Setting up the Openflow Connector for Veeva Vault¶

Enable Direct Data¶

Direct Data must be enabled on your Veeva Vault instance. This is a Vault-level feature that allows external systems to retrieve data exports via the Direct Data API.

To verify that Direct Data is enabled, your Vault administrator can check Admin » Settings » General Settings » Direct Data in the Veeva Vault UI.

For more information, see the Veeva Direct Data documentation (https://developer.veevavault.com/directdata/).

Create a service account¶

Create a dedicated Veeva Vault user account for the connector. This account must have:

• API access enabled.

• Sufficient permissions to access the Direct Data API endpoints.

• A security profile that allows the account to read the data objects you want to replicate.

Record the username and password for this service account. You will need these values when configuring the connector.

Create a Snowflake service user (Openflow BYOC only)¶

1. Create a service user:

   CopyExpand

   USE ROLE USERADMIN;
   CREATE USER <openflow_service_user>
     TYPE=SERVICE
     COMMENT='Service user for the Veeva Vault connector';
   

   Show lessSee more

   Scroll to top

2. Store the private key for that user in a file to supply to the connector’s configuration. For more information, see key-pair authentication.

   CopyExpand

   ALTER USER <openflow_service_user> SET RSA_PUBLIC_KEY = '<pubkey>';
   

   Show lessSee more

   Scroll to top

Create database, schema, and warehouse¶

1. Create the destination database:

   CopyExpand

   USE ROLE ACCOUNTADMIN;
   CREATE DATABASE IF NOT EXISTS <veeva_database>;
   

   Show lessSee more

   Scroll to top

2. Create the destination schema:

   CopyExpand

   CREATE SCHEMA IF NOT EXISTS <veeva_database>.<veeva_schema>;
   

   Show lessSee more

   Scroll to top

3. Create a role for the connector and grant the required privileges:

   CopyExpand

   CREATE ROLE IF NOT EXISTS <veeva_connector_role>;
   
   GRANT USAGE ON DATABASE <veeva_database> TO ROLE <veeva_connector_role>;
   GRANT USAGE ON SCHEMA <veeva_database>.<veeva_schema> TO ROLE <veeva_connector_role>;
   GRANT CREATE TABLE ON SCHEMA <veeva_database>.<veeva_schema> TO ROLE <veeva_connector_role>;
   

   Show lessSee more

   Scroll to top

4. Create a warehouse (or use an existing one) and grant usage privileges:

   CopyExpand

   CREATE WAREHOUSE IF NOT EXISTS <veeva_warehouse>
     WITH
       WAREHOUSE_SIZE = 'SMALL'
       AUTO_SUSPEND = 300
       AUTO_RESUME = TRUE;
   
   GRANT USAGE, OPERATE ON WAREHOUSE <veeva_warehouse> TO ROLE <veeva_connector_role>;
   

   Show lessSee more

   Scroll to top

5. If using Openflow - BYOC Deployments, assign the role to the service user:

   CopyExpand

   GRANT ROLE <veeva_connector_role> TO USER <openflow_service_user>;
   ALTER USER <openflow_service_user> SET DEFAULT_ROLE = <veeva_connector_role>;
   

   Show lessSee more

   Scroll to top

Create a network rule (Openflow Snowflake Deployments only)¶

To allow the connector to call the Veeva Vault API from a Snowflake-hosted runtime, create a network rule and an external access integration (EAI), and then grant the Snowflake role usage privileges on the EAI.

1. Create a network rule:

   CopyExpand

   USE ROLE ACCOUNTADMIN;
   
   CREATE OR REPLACE NETWORK RULE openflow_<runtime_name>_veeva_network_rule
     TYPE = HOST_PORT
     MODE = EGRESS
     VALUE_LIST = ('<your_vault_hostname>:443');
   

   Show lessSee more

   Scroll to top

2. Create an External Access Integration:

   CopyExpand

   CREATE OR REPLACE EXTERNAL ACCESS INTEGRATION openflow_<runtime_name>_veeva_eai
     ALLOWED_NETWORK_RULES = (openflow_<runtime_name>_veeva_network_rule)
     ENABLED = TRUE;
   

   Show lessSee more

   Scroll to top

3. Grant your Snowflake role USAGE on the integration:

   CopyExpand

   GRANT USAGE ON INTEGRATION openflow_<runtime_name>_veeva_eai
     TO ROLE openflow_runtime_role_<runtime_name>;
   

   Show lessSee more

   Scroll to top

Veeva Vault parameters¶

Snowflake destination parameters¶

Schema evolution parameters¶