Subset Manipulation TurboIntegrator Functions

These functions facilitate subset manipulation.

HierarchySubsetAliasGet
HierarchySubsetAliasGet returns the alias attribute for a subset within a hierarchy. This function was introduced in Planning Analytics 2.0.9.10/TM1 Server 11.8.9 and cannot be used in previous versions.
HierarchySubsetAliasSet
HierarchySubsetAliasSet sets the alias attribute to be used in an hierarchy subset. HierarchySubsetAliasSet returns 1 if successful, 0 otherwise.
HierarchySubsetCreate
HierarchySubsetCreate creates an empty public subset of a specified hierarchy and dimension.
HierarchySubsetDeleteAllElements
HierarchySubsetDeleteAllElements deletes all elements from a public subset of a dimension hierarchy.
HierarchySubsetDestroy
HierarchySubsetDestroy deletes a subset from the TM1® database.
HierarchySubsetElementExists
HierarchySubsetElementExists determines whether a specific element exists within a specific public subset on the server from which a TurboIntegrator process is executed. HierarchySubsetElementExists cannot be used to determine if an element exists in a private subset.
HierarchySubsetElementDelete
HierarchySubsetElementDelete deletes an element from a subset of a dimension hierarchy.
HierarchySubsetElementGetIndex
HierarchySubsetElementGetIndex retrieves the index of an element in a subset of a dimension hierarchy.
HierarchySubsetElementInsert
HierarchySubsetElementInsert adds an element to an existing subset in a dimension hierarchy.
HierarchySubsetExists
HierarchySubsetExists determines if a specific public subset exists on the server from which a TurboIntegrator process is executed. The function returns 1 if the subset exists on the server, otherwise it returns 0. Note that this function cannot be used to determine the existence of private subsets.
HierarchySubsetGetSize
HierarchySubsetGetSize returns the number of elements in a subset of a dimension hierarchy.
HierarchySubsetGetElementName
HierarchySubsetGetElementName returns the name of the element at a specified index location within a given subset of a dimension hierarchy.
HierarchySubsetIsAllSet
HierarchySubsetIsAllSet sets a subset to use all elements of the parent dimension. HierarchySubsetIsAllSet returns 1 if successful, 0 otherwise.
HierarchySubsetMDXGet
HierarchySubsetMDXGet retrieves the MDX expression used to create a subset.
HierarchySubsetMDXSet
HierarchySubsetMDXSet applies a specified MDX expression to an existing public subset of a hierarchy.
PublishSubset
PublishSubset publishes a named private subset on the server. This function was introduced in Planning Analytics 2.0.9.10/TM1 Server 11.8.9 and cannot be used in previous versions.
SubsetAliasGet
SubsetAliasGet returns the alias attribute for a subset. This function was introduced in Planning Analytics 2.0.9.10/TM1 Server 11.8.9 and cannot be used in previous versions.
SubsetAliasSet
SubsetAliasSet sets the alias attribute to be used in a subset. SubsetAliasSet returns 1 if successful, 0 otherwise.
SubsetCreate
SubsetCreate creates an empty public subset of a specified dimension.
SubsetCreateByMDX
SubsetCreateByMDX creates a public subset based on a passed MDX expression.
SubsetDeleteAllElements
SubsetDeleteAllElements deletes all elements from a public subset.
SubsetDestroy
SubsetDestroy deletes a subset from the TM1 database.
SubsetElementDelete
SubsetElementDelete deletes an element from a subset.
SubsetElementExists
SubsetElementExists determines whether a specific element exists within a specific public subset on the server from which a TurboIntegrator process is executed. SubsetElementExists cannot be used to determine if an element exists in a private subset.
SubsetElementGetIndex
SubsetElementGetIndex retrieves the index of an element in a subset. The function returns the index of the first occurrence of the specified element.
SubsetElementInsert
SubsetElementInsert adds an element to an existing subset.
SubsetExists
SubsetExists determines whether a specific public subset exists on the server from which a TurboIntegrator process is executed.
SubsetExpandAboveSet
SubsetExpandAboveSet sets the Expand Above property for a subset. The function returns 1 if successful, otherwise it returns 0.
SubsetFormatStyleSet
SubsetFormatStyleSet applies an existing display style to a named subset.
SubsetGetElementName
SubsetGetElementName returns the name of the element at a specified index location within a given subset.
SubsetGetSize
SubsetGetSize returns the number of elements in a subset.
SubsetIsAllSet
SubsetIsAllSet sets a subset to use all elements of the parent dimension. SubsetIsAllSet returns 1 if successful, 0 otherwise.
SubsetMDXGet
SubsetMDXGet retrieves the MDX expression used to create a subset.
SubsetMDXSet
SubsetMDXSet applies a specified MDX expression to a public or temporary subset.

Parent topic: TurboIntegrator Functions