Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:Read
Description:

This Snap reads the Reltio objects from a specified Tenant.

ETL Transformations & Data Flow

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

Input & Output

  • InputOne input view. This view to 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: The response contains the attributes value for each entity object provided. There is a separate response record for each input entity.
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:
  • Works in Ultra Task Pipelines.
  • You cannot roll back the productized Reltio Snap Pack in 4.20 to a prior version.
Configurations:

Account & Access

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

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: 

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>

Note

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

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

Default value: [None]

Object

Required. 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: [None]

Object Types

Required. 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: [None]

Object Id

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: [None]

Records to Read

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

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. The minimum value may be 1 and there is no upper bound for this property.

Minimum value: 1

Maximum value: None

Default value: 100

Query parametersDefines 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

Specifies the key used in the HTTP request for Reltio.

 Default value: [None]

Query parameter value

Specifies 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

Excerpt Include
Reltio Bulk Export
Reltio Bulk Export
nopaneltrue

Multiexcerpt include macro
nameSnap Execution
pageAnaplan Read

Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read


Basic Use Cases


1. The Reltio Read (Object) Snap with Pagination Settings

In this pipeline, the Reltio Read (Object) reads the objects from Relations, with a page size of 100, and of records Up to 200. Additionally, the JSON Splitter Snap splits the records based on the  specified split value.

2. The Reltio Read (Object) Snap Functioning as a Standalone Snap in a Pipeline

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



Typical Snap Configurations


The key Snap configurations are:

Without Expressions

The values are directly passed into the Snap:

With Expressions

  • Query from Upstream
    In the Snap settings shown below, the ID value is passed using an upstream Snap: 

Pipeline Parameter
In the configuration shown below, the values (Tenant URL, Object and Object types) are passed using the pipeline parameters:

 

The values as set in the Pipeline parameters:

Downloads


Attachments
patterns*slp, *zip
   

Excerpt Include
Reltio Snap Pack
Reltio Snap Pack
nopaneltrue