Integrate Vera workflow states into Jira workflows

Tricentis Vera supports the following workflow states:

• Routing for Approval

• Pending Vera Action

• Vera Error

• Approved

• Rejected

Note: Statuses are allowed to exist before the Routing for Approval state as long as Vera states are set up correctly.

Before you begin

Before you integrate Vera workflow, follow these steps:

1. Create Vera service account in Jira or Create Vera service account in Jira Cloud.

2. Create Vera system role.

3. Create Vera webhooks.

Workflow update for 2022.2

In the 2022.2 release, Vera incorporates new workflow states into Jira to better handle the processing of Vera records. The new update minimizes the amount of Vera states interacting with non-Vera statuses by funneling activity through the new Pending Vera Action status.

The newly supported transitions are:

• Vera Approval Route Started

• Vera Approval Route Canceled

• Vera Record Revised

• Vera Processing Error

Jira Server Plugin and Jira Cloud app handles the following intermediate states:

• Pending Vera Action

• Vera Error

Backwards compatibility

If the new transitions and intermediate states are not configured, then Vera will continue processing without using the original Routing for Approval, Approved, and Rejected statuses.

To integrate new or existing workflows to include Vera workflow states, follow these steps:

1. Navigate to Jira Administration Settings > Issues > Workflows.

2. Select the Edit button on the appropriate workflow.

3. Add the following Vera statuses as new steps:

   Step	Linked status
   Routing for Approval	Routing for Approval
   Pending VERA Action	Pending VERA Action
   VERA Error	VERA Error
   Approved	Approved
   Rejected	Rejected

4. Add the following property keys for all statuses except the first workflow status, such as To-Do and New.

   • Workflows that leverage Vera functionality need to have the Delete, Move, and Clone actions disabled for each workflow state other than the first workflow state.

   • The default permission scheme in Jira provides administrators the ability to use the Delete and Move actions in all workflow states. To allow non-administrator users these abilities, grant the permission to the preferred users in Issues > Permission Schemes.

   • Tx3 VERA Workflow Lock is not a real username and can be replaced with any fictitious value. The intent of this configuration is to restrict these actions to a fictitious user, ensuring that no actual user will be able to perform them.

     Property key	Property value*
     jira.permission.delete.user	Tx3 VERA Workflow Lock
     jira.permission.move.user	Tx3 VERA Workflow Lock
     jira.permission.createclone.user	Tx3 VERA Workflow Lock

5. Add the following property key to all Vera statuses (Routing for Approval, Pending Vera Action, Vera Error, Approved, and Rejected).

   Vera workflow states must be locked to prevent anyone other than the Vera service account from performing editing actions in Vera states.

   Fill in the appropriate Vera service account's username in the property value below:

   Property key	Property value*
   jira.permission.edit.user	<username of VERA service account>

6. Create transitions for the Vera statuses.

   All Vera statuses must be named according to the chart below and cannot be changed. The transitions between each status, however, are flexible and don't need to follow any naming convention.

   All transitions listed are required except the Revise transition.

   Transition from	Example transition name	Transition to	Purpose of the transition
   <Previous non-Vera status>	Start Approval(s)	Pending Vera Action	Trigger the Vera approval route.
   Pending Vera Action	Vera Approval Route Started	Routing for Approval	Vera System locks the record for processing the route for approval.
   Pending Vera Action	Vera Approval Route Cancelled	In Progress	Vera System locks the record for processing the cancellation of the approval route.
   Pending Vera Action	Vera Record Revised	In Progress	Vera System locks the record for processing the revision of the approval route.
   Pending Vera Action	Vera Processing Error	Vera Error	Vera System encountered an error when routing for approval.
   Routing for Approval	Complete Approval	Approved	Required for Vera service account to transition record to Approved when all approvers have signed the record.
   Routing for Approval	Complete Rejection	Rejected	Required for Vera service account to transition record to Rejected if the issue has been rejected.
   Routing for Approval	Withdraw Approval(s)	Pending Vera Action	Allows Jira Admins to roll back the Jira issue if the Vera approval route fails.
   Rejected	Withdraw Approval(s)	Pending Vera Action	Allows users to withdraw and edit the rejected record.
   Approved	Revise	Pending Vera Action	(Optional) Allows users to revise and rework the previously approved record.
   Vera Error	Vera Approval Route Started	Routing for Approval	Vera System locks the record for processing the route for approval if a Vera error occurs.
   Vera Error	Vera Approval Route Cancelled	In Progress	Vera System locks the record for processing the cancellation of the approval route if a Vera error occurs.
   Vera Error	Vera Record Revised	In Progress	Vera System locks the record for processing the revision of the approval route if a Vera error occurs.

7. For each Vera transition, add the appropriate options:

   • Webhooks must be added to the appropriate transitions to trigger approval route activities in Vera.

   • After adding the webhook as a post function, move the webhook transition to be the last post function.

   • Conditions must be added to the appropriate transitions so that only the Vera service account will have permissions to execute these transitions.

   Transition name	Option	Option name	Option parameter
   Start Approval(s)	Post Function	Trigger a Webhook	Start Vera Approval Route
   Withdraw Approval(s)	Post Function	Trigger a Webhook	Cancel Vera Approval Route
   Revise	Post Function	Trigger a Webhook	Revise Vera Record
   Vera Approval Route Started	Condition	User Is In Project Role	Tx3 Vera System
   Vera Approval Route Cancelled	Condition	User Is In Project Role	Tx3 Vera System
   Vera Record Revised	Condition	User Is In Project Role	Tx3 Vera System
   Vera Processing Error	Condition	User Is In Project Role	Tx3 Vera System
   Complete Approval	Condition	User Is In Project Role	Tx3 Vera System
   Complete Rejection	Condition	User Is In Project Role	Tx3 Vera System

8. Click Publish Draft to save the newly Vera integrated workflow.

Examples