Versions Compared

Key

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

On In this Pagearticle

Table of Contents
maxLevel2
absoluteUrltrue
excludeAdditional Resources|Related Links|Related Information

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.

...

Info
  • 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 Elastic Intelligent Integration Platform, see our Developer Documentation.

...

Snap Settings

...

Dialog

Click on the Snap to open the Snap popup. The Snap popup enables you to configure the various settings associated with the Snap. To hide the popupdialog. To hide the dialog, click on the Snap again, or click the Image Modified icon. You can configure the various settings that are available under the tabs. Most Snap popups dialogs have some–or all–of the tabs listed in the table below. For illustration, we have taken the File Reader Snap as an exampleexample For detailed information on configuring a specific Snap, click the Help Image Added icon on the Snap Settings dialog.

For detailed information on configuring a specific Snap, click the Image Removed icon on the Snap Settings popup.

Image Removed1Image RemovedImage Removed1
Tab
Purpose
ScreenshotImage
SettingsUse the Settings tab to configure the Snap.

Image Removed1

Image Added

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.

Image Added

Views

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

See Configuring Snap Views for more information.

Image Added

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

Image Added


Icons in a Snap Settings

PopupSnap popups typically display the following icons:

Dialog


Icon
Click toDesscription

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. 


Anchor
Views
Views
Configuring Snap Views

This section helps you understand how to configure Snap views. Using Snap views enable you to 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 offers 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

...

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. Image RemovedLearn more, Handling Errors with an Error Pipeline.

Image Added

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, field 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.Stop pipeline execution: Stops Pipeline execution at the occurrence of an error.

Anchor
IO
IO
Configuring Input and Output Views

...

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

Image RemovedImage Added

To configure input and output views for a Snap:

...