[Xray Cloud] Migrating Xray Data Between two different Instances

Presently, to migrate Xray data across two different cloud instances, you'll need to perform a batch of exports and imports since we don't have a straightforward process that does it all. Not only that, but migration of project configuration like workflows and non-Xray custom fields and permissions are dealt by Jira itself and not Xray.

Usually, for that last part of data to be migrated, we recommend using Jira's method, as you can see here: Migrating from one Cloud instance to another Cloud instance.

First, we'd like to add that ultimately, all Xray data can be migrated, just not automatically, nor through Jira's method of transferring data. Complementing that, we also have a suggestion, XRAYCLOUD-4703, to analyze the possibility of adding a feature that allows the import of Xray's backup file.

If you deem it appropriate, please *Vote* for it so we can keep track of your interest and *Watch* it to receive updates.

Recommended Method

After using Jira's Backup and Restore Tool, you'll see that all Jira data of Xray issues were migrated, like the Issues' Summary, Descriptions, etc. That information is not Xray managed, nor is it located in Xray Servers, so it transfers during that process.

Now, what is left to do is transfer the remaining data. This is divided between three major groups, which we advised are migrated according to this order:

Xray's Issue Data : a Test's Test Steps, or Gherkin Definition; a Pre Condition's Details, etc.;
Xray's Issue Relations : the association between a Test and a Test Set, a Test and a Test Execution, a Test Execution and a Test Plan, etc.;
Xray's Execution's Data : all Test Run data that allows the Test Run Status and subsequent features to be calculated.

The whole first point and part of the second point can be migrated by exporting the data with Xray's Document Generator, a built-in feature that allows you to customize templates and generate documents regarding Xray data and issues, which includes some Jira issues configured as requirements, and defects. You can check this Knowledge Base article about Export and import tests: Cloud/Cloud. There, you can download a base template that you can adapt to export Test, Test Set, and Pre-Condition Data and its relations.

Having the data exported to an XLSX file, you can easily convert it into a CSV file to use Xray's Test Case Importer.

*Note:* The whole operation will require a lot of manual processes because, in some cases, the exported information needs to be adapted to the formats supported.

For instance, for the CSV file to import correctly, its structure must follow the example found here: Importing Tests using Test Case Importer - Preparing the source file.

Finally, the remaining Relations and the Test Run's Data should be transferred performing exports and imports with REST API and Xray's GraphQL API. This method is necessary because this data is not saved in Custom Fields but by our field entities, which cannot be handled by default export methods nor default REST API.

DISCLAIMER: This is not the only possible method, and you can decide and successfully migrate the data using another method. Yet, this is the analysis and strategy we recommend you follow.

Content

Space Tools

Recommended Method

Related articles