User Tools

Site Tools


Action disabled: source
piabplanner:planner_calendar

Planner Calendar

Applies to: Planner 3.0, 3.1

Planner has a calendar that is customiseable either globally for the application, or for each project. The calendar is defined using an XML document, see below.

To change the global application calendar:

  1. Select 'File | Preferences' from the menu.
  2. Select the 'Global Calendar' tab from the Preferences form.

NOTE: The XML definition must be specified in English, even if your desktop locale is different i.e.

  • Days of the week are monday, tuesday..sunday
  • Working interval periods are in decimal notation with '.' as the decimal separator e.g. '8.0'

To change the plan-specific calendar:

  1. Select 'Options | Plan' from the menu.
  2. Select the 'Calendar' tab from the Preferences form.
  3. Click on 'Use Plan-Specific Calendar'
  4. Select a pre-defined calendar, press 'Reset' to load that calendar.
  5. Optionally, edit the calendar to suit your needs and use the 'Check' button to verify it.

Calendar XML Definition

The structure of the calendar XML definition is as follows:

<calendar>
 
  <dayofweek>
    <workinginterval/>
  </dayofweek>
 
  <exception/>
</calendar>

The <dayofweek> element specifies whether each day of the week is a working or non-working day, and whether it will be highlighted in the Gantt chart.

The <workinginterval> element specifies a working interval during the day. A day can contain more than on working interval.

The <exception> element specifies a particular date as a non-working or working day, has special working intervals or need to be highlighted in the Gantt chart.

Default Calendar

The default calendar has these features:

  • Non-working weekend days on Saturday and Sunday
  • 8-hour working day Monday-Friday
  • Two working intervals in the day: 08:00 to 12:00 and 13:00 to 17:00
  • 40-hour working week, 20 working days per month, 200 working days per year.

The XML definition for this is simply…

<calendar usesaturdays="false" usesundays="false"></calendar>

Average Working Hours/Days

Planner stores durations as decimal hours. In order to covert from other duration units e.g. days, weeks, months and years, the calendar can hold your choice of the average conversion factors i.e.

Unit Conversion Type Default Value
Working Hours in Day 8
Working Hours in Week 40
Working Days in Month 20
Working Days in Year 200

Standard Calendar

The Standard Calendar is a full definition of the Default calendar, with each day explicitly specified, so that you can use it as a base to edit from.

<calendar firstdayofweek="monday" 
  workinghoursinday="8" 
  workinghoursperweek="40" 
  workingdayspermonth="20"
  workingdaysperyear="200">
 
  <dayofweek name="monday" isworkingday="True" ishighlighted="False">
      <workinginterval starthour="8.0" finishhour="12.0" />
      <workinginterval starthour="13.0" finishhour="17.0" />
  </dayofweek>
 
  <dayofweek name="tuesday" isworkingday="True" ishighlighted="False">
      <workinginterval starthour="8.0" finishhour="12.0" />
      <workinginterval starthour="13.0" finishhour="17.0" />
  </dayofweek>
 
  <dayofweek name="wednesday" isworkingday="True" ishighlighted="False">
      <workinginterval starthour="8.0" finishhour="12.0" />
      <workinginterval starthour="13.0" finishhour="17.0" />
  </dayofweek>
 
  <dayofweek name="thursday" isworkingday="True" ishighlighted="False">
      <workinginterval starthour="8.0" finishhour="12.0" />
      <workinginterval starthour="13.0" finishhour="17.0" />
  </dayofweek>
 
  <dayofweek name="friday" isworkingday="True" ishighlighted="False">
      <workinginterval starthour="8.0" finishhour="12.0" />
      <workinginterval starthour="13.0" finishhour="17.0" />
  </dayofweek>
 
  <dayofweek name="saturday" isworkingday="False" ishighlighted="True">
  </dayofweek>
 
  <dayofweek name="sunday" isworkingday="False" ishighlighted="True">
  </dayofweek>
 
  <exception date="1/1/2012" isworkingday="False" ishighlighted="True">
  </exception>
 
</calendar>

Friday-Saturday Weekend Calendar

The 'Friday-Saturday Weekend' calendar sets Friday and Saturday as non-working days.

<calendar firstdayofweek="sunday"
  workinghoursinday="8" 
  workinghoursperweek="40" 
  workingdayspermonth="20"
  workingdaysperyear="200">
 
  <dayofweek name="monday" isworkingday="True" ishighlighted="False">
    <workinginterval starthour="8.0" finishhour="12.0" />
    <workinginterval starthour="13.0" finishhour="17.0" />
  </dayofweek>
 
  <dayofweek name="tuesday" isworkingday="True" ishighlighted="False">
    <workinginterval starthour="8.0" finishhour="12.0" />
    <workinginterval starthour="13.0" finishhour="17.0" />
  </dayofweek>
 
  <dayofweek name="wednesday" isworkingday="True" ishighlighted="False">
    <workinginterval starthour="8.0" finishhour="12.0" />
    <workinginterval starthour="13.0" finishhour="17.0" />
  </dayofweek>
 
  <dayofweek name="thursday" isworkingday="True" ishighlighted="False">
    <workinginterval starthour="8.0" finishhour="12.0" />
    <workinginterval starthour="13.0" finishhour="17.0" />
  </dayofweek>
 
  <dayofweek name="friday" isworkingday="False" ishighlighted="True">
  </dayofweek>
 
  <dayofweek name="saturday" isworkingday="False" ishighlighted="True">
  </dayofweek>
 
  <dayofweek name="sunday" isworkingday="True" ishighlighted="False">
    <workinginterval starthour="8.0" finishhour="12.0" />
    <workinginterval starthour="13.0" finishhour="17.0" />
  </dayofweek>
 
  <exception date="1/1/2012" isworkingday="False" ishighlighted="True">
  </exception>
 
</calendar>
piabplanner/planner_calendar.txt · Last modified: 2017/06/22 13:17 (external edit)