Updated on 2026-10-26 GMT+08:00

Adding a Field to a Work Item Type in a Project

If the system fields cannot meet your requirements, you can add fields for a work item type as required. Work item types include RRs, SFs, IRs, SRs, ARs, tasks, and bugs.

Prerequisites

An IPD-system device project is available, and you have permission to configure work item templates for the project.

Procedure

  1. Access the CodeArts Req homepage.
  2. Go to a project and choose Settings > Work.
  3. In the navigation pane, select a work item type for which you want to add fields, for example, RR. On the Fields tab, click Add Field.

  4. Click the Field Name drop-down list. The field name value information is displayed.
  5. Select an existing field or create a field for the work item type.

    • Adding an existing field
      1. Select an existing field.

        The fields configured in Configuring Common Fields in a Project are displayed in the value list of the displayed dialog box. You can search for a field in the Enter a name box, or scroll your mouse to select one. If no field in the list meets your requirements, go to 5.a to create a custom field.

      2. Specify what the selected field defaults to, whether to display it on creation pages, and whether it is mandatory.
      3. Click Publish. The added field is displayed in the field template list.
    • Creating a field
      1. In the displayed dialog box, click Create Field.
      2. Set the field information by referring to Table 1.
        Table 1 Parameters for 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 are 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 items.

        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.

        Default Value

        This parameter is displayed only when Field Type is set to Single-line text, Multi-line text, Date, Date and time, Integer, Decimal, Level field, Single-choice list, or Multi-choice list.

        Set this parameter based on site requirements.

        Display During Creation

        This parameter is toggled on by default. If this parameter is toggled off, this field will not be displayed when a work item is created.

        Required

        This parameter is toggled off by default. If this parameter is toggled on, the new field is mandatory.

        Baselined

        This parameter is displayed only for SFs, IRs, SRs, and ARs.

        This parameter is toggled off by default. If this parameter is toggled on, new fields will be locked and cannot be modified after work items (such as SFs) are baselined. If modification is required, a change process must be initiated.

      3. Click Publish. The new field is displayed in the field template list.

  6. (Optional) Manage fields. You can perform the following operations on fields in the field template list.

    Table 2 Managing a field

    Operation

    Description

    Editing a field

    Click to specify whether to display the field on creation pages and whether it is mandatory.

    System fields cannot be edited.

    Deleting a field

    Click . In the displayed dialog box, click Delete to delete the field.

    System fields cannot be deleted.

    Editing a field template

    Editing the field template is supported only for fields of the rich text type.

    Click and edit the template of the rich text field in the displayed dialog box.