JMWE Configuration

 

This page lists and explains the options provided in the JMWE Configuration page of the add-on.

Error handling for JMWE post-functions

By default, all errors raised by JMWE post-function, including those raised by custom Groovy scripts are logged in the Jira log file but not reported to the user.

To display errors during the transition, select the appropriate option below:

  • Display errors that occur in a JMWE post-function and prevent the transition from completing for all users.

  • Display errors that occur in a JMWE post-function and prevent the transition from completing for admin users only. (Non-admin users will not get an error message and their transitions will complete.)

  • Do not display errors that occur in a JMWE post-function and do not prevent the transition from completing. (Note: Admin users will still see an error flag informing them that there was an error so they may troubleshoot and fix the errors.)

Transitions activity tab in issue view

JMWE provides a new Activity tab for the issue view screen. You can enable or disable it globally, or enable it conditionally using one of the options below:

  • Always show the Transitions activity tab on the issue view screen.

  • Never show the Transitions activity tab on the issue view screen.

  • Show the Transitions activity tab on the issue view screen based on a Groovy condition.

Logs Configurations

Regardless of whether the JMWE workflow extensions are executed successfully or not, the executions are logged. These logs can be helpful when troubleshooting a JMWE Extension configuration. There are a number of configurations available, including using Webhooks to send execution logs to an external system, email notifications, and log storage.

Send Notifications

Execution logs can be sent to external resources for processing using Webhooks. You can add Webhooks for failed executions and executions that generate warnings, or both.

  • Failures webhook URL - The URL for the system to which failed execution logs should be sent.

  • Warnings webhook URL - The URL for the system to which warning execution logs should be sent.

Daily/Weekly Report

Error reports can also be sent by email.

The emails sent by JMWE use the default template from Jira Email Templates.

  • Send notification - Check this box to enable email notifications.

  • Log to send - Select which executions to include in the email - Only Errors or Error and warnings.

  • Recipient Groups - Select the Jira groups to which the emails should be sent. Leave this blank to not include any Jira groups.

  • Recipients - Select individual Jira users to which the emails should be sent. Leave this blank to not include any Jira users.

  • Frequency - Select the frequency at which the emails should be sent - Daily or Weekly.

Note: When configured for Daily, emails will be sent at 00:30 AM every day.

Logs storage

You can configure the number of execution logs to be stored using the two fields provided:

  • Select the number of recent logs to store for each workflow extension.

  • Additionally, select the number of error logs to keep for each workflow extension.

You are viewing the documentation for Jira Server / Data Center.

On This Page