Veeva Document Read

Overview

The Veeva Document Read Snap reads document metadata from Veeva Vault.

Use this Snap to retrieve metadata information for documents in Veeva Vault by specifying document IDs.


Veeva Document Read Snap overview

Supported Accounts

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has at most one document input view.

The input document can contain document IDs to read. If no input is provided, the Snap uses the configured document ID.

Output

This Snap has exactly one document output view.

The output document contains the document metadata retrieved from Veeva Vault.

Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label*

String

Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Veeva Document Read

API version*

String/Expression/ Suggestion

The Veeva Vault API version to use for this Snap.

Default value: v25.2

Example: v25.2

Ignore empty result

Checkbox

Select this checkbox to ignore empty results. When selected, the Snap does not write an output document if the document cannot be found.

Default value: Not selected

Document IDs*

Table

The IDs of the documents to read. Click the + icon to add document IDs.

Default value: N/A

Example: 12345

Include versions

Checkbox

Select this checkbox to include all versions of the document in the response.

Default value: Not selected

Include renditions

Checkbox

Select this checkbox to include all available renditions of the document in the response.

Default value: Not selected

Number of retries

Integer

The number of retry attempts for failed API calls. The Snap retries the request if it receives a transient error from Veeva Vault.

Default value: 3

Example: 5

Retry interval (seconds)

Integer

The time interval in seconds between retry attempts.

Default value: 1

Example: 10

Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default value: Validate & Execute