---
title: "Requirement Traceability Report"
canonical: "https://docs.getxray.app/space/XRAYCLOUD/44565208/Requirement%20Traceability%20Report"
format: markdown
---
> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> > Macro (toc)

# Introduction

The Requirement Traceability Report (Figure 1) shows the Requirements traceability through [Tests](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565156), [Test Runs](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565109), and Defects. It supports three levels for Requirements (e.g.: Epic => Stories => Sub-tasks), allowing you to track the [coverage](https://getxraydocs.atlassian.net/wiki/display/XRAYCLOUD/Coverage+Analysis) at multiple levels.

![Figure 1 - Requirement Traceability report](media://c31dc528-9b0c-4263-b80a-5f967ea4fca9)

  


This report enables you to follow the life of a coverable Issue (e.g.: a Requirement) in both forward and backward directions (i.e., from its origin through Tests, Test Runs, and Defects). It facilitates analysis of the overall Test coverage status.

Possible usage scenarios:

- Make full <span style="color: #000000">traceability </span>analysis, from coverable Issues (e.g.: Requirements) <=> Tests <=> Test Runs <=> Defects.
- Evaluate the coverage status for a version and see all linked (open/closed) Defects.
- See the Tests and Test Runs that cover each coverable Issue, and analyze how that contributes to the overall coverage status.
- Analyze the Requirements, related executions and Defects in a [Test Environment](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565129).
- See which Defects impact the Requirements, or a subset of the Requirements of a specific version.

# Operations

## Report Access

> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)

## Configuring and Using the Report

If the Test Traceability Report has not been generated yet, you will see the screen depicted in Figure 3.

At the top of the report, you have some options that need to be configured:

- Analysis & Scope (Figure 3 - 1): [how to analyze the Issues](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565185).
- *Filters* (Figure 3 - 2): the source data for the report (e.g.: the Requirements or other covered Issues) and how to evaluate the status for each one of the items being shown.
- Show Test Runs (Figure 3 - 3): this impacts the export of the report in a CSV file and the performance of the report (more below).

![Figure 3 - Configuration](media://ebdade2a-4026-4624-b3a4-a170e5a57ed0)


> ℹ️ - You don't have to change any of the options shown in Figure 3. You can create the report with the options configured by default.
> ℹ️ - If you generate a report and then leave the configuration screen, the report will be lost, and you will need to reconfigure it from the beginning.

## Understanding the Report

### Filters

> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)

### Analysis & Scope

> Macro (ui-steps)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)
> 
> > Macro (legacy-content)

## Understanding the Report

The Issues and values that are shown in the report (Figure 12) consider 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 also presents some calculated values for the selected options. For example, the Requirement status and the Test status are shown in the Requirements and Tests columns, respectively (Figure 12 - 5).

| Column | Notes |
| --- | --- |
| Requirements | Coverable Issues (e.g.: Requirements) and the calculated coverage 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 (only three are shown, but an action allows you to see all of them) |
| Defects | Defects directly associated with the Test Runs |

## Report 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 overload your browser, and it will be hard for you to <span style="color: #000000">analyze </span>the report with all that information.

Therefore, we advise you to hide the Test Runs column in the report (Figure 13 - 4) if the number of runs is considerably high (e.g. > 1000).

> Macro (rw-ui-expands-macro)
> 
> > Macro (rw-expand)
> 
> If you have questions or technical issues, please [contact the Support team via the Customer Portal (Jira service management)](https://jira.getxray.app/servicedesk/customer/portal/2/user/login?destination=portal%2F2%2Fcreate%2F28) or [send us a message using the in-app chat](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44577312).