Document to Binary

On this Page


You can use this Snap to transform document data into binary data. This Snap converts the value of the "content" key in the input document to a binary data at the output view

Snap Type

Document to Binary Snap is a TRANSFORM-type Snap that transforms document data to Binary type.



Support for Ultra Pipelines

Limitations and Known Issues


Snap Views



Number of Views

Examples of Upstream and Downstream Snaps




Number of Views

Examples of Upstream and Downstream Snaps






  • Min: 1

  • Max: 1

  • Structure

  • Copy

This Snap has at the max one input view which is a document data with a "content" key/value pair. The value of the "content" key should be a byte array or a string or a character array.




  • Min: 1

  • Max: 1

  • HDFS Writer

  • File Writer

The output view provides the binary data copied from the value to the "content" key in the input document data. If the input document data contains fields other than the "content" key/value pair, the input data (other than the "content") is inserted into the header part of the output binary data. One use case would be to connect Salesforce Attachment Download Snap as an upstream Snap to download a file attached to an SObject record.


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:

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

Snap Settings

  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon (): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon (): Indicates that you can add fields in the fieldset.

  • Remove icon (): Indicates that you can remove fields from the fieldset.

Field Name

Field Type


Field Name

Field Type



Default ValueDocument to Binary


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 valueENCODE_BASE64 

Dropdown list

Select if the content should be Base64 encoded or Base64 decoded or none (BYTE_ARRAY). The options are:




  • NONE


If the input "content" data has already been Base64-encoded and ENCODE_BASE64 is selected, the Snap will not encode the content again. In the same way, if the input "content" data has not been Base64-encoded and DECODE_BASE64 is selected, the Snap will not attempt to decode the content. The format option DOCUMENT allows you to serialize the document into a SnapLogic-specific JSON represenation, which allows you to deserialize types such as Dates when read back using a BinaryToDocument Snap.

BYTE_ARRAY is used 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.

When NONE is selected, the Snaplex's default platform specific encoding is used.This can be used for string text such as a .xml or a .csv format.  Because this uses platform specific encoding, it can vary between Snaplexes; therefore it is not advised to use NONE when passing data between pipelines that may be running in Snaplexes which run different operating systems.

Binary header properties

Use this fieldset to specify the properties.

  • You can access the properties in a binary document header in the expression properties of downstream Snaps. For example, a 'content-location' property added to the header in this Snap can be referenced in the File name property of a File Writer Snap with the expression: $['content-location']. 

  • If you configure the Snap to output a single binary document, the headers are computed from the first input document. 


Default value: None


Specify the value to use for a property in the binary header.

Target Path

Default value: None
Example: $['content-location'] to write the property 'content-location'.


Enter the target JSON path where the value from the expression will be written.

Snap Execution

Default ValueValidate & Execute
Example: Execute only

Dropdown list

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.


Downloading a PDF File Attached to a Salesforce Account Record

To download a PDF file attached to a Salesforce Account record, prepare a pipeline of Salesforce Attachment Download Snap + Document to Binary Snap + File Writer Snap.

  • Salesforce Attachment Download Snap: Enter an Attachment ID.

  • Binary to Document Snap: Select "[BYTE_ARRAY]" for the Encode or Decode property. (Salesforce Attachment Download Snap provides Base64-decoded content data.)

  • File Writer Snap: Enter the output file URL in the File name property.

The following pipeline reads the data in a .json format, encodes the data into a binary format and then decodes the data into output view.

The File Reader Snap reads the JSON data to be encoded to a binary format:

The Binary to Document encodes the data from the input stream, the respective output preview as displayed below:

The Document to Binary Snap decodes the data into an output preview as displayed below:


Snap Pack History