This page relates to version 1.30 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.

Configuring Custom Ratios

In this section:

  1. About Custom Ratios
  2. Adding New Custom Ratios & Custom Ratios' Key Attributes
  3. Editing Custom Ratios
  4. Using Custom Ratios in Rich Filter Gadgets

1. About Custom Ratios

Custom ratios are computed user-defined outputs which can be used in rich filter gadgets. They are defined as ratios, with a numerator and a denominator which can be based on issue count, or numeric or time tracking fields. Optional JQL filtering conditions can be used to filter the contributing issues for the numerator and/or the denominator. Custom ratios can thus be used to compute ratios of different values.

Below is an example of a Rich Filter Simple Gauge gadget which displays two gauges based on two custom ratios: Completion rate and Work ratio.

2. Adding New Custom Ratios & Custom Ratios' Key Attributes

You can add new and see existing custom ratios and their key attributes in the Custom Ratios section of your rich filter.

In order to define new custom ratios, click on the Add custom ratio button at the top-right of the page. The Add a custom ratio dialog will be displayed.

The key attributes of a custom ratio are:

AttributeDescription
LabelThe label is mandatory and it is used to identify and display custom ratios in rich filter gadgets.
ColorOptionally, you can set a custom color that will be used to display the value in the rich filter gadgets.
Numerator base value

The value on which the numerator of your custom ratio is based, selected among Issue Count, or numeric and time-tracking fields.

Numerator JQL

You can optionally define a JQL query to filter the issues which contribute to the numerator of the custom ratio. Only the issues which satisfy this query will be taken into account when calculating the numerator.

Denominator base value

The value on which the denominator of your custom ratio is based. The numerator and the denominator can be based on the same field or on two different fields of the same type. The denominator can also be a constant (fixed value), which you enter when defining the custom ratio.

The available options for the denominator base value depend on the selected numerator base value:

If the numerator base value is

Then the possible options for the denominator base value are

Issue Count

Same as numerator

Issue Count

Constant (fixed value)

A numeric field

Same as numerator

Constant (fixed value)

Any numeric field

A time-tracking field

Same as numerator

Any time-tracking field

Denominator JQL

You can optionally define a JQL query to filter the issues which contribute to the denominator of the custom ratio. Only the issues which satisfy this query will be taken into account when calculating the denominator.

Display format

Specifies the format used to display custom ratios in the rich filter gadgets. The available options are:

  • Percentage – for example, if the value is 3/10, the gadget displays 30%
  • Ratio – for example, if the value is 3/10, the gadget displays 0.3

If the Ratio option is selected, you have the possibility to further select how many decimals to display: none or exactly 3, 2 or 1 decimals.

Custom ratios are always displayed as percentages in gauge gadgets, independently of this setting.

 3. Editing Custom Ratios

The custom ratios section of your rich filter also allows you do to the following operations: 

To do the following:Do this:
View or Edit a custom ratio

Click on any custom ratio to view or edit its configuration, depending on your rights.

Delete a custom ratio

Click on the delete icon located at the right of the custom ratio.

Reorder the custom ratios list

Hover over the vertical “grid” icon, then drag and drop the custom ratio up or down to the new position.

This order is applied when displaying the custom ratios in the settings of the rich filter gadgets.

4. Using custom ratios in Rich Filter Gadgets

Once defined, the custom ratios can be used in the rich filter gadgets that support them. Below we provide the list of rich filter gadgets that can display custom ratios: