| Excerpt |
|---|
A workflow validator that is based on the result of a Jira expression. |
If the Jira expression returns false, a validation error message will be displayed. This can be used to test or compare issue fields, to test linked issues, to check for open Sprints, etc.
To add the 'Build-your-own (scripted) Validator' to a transition:
Click Edit for the workflow that has the transition you wish to configure the condition on.
In the Workflow Designer, select the transition.
Click on Validations in the properties panel.
Click on
Add validation.Select
Build-your-own (scripted) Validatorfrom the list of conditionsvalidators.Click on
Addto add the validator on the transition.Input a Jira expression in the
Jira expressionfield.Input a message in the
Error messagefield to display if the configured conditions are not satisfied. For information on how to write a 'Jira expression' see How to insert information using Jira expressions.Click on
Addto add the condition to the transition.
| Note |
|---|
On the Service Management portal view of a request, the customer will not see the |
.png?version=1&modificationDate=1556616354970&cacheVersion=1&api=v2){kind=spacer}
When you add this validator to a transition and trigger the transition, the add-on checks the result of the Jira expression. If it returns true the validation will pass. If it returns false or any non-boolean value, a validation error message is displayed.
Use case
A typical use of this workflow validator is to validate that the field of the issue has a specific value or the current user belongs to a specific group during the transition. Consider a use case where you want to block the user from triggering the “Approve” transition when the current user is not in the “Approvers” field. To configure this:
Add the “Build-your-own (scripted) validator” to the “Approve” transition
Input the following code under “Jira Expression”
Code Block !! issue.customfield_10002 && issue.customfield_10002.some(it => it == user)
Avoid Jira expressions errors
When a Jira expression throws an error, Jira considers the result as false and hence the workflow validator fails. The best way to avoid errors in your Jira expressions is to test your Jira expressions against an issue using the "Jira expression tester" before saving the validator. Here are typical problems you need to look out for:
null values: If your Jira expression returns null it is considered a non-boolean value and hence Jira returns an error. For example, to check that the issue is assigned, if you provide the Jira expression as:
| Code Block |
|---|
issue.assignee |
when tested against an issue that is unassigned the expression returns null. In such cases,lthe easiest is to use two logical not operators (!!) to return true if the issue is assigned ( !issue.assignee returns false hence !! issue.assignee will return true when the issue is assigned).
| Code Block |
|---|
!! issue.assignee |
You can also write a Jira expression to check that the result is not null like this:
| Code Block |
|---|
issue.assignee != null |
If your Jira expression accesses properties of an object that is null, then your Jira expression and thereby your workflow validator fail with an error. For example, to check that the issue's parent is a Story if you provide the Jira expression:
| Code Block |
|---|
issue.parent.issuetype.name == "Story" |
when tested against an issue without a parent, the Jira expression will return an error "Type null does not have any properties". To handle this you should include an expression to test that the issue has a parent.
Another use of this validator is to validate the comment added during the transition. Jira expressions do not facilitate a context variable to get the comment added during the transition. But you can access the comment on the transition screen with a workaround. Consider a use case where you want to block the user from rejecting the “Bug” without a comment with atleast 10 characters. To configure this:
Add the “Build-your-own (scripted) validator” to the “Approve” transition
Input the following code under “Jira Expression”
Code Block issue.comments.some(comment => !comment.id && comment.body.plainText.length > 10)
This basically tests whether there is a comment that has no ID (and therefore is new) and whose body length is > 10.