Objectives

Reltio Products Developer resources Roles Applications Objectives

Reltio Products Developer resources Roles Applications Objectives

Unify and manage your data

Objectives

Objectives Contents

About objectives

Administer system

Model data

Manage reference data

Configure the Reltio UI

Load and export data

Stream data

Cleanse data

Data cleansing at a glance

Data cleansing set up

Data cleansing operation

Data cleansing reference

Out-of-the-box Cleanse Functions

Address cleanser

Email Cleanser

Full name cleanser

HTTP Cleanse Function

Initials Cleanser

Pattern-based cleanser

Phone cleanser

S3 File Cleanser

String Cleanser

Cleanse parameter nestedAttributeToCleanse

Custom Cleanse Functions

Integrate data

Monitor data quality

Resolve potential matches

Manage profiles

Manage workflow tasks

Explore data insights

Cleanse parameter nestedAttributeToCleanse

Learn about the parameter to cleanse nested attributes.

The nestedAttributeToCleanse parameter defines the nested attributes to cleanse separately. It ensures that cleansing applies to all nested levels. The cleansed data is stored at each nested level.

Usage

Define this parameter within the infos object of the cleanseConfig to specify which nested attributes should be cleansed separately using the configured cleanse sequence.

Example: Using nestedAttributeToCleanse with Address Cleanser

{
    "uri": "configuration/entityTypes/NstdAddr3",
    "cleanseConfig": {
        "infos": [{
            "uri": "configuration/entityTypes/NstdAddr3/cleanse/infos/default",
            "useInCleansing": true,
            "sequence": [{
                "chain": [{
                    "cleanseFunction": "AddressCleanser",
                    "resultingValuesSourceTypeUri": "configuration/sources/ReltioCleanser",
                    "proceedOnSuccess": true,
                    "proceedOnFailure": false,
                    "mapping": {
                        "inputMapping": [{
                            "attribute": "configuration/entityTypes/NstdAddr3/attributes/Nested1/attributes/Nested2/attributes/Address/attributes/AddressInput",
                            "mandatory": true,
                            "cleanseAttribute": "Address"
                        }]
                    }
                }]
            }],
            "nestedAttributeToCleanse": "configuration/entityTypes/NstdAddr3/attributes/Nested1/attributes/Nested2/attributes/Address"
        }]
    }
}
            

Example: Using nestedAttributeToCleanse with StringFunctionCleanser

{
  "uri": "configuration/entityTypes/HCP",
  "label": "HCP",
  "description": "Health care provider",
  "extendsTypeURI": "configuration/entityTypes/Individual",
  "cleanseConfig": {
    "infos": [
      {
        "uri": "configuration/entityTypes/HCP/cleanse/infos/CleanserAddress1",
        "useInCleansing": true,
        "sequence": [
          {
            "chain": [
              {
                "cleanseFunction": "StringFunctionCleanser",
                "resultingValuesSourceTypeUri": "configuration/sources/ReltioCleanser",
                "proceedOnSuccess": true,
                "proceedOnFailure": true,
                "mapping": {
                  "inputMapping": [
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Addresses/attributes/AddressLine1",
                      "mandatory": true,
                      "cleanseAttribute": "Address1"
                    }
                  ]
                },
                "params": {
                  "casing": "Upper",
                  "isForce": true
                }
              }
            ]
          }
        ],
        "nestedAttributeToCleanse": "configuration/entityTypes/HCP/attributes/Addresses"
      }
    ]
  }
}
            

Considerations

The cleanser processes all levels of the specified nested attribute.
Ensure the cleanse sequence is correctly configured to apply cleansing at the right stage.
Incorrect nesting may lead to incomplete cleansing of hierarchical data.
Use a separate nestedAttributeToCleanse entry for each nested attribute that requires cleansing.
Ensure that nestedAttributeToCleanse is only applied to fully nested structures and doesn't reference simple attributes within a nested attribute.

Was this content helpful?

ON THIS PAGE

Cleanse parameter nestedAttributeToCleanse

Updated on March 18, 2025

You've found your way to a temporary environment. Content is not complete or final. Looking for Reltio documentation? Go to docs.reltio.com.