Versions Compared

Old Version 19

changes.mady.by.user István Verhás

Saved on

compared with

New Version 20

changes.mady.by.user István Verhás

Saved on

Key

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

Table of Contents

Email templates are velocity macro files. When email templates are used to render email body, the following Velocity context attributes are available.

...

Name
Type
Description
attachmentsManagercom.atlassian.jira.mail.util.MailAttachmentsManagerManager component
baseurlStringBase url of the Jira instance, set under General Configuration
buildutilscom.atlassian.jira.util.BuildUtils
customfieldManagercom.atlassian.jira.issue.CustomFieldManagerSupport for adding custom fields to outgoing emails
dateformattercom.atlassian.jira.web.util.OutlookDateDate format support
issuecom.atlassian.jira.mail.TemplateIssueIssue extended with support for processing in velocity templates
i18ncom.atlassian.jira.util.I18nHelperI18n support
jirakeyutilscom.atlassian.jira.util.JiraKeyUtils
jirautilscom.atlassian.jira.util.JiraUtils
remoteUsercom.atlassian.jira.user.ApplicationUserCurrent user running the action or null
rendererManagercom.atlassian.jira.issue.RendererManager
stringUtilsorg.apache.commons.lang.StringUtilsString helper methods
textutilscom.opensymphony.util.TextUtilsJira's text util methods
userutilscom.atlassian.core.user.UserUtils
jetiFieldRendererSee belowSupport for field rendering in templates. See details below.
jetiFieldFormatterSee belowSupport for date/time formatting in templates. See details below
templateSupportSee belowSupport for email templates, rendering, formatting. See details below.
numbercom.atlassian.jira.util.velocity.NumbertoolSupport for Number formatting in templates. See API documentation
currentUserInfo

$!currentUserInfo.user: current user object
$!currentUserInfo.roles: current user's project roles
$!currentUserInfo.groups: current user's groups.

userPropertyManager
 com.atlassian.jira.user.UserPropertyManager

 Access to Jira user properties. .

Usage:

Refernces to user properties by property name must be prefixed with "jira.meta." due to the nature of the Jira API.

E.g. If the user has a property, called "phone", the phone property may be rendered as

$!userPropertyManager.getPropertySet(<user object>).getString("jira.meta.phone")

currentTimestampjava.util.Date Date and time of rendering the template, this like "now". 
jiraDurationUtilscom.atlassian.jira.util.JiraDurationUtilsUtil class responsible for printing durations in various formats.
diffUtilscom.atlassian.jira.mail.DiffUtilsCompares two string values and renders wiki markup diffs.

...

MethodDescriptionUsage
String renderCustomField(Issue issue, String fieldKey);
Renders a custom field value as a string value$!jetiFieldRenderer.renderCustomField($!issue, "customfield_10011")
Object renderCustomFieldAsObject(Issue issue, String fieldKey);

Returns the value of the custom field as Raw value.

The Raw or Object value allows for further processing or access to methods, and attribues

$!jetiFieldRenderer.renderCustomFieldAsObject($!issue, "customfield_10011")

E.g. render the Display name attribute of a user selected in a user picker field

$!jetiFieldRenderer.renderCustomFieldAsObject($!issue, "customfield_10011").getDisplayName()

String renderVersions(Collection<Version> versions);
Renders the given versions as a comma-separated list of version names.E.g. $!jetiFieldRenderer.renderVersions($!issue.getFixVersions())
String renderComponents(Collection<ProjectComponent> components);
Renders the given components as a comma-separated list of component names.E.g. $!jetiFieldRenderer.renderComponents($!issue.getComponents())
String renderLabels(Collection<Label> labels);
Renders the given labels as a comma-separated list of label names.E.g. $!jetiFieldRenderer.renderLabels($!issue.getLabels())
String renderSecurityLevel(GenericValue securityLevel);
Renders the name of the given Security Level object $!jetiFieldRenderer.renderSecurityLevel($!issue.getSecurityLevel())
String renderIssueConstant(IssueConstant issueConstant);
Renders the name of an Issue type, Resolution, Priority or Status$!jetiFieldRenderer.renderIssueConstant($!issue.getPriority())
String renderUser(User user);
Renders the DisplayName attribute of a User or Application User object safely, if null, returns empty string$!jetiFieldRenderer.renderUser($!issue.getAssignee())
String renderDateTime(Timestamp ts);
Renders a Timestamp object using Jira's default date format, DateTimeFormat.format()

E.g.

  • $!jetiFieldRenderer.renderDateTime($!issue.getCreated())
  • render the value of a date or date time picker field: $!jetiFieldRenderer.renderDateTime($!jetiFieldRenderer.renderCustomFieldAsObject($!issue, "customfield_10011"))
String renderEstimate(TemplateIssue ti, I18nHelper i18n);
Renders the issue's Original estimate in nicely readable format, like 3d 4h 5m$!jetiFieldRenderer.renderEstimate($!issue, $i18n)
String renderRemainingEstimate(TemplateIssue ti, I18nHelper i18n);
Renders the issue's Remaining estimate in nicely readable format, like 3d 4h 5m$!jetiFieldRenderer.renderOriginalEstimate($!issue, $i18n)
String renderWorklog(TemplateIssue ti, I18nHelper i18n);
Renders the issue's Logged Work Time in nicely readable format, like 3d 4h 5m$!jetiFieldRenderer.renderWorklog($!issue, $i18n)
I18nHelper getI18nBean(String locale);

Returns a I18nBean for the given locale, locale string follows java syntax

E.g. get the language resources for French: $!jetiFieldRenderer.getI18nBean("fr")
String getLinkToCustomerPortal(Issue issue);

Returns an absolute link to the customer portal belonging to the service management project of the issue.

If the issue is not from a Service Management project, it returns null

$!jetiFieldRenderer.getLinkToCustomerPortal($!issue)
String getLinkToIssueInCustomerPortal(Issue issue);

Returns an absolute link to the issue in the customer portal belonging to the service management project of the issue.

If the issue is not from a Service Management project, it returns null

$!jetiFieldRenderer.getLinkToIssueInCustomerPortal
($!issue)


Anchor
jetiFieldFormatter
jetiFieldFormatter
$jetiFieldFormatter

$jetiFieldFormatter is an object in the template context that may be used to format date or date time values.

...

Anchor
templateSupport
templateSupport
templateSupport

MethodDescriptionUsage
String encodeUrl(String url);
Calls URLEncoder.encode(url) 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) to encode rendered URLs in email templates using the encoding specified$!templateSupport.encodeUrl($urlVariable, <desired encoding>)
Issue firstIssueMatchingJQL(String jql);Returns the first issue that matches the given JQL query


Code Block
#set($firtstIssue = $!templateSupport.firstIssueMatchingJQL("project = $issue.projectObject.key AND assignee=$!currentUser.name AND priority = Highest"))

$!firstIssue.summary


TemplateIssueSearchResults searchForIssuesByJQL(String jql);Returns a list of issues matching the given JQL query


Code Block
#set($searchResults = $!templateSupport.searchForIssuesByJQL("project=IT AND resolution=Unresolved", 10))
  #foreach($result in $searchResults.getResults())
$velocityCount - $!result.key (comments: $!result.comments.size())
  #end


TemplateIssueSearchResults searchForIssuesByJQL(String jql, int maxresults);Same as above but limits the results to the given number of issues
boolean issueMatchesJQL(String jqlQuery, Issue issue);Checks if the given issue matches the JQL query


Code Block
#if($!templateSupport.issueMatchesJQL("mycustomfield = somevalue AND component=ImportantComponent", $!issue) 
## do something...
#end


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 french language, while "fr_FR" is the french spoken in France.


Code Block
#set($frenchLocale = $!templateSupport.getLocale("fr_FR")


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.


Code Block
#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.


Code Block
#set($frenchLocale = $!templateSupport.getLocale("fr_FR")
#set($i18nFrench = $!templateSupport.getI18nHelper($frenchLocale)


boolean isAgent(ApplicationUser applicationUser, Project project);Determines if the given use is an Service Management Agent in the given project


Code Block
#if($!templateSupport.isAgent($!issue.reporter, $!issue.projectObject)
...
#end


String getParentValueFromCascadingSelectFieldValue(Map cascadeSelectFieldValue);
String getChildValueFromCascadingSelectFieldValue(Map cascadeSelectFieldValue);		Returns the parent or child value of a Cascade Select custom field.


Code Block
#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

boolean isInternalComment(Comment comment);Determins if the give comment is an Service Management Internal comment in the current issue.


Code Block
#if($!templateSupport.isInternalComment($!comment)) 
...
#end


String getCustomerVisibleStatus(Issue issue);Returns the Customer Visible Status name of the issue in a Service Management project#set($!customerVisibleStatus = $!templateSupport.getCustomerVisibleStatus($!issue)

...