Export data using Reltio export service
Learn about the essentials of exporting your data from Reltio Multidomain MDM.
Overview of exporting data
- Use the data in analysis and metrics reporting.
- Make the data available in CRM (customer relationship management) or similar platforms.
- Export the data into an ETL (export, transform, load) and move the data into other systems.
The diagram below shows how our platform handles export requests.
The flow of export requests in Reltio Multidomain MDM
Export features in Reltio Multidomain MDM and how you can use them.
What kind of data can I export?
- Entities
- Relations
- Activity Log Data
- Merge Tree Data
What permissions do I need to export data?
Reltio Multidomain MDM defines permissions by the scope of data you can access. Your access to export is the same as your Reltio Server access.
What are the ways I can export data?
- Using the Export application in Console (user interface) to create an export job.
- Making requests directly through an API.
How do I create and execute an export job with the export UI?
Use the Export application in Console to create an execute an export job. For more information, see Create and run an export job and Export entities and relationships.
What compression file types does export support?
| Format | File extension | Description |
|---|---|---|
| GZIP | .gz | Compresses a single file. Has a better compression ratio for individual files. |
| ZIP | .zip | Compresses multiple files and directories into one archive, including metadata such as file paths, dates, and attributes. |
What is the file-naming convention for exported data files?
By default, output export file names are built by the next template - part_<part-number>, where <part-number> indicates the number of the part of the generated output file. The numbering starts from zero.
For example, if entities/testName is the custom path parameter for the export files destination, then the output file is named as entities/testName/part_00001.csv.gz.
- entities/testName/part_00000.csv.gz
- entities/testName/part_00001.csv.gz
- entities/testName/part_00002.csv.gz
- entities/testName/part_00003.csv.gz
- entities/testName/part_00004.csv.gz
What are the Reltio Multidomain MDM APIs related to defining an export?
Background task limitations
Reltio enforces a tenant-level configurable limit on the number of running or scheduled background tasks. This limit applies to all periodic tasks - including exports, reindexing, data loads, match processing, and cleansing operations. You can use the Export Tasks Management API to check the number of active export tasks.
PERIODIC_TASKS_PER_TENANT_LIMIT_EXCEEDED
To avoid this, wait for current tasks to complete before starting new ones.
For more information, see Get Active Tasks and Tenant Configuration Parameters ReferenceSample of an exported schema
The following example defines the structure of an Organization entity, including attributes, relationships and crosswalks.
{
"types": {
"configuration/entityTypes/Organization": {
"label": "Organization",
"attributes": {
"configuration/attributes/Name": {
"label": "Organization Name",
"type": "STRING",
"isRequired": true,
"isMultivalue": false
},
"configuration/attributes/DUNSNumber": {
"label": "D-U-N-S Number",
"type": "STRING",
"isRequired": false,
"isMultivalue": false
},
"configuration/attributes/Address": {
"label": "Address",
"type": "GROUP",
"attributes": {
"configuration/attributes/Street": {
"label": "Street",
"type": "STRING"
},
"configuration/attributes/City": {
"label": "City",
"type": "STRING"
},
"configuration/attributes/State": {
"label": "State",
"type": "STRING"
},
"configuration/attributes/PostalCode": {
"label": "Postal Code",
"type": "STRING"
},
"configuration/attributes/Country": {
"label": "Country",
"type": "STRING"
}
}
},
"configuration/attributes/PhoneNumber": {
"label": "Phone Number",
"type": "STRING",
"isMultivalue": true
}
},
"crosswalks": {
"configuration/crosswalks/ExternalSource": {
"label": "External Source",
"isSurvivorshipCandidate": true
},
"configuration/crosswalks/Surrogate": {
"label": "Surrogate Crosswalk",
"isSystemGenerated": true
}
},
"relationships": {
"configuration/relationships/HasParent": {
"label": "Has Parent",
"relatedEntityType": "configuration/entityTypes/Organization",
"isBidirectional": true
}
}
}
}
}