Versions Compared

Key

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

Follow the below step-by-step guide if you need to import only parts of an email configuration into your system and override the existing ones with them.
This could be the case when you need to check another Jira instance's configuration or use templates, field rules etc. of another environment.

In this tutorial, we will import the mail handler, mail account and templates into an already existing configuration (which could be useful in case of a service management support channel where you need to see another test environment's settings).

Note
iconfalse
titlePrerequisites

It is a prerequisite that you have all projects, issue types, fields etc. already created in Jira before starting the Email This Issue Restore process. Everything you would like to set in Email This Issue has to be present before starting the backup, please make sure to check these beforehand.

Jira related dependencies:

  • In case of Projects, the name and the project key have to match
  • In case of Issue Type/Request type, the names have to match and they have to be available within the project
  • In case of (custom) Fields, the name and the field type have to match
  • In case of Project roles the names have to match
  • In case of Issue Link Types the names have to match
  • In case of Groups the names have to match
  • In case of a User, the user key has to match

Email This Issue related dependencies:

  • Template: either imported or found by name
  • SMTP connection: either imported or found by name
  • Mail Account: either imported or found by name

Step-by-Step

Generally speaking, there are four phases of a Backup/Restore process:

I. Creating a backup JSON file

II. Uploading the backup file to your new environment

III. Running the restore process

IV. Import results

...

If you follow this guide correctly, you should be able to import certain Email This Issue settings into your setup.

...

To create a backup JSON file in your system, you will need to carry out the following steps:

...

Image Removed

The file is displayed on a list in the Backup/Restore menu and can be restored by clicking on Restore.

Panel
borderColorgrey

On this page

Table of Contents
maxLevel3
minLevel3

Panel
borderColorgrey

Detailed documentation

Backup and Restore Administration

...

In order to upload the backup file into your system, follow the below steps:

...

Navigate to Email This Issue - Administration - Backup/Restore.

...

Click on Add file then click on Browse.

...

Select the JSON file you wish to restore then click Upload (or drag and drop the downloaded file in your browser).

...

Image Removed

...

After having the JSON file uploaded in your system you can now start the restore process:

...

Image Removed

...

  1. Entity selection

  2. Conflict resolution

  3. Overview

  4. Import results

...

Image Removed

The entities (objects that we are restoring - in this case email template, manual email default, notification etc.) are presented with drop-down menus and are marked with a grey highlight, while the rows without any highlights are entity items.

The entity items can be one of the following types:

...

Note

In case of importing Mail Accounts please note that we do not import passwords. They need to be entered again or the account needs to be changed in order for the setup to work.

Image Removed

...

Info
titleInfo

The import can have four results:

  • Success: all data has been imported successfully.
  • Warning: there were items during the import that could not be identified, therefore no action has been taken on those items.
  • Error: there was an error during the process such as a faulty JSON file. It does not mean that the restore has failed, it can still be successful, however, you need to check the configuration.
  • Failed: a fatal error has occurred, the import is failed, no action has been taken on any of the items.
    • In the case of "New entity", the new entity is NOT created.
    • In the case of "Overwrite existing", the existing entity will not be modified in any way.
  • On the results page a link is displayed next to the entity which takes you to the edit page of the entity.
Note
titleNote

The import log can be found in the browser's console in a JSON format.

If all the above steps are carried out properly, you should now have all the imported configurations of the backup file in your system.

Panel
borderColorgrey

Backup / Restore only parts of a configuration

Panel
borderColorgrey

Backup / Restore every setting in the same instance

...

borderColorgrey

...

Expertisefinder redirect
forcedfalse
dest{"value":"https://docs.meta-inf.hu/email-this-issue-for-jira-server-data-center/documentation/administration/backup-and-restore-settings/backup-and-restore-tutorials/backup-and-restore-only-parts-of-a-configuration"}
typeurl
enabledtrue

Thank you for visiting our old product documentation site. Note that we no longer store or update our documentation here.

Please navigate to our new documentation site and update your bookmarks accordingly. If you're looking for the former content of this page, click here.