Full Name Cleanser

The full name cleanser generates full names as defined and adds an attribute to the ReltioCleanser crosswalk.

Cleanser Name - FullNameBuilder

Description - This cleanser generates full names as defined and adds an attribute to the ReltioCleanser crosswalk, as per the output mapping.

Note: Consider the following points when you use the full name cleanser.
  • Except for the Name attribute, you can define your own names for all the below attributes.
    • FirstName
    • MiddleName
    • LastName
    • Initial
  • By default, FirstName and LastName are marked as mandatory. However, you can choose the mandatory attributes as per your requirement.
Table 1. Options
Key Allowed Sub-Attribute Name
isForce Boolean (true/false)
  • True - always generates a value for the Name attribute, whether or not the data for the desired output is supplied in the request.
  • False - generates value if the Name attribute is not available or is blank.
  • The default value is False.
pattern This is the only pattern to generate the full name.
  • Full name is generated as per this pattern only.
  • The default pattern is {FirstName} {MiddleName} {LastName}.

Limitation - When you have defined a cleanse input name of your own, for the FULL_NAME attribute, instead of Name, the cleansing option isForce is not applicable.

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

{
  "uri": "configuration/entityTypes/HCP",
  "cleanseConfig": {
    "infos": [
      {
        "uri": "configuration/entityTypes/HCP/cleanse/infos/FullNameBuilder",
        "useInCleansing": true,
        "sequence": [
          {
            "chain": [
              {
                "cleanseFunction": "FullNameBuilder",
                "resultingValuesSourceTypeUri": "configuration/sources/ReltioCleanser",
                "proceedOnSuccess": true,
                "proceedOnFailure": true,
                "mapping": {
                  "inputMapping": [
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/FirstName",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "FirstName"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/MiddleName",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "MiddleName"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/LastName",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "LastName"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Initial",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Initial"
                    },
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Name",
                      "mandatory": false,
                      "allValues": false,
                      "cleanseAttribute": "Name"
                    }
                  ],
                  "outputMapping": [
                    {
                      "attribute": "configuration/entityTypes/HCP/attributes/Name",
                      "mandatory": true,
                      "allValues": false,
                      "cleanseAttribute": "Name"
                    }
                  ]
                },
                "params": {
                  "isForce": true,
                  "pattern": "{FirstName} {MiddleName} {LastName}"
                }
              }
            ]
          }
        ]
      }
    ]
  },
  "attributes": [
    {
      "uri": "configuration/entityTypes/HCP/attributes/ID",
      "label": "ID",
      "name": "ID",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    },
    {
      "uri": "configuration/entityTypes/HCP/attributes/MiddleInitial",
      "label": "Middle Initial",
      "name": "MiddleInitial",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    },
    {
      "uri": "configuration/entityTypes/HCP/attributes/FirstName",
      "label": "First Name",
      "name": "FirstName",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    },
    {
      "uri": "configuration/entityTypes/HCP/attributes/MiddleName",
      "label": "Middle Name",
      "name": "MiddleName",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    },
    {
      "uri": "configuration/entityTypes/HCP/attributes/LastName",
      "label": "Last Name",
      "name": "LastName",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    },
    {
      "uri": "configuration/entityTypes/HCP/attributes/Initial",
      "label": "Initial",
      "name": "Initial",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    },
    {
      "uri": "configuration/entityTypes/HCP/attributes/Name",
      "label": "Name",
      "name": "Name",
      "description": "",
      "type": "String",
      "hidden": false,
      "important": false,
      "attributeOrdering": {
        "orderingStrategy": "LUD"
      }
    }
  ]
}

Example

Table 2. Example
Options Inputs (Input) Output (Name)
{ “isForce: false,
   “pattern”: “{FirstName} {LastName} {MiddleName}”
}
{
"FirstName": "Walter",
"MiddleName": "Bruce",
"LastName": "Willis",
“Name”: “Walter Bruce”
}
{
"FirstName": "Walter",
"MiddleName": "Bruce",
"LastName": "Willis",
“Name”: “Walter Bruce”
}
{
   “isForce: true,
   “patern”: “{FirstName} {LastName} {MiddleName}”
}
{
"FirstName": "Walter",
"MiddleName": "Bruce",
"LastName": "Willis",
“Name”: “Walter Bruce”
}
{
"FirstName": "Walter",
"MiddleName": "Bruce",
"LastName": "Willis",
“Name”: “Walter Willis Bruce”
}
{
   “isForce: true,
   “pattern”: “{FirstName} {MiddleName}”
}
{
"FirstName": "Walter",
"MiddleName": "Bruce",
"LastName": "Willis"
}
{
"FirstName": "Walter",
"MiddleName": "Bruce",
"LastName": "Willis",
“Name”: “Walter Bruce”
}
{
   “isForce: true,
   “pattern”: “{LastName} {FirstName}”
}
{
"FirstName": "Walter",
"MiddleName": "Bruce",
"LastName": "Willis"
}
{
"FirstName": "Walter",
"MiddleName": "Bruce",
"LastName": "Willis"
"Name":"Willis Walter"
}
{
}
{
"FirstName": "Walter",
"MiddleName": "Bruce",
"LastName": "Willis"
}
{
"FirstName": "Walter",
"MiddleName": "Bruce",
"LastName": "Willis"
"Name":"Walter Bruce Willis"
}
{
   “isForce: true,
   “pattern”: “{FirstName} {MiddleName} {LastName}”
}
{
"FirstName": "Walter",
"LastName": "Willis"
}
{
"FirstName": "Walter",
"LastName": "Willis"
"Name":"Walter Willis"
}