Document toolboxDocument toolbox

Usage Guide for Gauge Gadget

Owned by Low Kah Khang (Unlicensed)
Last updated: Dec 11, 2017 by Stella

Introduction

The Gauge Gadget allows you to visualise the number of issues in a custom filter in an effective manner.

In addition, it supports

  • 3 different styles of gauges
  • Custom minimum and maximum threshold values

Usage

To present the information in the Gauge Gadget,

  1. Define and save the Jira filters
  2. Insert the Gauge Gadget on the dashboard
  3. Configure the user preferences for the gadget

Define and save the Jira filters

Please refer to Jira Documentation (Using filters) for a guide on how to create a filter.

Insert the Gauge Gadget on the dashboard

To add a 3 Dimensional Monthly Gadget on the dashboard,

  1. Click on Add Gadget button on the Dashboard view to add a new gadget
  2. The Gadget Directory will pop up
  3. Enter Gauge in the search box to filter the matching gadget
     


  4. Click on the Add it Now button to add the gadget.
  5. Click on the Close button to return back to the Dashboard

Configuring User Preferences for the Gauge Gadget

 

Fill in the preferences for the gadget. Under the "Max Value Type" option, you can choose to have either a fixed value or a dynamic value from the number of issues in another filter, to be the maximum value. The different  configurations available are illustrated below.

Use Number as Max Value OptionUse Filter as Max Value Option
Preference
Description
Current Value Filter The filter in which the number of issues will be displayed in the gauge as the current value
Meter Type

The type of gauge to be displayed. There are a total of 5 different gauges:

  • Horseshoe Gauge – As the number of issues increases, it changes from Green to Yellow to Red
  • Horseshoe in % Gauge – Display the gauge in normalised percentage (0 - 100%) with color from Green to Yellow to Red
  • Horseshoe (Reverse) Gauge - As the number of issues increases, it changes from Red to Yellow to Green
  • Horseshoe in % (Reverse) - Display the gauge in normalised percentage (0 - 100%) with color from Red to Yellow to Green
  • Speedometer Gauge
  • Needle Gauge
Min ValueThe minimum value of the gauge
Max Value Type

Select the type of maximum value for the gauge

  • Maximum value of the gauge should be a fixed value (Use Number as Max Value)
  • Maximum value of the gauge should be based on the number of issues in another filter (Use Filter as Max Value)

Max Value

(For Use Number as Max Value Option)

The maximum value of the gauge

Max Value Filter

(For Use Filter as Max Value Option)

The filter in which the number of issues will be displayed in the gauge as the maximum value
Refresh IntervalHow often the gadget updates itself

 

 

  1. Click on the Save button to save the preferences.