Snap Reference

In this article

Overview

Snaps are the building blocks of a Pipeline. Each Snap performs a single function, such as read, write, or update data. You can view the Snaps available to you (or your account) in the Snap Catalog, on the left-hand side of the SnapLogic Designer. You can drag a Snap from the Snap Catalog on to the Canvas to use it in a Pipeline.

By default, the Snap Catalog contains a set of core Snaps available to all users. You can add premium or custom Snaps by installing them in Manager on the project-level Snap Packs page.

  • To see which version of a Snap Pack is in use, see the org-level Snap Packs page.
  • To learn how to develop Snaps for the SnapLogic Intelligent Integration Platform, see our Developer Documentation.

Snap Settings Dialog

Click on the Snap to open the Snap dialog. To hide the dialog, click on the Snap again, or click the  icon. You can configure the various settings that are available under the tabs. Most Snap dialogs have some–or all–of the tabs listed in the table below. For illustration, we have taken the File Reader Snap as an example For detailed information on configuring a specific Snap, click the Help  icon on the Snap Settings dialog.

Tab
Purpose
Image
SettingsUse the Settings tab to configure the Snap.

Account

Use the Account tab to create and store the account details that the Snap will need to access external resources that need authorization.

Refer to Accounts and the individual Snap account documentation for details.

Views

Use the Views tab to configure the input, output, and error views of the Snap.

See Configuring Snap Views for more information.

Info

Use the Info tab to add notes to the Snap. These notes can help other users understand the role of the Snap in the Pipeline. 

The Info tab also displays the Title, Purpose, Developer, and Class FQID (fully-qualified ID of the class that contains the Snap's functionality). 


Icons in a Snap Settings Dialog

Icon
Desscription

Access help associated with the Snap.

Maximize the Snap popup. This gives you more space to enter and view the detailed configuration strings more easily.

Remove the Snap from the Pipeline.

Save the changes made to the Snap settings.

Close the popup. 

Configuring Snap Views

Using Snap views you can configure the number of input and output documents that the Snap can support. You can also configure the Snap behavior in case of any error during the Snap execution. Every Snap contains the following views:

  • Error: Enables you to configure the error view of the Snap

  • Input: Enables you to specify the number of input views you want the Snap to have

  • Output: Enables you to specify the number of output views you want the Snap to have

Configuring Error Views

You can configure error views for every Snap you use in a Pipeline. Error views enable you to decide how the Snap must behave in case of an error during the Snap execution. Learn more, Handling Errors with an Error Pipeline.

By default, the error view of all Snaps is set to Stop pipeline execution. To configure error views for a Snap, click the When errors occur dropdown list and select one of the following options:

  • Stop pipeline execution: Stops Pipeline execution at the occurrence of an error.
  • Discard error data and continue: Discards any error data and continues with Pipeline execution.
  • Route error data to error view: Routes all error data to the error view of the Pipeline execution statistics.

Configuring Input and Output Views

You can configure input and output views for every Snap that you use in a Pipeline.

  • Input views help you define the number of inputs that a Snap can accept

  • Output views help you define the number of outputs that a Snap can generate

  • Views that are represented by a circle indicate that the Snap processes document data.

  • Views that are represented by a diamond indicate that the Snap processes binary data.

  • Min and Max values for a view list the minimum and the maximum number of views that can be configured for that particular Snap. If the Max value for a view is 0, then you cannot configure that view for the Snap. For example, if the input view has Min and Max both as 0, the Snap cannot be configured to have any input views.

To configure input and output views for a Snap:

  1. Go to Input or Output and click +.
    The selected view is added under Name.

  2. Update the name that you want to use for the view.

  • If the Snap supports more than one input or output view, you can click + to add more views till you reach the limit.

  • To remove an input or output view, click - next to the view name. To remove all views of a specific type, click - next to the Name header.