E.g.
Returns an absolute link to the customer portal belonging to the service management project of the issue.
Returns an absolute link to the issue in the customer portal belonging to the service management project of the issue.
$!jetiFieldFormatter.formatSafely($!formatter, $issue.getCustomFieldValue("customfield\_12345"))
|
| TimeZone getTimeZone(String tzID) | Returns the [TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) matching the id. TimeZone can be set in the Java date time formatters created above | $!formatter.setTimeZone($jetiFieldFormatter.getTimeZone("America/Los\_Angeles")) |
| TimeZone getDefaultTimeZone() | Returns the default [TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) in Jira. | |
| String\[] getAvailableTimeZoneIDs() | Returns all time zone IDs available in Jira. | |
* [DateTimeFormatter ](https://docs.atlassian.com/software/jira/docs/api/latest/com/atlassian/jira/datetime/DateTimeFormatter.html)is part of the Jira API
* [DateFormat ](http://docs.oracle.com/javase/7/docs/api/java/text/DateFormat.html)is a standard way to format dates in Java
## templateSupport
| Method | Description | Usage |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| String `encodeUrl(String url);` | Calls [URLEncoder.encode(url)](https://docs.oracle.com/javase/7/docs/api/java/net/URLEncoder.html) to encode rendered URLs in email templates using UTF-8 encoding | $!templateSupport.encodeUrl($urlVariable) |
| String `encodeUrl(String url, String encoding);` | Calls [URLEncoder.encode(url, encoding)](https://docs.oracle.com/javase/7/docs/api/java/net/URLEncoder.html) to encode rendered URLs in email templates using the encoding specified | $!templateSupport.encodeUrl($urlVariable, \) |
| boolean `issueMatchesJQL(String jqlQuery, Issue issue);` | Checks if the given issue matches the JQL query | #if($!templateSupport.issueMatchesJQL("mycustomfield = somevalue AND component=ImportantComponent", $!issue)
## do something...
#end
|
| I18nHelper `getI18nHelper(String localeName);` | Create an I18nHelper object for the locale
Local name is composed of language code and country code.
e.g. "fr" is for french language, while "fr\_FR" is the french spoken in France.
| #set($i18nFrench = $!templateSupport.getI18nHelper("fr\_FR") |
| I18nHelper `getI18nHelper(Locale locale);` | Create an I18nHelper object for the locale
Local name is composed of language code and country code.
e.g. "fr" is for french language, while "fr\_FR" is the french spoken in France.
| #set($frenchLocale = $!templateSupport.getLocale("fr\_FR")
#set($i18nFrench = $!templateSupport.getI18nHelper($frenchLocale)
|
| Locale `getLocale(String localeName);` | Creates a Java Locale object to be used in date / number formatting or language support.
Local name is composed of language code and country code.
e.g. "fr" is for the French language, while "fr\_FR" is the French spoken in France.
| #set($frenchLocale = $!templateSupport.getLocale("fr\_FR") |
| boolean `isAgent(ApplicationUser applicationUser, Project project);` | Determines if the given use is an Service Management Agent in the given project. | #if($!templateSupport.isAgent($!issue.reporter, $!issue.projectObject)
...
#end
|
| boolean `isInternalComment(Comment comment);` | Determines if the give comment is an Service Management Internal comment in the current issue. | #if($!templateSupport.isInternalComment($!comment))
...
#end
|
| TemplateIssueSearchResults `searchForIssuesByJQL(String jql);` | Returns a list of issues matching the given JQL query. | #set($searchResults = $!templateSupport.searchForIssuesByJQL("project=IT AND resolution=Unresolved", 10))
#foreach($result in $searchResults.getResults())
$velocityCount - $!result.key (comments: $!result.comments.size())
#end
|
| String `getCustomerVisibleStatus(Issue issue);` | Returns the Customer Visible Status name of the issue in a Service Management project. | #set($!customerVisibleStatus = $!templateSupport.getCustomerVisibleStatus($!issue) |
| Issue `firstIssueMatchingJQL(String jql);` | Returns the first issue that matches the given JQL query. | #set($firtstIssue = $!templateSupport.firstIssueMatchingJQL("project = $issue.projectObject.key AND assignee=$!currentUser.name AND priority = Highest"))
$!firstIssue.summary
|
| String getParentValueFromCascadingSelectFieldValue(Map cascadeSelectFieldValue);
String getChildValueFromCascadingSelectFieldValue(Map cascadeSelectFieldValue);
| Returns the parent or child value of a Cascade Select custom field. | #set($parentValue = $!templateSupport.getParentValueFromCascadingSelectFieldValue($!issue.getCustomFieldValue("customfield\_12345"))
#set($childValue = $!templateSupport.getChildValueFromCascadingSelectFieldValue($!issue.getCustomFieldValue("customfield\_12345"))
customfield\_12345 is the key of a cascade select field
|
| `String getCurrentUsersTimeZoneId()` | Returns the time zone id set in the current user’s profile. | The issue was updated at #renderDateTime($!issue.updated "yyyy-MM-dd'T'HH:mmZ'\['z']'" $!templateSupport.currentUsersTimeZoneId)
Please note that the capital letter T in the above code is just a placeholder, an example to mark that after the date, the time value comes next.
|
| `TemplateIssueSearchResults searchForIssuesByJQL(String jql, int maxresults);` | Same as above, but limits the results to the given number of issues. | |
## Template macros
| Macro signature | Parameters | Description | Example |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| #escapeHtml($value) | - $value: the value with HTML that should be escaped
| Escapes the HTML in a given value, therefore it will be displayed as text. | #escapeHtml("\Sample html\
") |
| #renderVersions($versions) | - $versions: the list of versions to render
| Renders the versions. | #renderVersions($!issue.fixVersions) |
| #renderComments($issue) | - $issue: the issue whose comments are to be rendered
| Renders the public comments of the issue. | #renderComments($!issue) |
| #renderCommentsInReverseOrder($issue) | - $comments: the issue whose comments are to be rendered
| Renders the public comments os the issue in reverse order. | #renderCommentsInReverseOrder($!issue) |
| #renderCurrentCommentIfPublic() |
| Renders the current comment if it is public. | #renderCurrentCommentIfPublic() |
| #renderServiceDeskPublicComments($issue) | - $issue: the issue whose comments are to be rendered
| Renders the public comments of the issue. | #renderServiceDeskPublicComments($!issue) |
| #renderServiceDeskInternalComments($issue) | - $issue: the issue whose comments are to be rendered
| Renders the internal comments of the issue. | #renderServiceDeskInternalComments($!issue) |
| #renderAllComments($issue) | - $issue: the issue whose comments are to be rendered
| Renders both public and internal comments of the issue. | #renderAllComments($!issue) |
| #renderLastComment($issue) | - $issue: the issue whose last comment is to be rendered
| Renders the last comment of the issue. | #renderLastComment($!issue) |
| #renderCurrentComment() |
| Renders the current comment. | #renderCurrentComment() |
| #renderComment() |
| Renders the current comment. | #renderComment() |
| #renderComponents($issue) | - $issue: the issue whose components are to be rendered
| Renders the components of the issue. | #renderComponents($!issue) |
| #renderDateTime($dateTimeValue $pattern $timezoneId) | - $dateTimeValue: the value to be formatted
- $pattern: the pattern describing the date and time format. You can find description about formatting and patterns here
- $timezoneId: the time zone used for formatting. You can find a list in the Supported Time Zones Appendix
| Formats a date-time field based on the pattern and the timezone. | #renderDateTime($!issue.created "dd MMM yyyy hh:mm a" "Australia/West") |
| #renderDate($dateValue $pattern $timezoneId) | - $dateValue: the value to be formatted
- $pattern: the pattern describing the date format. You can find description about formatting and patterns here
- $timezoneId: the time zone used for formatting. You can find a list in the Supported Time Zones Appendix
| Formats a date field based on the pattern and the timezone. | #renderDate($!issue.created "dd MMM yyyy" "Australia/West") |
| #renderLabels($issue) | - $issue: the issue whose labels are to be rendered
| Renders the labels of the issue. | #renderLabels($!issue) |
| #renderList($listitems) | - $listitems: the list of items to be rendered
| Renders the items into a bullet list. | #renderList($!issue.affectedVersions) |
| #renderFlatList($listitems) | - $listitems: the list of items to be rendered
| Renders the items into a comma-separated list. | #renderFlatList($!issue.affectedVersions) |
| #renderProject($issue) | - $issue: the issue whose project name is to be rendered
| Renders the project name of the issue. | #renderProject($!issue) |
| #renderDescription($issue) | - $issue: the issue whose description is to be rendered
| Renders the description of the issue. | #renderDescription($!issue) |
| #renderEnvironment($issue) | - $issue: the issue whose Environment field is to be rendered
| Renders the value of the Environment field from the issue. | #renderEnvironment($!issue) |
| #renderIssueType($issue) | - $issue: the issue whose type is to be rendered
| Renders the type of the issue. | #renderIssueType($!issue) |
| #renderCustomerVisibleStatus($issue) | - $issue: the issue whose status is to be rendered
| Renders the status of the issue that is visible to the customer. | #renderCustomerVisibleStatus($!issue) |
| #renderStatus($issue) | - $issue: the issue whose status is to be rendered
| Renders the status of the issue. | #renderStatus($!issue) |
| #renderPriority($issue) | - $issue: the issue whose priority is to be rendered
| Renders the priority of the issue. | #renderPriority($!issue) |
| #renderResolution($issue) | - $issue: the issue whose resolution is to be rendered
| Renders the resolution of the issue. | #renderResolution($!issue) |
| #renderIssueConstant($issueConstant) | - $issueConstant: the value of an issue system field
| Renders the value of the issue system field. | #renderIssueConstant($!issue.status) |
| #renderOriginalEstimate($issue) | - $issue: the issue whose original estimate is to be rendered
| Renders the original estimate of the issue. | #renderOriginalEstimate($!issue) |
| #renderRemainingEstimate($issue) | - $issue: the issue whose remaining estimate is to be rendered
| Renders the remaining estimate of the issue. | #renderOriginalEstimate($!issue) |
| #renderTimeSpent($issue) | - $issue: the issue whose time spent is to be rendered
| Renders the time spent field value. | #renderOriginalEstimate($!issue) |
| #renderSummary($issue) | - $issue: the issue whose summary is to be rendered
| Renders the summary of the issue. | #renderSummary($!issue) |
| #renderUser($user) | - $user: the user to be rendered
| Renders the user. | #renderUser($!issue.assignee) |
| #renderCommentBody($commentObject) | - $commentObject: the comment whose body is to be rendered
| Renders the body of a comment. | #renderCommentBody($!comment) |
| #renderTextWithCommentRenderer($textToRender) | - $textToRender: the text that should be rendered
| Renders the given text with the comment renderer. | #renderTextWithCommentRenderer($!worklog.comment) |
| #renderCustomField($issue $customFieldKey) | - $issue: the issue whose custom field is to be rendered
- $customFieldKey: the key of the custom field
| Renders the value of a custom field. | #renderCustomField($!issue "customfield\_10006") |
| #renderAllCustomFields($issue) | - $issue: the issue whose custom fields are to be rendered
| Renders the value of all custom fields on an issue. | #renderAllCustomFields($!issue) |
| #renderWorklog($worklog) | - $worklog: the worklog entry to be rendered
| Renders a worklog entry. | #renderWorklog($!issue.worklogs.get(0)) |
| #renderWorklogs($issue) | - $issue: the issue whose worklog entries are to be rendered
| Renders all worklog entries of an issue. | #renderWorklogs($!issue) |
| #renderUserProperty($user $propertyName) | - $user: the user whose property is to be rendered
- $propertyName: the name of the property to be rendered
| Renders one of the user's property. | #renderUserProperty($!issue.assignee "phone") |
| #footer() |
| Renders the Email This Issue footer. | #footer() |
| #renderLinkToCustomerPortal($issue $linkText) | - $issue: the issue whose customer portal link is to be rendered
- $linkText the text of the link
| Renders a link to the main page of the issue's customer portal. | #renderLinkToCustomerPortal($!issue "Customer Portal") |
| #renderLinkToIssueCustomerPortal($issue $linkText) | - $issue: the issue whose customer portal link is to be rendered
- $linkText the text of the link
| Renders a link that points to the issue in its customer portal. | #renderLinkToIssueCustomerPortal($!issue "Customer Portal") |
| #renderTemplate($templateId) | - $templateId: the ID of the template to be rendered
| Renders a template. | #renderTemplate(1) |
| #renderIssueComments($order $num $restriction) | | Renders the comments of an issue. | #renderIssueComments("desc" 10 "all") |
| #renderOptOutLink($linkText) | - $linkText: the text of the link
| Renders a link that customers can use to unsubscribe from notifications. | #renderOptOutLink("Unsubscribe") |
### Assets related macros
| Tex | | | |
|---|
| Macro Signature | Parameters | Description | Example |
| #renderAssetsCustomField($issue $customFieldKey $attributes $runAsUserName) | - $issue: the issue whose custom field is to be rendered
- $customFieldKey: the key of the custom field
- $attributes: Optional: the name of the attributes you want to include
- $runAsUserName: Optional: a custom user name used to run AQL queries. If not provided, the query runs with the permissions of the action's initiator.
| Renders all assets objects in the field with their labels and all of their attributes. The type of the field must be Assets Object. If $attributes is not provided, all attributes configured in the custom field context are rendered. $runAsUserName is introduced to provide a way to run AQL queries with more controlled permissions | #renderAssetsCustomField($!issue "customfield_10006") With custom attributes:
#renderAssetsCustomField($!issue "customfield_10006", ["Created", "Asset Status"]) With runAsUserName, without custom attributes:
#renderAssetsCustomField($!issue "customfield_10006", $null, "assetsViewUser") |
| #renderAssetsCustomFieldAttribute($issue $customFieldKey $attributeName $runAsUserName) | - $issue: the issue in the context
$customFieldKey
- key of the custom field(eg. customfield_10001)
- The type of the field must be Assets Object
- $attributeName: the name of the attribute
- $runAsUserName: Optional: a custom user name used to run AQL queries. If not provided, the query runs with the permissions of the action's initiator.
| Renders only the value of the attribute, which name was given by the attributeName parameter. | Render asset attribute:
#renderAssetsCustomFieldAttribute($!issue, 'customfield_10093', 'Name') With runAsUserName:
#renderAssetsCustomFieldAttribute($!issue, 'customfield_10093', 'Name', 'assetsViewUser') |
| #renderAssets($aql $attributes $limit) | - $aql: search query in Assets Query Language
- $attributes:
Optional: the attributes to display (used the same way as in the #renderAssetsCustomField macro).
- $limit:
Optional: the maximum number of Assets Objects to display. Default: 10 Maximum: 100
| Renders the labels and attributes of Assets Objects returned by the given AQL query. | Render assets with the default limit and all attributes: #renderAssets('objectId IN (1, 2, 3)') Render assets with custom limit and all attributes: #renderAssets('objectId IN (1, 2, 3)', $null, 25) |
| #renderAssetsLabel($aql $limit) | - $aql: search query in Assets Query Language
- $limit:
Optional: the maximum number of Assets object to display. Default: 10 Maximum: 100
| Renders the labels of Assets Objects returned by the given AQL query. | #renderAssetsLabel('objectId IN (1, 2, 3)', 5) |
| #rawAssetsCustomFieldAttribute($issue $customFieldKey $attributeName $delimiter $runAsUserName) | - $delimiter:
Optional: the delimiter to use when separating attribute values for multi-valued attributes. By default values are separated by commas.
Other parameters are the same as parameters of renderAssetsCustomFieldAttribute
| Displays the values of the given attribute without formatting. You can use this macro if you want to use your own formatting. | Display attribute value, use default delimiter (comma) for multi-valued attributes:
#rawAssetsCustomFieldAttribute($!issue, 'customfield_10093', 'Name') Display attribute value, use custom delimiter (semicolon) for multi-valued attributes:
#rawAssetsCustomFieldAttribute($!issue, 'customfield_10093', 'Name', ';') |
It is possible to render only the object names from an Assets field by using the `#renderCustomField($issue $customFieldKey)` macro.