Reltio Read (Object)

Reltio Read is a snap used to read Reltio objects by object ID.

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

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

ETL Transformations & Data Flow

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

Input & Output

  • Input: One input view. This view to provide the type or the value which is also suggested in the Input Schema. Only the fields marked with an asterisk ( * ) are the required inputs; all other fields are optional.
  • Output: The response contains the attributes value for each entity object provided. There is a separate response record for each input entity.

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.

The Reltio account must have sufficient access to read the objects 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. Use this format:

https://<reltio_host>/reltio/api/<tenant_id>

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

Example: https://sndbx.reltio.com/reltiotest/api/XKerg6bvb178fmuXYr3U7ZrG6/

Default value: [None]

Object

Required.

The Reltio Object to be created. This is a suggestible field. Reltio typically has three objects:

  • Entities: Entities are objects for the representation such as People,Company, and Locations.
  • 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. Depending on the business model, you can also define different types of interactions in their instance.
  • Relations: Relations define the links between entities.
Note: Reltio Read (Object) can read any of these object types. Reltio Read(Crosswalk) reads entities only.

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

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

Default value: [None]

Batch size

The number of records to be processed in a single API call.

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

Default value: 50

Thread limit

Required.

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

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

Default value: 20

Query parameters 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. For example, when Expression is disabled, the Query Parameter 'max' with the key Value '5' displays the five records of the Object on the output preview.
Query parameter key

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

Nests multiple values of the same attribute by grouping them into a single tag. If not selected, then an attribute with multiple values is displayed in two separate tags.

Default value: Not selected

Retry limit

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

The values can be passed directly or by 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 (By Object) operation.