ViewExtractSkipZeroesSet

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

ViewExtractSkipZeroesSet is the equivalent of the Skip Zero/Blank 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.

This function is valid in TM1 TurboIntegrator processes only.

Syntax

ViewExtractSkipZeroesSet (Cube, ViewName, Flag);

Argument	Description
Cube	The parent cube of the view for which you are setting the Skip Zeroes option.
ViewName	The view for which you are setting the Skip Zeroes option.
Flag	A binary value that turns the option on or off. Specify 1 to exclude zeroes from the extract. Specify 0 to include zeros. When UNDEFVALS is used to represent zeroes, the values are not excluded when the Flag argument is 1.

Argument

Description

Cube

The parent cube of the view for which you are setting the Skip Zeroes option.

ViewName

The view for which you are setting the Skip Zeroes option.

Flag

A binary value that turns the option on or off. Specify 1 to exclude zeroes from the extract. Specify 0 to include zeros.

When UNDEFVALS is used to represent zeroes, the values are not excluded when the Flag argument is 1.

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

Example

ViewExtractSkipZeroesSet ('99sales', '1st Quarter Actuals',1);

This example turns on the Skip Zeroes option for the extract created from the 1st Quarter Actuals view. The extract will not include any zero or blank values.