Planning window
The planning window is the time interval to schedule for.
Typically, it is derived automatically and does not need to be supplied by user, except the case when there is a Multi-day shift sequence patterns starting or ending with one or more OFF
elements.
Example planning window definition from Monday 2024-02-05 00:00
to Sunday 2024-02-11 23:59:59
:
{ "employees": [ ... ], "shifts": [ ... ], "planningWindow": { "start": "2024-02-05T00:00+01:00", "end": "2024-02-12T:00:00+01:00" } }
Please note that the start
time is treated as inclusive, while the end
as exclusive.
If omitted, the planning window interval is derived as follows:
-
start
: the start of the earliest of all shifts with time part adjusted to 00:00 (midnight).
Example: the earliest shift start = 2024-10-10T08:00+01:00
→ window start = 2024-10-10T00:00+01:00
.
-
end
: the next day after the start of the latest of all shifts with time part adjusted to 00:00 (midnight).
Example: the latest shift start = 2024-10-10T08:00+01:00
→ window end = 2024-10-11T00:00+01:00
.