Hierarchy Manipulation TurboIntegrator Functions

These functions facilitate hierarchy manipulation.

HierarchyContainsAllLeaves
HierarchyContainsAllLeaves returns true only if the specified hierarchy contains the full set of leaf elements that are present in the dimension. That is, it contains all the leaf elements that can be seen in the special Leaves hierarchy. If the specified hierarchy is missing one or more leaf elements, this function returns false.
HierarchyCreate
HierarchyCreate creates a new hierarchy in an existing dimension. The hierarchy cannot have the same name as the dimension.
HierarchyDeleteAllElements
HierarchyDeleteAllElements deletes all the elements in a hierarchy. This function is useful for recreating dimension hierarchies.
HierarchyDeleteElements
HierarchyDeleteElements deletes elements from a hierarchy using a subset of elements.
HierarchyDestroy
HierarchyDestroy deletes a hierarchy from the TM1® database.
HierarchyElementComponentAdd
HierarchyElementComponentAdd adds a component (child) to a consolidated element. You can't use this function in the Epilog procedure of a TurboIntegrator process.
HierarchyElementComponentAddDirect
HierarchyElementComponentAddDirect adds a component (child) to a consolidated element by directly editing a dimension.
HierarchyElementComponentDelete
HierarchyElementComponentDelete deletes a component (child) from a consolidated element.
HierarchyElementComponentDeleteDirect
HierarchyElementComponentDeleteDirect deletes a component (child) from a consolidated element by directly editing the dimension.
HierarchyElementDelete
HierarchyElementDelete deletes an element from a hierarchy.
HierarchyElementDeleteDirect
HierarchyElementDeleteDirect deletes an element from a dimension by directly editing the dimension.
HierarchyElementExists
HierarchyElementExists determines whether a specific elements exists in a hierarchy on the server from which a TurboIntegrator process is executed. The function returns 1 if the elements exists in the hierarchy on the server, otherwise it returns 0.
HierarchyElementInsert
HierarchyElementInsert adds an element to a dimension. You can use this function to add numeric, string, or consolidated elements. You can't use this function in the Data or Epilog procedures of a TurboIntegrator process.
HierarchyElementInsertDirect
HierarchyElementInsertDirect adds an element to a dimension by directly editing the dimension. You can use this function to add numeric, string, or consolidated elements.
HierarchyElementPrincipalName
HierarchyElementPrincipalName returns the principal name of an element or element alias.
HierarchyExists
HierarchyExists determines whether a specific hierarchy exists on the server from which a TurboIntegrator process is executed. The function returns 1 if the hierarchy exists on the server, otherwise it returns 0.
HierarchyHasOrphanedLeaves
HierarchySortOrder
HierarchySortOrder sets a sort type and sense for dimension elements and for components of consolidated elements within a dimension. The sort order defined by DimensionSortOrder determines how the subset displays in the Subset Editor.
HierarchyTimeLastUpdated
HierarchyTimeLastUpdated indicates when a specified dimension hierarchy was last updated. The function returns a real number that represents the current day (including the hour, minute, second, and millisecond) since the beginning of the year 1900.
HierarchyTopElementInsert
HierarchyTopElementInsert creates a root element in a dimension. If the dimension already has a single root, then this element will not be created.
HierarchyTopElementInsertDirect
HierarchyTopElementInsertDirect creates a root element in a dimension by directly editing the dimension. If the dimension already has a single root, then this element will not be created.
HierarchyUpdateDirect
HierarchyUpdateDirect performs a full rewrite of a hierarchy that has been subject to direct editing in a TurboIntegrator process, essentially compacting the memory footprint of the hierarchy.

Parent topic: TurboIntegrator Functions