In this article

PipeLoop Snap

Demo slides: https://docs.google.com/presentation/d/1rTjUi9kRgcxrkQqkvsIOB0_C3jjahivTXNZ0qK9_Bcs/edit?usp=sharing

Properties

Pipeline

Pipeline Parameters

• The pipeline parameters to pass into the child pipeline

• Contains two child fields, Parameter Name and Parameter Value

• Parameter Name

  • Suggestable - suggests from child pipeline pipeline parameters field key

  • String field

• Parameter Value

  • Expression-enabled

  • Schema-enabled

  • String field

Loop options

Stop condition

• Condition to be evaluated during execution. The loop execution stops when the stop condition is met

• String field

• expression-enabled

• schema-enabled

Iteration limit

• Hard cutoff to use to stop the pipeline iteration

• Integer field

• expression-enabled

• required

Debug iteration outputs

• List out iteration documents, loop index, and current evaluated stop condition

• Boolean field

Execution options

Execute On

• The environment to execute on

• required

• available values are

  • LOCAL_NODE, LOCAL_SNAPLEX, SNAPLEX_WITH_PATH

Snaplex Path

• The Snaplex to execute on

• String field

• expression-enabled

• Enabled when Execute On is set to SNAPLEX_WITH_PATH

PipeLoop Current Limitations

Overview

You can use this Snap to enable looping on pipeline executions (do while loop) based on a stopping condition or a hard cutoff iteration limit. ..The output document of the snap will be fed into the next round of document input for execution until the stop condition is met or the cutoff limit is reached.

<Image>

Snap Type

The <Snap name> PipeLoop Snap is a Read/Write/Parse/Transform/ Flow/Format-type Snap that reads/fetches/writes/parses/executes/transforms/calls/creates… .

Prerequisites

• Valid client ID.

• A valid account with the required permissions.

...

• .

Support for Ultra Pipelines  

• Works in Ultra Pipelines if batching is disabled. 

• Works in Ultra Pipelines if....

• Does not support Ultra Pipelines. 

Limitations

...

Limitations

• Reuse is not currently supported due to needing to close an input view in order to force a flush of all documents out

• PipeLoop supports child pipelines with 1 and only 1 open input view and 1 and only 1 open output view

• PipeLoop will read only the first output document for a given fed-in input document (all others will be ignored and dropped)

• We will be able to support expression on the pipeline specification, but it will only evaluate on the input document to PipeLoop, not for each iteration

Known Issues

None.

Snap Views

Snap Settings

...

{"features":["title","icon","rounded","collapsible","border"],"title":"Documenting Fields Based On Data Type/UI Element","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

**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 option 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.

Notes in field descriptions

• Confluence’s new editor does not allow nesting of most macros inside another macro, especially the Note/Alert/Warning/Info (Panel) macros inside a table macro and Excerpt macros inside Expand or Panel Macro+ macros. So, as a workaround use the Footnotes approach as mentioned below:

  • Assign numbers at the Note locations in the form of follow through phrases like See Note 2 below this table. or such.

  • Add your Notes---an appropriate Note/Alert/Warning/Info (Panel) macro---immediately below the macro (for example, Table macro) beginning the content with the corresponding number assigned.

data
Info
Info
Expression icon (): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic. Suggestion icon (): Indicates a list that is dynamically populated based on the configuration. Upload icon (): Indicates that you can upload files. Learn more about managing Files.

Field Name		Field Type

Field Dependency

Description
Label* Default Value: ELT Database Account Example: ELT RS Account		String

None.

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.

Number of records

Pipeline* Default Value:

 

N/A Example: demo-child-pipeline

String/Expression

Sampling Type is Number of records.

Enter the number of records to output.

fieldset Name

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

Field 1*

Specify the path of the pipeline to execute.
Pipeline Parameters	Use this field set to define child pipeline parameters to use for executing the pipeline.
	Parameter name Default Value: <value> or None. Example: <value>	String

Debug mode check box is not selected.

Field 2

/Suggestion	Specify the name of the parameter. You can select the Pipeline Parameters defined for the Pipeline selected in the Pipeline field.
Parameter value Default Value: <value> or None. Example: <value>	String

None

/Expression	Specify the value for the Pipeline Parameter, which can be an expression based on incoming documents or a constant.  If you configure the value as an expression based on the input, then each incoming document or binary data is evaluated against that expression when invoking the Pipeline. The result of the expression is JSON-encoded if it is not a string. The child Pipeline then needs to use the JSON.parse() expression to decode the parameter value. When Reuse executions to process documents is enabled, the parameter values cannot change from one invocation to the next.
Loop options		Define the iteration configuration.
Stop condition Default Value:  Example:		String/Expression
Iteration limit Default Value:  Example:		Integer/Expression
Debug iteration outputs Default Value:  Example:		Checkbox
Execution options		Define the child pipeline execution configuration.
Execute on Default Value:  Example:		Dropdown list	Select the one of the following Snaplex options to specify the target Snaplex for the child Pipeline: SNAPLEX_WITH_PATH. Runs the child Pipeline on a user-specified Snaplex. When you choose this option, the Snaplex Path field appears. LOCAL_NODE. Runs the child Pipeline on the same node as the parent Pipeline. LOCAL_SNAPLEX. Runs the child Pipeline on one of the available nodes in the same Snaplex as the parent Pipeline.
Execution label Default Value: N/A Example: demo		String/Expression	Specify the label to display in the Dashboard for the current execution.
Snap Execution Default Value:  Example: Validate & Execute		Dropdown list

N/A

Select one of the following three modes in which the Snap executes: 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 all Snaps that are downstream from it.

Troubleshooting

Examples

Excluding Fields from the Input Data Stream

...