Skip to end of banner
Go to start of banner

Display Message to User

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

A workflow post-function that displays a message on the issue view page to the user triggering the transition. 

The displayed message can be customized using the options (explained below) in the post-function configuration. Here is a sample message on the new issue view. 

This will not work on Jira Software boards nor Jira Service Desk customer portals

To add 'Display Message to User' post function to a transition: 

  1. Click Edit for the workflow that has the transition, you wish to add the post-function on.

  2. In the Workflow Designer, select the transition.

  3. Click on Post Functions in the properties panel.

  4. Click on Add post function.

  5. Select Display Message to User from the list of post-functions.

  6. Click on Add to add the post-function on the transition.

  7. Input a Message title and Message body. To input issue or transition or currentUser information see, Using Nunjucks Templates.

  8. Click on Add to add the post-function to the transition.

See here for a use case for a post-function.

You are viewing the documentation for Jira Cloud.

On This Page

JMWE shows an error message on the issue view if any error occurs during the execution of the post-function. This message is displayed only if the current user is a Jira administrator. 

When you add this post-function to a transition and trigger the transition, a message is displayed to the user triggering the transaction, as a “flag” in the top right corner of the issue view page. You can also use Nunjucks annotations to insert issue, transition, and current user information into the Message body and Action type, using the 'issue', 'transition' and 'currentUser' variables, respectively. You can customize the post-function using the following options:

Options

Message type: Select the type of message box ("flag") to display. It can be one of "Info", "Success", "Warning" and "Error".

Auto close: Select this option if you want the message box to disappear automatically after a few seconds.

You can add an action link to the message which, when clicked, can navigate to another issue or to an arbitrary URL. To add an action link, select the "Add action link" checkbox:

  • Action title: Input the title of the action link that will be displayed at the bottom of the message.

  • Action type: Select the type of action to be performed.

    • Navigate to URL: Input a text that represents a valid URL or a Nunjucks template that returns a valid URL. For example: 

      https://www.innovalog.com

    • Navigate to another issue: Input a valid issue key or a Nunjucks template that returns an issue key. For example:

      TEST-1

      {{ issue.fields.parent.key }}

Conditional execution

To execute this post-function based on the result of a Nunjucks template see Conditional execution.

Delayed execution

Post functions are provided with an option to delay execution for a set number of seconds using the Delayed execution option (Figure 1, right). To delay execution, select the number of seconds to wait until the post-function is run; any value between 1 second (the default) up to a maximum of 20 seconds can be selected.

Workflows that depend on post functions being executed in a specific order can fail due to the asynchronous nature of Connect post-functions in Jira Cloud. One workaround is to delay the execution of a post-function, thereby creating a more predictable execution order. For example, on the approval of a Story you want to create sub-tasks and immediately transition them; in this case, you will have to delay the execution of the Transition Linked Issues post-function, so that the sub-tasks are created before they are transitioned. See the sample use case, below.

Where possible, it is recommended to use the Sequence of post-functions post-function or Shared action post-function to execute a series of post-functions in a specific sequence instead of applying a delay.

  • No labels