addressdoctor software library documentation/2/ad... · the unique delivery point reference number...

AddressDoctor GmbH

Roentgenstr. 9

67133 Maxdorf

Germany

+49 (6237) 9774 0

208 S WILMINGTON ST STE 200

RALEIGH NC 27601-1434

United States +1 (866) 402 2800

UK free phone

0800-0328-276

[email protected]

www.AddressDoctor.com

Current as of: 19 November 2013

AddressDoctor Software Library Release Notes: Version 5.4.1

Release Notes: 5.4.1 – Last Revision 19/11/2013 12:37:00

2

The notes in this document are related to the latest release of AddressDoctor’s Software Library and apply to:

(i) the AddressDoctor Software Library used standalone directly from AddressDoctor

(ii) where the AddressDoctor Software Library is integrated into Informatica products as an OEM or partner

solution

(iii) where the AddressDoctor Software Library is integrated into any other third party product as an OEM or

partner solution.


3

Important Changes in Release 5.4.1 – New Unlock Code Regulations

New Unlock Codes for Supplementary Databases Starting with release 5.4.1, new unlock codes are needed for supplementary databases. You must reinitialize

the 5.4.1 engine with the new unlock codes in order to enable the supplementary databases. AddressDoctor

has generated an unlock key for the previously supported supplementary databases that is valid until 31st

December 2014. See section 1.6.5 New Unlock Codes for Supplementary Databases.

New Unlock Codes for New Features The following new features need unlock codes to be functional:

Address Code Lookup – see section 1.1 Address Code Lookup

Single Line Address Validation – see section 1.8 Single Line Address Validation - Preliminary Release.

Unlock Codes and Engine Expiration AddressDoctor has made improvements and changes regarding unlock codes and engine expiration warnings

and messages. See section 1.6 Unlock Codes and Engine Expiration.

Contact your local sales representative for more information on the new unlock code regulations.


4

1. What’s New in Version 5.4.1?

Version 5.4.1 includes the following highlights:

* New Address Code Lookup

* New Outdated addresses for Japan

* New Enrichments for South Africa and Brazil

* New JIS-2004 character set support for Japan

* New NOT_VALID_YET status value for unlock codes

* New New supplementary unlock codes

* New Additional characters for Swiss postal codes

* New Preserve input script for Japanese addresses

* New – Preliminary Release Single Line Address Validation

↗ Improved SendRight Recertification

↗ Improved Parser for China and Turkey

↗ Improved Warning messages for unlock codes

↗ Improved Support for additional variants for Post Office Box for Australia

↗ Improved Indian Address Validation

↗ Improved Japanese Address Validation

Fixed Crash during parsing of Country Specific Locality Line in Danish addresses

Fixed Crash during validation process for Russian addresses

Fixed Incorrect parsing of "TV" and "TH" in Danish addresses

Fixed Alias status code for LACSLink match is incorrectly set

Fixed Street alias table is not available in Batch mode for US addresses

Fixed Postal code and locality are being changed for US addresses

Fixed Inconsistent behavior related to Pre-Directional in US addresses

Fixed Correcting US address in CERT mode but not Batch mode

Fixed Sort order for house numbers


5

1.1 Address Code Lookup

AddressDoctor introduces a new product offering – Address Code Lookup. Address Code Lookup is a new

process mode that has its own unlock code. With Address Code Lookup, you can enter a country specific

address code and retrieve the complete or partial address for the code. Address Code Lookup is currently

available for the following countries:

Germany

Great Britain

Japan

South Africa

Serbia

For example, the Choumei Aza code is an eleven digit code defining a unique delivery point for Japanese

addresses. You can now search on the Choumei Aza code to find the associated address.

Contact your local sales representative to obtain the new unlock code for the Address Code Lookup feature.

1.1.1 New Address Code Lookup Process Mode in Parameters.xml

To use the Address Code Lookup process mode, specify the value ADDRESSCODELOOKUP for the process

mode attribute in the Parameters.xml file.

1.1.2 New Address Code Type Values

The following table describes the values that you can specify for the Type attribute of the AddressCode

parameter in the InputData.xml file.

Address Code Type Country Description

DEU_AGS Germany The Amtliche Gemeindeschlüssel (AGS) is a variable length code

that uniquely identifies a locality in Germany. There may be more

than one locality for a given AGS code.

For example, a DEU_AGS code with a value of 07338018 returns

the following output:

Locality: Maxdorf

Province: Rheinland-Pfalz

DEU_LOCALITY_ID Germany The Locality ID is a variable length code that uniquely identifies a

German locality.

For example, a DEU_LOCALITY_ID code with a value of 68015519

returns the following output:

Locality: Maxdorf

Province: Rheinland-Pfalz

DEU_STREET_ID Germany The Street ID is a variable length code that uniquely identifies a


6


German street address.

For example, a DEU_STREET_ID code with a value of 100560690


Röntgenstr.

67133 Maxdorf

Germany

GBR_UDPRN Great

Britain

The Unique Delivery Point Reference Number (UDPRN) is an eight

character code that uniquely identifies each postal address of the

Royal Mail PAF database.

For example, a GBR_UDPRN code with a value of 15511432


Flat 16

Haden Court

Lennox Road

London

N4 3HS

United Kingdom

JPN_CHOUMEI_AZA_CODE Japan The Choumei Aza code is an eleven digit code that defines a

unique delivery point for Japanese addresses.

For example, a JPN_CHOUMEI_AZA_CODE code with a value of

28201160001 returns the following output:

670-0081兵庫県姫路市田寺東１丁目

Or:

01 Chome

Taderahiga-shi

Himeji-shi Hyogo-ken 670-0081

Japan

SRB_PAK Serbia The Postal Address Code (PAK) is a six digit code that defines a

unique Serbian address to the street level.

For example, a SRB_PAK code with a value of 251133 returns the

following output:

Majora Ilica 1-9999

14000 Valjevo

Serbia

ZAF_NADID South

Africa

The National Address Database (NAD) ID is a unique numeric ID

assigned to each South African street address.


7


For example, a ZAF_NADID code with a value of 2153781 returns

the following output:

4 Balfour Road

Vincent

East London

5247

South Africa

1.1.3 Address Code Lookup Database

To use address code lookup, you must download the following Address Code Lookup database:

<XYZ>5AC.MD

Note: <XYZ> is the ISO-3 alphacode (ISO 3166) of the country.

1.1.4 New Type Value for the Database Parameter in SetConfig.xml

To indicate that the Address Code Lookup database is available, specify the value ADDRESS_CODE_LOOKUP

for the Type attribute of the Database parameter in the SetConfig.xml file.

1.1.5 New Type Value for the Unlock Code

To indicate that the Address Code Lookup database should be unlocked, specify the value

ADDRESS_CODE_LOOKUP for the UnlockCode attribute Type in the GetConfig.xml file.

1.1.6 New Status Values for Address Code Lookup

The following table describes the new status values that the Address Code Lookup process mode can return.

Status Value Description

A0 No information found for the address code.

A1 Either partial or complete address found for the address code.

1.2 Outdated Addresses for Japan

AddressDoctor can now return the new address code for deprecated or outdated addresses for Japan. If the

input address is an outdated address, and the new process parameter MatchingExtendedArchive = ON,

AddressDoctor validates the old address against the archived addresses in the reference database. If

MatchingExtendedArchive = OFF, the outdated input address is likely to be rejected, or to be corrected to

some other address.

If the address is an outdated address, then AddressDoctor returns the address with the following new

Extended Element Result Status (EERS) code:


8

EERS=F (output address is outdated).

If the supplementary enrichment for Japan is activated, AddressDoctor returns the validated outdated

address with the old Choumei Aza code and the new Choumei Aza code as enrichment values.

The new Choumei Aza code can then be used as input for the new Address Code Lookup processing mode to

retrieve the corresponding new address.

Note that both the JPN5E1.MD and JPN5AC.MD database files are needed with their respective unlock codes

in order to search for the new address using the new Choumei Aza code.

1.3 Parser Improvements

The AddressDoctor parser component identifies address elements in totally unfielded or partially fielded

addresses and assigns them to the proper fields. This is an important precursor to the actual validation. In

this release, AddressDoctor provides the following country-specific improvements to the parser:

The parser has been improved to handle fields unique to Turkish addresses.

The Chinese parser has been improved significantly to offer a better quality address validation

solution for China. AddressDoctor now supports native parsing for China.

Note: To get optimum results for Chinese addresses, use the commonly used Chinese address

format where the input address is a single line data entry.

Example:

413000湖南省益阳市赫山区康富南路 35号

1.4 Country Specific Enrichments

1.4.1 National Address Database ID for South Africa

AddressDoctor now provides the National Address Database (NAD) ID as an enrichment output field for

South African addresses. The NAD ID is a unique numeric ID assigned to each street address. You must have

the new supplementary database for South Africa as well as version 5.4.1 of the software library in order to

leverage this functionality.

For example, if you enter the following address:

4 Balfour Road

Vincent

East London

5247

South Africa

AddressDoctor returns the following enrichment output:

NAD_ID: 2153781


9

1.4.2 IBGE Code for Brazil

AddressDoctor now provides the Brazilian Institute of Geography and Statistics (IBGE) code as an enrichment

output field for Brazilian addresses. For ecommerce, a government agency in Brazil publishes a list of

cities/states and their official numeric seven digit code called the IBGE code. This code is used for taxation

and auditing purposes. Every order that gets placed is eventually cross-referenced with the city and state to

get the associated IBGE code.

You must have the new supplementary data for Brazil, BRA5E1.MD, as well as version 5.4.1 of the software

library in order to leverage this functionality.


Rua da Matriz 9

Centro

Glória do Goitá-pe

55620-000

Brazil

AddressDoctor returns the following enrichment output:

IBGE_CODE: 2606101

1.4.3 Locality and Street Address Codes for Germany

AddressDoctor now provides the following enrichment output fields for German addresses:

DEU_AGS. The Amtliche Gemeindeschlüssel (AGS) is a variable length code that uniquely

identifies a locality in Germany. There may be more than one locality for a given AGS code.

DEU_LOCALITY_ID. The Locality ID is a variable length code that uniquely identifies a German

locality.

DEU_STREET_ID. The Street ID is a variable length code that uniquely identifies a German street

address.

You must have the new supplementary databases for Germany as well as version 5.4.1 of the software library

in order to leverage this functionality.


Röntgenstr. 9

67133 Maxdorf

Germany

AddressDoctor returns the following enrichment outputs:

DEU_AGS: 07338018

DEU_LOCALITY_ID: 68015519

DEU_STREET_ID: 100560690


10

1.4.4 Additional Characters for Swiss Postal Codes

Swiss Post has introduced an additional two characters to the postal codes. AddressDoctor has updated its

engine to allow the output of the additional postal code characters as an enrichment field. The new field is

named Postal_Code_Extension.

A new supplementary database (CHE5E1.MD) for Switzerland is also available for download with this new

feature. To use the new enrichment field, you must set the EnrichmentSupplementaryCH parameter to ON in

the Parameters.xml file.

For example, if you enter the following address in Batch mode:

Hohlen 1

3800 Sundlauenen

Switzerland

AddressDoctor returns the following enrichment fields:

Status: ECH1

Postal_Code_Extension: 05

1.5 Quality Improvements

1.5.1 Japan

1.5.1.1 JIS-2004

AddressDoctor now provides support for the transliteration of the JIS-2004 character set into the Latin

character set.

1.5.1.2 Japanese Address Validation

AddressDoctor has made improvements to the parsing and validation of Japanese addresses.

1.5.1.3 Preserve Input Script for Japanese Addresses

If the PreferredScript parameter for a Japanese address is set to “PRESERVE_INPUT”, AddressDoctor

preserves the alphabet of the input address. If the Japanese input address contains data in multiple

alphabets, AddressDoctor uses the official alphabet from the reference database for the output.

For example, a Japanese address contains fields with both Kanji and Latin characters. If the PreferredScript

parameter is set to “PRESERVE_INPUT”, then AddressDoctor returns all address fields using Kanji characters

because that is the default alphabet in the reference database.

1.5.2 Australia – Support for Additional Variations for Post Office Box

The AddressDoctor engine now supports additional variations for Post Office Box for Australian addresses. In release 5.4.1, the following PO Box variants are supported:


11

BOX BOX. P O P.O PO PO. P.O. P.O.B POBOX POST BOX POST OFFICE BOX P / O Box P/O Box P O Box P.O. Box

1.5.3 India

AddressDoctor has made the following improvements to the validation of Indian addresses:

Interactive Mode

The interactive mode of the Indian engine now returns suggestions for partial or incomplete addresses.

For example, the following address was previously corrected and returned a “C3” status code.

AddressDoctor no longer corrects the address. Instead, a list of potential matches is returned.

Address:

Triveni Veg Restaurant

BR Ambedkar Road

Byculla

400027 - Mumbai

Maharashtra

In addition, customers can search for an address using just the postal code in interactive mode. For

example, entering the postal code 400027 now returns several suggestions. Previously, AddressDoctor

did not return any results.

Improved Performance

As a result of several changes and improvements to the Indian address validation routines, the

performance of Indian address validation has tripled with release 5.4.1.

1.5.4 Sort Order for House Numbers

AddressDoctor now returns a list of house numbers in logical order instead of alphabetical order. For

example, AddressDoctor now sorts and returns numbers in the following logical order:

1, 2, 3, 11, 12, 13, 14, 21, 22


12

Previously, AddressDoctor returned the same numbers in the following alphabetical order:

1, 11, 12, 13, 14, 2, 21, 22, 3

1.6 Unlock Codes and Engine Expiration

The AddressDoctor library 5.4.1 includes the following improvements and changes regarding unlock codes

and engine expiration.

1.6.1 Not Yet Valid Unlock Codes

Previous versions of the engine reported unlock codes that were not yet valid with a status of “EXPIRED” in

the GetConfig.xml file. AddressDoctor now reports these codes with a status of “NOT_VALID_YET”. In

addition, AddressDoctor no longer reports the following warning for these codes when calling AD_Initialize or

AD_InitializeW:

AD_SC_WRN_INIT_UNLOCKCODE_EXPIRED = 2 = “The SetConfig.xml contained at least one expired or not yet

valid unlock code”.

1.6.2 Adjacent Unlock Codes

Unlock codes that are adjacent to the currently valid unlock codes or unlock codes that overlap are now

handled correctly by extending the internally computed engine expiration date accordingly. In the

GetConfig.xml file, adjacent unlock codes are reported with a status of “NOT_VALID_YET”.

1.6.3 Engine Expiration

In order to use the library, valid unlock codes of type VALIDATION are required. If no valid codes are present

in the SetConfig.xml file, the engine goes into an “expired” state. The engine does not accept any process

calls in the expired state. Instead, it returns the following critical error code:

AD_SC_CERR_EXPIRED = -1601 = “The engine usage period has expired or is not activated yet”.

The same situation occurs with a call to AD_Initialize and AD_InitializeW. In version 5.4.1, the engine is

initialized so that a GetConfig.xml file can be retrieved to get details about the unlock codes. Previous

versions did not allow any calls to the engine. However, it should be noted that no process calls can succeed

when the engine is in an “expired” state.

If the expiration date is reached and a call to AD_Process is made, the engine goes into an “expired” state

and returns the above error code. The engine must be re-initialized with valid unlock codes.

1.6.4 GetConfig.xml

The GetConfig.xml file reflects the status of the engine at the time of the AD_Initialize call.


13

1.6.5 New Unlock Codes for Supplementary Databases

With release 5.4.1, new unlock codes are needed for supplementary databases. Supplementary databases are available for the following countries:

Brazil

Germany

Japan

Serbia

South Africa

Switzerland

United Kingdom

United States

1.6.5.1 Existing Supplementary Data

AddressDoctor has generated the following unlock code valid until 31st

December 2014 for the previously supported supplementary databases: Japan, Serbia, United Kingdom and Unites States.

2AX90UWTV8FJF2KHLXWMY8F2D8WL5HFMK7MC

Insert the code within your configuration and re-initialize the engine to activate the previously supported

supplementary databases. The code is also available in the software library package within the SetConfig.xml

file.

1.6.5.2 New Supplementary Data

Contact your local sales representative to receive an unlock code for the following supplementary databases

which are new with this release:

Brazil, Germany, South Africa, and Switzerland.

1.6.5.3 New Status Values for Supplementary Unlock Codes

The following table describes the new status values that the initialization process can return for the new

supplementary unlock codes.

Status Value Description

ExxC Database is corrupt

ExxN Database not found

ExxU Database not unlocked

Note: <xx> is the ISO-2 alphacode (ISO 3166) of the country

1.7 SendRight Recertification AddressDoctor 5.4.1 has passed the 2014 Cycle of the SendRight Certification. Note that the Statement of Accuracy (SOA) ID is now changed from “ADR13_xxxxxxxx” to “ADR14_xxxxxxxx”, where xxxxxxxx is the unique identifier for the SOA.


14

1.8 Single Line Address Validation – Preliminary Release

AddressDoctor is pleased to announce its very first version of the Single Line Address Validation solution.

AddressDoctor can now parse and validate addresses that are entered in a single line. When a user enters an

address in a single line (into the AddressComplete element) in the fast completion mode of the software

library, AddressDoctor can generate suggestions to complete the address. For example, if a user enters 14

Main Street, AddressDoctor provides a list of all postal codes and cities related to this address.

The Single Line Address Validation solution is a new product offering that has its own unlock code. The single

line address validation feature is available as a “Preliminary Release” in version 5.4.1.

Contact your local sales representative if you are interested in evaluating the single line address validation

product.

Single line address validation is only supported for the following countries in this release:

Australia

Canada

Germany

Great Britain

New Zealand

United States

Addresses for all other countries return the following new process status value:

N6 Validation Error: No validation performed because single line address validation is not supported for the

country.

The Single Line Address Validation feature requires a new specific unlock code of type

SINGLE_LINE_VALIDATION. If no such code is given or it is not valid, the engine will return the following

process status value:

N7 Validation error: Feature not unlocked

AddressDoctor welcomes all comments and feedback on the single line address validation functionality.


15

2 Customer Reported Software Library Fixes and Closed Enhancements

Change Request

ID

Description 317169 ALL - Range of house numbers returned in alphabetical order instead of logical order

343603 AUS – Keyword variants for PO Box to be handled by the Engine

319451 AUT - Losing company information and changing street

326176 BRA - IBGE code is not implemented

297450 CAN - Address gives V2 in Certified, but Postal Relevance is all zeros

333007 CAN - SB and HNO trailing the street name

333387 CHE - Part of street name is parsed to HNO

300301 CHN – Parsing does not recognize company and moves it to locality

338817 CHN - Company and building are not parsed correctly

348869 CHN - Building and SubBuilding must be identified

350779 CUW - 2 digit ISO country code 'CW' is not recognized for CURACAO

338528 DNK - "TV" and "TH" parsing in Danish addresses

357236 DNK - Crash during parsing of CountrySpecificLocalityLine

344924 ESP - SubBuilding parsing switches positions

351087 ESP - Need to add "Modulo" as sub building descriptor

312433 FRA - SubBuilding data is lost during parsing

348115 HUN - Hyphenated HNO is being split between SubBuilding and HNO

345152 IND - Incorrect Process Status code is being returned

345321 IND - A portion of the input sub building data is lost

345322 IND – Postal code is added when many are available to choose from

356824 IND – Address crashes in 5.4.0

334726 JPN – Postal code only input no longer leads to a C4 corrected status value

337783 JPN – Address without a postal code is not correctly validated

342585 JPN - Street 稲村 is missing after validation

342860 JPN - Number 61 is moved to residue instead of HNO field after validation

342865 JPN - Improve the parsing between locality level 3 and street

343043 JPN - StreetComplete1 is missing a character from the input causing the output to be incorrect

346633 JPN - Numbers in the input address need to be parsed correctly to move them to HNO

352176 JPN – “ban” and “go” are not recognized when they are in Katakana

346632 JPN - Need improvement in building and sub-building parsing

346636 JPN – Incorrectly appends street to "Non-street" addresses

350961 JPN - Mailability should be 1 if no delivery information is there

353201 JPN - Incorrect Chome parsing causes incorrect validation result


16

Change Request

ID

Description 346632 The StreetComplete1 is missing a character from the input causing the output to be

incorrect

338213 POL - 'Danzig' should no longer be used as an English name

342192 PRT - Hyphen present in HNO should not cause an I-code

354247 RUS – Address crashes during validation process

300673 USA - Misspelled alternate for street name is not corrected

305734 USA – Correcting address in CERT mode but not Batch mode USA - Inconsistent behavior related to Pre-Directional USA - Tie condition on sub-building is not falling back to a street name assignment

314728 USA - Mailability score is too high for addresses with incorrect SubBuilding

321721 USA - Street corrections need improvement

327338 USA - Cannot correct address with incorrect postal code and misspelled locality

327587 USA - Fuzzy matching is not enabled for dual addresses

327588 USA – Incorrect parsing when multiple RECIPIENT address lines are submitted to DALs

342581 USA - Extra characters are being counted as errors for street validation

343337 USA - Street alias table is not available in Batch mode

343986 USA - HNO is missing from input, I4 status is preferred instead of a C4 to firm record

345997 USA - Unable to correct street name when AVE is provided on input instead of AVENIDA

346078 USA – “PO BX" is not being parsed as delivery service

346122 USA - Not normalizing HIGHWAY to HWY to make a match

351409 USA - Street COMPLETE_WITH_NUMBER component is not being populated

351713 USA - Display ZIP+4 codes for all interactive results

352073 USA - Incorrect change of street name

352481 USA - '1st Floor' is not treated the same as 'Floor 1'

355971 USA – Postal code and locality are being changed

357282 USA - Over correcting the Street name and post code, an I-code is expected 342394 ZAF - Performance issue when PO box number is present on DAL2


17

3 Platform Matrix

OS Compiler

Type Architecture Version C(++) Version JDK Version

Windows x86 XP MS VS2005 Sun SE 6 x86-64 XP MS VS2005 Sun SE 6

Linux (SUSE) x86 SLES 10 GNU gcc 4.1 Sun SE 6 x86-64 SLES 10 GNU gcc 4.1 Sun SE 6

Linux (RedHat) x86 RHEL 5 GNU gcc 4.1 Sun SE 6 x86-64 RHEL 5 GNU gcc 4.1 Sun SE 6 System z (64 Bit) RHEL 5 GNU gcc 4.1 IBM SE 6

AIX POWER (64 Bit) 5.3 IBM XL C++ 9 IBM SE 6

Solaris SPARC (64 Bit) 10 Sun Studio 12 Sun SE 6 SPARC (32 Bit) 10 Sun Studio 12 Sun SE 6 Intel (64 Bit) 10 Sun Studio 12 Sun SE 6

HP-UX IA64 11 HP aCC A.06.20 HP SE 5


18

4 Informatica Global Customer Support

4.1 Informatica Customer Support Centers You can contact a Customer Support Center by telephone or through the Online Support.

Online Support requires a user name and password. You can request a user name and password at http://mysupport.informatica.com. The telephone numbers for Informatica Global Customer Support are available from the Informatica web site at http://www.informatica.com/us/services-and-training/support-services/global-support-centers/.

4.2 Informatica My Support Portal As an Informatica customer, you can access the Informatica My Support Portal at http://mysupport.informatica.com.

The site contains product information, user group information, newsletters, access to the Informatica

customer support case management system (ATLAS), the Informatica How-To Library, the Informatica

Knowledge Base, Informatica Product Documentation, and access to the Informatica user community.

http://mysupport.informatica.com/

http://www.informatica.com/us/services-and-training/support-services/global-support-centers/

http://mysupport.informatica.com/

addressdoctor software library documentation/2/ad... · the unique delivery point reference number...

Documents