Vault Loader allows you to create new documents in bulk from uploaded source files, document templates, and as content placeholders. You can also update information for existing documents in your Vault.
How to Load Documents
Before loading documents:
- If creating documents from source files, upload files to the staging server via FTP or the Vault REST API Create a Folder or File (Files under 50MB) or Resumable Upload Session (files over 50MB) endpoints.
- Prepare the CSV input file containing document field values.
To load documents:
- In the left panel of the Loader tab, click Load.
- For the CSV File, click Choose and select the CSV input file.
- In the Object Type picklist, select Documents.
- In the Action Type picklist, select Create or Update.
- Optional: Select the Document Migration Mode checkbox to allow creation of Documents, Document Versions, Document Renditions, or Documents, Versions, Roles in any state or state type. This also allows you to set the name, document number, and version number in your CSV input file.
- Optional: Select the Include updated field values in the output log for verification checkbox to include supported VQL fields in the output logs. VQL query validation will impact performance. Vault does not support this option when archiving documents.
- Optional: Click Map Fields to access the field mapping grid.
- Click Start Load.
Vault begins processing the request. When finished, you’ll receive a Vault notification and email with request details and CSV output files.
Note: Because Vault re-indexes documents asynchronously, using Include updated field values in the output log for verification when creating and updating documents with Vault Loader may not include the updated field values in the output log.
With field mapping, you can choose to map specific fields of the selected object type you wish to load to the columns in your CSV input file. For example, you can map the
therapeutic_area__v field name to the Therapeutic Area CSV column when creating an Product object record.
To map fields:
- After selecting your CSV file, select Documents from the Object drop-down list.
- In the Action Type drop-down, select Create, Update, Upsert, or Delete.
- In the Key Field drop-down, select any unique fields from the selected object. This option is only required for the Delete, Upsert, and Update actions.
- Click the Map Fields button to access the field mapping grid. You can also load previously saved mapping by clicking the Map Fields drop-down button and selecting Load Saved Mapping.
- Optional: Apply any additional column filters.
- Optional: Click Clear Fields to clear all existing column mappings.
- Optional: Click Automap to enable Vault to automatically map CSV columns to the object columns based on either the matching object label or name.
- Optional: Use the Search box to search for a specific object column.
- In the CSV Column, select a column name from the applicable drop-down list to map to the desired object field or label. You can enter a page number above the field mapping grid to jump to a specific page, or use the navigation arrows.
- Click Save Mapping to save your current column mappings.
- Click Start Load.
Since Vault requires certain fields to be in a specific format, Loader uses auto-formatting to convert field values to Vault’s standard format before completing a load. Loader uses auto-formatting for the following field types:
- Loader ensures that all boolean field values are either True or False prior to loading.
- When mapping data to a picklist, Loader uses the picklist name, for example,
family__c, for lookup prior to loading. If you don’t provide the name for the picklist, Loader can also use the picklist label, for example, Family, for lookup.
- Vault uses yellow highlighting for required CSV columns
- The drop-down lists in the CSV column displays (no mapping) for available columns of the CSV
- Select (no mapping) to un-map a previously mapped column
- Already mapped fields are unavailable in the CSV column drop-down until they are un-mapped
Preparing the CSV Input File
Document fields vary between Vaults and between document types. The following list includes the fields that are required, as well as several sample fields that cover the different field types. Some of these fields won’t apply when creating unclassified documents. We recommend using Loader to extract column headers and basing your CSV input on that file. You can only add relationships through multi-value relationship fields using ID values or through a lookup based on a unique field.
name__v is not a unique field. When uploading a document with a multi-value field, input the values as a comma-separated list without spaces between values.
Note: You must use UTF-8 encoding in your CSV file to create or update documents using Vault Loader.
Note: You can use the document external ID in an input file to create relationships for both source and target documents. To use the document external ID as a lookup, you must only provide the external ID and exclude the
|Column Header||Field||Example Value||Notes|
||ID||486||Required for update actions. This is the internal ID number of the document. You can find ID values by extracting existing documents with Vault Loader.|
||Document Name||Spring 2017 Flyer||Required unless the document type uses auto-naming; in this situation, providing a value overwrites the default value.|
||Subtype||Promotional||Required if there are subtypes for the selected document type.|
||Classification||Patient Education||Required if there are classifications for the selected subtype.|
||Document Lifecycle||Material Review||Required.|
||Major Version Number||1||Required if you’re creating multiple document versions; this would be “1” in “v1.3”. You cannot use this to update past versions of a document. Only the newest version of a document is editable via Vault Loader.|
||Minor Version Number||3||Required if you’re creating document versions; this would be “3” in “v1.3”. You cannot use this to update past versions of a document. Only the newest version of a document is editable via Vault Loader.|
||Source File||2017-flyer.pdf||References a file on the FTP server. In this situation, the file is in the root directory, but you may also create sub-directories and place the files there. File references must include the file extension, for example, “2017-flyer.pdf”.|
||Product||00P000000000101||References an object record using the document field name (
||Campaign > Name||Rise Above||References an object record using the document field name (
||Country > External ID||US120||References an object record using the document field name (
||Audience (picklist)||Patient,Pharmacist||References a picklist option or options using the UI label.|
||CLM Content||false||Indicates “No” for a Yes/No type field.|
||Publish Date (date)||2017-12-03||Populates a date field. Dates must use the YYYY-MM-DD format.|
Example Inputs for Creating Documents
You can create the following types of documents:
- Create documents from uploaded files. Download example input.
- Create documents from templates. Download example input.
- Create content placeholder documents. See example input.
- Create unclassified documents. See example input.
In addition to the standard Vault Loader permissions, your security profile must include the Application: All Documents: All Document Actions permission in order to create documents using Vault Loader.