Supported macros

This page is about Canned Responses for Jira Server and Data Center. If you are using Jira Cloud – please see the cloud documentation.

Canned Responses allows you to use various macros to retrieve issue related values. Here is the full list:

Macro

Example result

Macro

Example result

Special Macros

currentUserDisplayName

John Doe

currentUserFirstName

John

currentUserName

johndoe

cursor

sets cursor position after a response is inserted

date

15/Jun/15 (produces current date)

lastComment

inserts body of the latest comment visible to the current user

Standard fields

affectsVersion

1.2, 1.3

assigneeName

John Doe

assigneeFirstName

John

assigneeUserName

jdoe

components

Core, Documentation

createdDate

01/20/2017 (defined in Jira Look and Feel settings)

createdTime

01/20/2017 7:45 AM

dueDate

01/20/2019

fixVersion

1.2, 1.3

issueDescription

Create list of all macros so that users can easly see them all in one place before installing the plugin.

issueKey

CT-198

issuePriority

Highest

issueStatus

In Progress

issueSummary

Add "Supported Macros" section in CT documentation

issueType

Task

labels

Documenatation

projectKey

CT

projectName

Canned Responses

reporterName

Jane Doe

reporterUserName

janedoe

reporterFirstName

Jane

Sample custom fields

Sprint_10000

Sample Sprint

Story Points_10002

3.0

and all the others

User custom fields with filters

User_10003

janedoe

User_10003|displayName

Jane Doe

User_10003|firstName

Jane

User_10003|lastName

Doe

remoteLinks

All outgoing remote links, regardless of type, comma separated

remoteLinks_wiki

Remote links to Confluence content

remoteLinks_jira

Links to remote JIRA instances

remoteLinks_web

Links to web pages

Unresolved macros

While choosing template for rendering you might sometimes encounter "Unresolved macros detected" warning. This happens in two scenarios:

  • this particular issue has empty value for one of the used macros (for example relevant Custom Field value is "" or issue description is empty)

  • a different macro was meant to be used

You should double check that the template is using right macros. Otherwise it is just enough to review the rendered comment before posting and redact where necessary.