ViewExtractSkipConsolidatedStringsSet

ViewExtractSkipConsolidatedStringsSet sets an option to exclude strings on consolidated values that are excluded from a view or any associated view extracts. A view extract is a TM1® view exported as an ASCII comma-delimited (.cma) file.

TM1 allows the storing of strings on calculated values. When you exclude a calculated value from a view or view extract you may want to exclude the message string also from the view.

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.

This function is valid in TM1 TurboIntegrator processes only.

Syntax

ViewExtractSkipConsolidatedStringsSet (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 0 to include strings stored on consolidated values. This is the current and default behavior. Specify 1 to exclude strings stored on consolidated values.

Example

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

This example turns on the Skip Rule for Consolidated String option for the extract created from the 1st Quarter Actuals view. The extract will not include any string on the consolidated value.