Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Zephyr >= 4.0.0
  • Zephyr and Xray should be both installed
  • project where migration is being done must have Xray issue types (at least the Tests, Test Executions and Test Plans)
    • you may use the "Add Xray Issue Types" action shortcut available in the project settings page
  • requirement issue types used in Zephyr must be configured in Xray
  • defects issue defect issue types used in Zephyr  Zephyr must be configured in Xray
  • create similar Test Statuses and Test Step Statuses in Xray; this is not mandatory but may ease the process, which will always ask you to make the mapping between Zephyr statuses and Xray counterparts
  • make sure Zephyr is using different issue links between Test<=>Defect and Test<=>Requirement, by going into Zephyr's configuration settings
  • Do not change, create or delete any issue in the Project while the importation is running
  • We strongly recommend you to make a Backup backup of your Jira instance before doing the importation.

...

Info
titlePlease note

The current process performs an inline migration, i.e. Tests and data is migrated to Xray and the original entities are "lost".

Thus, we recommend to backup your JIRA Jira instance before performing the migration.

Also, as the amount of data to migrate may be considerable large, we advise you to perform this on non-working hours. Please also make sure that users are not changing data on the project while the migration is being done.

...

Most information will be migrated seamless seamlessly but please check the following table in more detail.

...

Supported FeaturesUnsupported

Inline migration (not cloning) of:

  • Test and Test steps
  • Test and Test step attachments
  • Links between Tests and Defects/Requirements
  • Cycle
    • including Cycle folders*
  • Executions
    • defects (global and step level)
    • attachments (global and step level)
    • result (global and step level)
    • comments (global and step level)
    • assignee

(*) Cycle folders will be migrated to Test Executions, since the semantics on Xray are a bit different in terms of entities/organization.

  • All Zephyr executions from the Ad-hoc cycle; only the last Execution is migrated
  • Custom fields in Test steps and on the Execution
  • Activity information
  • Test Statuses and Test Step Statuses
  • Cycle folders as such*
(*) Cycle folders will be migrated to Test Executions, since the semantics on Xray are a bit different in terms of entities/organization.


How it works

Within this section you're able to find the exact mapping of entities from Zephyr to Xray.

Mapping of information

Zephyr entityXray entityNotes

Test

  • steps
  • attachments

Test

  • steps
  • attachments
  • if empty, the "Step" column will be filled with "<undefined>"
Cycle

Test Plan (optional)

  • Summary: <version> - <cycle's name>
  • fixVersion: version assigned to Cycle

Test Execution, linked to the previous Test Plan

  • Summary: <version> - <cycle's name>
  • fixVersion: version assigned to Cycle

The Test Execution created here will contain the Executions assigned directly to the Cycle, since in Zephyr you can have Executions at that level besides on each folder.

Please note that...

  • if the Cycle contains multiple Executions for the same Test, only the last Execution will be migrated
Cycle's folder

Test Execution, linked to the Test Plan created earlier from the Cycle

  • Summary: <version> - <cycle's name> - <folder> Execution
  • fixVersion: version assigned to Cycle

Ad-hoc Cycle

Test Plan (optional)

  • Summary: <version> - <cycle's name>
  • fixVersion: version assigned to Cycle

Test Execution, linked to the previous Test Plan

  • Summary: <version> - <cycle's name>
  • fixVersion: version assigned to Cycle

Execution

  • global comment
  • global defects
  • step results
  • step comments
  • step defects

Test Run

  • global comment
  • global defects
  • step results
  • step comments
  • step defects

Info
titlePlease note

All issues will be created in the project where the migration is being performed.


How to use

Migrating data Performing the migration is easy; however, it is currently limited to Jira administrators.

...

Suppose you have a project that you wish to migrate from Zephyr for Jira to Xray and that the requirements mentioned above are met.


To start the importation process:

  1. Log in with an administrator account;
  2. Go to System>Import and Export>External System > Import and Export > External System Import;
  3. Select Xray's Zephyr Importer.


Then, you need to ....




Upon successful connection, you can optionally define a label to assign to the Test issues that will be created. This may be quite useful if you need a quick way to identify the newly created issues. The label syntax is restricted in the same way as the label fields in Jira. We recommend using a unique label with numbers.

...