Documentation moved
Thank you for visiting our old product documentation site. Note that we are in the process of migrating our product documentation and soon we will not store or update our documentation here.
Please navigate to our new documentation site and update your bookmarks accordingly. If you're looking for the former content of this page, click here.
Velocity Context offers many objects for templates. Find the list of variables with explanations here: Customizable Email Templates#VelocityContextforTemplates.
Below is the detailed description of object attributes. You can render the attributes in the templates in the format of $!variable.attribute
User
| Attribute Name | Type | Description |
|---|---|---|
userKey | String | Internal key of the user it is unique to the users. |
username | String | Loginname of the user |
email | String | Email address of the user |
displayName | String | Display name of the user |
active | boolean | true if the user account is active in Jira |
avatar24avatar32avatar48 | String | URLs to user avatars in different sizes. |
Issue
Attributes
| Attribute Name | Type | Description |
|---|---|---|
| id | number | Internal ID of the issue |
| key | String | Unique Issue Key |
| summary | String | Issue summary |
| description | FieldValue<String> | Issue Description field with raw value and rendered format |
| environment | FieldValue<String> | Issue Environment field with raw value and rendered format |
| project | Project | Project of the issue |
| issueType | IssueType | Type of the issue |
| status | Status | Issue status |
| resolution | Resolution | Resolution of the issue |
| priority | Priority | Priority of the issue |
| timetracking | Timetracking | Timetracking details of the issue |
| creator | User | Creator of the issue. The Creater may be different from the Reporter as privileged users may create issues on behalf of others. |
| reporter | User | The user set as Reporter in the issue. |
| assignee | User | Current assignee. |
| created | FieldValue<Date> | Issue Created date field value with raw value and rendered format. |
| updated | FieldValue<Date> | Issue Updated date field value with raw value and rendered format. |
| resolutionDate | FieldValue<Date> | Issue Resolution date field value with raw value and rendered format. |
| dueDate | FieldValue<Date> | Issue Due Date field value with raw value and rendered format. |
| customFields | ||
| comments | ||
| attachments | ||
| components | ||
| fixVersions | ||
| affectsVersions | ||
| labels | Collection<String> |
Methods
| Signature | Return type | Parameters | Description | Example |
|---|---|---|---|---|
| getCustomFieldValue(customFieldKey) | CustomFieldValue |
| Returns a API for Velocity Context Objects#CustomFieldValue object representing the value of the custom field addressed by the key | $!issue.getCustomFieldValue('customfield_10116') |
IssueEvent
| Attribute Name | Type | Description |
|---|---|---|
| eventType | EventType | The type of the triggered event.(eg. issue created, issue commented, ...) |
issue | API for Velocity Context Objects#Issue | The Issue which the event was fired on. |
changelog | API for Velocity Context Objects#Changelog | |
worklog | API for Velocity Context Objects#Worklog | |
| comment | API for Velocity Context Objects#Comment | |
| timestamp | Date | The time when the issue was triggered |
| user | API for Velocity Context Objects#User | The user who triggered the event (added the comment, updated the issue, ...) |
Comment
| Attribute Name | Type | Description |
|---|---|---|
| id | Number | Internal ID of the comment |
| author | User | Author of the comment |
| updateAuthor | User | Update author of the comment |
| body | FieldValue<String> | Comment body |
| created | FieldValue<Date> | Creation date |
| updated | FieldValue<Date> | Update date |
| limitedVisibility | boolean | |
| internalServiceDeskComment | boolean | |
| publicServiceDeskComment | boolean |
Changelog
| Attribute Name | Type | Description |
|---|---|---|
items | A list of Changelog items |
ChangelogItem
| Attribute Name | Type | Description |
|---|---|---|
created | Date | |
field | String | |
fieldId | String | |
fieldType | String | |
from | String | |
fromString | String | |
to | String | |
toString | String |
Worklog
| Attribute Name | Type | Description |
|---|---|---|
author | API for Velocity Context Objects#User | Author of the worklog |
comment | FieldValue<String> | The comment added to the worklog |
created | FieldValue<Date> | The date when the worklog was created |
issueId | long | Id of the issue |
started | FieldValue<Date> | |
timeSpent | String | |
timeSpentSeconds | long | |
visibilityType | String | |
visibilityValue | String | |
updateAuthor | API for Velocity Context Objects#User | |
| updated | FieldValue<Date> |
EmailCommand
| Attribute Name | Type | Description |
|---|
Template Support
| Attribute Name | Type | Description |
|---|---|---|
isAgent($!currentUser, $!issue.project) isAgent($!currentUser, $!issue.projectObject) | boolean | Returns true if the given user is an agent on the project, otherwise false. |
Project
| Attribute Name | Type | Description |
|---|---|---|
| id | Long | |
| name | String | |
| key | String | |
| projectTypeKey | String |
IssueType
| Attribute Name | Type | Description |
|---|---|---|
| id | Long | |
| name | String | |
| subtask | boolean | |
| iconUrl | String |
Status
| Attribute Name | Type | Description |
|---|---|---|
| id | Long | |
| name | String | |
| description | String | |
| iconUrl | String | |
| categoryKey | String | |
| categoryColorName | String |
Priority
| Attribute Name | Type | Description |
|---|---|---|
| id | Long | |
| name | String | |
| description | String | |
| iconUrl | String |
Resolution
| Attribute Name | Type | Description |
|---|---|---|
| id | Long | |
| name | String | |
| description | String |
Timetracking
| Attribute Name | Type | Description |
|---|---|---|
originalEstimate | String | |
| remainingEstimate | String | |
| timeSpent | String | |
| originalEstimateSeconds | Long | |
| remainingEstimateSeconds | Long | |
| timeSpentSeconds | Long |
Attachment
| Attribute Name | Type | Description |
|---|---|---|
| id | Long | |
| contentId | String | |
| filename | String | |
| mimeType | String | |
| created | Date | |
| size | long | |
| contentUrl | String | |
| thumbnailUrl | String | |
| hash | String |
Component
| Attribute Name | Type | Description |
|---|---|---|
| id | Long | |
| name | String |
Version
| Attribute Name | Type | Description |
|---|---|---|
| id | Long | |
| name | String |
CustomFieldValue
| Attribute Name | Type | Description |
|---|---|---|
| customField | API for Velocity Context Objects#CustomField | Reference to the CustomField |
| renderedValue | String | The value in html as visible in Jira |
| value | T | Contains the raw value of the field. Type is the type of declared in Jira. One of
|
CustomField
| Attribute Name | Type | Description |
|---|---|---|
| customId | Long | |
key | String | key of the custom field. This is the primary identifier used by Email This Issue. (eg. in macro parameters) The format is customfield_$id. |
| itemType | String | |
| type | String |
FieldValue<T>
| Attribute Name | Type | Description |
|---|---|---|
| rawValue | T | Contains the raw value of the field. Type is the type of declared in Jira. One of
|
| renderedValue | String | The value in html as visible in Jira |