Reltio Create

Overview

The Reltio Create Snap creates and writes data to the Reltio objects (Entities, Relations, Interactions, Categories) in a Reltio instance.

To configure this Snap, you must specify the type of object to create, the Tenant URL, and so on. You can also configure query parameters and their corresponding values.

Prerequisites

  • Reltio account with a valid Tenant ID so that Tenant URL can be formed/API for Account Settings.
  • The Reltio account must have write access to create objects in the Tenant.

Known issues

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.

One input view is required to provide attribute values for the object you want to create. For example, for a Relations object, you need to provide startObject, endObject, type, and crosswalks.

Output

This Snap has exactly one document output view.

Response for the Snap contains every value specified in attributes for that particular object, including crosswalk type and values.

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 Create

Tenant URL*

String/Expression
Determines the Reltio host with Tenant ID. Use this format: https://<reltio_host>/reltio/api/<tenant_id>.
Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

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

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

Object*

String/Expression/ Suggestion
The Reltio Object to be created. This is a suggestible field. Reltio typically has 4 objects - Entities, Interactions, Relations, and Categories. Suggestion only works if a valid account/tenant URL is provided.
  • Entities: Entities are objects for representation such as People, Companies, and Locations.
  • Categories: Entities are structured under the Categories. An entity can belong to multiple categories.
  • Interactions: Interactions are the actions between two or more entities that have an impact on one another. For example, email is an interaction that sends emails to one or several entities.
  • Relations: Relations define the links between entities.
Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Default value: N/A

Example: Entities

Object types*

String/Expression/ Suggestion
Based on the Object selected, this property can be configured to select the object type. This is a suggestible field, but the suggestion works only if a valid account/tenant URL/object is provided.
Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Default value: N/A

Batch size

Integer/Expression
Specifies the number of records that you want the Snap to process in a single API call.
Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Minimum value: 1

Maximum value: 2,147,483,647

Default value: 1

Example: 100

Thread limit*

Integer/Expression
Specifies the maximum threads of this Snap to delete the Reltio Objects.
Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Minimum value: 1

Maximum value: 50

Default value: 20

Example: 10

Query parameters Defines the query parameters and their values. The query parameters will be attached to the URL using the HTTP query parameter syntax, separated by & added as key=value.
Query parameter

String/Expression
A key which can be used in the HTTP request for Reltio.
Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Default value: N/A

Example: returnObjects

Query parameter value

String/Expression
The value associated with the specified Query parameter key.
Note: This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Default value: N/A

Example: true

Retry limit

Integer/Expression
Specifies the maximum number of attempts to get the response.
Note: You can provide this value dynamically as a Pipeline parameter or directly in the Snap, but not as an upstream value.

Minimum value: 1

Maximum value: 10

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