2.2.5.9 Hierarchy Object

  • Article

The Hierarchy object represents a collection of levels that provide a logical hierarchical drilldown path for client applications. It is a child of a Table object.

The Hierarchy object has the following properties.

Name

Type

Description

ID

unsignedLong

A reference to the object.

TableID

unsignedLong

An ID-based reference to a Table object.

Name

string

The name of the object.

Description

string

The description of the object.

IsHidden

boolean

A Boolean that indicates whether the hierarchy is treated as hidden by client visualization tools.

If the hierarchy is treated as hidden by client visualization tools, it is "true"; otherwise, it is "false".

State

enumeration

A value that provides information about the state of the hierarchy. The possible values and their interpretation are as follows:

  • Ready (1) – The hierarchy is queryable and has up-to-date data.

  • NoData (3) – Not applicable to Hierarchy.

  • CalculationNeeded – The hierarchy does not contain any data because it was not refreshed. No error is associated with the hierarchy.

  • SemanticError (5) – Not applicable to Hierarchy.

  • EvaluationError (6) - Not applicable to Hierarchy.

  • DependencyError (7) – A dependency associated with the hierarchy is in an error state (SemanticError, EvaluationError, or DependencyError).

  • Incomplete (8) - Not applicable to Hierarchy.

HierarchyStorageID

unsignedLong

An ID-based reference to a HierarchyStorage object. The HierarchyStorage object is reserved for internal use only.

ModifiedTime

dateTime

The time that the object was last modified.

StructureModifiedTime

dateTime

The time that the structure of the object was last modified.

RefreshedTime

dateTime

The time that the object was last refreshed.

DisplayFolder

string

Defines the display folder in which the hierarchy is displayed by the client applications.

HideMembers<54>

enumeration

A value that allows the members of a ragged/unbalanced hierarchy to be hidden. Compatibility level 1400 or higher is required.

The possible values are as follows:

  • Default (0) – The members are not to be hidden.

  • HideBlankMembers (1) – The members that have blank values are to be hidden.

LineageTag<55>

string

An optional tag that can be used to define the lineage of a hierarchy across different versions of a model.

Compatibility level 1600 or higher is required.

SourceLineageTag<56>

string

An optional tag that can be used to define the lineage of a referenced hierarchy across different versions of a model. As opposed to LineageTag, SourceLineageTag can be used to define the lineage of a referenced hierarchy rather than a hierarchy itself. SourceLineageTag is useful when a model references other models by using a Direct Query connection.

Compatibility level 1600 or higher is required.