Updated on 2024-05-21 GMT+08:00

Customizing Work Items

Project administrators can customize details of work items on the Fields and Templates, Statuses and Transition, Common Fields, and Common Statuses pages.

This section describes the procedure taking the Story type in Scrum projects as an example.

Accessing Custom Work Items

Perform the following operations to access the project settings.

  1. Go to the project details page.
  2. Choose Settings > Work. The story template page is displayed by default.

Customizing Fields and Templates

Add different types of fields for diverse scenarios.

You can customize work item templates and determine which fields are mandatory or optional. You can also save the customized template as the one that used by default when creating a project.

  1. On the target project details page, choose Settings > Project Settings.
  2. Set the default work item type to Stories and select Fields and Templates.
  3. Click Edit Template.

    • Set Description based on project requirements.
    • Set Default Value for system fields based on project requirements.
    • Set whether system fields are mandatory based on project requirements.
    • Click Add Existing Field or Create Field to add a field.

  4. Click Save.

    • You can also save the edited template as the one that used by default when creating a project by clicking Save as Template in the upper right corner.

      Then the Work Templates page is displayed. For details about how to set work templates, see Customizing a Template.

Customizing Statuses

You can customize different types of work item statuses and adjust their order.

  1. On the target project details page, choose Settings > Project Settings.
  2. The Stories page is displayed by default.

  3. Click Statuses and Transition. By default, the Statuses page is displayed.

  4. You can add an existing status, create a status, or delete a status.

    • Click Add Existing Status, select a status from the drop-down list, and click OK.
    • Click Create Status. In the dialog box that is displayed, set the status name (for example, CustomStatus1), category, and description, and click Add.
      • The created status is displayed on the Statues and Transitions tab pages.
      • Added statuses can be deleted.
      • The system statuses displayed on the Statuses and Transition page apply to all types of work items. Statuses added to a work item type can be used for other work item types.
      • You can select different work items (such as Epics, Features or Stories) and add customized statuses for them.

  5. Press and hold to rearrange the work item statuses by drag-and-drop.

Customizing Transitions

You can customize the status that a work item can be transitioned to. After it is configured, click Status column of the target work item on the Work > Work Items page to change the status.

  1. On the target project details page, choose Settings > Project Settings.
  2. The Stories page is displayed by default.

  3. Click Statuses and Transition. By default, the Statuses page is displayed.
  4. Click the Transitions tab.

  5. Select the allowed statuses and click Save.
  6. (Optional) Click Status column on the Work > Work Items page to view the statuses that a work item can be transitioned to.

Specifying Handlers

You can specify a handler for a work item in a specific status. When the status of a work item changes, the work item is automatically assigned to the corresponding handler.

  1. On the target project details page, choose Settings > Project Settings.
  2. The Stories page is displayed by default.

  3. Click Statuses and Transition. By default, the Statuses page is displayed.
  4. Click the Automation tab.

  5. Click in the row where a status is located.

  6. In the Configure Transition dialog box, configure the status transfer information and click OK.

Setting Common Fields

Customize common fields for work items.

  1. On the target project details page, choose Settings > Project Settings.
  2. In the navigation pane, choose Common Fields.

    Click Add Field, and set the field information, including the name (for example, CommonField1), type, and description.
    • The added field is displayed in the field list, including the name, type, option, description, and usage.
    • Click Clone Field to copy existing common fields of other projects to the current project.
    • Common fields can be modified or deleted.

  3. Add an existing common field (for example, CommonField1) to the work item template.

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

    1. In the navigation pane of the project settings page, 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, and click Add and save the template.

    3. When you create a story work item on the Work > Work Items page of the project, the parameter CommonField1 is automatically displayed.

      Customized common fields can be configured and used for all types of work items of the current project.

      The story work item template is used as an example. You can add work item templates of each type only once. The methods of adding common fields to work item templates of other types are the same.

      You can add a maximum of 25 common fields.

Setting Common Statuses

Customize work item common statuses and use them in addition to the default ones.

  1. On the target project details page, choose Settings > Project Settings.
  2. In the navigation pane, choose Common Statuses.

    Click Add Status, and set the status information, including the name (for example, CommonStatus1), category, and description.
    • The added status is displayed in the status list, including the name, description, category, and usage.
    • Common statuses can be deleted.

  3. Add an existing common field (for example, CommonStatus1) to the work item status.

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

    1. In the navigation pane, choose Stories > Statuses and Transitions.

      On the Statuses tab page, click Add Existing Status. In the Status drop-down list, select CommonStatus1 and click OK.

    2. In the Work > Work Items list of the project, click the status name in the row where the Story work item is located to select CommonStatus1.

    Customized common statuses can be configured and used for all types of work items of the current project.

    The New and Closed statuses cannot be deleted.

    You can add a maximum of 25 common statuses.