...
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 save , and Schema. Save the file as VeraAPTutorial-part1.json.:
Code Block language json { "Revision": "1", "Approval Policy": { "Version": "1.0.0.0" } }
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
Code Block language json "Approval Groups": [Vera Tutorial 1", "Schema": { "Business"ID": "http://tx3services.com/schemas/0/0/approval-policy.json", "Major": "Technical0", "Minor": "Quality0" } ]
Here is the updated Approval Policy with above code block:
Code Block language json { "Approval Policy": { "Version": "1.0.0.0", "Approval Groups": [ "Business",}
Info |
---|
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 the Approval Groups Business, Technical, and Quality:
Code Block language json "Approval Groups": [ "TechnicalBusiness", "QualityTechnical", ] } }
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.
Code Block "Quality" ]
Here is the updated Approval Policy with above code block:
Code Block language json { "Revision": "1", "Approval Policy": { "Route TemplatesVersion": ["Vera Tutorial 1", "Schema": { "ID": "http://tx3services.com/schemas/0/0/approval-policy.json", "NameMajor": "Default Approval0", } "Minor": "0" ]
Here is the updated Approval Policy with above code block:
Code Block { "Approval Policy": { "Version": "1.0.0.0" }, "Approval Groups": [ "Business", "Technical", "Quality" ], } "Route Templates": [ }
Create Route Template
Route Templates define the approval tasks and approval order. Record Types and Constraints are used to associate a Route Template to one or more Record Types. We will create a Default Approval Template for qTest records.
Add a Route Template Name as Default Approval:
Code Block "Route Templates": [ { "Name": "Default Approval" } ]
Here is the updated Approval Policy with above code block:
Code Block { "Revision": "1", } }
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.
Code Block "Approval Policy": { "Version": "Vera Tutorial 1", "Schema": { "RankID": "1"
Here is the updated Approval Policy with above code block:
Code Block { "Approval Policy": { http://tx3services.com/schemas/0/0/approval-policy.json", "VersionMajor": "1.0.0.0", "Approval Groups""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.a Rank to the Route Template. Rank determines the order Route Templates are evaluated when a Record is routed for approval. Mutually exclusive Route Templates that do not have overlapping Record Types or Constraints can have the same Rank. Later, when we add additional Route Templates, we will use Rank to ensure Route Templates are evaluated in the correct order to ensure the correct Route Template is matched to the Record. Set Rank to a value of 1:
Code Block "Prevent Author ApprovalRank": true"1"
Here is the updated Approval Policy with above code block:
Code Block { "Approval Policy": { "VersionRevision": "1.0.0.0", "Approval GroupsPolicy": { [ "Version": "Vera Tutorial "Business1", "TechnicalSchema",: { "QualityID": "http://tx3services.com/schemas/0/0/approval-policy.json", ], "Route TemplatesMajor": [ { "0", "NameMinor": "Default Approval0", }, "RankApproval Groups": [ "1Business", "Technical", "Prevent Author Approval"Quality" ], "Route Templates": 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.
Code Block "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:
Code Block "Prevent Author Approval": true
Here is the updated Approval Policy with above code block:
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 Route 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:
Code Block "Record Types": [ "qTest Test Case", "Automated Test Case", "qTest Test Run" ]
Here is the updated Approval Policy with above code block:
Code Block { "Revision": "1", "Approval Policy": { "Version": "Vera Tutorial 1", "Schema": { "ID": "http://tx3services.com/schemas/0/0/approval-policy.json", "Major": "Record Types0", "Minor": ["0" }, "Approval Groups"qTest: Test[ Case", "Business", "Automated Test Case"Technical", "Quality" ], "qTest Test Run"Route Templates": [ ]
Here is the updated Approval Policy with above code block:
Code Block { "Approval Policy": { "VersionName": "1.0.0.0Default Approval", "Approval Groups": [ "Rank": "Business1", "Technical", "Prevent Author Approval"Quality": true, ], "RouteRecord TemplatesTypes": [ { "qTest Test "Name": "Default Approval",Case", "Rank": "1Automated Test Case", "Prevent Author Approval":qTest true,Test Run" "Record Types": [] } "qTest Test Case", ] "Automated Test Case", } }
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.
Code Block "qTest Test RunConstraints": []
Here is the updated Approval Policy with above code block:
Code Block { ] "Revision": "1", "Approval Policy": { } ] } }
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.
Code Block "Version": "Vera Tutorial 1", "Schema": { "ID"Constraints: "http: []
Here is the updated Approval Policy with above code block:
Code Block {//tx3services.com/schemas/0/0/approval-policy.json", "Approval Policy": { Major": "0", "VersionMinor": "1.0.0.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 approval levelswith one or more Approvers. The Approvers are defined in the Approve Approval 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 completed before Approvers in subsequent Levels can be completed. The Default Approver route template will have 3 three Approvers, : Technical and Business can approve in any order, then after those Approvers that there is a Quality Approver on Level 2.:
Code Block "Levels": [ { "Name": "Level 1", "Approvers": ["Technical","Business"]"] }, { "Name": "Level 2", },"Approvers": ["Quality"] {} ]
Here is the updated Approval Policy with above code block:
Code Block { "NameRevision": "Level 21", "Approvers"Approval Policy": ["Quality"]{ "Version": "Vera Tutorial 1", } "Schema": { ]
Here is the updated Approval Policy with above code block:
Code Block {"ID": "http://tx3services.com/schemas/0/0/approval-policy.json", "Approval Policy": { Major": "0", "VersionMinor": "1.0.0.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 here:
View file | ||
---|---|---|
|
...
Info |
---|
Now that we have created our Records Management Policy and Approval Policy we can upload the polices to Vera Upload Policies |