ServerSandboxMerge function for IBM Planning Analytics (TM1)
ServerSandboxMerge merges a source sandbox into a target sandbox for the user who executed the process.
In this video, ServerSandboxMerge will be used to merge the sandbox ‘Goal’ to ‘Training’.
Where can the ServerSandboxMerge function be used?
TurboIntegrator
Which TM1 Server version is the ServerSandboxMerge function available for?
Version 11 and 12
What is the syntax for ServerSandboxMerge?
ServerSandboxMerge(SourceSandboxName, TargetSandboxName, ConflictRes, WaitForLocks)
- SourceSandboxName = Name of the existing sandbox owned by the user that will be merged into the target sandbox.
- TargetSandboxName = Name of the existing sandbox owned by the user that will be targeted and receive values from the source sandbox. If black, TM1 will consider the TM1 database as a target.
- ConflictRes = Optional and ignored parameter.
- WaitForLocks = Optional Boolean parameter. 1 means TM1 will wait to solve locks or exceptions and try the task again without rolling back the number. 0 means TM1 will not wait for exceptions and rollback if that happens.
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