Reltio Read (Crosswalk)

Overview

The Reltio Read (Crosswalk) 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.

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

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

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has exactly one document input view.
Output

This Snap has exactly one document output view.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label

String

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: Reltio Read (Crosswalk)
Tenant URL*

String/Expression		 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.

Default value: N/A

Example: https://test.reltio.com/reltiotest/api/XKiqdracb178fmuXYr3U7ZrG6/
Object*

String/Expression/ Suggestion		 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.
    Note: 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 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: N/A

Example: entities
Batch size

Integer/Expression		 Specifies the number of records that you want the Snap to process in a single API call.
Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Default value: 1

Example: 100
Thread limit*

Integer/Expression		 Specifies the maximum threads of this Snap to delete the Reltio Objects.
Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Minimum value: 1

Maximum value: 50

Default value: 20

Example: 10
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

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

Default value: N/A

Example: filter
Query parameter value

String/Expression		 It is the key value for the particular Query parameter used.

Default value: N/A

Example: equals(attributes.FirstName,'John')
Group

Checkbox		 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 value: Deselected
Retry limit

Integer/Expression		 Specify the maximum number of attempts to get the response.
Note: You can provide this value dynamically as a Pipeline parameter or directly in the Snap, but not as an upstream value.

Minimum value: 1

Maximum value: 10

Default value: 5

Example: 3
Snap execution

Dropdown list
Choose 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