Quick Reference for Library Products ■ May 2012
2012-05-24
Copyright
© 2012 SAP AG. All rights reserved.SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP BusinessObjects Explorer, StreamWork, SAP HANA and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries.Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects Software Ltd. Business Objects is an SAP company.Sybase and Adaptive Server, iAnywhere, Sybase 365, SQL Anywhere, and other Sybase products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Sybase, Inc. Sybase is an SAP company. Crossgate, m@gic EDDY, B2B 360°, B2B 360° Services are registered trademarks of Crossgate AG in Germany and other countries. Crossgate is an SAP company. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. 2012-05-24
Contents
3
Chapter 1
DataRight IQ Library...............................................................................................................5
1.1 1.2 1.2.1 1.2.2 1.2.3 1.2.4 1.2.5 1.2.6 1.2.7 1.2.8 1.2.9 1.2.10 1.2.11 1.2.12
DataRight IQ input fields .........................................................................................................5
Chapter 2
ACE U.S................................................................................................................................17
2.1 2.2 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6 2.2.7 2.2.8 2.2.9 2.2.10 2.2.11 2.2.12 2.2.13
ACE U.S. input fields.............................................................................................................17
DataRight IQ output items........................................................................................................8 Name items.............................................................................................................................8 Dual name items......................................................................................................................9 Firm items..............................................................................................................................10 Address items........................................................................................................................10 Last line items........................................................................................................................11 U.S. Social Security number items.........................................................................................11 Date items.............................................................................................................................11 U.S. phone items...................................................................................................................12 International phone items.......................................................................................................13 E-mail items ...........................................................................................................................14 User-defined pattern items.....................................................................................................16 Extra items.............................................................................................................................16
ACE U.S. output fields...........................................................................................................21 ace_get_component...............................................................................................................22 Alphabetical list of last-line components.................................................................................22 Alphabetical list of assigned address-line components...........................................................24 Alphabetical list of alias address-line components..................................................................27 Alphabetical list of dual address-line components...................................................................29 Alphabetical list of components available for multiline input....................................................31 Alphabetical list of postal codes.............................................................................................33 Alphabetical list of codes that describe address and assignment results................................34 Alphabetical list of other useful codes....................................................................................41 Output components: move data.............................................................................................46 Output components: NCOALink data.....................................................................................50 Output components: LACSLink..............................................................................................52 Output components: ANKLink................................................................................................54
2012-05-24
Contents
4
2.2.14 2.2.15 2.3 2.4 2.5 2.5.1
SuiteLink output fields............................................................................................................55
Chapter 3
Match/Consolidate...............................................................................................................69
3.1 3.1.1 3.1.2 3.1.3 3.1.4 3.2 3.2.1 3.2.2 3.2.3 3.2.4 3.2.5 3.2.6
Match key fields.....................................................................................................................69
Index
95
Alphabetical list of Geocensus codes.....................................................................................56 ACE U.S. address status codes.............................................................................................59 ACE address error codes (U.S. and Canada).........................................................................63 ACE U.S. suggestion list components ...................................................................................65 U.S. suggestion list output components.................................................................................65
Key fields for name and firm data ..........................................................................................69 Key fields for address data.....................................................................................................71 Alphabetical list of key fields for other data............................................................................73 Alphabetical list of key fields for overall scoring......................................................................74 Match configuration file parameters.......................................................................................75 Overall configuration file.........................................................................................................75 Key configuration file..............................................................................................................76 General configuration file........................................................................................................78 Keyfield match options configuration file................................................................................83 Auto options configuration file................................................................................................88 Rule definitions configuration file............................................................................................89
2012-05-24
DataRight IQ Library
DataRight IQ Library
This section contains input fields and output items for use within DataRight IQ. For details about the codes, options, and API calls used in conjunction with these items, see the DataRight IQ User's Guide. The fields and items in this section are current through DataRight IQ 7.90c.
1.1 DataRight IQ input fields
5
Type of data
Field name
Description
Example of data
Discrete Name/Title components
DRL_IPRENAME1-2
Discrete prename, such as "Mr.," "Mrs.," "Dr.," or "Lt. Col."
Mr.
DRL_IFNAME1-2
Discrete first name.
John
DRL_IMNAME1-2
Discrete middle name.
B.
DRL_ILNAME1-2
Discrete last name.
Smith
DRL_IHONPOST1-2
Discrete honorary postname, such as "Ph.D" or "CPA."
Ph.D, CPA
DRL_IMAT_POST1-2
Discrete postname, such as "Jr." or "Sr."
Jr., Sr.
DRL_ITITLE1-2
Discrete job title, such as "Software Engineer."
Manager
2012-05-24
DataRight IQ Library
Type of data
Field name
Description
Example of data
Name line
DRL_INAMELINE1-6
Whole name or names. May include job title, or job title may be presented separately in DRL_ITITLELINEx.
Mr. John B. Smith Jr., CPA, Manager William and Patricia Johnson Jones, Mr. Robert A.
Title line
DRL_ITITLELINE1-6
Job title. Use this field with the DRL_INAMELINEx fields.
Accountant
Note: If you use discrete name components, use the DRL_ITITLEx field instead of this field. Firm
Firm
Firm components
DRL_IFIRMNAME1-2
Name of a company or organization.
Business Objects
DRL_INAME_FIRM16
Name of a person or oganization.
Business Objects
DRL_IFIRMLOC1-2
Location within a company or organization, such as a department, mail stop, room, or building.
Building 2A Dept. of Accounting Mail stop 210
Note: DataRight IQ does not assume or maintain any relationship between the DRL_IFIRMNAMEx and DRL_IFIRMLOCx fields. For example, if you pass in a firm location through DRL_IFIRMLOC2, DataRight IQ does not assume that this is a firm location for the company named in DRL_IFIRMNAME2.
6
2012-05-24
DataRight IQ Library
Type of data
Field name
Description
Example of data
Multiple firm
DRL_IFIRMLINE1-2
Firm name, firm location, or both.
Business Objects
components
Dept. of Accounting
Phone number
DRL_IPHONE1-6
Phone number.
555-878-8787
E-mail address
DRL_IEMAIL1-6
E-mail address.
[email protected]
Date1-6
DRL_IDATE1-6
Date
08/16/2002
Social Security number
DRL_ISSN1-6
U.S. Social Security number
111-22-3333
User-defined data
DRL_IUDPM1-4
Input of data that you have defined in your pattern file (drludpm.dat).
CN244-56
For information about using user-defined patterns, see the DataRight IQ Modifier's Guide.
7
Address data
DRL_IADDRESS1-2
A line that can contain only an address.
541 N. Grant Ave.
Last-line data
DRL_ILAST_LINE1-2
A line that can contain only last line information.
LaCrosse, WI 54601
2012-05-24
DataRight IQ Library
Type of data
Field name
Description
Example of data
Input line data
DRL_ILINE1-12
DataRight IQ tries to parse all item types from this line in the following order. • Address • Last line • E-mail • SSN • Date • US phone • International phone • UDPM • Name • Firm
Mr. John B. Smith, CPA Manager Business Objects, Acctg. Dept. Mailstop 210
1.2 DataRight IQ output items
1.2.1 Name items Table 1-2: DataRight IQ output items for name
8
Item type
Field name
Description
Example
Parent
DRL_PERSON
All components for one person (except title).
Attn: Mr. John B. Smith, Jr.
2012-05-24
DataRight IQ Library
Item type
Field name
Description
Example
Component
DRL_NAME_DESIG
Name designator such as ATTN: or c/o.
ATTN:
DRL_NAME_SPEC
Special name.
Current Resident or Occupant
DRL_PRENAME
Prename.
Mr.
DRL_FIRST_NAME
First name.
John
DRL_MID_NAME
Middle name.
B.
DRL_LAST_NAME
Surname.
Smith
DRL_PRELAST
A prefix on a last name.
Von
DRL_MAT_POST
Maturity postname indicating heritage, such as Jr., Sr., III.
Jr.
DRL_HON_POST
Honorary postname indicating certification, academic degree, or affiliation.
CPA
DRL_TITLE
Job or occupational title of a person.
Manager
1.2.2 Dual name items
9
2012-05-24
DataRight IQ Library
Table 1-3: DataRight IQ output items for dual name Item type
Field name
Description
Example
Parent
DRL_NAME_DUAL
Two persons sharing one last name.
Terry and Kris Johnson
Component
DRL_NAME_CONNEC TOR
The connector component of a dual name.
and
1.2.3 Firm items Table 1-4: DataRight IQ output items for firm Item type
Field name
Description
Example
Parent
DRL_FIRM
The name of a company or organization.
Business Objects
Component
DRL_FIRM_LOC
A location within a company or organization, such as a department.
Accounting Dept.
1.2.4 Address items Table 1-5: DataRight IQ output items for address
10
Item type
Field name
Description
Example
Parent
DRL_ADDRESS
The street address.
541 N. Grant Ave.
2012-05-24
DataRight IQ Library
1.2.5 Last line items Table 1-6: DataRight IQ output items for last line Item type
Field name
Description
Parent
DRL_LAST_LINE
The city, state, and ZIP Code.
LaCrosse, WI 54601
1.2.6 U.S. Social Security number items Table 1-7: DataRight IQ output items for U.S. Social Security number Item type
Field name
Description
Example
Parent
DRL_SSN
A social security number.
555-55-5555
Component
DRL_SSN_AREA
The first three numbers of the social security number.
555
DRL_SSN_GROUP
The fourth and fifth numbers within a social security number
55
DRL_SSN_SERI AL
The last four numbers in a social security number.
5555
1.2.7 Date items
11
2012-05-24
DataRight IQ Library
Table 1-8: DataRight IQ output items for date Item type
Field name
Description
Example
Parent
DRL_DATE
A date that is parsed.
08-16-1977
Component
DRL_DATE_MONTH
The month that is parsed from the date.
Aug
DRL_DATE_DAY
The day that is parsed from the date.
16
DRL_DATE_YEAR
The year that is parsed from the date.
1977
1.2.8 U.S. phone items Table 1-9: DataRight IQ output items for U.S. phone
12
Item type
Field name
Description
Example
Parent
DRL_US_PHONE
An entire U.S. phone number.
(608) 555-5555
2012-05-24
DataRight IQ Library
Item type
Field name
Description
Example
Component
DRL_US_PHONE_AREA_CODE
The area code parsed from the phone number.
608
DRL_US_PHONE_PREFIX
The middle three numbers parsed from a phone number.
In "(608) 555-5555," "555" is returned.
DRL_US_PHONE_LINE
The last four numbers (excluding an extension) parsed from a phone number.
In "(608) 555-5555," "5555" is returned.
DRL_US_PHONE_EXT
An extension parsed from the phone number.
3000
DRL_US_PHONE_TYPE
The type of phone number that was parsed, if it is included with the input.
"Home" or "Work," for example.
1.2.9 International phone items Table 1-10: DataRight IQ output items for international phone
13
Item type
Field name
Description
Parent
DRL_INTERNATIONAL_PHONE
The entire international phone number, including extra items such as the country code.
2012-05-24
DataRight IQ Library
Item type
Field name
Description
Component
DRL_INTERNATION AL_PHONE_COUN_CODE
The country code of an international phone number.
DRL_INTERNATION AL_PHONE_CITY_CODE
The city code of the international phone number.
DRL_INTERNATIONAL_PHONE_LINE
The portion of the international phone number that is not the country code or the city code.
DRL_INTERNATIONAL_PHONE_DESC
The name of the country of origin of an international phone number.
1.2.10 E-mail items Table 1-11: DataRight IQ output items for e-mail
14
Item type
Field name
Description
Example
Parent
DRL_EMAIL
An entire e-mail address.
[email protected]
2012-05-24
DataRight IQ Library
15
Item type
Field name
Description
Example
Compo nents
DRL_EMAIL_USER
The user name of the e-mail address.
In "
[email protected]," "expat" is returned.
DRL_EMAIL_DOMAIN_ALL
The domain of the e-mail address.
london.home.of fice.city.co.uk
DRL_EMAIL_DOMAIN_TOP
The last listed domain of the e-mail address.
uk
DRL_EMAIL_DOMAIN_SEC OND
In an e-mail address with more than one domain listed, this field parses the second to last domain.
co
DRL_EMAIL_DO MAIN_THIRD
In an e-mail address with more than one domain listed, this field parses the third to last domain.
city
DRL_EMAIL_DO MAIN_FOURTH
In an e-mail address with more than one domain listed, this field parses the fourth to last domain.
office
DRL_EMAIL_DO MAIN_FIFTH
In an e-mail address with more than one domain listed, this field parses the fifth to last domain.
home
DRL_EMAIL_DO MAIN_HOST
The host of the e-mail address (the first item listed after the @ symbol).
london
DRL_EMAIL_IS_ISP
Whether or not the domain of an e-mail looked up in the ISP file.
T or F
2012-05-24
DataRight IQ Library
1.2.11 User-defined pattern items Table 1-12: DataRight IQ output items for user-defined pattern Item type
Field name
Description
Example
Parent
DRL_UDPM
Field for returning items based on the rules in your pattern file. See the DataRight IQ Modifier's Guide for more information.
PN123-56
Compo nent
DRL_UDPM_SUB15
Field for returning subcomponent items based on the rules in your pattern file. See the DataRight IQ Modifier's Guide for more information.
PN 123-56
1.2.12 Extra items Table 1-13: DataRight IQ output items for extra
16
Item type
Field name
Description
Example
Parent
DRL_EXTRA
Any data that was not recognized as fitting one of the other DataRight IQ output fields.
asdf jklk
2012-05-24
ACE U.S.
ACE U.S.
This section contains input fields, output fields, and codes, within ACE U.S.For details about the API calls used in conjunction with these items, see the ACE Library Reference.
2.1 ACE U.S. input fields
17
Type of data
Field name
Length
Description
Name
ACE_INAME
up to 60
ACE doesn't do anything with Name data except capitalize it.
Firm
ACE_IFIRM
up to 60
Some firms have their own ZIP+4 code. So if you present your company field to ACE, ACE can assign more specifically. Without the Firm field, ACE would have to fall back to assigning a more general ZIP+4 code that covers the whole building or block.
2012-05-24
ACE U.S.
Type of data
Field name
Length
Description
Street address
ACE_IADDRESS
up to 60
ACE_ISUITE
up to 60
If you store both the primary (street) address and the secondary address (apartment or suite) in separate fields, then you should present your data to ACE through the Address and Suite fields. For example: Address = “1000 Main Street”, Suite = “apt. 5”. Present only the Address field if you have one field combining the primary and secondary address (for example, “1000 Main Street apt. 5”). Through the Address field, ACE also can accept dual addresses, where one field contains both a street and PO-box address, or a rural and fire address (for example, “1000 Vine St., PO Box 510” or “RR 1 Box 510, 1000 Cedar Rd”).
ACE_IURB
up to 60
In Puerto Rico only, an Urbanization is a place name that denotes a neighborhood or subdivision (for example, "Urb Los Olmos" or "Urb Paseo Las Vistas"). When matching a Puerto Rican address to the ZIP+4 directory, ACE occasionally needs the urbanization to break a tie. This is because two different urbanizations may contain streets of the same name and house numbers. If your input address does not include an urbanization, ACE may be able to add it.
City
ACE_ICITY
up to 60
State
ACE_ISTATE
2
If you have separate database fields for city and state, present them to ACE through the input fields City and State. ACE uses this information to assign a ZIP Code. You cannot use the discrete fields City and State if: 1) You store city and state together in a combined field, or 2) You use state abbreviations other than those set by the U.S. Postal Service. See the Last Line field.
County
18
ACE_ICOUNTY
3
Although ACE assigns them from a postal database, County numbers are not really “postal” codes used in mail handling (except in Periodicals Class). Numbers start at 001 within each state.
2012-05-24
ACE U.S.
19
Type of data
Field name
Length
Description
ZIP Code
ACE_IZIP
5
If you have a field specifically for the ordinary, 5-digit ZIP Code, then present it to ACE through the ZIP field. ACE uses this information to confirm, or perhaps to complete, the city and state data.
ACE_IZIP4
4
ZIP4 codes are required for Postnet barcoding. They are also important for the GeoCensus Option. Notice that the proper field name does not include the plus sign (+).
ACE_IZIP10
10
If you have a combined field for ZIP and ZIP+4, present it through the ZIP10 field instead. For input, it doesn't matter whether or not you have a hyphen between the codes. If you set up ACE to automatically update this field, it will insert a hyphen intelligently.
2012-05-24
ACE U.S.
Type of data
Field name
Length
Description
Address lines
ACE_ILASTLINE
up to 60
There are some situations in which you should use the ACE field Last Line instead of the separate City, State, and ZIP fields: If you have a combined city-state-ZIP field, well, that's exactly what ACE calls Last Line. For example, your mapping might be: ACE_ILASTLINE = City_ST_ZIP. Perhaps you have a combined city-state field, but a separate field for ZIP. In that situation you have to set up the Last Line field to include (concatenate) both of your fields; for example, ACE_ILASTLINE = City_State & ZIP. You do not have to physically merge your fields. If your State field contains full spellings or abbreviations other than those set by the U.S. Postal Service, do not use the discrete State field. Instead, present your city, state, and ZIP fields together through the Last Line field. For example: ACE_ILASTLINE = City & State & ZIP
Country
20
ACE_ILINE1–12
up to 60
Some companies store name-address data in an open format of four or more lines. We call this type of record format a multiline format. ACE can accept two to twelve lines of multiline input. However many of these fields you need to use, be sure to start with Line1 and use fields consecutively. (ACE would report an error if you try to use lines 2, 3, and 5, for example.) All your multiline fields must be the same length if you want ACE to apply the "Swap Lines" feature.
ACE_ICOUNTRY
up to 60
ACE uses Country data to detect foreign addresses. ACE does not attempt to assign any addresses outside the U.S. and its possessions, territories, and protectorates. For domestic addresses, the Country field may be blank or contain any reasonable spelling such as "USA," "United States," and so on.
2012-05-24
ACE U.S.
Type of data
Field name
Length
Postal codes
Description If you already have postal codes in your input data, you can use the fields below to pass your codes into ACE. ACE will not use your original codes in the assignment process at all. However, these input fields are useful for other reasons; for example: ACE automatically updates these fields. So they can make it easier to update the postal-code fields in your database. ACE Library gives you tools to create your own "before-and-after" statistics.
ACE_IDPBC
2
DPBC means "delivery point bar code." You'll need this for Postnet barcodes on letter mail and for LOT sortation.
ACE_ICHKDGT
1
CHKDGT is short for "check digit." Some labelprinting systems require this digit for Postnet barcoding. If you use Label Studio you don't need it from ACE; Label Studio can generate the check digit for itself.
ACE_ICART
4
CART means "carrier route." You will need CART numbers if you intend to sort mail to carrier routes for a postage discount.
ACE_ILOT
4
ACE_ILOT_ORDER
3
LOT (line of travel) codes enable Presort to sort mail nearly to walk sequence. LOT and LOT_Order codes are required only if you mail Standard Mail (A), Enhanced Carrier-Route Subclass.
2.2 ACE U.S. output fields
21
2012-05-24
ACE U.S.
2.2.1 ace_get_component You can retrieve four types of data with ACE Library's ace_get_component() function: •
View your data, as input, by using the ACE_OLD flag.
•
View your data, as ACE standardized and assigned it, by using the ACE_NEW flag.
•
View the move-updated data, which ACE re-standardized, by using the ACE_MVID flag.
•
View the move-updated data exactly as it appears in the NCOALink database by using the components listed in Output components: NCOALink data. This data is available to you only if you own the Mover ID NCOALink option.
•
View the pre-LACSLink information by using ACE_PRELACS flag. ACE_APD, ACE_APL, ACE_APA ,ACE_APAL,ACE_APDL, and ACE_APM fields are not applicable for the ACE_PRELACS flag.
2.2.2 Alphabetical list of last-line components
22
Field name
Length
Description
ACE_CITY
13 to 28
Standardized city name. When the input city name is tagged by the USPS as invalid for mailing purposes, this field will always yield a converted city name, no matter how the placename option is set.
ACE_CITY_ABBR
13
The official USPS abbreviation of the city name, if one is available. This field will be blank if the full city name is less than 13 characters, or if the full name is longer, but the USPS has not provided an official abbreviation.
ACE_CITY_LLIDX
13 to 28
ACE_City_LLIDX yields a city name that is more geographically precise than ACE_City. LLIDX (last-line index) is a USPS number that ties a ZIP+4 record to a particular city, state, and ZIP.
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_CITY_PLACE
13 to 28
Standardized city name; city names invalid for mailing are always preserved, never converted, regardless of the values set for the place-name and assign city by input LLIDX options.
ACE_CITY_NPREF
13 to 28
Compare with ACE_CITY_LLIDX . When the input city is not recognized as a valid mailing city for the address line, CASS rules require that the city name be converted based on the last-line index. The input city name—capitalized and with spelling corrected as necessary—will be output through ACE_CITY_NPREF, so you can retain it if you wish. If there is no input city or the input city is not valid in the assigned finance area, then the default city for the assigned finance area will be output through ACE_CITY_NPREF.
ACE_STATE
2
Standard USPS abbreviation for the state (AK, AL, AR, and so on).
ACE_ZIP
5
Either the 5-digit ZIP assigned by ACE or, if ACE could not assign, then the ZIP found in the input record.
ACE_ZIP4
4
ZIP+4 add-on.
ACE_ZIP9
9
ZIP and ZIP+4 add-on without hyphen.
ACE_ZIP10
10
ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen. Note: If ACE cannot assign a ZIP, it will pass along the ZIP from the input data (if there was one). You can decide whether ACE will do the same thing with ZIP+4. Refer to the Unverified Postal Code option—we recommend the Erase setting.
23
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_LAST_LINE
28 to 43
If the address is fully assigned, this component yields a complete, standardized last line, including city, state, ZIP, and (perhaps) ZIP+4. Whether or not city place names are converted depends on how you set the place-name (non-mailing city name) option. Whether the ZIP+4 is included depends on how you set the multiline-assignment option. If the last line cannot be matched, this component yields ACE's best attempt at a standardized last line. Standardization will be very modest. The standardization of the city is also dependent on the ACE_OPT_ASSIGN_CITY_BY_INPUT_LLIDA parameter. If you have chosen to abbreviate the city name, the abbreviated city name appears in this output component. If a 13character city abbreviation does not exist, the full city name is output to the Last_Line component.
2.2.3 Alphabetical list of assigned address-line components
Field name
Length
Description
ACE_ADDRESS
up to 60
Complete, standardized primary and secondary address line. If the address is not assigned, you will get ACE's best attempt to standardize. Standardization is always Strict (vs. Loose), no matter how the Strict/Loose parameter was set. This component will contain the USPS street abbreviation if that option is enabled.
ACE_ALINE
up to 60
Complete address line: Primary, secondary, urbanization, dual address, and remainder. This component will contain the USPS street abbreviation if that option is enabled.
24
2012-05-24
ACE U.S.
25
Field name
Length
Description
ACE_APL_POSTDIR
9
Postdirectional spelled out (North, Northeast, East, and so on).
ACE_APL_PREDIR
9
Predirectional spelled out (North, Northeast, East, and so on).
ACE_APL_SUFFIX
10
Suffix spelled out (Street, Avenue, Boulevard, and so on).
ACE_DUAL_LINE
20 to 60
Complete, standardized address line, including primary and secondary, if available.
ACE_EXTRAN_PMB
14
Extraneous data retained in this field is our best guess at Private Mail Box data, based on the position in the address line and other information contained in the address.
ACE_EXTRAN_SEC
14
Extraneous data retained in this field is our best guess at secondary range data, based on the position in the address line and other information contained in the address.
ACE_EXTRANEOUS
28
Consists of the data from EXTRAN_SEC and EXTRAN_PMB respectively. Any additional # data is placed in the remainder or extra components.
ACE_NP_SECADDR
20
Complete non-postal secondary address (PMB 10). Nonpostal means that the mail is delivered through a private mailbox company rather than the USPS.
ACE_NP_SRANGE
10
Non-postal secondary range (PMB number only, does not include designator). Non-postal means that the mail is delivered through a private mailbox company rather than the USPS.
ACE_NP_UNIT
up to 10
Non-postal unit designator (PMB). Non-postal means that the mail is delivered through a private mailbox company rather than the USPS.
ACE_POB_NUM
up to 9
Post-office box number.
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_POSTDIR
2
Abbreviated post directional (N, NE, E, SE, S, SW, W, NW).
ACE_PREDIR
2
Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW).
ACE_PRIM_ADDR
up to 60
Complete, standardized, primary address line (for example, 100 Main St). This component will contain the USPS street abbreviation if that option is enabled.
26
ACE_PRIM_NAME
up to 28
Standardized primary name (most often street name). Caution: When the true street name includes a directional word (for example, North Ridge) this field may give you an incomplete street name (Ridge) because of USPS basedata patterns.
ACE_PRIM_RANGE
up to 10
Primary range (house number, such as "1000" in "1000 Vine Street").
ACE_REMAINDER
up to 60
Extraneous data found on the address line, which either can't be identified by the parser or does not belong in a standardized address.
ACE_RR_BOX_NUM
up to 9
Rural-route box number.
ACE_RR_NUM
up to 9
Rural-route number.
ACE_SEC_ADDR
up to 60
Complete secondary address (for example, apt 10, Ste 500, Box 34, Rm 7, 5th Flr).
ACE_SEC_RANGE
up to 8
Secondary range (Apt. or suite number only, does not include designator).
ACE_SUFFIX
4
Abbreviated suffix (St, Ave, Blvd, Rd, and so on).
ACE_UNIT_DESIG
up to 10
Unit designator (Apt, Ste, and so on).
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_URB
up to 60
Urbanization name; produced only when the address is in Puerto Rico.
ACE_USPS_UNIT
up to 10
Unit designator from ZIP+4 directory, or blank if none was found.
2.2.4 Alphabetical list of alias address-line components
Field name
Length
Description
ACE_APA_ADDRESS
20 to 60
Complete, standardized primary and secondary address line. Style of suffixes, directionals, and unit designators depends on how you set the Style parameters. This component will contain the USPS street abbreviation if that option is enabled.
ACE_APA_POSTDIR
2
Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW).
ACE_APAL_POSTDIR
9
Postdirectional spelled out (North, Northeast, East, and so on).
ACE_APA_PREDIR
2
Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW).
ACE_APAL_PRDIR
9
Predirectional spelled out (North, Northeast, East, and so on).
ACE_APA_PRIM_ADDR
up to 60
Complete, standardized, primary address line. Short or long style of suffixes and directionals depends on how you set the Style parameters. This component will contain the USPS street abbreviation if that option is enabled.
27
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_APA_PRIM_NAME
up to 28
Standardized primary name (most often street name). Caution: When the true street name includes a directional word (for example, North Ridge) this field may give you an incomplete street name (Ridge) because of USPS basedata patterns.
ACE_APA_PRIM_RANGE
up to 10
Primary range (house number, such as "1000" in "1000 Vine Street") for the alternate address.
ACE_APA_SEC_ADDR
up to 60
Complete secondary address (for example, Apt 10, Ste 500, Box 34, Rm 7, 5th Flr) for the alternate address.
ACE_APA_SEC_RANGE
up to 8
Secondary range (Apt. or suite number only, does not include designator).
ACE_APA_SUFFIX
4
Abbreviated suffix (St, ave, Blvd, Rd, and so on).
ACE_APAL_SUFFIX
10
Suffix spelled out (Street, avenue, Boulevard, and so on).
ACE_APA_TYPE
1
Alias type. Describes the input address, not the output address. A Input address matched an abbreviated street name. B The input address matched the high-rise alternate default base record. C Input street name is out of date; to get new street name, convert your record to the preferred alias. H Input address was an undesirable alternate, subject to conversion to a USPS preferred street address (high-rise alternate). O Input address was a street nickname or other alias. P Input address was a preferred alias. blank: Input address was not an alias or was unassigned.
ACE_APA_UNIT_DESIG
28
up to 10
Unit designator (Apt, Ste, and so on) for the alternate address.
2012-05-24
ACE U.S.
2.2.5 Alphabetical list of dual address-line components
Field name
Length
Description
ACE_APD_ADDRESS
20 to 60
Complete, standardized address line, including primary and secondary, if available.
ACE_APD_EXTRAN_PMB
14
Extraneous data retained in this field is our best guess at Private Mail Box data, based on position in the address line and other information contained in the address.
ACE_APD_EXTRAN_SEC
14
Extraneous data here is our best guess at secondary range data, based on position in address line and other information contained in the address
ACE_APD_EXTRANE OUS
28
Consists of the data from EXTRAN_SEC and EXTRAN_PMB respectively. Any additional # data is placed in the remainder or extra components.
ACE_APD_POB_NUM
up to 9
Post-office box number for the dual address.
ACE_APD_POSTDIR
2
ACE_APDL_POSTDIR
9
Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW) of the dual address. Postdirectional spelled out (North, Northeast, East, and so on) of the dual address.
29
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_APD_REC_TYPE
1
When a dual address is identified but not assigned, ACE will provide an address-type indication based on the way that the input data was parsed. This is not guarantee. ACE may indicate that a street, rural route, highway con¯tract, general delivery, or PO box was parsed. F Firm G General Delivery H High-rise apartment or office building P Post Office Box R Rural route or highway contract S Street blank: Unassigned
ACE_APD_PREDIR
2
ACE_APDL_PREDIR
9
Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW) of the dual address. Predirectional spelled out (North, Northeast, East, and so on) of the dual address.
30
ACE_APD_PRIM_ADDR
up to 60
Standardized primary address.
ACE_APD_PRIM_NAME
up to 28
Standardized primary name (most often street name) of the dual address. Caution: When the true street name includes a directional word (for example, North Ridge), this field may give you an incomplete street name (Ridge) because of USPS base-data patterns.
ACE_APD_PRIM_RANGE
up to 10
Primary range (house number, such as "1000" in "1000 Vine Street") of the dual address.
ACE_APD_REMAINDER
up to 60
Extra data found on the address line, which either can't be identified by the parser or does not belong in a standardized address.
ACE_APD_RR_NUM
up to 9
Rural-route number for the dual address.
ACE_APD_RR_BOX_NUM
up to 9
Rural-route box number for the dual address.
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_APD_SEC_ADDR
up to 60
Standardized secondary address (for example, "apt 210" or "Ste 300").
ACE_APD_SEC_RANGE
up to 8
Secondary range (apartment or suite number only, does not include designator) of the dual address.
ACE_APD_SUFFIX
4
ACE_APDL_SUFFIX
10
Abbreviated suffix (St, ave, Blvd, Rd, and so on) of the dual address. Suffix spelled out (Street, avenue, Boulevard, and so on) of the dual address.
ACE_APD_UNIT_DESIG
up to 10
Unit designator (Apt, Ste, and so on) of the dual address.
ACE_APD_URB
up to 60
Urbanization name; produced only when the address lies in Puerto Rico.
2.2.6 Alphabetical list of components available for multiline input
31
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_EXTRA1-10
up to 60
The "Extra" fields contain whatever nonaddress data ACE can find above the address data. Data will be filled into Extra10 first and will fill into the other Extra fields in descending order. For example: Comment: The "Extra" fields were added before DataRight and the TrueName Library became available. If you want to convert multiline address blocks into discrete fields, use DataRight or TrueName. They are much better at name, title, and firm parsing. Input record
Output record
Line1 = John Dough
Extra7 =
Line2 = American Bakery Supply
Extra8 =
Line3 = 308 2nd ave #152 Line4 = Ames IA 50014 Line5 = Line6 =
Extra9 = John Dough Extra10 = American Bakery Supply Address = 308 2nd ave Ste 152 City = Ames State = IA ZIP = 50014
ACE_STD_LINE112
up to 60
The "Std_Line" fields contain your multiline address block, standardized per your style settings. These fields enable you to output a record that contains both the original and standardized address. When planning your field length, please select a length that is less than or equal to the length of the input, multiline fields (Line1–12). If you have chosen to abbreviate the city name, the abbreviated city name appears in this output component. If a 13-character city abbreviation does not exist, the full city name is output to the Last_Line component. This component will contain the USPS street abbreviation if that option is enabled.
32
2012-05-24
ACE U.S.
2.2.7 Alphabetical list of postal codes
Field name
Length
Description
ACE_CART
4
Carrier-route number (for example, CØØ1, RØØ1, and so on).
ACE_CHECKDIGIT
1
If ACE can make a full assignment, this component contains the check-digit for 11-digit delivery-point barcode. ACE provides the check digit for a 5-digit barcode when only a 5-digit assignment is possible, or the address is undeliverable. When the address is unassigned, the check digit is based on the unverified input ZIP. This check digit is not valid for printing a 9-digit barcode.
ACE_CR_SORT_ZN
1
Carrier-route sort zone; indicates eligibility for Standard Mail automation Enhanced Carrier Route. Tip: This field is for convenience only. Presort will determine for itself where to apply CART discounts, and does not need this field from ACE. A Carrier route rates are available and merging is allowed. B Carrier route rates are available and merging is not allowed. C Carrier route rates are not available and merging is allowed. D Carrier route rates are not available and merging is not allowed.
33
ACE_DPBC
2
Numeric 2-digit code for delivery-point barcode. also used in LOT sortation (see LOT). Blank when ZIP+4 could not be assigned.
ACE_LOT
4
Line-of-Travel number
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_LOT_ORDER
1
Line-of-Travel sortation: A Ascending D Descending LOT codes are required for nonautomated, CART presorting in Standard Mail, Enhanced Carrier Route Subclass. LOT codes enable Presort to prepare letters in near walk sequence. See the Presort documentation for instructions.
ACE_ZIP
5
Either the 5-digit ZIP assigned by ACE or, if ACE could not assign, then the ZIP found in the input record.
ACE_ZIP10
10
ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen. Note: If ACE cannot assign a ZIP, it will pass along the ZIP from the input data (if there was one). You can decide whether ACE will do the same thing with ZIP+4. Refer to the Unverified Postal Code option—we recommend the Erase setting.
ACE_ZIP4
4
ZIP+4 add-on.
ACE_ZIP9
9
ZIP and ZIP+4 add-on without hyphen.
2.2.8 Alphabetical list of codes that describe address and assignment results
34
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_CASSRECTYP
1
This component returns the record type necessary for use when self-CASS certifying. The valid record types are: F Firm G General Delivery H High Rise P PO box R Rural Route or HWY Contract S Street blank Unassigned
ACE_DPV_CMRA
1
Y The address is a valid Commercial Mail Receiving Agency. N The address is not a Commercial Mail Receiving Agency. L The address triggered DPV locking. blank: This component is blank when the DPV Validation option is set to FALSE, DPV processing is currently locked, or ACE cannot assign the input address.
35
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_DPV_FTNOTE
12
DPV footers are required for end-user CASS certification. The footers contain the following information: AA Input address matches to the ZIP+4 file (records NOT assigned an error code except E600). A1 Input address does not match to the ZIP+4 file. (all records assigned an error code except E600) BB All input address components match to DPV (DPV_Status = Y). CC Input address primary number matches to DPV but the secondary number does not match (DPV_Status = S: The secondary is present but invalid). F1 Input address matches a military address. G1 Input address matches a general delivery address. M1 Input address primary number is missing (Error codes E420 or E302). M3 Input address primary number is invalid (DPV_Status = N and error code is NOT E600. Or if just the DPV_Status - L). N1 Input address primary number matches DPV, but the address is missing the secondary number. (DPV_Status = D). P1 Input address is missing the RR or HC box number (Rec_Type = P and error code is E420. Or if the Rec_Type = R and RR_Box is empty). P3 Input address has invalid PO, RR, or HC number. RR Input address matches to CMRA (DPV_CMRA = Y). R1 Input address matches to CMRA but the secondary number is not present. U1 Input address matches a unique address. Note: ACE always posts the DPV footers in the same order and this field will not always be 12 characters in length.
36
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_DPV_NO_STATS
1
No Stat indicator. No Stat means that the address is a vacant property, it receives mail as a part of a drop, or it does not have an established delivery yet. Y Address is flagged as No Stat in DPV data. N Address is not No Stat. blank: Address was not looked up. To indicate the maximum length of this component, use ACE_DPV_NO_STATS_LEN.
ACE_DPV_STATUS
1
The DPV status is determined during DPV validation. The following values are available for DPV Status. Y The address is a confirmed delivery point. The primary range and secondary range (if present) are valid. N The address is not a valid delivery point. S The primary range is a valid delivery point but, the secondary range is not valid in the DPV directory. D The primary range is a valid delivery point, but the secondary range data is not available on input. L This address triggered DPV Locking. Refer to the Delivery Point Validation Alert section of the Job Summary for details. blank: This component is blank when the DPV Validation option is set to FALSE, DPV processing is currently locked, or ACE cannot assign the input address.
ACE_DPV_VACANT
1
Vacant address indicator. Y Address is vacant. N Address is not vacant. blank: Address was not looked up
ACE_ERR_STAT
6
Error code, if address is unassigned; or status code, if assigned. (Not applicable for ACE_PRELACS flag)
37
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_ER ROR_CODE
6
Error code, if address is unassigned; or blank, if assigned.
ACE_STAT_CODE
6
(Not applicable for ACE_PRELACS flag) Status code (whether assigned or not). (Not applicable for ACE_PRELACS flag)
ACE_EWS_MATCH
1
If the address is located in the EWS directory, the address is an EWS match and a T is returned. If the address is not located in the EWS directory, an F is returned. If EWS is not enabled, the record will be blank.
ACE_FOREIGN CODE
1
Foreign address flag: F for foreign addresses, blank for domestic U.S. (Not applicable for ACE_PRELACS flag)
ACE_LACSCODE
1
LACS (Locatable Address Conversion System) indicator: T Address needs 9-1-1 conversion (from box to street address) and should be submitted to a LACS vendor. F Address does not need conversion. blank: Address was not assigned.
ACE_MATCH_5
1
T Last line was matched to a City/ZCF record. F Last line was not matched to a City/ZCF record.
38
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_MATCH_9
1
Match level indicator. Note: • •
When an address is fully assigned, it is both a 5- and a 9-digit match. So both Match_9 and Match_5 will be "T". Undeliverable addresses are 9-digit matches and they get a Match_9 value of T. But they have no ZIP+4 code. Therefore if you filter only on Match_9 you may get some blank ZIP+4 fields in your output. To filter out undeliverable addresses, filter on the Match_Un field.
T Address line was matched to a ZIP+4 record. F Address line was not matched to a ZIP+4 record. ACE_MATCH_UN
1
T The address is tagged by the USPS as unsuitable for mail delivery. This includes E600 records (for example, a cemetary or parking lot) as well as E601 records which are deemed undeliverable using DPV processing. F The address either was not matched to a ZIP+4 record, or was matched to a record that indicates the address is suitable for mail delivery.
39
ACE_NC_FIRM
up to 60
The firm match that was made using the input ZIP+4 for missing or invalid firm information.
ACE_NC_SECAD DR
up to 60
The secondary address match that was made using the input ZIP+4 for missing or invalid secondary address information.
ACE_NC_SRANGE
up to 8
The secondary range match that was made using the input ZIP+4 for missing or invalid secondary range information.
ACE_NC_UNIT
up to 10
The unit designator match that was made using the input ZIP+4 for missing or invalid unit designator information.
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_REC_TYPE
2
Record-type indicator for the assigned address. The first character indicates the type of record in the ZIP+4 directory to which the address was matched: F Firm. G General delivery. H High-rise apartment or office building. M Military. P Post office box. R Rural route or highway contract. S Street (usually, one side of one city block). blank: Unassigned. The second character may be a D or blank. The D stands for default; it means that ACE detected, from the ZIP+4 directory, that a finer level of ZIP+4 assignment would be possible if further input information were available. FD Firm default. ACE did not assign a firm-level ZIP+4, but could do so if given more or better firm information. GD General delivery default. assigned only when General Delivery is the only primary name listed for the ZIP Code. HD High-rise default. ACE assigned the ZIP+4 code for the whole building. assignment at the unit, floor, or wing level is possible. Often caused by a suite or apartment number out of range. RD Rural route or highway contract default. ACE assigned the ZIP+4 for the whole route; could do better with box number. SD Street default. Usually means that there is no ZIP+4 for the building, so ACE had to assign the ZIP+4 for the block. UD Unique default. Either the owner of the unique ZIP has not provided ZIP+4 assignments, or the address could not be matched. When ACE cannot assign an address, it will provide an addresstype indication based on the way that the input data was parsed. This is not foolproof. ACE may indicate that a street, rural route, highway contract, general delivery, or PO Box was parsed.
40
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_ZIP_MOVE
1
ZIP Move indicator: T The address is affected by a USPS ZIP Code realignment. ACE has assigned the new ZIP Code and, if applicable, the new city name. F The address is not affected by any USPS ZIP Code realignment.
ACE_ZIPTYPE
1
Type of ZIP Code assigned by ACE: M Military. U Unique (specific to a university, large firm, or other institution). blank: Ordinary ZIP, or ZIP was not assigned.
2.2.9 Alphabetical list of other useful codes
Field name
Length
Description
ACE_CASS_MATCH
1
Use this field to indicate the non-CASS option that was used in making the assignment. If the application was run using CASS rules, the field contains a zero (0). 0 The non-CASS option was not chosen or the non-CASS mode was not enabled. 1 Inexact ZIP move assignment. 2 Input ZIP+4 assignment. 3 DPV tie-breaking was used to make this assignment.
41
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_CONGRESS
3
District number for the U.S. House of Representatives. May be blank for any of four reasons: • District numbers are available only when the address is fully assigned. • District numbers are assigned only in areas that have congressional representation; this excludes Puerto Rico and other territories and possessions. • District numbers are not assigned to offshore military addresses. • USPS data on congressional districts is not complete. You may find some records that ought to be coded but are not, because of gaps in the base data (for example, PO boxes). Note: This district number has nothing to do with state legislative districts, nor with the U.S. Senate. also note, this feature does not include names or addresses of representatives. To obtain such information, contact your local or state government, or the local chapter of the League of Women Voters.
42
ACE_COUNTY
3
ACE_COUNTY NAME
25
FIPS county code. Numbers are unique within states. (FIPS stands for Federal Information Processing Standard.)
Fully spelled county name (for example, "La Crosse" instead of Ø63).
2012-05-24
ACE U.S.
Field name
Length
Description
ACE_FACTYPE
1
Indicates a type of postal facility. For ordinary addresses—except those specifically for a postal facility—you will most often get a P, B, C, or N. This component is blank when the address is unassigned. A Airport Mail Facility (AMF) B Branch Office C Community Post Office (CPO) D Area Distribution Center (ADC) E Sectional Center Facility (SCF) F Delivery Distribution G General Mail Facility (GMF) K Network Distribution Center (NDC) M Money Order Unit N City place name, invalid for mailing P Post Office (main) S Station U Urbanization (Puerto Rico only)
43
2012-05-24
ACE U.S.
44
Field name
Length
ACE_FIPSCODE
5
Description
2012-05-24
ACE U.S.
Field name
Length
Description Federal code for state and county. Uniquely identifies a county within the nation. Combines a 2-digit state number (table below) with 3-digit county code. 01 Alabama
17 Illinois
30 Montana
44 Rhode Island
02 Alaska
18 Indiana
31 Nebraska
45 South Carolina
04 Arizona
19 Iowa
32 Nevada
46 South Dakota
05 Arkansas
20 Kansas
33 New Hampshire
47 Tennessee
06 California
21 Kentucky
34 New Jersey
48 Texas
08 Colorado
22 Louisiana
35 New Mexico
49 Utah
09 Connecticut
23 Maine
36 New York
50 Vermont
10 Delaware
24 Maryland
37 North Carolina
51 Virginia
11 Dist. Of Columbia
25 Massachusetts
38 North Dakota
53 Washington
12 Florida
26 Michigan
39 Ohio
54 West Virginia
13 Georgia
27 Minnesota
40 Oklahoma
55 Wisconsin
15 Hawaii
28 Mississippi
41 Oregon
56 Wyoming
42 Pennsylvania
blank: territories, possessions, and protectorates
16 Idaho
29 Missouri
Note: When ACE makes a full assignment, the county fields are based on ZIP+4. When only a 5-digit match is possible, county is based on ZIP. Usually it will be right, but may be wrong where county and ZIP boundaries intersect. We do not have FIPS state numbers for territories, possessions, or protectorates such as Puerto Rico, the U.S. Virgin Is-
45
2012-05-24
ACE U.S.
Field name
Length
Description lands, or the Pacific islands.
ACE_FIRMLINE
20 to 60
Firm name from ZIP+4 directory, if matched; or if not matched, then the Firm data from the input record (if the discrete Firm field was input). Do not use this component if the input is multiline. If you want to extract a discrete firm field from a multiline address block, use DataRight or the TrueName Library.
ACE_RDI
1
The residential delivery indicator (RDI) that tells if the address is residential or non esidential. Y Residential address N Nonresidential address Note: RDI is an add-on feature.
ACE_NEWLINE
1 or 2
CRLF on DOS and Windows, LF on Unix. For posting to ASCII output files as an endof- record mark. (Not applicable for ACE_PRELACS flag)
ACE_QSS_DE FAULT
1
Indicates whether the record qualified as a default match rather than qualifying as a match at higher level of assignment.
2.2.10 Output components: move data These components show information about the move.
46
2012-05-24
ACE U.S.
Component
Length
Description
ACE_APM_MOVE_TYPE
1
Type of move record: B Business (matched by company name). F Family (matched by last name). I Individual (matched by first and last name). This field is also populated when an ANKLink match is made.
ACE_APM_EFF_DATE
6
The date indicated on the change of address card sent to the USPS – The date that the move is effective. Date format is:yyyymm. The yyyymm format is returned from the NCOALink directories and required by the USPS for audit purposes. If you want to use it in a function or post it to an output file, you'll probably have to convert the format to mm/dd/yyyy first. Use this expression for that conversion: right(APM.Eff_Date, 2) - "/01/" - left(APM.Eff_Date, 4) (This assumes that an effective date means the first of the month.) This expression turns ACE_APM_EFF_DATE into a string in mm/dd/yyyy format, suitable for posting or for input to date functions, such as ctod(). This field is also populated when an ANKLink match is made.
47
2012-05-24
ACE U.S.
Component
Length
Description
ACE_APM_PRE_NAME
6
ACE_APM_FIRST_NAME
15
These fields contain the name data used to make an NCOALink match.
ACE_APM_MID_NAME
15
ACE_APM_LAST_NAME
20
ACE_APM_POST_NAME
6
In some cases, the name in these APM fields is not the same as the input name (for example, if a nickname, alternate spelling, or initial is used instead). In the case of a firm match, these APM name fields will contain a split version of the firm data. These fields are also populated when an ANKLink match is made. (Not applicable for ACE_PRELACS flag)
ACE_APM_FIRM
60
If the change of address was made based on a firm (company) name, that firm name will be posted in this field. This field is also populated when an ANKLink match is made.
ACE_APM_RETCODE
2
This field shows NCOALink return codes. To populate this field, you must set the Mode parameter to Retcode or COA. A brief description of the return codes appears on the Mover ID Summary report. To print more detailed return code descriptions on the report, select the Print Return Code Descriptions option in the Report: Mover ID Summary block or window. This field is also populated when an ANKLink match is made.
48
ACE_APM_INT_CODES
185
"IntCodes" stands for "intermediate codes." These codes provide information that the USPS requires when you're performing NCOALink certification or audit testing. This information goes into the Test Client Output File. See your Mover ID User's Guide for details.
ACE_APM_HINT_BYTE
8
This field is used for audit testing.
2012-05-24
ACE U.S.
Component
Length
Description
ACE_APM_GENDER
1
This field is used for audit testing. This field is also populated when an ANKLink match is made.
ACE_APM_DROP
1
This field is used for audit testing. This field is also populated when an ANKLink match is made.
ACE_APM_DROP_N
1
This field is used for audit testing. This field is also populated when an ANKLink match is made.
49
ACE_APM_AUD_RANGE
up to 10
This is the range that was sent to NCOALink for matching. This field is required for audits.
ACE_APM_AUD_PNAME
up to 28
This is the primary name that was sent to NCOALink for matching. This field is required for audits.
ACE_APM_AUD_SRANGE
up to 10
This is the secondary range that was sent to NCOALink for matching. This field is required for audits.
ACE_APM_AUD_UNIT
up to 8
This is the unit data that was sent to NCOALink for matching. This field is required for audits.
ACE_APM_AUD_MID_NAME
2
This field contains the truncated middle name, as stored in the NCOALink data. Use this field for audit purposes only. This field is required for audits.
2012-05-24
ACE U.S.
Component
Length
Description
ACE_APM_AUD_FIELDS
700
This field contains information for Stage I and Stage II tests, specifically query data, result data, and hint bytes, as the USPS requires. Use this field for audit purposes only. This field is required for audits. For more information about the content of this field, see the NCOALink User Technical Reference at http://ribbs.usps.gov/. This field can also contain ANKLink return codes.
2.2.11 Output components: NCOALink data These fields show data exactly as it appears in the NCOALink directories. This data is available to you only if you own the Mover ID NCOALink option.
50
Component
Length
Description
ACE_APM_PRIM_RANGE
up to 10
Primary range (house number, such as "1000" for the address "1000 Vine St").
ACE_APM_PREDIR
2
Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW). Long form not available.
ACE_APM_PRIM_NAME
up to 28
Standardized primary name (most often street name). Caution: When the true street name includes a directional word (for example, North Ridge) this field may give you an incomplete street name (Ridge) because of USPS base-data patterns.
ACE_APM_POSTDIR
2
Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW). Long form not available.
ACE_APM_SUFFIX
4
Abbreviated suffix (St, Ave, Blvd, Rd, and so on). Long form not available.
2012-05-24
ACE U.S.
Component
Length
Description
ACE_APM_UNIT_DESIG
up to 10
Unit designator (#, Apt, Ste, and so on).
ACE_APM_SEC_RANGE
up to 8
Secondary range (apt. or suite number only, does not include designator).
ACE_APM_ADDRESS
up to 60
Complete, standardized primary and secondary address line (for example, 100 Main St Apt 10). This component will contain the USPS street abbreviation if that option is enabled.
ACE_APM_PRIM_ADDR
up to 60
Complete, standardized, primary address line (for example, 100 Main St). This component will contain the USPS street abbreviation if that option is enabled.
51
ACE_APM_SEC_ADDR
up to 60
Complete secondary address (for example, Apt 10, Ste 500, Box 34, Rm 7).
ACE_APM_CITY
13 to 28
Standardized city name for the new (forwarding) address. When the input city name is tagged by the USPS as invalid for mailing purposes, this field always yields a converted city name, no matter how the placename option is set.
ACE_APM_STATE
2
Standard USPS abbreviation for the state (AK, AL, AR, and so on) for the new (forwarding) address.
ACE_APM_DPBC
2
Numeric 2-digit code for delivery-point barcode.
ACE_APM_CART
4
Carrier-route number (for example, C001, R001, and so on).
ACE_APM_URB
up to 60
Urbanization name; produced only when the address is in Puerto Rico.
ACE_APM_CHK_DIGIT
1
Check digit for the Postnet barcode.
2012-05-24
ACE U.S.
Component
Length
Description
ACE_APM_LOT
4
Line-of-Travel number.
ACE_APM_LOT_ORDER
1
Line-of-Travel sortation: A Ascending D Descending LOT codes are required for non automated, CART presorting in Standard Mail, Enhanced Carrier Route Subclass. LOT codes enable Presort to prepare letters in near walk sequence. See the Presort documentation for instructions.
ACE_APM_LASTLINE
28 to 43
Complete, standardized last line, including city, state, ZIP, and ZIP+4. If you have chosen to abbreviate the city name, the abbreviated city name appears in this output component. If a 13-character city abbreviation does not exist, the full city name is output to the Last_Line component.
ACE_APM_ZIP
5
Either the 5-digit ZIP assigned by ACE or, if ACE could not assign, then the ZIP found in the input record.
ACE_APM_ZIP4
4
ZIP+4 add-on.
ACE_APM_ZIP9
9
ZIP and ZIP+4 add-on without hyphen.
ACE_APM_ZIP10
10
ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen.
2.2.12 Output components: LACSLink
52
2012-05-24
ACE U.S.
Component
Length
Description
ACE_LACSLINK_IND
1
Returns the conversion status of addresses processed by LACSLink. (Not applicable for ACE_PRELACS flag) Y Address found in LACSLink directories. N Address looked up with LACSLink but not converted. F The address was a false-positive. S A LACSLink conversion was made, but it was necessary to drop the secondary information. blank: No LACSLink lookup attempted.
ACE_LACSLINK_QUERY
50
Returns the pre-conversion address, populated only when LACSLink is turned on and a LACSLink lookup was attempted. This address will be in the standard Pub. 28 format. However, when an address has both a unit designator and secondary unit, the unit designator is replaced by the character "#". blank: No LACSLink lookup attempted. (Not applicable for ACE_PRELACS flag)
53
2012-05-24
ACE U.S.
Component
Length
Description
ACE_LACSLINK_RET CODE
2
Returns the match status for LACSLink processing: (Not applicable for ACE_PRELACS flag) A LACSLink record match. A converted address is provided in the address data fields. 00 No match and no converted address. 09 LACSLink matched an input address to an old address, which is a 'highrise default' address, no new address is provided. 14 Found LACSLink record, but couldn't convert the data to a deliverable address. 92 LACSLink record matched after dropping the secondary number from input address. A converted address is provided in the address data fields. Note: If you are trying to filter on records that are assigned a new address from LACSLink, you should use the AP.LACSL_Ret codes of A and 92. blank: No LACSLink lookup attempted.
2.2.13 Output components: ANKLink The following table contains output components for ANKLink information.
54
2012-05-24
ACE U.S.
Option
Length
Description
ACE_ANKLINK_RETCODE
2
ANKLink return code (Attempted Not Known). Valid values are: (Not applicable for ACE_PRELACS flag) 77 An ANKLink match was found. If ACE_APM_RETCODE contains an A, 91, or 92, you may be able to obtain a new addresss from an NCOALink full service provider. blank: No NCOALink lookup, or no ANKLink match. This will always be blank for full service providers.
2.2.14 SuiteLink output fields The following table contains output components for SuiteLink information. Component
Length
Description
ACE_SUITELINK_RETCODE
2
The result of SuiteLink processing. A SuiteLink match—secondary information exists and was assigned to this record as a result of SuiteLink processing. 00 SuiteLink no match—lookup was attempted but no matching record could be found. blank: A SuiteLink lookup was not attempted because one of the following was true: • The address was not a highrise default according to CASS. • The address did not contain a firm.
55
2012-05-24
ACE U.S.
Component
Length
Description
ACE_PRESL_ZIP
5
The ZIP Code that was assigned by ACE before SuiteLink processing. 5-digit ZIP Code The AP.SteLink_RC value is A. blank: No ZIP Code assigned.
ACE_PRESL_ZIP4
4
The ZIP+4 that was assigned by ACE before SuiteLink processing. The ZIP+4 is either for a high-rise default or street default record.
ACE_PRESL_DPBC
2
The numeric 2-digit code for the delivery point barcode that was generated before SuiteLink processing.
ACE_PRESL_SEC_RANGE
up to 8
The secondary range information that existed before SuiteLink processing. If this is blank, ACE did not assign any secondary information.
ACE_PRESL_UNIT_DESIG
up to 10
The unit designator that existed before SuiteLink processing. If this is blank, ACE did not assign any secondary information.
ACE_INPUT_FIRM
60
The firm name from your input file that is used only for SuiteLink processing. ACE matches the contents of this field to SuiteLink data. To see what firm name SuiteLink used for processing, look at the contents of this field.
2.2.15 Alphabetical list of Geocensus codes
56
2012-05-24
ACE U.S.
Option
Field name
Length
Description
Address-Lev el
ACE_AGEO_LAT
10
Latitude (degrees north of the Equator) in the format: +12.123456
ACE_AGEO_LNG
11
Longitude (degrees east of the Greenwich Meridian) in the format: +12.123456 In North America, latitudes are positive and longitudes are negative. For example, the White House is located at Latitude = 38.898556, Longitude = 077.037852 (about 39º north, 77º west).
57
ACE_AGEO_STA
2
FIPS state code.
ACE_AGEO_CTY
3
FIPS county code.
ACE_AGEO_PLA
5
FIPS place code. a number assigned by the U.S. government to each incorporated municipality (city, village, town, etc.)
ACE_AGEO_BLK
11
U.S. Census tract.
ACE_AGEO_MCD
6
U.S. Census Bureau minor civil division (MCD) data or, if MCD data is unavailable, census county division (CCD) data.
2012-05-24
ACE U.S.
Option
Field name
Length
Description
Centroid
ACE_CGEO_CBSA
5
A Core-Based Statistical Area (CBSA) consists of: • A county with an incorporated place or a census-designated place that has a population of at least 10,000. • Adjacent counties with at least 25 percent of employed residents of the county who work in the CBSA's core or central county. CBSAs are either metropolitan (population of at least 50,000) or micropolitan (population between 10,000 and 50,000). With CBSAs, you can collect statistics for less urban areas of the country. CBSAs cover approximately 90 percent of the entire U.S. population.
ACE_CGEO_LAT
10
ACE_CGEO_LNG
11
Latitude (degrees north of the Equator) in the format: +12.123456 Longitude (degrees east of the Greenwich Meridian) in the format: +12.123456 In North America, latitudes are positive and longitudes are negative. For example, the White House is located at Latitude = 38.898556, Longitude = 077.037852 (about 39º north, 77º west).
ACE_CGEO_MSA
4
ACE_CGEO_BLK
11
Metropolitan Statistical area (MSA) number. 0000 indicates the address does not lie in any MSA; usually a rural area. U.S. Census tract and block-group number. The first 6 digits are the tract number, four digits are the block-group numbers within the tract, and one digit is the null terminator. These codes are used for matching to demographic-coding databases. To uniquely specify a census block-group within the whole country, combine the FIPSCODE and GEO_BLK fields. The FIPSCODE field is not part of the GeoCensus option.
ACE_CGEO_MATCH
58
1
2012-05-24
ACE U.S.
Option
Field name
Length
Description Match code, indicating the precision of the centroid latitude and longitude assignment. The lower the number, the more precise the assignment. 1 9-digit match in Centroid. 4 7-digit match in Centroid. 5 5-digit match in Centroid. 7 No match in Centroid. blank: Not tried.
Both Address Level and Centroid
ACE_GEO_MATCH
1
Match code, indicating the precision of the latitude and longitude assignment. The lower the number, the more precise the assignment. 0 Matched in address level. 1 9-digit match in Centroid. 4 7-digit match in Centroid. 5 5-digit match in Centroid. 7 No match in Centroid. 8 Not matched in Address level. 9 Both options tried, but no match in either. blank: Not tried.
2.3 ACE U.S. address status codes
59
2012-05-24
ACE U.S.
Digit 1st
2nd
60
Description
Description
A
ACE had to truncate the address line to make it fit into your field.
C
ACE had to truncate the city name to make it fit into your field.
B
ACE truncated both the address line and the city name.
S
ACE didn't truncate anything.
0
Regarding the city, state, ZIP, and ZIP+4, there is no significant difference between the input data and the data that ACE assigned.
8
ACE assigned a different ZIP+4.
1
ACE assigned a different ZIP.
9
ACE assigned a different ZIP and ZIP+4.
2
ACE assigned a different city.
A
ACE assigned a different city and ZIP+4.
3
ACE assigned a different city and ZIP.
B
ACE assigned a different city, ZIP, and ZIP+4.
4
ACE assigned a different state.
C
ACE assigned a different state and ZIP+4.
5
ACE assigned a different state and ZIP.
D
ACE assigned a different state, ZIP, and ZIP+4.
6
ACE assigned a different city and state.
E
ACE assigned a different city, state, and ZIP+4.
7
ACE assigned a different city, state, and ZIP.
F
ACE assigned a different city, state, ZIP and ZIP+4.
2012-05-24
ACE U.S.
Digit 3rd
61
Description
Description
0
Regarding the primary name, directionals, and suffix, there is no significant difference between the input and what ACE assigned.
8
ACE assigned a different primary name.
1
ACE assigned a different suffix.
9
ACE assigned a different primary name and suffix.
2
ACE assigned a different predirectional.
A
ACE assigned a different predirectional and primary name.
3
ACE assigned a different predirectional and suffix.
B
ACE assigned a different predirectional, primary name, and suffix.
4
ACE assigned a different postdirectional.
C
ACE assigned a different primary name and postdirectional.
5
ACE assigned a different suffix and postdirectional.
D
ACE assigned a different primary name, suffix, and postdirectional.
6
ACE assigned a different predirectional and postdirectional.
E
ACE assigned a different predirectional, primary name, and postdirectional.
7
ACE assigned a different predirectional, suffix, and postdirectional.
F
ACE assigned a different predirectional, primary name, postdirectional, and suffix.
2012-05-24
ACE U.S.
Digit 4th
62
Description
Description
0
Regarding the county number, CART (carrier-route number), DPBC, and unit designator, there is no significant difference between the input data and the data that ACE assigned.
8
ACE assigned a different county number.
1
ACE assigned a different unit designator.
9
ACE assigned a different county number and unit designator.
2
ACE assigned a different DPBC.
A
ACE assigned a different county number and DPBC.
3
ACE assigned a different DPBC and unit designator.
B
ACE assigned a different county number, DPBC, and unit designator.
4
ACE assigned a different CART.
C
ACE assigned a different county number and CART.
5
ACE assigned a different CART and unit designator.
D
ACE assigned a different county number, CART, and unit designator.
6
ACE assigned a different CART and DPBC.
E
ACE assigned a different county number, CART, and DPBC.
7
ACE assigned a different CART, DPBC, and unit designator.
F
ACE assigned a different county number, CART, DPBC, and unit designator.
2012-05-24
ACE U.S.
Digit 5th
6th
Description
Description
0
Regarding the LOT, LOT_Order, and Puerto Rican urbanization, there is no significant difference between the input data and the data that ACE assigned.
4
ACE assigned a different urbanization.
1
ACE assigned a different LOT.
5
ACE assigned a different urbanization and LOT.
2
ACE assigned a different LOT_Order.
6
ACE assigned a different urbanization and LOT_Order.
3
ACE assigned a different LOT and LOT_Order.
7
ACE assigned a different urbanization, LOT, and LOT_Order.
Reserved for future use.
2.4 ACE address error codes (U.S. and Canada) Table 2-19: ACE address error codes
63
Code
Description
E101
Last line is bad or missing
E212
No city and bad ZIP/postal code
E213
Bad city, valid state/province, and no ZIP/postal code
E214
Bad city and bad ZIP/postal code
E216
Bad ZIP, can't determine which city match to select
2012-05-24
ACE U.S.
64
Code
Description
E302
No primary address line parsed
E412
Street name not found in directory
E413
Possible street-name matches too close to choose one
E420
Primary range is missing
E421
Primary range is invalid for the street/route/building
E422
Predirectional needed, input is wrong or missing
E423
Suffix needed, input is wrong or missing
E425
Suffix and directional needed, input is wrong or missing
E427
[Post] Directional needed, input is wrong or missing
E428
Bad ZIP, can't select an address match
E429
Bad city, can't select an address match
E430
Possible address-line matches too close to choose one
E431
Urbanization needed, input is wrong or missing
E439
Exact match made in EWS directory
E500
Other error
E501
Foreign address
E502
Input record entirely blank
2012-05-24
ACE U.S.
Code
Description
E503
ZIP not in area covered by partial ZIP+4 directory
E504
Overlapping ranges in ZIP+4 directory
E505
Address does not exist in the USPS directories. Undeliverable address.
E600
Marked by USPS as unsuitable for delivery of mail
E601
The primary address number did not DPV confirm, and the ZIP+4 was removed.
2.5 ACE U.S. suggestion list components
2.5.1 U.S. suggestion list output components
65
Field name
Description
ACEQ_RECTYPE
Record type (10=street, 14=PO box, 18=rural route, 20=high-rise, 21=firm, 26=general delivery).
ACEQ_ODDEVEN
An E to indicate that the record covers the even-numbered side of the street, an O to indicate odd, or B to indicate both.
ACEQ_SODDEVEN
Same indicator for secondary-address records.
2012-05-24
ACE U.S.
Field name
Description
ACEQ_LLINDEX
Last-line index is a 3-digit number that links each ZIP+4 directory record to a particular combination of city, state, and ZIP.
ACEQ_URB_INDEX
Urbanization index is a number that links a record to an urbanization name. (It is not the name itself.) The Urb_Index will be zero for PR records that do not have an urbanization, and for records outside Puerto Rico.
ACEQ_LOWRANGE
Primary range; comparable to ACE_PRIM_RANGE.
ACEQ_HIGHRANGE ACEQ_PREDIR
Predirectional (N, NE, E, SE, S, SW, W, NW); similar to ACE_PREDIR.
ACEQ_PNAME
Primary (street) name; similar to ACE_PRIM_NAME.
ACEQ_POSTDIR
Postdirectional (N, NE, E, SE, S, SW, W, NW); similar to ACE_POSTDIR.
ACEQ_SUFFIX
Street suffix (Ave, Blvd, St, Rd, and so on.); similar to ACE_SUFFIX.
ACEQ_SNAME
Secondary name, usually a firm name.
ACEQ_UNIT
Unit designator; similar to ACE_USPS_UNIT.
ACEQ_LOWSRANGE
Secondary range (apartment or suite number); comparable to ACE_SEC_RANGE.
ACEQ_HIGHSRANGE ACEQ_ZIP
Five-digit ZIP Code; similar to ACE_ZIP.
ACEQ_ZIP4EVEN
ZIP+4 add-on code; comparable to ACE_ZIP4.
ACEQ_ZIP4ODD ACEQ_CARTEVEN
Carrier-route number; comparable to ACE_CART.
ACEQ_CARTODD
66
2012-05-24
ACE U.S.
Field name
Description
ACEQ_ALSTYP
Alias type; similar to ACE_APA_TYPE.
ACEQ_LACSIND
LACS (9-1-1) indicator. A three-digit number that identifies a particular combination of city, state, and ZIP cope. ACE uses LLI to confirm relationship of address line (ZIP+4 record) to last line. Similar to ACE_LACSCODE.
ACEQ_ZIP_MOVE
ZIP Move indicator. TThe address is affected by a USPS ZIP Code realignment. There may be a change in the city, ZIP, or PO box number. FThe address is not affected by any USPS ZIP Code realignment. Similar to ACE_ZIP_MOVE.
67
ACEQ_CONGRESS
Congressional district; similar to ACE_CONGRESS.
ACEQ_COUNTY
FIPS county number; similar to ACE_COUNTY.
ACEQ_ALTERNATE
ZIP+ 4 directory alternate address indicator. Returns a value of T if the address is an Alternate and a value of F if the Address is not an Alternate.
2012-05-24
ACE U.S.
68
2012-05-24
Match/Consolidate
Match/Consolidate
This chapter contains key fields, and configuration file options for use within the Match Library. For details about the API calls used in conjunction with these items, see the Match Library Programmer's Reference. The items in this section are current through version 7.60c of Match/Consolidate.
3.1 Match key fields
3.1.1 Key fields for name and firm data This table shows the Match fields related to names, titles, and firms. These fields can be filled automatically, directly from the TrueName session, by calling mtc_key_set_tndata(). This list is in address order.
Table 3-1: Match key fields for name and firm data
69
Field name
Description
Example of data
MTC_KEYFLD_PRE NAME
Discrete prename, such as "Mr.," "Mrs.," "Dr.," or "Sgt."
Mr.
MTC_KEYFLD_FIRST NAME
Discrete first name.
John
MTC_KEYFLD_MID DLENAME
Discrete middle name.
B.
2012-05-24
Match/Consolidate
Field name
Description
Example of data
MTC_KEYFLD_LAST NAME
Discrete last name.
Smith
MTC_KEYFLD_MAT POSTNAME
Discrete postname.
Sr, Jr, III
MTC_KEYFLD_OTHER POSTNAME
Postname indicating certification, academic degree or affiliation.
CPA, PhD, USAF
MTC_KEYFLD_GEN DER
Gender number:
1
1 Strong male (that is, very likely male) 2 Male (that is, likely male) 3 Ambiguous (that is, could be male or female) 4 Female (that is, likely female) 5 Strong female (that is, very likely female)
MTC_KEYFLD_TITLE
70
Discrete job title.
Manager, Software Engineer
2012-05-24
Match/Consolidate
Field name
Description
Example of data
MTC_KEYFLD_FIRM
Name of a company or organization.
SAP
Note: If ACE finds a firm-level match in the national ZIP+4 directory (as indicated by ACE_REC_TYPE), then the firm field will be populated with ACE_FIRMLINE from the call to mtc_key_set_acedata(). Otherwise, it will be filled with Firm data parsed by TrueName.
3.1.2 Key fields for address data This table shows the Match fields related to addresses. Fields in this group can be loaded automatically, directly from the ACE address handle, by calling mtc_key_set_acedata(). This list is in address order.
Table 3-2: Match key fields for address data
71
Field name
Description
Example of data
MTC_KEYFLD_FIRM
Name of a company or organization. Note: If ACE finds a firm-level match in the national ZIP+4 directory (as indicated by ACE_REC_TYPE), then the firm field will be populated with ACE_FIRMLINE from the call to mtc_key_set_acedata(). Otherwise, it will be filled with Firm data parsed by TrueName.
Business Objects
2012-05-24
Match/Consolidate
72
Field name
Description
Example of data
MTC_KEYFLD_STRANGE
Primary range (house number).
100
MTC_KEYFLD_STPREDIR
Predirectional.
N, NE, E, SE, North, Northeast, East
MTC_KEYFLD_STNAME
Primary name (street name).
Harborview
MTC_KEYFLD_STSUFFIX
Suffix.
St, Ave, Blvd, Street, Avenue, Boulevard
MTC_KEYFLD_STPOST DIR
Postdirectional.
N, NE, E, North, Northeast, East
MTC_KEYFLD_STSRANGE
Secondary range (number only, without unit designator such as "Apt" or "Suite" prefix).
100
MTC_KEYFLD_POBOA
Post-office box number (number only, without "PO Box" prefix).
1103
MTC_KEYFLD_RRNUM
Rural-route number (number only, without "RR" or "Route" prefix).
1
MTC_KEYFLD_RRBOA
Rural-route box number (number only, without "Box" prefix).
14
MTC_KEYFLD_UNPADDR LINE
Unparsed address line.
5th and View
2012-05-24
Match/Consolidate
Field name
Description
Example of data
MTC_KEYFLD_ACEREC TYPE
Record-type indicator for the assigned address. The first character indicates the type of record in the ZIP+4 directory to which the address was matched. The second character may be a D or blank. The D stands for default; it means that ACE detected, from the ZIP+4 directory, that a finer level of ZIP+4 assignment would be possible if further input information were available.
FD firm
MTC_KEYFLD_ACEER RORCODE
Error code, if address is unassigned; or blank, if assigned.
E201
MTC_KEYFLD_CITY
Standardized city name.
La Crosse
MTC_KEYFLD_STATE
Standard USPS abbreviation for the state.
AK, AL, AR, and so on
MTC_KEYFLD_ZIP
5-digit ZIP.
54601
MTC_KEYFLD_ZIP4
ZIP+4.
4071
MTC_KEYFLD_COUNTRY
Country.
U.K.
MTC_KEYFLD_UNPLAST LINE
Unparsed last line.
Anytown, USA
G general delivery MD military
3.1.3 Alphabetical list of key fields for other data
73
2012-05-24
Match/Consolidate
Table 3-3: Match key fields for other data Field name
Description
Example of data
MTC_KEYFLD_BIRTHDATE
Date of birth in YYYYMMDD.
19450222
MTC_KEYFLD_PHONE
Phone number, including area code, without punctuation.
6087888154
MTC_KEYFLD_SPECIAL1
Use these fields for data that's not defined in any of the other key fields.
MTC_KEYFLD_SPECIAL2 MTC_KEYFLD_SPECIAL3 MTC_KEYFLD_SPECIAL4 MTC_KEYFLD_SPECIAL5 MTC_KEYFLD_SPECIAL6 MTC_KEYFLD_SPECIAL7 MTC_KEYFLD_SPECIAL8 MTC_KEYFLD_SPECIAL9 MTC_KEYFLD_SPECIAL10 MTC_KEYFLD_SSNUM
Social Security account number.
1112223333
3.1.4 Alphabetical list of key fields for overall scoring Table 3-4: Match key fields for overall scoring
74
Field name
Description
Example of data
MTC_MATCHFLD_ADDR LINE
All the data in an address line, including range, street, directionals, and secondary range.
100 Harborview Plaza, Suite 13
2012-05-24
Match/Consolidate
Field name
Description
Example of data
MTC_MATCHFLD_FIRMLINE
All the data in a firm line, like firm, firm location.
Business Objects, Accounting Dept
MTC_MATCHFLD_LASTLINE
Al the data in the last line of an address, including city, state, and ZIP Code.
La Crosse WI 54601-4071
MTC_MATCHFLD_NAME LINE
All the data in the name line, like prename, first name, last name, postname, and so on.
Walter P. Malone, Lt Col, USAF
3.2 Match configuration file parameters
3.2.1 Overall configuration file Table 3-5: Match overall configuration file
75
Purpose
Option
File label
MTC_Overall_Config_File
Value/Example n/a n/a
Description
The first line of the file must be: MTC_Overall_Config_File.
2012-05-24
Match/Consolidate
Value/Example
Purpose
Option
Identify other configuration files in the set
MTC_Key_Config_File
path/faml_key.cfg
Pathname of the Match Key configuration file.
MTC_General_Config_File
path/faml_gen.cfg
Pathname of the Match General configuration file.
MTC_Keyfield_Config_File
path/faml_fld.cfg
Pathname of the Keyfield Match Options configuration file.
MTC_auto_Options_Con fig_File
path/auto_opt.cfg
Pathname of the Match auto Options configuration file.
MTC_Rule_Definition_Con fig_File
path/faml_rul.cfg
Pathname of the Match Rule Definition configuration file.
MTC_Matching_Type
RULE
AUTO
AUTO
If Rule is set, comment out the option MTC_auto_Options_Config_File.
Set type of matching
n/a
Description
3.2.2 Key configuration file Table 3-6: Match key configuration file
76
Purpose
Option
Value/Example
Description
File label
MTC_Key_Config_File
n/a
The first line of the file must be: MTC_Key_Config_File.
2012-05-24
Match/Consolidate
77
Purpose
Option
Value/Example
Description
Describe each key field
MTC_Field_Name
MTC_KEYFLD_TITLE
Match key fields begin with MTC_KEYFLD_. See Match Key Fields tables.
MTC_Field_Number
1–2
The number for this field. Normally, this is one. However, the following fields can have a value set greater than one: prename, first name, middle name, last name, postname maturity, postname other, gender, social security number, birth date, telephone number, and title.
MTC_Field_Alter nate_Number
0–6
The number for this alternate field. Match standards can be used with the name and name-related fields, including first name, middle name, prename, maturity postname, and other post name.
MTC_Field_Length
1–255
This value sets the length of this key field by establishing the maximum number of bytes of data that you want to store in this key field. The value does not have to include a terminating NULL. For example, the ZIP field could have a length of 5.
2012-05-24
Match/Consolidate
Purpose
Option
Value/Example
Description
MTC_Standardized_Da ta
True
Data is standardized, so a fast match process requires an exact data match for the fields to be considered a match.
False
A more extensive match process is used to determine whether the fields should be considered a match.
3.2.3 General configuration file Table 3-7: Match general configuration file Pur pose
Option
Value/Example
Description
File label
MTC_General_Con fig_File
n/a
The first line of the file must be: MTC_General_Config_File
Matching strategy
MTC_Match_Type
INDIVIDUAL
For automatic matching, one of the five values must be identified. The name of each represents its intended matching strategy.
FAMILY RESIDENT FIRM_INDIVIDUAL FIRM
78
Note: Use this option (MTC_Match_Type) for automatic matching only. If this session is rule-based, comment out this option.
2012-05-24
Match/Consolidate
Pur pose Overall matching tightness
Option
Value/Example
Description
MTC_Match_Thresh old
EXACT
For automatic matching, use one of the four values. The name of each represents the degree of similarity Match will demand of matches.
TIGHT MEDIUM LOOSE
Hyphenated last names
79
Note: Use this option (MTC_Match_Threshold) for automatic matching only. If this session is rule-based, comment out this option.
MTC_Option_Name
HYPHENATED_LAST NAME_TREATMENT
This option controls the treatment of hyphenated last names.
MTC_Option_Value
ON
Special treatment so that, for example, Jones would match Jones-Smith.
OFF
The special treatment for hyphenated last names is cancelled.
AUTO
(auto-matching only) Match will decide whether to apply special treatment in this situation.
2012-05-24
Match/Consolidate
Pur pose Multiple names per record
Maiden names
80
Option
Value/Example
Description
MTC_Option_Name
MULTINAME_TREATMENT
This option controls the treatment when multiple names are present.
MTC_Option_Value
MATCH_ALL_NAMES
All the names of multiname records must match to have a match.
MATCH_ONE_NAME
A match of any one of the names results in a match.
AUTO
(Auto-matching only) Match will decide whether all or just one of the names must match.
MTC_Option_Name
MAIDEN_NAME_TREATMENT
This option controls treatment of female records with different last names.
MTC_Option_Value
ON
A difference in last names does not prevent a match.
OFF
No special accommodation is given to the last name comparison.
AUTO
(Auto-matching only) Match will decide whether special treatment is warranted in this case.
2012-05-24
Match/Consolidate
Pur pose Ambiguous data
Option
Value/Example
Description
MTC_Option_Name
AMBIG_LASTLINE_DATA
Controls Match when it encounters ambiguity in last line data.
AMBIG_ADDRESS_DATA
Controls Match when it encounters ambiguity in address data.
AMBIG_FIRM_DATA
Controls Match when it encounters ambiguity in firm name data.
AMBIG_NAME_DATA
Controls Match when it encounters ambiguity in name data.
NO_MATCH
The fields will not match.
POOR
Data in this field must meet a poor match criteria.
LOOSE
Data in this field must meet a loose match criteria.
AUTO
Match will decide how to treat ambiguous data in this situation.
MTC_Option_Name
NUMBER_OF_PEOPLE
Controls how many people will be stored in the key if AUTO matching is used and the key is not explicitly defined.
MTC_Option_Value
1–16
Total number of names to be set up as a keyfield.
MTC_Option_Value
Max names per key
81
2012-05-24
Match/Consolidate
Pur pose Ignore firm if name matches
82
Option
Value/Example
Description
MTC_Option_Name
IGNORE_FIRM_OPTION
Controls whether Match should ignore firm data if name data matches.
MTC_Option_Value
ON
Firm data is ignored if name data matches sufficiently.
OFF
Firm data is treated normally, in accordance with field settings.
AUTO
Match will decide whether to ignore firm data in this situation.
2012-05-24
Match/Consolidate
Pur pose Extra comparisons
Option
Value/Example
Description
MTC_Option_Name
EXTRA_COMPARE_SEC_RANGE
Controls the conditions under which an extra comparison will be performed in order to best determine matches.
EXTRA_COMPARE_ADDRESS EXTRA_COMPARE_FIRM MTC_Option_Value
INDIVIDUAL
An extra compare is performed on name data.
FAMILY
An extra compare is performed on last name data.
FIRM_INDIVIDUAL
An extra compare is performed on name and firm data.
FIRM
An extra compare is performed on firm data.
OFF
No extra compare is performed on any data.
AUTO
Match decides whether to do an extra compare, and on what data.
3.2.4 Keyfield match options configuration file
File label
83
Option
Value
Description
MTC_Key field_Config_File
n/a
The first line of the file must be: MTC_Keyfield_Config_File
2012-05-24
Match/Consolidate
Key-field to which these settings will apply Compare field or words
Adjust for initials
Option
Value
Description
MTC_Field_Name
MTC_KEYFLD_TITLE
Match key fields begin with MTC_KEYFLD_. See Match Key Fields tables.
MTC_Op tion_Name
COMPARE_DATA_AS
This option sets the comparison algorithm for this field data.
MTC_Option_Val ue
ONE_STRING
The entire field data is compared as a string (most efficient).
WORDS
The field data is first parsed into words, then the words are compared.
AUTO
(Auto-matching only) Match decides which comparison algorithm should be used.
MTC_Op tion_Name
MTC_Option_Val ue
84
ADJUST_SCORE_FOR_INI TIALS
Controls any adjustment for names that are acronyms, or initials, like "IBM" versus "International Business Machines."
YES
Match will deduct less for unmatched characters that fit this situation.
NO
Match will treat these unmatched characters the same as any others.
AUTO
(Auto-matching only) Match will decide whether to deduct less for these unmatched characters.
0–100
(Rule matching only) as this number increases, less is deducted for the unmatched characters.
2012-05-24
Match/Consolidate
Adjust for "missing" words
85
Option
Value
Description
MTC_Op tion_Name
ADJUST_SCORE_FOR_ SUBSTRINGS
Controls any adjustment for names that are shorter forms, like "Midtown Power" versus "Midtown Power and Light."
MTC_Option_Val ue
YES
Match will deduct less for unmatched characters (words) that fit this situation.
NO
Match will treat these unmatched characters (words) the same as any others.
AUTO
(Auto-matching only) Match will decide whether to deduct less for these unmatched characters (words).
0–100
(Rule matching only) as this number increases, less is deducted for the unmatched characters (words).
2012-05-24
Match/Consolidate
Adjust for abbreviations
Require exact matching on numbers
File label
86
Option
Value
Description
MTC_Op tion_Name
ADJUST_SCORE_FOR_ ABBREVIATIONS
Controls any adjustment for names which have abbreviated words, like "Gen Elec" versus "General Electric."
MTC_Option_Val ue
YES
Match will deduct less for unmatched characters that fit this situation.
NO
Match will treat these unmatched characters the same as any others.
AUTO
(Auto-matching only) Match will decide whether to deduct less for these unmatched characters.
0–100
(Rule matching only) as this number increases, less is deducted for the unmatched characters.
MTC_Op tion_Name
REQUIRE_NUMERIC_DA TA_TO_MATCH_EXACTLY
Controls whether or not Match will require that numeric data match exactly, regardless of other match criteria.
MTC_Option_Val ue
YES
Numeric data must match exactly, regardless of other match criteria.
NO
Numeric data will not be treated any different than alphabetical data.
AUTO
(Auto-matching only) Match will decide whether or not to require numeric data to match exactly.
n/a
The first line of the file must be: MTC_auto_Options_Config_File
MTC_auto_Op tions_Config_File
2012-05-24
Match/Consolidate
Key-field to which these settings will apply Set a threshold score
87
Option
Value
Description
MTC_Field_Name
MTC_KEYFLD_TITLE
Match key fields begin with MTC_KEYFLD_. See Match Key Fields tables.
MTC_Op tion_Name
FIELD_MATCH_THRESHOLD
Sets a threshold specifically for this field to override a general setting.
MTC_Option_Val ue
EXACT
Must match exactly.
TIGHT
Must meet a tight match criteria.
MEDIUM
Must meet a medium match criteria.
LOOSE
Must meet a loose match criteria.
POOR
Must meet a poor match criteria.
WEIGHT_ONLY
Use the score from this field for weighting only. No minimum score (threshold) applies.
OFF
Do not perform the comparison on this field.
AUTO
Match decides the match threshold for this field.
2012-05-24
Match/Consolidate
Blankfield handling
Option
Value
Description
MTC_Op tion_Name
ONE_FIELD_BLANK
Controls how Match reacts to blank data in one or both fields.
MTC_Option_Val ue
BOTH_FIELDS_BLANK IGNORE_FIELD_COMPARI SON USE_BLANK_SCORE_IN_ EVALUATION
Set blank score
Match ignores this field if a blank is involved. Match performs the comparison and uses the blank score.
AUTO
Match decides whether to ignore the field or use the blank score.
MTC_Op tion_Name
ONE_FIELD_BLANK_SCORE BOTH_FIELDS_BLANK_SCORE
Sets the match score for this field if the blank condition is met and the corresponding control is set to USE_BLANK_SCORE_IN_EVALUATION.
MTC_Option_Val ue
EXACT
Matches exactly.
TIGHT
Meets a tight match criteria.
MEDIUM
Meets a medium match criteria.
LOOSE
Meets a loose match criteria.
POOR
Meets a poor match criteria.
NO_MATCH
This field does not match.
3.2.5 Auto options configuration file
88
2012-05-24
Match/Consolidate
Purpose
Option
Value
Description
Extra comparison
MTC_Op tion_Name
ONE_FIELD_BLANK_EXTRA_ COMPARE
Controls the conditions (one blank, both blank, or different) under which an extra comparison will be performed in order to best determine matches.
BOTH_FIELDS_BLANK_EXTRA_ COMPARE DIFFERENT_FIELDS_EXTRA_ COMPARE MTC_Op tion_Value
INDIVIDUAL
Extra compare on name data.
FAMILY
Extra compare on last name data.
FIRM_INDIVIDUAL
Extra compare on name and firm data.
FIRM
Extra compare on firm data.
OFF
No extra compare is performed on any data.
AUTO
Match decides whether to do an extra compare, and on what data.
3.2.6 Rule definitions configuration file
Purpose
File label
89
Option
Value
Description
MTC_Rule_Definition_Con fig_File
n/a
The first line of the file must be: MTC_Rule_Definition_Config_ File
2012-05-24
Match/Consolidate
Purpose
Option
Value
Description
Set number of rules and overall limits
MTC_Total_Number_Rules
1-64
This is the total number of rules included in this session.
MTC_Maximum_Weighted_Score_for_ Nodupe_Record
-1 – 100
If the overall weighted score for this session equals this number or lower, then the records are determined to not match. A value of -1 means that this session will never determine a non-match based solely on the weighted match score. Must be lower than the value in MTC_Minimum_Weighted_ Score_for_ Dupe_Record.
MTC_Minimum_Weighted_Score_for_ Dupe_Record
0–101
If the overall weighted score for this session equals this number or higher, then the records are determined to match. a value of 101 means that this session will never determine a match based solely on the weighted match score. Must be greater than the value in MTC_Maximum_Weighted_ Score_for_ Nodupe_Record.
MTC_Rule_Number
1-64
The number assigned to this rule.
Identify the rule
90
2012-05-24
Match/Consolidate
Purpose
Option
Value
Description
Identify the field to which this rule applies
MTC_Field_Name
MTC_KEYFLD_TITLE
Those that start with MTC_KEYFLD_ or MTC_MATCHFLD_. See Match Key Fields and Match Fields tables.
MTC_Field_Blank
IGNORE_FIELD_COMPARI SON
Match ignores this field if a blank is involved.
MTC_Both_Fields_Blank
USE_BLANK_SCORE_IN_ EVALUATION
Match performs the comparison and uses the appropriate blank score as the comparison score.
MTC_Field_Blank_Score
0–100
The score to use in this field match if the blank field operation MTC_Field_Blank (above) applies.
MTC_One_Field_Blank_Score
0–100
The score to use in this field match if the blank field operation MTC_One_Field_Blank applies.
MTC_Both_Fields_Blank_Score
0–100
The score to apply to this field match if the blank field operation MTC_Both_Fields_Blank applies.
Blank-field handling
MTC_One_Field_Blank
Set blank score
91
2012-05-24
Match/Consolidate
Purpose
Set max score for no-match
Set min. score for match
92
Option
Value
Description
MTC_Maximum_Rule_Score_ for_Nodupe_Record
-1 – 100
If this field comparison score equals this number or lower, then the records are determined to not match. A value of -1 means that this rule will never determine a nonmatch. Must be lower than the value in MTC_Minimum_Rule_Score_ for_ Dupe_Record.
MTC_Minimum_Rule_Score_for_ Dupe_Record
0–101
If this field comparison score equals this number or higher, then the records are determined to match. A value of 101 means that this rule will never determine a match. Must be greater than the value in MTC_Maximum_Rule_Score_ for_ Nodupe_Record.
2012-05-24
Match/Consolidate
Purpose
Control participation of this field in weighted scoring
Option
Value
Description
MTC_Weight_for_This_ Field
0-100
The weight this field comparison has within the overall record comparison. all such rule rates for this session must not total more than 100.
MTC_Use_In_Overall_Weighted_ Score_ If_Rule_Score_Exceeds
-1 – 100
If this field comparison score equals this number or lower, then this rule does not contribute to the calculation of the overall weighted score. In this situation, Match ignores this field comparison in its calculation of the overall weighted score. Contrast this option with the next option .
MTC_Use_Zero_Weight_Score_If_ Rule_Score_Does_Not_Exceed
-1 – 100
If this field comparison score equals this number or lower, then a score of zero is used in this field's contribution to the overall weighted score. Contrast this option with the one above.
93
2012-05-24
Match/Consolidate
94
2012-05-24
Index A ACE U.S. address and assignment results codes 34 address status codes 59 address-line components alias 27 assigned 24 dual 29 AP fields 46 APM fields 46 error codes 63 fields and options 17, 65 Geocensus codes 56 last-line components 22 multiline input components 31 other codes 41 postal codes 33 SuiteLink fields 55 ACE_AGEO_BLK 56 ACE_AGEO_CTY 56 ACE_AGEO_LAT 56 ACE_AGEO_LNG 56 ACE_AGEO_MCD 56 ACE_AGEO_PLA 56 ACE_AGEO_STA 56 ACE_ANKLINK_RETCODE 54 ACE_APD_ADDRESS 29 ACE_APD_EXTRAN_PMB 29 ACE_APD_EXTRAN_SEC 29 ACE_APD_EXTRANEOUS 29 ACE_APD_POB_NUM 29 ACE_APD_POSTDIR 29 ACE_APD_PREDIR 29 ACE_APD_PRIM_ADDR 29 ACE_APD_PRIM_NAME 29 ACE_APD_PRIM_RANGE 29 ACE_APD_REC_TYPE 29 ACE_APD_REMAINDER 29 ACE_APD_RR_BOX_NUM 29 ACE_APD_RR_NUM 29 ACE_APD_SEC_ADDR 29 ACE_APD_SEC_RANGE 29 ACE_APD_SUFFIX 29 ACE_APD_UNIT_DESIG 29 ACE_APD_URB 29 ACE_APDL_POSTDIR 29 ACE_APDL_PREDIR 29 ACE_APDL_SUFFIX 29 ACE_APM_ADDRESS 50
95
ACE_APM_AUD_FIELDS 46 ACE_APM_AUD_MID_NAME 46 ACE_APM_AUD_PNAME 46 ACE_APM_AUD_RANGE 46 ACE_APM_AUD_UNIT 46 ACE_APM_CART 50 ACE_APM_CHK_DIGIT 50 ACE_APM_CITY 50 ACE_APM_DPBC 50 ACE_APM_DROP 46 ACE_APM_DROP_N 46 ACE_APM_EFF_DATE 46 ACE_APM_FIRM 46 ACE_APM_FIRST_NAME 46 ACE_APM_GENDER 46 ACE_APM_HINT_BYTE 46 ACE_APM_INT_CODES 46 ACE_APM_LAST_NAME 46 ACE_APM_LASTLINE 50 ACE_APM_LOT 50 ACE_APM_LOT_ORDER 50 ACE_APM_MID_NAME 46 ACE_APM_MOVE_TYPE 46 ACE_APM_POST_NAME 46 ACE_APM_POSTDIR 50 ACE_APM_PRE_NAME 46 ACE_APM_PREDIR 50 ACE_APM_PRIM_ADDR 50 ACE_APM_PRIM_NAME 50 ACE_APM_PRIM_RANGE 50 ACE_APM_RETCODE 46 ACE_APM_SEC_ADDR 50 ACE_APM_SEC_RANGE 50 ACE_APM_STATE 50 ACE_APM_SUFFIX 50 ACE_APM_UNIT_DESIG 50 ACE_APM_URB 50 ACE_APM_ZIP 50 ACE_APM_ZIP10 50 ACE_APM_ZIP4 50 ACE_APM_ZIP9 50 ACE_CART 33 ACE_CASS_MATCH 41 ACE_CASSRECTYP 34 ACE_CGEO_BLK 56 ACE_CGEO_CBSA 56 ACE_CGEO_LAT 56 ACE_CGEO_LNG 56 ACE_CGEO_MATCH 56 ACE_CGEO_MSA 56 ACE_CHECKDIGIT 33
ACE_CITY 22 ACE_CITY_ABBR 22 ACE_CITY_LLIDX 22 ACE_CITY_NPREF 22 ACE_CITY_PLACE 22 ACE_CONGRESS 41 ACE_COUNTY 41 ACE_COUNTYNAME 41 ACE_CR_SORT_ZN 33 ACE_DPBC 33 ACE_DPV_CMRA 34 ACE_DPV_FTNOTE 34 ACE_DPV_NO_STATS 34 ACE_DPV_STATUS 34 ACE_DPV_VACANT 34 ACE_ERR_STAT 34 ACE_ERROR_CODE 34 ace_error_codes 63 ACE_EWS_MATCH 34 ACE_EXTRA1-10 31 ACE_FACTYPE 41 ACE_FIPSCODE 41 ACE_FIRMLINE 41 ACE_FOREIGNCODE 34 ACE_GEO_MATCH 56 ace_get_component() 22 ACE_IADDRESS 17 ACE_ICART 17 ACE_ICHKDGT 17 ACE_ICITY 17 ACE_ICOUNTRY 17 ACE_ICOUNTY 17 ACE_IDPBC 17 ACE_ILASTLINE 17 ACE_ILINE1–12 17 ACE_ILOT 17 ACE_ILOT_ORDER 17 ACE_INAME ACE_IFIRM 17 ACE_INPUT_FIRM 55 ACE_ISTATE 17 ACE_ISUITE 17 ACE_IURB 17 ACE_IZIP 17 ACE_IZIP10 17 ACE_IZIP4 17 ACE_LACSCODE 34 ACE_LACSLINK_IND 52 ACE_LACSLINK_QUERY 52 ACE_LACSLINK_RETCODE 52 ACE_LAST_LINE 22 ACE_LOT 33
2012-05-24
Index
ACE_LOT_ORDER 33 ACE_MATCH_5 34 ACE_MATCH_9 34 ACE_MATCH_UN 34 ACE_MVID flag 22 ACE_NC_FIRM 34 ACE_NC_SECADDR 34 ACE_NC_SRANGE 34 ACE_NC_UNIT 34 ACE_NEW flag 22 ACE_NEWLINE 41 ACE_OLD flag 22 ACE_PRESL_DPBC 55 ACE_PRESL_SEC_RANGE 55 ACE_PRESL_UNIT_DESIG 55 ACE_PRESL_ZIP 55 ACE_PRESL_ZIP4 55 ACE_QSS_DEFAULT 41 ACE_RDI 41 ACE_REC_TYPE 34 ACE_STAT_CODE 34 ACE_STATE 22 ACE_STD_LINE1-12 31 ACE_SUITELINK_RETCODE 55 ACE_ZIP 22, 33 ACE_ZIP_MOVE 34 ACE_ZIP10 22, 33 ACE_ZIP4 22, 33 ACE_ZIP9 22, 33 ACE_ZIPTYPE 34 ACEQ_ALSTYP 65 ACEQ_ALTERNATE 65 ACEQ_CARTEVEN 65 ACEQ_CARTODD 65 ACEQ_CONGRESS 65 ACEQ_COUNTY 65 ACEQ_HIGHRANGE 65 ACEQ_HIGHSRANGE 65 ACEQ_LACSIND 65 ACEQ_LLINDEX 65 ACEQ_LOWRANGE 65 ACEQ_LOWSRANGE 65 ACEQ_ODDEVEN 65 ACEQ_PNAME 65 ACEQ_POSTDIR 65 ACEQ_PREDIR 65 ACEQ_RECTYPE 65 ACEQ_SNAME 65 ACEQ_SODDEVEN 65 ACEQ_SUFFIX 65 ACEQ_UNIT 65 ACEQ_URB_INDEX 65 ACEQ_ZIP 65 ACEQ_ZIP_MOVE 65 ACEQ_ZIP4EVEN 65 ACEQ_ZIP4ODD 65
96
address data keyfields Match 71 address and assignment results codes ACE U.S. 34 address items 10 address status codes ACE U.S. 59 address-line components ACE_ADDRESS 24 ACE_ALINE 24 ACE_APA_ADDRESS 27 ACE_APA_POSTDIR 27 ACE_APA_PREDIR 27 ACE_APA_PRIM_ADDR 27 ACE_APA_PRIM_NAME 27 ACE_APA_PRIM_RANGE 27 ACE_APA_SEC_ADDR 27 ACE_APA_SEC_RANGE 27 ACE_APA_SUFFIX 27 ACE_APA_TYPE 27 ACE_APA_UNIT_DESIG 27 ACE_APAL_POSTDIR 27 ACE_APAL_PRDIR 27 ACE_APAL_SUFFIX 27 ACE_APL_POSTDIR 24 ACE_APL_PREDIR 24 ACE_APL_SUFFIX 24 ACE_DUAL_LINE 24 ACE_EXTRAN_SEC 24 ACE_EXTRANEOUS 24 ACE_NP_SECADDR 24 ACE_NP_SRANGE 24 ACE_NP_UNIT 24 ACE_POB_NUM 24 ACE_POSTDIR 24 ACE_PREDIR 24 ACE_PRIM_ADDR 24 ACE_PRIM_NAME 24 ACE_PRIM_RANGE 24 ACE_REMAINDER 24 ACE_RR_BOX_NUM 24 ACE_RR_NUM 24 ACE_SEC_ADDR 24 ACE_SEC_RANGE 24 ACE_SUFFIX 24 ACE_UNIT_DESIG 24 ACE_URB 24 ACE_USPS_UNIT 24 alias ACE U.S. 27 assigned ACE U.S. 24 CE_EXTRAN_PMB 24 dual ACE U.S. 29
adjust for abbreviations, Match 83 adjust for initials, Match 83 Ambiguous data, Match 78 ANKLink 54 APM_AUD_SRANGE 46
B blank score, Match 83 blank-field handling, Match 83
C compare field or words, Match 83 configuration file, overall Match 75
D DataRight IQ fields and options 5 output items 8 date items 11 DRL_ADDRESS 10 DRL_DATE 11 DRL_DATE_DAY 11 DRL_DATE_MONTH 11 DRL_DATE_YEAR 11 DRL_EMAIL 14 DRL_EMAIL_DOMAIN_ALL 14 DRL_EMAIL_DOMAIN_FIFTH 14 DRL_EMAIL_DOMAIN_FOURTH 14 DRL_EMAIL_DOMAIN_HOST 14 DRL_EMAIL_DOMAIN_SECOND 14 DRL_EMAIL_DOMAIN_THIRD 14 DRL_EMAIL_DOMAIN_TOP 14 DRL_EMAIL_IS_ISP 14 DRL_EMAIL_USER 14 DRL_EXTRA 16 DRL_FIRM 10 DRL_FIRM_LOC 10 DRL_FIRST_NAME 8 DRL_HON_POST 8 DRL_IADDRESS1-2 5 DRL_IDATE1-6 5 DRL_IEMAIL1-6 5 DRL_IFIRMLINE1-2 5 DRL_IFIRMLOC1-2 5 DRL_IFIRMNAME1-2 5 DRL_IFNAME1-2 5 DRL_IHONPOST1-2 5 DRL_ILAST_LINE1-2 5 DRL_ILINE1-12 5 DRL_ILNAME1-2 5 DRL_IMAT_POST1-2 5
2012-05-24
Index
DRL_IMNAME1-2 5 DRL_INAME_FIRM1-6 5 DRL_INAMELINE1-6 5 DRL_IPHONE1-6 5 DRL_IPRENAME1-2 5 DRL_ISSN1-6 5 DRL_ITITLE1-2 5 DRL_ITITLELINE1-6 5 DRL_IUDPM1-4 5 DRL_LAST_LINE 11 DRL_LAST_NAME 8 DRL_MID_NAME 8 DRL_NAME_CONNECTOR 9 DRL_NAME_DESIG 8 DRL_NAME_DUAL 9 DRL_NAME_SPEC 8 DRL_PERSON 8 DRL_PRELAST 8 DRL_PRENAME 8 DRL_SSN 11 DRL_SSN_AREA 11 DRL_SSN_GROUP 11 DRL_SSN_SERIAL 11 DRL_TITLE 8 DRL_UDPM 16 DRL_UDPM_SUB1-5 16 DRL_US_PHONE 12 DRL_US_PHONE_AREA_CODE 12 DRL_US_PHONE_EXT 12 DRL_US_PHONE_LINE 12 DRL_US_PHONE_PREFIX 12 DRL_US_PHONE_TYPE 12 dual name items 9
E e-mail items 14 error codes 63 exact matching on numbers, Match 83 extra comparison, Match 88 Extra comparisons, Match 78 extra items 16
F file label, Match 83 File label, Match 78 firm items 10
G general configuration file Match 78 Geocensus codes 56
97
H Hyphenated last names, Match 78
I Ignore firm if name matches, Match 78 international phone items 13
K key configuration file Match 76 keyfields address data 71 Match 69 other data, Match 73 overall scoring, Match 74
L LACSLink output components 52 last line items 11 last-line components ACE U.S. 22
M Maiden names, Match 78 Match address data keyfields 71 configuration file parameters 75 general configuration file 78 key configuration file 76 keyfield match options configuration file 83 keyfields 69 other data keyfields 73 overall configuration files 75 overall scoring keyfields 74 rule definitions configuration file 89 Match configuration file parameters MTC_auto_Options_Config_File 75 MTC_General_Config_File 75 MTC_Key_Config_File 75 MTC_Keyfield_Config_File 75 MTC_Matching_Type 75 MTC_Overall_Config_File 75 MTC_Rule_Definition_Config_File 75 Match general configuration file MTC_General_Config_File 78 MTC_Match_Threshold 78
Match general configuration file (continued) MTC_Match_Type 78 Match key configuration file MTC_Field_Alternate_Number 76 MTC_Field_Length 76 MTC_Field_Name 76 MTC_Field_Number 76 MTC_Key_Config_File 76 MTC_Standardized_Data 76 Match keyfield match options configuration file MTC_Field_Name 83 MTC_Option_Name 83 MTC_Option_Value 83 Match keyfields MTC_KEYFLD_FIRM 69 MTC_KEYFLD_FIRSTNAME 69 MTC_KEYFLD_GENDER 69 MTC_KEYFLD_LASTNAME 69 MTC_KEYFLD_MATPOSTNAME 69 MTC_KEYFLD_MIDDLENAME 69 MTC_KEYFLD_OTHERPOSTNAME 69 MTC_KEYFLD_PRENAME 69 MTC_KEYFLD_TITLE 69 Matching strategy, Match 78 Max names per key, Match 78 missing word adjustment, Match 83 MTC_auto_Options_Config_File 88 MTC_Both_Fields_Blank 89 MTC_Both_Fields_Blank_Score 89 MTC_Field_Blank 89 MTC_Field_Blank_Score 89 MTC_Field_Name 89 MTC_Keyfield_Config_File 83 MTC_KEYFLD_ACEERRORCODE 71 MTC_KEYFLD_ACERECTYPE 71 MTC_KEYFLD_BIRTHDATE 73 MTC_KEYFLD_CITY 71 MTC_KEYFLD_COUNTRY 71 MTC_KEYFLD_FIRM 71 MTC_KEYFLD_PHONE 73 MTC_KEYFLD_POBOA 71 MTC_KEYFLD_RRBOA 71 MTC_KEYFLD_RRNUM 71 MTC_KEYFLD_SPECIAL1 73 MTC_KEYFLD_SPECIAL10 73 MTC_KEYFLD_SPECIAL2 73 MTC_KEYFLD_SPECIAL3 73 MTC_KEYFLD_SPECIAL4 73 MTC_KEYFLD_SPECIAL5 73 MTC_KEYFLD_SPECIAL6 73 MTC_KEYFLD_SPECIAL7 73 MTC_KEYFLD_SPECIAL8 73
2012-05-24
Index
MTC_KEYFLD_SPECIAL9 73 MTC_KEYFLD_SSNUM 73 MTC_KEYFLD_STATE 71 MTC_KEYFLD_STNAME 71 MTC_KEYFLD_STPOSTDIR 71 MTC_KEYFLD_STPREDIR 71 MTC_KEYFLD_STRANGE 71 MTC_KEYFLD_STSRANGE 71 MTC_KEYFLD_STSUFFIX 71 MTC_KEYFLD_UNPADDRLINE 71 MTC_KEYFLD_UNPLASTLINE 71 MTC_KEYFLD_ZIP 71 MTC_KEYFLD_ZIP4 71 MTC_MATCHFLD_ADDRLINE 74 MTC_MATCHFLD_FIRMLINE 74 MTC_MATCHFLD_LASTLINE 74 MTC_MATCHFLD_NAMELINE 74 MTC_Maximum_Rule_Score_for_Nodupe_Record 89 MTC_Maximum_Weighted_Score_for_Nodupe_Record 89 MTC_Minimum_Rule_Score_for_Dupe_Record 89 MTC_Minimum_Weighted_Score_for_Dupe_Record 89 MTC_One_Field_Blank 89 MTC_One_Field_Blank_Score 89
98
MTC_Rule_Definition_Config_File 89 MTC_Rule_Number 89 MTC_Total_Number_Rules 89 MTC_Use_In_Overal_Weighted_Score_If_Rule_Score_Exceeds 89 MTC_Use_Zero_Weg i ht_Score_If_Rue l _Score_Does_Not_Exceed 89 MTC_Weight_for_This_Field 89 multiline input components ACE U.S. 31 Multiple names per record, Match 78
N name items 8
O other codes ACE U.S. 41 Output components LACSLink 52 move data 46 NCOALink data 50 output items DataRight IQ 8 Overall matching tightness, Match 78
P postal codes ACE U.S. 33
R RL_MAT_POST 8 rule definitions configuration file Match 89
S SuiteLink fields 55
T threshold score, Match 83
U U.S. phone items 12 U.S. Social Security number items 11 us_ace_input 17 user-defined pattern items 16
2012-05-24
