Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
panelIconIdatlassian-info
panelIcon:info:
panelIconText:info:
bgColor#F4F5F7

This page is about Canned Responses Pro Templates for Jira Cloud. Using Server or Data Center? Click here.

Canned Responses (CR) allows users to create and use templates to quickly respond to issues. These templates can be created, used, and managed in the Canned Responses

...

panel, which can be found on any issue view

...

, and, if you have the browser extension installed, in the Transition screen and JSM Queues view.

On this page, we’ll explore all the places where Canned Responses is available.

...

  1. Dropdown

  2. Quick toolbar

    1. How to Favorite a Template

  3. Editor box

  4. Smart suggestions

  5. Save

  6. Schedule comments

  7. Create

  8. Manage

...

Once you create a template, it’ll be available here for easy insertion in future issues. Here you can create new templates by clicking the ➕ button next to each folder (for example, if you click the button next to Global, you’ll create a new template in that folder), select and insert templates, or favorite templates so that they appear in the quick toolbar.

Click Insert template to open the dropdown menu, search templates by typing, and select one to open it. You can also use Shift+Tab while in the editor to open the dropdown, navigate with arrows, and press Enter to select.

...

This toolbar allows for one-click insertion. When you favorite a template by clicking the star button next to it, it appears here. Once you click on a template, the text editor will expand with the template already inserted and ready for optional corrections.

...

  • on templates list (open your Jira project menu, click Canned Responses)

  • on templates list dialog (click the Manage button in Issue view)

  • when creating or editing templates (see Create new and Edit dialogs)

  • directly in Insert template... dropdown (in Issue view)

Adding a template to your favorites is an individual action; only the person who favorited a given template will see it in their quick toolbar.

All of the templates still follow visibility scopes, but each user can choose to favorite some of their templates to have them on hand, according to their individual style of work.

...

This allows you to compose a new comment or edit the issue description. When you click on a template, the box expands, and the template’s content, with the Dynamic Variables resolved, is inserted. Before saving the comment or the description, you can make any necessary modifications.

...

This feature offers response suggestions from your bank of templates and common phrases, and can help you quickly find the right answer for your situation. It’s automatically enabled when you install the app. You can disable it by turning off the toggle.

...

Clicking this button will send your message to the customer in issue view or save your template in the description field.

...

Here you can schedule your comment to be sent at the specified time unless a new comment is added to the issue or the issue has changed status.

Note

Keep in mind that you cannot schedule a comment with an action or attachment. To schedule such a message, you need to delete all actions and/or attachments, and try again.

...

When you click this, the Create template screen will appear. On this screen, you can create new templates, favorite them, and so on.

...

On this screen, you can manage all the templates in your instance. This page acts as an overview of all Canned Responses features. Here you can see all the templates in the instance, filter them, add new templates, or go to User settings, Project settings, and Global settings with just one click.

...

Image Removed
Image Removed

Important Note:

How the Canned Responses section appears to you will depend on whether you use the companion browser extension or not. The images and gifs in this documentation may look different in your instance for this reason.

The browser extension lets users access and use their predefined templates directly in native Jira fields and on additional Jira screens. Without the extension, the section is located in a separate editor box, above the Activity section.

...

titleClick to see the difference...

...

Without browser extension

...

With browser extension

...

Canned Responses is fully functional without the extension; however, to have Canned Responses available directly in the native Jira comment box, we highly recommend you use the companion browser extension.

...

panelIconId1f96b
panelIcon:canned_food:
panelIconText🥫
bgColor#E3FCEF

...

On this page:

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledefault
typelist
printabletrue
Aura divider
summaryImportant Note
paramsJTdCJTIydHlwZSUyMiUzQSUyMnRleHQlMjIlMkMlMjJzdHlsZSUyMiUzQSU3QiUyMmFsaWdubWVudCUyMiUzQSU3QiUyMmhvcml6b250YWwlMjIlM0ElMjJzdGFydCUyMiU3RCUyQyUyMmljb24lMjIlM0ElN0IlMjJuYW1lJTIyJTNBJTIyZmFQYXBlclBsYW5lJTIyJTJDJTIyY29sb3IlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJzaXplJTIyJTNBMjQlN0QlMkMlMjJ0ZXh0JTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJmb250U2l6ZSUyMiUzQTE4JTJDJTIydGV4dEFsaWduJTIyJTNBJTIybGVmdCUyMiUyQyUyMmZvbnRXZWlnaHQlMjIlM0ElMjJib2xkJTIyJTJDJTIydGV4dCUyMiUzQSUyMkltcG9ydGFudCUyME5vdGUlMjIlN0QlMkMlMjJib3JkZXIlMjIlM0ElN0IlMjJ0b3AlMjIlM0FmYWxzZSUyQyUyMnJpZ2h0JTIyJTNBZmFsc2UlMkMlMjJib3R0b20lMjIlM0F0cnVlJTJDJTIybGVmdCUyMiUzQWZhbHNlJTJDJTIyY29sb3IlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJzdHlsZSUyMiUzQSUyMnNvbGlkJTIyJTJDJTIyd2lkdGglMjIlM0EyJTdEJTJDJTIyc2l6ZSUyMiUzQSU3QiU3RCU3RCU3RA==

How the Canned Responses panel appears to you will depend on whether you use the companion browser extension or not. The images and gifs in this documentation may look different in your instance for this reason.

The browser extension lets users access and use their predefined templates directly in native Jira fields and on additional Jira screens. Without the extension, the panel is located in a separate editor box, above the Activity section.

Expand
titleClick to see the difference...

Without browser extension

With browser extension

Image AddedImage Added

Canned Responses is fully functional without the extension; however, to have Canned Responses available directly in the native Jira comment box, we highly recommend you use the companion browser extension.

Aura divider
summaryAura Divider
paramsJTdCJTIydHlwZSUyMiUzQSUyMnJlZ3VsYXIlMjIlMkMlMjJzdHlsZSUyMiUzQSU3QiUyMmFsaWdubWVudCUyMiUzQSU3QiUyMmhvcml6b250YWwlMjIlM0ElMjJzdGFydCUyMiU3RCUyQyUyMmljb24lMjIlM0ElN0IlMjJuYW1lJTIyJTNBJTIyZmFQYXBlclBsYW5lJTIyJTJDJTIyY29sb3IlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJzaXplJTIyJTNBMjQlN0QlMkMlMjJ0ZXh0JTIyJTNBJTdCJTIyY29sb3IlMjIlM0ElMjIlMjMzMzMlMjIlMkMlMjJmb250U2l6ZSUyMiUzQTE0JTJDJTIydGV4dEFsaWduJTIyJTNBJTIybGVmdCUyMiUyQyUyMmZvbnRXZWlnaHQlMjIlM0ElMjJib2xkJTIyJTJDJTIydGV4dCUyMiUzQSUyMkF1cmElMjBEaXZpZGVyJTIyJTdEJTJDJTIyYm9yZGVyJTIyJTNBJTdCJTIydG9wJTIyJTNBZmFsc2UlMkMlMjJyaWdodCUyMiUzQWZhbHNlJTJDJTIyYm90dG9tJTIyJTNBdHJ1ZSUyQyUyMmxlZnQlMjIlM0FmYWxzZSUyQyUyMmNvbG9yJTIyJTNBJTIyJTIzMzMzJTIyJTJDJTIyc3R5bGUlMjIlM0ElMjJzb2xpZCUyMiUyQyUyMndpZHRoJTIyJTNBMiU3RCUyQyUyMnNpemUlMjIlM0ElN0IlN0QlN0QlN0Q=

By default, the Canned Responses panel only appears on the issue view screen. Installing the browser extension allows you to have CR on the Transition screen and JSM Queues view. The Create Issue screen is not yet supported.

Canned Responses Pro panel (without the browser extension)

On the issue view, the Canned Responses panel is located in aseparate editor box, above the Activity section.

...

Native comment box (with browser extension)

When you install the browser extension, the CR panel appears directly in the native Jira comment box, in the Activity section. This simplifies usage for support agents by seamlessly integrating Canned Responses with the Jira interface.

...

Note

Within the editor, you may see an extra CR button, representing the built-in menu of canned responses offered by JSM. To avoid any potential confusion, hide this button by accessing Settings > Global Settings and toggling on the "Hide built-in canned responses" option.

Description field (with browser extension)

The CR panel appears in the Jira description field when you have the browser extension on. This can be used to save time and ensure consistency in the language and formatting of issue descriptions. It can also help improve the accuracy and speed of issue resolution by providing clear and consistent instructions or information.

...

Create Issue screen (with browser extension)

The Description field in the Create Issue screen also features the Canned Responses Pro dropdown, and you can insert templates into the field as usual. The templates available will dynamically change based on the project you select for the issue.

Note

Canned Responses Pro doesn't currently support automated actions, attachments, or dynamic variables within templates used on the Create issue screen. If a template uses unsupported features, a warning flag will appear. You'll need to verify the text before creating the issue.

...

You can track template usage through the Insights screen to see how often templates are used within the Create Issue view.

Transition screen (with browser extension)

The Transition screen appears when you change the issue status, depending on your workflow settings. You can change the issue status without any additional screens, or when it requires some additional info for moving the issue to the selected status, like leaving a comment or filling out some fields, you will see this screen.

When the browser extension is installed, the CR panel appears on the Transition screen, allowing you to change the issue’s status and leave a comment for the customer in one go.

...

Note

Dynamic variables rely on Jira REST APIs to retrieve custom field values, which means that they can only retrieve values from saved fields. Therefore, if your field is empty and you populate it during transition, dynamic variables cannot retrieve the value on the fly on the same screen.

As long as the fields have been filled in the regular issue view or during the previous transition, and the field is not empty during the transition, dynamic variables will work as expected.

JSM queues (with browser extension)

In Jira Service Management, customer requests are organized into queues, and you can link, comment, assign, or transition multiple requests using bulk actions.

...

Note

Keep in mind that only the dynamic variables listed below are supported, and the other dynamic variables will not be replaced with values.

  • $currentUserName$

  • $currentUserAccountId$

  • $date$

  • $currentUserFirstName$

  • $time$

  • $timezoneName$

  • $timeUTCOffset$

Moreover, due to Jira Cloud limitations, this view doesn’t support attachments or automated actions.

When you install the browser extension, Canned Responses allows you to comment on numerous JSM requests at once using your predefined templates.

To add internal comments or reply to customers on multiple requests:

  1. From your service project, go to a queue that shows all the requests you’d like to comment on.

  2. Click the box beside each request you’d like to comment on.

  3. Click Comment in the action bar.

  4. Click Select template to open a dropdown and search your template or select your favorite one from the quick toolbar.

    Image Added
  5. Click Comment to post your comments to the requests.

Note

Please note there are limitations due to Jira Cloud restrictions:

  • You must use the Canned Responses extension for Chrome, Edge andFirefox browsers.

  • Automated actions added to the template cannot be run while inserting templates this way.

  • Only plain text can be added to the comments, and attachments cannot be added to multiple requests this way.

  • As mentioned above, only the following dynamic variables are supported in this view: $currentUserName$, $currentUserAccountId$, $currentUserFirstName$, $time$, $timezoneName$, $timeUTCOffset$, $date$