Workflow Rules
Before you start
View our training module on Scripted Workflow Rules.
What are workflow rules?
Workflow rules in ScriptRunner for Jira Cloud allow you to extend and automate Jira's native workflows by adding conditional logic, custom validators, and post-transition rules. They enable you to create rules for transitioning a work item's status in Jira Cloud, giving you greater control over when and how it transitions.
How to use workflow rules
ScriptRunner for Jira Cloud provides built-in and custom workflow functions. You can use these workflows to change or transition a work item through a set of logical steps.
Workflows typically represent a process and contain a set of statuses and transitions. You can extend Jira's native workflows by adding:
Restrict Transitions - check to make sure that a requirement is met before the transition option is available.
Validate Details - check to make sure that a requirement is met when a user tries to transition a work item.
- Perform Actions - perform automated actions after a work item transitions to a new status.
You can only view Workflows in ScriptRunner for Jira Cloud if you have already created a restriction, validator, or workflow action from the Workflows within the Jira administration menus. Once added in Jira, the workflow appears in the Workflows section of ScriptRunner for Jira Cloud, where you can edit or disable it.
ScriptRunner for Jira Cloud provides workflow restrictions and validators using the Jira Expression Framework. It is not possible to use the REST API.
It's worth noting from the outset that although you may be familiar with extensions to workflows in the Jira Server version of ScriptRunner, the Cloud infrastructure differs. You can follow our step-by-step example to learn how to extend workflows.
What is the Workflow page?
The ScriptRunner for Jira cloud Workflows page lets you quickly view and manage information about existing workflows, without navigating through the Jira administration menus. In other words, this is where you can edit a Scriptrunner workflow rule after it's been created on a workflow transition.
How to use the Workflow page
You simply navigate to ScriptRunner → Workflows and a list of all existing workflows displays.
You can view all workflow rules, or you can refine the list displayed by:
- Type - choose the type of workflow rules to display. These include Perform actions, Restrict transitions, and Validate details.
- Workflow Status - choose whether to display Active or Inactive workflows. Both are activated by default.
The History column displays any errors that may have occurred with the 10 most recent script executions. More details, such as logs or payload, can be accessed by clicking the red icon for a given error.
If you wish to edit or disable a particular workflow rule, click the Actions ellipsis for your preferred workflow and select either Edit or Disable.
- If you choose to disable the chosen workflow, you simply confirm this via a confirmation message once prompted.
- If you choose to edit the chosen workflow, you will see the workflow details screen displayed from where you can make the required edits and click Update. For example:
