QuickStart.md · seven/工作流引擎

## 快速上手

### 创建流程设计
该步骤是设计我们的流程节点该怎么走。

####  ***简单流程***
- 在流程设计页面，点击新增，输入流程名称，点击确定，即可创建一条流程设计记录,新增成功后自动进入到流程设计页面。
![新增](ReadmeImges/流程设计-新增.png )

- 也可以通过点击列表的编辑按钮，进入到设计页面。
![编辑](ReadmeImges/流程设计-编辑.png )
在设计页面，左边是可拖拽的节点，中间的节点布局，右边是属性编辑区。
![新增](ReadmeImges/流程设计-设计.png )

- 从左边拖拽节点到中间进行布局设计，开始-普通-结束，这是最简单的流程设计。
 ![节点拖拽](ReadmeImges/流程设计-节点拖拽.gif )
- 节点连线，鼠标放到布局区节点的 左边图标，鼠标会变成 十字 ，点击拖拽，放到目标节点，放开鼠标，就自动连接上了。
![节点拖拽](ReadmeImges/流程设计-节点连线.gif)
- 点击右上角的 保存 按钮，即可保存流程设计。
![节点拖拽](ReadmeImges/流程设计-编辑-保存.png)
这样一个简单的流程就完成了。

####  ***有分支的流程***
- 一个节点可以连接到几个下级节点，这样就构成了多分支流程。
![多分支连接](ReadmeImges/流程设计-多分支连接.gif)

#### ***有会签的流程***
- 多个节点连线到会签节点，实现会签（等待所有人都处理完才到下一步）。
![会签连接](ReadmeImges/流程设计-节点会签.gif)

####  ***有子流程的流程***
- 使用子流程节点，可以实现等待子流程节点审批完成后，主流程才会到下一个节点（慎用子流程）。子流程节点 和 子节点节点 是配合使用，一个子流程必须用子节点节点做起始节点，子节点用于标记这里子流程的开始节点。一个子流程可以有多个子节点节点，可以通过条件配置指定走哪个子流程（后面会讲条件配置）
![子流程](ReadmeImges/流程设计-子流程设计.png)
多个子流程分支的情况（当然，这个不建议，如果需要有多个子流程分支，则应该在外层就指定多个子流程节点，在外层先进行判断）：
![子流程](ReadmeImges/流程设计-多个子流程设计.png)

***子流程的逻辑相对麻烦，驳回可能会有问题，如果有此类需求，优先建议将节点都平铺出来，类似这种：***
![子流程](ReadmeImges/流程设计-子流程设计-问题.png)

### 节点属性
点击节点，在右侧可以编辑该节点的属性。

***注意：配置完的节点信息，一定要点击配置面版右下角的 确定 按钮保存，否则配置信息调整无效。***
#### 名称
节点显示名称

#### 审批人员
审批人员的配置确定这个节点由谁来审批。

一个节点可以增加多个配置项。  可以通过自定义人员选择器来增加人员的选择类型（详见扩展点）

- 点击 添加人员，会新增一个人员配置项
![添加人员](ReadmeImges/流程设计-节点配置-添加人员.png),其中，
  - 人员类型。人员类型指定了这个人按什么样的方式或者分类获取。比如，按角色，按职位等
  - 人员项。分类明细，指定具体的类型，比如，类型按角色，则这个人员项则选择具体的某个角色。
  ![人员选择](ReadmeImges/流程设计-节点配置-添加人员-人员选择.png)
  - 参数。这个为额外的配置项，具体作用和用法由人员选择器决定。
  - 审批、抄送。审批，则该配置项匹配的人员将可以审批，抄送，则该选项匹配的人员只能查看，不能审批。
  - 描述。自定义备注。

#### 等待所有人审批
  如果勾选了该选项，当匹配到多个人时，将等到所有人都审批完成才会往下走。（有点类似会签，但是会签的等待上游的所有节点审批，但每个节点都有可能匹配到多个人，特别时按职位匹配时）

#### 退回节点
退回节点用于手动指定审批驳回时，驳回到哪个节点上。默认情况下，无需指定退回节点，驳回时将自动回溯到上一级的节点。
 - 点击 添加节点 增加一个退回节点配置
  ![人员选择](ReadmeImges/流程设计-节点配置-退回节点.png)

- 选择节点。指定驳回时要返回的是哪个节点。由于节点处理没那么智能，这里的节点一定要选择其上游的节点，否则流程可能会有问题。
  - 回退条件。配置驳回时，验证是否退回到指定的节点。只有满足条件时，才能退回。默认不指定时，将无条件回退到指定的节点。退回条件配置信息：
    - 条件类型。该选项指定要用什么处理逻辑来做判断。l条件类型可以通过自定义条件处理器扩展（详见扩展点）。
    - 参数。提供参数给处理逻辑解析，不同的条件类型需要的参数可能不一样，除此之外，在后台处理时，还会结合表单数据，流程信息等信息进行解析，具体处理方式以条件类型为准。
      
      比如，条件类型 选择 布尔处理器，参数 传 true 则，标识，这个条件是满足的，但这种方式是写死的。
      
      如果使用 表单条件处理器，参数传 value(请假天数)>3（请假天数 为json表单字段）,则匹配审批表单的请假天数 大于 3，才会满足。

**再次强调，使用什么参数格式，得看条件类型的规范，**

### 线条属性
点击连接节点的线条，可以配置线条的属性。线条主要配置的是条件处理，其确定了这条线是否走的通。

***注意：配置完的节点信息，一定要点击配置面版右下角的 确定 按钮保存，否则配置信息调整无效。***

点击线条，右侧将切换为线条属性配置。
![线条配置](ReadmeImges/流程设计-线条配置.png)

#### 线条名称
线条名称 将显示在设计图的线条上，通常，如果该线条配置了条件，可以将条件作为名称。
![条件名称](ReadmeImges/流程设计-线条配置-条件名称.png)

#### 添加条件 
通过配置条件，来决定该连线是否能联通。

在节点审批时，将判断下游节点的连线，哪条线连的通就派发到连接的节点。相当于某些流程设计里的判断节点。’
这里的思路是直接赋予线条条件，连线能不能打通，就看条件满不满足。

***对于子流程的线条配置，如果一个子流程节点有多个子流程，则应该只能让其满足一条分支，否则流程会有问题***

参考 节点配置--退回节点--回退条件。

***附条件处理器的解析基本流程：***
- 数据来源：审批时，对条件进行判断时，有两个来源，一个是一开始填写，发起后就不能更改的 表单数据，一个是在每一个人审批都可以有自己步骤的表单数据 这里称为审批表单（通常不需要，看实际情况）。他们在条件解析
时是通过不同的字段传入的：
![条件名称](ReadmeImges/流程设计-线条配置-条件数据来源.png)
而条件解析传入的表达式将作为公式解析，用来判断表单的数据是否满足表达式的公式。
![条件名称](ReadmeImges/流程设计-线条配置-条件数据来源-表达式.png)

- 数据解析。不同的条件处理器解析不同，这里以 Json条件处理器为例（2023-5-1 新增），该处理器支持通过 "\${属性key}" 的方式来解析变量，比如，表单的数据是这样 ："{days:12}"，则通过 \${days} 即可取到 12，如果我们的表达式 写成 "\${days}>10"，那这个条件就会解析为 12>10 ,
显然就会返回 true。具体怎么解析还得看条件处理器怎么支持。

既然数据是通过 属性key 来获取数据，那我们的表单里也要有这个key才行。

如果表单数据是直接在输入框编辑,就直接指定属性名称，比如，
![条件名称](ReadmeImges/流程设计-线条配置-条件数据来源-表单key.png)

那如果是通过动态表单配置的表单，则一定要手动指定控件的属性名称：
![条件名称](ReadmeImges/流程设计-线条配置-条件数据来源-动态表单key.png)

### 流程信息
通过点击编辑面版的右上角 流程信息 可以查看当前设计的 json 信息，还可以直接更新 json 信息以实现编辑，通常需要复制一个流程时，可以通过该功能。
![条件名称](ReadmeImges/流程设计-编辑-复制编辑.png)

### 保存
点击右上角的保存按钮保存流程设计。
![保存](ReadmeImges/流程设计-编辑-保存.png)

- 描述。这个是这个流程的描述
- 版本。一个流程设计可以有多个版本，通过多版本控制，可以实现在业务演变过程中，调整流程，并且保证已经审批中的流程正常。
- 版本描述。针对这个版本的描述。

### 列表功能
![列表功能](ReadmeImges/流程设计-列表功能.png)

- 查看。快速查看设计图
- 编辑。进入设计页面编辑设计图。
- 版本切换。一个流程设计随着业务变化会有多个版本，该版本切换确定新建的流程使用哪个版本。
- 模拟。该功能提供流程设计的模拟验证，以确保调整的流程是否正常。
  - 点击模拟会进入到流程模拟页面
  ![模拟](ReadmeImges/流程设计-列表功能-模拟.png)
  在模拟页面，可以手动编辑json表单数据，然后指定人员进行审批。
  - 是否模拟。该勾选项如果不勾选，将当作一条正常的流程发起审批。仅为了测试，默认勾选。
  - 审批。模拟流程发起后，可以切换当前用户吗，如果下一个步骤是他审批的，将会看到审批表单。
  ![列表功能](ReadmeImges/流程设计-列表功能-模拟-切换-当前用户.png)
  审批可以进行直接审批或者转发
  ![列表功能](ReadmeImges/流程设计-列表功能-模拟-审批.png)
  ![列表功能](ReadmeImges/流程设计-列表功能-模拟-转发.png)
    - 表单数据。该参数适用于每次审批可能会更改表单数据的场景。该场景可能发生在作业流控制，即在某些节点可以编辑数据。
    - 批语。
    - 其它（在模拟页面没有附件等上传，但实际应用过程，可以在不同的审批不同提交附件文件等）
    - 转发即转给另一个人处理，转发的人员也是通过人员选择器选择，详细参考节点配置的人员选择。

### 配置流程表单
*这一步不是必须。如果你的系统有自己的表单，这里则用不上。在这里，是为了让演示环境更完整以及方便，才增加了动态表单模块*

*流程表单和流程设计不是必须关联的，在demo平台上的表单设计只是提供一种应用的参考方式。可以但不限于。可以理解为，这里的表单只是为了将表单数据进行可视化，可操作化*

#### 表单创建
切换到 流程表单 功能菜单，点击新增，创建一个与指定流程设计版本的表单。
![创建](ReadmeImges/流程表单-创建.png)

#### 表单编辑
新建的表单需要通过列表页，点击编辑进入到编辑页面，在编辑页面编辑表单。
![创建](ReadmeImges/流程表单-编辑.png)
与流程设计类型，表单设计也分三个区域，左侧控件区，中间是布局区，右侧是控件属性区。
通过拖拽左边的控件到中间编辑区进行控件布局。
![推拽](ReadmeImges/流程表单-编辑-推拽.png)
![布局](ReadmeImges/流程表单-编辑-布局.png)

#### 控件编辑
选中布局区域的控件，通过其下的功能按钮可以进行简单的控件编辑。

![控件编辑](ReadmeImges/流程表单-编辑-布局-控件编辑.png)
 - 删除。从布局区域移除该控件
 - 复制。复制一个同样的控件（会生成新的控件id）
 - 编辑。点击编辑右侧将会出现该控件的属性面版，可直接编辑属性。
 ![控件属性](ReadmeImges/流程表单-编辑-布局-控件属性.png)
 不同的控件类型可编辑的控件属性也有所不同。通常有：
  - 宽度。宽度将表单的宽度分为24 个栅格，选择 6 个栅格表示该控件占据 1/4 的宽度。12 个栅格标识占据了 1/2 的宽度。
  - 字段。自动生成的字段名称。可以手动指定（但不可重复）。通常如果需要在流程中解析字段数据时，应该要手动指定字段名称。
  - 字段类型。也是控件类型，切换将更改控件样式和可配置的属性。
  - 默认值。指定默认值。

#### 几种特殊的控件和属性
- 单、多选。比如 checkbox，select，radiobox 等，对于这些，特别提供了 选项属性,选项属性是一组数组，指定选择值和名称两个属性填写。
 ![控件属性](ReadmeImges/流程表单-编辑-布局-控件属性-选择项.png)

- 表格table。表格需要配置每一列的数据，每一列又可以是不同的数据类型，所以表格的属性相当于嵌套了一层控件
 ![控件属性](ReadmeImges/流程表单-编辑-布局-控件属性-表格.png)

#### 预览
点击预览可以查看生成的表单效果。

#### 保存
与流程设计类似，流程表单也可以进行版本管理，一个流程设计可以设计多版表单，但最终数据呈现以激活的版本为准。

![控件属性](ReadmeImges/流程表单-保存.png)

### 发起审批

在 流程审批--我发起的-新建 ，即可创建和发起审批。

## API

[API文档](/Api.md)

常用开放接口基本说明

## 插件系统
  系统实现了一套插件管理逻辑，目的是为了某些插件（扩展点）可以配置和复用。
  管理员登录可以对插件进行管理和配置

[插件系统文档](/Plugin.md)

seven/工作流引擎

简介

发行版

贡献者

近期动态

seven/工作流引擎 .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

seven/工作流引擎