Veeva Metadata Read

Overview

The Veeva Metadata Read Snap reads metadata for Veeva Vault objects and documents.

Use this Snap to retrieve schema information, field definitions, and object metadata from Veeva Vault.


Veeva Metadata 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 specify the object name for which to retrieve metadata. If no input is provided, the Snap uses the configured object name.

Output

This Snap has exactly one document output view.

The output document contains the metadata information for the specified Veeva Vault object or document type.

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 Metadata Read

API version*

String/Expression/ Suggestion

The Veeva Vault API version to use for this Snap.

Default value: v25.2

Example: v25.2

Metadata type*

String/Expression/ Suggestion

The type of metadata to retrieve. Options include object, field, picklist, etc.

Default value: object

Example: picklist

Object type

String/Expression/ Suggestion

The name of the Veeva Vault object to retrieve metadata for.

Default value: N/A

Example: product__v

Ignore empty result

Checkbox

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

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