184 lines
6.1 KiB
Markdown
184 lines
6.1 KiB
Markdown
# JNPF Workflow 文档索引
|
||
|
||
> JNPF 流程平台开发指南,整理自 17 条平台示例和前后端源码分析。
|
||
|
||
## JNPF 与 Flowable 引擎集成
|
||
|
||
JNPF 工作流基于 **Flowable** 引擎实现,流程数据存储在 JNPF 数据库,但流程执行由 Flowable 管理。
|
||
|
||
### 数据存储
|
||
|
||
| 组件 | 存储位置 | 说明 |
|
||
|------|----------|------|
|
||
| 流程模板 | `base_flow_template` 表 | JNPF 管理 |
|
||
| 流程版本 | `base_flow_template` 版本字段 | JNPF 管理 |
|
||
| 流程实例 | Flowable 表(ACT_*) | Flowable 引擎 |
|
||
| 任务节点 | Flowable 表(ACT_RU_*) | Flowable 引擎 |
|
||
| 表单数据 | `base_flow_task` 表 | JNPF 管理 |
|
||
|
||
### 集成机制
|
||
|
||
1. **模板发布**:JNPF 保存流程模板(含 flowXml/flowNodes)到 `base_flow_template`
|
||
2. **流程发起**:JNPF 调用 Flowable API 创建流程实例,Flowable 生成任务节点
|
||
3. **审批操作**:JNPF 调用 Flowable API 完成审批,Flowable 推进流程
|
||
4. **任务查询**:JNPF 关联查询 Flowable 表和 JNPF 表,返回完整状态
|
||
|
||
### 关键表关系
|
||
|
||
```
|
||
base_flow_template (模板)
|
||
↓ version_id
|
||
base_flow_task (流程实例) ← 关联 → Flowable ACT_RU_* (任务)
|
||
```
|
||
|
||
### 与标准 Flowable 的差异
|
||
|
||
- JNPF 对 Flowable 做了封装,API 路径为 `/api/workflow/*`
|
||
- Flowable 原生 API 通过内部服务调用,不直接暴露
|
||
- 表单数据绑定在 JNPF 层,Flowable 只负责流程控制
|
||
|
||
## 文档结构
|
||
|
||
```
|
||
workflow/
|
||
├── README.md # 本文档(速查入口)
|
||
├── 01-template-guide.md # 流程模板创建与配置
|
||
├── 02-flow-design-guide.md # 流程设计指南
|
||
├── 03-task-operation-guide.md # 任务操作指南
|
||
├── 04-approval-operation-guide.md # 审批操作指南
|
||
├── 05-advanced-features-guide.md # 高级功能指南
|
||
├── 06-examples/ # 示例文档
|
||
│ ├── 01-simple-flow.md # 简单流程(type=1)
|
||
│ ├── 02-standard-flow.md # 自由审批流程(type=0)
|
||
│ ├── 03-trigger-flow.md # 触发器流程(type=2)
|
||
│ └── 04-form-workflow.md # 表单工作流(webType=3)
|
||
└── 07-troubleshooting.md # 故障排查
|
||
|
||
../workflow-guide.md # 完整开发指南(详细)
|
||
```
|
||
|
||
## 快速参考
|
||
|
||
### 流程类型
|
||
| type | 名称 | 说明 |
|
||
|------|------|------|
|
||
| 0 | 自由审批 | 标准审批流程,用户自定义节点和连线 |
|
||
| 1 | 简单流程 | 预定义三节点(发起→审批→结束) |
|
||
| 2 | 触发器流程 | Webhook/定时触发,无审批环节 |
|
||
| 3 | 自由流程 | 允许自由选择审批人 |
|
||
| 4 | 决策引擎 | 条件分支决策 |
|
||
|
||
### 节点类型
|
||
| type | 名称 | 说明 |
|
||
|------|------|------|
|
||
| start | 发起节点 | 流程发起 |
|
||
| approver | 审批节点 | 需要审批 |
|
||
| processing | 办理节点 | 任务处理 |
|
||
| subFlow | 子流程 | 调用子流程 |
|
||
| free | 自由节点 | 自由选择审批人 |
|
||
| gateway | 网关 | 条件路由 |
|
||
|
||
### 审批人指定方式 (assigneeType)
|
||
| 值 | 名称 | 说明 |
|
||
|---|------|------|
|
||
| 1 | 发起人上级 | 发起人的 N 级上级 |
|
||
| 2 | 特定岗位 | 指定岗位审批 |
|
||
| 3 | 发起人自己 | 发起者自己审批 |
|
||
| 4 | 表单变量 | 从表单字段中选择审批人 |
|
||
| 5 | 审批节点 | 指定流程中某个节点审批人 |
|
||
| 6 | 指定成员 | 直接指定审批人 |
|
||
| 7 | 候选人 | 发起时选择审批人 |
|
||
| 9 | 数据接口 | 从接口获取审批人 |
|
||
| 10 | 逐级审批 | 按层级向上审批 |
|
||
|
||
### 会签规则 (counterSign)
|
||
| 值 | 名称 | 说明 |
|
||
|---|------|------|
|
||
| 0 | 或签 | 一名审批人同意或拒绝即可 |
|
||
| 1 | 会签 | 无序会签,达到会签比例通过 |
|
||
| 2 | 依次审批 | 按顺序依次审批 |
|
||
|
||
### 常用操作
|
||
```python
|
||
# 创建简单流程
|
||
result = client.workflow.create_simple_flow(
|
||
full_name="采购审批",
|
||
en_code="purchaseFlow",
|
||
form_id=func_id,
|
||
approver_user_ids=["user_id"],
|
||
)
|
||
version_id = result["version_id"]
|
||
|
||
# 发起流程
|
||
task = client.workflow.launch_task(version_id, {"f_amount": 5000})
|
||
|
||
# 审批
|
||
client.workflow.approve(operator_id, "同意")
|
||
|
||
# 拒绝
|
||
client.workflow.reject(operator_id, "不同意")
|
||
|
||
# 退回
|
||
client.workflow.back(operator_id, {"targetNodeId": "node_id"})
|
||
```
|
||
|
||
## 关键配置参考
|
||
|
||
### flowNodes 结构
|
||
```json
|
||
{
|
||
"global": { "formId": "", "titleType": 0 },
|
||
"Event_0oz4pwh": { "type": "start", "formId": "" },
|
||
"Activity_1qf73gq": { "type": "approver", "assigneeType": 6, "approvers": [] },
|
||
"Event_0zlhfee": { "type": "end" }
|
||
}
|
||
```
|
||
|
||
### flowXml
|
||
BPMN 2.0 XML,简单流程需要 URL 编码。
|
||
|
||
### flowConfig
|
||
```json
|
||
{"visibleType": 1}
|
||
```
|
||
- visibleType=1: 公开
|
||
- visibleType=2: 权限设置
|
||
|
||
## 源码位置
|
||
|
||
### 前端
|
||
| 文件 | 路径 |
|
||
|-----|------|
|
||
| 流程设计器 | `views/onlineDev/flowEngine/Form.vue` |
|
||
| 流程模板表单 | `views/onlineDev/flowEngine/DesignForm.vue` |
|
||
| 流程解析器 | `views/workFlow/components/FlowParser.vue` |
|
||
| 节点配置 | `views/workFlow/components/NodeFormParser.vue` |
|
||
| API: task | `src/api/workFlow/task.ts` |
|
||
| API: template | `src/api/workFlow/template.ts` |
|
||
|
||
### 后端
|
||
| 文件 | 路径 |
|
||
|-----|------|
|
||
| DefinitionController | `后端/jnpf-workflow/.../controller/DefinitionController.java` |
|
||
| TaskController | `后端/jnpf-workflow/.../controller/TaskController.java` |
|
||
| FlowUtil | `后端/jnpf-workflow-core/.../util/FlowUtil.java` |
|
||
| FlowableUtil | `后端/jnpf-workflow-core/.../util/FlowableUtil.java` |
|
||
|
||
## 平台示例(17条)
|
||
|
||
详见 [workflow_examples.md](../../docs/workflow_examples.md)
|
||
|
||
| 类型 | 数量 | 示例 |
|
||
|------|------|------|
|
||
| type=0 自由审批 | 9 | leaveApply, 采购申请, 付款申请, 离职申请... |
|
||
| type=1 简单流程 | 4 | crmOrder, salesOrder, materialapply, paymentapply |
|
||
| type=2 触发器 | 4 | webhook, Timedtrigger, customeradd, messagetrigger |
|
||
|
||
## 常见错误
|
||
|
||
1. **create_template 必须含 flowXml/flowNodes/flowConfig** - 否则 NPE
|
||
2. **审批需要 status 字段** - status=1 同意, status=2 拒绝
|
||
3. **launch_task 的 isFlow 必须是整数** - 用 1 而非 True
|
||
4. **get_flow_info 参数是 version_id** - 不是 template_id
|
||
5. **审批人不能与发起人相同** - 会报系统异常
|