Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

...

How to Delete All Templates

...

Anchor
export
export
How to Export

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

Anchor
import
import
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.

Anchor
file
file
What Should the Export/Import File Look Like?

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

...

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.

Anchor
explanations
explanations
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

Anchor
when
when
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?
Anchor
cant-use
cant-use

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.

Anchor
delete
delete
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.

...