This tutorial will guide you through writing Groovy scripts that test the value of a field and perform an action based on the outcome.For this you need to access the field of an issue looking at the Issue interface and compare it against a value using the Groovy operators.
On this page:
2.1 Test the value of a field against a String
This section of the tutorial guides you through writing a conditional statement that compares the value of a field against a String. Imagine a functional use case where you want to allow the progress on an issue only when the issue is assigned to the logged in user. For this you will need to write a Groovy script in the Scripted (Groovy) condition to compare the usernames of the Assignee and the logged in user.
Note that you need not create a new condition for this. The imported backup has everything in place.
Writing the script
Step 1 - Navigate to the condition
- Go to the Administration icon and click on it.
- Go to Issues - > Workflows
- Locate the workflow GIJ: Process Management Workflow
- Edit it
- Click on transition Start Progress
- Go to the
Conditions
tab - Edit the Scripted (Groovy) condition which is the first condition in the list.
Step 2 - Write the script in the condition
Write the following script in
Groovy script
.issue.get("assignee").name == currentUser.name
(1) Accessing the assignee of an issue using the
get()
method and fetching the name of the ApplicationUser using.name
Your configuration should look like this:
Step 3 - Test your script
- Click on
Test Groovy Script
. - Input the issue key
GIJ-5
- Click on
Test
- The following result will be displayed.
Step 4 - Save the configuration
- Click on
Update
- Publish the workflow (you dont need to save a backup copy).
Step 5 - Test it on an issue
- View the issue
GIJ-5
in a new tab. - Check that the transition
Start Progress
is not available for a trigger on the issueGIJ-5.
- Click on
Assign to me
, to assign it to the logged in user.
- Check that the transition
Start Progress
is now available for a trigger on the issueGIJ-5.
Use cases
The output of the code is a Boolean. You can use this script in any other relevant context, such as allowing only the reporter of the issue to close the issue.
References
2.1 Writing a simple conditional statement
This section of the tutorial will teach you writing a simple condition and testing it in the Groovy script tester on the JMWE administration pages. Let us write a simple condition to check that the priority of an issue is Critical
or Highest
.
Writing the script
Step 1 - Navigate to the Groovy script tester in the admin pages
- Go to the Administration icon and click on it.
- Locate Add-ons from the menu and click on it.
- Locate JIRA MISC WORKFLOW EXTENSIONS on the left panel.
- Click on Groovy script tester.
Step 2 - Write the script in the editor
Write the following script in the editor.
if(issue.getAsString("priority") == "Critical" || issue.getAsString("priority") == "Highest"){ return true } else{ return false }
- Your script will look like this:
Step 3 - Test your script
- Click on
Test Groovy Script
. - Input the issue key
GIJ-3
- Click on
Test
- The following result will be displayed.
Step 4 - Simplify your script
You can simplify the script removing the if-else
and returning the result of the comparison which is a Groovy truthy or falsy
- Go to the editor
Replace the script with the following code:
issue.getAsString("priority") == "Critical" || issue.getAsString("priority") == "Highest"
Step 5 - Retest your script
- Click on
Test again
. - The following result will be displayed.
Use cases
The output of the code is a boolean value. You can use this script in any relevant context, such as, Assign the issue to the Project lead only if the priority of the issue is Critical
or Highest
.
References
2.3 Writing multiple conditions using switch
This section of the tutorial will guide you through writing multiple conditions using the switch control structure
Writing the script
Step 1 - Navigate to the post-function
- Go back to the previous tab.
- Edit the workflow in
Diagram
mode. - Click on the Create transition
- Click on Post-functions
- Edit the second post-function in the list.
Step 2 - Write the script in the post-function
Write the following script in
Value.
def component = issue.getAsString("components") def priority = "" switch (component) { case "Finance" : priority = "Highest"; break case "Production Planning" || "Quality Management" : priority = "High"; break default : priority = "Medium"; break }
- Your script should look like this:
Step 3 - Test your script
- Click on
Test Groovy Script
. - Input the issue key
GIJ-5
- Click on
Test
- The following result will be displayed.
Use cases
The output of the code is a String representing the priority of an issue. You can use this script in any relevant context, such as, setting the priority of the issue to based on the Component/s.