Configure Approval Policy

Incorrectly editing Vera policy files can cause the system to become unresponsive or to fail. If you are unsure or need guidance, please reach out to Tricentis Support before making changes to the policy files.

To add additional approval routes or change the existing approval routes in Vera, you must edit the Approval Policy file.

Add a new approval group to Vera

To add a new approval group to Vera, follow these steps:

1. To access the Approval Policy file that needs to be updated, see Manage policy files.

2. Edit the file and find the Approval Groups element near the top of the file:

   Copy

   Approval Roles Code Snippet

   {
       "Approval Policy":
       {
           "Version": "Tricentis Standard 1.0.0.0",
           "Schema":
           {
               "ID": "http://tricentis.com/schemas/0/0/approval-policy.json",
               "Major": "0",
               "Minor": "0"
           },
           "Approval Groups": [
               "Business",
               "Quality",
               "Reviewer",
               "Technical",
           ]
       }
   }

3. Add the Approval Group to the list.

   Make sure to enclose the name of the group in plain double quotes and use a comma to separate it from other groups in the list.

4. Upload the policy file to the Policy Management page either as a new approval policy or as a revision to an existing one.

   Vera will read the policy file and the approval roles will be available for assigning to users in the Vera Administration portal.

To add users to the new Approval Role(s), see Assign users to a domain role.

Add a new approval route to Vera

To add a new approval route to Vera, follow these steps:

1. To access the Approval Policy file that needs to be updated, see Manage policy files. 

2. Edit the file and find the Route Templates section.

3. Add a new Route Template by copying one of the existing templates or creating your own.

   The route template must include the following elements and be valid JSON: Name, Rank, Record Types, and Levels. The template can also include a Constraints section, if needed.

   Copy

   Example Route Template

   {
       "Name": "Dry Run qTest Test Case Approval",
       "Rank": "1",
       "Record Types": [ "qTest Test Case" ],
       "Levels": [
           {
               "Name": "Level 1",
               "Approvers": [ "Digital Tester Reviewer" ]
           }
       ],
       "Constraints": [
           {
               "Type": "Field Is One Of",
               "Name": "Project Name for Approval",
               "Values": ["Project Name"]                     
           },
           {
               "Type": "Field Is One Of",
               "Name": "Test Level",
               "Values": ["Dry Run"]
           }
       ]
   },

   • Name: Can be any string. This will be displayed in the Approval Route field in the target system and in Vera.

   • Rank: Any integer from 1 to 9999. This is used to determine which route template to choose if a record matches more than one. The lower the number, the higher the rank (1 = highest).

   • Record Types: A list of valid record types. These must match the record types defined in the Record Management Policy file.

   • Levels: A list of approval levels. Each level consists of a name and a list of approvers. The approvers must be from the list of approval groups defined above in the Approval Groups element at the top of the file.

   • Constraints: An optional element where constraints are defined that help match records with the appropriate route template. For a list of commonly used constraints in Vera, see Vera constraints.

Example: Download a sample Approval Policy template.

Deploy Approval Policy

For information on how to deploy Approval Policy, see Manage policy files.