The Rich Filter Statistics Gadget

Contents:

About the Rich Filter Statistics gadget

The Rich Filter Statistics gadget displays the collection of issues grouped by a specific field/criteria. It resembles 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 called working query;

  • the gadget can group the issues by an issue field or by a smart filter;

  • the gadget can group the issues by the values of a date or date time field to compute daily, weekly, monthly, quarterly, or yearly statistics;

  • the gadget can display multiple result types at the same time (such as Issue Count and Story Points);

  • the gadget can display custom ratios;

  • the gadget can display one or more time series;

  • the user can change the sorting order by clicking on a column name;

  • the gadget can display the data as a chart; the user can switch between the table view and the chart view by clicking on an icon;

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

Example 1: Issue Count and Story Points aggregated by the issue field Priority:

Example 2: Issue Count and Story Points aggregated by a smart filter named High-level Status:

The labels and colors displayed for High Level Status come from the clauses defined in this smart filter's configuration.

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

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.

Statistic type

Select the issue field or the smart filter on which the issues will be grouped. The drop-down list includes the smart filters defined in the selected rich filter:

The gadget supports several types of breakdown configuration, depending on the selected Statistic type:

  • Statistics on option fields (e.g., Priority, Status, select custom fields, etc.) or smart filters

  • Statistics on date or date time fields

  • Statistics on time series

These options are further detailed in the sections below. 

Statistics on option fields or smart filters

The following settings are applicable when the selected Statistic type is an option 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: This will be sorted by the value computed for each statistical type group (if multiple value columns exist, the first one will be used for sorting).

  • Alphabetical: This will use alphabetical order for the statistical type groups.

  • Natural: This will use the native sorting order of the issue field or smart filter selected as Statistic type, i.e., the order configured for the field or smart filter's options. This sorting option is available only for the issue fields Priority, Status, and Issue Type and for smart filters.

Reverse sort order

If checked, the sort order is reversed.

Maximum rows

If set, limit the number of result 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.

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

  • Numeric: computes the sum of a numeric field for the issues in each group. For instance, when using Jira Software, the gadget can show the number of Story Points for each Statistical type group.

  • Custom values: displays a custom value configured in the rich filter (aggregation formula, display options, etc.).

  • Custom ratios: displays a custom ratio configured in the rich filter (percentage or ratio).

Statistics on date fields

The following 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 Days, Weeks, Months, Quarters, Years, and Auto.

Time Range









Together with its sub-settings, this specifies the total time span for which the statistics should be computed. 

The time range sub-settings 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 days / weeks, etc.

Enter a number of periods. The time range corresponds to the specified number of consecutive aggregation 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

From / To

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").

All dates



If selected, the time range is determined dynamically to include all the relevant issues (from the first date to the last date in the issues' values).

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 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.

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

  • Numeric: computes the sum of a numeric field for the issues in each group. For instance, when using Jira Software, the gadget can show the number of Story Points for each Statistical type group.

  • Custom values: displays a custom value configured in the rich filter (aggregation formula, display options, etc.).

  • Custom ratios: displays a custom ratio configured in the rich filter (percentage or ratio).

Statistics on time series

The gadget can also be configured to display one or more time series. To do so, select the Time series option in the Statistic type setting. 

The following settings are applicable when the selected Statistic type is Time series:

Setting

Description

Setting

Description

Aggregation periods

Select the periods on which the issues will be grouped, according to the date or date time fields on which the selected time series are based.

The available options are Days, Weeks, Months, Quarters, Years, and Auto.

Time Range









Together with its sub-settings, this specifies the total time span for which the statistics should be computed. 

The time range sub-settings 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 days / weeks, etc.

Enter a number of periods. The time range corresponds to the specified number of consecutive aggregation 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

From / To

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").

All dates



If selected, the time range is determined dynamically to include all the relevant issues (from the first date to the last date in the issues' values).

Contextual options



These are predefined Time range options, which 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 of the selected time series:

  • for time series based on all value types other than custom ratios, the proportion of each value relative to the total;

  • for time series based on custom ratios, the proportion corresponding to the ratio.

Show totals

If checked, the gadget displays a row with the totals for each selected time series.

Time series

You can select one or several time series to display. The gadget displays a new column for each selected time series with the values computed from the given time series.

Quick charts in the Rich Filter Statistics gadget

In addition to the main table view, the Rich Filter Statistics gadget offers a chart view, which displays the results as a chart. This chart, referred to as a quick chart, requires no additional configuration. You can switch between the table view and the chart view by clicking on the corresponding icon at the gadget's bottom right.

By default, a donut chart based on the first column of the table is displayed. You can choose the chart type and the values of the quick chart by selecting them in the corresponding fields at the bottom right of the gadget. The following chart types are currently available:

  • donut chart

  • pie chart

  • gauge chart

  • bar chart

  • treemap chart

Examples of quick charts:

Donut chart of Issue Count by Project:

Pie chart of Story Points by Priority:

Gauge chart of Time Spent by Status:

Bar chart of Issue Count by Issue Type:

Treemap chart of Story Points by Status: