Configure the Approval Policy

In order to add additional approval routes or to change the existing approval routes in VERA, you must edit the Approval Policy file on the VERA Server. Follow the instructions below to add addition all approval routes to VERA (or update existing routes):

Add a New Approval Group to VERA

1. Access the Approval Policy.json file in the Policies directory of the VERA Server Installation Directory.
2. Edit the file and find the Approval Groups element near the top of the file:
   1. 
3. Add the Approval Group to the list. Be 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.

Add a New Approval Route to VERA

1. Access the Approval Policy.json file in the Policies directory of the VERA Server Installation Directory.
2. Edit the file and find the Route Templates section:
   1. 

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.

   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"]
           }
       ]
   },

   1. Name: Can be any string. This will be displayed in the Approval Route field in the target system and in VERA.
   2. 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).
   3. Record Types: A list of valid record types. These must match the record types defined in the Records Management Policy.json file.
   4. 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.

   5. Constraints: An optional element where constraints are defined that help match records with the appropriate route template. A list of commonly used constraints can be found here: https://github.com/Tx3-Services/VERA-Configuration-Cookbook/wiki/Index-of-Supported-VERA-Constraints

      Field constraints must match the field labels in qTest or Jira exactly and should be defined in the Records Management Policy.

Deploy the Approval Policy

see Managing Policy Files