Versions Compared

Old Version 6

changes.mady.by.user Balázs Lakatos [META-INF]

Saved on

compared with

New Version 7

changes.mady.by.user Balázs Lakatos [META-INF]

Saved on

Key

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


Info

In Email This Issue, you can create a JSON file and upload it:



Info

The full restore process consists of two steps:

  1. Uploading a JSON file
  2. Restoring data from the uploaded file


Uploading a JSON file 
Anchor
upload
upload

The upload and restore processes take place in the Email This Issue - Administration - Backup/Restore section.

Parts of the UI that are connected to the backup process can be found in the Backup menu documentation.

In order to restore parts or whole of a configuration, you need to first 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 may 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:

FieldDescription
Created dateDate and time of the exported file displayed in the timezone settings of the original backup system.
DescriptionThe description field's value, that has been entered during the original backup process. If left empty, nothing is displayed.
Created byUsername of the person creating the export (in raw text format).
App versionThe version number of the source Email This Issue instance
Jira versionThe 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

Anchor
restore
restore

Expand
titleRestoring 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.

Image RemovedImage Added

The restore configuration has four stages:

  1. Entity selection
  2. Conflict resolution
  3. Overview
  4. Import results


Note

Please note that 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.

Step 1. - Entity Selection

Anchor
entity
entity

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.).

Image RemovedImage Added

The entity items can be one of the following four:

  1. 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

Anchor
conflict
conflict

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.

Image RemovedImage Added


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.

Image RemovedImage Added

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.Image Removed

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

Image Added


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

Image RemovedImage Added

When selecting Overwrite existing entity, the a Select entity drop-down menu 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:

Image Added

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

Image Added

The below table specifies the required or optional attributes of every entity that may be restored during the restore process.

Image RemovedAttributes marked with an asterisk ( * ) are required to fill in:

Entity NameCreate New EntityOverwrite Existing Entity
Email TemplateEntity 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*
NotificationsEntity name*Select existing entity from the dropdown list*
Canned ResponsesEntity name*Select existing entity from the dropdown list*
Field Rules

Select a project

Select an issue type

Select existing entity from the list
Distribution ListsEntity name*Select existing entity from the dropdown list*
SMTP ConnectionsEntity name*Select existing entity from the dropdown list*
Mail AccountsEntity name*Select existing entity from the dropdown list*
Mail HandlersEntity name*Select existing entity from the dropdown list*
NextGen Mail HandlersEntity 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 ConfigurationOnly overwriting an existing
configuration is available		No action needed
Purge ConfigurationsOnly overwriting an existing
configuration is available		No action needed
MD5 patternsNo action needed
Attachment Name FiltersNo action needed


After selecting how to resolve a conflict, you have to all conflicts, click on Check each time to see if the resolution have been successful or click on Cancel to cancel the process.If the resolution has been successful, a green 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 . All other entity items remain marked with a red circle until their respective conflicts are resolved. Conflicts already resolved are marked with a green checkmark:

Image Added

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

Info

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

Step 3. - Overview

Anchor
overview
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: type of the entity that is generated from the original scope of the import file
  2. Original entity name: name of the entity that is generated from the original scope of the import file
  3. Action: what will happen to the original entity (currently the options are to CREATE NEW or OVERWRITE EXISTING entity)
  4. Entity name after import: how the entity can be found after the import

Image RemovedImage Added


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. - Import Results

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