Page tree

This documentation relates to an older version 1.2 of the Structure.Gantt. Visit the [current documentation home].

Skip to end of metadata
Go to start of metadata

Please bear with us as we improve this feature.

At the moment, there is no good user interface for editing the calendars. We are going to ship it in future versions.

Currently, if you need to define a calendar, please refer to the technical documentation about JSON format or write us to support@almworks.com so we can help you.

Structure.Gantt allows you to define different calendars for the following:

This is especially useful when you need more precise planning for resources working on different schedules. 

Schedules are defined as Calendars and Structure.Gantt comes with two predefined calendars: "Standard" (40-hour work week, 9-17 every workday) and "24 Hour", with all time marked as working time.

Jira administrator can also define additional calendars using the Administration | Structure | Structure.Gantt | Work Calendars page.

Calendar format

A calendar is defined by a code in JSON format, which sets the working periods for each day of the week and lists exceptions.

Basic structure

Every calendar consists either of a Week schedule or list of exceptions, or both:

{
  "week": ...,
  "exceptions": ...
}


Week schedule

Week schedule is defined by specifying work ranges for every weekday (monday, tuesday, wednesday, thursday, friday, saturday, sunday):

"week": {
      "monday": [
        {
          "start": 900,
          "finish": 1300
        },
        {
          "start": 1400,
          "finish": 1715
        }
      ],
      "tuesday": [
        {
          "start": 900,
          "finish": 1300
        },
        {
          "start": 1400,
          "finish": 1715
        }
      ]
}

Time is written using HHMM format, where HH is a 24 hours and MM is minutes, for example: `1730` for 17:30 and `930` for 9:30.

You may skip weekday either by skipping its definition at all or by providing an empty list of ranges: 

{"monday": []}


Exceptions

Exceptions are defined for exact dates:

"exceptions": [
      {
        "date": 20170301,
        "workPeriods": []
      },
      {
        "date": 20170305,
        "workPeriods": []
      }
]

Dates are written using YYYYMMDD format, where YYYY is 4 digit year, MM is a month (1-12) and DD is a day (0-31).

Hierarchy

You can also organize calendars into a hierarchy via "Based on" property, so you can create more specific calendars based on some general one ("Standard", for example).

Then extending existing calendar week schedule values are overridden (i.e. defenition for "wednesday" in a child calendar will override "wednesday" schedule of parent calendar).

Time zones

Calendars don't have time zone information and should be written in your local time. Time zones are provided separately and are taken either from the current user profile TZ (for the Gantt chart, configured at User Profile page) or from default or individual resource settings:

Deleting Calendars

Calendars can be deleted (even the ones that are used by other calendars as Based On or by Gantt charts). Gantt will continue to work properly even if a specified calendar can not be found: some hardcoded calendar definition similar to default version of "Standard" calendar will be used. However, this is not normal and should be fixed.

Gantt Info popup will show a warning as soon as the Gantt calendar becomes unavailable.

For the resource calendars issues there is no notification shown.



  • No labels