更新时间:2024-10-14 GMT+08:00
分享

创建流程服务编排

操作场景

在数据发布、数据变更等流程运行过程中,用户需要通过调用流程服务API,可以将部件、BOM(Bill Of Material,物料清单)、工艺等数据传递给第三方系统,实现上下游系统之间数据同步。此时,可以通过定义流程服务编排,生成相应的流程服务API,后续在流程元模板的“流程编辑”中应用后,实现流程与外部系统对接,如数据同步、数据集成、消息通知等场景。

流程服务编排支持通过如下方式进行创建,请根据实际业务需求进行选择。

前提条件

已登录IPDCenter基础服务,进入流程引擎页面。

手动创建流程服务编排

  1. 在左侧导航栏中,选择流程编排服务 > 流程服务编排,进入“流程服务编排”页面。
  2. 单击“创建”,展开“创建服务”页面。
  3. 选择“手动创建”页签,并在“基本信息”中,参照如下说明进行设置。

    图1 手动创建-基本信息
    表1 手动创建-基本信息配置参数

    参数

    参数说明

    服务名称

    用户自定义,表示需要创建的流程服务编排的名称。

    tag

    用户自定义,可根据用途、分组、流程等各维度自定义,以便更灵活管理流程服务编排。

    服务来源

    支持选择XDM、外部系统和内部系统。默认为“内部系统”

    批量执行

    流程服务编排是否需要批量执行。

    默认为“否”。如果选择“是”,展示“变量名”,用户自定义。

    是否异步执行

    流程服务编排是否需要异步执行。

    默认为“否”。如果选择“是”,展示“查询方式”,当前支持API和APIEDIT两种查询方式。

    服务描述

    用户自定义,用于说明当前创建的流程服务编排的作用、使用场景等,以便于其他用户了解和使用该流程服务编排。

    长度不能超过64个字符。

  4. 单击“下一步”,进入“配置信息”页面。
  5. “配置信息”中,根据服务类型的不同,配置同的信息

    表2 手动创建-配置信息配置参数

    参数

    参数说明

    服务类型

    流程服务编排支持的服务类型如下:

    • HTTP:基于HTTP协议封装的API类型。
      图2 HTTP服务类型
      • 服务地址:用户自定义,长度不能超过200个字符。
      • 方法类型:根据业务需求设置当前流程服务编排的方法类型,可选择GET、POST和PUT。选择指定方法类型后,您可以进一步定义对应方法类型的Header参数、Query参数和Body参数。

        Header参数:在“Header参数”页签下,单击“新增”,输入参数名称和参数值,设置是否加密,单击“保存”(首次创建服务编排时,需要添加“X-Application-Id”“X-Tenant-Id”两个参数,参数值分别为${X-Application-Id}${X-Tenant-Id}。)

        Query参数:在“Query参数”页签下,单击“新增”,输入参数名称和参数值,设置是否加密,单击“保存”

        Body参数:在“Body参数”页签下,选择参数类型(可选择JSON和FORM_DATA),并根据选择的参数类型设置Rest模板或Form参数。

        其中,GET方法不支持配置Body参数。

      • 返参模板:根据实际业务需求,输入JSON格式的返回参数。
    • APIEDIT:用户自定义脚本或编排多个接口及参数格式。
      图3 APIEDIT服务类型
      • 执行流程:单击“编辑流程”,切换至执行流程的编辑页面,根据实际业务需求进行设置,单击“保存”
      • 入参模板:根据实际业务需求,输入JSON格式的入参。
      • 返参模板:根据实际业务需求,输入JSON格式的返回参数。

    请求参数(Query/Header/Body)

    1. 根据实际业务需求,勾选“请求参数(Query/Header/Body)”,单击“新增”
    2. 在弹出的“设置请求参数”窗口中,参照如下说明进行设置,单击“保存”
      • 参数名:用户自定义。
      • 类型:系统提供多种类型,包含:BOOLEAN、BYTE、SHORT、INTEGER、LONG、STRING、FLOAT、DOUBLE、OBJECT、BIG_DECIMAL、DATE和FILE。
      • 是否为数组:可选择“是”“否”
      • 位置:可选择QUERY、HERDER和BODY。
      • 是否必填:可选择“是”“否”
      • 是否为模板:可选择“是”“否”
      • 默认值:用户自定义。
      • 描述:用户自定义。

    响应参数

    1. 根据实际业务需求,勾选“响应参数”,单击“新增”
    2. 在弹出的“设置请求参数”窗口中,参照如下说明进行设置,单击“保存”
      • 参数名:用户自定义。
      • 类型:系统提供多种类型,包含:BOOLEAN、BYTE、SHORT、INTEGER、LONG、STRING、FLOAT、DOUBLE、OBJECT、BIG_DECIMAL、DATE和FILE。
      • 是否为数组:可选择“是”“否”
      • 描述:用户自定义。

  6. 单击“保存”

模板创建流程服务编排

  • 通过模板创建流程服务编排前,请先下载模板用作于新流程服务编排的模板。
  • 仅支持上传xlsx格式文件,文件数量1个,大小不超过50M。
  1. 在左侧导航栏中,选择流程编排服务 > 流程服务编排,进入“流程服务编排”页面。
  2. 单击“创建”,展开“创建服务”页面。
  3. 选择“模板创建”页签,将已在本地编辑好的流程服务编排拖拽到待上传列表区域。

    您也可以“单击上传”,将已在本地编辑好的流程服务编排上传至流程引擎。

  4. 单击“保存”

Yaml创建流程服务编排

流程引擎支持通过导入Swagger 2.0的Yaml文件来创建流程服务编排,且该Yaml文件不能大于1MB。

  1. 在左侧导航栏中,选择流程编排服务 > 流程服务编排,进入“流程服务编排”页面。
  2. 单击“创建”,展开“创建服务”页面。
  3. 选择“Yaml创建”页签,选择“服务来源”,并将已在本地编辑好的流程服务编排拖拽到待上传列表区域。

    当前流程服务编排支持XDM和外部系统两种服务来源。

    您也可以“单击上传”,将已在本地编辑好的流程服务编排上传至流程引擎。

  4. 单击“保存”

相关文档