Vault CRM Bridge setup

Before you create a Vault CRM bridge, complete the following tasks:

  • System - Create a system in Network for Vault CRM.

    For details, see Adding systems.

  • Credentials - Vault credentials are required to connect Network to Vault CRM. Ensure the credentials are saved in Network (Settings > External Credentials) before you begin.

    For details, see Add Vault credentials.

    Network credentials must also be saved in Vault CRM. For details, see Vault CRM Help: Administrative Tools.

  • Network - Vault CRM configuration - The integration steps between Network and Vault CRM must be completed.

    See the Vault CRM Help: Configuring Network Integration topics.

    This includes managing Network mappings for objects, fields, and references.

  • Target subscription - Create the target subscription that will be used to export data to Vault CRM.

Configure the target subscription

Before you create a Network Bridge, define the target subscription configuration that you'll use for the bridge. There are a few recommended settings for subscriptions that are used to export data to Vault CRM.

To create the target subscription:

  1. In the Admin console, click System Interfaces > Target Subscriptions.

  2. Click Add Subscription.

    Configure the settings in each section.

  3. Details - Define the following settings:

    • Name - Type a relevant name for the subscription.

    • Type - Choose Data.

    • System - Expand the list and choose the Vault CRM system that you will export the data to.

      If you haven't defined a system yet, go to System Interfaces > Systems and create the system.

    • Description - Type a meaningful description for this subscription.

  4. General Export - These setting values are recommended for target subscriptions for Vault CRM bridges.

    Targeted Record Options

    • Full Data Extract - Choose Delta to export only the changes that occurred since the subscription last ran.

    • Record Type - Choose Non-Candidate to export all records except for candidate records.

    • Record State - Choose All so records with all record states are exported.

    • Export Only Updated Sub-Objects - Do not select this setting. All sub-objects should be exported in this subscription.

  5. Hierarchy - Determine the related entities to export.

    • Level of Hierarchy to Export - By default, one level of parent will be exported to ensure that relationships are intact.

    • Apply "Export Options" to the target records related entities - Choose this option if you want to filter the related entities that are exported based on any filters that you apply in the Export Options section below.

  6. Reference Data - Do not select Include Reference Data Files. It is not required for Vault CRM Bridge subscriptions.

  7. File Format - Do not change the default values in this section. Vault CRM expects target subscriptions to be comma delimited and to have a header row.

    Format - The format of the export file. This is set to CSV by default.

    Encoding - The encoding for the export. This is set to UTF-8 by default.

    The following options help exported files to comply with Vault CRM's file acceptance format.

    Delimiter- The character used to separate values in the exported .csv file. Choose comma (,).

    Text Qualifier - The character to identify the beginning and end of text. Choose double quotes (").

    Include header row? - Ensure that this is selected so the .csv file contains a header row.

    Export File Format - Defines how the file is exported. Choose Compressed single file (default). This means that one compressed file will be exported and it will contain .csv file for each object.

    Compression Format - Choose the Zip (zip) compression format. The target subscription will export one .zip file which will contain a .csv file for each object.

    Export File/ Folder Name - Choose one of the following options:

    • Default - The file exported with the following naming convention: exp_########.
    • Include Name and Timestamp - The file is exported with the following naming convention: <subscription name>_YYMMDDTHHMMSSSSS; for example, CRM_Target_170113T191503397.
    • Static Name - Do not choose this option. This exports the file with the same name, so the file and folder will be overridden each time the job runs.

  8. Export Locations - Choose to save the exported file in the following locations:

    • Default - The default path is outbound/<system_name>.

    • Custom - Define a custom path.

      Administrators can give users specific access to FTP folders, so identifying a custom path for this subscription enables you to protect the data. For more information about identifying FTP folder access for users, see Add a user profile. Custom paths are not validated, so ensure that they are correct so your job does not fail.

      For information about accessing the files in your Network file system, see File Explorer.

    • Export to Cloud Storage - Export the data directly to your private cloud storage. Exporting to Amazon S3 buckets are supported.

      The Amazon S3 bucket must be created with write access so you can export the files. For more information, see Exporting data to cloud storage.

  9. File & Field Selection - Accept the Select Which Objects and Fields to Export default value.

    All the enabled objects in your Network instance display.

    • Veeva standard objects (HCO, HCP, Address, License, Parent HCO) - Accept the Export All Fields default value.

    • Custom Key - Accept the Export All Fields default value. Custom keys filtered by the defined Vault CRM source system should be included in the target subscription.

    • All other objects (custom objects and Network widget objects) - Choose the level of export.

      Custom objects and Network widget objects (Affiliation and Account Link) are not supported for the Network Bridge integration with Vault CRM but they do not impact the Bridge subscription job. They can be included in the target subscription if you plan to use the same file that is generated for the Network Bridge for another purpose; for example, to load custom object data through a Veeva Connector.

  10. Export Options - Filter the objects to export.

    Note: A primary country filter does not need to be configured. Vault CRM bridges are multi-country bridges by default. When the target subscription job runs, a primary country filter is automatically applied based on the country of the bridge job executing the target subscription.

    A target subscription for a Vault CRM Bridge will have the following filter groups defined for HCOs and HCPs:

    • Group 1

      • Field - Source System

      • Condition - Contains

      • Value - The Vault CRM system

    • Group 2

      • Field - Defined Query

      • Value: send_to_crm__c:in:Y

        This query means that the record will be exported if the send to CRM flag is set to Y.

  11. Transformation Rules - Displays any rules that you have applied to this subscription.

    For example, create rules to remove specific address types from Vault CRM.

    For more information, see Transformation rules.

  12. Transformation Queries - Displays any queries that you have applied to this subscription.

    For more information, see Transforming outbound data.

    Note: Do not use transformation queries to filter relationships or addresses for Vault CRM using the Bridge. The Vault CRM Bridge does not just use exported files, it also involves other processes (data change requests, Network Account Search, direct downloads through the API, and so on) that do not use transformation queries.

  13. In the Job Trigger Configuration section, accept the Manual option to run the subscription. The schedule for the subscription will be set in the Vault CRM Bridge configuration.

  14. Save your changes.

The target subscription is available and can be applied to the Vault CRM Bridge configuration.

Next step

When the prerequisite tasks are complete, the Vault CRM Bridge can be created.