Reltio Merge

Overview

The Reltio Merge Snap merges the Reltio Objects (Entities or Categories) data for a given Winner and Loser entity or for category IDs as mentioned on the Tenant.

It provides a potential match between the two entities.

Winner ID describes the Entity ID as a resulting 'survivor' and combines all attributes, crosswalks, roles and tags from the 'losing' entity into it.

Loser ID describes the Entity ID to be merged into the Winner (survivor) object, where an entity corresponds to one of the Reltio Objects.

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 merge the objects or entities from the Tenant.

Limitations

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

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has exactly one document input view.

The Input view is optional and is required only to pass the Winner/Loser ID from the upstream Snap or value in that field. Only the fields marked with an asterisk (*) are the required inputs; all other fields are optional.
Output

This Snap has exactly one document output view.

Response for this Snap differs based on the operation selected. For potential matches, the Snap provides a 'success' or 'failure' message accordingly. For merging entities or categories, the Snap provides the attributes of the merged entity in the output.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label

String

Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Reltio Merge
Tenant URL*

String/Expression		 Specifies the Reltio host with tenant ID. Use this format: https://<your_reltio_host>/reltio/api/<tenant_id>
Note: The value can be passed directly or through the pipeline parameters, but not through the upstream.

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

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

Dropdown list		 Specifies the merge operation to be performed. The available options are:
  • Merge Entities: Merges two entities.
  • Merge Categories: Merges two categories.
  • Potential Match For Entities: Provides a potential match for the entities.

Default value: Merge Entities
Winner Id*

String/Expression		 Specifies the Winner entity or category identifier.

This field describes the entity ID as a resulting 'survivor' and combines all the attributes, crosswalks, roles and tags from the 'losing' entity into it.

Note: The value can be passed using the upstream Snap or through the pipeline parameters.

Default value: $winnerId

Example: e12345
Loser Id*

String/Expression		 Specifies the loser entity or the category identifier. This field describes the Entity ID to be merged in the survivor object.
Note: The value can be passed using the upstream Snap or through the pipeline parameters.

Default value: $loserId

Example: e67890
Retry limit

Integer/Expression		 Specifies the maximum number of attempts to get the response.

Minimum value: 1

Maximum value: 10

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

Default value: 5

Example: 3
Snap execution

Dropdown list
Choose 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.

Default value: Execute only

Example: Validate & Execute