A schedule is a calendar used to store events and trigger some control-command based on the current date.


Schedule main concepts

A schedule defines ranges and associates a value to each range. The value is used as an output for some control-command.

Let's take an example with a Boolean schedule:

  • We define three ranges for the Monday weekday (e.g. every Monday)
  • On the right we can see the Schedule output varying over the daytime

 There are two important concepts to know about schedules:

  • The type of schedule. This will define the nature of the output, whether it's a boolean, a numeric etc. It follows the type of points. See Point data type
  • The type of events: an event can be a regular one or a single one (also called special event)

Let's get deeper.


The 4 types of schedules

There are 4 possible types of schedule as there are 4 types of points:

  • Numeric
  • Boolean
  • Enum
  • String

The type of schedule reflects the output type as for a point.

The most common used are Boolean and Enum.


The 2 types of events

We differentiate two types of events: 

  • Regular events:
    • They are defined for a single weekday with a start time and a end time. (These are the input parameters to create a regular event through the API or a connector).
    • They repeat every week
  • Single event also called special event
    • They are defined with a start date and a end date


Each event has an associated value which depends on the type of schedule.


Below is an example of Enum schedule (a text is associated to an ordinal) with regular events:


It can contain also special events:


A special event will take over on a regular event. This is very convenient to define national holidays...


Use of schedule

The concept of schedule is broad and can be used to store room bookings, large equipment running authorization...