JIRA TimeTracking Reporting Collection

Name JIRA TimeTracking Reporting Collection
Author(s) Jes A
Homepage N/A
Price 399$ (USD)  Buy Now (Redirect to Paypal)
License Commercial
JavaDocs n/a
IssueTracking http://developer.atlassian.com/jira/browse/TMRPT
Download See Version History below

Trial & Purchase

You can try out the plugin for free for one month.

Buy Now (Redirect to Paypal)

License and Trial terms

Description & Features

JIRA TimeTracking Reporting Collection is a set of reports and portlets presenting time tracking data in various ways. It contains more than 25 portlets and reports. As a supplement also a service can be configured to send a report as an email to one or more recipients. 
The intention with the plugin is:

  • Provide the project participants with accurate and up to date data about the resource consumption.
  • Provide a framework for further development and improvements. 
  • Make it easy to extend or customize.

Filtering criterions - How to filter out issues and worklogs.

Basically reports and portlets uses the same filtering criterions options to filter out issues.

  • Filter or project. Only issues from this filter or project will be listed.
  • Start and end date OR a relative start and end date. Only worklogs in this duration will be listed.
  • Group. Only worklogs from users member of this group will be listed.
  • User. Only worklogs submitted by this user wil be listed.
  • Period. Only relevant for "period" portlets and reports. Define a period - day, week, month or year.

Reports & Portlets

Actually there are only 2 different portlets and 2 reports. But for each portlet and report you can chose all in all more than 25 different ways to present time tracking data, which again can be configured in various ways.

The "Period" portlets and reports makes it possible to get an overview over when the work has been logged in periods of days, weeks, months or years within the chosen duration.

I recommend just to try the plugin out - I have no plans of making user manuals and so on.

Service & Email

It is possible to add a service that will send a report (CSV format) attached to an email. The services uses the same filtering criteria as a portlet.
When you configure the service you will have to specify recipients of the mail, when to run the service etc.

The service is designed so you can make you own report by adding a new velocity file.

Usage & Installation

  1. Unzip the zipfile
  2. Copy the JAR to the WEB-INF/lib folder
  3. Copy the folder com and all its subfolders to WEB-INF/classes
  4. Restart JIRA
  5. Now you can add new portlets from your dashboard or view reports from any Browse Project page.
  6. Optional: To enable a service which can send a report as an email go to the Administration > Services page. Type any name in the Name field and com.ja.jira.plugin.timetracking.service.TimeTrackingReportService in the class field. Configure the service.
  7. Recommendation: You can customize settings in the file com/ja/jira/plugin/timetracking/properties/timetracking.properties
    • Warning: Be careful editing the properties file. Even small errors can lead to that all reports and portlets will break.

Yet another recommendation: In the .properties you can set up filters to filter out groups and alter values in select lists. The .properties file contains info on how to do this. You can also add or remove velocityfiles for the report, portlet and service.

Warning: Do not delete users. A worklog performed by a deleted user can cause the plugin to break.

Notice: The reports and portlets that contains the name Risk depends on the JIRA RiskManagement plugin. You can enable them by outcomment three tokens (risk;risk_barchart;risk_barchart_2) from the timetracking.portlet.keys property in the file com/ja/jira/plugin/timetracking/properties/timetracking.properties.

Customize

You can cutomize and reduce or extend the plugin quite a lot. For instance you can add your own reports, portlets or services by adding a new velocityfile and using the java API.

Look in the com/ja/jira/plugin/timetracking/properties/timetracking.properties file for 'how to'. 

See also this tutorial on how to add a new report, portlet or service: How to add a new report or portlet (to the Jira TimeTracking Reporting Collection)

Version History

Having trouble downloading and unzip zip files?  See this fix CONF-7620

Version JIRA version
Date
Comment
Binary Source
2.00 3.13 2008.10.04 Now works with Jira 3.13
Resolves TMRPT-30 and TMRPT-34
jira-plugin-timetracking.zip n/a
           
1.04
3.12.x 2008.06.06
Resolves this bug TMPRT-26

2008.08.29 - Important: There is a bug in this version. Please check out:  TMRPT-33
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
1.03 3.10.x
2008.02.22
Implements these requests TMRPT-21 and TMRPT-22
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
1.02 3.10.x 2008.02.15 Fixes this request TMRPT-20
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
1.01 3.10.x
2008.02.09
Added an AffectedVersion portlet and report
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
1.0 3.10.x
2007.12.16
This plugin should be ready for a version "1.0" label. The 1.0 version do not contains any updates, but removes some stuff that were used only for testing. jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
0.98 3.10.x
2007.12.03
Fixes this bug TMRPT-14. Few changes in velocity templates.
Does also contain some experimental portlets that will show billing data. One can set up a hour rate per project and user in the .properties file for a fixed period of time - a billing scheme. See the .properties for how to.
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
0.97 3.10.x
2007.12.02
Fixes this bug TMRPT-14. Few changes in velocity templates.
This version is invalid, please do not use
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
0.96 3.10.x
2007.09.15
Added a few portlet templates
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
0.95 3.10.x
2007.08.30
See TMRPT-12
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
0.94 3.10.x
2007.08.26
Updated to work with 3.10
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
0.93 3.7 2007.04.16 Fixes this bug TMRPT-8.
Also a few API changes.
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
0.92 3.7
2007.03.08
Added CustomFieldManager to the velocityparams.
See this coment and thread.
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
0.91 3.7
2007.02.20
Fixes this bug TMRPT-2
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
0.9 3.7
2007.01.07
Updated to work with Jira 3.7.
jira-plugin-timetracking.zip jira-plugin-timetracking_source.zip
0.8 3.6.x
n/a Added plenty more portlets and reports.
Contains also some simple bar charts.
jira-plugin-timetracking.zip
ira-plugin-timetracking_source.zip
0.6.1 3.6.x n/a Bugfix    
0.6 3.6.x n/a Changed the API. Better performance.
   
0.5 3.6.x n/a Initial upload
   

Open Issues






Screenshots






Labels

plugin plugin Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Aug 18, 2006

    jira63 says:

    Hi, Do you have any plan to add some feature to facilitate time logging&nb...

    Hi,

    Do you have any plan to add some feature to facilitate time logging for example under a weekly time sheet format to make it easy for users to log time just once a week instead of every day ? 

    Charly

    1. Aug 18, 2006

      Jes A says:

      For now just reporting. What about the [Kaamelot FastWorklog]? Doesn't...

      For now just reporting.

      What about the [Kaamelot FastWorklog]?

      Doesn't that meet you requirements?

      /Jes

  2. Aug 29, 2006

    Dmitry Tsitelov says:

    Plugin has various problems if JIRA's base path includes some directory after ho...

    Plugin has various problems if JIRA's base path includes some directory after hostname, like 'http://somehost:8080/jira';

    Problem caused by some mistakes with URI.resolve() manipulations in TimeTrackingTools class.
    Consider the patch - TimeTrackingTools.java.patch

    /Cit

    1. Aug 29, 2006

      Jes A says:

      Cit, Can't reproduce the errors when using an extended base path. Actually we u...

      Cit,

      Can't reproduce the errors when using an extended base path. Actually we use it in an installation with nearly the same path as the example - apart from port and domain. (Could it be that the Base URL in Administration > General Configuration is invalid?)

      But anayway: My conclusion is that the plugin will produce invalid URL's when the baseurl and the query string respectively has no trailing or leading "/" (or both has it).

      Will soon upload a new release to fix this. (Also, there is probably already a solution in the JIRA API - has just not been able to find it.)

      Cheers,
      Jes

  3. Aug 30, 2006

    Jes A says:

    The 3.6.1 version of JIRA TimeTracking Reporting Collection has been uploaded wi...

    The 3.6.1 version of JIRA TimeTracking Reporting Collection has been uploaded with af property file with some settings for the "Group Selector" which are specific for my company.

    Please replace the current with this instead. timetracking.properties

  4. Sep 01, 2006

    Asbjørn Aarrestad says:

    Great plugin, but is is possible to add some "grand total" information, ie to th...

    Great plugin, but is is possible to add some "grand total" information, ie to the "TimeTracking Issue Completion" view. (total time estimated, total time spent, total time remaining

    1. Sep 01, 2006

      Jes A says:

      It could be done. But there are a few challenges from my point of view. Fist of ...

      It could be done.
      But there are a few challenges from my point of view.
      Fist of all the TimeTracking Issue Completion is a bit special because it iterates over all issues contained in the filter/project. All the others reports/portlets only iterates over the issues which have worklogs.

      Adding a Grand Total for OriginalEstimate and RemaingEstimate could easily give one an wrong impression of the current status, since not all issues necessarily have estimates.

      The best way to implement the feature is to do it in a velocity file. The documentation of the plugin is currently quite miserable. But you can actually easily add you own velocity files which define you own report or portlets. Look in the .properties file for how to!

  5. Sep 23, 2006

    Zacharias J. Beckman says:

    What would it take to modify the timesheet so that a project is optional (that i...

    What would it take to modify the timesheet so that a project is optional (that is, if no project is specified, we would get a timesheet report across all projects)? In its current form, this report looks great but doesn't fill the need of actually giving us time reports, since each user's work is hidden inside projects. Given the number of projects, I can't run this report for each project and then manually add up user's time across them...

    1. Sep 23, 2006

      Zacharias J. Beckman says:

      Oooh. Figured this out. I created a filter for "All Issues" that is... well, a f...

      Oooh. Figured this out. I created a filter for "All Issues" that is... well, a filter that lists all issues. Period. Big filter, but if I use it in the TimeTracking Report and use a User Total, it works perfect. Exactly what I needed, thanks for this excellent plugin.

      A few minor nits I noticed:

      1. In my system, the "Group" popup contains only one item, "Alle" (which looks like a typo to me, but I'm wondering where the groups are...)
      2. I'm not sure what the Period popup does. Guess I'll experiment with it. Maybe a better description?
      3. The list of "Participating Users" at the top really isn't that useful. I'd consider loosing it... if I run a user total report, it's obviously not necessary, but seeing it on other reports... well, it doesn't really offer any meaningful information, but it does take up a huge amount of space (we have a lot of users).
      1. Sep 24, 2006

        Jes A says:

        1) See my comment from Aug 30 about the properties file in the zip. 2) The diffe...

        1) See my comment from Aug 30 about the properties file in the zip.
        2) The difference between duration and period:
        Duration: Only worklogs from the start and end date will be listed, summed up etc.
        Period: Only relevant for some of the reports/portlets formats. Fx. It will sum up the spent time for a user pr. Day, week, month ect.
        So if Period is only relevant for some portlet/report formats, why can a user select it for all portlet/report formats. Because the advantages of having a generic configuration and a framework for TimeTracking reports and portlets is clearly higher than maintaining several different portlets and reports.
        3) Well, I like to see the participating users. But feel free to edit the velocity files. You can easily exclude it.

        Generally the plugin is rather pure documented. Hoping to update it soon with localization and better documentation.

        But you should have a look in the .properties file. Here you can configure the plugin so it to some extend matches you needs.

  6. Oct 03, 2006

    Steve Ragle says:

    Posting on behalf of a co-worker who can't add comments for some reason even whe...

    Posting on behalf of a co-worker who can't add comments for some reason even when logged in. -Steve

    From: Andrew S.
    Hi,

    We installed your time reporting plug-in for JIRA and it is giving us valuable info, but I have a question.

    The I am using the Time Tracking - issue accumulated report and find that it is only reporting time in chunks of whole hours.  If someone records time spent as 45 minutes the report shows zero.  The totals, however, reflect the correct total number so I think it is just a display issue.  How do I change this?

    Thanks for your help.

    Andrew Stoloff

    1. Oct 03, 2006

      Jes A says:

      It's a bug! Any value below 1 hour (3600 seconds) will be returned as 0 hour...

      It's a bug! Any value below 1 hour (3600 seconds) will be returned as 0 hour. But values higher than 3600 seconds should be returned correct (I.E 5400 seconds will be returned as 1.5 hour.)

       I'm working on a new release which will correct this.

      A temporary fix would be to edit the getTimePretty(long time) method in class com.ja.jira.plugin.timetracking.utils.TimeTrackingTools to return  "return getDecimalFormat().format((double) time / 3600);"

      Thanks for your feedback!

      /Jes

    2. Dec 07, 2006

      Jes A says:

      This bug was fixed by version 0.8

      This bug was fixed by version 0.8

  7. Jan 01, 2007

    Ronald de Vries says:

    Jes, are you checking this plugin for 3.7 compatibility? When will I be able to ...

    Jes, are you checking this plugin for 3.7 compatibility? When will I be able to try this in 3.7EE?

    1. Jan 02, 2007

      Jes A says:

      Ronald, I'm pretty sure that this plugin is not compatible with 3.7 because of s...

      Ronald, I'm pretty sure that this plugin is not compatible with 3.7 because of several changes in the API I noticed when I fixed the RiskManagement plugin.
      Hopefully it could be done by the end of this week. But it depends on the impact and depth of the API changes.

    2. Jan 03, 2007

      Darryl Voss says:

      Does anyone have any information on when a release will be made of this plugin t...

      Does anyone have any information on when a release will be made of this plugin that works on version 3.7?  I have upgraded but can no longer use this plugin.

      1. Jan 04, 2007

        Jes A says:

        Hopefully by the end of this week - the API have changed quite a lot from 3.6.x ...

        Hopefully by the end of this week - the API have changed quite a lot from 3.6.x to 3.7 regarding the handling of worklogs.

    3. Jan 07, 2007

      Jes A says:

      Should work with 3.7 now. Let me know if you find any bugs... (and you probably ...

      Should work with 3.7 now. Let me know if you find any bugs... (and you probably will).

      1. Jan 08, 2007

        Dharmendra Varma says:

        Hi Jes Thanks.  However, I am unable to unzip the files.  It is throw...

        Hi Jes

        Thanks.  However, I am unable to unzip the files.  It is throwing error while unzipping it.  Can you please do the needful?

        1. Jan 08, 2007

          Jes A says:

          I think this is a confluence problem. Downloaded files are messed up using IE 7....

          I think this is a confluence problem. Downloaded files are messed up using IE 7.0. Using FireFox no problems.

  8. Jan 22, 2007

    Alister Air says:

    Hi, I've installed the plugin, and reckon it's excellent. The only problem I'm...

    Hi,

    I've installed the plugin, and reckon it's excellent. The only problem I'm having at the moment is in getting that plugin into a Confluence page using the jiraportlet macro. Is anyone else having any problems? I have added the authentication information needed at the end of the URL (&os_username=<user>&os_password=<password>) but the Confluence page displays nothing. The URL ends in targetUser= and I've tried with two & symbols (ie, targetUser=&&os_username). The URL also has spaces in it, as I'm making a report based on a project category (great feature, by the way - not enough system functionality uses project categories) that has spaces in the name. I've tried replacing the spaces with %20 or commenting them using ** but neither help.

    Thanks,

    Alister

    1. Jan 23, 2007

      Jes A says:

      Alister, have created an issue in Jira, tracking this bug: http://developer.atla...

      Alister, have created an issue in Jira, tracking this bug: http://developer.atlassian.com/jira/browse/TMRPT-1&nbsp;(A new version which I think resolves you request can be downloaded from there, let me know if it works)

      Cheers Jes

      1. Jan 24, 2007

        Alister Air says:

        Hi - nope. I get an error message in Confluence. It returns an error: type Ex...

        Hi - nope. I get an error message in Confluence. It returns an error:

        type Exception report

        message

        description The server encountered an internal error () that prevented it from fulfilling this request.

        exception

        org.apache.jasper.JasperException

        and more stuff below this...