@alanwang-merit/meritdata-platform-skill-package 1.0.8 → 1.0.10

package/skills/meritdata-platform-bpm/references/api//346/224/273/347/225/245-01-/346/265/201/347/250/213API-/347/253/240/350/212/20204_/350/277/220/350/241/214/350/247/204/345/210/231/345/274/225/346/223/216.md

@@ -0,0 +1,449 @@
+---
+name: 攻略-01-流程API-章节04_运行规则引擎
+description: 运行规则引擎 — 美林平台 BPM 流程 HTTP API 接口全集（启动流程、完成任务、追踪、阅知、退回等）
+keywords: [BPM, 流程API, 工作流, 启动流程, 完成任务, 追踪, 退回, 阅知, Camunda, 运行规则引擎]
+use-cases: [BPM 流程 API 调用, 流程审批集成, 流程追踪, 流程退回]
+source-section: 3. 运行规则引擎
+source-file: 应用开发平台-流程管理-使用攻略（一）：流程API接口.md
+---
+
+# 3.  运行规则引擎
+
+## 📋 API 契约（机器可读）
+
+```json
+{
+  "apiName": "run",
+  "method": "POST",
+  "urlPattern": "/api/bpm/core/ruleengine/run",
+  "signature": "Result ruleEngineRun()",
+  "functionDesc": "根据业务id和流程定义key打开流程实例，获取流程实例详情",
+  "module": "bpm.process",
+  "pathParameters": [
+    {
+      "name": "procDefKey",
+      "type": "String",
+      "required": true,
+      "desc": "流程key",
+      "constraint": "非空"
+    },
+    {
+      "name": "businessId",
+      "type": "String",
+      "required": true,
+      "desc": "业务id",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "bpmOperName",
+      "type": "String",
+      "required": false,
+      "desc": "操作名称",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "bpmOperValue",
+      "type": "String",
+      "required": false,
+      "desc": "操作值",
+      "constraint": "字符串"
+    },
+    {
+      "name": "自定义流程参数",
+      "type": "String",
+      "required": false,
+      "desc": "自定义流程参数",
+      "constraint": "字符串"
+    }
+  ],
+  "requestParameters": [
+    {
+      "name": "procDefKey",
+      "type": "String",
+      "required": true,
+      "desc": "流程key",
+      "constraint": "非空"
+    },
+    {
+      "name": "businessId",
+      "type": "String",
+      "required": true,
+      "desc": "业务id",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "bpmOperName",
+      "type": "String",
+      "required": false,
+      "desc": "操作名称",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "bpmOperValue",
+      "type": "String",
+      "required": false,
+      "desc": "操作值",
+      "constraint": "字符串"
+    },
+    {
+      "name": "自定义流程参数",
+      "type": "String",
+      "required": false,
+      "desc": "自定义流程参数",
+      "constraint": "字符串"
+    }
+  ],
+  "returnType": "MainForm对象",
+  "returnFields": [
+    "timestamp",
+    "status",
+    "message",
+    "data",
+    "success"
+  ],
+  "exceptionList": [
+    "BusinessException",
+    "SystemException"
+  ],
+  "exampleCall": "bpmEngine.ruleEngineRun(...)",
+  "bestPractice": "传入 bpmOperName 和 bpmOperValue 必须匹配流程定义中的按钮配置"
+}
+```
+
+说明：根据业务id和流程定义key打开流程实例，获取流程实例详情
+
+情况一：只是打开流程表单数据，不做任何操作。获取不到下一节点的审批人员数据
+
+情况二：点击提供的流程按钮中的发送按钮，传入bpmOperName，bpmOperValue参数。获取当前节点的
+runtime[nextNode]表示:下一节点的审批人员数据和审批方式
+
+* method: `POST`
+* url: `http://IP:端口/gateway/服务名/api/bpm/core/ruleengine/run`
+* PathVariables
+    ```
+     无
+    ```
+    
+* RequestParams
+    | 参数       | 参数类型 | 是否必须 | 释义        | 备注 |
+    | ---------- |-------- |-------- | ----------- | ---- |
+    | procDefKey | String      |是       | 流程key   |      |
+    | businessId | String      |是       | 业务id   |      |
+    |bpmOperName|String|否|操作名称|如果想要获取当前节点的runtime[nextNode],传入该参数|
+    |bpmOperValue|String|否|操作值|如果想要获取当前节点的runtime[nextNode],传入该参数|
+    | 自定义流程参数|String | 否   | 自定义流程参数 | |
+* ResponseBody
+    返回数据类型：MainForm对象
+
+<b>Postman样例:</b>
+适用于前端直接调用
+http://127.0.0.1:8080/gateway/cloud-system-bpm-demo/api/bpm/core/ruleengine/run?procDefKey=Process_Demo1&businessId=3f28824f77d7e9a60177d802f61d0000
+
+```json
+   {
+       "procDefKey":"Process_Demo1"
+       "businessId":"3f28824f77d7e9a60177d802f61d0000"
+   }
+```
+
+返回数据如下：
+```json
+{
+    "timestamp": 1614242117951,
+    "status": 1,
+    "message": "成功",
+    "stackmessage": null,
+    "path": "/api/bpm/core/ruleengine/run",
+    "data": {
+        "runtime": {
+            "businessId": null,
+            //流程定义key
+            "procDefKey": "Process_Demo1",
+            //流程定义id
+            "procDefId": "Process_Demo1:4:d349d3dd-7689-11eb-ac36-00d861edd189",
+            //流程实例id
+            "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+            //任务id
+            "taskId": "94c159ee-773a-11eb-930f-00d861edd189",
+            //任务key
+            "taskDefKey": "Activity_0vjczzn",
+            //任务名称
+            "taskName": "总监审批",
+            //表单地址
+            "formLink": "/bpm-demo/example/index.html#/formRead?id=3f28824f77d7e9a60177d802f61d0000",
+            //是否人员选择
+            "selUserWin": "no",
+            //是否填写意见
+            "opinionWin": "no",
+            //操作按钮
+            "bpmBtns": [
+                {
+                    "name": "保存",
+                    "id": "bpmSaveOrUpdateBtn",
+                    "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+                    "type": "primary"
+                },
+                {
+                    "name": "填写意见",
+                    "id": "bpmOpinionBtn",
+                    "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+                    "type": ""
+                },
+                {
+                    "name": "发送",
+                    "id": "bpmSendBtn",
+                    "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+                    "type": ""
+                },
+                {
+                    "name": "流程终止",
+                    "id": "bpmJumpBtnEnd",
+                    "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+                    "type": "",
+                    "procDefId": "Process_Demo1:4:d349d3dd-7689-11eb-ac36-00d861edd189"
+                },
+                {
+                    "name": "特送",
+                    "id": "bpmJumpBtn",
+                    "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+                    "type": "",
+                    "procDefId": "Process_Demo1:4:d349d3dd-7689-11eb-ac36-00d861edd189"
+                },
+                {
+                    "name": "管理特送",
+                    "id": "bpmJumpManagementBtn",
+                    "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+                    "type": "",
+                    "procDefId": "Process_Demo1:4:d349d3dd-7689-11eb-ac36-00d861edd189"
+                },
+                {
+                    "name": "退回上一环节处理人",
+                    "id": "bpmRetprenodeBtn",
+                    "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+                    "type": ""
+                },
+                {
+                    "name": "退回拟稿人",
+                    "id": "bpmRetfirnodeBtn",
+                    "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+                    "type": ""
+                },
+                {
+                    "name": "退回任意环节",
+                    "id": "bpmRetRandomNodeStatusBtn",
+                    "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+                    "type": ""
+                },
+                {
+                    "name": "查看追踪",
+                    "id": "bpmProcTrackBtn",
+                    "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+                    "type": "",
+                    "procDefId": "Process_Demo1:4:d349d3dd-7689-11eb-ac36-00d861edd189"
+                },
+                {
+                    "name": "关闭",
+                    "id": "bpmCloseBtn",
+                    "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+                    "type": ""
+                }
+            ],
+            //下一节点处理人和审批类型
+            "nextNodes": [],
+            "mainForm": {
+                "tenantId": "",
+                "createTime": 1614236908000,
+                "updateTime": 1614237905000,
+                "creatorId": null,
+                "reviserId": null,
+                "id": "3f28824f77d7e9980177d8047c920003",
+                //应用模块名称
+                "appModuleName": "差旅费",
+                //模块id
+                "appModuleId": "报销",
+                //所属系统id
+                "appSystemId": "BPM",
+                //所属系统
+                "appSystemName": "BPM系统",
+                //流程定义id
+                "procDefId": "Process_Demo1:4:d349d3dd-7689-11eb-ac36-00d861edd189",
+                //流程实例id
+                "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+                //流程定义key
+                "procDefKey": "Process_Demo1",
+                //流程读者id,按逗号拼接
+                "flowReaderIds": ",test1,",
+                //流程读者名称
+                "flowReaderNames": "测试1",
+                //流程作者id,即处理人
+                "flowAuthorIds": ",test1,",
+                //流程
+                "flowAuthorNames": "测试1",
+                //流程处理状态: draft草稿箱、track跟踪、over办结
+                "procDealStatus": "track",
+                //拟稿人名称
+                "drafterName": "测试1",
+                //拟稿人编码
+                "drafterId": "test1",
+                //拟稿部门编码
+                "drafterDeptId": "yanfa",
+                //拟稿部门名称
+                "drafterDeptName": "技术研发部",
+                //标题
+                "subject": "测试1_2021-02-25 00:00_出差报销",
+                //紧急程度
+                "urgent": "普通",
+                //密级
+                "secret": "高级",
+                //表单连接地址
+                "formLink": "/bpm-demo/example/index.html#/formEdit?id=3f28824f77d7e9a60177d802f61d0000",
+                //上一活动处理人编码
+                "preActDealerId": "test1",
+                // 上一处理人编码
+                "preDealerId": "test1",
+                //上一活动Id
+                "preActId": "Activity_1el7wyo",
+                //当前处理节点Ids
+                "nodeIds": "Activity_0vjczzn",
+                //当前处理节点名
+                "nodeNames": "总监审批",
+                //锁定用户编码
+                "lockUserId": "test1",
+                //锁定用户名称
+                "lockUserName": "测试1",
+                //锁定是否启用，0：未启用，1：启用
+                "lockStatus": null,
+                //流程设计版本号
+                "bpmVersion": 1,
+                //业务id
+                "businessId": "3f28824f77d7e9a60177d802f61d0000",
+                //门户模式：默认模式default（无前缀）,固定模式fix（开发使用）,门户模式portal
+                "portalMode": "default",
+                //门户前缀
+                "portalUrl": ""
+            }
+        },
+        //表单连接地址
+        "formLink": {
+            "sort": "0",
+            "name": "总监审批",
+            "link": "/bpm-demo/example/index.html#/formRead?id=businessId"
+        },
+        //当前节点候选处理人规则
+        "actors": [
+            {
+                "type": "1",
+                "ids": "drafterCode",
+                "codes": null,
+                "names": null,
+                "level": null,
+                "duty": null,
+                "dutyName": null,
+                "dutyCode": null,
+                "condition": null,
+                "customControllerName": null,
+                "customMethodsName": null
+            }
+        ],
+        //当前节点审批方式
+        "approve": {
+            "type": "onlyApprove"
+        },
+        //操作路由
+        "route": {
+            "type": "1",
+            "name": null,
+            "value": null,
+            "returnName": null,
+            "returnValue": null,
+            "operName": "发送",
+            "operImgPath": null
+        },
+        //意见
+        "opinion": {
+            "display": "1",
+            "type": "1",
+            "must": "1",
+            "regionName": null,
+            "regionSort": "0",
+            "opinionField": null,
+            "opinionYesNo": null,
+            "opinionDeptStatus": null,
+            "opinionListStatus": null,
+            "routeName": null,
+            "routeValue": null,
+            "routeOpiMust": null,
+            "routeCommentMust": null,
+            "opinionUserImgStatus": null,
+            "autoOpinion": null,
+            "autoOpiContent": null,
+            "isOpiDisplay": null,
+            "isOpiMust": null
+        },
+        //操作候选人员
+        "seluserwin": {
+            "display": "yes@@@@@【本环节需要选人】",
+            "noseluser": "no@@@@@【本环节不需要自动选人】"
+        },
+         // 表单是否可以编辑
+        "editStatus": {
+            "type": "1"
+        },
+        //当前活动节点信息
+        "activity": {
+            "id": "Activity_0vjczzn",
+            "name": "总监审批"
+        },
+        //当前节点变量
+        "formVars": [],
+        // 阅知
+        "sendRead": {
+            "actor": [],
+            "isSendRead": {
+                "type": "0"
+            }
+        },
+        // 允许收回
+        "regainStatus": {
+            "type": null
+        },
+        // 退回上一环节处理人
+        "isRetprenode": {
+            "type": "1"
+        },
+         // 退回拟稿人
+        "isRetfirnode": {
+            "type": "1"
+        },
+         // 返回任意环节
+        "retRandomNodeStatus": {
+            "type": "1"
+        },
+        // 转发
+        "sign": null,
+        "completionCondition": null
+    },
+    "extraInfo": {},
+    "success": true
+}
+```
+
+<b>java测试样例:</b>
+适用于后端调用
+ 注入com.meritdata.cloud.bpm.core.BpmEngine类
+```java
+    @Autowired
+    BpmEngine bpmEngine;
+    @ApiOperation(value = "规则引擎执行", notes = "根据流程实例Id和流程所需要的变量，查询对应待办任务；" +
+            "结果1.存在待办：返回RuleEngine下的当前执行的任务Id、当前执行任务的规则信息，后续处理用户节点用户信息;" +
+            "结果2.不存在待办：返回空的RuleEngine实例化。")
+    @RequestMapping(value = "/ruleengine/run", method = RequestMethod.POST)
+    @ResponseBody
+    public ResultBody<RuleEngine> ruleEngineRun() {
+        Map variables = new HashMap();
+        variables.put("procDefkey","Process_Demo1");
+        variables.put("businessId","3f28824f77d7e9a60177d802f61d0000");
+
+        return bpmEngine.ruleEngineRun(variables);
+    }    
+```

package/skills/meritdata-platform-bpm/references/api//346/224/273/347/225/245-01-/346/265/201/347/250/213API-/347/253/240/350/212/20205_/345/256/214/346/210/220/344/273/273/345/212/241/346/216/245/345/217/243.md

@@ -0,0 +1,232 @@
+---
+name: 攻略-01-流程API-章节05_完成任务接口
+description: 完成任务接口 — 美林平台 BPM 流程 HTTP API 接口全集（启动流程、完成任务、追踪、阅知、退回等）
+keywords: [BPM, 流程API, 工作流, 启动流程, 完成任务, 追踪, 退回, 阅知, Camunda, 完成任务接口]
+use-cases: [BPM 流程 API 调用, 流程审批集成, 流程追踪, 流程退回]
+source-section: 4. 完成任务接口
+source-file: 应用开发平台-流程管理-使用攻略（一）：流程API接口.md
+---
+
+# 4. 完成任务接口
+
+## 📋 API 契约（机器可读）
+
+```json
+{
+  "apiName": "complete",
+  "method": "POST",
+  "urlPattern": "/api/bpm/core/task/{id}/complete",
+  "signature": "Result complete()",
+  "functionDesc": "完成当前节点，进入下一节点",
+  "module": "bpm.process",
+  "pathParameters": [
+    {
+      "name": "id",
+      "type": "String",
+      "required": true,
+      "desc": "任务id",
+      "constraint": "非空字符串"
+    }
+  ],
+  "requestParameters": [
+    {
+      "name": "businessId",
+      "type": "String",
+      "required": true,
+      "desc": "业务id",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "runtime[taskDefKey]",
+      "type": "String",
+      "required": true,
+      "desc": "任务定义key",
+      "constraint": "非空"
+    },
+    {
+      "name": "approve[type]",
+      "type": "String",
+      "required": true,
+      "desc": "审批方式",
+      "constraint": "字符串"
+    },
+    {
+      "name": "bpmOperValue",
+      "type": "String",
+      "required": true,
+      "desc": "操作值",
+      "constraint": "字符串"
+    },
+    {
+      "name": "bpmOperName",
+      "type": "String",
+      "required": true,
+      "desc": "操作名称",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "bpmSubject",
+      "type": "String",
+      "required": false,
+      "desc": "待办标题",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "bpmUrgent",
+      "type": "String",
+      "required": false,
+      "desc": "紧急程度",
+      "constraint": "非空字符串"
+    },
+    {
+      "name": "bpmSecret",
+      "type": "String",
+      "required": false,
+      "desc": "密级程度",
+      "constraint": "非空，加密字符串"
+    },
+    {
+      "name": "下一节点的任务定义key_下一节点的审批方式",
+      "type": "String",
+      "required": false,
+      "desc": "下一节点审批人员",
+      "constraint": "非空"
+    },
+    {
+      "name": "自定义流程参数",
+      "type": "String",
+      "required": false,
+      "desc": "自定义流程参数",
+      "constraint": "字符串"
+    }
+  ],
+  "returnType": "MainForm对象",
+  "returnFields": [
+    "timestamp",
+    "status",
+    "message",
+    "data",
+    "success"
+  ],
+  "exceptionList": [
+    "BusinessException",
+    "SystemException"
+  ],
+  "exampleCall": "bpmEngine.complete(...)",
+  "bestPractice": "传入 bpmOperName 和 bpmOperValue 必须匹配流程定义中的按钮配置"
+}
+```
+说明: 完成当前节点，进入下一节点
+* method: `POST`
+* url: `http://IP:端口/gateway/服务名/api/bpm/core/task/{id}/complete`
+* PathVariables
+    | 参数       | 参数类型 | 是否必须 | 释义        | 备注 |
+    | ---------- |-------- |-------- | ----------- | ---- |
+    | id | String   | 是  |  任务id    ||
+    
+* RequestParams
+    | 参数       | 参数类型 | 是否必须 | 释义        | 备注 |
+    | ---------- |-------- |-------- | ----------- | ---- |
+    | businessId | String      |是       | 业务id   |      |
+    |runtime[taskDefKey]|String|是|任务定义key||
+    |approve[type]|String|是|审批方式|审批方式 onlyApprove:单人审批,anyApproveList:任意一人审批,parApproveList:并行审批审批,seqApproveList:串行审批|
+    |bpmOperValue|String|是|操作值||
+    |bpmOperName|String|是|操作名称||
+    | bpmSubject | String      |否       | 待办标题   |      |
+    | bpmUrgent | String      |否       | 紧急程度   |      |
+    | bpmSecret | String      |否       | 密级程度   |      |
+    |下一节点的任务定义key_下一节点的审批方式|String|否|下一节点审批人员|当不传时：下一节点的审批人员为全部，当传参时：下一节点的审批人员为传入的人员。传入的值为人员编码。多个人员时，按逗号隔开，当设计器中设置为单人审批时，只能传入一个人员编码。例如：Activity_0vjczzn_anyApproveList："test1,test2",Activity_0vjczzn表示：下一节点的任务定义key,anyApproveList表示：下一节点的审批方式|
+    | 自定义流程参数|String | 否   | 自定义流程参数 | |
+* ResponseBody
+    返回数据类型：MainForm对象
+
+<b>Postman样例:</b>
+适用于前端直接调用
+http://127.0.0.1:8080/gateway/cloud-system-bpm-demo/api/bpm/core/task/94c159ee-773a-11eb-930f-00d861edd189/complete?businessId=3f28824f77d7e9a60177d802f61d0000&runtime[taskDefKey]=Activity_0vjczzn&approve[type]=onlyApprove&bpmOperValue=bpmSendBtn&bpmOperName=发送
+
+```json
+   {
+       "businessId":"3f28824f77d7e9a60177d802f61d0000",
+       "runtime[taskDefKey]":"Activity_0vjczzn",
+       "approve[type]":"onlyApprove",
+       "bpmOperValue":"bpmSendBtn",
+       "bpmOperName":"发送"
+   }
+```
+
+返回数据如下：
+```json
+    {
+    "timestamp": 1614307657500,
+    "status": 1,
+    "message": "成功",
+    "stackmessage": null,
+    "path": "/api/bpm/core/task/94c159ee-773a-11eb-930f-00d861edd189/complete",
+    "data": {
+        "tenantId": "",
+        "createTime": 1614236908000,
+        "updateTime": 1614307657269,
+        "creatorId": null,
+        "reviserId": null,
+        "id": "3f28824f77d7e9980177d8047c920003",
+        "appModuleName": "差旅费",
+        "appModuleId": "报销",
+        "appSystemId": "BPM",
+        "appSystemName": "BPM系统",
+        "procDefId": "Process_Demo1:4:d349d3dd-7689-11eb-ac36-00d861edd189",
+        "procInstId": "42a93008-7738-11eb-8728-00d861edd189",
+        "procDefKey": "Process_Demo1",
+        "flowReaderIds": ",test1,",
+        "flowReaderNames": "测试1",
+        "flowAuthorIds": null,
+        "flowAuthorNames": "",
+        "procDealStatus": "over",
+        "drafterName": "测试1",
+        "drafterId": "test1",
+        "drafterDeptId": "yanfa",
+        "drafterDeptName": "技术研发部",
+        "subject": "测试1_2021-02-25 00:00_出差报销",
+        "urgent": "普通",
+        "secret": "高级",
+        "formLink": "/bpm-demo/example/index.html#/formEdit?id=3f28824f77d7e9a60177d802f61d0000",
+        "preActDealerId": "test1",
+        "preDealerId": "test1",
+        "preActId": "Activity_0vjczzn",
+        "nodeIds": "over",
+        "nodeNames": "办结",
+        "lockUserId": "test1",
+        "lockUserName": "测试1",
+        "lockStatus": null,
+        "bpmVersion": 1,
+        "businessId": "3f28824f77d7e9a60177d802f61d0000",
+        "portalMode": "default",
+        "portalUrl": ""
+    },
+    "extraInfo": {},
+    "success": true
+}
+```
+
+<b>java测试样例:</b>
+适用于后端调用
+ 注入com.meritdata.cloud.bpm.core.BpmEngine类
+```java
+    @Autowired
+    BpmEngine bpmEngine;
+
+    @ApiOperation(value = "完成任务", notes = "根据任务id，完成任务")
+    @RequestMapping(value = "/task/complete", method = RequestMethod.POST)
+    public ResultBody<MainFormDTO> complete() {
+        // 任务id
+        String id = "9f2c6791-7748-11eb-90ec-00d861edd189";
+        Map variables = new HashMap();
+        variables.put("businessId","3f28824f77d7e9a60177d806daab0001");
+        variables.put("runtime[taskDefKey]","Activity_0vjczzn");
+        variables.put("approve[type]","onlyApprove");
+        variables.put("bpmOperValue","bpmSendBtn");
+        variables.put("bpmOperName","发送");
+        // 调用完成任务
+        ResultBody<MainFormDTO> mainFormVo = bpmEngine.complete(id,variables);
+        return mainFormVo;
+    }
+```