Display message to user

 

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

To add the 'Display message to user" post-function to a transition:

  1. Click Edit for the workflow that has the transition you wish to configure 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 Post-function from the list of post-functions.

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

  7. Input a text optionally including Groovy template markup in the “Message title”

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

 

 

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 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", and it will control the icon displayed in front of the message.

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 Groovy expression that returns a valid URL. For example: 

      1 https://www.innovalog.com
    • Navigate to another issue: Input a Groovy expression that returns an issue key. For example:

      1 "TEST-1"
    • When user clicks: Select this option to open the link or issue in a new window/tab

Conditional execution

Input a Groovy expression that returns true if the post-function should run. For more information see Conditional execution using Groovy expression

Error Handling

By default, all errors (Java Exceptions) raised by this post-function, including those raised by custom Groovy scripts, will be logged in the JIRA log file but will not be reported to the user and will not prevent the transition from completing. However, when designing new workflows or troubleshooting them, it is more convenient to be notified immediately of any such error during the execution of the transition. For example, on the production Jira instances, you might want to show errors only for the post-function(s) being worked on, in order to avoid disrupting other workflows. To make errors raised by the current post-function prevent the transition from completing and show the error in the browser, select Make transition fail when an error occurs in this post-function.

If you want to show all the errors, either only to the admins or to all users, configure the option globally on the JMWE configuration page. For example, on development and staging Jira instances, you can activate error reporting for all JMWE post-functions, to display all the errors and it is recommended to do so, and on production Jira instances you might want to activate error reporting only to administrators so that they can be made aware of configuration errors.

When the option is selected on a post-function, it overrides the configuration on the JMWE configuration page.