See this in action in our Sanbox https://radbee-sandbox.atlassian.net
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 4 Next »

This feature is currently in Beta

we look forward to hear any feedback, requests, and questions. ( support@radbee.com )

We explain here:

  1. Migration: When you transfer your data from one Atlassian site to another, what steps to take so that your snapshots data stays intact. We will cover two scenarios:

    1. transferring only Confluence spaces to a new site

    2. transferring both Confluence spaces and Jira projects to a new site

  2. How to ensure you include all required snapshots data is your backups, so that you can recover fully if you need to restore your Confluence space.

  3. How to restore snapshots from backup

The Snapshots tools (for backup, restore, and migration) always need to be used along with the native Atlassian tools (for backup, restore, and migration).
The Jira data that is captured by the snapshots on your site is stored in Confluence. As such, it is backed up, restored, and migrated by the native Atlassian tools.
However, there is metadata information about your snapshots that the snapshots App uses to display correctly the snapshots on the pages, and to retrieve new snapshots.

The tools described on this page take care of that aspect of your backup, restore and migration. More specifically, here are the features that will be enabled by the steps described here:

  1. The page is ‘aware’ of the history of snapshots on that page. So the drop down list in DIFF is correct, and when showing a page historical version then the correct snapshots version is displayed.

  2. Snapshots retrieves and displays correctly the snapshots columns that are custom fields. As custom field ids may change when moving between Jira sites, snapshots needs to be informed about the new ids.

  3. As part of how the App works, each snapshot has information about the Jira from which the data was taken. New snapshots cannot be triggered from the new Jira, unless the information about Jira is updated inside each and every snapshot.

Migration between sites: Steps to follow

Here is how to use the snapshots migration tools, as part of a site migration flow.

👁️‍🗨️ The Snapshots tools are available to a Confluence administrator → Under the Snapshots App administration area.

Step

Notes

1

On source site

The steps on the source site should be carried out at the same point of time as , to ensure the Atlassian backup and the Snapshots backup are consistent

2

The tab: Backup or Export
Select the space or spaces you need to migrate, and generate a snapshots export file

A json file is generated. We’ll call this the snapshots export.

It contains metadata that snapshots needs for the restoration of data on the target site.
Keep this file for when the data is restored on the target site.

3

The tab: Export Jira Metadata

Download here a file with the Jira metadata required for snapshots.

This step is needed in the scenario where Jira is also moving to another site then the current one. If your Jira is not migrated, you can skip this step.

A json file is generated. We’ll call it the snapshots Jira metadata export.
It contains metadata about the Jira site that the source Confluence is connected to, and about the custom fields that are used as columns in your snapshots.

Keep this file for when the data is restored on the target site.

4

Using Atlassian native tools to migrate to the new site

Use Atlassian tools to transfer Confluence spaces and Jira projects to the target site.

5

On target site

6

Install the Snapshots App and setup connectivity with Jira

7

If using the Traceability extension for Jira Snapshots:

Install the Traceability extension for Jira Snapshots and setup connectivity with Xray

Once you complete the installation of the App(s), pages with Snapshot tables display the Snapshot table.
However not all features will work correctly. For example, the DIFF feature in Snapshot will not work and the historical versions will not display correctly.

8

Prepare the Jira metadata export (json file) for the migration

If Jira moved to a new site, prepare the Jira metadata export file for the migration. This file was generated on the source Confluence site in previous steps, and it needs to be augmented with data about the target Jira.

  1. Open the file and review the list of custom fields that are used by snapshots.

  2. Find the equivalent custom fields in your new Jira site.

  3. For each custom field:

    1. If the custom field id on the new Jira is identical to the one on the old Jira: you can leave the field “newJiraId” empty (or complete with the same id)

    2. If the custom field id on the new Jira is different from the one on the old Jira: complete the field “newJiraId” accordingly.

  4. You do not need to update any other field or element in the json.

In this example, two custom fields are appearing in Snapshots:

  1. The custom field “Approvers” retained its id, so the newJiraId field is left empty.

  2. The custom field “Comments_Automation” has a new id in the new Jira. That id was added manually by the administrator who carries out the migration.

{
  "fromJiraHost": "https://vdxtest.atlassian.net",
  "fromJiraCloudId": "a7ceb685-a4a1-4795-b2e0-5d6a24caba98",
  "customFieldsMapping": {
    "customfield_10003": {
      "oldJiraId": "customfield_10003",
      "oldJiraName": "Approvers",
      "newJiraId": ""
    },
    "customfield_10076": {
      "oldJiraId": "customfield_10076",
      "oldJiraName": "Comments Automation",
      "newJiraId": "customfield_10106"
    }
  }
}
9

The tab: Restore or Import
Upload the snapshots export file (generated on the source site by Snapshots)

This file is not modified manually. It is uploaded exactly as it was downloaded.
After this step some Snapshots feature will be recovered:

  1. The DIFF feature will show the complete history of the Snapshots.

  2. When reviewing historical versions of the page, the correct snapshot data is shown.

If Jira data did not move to a new site, the snapshots should be fully working now. If Jira moved to a new URL, you’ll need to proceed to the next steps.

10

The tab: Import Jira Metadata
Follow this step only if Jira data moved to a new site.

Use the modified Jira metadata export (json file) you prepared in earlier steps. Upload here and trigger the process.

After this step, snapshots should be fully functional:

  1. New snapshots can be triggered.

  2. Custom fields columns show their correct headers and values. If the custom field changed name- it will show the name on the new site.

Backup procedure: Steps to follow

This paragraph is coming soon

Backup procedure: Steps to follow

This paragraph is coming soon

Limitations, troubleshooting and upcoming improvements

Issue

Notes

1

Stickers are currently not migrated

This in scope for future release

2

  • No labels