Understanding Address Cleanse Parameters

Reltio provides parameters related to address cleansing.

Using justCalculateHashes Parameter

Parameter - justCalculateHashes; The default value is false for the {{tenant_uri}}/cleanse?{{uri}} task.

Parameter Usage:

Set the parameter justCalculateHashes to true to calculate the hashes for already cleansed entities.

Using failedOnly Parameter

Parameter: failedOnly; The default value is false for the {{tenant_uri}}/cleanse?{{uri}} task.

Parameter Usage - Consider the following points:

  • "failedOnly":true for the entities that were not cleansed successfully. Hash is absent for cleanse-crosswalk (for example, ReltioCleanser).
  • "failedOnly":false for all entities what were or were not cleansed successfully.

Using forceCleansing Parameter

Parameter: forceCleansing; The default value is false for the {{tenant_uri}}/cleanse?{{uri}} task.

Parameter Usage:

  • If "forceCleansing":true, the Reltio Connected Cloud ignores the existing hash and fire cleansing of the entity.
  • If "forceCleansing":false, the Reltio Connected Cloud cleanses the entities where the hash is absent or the hash is incorrect.

Using justCalculateHashes/failedOnly/forceCleansing

This example calculates/re-calculates hashes for all entities:

{{tenant_uri}}/cleanse?entityType=Location&justCalculateHashes=true

This example treis to re-cleanse failed only entities:

{{tenant_uri}}/cleanse?entityType=Location&failedOnly=true 

This example tries to re-cleanse all entities:

{{tenant_uri}}/cleanse?entityType=Location&forceCleansing=true

Succcessfully Cleansed

ES:

GET {{tenant_uri}}/entities/_total?filter=(missing(successfully_cleansed) and equals(type, 'configuration/entityTypes/Location'))

DBScan:

POST: {{tenant_uri}}/entities/_dbscan?select=uri,attributes.AddressLine1,attributes.VerificationStatus
Body:{  
   "type":"configuration/entityTypes/Location",
   "pageSize":100,
   "filter":"missing(successfully_cleansed) and equals(type, 'configuration/entityTypes/Location')"
}