Skip to end of banner
Go to start of banner

WIP: SNAP-7851 - Zuora REST Read Snap

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

In this article

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.

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 view.
Output

Document

  • Min:1
  • Max:1
  • Filter

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: ELT Database Account
Example: ELT RS Account

OpenAPI Specification

String

Enter the URL for the OpenAPI specification file.

Example: zuora_open_api_spec3.json, sldb:///zuora_open_api_spec3.json
Default value: [None]

Zuora Object

String

Required.  Enter the desired Zuora object name. 

Example: Account
Default value: [None] 

Where Clause

String

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

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

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
Default value: [None]

Number of retries

Integer

Enter the maximum number of retry attempts in case of a failure in execution.

Example: 3
Default value: 0

Retry interval (seconds)

Integer

Specify the minimum number of seconds to wait before the next retry.

Example: 2
Default value: 1

Troubleshooting

ErrorReasonResolution
SOAP ExceptionSOAP request failedPlease 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 ExceptionThe 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 typeThe provided input is not a document of type MapPlease ensure the input document type is of type Map.

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:

<screenshot of Pipeline/Snap and description>

Download this Pipeline. 

Downloads

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

  File Modified
No files shared here yet.


Error rendering macro 'excerpt-include' : No link could be created for 'XYZ Snap Pack'.

See Also

  • No labels

Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.