| 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 |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name | String | Name for this configuration. Connectors reference the configuration with this name. | x | |
Connection | Connection types for this configuration. | x | ||
Expiration Policy | Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Response Timeout | Number | Maximum amount of time in milliseconds that the connector waits for the Veeva Vault response. If the time elapses, a Response Timeout exception is thrown. |
| |
Burst API Limit Profile | One of: | Burst API limit profile configuration in which the Veeva Vault burst API limit exceed is configured. It is enabled by default. | ||
Daily API Limit Profile | One of: | Daily API limit profile configuration in which the Veeva Vault daily API limit exceed is configured. It is enabled by default. | ||
Host | String | Host. | ||
Port | Number | Port. | ||
Username | String | Username to authenticate against the proxy server. | ||
Password | String | Password to authenticate against the proxy server. | ||
NTLM Domain | String | NTLM domain. | ||
Vault URL | String | Veeva Vault instance URL required for connection. | x | |
Version | String | Version for the Veeva Vault instance required. |
| |
Client Id | String | Client ID required to send with each request header to the Vault instance. | x | |
Username | String | Username for the Veeva Vault instance required for connection. | x | |
Password | String | Password for the Veeva Vault instance required for connection. | x | |
Reconnection | Configures a reconnection strategy to use when a connector operation fails to connect to an external server. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Response Timeout | Number | Maximum amount of time in milliseconds that the connector waits for the Veeva Vault response. If the time elapses, a Response Timeout exception is thrown. |
| |
Burst API Limit Profile | One of: | Burst API limit profile configuration in which the Veeva Vault burst API limit exceed is configured. It is enabled by default. | ||
Daily API Limit Profile | One of: | Daily API limit profile configuration in which the Veeva Vault daily API limit exceed is configured. It is enabled by default. | ||
Host | String | Host. | ||
Port | Number | Port. | ||
Username | String | Username to authenticate against the proxy server. | ||
Password | String | Password to authenticate against the proxy server. | ||
NTLM Domain | String | NTLM domain. | ||
Vault URL | String | Veeva Vault instance URL required for connection. | x | |
Version | String | Version for the Veeva Vault instance required. |
| |
Client Id | String | Client ID required to send with each request header to the Vault instance. | x | |
OIDC Profile ID | String | OIDC profile ID generated by Veeva when creating a new OIDC profile. | x | |
Reconnection | Configures a reconnection strategy to use when a connector operation fails to connect to an external server. | |||
Consumer Key | String | OAuth consumer key, as registered with the service provider. | x | |
Consumer Secret | String | OAuth consumer secret, as registered with the service provider. | x | |
Authorization Url | String | URL of the service provider’s authorization endpoint. |
| |
Access Token Url | String | URL of the service provider’s access token endpoint. |
| |
Scopes | String | OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation. |
| |
Resource Owner Id | String | Resource owner ID to use with the authorization code grant type. | ||
Before | String | Name of a flow to execute immediately before starting the OAuth dance. | ||
After | String | Name of a flow to execute immediately after receiving an access token. | ||
Listener Config | String | Configuration for the HTTP listener that listens for requests on the access token callback endpoint. | x | |
Callback Path | String | Path of the access token callback endpoint. | x | |
Authorize Path | String | Path of the local HTTP endpoint that triggers the OAuth dance. | x | |
External Callback Url | String | URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL. | ||
Object Store | String | Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Metadata Format | Enumeration, one of:
| Metadata format. | x | |
Document Metadata | Binary | Document metadata as an Input Stream. The payload must be in the format specified in the Metadata Format field. |
| |
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Metadata Format | Enumeration, one of:
| Metadata format. | x | |
Document Metadata | Binary | Document metadata as an Input Stream. The payload must be in the format specified in the Metadata Format field. |
| |
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Object Name | String | Object name. | x | |
Metadata Format | Enumeration, one of:
| Metadata format. | x | |
Object Metadata | Binary | Vault object metadata in CSV or JSON format as an Input Stream to create bulk object records on the vault. |
| |
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Metadata Format | Enumeration, one of:
| Metadata format. | x | |
Document Metadata | Binary | Document metadata in CSV OR JSON format as an Input Stream to delete multiple document renditions from the vault. |
| |
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Metadata Format | Enumeration, one of:
| Metadata format. | x | |
Document Metadata | Binary | Document metadata in CSV or JSON format as an Input Stream to delete single or multiple documents from the vault. |
| |
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Object Name | String | Object name. | x | |
Metadata Format | Enumeration, one of:
| Metadata format. | x | |
Object Metadata | Binary | Vault object metadata in CSV or JSON format as an Input Stream to create bulk object records on the vault. |
| |
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Metadata Format | Enumeration, one of:
| Metadata format. | x | |
Document Metadata | Binary | Document metadata in CSV or JSON format as an Input Stream to export documents from vault. |
| |
Source | Boolean | To exclude source files, set to |
| |
Renditions | Boolean | To include renditions, set to |
| |
All Versions | Boolean | To include all versions or the latest version, set to |
| |
Polling Interval | Number | Poll the vault at the specified interval, in seconds, until the job is successful. |
| |
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Audit Type | String | Audit type. | x | |
Start Date | String | Start date to retrieve audit information. This date cannot be more than 30 days ago. Dates must be of | ||
End Date | String | End date to retrieve audit information. This date cannot be more than 30 days ago. Dates must be of | ||
Fetch Size | Number | Number of limits or records per page. |
| |
Batch Size | Number | Number of pages per batch. |
| |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Array of Message of Binary payload and HTTP Response Attributes attributes |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Document Metadata | Binary | Document ID metadata in a JSON format payload, for example, |
| |
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Type | String | Document type to retrieve the type. | ||
SubType | String | Document subtype to retrieve the type. | ||
Classification | String | Document classification to retrieve the classification. | ||
Document Properties | Array of String | List of document properties to build a VQL query. | ||
WHERE Clause | String | WHERE clause that is appended to dynamically build a VQL query. | ||
Fetch Size | Number | Fetch size which limits the records per page. |
| |
Batch Size | Number | Batch size which accommodates the number of pages in a specified number of batches. |
| |
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Array of Message of Binary payload and HTTP Response Attributes attributes |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Object Name | String | Object name. | x | |
Object Fields | Array of String | Object fields list to include in the dynamic VQL query. | ||
WHERE Clause | String | WHERE clause. | ||
Fetch Size | Number | Number of limits or records per page. |
| |
Batch Size | Number | Number of pages per batch. |
| |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Array of Message of Binary payload and HTTP Response Attributes attributes |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Picklist Name | String | Picklist name. | ||
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Method | Enumeration, one of:
| HTTP method to send the request. |
| |
Path | String | Path in which the request is sent, for example, |
| |
Body | Any | Body of the request message. |
| |
Headers | Object | HTTP headers the message must include. | ||
URI Parameters | Object | URI parameters that are provided in the Path field. | ||
Query Parameters | Object | Query parameters the request must include. | ||
Request Streaming Mode | Enumeration, one of:
| Whether the request must be sent using streaming or not. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
VQL Query | String | VQL query required as per Veeva API documentation. | x | |
Input Parameters | Object | Input parameters in the format | ||
Fetch Size | Number | Number of limits or records per page. |
| |
Batch Size (DEPRECATED) | Number | Number of batches of Fetch Size elements to return. This field is deprecated. |
| |
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Array of Message of Binary payload and HTTP Response Attributes attributes |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Include Spark Headers | Boolean | Flag to include Spark headers received from the vault in the Spark validator output. |
| |
Public Key Path | String | Directory path to store the public key (00001.pem) file that is used to verify incoming Spark messages with a signature. Retrieved from the vault, if not specified. |
| |
Spark Headers | Object | Spark headers received from the vault and embedded in the Spark message. |
| |
Spark Message | Input Stream | Spark message body received from the vault. |
| |
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type | Object |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Resource Owner Id | String | ID of the resource owner for whom to invalidate access. |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Metadata Format | Enumeration, one of:
| Metadata format. | x | |
Document Metadata | Binary | Editable document metadata in CSV OR JSON format as an Input Stream to update single or multiple documents on the vault. |
| |
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type |
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration | String | Name of the configuration to use. | x | |
Object Name | String | Object name. | x | |
Metadata Format | Enumeration, one of:
| Metadata format. | x | |
Object Metadata | Binary | Vault object metadata in CSV or JSON format as an Input Stream to create bulk object records on the vault. |
| |
Output Mime Type | String | MIME type of the payload that this operation outputs. | ||
Output Encoding | String | Encoding of the payload that this operation outputs. | ||
Streaming Strategy |
| Configures how Mule processes streams. Repeatable streams are the default behavior. | ||
Target Variable | String | Name of the variable that stores the operation’s output. | ||
Target Value | String | Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
| |
Reconnection Strategy | Retry strategy in case of connectivity errors. |
Type | Binary |
Attributes Type |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Fails Deployment | Boolean | When the application is deployed, a connectivity test is performed on all connectors. If set to | ||
Reconnection Strategy | Reconnection strategy to use. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency | Number | How often to attempt to reconnect, in milliseconds. | ||
Count | Number | How many reconnection attempts the Mule app can make. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency | Number | How often to attempt to reconnect, in milliseconds. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Idle Time | Number | Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. | ||
Time Unit | Enumeration, one of:
| Time unit for the Max Idle Time field. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size | Number | Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value. | ||
Buffer Size Increment | Number | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a | ||
Max Buffer Size | Number | Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a | ||
Buffer Unit | Enumeration, one of:
| Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Size | Number | Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:
| ||
Buffer Unit | Enumeration, one of:
| Unit for the In Memory Size field. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size | Number | Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value. | ||
Buffer Size Increment | Number | This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a | ||
Max Buffer Size | Number | Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Objects | Number | Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. | ||
Buffer Unit | Enumeration, one of:
| Unit for the In Memory Size field. |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Status Code | Number | HTTP status code of the response. Former 'http.status'. | x | |
Reason Phrase | String | HTTP reason phrase of the response. Former 'http.reason'. | x | |
Headers | Object | Map of HTTP headers in the message. Former properties. | x |
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Api Limit | Number | Veeva Vault API threshold limit. When this threshold is reached or exceeded, the connector waits the specified time. |
| |
Wait Time | Number | Time the connector waits once the threshold value reaches or exceeds the remaining API calls. |
| |
Max Wait Unit | Enumeration, one of:
| Time unit for the Wait Time field. |
|
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Api Limit | Number | API limit threshold value to set the allowed daily limit for the number of API calls. Once the API limit threshold value is reached, the connector throws an |
|