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

Configuring Work Item Type Templates

Configure all work item types that can be managed in a project, their fields and workflows, as well as the parent-child relationship between them. Before configuring a work item type template, first copy a work item type template and then edit it.

After the baseline function of a field is disabled, the unfinished change review will fail in the project that uses the field.

Constraints

  • The preset IPD-self-operated software/cloud service template cannot be copied, edited, or deleted.
  • The preset IPD-standalone software and IPD-system device templates cannot be edited or deleted.

Prerequisites

You must have the permissions of the Tenant Administrator role. For details about how to assign the Tenant Administrator role to a user, see Creating a User Group and Assigning Permissions.

Copying a Work Item Type Template

  1. Access the CodeArts Req homepage and click .
  2. Choose All Account Settings.
  3. Choose Work Item Management > Template Settings > Work Item Type Templates. The existing work item type templates are displayed.
  4. Select the name of the template to be copied and click .

  5. Enter the Template Name and Description.
  6. Click OK. The new work item type template is displayed in the list.

    Its Release is DRAFT. It can be used in associated projects only after being successfully released.

    You can perform the following operations on a new work item template:

    Table 1 Managing a work item type template

    Operation

    Description

    Edit work item type template

    Click to modify the template name, Work item level configuration, Field behavior configuration, and Workflow configuration. For details, see Editing a Work Item Type Template.

    Delete work item type template

    Click . In the displayed dialog box, click OK to delete the work item type template.

    NOTE:

    The work item template that has been associated with project templates cannot be deleted. To delete it, cancel the association in the project template configuration first.

Editing a Work Item Type Template

  1. Access the CodeArts Req homepage and click .
  2. Choose All Account Settings.
  3. Choose Work Item Management > Template Settings > Work Item Type Templates. The existing work item type templates are displayed.
  4. Select the work item type template to be edited and click . Its Work item level configuration page is displayed.
  5. Modify the workflow template name by clicking in the upper left corner.
  6. Configure work item hierarchies, including all work item types required and work item hierarchy trees.

    1. Drag the required work items from Work Item Types on the left to the canvas.
    2. Configure the hierarchy of work items on the canvas. For details, see Managing Work Item Hierarchies on the Canvas. Figure 1 shows the configured work item hierarchy trees. Table 2 describes the concepts related to the work item hierarchy tree.
      Figure 1 Work item hierarchy tree example

      Table 2 Work item hierarchy tree concepts

      Concept

      Description

      Top-level work item type

      Top of the work item hierarchy tree. You can create a top-level work item directly. If the top-level work item type is selected in Configuring Function Pages, this work item type can be created in the project where this function page is used.

      The top-level work item types in Figure 1 include security goal (SG), functional security requirement (FSR), technical security requirement (TSR), SF, bug, and task.

      Child work item type

      Middle or leaf nodes in the work item hierarchy tree. You can only create them from the parent work item.

      The child work item types in Figure 1 include TSR, task, SF, bug, and FSR. Specifically, SGs can be broken down into FSRs, FSRs into TSRs, and tasks into sub-tasks.

  7. Click Next. The Field behavior configuration page is displayed.
  8. Configure the field behavior of each work item type in the work item template.

    1. Select a work item type on the left.
    2. Configure the field behaviors by referring to Table 3.
      Table 3 Parameters for configuring field behaviors

      Parameter

      Description

      New Page Display

      Specify whether to display the field on the creation page.

      • If the switch is toggled on (), the field is displayed on the creation page.
      • If the switch is toggled off (), the field is not displayed on the creation page.

      New page required

      Specify whether the field is mandatory on the creation page.

      • If the switch is toggled on (), the field is mandatory on the creation page.
      • If the switch is toggled off (), the field is optional on the creation page.

      Baseline Locked

      Specify whether the field is baselined.

      • If the switch is toggled on (), the field is baselined.
      • If the switch is toggled off (), the field is not baselined.

      Used for Quickly Splitting Sub-Work Items

      Specify whether the field can be used for quick breakdown.

      • Only fields of the multi-choice list type support quick breakdown.
      • This parameter is available only when the work item type has child work item types.

      default value

      Specify default value of the field.

      operate

      Operations supported by the field.

      • Viewing the field: Click in the Operation column of the field. In the displayed dialog box, view the name, type, and description of the field.
      • Editing the field template: For a rich text field, click in the Operation column of the field. In the displayed dialog box, set a template for the field.

  9. Click Next. The Workflow configuration page is displayed.
  10. Set a workflow for each work item type in the work item template. You can select only one workflow for each work item in the work item template.

  11. Click Release.

    • Click Save to save the work item type template. The template takes effect only after being released.
    • After a released template is modified and saved, you can click Reset template to restore the template to the latest released version.
    • Click Cancel to cancel the modification of the work item type template.

    After the release is complete, the work item type template is displayed in the Work Item Management > Template Settings >Work Item Type Templates list. The Release of the template is RELEASE. You can use the template in corresponding projects.

Managing Work Item Hierarchies on the Canvas

You can manage work item hierarchies on the canvas, such as creating a work item hierarchy tree, and removing, enabling, and disabling a work item type. The procedure is as follows:

  1. Access the CodeArts Req homepage and click .
  2. Choose All Account Settings.
  3. Choose Work Item Management > Template Settings > Work Item Type Templates. The existing work item type templates are displayed.
  4. Select the work item type template to be edited and click . Its Work item level configuration page is displayed.
  5. Manage work item hierarchies on the canvas by referring to Table 4.

    Table 4 Managing work item hierarchies on the canvas

    Operation

    Procedure

    Create work item hierarchy tree

    1. Drag the required work item types from Work Item Type to the canvas.
    2. Connect the work item types to build a parent-child hierarchy:

      Hover over a preconfigured work item type. When the red circle shown below appears, hold down the left mouse button and drag the connecting line, then attach the arrow to another preconfigured work item type to set it as a child.

    3. Repeat the steps above to build a work item hierarchy tree.

      NOTE:
      • Click Autolayout above the canvas to adjust the layout of the work item hierarchy tree.
      • Click Save to save all work item hierarchy trees on the canvas. The saved work item hierarchy trees take effect only after being released.

    Remove work item type

    • To remove work item types with child work item types, perform the following steps:
      1. Hover over the work item type to be deleted on the canvas.
      2. Click , and a prompt will appear, indicating that its child work item types will also be removed.
      3. Click OK to remove the work item and its child types.
    • To remove work item types without child work item types, perform the following steps:
      1. Hover over the work item type to be deleted on the canvas.
      2. Click .

    Disable work item type

    • To disable work item types with child work item types, perform the following steps:
      1. Hover over the work item type to be disabled on the canvas.
      2. Click , and a prompt will appear.
      3. Select Linkage disabled child work item type or Disable only the current work item type as required.
        • Select Linkage disabled child work item type and click OK to disable the work item type and its child types.
        • Select Disable only the current work item type and click OK to disable the work item type.
    • To disable work item types without child work item types, perform the following steps:
      1. Hover over the work item type to be disabled on the canvas.
      2. Click .

    Enable work item type

    Prerequisites:

    Only disabled work item types can be enabled.

    Procedure:

    1. Hover over the work item type to be enabled on the canvas.
    2. Click .

      When a work item type has child work item types, its enabling behavior automatically follows the same rule selected when it is disabled:

      If Linkage disabled child work item type is selected during disabling, enabling the parent will also enabling its children.

      If Disable only the current work item type is selected during disabling, enabling it means enabling only the current type.

    Undo

    Click Undo to undo the latest operation on the canvas.

    Redo

    Click Redo to restore the latest operation on the canvas.

    Restore

    Prerequisites:

    Only released work item type templates can be restored.

    Procedure:

    Click Restore to restore the canvas to the latest saved version.

    Autolayout

    Click Auto Layout to lay out all work item hierarchy trees on the canvas.

    Shortcut keys

    Click in the lower left corner of the canvas to view the shortcut keys as follows:

    • Zoom in: Hold down the Ctrl key and press the + key.
    • Zoom out: Hold down the Ctrl key and press the – key.
    • Pan the canvas: Hold down the spacebar and the left mouse button while dragging.