Reltio Bulk Export

Reltio Bulk Export exports Reltio Objects in bulk from Reltio to Amazon S3.

Table 1. Reltio Bulk Export
Field Name Description
Snap Type: Write
Description:

This Snap exports Reltio Objects (Entities/ Relations) in bulk from a Reltio Tenant to S3 storage. After the bulk export operation is complete, the Snap sends a download link 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.

ETL Transformations & Data Flow

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.

Input & Output

  • Input: 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 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 user.
  • Output: Response for this Snap differs based on the operation selected:
    Operation Type Output Data
    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

Modes

  • Ultra pipelines: May work in Ultra Pipelines.
  • Spark (Deprecated) mode: Not supported in Spark mode.
Prerequisites:

Reltio account with a valid Tenant ID so that Tenant URL can be formed/API for Account Settings. Also, the Reltio account must have sufficient access to export objects 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 Accountfor 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: None at this time.
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. Use this format:

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

Example: https://sndbx.reltio.com/reltio/api/XK178mXYr3UZrG6/

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

This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Operations

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

Default value: Export entities

Task Id

ID of the Reltio Export task initiated by the user.

Default value: [None]

S3 File

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

Example: s3:///iqdrac/test/test.zip

Default value: s3:///

Query parameters 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

The key which can be used in the HTTP request for Reltio.

Default value: [None]

This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Query parameter value

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

Default value: [None]

This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Retry limit

The maximum number of times the Snap will attempt to get 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.

Default value: 5

Maximum value: 10

This value can be provided dynamically as a pipeline parameter or directly in the Snap, but not as an upstream parameter.

Execute during preview

Executes the Snap during a pipeline 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, typical Snap configurations, and operation types for the Bulk Export operation.