ELCOMP function#

ELCOMP returns the name of a child (component) of a consolidated element at a given index - the way to walk a consolidation's children.

Signature#

=ELCOMP("Server:Dimension", element, index)

#	Argument	Type	Required	Permitted values and notes
1	`Server:Dimension`	String	Yes	`"server:dimension"`.
2	`element`	String	Yes	A consolidated element. A numeric value warns but is accepted.
3	`index`	Integer	Yes	The child to return, 1-based. Must be a whole number of at least 1.

ELCOMP takes exactly three arguments. The default result is an empty string.

For the shared error model and the Calc Mode effect, see how Reportworq handles errors.

Situation	Result
More than three arguments	Hard error
Fewer than three arguments	Warning, blank
`index` is not numeric or cannot be parsed	Hard error
`index` is less than 1	Warning, blank
The element is a string element	Warning, blank - a string element has no children
The element is not consolidated	Returns blank
`index` is greater than the number of children	Warning, blank
Dimension or element not found	Warning, blank

=ELCOMP("PlanTM1:Region", "North America", 1)

IBM Planning Analytics functions - the function index and the shared error model.
ELCOMPN function - the number of children of a consolidation.
ELPAR function - a parent of an element by index.

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