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 reference

Out-of-the-box Cleanse Functions

Pattern-based cleanser

Integrate data

Monitor data quality

Resolve potential matches

Manage profiles

Manage workflow tasks

Explore data insights

Pattern-based cleanser

Learn about the pattern-based cleanser.

The PatternBasedFieldBuilder cleanser generates output text per the pattern and attribute mappings you configure. When the cleanser runs on an entity profile, it adds a crosswalk for the resulting value that uses ReltioCleanser as its source, per the cleanse config settings.

Table 1. Options
Key	Allowed Values	Description
`isForce`	Boolean (true/false)	True: Generates a value for the Name attribute if it is available. False (default): Generates a value for the `Name` attribute if it isn't available or blank.
`pattern`	This is the only pattern to generate the desired output.	The output is generated as per the given pattern only. If no pattern is defined, the input values are arranged with spaces in between. Note: Use the `beforeSave` LCA hook to enable the Pattern-Based Cleanser to work with nested attributes. For details on this LCA hook, see topic LCA Hooks.

Limitations

The pattern-based cleanser doesn't support reference attributes.
If you configure a named attribute as the desired target for the output of this cleanser and it uses a name other than OutputText, then the parameter isForce isn't available for use.

Example configuration

Map the PatternBasedFieldBuilder for any entity in your L3 configuration. Here is an example of a sample configuration:

{
  "uri": "configuration/entityTypes/HCP2",
  "cleanseConfig": {
    "infos": [
      {
        "uri": "configuration/entityTypes/HCP2/cleanse/infos/PatternBasedFieldBuilder",
        "useInCleansing": true,
        "sequence": [
          {
            "chain": [
              {
                "cleanseFunction": "PatternBasedFieldBuilder",
                "resultingValuesSourceTypeUri": "configuration/sources/ReltioCleanser",
                "proceedOnSuccess": true,
                "proceedOnFailure": true,
                "mapping": {
                  "inputMapping": [
                    {
                      "attribute": "configuration/entityTypes/HCP2/attributes/Name",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Name"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP2/attributes/Organization/attributes/Name",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "OrganizationName"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP2/attributes/Country",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Country"
                    }
                  ],
                  "outputMapping": [
                    {
                      "attribute": "configuration/entityTypes/HCP2/attributes/ShortNote",
                      "mandatory": true,
                      "allValues": false,
                      "cleanseAttribute": "OutputText"
                    }
                  ]
                },
                "params": {
                  "isForce": true,
                  "pattern": "{Name}, {OrganizationName} - {Country}"
                }
              }
            ]
          }
        ],
        "nestedAttributeToCleanse": "configuration/entityTypes/HCP2/attributes/Organization/attributes/Name"
      }
    ]
  },
  "attributes": [
    {
      "uri": "configuration/entityTypes/HCP2/attributes/Name",
      "label": "Name",
      "name": "Name",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false
    },
    {
      "uri": "configuration/entityTypes/HCP2/attributes/Country",
      "label": "Country",
      "name": "Country",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false
    },
    {
      "uri": "configuration/entityTypes/HCP2/attributes/Organization",
      "label": "Organization",
      "name": "Organization",
      "description": "",
      "type": "Nested",
      "hidden": false,
      "important": false,
      "attributes": [
        {
          "uri": "configuration/entityTypes/HCP2/attributes/Organization/attributes/Name",
          "label": "Name",
          "name": "Name",
          "description": "",
          "type": "String",
          "hidden": false,
          "important": false
        }
      ]
    },
    {
      "uri": "configuration/entityTypes/HCP2/attributes/ShortNote",
      "label": "ShortNote",
      "name": "ShortNote",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false
    }
  ]
}

Examples of input and output

Options Inputs (InputText) Output (OutputText)


{ “isForce: false,
   “pattern”: I, “{FirstName} {LastName}, live in {Country}”
}

{
"FirstName": "Walter",
"LastName": "Bruce"
"Country": "USA"
}

{
"FirstName": "Walter",
"LastName": "Bruce"
"Country": "USA"
"OutputText":"I, Walter Bruce, live in USA"
}

{ “isForce: false,
   “pattern”: “{Address1}, {City}, <br>{Country} - {PostalCode}”
}

{
"Address1": "100 MAIN ST
",
"City": "SEATTLE WA
",
"Country": "USA
",
"PostalCode": "98104
"
}

{
"Address1": "100 MAIN ST",
"City": "SEATTLE WA",
"Country": "USA",
"PostalCode": "98104"
"OutputText":"100 MAIN ST, SEATTLE WA, <br>USA - 98104"
}

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.