Updated on 2024-10-31 GMT+08:00

Managing Bugs

After creating a bug (see Creating Bugs), you can perform the operations described in this section on it.

On the Bug List Page

On the project homepage, choose Work > Req > Defects, and perform the following operations.
Figure 1 Bug list
Table 1 Operations in the bug list

Operation

Procedure

Search for bug

  • By adding filters
    1. Click the search box in the bug list and select one or more filters to search for bugs.
    2. To clear all filters and display all data, click on the right of the search bar.
  • By using a saved view
    1. Click the search box in the bug list and select one or more filters.
    2. Click on the rightmost of the search bar, and enter a view name.
    3. Click OK. The created view is displayed next to the Bug button.
    4. Select the created view to query the bugs that meet the search criteria.

      Views can be shared with others, modified, and deleted.

Import work items

Use a template to import bugs in batches.

  1. In the bug list, click on the right of the search bar and select Import.
  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. The template file should be named in the following format: Project name + "-" + Module name (for example, Bug) + Template.

  3. Fill in the fields on the Bug - List sheet.

    For details about how to set parameters, see the Bug - Import Rules sheet in the template file.

  4. Drag or click to select a file to be imported.
  5. Click Import. The import progress dialog box is displayed.
    • After the import is successful, you can view the imported bug information in the bug list.
    • If the import fails, a message is displayed in the upper right corner of 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 again.
      NOTE:

      For details about operations on import records, see Viewing Work Item Import/Export Records.

Export work items

Export bugs in batches to an Excel file.

  1. Export some or all bugs.
    • Export all: On the Defects page, click on the right of the search bar and choose Export. The Select Fields to Export dialog box is displayed.
    • Export some: In the bug list, select one or more bugs to be exported and click Export at the bottom of the page. The Select Fields to Export dialog box is displayed.
  2. Select the fields to be exported.
  3. Click Export. A dialog box is displayed, indicating the export progress.

    After the bugs are exported, the bug file will be automatically downloaded to the local PC. The file format is .xlsx.

    NOTE:

    For details about operations on export records, see Viewing Work Item Import/Export Records.

Configure fields to display

Click next to the Operation field.
  • On the left of the pop-up box, select the fields to be displayed.
  • On the right of the pop-up box, drag the fields in the Selected area to adjust the display sequence.

On the Bug Details Page

On the details page of a bug, you can modify the description, priority, and owner, add tags and attachments, associate work items, check review records, add workloads, and view the operation history.
Figure 2 Bug details page
Table 2 Management operations on the details page

Operation

Procedure

Remarks

Edit work item

On the bug 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 bugs.

Change work item status

Go to the work item details page, click the Status field, and transition the work item to the target status. For details about status transition, see Table 1.

You must have permission to update statuses for bugs.

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 50 MB.

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

    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 file that is successfully uploaded. The operations that can be performed are displayed.

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

You must have permission to upload attachments for bugs.

Add and view related 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.
    Figure 3 Related items
  2. Complete association.
    • Associate Work Item: associated work items of other types in the project.

      Associate existing RRs.

      Associate existing IRs, SRs, and ARs.

      Associate existing tasks. To cancel the association, click .

    • Associated upstream bugs: bugs coordinated from upstream projects.

      The upstream bug information is displayed only when their responsible project is set to the current project on their downstream bug association page.

    • Associated downstream bugs: bugs assigned to other projects for collaboration.

      A maximum of 10 child bugs can be created at a time. One child bug is displayed by default and cannot be deleted.

      1. Click Assign Owner.

      2. Configure the information about bug assignment. Click to expand and configure more information.

      3. Click OK. The bug is assigned. The bug can only be viewed and handled in the responsible project.
      NOTE:

      After a bug is assigned for collaboration, its attachments will not be synchronized to the downstream bugs. The current owners of these downstream bugs can contact the bug creator to obtain attachments.

    • Files: files corresponding to the bug.

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

    • Wiki: wikis corresponding to the bug.

      Select a wiki associated with the current bug. You can create a new wiki.

    • Test Plan: test plans related to the current bug. You can associate test plans with the current bug.
    • Test Case: test cases related to the current bug. You can associate bugs with test cases in CodeArts TestPlan. The associated cases will be displayed here.
    • Code Commit Record: code submission records related to the current bug.

      Related information is displayed only when the current bug is associated during code commit.

    • Code Branch: code branches related to the current bug.

      Related information is displayed only when code branches are associated with the current bug.

You must have permission to associate/dissociate work items, assign bugs, associate/dissociate files, and associate/dissociate wikis for bugs.

Add workload

  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.
    • Decide whether to select Weekends included. If not, weekend workload records will not be generated.
    • 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 Creating Work Types.
  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 bugs.

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

View operation history

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

  1. Go to 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 matching historical records.

You must have permission to view bugs.

Tag work item

  1. Go to the work item details page. Click next to Tag at the top of the page, and select Create Tag.

    The added tag is displayed in the Tag area.

  2. In the Create Tag dialog box, set Tag Name and select Tag Color.
  3. Click OK.

    The new tag is displayed next to the bug ID in the bug list.

  4. (Optional) Hide a tag.
    • Click next to Tag. In the displayed dialog box, deselect to hide the tag.
      Figure 4 Hiding a tag - 01
    • Move the cursor to the tag name and click to hide the tag.
      Figure 5 Hiding a tag - 02
      NOTE:

      If you need to add tags for multiple work items, select the desired work items, click Batch Edit in the lower part of the page, and select Tag.

You must have permission to edit bugs.

Add comment

  1. Go to the work item details page.
  2. On the Details tab page, click the Comments text box.
    Figure 6 Add comment
  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 view bugs.