Reltio Update

This Snap updates the Reltio objects entities on the specified tenant.

Table 1. Reltio Update
Field Name Description
Snap type: Write
Description:

This Snap is used to update the Reltio Objects (Entities only) on the specified Tenant.

ETL Transformations & Data Flow

The Snap updates specific data for an entity in the Reltio tenant. It has the ability to perform a bulk update on set of entity objects. Bulk update can be addition, deletion, update etc.

Input & Output

  • Input: Input view is optional and is required only to pass the Entity ID/ Role(s)/Tag(s) from the upstream Snap or directly into the Snap, however, the input is mandatory while performing a Bulk update operation which allows JSON format only. Input is needed based on the operation chosen by the user.
  • Output: Response for this Snap differs based on the operation selected. When deleting a tag/role, it provides the "success" or "failure" message accordingly, but when adding the tag(s)/role(s), it provides the set of roles/tags added to the specified Entity object.

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. SeeReltio Account for information on setting up this type of account.

Views

Input
This Snap has exactly one document input view.
Output
This Snap has exactly one document output view.
Error
This 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.

Specifies the Reltio host with Tenant ID. Use this format:

https://<reltio_host>/reltio/api/<tenant_id>

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

Example: https://sndbx.reltio.com/reltiotest/api/XKerg6bvb178fmuXYr3U7ZrG6/

Default value: [None]

Operations

Specifies the update operation to be performed. The options available are:

  • Add roles to an entity: Add role(s) to a specific entity identifier
  • Delete role from an entity: Delete the role from a specific entity identifier
  • Add tags to an entity: Add tag(s) to a specific entity identifier
  • Delete tags from an entity: Delete the tag from a specific entity identifier
  • Bulk update: Provides a set of bulk attributes operation like addition of attributes, deletion of attributes, updating the values of multiple attributes of listed entities in the input

    When performing a Bulk update, the input is mandatory and comes from the upstream that allows JSON format only.

    Default value: Add roles to an entity

Entity Id

The entity identifier to be provided. Provide the ID when adding/deleting the roles (or tags) to an entity, or, adding/deleting an entity to and from the category.

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

Default value: [None]

Roles

Specifies the role(s) to be added to the specific entity identifier. Multiple roles can be added separated by commas. When performing a deletion, provide the role only (single and not multiple) to be deleted.

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

Default value: [None]

Tags

Specifies the tag(s) that can be added to a specific entity identifier. Multiple tags can be added and separated by commas.

When performing a deletion, provide the single tag (and not multiple) to be deleted.

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

Default value: [None]

Retry limit

The maximum number of times the Snap will attempt to retrieve the response. Reltio uses the exponential back off retry policy only for HTTP Status Codes 502, 503 and 504. Reltio has no retry policy for HTTP Status Codes 401, 403, 404, 500.

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

Default value: 5

Maximum value: 10

Execute during preview

This property enables you to execute the Snap during the Save operation so that the output view can produce the preview data.

Default value: Not selected

See the below examples for the basic use case and typical Snap configurations for the Update operation.