Chapter 3. Graphs on Server Side - Sandboxes

Sandbox is a base storage unit for project. Sandbox is actually a server-side analogy to a CloverETL Designer project. Since CloverETL Designer has a connector to CloverETL Server, a designer project and a server sandbox may be linked together. This remote CloverETL Designer project looks and works like common local project, but all files are stored on the server side and all operations are performed on server side. See CloverETL Designer manual for details on configuring a connection to the server.

Technically speaking, a sandbox is a dedicated directory on the server file system. A sandbox cannot contain another sandbox. It is recommended to have one directory as sandboxes container and create a subdirectory for each sandbox. Files and directories in sandboxes are read by JVM of Application Server. Thus, all these directories must be accessible to the OS user who executes JVM of Application Server. i.e. If Apache Tomcat is executed as an OS service by "tomcat" user, all sandboxes must be accessible to this user.

In cluster mode, there are three sandbox types: "shared", "local" and "partitioned". See Chapter 22, Clustering for details.

Sandboxes Section in CloverETL Server Web GUI

Figure 3.1. Sandboxes Section in CloverETL Server Web GUI


Each sandbox is defined by following attributes:

Table 3.1. Sandbox attributes

IDUnique "name" of the sandbox. It is used in server APIs to identify sandbox. It must meet common rules for identifiers. It is specified by user in during sandbox creation and it can be modified later. Note: modifying is not recommended, because it may be already used by some CS APIs clients.
NameSandbox name used just for display. It is specified by user in during sandbox creation and it can be modified later.
Root pathAbsolute server side file system path to sandbox root. It is specified by user during sandbox creation and it can be modified later. This attribute is used only in standalone mode. See Chapter 22, Clustering for details about cluster mode.
OwnerIt is set automatically during sandbox creation. It may be modified later.

Sandbox Detail in CloverETL Server Web GUI

Figure 3.2. Sandbox Detail in CloverETL Server Web GUI