Shift
This context lets you access and manage a single shift.
Unique Actions
Configure
This action is used to edit properties of shift.
 | Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier. |
Action Type: |
Common Actions
Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status
Context States and Icons
This context has no states. It is always represented by the 
icon.
Advanced Information |
Context Information
Context Type: shift
Context Name: provided by user
Context Description: provided by user
Context Path: shifts.SHIFT_NAME
Context Mask: shifts.*
Context Permissions
Level | Description |
None | No access allowed. |
Observer | Basic event monitoring. Status browsing. |
Operator | Configuration browsing. |
Manager | Shift configuration and removal. |
Engineer | Same as Manager. |
Administrator | Same as Manager. |
Public Variables (Properties)
Common Variables: groupMembership (Group Membership), activeAlerts (Active Alerts)
Shift Properties
See description of the variable and its fields is here.
Variable Name: | childInfo |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | Shift Name. Name of this shift context, required to refer to this shift from other parts of the system. It should satisfy the context naming conventions. Length: 1-50 characters. |
description | String | Shift Description. Length: 1-100 characters. |
type | Integer | Type. 0(Week) or 1(Regular) |
startDate | Date | Start Date. Only for regular shift type |
autoOut | Boolean | Auto Out. |
otAfterEnd | Boolean | Overtime After End. |
otBeforeBegin | Boolean | Overtime Before Begin. |
otDayOff | Boolean | Overtime Day Off. |
otDuringLunch | Boolean | Overtime During Lunch. |
Schedule
See description of the variable and its fields is here. This variable has several differences for week and regular shift types.
Variable Name: | schedule |
Records: | 7 for week shift, 0...unlimited for regular shift |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
dayOfWeek | String | Day Of Week. Regular shifts have no this field. |
isWorkday | Boolean | |
reportingTime | Date | Time-only editor is used. |
knockOffTime | Date | Time-only editor is used. |
hasLunch | Boolean | |
lunchBeginHour | Date | Time-only editor is used. |
lunchEndHour | Date | Time-only editor is used. |
maximumOT | Integer | |
minimumOT | Integer |
Exceptions
See description of the variable and its fields is here.
Variable Name: | exceptions |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
startDate | Date | Date-only editor is used. |
endDate | Date | Date-only editor is used. |
isWorkday | Boolean | |
reportingTime | Date | Time-only editor is used. |
knockOffTime | Date | Time-only editor is used. |
hasLunch | Boolean | |
lunchBeginHour | Date | Time-only editor is used. |
lunchEndHour | Date | Time-only editor is used. |
maximumOT | Integer | |
minimumOT | Integer |
Public Functions
This context has no public functions.
Public Events
Common Events: info (Information)
Was this page helpful?