Introduction
Requirement Coverage in Xray allows project administrators to define which Issue Types are considered Requirements and how they relate to sub-requirements. By customizing these settings, teams can ensure accurate traceability between test results and project requirements.
Project admins can:
- Enable or disable Requirement Coverage at the project level.
- Customize Issue Type mapping, defining which Jira Issue Types act as Requirements.
- Configure sub-requirement relationships, either using issue links or sub-tasks.
- A project re-index operation is necessary to retain the accuracy of Xray Reports when there are changes to Requirement Issue Type Mappings (if this is the case, Xray will prompt you).
- When changing the Sub-Requirements hierarchy, previously calculated requirements might need to be recalculated. This can be accomplished by performing a re-index.
- By default, each project inherits the globally-defined Requirement Issue Type mapping settings. However, project admins are able to override the global settings by configuring Requirement Coverage at the project level directly.
- All the Requirement Coverage project settings will be transferred during a migration from Server/Data Center to Cloud.
Access
In your Jira Server/DC instance, click the settings/gear icon (Figure 1 - 1) and select Projects (Figure 1 - 2).
A list of projects appears (Figure 1 - 3). Click the project you wish to work on.
Figure 1 - Settings
An Xray Settings menu will appear on the left side of the screen. There, click Requirement Coverage (Figure 2 - 1). The Requirement Coverage page will open (Figure 3).
Figure 2 - Requirement Coverage
In the Requirement Coverage screen (Figure 3) you can edit the different fields (Figure 3 - 3; 2; 4; Figure 4 - 1) to customize your experience.
Figure 3 - Requirement Coverage
Once you've finished editing, click Save (Figure 4 - 2).
Figure 4 - Requirement Coverage
Operations
Enabling Requirement Coverage
To enable Requirement Coverage for a project, please use the Requirement Coverage toggle (Figure 3 - 1).
By enabling Requirement Coverage, you are effectively adding the project to the Requirement Projects list.
If you override the Requirement Coverage settings, it won't affect the existing Test results (but all Issues are affected). No recalculations are triggered automatically.
Overriding Issues
Issue Type Mapping
Besides being able to enable or disable Requirement Coverage, project admins can also override the Global Issue Type mapping for Requirement Issues.
There, use the toggle (Figure 3 - 2) to override the Global Issue Type mapping.
Once enabled, the Issue Types can now be configured as Requirements by dragging from the Available Issue Types list (Figure 3 - 3) to the Requirements Issue Types list (Figure 3 - 4).
Xray Issue Types (Test, Test Plan, Test Set, Test Execution, Sub-Test Execution, and Precondition) must not be mapped as Requirements.
Sub-Requirements (Figure 4 - 1)
Along with Requirement Issue Types, by overriding the Global Issue Types for Requirements, project admins can also configure the relation between Requirements and Sub-Requirements Issues.
A single Issue Type can be mapped as both a Requirement and a Sub-Requirement.
There are no limitations on which Issue Types can be mapped as Sub-Requirements.
In this section (Figure 4 - 1) you can define how Requirements and Sub-Requirements are associated (only one of these options can physically be selected at a time).
If the Jira link mechanism is used, then the Issue Link Type must be chosen as well as the direction from the parent Requirement to the child Requirement. If Sub-Tasks are used, then simply check the Use Sub-Tasks Issues option.
The Sub-Task Requirement Issue Types must also be associated with Requirements in the Issue Type Mapping section.
Sub-Task Issues
When this option is enabled, Sub-Requirements are associated with Requirements by Sub-Task Issues. When this option is disabled, Sub-Requirements are associated with Requirements with Issue links configured below.
Epic - Story
When this option is enabled, Story Issues are associated with Epic Issues as Sub-Requirements.
Issue Link Type
If Sub-Requirements are not defined as sub-tasks, you can configure a Jira link to define this association. Select the Issue Link type for the Requirement - Sub-Requirement relationship.
Direction
Select the Link Direction for the parent > child relationship of the Requirement > Sub-Requirement.
Once you're done editing, click Save (Figure 4 - 2).