Reltio Read (Crosswalk)

On this Page

Snap type:Read
Description:

This Snap reads Reltio entities from a specified Tenant. For information on using Reltio objects other than entities (interactions, relations, and categories,) see Reltio Read (Object).

ETL Transformations and Data Flow

This Snap reads data from the Reltio Object and Object Type.

Input & Output

  • Input
    There should be one input view to provide the Object type or the values which are also suggested in the Input Schema. The fields marked in (*) only are the required inputs. Others are optional.
  • Output:
    Response contains the attribute values for each entity object (separate record for each input entity) provided.

Modes

Prerequisites:

A valid Reltio account with the Tenant ID for the Tenant URL, or an  API key for the account settings to be generated.

Access in Reltio to read objects and entities from the Tenant.

Limitations and Known Issues:

You cannot roll back the productized Reltio Snap Pack in 4.20 to a prior version.

Configurations:

Account and Access

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Reltio Account for more information.


Views

InputThis Snap has exactly 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.
Troubleshooting: None at this time.

Settings

Label

Required. The name of the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Tenant URL

Required. Specifies the Reltio host with Tenant ID. The format used is https://<reltio_host>/reltio/api/<tenant_id> 

The values can be passed directly or using the pipeline parameters but not through the upstream.

Examplehttps://test.reltio.com/reltiotest/api/XKiqdracb178fmuXYr3U7ZrG6/

Default value: [None]

Object

Required. The Reltio Object to be created. You can either enter a valid object name or select an object from the suggestions displayed. 

Reltio typically has four objects:

  • entities: Entities are objects for the representation.

    In the current version, Reltio API only supports entities, and other object types will be supported when the functions are available in Reltio APIs. For information on using Reltio objects other than entities (interactions, relations, and categories,) see Reltio Read (Object).

  • categories: Entities are structured under the Categories. An entity can belong to multiple categories.
  • interactions: Interactions are the actions between two or more entities that have an impact on one another. For example: email is an interaction that sends emails to one one or several entities. One can also define different types of interactions in their instance depending on the business model.
  • relations: Define the links between entities.

The suggestion works only when the valid account or the Tenant URL is provided.

The values can be passed directly or using the pipeline parameters.

Default value: [None]

Batch size

Specifies the number of records that you want the Snap to process in a single API call.

Default value: 1

Minimum value: 1

Maximum value: 2,147,483,647


This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter. 

Thread limit

Required. Specifies the maximum threads of this Snap to delete the Reltio Objects.

Minimum value: 1

Maximum value: 50

Default value: 20

This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter. 

Query parameters

Specify query parameters and their values. Use the http query parameter syntax to attach query parameters to the URL, separating each parameter using an '&'.

Query parameter

Specify the key to be used in the HTTP request for Reltio.

 Default value: [None]

Query parameter value

It is the key value for the particular Query parameter used.

Default value: [None]

Group

This value indicates whether or not to nest the values of same attributes. If not selected, then an attribute having multiple values will be shown in two different tags else it will be grouped in a single tag.

Default valueNot selected

Retry limit

Specify the maximum number of attempts to get the response. 

Minimum value: 1
Maximum value: 10

Default Value: 5

You can provide this value dynamically as a Pipeline parameter or directly in the Snap, but not as an upstream value. 

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

Basic Use Case


The following pipeline describes how the Snap functions as a standalone Snap in a pipeline:

In the screenshot below, the Reltio Read (Crosswalk) Snap uses input view to provide the Object type or the values that are also suggested in the input schema of the upstream Snap. The Query parameters are left empty to retrieve all the records from the sources specified in the Tenant URL and Object fields.


The Mapper Snap provides the values for the type and value on the Object.

The successful execution of the pipeline displays the below output preview:

Typical Snap Configurations


The key Snap configurations for the Snap are:

Without Expressions

Since the Snap requires the input documents from the upstream, the values are directly provided within the Snap:


The upstream Snap provides the values to be read from the specified entity. The expression values are provided dynamically using the pipeline parameters:

The values as set on the pipeline parameters:

Advanced Use Case


The following describes a pipeline, with a broader business logic involving multiple ETL transformations. The Reltio Create, Read (Crosswalk) and  Update Snaps create, read and update the messages respectively as received form the SQS messaging instance. The pipeline download is available in the Downloads section.

  

The ETL transformations:

  • Extract: The SQS Consumer Snap consumes the messages from the SQS Messaging instance.
  • Transform: The JSON Parser Snap transforms the records into the JSON format and the Mapper Snap maps the object for the messages to be created on the Reltio console.
  • Load: The  Reltio Create Snap creates the entity for the messages. 

The other ETLs involved are:

  • Extract: The Reltio Read (Crosswalk) Snap reads the messages from the instance.
  • Transform: The JSON Splitter Snap splits the records to be mapped using a Mapper Snap for the records to be updated on the Reltio instance.
  • Load: The Reltio Update Snap updates the required records on to the Reltio object.


Snap Pack History

 Click to view/expand
Release Snap Pack VersionDateType  Updates
4.27427patches12999 Latest

Enhanced the Reltio Generic Execute with a new field Empty Responses as Separate Documents, that enables the Snap to write empty responses as separate documents.

4.27main12833StableUpgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10410 LatestFixed an issue with the Reltio Create Snap where the Snap processes a lesser number of documents while loading data into Reltio.
4.25main9554
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main8556
StableUpgraded with the latest SnapLogic Platform release.
4.23main7430
 
StableUpgraded 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.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18snapsmrc523
 
StableUpgraded with the latest SnapLogic Platform release.
4.17ALL7402
 
Latest

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

4.17snapsmrc515
 
Latest

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

4.16 Patch reltiosnapconnector6773 Latest

Fixed an issue with the Reltio Generic Execute Snap wherein response codes were handled incorrectly.

4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
Stable

New Snap added: Reltio Generic Execute.

4.13 Patch reltiosnapconnector5200 Latest
  • Fixed the Reltio Read (Object) Snap to fetch all the records from Reltio objects (entities, categories, and relations, except interactions).
  • Added two new properties -- "Page Size" and "Records to Read" in the Read (Object) Snap.
4.13

snapsmrc486

 
Stable
  • Added a new property, S3 File, to the Reltio Bulk Export Snap to support exporting data to the specified S3 location.
  • Added new properties Batch size, and Thread limit to the Reltio Delete (URI) and Reltio Delete (Object) Snaps to enhance the performance.
4.12

snapsmrc480

 
Stable

Introduced the Snap Pack this release. The Snap Pack includes: Reltio Bulk Export, Reltio Create, Reltio Delete (Object), Reltio Delete (URI), Reltio Merge, Reltio Read (CrossWalk), Reltio Read (Object), Reltio Unmerge and Reltio Update.