Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Customizing Test Document Templates

Updated on September 25, 2019

Ask a question or post a comment

Use the Document Tests menu choice to generate formatted documents that capture information about the testing efforts managed by TMF. Typically, you customize the model test document templates to meet your project and organization needs.


Customizing test document templates

The templates are stored as Word Template rules.

TemplateWord Template rule
Test Definition DocumentPegaTestMgmt-Definition-Suite.TestMgmtDefinition
Test Execution DocumentPegaTestMgmt-Execution-Run.TestRun

To customize a model template:
  1. Log into the system as a TMF administrator (for example, as TMSysadmin).
  2. Using the Rules Explorer, expand the SysAdmin category and select Word Template to see the list of instances.
  3. Open the standard template rule that you want to customize (either TestMgmtDefinition for a Test Definition document or TestRun for a Test Execution document).
  4. Click the Save As icon, and specify a RuleSet that you have established to hold customized rules for use by your TMF users.

    Note: Typically, create your own RuleSet in the system to hold such customized rules. When you create the RuleSet, specify that it requires the PegaAppTestMgmt RuleSet. After creating the RuleSet, add it to the Production RuleSets array in the PegaTestManagement application rule. Also add your RuleSet to the Production RuleSets array in the access group rules for your TMF administrators and for those operators who generate the documents that use the customized templates.

  5. Click the Save As button and the new Word Template rule form opens.
  6. Click Edit Word Templateto open the model template in Word.

    Note: To see the locations in the Microsoft Word document that are auto-generated from Process Commander properties, turn on the field code display in Word:

    1. In Word, click on the Word icon in the upper left corner, then click the Word Options button.
    2. Select Advanced, and in the Show document content section, enable Show field codes instead of their values and set Field shading to Always.

    3. Click the OK button to return to the Word document. Text in the Word template file that is auto-generated by referencing Process Commander properties is highlighted.

  1. Make changes to the file in Word and select the Save action in Word.
  2. Close Word, then save the rule form.

The next time you use Tools > Document Tests and specify that template type, the wizard uses the customized template.

Back to About the Test Management Framework

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us