Configuring Common Work Item Fields

Constraints

A maximum of 25 common fields can be customized.

Prerequisites

• You have created a Scrum project. For details, see Creating a CodeArts Project.
• An IAM user has been added to the project. For details about how to add members, see Adding Project Members.
• You have permissions to custom work items. For details about how to set permissions, see Managing CodeArts Project Permissions.

Procedure

1. Access the CodeArts Req homepage.
2. Go to a Scrum project and choose Settings > Work Item.
   Figure 1 Setting common fields
   

3. In the navigation pane, choose Common Fields.

   Click Add Field to add a work item field (for example, CommonField1). Set the field information as instructed in Table 1.

   Table 1 Add Field parameters

   Parameter	Description
   Field Name	Name of the field to be added. Only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-) are allowed.
   Field Type	Type of the field to be added. Select a field type, for example, Single-line text, from the drop-down list.
   Description	(Optional) Description of the field to be added. A maximum of 255 characters are allowed.

   • The added field is displayed in the field list, including the name, type, option, description, and usage.

   • Click Clone Field to clone existing common fields of other projects to the current project.
   • Common fields can be modified or deleted.

4. Add an existing common field (for example, CommonField1) to the work item template. Common fields can be configured in the epic, feature, story, task, and bug work item templates. You can add common fields to other work item templates in the same way, and only need to do this once for each of them.

   The following uses the story work item template as an example:

   1. In the left navigation pane, choose Stories > Fields and Templates.
   2. Click Edit Template in the upper right corner to enter the editing state of the story work item template.

      Click Add Existing Field, select CommonField1 from the Field Name drop-down list, click Add, and save the template.

      Figure 2 Adding an existing field to the work item template
      
   3. Check this CommonField01 field when creating a story on the Work Item > Req > Work Items page.

      (Optional) After the configuration is complete, click Save as Template in the upper right corner of the page. In the Save as Template dialog box, enter a template name and description, and click OK. This template can be used to create Scrum projects. See the following figure.

      Figure 3 Applying a work item template