Page History
...
| Note |
|---|
To use this report, you must enable Requirement Coverage for your project. |
The Xray Requirement Traceability report shows the Requirements traceability through Tests, Test Runs, and Defects.
This report enables you to follow the life of a Requirement in both forward and backward directions (i.e., from its origin all the way through Tests, Test Runs, and Defects). It facilitates the analysis of the overall Requirements coverage status.
...
- Make full traceability analysis, from Requirements <=> Tests <=> Test Runs <=> Defects.
- Evaluate the Requirement status for a given version and see all linked (open/closed) Defects.
- See the Tests and Test Runs that cover each Requirement, and analyze how that contributes to the overall Requirement status.
- Analyze the Requirements and related Executions and Defects in a given Test Environment.
- See what Defects are impacting the Requirements or a subset of the Requirements of a specific version.
Operations
Report Access and Usage
With the Requirement Coverage Already Enabled
| UI Steps | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
Without the Requirement Coverage Enabled
If you are working on a Project that doesn't have the Requirement Coverage enabled, and try to access the Requirement Traceability report, you will see a warning (Figure 5 - 1).
To be able to access/generate a Requirement Traceability report, you have to enable the Requirement Coverage for that project first.
Figure 5 - Disabled
Reading the Report
At the top of the Requirement Traceability report, you'll find three areas related to the report and with the data shown in the reportthere:
- Figure 4 - 1: analysis and scope, for choosing how to analyze the entities.
- Figure 4 - 2: filter, for selecting the source data.
- Figure 4 - 5: visualization information and options.Figure 4 - 3: quick filter based on calculated coverage for the defined scope on Figure 4 - 1.
- Figure 4 - 4: main report areas.
- Figure 4 - 5: report visualization information and options.
Source Data
Source Requirements Issues can be directly provided (Figure 4 - 2) using the Requirement fields configured in the Basic tab (Figure 5 6 - 1) or the JQL written in the the Advanced tab (Figure 5 6 - 2).
| Info | ||
|---|---|---|
| ||
Cross-project reports is an Xray Enterprise feature. If you do not have Xray Enterprise installed, the project filter is not available, and this report can only be generated with a single project. If you haveXray Enterprise, it is mandatory to select at least one project before generating the report. |
Figure 5 6 - Fields
By default, the Basic tab (Figure 5 6 - 1) provides the following fields:
- Project (Figure 5 - 3): select multiple projects to analyze (only available in Xray Enterprise).
- Fix Version (Figure 5 6 - 83): version assigned to Requirements.
- Sprint (Figure 5 6 - 46):sprint assigned to Requirements (only available if Jira Software is installed).
- Component (Figure 5 6 - 94): components assigned to Requirements.
- Status (Figure 5 6 - 57):the Issue's workflow status.
- Resolution (Figure 6 - 5 - 10): the Issue's workflow resolution.
- Contains text (Figure 5 6 - 68): filter requirements by text.
By clicking More (Figure 5 6 - 79), it's possible to manage select which fields will be used to filter the Requirements (Figure 6 7 - 1):
- Selecting fields will enable further filtering further of the Requirements.
- Unselecting fields will remove them from the dialog and thus from the search criteria.
Figure 6 7 - More
| Info |
|---|
The default fields cannot be removed from the dialog. |
Alternatively, to the Basic tab(Figure 5 6 - 1), the Advanced tab (Figure 5 6 - 2) offers the possibility of filtering the requirements via JQL (Figure 7 8 - 1):
Figure 7 8 - JQLAdvanced
If you wish, you can clear the filter to see all Requirements once again: click the Clear button (Figure 7 6 - 210) and then press press Apply (Figure 7 6 - 39).
Quick Filters
In the Quick Filters section (Figure 8 9 - 1), you can filter out Requirements based on their current coverage status for the scope defined. By default, all possible coverage statuses are unchecked, meaning that all Requirements will be shown no matter in of which coverage status they are. You can click on one or more statuses (Figure 8 6 - 2; 37) and, in that case, Requirements will be filtered out, and they'll show if they match one of the selected statuses.
Next to each coverage status, you can quickly evaluate the total number of Requirements. This allows you to quickly find and analyze the Requirements having that have problems or the ones that are not yet covered, for example.
Figure 8 9 - Filters
Options Menu
There is also an options menu (Figure 9 - 3), accessible via the gear icon (Figure 8 9 - 42) where you can choose the visualization type for the report:
- Requirement Presentation:
- Hierarchical (Figure 8 9 - 53) - the parent/child relationship between Requirements will be shown in the report, up to two levels (e.g. Epic => Story). In this case, the filter needs only to include the parent requirements (e.g. "Epic").
- Flat (Figure 8 9 - 53) - the Requirement Issues will not consider the parent/child relationship. All parent and child Requirements will be considered and shown at the same level in the report, as long as the filter includes them.
- Hide Test Runs (Figure 8 9 - 64): hides the Test Runs column; this is quite useful when you are using Continuous Integration and you have multiple runs.
Analysis
On top of the top report (Figure 9 - 1; 25), it's possible to define the analysis strategy, i.e., the way you want to analyze the selected/filtered requirementsRequirements. By clicking the respective field (Figure 9 - 15), you can choose to analyze either by by Version or Test Planand complement it with a Test Environment.
Figure 9 - Analysis
an Environment.
- If you choose analysis by Version (Figure 10 - 1), then only the Test Executions for the specified version are considered. Click Apply (Figure 10 - 3) when you're done.
- If the Test Environment Environment is specified (Figure 11 10 - 2), then it considers only the executions within that environment. Click Apply (Figure 10 - 3) when you're done.
Figure 10 - Version
- If you choose analysis by Test Plan (Figure 11 - 1), then only the Test Executions (and related Tests and results) for the given Test Plan are considered for the calculation of the coverage status of each requirement. Click Apply (Figure 11 - 3) when you're done.
- If the Test Environment is specified (Figure 11 - 2), then it considers only the executions within that environment. Click Apply (Figure 11 - 3) when you're done.
| Info |
|---|
When you choose analysis by Test Plan (Figure 11 - 1), the Requirements are not filtered in any way. Therefore, if you want to restrict the list of Requirements that are being shown (e.g., just show the Requirements being indirectly covered by the Tests belonging to a Test Plan), you must always use the Filter options and eventually, some saved filter for that purpose (such as the |
...
| Column | Notes |
|---|---|
Requirements | Requirements and the calculated Requirement status, considering the options selected for analysis |
| Tests | Tests and the calculated status, considering the options selected for analysis |
Test Runs | Test Runs and their status from all related Test Executions |
| Defects | Defects directly associated with the Test Runs, as well as those directly linked to the Tests (via a created Issue link) for the given version (through the AffectsVersion) |
| Info |
|---|
The defects Defects that appear on a separate row (i.e., that are not related to a specific Test Run) contain all defects associated with the Test (Figure 13 - 1). In other words, it contains all defects linked to the Test, including the ones reported for Test Runs done on a different environment. This allows you to see all "related defects" that may or may not impact your version.
Figure 13 - Defects |
...
Therefore, we advise you to :
...
hide the Test Runs column in the report (Figure
...
14 - 1), if the number of runs is considerably high (e.g. > 1000); the amount of information may overload your browser, and it will be hard for you to analyze the report with all that information.
Figure 14 - Report
Figure 15 - Test run
Hierarchy
In the following example (Figure 1615), you can see the hierarchical relation between an Epic and some Stories (Figure 16 15 - 1). Once enabled, the hierarchy can be viewed as part of the report, and it supports a depth of up to five levels of Requirements.
Figure 16 15 - Requirements
| Info |
|---|
Requirements with Labels or Statuses configured to be ignored in the Requirements Coverage settings will not appear on this report. |
...
| UI Steps | ||||||
|---|---|---|---|---|---|---|
|
Sharing the Report
The report can be shared by copying and sending the URL located in the browser's address bar (Figure 17 - 1).
...