Destinations

Describes how external integrations are configured and kept up to date with shifts.

Each On-Call Optimizer schedule can be linked to one or more destinations to enable the export of assigned shifts.

Supported Destinations

Additional destination types (e.g. calendars) will be added soon.

Adding and Removing Destinations

Destinations can be added and removed from a schedule via the “Destinations” tab within a Schedule.

Schedules created via linking an existing schedule will have a matching destination pre-populated which can be removed or edited if desired.

The available configuration parameters for a destination are:

  • Source Assignee: Which of the assignees from the schedule will be exported to the destination.
  • Automatic: When enabled, updated shifts are automatically pushed to the destination whenever new assignments are confirmed on the schedule. If disabled, updates to the destination must be manually triggered.

Destination Behaviour

On-Call Optimizer exports a list of shifts, each consisting of a single assignee to each destination. In order to export a schedule containing both primary and secondary assignees, two destinations will need to be configured, one sourced from the primary assignee, the other sourced from the secondary assignee.

For each destination On-Call Optimizer tracks the end time of the most distant shift that was successfully sent to the destination.

During normal operation the end time of the last shift exported to a destination should match the shifts that have been assigned up to the configured horizon of the On-Call Optimizer schedule. This date can always be viewed in the tooltip of the status icon for the destination on the Destinations tab of any On-Call Optimizer schedule.

Destination Export

When configured for automatic export, the destination will be updated with new shifts after each new assignment is confirmed to the schedule. When automatic export is disabled, the destination will only be updated when an export is explicitly triggered via the user interface.

To trigger a destination export, click the “Export Now” button on the right hand side of the destination’s row.

Destination Status

A status is reported for each destination as one of the following states:

  • OK: All assigned shifts are successfully exported and represented in destination.
  • Pending: No shifts are yet assigned for the schedule to export, or an export attempt is currently in process.
  • Warning: Future shifts (beyond 3 days from now) are not yet successfully exported to the destination.
  • Error: The current or imminent shifts (within the next 3 days) have not been successfully exported to the destination.

Any destination reporting an Error or Warning status will cause the schedule to be reported in the corresponding state also.


Last updated November 7, 2024