Assets Backup Vault is an external resource, that enables accessing Assets backup even when Atlassian cloud is not accessible.
Table of Contents
| 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:
...
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:
...
| Info |
|---|
While deleting the backup from own database (e.g. MongoDB), the deletion may take up to 6 hours. |
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:
...
| Info |
|---|
Due to the rate limits of corresponding Atlassian REST API, performance of restore process is limited to ~1,000 objects per minute. For example, if a schema contains 90,000 objects, restore will take approximately 1.5 hours. Also, please keep in mind that if you start more than one parallel restore/migrations, it may also take long due to the Request per minute limitation of the corresponding Atlassian REST API. |
Restore with object icons
If this checkbox is checked, object icons will be restored (not Object Type icons).
| Note |
|---|
Restoring icons may take considerably longer! If a schema contains many objects, after backup is completed, icons will be backed up in background, which may take several hours, depending on the number of objects. Therefore, if you are trying to restore backup with icons immediately, icons may not be included in the restored schema. |
Restore object history
You can restore also the history of objects by checking the “Restore object history“ checkbox:
...
| Note |
|---|
Times in the restored history attribute will be always shown in CET (UTC+2) |
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:
...
| Info |
|---|
If you try to restore Object Type that has an attribute referenced to another Object Type (which you are not restoring), in such case the restored Object Type will lack the corresponding attribute. |
Existing schema
You can restore objects in the original/existing schema. By checking this option, you will see the following fields:
...
| Info |
|---|
If you restore a backup twice in the existing schema, even if you choose not to duplicate the objects, they will still be duplicated as the restored objects will have new IDs. |
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:
...
| Info |
|---|
If the schema which is being restored contains references to the users, which does not exist in another instance, the object attribute will be still restored but attribute value will be empty. Such empty attributes are by default hidden from an object view, unless manually edited. |
Migration of cross-schema references
After the objects are migrated, you can restore also references between schemas.
...
| Info |
|---|
Keep in mind that in case of large number of references, restoring may take hours and the references between the selected schemas (from the select list) will not be restored. |
Click the “Restore References” button to start restoring.
...
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:
...
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.
...
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:
...
| Info |
|---|
Full log is available for the restores and migrations performed after October 12th, 2023. For the restoes done before, the downloaded log will be empty. |
Restore History
All the restores, whether successful or unsuccessful will be shown in the History table on the main page of the app:
...
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.
...
| Note |
|---|
If schema contains many objects, restore may take long! |
Additional Remarks
| Note |
|---|
If you are migrating from Server to Cloud, the “Text“ attributes may contain more than 255 characters. In such case, after the migration, the objects containing more than 255 characters in this attribute, will not be restored. If this happens, you need to change the affected attribute type “Text“ to “Text Area“ on the Cloud and Restore only affected specific object types in the existing schema: https://twinit.atlassian.net/wiki/spaces/IB/pages/596476255/Restore+Migration+Guide#Existing-schema. |
...