Active Address Users Guide
Active Address Users Guide
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
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
Street Address
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
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
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.
Canadian Addresses:
Val
uemayal sobe“ Stn”and“
RPO”
Canadian Addresses:
Value may also be Station name or Retail Postal Outlet name.
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
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.
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.
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.
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
Canadian Addresses:
Forward Sortation Area will be placed in Zip. This is the left segment of the postcode: A1A 1A1
Canadian Addresses:
Local Delivery Unit will be placed in Zip4. This is the right segment of the postcode: A1A 1A1
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
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.
[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:
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.
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