# Vault Loader Command Line Tool Reference Use the command line arguments and parameters in this reference to load data to your Vault or extract data from your Vault in bulk. This article lists actions and parameters available in the Vault Loader 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 manage your Vault's file staging, see the Vault Loader File Staging Command Line Tool Reference. For each CSV input file, the file contents must be in comma-separated value format, but the file extension can be either .CSV or .TXT. ## Create Documents Before starting, upload document source files or renditions to file staging. If you do not provide source files, documents are created as placeholders. Prepare the CSV input file.

Action	Parameters	Example
-createdocument	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -createdocument -csv docs_for_upload.csv -m vault_vph_fields.csv`

## Update Documents {#update-documents} This action updates document fields on existing documents using the values you provide in the CSV. Before starting, prepare the CSV input file.

Action	Parameters	Example
-updatedocuments	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -updatedocuments -csv docs_for_upload.csv -m vault_vph_fields.csv`

## Add Document Versions {#add-document-versions} This action creates new versions for an existing document. Before starting, upload all source files to file staging and prepare the CSV input file.

Action	Parameters	Example
-createversions	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -createversions -csv docs_for_upload.csv -m vault_vph_fields.csv`

## Add Document Renditions {#add-document-renditions} This action adds new renditions to existing documents. Before starting, upload all files to file staging and prepare the CSV input file.

Action Parameters Example

-createrenditions

-csv [CSV]

-m [MAPPING]

java -jar VaultDataLoader.jar -createrenditions 

 -csv new_renditions.csv 

 -m vault_vph_fields.csv

## Create Document Attachments This action adds new attachments to existing documents. If the attachment already exists, Vault uploads the attachment as a new version of the existing attachment. Before starting, upload all files to file staging and prepare the CSV input file.

Action Parameters Example

-createdocumentattachments

-csv [CSV]

-m [MAPPING]

java -jar VaultDataLoader.jar -createdocumentattachments

-csv new_attachments.csv

-m vault_vph_fields.csv

## Delete Document Attachments This action removes attachments from existing documents. Before starting, prepare the CSV input file.

Action

Parameters

Example

-deletedocumentattachments

-csv [CSV]

-m [MAPPING]

java -jar VaultDataLoader.jar -deletedocumentattachments

-csv attachments_to_delete.csv

-m vault_vph_fields.csvs

## Create Document Relationships This action creates new document relationships using details from the CSV file you provide. Before starting, prepare the CSV input file.

Action	Parameters	Example
-createrelationships	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -createrelationships -csv supporting_docs_2017.csv`

## Export Document Relationships This action exports document relationship metadata.

Action Parameters Example

-exportrelationships

-csv [CSV]

-type [TYPE]

-subtype [SUBTYPE]

-classification [CLASSIFICATION]

-noneditable

-headers

-where [WHERE]

-columns [COLUMNS]

java -jar VaultDataLoader.jar createrleationships -exportrelationships -csv supporting_doc_relationships.csv -type References -where "product__v='wonderDrug'"-columns created_by__v

## Delete Document Relationships This action deletes existing document relationships identified in the CSV file. Before starting, prepare the CSV input file.

Action	Parameters	Example
-deleterelationships	-csv [CSV] -includefields	`java -jar VaultDataLoader.jar -deleterelationships -csv delete_supporting_doc_relationships.csv`

## Update Document Roles {#update-document-roles} This action updates the users assigned to roles on specific documents. Before starting, prepare the CSV input files.

Action	Parameters	Example
-updateroles	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -updateroles -csv new_doc_roles.csv -m vault_vph_fields.csv`

## Remove Users from Document Roles This action removes users from roles on specific documents. Before starting, prepare the CSV input files.

Action Parameters Example

-deleteroles

-csv [CSV]

-m [MAPPING]

java -jar VaultDataLoader.jar -deleteroles 

-csv remove_from_doc_roles.csv 

-m vault_vph_fields.csv

## Export Documents This action exports document field values, renditions, and/or source files for all documents or documents that meet your criteria. Extracted metadata uses the specified CSV file. Exported files go to your Vault's file staging. You can also use this action to export document field names as column headers without data.

Action Parameters Example

-exportdocuments

-csv [CSV]

-type [TYPE]

-subtype [SUBTYPE]

-classification [CLASSIFICATION]

-headers

-columns [COLUMNS]

-source

-renditions

-allversions

java -jar VaultDataLoader.jar -exportdocuments -csv doc_extract.csv -source -type Resources -where "product__v='wonderDrug'" -columns created_by__v,title__v

### Exporting Source Files & Renditions When exporting files using _-renditions_ and/or _-source_, Vault Loader can only export 2,000 files in a single action. You can refine your export by document type or using the _WHERE_ clause. When an export includes documents with multiple rendition types and you include _-renditions_, the CSV output includes a separate row for each rendition type. ## Create Users {#create-users} This action creates new users using details from the CSV file you provide. Before starting, prepare the CSV input file.

Action	Parameters	Example
-createusers	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -createusers -csv user_onboarding.csv -m vault_vph_fields.csv`

## Update Users {#update-users} This action updates details for existing users using the CSV file you provide. Before starting, prepare the CSV input file.

Action	Parameters	Example
-updateusers	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -updateusers -csv user_update.csv -m vault_vph_fields.csv`

## Upsert Users {#upsert-users} This action creates new users and updates details for existing users using the CSV file you provide. Before starting, prepare the CSV input file.

Action Parameters Example

-upsertusers

-csv [CSV]

-m [MAPPING]

-idParam [FIELD]

java -jar VaultDataLoader.jar -upsertusers 

 -csv user_update.csv 

 -m vault_vph_fields.csv

## Export Users This action exports user metadata.

Action Parameters Example

-exportusers

-csv [CSV]

-columns [FIELD]

-where [WHERE]

-headers

-noneditable

java -jar VaultDataLoader.jar -exportusers 

 -csv users_12-15-15.csv

 -noneditable

 -where "active__v='false'"

java -jar VaultDataLoader.jar -exportusers -csv users_names.csv -columns first_name__v,last_name__v

## Create Groups {#create-groups} This action creates new groups using details from the CSV file you provide. Before starting, prepare the CSV input file.

Action	Parameters	Example
-creategroups	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -creategroups -csv group_import.csv -m vault_vph_fields.csv`

## Update Groups {#update-groups} This action updates existing groups using details from the CSV file you provide. Before starting, prepare the CSV input file.

Action	Parameters	Example
-updategroups	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -updategroups -csv group_update.csv -m vault_vph_fields.csv`

## Upsert Groups {#upsert-groups} This action updates existing groups using details from the CSV file you provide. Before starting, prepare the CSV input file.

Action Parameters Example

-upsertgroups

-csv [CSV]

-m [MAPPING]

idParam [FIELD]

java -jar VaultDataLoader.jar -upsertgroups 

 -csv group_import.csv 

 -m vault_vph_fields.csv

## Export Groups This action exports group metadata.

Action Parameters Example

-exportgroups

-csv [CSV]

-columns [FIELD]

-headers

-noneditable

java -jar VaultDataLoader.jar -exportgroups 

 -csv groups_2015.csv

 -noneditable

## Export Object Records {#retrieve-object-records} This action exports record metadata for a specific object.

Action Parameters Example

-export [OBJECT NAME]

-csv [CSV]

-where [WHERE]

-columns [FIELD]

-headers

-noneditable

java -jar VaultDataLoader.jar 

 -export product__v 

 -csv prod_exp.csv 

 -where "name__v like 'Ad%'" 

 -columns name__v

java -jar VaultDataLoader.jar -export product__v -headers

## Create Object Records {#create-object-records} This action creates new object records for a specific object. Before starting, prepare the CSV input file.

Action Parameters Example

-create [OBJECT NAME]

-csv [CSV]

-m [MAPPING]

-recordmigrationmode

java -jar VaultDataLoader.jar 

 -create product__v 

 -csv new_prods.csv 

 -m vault_vph_fields.csv

## Update Object Records {#update-object-records} This action updates existing object records with data from the provided file. Before starting, prepare the CSV input file.

Action Parameters Example

-update [OBJECT NAME]

-csv [CSV]

-m [MAPPING]

-recordmigrationmode

java -jar VaultDataLoader.jar 

 -update product__v 

 -csv update_prods.csv 

 -m vault_vph_fields.csv

## Upsert Object Records {#upsert-object-records} This action updates existing object records or creates new records from the provided file. Before starting, prepare the CSV input file.

Action Parameters Example

-upsert [OBJECT NAME]

-csv [CSV]

-m [MAPPING]

-idParam

-recordmigrationmode

java -jar VaultDataLoader.jar 

 -upsert product__v 

 -csv update_prods.csv 

 -m vault_vph_fields.csv

 -idParam external_id__v

## Delete Object Records {#delete-object-records} This action deletes existing object records identified in the CSV file. If deleting specific records, prepare the CSV input file. If deleting all records, you don't need to provide an input file.

Action	Parameters	Example
-delete [OBJECT NAME]	-csv [CSV] -all	`java -jar VaultDataLoader.jar -delete product__v -csv prods_to_delete.csv`
		`java -jar VaultDataLoader.jar -delete product__v -all`

Note: When deleting all object records, the rowID in the generated success file displays -1 next to each deleted object record. This is an expected behavior.

## Create Object Record Attachments {#create-object-record-attachments} This action adds new attachments to existing object records. If the attachment already exists, Vault uploads the attachment as a new version of the existing attachment. Before starting, upload all files to file staging and prepare the CSV input file.

Action Parameters Example

-createattachments [OBJECT NAME]

-csv [CSV]

-m [MAPPING]

java -jar VaultDataLoader.jar -createattachments product__v

-csv new_attachments.csv

-m vault_vph_fields.csv

## Delete Object Record Attachments {#delete-object-record-attachments} This action deletes existing attachments from object records. Before starting, prepare the CSV input file.

Action Parameters Example

-deleteattachments [OBJECT NAME]

-csv [CSV]

-m [MAPPING]

java -jar VaultDataLoader.jar -deleteattachments product__v

-csv attachments_to_delete.csv

-m vault_vph_fields.csv

## Assign Users & Groups to Object Record Roles {#assign-users-groups-roles} This action assigns users and groups to object record roles with custom or matching sharing rules. Before starting, prepare the CSV input file.

Action Parameters Example

-assignobjectroles [OBJECT NAME]

-csv [CSV]

java -jar VaultDataLoader.jar -assignobjectroles object_name__c

-csv assign_object_roles.csv

## Remove Users & Groups from Object Record Roles {#remove-users-groups-roles} This action removes users and groups from roles on object records with custom or matching sharing rules. Before starting, prepare the CSV input file.

Action Parameters Example

-removeobjectroles [OBJECT NAME]

-csv [CSV]

java -jar VaultDataLoader.jar -removeobjectroles object_name__c

-csv remove_object_roles.csv

## Parameters The following parameters must be used with other arguments to modify how Vault processes a command:

Parameter	Description
-all	Use this flag with a delete action to indicate that the action should affect all records of the specified object.
-async	Use this flag with any action to complete the operation asynchronously. With this flag, you will be able to immediately start a new operation. The command line tool will not display status messages on asynchronous operations, but will immediately return a job ID that enables you to later check the status.
-type [TYPE] -subtype [SUBTYPE] -classification [CLASSIFICATION]	Use these flags to filter the results of an export operation by document type, subtype, and/or classification.
-where [WHERE]	Use this flag with an export action to filter the export based on a VQL query. The value must be a WHERE clause wrapped in double quotation marks, such as `"product__v='wonderDrug'"`.
-headers	Use this flag with an export action to export only field names as column headers. This can help you to create a template for CSV input files.
-columns [COLUMNS]	Use this flag on an export action by specifying field names to limit the export to only those fields. Note that you cannot have spaces between columns names when specifying columns with the '-columns' flags.
-noneditable	Use this flag on an export action to extract both editable and read-only fields. Note that including non-editable fields means that you cannot use the export as a template for CSV input files.
-idParam [FIELD]	Use this flag on update, upsert, or delete actions to specify that items are identified in the CSV input file via an external ID, rather than the ID field.
-allversions	Use this flag on an export documents action to include all document versions in your export.
-includefields	Use this flag with a load action to specify that Vault should include the input fields in the output success log.
-recordmigrationmode	Use this flag to create or update a record in a specific lifecycle state. When you set this flag, Vault skips sending out email notifications when tasks are assigned, reassigned, or completed for the user tasks in the batch. Additionally, Vault bypasses entry criteria, entry actions, event actions (create actions only), validation rules, and reference constraints.
-documentmigrationmode	Use this flag with the following action and object types to create records in a specific state or state type. Also allows you to set the name, document number, and version number: Create documents Update documents Create document renditions Create document versions Create documents, versions, roles