Versions Compared

Key

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

Jira Datacenter supports archiving of issues and projects since  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 searchessearch resultsThis enhances Jira performance because it stores less data in the indexes.

As many of the Xray entities are normal Jira issues, it already supports this feature at some extent. So, archiving its issue types issue objects, archiving its issues has the same effect of archiving any other Jira issue type - namely archived issues no longer appear on JQL search results and on reports. Additionally. But additionally, Xray extends this feature by archiving or removing some of its internal data.

The goal of this page is to describe the behaviour effects of Xray whenever its issues are archivedarchiving 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.

Archiving Test Execution issues will hide them from:

Archiving a Test Execution will also archive its Test Runs.

Archiving Test Runs

Archiving a Test Execution issue automatically archives its related Test Runs as wellArchiving Test Runs Doing so will not delete the Test Run information from database, they are just hidden from issue views, reports, gadgets and are no instead they will be:

  • 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

...

A message will be shown in the Test and Test Execution issue view informing there are archived Test Runs:

Image Added

And also in the execution page:

Image Added

Test Runs archived via Test Execution issue can be restored at any time by restoring the Test Execution issue.

Archiving Tests

Archived Test issues:

Archiving a Test will also archive its Test Runs.

Archiving Test Runs

Archiving a Test issue will also archive its

Archiving Tests

Archiving a Test issue automatically archives its related Test Runs with the same effects described on the previous section. Additionally, archived Tests are no longer used for the calculation of the Requirement Status and are hidden from the Requirement Test Coverage analysis, Test Plan Overall Execution Status bar and any other kind of analysis involving these Tests.

Archiving Test Plans

Effects of Issue Archiving on Xray built-in reports and gadgets

Archived issues and test runs no longer appear on reports, gadgets ...

Effects of Issue Archiving on Xray Document Generator exports

Archived issues and test runs no longer appear on documents exported by docgen ...

Effects of Issue Archiving on the issue data tables sections

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:

Archived Test Plans will also no longer be used as scope for the Test Run Status and Requirement Status.

Effects in the Test Run and Requirement status scope

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 R that was NOK in the scope of TP will be UNCOVERED for the same scope TP.

Another effect 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:

Image Added

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 will be excluded from:

Archiving Requirements will also archive their Sub-Test Executions.

Archiving Sub-Test Executions

Each issue is archived along with all its subtasks.

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:

Archiving Projects

When archiving a Project all its issues are archived as well, including the Xray ones.

The effects of project archiving 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.

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 links.

Whenever issues are archived, those will no longer be present on JQL search results.

Due to the fact that Xray Issue Data Table components, used for presentation of Xray issue associations, are built on top of JQL searches 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 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. The below image shows an example of the Test Sets section in a Test issue view after archiving one of its related Test Sets.

Image AddedWhenever an issue is archived it is removed from the Lucene indexes and thus no longer appears on JQL search results. This has impact on some of the Xray issue data tables used to present the associations between issues.