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

Managing Custom Work Items

After creating a work item (see Creating Custom Work Items), you can perform the operations described in this section on it.

In the List of a Custom Function Page

Go to the project homepage and select a custom function page. If the custom work item page is named Function Security, choose Work Item > Req > Function Security and perform the following operations.
Table 1 Managing the list of a custom function page

Operation

Procedure

Query work items

Query work items by adding filters:
  1. Click the search box in the list of a custom function page and select one or more filters to search for work item types.
  2. To clear all filters and display all data, click on the right of the search bar.
  3. Query results can be displayed in tree, list, or Gantt chart view.

Import work items

Import work items using an Excel file. Use the provided template to import work items in batches.
  1. In the list of a custom function page, click on the right of the search bar, and select ImportExcel.
  2. In the displayed dialog box, click Download Template.

    The import template file is displayed in the lower part of the page. Save the file to the local PC and fill in data.

  3. Fill in the fields on the custom function list tab.

    For details about how to set parameters, see the Custom Requirement Import sheet in the template file.

  4. Drag or click to select a file to be imported.
  5. Click Next. The verification progress dialog box is displayed.
    After the verification progress reaches 100%, close the dialog box and view the verification result. If the mandatory fields fail the verification, the import is not allowed, while the verification result of optional fields does not affect the import.
    • If the verification is successful, click Confirm Import and perform operations as prompted. Imported task information can be viewed in the list of a custom function page.
    • If the verification fails, modify the file based on the verification result. Click Last step to import the modified file. If the import fails, a message is displayed on the page. Click View Failure Details in the message to view the failure details. You can modify the requirement information based on the details and import the template file again.

Export work items

Export work items to an Excel file.
  1. In the list of a custom function page, click on the right of the search bar and select Export.
  2. Select the fields to be exported and determine whether to export child work items.
  3. Click Export. A dialog box is displayed, indicating the export progress.

    After the tasks are exported, click Download. The task file will be downloaded to the local PC. The file format is .xlsx.

Configure fields to display

Click next to the Operation field.
  • On the left of the pop-up box, select the fields to be displayed in Available.
  • On the right of the pop-up box, drag the fields in Selected to adjust the display sequence.
  • On the right of the pop-up box, select a field spacing style under Appearance. The options include Compact, Standard, and Loose.

Migrate work items in batches

You can migrate work items in the list of a custom function page to another project. After the migration, the work items do not need to be processed in the current project.

Constraints

  • Work items that have been baselined, completed, or are currently under baseline review or change review cannot be migrated.
  • Batch migration is based on the selected top-level work item types. Top-level work items can be migrated across projects, and non-top-level work items can be migrated within a project.
  • During cross-project migration, work items can be migrated only to projects with the same work item type template.
  • Work items and their child work items will be migrated together.
  • After cross-project migration:
    • The work item will be re-executed.
    • The actual workload, associated item (except collaborative work item), label, and release sprint fields will be cleared.
    • If the upstream and downstream projects of the corresponding work item are not configured in the target project, the collaborative work item is cleared.
    • Custom fields of the work item in the source project are discarded, and custom fields of the work item in the target project are displayed.
Procedure
  1. In the list of a custom function page, select one or more work items to be migrated and click Migrate in the lower part of the page.
  2. In the displayed dialog box, select the project to be migrated.
  3. Click Next. The migration confirmation dialog box is displayed.

  4. Select the current owner.
  5. Click OK. The custom function page is displayed, and a message is displayed in the upper right corner, indicating that the migration is successful.

    The migrated work items are not in the list of a custom function page. The status of the work items migrated to another project is Initial.

Snapshot versions

Snapshots include plan management snapshots, feature tree snapshots, and work item snapshots. A version snapshot is a work item snapshot. Its name is automatically generated by the system.

Constraints

A work item can have a maximum of 1,000 snapshots.

Procedure

  1. On the custom function page, select the work items for which you want to take a version snapshot.
  2. Click in the lower part of the page to take a snapshot for the selected work items. A message is displayed in the upper right corner of the page, indicating that the operation is successful. The snapshot is a work item snapshot. Its name is automatically generated by the system.

    The format of the work item snapshot name is: Work item type + "v" + Year + "." + Month + "." + Day + "." + Number of versions generated on the current day.

    For example, if an RR is snapshotted for the first time on March 25, 2026, its snapshot name generated by the system is RR v26.03.25.1.

    NOTE:

    You can also go to the work item details page, click in the upper right corner, and select Version Snapshot to create a snapshot for the work item.

  3. (Optional) Click the work item name to go to its details page, click , and select Version History to view the generated snapshots.

Clone work items across projects

Constraints

  • You must clone the entire work item tree (for example, the custom work item tree SG-FSR-TSR). Child work items cannot be cloned separately.
  • Only work items can be cloned. The workload, associated work item (except parent-child work item), tag, and release sprint fields will be cleared.
  • You must have permission to create and clone work items for the target project.
  • Work items can be cloned only to projects with the same work item type template.
  • You can clone up to 50 work items at a time.

Procedure

  1. Select the work items to clone in the list of a custom function page and click Cross-Project Copy. The page for cloning requirements across projects is displayed.
  2. Select a target project from the drop-down list. You can select only a project to which you have joined.
  3. Click Next. The window for setting mandatory fields is displayed. Select the target owner from the drop-down list (the current operator is selected by default). Mandatory fields are those on the custom function creation page of the target project.
  4. Click OK. The work items are cloned to the target project.
  5. Go to the target project to view the cloned work items.

Transition statuses in batches

Constraints

  • The types of the selected work items must be the same.
  • The selected work items must be in the same status.
  • You must have permission to set statuses for work items.
  • All mandatory fields of the selected work items have been set.

Procedure

  1. Select the target work item types in the list of a custom function page and click Batch Transfer in the lower part of the page. The Batch Transfer window is displayed.
  2. Click the Transitions tab. Select the target status from the drop-down list.
  3. Click Next.
  4. Set mandatory fields. The mandatory fields are set on the In-transition GUI Config tab page of the project's workflow solution.
  5. Click OK.

Perform batch operations

You can select multiple work items to perform batch operations: baseline/unbaseline, change, baseline review, assign, migrate, edit, suspend/unsuspend, export, delete, cross-project clone, and transition.

Manage work items by group

You can group work items by any supported field type.

Constraints

  • A maximum of 1,000 work items can be displayed during grouping.
  • The supported field types include single-choice list, multi-choice list, single-choice user, multi-choice user, hierarchy, and date.
  • For projects in a program (after sub-project aggregation is enabled), grouping by release, sprint, module, feature set, or tag is unavailable.

Procedure

  1. On the custom function page, click Group.
  2. On the displayed page, select the fields used to group work items.
    • You can sort work items in ascending or descending order.
    • You can enter a keyword to search for fields.
    • When work items are grouped by multi-select list or multi-select user, the same work item may appear in multiple groups.
    • You can click No grouping to ungroup work items.

On the Custom Work Item Details Page

Click the name of a work item type to access the work item details page. On the details page of a work item, you can modify its description and fields, add tags and attachments, associate work items, check review records, add workloads, and view the history.
Table 2 Management operations on the details page

Operation

Procedure

Remarks

Edit work item

On the work item details page, click the value box of the field to be modified, and enter a target value in the text box or select one from the drop-down list. The changes are saved automatically.

You must have permission to edit custom work items.

Change work item status

Go to the work item details page, click the Status field, and transition the work item to the target status.

You must have permission to set statuses for custom work items.

Baseline work item

  1. Go to the work item details page, and choose > Baseline. The Baseline dialog box is displayed.
  2. Click OK.

    You can see the baseline icon on the left of the work item title. For example, is displayed for a based SG. You can unbaseline work items that have been baselined.

You must have permission to baseline custom work items.

Change work item

The change process can be initiated only for baselined and uncompleted work items.

  1. Go to the details page of a baselined work item, and choose > Change Review. The CR page is displayed.
  2. Enter CR information.
    • Enter basic information, including Description, Start, End, and Copy To.
    • Set change objects: Click Add in the Change Objects area. In the displayed dialog box, select the work item types to be changed from the drop-down list and click Add.
    • Set associated files: If there are associated files, upload them on the Attachments tab of the Associated Files area.
    • Collaborative Parent Item Change: CRs can be added only when they already exist in the system.
  3. Click Submit. The Review page is displayed.

    Choose Review > Change Review to view the new CR in the change process. The CR state is Pending review by default.

    Track the approval progress of the CR. Only when the state is END, which means that the CR has been processed, will the changed content be displayed in the corresponding list of a custom function page.

You must have permission to check custom work items.

Upload attachment

Attachments can be pictures, workbooks, manuscripts, and text files. A maximum of 100 attachments can be added to each work item, and their total size cannot exceed 500 MB.

  1. Go to the work item details page, and click the Attachment tab.
  2. Click Click or drag the file here to upload it., select a local file, and upload the file to the work item as an attachment.

    Local files can be directly dragged to the text box. When the upload progress reaches 100%, the system displays a message indicating that the attachment is uploaded successfully.

    Move the cursor to the uploaded file. The available operations are displayed.

    • Click to download the file.
    • Click to delete the uploaded file.

You must have permission to edit or upload attachments for custom work items.

Add and check associated item

A work item can be associated with other types of work items in a project.

  1. Go to the work item details page and click the Related Items tab.
  2. Complete association.
    1. Parent work item: Parent work item that the work item is subordinated to.

      The parent work item area displays information about the parent work item only when the work item has a parent work item.

      You can associate a work item with its parent work item only when the work item is the top-level work item on the current function page and is a child work item of another work item type. For details about the concepts of the work item hierarchy tree, see Table 2.

    2. Child work item: Child work items broken down from the current work item.

      Each work item can be broken down into a maximum of 10 child work items at a time. One child requirement is displayed by default and cannot be deleted.

      1. Click Break Down. The Break Down Child Work Item dialog box is displayed.

      2. Configure the child work item information. Click to expand and configure more information.

      3. Click OK. The child work item is automatically displayed under the parent work item in the list of a custom function page.

    3. Related Upstream Work Items: work items assigned by other projects to your project.
    4. Related Downstream Work Items: work items assigned to downstream projects.
    5. Associate Work Item: associated work items of any other types in the project. All work item types configured in Configuring Work Item Type Templates can be associated.
    6. Custom work item associations. The name displayed is the same as the name of the work item association configured in Configuring Work Item Associations. The work item types that can be associated are the intersection of those configured in Configuring Work Item Associations and those supported by the current project.
    7. Files: Files corresponding to the current work item.

      Select a file associated with the current work item. You can upload a local file.

    8. Wiki: wikis corresponding to the current work item.

      Select a wiki associated with the current work item. You can also create a wiki.

    9. Test Case: test cases related to the current work item. You can select a test case associated with the work item in CodeArts TestPlan.
    10. Test Design: test design related to the current work item. You can select the test design associated with the work item in CodeArts TestPlan.
    11. Test Plan: test plans related to the current work item. You can select a test plan associated with the work item in CodeArts TestPlan.
    12. Code Commit Record: code commit records related to the current work item.

      Related information is displayed only when the current work item ID is associated with a code commit.

    13. Code Branch: code branch corresponding to the current work item.

      Related information is displayed only when a code branch is associated with the current work item.

    14. Code Merge & Change Request: code merge and change requests corresponding to the current work item.

      Related information is displayed only when a submitted merge or change request is associated with the current work item.

    15. External Link: external links associated with the current work item.
      • Create link: Click Add Link. In the displayed dialog box, set Link Name and Link. The value of Link must start with https:// and cannot contain invalid characters, such as spaces and Chinese characters. Click OK.

        After a link is created, you can click External Link to view, edit, copy, or delete the link.

      • Copy link: Click on the right of the link to be copied.
      • Edit link: Click on the right of the link to be edited. In the Edit Link dialog box, you can change the Link Name and Link.
      • Delete link: Click on the right of the link to be deleted. In the displayed dialog box, click Delete.

You must have the permissions to assign or cancel assignment of, break down, associate or dissociate, and associate or dissociate a parent work item for custom work items.

View review records

You can check the review records of the work item only in the following situations:

  • When a work item is added to a baseline review, the baseline review process is triggered. Only then will you be able to view the review record on the Review tab of the corresponding work item details page.
  • When a locked field of a baselined work item is modified, the change process is automatically triggered. Only then will you be able to view the review record on the Review tab of the corresponding work item details page.
  • You can view the review records in Review of the corresponding work item details page only when the work item has a general review record.

You must have permission to check custom work items.

Add workloads

  1. Go to the work item details page and click the Workload tab.
  2. Click Add Workload. The Add Workload dialog box is displayed.
  3. Enter the workload information.
    • The end date cannot be earlier than the start date.
    • You can select Total or Daily for Workload.
    • Work Type options include backend development, frontend development, UI design, replacement leave, debugging, and general. You can also customize the value by referring to Adding a Work Type.
  4. Click OK.

    The system automatically generates corresponding records based on the entered dates and days.

    The workload can be edited and deleted.

You must have permission to add person-hours for custom work items.

Workloads can be edited and deleted by the creator. By default, the project administrator can edit and delete all workloads.

Viewing History

History displays all operation logs of users, including creation, status transition, review initiation, work item association, and workload addition.

  1. Access the work item details page.
  2. Click the History tab.
    • Click or to check historical records in the ascending or descending order of operation time.
    • You can set search criteria to query historical records that meet the search criteria.

You must have permission to check custom work items.

Tag work item

Tags can be added to work items. Once added, the tags will appear next to .

  1. Go to the work item details page. Click next to Tag at the top of the page, and select Create Tag.
  2. In the Create Tag dialog box, enter Tag Name and select Tag Color.
  3. Click OK.
  4. (Optional) Display the tag. Click next to Tag. In the displayed dialog box, select the tag to be displayed. The tag will be displayed next to .
  5. (Optional) Hide a tag.
    • Click next to Tag. In the displayed dialog box, deselect √ to hide the tag.
    • Move the cursor to the tag name and click to hide the tag.
      NOTE:

      To add or remove tags for multiple work items, select the desired work items in the list of the custom function page, click Batch Edit in the lower part of the page, and select Tag.

You must have permission to edit custom work items.

Add comment

  1. Access the work item details page.
  2. On the Details tab page, click the Comments text box.
  3. Enter a comment.

    You can upload images, enter links, associate work items, and use @ to notify project members in comments.

  4. Click Submit.

    Submitted comments can be replied, edited, pinned to the top, and deleted.

You must have permission to check custom work items.

Historical versions

For work items with snapshots, you can view their historical versions and compare the differences between them.

NOTE:

For work item types preset in IPD projects, such as raw requirements, R&D requirements, tasks, and bugs, the method of view historical versions is similar to that of custom work items. Refer to the following method.

  1. Go to the work item details page, click in the upper right corner, and select Version History.
  2. In the Version History dialog box, select two versions and click Compare Versions. On the Workitem Version Comparison page, view the differences between the original version and the compared version. You can click in the upper right corner and select Hide Identical Items to view only the differences between the two versions.
  3. Hover over a snapshot version. is displayed. Click to delete the snapshot.
    NOTE:

    If a work item has a third-party snapshot or its child work items have third-party snapshots and the child work items cannot be separated from the current work item, the snapshot cannot be deleted.

You must have permission to check custom work items.

To delete a snapshot, you must have permission to delete custom work items.