---
title: "Test Plans Report"
canonical: "https://docs.getxray.app/space/XRAY/301700792/Test%20Plans%20Report"
format: markdown
---
> Macro (rw-ui-expands-macro)

# Introduction

The Test Plans report shows a comprehensive view of your Test Plan portfolio, including Test coverage, execution progress, and linked Defects.

![Figure 1 - Test plans](media://93280d7b-bc25-47db-b66c-4d30dc733bc3)

> ⚠️ To use this report, your project must have the Test Plan Issue Type in the Issue Type scheme<span style="color: #000000">.</span>


This report allows you to track your Test Plan progress at a glance with visual bar graphs.

Possible usage scenarios:

- Customizing which Test Plan attributes to display.
- Organizing columns to match your workflow.
- Analyzing both the progress of the Test Plan and its success rate (i.e., the % of Tests contributing to the requirement's OK status).
- Checking the success rate by Test Environment.
- Verifying the number of manual Tests vs. others in the Test Plan.
- Seeing the overall execution status (i.e., the latest status of the Tests of the Test Plan).
- Checking the number of Linked Defects opened/closed, in the context of the Test Plan.

# Operations

## Report Access and Generation

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> On the top menu of your Jira Data Center instance, click *Projects* (Figure 2 - 1) and select a project (Figure 2 - 2).
> 
> ![Figure 2 - Project](media://6b6f387c-5d25-41c7-99b9-b3e1b28df50a)
> 
> > Macro (rw-step)
> 
> A menu will open on the left side of the screen. There, click *Xray* *Reports* (Figure 2 - 3).
> 
> > Macro (rw-step)
> 
> Use the dropdown menu at the top of the screen (Figure 3 - 1) and click the *Test Plans Report* (Figure 3 - 2).
> 
> ![Figure 3 - Report](media://c85973ce-b23f-40db-96ce-d6e102f9cdcd)
> 
> > Macro (rw-step)
> 
> Click the *Generate Report* button (Figure 3 - 2) to create the report.
> 
> > Macro (rw-step)
> 
> The report will be instantaneously generated (Figure 4). 
> 
> The report may be a bit wide for some screen resolutions, so you will need to scroll horizontally to see the rest of the information.
> 
> Some values provide a link, so you can be redirected to the respective entities.
> 
> ![Figure 4 - Report](media://246dbf3a-70ae-40c3-a26a-56fd3aa3f3af)

## Understanding and Using the Report

### Columns

The Test Plans Report uses a dual-zone column system (the column *Test Executions* - Figure 4 - 3 - marks the start of fixed columns):

**Zone 1: **customizable columns - Test Plan details (Figure 4 - 1):

- Key.
- Summary.
- Version
- Start/End Date.
- Test Environments.

#### Drag and Drop

You can reorder the columns from Zone 1 by dragging and dropping the columns to their desired position (Figure 5 - 1):

- Release the mouse button to drop the column into the new position.
- The table will automatically update with the new column order.

![Figure 5 - Reorder](media://8c1647b7-981f-4104-abbd-0e250c270bfb)

#### Customizing Columns

By clicking *Columns* (Figure 6 - 1), you can:

- Use the boxes to add/remove (Figure 6 - 2) columns.
- Use the grey dots to reorder these columns (Figure 6 - 3) by dragging and dropping them directly in the table header. This action has the same effect as rearranging columns within the column dropdown menu, and changes made in one area will be reflected in the other.
  - Once you’re finished, click *Done* (Figure 6 - 4).
- Use the search bar (Figure 6 - 5) to find columns.
- Click *Restore Defaults* (Figure 6 - 6), all columns reset to system defaults.

![Figure 6 - Columns](media://2bc0649e-9b33-4d7c-85ff-0afece3de274)

**Zone 2: **fixed columns (Figure 5 - 2) - metrics and results: 

- Test Executions (number of Test Executions related to this Test Plan).
- Test Runs (the number of Test Runs from all related Test Executions).
- Total Tests (number of Tests being tracked by the Test Plan).
- Tests by Status (number of Test Plan's Tests, per latest status).
- Test types (Manual, Cucumber, Generic, other).
- Progress (overall progress; % of Tests with a final status).
- Success Rate (% of "successful" Tests (i.e., whose latest status contributes to the OK requirement status; the PASS Test Run status is an example of such a status)).
- Linked Defects (Defects directly associated with the related Test Runs (i.e., that were created within the context of Test Executions of a given Test Plan).

> ℹ️ The Zone 2 columns (Figure 5 - 2) are always visible, and they are non-reorderable.

### Source Data

Source Test Plan Issues can be directly provided (Figure 7 - 2) using a saved filter or by specifying some Test Plan fields.

Available by clicking *Project* (Figure 7 - 1).

![Figure 7 - Data](media://c8bfe0f6-32da-406c-beea-96f42201f4fb)

- **Saved filter**: a saved filter containing Test Plan Issues.
- **Project**: select multiple projects to analyze **(only available in Xray Enterprise).**
- **Fix Version**: the version assigned to the Test Plan.
- **Assignee**: the Test Plan's assignee.
- **Status**: the workflow status.
- **Resolution**: the workflow resolution.

## Exporting the Report

The report can be exported to a CSV file, which will include all report rows (and not just the visible ones).

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Click *Export* (Figure 8 - 1) and then *To csv* (Figure 8 - 2).
> 
> ![Figure 8 - Report](media://a319cfc5-c701-423c-b887-1e1ccdaec1d6)
> 
> > Macro (rw-step)
> 
> You will get the file on your machine instantaneously.

## Highlights

The Test Runs Report includes an interactive onboarding system to help you discover and understand new features. This includes:

- **Reports menu lozenge** - *NEW* tag in the reports dropdown menu (Figure 9 - 1).
- **Onboarding cards** - dismissible information cards for each report type (Figure 9 - 2).
- **Feature highlights** - contextual tooltips and hints (Figure 9 - 2).

![Figure 9 - Highlights](media://b6c8099f-3979-4856-986f-18595ca48aaa)

> 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/XRAY/pages/301501383).