Using Checklist for Jira with ScriptRunner Behaviors
- Yves Riel
Use Case
- +/- 7 minutes read
Few things in tech are as satisfying as creating automation to handle repeated tasks. Automation can improve accuracy, simplify complex tasks and streamline Jira workflows.
The latest release (v7.1) of Checklist for Jira (Data Center) provides new automation opportunities by allowing you to integrate your checklists with Behaviors from ScriptRunner, one of the most popular scripting tools in the Atlassian Marketplace.
By integrating checklists with the ScriptRunner Behaviors API, you can unlock many new possibilities. We will cover a few of them below.
Updating Checklists Based on Other Fields
First, you can use Scriptrunner integration to address a commonly requested use case – the ability to set the checklist’s contents depending on the value of another field on the Create Screen. Imagine that you create a new issue. Your process requires you to set a mandatory dropdown field which indicates the level of the request (e.g. Level 1, Level 2, etc). The content of the checklist is different for each level, and the requester is expected to check the appropriate items immediately.
Before the ScriptRunner’s behaviors integration, it was only possible to do with Jira automation which required two separate actions by the requestor. They would first create the issue, including setting the Level dropdown field. They would then have to open the newly created issue to view (and complete) the proper checklist.
Behaviors now allow you to achieve this without leaving the Create Issue screen. When the level dropdown is set, the Behavior script is run in the background and immediately populates the checklist with the proper template. The requester can now simply set the dropdown field, check the required items, and then create the issue; all in one go.
For technical details of this use case, see our documentation page: Load templates based on a select field.
Updating Other Fields Based on Checklists
Of course, you may want to do the process in reverse. Assume that the checklist is always the same when the issue is created. Based on which checklist item is selected, you would like to change the issue priority and even display an extra text field asking for more details.
The Behavior script can monitor when a specific checklist item has been checked, and then automatically set the issue priority, as well as display a mandatory text area asking for more details. All of this takes place before the issue is actually created. This can enhance collaboration and coordination in real-time, especially for larger teams.
Updating Checklists Based on it's Own Values
Finally, imagine your process requires you to assign yourself checklist items and set a due date for visibility. When the item is completed, you must remove the due date, change the item’s status to in review and assign the item to a member of the QA team.
The safest way to ensure that the process is properly followed is to automate it. Simply create a Behavior that will remove the due date and reassign the item to the QA team member when the item is checked. This way, you enforce your process and keep the busywork to a minimum.
See the Remove Due Date when the item is checked documentation page to learn more.
About ScriptRunner & Checklist for Jira
ScriptRunner for Jira is an application available on the Atlassian Marketplace, made by the good people at Adaptavist. It’s the ultimate Jira automation and customization tool to automate workflows and issues, extend Jira, and improve UX with Groovy Scripts and JQL. See their documentation for examples of what can be done with Scriptrunner.
Trusted by Global and Fortune 500 companies to get the job done, Checklist for Jira helps simplify your workflow and reduce the need for subtasks. Use them for To Do lists, QA, or Agile processes like Definition of Done and Acceptance Criteria.