Configuration

Understand the configuration options for a schedule and their effects.

The configuration of a schedule controls how On-Call Optimizer will generate shifts to assign for the schedule, and any availability information sourced from other schedules that should be taken into account when generating assignments.

In addition to the schedule configuration described on this page, other aspects of the how the schedule behaves throughout its lifecycle are controlled via:

  • The list of members and their roles and properties on the Members tab
  • The assignment settings accessible by clicking the wrench icon beside the “Next Shift Assignment” heading on the “Overview” or “Assignments” tabs of the schedule.
  • Any destinations that are configured for the schedule.

Basic Configuration

The basic configuration for a schedule includes its Name and the Time Zone in which it operates.

For schedules linked to an external On-Call Product the basic configuration is not editable and will be automatically synchronized from the external schedule.

Shift Configuration

The shift configuration describes how On-Call Optimizer will generate future shifts for the schedule. Up to 10 shifts may be configured on a schedule. The available configuration fields for each shift are:

  • Day: Required. One of the normal days of the week (Mon-Sun) or one of the wildcard values Daily, Weekdays, Weekends.
  • Hour: Required. In 24-hour notation, 00 - 23.
  • Minute: Required. 00 - 59
  • Primary Assignee: Optional (but at least one assignee is required across all shifts).
  • Secondary Assignee: Optional.

Valid values for the assignee fields are either a static member of the schedule or one of the following keywords:

  • BEST_MEMBER to request automatic assignment.
  • LAST_PRIMARY to request assignment of the member who was primary in the last shift.
  • [Not assigned] to request that no member be assigned to this role in the shift.

The Day, Hour and Minute fields describe when each new shift will start. The Primary/Secondary Assignee fields describe who, or how On-Call Optimizer will choose to, assign to each shift.

The [Not assigned] keyword is typically used in the secondary field when only a single assignee is required for the shift, however it can also be used in the primary field when you wish to configure a schedule with non-continuous assignments (e.g. only create shifts for business hours Monday to Friday). The only restriction is that at least one of the shift configurations must contain an assignee - there’s no point asking On-Call Optimizer to manage a schedule to which no-one is ever assigned!

Use the example configs to further understand how shift configurations can be combined to achieve a variety of different schedule types and configurations, or for detailed information consult the extension logic, and assignment algorithm reference.

Cross-Schedule Availability

The cross-schedule availability configuration can be used to automatically generate availability information for a schedule based on the assignments that are present in another schedule.

The availabilty information generated by cross-schedule availability configuration will be used with the same weight and purposes as availability information that has been individually supplied by members from their calendars.

Configuring cross-schedule availability requires 3 pieces of information:

  • Action: The type of availabilty information to create (Block or Prefer).
  • Source Assignee: Which of the assignees from the source schedule to create availability information for.
  • Source Schedule: The schedule from which to source the assignments used to generate the availability information.

Configuring cross-schedule availability creates a dependency on the source schedule which requires that it has been assigned prior to the schedule that is depending on it. Attempts to assign new shifts for a schedule which has a cross-schedule availability dependency on a source schedule which does not yet have assignments covering the dates of the requested assignment will fail as the source shifts needed to generate the availability entries required by the configuration do not exist.

Therefore when configuring cross-schedule availability you need to double-check that the horizon and schedule window settings for the source schedule are appropriately set to ensure it is always assigned before the schedule depending on it.


Last updated November 7, 2024