Sandbox Content
Sandbox should contain graphs, metadata, external connection and all related files. Files especially graph files are identified by relative path from sandbox root. Thus you need two values to identify specific graph: sandbox and path in sandbox.
Although web GUI section sandboxes isn't file-manager, it offers some useful features for sandbox management.
Download sandbox in ZIP
Select sandbox in left panel, then web GUI displays button "Download sandbox in ZIP" in the tool bar on the right side.
Created ZIP contains all readable sandbox files in the same hierarchy as on file system. You can use this ZIP file for upload files to the same sandbox, or another sandbox on different server instance.
Upload ZIP to sandbox
Select sandbox in left panel. You must have write permission to the selected sandbox. Then select tab "Upload ZIP" in the right panel. Upload of ZIP is parametrized by couple of switches, which are described below. Open common file chooser dialog by button "+ Upload ZIP". When you choose ZIP file, it is immediately uploaded to the server and result message is displayed. Each row of the result message contains description of one single file upload. Depending on selected options, file may be skipped, updated, created or deleted.
Table 3.3. ZIP upload parameters
| Label | Description |
|---|---|
| Encoding of packed file names | File names which contain special characters (non ASCII) are encoded. By this select box, you choose right encoding, so filenames are decoded properly. |
| Overwrite existing files | If this switch is checked, existing file is overwriten by new one, if both of them are stored in the same path in the sandbox and both of them have the same name. |
| Replace sandbox content | If this option is enabled, all files which are missing in uploaded ZIP file, but they exist in destination sandbox, will be deleted. This option might cause loose of data, so user must have special permission "May delete files, which are missing in uploaded ZIP" to enable it. |
Download file in ZIP
Select file in left panel, then web GUI displays button "Download file in ZIP" in the tool bar on the right side.
Created ZIP contains just selected file. This feature is useful for large files (i.e. input or output file) which cannot be displayed directly in web GUI. So user can download it.
Download file HTTP API
It is possible to download/view sandbox file accessing "download servlet" by simple HTTP GET request:
http://[host]:[port]/[Clover Context]/downloadFile?[Parameters]
Server requires BASIC HTTP Authentication. Thus with linux command line HTTP client "wget" it would look like this:
wget --user=clover --password=clover http://localhost:8080/clover/downloadFile?sandbox=default\&file=data-out/data.dat
Please note, that ampersand character is escaped by back-slash. Otherwise it would be interpreted as command-line system operator, which forks processes.
URL Parameters
sandbox - Sandbox code. Mandatory parameter.
file - Path to the file relative from sandbox root. Mandatory parameter.
zip - If set to "true", file is returned as ZIP and response content type is "application/x-zip-compressed". By default it is false, so response is content of the file.