This documentation relates to version 1.7 of the Rich Filters Add-on for JIRA. Documentation for previous versions is available via the documentation index.

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 gadget-specific JQL we call a “working query”;
  • the gadget can break down the results by an issue field or by a smart filter;
  • 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.

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:

Statistics on date fields

The gadget can also display statistics based on date fields. Some settings are relevant and will be displayed only if the Statistic Type is a date or date/time field (i.e. Time Intervals, Number of Intervals, Display Period). At the same time, the Sort By and Sort Direction are relevant and will be displayed only for fields which are not date or date/time. 

Edit the gadget configuration as described in the following table:

Setting Description

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. This setting is mandatory.

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

Select the issue field or the smart filter on which the issues will be grouped. This setting is mandatory.

Sort By

Does not apply to date and date/time fields

Select how to sort the values of your Statistic Type:

  • Total: this will sort by the output value that matches each Statistic Type group.
  • 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.

Sort Direction

Does not apply to date and date/time fields

Select whether the field values should be sorted in Ascending or Descending order.

Time Intervals

Applies only to date and date/time fields

The length of the time intervals to be used for statistics. It can be: Hourly (only for date/time fields), Daily, Weekly, Monthly, Quarterly, or Yearly.

Number of Intervals

Applies only to date and date/time fields

The number of time intervals to be displayed in the statistics gadget.

Display Period

Applies only to date and date/time fields

Depending on the date field you use, you can select the period you wish to represent in the statistics gadget:

  • Past
  • Future
  • Past & Future

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 an 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 easily see all the issues that are due soon or Past & Future to also see if there are overdue issues.

Values

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

There are five 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 Agile, 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.

In JIRA, numeric fields can also store negative values. The Rich Filter Statistics Gadget treats the negative values as zero.