SubsetAttrS function for IBM Planning Analytics (TM1)

Where can the SubsetAttrS function be used?

TurboIntegrator

Which TM1 Server version is the SubsetAttrS function available for?

Version 11 and 12

What is the syntax for SubsetAttrS?

SubsetAttrS(DimName, SubName, AttrName)

• DimName = Name of the Dimension.​
• SubName = Name of the subset.​
• AttrName = Name of the attribute which value we want to retrieve. 

Relevant Functions

• HierarchySubsetAliasGet = Retrieves the alias used for a subset in a hierarchy.
• HierarchySubsetAliasSet = Sets an alias for a subset for a hierarchy. Returns 1 if successful or 0 if not.
• HierarchySubsetAttrDelete = Deletes a subset attribute from a hierarchy in a dimension.
• HierarchySubsetAttrInsert = Adds a new attribute for subsets.
• HierarchySubsetAttrN = Returns a numeric attribute for a subset, tied to a dimension’s hierarchy
• HierarchySubsetAttrNL = Returns a numeric attribute for a subset, tied to a dimension’s hierarchy, given a locale
• HierarchySubsetAttrPutN = Writes a numeric value to a subset’s attribute or set of elements in a hierarchy for a dimension.
• HierarchySubsetAttrPutS = Writes a string value to a subset’s attribute or set of elements in a hierarchy for a dimension.
• HierarchySubsetAttrS = Retrieve data from a string attribute associated to a subset in a hierarchy.
• HierarchySubsetAttrSL = Retrieve data from a string attribute associated to a subset in a hierarchy, based on a language locale.
• HierarchySubsetCreate = Creates an empty public subset in a hierarchy.
• HierarchySubsetDeleteAllElements = Deletes all elements in a subset from a hierarchy. 
• HierarchySubsetDestroy = Destroys a subset from a hierarchy.
• HierarchySubsetElementDelete = Deletes an element from a subset using an index number.
• HierarchySubsetElementExists = Checks if an elements exists in a public subset. 1 is returned if the elements exists or 0 if it does not exist in the subset.
• HierarchySubsetElementGetIndex = Returns the index of an element in a subset for a hierarchy.
• HierarchySubsetElementInsert = Adds an element into a subset associated to a hierarchy.
• HierarchySubsetExists = Checks if a public subset exists for a hierarchy. 1 is returned if the subset exists or 0 if the subset does not exist.
• HierarchySubsetGetElementName = Returns the name of an element from a subset using an index number that’s associated with a hierarchy.
• HierarchySubsetGetSize = Returns the number of elements in a subset that’s associated with a hierarchy.
• HierarchySubsetIsAllSet = Sets a subset to contain all elements of the dimension.
• HierarchySubsetMDXGet = Returns the MDX expression used to for a subset that’s associated with a hierarchy.
• HierarchySubsetMDXSet = Inserts a MDX expression to a public subset.
• PublishSubset = Converts a private subset to public.
• SubsetAliasGet = Retrieves the alias used for a subset.
• SubsetAliasSet = Sets the alias attribute in the Subset.  
• SubsetAttrDelete = Deletes a subset attribute from the dimension.
• SubsetAttrInsert = Creates a string, numeric or alias subset attribute for a dimension. 
• SubsetATTRN = Retrieves a value from a subset’s numeric attribute. 
• SubsetAttrNL = Retrieves a value from a subset’s numeric attribute for a given language. If the attribute is not defined for the language code, then the function returns the base attribute value. 
• SubsetAttrPutN = Updates a numeric attribute from a subset. 
• SubsetAttrPutS = Updates a string attribute from a subset. 
• SubsetAttrS = Retrieves a string attribute from a subset. 
• SubsetAttrSL = Retrieves a string attribute from a subset based on the local language code. If the attribute is not defined for the language code, then the function returns the base attribute value.  
• SubsetCreate = Creates a subset in a dimension.  
• SubsetCreateByMDX = Creates a public subset based on a MDX statement.  
• SubsetDeleteAllElements = Deletes all elements from a public subset. 
• SubsetDestroy = Deletes a subset.
• SubsetElementDelete = Deletes an element from a public subset. 
• SubsetElementExists = Checks if an element exists in the specified public subset. If an element exists in the subset then it returns 1 otherwise it returns 0.  
• SubsetElementGetIndex = Retrieves an element’s index in a subset. If the element doesn’t exist in the subset, then the function returns 0. If the index is not between 1 and the size of the subset then the function return error and process will be aborted. 
• SubsetElementInsert = Adds an element in an existing subset. 
• SubsetExists = Checks if a public subset exists. The function returns a 1 if the subset exists in the dimension, otherwise it returns 0. 
• SubsetExpandAboveSet = Sets expand above to a subset. It returns 1 if successful otherwise it returns 0.  
• SubsetFormatStyleSet = Applies an existing display style to a named subset.
• SubsetGetElementName = Retrieves an element’s name from a subset based on an index. 
• SubsetGetSize = Retrieves an element’s name from a subset based on an index. 
• SubsetIsAllSet = Sets all elements to a public subset
• SubsetMDXGet = Retrieves the MDX statement used for a subset.  
• SubsetMDXSet = Applies a MDX expression to a public subset. If the subset doesn’t exist, then an error will occur.