Creating templates for test artifacts

You can create customized templates for supported test artifacts. You can also designate the default template for each artifact.

Before you begin

To access the Manage Artifact Templates view and create templates, you must be logged in as a user who has the Save Template and Save Template Section permissions. For more information, see Quality Management role-based permissions.

Templates that come with the application cannot be modified; therefore, you cannot click the names to open them. The Modifiable column indicates whether a template can be edited. If you do not want the predefined templates to be available for creating new artifacts, you can delete those templates. Each artifact must have at least one available template, and one template must be the default template.

About this task

You can create templates for the following test artifacts:
  • Test plans
  • Test cases
  • Test suites
  • Manual test scripts
  • Keywords
You can create an entirely new template or create a template that is based on another template. You can set any template as the default by selecting the template and clicking the Set as new default icon (Set as new default).


  1. In the upper-right portion of the banner, click the Administration (Administration) icon and then click Manage Artifact Templates.
  2. Create an entirely new template or create a template that is based on another template:
    • To create an entirely new template, from the Action Bars, click the arrow next to the Create Templates (Create template) icon, and click to create a test plan, test case, or test suite template.
    • To create a template that is based on another template:
      1. Select a template, and then click the Copy Template icon.
      2. Rename the template, and then modify it as needed.
  3. Define or modify the contents of the template as needed.
    1. To add a section, select the section from the Available Sections list, and move it to the Selected Sections list by clicking the Add (Move right) icon.
      Tip: To select multiple sections, press Ctrl and click. You can also move all of the sections at the same time by clicking the Add All (Move all right) icon.
    2. To modify the name, description, and contents of a section, select the section name from the Selected Sections list and then click the Edit (Edit) icon. Many sections can be modified to display custom attributes that you have previously defined for an artifact type on the Project Properties page.
      Note: If you change a section, the change is applied to all templates that include that section.
    3. To create a customized section, click the New (Create section) icon.
      1. From the Section Type list, select the type of content for the new template section, Rich Text Editor or Grid.
      2. If you select Grid, click the Add (Add) icon to add a column and then type the column name.
      3. If you select Rich Text Editor, you can enter boilerplate content into the text field. That content is included in all templates that use the section.
    4. To remove a section, move the section from the Selected Sections list to the Available Sections list by clicking the Remove (Move left) icon.
      Note: If you remove a section from a template, the test plans, test cases, or test suites that are based on that template retain the original section and are not affected by the change.
    5. To delete a custom section, select the section, and click the Delete (Delete) icon. You cannot delete standard sections of a template.

What to do next

Create a test plan, test case, or test suite and choose the new template from the list.

video icon Video channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community forums library

support icon Support

IBM Support Community
Deployment wiki