Unify and manage your data

Configure cleanse function infos

Learn how to configure data cleansing, including input and output mappings, sequence chains, and cleanse functions.

This table describes the content of the infos associated with cleanse functions.

Table 1. Configure Infos
InfosDescription
useInCleansingSpecifies whether the cleanse info is automatically used to cleanse the updated or created entity.
sequenceSpecifies a list of cleansing chains that are applied one by one during the cleansing.
chainSpecifies the list of cleanse functions that are applied one by one depending on the proceedOnSuccess or proceedOnError parameters.
cleanseFunctionIndicates the name of the cleanse function.
params

Specifies additional parameters for the cleanse function. Define this object inside a chain element to pass function-specific settings such as pattern, isForce, and cleanseLookupInputStrategy.

  • pattern: Specifies the output pattern used to generate the cleansed value.
  • isForce: Specifies whether a value is always generated, even if a value already exists. Default value: false
    • true: Always generates a value, even if the target attribute already has a value.
    • false: Generates a value only if the target attribute is blank or has no value.
  • cleanseLookupInputStrategy: Specifies which value is passed to the cleanse function during the cleanse process for an attribute whose value is resolved through RDM lookup data. Supported values are:
    • RAW_VALUE: Passes the raw, unresolved value.
    • LOOKUP_VALUE: Passes the resolved lookup value.
    • LOOKUP_CODE: Passes the lookup code.

Consider the following behavior:

  • If cleanseLookupInputStrategy is set to LOOKUP_CODE or LOOKUP_VALUE, and the lookup is not configured or cannot be resolved, the value passed to the cleanse function depends on the useRawValueAsDefaultForCleanse setting. For more information, see Configure cleanse to use raw value when lookup fails
  • When resolveLookupCode is set to true, raw values are not persisted, so the cleanse function does not use RAW_VALUE.
filterSpecifies a filter expression that controls when a cleanse function runs. The expression is evaluated against the entity attribute values. If the expression evaluates to true, the cleanse function runs. If it evaluates to false, the cleanse function is skipped. If you don't define a filter, the cleanse function runs for all entity data.
mapping sectionContains the input and output attribute mapping for the cleanse function. May contain own inputMapping or outputMapping sections or references to common attribute mappings using inputMappingRef or outputMappingRef attributes.
proceedOnSuccess
  • Specifies whether the cleansing should proceed to the next element in the chain, if the current cleansing is successful. This may be omitted.
  • The default value is true.
proceedOnFailure
  • Specifies whether the cleansing should proceed to the next element in the chain, if the current cleansing is not successful. This may be omitted.
  • The default value is true.
resultingValuesSourceTypeUri
  • Mandatory field
  • Specifies the source type of a crosswalk for cleansed values.
  • The attribute value of the selected source type is not considered in the cleanse function.
Note: All cleansed values are associated with the special crosswalk source specified in resultingValuesSourceTypeUri. By default, the cleanser crosswalk doesn't populate the updateDate parameter. To change this behavior, contact Reltio Customer Engineering to enable the changeCleanseCrosswalkUpdateDate parameter in optionalParameters in your tenantConfiguration. Once enabled, values associated with the cleanser crosswalk, reltioLoadDate and updateDate will be updated. For details, see topic Get help in Support Portal