Route table |
The Route table provides information about scheduled routes containing jobs.
Note |
---|
This table supports Response integrations for Fleet accounts. Contact your account manager for additional information. |
This topic contains the following sections:
When you write templates that access this table, follow these requirements:
Specify the Symbolic Name for the table version to use:
TableID = Route-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.
[Filter] Id(ExtId) = Equals(Id1) # You can filter on literals or on variables from the [User] or [Calculated] sections.
[Filter] Id(ExtId) = In(["Id1","Id2","Id3"])
You can improve the performance of the StartTime fetcher by adding one or more of the optional filter parameters.
[Filter] StartTime = GreaterThan(StartTime) # You can use either a GreaterThan or Between function # such as Between(TimeStart,TimeEnd) # Optional filter parameters: # TerritoryId(ExtId)= In("Id1", "Id2", Id3") # Or use Telogis Id: TerritoryId = Equals("123456...") # DriverId(ExternalIdName) = In("Id1", "Id2", Id3") # Or use Telogis Id: DriverId = Equals("123456...") # UnitId(ExternalIdName) = In("Id1", "Id2", Id3") # Or use Telogis Id: UnitId = Equals("123456...") # LastUpdateTime = GreaterThan ("UpdateStartTime") # You can use either a GreaterThan or Between function # such as Between(StartLastUpdateTime, EndLastUpdateTime)
This table supports the following option, which can be set in the [TableOptions] section.
Value | Description |
---|---|
Never (default) | TDE only sets the values provided within the input data and does not update the route with related values from the Unit or Driver tables. |
Always | This setting affects the following scenarios:
|
AssignOnly | This setting affects the following scenarios:
|
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 |
---|
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 route. |
Name | Text | The name of the route. |
DriverId | Id<Driver> | (required if no UnitId) The ID of the driver assigned to this route. |
UnitId | Id<Unit> | (required if no DriverId) The ID of the vehicle that the assigned driver is to use for this route (if known). |
TerritoryId | Id<Territory> | (required) The ID of the territory to which this route belongs. |
TerritoryName | Text | (read-only) The name of the territory. |
StartTime | Timestamp | The time of day when the route is scheduled to start (when the vehicle is to leave the depot). |
EndTime | Timestamp | The time of day when the route is scheduled to end (when the vehicle is to return to the depot). |
Status | EnumType | (read-only) The status of this route. Values: NotStarted, InProgress, Complete, NotComplete. |
EarliestStartTime | Timestamp | The earliest time of day that the route can start (when the vehicle leaves the depot). A route's shift is Variable if both the EarliestStartTime and LatestEndTime are specified (i.e. the shift's beginning and ending times may vary within the window specified). If only the EarliestStartTime is specified, then the route's shift is Fixed (i.e. the shift begins at the EarliestStartTime). |
LatestEndTime | Timestamp | For variable schedules, the latest time of day that the route can end (when the vehicle is to return to the depot). |
NormalShiftDuration | TimeInterval | The duration for which the driver can be paid at the normal rate, before triggering overtime. |
MaximumShiftDuration | TimeInterval | The maximum duration that the driver's shift can be scheduled for, including overtime. |
FixedVehicleCostPerDay | Number | The fixed cost per day of running the specified vehicle, used to calculate depreciation. |
LastUpdateTime | Timestamp | (read-only) The time when the route was last edited. |
ActualDistanceMetres | Distance | (read-only) The Route Actual Distance. |
Additional 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]. |