Reltio Read (Object)

Overview

The Reltio Read (Object) Snap reads the Reltio objects from a specified Tenant.

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

  • 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.

This view provides 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

This Snap has exactly one document output view.

The response contains the attributes value for each entity object provided. There is a separate response record for each input entity.
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 (Object)
Tenant URL*

String/Expression		 Specifies the Reltio host with Tenant ID. Use this format: https://<reltio_host>/reltio/api/<tenant_id>
Note: The values can be passed directly or by using the pipeline parameters, but not through the upstream Snap.

Default value: N/A

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

String/Expression/ Suggestion		 The Reltio object to be read. This is a suggestible field. Reltio typically has four 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.

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

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

Default value: N/A

Example: Entities
Object Types*

String/Expression/ Suggestion		 The suggestible field provides options to choose an object type for a particular Object. The suggestion works only when a valid Account, Tenant URL and Object are provided.

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

Default value: N/A
Object Id

String/Expression		 The object ID describes the part of 'uri' of the Reltio API response.

For example: "uri": "entities/abcd1234" is a part of Reltio Object (Entity here) so abcd1234 is the Object Id (Entity Id here). In Reltio UI, it says like "Entity ID" in profile of each Entity Object.

This is either being taken from upstream or pipeline parameters.

Default value: N/A

Example: abcd1234
Records to Read

Dropdown list		 Specifies the number of records to read from an object. The available options are:
  • Up to 200 records: The Snap retrieves records up to 200 from the specified Reltio object/object type.
  • All records: The Snap retrieves all the records from the specified object/object type (except "interactions" object).

Default value: Up to 200 records
Page Size

Integer/Expression		 Conditional. Specifies the page size to be set for the Reltio read functionality. This property is applicable only when the option, All records is selected on Records to Read property for Relations object. The Snap sets the pagination for the records in the Relations object. The values can be passed using the pipeline parameters or via the upstream Snaps.

Minimum value: 1

Maximum value: None

Default value: 100
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. 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

String/Expression		 Specifies the key used in the HTTP request for Reltio.

Default value: N/A

Example: max
Query parameter value

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

Default value: N/A

Example: 5
Group

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

Integer/Expression		 Specify the maximum number of attempts to get the response.

Minimum value: 1

Maximum value: 10

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

Default value: 5
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