In this article

Table of Contents

maxLevel	2
absoluteUrl	true

Overview

You can use this Snap to retrieve the data from all the fields for a Zuora object. to read record from a Zuora object in Rest API. It uses POST , /query and, /jobs for for most of the Zuora Objects except Export, Import and Communicationprofile. The Snap uses /v1/action/query for them.

Expected upstream Snaps: [Optional] If none, the Snap executes once. If there are input documents, the Snap executes once for each input document.
Expected downstream Snaps: Any Snap that has a document input view, such as Filter or Mapper or JSON Formatter.
Expected output: This Snap provides records for all fields of the selected Zuora object if the Output Fields property is empty.

Image Added

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

...

None

Known Issues

None.

Snap Input and Output

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min:1
Max:1

Mapper Snap

This

Snap has at most one document input viewA document containing all the information required by the Snap. You can modify the default name to be specific and meaningful, especially if you have more than one of the same Snap in your Pipeline.

Output

Document

Min:1
Max:1

Filter

This Snap has exactly one document output

and JSON Formatter.

Parts and referred objects of the specification related to the selected path and operation in the second output view.

Snap Settings

Note
Field names marked with an asterisk ( * ) are mandatory.

Field Name	Data type	Description
Label*	String	Specify a unique label for the

account

Snap.

Default Value:

Zuora

Zuora REST Read
Example:

Read

Read Account data

OpenAPI Specification

String

Enter the URL for the OpenAPI specification file. If the field is left empty, the Snap uses the built-in OpenAPI specification.

Default Value: [None]
Example: zuora_open_api_spec3.json,

sldb

sldb:///zuora_open_api_spec3.json

Default value: [None]


Zuora Object*	String/Suggestion

Required.

Enter the desired Zuora object name.

Click the Suggestions icon to see the available object names. The

Alternatively, click the Suggestion icon to fetch the list of associated object names and select an object. The Snap executes and fetches the data for the object specified.

Example: Account

Default

value

Value: [None] Example: Account
Where Clause	String	Enter the WHERE clause of the Zuora SELECT query without the word ‘WHERE’.

Example: name = ‘SnapLogic’
Default value

Default Value: [None] Example: name = ‘SnapLogic’
Limit Clause	String	Enter the LIMIT clause to indicate the maximum number of output records.

Example: 10000

Default

value

Value: [None]
Example: 10000

Note
This

property

field does not support Zuora Objects: export, import and communicationprofile. Use Where Clause to limit the number of records. For more information, refer to the Zuora documentation on Zuora Query Processing Limitations.

Output Fields

Use this field set to define the output fields that you want to view in your query output. Specify each output field in a separate row. Click + to add a new row.

Output Fields

String

Enter

the SELECT

the Output field names, one field name for each row. If left empty, the Snap

attempts to select

includes all the fields

.Example: id

in the output.

Default

value

Value: [None]
Example: id

Number of

retries

Retries

Integer

Enter the maximum number of

retry attempts

retries to attempt in case of

a

connection failure

in execution

.

Default Value: 0
Example: 3

Default value: 0

Retry

interval

Interval (seconds)

Integer

Specify the

minimum number of seconds to wait before the next retry.

interval in seconds between two reconnection attempts.

Default Value: 1
Example: 2

Default value: 1

Pass Through

Checkbox

If selected,

Select this checkbox to pass the input document

will be passed

through

to

the output view under the key

'

original

'.

Default

value: deselected

Value: Deselected Example: Selected
Snap Execution	N/A

Indicates how

Select one of the three modes in which the Snap

must be executed

executes. Available options are:

Validate & Execute: Performs limited execution of the Snap

(up to 50 records)

, and generates a data preview during Pipeline validation

;

. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline

execution

runtime.
Execute only: Performs full execution of the Snap during Pipeline execution

; does not execute the Snap during Pipeline validation

without generating preview data.
Disabled: Disables the Snap and

, by extension, its downstream Snaps

all Snaps that are downstream from it.

Default

value

Value:

Validate

Validate & Execute

Troubleshooting

...

Examples

...

Example: Execute

Examples

Reading Account details from an Account

In the following example, we create this Pipeline with Zuora Rest Read Snap and Mapper Snap to read the account details such as contact number, name of the account, and city from an account.

First, we read the data with the help of Zuora Rest Read Snap and segregate the required information with the help of Mapper Snap.

Image Added

Configure the Zuora Rest Read Snap to read the information.

Settings	Output view
Image Added	Image Added

Route the output of the Snap into two outputs to read the data as-is using Router Snap and to segregate the required information. Using Mapper Snap, enter the columns name or the parameters you want the Snap to read.

Settings	Output view
Image Added	Image Added

Once the information is segregated in the output, you use the information in ServiceNow Insert Snap.

Settings	Output view
Image Added	Image Added

Download this Pipeline

Reading Contact ID from an Account

In the following example, we create this Pipeline with Zuora Rest Read Snap and Zuora Open API Snap to create an account, link an account to contact, read the details of the contact from the contact data.

First, create an account with a unique ID from the Mapper Snap, link it to a contact contact, and read the contact data using Rest Read Snap.

Image Removed

The data is added to Image Added

We configure the Mapper Snap and sent to add data and send it to the Open API Snap.

Settings	Output view
Image Modified	Image Modified

The details created are sent from the upstream Snap to create a unique account ID using Open API Snap. Following are the Snap settings and the output view:

Settings	Output view
Image Modified	Image Modified

Using Mapper Snap, we are sending data to create a contact for an account by mapping a unique account ID. The details of the data created can be seen under Expression and Target Path. The Output view for the Mapper Snap is as follows: