Settings table |
The Settings table allows the management of assorted settings for platform entities.
Note |
---|
Some settings may not be available for all accounts. Contact your account manager for additional information. |
This topic contains the following sections:
The Settings table consists of four columns that are all primary keys:
Each entry in the Settings table must have exactly one of these four columns populated, to indicate the record to be retrieved or updated.
When you write templates that access this table, follow these requirements:
Specify the Symbolic Name for the table version to use:
TableId = Settings-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] CustomerId(ExternalIdName) = Equals("DEF123")
[Filter] CustomerId(ExternalIdName) = In(["ABC123","DEF123"])
[Filter] UnitId(ExternalIdName) = Equals(Id1)
[Filter] UnitId(ExternalIdName) = In([Id1,Id2,Id3])
[Filter] TerritoryId(ExternalIdName) = Equals("ABC123")
[Filter] TerritoryId(ExternalIdName) = In(["ABC123","DEF123"])
[Filter] RouteId(ExternalIdName) = Equals("RST456")
[Filter] RouteId(ExternalIdName) = In([RouteId1,RouteId2,RouteId3])
[Filter] DriverId(ExternalIdName) = Equals(Id1)
[Filter] DriverId(ExternalIdName) = In([Id1,Id2,Id3])
This table supports the following options, which can be set in the [TableOptions] section.
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 |
---|---|---|
UnitId | Id<Unit> | The ID of the vehicle. |
DriverId | Id<Driver> | The ID of the driver. DriverId does not support updating Settings fields. |
TerritoryId | Id<Territory> | The ID of the territory. |
RouteId | Id<Route> | The ID of the route. |
RoutingSettings | RoutingSettings | The RoutingSettings for the entity. |
HierarchySettings | HierarchySettings | (read-only) The HierarchySettings for the entity. |
Additional columns: