ViewExtractFilterByTitlesSet

ViewExtractFilterByTitlesSet sets an option to filter by titles on consolidated values that are excluded from a view or any associated view extracts.

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

ViewExtractFilterByTitlesSet (Cube, ViewName, FilterByTitles, Temporary);

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.

FilterByTitles

A binary value that turns the option on or off. Specify 0 to include titles stored on consolidated values. This is the current and default behavior. Specify 1 to exclude titles stored on consolidated values.

Temporary

A Boolean value that indicates whether the settings are temporary.

Example

ViewExtractFilterByTitlesSet ('99sales', '1st QuarterActuals', 1, 0);