The Rich Filter Simple Gauges Gadget

Owned by Cristian Oancea
Last updated: May 14, 2024 by Praveena Manohar
4 min read

Contents:

About the Rich Filter Simple Gauges gadget

The Rich Filter, Simple Gauges gadget, displays proportions from issue counts, numeric and time-tracking issue fields, custom values, and custom ratios. The gadget is based on a rich filter and provides, among others, the following features: 

  • the collection of issues used for the calculations can be further filtered using Rich Filter Controller gadgets;

  • the gadget itself can further refine the results by applying a gadget-specific JQL called working query;

  • the proportions can be displayed in one of three ways: as a gauge, as a percentage and fraction, or as a percentage only (for simplicity, called gauges, regardless of the way they are displayed);

  • for the same collection of issues, the gadget can display multiple gauges at the same time;

  • each gauge can be configured in one of two ways:

    • with a filter & value pair – the filter can be a predefined filter or any static filter; the value can be the number of issues (Issue Count), a numeric or time-tracking field (such as Story Points or Original Estimate), or a custom value; the proportion is computed as the sum of the values of the issues that satisfy the filter divided by the sum of the values of all the issues in the collection used by the gadget;

    • with a custom ratio – a dedicated configuration object for ratio definitions.

  • The content of the gadget can be exported to PDF, Excel (.xlsx), and CSV formats.

Configuring the Rich Filter Simple Gauges gadget

Add a new or edit an existing Rich Filter Simple Gauges 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

Setting

Description

Rich filter

Select the rich filter the gadget will use.

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

The gadgets’ configuration forms only show the rich filters you can view. For more details, check the Rights and Permissions page.

Working Query

The working query is an additional JQL query that is permanently applied on top of the base Jira filter and any active quick filters in the controller to further filter the issues the gadget will work with. The working query is optional: if left empty, only the base Jira filter and the quick filters affect the issues used by the gadget.

Gauge filters & values

Configure the definition of each of the gauges to be displayed. You can configure up to 10 gauges in each gadget.

Each gauge can be configured using a filter and value pair or a custom ratio.

Two dropdowns are used to configure the gauges:

  1. The first dropdown contains:

    • Three predefined filters: Resolved Issues (resolution is not EMPTY), Unresolved Issues (resolution = Unresolved), Status category: Done (statusCategory = Done)

    • The static filters defined in the selected rich filter

    • The custom ratios defined in the selected rich filter

  2. The second dropdown is displayed only if a filter (predefined or static) is selected in the first dropdown. The second dropdown contains four kinds of possible values:

    • Issue Count: the gauge is based on the number of issues.

    • Numeric: the gauge is based on a numeric field (e.g., Story Points or Votes).

    • Time Tracking: the gauge is based on one of the time-tracking fields (i.e., Original Estimate, Remaining Estimate, Time Spent).

    • Custom values:  the gauge is based on a custom value.

To sum up, to configure a gauge:

  1. First, select a filter or a custom ratio. If a custom ratio is selected, the gauge definition is complete and is added to the list.

  2. If a filter was selected in step 1, select a value to complete the gauge definition – the gauge definition is added to the list.

Layout

Select one of the following display options:

  • Gauge:

  • Percentage & fraction:

  • Percentage only: