Click or drag to resize
RouteDriverBreak table
Print this page

The RouteDriverBreak table is used by Dispatch and Scenarios to insert a Break-Type-Job into a route.

Driver breaks are rules that are defined on a route. These rules determine when breaks should automatically be inserted into the route. On any route, driver breaks are represented by Jobs that have a Job Type of either ‘Driver Break’ or ‘Legal Driver Break’.

Driver breaks are re-evaluated on every RouteCloud request that is made (including re-evaluation). Every time the route is re-evaluated, Break-Type-Jobs are updated to match the RouteDriverBreak definitions for the route. Break-Type-Jobs can be imported through TDE if desired, but if they do not have a matching RouteDriverBreak, they are removed when the route is re-evaluated.

Note Note

Driver break windows are optional components of routes. When you delete a route, its associated driver break windows are deleted, but when you delete a driver break window, the route is unaffected.

This topic contains the following sections:

Requirements

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

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

    Copy
    TableID = RouteDriverBreak-2.0  # RouteDriverBreak table

  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 requires the use of a fetcher. The following fetchers are available and are listed from most efficient to least:
    1. Id (Equals/In)
      Copy
      [Filter]
Id(ExtId) = Equals(Id1)   # You can filter on literals or on variables from the [User] or [Calculated] sections.
      Copy
      [Filter]
Id(ExtId) = In(["Id1","Id2","Id3"])
    2. RouteId (Equals)
      Copy
      [Filter]
RouteId(ExternalIdName) = Equals("USA123") # or use Telogis Id: RouteId = Equals(Id("123456..."))
RouteDriverBreak 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<RouteDriverBreakv2> (primary key) The ID of the driver break.
RouteId Id<Route> The ID of the route that the driver break belongs to. Must be unique.
Name Text The name of the driver break. Must be unique within the Route.
EarliestStartTime TimeInterval The earliest time of day this break can be scheduled. If the route ends before this time, the break will not be scheduled.
LatestStartTime TimeInterval The latest time of day this break can be scheduled. If the route starts after this time, the break will not be scheduled.
IsPaid BoolType Specifies whether the driver is paid for this break.
Duration TimeInterval The duration of the driver break.