CreateHierarchyByAttribute function for IBM Planning Analytics (TM1)

Where can the CreateHierarchyByAttribute function be used?

Which TM1 Server version is the CreateHierarchyByAttribute function available for?

What is the syntax for CreateHierarchyByAttribute?

• ​​DimensionName = Name of the dimension to create a new hierarchy.​
• AttributeName = Name of the attribute to be used as middle level of the new hierarchy. The AttributeName also names the new hierarchy.​
• EmptyParentName = Name of the middle level parent when a N Level element does not have a value for the parameter ‘AttributeName’. If this parameter is left blank, TM1 will insert the N Level element in the TopLevel element.​
• RootName = Name of the TopLevel element to be added to the new hierarchy.

Relevant Functions

• CreateHierarchyByAttribute = Creates a hierarchy composed of three levels. The lowest level is the N element, the first parent is a given attribute, and the top level is given by a parameter. The new hierarchy will have the same name as the given attribute.
• HierarchyContainsAllLeaves = If a hierarchy contains all leaf elements in the dimension. If all are leaf elements, the function returns 1 (True), and if missing one or more leaf elements, it returns 0 (false).
• HierarchyCreate = Creates a new hierarchy in a dimension.
• HierarchyDeleteAllElements = Deletes all elements in a hierarchy.
• HierarchyDeleteElements = Deletes an element from a hierarchy.
• HierarchyDestroy = Deletes a hierarchy from a dimension.
• HierarchyElementComponentAdd = Adds an element to a consolidated element in a hierarchy, rolling up according to the weight defined.
• HierarchyElementComponentAddDirect = Adds an element to a consolidated element in a hierarchy, rolling up according to the weight defined.
• HierarchyElementComponentDelete = Deletes a component (child) from a consolidated element in a hierarchy.
• HierarchyElementComponentDeleteDirect = Deletes a component (child) from a consolidated element in a specific hierarchy in a dimension. This function is actioned immediately.
• HierarchyElementDelete = Deletes a member element of a specific hierarchy.
• HierarchyElementDeleteDirect = Deletes a member element of a specific hierarchy in a dimension. This function is actioned immediately.
• HierarchyElementExists = Checks whether an element exists in a dimension.
• HierarchyElementInsert = Adds an element to a hierarchy.
• HierarchyElementInsertDirect = Adds an element to a specific hierarchy. This function is actioned immediately.
• HierarchyElementPrincipalName = Returns the principal name of an element given an alias or the element name itself.
• HierarchyExists = Checks whether a specific hierarchy exists in a dimension.
• HierarchyHasOrphanedLeaves = Returns 1 if a hierarchy in a dimension has an orphaned element or returns 0 if there is no orphaned element in that hierarchy.
• HierarchySortOrder = Sets the order in which elements in a dimension are organized and displayed.
• HierarchyTimeLastUpdated = Returns a number that refers to the last time the hierarchy was updated.
• HierarchyTopElementInsert = Adds a root element to a hierarchy, if there isn’t any root element in it.
• HierarchyTopElementInsertDirect = Adds a root element to the target hierarchy if there isn’t any root element in it. This function is actioned immediately.
• HierarchyUpdateDirect = Performs a full rewrite of a hierarchy that has been subject to direct editing.