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

130 lines
3.1 KiB
Markdown

# 流程模板创建与配置
> 来源:前端 `views/onlineDev/flowEngine/DesignForm.vue`、后端 `DefinitionController.java`
## 创建模板
### DesignForm.vue 关键代码
```typescript
// 模板创建/编辑
const query = {
...values,
iconBackground: state.iconBackground,
id: state.dataForm.id,
type: state.dataForm.type, // 0=标准, 1=简单, 2=任务, 4=决策
};
const formMethod = state.dataForm.id ? update : create;
formMethod(query).then((res) => {
if (type === 1) emit('design', { id, fullName, type });
});
```
### 模板字段说明
| 字段 | 说明 | 必填 |
|------|------|------|
| fullName | 流程名称 | 是 |
| enCode | 流程编码 | 是 |
| type | 流程类型 | 是 |
| category | 分类ID | 是 |
| icon | 图标 | 是 |
| iconBackground | 图标背景色 | 否 |
| showType | 显示位置 | 否 |
| sortCode | 排序 | 否 |
| description | 说明 | 否 |
### 流程类型 (type)
| type | 名称 | 说明 |
|------|------|------|
| 0 | 标准流程 | 用户自定义节点和连线 |
| 1 | 简单流程 | 预定义三节点 |
| 2 | 任务流程 | 任务处理节点 |
| 3 | 自由流程 | 自由选择审批人 |
| 4 | 决策流程 | 条件分支决策 |
### API 调用
```python
# 创建模板
resp = client.workflow.create_template({
"fullName": "采购审批",
"enCode": "purchaseFlow",
"type": 1,
"category": "category_id",
"icon": "icon-ym icon-ym-flow",
"iconBackground": "#008cff",
})
template_id = resp.id
# 更新模板
client.workflow.update_template({
"id": template_id,
"fullName": "采购审批(修订版)",
})
# 删除模板
client.workflow.delete_template(template_id)
```
## 版本管理
### 新增版本
```typescript
// copyVersion -> 返回新版本ID
copyVersion(currentVersion.id).then((res) => {
const newVersionId = res.data;
});
```
### 版本状态
| state | 名称 | 说明 |
|-------|------|------|
| 0 | 设计中 | 可编辑 |
| 1 | 启用中 | 已发布运行 |
| 2 | 已归档 | 不可用 |
### API 调用
```python
# 获取版本列表
versions = client.workflow.get_version_list(template_id)
for v in versions.data:
print(f"版本: {v['fullName']}, state={v['state']}, id={v['id']}")
# 新增版本(复制)
new_version = client.workflow.copy_version(version_id)
# 删除版本
client.workflow.delete_version(version_id)
```
## 模板信息获取
```python
# 获取模板详情
info = client.workflow.get_template_info(template_id)
# 获取流程设计信息(包含 flowNodes)
flow_info = client.workflow.get_flow_info(version_id)
# 获取流程列表(分页)
list_resp = client.workflow.get_template_list({
"currentPage": 1,
"pageSize": 20,
})
```
## 平台示例
| 模板 | ID | type | 说明 |
|------|-----|------|------|
| 请假申请 | 585824179933152389 | 0 | 自由审批,包含请假类型、时长验证 |
| 销售订单 | 585824509966156933 | 1 | 简单流程,商品明细 |
| CRM订单 | 585361795057715206 | 1 | 简单流程,商品明细、收款计划 |
| 物资申请 | 588008146002249413 | 1 | 简单流程 |
| 付款申请 | 588010241019348677 | 1 | 简单流程 |