Page History
...
The goal of this page is to describe the effects of archiving issues on Xray.
| Table of Contents |
|---|
...
Archiving Test Executions
...
| Info |
|---|
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. |
...
- Test Executions section of the Test Plan issue view
- Xray built-in reports and gadgets
- Document generator exports
- Search results from Xray JQL functions
Archiving a Test Executions Execution will also archive its Test Runs.
...
- Read-only: You will still be able to navigate into the execution page and see the execution results but will not be able to edit
- No longer used for the calculation of the Test Run Status and Requirement Status
- Omitted from the Test Runs section in the Test and Test Execution issue view (including Overall Execution Status bar)
- Hidden from the execution inner tables in the Tests section of the Test Plan
- No longer used for the calculation of the Test Run Status and Requirement Status
- Hidden Excluded from Xray built-in 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 Tests
Archived Test issues:
- No longer participate in the calculation of Requirement Status
- Are no longer taken in account in the Test Coverage
- No longer appear in the Tests section in the Test Plan (including Overall Execution Status bar), Test Set and Pre-Condition issue view 1
- Are hidden from Test Repositories and Test Plan Boards
- Are hidden excluded from Xray built-in reports, gadgets and document generator exports
- No longer appear in search results from Xray JQL functions
Archiving Tests a Test will also archive its Test Runs.
Archiving Test Runs
Archiving a Test issue also automatically archives its will also archive its related Test Runs with the same effects described previously when archiving via Test Execution issue.
Test Runs archived via Test issue can be restored at any time by restoring the Test issue.
...
Archiving Test Plans
Archiving Test Plans will hide them from:
- Test Plans section in the Test issue view 1
- Xray built-in reports, gadgets and and document generator exports
- Search results from from Xray JQL functions
Archived Test Plans will also no longer be used as scope for the Test Run Status and Requirement Status.
...
Archived Test Plans are no longed used as scope for the Test and Requirements status custom fields, which affects the scope analysis of Requirements and Tests: After archiving a Test Plan TP, a given requirement Requirement R that was NOK in the scope of TP will be UNCOVERED for the same scope TP.
...
An archived Test Plan issue can be restored anytime, doing so will retrieve the Test Plan state prior to archiving and all of the Test Plan-scoped statuses for Tests and Requirements.
...
Archiving Requirements
Archived requirements Requirements will be excluded from:
- Xray built-in reports and and gadgets
- Document generator exports exports
- Search results of of Xray JQL functions
Archiving requirements Requirements will also archive their Sub-Test Executions.
...
In case a Requirement is archived, its Sub-Test Executions will be archived as well. A Sub-Test Execution has the same functionalities of a Test Execution so archiving them have the same effect as archiving a Test Execution issue, namely all its Test Runs will be archived.
...
Archiving Test Sets and Pre-Conditions
...
Archived Test Sets and Pre-Conditions will be excluded from:
- Xray Xray reports and and gadgets
- Document generator exports exports
- Search results of of Xray JQL functions
- Test Sets and Pre-Condition sections in the Test issue view 1
...
Archiving Projects
When archiving a Project all its issues are archived as well, including the Xray ones.
The effects of project archiving on Jira and Xray will be the same as archiving issues.
For example, the archived issues will no longer be present on JQL results and if Test or Test Executions are found, Xray will also archive their internal data, namely its Test Runs.
The latter can be a long running task depending on the amount of Xray data to handle, but currently there is no easy way of knowing the progress of it.
In case you need to know the overall progress of the project archive, you can refer to the below queries which will report the number of active/archived entities.
On Project archive:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
--The below query returns the number of non-archived test runs in the project. Once it reaches 0, all test runs where successfully archived. Replace <PROJ_KEY> with the project key.
SELECT count(*) as active_test_runs
FROM "AO_8B1069_TEST_RUN" tr
JOIN jiraissue exec_issue on exec_issue.id=tr."TEST_EXEC_ISSUE"
JOIN project p1 on p1.id=exec_issue.project
JOIN jiraissue test_issue on test_issue.id=tr."TEST_ISSUE_ID"
JOIN project p2 on p2.id=test_issue.project
WHERE (tr."ARCHIVED" = 'N' or tr."ARCHIVED" IS NULL)
AND (p1.pkey = '<PROJ_KEY>' OR p2.pkey = '<PROJ_KEY>')
--The below query returns the number of active tests in test repositories and test plan boards. Once it reaches 0, all tests where successfully hidden. Replace <PROJ_KEY> with the project key.
SELECT count(*) as active_tests
FROM "AO_8B1069_LEAF" leaf
JOIN jiraissue test on test.id=leaf."TEST_ID"
JOIN project p1 on p1.id=test.project
WHERE (leaf."ARCHIVED" = 'N' or leaf."ARCHIVED" IS NULL)
AND (p1.pkey = '<PROJ_KEY>') |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
-- The below query returns the number of non-archived test runs in the project. Once it reaches 0, all test runs where successfully archived. Replace <PROJ_KEY> with the project key.
SELECT count(*) as active_test_runs
FROM AO_8B1069_TEST_RUN tr
JOIN jiraissue exec_issue on exec_issue.id=tr.TEST_EXEC_ISSUE
JOIN project p1 on p1.id=exec_issue.project
JOIN jiraissue test_issue on test_issue.id=tr.TEST_ISSUE_ID
JOIN project p2 on p2.id=test_issue.project
WHERE (tr.ARCHIVED = 'N' or tr.ARCHIVED IS NULL)
AND (p1.pkey = '<PROJ_KEY>' OR p2.pkey = '<PROJ_KEY>')
-- The below query returns the number of active tests in test repositories and test plan boards. Once it reaches 0, all tests where successfully hidden. Replace <PROJ_KEY> with the project key.
SELECT count(*) as active_tests
FROM AO_8B1069_LEAF leaf
JOIN jiraissue test on test.id=leaf.TEST_ID
JOIN project p1 on p1.id=test.project
WHERE (leaf.ARCHIVED = 'N' or leaf.ARCHIVED IS NULL)
AND (p1.pkey = '<PROJ_KEY>') |
On Project restore:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
--The below query returns the number of archived test runs in the project. Once it reaches 0, all test runs where successfully restored. Replace <PROJ_KEY> with the project key.
SELECT count(*) as archived_test_runs
FROM "AO_8B1069_TEST_RUN" tr
JOIN jiraissue exec_issue on exec_issue.id=tr."TEST_EXEC_ISSUE"
JOIN project p1 on p1.id=exec_issue.project
JOIN jiraissue test_issue on test_issue.id=tr."TEST_ISSUE_ID"
JOIN project p2 on p2.id=test_issue.project
WHERE tr."ARCHIVED" = 'Y'
AND (p1.pkey = '<PROJ_KEY>' OR p2.pkey = '<PROJ_KEY>')
--The below query returns the number of archived tests in test repositories and test plan boards. Once it reaches 0, all tests where successfully restored. Replace <PROJ_KEY> with the project key.
SELECT count(*) as archived_tests
FROM "AO_8B1069_LEAF" leaf
JOIN jiraissue test on test.id=leaf."TEST_ID"
JOIN project p1 on p1.id=test.project
WHERE (leaf."ARCHIVED" = 'Y')
AND (p1.pkey = '<PROJ_KEY>') |
...
| language | sql |
|---|---|
| title | MySQL |
| collapse | true |
...
.
...
Impact on Xray Issue Links
| Info |
|---|
| This section refers to the Xray custom issue links only (e.g. Tests associated with Pre-Conditions, with Test Sets, etc.) and not to the Jira native issue link featurelinks. |
Archiving issues do not archive the associations between Xray issues: for instance an active Test issue is still associated with an archived Test Set issue.
Whenever issues are archived, those will no longer be present on JQL search results.
Due to the fact that However, due to the fact that archived issues are no longer present on Lucene indexes and some Xray Issue Data Table components used to display information about the issue links , used for presentation of Xray issue associations, are built on top of JQL searches , these will no longer show the archived associated issues.and that archived issues no longer appear in those search results, the links will no longer be shown in some issue views. Because of that, there is no way to know if an issue is still linked to an archived one.
Whenever this Whenever that happens, a warning message will be displayed at the top of the affected Xray Issue Data Table informing that some associated issues are being hidden from the UI. The below image shows an example of the Test Sets section in a Test issue view after archiving one of its related Test Sets.
