Email This Issue
📈 Marketplace❓ Support❤️ Feedback🏠 META-INF Apps
Email This Issue - for Jira Server/Data Center
Email This Issue - for Jira Server/Data Center
  • ⬇️Start Here
  • Email This Issue - for Jira Server/DC
  • Features
  • Secure the email channel with Email This Issue
  • Comparing Email This Issue and Jira Server/DC
  • 🤓Documentation
    • Outgoing Emails
      • Sending manual emails
        • The difference between email editors
        • Enabling template categories so templates can be chosen on the Email screen
        • Mail Generation Queue (formerly called Event Queue)
        • Manual Email Default Settings
      • Sending issue filters by email
      • Email templates
        • Adding custom macro to email templates
        • Adding Email Audit Log to email templates
        • Adding fields to email templates
        • Adding issue comments to emails
        • Adding issue link information to your template
        • Adding issue operation links to the email
        • Adding a signature with a company logo to emails
        • Adding user properties to emails
        • Disabling links and avatars or icons in templates
        • Formatting Date and Time values
        • Using reply templates
        • Using Mail Body Initializer templates
        • Rendering templates within templates
        • Velocity Context in email templates
        • Formatting number values
        • Searching for issues in email templates
        • Changelog information in email templates
        • Canned responses
      • Contexts
        • Context Resolution Algorithm
      • Event Notifications
      • Distribution lists
      • Workflow post functions
      • Custom fields
    • Incoming Emails
      • Attachment Filtering
      • Next Generation Mail Handlers
        • Jira automation and Next Generation Mail Handlers
        • Using regular expressions
      • Classic Mail Handlers - Deprecated
        • Mail Handler Error Log
        • Step-by-step Classic Mail Handler to Next Generation Mail Handler migration aid
        • Field Rules
        • Phasing out the Classic Mail Handler
        • Comparing the Classic and the Next Generation Mail Handlers
    • Integrations
      • CRM for Jira
      • nFeed
      • Glass Documentation
      • API - Integration with other services
    • Administration
      • General configuration
      • Email Audit Log
      • Outgoing Mail Connections
      • Outgoing Mail Queue
      • Incoming Mail Connections
      • Incoming Mail Queue
      • Incoming Mail Log
      • Backup and restore settings
        • Backup and restore administration
          • Backup menu
          • Restore menu
        • Backup and Restore Tutorials
          • Backup and restore for empty email settings
          • Backup and restore only parts of a configuration
          • Backup and restore every setting in the same instance
      • OAuth2 Authorizations in Email This Issue
        • OAuth2 Client Credentials
        • Authorizing Email This Issue to access Gmail accounts
        • Authorizing Email This Issue to access Microsoft 365 accounts
        • Enabling OAuth2 Authorization in your Google Account
        • Enabling OAuth2 authorization in your Microsoft 365 account
        • Troubleshooting guides for Microsoft OAuth2 Connections
          • How to fix "Authorization Was Interrupted" error
          • How to fix "BAD User is authenticated but not connected" error
          • How to fix "401 Unauthorized" error
          • How to fix "key expires_in " error
          • How to fix "Need admin approval" error
      • Alerting via Webhooks
        • Webhooks
          • Configuring Slack to receive webhooks
          • Configuring OpsGenie to receive webhooks
        • Webhook execution logs
      • Email Security
    • Service management integration
    • JQL Functions
    • Top-level menu navigation
  • ☁️Server to Cloud Migration
    • Server to Cloud - Automatic Migration tool
    • Server to Cloud - Manual migration guide for Email This Issue
      • Overview of available features
      • Differences of the Server and Cloud user interface
      • Migrating Outgoing Settings
        • Migrating Templates
        • Migrating Notifications
        • Migrating Manual Email Defaults
        • Migrating Contexts
        • Migrating Canned Responses
        • Migrating Post Functions
        • Migrating Outgoing Mail Connections
      • Migrating Incoming Settings
        • Migrating Classic Mail Handlers
        • Migrating Next Generation Mail Handlers
        • Migrating Incoming Mail Connections
        • Migrating Incoming Mail Queue Settings
        • Migrating Incoming Mail Log Settings
      • Migrating Other Settings
        • Migrating OAuth2 Credentials
        • Migrating global default email settings
        • Migrating permissions for sending emails manually
        • Migrating recipient restrictions
  • ❓FAQ
    • FAQ
      • How to bypass workflow conditions
      • How to avoid email loops
      • How to control who to send emails to
      • How to customize Email From in outgoing emails
      • How to enable logging
      • How to install license keys
      • How to find out why the Email button is missing
      • How to obtain a community or non-profit license
      • How to prevent duplicate emails
      • How to remove old content from reply emails
      • How to send personalized emails to recipients
      • How to set up auto-reply or acknowledgment emails
      • How to track cases when you don't get any emails
      • How to view the log of incoming and outgoing emails
      • The iOS Mail app does not show attachments
      • How to route emails to projects
      • How to maintain email threads in Jira
      • How to fix issues with a corrupt index state
      • How to set polling interval for mail accounts manually
    • Tutorials
      • Configuring email approval
      • Customizing the email template used with manual emails
      • Enhance Jira Service Management with Email This Issue
      • Getting Started
      • Setting up an Email Help Desk
      • Setting up customized notifications
      • Setting up a Service Management with a Next-Gen Mail Handler
  • 🌪️Misc
    • Open Source Components
    • Pricing Updates
      • Pricing Update effective October 1st 2018
      • Pricing Update effective December 1, 2021
    • End of Support Policy
    • Security Advisories
      • Email This Issue Security Advisory 2020-02-18
    • Database Tables
    • Translations
  • 🆕Release Notes
    • Release notes
      • 9.x.x
        • 9.15.0 Jira 10 compatibility
        • 9.13.0 Improvements and Fixes
        • 9.11.0 Improvements and fixes
        • 9.10.0 Major improvements and fixes
        • 9.9.1 Improvements and fixes
        • 9.9.0.2 Major improvements and fixes
        • 9.8.0 Improvements and fixes
        • 9.7.0 Improvements and fixes
        • 9.6.0 Improvements and fixes
        • 9.5.0 Improvements and fixes
        • 9.4.0 Bugfixes
        • 9.3.3. Improvements and fixes
        • 9.3.2 Major improvements
        • 9.3.1 Automatic cloud migration
        • 9.2.2.1 Bugfixes
        • 9.2.2 Improvements and fixes
        • 9.2.1.3 Compatibility changes for Jira 9.0.0
        • 9.2.1 Major improvements
        • 9.2.0 Improvements and fixes
        • 9.1.1 Improvements and fixes
        • 9.1.0.1 Alerting and other major new features
        • 9.0.2 Bugfixes, next step in deprecating the Classic Mail Handler
        • 9.0.1 Minor improvement and fixes
        • 9.0.0 Major improvements
        • 9.12.0 Improvement and fixes
        • 9.17 Improvements and Fixes
        • 9.18.0 Improvements and fixes
      • 8.1.x
        • 8.1.3 Classic handler is deprecated, timezone support, bug fixes
        • 8.1.2 Important bug fixes
        • 8.1.1 Microsoft 365 OAuth2, improvements and fixes
        • 8.1.0 Microsoft 365 OAuth2, improvements and fixes
      • Up to 8.0.6
Powered by GitBook
On this page

Was this helpful?

  1. Documentation
  2. Administration
  3. Backup and restore settings
  4. Backup and Restore Tutorials

Backup and restore only parts of a configuration

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 import the mail handler, mail account and templates into an already existing configuration (which can be useful in the case of a service management support channel where you need to see another test environment's settings).

Prerequisites

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 procedure

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. Importing results

We go into details of the above steps in the following pages.

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

I. Creating a backup JSON file

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

  1. Go to SETTINGS --> Backup/Restore.

  2. Click on Backup (next to Add file) and optionally fill the "Description of the export" field, then press the Create button under the description field.

  3. Download the JSON file by clicking on the three dots at the end of the row and click on Download. Please note that the backup JSON file is by default stored at <Jira Home Directory>\data\emailissue\.

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

II. Uploading the backup file back into your environment

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

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

  2. Click on Add file then click on Browse.

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

  4. The file is now listed in a table below and can be used to restore your settings.

III. Running the restore process

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

  1. Click on the three dots at the end of an uploaded item

  2. Click on Restore

The restore configuration has four stages:

  1. Entity selection

  2. Conflict resolution

  3. Overview

  4. Importing results

Entity selection

During entity selection, you can select which parts of your configuration you would like to import into your server instance. In this case, we would like to import the mail handler, mail account and templates into an already existing configuration as shown below:

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:

  • Name of an entity (e.g.: the name of a template)

  • A Project and/or an Issue type can be selected within the entity, in which case it is presented as <Project name>; <IssueType name> (this could be the case with the Manual email default for example)

  • A Project and/or an Issue type can be selected within the entity, in which case it is presented as <Project name>; <IssueType name>; <JQL filter> (this could be the case with the Context for example)

Conflict resolution

After selecting the entities to be imported, click on Conflict resolution to proceed with the process.

During the import, there could be conflicts regarding the items you wish to restore, but in this case, because we are restoring data in your old system there will be configurations (therefore conflicts) present already.

Otherwise, click on Overwrite existing then select an entity you wish to overwrite (by default the original entity will be offered to you automatically). By default the entity you are resolving is displayed but it can be overwritten in the Select Entity section:

Overview

After resolving the conflicts, click on Check to see if the resolutions have been successful. Once all the conflicts are resolved successfully, the overview page is displayed and you may proceed with the restore process by clicking on Confirm.

Important: When 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.

IV. Importing results

  1. After clicking on Confirm, the import results page displays the log of imported entities and their status. Imported entities can be found on the left pane, while the results of their import are presented on the right pane of the window.

  2. Click on Close to exit the import result page.

Note: 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: 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.

See more:

PreviousBackup and restore for empty email settingsNextBackup and restore every setting in the same instance

Last updated 3 years ago

Was this helpful?

If you wish to restore any configuration into an empty setting, please follow our from this point onwards.

🤓
Backup and restore for empty email settings
Backup and restore administration
Backup and restore for empty email settings
Backup and restore every setting in the same instance