TM1VAL function#

TM1VAL is a hierarchy-aware retrieval, the complement to DBRW. Member reference order does not matter and any hierarchy you omit assumes its default member, so you can specify only the members you care about.

TM1VAL is a native TM1 / Planning Analytics function.

Signature#

=TM1VAL(host, server, cube, mode, [valueToSend], member1, member2, ...)

Arguments#

#	Argument	Type	Required	Permitted values and notes
1	`host`	String	Yes	The host environment. Ignored by Reportworq, but must be non-blank and not an Excel error value.
2	`server`	String	Yes	The server instance.
3	`cube`	String	Yes	The cube name.
4	`mode`	String or number	Yes	`0` or `READ` for read. See the mode note below.
5	`valueToSend`	any	No	A write value. Ignored (write mode is not supported), but an Excel error value here is still reported.
6..N	member	String	No	Up to 64 member references, in any order. Omitted hierarchies assume their default member.

TM1VAL takes four to sixty-nine arguments.

Support notes#

Read mode only. Reportworq supports the read mode of TM1VAL. The write (1 / WRITE) and clear (2 / CLEAR) modes are not supported and produce a hard error.
Unrecognized mode falls back to read. If the mode argument is a value the function does not recognize, it is treated as read rather than rejected. Pass 0 or READ explicitly so the intent is clear.
Universal Reports. As documented on the prior IBM Planning Analytics functions page, TM1VAL is supported in full (dynamic) Universal Reports and not in static Universal Reports. This scope is carried from that documentation and still needs confirmation against the current build; treat it as a documented limitation rather than a guarantee.
Like DBRW, retrieval is deferred to batch processing, so the cell briefly shows #VALUE! before it resolves.

What happens when an argument is wrong#

Situation	Result
Fewer than four arguments	Hard error - too few parameters
More than sixty-nine arguments	Hard error - too many parameters
Blank `host`, `server`, `cube`, or `mode`	Hard error
A write or clear mode	Hard error - not supported

Examples#

=TM1VAL("*", "PlanTM1", "Sales", 0, , "[Region].[Northeast]", "[Measure].[Revenue]")

IBM Planning Analytics functions - the function index and the shared error model.
DBRW function - the non-hierarchy-aware cube retrieval.
DefineCalc function - declare a calculated member for retrieval.

Feedback on this page

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

Email feedback on this page

Or write to support@reportworq.com directly.