SetUseActiveSandboxProperty

This function controls whether a process reads and writes cube data to the base data or to the user's active sandbox.

This is a TM1® TurboIntegrator function, valid only in TurboIntegrator processes. The default is for processes to read and write to the base data.

The scope of this function applies only to the current running process and temporarily overrides the permanent value for this property that is set in the Architect / Server Explorer user interface.

Syntax

SetUseActiveSandboxProperty(PropertyValue)

Argument	Description
PropertyValue	A Boolean value that indicates whether the process should use the active sandbox context when reading and writing cube data. If PropertyValue = 0, the process will disregard the active sandbox context and read/write to the base data. If PropertyValue = 1, the process will read/write cube data to the active sandbox.

Argument

Description

PropertyValue

A Boolean value that indicates whether the process should use the active sandbox context when reading and writing cube data.

If PropertyValue = 0, the process will disregard the active sandbox context and read/write to the base data.

If PropertyValue = 1, the process will read/write cube data to the active sandbox.

Example

SetUseActiveSandboxProperty(1);

This example will cause the process to read/write cube data to the active sandbox for the rest of this execution.