Notification Templates

Accessing the Notification Template section

Click the from the top menu and choose Issues from the dropdown list.
Select 'Notification Template' from the left menu.

Alternatively you can press '.' to show the quick search dialog and type 'Notification Templates' and hit <enter> to go to this menu.
Next, you will see the following screen:

In the first tab (Templates library) you will fond you some built-it templates. These templates could help you by the time you create a new template.

In the second tab (User made templates) you will find the templates you have created for using in your notifications.

On this page

Please be aware that you need a JIRA administrator account before you can perform the tasks mentioned on this page!

Create your first template

To create a new template, simply press the button located at the top of the page. In the next screen you will see a form to edit your new template.

You can also click in the Copy link in any of the templates in the Templates library. In this case a new template will be created and placed in the User made templates tab. Go there to edit it

Make sure to fill out the template's name, subject and add content to the HTML editor. If you wish to add any dynamic variables click the at the top of the page to get more help on what variables you can include or check the documentation.

Add fields and custom fields to the template

TemplateMe! allows you to easily add fields and custom fields to your template. Just click in the "View issue fields" to make TemplateMe! shows you all the availeble issue fields and custom fields. To add a given field just click in it and TemplateMe will add it to your template (using the custom field id).

Also TemplateMe! has an autocomplete feature. In the editor just click $ and let the editor show you your options:

When finished click the button to save your template.

NotifyMe! Integration

If you have also installed the NotifyMe! add-on and want to TemplateMe! to display the text of the email in any place of your template, then simply add the $!notifymeHtml variable to your template.

Send a preview email

If you want to see how look your template using a real example you can click the Preview button. In the next screen select a existing issue and an user to send a preview email.

Delete, Edit or Copy a Template

After you have created a template, it will appear in the list of User made templates. At the right hand side of each template you can select any of the actions available. You can edit, copy or delete a template.

Templates that are part of a Notification Scheme cannot be deleted. Default Templates that were added by the add-on can't be deleted either.

Available variables

When creating your templates you can use the following variables. These variables will be replace on the fly when sending notifications. TemplateMe! uses velocity templates in order to render the email content. You can know more about Velocity here.

Variable	Description
$!issue	The whole Jira issue. You can access al methods and properties of the issue. Example: $!issue.reporter.emailAddress
$!event	The notification event. Example: $!event.eventTypeId
$!user	The user that triggered the notification. Example: $!user.emailAddress
$!project	The issue's project. Example: $!project.key
$!comments	The Comment objects. Example: #foreach ($c in $!comments) c.body #end
$!baseurl	Jira base url. Useful for constructing url and links Example: $!baseurl/projects/$project.key/issues/$issue.key Renders like http://myjira.com/projects/projects/BNB/issues/BNB-143
$!currentTimestamp	The current date time Example: This email was sent $!currentTimeStamp Renders like Wed Aug 01 09:22:46 CEST 2018
$!dateTimeFormatter	Date formatter. Example: $!dateTimeFormatter.format($issue.created) Renders like 23/jul/18 1:19 PM
$!lastComment	Last Comment object Example: $!lastComment.authorFullName
$!lastCommentText	Text of the last comment Example: $!lastCommentText
$!lastCommentHtml	Html styled content of the last comment Example: $!lastCommentHtml
$!lastCommentAuthor	Full name of the last comment Example: $!lastCommentAuthor
$!issueType	Name of the issue type Example: $!issueType
$!issueDescHtml	Html styled description of the issue Example: $!issueDescHtml
$issueManager	Use the Atlassian's IssueManager class. Example: $issueManager.getIssue($!customfield_10200).summary

How to insert complex code

Don't use the editor directly to insert complex code (for example a few lines of code). The editor will add invisible html characters and this will wreck the template.

If you want to add a few lines of code please use the Source code screen (Tools > Source code) to insert the code you want.