If you are upgrading from a version lower than 3.2, this implies that an upgrade task will run to pre-calculate historical data. This is a one-time action that will run in the background so that Xray is still available during the upgrade. A  re-index operation of your Jira instance is required so that the internal data becomes searchable and usable by Xray.

If you are upgrading from v3.2.x or v3.3.x to v6, you must recalculate data in the Xray configuration section → Custom Fields. This recalculation is necessary because of the huge improvement in the amount of data that Xray needs to add to the table and to the Lucene indexes.

Downgrading from Xray 5.x.x to a previous version will have the following side - effects on Test Runs with a dataset:

• Test parameters will no longer be converted on the Test Run page, this includes Test Step definitions and Pre-Conditions;
• When loading a Test Run created on version 5.x.x, the merge/reset message will be displayed;
• When merging a Test Run created on version 5.x.x with the new Test Step definition, all Test Step results will be updated, but the reset/merge message will still be displayed;
• A Test Run created on version 5.x.x with iterations will be displayed in a "flat mode." The iterations will no longer be available, and all the Test Step results from each iteration will be presented on in the Test Steps section;
  
• After the downgrade, the integrity checker will fail on "Check for invalid Mementos" for all Test Runs created on version 5.x.x. We recommend running the integrity checker before downgrading to get rid of eliminate possible invalid mementos.

Downgrading from Xray 6.x.x to a previous version will have the following side - effects:

• Test Issue:
  • A Call Test will be converted to a regular test step with a warning message
    
• Test Run Page
  • The Merge/Reset action will be displayed

The Test Step Custom Fields and Test Run Custom Fields of the type "User Picker" will have to be deleted in the project configuration as they are not supported. Following that, the Test Runs that are using a User Picker field will have to be merged or reset. This includes Test Runs that have the field for the Test Run itself and also Test Runs for Manual Tests where the Test Steps contained the User Picker field.

Downgrading from Xray 6.x to a version less than 3.2.0 implies that you must perform performing a re-index afterward. This is because from Xray 3.2.0 onwards, the content and format of what Xray indexes have changed.

Historical Coverage Gadget

Some configuration parameters for this gadget were modified as a result of supporting multiple projects whenever using a saved filter as a source. It is possible that some users will get errors on the gadget after downgrading from 4.x. If this happens, please edit the configuration to ensure the gadget is configured properly.