Click or drag to resize
Marker table
Print this page

The Marker table provides information about the locations for which markers are defined.

All new integrations dealing with markers should use the Site table, not the Marker table.

This topic contains the following sections:

Requirements

Markers require location to be specified through one of these column sets:

  • Lat and Lon

  • EnvelopeAddress that includes the country specified in the string, like "20 Enterprise, Aliso Viejo, CA 92656 -- USA"

  • EnvelopeAddress and Country

    Note Note

    If you specify the country both within the EnvelopeAddress string and with the Country column, then the value set for the Country column is used.

  • StreetName and Country plus one of the following:

  • PostalCode
  • City and Region

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

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

    TableID = Marker-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. However, the following fetchers are available to optimize your query and are listed from most efficient to least:
    1. Id (Equals/In)
      [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"])
    2. Tag (Equals)
      [Filter]
      Tag = Equals("MarkerName")     # You can filter on literals or on variables from the [User] or [Calculated] sections
    3. Shape (ContainsPoint(Latitude,Longitude))

      This fetcher filters by whether the marker contains a location, identified by latitude and longitude. For polygon markers, the fetcher checks for the location within the boundaries of the polygon Shape. For point markers, the fetcher checks for the location within the Radius of the marker. If you filter on literals (Example 1), then you must define a default unit of measure for the Angle data type in the [Defaults] section. If you filter on input from the [User] section, then you can either define the unit of measure in the [Defaults] section or for each line in the [User] section as shown in Example 2.

      Example 1
      [Defaults]
      Angle=Degree     # Sets the default unit of measure for the Latitude and Longitude literals in the [Filter] section
      
      [Filter]                                   
      Shape = ContainsPoint(30.39761,-97.72958)  # Filters markers by literal values
      Example 2
      [User]     # Sets the Latitude and Longitude by query string, for example: &Latitude=30.39761&Longitude=-97.72958
      Latitude(Angle,Degree) = “latitude”        # Sets the data type and unit of measure for Latitude 
      Longitude(Angle,Degree) = “longitude”      # Sets the data type and unit of measure for Longitude 
      
      [Filter]
      Shape = ContainsPoint(Latitude,Longitude) # Filters markers by input from the [User] section
    4. UserId (Equals)
      [Filter]
      UserId(ExternalIdName) = Equals("ABC123")  # or use Telogis Id: UserId = Equals("123456...")
    5. UpdateTime (GreaterThan)
      [Filter]
      UpdateTime = GreaterThan(TimeStart)        # Timestamp variable from User or Calculated section
    6. UpdateTime (Between)
      [Filter]
      UpdateTime = Between(TimeStart,TimeEnd)    # Timestamp variable from User or Calculated section
    7. PrimaryCategoryId (Equals)
      [Filter]
      PrimaryCategoryId(Telogis, Name) = Equals("HQ")  # or use an External key or Telogis Id
    8. PrimaryCategoryId (In)
      [Filter]                         # Tests whether external key value matches any in the set
      PrimaryCategoryId(Telogis, Name) = In(["HQ", "Customers", "Fuel Station", "Prohibited"])
Supported table options

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

  • ResetAccessPathIntersection - This table option is Boolean and can be omitted. This option allows resetting the Intersection and Access Paths fields for a marker's associated site during an update operation. The following table describes the behavior of this option for the Update intent.
    Note Note

    Access Paths cannot be set through a Site table Create/Update.

    Update Intent

    Value

    Description

    Not set

    The default behavior will be the following:

  • An update to a Marker will not clear the corresponding Site’s Intersection or Access Paths.
  • If the customer option HasDefaultResetAccessPathIntersection is set to True, the default behaviour will be the same as True.
  • True

    The default behavior will be the following:

  • Any update that causes the Marker to move more than 500 feet will remove the corresponding Site’s Intersection and Access Paths.
  • Caution note Caution

    Any Intersection or Access Paths “reset” cannot be recovered.

    False

    The default behavior will be the following:

  • An update to a Marker will not reset the corresponding Site’s Intersection or Access Paths.
  • Note Note

    This takes priority over the customer option HasDefaultResetAccessPathIntersection.

Marker 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 marker.
UserId Id (read-only) The Id of the user who created the marker.
DriverId Id<Driver> The ID of the driver associated with this marker (e.g. the driver with a job assigned at this marker).
PrimaryCategoryId Id<Category> The ID of the marker's primary category.
CategoryIds Set<Id<Category>> Set of IDs of the categories to which this marker belongs. Updates must include the full set of desired IDs.
Tag Text The name of the marker.
TerritoryId Id<Territory> The ID of the territory to which the marker belongs. To clear the territory, set the TerritoryId to 0.
TerritoryName Text (read-only) The name of the territory to which the marker belongs.
MarkerType Number Indicates whether the marker is a point marker (0) or a polygon marker (5).
Radius Distance The radius of the marker (for point markers).
Shape Polygon The points defining a polygon marker's boundary, in Lat Lon pairs. Must be a WKT (Well Known Text) definition string not greater than 10 MB. Example: "POLYGON((-120.06252 36.08499, -115.07387 35.8306, -117.65138 33.74055, -120.06252 36.08499))".
Lat Angle The latitude where marker is located. Must be between -90 and 90 degrees. If this value is 0, then the value of Lon must be non-zero.
Lon Angle The longitude where the marker is located. Must be between -180 and 180 degrees. If this value is 0, then the value of Lat must be non-zero.
StreetNumber StreetNumber The street number portion of the marker's address.
StreetName Text The street name portion of the marker's address.
City Text The city where the marker is located.
Region Text The state or region where the marker is located.
PostalCode Text The zip code or postal code of the marker's address.
Country Text The Country where the marker is located.
EnvelopeAddress Text The mailing address for the marker. On create, TDE geocodes this address if Lat/Lon are undefined.
IsZone BoolType Indicates whether the marker is a zone marker. Zone markers report the vehicles actual location rather than "snapping" vehicle locations to the marker location. In addition, zone markers can have assigned speed limits.
Contact1 Text Contact details, such as name or phone number.
Contact2 Text Additional contact details.
Phone1 Text Primary phone number.
Phone2 Text Secondary phone number, such as for a pager.
Notes Text Free-form notes about the marker.
SpeedLimit Number Maximum speed (in default units) for vehicles driving within the boundaries of the marker. This value is only used for zone markers.
UpdateTime Timestamp (read-only) Date and time when this marker was last updated.

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