Versions Compared

Key

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


In this article

Table of Contents
maxLevel2
absoluteUrltrue

...

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Binary



  • Min:0
  • Max:1
  • Mapper Snap
  • Copy Snap
  • ..
Requires the EDI data and internal ID as a JSON document.
Output


Binary


  • Min:1
  • Max:1
  • ..
  • ..

The EDI transaction ID and order confirmation.

Snap Settings

...

titleDocumenting Fields Based On Data Type/UI Element

**Delete Before Publishing**

Choose from the following sentences to document specific field types.

...


Parameter
Data Type
Description
Default Value
Example
LabelStringRequired. The name for the Snap. You can modify the default name to be specific and meaningful, especially if you have more than one of the same Snaps in your pipeline.Get ProductsOrd_300
VersionString/Expression
Required. Specify the Shopify API version. Alternatively, click the Suggestion Image Added icon to fetch the list of Shopify API versions. 
2021-042021-04
Product IDString/ExpressionRequired. Specify a unique identifier for the product.N/ACMS0119
Resource IDString/ExpressionSpecify a unique identifier for the resource.N/A$resid
Parameters

Use this field set to define object parameters ad their values. This field set contains the following fields:

  • Parameter
  • Parameter value
ParametersString/Expression/SuggestionSpecify a query parameter.N/A
Parameter valueString/ExpressionSpecify a value for the parameter.N/A
Number Of RetriesInteger/ExpressionSpecify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout.12
Retry Interval (Seconds)Integer/ExpressionSpecify the duration in seconds for which the Snap must wait between two reconnection attempts, until the number of retries is reached.15
Snap ExecutionDrop-down list

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

...

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 must/must not do. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
    The name of the account.
    Enter the account ID that you want 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 user must/must not do. 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.
    Enter the number of records in a batch.
    Enter the number of seconds for which you want the Snap to wait between retries.
    Enter 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.

...

Field Sets

Specify advanced parameters that you want to include in the request.

This fieldset consists of the following fields:

  • Field 1
  • Field 2
  • Field 3
  • all Snaps that are downstream from it.

Validate & Execute

Execute only



Troubleshooting


ErrorReasonResolution

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

...

Getting Product Variants


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

...

Attachments
patterns*.slp, *.zip


Insert excerpt
XYZ Shopify Snap PackXYZ
Shopify Snap Pack
nopaneltrue

...

See Also