Xray provides a gadget for viewing requirements and evaluate their completeness for a particular release.


This gadget enables you to quickly check the status of a group of requirements for a specific Version, Environment or Test Plan.

Requirements are always shown in hierarchical mode.

Possible usage scenarios:

  • analyze the coverage status for a group of requirements for a given version
  • analyze the coverage status for a group of requirements for a given version and Test Environment
  • analyze the coverage status for a a group of requirements, taking into account the coverage and the results made in the context of some Test Plan
  • evaluate the completeness for a group of requirements for a given version
  • see the amount of Tests passing / failing per each requirement

How to use

Source requirement issues for the chart can be provided by a saved filter.

  • Saved filter: a saved filter containing requirement issues; this filter applies to the top-level (i.e. parent) requirements

Additional configuration parameters for this gadget include:

  • Execution Scope: either Version or Test Plan
  • Test Plan Key: the key of the Test Plan, if the Execution Scope is "Test Plan"
  • Project: auxiliary field containing the Project to take into account when selecting the Analysis Version
  • Analysis Version: the version, if the Execution Scope is "Version"
  • Test Environment: the test environment in which the tests were run
  • Requirement Status: only show requirements in the chosen status(es)

  • Custom Title: custom title for the gadget, if the appropriate checkbox is enabled; otherwise, a default title is used
  • Number of results: the number of results per page
  • Refresh Interval: how often the gadget is updated


When you choose analysis by Test Plan, the 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 covered by the Tests of a Test Plan), you must always use a proper saved filter for that purpose (such as the requirementTests JQL function).


Below is a typical list of requirements (e.g. stories in this case).

If your filter includes parent requirements (e.g. Epic), then you can see them and drill-down into the sub-requirements (e.g. stories) in order to evaluate the completeness of each one at a more grained level.