Page Comparison

On this page, you’ll learn how to create a template in Canned Responses.

It’s possible to create a template directly in the issue or on the configuration (Profile > My Canned Responses) page:

Anchor
acces-template acces-template

How to Access the Template Creation Screen

• Canned Response Panel – Open any issue and click 'Comment' or type 'm' to go directly to the Comment field to see the Canned Response panel. Click the plus icon to create a new template.

• Alternatively, you can open your profile to view all of your canned responses and add new ones. To do that, follow the steps below:

Image Removed

Image Added

Anchor
how-to how-to

How to Create a New Template

Now, let’s create a new template. After opening the Add response template screen by using one of the methods described above, follow the steps below and learn about each component:

Anchor
template-name template-name

1. Template name:

Enter a name for your template. This is the name you'll be searching for when using the template in one of the fields where Canned Responses is available.

Anchor
visibility visibility

2. Visibility scope:

The visibility scope indicates who will see this template in Jira issues. Template visibility can be restricted to you or shared with your teammates using Project or Global scopes. Depending on your role, you can create templates in one of three types of scopes:

• Personal – visible (in issues) to a specific user only. Managed by the user and administrators.

• Projects - visible for issues from selected projects. Managed by Jira Administrators (global permission), Project Administrators, and users granted the Manage Project Canned Responses project permission provided by Canned Responses. See Managing project permissions documentation for detailed information.

• Global - visible to everybody. Managed by Jira administrators only. 

For more information, check out the table below for the visibility scopes within Canned Responses:

Can't administer, view nor use

Anchor
response response

4. Response content:

Create any template content using the editor.

Macros

You can use macros, which are special keywords that will be dynamically replaced with proper data when the template is used, to generate contextual templates based on issue data. There are macros for all issue fields as well as custom fields.

Canned Responses supports all Jira custom fields. Some of the most commonly used macros are listed below, along with examples of generated content based on issue data:

Using @ mentions

Canned Responses for Jira also supported mentioning people while putting templates in comments. Jira uses markdown to generate rich comments, and we need to generate some markdown as well to make proper mentions. See the Jira WikiRenderer documentation. To create a mention for a user field:

Macro	Template content
Particular User	[~username]	username is Jira username of user you want to mention
Assignee	[~$assigneeName$]
Current User	[~$currentUserName$]
Reporter	[~$reporterUserName$]
User Picker (single user)	[~$Field Name_10000$]	Field Name and 10000 are Jira custom field name and id

You don't have to do anything extra to send email notifications for user mentions. Canned Responses will generate the usual Jira user mention, and the email notifications will be sent according to your notification scheme.

Anchor
save save

6. Save template

Click the Save template button to save your template. It’ll then be available in the dropdown menu of the Canned Response panel for easy insertion in future issues.

That’s all you need to know to start creating smart templates that save you time and increase efficiency.

🖇️ Related Articles