Click or drag to resize
Hierarchy table
Print this page

The Hierarchy table is used to manage hierarchy nodes that are arranged in a tree structure. This means that all nodes except for the company's root node have a parent (as specified by the ParentId field).

Nodes can have zero or more children. Moving a node to a new parent can be done by performing an Update and specifying a new ParentId.

Note Note

This table cannot be used to create a company's root node (such as to enable hierarchy support for a company).

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 = Hierarchy-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:
    • NodeId (Equals)
      Copy
      [Filter]
NodeId(ExternalIdName) = Equals("ABC123")   # or use Telogis Id: NodeId = Equals("123456...")
    • NodeId (In)
      Copy
      [Filter]
NodeId(ExternalIdName) = In([Id1,Id2,Id3])  # Tests whether external key value matches any in the set
Hierarchy 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
NodeId Id (primary key) The ID of the node.
NodeName Text The name that describes this node in Fleet.
ParentId Id<Hierarchy> The ID of this node's parent in the hierarchy, required for all but the company's root node. Updating the ParentId moves the node.
HierarchyLevel Number (read-only) Indicates the node's level in the hierarchy tree. Levels: 1 (root node), 2 (root's children), 3 (children's children).
EmailAddress Text Specifies the email address to which the datapump sends GF Co-location reports, which might contain sensitive information. If the field is empty, no reports are sent. To specify multiple addresses, separate them with a comma and enclose the string in quotes, such as "user-a@verizonconnect.com,user-b@verizonconnect.com".
EmailControl Text Controls when GF Co-location reports are sent. Values: Never (never send any), Always (always send), Exceptions (only report exception conditions).
UtilEmailAddress Text Specifies the email address to which the datapump sends minimal status reports, which contain no sensitive information. If the field is empty, no reports are sent. To specify multiple addresses, separate them with a comma and enclose the string in quotes, such as "user-a@verizonconnect.com,user-b@verizonconnect.com".
UtilEmailControl Text Controls when minimal status reports are sent. Values: Never (never send any), Always (always send), Exceptions (only report exception conditions).
MaxAllowedLevels Number (read-only) Indicates the maximum number of levels that this hierarchy tree can support. Branches cannot be created (by creating or moving a node) that would exceed this limit.
TreeMustBeBalanced BoolType (read-only) Indicates that every branch on the hierarchy tree must contain MaxAllowedLevels nodes. Currently, this restriction is not enforced.
DashboardEnabled BoolType (read-only) True if the hierarchy is dashboard enabled.

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