Input 

Binary 

• Min: 1

• Max: 1

• File Reader

• Multi File Reader

• Hdfs Reader

• CSV Formatter

• JSON Formatter

Binary input document. Typically binary data as a value of the "content" key in the input document data.

Output

Document

• Min: 1

• Max: 1

• Mapper

The output view provides the binary data as a byte array value to the "content" key in the output document data. If the input binary data contains header information, the meta data in the header will be present as a value to the key "original" in the output document data. For example, connect a Salesforce Create Snap as a downstream Snap to upload an attachment to an SObject record.

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 while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

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

• Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the 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: Binary to Document
Example: Binary_to_Document

String

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.

Encode or Decode*

Default Value: ENCODE_BASE64
Example: BYTE_ARRAY 

Dropdown list

Select one of the following options to encode or decode the content. The options are:

• ENCODE_BASE64: Allows you to encode the content.

• DECODE_BASE64: Allows you to decode the content.

• DOCUMENT: Allows you to serialize the document into a SnapLogic-specific JSON representation, which allows you to deserialize types such as Dates when read back using a Binary To Document Snap.

• BYTE_ARRAY: Allows you to pass raw binary data. For example, a compressed .zip file can be created in many formats.  The safest way to convert such a file between binary and document is with BYTE_ARRAY.

• NONE: Allows you to use the Snaplex's default platform specific encoding. You can use this for string text such as a .xml or a .csv format.  Because this uses platform specific encoding, it can vary between Snaplexes; therefore, we recommend that you not to use NONE when passing data between Pipelines that may be running in Snaplexes which run different operating systems.

Ignore empty stream

Default value: Deselected
Example: Selected

Checkbox

Select this checkbox to enable the Snap to ignore the incoming data stream when no document is received in the input view.
Deselect this checkbox to enable the Snap to write empty binary data with a header in the output view when no document is received in the input view.

Snap Execution

Default Value: Validate & Execute
Example: Disabled

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

 $original.content-location

 move

 $Name

 $Id

 move

 $Id

 $original.content-type 

 move

 $ContentType

 $content

 move

 $Body

The File Reader Snap reads the binary data to be converted:

The output preview when ENCODE_BASE64 is selected:

The output preview when NONE is selected:

The output preview when DECODE_BASE64 is selected:

The output preview when DOCUMENT is selected:

The output preview when BYTE_ARRAY is selected: