How To Revert Workflow Changes In Jira
This page describes configuring transitions in Jira workflows. For data most the basics of workflows – see Working with workflow.
Equally a Jira administrator, you can command the following aspects of a transition'south behavior:
- Triggers – transition Jira bug when certain events occur in a connected development tool, such as Atlassian's Bitbucket or Stash.
- Atmospheric condition – bank check that a transition should be performed by the user.
- Validators – check that any input to the transition (for example, past a user) is valid,before the transition is performed.
- Post functions – comport out additional processing,later a transition is performed.
- Properties – are key-value pairs that can be used to further customize transitions.
As well on this page:
- Customize how transitions appear
- Global transitions
Triggers
Jira administrators can configure triggers in Jira workflows that respond to events in your linked evolution tools. This allows you to fix your development tools and Jira workflows so that, for example, when a programmer creates a co-operative to start work on an issue in Atlassian's Bitbucket or Stash, the consequence will automatically be transitioned from 'Open' to 'In progress'.
If you haven't set up up a trigger before or you want to learn nearly triggers in more item, come across our guide on triggers here: Configuring workflow triggers. The guide also shows you how to configure a workflow with triggers, similar to this sample development workflow: Development Workflow with Triggers (from Atlassian Marketplace).
Configure triggers
To see, or to set, triggers for a transition, edit the workflow that contains the transition, select the transition, then clickTriggers in the properties panel for the transition.
Conditions
Conditions control whether a transition should be executed by the user. As examples, conditions tin exist used to:
- allow but the reporter to execute a transition.
- allow simply users with a certain permission to execute a transition.
- let execution only if code has, or has non, been committed against this issue.
If a condition fails, the user volition not see the transition button on the 'View consequence' page, and so will not be able to execute the transition.
Conditions cannot validate input parameters gathered from the user on the transition'south screen – you lot demand a validator to exercise this.
The following sections describe:
- Calculation a condition
- Grouping conditions
Adding a status
To add together a condition to a transition, edit the workflow that contains the transition, select the transition, and then clickConditions in the backdrop panel for the transition.
On theConditions tab, yous tin see whatsoever conditions that accept already been set.
When you clickAdd condition, you can cull from the available conditions, and set any necessary parameters for the status. Boosted conditions may be available from installed apps. or you tin create your own conditions using the app organisation; see the Workflow app Modules for details.
Notation that you tin also edit the transition in 'text' style.
Grouping conditions
Y'all can construct complex conditions past grouping and nesting conditions. Change any status into a group by clicking the 'Add grouped status' icon for the condition. Now you can add further conditions to this new group, as described to a higher place.
You tin can toggle the logic for how the conditions in a group are applied between AllandAny.
Validators
Validators check that any input made to the transition is validearlier the transition is performed. Input tin can include that gathered from the user on the transition's screen.
If a validator fails, the issue does not progress to the destination status of the transition, and the transition'due south mail service functions are not executed.
Adding a validator
To add a validator to a transition, edit the workflow that contains the transition, select the transition, then clickValidatorsin the properties panel for the transition.
On theValidatorstab, yous can see whatsoever validators that have already been set.
When y'all cllckAdd together validator y'all tin can choose from the available validators and prepare whatever necessary parameters for the validator.
Note that you lot can likewise edit the transition in 'text' mode.
Post functions
Postal service functions behave out whatsoever additional processing required after a transition is executed, such equally:
- updating an issue'due south fields
- generating change history for an issue
- adding a comment to an issue
- generating an event to trigger electronic mail notifications
The following sections describe:
- Essential post functions
- Optional post functions
- Using postal service functions with the initial transition
- Using a mail service function to fix a field
- Using a mail role to send HipChat notifications
- Using a post function to send e-mail notifications
Essential post functions
Every Jira transition has the following essential post functions, which are performed in this order:
- Set issue status to the linked status of the destination workflow status.
- Add a annotate to an upshot if one is entered during a transition.
- Update alter history for an issue and store the outcome in the database.
- Reindex an outcome to keep indices in sync with the database.
- Fire an effect that can be processed past the listeners.
These essential mail functions cannot be deleted from a transition or reordered. However, you can insert other (optional) mail functions between them.
Optional post functions
Jira includes several optional mail functions that can be added to transitions.
Additional post functions may be bachelor from installed apps. or you can create your ain postal service functions using the app system; see the Workflow app Modules for details.
Calculation a postal service function
To add a post function to a transition, edit the workflow that contains the transition, select the transition, and so clickPost functions in the properties panel for the transition.
On thePost functions tab, you can encounter any post functions that take already been set. When y'all clickAdd together mail role you can choose from the available post functions, and set whatever necessary parameters. Options for editing or deleting a post function, and for irresolute the execution gild, are at the correct of the tab (hover there to see them).
Annotation that you can likewise edit the transition in 'text' mode.
Using post functions with the initial transition
You tin add post functions to a workflow'due south initial transition when you need to perform processing tasks – such as setting a particular field's value – when an result is created. The initial transition is called 'Create' (if y'all created a bare workflow) or 'Create Upshot' (if you copied the system workflow).
Jira includes the following essential mail functions that are specific to a workflow's initial transition and that are performed in this social club:
- Create the issue.
- Fire an event that tin be processed past the listeners.
The post-obit optional post functions are available specifically for the initial transition:
Optional post function (initial transition only) | Description |
---|---|
Create Annotate | Adds a annotate to an outcome if ane is entered during a transition. |
Update Issue Condition | Sets the outcome's condition to the linked condition of the destination workflow status. |
Store Upshot | Stores updates to an issue (no change history is created). |
Additionally, the standard optional post functions tin too be added to an initial transition,
Optional post functions added to the Create transition must be placed before the 'Create the result originally' mail service function.
If yous wish, you lot can configure the initial status for your workflow to go to a different initial transition. See Configuring the initial status for details.
Notes
If you lot need to set the 'Resolution' field when creating an event, add the 'Update Event Field' post part after the 'Create the issue' postal service office and after that, use the 'Store Upshot' postal service function. The 'Store Result' post office is useful for setting the Resolution field during issue creation.
However, only use the Store Issue post function where necessary, since it:
- does not generate change history
- is unable to persist fields that accept a one-to-many human relationship with the issue (for example, 'Version' or 'Component')
Using a mail office to set a field
You can use the 'Update Issue Field' post part to set the value of an issue'southward field later a particular transition is executed.
For example, you might want a transition that moves the issue to a airtight status to automatically set the 'Resolution' field.
Example: Using a post office to fix the Resolution field:
-
Edit the workflow that has the transition, and drag from status to some other to create a new transition.
- Select either None or a screen that does not contain the Resolution field:
- Add a new post function of type 'Update Result Field' and:
- Select Resolution from theResult Field list.
- Select a suitable resolution from the Field Value list.
To create a transition that clears the Resolution field, follow the same steps higher up for adding an 'Update Issue Field' post function to your transition. All the same, select None from the Field Value list.
The list of postal service functions for this transition includes the following argument:
- The Resolution of the event will be cleared.
Each time one of these transitions is executed, the Resolution of the result is automatically set or cleared, equally specified in these post functions.
Using a post office to ship HipChat notifications
You can use a 'Notify HipChat' post part to send a notification to one or more HipChat rooms whenever an consequence passes through a transition with this postal service function. You lot tin can likewise add a JQL query to the 'Notify Hipchat' postal service part to filter for the bug that will trigger the HipChat notification.
To send HipChat notifications:
- Create or edit your transition.
- Add a new mail office of type 'Notify HipChat'.
- On the 'Add Parameters to Function' page:
- Optionally, specify a JQL query. Only issues that lucifer the query will send notifications.
Leave this field empty to send notifications to all problems that pass through this transition. - Select the HipChat rooms you want to link with your workflow transition.
- Optionally, specify a JQL query. Only issues that lucifer the query will send notifications.
Using a post function to send e-mail notifications
Utilize the 'Fire an event that can be candy past the listeners' postal service part to fire the 'Generic Event', which is a built-in Jira event that tin can be used to trigger the sending of e-mail notifications after a particular transition is executed.
Alternatively, yous could burn a custom issue that you've created specifically for this transition.
When a transition is performed, Jira will:
- Look upwards the notification scheme associated with the issue'south project and identify the users associated with the fired outcome;
- Send an email notification to each user.
The fired upshot is also propagated to all registered listeners.
Example: Using a mail office to burn down the Generic Event to send electronic mail notifications:
- Create or edit your transition.
- Click the transition's Post Functions tab and edit the 'Fire an event that tin can exist processed by the listeners' post function.
-
Select Generic Event from the list of events.
Transition properties
Properties are key-value pairs that tin can be used to further customize transitions. For example, transition properties can help to extend a copiedarrangement workflow to let linguistic communication translations.
To view and edit the properties of a transition:
- Select a transition in the diagram.
- ClickProperties in the Properties panel.
- Either:
- Add a new holding to the transition.
- Delete a property, by clicking the icon to the correct of the property.
Important
It is not possible to edit a transition'southward properties on this page. To change any property's key or value (or both), you lot must first delete the holding you wish to change and add the new updated property.
Note that you can also edit the transition in 'text' fashion.
It is possible to implement restrictions on transitions using transition properties. For more information, come across Workflow properties.
Customize how transitions announced
When viewing an event, most of the operations and workflow transitions are available from a row of buttons at the pinnacle of the effect.
To change the number of transition buttons from the default of ii:
By default, the first two transitions announced equally separate buttons in the set of transition buttons. Additional transitions appear in theWorkflow card. The society in which these buttons announced is based on the club defined in thearrangement workflow.
- Shutdown Jira.
- Edit the
jira-config.backdrop
file in your Jira application home directory. Come acrossMaking changes to thejira-config.properties
file for more information. - Change the value of '
X
' in theops.bar.group.size.opsbar-transitions = 10
property of this file to be the number of transition buttons requiredearliertheWorkflow menu.
If this belongings does not exist in yourjira-config.properties
file, add it. Otherwise, a default value of 2 is assumed. - Save the updated
jira-config.properties
file. - Restart Jira.
To modify the order of transition buttons:
To change the social club of transition buttons, including additional transitions in theWorkflow menu, add the property keyopsbar-sequence
to each workflow transition that you wish to reorder. Eachopsbar-sequence
property key requires a property value that defines the order of the transition activity on issue views.
- Go to the transition's properties, as described in Transition properties in a higher place.
- Blazon
opsbar-sequence
into theProperty Key field, under 'Add together New Belongings'. - Type a value In theBelongings Value field, The value must exist a positive integer (starting at '0'); it defines the lodge of the transition buttons on issue views.
Consider using a sequence ofopsbar-sequence
property values similar 10, 20, 30... to allow new transitions to be hands added after. - ClickAdd.
Adding theopsbar-sequence
property to a workflow transition does not change the order of these transitions in the workflow in Text edit mode. The improver of this property but affects the order of transitions on the View upshotpage.
Global transitions
Global transitions allow any status in a workflow to transition to a particular status.
You tin can add a global transition:
- When creating a new status (calculation an existing status) – check the Add global transition to status selection.
- By selecting a status and checkingPermit all statuses to transition to this one in the properties console for the status.
To create ii global transitions that point to the same destination step:
- From the workflow designer, create the showtime global transition every bit normal by selecting a stride and checking "Let all statuses to transition to this i"
- Create the second global transition on anyother pace that does non currently have a global transition pointing to it
- Then from text editor, select the 2d global transition that you created
- Click on the 'Edit' push button and change the 'Destination Step' to the same pace that you selected for your first global transition, and then click 'Update'
How To Revert Workflow Changes In Jira,
Source: https://confluence.atlassian.com/adminjiraserver0813/advanced-workflow-configuration-1027138145.html
Posted by: thorntontues1985.blogspot.com
0 Response to "How To Revert Workflow Changes In Jira"
Post a Comment