HierarchySubsetATTRNL
HierarchySubsetATTRNL returns an attribute's numeric value for a specified subset (and locale) associated with a hierarchy in a dimension.
This function is valid in TM1® TurboIntegrator processes only.
Syntax
HierarchySubsetATTRNL(DimName, HierName, SubName, AttrName, [LangLocaleCode]);
Argument |
Description |
---|---|
DimName |
A valid dimension name. |
HierName |
The name of a hierarchy in a dimension. |
SubName |
The name of a subset in a dimension. |
AttrName |
The attribute for which you want to retrieve a value. This argument must be a valid attribute of the dimension. |
LangLocaleCode |
This optional parameter specifies the language locale code for which you want to return a value. Valid LangLocaleCode values correspond to the international language codes listed in the }Cultures control dimension. When the LangLocaleCode is not specified or is omitted, the user's current locale is used as the LangLocaleCode argument. If an attribute value does not exist for the LangLocaleCode, the value for an associated parent LangLocaleCode is returned. If an attribute value does not exist for an associated parent LangLocaleCode, the base attribute value is returned. For example if the LangLocaleCode is |
Example
In this example, the function returns the numeric value of the Accounting_Code attribute of the Sales subset (from the Europe hierarchy) for the French locale.
HierarchySubsetATTRNL('Plan_Business_Unit', 'Europe', 'Sales', 'Accounting_Code', 'fr');