HierarchyElementPrincipalName
HierarchyElementPrincipalName returns the principal name of an element or element alias.
TurboIntegrator must use principal element names when updating dimensions; element aliases cannot be used. This function is therefore useful for determining principal element names while attempting to update a dimension when only element aliases are available to the TurboIntegrator process.
This function is valid in TM1® TurboIntegrator processes only.
Syntax
HierarchyElementPrincipalName( DimName, HierName, ElName )|
Argument |
Description |
|---|---|
|
DimName |
The name of the dimension from which you want to retrieve a principal element name. |
|
HierName |
The name of the hierarchy within the dimension. |
|
ElName |
An element name. ElName can be either an element alias or a principal element name. |
Example
If ElName is not in the currently saved version of DimName, the function returns ElName.
If ElName is in DimName, whether as an element alias or a principal element name, it returns the principal name of the element.