Page History
...
| Note | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Before migrating from Xray Server/DC to Cloud be sure you've completed the steps recommended:
Ready for a Checklist? Make Sure you do not forget any step and download our Xray Migration from Server to Cloud Checklist.
Learn more at Migration Preparation. Also make sure you are aware of the differences between Xray Server and Xray Cloud. Be also sure, that if you select the Xray Cloud Standard you are aware of the storage limit and API rate Limit. If the storage and api rate limit, offered by Xray Standard is not enough, you might consider upgrading to Xray Enterprise. |
Migration Assessment
As in any other other move, you first need to make sure you run a comprehensive and complete assessment.
Ready for a Checklist? Make Sure you do not forget any step and download our Xray Migration from Server to Cloud Checklist.
Learn more at Migration Preparation. Also make sure you are aware of the differences between Xray Server and Xray Cloud. Be also sure, that if you select the Xray Cloud Standard you are aware of the storage limit and API rate Limit. If the storage and api rate limit, offered by Xray Standard is not enough, you might consider upgrading to Xray Enterprise. |
Migration Assessment
As in any other other move, you first need to make sure you run a comprehensive and complete assessment.
Avoid assessing and planning data migration too late on your migration journey. Xray is seemly integrated with Jira, so it'Avoid assessing and planning data migration too late on your migration journey. Xray is seemly integrated with Jira, so it's migration can be as complex as the Jira itself.
...
E.g., all the Tests in the Test Plans of Project A must be part of the migrated Projects.
| Warning |
|---|
Avoid data change during the migration, otherwise the migration might fail. |
Understand and Communicate the Limitations
Issue History and Test Run Activity
Due to the textual nature of the data in the activity logs, the entries are mostly copied directly. The language, phrases and markups may differ from server to cloud.
Migration drift not supported
All the linked data must be migrated together so data integrity can be guaranteed on the cloud.
Automated Step Library
Not supported by Xray Cloud and will not be migrated.
Cucumber settings
Will not be migrated to cloud. (Miscellaneous settings section)
Gadget Configuration
Configuration of Xray gadgets will not be migrated.
Xray Notifications
Xray Notifications (events) will not be migrated. Xray Cloud does not provide this feature.
Document Generator
Templates migrated from the Server must be revised once there are some differences between the server and cloud version.
Archived Issues
Xray data belonging to the archived issues are not migrated.
In the past we've seen migrations failing due to archived projects. Xray does not have visibility/permissions into these projects so please check if you are trying to migrate archived projects.
| Info |
|---|
If you want to migrate archived projects, you first need to unarchived them. Follow this article to understand how to check which projects are archived: [Xray] How to get all Archived Projects? |
Migration Preparation
creating, modifying, or deleting Issues related to Xray or connected projects during migration, as this can cause failures if more than 100 Issues are missing. Disable all automation and third-party app modifications to prevent exceeding this limit. Ensure all Jira projects are fully migrated; otherwise, Xray won’t find the expected Issues. Also, remove issue security schemes or set them to "Any logged-in user" before migration to avoid permission-related failures. |
Understand and Communicate the Limitations
Issue History and Test Run Activity
Due to the textual nature of the data in the activity logs, the entries are mostly copied directly. The language, phrases and markups may differ from server to cloud.
Migration drift not supported
All the linked data must be migrated together so data integrity can be guaranteed on the cloud.
Automated Step Library
Automated Steps Library will be migrated but you need to perform a re-index. Check more details on [Xray] Will the automated Automated Step Library be migrated to the Cloud when performing a migration from Server/DC to the Cloud using JCMA?
Cucumber settings
Will not be migrated to cloud. (Miscellaneous settings section)
Gadget Configuration
Configuration of Xray gadgets will not be migrated.
Xray Notifications
Xray Notifications (events) will not be migrated. Xray Cloud does not provide this feature.
Document Generator
Templates migrated from the Server must be revised once there are some differences between the server and cloud version.
Archived Issues
Xray data belonging to the archived issues are not migrated.
In the past we've seen migrations failing due to archived projects. Xray does not have visibility/permissions into these projects so please check if you are trying to migrate archived projects.
Project Level Settings
The project level settings get transferred when migrating from Xray Data Center to Xray Cloud (except for Default Column Layouts settings).
| Info |
|---|
If you want to migrate archived projects, you first need to unarchived them. Follow this article to understand how to check which projects are archived: [Xray] How to get all Archived Projects? |
Migration Preparation
Before hitting "Migrate" you need to Before hitting "Migrate" you need to perform some steps to avoid issues and unsuccessful migrations.
...
There are no more errors, meaning that the projects can be migrated together safely. We can now go back to the Jira Migration Assistant and plan our migration with both projects.
...
Preloading Xray Data Before Migration
...
that allows you to migrate Jira attachments in advance, saving you time on the migration day.
For more details about the steps required to preload the Xray attachments, please check these steps:
...
It is essential to have Xray version 7.8.2
...
or the latest installed, as this version includes the attachments feature. Additionally, you'll need to ensure
...
that JCMA (Jira Cloud Migration Assistant) is updated to version 1.
...
12.
...
16 or higher. Below is a step-by-step guide
...
on how the preload process works:
1. Install Xray version 7.8.2
...
or the latest
This version is
...
required as it introduces the attachments functionality.
...
2. Ensure JCMA version 1.
...
12.
...
16 or above is installed
...
|
...
Starting from JCMA 1.12.16, no feature flags are required. A new option, "Preloadable app data only," is now available on the projects screen.
- If this option does not appear, customers can contact Atlassian to enable the feature flag for them.
- For JCMA versions 1.12.13 to 1.12.15, customers must reach out to Atlassian to have the feature flag enabled manually.
3. Additional References
For more details on preloading app data before migration, refer to Atlassian's official documentation.
By following these steps, the preload process should work as expected, ensuring a smoother migration with minimal downtime.
| Info |
|---|
Go here to see more about Xray attachments. |
The Migration Process
Now that you've assess, plan an prepare the migration you are ready to go to Jira Cloud Migration Assistant and start the migration.
If you want to know how to start the migration please go to Atlassian Documentation.
Migrate All Users
It is recommended that you select the option "All users and groups from the Jira directory" when choosing which users to migrate in the Jira Migration Assistant. This is due to the way that Jira checks which users are related to a project which will not consider users assigned to Test Runs.
Figure 5 - JMCA Users Migration
The Xray migration starts right after the Jira migration. While Xray is migrating projects, the Xray app screens/actions will be disabled until the end of the migration. Those screens will show a warning and an action to allow the user to see the current progress of the migration. This progress shows details about what is being done.
Figure 6 - Xray Blocked message in Tests
Xray Cloud also provides a page on the app administration section with all the migration plans in progress and done. Here the Jira administrator could see the history of migration and the ongoing migration plans. Learn more about this here.
Figure 7 - Migration Status
...
Unsuccessful Migrations
We are continuously working to improve and reduce the effort of migrating Xray to Cloud. Nevertheless, we recognise that issues may affect your migration that will cause a failure.
Our Migration Effort Score is rated by our customer as "Normal" and a big percentage of customers to do not face any blockers. The success depends on understanding and follow all the steps needed and tha data size anda complexity.
If the Xray migration is not successful during the Jira cloud migration plan, we highly recommend trying it again. Before trying again, make sure the cloud project is removed. If the issue persists, please contact our support in order to get help.
Most Common Reasons for Unsuccessful Migration
| Problem | Solution | Reference |
|---|---|---|
 Xray version is not compatible with Jira Cloud Migration Assistant | Upgrade Xray Version | |
| During the migration, there was a data change. | Re-run Migration and make sure there is no data change. | |
| Migration failed due to Archived projects | Unarchived the projects and migrated again. | |
| Migration failed due to Issue Security Scheme | Remove issue security schemes from projects before migration, or set issue security to "Any logged-in user."and then rerun the migration. | |
| Missing Permissions | Update the Xray app to 7.2.0 and later, or grant the "Browse Projects" and "Edit Issues" permissions to "Any logged-in user." | |
| Migration failed due to Missing Projects | Re-run the Migration and include all the projects that share dependency. | |
| Migration failed due to Xray issuetypes not matching | Re-run the Migration. But, before please check and rename all the Xray issues to match in both instances before the migration | |
 Xray Sub Test Execution is not installed on the Xray Cloud | Before the migration, please ensure that the Jira Sub-task is enabled, and then re-install Xray via the Health Check on the Jira Cloud. |
By following these steps, the preload process should work as expected.
| Info |
|---|
Go here to see more about Xray attachments. |
The Migration Process
Now that you've assess, plan an prepare the migration you are ready to go to Jira Cloud Migration Assistant and start the migration.
If you want to know how to start the migration please go to Atlassian Documentation.
Migrate All Users
It is recommended that you select the option "All users and groups from the Jira directory" when choosing which users to migrate in the Jira Migration Assistant. This is due to the way that Jira checks which users are related to a project which will not consider users assigned to Test Runs.
Figure 5 - JMCA Users Migration
The Xray migration starts right after the Jira migration. While Xray is migrating projects, the Xray app screens/actions will be disabled until the end of the migration. Those screens will show a warning and an action to allow the user to see the current progress of the migration. This progress shows details about what is being done.
Figure 6 - Xray Blocked message in Tests
Xray Cloud also provides a page on the app administration section with all the migration plans in progress and done. Here the Jira administrator could see the history of migration and the ongoing migration plans. Learn more about this here.
Figure 7 - Migration Status
Unsuccessful Migrations
We are continuously working to improve and reduce the effort of migrating Xray to Cloud. Nevertheless, we recognise that issues may affect your migration that will cause a failure.
Our Migration Effort Score is rated by our customer as "Normal" and a big percentage of customers to do not face any blockers. The success depends on understanding and follow all the steps needed and tha data size anda complexity.
If the Xray migration is not successful during the Jira cloud migration plan, we highly recommend trying it again. Before trying again, make sure the cloud project is removed. If the issue persists, please contact our support in order to get help.
Most Common Reasons for Unsuccessful Migration
| Problem | Solution | Reference |
|---|---|---|
| Xray version is not compatible with Jira Cloud Migration Assistant | Upgrade Xray Version | |
| During the migration, there was a data change. | Re-run Migration and make sure there is no data change. | |
| Migration failed due to Archived projects | Unarchived the projects and migrated again. | |
| Migration failed due to Issue Security Scheme | Remove issue security schemes from projects before migration, or set issue security to "Any logged-in user."and then run the migration again. |
| Info | ||
|---|---|---|
| ||
To learn more about migration from Xray Server to Xray Cloud you might want to take our dedicated course available for free at Xray Academy: Migration from Xray Server to Xray Cloud
|
...