Issue Filter Formula Gadget

On this page

https://youtu.be/UHrCzhj-Z5I

Overview

This gadget calculates and displays the result of a simple formula (like SUM, MAX or AVERAGE) on a numeric field of the issues from a specified Jira issue filter or JQL. The calculated formula result can be displayed as a number, in form of gauge chart or on a 5-star sclale.

You can use this gadget for calculating and displaying various metrics and project key numbers.

For instance, the total remaining work or the work done in your project.

image-20240221-105258.png
Issue Filter Formula Gadget configured to display the result as number

Or, you can display the progress toward your team goals by configuring it as a gauge chart with custom limits and colors.

image-20240514-092140.png
Issue Filter Formula Gadget configured to display the result as gauge chart

In Jira Service Management (JSM), you can use it to make calculations based on the Satisfaction field that is set by customers when completing the satisfaction survey after the ticket closure; for instance, you can calculate and display the average Customer Satisfaction (CSAT) of your support team.

Configuration

The settings of this gadget are divided in 2 tabs:

  • Data tab - contains the required settings of the gadget, such as title or data source

  • More Settings tab - contains the optional settings, such as card colors

Data tab

On this tab you can configure the required settings of the gadget.

Setting

Description

Setting

Description

Gadget Title

Choose what to display in the title bar of the gadget.

The Meaning of the Data

Specify the text to be displayed under the calculated value representing the meaning of that value.

Data Source

Select the type of Data Source used by the gadget:

  • A Saved filter that contains the Jira issues for which you want to do the calculation. Make sure that the specified filter is shared if you want other people to visualize the dashboard.

  • A JQL query that returns the issues you want to be processed by the gadget.

Formula

Choose the basic formula (Sum, Average, Min or Max) to be used in the calculation.

Calculation field

Select the Jira issue field to be used for the calculation. You can choose from a list of the numeric fields available in your Jira instance.

  • On Jira Server and Data Center, the scripted fields added via the ScriptRunner app are also available for selection here, but only if they are configured as numerical fields in the Custom Fields area of Jira Administration. More exactly, their Search Template must be set to Number Search.

  • On Jira Service Management, select the Satisfaction field to calculate, for example, the average Customer Satisfaction (CSAT) based on the feedback provided by your customers after their ticket is closed.

Math transformation

Optionally, you can apply an extra math formula to the result of the basic formula. With this extra math formula, you can practically modify the final result with any operation or math function you want. The formula must contain "x", which represents the result of the initial basic formula.
A good example is when you use a basic formula against a time field of Jira, like the Original Estimate or Remaining Estimate. Jira stores the values of these fields in seconds and the result of the basic formula will also be in seconds. To transform in hours, you must apply the math transformation "x/3600".

Decimal places

Choose the number of decimals to be used when displaying the final result.

More Settings tab

On this tab you can configure the optional settings of the gadget.

Setting

Description

Setting

Description

Display mode

Choose how the result will be displayed:

  • As Number - the default option, which works in all the cases

  • As Gauge chart - in this case you can set custom limits and colors to be displayed by the gauge chart

  • On a 5-star rating scale - if, for example, the gadget was configured to calculate the Customer Satisfaction (CSAT).

Display prefix (unit of measure)

Check this option if you want a text representing the unit of measure to be displayed before the calculated value. A prefix like '$' will be displayed in the form of '$8500.50'.

Display suffix (unit of measure)

Check this option if you want a text representing the unit of measure to be displayed after the calculated value. A suffix like 'h' will be displayed in the form of '168.8h'.

Format the number by using commas

Check this option if you want the calculated value to be displayed with commas. For example, '15300000' will be displayed as '15,300,000' or '5432.1234' will be displayed as '5,432.1234'.

Refresh interval

Choose how often the gadget will refresh automatically.

Related blog articles

The following blog articles provide more information on how to use this gadget.