Veeva Vault Connector 1.4 Reference - Mule 4

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

One of:

Burst API limit profile configuration in which the Veeva Vault burst API limit exceed is configured. It is enabled by default.

One of:

Daily API limit profile configuration in which the Veeva Vault daily API limit exceed is configured. It is enabled by default.

String

Host.

Number

Port.

String

Username to authenticate against the proxy server.

String

Password to authenticate against the proxy server.

String

NTLM domain.

String

Veeva Vault instance URL required for connection.

x

String

Version for the Veeva Vault instance required.

v19.3

String

Client ID required to send with each request header to the Vault instance.

x

String

Username for the Veeva Vault instance required for connection.

x

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.

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

One of:

Burst API limit profile configuration in which the Veeva Vault burst API limit exceed is configured. It is enabled by default.

One of:

Daily API limit profile configuration in which the Veeva Vault daily API limit exceed is configured. It is enabled by default.

String

Host.

Number

Port.

String

Username to authenticate against the proxy server.

String

Password to authenticate against the proxy server.

String

NTLM domain.

String

Veeva Vault instance URL required for connection.

x

String

Version for the Veeva Vault instance required.

v19.3

String

Client ID required to send with each request header to the Vault instance.

x

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.

String

OAuth consumer key, as registered with the service provider.

x

String

OAuth consumer secret, as registered with the service provider.

x

String

URL of the service provider’s authorization endpoint.

https://{IdentityProvider}/oauth2/v2.0/authorize

String

URL of the service provider’s access token endpoint.

https://{IdentityProvider}/oauth2/v2.0/token

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

openid offline_access

String

Resource owner ID to use with the authorization code grant type.

String

Name of a flow to execute immediately before starting the OAuth dance.

String

Name of a flow to execute immediately after receiving an access token.

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

String

Path of the access token callback endpoint.

x

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

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.

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

String

Name of the configuration to use.

x

Enumeration, one of:

Metadata format.

x

Binary

Document metadata as an Input Stream. The payload must be in the format specified in the Metadata Format field.

#[payload]

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Enumeration, one of:

Metadata format.

x

Binary

Document metadata as an Input Stream. The payload must be in the format specified in the Metadata Format field.

#[payload]

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Object name.

x

Enumeration, one of:

Metadata format.

x

Binary

Vault object metadata in CSV or JSON format as an Input Stream to create bulk object records on the vault.

#[payload]

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Enumeration, one of:

Metadata format.

x

Binary

Document metadata in CSV OR JSON format as an Input Stream to delete multiple document renditions from the vault.

#[payload]

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Enumeration, one of:

Metadata format.

x

Binary

Document metadata in CSV or JSON format as an Input Stream to delete single or multiple documents from the vault.

#[payload]

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Object name.

x

Enumeration, one of:

Metadata format.

x

Binary

Vault object metadata in CSV or JSON format as an Input Stream to create bulk object records on the vault.

#[payload]

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Enumeration, one of:

Metadata format.

x

Binary

Document metadata in CSV or JSON format as an Input Stream to export documents from vault.

#[payload]

Boolean

To exclude source files, set to false.

true

Boolean

To include renditions, set to true.

false

Boolean

To include all versions or the latest version, set to true.

false

Number

Poll the vault at the specified interval, in seconds, until the job is successful.

10

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Audit type.

x

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.

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.

Number

Number of limits or records per page.

1000

Number

Number of pages per batch.

10

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Binary

Document ID metadata in a JSON format payload, for example, {"documentId": "534"}.

#[payload]

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Document type to retrieve the type.

String

Document subtype to retrieve the type.

String

Document classification to retrieve the classification.

Array of String

List of document properties to build a VQL query.

String

WHERE clause that is appended to dynamically build a VQL query.

Number

Fetch size which limits the records per page.

1000

Number

Batch size which accommodates the number of pages in a specified number of batches.

10

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Object name.

x

Array of String

Object fields list to include in the dynamic VQL query.

String

WHERE clause.

Number

Number of limits or records per page.

1000

Number

Number of pages per batch.

10

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Picklist name.

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

Enumeration, one of:

HTTP method to send the request.

GET

String

Path in which the request is sent, for example, /vobjects/{object_name}/actions/{action_name}.

/

Any

Body of the request message.

#[payload]

Object

HTTP headers the message must include.

Object

URI parameters that are provided in the Path field.

Object

Query parameters the request must include.

Enumeration, one of:

Whether the request must be sent using streaming or not.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

VQL query required as per Veeva API documentation.

x

Object

Input parameters in the format #[{'name': 'Hemant', 'nickname': payload, 'company': vars.company}].

Number

Number of limits or records per page.

1000

Number

Number of batches of Fetch Size elements to return. This field is deprecated.

10

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

Boolean

Flag to include Spark headers received from the vault in the Spark validator output.

false

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

Object

Spark headers received from the vault and embedded in the Spark message.

#[attributes.headers]

Input Stream

Spark message body received from the vault.

#[payload]

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

ID of the resource owner for whom to invalidate access.

String

Name of the configuration to use.

x

Enumeration, one of:

Metadata format.

x

Binary

Editable document metadata in CSV OR JSON format as an Input Stream to update single or multiple documents on the vault.

#[payload]

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

String

Name of the configuration to use.

x

String

Object name.

x

Enumeration, one of:

Metadata format.

x

Binary

Vault object metadata in CSV or JSON format as an Input Stream to create bulk object records on the vault.

#[payload]

String

MIME type of the payload that this operation outputs.

String

Encoding of the payload that this operation outputs.

Configures how Mule processes streams. Repeatable streams are the default behavior.

String

Name of the variable that stores the operation’s output.

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Retry strategy in case of connectivity errors.

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 to use.

Number

How often to attempt to reconnect, in milliseconds.

Number

How many reconnection attempts the Mule app can make.

Number

How often to attempt to reconnect, in milliseconds.

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Enumeration, one of:

Time unit for the Max Idle Time field.

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.

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.

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.

Enumeration, one of:

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

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:

Enumeration, one of:

Unit for the In Memory Size field.

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.

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.

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.

Number

Maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Enumeration, one of:

Unit for the In Memory Size field.

Number

HTTP status code of the response. Former 'http.status'.

x

String

HTTP reason phrase of the response. Former 'http.reason'.

x

Object

Map of HTTP headers in the message. Former properties.

x

Number

Veeva Vault API threshold limit. When this threshold is reached or exceeded, the connector waits the specified time.

200

Number

Time the connector waits once the threshold value reaches or exceeds the remaining API calls.

5

Enumeration, one of:

Time unit for the Wait Time field.

MINUTES

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