In this article
Overview
You can use this Snap to retrieve all fields for a Zuora object. It uses POST, query and, jobs 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.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations
To read custom object data, you need to provide an object name. It does not appear in the Suggestions list of the Zuora Object property.
Known Issues
None.
Snap Input and Output
| Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| This Snap has at most one document input view. |
| Output | Document |
|
| This Snap has exactly one document output view. |
Snap Settings
Field names marked with an asterisk ( * ) are mandatory.
Field Name | Data type | Description |
|---|---|---|
Label | String | Specify a unique label for the account. Default Value: Zuora REST Read |
OpenAPI Specification | String | Enter the URL for the OpenAPI specification file. Example: zuora_open_api_spec3.json, sldb:///zuora_open_api_spec3.json |
Zuora Object | String | Required. Enter the desired Zuora object name. Click the Suggestions icon to see the available object names. The Snap executes and fetches the data for the object specified. Example: Account |
Where Clause | String | Enter the WHERE clause of the Zuora SELECT query without the word ‘WHERE’. Example: name = ‘SnapLogic’ |
| Limit Clause | String | Enter the maximum number of output records. Example: 10000 This property 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 | String | Enter the SELECT field names, one field name for each row. If empty, the Snap attempts to select all fields. Example: id |
Number of retries | Integer | Enter the maximum number of retry attempts in case of a failure in execution. Example: 3 |
Retry interval (seconds) | Integer | Specify the minimum number of seconds to wait before the next retry. Example: 2 |
Pass Through | Checkbox | If selected, the input document will be passed through to the output view under the key 'original'. Default value: Selected |
Snap Execution | N/A | Indicates how the Snap must be executed. Available options are:
Default value: Validate & Execute |
Troubleshooting
| Error | Reason | Resolution |
|---|---|---|
| SOAP Exception | SOAP request failed | Please verify the template is correct. the substituted values are valid and the provided envelope matches the namespaces that are required by the targeted service. |
| Authorization Exception | The provided credentials are not authorized to request the export from Zuora. Please make sure that the credentials match either Zuora's sandbox or production environment. | You can switch between sandbox and production by dis/enabling the production property on the Zuora account. |
| Error finding subscribes a node in the template | Please ensure that the template has a subscribes node under the subscribe node parent. | |
| Unexpected input type | The provided input is not a document of type Map | Please ensure the input document type is of type Map. |
Examples
In the following use case example, the Pipeline uses Zuora Rest Read Snap and Zuora Open API Snap to create an account with a unique ID from the Mapper Snap, link it to a contact.
The data is added to the Mapper Snap and sent to the Open API Snap.
Settings | Output view |
|---|---|
|
|
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 |
|---|---|
|
|
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 |
|---|---|
|
|
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 |
|---|---|
|
|
The contact details can be fetched by passing a unique contact ID using Zuora Rest Read by passing $entity.Id.
Settings | Output view |
|---|---|
|
|
Download this Pipeline.
Downloads
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.