GetUseActiveSandboxProperty

GetUseActiveSandboxProperty returns a Boolean value that indicates whether a process reads and writes data to the base data or to the user's active sandbox.

This function is valid in TM1® TurboIntegrator processes only.

The default is for processes to read and write to the base data.

  • If the return is 0, the process is currently reading and writing to the base data.
  • If the return is 1, the process is currently reading and writing to the active sandbox.
Note: This function returns the permanent value for this property as set in the Architect / Server Explorer user interface unlessyou have used the SetUseActiveSandboxProperty function in the process. In that case, the value for this property is determined by the value that was last set with the SetUseActiveSandboxProperty function.

Syntax

GetUseActiveSandboxProperty()

Arguments

None.

Example

return_value = GetUseActiveSandboxProperty();

This example will return a Boolean value indicating whether the process is currently reading and writing cube data to the active sandbox or to the base data.