Veeva Read

Overview

The Veeva Read Snap reads records from Veeva Vault objects.

Use this Snap to retrieve records from Veeva Vault objects by specifying record IDs.


Veeva 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 record IDs to read. If no input is provided, the Snap reads records based on the configured settings.

Output

This Snap has exactly one document output view.

The output document contains the record data 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 Read

API version*

String/Expression/ Suggestion

The Veeva Vault API version to use for this Snap.

Default value: v25.2

Example: v25.2

Object type

String/Expression/ Suggestion

The name of the Veeva Vault object to read records from.

Default value: N/A

Example: product__v

Page size

Integer

The number of records to retrieve per page. This setting controls pagination for large result sets.

Default value: 1000

Example: 1000

Ignore empty result

Checkbox

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

Default value: Not selected

Output fields

Table

Specify the fields to include in the output. Click the + icon to add fields to retrieve from the Veeva Vault object.

Default value: N/A

Where clause

String/Expression

A WHERE clause to filter the records retrieved. Use VQL (Vault Query Language) syntax.

Default value: N/A

Example: status__v = 'active__v'

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