Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

Route Templates define the approval tasks and approval order. Record Types and Constraints are used to associate an a Route Template to one or more Record Types. We will create a Default Approval Template for qTest records.

  1. Add an 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",
      "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"
          }
        ]
      }
    }
  2. Add 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
            "Rank": "1"

    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"
          }
        ]
      }
    }
  3. 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
          }
        ]
      }
    }
  4. 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": "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"
            ]
          }
        ]
      }
    }
  5. 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
            "Constraints": [] 

    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,
            "Record Types": [
              "qTest Test Case",
              "Automated Test Case",
              "qTest Test Run"
            ],
            "Constraints": []
          }
        ]
      }
    }
  6. Add Levels to the Route Template. Levels contain one or more approval levelswith one or more Approvers. The Approvers are defined in the 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 completed before Approvers in subsequent Levels can be completed. The Default Approver route template will have three Approvers: Technical and Business can approve in any order, then after 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
    {
      "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"]
              }
            ]
          }
        ]
      }
    }

...