Automatic Unmerge Task
Learn about the Automatic Unmerge task
batchUnmergeEntities task when you want to ensure entities that no longer match are automatically unmerged. This line of action is important, if you made any of these changes after you loaded your data:- Added, deleted, or edited match rules
- Edited survivorship rules for any attributes included in match rules
readOnly=true mode on the tenant, and the task tests which entities should be unmerged. The mode readOnly=false works as earlier only on the entity type where Automatic unmerge is enabled. For more information, see topic Enable automatic unmerge on the tenant configuration.Request
Tenant admin role is required:
| Parameter | Required | Default Value | Description |
|---|---|---|---|
| uriList | No |
List of candidate entity URIs for unmerging. Example of a request body with a URI list:
| |
| entityType | No | The type of entity on which the task will run. If you don't specify it, the task will run all entity types, effectively the whole tenant. | |
| readOnly | No | true | If true, only tests candidate entities for unmerge. It doesn't commit changes. |
| updatedSince | No | 0 |
Only entities with |
| updatedTill | No | 0 |
Only entities with |
| distributed | No | false | If set to true, the task runs in distributed mode (refer to Distributed Mode). |
| taskPartsCount | No | 2 | If you set distributed=true, you can specify the number of parts in which you want to execute this task. Note: This parameter is used only in distributed mode distributed=true, otherwise it is ignored. |
| entitiesLimit | No | The number of entities to be processed by the task. |
You can retrieve detailed information by getting the task by its ID.
Response
| Parameter | Description |
|---|---|
| totalObserved | Overall statistics on total number of observed entities. |
| totalDetected | Overall statistics on total number of entities that should be automatically unmerged readOnly=true, or that were automatically unmerged readOnly=false. |
| entityTypeStatistics | The number of processed and detected entities to be unmerged, with up to 1000 examples of entities URIs. Statistics are grouped per entity type. Note: These statistics are displayed irrespective of the value specified for the
readOnly parameter. |
Filter entities in BulkUnmergeEntitiesTask
Reltio supports the filtering of entities to be unmerged before they are read, leading to reduced the number of read requests to the database during the task process and as a result improving the task performance.
This filter can be specified either by query or included in the object list.
| Parameter | Required | Default Value | Description |
|---|---|---|---|
| filter | No | null |
The structure to describe the batch unmerge entities task filter specification Contains:
|
If you only define the query the task uses the ES URI iterator;
If you only define the include list parameter or the uriList parameter the task uses the default URI iterator;
If you only define the entityType parameter the task converts that parameter to the ES filter and uses the ES URI iterator;
If you only define the updatedSince/updatedTill parameters the task generated the ES filter based on these parameters and uses the ES URI iterator;
If you define the query and include list parameters the task is not created and an error message is presented;
If you define the query and uriList parameters the task is not created and an error message is presented;
If you define the query and entityType parameters the task converts the entityType parameter to ES filter and concatenates it to all query filters;
If you define the query and updatedSince/updatedTill parameters the task converts the updatedSince/updatedTill parameter to ES filter and concatenates it to all query filters;
If you define the include list and uriList parameters the task works with URIs from the include list;
If you define the include list and updatedSince/updatedTill parameters OR the uriList and updatedSince/updatedTill parameters the task uses the default URI iterator and filters the already read entities by updatedSince or updatedTill;
If you define the entityType and updatedSince/updatedTill parameters the task generates the ES filter based on these parameters and uses the ES URI iterator;
The exclude list parameter works separately. It also filters entities out before reading objects but does not use the ES filter.