JIRA Calendar Plugin

Name JIRA Calendar Plugin
Vendor Atlassian Pty Ltd (Website)
Authors Hamish Barney, Atlassian
Homepage http://confluence.atlassian.com/display/JIRAEXT/JIRA+Calendar+Plugin
Issue Management http://developer.atlassian.com/jira/browse/JCAL
Categories Content
Version 1.8
Availability JIRA v3.10.2 to v3.12.3
State Stable
Support Atlassian Supported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/JIRAEXT/JIRA+Calendar+Plugin
Java API Docs n/a
Download Source http://svn.atlassian.com/svn/public/contrib/jira/jira-calendar-plugin/tags/1.8/
Download JAR jira-calendar-plugin-1.8.zip

Compatibility With JIRA

Plugin Version 3.10.2 3.11 3.12.1 Tested Supported
1.8 David Chui (Jan/28/2008)  

Description/Features

The JIRA Calendar Plugin shows issues and versions in a calendar format based on their due date. Calendars can be based on a filter or on a project. It is developed and maintained by Atlassian.
The calendar can be viewed in two formats:

  • HTML - as a portlet or project tab
  • ICal - as an ICal file that can be viewed in any ICal file viewer

The plug-in consists of the following components:

  • Calendar Portlet - A portlet for displaying the Calendar in HTML format in one of the user's portal pages. Calendars can be based on a filter or a project.
  • Calendar Project Tab - Displays a HTML Calendar for the issues associated with the project being browsed in HTML format
  • HTML Calendar Servlet - This servlet returns HTML fragments for the Calendar Portlet and the Calendar Project Tab. This lets the Portlet and the Project Tab switch between months without reloading the whole page.
  • ICal Calendar Servlet - This servlet is responsible for serving the ICal format files. There is a link to this servlet provided in the Calendar Portlet and Project Tab.

The Calendar Portlet and the Project Tab remember which month was being browsed and saves it in the session. This means that, for example, when you return to your dashboard the Calendar Portlet will continue to show the month you were browsing when you last visited the dashboard this session.

Version History

Plugin Version JIRA Version Comments
1.8 3.10.x, 3.11
Includes fix for jra-13010 (Priority colours not being shown when the colours are not correctly specified in the administration).
1.7 3.10.x Links versions to the new Browse Version pages
1.6 3.6.x Includes fix for jcal-32 (Errors being written to logs when browsing between months).
1.5 3.6.x Includes fixes for jcal-25 (not encoding html in issue title and description fields) and jcal-24 (ignoring browse project permission and displaying release information).
1.4 3.6.x Includes fixes for jcal-9 and jcal-17 (some issues not being shown), jcal-10 (JavaScript problems in some browsers) and jcal-15 (problems displaying calendars in some locales).
1.3 3.6.x Includes fix for jcal-7 ArrayIndexOutOfBoundsException encountered when browsing.
1.2 3.6.x Includes fix for issues: weekdays incorrect (jcal-5) and displaying filters where multiple projects were selected (jcal-6)
1.1 3.6.x Includes fix for issue jcal-1
1.0 3.6.x Initial release. Includes Portlet, Project Tab and ICal Export

Usage & Installation

  1. If you have downloaded the ZIP file, unzip the ZIP file.
  2. Install the plugin by copying the JARs to WEB-INF/lib inside your JIRA web application, remember to delete old versions of the jar files if they exist.
  3. Restart JIRA.
    • Note: You must restart JIRA after this step, before the next!
  4. Now you can add new calendar portlets to your Dashboard, or view calendars from any projects Browse Project page.

    Screenshots
    (view as slideshow)
           
      JIRA Calendar as Project Tab   JIRA Calendar imported into ICal   JIRA Calendar Portlet  
     
               
      JIRA Calendar Portlet With Pop-up          
     

    If you find any bugs please log them at http://developer.atlassian.com/jira/browse/JCAL

Labels

 
  1. Jun 22, 2006

    seth ladd says:

    Hello,  We just installed the calendar plugin into JIRA Professional Editio...

    Hello,

     We just installed the calendar plugin into JIRA Professional Edition, Version: 3.6-#153.  We are unable to import the iCal file into Outlook 2003.  We get a "Cannot import vCalendar file." popup warning/error from Outlook.

     
    Any ideas?  We like the calendar idea, but the default rendering in HTML doesn't show the actual names.

    Thanks!

    1. Jun 27, 2006

      Hamish Barney says:

      Hi Seth, You could be experiencing an authentication problem. Are you subscribi...

      Hi Seth,

      You could be experiencing an authentication problem. Are you subscribing to the ICal feed from outlook? Outlook doesn't share the session with the browser so it could be that Jira sees the request from Outlook as coming from an unauthenticated user and so isn't returning the ICal file.

      If this is the case there are two ways of solving this problem:

      • You are can you try downloading the ICal file manually from your browser and then importing the downloaded file into outlook.
      • You can also add your user name and password to the URL Outlook uses to retrieve the ICal file, this will allow Outlook to retrieve the ICal file as you. If the URL is something like: "http://my.server/jira/plugins/servlet/calendar?searchRequestId=10000&showVersions=true"
        then add your username and password to the URL:
        "http://my.server/jira/plugins/servlet/calendar?searchRequestId=10000&showVersions=true&os_username=<USERNAME>&os_password=<password>"

      You said that the HTML view doesn't show the actual names. What do you mean exactly? Do you want to see the names of the issues displayed in the calendar view instead of the coloured squares?

      You can log any issues or suggestions for improvements at: http://developer.atlassian.com/jira/browse/JCAL

      Let me know how you get on.
      Thanks,
      Hamish

      1. Jun 27, 2006

        seth ladd says:

        Thanks for the reply. &nbsp;I did right click and save the iCal file to my deskt...

        Thanks for the reply.

         I did right click and save the iCal file to my desktop and attempted to open it from there.  I receive the same error.  Looking at the file contents, they look correct (that is, they look like a real iCal file)

         I can paste in the iCal file if that helps.

        1. Jul 03, 2006

          Hamish Barney says:

          Hi Seth, If you can post the ical file or send it to me (hamish@atlassian.com) ...

          Hi Seth,

          If you can post the ical file or send it to me (hamish@atlassian.com) that would be great. Its a pity that the error message isn't a bit more descriptive.

          Thanks, 

          Hamish 

          1. Nov 05, 2006

            Daniel Micanek says:

            Hi, I have the same problem. We have Powered by Atlassian JIRA™ the Professiona...

            Hi,

            I have the same problem. We have Powered by Atlassian JIRA™ the Professional Issue Tracker. (Enterprise Edition, Version: 3.6-#153. I now send ical file.

            Thanks,

            Daniel

    2. Dec 05, 2006

      Brill Pappin says:

      Same problem here... A clue was that it was complaining that it might be a Lunar...

      Same problem here...

      A clue was that it was complaining that it might be a Lunar calendar. Not sure of the details but I'll post more info if I get some.

  2. Jun 28, 2006

    Ivette Mestre says:

    Hello, We just finished our first release tracking issues using Jira. The proble...

    Hello,

    We just finished our first release tracking issues using Jira. The problem is that when I "publish" the release, I'm not longer able to list the tasks that were included on it when I click on the release icon in the calendar (it shows now as a closed package). This is because the associated filter has the condition Resolution = Unresolved, and I already resolved all those issues because we finished work on them.

    I think it would be nice if when you click in the release icon all the issues associated with the release were returned, regardless of the resolution.

    Thanks,

    - Ivette

    1. Jul 31, 2007

      wnjer says:

      \\
  3. Jul 15, 2006

    Ruben Miranda says:

    This is a most excellent plugin, thanks for your effort in putting this together...

    This is a most excellent plugin, thanks for your effort in putting this together.

  4. Jul 17, 2006

    Amos Gouaux says:

    This is a wonderful plugin. The only thing that I'd like to see is an option to ...

    This is a wonderful plugin. The only thing that I'd like to see is an option to only show unresolved issues. That way we can see right away not only something is due, but it's still unresolved.

  5. Jul 17, 2006

    Ruben Miranda says:

    I thiink it would make more sense, instead of adding an unresolved yes/no flag, ...

    I thiink it would make more sense, instead of adding an unresolved yes/no flag, to instead incorporate this plugin into the Filter view. That way you can search for whatever criteria you want, then show it in a calendar/iCal feed.

    On that note, vote for it at JCAL-13!

  6. Sep 26, 2006

    Eyal Kaduri says:

    Good day, This Plug in Seems to be very helpful, however is there a way for me t...

    Good day,

    This Plug in Seems to be very helpful,

    however - is there a way for me to select ( Hard coded - or by upcoming version of the plug-in ) the info/values to be used in the Calendar View?

     Reason:

    Due Date is mainly used for tasks and not actual issues that require fixing ( Bugs etc. ). So we use a custom field called "Expected Resolution Version" - ( which has no alternative in JIRA - no "Due Version" etc. ) - i would like to see issues with Due Version / Resolution Version especialy with the ability to Tag/Untag "Resolved/Unresolved",

    Thanks in advance

    Eyal

    1. Sep 27, 2006

      Jeff Turner says:

      Wouldn't you then just have hundreds of issues on the one date associated with t...

      Wouldn't you then just have hundreds of issues on the one date associated with the "Expected Resolution Version"? How do you get a date from a version?

    2. Nov 26, 2006

      Alex Holtz says:

      We have a similar process to what Eyal talks about with "Release versions" that ...

      We have a similar process to what Eyal talks about with "Release versions" that have codenames. A popular example would be Apple's OS naming: Jaguar, Panther, Tiger, etc. Internally those values have a release date for Apple and we do something very similar.

      I'm not sure how you would get a date from these values actually - or if it's even necessary - but I can see how this would be a popular use case.

      1. Nov 28, 2006

        Jeff Turner says:

        I'm still not totally sure I understand what you're after. If you could explain ...

        I'm still not totally sure I understand what you're after. If you could explain it in detail, please do so in a new JCAL feature request, so it isn't lost.

        Cheers,
        Jeff

        1. Mar 06, 2007

          Jeff Heinen says:

          For another example, one of the groups here uses JIRA as a "trouble ticket" syst...

          For another example, one of the groups here uses JIRA as a "trouble ticket" system. "Due Date" has been used as the "Deadline", but there is also the concept of "Work Scheduled Date". They would like the calendar to be able to use any "Date Picker" type field. So they can make a calendar of what days tasks are scheduled for.

          As I don't see a issue for this, I made JCAL-29.

  7. Dec 13, 2006

    husnu senturk says:

    Hi, I just installed plugin by copying the JARs to WEBINF/lib and then restarted...

    Hi,

    I just installed plugin by copying the JARs to WEB-INF/lib and then restarted Jira but I couldn't import the iCal file into Outlook 2003. I read your comments upward. I tried downloading the ICal file manually from my browser and then importing the downloaded file into outlook acording to your suggestion. Downloaded file's name was calendar and type of file is only file (not *.ics). When I tried to import file, Outlook didn't notice the file. I choose all files type and select downloaded file but  I saw "input  file  may be corrupted"  message.  What is the problem with ICal?

    1. Dec 18, 2006

      Andreas Knecht says:

      Outlook 2003's compatibility with the iCal standard is quite bad. If you do a go...

      Outlook 2003's compatibility with the iCal standard is quite bad. If you do a google search you will find a LOT of problems reported around this functionality in Outlook.

      Your best options are probably to upgrade to a later version of Outlook, or you could give RemoteCalendars a go.

      Cheers,
      Andreas

  8. Jan 04, 2007

    Philippe Leroux says:

    Hi \! &nbsp;&nbsp;&nbsp; Is the plugin compatible with Jira 3.7.x ?

    Hi !

        Is the plugin compatible with Jira 3.7.x ?

    1. Jan 29, 2007

      Jeff Guthrie says:

      echoing Phillippe's question. Is this compatible with 3.7?

      echoing Phillippe's question. Is this compatible with 3.7?

  9. Jan 08, 2007

    bwentink says:

    The screenshots show various colored squares (red, green, black, etc.).&nbsp; I ...

    The screenshots show various colored squares (red, green, black, etc.).  I assume that they mean certain aspects of the project missed their deadlines, some are in danger of being missed, some are going well, etc.  How do I use these squares in my calendar?  Right now all I see are Issues listed on the dates due.  For example, 1/15/07 displays ISSUES: 2.

    Thank you.

    1. Jan 08, 2007

      Michelle de Guzman says:

      Hi there, I think you'll find that these colours are referring to the issues' p...

      Hi there,

      I think you'll find that these colours are referring to the issues' priority. The colour schemes your system is using should be available via (Admin -> Issue Settings -> Priorities).

      Please let us know if this is not the case for you.

      Cheers,
      Michelle

  10. Jan 30, 2007

    Bhavin Turakhia says:

    does this work on 3.7.x?

    does this work on 3.7.x?

    1. Jan 30, 2007

      Dylan Etkin says:

      Yes it does.

      Yes it does.

  11. Feb 15, 2007

    Rovin Dawson says:

    Hiya,\\ Just wanted to ask if there was any other configurable view other than d...

    Hiya,

    Just wanted to ask if there was any other configurable view other than due dates on calendars? For example, if you have an issue/task that has duration of 10d and you start work on the issue and log time against it, can this be reflected in the calendar. It would be good to show time spent against time remaining/planned.

    Thoughts?

    Cheers

    Rov

    PS I have issues

    1. Feb 19, 2007

      Andreas Knecht says:

      Hi Rovin, Currently the Calendar plugin does not support this. You're more than...

      Hi Rovin,

      Currently the Calendar plugin does not support this. You're more than welcome however to open a feature request here and voting for its implementation. The more votes your feature will receive the more likely it will be to get implemented.

      You may also want to check out the Gantt Chart Plugin or the ILOG Gantt Bridge for JIRA.

      Cheers,
      Andreas

  12. Apr 16, 2007

    Sebastian Otaegui says:

    Hello, i want to add the portlet to a confluence page using the RunPortlet funct...

    Hello, i want to add the portlet to a confluence page using the RunPortlet functionality, is that possible. would you show me the parameters that i have to pass to the app?

    Best regards

  13. Apr 19, 2007

    Bettina Zucker says:

    At first look the plugin seems to work also for Jira 3.8.1. Cheers Bettina Zucke...

    At first look the plugin seems to work also for Jira 3.8.1.

    Cheers

    Bettina Zucker

  14. Apr 25, 2007

    Roy Mattia says:

    I installed the plugin on Jira 3.7.4. The problem I am having is that the colors...

    I installed the plugin on Jira 3.7.4. The problem I am having is that the colorsquares for issues with Blocker or Critical priorities did not display. There doesn't seem to be an issue with these priorities in the "Project" portlet - there these priorities display as red. I had to reset the Status Color of these priorities. Now the colors display. Can anyone explain why this happened?

    1. Apr 30, 2007

      Roy Mattia says:

      I can answer my own question now. The color values for the default priorities "B...

      I can answer my own question now. The color values for the default priorities "Blocker" and "Critical" were missing the leading "#" in the Priorities configuration. Selecting a different color fixed this, and entering the "#" at the beginning of the value would have done the same.

  15. May 22, 2007

    Bertrand Ducret says:

    Hello, it seems the links
    1. Jul 02, 2007

      Hamish Barney says:

      Hi Betrand, We made a mistake in the release process and forgot to update the fi...

      Hi Betrand,
      We made a mistake in the release process and forgot to update the file that contains the version number. The 1.6 jar file does contain the 1.6 version despite this. We'll fix this in the next release .
      Sorry and thanks for letting us know.
      Hamish

  16. Jul 23, 2007

    Neal Applebaum says:

    I'm trying to use the project Tab, but I am finding that it is including Resolve...

    I'm trying to use the project Tab, but I am finding that it is including Resolved (even Closed) issues. This makes it difficult to see what is on the schedule since they show as 'Due' even though they have been closed. Am I missing something here?

  17. Aug 03, 2007

    Dave Finehout says:

    &nbsp;I clicked on the "Current: jiracalendarplugin1.8.zip" link to download and...

     I clicked on the "Current: jira-calendar-plugin-1.8.zip" link to download and install the calendar plugin.

    Under JIRA 3.10.1 it is listed as Calendar - 1.6

    Do I have the right version??

    Thanks,

    Dave 

  18. Oct 01, 2007

    hernan guelman says:

    Suggestion (what do you think?): We do not use the due date as much. But I thoug...

    Suggestion (what do you think?): We do not use the due date as much. But I thought that the calender could/should show issues that have been resolved based on their resolution date (shutdown value, I think this field is not standard and was created to support the charting plug).

    Anyway, it could show issues based on due date or the shutdown date once they have it.

    1. Oct 01, 2007

      Jeff Heinen says:

      I thought of something similar, but for a "Scheduled Date" custom field that we ...

      I thought of something similar