Timesheet report and portlet

Name JIRA Timesheet report and portlet
Version 1.7
Product Versions JIRA 3.10+
Author(s) Andriy Zhdanov
Homepage Timesheet report and portlet
Price FREE! Donations welcome
License  
JavaDocs  
IssueTracking http://developer.atlassian.com/jira/browse/TIME
Download JAR normal 1.7
extended 1.8
Download Source http://svn.atlassian.com/svn/public/contrib/jira/jira-timesheet-plugin/trunk/

We encountered lack of resource time tracking in Jira, though, fortunately it was quite easy to develop such reports and even portlet as follows:

1. Pivot project report, that displays a summary of worked hours for project for certain period, where columns a project users (resources) and rows are project issues (tasks). Totals are also displayed: on row - total worked for the issue during the specified period; on column total worked hours by user for the specified period.

See screen shot for pivot report:

2. User Time sheet report, with possibility to chose user and period

See screen shot for timesheet report:

3. Time sheet portlet, that shows logged user' work load during the week.

See screen shot for timesheet portlet:

To install plugin:
1) Download jar (see above)
2) Put it into <jira_home>/WEB-INF/lib directory
3) Extract portlets/dashboard/thumbnails/corner_timesheet.png and timesheet.png from the jar into <jira_home>/portlets/dashboard/thumbnails/ to see screen shots in step 4.
4) Restart Jira. You should see 'Timesheet Report' and 'Pivot Report' under 'Browse Project' in your Jira. Also you should get possibility to add 'Timesheet Portlet' when configuring your dashboard.

Seel also sources it was developed for jira-development-kit-0.4.1. To build it:
1) Checkout sources (see above) into your working directory
2) Install maven 1.0.x (see appropriate documentation for this)
3) Execute 'maven jar' in plugin-timesheet directory. You should obtain atlassian-jira-plugin-report-timesheet-1.x.jar in 'target' directory. Then follow the 'To intall plugin' instructions.

Labels

plugin plugin Delete
report report Delete
portlet portlet Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
  1. Aug 19, 2005

    Mark Hetherington says:

    We are using the User timesheet report in Firefox successfully thank you. Howeve...

    We are using the User timesheet report in Firefox successfully thank you. However, in Internet Explorer, if there are entries for a given issue on more than one day in the specified time period, the display is distorteed with the data shifted one column left for all entreis for an issue except the first one. Is there an easy fix for this?

    Thanks

    Mark

    1. Sep 21, 2005

      Andriy Zhdanov says:

      I've checked once again in IE 6.0.2900.2180.xpspsp2gdr.050301519 it works fine. ...

      I've checked once again in IE 6.0.2900.2180.xpsp_sp2_gdr.050301-519 - it works fine.
      May be this is browser problem, sorry I can't test in all browsers. If you have more details, please provide it, I'll try to solve the problem.

  2. Aug 31, 2005

    Anonymous says:

    Please provide the instalation instructions: 1. downloaded the sources 2. build ...

    Please provide the instalation instructions:
    1. downloaded the sources
    2. build those with maven and obtain the jar
    3. copy the jar to jira web-inf/lib
    4. how is the plugin available? shouldn't it have any properties file? where can be found a properties file for this plugin...

    Thanks

    1. Sep 21, 2005

      Andriy Zhdanov says:

      Added prebuilt jar to attachments and added instractions on how to install it an...

      Added pre-built jar to attachments and added instractions on how to install it and build it from sources.
      There is no need to adjust any properties, untill you want to localise it. Otherwise please see jira plugin development documentation for details.

  3. Sep 21, 2005

    Jonathan Nolen says:

    Unless anyone objects, I would like to move this page into the JIRAEXT: space wi...

    Unless anyone objects, I would like to move this page into the JIRA Extensions space with the other plugins. Andrew, is that OK with you?

    1. Sep 21, 2005

      Andriy Zhdanov says:

      Yep :)

      Yep

      1. Sep 21, 2005

        Jonathan Nolen says:

        Done.

        Done.

  4. Sep 21, 2005

    Andriy Zhdanov says:

    I've just added updated sources and binary jar: show totals at the bottom of th...

    I've just added updated sources and binary jar:

    • show totals at the bottom of the timesheet report
    • escape html for worklog comments in timesheet report,
    • let change reporting day for time sheet portlet (though it is hard-coded to Monday in ...portlet.timesheet.TimeSheet.java, and one will need to adjust week days list in templates/timesheetportlet/timesheet-portlet.vm if will change)
    • fix displaying issues types and priorities for Jira v.3.3.1
  5. Nov 14, 2005

    Anonymous says:

    Hello, I'm having the same problems as reported above (when using both IE6 and O...

    Hello,

    I'm having the same problems as reported above (when using both IE6 and Opera, works in Firefox). Also - the sorting (of more than one time log per event per day) is quite random, and changes from refresh to refresh...

    Regards,

    Rune

     

  6. Nov 23, 2005

    Damon Rand says:

    Likewise.. This works fine for me in Mozilla but in MSIE the date pickers are ap...

    Likewise.. This works fine for me in Mozilla but in MSIE the date pickers are appearing translucent and they invoke some kind of ajax process that gives a network failure. I'm on Jira 3.4.1/TC55.

  7. Nov 28, 2005

    Anonymous says:

    I have had some of these same requirements for time tracking. My requirement als...

    I have had some of these same requirements for time tracking. My requirement also extends into the future for resource planning. For example, we often use Excel to chart out the resource plan for coming months by plotting projects on the y-axis and resources on the x-axis. The cell values then contain the work estimates rolled up for the various projects.

    I have thought that one way to do this in JIRA might be to:

    1) copy the Two Dimensional Statistics portlet code...rename it to something like Advanced Two Dimensional Statistics portlet
    2) In the Edit Screen (which already contains: Filter, X-Axis, Y-Axis, and Show Totals), add a new field called: Cell Value with options for Issue Number (i.e. the current default), Work Estimated, and Work Logged.

    This would enable one to produce a report to show future work estimates for a user defined filter across projects vs. resources.

    I just don't have the resources to create such a portlet right now.

    1. Dec 21, 2005

      Andriy Zhdanov says:

      Just wanted to refer to
  8. Dec 18, 2005

    Rob Kearey says:

    I seem to be encountering some exceptions when using this plugin in 3.4.2 is the...

    I seem to be encountering some exceptions when using this plugin in 3.4.2 - is there anywhere I can lodge bugs?

  9. Dec 19, 2005

    Andriy Zhdanov says:

    I'm sorry to say there is no&nbsp;any bug tracker for this. Software was provide...

    I'm sorry to say there is no any bug tracker for this. Software was provided as is, and everybody is welcome to fix those issues. I just wanted to share the extension we created, and I'd like to see further improvements public as well

    1. Dec 19, 2005

      Rob Kearey says:

      Fair enough I'm not a java programmer, and my progammer teams' time is fully acc...

      Fair enough - I'm not a java programmer, and my progammer teams' time is fully accounted for I'm happy to share bug reports etc.

  10. Dec 21, 2005

    Anonymous says:

    Despite the fact that i specify an exact&nbsp;period for Time Sheet Report or Pr...

    Despite the fact that i specify an exact period for Time Sheet Report or Project Pivot Report i get results over the last week exceptionally.

    Note: My version of JIRA is localized and uses russian time format. Maybe it is the cause?

    1. Dec 21, 2005

      Andriy Zhdanov says:

      Yes, the ddMMMyy date can not be parsed, because MMM is corrupted (java can't de...

      Yes, the dd-MMM-yy date can not be parsed, because MMM is corrupted (java can't decode it from url, I think)

      I suggest you to change corresponding properties in atlassian-jira\WEB-INF\classes\jira-application.properties to use numbers for month.

      As follows:

      jira.date.picker.java.format = d-MM-yy
      jira.date.picker.javascript.format = %e-%m-%Y

      See also Advanced JIRA configuration with jira-application.properties

  11. Dec 30, 2005

    Anonymous says:

    This plugin (and presumably all the time tracking?) has no concept of permission...

    This plugin (and presumably all the time tracking?) has no concept of permissions.

    Users can look at a project pivot report that shows bugs they can't (shouldn't) be allowed to see.

    They can't click on the entry and get any more information about it, but they shouldn't be able to see those bugs at all.

    Ideally, certain users wouldn't be allowed to run these sorts of reports at all.  For us, we want to let our customers see their bugs, and see the comments on their bugs, and all that, but we don't want them to see the work log, and we certainly don't want them seeing all the other bugs we were working on, even if it is just the titles.       

    Karl P 

    1. Jan 02, 2006

      Mike Cannon-Brookes says:

      Karl, All normal reports in JIRA respect permissions users won't be able to see ...

      Karl,

      All normal reports in JIRA respect permissions - users won't be able to see any issue they don't have access too.

      I haven't looked at the code of this particular plugin, but it certainly should be possible to restrict the list of issues down to only issues browseable by the currently logged in user. Any vanilla search request includes these security checks by default.

      I'll see if Jonathan can look into it.

      Cheers,
      Mike

      1. Jan 03, 2006

        Jonathan Nolen says:

        I found the problem and corrected it by adding a new permissions check. Attachin...

        I found the problem and corrected it by adding a new permissions check. Attaching a new version.

        1. Jan 04, 2006

          Karl Palsson says:

          hehe, too fast for me :)&nbsp; I got as far as a dirty hack that mostly worked f...

          hehe, too fast for me   I got as far as a dirty hack that mostly worked for our installation, re-teaching myself java love all over again, but I come back from the holiday to do it properly, and presto!  all done for me    

    2. Mar 27

      Ian Pottier says:

      I am facing another aspect of the lack of permissions checks in this plugin: Any...

      I am facing another aspect of the lack of permissions checks in this plugin:

      Anyone can through the plugin view worklogs of other users and even worse, worklogs with a visibility group!

      Can user choices be limited through configuration for the portlet so only "current user" is available ?

      Can links for the reports be disabled for non admin users?

      Thanks in advance!

      1. Mar 30

        Andriy Zhdanov says:

        Hi Ian, I've just fixed issue with viewableBy for worklogs (see TIME38

        Hi Ian,

        I've just fixed issue with viewableBy for worklogs (see TIME-38), this should obsolete necessity for additional configuraiton options, like "cuurent user only" and reports availability.

        1. Apr 02

          Ian Pottier says:

          Great job Andriy. Is the jar file at the top up to date though? I can't see any ...

          Great job Andriy.

          Is the jar file at the top up to date though? I can't see any change in the plugin so far.

          1. Apr 02

            Andriy Zhdanov says:

            Yes, have you tried to set 'viewableBy' for a (new) worklog record to let say 'A...

            Yes, have you tried to set 'viewableBy' for a (new) worklog record to let say 'Administrators' and view timesheet report being not an administrator?

  12. Jan 10, 2006

    Juergen Kohl says:

    Is it possible to extend the Time Sheet Report with an Excellink? The Pivot Repo...

    Is it possible to extend the Time Sheet Report with an Excel-link? The Pivot Report has one.

    1. Jan 15, 2006

      Andriy Zhdanov says:

      Yes, and you can do it since I'm not sure when I'll need this myself. Just for a...

      Yes, and you can do it since I'm not sure when I'll need this myself. Just for any case, should it be just a dump of worklog for selected params?

  13. Jan 10, 2006

    Juergen Kohl says:

    Is it possible to add custom fields to the issue lists?

    Is it possible to add custom fields to the issue lists?

    1. Jan 10, 2006

      Nick Menere says:

      Hi, I am quite sure it does not come standard but you could modify the source to...

      Hi,
      I am quite sure it does not come standard but you could modify the source to do this.
      Though maybe Jonathan or the original author could provide more help.

      Cheers,
      Nick

  14. Jan 15, 2006

    Zach Garner says:

    Would you please clarify what license this plugin's source code is released unde...

    Would you please clarify what license this plugin's source code is released under. Thanks.

    1. Jan 15, 2006

      Andriy Zhdanov says:

      Artistic license as is, opensource, just refer the author if you distribute it.

      Artistic license - as is, open-source, just refer the author if you distribute it.

  15. Apr 12, 2006

    Vincent Thoulé says:

    Hi, A short comment to notify avalez and comunity, that I have made some enhanc...

    Hi,

    A short comment to notify Andriy Zhdanov and comunity, that I have made some enhancement and migration to JIRA 3.5 of TimeSheet plugin ... See Kaamelot Timesheet.

    Rgds
    Vincent

    1. May 02, 2006

      Andriy Zhdanov says:

      Can we join both projects? I basically would like to have all this in Subversion...

      Can we join both projects? I basically would like to have all this in Subversion, as single project. We can have branch for 3.4.x.

      Please let me know, if there is something that you want to have different than on this page (author, license) , we can change it easily

      1. May 03, 2006

        Vincent Thoulé says:

        Andrew, I contact you by mail. Rgs V.

        Andrew,
        I contact you by mail.
        Rgs
        V.

  16. May 10, 2006

    emilio moreno says:

    Hi Andrew Just a suggestion; would be possible to modify the portlet to select o...

    Hi Andrew

    Just a suggestion; would be possible to modify the portlet to select other user time sheet? When you are a developer it is very interesting to have your own timesheet, but when you lead a programming team you want to see your developers timesheet, not yours.

    Regards

    Emilio

    1. May 18, 2006

      Andriy Zhdanov says:

      It is possible to pickup user on timesheet report configure page. Or you are tal...

      It is possible to pickup user on timesheet report configure page.
      Or you are talking about portlet? So you may be want to setup multiple timsheet portlets for all your team members? If so, please add ticket in project Jira (see on top of the page)

      1. May 18, 2006

        emilio moreno says:

        Yes, Andrew i was talking about portlet; it is incredibly usefull to have one da...

        Yes, Andrew i was talking about portlet; it is incredibly usefull to have one dashboard tab for each developer and in such tab to have the timesheet portlet for thtat developer. I will add the ticket. Thanks.

  17. May 16, 2006

    gregor beedie says:

    Hi Andrew I've copied the .jar and extracted .pngs to their respective dirs. Whe...

    Hi Andrew

    I've copied the .jar and extracted .pngs to their respective dirs. When I restart jira I get the following error message:

    16-May-2006 14:37:02 org.apache.catalina.core.StandardContext start
    SEVERE: Error listenerStart
    16-May-2006 14:37:02 org.apache.catalina.core.StandardContext start
    SEVERE: Context [] startup failed due to previous errors

    I have just upgraded from jira 3.0.2 to 3.6.1; I'm using javaRE 1.4.2_05-b04; with tomcat4.

     Are there any compatibility issues with such a leap in jira versions?

     Regards

     Gregor

    1. May 18, 2006

      Andriy Zhdanov says:

      Sorry, my mistake to compile plugin on JDK 1.5, just fixed it to work on 1.4, pl...

      Sorry, my mistake to compile plugin on JDK 1.5, just fixed it to work on 1.4, please pick up the jar again.

  18. May 18, 2006

    dedang says:

    Hi Andrew, I have downloaded source code&nbsp; as your direction, i am using jir...

    Hi Andrew,

    I have downloaded source code  as your direction, i am using jira enterprise 3.5.3. I use the jira-plugin-development-kit 3.5 as suggested from : http://confluence.atlassian.com/display/JIRA/JIRA+Plugin+Development+Kit&nbsp; for jira 3.5.x. However, i can't compile the source code, below are error messages:

    "
    C:\Downloads\jira-development-kit-3.5\examples\jira-timesheet-plugin>maven jar
     __  __
    |  \/  |_ _Apache_ ___
    | |\/| / _` \ V / -_) ' \  ~ intelligent projects ~
    ||  |_,|_/__|||_|  v. 1.0.2

    Parse Fatal Error at line 1 column 30: Open quote is expected for attribute "htt
    p-equiv".
    org.xml.sax.SAXParseException: Open quote is expected for attribute "http-equiv"
    .
            at org.apache.xerces.util.ErrorHandlerWrapper.createSAXParseException(Un
    known Source)
            at org.apache.xerces.util.ErrorHandlerWrapper.fatalError(Unknown Source)

            at org.apache.xerces.impl.XMLErrorReporter.reportError(Unknown Source)
            at org.apache.xerces.impl.XMLErrorReporter.reportError(Unknown Source)
            at org.apache.xerces.impl.XMLScanner.reportFatalError(Unknown Source)
            at org.apache.xerces.impl.XMLScanner.scanAttributeValue(Unknown Source)
            at org.apache.xerces.impl.XMLNSDocumentScannerImpl.scanAttribute(Unknown
     Source)
            at org.apache.xerces.impl.XMLNSDocumentScannerImpl.scanStartElement(Unkn
    own Source)
            at org.