DimensionSortOrder function for IBM Planning Analytics (TM1)

Where can the DimensionSortOrder function be used?

TurboIntegrator

Which TM1 Server version is the DimensionSortOrder function available for?

Version 11 and 12

What is the syntax for DimensionSortOrder?

DimensionSortOrder(DimName, CompSortType, CompSortSense, ElSortType , ElSortSense)

• DimName = Dimension Name​
• CompSortType = sort type for components of consolidated elements ​
  • ByInput: retain the original dimension element insert order​
  • ByName: sort by name​
• CompSortSense = the sense of order for CompSortType either ‘Ascending’ or ‘Descending’. This applies only when the CompSortType is ByName. ​
  • Ascending: ascending alphabetical order​
  • Descending: descending alphabetical order​
• ElSortType = sort type for all elements​
  • ByInput: retain the original dimension element insert order​
  • ByName: sort by name​
  • ByLevel:  Sorts dimension elements by level.​
  • ByHierarchy – Sorts dimension elements by hierarchy.​
• ElSortSense = the sense of order for ElSortType either ‘Ascending’ or ‘Descending’. This applies only when the ElSortType is ByName.​
  • Ascending: ascending alphabetical order​
  • Descending: descending alphabetical order

Relevant Functions

• DimensionCreate = Creates a new dimension.
• DimensionDeleteAllElements = Deletes all elements in a dimension.
• DimensionDeleteElements = Deletes elements in a dimension based on a subset.
• DimensionDestroy = Deletes a dimension.
• DimensionElementComponentAdd = Adds an element to a consolidated element in a rollup according to a specific weight in a dimension. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab).
• DimensionElementComponentAddDirect = Adds an element to a consolidated element in a rollup according to a specific weight in a dimension. This function is actioned immediately.
• DimensionElementComponentDelete = Deletes an element from a consolidated element in a rollup. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab).
• DimensionElementComponentDeleteDirect = Deletes an element from a consolidated element. This function is actioned immediately.
• DimensionElementDelete = Deletes an element in a dimension. This action occurs after a commitment to the process (e.g., at the end of executing the metadata tab).
• DimensionElementDeleteDirect = Deletes an element directly in a dimension. This function is actioned immediately.
• DimensionElementExists = Checks whether a specific element exists in a dimension.
• DimensionElementInsert = Adds an element in a dimension. This action occurs after a commitment in the process (e.g. at the end of executing the metadata tab).
• DimensionElementInsertDirect = Adds an element in a dimension by directly editing a dimension. This function is actioned immediately.
• DimensionElementPrincipalName = Returns the principal name of an element or element alias.
• DimensionExists = Checks whether a dimension exists.
• DimensionHierarchyCreate = Creates a hierarchy in a dimension.
• DimensionSortOrder = Sorts the elements and components of consolidations within a dimension.
• DimensionTimeLastUpdated = Returns a serial value indicating the date and time when a dimension was last updated.
• DimensionTopElementInsert = Creates a root element in a dimension.
• DimensionTopElementInsertDirect = Creates a root element in a dimension by directly editing a dimension.
• DimensionUpdateDirect = Rewrites a dimension that has been edited with Dimension*Direct function(s) (e.g. DimensionElementInsertDirect) to reduce the memory utilised to edit the dimension.