Reltio Read (Crosswalk)

The Snap is used to read Reltio objects by crosswalks.

Table 1. Reltio Read (Crosswalk)
Field Name Description
Snap type: Read
Description:

This Snap reads Reltio Objects (Entities only) from a specified Tenant by passing in a Crosswalk ID.

ETL Transformations & Data Flow

This Snap reads the 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 attributes value for each entity object (separate record for each input entity) provided.

Modes

  • Ultra pipelines: May work in Ultra Pipelines.
  • Spark (Deprecated) mode: Not supported in Spark mode.
Prerequisites:

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

An access from Reltio to merge the objects or entities from the Tenant.

Limitations and Known Issues: None at this time.
Configurations:

Account & Access

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. SeeReltio Account for information on setting up this type of account.

Views

Input
This Snap has exactly one document input view.
Output
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.
Troubleshooting:
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.

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.

Example: https://sndbx.reltio.com/reltio/api/XK178mXYr3UZrG6/

Default value: [None]

Object

Required.

The Reltio Object to be created. This is a suggestible field.

Reltio typically has four objects:

entities: Entities are objects for the representation.

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 to be processed in a single API call.

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

Default value: 50

Thread limit

Required.

Specifies the maximum number of threads for the Snap to create Reltio Objects.

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

Default value: 20

Query parameters Defines the query parameters and their values. The query parameters are attached to the URL using the http query parameter syntax, separated by & and are added as key=value pairs.
Query parameter key

It is the key used in the HTTP request for Reltio.

Default value: [None]

Query parameter value

The key value for the particular Query parameter used.

Default value: [None]

Group 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 value: Not selected

Retry limit

The maximum number of times the Snap will attempt to retrieve the response. Since Reltio uses the exponential backoff, the retry mechanism applies for HTTP Status Codes 502, 503 and 504 only and not for the HTTP Status Codes 401, 403, 404, 500.

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

Default value: 5

Maximum value: 10

See the below examples for the basic use case and typical Snap configurations for the Read (Crosswalk) operation.