shift_pattern
- Last UpdatedNov 12, 2024
- 3 minute read
The shift_pattern table defines shift patterns, which are assigned to entities.
-
A shift pattern can contain shift schedules to define when shifts change within the shift pattern.
-
Shift patterns can be a standard recurring pattern that defines normal shift operations.
-
Shift patterns have a start and end effective date, which can be used to define high and low seasonal work or rotational periods. For example, a site might have a high season of 7 days a week with 3 shifts a day and then a low season of 5 days a week with 2 shifts a day.
-
Shift patterns can also be used to define holidays and overtime. These exceptions to the standard shift pattern take precedence over standard shift patterns to remove (holiday) or add (overtime) shifts from/to the standard shift pattern.
-
Standard recurring shift patterns can be assigned to any physical entity ID that has the Can Schedule Shifts capability. A shift pattern that is assigned to any entity will by default be applied to all its child entities that have not been directly assigned a shift pattern. If an entity has more than one parent entity that has a shift pattern assigned to them, then the shift pattern is inherited from the default parent (parent_ent_id in the ent table).
-
Holiday and overtime shift patterns can be assigned to any physical entity that has the Can Schedule Shifts capability or is a child of such an entity.
|
Field |
Datatype |
PK |
Nulls? |
Description |
|---|---|---|---|---|
|
pattern_id |
int32 |
Y |
N |
The shift pattern ID. |
|
pattern_name |
string80 |
N |
N |
The shift pattern name. Must be unique. |
|
start_eff_local |
tsmalldatetime |
N |
N |
Defines the time range, in local time, when the shift pattern is in effect.
|
|
end_eff_local |
tsmalldatetime |
N |
Y |
|
|
recurring |
logical |
N |
N |
True (the default) for regular shift patterns. The shift pattern's schedule is repeated weekly from the start time to the end time (if configured) or repeated perpetually. When true, the additive setting is ignored. False for overtime and holiday shift patterns. |
|
additive |
logical |
N |
N |
True for an overtime shift pattern. An overtime schedule will be merged with a regular shift pattern's schedule for the days that are selected. The unselected days are ignored as they are expected to follow their original schedule. False for a regular or holiday schedule. A holiday schedule blocks out time periods from regular and overtime shifts, do not have shifts, and are identified as No Shift in entity schedules. |
|
enabled |
logical |
N |
N |
Indicates whether the shift pattern is active and so can be used. When true, the shift pattern and its schedules are used at runtime. When false (the default), the shift pattern and its schedules are ignored at runtime It is best to have all the shift schedule links established and have this flag set to true so that the middleware maintenance services will process the shift change next minute. But when it is set to true, the maintenance services will start processing shift changes every minute while the entities are linked/schedules are attached, etc. Therefore, this flag is set to false by default and the user has to enable this flag once all the configuration is complete. |
|
comments |
string2000 |
N |
Y |
Any additional comments about this shift pattern, which will be recorded in the shift_history table when this pattern is used. |
|
last_edit_comment |
string254 |
N |
Y |
Reserved for internal use to indicate why this record was changed. |
|
last_edit_by |
string40 |
N |
Y |
The user who added or last changed this record. |
|
last_edit_at |
tdatetime |
N |
N |
When this record was added or last changed. |