Syncing Metadata Between Vault and CRM

Admins can create and maintain records in both Vault and CRM using the CRM Vault Metadata Sync feature, eliminating the need to manually update records between CRM and Vault.

Object lifecycles in Vault create additional Vault fields that cannot be mapped to CRM. Do not associate any object lifecycle with the following objects:

  • CRM Content Type
  • CRM Detail Group
  • CRM Product
  • CRM Product Group
  • Directory
  • Event Configuration
  • Event Topic
  • Survey

This integration supports custom field mapping, CRM WHERE clauses, and can be scheduled to run using the CRM Process Scheduler.

For example, a CRM admin adds Cholecap to the Product Catalog, then syncs the CRM org with Vault from the CRM Vault Metadata Sync page. The content creator in Vault is now able to select Cholecap 10mg from the Approved Email Vault using the new CRM Product Field. Because a CRM Product field is selected in Vault, the Approved Email integration uses the CRM Product, associating Cholecap 10mg with the appropriate Approved Email in both Vault and CRM.

Metadata sync works in CLM and Events Management.

Preparing the Vault Metadata Sync

Setting Up the CRM Connection

To configure a CRM connection for sync:

  1. Navigate to the CRM Vault Metadata Sync tab.
  2. Select Edit from the Veeva CRM Connection Management section.
  3. Enter the username and password of the CRM Integration user.
  4. Indicate whether this is a Sandbox org.
  5. Select Save.
  6. Select Validate to confirm the credentials are correct.

Setting Up the Vault Connection

To configure a Vault connection for sync:

  1. Navigate to the CRM Vault Metadata Sync tab.
  2. Select New or Edit in the Vault Connection Management section. This integration supports syncing metadata from one CRM org to multiple Vaults.
  3. Enter the Vault Name.
  4. Enter the Vault URL.
  5. Enter the username and password of the integration user.
  6. Select one or more check boxes to indicate which data to sync:

    • Product Sync – Syncs the Detail Product, Detail Groups, and Detail Topics in your CRM Product Catalog
    • Survey Sync – Syncs all CRM surveys that are not expired and channel = CLM or Approved Email
    • Directory Sync – Syncs all CRM directories
    • Content Type Syncs – Syncs the Content Type for Approved Email
    • Content Group Syncs – Syncs the Content Groups for Approved Email and CLM
    • Event Configuration Sync – Syncs active Event configurations. This option has no associated WHERE clause.
    • Event Topic Sync – Syncs active Event Topics. Admins can define an optional WHERE clause to specify which Event Topic metadata syncs with Vault.

      Only Event Topics linked to a Detail Product or a Detail Topic Product can be synced via this integration.

  7. Add a WHERE clause for each sync to filter out specific items. This step is optional.
  8. Select Save to save the information.
  9. Select Validate to validate the credentials and WHERE clauses.

The CRM Vault Metadata Sync feature does not support pushing of metadata from Sandbox CRM Orgs to Production Vaults. Sandbox CRM Orgs can only be used with Sandbox/Test/Demo Vaults, and Production CRM Orgs support all Vault domain types.

Syncing Data Between CRM and Vault

Two kinds of sync are available, based on when the connection with Vault was established: the initial full refresh sync and incremental sync.

Sync successes and failures can be downloaded in the Metadata Sync History section of the CRM Vault Metadata Sync tab.

Initial Full Refresh Sync

When the connection between Vault and CRM is initially established, a Full Refresh automatically initiates the following actions:

  • If a CRM_Org__v record does not exist in Vault corresponding to the CRM org, one is created
  • All active records configured to be synced are created in Vault as new records based on the mapped fields

Incremental Sync

On subsequent syncs with Vault, the following process is performed:

  • All active synced records are checked for matches to records in Vault based on the VExternal_Id_vod field
  • If a match exists, the record in Vault is updated based on the values in CRM
  • If a match is not found, a new record is created in Vault
  • Newly inactive or deleted records are marked as inactive in Vault

Incremental syncs can be scheduled hourly via the Veeva Process Scheduler.

Mapping Vault Data to CRM

Administrators can use the CRM Product and CRM Detail Group fields within Vault to map a product record from Veeva CRM directly to a Vault CRM Products field.

After a successful sync of the CRM Vault Metadata, select Compare Map in the CLM, Approved Email or Events Management admin pages. The mapping is updated to show a Primary and a secondary mapping, where the VExternal_Id_vod field in the CRM Product_vod object now maps to the external ID of crm_product__v field in the crm_product__v object and crm_detail_group__v field in the crm_detail_group__v object in Vault.

The following Veeva CRM records map to the appropriate primary Vault fields:

CLM Administration Console



Detail Group


CLM Presentation

Key Message

Approved Email

Administration Console



Detail Group


Email Template

Email Fragment

Engage Metadata Sync

Administration Console



Detail Group


Multichannel Content

Multichannel Content Asset

If the CRM Product and CRM Detail Group fields are not enabled or are null on the document field, the integration syncs the appropriate records from the secondary Vault product__v and detail_group__v fields. The product__v and detail_group__v fields are standard Vault fields. The integrations prioritize CRM Products and CRM Detail Groups when both CRM Product and Product or CRM Detail Group and Detail Group fields are populated. This means existing content does not have to be updated with CRM Products to use this feature. CRM Product can be used for only new content.

Mapping does not change for Surveys, Directories, or Content Types, and is still matched based on the external ID of those records in their existing objects.

Troubleshooting and Tips

A few tips on metadata:

  • Media associated with Key Messages that are not marked active are not displayed
  • For media, the Display Order field on Key Messages is ignored. This field is used to determine the order textual (as opposed to CLM) Key Messages display on the Call Report in the Key Messages section.
  • You can delete a Key Message or mark it inactive to remove a piece of media. Once users have saved calls with a piece of media, you can only mark it as inactive as the system uses that Key Message to properly display information about the call.
  • It is best practice to delete all CLM Presentation Slide Records which are associated to an inactive Key Message
  • A media file can be in multiple presentations – this allows updating a piece of content once, and have the changes reflected in multiple presentations
  • If the Description_vod or the CLM_ID_vod are not filled in, on upload, the system will automatically populate the Description with the Media File Name and the CLM ID with CLM ID. Populating the Presentation ID field on each presentation is recommended, as it makes the data much easier to move between testing and production
  • If you forget to upload the media for a Key Message but include it as a presentation slide, the entire presentation is hidden to prevent accidental display of partial presentations. The entire presentation is also hidden if a user does not have access to one of the Key Messages inside the presentation.

Mapping Vault Object Reference Fields

Administrators can map custom fields in CRM to custom object reference fields in connected instanced of Vault. This enables users to filter synced CRM records by more than one org.

For example, Verteo Biopharma has multiple CRM orgs connected to one global Vault. Alice Adams is an admin who wants to display Cholecap only in orgs corresponding to the US market. She modifies the mapping in the appropriate orgs to display Cholecap.

To enable filtering by product, an admin must establish a link between CRM fields and Vault via the CRM Vault Metadata Sync administration page.

To create the mapping:

  1. Select the CRM Vault Metadata Sync Administration tab.
  2. Select View Map in the Vault Connection Management section.
  3. Select Edit Mapping.
  4. Select Show All for Vault Fields.
  5. Select the appropriate field from the drop-down on the referenced Vault object.
  6. Select the appropriate field from the drop-down for CRM API Name.

The following CRM and Vault Field Types are supported:

Field values must be an exact match to populate the object reference field.

CRM Field Type

Vault Field Type


  • Text
  • Picklist
  • Multipicklist

Text Area

  • Text
  • Picklist
  • Multipicklist


  • Boolean


  • Number


  • Text
  • Picklist
  • Multipicklist


  • Text
  • Multipicklist


  • Text