Accelerate the Value of Data

Address Cleanse Options

Learn about the server options for address cleansing.

You can enable the server options in one of the following ways:
  • In the Physical Configuration - Contact the Support Team to enable a server option at the physical configuration level.
  • In the L3 Configuration - See Configuring the Server Options to configure a server option in your L3.
Note: Your L3 configuration overrides the physical configuration.

After enabling the server options, re-cleanse the tenant to ensure that the enabled server options are applied and affect the existing location. Also, the process of cleansing can have an effect on the matching rate, because the standardized locations that were not matching, can match and eventually merge into one.

Table 1. Address Cleanse Options
Options Description
AddressLineSeparatorUsed to specify the string that separates the Output Address lines within the Output Address field.
CasingIgnoreFieldsUsed to specify the fields that must not be cased. The default value is ID,PostalCode,PostalCodePrimary,PostalCodeSecondary,ISO3166-2,ISO3166-3,PostBox,PostBoxNumber,PostBoxType,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC
CombinedVerifyMethodsWhen the CombinedVerifyMethods option is enabled, the flexible spelling correction option gets applied during the verification process. This server option is enabled by default. The possible values are Yes (default) and No.

For more information about this option, see Understanding the CombinedVerifyMethod Option.

DataDirectoryUsed to specify the directory in which the Global Knowledge Repository must be found (other than the directory of the loqate.ini configuration file specified during the lqtServer::init call).
DefaultCountryUsed to specify the default country with its ISO 3166-1 alpha-3 code. This must be used if no identifiable country is found in the input record. To find the code for a country, use the ISO Country code search.
DuplicateHandlingMaskThis option is enabled to remove valid duplicate components in the input address and enhance the address cleansing accuracy. This option can be enabled to remove duplicates across all levels of an input address. Depending on the level at which this option is enabled in the L3 configuration, the duplicates present in the address can be removed either from the same line or across all levels of input. For more information about this option, see DuplicateHandlingMask option.
EnhancedCountryToolAllows you to enable the Automatic Country Identification.
  • To enable the option, set the value of the option to ON or True.
  • To disable the option set the value to OFF or False. The default value is False.
FormatFieldsA list of default field formats for those fields that can be derived from a combination of other fields. This can be overridden on a per-country basis and must only be changed if requested by the Support Team.
IgnoreUnmatchedAllows unmatched input data within the address lines to be ignored during a search process. Hence, allowing the search to proceed by matching only the partial input data.

Consider the address, 4 Slapp Hill Rd Hardwick VT 05843 USA. If the IgnoreUnmatched option is enabled and is equal to 1, then the address is not converted to 4 Baker Hill Rd Hardwick VT 05843 USA.

By default, the IgnoreUnmatched option is not enabled. To enable this option as per your business requirements, contact Reltio’s Customer Support Team.
LogFileNameUsed to specify a file name to debug output. Must be specified before the lqtServer::init call.
MinimumVerificationLevelUsed to specify the minimum verification level that a record must reach in order to avoid reversion. For more information about this option, see MinimumVerificationLevel option.
NativeAddressLineReverseUsed to specify whether to reverse the order of the Input Address lines when processing non-Latin data. Usually, this is set on a per-country basis automatically, but can be overridden by setting the server option as appropriate.
  • When set to False, any input Address Lines are linked together in normal order (for example, Address1 + Address2 + Address3).
  • When set to True, any input Address Lines are linked together in reverse order (for example, Address3 + Address2 + Address1).
OutputCasingUsed to specify the letter case to be used in Output fields. Valid options are Upper, Title, or Lower. The default value is Title.
OutputScriptUsed to specify the ISO 15924 Code, in which the output must be encoded, if possible. Alternatively, Native must be specified to choose the correct country specific script value.
OutputSortTypeUsed to specify the order in which the Search output results must be sorted.
  • To sort in alphabetical order use Alphabetical.
  • Alternatively, specify Address Verification Code (AVC) to sort from the highest verification level to the lowest verification level. For more information about AVC, see Understanding Address Verification Code.
  • The option can also be set to Similarity. This gives an indication of the percentage of the Input characters that have been matched with the Output.
  • The default value is AVC.
PreferPrimaryValidAliasUsed to indicate whether to pick out the first valid alias in the reference data. To enable set to "Yes". The default is "No".

For example, let's consider the two address records below:

  • 276 Pondella Road, N Ft Myers, FL, USA
  • 276 Pondella Rd, North Fort Myers, FL, USA

If PreferPrimaryValidAlias is set to "Yes" (enabled), the two addresses are standardized and verified to a single record as, 276 Pondella Rd, North Fort Myers, FL, USA. The default is "No".

For more information about this option, see Address Standardization.

SuppressAddressFieldsUsed to specify the comma-separated list of fields that must be suppressed from the Address field Output.
SuppressFieldsUsed to specify the comma-separated list of fields that must be suppressed from the Output.
SuppressUnmatchedIf this option is set to TRUE or ON, then unverified fields do not appear as Output in the Address fields (Address, Address1, Address2, and so on). The default option is FALSE or OFF.
StrictReferenceMatchHelps to output results that are identical to what is found within the reference data. For example, if an Input Address has a premise of 08, but the reference data contains 8, then the Premise is verified with a Premise Number output of 08. Turning on StrictReferenceMatch gives the output as 8. The default value is No.
TransliterationIgnoreFieldsUsed to specify the fields that must not be transliterated. The default value is ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC.