Vault Loader allows you to bulk create and delete document relationships in your Vault. Note that you cannot create or delete standard relationship types. Examples of standard relationship types include Based On, Original Source, and Attachments.
How to Load Document Relationships
Before loading document relationships, prepare the CSV input file containing field names and values.
To create or update document relationships:
- 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 Relationships.
- In the Action Type picklist, select Create or Delete.
- Click Start Load.
Before processing the request, Vault validates the selected CSV file. If the file is valid, Vault begins processing the request. When finished, you’ll receive a Vault notification and email with request details and CSV output files.
The fields you include in your CSV will depend on your Create or Delete action. If you aren’t sure where to begin, see the example CSV inputs below.
|Column Header||Example Value||Notes|
|id||23||The id of the document relationship. This is required for deleting relationships.|
|source_doc_id__v||17||Required for creating document relationships between the source and target documents.|
|source_major_version__v||2||The major version number of the source document. This only applies when the target document is bound to a specific version of the source document.|
|source_minor_version__v||1||The minor version number of the source document. This only applies when the target document is bound to a specific version of the source document.|
|target_doc_id__v||22||The document id field of the target document which is bound to the source document. This is required for creating document relationships between the source and target documents.|
|target_major_version__v||1||The major version number of the target document. This only applies when the source document is bound to a specific version of the target document.|
|target_minor_version__v||3||The minor version number of the target document. This only applies when the source document is bound to a specific version of the target document.|
|relationship_type__v||supporting_documents__c||The relationship type (supporting documents, related claims, related materials, etc.). This action only supports custom relationships.|
Note: You can use the
target__vr.external_id__v fields instead of the
target_doc_id__v fields when creating a document relationship.
This action supports the following custom relationship types:
- Licence Files
- Patient Labeling
- Product Labeling
- Related Documents
- Related Materials
- Supporting Documents
Note that your organization may have worked with Veeva Services to create additional custom relationship types for your Vault.
- Create document relationships
- Create source version-specific relationships
- Create target version-specific relationships
Before beginning the Vault Loader job to create or delete document relationships, Vault checks that the selected CSV file meets certain criteria:
- Is not empty
- Does not contain empty columns
- Includes a valid header row (Invalid header rows are those with no columns that match to metadata for the records you’re loading.)
If your file is not valid, Vault displays a notification, stops the process, and allows you to select a new CSV file. If some of the header columns do not match metadata for your Vault, the notification will allow you to stop the load or ignore those columns and proceed.