Files
aibridge/docs/workflow/05-advanced-features-guide.md
2026-05-18 09:28:15 +08:00

202 lines
3.9 KiB
Markdown

# 高级功能指南
## 流程监控
### 监控按钮
```typescript
// FlowParser.vue - 流程监控
if (btnInfo?.hasCancelBtn) monitorBtnList.push({ id: 'cancel', fullName: '终止' });
if (btnInfo?.hasActivateBtn) monitorBtnList.push({ id: 'resurgence', fullName: '复活' });
if (btnInfo?.hasPauseBtn) monitorBtnList.push({ id: 'pause', fullName: '暂停' });
if (btnInfo?.hasAssignBtn) monitorBtnList.push({ id: 'assign', fullName: '指派' });
```
### API 调用
```python
# 获取监控列表
resp = client.workflow.get_monitor_list({
"currentPage": 1,
"pageSize": 20,
})
# 终止流程
client.workflow.cancel(task_id)
# 暂停流程
client.workflow.pause(task_id)
# 复活流程
client.workflow.resurgence(task_id)
# 指派任务
client.workflow.assign(task_id, {
"assignUserId": "user_id",
})
```
## 流程委托
### 说明
委托用于将审批权临时转交给其他用户,通常在请假或出差时使用。
```python
# 获取委托列表
resp = client.workflow.get_delegate_list({
"currentPage": 1,
"pageSize": 20,
})
```
## Webhook
### 使用流程
```
1. get_webhook_url -> 获取 Webhook URL
2. webhook_start -> 开启接收
3. 外部系统 POST 到 Webhook URL
4. JNPF 自动创建并启动流程
```
### API 调用
```python
# 获取 Webhook URL
resp = client.workflow.get_webhook_url({"flowId": flow_id})
webhook_url = resp.data # "http://..."
# 获取 Webhook 字段
resp = client.workflow.get_webhook_params(random_str)
# 开启 Webhook
client.workflow.webhook_start(flow_id, random_str)
```
## 流程评论
```python
# 获取评论列表
resp = client.workflow.get_comment_list({"taskId": task_id})
# 添加评论
client.workflow.create_comment({
"taskId": task_id,
"content": "请尽快处理",
"type": 1,
})
# 删除评论
client.workflow.delete_comment(comment_id)
```
## 收藏流程
```python
# 获取收藏流程列表
resp = client.workflow.get_collect_flow_list()
# 收藏/取消收藏
client.workflow.set_collect_flow(template_id)
```
## 上架/下架
```python
# 上架/下架流程模板
client.workflow.up_down_shelf({
"id": template_id,
"enabledMark": 1, # 1=上架, 0=下架
})
```
## 流程选择器
```python
# 获取流程列表(用于发起页面选择)
resp = client.workflow.get_flow_selector({"keyword": "采购"})
# 获取流程树形列表
resp = client.workflow.get_tree_list(form_type="3") # 3=工作流表单
```
## 决策参数
```python
# 获取流程决策参数(用于条件分支配置)
resp = client.workflow.get_decision_parameter(template_id)
```
## 节点跳转
### JumpCmd
```java
// 后端 TaskController
public boolean jump(JumpFo fo) {
BpmnModel bpmnModel = repositoryService.getBpmnModel(instance.getProcessDefinitionId());
JumpCmd jumpCmd = new JumpCmd(fo.getInstanceId(), fo.getSource(), fo.getTarget(), "custom jump", bpmnModel, runtimeService);
managementService.executeCommand(jumpCmd);
}
```
### 获取可回退节点
```python
# 获取可回退的节点
resp = client.workflow.get_back_node_list(operator_id)
# 获取后续节点
resp = client.workflow.get_task_next(task_id, node_id)
```
## 子流程
```python
# 查看子流程信息
resp = client.workflow.get_sub_flow_info(
node_code="sub_node_code",
flow_id=task_id
)
```
## 外部节点重试
```python
# 外部节点重试
client.workflow.retry_outside(node_id)
```
## 流程版本管理
```python
# 获取版本列表
versions = client.workflow.get_version_list(template_id)
# 新增版本
new_version = client.workflow.copy_version(version_id)
# 删除版本
client.workflow.delete_version(version_id)
# 切换为标准流程
client.workflow.change_type(template_id) # 简单->标准(不可逆)
```
## 导出模板
```python
# 导出流程模板
resp = client.workflow.export_template(template_id)
# 返回文件流
```
## 复制模板
```python
# 复制流程模板
resp = client.workflow.copy_template(template_id)
new_template_id = resp.id
```