TM1RptRow function for IBM Planning Analytics (TM1)
TM1RptRow returns the row set in a Dynamic Report. Use MDX, a set/subset or hardcode a list of elements in Excel to return members to the row. Change how the row appears to users by setting the element’s indentation, whether to expand consolidations above or below, or allow drilling on consolidations. Used for Dynamic Reports (Active Form).
In the video, the TM1RptRow will be used in a Dynamic Report to:
Where can the TM1RptRow function be used?
Excel
Which TM1 Server version is the TM1RptRow function available for?
Version 11 and 12
What is the syntax for TM1RptRow?
TM1RptRow(TM1RptView, TM1ServerName:Dimension, SetName, ElementList, AliasOverride, ExpandAbove, MDXOverride, IndentRate, IndentCharacter, ConsolidationDrilling)
- TM1ServerName = Name of the TM1 Server
- Dimension = dimension used for the row
- TM1RptView = reference to the TM1RptView function from a Dynamic Report
- Dimension = Name of the Dimension (REQUIRED)
- SetName = Set name (OPTIONAL)
- ElementList = An array of elements. For example {“4”;”40”;”400”} (OPTIONAL)
- AliasOverride = Name of an alias (OPTIONAL)
- ExpandAbove = A Boolean field. 1 for consolidations to expand above or 0 to expand below. As a default, it is set to 0 (OPTIONAL)
- MDXOverride = An MDX expression (OPTIONAL)
- IndentRate = Enter a number to indicate the indentation applied to each level. A value of 0 applies no indentation. As a default, the indentation of 1 is applied (OPTIONAL)
- ConsolidationDrilling = turn on or off drilling down or up consolidations. A value of 0 prevents drilling, while 1 allows drilling. As a default, drill is applied (OPTIONAL)
Relevant Functions
- TM1RptElIsConsolidated = Returns a boolean value if an element is consolidated
- TM1RptElIsExpanded = Returns a boolean value if an element is expanded on the row set
- TM1RptElLev = Returns an element’s level relative to the root in the subset
- TM1RptFilter = Apply a filter to the Dynamic report to sort the row based on a column
- TM1RptView = controls the definition of the report like zero suppression and the format area
- TM1RptTitle = Used to define the title dimension