Jira Datacenter supports archiving of issues and projects since v8.1. By archiving issues, Jira will remove them from the indexes. The archived issues will still be accessible in read-only mode, however, they will not appear in search results. This enhances Jira performance because it stores less data in the indexes.
As many of the Xray entities are normal Jira issue objects, archiving its issues has the same effect of archiving any other Jira issue type. But additionally, Xray extends this feature by archiving some of its internal data.
The goal of this page is to describe the effects of archiving issues on Xray.
What happens when Test Executions are archived?
Archived Test Execution issues no longer appear:
- In the Test Executions section of the Test Plan issue view
- In Xray reports and gadgets
- In document generator exports
- In search results from Xray built-in JQL functions
Archiving of Test Runs
Archiving a Test Execution issue automatically archives its related Test Runs. Doing so will not delete the Test Run information from database, instead they will be:
- Read-only
- Omitted from the Test Runs tables in the Test and Test Execution issue view
- Still be possible to navigate into the execution page and see the execution results
- No longer used for the calculation of the Test Run Status and Requirement Status
- Hidden from Xray reports and gadgets
- Hidden from document generator exports
Test Runs archived via Test Execution issue can be restored at any time by restoring the Test Execution issue.
Archiving old Test Executions is a good use case for archiving Xray issues, especially if continuous integration processes are used. These can quickly create many Test Execution issues while importing new execution results into Xray on a daily basis. These issues are good candidates to be archived.
What happens when Tests are archived?
Archived Test issues:
- No longer participate in the Requirement Status calculation
- Are no longer taken in account in the Test Coverage
- No longer appear in the Tests section in the Test Plan, Test Set and Pre-Condition issue view
- Are hidden from Test Repositories and Test Plan Boards
- Are hidden from Xray reports, gadgets and document generator exports
- No longer appear in search results from Xray built-in JQL functions
Archiving of Test Runs
Archiving a Test issue also automatically archives its related Test Runs with the same effects described on the previous section.
Test Runs archived via Test issue can be restored at any time by restoring the Test issue.
What happens when Tests Plans are archived?
Archived Test Plans:
- Are no longer used as scope for the calculation of Test Run Status and Requirement Status
- No longer appear in the Test Plans section in the Test issue view
- Are hidden from Xray reports, gadgets and document generator exports
- No longer appear in search results from Xray built-in JQL functions
Effects in the scope analysis
Archived Test Plans are no longed used as scope when analysing Test and Requirements statuses.
One of the effects of not being used as scope is that the Latest Statuses of Tests under a Test Plan issue will not be shown anymore. For this reason, when archiving a Test Plan, a message will be displayed informing of the situation:
An archived Test Plan issue can be restored anytime, doing so will retrieve the Test Plan state prior to archiving and all the Test Plan-scoped statuses for Tests and Requirements.
What happens when Requirements are archived?
What happens when Test Sets and Pre-Conditions are archived?
What happens when Projects are archived?
When archiving a Project its issues are archived as well. If any Test or Test Execution is found, Xray will archive its internal data, namely the Test Runs will be archived and the Tests will be hidden from the Test Repository and Test Plan Boards.
This can be a long running task depending on the amount of Xray internal data to handle. Currently, Jira provides no way of knowing the progress of a project archival. However you can use this: