The Rich Filter Two Dimensional Statistics Gadget
- Dan Mihalache
- Praveena Manohar
- Cristian Oancea
- Bogdan Butnaru
In this section:
Configuring the Rich Filter Two Dimensional Statistics gadget
Quick charts in the Rich Filter Two Dimensional Statistics gadget
About the Rich Filter Two Dimensional Statistics gadget
The Rich Filter Two-Dimensional Statistics gadget is a two-dimensional version of the Rich Filter Statistics Gadget. It allows grouping issues on two criteria, and computes statistics for combinations of statistic types. It resembles Jira’s built-in Two Dimensional Filter 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 result type displayed by the gadget can be customized (for instance, to show the sum of Story Points instead of the Issue Count);
the gadget can display custom ratios;
the gadget can display time series;
the user can change the sorting order by clicking on an icon next to the column or row name;
the gadget can also 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: Story Points aggregated by the issue field Priority and a smart filter named High-Level Status:
The labels and the colors displayed for High Level Status come from the clauses defined in the configuration of this smart filter.
2. Configuring the Rich Filter Two Dimensional Statistics gadget
Add a new or edit an existing Rich Filter Two Dimensional Statistics gadget in your Jira dashboard. The configuration form of the gadget will be displayed:
Edit the gadget configuration as described below:
Setting | Description |
|---|---|
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 can view. See the Rights and Permissions documentation page for details. |
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. |
Two breakdowns, one horizontal and one vertical, need to be configured. Below, we describe the breakdown settings only once. | |
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: For each of the two breakdowns (horizontal and vertical), there are several types of configuration, depending on the selected Statistic type: a. Statistics on option fields (e.g., Priority, Status, select custom fields, etc.) or smart filters b. Statistics on date or date time fields c. Statistics on time series These options are further detailed in the sections below. |
2.a. 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 |
|---|---|
Sort by | Select how to sort the values of your Statistic type:
|
Reverse sort order | If checked, the sort order is reversed. |
Maximum rows/cols | These settings limit the number of rows and columns to display. |
Show totals | If checked, the gadget displays the total values for the corresponding breakdown. |
Value | Select the value to be computed for each Statistic type group. The following value types are available:
|
Statistics on date fields
The following settings are applicable when the selected Statistic type is a date or a date time field:
Setting | Description | ||
|---|---|---|---|
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: Days, Weeks, Months, Quarters, Years, Auto. | ||
Time range | Together with its subsettings, this specifies the total time span for which the statistics should 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 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:
| ||
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 (" | |
All dates | If selected, the time range is determined dynamically to include all the relevant issues (from the first date to the last date occurring in the values of the issues). | ||
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 totals | If checked, the gadget displays the total values for the corresponding breakdown. | ||
Value | Select the value to be computed for each Statistic type group. The following value types are available:
| ||
2.c. Statistics on time series
The gadget can also be configured to display time series. In order to do so, you need to select a time series in the Statistic type setting. The selection can be done either on the horizontal breakdown or on the vertical one. The following image provides an example where the time series is selected on the horizontal breakdown:
The following settings are applicable when the selected Statistic type is a time series:
Setting | Description | ||
|---|---|---|---|
Aggregation periods | Select the periods on which the issues will be grouped, according to the date or date time field on which the selected time series is based. The available options are: Days, Weeks, Months, Quarters, Years, Auto. | ||
Time range | Together with its subsettings, this specifies the total time span for which the statistics should 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 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:
| ||
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 (" | |
All dates | If selected, the time range is determined dynamically to include all the relevant issues (from the first date to the last date occurring in the values of the issues). | ||
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 totals | If checked, the gadget displays the total values for the corresponding breakdown. | ||
Value | The gadget automatically fills-in the Value field with the base value of the selected time series. | ||
3. Quick charts in the Rich Filter Two Dimensional Statistics gadget
In addition to the main table view, the Rich Filter Two Dimensional 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 located at the bottom right of the gadget.
By default, a clustered bar chart is displayed. You can choose the chart type of the quick chart by selecting it in the corresponding field at the bottom of the gadget. You can also swap the primary and secondary breakdowns of the chart by clicking on the <> icon located between the breakdowns, at the bottom of the gadget.
The following chart types are currently available:
Clustered bar chart
Stacked bar chart
Multi-line chart
Examples of 2D quick charts:
Clustered bar chart of Issue Count by Project:
Stacked bar chart of Time Spent by Issue Type and Priority:
Multi-line chart of Story Points by Priority and Assignee: