Click or drag to resize
Shift table
Print this page

Use the Shift table to define and manage work shifts for an organization.

Note Note

This table supports Response integrations for Fleet accounts.

Each shift provides the following information that describes the work hours in a single day (24-hour period):

  • Work start time, and optionally end time
  • Shift duration (normal hours)
  • Maximum duration (permitted overtime)

You can create shifts for fixed or variable start times. For fixed shifts, you specify only the start time and duration of the shift. For variable shifts that can start and end within a given time period, specify both the start and end time. For example, for an 8-hour shift that can start between 8:00 AM and 10:00 AM, specify EarliestStartTime=8:00:00 and LatestEndTime=18:00:00.

After you set up the work shifts, you can complete the following additional shift management tasks:

  • Use the ShiftBreak table to add driver break schedules to each shift.
  • Use the ShiftPattern table to combine the shifts into patterns that describe driver work schedules over a set period of days.

This topic contains the following sections:

Requirements

To Create a shift, at a minimum the following columns must be provided:

  • Name (unique)
  • EarliestStartTime
  • NormalDuration
  • MaximumDuration
If you are creating a variable shift, you must also specify the LatestEndTime.

To Update or Delete a Shift, only the Id is required.

When you write templates that access this table, follow these requirements:

  1. Specify the Symbolic Name for the table version to use:

    Copy
    TableID = Shift-1.0

  2. Specify an Intent that this table supports:

    • Retrieve
    • Create
    • Update
    • CreateOrUpdate
    • Delete

  3. 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.

  4. Retrieve templates: This table does not require the use of a fetcher.
Shift column descriptions

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.

Note Note
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.
Column Data Type Description
Id Id (primary key) The ID of the shift.
Name Text (Telogis key) The name of the shift.
EarliestStartTime TimeInterval (required) The earliest time that the driver can begin work.
LatestEndTime TimeInterval For variable shifts, the latest time that the driver can stop working.
NormalDuration TimeInterval (required) The duration for which the driver can be paid at the normal rate, before triggering overtime.
MaximumDuration TimeInterval (required) The maximum duration that the driver shift can be scheduled for, including overtime.

Additional columns:

Column Data Type Description
CustomerId Id (read-only, all Fleet tables) The ID of the customer/owner.
CustomerFullName Text (read-only, all Fleet tables) The human-readable full name of the customer/owner.
Custom columns
Column Data Type Description
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].