About Vault Loader
Vault Loader allows you to load data to your vault or extract data from your vault in bulk. Loader is particularly useful during migrations and on-boarding. Extracted information downloads to a CSV file, which you can load back into your vault or into other systems.
| Available Bulk Actions | File | Batch Size |
|---|---|---|
| Extract Object Record Metadata | CSV output | up to 1,000,000 |
| Extract Users | CSV output | up to 1,000,000 |
| Extract Groups | CSV output | up to 1,000,000 |
| Create, Update & Delete Object Records | CSV input | unlimited; (CSV must be under 1GB) |
| Create & Update Users | CSV input | unlimited; ( CSV must be under 1GB) |
| Create & Update Groups | CSV input | unlimited; (CSV must be under 1GB) |
How to Enable Vault Loader
To enable Vault Loader, go to Admin > Settings > General Settings. Once enabled, the Loader tab appears in the vault’s primary navigation bar.
Loader Permissions
By default, only Vault Owners have access to the loader. To extend this functionality to other users or groups, assign them to a custom security profile that includes the Vault Loader permission.
To perform any actions through Loader, you must also have the correct access for the action. For example, you cannot update documents on which you don’t have role-based permissions or create users without the appropriate security profile.
There are additional permissions and restrictions for FTP access.
Notifications & Output Files
Vault shows the status of loader jobs in Admin > Operations > Job Status and also sends notifications for both successes and failures. Admins can modify the notification message templates if needed.
Success & Failure Log Files
After each load, Vault creates separate success and failure logs as CSV files. You can download these files from the in-vault notification or email notification. Both files contain the system-managed id values of each record.
If you select the Include fields in output log checkbox when loading, Vault queries the fields using VQL and validates that the fields were successfully created.
Failure Logs
Failure logs include:
- Error messages for each record that failed to load
- Original data alongside corresponding errors
- Row IDs from the original CSV file for the corresponding row
You can review and fix errors from within the error log. Once you correct any errors, you can re-import the failure log.
How to Use the FTP Server
See Accessing Your Vault FTP Server to learn about connecting to the server. Note that you must use UTF-8 encoding in your CSV files.
How to Use the Server for Inputs
To reference files:
- Connect to the FTP server for your vault.
- Upload files to the server. You can put these in the root directory or in your personal subdirectory. You can also create a new subdirectory for them.
- Add the file column to your CSV input and enter the path/name of each file relative to the FTP root directory, for example, u60613/Dec-2015-Batch/Study_Countries.csv.
How to Use the Server for Extracts
When Vault Loader exports files as part of an extract, you can find those files on your staging server. The CSV output will include the file column that shows the filename and location, relative to the FTP root directory.