Administration Guide

Work Calendars

On this page

A work calendar sets which hours count as working time. It is built from three kinds of parts:

  • Working hours: named bands, each either a start and an end time or a day off. A calendar's working week assigns one band to each weekday, and a band can be used by several calendars.
  • Exceptions: holidays, working days, and custom hours that change the working week on given dates.
  • Exception lists: named lists of exceptions that you attach to one or more work calendars. A calendar can have several exception lists, in order.

One calendar can be the default calendar; setting a calendar as the default clears the default from every other calendar. A personal calendar belongs to one person and holds that person's personal events.

Calendars are used in these places:

  • Due dates: a ticket's due date and response date are counted in the working time of its service level's calendar, or of the default calendar when the service level names none. When there is no default calendar either, time is counted around the clock. See Services and SLAs.
  • Technicians: each technician can have a work calendar on the Person record, and a personal calendar with personal events.
  • Projects: a project's calendar is a shared work calendar, not a personal calendar.
  • Workflow conditions: a condition can test whether a date is within a technician's working hours ("is working hours of technician") or covered by a calendar ("is covered by calendar"), and a date comparison by an interval can count the interval in a calendar's working time. A technician's working hours are those of the calendar that governs the person, personal events included; when no calendar governs the person, no date is within their working hours. See Workflow Overview.

The Calendar page, which plots dates of records, is not a work calendar and has no effect on how SLAs are measured. See Calendars.

What you can see and change

  • The Admin Center's Work Calendars page, with all three of its tabs, is gated by its own page permission; see Permissions Reference.
  • Personal work time is controlled by two Person permissions: Modify Own Work Time ("Allows modifying the technician's own work time") and Modify Work Time for All ("Allows modifying personal work time for all technicians").
  • A calendar that a service, a service level, a person, or a project uses cannot be deleted.

In the Admin Center

Open General > Work Calendars. The page has three tabs: Calendars, Holidays and Exceptions, and Working Week.

Define working-hours bands

The Working Week tab lists the working-hours bands. You can create and edit bands, and delete several at a time. The Name column shows a band's name without a leading number prefix such as 1-.

In a band's form:

  • Enter the Name.
  • Choose Working Day or Day Off. For a working day, set the start and end times; the end time cannot equal the start time. For a day off, the times are unavailable.

When your browser's time zone differs from the server's, the form warns that the times use the application server's time zone and says how many hours the server is ahead of or behind your local time.

Create or edit a calendar

On the Calendars tab, New starts the calendar wizard, and editing a calendar opens the same wizard with all four steps filled in. The steps come in a fixed order; Back is available at every step but the first, and steps cannot be skipped.

  1. On the Calendars tab, click New, or edit an existing calendar.
  2. Working Hours: choose a working week for each of the seven weekdays. All seven are required. The list shows each name without its leading number prefix, as the Working Week tab does.
  3. Exception List: attach holiday and exception lists. Each list can be attached once.
  4. Custom Exceptions: add the calendar's own exceptions as Holiday, Working Day, or Custom Hours. They are kept in the wizard and saved when you submit it.
  5. General: enter the Name, which is required. Select Set as default to make this calendar the default.
  6. Submit the wizard.

A custom exception has these fields:

  • Holiday: one of three date specifications. Annual takes a day and a month; the day is limited to 29 for February and to 30 for the other 30-day months. Floating takes the nth or the last weekday of a month. Fixed takes an exact date.
  • Working Day: a date and the working week that applies on it.
  • Custom Hours: a start and an end date and time, the end after the start, and whether the period is work time.

The exceptions grid shows a summary of each exception. Is Work Time is checked for custom hours marked as work time and for a working day whose working week is not a day off.

Define holiday and exception lists

The Holidays and Exceptions tab lists the exception lists. You can create and edit lists, and delete several at a time. A list's dialog has two tabs:

  • Exceptions: the list's exceptions, in the same grid as a calendar's custom exceptions.
  • Calendars: the work calendars the list is attached to. Add attaches the list to another calendar and is unavailable once every calendar has the list.

Exceptions you add, change, or delete in the list's dialog are saved when you submit the dialog. A list with no calendar attached is saved without a question.

TIP: An exception list has no effect on working time or due dates until it is attached to a work calendar. Because one list can be attached to several calendars and a calendar can have several lists, you can keep, for example, a separate list of public holidays for each country your offices are in and attach each list to the calendars of the offices in that country.

Set the default calendar or delete calendars

On the Calendars tab:

  • To make a calendar the default, select that one calendar and click Set as default. The command is available only when exactly one calendar is selected and it is not the default already.
  • To delete calendars, select one or more, delete them, and confirm.

TIP: Keep one calendar set as the default. When there is no default calendar, the due dates and response dates of tickets whose service level names no calendar are counted around the clock, seven days a week, and for a technician with neither a personal calendar nor a work calendar on the Person record, the workflow condition "is working hours of technician" is never met.

In the Settings App

Open General > Work Calendars. The page has three areas, Calendars, Holidays and Exceptions, and Working Week, each with New, Edit, and Delete. The Calendars area also has Set Default. Double-clicking a row runs Edit. Each area's grid has an XML export command in its shortcut menu.

Delete asks for confirmation. A calendar that is in use is not deleted.

Define working-hours bands

  1. In the Working Week area, click New, or select a band and click Edit. The window is titled New Working Hours or Working Hours [<name>].
  2. Enter the name.
  3. Choose Working Day or Day Off, and for a working day set the From and To times. A new band starts as a working day from 09:00 to 18:00.
  4. Click OK. It is available once the name is filled in and something has changed, and, for a working day, only while From and To differ.

Create or edit a calendar

  1. In the Calendars area, click New, or select a calendar and click Edit. The wizard is titled New Calendar or Calendar [<name>].
  2. On Working Hours, choose a band for each weekday, Monday: to Sunday:. Each box shows the band's name, and its list shows the bands with their name, from time, to time, and day-off setting. The bands must already exist: they are created in the Working Week area, not in the wizard. Next leaves this page only when all seven weekdays have a band, and otherwise names the weekday that has none.
  3. On Exception Lists, click Add to attach exception lists. The picker offers only exception lists that are not yet attached, and Add is unavailable when there is none left. Exceptions in an upper list override the exceptions of a lower list.
  4. On Custom Exceptions, add the exceptions specific to this calendar. They override the exceptions of the exception lists.
  5. On General, enter the name and, if you like, a description. Select Set as Default to make this calendar the default.
  6. Click Finish. It is available only on General, once a name is entered.

To make an existing calendar the default, select it in the Calendars area and click Set Default.

Define an exception list

  1. In the Holidays and Exceptions area, click New, or select a list and click Edit. The editor is titled New Exception List or Exception List [<name>].
  2. Open the Add menu and choose Holiday, Working Day, or Custom Hours. The window that opens carries the entry's name as its title.
  3. Enter the Name: (required, up to 50 characters) and, if you like, a Description:, and fill in the page for the type:
    • Holiday: choose Annual: (the default), Floating date: (First, Second, Third, Fourth, or Last weekday of a month), or Fixed date:.
    • Working Day: the Date: and the Hours: band that applies on it, chosen from the bands already defined. Both are required.
    • Custom Hours: Start Date: and End Date:, with their Time: fields, and Is work time.
  4. Click OK. It is available while the page is valid.
  5. On the editor's Calendars page, attach the list to work calendars. The picker offers only shared work calendars, never personal calendars.
  6. Click OK to close the editor.

The exceptions grid shows Type, Name, From Time, To Time, Time, and Is Work Time, with Edit and Delete beside the Add menu; the Del key also deletes.

When you close a new list with OK after changing it and no calendar is attached, you see "This Exception List has no effect until you apply it to a work calendar. Do you want to specify a work calendar now?" Yes takes you to the Calendars page and opens the picker; No saves the list without a calendar. An existing list whose calendars you remove is saved without the question.

Manage personal event categories

Personal events are filed under personal event categories, which set an event's color. The categories are listed at Workflow and Business Logic > Organization Management > Persons > Classification, on the Personal Event Categories page. The page shows the columns Category, Enabled, All day, Work time (Available, Busy, or Non-working), and Color. The two built-in categories Work time and Non work time are not listed and cannot be renamed or deleted there.

  1. Click New, or select a category and click Edit. The window is titled New Personal Event Category or Personal Event Category [<name>].
  2. Enter the Category: name. OK stays unavailable while it is blank.
  3. Choose the Color:. The ellipsis button next to the list opens the Windows Color dialog for any other color.
  4. Set Enabled, All day, and Is work time. For a work-time category, choose Available or Busy; a category that is not work time is always saved as not available.
  5. Click OK.

A new category starts white, enabled, and available.

To change the order, select one category and click Move Up (Ctrl+Up) or Move Down (Ctrl+Down); these work while the grid's quick filter is empty. The shortcut menu adds Sort by Name, Enable, and Disable.

Delete asks for confirmation. A category that a calendar exception still uses is not deleted, and you see "Unable to delete item because it is referenced by other database object(s). To delete the item, you need to remove these dependencies first." When you delete several categories and others remain after a refusal, you are asked "Would you like to continue removing the remaining records?" (Yes, Yes to All, No).

Exception types

Type What it does
Holiday Makes the whole day non-working. The date is annual (a day and month every year), floating (the first, second, third, fourth, or last given weekday of a month), or fixed (one date). A holiday has no work-time setting.
Working Day On one date, applies a working-hours band you choose. Whether the day is working time follows that band.
Custom Hours Covers a start and an end date and time, marked as work time or not.

Two exception categories come with every database, Work time and Non work time; a custom exception marked as work time uses the first. Personal events use the personal event categories; see Manage personal event categories.

How the calendar in force is resolved

For a date, a calendar's working time is worked out in this order:

  • The working week gives the weekday's working hours.
  • The calendar's own exceptions change them. They override the exceptions of the attached exception lists.
  • The attached exception lists follow. An exception in an upper list overrides the exceptions of a lower list.
  • For a personal calendar, the person's work calendar from the Person record comes next, or the default calendar when the person has none.

The calendar that governs a person is their personal calendar, then the work calendar on their Person record, then the default calendar. The SLA clock never uses a personal calendar.

What technicians see in the Web App

The calendars and categories set up here appear on a person's record in the Web App, where personal events are added, changed, and rescheduled.

  • The Technician tab inside the Person record's General tab holds the skill level, the work calendar, and the hourly rate. The work calendar field offers shared work calendars only, not personal calendars.
  • The record's Work Calendar tab shows the person's calendar: the personal events, and the holidays and other exceptions of the calendars it inherits. Personal events can be edited there; a holiday or a working-day exception cannot: clicking one opens nothing, and it cannot be dragged. The tab is read-only whenever the record is.
  • The dialog for a new personal event offers the enabled personal event categories, in the order set on the Settings App's Personal Event Categories page with Move Up and Move Down.
  • Each event is drawn in its category's color, so a color change on that page recolors the events already filed under the category. A category whose color is black is drawn in the theme's event color instead. The events of a disabled category are still shown.