Reltio Bulk Export

Overview

The Reltio Bulk Export Snap bulk exports Reltio Objects (Entities/Relations) from a Reltio Tenant to S3 storage.

After the bulk export operation is complete, a download link is sent to the user's email address. Based on the operation selected, this Snap can also be used to:

  • Get the status of the bulk export.
  • Pause, stop, or resume the export.

The Reltio Bulk Export Snap extracts Reltio Objects from the specified tenant to the specified S3 storage. If no S3 storage is specified, the objects are extracted to S3 storage provided by Reltio.

Prerequisites

  • A Reltio account with a valid Tenant ID so that Tenant URL can be formed.
  • The Reltio account must have sufficient access to export objects 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 at most one document input view.

Input view is optional and is required only to pass the Task ID from the upstream snap. It is also used to pass the body for "filtering" Operation for Export operations. The keys which can be used when the user wants to view the filter parameters have to be supplied. These filter parameters can be used while exporting entities/relations. Input is needed based on the operation chosen by the user.
Output

This Snap has exactly one document output view.

Response for this Snap differs based on the operation selected:

  • Export entities/Export relations: Task ID
  • Task status: Status of the task with all the attributes for that task
  • Pause task, Stop task, or Resume task: Success/failure message
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 Bulk Export
Tenant URL*

String/Expression

The Reltio host with Tenant ID. Use this format: https://<reltio_host>/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://sndbx.reltio.com/reltio/api/XK,XYr3jjHG98gMY345U/
Operations

Dropdown list

Specifies the type of Export to be done. Possible allowed values are:

  • Export entities: For exporting the Entities.
  • Export relations: For exporting the Relations.
  • Task status: Provides the status of the corresponding task (as specified in the Task Id field).
  • Pause task: Pauses the on-going task (as specified in the Task Id field).
  • Stop task: Stops a scheduled or paused task (as specified in the Task Id field).
  • Resume task: Restarts the paused task (as specified in the Task Id field).
CAUTION: Performance of an export task (Export entities and Export relations) depends on the performance of the environment and the number of tasks on the environment, and hence the range of performance impact may vary from task to task.
CAUTION: Resume task can only be used for paused tasks and not stopped (or canceled) tasks. If the user tries to resume a stopped task, the following message is displayed: The execute request failed due to invalid input.

Default value: Export entities
Task Id

String/Expression

The ID of the Reltio Export task initiated by the user.

Default value: N/A
S3 File

String/Expression

The location of the S3 storage where the exported data is to be stored. It should follow the format s3:///<bucket_name>/<folder_name>/<filename.zip>.

Default value: s3:///

Example: s3:///iqdrac/test/test.zip
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

The 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
Query parameter value

String/Expression

A value which is appropriate for that particular Query parameter key used.

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
Retry limit

Integer/Expression

Specify 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
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

Troubleshooting

Error Reason Resolution
Failure: The execute request failed due to invalid input., Reason: User has no valid emails for export data, errorCode: 543 The export job needs a user email to send an email notification about the job status. For Client credentials Grant type, the account is not associated to any user, hence the Snap displays an error.

To resolve this issue, specify an email parameter in the Query parameters and retry the execution. The pipeline should run successfully.