Click or drag to resize
Settings table
Print this page

The Settings table allows the management of assorted settings for platform entities.

Note 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:

  • CustomerId
  • UnitId
  • TerritoryId
  • RouteId

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:

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

    TableId = Settings-1.0

  2. Specify an Intent that this table supports:

    • Retrieve
    • Update

  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. CustomerId (Equals/In)
      CustomerId(ExternalIdName) = Equals("DEF123")
      CustomerId(ExternalIdName) = In(["ABC123","DEF123"])
    2. UnitId (Equals/In)
      UnitId(ExternalIdName) = Equals(Id1)
      UnitId(ExternalIdName) = In([Id1,Id2,Id3])
    3. TerritoryId(Equals/In)
      TerritoryId(ExternalIdName) = Equals("ABC123")
      TerritoryId(ExternalIdName) = In(["ABC123","DEF123"])
    4. RouteId (Equals/In)
      RouteId(ExternalIdName) = Equals("RST456")
      RouteId(ExternalIdName) = In([RouteId1,RouteId2,RouteId3])
Supported table options

This table supports the following options, which can be set in the [TableOptions] section.

  • Retrieve
  • Update

Settings 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
UnitId Id<Unit> The ID of the vehicle.
TerritoryId Id<Territory> The ID of the territory.
RouteId Id<Route> The ID of the route.
RoutingSettings RoutingSettings The RoutingSettings for the entity.

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.