Versions Compared

Key

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

...

As of Xray v3.3, the importer only performs inline migration of data (i.e. Zephyr's Test issues are "moved" to Xray's Test issues).

Before using the

...

Zephyr Import tool

Before using the tool, please check the necessary requirements and also the existing features and its limitations.

...

  • 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
  • Defect issue types used in 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
  • The only mandatory field in Xray's Test, Test Execution and Test Plan should be the issue Summary and issue Reporter
  • Make sure that the Jira workflow states, that are being used by "Zephyr Test" issue type, are editable. Click here for the official Jira documentation on this subject.
  • We strongly recommend you to make a 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 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.

...

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
  • 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 configurations
  • 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.

...

Then, you need to choose the project where to perform the migration; this will be same where the Xray entities will be created in. 

You may finetune fine-tune the process bye by (un)checking some flags:

  • Links between requirements and tests to respective Xray Issue Link Type used for requirement coverage: creates the link Xray uses for tracking coverage between Tests and requirements; by default Xray used the "tests" issue link type
  • Zephyr Cycles to Xray Test Plans: creates Test Plans based on Zephyr Cycles
  • Zephyr Ad Hoc Cycles to Xray Test Plans: creates Test Plans based on Zephyr Ad Hoc Cycles

...

If Zephyr Cycles to Xray Test Plans and Zephyr  Zephyr Ad Hoc Cycles to Xray Test Plans are unchecked then no Test Plans will be created; nevertheless, Test Executions will always be created if Zephyr Executions exist. 

...

At the end, a brief summary is shown mentioning the total number of Xray issues created and any warnings that occurred during the process.


Image RemovedImage Added


Please have a look at the following section for some additional steps before concluding the migration process.

...