在数据发布、数据变更等流程运行过程中,用户需要通过调用流程服务API,可以将部件、BOM(Bill Of Material,物料清单)、工艺等数据传递给第三方系统,实现上下游系统之间数据同步。此时,可以通过定义流程服务编排,生成相应的流程服务API,用以后续在流程元模板的“流程编辑”中应用后,实现流程与外部系统对接,如数据同步、数据集成、消息通知等场景。
手动创建流程服务编排
- 登录流程引擎。
- 在左侧导航栏中,选择,进入“流程服务编排”页面。
- 单击“创建”,展开“创建服务”页面。
- 选择“手动创建”页签,并在“基本信息”中,参照如下说明进行设置。
图1 手动创建-基本信息
表1 手动创建-基本信息配置参数
参数 |
参数说明 |
服务名称 |
用户自定义,表示需要创建的流程服务编排的名称。 |
tag |
用户自定义,可根据用途、分组、流程等各维度自定义,以便更灵活管理流程服务编排。 |
服务来源 |
支持选择XDM、外部系统和内部系统。默认为“内部系统”。 |
批量执行 |
流程服务编排是否需要批量执行。
默认为“否”。如果选择“是”,展示“变量名”,用户自定义。 |
是否异步执行 |
流程服务编排是否需要异步执行。
默认为“否”。如果选择“是”,展示“查询方式”,当前仅支持API查询方式。 |
服务描述 |
用户自定义,用于说明当前创建的流程服务编排的作用、使用场景等,以便于其他用户了解和使用该流程服务编排。
长度不能超过64个字符。 |
- 单击“下一步”,进入“配置信息”页面。
- 在“配置信息”中,根据服务类型的不同,需要配置的信息不同。
表2 手动创建-配置信息配置参数
参数 |
参数说明 |
服务类型 |
流程服务编排支持的服务类型如下:
HTTP:基于HTTP协议封装的API类型。
图2 HTTP服务类型
- 服务地址:用户自定义,长度不能超过200个字符。
- 方法类型:根据业务需求设置当前流程服务编排的方法类型,可选择GET、POST和PUT。选择指定方法类型后,您可以进一步定义对应方法类型的Header参数、Query参数和Body参数。
Header参数:在“Header参数”页签下,单击“新增”,输入参数名称和参数值,设置是否加密,单击“保存”。
Query参数:在“Query参数”页签下,单击“新增”,输入参数名称和参数值,设置是否加密,单击“保存”。(首次创建服务编排时,需要添加“X-Application-Id”和“X-Tenant-Id”两个参数,参数值分别为${X-Application-Id},${X-Tenant-Id}。)
Body参数:在“Body参数”页签下,选择参数类型(可选择JSON和FORM_DATA),并根据选择的参数类型设置Rest模板或Form参数。
其中,GET方法不支持配置Body参数。
- 返参模板:根据实际业务需求,输入JSON格式的返回参数。
|
请求参数(Query/Header/Body) |
- 根据实际业务需求,勾选“请求参数(Query/Header/Body)”,单击“新增”。
- 在弹出的“设置请求参数”窗口中,参照如下说明进行设置,单击“保存”。
- 参数名:用户自定义。
- 类型:系统提供多种类型,包含:BOOLEAN、BYTE、SHORT、INTEGER、LONG、STRING、FLOAT、DOUBLE、OBJECT、BIG_DECIMAL、DATE和FILE。
- 是否为数组:可选择“是”和“否”。
- 位置:可选择QUERY、HERDER和BODY。
- 是否必填:可选择“是”和“否”。
- 是否为模板:可选择“是”和“否”。
- 默认值:用户自定义。
- 描述:用户自定义。
|
响应参数 |
- 根据实际业务需求,勾选“响应参数”,单击“新增”。
- 在弹出的“设置请求参数”窗口中,参照如下说明进行设置,单击“保存”。
- 参数名:用户自定义。
- 类型:系统提供多种类型,包含:BOOLEAN、BYTE、SHORT、INTEGER、LONG、STRING、FLOAT、DOUBLE、OBJECT、BIG_DECIMAL、DATE和FILE。
- 是否为数组:可选择“是”和“否”。
- 描述:用户自定义。
|
- 单击“保存”。