--- schema_version: "1" id: d8c99df840a0a301e5da65b0297ee4fba4a6cdf694b6c64fbf39be841eac077f title: Veeva Vault Connector 1.5 Reference collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/veevavault-connector/latest/veevavault-connector-reference.md canonical_url: https://docs.mulesoft.com/veevavault-connector/latest/veevavault-connector-reference source_site: docs.mulesoft.com content_type: documentation content_hash: 4659414f4c14666b884846df74b5e975f23563b125a4bdc2061a2605cf24cf3a description: MuleSoft Documentation Site release: "1.5" latest: true --- --- product: Veeva Vault Connector version: 1.5 is-latest-version: true --- # Veeva Vault Connector 1.5 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt ## Configuration Default Configuration for Veeva Vault Connector.

Name	Type	Description	Required
Name	String	Name for this configuration. Connectors reference the configuration with this name.	x
Connection	Basic Connection OAuth 2.0 / Open ID Connection Provider	Connection types for this configuration.	x
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

### Basic Connection Uses basic connection for authorization.

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.	`30000`
Burst API Limit Profile	One of: Burst Api Limit Config Disable Burst Api Limit Config	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 Config Disable Daily Api Limit Config	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.	`v19.3`
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	Reconnection	Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

### OAuth 2.0 / Open ID Connection Provider Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). Authorizes against any OpenID provider and later exchanges the issued access token for a Veeva session ID. For more information on how to configure this connection type, refer to [OAuth 2.0 / Open ID Connection Provider](https://docs.mulesoft.com/veevavault-connector/latest/veevavault-connector-studio#oauth2-oidc-connection).

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.	`30000`
Burst API Limit Profile	One of: Burst Api Limit Config Disable Burst Api Limit Config	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 Config Disable Daily Api Limit Config	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.	`v19.3`
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	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.	`https://{IdentityProvider}/oauth2/v2.0/authorize`
Access Token Url	String	URL of the service provider’s access token endpoint.	`https://{IdentityProvider}/oauth2/v2.0/token`
Scopes	String	OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.	`openid` `offline_access`
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.

## Operations - [Create Document Renditions](#createDocumentRenditions) - [Create Documents](#createDocuments) - [Create Object Records](#createObjectRecords) - [Delete Document Renditions](#deleteDocumentRenditions) - [Delete Documents](#deleteDocuments) - [Delete Object Records](#deleteObjectRecords) - [Export Documents](#exportDocuments) - [Get Audit Details](#getAuditDetails) - [Get Document Renditions Types](#getDocumentRenditionsTypes) - [Get Documents](#getDocuments) - [Get Object Records](#getObjectRecords) - [Get Picklists](#getPicklists) - [Invoke REST API](#invokeRestApi) - [Query](#query) - [Spark Validator](#sparkMessageValidator) - [Unauthorize](#unauthorize) - [Update Documents](#updateDocuments) - [Update Object Records](#updateObjectRecords) ### Create Document Renditions `` Creates document renditions in bulk on Veeva Vault using document metadata provided in CSV or JSON format.

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Metadata Format	Enumeration, one of: CSV JSON	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.	`#[payload]`
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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	HTTP Response Attributes

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Metadata Format	Enumeration, one of: CSV JSON	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.	`#[payload]`
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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	HTTP Response Attributes

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: CSV JSON	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.	`#[payload]`
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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	HTTP Response Attributes

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Metadata Format	Enumeration, one of: CSV JSON	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.	`#[payload]`
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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	HTTP Response Attributes

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Metadata Format	Enumeration, one of: CSV JSON	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.	`#[payload]`
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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	HTTP Response Attributes

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: CSV JSON	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.	`#[payload]`
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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	HTTP Response Attributes

#### Associated Configurations - [Configuration](#config) #### Throws - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:INVALID\_KEY\_FORMAT - VEEVAVAULT:INVALID\_SESSION\_ID - VEEVAVAULT:EXECUTION - VEEVAVAULT:CLIENT\_PROTOCOL - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:RESPONSE\_TIMEOUT - VEEVAVAULT:IOEXCEPTION - VEEVAVAULT:PARAMETER\_REQUIRED - VEEVAVAULT:CONNECTIVITY - VEEVAVAULT:INVALID\_AUTH - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:USERNAME\_OR\_PASSWORD\_INCORRECT - VEEVAVAULT:RETRY\_EXHAUSTED - VEEVAVAULT:JSON\_EXCEPTION - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:INVALID\_SPARK\_MESSAGE - VEEVAVAULT:INVALID\_TOKEN - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:SESSION\_EXPIRED ### Export Documents `` Queries a set of documents to export to your vault’s FTP staging server. Use the **Export Documents** operation in a separate asynchronous flow by using Async Scope and passing the payload with document IDs. When used asynchronously, the **Export Documents** operation executes in separate flow thread and waits for the specified polling interval to poll the job status until it is successful while the main flow continues its process. The FTP staging area in the folder stores the exported documents, with the `{root}/{userId}/{jobId}/{documentIds}/{versions}` hierarchy structure. The following example shows the **Export Documents** operation returning job results as a response: \[ { "file": "/41601/249051/0\_1/TestDocument.docx", "user\_id\_\_v": 1885110, "id": 249051, "responseStatus": "SUCCESS", "minor\_version\_number\_\_v": 1, "major\_version\_number\_\_v": 0 }, { "file": "/41601/249050/0\_1/TestDocument.docx", "user\_id\_\_v": 1885110, "id": 249050, "responseStatus": "SUCCESS", "minor\_version\_number\_\_v": 1, "major\_version\_number\_\_v": 0 }, { "file": "/41601/249052/0\_1/TestDocument.docx", "user\_id\_\_v": 1885110, "id": 249052, "responseStatus": "SUCCESS", "minor\_version\_number\_\_v": 1, "major\_version\_number\_\_v": 0 } \] This example contains the following attributes: - `file` Uses the `"/{jobId}/{documentId}/{major-minor-version}/{filename}"` format, which is the absolute file path location on the Vault FTP server staging area. - `user_id__v` Vault system user ID of a user whose credentials are configured in the connector. The folder is created on the Vault FTP server staging area root location under where the exported file is located. The folder is created with the name of the user ID prefixed with the letter `u`, for example `/uXXXXXXX/{jobId}/{documentId}/{major-minor-version}/{filename}\)`. - `id` Document ID of the exported document file. - `major_version_number__v` Major version number of the exported document file. - `minor_version_number__v` Minor version number of the exported document file.

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Metadata Format	Enumeration, one of: CSV JSON	Metadata format.		x
Document Metadata	Binary	Document metadata in CSV or JSON format as an Input Stream to export documents from vault.	`#[payload]`
Source	Boolean	To exclude source files, set to `false`.	`true`
Renditions	Boolean	To include renditions, set to `true`.	`false`
All Versions	Boolean	To include all versions or the latest version, set to `true`.	`false`
Polling Interval	Number	Poll the vault at the specified interval, in seconds, until the job is successful.	`10`
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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	HTTP Response Attributes

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 `YYYY-MM-DDTHH:MM:SSZ` format. Dates and times are in UTC. If the time is not specified, it defaults to midnight (T00:00:00Z) on the specified date.
End Date	String	End date to retrieve audit information. This date cannot be more than 30 days ago. Dates must be of `YYYY-MM-DDTHH:MM:SSZ` format. Dates and times are in UTC. If the time is not specified, it defaults to midnight (T00:00:00Z) on the specified date.
Fetch Size	Number	Number of limits or records per page.	`1000`
Batch Size	Number	Number of pages per batch.	`10`
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable non-repeatable-iterable	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

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, `{"documentId": "534"}`.	`#[payload]`
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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	HTTP Response Attributes

#### Associated Configurations - [Configuration](#config) #### Throws - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:INVALID\_KEY\_FORMAT - VEEVAVAULT:INVALID\_SESSION\_ID - VEEVAVAULT:EXECUTION - VEEVAVAULT:CLIENT\_PROTOCOL - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:RESPONSE\_TIMEOUT - VEEVAVAULT:IOEXCEPTION - VEEVAVAULT:PARAMETER\_REQUIRED - VEEVAVAULT:CONNECTIVITY - VEEVAVAULT:INVALID\_AUTH - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:USERNAME\_OR\_PASSWORD\_INCORRECT - VEEVAVAULT:RETRY\_EXHAUSTED - VEEVAVAULT:JSON\_EXCEPTION - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:INVALID\_SPARK\_MESSAGE - VEEVAVAULT:INVALID\_TOKEN - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:SESSION\_EXPIRED ### Get Documents `` Retrieves document details from Veeva Vault. You can either: - Provide document properties (document type, subtype, and classification) to retrieve document details. If document properties are provided, the **Get Documents** operation builds the VQL query dynamically. The VQL query is then executed on the vault to retrieve document details. - Have document properties (document type, subtype, and classification) fetched to retrieve document details. If document properties are not provided, the document properties metadata is fetched using `/api/{version}/metadata/objects/documents/properties` and the VQL query is built based on the document metadata properties added or inserted in the **Document Properties** list. If metadata properties are not provided, then all queryable document properties are used and executed in the VQL query. Place a For-Each/Splitter element after this operation to fetch each document’s data (page) sequentially. This operation provides a paging mechanism based on Mule standard pagination. Refer to [Streaming and Pagination](https://docs.mulesoft.com/veevavault-connector/latest/veevavault-connector-config-topics#streaming_and_pagination.adoc) for more details.

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable non-repeatable-iterable	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.	`1000`
Batch Size	Number	Batch size which accommodates the number of pages in a specified number of batches.	`10`
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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

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.	`1000`
Batch Size	Number	Number of pages per batch.	`10`
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable non-repeatable-iterable	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	HTTP Response Attributes

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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configures how Mule processes streams. Repeatable streams are the default behavior.
Method	Enumeration, one of: GET DELETE POST PUT	HTTP method to send the request.	`GET`
Path	String	Path in which the request is sent, for example, `/vobjects/{object_name}/actions/{action_name}`.	`/`
Body	Any	Body of the request message.	`#[payload]`
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: AUTO ALWAYS NEVER	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	HTTP Response Attributes

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Streaming Strategy	Repeatable In Memory Iterable Repeatable File Store Iterable non-repeatable-iterable	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 `#[{'name': 'Hemant', 'nickname': payload, 'company': vars.company}]`.
Fetch Size	Number	Number of limits or records per page.	`1000`
Batch Size (DEPRECATED)	Number	Number of batches of Fetch Size elements to return. This field is deprecated.	`10`
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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Array of Message of Binary payload and HTTP Response Attributes attributes

#### Associated Configurations - [Configuration](#config) #### Throws - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:USERNAME\_OR\_PASSWORD\_INCORRECT - VEEVAVAULT:INVALID\_KEY\_FORMAT - VEEVAVAULT:INVALID\_SESSION\_ID - VEEVAVAULT:JSON\_EXCEPTION - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:EXECUTION - VEEVAVAULT:INVALID\_SPARK\_MESSAGE - VEEVAVAULT:INVALID\_TOKEN - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:CLIENT\_PROTOCOL - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:RESPONSE\_TIMEOUT - VEEVAVAULT:IOEXCEPTION - VEEVAVAULT:PARAMETER\_REQUIRED - VEEVAVAULT:INVALID\_AUTH - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:SESSION\_EXPIRED ### Spark Validator `` Validates and verifies Spark messages triggered from the vault with a signature and public key. Upon successful validation and verification, the Spark message can be further processed in the Mule flow according to your business requirements. Refer to https://developer.veevavault.com/sdk/#spark-messaging\[Spark Messaging feature and functionalities and setup\] for more details. The output of the **Spark Validator** operation includes Spark attributes (optional) with the Spark message as it is received from the vault. > [!NOTE] Before triggering a Spark message from the vault, make sure to raise a support ticket with > Veeva Vault Support to increase the time interval (for example, 10 seconds) for the Spark message > to resend or retry. By default, the time interval is configured as 5 seconds, which is less than > the time required for the **Spark Validator** operation to complete message validation and > verification. > [!NOTE] As per Veeva Systems, the public key (00001.pem) expires every two years. You receive > notification in advance advising you of the expiration date. If you are using the **Spark > Validator** operation in a Mule application flow, after the public key expiration date you must > remove the public key file from the path configured in the **Public Key Path** field. A new public > key will be created during execution of the key removal. If you don’t do this, Spark message > verification fails as `INVALID_SPARK_MESSAGE`. The Mule application deployed on CloudHub with the > default path must be restarted for successful Spark message verification.

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.	`false`
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.	`${mule.home}/apps/${app.name}/publickeys`
Spark Headers	Object	Spark headers received from the vault and embedded in the Spark message.	`#[attributes.headers]`
Spark Message	Input Stream	Spark message body received from the vault.	`#[payload]`
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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

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.

#### Associated Configurations - [Configuration](#config) ### Update Documents `` Updates bulk documents using editable metadata in the payload provided in CSV or JSON format.

Name	Type	Description	Default Value	Required
Configuration	String	Name of the configuration to use.		x
Metadata Format	Enumeration, one of: CSV JSON	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.	`#[payload]`
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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	HTTP Response Attributes

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: CSV JSON	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.	`#[payload]`
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	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	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.	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	Retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	HTTP Response Attributes

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 `true`, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Reconnection Strategy	Reconnect Reconnect Forever	Reconnection strategy to use.

### Reconnect Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

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.

### Reconnect Forever Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field	Type	Description	Default Value	Required
Frequency	Number	How often to attempt to reconnect, in milliseconds.

### Expiration Policy Configures an expiration policy strategy.

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: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Max Idle Time field.

### Repeatable In Memory Stream Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field	Type	Description
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 `STREAM_MAXIMUM_SIZE_EXCEEDED` error is raised when the buffer gets full.
Max Buffer Size	Number	Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a `STREAM_MAXIMUM_SIZE_EXCEEDED` error. A value of less than or equal to `0` means no limit.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

### Repeatable File Store Stream Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

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: Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory. Configure a smaller buffer size to decrease memory load at the expense of response time.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	Unit for the In Memory Size field.

### Repeatable In Memory Iterable Configures the repeatable in memory iterable type.

Field	Type	Description
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 `STREAM_MAXIMUM_SIZE_EXCEEDED` error is raised when the buffer gets full.
Max Buffer Size	Number	Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a `STREAM_MAXIMUM_SIZE_EXCEEDED` error. A value of less than or equal to `0` means no limit.

### Repeatable File Store Iterable Configures the file store iterable type.

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: BYTE KB MB GB	Unit for the In Memory Size field.

### HTTP Response Attributes Configures HTTP response attributes for the configuration.

Field	Type	Description	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

### Burst Api Limit Config Use **Burst API Limit Profile** if the specified burst API limit of the Veeva Vault API reaches or exceeds the configured threshold value. If the value of **Burst API Limit Profile** is set to `Burst api limit config (Default)`, the connector evaluates the specified burst API limit of the Veeva Vault API response header (`X-VaultAPI-BurstLimitRemaining`) against the configured threshold value. If the remaining burst API limit reaches or exceeds the configured threshold value, the connector waits for the specified amount of time to restart the count for **Burst Limit Remaining**. For more information, refer to https://developer.veevavault.com/docs/#api-rate-limits\[API Rate Limit Headers\].

Field	Type	Description	Default Value
Api Limit	Number	Veeva Vault API threshold limit. When this threshold is reached or exceeded, the connector waits the specified time.	`200`
Wait Time	Number	Time the connector waits once the threshold value reaches or exceeds the remaining API calls.	`5`
Max Wait Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	Time unit for the Wait Time field.	`MINUTES`

### Daily Api Limit Config Use **Daily API Limit Profile** to configure the API limit threshold that is evaluated against the remaining daily API limit calls. If the daily API limit calls reach or exceed the specified API limit threshold value, an exception is thrown. **Daily API Limit Profile** is disabled by default. For more information, refer to https://developer.veevavault.com/docs/#api-rate-limits\[API Rate Limit Headers\].

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 `API_LIMIT_EXCEED` exception for each request invoking an API call.	`10000`

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com)