Reltio Generic Execute

In this article

Overview

The Reltio Generic Execute Snap allows you to perform Read, Write, Update and Delete operations upon objects in the specified Reltio tenant by executing REST APIs (GET, PUT, POST, and DELETE). The API key that you specify in the Account settings determines the API calls that you can make. 

Prerequisites

Reltio account with a valid Tenant ID so that Tenant URL can be formed/API for Account settings. Also, the Reltio account must have appropriate read and write access to create objects in the Tenant.

Support for Ultra Pipelines  

Works in Ultra Pipelines

Limitations and Known Issues

  • You cannot roll back the productized Reltio Snap Pack in 4.20 to a prior version.

Snap Input and Output

Input/OutputType of ViewNumber of viewsExamples of upstream/downstream Snaps
InputDocument
Min: 0
Max: 1
  • JSON Generator
  • JSON Formatter
OutputDocument
Min: 1
Max: 1
  • Mapper 
  • Copy

Snap Settings

FieldField TypeDescription
Label*StringSpecify the name for the Snap. Modify this to be more specific, especially if there are more than one of the same Snap in the Pipeline.
Service URL*String

Specify the service URL in the format: .

The format to be followed:

  • For performing an operation on all objects of an object type: https://www.reltio.com/tenant_id/object_type
  • For performing an operation on specific object in an object type: https://www.reltio.com/tenant_id/object_type/object_id
  • For performing an operation on crosswalks related to an object: https://www.reltio.com/tenant_id/object_type/entity_id/crosswalks

Default Value{tenantUrl}/{serviceUri}
Example{tenantUrl}/{serviceUri}

HTTP Method*Dropdown list

Select the type of HTTP request.

  • Get
  • Post
  • Put
  • Delete

Default Value: Get 
Example: Post

HTTP Request BodyString

Specify the HTTP body of the request. Relevant to post request.

You can provide this value dynamically as a Pipeline parameter and upstream parameter or directly in the Snap.

Default Value: [None] 

Query parameters

Use this field set to define query parameters and their values. The query parameters are attached to the URL using the HTTP query parameter syntax, separated by & and added as 'key=value'.

You can provide the parameters dynamically as Pipeline parameters or directly in the Snap, but not as upstream values.

Query parameterString

Specify the name of the query parameter to pass in the API.

Default Value: [None]
Example: type

Query parameter valueString

Specify the value for the specified query parameter.

Default Value: [None]
Example: reltio

Raw data

Checkbox

Select this checkbox to write the HTTP response content to the output view as it is. If you deselect this checkbox, the data is parsed according to content type. 

Default Value: Deselected


Empty Responses as Separate DocumentsCheckbox

Select this checkbox to write all responses into separate output documents in the same order as they appear in the request body.

Deselect this checkbox to group all empty responses into one output document.

When you fetch multiple entities with POST {TenantURL}/entities/_byUris, the non-existing entities result in empty-string responses.

Default Value: Deselected

Retry limitInteger

Specify the maximum number of attempts to get the response. 
Minimum value: 1
Maximum value: 10

Default Value: 5

Snap Execution

Dropdown list

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

Examples


GET

The Pipelines below demonstrates how the Reltio Generic Execute Snap can be used to read Reltio objects and Crosswalks. Based on the Snap's configuration you can either read one or all objects of a type. All four pipelines are included in one file and can be downloaded from the Downloads section below.

 Read by object type

This pipeline shows how all entities can be read from the specified tenant URL and the data sent downstream for further processing. The pipeline is as shown below:

The Reltio Generic Execute Snap is configured as shown below: 

 

An output preview of of the Snap's execution is as shown below, it lists details of all the entities in the tenant:

 Read by object ID

To retrieve details of a specific entity, the Service URL property will have to be configured to include the entity ID in question. The pipeline is as shown below:

The Reltio Generic Execute Snap is configured as shown in the screenshot below, the configuration is the same as that in the above example with the only difference being that the Service URL includes the entity ID.

An output preview of of the Snap's execution is as shown below, it lists details of the specified entity:

 Read by object ID using Pipeline Parameters

This pipeline demonstrates the Reltio Generic Execute Snap accepting Pipeline Parameters:

 

The Pipeline Parameter is configured as shown below:

The Reltio Generic Execute Snap is configured as shown below, the value for the Service URL property is passed as a Pipeline Parameter:

 

An output preview of of the Snap's execution is as shown below, it lists details of the specified entity:

 Read crosswalks

The same Pipeline shown in the example above can be modified to show crosswalk data for a specified entity. This is demonstrated in the Pipeline below:

The Reltio Generic Execute Snap is configured as shown in the screenshot below:

An output preview of of the Snap's execution is as shown below, it lists details of the crosswalks related to the specified entity:

Downloads

Important steps to successfully reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

  File Modified

File Example_Reltio Generic Execute_ GET.slp

Mar 09, 2022 by Subhajit Sengupta


Snap Pack History

 Click to view/expand
Release Snap Pack VersionDateType  Updates
4.29main15993 StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.
4.27 Patch427patches12999 Latest

Enhanced the Reltio Generic Execute with a new field Empty Responses as Separate Documents, that enables the Snap to write empty responses as separate documents.

4.27main12833StableUpgraded with the latest SnapLogic Platform release.
4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10410 LatestFixed an issue with the Reltio Create Snap where the Snap processes a lesser number of documents while loading data into Reltio.
4.25main9554
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main8556
StableUpgraded with the latest SnapLogic Platform release.
4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18snapsmrc523
 
StableUpgraded with the latest SnapLogic Platform release.
4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
Latest

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16 Patch reltiosnapconnector6773 Latest

Fixed an issue with the Reltio Generic Execute Snap wherein response codes were handled incorrectly.

4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
Stable

New Snap added: Reltio Generic Execute.

4.13 Patch reltiosnapconnector5200 Latest
  • Fixed the Reltio Read (Object) Snap to fetch all the records from Reltio objects (entities, categories, and relations, except interactions).
  • Added two new properties -- "Page Size" and "Records to Read" in the Read (Object) Snap.
4.13

snapsmrc486

 
Stable
  • Added a new property, S3 File, to the Reltio Bulk Export Snap to support exporting data to the specified S3 location.
  • Added new properties Batch size, and Thread limit to the Reltio Delete (URI) and Reltio Delete (Object) Snaps to enhance the performance.
4.12

snapsmrc480

 
Stable

Introduced the Snap Pack this release. The Snap Pack includes: Reltio Bulk Export, Reltio Create, Reltio Delete (Object), Reltio Delete (URI), Reltio Merge, Reltio Read (CrossWalk), Reltio Read (Object), Reltio Unmerge and Reltio Update.