Reltio Update
Overview
The Reltio Update Snap updates Reltio Objects (Entities/Categories) on the specified Tenant.
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, and more.
- This is a Write-type Snap.
Works in Ultra Tasks
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
- 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. Input view is optional and is required only to pass the Entity ID, Category ID, Role(s), or 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 user. |
|
| Output |
This Snap has exactly one document output view. Response for this Snap differs based on the operation selected. When deleting a tag or role, it provides the "success" or "failure" message accordingly. When adding the tag(s) or role(s), it provides the set of roles or tags added to the specified Entity object. |
|
| Learn more about Error handling. | ||
Snap settings
| 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 Update |
Tenant URL*
String/Expression |
Specifies the Reltio host with Tenant ID. Use this format:
Note: The values can be passed directly or by using the pipeline parameters, but not through the upstream Snap.
Default value: N/A Example: |
Operations
Dropdown list |
Specifies the update operation to be performed. The options available are:
Note: 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
String/Expression |
Specifies the entity identifier to be provided. Provide the ID when adding or deleting the roles (or tags) to an entity, or 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: N/A |
Category Id
String/Expression |
Specifies the category identifier. 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: N/A |
Roles
String/Expression |
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: N/A |
Tags
String/Expression |
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. Note: The value can be passed using the upstream or through the pipeline parameters.
Default value: N/A |
Retry limit
Integer/Expression |
Specify the maximum number of attempts to get the response. Minimum value: 1 Maximum value: 10 Tip: You can provide this value dynamically as a Pipeline parameter or directly in the Snap, but not as an upstream value.
Default value: 5 |
Snap execution
Dropdown list |
Choose one of the three modes in
which the Snap executes. Available options are:
Default value: Execute only Example: Validate & Execute |