Please note: upgrade JMWE to the latest version to keep your workflows running.
Event-based Actions
- Daniel Barrow
- Comala Publishing
An Event-based Action is a series of one or more JMWE post-functions that run when a change is made to an issue, such as when fields are modified, an issue is transitioned, or a comment is added.
Some examples of what can be achieved through Event-based Actions are:
Synchronizing changes to a field with related issues such as sub-tasks, linked issues, epics, etc.
Calculating the value of a field based on the values of another field. See this post for a demonstration.
Copying a comment added by a customer on a Service Management request to linked Jira Software issues.
Validating data when a user edits an issue field on the issue view screen (as opposed to validating field values during a transition, for which you should use a Validator). See this video for a demonstration.
Events
Nearly any issue event can trigger an Event-based Action; the Event configurations determine which specific event will trigger the action.
Note: Currently, only one event can be selected for an Event-based Action. If you need to trigger the same sequence of post-functions for multiple events, it is recommended that you do the following:
Create a Shared Action for the sequence of post-functions that should run after the event.
Create an Event-based Action for the first event that should trigger the action.
In the Post-functions configuration for the action, use the Shared Action post-function to add the sequence of post-functions you created in Step 1.
Duplicate the Event-based Action for each of the events needed.
When you create an Event-based Action in this way it makes some edits or updates easier. If you need to modify the post-functions that run during the event (e.g. change the configuration of an existing post-function or add a new post-function), you can edit the Shared Action, and those changes will be applied to all of the actions that utilize that Shared Action.
The following events are able to trigger an Event-based Action:
Issue Link Added, Issue Link Deleted: When you select one of these events, the Post-functions configured are run on issues based on the direction of the associated issue link type. For example, when the issue link type between a Dev task and Testing task is Dev
is blocked byTesting, the post-function is run on the Testing task.
You are viewing the documentation for Jira Cloud.
Administration
To access Event-based Actions:
Log into your Jira instance as an administrator.
Click the Settings icon in the upper right corner and select Apps.
Under JIRA MISC WORKFLOW EXTENSIONS in the left-hand panel, click Event-based Actions.
The Event-based Actions page (Figure 1, right) lists all Event-based Actions that have been created, as well as the following:
Search - Filter the list of Event-based actions by action ID.
Create new action - Click to create a new Event-based Action.
Shared action list - A list of all Event-based Actions for the instance. The list includes the following information:
Enabled - Status of an Event-based Action. By default, a newly created Event-based Action is enabled.
Action Name - The name of the Event-based Action. Click the name to edit the Event-based Action.
Event(s) - The event or events that will trigger the action.
Projects - The number of projects to which the Event-based Action has been applied.
Hold the pointer over the badge to see a list of projects in which the Event-based Action is used.By - The user who created the action, or the last user to edit or enable/disable the action.
Last modified - When the action was last modified (edited or enabled/disabled).
Post-functions - The number of post-functions included in the Event-based Action.
Hold the pointer over the badge to see a list of the post-functions included in the Event-based Action.Action menu - Click to open a menu with specific actions for the Event-based Action:
Duplicate - Create a copy of the Event-based Action. The new action will have the same name as the original, with “- copy” appended.
View Summary - Open the Summary window (Figure 2, right), listing the triggering event for the action, the projects and issues included in the action, and the Post-functions that will run in the Event-based Action.
ID - The Jira ID of the Event-based Action. Click the menu option to copy the ID value to your clipboard. This value can be used in the JMWE Logs page to filter the logs by Action ID.
Delete - Permanently delete the Event-based Action.
In the event that an Event-based Action encounters a serious issue, it may be disabled by Appfire. In these circumstances, the Enabled column will show as either Disabled or Blocked with the message “This event-based action was disabled/blocked by Appfire. Please contact Appfire support for details”.
Filter and Sort
Configure an Event-based action
For more information on configuring Event-based actions, see this page.
