Skip to main content
Feedback

Veeva connection

The Veeva connection represents a single Veeva Vault instance in your domain. The connector obtains a session and cache it to reuse it in subsequent executions.

Connection tab

Authentication Type - Select either User Credentials or OAuth 2.0 to authenticate your Veeva account. The default value is User Credentials.

User Credentials

  • If the Vault Authentication API burst limit is exceeded while requesting the Session ID, the connector waits 60 seconds before retrying once when you use the User Credentials authentication type.

Vault Subdomain/DNS - Enter the URL of your Vault instance. The default value is: {vault_subdomain}.veevavault.com. See the Veeva Developer Docs to learn more.

note

The Veeva Developer Docs use the terms Vault DNS and Vault Subdomain interchangeably. While using this connector, Boomi advises you to use the same input for both Vault DNS and Vault Subdomain to avoid issues.

API Version - The default Veeva REST API API version. The current version is v23.3, the current GA version.

User - Enter your Vault user name.

Password - Enter your Vault user password.

Session timeout (minutes)- Enter the Session Duration (in minutes) configured in your Vault by your Vault admin. This value must be at least 10 minutes and no longer than 480 minutes."

Client ID (Optional) - Enter your header name if any. If you input a value, it will be concatenated after Boomi_. This value is trimmed before being used in the X-VaultAPI-ClientID header.

note

The following restrictions apply to Client ID: A valid client ID must be an alphanumeric string with a maximum of 100 characters. A Client ID can be mixed-case and the only special characters allowed are periods, underscores, and hyphens. If an API request includes an invalid Client ID, the value will appear as invalid_client_id in the API Usage Log.

OAuth2.0/Open ID Connect profile ID - The ID of your Veeva Vault OAuth2.0 / Open ID Connect profile.

Authorization Server Client Application ID (Optional) - The ID of the client application at the external Authorization Server Provider.

OAuth 2.0

Veeva requires you to use an external Authorization Server Provider, for more information see the resource Configuring OAuth 2.0 / OpenID Connect Profiles.

The following fields are displayed when you select OAuth 2.0 to authenticate your Veeva session.

Client ID - The external authorization service client application ID.

Client Secret - The external authorization service client application secret.

Authorization Token URL - The external Authorization Server Authorization Token URL.

Scope - The external authorization service client application scope. The default is openid offline_access.

Access Token URL - The external Authorization Server Access Token URLs.

Access Token -The encrypted access token retrieved from the external Authentication Server to access protected resources. Click to generate the access and refresh tokens. When a new window opens asking you to confirm offline access, click Accept. A second message indicates the access token was received and successfully generated.

Test Connection

You can test your connection settings before you use or save the connection in a process. The Test Connection ensures that your specified settings are correct, valid, and accessible. If the test connection is successful, you can save the connection. Otherwise, review and correct any incorrect settings, then test again.

Attention

You can only run the Test Connection against containers associated with your account (local runtimes, runtime clusters, and runtime clouds).

URL logging

Every time the connector executes a request to the service, the URL is logged. The table below details where the logs for different executions are stored.

Requests executionLogger
OperationsDocument
Test ConnectionContainer
BrowserDocument
RetriesContainer

The following is an example of a log stored in the container for Authentication requests.

Jan 21, 2025 10:31:27 AM ART INFO    [com.boomi.connector.veeva.VeevaConnection testConnection] GET : https://example.veevavault.com/api/v23.3/metadata/vobjects

The runtime prints buffered debug messages whenever a log message at the WARNING level or higher is written by default. See the topic Changing the default for logging debug messages to change this setting; You must have the Runtime Management privilege to perform this task.

On this Page