SSA-NAME3 API Reference Guide

10.2
- 10.5 HotFix 1
- 10.5
- 10.2 HotFix 1
- 10.1 HotFix 1
- 10.1
- 10.0 HotFix 1
- 10.0

Back Next

Validation Database Files

The validation process makes use of postal validation databases stored in a sub-directory of SSA-NAME3’s installation named

ssaas/ad/ad/db

for ASM using AddressDoctor v4 and

ssaas/ad5/ad/db

for ASM using AddressDoctor v5.

The Address Standardization Module installer does not install any validation databases. They are ordered separately by contacting Informatica Corporation. When you receive these files (named *.MD), you must copy them into the directory specified above. You will also receive a file named key that contains an unlock code for your specific databases. This file must be copied to the same directory.

Also in case of ASM using AddressDoctor v5 to support geocoding, unlock code for geocoding should be present in file named

key.geo

. This file must be copied to the same directory where key is copied.

ASM configuration for AddressDoctor v5

The values of unlock key, number of threads, maximum number of address object to be used for Address Standardization are determined from the values in the file

ssaasmv5.xml

The format of the ASM ADv5 configuration XML should be in UTF-8.

Address Standardization XML configuration file samples:

The simplest XML configuration file:

<?xml version="1.0" encoding="UTF-8"?>
<ASM_ADv5_Config>
<MAX_THREAD>1</MAX_THREAD>
<MAX_ADOBJECTS>2</MAX_ADOBJECTS>
<AD5_UNLOCK_CODE>
<UNLOCK_CODE>**Placeholder for UnlockCode**</UNLOCK_CODE>
</AD5_UNLOCK_CODE>
</ASM_ADv5_Config>

MAX_THREAD

value should not be set to a larger value than the number of cores/CPUs. Its recommended to set the value of

MAX_ADOBJECTS

as twice the number of threads set using

MAX_THREAD

. Also these options should be set before starting Name3 servers.

XML Configuration with multiple license key:


<?xml version="1.0" encoding="UTF-8"?>
<ASM_ADv5_Config>
        <MAX_THREAD>1</MAX_THREAD>
        <MAX_ADOBJECTS>2</MAX_ADOBJECTS>
        <AD5_UNLOCK_CODE>
             <UNLOCK_CODE>**Placeholder for UnlockCode 1**</UNLOCK_CODE>
             <UNLOCK_CODE>**Placeholder for UnlockCode 2**</UNLOCK_CODE>
                      ...
             <UNLOCK_CODE>**Placeholder for UnlockCode N**</UNLOCK_CODE>
        </AD5_UNLOCK_CODE>
</ASM_ADv5_Config>

XML configuration with preload options:


<?xml version="1.0" encoding="UTF-8"?>
<ASM_ADv5_Config>
        <MAX_THREAD>1</MAX_THREAD>
        <MAX_ADOBJECTS>2</MAX_ADOBJECTS>
        <AD5_UNLOCK_CODE>
             <UNLOCK_CODE>**Placeholder for UnlockCode 1**</UNLOCK_CODE>
        </AD5_UNLOCK_CODE>
        <PRELOAD_COUNTRIES>
                <PRELOAD TYPE="FULL">Switzerland</PRELOAD>
                <PRELOAD TYPE="PARTIAL" VALMODE="CORRECT">Canada</PRELOAD>
                <PRELOAD VALMODE="CERTIFY">Australia</PRELOAD>
        </PRELOAD_COUNTRIES>
</ASM_ADv5_Config>

Refer to

Character Sets and Countries

section for valid country name for preload.

XML configuration with enrichment options:


<?xml version="1.0" encoding="UTF-8"?>
<ASM_ADv5_Config>
								<MAX_THREAD>1</MAX_THREAD>
								<MAX_ADOBJECTS>2</MAX_ADOBJECTS>
								<AD5_UNLOCK_CODE>
															<UNLOCK_CODE>**Placeholder for UnlockCode 1**</UNLOCK_CODE>
								</AD5_UNLOCK_CODE>
								<PRELOAD_COUNTRIES>
																		<PRELOAD TYPE="PARTIAL" VALMODE="CERTIFY">Australia</PRELOAD>
								</PRELOAD_COUNTRIES>
								<PROCESS_OPTION>
																	<ENRICHMENT_OPTION>EnrichmentGeoCoding</ENRICHMENT_OPTION>
																	<ENRICHMENT_OPTION>EnrichmentCASS</ENRICHMENT_OPTION>
								</PROCESS_OPTION>
</ASM_ADv5_Config>

To get CASS, GeoCoding, AMAS, SERP enrichment fields we need to specify enrichment options. EnrichmentGeoCoding, EnrichmentCASS, EnrichmentAMAS, EnrichmentSERP, EnrichmentSNA etc. are the possible values for enrichment option.

Batch Test Utility

Provided with the Address Standardization Module is the batch utility asmnm3. This program utilizes all of the API functions. It takes address from an input file and can perform both parsing and validation. It is ideal for verifying programs that utilize the Address Standardization Module API or for batch processing a small number of addresses.

%SSABIN%\asmnm3 InputFile -hHostName:PortNumber [Options]

where

InputFile: The input file will consist of addresses in a ten line format. Addresses with less than 10 lines must be terminated with a comment line. This is a line beginning with the comment string which defaults to the ’#’ character.

-hHostName:PortNumber: NM3 Server host name and port number

Possible options are

-a	Prints the suggested address label.
-A	Force the use of archive tables.
-b	Force the use of ASM with Address Doctor v5 (default v4).
-cCharSet	The Character set to use. The default is WIN1250.
-dDefaultCountry	The Country to use when parsing cannot determine a country from the address.
-f	Force the use of the DefaultCountry.
-gFileName	CASS summary report file-name
-i	Individual field-level input. When specified, each input address consists of n lines, where n is the maximum number of Field-Index values supported, as documented in the Parsing an Address section. Each field value must be prefixed by 3 bytes (which are ignored). This reserves space for a 2 digit fieldindex plus a space, used for documentation purposes

For example, a valid input file appears as follows:

00
01
02
03 Mr.
04 John
05 Peter
06 Smith
07
08
09
10 Main Street S
11
12 100 Apt 23A
13
14
15 New York
16 NY
17 10023
18 USA
#

Option	Description
-Lpreload_country	The Country to use during preloading of database into memory.
-mValMode	The Mode to use for validation purposes valid values are Suggest , Correct and Complete . The default value is Suggest .
-o	PO Box complete flag.
-pPopulation	The SSA-Name3 Population to use.
-P	Force the use of partially fielded. This should be accompanied with Individual field-level input.
-sSystem	The NM3 System Directory
-S	Prints the address match score.
-rString	Set the comment string. This defaults to # .
-Tpreload_type	Set the preload type. This defaults to NOPRELOAD .
-v	Performs Validation. The default is to parse only.
-xml	Generate CASS 3553 summary report in xml format.
-y	Set preferred language type.
-z	Prints the Validation database version.
-ZzipFormat	Set the format of the output zip code. The valid values are BASE_ZIP and FORMAT_ZIP .

Rename Saved Search

Table of Contents

SSA-NAME3 API Reference Guide

SSA-NAME3 API Reference Guide

Validation Database Files

Validation Database Files

ASM configuration for AddressDoctor v5

Batch Test Utility