Use the command line arguments and parameters in this reference to manage your Vault’s file staging server. This article lists actions and parameters available in the Vault Loader file staging command line tool. For information on getting started with the Vault Loader command line tool, including installation and authentication, see Using the Vault Loader Command Line Tool. For information on using the Vault Loader command line tool to to load data to your Vault or extract data from your Vault in bulk, see the Vault Loader Command Line Tool Reference.
File Staging Basics
When managing your Vault’s file staging server:
- To view the root folder on the staging server, you must have the standard Vault Owner or System Admin security profile. Non-Admin users with a security profile that grants the Application: File Staging: Access permission can view and manage items in a personal folder.
- When outputting a list of items on the staging server, Vault places the CSV output file in the same directory as your VaultDataLoader.jar file.
- When uploading items, place files in the same directory as your VaultDataLoader.jar file.
List Items
List files and folders on your Vault’s file staging server. You can specify the path to the folder to begin the listing. If omitted, the listing begins at the root (for Admin users) or user folder (for non-Admin users). If results are not output to a CSV file, Vault displays up to 25 items at a time. Press the spacebar followed by enter to see the next 25 items. This pagination option expires after 20 minutes.
| Action | Parameters | Example |
| -ls [PATH] |
-R -l -output [FILENAME] -outputoverwrite [FILENAME] |
java -jar VaultDataLoader.jar -ls u123456/cholecap_files -R -l -output cholecap_files.csv |
|
java -jar VaultDataLoader.jar -ls -outputoverwrite cholecap_files.csv |
Create a Folder
Create one or more folders at a given path on your Vault’s file staging server.
| Action | Parameters | Example |
|
-mkdir [PATH] |
java -jar VaultDataLoader.jar -mkdir Folder1 /u123456/Folder2 |
Upload a File or Folder
Upload files or folders to the File Staging Server.
|
Action |
Parameters |
Example |
|
-put [ITEM] |
-parent [FOLDER] -overwrite -R -concurrent [NUMBER] -output [FILENAME] -outputoverwrite [FILENAME] |
java -jar VaultDataLoader.jar -put cholecap_files -parent u123456/Cholecap_folder -R -concurrent 5 -output cholecap_files_upload_progress.csv |
|
java -jar VaultDataLoader.jar -put nyaxa_files -parent u123456/Nyaxa_folder -outputoverwrite nyaxa_files_upload_progress.csv |
Download Files or Folders
Download one or more files or folders from the staging server.
|
Action |
Parameters |
Example |
|
-get [ITEM] |
-downloadpath [PATH] -overwrite -R -concurrent -output -outputoverwrite |
java -jar VaultDataLoader.jar -get cholecap_files -downloadpath Desktop/Cholecap_folder -R -concurrent 5 -output cholecap_files_download_progress.csv |
|
java -jar VaultDataLoader.jar -get nyaxa_files -outputoverwrite nyaxa_files_download_progress.csv |
Rename a File or Folder
Change the name of an existing file or folder.
|
Action |
Parameters |
Example |
|
-rename [ITEM] [NEWITEM] |
java -jar VaultDataLoader.jar -rename holecap_files cholecap_files |
Move a File or Folder
Move an existing file or folder.
|
Action |
Parameters |
Example |
|
-move [ITEM] [PATH] |
-overwrite |
java -jar VaultDataLoader.jar -move nyaxa_files/cholecap.pdf cholecap_files
-overwrite |
Delete a File or Folder
Delete one or more files or folders at a given path on your Vault’s file staging server. Use the -R parameter on a specified folder to remove all of its contents recursively, including files and subfolders.
| Action | Parameters | Example |
|
-rm [PATH] |
-R |
java -jar VaultDataLoader.jar -rm /u123456/cholecap.docx /nyaxa.txt |
|
java -jar VaultDataLoader.jar -rm /folder1 /folder2/subfolder3 -R |
File Staging Parameters
| Parameter | Description |
|
-R |
Use this flag to apply an action to all files and subfolders in a folder. |
|
-l |
Use this flag with the List Items action to return results in long format, including kind, name, path, size (for files only), and modified date (for files only). If omitted, the default is short format. |
|
-output [FILENAME] |
Use this flag to output results to a csv file with a specified name. Once generated, Vault places this file in the same directory as your VaultDataLoader.jar file. |
|
-outputoverwrite [FILENAME] |
Use this flag to overwrite an existing output file. |
| -parent | When using the Upload a File or Folder action, this flag is required and specifies the path to the parent directory to place the uploaded files or folders. |
| -concurrent | Use this flag with the Upload a File or Folder or Download Files or Folders action to specify the number of concurrent uploads or downloads, which can be between 1 and 10. |
| -downloadpath | Use this flag with the Download Files or Folders action to specify the path to the folder in which to place the download. If omitted, Vault places the files in the "filedownloads" subfolder of the directory containing your VaultDataLoader.jar file. |
| -overwrite | Use this flag with the Move a File or Folder action to overwrite an existing item with the same name. If omitted, the default is not to overwrite. |