Configuring Custom Ratios
Contents:
About Custom Ratios
Custom ratios are computed user-defined outputs 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 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 that displays two gauges based on two custom ratios: Completion rate and Work ratio.
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.
To define new custom ratios, click the Add custom ratio button. The Add a custom ratio dialog will then be displayed.
The key attributes of a custom ratio are:
Attribute | Description |
|---|---|
Label | The label is mandatory and used to identify and display custom ratios in rich filter gadgets. |
Color | Optionally, you can set a custom color to display the value in the rich filter gadgets. |
Numerator 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. |
Numerator JQL | You can optionally define a JQL query to filter the issues contributing to the custom ratio's numerator. Only the issues that satisfy this query will be 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: |
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:
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. |
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. |
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
Learn more: Rich Filter Simple Gauge Gadget.
The Rich Filter Smart Gauges gadget
Learn more: The Rich Filter Smart Gauges GadgetThe Rich Filter Statistics gadget
Learn more: Rich Filter Statistics Gadget.The Rich Filter Two Dimensional Statistics gadget
Learn more: Rich Filter Two Dimensional Statistics Gadget.