更新时间:2023-08-15 GMT+08:00
分享

ISDP+问题管理

描述

ISDP+问题管理集成ISDP+问题管理相关能力,对现场作业过程、任务施工过程,设备视频监控等多个场景中识别的问题提供统一的管理,从提出问题到处理、关闭问题,实现问题的闭环。上层应用可以基于此快速开发问题管理的业务应用。

开放能力

ISDP+问题管理包含一个APP资产和一个BO资产,APP资产提供页面能力,BO资产提供服务能力。

  • APP资产提供的页面:

    页面

    说明

    问题列表

    问题列表页面集成ISDP+问题列表页面。

  • BO资产提供的服务:

    服务

    说明

    创建问题单

    该服务用于创建问题单。

    分页查询问题列表

    该服务用于分页查询问题列表。

    查询单个问题单详情

    该服务用于查询单个问题的详情。

问题管理页面集成方法说明

  1. 联系对接的ISDP+系统管理员分配单点登录认证凭证(client_id,client_secret)。

    1. 以超级管理员账号登录ISDP+管理员系统(console)(登录地址:https://ISDP+的域名/console#/sysAdmin/home),如图1所示。
      图1 ISDP+管理员系统(console)
    2. 选择“初始设置 > oauth2集成配置”,进入“oauth2集成配置”页面,如图2所示。
      图2 进入oauth2集成配置
    3. 单击“新建”,如图3所示,配置oauth2集成信息,配置参数说明请参见表1
      图3 新建配置
      表1 配置参数说明

      参数

      配置说明

      示例

      客户端ID

      手动输入客户端ID。

      test

      授权协议

      下拉选择授权协议。

      authorization_code,password,refresh_token

      跳转地址

      手动输入URL格式跳转地址,如有多个地址,请用英文逗号分隔。

      -

      Token失效时间(s)

      手动输入整数,默认Token失效时间12小时。

      1200

      刷新Token失效时间(s)

      手动输入整数,默认刷新Token失效时间30天。

      43200

    4. 单击“确定”,新建成功后会弹出密钥详情页面,如图4所示。
      单击“复制”,可复制密码。
      图4 密钥详情

      客户端ID和密码,即为分配的单点登录认证凭证(client_id,client_secret)。

  2. 获取对接ISDP+的服务器的IP地址,并提供给ISDP+系统管理员配置到ISDP+的IP白名单。

    1. ISDP+系统管理员登录nacos控制台。
    2. 图5所示,选择“配置管理 > 配置列表”,进入“配置管理”页面。
      图5 进入配置管理
    3. 在文件中配置要添加的IP地址。
      • OP版本:配置文件application.yaml
        1. 图6所示,查询到“application.yaml”文件。
          图6 查询“application.yaml”文件
        2. 单击“application.yaml”文件对应的“编辑”,进入该文件的“编辑配置”页面。
        3. 在文件中添加如下配置,如图7所示。
          其中示例中appcube_sso,为1中分配的单点登录认证凭证中的“客户端ID”,IP地址为要添加到ISDP+白名单的服务器IP地址,请根据实际情况修改。
          oauth2:
            serverAuth:
              clientMap:
                appcube_sso:
                   ipList:
                     - 10.10.10.10
          图7 配置示例
        4. 单击“发布”。
      • OC版本:配置文件plat-oauth2-server.yaml
        1. 图8所示,查询到“plat-oauth2-server.yaml”文件。
          图8 查询“plat-oauth2-server.yaml”文件
        2. 单击“plat-oauth2-server.yaml”文件对应的“编辑”,进入该文件的“编辑配置”页面。
        3. 在文件中添加如下配置,如图9所示。
          其中示例中appcube_sso,为1中分配的单点登录认证凭证中的“客户端ID”,IP地址为要添加到ISDP+白名单的服务器IP地址,请根据实际情况修改。
          oauth2:
            serverAuth:
              clientMap:
                appcube_sso:
                   ipList:
                     - 10.10.10.10
          图9 配置示例
        4. 单击“发布”。

  3. 配置ISDP+的登录账户,或者将自己系统的用户账号同步到ISDP+中(通过OpenAPI的方式)。

    通过API“添加人员账号”同步用户账号到ISDP+,API的使用方法请参见添加人员账号

  4. 集成页面。

    问题管理开放的1个页面以及URL如下:

    问题列表页面

    URL:https://isdp+的域名/embed/#/qc/question/problemMgmt?menuType=-9069

    页面可以通过iframe嵌入方式集成,也可以通过跳转方式集成:

    问题列表页面
    1. 调用ISDP+获取token接口https://isdp+域名/oauth2/oauth/rest_token,得到access_token。
    2. 将获取到的access_token拼接到页面的URL上。

      示例:https://isdp+的域名/embed/?access_token=XXXXXXXXXXXX#/qc/question/problemMgmt?menuType=-9069

    ISDP+问题管理APP中页面集成示例:

    问题列表页面,过iframe嵌入方式集成ISDP+问题列表页面。

服务集成实现方法

  1. 在对接的ISDP+系统创建应用,并记录下“应用ID”和“令牌”。

    相关操作请参见创建应用

  2. 使用创建的应用订阅API。

    相关操作请参见订阅API

  3. 配置系统参数。

    1. 进入到BO。
    2. 图10所示,单击“配置”。
      图10 配置
    3. 单击“系统参数”,配置相关参数。
      需要配置的参数:
      • 应用ID和令牌
      • 获取ISDP+ token的接口地址
      • 订阅的API
      图11 配置系统参数

  4. 配置完成后,在进行服务和脚本的编排时,首先调用ISDP+获取token接口,得到access_token,再调用其他API接口。
  5. 配置业务权限凭证。

    通过业务权限凭证,可以控制AppCube的用户对于自定义公共接口的访问权限,如果用户权限中包含了某个业务权限凭证,该用户将能够调用配置了相应业务权限凭证的自定义公共接口。

    具体操作请参见如何控制接口访问权限

如何使用资产

【APP资产】

  1. 订购并安装部署ISDP+问题管理APP资产到对应的开发环境。

    相关操作请参见如何订购&部署资产

  2. 在开发环境首页的“项目”页签单击“行业应用”,再单击“创建Addon应用”。
  3. 输入标签和名称,选择分类,选择依赖的APP“ISDP+问题管理”,单击“创建”

    图12 创建Addon应用

  4. 创建后,页面跳转到Addon应用开发页面,在页面上方为Addon应用定制内容,“External dependencies”里为依赖的应用目录树。

    图13 Addon应用开发页面

  5. 开发定制内容,例如基于依赖App中的页面进行定制。

    1. 图14所示,鼠标放在Addon应用定制目录下的Page文件夹旁会出现加号,单击加号,选择“高级页面”。
      图14 进入添加高级页面
    2. 图15所示,在“添加高级页面”中选择“基于已有页面”,勾选基于的页面,单击“添加”。
      图15 添加高级页面

      添加后,在Addon应用定制目录下的Page文件夹下会出现该定制页面,如图16所示,可以基于该定制页面进行开发。

      图16 添加结果

      后续就是应用的开发过程,开发完成将Addon应用打包时,只能将定制内容打包出去,依赖的内容不会随Addon应用打包发布出去,在其他环境中也需要订购部署依赖的资产包。

【BO资产】

  1. 订购并安装部署ISDP+问题管理BO资产到对应的开发环境。

    相关操作请参见如何订购&部署资产

  2. 在开发环境首页的“项目”页签,新建或进入已有的应用。
  3. 图17所示,在应用开发页面下“External dependencies”目录树旁单击加号,选择“BO服务”。

    图17 BO服务

  4. 图18所示,在“添加BO”页面选择BO,单击“添加”,导入BO。

    图18 添加BO

    导入后,该BO会出现在上层应用中,如图19所示。后续,您可在应用中调用该BO中的服务。

    图19 导入BO

  5. 调用BO中的服务。

    例如在标准页面的服务模型中调用BO中的服务。

    1. 在应用中打开一个标准页面,或者新创建一个标准页面。
      添加方法如图20图21所示。
      图20 添加标准页面1
      图21 添加标准页面2
    2. 图22所示,标准页面开发界面下侧,单击“模型视图”,切换到“模型视图”。
      图22 模型视图
    3. 图23所示,单击“新增模型”,定义模型名称,选择来源为“服务”,单击“下一步”。
      图23 新增模型
    4. 图24所示,选择调用ISDP+问题管理BO中的服务,后续可以基于服务进行定制开发
      图24 选择调用服务

相关文档