Traceability Report
| Column | Notes |
|---|---|
Requirements | "requirements" and the calculated requirement status, taking into account the options selected for analysis |
| Tests | Tests and the calculated status, taking into account 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). |
Traceability Report is one of the most effective reports to analyze your overall readiness to deploy in terms of requirements coverage and visibility. This is one of the first markers of a release that meets all expectations/requirements and will guarantee the software meets the functions that were expected.
Purpose
Shows the requirement traceability, from requirements to defects.
This helps you analyze the requirements and related Tests, Test Runs and defects, for quickly identifying uncovered or incomplete/faulty requirements.
This report enables you to follow the life of a requirement in both forwards and backwards direction (i.e., from its origin all the way through tests, test runs and defects). It facilitates analysis of the overall requirements coverage status.
Possible usage scenarios:
- 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, especially useful in highly regulated organizations where you need to make sure every requirement is tested before a release.
- 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
The report not only shows the traceability between entities, but it also presents some calculated values for the selected options. For example, the requirement status and the Test status that are shown in the Requirements and Tests columns, respectively.
How to use
This report is accessible either from the Xray icon on the project left sidebar or from the standard Reports icon, which includes other kinds of reports besides Xray.
Source coverable issues (e.g. "requirements) can be directly provided using a Basic or Advanced filter:
- Advanced: a JQL query to filter the coverable issues
- Basic:
- Project: project
- Assignee: the issue's assignee
- Component: the component assigned to the issue
- Fix Versions: versions assigned to the issue
- Resolution: the workflow resolution
- Status: the workflow status
- Contains: the full issue key or part of the summary
It's also possible to configure the report with additional parameters:
- Show Test Runs: if unchecked, will hide the Test Runs column; this is quite useful when you are using Continuous Integration and you have multiple runs
Analysis
On the left side, it's possible to define the analysis strategy, i.e., the way you want to analyze the selected/filtered requirements. You can choose to analyze either by Latest, Version or Test Plan, and complement it with a Test Environment.
If you choose analysis by Version, then only the Test Executions for the specified version are taken into account.
If you choose analysis by Test Plan, 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.
If the Test Environment is specified, then it considers only the executions within that Environment.
Note
When you choose analysis by Test Plan, the coverable issues (e.g. 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 Filters dropdown.
Understanding the report
The issues and values that are shown in the report take into account the options selected for analysis, namely, the relevant Test Executions and corresponding Test Runs and defects.
The report not only shows the traceability between entities, but it also presents some calculated values for the selected options. For example, the requirement status and the Test status that are shown in the Requirements and Tests columns, respectively.
Column | Notes |
|---|---|
Requirements | coverable issues (e.g. "requirements)" and the calculated coverage status, taking into account the options selected for analysis |
| Tests | Tests and the calculated status, taking into account the options selected for analysis |
Test Runs | Test Runs and their status from all related Test Executions (only 3 are shown but an action allows you to see all of them) |
| Defects | defects directly associated with the Test Runs |
Performance
In Continuous Integration scenarios, with thousands of runs, showing all those Test Runs at the same time in this report may take some time and may overload your browser.
Therefore, we advise you to hide Test Runs column in the report, if the number of runs is considerable high (e.g. > 1000); the amount of information may overload your browser and it will be hard for you to analyse the report with all that information.
Examples
In the following example you can see the hierarchical relationship between an Epic and some Stories (hierarchical presentation should be enabled in the report settings - section D).
Export & Share
The report can be exported to a CSV file, which will include all report rows (and not just the visible ones).
Click on Export and select To csv.
