Operations Guide

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

Back Next

ASM Workbench Input Options

ASM Workbench

Country Specific Input

Country specific Input:

Force Country option

Force country

option is used to force the use of default country.

Before selecting a Country Name for validating an address or preloading country database into memory, appropriate Postal database (

.MD

) file must be present in

%SSATOP%/ssaas/ad/ad/db

directory for ASM using AddressDoctor v4 and in

%SSATOP%/ssaas/ad5/ad/db

directory for ASM using AddressDoctor v5.

Character Set

This is used to define the character set of the input data. The parsed / validated address fields will be returned to the caller using this character set as well.

Country Preload Option

Preload

option provides greater flexibility in loading the country address database into memory. The preload option includes partial preload for US CASS (certified) including ZIP move and EWS data. Only one country database can be preloaded. If database file is not located or insufficient memory, causes preload to fail.

Partial Preload: Partial preloading will load the data and indexing structures into memory. The reference data itself will remain on the hard drive. Partial is an alternative when not enough memory is available to fully load the desired databases.
Full Preload: Full preloading will move the entire reference database into memory. This may need a significant amount of memory for countries with large databases such as USA or, but it will increase the processing speed significantly.
Before preload of country verify selected country name contains corresponding database (
.MD
) file located in appropriate postal reference database directory
%SSATOP%/ssaas/ad/ad/db
for ASM using AddressDoctor v4 and
%SSATOP%/ssaas/ad5/ad/db
for ASM using AddressDoctor v5.

Address Input Type

Fielded address Input: Fielded addresses will typically provide the most reliable results when cleansing an address. This address input provide separate field for each address component input.
Partially Fielded Input: In many databases address data has been partially broken out. for example a separate state, or postal code field. But some of the address is left in generic "address lines". In this case the address data are input using the fielded data (example: Contact, Province, Locality, Country, Postal Code) by selecting Fielded address input type, and then use the DeliveryAddressLines to input the
ADDRESS_LINE_*
elements, this is done by selecting Partially Fielded checkbox.
UnFielded Input: UnFielded Address Input has no explicit structure (other than 10 line input) this input is most flexible, but produce least reliable results.

Options

Batch Mode: Batch Mode is mainly used for importing input file containing unfielded input data and correcting the input address.
Interactive Mode: Interactive Mode is user driven, user has to use either unfielded (10 line input) or fielded inputs (individual components address input).

Parsing and Validation Frame

ASM Workbench provides four different operations for parsing, validating, certify input address and reset for clearing the input fields. For Fielded Address Format type Parse button will be disabled and for certify validation mode Validation button will be disabled.

Attributes

Preferred Language: This option is used to represent address into appropriate language type.

Option Value
Meaning

POSTAL_ADMIN
Set preferred language to that which is preferred by the postal service. This is the default.

LATIN_SCRIPT
Return the address using Latin script.

ENGLISH
English version of the address.
Validation Mode: Some optional aspects of Address Standardization behavior may be set by selecting the Validation Mode combo box.

Option Value
Meaning

Correct
Correct the input address. Do not generate suggestions. Generally used in batch mode.

Suggest
Generate suggestions (the default). Generally used by online applications where the operator can choose between a list of possibilities.

Complete
Use an incomplete address (fragment) to quickly generate suggestions. Used for online "fast completion" style of applications.

Certify
Use CASS certified validation rules defined by the USPS. Certify mode is only available for US addresses and requires additional database files to be installed in the DB directory.
Archive Check: Archive Check option will include vanity names and outdated names (especially for localities) in the processing. Skipping this option will improve the speed very slightly, but may not correct addresses containing vanity names or outdate locality names. Two countries where you should definitely use this option are Germany and the US.

Option Value	Meaning
POSTAL_ADMIN	Set preferred language to that which is preferred by the postal service. This is the default.
LATIN_SCRIPT	Return the address using Latin script.
ENGLISH	English version of the address.

Option Value	Meaning
Correct	Correct the input address. Do not generate suggestions. Generally used in batch mode.
Suggest	Generate suggestions (the default). Generally used by online applications where the operator can choose between a list of possibilities.
Complete	Use an incomplete address (fragment) to quickly generate suggestions. Used for online "fast completion" style of applications.
Certify	Use CASS certified validation rules defined by the USPS. Certify mode is only available for US addresses and requires additional database files to be installed in the DB directory.

Suggested Address Label Display

The address shown in the suggested address label display is formatted according to the address formatting rules in the country

Address Result Panel Display

After parsing or validation, individual address fields are available for collection as part of a "suggestion". Suggestion 0 always holds the parsed fields. Suggestions numbered 1 and above hold the validated address fields. Individual fields are viewed in the List box in Output Results Frame. When the users has chosen the

UnFielded

and

validate

option, then Output frame list out the suggestion for the input address, once the user clicks on each suggestion the output address data from the List is mapped to corresponding fields in Fielded address display panel.

Validation Status and Database Version Display

Status bar displays Validation postal database version, AddressDoctor version and the status message when we press the validation button to validate the address.

Where version represents the Validation Database version and the status represent the Validation Status as mention in the following table for ASM using AddressDoctor v4:

Status Code	Meaning
0	Address is correct
1	Address was corrected
2	Needs correction; deliverability high
3	Needs correction; deliverability fair
4	Needs correction; deliverability small
5	Country not recognized
6	No valid country database found
7	Country not unlocked
8	No validate called yet
9	Insufficient information
10	No suggestions
11	Suggestions incomplete
12	Suggestions

Refer below table for validation status for ASM using AddressDoctor v5:

Status Code	Meaning
0	Verified - Input data correct - all elements were checked and input matched perfectly
1	Verified - Input data correct on input but some or all elements were standardised or input contains outdated names or exonyms
2	Verified - Input data correct but some elements could not be verified because of incomplete reference data
3	Verified - Input data correct but the user standardisation has deteriorated deliverability
4	Corrected - all elements have been checked
5	Corrected - but some elements could not be checked
6	Corrected - but delivery status unclear
7	Corrected - but delivery status unclear because user standardisation was wrong
8	Data could not be corrected completely, but is very likely to be deliverable - single match
9	Data could not be corrected completely, but is very likely to be deliverable - multiple matches
10	Data could not be corrected, but there is a slim chance that the address is deliverable
11	Data could not be corrected and is pretty unlikely to be delivered
12	FastCompletion Status - Suggestions are available - complete address
13	FastCompletion Status - Suggested address is complete but combined with elements from the input
14	FastCompletion Status - Suggested address is not complete
15	FastCompletion Status - Insufficient information provided to generate suggestions
16	Country recognized from ForceCountryISO3 Setting
17	Country recognized from DefaultCountryISO3 Setting
18	Country recognized from name without errors
19	Country recognized from name with errors
20	Country recognized from territory
21	Country recognized from province
22	Country recognized from major town
23	Country recognized from format
24	Country recognized from script
25	Country not recognized - multiple matches
26	Country not recognized
27	Parsed perfectly
28	Parsed with multiple results
29	Parsed with Errors - Elements change position
30	Parse Error - Input Format Mismatch
31	Validation Error: No validation performed because country was not recognized
32	Validation Error: No validation performed because required reference database is not available
33	Validation Error: No validation performed because country could not be unlocked
34	Validation Error: No validation performed because reference database is corrupt or in wrong format
35	Validation Error: No validation performed because reference database is too old - you need to contact AddressDoctor to obtain updated reference data

Output Result Frame Column Selection Menu

Output Result Frame also provides option to select the list of column that user wants to view on the Output result panel. When the user right clicks on the list panel then popup menu displays on the screen showing the list of columns that user wants to enable or disable on the list.

Field Status Display

Match Status: All results share a Match Status that describes how the address elements matched to the postal reference data. Refer below table for match status for ASM using AddressDoctor v4:

Match Status
Meaning

0
Empty

1
Not found

2
Not Checked (no reference data or no chance of success)

3
Matched with errors

4
Matched without errors

Refer below table for match status for ASM using AddressDoctor v5:

val_status
Meaning

0
Empty

1
Not found

2
Not checked (no reference data)

3
Wrong - Set by validation only

4
Match with errors in this element

5
Match with changes

6
Match without errors
Result Status: The Result Status indicates for each address component if and how it has been modified during the address validation process. Refer below table for result status for ASM using AddressDoctor v4:

Result Status
Meaning

0
Empty

1
Not checked

2
Not checked but standardized

3
Checked and corrected (changed or inserted)

4
Validated, but changed (synonyms, old names)

5
Validated, but standardized

6
Validated and unchanged

Refer below table for result status for ASM using AddressDoctor v5:

val_mods
Meaning

0
Empty

1
Not validated and not changed

2
Not validated bus standardized

3
Validated but not changed due to invalid input

4
Validated but not changed due to lack of reference data

5
Validated but not changed due to multiple matches

6
Validated and changed by eliminating the input value

7
Validated and changed due to correction based on reference data

8
Validated and changed by adding value based on reference data

9
Validated, not changed, but delivery status not clear

12
Validated, verified but changed due to outdated name

13
Validated, verified but changed from exonym to official name

14
Validated, verified but changed due to standardization based on casing or language

15
Validated, verified and not changed due to perfect match

Match Status	Meaning
0	Empty
1	Not found
2	Not Checked (no reference data or no chance of success)
3	Matched with errors
4	Matched without errors

val_status	Meaning
0	Empty
1	Not found
2	Not checked (no reference data)
3	Wrong - Set by validation only
4	Match with errors in this element
5	Match with changes
6	Match without errors

Result Status	Meaning
0	Empty
1	Not checked
2	Not checked but standardized
3	Checked and corrected (changed or inserted)
4	Validated, but changed (synonyms, old names)
5	Validated, but standardized
6	Validated and unchanged

val_mods	Meaning
0	Empty
1	Not validated and not changed
2	Not validated bus standardized
3	Validated but not changed due to invalid input
4	Validated but not changed due to lack of reference data
5	Validated but not changed due to multiple matches
6	Validated and changed by eliminating the input value
7	Validated and changed due to correction based on reference data
8	Validated and changed by adding value based on reference data
9	Validated, not changed, but delivery status not clear
12	Validated, verified but changed due to outdated name
13	Validated, verified but changed from exonym to official name
14	Validated, verified but changed due to standardization based on casing or language
15	Validated, verified and not changed due to perfect match

CASS Field Status Display

When validating address using validation mode as Certify, The Result panels shows validated address fields and when Display CASS Fields is selected will pop up CASS fields dialog as shown below:

CASS Summary Report Display

USPS Form 3553 CASS certification can be generated by selecting

View CASS Report

from popup menu displayed in the address result tab for CASS certified address. Selecting this option displays

CASS Summary

report dialog as shown below:

Statistics Reports - CASS Certification

ASM also provides options to generate USPS CASS 3553 Summary report which displays total records coded in each category. The report can be generated in HTML and XML format. CASS 3553 summary report sections are explained in detail under

CASS Summary Report Display

File Menu Options

File | Clear Results: Menu option
File
Clear Results
menu option is used to clear the address result output display windows.
File | Save Input: Menu option
File
Save Input
will prompt File Dialog, this options reads the file name from user and dumps address input and options(including validation mode, preload option, attributes) in the input file, which can be used as input for ASM Batch Test utility.
File | View CASS Summary: Menu option
File
View CASS Summary
will display CASS Summary report dialog.
File | Generate CASS Report: Menu option
File
Generate CASS Report
will prompt File Dialog, this options reads the file name from user and generate CASS summary for the input address. File format can be either XML or HTML.
File | Clear CASS Summary: Menu option
File
Clear CASS Summary
is used to clear accumulated CASS summary after multiple validation using validation mode as certify.
File | Exit: Menu option
File
Exit
will prompt to close and exit all SSA-NAME3 Workbench sessions.

Rename Saved Search

Table of Contents

Operations Guide

Operations Guide

ASM Workbench Input Options

ASM Workbench Input Options

Country Specific Input

Character Set

Country Preload Option

Address Input Type

Options

Parsing and Validation Frame

Attributes

Suggested Address Label Display

Address Result Panel Display

Validation Status and Database Version Display

Output Result Frame Column Selection Menu

Field Status Display

CASS Field Status Display

CASS Summary Report Display

Statistics Reports - CASS Certification

File Menu Options