| Field | Description |
|---|---|
Name | Configuration name |
Vault URL | URL of the Veeva Vault instance required for the connection |
Username | Username used to initialize the session |
Password | Password used to authenticate the user |
Client Id | Client ID to send with each request header to the Veeva Vault instance for tracking purposes, in the format The client ID has the prefix |
| Field | Description |
|---|---|
Response Timeout | Maximum amount of time, in milliseconds, that the connector waits for the Veeva Vault response. If the maximum amount of time is exceeded, a timeout exception is thrown. The default is 30,000 milliseconds (30 seconds). |
Burst API Limit Profile | Burst API limit profile configuration to act upon if the specified burst API limit of the Veeva Vault API reaches or exceeds the configured threshold. If Burst API limit config is enabled (default), then the connector evaluates the Veeva Vault API’s response header ( The following example shows an application log with a warning message at WARN 2019-06-06 10:34:45,096 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Burst API Limit remaining calls [1997] has exceeded/reached an API Limit Profile threshold set as [1997]. As per API Limit Profile, Veeva Vault Connector will wait for [5] MINUTES. WARN 2019-06-06 10:39:45,098 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.operations.VeevaVaultOperations: Properties or Fields is not available for api [/api/v18.2/metadata/objects/documents/types/site_management__c] , will use input list [[name__v, type__v, subtype__v, classification__v, lifecycle__v, status__v, study__v, product__v, id]] if configured to build VQL query INFO 2019-06-06 10:39:45,098 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.pagination.GetDocumentsPagingProvider: Query Build :: SELECT name__v, type__v, subtype__v, classification__v, lifecycle__v, status__v, study__v, product__v, id FROM documents WHERE name__v= 'F22611234--6764' INFO 2019-06-06 10:39:46,024 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Response received for sync http request :: 'https://[vault-domain]/api/v18.2/query?q=SELECT+name__v%2C+type__v%2C+subtype__v%2C+classification__v%2C+lifecycle__v%2C+status__v%2C+study__v%2C+product__v%2C+id+FROM+documents+WHERE+name__v%3D+%27F22611234--6764%27++LIMIT+1000+OFFSET+0' in 925 milliseconds. |
API Limit Threshold | Veeva Vault API limit threshold for Burst API
Limit Profile. When the specified limit is reached or exceeded, the connector waits for the
specified amount of time. The default is
|
Wait Time | Amount of time that the connector waits if the API
Limit Threshold is reached or exceeded. The default is
|
Time Unit | Time unit for the wait time. The default is
|
Daily API Limit Profile | Daily API limit exceed profile configuration to use if the
daily API limit of the Veeva Vault API reaches or exceeds the configured threshold. The daily limit
is the total number of API calls within any 24-hour window. The following
example shows an application log with a warning message at WARN 2019-06-06
10:47:31,698 [[MuleRuntime].io.44: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING
@108e7f43] [event: 624cfa50-881a-11e9-90e2-d61515f42856]
org.mule.extension.veevavault.internal.service.HttpRequestService: Veeva Daily API Limit remaining
calls [10000] has exceeded/reached an Daily API Limit Profile threshold set as [10000]. As per API
Limit Profile, Veeva Vault Connector will throw an exception.
ERROR 2019-06-06 10:47:31,699 [[MuleRuntime].io.44:
[veevavault-connector-demo].get-documents-operationFlow.BLOCKING @108e7f43] [event:
624cfa50-881a-11e9-90e2-d61515f42856]
org.mule.extension.veevavault.internal.service.HttpRequestService: Exception caught while processing
Sync request ::: https://xxxxx-xxxxx.veevavault.com/api/v20.1/metadata/vobjects/site__v, Exception
::: \{"responseStatus":"FAILURE","errors":[\{"type":"API_LIMIT_EXCEED","message":"The Veeva Vault
Connector has reached/exceeded daily API limit remaining calls [10000]. The configured daily api
limit threshold is \(10000\)"}\]}
ERROR 2019-06-06 10:47:31,767 [[MuleRuntime].io.44:
[veevavault-connector-demo].get-documents-operationFlow.BLOCKING @108e7f43] [event:
624cfa50-881a-11e9-90e2-d61515f42856]
org.mule.runtime.core.internal.exception.OnErrorPropagateHandler:
---
Message : An error occurred from the Veeva Vault API. Error Code: API_LIMIT_EXCEED. Original Error
Message: The Veeva Vault Connector has reached/exceeded daily API limit remaining calls [10000]. The
configured daily api limit threshold is (10000). Error type : VEEVAVAULT:API_LIMIT_EXCEED
********************************************************************************** |
API Limit Threshold | Veeva Vault API limit threshold for Daily
API Limit Profile. When the specified limit is reached or exceeded, the connector waits for
the specified amount of time. The default is
|
| Field | Description |
|---|---|
Name | Configuration name |
Vault URL | Veeva Vault instance URL required for connection. |
Version | Version for the Veeva Vault instance required. |
Client Id | Client ID required to send with each request header to the Vault instance. |
OIDC Profile ID | OIDC profile ID generated by Veeva when creating a new OIDC profile. To configure the OIDC profile ID, use the ID in your OIDC profile in Veeva. Your OIDC profile contains a Vault Session ID URL, for example, |
Consumer Key | OAuth consumer key, as registered with the service provider. This is your IdP client ID, assuming you already have a client application registration created at the ID provider of your choice, for example, PoneOne or PingFederate. |
Consumer Secret | OAuth consumer secret, as registered with the service provider. This is your IdP client secret, assuming you already have a client application registration created at the ID provider of your choice, for example, PoneOne or PingFederate. |
Authorization Url | OAuth 2.0 authorization URL, such as |
Access Token Url | OAuth 2.0 token URL, such as |
Scopes | You can set up your OAuth 2.0 scopes as necessary, but the important ones |
Resource Owner Id | Depending on your IdP configuration, you can leave it blank. |
Listener Config | Create a new HTTP Listener or use an existing one if you have one, for example, |
Callback Path | Callback path of your application. If you set it to |
Authorize Path | Authorize path. You will navigate to this path when starting the OAuth 2.0 dance, for example, |
External Callback Url | You can set this directly to |