Xray provides a gadget for viewing the overall requirements coverage report for a given set of requirement issues. The requirement issues can span different projects, unlike the Requirements Coverage charts, which are specific to each project.


This 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 determine whether they're covered or not. If they are, you can see their current status.

Xray makes it possible for you to analyze the requirements for a given version, taking into account the executions made for that version. Alternatively, it is possible to restrict the analysis by considering only the Tests that belong to a specific Test Plan; thus, you're able to evaluate the requirements coverage in the context of a given Test Plan. 


For more information on coverage, please refer to Coverage Analysis.

How to use

Source requirement issues for the chart can be provided by using a saved filter or a project:

  • Project or Saved Filter: all requirements for a given project or a saved filter containing requirement issues

Notice that a "Saved Filter" or a "Project" must be select in order to use the gadget.

Additional configuration parameters for this gadget include:

  • Group By: group the requirements by a specific field/custom field
  • Flat Requirements Presentation: if enabled, all parent and sub-requirements are shown at the same level (e.g., Epics and Stories); if disabled, only parent requirements are shown
  • Execution Scope: Version or Test Plan
    • Test Plan Key: the key of the Test Plan, if the Execution Scope is "Test Plan"
    • Analysis Version: the version, if the Execution Scope is "Version"
  • Refresh Interval: how often the gadget is updated

Even if a saved filter is used, an analysis version can be selected for the Requirement Status calculation.