ServerActiveSandboxSet
ServerActiveSandboxSet sets the active sandbox of the executing user. An empty string is used to clear the executing user's active sandbox. This function throws an error if the executing user does not own a sandbox with the passed name.
Because chores run in the context of a special admin user, and can have no active sandbox, this function always throws an error when executed using a chore.
Note: For a TurboIntegrator process to read and write values in the context of the executing user's
active sandbox, the UseActiveSandbox property must be set. See GetUseActiveSandboxProperty and SetUseActiveSandboxProperty.
This function is valid in TM1® TurboIntegrator processes only.
Syntax
ServerActiveSandboxSet(SandboxName)| Argument | Description |
|---|---|
|
SandboxName |
A string value. The name of a sandbox owned by the executing user. |
Example: Set the executing user's active sandbox to "Best case"
ServerActiveSandboxSet('Best case');Example: Clear the executing user's active sandbox and set context back to the base data
ServerActiveSandboxSet('');