Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Snap type:Write
Description:

This Snap is used to update the Reltio Objects (Entities/ Categories) on the mentioned Tenant.

ETL Transformations & Data Flow

The Snap updates specific data either for an entity or the category 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/ Category Id/ Role(s)/ Tag(s) from upstream snap or value in that field. It is also used to pass the body for “Bulk Update” Operation. Input is needed based on the operation chosen by user.

  • Output:

Response for this snap differs based on the operation selected. For deleting tag/ role, it will provide "success" or "failure" message accordingly. For adding the tag(s)/ role(s), it will           provide 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. See Reltio Account for information on setting up this type of account.

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: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. The format to be used is https://<reltio_host>/reltio/api/<tenant_id>

Note

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

Examplehttps://sndbx.reltio.com/reltio/api/XK178mXYr3UZrG6/

Detault 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
  • Add an entity to the category: Add the specified entity identifier to the mentioned category id
  • Delete an entire entity from the category: Delete the specified entity identifier from the mentioned category id
  • Bulk update: Provides a set of bulk attributes operation like addition of attributes, deletion of attributes, updating the values of multiple attributes of listed entitites in the input (NOTE: Input comes as an upstream document here).

Default valueAdd roles to an entity

Entity Id

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

Note

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

Default value: [None]

Category Id

Specifies the category identifier to be supplied. Provide the ID when adding or deleting an entity to and from the category.

Note

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.

Note

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 the specific entity identifier. Multiple tags can be added separated by commas.

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

Note

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

Default  value: [None]

Retry limit

Determines the maximum number of attempts to retrieve the response. Since Reltio uses the exponential backoff, the retry mechanism applies for HTTP Status Codes 502, 503 and 504 only but not for the HTTP Status Codes 401, 403, 404, 500.

Note

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 

Insert excerpt
Reltio Snap Pack
Reltio Snap Pack
nopaneltrue