Understanding Address Cleanse Parameters

Reltio provides parameters related to address cleansing.

Using useHash Parameter

Parameter - useHash; The default value is false.

Parameter Usage:

"cleanseConfig": 
	{"infos": [{
		"sequence": [{
			"chain": ["useHash": true, 
			...
		}]
	}]

You can set "useHash":true in all cleanse chains where you want to use it.

  • If useHash is set to true, hashes are taken into account.
  • If the hash of the input-cleanse-values is already calculated and was not changed (there were no changes with input-cleanse-values), the entities are not re-cleansed with standard parameters by a task for this chain.

Using useHash Parameter

Here is an example of using the useHash parameter for location:

"cleanseConfig":{  
   ... 

        "infos":[  
      {  
         "uri":"configuration/entityTypes/Location/cleanse/infos/default",
         "useInCleansing":true,
         "sequence":[  
            {  
               "chain":[  
                  {  
                     ... 

"useHash":true,
                     ...
                  }
               ]
            }
         ]
      },
      {  
         "uri":"configuration/entityTypes/Location/cleanse/infos/other",
         "useInCleansing":true,
         "sequence":[  
            {  
               "chain":[  
                  {  
                     ... 

"useHash":true,
                     ...
                  }
               ]
            }
         ]
      }
   ]
},

Fire cleanse task with justCalculateHashes and failedOnly:

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

Search for non-cleansed entities:

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

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')"
}