This page relates to version 1.24 of Rich Filters for Jira Dashboards for Server & Data Center. See the documentation index for previous versions, or for the Cloud version of Rich Filters.

The Rich Filter Statistics Gadget

In this section:

1. 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 furthered filtered using Rich Filter Controller gadgets;
  • the gadget itself can further refine the results by applying a gadget-specific JQL that we call 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 in order 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’s title can be customized.

Rich Filter Extensions

Rich filter extensions are separate Jira apps that can be 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 the these extensions:

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

SettingDescription

Title

Optionally, you can customize the title of the gadget. If left blank, the default title will be Rich Filter Statistics.

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

All the following configuration options depend on the selected Statistic type.

2.a. 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:

SettingDescription
Sort by

Select how to sort the values of your Statistic type:

  • Total: this will sort by the value of each Statistic type group (if there are multiple value columns, the first one is used for sorting).
  • Alphabetical: this will use alphabetical order for the Statistic type groups.
  • Natural: this will use the issue field’s or smart filter’s native sorting order, i.e. the order that has been configured for the options of each field or smart filter.
Reverse sort orderIf checked, the sort order is reversed.
Maximum rowsThis setting limits the maximum number of rows to display.
Show percentage barsIf checked, the gadget displays the proportion represented by each statistic value relative to the total, as a bar chart.
Show totalsIf checked, the gadget displays a row with the totals for each of the selected values.
Values

Select the outputs to be computed for each Statistic type group. You can select up to 10 outputs at a time.

There are six kinds of possible values:

  • 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 all issues in each group.
  • Σ 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 all issues in each group. For instance, if using Jira Software, the gadget can show how many Story Points there are for each Statistic type group. 
  • Σ Numeric: the same as Numeric 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.

2.b. 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:

SettingDescription
Aggregation periods

Select the periods on which the issues will be grouped, according to the their values for the date or date time field selected as Statistic type.

The available options are: Hours, Days, Weeks, Months, Quarters, 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 rangeTime range subsettingDescription

Number of periods

Number of periodsEnter 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

Fields like Created or Resolved always contain values that are in the past. Therefore you should always select Past for these fields as you will never find any issue created or resolved in the future.

Fields like Due Date contain values that can be both in the past and in the future. For this field it is more useful to select Future in order to see statistics for the issues that are due soon, or Past & Future to also see the statistics for overdue issues.

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 which depend on the selected Aggregation period. 

Possible options are: This year, Last year, This quarter, Last quarter, This month, Last month. 

Reverse sort orderIf checked, the default chronological order is reversed.
Show percentage barsIf checked, the gadget displays the proportion represented by each statistic value relative to the total, as a bar chart.
Show totalsIf checked, the gadget displays a row with the totals for each of the selected values.
Values

Select the outputs to be computed for each Statistic type group. You can select up to 10 outputs at a time.

There are six kinds of possible values:

  • 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 all issues in each group.
  • Σ 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 all issues in each group. For instance, if using Jira Software, the gadget can show how many Story Points there are for each Statistic type group. 
  • Σ Numeric: the same as Numeric 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.

2.c. Statistics on Time Series

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

SettingDescription
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, 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 rangeTime range subsettingDescription

Number of periods

Number of periodsEnter 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

Fields like Created or Resolved always contain values that are in the past. Therefore you should always select Past for these fields as you will never find any issue created or resolved in the future.

Fields like Due Date contain values that can be both in the past and in the future. For this field it is more useful to select Future in order to see statistics for the issues that are due soon, or Past & Future to also see the statistics for overdue issues.

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 which depend on the selected Aggregation period. 

Possible options are: This year, Last year, This quarter, Last quarter, This month, Last month. 

Reverse sort orderIf checked, the default chronological order is reversed.
Show percentage barsIf checked, the gadget displays the proportion represented by each statistic value relative to the total, as a bar chart.
Show totalsIf checked, the gadget displays a row with the totals for each of the selected values.
Time series

Select the time series to be displayed. For each selected time series, the gadget displays a new column with values.