Loquate
Data Management's Loqate tool interfaces with Loqate's AddressVerify system to validate and cleanse mailing addresses for more than 240+ countries and territories. It:
Supports data in any UTF8 language.
Parses unstructured text into labeled address, location and contact components.
Validates data against the Loqate Global Knowledge Repository of worldwide reference data.
Standardizes to the correct local format country based on Oasis and UPU standards.
Corrects common misspellings and converts data to local address format.
Adds missing components such as postal codes, region, and other address components.
Loqate tool configuration parameters
The Loqate tool has three sets of configuration parameters in addition to the standard execution options:
Input
Input type | Select the structure that best describes the input data. This is optional and defaults to All available. |
Map available input fields | Map the input fields to the data fields. The available input fields will depend on the selected Input type. |
Output
See Output field names and sizes.
Options
Address line separator | If output includes Full address formatted for mailing, the character used to separate the address lines. Defaults to HTML |
Process mode | Select the processing mode:
|
Context cache result size | If Override cache settings is selected, specifies how many sets of context results should be cached in memory. This cache is a cost-based cache based on processing time, meaning that the slowest context analyses have their results cached. Defaults to 0. Values up to around 5,000 are relevant, but the memory usage and performance gain will be dependent on the supplied input data. |
Query cache result size | If Override cache settings is selected, specifies how many sets of query results should be cached in memory. This cache is a cost-based cache based on query time, meaning that the slowest queries have their results cached. Defaults to 0. Values up to around 5,000 are relevant, but the memory usage and performance gain will be dependent on the supplied input data. |
Reference page cache size | If Override cache settings, specifies the number of MRU reference datasets to cache. Default value is 5. |
Reference dataset cache size | If Override cache settings, specifies the number of MRU pages to cache from each individual reference dataset. Default value is 12, and each page equates to approximately 5Mb of memory use. |
Loqate output field names and sizes
The following are the default output field names and sizes for the Loqate tool. All fields are Unicode Text.
Description | Output field | Meaning | Length |
|---|---|---|---|
Organization |
| The business name associated with a particular delivery point, should one exist. | 32 |
Organization name |
| The name indicator within the Organization field, should one exist. For instance, if Organization contains ‘Loqate Inc” OrganizationName contains “Loqate” if a sufficient level of parsing detail exists for the particular country. | 24 |
Organization type |
| The trailing type indicator contained within the Organization field, should one exist. For instance, if Organization contains “Loqate Inc” OrganizationType contains “Inc” if a sufficient level of parsing detail exists for the particular country. | 24 |
Contact name |
| Contact name information. | 32 |
Contact function name |
| Contact function or job information. | 32 |
Contact department name |
| Contact organizational department information. | 32 |
Full address formatted for mailing |
| Full address correctly formatted for mailing, including line breaks. | 64 |
First-line...Twelfth-line address |
| Address lines 1...12. | 64 |
PostBox |
| The post box for a particular delivery point, should one exist. | 28 |
PostBox number |
| The alphanumeric indicator within the PostBox field, should one exist. For instance, if PostBox contains “PO BOX 1234” PostBoxNumber contains “1234” if a sufficient level of parsing detail exists for the particular country. | 10 |
PostBox type |
| The type indicator contained within the PostBox field, should one exist. For instance, if PostBox contains “PO BOX 1234” PostBoxType contains “PO BOX” if a sufficient level of parsing detail exists for the particular country. | 10 |
Administrative Area |
| The most common geographic data element within a country. For instance, USA State, and Canadian Province. | 64 |
SuperAdministrative Area |
| The largest geographic data element within a country. | 64 |
SubAdministrative Area |
| The smallest geographic data element within a country. For instance, USA County. | 64 |
Address verification code |
| 14 | |
Country name |
| ISO 3166 official country name. | 28 |
Latitude |
| WGS 84 latitude in decimal degrees format. | 11 |
Longitude |
| WGS 84 longitude in decimal degrees format. | 11 |
Geocode accuracy |
| 2 | |
Full delivery address formatted for mailing |
| Full address minus Organization, Locality fields, AdministrativeArea fields, and PostalCode fields, correctly formatted for mailing in the relevant country, including line breaks. | 256 |
First line...twelfth line address formatted for mailing |
| Delivery address lines 1...12 | 128 |
ISO 3166 2-character country code |
| The ISO 3166 2-character country code. | 2 |
ISO 3166 3-character country code |
| The ISO 3166 3-character country code. | 3 |
ISO 3166 3-digit numeric country code |
| The ISO 3166 4-character country code. | 3 |
Locality name |
| The most common population center data element within a country. For instance, USA City, Canadian Municipality. | 32 |
Locality extra |
| Information that could be present along with the Locality. This information is not considered as part of the Postal authority data but is still necessary for parsing the address in order to obtain a complete delivery address. Available if a sufficient level of parsing detail exists within a particular country. | 32 |
Dependent locality name |
| A smaller population center data element, dependent on the contents of the Locality field. For instance, Turkish Neighborhood. | 32 |
Double dependent locality name |
| The smallest population center data element, dependent on both the contents of the Locality and DependentLocality fields. For instance, UK Village. | 32 |
Building |
| The descriptive name identifying an individual location, should one exist. | 28 |
Name indicator within building field |
| The name indicator within the Building field, should one exist. For instance, if Building contains "WESTMINSTER HOUSE” BuildingName contains "WESTMINSTER” if a sufficient level of parsing detail exists for the particular country. | 28 |
Leading type indicator within building field |
| The leading building type indicator within the Building field, should one exist. For instance, if Building contains "BLOC C" BuildingLeadingType contains "BLOC" if a sufficient level of parsing detail exists for the particular country. | 10 |
Trailing type indicator within building field |
| The trailing building type indicator within the Building field, should one exist. For instance, if Building contains "WESTMINSTER HOUSE" BuildingTrailingType contains "HOUSE" if a sufficient level of parsing detail exists within a particular country. | 10 |
Subbuilding |
| The secondary identifiers for a particular delivery point. For instance, FLAT 1 or SUITE 212. | 28 |
Type indicator within subbuilding field |
| "FLAT" if a sufficient level of parsing detail exists within a particular country. | 10 |
Number indicator within subbuilding field |
| The alphanumeric indicator within the SubBuilding field, should one exist. For instance, if SubBuilding contains "FLAT 1" SubBuildingNumber contains "1" if a sufficient level of parsing detail exists within a particular country. | 10 |
Name indicator within subbuilding field |
| The descriptive name within the SubBuilding field. For instance, if SubBuilding contains "BASEMENT FLAT" SubBuildingName contains "BASEMENT FLAT". | 28 |
Complete postal code |
| The complete postal code for a particular delivery point, should such detail be able to be determined. | 28 |
Primary postal code |
| The primary postal code used for a particular country. For instance, USA Zip, Canadian Postcode, Indian PINcode. | 28 |
Secondary postal code |
| This field contains secondary postal code information, if used in a particular country and if such detail is able to be determined and reference data is available. For instance, USA Zip+4. | 28 |
Premise |
| The alphanumeric code identifying an individual location, should one exist. | 28 |
Premise type indicator within the premise field |
| The leading premise type indicator within the Premise field, should one exist. | 10 |
Alphanumeric indicator within Premise field |
| The alphanumeric indicator within the Premise field, should one exist. For instance, if Premise contains “Plot 7/7A” PremiseNumber contains “7/7A” if a sufficient level of parsing detail exists within a particular country. | 10 |
Premise extra data |
| Information that could be present as part of the Premise field. Example: In a French address, the Premise number could be followed by words 'bis' or 'ter'. | 28 |
Thoroughfare |
| The most common street or block data element within a country. For instance, USA Street. | 28 |
Name indicator within Thoroughfare |
| The name indicator within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “N MAIN ST” ThoroughfareName contains “MAIN” if a sufficient level of parsing detail exists for the particular country. | 28 |
Thoroughfare pre-direction |
| The prefix directional contained within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “N MAIN ST” ThoroughfarePreDirection contains “N” if a sufficient level of parsing detail exists for the particular country. | 10 |
Leading thoroughfare type indicator within Thoroughfare |
| The leading thoroughfare type indicator within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “RUE DE LA GARE” ThoroughfareLeadingType contains “RUE” if a sufficient level of parsing detail exists for the particular country. | 10 |
Trailing thoroughfare type indicator within Thoroughfare |
| The trailing thoroughfare type indicator within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “N MAIN ST” ThoroughfareTrailingType contains “ST” if a sufficient level of parsing detail exists for the particular country. | 10 |
Thoroughfare post-direction |
| The postfix directional contained within the Thoroughfare field, should one exist. For instance, if Thoroughfare contains “MAIN ST N” ThoroughfarePostDirection contains “N” if a sufficient level of parsing detail exists for the particular country. | 10 |
Dependent thoroughfare |
| The dependent street or block data element within a country. For instance, UK Dependent Street. | 28 |
Name indicator within Dependent thoroughfare |
| The name indicator within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains “N MAIN ST” DependentThoroughfareName contains “MAIN” if a sufficient level of parsing detail exists for the particular country. | 28 |
Dependent thoroughfare pre-direction |
| The prefix directional contained within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains "N MAIN ST” DependentThoroughfarePreDirection contains "N” if a sufficient level of parsing detail exists for the particular country. | 10 |
Leading dependent thoroughfare type indicator within dependent thoroughfare |
| The leading thoroughfare type indicator within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains "RUE DE LA GARE” DependentThoroughfareLeadingType contains "RUE” if a sufficient level of parsing detail exists for the particular country. | 10 |
Trailing dependent thoroughfare type indicator within dependent thoroughfare |
| The trailing thoroughfare type indicator within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains "N MAIN ST” DependentThoroughfareTrailingType contains "ST” if a sufficient level of parsing detail exists for the particular country. | 10 |
Dependent thoroughfare post-direction |
| The postfix directional contained within the DependentThoroughfare field, should one exist. For instance, if DependentThoroughfare contains "MAIN ST N” DependentThoroughfarePostDirection contains "N” if a sufficient level of parsing detail exists for the particular country. | 10 |
Unmatched |
| Can hold any information in the input address fields that is unable to be parsed to a particular address field. | 128 |
Configure the Loqate tool
Select the Loqate tool, and then go to the Input tab.
Select Input type and choose the structure that best describes the input data:
Fielded. All the data is fielded (for example, Street, City, State, ZIP/PostCode are all stored in individual fields), for example:
Thoroughfare:
Walnut Street
Premise:
1515
PostBox:
PO Box 1378
Locality:
Boulder
AdministrativeArea:
CO
PostalCode:
80302
Partially fielded. Some data has been fielded but some of the address is in generic "address lines," for example:
Address1:
1515 Walnut Street
Address2:
PO Box 1378
Locality:
Boulder
AdministrativeArea:
CO
PostalCode:
80302
Unfielded. All data is is in generic "address lines," for example
Address1:
1515 Walnut Street
Address2:
PO Box 1378
Address3:
Boulder CO 80302
All available. If your data contains elements not described by the other structures, choose All available.
Use the Map available input fields grid to map each Description to the correct Input Field.
Go to the Output tab, and use the Output fields grid to map each Description to the correct Output Field. You can select the Select arrow and choose All, None, or Typical to generate default Output Field names.
If the specified output fields do not already exist in the input file, they will be created as new fields, using the default names and field sizes. If the output fields already exist in the input file, the fields must be large enough to handle the standard size of the components, or results may be truncated. See Output field names and sizes.
If your output fields include Full address formatted for mailing, including line breaks, you may specify an Address line separator on the Options tab.
You may specify a Process mode on the Options tab, or accept the default setting of Verify and Geocode.
Optionally, select Override cache settings on the Options tab to configure Context cache result size, Query cache result size, Reference page cache size, and Reference dataset cache size.
The impact of these settings is highly data dependent. In some situations you may reduce memory usage by setting them at low values with little change in throughput. In other situations, you can obtain throughput gains by configuring higher values. However, if the caches exceed the available physical memory, performance will be adversely affected. Start at a low value and then increase gradually, checking to see if throughput improves.
Optionally, go to the Execution tab, and then set Web service options.