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
  • Uploading a JSON file
  • Restoring data from the uploaded file

Was this helpful?

  1. Documentation
  2. Administration
  3. Backup and restore settings
  4. Backup and restore administration

Restore menu

PreviousBackup menuNextBackup and Restore Tutorials

Last updated 1 year ago

Was this helpful?

In Email This Issue, you can create a JSON file and upload it to restore your current settings:

  • on the same Jira server instance

  • on another Jira server instance

The full restore procedure consists of the following steps:

1. Upload a JSON file.

2. Restore data from the uploaded file.

Uploading a JSON file

Go to SETTINGS --> Backup/Restore.

For the backup procedure see .

In order to restore parts or whole of a configuration, you need to upload a file. For this, the Add file button is used which displays the option to select a file to be uploaded.

The file can be uploaded by drag and drop or by pressing the Choose File button and then the Upload button.

You can cancel the upload process before hitting Upload, by clicking on the Cancel button.

The uploaded files are displayed in a table under the upload menu, displaying the following values:

Field
Description

Created on

Date and time of the exported file displayed in the time zone settings of the original backup system.

Description

The description field's value that has been entered during the original backup process. If left empty, nothing is displayed.

Created by

Username of the person creating the export (in raw text format).

App version

The version number of the source Email This Issue instance.

Jira version

The version number of the source Jira instance.

The uploaded files can be deleted by clicking on the three dots at the end of the backup row and clicking on Delete.

Backup files can be Restored by clicking on Restore while backup files can be downloaded by pressing Download.

If the user does not upload a JSON file but presses Upload, the following error message appears:

If the upload is successful, the JSON file is added to the list of exported entries.

Restoring data from the uploaded file

In order to restore parts or whole of a configuration, you need to start the restore process after uploading a file.

The uploaded files can be restored by clicking on the three dots at the end of the backup row and clicking on Restore.

The restore configuration has four stages:

  1. Entity selection

  2. Conflict resolution

  3. Overview

  4. Importing results

Step 1 - Entity selection

The first step in the restore process is the Entity selection where you can select which parts of your configuration you would like to import into your server instance.

The entities, such as Email Template, Configuration, Notifications or Responses are presented with drop-down menus and are marked with a grey highlight.

The rows without any highlights are entity items (such as email templates, configurations, notifications, responses etc.).

The entity items can be one of the following four:

  1. The name of an entity (e.g.: the name of a template)

  2. The entity is a pattern (e.g.: MD5 pattern) or a regular expression, in which case this is displayed

  3. A Project and/or an Issue type can be selected within the entity, in which case it is presented as <Project name>; <IssueType name>

  4. A Project and/or an Issue type and/or JQL criteria can be entered within the entity, in which case it is presented as <Project name>; <IssueType name>; <JQL filter>

You can select the entities individually by clicking on their respective checkboxes or you can select them all by clicking on the checkbox next to the name of the entity.

You can proceed with the restoration by clicking on Conflict resolution or cancel the process by clicking on Cancel.

Step 2 - Conflict resolution

During the import there might be conflicts regarding the items you wish to restore. These items can be found on the left pane, while the resolution to their conflicts are presented on the right pane of the window.

All conflicts need to be resolved before being able to proceed to Step 3 - Overview. You can always navigate back to the entity selection by pressing the Back to entity selection button.

The items you wish to import on the left pane are listed by their entities and their conflicts have to be resolved separately by clicking on the entity item first.

This brings up the conflict unique to that entity item and displays a drop-down menu called Restore type. Here, the user can select how the data should be restored and therefore resolve the conflict.

Conflicts for the entity items can only be resolved one-by-one, they cannot be resolved altogether by clicking on the collective entity and selecting one restore type.

Note: At the moment every entity requires a check with the exception of MD5 patterns, configurations, and the attachment name filter's regular expressions.

There are two ways to resolve a conflict:

  1. Create new entity In this case a new scope has to be given to the imported entity (such as a new name of a project/issue type setting). This is the default restore type when the user is uploading a configuration in an empty instance.

  2. Overwrite existing entity In this case you need to select an existing entity in the system and we will overwrite its attributes but not its scope.

When selecting Create new entity, you can click on the Insert imported parameters button next to the restore type. This will automatically fill out the entity's parameters with the imported parameters such as the name or the scope (project, an issue type or in some cases a JQL query) of the entity.

On the following figure the conflict resolution screen for an Email Template is shown:

You can also set these parameters manually, in this case by selecting the project, the issue type and a JQL for a Context:

When selecting Overwrite existing entity, a Select entity drop-down list or a Select entity list (with radio buttons) is displayed depending on the entity type with the currently available entity items from within the system.

Note: You can select multiple items to overwrite the same entity item, in this case we'll iterate through the list of replaceable entities and will only overwrite the selected existing item with the last one of the imported items. For this reason, we urge you not to select the same item to be replaced by multiple entity items.

This is how the Select entity drop-down list is displayed:

This is how the Select entity list with radio buttons is shown:

The following table specifies the required or optional attributes of every entity that may be restored during the restoration process. Attributes marked with an asterisk ( * ) are required to fill in or select:

Entity Name
Create New Entity
Overwrite Existing Entity

Email Template

Entity name*

Select existing entity from the dropdown list*

Manual Email Defaults

Select a project

Select an issue type

JQLfilter

Select existing entity from the list*

Notifications

Entity name*

Select existing entity from the dropdown list*

Canned Responses

Entity name*

Select existing entity from the dropdown list*

Field Rules

Select a project

Select an issue type

Select existing entity from the list

Distribution Lists

Entity name*

Select existing entity from the dropdown list*

OAuth2 Credentials

Entity name*

Not supported

Certificates

Entity name*

Not supported

SMTP Connections

Entity name*

Select existing entity from the dropdown list*

Mail Accounts

Entity name*

Select existing entity from the dropdown list*

Mail Handlers

Entity name*

Select existing entity from the dropdown list*

Next Generation Mail Handlers

Entity name*

Select existing entity from the dropdown list*

Classic Mail Handlers

Select a project

Select an issue type

Select existing entity from the list*

Contexts

Select a project

Select an issue type

JQL filter

Select existing entity from the list*

General Configuration

Only overwriting an existing configuration is available

No action needed

Mail Queue Configuration

Only overwriting an existing configuration is available

No action needed

Purge Configurations

Only overwriting an existing configuration is available

No action needed

MD5 patterns

No action needed

No action needed

Attachment Name Filters

No action needed

No action needed

Note: The MD5 patterns', configurations' and the attachment name filter's regular expression scopes will be checked automatically. If two items of the same scope (name, regular expression etc.) are found, the old one will be overwritten by the system with the new one. If no two items are of the same scope, a new entity will be created by default. These conflict resolutions cannot be changed by users.

After selecting how to resolve all conflicts, click Check. If all conflicts have been successfully resolved, you'll be redirected to the Overview page. If there are one or more conflicts that could not be resolved appropriately, a red exclamation mark appears next to the entity item until their respective conflicts are resolved. Conflicts already resolved successfully are marked with a green checkmark:

You can cancel the restore process anytime by clicking on Cancel.

Step 3 - Overview

Once every conflict has been resolved, an overview page is displayed, its data is generated based on the selected entities.

The overview page displays the following information:

  1. Entity type: the type of the entity that is generated from the original scope of the import file.

  2. Original entity name: the name of the entity that is generated from the original scope of the import file.

  3. Action: what happens to the original entity (currently the options are to CREATE NEW or OVERWRITE EXISTING entities).

  4. Entity name after restore: how the entity can be found after the import.

After checking your list of entities in the overview page, click on Confirm to finalize the restore or Cancel to cancel the process.

Step 4 - Importing results

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 including the attributes and logging their status.

The import can have three results:

  1. Success: all data has been imported successfully.

  2. Warning: there were items during the import that could not be identified, therefore no action has been taken on those items.

  3. Failed: a fatal error has occurred, the import is failed, no action has been taken on any of the items.

On the results page, a link is displayed next to the entity which takes you to the Edit page of the entity:

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

Note: At no point during the restore process can you save your progress. Changes are applied after pressing the Confirm button at the end of .

🤓
Step 3 - Overview
here