ViewExtractSkipRuleValuesSet

ViewExtractSkipRuleValuesSet sets an option to include/exclude rule-calculated values in a view and any associated view extracts. A view extract is a TM1® view exported as an ASCII comma-delimited (.cma) file.

ViewExtractSkipRuleValuesSet is the equivalent of the Skip Rule Calculated Values option in the View Extract dialog box.

Note: This function affects views as they exist on the server. The scope of this function is not restricted to extracts generated from a view. Setting ViewExtractSkipRuleValuesSet=1 causes a "rules off" mode, which turns off all rule evaluation. This means that not only are rule-calculated cells excluded, but their contribution to consolidations is also ignored. This can result in consolidated values in the view being different from the consolidated values in the cube.

This function is valid in TM1 TurboIntegrator processes only.

Syntax

ViewExtractSkipRuleValuesSet (Cube, ViewName, Flag);

Argument	Description
Cube	The parent cube of the view for which you are setting the option.
ViewName	The view for which you are setting the option.
Flag	A binary value that turns the option on or off. Specify 1 to exclude rule-calculated values from the extract. Specify 0 to include rule-calculated values.

Note: Read about the impact of enabling a specific combination of view manipulation functions.

Example

ViewExtractSkipRuleValuesSet ('99sales', '1st QuarterActuals', 1);

This example turns on the Skip Rule Calculated Values option for the extract created from the 1st Quarter Actuals view. The extract will not include any rule-calculated values.