Document toolboxDocument toolbox

Usage Guide for 3 Dimensional Monthly Gadget

Introduction

The Three Dimensional Monthly Gadget allows you to display the selected statistics grouped by month. 

In addition, it supports

  • grouping by year
  • summing up totals for rows and columns
  • clickable links to zoom into the issues matching the statistics

Usage

To present the information in the Three Dimensional Monthly Gadget,

  1. Define and save the Jira filters
  2. Insert the Three Dimensional Monthly 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) 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

 

Inserting Three Dimensional Monthly Gadget on the dashboard

To add a Three 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 "Three" 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 

    Preference
    Description
    Notes
    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 
    Show YearWhether to display the year in the table Possible values are true or false
    If show year is selected false and the matching issues lapse across multiple years, the clickable links will be disabled 
    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