Build-your-own Validator
- Daniel Barrow
A workflow validator that is based on the result of either a custom expression or a scripted Groovy expression. If the expression returns false (or falsey), a validation error message will be displayed.
The Build-your-own validator will evaluate when its Transition is triggered and will either allow the transition or display an error message, based on the outcome of the included expression - when the expression evaluates to true (or “truthy” in the case of Groovy expressions) the transition will proceed; otherwise the transition will not be triggered and a message will be displayed to the user. There are two options for creating an expression:
No Code - Build an expression to test the value of a field using standard operators (e.g. “equals/does not equal”, “greater than/less than”, and “is empty/is not empty” among others). Field values can be compared to other fields or to static values.
Groovy Script - For even greater flexibility, build a Groovy expression that evaluates to
trueorfalse(or truthy/falsey). For more information on using Groovy in JMWE, see Using Groovy with JMWE.
Note: the No Code option for this Validator enables you to build an expression using several fields to configure which field should be evaluated, and the conditions that the field value must meet in order to evaluate to true or false. Once the No Code fields have been configured, a Groovy script will be generated for you! The Validator can be saved as configured, and it will remain a No Code validator or it can be switched to a Groovy script validator that automatically uses the generated script.
Alternately, the generated Groovy script can be copied so it can be updated and/or customized outside of JMWE.
Configure the validator
Follow the steps above to add a validator to a Transition.
From the list of validators, select Build-your-own Validator.
Click Add.
The Build-your-own Validator page will open (Figure 1, right). Configure the validator as needed. See below for details on each of the configurations.
Click Add.
Options
The following options are available:
Description - Give the validator a description. The Description will be displayed in the list of validators for a Transition.
Error message - The error message that will display to the user when the validator evaluates to
false.Choose Type - Select either No Code to build a validator using standard logical operators, or select Groovy Script to enter a Groovy expression.
Field - Only available when Choose Type, above, is set to No Code. Select the field to be evaluated.
Operator - Only available when Choose Type, above, is set to No Code. Select the logical operator to use in the field evaluation.
Value to compare type - Only available when Choose Type, above, is set to No Code. Configure whether to compare the field value to another field or to a static value.
Value to compare - Only available when Choose Type, above, is set to No Code. This field updates based on the setting for Value to compare type:
Field - When value to compare type is set to ‘Field’, this field is a pulldown menu used to select the comparing field to use in evaluation.
Text - When value to compare type is set to ‘Text’, this field is a text field where a static value can be entered.
Regex - Only available when Choose Type, above, is set to No Code and Operator is set to Matches a regular expression/Does not match a regular expression. The regular expression to use in the field evaluation.
Compiled script - Only available when Choose Type, above, is set to No Code. After all other fields have been configured, the compiled script will be displayed (Figure 2, right). The Compiled script window includes two buttons:
Test ( ) - Test the compiled script against an existing issue to determine the outcome.
Copy ( ) - Copy the compiled script to the clipboard.
Groovy script - Only available when Choose Type, above, is set to Groovy script.
You are viewing the documentation for Jira Data Center/Server.
On This Page
