Versions Compared

Old Version 25

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 26

changes.mady.by.user Subhajit Sengupta

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

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 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 relationsTask ID
    Task statusStatus of the task with all the attributes for that task
    Pause task, Stop task, or Resume taskSuccess/failure message

    Modes

PrerequisitesReltio 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 Accountfor 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>


Info

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

Note

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.


Note

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

Expand
titleSample output example of resuming a cancelled task



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

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]


Info

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


Query parameter value

Value which is appropriate for that particular Query parameter key used.

Default value: [None]


Info

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


Retry limit


Excerpt
Specify the maximum number of attempts to get the response. 

Minimum value: 1
Maximum value: 10

Default Value: 5

Info

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



Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute


Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

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
Expand
titleExport entities


Expand
titleExport relations
 


Expand
titleTask 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: 


Expand
titlePause 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:


Expand
titleStop 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:


Expand
titleResume 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:

Note

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

Multiexcerpt include macro
namedownload_instructions
pageOpenAPI

Attachments
patterns*.slp,*.zip


Insert excerpt
Reltio Snap Pack
Reltio Snap Pack
nopaneltrue