AddInfoCubeRestriction
AddInfoCubeRestriction filters InfoCube data as it is pulled into TM1®. Use this function to restrict the values that are imported for a specified characteristic. This function must be placed in the Prolog. The function can be called multiple times to filter more than one characteristic in a single process.
This function is valid in processes only.
This function is not available in processes on Planning Analytics Engine.
Syntax
AddInfoCubeRestriction(STRING CharactName, STRING sign,STRING compOperator,
STRING lowValue, STRING highValue)|
Argument |
Description |
|---|---|
|
STRING CharactName |
Contains the technical name of the characteristic to be restricted. The data type has to be a character string with a length equal to or less than 30. |
|
STRING sign |
Contains either I (= inclusive) or E (= exclusive). Exclusive is the logical NOT for the restriction specified by this row. The data type has to be a character of length 1. |
|
STRING compOperator |
Contains the relational comparative operator. The data type has to be a character string of length 2. Valid comparative operators are: 'EQ' = equal 'NE' = not equal 'LT' = less than 'GT' = grater than 'LE' = less or equal 'GE' = grater or equal 'BT' = between 'NB' = not between |
|
STRING lowValue |
Contains the low value for the operator specified in the row before. The data type has to be a character string with a length equal to or less than 60. |
|
STRING highValue |
Contains the high value for the operator specified two rows before. The data type has to be a character string with a length equal to or less than 60. It is only needed for the operators BT and NB, otherwise it is ignored, and in this case an empty string should be placed here. |
Example
The following example returns all characteristic values between 1997 and 2000.
AddInfoCubeRestriction('0CALYEAR','E','BT','1997','2000');The following example returns all characteristic values not between 1997 and 2000.
AddInfoCubeRestriction('0CALYEAR','I','NB','1997', '2000') ;The following example returns all characteristic values not equal to USD.
AddInfoCubeRestriction('0DOC_CURRCY', 'I', 'NE', 'USD','') ;