Versions Compared

Old Version 6

changes.mady.by.user Shilpa

Saved on

compared with

New Version Current

changes.mady.by.user Gouri Bhagchandani

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to retrieve all fields for a Zuora object.

  • 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.

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


Image Added

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Limitations

None.

Known Issues

None.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
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.


...

Batch execution failed

...

The Pipeline ended before the batch could complete execution due to a connection error.

Verify that the Batch size field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.

Examples

Excluding Fields from the Input Data Stream

We can exclude the unrequired fields from the input data stream by omitting them in the Input schema fieldset. This example demonstrates how we can use the <Snap Name> to achieve this result:

...

Field Name

Data type

Description

Label*

String

Specify a unique label for the

account

Snap.

Default Value:

 ELT Database Account

 Zuora REST Read
Example:

 ELT RS

 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

Required. This property sets the Zuora object name. A suggestion lists all the available object names. Enter the desired object if it is not in the suggested list.

Example: Account
Default value

/Suggestion

Enter the desired Zuora object name. 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.

Default Value: [None] 
Example: Account

Where Clause

String

Enter the WHERE clause of the Zuora SELECT query without the word ‘WHERE’.

Default Value: [None] 
Example: name = ‘SnapLogic’

Default value: [None] 
Limit ClauseString

Enter the LIMIT clause to indicate the maximum number of output records.

Default Value: [None]
Example: 10000

Note

This 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 FieldsString

Enter

SELECT

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

attempts to select

includes all the fields in the output.

Example: id

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.

Example: 2
Default value: 1

Troubleshooting

...

interval in seconds between two reconnection attempts.

Default Value: 1
Example: 2

Pass Through

Checkbox

Select this checkbox to pass the input document through the output view under the key original

Default Value: Deselected
Example: Selected

Snap Execution

N/A

Select 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
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, and read the contact data using Rest Read Snap.

Image Added

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

Settings

Output view

Image Added

Image Added

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 Added

Image Added

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:

Settings

Output view
Image Added

Image Added



Settings

Output view

Image Added

Image Added

The contact for an account is created and a unique contact ID is generated. The Settings and Output view are as follows:

Settings

Output view

Image Added

Image Added

The contact details can be fetched by passing a unique contact ID using Zuora Rest Read by passing $entity.Id.


Settings

Output view

Image Added

Image Added


Download this Pipeline. 

Downloads

Note
titleImportant Steps to Successfully Reuse Pipelines
  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

Attachments
patterns*.slp, *.zip

Insert excerpt
XYZ Zuora Snap PackXYZ
Zuora Snap Pack
nopaneltrue

...

See Also