Versions Compared

Key

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

In this section:

...

Contents:

Table of Contents
stylenone

Anchor
section1
section1

...

About Custom Ratios

Custom ratios are computed user-defined outputs which can be that are 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  gadget that displays two gauges based on two custom ratios: Completion rate and  and Work ratio.Image Removed

...

Anchor
section2
section2

...

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.Image Removed

...

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

...

The key attributes of a custom ratio are:

Attribute

Description

Label

The label is mandatory and

it is

used to identify and display custom ratios in rich filter gadgets.

Color

Optionally, you can set a custom color

that will be used

to display the value in the rich filter gadgets.

Numerator

base

base value

The value on which the numerator of your custom ratio is based

,

is selected among Issue Count

,

or numeric and time-tracking fields.

Image Removed
Image Added

Numerator JQL

You can optionally define a JQL query to filter the issues

which contribute

contributing to

the numerator of

the custom ratio's numerator. Only the issues

which

that satisfy this query will be

taken into account

considered 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

Image Removed
Image Added

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 

the Ratio

 option

 option is selected, you have the possibility to further select how many decimals to display:

none

none or

exactly

exactly 3, 2 or 1 decimals.

Image Removed
Image Added
Info

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

Anchor
section3
section3

...

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.

Image Removed
Image Added

Delete a custom ratio

Click on the

delete

Delete icon located at the right of the custom ratio.

Image Removed
Image Added

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.

Image Removed
Image Added

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

Anchor
section4
section4

...

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:

  • The Rich Filter Simple Gauge gadget

    Image Removed
    Have a look at The Image Added

Learn more: Rich Filter Simple Gauge Gadget

...

.

  • The Rich Filter Smart Gauges gadget

    Image Removed
    Have a look at image-20240523-142520.pngImage Added


    Learn more: The Rich Filter Smart Gauges Gadget

    documentation page to see how to configure the gadget


  • The Rich Filter Statistics gadget

    Image Removed
    1880pxHave a look at The image-20240523-142548.pngImage Added


    Learn more: Rich Filter Statistics Gadget

    documentation page to see how to configure the gadget

    .

  • The Rich Filter Two Dimensional Statistics gadget

    Image Removed
    Have a look at The Image Added


    Learn more: Rich Filter Two Dimensional Statistics Gadget

    documentation page to see how to configure the gadget

    .