Skip to end of metadata
Go to start of metadata
Icon

If you are using SQL Server as a database, please make sure you are using 1.2.10 or higher, which fixes a bug that caused search index lock problems.

Description/Features

A plugin providing various charts and reports for JIRA.


These charts and reports provide a visual representation of a project or a saved filter in different contexts.

In general, charts are:

  • run over any saved filter or project
  • for a period of X days previous to the current date
  • broken down into incremental periods of hours, days, weeks, months, quarters or years.
  • hyperlinked to relevant issues in the Issue Navigator
  • linked to a relevant report showing a larger chart, as well as a detailed data table

Gadgets and Reports

The plugin currently includes the following gadgets (not available as report), which are:

  • Average Time in Status - displays the average number of days issues have spent in a status.
  • Average Number of Times in Status - displays the average number of times an issues has been in a status.
  • Time to First Response - displays the number of hours taken to respond to issues in a project or for a filter. Gadget only (i.e. not available as a report).

Only the following is available as chart (report) and gadget:

  • Workload Pie Chart - display the amount of time spent on issues from a project or filter grouped by a statistic type in pie-chart format
    • The issues can be grouped by any statistic type (e.g. Status, Priority, etc.). You must have jira time tracking enabled and issues must have work log time recorded. This report displays the actual time spent by the statistic type (e.g. Component, Assignee etc)

Note: the following charts have been built in to JIRA 4.0 and later, so are no longer part of the Charting plugin:

  • Recently Created Issues - a bar chart showing the issues recently created.
    • The green portion of the bar shows the created issues which are resolved, the red portion shows created but as yet unresolved issues.
    • This visually shows both how quickly you're creating issues, as well as how many of those created issues are resolved.
  • Created vs Resolved Issues - a difference chart showing the issues created vs resolved over a given period.
    • This chart can either be cumulative or not.
    • Areas in red show periods where more issues were created than resolved, areas in green show periods where more were resolved than created.
    • Versions can also be added to this chart, showing you how issue creation & resolution related to releases
  • Resolution Time - a bar chart showing the average resolution time (in days) of resolved issues.
    • This is useful to show you over time whether your team is getting better or worse at resolving issues in a timely fashion.
  • Average-Age Open Issues - a bar chart showing the average number of days that issues have been unresolved
    • This chart displays the average of how long issues remain open on a specified interval (e.g. daily, weekly, etc.)
  • Pie Chart - display number of issues from a project or filter grouped by a statistic type in pie-chart format
    • The issues can be grouped by any statistic type (e.g. Status, Priority, etc.)
  • Time Since Chart - For any chosen date field, shows a bar chart with number of issues with the chosen date field set on that date.

'Charting' View for Issue Navigator

The JIRA Charting Plugin now integrates with your issue navigator. When viewing search results you can click the 'Chart' option in the issue navigator views to popup an instant chart view.

From the chart view popup you have the option to configure any chart that is available via the charting plugin. Once happy with your chart and its configuration you can, in one step, create a named filter and save the chart to any page on your dashboard.

 

Custom Fields

  • Resolution Date (removed from the plugin since version 1.5, in favor of the resolution date system field) - required to be installed, this custom field indexes issue resolution dates (for fast querying during charting) but also allows you to add resolution date into any filter or search. For example: show me all issues resolved during this week or in the last 30 days. This field can of course be combined with other search fields.
  • First Response Date - required to be installed, this custom field indexes the date of the first comment that is not by the reporter (for fast querying during charting) but also allows you to add this date into any filter or search.
  • Time in Status - Stores statistics about the amount of time/times an issue has spent/been in its statuses. This field is used to generate the Average Number of Times Spent In Status and Average Time Spent In Status Charts.

    Please Sir, can I have some more?

    Icon

    I'm always looking for suggestions of new charts to add to this plugin. If you've got a suggestion please raise a feature request with specific details on exactly what data the chart should show, where the data comes from and why it's useful.
    Need support? Please see our support page for details.

Usage and Installation

MS SQL Server users please upgrade

Icon

The 1.1.1 version of the plugin caused problems on MS SQL Server and possibly other databases. Please upgrade the plugin to version 1.1.2.

Headless Mode

Icon

You may need to run Java in Headless Mode. This is accomplished by setting the VM variable - -Djava.awt.headless=true

  1. Copy the plugin JAR to JIRA
    • If you're installing version 1.5 or newer, you should copy the JAR to <JIRA home directory>/plugins/installed-plugins.
    • If you're installing a version older than 1.5, you should copy the JAR to WEB-INF/lib
  2. Restart JIRA
  3. If you're running JIRA 3.x, go to Administration > Custom Fields and add a new custom field of the type Resolution Date. Do not add this field to any workflow transition screens (e.g. Resolve screen), but if you want you could display it on the default ("view issue") screen.
    • Recommendation: name the custom field "Resolution Date"
    • Warning: make sure the searcher is set to "Date Picker" (bonus: this means you can now search and filter by date resolved!)
  4. Go to Administration > Custom Fields and add a new custom field of the type Date of First Response. Do not add the field to any (transition) screens.
    • Warning: make sure the _searcher is set to "Date Picker" (bonus: this means you can now search and filter by date of the first comment!)
  5. Go to Administration > Custom Fields and add a new custom field of the type Time in Status. Do not add the field to any (transition) screens.
    • Warning: make sure the searcher is set to "Free Text Searcher" (NOTE: you will not want to put this field on any screens as the data it stores is not in human readable format)
  6. Go to Administration > Indexing and re-index your JIRA data.
  7. Now you can add new chart gadget to your Dashboard, or view reports from any projects Browse Project page.
    • Note: I've tried to do as much intelligent cross linking as possible. All chart gadget are linked through to relevant report for more detail, and all charts elements (bars, points etc) are linked to a relevant issue search showing you the issues which make up that element.

      Icon

      Please do not add the Resolution Date custom field to any Resolve Issue Screens, this can make it so that the resolution date is calculated incorrectly if the issue does not yet have any change history.

Additional Notes

  1. Internet Explorer users will need to configure the 'Temporary Internet file' settings of their browsers, to be able to print pages with charts correctly.
    The Internet Explorer cache should be set to check for newer versions of stored pages 'Automatically', not 'Every visit to the page' (i.e. no caching).
    For full instructions, see the relevant section of the user guide here.

Screenshots

 

 

5 Comments

  1. The picker for the field Date of First Response is a Date Range Picker, not a Date Picker in 4.x

  2. Ok, I'll bite.  I've reviewed the documentation and I don't see any description of how the "Temperatures in Brisbane" chart was created.   This is the type of chart I would like to use with the summary of logged work hours.  Can someone point me to the documentation for this?

    Thanks,

    Sean

  3. Unknown User (tom.heitbrink@rabomobiel.nl)

    When upgrading from 3.x to 4.x, is the field resolution date stil needed, or canit be removed as a custom field ?

  4. Unknown User (jayajha)

    We use JIRA v4.3.4#620-r152668. Has this plug in been tested for this version? 

  5. Ditto the question about whether the field resolution date is still needed in JIRA versions 4.x and newer.