Table of Contents

To restore the desired backup of a certain Schema, click on the “Restore” button across the needed schema in the Synched schemas grid (see Backup Configuration | Synced schemas):

Clicking “Restore” button will navigate you to the page with the list of all the available backups and restore history.

Available Backups

Under Available backups, you will see all the backups for the selected schema:

For each backup you can see the following information and Actions:

• N

  • Order number of the backup

• Backup date

  • Date and time when the backup was completed

• Objects

  • Number of the object in the schema backup

• Type

  • Manual

  • Scheduled

• History status

  • Defined the status of the object history restoration (see Restore Object History for more details)

• Objects in issues status

  • Status of background backup of the objects in issue fields (see Restore Objects in Jira Issue Fields for more details)

• Actions

  • Select

  • Delete

You can also filter the backup with the Backup type (Scheduled or Manual) or the Date, by clicking Date control, which will display a calendar to choose a date or a date range:

If yet there are no backups of the schema, the list will be empty with the options either to manually backup the schema by clicking Backup now button or schedule backup by clicking Schedule button:

Delete Backup

With the Delete under the three dots along the backup, you can delete a certain backup by confirming delete in the following confirmation popup:

Restore

To restore the schema, select it by clicking Select button. You will see the information about the selected backup on the left side of the page and the Restore options - on the right (Destination):

By selecting the corresponding option under Destination, you can restore the schema on the current instance in a new or an existing schema or migrate it to another instance.

Current instance

To restore the schema on a current instance, choose a new schema name and key, where the schema should be restored in (the schema will be automatically created) and click Restore and Confirm buttons, which you will see in the confirmation popup. After the restore starts, the status will be shown in the right pane Destination) and Restore history:

The Status of the restoration can be:

• Restore pending

• 

  Restore in progress

• 

  Restore completed

  • If the restore was completed successfully, you will see “Operation success“ message by clicking the Result message:

• 

  Restore Error

  • If the restore was not successful, you will see the error message by clicking the Result message:

• 

  Restore completed:

• 

Restore with object icons

If this checkbox is checked, object icons will be restored (not Object Type icons).

Restore object history

You can restore also the history of objects by checking the “Restore object history“ checkbox:

If checked, after the schema is restored, object history will be restored in a newly created attribute: OBJECT_HISTORY.

Restore specific Object Types

You can also restore the Schema not completely, but only certain Object Types, including Objects. To do so, check “Restore specific Object Types” checkbox and the list of all the Object Types from the backup will show up:

You can Expand and collapse the parent Object Type(s) by clicking the arrow and select child Object Type(s) from the list by clicking the corresponding Checkbox:

Existing schema

You can restore objects in the original/existing schema. By checking this option, you will see the following fields:

• Schema

  • A dropdown will show the list of the existing schemas on the instance, from where you can choose a schema you want the objects to be restored in:

  • 

• Duplicate Objects

  • This option deals with the cases when objects that need to be restored already exist in the existing schema (Object IDs are used for matching)

    • If checked: Duplicate objects will be created

    • If unchecked: Duplicate objects will NOT be created

• Restore with object icons

  • Same as for Current instance - see above

• Restore specific Object Types

  • Same as for Current instance - see above

Migration on another instance

You can migrate a backup from the current to another instance. To do so, select the “Restore on another instance” option, choose a Target instance and enter a unique Schema name and key:

Under the Targe instance dropdown, you will see the instances that were added to the List of target instances under the current connection. You can identify and select the added target instance by name and the URL:

Also, from the same window, you can choose to add a new target instance, by filling the same information as while adding a new target instance under the current connection. Select New target instance in te dropdown to see the necessary fields to fill in:

After Migration is started, you will have a chance to save the newly added instance to the List of target instances.

While migrating a schema to another instance, you can also use the “Restore with object icons“ and “Restore only specific Object Types“ options.

Migration of cross-schema references

After the objects are migrated, you can restore also references between schemas.

To restore the reference, click “Restore References“ button in a “Restores” grid:

After clicking the button, you will see the following popup:

From here you can choose the schemas (one or more) from which you need to restore the references in the current schema.

You can also choose to whether restore outbound references from the current schema to the selected ones by toggling the “Restore also outbound references” control:

Click the “Restore References” button to start restoring.

You can see the progress and the results of the references restore in the “Restores“ and “Restore History“ grids:

You can see the following information after clicking the downward arrow on the schema, which was created after the restore:

• Cross-schema references restore status with the following options

  • PENDING

  • IN PROGRESS

  • SUCCESS

  • ERROR

• Outbound references

  • YES or NO, indicating whether Outbound references restore was selected

• Referenced schemas

  • List of the schemas selected for the references restore

• Reference update message

  • In case of errors, clicking on the “Result message” will show the details of the error

Restores grid

After the restore is completed or failed, the restore will appear in the Restores grid for the certain backed-up schema:

The grid shows the following information:

• Schema

  • Name and link (if the restore/migration was successful) of the schema that was restored. You can click the schema name to directly go to the schema

  • Destination

    • Which option was used as a destination during the restore/migration:

      • Current instance

      • Existing schema

      • Another instance

  • Started

    • The date and time of the restore/migration was started

  • Ended

    The date and time of the restore/migration was Ended

  • Status

    • Status of the restore/migration. Can be:

      • Restore completed

      • Restore error

  • Result

    • Result of the restore. In case of error, you can click an error icon to identify the reason for the error:

      

    • If the “Restore objects in issues” is attempted for the restored schema, the result will show the fields validation results. Please refer to Restore Objects in Jira Issue Fields for more details

  • “Restore objects in issues” button

    • For more details refer to Restore Objects in Jira Issue Fields to restore the objects in the issues of the current instance or to restore objects in the migrated issues from DC to Cloud or from Cloud to another Cloud.

To view additional information regarding the restore, click the “down arrow” in the beginning of the schema row:

You can see the following information here:

• Restored from: the name and link of the original schema

• Restored to: the name and link of the restored schema

• History restored: YES/NO - whether history restore option was selected

• Icons restored: YES/NO - whether the “Restore icons“ option was selected

• Specific object types restored: YES/NO - whether the “Restore only specific object types“ option was selected during the restore

• Result message: the result of the restore. In case of an error, you can click an error icon to identify the reason for the error (see the screen above)

  • Download full log (.xlsx) - you can download full restore/migration log by clicking the button. More details: https://twinit.atlassian.net/wiki/spaces/IB/pages/596476255/Restore+Migration+Guide#Full-restore-log .

• Updated fields - List of the updated Jira custom fields

  • For this and the next two positions, please see Restore Objects in Jira Issue Fields for more details.

• Field update status

• Fields update date

Full restore log

You can download full restore log in .josn format, which will show detailed log of the restored objects or the error messages per certain object. The downloaded file contains:

• ObjectKey

  • Key of the Asset object

• Result

  • Restore status of the object

    • true: The object was restored

    • false: The object was not restored

• Message

  • { message: 'OK' } - if the message was restored

  • The certain error message of the object was not restored:

    • Example of the error messages:

      • OBJECTKEY-001 {"errorMessages":[],"errors":{"attribute-id":"The attribute '[attribute name]' has to be unique"}}

        • “Unique“ is checked in the General tab of the attribute configuration

      • OBJECTKEY-002 {"errorMessages":[],"errors":{"attribute-18718":"Invalid values ([attribute value])"}}

        • The attribute contains invalid value, e.g. text in the Integer attribute type

      • OBJECTKEY-003 {"errorMessages":[],"errors":{"attribute-18334":"[attribute name] - Text attribute value must be less than 255 characters long"}}

        • The “text“ type attribute contains more than 255 characters

Example of the log file:

[
    {
        "ObjectKey": "OBJECTKEY-001",
        "Result": true,
        "Message": "{ message: 'OK' }"
    },
    {
        "ObjectKey": "OBJECTKEY-002",
        "Result": true,
        "Message": "{ message: 'OBJECTKEY-002 {"errorMessages":[],"errors":{"attribute-id":"The attribute '[attribute name]' has to be unique"}}' }"
    }
  ]

Restore History

All the restores, whether successful or unsuccessful will be shown in the History table on the main page of the app:

Restores Grid shows the following information:

• Schema

  • Name of the schema restored or tried to be restored

  • For successful restore/migrations, the schema name is clickable and you will be navigated to the restored schema in Atlassian Assets.

• Destination

  • Current instance

  • Another instance

• Started

  • Date and time when the restore was started

• Ended

  • Date and time when the restore was finished

    • will be empty for unsuccessful restores

• Status

  • status of the restore

    • In progress: restore process is in progress.

    • Restore completed: restore was finished successfully.

    • Restore error: restore was not finished.

• Result

  • Result message: details of the result. Clicking the result message will show the details of the result.

• 

In addition, by clicking the downward arrow button on the left of the schema name, you can see more details regarding the certain restore:

The following additional details are available:

• Restored from

  • Name of the original schema (clickable, if the schema is on the same instance and is not deleted)

• Restored to

  • Name of the restored schema (clickable)

• History restored

  • YES/NO - whether the options was selected while restore

• Icons restored

  • YES/NO - whether the options was selected while restore

• Specific object types restored

  • YES/NO - whether the options was selected while restore

• Result message

  • Details of the restore result. Clicking the result message will show more details, particularly in case of failed restores.

Additional Remarks