Table of Contents
Find the Notification Assistant
Login to JIRA with administrative rights and locate the Notification Assistant:
Choose "Administration/Add-ons"
Locate the plugin at the left side:
Set up your first notification
You will see the start screen of the Notification Assistant.
Click on "Add Notification"
Configure your notification
Enter the values that should be valid for your notification.
The attributes
| Attribute | Description |
|---|---|
| Notification Name | Give your notification a descriptive name, ie. "Remind assignees 24 hours prior to due date". Can not be equal to another notification name. |
| Description | Give your notification a description to remeber the purpose of the notification. |
| Threshold to fire | You can specify a threshold for the minimum number of issues in the JQL-query result. When reached, it will trigger the notification to fire. |
| Restrict issue trigger | Restrict the number of times a specific issue should trigger a notification in reoccurring result sets. The delta between result sets will always trigger a notification. |
| JQL Expression | You can specify any JQL Expression to be the reason to fire the notification. |
| Email Template | You have to specify the email template for this notification. The email template "Default Email Template" is the default value. |
| Recipient type People | You can specify recipients with certain attributes in the result set to receive notifications. You can configure Assignee, Reporter, Watchers and Voters. |
| Recipient type Users | You can select one or more JIRA users to be the receive notifications. |
| Recipient type Groups | You can select one or more JIRA groups to be the receive notifications. |
| Recipient type Custom Field | You can choose a custom field of type "Text Field", "User Picker", "Multi User Picker", "Multi Group Picker" or the third party "NFeed Users" to be the recipients. The custom field of type "Text Field" needs to be populated with one or many valid comma separated email addresses for notifications to be sent. You can add custom fields in the administration menu "Issues / Fields". |
| Recipient type Email address | You can specify one or many email addresses to be the recipient. It can even be an address not registered in JIRA. |
| Recipient type CC Email address | You can specify one or many email addresses to get a carbon copy notification email. It can even be an address not registered in JIRA. |
Trigger Configuration
| Here is were you determine when the notification should fire and in which interval. You can only use one type of trigger configuration for each notification. Select the configuration you want (active tab), the rest of the tabs will be ignored. Trigger by Event If you choose trigger by events, in some cases (like "closed" event) make sure you have set the JIRA event in the post function within the transition. |
Send Configuration
| Here is where you specify the email template and some more optional way of notifications.
You are able to notify a specific HipChat room.
Maybe you want to automatically post a comment to the issues found in the result set?
You are able to call a REST-API in this way. You can use placeholders in the posted data to be able to send data depending on the issues reflecting this notification.
|
Your configured notifications
You can now see your configured notifications in this screen.
You can choose to configure, copy, delete or execute them right away.
Note that notifications that is configured to use the Event trigger configuration cannot be executed right away since they are event driven.
You are able to click the "info"-button to get a detailed information about the notification:
Set up your own Email Template
The Notification Assistant for JIRA is initially configured with an email template that looks like the JIRA native email template. You can now create your own email templates that can be configured with the specific JIRA fields you like.
The Notification Assistant supports most of the internal JIRA fields as well as custom field types such as:
| Date Picker | Multi Group Picker | Radio Buttons |
| Date Time | Multi Select | Select |
| Free Text Field | Multi User Picker | Single Version Picker |
| Group Picker | Multi Version Picker | Textfield |
| Labels | Number Field | URL Field |
| Multi Checkbox | Project Picker | User Picker |
| Readonly Text | Insight Object (3rd party plugin) | CCC Last Comment (3rd party plugin) |
Nfeed Customfields (3rd party plugin) | Multi Cascading Select (3rd party plugin) | Tempo Account ID (3rd party plugin) |
Click on "Add Email Template"
This is the configuration screen for your email template, customise it in a way that fits your needs.
The attributes
| Attribute | Description |
|---|---|
| Email Template Name | Give your email template a descriptive name. Can not be equal to another email template name. |
| Email subject | This will be the subject of the email sent to the recipient/s. |
| Email message | Write a message that is explanatory to the receiver, they need to know why you have set up this notification and why it's important. This message will also differ all notifications from the Notification Assistant compared to native JIRA built in notifications. The message is written in a html editor which makes it possible, for example, to specify links or change the image to your own logo in the email. If you plan to send emails to remote recipients you need to make sure your logo can be accessed outside your company firewall. |
| Original field name | The original field name that are configured in this email template. |
| Email display name | The displayed field name that will be shown in the notification emails. Modify them as you like. |
| Choose Field | The input field to add new fields to the email template. |
| Include links | If there should be any links back to JIRA in the email template |
| Email footer | Specify a notification footer. The footer is written in a html editor which makes it possible, for example, to write links or change the image to your own logo in the email. If you plan to send emails to remote recipients you need to make sure your logo can be accessed outside your company firewall. |
Add details with place holders
We support several place holders to customize your email template.
| Place holder | Description |
|---|---|
| ${username} | Give you the JIRA username of the recipient. Note that this will not apply external recipients! |
| ${fullname} | Gived you the full name of the JIRA user recipient. Note that this will not apply external recipients! |
| ${summary} | Gives you the issue summary of the first issue in the email template. Handy in event mode! |
| ${key} | Gives you the issue key of the first issue in the email template. Handy in event mode! |
| ${assignee} | Gives you the issue assignee of the first issue in the email template. Handy in event mode! |
| ${issuetype} | Gives you the issue type of the first issue in the email template. Handy in event mode! |
| ${priority} | Gives you the issue priority of the first issue in the email template. Handy in event mode! |
| ${project} | Gives you the project for the issue of the first issue in the email template. Handy in event mode! |
| ${reporter} | Gives you the reporter of the first issue in the email template. Handy in event mode! |
| ${status} | Gives you the status of the first issue in the email template. Handy in event mode! |
| ${eventtype} | In event mode, you can use the event type like "updated" or "commented" in your email templates. Only available in event mode. |
| ${CFNAME} | Gives you a custom field value from a supported custom field. Replace CFNAME with the specific Custom Field Name. |
Add new fields in email template
You can simply add new fields to the email template (supports autocomplete):
Change Email display name
When placing the mouse over each row you will get a list of functions where you can edit your fields. Click on "Edit" to change the email display name.
You will see this dialogue:
You can change the display name to fit your purpose, it will then be displayed in the notification emails.
The default for "Priority" is "P" as in JIRA native email template.
Change position/ordering of the fields
You can change the order of the fields to appear in the notification emails.
Just drag and drop them in the order you want them. It can looks like this:
Your configured Email Templates
You can now see your configured email templates at the bottom of this screen.
Want to publish your notifications to HipChat?
Take a look at this page.