Import/Export templates

Owned by Derya Özdemir
Last updated: Dec 06, 2024
4 min read

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

The Import/Export feature allows you to easily back up your templates for safekeeping and restore them when needed. To accomplish this, navigate to Apps > Manage Your Apps, and click Import/Export under the CANNED RESPONSES section.

This page is only available to Jira administrators.

The feature is intended for backup purposes and is not recommended for transferring templates between different instances.

On the Import/Export screen, you can export all the templates in your Jira instance into a .json file or import templates from a .json or .csv file.

On this page:

On this page:

The Import/Export screen.

How to export

In the Export section, click Download, and your file will be downloaded immediately in .json format.

How to import

In the Import section, click Choose File, select the .json or .csv file you want to import, click Open, and your file will be imported.

Example export/import file

Check out an example file and learn more about each parameter through the explanations below:

name

content

scope

scopeParam

favourite

name

content

scope

scopeParam

favourite

More Info Request

Hi $reporterName$,

I'm reviewing this issue, and I don't think we have enough information to reproduce this problem. Can you add a little more detail to this ticket?

Cheers,
$currentUserDisplayName$

GLOBAL

 

true

Not Supported Browser

Hi $reporterName$,

We no longer support IE 7 in $projectName$.
We recommend you to upgrade to a more recent version. It can be downloaded from Microsoft:
http://www.microsoft.com/windows/downloads/ie/getitnow.mspx

Alternatively, you can use the Chrome browser:
https://www.google.com/intl/en/chrome/browser/

Best regards,
$currentUserDisplayName$

PROJECT

SSP

 

Screenshot Request

Hi $reporterName$,

Can you please add some screenshots of what you're seeing?

Best regards,
$currentUserDisplayName$

USER

557058:0c7dd459-31b7-4ef1-ae6c-a4a28ead7729

 

Customer Timeout

Hi $reporterFirstName$,

We haven't received any response from you for a while, so we assume that this issue has been resolved. However, if that's not the case, feel free to reopen it, and we will respond accordingly.

Cheers,
$currentUserDisplayName$

GROUP

site-admins
servicedesk-agents
developers

true

When importing a .csv file, it’s important to include headers as the first row. If the user skips the title, the first row of data will be shown as the title.

Explanations

  • "name" column defines the template name as seen in the picker

  • "content" column defines the template content (along with dynamic variables aka. macros and etc.)

  • "scope" column defines the template scope and can take one of the following values (case sensitive!): GLOBAL, PROJECT, USER, GROUP

  • "scopeParam" column is used with connection to PROJECT scope (it will denote project name) or to USER scope (in that case it will denote user accountId), or to GROUP scope (in that case, it will be a newline-separated list of Jira group names)

  • "favourite" column defines whether the template should appear in the Favourite Bar or not

When to use the Import/Export feature

The Import/Export feature is meant for Jira Cloud backups only! If you are migrating from Server to Cloud, we recommend moving your templates with the Atlassian Migration Program. You can learn more here.

What if I can’t use the Atlassian Migration Program?

This feature is intended for backups only and is not recommended for migrating templates between Jira instances. If you can’t use the Atlassian Migration Program and need to import templates from Server, note the following:

  • Canned Responses for Jira Server does not have a notion of "GROUP" scope - it’s available only for the Cloud version of Canned Responses.

  • Canned Responses for Jira Server does not have a Quick toolbar - the "favorite" column will only be meaningful for Jira Cloud installations.

  • Jira Server has a different way of user identification than Jira Cloud. In server, it is still an userKey (i.e., "admin", "pstefaniak"), while in Jira Cloud it is accountId ("557058:0c7dd459-31b7-4ef1-ae6c-a4a28ead7729") - you will need to manually replace user keys for user IDs in the CSV.

  • Custom fields in dynamic variables are referenced by internal ID instead of a custom field name. It means that in different instances the templates might produce a different result, rendering different dynamic variables than expected.

  • You will have to change IDs of the projects and groups manually while transferring templates between instances (for Server-Cloud and Cloud-Cloud migrations).

How to delete all templates

In some cases, you may want to delete all of your templates from your instance. You can take this action on the Import/Export screen as well. Simply click Delete, and your templates will be deleted forever.

Proceed with caution! Once you click Delete, you won't be able to reverse this action, and all templates on your Jira instance will be purged.