Snap Settings Dialog

This page is no longer maintained (Jul 12, 2023). For the most current information, go to https://docs.snaplogic.com/snaps/snap-settings-dialog.html.

In this page

Overview

The Snap settings dialog enables you to configure the settings required to design your pipeline. Click on the Snap to open the Snap dialog. To hide the dialog, click the Snap again or the icon. Most Snap dialogs include the tabs listed in the table below. Let's take the File Reader Snap as an example to illustrate. For detailed instructions on configuring a specific Snap, click the Help icon on the Snap Settings dialog.

Tabs

The Snap settings are available under different tabs described in this section. It includes the following tabs:

Settings: Use 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 Snap's input, output, and error views. Refer to 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

Description

Icon

Description

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