Cognos TM1 Element Information Rules Functions

Element Information Rules Functions:

• DIMIX
• DTYPE
• ELCOMP
• ELCOMPN
• ELISANC
• ELISCOMP
• ELISPAR
• ELLEV
• ELPAR
• ELPARN
• ELWEIGHT

DIMIX:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
DIMIX returns the index number of an element within a dimension.

Syntax:
DIMIX(dimension, element)

Arguments:

Argument	Description
dimension	A valid dimension name.
element	The name of an element within the dimension. If the element is not a member of the dimension specified, the function returns 0.

Example:
DIMIX('Region','Brazil')
Brazil has an index value of three in the Region dimension. The example returns 3.

DTYPE:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
DTYPE returns information about the element type of a specified element. It returns N if the element is a numeric element, S if the element is a string element, and C if the element is a consolidated element.

Syntax:
DTYPE(dimension, element)

Arguments:

Argument	Description
dimension	A valid dimension name.
element	The name of an element within the dimension.

Example:
DTYPE('Region','Europe')
The element Europe is a consolidated element of the Region dimension, so the example returns C.

ELCOMP:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
ELCOMP returns the name of a child of a consolidated element in a specified dimension. If the element argument is not a consolidated element, the function returns 0.

Syntax:
ELCOMP(dimension, element, position)

Arguments:

Argument	Description
dimension	A valid dimension name.
element	The name of a consolidated element within the dimension.
position	A positive value less than or equal to the total number of children in the specified element.

Example:
ELCOMP('Region','Central Europe',2)
In the dimension Region, the consolidated element Central Europe is a consolidation of the children France and Germany. Germany is in the second position in this consolidation. Accordingly, the example returns Germany.

ELCOMPN:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
ELCOMPN returns the number of components in a specified element. If the element argument is not a consolidated element, the function returns 0.

Syntax:
ELCOMPN(dimension, element)

Arguments:

Argument	Description
dimension	A valid dimension name.
element	The name of a consolidated element within the dimension.

Example:
ELCOMPN('Region','Scandanavia')
In the Region dimension, the element Scandanavia is a consolidation of three elements. The example returns 3.

ELISANC:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
ELISANC determines whether element1 is an ancestor of element2 in the specified dimension. The function returns 1 if element1 is an ancestor of element2, otherwise the function returns 0.

Syntax:
ELISANC(dimension, element1, element2)

Arguments:

Argument	Description
dimension	A valid dimension name.
element1	The name of an element within the dimension.
element2	The name of an element within the dimension.

Example:
ELISANC('Region', 'Europe', 'Germany')
In the dimension Region, the element Europe is an ancestor of Germany. The example returns 1.

ELISCOMP:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
ELISCOMP determines whether element1 is a child of element2 in the specified dimension. The function returns 1 if element1 is a child of element2, otherwise the function returns 0.

Syntax:
ELISCOMP(dimension, element1, element2)

Arguments:

Argument	Description
dimension	A valid dimension name.
element1	The name of an element within the dimension.
element2	The name of an element within the dimension.

Example:
ELISCOMP('Region','Germany','Central Europe')
In the dimension Region, the element Central Europe is a consolidation of two elements, Germany and France. The example returns 1.

Note: this function returns 1 only for immediate children. In the above example, Germany is a child of Central Europe. Further, Central Europe is a child of Europe. However, because the function returns 1 only for immediate children, the following example returns 0:
ELISCOMP('Region','Germany','Europe')

ELISPAR:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
ELISPAR determines whether element1 is a parent of element2 in the specified dimension. The function returns 1 if element1 is a parent of element2, otherwise the function returns 0.

Syntax:
ELISPAR(dimension, element1, element2)

Arguments:

Argument	Description
dimension	A valid dimension name.
element1	The name of an element within the dimension.
element2	The name of an element within the dimension.

Example:
ELISPAR('Region','Central Europe','Germany')
In the dimension Region, the consolidated element Central Europe is the parent of both Germany and France. Accordingly, the example returns 1.

Note: this function returns 1 only for immediate parents. In the above example, Europe is a parent of Central Europe. Further, Central Europe is a parent of Germany. However, because Europe is not an immediate parent of Germany, the following example returns 0:
ELISPAR('Region','Europe','Germany')

ELLEV:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
ELLEV returns the level of an element within a dimension.

Syntax:
ELLEV(dimension, element)

Arguments:

Argument	Description
dimension	A valid dimension name.
element	The name of an element within the dimension.

Example:
ELLEV('Region','Europe')
In the Region dimension, individual countries (Level 0) add up to regions (Level 1).
The regions then add up to super-regions (Level 2), which in turn add up to the world (Level 3). The example returns 2, as Europe is a Level 2 element.

ELPAR:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
ELPAR returns the parent of an element in a specified dimension

Syntax:
ELPAR(dimension, element, index)

Arguments:

Argument	Description
dimension	A valid dimension name.
element	The name of an element within the dimension.
index	A positive value less than or equal to the total number of consolidated elements (parents) that use the element argument as a child.

Example:
ELPAR('Model','Wagon 4WD',2)
In the dimension Model, the element Wagon 4WD is a child of both Total Wagons and Total 4WD. Therefore, both Total Wagons and Total 4WD are parents of Wagon 4WD. In the structure of the Model dimension, Total Wagons is defined first, Total 4WD is defined second.
The example returns Total 4WD, as this is the second instance of a parent to Wagon 4WD within the Model dimension.

ELPARN:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
ELPARN returns the number of parents of an element in a specified dimension.

Syntax:
ELPARN(dimension, element)

Arguments:

Argument	Description
dimension	A valid dimension name.
element	The name of a consolidated element within the dimension.

Example:
ELPARN('Model','Wagon 4WD')
In the Model dimension, the element Wagon 4WD is a child of both Total Wagons and Total 4WD. Therefore, both Total Wagons and Total 4WD are parents of Wagon 4WD. The function returns 2.

ELWEIGHT:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
ELWEIGHT returns the weight of a child in a consolidated element.

Syntax:
ELWEIGHT(dimension, element1, element2)

Arguments:

Argument	Description
dimension	A valid dimension name.
element1	The name of an element within the dimension.
element2	The name of an element within the dimension.

Example:
ELWEIGHT('Account1','Gross margin','Variable Costs')
The element Variable Costs, which is a child of Gross margin, has a weight of -1. The example returns -1.