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 Execution


Anaplan Read

Select one of the following three modes in which the Snap executes:

  • 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 ValueExecute only
Example: Validate & Execute

Snap type:Read
Description:

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

Input & Output

  • Input
    There should be one input view to provide the Object type or the values which are also suggested in the Input Schema. The fields marked in (*) only are the required inputs. Others are optional.
  • Output:
    Response contains the attribute values for each entity object (separate record for each input entity) provided.

Modes

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 and Known Issues:

None at this timeYou cannot roll back the productized Reltio Snap Pack in 4.20 to a prior version.

Configurations:

Account and Access

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


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: None at this time.

Settings

Label

Required. The name of 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 https://<reltio_host>/reltio/api/<tenant_id> 

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

Examplehttps://test.reltio.com/reltiotest/api/XKiqdracb178fmuXYr3U7ZrG6/

Default value: [None]

Object

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

Batch size

Insert excerpt
Reltio Create
Reltio Create
nopaneltrue

Thread limit

Insert excerpt
Reltio Delete (Object)
Reltio Delete (Object)
nopaneltrue

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

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

 Default value: [None]

Query parameter value

It is the key value for the particular Query parameter used.

Default value: [None]

Group

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

Retry limit

Insert excerpt
Reltio Bulk Export
Reltio Bulk Export
nopaneltrue

Multiexcerpt include macro
name
pageAnaplan Read
Multiexcerpt include macro
nameSnap_Execution_Introduced
page


Examples

Basic Use Case


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

In the screenshot below, the Reltio Read (Crosswalk) Snap uses input view to provide the Object type or the values that are also suggested in the input schema of the upstream Snap. The Query parameters are left empty to retrieve all the records from the sources specified in the Tenant URL and Object fields.


The Mapper Snap provides the values for the type and value on the Object.

The successful execution of the pipeline displays the below output preview:

Typical Snap Configurations


The key Snap configurations for the Snap are:

Without Expressions

Since the Snap requires the input documents from the upstream, the values are directly provided within the Snap:


The upstream Snap provides the values to be read from the specified entity. The expression values are provided dynamically using the pipeline parameters:

The values as set on the pipeline parameters:

Advanced Use Case


The following describes a pipeline, with a broader business logic involving multiple ETL transformations. The Reltio Create, Read (Crosswalk) and  Update Snaps create, read and update the messages respectively as received form the SQS messaging instance. The pipeline download is available in the Downloads section.

  

The ETL transformations:

  • Extract: The SQS Consumer Snap consumes the messages from the SQS Messaging instance.
  • Transform: The JSON Parser Snap transforms the records into the JSON format and the Mapper Snap maps the object for the messages to be created on the Reltio console.
  • Load: The  Reltio Create Snap creates the entity for the messages. 

The other ETLs involved are:

  • Extract: The Reltio Read (Crosswalk) Snap reads the messages from the instance.
  • Transform: The JSON Splitter Snap splits the records to be mapped using a Mapper Snap for the records to be updated on the Reltio instance.
  • Load: The Reltio Update Snap updates the required records on to the Reltio object.


Downloads

Multiexcerpt include macro
namedownload_instructions
pageOpenAPI


Attachments
patterns*slp, *zip
     


Insert excerpt
Reltio Snap Pack
Reltio Snap Pack
nopaneltrue