自定义内置工作流 分享链接

本节文档，我们来给大家介绍一下如何自定义我们的内置流程。

前面的文档已经简单的介绍了工作流目前根据禅道使用流程、功能模块以及自定义需要，目前内置了产品视图、产品计划、发布、需求、项目视图、版本、任务、Bug、用例、测试单、套件、反馈这12个流程。

内置流程只能查看、编辑、字段管理和动作管理。不支持标签、子流程、明细表功能，内置流程不能删除。

你可以根据自己的使用需要来自定义内置流程。

下面我们以Bug流程为例，来介绍如何自定义我们的内置流程。

一、查看和编辑

首先，我们来看简单的查看和编辑内置流程功能。

1、查看

点击标题，可以查看Bug流程详情页面。

2、编辑

编辑流程，可以修改流程的名称和描述。（内置流程不可修改流程名）

二、字段管理

对内置流程的字段管理，可以编辑原有字段，也可以为内置流程添加新字段。

1、编辑内置流程原有字段

点击右侧操作区设计按钮，进入编辑器，然后可以根据使用需要，对内置流程字段进行编辑操作。（内置流程字段不能删除）

点击字段列表右侧操作栏的编辑按钮，就可以对内置流程的字段进行编辑。

2、添加新字段

给内置流程添加新字段，点击页面右上角的“添加字段”，即可进入添加新字段的页面。

我们以给Bug添加一个“评审结果”字段为例，

添加字段页面：

• 字段名称： 数据库存储的字段或界面显示的数据项。
• 位于：新增字段显示的位置，下拉里默认显示该流程的其他字段名称。
• 字段代号：只能包含英文字母，用于数据库里存储该字段信息。字段代号
• 字段类型：目前支持数字、日期时间、字符串。 数字支持：tinyint、smallint、mediumint、int、decimal、float、double。 日期时间支持：date、datetime、timestamp。 字符串支持：char、varchar、text。
• 控件：支持标签、文本框、富文本、日期、时间、下拉菜单、单选按钮、复选框。
• 数据源：可以从下拉菜单里选择，也可以选择自定义，然后添加上自定义的值。
• 默认值：选择控件后，该控件显示的默认值。默认值必须填写选项的键。
• 验证规则： 验证数据格式的方式，支持正则表达式。
• 导出：该字段是否可以导出。
• 检索：该字段是否可以搜索。
• 外键： 外键用来关联显示子流程的数据，外键只能有一个。设为外键的字段应该使用下拉菜单或者单选按钮作为控件，如果设为外键的字段控件不是下拉菜单或者单选按钮，系统将默认更新控件为下拉菜单并选择数据源为子流程。

字段添加成功后：

需要特别提醒的是，新加的字段需要在动作界面里勾选上，这样在流程的界面上才会显示出来。

下面我们就开始讲动作的管理功能。

三、动作管理

接着上面添加字段后的，要在动作界面上勾选的问题。

1、动作界面显示新增字段

内置流程的动作默认的扩展方式是不扩展，需要在内置页面添加上新增的字段，需要先编辑该动作，把扩展方式改为扩展。

点击动作列表页右侧操作栏的“编辑”按钮，把扩展方式由不扩展改为扩展。

以Bug详情为例：

改为扩展后的动作，界面和扩展动作的按钮就可以操作了。

点击Bug详情的“界面”，进入界面编辑页面。

点击编辑，可以修改我们在上面添加的“评审结果”字段的显示位置和是否显示。

位置：基本信息，显示在Bug详情页的右侧。详细信息，显示在Bug详情页的左侧。

如果是隐藏，那么在这个Bug详情这个页面则不显示我们新增的这个“评审结果”字段。

在Bug详情页面添加新增的字段“评审结果”成功后，Bug详情页的详细信息或者是基本信息就会显示“评审结果”的信息。

位置选择详细信息时：

位置选择基本信息时：

还可以在Bug列表页，通过自定义列字段，勾选“评审结果”显示在列表栏里。

设置成功后，返回Bug列表页，就可以查看到“评审结果”字段显示在表头字段里。

2、添加动作

 点击动作列表页面右上角的“添加动作”按钮，就可以为内置流程添加新的动作。

我们以为Bug流程添加一个“评审”动作为例：

• 动作名称：新增动作的名称。
• 动作代号：新增动作的代号，只能是英文字母。代号一经填写将不能修改，请慎重。
• 打开方式：执行该动作时，页面的打开方式。目前有：普通页面、弹窗页面、无页面3种方式可选择。
• 显示位置：该动作会在哪个位置显示。目前有：菜单栏、列表页、详情页、列表页和详情页4种方式可以选择。目前仅支持详情页的显示。
• 显示方式：该动作的显示方式。目前有：直接显示在页面上、显示在下拉菜单中2种方式可以选择。目前仅支持显示在页面上。
• 描述：对新增动作的简单描述。

动作新增成功后：

新增的动作可以进行编辑、界面、触发条件、数据校验、界面联动、扩展动作、设置提醒、JS、CSS、删除等操作。

3、设置动作的触发条件

也就是设置在什么条件下，才触发这个动作。也就是什么条件下，页面显示这个操作且可以执行这个操作。
点击动作列表页面右侧操作栏里的“触发条件”，就可以进入到动作触发条件的设置页面。

触发条件的类型可以选择：

下面我们来设置“评审”这个动作的触发条件：

设置好后，在评审结果是未评审的Bug详情页面，就会显示“评审”按钮。

4、设置动作界面

新增了动作之后，需要设置动作的界面。也就是执行这个动作的界面显示什么字段和内容。

4.1 点击动作列表右侧操作栏的“界面”进入界面设置页面。

4.2 点击页面底部的“编辑按钮”，默认的列表里会显示与Bug相关的所有字段。

4.3 把需要在“评审”页面显示的字段勾选（或者点击后侧的显示和隐藏按钮来操作）并设置好验证规则或者默认值。

4.4 都设置完毕后，点击保存即可。

接下来，我们看设置好的评审页面。

我们设置显示的字段都有显示出来，且这些字段可以根据实际使用需要，到界面里做调整。

5、设置动作的数据校验

可以设置，当哪些字段为某一个值时， 执行这个动作后的提示信息。

我们系统里默认的执行这个动作的提示是“保存成功”，通过这个数据校验，你可以根据实际使用需要设置为你需要的提示信息。

数据校验的类型可以选择：以数据为校验方式、以SQL语句为校验方式。

6、设置动作的扩展动作

可以为当前动作新增扩展动作，当执行完当前动作后需要关联更新的数据（字段）。

可以设置在什么条件下触发当前动作的扩展动作，以及设置执行扩展动作后的提示信息。

执行的扩展动作可以是新增、修改或者删除。

触发扩展动作的条件设置和前面介绍动作的触发条件的设置是类似的。在这不再赘述。

7、设置提醒

也就是设置执行这个动作，给哪些用户发送提醒邮件。

设置提醒可以在动作列表页右侧的操作按钮来进行设置，也可以到具体的动作执行页面进行操作。

因为默认在每个动作执行页面，都可以设置发送给字段。

前提是需要在后台--消息里成功配置发信邮箱，且组织--用户里的用户信息里都填写了正确的邮箱地址。

这样，当这个动作执行后，发送给里的用户将会收到提醒邮件，

四、内置流程子状态管理

禅道企业版3.5.beta版本新增子状态的功能。

禅道默认的系统里，状态字段都是参与程序运算的，之前是不能进行自定义的。新增了子状态功能后，你可以在原有的状态基础上根据实际使用需要，添加新的子状态。

子状态默认显示在流程的字段列表里。

下面我们以自定义任务的子状态，来简单介绍一下子状态的功能。

1、编辑添加子状态

点击流程的“字段”按钮，进入流程的字段列表页。

在字段列表找到“ 子状态”字段，点击子状态右侧的”编辑“按钮，进入子状态的编辑页面。

子状态的编辑页面：

编辑添加子状态，填写对应的键和值。键只可以使用字母和数字的组合，值可以根据实际使用需要来填写。

添加的每一个状态的子状态，都必须设置一个默认值。

设置完成后，点击保存即可。

到任务---看板---看板设置里，针对子状态进行设置。

• 看板列字段：我们默认的设置是不显示子状态的，需要显示选中子状态即可。
• 看板模式：任务看板和Bug看板需要分开单独设置。
• 看板显示列：默认会显示所有的子状态，可以根据需要来设置哪些状态需要显示。
• 看板列自定义颜色：显示子状态后，看板列的颜色需要重新自定义设置。
• 需要恢复回默认设置时，点击底部的”恢复默认“按钮。

看板设置成功后：

可以拖拽任务改变任务的状态，也可以通过编辑任务，来改变任务的状态。