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 Jira searches. This enhances Jira performance because Jira stores less data.
This page describes the known impact and limitations of archiving issues in Xray.
We have plans to support the Jira archiving feature and even extend this feature so that Xray issues can be archived without some of the undesirable side effects that are described on this page. A good use case for archiving Xray issues, will be to archive old Test Executions, especially if continuous integration processes keep importing new execution results into Xray on a daily basis. This feature is on our Roadmap. |
For more information on archiving issues please visit JIRA documentation.
Even though the Test is read only, it still can be executed from the Test Runs section and the fields from the execution page can be edited (evidences, steps, comments, custom fields, etc).
The Test Execution will still contribute for the Test Run Status of the Test. However the Test Execution will not be listed in the Test Run Section of the Test and there will be no indication that an archived Issue is affecting the Test Run Status.
The Test Issue still contributes to the Requirement Status, even after reseting this custom field. However the Test is not included in the Test Coverage and there is no indication that an archived Test is affecting the Requirement Status.
When clicking on the link in the Requirement Status bar the Test will not be found in the JQL search.
In the Test Coverage Section we will not be able to perform the analysis in the scope of the archived Test Plan because the Issue will not be found in the selector. However, the Test Plan still contributes for the coverage.
When archiving a Test it will still contributes to the Overall Execution Status. However, the Test will not be listed in the Tests Section.
When archiving a Test issue it will still be included in the Overall Execution Status. However, it will be count with the wrong status (in the example bellow it should be FAIL) and will not be included in the Test list.
The Overall Execution Status bar of the Test Plan board behaves the same way.
Issue sections will not display the associated archived issue. Instead it will display an empty filtered table. See the example bellow for a Test associated with an archived Test Set.
This will affect the following Issue page sections:
There is an incorrect Test count if the archived Test is associated with a folder. Also the Test will be visible if associated with a folder, otherwise it will not appear in the orphans.
When archiving a Test it still being included in Tests count but the JQL link will not work.
According to JIRA documentation, archived Issues will no longer appear on the reports. This is not always the case for Xray reports.
According to JIRA documentation, archived Issues will no longer appear on dashboards. This is not always the case for Xray gadgets.
The archived Test is being included in the Total value but not on statuses.
Even though the Test is read-only, the Test Run can still be edited using the endpoints (PUT|POST|DELETE) /rest/raven/1.0/api/testrun/{id}/status/*.
see Test Runs - REST.
When Using GET /rest/raven/1.0/api/testrepository/<projectKey>/folders the archived Test is included in counts.
PUT and POST can also be executed, even though the Test Issue is read-only.
The cases noted in the table below are not necessary wrong, but due to their peculiarity deserve some reflection.
| JQL function | note |
|---|---|
requirements | The Requirement Status is still affected by the archived. It will return same results as if Test issue wasn't archived. |
requirementsWithStatusByTestPlan | The Requirement Status is still affected by the archived. It will return same results as if Test or Test Plan issue wasn't archived. |
testTestSet | Returns associated issues, even if issue passed as argument is archived. |
testTestSet | Returns associated issues, even if issue passed as argument is archived. |
testsWithNoTestSet | Returns associated issues, even if issue passed as argument is archived. |
testPreConditions | Returns associated issues, even if issue passed as argument is archived. |
preConditionTests | Returns associated issues, even if issue passed as argument is archived. |
testRequirements | Returns associated issues, even if issue passed as argument is archived. |
requirementTests | Returns associated issues, even if issue passed as argument is archived. |
testExecutionTests | Returns associated issues, even if issue passed as argument is archived. |
testTestExecutions | Returns associated issues, even if issue passed as argument is archived. |
testSetPartiallyIn | Returns associated issues, even if issue passed as argument is archived. |
testSetFullyIn | Returns associated issues, even if issue passed as argument is archived. |
testPlanTests | Returns associated issues, even if issue passed as argument is archived. |
testPlanTestExecutions | Returns associated issues, even if issue passed as argument is archived. |
testPlanRequirements | Returns associated issues, even if issue passed as argument is archived. |
testTestPlan | Returns associated issues, even if issue passed as argument is archived. |
There is a peculiarity with the following entries of the Xray Integrity Checker
Let's take the example of an archived Test Set with associated Tests. Running the clear Test Count will clear the value for the issue and, after opening the archived Test Set issue, the value will not be recalculated because the issue is read-only.