更新时间:2024-12-04 GMT+08:00
分享

应用集成

系统管理员可以通过应用集成功能,便捷地将应用集成至CraftArts IPDCenter,支持应用服务的添加、编辑和删除。

添加应用

  1. 在角色桌面首页,选择左上角的,单击“管理中心”
  2. 选择集成管理 > 应用集成,进入“应用集成”页面。
  3. 单击“添加应用”
  4. 在页面右侧的“添加应用”界面的“基本信息”页签中,配置待添加应用的信息,具体参数配置说明如表1所示。

    表1 基本信息参数配置说明

    参数

    配置说明

    应用名称

    填写应用的名称。

    最多输入64个字符,并且不能与已存在应用的名称相同。

    应用配置方式

    • 应用首页地址:填写应用首页的URL地址,应用首页地址不能与已存在应用的URL地址相同。
    • 应用UI模板:使用应用UI模板展示应用。
    说明:

    “应用首页地址”和“应用UI模板”任选其一即可。

    首页打开方式

    设置页面的打开方式,以“新页面打开”“作为微前端子页面打开”(在应用内部打开)。

    应用图标

    选择待添加应用图标。

    填写应用名称后,系统会自动生成默认图标。如果不使用系统默认图标,您可以单击,并选择已准备的应用图标。

    应用描述

    填写应用的描述信息,非必填参数。

    集成认证

    选择是否开启集成认证,默认不开启。

    目前开启集成认证仅支持OAuth2,开启集成认证后不可修改。

    认证凭证

    开启集成认证后,可以在“认证凭证”处单击复制密钥,密钥仅支持复制一次,请妥善保存。

    如果密钥丢失,需要在“认证凭证”处单击重置密钥,再复制新的密钥。

    用户退出通知地址

    填写用户退出应用的通知地址,仅在开启集成认证时需要配置。

    Refresh Token有效期

    配置Refresh Token的有效期,默认7200秒。仅在开启集成认证时需要配置。

    取值范围:[7200,86400]

    Access Token有效期

    配置Access Token的有效期,默认7200秒。仅在开启集成认证时需要配置。

    取值范围:[7200,86400]

  5. 单击“确认”,保存基本信息并添加应用。

    添加后的应用展现在应用列表中,可以通过名称搜索查询。

    如果添加应用选择开启集成认证,应用列表中该应用的访问控制默认开启,如果新增应用未开启集成认证,则应用列表中该应用的访问控制默认不开启。

  6. 单击“可用性检测”,配置可用性检测信息,具体配置说明如表2所示。

    表2 可用性检测参数配置说明

    参数

    配置说明

    可用性检测

    是否开启可用性检测,缺省值为开启可用性检测。

    • 开启:定时检测应用是否能够正常使用。

      默认30分钟自动检测应用是否正常,10秒内应用正常响应,则应用状态为正常,否则应用状态显示为异常,并发送应用异常通知消息至指定的用户。

    • 不开启:定时进行可用性检测时,不检测该应用,应用列表中该应用的“应用状态”显示为“未检测”
    说明:

    进行应用检测时会检测应用首页地址和应用健康检查API是否能够正常响应,如果未配置应用健康检查API,则只检测应用首页地址是否能够正常响应。

    如果连续多次应用检测,应用状态都异常,仅会在第一次检测异常时给指定用户发送应用异常通知消息。

    应用异常通知

    用于配置应用异常通知消息需要发送的用户。

    默认配置为应用创建者和系统管理员用户,您可以配置多个用户。

    应用健康检查API

    用于配置应用检测时,需要进行应用健康检查的API。

    单击“添加API”,并配置API名称、请求方法和URL地址,其中API名称为可选参数。

    默认配置为空,您可以配置最多100个API,如果不配置,则跳过应用健康检查API。

  7. 单击“确认”,保存可用性检测信息。

编辑应用

  1. 在角色桌面首页,选择左上角的,单击“管理中心”
  2. 选择集成管理 > 应用集成,进入“应用集成”页面。
  3. 在应用列表中,选择待编辑的应用,单击操作列的“编辑”
  4. 在右侧的“编辑应用”界面的“基本信息”页签,配置待编辑应用信息,具体参数配置说明如表3所示。

    表3 编辑应用参数配置说明

    参数

    配置说明

    应用名称

    填写应用的名称。

    最多输入64个字符,并且不能与已存在应用的名称相同。

    应用配置方式

    • 应用首页地址:填写应用首页的URL地址,应用首页地址不能与已存在应用的URL地址相同。
    • 应用UI模板:使用应用UI模板展示应用。
    说明:

    “应用首页地址”和“应用UI模板”任选其一即可。

    首页打开方式

    设置页面的打开方式,以“新页面打开”“作为微前端子页面打开”(在应用内部打开)。

    应用图标

    选择应用图标,配置方式如下:

    • 如果正在使用系统默认图标,您可以单击,并选择已准备的应用图标,使用所选择的自定义图标。
    • 如果正在使用自定义图标,您可以单击自定义图标上的删除按钮使用系统默认图标,或者单击自定义图标上的,并选择新的图标替换原有的自定义图标。

    应用描述

    填写应用的描述信息,非必填参数。

    集成认证

    选择是否开启集成认证,默认不开启。

    仅应用没有开启集成认证时显示该参数,如果应用已开启集成认证,不能在编辑时关闭集成认证。

    认证凭证

    开启集成认证后,可以在“认证凭证”处单击复制密钥,密钥仅支持复制一次,请妥善保存。

    如果密钥丢失,需要在“认证凭证”处单击重置密钥,再复制新的密钥。

    用户退出通知地址

    填写用户退出应用的通知地址,仅在开启集成认证时需要配置。

    Refresh Token有效期

    配置Refresh Token的有效期,默认7200秒。仅在开启集成认证时需要配置。

    取值范围:[7200,86400]

    Access Token有效期

    配置Access Token的有效期,默认7200秒。仅在开启集成认证时需要配置。

    取值范围:[7200,86400]

  5. 单击“确认”,保存修改。
  6. 单击“可用性检测”,配置可用性检测信息,具体配置说明如表4所示。

    表4 可用性检测参数配置说明

    参数

    配置说明

    可用性检测

    是否开启可用性检测,缺省值为开启可用性检测。

    • 开启:定时检测应用是否能够正常使用。

      默认30分钟自动检测应用是否正常,10秒内应用正常响应,则应用状态为正常,否则应用状态显示为异常,并发送应用异常通知消息至指定的用户。

    • 不开启:定时进行可用性检测时,不检测该应用,应用列表中该应用的“应用状态”显示为“未检测”
    说明:

    进行应用检测时会检测应用首页地址和应用健康检查API是否能够正常响应,如果未配置应用健康检查API,则只检测应用首页地址是否能够正常响应。

    如果连续多次应用检测,应用状态都异常,仅会在第一次检测异常时给指定用户发送应用异常通知消息。

    应用异常通知

    用于配置应用异常通知消息需要发送的用户。

    默认配置为应用创建者和系统管理员用户,您可以配置多个用户。

    应用健康检查API

    用于配置应用检测时,需要进行应用健康检查的API。

    单击“添加API”,并配置API名称、请求方法和URL地址,其中API名称为可选参数。

    默认配置为空,您可以配置最多100个API,如果不配置,则跳过应用健康检查API。

  7. 单击“确认”,保存修改。

配置应用访问控制

  1. 在角色桌面首页,选择左上角的,单击“管理中心”
  2. 选择集成管理 > 应用集成,进入“应用集成”页面。
  3. 在应用列表中,选择待配置的应用。
  4. “访问控制”列,配置是否开启应用的访问控制。

    • 开启访问控制:应用在开启访问控制后,该应用才能在用户侧显示,用户可正常添加和使用该应用。
    • 关闭访问控制:应用在关闭访问控制后,该应用将不会在用户侧显示,用户无法添加和使用该应用。

      如果在关闭应用的访问控制前,用户已将该应用添加到角色桌面,关闭访问控制后,该应用名称在角色桌面置灰,单击应用也无法访问该应用。

查看和重置认证凭证

应用开启集成认证后,可以查看和重置应用的认证凭证。

  1. 在角色桌面首页,选择左上角的,单击“管理中心”
  2. 选择集成管理 > 应用集成,进入“应用集成”页面。
  3. 在应用列表中,选择待查看的应用。
  4. 单击“操作”列的“认证凭证”,弹出“认证凭证”弹窗,如图1所示。

    图1 认证凭证弹窗

  5. 单击可重置认证凭证密钥,重置后可单击复制新的密钥。

    密钥仅支持复制一次,复制成功后按钮置灰。

删除应用

  1. 在角色桌面首页,选择左上角的,单击“管理中心”
  2. 选择集成管理 > 应用集成,进入“应用集成”页面。
  3. 在应用列表中,选择待删除的应用。
  4. 单击操作列的“删除”,在弹出的确认删除对话框中单击“确定”,删除应用。

应用UI模板配置

  1. 在角色桌面首页,选择左上角的,单击“管理中心”
  2. 选择集成管理 > 应用集成,进入“应用集成”页面。
  3. “添加应用”“编辑应用”界面,选择“应用UI模板”“进入模板配置”,进入应用配置页面。

    图2 应用UI模板

  4. 添加应用菜单。

    1. 单击,在“添加菜单”窗口中输入“菜单标题”“菜单URL(可选)”,单击“确定”
    2. 添加完成后,页面左侧展示菜单列表。
      • 单击,添加子菜单,最多添加三个层级。
      • 单击,重新编辑标题或URL。
      • 单击,删除菜单。删除父级菜单时,子菜单会一同被删除。
      图3 添加应用菜单

  5. 单击“预览”,查看已添加的应用界面,确认无误后,单击“保存”“取消”

相关文档