Configuring a Review Checklist Template and Check Items

Constraints

• A maximum of 100 review checklist templates can be created.
• A review checklist template can contain a maximum of 50 check items.
• A review checklist template that has been associated with a work item type or review cannot be deleted.

Prerequisites

You must have the permissions of the Tenant Administrator role.

Creating a Review Checklist Template

1. Access the CodeArts Req homepage and click .
2. Choose All Account Settings.
3. Choose Work Item Management > Template Settings > Checklist Templates.
4. Click Create New Template.
5. Set the parameters for creating a review checklist template by referring to Table 1.

   Table 1 Parameters for creating a review checklist template

   Parameter	Description
   Template name	Name of the review checklist template to be created. The name contains a maximum of 50 characters. A tenant can have a maximum of 100 templates. The name must be unique.
   Description	Description of the review checklist template to be created. This parameter is optional. It can contain up to 500 characters.

6. Click OK. The created review checklist template is displayed in the list.
   You can perform the following operations on the created review checklist template.

   Table 2 Managing a review checklist template

   Operation	Description
   Edit review checklist template	Click . On the displayed page, you can modify the template name and description and create a check item. For details about how to create a check item, see Creating a Review Check Item in the Template.
   Edit review checklist template	Click to copy the review checklist template.
   Delete review checklist template	Click , read the information, and click Delete. NOTE: If the current work item type has been associated with a work item type template, cancel the association on the Work Item Type Templates page and then delete template. If the current review checklist template has been used by a review in the project, cancel the association in the review settings of the project and then delete the template.

Creating a Review Check Item in the Template

1. Access the CodeArts Req homepage and click .
2. Choose All Account Settings.
3. Choose Work Item Management > Template Settings > Checklist Templates. The existing checklist templates are displayed.
4. Locate the checklist template for which you want to create a review checklist item and click to go to the template editing page.
5. Click New check item. The check item creation window is displayed.
6. Set the parameters for creating a review check item by referring to Table 3.

   Table 3 Parameters for creating a review check item

   Parameter	Description
   Check item name	Name of the review item to be created. The name contains a maximum of 200 characters.
   Description	Description of the review item to be created. This parameter is optional. The description is displayed as a prompt in the checklist on the work item creation page. It can contain up to 500 characters.

7. Click OK. The created review check item is displayed in the list.
   

   • Click Save to save the check item. It 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 exit the page for editing the review check item template and cancel the modification.
   You can perform the following operations on the created check item.

   Table 4 Managing a review check item

   Operation	Description
   Edit review check item	Click to modify the check item name and description.
   Delete review check item	Click to delete the check item.