Kanban Gantt for Jira Documentation with Adaptavist Scriptrunner

This is the documentation of the plugin Kanban Gantt for Jira Server and Datacenter.

The plugin is totally OpenSource and FREE. The source code can be forked and reviewed in GitHub (this link). The original creator is the user of Github @hvqzao

Before the install we recommend to take a look the fantastic review of the plugin by Ravi Sagar.

By the moment the plugin is only compatible with:

• Languages en, es, nl, fr, it, cs, de, zh  accepted
  • Obtained by the Jira REST API call ./rest/api/2/myself
  • Value stored in a Browser cookie: gantt_locale
• Date-formats ( all combinations of d, dd, M, MM, MMM, yy, yyyy in any order with separator “/” or “-“) 
  • Obtained by the Jira REST API call ./rest/api/2/application-properties?key=jira.lf.date.dmy
  • Value stored in a Browser cookie: gantt_date_format

The Date-format setting is obtained by the Jira System setting (In the Look&Feel section) called “Day/Month/Year Format” and must be consistent with the value of “Complete Date/Time Format“:

If your Jira is configured in other time locale and language, you always can use the plugin Adaptavist Scriptrunner to show Calculated fields in the issues and solve the problem. The name of this feature is “Script fields“. In the last section of this document we will show some tricks to show complex calculated date fields.

The configuration of the plugin is very easy: Just go to your Kanban board and go to the Settings/Configuration and click in the Card Layout part in order to show 3 extra fields in the cards of the Kanban board. The first customfield must be some field to make the Group By hierarchy in the Gantt, for example, you can use the system field “assignee“. As second field you can use “Created” system field or an “Start date” custom field (created by you previously in Jira), and as third field you can use “Due Date” or “Resolved” or “Updated” system fields or an “End date” custom field (created by you in Jira). See here an example:

Now you will see the Dates on the cards if you take a look to the Kanban board:

Now you can click in the Gantt button and show the diagram!

The plugin will show the current work and will remove the old work automatically. The plugin aggregate/combines the tasks by the first field (in this case “assignee“) and show the duration in “Days” of the task. The task will be colorized by the color of the Epic associated.

---

 

Now we will show how to create Calculated script dates to show in your cards, in this way your Gantt will be dynamic and will show the info you need. Create a script field with Scriptrunner is very easy. Just go to the “Script fields” section of the plugin. Now you can create the script field.

Example with a Date-time calculated field ( please note the Searcher template is “Date Time Range picker“)

Now configure the script field as Date-time

Now we can develop complex formulas/scripts to show our Date field in a dynamic way and calculated on view! Example to show Transition dates (remember, you can show the first date of transition or the last date…just change the “reverse()” method of the function):

Example with the standard Dates of an Issue: Created, Updated, Resolved, DueDate,…

You can condition on Project, IssueType or Status!

Also, probably you want to obtain a customfield extra date to show calculated, from a linked issue…see this complex example:

The plugin Kanban Gantt for Jira can work with String dates, then the Language of your Jira Server is not a problem to use the plugin. You can create Script Calculated Date fields in String format! Just create an HTML Script Field. Please note the “Free Text Searcher” in this case.

And the HTML as a template (the result will be not editable in this way):

Now see this example to format the Date to English obtaining a custom field called “Start Date” and shown the value formatted

The same with the Date standard issue fields like Created, Updated, Resolved, DueDate…

As you read, the plugin is and will be always Open Source and collaborators all welcome always of course! For any type of suggestion or issues/bugs you can contact in our Customer Portal (here the link).

By MrAddon