Using Multi Select Fields in Approval Route Templates
- HB Farris
Organizations can use multi select fields in Jira and qTest for record approval routes.
- 1 Sample Business Rules
- 2 Vera Analysis & Design
- 3 Jira Project Configuration
- 4 Vera Configuration
- 4.1 Records Management Policy updates
- 4.2 Approval Policy updates
- 4.2.1 Approval Roles
- 4.2.2 Approval Templates
- 4.2.2.1 Qualification, SOX & GxP
- 4.2.2.2 Qualification & SOX
- 4.2.2.3 Qualification & GxP
- 4.2.2.4 SOX & GxP
- 4.2.2.5 Qualification
- 4.2.2.6 SOX
- 4.2.2.7 GxP
- 5 Policy Samples
Sample Business Rules
Consider the following scenario for Jira issues:
Compliance (multi select field) | Technical | Business | Quality |
|---|---|---|---|
Qualification | A |
|
|
SOX |
| A |
|
GxP |
|
| A |
Qualification & SOX | A | A |
|
Qualification & GxP | A |
| A |
SOX & GxP |
| A | A |
Qualification, SOX & GxP | A | A | A |
Vera Analysis & Design
Based on the above requirement we will need to make the following modifications:
Update Jira Issue field and field values
Add Compliance field
Add Compliance field values: Qualification, SOX, GxP
Add the Jira Issue Record Type data fields in the Records Management Policy
Modify the Approval Policy
Add new Approval Roles
Add and modify Route Templates
We will need to update the Approval Policy with the following Approval Templates:
Approval Template Name | Rank | Record Type | Constraints | Level 1 Approvers |
|---|---|---|---|---|
Qualification, SOX & GxP | 1 | Jira Issue | Compliance = (Qualification, SOX & GxP) | Technical, Business, Quality |
Qualification & SOX | 2 | Jira Issue | Compliance = (Qualification & SOX) | Technical, Business |
Qualification & GxP | 3 | Jira Issue | Compliance = (Qualification & GxP) | Technical, Quality |
SOX & GxP | 4 | Jira Issue | Compliance = (SOX & GxP) | Business, Quality |
Qualification | 6 | Jira Issue | Compliance = Qualification | Technical |
SOX | 7 | Jira Issue | Compliance = SOX | Business |
GxP | 8 | Jira Issue | Compliance = GxP | Quality |
Rank determines the order Route Templates are evaluated by Vera when a record is routed for approval. Use Rank to ensure Constraints are evaluated in the proper order. The rank can be any integer from 1 to 9999. Default is the lowest rank (highest number) so it is the last Route Template evaluated.
Jira Project Configuration
Add Custom Multi Select List field to Jira named Compliance and add options for Qualification, SOX and GxP
Remember to add custom field to screens
Vera Configuration
Now that you evaluated the business rules and updated Jira, you can update the Records Management Policy and the Approval Policy.
Records Management Policy updates
We are going to update the Records Management Policy by adding a Jira Issue record and fields. Ensure you add the Compliance field to the Jira Issue
{
"Name": "Jira Issue",
"Definitions": [
{
"Systems": [
"JIRA"
],
"Singular Name": "Issue",
"Plural Name": "Issues"
}
],
"Fields": [
{
"Name": "Components",
"Is Data": true
},
{
"Name": "Description",
"Is Data": true
},
{
"Name": "Summary",
"Is Data": true
},
{
"Name": "Issue Type",
"Is Data": true
},
{
"Name": "Fix versions",
"Is Data": true
},
{
"Name": "Owner",
"Is Data": true
},
{
"Name": "Compliance",
"Is Data": true
}
]
}Approval Policy updates
The following Approval Roles and Route Templates are added to the Approval Policy.
Approval Roles
Ensure the Technical, Business and Quality Approval Roles are defined in the Approval Policy:
"Approval Groups": [
"Business",
"Technical",
"Quality",
"Data Owner",
"Product Team Member",
"Product Lead"
]Approval Templates
Now we can add the new Route Templates.
Qualification, SOX & GxP
Configuration element | Value | Code Snippet |
|---|---|---|
Name | Qualification, SOX & GxP | "Name": "Qualification, SOX & GxP" |
Rank | 1 | |
Record Type | Jira Issue | |
Constraints | Compliance = (Qualification, SOX & GxP) | The ALL & Field Contains constraints can be used for this business rule. Note: Ignore Case default value is false. |
Level 1 Approvers | Technical, Business, Quality |
The completed Route Template for Qualification, SOX & GxP is below:
Qualification & SOX
Configuration element | Value | Code Snippet |
|---|---|---|
Name | Qualification & SOX | |
Rank | 2 | |
Record Type | Jira Issue | |
Constraints | Compliance = (Qualification & SOX) | The ALL & Field Contains constraints can be used for this business rule. Note: Ignore Case default value is false. |
Level 1 Approvers | Technical, Business |
The completed Route Template for Qualification, SOX & GxP is below:
Qualification & GxP
Configuration element | Value | Code Snippet |
|---|---|---|
Name | Qualification & GxP | |
Rank | 3 | |
Record Type | Jira Issue | |
Constraints | Compliance = (Qualification & GxP) | The ALL & Field Contains constraints can be used for this business rule. Note: Ignore Case default value is false. |
Level 1 Approvers | Technical, Quality |
The completed Route Template for Qualification & GxP is below:
SOX & GxP
Configuration element | Value | Code Snippet |
|---|---|---|
Name | SOX & GxP | |
Rank | 4 | |
Record Type | Jira Issue | |
Constraints | Compliance = (SOX & GxP) | The ALL & Field Contains constraints can be used for this business rule. Note: Ignore Case default value is false. |
Level 1 Approvers | Business, Quality |
The completed Route Template for SOX & GxP is below:
Qualification
Configuration element | Value | Code Snippet |
|---|---|---|
Name | Qualification | |
Rank | 5 | |
Record Type | Jira Issue | |
Constraints | Compliance = Qualification | The Field Contains constraints can be used for this business rule. Note: Ignore Case default value is false. |
Level 1 Approvers | Technical |
The completed Route Template for Qualification is below:
SOX
Configuration element | Value | Code Snippet |
|---|---|---|
Name | SOX | |
Rank | 6 | |
Record Type | Jira Issue | |
Constraints | Compliance = SOX | The Field Contains constraints can be used for this business rule. Note: Ignore Case default value is false. |
Level 1 Approvers | Business |
The completed Route Template for SOX is below:
GxP
Configuration element | Value | Code Snippet |
|---|---|---|
Name | GxP | |
Rank | 7 | |
Record Type | Jira Issue | |
Constraints | Compliance = GxP | The Field Contains constraints can be used for this business rule. Note: Ignore Case default value is false. |
Level 1 Approvers | Quality |
The completed Route Template for GxP is below:
Policy Samples
When you route a Jira Issue for Approval the Compliance field set to any combination of Qualification, SOX or GxP, the corresponding approval template will be applied to the record:
Here is the sample Records Management Policy and Approval Policy created during this exercise.