Configuring Common Work Item Fields

Prerequisites

• An IPD-standalone software project is available, in which you have permission to configure work item templates.
• You have the Tenant Administrator permission.
• A maximum of 150 common fields can be customized in a project.

Configuring Common Fields in a Project

1. Access the CodeArts Req homepage.
2. Go to the project and choose Settings > Work.
3. In the navigation pane, choose Work Items > Common Field.
4. Click Create Field. In the dialog box that is displayed, set the required parameters.

   Table 1 Creating a field

   Parameter	Description
   Field Name	Enter a maximum of 15 characters, including letters, digits, and hyphens (-).
   Field Type	Type of the field. The options include: single-choice list, multi-choice list, single-line text, multi-line text, date, date and time, integer, decimal, single-choice user, multi-choice user, level field, and review check item. If Field Type is set to Multi-choice list, set options as needed. You can enable Quickly split sub-work items as needed. When this switch is enabled, the corresponding number of child work items will be automatically generated during work item breakdown, based on the number of options selected.
   Options	This parameter is displayed only when Field Type is set to Single-choice list, Multi-choice list, or Level field. When Field Type is set to Single-choice list or Multi-choice list, you can click Add Option to add one option at a time. To add multiple options at a time, click Add Multiple. Separate options by pressing Enter. When there are multiple options, you can drag to adjust their positions. When Field Type is set to Single-choice list or Multi-choice list, you can click to delete options. There is a default option, which cannot be deleted. When Field Type is set to Level field, click Edit Option. In the Edit Option dialog box, click on the right of the text box to add field levels. A maximum of 6 levels can be added. Click Add Option to add fields of the same level. Click Add Multiple to add multiple options at a time.
   Related Review Check Item Template	This parameter is displayed only when Field Type is set to Review Check Item. Select a created review check item template from the Related Review Check Item Template drop-down list.
   Description	Remarks about the field. Enter a maximum of 50 characters, including letters, digits, and hyphens (-).

5. Click OK.

   The new field is displayed at the end of the list. The parameters in this list are described in the following table.

   Table 2 Field list

   Parameter	Description
   Field Name	System or custom field name. Hover over the header and click to sort by field name.
   Created/Added By	The user who creates or adds a field. Hover over the header and click to sort by creator or adding user.
   Created/Added At	Time when a field is created or added. Hover over the header and click to sort by creation or addition time.
   Field Type	System or custom field type. The options include: single-choice list, multi-choice list, single-line text, multi-line text, date, date and time, integer, decimal, single-choice user, multi-choice user, and level field. Hover over the header and click to sort by field type. Hover over the header and click to filter fields.
   Option	Field option values. Displayed only when Field Type is set to Single-choice list or Multi-choice list.
   Description	System or custom field description.
   Status	Work item types that are currently using a system or custom field.
   Operation	You can edit and delete a field. To edit a field, click in this column. System fields cannot be edited. Custom fields of your tenant cannot be edited here. To delete a field, click in this column. System fields cannot be deleted. Deleting a tenant-defined field only removes it from work item templates where it was previously used. It remains in the tenant's field list. Deleted fields cannot be recovered.

6. (Optional) Add a common field (for example, CommonField01) to a work item template.

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

   1. Choose Work > Work Items > Initial Requirement (IR) > Field Templates.
   2. Click Add Field, select CommonField01 from the Field Name drop-down list, and click OK to save the template.
      Figure 1 Add Field dialog box
      
   3. Check this CommonField01 field when creating or editing an IR on the Work > Req > R&D Requirements page.
      

      • Customized common fields can be configured and used for all types of work items of the current project.
      • The IR work item template is used as an example. 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.

Configuring Common Fields in Tenant Settings

You have the Tenant Administrator permission.

You can configure tenant-level common fields for work items across all your IPD projects.

1. Log in to the CodeArts homepage, click , and choose All Account Settings.
2. Choose Work > Field. The existing common fields are displayed.
3. Click Create Field. In the dialog box that is displayed, enter a field name, select a field type, and click OK. The new field is displayed in the list.

You can perform the following operations on a new field:

• Click to modify the field name, type, and description.
• Click . In the dialog box that is displayed, click Delete to delete the field.

Fields created on the Work > Field page apply to all IPD projects in your tenant and can be configured for the work items in these projects.

1. Go to an IPD project and choose Settings > Work.
2. Click Work Items and select a work item type.
3. On the Field Templates tab page, click Add Field. In the displayed dialog box, select a new field, configure other options, and click OK.