SnapLogic Read

Overview

You can use this Snap to read the specified SnapLogic asset.


SnapLogic Delete Overview

Prerequisites

None.

Limitations and known issues

When retrieving the account details, if the SnapLogic Account isn't in the same pipeline project, the SnapLogic Read Snap might incorrectly fetch details from an account with the same name from another project, even when you provide the full project path.

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap has at most one document input view.
Output This Snap has exactly one document output view.
Error

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 when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • 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.

Snap settings

Legend:
  • Expression icon (): JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Account configuration.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: SnapLogic Read

Example: SnapLogic Read1
Asset type String
Required. Select the type of asset to read. Options available include:
  • TASK
  • FLOWS
  • ACCOUNT
  • PIPELINE
  • PROJECT (used for both projects and Project Spaces)
  • SNAPLEX

Default value: ACCOUNT

Example: TASK
Asset path String/Expression

Required. Specify the absolute path for the asset in the following format:

<org>/<project_space>/<project>/<asset>

Default value: N/A

Example: /myorg/Engineering/Status/LatestDefects
Absolute Path Checkbox Select this checkbox to check the absolute path of the asset.

Default status: Deselected
Normalized Checkbox Select this checkbox to normalize the Snap output, removing all the internal information from the output artifact.

For example, if you read a pipeline without selecting this check box, you see fields such as link_serial, update_time and scrub_version, in the output artifact. The Snap appends these fields to the Snap code. However, when you select this checkbox, you see only the Snap code, with all such additional information removed.

This feature simplifies the task of running a diff between different instances of the same pipeline in different locations. For example, if the pipeline is in Development and Production Orgs, the normalized version of both would be the same.

Default status: Deselected
Snap execution Dropdown list
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.

Default value: Execute only

Example: Validate & Execute

Examples