Input 

Binary or Document

• Min: 0

• Max: 1

• Mapper Snap

• Copy Snap

The document or binary data to send to the child pipeline.

Retry is not supported if the input view is a Binary data type

Output

Binary or Document

• Min: 0

• Max: 1

• Mapper Snap

• Router Snap

• If the child pipeline has an unlinked output, then documents or binary data from that view are transferred out of this view.

• If the child pipeline has a linked view then the output document or binary data is generated for successful runtimes with the run_id field.

• Unsuccessful pipeline runs write a document to the error view. If Reuse executions to process documents is deselected, the original input or binary data is added to the output document.

• For Pool Size Usage: If the Pool Size field value is greater than one, then the order of records in the output is not guaranteed to be the same as that of the input.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

• Stop Pipeline Execution: Stops the current Pipeline execution if the Snap encounters an error.

• Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

• Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Label*

Default Value: Pipeline Execute
Example: ExecuteCustomerUpdatePipeline

String

None.

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

Pipeline*

Default Value: N/A
Example: 

String/Expression

None

Specify the child pipeline's absolute or relative (expression-based) path to run. If you specify only the pipeline name, Snap searches for the pipeline in the following folders in this order:

• Current project

• Shared project-space

• Shared folder of the Org

You can specify the absolute path to the target project using the Org/project_space/project notation.

You can also dynamically choose the pipeline to run by entering an expression in this field when Expressions are enabled. For example, to run all of the pipelines in a project, you can connect the SnapLogic List Snap to this Snap to retrieve the list of pipelines in the project and run each one.

Execute On

Default Value: SNAPLEX_WITH_PATH
Example: groundplex4-West

Dropdown list

N/A

Select one of the following Snaplex options to specify the target Snaplex for the child pipeline:

• LOCAL_NODE. Runs the child pipeline on the same node as the parent pipeline. This option is recommended when the child Pipeline is being used for Pipeline structuring and reuse rather than Pipeline workload distribution. Use this option for most regular child Pipeline executions.

• LOCAL_SNAPLEX. Runs the child pipeline on one of the available nodes in the same Snaplex as the parent pipeline. As the child pipeline is on the local Snaplex, network communication is optimized for streaming data processing. Use this option only when workload distribution within the Snaplex is required.

• SNAPLEX_WITH_PATH. Runs the child pipeline on a user-specified Snaplex, and the Snaplex Path field appears. It's important to note that this process is highly dependent on the network. The network communication is optimized for batch data processing since the child Pipeline is on a remote Snaplex. It is recommended to use this option only when the child Pipeline needs to run on a different Snaplex because of endpoint connectivity restrictions or for workload distribution purposes.

For more information, refer to the Best Practices.

Snaplex Path

Default Value:N/A
Example: DevPlex-1

String/Expression

Appears when you select SNAPLEX_WITH_PATH for Execute On.

Enter the name of the Snaplex on which you want the child pipeline to run. Click  to select from the list of Snaplex instances available in your Org.

Execution Label

Default Value: N/A 
Example: NetSuite-Create-Credit-Memo

String/Expression

N/A

Specify the label to display in the Pipeline view of the Dashboard.

You can use this field to differentiate each pipeline execution.

Pipeline Parameters

Use this fieldset to define the Pipeline Parameters for the pipeline selected in the Pipeline field. When you select Reuse executions to process documents, you cannot change parameter values from one Pipeline invocation to the next.

Parameter Name

Default Value: N/A
Example: Postal_code

String

Debug mode checkbox is not selected.

Enter the name of the parameter. Select the defined Pipeline Parameters in the Pipeline field.

Parameter Value

Default Value: N/A
Example: 94002

String

None

Enter 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 evaluates against that expression when to you invoke 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.

Reuse executions to process documents

Default Value: Deselected

Checkbox

None

Select this checkbox to start a child pipeline and pass multiple inputs to the pipeline. Reusable executions continue to live until all of the input documents to this Snap are fully processed.

Batch size*

Default Value: 1
Example: 2

Integer/Expression

None

Specify the number of documents in the batch size. If Batch Size is set to N, then N input documents are sent to each child pipeline that is started. After N documents, the child pipeline input view is closed until the child pipeline completes its execution. The output of the child pipeline (one or more documents) passes to the Pipeline Execute output view. New child pipelines are started after the original pipeline is complete.

Pool Size*

Default Value: 1
Example: 4

Integer/Expression

None

Specify an execution pool size to process multiple input documents or binary data concurrently. When the pool size is greater than one, the Snap starts Pipeline executions as needed up to the specified pool size. 

When you select Reuse executions to process documents, the Snap starts a new execution only if either all executions are busy working on documents or binary data and the total number of executions is below the pool size.

Timeout (in seconds)

Default Value: N/A
Example:10

Integer/Expression

N/A

Specify the number of seconds for which the Snap must wait for the child pipeline to complete the runtime. If the child pipeline does not complete the runtime before the timeout, the execution process stops and is marked as failed.

Retry limit

Default Value: N/A
Example: 3

Integer/Expression

N/A

Specify the maximum number of retry attempts that the Snap must make in the case of a failure. If the child pipeline does not execute successfully, an error document is written to the error view. If the child pipeline is not in a completed state, then it will retry. The pipeline failure at the application level could have various causes, including network failures.

Retry interval

Default Value: N/A
Example: 10

String/Expression

N/A

Specify the minimum number of seconds the Snap must wait between two retry requests. A retry happens only when the previous attempt results in an error. 

Snap Execution

Default Value: 
Example: Validate & Execute

Dropdown list

N/A

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

Account validation failed.

The Pipeline ended before the batch could complete execution because of a connection error.

Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero so the connection is always open.