The Rich Filter Simple Gauge Gadget

The Rich Filter Simple Gauge gadget displays proportions from issue counts, numeric and time-tracking issue fields, and custom ratios. 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 a working query;

  • 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), or a numeric or time-tracking field (such as Story Points or Original Estimate); 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 gadget supports multiple display layouts;

  • the gadget’s title can be customized.

Rich Filter Extensions

Rich filter extensions are separate Jira apps installed on top of the Rich Filters for Jira Dashboards app to extend the rich filters and rich filter gadgets with new specific functionality.

New gauge options are available if you add any of these extensions:

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

Setting

Description

Title

You can optionally customize the gadget's title. If left blank, the default title will be Rich Filter Simple Gauge.

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. Check the section on permissions for more 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 its rich filter using the Rich Filter option in the menu at the top right of the gadget.

Working Query

The working query is a JQL query combined with the rich filter's base 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 and 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 in one of two ways: with a filter & value pair or a custom ratio. Two selection drop-downs are used to configure the gauges:

The filter and ratio drop-down contains:

  • The static filters defined in the selected rich filter

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

  • The custom ratios defined in the selected rich filter.

The value drop-down is displayed only if a filter (predefined or static) is selected in the first drop-down. The second drop-down contains the following options:

  • Issue Count: counts the number of issues.

  • Numeric: computes the sum of a numeric field. For instance, if using Jira Software, the gadget can use the sum of Story Points for the issues returned. 

  • Σ Numeric: the same as Numeric, but it also includes the values in its sub-tasks for each issue.

  • Time Tracking: computes the sum of one of the time-tracking fields (i.e., Original Estimate, Remaining Estimate, Time Spent).

  • Σ Time Tracking: This is the same as Time Tracking, but for each issue, it also includes the values in its sub-tasks.

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

You can choose 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.



Â