Cognos TM1 Cube Data Rules Functions

Cognos TM1 Cube Data Rules Functions:

1. DB
2. ISLEAF
3. UNDEF
4. UNDEFVALS

DB:
This is a TM1 rules function, valid in TM1 rules only. Use of this function in a TurboIntegrator process will cause an error.
DB returns a value from a cube in a TM1 database. DB returns a numeric value if used in a numeric expression and a string value if used in a string expression.
Syntax:
DB(cube, e1, e2, [...e256])

Arguments:

Arguments	Description
cube	The name of the cube from which to retrieve the value.
e1,...en	Dimension element names that define the intersection containing the value to be retrieved. e1,...en Arguments e1 through en are sequence-sensitive. e1 must be an element from the first dimension of the cube, e2 must be an element from the second dimension, and so on.

Example:
DB('Budget', 'California', '15" Flat Panel Monitors', 'Net Sales', 'January')
In the above example, Budget is the cube name, and the function returns the value at the intersection of California, 15" Flat Panel Monitors, Net Sales, and January.

ISLEAF:
This is a TM1 rules function, valid only in TM1 rules.
ISLEAF returns 1 if a specified cell is a leaf cell (identified solely by leaf/simple elements). If the specified cell is identified by any consolidated elements, the function returns 0.
The ISLEAF function cannot be used in TurboIntegrator processes. The presence of this function in a process will prevent the process from compiling.
Syntax:
ISLEAF
Arguments:
None

Example:
You can use ISLEAF in an IF statement to test if a current cell is a leaf cell.
For example, []=IF((ISLEAF=1),TrueStatement, FalseStatement);
executes the TrueStatement if the current cell is a leaf cell, otherwise it executes the FalseStatement.

UNDEF:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
UNDEF returns the undefined value. This function can be used to prevent datafrom being stored in a cube based on a logical test.
Syntax:
UNDEF
Arguments: None

Example:
UNDEF returns the undefined value.

UNDEFVALS:
This is a TM1 rules function, valid in both TM1 rules and TurboIntegrator processes.
UNDEFVALS allows users to distinguish between data cells that are empty and cells that actually contain a zero. When a rule includes an UNDEFVALS statement, cells containing zeros display the value zero, but empty cells appear blank. This function can also be used to prevent data from being stored in a cube based on a logical test. When used, UNDEFVALS must be the first statement in a rule without a SKIPCHECK statement.
If a rule includes a SKIPCHECK statement, the UNDEFVALS statement must be the second statement in the rule.

Note: When UNDEFVALS is used to distinguish between empty cells and those containing the value 0, cells containing the value 0 remain visible when zero suppression is applied to a view.
Syntax:
UNDEFVALS
Arguments:
None.

Example:
When a rule includes an UNDEFVALS statement, cells containing zeros display the value zero, but empty cells appear blank.