Input 

Document

• Min: 0

• Max: 1

JSON Generator

This Snap has at most one document input view.

Output

Document

• Min: 1

• Max: 1

Mapper

This Snap has exactly one document output view.

Error 

This Snap has at most one document error view and produces zero or more documents in the view.

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:

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

Label

String

N/A

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

Depth

Default value: minimal

Dropdown list

N/A

The depth or level of detail returned. The options available include:

• minimal (entity name, type, ID, date created, date last updated, date last accessed)

• partial (All of the entity's properties are returned and if the entity is related to other objects, those entities are returned at minimal depth.)

• complete (All of the entity's properties are returned and all related entities are returned at complete depth.)

ID

Default value: [None]

String

N/A

Required. An identifier for the entity.

Additional parameters

Default value: minimal

Use this field set to define additional parameters.

N/A

A table that contains name-value pairs for custom parameters.

Pass through

Default Value: Deselected

Checkbox

N/A

Select this checkbox to enable the Snap to pass the input document to the output view under the key original.

Snap Execution

Dropdown list

N/A

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.