Jira实战 | 自定义字段

《Jira策略管理实战手册》: 为管理员提供配置、清理和维护Jira的模板。

文末获取Kindle版和印刷版。

最佳实践

应该这么做

限制自定义字段的数量，只创建供多个项目进行查询和使用的必要字段，太多的自定义字段会影响性能。

如果需要不同的字段描述或值的时候，仅需使用字段配置或是上下文功能，千万不要使用重复的自定义字段。

不要这么做

创建多个相同名称的字段，甚至字段还是不同的类型，这些重名会导致系统管理员在为最终用户创建界面查询时造成混乱。

必填字段

这里有两种完成必填字段的方式：

• 在项目里的“字段配置”方案将字段设置为必填，这个方法会在创建和编辑的界面上呈现红色星号符号，视觉上告知为必填。如果字段留白的话，会在提交的时候显示红色的错误页。

• 使用“工作流转”换验证器规则让字段必填，这个方法会在转换的时候在覆盖页面上呈现红色错误信息，不会在该字段上呈现红色星号。

最好的方法就是根据情况来处理，需要在创建界面上必填字段的时候，可以使用“字段配置”的方法；举个例子，需要在工作流中的三个步骤上必填字段的时候，可以使用“工作流转换”的方法

如果必填字段没有显现在界面上的话，你的用户会看到错误信息并且无法继续进行处理。

建议

公告一个可用的自定义字段和其用法的列表会是相当有用的，这可以鼓励最终用户请求既有的字段，而不是提出新的或是相类的字段需求，你可以这么做:给用户“常见问题集”页面(在yourjiraurl.com/secure/ShowConstantsHelp.jspa)，复制并粘贴上JIRA静态列表、查询数据库、使用REST API去生成可用选项的快速列表。

字段配置

字段配置 – 提供了改变字段行为的能力，属性:

• 名称

• 描述

• 所有可用字段的设置

应该这么做

在所有项目中呈现用户期望的标准字段

不要这么做

必填字段没有呈现在界面上，用户会看到错误信息并且无法进行创建或是转换问题。

重要的标准字段

即使不是所有用户都需要输入数据的情况下，下列字段必须是可用的。

字段配置方案

字段配置方案 – 用来将字段配置映射到问题类型，属性:

• 名称

• 描述

• 关联字段配置

字段配置和方案的关系

在这个例子里，四个字段有特定的设定，“条件”字段在任务问题类型是显现的，但是却在“子任务”问题类型隐藏，这两个字段配置让你可以在不同问题类型让同一个界面略有不同。

或者，你可以使用相反的设定:两个界面(一个没有条件字段)和一个字段配置。

另外一个界面设定则是将所有的字段放置在一个界面，并且使用字段配置来隐藏不该呈现在特定问题类型的字段。

适当的字段类型

在创建新字段的时候，务必选择最适合的类型来使用，一旦选择字段类型后就不能够更改了，要变更字段类型的话，你需要创建新的自定义字段，从原先的字段所储存的数据迁移到新的字段，然后移除原先的字段，再更新界面呈现新的字段。

文本字段 (单行)vs 文本字段 (多行)

这两者之间的选择最重要的是所需字符的长度，文本限制在255个字符或是更少？如果是，"文本字段(单行)"类型会是最佳的选择，对于长段落类型的响应，"文本字段（多行）"类型会是最佳的选择。 

复选框 vs 单选框

这两个字段类型容易误用，在JIRA里或是任何网站及线上应用的UI规则都是相同的。

• 复选框 - 如果有用户能够有多个选项去选择，适合使用核取方块复选框字段格式，用户能够在一个问题中不选择或是选择一到多个选项。

• 单选框 - 如果用户必须在多个选项中选择一个，选项间彼此是互斥的情况，适合使用单选按钮，用户只能够选择一个，所以须使用清晰的选项标签。

特别的功能

有一个插件(在JIRA Cloud和JIRA服务器上都有)叫做"JIRA Toolkit Plugin"，这个插件提供了两个非常有用的字段类型，这两个叫做"Message Custom Field (for view)"和"MessageCustom Field (for edit)"。这些字段让你在问题或是工作流转换上让你能够呈现文本或是HTML，它们的特性就是能够帮助提供额外的指令、显示警告或是链接到额外的信息。

若要在查看界面上放置消息，使用"Message Custom Field (for view)"字段类型；若要在创建、编辑、转换界面上放置消息，使用"Message Custom Field (for edit)"字段类型。

关于《JIRA策略管理实战手册》

本文节选自《JIRA策略管理实战手册》，为Jira管理员提供配置、清理和维护Jira的模板。

此实战手册包含：

• 152条建议- 帮助您设置、清理和维护Jira

• 50个工作表，以及其他相关模板、代码片段和示例

• 33个需避免的反面真实案例

• 每个管理区域的最佳实践和注意事项

• 作者作为管理员犯下的十大错误

关于翻译，编辑和审稿人