TM1RPTFILTER function#

TM1RPTFILTER builds the sort and filter expression applied to an Active Form region's row axis.

TM1RPTFILTER is part of the native TM1 Active Form family. It is normally generated by Planning Analytics for Excel rather than typed by hand.

Signature#

=TM1RPTFILTER(viewId, tuple, filterFunction, filterValue, sortOrder)

#	Argument	Type	Required	Permitted values and notes
1	`viewId`	String	Yes	The Active Form view id.
2	`tuple`	String	Yes	The measure tuple the sort or filter targets.
3	`filterFunction`	String	Yes	One of `TOPCOUNT`, `BOTTOMCOUNT`, `TOPPERCENT`, `BOTTOMPERCENT`, `TOPSUM`, `BOTTOMSUM`, or blank for no filter.
4	`filterValue`	Number	Yes	The count, percent, or sum threshold. Defaults to `0` if blank.
5	`sortOrder`	String	Yes	`asc`/`basc`, `desc`/`bdesc`, `nbasc`, or `nbdesc`; blank for no sort.

TM1RPTFILTER requires all five arguments.

Situation	Result
Fewer than five arguments	Hard error - missing parameters
`filterFunction` is not one of the recognized values or blank	Hard error
`tuple` or `viewId` blank	Hard error

IBM Planning Analytics functions - the function index and the shared error model.
TM1RPTROW function - the dynamic row axis this filters.

Comments, questions, requests, or something missing or unclear? Email us - the page you are on is filled in for you.