Files
aibridge/docs/workflow/02-flow-design-guide.md
T
2026-05-18 09:28:15 +08:00

232 lines
5.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 流程设计指南
> 来源:前端 `views/onlineDev/flowEngine/Form.vue`、FlowProcess 组件
## 流程设计器结构
### Form.vue 关键代码
```typescript
// 获取流程设计数据
getFlowInfo(currentVersion.id).then((res) => {
state.dataForm = { ...state.dataForm, ...res.data };
state.flowConfig = JSON.parse(state.dataForm.flowConfig || '{}');
});
// 保存流程设计
saveFlow({
...data,
id: template_id,
flowId: version_id,
flowConfig: JSON.stringify(flowConfig),
}).then((res) => {
if (data.type === 1) {
// 发布
currentVersion.state = 1;
}
});
```
## save_flow 接口
### 请求参数
```python
client.workflow.save_flow({
"id": template_id, # 模板ID
"flowId": version_id, # 版本ID
"flowXml": flow_xml, # BPMN XML(需URL编码)
"flowNodes": flow_nodes, # 节点配置字典
"flowConfig": flow_config, # JSON字符串
"type": 1, # 0=保存, 1=发布
})
```
### flowXml 格式
**简单流程(type=1)** - 必须 URL 编码:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<bpmn2:definitions ...>
<bpmn2:process id="Process_1">
<bpmn2:startEvent id="Event_0oz4pwh">
<bpmn2:outgoing>Flow_1iadlmn</bpmn2:outgoing>
</bpmn2:startEvent>
<bpmn2:userTask id="Activity_1qf73gq">
<bpmn2:incoming>Flow_1iadlmn</bpmn2:incoming>
<bpmn2:outgoing>Flow_1kz1x8a</bpmn2:outgoing>
</bpmn2:userTask>
...
</bpmn2:process>
</bpmn2:definitions>
```
### flowNodes 结构
```python
{
"global": {
"type": "global",
"nodeId": "global",
"formId": "form_id",
"titleType": 0,
"defaultContent": "{发起用户名}的{流程名称}",
"hasSign": False,
"hasRevoke": False,
"hasComment": True,
"connectList": ["Flow_1", "Flow_2"],
},
"Event_0oz4pwh": { # 发起节点
"type": "start",
"nodeId": "Event_0oz4pwh",
"nodeName": "流程发起",
"formId": "form_id",
},
"Activity_1qf73gq": { # 审批节点
"type": "approver",
"nodeId": "Activity_1qf73gq",
"nodeName": "部门审批",
"formId": "form_id",
"assigneeType": 6,
"approvers": [{"id": "user_id", "type": "user"}],
"counterSign": 0,
"hasOpinion": True,
},
"Event_0zlhfee": { # 结束节点
"type": "end",
"nodeId": "Event_0zlhfee",
},
}
```
### flowConfig 结构
```python
# 简单/标准/任务/自由流程
{"visibleType": 1} # 1=公开, 2=权限设置
# 决策流程
{
"visibleType": 1,
"startParameterList": [], # 自定义入参
"endParameterList": [], # 自定义出参
}
```
## AIBridge 便捷方法
```python
# 一键创建简单流程(推荐)
result = client.workflow.create_simple_flow(
full_name="采购审批",
en_code="purchaseFlow",
form_id="visual_dev_id",
approver_user_ids=["user_id_1", "user_id_2"],
)
# 返回: {"template_id": "...", "version_id": "..."}
# 创建标准流程
result = client.workflow.create_standard_flow(
full_name="请假申请",
en_code="leaveFlow",
form_id="visual_dev_id",
)
# 创建任务流程
result = client.workflow.create_task_flow(
full_name="任务处理",
en_code="taskFlow",
form_id="visual_dev_id",
handler_user_ids=["user_id"],
)
# 创建自由流程
result = client.workflow.create_free_flow(
full_name="自由审批",
en_code="freeFlow",
form_id="visual_dev_id",
approver_user_ids=["user_id"],
)
# 创建决策流程
result = client.workflow.create_decision_flow(
full_name="条件审批",
en_code="decisionFlow",
form_id="visual_dev_id",
branch_a_user_ids=["user_id_1"],
branch_b_user_ids=["user_id_2"],
)
```
## 审批节点配置 (assigneeType)
| 值 | 名称 | 配置项 |
|---|------|-------|
| 1 | 发起人上级 | managerLevel: 1-10 |
| 2 | 特定岗位 | assignList: 岗位列表 |
| 3 | 发起人自己 | - |
| 4 | 表单变量 | formFieldType, formField |
| 5 | 审批节点 | approverNodeId |
| 6 | 指定成员 | approvers: [{id, type}] |
| 7 | 候选人 | isCandidates: true |
| 9 | 数据接口 | interfaceConfig |
| 10 | 逐级审批 | managerLevel |
## 会签配置 (counterSign)
```python
{
"counterSign": 1, # 0=或签, 1=会签, 2=依次审批
"counterSignConfig": {
"auditType": 1, # 1=按百分比, 2=按人数
"auditRatio": 100, # 通过比例
"auditNum": 1, # 通过人数
"rejectType": 0, # 拒绝规则
"rejectRatio": 10,
"rejectNum": 1,
}
}
```
## 按钮配置
```python
{
"hasAuditBtn": True,
"auditBtnText": "同意",
"hasRejectBtn": True,
"rejectBtnText": "拒绝",
"hasBackBtn": False,
"backBtnText": "退回",
"hasFreeApproverBtn": False,
"freeApproverBtnText": "加签",
"hasReduceApproverBtn": False,
"reduceApproverBtnText": "减签",
"hasTransferBtn": False,
"transferBtnText": "转审",
"hasAssistBtn": False,
"assistBtnText": "协办",
"hasSaveAuditBtn": False,
"saveAuditBtnText": "暂存",
}
```
## 超时配置
```python
{
"timeLimitConfig": {
"on": 1, # 0=不启用, 1=启用
"nodeLimit": 0, # 节点时限
"duringDeal": 24, # 办理时长(小时)
},
"overTimeConfig": {
"on": 2, # 0=不启用, 1=自动通过, 2=通知
"firstOver": 24, # 首次超时时间
"overNotice": True,
"overAutoApprove": False,
"overAutoApproveTime": 5,
}
}
```