On In this Pagearticle
|Table of Contents|
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.
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 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 icon on the Snap Settings dialog.
|Settings||Use the Settings tab to configure the Snap.|
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.
Use the Views tab to configure the input, output, and error views of the Snap.
See Configuring Snap Views for more information.
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).
PopupSnap popups typically display the following icons:
Icons in a Snap Settings
|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.|
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:
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, 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.
To configure input and output views for a Snap: