SecurityOverlayCreateGlobalDefault

SecurityOverlayCreateGlobalDefault is used to create or destroy a Security Overlay cube, and to set the overlay for a given area of a data cube.

Creating a data cube with a name that signifies an overlay cube will cause the data cube to be made into an overlay if the server is restarted. When the cube is loaded it will be configured as an overlay if a matching data cube is found.

Global overlays apply to all users.

The process must be configured to modify security data to successfully execute SecurityOverlayCreateGlobalDefault.

The function returns True if successful and a major error if unsuccessful.

This function is valid in TM1® TurboIntegrator processes only.

Syntax

SecurityOverlayCreateGlobalDefault (Cube, DimensionMap)

Argument

Description

Cube

Name of the cube.

DimensionMap

String specifying whether the dimension at each position should be used in the overlay. The order of dimensions is the original cube order. A 1 for each included dimension and a 0 for an excluded one. Each value separated by a colon.

Example

SecurityOverlayCreateGlobalDefault(‘DataCube’,
        ‘0:0:1:0’);