Binary Copy

In this article

Overview

You can use this Snap to copy a binary stream to the Snap’s output views. Use this Snap if you want to send the same information to multiple endpoints.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations and Known Issues

None.

Snap Input and Output

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Binary

  • Min: 1

  • Max: 1

  • File Reader

  • S3 File Reader

  • Zip File Read

Binary input data.

Output

Binary

  • Min: 1

  • Max: ∞

  • JSON Parser

  • XML Parser

Output in binary format.

Snap Settings

Field Name

Field Dependency

Description

Field Name

Field Dependency

Description

Label*

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.

Default ValueBinary Copy
ExampleCopy Binary Data

Snap Execution

None.

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 all Snaps that are downstream from it.

Default Value: Validate & Execute
ExampleExecute only

Snap Pack History

4.26 (main11181)

  • Added Binary Copy Snap that enables you to copy a binary stream to the Snap’s output views. You can use this Snap if you want to send the same information to multiple endpoints.

4.25 (main9554)

4.24 (main8556)

  • No updates made.

4.23 (main7430)

  • Introduces a new Snap, HTTP Router Snap, that enables API developers to route multiple HTTP requests appropriately based on the request method (GET, PUT, PATCH, etc.) when executing Pipelines as Triggered Tasks.

  • Fixed the Head Snap issue by closing the output view after writing the last output document so that downstream snaps can complete, even while the Head Snap continues to consume any available input.

4.22 (422patches6648)

  • Enhances the Data Validator Snap by making the Constraint value field as optional under the Constraints.

4.22 (main6403)

  • No updates made.

4.21 Patch flow8855

  • Fixes the Binary Router Snap's failure in Ultra Pipelines by preventing a deep-copy (performing a copy of the original objects recursively) of binary data headers.

4.21 (snapsmrc542)

  • No updates made.

4.20 (snapsmrc535)

  • Adds a new Snap, Gate, which enables you to consolidate multiple input streams into a single output document where each input stream is displayed as a label containing the list of records that were received by that input view.

  • The Pipeline Execute Snap now provides the following capabilities:

    • Specify the Snaplex on which to run child Pipelines. You can now select the Snaplex on which to run the child Pipelines through the Execute On and Snaplex Path fields. The default option is executing the child Pipeline on the same Snaplex node as the Parent, but you can also specify a different Snaplex through the drop-down list, which includes the option to manually enter a Snaplex name.

    • Configure retry logic for child Pipeline executions. You can now configure retry logic for child Pipeline executions though the following fields: Number of RetriesRetry Interval, and Timeout fields.

4.19 (snaprsmrc528)

  • No updates made.

4.18 Patch flow7743

  • Added a property Validate full JSON path to the Data Validator Snap to fix an issue wherein a field validation failure against a constraint does not produce an error.

4.18 (snapsmrc523)

  • No updates made.

4.17 Patch flow7637

  • Fixed an issue with the Data Validator Snap wherein the output fails to report all but one of the violations when there are multiple constraints of the Required type.

4.17 Patch ALL7402

  • Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17 (snapsmrc515)

  • Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16 (snapsmrc508)

  • Pipeline Execute Snap: Added the capability to select either document (previously supported) or binary data (new) for your input and output Views.

4.15 Patch flow6263

  • Improved the error messages to include the source path of the constraint for data validation failures.

4.15 (snapsmrc500)

  • No updates made. Automatic rebuild with a platform release.

4.14 (snapsmrc490)

  • No updates made. Automatic rebuild with a platform release.

4.13 (snapsmrc486)

  • No updates made. Automatic rebuild with a platform release.

4.12 Patch flow4895

  • Fixed an issue in the Data Validator Snap that made multiple copies of lineage on the error path.

4.12 (snapsmrc480)

  • Resolved an issue with the Union Snap that caused excessive CPU utilization.

4.11 Patch flow4461

  • Fixed an issue with the Pipeline Execute Snap that could cause the parent pipeline to freeze when the child pipeline fails.

4.11 Patch flow4292 

  • Resolved an issue with the Union Snap in Ultra Mode that spikes the CPU utilization to ~30% during startup of 120 instances.

4.11 [snapsmrc465]

  • No updates made. Automatic rebuild with a platform release.

4.10 (snapsmrc414)

  • No updates made. Automatic rebuild with a platform release.

4.9.0 Patch flow3320

  • Data Validator Snap - fixed Type constraint feature.

4.9.0 Patch flow3094

  • Addressed an issue in Binary Router where the Snap did not wait until all threads completed to write data to the output views.

4.9 (snapsmrc405)

  • No updates made. Automatic rebuild with a platform release.

4.8.0 (snapsmrc398)

  • Filter: Snap-aware error handling policy enabled for Spark mode. This ensures the error handling specified on the Snap is used.

4.7.0 Patch flow2598

  • Addressed a possible race condition when reusing pipelines with a Pipeline Execute Snap.

4.7.0 Patch flow2297

  • Fixed an issue with Ultra pipeline when invoking, using Pipeline Execute, a child pipeline that contains a non-Ultra compatible Snap.

4.7.0 (snapsmrc382)

  • Recommendation: The Pipeline Execute Snap is meant to eventually replace ForEach and Task Execute. It is suggested you use Pipeline Execute for all new pipelines and update existing pipelines at your earliest convenience.

  • Updated the Pipeline Execute Snap with Execute during preview field.

4.6.0 Patch flow1909

  • Resolved an issue with Union Snap slowing down pipelines.

4.6.0 (snapsmrc362)

  • The following Snaps now support error view in Spark mode: Copy, Union.

  • ForEach: The value for the Maximum instances property is limited to a maximum of 100. A value higher than 100 will automatically be limited down to 100 during pipeline execution.

  • Pipeline Execute: Snaplex property added to let you specify the Snaplex on which to run the child pipeline.

  • Resolved an issue in Task Execute Snap that caused an internal server error (status code: 500).

  • Resolved an issue in Pipeline Execute Snap that did not show parameter suggestions when the pipeline is selected from another project.

  • Resolved an issue in Copy Snap that showed errors on the UI while the Javascript was being executed.

  • Resolved an issue in Filter Snap that failed with "could not filter the document" if upstream data for ServiceNow Query.

4.5.1 (flow1574)

  • Resolved an issue with Pipeline Execute not able to load pipeline selected from the pipeline picker property.

  • Enhanced error handling in Pipeline Execute for when Reuse is enabled and the pipeline path is an expression whose result is not constant.

  • Resolved an issue in Pipeline Execute not including the runtime ID and state in error documents.

4.5.0 (snapsmrc344)

  • NEW! Pipeline Execute introduced in this release. This Snap provides a way to flexibly and efficiently execute pipelines and flowing documents into and out of these executions.

  • Resolved an issue in Task Execute Snap to ensure JAVA 7 and JAVA 8 Snaplex give the same output.

  • Resolved an issue with the Router Snap routing to the wrong output when used in Spark mode.

4.4.0

  • Resolved an issue with Exit Snap hanging during validation if threshold is not met.

  • Spark support added to the Copy, Filter, Router, and Union Snaps.

4.3.2

  • Resolved an issue with Task Execute where java.math.BigInteger cannot be cast to java.lang.String exception if input document variable was a numeric type.

  • Resolved an issue with Task Execute failing with expression enabled.

  • Resolved an issue with data preview not working in the ForEach Snap.

  • Resolved an issue with Execute during Preview functionality broken in the ForEach Snap.

  • Resolved an issue with ForEach Snap not representing the output schema correctly during preview.

4.3.1

  • Resolved an issue with the ForEach poll interval being inconsistent.

4.3.0

  • In Data Validator, the pattern option now works with partial matches.

  • Exit Snap 

    • Error handling improved to handle messages that are non-strings.

    • Exit Snap now supports expressions in the Exit error message property.

  • ForEach Snap now generates output documents when run. Output documents will also be produced if a child pipeline called by the ForEach is manually stopped.

4.2.2

  • Resolved an issue in ForEach where a recursive pipeline in synchronous mode was unable to finish execution.

  • Resolved an issue in Data Validator not working for partial matches.

August 7, 2015 (2015.25/4.2.1)

  • NEW! Exit Snap introduced in this release. This Snap forces a pipeline to stop with a failed status if it receives more records than the user-defined threshold.

  • Resolved error in ForEach Snap where an exposed error view triggered a pipeline failure.

June 27, 2015 (2015.22)

  • The Router Snap now supports even distribution across all output views if no expressions are defined. With this change, Routes is no longer a required field.

June 6, 2015 (2015.20)

  • Task Execute should have Execute on preview

  • Directory Browser Snap did not render output data when running from "Windows" Groundplex.

May 15, 2015

  • ForEach: Error was not thrown on validation if the child pipeline was not provided.

May 2, 2015

  • Binary Router: enhanced error handling

  • Filter: bug fixes

  • Router: bug fixes

December 20, 2014

Updated Snaps may include new or changed functionality or be otherwise improved.

  • Data Validator: Type constraint added.

  • Union Snap: Preserve order was removed.

  • ForEach

July/Summer 2014

  • NEW! Binary Router Snap introduced in this release.

  • NEW! Task Execute Snap introduced in this release.

June 30, 2014

  • Data Validator (Beta Release). This Snap validates incoming documents and their attributes against constraints you define.

  • ForEach: Addressed an issue with parallel execution not working properly.

April 2014

  • ForEach Snap updated to support Snaplex selection and pipeline parameters.

January 2014

  • NEW! ForEach Snap introduced in this release.

November 2013

  • NEW! Head Snap introduced in this release.

  • NEW! Tail Snap introduced in this release.

Initial Release (June 2013)

  • Router Snap introduced in this release.

  • Copy Snap introduced in this release.

  • Union Snap introduced in this release.

  • Filter Snap introduced in this release.


See Also

https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary

https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1438341/Getting+Started

https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1439233/Glossary