ServerActiveSandboxGet function for IBM Planning Analytics (TM1)
ServerActiveSandboxGet returns the name of the active sandbox for the user. If no sandbox is set as active, the function returns a blank string.
In this video, ServerActiveSandboxGet will be used to get the user’s active sandbox name.
Where can the ServerActiveSandboxGet function be used?
TurboIntegrator
Which TM1 Server version is the ServerActiveSandboxGet function available for?
Version 11 and 12
What is the syntax for ServerActiveSandboxGet?
ServerActiveSandboxGet();
- Note
- As chores run in a special user context, so TM1 will always return a blank string when this function is executed by a chore.
- Sandboxes are a private space for users to work and insert values. These values are stored separately from the TM1 database.
Relevant Functions
- GetUseActiveSandboxProperty = Returns a value that identifies if the process has read/write access to the base or active sandbox for the user
- ServerActiveSandboxGet = Returns the name of the active sandbox for the user
- ServerActiveSandboxSet = Sets an existing sandbox as active for the user
- ServerSandboxClone = Creates a sandbox that is a copy of an existing one
- ServerSandboxCreate = Creates a new Sandbox for the user
- ServerSandboxDiscardAllChanges = Discards all changes for a given sandbox owned by the user who executed the process
- ServerSandboxesDelete = Delete user sandboxes from the TM1 server (Admin use only)
- ServerSandboxExists = Checks if a sandbox exists for a user
- ServerSandboxGet = Returns the name of a user sandbox using an index
- ServerSandboxListCountGet = Returns the number of sandboxes a user has
- ServerSandboxMerge = Merges a source sandbox into a target sandbox for the user who executed the process
- SetUseActiveSandboxProperty = Set whether the process reads/writes cube data to the base or active sandbox for the user