tLoqateAddressRow – Docs for ESB 5.x

Component family

Data Quality

Function

tLoqateAddressRow parses, verifies, cleanses,
standardizes, transliterates, and formats international addresses.

This component uses the Loqate Global Knowledge Repository containing definitive
address and geographic reference data for over 240 countries in multiple languages
and character sets.

tLoqateAddressRow uses the Q4, 2012
release.

Purpose

tLoqateAddressRow enables you to parse
structured or unstructured text into labeled address, it automatically puts address
components into the correct address field.

You can compare address data against reference data to ensure that it is
accurate and complete. You can correct spellings, add missing address data such as
city, city area, region or postcode, and enrich address with other elements such as
latitude longitude and other relevant data.

Basic settings

Schema

A schema is a row description, it defines the number of fields to be processed
and passed on to the next component. The schema is either Built-in or stored remotely in the Repository.

Since version 5.6, both the Built-In mode and the Repository mode are
available in any of the Talend solutions.

Built-in: You create the schema and store it
locally for this component only. Related topic: see Talend Studio User
Guide.

Repository: You have already created the schema
and stored it in the Repository. You can reuse it in various projects and job
designs. Related topic: see Talend Studio User
Guide.

Edit Schema

Click the […] button and define the input and
output schema of the address data.

Make sure to define in the output schema all columns necessary to output the
formatted data you want to get from tLoqateAddressRow.

Input Address

Address field: add lines to the table and
select from the component predefined list the fields that will hold the input
address.

tLoqateAddressRow provides a long list of
individual fields because some countries have more complex addressing structures
than others. For further information about the input fields, see Address fields in tLoqateAddressRow.

Input Column: add lines to the table and select
from the list the columns that hold the input address. The input schema can have one
or multiple columns and can have columns that do not represent address data.

Output Address

Address field: add lines to the table and
select from the component predefined list the fields that will hold the output
address. The component will map the values of these fields to the output columns you
set in the table.

tLoqateAddressRow provides a long list of
individual fields because some countries have more complex addressing structures
than others. For further information about the output fields, see Address fields in tLoqateAddressRow.

Output Column: add lines to the table and
select from the list the columns that will hold the output address.

If you select to have an output column in the Output
Address table that has the exact name of an input column, the input
column value will be overwritten by the value given by tLoqateAddressRow.

In the output schema, there are two output standard columns that are read-only:

–STATUS: returns the status of processing input addresses. For
further information about process status, see Process status in tLoqateAddressRow.

–ACCURACYCODE: returns the verification code for the processed
address. For further information about what values this code is made up of and the
implications of each segment, see Address verification codes in tLoqateAddressRow.

Loqate Data Path

Set the path to the Loqate Global Knowledge Repository provided by Loqate and
installed locally.

You must order and download the Loqate Local API and the Global Knowledge
Repository from http:// www.loqate.com/. tLoqateAddressRow uses the Q4, 2012 release.

Advanced settings

Server options

Set the server options as the following:

–Address Line Separator: define the string
which will separate the output address components within the output address fields.
The default separator is the line break string (<BR>).

–Default Country: select the country name for
which the ISO 3166-1 alpha-3 code should be used when parsing data and if no
identifiable country is found in an input record.

–Forced Country: select the country name for
which the ISO 3166-1 alpha-3 code should be used for all input records when parsing
data.

–Output Script: use this option to
transliterate the output address.

Select Latin to encode the parsing results in
Latin, or western characters.

Select Native to encode the parsing results
using the country script.

Below is a list of the character sets (scripts) and languages tLoqateAddressRow can transliterate:

Latn – Latin (Western characters),

Cyrl – Cyrillic (Russia),

Grek – Greek (Greece)

Hebr – Hebrew (Israel),

Hani – Kanji (Japan),

Hans – simplified Chinese (China),

Arab – Arabic (United Arab Emirates),

Thai – Thai (Thailand),

Hang – Hangul (South Korea),

Native – output in the native script wherever possible.

–Minimum match score: specify the minimum match
score a record must reach in order not to be reverted. The default value is zero,
and valid values are between zero and 100.

This option is very helpful when you want to get, in the output fields, the
input data if a specific level of verification (minimum match score) was not
reached.

tStatCatcher
Statistics

Select this check box to collect log data at the component level.

Global Variables

ERROR_MESSAGE: the error message generated by the
component when an error occurs. This is an After variable and it returns a string. This
variable functions only if the Die on error check box is
cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable
functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl +
Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio
User Guide.

Usage

This component is an intermediary step. It requires an input and output
flows.

Limitation

n/a

Address [in,out]

used to specify the full mailing address in the relevant country.

Address1, Address2, ... Address12
[in,out]

used to specify input data for the address line in the relevant country, split
into individual address lines.

DeliveryAddress [out]

used to specify the full address including line breaks without the
Organization, Locality, AdministrativeArea
and PostalCode fields.

DeliveryAddress1,
DeliveryAddress2…DeliveryAddress12 [out]

used to specify the individual lines contained within the
DeliveryAddress field.

Country [in]

used to provide the country name or code.

CountryName [out]

used to provide the ISO 3166 official country name.

ISO3166-2 [out]

used to provide the ISO 3166 2-character country code.

ISO3166-3 [out]

used to provide the ISO 3166 3-character country code.

ISO3166-N [out]

used to provide the ISO 3166 3-digit numeric country code.

SuperAdministrativeArea [in,out]

used to provide the largest geographic data element within a country.

AdministrativeArea [in,out]

used to provide the most common geographic data element within a country. For
instance, USA State, and Canadian Province.

SubAdministrativeArea [in,out]

used to provide the smallest geographic data element within a country. For
instance, USA County.

Locality [in,out]

used to provide the most common population center data element within a country.
For instance, USA City, Canadian Municipality.

DependentLocality [in,out]

used to provide a smaller population center data element, dependent on the
contents of the Locality field. For instance, Turkish
Neighborhood.

DoubleDependentLocality [in,out]

used to provide the smallest population center data element, dependent on both
the contents of the Locality and DependentLocality fields.
For instance, UK Village

Thoroughfare [in,out]

used to provide the most common street or block data element within a country.
For instance, USA Street.

DependentThoroughfare [in,out]

used to provide the dependent street or block data element within a country. For
instance, UK Dependent Street.

Building [in,out]

used to provide the descriptive name identifying an individual location, if such
a name exists.

Premise [in,out]

used to provide the alphanumeric code identifying an individual location, if
such a code exists.

SubBuilding [in,out]

used to provide the secondary identifiers for a particular delivery point. For
instance, “FLAT 1” or “SUITE 212”.

PostalCode [in,out]

used to provide the complete postal code for a particular delivery point, if
such detail can be determined.

PostalCodePrimary [out]

used to provide the primary postal code used for a particular country. For
instance, USA Zip, Canadian Postcode, Indian PINcode.

PostalCodeSecondary [out]

used to provide secondary postal code information, if used in a particular
country and if such detail can be determined and reference data is available. For
instance, USA Zip Plus 4.

Organization [in,out]

used to provide the business name associated with a particular delivery point,
if such a name exists.

PostBox [out]

used to provide the post box for a particular delivery point, if it
exists.

Unmatched [out]

used to list any words that could not be matched to a particular address
component.

Latitude [out]

used to provide the WGS 84 latitude in decimal degrees format.

Longitude [out]

used to provide the WGS 84 longitude in decimal degrees format.

GeoAccuracy [out]

used to provide the GeoAccuracy code. For further information, see GeoAccuracy Code.

GeoDistance [out]

used to provide the radius of accuracy in meters, giving an indication of the
likely maximum distance between the given geocode and the physical location.

P (Point)

a single geocode was found matching the input address.

I (Interpolated)

a geocode was able to be interpolated from the input addresses location in a
range.

A (Average)

multiple candidate geocodes were found to match the input address, and an
average of these was returned.

U (Unable to geocode)

a geocode was not able to be generated for the input address.

5

delivery point (PostBox or SubBuilding).

4

premises (Premises or Building).

3

thoroughfare.

2

locality.

1

administrative area.

0

none.

The verification status

used to specify the full mailing address in the relevant country.

The post-processed verification match level.

used to specify input data for the address line in the relevant country, split
into individual address lines.

The pre-processed verification match level

used to specify the full address including line breaks without the
Organization, Locality, AdministrativeArea
and PostalCode fields.

The parsing status

used to specify the individual lines contained within the
DeliveryAddress field.

The lexicon identification match level

used to supply the country name or code.

The context identification match level

used to supply the ISO 3166 official country name.

The postcode status

used to supply the ISO 3166 2-character country code.

The matchscore

used to supply the ISO 3166 3-character country code.

psOK

the process completed normally. The score must be examined to determine result
accuracy.

psException

an exception occurred during processing input records, normally as a result of
malformed input data.

psServerUninitialized

the process could not be completed because the server has not been
initialized.

psInvalidInputRecord

the input record contains invalid data, often due to the supply of
non-UTF8/Unicode data.