Sandbox Functions

These functions are used with sandboxes.

GetUseActiveSandboxProperty
GetUseActiveSandboxProperty returns a Boolean value that indicates whether a process reads and writes data to the base data or to the user's active sandbox.
ServerActiveSandboxGet
ServerActiveSandboxGet returns the name of the user's active sandbox. If the user has no active sandbox, an empty string is returned. Because chores run in the context of a special admin user, and can have no active sandbox, this function always returns an empty string when executed using a chore.
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.
ServerSandboxClone
ServerSandboxClone clones an existing sandbox into a new sandbox.
ServerSandboxCreate
ServerSandboxCreate creates a new sandbox.
ServerSandboxesDelete
ServerSandboxesDelete allows administrators to discard user sandboxes that match certain criteria.
ServerSandboxDiscardAllChanges
ServerSandboxDiscardAllChanges discards all changes in an existing sandbox.
ServerSandboxMerge
ServerSandboxMerge merges a source sandbox into an existing target sandbox. If the target sandbox is not specified, the source sandbox is merged into base.
ServerSandboxExists
ServerSandboxExists tests for the existence of the passed sandbox. 1 is returned when the passed sandbox exists, 0 otherwise.
ServerSandboxGet
ServerSandboxGet returns the name of the sandbox identified by the number N, where N is the parameter entered.
ServerSandboxListCountGet
ServerSandboxListCountGet returns the count of sandboxes as a number.
SetUseActiveSandboxProperty
SetUseActiveSandboxProperty controls whether a process reads and writes cube data to the base data or to the user's active sandbox. The default is for processes to read and write to the base data.

Parent topic: TurboIntegrator Functions