---
title: "Overall Test Coverage Gadget"
canonical: "https://docs.getxray.app/space/XRAYCLOUD/44565335/Overall%20Test%20Coverage%20Gadget"
format: markdown
---
<details>
<summary>Table of Contents</summary>

> Macro (toc)
</details>

# Introduction

Overall Test Coverage (Figure 1) is a gadget for viewing the [Test Coverage Report](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565216) for a set of Requirement Issues.

The covered Issues can span different projects, like the Test Coverage charts.

The Overall Test Coverage gadget provides a quick way of evaluating the current coverage status of your project's Requirements. You're able to visually identify the relevant Requirements by filtering them beforehand, and determining whether they're covered or not. If they are, you can see their current status.

![Figure 1 - Overall test coverage](media://84daf0f9-5815-4727-8b11-a56976dd3242)


You can analyze the Requirements for a version, considering the [Test Executions](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565117) made for that version. Alternatively, it is possible to restrict the analysis by considering only the Tests that belong to a specific [Test Plan](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565153); thus, you're able to evaluate the requirements coverage in the context of a Test Plan. 


> ℹ️ Please check the [Requirements Coverage Analysis page](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565185).

# Operations

## Gadget Access

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> On your Jira Cloud instance, click *Dashboards* (Figure 2 - 1) and select *Default Dashboards* (Figure 2 - 2).
> 
> ![Figure 2 - Dashboard](media://ebccf39f-40f2-45ae-be07-cfc95a64a9ef)
> 
> > Macro (rw-step)
> 
> Once the dashboard opens, click *Edit* (Figure 2 - 3). A new screen will open (Figure 3). Click *Add gadget* (Figure 3 - 1).
> 
> ![Figure 3 - Add](media://a3606249-1792-4e0f-81ad-8d76c9e5c892)
> 
> > Macro (rw-step)
> 
> A side menu will open on the right (Figure 4). Search for the Overall Test Coverage gadget or type it in the bar (Figure 4 - 1). Then, click *Add* (Figure 4 - 2).
> 
> ![Figure 4 - Add](media://f3db07ef-5c64-4719-8585-88d3e9f334bb)
> 
> > Macro (rw-step)
> 
> The Overall Test Coverage gadget will immediately appear on your Dashboard (Figure 4 - 3) and is ready to be configured.

## Configuring and Using the Gadget

> Macro (rw-ui-steps-macro)
> 
> > Macro (rw-step)
> 
> Source Requirement Issues for the chart can be provided by using a saved filter or by selecting a project:
> 
> - *Project or Saved Filter *(Figure 5 - 1): a saved filter or a project containing Requirement Issues. A project or saved filter must always be selected for this gadget to be used.
> - *Group By* (Figure 5 - 2): group the Requirements by a specific field/custom field.
> - *Flat Test Coverage View *(Figure 5 - 3): if this option is enabled, all parent and Sub-Requirements are shown at the same level (e.g., Epics and Stories); if disabled, only parent Requirements are shown.
> - *[Analysis & Scope](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565185)**:* (Figure 5 - 4): *Latest*, *Version* or *Test Plan*.
> - *Test Plan Issue:* the Issue key of the Test Plan, if the Execution Scope is *Test Plan*.
> - *Analysis Version:* the version, if the Execution Scope is *Version*.
> - *[Test Environment](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565129)* (Figure 5 - 5).
> - *Final Status* Precedence (Figure 5 - 6):** **whether the final status has precedence over non-final ones.
> - *Auto-generate gadget name *(Figure 5 - 7)*:*** **whether the name of the gadget should be generated based on the parameters you defined.
> 
> ![Figure 5 - Configuration](media://5cb9e9b6-3fd4-49b0-89e3-ce53772c7a68)
> 
> > Macro (rw-step)
> 
> Once you're done configuring, click *Save* (Figure 5 - 8).
> 
> The output will appear immediately (Figure 6).
> 
> ![Figure 6 - Gadget.png](media://934949a1-abe3-4074-8fa0-b3fc7de5b5f1)


<details>
<summary>Support/Troubleshooting</summary>

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).
</details>