Versions Compared

Key

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

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:

Read


Description:

This Snap provides the ability to retrieve records by defining output fields and optional conditions. The output fields are the fields returned by the query. The condition can be defined to only return a specific set of records.

The conditions can either be combined with <and> or <or> operator. This is a limitation by Zuora: http://knowledgecenter.zuora.com/D_Zuora_APIs/SOAP_API/C_SOAP_API_Reference/A_SOAP_Basics/A_Zuora_Object_Query_Language/Filter_Statements

  • Expected upstream Snaps: [None] or any Snap that provides a document output view, such as Data or a JSON Generator Snap.

  • Expected downstream Snaps: Any Snap that has a document input view, such as Filter or Data or JSON Formatter.
  • Expected input: [None], or documents that provide fields that are used in one or more conditions of the Snap.
  • Expected output: This Snap provides records for all fields of the selected Zuora object.
Prerequisites:

[None]


Support and limitations:Ultra pipelines: Works in Ultra Pipelines.Spark mode: Not supported in /wiki/spaces/SD/pages/1437917 modeTask Pipelines.
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Zuora Account for information on setting up this type of account.


Views:


InputThis Snap has at most one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.


Settings

Label


Required.The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Request timeout



Required.Defines the timeout value for the SOAP request, 0 means no timeout
Example: 0
Default value: 0


Object

Required.The Zuora Object being queried. The field is suggestable once the Zuora account is defined

Example: Account
Default value: [None] 


Output fields


Required. The fields to be returned by the query. The return field is suggestable after selecting the + icon and after the Object property is defined. At least one output field must be defined.

Example: AccountNumber

Default value: [[None]


Conditions

The conditions defined in the where clause if any. Each predicate has access to the schema on the input view if any. The example shows the usage of a condition that is enabled as an expression.

Example: (with expression toggle (=) on) "AccountNumber = '" + $accNumber + "'"

The second example shows the usage of a condition that is not enabled as an expression.

Example: (with expression toggle (=) off) Id = '2c92c0f8427e89d8014291c9609131ee'

Default value: [[None]


Condition operator

The operator to concatenate each condition. It can either be all AND or all OR. Zuora does not support mixing both. 
http://knowledgecenter.zuora.com/D_Zuora_APIs/SOAP_API/C_SOAP_API_Reference/A_SOAP_Basics/A_Zuora_Object_Query_Language/Filter_Statements

Example: and


Default value: and


Remove namespace prefixes

Select this option to remove any residual XML namespace prefixes from the output JSON. For example, "ns2:Id" becomes "Id".

Default value: Not selected.


Examples

Downloads

Attachments
patterns.*slp, .*zip




Insert excerpt
Zuora Snap Pack
Zuora Snap Pack
nopaneltrue