Contents of the Velocity Context

This is the listing of the contents of the Velocity Context used to process web templates.

For JIRA 3.6.x and later - please refer to the JIRA 3.6.x guide for details on the velocity context used to process email templates.

Velocity variable

JIRA Object/Value

Description

As of Version 

 Condition

 constantsManager

 com.atlassian.jira.config.ConstantsManager

 Manager for issue types, statuses, priorities and resolutions.

 3.4

 always present

 projectManager

 com.atlassian.jira.project.ProjectManager

 Implementations of this interface are responsible for all management of project entities within JIRA.

 3.4

 always present

 customFieldManager

com.atlassian.jira.issue.CustomFieldManager 

 Functions for working with CustomFields

 3.5

 always present

 applicationProperties

 com.atlassian.jira.config.properties.ApplicationProperties

 provides access to JIRA properties stored in the DB

 3.4

 always present 

 jirautils 

 com.atlassian.jira.util.JiraUtils

 Miscellaneous utility methods.

 3.4

 always present

 jirakeyutils

 com.atlassian.jira.util.JiraKeyUtils

 utilities to determine the validity of JIRA project/issue keys

 3.4

 always present 

 buildutils

 com.atlassian.jira.util.BuildUtils

 provides information on the running version of JIRA

 3.4

 always present 

 velocityhelper

 com.atlassian.jira.util.JiraVelocityHelper

 A simple class store methods we want to expose to velocity templates

 3.4

 always present

 userutils

 com.atlassian.core.user.UserUtils

 A utility class for operating on users.

 3.4

 always present

 textutils

 com.opensymphony.util.TextUtils

 lots of utility methods for manipulating text

 3.4

 always present 

 params

 java.util.Map

 parameters of the IssueEvent that triggered this email notification 

 3.4

 always present

 issue

 org.ofbiz.core.entity.GenericValue

 a GenericValue representing the issue which triggered this email notification 

 3.4

 always present

 issueObject

 com.atlassian.jira.issue.MutableIssue

an Issue object representing the issue which triggered this email notification

 3.5.2

 always present

 remoteUser

 com.opensymphony.user.User

 the logged in user if they exist 

 3.4

 remoteUser != null 

 renderedDescription

 java.lang.String

 the rendered description field, it a renderer has been specified 

 3.4

 renderer specifed for issue and field 

 renderedEnvironment

 java.lang.String

 the rendered environment field, it a renderer has been specified 

 3.4

 renderer specifed for issue and field

 timeoriginalestimate

 java.lang.String

The DateUtils.getDurationPretty value of timeoriginalestimate from issue or "None" if null

 3.4

 always present

 timeestimate

 java.lang.String

 The DateUtils.getDurationPretty value of timeestimate from issue or "None" if null

 3.4

 always present

 timespent

 java.lang.String

 The DateUtils.getDurationPretty value of timespent from issue or "None" if null

 3.4

 always present

 duedate

 java.sql.Timestamp

 Duedate from the issue

 3.4

 always present

 versions

 List(org.ofbiz.core.entity.GenericValue)

 A list of GenericValues representing the Affected Versions of the issue

 3.4

 always present

 fixfors

 List(org.ofbiz.core.entity.GenericValue)

 A list of GenericValues representing the Fix Versions of the issue

 3.4

 always present

 components

 List(org.ofbiz.core.entity.GenericValue)

 A list of GenericValues representing the Components of the issue

 3.4

 always present

 assignee

 com.opensymphony.user.User

 The assignee of the issue

 3.4

 assignee != null 

 reporter

 com.opensymphony.user.User

 The reporter of the issue

 3.4

 reporter != null

 renderedComment

 java.lang.String

 the rendered comment field, it a renderer has been specified. The comment is the comment associated with the change

 3.4

 renderer specifed for issue and field and comment created

 comment

 org.ofbiz.core.entity.GenericValue

 generic value representing the comment associated with the change

 3.4

 comment created

 commentauthor

 com.opensymphony.user.User

 the author of the comment

 3.4

 comment created

 timelogged

 java.lang.String

 The DateUtils.getDurationPretty value of timelogged from issue or "None" if null

 3.4

 always present

 changelog

 org.ofbiz.core.entity.GenericValue

 generic value representing the changelog associated with the change

 3.4

 changelog != null

 changelogauthor

 com.opensymphony.user.User

 The change log author of the issue

 3.4

 changelog != null

 visibilitylevel

 java.lang.String

 The security level of the comment

 3.4

 comment created

 i18n

 com.atlassian.jira.util.I18nHelper

 Bean that searches for i18n text in JiraWebActionSupport.properties

 3.4

 always present

 dateutils

com.atlassian.core.util.DateUtils

methods for working with dates

 3.4

 always present

 attachments

 List( org.ofbiz.core.entity.GenericValue)

 list of generic values that represents the attachments associated with the issue

 3.4

 always present

 security

 org.ofbiz.core.entity.GenericValue

 generic value representing the security level, if any, associated with this issue

 3.4

 if(isEnterpriseEdition) 

mailPluginsHelper

com.atlassian.jira.mail.JiraMailPluginsHelperImpl

provides access to isPluginModuleEnabled()

3.7

always present

Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport