Reltio Delete (Object)

On this Page

Snap Type:Write
Description:

This Snap deletes records associated with Reltio objects (Entities/ Relations/ Categories) from the mentioned Tenant. It also supports the bulk operation by using the Bulk Delete functionality. This Snap cannot be used for deleting Interactions because transaction-based data cannot be deleted.

ETL Transformations & Data Flow

The Reltio Delete (Object) Snap extracts (or deletes) the corresponding data from the Reltio Tenant. 

Input & Output

  • InputInput view is optional and is required only to pass the Object ID from the upstream Snap or value in that field.
  • Output: Response for the Snap contains either success or an error, depending on whether the URI was deleted or not.

Modes

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 sufficient access to delete objects in the Tenant.
Limitations and Known Issues: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 Accountfor information on setting up this type of account.

Views

InputThis Snap has at most 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:The section describes typical issues you may encounter while using this Snap, and instructions on how to workaround them:

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. This determines the Reltio host with Tenant ID. Use this format:
https://<reltio_host>/api/tenant_id>.

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

Default value: https://<your_reltio_host>/reltio/api/<tenant_id>


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

Object

Required. The Reltio Object from where the data is to be deleted. This is a suggestible field. 

Reltio typically has 4 objects - Entities/ Interactions/ Relations/ Categories. Suggestion only works if the valid account/ tenant URL is provided.

Default value: [None]


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

Object Id

RequiredThe identifier for the object to be deleted. Multiple objects can be deleted by using the Bulk delete option but in that the multiple IDs must be separated by a comma (,).

Default value: [None]

Bulk delete

This property enables deleting multiple entities at a time, separated by commas.

Default value: Not selected

Retry limit

Specify the maximum number of attempts to get the response. 

Minimum value: 1
Maximum value: 10

Default Value: 5

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

Batch size

Specifies the number of records that you want the Snap to process in a single API call.

Default value: 1

Minimum value: 1

Maximum value: 2,147,483,647


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

Thread limit

Required. Specifies the maximum threads of this Snap to delete the Reltio Objects.

Minimum value: 1

Maximum value: 50

Default value: 20

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

Snap Execution

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


Basic Use Case

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



The Snap is configured with the following parameters:


An example of the output from executing this pipeline:

Typical Snap Configurations

Key configuration of the Snap lies in how the values are passed. The values can be passed:

  • Without Expression:

Values are passed directly into the Snap:

  • With Expression:
    • Using pipeline parameters:

Values are passed as pipeline parameters:

  

Advanced Use Case

The following describes a pipeline, with a broader business logic involving multiple ETL transformations, that shows how typically in an enterprise environment, the Reltio functionality is used. The pipeline download is available in the Downloads section.

This pipeline retrieves the data from the Oracle Database and loads into the Reltio instance.


The key ETL transformations: 

Extract: The Oracle Select Snap retrieves the data from Oracle database.

Transform: The Head and the Mapper Snaps maps the specific data to be moved into the Reltio instance.

Load: The Reltio Create Snap creates the entities from the documents received from the upstream.

The pipeline further uses the Reltio Merge, Unmerge  and the Delete Snaps to perform the respective functions while transforming ( the JSON Splitter, Mapper and the Head Snaps) the data to serve the various business purposes.


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 Basic Use Case_Reltio_Delete_Object.slp

Jan 17, 2018 by Mohammed Iqbal

File Reltio Adv Use case.slp

Feb 17, 2018 by Aparna Tayi

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.