Document toolboxDocument toolbox

Usage Guide for Rolling Window Monthly Gadget

Owned by Hua Soon SIM [Akeles]
Last updated: Jul 22, 2020 by Angela

Introduction

The Rolling Window Monthly Gadget allows you to see the number of matching issues for the last X months. 

For example, if the current month is Dec, and a 6 months trend was selected, it will display the trend of issues from Jul to Dec.

In addition, there is an option to calculate the average and to compare it with the latest month. If the trend is increasing, it will display a red up arrow. If the trend is decreasing, it will display a green down arrow.

Usage

To present the information in the Rolling Window Monthly Gadget,

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

1. Define and save the Jira filters

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

You can use the advanced JQL functions like startOfYear() and endOfYear() to limit the results of the filter to the current year

2. Insert the Rolling Window Monthly Gadget on the dashboard

To add a Rolling Window 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 "Roll Window Monehtly Gadget" in the search box to filter the matching gadget
     

  4. Click on the Add gadget button to add the
  5. Repeat step 4 for each additional gadget required
  6. Click on the Finished button to return back to the Dashboard

Configure the user preferences for the gadget


  1. Fill in the preferences 

    PreferenceDescriptionNotes
    Saved FilterThe filter for searching the issue
    X AxisThe date field to be used for segmenting the issues across the months in the year
    Y AxisThe issue field to be used for dividing the issues into different category rows
    # of MonthsThe number of months to considerPossible values are 3, 6, 9 or 12
    Period Type

    Available from version 1.7.0/2.2.0 onwards

    Whether to display results for past months or future months

    		Possible values are Months Before or Months After
    Include Current MonthWhether to include the current month. If false, it will start counting backwards from the previous month or forward from next monthPossible values are true or false
    Display AverageWhether to calculate the average and display the trend indicatorPossible values are true or false
    Show TotalsWhether to sum the totalsPossible values are true or false
    Refresh Intervalhow often you want the gadget to update itself
  2. Click on the Save button to save the changes