0% found this document useful (0 votes)
9 views

Active Address Users Guide

ActiveAddressUsersGuide

Uploaded by

shijenhe
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
9 views

Active Address Users Guide

ActiveAddressUsersGuide

Uploaded by

shijenhe
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 16

Address Verification & Standardization Component

The Software Company, Inc.


34467 Highview Drive
Pine, CO 80470-9704
www.SoftwareCompany.com
ActiveAddress v3.5 Introduction

ActiveAddress COM Object allows you to quickly and easily build address verification,
standardization and parsing into your custom applications. Accept addresses free-form and let
ActiveAddress do the rest. Each address will be standardized, split into USPS standard
components then graded for overall completeness and accuracy. Plus, no USPS database
subscription is required.

ActiveAddress can process all types of addresses including Suite Numbers and City/State/Zip. A
special Address_Quality flag is returned each time an address is processed allowing you to easily
identify questionable addresses before they enter your system. Also returned is the
Address_Type flag indicating the type of address being processed: Street, Military, PO Box,
Rural Route, Highway Contract, General Delivery or Suite giving you flexibility in their
handling. And, for a more appealing presentation, let ActiveAddress set the proper capitalization.

As a bonus, when you combine ActiveAddress with our ActiveGender product, you can handle
even the impossible task of identifying data that has been entered free-form, where the names,
addressesa ndC/ S/Z“ float”f rom f iel
dt of ield.You’ llalway sb ec ertainofwh atda tay ou'
re
working with.

ActiveAddress is being used by government agencies from coast-to-coast. Some states now
require that addresses be stored in standardized and parsed format to facilitate address matching
from agency to agency.

Features

 Save Time and Postage by Eliminating Partial or Non-Addresses


 User Updatable Tables So Your Applications Never Go Out-of-Date
 Proper Case Conversion for More Attractive Data Presentation
 No Recurring Update Charges
 FREE Upgrades for a Full Year
 Royalty Free Run-Time (first 100 end-user installations)
 Small Run-Time Package
 Designed for use with Visual Basic, C++, Visual FoxPro, ASP, Access, SQL and more
 Bullet-Proof and FAST
ActiveAddress v3.5 How ActiveAddress Works

ActiveAddress COM Object starts by meticulously identifying each individual address


component based on its context. Intuitive algorithms examine the results and a selection is made
of the most complete and correct data. If needed, format corrections are made and the USPS
recommended abbreviations are applied. The Address_Quality flag is then set to indicate how
complete and correct the address is. Finally, the standardized address components are returned to
your application along with a complete and cleansed composite address.

Strictc onfor mi
tyt oUSPS “ Pos talAddres s
ingSt anda rdsPubl i
cati
on28”e ns ur
e sc on si
s tent
standardization of every address. However, you can easily customize these settings for critical
applications.

ActiveAddress COM Object is the ONLY address verification and parsing software that can
reliably find and extract a Street Address when it's surrounded by extraneous data. It can even
separate Stree tAddre ssfromCi ty /
Sta
te/Zipwh ent h ey’reinthes amef ield.

The success or failure of any parsing software is dependent on how well it can handle "dirty"
addresses. These are addresses that have non-standard abbreviations or the address elements
are run together such as APT6. ActiveAddress can handle these and more.

Examples

Address_In: IS DEPT 123NE MAIN ST#1


Address_Out: 123 NE Main St # 1

Address_In: Re: DOC#222 123 ADAMS BL AP5%DORIS


Address_Out: 123 Adams Blvd Apt 5

Address_In: AP2,123NE SOUTH STREET WEST%JANE


Address_Out: 123 NE South St W Apt 2

Address_In: 6TH FLOOR ONE BROADWAY ST,RE:LN-123456


Address_Out: 1 Broadway St Fl 6
ActiveAddress v3.5 Address Elements

Street Address

123 NW Main St SW Apt 4

Suite_Number
Suite_Type
Street_Post_Dir
Street_Suffix
Street_Name
Street_Pre_Dir
Street_Number

Box Address

RR 12 Box 21

Box_Number
Box
Box_Type_Number
Box_Type

City/State/Zip

Pine Grove, CO 80470-9704

Zip_4
Zip
State
City
ActiveAddress v3.5 Input Properties

Address_In
Syntax: Address_In = String
Description:
Supplied by the user, this property is set to the address string to be processed.

After calling the Parse Method, the Address_In string will be standardized and corrected then
placed into the Address_Out property. In addition, each element of the Address_In string will be
placed into the appropriate address component property.

CSZ_In
Syntax: CSZ_In = String
Description:
Supplied by the user, this property is set to the city, state and zip string (last line) of the address.

After calling the Parse Method, the CSZ_In string will be standardized and corrected then placed
into the CSZ_Out property. In addition, each component of the CSZ_In property will be placed
into the appropriate City, State, Zip component property. Setti
ngCSZ_I nto“ USA”or“ Ca nada”
will force the appropriate interpretation of Address_In.

Canadian Addresses:
Municipality / Province / Postcode are synonymous with City / State / Zip respectively.

CSZ_InSameField
Syntax: CSZ_InSameField = Boolean
Description:
Supplied by the user, this property is set to Boolean (True/False) to indicate whether or not the
Address_In property also contains city/state/zip data. Set CSZ_InSameField to “ True”to parse
this extra data into the City, State and Zip properties. De
faul
tis“Fal se”.

Numeric_Street_Conv
Syntax: Numeric_Street_Conv = Boolean
Description:
Supplied by the user, this property is set to Boolean (True/False) to indicate whether or not to
convert a spelled out numeric street name to an ordinal number. (Third converts to 3rd, etc.) Set
Nume ric_Street_Con vt o“ Fal
se ”i fy ouwa nttor etaint heor igina lspe ll
edouts treetn ame .
Numeric street names are spelled out only when there are duplicate street names within a postal
delivery area and the only distinguishing factor is that one of them is spelled out. Default is
“Fal se”.
ActiveAddress v3.5 Input Properties

Reference_File_Path (changed in v3.0+)


Syntax: Reference_File_Path = String
Description:
Supplied by the user, this property is set to the full path and file name of the user-defined file
containing the Street_Suffix and Suite_Type abbreviations. A standard set of abbreviations is
supplied and installed in the Windows\System32 f olde run dert hena me :“ ActiveAddr e s
s.ref”.
You can rename and relocate this file to any other folder as long as you set the
Reference_File_Path property to the new path and file name. Default is “Windows\ System32”
folder.

You can switch to a different reference file prior to any call to ActiveAddress. However, each
switch will add a small amount of overhead and excessive switching may degrade the overall
performance of your application.

Se
e“Updat
ingUs
erCont
rolTabl
es”l
ate
rint
hisgui
def
ori
nst
ruc
tionsonc
ust
omi
zi
ngt
hisf
ile.

Output_Case (changed in v3.0+)


Syntax: Output_Case = StringLiteral
Description:
Suppl i
e db yt heus er,thispr ope r
tyi ss etto“ Upper”,“Lowe r
”,“Mixe
d”or“Non
e”t
oin
dic
ate
the desired casing of the output address and its components. Def
aul
tis“None
”.

Static_Key_Name (new in v3.0+)


Syntax: Static_Key_Name = String
Description:
Supplied by the user, this property is set to the name portion of the static key assignment or
blank.

Static_Key (new in v3.0+)


Syntax: Static_Key = String
Description:
Supplied by the user, this property is set to the key portion of the static key assignment or blank.
ActiveAddress v3.5 Output Properties

Address_Out (read only)


Syntax: String = Address_Out
Description:
After calling the Parse Method, this property will contain the standardized and corrected address
string from the Address_In property including a suite number if present. If the Address_In string
retu r
nsa nAddr ess_Qua li
tyof“ Low” ,Addr ess_Outpr ope rtywi llbebla nk.

Address_Out_Street (read only)


Syntax: String = Address_Out_Street
Description:
After calling the Parse Method, this property will contain only the street portion of Address_Out.

Address_Out_Suite (read only)


Syntax: String = Address_Out_Suite
Description:
After calling the Parse Method, this property will contain only the suite portion of Address_Out.

Street_Number (read only)


Syntax: String = Street_Number
Description:
After calling the Parse Method, this property is set to the primary address number component of
Address_In commonly referred to as house number, street number or range.

Street_Pre_Dir (read only)


Syntax: String = Street_Pre_Dir
Description:
After calling the Parse Method, this property is set to the Predirectional component of
Address_In. Values will be a valid directional (N, NE, S, SE, etc.) or blank.

Street_Name (read only)


Syntax: String = Street_Name
Description:
After calling the Parse Method, this property is set to the Street Name component of Address_In.
Value will be alphanumeric.
ActiveAddress v3.5 Output Properties

Street_Suffix (read only)


Syntax: String = Street_Suffix
Description:
After calling the Parse Method, this property is set to the Street Suffix component of Address_In.
Values will be a valid suffix (St, Ave, Rd, etc.) or blank.

Street_Post_Dir (read only)


Syntax: String = Street_Post_Dir
Description:
After calling the Parse Method, this property is set to the Postdirectional component of
Address_In. Values will be a valid directional (N, NE, S, SE, etc.) or blank.

Suite_Type (read only)


Syntax: String = Suite_Type
Description:
After calling the Parse Method, this property is set to the Suite Type component of Address_In.
Values will be only valid suite types (Apt, Suite, Unit, etc.) or blank.

Suite_Number (read only)


Syntax: String = Suite_Number
Description:
After calling the Parse Method, this property is set to the Suite Number component of
Address_In. Values will be alphanumeric suite number or blank.

Box_Type (read only)


Syntax: String = Box_Type
Description:
After calling the Parse Method, this property is set to the Box Type component of Addressing.
Values will be only valid box types (PO Box, RR, HC, etc.) or blank.

Box_Type_Number (read only)


Syntax: String = Box_Type_Number
Description:
After calling the Parse Method, this property is set to the Box Type Number component of
Address_In. Values will be alphanumeric box type number or blank.
ActiveAddress v3.5 Output Properties

Box (read only)


Syntax: String = Box
Description:
After calling the Parse Method, this property is set to the Box component of Address_In. Value
willb e“Box”orbl an k.

Canadian Addresses:
Val
uemayal sobe“ Stn”and“
RPO”

Box_Number (read only)


Syntax: String = Box_Number
Description:
After calling the Parse Method, this property is set to the Box Number component of
Address_In. Values will be alphanumeric box number or blank.

Canadian Addresses:
Value may also be Station name or Retail Postal Outlet name.

Address_Quality (read only)


Syntax: String = Address_Quality
Description:
After calling the Parse Method, this property is set according to the completeness of the
Input_Address. "Low" if no recognizable address is present. "Medium" if an address is present
but is incomplete, such as a missing apartment number or street suffix. "High" is returned when a
complete and technically correct address is found.

Ifyoura ddr
ess
es“ float”from f iel
dt ofi
e l
dy ouc ane asi
lyde terminewhi chfiel
dc on tainst he
address through trial and error by examining Address_Quality and Address_Type after trying
each field.
ActiveAddress v3.5 Output Properties

Address_Type (read only)


Syntax: String = Address_Type
Description:
After calling the Parse Method, this property is set to one of the following address types:
S Street (1 N Main St, 2 US Highway 441, etc.)
A Suite (Apt 1, Suite 2, etc.)
P Post Office Box (PO Box 1)
R Rural Route (RR 1 Box 2)
H Highway Contract (HC 1 Box 2)
G General Delivery (Gen Del, GD, etc.)
M Military (CMR 1 Box 2, etc.)
N Not a valid address tt
Address_Quality will also be se o“
Low”

Address_Leading_Data (read only)


Syntax: String = Address_Leading_Data
Description:
After calling the Parse Method, this property will contain all data that precedes the actual
addres s
.I ftheAddr ess_I
ns tr
ingr eturnsa nAddr e ss_Qua lit
yof“ Low” ,t hi
spr opertywi llbe
blank.

Address_Trailing_Data (read only)


Syntax: String = Address_Trailing_Data
Description:
After calling the Parse Method, this property will contain all data that follows the actual address.
sa
If the Address_In string return nAddr ess_Qua lityof“ Low” ,thispr ope rtywillbebl an k.

Address_Filtered_Data (read only)


Syntax: String = Address_Filtered_Data
Description:
After calling the Parse Method, this property will contain all data that was filtered out before
processing according to the [NameFilter] section of ActiveAddress.ref file.
ActiveAddress v3.5 Output Properties

CSZ_Out (read only)

Syntax: String = CSZ_Out

Description:
After calling the Parse Method, this property will contain the standardized city/state/zip (last
line) from the CSZ_In property.

Canadian Addresses:
Municipality / Province / Postcode are synonymous with City / State / Zip respectively.

Country (read only)(new in v3.0+)

Syntax: String = Country

Description:
After calling the Parse Method, this property will contain the country identified by the city, state,
zip. Values will be USA, Canada, USA Military, USA Possession or blank.

Canadian Addresses:
Municipality / Province / Postcode are synonymous with City / State / Zip respectively.

City (read only)

Syntax: String = City

Description:
After calling the Parse Method, this property is set to the City component of CSZ_In.

Canadian Addresses:
Municipality will be placed in City.

State (read only)

Syntax: String = State

Description:
After calling the Parse Method, this property is set to the State component of CSZ_In. Values
will be only valid USPS state abbreviations (FL, AZ, CO, etc.) or blank.

Canadian Addresses:
Province abbreviation will be placed in State.
ActiveAddress v3.5 Output Properties

Zip (read only)


Syntax: String = Zip
Description:
After calling the Parse Method, this property is set to the Zip component of CSZ_In. Values will
be only 5-digit numeric zip codes or blank.

Canadian Addresses:
Forward Sortation Area will be placed in Zip. This is the left segment of the postcode: A1A 1A1

Zip4 (read only)


Syntax: String = Zip4
Description:
After calling the Parse Method, this property is set to the Zip+4 component of CSZ_In. Values
will be only 4-digit numeric zip add-on codes (sector/segment) or blank.

Canadian Addresses:
Local Delivery Unit will be placed in Zip4. This is the right segment of the postcode: A1A 1A1

CSZ_Quality (read only)


Syntax: String = CSZ_Qualty
Description:
After calling the Parse Method, thispr ope rtyi ss ett
o” Low” ,“ Me dium”or“
High”t
oin
dic
ate
the probability that the CSZ_In property value is complete and correct.
ActiveAddress v3.5 Output Properties

Return_Code (read only)(new in v3.0+)


Syntax: String = Return_Code
Description:
After calling the Parse method, this property is set to blank upon successful completion. Some
common exceptions are listed below. Most exceptions usually occur on the first call to the Parse
method. This property should be examined upon each return from the Parse method.

Common Return Codes:


R35 Reference File Not Found
T00 Suffix Table Limit Reached (1024)
T01 Suite Type Table Limit Reached (1024)
T02 Filter Table Limit Reached (1024)
L00 License Expired
L01 Static Key Validation Failed
L50 - L69 License Validation Failed
ActiveAddress v3.5 Methods

Clear
Syntax: Object.Clear
Description:
After calling the Clear method, all associated output properties will be set to a null string.

Parse
Syntax: Object.Parse
Description:
After calling the Parse method, the Address_In property will be standardized and corrected then
placed into the Address_Out property. In addition, each element of the Address_In property will
be placed into the appropriate address component property and the Address_Quality and
Address_Type flags appropriately set. The Return_Code property is also set and should be
checked after each call to the Parse method. See “Return_Code”property elsewhere in this
guide.
ActiveAddress v3.5 Control Tables

Updating User Control Tables

ActiveAddress.ref contains a complete list of street suffixes and suite types along with their
abbreviationsa ndf ulls pe ll
ings .I tisloc atedint h e“Windows\System32”f older
.Us eNot epador
a similar text editor to edit the file. Detailed instructions on the format of the entries are
contained within the file. This file can also be relocated. See Reference_File_Path property.

ActiveAddress allows you to specify which street suffixes and suite types are to be recognized as
well as your preferred abbreviations.

The filter section of the table allows you to specify which, if any, characters, words or phrases
are to be ignored during processing. All filters that were found in the Address_In property will
be stored in the Address_Filtered_Data property.

Extensive tables are included. Below are a few examples:

[StreetSuffix]
ST Street St Y
STR Street St N
STREET Street St N

[SuiteType]
STE Suite Ste Y
SUITE Suite Ste Y

[Filter]
C/O
ET AL
ActiveAddress v3.5 Installation Notes

IfInst
all
ati
on Doesn’
tSt
art Automatically:

 Select Start > Run from the Task Bar.


 Type CD-ROM dr ivel e
tterfollowedby“ :
\ActiveAddr
ess
35.
msi
”an
dpr
esse
nte
r.

Inth ef ol
der“Pr ogram Fi l
es\The Software Company\ActiveAddress 3.5”y ouwi llfindas ample
program named: Sample.vbp. There is also a compiled version called Sample.exe that you can
run to demonstrate ActiveAddress.

Deploying Your Applications

“Ac tiveAddr ess.


dll
”i sus ua l
lypl acedi nt heappl i
c ati
onf ol
de roft hetarget machine and must be
registered with Windows. You c anus eRe gsvr32. exef ort hispur pos e.Th e“Ca r?????.dll
”f il
e s
areus ua l
lypl acedi nth e“ Wi ndows \Sy st
em32”f older.Th e“ Ac tiv
e Address.r
e f”fi
lei slocate d,
byde fault,int he“ Wi ndows \System32”f ol
de rb utc anb er elocateda ny whe r
eont hetarget
machine as long as the full path and file name are specified in the Reference_File_Path property.

Be sure to include all of the following in your installation package:

ActiveAddress.dll –register with Windows (you can use Regsvr32.exe for this purpose)

In addition to the above, there is a small runtime package which is usually installed into
“Windows\System32 folder” . These do not need to be registered with Windows.

Carcla35.dll
Carclw60.dll
Carfsw20.dll
ActiveAddress.ref*

* ActiveAddress.ref can be relocated anywhere on the target machine as long as the full path and
file name are specified in the Reference_File_Path property.

This product is initially licensed for a period of 30 days or up to 1000 calls. It must be registered
to continue using it after this evaluation period. Please contact us at:

[email protected]
P: 303/838-1223
F: 303/838-1224

You might also like