Establishing a Connection
Configure a Connection Profile
From the CData ribbon, click Get Data and select From Veeva Vault connection/s to launch the CData Query window. To setup a new connection, you will have to click the New Veeva Vault Connection button. Here you can set the connection settings, test the connection, and save the connection profile.
Connecting to Veeva Vault
In order to connect to your Veeva Vault account, you first need to set the RSBVeevaVault_p_URL connection property to the host you see in the address bar after logging in to your account.
For example: https://myvault.veevavault.com.
Authenticating to Veeva Vault
The add-in supports the following authentication methods:
- Veeva Vault user credentials
- OpenID Connect with the Azure AD Authentication Provider
- Okta SSO
User Credentials
Set the AuthScheme to Basic and set the User and Password to your user login credentials.
OpenID with AzureAD
OpenID Connect with Azure AD is a connection type that goes through OAuth. Set the AuthScheme to AzureAD. The following sections assume that you have done so.Desktop Applications
Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom AzureAD App.
Get an OAuth Access Token
You are ready to connect after setting one of the groups of connection properties below:
- Authenticating using a Client Secret
- OAuthClientId: Set this to the Client Id in your app settings.
- OAuthClientSecret: Set this to the Client Secret in your app settings.
- CallbackURL: Set this to the Redirect URL in your app settings. .
- Optionally, depending on the required claims to complete the authentication with the Veeva Vault data source, you may need to set additional scopes via the Scope property. For example, to get the user name and email claims from the UserInfo endpoint, you will need to set the scope value to: 'openid profile email offline_access'.
- Authenticating using a Certificate
- OAuthClientId: Set this to the Client Id in your app settings.
- OAuthJWTCert: Set this to the JWT Certificate store.
- OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.
- CallbackURL: Set this to the Redirect URL in your app settings. .
- Optionally, depending on the required claims to complete the authentication with the Veeva Vault data source, you may need to set additional scopes via the Scope property. For example, to get the user name and email claims from the UserInfo endpoint, you will need to set the scope value to: 'openid profile email offline_access'.
When you connect, the add-in opens the OAuth endpoint in your default browser. Log in and grant permissions to the application.
Okta
The add-in supports the Okta SAML 2.0 flow. Before you can authenticate via Okta SSO, you must configure your Veeva Vault and Okta instances as described in Veeva Vault's Okta SSO guide.
After following those steps, set the following to connect:
- AuthScheme: OKTA
- User: the username of the Okta account to use for Okta SSO.
- Password: the password of the Okta account to use for Okta SSO.
- SSOLoginURL: the "Identify Provider Login URL" associated with your Veeva Vault single sign-on profile. This is the value you copied from "Identity Provider Login URL" in the View Setup Instructions screen from the "Veeva Vault" app integration menu in Okta (step 8 in the linked Veeva Vault Okta SSO guide above).
- This should look like: https://dev-XXXXXXXXX.okta.com/app/veeva_vault/XXXXXXXXXXXXXXX/sso/saml
- SSOExchangeUrl: the "Vault SSO Login URL" associated with your Veeva Vault single sign-on profile. After you have created a single sign-on profile in Veeva Vault (step 12 in the linked Veeva Vault Okta SSO guide above), you can find this in Veeva Vault by navigating to Admin > Settings > SAML Profiles > (click your SAML profile's label) > SAML Single Sign-on Configuration.
- This should look like: https://login.veevavault.com/auth/saml/consumer/_XXXXXXXXXXXXXXXX
Connection Properties
The Connection properties describe the various options that can be used to establish a connection.
Managing Connections
After successfully authenticating to Veeva Vault you will be able to customize the data you are importing. To learn more about this, see Managing Connections.
See Also
- Querying Data: Use the data selection wizard to pull data into a spreadsheet. You can also configure scheduled data refresh here.
- Using the Excel Add-In: Find other ways to interact with Veeva Vault data, such as using the available CData Excel Functions.