Now that Record Types are defined in the Records Management Policy we can create Route Templates for those records. Route Templates contain the approval tasks required to approve a record. When a record is routed for approval Vera uses the Route Template to create an approval route for the record that was routed for approval. We will build an Approval Policy with one Route Template for all Record Types defined in the Records Management Policy. In later sections we will create additional Route Templates to meet specific approval requirements.
Create JSON File
Below we will create an Approval Policy and define Approval Routes for qTest Record Types; qTest Test Case, Automated Test Case and qTest Test Run.
Create a new JSON file and add a Revision number, Version number and Schema save the file as VeraAPTutorial-part1.json.
{ "Revision": "1", "Approval Policy": { "Version": "Vera Tutorial 1", "Schema": { "ID": "http://tx3services.com/schemas/0/0/approval-policy.json", "Major": "0", "Minor": "0" } }
Policy Revision management was introduced in Vera 2023.2. You still need to include a Revision and Version number to upload policies. The Version number can be used as a reference number. The Revision number is managed by Vera. The Revision number in the file is ignored when uploading policies.
Create Approval Groups
Approval Groups are a list of Approval Roles that will be used later as Approval Tasks in the Approval Routes.
Add Approval Groups Business, Technical and Quality
"Approval Groups": [ "Business", "Technical", "Quality" ]Here is the updated Approval Policy with above code block:
{ "Revision": "1", "Approval Policy": { "Version": "Vera Tutorial 1", "Schema": { "ID": "http://tx3services.com/schemas/0/0/approval-policy.json", "Major": "0", "Minor": "0" }, "Approval Groups": [ "Business", "Technical", "Quality" ] } }
Create Approval Template
Approval Templates define the approval tasks and approval order. Record Types and Constraints are used to associate an Approval Template to one or more Record Types. We will create a Default Approval Template for qTest records.
Add an Approval Template Name, Default Approval.
"Route Templates": [ { "Name": "Default Approval" } ]Here is the updated Approval Policy with above code block:
{ "Revision": "1", "Approval Policy": { "Version": "Vera Tutorial 1", "Schema": { "ID": "http://tx3services.com/schemas/0/0/approval-policy.json", "Major": "0", "Minor": "0" }, "Approval Groups": [ "Business", "Technical", "Quality" ], "Route Templates": [ { "Name": "Default Approval" } ] } }Add a Rank to the Approval Template. Rank determines the order Approval Templates are evaluated when a Record is routed for approval. Mutually exclusive Approval Templates that do not have overlapping Reocrd Types or Constraints can have the same Rank. Later, when we add additional Approval Templates, we will use Rank to ensure Approval Templates are evaluated in the correct order to ensure the correct Approval Template is matched to the Record. Set Rank with a value of 1.
"Rank": "1"
Here is the updated Approval Policy with above code block:
{ "Revision": "1", "Approval Policy": { "Version": "Vera Tutorial 1", "Schema": { "ID": "http://tx3services.com/schemas/0/0/approval-policy.json", "Major": "0", "Minor": "0" }, "Approval Groups": [ "Business", "Technical", "Quality" ], "Route Templates": [ { "Name": "Default Approval", "Rank": "1" } ] } }Add an optional element, Prevent Author Approval. When this option is set to true the qTest Test Case or qTest Test Run Author is not authorized to approve the record even if they have the correct approval role. The Author was defined in the Records Management Policy in the previous sections. Add Prevent Author Approval and set to true.
"Prevent Author Approval": true
Here is the updated Approval Policy with above code block:
{ "Revision": "1", "Approval Policy": { "Version": "Vera Tutorial 1", "Schema": { "ID": "http://tx3services.com/schemas/0/0/approval-policy.json", "Major": "0", "Minor": "0" }, "Approval Groups": [ "Business", "Technical", "Quality" ], "Route Templates": [ { "Name": "Default Approval", "Rank": "1", "Prevent Author Approval": true } ] } }Add the Record Types to the Approval Template. The Record Types are defined in the Records Management Policy. Enter the Record Types that should be associated with the Route Template. We will add qTest Test Case, Automated Test Case and qTest Test Run Record Types.
"Record Types": [ "qTest Test Case", "Automated Test Case", "qTest Test Run" ]Here is the updated Approval Policy with above code block:
{ "Revision": "1", "Approval Policy": { "Version": "Vera Tutorial 1", "Schema": { "ID": "http://tx3services.com/schemas/0/0/approval-policy.json", "Major": "0", "Minor": "0" }, "Approval Groups": [ "Business", "Technical", "Quality" ], "Route Templates": [ { "Name": "Default Approval", "Rank": "1", "Prevent Author Approval": true, "Record Types": [ "qTest Test Case", "Automated Test Case", "qTest Test Run" ] } ] } }Add Constraints to the Route Template. Right now we only have one Route Template in the Approval Policy which will be used for all Record Types so there are no constraints.
"Constraints": []
Here is the updated Approval Policy with above code block:
{ "Revision": "1", "Approval Policy": { "Version": "Vera Tutorial 1", "Schema": { "ID": "http://tx3services.com/schemas/0/0/approval-policy.json", "Major": "0", "Minor": "0" }, "Approval Groups": [ "Business", "Technical", "Quality" ], "Route Templates": [ { "Name": "Default Approval", "Rank": "1", "Prevent Author Approval": true, "Record Types": [ "qTest Test Case", "Automated Test Case", "qTest Test Run" ], "Constraints": [] } ] } }Add Levels to the Route Template. Levels contain one or more Levels with one or more Approvers. The Approvers are defined in the Approve Groups element of the Approval Policy. We recommend using Level # pattern for Levels. Approvers in the same Level can complete their approval tasks in any order. All approvals must be complete before Approvers in subsequent Levels can be completed. The Default Approver route template will have 3 Approvers, Technical and Business can approve in any order, then after those Approvers there is a Quality Approver on Level 2.
"Levels": [ { "Name": "Level 1", "Approvers": ["Technical","Business"] }, { "Name": "Level 2", "Approvers": ["Quality"] } ]Here is the updated Approval Policy with above code block:
{ "Revision": "1", "Approval Policy": { "Version": "Vera Tutorial 1", "Schema": { "ID": "http://tx3services.com/schemas/0/0/approval-policy.json", "Major": "0", "Minor": "0" }, "Approval Groups": [ "Business", "Technical", "Quality" ], "Route Templates": [ { "Name": "Default Approval", "Rank": "1", "Prevent Author Approval": true, "Record Types": [ "qTest Test Case", "Automated Test Case", "qTest Test Run" ], "Constraints": [], "Levels": [ { "Name": "Level 1", "Approvers": ["Technical","Business"] }, { "Name": "Level 2", "Approvers": ["Quality"] } ] } ] } }
Now we have an Approval Policy configured for qTest integration. The completed JSON file with the Default Approval Route Template can be downloaded:
Now that we have created our Records Management Policy and Approval Policy we can upload the polices to Vera Upload Policies