| Note |
|---|
| title | General Guidelines. Remove Before Publishing. |
|---|
|
- Always use title casing for Heading formats 1 and 2.
- Always use active voice.
- Do not use "Please" anywhere in the document.
- Screenshots
- Always use the New Form UI.
- Be optically similar. Max size 1000 px or corresponding gridline size as in the style guide.
- Do not capture Snap borders when showing configurations in the Examples section. You can add a border in the editor here.
- See Image Style Guide for details.
- Examples must always use first-person plural references. You can use the second-person if needed depending upon the example's content.
|
...
Overview
You can use this Snap to...
Prerequisites
...
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
Capture if Ultra Mode is supported. If the Snap requires certain configurations to support Ultra mention those as well.
Works in
...
Ultra Pipelines.
Limitations
None.
Known Issues
...
| Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|
| Input | Document Binary Binary or Document | | Requires | the EDI data and internal ID as a JSON documentThis Snap has at most one document input view. |
| Output | Document Binary Binary or Document | | | The EDI transaction ID and order confirmation | This Snap has exactly one document output view. |
Snap Settings
| Note |
|---|
| title | Documenting Fields Based On Data Type/UI Element |
|---|
|
**Delete Before Publishing** Choose from the following sentences to document specific field types. Drop-down lists/Option Buttons (radio buttons):
You must list the LoV and describe them if their meaning isn't apparent. In this case, format the LoV in italics, regular font for the LoV's description. In either case, list the LoVs as a bullet list. - <State what the should do in this field>. The available options are: <bullet list of LoVs>
Specify the Salesforce API to be used. The available options are:... - Select the <category> that you want to use. Available options are...
* Option 1<italicized>. <third person singular form of the verb>
* Option 2<italicized>. <third person singular form of the verb>
Select the API that you want to use. Available options are:
Bulk API. Sends the Snap execution request details as a bulk API call.
REST API. ...
OR
Select one of the three following modes in which the Snap executes:
* Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then 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 downstream from it.
Check boxes: - If selected, <Snap behavior>.
If selected, an empty file is written when the incoming document has no data. - If selected, <behavior>. If not selected/Otherwise, <behavior>
Use "If not selected" if the first sentence is long.
If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property.
- Select to <action>
Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
Select to execute the Pipeline during validation.
Text Fields - Describe what the user shall specify in this field. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
Enter the name for new account.
Specify the account ID to use to log in to the endpoint.
Required if IAM Role is selected.
Do not use this field if you are using batch processing.
Numeric Text Fields - Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
The number of records in a batch.
The number of seconds for which you want the Snap to wait between retries.
The number of seconds for which the Snap waits between retries.
Use the following special values:
* 0: Disables batching.
* 1: Includes all documents in a single request.
|
...
| Note |
|---|
Field names marked with an asterisk ( * ) are mandatory. |
Field NameField Dependency | Data type | Description |
|---|
Default Value: Example: Label* | None.String | Specify a unique label for the account. Default Value: ELT Database Account
Example: ELT RS Account | Field set | Specify advanced parameters that you want to include in the request.
This field set consists of the following fields:
Field 1* | Debug mode check box is not selected. | Default Value: <value> or None.
Example: <value>
Field 2 | None. | 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. 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: [None] |
Where Clause | String | Enter WHERE clause of Zuora SELECT query without the word ‘WHERE’. Example: name = ‘SnapLogic’
Default value: [None] |
Output Fields | String | Enter 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
| Error | Reason | Resolution |
|---|
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. |
|
|
|
...
We can exclude the unrequired fields from the input data stream by omitting them in the Input schema field set fieldset. This example demonstrates how we can use the <Snap Name> to achieve this result:
...
