Versions Compared

Version Old Version 19 New Version 20
Changes made by

Antonio Dionisio

Antonio Dionisio

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Accessing the Notification Template section

  1. Click the  from the top menu and choose Issues from the dropdown list. 

  2. Select  'Notification Template' from the left menu.

    Info

    Alternatively you can press '.' to show the quick search dialog and type 'Notification Templates' and hit <enter> to go to this menu.


  3. Next, you will see the following screen:

     
    Note that TemplateMe! offers you some built-it templates, this templates could help you by the time you create a new template.


Info
titleOn this page

Table of Contents
 


Warning

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


Excerpt
hiddentrue

Read this page if you want to get started with your first template or want to add additional templates.


Create your first template

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


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 (question) at the top of the page to get more help on what variables you can include.

When finished click the "Save" button to save your template.

Info
titleNotifyMe! Integration

If you have also installed the NotifyMe! add-on and want to TemplateMe! to display the content generated  by this add-on, 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 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.

Note
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.

VariableDescription
$!issue

The whole Jira issue. You can access al methods and properties of the issue.

Example:

Code Block
$!issue.reporter.emailAddress


$!event

The notification event.

Example:

Code Block
$!event.eventTypeId


$!user

The user that triggered the notification.

Example:

Code Block
$!user.emailAddress


$!project

The issue's project.

Example:

Code Block
$!project.key



$!comments

The Comment objects.

Example:

Code Block
#for ($c in $!comments)
	c.body
#end



$!baseurl

Jira base url. Useful for constructing url and links

Example:

Code Block
"$!baseurl/projects/$project.key/issues/$issue.key"


$!dateTimeFormatter

Date formatter.

Example: 

Code Block
$!dateTimeFormatter.format($!currentTimestamp)


$!lastComment

Last Comment object

Example:

Code Block
$!lastComment.authorFullName


$!lastCommentText

Text of the last comment

Example:

Code Block
$!lastCommentText


$!lastCommentHtml

Html styled content of the last comment

Example:

Code Block
$!lastCommentHtml


$!lastCommentAuthor

Full name of the last comment

Example:

Code Block
$!lastCommentAuthor


$!issueType

Name of the issue type

Example:

Code Block
$!issueType


$!issueDescHtml

Html styled description of the issue

Example:

Code Block
$!issueDescHtml