Import & Export Templates
This page is about Canned Responses Pro Templates for Jira Server/Data Center. Using Cloud? 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 the cog icon in the Jira top bar and click Manage Apps. Then click Import/Export under the CANNED RESPONSES FOR JIRA section.
This page is only available to Jira administrators.
On this page:
How to Export
In the Export section, click Download, and your file will be downloaded immediately in .csv format.
How to Import
In the Import section, click Choose File, select the .csv file you want to import, click Open, and your file will be imported.
Example File:
name | content | scope | scopeParam | favorite |
---|---|---|---|---|
More Info Request | Hi $reporterName$, | GLOBAL | ||
Not Supported Browser | Hi $reporterName$, | PROJECT | SSP | |
Screenshot Request | Hi $reporterName$, | USER | admin |
When importing a .csv file, it is important to include headers as the first row. Importing mechanism omits the first row.Â
Explanations
"name" column defines the template name as seen in the picker
"content" column defines the template content (along with macros etc.)
"scope" column defines the template scope, and can take one of the following values (case sensitive!): GLOBAL, PROJECT, USER
"scopeParam" column is used with connection to PROJECT scope (it will denote project key) or to USER scope (in that case it will denote Jira userKey)
"favourite" column is not used in the Canned Responses Server/DC version. See the related Cloud documentation for comparison.
Caveats
When migrating templates between Jira instances, you need to be aware of these facts:
Canned Responses for Jira Server does not have a notion of "GROUP" scope - it is available only for Cloud version of Canned Responses.
Canned Responses for Jira Server does not have a Favorite Bar - making the "favorite" column meaningful only 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")
Custom Fields in macros are referenced by internal ID instead of the custom field name. It means that, in different instances, the templates might produce different results, rendering different macro(s) than expected.
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.