This documentation relates to version 1.8 of the Rich Filters Add-on for JIRA. Documentation for previous versions is available via the documentation index.

The Rich Filter Simple Gauge Gadget

The Rich Filter Simple Gauge Gadget displays issue count and field sum gauges. The gadget is based on a rich filter and works as follows: 

  • the gadget builds a collection of issues based on the rich filter's base query and on the active quick filters (which means the results can be refined using Rich Filter Controller gadgets);
  • the gadget itself can further refine the issue collection by applying a gadget-specific JQL that we call “working query”;
  • it computes a gauge level based on predefined criteria or on any static filter defined in the rich filter;
  • for the same collection of issues, the gadget can display multiple gauges at the same time – based on different values, like the number of issues (Issue Count) or the sum of number and time tracking fields (such as Story Points or Original Estimate);
  • the gadget supports multiple display layouts;
  • the gadget’s title can be customized.

Configuring the Rich Filter Simple Gauge Gadget

Add a new or edit an existing Rich Filter Simple Gauge Gadget in your JIRA dashboard. The configuration form of the gadget will be displayed:

Edit the gadget configuration as described in the following table:

Setting Description
Title Optionally, you can customize the title of the gadget. If left blank, the default title will be Rich Filter Simple Gauge.
Rich Filter

Select the rich filter the gadget will use.

Click on the Rich Filter button to display the list of rich filters; you can either scroll through or use the search box to find the filter you need.

The gadgets’ configuration forms only show the rich filters you are allowed to view. See the section on permissions for details.

The link in the description line below the Rich Filter button opens a new page with the configuration of the selected rich filter.

Also, when the gadget is in display mode, you can navigate directly to the rich filter of the gadget using the Rich Filter option in the menu at the top right of the gadget.

Working Query The working query is a JQL query that is combined with the base filter of the rich filter before searching for issues. The working query is optional: if left empty, only the base JIRA filter and the quick filters affect the issues used for the output.
Gauge Filter

Select the criteria to be used as base for the gauge level. You can use predefined criteria or any defined static filter.

Values

Select the values to base the gauges on. You can select up to 5 values at a time.

There are five kinds of possible values:

  • Issue Count: counts the number of issues.
  • Time Tracking: computes the sum of one of the time-tracking fields (i.e. Original Estimate, Remaining Estimate, Time Spent).
  • Σ Time Tracking: the same as Time Tracking but for each issue it also includes the values in its sub-tasks.
  • Numeric: computes the sum of a numeric field. For instance, if using JIRA Agile, the gadget can use the sum of Story Points for the issues returned. 
  • Σ Numeric: the same as Numeric but for each issue it also includes the values in its sub-tasks.

Layout

You can chose one of several layouts to display the results:

  • Gauge: a gauge is displayed for each output value.
  • Percentage & Ratio: for each output value, the gadget displays the percentage and ratio of the gauge level out of the total.
  • Percentage Only: for each output value, the gadget displays only the percentage of the gauge level out of the total.