Veeva Vault Connector 1.2 Additional Configuration Information - Mule 4

Follow the instructions in Connection Configuration.

The Create Documents operation enables you to create single or multiple documents with the provided document metadata in CSV or JSON format. Make sure you have uploaded document files on the vault FTP server location with the document content to attach to the created documents.

The Get Documents operation enables you to retrieve document details based on the document type, subtype and classification selected. Using the selected type, subtype, and classification it fetches document properties metadata and builds VQL queries dynamically. The VQL query is then executed on the vault to retrieve document details. 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. See Streaming and Pagination for more details.

The document type, subtype, and classification are optional. If none are selected then document properties metadata is fetched using API (/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 in VQL and executed.

The Delete Documents operation enables you to delete single or multiple documents using the bulk API with input metadata in CSV or JSON format.

The Update Documents operation enables you to update bulk documents with the provided editable metadata in the payload in CSV or JSON format.

An Export Documents operation enables you to query a set of documents for export to your vault’s FTP staging server. It is recommended that you use the Export Documents operation in a separate asynchronous flow using Async Scope and passing the payload with document IDs.

When used asynchronously the 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 exported documents are stored on the FTP staging area in the folder, with the hierarchy structure:
{root}/{userId}/{jobId}/{documentIds}/{versions}.

The following is an example of the Export Documents operation returning job results as response:

The previous example shows the following attributes:

The Create Document Renditions operation enables you to add document renditions in bulk. Your vault must be in Migration Mode before using this operation. It takes CSV input data with a maximum size of 1 GB with a standard UTF-8-encoded value.

The Get Document Renditions Types operation enables you to retrieve document renditions types details.

The Delete Document Renditions operation enables you to delete document renditions in bulk using CSV or JSON format input metadata.

The Create Object Records operation enables you to create bulk object records for the selected vault object with the provided object metadata in CSV or JSON format.

The Get Object Records operation enables you to retrieve object records details using object metadata fields to build a VQL query dynamically and execute on vault to get object details. Place a For-Each/Splitter element after this operation to fetch each object records (page) sequentially.

This operation provides a paging mechanism based on Mule standard pagination. See Streaming and Pagination for more details.

The Update Object Records operation enables you to update object records of specified vault object.

The Query operation enables you to execute the specified VQL query on the vault and retrieve the result in a paginated data input stream. Place a For-Each/Splitter element after the Query operation to fetch each record in sequential order.

Note: Do not specify LIMIT and OFFSET in the VQL query. These parameters are incorporated internally.

This operation provides a paging mechanism based on Mule standard pagination. See Streaming and Pagination for more details.

The Get Picklists operation enables you to retrieve all available picklist values configured on a picklist.

The Get Audit Detail operation enables you to retrieve audit details for the specified audit type. This operation provides a paging mechanism based on Mule standard pagination.

See Streaming and Pagination for more details.

The Spark Validator operation 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. See 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 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, it is configured as 3 seconds, which is less than the time required for Spark Validator 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 this operation in a Mule application flow, after the public key expiration date you need to 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.

The Veeva Vault Connector operation responses are based on the Veeva Vault API success or failure response with an error.

The connector returns a SUCCESS response at HIGH LEVEL and SUCCESS or FAILURE at LOW LEVEL. This means the connector operation is successful but some document or object records failed to create or update due to some irrelevant metadata being passed in the request.

All the operations in the connector (except Download Document) return an InputStream as a payload with respective results based on operation output. Because of this, by default, Mule applies Streaming Strategies. See Mule Streaming Strategies for more details. The streaming strategies configuration fields are in the Advanced tab of the connector operations.

The following operations in the connector provide a pagination mechanism based on Mule standard pagination.

While using the paginated operations make sure to place a For-Each/Splitter element to retrieve each object (metadata is in JSON format) at a time. The pagination operations have Fetch Size and Batch Size fields.

The repeatable streams measure the buffer size in byte measurements. When handling objects, the runtime measures the buffer size using instance counts.

In non-repeatable streams connector operations return streams as the number of records per batch. Repeatable streams return all records at once, so when calculating the in-memory buffer size for repeatable auto-paging, you need to estimate how much memory space each instance takes to avoid running out of memory.

After you complete configuring the connector, you can try the Examples.