---
title: "Requirements List Gadget"
canonical: "https://docs.getxray.app/space/XRAYCLOUD/44565368/Requirements%20List%20Gadget"
format: markdown
---
<details>
<summary>Table of Contents</summary>

> Macro (toc)
</details>

# <span style="color: #333333">Introduction</span>

<span style="color: #333333">The Requirements List gadget (Figure 1) provides a quick way of evaluating the current status of your project Tests. You're able to visually identify the Requirements by filtering them beforehand and determining their coverage status.</span>

![Figure 1 - Requirements list](media://b88f5b06-af9d-4e55-9d95-c27f9a58dd68)


# 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://b994b325-2c4f-4d13-9739-0f10f78252ac)
> 
> > 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://f990ea01-99c4-4602-81e8-e3fa44b32b11)
> 
> > Macro (rw-step)
> 
> A side menu will open on the right (Figure 4). Search for the Requirements List gadget or type it on the bar (Figure 4 - 1). Then, click *Add* (Figure 4 - 2).
> 
> ![Figure 4 - Add](media://70c62299-0b0b-4ce3-b134-976add464d0a)
> 
> > Macro (rw-step)
> 
> The Requirements List 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 list 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.
> - *Number of Results* (Figure 5 - 2): the number of results displayed per page is up to 100.
> - *Columns to Display* (Figure 5 - 3):** **the columns that will be displayed; the order of the columns in the table will be the order of the fields in the selector.
> - Flat Test Coverage View (Figure 5 - 4).
> - *[Analysis & Scope](https://getxraydocs.atlassian.net/wiki/spaces/XRAYCLOUD/pages/44565185)**:* (Figure 5 - 5): *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 - 6).
> - *Final Status* *Precedence* (Figure 5 - 7):** **whether the final status has precedence over non-final ones.
> - *Auto-generate Gadget Name *(Figure 5 - 8)*:*** **whether the name of the gadget should be generated based on the parameters you defined.
> 
> ![Figure 5 - Dashboard](media://22bd2673-2bc5-4dea-aec4-e20bb9db6a40)
> 
> 
> > Macro (rw-step)
> 
> Once you're done configuring, click *Save* (Figure 5 - 9).
> 
> The output will appear immediately (Figure 6).
> 
> ![Figure 6 - Dashboard](media://72960c9b-12a1-4423-985a-22e3d9648b6e)


<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>