The Rich Filter Statistics Gadget

Contents:

1 About the Rich Filter Statistics Gadget
- 1.1 Rich Filter Extensions
2 Configuring the Rich Filter Statistics Gadget

About the Rich Filter Statistics Gadget

The Rich Filter Statistics gadget displays the collection of issues grouped by a specific field/criteria. It is similar to Jira’s built-in Issue Statistics Gadget, but it is based on a rich filter instead of a Jira saved search and thus adds several new features:

the collection of issues used for the statistics can be further filtered using Rich Filter Controller gadgets;
the gadget itself can further refine the results by applying a gadget-specific JQL that we call a working query;
the gadget can break down the results by issue fields, smart filter, or time series;
the gadget can also use a date field to break down the results by Hour, Day, Week, Month, Quarter or Year;
the gadget can display multiple outputs at the same time (such as Issue Count and Story Points);
the gadget can display custom ratios;
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 statistic options are available if you add any of these extensions:

Rich Filters::Time Tracking Dashboards allows you to display statistics and time series based on work log attributes – Worklog Author, Worklog Date, and Worklog Time Spent
Rich Filters::Service Desk Dashboards allows you to display statistics based on Service Desk fields – Customer Request Type and Organizations, compute values based on Service Desk SLA fields, or display time series based on Service Desk SLA fields

Configuring the Rich Filter Statistics Gadget

Add a new or edit an existing Rich Filter Statistics gadget in your Jira dashboard. The configuration form of the gadget will be displayed:

Edit the gadget configuration as described below:

Setting	Description

Setting	Description
Title	You can optionally customize the gadget's title. If left blank, the default title will be Rich Filter Statistics.
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 displayed.
Statistic Type	This setting is mandatory and specifies the criteria on which the issues will be grouped. There are three types of Statistic types: a. Option issue fields (e.g., Priority, Status, select custom fields, etc.) and Smart Filters b. Date and date time issue fields c. Advanced – Time Series

Statistics on option issue fields or smart filters

The following statistics settings are applicable when the selected Statistic type is an option issue field (e.g., Priority, Status, select custom fields, etc.) or a smart filter:

Setting	Description

Setting	Description
Sort by	Select how to sort the values of your Statistic type: Total: Sort by the value of each Statistic type group (if there are multiple value columns, the first one is used for sorting). Alphabetical: Uses alphabetical order for the Statistic type groups. Natural: Uses the issue field’s or smart filter’s native sorting order, i.e., the order configured for each field or smart filter's options.
Reverse sort order	If checked, the sort order is reversed.
Maximum rows	This setting limits the maximum number of rows to display.
Show percentage bars	If checked, the gadget displays a bar chart for each statistic value: for all value types other than custom ratios, the proportion of each value relative to the total; for custom ratios, the proportion corresponding to the ratio.
Show totals	If checked, the gadget displays a row with the totals for each selected value.
Values	Select the values to be computed for each Statistic type group. You can select up to 10 values at a time. The following value types are available: Issue Count: computes the number of issues in each group. Numeric: computes the sum of a numeric field for all issues in each group. For instance, using the Jira Software, the gadget can show the number of Story Points for each Statistic type group. Σ 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) for all issues in each group. Σ Time Tracking: This is the same as Time Tracking, but for each issue, it also includes the values in its sub-tasks. Custom Values: computes values based on the configuration of a custom value – label, color, total formula, formatting and JQL filter. Custom Ratios: displays a custom ratio configured in the rich filter (percentage or ratio).

Statistics on date and date time fields

The following statistics settings are applicable when the selected Statistic type is a date or a date time field:

Setting	Description

Setting	Description
Aggregation periods	Select the periods on which the issues will be grouped, according to their values for the date or date time field selected as Statistic type. The available options are Hours, Days, Weeks, Months, Quarters, and Years.
Time range	Together with its subsettings, this specifies the total time span for which the results will be computed. The time range subsettings depend on the option selected in the Time range drop-down as described below.
	Time range	Time range subsetting	Description
	Number of periods	Number of periods	Enter a number of periods. The time range corresponds to the specified number of consecutive aggregation periods.
	Number of periods	Direction	Select how the periods are positioned relative to the current period. The possible options are: Past – the time range includes past periods and the current period Future – the time range includes the current period and future periods Past & Future – the time range includes past periods, the current period, and future periods, with the current period in the middle of the range
	Between dates	Start date End date	Enter the two dates that define the limits of the time range (both specified dates are inclusive). The inputs can be selected from a date picker or entered manually as a calendar date ("`yyyy/MM/dd`" or "`yyyy-MM-dd`") or as a time relative to the present (e.g. `"-5d"`, `"4w 2d"`).
	Contextual options		These are predefined Time range options that depend on the selected Aggregation period. Possible options are: This year, Last year, This quarter, Last quarter, This month, Last month.
Reverse sort order	If checked, the default chronological order is reversed.
Show percentage bars	If checked, the gadget displays a bar chart for each statistic value: for all value types other than custom ratio, the proportion of each value relative to the total; for custom ratios, the proportion corresponding to the ratio.
Show totals	If checked, the gadget displays a row with the totals for each selected value.
Values	Select the values to be computed for each Statistic type group. You can select up to 10 values at a time. The following value types are available: Issue Count: computes the number of issues in each group. Numeric: computes the sum of a numeric field for all issues in each group. For instance, using Jira Software, the gadget can show the number of Story Points for each Statistic type group. Σ 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) for all issues in each group. Σ Time Tracking: This is the same as Time Tracking, but for each issue, it also includes the values in its sub-tasks. Custom Values: computes values based on the configuration of a custom value – label, color, total formula, formatting and JQL filter. Custom Ratios: displays a custom ratio configured in the rich filter (percentage or ratio).

Statistics on Time Series

The following statistics settings are applicable when the selected Statistic type is Advanced – Time Series:

Setting	Description

Setting	Description
Aggregation periods	Select the periods on which the issues will be grouped, according to the time series selected as Statistic type. The available options are Hours, Days, Weeks, Months, Quarters, and Years.
Time range	Together with its subsettings, this specifies the total time span for which the results will be computed. The time range subsettings depend on the option selected in the Time range drop-down as described below.
	Time range	Time range subsetting	Description
	Number of periods	Number of periods	Enter a number of periods. The time range corresponds to the specified number of consecutive aggregation periods.
	Number of periods	Direction	Select how the periods are positioned relative to the current period. The possible options are: Past – the time range includes past periods and the current period Future – the time range includes the current period and future periods Past & Future – the time range includes past periods, the current period, and future periods, with the current period in the middle of the range
	Between dates	Start date End date	Enter the two dates that define the limits of the time range (both specified dates are inclusive). The inputs can be selected from a date picker or entered manually as a calendar date ("`yyyy/MM/dd`" or "`yyyy-MM-dd`") or as a time relative to the present (e.g. `"-5d"`, `"4w 2d"`).
	Contextual options		These are predefined Time range options that depend on the selected Aggregation period. Possible options are: This year, Last year, This quarter, Last quarter, This month, Last month.
Reverse sort order	If checked, the default chronological order is reversed.
Show percentage bars	If checked, the gadget displays a bar chart for each statistic value: for all value types other than custom ratio, the proportion of each value relative to the total; for custom ratios, the proportion corresponding to the ratio.
Show totals	If checked, the gadget displays a row with the totals for each of the selected values.
Time series	Select the time series to be displayed. The gadget displays a new column with values for each selected time series.