Versions Compared

Old Version 29

changes.mady.by.user Praveena Manohar

Saved on

compared with

New Version Current

changes.mady.by.user Praveena Manohar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this sectionContents:

Table of Contents
stylenone

Anchor
section1
section1

...

About the Rich Filter Statistics gadget

The The Rich Filter Statistics gadget  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 

    using Rich Filter Controller

     gadgets

     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

    in order

    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 

     and Story Points);

  • the gadget can display custom ratios;

  • the gadget can display one or

    several

    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 -level Status:

...

Tip

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

Anchor
section2
section2

...

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

Rich filter

Select the rich filter the gadget will use.

Click

on the 

the Rich Filter

 button

 button to display the list of rich filters; you can either scroll through or use the search box to find the desired filter

you need

.

Info

The gadgets’ configuration forms only show the rich filters you

are allowed to

can view.

 See

 For more details, check the Rights and Permissions

documentation

page

for details

.

Working

query

Query

The working query is an additional JQL query

which

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 on

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:

Image Removed
Image Added
Note

The gadget supports several types of breakdown 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. 

Anchor
section2a
section2a

...

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 

your Statistic type:

  • Total:

 this

  •  This will

sort

  • be sorted by the value computed for

each Statistic type group

  • each statistical type group (if

there are

  • multiple value columns exist, the first one

is

  • will be used for sorting).

  • Alphabetical:

 this

  •  This will use alphabetical order for the

 Statistic

  • statistical type

 groups

  •  groups.

  • Natural:

 this

  •  This will use the native sorting order of the issue field or smart filter selected as Statistic type, i.e., the order

that has been

  • configured for

the options of

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

limits

limit the number of result rows to display.

Tip

The user can still display all the computed rows by clicking on the number of rows in a rounded rectangle

located

at the bottom right of the gadget.

Show percentage bars

If checked, the gadget displays

as

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

of the

selected

values

value.

Values

Select the values to be computed for

each 

each Statistic type

 group

 group. You can select up to 10 values at a time.

The following value types are available:

  • Issue Count:

 computes

  •  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

how many 

  • the number of Story Points

 there are Statistic

  • for each

 

  • Statistical type

 group
 as configured

  •  configured in the rich filter (aggregation formula, display options, etc.).

  • Custom ratios: displays a custom ratio

as

  • configured in the rich filter (percentage or ratio).

Image Removed
  • Image Added

Anchor
section2b
section2b

...

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, and Auto.

Tip

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

Range





Together with its

subsettings

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

The time range

subsettings

sub-settings depend on the option selected in the Time range drop-down as described below.

Time

range

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

Tip

Fields like Created or Resolved always contain past values

that are in the past

. Therefore, you should always

select 

select Past for these fields, as you will never find any

issue

issues 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 

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

 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

occurring

in the issues' values

of the issues

).

Info

All dates

is

are the only possible Time range option if the selected Aggregation period is Auto.

Contextual options


These are predefined Time range options

which

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

as

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

of the

selected

values

value.

Values

Select the values to be computed for

each 

each Statistic type

 group

 group. You can select up to 10 values at a time.

The following value types are available:

  • Issue Count:

 computes

  •  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

how many 

  • the number of Story Points

 there are for each Statistic type group

  •  for each Statistical type group.

  • Custom values: displays a custom value

 as configured

  •  configured in the rich filter (aggregation formula, display options, etc.).

  • Custom ratios: displays a custom ratio

as

  • configured in the rich filter (percentage or ratio).

Image Removed
  • Image Added

Anchor
section2c
section2c

...

Statistics on time series

The gadget can also be configured to display one or several more time series. In order to To do so, you need to select the option Time series option in the Statistic type setting. Image Removed

...

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

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.

Tip

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

Range





Together with its

subsettings

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

The time range

subsettings

sub-settings depend on the option selected in the Time range drop-down as described below.

Time

range

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

Tip

Fields like Created or Resolved always contain values

that are in

from the past. Therefore, you should always

select 

select Past for time series based on these fields, as you will never find any

issue

issues created or resolved in the future.

Fields like Due Date contain values that can be both in the past and in the future. For a 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

 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

occurring

in the issues' values

of the issues

).

Info

All dates

is

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

Reverse sort order

If checked, the default chronological order is reversed.

Show percentage bars

If checked, the gadget displays

as

a bar chart

,

for each of the selected time series:

  • for time series based on all value types other

than 

  • than custom ratios, the proportion of each value relative to the total;

  • for time series based

on 

Show totals

If checked, the gadget displays a row with the totals for each

of the

selected time series.

Time series

Select

You can select one or several time series to

be displayed. For each selected time series, the

display. The gadget displays a new column for each selected time series with the values computed from the given time series.

Image Removed
Image Added

Anchor
section3
section3

...

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 located at the gadget's bottom right of the gadget.

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

Info

The order of the slices or bars in the quick charts is the same as in the table.

The maximum rows setting applies to the quick charts as well.

...