Versions Compared

Old Version 2

changes.mady.by.user Aparna Tayi

Saved on

compared with

New Version 3

changes.mady.by.user Aparna Tayi

Saved on

Key

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


Snap type:Read
Description:

This Snap reads the Reltio Objects (Entities only) from a specified Tenant.

ETL Transformations & Data Flow

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

Input & Output

  • Input: 
    There should be one input view where we need to provide the type or the value which is also suggested in Input Schema. Only the fields marked in * are the required inputs. Others are mandatory.
  • Output:

     

Response

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

The format used is 

Use the format, https://<reltio_host>/reltio/api/<tenant_id>.

  


Note

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

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

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

Note

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.

Note

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.

Note

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

Default value: 20

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

This value indicates whether or not to nest the values of the same attributes. If not selected, then an attribute having multiple values is displayed in two different tags else it will be grouped in a single tag.

Default value: Not selected

Retry limit

Determines the maximum number of attempts to retrieve the response. Since Reltio uses the exponential backoff, the retry mechanism applies for HTTP Status Codes 502, 503 and 504 only and does not apply for the HTTP Status Codes 401, 403, 404, 500.

Note

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

 Default value: 5

Maximum value: 10


Basic use Case

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

Image Added

Image Added

Typical Snap Configurations

The key Snap Configurations are:

  • With Expressions
    •  Query from Upstream

In the below Snap settings, the values are passed using an upstream Snap: 

Image Added

  Image Added


  •  Pipeline Parameter

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

 Image Added


The values as set in the Pipeline parameters:

Image Added

Downloads

Attachments
patterns*slp, *zip
   

Insert excerpt
Reltio Snap Pack
Reltio Snap Pack
nopaneltrue