SnapLogic Read

On this Page

Snap type:

Read


Description:

This Snap reads the specified SnapLogic Asset.


Prerequisites:

[None]


Support, limitations and Known Issues:

Works in Ultra Task Pipelines.

When retrieving account details, if the SnapLogic Account is not in the same project as the pipeline, the SnapLogic Read Snap might incorrectly retrieve details of an account with the same name from a different project, even when you specify the absolute project path.

Account: 

Accounts are not used with this Snap.


Views:
InputThis Snap has at most one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label


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.


Asset type



Required. Select the type of asset to read.

  • ACCOUNT
  • PIPELINE
  • PROJECT (used for both projects and Project Spaces)
  • TASK
  • SNAPLEX

Default value: ACCOUNT

Asset path


Required. Absolute path for the asset in the form of: /<org>/<project_space>/<project>/<asset>

Examples: /myorg/Engineering/Status/LatestDefects

Default value: [None]

Normalized

Normalizes the Snap output, removing all additional 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, scrub_version, and so on, in the output artifact. The Snap appends these fields to the Snap code. However, when you select this check box, 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 value: Deselected

Snap Execution

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.

Examples


Read Pipeline

With Asset Type set to PIPELINE and Asset Path set to a valid pipeline name in the format /<org>/<project_space>/<project>/<pipeline>, the output looks like:

Read Account

With Asset Type set to Account and Asset Path set to a valid pipeline name in the format /<org>/<project_space>/<project>/<account>, the output looks like:

Read Task

With Asset Type set to Task and Asset Path set to a valid pipeline name in the format /<org>/<project_space>/<project>/<task>, the output looks like:

The task output varies slightly depending on the type of task being read. The output includes task history. 

Snap Pack History

 Click to view/expand
ReleaseSnap Pack VersionDateTypeUpdates
February 2024main25112 StableUpdated and certified against the current SnapLogic Platform release.
November 2023main23721 StableUpdated and certified against the current SnapLogic Platform release.

August 2023

main22460

 

Stable

Updated and certified against the current SnapLogic Platform release.

May 2023main21015 StableUpgraded with the latest SnapLogic Platform release.
February 2023main19844 StableUpgraded with the latest SnapLogic Platform release.
November 2022main 18944 StableUpgraded with the latest SnapLogic Platform release.
August 2022main17386 StableUpgraded with the latest SnapLogic Platform release.

4.29

main15993

  

Stable

Upgraded with the latest SnapLogic Platform release.

4.28main14627 StableUpgraded with the latest SnapLogic Platform release.

4.27

main12833

 

Stable

Upgraded with the latest SnapLogic Platform release.
4.26main11181
 
StableUpgraded with the latest SnapLogic Platform release.
4.25main9554
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main8556
 
StableUpgraded with the latest SnapLogic Platform release.
4.23main7430
 
Stable

Upgraded with the latest SnapLogic Platform release.

4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542
StableUpgraded with the latest SnapLogic Platform release.
4.20snapsmrc535
StableUpgraded with the latest SnapLogic Platform release.
4.19snapsmrc528
Stable

The SnapLogic Read Snap now features the Normalization checkbox, which, when selected, makes Pipeline comparisons easier.

4.18snapsmrc523
Stable

Enhanced all the Snaps in this Snap Pack with the capability to create, delete, and update Snaplexes directly inside the Pipeline. This feature facilitates administrative tasks if you are running your Pipelines on a Groundplex.

4.17 PatchALL7402
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
Stable

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during the preview check box.

4.16 snapsmrc508
StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500
StableUpgraded with the latest SnapLogic Platform release.
4.14 snapsmrc490
StableUpgraded with the latest SnapLogic Platform release.
4.13snapsmrc486
StableUpgraded with the latest SnapLogic Platform release.
4.12snapsmrc480
StableUpgraded with the latest SnapLogic Platform release.
4.11snapsmrc465
Stable

Read Task output includes task history.

4.10snapsmrc414
StableUpgraded with the latest SnapLogic Platform release.
4.9snapsmrc405
StableUpgraded with the latest SnapLogic Platform release.
4.8.0snapsmrc398
Stable
  • Support for Project and Project Spaces as an Asset Type added to SnapLogic Create, SnapLogic Delete, SnapLogic Read, and SnapLogic Update. This is used for both projects and Project Spaces.

  • Support for the pipeline as an Asset Type added to SnapLogic Update.

  • Support for enabling/disabling tasks added to SnapLogic Update.

4.7snapsmrc382
StableUpgraded with the latest SnapLogic Platform release.
4.6snapsmrc362
Stable

Upgraded with the latest SnapLogic Platform release.

4.5.0snapsmrc344
Stable

Introduced in Release 4.5. This Snap Pack contains the following Snaps: SnapLogic Create, SnapLogic Delete, SnapLogic List, SnapLogic Read, SnapLogic Update.