Versions Compared

Old Version 23

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version Current

changes.mady.by.user Gouri Bhagchandani

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Binary 

  • Min: 1

  • Max: 1

  • File Reader

  • Multi File Reader

  • Hdfs Reader

  • CSV Formatter

  • JSON Formatter

Any Snap with a binary output view

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

  • Any Snap with a document input view, typically a Snap which expects a binary data as a value of the "content" key in the input document data.

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

    Snap Settings

    Info

    • Asterisk (*): Indicates a mandatory field.

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

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

    • Add icon ((blue star) ): Indicates that you can add fields in the field set.

    • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

    Field Name

    Field Type

    Description

    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

    Value: ENCODE_BASE64
    Example: BYTE_ARRAY 

    Dropdown list

    Select

    if

    one of the following options to encode or decode the content

    should be encoded or decooded

    . The options are:

    • ENCODE_BASE64

    - allows

    • : Allows you to encode the content.

    • DECODE_BASE64

    - allows

    • : Allows you to decode the content.

    Info

    If the input "content" data has already been Base64-encoded and if you choose ENCODE_

    BASE64 is selected

    BASE64, the Snap does not encode the content again.

    In the same way

    Similarly, if the input "content" data has not been Base64-encoded and if you choose DECODE_

    BASE64 is selected

    BASE64, the Snap does not attempt to decode the content. 

    • DOCUMENT

    - allows

    • : Allows you to serialize the document into a SnapLogic-

    specific JSON represenation

    • specific JSON representation, which allows you to deserialize types such as Dates when read back using

    a BinaryToDocument Snap

    • a Binary To Document Snap.

    • BYTE_ARRAY

    - allows

    • : Allows you to pass raw binary data.

      For

    •  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

    • : Allows you to use the Snaplex's default platform specific encoding. You can use

    thisfor

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

    • , we recommend that you not to use NONE when passing data between

    pipelines

    • Pipelines that may be running in Snaplexes which run different operating systems.

    Info

    • This Snap can receive multiple binary streams. If you select BYTE_ARRAY in the Encode or Decode

    drop-down

    • dropdown list, then the maximum limit for each input binary stream is 2GB. This limit is much lower for other options.

    • Depending on the input data, the encoded/decoded data can become larger than 2GB, even if the input data is smaller than 2GB.

    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.

    Example

    Uploading a PDF File Attachment to a Salesforce Account Record

    To upload a PDF file attachment to a Salesforce Account record, prepare build a pipeline of Pipeline using File Reader Snap + , Binary to Document Snap + , Mapper (Data) Snap + , Structure Snap + , and Salesforce Create Snap.

    • File Reader Snap: Enter a pdf file URL in the File property.

    • Binary to Document Snap: Select "ENCODE_BASE64" for the Encode or Decode property.

    • Mapper (Data) Snap: Enter one row of "$Id" in the Target path property and an ID of an existing Account SObject record.

    • Structure Snap:  Mapping table property

    Source Path

    Operation

    Target Path

     $original.content-location

     move

     $Name

     $Id

     move

     $Id

     $original.content-type 

     move

     $ContentType

     $content

     move

     $Body

    • Salesforce Create Snap: Enter "Attachment" in the Object type property.

    The following pipeline reads the binary data from the upstream and converts it into document data in the output preview. 

    ...

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

    Image Modified

    The output preview when ENCODE_BASE64 is selected:

    Image Modified

    The output preview when NONE is selected:

    Image Modified

    The output preview when DECODE_BASE64 is selected:

    Image Modified

    The output preview when DOCUMENT is selected:

    Image Modified

    The output preview when BYTE_ARRAY is selected:

    Image Modified

    Snap Pack History