ServerSandboxGet function for IBM Planning Analytics (TM1)

Where can the ServerSandboxGet function be used?

TurboIntegrator

Which TM1 Server version is the ServerSandboxGet function available for?

Version 11 and 12

What is the syntax for ServerSandboxGet?

ServerSandboxGet(Index, UserName)

• ​​Index = Index of the sandbox to have the name retrieved. The index is a contiguous number. If one sandbox is deleted, the following sandboxes will have their Index changed, that also means that the first iteration to return a blank value can be used to stop the iteration.​
• 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 runs the process; if not, TM1 will return an error.

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