Use the ShiftBreak table to manage break information for a specified shift.
This table supports Response integrations for Fleet accounts.
Each ShiftBreak provides the following information:
You can create multiple breaks for a given shift. For example, you might want to define morning and afternoon breaks along with a separate lunch break for the same shift. If you assign multiple breaks to the same ShiftId, each break must have a unique name.
You can also specify whether the break must start at a specific time or within a specified time range.
Before assigning breaks to a shift, use the Shift start time, end time, and maximum duration to calculate the time range for the shift. Then, make sure that all breaks assigned to the shift fall within that time range.
This topic contains the following sections:
To Create a new ShiftBreak, at a minimum the following columns must be provided:
To Update or Delete a shift, only the ShiftBreak Id is required.
When you write templates that access this table, follow these requirements:
Specify the Symbolic Name for the table version to use:
TableID = ShiftBreak-1.0
Specify an Intent that this table supports:
Input templates: In your [Output] section, be sure to map an input value to every table column that is flagged as being a primary key or required.
This list includes each column's name, which you use in expressions to retrieve or create data, and data type, which defines how the data is retrieved and set.
|If a column of data type Id is a primary key OR if it refers to other tables (Id <OtherTable>), then you can map it to an external key or, in some cases, a Telogis key.|
|Id||Id||(primary key) The ID of the shift break.|
|ShiftId||Id<Shift>||(required) The ID of the shift that contains the break.|
|Name||Text||The name of the ShiftBreak. This value must be unique for each break associated with the same ShiftId.|
|EarliestStartTime||TimeInterval||(required) The earliest time that the break can start in HH:MM:SS format.|
|LatestStartTime||TimeInterval||The latest time that the break can start in HH:MM:SS format. This value must be later than the value specified for EarliestStartTime.|
|Duration||TimeInterval||(required) The duration of the break in HH:MM:SS format. (For example, for a 10 minute break, specify 0:10:00|
|Custom.name||Text||Specifies a user-defined custom column name to store additional information in the table. If the column name contains non-alphanumeric characters, enclose the value in brackets, for example Custom.[Special column].|