The Rich Filter Flexi Charts Gadget
In this section:
1. About the Rich Filter Flexi Charts gadget
The Rich Filter Flexi Charts gadget displays a chart with data computed from a collection of issues. This gadget is highly customizable, providing multiple options for the type of chart and the way the data is computed and displayed. It is also based on a rich filter instead of a Jira saved filter, thus providing the following features:
- the collection of issues used by the gadget 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 result type displayed by the chart can be Issue Count, a numeric or time-tracking field, or a custom value;
- each chart type has either one or two breakdowns (the charts are referred to as 1D charts and 2D charts respectively) and each breakdown is based on an issue field or a smart filter. The primary breakdown can also be based on a date or date time field;
- the gadget can display custom ratios and time series;
- the gadget can display average age reports;
- the gadget can also display the values from charts in a tabular format;
- the content of the gadget can be exported to PDF, Excel (.xlsx), and CSV formats.
Example 1: Donut chart of Issue Count by Project:
Example 2: Clustered bar chart of Story Points by Status and a smart filter named Team:
2. Configuring the Rich Filter Flexi Charts gadget
Add a new or edit an existing Rich Filter Flexi Charts gadget in your Jira dashboard. The configuration form of the gadget will be displayed.
- For 1D charts – donut, pie, gauge, bar, line, treemap, word cloud:
- For 2D charts – clustered bar, stacked bar, multi-line:
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 are allowed to view. See the Rights and Permissions documentation page for details. |
| Working query | The working query is an additional JQL query which 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. |
| Chart type | Select one of the available chart types:
|
For 2D charts, two breakdowns need to be configured, one primary and one secondary. Below we describe the breakdown settings only once. | |
| Statistic type | Select the criteria on which the issues will be grouped. In addition to issue fields, the drop-down list includes the smart filters and the time series defined in the selected rich filter, as well as options for special reports:
For the breakdown of 1D charts and for the primary breakdown of 2D charts, 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 d. Special statistics The secondary breakdown of 2D charts can only be based on options fields or smart filters. 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 the order in which the values are displayed in the chart. The following options are available:
|
| Reverse sort order | If checked, the sort order is reversed. |
| Maximum slices / bars etc. | These settings limit the number of slices / bars etc. to display. In the case of slices, the ones which are not individually displayed due to this limit are represented by one slice called Other. The user can still display all the computed slices / bars etc. by clicking on the numbers in rounded rectangles located at the bottom right of the gadget. |
| Value | Select the value to be computed for each Statistic type group. There are four kinds of possible values:
|
2.b. Statistics on date fields
The following settings are applicable when the selected Statistic type is a date or a date time field:
Please note that date fields can be used as breakdown only in Bar, Clustered/Stacked bar, and Line/Multi-line charts. The other chart types are not compatible with date field configurations.
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. If the Auto option is selected, the aggregation periods and time range are adjusted dynamically to produce the most granular yet complete statistics (i.e. with the appropriate aggregation period so that all the relevant issues are included). | ||
| 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 days / weeks etc. | Number | Enter the number of aggregation periods to be displayed. 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:
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 | 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). All dates is the only possible Time range option if the selected Aggregation period is Auto. | ||
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. | ||
| Aggregation type | Select one of the following aggregation type options:
| ||
| Value | Select the value to be computed for each Statistic type group. There are four kinds of possible values:
| ||
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 in the primary breakdown. The following image provides an example:
Please note that time series can be used as breakdown only in Bar, Clustered/Stacked bar, and Line/Multi-line charts. The other chart types are not compatible with time series configurations.
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. If the Auto option is selected, the aggregation periods and time range are adjusted dynamically to produce the most granular yet complete statistics (i.e. with the appropriate aggregation period so that all the relevant issues are included). | ||
| 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 days / weeks etc. | Number | Enter the number of aggregation periods to be displayed. 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:
Fields like Created or Resolved always contain values that are in the past. Therefore you should always select Past for time series based on 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 time series based on 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 | 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). All dates is the only possible Time range option if the selected Aggregation period is Auto. | ||
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. | ||
| Aggregation type | Select one of the following aggregation type options:
| ||
| Value | The gadget automatically fills-in the Value field with the base value of the selected time series.
| ||
2.d. Special statistics
The gadget can also be configured to display average age reports, which show how long issues have been unresolved on average, during each aggregation period in a time range.
How is the average age chart computed?
The way the average age algorithm works is that, for each aggregation period (1) it identifies all issues that are relevant for that aggregation period, (2) computes and sums their ages and then (3) divides the sum of ages by the number of relevant issues in that aggregation period.
(1) An issue is relevant for an aggregation period if the following two conditions are both met at the same time:
- the issue was created before or during the aggregation period (i.e. created before the end of the aggregation period)
- the issue has not been resolved before the start of the aggregation period (i.e. it has been resolved during or after the aggregation period, or it is still unresolved)
(2) During each aggregation period, the age of a relevant issue is calculated as:
- for issues resolved during the aggregation period: resolution date minus created date
- for issues resolved after the end of the aggregation period or for issues which are still unresolved: the end of the period minus the creation date.
Note: If an aggregation period starts in the past and ends in the future, then Now is used to calculate the age of an issue instead of the end of the period.
(3) The average age for an aggregation period is computed as the ratio between the sum of issue ages and the number of issues which are relevant for that aggregation period. The average age values are displayed in days with two decimals.
In order to display the issues average age in the Flexi Chart gadget, select the Average age option in the Statistic type setting in the primary breakdown. The following image provides an example:
Please note that the average age can only be displayed in Bar/Clustered bar and Line/Multi-line charts. The other chart types are not compatible with average age reporting.
The following settings are applicable when the selected Statistic type is the Average age:
| Setting | Description | ||
|---|---|---|---|
| Aggregation periods | Select the periods on which the issues will be grouped. The available options are: Days, Weeks, Months, Quarters, Years, Auto. If the Auto option is selected, the aggregation periods and time range are adjusted dynamically to produce the most granular yet complete statistics (i.e. with the appropriate aggregation period so that all the relevant issues are included). | ||
| 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 days / weeks etc. | Number | Enter the number of aggregation periods to be displayed. The time range corresponds to the specified number of consecutive aggregation periods. | |
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). All dates is the only possible Time range option if the selected Aggregation period is Auto. | ||
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. | ||
| Value | The gadget automatically fills-in the Value field with the Average issue age value. | ||
3. Examples of Flexi 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:
- Bar chart of Average age by weeks:
- Line chart of Issue Count by Created date:
- Treemap chart of Story Points by Status:
- Word cloud chart of Issue Count by Organizations:
- Clustered bar chart of Story Points by Status and by a smart filter named Team:
- Stacked bar chart of Time Spent by Issue Type and Priority:
- Multi-line chart of Issue Count by Created and Team:
4. Quick tables in the Flexi Charts gadget
Quick tables enable users to easily display the values from charts in a tabular format. To toggle the quick table on or off, simply click on the table icon located in the footer of the gadget.
