On this Page

Snap Type:

Write

Description:

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

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 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:
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: Works in Ultra Pipelines.

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

You cannot roll back the productized Reltio Snap Pack in 4.20 to a prior version.

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

Input	This Snap has at most 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/XK,XYr3jjHG98gMY345U/

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

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.

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 will be displayed: The execute request failed due to invalid input

Sample output example of resuming a cancelled task

Task Id

The 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

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

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

A 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

Specify the maximum number of attempts to get the response.

Minimum value: 1
Maximum value: 10

Default Value: 5

You can provide this value dynamically as a Pipeline parameter or directly in the Snap, but not as an upstream value.

Snap execution

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

Troubleshooting

Error	Reason	Resolution
When you configure the Reltio OAuth2 Account for the Reltio Bulk Export Snap, it displays the following error: `Failure: The execute request failed due to invalid input., Reason: User has no valid emails for export data, errorCode: 543`	The export job needs an 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.

Error

Reason

Resolution

When you configure the Reltio OAuth2 Account for the Reltio Bulk Export Snap, it displays the following error:

Failure: The execute request failed due to invalid input., Reason: User has no valid emails for export data, errorCode: 543

The export job needs an 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.

Examples

Basic Use Case

The following pipeline describes how the Snap functions as a standalone Snap in a pipeline:

The Snap is configured with the following parameters:

An example of the output data from executing this pipeline:

Typical Snap Configurations

Key configuration of the Snap lies in how the values are passed. The values can be passed:

Without Expression:

Values are passed directly into the Snap:

With Expression:
- Using pipeline parameters:

Values are passed as pipeline parameters:

Examples for Operation types:

As mentioned earlier, there are six values possible in Operations properties. Depending on which operation is selected, the output will be different. The following types of Operations are possible:

Export entities - For exporting the Entities.
Export relations - For exporting the Relations.
Task status - Provides the status of a task (or all tasks)
Pause task - Pauses an on-going task
Stop task - Stops a scheduled or paused task
Resume task - Restarts a paused task

Export entities

Export relations

Task status

If a Task ID is not provided in the Task Id property, then all the tasks and their corresponding status will be displayed. If a Task ID is provided in the Task Id property, then the status of that task will be provided. Below is a sample output for a specified Task ID:

Pause task

When Pause task is selected, the task will be paused and the output will be the task's details as well as a success status message as shown:

Stop task

When Stop task is selected, the task will be stopped and the output will be the task's details as well as a success message as shown:

Resume task

When Resume task is selected, the paused task will be unpaused and the output will be the task's details as well as a success status message as shown:

Resume task can only be used for paused tasks and not stopped (or cancelled) tasks, if the user tries to resume a stopped task the following message will be displayed: The execute request failed due to invalid input

Downloads

Important steps to successfully reuse Pipelines

Download and import the pipeline into the SnapLogic application.
Configure Snap accounts as applicable.
Provide pipeline parameters as applicable.

	File	Modified
Labels No labels Preview View	File Basic Use Case_Reltio_Bulk Export.slp	Mar 27, 2018 by Mohammed Iqbal

Snap Pack History

Click to view/expand

Release	Snap Pack Version	Date	Type	Updates
February 2025	main29887	12 Feb 2025	Stable	Updated and certified against the current SnapLogic Platform release.
November 2024	main29029	13 Nov 2024	Stable	Updated and certified against the current SnapLogic Platform release.
August 2024	438patches28852	31 Oct 2024	Latest	Fixed an issue with the Reltio OAuth2 Account that caused multiple refresh token calls. Now, the account refreshes the token based on its expiration time.
August 2024	438patches28012	11 Sep 2024	Latest	Added the Reltio OAuth2 Account that authenticates the user via the Client credentials Grant type.
August 2024	main27765	21 Aug 2024	Stable	Updated and certified against the current SnapLogic Platform release.
May 2024	main26341	08 May 2024	Stable	Updated and certified against the current SnapLogic Platform release.
February 2024	main25112	14 Feb 2024	Stable	Updated and certified against the current SnapLogic Platform release.
November 2023	main23721	08 Nov 2023	Stable	Updated and certified against the current SnapLogic Platform release.
August 2023	main22460	16 Aug 2023	Stable	Updated and certified against the current SnapLogic Platform release.
May 2023	main21015	10 May 2023	Stable	Upgraded with the latest SnapLogic Platform release.
February 2023	main19844	09 Feb 2023	Stable	Upgraded with the latest SnapLogic Platform release.
November 2022	main18944	10 Nov 2022	Stable	Upgraded with the latest SnapLogic Platform release.
October 2022	430patches18173	13 Oct 2022	Latest	The Reltio Snaps which previously hung when there was no data or while processing the data will now time out when there is a slow server response.
August 2022	main17386	11 Aug 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.29	main15993	14 May 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.28	main14627	12 Feb 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.27 Patch	427patches12999	23 Nov 2021	Latest	Enhanced the Reltio Generic Execute with a new field Empty Responses as Separate Documents, that enables the Snap to write empty responses as separate documents.
4.27	main12833	13 Nov 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.26	main11181	14 Aug 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.25 Patch	425patches10410	12 Jul 2021	Latest	Fixed an issue with the Reltio Create Snap where the Snap processes a lesser number of documents while loading data into Reltio.
4.25	main9554	08 May 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.24	main8556	13 Feb 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.23	main7430	14 Nov 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.22	main6403	12 Sep 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.21	snapsmrc542	09 May 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.20	snapsmrc535	08 Feb 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.19	snaprsmrc528	14 Nov 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.18	snapsmrc523	10 Aug 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.17	ALL7402	11 Jun 2019	Latest	Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17	snapsmrc515	11 Jun 2019	Latest	Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.
4.16 Patch	reltiosnapconnector6773	22 Feb 2019	Latest	Fixed an issue with the Reltio Generic Execute Snap wherein response codes were handled incorrectly.
4.16	snapsmrc508	16 Feb 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.15	snapsmrc500	15 Dec 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.14	snapsmrc490	11 Aug 2018	Stable	New Snap added: Reltio Generic Execute.
4.13 Patch	reltiosnapconnector5200	16 May 2018	Latest	Fixed the Reltio Read (Object) Snap to fetch all the records from Reltio objects (entities, categories, and relations, except interactions). Added two new properties -- "Page Size" and "Records to Read" in the Read (Object) Snap.
4.13	snapsmrc486	12 May 2018	Stable	Added a new property, S3 File, to the Reltio Bulk Export Snap to support exporting data to the specified S3 location. Added new properties Batch size, and Thread limit to the Reltio Delete (URI) and Reltio Delete (Object) Snaps to enhance the performance.
4.12	snapsmrc480	17 Feb 2018	Stable	Introduced the Snap Pack this release. The Snap Pack includes: Reltio Bulk Export, Reltio Create, Reltio Delete (Object), Reltio Delete (URI), Reltio Merge, Reltio Read (CrossWalk), Reltio Read (Object), Reltio Unmerge and Reltio Update.

Browser not supported