Notification Parameters

Owned by Derya Özdemir
Last updated: Oct 25, 2023
2 min read

This page is about Time to SLA for Jira On-Prem. Using Jira Cloud? Click the Cloud button above.

TTS offers a flexible way of creating dynamic email content. On this page, we will list the potential parameters you can use, and give you some handy tips.

Parameter

Type

Description

Parameter

Type

Description

${slaDescription}

String

Name of the SLA

${dateTool}

DateTool

DateTool can be used to format dates. (v7.7.0+)

Example:

$dateTool.format('d-M-yyyy H:m:s', ${issue.getCustomFieldValue($customFieldManager.getCustomFieldObject('customfield_11201'))})

${dateTimeFormatter}

DateTimeFormatter

DateTimeFormatter can be used to format dates with predefined formats in Jira. (v7.7.0+)

Example

$dateTimeFormatter.formatDMYHMS(${issue.getCustomFieldValue($customFieldManager.getCustomFieldObject

('customfield_11201'))})$dateTimeFormatter.format(${issue.getCustomFieldValue(

$customFieldManager.getCustomFieldObject('customfield_11201'))})

${slaValue}

String

SLA value as a time string

${slaStartDate}

String

Start time of the SLA

${slaEndDate}

String

End time of the SLA

${slaNotifyBefore}

String

Notify before the parameter in notification settings

${originStatus}

String

Origin status name, null if origin is not set by status

${targetStatus}

String

Target status name, null if target is not set by status

${slaExceeded}

Boolean

Indicates whether or not SLA is exceeded (v7.1.0+)

Example:

#if(${slaExceeded})You missed SLA deadline#end

${slaRemainingTime}

String

Remaining duration of SLA (i.e. 1h 30m) (v7.1.0+)

${slaOverdue}

String

Overdue duration of SLA (i.e. 1d 10h) (v7.1.0+)

${issue}

Issue

Issue object to retrieve various issue attributes (e.g. ${issue.summary} )

${customFieldManager}

CustomFieldManager

CustomFieldManager could be used to insert custom field values into e-mail text

Example:

${issue.getCustomFieldValue($customFieldManager.getCustomFieldObject('customfield_11100'))}

${issue.priority.name}

String

Get priority information

${baseUrl}/browse/${issue.key}

String

Get link information

${issue.getAssigneeUser().getDisplayName()}

String

The display name of the user assigned to the issue

${issue.getDueDate()}

Date

The due date assigned to the issue, if any.

${issue.created}

Date

The date and time when the issue was created

${issue.fields.project.name}

String

The name of the project associated with the issue

${issue.status.getName().toString()}

String

The name of the current status of the issue

${issue.description.toString()}

String

The description of the issue

${issue.fields.summary}

String

The summary of the issue

${issue.fields.reporter.displayName}

String

The display name of the user who reported the issue

Tip for Template Variables:

In some cases, custom fields or other fields on the issue may have a null value, resulting in variable names being displayed in email content.To prevent this, put an ! after $ sign on a variable name like this:

$!{issue.getCustomFieldValue($customFieldManager.getCustomFieldObject('customfield_11100'))}

How can I format dates with a custom time zone?

You can change the time zone of the dateTimeFormatter provided in the notifier context.

1. Copy the following code block into your notifier content:

#set( $tz = $dateTool.getTimeZone().getTimeZone("IST"))

#set( $zonedFormatter = $dateTimeFormatter.withZone($tz))  

#set( $date = $issue.created)

Created Date: ${zonedFormatter.format($date)}<br>

2. Change IST with any time zone you would like to apply. Find a list of all available time zones here.

3. Change $date with any date you would like to format. 

4. You can also apply custom time formats with zonedFormatter as usual.

Advanced Tip:

You can use loops, if/else conditions, and other Velocity templating engine features in Time to SLA notifier templates. More information can be found in the official Velocity guide.

Here is an example of how you can iterate over the selected users in a multiple user picker custom field and display their real names:

#set( $users = $!{issue.getCustomFieldValue($customFieldManager.getCustomFieldObject('customfield_10300'))})
 
Custom Field (Multiple user picker):
#foreach( $user in $users )
  $user.displayName#if( $velocityHasNext ),#end
#end