Quick Reference for Views and Job-File Products
March 2011
Copyright information
2
© 2011 SAP AG. All rights reserved.SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, 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 S.A. in the United States and in other countries. Business Objects 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.
Quick Reference for Views and Job-File Products March 2011
Contents
Chapter 1: DataRight IQ .................................................................................................. 5 DataRight IQ input fields..................................................................................6 DataRight IQ output fields selection chart .....................................................10 Chapter 2: ACE U.S........................................................................................................ 21 ACE U.S. input fields .....................................................................................22 ACE U.S. output fields ...................................................................................25 ACE U.S. address status codes .......................................................................68 ACE address error codes (U.S. and Canada) ..................................................70 Chapter 3: ACE Canada................................................................................................. 71 ACE Canada input fields ................................................................................72 ACE Canada output fields ..............................................................................74 ACE Canada address status codes ..................................................................80 Chapter 4: International ACE ...................................................................................... 83 International ACE input fields........................................................................84 IACE output fields ..........................................................................................87 International ACE address fault codes..........................................................107 International ACE address status codes........................................................109 Chapter 5: Match/Consolidate ..................................................................................... 117 Match/Consolidate input fields.....................................................................118 Match/Consolidate key fields .......................................................................124 Match/Consolidate output fields...................................................................127 Chapter 6: Presort......................................................................................................... 133 Presort input fields ........................................................................................134 Selection chart ........................................................................................134 Presort output fields ......................................................................................143 Selection chart ........................................................................................143 Chapter 7: Label Studio ............................................................................................... 161 Label Studio input fields...............................................................................162 Label Studio output fields.............................................................................166 Chapter 8: Values, commands, and filter functions................................................... 169 Lower ASCII code values.............................................................................170 Upper ASCII code values .............................................................................172 Command-line options..................................................................................174
Contents
3
Command syntax ................................................................................... 174 Filter functions and operators....................................................................... 177 Index ............................................................................................................ 181
4
Quick Reference for Views and Job-File Products March 2011
Chapter 1: DataRight IQ
This chapter contains input and output fields for DataRight IQ Job and DataRight IQ Views. For more information on setting up jobs with these products, see the documentation that accompanies DataRight IQ. The items in this section are current through DataRight IQ 7.90c.
Chapter 1: DataRight IQ
5
DataRight IQ input fields Input fields are listed by the type of input data. When a field is grouped together with other like fields, the order is based on the first field in the list.
DataRight IQ input fields Field name(s)
Length
Description
Example of data
PW.Pre_Name PW.First_Name PW.Mid_Name PW.Last_Name PW.Post_Name
up to 254
If the input database contains discrete fields for name data, use these PW fields to present the data to DataRight IQ. If you use these input fields, at a minimum you must use Last_Name and either Pre_Name or First_Name.
Mr. John B. Smith Jr., CPA
PW.Title1–6
up to 254
If the input database contains a separate job-title field, present the field to DataRight IQ as Titlex. Use this field only if you are confident that the field contains only job titles. DataRight IQ does not apply its own parsing to this field.
Accountant
PW.Name_Line1–6
up to 254
If the input database stores names as whole lines, present each line to DataRight IQ as Name_Linex. A name line may contain more than one name.
Mr. John B. Smith Jr., CPA, Accountant Mr. and Mrs. David Zaiman Jones, John and Doe, Mary
PW.Name_Firm1–6
up to 254
If an input field contains name data in some records but contains firm (company) data in other records, present the field to DataRight IQ as Name_Firmx. DataRight IQ parses name and firm data from this field; any other data (including address data) is parsed as extra data.
Record 1: Mr. John B. Smith, Jr., CPA Record 2: Business Objects, Sales Dept.
PW.Firm1–2
up to 254
If an input field contains the name of a company or organization, present the field to DataRight IQ as Firmx. Note: If you use any Linex fields, do not use the Firmx fields. Instead, use FirmLinex. (If you use any Firmx fields and also use Linex fields, any firm names found in the Linex fields will be parsed as extra data.)
Business Objects
PW.FirmLoc1–2
up to 254
If an input field contains information that identifies a location Accounting Dept. within a company, such as a department or mail stop, present the field to DataRight IQ as FirmLocx. Note: If you use any Linex fields, do not use the Firm_Locx fields. Instead, use Firm_Linex. (If you use any FirmLocx fields and also use Linex fields, any firm location data found in the Linex fields will be parsed as extra data.)
PW.FirmLine1–2
up to 254
If an input field contains both firm-name and firm-location data, present the field to DataRight IQ as FirmLinex. You may also use FirmLinex if a field contains firm-name data in some records but contains firm-location data in other records. Note: If you use any Firmx or FirmLocx fields, you may not use FirmLine1-2.
6
Quick Reference for Views and Job-File Products March 2011
Business Objects, Accounting Dept.
DataRight IQ input fields Field name(s)
Length
Description
Example of data
PW.Non_Addr1–6
up to 254
If the input database stores any type of data in one single field except address type information. This would include names, firm names, telephone numbers, social security numbers, dates, and e-mail addresses.
Mr. John B. Smith, Jr., CPA Business Objects, Sales Dept. (608)555-1212
PW.Address
up to 60
If the input database contains only one field for address-line data (street address, PO box, rural route), present the field to DataRight IQ as Address. Through the Address field, DataRight IQ can accept dual addresses, where one field contains both a street address and PO box, or a rural and fire address. Note: If the input database has more than one address-line field, do not use Address for any of those fields. Instead, use Linex for all the address-line fields.
1234 W Main St 1234 W Main St, Apt. 5 1234 W Main St, PO box 123
PW.Unit
up to 60
If the input database has a separate field for unit information (apartment or suite), use Address for the primary (street) address and Unit for the unit information.
Apt. 5
PW.City
up to 60
If the input database has separate fields for city and state, present them to DataRight IQ through the input fields City and State.
La Crosse
PW.State
2
Note: You cannot use the discrete City and State fields if you store city and state together in one field or use state abbreviations other than those set by the U.S. Postal Service. In these instances, you must instead use Last_Line.
WI
PW.ZIP
5
If the input database has a field specifically for the 5-digit ZIP Code, present the field to DataRight IQ as ZIP.
54601
PW.ZIP4
4
If the input database has a separate field for the 4-digit ZIP+4 extension, define the field as ZIP4.
4051
PW.ZIP10
10
If the input database has a combined field for ZIP and ZIP4, present the field to DataRight IQ as ZIP10. It doesn’t matter whether or not there is a hyphen between the codes.
54601-4051 546014051
PW.Last_Line
up to 60
La Crosse WI 54601If one field in the input database contains city, state, and ZIP 4051 data, present the field to DataRight IQ as Last_Line. In some situations, you must set up Last_Line to include (concatenate) two or more fields containing city, state, and ZIP data: If you store city and state data together in one field but store ZIP in a separate field, set up Last_Line to include both fields. For example, your DEF file entry might be Last_Line = DB.CITY_STATE & DB.ZIP. If the input state field contains either full spellings or abbreviations other than those set by the U.S. Postal Service, you cannot use the discrete State field. Set up Last_Line to include your city, state, and ZIP fields. For example, Last_Line = DB.CITY & DB.STATE & DB.ZIP.
PW.Urb
up to 60
If the input database contains a separate field for the Puerto Rican urbanization name, present the field to DataRight IQ as Urb.
Urb Radioville
Chapter 1: DataRight IQ
7
DataRight IQ input fields Field name(s)
Length
Description
PW.Country
up to 60
If the input database contains a separate field for country name, Canada present the field to DataRight IQ as Country. DataRight IQ does not do anything with the data in this field except apply capitalization.
PW.Line1–12
up to 60
If the content of an input field varies from record to record, present the field to DataRight IQ as Linex. DataRight IQ will identify and parse name, title, firm, and U.S. address data. Use Linex only if an input field is truly a multiline field with floating data. If an input field consistently contains a certain type of data, define the field as specifically as possible. Note: Do not use Linex for discrete name components (first name, middle name, last name, and so on).
Any data
PW.List_ID
up to 254
Use this field to define logical lists. You can define an input field (for example, List_ID = DB.Broker), or you can define a constant for all records in a file (for example, List_ID = “Broker A”).
Broker A
PW.Delete
1
Some fixed-length and ASCII files include a field that is used to * mark files for deletion. If your file includes such a field, you can present it as Delete. DataRight IQ checks the Delete field to determine if the record is marked to be deleted. If the first character of the field is an asterisk (*), the record is treated as deleted. If the first character is any other character or if the field is blank, the record is not considered deleted. You can control whether DataRight IQ processes deleted records through the Process Deleted Records parameter in the Input File block.
PW.Date1–6
up to 60
If the input database contains a field for the date, present it to DataRight IQ through Date1-6.
1977-08-16
PW.Email1–6
up to 60
If the input database contains a field for e-mail addresses, present it to DataRight IQ through EMail1-6.
joex@Business Objects.com
PW.Phone1–6
up to 60
If the input database contains a field for phone numbers (either North American or International), present it to DataRight IQ through Phone1-6.
(608)-555-5555 61 7 4035 2170
PW.SSN1–6
up to 60
If the input database contains a field for social security numbers, present it to DataRight IQ through SSN1-6.
111-22-3333
PW.Pattern1–4
254
If you’ve created a user-defined pattern for a particular item in PN160-345 your database, present the field that contains this data to DataRight IQ through Pattern1-4.
8
Quick Reference for Views and Job-File Products March 2011
Example of data
DataRight IQ input fields Field name(s)
Length
Description
Example of data
PW.user:fieldname
up to 60
You may define your own PW fields by using the User: prefix. You may use this field to overcome field-naming differences among input files. If your input files contain different field names (for example, ID vs. CUSTOMERID), present the fields to DataRight IQ as a User: field (for example, User:CUST_ID). This gives you a common field—CUST_ID—to use in posting and filters. Note: When you type an entry for a User: field in the DEF file, do not include the “PW” prefix. For example, type User:CUST_ID, not User:PW.CUST_ID.
Any data
Chapter 1: DataRight IQ
9
DataRight IQ output fields selection chart There are four types of DataRight IQ application fields: AP fields contain parsed, standardized data. DataRight IQ applies the standardization specified in the Standardization/Assignment Control block in the job file. APU fields contain parsed, unstandardized data. APC fields contain parsing-confidence scores. APM fields contain match standards that can be used for matching or Match/ Consolidate processing. Name and title data
DataRight IQ output fields: Name and title data Field name(s)
Length
Description
Example of data
AP.NameDesig1–6 APU.NameDesig1–6
254
Name designator such as Attn: or c/o.
Attn:
AP.Pre_Name1–6 APU.Pre_Name1–6
254
Prename, such as Mr., Ms., Dr. The prename may be parsed from the input data or assigned by DataRight IQ.
Mr.
AP.FirstName1–6 APU.FirstName1–6
254
First name or first–name initial.
John
AP.Mid_Name1–6 APU.Mid_Name1–6
254
Middle name or middle initial.
B.
AP.Last_Name1–6 APU.Last_Name1–6
254
Surname.
Smith
AP.Mat_Post1–6 APU.Mat_Post1–6
254
Postname indicating heritage, such as Jr., Sr., III.
Jr.
AP.Oth_Post1–6 APU.Oth_Post1–6
254
Postname indicating certification, academic degree, or affiliation, such as CPA, Ph.D., USMC.
CPA
AP.Title1–6 APU.Title1–6
254
Accountant Job title. DataRight IQ associates the title with a name whenever possible, so the job title in AP.Title1 is the title for the person in AP.Name1, and so on.
AP.All_Names APU.All_Names
1500
AP.All_Names or APU.All_Names will concatenate all AP.NAMEx or APU.NAMEx fields together.
AP.Name1–6 APU.Name1–6
254
The entire name for one person, not including job title.
10
Quick Reference for Views and Job-File Products March 2011
Attn: Mr. John B. Smith, Jr., CPA
DataRight IQ output fields: Name and title data Field name(s)
Length
Description
Example of data
AP.Name_Line1–6 APU.Name_Line1–6
254
If the input records contain discrete name and title fields, DataRight IQ builds a name line in the Name_Line1 field. If the input records contain name data in name lines or multiline fields, each Name_Linex field contains all of the name and title data found in the original input line. Name components are in the same order as they appear on the input line. Note: Numbers for the name line fields may not always correspond to the numbers for the name component fields. For example, AP.FirstName2 may contain the first name of the second person found on AP.Name_Line1.
Attn: Mr. John B. Smith, Jr., CPA, Accountant Jones, Mr. John and Doe, Ms. Mary
AP.Dual_Name APU.Dual_Name
254
The first dual name found by the parser. Name components are in the same order as they appear on the input line. (A dual name is two names that share one last name.) Note: If DataRight IQ finds a dual name, it places the dual name into the appropriate AP.Name_Linex field and also into AP.Dual_Name.
Mr. and Mrs. Craig Pesik
AP.Spec_Name APU.Spec_Name
254
Generic name words such as Occupant, Current Resident, or Family.
Occupant
AP.Name_Cnt
1
The number of personal names found in the record (up to six).
2
Firm data
DataRight IQ output fields: Firm data Field name(s)
Length
Description
Example of data
AP.Firm1–2 APU.Firm1–2
up to 60
The name of a company or organization.
Input data: FIRSTLOGIC INCORP. AP.Firm1: Firstlogic, Inc. APU.Firm1: FIRSTLOGIC INCORP.
AP.Firm_Loc1–2 APU.Firm_Loc1–2
up to 30
A location within a company or organization, such as a department, room, or mail stop. Usually this information is used for internal mail or fax delivery.
Input data: SALES DEPARTMENT AP.Firm_Loc1: Sales Dept. APU.Firm_Loc1: SALES DEPARTMENT
AP.Firm_Line1–2 APU.Firm_Line1–2
up to 60
All the firm data found in one input firm line or multiline field. May contain company-name data, firm location data, or both.
Business Objects, Sales Dept.
Chapter 1: DataRight IQ
11
Gender codes and salutations
DataRight IQ output fields: Gender codes and salutations Field name(s)
Length
Description
Example of data
AP.Gender1–6 APU.Gender1–6
1
Gender codes for AP.Name1–6. For a list of gender codes, see AP.Gender_Rec.
5
AP.Gender_Rec
1
Overall gender for the entire record. 1 High confidence male. 2 Some confidence that the name is male. 3 The name could be either male or female. 4 Some confidence that the name is female. 5 High confidence that the name is female. 6 Multiple names, some male and some female. 7 Multiple names, all male. 8 Multiple names, all female. 9 Multiple names, at least one ambiguous (but none unasigned). 0 Unassigned. DataRight IQ could not find any gender data for the name.
6
AP.Salute1–6
up to 60
Salutation for the person in the corresponding AP.Namex field.
Dear Mr. Smith
AP.Dual_Salut
up to 60
Salutation for AP.Dual_Name.
Dear Mr. and Mrs. Pesik
AP.Salute_Rec
up to 60
Salutation for all persons in the record.
Dear Mr. Smith and Mr. Jones
Address data
The output fields for address data are listed in address order, and not alphabetically.
DataRight IQ output fields: Address data Field name(s)
Length
Description
Example of data
AP.Address1–3 APU.Address1–3
up to 60
Address line. May be a street address, post office box, or rural address. Address1 is the first address line found by the parser as it worked its way up the address block. Note: DataRight IQ strips all punctuation from standardized (AP) address lines.
1234 W Main St, Apt 5 PO box 123
AP.City APU.City
13 to 28
Input data: LA CROSS Discrete city name. AP.City: La Crosse Note: The standardized (AP) city field may contain a APU.City: LA CROSS different city name than the input file (see AP.Last_Line for an example). Results depend upon your setting at the Non–Mailing Cities parameter in the Standardization/Assignment block.
AP.State APU.State
2 to 15
Discrete state data. AP.State contains the standard U.S. Postal Service abbreviation, though only if Standardize Last Line is turned on.
12
Quick Reference for Views and Job-File Products March 2011
Input data: Wisc AP.State: WI APU.State: Wisc
DataRight IQ output fields: Address data Field name(s)
Length
Description
Example of data
AP.Country APU.Country
up to 60
If the input database contains a separate field for coun- Canada try name, present the field to DataRight IQ as Country. DataRight IQ does not do anything with the data in this field except apply capitalization.
AP.ZIP APU.ZIP
5
5–digit ZIP Code. Note: DataRight IQ will not change or assign ZIP Code data unless the Standardize Last Line parameter in the Standardization/ Assignment Control block is set to Yes. ZIP Code data is also available from our ACE program. ACE is more reliable for ZIP Code assignment because it can verify data with the national ZIP+4 directory.
Input data: La Crosse WI 54600 AP.ZIP: 54601 APU.ZIP: 54600
AP.ZIP4 APU.ZIP4
4
Last 4 digits of ZIP+4 code. This field will be blank unless ZIP4 data was found in the input record. DataRight IQ does not assign ZIP4 codes. Note: If DataRight IQ assigns a new 5–digit ZIP Code, DataRight IQ automatically blanks out AP.ZIP4, because the original ZIP4 data may not be correct.
Input data: La Crosse WI 54601-4051 AP.ZIP4: 4051 APU.ZIP4: 4051
AP.Last_Line APU.Last_Line
up to 30
Combined city, state, and ZIP Code (and possibly ZIP4). Note: The example shows the fullest possible standardization. Results depend upon your settings in the Standardization/Assignment block, particularly the Non-Mailing Cities parameter and Standardize Last Line parameter.
Input data: Shelby, WISC. AP.Last_Line: La Crosse WI 54601 APU.Last_Line: Shelby, WISC.
AP.Prim_Addr APU.Prim_Addr
20 to 60
Primary address (street address).
Input data: 1000 VINE STREET WEST, APT. 123 AP.Prim_Addr: 1000 Vine Street West APU.Prim_Addr: 1000 VINE STREET WEST
AP.Prim_Range APU.Prim_Range
up to 10
Primary range (house number only).
Input data: 1000 VINE STREET WEST, APT. 123 AP.Prim_Range: 1000 APU.Prim_Range: 1000
AP.Sec_Addr APU.Sec_Addr
15 to 60
The complete secondary address (apartment or suite), including unit designator (such as Apt.) and unit number.
Input data: 1000 VINE STREET WEST, APT. 123 AP.Sec_Addr: Apt 123 APU.Sec_Addr: APT. 123
AP.Sec_Range APU.Sec_Range
up to 8
Secondary range (apartment or suite number only).
Input data: 1000 VINE STREET WEST, APT. 123 AP.Sec_Range: 123 APU.Sec_Range: 123
Chapter 1: DataRight IQ
13
DataRight IQ output fields: Address data Field name(s)
Length
Description
Example of data
AP.POBox_Line APU.POBox_Line
up to 18
Complete line for post office box.
Input data: P.O. BOX 12 AP.POBox_Line: PO box 12 APU.POBox_Line: P.O. BOX 12
AP.POBox APU.POBox
up to 11
Post-office box number.
Input data: P.O. Box 12 AP.POBox: 12 APU.POBox: 12
AP.RR_Line APU.RR_Line
up to 18
Complete line for rural-route or highway-contract addresses.
Input data: RR 2, BOX 59 AP.RR_Line: RR 2, Box 59 APU.RR_Line: RR 2, BOX 59
AP.RR APU.RR
up to 11
Rural-route or highway-contract number.
Input data: RR 2, Box 59 AP.RR: 2 APU.RR: 2
AP.RRBox APU.RRBox
up to 11
Box number for rural-route or highway-contract address.
Input data: RR 2, Box 59 AP.RRBox: 59 APU.RRBox: 59
AP.Urb APU.Urb
up to 60
Puerto Rican urbanization name.
Urb Radioville
Error, change, and quality codes
DataRight IQ output fields: Error, change, and quality codes Field name(s)
Length
Description
Example of data
AP.Name_Error
4
E101 if DataRight IQ did not parse any name data from the input record. Blank if any name data was found.
E101
AP.Firm_Error
4
E201 if DataRight IQ did not parse any company-name data from the input record. Blank if any company name data was found.
E201
AP.Addr_Error
4
E301 if DataRight IQ did not parse any address-line data from the input record. Blank if any address-line data was found.
E301
AP.LL_Error
4
Parsing error code for last-line data: E401 No last-line data was parsed from the record. E402 The last-line is either incomplete or not valid. E403 Foreign last line.
E402
AP.Name_Chng
8
A code indicating which name components DataRight IQ standardized during processing. For values and decoding instructions, see the DataRight IQ User’s Guide.
C0000004
14
Quick Reference for Views and Job-File Products March 2011
DataRight IQ output fields: Error, change, and quality codes Field name(s)
Length
Description
Example of data
AP.Firm_Chng
3
A code indicating which firm components DataRight IQ standardized during processing. For values and decoding instructions, see the DataRight IQ User’s Guide.
C01
AP.Addr_Chng
2
A code indicating whether DataRight IQ dropped any addressline data during processing: C0 DataRight IQ did not drop any address-line data. C1 DataRight IQ dropped address-line data*. * If DataRight IQ finds more than one street address line in a record, it keeps the first street address line found and drops any additional street address lines. The same concept also applies to multiple PO box addresses and multiple rural-route addresses.
C0
AP.LL_Chng
3
A code indicating which last-line components DataRight IQ changed (standardized) during processing. For values and decoding instructions, see the DataRight IQ User’s Guide.
C01
AP.Name_Qual
9
A code indicating which name components DataRight IQ found Q00023046 in the input data. For values and decoding instructions, see the DataRight IQ User’s Guide.
AP.Firm_Qual
3
A code indicating which firm components DataRight IQ found in the input data. For values and decoding instructions, see the DataRight IQ User’s Guide.
AP.Addr_Qual
3
A code indicating which address-line components DataRight IQ Q03 found in the input data. For values and decoding instructions, see the DataRight IQ User’s Guide.
AP.LL_Qual
2
A code indicating which last-line components DataRight IQ found in the input data. For values and decoding instructions, see the DataRight IQ User’s Guide.
Q01
C7
Status codes
DataRight IQ output fields: Status codes Field name(s)
Length
Description
Example of data
AP.Name_Stat
7
A 6-digit numeric status code prefixed with an “S.” Each numeric digit indicates the status of one AP.Namex field. The leftmost digit is for AP.Name1, the rightmost for AP.Name6: 0 AP.Namex is empty. 1 Gender of prename and first name agree. 2 Gender of prename and first name disagree. 3 Name has firm format (overrides all other codes).
S100000 This status code indicates that for AP.Name1 the gender of the prename and first name agree (1). AP.Name2–6 are empty (0).
AP.Dname_Stat
2
Status code for AP.Dual_Name: S0 AP.Dual_Name is empty. S1 AP.Dual_Name is populated.
S1
Chapter 1: DataRight IQ
15
DataRight IQ output fields: Status codes Field name(s)
Length
Description
Example of data
AP.Firm_Stat
3
A 2-digit numeric status code prefixed with an “S”. The leftmost digit indicates the status of AP.Firm1. The right-most digit indicates the status of AP.Firm2. 0 AP.Firmx is empty. 1 The data in AP.Firmx has a format typical of a firm name. 3 The data in AP.Firmx has a format typical of a person’s name.
S10 This status code indicates that the data in AP.Firm1 has a firmname format (1) and that AP.Firm2 is empty (0).
AP.Addr_Stat
4
A 3-digit numeric code prefixed with an “S”. Each numeric digit indicates the status of one AP.Addressx field. The leftmost digit is for AP.Address1, the second digit is for AP.Address2, the right-most digit is for AP.Address3. 0 AP.Addressx is empty. 1 AP.Addressx is populated.
S110 This status code indicates that data is present in AP.Address1 and AP.Address2 (1), and AP.Address3 is empty (0).
AP.LL_Stat
2
Status code for AP.Last_Line: S0 Apx.Last_Line is empty. S1 Apx.Last_Line is populated.
S1
Miscellaneous fields
DataRight IQ output fields: Miscellaneous fields Field name(s)
Length
Description
Example of data
AP.Bypass
1
T
T F
F
True if the record was bypassed during processing by meeting a certain condition in the bypass filter. False if the record was not bypassed during processing by meeting a certain condition in the bypass filter
AP.Date1–6
up to 60
Contains the parsed date.
1977-08-16
AP.Email1–6
up to 60
Contains the parsed e-mail address.
[email protected]
AP.EmailUser1–6
up to 80
Contains the user name from the parsed e-mail address.
joex
AP.EmailAllD1–6
up to 80
Contains the entire domain name, without the user name, from the parsed e-mail address (everything after the @ symbol).
university.rr.sci.rm.edu.uk
AP.EmailTopD1–6
up to 80
Contains the top level domain from the parsed e-mail address.
uk
AP.Email2ndD1–6
up to 80
Contains the second level domain from the parsed e-mail address.
edu
AP.Email3rdD1–6
up to 80
Contains the third level domain from the parsed e-mail address. rm
AP.Email4thD1–6
up to 80
Contains the fourth level domain from the parsed e-mail address.
AP.Email5thD1–6
up to 80
Contains the fifth level domain from the parsed e-mail address. rr
AP.EmailHost1–6
up to 80
Contains the host domain from the parsed e-mail address.
16
Quick Reference for Views and Job-File Products March 2011
scil
university
DataRight IQ output fields: Miscellaneous fields Field name(s)
Length
Description
Example of data
AP.EmailISP1–6
1
Contains a value indicating whether the domain of this email looked up in the ISP file.
T or F
AP.USPhone1–6
up to 60
Contains the parsed North American (U.S. and Canada) phone number.
(608)-555-1212
AP.USAreaCod1–6
3
Contains the area code from the parsed U.S. phone number.
608
AP.USPhonPre1–6
3
Contains the prefix from the parsed U.S. phone number.
555
AP.USPhonLin1–6
4
Contains the line number from the parsed U.S. phone number.
1212
AP.USPhonExt1–6
10
Contains the extension from the parsed U.S. phone number.
ext2500
AP.USPhoneTyp1–6
32
Contains the type of U.S. phone number.
business
AP.IntPhone1–6
up to 60
Contains the parsed international (non-North American) phone number.
011 44 4035 2170
AP.IntCtryCd1–6
4
Contains the country code from the parsed international phone number.
44
AP.IntCityCd1–6
up to 32
Contains the city code from the parsed international phonenum- 4035 ber.
AP.IntPhNum1–6
up to 32
Contains the line number from the parsed international phone number.
2170
AP.IntPhDesc1–6
up to 64
Contains the description from the parsed international phone number.
United Kingdom
AP.SSN1–6
up to 60
Contains the parsed U.S. Social Security number.
111-22-3333
AP.Pattern1–4
up to 60
Contains the parsed user-defined pattern.
PN160-345
AP.PatnLabel1–4
up to 80
Contains the text label from the user defined file that identifies the pattern matched.
AP.Patnsub1-4_1–5
up to 254
Up to 5 sub patterns that make up your pattern rule.
AP.Extra1–12
up to 60
25E-95C4 Excess data that could not be identified or sent to other AP fields. In general, excess data will be arranged in the same order that it appeared in the input record. DataRight IQ fills these fields from the top down (1 to 12).
AP.File_No
up to 3
Input file number, according to the sequence of Input File blocks in the job file.
1
AP.List_No
up to 3
List number, according to the sequence of Input List Description blocks in the job file. Identifies the list to which the record belongs.
1
AP.list_name
up to 60
The name of the output list that was defined.
Chapter 1: DataRight IQ
17
DataRight IQ output fields: Miscellaneous fields Field name(s)
Length
Description
Example of data
AP.Rec_No_Out
up to 10
Output record number, numbered separately for each output file. This field may be used in the Post to Output block only. The field will contain a zero if referenced from anywhere else. Note: If you append records to an existing output file, AP.Rec_No_Out reflects the record’s actual position in the file. For example, if the file has 100,000 existing records, AP.Rec_No_Out will contain 100,001 for the first record DataRight IQ appends to the file.
42568
AP.Record_No
up to 10
Record number from the input file.
127046
AP.Newline
1 to 2
on DOS, LF on UNIX. Use this as the end-of-record mark when posting to ASCII output files.
CRLF
Match standards for first and middle names
CRLF
APM fields contain match standards that can be used for Match/Consolidate processing.
DataRight IQ output fields: Match standards for first and middle names Field name
Length Description
APM.FirstName1–6 APM2–6.FirstName1–6
254
Match standards for AP.FirstName1–6. Match standards If AP.FirstName1 are intended for use in later match processing. DataRight contains Pat: IQ returns up to six match standards for each first name. APM.FirstName1: Patricia APM2.FirstName1: Patrick
APM.Mid_Name1–6 APM2–6.Mid_Name1–6
254
Match standards for AP.Mid_Name1–6. Match standards are intended for use in later match processing. DataRight IQ returns up to six match standards for each middle name.
18
Quick Reference for Views and Job-File Products March 2011
Example of data
If AP.Mid_Name1 contains Pat: APM.Mid_Name1: Patricia APM2.Mid_Name1: Patrick
Confidence scores for name, title, and firm data
DataRight IQ output fields: Confidence scores for name, title, and firm data Field name(s)
Length
Description
APC.NameDesig1–6 APC.Pre_Name1–6 APC.FirstName1–6 APC.Mid_Name1–6 APC.Last_Name1–6 APC.Mat_Post1–6 APC.Oth_Post1–6
3
Confidence scores for each of the parsed name components. A confidence score is a number from 1 to 100 indicating the confidence that the data was parsed correctly.
APC.Name1–6
3
Confidence scores for AP.Name1–6 and APU.Name1–6.
APC.Name_Line1–6
3
Confidence scores for AP.Name_Line1–6 and APU.Name_Line1–6.
APC.All_Names
Confidence scores for AP.All_Names and APU.All_Names.
APC.Dual_Name
3
Confidence score for AP.Dual_Name and APU.Dual_Name.
APC.Spec_Name
up to 60
Confidence scores for AP.Spec_Name and APU.Spec_Name.
APC.Title1–6
3
Confidence scores for AP.Title1–6 and APU.Title1–6.
APC.Firm1–2
3
Confidence scores for AP.Firm1–2 and APU.Firm1–2.
APC.Firm_Loc1–2
3
Confidence scores for AP.Firm_Loc1–2 and APU.Firm_Loc1–2.
APC.Firm_Line1–2
3
Confidence scores for AP.Firm_Line1–2 and APU.Firm_Line1–2.
APC.Record
3
Composite parsing-confidence score for all name, title, and firm data parsed from the record.
Chapter 1: DataRight IQ
19
20
Quick Reference for Views and Job-File Products March 2011
Chapter 2: ACE U.S.
This chapter contains input fields, output fields, status codes, and error codes for ACE U.S. Job and ACE U.S. Views. Input fields are listed by the type of input data. Output fields are listed in alphabetical order. When a field is grouped together with other like fields, the order is based on the first field in the list. For more information on setting up jobs with these products, see the ACE Job File Reference or the ACE Views online help.
Chapter 2: ACE U.S.
21
ACE U.S. input fields
ACE U.S. input fields Type of data
Field name
Length
Name (line)
PW.Name_Line
up to 60 ACE capitalizes name data. If you’re performing Mover ID processing, ACE can take PW.Name_Line as input.
Name (discrete name components)
PW.Pre_Name PW.First_Name PW.Mid_Name PW.Last_Name PW.Post_Name
up to 60 If you’re performing Mover ID NCOALink processing, ACE can take these discrete name components as input. You can achieve the best NCOALink matching results by using discrete name components.
Title
PW.Title
up to 60 ACE doesn’t do anything with Title data except capitalize it.
Firm
PW.Firm
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.
Street address
PW.Address PW.Unit
up to 60 If you store both the primary (street) address and the secondary address up to 60 (apartment or suite) in separate fields, then you should present your data to ACE through the Address and Unit fields. For example: Address = “1000 Main Street”, Unit = “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”).
PW.Urb
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
PW.City
State
PW.State
up to 60 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 2 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 below.
22
Description
Quick Reference for Views and Job-File Products March 2011
ACE U.S. input fields Type of data
Field name
Length
Description
ZIP Code
PW.ZIP
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.
PW.ZIP4
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 (+).
PW.ZIP10
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.
Country
PW.Country
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.
Multiline
PW.Line1–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 12 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.
Last line
PW.Last_Line
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 DEF file entry might be: Last_Line = DB.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, Last_Line = DB.City_State & DB.ZIP. You do not have to physically merge your fields. Note, with concatenated fields, ACE cannot apply automatic updating. You will have to manually post AP 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: Last_Line = DB.City & DB.State & DB.ZIP
Chapter 2: ACE U.S.
23
ACE U.S. input fields 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 can compare the codes it assigned with the codes you input. ACE Views and ACE Job, on their summary reports, give statistics about this. ACE Library and Transaction give you tools to create your own “before-and-after” statistics. PW.DPBC
2
DPBC means “delivery point bar code.” You’ll need this for Postnet barcodes on letter mail, for LOT sortation., and for Periodicals (unless you do a true walk sequence).
PW.Chk_Digit
1
Chk_Digit is short for “check digit.” Some label-printing 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.
PW.CART
4
CART means “carrier route.” You will need CART numbers if you intend to sort mail to carrier routes for a postage discount.
PW.LOT PW.LOT_Order
4 1
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, Enhanced Carrier-Route Subclass, or Periodicals (unless you do a true walk sequence).
County
PW.County
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.
Mark records for deletion
PW.Delete
1
When processing non-dBASE files, you can use the Delete field to signal ACE when a record is marked to be deleted (nondestructive). ACE checks the Delete field to determine if the record is marked to be deleted. If the first character is an asterisk (*), the record is treated as deleted. If the first character is anything else, the record is not considered deleted. You can control whether ACE processes deleted records through the Process Deleted Records option in the Input File section.
Other PW fields PW…
user-defined fields
24
user:fieldname
up to 60 ACE can accept a large number of other PW fields not listed here. Find a complete list in the Index. ACE doesn’t necessarily process or use those other fields, but they are handy in posting or filters when you are working with files that don’t use the same field names. You may define your own PW fields by using the prefix user: in your DEF file. For example, if you define “user:Status = DB.STATUS”, then you can work with Status as you would use any other PW field, in posting or filters. This is handy when you are working with files that don’t use the same field names.
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields Last-line components
ACE U.S. output fields: Last-line components Field name
Length
Description
AP.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 place-name option is set.
AP.City_Abbr
13
AP.City_LLIDX
13 to 28 AP.City_LLIDX yields a city name that is more geographically precise than AP.City. LLIDX (last-line index) is a USPS number that ties a ZIP+4 record to a particular city, state, and ZIP.
AP.City_Npref
13 to 28 Compare with AP.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 converted city name will be output through AP.City. The input city name—capitalized and with spelling corrected as necessary—will be output through AP.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 AP.City_Npref.
AP. 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 “Assign City From Input/ LL IDX” and “Non-Mailing Cities” options.
AP.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 Standardization Style parameter Non-Mailing Cities. Whether the ZIP+4 is included depends on how you set Multiline Style parameter Include ZIP+4. 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 “Assign City From Input / LL Idx (Y/N) = Y” parameter. If you have chosen to abbreviate the city name, the abbreviated city name appears in this output field. If a 13-character city abbreviation does not exist, the full city name is output to the Last_Line field.
AP.State
2
Standard USPS abbreviation for the state (AK, AL, AR, and so on)
AP.ZIP
5
Either the 5-digit ZIP assigned by ACE or, if ACE could not assign, then the ZIP found in the input record. 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.
AP.ZIP10
10
ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen.
AP.ZIP4
4
ZIP+4 add-on.
AP.ZIP9
9
ZIP and ZIP+4 add-on without hyphen.
AP.City_Abbr yields 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.
Chapter 2: ACE U.S.
25
Assigned address-line components
ACE U.S. output fields: Assigned address-line components Field name
Length
AP.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.
AP.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.
AP.Dual_Line
20 to 60 Complete, standardized address line, including primary and secondary, if available.
AP.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.
AP.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.
AP.Extraneous
28
Consists of the data from EXTRAN_SEC and EXTRAN_PMB respectively. Any additional # data is placed in the remainder or extra components.
AP.Np_Secaddr
20
Complete secondary non-postal address (PMB 10).
AP.Np_Srange
10
Non-postal secondary range (PMB number only, does not include designator).
AP.Np_Unit
up to 10 Non-postal unit designator (PMB).
AP.PO_Box
up to 9
Post-office box number.
AP.Postdir APL.Postdir
2 9
Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW). Postdirectional spelled out (North, Northeast, East, and so on).
AP.Predir APL.Predir
2 9
Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW). Predirectional spelled out (North, Northeast, East, and so on).
AP.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.
AP.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.
AP.Prim_Range
up to 10 Primary range (house number, such as “1000” in “1000 Vine Street”).
AP.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.
AP.RR_Box
up to 9
Rural-route box number.
AP.RR_Number
up to 9
Rural-route number.
AP.Sec_Addr
up to 60 Complete secondary address (for example, Apt 10, Set 500, Box 34, Am 7, 5th Flr).
AP.Sec_Range
up to 8
Secondary range (apt. or suite number only, does not include designator).
AP.Suffix APL.Suffix
4 10
Abbreviated suffix (St, Ave, Blvd, Rd, and so on). Suffix spelled out (Street, Avenue, Boulevard, and so on).
26
Description
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Assigned address-line components Field name
Length
AP.Unit_Desig
up to 10 Unit designator (#, Apt, Ste, and so on).
AP.Urb
up to 60 Urbanization name; produced only when the address is in Puerto Rico.
AP.USPS_Unit
up to 10 Unit designator from ZIP+4 directory, or blank if none was found.
Alias address-line components
Description
ACE produces the alias components whenever the input address is an undesirable alias. These components always give you the preferred alias, no matter how you set the Alias option. Alias components are also produced whenever the ZIP+4 directory lists a firm alternate or high-rise alternate for the input address. Refer to the ACE User’s Guide for background information and examples of aliases and alternates.
ACE U.S. output fields: Alias address-line components Field name
Length
Description
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.
APA.Postdir APAL.Postdir
2 9
Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW). Postdirectional spelled out (North, Northeast, East, and so on).
APA.Predir APAL.Predir
2 9
Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW). Predirectional spelled out (North, Northeast, East, and so on).
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.
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 base-data patterns.
APA.Prim_Range
up to 10 Primary range (house number, such as “1000” in “1000 Vine Street”) for the alternate address.
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.
APA.Sec_Range
up to 8
Secondary range (apt. or suite number only, does not include designator).
APA.Suffix APAL.Suffix
4 10
Abbreviated suffix (St, Ave, Blvd, Rd, and so on). Suffix spelled out (Street, Avenue, Boulevard, and so on).
Chapter 2: ACE U.S.
27
ACE U.S. output fields: Alias address-line components Field name
Length
Description
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.
APA.Unit_Desig
up to 10 Unit designator (#, Apt, Ste, and so on) for the alternate address.
Dual address-line components
ACE U.S. output fields: Dual address-line components Field name
Length
APD.Address
20 to 60 Complete, standardized address line, including primary and secondary, if available.
APD.Extran_PMB
14
Extraneous data in this field is the best guess at Private Mail Box data, based on position in the address line and other information contained in the address.
APD.Extran_Sec
14
Extraneous data in this field is our best guess at secondary range data, based on position in the address line and other information contained in the address.
APD.Extraneous
28
Consists of the data from EXTRAN_SEC and EXTRAN_PMB respectively. Any additional # data is placed in the remainder or extra components.
APD.PO_Box
up to 9
Post-office box number for the dual address.
APD.Postdir APDL.Postdir
2 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.
APD.Predir APDL.Predir
2 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.
APD.Prim_Addr
up to 60 Standardized primary address.
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 basedata patterns.
APD.Prim_Range
up to 10 Primary range (house number, such as “1000” in “1000 Vine Street”) of the dual address.
28
Description
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Dual address-line components Field name
Length
Description
APD.Rec_Type
1
When a dual address is identified but not assigned, ACE will provide an addresstype indication based on the way that the input data was parsed. This is not guarantee. ACE may indicate that a street, rural route, highway contract, 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.
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.
APD.RR_Box
up to 9
Rural-route box number for the dual address.
APD.RR_Number
up to 9
Rural-route number for the dual address.
APD.Sec_Addr
up to 60 Standardized secondary address (for example, “Apt 210” or “Ste 300”).
APD.Sec_Range
up to 8
Secondary range (apartment or suite number only, does not include designator) of the dual address.
APD.Suffix APDL.Suffix
4 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.
APD.Unit_Desig
up to 10 Unit designator (#, Apt, Ste, and so on) of the dual address.
APD.Urb
up to 60 Urbanization name; produced only when the address lies in Puerto Rico.
Chapter 2: ACE U.S.
29
Components available for multiline input
ACE U.S. output fields: Components available for multiline input Field name
Length
Description
AP.Extra1-10
up to 60 The “Extra” fields contain whatever non address data ACE can find above the address data. The first Extra field populated is AP.Extra10, then AP.Extra9, and so on. For example: Input record
Output record
Line1 = John Dough Line2 = American Bakery Supply Line3 = 308 2nd Ave #152 Line4 = Ames IA 50014 Line5 = Line6 =
Extra7 = Extra 8 = Extra9 = John Dough Extra10 = American Bakery Supply Address = 308 2nd Ave Ste 152 City = Ames State = IA ZIP = 50014
The “Extra” fields were added before DataRight was available. If you want to convert multiline address blocks into discrete fields, use DataRight. They are much better at name, title, and firm parsing. AP.Std_Line1-12
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 greater 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 field. If a 13-character city abbreviation does not exist, the full city name is output to the Last_Line field. If using multiline, this component will contain the USPS street abbreviation if that option is enabled.
Postal codes
ACE U.S. output fields: Postal codes Field name
Length
Description
AP.CART
4
Carrier-route number (for example, CØØ1, RØØ1, and so on).
AP.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.
AP.LOT
4
Line-of-Travel number
30
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Postal codes Field name
Length
Description
AP.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.
AP.Chk_Digit
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.
AP.DPBC
2
Numeric 2-digit code for delivery-point barcode. Also used in LOT sortation (see LOT above). Blank when ZIP+4 could not be assigned.
AP.ZIP
5
Either the 5-digit ZIP assigned by ACE or, if ACE could not assign, then the ZIP found in the input record. 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.
AP.ZIP10
10
ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen.
AP.ZIP4
4
ZIP+4 add-on.
AP.ZIP9
9
ZIP and ZIP+4 add-on without hyphen.
Codes that describe the address and assignment results
ACE U.S. output fields: Codes that describe the address and assignment results Field name
Length
Description
AP.CASSrectyp
1
This component posts the record type necessary for posting on the CASS test. 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
AP.Err_Stat
6
Error code, if address is unassigned; or status code, if assigned.
AP.Error_Code
6
Error code, if address is unassigned; or blank, if assigned.
Chapter 2: ACE U.S.
31
ACE U.S. output fields: Codes that describe the address and assignment results Field name
Length
Description
AP.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.
AP.Foreign
1
Foreign address flag: F for foreign addresses, blank for domestic U.S.
AP.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.
AP.Match_5
1
T F
AP.Match_9
1
T Address line was matched to a ZIP+4 record. F Address line was not matched to a ZIP+4 record. 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”. Note: 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.
AP.Match_Un
1
T
F AP.NC_Firm
Last line was matched to a City/ZCF record. Last line was not matched to a City/ZCF record.
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. 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.
Up to 60
The firm match that was made using the input ZIP+4 for missing or invalid firm information.
AP.NC_Secaddr Up to 60
The secondary address match that was made using the input ZIP+4 for missing or invalid secondary address information.
AP.NC_Srange
Up to 8
The secondary range match that was made using the input ZIP+4 for missing or invalid secondary range information.
AP.NC_Unit
Up to 10
The unit designator match that was made using the input ZIP+4 for missing or invalid unit designator information.
32
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Codes that describe the address and assignment results Field name
Length
Description
AP.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 address-type 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.
AP.Stat_Code
6
Status code (whether assigned or not). The sixth character returned for this field is currently unused and will be blank.
AP.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.
AP.ZIP_Type
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.
Chapter 2: ACE U.S.
33
ACE U.S. output fields: Codes that describe the address and assignment results Field name
Length
Description
DPV codes: Codes that describe the address and assignment results for Delivery Point Validation (DPV is a for sale option)
AP.DPV_CMRA 1
Y N L blank
AP.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.
AP.DPV_NoStat
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.
34
The address is a valid Commercial Mail Receiving Agency. The address is not a Commercial Mail Receiving Agency. The address triggered DPV locking. This component is blank when the DPV mode is not set to VALIDATE or BOTH, DPV processing is currently locked, or ACE cannot assign the input address.
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Codes that describe the address and assignment results Field name
Length
Description
AP.DPV_Status
1
The following values are available for AP.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 parsed secondary range (including extran_sec # sign data) 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 field is blank when the DPV mode is not enabled, DPV processing is currently locked, or ACE cannot assign the input address.
AP.DPV_Vacant
1
Vacant address indicator. Y Address is vacant. N Address is not vacant. blank Address was not looked up
AP.DSF_Tback
1
Throwback indicator. Y Customer with street address wants delivery at PO Box instead. N No throwback necessary. blank Address was not looked up.
AP.DSF_Season
1
Seasonal address indicator. Y Address is seasonally occupied. N Address is not seasonal. blank Address was not looked up.
AP.DSF_Busind
1
Residential/business indicator. You may use this information to lower your parcel-shipping costs. (Some parcel delivery services charge more for delivery to residential addresses.) Y Business address. N Not a business address. blank Address was not looked up.
AP.DSF_Rectyp
1
Record type. B Business address. R Residential address. U Unknown. AP.DSF_Deltype is blank. blank No information available.
AP.DSF_Deltyp
1
Delivery type. 1 Curb-side delivery. 2 NDCBU (Neighborhood Delivery Centralized Box Unit) delivery. 3 Central delivery. 4 Door-slot delivery. blank Address was not looked up.
Chapter 2: ACE U.S.
35
ACE U.S. output fields: Codes that describe the address and assignment results Field name
Length
Description
AP.DSF_Dropin
1
Drop indicator. Y Delivery point serves multiple businesses or families. For example, delivery point may be a CMRA (Commercial Mail Receiving Agency). N Delivery address is not a CMRA. blank Address was not looked up.
AP.DSF_Dropct
3
Drop count. If AP.DSF_Dropin or APM.DSF_Dropin contains Y or AP.DPV_CMRA contains Y, then this field contains a value from 000 to 999, indicating the number of businesses or families served by this delivery point.
AP.DSF_Edu
1
Educational indicator. Y Address is an educational institution. N Address is not an educational institution. blank Address was not looked up.
AP.DSF_LACS
1
LACS (Locatable Address Conversion System) indicator. Y Address is LACS convertible. N Address is not LACS convertible. blank Address was not looked up.
AP.Walk_Seq
4
Walk Sequence number. Contains sequence number 0000-9999. If you perform NCOALink and DSF2 processing at the same time, the assigned sequence number is based on the move-updated address if one exists. If no move-updated address exists, then the assigned sequence is based on the original address.
AP.DSF_Seqsrc
1
DSF sequence source. Indicates which address is the basis for the assigned walk sequence (AP.Walk_Seq). O Original address. M Move-updated address (available if you’re performing NCOALink processing also).
36
Quick Reference for Views and Job-File Products March 2011
Other useful codes
ACE U.S. output fields: Other useful codes Field name
Length
Description
AP.CASS_Match
1
Use this field to indicate which option was used to make the assignment. 0 The Non-CASS and DPV tie break options are disabled or were not used to make an assignment. 1 Inexact ZIP move assignment. 2 Input ZIP+4 assignment. 3 DPV tie-breaking was used to make this assignment. blank ACE could not assign an input address.
AP.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 that 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.
AP.County
3
FIPS county code. Numbers are unique within states. (FIPS stands for Federal Information Processing Standard.)
AP.CountyName
25
Fully spelled county name (for example, “La Crosse” instead of Ø63).
AP.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)
K
Network Distribution Center (NDC)
B
Branch Office
M
Money Order Unit
C
Community Post Office (CPO)
N
City place name, invalid for mailing
D
Area Distribution Center (ADC)
P
Post Office (main)
E
Sectional Center Facility (SCF)
S
Station
F
Delivery Distribution
U
Urbanization (Puerto Rico only)
G
General Mail Facility (GMF)
Chapter 2: ACE U.S.
37
ACE U.S. output fields: Other useful codes Field name
Length
Description
AP.FIPSCODE
5
Federal code for state and county. Uniquely identifies a county within the nation. Combines a 2-digit state number 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
16 Idaho
29 Missouri
42 Pennsylvania
blank territories, possessions, and protectorates
Notes: 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 Islands, or the Pacific islands. AP.Firm
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.
AP.Newline
1 or 2
on DOS and Windows, LF on UNIX. For posting to ASCII output files as an end-of-record mark. The output field should be named EOR.
AP.Qss_Dflt
1
Indicates whether the record qualified as a default match rather than qualifying as a match at higher level of assignment.
AP.RDI
1
The residential delivery indicator (RDI) that tells if the address is residential or nonresidential. Y Residential address N Nonresidential address RDI is an add-on feature.
38
C L
R F
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Other useful codes Field name
Length
Description
AP.Rec_No_Out
up to 10 The record number of a record as it is written to an output file. You may post it to an output file or to an Error Report in the Custom format. Note: If you create a Standardization Report in a Custom format, do not post this component. An output record number means nothing on a Standardization Report, because that report ignores your output file setup.
AP.Record_No
up to 10 The record number of a record as it was read from the input file. It is a true record number and is not affected by your job setup, input filter, and so on You may post it to output files, to give yourself an audit trail between input and output records. Or you may use it when preparing an Error or Standardization report in the Custom format.
Geocensus codes
The Geocensus codes are listed by option.
ACE U.S. output fields: Geocensus codes Option
Length
Description
Address-Level AP.Ageo_Lat
10
Latitude (degrees north of the Equator) in the format: +12.123456 Longitude (degrees east of the Greenwich Meridian) in the format: +12.123456
AP.Ageo_Lng
11
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).
AP.Ageo_Sta
2
FIPS state code.
AP.Ageo_Cty
3
FIPS county code.
AP.Ageo_Pla
5
FIPS place code. A number assigned by the U.S. government to each incorporated municipality (city, village, town, etc.).
AP.Ageo_Blk
10
U.S. Census tract and Block Numbering Area (BNA).
AP.Ageo_MCD
6
U.S. Census Bureau minor civil division (MCD) data or, if MCD data is unavailable, census county division (CCD) data.
AP.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.
Centroid
Field name
Chapter 2: ACE U.S.
39
ACE U.S. output fields: Geocensus codes Option
Centroid
Field name
Length
Description
AP.Cgeo_Lat
10
Latitude (degrees north of the Equator) in the format: +12.123456 Longitude (degrees east of the Greenwich Meridian) in the format: +12.123456
AP.Cgeo_Lng
11
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).
AP.Cgeo_Msa
4
Metropolitan Statistical Area (MSA) number. 0000 indicates the address does not lie in any MSA; usually a rural area.
AP.Cgeo_Blk
10
U.S. Census tract and block-group number. The first 6 digits are the tract number, and the first of the final four digits are the block-group number within the tract. 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.
AP.Cgeo_Match
Both Address- AP.Geo_Match Level and Centroid
40
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. 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.
Quick Reference for Views and Job-File Products March 2011
Mover ID components for NCOALink
The fields listed below are for use only during NCOALink audit testing. The USPS requires them and dictates their content and length.
Audit components
ACE U.S. output fields: Mover ID components for NCOALink Audit components Field name
Length
Description
AP.Aud_Pname
up to 28 This is the primary name that was sent to NCOALink for matching. This field is required for audits.
AP.Aud_Range
up to 10 This is the range that was sent to NCOALink for matching. This field is required for audits.
AP.Aud_Srange
up to 10 This is the secondary range that was sent to NCOALink for matching. This field is required for audits.
AP.Aud_Unit
up to 8
This is the unit data that was sent to NCOALink for matching. This field is required for audits.
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 (Attempted Not Known) return codes.
APM.Aud_Mid
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.
APM.Aud_Pname
up to 28 This is the primary name according to the NCOALink move record. This field is required for audits.
APM.Aud_Range
up to 10 This is the range data according to the NCOALink move record. This field is required for audits.
APM.Aud_Srange
up to 10 This is the secondary range according to the NCOALink move record. This field is required for audits.
APM.Aud_Unit
up to 8
This is the unit data according to the NCOALink move record. This field is required for audits.
APM.Drop
1
This field is used for audit testing. This field is also populated when an ANKLink match is made.
APM.Drop_N
1
This field is used for audit testing. This field is also populated when an ANKLink match is made.
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.
APM.Gender
1
This field is used for audit testing. This field is also populated when an ANKLink match is made.
APM.Hint_byte
8
This field is used for audit testing.
Chapter 2: ACE U.S.
41
ACE U.S. output fields: Mover ID components for NCOALink Audit components Field name
Length
Description
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
APM.Pre_Name APM.First_Name APM.Mid_Name APM.Last_Name APM.Post_Name
6 15 15 20 6
These fields contain the name data used to make an NCOALink match. 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.
42
Quick Reference for Views and Job-File Products March 2011
NCOALink data
The output components listed below contain data exactly as it appears in the NCOALink directories.
ACE U.S. output fields: Mover ID components for NCOALink data Field name
Length
Description
Address-line components
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.
APM.Postdir
2
Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW). Long form not available.
APM.Predir
2
Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW). Long form not available.
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.
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.
APM.Prim_Range up to 10 Primary range (house number, such as “1000” for the address “1000 Vine Street”). APM.Sec_Addr
up to 60 Complete secondary address (for example, Apt 10, Ste 500, Box 34, Rm 7, 5th Flr).
APM.Sec_Range
up to 8
Secondary range (apt. or suite number only, does not include designator).
APM.Suffix
4
Abbreviated suffix (St, Ave, Blvd, Rd, and so on). Long form not available.
APM.Unit_Desig
up to 10 Unit designator (#, Apt, Ste, and so on).
APM.Urb
up to 60 Urbanization name; produced only when the address is in Puerto Rico.
Last-line components
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 will always yield a converted city name, no matter how the place-name option is set.
APM.Last_Line
28 to 43 Complete, standardized last line, including city, state, ZIP, and ZIP+4.
APM.State
2
Standard USPS abbreviation for the state (AK, AL, and so on) for the new address.
APM.ZIP
5
Either the 5-digit ZIP assigned by ACE or, if ACE could not assign, then the ZIP found in the move record.
APM.ZIP10
10
ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen.
APM.ZIP4
4
ZIP+4 add-on.
APM.ZIP9
9
ZIP and ZIP+4 add-on without hyphen.
APM.CART
4
Carrier-route number (for example, C001, R001, and so on).
APM.Chk_Digit
1
Check digit for the Postnet barcode.
APM.DPBC
2
Numeric 2-digit code for delivery-point barcode.
APM.LOT
4
Line-of-Travel number.
Postal codes
Chapter 2: ACE U.S.
43
ACE U.S. output fields: Mover ID components for NCOALink data Field name
Length
Description
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.
Move information
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. Note: 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. Here is the 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 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.
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.
APM.RetCode
2
This field shows NCOALink return codes. To populate this field, you must set the Mode parameter to Retcode or COA. For a complete list of return codes and their meanings, see the NCOALink documentation available at http://ribbs.usps.gov/. A brief description of the return codes also appears on the Mover ID Summary report. This field is also populated when an ANKLink match is made.
44
Quick Reference for Views and Job-File Products March 2011
Additional components ACE assigns to the move record returned from NCOALink
ACE looks up the address returned from NCOALink only to assign additional postal and other codes, which are listed below. If ACE is unable to match the record returned from NCOALink to the National directories, ACE will leave these fields blank. Add-on options: The GeoCensus, RDI, and DPV fields are available to you only if you own those options. Contact Business Objects at 800-831-6245 or
[email protected] for details. .
ACE U.S. output fields: Mover ID components for NCOALink postal and other codes Field name
Length
Description
Address-line components
APM.Aline
up to 60 Complete address line: Primary, secondary, and urbanization. This component will contain the USPS street abbreviation if that option is enabled.
APM.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.
APM.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.
APM.Extraneous
28
Consists of the data from EXTRAN_SEC and EXTRAN_PMB respectively. Any additional # data is placed in the remainder or extra components.
APM.Np_Secaddr
20
Complete secondary non-postal address (PMB 10).
APM.Np_Srange
10
Non-postal secondary range (PMB number only, does not include designator).
APM.Np_Unit
up to 10 Non-postal unit designator (PMB).
APM.PO_Box
up to 9
Post-office box number (box number only, such as 333 for address PO box 333).
APM.RR_Box
up to 9
Rural-route box number (box number only, such as 22 for address Rural Route 1 Box 22).
APM.RR_Number
up to 9
Rural-route number (route number only, such as 1 for address Rural Route 1 Box 22).
APM.USPS_Unit
up to 10 Unit designator from ZIP+4 directory, or blank if none was found.
Last-line components
APM.City_Abbr
13
AP.City_Abbr yields 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.
APM.City_LLIDX
13 to 28 AP.City_LLIDX yields a city name that is more geographically precise than AP.City. LLIDX (last-line index) is a USPS number that ties a ZIP+4 record to a particular city, state, and ZIP.
APM.City_Npref
13 to 28 When the input city is not the right city name for the address line, CASS rules require that the city name be converted based on the last-line index. The converted city name will be output through APM.City. The input city name—capitalized and with spelling corrected as necessary—will be output through APM.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 APM.City_Npref.
APM.City_Place
13 to 28 Standardized city name; city names invalid for mailing are always preserved, never converted, no matter how the place-name option is set.
Chapter 2: ACE U.S.
45
ACE U.S. output fields: Mover ID components for NCOALink postal and other codes Field name
Length
Description
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.
Postal codes
APM.CR_Sort_Zn
Codes that describe the address and assignment results
APM.CASS_Match 1
Use this field to indicate which option was used to make the assignment. 0 The Non-CASS and DPV tie break options are disabled or were not used to make an assignment. 1 Inexact ZIP move assignment. 2 Input ZIP+4 assignment. 3 DPV tie-breaking was used to make this assignment. blank ACE could not assign an input address.
APM.CASSrectyp
1
The record type is necessary for posting on the CASS test. It is populated only for assigned records, and the valid record types are: F Firm G General delivery H High-rise P PO box R Rural route or hwy contract S Street
APM.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 that 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.
APM.County
3
FIPS county code. Numbers are unique within states. (FIPS stands for Federal Information Processing Standard.)
APM.CountyName
25
Fully spelled county name (for example, “La Crosse” instead of Ø63).
APM.Err_Stat
6
Error code, if address is unassigned; or status code, if assigned.
46
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Mover ID components for NCOALink postal and other codes Field name
Length
Description
APM.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.
APM.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)
K
Network Distribution Center (NDC)
B
Branch Office
M
Money Order Unit
C
Community Post Office (CPO)
N
City place name, invalid for mailing
D
Area Distribution Center (ADC)
P
Post Office (main)
E
Sectional Center Facility (SCF)
S
Station
F
Delivery Distribution
U
Urbanization J (Puerto Rico only)
G
General Mail Facility (GMF
APM.Foreign
1
Foreign address flag: F for foreign addresses, blank for domestic U.S.
APM.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.
APM.Match_5
1
T Last line was matched to a City/ZCF record. F Last line was not matched to a City/ZCF record.
APM.Match_9
1
T Address line was matched to a ZIP+4 record. F Address line was not matched to a ZIP+4 record. 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”. Note: 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.
APM.Match_Un
1
T F
The address is tagged by the USPS as unsuitable for mail delivery (for example, a cemetery)—exactly the same meaning as error code E600. 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.
Chapter 2: ACE U.S.
47
ACE U.S. output fields: Mover ID components for NCOALink postal and other codes Field name
Length
Description
APM.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 if given more or better firm data. 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 address-type 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. It will not indicate firm, high-rise, or other types.
APM.Stat_Code
6
Status code (whether assigned or not). The sixth character returned for this field is currently unused and will be blank.
APM.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.
APM.ZIP_Type
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.
48
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Mover ID components for NCOALink postal and other codes Field name
Length
Description
Components for add-on options The GeoCensus, RDI, and DPV fields are available to you only if you own those options. Contact Business Objects at 800-831-6245 or
[email protected] for details.
APM.Ageo_Lat APM.Ageo_Lng
10 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).
APM.Ageo_Sta
2
FIPS state code.
APM.Ageo_Cty
3
FIPS county code.
APM.Ageo_Pla
5
FIPS place code. A number assigned by the U.S. government to each incorporated municipality (city, village, town, etc.).
APM.Ageo_Blk
7
U.S. Census tract and BNA, in the format: 123456
APM.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.
APM.Cgeo_Lat
10
Latitude (degrees north of the Equator) in the format: +12.123456 Longitude (degrees east of the Greenwich Meridian) in the format: +12.123456
APM.Cgeo_Lng
11
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).
APM.Cgeo_Msa
4
Metropolitan Statistical Area (MSA) number. 0000 indicates the address does not lie in any MSA; usually a rural area.
APM.Cgeo_Blk
7
U.S. Census tract and block-group number. The first 6 digits are the tract number, and the final digit is the block-group number within the tract. 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.
APM.Cgeo_Match
1
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.
Chapter 2: ACE U.S.
49
ACE U.S. output fields: Mover ID components for NCOALink postal and other codes Field name
Length
Description
APM.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.
APM.DPV_CMRA
1
Y N L blank
The address is a valid Commercial Mail Receiving Agency (CMRA). The address is not a CMRA. This address triggered DPV locking. See “Delivery Point Validation Alert” in the Job Summary. This field is blank DPV processing is currently locked, or ACE can’t assign the input address.
APM.DPV_Ftnote
12
DPV footnotes are required for end-user CASS certification. They contain the following details about your data: AA Input address matches directory data. A1 Input address does not match directory data. BB All input address fields match DPV. CC Input address primary number matches DPV, but the secondary number does not match. The secondary is present but invalid. F1 Input address matches a military address. G1 Input address matches a general delivery address. M1 Input address lacks a primary number. M3 Input address primary number is invalid. N1 Input address primary number matches DPV, but the high-rise address lacks a secondary number. NL An NCOALink move address cannot be DPV confirmed. A return code of NL means that the NCOALink directory data does not exactly match the DPV directory data. This may happen because the NCOALink directories are updated more frequently than the DPV directories. P1 Input address lacks a PO, RR, or HC Box number. RR Input address matches to CMRA. R1 Input address matches to CMRA, but the secondary number is not present. U1 Input address matches a unique address.
APM.DPV_NoStat
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.
50
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Mover ID components for NCOALink postal and other codes Field name
Length
Description
APM.DPV_Status
1
DPV Status tells you the following about your data: 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 parsed 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. See “Delivery Point Validation Alert” in the Job Summary. blank This field is blank when the DPV mode is not enabled, DPV processing is currently locked, or ACE cannot assign the input address.
APM.DPV_Vacant
1
Vacant address indicator. Y Address is vacant. N Address is not vacant. blank Address was not looked up
APM.DSF_Tback
1
Throwback indicator. Y Customer with street address wants delivery at PO Box instead. N No throwback necessary. blank Address was not looked up.
APM.DSF_Season
1
Seasonal address indicator. Y Address is seasonally occupied. N Address is not seasonal. blank Address was not looked up.
APM.DSF_Busind
1
Residential/business indicator. You may use this information to lower your parcel-shipping costs. (Some parcel delivery services charge more for delivery to residential addresses.) Y Business address. N Not a business address. blank Address was not looked up.
APM.DSF_Rectyp
1
Record type. B Business address. R Residential address. U Unknown. AP.DSF_Deltype is blank. blank No information available.
APM.DSF_Deltyp
1
Delivery type. 1 Curb-side delivery. 2 NDCBU (Neighborhood Delivery Centralized Box Unit) delivery. 3 Central delivery. 4 Door-slot delivery. blank Address was not looked up.
Chapter 2: ACE U.S.
51
ACE U.S. output fields: Mover ID components for NCOALink postal and other codes Field name
Length
Description
APM.DSF_Dropin
1
Drop indicator. Y Delivery point serves multiple businesses or families. For example, delivery point may be a CMRA (Commercial Mail Receiving Agency). N Delivery address is not a CMRA. blank Address was not looked up.
APM.DSF_Dropct
3
Drop count. If AP.DSF_Dropin or APM.DSF_Dropin contains Y or AP.DPV_CMRA contains Y, then this field contains a value from 000 to 999, indicating the number of businesses or families served by this delivery point.
APM.DSF_Edu
1
Educational indicator. Y Address is an educational institution. N Address is not an educational institution. blank Address was not looked up.
APM.DSF_LACS
1
LACS (Locatable Address Conversion System) indicator. Y Address is LACS convertible. N Address is not LACS convertible. blank Address was not looked up.
APM.RDI
1
The residential delivery indicator (RDI) shows if the address is residential or nonresidential. Y Residential address N Nonresidential address
APM.TaxIQ
9
The proprietary identifier that Vertex® Sales and Use Tax Software requires to determine tax jurisdictions.
52
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Mover ID components for NCOALink postal and other codes Field name
Length
Description
Other useful codes
APM.FIPSCODE
5
Federal code for state and county. Uniquely identifies a county within the nation. Combines a 2-digit state number 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
16 Idaho
29 Missouri
42 Pennsylvania
blank territories, possessions, and protectorates
Notes: 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 Islands, or the Pacific islands. APM.Newline
1 or 2
on DOS and Windows, LF on UNIX. For posting to ASCII output files as an end-ofrecord mark. The output field should be named EOR.
APM.Qss_Dflt
1
Indicates whether the record qualified as a default match rather than qualifying as a match at higher level of assignment.
APM.Rec_No_Out
up to 10 The record number of a record as it is written to an output file. You may post it to an output file or to an Error Report in the Custom format. Note: If you create a Standardization Report in a Custom format, do not post this component. An output record number means nothing on a Standardization Report, because that report ignores your output file setup.
APM.Record_No
up to 10 The record number of a record as it was read from the input file. It is a true record number and is not affected by your job setup, input filter, and so on You may post it to output files, to give yourself an audit trail between input and output records. Or you may use it when preparing an Error or Standardization report in the Custom format.
C L
R F
Chapter 2: ACE U.S.
53
Output codes for USPS LACSLink
LACSLink is a USPS service that updates rural-route addresses to street-name addresses. These “911” conversions make it easier for police, fire, ambulance, and postal personnel to locate a rural address. LACSLink also converts addresses when streets are renamed or post office boxes renumbered. LACSLink uses the same USPS “Link” technology that NCOALink uses. This technology ensures that the data remains private and secure, and at the same time gives you easy access to the data. LACSLink replaces the USPS’s Locatable Address Conversion System (LACS). The USPS requires all NCOALink full service providers to offer LACSLink processing, but full service providers do not have to run LACSLink at all times. LACSLink is optional for other users, including NCOALink limited service providers and NCOALink end users.
ACE U.S. output fields: LACSLink fields Field name
Length
Description
AP.LACSL_Ind
1
Returns the conversion status of addresses processed by LACSLink. 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.
AP.LACSL_Qry
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.
AP.LACSL_Ret
2
Returns the match status for LACSLink processing: 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.
Output components for ANKLink
54
The following table contains output components for ANKLink information.
Quick Reference for Views and Job-File Products March 2011
U.S. ACE output fields: ANKLink output components Field name
Length
Description
APM.ANKL_Ret
2
ANKLink return code. Valid values are: 77 An ANKLink match was found. If 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.
SuiteLink output fields
The following table contains output components for SuiteLink information.
ACE U.S. output fields: SuiteLink fields Field name
Length
Description
AP.SteLink_RC
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.
AP.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.
AP.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.
AP.PreSL_DPBC
2
The numeric 2-digit code for the delivery point barcode that was generated before SuiteLink processing.
AP.PreSL_SecR
up to 8
The secondary range information that existed before SuiteLink processing. If this is blank, ACE did not assign any secondary information.
AP.PreSL_Unit
up to 10
The unit designator that existed before SuiteLink processing. If this is blank, ACE did not assign any secondary information.
AP.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.
Chapter 2: ACE U.S.
55
Output fields for ACE Pre-LACSLink fields (APPL)
Pre-LACSLink application component, or “APPL” fields are used to retain address components that were replaced with LACSLink address information.
Last-line components
ACE U.S. output fields: Last-line components Field name
Length
APPL.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 place-name option is set.
APPL.City_Abbr
13
APPL.City_LLIDX
13 to 28 APPL.City_LLIDX yields a city name that is more geographically precise than APPL.City. LLIDX (last-line index) is a USPS number that ties a ZIP+4 record to a particular city, state, and ZIP.
APPL.City_Npref
13 to 28 Compare with APPL.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 converted city name will be output through APPL.City. The input city name—capitalized and with spelling corrected as necessary—will be output through APPL.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 APPL.City_Npref.
APPL.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 “Assign City From Input/ LL IDX” and “NonMailing Cities” options.
APPL.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 Standardization Style parameter Non-Mailing Cities. Whether the ZIP+4 is included depends on how you set Multiline Style parameter Include ZIP+4. 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 “Assign City From Input / LL Idx (Y/N) = Y” parameter. This component will contain the USPS street abbreviation if that option is enabled.
APPL.State
2
Standard USPS abbreviation for the state (AK, AL, AR, and so on)
APPL.ZIP
5
Either the 5-digit ZIP assigned by ACE or, if ACE could not assign, then the ZIP found in the input record. 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.
APPL.ZIP10
10
ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen.
APPL.ZIP4
4
ZIP+4 add-on.
APPL.ZIP9
9
ZIP and ZIP+4 add-on without hyphen.
56
Description
APPL.City_Abbr yields 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.
Quick Reference for Views and Job-File Products March 2011
Assigned address-line components
ACE U.S. output fields: Assigned address-line components Field name
Length
Description
APPL.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.
APPL.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.
APPL.Dual_Line
20 to 60 Complete, standardized address line, including primary and secondary, if available.
APPL.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.
APPL.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.
APPL.Extraneous
28
Consists of the data from EXTRAN_SEC and EXTRAN_PMB respectively. Any additional # data is placed in the remainder or extra components.
APPL.Np_Secaddr
20
Complete secondary non-postal address (PMB 10).
APPL.Np_Srange
10
Non-postal secondary range (PMB number only, does not include designator).
APPL.Np_Unit
up to 10 Non-postal unit designator (PMB).
APPL.PO_Box
up to 9
Post-office box number.
APPL.Postdir APL.Postdir
2 9
Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW). Postdirectional spelled out (North, Northeast, East, and so on).
APPL.Predir APL.Predir
2 9
Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW). Predirectional spelled out (North, Northeast, East, and so on).
APPL.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.
APPL.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.
APPL.Prim_Range
up to 10 Primary range (house number, such as “1000” in “1000 Vine Street”).
APPL.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.
APPL.RR_Box
up to 9
Rural-route box number.
APPL.RR_Number
up to 9
Rural-route number.
APPL.Sec_Addr
up to 60 Complete secondary address (for example, Apt 10, Set 500, Box 34, Am 7, 5th Flr).
APPL.Sec_Range
up to 8
Secondary range (apt. or suite number only, does not include designator).
APPL.Suffix
4
Abbreviated suffix (St, Ave, Blvd, Rd, and so on).
Chapter 2: ACE U.S.
57
ACE U.S. output fields: Assigned address-line components Field name
Length
Description
APPL.Unit_Desig
up to 10 Unit designator (#, Apt, Ste, and so on).
APPL.Urb
up to 60 Urbanization name; produced only when the address is in Puerto Rico.
APPL.USPS_Unit
up to 10 Unit designator from ZIP+4 directory, or blank if none was found.
Components available for multiline input
ACE U.S. output fields: Components available for multiline input Field name
Length
Description
APPL.Extra1-10
up to 60 The “Extra” fields contain whatever non address data ACE can find above the address data. The first Extra field populated is APPL.Extra10, then APPL.Extra9, and so on. For example: Input record
Output record
Line1 = John Dough Line2 = American Bakery Supply Line3 = 308 2nd Ave #152 Line4 = Ames IA 50014 Line5 = Line6 =
Extra7 = Extra 8 = Extra9 = John Dough Extra10 = American Bakery Supply Address = 308 2nd Ave Ste 152 City = Ames State = IA ZIP = 50014
The “Extra” fields were added before DataRight was available. If you want to convert multiline address blocks into discrete fields, use DataRight. They are much better at name, title, and firm parsing. APPL.Std_Line1-12
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 greater than or equal to the length of the input, multiline fields (Line1–12). This component will contain the USPS street abbreviation if that option is enabled.
Postal codes
ACE U.S. output fields: Postal codes Field name
Length
Description
APPL.CART
4
Carrier-route number (for example, CØØ1, RØØ1, and so on).
58
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Postal codes Field name
Length
Description
APPL.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.
APPL.LOT
4
Line-of-Travel number
APPL.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.
APPL.Chk_Digit
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.
APPL.DPBC
2
Numeric 2-digit code for delivery-point barcode. Also used in LOT sortation (see LOT above). Blank when ZIP+4 could not be assigned.
APPL.ZIP
5
Either the 5-digit ZIP assigned by ACE or, if ACE could not assign, then the ZIP found in the input record. 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.
APPL.ZIP10
10
ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen.
APPL.ZIP4
4
ZIP+4 add-on.
APPL.ZIP9
9
ZIP and ZIP+4 add-on without hyphen.
Chapter 2: ACE U.S.
59
Codes that describe the address and assignment results
ACE U.S. output fields: Codes that describe the address and assignment results Field name
Length
Description
APPL.CASSrectyp
1
This component posts the record type necessary for posting on the CASS test. It is only populated for assigned records, and the valid record types are: F (firm) G (general delivery) H (high-rise) P (PO box) R (rural route or hwy contract) S (street)
APPL.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.
APPL.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.
APPL.Match_5
1
T F
APPL.Match_9
1
T Address line was matched to a ZIP+4 record. F Address line was not matched to a ZIP+4 record. 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”. Note: 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.
APPL.Match_Un
1
T F
Last line was matched to a City/ZCF record. Last line was not matched to a City/ZCF record.
The address is tagged by the USPS as unsuitable for mail delivery (for example, a cemetery)—exactly the same meaning as error code E600. 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.
APPL.NC_Firm
Up to 60
The firm match that was made using the input ZIP+4 for missing or invalid firm information.
APPL.NC_Secaddr
Up to 60
The secondary address match that was made using the input ZIP+4 for missing or invalid secondary address information.
APPL.NC_Srange
Up to 8
The secondary range match that was made using the input ZIP+4 for missing or invalid secondary range information.
APPL.NC_Unit
Up to 10
The unit designator match that was made using the input ZIP+4 for missing or invalid unit designator information.
60
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Codes that describe the address and assignment results Field name
Length
Description
APPL.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 address-type 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.
APPL.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.
APPL.ZIP_Type
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.
Chapter 2: ACE U.S.
61
ACE U.S. output fields: Codes that describe the address and assignment results Field name
Length
Description
DPV codes: Codes that describe the address and assignment results for Delivery Point Validation (DPV is a for sale option)
APPL.DPV_CMRA
1
Y N L blank
APPL.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.
APPL.DPV_NoStat
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.
62
The address is a valid Commercial Mail Receiving Agency. The address is not a Commercial Mail Receiving Agency. The address triggered DPV locking. This component is blank when the DPV mode is not set to VALIDATE or BOTH, DPV processing is currently locked, or ACE cannot assign the input address.
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Codes that describe the address and assignment results Field name
Length
Description
APPL.DPV_Status
1
The following values are available for APPL.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 parsed secondary range (including extran_sec # sign data) 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 field is blank when the DPV mode is not enabled, DPV processing is currently locked, or ACE cannot assign the input address.
APPL.DPV_Vacant
1
Vacant address indicator. Y Address is vacant. N Address is not vacant. blank Address was not looked up
Other useful codes
ACE U.S. output fields: Other useful codes Field name
Length
Description
APPL.CASS_Match
1
Use this field to indicate which option was used to make the assignment. 0 The Non-CASS and DPV tie break options are disabled or were not used to make an assignment. 1 Inexact ZIP move assignment. 2 Input ZIP+4 assignment. 3 DPV tie-breaking was used to make this assignment. blank ACE could not assign an input address.
APPL.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 that 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.
Chapter 2: ACE U.S.
63
ACE U.S. output fields: Other useful codes Field name
Length
Description
APPL.County
3
FIPS county code. Numbers are unique within states. (FIPS stands for Federal Information Processing Standard.)
APPL.CountyName
25
Fully spelled county name (for example, “La Crosse” instead of Ø63).
APPL.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.
APPL.FIPSCODE
5
A
Airport Mail Facility (AMF)
K
Network Distribution Center (NDC)
B
Branch Office
M
Money Order Unit
C
Community Post Office (CPO)
N
City place name, invalid for mailing
D
Area Distribution Center (ADC)
P
Post Office (main)
E
Sectional Center Facility (SCF)
S
Station
F
Delivery Distribution
U
Urbanization (Puerto Rico only)
G
General Mail Facility (GMF)
Federal code for state and county. Uniquely identifies a county within the nation. Combines a 2-digit state number 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
16 Idaho
29 Missouri
42 Pennsylvania
blank territories, possessions, and protectorates
Notes: 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 Islands, or the Pacific islands.
64
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: Other useful codes Field name
Length
APPL.Firm
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.
APPL.Qss_Dflt
1
Indicates whether the record qualified as a default match rather than qualifying as a match at higher level of assignment.
APPL.RDI
1
The residential delivery indicator (RDI) that tells if the address is residential or nonresidential. Y Residential address N Nonresidential address RDI is an add-on feature.
APPL.Rec_No_Out
up to 10 The record number of a record as it is written to an output file. You may post it to an output file or to an Error Report in the Custom format. Note: If you create a Standardization Report in a Custom format, do not post this component. An output record number means nothing on a Standardization Report, because that report ignores your output file setup.
APPL.Record_No
up to 10 The record number of a record as it was read from the input file. It is a true record number and is not affected by your job setup, input filter, and so on You may post it to output files, to give yourself an audit trail between input and output records. Or you may use it when preparing an Error or Standardization report in the Custom format.
Geocensus codes
Description
The Geocensus codes are listed by option.
ACE U.S. output fields: Geocensus codes Option
Field name
Length
Description
Address-Level APPL.Ageo_Lat
10
Latitude (degrees north of the Equator) in the format: +12.123456 Longitude (degrees east of the Greenwich Meridian) in the format: +12.123456
APPL.Ageo_Lng
11
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).
APPL.Ageo_Sta
2
FIPS state code.
APPL.Ageo_Cty
3
FIPS county code.
APPL.Ageo_Pla
5
FIPS place code. A number assigned by the U.S. government to each incorporated municipality (city, village, town, etc.).
APPL.Ageo_Blk
10
U.S. Census tract and Block Numbering Area (BNA).
APPL.Ageo_MCD
6
U.S. Census Bureau minor civil division (MCD) data or, if MCD data is unavailable, census county division (CCD) data.
Chapter 2: ACE U.S.
65
ACE U.S. output fields: Geocensus codes Option
Field name
Length
Description
Centroid
APPL.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.
APPL.Cgeo_Lat
10
Latitude (degrees north of the Equator) in the format: +12.123456 Longitude (degrees east of the Greenwich Meridian) in the format: +12.123456
APPL.Cgeo_Lng
11
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).
APPL.Cgeo_Msa
4
Metropolitan Statistical Area (MSA) number. 0000 indicates the address does not lie in any MSA; usually a rural area.
APPL.Cgeo_Blk
10
U.S. Census tract and block-group number. The first 6 digits are the tract number, and the final four digits are the block-group number within the tract. 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.
Centroid
APPL.Cgeo_Match
Both Address- APPL.Geo_Match Level and Centroid
SuiteLink output fields
66
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. 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.
The following table contains output components for SuiteLink information.
Quick Reference for Views and Job-File Products March 2011
ACE U.S. output fields: SuiteLink fields Field name
Length
Description
APPL.SteLink_RC
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.
APPL.PreSL_ZIP
5
The ZIP Code that was assigned by ACE before SuiteLink processing. 5-digit ZIP Code The APPL.SteLink_RC value is A. blank No ZIP Code assigned.
APPL.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.
APPL.PreSL_DPBC
2
The numeric 2-digit code for the delivery point barcode that was generated before SuiteLink processing.
APPL.PreSL_SecR
up to 8
The secondary range information that existed before SuiteLink processing. If this is blank, ACE did not assign any secondary information.
APPL.PreSL_Unit
up to 10
The unit designator that existed before SuiteLink processing. If this is blank, ACE did not assign any secondary information.
APPL.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.
Chapter 2: ACE U.S.
67
ACE U.S. address status codes
ACE U.S. address status codes Digit
1st
2nd
3rd
68
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 8 significant difference between the input data and the data that ACE assigned.
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.
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.
Quick Reference for Views and Job-File Products March 2011
ACE U.S. address status codes Digit
4th
5th
6th
Description
Description
0
Regarding the county number, CART (carrier-route 8 number), DPBC, and unit designator, there is no significant difference between the input data and the data that ACE assigned.
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.
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.
Chapter 2: ACE U.S.
69
ACE address error codes (U.S. and Canada)
ACE address error codes (U.S. and Canada) Code
Country
Description
Code
Country
Description
E101
Can
U.S. Last line is bad or missing
E433
Can
Address conflicts with the postal code, different street name exists for input postal code
E212
Can
U.S. No city and bad ZIP/postal code
E434
Can
No street assignment was possible, there was a duplicate postal-code match
E213
Can
U.S. Bad city, valid state/province, and no ZIP/postal code
E435
Can
No street assignment, no postal code
E214
Can
U.S. Bad city and bad ZIP/postal code
E436
Can
No street assignment, postal code not matched
U.S. Bad ZIP, can’t determine which city match to select
E437
Can
Multiple match, different directory areas
E216 E302
Can
U.S. No primary address line parsed
E439
E412
Can
U.S. Street name not found in directory
E450
Can
High rank has out-of-range suite
E413
Can
U.S. Possible street-name matches too close E451 to choose one
Can
High rank has out-of-range PO box
U.S. Primary range is missing
E452
Can
PO box vs. civic postal-code mismatch
U.S. Primary range is invalid for the street/ route/building
E453
Can
Multiple suite ranking conflict
U.S. Predirectional needed, input is wrong or missing
E500
Can
U.S. Other error
U.S. Suffix needed, input is wrong or missing
E501
Can
U.S. Foreign address
U.S. Suffix and directional needed, input is wrong or missing
E502
U.S. Input record entirely blank
U.S. [Post] Directional needed, input is wrong or missing
E503
U.S. ZIP not in area covered by partial ZIP+4 directory
E428
U.S. Bad ZIP, can’t select an address match
E504
U.S. Overlapping ranges in ZIP+4 directory
E429
U.S. Bad city, can’t select an address match E505
U.S. Address does not exist in the USPS directories. Undeliverable address.
U.S. Possible address-line matches too close to choose one
U.S. Marked by USPS as unsuitable for delivery of mail
E420 E421
Can
E422 E423
Can
E425 E427
E430
Can
Can
E431
E432
70
U.S. Exact match made in EWS directory
E600
U.S. Urbanization needed, input is wrong or E601 missing Can
The address conflicts with the postal code, the same street has a different postal code
Quick Reference for Views and Job-File Products March 2011
U.S. The primary address number did not DPV confirm, and the ZIP+4 was removed.
Chapter 3: ACE Canada
This chapter contains input fields, output fields, and status codes for ACE Canada Job File. Refer to “ACE address error codes (U.S. and Canada)” on page 70 for a list of ACE Canada error codes. Input fields are listed by the type of input data. Output fields are listed in alphabetical order. When a field is grouped together with other like fields, the order is based on the first field in the list. For more information on setting up jobs with this product, see the ACE Canada Job File Reference. The items in this section are current through version 7.80c of ACE Canada.
Chapter 3: ACE Canada
71
ACE Canada input fields
ACE Canada input fields Type of Data
Field name
Length
Name (line)
PW.Name_Line
up to 60 ACE doesn’t do anything with Name data except capitalize it. Note: The discrete fields Pre_Name, First_Name, Mid_Name, Last_Name, and Post_Name are also accepted, though rarely used.
Title
PW.Title
up to 60 ACE doesn’t do anything with Title data except capitalize it.
Firm
PW.Firm
up to 60 ACE doesn’t do anything with Firm data except capitalize it.
Street address
PW.Address
up to 60 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 up to 60 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”). 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 Unit fields. For example: Address = “1000 Main Street”, Unit = “Apt. 5”.
PW.Unit
Description
City
PW.City
Province
PW.Province or PW.State
Post code
PW.PostCode or PW.ZIP
6 or 7
Country
PW.Country
up to 60 ACE uses Country data to detect foreign addresses. ACE does not attempt to assign any addresses outside Canada. For domestic addresses, the Country field may be blank or contain “Canada.”
Multiline
PW.Line1–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 12 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.
72
up to 60 If you have separate database fields for city and province, present them to ACE through the input fields City and Province or State. ACE uses this infor2 mation to assign a postal code. You cannot use the discrete fields City and Province if: 1) You store city and province together in a combined field, or 2) You use province abbreviations other than those set by Canada Post. See the Last_Line field below. If you have a field specifically for the postal code, then present it to ACE through the PostCode or ZIP field. ACE uses this information to confirm, or perhaps to complete, the city and province data. It may also be used to crosscheck the address line.
Quick Reference for Views and Job-File Products March 2011
ACE Canada input fields Type of Data
Field name
Length
Description
Last line
PW.Last_Line
up to 60 There are some situations in which you must use the ACE field Last_Line instead of the separate City, Province, and Postal fields: If you have a combined city-province-postal-code field, well, that’s exactly what ACE calls Last_Line. For example, your DEF file entry might be: Last_Line = DB.City_Prov_Post. Perhaps you have a combined city-province field, but a separate field for postal code. In that situation you have to set up the Last_Line field to include (concatenate) both of your fields; for example, Last_Line = DB.City_Prov & DB.PostCode. You do not have to physically merge your fields. If your Province field contains full spellings or abbreviations other than those set by Canada Post, do not use the discrete Province field. Instead, present your city, province, and postal-code fields together through the Last_Line field. For example: Last_Line = DB.City & DB.Province & DB.PostCode
Language
PW.Language
1
ACE can standardize address lines in French or English. One option for controlling language choice is through an input field. ACE will examine only the first character of the Language field. That first character may be an E for English or an F for French. If ACE finds any other value in the field, it will attempt to preserve the language of the address line as it was input.
Mark records for deletion
PW.Delete
1
When processing ASCII files, you can use the Delete field to signal ACE when a record is marked to be deleted. ACE checks the Delete field to determine if the record is delete-marked. If the first character is an asterisk (*), the record is treated as delete-marked. If the first character is anything else, the record is not considered delete-marked. By using this field, you can mimic the feature of dBASE (and other databases) called nondestructive delete marking. Refer to Database Prep for more information. Note: ACE Canada does not offer a job-file parameter for you to control whether delete-marked records are processed. So a delete-marked record will be processed through the assignment engine. However, by using an output filter, you can keep delete-marked records output of your output file. The output filter expression to use is: .not. deleted()
Other fields
PW…
up to 60 ACE can accept a large number of other PW fields not listed here (see “Index” on page 181). ACE doesn’t necessarily process or use those other fields, but they are handy in posting or filters when you are working with files that don’t use the same field names.
User-defined field
user:fieldname
You may define your own PW fields by using the prefix user: in your DEF file. For example, if you define “user:Status = DB.STATUS”, then you can work with Status as you would use any other PW field, in posting or filters. This is handy when you are working with files that don’t use the same field names.
Chapter 3: ACE Canada
73
ACE Canada output fields
Last-line components
ACE Canada output fields: Last-line components Field name
Length
Description
AP.City
up to 30
Standardized city name. When the input city name is tagged as a place name by Canada Post, this field will always preserve the place name, never convert, no matter how the place-name option is set.
AP.City13
up to 13
The official 13-character abbreviation of the city name, or the full spelling if the city name is less than 13 characters (counting spaces).
AP.City18
up to 18
The official 18-character abbreviation of the city name, or the full spelling if the city name is less than 18 characters (counting spaces)
AP.Country
up to 100 The fully-spelled country name.
AP.Last_Line
up to 60
If the address is fully assigned, this component yields a complete, standardized line, including city, province, and postal code. Whether the city place names are converted depends on how you set the place-name 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.
AP.PostCode
6
Postal code in ananan format.
AP.PostCode7
7
Postal code in ana nan format, with one space separating the FSA and LDU portions. Note: If ACE cannot assign a postal code, it will pass along the postal code from the input data (if there was one).
AP.Pref_City
up to 30
Standardized city name. When the input city name is tagged as a place name by Canada Post, this Field will always yield the preferred (converted) city name, no matter how the place name option is set.
AP.Province
2
Standard Canada Post abbreviation for the province.
Assigned address-line components
ACE Canada output fields: Assigned address-line components Field name
Length
AP.Address
up to 60 Complete, standardized primary and secondary address line. Style of suffixes, directionals, and secondary ranges depends on how you set those style options. If the address is not assigned, you will get ACE’s best attempt to standardize.
AP.Aline
up to 60 Complete address line: Primary, secondary, urbanization, dual address, and remainder.
AP.Delinst
up to 28 Delivery Installation city name—usually the same as the city name, and omitted from the address line if it is the same.
AP.DelQual
up to 14 Delivery Installation Qualifier. For example, “Main” in “RR 2 Vancouver Stn Main”
74
Description
Quick Reference for Views and Job-File Products March 2011
ACE Canada output fields: Assigned address-line components Field name
Length
Description
AP.DelType
up to 5
Delivery Installation Type; for example, “Stn” in “RR 2 Vancouver Stn Main”. Possible values include: English: French: PO Post Office BDP Bureau de Poste RPO Retail Postal Outlet CSP Comptoir Service Postal STN Station SUCC Succursale LCD Letter Carrier Depot PDF Poste de Facteurs CMC Community Mail Centre CPC Centre Postal Communautaire CDO Commercial Dealership Outlet CC Concession Commerciale
AP.Dir
2
Abbreviated directional (English: N, NE, E, SE, S, SW, W, NW) (French: N, NE, E, SE, S, SO, O, NO).
AP.POBOX_NUM
Up to 100
Includes the numeric portion of the post-office box number.
AP.Prim_Addr
up to 60 Complete, standardized, primary address line (for example, 100 Main St).
AP.Prim_Name
up to 28 Standardized primary name (most often street name).
AP.Prim_Range
up to 10 Primary range (that is, house number, such as “1000” in “1000 Vine Street”).
AP.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.
AP.RR_Number
Up to 100
AP.Sec_Addr
up to 60 Complete secondary address (for example, Apt 10, Suite 500, Bureau 34).
AP.Sec_Range
up to 8
Secondary range (number only, does not include unit designator).
AP.Suffix
4
Abbreviated suffix (English: St, Rd, Ave, Blvd, and so on) (French: Rue, Rte, Av, Boul, and so on).
AP.Unit_Desig
up to 10 Unit designator (English: Apt, Suite, or Unit) (French: App, Bureau, Unite).
APL.Dir
9
Directional spelled out (English: North, Northeast, East, and so on) (French: Nord, Nord-Est, Est, and so on).
APL.Suffix
10
Suffix spelled out (English: Street, Road, Avenue, Boulevard, and so on) (French: Rue, Route, Avenue, Boulevard, and so on).
Includes the numeric portion of the rural route address.
Alias address-line components
ACE Canada output fields: Alias address-line components Field name
Length
Description
APA.Address
20 to 60
Complete, standardized primary and secondary address line for the preferred alias. Style of suffixes, directionals, and secondary ranges depends on how you set those style options.
APA.Dir
2
Abbreviated directional for the alias address (English: N, NE, E, SE, S, SW, W, NW) (French: N, NE, E, SE, S, SO, O, NO).
Chapter 3: ACE Canada
75
ACE Canada output fields: Alias address-line components Field name
Length
Description
APA.Prim_Addr
up to 60
Complete, standardized, primary address line for the preferred alias. Short or long style of suffixes and directionals depends on how you set those style options.
APA.Prim_Name
up to 28
Standardized primary name (most often street name) for the alias address.
APA.Suffix
4
Abbreviated suffix for the alias address (English: St, Rd, Ave, Blvd, and so on) (French: Rue, Rte, Av, Boul, and so on).
APA.Prim_Range
up to 100 House number, house description, or post-office box number. For example, for the address “123 Main Street,” the range is “123.”
APAL.Dir
9
Directional spelled out for the alias address (English: North, Northeast, East, and so on) (French: Nord, Nord-Est, Est, and so on).
APAL.Suffix
10
Suffix spelled out for the alias address (English: Street, Road, and so on) (French: Rue, Route, and so on).
Dual address-line components
ACE Canada output fields: Dual address-line components Field name
Length
Description
APD.Address
20 to 60 Complete, standardized address line, including primary and secondary, if available. Style of suffixes, directionals, and secondary ranges depends on how you set those style options.
APD.Delinst
up to 28 Delivery Installation city name for the dual address—usually the same as the city name, and omitted from the address line if it is the same.
APD.DelQual
up to 14 Delivery Installation Qualifier for the dual address. For example, “Main” in “RR 2 Vancouver Stn Main”
APD.DelType
up to 5
Delivery Installation Type; for example, “Stn” in “RR 2 Vancouver Stn Main”. Possible values include: English: French: PO Post Office BDPBureau de Poste RPO Retail Postal OutletCSPComptoir Service Postal STN Station SUCCSuccursale LCD Letter Carrier Depot PDFPoste de Facteurs CMC Community Mail Centre CPCCentre Postal Communautaire CDO Commercial Dealership OutletCCConcession Commerciale
APD.Dir
2
Abbreviated directional for the dual address (English: N, NE, E, SE, S, SW, W, NW) (French: N, NE, E, SE, S, SO, O, NO).
APD.Prim_Addr
up to 60 Standardized primary address. Short or long style of suffixes and directionals depends on how you set those style options.
APD.Prim_Name up to 28 Standardized primary name (most often street name) for the dual address. APD.Prim_Range up to 10 Primary range (house number) of the dual address.
76
Quick Reference for Views and Job-File Products March 2011
ACE Canada output fields: Dual address-line components Field name
Length
Description
APD.Rec_Type
2
When a dual address is identified but not assigned, ACE Canada will provide an address-type indication based on the way that the input data was parsed. This is not a guarantee. ACE Canada may indicate that a street, rural route, highway contract, 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
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.
APD.Sec_Addr
up to 60 Standardized secondary address. Style of secondary ranges depends on how you set that style option.
APD.Sec_Range
up to 8
Secondary range for the dual address (apartment or suite number only, does not include designator).
APD.Suffix
4
Abbreviated suffix for the dual address (English: St, Rd, Ave, Blvd, and so on) (French: Rue, Rte, Av, Boul, and so on).
APD.Unit_Desig
up to 10 Unit designator for the dual address (English: Apt, Suite, or Unit) (French: App, Bureau, Unite).
APDL.Dir
9
Directional spelled out for the dual address (English: North, Northeast, East, and so on) (French: Nord, Nord-Est, Est, and so on).
APDL.Suffix
10
Suffix spelled out for the dual address (English: Street, Road, and so on) (French: Rue, Route, and so on).
Components available for multiline input
ACE Canada output fields: Components available for multiline input Field name
Length
Description
AP.Extra1-12
up to 60 The “Extra” fields contain whatever non address data ACE can find above and below the address data. The purpose of these fields is to help you separate address data from other data such as name, title, and company. For example: Input record Output record Line1 = John DoughExtra1 = Line2 = Canadian Bakery SupplyExtra2 = Line3 = 308 2nd Ave #152Extra3 = John Dough Line4 = Vancouver BC V6A1Z9Extra4 = Canadian Bakery Supply Line5 = Address = 308 2nd Ave Suite 152 Line6 = City = Vancouver Province = BC Postal7 = V6A 1Z9
Chapter 3: ACE Canada
77
ACE Canada output fields: Components available for multiline input Field name
Length
Description
AP.Std_Line1-12
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 greater than or equal to the length of the input, multiline fields (Line1–6).
Other useful codes
CACE output fields: Other useful codes Field name
Length
Description
AP.Addr_Lvr
1
A single character that indicates whether the address is a Large Volume Receiver (comparable to a Unique ZIP Code in the U.S.). T The address is a Large Volume Receiver. F The address is not a Large Volume Receiver. blank The address was not assigned.
AP.Category
1
A single character that indicates the result of the assignment process: V Address verified as-is. No changes made. Note: ACE Canada may make slight standardization changes to the address and still consider the address verified as-is. C Some address components changed. N Address could not be assigned. F Foreign address.
AP.Err_Stat
6
Error code, if address is unassigned; or status code, if assigned.
AP.Error_Code
6
Error code, if address is unassigned; or blank, if assigned.
AP.Stat_Code
6
Status code. Blank if unassigned.
AP.Firm
20 to 60 Firm name from the national directory, if matched; or if not matched, then the Firm data from the input record. Do not use this component if the input is multiline.
AP.Newline
1 or 2
CRLF on DOS and Windows, LF on UNIX. For posting to ASCII output files as an end-of-record mark. The output field should be named EOR.
AP.Rec_Type
2
Type of postal code assigned. F Firm H High-rise P PO box R Rural route or highway contract S Street SR Street served by route BN Building name X Unknown address
AP.Record_No
10
The input file record number.
AP.Rec_No_Out
10
The output file record number.
78
Quick Reference for Views and Job-File Products March 2011
CACE output fields: Other useful codes Field name
Length
Description
AP.Urban_Ind
1
Indicates whether an address is urban. T The address is urban F The address is not urban blank The address didn’t assign and the postcode was not entered on input
GeoCoding components
ACE Canada output fields: GeoCoding components Field name
Length
Description
AP.ADDRESS_GEO_LAT
12
Latitude (degrees north of the equator) in the format +12.123456.
AP.ADDRESS_GEO_LNG
12
Longitude (degrees east of the Greenwich Meridian) in the format +12.123456.
AP.CENTROID_GEO_LAT
12
Latitude (degrees north of the equator) in the format +12.123456.
AP.CENTROID_GEO_LNG
12
Longitude (degrees east of the Greenwich Meridian) in the format +12.123456.
AP.GEO_MATCH
9
Match code indicating the precision of the latitude and longitude assignment. 0 Match in Address-level. 1 Match on Centroid-level. 7 No match on Centroid-level. 8 No match on Address-level. 9 Both options tried, but no match on Address or Centroid-level.
Chapter 3: ACE Canada
79
ACE Canada address status codes
ACE Canada address status codes Digit
1st
2nd
3rd
80
Description
Description
S
ACE did not truncate anything.
B
ACE truncated both the address line and the city name.
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.
0
Regarding the city, province, and postal code, there is no significant difference between the input data and the data that ACE assigned.
8
Not used.
1
ACE assigned a different postal code.
9
Not used.
2
ACE assigned a different city.
A
Not used.
3
ACE assigned a different city and postal code.
B
Not used.
4
ACE assigned a different province.
C
Not used.
5
ACE assigned a different province and postal code.
D
Not used.
6
ACE assigned a different city and province.
E
Not used.
7
ACE assigned a different city, province, and postal code.
F
Not used.
0
Regarding the primary name, directional, suffix, and 8 dual, there is no significant difference between the input and what ACE assigned.
ACE assigned a different dual address.
1
ACE assigned a different suffix.
9
ACE assigned a different suffix and dual address.
2
ACE assigned a different directional.
A
ACE assigned a different directional and dual address.
3
ACE assigned a different directional and suffix.
B
ACE assigned a different directional, suffix, and dual address.
4
ACE assigned a different primary name.
C
ACE assigned a different primary name and dual address.
5
ACE assigned a different primary name and suffix.
D
ACE assigned a different primary name, suffix, and dual address.
6
ACE assigned a different primary name and directional.
E
ACE assigned a different primary name, directional, and dual address.
7
ACE assigned a different primary name, directional, F and suffix.
ACE assigned a different primary name, directional, suffix, and dual address.
Quick Reference for Views and Job-File Products March 2011
ACE Canada address status codes Digit
4th
Description
Description
0
Regarding the unit designator and delivery installation area name, type, and qualifier, there is no significant difference between the input data and the data that ACE assigned.
8
ACE assigned a different delivery installation qualifier.
1
ACE assigned a different unit designator.
9
ACE assigned a different delivery installation qualifier and unit designator.
2
ACE assigned a different delivery installation area name.
A
ACE assigned a different delivery installation qualifier and area name.
3
ACE assigned a different delivery installation area name and unit designator.
B
ACE assigned a different unit designator, delivery installation qualifier and area name.
4
ACE assigned a different delivery installation type.
C
ACE assigned a different delivery installation qualifier and type.
5
ACE assigned a different delivery installation type and unit designator.
D
ACE assigned a different unit designator, delivery installation qualifier and type.
6
ACE assigned a different delivery installation type and area name.
E
ACE assigned a different delivery installation qualifier, type, and area name.
7
ACE assigned a different unit designator, delivery installation type and area name.
Chapter 3: ACE Canada
81
82
Quick Reference for Views and Job-File Products March 2011
Chapter 4: International ACE
This chapter contains input fields, output fields, status codes, and error codes for International ACE Job File and International ACE Views. Input and output fields are listed in alphabetical order. When a field is grouped together with other like fields, the order is based on the first field in the list. This information is current through version 7.80c of International ACE. For more information on setting up jobs with these products, see the International ACE Job File Reference or the International ACE Views online help.
Chapter 4: International ACE
83
International ACE input fields Some guidelines for setting up input fields: For numbered fields, start with field number 1 and use consecutive fields— for example, Line1, Line2, Line3, and so on. You must use at least one Addr_Line field or one Line field. You may use either Addr_Line fields or Line fields, but not both. For last-line data, you may use either the Last_Line field or the Locality, Region and Postcode fields. You must use at least one of the following: Line; Last_Line; or Postcode, Locality and Region.
IACE input fields Engines that produce this line Field name
Description
PW.Addr_Line1
Delivery address line—for example, “123 Main Street, Unit 4.” X Japan engine: Rrepresents the sub-district (aza, bu, chiwari, sen), super block (joh), block (chome, kumi, Hokkaido go), sub-block (banchi, gaiku, tochi kukaku), and house number (go) parts of the Japanese address. These parts appear after a district or village and before a building. If address2 is not present, this should also contain the Building Name, Building Floor, Building Room parts of the Japanese address. In case of LOPC address, P.O. Box data should be inserted in the PW.Addr_Line1 field and post office name should be inserted in the PW.Locality1 field.
PW.Addr_Line2
Delivery address line—for example, “123 Main Street, Unit 4.” X Japan engine: Represents the building name, building floor, and building room parts of the address.
PW.Chk_Digit
Check digit for the delivery-point barcode.
—
—
—
—
X
PW.Country
Country name.
X
X
X
X
X
PW.County
Three-digit county code. Numbers start at 001 within each state.
—
—
—
—
X
PW.Delvy_Pt
Two-digit DPBC code.
—
—
—
—
X
PW.Firm1-2
The name of a company, business, or organization. In some countries, large firms have their own postal code. If you present a firm field to IACE, it can assign more specific postal codes. Japan engine: This information is just passed through.
X
X
X
X
X
84
Quick Reference for Views and Job-File Products March 2011
Aus
Can
Intl
Jpn
U.S.
X
X
X
X
X
IACE input fields Engines that produce this line Field name
Description
Aus
Can
Intl
Jpn
U.S.
PW.Last_Line1
Locality, region, and postal code on one line. Japan Engine: If PW.Last_line2 is not present, PW.Last_line1should also contain the address parts for PW.locality2 and PW.locality3. PW.Last_Line1can also contain this information.
X
X
X
X
X
PW.Last_Line2
Locality, region, and postal code on one line. Japan Engine: If PW.Last_line2 is not present, PW.Last_line1should also contain the address parts for PW.locality2 and PW.locality3. PW.Last_Line1can also contain this information.
X
PW.Line1–12
A line that may contain any data. The type of data in this line may vary from record to record. International engine supports only 8 lines. Japan engine: These represent the lines that may contain any data with following restrictions: Individual components cannot span over multiple lines. The address in total has to be in the traditional order of a Japanese address. The data in these lines should be in order according to the option you have selected for order of multi-lines.
X
X
X
X
X
PW.Locality1
X City, town, or suburb. Japan engine: The city (shi) or island (shima) part of the Japanese address: If Locality2 is not present, it contains the ward and county information. If Locality3 is not present, it also contains the district or village information. Locality1 can contain information from Locality2-3. In case of PO box, this represents the post office Name. Also for Japan, PW.Locality1 represents the post office name when the address is postal. In case of LOPC address, P>O> Box data should be inserted in the PW.Addr_Line1 field and post office name should be inserted in the PW.Locality1 field.
X
X
X
X
PW.Locality2
International engine: Additional city, town, or suburb informa- — tion. U.S. engine: Puerto Rican urbanization. Japan engine: The ward (ku) or county (gun) part of the Japanese address. If Locality3 is not present, it also contains the district or village information. Locality1 can contain information from Locality3.
—
X
X
X
PW.Locality3
Additional city, town, or suburb information. Japan engine: The district (machi) or village (mura) part of the Japanese address.
—
—
X
X
—
PW.LOT
Line-of-travel code.
—
—
—
—
X
X
Chapter 4: International ACE
85
IACE input fields Engines that produce this line Field name
Description
Aus
Can
Intl
Jpn
U.S.
PW.LOT_Order
Line-of-travel order code.
—
—
—
—
X
PW.Name_Line1
International ACE doesn’t do anything with name data except case it. Japan engine: This component is just passed through.
X
X
—
X
X
PW.Postcode
Other engines: Postal code. U.S. engine: Five-digit ZIP Code and ZIP4.
X
X
X
X
X
PW.Region
State, province, or region.
X
X
X
X
X
PW.Route
Carrier route.
—
—
—
—
X
PW.Title1
International ACE doesn’t do anything with title data except case it.
X
X
—
—
X
PW.Unit
If you store the street address and secondary address (apartment or suite) in separate fields, present the fields to International ACE through the Addr_Line1 and Unit fields.
X
X
—
—
X
86
Quick Reference for Views and Job-File Products March 2011
IACE output fields
Address components
For the U.S. and Canada engines, address-line data will be standardized according to your settings in the Standardization Options section of the job file. If the address is not assigned, you will get International ACE’s best attempt to standardize. Non-postal means that the mail is delivered through a private mailbox company rather than the USPS. Address output fields are listed in address order, not alphabetical order.
IACE output fields: Address components Availability per engine Field name
Length
Description
Aus
Can
Intl
Jpn
U.S.
AP.Addr_Total
up to 100
Complete address line: Primary address, secondary address, Puerto Rican urbanization (U.S. only), dual address, and remainder.
—
X
—
—
X
AP.Address
up to 100
Complete primary and secondary address line. Note: The software does not populate this field for UK addresses. If you want to combine the primary and secondary address into one line, concatenate AP.Prim_Range, AP.Prim_Name1, and AP.Sec_Addr.
X
X
X
X
X
AP.Building
up to 100
Building name.
X
—
X
X
—
AP.Bypass
1
This field indicates whether the current record was bypassed or not during the read step. A T is returned when the current record is bypassed. An F is returned when the current record is not bypassed.
X
X
X
X
X
AP.Delinst
up to 100
Delivery Installation city name; usually the same as the city name, and omitted from the address line if it is the same. Japan engine: The name of the post office is returned.
—
X
—
X
—
AP.DelQual
up to 100
Delivery Installation Qualifier—for example, “Main” in — “RR 2 Vancouver Stn Main.”
X
—
—
—
Chapter 4: International ACE
87
IACE output fields: Address components Availability per engine Field name
Length
Description
Aus
Can
Intl
Jpn
U.S.
AP.DelType
up to 100
U.S. engine: Type of postal facility: 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 P Post Office (main) S Station U Urbanization (Puerto Rico only)
—
X
—
—
X
Canadian engine: Type of delivery installation: English Post Office PO RPO Retail Post Outlet STN Station LCD Letter Carrier Depot CMC Community Mail Centre CDO Commercial Dealership Outlet French BDP Bureau de Poste CSP Comptoir Service Postal SUCC Succursale PDF Poste de Facteurs CPC Centre Postal Communautaire CC Concession Commerciale AP.Key_Num
up to 100
Additional sub-block information that may indicate one of the following conditions: The block data contains an additional block number under a house number. Indicates the mail group that the mail in a building belongs to.
—
—
—
X
—
AP.Level_Desc
up to 100
Level description, such as “Floor.”
X
—
—
—
—
AP.Level_Num
up to 100
The level number. Japan engine: Contains the level information such as “ .”
X
—
—
X
—
AP.NP_Secaddr
up to 100
Complete non-postal secondary address (PMB 10). Non-postal means that the mail is delivered through a private mailbox company rather than the USPS.
—
—
—
—
X
88
Quick Reference for Views and Job-File Products March 2011
IACE output fields: Address components Availability per engine Field name
Length
Description
Aus
Can
Intl
Jpn
U.S.
AP.Np_Srange
up to 100
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.
—
—
—
—
X
AP.Np_Unit
up to 100
Non-postal unit designator (PMB). Non-postal means that the mail is delivered through a private mailbox company rather than the USPS.
—
—
—
—
X
AP.Post_Dir
up to 100
Abbreviated directional (N, S, NW, SE) that follows a street name.
X
X
—
—
X
AP.Postal_Nam
up to 100
Postal delivery name (P.O. box, G.P. O. box, RMB, and so on) Japan engine: Postal_name will always contain the Japanese string for post box number “ .“
X
—
—
X
—
AP.Postal_Num
up to 100
X Australian engine: Postal delivery number. International and Japan engines: Japan engine: Postal_num will contain the PO box Number part of the Japanese address. It may include markers such as dai “ ” and go “ ”. For example, the box 123 may show as “ ”, where dai is No., 123 is a box number, and go is a box number marker. U.S. engine: Rural-route box number or P.O. box number. Canada engine: Includes the numeric portion of the post office box number.
X
X
X
X
AP.Pre_Dir
up to 100
Abbreviated directional (N, S, NW, SE) that precedes a street name.
—
—
—
—
X
AP.Prim_Addr
up to 100
Complete primary address line—for example, “100 Main Street.” Japan engine: Contains the full block (chome-banchigo) of the Japanese address.
X
X
—
X
X
AP.Prim_Name1
up to 100
Primary name, most often a street name. Japan engine: Contains the block (chome, kumi, Hokkaido go) part of the Japanese address.
X
X
X
X
X
AP.Prim_Name2
up to 100
Primary name that has a street range including a major thoroughfare and the street connected to the thoroughfare. Japan engine: Contains the sub-block (banchi, gaiku, or tochi kukaku) part of the Japanese address.
—
—
X
X
—
AP.Prim_Range
up to 100
House number, house description, or post-office box number. For example, for the address “123 Main Street,” the range is “123.” Japan engine: contains the house number (go) part of the Japanese address.
X
X
X
X
X
Chapter 4: International ACE
89
IACE output fields: Address components Availability per engine Field name
Length
Description
Aus
Can
Intl
Jpn
U.S.
AP.Remainder1
up to 100
Extraneous data found on the address line, which either cannot be identified or does not belong in a standardized address.
X
X
X
X
X
AP.Remainder2
up to 100
Consists of extraneous Private Mail Box or secondary address data.
—
—
—
—
X
AP.Rural_Num
up to 100
U.S. engine: Rural-route number. Canada engine: Includes the numeric portion of the rural route address.
—
X
—
—
X
AP.Sec_Addr
up to 100
Complete secondary address—for example, “Unit 10.” Japan engine: Consists of building name, floor and room number components.
X
X
X
X
X
AP.Singl_Addr
up to 100
Contains the whole address in a single line.
—
—
—
X
—
AP.Suffix
up to 100
Abbreviated street type such as “St,” “Ave,” or “Pl.”
X
X
X
—
X
AP.Unit_Desc
up to 100
Unit description, such as “Apartment” or “Flat.”
X
X
X
—
X
AP.Unit_Dir
up to 100
Unit description taken from the postal directory.
—
—
—
—
X
AP.Unit_Num
up to 100
Unit number.
X
X
X
X
X
APL.Post_Dir
up to 100
Fully-spelled directional (North, South) that follows a street name.
X
X
—
—
X
APL.Pre_Dir
up to 100
Fully-spelled directional (North, South) that precedes a street name.
—
—
—
—
X
APL.Suffix
up to 100
Fully-spelled street type such as “Street,” “Avenue,” or “Place.”
X
—
—
—
—
Alternate address-line components
90
Occasionally, there are two acceptable forms of an address—for example, there may be two commonly used names for the same street. In such cases, the postal authority prefers one form of the address. If the input address is not the preferred form, International ACE produces “alternate” components. These components always give you the preferred form of the address, no matter how you set the Address Line Alias option (that setting affects the AP fields, not the APA fields). Alternate components are also produced whenever the postal directory lists a firm alternate or high-rise alternate.
Quick Reference for Views and Job-File Products March 2011
IACE output fields: Alternate address-line components Availability per engine Field name
Length
Description
APA.Addr_Type
up to 100
APA.Address
up to 100
APA.Building
Can
Jpn
U.S.
— 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.
—
X
Complete, standardized primary and secondary address line. Style of suffixes, directional, and unit designators depends on how you set the standardization options.
X
—
X
up to 100
Building name.
—
X
—
APA.Cnty_Name
up to 100
Contains the county (gun) part of the Japanese address. Note: In the U.S., county information is not included on mail pieces.
—
X
—
APA.Last_Line
up to 100
Locality, region, and postal code together on one line.
X
X
X
APA.Level_Num
up to 100
Contains the level information such as “
—
X
—
APA.Locality1
up to 100
Canadian and U.S. engines: The locality name preferred by the postal authority. (The Assign City option has no effect on this field.) Japan engine: Contains the city (shi) or island (shima) part of the address. If the address contains a PO box, this will contain the name of the post office. If the address is an island type, this contains the island part of the address. Other engines: City, town, locality, or suburb.
X
X
X
APA.Locality2
up to 100
U.S. engine: Urbanization (Puerto Rican addresses only). Japan engine: Contains the ward (ku) part of the address. Other engines: Additional locality information.
—
X
X
APA.Locality3
up to 100
Additional locality information. Japan engine: Contains the district (machi) or Village (mura) part of the address.
—
X
—
APA.Locality4
up to 100
Japan engine: Contains the sub-district (aza, bu, chiwari, sen) part of the address.
—
X
—
APA.Post_Dir
up to 100
Abbreviated directional (N, S, NW, SE) that follows a street name.
X
—
X
.”
Chapter 4: International ACE
91
IACE output fields: Alternate address-line components Availability per engine Field name
Length
Description
Can
Jpn
U.S.
APA.Pre_Dir
up to 100
Abbreviated directional (N, S, NW, SE) that precedes a street name.
—
—
X
APA.Prim_Addr
up to 100
Complete, standardized primary address line. Style of sufX fixes and directional depends on how you set the standardization options.
—
X
APA.Prim_Name1
up to 100
Primary name, most often a street name. Japan engine: Contains the block (chome, kumi, Hokkaido go) part of the Japanese address.
X
X
X
APA.Prim_Name2
up to 100
Primary name that has a street range including a major thoroughfare and the street connected to the thoroughfare. Japan engine: Contains the sub-block (banchi, gaiku, or tochi kukaku) part of the Japanese address.
—
X
—
APA.Prim_Range
up to 100
House number, house description, or post-office box number. For example, for the address “123 Main Street,” the range is “123.” Japan engine: contains the house number (go) part of the Japanese address.
X
X
X
APA.Region
up to 100
State, province, territory, or region.
X
X
X
APA.Sec_Addr
up to 100
Complete secondary address (such as “Apartment 10”) for the alternate address.
—
—
X
APA.Suffix
up to 100
Abbreviated street type such as “St,” “Ave,” or “Pl.”
X
—
X
APA.Unit_Desc
up to 100
Unit description, such as “Apartment” or “Flat,” for the alter- — nate address.
—
X
APA.Unit_Num
up to 100
Unit number.
X
X
X
APAL.Post_Dir
up to 100
Fully-spelled directional (North, South) that follows a street name.
X
—
X
APAL.Pre_Dir
up to 100
Fully-spelled directional (North, South) that precedes a street name.
—
—
X
APAL.Suffix
up to 100
Fully-spelled street type such as “Street,” “Avenue,” or “Place.”
X
—
X
Dual address-line components
IACE output fields: Dual address-line components Availability per engine Field name
Length
APD.Address
up to 100 Complete, standardized address line, including primary and secondary, if available.
92
Description
Quick Reference for Views and Job-File Products March 2011
Aus
Can
U.S.
X
X
X
IACE output fields: Dual address-line components Availability per engine Field name
Length
APD.Prim_Addr
Description
Aus
Can
U.S.
up to 100 Standardized primary address.
X
X
X
APD.Sec_Addr
up to 100 Standardized secondary address, such as “Unit 10.”
X
X
X
APD.Remainder1
up to 100 Extraneous data found on the address line, which either cannot be identified or does not belong in a standardized address.
—
X
X
APD.Remainder2
up to 100 Consists of extraneous Private Mail Box or secondary address data.
—
—
X
APD.Locality2
up to 100 Urbanization name (Puerto Rican addresses only).
—
—
X
APD.Prim_Range
up to 100 Primary range (house number or box number).
X
X
X
APD.Prim_ Name1-2
up to 100 Standardized primary name (most often a street name).
X
X
X
APD.Suffix APDL.Suffix
up to 100 Abbreviated street type such as “St,” “Ave,” or “Pl.” up to 100 Fully spelled street type such as “Street,” “Avenue,” or “Place.”
X X
X X
X X
APD.Pre_Dir APDL.Pre_Dir
up to 100 Abbreviated directional (N, S, NW, SE) that precedes a street name. up to 100 Fully spelled directional (North, South) that precedes a street name.
—
—
X X
APD.Post_Dir APDL.Post_Dir
up to 100 Abbreviated directional (N, S, NW, SE) that follows a street name. up to 100 Fully spelled directional (North, South) that follows a street name.
X X
X X
X X
APD.Rural_Num
up to 100 Rural-route number.
—
—
X
APD.Unit_Desc
up to 100 Unit description, such as “Apartment” or “Flat,” for the alternate address.
X
X
X
APD.Unit_Num
up to 100 Unit number.
X
X
X
APD.Postal_Num
up to 100 Rural-route box number or post-office box number.
—
—
X
APD.Level_Num
up to 100 Level number.
X
—
—
APD.Level_Desc
up to 100 Level Description such as “Floor”.
X
—
—
APD.Delinst
up to 100 Delivery Installation city name; usually the same as the city name, and omitted from the address line if it is the same.
—
X
—
Chapter 4: International ACE
93
IACE output fields: Dual address-line components Availability per engine Field name
Length
APD.DelType
APD.DelQual
Description
Aus
Can
U.S.
up to 100 Delivery Installation type—for example, “Stn” in “RR 2 Vancouver Stn Main.” The language (English or French) used in this field will be the same as the language used in the input record. Possible values: English PO Post Office RPO Retail Postal Outlet STN Station LCD Letter Carrier Depot CMC Community Mail Centre CDO Community Dealership Outlet French BDP Bureau de Poste CSP Comptoir Service Postal SUCC Succursale PDF Poste de Facteurs CPC Centre Postal Communautaire CC Concession Commerciale
—
X
—
up to 100 Delivery Installation Qualifier, such as “Main” in “RR 2 Vancouver Stn Main.”
—
X
—
Last-line components
IACE output fields: Last-line components Data types available per engine Field name
Length
Description
Aus
Can
Intl
Jpn
U.S.
AP.Last_Line
up to 100
Locality, region, and postal code together on one line.
X
X
—
X
X
AP.Local_Abr1
up to 100
The official 13-character abbreviation of the locality name, or the full spelling if the locality name is less than 13 characters (counting spaces).
—
X
—
—
X
AP.Local_Abr2
up to 100
The official 18-character abbreviation of the locality name, or the full spelling if the locality name is less than 18 characters (counting spaces).
—
X
—
—
—
AP.Local_Alt
up to 100
— Preserves the input locality if it is recognized by the postal authority as a locality name for this address. Misspellings are corrected. (The Assign City option has no effect on this field.)
X
—
—
X
94
Quick Reference for Views and Job-File Products March 2011
IACE output fields: Last-line components Data types available per engine Field name
Length
Description
Aus
Can
Intl
Jpn
U.S.
AP.Locality1
up to 100
Canadian and U.S. engines: The locality name preferred by the postal authority. (The Assign City option has no effect on this field.) Japan engine: Contains the city (shi) or island (shima) part of the address. Other engines: City, town, locality, or suburb.
X
X
X
X
X
AP.Locality2
up to 100
U.S. engine: Urbanization (Puerto Rican addresses only). Japan engine: Contains the ward (ku) part of the address. Other engines: Additional locality information.
X
—
X
X
X
AP.Locality3
up to 100
Additional locality information. Japan engine: Contains the district (machi) or Village (mura) part of the address.
—
—
X
X
—
AP.Locality4
up to 100
Japan engine: Contains the sub-district (aza, bu, chiwari, sen) part of the address.
—
—
—
X
—
AP.Postcode
up to 100
The complete postcode. Australian engine: Complete four-digit postcode. Canadian engine: Complete six-character postal code (FSA + LDU). International engines: Complete postal code. U.S. engine: Complete postal code (ZIP Code + ZIP4). Japan engine: Contains the 7-digit postal code part of the address.
X
X
X
X
X
AP.Postcode1
up to 100
Australian engine: Four-digit postcode. Canadian engine: First three characters (FSA) of the postal code. International engines: Postal code. U.S. engine: Five-digit primary postal code (ZIP Code). Does not include the four-digit secondary postal code (ZIP4). Japan engine: Contains the first 3-digits of the postal code in the Japanese address.
X
X
X
X
X
AP.Postcode2
up to 100
Secondary postal code. Canadian engine: Last three characters (LDU) of the postal code. U.S. engine: Four-digit ZIP4 code. On a mail piece, this code follows the primary postal code, with a hyphen placed between—for example, 54601-1234. Japan engine: Contains the last 4-digits postal code of the postal code in the Japanese address.
—
X
X
X
X
AP.Region
up to 100
State, province, territory, or region.
X
X
X
X
X
Chapter 4: International ACE
95
Components available for multiline input
IACE output fields: Components available for multiline input Data types available per engine Field name
Length
Description
Aus
Can
Intl
Jpn
U.S.
AP.Std_Line1-8
up to 61
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 addresses.
X
X
X
X
X
AP.Std_Line9-12
up to 61
See AP.Std_Line1 above.
X
X
—
X
X
Additional postal codes
IACE output fields: Additional postal codes Data types available per engine Field name
Length
Description
Aus
Can
Intl
Jpn
U.S.
AP.Chk_Digit
up to 100
Check digit for the delivery-point barcode, or for a fivedigit barcode if secondary postal code (ZIP4) could not be assigned.
—
—
—
—
X
AP.LOT
up to 100
Line-of-travel number.
—
—
—
—
X
AP.LOT_Order
up to 100
Line-of-travel sortation. A Ascending D Descending
—
—
—
—
X
AP.Sort_DelPt
up to 100
X Sorted delivery-point identification information. Australian engine: Eight-digit delivery point identifier. This is the primary component needed to generate a barcode. This component is not printed on mail pieces. International engine: Two-digit code returned for U.K. addresses (Two-digit DPS). U.S. engine: Two-digit DPBC code, which is one of the pieces of data needed to generate a delivery-point barcode.
—
X
—
X
AP.Sort_Route
up to 100
Carrier-route number.
—
—
—
X
96
Quick Reference for Views and Job-File Products March 2011
—
Codes that describe results
IACE output fields: Codes that describe results Data types available per engine Field name
Length
Description
AP.Addr_Lvr
2
A single character that indicates whether the address is a X Large Volume Receiver. T The address is an LVR. F The address is not an LVR.
AP.Addr_Type
2
The type of address:
AP.Asmt_Code
2
Aus
Can
Intl
Jpn
U.S.
X
—
—
X
BN
Building name
—
X
—
X
—
F G H L M O R
Firm General delivery High-rise building Large volume receiver (unique) Military Foreign Rural
X
X
X
—
X
P S X
Postal Street Unknown, or the address was unassigned
X
X
X
X
X
SR
Street/Rural
X
X
—
—
—
—
X
—
—
—
The result of the assignment process: V Address verified as-is. No changes made. C Some address components changed. N Address could not be assigned. F Non-Canadian address.
Chapter 4: International ACE
97
IACE output fields: Codes that describe results Data types available per engine Field name
Length
Description
AP.Asmt_Type
up to 100
The level to which International ACE could match the address to the data in the postal directories:
Aus
Can
Intl
Jpn
U.S.
BN
Building name
—
X
—
X
—
C F
Country Firm
X
X
X
—
X
L1
Locality 1
X
X
X
X
X
L2 L3 L4
Locality 2 Locality 3 Locality 4
—
—
—
X
—
O
Foreign
X
X
—
—
—
P
Postal code
X
X
—
X
—
PN PR
Primary name Primary range
X
X
X
X
X
R
Region
—
—
—
X
—
SR X
Secondary range Unknown, or the address was unassigned
X
X
X
—
X
AP.Cert_Match
2
Use this field to indicate the non-CASS option that was used in making the assignment. 0 The non-certified option was not chosen (the job was run using certification rules) or the Enable Non-certified Features option was not enabled. 1 Inexact ZIP move assignment. 2 Input ZIP+4 assignment.
—
—
—
—
X
AP.Eng_Used
10
The engine used to process this address. Aus Australia Engine Can Canada Engine Intl International Engine USA U.S. Engine JPN Japan Engine
X
X
X
X
X
AP.EWS_Match
2
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.
—
—
—
—
X
AP.Fault_Code
10
Address-fault code.
X
X
X
X
X
AP.Fault_Stat
10
Address-fault code if address is unassigned, or status code if address is assigned.
X
X
X
X
X
AP.LACS_Code
2
Locatable Address Conversion System indicator. T Address needs conversion from a box address to a street address. Submit address to a LACS vendor. F Address does not need conversion.
—
—
—
—
X
98
Quick Reference for Views and Job-File Products March 2011
IACE output fields: Codes that describe results Data types available per engine Field name
Length
Description
Can
Intl
Jpn
U.S.
AP.NC_Firm
Up to 60
The firm match that was made using the input ZIP+4 for — missing or invalid firm information.
—
—
—
X
AP.NC_Secaddr
Up to 60
The secondary address match that was made using the input ZIP+4 for missing or invalid secondary address information.
—
—
—
—
X
AP.NC_Srange
Up to 8 The secondary range match that was made using the input ZIP+4 for missing or invalid secondary range information.
—
—
—
—
X
AP.NC_Unit
Up to 10
The unit designator match that was made using the input — ZIP+4 for missing or invalid unit designator information.
—
—
—
X
AP.Pcode_Move
2
T
Address is affected by postal code realignment. A — new postal code and, if applicable, a new city name, were assigned. Address is not affected by realignment.
—
—
—
X
F
Aus
AP.Pcode_Type
2
— Type of primary postal code (ZIP Code): M Military U Unique (specific to a large firm) blank A blank field indicates an ordinary postal code, or that the postal code was not assigned.
X
—
—
X
AP.Route_Sort
2
— 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 International 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.
—
—
—
X
AP.Stat_Code
10
Address status code. X For all UK addresses, AP.Stat_Code will contain all zeros (000000000) because it is not a supported field for UK addresses.
X
X
X
X
AP.Qss_Dflt
2
Values are T or F. Indicates whether the record qualified as a default match rather than qualifying as a match at a higher level of assignment.
—
—
—
—
X
AP.RDI
1
The residential delivery indicator (RDI) that tells if the address is residential or nonresidential. Y Residential address N Nonresidential address RDI is an add-on feature.
—
—
—
—
X
Chapter 4: International ACE
99
DPV output components
The following output fields are available for reporting DPV processing results. You must set the DPV Mode to VALIDATE or BOTH to post information to these fields/ components.
IACE output fields: DPV output components Data types available per engine Field name
Length
Description
Aus
Can
Intl
Jpn
U.S.
AP.DPV_CMRA
2
Y The address is a valid Commercial Mail Receiving Agency (CMRA). N The address is not a CMRA. L This address triggered DPV locking. See “Delivery Point Validation Alert” in the Job Summary. blank This field is blank DPV processing is currently locked, or ACE can’t assign the input address.
—
—
—
—
X
AP.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. A1 Input address does not match to the ZIP+4 file. BB All input address components match to DPV. CC Input address primary number matches to DPV, but the secondary number does not match (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. M3 Input address primary number is invalid. N1 Input address primary number matches to DPV but the high-rise address is missing the secondary number. P1 Input address is missing the PO, RR, or HC Box number. P3 Input address is invalid PO, RR, or HC box number. RR Input address matches to CMRA. R1 Input Address is DPV matched to CMRA, but PMB number is not present. U1 Input address matches a unique address. Note: International ACE always posts the DPV footers in the same order and this field will not always be 12 characters in length.
—
—
—
—
X
100
Quick Reference for Views and Job-File Products March 2011
IACE output fields: DPV output components Data types available per engine Field name
Length
Description
Aus
Can
Intl
Jpn
U.S.
AP.DPV_Status
2
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 parsed 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 The address is recognized as a false-positive and triggered DPV locking. Blank This field is blank when the DPV mode is not enabled, DPV processing is currently locked, or IACE cannot assign the input address.
—
—
—
—
X
Other components
IACE output fields: Other components Data types available per engine Field name
Length
Description
Aus
Can
Intl
Jpn
U.S.
AP.Cntry_Name
up to 100
Fully spelled country name, in English.
X
X
X
X
X
AP.Cnty_Code
up to 100
Federal Information Processing Standard (FIPS) threedigit county code. Numbers are unique within states. You might use county information if you are preparing a presorted periodicals mailing.
—
—
—
—
X
AP.Cnty_Name
up to 100
Fully spelled county name. Note: In the U.S., county information is not included on mail pieces.
—
—
—
X
X
AP.Ctry_Alph2
up to 100
International engine: Two-character ISO code identifying the country.
X
X
X
X
X
AP.Ctry_Numrc
up to 100
International engine: Three-digit ISO code identifying the country.
X
X
X
X
X
AP.District
up to 100
District number for the U.S. House of Representatives.
—
—
—
—
X
AP.Extra1–12
up to 100
Any non address data found above or below the address data in the address block. Available only if the input data was presented through multiline fields.
X
X
X
X
X
Chapter 4: International ACE
101
IACE output fields: Other components Data types available per engine Field name
Length
Description
Aus
Can
Intl
Jpn
U.S.
AP.Fac_Type
up to 100
Type of postal facility. 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 P Post Office (main) S Station U Urbanization (Puerto Rico)
—
X
—
—
X
AP.FIPS_Code
up to 100
Federal code for state and county. Combines a two-digit state code and three-digit county code.
—
—
—
—
X
AP.Firm
up to 100
Firm name. Do not use this field if the input was multiline, because if there is no firm name in the postal directory, International ACE cannot reliably identify firm names from multilines. Note for Canadian and U.S. engines: If you retrieve the corrected component, the firm name is taken from the postal directory if found, otherwise taken from the input record. Be aware that the postal directory might contain some unusual or shortened spellings that you may or may not find suitable for printing on mail pieces. If you prefer to retain your own firm data, retrieve the original component.
—
X
X
—
X
AP.Newline
3
CRLF on Windows, LF on UNIX. Use this as the end-of- X record mark when posting to ASCII output files.
X
X
X
X
AP.Rec_No_Out
11
The output file record number.
X
X
X
X
X
AP.Record_No
11
The input file record number.
X
X
X
X
X
AP.Urban_Ind
up to 100
Indicates whether an address is urban. T The address is urban. F The address is not urban. blank The address did not assign and the postcode was not entered on input.
—
X
—
—
—
U.S. GeoCensus and Canada GeoCoding components
102
Quick Reference for Views and Job-File Products March 2011
IACE output fields: U.S. GeoCensus and Canada GeoCoding components Field name
Length
Description
U.S.
Can
AP.Ageo_Blk
10
U.S. Census tract and Block Numbering Area (BNA), in the format 123456.
X
AP.Ageo_Cty
3
FIPS county code.
X
AP.Ageo_Lat
10
Latitude (degrees north of the equator) in the format +12.123456.
X
X
AP.Ageo_Lng
11
Longitude (degrees east of the Greenwich Meridian) in the format +12.123456.
X
X
AP.Ageo_Pla
5
FIPS place code.
X
AP.Ageo_Sta
2
FIPS state code.
X
AP.Cgeo_Blk
10
U.S. Census tract and block-group number. The first six digits are the tract number, and the final digit is the block-group number within the tract. The MSA and block codes are used for matching to demographiccoding databases. To uniquely specify a census block-group within the entire country, combine the FIPS_Code and Geo_Blk fields.
X
AP.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.
X
AP.Cgeo_Lat
up to 100
Latitude (degrees north of the equator) in the format +12.123456.
X
X
AP.Cgeo_Lng
up to 100
Longitude (degrees east of the Greenwich Meridian) in the format +123.123456.
X
X
AP.Cgeo_MSA
up to 100
Metropolitan Statistical Area number. 0000 indicates the address does not lie in any MSA (usually a rural area).
X
Chapter 4: International ACE
103
IACE output fields: U.S. GeoCensus and Canada GeoCoding components Field name
Length
Description
U.S.
Can
AP.Geo_Match
up to 100
Match code indicating the precision of the latitude and longitude assignment.
X
X
U.S. engine: 0 Match in address level. 1 Nine-digit match. Usually indicates precision to a particular block face. 4 Seven-digit match. Usually indicates precision within a few blocks. 5 Five-digit match. Usually indicates precision to within a mile or two. 7 No match in Centroid-Level. 8 No match in Address-Level. 9 No match in Centroid-Level or Address-Level. Canada engine: 0 Match in Address-level. 1 Match in Centroid-level. 7 No match in Centroid-level. 8 No match in Address-level. 9 Both options tried, but no match in Address or Centroidlevel.
Informational Codes
The following countries and country categories are currently available in International ACE. All World Engine Austria Italy France Germany Portugal New Zealand South Africa United Kingdom
Component name
Length
Description
AP.Match_A
1
Displays the actual level of assignment for the record. 0 Country not determined. 1 Country level assignment. 2 Region level 3 Locality level assignment. 5 Primary name level assignment. 6 Primary range level assignment.
104
Quick Reference for Views and Job-File Products March 2011
Component name
Length
Description
AP.Match_P
1
Displays the potential level of assignment for the record. 0 Country not determined. 1 Country level assignment. 3 Locality level assignment. 5 Primary name level assignment. 6 Primary range level assignment.
APIC.Cntry_Name APIC.Firm APIC.Locality1 APIC.Locality2 APIC.Postal_Num APIC.Prim_Range APIC.Prim_Name1 APIC.Prim_Name2 APIC.Region APIC.Sec_Addr
1
Displays additional information about how International ACE assigned the corresponding field. 0 No further information available. 1 Assigned with the aid of the full Postcode. 2 Assigned with the aid of a partial Postcode. 5 Assigned and upgraded. 7 Exact match and not altered. 8 German Historical street data updated.
APIC.Full_Code
11
This field concatenates all components with additional information into one field. Here is the order in which the individual codes are displayed. APIC.Firm APIC.Sec_Addr APIC.Prim_Range APIC.Prim_Name1 APIC.Prim_Name2 APIC.Locality1 APIC.Locality2 APIC.Region APIC.Cntry_Name APIC.Postal_Num APIC.Postcode Note: See each individual field for a description of the displayed value.
APIC.Postcode
1
Displays additional information about how International ACE assigned AP.Postcode. 0 Component is not available or does not apply to current address. 1 Assigned Postcode is the default for the town. 2 Assigned Postcode is the default for the street. United Kingdom addresses only: 3 Postcode found in Royal Mail bulk recoding file when a Locality or County-level assignment was made. 4 Postcode found in Royal Mail bulk recoding file when a Street or Premise-level assignment was made.
Chapter 4: International ACE
105
Component name
Length
Description
APIS.Cntry_Name APIS.Firm APIS.Locality1 APIS.Locality2 APIS.Prim_Name1 APIS.Prim_Name2 APIS.Region APIS.Sec_Addr
1
Displays the level of assignment for the corresponding field. 0 Component is not available or does not apply to current address 1 Not assigned level 3. No possible match. 2 Not assigned level 2. Low potential match. 3 Not assigned level 1. Close match. 4 Assigned level 4. Component not found in input, but was added. 5 Assigned level 3. Satisfactory match. 6 Assigned level 2. Good match. 7 Assigned level 1. Exact match. 8 German addresses only: German Historical Street data assignment. 9 Component is available on input but cannot be validated.
APIS.Full_Code
11
This field concatenates all informational output components into one field. Individual codes are displayed in this order. APIS.Firm APIS.Sec_Addr APIS.Prim_Range APIS.Prim_Name1 APIS.Prim_Name2 APIS.Locality1 APIS.Locality2 APIS.Region APIS.Cntry_Name APIS.Postal_Num APIS.Postcode Note: See each individual field for a description of the displayed value.
APIS.Postal_Num
1
Displays the level of assignment for the AP.Postal_Num field. 0 No PO box information was available on input. 4 Finland addresses: More than one P. O. Box number match in the directory. 5 PO box information is not available for locality. 6 PO box information is available for locality, but the input PO box number is invalid. 7 PO box information is available for locality and the input PO box number is valid. 9 PO box information is available on input but cannot be validated.
APIS.Postcode
1
Displays the level of assignment for the AP.Postcode field. 0 Component is not available or does not apply to current address. 1 Input Postcode verified. 2 Input Postcode changed. 4 Postcode assigned. 8 Postcode is available in the directory but no address components match. 9 Postcode is available on input but cannot be validated.
APIS.Prim_Range
1
Displays the level of assignment for AP.Prim_Range. 0 The range is not found on input. 4 Insufficient input data; cannot choose between multiple street-level matches 6 The range is found on input but is not a match. 7 The range is found on input and is a match. 8 Insufficient input data; street level match occurred using partial range matching 9 The range is available on input but cannot be validated.
106
Quick Reference for Views and Job-File Products March 2011
International ACE address fault codes
IACE address fault codes Availability per engine Code
Description
Aus
Can
Intl
Jpn
U.S.
F101
Last line is bad or missing.
X
X
X
X
X
F212
No locality, postal code is bad. Japan engine: No locality and bad postal code.
X
X
X
X
X
F213
Bad locality, no postal code. Japan engine: No postal code and at least one of the localities is bad.
X
X
X
X
X
F214
Bad locality, bad postal code. Japan engine: Bad postal code and at least one of the localities bad.
X
X
X
X
X
F216
Bad postal code; can’t determine which locality to select.
—
—
X
—
X
F302
No primary address line.
X
X
X
—
X
F412
Street name not found in postal directory.
X
X
X
—
X
F413
Possible street-name matches are too close to choose one.
X
X
—
—
X
F420
Primary range is missing.
X
—
X
—
X
F421
Primary range is not valid for the street, route, or building.
X
X
X
—
X
F422
Predirectional needed; input is wrong or missing.
—
—
—
—
X
F423
Suffix needed; input is wrong or missing.
X
X
—
—
X
F425
Suffix and directional needed, input is wrong or missing.
X
—
—
—
X
F427
Postdirectional needed; input is wrong or missing.
X
X
—
—
X
F428
Bad postal code; can’t select an address match.
X
—
X
—
X
F429
Bad city; can’t select an address match. International engine: This is valid for UK addresses only.
X
—
X
—
X
F430
Possible address-line matches are too close to choose one.
X
X
X
—
X
F431
Puerto Rican urbanization needed; input is wrong or missing.
—
—
—
—
X
F432
Address conflicts with postal code, and the same street has a different postal code.
—
X
—
—
—
F433
The input postcode is in the directory, but the input street data is not in the directory. International engine: This is valid for U.K. addresses only.
—
X
X
—
—
F434
Street assignment was possible, there was a duplicate postal-code match.
—
X
—
—
—
F435
No street assignment, no postal code.
—
X
X
—
—
F436
No street assignment, postal code not matched.
—
X
—
—
—
Chapter 4: International ACE
107
IACE address fault codes Availability per engine Code
Description
Aus
Can
Intl
Jpn
U.S.
F437
Multiple match, different directory areas.
—
X
—
—
—
F438
Secondary address information is missing.
X
—
—
—
—
F439
Cannot assign an exact match in the EWS directory.
—
—
—
—
X
F440
Insufficient input data; cannot choose between multiple street-level matches.
—
—
X
—
—
F441
Insufficient input data; street level match occurred using partial-range matching.
—
—
X
—
—
F450
Unit missing or out of range.
—
X
X
—
—
F451
PO box missing or out of range.
—
X
X
X
—
F452
PO box disagrees with postal code. International engine: This is valid for Finland addresses only.
—
X
X
—
—
F453
More than one match found for unit, could not choose one.
—
X
—
—
—
F500
Other error
X
X
X
X
X
F501
Foreign address.
X
X
—
—
X
F502
Input record entirely blank.
—
—
—
X
X
F503
Postal code is not in area covered by partial postal-code directory.
—
—
—
—
X
F504
Overlapping ranges in postal directory.
—
—
—
—
X
F505
Matched to undeliverable default record. The generated undeliverable (F505) has no ZIP+4 listed, an invalid CART, and is flagged as undeliverable. (United States)
—
—
—
—
X
F600
Undeliverable.
—
—
—
—
X
blank
No error.
X
X
X
108
Quick Reference for Views and Job-File Products March 2011
X
International ACE address status codes In this table, “postal code” means POSTCODE1 and “secondary postal code” means POSTCODE2. For the U.S. engine, POSTCODE1 is the five-digit ZIP Code and POSTCODE2 is the four-digit ZIP4 code. The Japan Engine only populates the first digit. All other digits will be zero.
IACE address status codes Availability per engine Digit
Value Description
Aus
Can
Intl
Jpn
U.S.
1st
0
Regarding locality, region, postal code, and secondary postal code, there is no significant difference between the input data and the corrected data.
X
X
X
X
X
1
International ACE corrected or populated the postal code.
X
X
X
X
X
2
International ACE populated the locality/county.
X
X
X
X
X
3
International ACE corrected or populated the postal code and populated the locality/county.
X
X
X
X
X
4
International ACE populated the region.
X
X
X
X
X
5
International ACE corrected or populated the postal code and populated the region.
X
X
X
X
X
6
International ACE corrected the locality and region.
X
X
X
—
X
7
International ACE corrected the locality, region, and postal code.
X
X
X
—
X
8
International ACE corrected the secondary postal code.
—
—
X
—
X
9
International ACE corrected the postal code and secondary postal code.
—
—
X
—
X
A
International ACE corrected the locality and secondary postal code.
—
—
X
—
X
B
International ACE corrected the locality, postal code, and secondary postal code.
—
—
X
—
X
C
International ACE corrected the region and secondary postal code.
—
—
X
—
X
D
International ACE corrected the region, postal code, and secondary postal code.
—
—
X
—
X
E
International ACE corrected the locality, region, and secondary postal code.
—
—
X
—
X
F
International ACE corrected the locality, region, postal code, and sec- — ondary postal code.
—
X
—
X
0
Regarding suffix, directional, and primary name, there is no significant difference between the input data and the corrected data.
X
X
X
—
X
1
International ACE corrected the suffix (such as “Street” or “Lane”).
X
X
X
—
X
2
International ACE corrected the predirectional.
—
—
X
—
X
2nd
Chapter 4: International ACE
109
IACE address status codes Availability per engine Digit
3rd
110
Value Description
Aus
Can
Intl
Jpn
U.S.
3
International ACE corrected the predirectional and suffix.
—
—
X
—
X
4
International ACE corrected the postdirectional.
X
X
X
—
X
5
International ACE corrected the suffix and postdirectional.
X
X
X
—
X
6
International ACE corrected the predirectional and postdirectional.
—
—
X
—
X
7
International ACE corrected the predirectional, suffix, and postdirec- — tional.
—
X
—
X
8
International ACE corrected the primary name.
X
X
X
9
International ACE corrected the primary name and suffix.
X
X
X
—
X
A
International ACE corrected the predirectional and primary name.
—
—
X
—
X
B
International ACE corrected the predirectional, primary name, and suffix.
—
—
X
—
X
C
International ACE corrected the primary name and postdirectional.
X
X
X
—
X
D
International ACE corrected the primary name, suffix, and postdirec- X tional.
X
X
—
X
E
International ACE corrected the predirectional, primary name, and postdirectional.
—
—
X
—
X
F
International ACE corrected the predirectional, primary name, suffix, — and postdirectional.
—
X
—
X
0
Regarding unit designator, DPBC code, carrier-route number, and county number, there is no significant difference between the input data and the corrected data.
X
X
X
—
X
1
International ACE corrected the unit designator.
X
X
X
—
X
2
International ACE corrected the DPBC.
—
—
—
—
X
3
International ACE corrected the unit designator and DPBC.
—
—
—
—
X
4
International ACE corrected the CART.
—
—
—
—
X
5
International ACE corrected the unit designator and carrier-route number.
—
—
—
—
X
6
International ACE corrected the DPBC and carrier-route number.
—
—
—
—
X
7
International ACE corrected the unit designator, DPBC, and carrierroute number.
—
—
—
—
X
8
International ACE corrected the county number.
—
—
—
—
X
9
International ACE corrected the unit designator and county number.
—
—
—
—
X
A
International ACE corrected the DPBC and county number.
—
—
—
—
X
B
International ACE corrected the unit designator, DPBC, and county number.
—
—
—
—
X
Quick Reference for Views and Job-File Products March 2011
X
IACE address status codes Availability per engine Digit
4th
Value Description
Aus
Can
Intl
Jpn
U.S.
C
International ACE corrected the carrier-route number and county number.
—
—
—
—
X
D
International ACE corrected the unit designator, carrier-route number, and county number.
—
—
—
—
X
E
International ACE corrected the DPBC, carrier-route number, and county number.
—
—
—
—
X
F
International ACE corrected the unit designator, DPBC, carrier-route number, and county number.
—
—
—
—
X
0
Australian engine: Regarding level designator, there is no significant difference between the input data and the corrected data. Canadian engine: This digit is always 0 (zero). U.S. engine: Regarding line-of-travel number, line-of-travel order, and urbanization, there is no significant difference between the input data and the corrected data.
X
X
X
—
X
1
International ACE corrected the line-of-travel number.
—
—
—
—
X
2
International ACE corrected the line-of-travel order.
—
—
—
—
X
3
International ACE corrected the line-of-travel number and line-oftravel order.
—
—
—
—
X
4
International ACE corrected the Puerto Rican urbanization.
—
—
—
—
X
5
International ACE corrected the line-of-travel number and urbanization.
—
—
—
—
X
6
International ACE corrected the line-of-travel order and urbanization.
—
—
—
—
X
7
International ACE corrected the line-of-travel number, line-of-travel order, and urbanization.
—
—
—
—
X
8
International ACE corrected the level designator.
X
—
—
—
—
—
—
—
—
—
0
X Australian and U.S. engines: This digit is always 0 (zero). Canadian engine: Regarding dual address and delivery installation area, type, and qualifier, there is no significant difference between the input data and the corrected data.
X
X
—
X
1
International ACE corrected the dual address.
—
X
—
—
—
2
International ACE corrected the delivery installation area.
—
X
—
—
—
3
International ACE corrected the dual address and delivery installation area.
—
X
—
—
—
4
International ACE corrected the delivery installation type.
—
X
—
—
—
5
International ACE corrected the dual address and delivery installation type.
—
X
—
—
—
9, A-F Not used. 5th
Chapter 4: International ACE
111
IACE address status codes Availability per engine Digit
6th
112
Value Description
Aus
Can
Intl
Jpn
U.S.
6
International ACE corrected the delivery installation type area and type.
—
X
—
—
—
7
International ACE corrected the dual address and the delivery instal- — lation area and type.
X
—
—
—
8
International ACE corrected the delivery installation qualifier.
X
9
International ACE corrected the dual address and delivery installation qualifier.
—
X
—
—
—
A
International ACE corrected the delivery installation area and qualifier.
—
X
—
—
—
B
International ACE corrected the dual address and the delivery instal- — lation area and qualifier.
X
—
—
—
C
International ACE corrected the delivery installation type and qualifier.
—
X
—
—
—
D
International ACE corrected the dual address and the delivery instal- — lation type and qualifier.
X
—
—
—
E
International ACE corrected the delivery installation area, type, and qualifier.
—
X
—
—
—
F
International ACE corrected the dual address and the delivery instal- — lation area, type, and qualifier.
X
—
—
—
0
Australian: Neither a slash nor dash was added to the range. Canadian and U.S. engines: Neither the address line nor locality was truncated.
X
X
X
—
X
1
International ACE truncated the address line to make it fit into your output field.
—
X
—
—
X
2
International ACE truncated the locality to make it fit into your output field.
—
X
—
—
X
3
International ACE truncated both the address line and locality.
—
X
—
—
X
4
International ACE added a slash ( / ) to the range.
X
—
—
—
—
5
Not used.
—
—
—
—
—
6
Not used.
—
—
—
—
—
7
Not used.
—
—
—
—
—
8
International ACE added a dash ( - ) to the range.
X
—
—
—
—
9
Not used.
—
—
—
—
—
A
Not used.
—
—
—
—
—
B
Not used.
—
—
—
—
—
C
International ACE added both a slash and a dash to the range.
X
—
—
—
—
Quick Reference for Views and Job-File Products March 2011
IACE address status codes Availability per engine Digit
7th
Value Description
Aus
Can
Intl
Jpn
U.S.
D
Not used.
—
—
—
—
—
E
Not used.
—
—
—
—
—
F
Not used.
—
—
—
—
—
0
None of the conditions for this digit is true (if supported by the engine).
X
X
X
—
X
1
The postal code is unique to an organization that receives a large vol- X ume of mail.
—
—
—
X
2
The address has a military postal code.
—
—
—
—
X
3
The postal code is unique to an organization that receives a large vol- — ume of mail, and the address has a military postal code.
—
—
—
X
4
The input locality is equivalent to the output locality.
—
X
X
—
X
5
The postal code is unique to an organization that receives a large vol- — ume of mail, and every letter in the input locality also appears in the corrected locality.
—
—
—
X
6
The address has a military postal code and every letter in the input locality also appears in the corrected locality.
7
The postal code is unique to an organization that receives a large vol- — ume of mail, the address has a military postal code, and every letter in the input locality also appears in the corrected locality.
—
—
—
X
8
The input primary name is equivalent to the output primary name.
—
X
X
—
X
9
The postal code is unique to an organization that receives a large vol- — ume of mail and every letter in the input primary name also appears in the corrected primary name.
—
—
—
X
A
The address has a military postal code and every letter in the input primary name also appears in the corrected primary name.
—
—
—
—
X
B
The postal code is unique to an organization that receives a large vol- — ume of mail, the address has a military postal code, and every letter in the input primary name also appears in the corrected primary name.
—
—
—
X
C
The input primary name and locality is equivalent to the output primary name and locality.
—
X
X
—
X
D
The postal code is unique to an organization that receives a large vol- — ume of mail, every letter in the input locality also appears in the corrected locality, and every letter in the input primary name also appears in the corrected primary name.
—
—
—
X
E
The address has a military postal code, every letter in the input local- — ity also appears in the corrected locality, and every letter in the input primary name also appears in the corrected primary name.
—
—
—
X
X
Chapter 4: International ACE
113
IACE address status codes Availability per engine Digit
8th
9th
114
Value Description
Aus
Can
Intl
Jpn
U.S.
F
The postal code is unique to an organization that receives a large vol- — ume of mail, the address has a military postal code, every letter in the input locality also appears in the corrected locality, and every letter in the input primary name also appears in the corrected primary name.
—
—
—
X
0
Australian: None of the conditions for this digit is true. Canadian and U.S. engines: This digit is always 0 (zero).
X
X
X
—
X
1
The parsed region and postal code agree.
X
—
—
—
—
2
The parsed locality and postal code agree.
X
—
—
—
—
3
The parsed region and postal code agree, and the parsed locality and postal code agree.
X
—
—
—
—
4
The parsed thoroughfare and postal code agree.
X
—
—
—
—
5
The parsed region and postal code agree, and the parsed thoroughfare and postal code agree.
X
—
—
—
—
6
The parsed locality and postal code agree, and the parsed thoroughfare and postal code agree.
X
—
—
—
—
7
The parsed region and postal code agree, the parsed locality and X postal code agree, and the parsed thoroughfare and postal code agree.
—
—
—
—
8
The parsed locality and region agree.
X
—
—
—
—
9
The parsed region and postal code agree, and the parsed locality and region agree.
X
—
—
—
—
A
The parsed locality and postal code agree, and the parsed locality and region agree.
X
—
—
—
—
B
The parsed region and postal code agree, the parsed locality and postal code agree, and the parsed locality and region agree.
X
—
—
—
—
C
The parsed thoroughfare and postal code agree, and the parsed local- X ity and region agree.
—
—
—
—
D
The parsed region and postal code agree, the parsed thoroughfare and postal code agree, and the parsed locality and region agree.
X
—
—
—
—
E
The parsed locality and postal code agree, the parsed thoroughfare and postal code agree, and the parsed locality and region agree.
X
—
—
—
—
F
The parsed region and postal code agree, the parsed locality and postal code agree, the parsed thoroughfare and postal code agree, and the parsed locality and region agree.
X
—
—
—
—
0
Australian engine: The parsed thoroughfare and locality do not X agree and there is no significant change to the original address as defined by the postal authority. Canadian engine: This digit will be zero if there are not significant change to original address as defined by postal authority. U.S. engine and International engine: This digit is always 0 (zero).
X
X
Quick Reference for Views and Job-File Products March 2011
X
IACE address status codes Availability per engine Digit
10th
Value Description
Aus
Can
Intl
Jpn
U.S.
1
The parsed thoroughfare and locality agree.
X
—
—
—
—
2
Significant change to original address as defined by postal authority.
X
X
—
—
—
3
Both Value 1 and Value 2 are true.
X
—
—
—
—
4–9 A–F
Not used.
—
—
—
—
—
0-9 A-F
This digit is not currently used.
—
—
—
—
—
Chapter 4: International ACE
115
116
Quick Reference for Views and Job-File Products March 2011
Chapter 5: Match/Consolidate
This chapter contains input fields and output fields for Match/Consolidate Job File and Match/Consolidate Views. Input, key, and output fields are listed in alphabetical order. When a field is grouped together with other like fields, the order is based on the first field in the list. For more information on setting up jobs with these products, see the Match/ Consolidate Job File Reference or the Match/Consolidate Views online help. The items in this section are current through version 7.90c of Match/Consolidate.
Chapter 5: Match/Consolidate
117
Match/Consolidate input fields
Match/Consolidate input fields Field name
Length
Description
Example of data
PW.Address PW.Prim_Range PW.Predir PW.Prim_Name PW.PO_Box PW.RR_Number PW.RR_Box PW.Suffix PW.Postdir PW.Sec_Range
up to 60 up to 10 up to 9 up to 28 up to 9 up to 9 up to 9 up to 10 up to 9 up to 8
If your input data has discrete fields for these units of address data, use these PW fields for that data. Define all the fields you need for your matching strategy. Include any field used in matching or breaking.
1234 W Main St “1000” in 1000 Vine Street N, NE, North, Northeast Most often street name PO box number Rural-route number Rural-route box St, Ave, Street, Avenue N, NE, North Northeast Apartment or street no. only
PW.Unit PW.Pmb PW.City PW.State
up to 60 up to 14 up to 60 2
Can only be used with Extended Address Parsing.
Apt 5 1234 La Crosse WI
PW.AppBlnkPri
1
For suppression lists only. Determines whether Match/ Consolidate should apply blank priority to the suppression list’s match priority. Y Apply blank priority to this list’s match priority. N Do not apply blank priority to this list’s match priority. If the AppBlnkPri field is not defined, or if the first character is not Y or N, the default value in the Input List Defaults block is used.
PW.Birthdate
60
Birthdate
PW.Delete
1
* When processing non-dBASE files, you can use the Delete field to signal Match/Consolidate when a record is marked to be deleted (nondestructive). Match/Consolidate checks the Delete field to determine if the record is marked to be deleted. If the first character is an asterisk (*), the record is treated as deleted. If the first character is anything else, the record is not considered deleted.
PW.CART PW.County PW.Country
4 3 up to 60
Carrier route number. County code. Country name.
PW.Driv_Prior
3
Determines which record is the driver record in a break group. Match/Consolidate expects to find a value between 0 and 255 in this field, 0 being the highest priority. If the Driv_Prior field is not defined, or if the value in that field is not numeric or not between 0 and 255, the default value in the Input List Defaults block is used.
118
Quick Reference for Views and Job-File Products March 2011
1960/09/13
C124 020 Canada
Match/Consolidate input fields Field name
Length
Description
Example of data
PW.Driv_Salvg
1
For suppression lists only. Determines whether Match/ Consolidate should perform data salvaging on this suppression list. Y Perform data salvaging. N Do not perform data salvaging. If the Driv_Salvg field is not defined or if the first character is not Y or N, the default value in the Input List Defaults block is used.
PW.Firm or PW.Firm1
up to 60
If your database contains a discrete field for firm names, this is the PW field to use. Firm may contain firm names only. If you use this field, do not use the numbered Firm fields (Firm1 or Firm2).
Business Objects
PW.Firm1-2
up to 60
If your database contains one or two discrete fields for firm names, and if you are using Extended name, title, and firm parsing, then identify the field(s) with Firm1 and Firm2. If you use Firm, do not use these numbered Firm fields (Firm1 or Firm2).
Business Objects
PW.Firmline1–2
up to 60
If one or two fields of your database contain firm name and firm location data (for example, department, mail stop, or building number), identify that field (or fields) with Firmline1 (and Firmline2). The Extended name, title, and firm parsing process can parse firm names and firm location elements from the data. Note: If you use any Firm or Formulaic fields, you may not use FirmLine1-2.
Business Objects, Accounting Dept
PW.Firstpart1-2 PW.Lastpart1-2
up to 60
If your database separates names into two parts, and if you are using Extended name, title, and firm parsing, then use this combination of fields. Firstpart1–2 may be used for the prename, first name, and middle name for each of two names. Lastpart1–2 may contain last name, maturity postname, other postname, and title for two names. Note: If you use any discrete name fields, you cannot use FirstPart1 and LastPart1, but you can use FirstPart2 and LastPart2.
Mr. John B. Smith Jr., CPA, Accountant
PW.ID1-9
up to 10
The data in this field must be a positive integer. If your data contains a field that uses a value to uniquely identify records or groups of records, use this PW field to determine the largest value within that field. If you define ID1 in one input file’s definition file, then you should define it in all of the input files’ definition files. The value of the data in this field cannot exceed 4294967295.
ID1=“2345”
PW.Last_Line
up to 60
If your input data combines city, state, and ZIP Code data in one field, use Last_line to identify that field. In some cases, you may have to combine two or more input fields and define them as Last_Line.
La Crosse WI 54601-4051
Chapter 5: Match/Consolidate
119
Match/Consolidate input fields Field name
Length
Description
Example of data
PW.Line1–6
up to 60
If your database is a multiline type, in which the fields may contain name, title, firm, or address data, or some combination thereof, then you can use these fields to identify that floating data. If you use the Extended name, title, and firm parsing process, Match/Consolidate can parse name, firm, and/or address data from these fields. From these fields, Standard parsing does not parse names, titles, or firms—only addresses. If you use all 6 lines, you must include Last_Line within those 6 lines.
Any data
PW.List_ID
up to 254
If you want the records of this database to be members of a list, use this field to define that list. You can define this field with a constant (enclosed in quotation marks) or with field data (the database field name).
List_ID = “house_file” List_ID = DB.list_code
PW.List_NewID
3
Determines if an auto-generated list generates an AP.ID_INC_NO number. Yes generates the AP_ID_INC_NO for all dupe groups assigned to that list. No sets the increment number to zero for each dupe group in that list.
PW.List_Prior
3
Determines the list’s priority, which sorts records within dupe groups. Match/Consolidate expects to find a value between 0 and 999 in this field, 0 being the highest priority. If the List_Prior field is not defined, or if the value in that field is not numeric or not between 0 and 999, the default value in the Input List Defaults block is used.
PW.List_Srch
1
Duplicate records within the list are found according to the first character in the field. Y Search for dupes within this list. N Do not search for dupes within this list. If the List_Srch field is not defined, or if the first character is not Y or N, the default value in the Input List Defaults block is used.
PW.List_Type
1
The list type is assigned according to the first character in the field. N Normal P Suppress (or Purge) S Special If the List_Type field is not defined, or if the first character is not N, P, or S, the default value in the Input List Defaults block is used.
120
Quick Reference for Views and Job-File Products March 2011
Match/Consolidate input fields Field name
Length
Description
Example of data
PW.Merg_Purg1–0
up to 60
Merg_Purg1 = DB.gender These PW fields make it possible for you to use other than name, firm, and address-related data for breaking or matching. For example, your database may have a field for gender, upon which you may want to match. If so, define one of the Merg_Purgx fields for that gender database field, then complete the associated line in your Match/Consolidate job’s match criteria.
PW.Name_Firm1-6
up to 60
If an input field contains name data in some records but contains firm (company) data in other records, present the field to Match/Consolidate as Name_Firmx. Match/ Consolidate parses name and firm data from this field; any other data (including address data) is parsed as extra data. For example, name, title, firm name, and firm location data. Use Name_Firm1–6 to identify up to six of these fields. The Extended name, title, and firm parsing process can parse name, title, and firm data from these fields.
Mr. John B. Smith Jr., CPA Business Objects Mr. and Mrs David Zaiman
PW.Name_Line1–6
up to 60
If your database stored all name elements for a record as a single field and you are using Extended name, title and firm parsing, then you can use Name_Line1– Name_Line6 to identify the field(s). These fields may contain name or title data, or both. As an alternative, you can use Name_Line (above). In either case, the extended parsing process can parse names and titles from these fields. Do not mix Name_Line and the numbered Name_Line fields (Name_Line1–6).
Mr. John B. Smith Jr., CPA Mr. and Mrs. David Zaiman Tony Deets and Geoffrey Skipton
PW.Name_Line PW.Name_Line1
up to 60
If your database includes all the name elements stored as a single field or line, you can use either Name_Line or Name_Line1 to identify that field. However, Standard parsing does not parse titles from either Name_Line or Name_Line1. If you will be using Extended parsing, you can parse names and titles from these fields. Do not mix Name_Line and the numbered Name_Line fields (Name_Line1–6). Note: If you use discrete name fields or FirstPart1 and LastPart1, you cannot use Name_Line1 because the output Name_Line1 field is reserved for the discrete or partname data. Likewise, if you define FirstPart2 and LastPart2, you cannot use Name_Line2.
Mr. John B. Smith Jr., CPA Mr. and Mrs. David Zaiman Tony Deets and Geoffrey Skipton
PW.Phone
60
Telephone number
(608)-555-5555 61 7 4035 2170
Chapter 5: Match/Consolidate
121
Match/Consolidate input fields Field name
Length
Description
Example of data
PW.Pre_Name PW.First_Name PW.Mid_Name PW.Last_Name PW.Post_Name
up to 60
If your database contains discrete fields for name components, define those fields even if you are preparing a resident-type mailing. Match/Consolidate uses name data for matching in some situations. If your input files contain mismatching field names, you might want to define these PW fields, even if you are not going to use them for matching or breaking. You will then have common names for output posting.
Mr. John B. Smith CPA
PW.Prim_Name
up to 28
Standardized primary name (most often street name). Important: When the true street name includes a directional work (for example, North Ridge) this field may give you an incomplete street name (Ridge) because of USPS base-data patterns.
PW.Priority
up to 60
When Match/Consolidate prioritizes records within each Priority = “2” dupe group, some records may tie. One way to break the tie is to select a database field and use the value of that field to rank one record ahead of another. Define that field as the PW field Priority. Note: Match/Consolidate converts the field type to character. If you have a numeric field, pad the data with enough zeros to make the resulting numbers match your data.
PW.SSN
60
Social Security Number
111-22-3333
PW.Title1–6
up to 60
If you are using Extended name, title, and firm parsing, you can identify up to six title fields. These can contain titles only. As an alternative, you can use Title (above), but do not mix its use with these numbered PW fields. That is, if you use Title, do not use the numbered Title fields (Title1–6).
Accountant
PW.Title PW.Title1
up to 60
If your database includes a field for title data, use either Accountant Title or Title1 to identify that field. Only one title field is allowed when using Standard name, title, and firm parsing.
PW.ZIP PW.ZIP4 PW.ZIP10
5 4 10
If your input files contain mismatching field names, you 54601 might want to define these PW fields, even if you are not 4051 going to use them for matching or breaking. You will 54601-4051 then have common names for posting to your output file.
PW…
up to 60
Match/Consolidate can accept a large number of other PW fields not listed here. See “Index” on page 181. Match/Consolidate doesn’t necessarily process or use those other fields, but they are handy in posting or filters when you are working with files that don’t use the same field names.
122
Quick Reference for Views and Job-File Products March 2011
Phone = DB.account_no
Match/Consolidate input fields Field name
Length
Description
Example of data
user:fieldname
The length varies based on your application of the field.
You can define your own PW fields in your DEF file by user:phone = account_no using the “user” prefix. For example, if you define user:phone=telephone, you can post or construct filters for Phone as you would with any other PW field. Use this when you use two or more files that don’t have the same field names. You can create a user-defined field to better represent your matching strategy by adding them to the Match Criteria or Rule Definition block. This lets you give a userdefined field a unique name. User-defined fields are similar to Merg_Purg fields except that you can give the field a name that better represents your matching strategy. The following rules apply to user-defined fields: Valid names must be 1-10 characters long. Valid names must start with an alpha character. Remaining characters can be alphanumeric or an underscore, but must not contain dashes or spaces. Selecting the Upper Case Merg_Purg Fields parameter in the Matching Options block will upper case the userdefined and Merg_Purg key fields. Important: Do not name a user-defined field the same as an existing PW field. You must define user-defined fields in the DEF file before using them in the Match Criteria block.
Chapter 5: Match/Consolidate
123
Match/Consolidate key fields The following table lists all the Match/Consolidate key fields and the PW input fields used to populate the key fields in either NONE, STD or EXT parsing. The list is in alphabetical order by the key field name.
Match/Consolidate key fields
124
Key Field Name
Parsing (None)
Parsing (STD)
Parsing (Ext)
Birthdate
Birthdate
Birthdate
Birthdate
Firm
Firm
Firm Firm1
Name_Firm1-6 Firm Firm1-2 FirmLine1-2 Line1-12
Firmloc
Name_Firm1-6 Firmloc1-3 FirmLine1-2 Line1-12
Gender
Generated by parse
Phone
Phone
Phone
Phone
Pmb
Pmb
Address Line1-12
Address Line1-12
Po_Box
Po_Box
Address Line1-12
Address Line1-12
Postdir
Postdir
Address Line1-12
Address Line1-12
Predir
Predir
Address Line1-12
Address Line1-12
Prim_Name
Prim_Name
Address Line1-12
Address Line1-12
Prim_Range
Prim_Range
Address Line1-12
Address Line1-12
Sec_Range
Sec_Range
Address Line1-12
Address Unit Line1-12
Ssn
Ssn
Ssn
Ssn
Suffix
Suffix
Address Line1-12
Address Line1-12
Quick Reference for Views and Job-File Products March 2011
Match/Consolidate key fields Key Field Name
Parsing (None)
Parsing (STD)
Parsing (Ext)
Title
Title
Title Title1
Name_Line1-6 Lastpart1-2 Title Title1-6 Name_Firm1-6 Line1-12
City
City
Line1-12 Last_Line City
Line1-12 Last_Line City
Country
Country
Country
Country
Error_Code
Generated by parse
First_Name
First_Name
First_Name Name_Line Name_Line1
First_Name Name_Line Name_Line1-6 Firstpart1-2 Name_Firm1-6 Line1-12
Last_Name
Last_Name
Last_Name Name_Line Name_Line1
Last_Name Name_Line Name_Line1-6 Firstpart1-2 Name_Firm1-6 Line1-12
Mat_Post
Post_Name
Post_Name Name_Line Name_Line1
Post_Name Name_Line Name_Line1-6 Firstpart1-2 Name_Firm1-6 Line1-12
Merg_Purg1-0
Merg_Purg1-0
Merg_Purg1-0
Merg_Purg1-0
Mid_Name
Mid_Name
Mid_Name Name_Line Name_Line1
Mid_Name Name_Line Name_Line1-6 Firstpart1-2 Name_Firm1-6 Line1-12
Oth_Post
Name_Line Name_Line1-6 Lastpart1-2 Name_Firm1-6 Line1-12
Chapter 5: Match/Consolidate
125
Match/Consolidate key fields Key Field Name
Parsing (None)
Parsing (STD)
Parsing (Ext)
Pre_Name
Pre_Name
Pre_Name Name_Line Name_Line1
Pre_Name Name_Line Name_Line1-6 Firstpart1-2 Name_Firm1-6 Line1-12
Rec_Type
Generated by parse
RR_Box
RR_Box
Address Line1-12
Address Line1-12
RR_Number
RR_Number
Address Line1-12
Address Line1-12
State
State
Line1-12 Last_Line State
Line1-12 Last_Line State
Address
Address
Unp_Addr Unp_lline
126
Last_Line
ZIP
ZIP
Line1-12 Last_Line ZIP ZIP10
Line1-12 Last_Line ZIP4 ZIP10
ZIP4
ZIP4
Line1-12 Last_Line ZIP4 ZIP10
Line1-12 Last_Line ZIP4 ZIP10
Quick Reference for Views and Job-File Products March 2011
Match/Consolidate output fields
Match/Consolidate output fields Field name
Length
Description
AP.[Results.[Level.[M atchset.]]]
Use this AP field to simultaneously reference different match results, different levels, or Length different match sets. varies based on Use this AP format only with ADV matching. You can use any of the previous AP your fields with this format. applicaThe optional Results prefix indicates which match results to use. Valid values are STD, tion of REL, and ADJ. the field. The optional Level prefix indicates which match level to use. Valid values are levels defined in the current match set. The optional Matchset prefix indicates which match set to use. Valid values are a matchset defined in the current job file. Valid AP prefix combinations include: AP, AP.Results, AP.Results.Level, and AP.Results.Level.Matchset. If you use AP, then MCD uses the current match results, match level, and match set. If you use AP.Results, then MCD uses the current match level and match set. If you use AP.Results.Level, then MCD uses the current match set. MCD does not support AP.Level or AP.Matchset. MCD issues an error if you specify a match results, match level, and/or match set in the AP prefix that does not exist.
AP.Addr_Error
4
Error code for address parsing. E301 No address data. E302 Bad address data. blank Address was successfully parsed.
AP.ASuper_Cnt
3
Number of Super Lists defined in a job. 0 Unique record. 1 to 255 Number of Super Lists represented in the dupe group.
AP.ASuper_Name
20
Super List name for the Super Lists defined in a job.
AP.ASuper_No
3
Super List number (1 to 255), assigned from the sequence of Super List Description blocks in the job file. Super Lists that are not assigned to a Super List within a job and are not assigned a Super List number.
AP.Buyer_Cnt
4
This AP field holds the multi-buyer count of a record.
AP.File_No
3
File number (1 to 255), assigned from the sequence of Input File blocks in the job file.
AP.Firm_Error
4
Error code for firm parsing. E201 No firm data. blank Firm was successfully parsed.
Chapter 5: Match/Consolidate
127
Match/Consolidate output fields Field name
Length
Description
AP.Gender
1
The overall gender determination for the record. Note: Gender is assigned only when you choose Extended parsing. When using Standard name, title, and firm parsing, all records are unassigned (5). 0 High confidence that the name is male. 1 Some confidence that the name is male. 2 Name could be either male or female. 3 Some confidence that the name is female. 4 High confidence that the name is female. 5 One or more names could not be assigned any gender. 6 Two or more names; at least one male and at least one female. 7 Two or more names; all male. 8 Two or more names; all female. 9 Two or more names; at least one name’s gender was ambiguous. (Note: If at least one name is unassigned, the whole record is unassigned.)
AP.Group_Cnt
10
Dupe-group record count. 1 Unique record. 2 to 65535Number of records in the dupe group.
AP.Group_No
10
Dupe-group serial number. 1 to 4294967295 The number assigned to this dupe group. blank Unique record.
AP.Group_Ord
10
Dupe-group order: Indicates the position of the record in the dupe group. 0 A unique record. 1 A master dupe record. 2 to 65535 A subordinate dupe record.
AP.Group_Rank
1
Dupe-group rank: Identifies the rank of this record within its dupe group. M Master dupe. S Subordinate dupe. blank Unique record, not a member of any dupe group.
AP.Group_Type
1
Describes the dupe group of which the record is a member. M Multilist (the members of the dupe group came from more than one input list). S Single-list (all the members of the dupe group came from the same input list). P Purge (at least one of the members of the dupe group came from a suppression list). blank Unique record, not a member of any dupe group.
AP.ID_INC_NO
10
Stores a sequential number for records that belong to a list. Cannot exceed 4294967295.
AP.IntraOrd
1
Indicates the position of the list in the dupe group based on AP.IntraType. Multiple records from the same list receive the same IntraOrd number, because the number indicates the order of lists based on the first occurrence of each list within the dupe group. 0 A unique record. 1 A record from the first list in the dupe group. 2 to 65535A record from subsequent lists in the dupe group.
128
Quick Reference for Views and Job-File Products March 2011
Match/Consolidate output fields Field name
Length
Description
AP.IntraType
1
Evaluates the input list structure within a dupe group to determine if there are multiple records from the same list within a dupe group. M Identifies the first record representing an input list. S Indicates the input list is represented more than once. blank Unique record.
AP.LB_Prior
5
List Match Priority plus Blank Priority (0 to 65535) per job setup.
AP.List_Cnt
4
List count: the number of lists represented in the dupe group. 0 Unique record, not a member of any dupe group. 1 to 2000The number of lists in which the members of this dupe group were found.
AP.List_Name
20
List name from the Name parameter in the Input List Description block.
AP.List_No
4
List number (1 to 2,000), assigned from the sequence of Input List Description blocks in the job file. Identifies the list from which the record came. This is not the same as the PW field List_ID.
AP.List_Type
8
The type of list, from the Type parameter in the Input List Description block: NORMAL, SPECIAL, or SUPPRESS(ion).
AP.LL_Error
4
Error code for parsing last-line data. E401 No last-line data. E402 Invalid last line. E403 Foreign last-line data. blank Last line was successfully parsed.
AP.MatchRule
20
The name of the rule that was used in detecting the match. If AP.MatchType is R, then the AP.MatchRule reflects the deciding rule’s name, which is taken from the Rule Name parameter of the Rule Definition block. If AP.MatchType is any other value, then the AP.MatchRule is undefined and the output is blank.
AP.MatchScore
3
A number that indicates the score of a match. blank 0–100 If AP.MatchType equals R, then AP.MatchScore reflects the score of the rule detecting the match. If AP.MatchType equals W, then the AP.MatchScore reflects the overall weighted score. If AP.MatchType equals S, then the AP.MatchScore reflects a score determined with standard matching. If AP.MatchType is any other value, then the AP.MatchScore is undefined and the output is blank.
Chapter 5: Match/Consolidate
129
Match/Consolidate output fields Field name
Length
Description
AP.MatchType
1
A letter that indicates what caused a match. blank The record is unique D The record is a driver record in a match group. S A record that matched due to a standard matching match criteria. A A record that matched due to an extended matching auto match session. R A record that matched due to a rule in an extended matching rule match session. W A record that matched due to a weighted overall score in an extended matching rule match session. C A record that belongs to a match group of a Combine Match Set. E A record that matched due to a pre-compare Match/Consolidate custom function. O A record that matched due to a post-compare Match/Consolidate custom function.
AP.Max_ID1-9
10
1 to 4294967295. This holds the maximum value of the ID1 PW field.
AP.Name_Error
4
Error code for parsing name data. E101 No name data. blank Name was successfully parsed.
AP.Newline
1 or 2
on DOS, LF on UNIX. For posting to ASCII output files as an end-of-record mark. The output field should be named EOR.
AP.Num_Names
1
The number of individuals found in the input record (0 to 6). If more than 6 individuals are identified, the value is 6.
AP.Parse
1
The results of the attempt to parse address and last-line data. A Address line unparsed (last line okay). B Blank last-line data. F Foreign address. L Unparsed last line. blank Record was successfully parsed.
AP.Parse_Type
1
Type of input record. B Business record. R Residential record.
AP.Rec_No_Out
10
Record number from the output file (1 to 4294967295).
AP.Record_No
10
Record number from the input file (1 to 4294967295).
AP.SIntraOrd
1
Indicates the position of the super list in the dupe group based on AP.SIntraType. Multiple records from the same super list receive the same SIntraOrd number, because the number indicates the order of super lists based on the first occurrence of each super list within the dupe group. 0 A unique record. 1 A record from the first super list in the dupe group. 2 to 65535 A record from subsequent super lists in the dupe group.
AP.SIntraType
1
Evaluates the Super List structure within a dupe group to determine if there are multiple records from the same super list within a dupe group. M Identifies the first record representing a super list. S Indicates the super list is represented more than once. blank Unique record.
130
C L
R F
Quick Reference for Views and Job-File Products March 2011
Match/Consolidate output fields Field name
Length
Description
AP.Super_Cnt
3
Super List count. 0 Unique record. 1 to 255 Number of Super Lists represented in the dupe group.
AP.Super_Name
20
Super List name, from the Name parameter in the Super List Description block.
AP.Super_No
3
Super List number (1 to 255), assigned from the sequence of Super List Description blocks in the job file.
AP.Unique_No
10
A sequential number that uniquely identifies a record. Unique records are assigned a unique number. Matched records (that is, dupes) also are assigned a number; all members of the dupe group get the same value for AP.Unique_No. So in a sense, AP.Unique_No is a superset of AP.Group_No. 1 to 4294967295 The number assigned to the unique record or dupe group.
AP.Was_Output
1
Use this field to ensure that a record is not output to more than one output file. T indicates that the record has been written to an output file. F indicates that the record has not been written to an output file.
Chapter 5: Match/Consolidate
131
132
Quick Reference for Views and Job-File Products March 2011
Chapter 6: Presort
This chapter contains input fields and output fields for Presort Job and Presort Views. Fields are first listed by the type of information, and are followed by an alphabetical list. When a field is grouped together with other like fields, the order is based on the first field in the list. For more information on setting up jobs with these products, see the Presort Job File Reference or the Presort Views online help.
Chapter 6: Presort
133
Presort input fields Selection chart
This table may be helpful when you know what you need, but not the name for it. Once you know the name of the field you need, you can look up detailed information in the alphabetical listing that starts on the next page. Presort uses only postal codes to perform the presort itself; full address information is not needed. The set of fields that you must present to Presort depends on the type of mailing you want to prepare.
Presort input fields: Selection chart Type of data
Field description
Field name
Field description
Field name
Basic fields used for sorting mail
ZIP Code required for all presorts
PW.ZIP PW.ZIP10 PW.Last_Line PW.Line1–Line6
Enhanced Carrier Route Subclass, Standard, Periodicals
PW.LOT PW.LOT_Order PW.DPBC
Required for automation presorts
PW.ZIP4 PW.ZIP10 PW.Last_Line PW.Line1 –Line6
Walk-sequence preparation, Periodicals or Standard
PW.Walk_Seq PW.Firm_ID PW.Bus_Ind
PW.DPBC
Detect foreign records
PW.Country
Detect and process for- PW.Country eign records PW.Intl_Regn PW.City
Prepare firm bundles
PW.Firm_ID
Claim “in-county” postage discount
Advertising Percentage
PW.Ad_Pct
Multiple versions or editions
PW.Version_ID PW.Key_Code PW.Height PW.Wt_Oz PW.Wt_Lbs PW.Width PW.Thickness PW.Meter_Rate
Carrier-route presorts Periodicals Class
PW.CART PW.ZIP4
PW.County
Count paid subscribers PW.Subscriber Fields for multi- Multiple entry points ple-mailing jobs for destination entry
Dividing the job into segments
134
PW.Entry_ID
PW.Segment_ID
Quick Reference for Views and Job-File Products March 2011
Presort input fields: Selection chart Type of data
Field description
Other fields
Field name
Field description
Field name
Generate multiple cop- PW.Copies ies per input record
GCA Mail.dat, seed file
PW.Seed_ID PW.Key_Code
Deleted records in flat files
PW.Delete
Name Optimizer
PW.Priority
Overcome format differences among input files
PW.Name_Line1 PW.Title, PW.Firm PW.Phone, PW.SSN PW.Birthdate, PW.Gender PW.Address, PW.City, PW.State, and so on user:fieldname
Alphabetical listing of input fields
Presort input fields Field name
Length
Description
PW.Ad_Pct
6
The percentage of advertising in a Periodicals piece. If Presort detects a different advertising percentage, it creates a new version.
PW.Bus_Ind
1
The delivery type of each address in your walk-sequenced mailing. A Residential B Business C Primary Residential with Business. Presort will read this value, but will treat it as a residential value (A). D Primary Business with Residential. Presort will read this value, but will treat it as a business value (B). G General delivery
PW.CART
4
Represents the carrier-route-number and is required if your job includes at least one carrier-route presort scheme. Use our ACE program to append CART to your records.
PW.City
13 to 25
Periodicals only. This field is optional. Use for sorting foreign pieces. When Presort prepares foreign pieces, it sorts them first by PW.Intl_Regn, then by PW.Country, and finally by PW.City (if you have set up all three fields). If you have a discrete field for the city name, you could present it to Presort as PW.City. Example:Your DEF file entry might look like this: City = DB.City. Note: A discrete city-name field is required. For the purpose of sorting by foreign cities, Presort does not support parsing the city name from a last-line or multiline field.
PW.Copies
1 to 3
The number of copies when you mail more than one piece per database record. Presort generates multiple copies per input record according to this field. 0 or 1 Records should only receive one copy blank Records should only receive one copy You may use this field with or without firm packaging.
Chapter 6: Presort
135
Presort input fields Field name
Length
Description
PW.Country
up to 60
Contains the country name. US, U.S., USA, and so ondomestic address blank domestic address any other valueforeign record Note: Further processing of foreign records is possible in Periodicals Class only. See “PW.Intl_Regn” on page 137 and “PW.City” on page 135.
PW.County
3
Periodicals Class only The 3-digit county code used to determine if the mailing is eligible for the in-county discount.. Presort can help you determine which mail pieces are eligible for the In-County postage discount. First, use the ACE utility Show or ShowL to look up the FIPS county code of the post office(s) where you will enter your mailing. Use ACE to append the FIPS county code to your records. Use the ACE field AP.County, not AP.FIPSCODE. Then present that field to Presort as the PW field County. For example, your DEF file entry might look like this: County = DB.County In the Entry Point Description section of your job, be sure to set these two parameters: Take In-County Discount and County of Publication.
PW.Delete
1
When processing non-dBASE3 files, you can use the Delete field to signal Presort when a record is marked to be deleted (nondestructive). Presort checks the Delete field to determine if the record is marked to be deleted. If the first character is an asterisk (*), the record is treated as deleted. If the first character is anything else, the record is not considered deleted.
PW.DPBC
2
The delivery-point barcode field is required if: Your job includes at least one automation letter presort scheme. Your job includes the Standard Enhanced Carrier Route presort scheme. (Also see LOT and LOT_Order.) Your job includes Periodicals basic carrier rout rate mail, unless you are doing a true walk-sequence. You must present this code to Presort as a discrete field; Presort does not extract DPBCs embedded in a combined field. Use our ACE program to append DPBC to your records.
PW.Entry_ID
up to 60
For multiple entry points, Presort must link each input record to one entry point or another. Most users allow Presort to do this by ZIP Code range. For a few of our more sophisticated users, that approach is too simple. They preprocess the database to assign records to entry points by a more complex algorithm. To each record, they append a coded field that indicates the entry point. This field is then presented to Presort through the PW field Entry_ID. Both of these approaches are explained more fully in the Presort User’s Guide.
136
Quick Reference for Views and Job-File Products March 2011
Presort input fields Field name
Length
Description
PW.Firm_ID
up to 60
To form firm packages, Presort performs a rudimentary “duplicate detection,” searching for records that have the same value in Firm_ID. If matching records are found in the same ZIP Code, those mail pieces are placed in a firm package. To set this up, present your company-name field to Presort as the PW field Firm_ID. For example, your DEF file entry might look like this: Firm_ID = DB.Company Presort tests Firm_ID only for exact matches, so “Firstlogic” would not be placed in a firm package with “First Logic.” Clearly, consistent data entry is important. If firm names have not been typed consistently, we suggest using Match/Consolidate to detect matches and lay the foundation for firm packaging. The technique is explained in the Match/Consolidate manual.
PW.Force_SP
1
Use this field to mark the records that you want to force to the single-piece price. When this field contains any value, punctuation, letter, or number, the software will force the qualified record to the single-piece rate even if the Include Unqualified Pieces parameter is set to No. If the field is blank, the software will not use that piece for the Force Single Piece rate. Note: This field only applies to First Class, Standard Mail Letter, and Flat. This field will be ignored for other classes or shapes. Presort offers another way to set up multiversion mailings. It is designed for users who have very complex pieces, such as account statements with selective inserts. If you select this method, you will need a program to preprocess your database and append piecedimension fields to each record. The approach is explained in the Presort User’s Guide.
PW.Height PW.Width PW.Wt_Oz PW.Wt_Lbs PW.Thickness PW.IMB_CRID
up to 12
The Customer Registration Identification (CRID) number. This enables you to Identify a mail owner by the Customer Registration Identification (CRID) number for each version. Note: This field is only used for mail.dat.
PW.IMB_MID
6 or 9
Use this field to set the Mailer ID that appears in the Piece IM barcode for each record. This field allows you to use different Mailer IDs across the entire job.
PW.IMB_Serial
6 or 9
Use this field to set the serial number that appears in the Piece IM barcode for each record. Note: Presort does not do anything to prevent repeated values. For example, if a Presort job produces over 99,999 trays, Presort does not issue a warning. Note that serial numbers on the output records are not be in sequential order.
PW.Intl_Regn
up to 60
This field is optional. Some users have, in their foreign records, a field that indicates an international mailing vendor, or perhaps a continent or other geographical unit larger than country. If you have such a field, you could present it to Presort as the PW field Intl_Regn. When Presort prepares foreign pieces, it sorts them first by Intl_Regn, then by Country, and finally by City (assuming you have set up all three fields).
PW.Key_Code
up to 60
If your job involves multiple versions or editions, then it is possible that two or more versions might be mailed to the same seed name. Your Mail.dat seed file is supposed to contain one record for each combination of seed name and version—in effect, one record per seed piece. Key_Code is a field for the version code. It works much like Version_ID. In fact, you might very well use the same database field for both purposes. For example, your DEF file entries might look like this: Version_ID = DB.EDITION Key_Code = DB.EDITION
Chapter 6: Presort
137
Presort input fields Field name
Length
Description
PW.LOT PW.LOT_Order
4 1
Line-of-Travel number. Line-of-Travel sortation: A ascending D descending. LOT codes are required for nonautomated, CART presorting in Standard Mail, Enhanced Carrier Route Subclass, when density is below 125 pieces per route and the file is not walk-sequenced. It is also required for Periodicals basic carrier route rate mail, unless you are doing a true walk-sequence. LOT codes enable Presort to prepare letters or flats in near walk sequence. Use our ACE program to append LOT codes to your records. You need both fields.
PW.Mail_Class
The mail class. If your current jobs are set up for auto dimension, add this field in your definition file and then populate the mail class in your database. Valid values for this field are: PER or 2 Periodicals STD or 3 Standard mail
PW.Meter_Rate
The Meter_Rate field is an optional method for handling postage. Some of our customers preprocess their mailing lists to determine (among other things) the postage amount that will be metered on each piece. Note that the postage amount must be in cents, not dollars (for example, use 24.9, not 0.249). If you have such a field, you could present it to Presort through the PW field Meter_Rate. For example, your DEF file entry might look like this: Meter_Rate = DB.POSTAGE In a co-mailing situation, you might be processing two databases for two different clients. If your clients want their pieces metered at two different rates, you will need Meter_Rate. In this case you probably don’t have a database field for postage. So instead, you set up Meter_Rate based on constant values. Your DEF file setup might look like this: Client #1 Client #2 Database name: bill.dbf jane.dbf DEF file name: bill.def jane.def DEF file entry: Meter_Rate = “25” Meter_Rate = “23” To activate this feature, you must also set a parameter in your Presort job: In the Mailing Information section, set Postage Payment Method = MULTI METER. This will signal Presort to use the Meter_Rate field.
138
Quick Reference for Views and Job-File Products March 2011
Presort input fields Field name
Length
Description
PW.PLANET
11 or 13
A field containing a numeric PLANET code. There are two types of PLANET codes: destination and origin. A destination PLANET code consists of: The destination service code (two characters): 22 Residual mail 40 First Class letters 41 First Class flats 42 Standard letters 43 Standard flats 44 Periodical letters 45 Periodical flats 46 First Class cards 47 Standard cards Your account ID that was assigned to you by CONFIRM (five characters). Mail piece information that is the same on each piece in the mailing (four characters). Note: Presort calculates a one-digit check digit, which is included in the output field AP.CONFIRM. (See “AP.CONFIRM” on page 146) An origin PLANET code consists of: The origin service code (two characters): 21 Residual mail 50 Courtesy reply letters 51 Courtesy reply flats 52 Business reply letters 53 Business reply flats 54 Business reply cards 56 QBRM letters 57 QBRM cards 58 Courtesy reply cards Mail piece information that is unique on each piece in the mailing (nine characters). Note: Presort calculates a one-digit check digit, which is included in the output field AP.CONFIRM. (See “AP.CONFIRM” on page 146.)
PW.Priority
up to 60
In Name Optimizer jobs, you may use the Priority field to guide selection of records from Expire or Add files. See the Name Optimizer guide for instructions.
PW.Prt_PLANET
1
A field that designates whether a mail piece receives a PLANET barcode. If your database contains a field that indicates if a piece should have a PLANET barcode, include the Prt_PLANET field in your definition file. When this field contains any value, punctuation, letter, or number, it is included in the CONFIRM processing. A blank field indicates that the piece is not to be included in CONFIRM, and it will not receive a PLANET barcode. You must also include PLANET in your definition file and AP.CONFIRM in your output file.
Chapter 6: Presort
139
Presort input fields Field name
Length
Description
PW.RAE_ID
Up to 60
Ride-Along ID field. This field is to be used when you turn on the auto-dimension feature. It assigns the ride-along ID with each new version created. Example: In a definition file, associate the RAE_ID field with a version code or ride-along code from your input file. Here's an example of a definition file entry: RAE_ID = DB.RAE_Code Version_ID = DB.Edition+DB.RAE_Code These entries would make Presort automatically create a new version for each different ride-along going with the Periodicals piece. Information from the Version Defaults block would be used for the version specifics, and Presort would assign the Version_ID as the name of the version. The way the definition file is set up, the ride-along ID would be a part of the version name.
PW.Rate_Cat
1
Takes the mail piece rate category from the input file and assigns it one of these values: A Science of Agriculture rate B Bound Printed Matter rate C Classroom (discounted Outside County) rate E Commercial Plus (1C Parcel) L Library rate M Media Mail rate N Non-profit (discounted Outside County) rate P Parcel Post/Parcel Select rate R Regular (Outside County) rate Note: Presort will only look at the first character in the database field when assigning rate categories.
PW.Seed_ID
up to 60
The Graphic Communication Association (GCA) sets the Mail.dat standard for data interchange among printers, publishers, service bureaus, and the USPS. The Mail.dat standard was revised early in 1997. Please refer to the GCA documentation for information about Mail.dat. The 1997 standard calls for, among other changes, an additional file, called the seed file. This file is to contain one record per piece mailed to a seed name. If your mailing list includes seed names, you should have a field that contains a unique identifier, usually a number, on each seed record. In ordinary records, this field should be blank. Present your seed-number field to Presort through the PW field Seed_ID. For example, your DEF file entry might look like this: Seed_ID = DB.SEED
PW.Segment_ID
31
The Segmenting feature is a way to break up your job into separately documented mailings. You may segment by any criteria that serves your needs. You will need a database field, coded to indicate in which segment each record should be placed. Present your field to Presort as the PW field Segment_ID. Read more about segmenting in the Presort User’s Guide.
PW.SRVC_Type
3
Use this input field to set the service(s) desired for a particular record. This field allows you to have different services (Confirm, address change, and so on) for each record. Note: Presort does not consider this value when defining new versions in jobs that use auto dimensions and auto versions.
140
Quick Reference for Views and Job-File Products March 2011
Presort input fields Field name
Length
Description
PW_Sub_Opt
1
Gets the piece’s subscriber option from the input file or the version default. A Assume all. All input records assumed to be subscribers. N Assume note. All input records assumed to be nonsubscribers. U Count under. All nonsubscriber input records assumed to be under the 10 percent limit (using the PW.Subscriber field). O Count over. All nonsubscriber input records assumed to be over the 10 percent limit (using the PW.Subscriber field).
PW.Subscriber
1
Periodicals Class only: To qualify for special postage rates, some mailers are required to count and report the percentage of copies going to subscribers. Presort can do this count for you. The results will appear on your Presort Job Summary report. You may have a field in your database that indicates whether the person is a subscriber. This field should be blank for nonsubscribers; for subscribers it may contain any punctuation mark, letter, or number you like. If the underlying database field is a Logical-type field, then a True value indicates a subscriber, and a False value indicates a non-subscriber. Present your field to Presort as the PW field Subscriber. For example, your DEF entry might look like this: Subscriber = DB.Sub. You must also set a parameter in the Version block section of your Presort job: Subscriber Option = COUNT_OVER or COUNT_UNDER.
PW.Thickness
Refer to PW.Height.
PW.Version_ID
up to 60
To support multi-version mailings, you may have a database field for the version or edition. Typically, this field would contain a code or number to indicate which version or edition each person should receive. If your records include such a field, present it to Presort through the PW field Version_ID. For example, your DEF file entry might look like this: Version_ID = DB.Edition_Code
PW.Ver_Name
up to 31
The version description. For auto dimension jobs only, you can use this field input field to define a version description. This description is independant of what is defined in the PW.Version_ID input field.
PW.Walk_Seq
5
You may need the Walk_Seq field for walk-sequence jobs at the 125-piece or saturation rate. This PW field corresponds to the Computerized Delivery Sequence (CDS) field Delivery Sequence Number (see “PW.Bus_Ind” on page 135). See PW.Height.
PW.Width PW.Wt_Oz PW.Wt_Lbs PW.ZIP or PW.ZIP10 or PW.Last_Line or PW.Line1 – Line6
5 10 up to 60 up to 60
The ZIP Code is required for any Presort job. Most users have a discrete ZIP field (so their DEF entry is simply ZIP = DB.ZIP). Otherwise, Presort can extract ZIP Codes that are embedded in— A 10-digit field that combines ZIP, hyphen, and ZIP+4; for example: ZIP10 = DB.ZIP10. (Note that the hyphen is required. Presort doesn’t accept nine consecutive digits.) A field that combines city, state, and ZIP; for example: Last_Line = DB.City_St_ZIP A multiline layout in which the ZIP appears “somewhere” in an array of free-form fields.
Chapter 6: Presort
141
Presort input fields Field name
Length
Description
PW.ZIP4 or PW.ZIP10 or PW.Last_Line or PW.Line1 – Line 12
4 10 up to 60 up to 60
If your job includes at least one automation presort scheme, the ZIP+4 field is required. Most users have a discrete ZIP+4 field. Otherwise, Presort can extract ZIP+4 codes that are embedded in combined fields. See the discussion of ZIP, above. Note: The ZIP+4 code “∅∅∅∅” is invalid. Presort checks for this value and suppresses it. Any record containing a ZIP+4 of “∅∅∅∅” will be treated as if it contained no ZIP+4 at all.
PW…
up to 60
Presort can accept a large number of other PW fields not listed here. See the index for a list under PW. Those fields may be handy in output posting or in filters when you are working with files that don’t use the same field names. (If you have only one input file, or if you convert all files to a standard format, there may be no reason to set up those extra PW fields.)
user:fieldname
142
You may define your own PW fields by using the prefix “user:” in your DEF file. For example, if you define “user:Status = DB.STATUS”, then you can work with Status as you would use any other PW field, in posting or filters. This is handy when you are working with files that don’t use the same field names.
Quick Reference for Views and Job-File Products March 2011
Presort output fields Selection chart
This table may be helpful when you know what you need, but not the name for it. Once you know the name of the field you need, you can look up detailed information in the alphabetical listing that starts on the next page. Presort uses only postal codes to perform the presort itself; full address information is not needed. The set of fields that you must present to Presort depends on the type of mailing you want to prepare.
Presort output fields: Selection chart Type of data
Field description
Required for Top line package, container, and pallet labels Middle line
Optional info about packages
Other fields
Optional info about trays and sacks
Field name
Field description
Field name
AP.Dest_Line AP.Dest_CS AP.Dest_ZIP
Barcode
AP.Contents AP.Ctn_Barcd
AP.Cont_Line AP.Cont_Nompc AP.Cont_Pc
Trays only
AP.Zebra_Req
Bottom line
AP.Orig_Line
Dimensions
AP.Pkg_Thk AP.Pkg_Wt
Numbering
AP.Pkg_No_Abs AP.Pkg_No_Ctn AP.Pkg_No_Mlg AP.Pkg_No_Plt AP.Pkg_No_Rel
Break marks
AP.Pkg_Brk_F AP.Pkg_Brk_FL AP.Pkg_Brk_L
Postage category
AP.Pkg_Rate
Sort level and destination
AP.PkgDestZip AP.Pkg_Level
Simplified addressing
AP.Opt_Endrs AP.Opt_En_Txt
Number of pieces
AP.No_Pcs
Class of mail
AP.Class
End-of-record mark
AP.Newline
Postage
AP.Postage AP.Dest_Rate
Dimensions
AP.Ctn_Size AP.Ctn_Type AP.Ctn_Vol AP.Ctn_Wt
Numbering
AP.Ctn_No_Abs AP.Ctn_No_Mlg AP.Ctn_No_Plt AP.Ctn_No_Rel
Break marks
AP.Ctn_Brk_F AP.Ctn_Brk_FL AP.Ctn_Brk_L
Postage
AP.Ctn_Rate AP.Zone
Sort level and destination
AP.CtnDestZip AP.Ctn_Level
Trays only
AP.Ctn_Fill AP.Tray_Prep AP.Zebra_Req
Number of...
AP.No_Pcs AP.No_Pkgs
Chapter 6: Presort
143
Presort output fields: Selection chart Type of data
Field description
Field name
Field description
Field name
Optional info about pallets
Separate pallets from containers
AP.Pallet
Number of...
AP.No_Pcs AP.No_Pkgs AP.No_Ctn_Plt AP.No_Pkg_Plt
Dimensions
AP.Plt_Vol AP.Plt_Wt
Numbering
AP.Plt_No_Abs AP.Plt_No_Mlg AP.Plt_No_Rel
Break marks
AP.Plt_Brk_F AP.Plt_Brk_FL AP.Plt_Brk_L
Destination
AP.ZIP_Range AP.Zone
Sort level and destination
Ap.Dest_Cs_Ab AP.Dest_ZIP_C AP.PltDestZip AP.Plt_Level
Discounts
AP.Coplt_Dis
Keylines
AP.ACS_Code
Postnet barcode
AP.Prt_Req_BC
AP.ACS_Key AP.Mailing_ID AP.Manfst_Key AP.No_Pcs_Ctn
Endorsements
AP.Cart_Endrs AP.Opt_Endrs AP.Rate_Endrs
AP.No_Pcs_Lbl AP.No_Pcs_Pkg AP.No_Pcs_Plt
Multiple versions or editions
AP.Ver _Name AP.Ver_No
Keylines, cont.
AP.Pc_No_Abs AP.Pc_No_Ctn AP.Pc_No_Mlg AP.Pc_No_Pkg AP.Pc_No_Plt AP.Pc_No_Rel AP.Ver_Wt
Trace back to database record
AP.File_No AP.Record_No
Periodicals
AP.Issue_Date AP.RAE_Name AP.RAE_ID AP.RAE_Wt AP.RAE_Thk
Name Optimizer
AP.Add_Type
Postage
AP.Piece_Rate AP.Zone
Optional fields for address labels or mail/ merge documents
Optional fields for address labels or mail/ merge documents, cont.
144
Quick Reference for Views and Job-File Products March 2011
Presort output fields: Selection chart Type of data
Field description
Field name
Field description
Field name
Optional info about multiple mailings
Multiple versions or editions
AP.Ver _Name AP.Ver_No AP.Bind_Name AP.Bind_No
Multiple entry points
AP.Ent_Pt_CSZ AP.Ent_Pt_Nam AP.Ent_Pt_No
Multiple schemes
AP.Scheme_No
AP.Dest_Rate
Segmenting
AP.Seg_Name AP.Seg_No
Alphabetical list of output fields
Presort output fields Available for output-file types Field name
Adr
AP.ACS_Code
Pkg Ctr
Length
Description
A
up to 9
Address Change Service participant code. Taken from your ACS/Mailer ID Code entry in the Version Description.
AP.ACS_Key
A
up to 21
ACS keyline, from data entered in the Version Description. Includes pad, check digit, and framing pound signs (#).
AP.Add_Type
A
1
For Name Optimizer jobs only. Indicates the source of a mail piece: A Record came from an Add file. D Piece was added by the Duping procedure. E Record came from an Expire file. blank Record came from an ordinary input file.
AP.Adr_BC_Min
A
2
Minimum Postnet barcode required on the piece (as a number of digits, not counting the check digit): 11 Piece is in an automated-letter scheme; it must bear a full delivery-point (11-digit) barcode. 9 Piece is in an automated-flat scheme; it must bear at least a ZIP+4 (9-digit) barcode. 5 Presort-rate pieces in co-sacking schemes. 0 Piece is a carrier-route or regular (nonautomated) scheme, and no Postnet barcode is required.
AP.Adr_BC_dgt
A
11
The number of digits that represent the address barcode. This value can be 0, 5, 9, or 11 digits. It represents the ZIP, ZIP+4, and the DPBC digits that Presort obtained from the input record. This field can be used as input to Label Studio.
AP.Adr_BC_Max
A
2
Maximum Postnet barcode that may be printed on the piece. The value posted is always 11.
AP.Bind_Name
A
up to 31
Bindery name, as entered on the Bindery Name line of the Version Description block.
P
C
Plt
Chapter 6: Presort
145
Presort output fields Available for output-file types Field name
Adr
Pkg Ctr
AP.Bind_No
A
P
AP.CART_Endrs
Length
Description
up to 5
Bindery number (1 to 32500), according to the sequence of Bindery Name entries in Version Description blocks in the job file.
A
up to 20
Carrier-route endorsement; identifies carrier route, rural route, and so on, and whether walk-sequenced. **C-001 Periodicals, carrier route. **WSH**C-001 Periodicals, walk-sequence high-density. **WSS**C-001 Periodicals, walk-sequence saturation. **ECRLOT**C-001 Standard Mail (S) Enhanced Carrier Route, regular rate, LOT sorted. **ECRWSH**C-001 Standard Mail (S) Enhanced Carrier Route, walk-sequence high-density. **ECRWSS**C-001 Standard Mail (S) Enhanced Carrier Route, walk-sequence saturation.
AP.CART_Pkg
A
1
Y N
AP.Class
A
1
Class of mail: 1 First Class Mail. 2 Periodicals Class. 3 Standard Mail. 4 Package Services.
AP.CONFIRM
A
12 or 14
CONFIRM (Computerized Online Notification for In-Bound and out-bound Reply Mail) contains the full PLANET code from the input file, plus a check-digit calculated by Presort. You can only use the AP.CONFIRM field with the address output file. Your output will be 12 or 14 bytes based on your input in PW.PLANET. If you input 11 bytes, the output will be 12 bytes. If you input 13 bytes, your output will be 14 bytes.
P
Plt
C
C
P
The piece is in a carrier-route package. The piece is not in a carrier-route package.
AP.Cont_Line
C
P
34
Contents line for container and pallet labels. Describes class, piece type, and preparation (for example, STD FLTS 5D BC). In Presort output files, the Mail-Processing Code (if applicable) is right-aligned.
AP.Cont_Nompc
C
P
27
Contents line for container and pallet labels. Describes class, piece type, and preparation (for example, STD FLTS 5D BC).
AP.Cont_Pc
C
P
8
Contains the container processing code, right-aligned.
AP.Contents
C
3
USPS contents identifying number (CIN), identifying the mail class and type. Used in generating the container barcode.
AP.Ctn_Barcd
C
8 sack 10 tray
Container barcode; the number on which sack- or tray-label barcodes are based. For sack presorts, this field combines destination ZIP and contents codes. Another two bytes are added if the container type is tray. This additional portion is called the proxy. For trays containing automated mail, the proxy is “Ø1”; for nonautomated trays, it is “Ø7”.
146
Quick Reference for Views and Job-File Products March 2011
Presort output fields Available for output-file types Field name
Adr
Pkg Ctr
AP.Ctn_BC_Req
Plt
C
Length
Description
1
Y N
This sack or tray label must include a barcode. A barcode on this sack or tray label is optional.
AP.Ctn_Brk_F
A
P
1
Container break mark. Also see AP.Pkg_Brk_F and AP.Plt_Brk_F. # First piece or package in the container. blank Other piece or package.
AP.Ctn_Brk_FL
A
P
1
Same values, but the first and last pieces or packages are marked.
AP.Ctn_Brk_L
A
P
1
Same values, but only the last piece or package is marked.
AP.Ctn_Charge
A
P
6
The container rate charge.
AP.CtnDestZip
A
5
Destination ZIP Code for the container in which this piece was included. Notes: This is the ZIP where the container is destined—where it will be opened and worked—not where it is entered. When the ZIP is only 3 digits, the field is left-aligned and right-padded with spaces.
AP.Ctn_Fill
A
1
Degree of fullness in letter trays: F Full container. O Overflow (partial container mailed with at least one full container). U Underfilled (individual partial container). blank Container is a flats tray, sack, or pallet.
P
C
C
P
Chapter 6: Presort
147
Presort output fields Available for output-file types Field name
Adr
Pkg Ctr
AP.Ctn_Level
A
P
AP.Ctn_No_Abs
A
AP.Ctn_No_Mlg
Length
Description
C
4
Container sortation level. Also see AP.Pkg_Level and AP.Plt_Level. 3DG 3-digit 3DGS 3-digit scheme 3DGU Unique 3-digit city 5DG 5-digit 5DGS 5-digit Scheme AADC Automated ADC ADC Area Distribution Center ASF Auxiliary Service Facility CR5 5-digit carrier route CR5S 5-digit Scheme CART CRD Direct carrier route CTY Multi-ZIP city FRM Firm M5D Merged 5-digit M5DS Merged 5-digit scheme MAAD Mixed AADC MADC Mixed ADC MNDC Mixed NDC NDC Network Distribution Center RES Residual SCF Sectional Center Facility SGL First Class single piece blank Nonpresort or unqualified
P
C
up to 6
Absolute container number (1 to 999999), no matter how General Output is set up.
A
P
C
up to 6
Container number within the mailing, no matter how General Output is set up.
AP.Ctn_No_Plt
A
P
C
up to 6
Container number within the pallet, no matter how General Output is set up.
AP.Ctn_No_Rel
A
P
C
up to 6
Container number per the numbering system chosen in General Output. Not affected by Mailflow.
AP.Ctn_No_Seg
A
P
C
up to 6
Container number within the segment, no matter how General Output is set up.
148
Plt
Quick Reference for Views and Job-File Products March 2011
Presort output fields Available for output-file types Field name
Adr
Pkg Ctr
AP.Ctn_Rate
A
P
AP.Ctn_Rt_Cat
A
AP.Ctn_Size
AP.Ctn_Type
Plt
Length
Description
C
4
Postage rate applied to the container: BAS Basic. CR Carrier route. PS3 3-digit presort. PS5 5-digit presort. SGL Single piece. AADC Automated area distribution center. ADC Area distribution center. MAAD Mixed automated area distribution center MADC Mixed area distribution center MIX Multi-rate pieces blank Nonpresort or unqualified.
P
C
up to 7
Container’s rate category: REG Regular (Outside County) rate NONPROF Nonprofit (sidcounted Outside County) rate CLASS Classroom (discounted Outside County) rate AG Science of Agriculture rate MIXED Mixed rate categories BPM Bound Printed Matter Rate MEDIA Media Mail Rate LIBRARY Library rate PARPOST Parcel Post/Parcel Select rate
A
P
C
1
Container size: 1 1-foot tray or #1 sack or #1 CLEAR SACK. 2 2-foot tray or #2 sack. 3 #3 sack or #3 CLEAR SACK. blank Flats tray or pallet.
A
P
C
1
Container type: F Flats tray (tub). S Sack (use AP.Ctn_Size to get sack size). T Tray (use AP.Ctn_Size to get tray length).
AP.Ctn_Vol
C
7
Container (mail) volume in cubic feet (00.1000 to 65.0000).
AP.Ctn_Wt
C
9
Container (mail) weight in pounds (0001.0000 to 2200.0000).
AP.Dest_CS
P
C
P
up to 30
City and state of destination USPS facility.
AP.Dest_Cs_Ab
P
C
P
21
Contains the USPS-approved abbreviation for the destination city name and the destination state. If the city name is 13 characters or less and needs no abbreviation, this contains the city and state of the destination USPS facility. Important: Presort may truncate your data if it contains a ZIP Code with more than 5 digits.
Chapter 6: Presort
149
Presort output fields Available for output-file types Field name
Adr
Pkg Ctr
AP.Dest_Line
AP.Dest_Rate
A
P
Plt
Length
Description
C
P
25 to 34
City, state, and ZIP of destination USPS facility. Printed on first line of labels. To use this field correctly, you will need to know the width (in characters) of the printable text area on your labels. AP.Dest_Line gives you the same data as AP.Dest_CS and AP.Dest_ZIP, but more intelligently adjusted for field length. ZIP is right-aligned. If the field is too short, Presort truncates the city, and keeps the state and ZIP.
C
P
4
Destination-entry discount rate. Pallets may have more than one destination rate; if so, this field will indicate the lowest destination rate (maximum discount) on the pallet. To indicate that your mail received the DSCF rate, include AP.Dest_Rate in your output file setup. Presort outputs DSCF to indicate the pieces that qualified for the rate. To indicate that pieces received the DADC discount, include the AP.Dest_Rate field in your output file setup. DADC DNDC DSCF DDU blank
ADC discount. NDC discount. SCF discount. DDU discount. No discount.
AP.Dest_ZIP
P
C
P
3 or 5
The 3 or 5-digit destination ZIP Code of the container. Note: If you know your label width exactly, use AP.Dest_Line. Presort will handle long city names in this field. If you don’t know or don’t want to fix the label width, use the separate fields AP.Dest_CS and AP.Dest_ZIP. Separate fields are more useful in some label-printing programs.
AP.Dest_ZIP_C
P
C
P
3 or 5
This posts the same information as in AP.Dest_ZIP described above.
AP.Ent_Pt_CSZ
A
P
C
P
up to 35
Entry point city, state, and ZIP Code; taken from corresponding lines in Entry Point Description.
AP.Ent_Pt_Nam
A
P
C
P
up to 31
Name of entry point; taken from the Entry Point Name line of the Entry Point Description.
AP.Ent_Pt_No
A
P
C
P
up to 3
Entry point number (1 to 999), according to the sequence of Entry Point Descriptions in the job file. Not affected by Mailflow.
AP.File_No
A
up to 3
Input file number (1 to 255), according to the sequence of Input File blocks in the job. When you have more than one input file, use AP.File_No and AP.Record_No together to uniquely identify each record.
AP.GCA_Ucid
A
6
Contains a unique GCA container ID generated by the software. It is not the same as the container ID that you assign to your containers, and it should not be printed on container labels. For future use in re-sequencing containers between Presort, post Presort software, and label printing.
150
P
C
P
Quick Reference for Views and Job-File Products March 2011
Presort output fields Available for output-file types Field name
Adr
AP.IMB_ADR
Pkg Ctr
Length
Description
A
31
Contains the 31-digit number for the IM barcode. This field is available only for the address output file.
AP.IMB_ADR_AC
A
65
Posts the encoded barcode in mixed case to the address output file. When you post this field, the 2nd, 4th, 6th, and so on character are lower case.
AP.IMB_ADR_EC
A
65
Posts the encoded barcode in all upper case to the address output file.
AP.IMB_ADR_MI
A
9
Contains the 6- or 9-digit mailer ID for the IM barcode.
AP.IMB_ADR_SN
A
9
Contains the 6- or 9-digit serial number for the IM barcode.
21
Contains the Pallet IM barcode. This field is available only for the pallet output file.
AP.IMB_PLT
Plt
P
AP.IMB_RTAUTO
C
4
Posts the route or auto information to the container output file. For carrier route direct trays, this field outputs the carrier route code for the pieces in the tray. For all other trays, if the pieces within the tray are barcoded, the field output would be “AUTO”.
AP.IMB_TRYSCK
C
24
Contains the 24-digit number for the Tray/Sack IM barcode. This field is available only for the container output file.
AP.Issue_Date
A
up to 15
Date that a publication was issued. Data is taken from your entry at the Periodicals Issue Date parameter in the Version Description block.
AP.Mail_Type
A
3
Presort status of the mail piece: CAR Carrier-route presorted (excluding ECR). ATM Automation presorted (Regular ECR). REG Regular presorted. NPS Qualified nonpresorted. UNQ Unqualified. FGN Foreign.
AP.Mailing_ID
A
up to 14
Mailing sequence number. Used by participants in USPS measurement programs to identify mailings. To generate the code, Presort combines an optional prefix, which you set, with a serial number that Presort assigns. You may set the prefix, and the starting point for serial numbers, through your job file. See the Mailing Sequence Number parameters in General Output.
AP.Manfst_Key
A
up to 24
Manifest keyline, including serial number, weight (1C only), rate category, and postage. This is required if you're mailing under the Manifest Mailing System (MMS). Length is up to 20 in Standard, up to 24 in First Class.
AP.Newline
A
1 or 2
C L R F on DOS, LF on UNIX. Intended for posting to fixedASCII output files, as an end-of-record mark. The output field itself should be named EOR.
P
C
P
Chapter 6: Presort
151
Presort output fields Available for output-file types Field name
Adr
Pkg Ctr
AP.No_Ctn_Plt
AP.No_Pcs
P
C
Plt
Length
Description
P
3
Number of containers on the pallet (1 to 144). Useful only when preparing a Trays on Pallets or Sacks on Pallets scheme. Blank otherwise.
P
up to 5
Number of pieces in the package, container, or pallet (1 to 99999).
AP.No_Pcs_Ctn
A
up to 5
Number of pieces in the container.
AP.No_Pcs_Lbl
A
up to 5
Number of pieces for the address label (useful when preparing firm packages with the single-label-per-package option).
AP.No_Pcs_Pkg
A
up to 5
Number of pieces in the package.
AP.No_Pcs_Plt
A
up to 5
Number of pieces on the pallet.
P
5
Number of packages in the pallet (1 to 99999). Useful only when working with a Packages on Pallets scheme. Blank otherwise.
P
4
Number of packages in the container or pallet (1 to 9999).
AP.No_Pkg_Plt
AP.No_Pkgs
C
AP.Opt_Endrs
A
P
28
Optional endorsement. For example: *****************5-DIGIT 54601 AUTO Combined package contains automation rate pieces. Notes: Presort places an endorsement line in every record, even though the endorsement technically is required only on the top piece in each package. Set up the output field to be the same size as the printable text area of your labels. Presort will automatically right-align the endorsement and left-fill with asterisks (*). AP.Opt_Endrs does not include the ACS Participant Code. Left-filling with asterisks is not performed correctly if you are using AP.Opt_Endrs within a filter expression—including concatenating AP.Opt_Endrs with another field.
AP.Opt_En_Txt
A
P
up to 28
Contains the information in AP.Opt_En, with just two of the leading asterisks characters (*).
25 to 34
Origin line for labels. Entry point city, and state data are taken from the Entry Point Description block in the job file. Does not include mailer name.
1
Pallet flag: P This piece, package, or container goes on a pallet. blank Not on pallet.
AP.Orig_Line
C
AP.Pallet
A
AP.Pc_No_Abs
A
up to 10
Absolute piece number (1 to 4294967295) within the entire job.
AP.Pc_No_Ctn
A
up to 10
Piece number within the container, no matter how General Output is set up.
152
P
C
P
Quick Reference for Views and Job-File Products March 2011
Presort output fields Available for output-file types Field name
Adr
AP.Pc_No_Mlg
Pkg Ctr
Plt
Length
Description
A
up to 10
Piece number within the mailing, no matter how General Output is set up.
AP.Pc_No_Pkg
A
up to 10
Piece number within the package, no matter how General Output is set up.
AP.Pc_No_Plt
A
up to 10
Piece number within the pallet, no matter how General Output is set up.
AP.Pc_No_Rel
A
up to 10
Piece number per the numbering system chosen in General Output. Not affected by Mailflow.
AP.Pc_No_Seg
A
up to 10
Piece number within the segment, no matter how General Output is set up.
AP.Pc_Rt_Cat
A
up to 8
The version’s rate category: REG Regular (Outside County) rate NONPROF Nonprofit (discounted Outside County) rate CLASS Classroom (discounted Outside County) rate COMMPLUS 1C Parcel AG Science of Agriculture rate MIXED Mixed rate categories BPM Bound Printed Matter Rate MEDIA Media Mail Rate LIBRARY Library rate PARPOST Parcel Post/Parcel Select rate
Chapter 6: Presort
153
Presort output fields Available for output-file types Field name
Adr
AP.Piece_Rate
Length
Description
A
3
Rate category of the mail piece: AA Automation AADC AB Automation AADC (letters) and automation ADC (flats) AD ADC AF Automation 3/5 (flats) AT Automation 3-digit AV Automation 5-digit BB Automation basic (flats) BS Basic (letters and flats) EB Enhanced CART basic EH Enhanced CART high-density FB Firm Bundles FP First Class Presorted blank unqualified ES Enhanced CART saturation MB Automation mixed AADC (letters) and automation mixed ADC (flats) MD Mixed ADC RA Regular 3/5 RB Regular basic/Regular NDC/special or standard library mail RT Regular 3-digit RV Regular 5-digit SP Single-piece
AP.Pkg_Brk_F
A
1
Package break mark. Also see AP.Ctn_Brk_F and AP.Plt_Brk_F. # First piece in the container. blank Other piece.
AP.Pkg_Brk_FL
A
1
Same values, but the first and last pieces are marked.
AP.Pkg_Brk_L
A
1
Same values, but only the last piece is marked.
AP.Pkg_Charge
A
5
The bundle rate charge. When you use the field in an address output file it outputs a 0, except for the first outside-county piece found in each bundle that receives the charge. The entire bundle charge is applied for the first piece in a bundle that receives a charge.
AP.PkgDestZip
A
5
Destination ZIP Code for the package in which this piece was included. Notes: This is the ZIP where the package is destined—where it will be opened and worked—not where it is entered. When the ZIP is only 3 digits, the field is left-aligned and right-padded with spaces.
154
Pkg Ctr
P
C
Plt
P
Quick Reference for Views and Job-File Products March 2011
Presort output fields Available for output-file types Field name
Adr
Pkg Ctr
AP.Pkg_Level
A
AP.Pkg_No_Abs
Plt
Length
Description
P
4
Package sortation level. Also see AP.Ctn_Level and AP.Plt_Level. 3DG 3-digit ASF Auxiliary Service Facility MAAD Mixed AADC 3DGS 3-digit scheme NDC Network Distribution Center MADC Mixed ADC 3DGU Unique 3DG city CR5 5-digit carrier route MNDC Mixed NDC 5DG 5-digit CRD Direct carrier route RES Residual AADC Automated ADC CTY Multi-ZIP city SCF Sectional Center Facility ADC Area Distribution Center FRM Firm blank Nonpresort or unqualified
A
P
up to 7
Absolute package number within the entire job (1 to 9999999), no matter how General Output is set up.
AP.Pkg_No_Ctn
A
P
up to 7
Package number within the container, no matter how General Output is set up.
AP.Pkg_No_Mlg
A
P
up to 7
Package number within the mailing, no matter how General Output is set up.
AP.Pkg_No_Plt
A
P
up to 7
Package number within the pallet, no matter how General Output is set up.
AP.Pkg_No_Rel
A
P
up to 7
Package number per the numbering system chosen in General Output. Not affected by Mailflow.
AP.Pkg_No_Seg
A
P
up to 7
Package number within the segment, no matter how General Output is set up.
Chapter 6: Presort
155
Presort output fields Available for output-file types Field name
Adr
Pkg Ctr
AP.Pkg_Rate
A
AP.Pkg_Rt_Cat
A
Plt
Length
Description
P
4
Postage rate applied to the package: BAS Basic. CR Carrier route. MIX Package has pieces with more than one rate. PS Presort. PS3 3-digit presort. PS5 5-digit presort. AADC Automated area distribution center. ADC Area distribution center. MAAD Mixed automated area distribution center MADC Mixed area distribution center blank Single-piece, nonpresorted or unqualified.
P
up to 7
The package’s rate category: REG Regular (Outside County) rate NONPROF Nonprofit (sidcounted Outside County) rate CLASS Classroom (discounted Outside County) rate AG Science of Agriculture rate MIXED Mixed rate categories BPM Bound Printed Matter Rate MEDIA Media Mail Rate LIBRARY Library rate PARPOST Parcel Post/Parcel Select rate
AP.Pkg_Thk
P
up to 9
Package thickness in inches. Includes decimal point and six decimal places (for example, 12.123456).
AP.Pkg_Wt
P
up to 9
Package weight in pounds. Includes decimal point and six decimal places (for example, 12.123456).
AP.Plt_Brk_F
A
P
C
1
Pallet break mark. Also see AP.Pkg_Brk_F and AP.Ctn_Brk_F. # First piece in the pallet. blank Other piece.
AP.Plt_Brk_FL
A
P
C
1
Same values, but the first and last pieces are marked.
AP.Plt_Brk_L
A
P
C
1
Same values, but only the last piece is marked.
AP.PltDestZip
A
5
Destination ZIP Code for the pallet in which this piece was included. Notes: This is the ZIP where the pallet is destined— where it will be opened and worked—not where it is entered. When the ZIP is only 3 digits, the field is left-aligned and right-padded with spaces.
156
Quick Reference for Views and Job-File Products March 2011
Presort output fields Available for output-file types Field name
Adr
Pkg Ctr
Plt
Length
Description
AP.Plt_Level
A
P
C
P
4
Pallet sortation level. Also see AP.Pkg_Level and AP.Ctn_Level. 3DG 3-digit 5DG 5-digit 5DGS 5-digit Scheme AADC Automated Area Distribution Center ADC Area Distribution Center ASF Auxiliary Service Facility CR5S 5-digit Scheme Cart M5D Merged 5-digit M5DS Merged 5-digit scheme MAAD Mixed AADC MADC Mixed ADC air pallet MNDC Mixed NDC MET Metro pallet NDC Network Distribution Center OMX Origin mixed ADC surface PNDC Protected NDC PSCF Protected SCF SCF Sectional Center Facility. Origin SCF and SCF blank Not prepared on pallets
AP.Plt_No_Abs
A
P
C
P
up to 6
Absolute pallet number (1 to 999999), no matter how General Output is set up.
AP.Plt_No_Mlg
A
P
C
P
up to 6
Pallet number within the mailing, no matter how General Output is set up.
AP.Plt_No_Rel
A
P
C
P
up to 6
Pallet number per the numbering system chosen in General Output. Not affected by Mailflow.
AP.Plt_No_Seg
A
P
C
P
up to 6
Pallet number within the segment, no matter how General Output is set up.
AP.Plt_Rt_Cat
A
P
C
P
up to 7
The pallet’s rate category: REG Regular (Outside County) rate NONPROF Nonprofit (sidcounted Outside County) rate CLASS Classroom (discounted Outside County) rate AG Science of Agriculture rate MIXED Mixed rate categories BPM Bound Printed Matter Rate MEDIA Media Mail Rate LIBRARY Library rate PARPOST Parcel Post/Parcel Select rate
P
7
Pallet volume in cubic feet, with four decimal places and point (00.1000 to 65.0000). Covers only the mail itself, not the pallet or any wrapping materials.
AP.Plt_Vol
Chapter 6: Presort
157
Presort output fields Available for output-file types Field name
Adr
Pkg Ctr
AP.Plt_Wt
AP.Postage
A
P
C
Plt
Length
Description
P
9
Pallet weight in pounds, with four decimal places and point (0001.0000 to 2200.0000). Covers only the mail itself, not the pallet or any wrapping materials.
P
up to 14
Estimated postage in dollars with decimal point, but no currency symbol (for example, 00.32). When posted to an address output file, you get postage for the piece; when posted to a package output file, you get total postage for the whole package, and so on. Note: If a surcharge is applied, it will be included with the piece rate and reflected in the Address output file. Container charges: When container charges apply, Presort does not include the container charge when posting ap.postage in either an address or a package output file. The charge is reflected in ap.postage when you use the field in a container or pallet output file. Bundle charges: When bundle charges apply, Presort includes any applicable bundle charges when posting ap.postage in a package, container, or pallet output file. Bundle charges are not reflected in ap.postage when you use it in an address output file.
AP.Postnetdgt
158
A
11
The number of digits that represent the address barcode. This value can be 0, 5, 9, or 11 digits. It represents the ZIP, ZIP+4, and the DPBC digits that Presort obtained from the input record. This field can be used as input to Label Studio. If the number of digits output in AP.Adr_BC_dgt is less than the minimum set at AP.Adr_BC_Min, this field is blank.
Quick Reference for Views and Job-File Products March 2011
Presort output fields Available for output-file types Field name
Adr
AP.Process_Cat
Pkg Ctr
Plt
Length
Description
A
25
Returns the processing category of each parcel. Possible return values include: AUTOMATED LETTER MACHINABLE LETTER NONMACHINABLE LETTER PER NONAUTOMATION LETTER AUTOMATED FLAT ALTERNATIVE PER AUTO FLAT FLAT POSTCARD DOUBLE POSTCARD NOT FLAT MACHINABLE MACHINABLE PARCEL IRREGULAR PARCEL CMM 1C PARCEL You can differentiate automated from non-automated versions of processing categories by also looking at AP.Mail_Type.
AP.Prt_Req_BC
A
1
Postnet barcode required: Indicates whether or not Postnet is required on the piece. Y Posts when a presort-rate piece is in a co-sacking scheme. If it is a BPM single piece, Y indicates that the piece received the single piece barcode discount. N The piece was not included in any automated scheme, so the barcode is optional.
AP.Rate_Endrs
A
up to 21
Rate endorsement. For 1C and STD jobs only; blank for PER and PSVC jobs. Presort places an endorsement line in every qualified record.
AP.RAE_ID
A
up to 60
The ride-along ID as entered in PER Ride-Along Enclosure Description block.
AP.RAE_Name
A
up to 31
The ride-along name as entered in the PER Ride-Along Enclosure Description block.
AP.RAE_Thk
A
up to 60
Thickness of ride-along enclosure in inches. Includes decimal point and four decimal places (for example, 0.25).
AP.RAE_Wt
A
up to 60
Weight of ride-along enclosure in pounds. Includes decimal point and four decimal places (for example, 0.205).
AP.Record_No
A
up to 10
Record number from the input file (1 to 9999999999). When you have more than one input file, combine AP.File_No and AP.Record_No to uniquely identify each record. Remember that Presort reads input records in the order that they physically appear in the file. Presort does not work with database indexes.
Chapter 6: Presort
159
Presort output fields Available for output-file types Field name
Adr
Pkg Ctr
Plt
Length
Description
AP.Scheme_No
A
P
C
P
up to 2
1 to 99 Scheme number, per sequence of presort schemes in the job file. Not affected by Mailflow. blank For qualified nonpresort, unqualified, and foreign pieces. Also see AP.Mail_Type.
AP.Seg_Name
A
P
C
P
up to 31
Segment name; taken from your entry at the Segment Name line of Segment Description.
AP.Seg_No
A
P
C
P
up to 4
Segment number (1 to 9999), according to the sequence of Segment Descriptions in the job file. Not affected by Mailflow.
AP.Tray_Prep
A
P
C
1
Method of letter or 1C flats tray preparation: L Loose. S Separator cards. P Packages.
AP.Ver_Name
A
up to 31
Version name, as entered on Version Name line of the Version Description block. If using the Auto Version feature, then version names will be taken the values found in the Version_ID field.
AP.Ver_No
A
up to 5
Version number (1 to 32500), according to the sequence of Version Description blocks in the job file. Also see AP.Cpl_Ver_No. If using the Auto Version feature, then version numbers will be assigned in the order that values were found in the Version_ID field.
AP.Ver_Wt
A
up to 9
Weight of mail piece in pounds. Includes decimal point and six decimal places (for example, 12.123456).
1
Zebra bars required: Indicates whether or not zebra bars are required on the tray label. Y Contains automated mail, so zebra bars are required on the tray label. N Contains nonautomated mail, so zebra bars must not be printed. blank The container is a sack so zebra bars are irrelevant.
11
ZIP range of pieces on the pallet. Includes a hyphen (for example, 54601-54650).
AP.Zebra_Req
AP.ZIP_Range
160
C
P
Quick Reference for Views and Job-File Products March 2011
Presort output fields Available for output-file types Field name
Adr
AP.Zone
A
AP.Zone
Pkg Ctr
C
Plt
P
Length
Description
up to 3
Zone rating. Available only in Periodical and Package Services jobs. ICD Incounty DDU IC Incounty DDU DDU SCF SCF 1-2 Zone 1 & 2 3 Zone 3 4 Zone 4 5 Zone 5 6 Zone 6 7 Zone 7 8 Zone 8 blank First Class or Standard job; zones do not apply.
up to 17
Zone rating. Available only in Periodical and Package Services jobs. Includes all zones represented in the container or pallet, separated by a comma. If a container or pallet happened to contain at least one piece for every zone, the field would be— L,1,2,3,4,5,6,7,8
Chapter 6: Presort
161
Chapter 7: Label Studio
This chapter contains input and output fields for use in Label Studio. The items in this section are current through version 7.90c. The USPS requires specific information on address, sack, tray, and pallet labels. See the Domestic Mail Manual (DMM) and your Label Studio User's Guide for more information about positioning the elements on the labels.
Chapter 7: Label Studio
161
Label Studio input fields The following table is an alphabetical listing of each Label Studio input field.
Label Studio input fields Field name
Length
Description
PW.ACS_Code
up to 9
Address Change Service participant code.
PW.ACS_Key
up to 20
ACS keyline data. Data should include pad, check digit, and framing pound signs (#).
PW.Adr_Bc_Dgt
up to 11
If this address label design includes a barcode, this field can be used to input the digits for the barcode.
PW.Adr_Bc_Max
2
Use this field in a conditional filter to inform Label Studio of the longest (largest) barcode that should be printed on this label.
PW.Adr_Bc_Min
2
Use this field in a conditional filter to inform Label Studio of the shortest (smallest) barcode that should be printed on this label.
PW.Aux_Ctrl
PW.Brk_Lvl1 PW.Brk_Lvl2 PW.Brk_Lvl3
162
Inkjet drivers only: This field reads the map definition in your Auxiliary control map file. This field then links the external Auxiliary control map file to the desired map for each record. 1 or more
Use these fields to identify a break, for example, to signal the beginning or end of a package, container, or pallet. Use the corresponding parameters in the Input Options block to control how Label Studio should interpret values it finds in these fields. Note: Be sure to use these PW fields consistently across all the input files. For example, assign PW.Brk_Lvl1 to fields of equivalent content for each input file. Break definition
Field content
Identified as
FIRST
Non-blank or non-zero value
The first record in a new element
LAST
Non-blank or non-zero value
The last record in the current element
CHANGE
A change in the field value
The first record of a new element
VALUE
A change in the field value
The first record of a new element. Blank or zero values are not considered part of the element.
IGNORE
Any value
Ignore the corresponding PW fi ld
Quick Reference for Views and Job-File Products March 2011
Label Studio input fields Field name
Length
Description
PW.CART_Endrs
up to 15
Carrier-route endorsement: identifies carrier route, rural route, and so on, and whether walk-sequenced. For example: **AUTOCR**C-001
First Class, carrier route, automation rate.
**C-001
Periodicals, carrier route.
**WSH**C-001
Periodicals, walk-sequence high-density.
**WSS**C-001
Periodicals, walk-sequence saturation.
**AUTOCR**C-001
Standard Mail (S) Enhanced Carrier Route, automation rate.
**ECRLOT**C-001
Standard Mail (S) Enhanced Carrier Route, regular rate, LOT sorted.
**ECRWSH**C-001
Standard Mail (S) Enhanced Carrier Route, walksequence high-density.
**ECRWSS**C-001
Standard Mail (S) Enhanced Carrier Route, walksequence saturation.
PW.City
13 to 25
If you have a discrete field for the city name, use City for that data. For example, your DEF file entry might look like this: City = DB.City.
PW.Contents
25 to 34
The USPS requires two things on the Contents line of your sack and tray labels and pallet placards: the contents information and the mail processing code. Label Studio requires that you define this data separately. Use this field for the contents information.
PW.Copies
1 to 3
If you mail more than one piece per database record, your database may contain a field indicating the number of copies. Present your field to Label Studio as the field Copies. Label Studio will generate multiple copies per input record according to this field. In records that should receive only one copy, the Copies field may either be blank or contain the number “1”. You may use this field with or without firm packaging.
PW.Ctn_Bc_Dgt
10
If you want Label Studio to print a barcode on a sack or tray label, use this field for the number value—digits—of the barcode.
PW.Ctn_Bc_Req
1
Use this field to signal whether or not a barcode is to be printed on this sack or tray label. Y: Print a barcode on this label other value or blank: Do not print a barcode on this label
PW.Delete
1
Some types of databases include a hidden mark that indicates whether a record is marked as deleted. You can set Label Studio to ignore or to process such deleted records. In simpler types of files, especially fixed or delimited text files, there is no hidden delete mark. Some users mimic the delete mark by using a regular field as the indicator. If your file includes such a field, you can present it as the Delete field. For example, your DEF file entry might look like this: Delete = DB.DEL.
PW.Demog_Code
up to 60
Inkjet drivers only: If you assemble pieces on a selective bindery, you may have a database field for the book version code. The version code indicates to the bindery controller which version to make for that customer. (Exactly where the code appears in the output print record depends on which inkjet driver you use.)
Chapter 7: Label Studio
163
Label Studio input fields Field name
Length
Description
PW.Dest_City PW.Dest_Zip
13 to 25 5
The USPS requires two things on the Destination line of labels for sacks, trays, and pallets—the destination city and destination ZIP Code. The Destination city usually includes the destination state.
PW.Dest_CS_AB
21
Contains the USPS-approved abbreviation for the destination city name and the destination state. If the city name is 13 characters or less and needs no abbreviation, this field contains the city and state of the destination USPS facility.
PW.DPBC
2
The delivery-point barcode field can be used if your job is for at least one automation letter presort scheme or if your job is for the Standard Enhanced Carrier Route presort scheme.
PW.IMB_ADR
31
31-digit number for the IM barcode.
PW.IMB_ADR_AC
65
Prints the encoded barcode in mixed case, or alternating case (AC). The even digits (2nd, 4th, 6th, and so on) of the barcode are lowercase. Some printers include lowercase letters in the IM barcode font to shorten the length. If your printer has this feature (for example, the Heidelberg SE 163 Rev K printer) and you need the barcode narrower, use the PW.IMB_ADR_AC field. If you’re printing to an inkjet printer, use PW.IMB_ADR_EC or PW.IMB_ADR_AC to print the Intelligent Mail barcode.
PW.IMB_ADR_EC
65
Prints the encoded barcode in uppercase. If you’re printing to an inkjet printer, use PW.IMB_ADR_EC or PW.IMB_ADR_AC to print the Intelligent Mail barcode.
PW.IMB_PLT
21
Pallet IM barcode.
PW.IMB_RTAUTO
5
Prints the carrier route code for the pieces in carrier route direct trays. For all other trays, if the pieces within the tray are barcoded, the word "AUTO" is output.
PW.IMB_TRAYSCK
24
24-digit number for the tray IM barcode.
PW.Last_Line
up to 60
For address labels, if your database combines the city, state, and ZIP data in one field, you can use Last_Line for that field to input last-line data. On the other hand, if your database maintains the city, state, and ZIP Code in a separate field, use the discrete PW fields— City, State, ZIP, and so on for the address last-line data.
PW.Line1- Line6
up to 60
For address label data, if the content of your database field varies from record to record, use Line1 through Line6 to present your database data to Label Studio.
PW.Mail_Type
3
You can use this field to signal to Label Studio the category that applies to the record.
PW.Mproc_Code
up to 8
The USPS requires two things on the Contents line of your container and pallet labels: the contents information and the mail processing code. Label Studio requires that you define this data separately. Use this field for the mail processing code.
PW.Msg_Link
up to 60
Inkjet drivers only: If your controller supports dynamic or selective messaging, you may have a database field for the message number. This number indicates to the bindery controller which message to apply. Present your message-number field through the Msg_Link field. Label Studio can include this code in the control portion of each output print record. (Exactly where the code appears in the record depends on which inkjet driver you use.)
PW.Opt_Endrs
at least 23
If your address label is to include an optional endorsement line, use this field to contain the USPS-mandated values for that optional endorsement. Label Studio can pad the data on the left with asterisks, as necessary, to reach the specified label width. See the Domestic Mail Manual (DMM), section M for the acceptable values.
164
Quick Reference for Views and Job-File Products March 2011
Label Studio input fields Field name
Length
Description
PW.Orig_Line
25 to 34
The USPS requires one of two options on the Origination line of your sack and tray labels and pallet placards: either the city and state of the entry post office or the mailer’s name and the city and state of the mailer’s location. Use this field for that information.
PW.Planet
up to 14
The digits that represent the USPS Planet barcode.
PW.State
2
If you have a discrete field for the state identifier, use State for that data. For example, your DEF file entry might look like this: State = DB.State.
PW.Unt_Brk1 PW.Unt_Brk2 ... PW.Unt_Brk9 PW.Unt_Brk10
at least 1 Use these fields to signal the start or end of a mailing unit, such as an entry point or segment. Use the corresponding definition lines in the Input Options block to control how Label Studio should interpret values it finds in these fields. Note: Be sure to use these PW fields consistently across all the input files. For example, assign Unt_Brk1 to fields of equivalent content for each input file. Break definition
Field content
Identified as
FIRST
non-blank or non-zero value
the first record in the mailing unit.
LAST
non-blank or non-zero value
the last record in the mailing unit
CHANGE
a change in the field value
the first record of a new element
IGNORE
any value
ignore the corresponding PW field
PW.Zebra_Req
1
Use this field to signal whether or not a zebra code is to be printed on this tray label. Y: Print a zebra code on this label blank or other value: Do not print a zebra code on this label
PW.ZIP PW.ZIP4 PW.ZIP10
5 4 10
Use these fields for intelligent hyphenation on your labels.
PW.fieldname
up to 60
Label Studio can accept a large number of other PW fields not listed here. Those fields may be handy in output posting, in label designs, or in filters when you are working with files that don’t use the same field names. If you have only one input file, or if you convert all files to a standard format, there may be no reason to set up those extra PW fields.
User:fieldname
up to 60
You may define your own PW fields by using the prefix Use. Example: If you define User:Status = DB.STATUS in your DEF file, then you can work with PW.Status as you would use any other PW field, in posting or filters. This feature is handy when you are working with files that don’t use the same field names.
Chapter 7: Label Studio
165
Label Studio output fields The following table is an alphabetical listing of each Label Studio output field.
Label Studio output fields Field name
Label Type (address, sack, tray, or pallet)
Length
Description
AP.Adr_BC_Dgt
A
up to 11
The digits that represent the address barcode. This value can be 0, 5, 9, or 11 digits. Label Studio retrieves these digits from PW.Adr_BC_Dgt. If this field includes a check digit, Label Studio strips off the check digit and recalculates a new check digit. Note: This field, by itself, does not cause the Postnet barcode to be printed on the label. You will need to place a Postnet barcode object on your layout and define a value in the Postnet properties, if your printer drive supports it. Otherwise, you will need to set up your control line or escape codes to print the barcode on your label. In some cases you will need to do both of these things. See your printer’s documentation to see what applies.
AP.Adr_Chk_Digit
A
1
Contains the check digit for AP.Adr_BC_Dgt.
AP.Aux_Ctrl_Map_1
A
up to 151
Inkjet drivers only: Before you can use this field, you must define PW.Aux_Ctrl and enter an auxiliary control map file name in the Inkjet block of Label Studio. Use this field if your driver requires the auxiliary control map file to be populated with 1s and 0s (zeros).
AP.Aux_Ctrl_Map_X
A
up to 151
Inkjet drivers only: Before you can use this field, you must define PW.Aux_Ctrl and enter an auxiliary control map file name in the Inkjet block of Label Studio. Use this field if your driver requires the auxiliary control map file to be populated with Xs and spaces.
AP.Brk_Lvl1_F AP.Brk_Lvl1_FL AP.Brk_Lvl1_L AP.Brk_Lvl2_F AP.Brk_Lvl2_FL AP.Brk_Lvl2_L AP.Brk_Lvl3_F AP.Brk_Lvl3_FL AP.Brk_Lvl3_L
A
1
Use these fields to identify a break, for example, to signal the beginning or end of a package, container, or pallet. F First piece is marked FL First and last pieces are marked L Last piece is marked
up to 10
The digits that represent the sack or tray label barcode. This field must contain exactly 0, 8 (sack), or 10 (tray) digits.
AP.Ctn_Bc_Dgt
S
T
S
T
P
AP.Design_Name
A
S
T
P
up to 260
This information is taken from the Labels block and contains the name of your design file. You may want to use this field on your banner pages
AP.Design_Path
A
S
T
P
up to 260
This information is taken from the Labels block and contains the file path of your design file. You may want to use this field on your banner pages.
166
Quick Reference for Views and Job-File Products March 2011
Label Studio output fields Field name
Label Type (address, sack, tray, or pallet)
Length
Description
AP.File_No
A
up to 3
Input file number (1 to 255), according to your input file sequence. When you have more than one input file, AP.File_No and AP.Record_No together uniquely identify each record.
AP.Hopper_Map_1
A
up to 151
Inkjet drivers only: Before you can use this field, you must define PW.Demog_Code and enter a hopper map file name in the Inkjet block of Label Studio. Use this field if your inkjet driver requires the hopper map to be populated with 1s and 0s (zeros).
AP.Hopper_Map_X
A
up to 151
Inkjet drivers only: Before you can use this field, you must define PW.Demog_Code and enter a hopper map file name in the Inkjet block of Label Studio. Use this field if your inkjet driver requires the hopper map to be populated with Xs and spaces.
AP.Input_Name
A
S
T
P
up to 260
This information is taken from an Input File block and contains the name of the input file used to produce the label or banner page.
AP.Input_Path
A
S
T
P
up to 260
This information is taken from an Input File block and contains the file path of the input file used to produce the label or banner page.
AP.Job_Desc
A
S
T
P
up to 80
This information is taken from the General Information block of your job file. It contains the description of your job.
AP.Job_End
A
S
T
P
1
This field marks the last label in your job with a “Y”.
AP.Job_Owner
A
S
T
P
up to 20
This information is taken from the General Information block of your job file. It contains your job owner information.
AP.Job_Path
A
S
T
P
up to 260
The file path of your job file.
AP.Job_Start
A
S
T
P
1
This field marks the first label in your job with a “Y”.
AP.Lbl_No
A
S
T
P
up to 10
The absolute number assigned to each label that is to be output. Test labels, quality books, and so on, are not included in this number.
AP.Lbl_No_Page
A
S
T
P
up to 10
The number assigned to each label on a page. Label Studio resets this number for each new page of labels.
AP.Lbl_No_Unt
A
S
T
P
up to 10
The number assigned to each label that is to be output, within the label’s unit. Test labels, quality books, and so on, are not included in this number.
AP.Lbl_No_Sub
A
S
T
P
up to 10
The number assigned to each label of a given type (address, sack, tray, or pallet) that is to be output, within the label’s subunit. Test labels, quality books, and so on, are not included in this number.
AP.Mailer_Name
A
S
T
P
up to 20
This information is taken from the General Information block of your job file. It contains your mailer name information.
AP.Page_No
A
S
T
P
up to 10
This field contains the number assigned to each page.
S
T
P
Chapter 7: Label Studio
167
Label Studio output fields Field name
Label Type (address, sack, tray, or pallet)
Length
Description
AP.Planet
A
up to 13
The digits that represent the Planet barcode. This value can be 11 or 13 digits. AP.Planet retrieves these digits from PW.Planet. If this field includes a check digit, Label Studio strips off the check digit and recalculates a new check digit.
AP.Planet_Chk_Dgt
A
1
This field contains the check digit for AP.Planet.
AP.Qbook
A
1
Inkjet drivers only: When printing Q-books, Label Studio populates this field with a Y if the respective record is a Q-book. On all other records, Label Studio populates this field with an N.
AP.Record_No
A
S
T
P
up to 10
Record number from the input file (1 to 9999999999). When you have more than one input file, combine AP.File_No and AP.Record_No to uniquely identify each record.
AP.Seq_No_Abs
A
S
T
P
up to 10
Use this field to print an absolute number on each record. For example, if your mailing has 200 labels, and you have 100 labels in one file and 100 in another file, you can use this field to number your labels 1– 100 and 101– 200.
AP.Seq_No_Rel
A
S
T
P
up to 10
Use this field to print a relative number on each record. For example, if your mailing has 200 labels, and you have 100 labels in one file and 100 in another file, you can use this field to number your labels as 1– 100 and 1– 100.
AP.Subunit_End
A
S
T
P
1
This field marks the last label in your subunit with a “Y”.
AP.Subunit_Start
A
S
T
P
1
This field marks the first label in your subunit with a “Y”.
AP.Unit_End
A
S
T
P
1
This field marks the last label in your unit with a “Y”.
AP.Unit_Start
A
S
T
P
1
This field marks the first label in your unit with a “Y”.
AP.Subunt_No
A
S
T
P
up to 10
The subunit number within the current unit.
AP.Ubrk1_Des – AP.Ubrk10_Des
A
S
T
P
at least 1 This information is taken from the Unit Break Definition window. You can access this window from the Input Options block.
AP.Unt_Desc
A
S
T
P
up to 40
This field contains the value of Unit Break Description for the current unit.
AP.Unt_No
A
S
T
P
up to 10
This field contains the unit number associated within the current unit.
AP.Volume_No
A
up to 10
This field represents the value for the current volume.
168
Quick Reference for Views and Job-File Products March 2011
Chapter 8: Values, commands, and filter functions
This chapter is a collection of useful commands that you can use with our software products to increase your ability to manipulate data. Included are upper and lower ASCII values, command lines for running each product, and filter and functions for manipulating data.
Chapter 8: Values, commands, and filter functions
169
Lower ASCII code values Note for DMT files: You may use, as delimiters, characters in the extended ASCII set (also known as “upper” ASCII). Those characters are not included in this list because they vary from one computer system to another. Please see your system manuals for information about extended ASCII.
Lower ASCII code values Code
Description
Code
Description
Code
Description
000
null
026
substitute
052
4
001
start of heading
027
escape
053
5
002
start of text
028
file separator
054
6
003
end of text
029
group separator
055
7
004
end of transmission
030
record separator
056
8
005
enquiry
031
unit separator
057
9
006
acknowledge
032
space
058
: (colon)
007
bell
033
! (exclamation mark)
059
; (semicolon)
008
backspace
034
“(double quote)
060
< (less than)
009
horizontal tab
035
# (pound sign)
061
=
010
line feed
036
$
062
> (greater than)
011
vertical tab
037
%
063
?
012
form feed
038
&
064
@
013
carriage return
039
' (apostrophe)
065
A
014
shift out
040
(
066
B
015
shift in
041
)
067
C
016
data link escape
042
* (asterisk)
068
D
017
device control 1 or X-ON
043
+
069
E
018
device control 2
044
, (comma)
070
F
019
device control 3 or X-OFF
045
- (hyphen)
071
G
020
device control 4
046
. (period)
072
H
021
negative acknowledge
047
/ (forward slash)
073
I
022
synchronous idle
048
0
074
J
023
end-of-transmission block
049
1
075
K
024
cancel
050
2
076
L
025
end of medium
051
3
077
M
170
Quick Reference for Views and Job-File Products March 2011
Lower ASCII code values Code
Description
Code
Description
Code
Description
078
N
095
_ (underscore)
110
n
079
O
096
` (accent)
111
o
080
P
097
a
114
r
081
Q
098
b
115
s
082
R
099
c
116
t
083
S
100
d
117
u
084
T
101
e
118
v
085
U
102
f
119
w
086
V
103
g
120
x
087
W
104
h
121
y
088
X
105
i
122
z
089
Y
106
j
123
{
090
Z
107
k
124
| (vertical bar, pipe)
091
[
108
l
125
}
092
\ (back slash)
109
m
126
~ (tilde)
093
]
112
p
127
delete
094
^ (caret)
113
q
Chapter 8: Values, commands, and filter functions
171
Upper ASCII code values This section lists characters in the upper ASCII set (values 128–255) as defined in code page 1252, the ANSI Latin 1 code page.
Upper ASCII code values Code
Description
Code
Description
Code
Description
128
€ (Euro symbol)
155
›
182
¶ (paragraph)
129
not used
156
œ
183
·
130
‚(comma)
157
not used
184
¸
131
ƒ
158
ž
185
¹
132
„
159
Ÿ
186
º
133
… (ellipses)
160
(nonbreaking space)
187
» (close quote)
134
†
161
¡ (inverted exclamation)
188
¼
135
‡
162
¢ (cent)
189
½
136
ˆ
163
£ (pound)
190
¾
137
‰
164
¤
191
¿ (inverted question)
138
Š
165
¥
192
À
139
‹
166
¦
193
Á
140
Œ
167
§ (section)
194
Â
141
not used
168
¨ (umlaut)
195
Ã
142
Ž
169
© (copyright)
196
Ä
143
not used
170
ª
197
Å
144
not used
171
«(open quote)
198
Æ
145
‘(single open quote)
172
¬
199
Ç
146
’ (single close quote)
173
-
200
È
147
“(double open quote)
174
® (registered trademark)
201
É
148
” (double close quote)
175
¯
202
Ê
149
•(bullet)
176
° (degree)
203
Ë
150
– (en dash)
177
± (plus or minus)
204
Ì
151
—(em dash)
178
² (squared)
205
Í
152
˜ (tilde)
179
³ (cubed
206
Î
153
™ (trademark)
180
´
207
Ï
154
Š
181
µ
208
Ð
172
Quick Reference for Views and Job-File Products March 2011
Upper ASCII code values Code
Description
Code
Description
Code
Description
209
Ñ
225
á
241
ñ
210
Ò
226
â
242
ò
211
Ó
227
ã
243
ó
212
Ô
228
ä
244
ô
213
Õ
229
å
245
õ
214
Ö
230
æ
246
ö
215
× (multiply)
231
ç
247
÷ (divide)
216
Ø
232
è
248
ø
217
Ù
233
é
249
ù
218
Ú
234
ê
250
ú
219
Û
235
ë
251
û
220
Ü
236
ì
252
ü
221
Ý
237
í
253
ý
222
Þ
238
î
254
þ
223
ß
239
ï
255
ÿ
224
à
240
ð
Chapter 8: Values, commands, and filter functions
173
Command-line options Command syntax
General commands
Use the command syntax that corresponds to your product to run your jobs.
Product
Command syntax
DataRight
pwdtr [options] [path] jobfile.dtr
ACE:
pwace [options] [path] jobfile.ace
ACE Canada:
pwcace [options] [path] jobfile.cac
Match/Consolidate:
pwmpg [options] [path] jobfile.mpg
Presort:
presort [options] [path] jobfile.pst
International Presort:
ipresort [options] [path] jobfile.ips
Here is a list of other commands that you can use to manipulate how the software outputs information.
Syntax by operating system
174
Windows
UNIX
Description
/a
-a
Answer verifier warning messages with “Continue”—that is, ignore them.
/lfile.log
>file.log
Record messages in a log file. (You can use with the /nos and the /a options. However, you will not see all the verification issues when /a is chosen)
/watch
-watch
Add system time-of-day to progress messages.
/nos
-nos
No stop on verifier error messages. Useful when running jobs via a batch or shell script—if one job fails, the others are not held up.
/rev
-rev
Display the software version and revision level.
/v
-v
Verify only; do not process the job. Helpful if you want to run a job overnight because you can verify your job during the day.
&:
start / min:
Run a job in the background.
Quick Reference for Views and Job-File Products March 2011
Edjob command-line options
Use these additional commands when you run Edjob on your existing jobs to update them to the latest version of the software. Command-line format: edjob [options] [path] script.upd
[path] jobfile
Edjob command-line options Syntax by operating system
Description
DOS
Windows
UNIX
/bx
/bx
-bx
Remove excess blank lines so that the maximum number of contiguous blank lines (between blocks) will be x (1-9).
/c
/c
-c
Suppress the prompt for confirmation. (Normally, Edjob pauses with a prompt for confirmation before updating each job file. This can become wearisome, so many users add the c option to their command line.)
/e:error_file
/e:error_file
-e:error_file Log errors—job files found but not updated—in the error file. Normal progress messages still go to the screen. This option is handy for overnight processing, because Edjob does not stop on errors. The log file contains one line per job file found. Even if there is no error, the file name is logged—so the log is a handy way to verify that a particular job was updated.
/n
/n
-n
No backup. Normally, Edjob backs up each job file before updating it (for example, jobfile.ace is backed up to jobfile.aed). If you don’t feel this backup is necessary or you can’t spare the disk space, add the n option to suppress the backup.
/s
/s
-s
Recursively search for job files in all directories named, and in all subdirectories under them.
/v
/v
-v
Produce verbose progress messages.
/V
/V
-V
Produce very verbose progress messages.
script.upd
script.upd
script.upd
To update your jobs, Edjob follows instructions in a script file. Each time we send an update that involves any job-file changes, we install a new update script in the product directory. Theoretically, if you’ve followed our advice about setting the PATH and PW_PATH variables (see our System Administrator’s Guide), Edjob should be able to find the right script by itself. However, to be on the safe side, usually it’s wise to include the full pathname on your Edjob command line. ACE Canada pwcacjob.upd ACE U.S. pwacejob.upd DataRight pwdtrjob.upd DataRight IQ pwdiqjob.upd International ACE pwiacjob.upd International Presort pwipsjob.upd Match/Consolidate pwmpgjob.upd Presort U.S. pwpstjob.upd PrintForm pwpfjob.upd ZipCount pwzctjob.upd
Chapter 8: Values, commands, and filter functions
175
Edjob command-line options Syntax by operating system DOS
Windows
Description
UNIX
There are three ways to identify which job files you want to update:
176
jobfile.ext
jobfile.ext
jobfile.ext
Type the full name (with path, if necessary) of one job file.
*.ext
*.ext
“*.ext”
Type a wild card; for example, "*.ace". On UNIX, enclose the wild card in quotes. This method is often used with the recursivesearch option (see s option above).
@joblist
@joblist
@joblist
To update a particular set of job files, you can type their path names into a text file. Then include the name of that “job-list” file on your Edjob command line. Precede the file name with an @ symbol.
Quick Reference for Views and Job-File Products March 2011
Filter functions and operators
Type
Description
Function/operator syntax
Arithmetic
Perform division and return the remainder
mod()
Multiplication
*
Addition
+
Subtraction
-
Division (no % modulus available)
/
Less than
=
Not equal to
Is exactly equal to
=
Is contained in or is a subset of
$
ASCII value to character
chr()
Character mm/dd/yy or mm/dd/yyyy to date
ctod()
Character string to lowercase
lower()
Character string to UPPERCASE
upper()
Character string to Mixed Case
proper()
Character to ASCII value
asc()
Character to numeric
val()
Date to character mm/dd/yyyy
dtoc()
Date to character yyyymmdd
dtos()
Numeric decimal to integer by truncation
int()
Numeric decimal to n decimal places (or integer) by rounding
round()
Numeric to absolute value
abs()
Numeric to character string
str()
Search a string for one character and substitute another
chrtran()
Select the larger of two numbers
max()
Select the smaller of two numbers
min()
Comparison
Convert data
Compare
Chapter 8: Values, commands, and filter functions
177
Type
Description
Function/operator syntax
Provide data
Character repeated n times
replicate()
Current date from time-of-day clock
date()
Current time from time-of-day clock
time()
n spaces
space()
Number of current record, from input file
recno()
Day of the week from date (Sunday, Monday, ... Saturday)
cdow()
Day-of-the-month numeric from date (1, 2, ... a1)
day()
Day-of-the-week numeric from date (1, 2, ... 7)
dow()
Leftmost n characters from string
left()
Month name from date (January, February, ... December)
cmonth()
Month numeric from date (1, 2, ... 12)
month()
Range of characters from string
substr()
Rightmost n characters from string
right()
Year numeric from date
year()
Number of non-Latin-1 characters that are converted to Latin-1 with the Unicode to Latin-1 table. Example filter: translated(pw.line1)>0
translated( )
Number of non-Latin-1 characters that are either illegal or unassigned. Unassigned is a character that has a numeric value greater than 255 for which there is no value specified in the Unicode to Latin-1 table. Example filter: unassigned(pw.line1)>0
unassigned( )
Measure the length of a character expression
len()
Trim leading spaces
ltrim()
Trim trailing spaces
rtrim()
Trim leading and trailing spaces
alltrim()
Concatenate strings, removing all leading and trailing spaces from both, and inserting one space between
&
Concatenate strings leaving leading and trailing spaces where they are
+
Concatenate strings and places all trailing blank spaces at the end
-
Does expression begin with a capital letter (A–Z)?
isupper()
Does expression begin with a letter (A–Z or a–z)?
isalpha()
Does expression begin with a lower–case letter (a–z)?
islower()
Does expression begin with a number (0–9)?
isdigit()
Does expression contain any data other than spaces?
empty()
Test; if true, return expression #1; if false, return expression #2
iif()
Extract
Extract (Unicode only)
Fit and trim
String concatenation
Test
178
Quick Reference for Views and Job-File Products March 2011
Type
Miscellaneous
Description
Function/operator syntax
Is character expression #1 located within expression #2 (true/false)?
$
How many characters in expression #1 are within expression #2?
span()
Where is character expression #1 located within expression #2?
at()
Is the input record marked to be deleted?
deleted()
Not (reverses the sense of a logical true/false)
!
Use parentheses liberally to control precedence (order in which operations are performed).
()
Chapter 8: Values, commands, and filter functions
179
180
Quick Reference for Views and Job-File Products March 2011
Index
Numerics 10-digit ZIP Code without hyphen, 25, 31, 59
A abbreviated directional, 75, 76, 91 suffix, 26, 43, 75, 76, 90 abbreviated predirectional, 93 abbreviated street type, 93 abbreviation province, 74 absolute pallet number, 157 absolute container number, 148 absolute label number, 167 absolute package number, 155 absolute piece number, 152 ACE Canada address error codes, 70 address status codes, 80–81 alias address line component fields, 75 APA fields, 75 APD fields, 76 assigned address line component fields, 74–75 command-line syntax, 174 dual address line component fields, 76 input fields by data type, 72–73 last-line component fields, 74 multi line input component fields, 78 other codes, 79 other useful codes, 78 output fields, 74–79 ACE engines, 98 ACE U.S. address and assignment results code fields, 31, 60 address error codes, 70 address status codes, 68–69 alias address-line component fields, 27 AP fields, 25–?? APA fields, 27 APAL fields, 27 APD fields, 28 APDL fields, 29 APM fields, 43 assigned address-line components, 26, 57 command-line syntax, 174 dual address-line component fields, 28 geocensus code fields by option, 39, 65 input fields, 22–24 last-line component fields, 25, 56 multi line input component fields, 30, 58 NCOALink fields, 41 other useful codes, 37, 63
output fields, 25–?? postal code fields, 30, 58 PW fields, 22–24 ACS, 162 ACS keyline data, 162 ACS participant code, 162 address, 22, 26, 43, 72, 74, 75, 76, 87, 118 alternate input, 91 language standardization, 73 multi line, 30, 78, 96 non-postal, 26, 45, 88 primary, 26, 28, 43, 75, 76, 77, 89, 92 secondary, 26, 27, 29, 43, 75, 90 standardized, 28, 92 standardized primary and secondary, 91 urban, 79, 102 address barcode, 158 address change service, See ACS address conversion LACSLink, 54 address fault code, 98 address label, 164 address line components alias, 27 dual, 28 U.S. ACE, 26, 57 address line remainder, 26, 29, 75, 90 address status code, 99 alias input address field type, 28 ana nan postal code format, 74 ananan postal code format, 74 ANKLink, 54 AP, 145 AP prefix, 127 AP.ACS_Code, 144, 145 AP.ACS_Key, 144, 145 AP.Add_Type, 144, 145 AP.Addr_Chng, 15 AP.Addr_Error, 14 AP.Addr_Lvr, 78, 97 AP.Addr_Qual, 15 AP.Addr_Stat, 16 AP.Addr_Total, 87 AP.Addr_Type, 97 AP.Address1–3, 12 AP.Adr_BC_Dgt, 166 AP.Adr_BC_dgt, 145 AP.Adr_BC_Max, 145 AP.Adr_BC_Min, 145 AP.Adr_Chk_Digit, 166 AP.Ageo_Blk, 39, 103 AP.Ageo_Cty, 39, 103 AP.Ageo_Lat, 39, 103 AP.Ageo_Lng, 39, 103 AP.Ageo_MCD, 39 Index
181
AP.Ageo_Pla, 39, 103 AP.Ageo_Sta, 39, 103 AP.Aline, 26, 74 AP.All_Names, 10 AP.Asmt_Code, 97 AP.Aud_Pname, 41 AP.Aud_Range, 41 AP.Aud_Srange, 41 AP.Aud_Unit, 41 AP.Aux_Ctrl_Map_1, 166 AP.Aux_Ctrl_Map_X, 166 AP.Bind_Name, 145 AP.Bind_No, 146 AP.Brk_Lvl1_F, 166 AP.Brk_Lvl1_FL, 166 AP.Brk_Lvl1_L, 166 AP.Brk_Lvl2_F, 166 AP.Brk_Lvl2_FL, 166 AP.Brk_Lvl2_L, 166 AP.Brk_Lvl3_F, 166 AP.Brk_Lvl3_FL, 166 AP.Brk_Lvl3_L, 166 AP.Building, 87 AP.Buyer_Cnt, 127 AP.Bypass, 87 AP.CART, 30 AP.CART_Endrs, 146 AP.CART_Pkg, 146 AP.CASS_Match, 37 AP.CASSrectyp, 31 AP.Category, 78 AP.Cert_Match, 98 AP.Cgeo_Blk, 40, 103 AP.CGeo_CBSA, 103 AP.Cgeo_CBSA, 39 AP.Cgeo_Lat, 40, 103 AP.Cgeo_Lng, 40, 103 AP.Cgeo_Match, 40 AP.Cgeo_MSA, 103 AP.Cgeo_Msa, 40 AP.Chk_Digit, 31, 96 AP.City, 12, 25, 74 AP.City_Abbr, 25 AP.City_LLIDX, 25 AP.City_Npref, 25 AP.City_Place, 25 AP.City13, 74 AP.City18, 74 AP.Class, 146 AP.Cntry_Name, 101 AP.Cnty_Code, 101 AP.Cnty_Name, 101 AP.CONFIRM, 146 AP.Congress, 37 AP.Cont_Line, 146 AP.Cont_Nompc, 146 AP.Cont_Pc, 146 AP.Contents, 146 AP.Country, 13, 74 AP.County, 37 AP.CountyName, 37 AP.CR_Sort_Zn, 30
182
AP.Ctn_Barcd, 146 AP.Ctn_Bc_Dgt, 166 AP.Ctn_BC_Req, 147 AP.Ctn_Brk_F, 147 AP.Ctn_Brk_FL, 147 AP.Ctn_Brk_L, 147 AP.Ctn_Charge, 147 AP.Ctn_Fill, 147 AP.Ctn_Level, 148 AP.Ctn_No_Abs, 148 AP.Ctn_No_Mlg, 148 AP.Ctn_No_Plt, 148 AP.Ctn_No_Rel, 148 AP.Ctn_No_Seg, 148 AP.Ctn_Rate, 149 AP.Ctn_Rt_Cat, 149 AP.Ctn_Size, 149 AP.Ctn_Type, 149 AP.Ctn_Vol, 149 AP.Ctn_Wt, 149 AP.CtnDestZip, 147 AP.Ctry_Alph2, 101 AP.Ctry_Numrc, 101 AP.Date1–6, 16 AP.Delinst, 74, 87 AP.DelQual, 74, 87 AP.DelType, 75, 88 AP.Design_Name, 166 AP.Design_Path, 166 AP.Dest_CS, 149 AP.Dest_Cs_Ab, 149 AP.Dest_Line, 150 AP.Dest_Rate, 150 AP.Dest_ZIP, 150 AP.Dest_ZIP_C, 150 AP.Dir, 75 AP.District, 101 AP.Dname_Stat, 15 AP.DPBC, 31 AP.DPV_CMRA, 100 AP.DPV_cmra, 34 AP.DPV_Ftnote, 34, 100 AP.DPV_NoStat, 34 AP.DPV_Status, 35, 101 AP.DSF_Busind, 35 AP.DSF_Deltyp, 35 AP.DSF_Dropct, 36 AP.DSF_Dropin, 36 AP.DSF_Edu,, 36 AP.DSF_LACS,, 36 AP.DSF_Rectyp, 35 AP.DSF_Season, 35 AP.DSF_Seqsrc, 36 AP.DSF_Tback, 35 AP.Dual_Address, 26 AP.Dual_Name, 11 AP.Dual_Salut, 12 AP.Email1–6, 16 AP.Email2ndD1–6, 16 AP.Email3rdD1–6, 16 AP.Email4thD1–6, 16 AP.Email5thD1–6, 16
Quick Reference for Views and Job-File Products March 2011
AP.EmailAllD1–6, 16 AP.EmailHost1–6, 16 AP.EmailTopD1–6, 16 AP.EmailUser1–6, 16 AP.Eng_Used, 98 AP.Ent_Pt_CSZ, 150 AP.Ent_Pt_Nam, 150 AP.Ent_Pt_No, 150 AP.Err_Stat, 31, 78 AP.Error_Code, 31, 78 AP.EWS_Match, 32, 98 AP.Extra1-10, 78, 101 AP.Extra1–10, 30 AP.Extra1–12, 17 AP.Extran_PMB, 26 AP.Extran_Sec, 26 AP.Extraneous, 26, 45 AP.Fac_Type, 102 AP.FacType, 37 AP.Fault_Code, 98 AP.Fault_Stat, 98 AP.File_No, 17, 127, 150, 167 AP.FIPS_Code, 102 AP.FIPSCODE, 38 AP.Firm_Chng, 15 AP.Firm_Error, 14, 127 AP.Firm_Line1–2, 11 AP.Firm_Loc1–2, 11 AP.Firm_Qual, 15 AP.Firm_Stat, 16 AP.Firm1–2, 11 AP.FirstName1–6, 10 AP.Foreign, 32 AP.GCA_Ucid, 150 AP.Gender_Rec, 12 AP.Gender1–6, 12 AP.Geo_Match, 40, 104 AP.Group_Cnt, 128 AP.Group_No, 128 AP.Group_Ord, 128 AP.Group_Rank, 128 AP.Group_Type, 128 AP.Hopper_Map_1, 167 AP.Hopper_Map_X, 167 AP.ID_INC_NO, 128 AP.IMB_ADR, 151 AP.IMB_ADR_AC, 151 AP.IMB_ADR_EC, 151 AP.IMB_ADR_MI, 151 AP.IMB_ADR_SN, 151 AP.IMB_PLT, 151 AP.IMB_RTAUTO, 151 AP.IMB_TRYSCK, 151 AP.Input_Firm, 55 AP.Input_Name, 167 AP.Input_Path, 167 AP.IntCityCd1–6, 17 AP.IntCtryCd1–6, 17 AP.IntPhDesc1–6, 17 AP.IntPhNum1–6, 17 AP.IntPhone1–6, 17 AP.IntraOrd, 128
AP.IntraType, 129 AP.Issue_Date, 151 AP.Job_Desc, 167 AP.Job_End, 167 AP.Job_Owner, 167 AP.Job_Path, 167 AP.Job_Start, 167 AP.LACS_Code, 98 AP.LACSCODE, 32 AP.Lacsl_Ind, 54 AP.Lacsl_Qry, 54 AP.Lacsl_Ret, 54 AP.Last_Line, 13, 25, 74, 94 AP.Last_Name1–6, 10 AP.LB_Prior, 129 AP.Lbl_No, 167 AP.Lbl_No_Page, 167 AP.Lbl_No_Sub, 167 AP.Lbl_No_Unt, 167 AP.Level_Desc, 88 AP.Level_Num, 88 AP.List_Cnt, 129 AP.List_Name, 129 AP.list_name, 17 AP.List_No, 17, 129 AP.List_Type, 129 AP.LL_Chng, 15 AP.LL_Error, 14, 129 AP.LL_Qual, 15 AP.LL_Stat, 16 AP.Local_Abr1, 94 AP.Local_Abr2, 94 AP.Local_Alt, 94 AP.Locality1-4, 95 AP.LOT, 30 AP.LOT_Order, 31, 96 AP.Mail_Type, 151 AP.Mailer_Name, 167 AP.Mailing_ID, 151 AP.Manfst_Key, 151 AP.Mat_Post1–6, 10 AP.Match_5, 32 AP.Match_9, 32 AP.Match_A, 104 AP.Match_P, 105 AP.Match_Un, 32 AP.MatchRule, 129 AP.MatchScore, 129 AP.MatchType, 130 AP.Max_ID1-9, 130 AP.Mid_Name1–6, 10 AP.Name_Chng, 14 AP.Name_Cnt, 11 AP.Name_Error, 14, 130 AP.Name_Line1–6, 11 AP.Name_Qual, 15 AP.Name_Stat, 15 AP.Name1–6, 10 AP.NameDesig1–6, 10 AP.NC_Firm, 32, 99 AP.NC_Secaddr, 32, 99 AP.NC_Srange, 32, 99 Index
183
AP.NC_Unit, 32, 99 AP.Newline, 18, 38, 78, 102, 130, 151 AP.No_Ctn_Plt, 152 AP.No_Pcs, 152 AP.No_Pcs_Ctn, 152 AP.No_Pcs_Lbl, 152 AP.No_Pcs_Pkg, 152 AP.No_Pcs_Plt, 152 AP.No_Pkg_Plt, 152 AP.No_Pkgs, 152 AP.Np_Secaddr, 26, 88 AP.Np_Srange, 26, 45, 89 AP.Np_Unit, 26, 89 AP.Num_Names, 130 AP.Opt_En_Txt, 152 AP.Opt_Endrs, 152 AP.Orig_Line, 152 AP.Oth_Post1–6, 10 AP.Page_No, 167 AP.Pallet, 152 AP.Parse, 130 AP.Parse_Type, 130 AP.PatnLabel1–4, 17 AP.Patnsub1–4_1–5, 17 AP.Pattern1–4, 17 AP.Pc_No_Abs, 152 AP.Pc_No_Ctn, 152 AP.Pc_No_Mlg, 153 AP.Pc_No_Pkg, 153 AP.Pc_No_Plt, 153 AP.Pc_No_Rel, 153 AP.Pc_No_Seg, 153 AP.Pc_Rt_Cat, 153 AP.Pcode_Move, 99 AP.Pcode_Type, 99 AP.Piece_Rate, 154 AP.Pkg_Brk_F, 154 AP.Pkg_Charge, 154 AP.Pkg_Level, 155 also see AP.Ctn_Level also see AP.Plt_Level AP.Pkg_No_Abs, 155 AP.Pkg_No_Ctn, 155 AP.Pkg_No_Mlg, 155 AP.Pkg_No_Plt, 155 AP.Pkg_No_Rel, 155 AP.Pkg_No_Seg, 155 AP.Pkg_Rate, 156 AP.Pkg_Rt_Cat, 156 AP.Pkg_Thk, 156 AP.Pkg_Wt, 156 AP.PkgDestZip, 154 AP.Planet, 168 AP.Planet_Chk_Dgt, 168 AP.Plt_Brk_F, 156 AP.Plt_Brk_FL, 156 AP.Plt_Brk_L, 156 AP.Plt_Level, 157 AP.Plt_No_Abs, 157 AP.Plt_No_Mlg, 157 AP.Plt_No_Rel, 157 AP.Plt_No_Seg, 157
184
AP.Plt_Rt_Cat, 157 AP.Plt_Vol, 157 AP.Plt_Wt, 158 AP.PltDestZip, 156 AP.PO_Box, 26 AP.POBox, 14 AP.POBox_Line, 14 AP.POBOX_NUM, 75 AP.Post_Dir, 89 AP.Postage, 158 AP.Postal_Nam, 89 AP.Postal_Num, 89 AP.PostCode, 74 AP.Postcode1, 95 AP.Postcode2, 95 AP.PostCode7, 74 AP.Postdir, 26 AP.Postnetdgt, 158 AP.Pre_Dir, 89 AP.Pre_Name1–6, 10 AP.Pref_City, 74 AP.PreSL_DPBC, 55 AP.PreSL_SecR, 55 AP.PreSL_Unit, 55 AP.PreSL_ZIP, 55 AP.PreSL_ZIP4, 55 AP.Prim_Addr, 13, 26, 75, 89 AP.Prim_Name, 26, 75 AP.Prim_Name1, 89 AP.Prim_Name2, 89 AP.Prim_Range, 13, 26, 75, 89 AP.Process_Cat, 158 AP.Province, 74 AP.Prt_Req_BC, 159 AP.Qbook, 168 AP.Qss_Dflt, 38, 99 AP.RAE_ID, 159 AP.RAE_Name, 159 AP.RAE_Thk, 159 AP.RAE_Wt, 159 AP.Rate_Endrs, 159 AP.RDI, 38, 99 AP.Rec_No_Out, 18, 39, 79, 102, 130 AP.Rec_Type, 33, 79 AP.Record_No, 18, 39, 79, 102, 130, 159, 168 AP.Region, 95 AP.Remainder, 26, 75 AP.Remainder1, 90 AP.Remainder2, 90 AP.Results, 127 AP.Results.Level, 127 AP.Route_Sort, 99 AP.RR, 14 AP.RR_Box, 26 AP.RR_Line, 14 AP.RR_Number, 26, 75 AP.RRBox, 14 AP.Rural_Num, 90 AP.Salute_Rec, 12 AP.Salute1–6, 12 AP.Scheme_No, 159 AP.Sec_Addr, 13, 26, 75, 90
Quick Reference for Views and Job-File Products March 2011
AP.Sec_Range, 13, 26, 75 AP.Seg_Name, 159 AP.Seg_No, 159 AP.Seq_No_Abs, 168 AP.Seq_No_Rel, 168 AP.Singl_Addr, 90 AP.SIntraOrd, 130 AP.SIntraType, 130 AP.Sort_DelPt, 96 AP.Sort_Route, 96 AP.Spec_Name, 11 AP.SSN1–6, 17 AP.Stat_Code, 33, 99 AP.State, 12, 25 AP.Std_Line1-12, 78 AP.Std_Line1–12, 30 AP.Std_Line1-8, 96 AP.Std_Line9-12, 96 AP.SteLink_RC, 55 AP.Subunit_End, 168 AP.Subunit_Start, 168 AP.Subunt_No, 168 AP.Suffix, 26, 75, 90 AP.Super_Cnt, 131 AP.Super_Name, 131 AP.Super_No, 131 AP.Title1–6, 10 AP.Tray_Prep, 159 AP.Ubrk1_Des, 168 AP.Ubrk10_Des, 168 AP.Unique_No, 131 AP.Unit_Desc, 90 AP.Unit_Desig, 27, 75 AP.Unit_Dir, 90 AP.Unit_End, 168 AP.Unit_Num, 90, 92 AP.Unit_Start, 168 AP.Unt_Desc, 168 AP.Unt_No, 168 AP.Urb, 14, 27 AP.Urban_Ind, 79, 102 AP.USAreaCod1–6, 17 AP.USPhone1–6, 17 AP.USPhoneExt1–6, 17 AP.USPhoneTyp1–6, 17 AP.USPhonLin1–6, 17 AP.USPhonPre1–6, 17 AP.USPS_Unit, 27 AP.Ver_Name, 159 AP.Ver_No, 160 AP.Ver_Wt, 160 AP.Volume_No, 168 AP.Walk_Seq, 36 AP.Was_Output, 131 AP.Zebra_Req, 160 AP.ZIP, 13 AP.ZIP_Move, 33 AP.ZIP_Range, 160 AP.ZIP_Type, 33 AP.ZIP4, 13 AP.ZIP9, 25, 31, 59 AP.Zone, 160
APA fields, 27, 75, 90 APA.Addr_Type, 91 APA.Address, 27, 91 APA.Building, 91 APA.Cnty_Name, 91 APA.Dir, 75 APA.Last_Line, 91 APA.Level_Num, 91 APA.Locality1-4, 91 APA.Post_Dir, 91 APA.Postdir, 27 APA.Pre_Dir, 92 APA.Prim_Addr, 27, 76, 92 APA.Prim_Name, 27, 76 APA.Prim_Name1, 92 APA.Prim_Name2, 92 APA.Prim_Range, 27, 76, 92 APA.Region, 92 APA.Sec_Addr, 27, 92 APA.Sec_Range, 27 APA.Suffix, 27, 76, 92 APA.Type, 28 APA.Unit_Desc, 92 APA.Unit_Desig, 28 APAL fields, 92 APAL.Dir, 76 APAL.Post_Dir, 92 APAL.Postdir, 27 APAL.Pre_Dir, 92 APAL.Suffix, 27, 76, 92 APC field, 19 APC.All_Names, 19 APC.Dual_Name, 19 APC.Firm_Line1–2, 19 APC.Firm_Loc1–2, 19 APC.Firm1–2, 19 APC.FirstName1–6, 19 APC.Last_Name1–6, 19 APC.Mat_Post1–6, 19 APC.Mid_Name1–6, 19 APC.Name_Line1–6, 19 APC.Name1–6, 19 APC.NameDesig1–6, 19 APC.Oth_Post1–6, 19 APC.Pre_Name1–6, 19 APC.Record, 19 APC.Spec_Name, 19 APC.Title1–6, 19 APD fields, 28, 76, 92 APD.Address, 28, 92 APD.Delinst, 76, 93 APD.DelQual, 76, 94 APD.DelType, 76, 94 APD.Dir, 76 APD.Extran_PMB, 28 APD.Extran_Sec, 28 APD.Extraneous, 28 APD.Level_Desc, 93 APD.Level_Num, 93 APD.Locality2, 93 APD.PO_Box, 28 APD.Post_Dir, 93 Index
185
APD.Postal_Num, 93 APD.Postdir, 28 APD.Pre_Dir, 93 APD.Prim_ Name1-2, 93 APD.Prim_Addr, 28, 76, 77, 93 APD.Prim_Name, 28, 76, 77 APD.Prim_Range, 28, 76, 77, 93 APD.Rec_Type, 29 APD.Remainder, 29 APD.Remainder1, 93 APD.Remainder2, 93 APD.RR_Box, 29 APD.RR_Number, 29 APD.Rural_Num, 93 APD.Sec_Addr, 29, 93 APD.Sec_Range, 29 APD.Suffix, 29, 93 APD.Unit_Desc, 93 APD.Unit_Desig, 29 APD.Unit_Num, 93 APD.Urb, 29 APDL.Postdir, 28 APDL.Predir, 28 APIC.Cntry_Name, 105 APIC.Firm, 105 APIC.Full_Code, 105 APIC.Locality1, 105 APIC.Locality2, 105 APIC.Postal_Num, 105 APIC.Prim_Name1, 105 APIC.Prim_Name2, 105 APIC.Prim_Range, 105 APIC.Region, 105 APIC.Sec_Addr, 105 APIS.Cntry_Name, 106 APIS.Full_Code, 106 APIS.Locality1, 106 APIS.Locality2, 106 APIS.Postal_Num, 106 APIS.Prim_Name1, 106 APIS.Prim_Name2, 106 APIS.Prim_Range, 106 APIS.Region, 106 APIS.Sec_Addr, 106 APL.Dir, 75 APL.Post_Dir, 90 APL.Postdir, 26 APL.Pre_Dir, 90 APL.Predir, 26 APL.Suffix, 26, 75 APM.Address, 43 APM.Ageo_Blk, 49 APM.Ageo_Cty, 49 APM.Ageo_Lat, 49 APM.Ageo_Lng, 49 APM.Ageo_Pla, 49 APM.Ageo_Sta, 49 APM.Aline, 45 APM.ANKL_Ret, 55 APM.Aud_Fields, 41 APM.Aud_Mid, 41 APM.Aud_Pname, 41
186
APM.Aud_Range, 41 APM.Aud_Unit, 41 APM.CART, 43 APM.CASS_Match, 46 APM.CASSrectyp, 46 APM.Cgeo_Blk, 49 APM.Cgeo_CBSA, 49 APM.Cgeo_Lat, 49 APM.Cgeo_Lng, 49 APM.Cgeo_Msa, 49 APM.Chk_Digit, 43 APM.City, 43 APM.City_Abbr, 45 APM.City_LLIDX, 45 APM.City_Npref, 45 APM.City_Place, 45 APM.Congress, 46 APM.County, 46 APM.CountyName, 46 APM.CR_Sort_Zn, 46 APM.DPBC, 43 APM.DPV_ CMRA, 50 APM.DPV_Ftnote, 50 APM.DPV_NoStat, 50 APM.DPV_Status, 51 APM.Drop, 41 APM.Drop_V, 41 APM.DSF_Busind, 51 APM.DSF_Deltyp, 51 APM.DSF_Dropct, 52 APM.DSF_Dropin, 52 APM.DSF_Edu, 52 APM.DSF_Rectyp, 51 APM.DSF_Season, 51 APM.DSF_Tback, 51 APM.Eff_Date, 44 APM.Err_Stat, 46 APM.EWS_Match, 47 APM.Extran_PMB, 45 APM.Extran_Sec, 45 APM.Extraneous, 45 APM.FacType, 47 APM.FIPSCODE, 53 APM.Firm, 41 APM.First_Name, 42 APM.FirstName1–2, 18 APM.Foreign, 47 APM.Gender, 41 APM.Geo_Match, 50 APM.Hint_byte, 41 APM.IntCodes, 42 APM.LACSCODE, 47 APM.Last_Line, 43 APM.Last_Name, 42 APM.LOT, 43 APM.LOT_Order, 44 APM.Match_5, 47 APM.Match_9, 47 APM.Match_Un, 47 APM.Mid_Name, 42 APM.Mid_Name1–2, 18 APM.Move_Type, 44
Quick Reference for Views and Job-File Products March 2011
APM.Newline, 53 APM.Np_Secaddr, 45 APM.Np_Unit, 45 APM.PO_Box, 45 APM.Post_Name, 42 APM.Postdir, 43 APM.Pre_Name, 42 APM.Predir, 43 APM.Prim_Addr, 43 APM.Prim_Name, 43 APM.Prim_Range, 43 APM.Qss_Dflt, 53 APM.RDI, 52 APM.Rec_No_Out, 53 APM.Rec_Type, 48 APM.Record_No, 53 APM.RetCode, 44 APM.RR_Box, 45 APM.RR_Number, 45 APM.Sec_Addr, 43 APM.Sec_Range, 43 APM.Stat_Code, 48 APM.State, 43 APM.Suffix, 43 APM.TaxIQ, 52 APM.Unit_Desig, 43 APM.Urb, 43 APM.USPS_Unit, 45 APM.ZIP, 43 APM.ZIP_Move, 48 APM.ZIP_Type, 48 APM.ZIP10, 43 APM.ZIP4, 43 APM.ZIP9, 43 APM2–6.FirstName1–2, 18 APM2–6.Mid_Name1–2, 18 APPL, 56 APPL.Address, 57 APPL.Ageo_Blk, 65 APPL.Ageo_Cty, 65 APPL.Ageo_Lat, 65 APPL.Ageo_Lng, 65 APPL.Ageo_MCD, 65 APPL.Ageo_Pla, 65 APPL.Ageo_Sta, 65 APPL.Aline, 57 APPL.CART, 58 APPL.CASS_Match, 63 APPL.CASSrectyp, 60 APPL.Cgeo_Blk, 66 APPL.Cgeo_CBSA, 66 APPL.Cgeo_Lat, 66 APPL.Cgeo_Lng, 66 APPL.Cgeo_Match, 66 APPL.Cgeo_Msa, 66 APPL.Chk_Digit, 59 APPL.City, 56 APPL.City_Abbr, 56 APPL.City_LLIDX, 56 APPL.City_Npref, 56 APPL.City_Place, 56 APPL.Congress, 63
APPL.County, 64 APPL.CountyName, 64 APPL.CR_Sort_Zn, 59 APPL.DPBC, 59 APPL.DPV_CMRA, 62 APPL.DPV_Ftnote, 62 APPL.DPV_NoStat, 62 APPL.DPV_Status, 63 APPL.DPV_Vacant, 63 APPL.Dual_Line, 57 APPL.EWS_Match, 60 APPL.Extra1-10, 58 APPL.Extraneous, 57 APPL.FacType, 64 APPL.FIPSCODE, 64 APPL.Geo_Match, 66 APPL.Input_Firm, 67 APPL.LACSCODE, 60 APPL.Last_Line, 56 APPL.LOT, 59 APPL.LOT_Order, 59 APPL.Match_5, 60 APPL.Match_9, 60 APPL.Match_Un, 60 APPL.NC_Firm, 60 APPL.NC_Secaddr, 60 APPL.NC_Srange, 60 APPL.NC_Unit, 60 APPL.Np_Secaddr, 57 APPL.Np_Srange, 57 APPL.Np_Unit, 57 APPL.PO_Box, 57 APPL.Postdir, 57 APPL.Predir, 57 APPL.PreSL_DPBC, 67 APPL.PreSL_SecR, 67 APPL.PreSL_Unit, 67 APPL.PreSL_ZIP, 67 APPL.PreSL_ZIP4, 67 APPL.Prim_Addr, 57 APPL.Prim_Name, 57 APPL.Prim_Range, 57 APPL.Qss_Dflt, 65 APPL.RDI, 65 APPL.Rec_No_Out, 65 APPL.Rec_Type, 61 APPL.Record_No, 65 APPL.Remainder, 57 APPL.RR_Box, 57 APPL.RR_Number, 57 APPL.Sec_Addr, 57 APPL.Sec_Range, 57 APPL.State, 56 APPL.Std_Line1-12, 58 APPL.SteLink_RC, 67 APPL.Suffix, 57 APPL.Unit_Desig, 58 APPL.Urb, 58 APPL.USPS_Unit, 58 APPL.ZIP_Move, 61 APPL.ZIP_Type, 61 APU.Address1–3, 12 Index
187
APU.All_Names, 10 APU.City, 12 APU.Country, 13 APU.Dual_Name, 11 APU.Firm_Line1–2, 11 APU.Firm_Loc1–2, 11 APU.Firm1–2, 11 APU.FirstName1–6, 10 APU.Gender1–6, 12 APU.Last_Line, 13 APU.Last_Name1–6, 10 APU.Mat_Post1–6, 10 APU.Mid_Name1–6, 10 APU.Name_Line1–6, 11 APU.Name1–6, 10 APU.NameDesig1–6, 10 APU.Oth_Post1–6, 10 APU.POBox, 14 APU.POBox_Line, 14 APU.Pre_Name1–6, 10 APU.Prim_Addr, 13 APU.Prim_Range, 13 APU.RR, 14 APU.RR_Line, 14 APU.RRBox, 14 APU.Sec_Addr, 13 APU.Sec_Range, 13 APU.Spec_Name, 11 APU.State, 12 APU.Title1–6, 10 APU.Urb, 14 APU.ZIP, 13 APU.ZIP4, 13 ASCII code values lower, 170–171 upper, 172–173 assigned address record type, 33 assignment level, 104 assignment status code, 33, 48
B barcode, 163 address, 158 container, 146, 147 sack or tray label, 163 Zebra, 160, 165 blank priority, 129 book version code, 163 break definition, 165 break definitions, 162 break level, 166 breakmark package, 154 pallet, 156 first and last piece, 156 last piece, 156 building name, 87, 91
C carrier route, 86, 96 CART, 24, 30, 43, 118, 135
188
CASS, 31, 37, 46, 63 CBSA, 103 check digit, Planet barcode, 168 city delivery installation name, 87 city destination, 149 city name delivery installation, 74, 76, 93 standardized, 74 truncate, 68 codes U.S. ACE, 37, 63 command-line options, 174 Edjob, 175 general commands, 174 concantenated field, 106 container, 147 absolute number, 148 barcode, 146 degree of fullness letter trays, 147 destination ZIP, 147 destination ZIP Code, 150 level, 148 number, 148 number within mailing, 148 number within pallet, 148 postage rate, 149 size, 149 type, 149 volume, 149 weight, 149 Core-Based Statistical Area. See CBSA country, 118 ISO code, 101 county, 118
D DataRight APM fields, 18 command-line syntax, 174 match standards first and middle names, 18 salutation fields, 12 DataRight IQ address data fields, 12–14 AP field, 10 APC field, 10 APC fields, 19 APM field, 10 APU field, 10 confidence scores name, title, firm data, 19 error, change, quality code fields, 14 firm fields, 11 gender code fields, 12 miscellaneous fields, 16 name and title fields, 10 status code fields, 15 default match qualification, 38 delete, 24, 73, 118, 136, 163 deliver installation city name, 74 delivery installation city name, 76, 87, 93
Quick Reference for Views and Job-File Products March 2011
delivery installation qualifier, 74, 76, 87 delivery installation type, 75, 76, 88, 94 delivery installtion qualifier, 94 delivery point barcode, 24, 31, 43, 164 two digit, 84 delivery point validation, 34, 35 delivery-point barcode, See DPBC delivery-point identification information, 96 destination city and state, 149 city name abbreviation, 149 container ZIP, 147 entry discount rate, 150 PLANET code, 139 USPS facility city, state, ZIP, 150 destination ZIP Code, 150, 164 container, 150 package, 154 pallet, 156 dimension fields, 137 directional abbreviated, 75, 76, 91 abbreviated pre, 93 abbreviated predirectional, 89 abbreviation, 89, 91, 92, 93 follows address, 92 non abbreviated, 90 post, 28, 43 pre, 90, 92 preceding address, 92 spelled out, 75, 76, 92 discount destination-entry rate, 150 discrete field, 163 district number house of representatives, 101 DPBC, 24, 31, 43, 84, 96, 136, 164 dupe group lists, 129 order, 128 priority, 122 rank, 128 record count, 128 serial number, 128 type, 128
E early warning system, 32, 47, 98 Edjob command-line options, 175 enclosure ride-along, 140, 159 end of record mark, 38, 53, 78, 102, 130, 151 endorsement rate, 159 enhanced carrier route eligible, 99 entry point city, state, ZIP, 150 ID, 136 name, 150 number, 150 error codes ACE U.S., 70
error status code, 31, 46, 78 EWS see early warning system extra field non address data, 30, 78, 101 extraneous data, 26, 28, 45
F federal code state and county, 38, 53, 102 field type alias input address, 28 fields other PW fields, 24 fifth digit US address status codes, 69 filter functions, 177 arithmetic, 177 compare, 177 comparisons, 177 convert data, 177 extract, 178 Unicode only, 178 fit and trim, 178 miscellaneous, 179 provide data, 178 string concatenation, 178 test, 178 FIPS code, 38, 53, 102 firm, 22, 38, 65, 72, 78, 102, 105, 106, 119 identification number, 137 match, 32 firm match, 99 firm parsing error code, 127 first digit US address status codes, 68 first name match standards, 18 fourth digit US address status codes, 69
G gender, 128 geocensus, 102 geocensus codes address level fields, 39, 65 centroid fields, 39, 66
H hopper map, 167 house number primary name, 27 primary range, 26, 43, 75, 76, 77, 89, 92, 93
I IACE see International ACE input file number, 127 record number, 39, 53, 79, 102, 130, 159, 168 input file number, 150, 167 input record type, 130 installation type
Index
189
delivery, 75, 76, 88, 94 intelligent hyphenation, 165 International ACE additional postal code fields, 96 address component fields, 87 address fault codes, 107–108 address status codes, 109–115 alternate address line component fields, 90 APA fields, 90 dual address line component fields, 92 informational codes, 104 input field guidelines, 84 input fields, 84–86 last line component fields, 94 multi line input component fields, 96 other component fields, 101 output fields, ??–104 postal facility codes, 88 results code fields, 97 U.S. geocensus fields, 102 international mailing vendor, 137 International Presort command-line syntax, 174 issue date, 151
K key fields Match/Consolidate, 124–126
L label origin line, 152, 165 label data, ??–162 label number, 167 absolute, 167 Label Studio AP fields, 166–168 input fields, 162–165 output fields, 166–168 PW fields, 162–165 LACS, 32, 47 LACSLink, 54 last line, 23, 25, 43, 73, 74, 141, 164 locality, region, postal code, 85, 91, 94 parsing error code, 129 last_line, 119 latitude and longitude match code, 40, 50, 66, 104 letter tray preparation, 159 level description, 88, 93 number, 88, 91, 93 of assignment primary range, 106 package sortation, 155 Level prefix, 127 line of travel, 24, 30, 43 list count, 129 list priority, 129 locality, 85, 91, 95, 105, 106 preserve, 94 locality name abbreviation, 94
190
Locatable Address Conversion System, 54 locatable address conversion system see LACS LOT, 85, 138 see line of travel lot, 96
M mailer name information, 167 mailing sequence number, 151 mail-piece status, 151 manifest keyline, 151 match cause, 130 match score number, 129 match standards first name, 18 middle name, 18 Match/Consolidate command-line syntax, 174 input fields, 118–123 key fields, 124–126 output fields, 127–131 Matchset prefix, 127 messaging, 164 meter rate, 138 middle name match standards, 18 military postal code, 99 move indicator ZIP Code, 33, 48 move record effective date, 44 move type, 44 Mover ID fields NCOALink, 41 multi line address, 30, 78, 96 multi line input components U.S. ACE, 30, 58 multi version version identification, 141 weight, 137 weight in ounces, 137 width, 137
N name, 130 name error code E101, 130 name_line, 121 name_line1, 121 NCOALink fields, 41 non-postal address, 26, 45, 88 secondary range, 26, 45, 89 unit designator, 26, 45, 89 number of containers on pallet, 152 packages in container, 152 packages in pallet, 152 pieces for address label, 152 pieces in container, 152
Quick Reference for Views and Job-File Products March 2011
pieces in package, 152 pieces on pallet, 152
O operators, 177 arithmetic, 177 compare, 177 comparison, 177 convert data, 177 extract, 178 Unicode only, 178 fit and trim, 178 miscellaneous, 179 provide data, 178 string concatenation, 178 test, 178 operators (in filters), 179 optional endorsement, 152, 164 optional endorsement text, 152 origin line, 152, 165 origin PLANET code, 139 Other PW fields, 24 output limit one output per record, 131 output fields U.S. ACE, 25 output file record number, 39, 53, 79, 102, 130
P P. O. box international engine, 89 see post office box package destination ZIP Code, 154 postage rate, 156 sortation level, 155 thickness, 156 weight, 156 package breakmark, 154 package number absolute, 155 from General Output, 155 within container, 155 within mailing, 155 within pallet, 155 within segment, 155 pallet absolute number, 157 destination ZIP Code, 156 range of pieces, 160 sortation level, 157 pallet breakmark, 156 pallet flag, 152 pallet number in General Output, 157 mailing, 157 segment, 157 pallet volume, 157 pallet weight, 158 parcel processing category, 158
parsing error last line, 129 parsing results, 130 participant code, ACS, 162 percent subscriber, 141 piece number, 153 absolute, 152 in container, 152 in package, 153 in pallet, 153 in segment, 153 within mailing, 153 pkg_brk_fl, 154 pkg_brk_l, 154 Planet barcode, 165, 168 PLANET code destination and origin, 139 PMB, 45 post code, 95 secondary, 95 post directional abbreviation, 28, 43 post office box, 28 post office box number, 26, 93 postage estimated, 158 meter rate, 138 postage rate package, 156 postal code, 72 ana nan format, 74 ananan format, 74 realignment, 99 type, 79, 99 postal codes U.S. ACE, 30, 58 postal delivery name, 89 postal delivery number australian engine, 89 postal facility codes, 88 postal facility type, 37, 47, 102 postal number, 105, 106 Postcode, 86 postcode, 95, 105, 106 PostNet barcode, 164 PostNet required, 159 potential assignment level, 105 pre directional, 89 predir, 26, 28, 43, 57 Pre-LACSLink, 56 Presort command-line syntax, 174 input fields, 135–142 input fields selection chart, 134–135 output fields, 145–160 output fields selection chart, 143–145 prim_name, 122 primary address, 26, 92 standardized, 28, 43, 75, 76, 77, 89 primary name, 89, 92, 105, 106 major thoroughfare U.K. addresses only, 89, 92 Index
191
primary range house number, 26, 27, 43, 75, 76, 77, 89, 92, 93 level of assignment, 106 primary street name, 89, 92 standardized, 26, 28, 43, 75, 76, 77, 93 priority, 139 blank, 129 dupe group, 122 list, 129 private mail box extraneous address data, 93 private mail box data, 26, 28, 45, 57 private mailbox data, 26, 45 processing category parcel, 158 province, 72, 86, 95 province abbreviation, 74 publication issue date, 151 Puerto Rican urbanization name, 22, 27, 29, 43, 93 PW fields U.S. ACE, 22 PW fields, define your own, 123 PW.ACS_Code, 162 PW.ACS_Key, 162 PW.Ad_Pct, 134, 135 PW.Addr_Line1-2, 84 PW.Address, 7, 118 PW.Adr_Bc_Dgt, 162 PW.Adr_Bc_Max, 162 PW.Adr_Bc_Min, 162 PW.Aux_Ctrl, 162 PW.Brk_Lvl1-Lvl3, 162 PW.CART, 24, 118, 135 PW.CART_Endrs, 163 PW.Chk_Digit, 24, 84 PW.City, 7, 22, 72, 118, 135, 163 PW.Contents, 163 PW.Copies, 135, 163 PW.Country, 8, 23, 72, 84, 118, 136 PW.County, 24, 84, 118, 136 PW.Ctn_Bc_Dgt, 163 PW.Ctn_Bc_Req, 163 PW.Date1–6, 8 PW.Delete, 8, 24, 73, 118, 136, 163 PW.Delvy_Pt, 84 PW.Demog_Code, 163 PW.Dest_City, 164 PW.Dest_CS_AB, 164 PW.Dest_Zip, 164 PW.DPBC, 24, 164 PW.Email1–6, 8 PW.Entry_ID, 136 PW.fieldname, 165 PW.Firm_ID, 137 PW.Firm1, 119 PW.Firm1-2, 84, 119 PW.Firm1–2, 6 PW.FirmLine1–2, 6 PW.Firmline1-2, 119 PW.FirmLoc1–2, 6 PW.First_Name, 6, 22, 122
192
PW.Firstpart1-2, 119 PW.Force_SP, 137 PW.Height, 137 PW.ID1-9, 119 PW.IMB_ADR, 164 PW.IMB_ADR_AC, 164 PW.IMB_ADR_EC, 164 PW.IMB_CRID, 137 PW.IMB_MID, 137 PW.IMB_PLT, 164 PW.IMB_Serial, 137 PW.IMB_TRAYSCK, 164 PW.Intl_Regn, 137 PW.Key_Code, 137 PW.Language, 73 PW.Last_Line, 7, 23, 73, 119, 141, 164 PW.Last_Line1-2, 85 PW.Last_Name, 6, 22, 122 PW.Lastpart1-2, 119 PW.Line1- 6, 164 PW.Line1- Line 12, 142 PW.Line1- Line6, 141 PW.Line1-12, 72, 85 PW.Line1–12, 8, 23 PW.Line1-6, 120 PW.List_ID, 8, 120 PW.Locality1, 85 PW.Locality2, 85 PW.Locality3, 85 PW.LOT, 24 PW.LOT_Order, 24, 138 PW.Mail_Class, 138 PW.Mail_Type, 164 PW.Merg_Purg1-0, 121 PW.Meter_Rate, 138 PW.Mid_Name, 6, 22, 122 PW.Mproc_Code, 164 PW.Msg_Link, 164 PW.Name_Firm1-6, 121 PW.Name_Firm1–6, 6 PW.Name_Line, 22, 72, 121 PW.Name_Line1, 86, 121 PW.Name_Line1-6, 121 PW.Name_Line1–6, 6 PW.Non_Addr1–6, 7 PW.Opt_Endrs, 164 PW.Orig_Line, 165 PW.Pattern1–4, 8 PW.Phone1–6, 8 PW.PLANET, 139 PW.Planet, 165 PW.Pmb, 118 PW.Post_Name, 6, 22, 122 PW.PostCode, 72 PW.Pre_Name, 6, 22, 122 PW.Prim_Name, 122 PW.Priority, 122 PW.Province, 72 PW.Prt_PLANET, 139 PW.RAE_ID, 140 PW.Region, 86 PW.Route, 86
Quick Reference for Views and Job-File Products March 2011
PW.Seed_ID, 140 PW.Segment_ID, 140 PW.SRVC_Type, 140 PW.SSN1–6, 8 PW.State, 7, 22, 118, 165 PW.Subscriber, 141 PW.Title, 22, 72, 122 PW.Title1, 86 PW.Title1-6, 122 PW.Title1–6, 6 PW.Unit, 7, 22, 72, 86, 118 PW.Unt_Brk1, 165 PW.Unt_Brk10, 165 PW.Unt_Brk2, 165 PW.Unt_Brk2-9, 165 PW.Unt_Brk9, 165 PW.Urb, 7, 22 PW.user fieldname, 9 PW.Ver_Name, 141 PW.Version_ID, 141 PW.Walk_Seq, 141 PW.Width, 137, 141 also see PW.Height PW.Wt_Lbs, 137, 141 also see PW.Height PW.Wt_Oz, 137, 141 also see PW.Height PW.Zebra_Req, 165 PW.ZIP, 7, 122, 165 PW.ZIP10, 7, 122, 165 PW.ZIP4, 7, 122, 165 PW_Rate_Cat, 140 PW_Sub_Opt, 141
Q Q-books, 168 qualifier delivery installation, 74, 76, 87
R range secondary, 26, 75 rate category mail piece, 154 rate endorsement, 159 record limit to one output file, 131 sequential number, 131 record identification field, 119 record number input file, 39, 53, 79, 102, 130, 159, 168 output file, 39, 53, 79, 102, 130 record type assigned address, 33 postal code, 79 region, 86, 95, 105, 106 remainder address line, 26, 29, 75, 90 residential delivery indicator see AP.RDI
result codes U.S. ACE, 31, 60 Results prefix, 127 AP., 127 ride-along enclosure ID field, 140 name, 159 thickness, 159 weight, 159 ride-along enclosure ID, 159 rule name for match, 129 rural route box number, 26, 29, 45, 93 rural-route box number U.S.engine, 89 rural-route number, 90
S sack barcode, 163 scheme number, 159 second digit US address status codes, 68 secondary address complete, 26, 27, 29, 43, 75, 90 secondary address match, 32, 99 secondary range, 26, 75 non-postal, 26, 45, 89 secondary range data, 26, 28, 45, 57 secondary range match, 32, 99 seed file, 140 seed record, 137 segment identification number, 140 segment name, 159 segment number, 159 selection chart Presort input fields, 134–135 Presort output fields, 143–145 sequention list number, 128 sixth digit US address status codes, 69 sortation level pallet, 157 standardized city name, 74 standardized address, 92 standardized address line, 27, 28 standardized primary street name, 27, 93 state, 72, 86, 95, 165 state and county federal code, 38, 53, 102 state destination, 149 state name, 22, 25, 43 status code address, 99 assignment, 33, 48 status codes ACE U.S., 68–69 street name primary, 26, 28, 43, 75, 76, 77 street type abbreviated, 93 spelled out, 92 sub unit number, 168 subscriber percent, 141 suffix, 26, 90 abbreviated, 75, 76, 90 Index
193
address, 26 full, 75, 76 super list count, 131 name, 131 number, 131 syntax command-line options, 174
T thickness, 137, 141 package, 156 ride-along enclosure, 159 third digit US address status codes, 68 title data, 22, 72, 122 tray letter tray preparation, 159 tray barcode, 163 type container, 149
U unassigned address status code, 78 unassigned address error code, 31, 46 unique record sequential number, 131 unit break description value, 168 unit description, 90, 92 unit designator non-postal, 26, 45, 89 unit designator match, 99 unit number, 90, 92, 93 current unit, 168 sub unit, 168 unit start and end, 165 unsuitable for delivery, 32, 47 urban address indicator, 79, 102 urbanization name Puerto Rico, 22, 27, 29, 43, 93 US address status codes ACE, 68 user fieldname, 24, 73, 123, 142, 165
194
fieldnames, 165 USPS LACSLink, 54 USPS Planet barcode, 165
V version code, 137 version identification, 141 version name, 159 version number, 160 version weight, 160 volume container, 149 current volume number, 168
W walk sequence, 141 weight container, 149 multi version, 137 ounces, 137 package, 156 pounds, 137 ride-along enclosure, 159 version, 160 width multi version, 137
Z Zebra barcode required, 160, 165 zebra code, 165 ZIP, 23, 25, 31, 43, 56, 59, 72, 122, 141 ZIP Code no hyphen, 25, 31, 59 range of pieces, 160 ZIP Code of destination, 150, 164 ZIP Code realignment, 33, 48 ZIP Code type, 33, 48 ZIP10, 23, 25, 31, 43, 56, 59, 122, 141, 142 ZIP4, 23, 25, 31, 43, 56, 59, 122, 142 ZIP9, 56 zone CART sort, 30, 46 zone rating, 160
Quick Reference for Views and Job-File Products March 2011
Index
195
196
Quick Reference for Views and Job-File Products March 2011
