ServerSandboxExists function for IBM Planning Analytics (TM1)

ServerSandboxExists checks if a sandbox exists for a user. It returns a numeric value of 1 if the sandbox exists or 0 if it does not exist.

In this video, ServerSandboxExists will be used to check if the sandbox Training exists.

TurboIntegrator

Version 11 and 12

ServerSandboxExists(SandboxName, UserName)

SandboxName = Name of the existing sandbox to be cloned.
UserName = Optional parameter with a user’s name to check if the sandbox exists. If omitted, TM1 will check the user who is running the process. This parameter only works if an Admin, DataAdmin or the given user is running the process. If not, TM1 will return an error.

Note: Sandboxes are a private space for users to work and insert values. These values are stored separately from the TM1 database.

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