Vous êtes sur la page 1sur 148

Quick Reference for Views and Job-File Products

February 2012

Copyright information

2012 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 February 2012

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: Match/Consolidate ....................................................................................... 71 Match/Consolidate input fields.......................................................................72 Match/Consolidate key fields .........................................................................78 Match/Consolidate output fields.....................................................................81 Chapter 4: Presort........................................................................................................... 87 Presort input fields ..........................................................................................88 Presort output fields ........................................................................................97 Chapter 5: Label Studio ............................................................................................... 117 Label Studio input fields...............................................................................118 Label Studio output fields.............................................................................122 Chapter 6: Values, commands, and filter functions................................................... 125 Lower ASCII code values.............................................................................126 Upper ASCII code values .............................................................................128 Command-line options..................................................................................130 Command syntax....................................................................................130 Filter functions and operators .......................................................................133 Index.............................................................................................................137

Contents

Quick Reference for Views and Job-File Products February 2012

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

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 PW.Title16

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. 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. 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

up to 254

PW.Name_Line16

up to 254

Mr. John B. Smith Jr., CPA, Accountant Mr. and Mrs. David Zaiman Jones, John and Doe, Mary Record 1: Mr. John B. Smith, Jr., CPA Record 2: Business Objects, Sales Dept. Business Objects

PW.Name_Firm16

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. 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.)

PW.Firm12

up to 254

PW.FirmLoc12

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.) 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. Business Objects, Accounting Dept.

PW.FirmLine12

up to 254

Quick Reference for Views and Job-File Products February 2012

DataRight IQ input fields


Field name(s) Length Description Example of data

PW.Non_Addr16

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 1234 W Main St 1234 W Main St, Apt. 5 1234 W Main St, PO box 123

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. 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. If the input database has separate fields for city and state, present them to DataRight IQ through the input fields City and State. 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. If the input database has a field specifically for the 5-digit ZIP Code, present the field to DataRight IQ as ZIP. If the input database has a separate field for the 4-digit ZIP+4 extension, define the field as ZIP4. If the input database has a combined field for ZIP and ZIP4, present the field to DataRight IQ as ZIP10. It doesnt matter whether or not there is a hyphen between the codes.

PW.Unit

up to 60

Apt. 5

PW.City

up to 60

La Crosse

PW.State

WI

PW.ZIP PW.ZIP4 PW.ZIP10

5 4 10

54601 4051 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. If the input database contains a separate field for the Puerto Rican urbanization name, present the field to DataRight IQ as Urb. Urb Radioville

PW.Urb

up to 60

Chapter 1: DataRight IQ

DataRight IQ input fields


Field name(s) Length Description Example of data

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. 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). 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). Any data

PW.Line112

up to 60

PW.List_ID

up to 254

Broker A

PW.Delete

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. If the input database contains a field for the date, present it to DataRight IQ through Date1-6. If the input database contains a field for e-mail addresses, present it to DataRight IQ through EMail1-6. If the input database contains a field for phone numbers (either North American or International), present it to DataRight IQ through Phone1-6. If the input database contains a field for social security numbers, present it to DataRight IQ through SSN1-6. 1977-08-16 joex@Business Objects.com (608)-555-5555 61 7 4035 2170 111-22-3333

PW.Date16 PW.Email16 PW.Phone16

up to 60 up to 60 up to 60

PW.SSN16 PW.Pattern14

up to 60 254

If youve 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.

Quick Reference for Views and Job-File Products February 2012

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 fieldCUST_IDto 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

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.NameDesig16 APU.NameDesig16 AP.Pre_Name16 APU.Pre_Name16 AP.FirstName16 APU.FirstName16 AP.Mid_Name16 APU.Mid_Name16 AP.Last_Name16 APU.Last_Name16 AP.Mat_Post16 APU.Mat_Post16 AP.Oth_Post16 APU.Oth_Post16 AP.Title16 APU.Title16 AP.All_Names APU.All_Names AP.Name16 APU.Name16

254 254 254 254 254 254 254 254

Name designator such as Attn: or c/o. Prename, such as Mr., Ms., Dr. The prename may be parsed from the input data or assigned by DataRight IQ. First name or firstname initial. Middle name or middle initial. Surname. Postname indicating heritage, such as Jr., Sr., III. Postname indicating certification, academic degree, or affiliation, such as CPA, Ph.D., USMC.

Attn: Mr. John B. Smith Jr. CPA

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 or APU.All_Names will concatenate all AP.NAMEx or APU.NAMEx fields together. The entire name for one person, not including job title. Attn: Mr. John B. Smith, Jr., CPA

1500 254

10

Quick Reference for Views and Job-File Products February 2012

DataRight IQ output fields: Name and title data


Field name(s) Length Description Example of data

AP.Name_Line16 APU.Name_Line16

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. 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. Generic name words such as Occupant, Current Resident, or Family. The number of personal names found in the record (up to six).

Attn: Mr. John B. Smith, Jr., CPA, Accountant Jones, Mr. John and Doe, Ms. Mary

AP.Dual_Name APU.Dual_Name

254

Mr. and Mrs. Craig Pesik

AP.Spec_Name APU.Spec_Name AP.Name_Cnt

254 1

Occupant 2

Firm data

DataRight IQ output fields: Firm data


Field name(s) Length Description Example of data

AP.Firm12 APU.Firm12

up to 60

The name of a company or organization.

Input data: FIRSTLOGIC INCORP. AP.Firm1: Firstlogic, Inc. APU.Firm1: FIRSTLOGIC INCORP. Input data: SALES DEPARTMENT AP.Firm_Loc1: Sales Dept. APU.Firm_Loc1: SALES DEPARTMENT Business Objects, Sales Dept.

AP.Firm_Loc12 APU.Firm_Loc12

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.

AP.Firm_Line12 APU.Firm_Line12

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.

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.Gender16 APU.Gender16 AP.Gender_Rec

1 1

Gender codes for AP.Name16. For a list of gender codes, see AP.Gender_Rec. 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. Salutation for the person in the corresponding AP.Namex field. Salutation for AP.Dual_Name. Salutation for all persons in the record.

5 6

AP.Salute16 AP.Dual_Salut AP.Salute_Rec

up to 60 up to 60 up to 60

Dear Mr. Smith Dear Mr. and Mrs. Pesik 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.Address13 APU.Address13

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 NonMailing Cities parameter in the Standardization/Assignment block. Discrete state data. AP.State contains the standard U.S. Postal Service abbreviation, though only if Standardize Last Line is turned on. Input data: Wisc AP.State: WI APU.State: Wisc

AP.State APU.State

2 to 15

12

Quick Reference for Views and Job-File Products February 2012

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. 5digit 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. 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 5digit ZIP Code, DataRight IQ automatically blanks out AP.ZIP4, because the original ZIP4 data may not be correct. 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. Primary address (street address). Input data: La Crosse WI 54600 AP.ZIP: 54601 APU.ZIP: 54600

AP.ZIP APU.ZIP

AP.ZIP4 APU.ZIP4

Input data: La Crosse WI 54601-4051 AP.ZIP4: 4051 APU.ZIP4: 4051

AP.Last_Line APU.Last_Line

up to 30

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

Input data: 1000 VINE STREET WEST, APT. 123 AP.Prim_Addr: 1000 Vine Street West APU.Prim_Addr: 1000 VINE STREET WEST Input data: 1000 VINE STREET WEST, APT. 123 AP.Prim_Range: 1000 APU.Prim_Range: 1000 Input data: 1000 VINE STREET WEST, APT. 123 AP.Sec_Addr: Apt 123 APU.Sec_Addr: APT. 123 Input data: 1000 VINE STREET WEST, APT. 123 AP.Sec_Range: 123 APU.Sec_Range: 123

AP.Prim_Range APU.Prim_Range

up to 10

Primary range (house number only).

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. Secondary range (apartment or suite number only).

AP.Sec_Range APU.Sec_Range

up to 8

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 Input data: P.O. Box 12 AP.POBox: 12 APU.POBox: 12 Input data: RR 2, BOX 59 AP.RR_Line: RR 2, Box 59 APU.RR_Line: RR 2, BOX 59 Input data: RR 2, Box 59 AP.RR: 2 APU.RR: 2 Input data: RR 2, Box 59 AP.RRBox: 59 APU.RRBox: 59 Urb Radioville

AP.POBox APU.POBox AP.RR_Line APU.RR_Line

up to 11

Post-office box number.

up to 18

Complete line for rural-route or highway-contract addresses.

AP.RR APU.RR AP.RRBox APU.RRBox AP.Urb APU.Urb

up to 11

Rural-route or highway-contract number.

up to 11

Box number for rural-route or highway-contract address. Puerto Rican urbanization name.

up to 60

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 AP.Firm_Error

4 4

E101 if DataRight IQ did not parse any name data from the input record. Blank if any name data was found. E201 if DataRight IQ did not parse any company-name data from the input record. Blank if any company name data was found. E301 if DataRight IQ did not parse any address-line data from the input record. Blank if any address-line data was found. 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. A code indicating which name components DataRight IQ standardized during processing. For values and decoding instructions, see the DataRight IQ Users Guide.

E101 E201

AP.Addr_Error AP.LL_Error

4 4

E301 E402

AP.Name_Chng

C0000004

14

Quick Reference for Views and Job-File Products February 2012

DataRight IQ output fields: Error, change, and quality codes


Field name(s) Length Description Example of data

AP.Firm_Chng

A code indicating which firm components DataRight IQ standardized during processing. For values and decoding instructions, see the DataRight IQ Users Guide. 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. A code indicating which last-line components DataRight IQ changed (standardized) during processing. For values and decoding instructions, see the DataRight IQ Users Guide.

C01

AP.Addr_Chng

C0

AP.LL_Chng

C01

AP.Name_Qual

A code indicating which name components DataRight IQ found Q00023046 in the input data. For values and decoding instructions, see the DataRight IQ Users Guide. A code indicating which firm components DataRight IQ found in the input data. For values and decoding instructions, see the DataRight IQ Users Guide. Q01

AP.Firm_Qual

AP.Addr_Qual

A code indicating which address-line components DataRight IQ Q03 found in the input data. For values and decoding instructions, see the DataRight IQ Users Guide. A code indicating which last-line components DataRight IQ found in the input data. For values and decoding instructions, see the DataRight IQ Users Guide. C7

AP.LL_Qual

Status codes

DataRight IQ output fields: Status codes


Field name(s) Length Description Example of data

AP.Name_Stat

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). Status code for AP.Dual_Name: S0 AP.Dual_Name is empty. S1 AP.Dual_Name is populated.

S100000 This status code indicates that for AP.Name1 the gender of the prename and first name agree (1). AP.Name26 are empty (0). S1

AP.Dname_Stat

Chapter 1: DataRight IQ

15

DataRight IQ output fields: Status codes


Field name(s) Length Description Example of data

AP.Firm_Stat

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 persons name. 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.

S10 This status code indicates that the data in AP.Firm1 has a firmname format (1) and that AP.Firm2 is empty (0). S110 This status code indicates that data is present in AP.Address1 and AP.Address2 (1), and AP.Address3 is empty (0). S1

AP.Addr_Stat

AP.LL_Stat

Status code for AP.Last_Line: S0 Apx.Last_Line is empty. S1 Apx.Last_Line is populated.

Miscellaneous fields

DataRight IQ output fields: Miscellaneous fields


Field name(s) Length Description Example of data

AP.Bypass

T 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

T F

AP.Date16 AP.Email16 AP.EmailUser16 AP.EmailAllD16 AP.EmailTopD16 AP.Email2ndD16 AP.Email3rdD16 AP.Email4thD16 AP.Email5thD16 AP.EmailHost16

up to 60 up to 60 up to 80 up to 80 up to 80 up to 80 up to 80 up to 80 up to 80 up to 80

Contains the parsed date. Contains the parsed e-mail address. Contains the user name from the parsed e-mail address. Contains the entire domain name, without the user name, from the parsed e-mail address (everything after the @ symbol). Contains the top level domain from the parsed e-mail address. Contains the second level domain from the parsed e-mail address.

1977-08-16 joex@university.rr.sci.rm.edu.uk joex university.rr.sci.rm.edu.uk uk edu

Contains the third level domain from the parsed e-mail address. rm Contains the fourth level domain from the parsed e-mail address. scil

Contains the fifth level domain from the parsed e-mail address. rr Contains the host domain from the parsed e-mail address. university

16

Quick Reference for Views and Job-File Products February 2012

DataRight IQ output fields: Miscellaneous fields


Field name(s) Length Description Example of data

AP.EmailISP16 AP.USPhone16 AP.USAreaCod16 AP.USPhonPre16 AP.USPhonLin16 AP.USPhonExt16 AP.USPhoneTyp16 AP.IntPhone16 AP.IntCtryCd16 AP.IntCityCd16 AP.IntPhNum16 AP.IntPhDesc16 AP.SSN16 AP.Pattern14 AP.PatnLabel14 AP.Patnsub1-4_15 AP.Extra112

1 up to 60 3 3 4 10 32 up to 60 4 up to 32 up to 32 up to 64 up to 60 up to 60 up to 80 up to 254 up to 60

Contains a value indicating whether the domain of this email looked up in the ISP file. Contains the parsed North American (U.S. and Canada) phone number. Contains the area code from the parsed U.S. phone number. Contains the prefix from the parsed U.S. phone number. Contains the line number from the parsed U.S. phone number. Contains the extension from the parsed U.S. phone number. Contains the type of U.S. phone number. Contains the parsed international (non-North American) phone number. Contains the country code from the parsed international phone number.

T or F (608)-555-1212 608 555 1212 ext2500 business 011 44 4035 2170 44

Contains the city code from the parsed international phonenum- 4035 ber. Contains the line number from the parsed international phone number. Contains the description from the parsed international phone number. Contains the parsed U.S. Social Security number. Contains the parsed user-defined pattern. Contains the text label from the user defined file that identifies the pattern matched. Up to 5 sub patterns that make up your pattern rule. 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). Input file number, according to the sequence of Input File blocks in the job file. List number, according to the sequence of Input List Description blocks in the job file. Identifies the list to which the record belongs. The name of the output list that was defined. 1 1 2170 United Kingdom 111-22-3333 PN160-345

AP.File_No AP.List_No

up to 3 up to 3

AP.list_name

up to 60

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 records 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. Record number from the input file. on DOS, LF on UNIX. Use this as the end-of-record mark when posting to ASCII output files.
CRLF

42568

AP.Record_No AP.Newline

up to 10 1 to 2

127046
CRLF

Match standards for first and middle names

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 Example of data

APM.FirstName16 APM26.FirstName16

254

Match standards for AP.FirstName16. 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 Match standards for AP.Mid_Name16. Match standards are intended for use in later match processing. DataRight IQ returns up to six match standards for each middle name. If AP.Mid_Name1 contains Pat: APM.Mid_Name1: Patricia APM2.Mid_Name1: Patrick

APM.Mid_Name16 APM26.Mid_Name16

254

18

Quick Reference for Views and Job-File Products February 2012

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.NameDesig16 APC.Pre_Name16 APC.FirstName16 APC.Mid_Name16 APC.Last_Name16 APC.Mat_Post16 APC.Oth_Post16 APC.Name16 APC.Name_Line16 APC.All_Names APC.Dual_Name APC.Spec_Name APC.Title16 APC.Firm12 APC.Firm_Loc12 APC.Firm_Line12 APC.Record

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.

3 3

Confidence scores for AP.Name16 and APU.Name16. Confidence scores for AP.Name_Line16 and APU.Name_Line16. Confidence scores for AP.All_Names and APU.All_Names.

3 up to 60 3 3 3 3 3

Confidence score for AP.Dual_Name and APU.Dual_Name. Confidence scores for AP.Spec_Name and APU.Spec_Name. Confidence scores for AP.Title16 and APU.Title16. Confidence scores for AP.Firm12 and APU.Firm12. Confidence scores for AP.Firm_Loc12 and APU.Firm_Loc12. Confidence scores for AP.Firm_Line12 and APU.Firm_Line12. 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 February 2012

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 Description

Name (line)

PW.Name_Line

up to 60 ACE capitalizes name data. If youre performing Mover ID processing, ACE can take PW.Name_Line as input. up to 60 If youre 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.

Name (discrete name components)

PW.Pre_Name PW.First_Name PW.Mid_Name PW.Last_Name PW.Post_Name PW.Title PW.Firm

Title Firm

up to 60 ACE doesnt do anything with Title data except capitalize it. 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. 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). 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. 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.

Street address

PW.Address PW.Unit

PW.Urb

City State

PW.City PW.State

22

Quick Reference for Views and Job-File Products February 2012

ACE U.S. input fields


Type of data Field name Length Description

ZIP Code

PW.ZIP

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. 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 (+). If you have a combined field for ZIP and ZIP+4, present it through the ZIP10 field instead. For input, it doesnt 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.

PW.ZIP4

PW.ZIP10

10

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. 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. 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, thats 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

Multiline

PW.Line112

Last line

PW.Last_Line

Chapter 2: ACE U.S.

23

ACE U.S. input fields


Type of data Field name Length Description

Postal Codes

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. Youll need this for Postnet barcodes on letter mail, for LOT sortation., and for Periodicals (unless you do a true walk sequence). Chk_Digit is short for check digit. Some label-printing systems require this digit for Postnet barcoding. If you use Label Studio you dont need it from ACE; Label Studio can generate the check digit for itself. CART means carrier route. You will need CART numbers if you intend to sort mail to carrier routes for a postage discount. 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). 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. 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.

PW.Chk_Digit

PW.CART PW.LOT PW.LOT_Order

4 4 1

County

PW.County

Mark records for deletion

PW.Delete

Other PW fields PW

up to 60 ACE can accept a large number of other PW fields not listed here. Find a complete list in the Index. ACE doesnt necessarily process or use those other fields, but they are handy in posting or filters when you are working with files that dont 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 dont use the same field names.

user-defined fields

user:fieldname

24

Quick Reference for Views and Job-File Products February 2012

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. 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.

AP.City_Abbr

AP.City_LLIDX AP.City_Npref

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. 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 namecapitalized and with spelling corrected as necessarywill 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. 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. 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 ACEs 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. 2 5 Standard USPS abbreviation for the state (AK, AL, AR, and so on) 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 optionwe recommend the Erase setting. ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen. ZIP+4 add-on. ZIP and ZIP+4 add-on without hyphen.

AP. City_Place

AP.Last_Line

AP.State AP.ZIP

AP.ZIP10 AP.ZIP4 AP.ZIP9

10 4 9

Chapter 2: ACE U.S.

25

Assigned address-line components

ACE U.S. output fields: Assigned address-line components


Field name Length Description

AP.Address

up to 60 Complete, standardized primary and secondary address line. If the address is not assigned, you will get ACEs 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. 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. 20 to 60 Complete, standardized address line, including primary and secondary, if available. 14 14 28 20 10 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. 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. Consists of the data from EXTRAN_SEC and EXTRAN_PMB respectively. Any additional # data is placed in the remainder or extra components. Complete secondary non-postal address (PMB 10). Non-postal secondary range (PMB number only, does not include designator).

AP.Aline AP.Dual_Line AP.Extran_PMB AP.Extran_Sec AP.Extraneous AP.Np_Secaddr AP.Np_Srange AP.Np_Unit AP.PO_Box AP.Postdir APL.Postdir AP.Predir APL.Predir AP.Prim_Addr AP.Prim_Name

up to 10 Non-postal unit designator (PMB). up to 9 2 9 2 9 Post-office box number. Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW). Postdirectional spelled out (North, Northeast, East, and so on). Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW). Predirectional spelled out (North, Northeast, East, and so on).

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. 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. up to 10 Primary range (house number, such as 1000 in 1000 Vine Street). up to 60 Extraneous data found on the address line, which either cant be identified by the parser or does not belong in a standardized address. up to 9 up to 9 Rural-route box number. Rural-route number.

AP.Prim_Range AP.Remainder AP.RR_Box AP.RR_Number AP.Sec_Addr AP.Sec_Range AP.Suffix APL.Suffix

up to 60 Complete secondary address (for example, Apt 10, Set 500, Box 34, Am 7, 5th Flr). up to 8 4 10 Secondary range (apt. or suite number only, does not include designator). Abbreviated suffix (St, Ave, Blvd, Rd, and so on). Suffix spelled out (Street, Avenue, Boulevard, and so on).

26

Quick Reference for Views and Job-File Products February 2012

ACE U.S. output fields: Assigned address-line components


Field name Length Description

AP.Unit_Desig AP.Urb AP.USPS_Unit

up to 10 Unit designator (#, Apt, Ste, and so on). up to 60 Urbanization name; produced only when the address is in Puerto Rico. up to 10 Unit designator from ZIP+4 directory, or blank if none was found.

Alias address-line components

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 Users 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. 2 9 2 9 Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW). Postdirectional spelled out (North, Northeast, East, and so on). Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW). Predirectional spelled out (North, Northeast, East, and so on).

APA.Postdir APAL.Postdir APA.Predir APAL.Predir 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. 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. up to 10 Primary range (house number, such as 1000 in 1000 Vine Street) for the alternate address. up to 60 Complete secondary address (for example, Apt 10, Ste 500, Box 34, Rm 7, 5th Flr) for the alternate address. up to 8 4 10 Secondary range (apt. or suite number only, does not include designator). Abbreviated suffix (St, Ave, Blvd, Rd, and so on). Suffix spelled out (Street, Avenue, Boulevard, and so on).

APA.Prim_Name

APA.Prim_Range APA.Sec_Addr APA.Sec_Range APA.Suffix APAL.Suffix

Chapter 2: ACE U.S.

27

ACE U.S. output fields: Alias address-line components


Field name Length Description

APA.Type

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 Description

APD.Address APD.Extran_PMB APD.Extran_Sec APD.Extraneous APD.PO_Box APD.Postdir APDL.Postdir APD.Predir APDL.Predir APD.Prim_Addr APD.Prim_Name

20 to 60 Complete, standardized address line, including primary and secondary, if available. 14 14 28 up to 9 2 9 2 9 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. 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. Consists of the data from EXTRAN_SEC and EXTRAN_PMB respectively. Any additional # data is placed in the remainder or extra components. Post-office box number for the dual address. 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. 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.

up to 60 Standardized primary address. 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. up to 10 Primary range (house number, such as 1000 in 1000 Vine Street) of the dual address.

APD.Prim_Range

28

Quick Reference for Views and Job-File Products February 2012

ACE U.S. output fields: Dual address-line components


Field name Length Description

APD.Rec_Type

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 APD.RR_Box APD.RR_Number APD.Sec_Addr APD.Sec_Range APD.Suffix APDL.Suffix APD.Unit_Desig APD.Urb

up to 60 Extra data found on the address line, which either cant be identified by the parser or does not belong in a standardized address. up to 9 up to 9 Rural-route box number for the dual address. Rural-route number for the dual address.

up to 60 Standardized secondary address (for example, Apt 210 or Ste 300). up to 8 4 10 Secondary range (apartment or suite number only, does not include designator) of the dual address. 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.

up to 10 Unit designator (#, Apt, Ste, and so on) of the dual address. 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 (Line112). 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 AP.CR_Sort_Zn

4 1

Carrier-route number (for example, C1, R1, and so on). 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. Line-of-Travel number

AP.LOT

30

Quick Reference for Views and Job-File Products February 2012

ACE U.S. output fields: Postal codes


Field name Length Description

AP.LOT_Order

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. 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. Numeric 2-digit code for delivery-point barcode. Also used in LOT sortation (see LOT above). Blank when ZIP+4 could not be assigned. 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 optionwe recommend the Erase setting. ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen. ZIP+4 add-on. ZIP and ZIP+4 add-on without hyphen.

AP.Chk_Digit

AP.DPBC AP.ZIP

2 5

AP.ZIP10 AP.ZIP4 AP.ZIP9

10 4 9

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

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 Error code, if address is unassigned; or status code, if assigned. Error code, if address is unassigned; or blank, if assigned.

AP.Err_Stat AP.Error_Code

6 6

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 AP.Foreign AP.LACSCODE

1 1 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. Foreign address flag: F for foreign addresses, blank for domestic U.S. 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. T F Last line was matched to a City/ZCF record. Last line was not matched to a City/ZCF record.

AP.Match_5 AP.Match_9

1 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. T The address is tagged by the USPS as unsuitable for mail delivery. This includes E600 records (for example, a cemetary or parking lot) as well as E601 records which are deemed undeliverable using DPV processing. 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.

AP.Match_Un

F AP.NC_Firm Up to 60

The firm match that was made using the input ZIP+4 for missing or invalid firm information. The secondary address match that was made using the input ZIP+4 for missing or invalid secondary address information. The secondary range match that was made using the input ZIP+4 for missing or invalid secondary range information. The unit designator match that was made using the input ZIP+4 for missing or invalid unit designator information.

AP.NC_Secaddr Up to 60 AP.NC_Srange AP.NC_Unit Up to 8 Up to 10

32

Quick Reference for Views and Job-File Products February 2012

ACE U.S. output fields: Codes that describe the address and assignment results
Field name Length Description

AP.Rec_Type

Record-type indicator for the assigned address. The first character indicates the type of record in the ZIP+4 directory to which the address was matched: 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. Status code (whether assigned or not). The sixth character returned for this field is currently unused and will be blank. 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. 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.

AP.Stat_Code AP.ZIP_Move

6 1

AP.ZIP_Type

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

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.

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. 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.

AP.DPV_NoStat

34

Quick Reference for Views and Job-File Products February 2012

ACE U.S. output fields: Codes that describe the address and assignment results
Field name Length Description

AP.DPV_Status

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. Vacant address indicator. Y Address is vacant. N Address is not vacant. blank Address was not looked up Throwback indicator. Y Customer with street address wants delivery at PO Box instead. N No throwback necessary. blank Address was not looked up. Seasonal address indicator. Y Address is seasonally occupied. N Address is not seasonal. blank Address was not looked up. 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. Record type. B Business address. R Residential address. U Unknown. AP.DSF_Deltype is blank. blank No information available. 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.

AP.DPV_Vacant

AP.DSF_Tback

AP.DSF_Season

AP.DSF_Busind

AP.DSF_Rectyp

AP.DSF_Deltyp

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

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. 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. Educational indicator. Y Address is an educational institution. N Address is not an educational institution. blank Address was not looked up. LACS (Locatable Address Conversion System) indicator. Y Address is LACS convertible. N Address is not LACS convertible. blank Address was not looked up. 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. 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 youre performing NCOALink processing also).

AP.DSF_Dropct

AP.DSF_Edu

AP.DSF_LACS

AP.Walk_Seq

AP.DSF_Seqsrc

36

Quick Reference for Views and Job-File Products February 2012

Other useful codes

ACE U.S. output fields: Other useful codes


Field name Length Description

AP.CASS_Match

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. 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. FIPS county code. Numbers are unique within states. (FIPS stands for Federal Information Processing Standard.) Fully spelled county name (for example, La Crosse instead of 63). Indicates a type of postal facility. For ordinary addressesexcept those specifically for a postal facilityyou will most often get a P, B, C, or N. This component is blank when the address is unassigned.
A B C D E F G

AP.Congress

AP.County AP.CountyName AP.FacType

3 25 1

Airport Mail Facility (AMF) Branch Office Community Post Office (CPO) Area Distribution Center (ADC) Sectional Center Facility (SCF) Delivery Distribution General Mail Facility (GMF)

K M N P S U

Network Distribution Center (NDC) Money Order Unit City place name, invalid for mailing Post Office (main) Station Urbanization (Puerto Rico only)

Chapter 2: ACE U.S.

37

ACE U.S. output fields: Other useful codes


Field name Length Description

AP.FIPSCODE

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 02 Alaska 04 Arizona 05 Arkansas 06 California 08 Colorado 09 Connecticut 10 Delaware 11 Dist. Of Columbia 12 Florida 13 Georgia 15 Hawaii 16 Idaho 17 Illinois 18 Indiana 19 Iowa 20 Kansas 21 Kentucky 22 Louisiana 23 Maine 24 Maryland 25 Massachusetts 26 Michigan 27 Minnesota 28 Mississippi 29 Missouri 30 Montana 31 Nebraska 32 Nevada 33 New Hampshire 34 New Jersey 35 New Mexico 36 New York 37 North Carolina 38 North Dakota 39 Ohio 40 Oklahoma 41 Oregon 42 Pennsylvania 44 Rhode Island 45 South Carolina 46 South Dakota 47 Tennessee 48 Texas 49 Utah 50 Vermont 51 Virginia 53 Washington 54 West Virginia 55 Wisconsin 56 Wyoming 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. 1 or 2 1 1 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.
C L

AP.Newline AP.Qss_Dflt AP.RDI

R F

Indicates whether the record qualified as a default match rather than qualifying as a match at higher level of assignment. 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

Quick Reference for Views and Job-File Products February 2012

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. 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.

AP.Record_No

Geocensus codes

The Geocensus codes are listed by option.

ACE U.S. output fields: Geocensus codes


Option Field name 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 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). FIPS state code. FIPS county code. FIPS place code. A number assigned by the U.S. government to each incorporated municipality (city, village, town, etc.). U.S. Census tract and Block Numbering Area (BNA). U.S. Census Bureau minor civil division (MCD) data or, if MCD data is unavailable, census county division (CCD) data. 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 CBSAs 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.

AP.Ageo_Lng

11

AP.Ageo_Sta AP.Ageo_Cty AP.Ageo_Pla AP.Ageo_Blk AP.Ageo_MCD Centroid AP.Cgeo_CBSA

2 3 5 10 6 5

Chapter 2: ACE U.S.

39

ACE U.S. output fields: Geocensus codes


Option 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 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). Metropolitan Statistical Area (MSA) number. 0000 indicates the address does not lie in any MSA; usually a rural area. U.S. Census tract and block-group number. The first 6 digits are the tract number, 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. 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.

AP.Cgeo_Lng

11

AP.Cgeo_Msa AP.Cgeo_Blk

4 10

Centroid

AP.Cgeo_Match

Both Address- AP.Geo_Match Level and Centroid

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.

40

Quick Reference for Views and Job-File Products February 2012

Mover ID components for NCOALink


Audit components

The fields listed below are for use only during NCOALink audit testing. The USPS requires them and dictates their content and length.

ACE U.S. output fields: Mover ID components for NCOALink Audit components
Field name Length Description

AP.Aud_Pname AP.Aud_Range AP.Aud_Srange AP.Aud_Unit APM.Aud_Fields

up to 28 This is the primary name that was sent to NCOALink for matching. This field is required for audits. up to 10 This is the range that was sent to NCOALink for matching. This field is required for audits. up to 10 This is the secondary range that was sent to NCOALink for matching. This field is required for audits. up to 8 700 This is the unit data that was sent to NCOALink for matching. This field is required for audits. 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. 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_Mid APM.Aud_Pname APM.Aud_Range APM.Aud_Srange APM.Aud_Unit APM.Drop APM.Drop_N APM.Firm

up to 28 This is the primary name according to the NCOALink move record. This field is required for audits. up to 10 This is the range data according to the NCOALink move record. This field is required for audits. up to 10 This is the secondary range according to the NCOALink move record. This field is required for audits. up to 8 1 1 60 This is the unit data according to the NCOALink move record. This field is required for audits. This field is used for audit testing. This field is also populated when an ANKLink match is made. This field is used for audit testing. This field is also populated when an ANKLink match is made. 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. This field is used for audit testing. This field is also populated when an ANKLink match is made. This field is used for audit testing.

APM.Gender APM.Hint_byte

1 8

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 youre performing NCOALink certification or audit testing. This information goes into the Test Client Output File. See your Mover ID Users Guide for details 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.

APM.Pre_Name APM.First_Name APM.Mid_Name APM.Last_Name APM.Post_Name

6 15 15 20 6

42

Quick Reference for Views and Job-File Products February 2012

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 APM.Postdir APM.Predir APM.Prim_Addr APM.Prim_Name

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. 2 2 Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW). Long form not available. Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW). Long form not available.

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. 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 APM.Sec_Range APM.Suffix APM.Unit_Desig APM.Urb up to 60 Complete secondary address (for example, Apt 10, Ste 500, Box 34, Rm 7, 5th Flr). up to 8 4 Secondary range (apt. or suite number only, does not include designator). Abbreviated suffix (St, Ave, Blvd, Rd, and so on). Long form not available.

up to 10 Unit designator (#, Apt, Ste, and so on). 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. 28 to 43 Complete, standardized last line, including city, state, ZIP, and ZIP+4. 2 5 10 4 9 Standard USPS abbreviation for the state (AK, AL, and so on) for the new address. Either the 5-digit ZIP assigned by ACE or, if ACE could not assign, then the ZIP found in the move record. ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen. ZIP+4 add-on. ZIP and ZIP+4 add-on without hyphen.

APM.Last_Line APM.State APM.ZIP APM.ZIP10 APM.ZIP4 APM.ZIP9


Postal codes

APM.CART APM.Chk_Digit APM.DPBC APM.LOT

4 1 2 4

Carrier-route number (for example, C001, R001, and so on). Check digit for the Postnet barcode. Numeric 2-digit code for delivery-point barcode. Line-of-Travel number.
Chapter 2: ACE U.S.

43

ACE U.S. output fields: Mover ID components for NCOALink data


Field name Length Description

APM.LOT_Order

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

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, youll 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. 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. 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.

APM.Move_Type

APM.RetCode

44

Quick Reference for Views and Job-File Products February 2012

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 information@businessobjects.com 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 APM.Extran_PMB APM.Extran_Sec APM.Extraneous APM.Np_Secaddr APM.Np_Srange APM.Np_Unit APM.PO_Box APM.RR_Box APM.RR_Number APM.USPS_Unit

up to 60 Complete address line: Primary, secondary, and urbanization. This component will contain the USPS street abbreviation if that option is enabled. 14 14 28 20 10 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. 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. Consists of the data from EXTRAN_SEC and EXTRAN_PMB respectively. Any additional # data is placed in the remainder or extra components. Complete secondary non-postal address (PMB 10). Non-postal secondary range (PMB number only, does not include designator).

up to 10 Non-postal unit designator (PMB). up to 9 up to 9 up to 9 Post-office box number (box number only, such as 333 for address PO box 333). Rural-route box number (box number only, such as 22 for address Rural Route 1 Box 22). Rural-route number (route number only, such as 1 for address Rural Route 1 Box 22).

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 APM.City_Npref

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. 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 namecapitalized and with spelling corrected as necessarywill 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. 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.

APM.City_Place

Chapter 2: ACE U.S.

45

ACE U.S. output fields: Mover ID components for NCOALink postal and other codes
Field name Length Description

Postal codes

APM.CR_Sort_Zn

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.

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. 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 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. FIPS county code. Numbers are unique within states. (FIPS stands for Federal Information Processing Standard.) Fully spelled county name (for example, La Crosse instead of 63). Error code, if address is unassigned; or status code, if assigned.

APM.CASSrectyp

APM.Congress

APM.County APM.CountyName APM.Err_Stat

3 25 6

46

Quick Reference for Views and Job-File Products February 2012

ACE U.S. output fields: Mover ID components for NCOALink postal and other codes
Field name Length Description

APM.EWS_Match APM.FacType

1 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. Indicates a type of postal facility. For ordinary addressesexcept those specifically for a postal facilityyou will most often get a P, B, C, or N. This component is blank when the address is unassigned.
A B C D E F G

Airport Mail Facility (AMF) Branch Office Community Post Office (CPO) Area Distribution Center (ADC) Sectional Center Facility (SCF) Delivery Distribution General Mail Facility (GMF

K M N P S U

Network Distribution Center (NDC) Money Order Unit City place name, invalid for mailing Post Office (main) Station Urbanization J (Puerto Rico only)

APM.Foreign APM.LACSCODE

1 1

Foreign address flag: F for foreign addresses, blank for domestic U.S. 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. T Last line was matched to a City/ZCF record. F Last line was not matched to a City/ZCF record. 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. 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.

APM.Match_5 APM.Match_9

1 1

APM.Match_Un

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

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. Status code (whether assigned or not). The sixth character returned for this field is currently unused and will be blank. 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. 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.

APM.Stat_Code APM.ZIP_Move

6 1

APM.ZIP_Type

48

Quick Reference for Views and Job-File Products February 2012

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 information@businessobjects.com 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). FIPS state code. FIPS county code. FIPS place code. A number assigned by the U.S. government to each incorporated municipality (city, village, town, etc.). U.S. Census tract and BNA, in the format: 123456 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 CBSAs 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. 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). Metropolitan Statistical Area (MSA) number. 0000 indicates the address does not lie in any MSA; usually a rural area. U.S. Census tract and block-group number. The first 6 digits are the tract number, 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. 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.

APM.Ageo_Sta APM.Ageo_Cty APM.Ageo_Pla APM.Ageo_Blk APM.Cgeo_CBSA

2 3 5 7 5

APM.Cgeo_Lat APM.Cgeo_Lng

10 11

APM.Cgeo_Msa APM.Cgeo_Blk

4 7

APM.Cgeo_Match

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

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. 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 cant assign the input address.

APM.DPV_CMRA

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. 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.

APM.DPV_NoStat

50

Quick Reference for Views and Job-File Products February 2012

ACE U.S. output fields: Mover ID components for NCOALink postal and other codes
Field name Length Description

APM.DPV_Status

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. Vacant address indicator. Y Address is vacant. N Address is not vacant. blank Address was not looked up Throwback indicator. Y Customer with street address wants delivery at PO Box instead. N No throwback necessary. blank Address was not looked up. Seasonal address indicator. Y Address is seasonally occupied. N Address is not seasonal. blank Address was not looked up. 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. Record type. B Business address. R Residential address. U Unknown. AP.DSF_Deltype is blank. blank No information available. 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.

APM.DPV_Vacant

APM.DSF_Tback

APM.DSF_Season

APM.DSF_Busind

APM.DSF_Rectyp

APM.DSF_Deltyp

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

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. 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. Educational indicator. Y Address is an educational institution. N Address is not an educational institution. blank Address was not looked up. LACS (Locatable Address Conversion System) indicator. Y Address is LACS convertible. N Address is not LACS convertible. blank Address was not looked up. The residential delivery indicator (RDI) shows if the address is residential or nonresidential. Y Residential address N Nonresidential address The proprietary identifier that Vertex Sales and Use Tax Software requires to determine tax jurisdictions.

APM.DSF_Dropct

APM.DSF_Edu

APM.DSF_LACS

APM.RDI

APM.TaxIQ

52

Quick Reference for Views and Job-File Products February 2012

ACE U.S. output fields: Mover ID components for NCOALink postal and other codes
Field name Length Description

Other useful codes

APM.FIPSCODE

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 02 Alaska 04 Arizona 05 Arkansas 06 California 08 Colorado 09 Connecticut 10 Delaware 11 Dist. Of Columbia 12 Florida 13 Georgia 15 Hawaii 16 Idaho 17 Illinois 18 Indiana 19 Iowa 20 Kansas 21 Kentucky 22 Louisiana 23 Maine 24 Maryland 25 Massachusetts 26 Michigan 27 Minnesota 28 Mississippi 29 Missouri 30 Montana 31 Nebraska 32 Nevada 33 New Hampshire 34 New Jersey 35 New Mexico 36 New York 37 North Carolina 38 North Dakota 39 Ohio 40 Oklahoma 41 Oregon 42 Pennsylvania 44 Rhode Island 45 South Carolina 46 South Dakota 47 Tennessee 48 Texas 49 Utah 50 Vermont 51 Virginia 53 Washington 54 West Virginia 55 Wisconsin 56 Wyoming 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 APM.Qss_Dflt APM.Rec_No_Out 1 or 2 1 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.
C L

R F

Indicates whether the record qualified as a default match rather than qualifying as a match at higher level of assignment.

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. 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.

APM.Record_No

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 USPSs 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

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. 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. 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 couldnt 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.

AP.LACSL_Qry

50

AP.LACSL_Ret

Output components for ANKLink

The following table contains output components for ANKLink information.

54

Quick Reference for Views and Job-File Products February 2012

U.S. ACE output fields: ANKLink output components


Field name Length Description

APM.ANKL_Ret

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

The result of SuiteLink processing. A SuiteLink matchsecondary information exists and was assigned to this record as a result of SuiteLink processing. 00 SuiteLink no matchlookup 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. 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. 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. The numeric 2-digit code for the delivery point barcode that was generated before SuiteLink processing. The secondary range information that existed before SuiteLink processing. If this is blank, ACE did not assign any secondary information. The unit designator that existed before SuiteLink processing. If this is blank, ACE did not assign any secondary information. 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.

AP.PreSL_ZIP

AP.PreSL_ZIP4 AP.PreSL_DPBC AP.PreSL_SecR AP.PreSL_Unit AP.Input_Firm

4 2 up to 8 up to 10 60

Chapter 2: ACE U.S.

55

Output fields for ACE Pre-LACSLink fields (APPL)


Last-line components

Pre-LACSLink application component, or APPL fields are used to retain address components that were replaced with LACSLink address information.

ACE U.S. output fields: Last-line components


Field name Length Description

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. 13 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.

APPL.City_Abbr

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. 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 namecapitalized and with spelling corrected as necessarywill 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. 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. 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 ACEs 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. 2 5 Standard USPS abbreviation for the state (AK, AL, AR, and so on) 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 optionwe recommend the Erase setting. ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen. ZIP+4 add-on. ZIP and ZIP+4 add-on without hyphen.

APPL.City_Npref

APPL.City_Place

APPL.Last_Line

APPL.State APPL.ZIP

APPL.ZIP10 APPL.ZIP4 APPL.ZIP9

10 4 9

56

Quick Reference for Views and Job-File Products February 2012

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 ACEs 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. 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. 20 to 60 Complete, standardized address line, including primary and secondary, if available. 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. 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. Consists of the data from EXTRAN_SEC and EXTRAN_PMB respectively. Any additional # data is placed in the remainder or extra components. Complete secondary non-postal address (PMB 10). Non-postal secondary range (PMB number only, does not include designator).

APPL.Aline APPL.Dual_Line APPL.Extran_PMB

APPL.Extran_Sec

14

APPL.Extraneous APPL.Np_Secaddr APPL.Np_Srange APPL.Np_Unit APPL.PO_Box APPL.Postdir APL.Postdir APPL.Predir APL.Predir APPL.Prim_Addr APPL.Prim_Name

28 20 10

up to 10 Non-postal unit designator (PMB). up to 9 2 9 2 9 Post-office box number. Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW). Postdirectional spelled out (North, Northeast, East, and so on). Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW). Predirectional spelled out (North, Northeast, East, and so on).

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. 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. up to 10 Primary range (house number, such as 1000 in 1000 Vine Street). up to 60 Extraneous data found on the address line, which either cant be identified by the parser or does not belong in a standardized address. up to 9 up to 9 Rural-route box number. Rural-route number.

APPL.Prim_Range APPL.Remainder APPL.RR_Box APPL.RR_Number APPL.Sec_Addr APPL.Sec_Range APPL.Suffix

up to 60 Complete secondary address (for example, Apt 10, Set 500, Box 34, Am 7, 5th Flr). up to 8 4 Secondary range (apt. or suite number only, does not include designator). 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 APPL.Urb APPL.USPS_Unit

up to 10 Unit designator (#, Apt, Ste, and so on). up to 60 Urbanization name; produced only when the address is in Puerto Rico. 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 (Line112). 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

Carrier-route number (for example, C1, R1, and so on).

58

Quick Reference for Views and Job-File Products February 2012

ACE U.S. output fields: Postal codes


Field name Length Description

APPL.CR_Sort_Zn

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. Line-of-Travel number 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. 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. Numeric 2-digit code for delivery-point barcode. Also used in LOT sortation (see LOT above). Blank when ZIP+4 could not be assigned. 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 optionwe recommend the Erase setting. ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen. ZIP+4 add-on. ZIP and ZIP+4 add-on without hyphen.

APPL.LOT APPL.LOT_Order

4 1

APPL.Chk_Digit

APPL.DPBC APPL.ZIP

2 5

APPL.ZIP10 APPL.ZIP4 APPL.ZIP9

10 4 9

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

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) 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. 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. T F Last line was matched to a City/ZCF record. Last line was not matched to a City/ZCF record.

APPL.EWS_Match APPL.LACSCODE

1 1

APPL.Match_5 APPL.Match_9

1 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. 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.

APPL.Match_Un

APPL.NC_Firm APPL.NC_Secaddr APPL.NC_Srange APPL.NC_Unit

Up to 60 Up to 60 Up to 8 Up to 10

The firm match that was made using the input ZIP+4 for missing or invalid firm information. The secondary address match that was made using the input ZIP+4 for missing or invalid secondary address information. The secondary range match that was made using the input ZIP+4 for missing or invalid secondary range information. 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 February 2012

ACE U.S. output fields: Codes that describe the address and assignment results
Field name Length Description

APPL.Rec_Type

Record-type indicator for the assigned address. The first character indicates the type of record in the ZIP+4 directory to which the address was matched: 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. 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. 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.

APPL.ZIP_Move

APPL.ZIP_Type

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

Y N L blank

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.

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. 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.

APPL.DPV_NoStat

62

Quick Reference for Views and Job-File Products February 2012

ACE U.S. output fields: Codes that describe the address and assignment results
Field name Length Description

APPL.DPV_Status

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. Vacant address indicator. Y Address is vacant. N Address is not vacant. blank Address was not looked up

APPL.DPV_Vacant

Other useful codes

ACE U.S. output fields: Other useful codes


Field name Length Description

APPL.CASS_Match

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. 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.

APPL.Congress

Chapter 2: ACE U.S.

63

ACE U.S. output fields: Other useful codes


Field name Length Description

APPL.County APPL.CountyName APPL.FacType

3 25 1

FIPS county code. Numbers are unique within states. (FIPS stands for Federal Information Processing Standard.) Fully spelled county name (for example, La Crosse instead of 63). Indicates a type of postal facility. For ordinary addressesexcept those specifically for a postal facilityyou will most often get a P, B, C, or N. This component is blank when the address is unassigned.
A B C D E F G

Airport Mail Facility (AMF) Branch Office Community Post Office (CPO) Area Distribution Center (ADC) Sectional Center Facility (SCF) Delivery Distribution General Mail Facility (GMF)

K M N P S U

Network Distribution Center (NDC) Money Order Unit City place name, invalid for mailing Post Office (main) Station Urbanization (Puerto Rico only)

APPL.FIPSCODE

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 02 Alaska 04 Arizona 05 Arkansas 06 California 08 Colorado 09 Connecticut 10 Delaware 11 Dist. Of Columbia 12 Florida 13 Georgia 15 Hawaii 16 Idaho 17 Illinois 18 Indiana 19 Iowa 20 Kansas 21 Kentucky 22 Louisiana 23 Maine 24 Maryland 25 Massachusetts 26 Michigan 27 Minnesota 28 Mississippi 29 Missouri 30 Montana 31 Nebraska 32 Nevada 33 New Hampshire 34 New Jersey 35 New Mexico 36 New York 37 North Carolina 38 North Dakota 39 Ohio 40 Oklahoma 41 Oregon 42 Pennsylvania 44 Rhode Island 45 South Carolina 46 South Dakota 47 Tennessee 48 Texas 49 Utah 50 Vermont 51 Virginia 53 Washington 54 West Virginia 55 Wisconsin 56 Wyoming 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 February 2012

ACE U.S. output fields: Other useful codes


Field name Length Description

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. 1 1 Indicates whether the record qualified as a default match rather than qualifying as a match at higher level of assignment. 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.Qss_Dflt APPL.RDI

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. 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.

APPL.Record_No

Geocensus codes

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 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). FIPS state code. FIPS county code. FIPS place code. A number assigned by the U.S. government to each incorporated municipality (city, village, town, etc.). U.S. Census tract and Block Numbering Area (BNA). U.S. Census Bureau minor civil division (MCD) data or, if MCD data is unavailable, census county division (CCD) data.

APPL.Ageo_Lng

11

APPL.Ageo_Sta APPL.Ageo_Cty APPL.Ageo_Pla APPL.Ageo_Blk APPL.Ageo_MCD

2 3 5 10 6

Chapter 2: ACE U.S.

65

ACE U.S. output fields: Geocensus codes


Option Field name Length Description

Centroid

APPL.Cgeo_CBSA

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 CBSAs 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. 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). Metropolitan Statistical Area (MSA) number. 0000 indicates the address does not lie in any MSA; usually a rural area. U.S. Census tract and block-group number. The first 6 digits are the tract number, 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. 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.

APPL.Cgeo_Lat

10

APPL.Cgeo_Lng

11

APPL.Cgeo_Msa APPL.Cgeo_Blk

4 10

Centroid

APPL.Cgeo_Match

Both Address- APPL.Geo_Match Level and Centroid

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.

SuiteLink output fields

The following table contains output components for SuiteLink information.

66

Quick Reference for Views and Job-File Products February 2012

ACE U.S. output fields: SuiteLink fields


Field name Length Description

APPL.SteLink_RC

The result of SuiteLink processing. A SuiteLink matchsecondary information exists and was assigned to this record as a result of SuiteLink processing. 00 SuiteLink no matchlookup 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. 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. 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. The numeric 2-digit code for the delivery point barcode that was generated before SuiteLink processing. The secondary range information that existed before SuiteLink processing. If this is blank, ACE did not assign any secondary information. The unit designator that existed before SuiteLink processing. If this is blank, ACE did not assign any secondary information. 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.

APPL.PreSL_ZIP

APPL.PreSL_ZIP4 APPL.PreSL_DPBC APPL.PreSL_SecR APPL.PreSL_Unit APPL.Input_Firm

4 2 up to 8 up to 10 60

Chapter 2: ACE U.S.

67

ACE U.S. address status codes

ACE U.S. address status codes


Digit Description Description

1st

A B

ACE had to truncate the address line to make it fit into your field. ACE truncated both the address line and the city name.

C S

ACE had to truncate the city name to make it fit into your field. ACE didnt truncate anything. ACE assigned a different ZIP+4.

2nd

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. ACE assigned a different city. ACE assigned a different city and ZIP. ACE assigned a different state. ACE assigned a different state and ZIP. ACE assigned a different city and state. ACE assigned a different city, state, and ZIP. Regarding the primary name, directionals, and suffix, there is no significant difference between the input and what ACE assigned. ACE assigned a different suffix. ACE assigned a different predirectional. ACE assigned a different predirectional and suffix. ACE assigned a different postdirectional. 9 A B C D E F 8

1 2 3 4 5 6 7 3rd 0

ACE assigned a different ZIP and ZIP+4. ACE assigned a different city and ZIP+4. ACE assigned a different city, ZIP, and ZIP+4. ACE assigned a different state and ZIP+4. ACE assigned a different state, ZIP, and ZIP+4. ACE assigned a different city, state, and ZIP+4. ACE assigned a different city, state, ZIP and ZIP+4. ACE assigned a different primary name.

1 2 3 4 5 6 7

9 A B C

ACE assigned a different primary name and suffix. ACE assigned a different predirectional and primary name. ACE assigned a different predirectional, primary name, and suffix. ACE assigned a different primary name and postdirectional. ACE assigned a different primary name, suffix, and postdirectional. ACE assigned a different predirectional, primary name, and postdirectional. ACE assigned a different predirectional, primary name, postdirectional, and suffix.

ACE assigned a different suffix and postdirectional. D ACE assigned a different predirectional and postdirectional. ACE assigned a different predirectional, suffix, and postdirectional. E F

68

Quick Reference for Views and Job-File Products February 2012

ACE U.S. address status codes


Digit Description Description

4th

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 unit designator. ACE assigned a different DPBC. ACE assigned a different DPBC and unit designator. ACE assigned a different CART. 9 A B C

ACE assigned a different county number.

1 2 3 4 5 6 7 5th 0

ACE assigned a different county number and unit designator. ACE assigned a different county number and DPBC. ACE assigned a different county number, DPBC, and unit designator. ACE assigned a different county number and CART. ACE assigned a different county number, CART, and unit designator. ACE assigned a different county number, CART, and DPBC. ACE assigned a different county number, CART, DPBC, and unit designator. ACE assigned a different urbanization.

ACE assigned a different CART and unit designator. D ACE assigned a different CART and DPBC. ACE assigned a different CART, DPBC, and unit designator. Regarding the LOT, LOT_Order, and Puerto Rican urbanization, there is no significant difference between the input data and the data that ACE assigned. ACE assigned a different LOT. ACE assigned a different LOT_Order. ACE assigned a different LOT and LOT_Order. Reserved for future use. E F 4

1 2 3 6th

5 6 7

ACE assigned a different urbanization and LOT. ACE assigned a different urbanization and LOT_Order. ACE assigned a different urbanization, LOT, and LOT_Order.

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 No street assignment was possible, there was a duplicate postal-code match No street assignment, no postal code No street assignment, postal code not matched Multiple match, different directory areas U.S. Exact match made in EWS directory

E212 E213 E214 E216 E302 E412 E413 E420 E421 E422 E423 E425 E427 E428 E429 E430 E431

Can Can Can

U.S. No city and bad ZIP/postal code U.S. Bad city, valid state/province, and no ZIP/postal code U.S. Bad city and bad ZIP/postal code U.S. Bad ZIP, cant determine which city match to select

E434 E435 E436 E437 E439 E450

Can Can Can Can

Can Can Can

U.S. No primary address line parsed U.S. Street name not found in directory

Can Can Can Can Can Can

High rank has out-of-range suite High rank has out-of-range PO box PO box vs. civic postal-code mismatch Multiple suite ranking conflict U.S. Other error U.S. Foreign address U.S. Input record entirely blank U.S. ZIP not in area covered by partial ZIP+4 directory U.S. Overlapping ranges in ZIP+4 directory U.S. Address does not exist in the USPS directories. Undeliverable address. U.S. Marked by USPS as unsuitable for delivery of mail U.S. The primary address number did not DPV confirm, and the ZIP+4 was removed.

U.S. Possible street-name matches too close E451 to choose one U.S. Primary range is missing E452 E453 E500 E501 E502 E503 E504

Can

U.S. Primary range is invalid for the street/ route/building U.S. Predirectional needed, input is wrong or missing

Can

U.S. Suffix needed, input is wrong or missing U.S. Suffix and directional needed, input is wrong or missing

Can

U.S. [Post] Directional needed, input is wrong or missing U.S. Bad ZIP, cant select an address match

U.S. Bad city, cant select an address match E505 Can U.S. Possible address-line matches too close to choose one 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

E432

70

Quick Reference for Views and Job-File Products February 2012

Chapter 3: 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 3: Match/Consolidate

71

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 PW.Unit PW.Pmb PW.City PW.State PW.AppBlnkPri

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 up to 60 up to 14 up to 60 2 1

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 Apt 5 1234 La Crosse WI

Can only be used with Extended Address Parsing.

For suppression lists only. Determines whether Match/ Consolidate should apply blank priority to the suppression lists match priority. Y Apply blank priority to this lists match priority. N Do not apply blank priority to this lists 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. Birthdate 1960/09/13

PW.Birthdate PW.Delete

60 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. Carrier route number. County code. Country name. 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. C124 020 Canada

PW.CART PW.County PW.Country PW.Driv_Prior

4 3 up to 60 3

72

Quick Reference for Views and Job-File Products February 2012

Match/Consolidate input fields


Field name Length Description Example of data

PW.Driv_Salvg

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. 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). 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). 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. 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. Firstpart12 may be used for the prename, first name, and middle name for each of two names. Lastpart12 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. 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 files 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. 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. Business Objects

PW.Firm or PW.Firm1

up to 60

PW.Firm1-2

up to 60

Business Objects

PW.Firmline12

up to 60

Business Objects, Accounting Dept

PW.Firstpart1-2 PW.Lastpart1-2

up to 60

Mr. John B. Smith Jr., CPA, Accountant

PW.ID1-9

up to 10

ID1=2345

PW.Last_Line

up to 60

La Crosse WI 54601-4051

Chapter 3: Match/Consolidate

73

Match/Consolidate input fields


Field name Length Description Example of data

PW.Line16

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 firmsonly addresses. If you use all 6 lines, you must include Last_Line within those 6 lines. 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). 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. Determines the lists 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. 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. 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.

Any data

PW.List_ID

up to 254

List_ID = house_file List_ID = DB.list_code

PW.List_NewID

PW.List_Prior

PW.List_Srch

PW.List_Type

74

Quick Reference for Views and Job-File Products February 2012

Match/Consolidate input fields


Field name Length Description Example of data

PW.Merg_Purg10

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 jobs match criteria. 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_Firm16 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. 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_Line16). 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_Line16). 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. Telephone number Mr. John B. Smith Jr., CPA Business Objects Mr. and Mrs David Zaiman

PW.Name_Firm1-6

up to 60

PW.Name_Line16

up to 60

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

Mr. John B. Smith Jr., CPA Mr. and Mrs. David Zaiman Tony Deets and Geoffrey Skipton

PW.Phone

60

(608)-555-5555 61 7 4035 2170

Chapter 3: Match/Consolidate

75

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. 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.

Mr. John B. Smith CPA

PW.Prim_Name

up to 28

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. Social Security Number 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 (Title16). 111-22-3333 Accountant

PW.SSN PW.Title16

60 up to 60

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. 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. Match/Consolidate can accept a large number of other PW fields not listed here. See Index on page 181. Match/Consolidate doesnt necessarily process or use those other fields, but they are handy in posting or filters when you are working with files that dont use the same field names. Phone = DB.account_no

PW.ZIP PW.ZIP4 PW.ZIP10 PW

5 4 10 up to 60

76

Quick Reference for Views and Job-File Products February 2012

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 dont 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 3: Match/Consolidate

77

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


Key Field Name Parsing (None) Parsing (STD) Parsing (Ext)

Birthdate Firm

Birthdate Firm

Birthdate Firm Firm1

Birthdate Name_Firm1-6 Firm Firm1-2 FirmLine1-2 Line1-12 Name_Firm1-6 Firmloc1-3 FirmLine1-2 Line1-12 Generated by parse

Firmloc

Gender Phone Pmb Po_Box Postdir Predir Prim_Name Prim_Range Sec_Range Phone Pmb Po_Box Postdir Predir Prim_Name Prim_Range Sec_Range Phone Address Line1-12 Address Line1-12 Address Line1-12 Address Line1-12 Address Line1-12 Address Line1-12 Address Line1-12 Ssn Address Line1-12

Phone Address Line1-12 Address Line1-12 Address Line1-12 Address Line1-12 Address Line1-12 Address Line1-12 Address Unit Line1-12 Ssn Address Line1-12

Ssn Suffix

Ssn Suffix

78

Quick Reference for Views and Job-File Products February 2012

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 Line1-12 Last_Line City Country Generated by parse

City

City

Line1-12 Last_Line City Country

Country Error_Code First_Name

Country

First_Name

First_Name Name_Line Name_Line1

First_Name Name_Line Name_Line1-6 Firstpart1-2 Name_Firm1-6 Line1-12 Last_Name Name_Line Name_Line1-6 Firstpart1-2 Name_Firm1-6 Line1-12 Post_Name Name_Line Name_Line1-6 Firstpart1-2 Name_Firm1-6 Line1-12 Merg_Purg1-0 Mid_Name Name_Line Name_Line1-6 Firstpart1-2 Name_Firm1-6 Line1-12 Name_Line Name_Line1-6 Lastpart1-2 Name_Firm1-6 Line1-12

Last_Name

Last_Name

Last_Name Name_Line Name_Line1

Mat_Post

Post_Name

Post_Name Name_Line Name_Line1

Merg_Purg1-0 Mid_Name

Merg_Purg1-0 Mid_Name

Merg_Purg1-0 Mid_Name Name_Line Name_Line1

Oth_Post

Chapter 3: Match/Consolidate

79

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 Generated by parse

Rec_Type RR_Box RR_Number State RR_Box RR_Number State Address Line1-12 Address Line1-12 Line1-12 Last_Line State Address

Address Line1-12 Address Line1-12 Line1-12 Last_Line State Address Last_Line

Unp_Addr Unp_lline ZIP ZIP

Line1-12 Last_Line ZIP ZIP10 Line1-12 Last_Line ZIP4 ZIP10

Line1-12 Last_Line ZIP4 ZIP10 Line1-12 Last_Line ZIP4 ZIP10

ZIP4

ZIP4

80

Quick Reference for Views and Job-File Products February 2012

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. applica- The 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. 4 Error code for address parsing. E301 No address data. E302 Bad address data. blank Address was successfully parsed. Number of Super Lists defined in a job. 0 Unique record. 1 to 255 Number of Super Lists represented in the dupe group. Super List name for the Super Lists defined in a job. 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. This AP field holds the multi-buyer count of a record. File number (1 to 255), assigned from the sequence of Input File blocks in the job file. Error code for firm parsing. E201 No firm data. blank Firm was successfully parsed.

AP.Addr_Error

AP.ASuper_Cnt

AP.ASuper_Name AP.ASuper_No

20 3

AP.Buyer_Cnt AP.File_No AP.Firm_Error

4 3 4

Chapter 3: Match/Consolidate

81

Match/Consolidate output fields


Field name Length Description

AP.Gender

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 names gender was ambiguous. (Note: If at least one name is unassigned, the whole record is unassigned.) Dupe-group record count. 1 Unique record. 2 to 65535Number of records in the dupe group. Dupe-group serial number. 1 to 4294967295 The number assigned to this dupe group. blank Unique record. 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. 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. 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. Stores a sequential number for records that belong to a list. Cannot exceed 4294967295. 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.

AP.Group_Cnt

10

AP.Group_No

10

AP.Group_Ord

10

AP.Group_Rank

AP.Group_Type

AP.ID_INC_NO AP.IntraOrd

10 1

82

Quick Reference for Views and Job-File Products February 2012

Match/Consolidate output fields


Field name Length Description

AP.IntraType

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. List Match Priority plus Blank Priority (0 to 65535) per job setup. 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. List name from the Name parameter in the Input List Description block. 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. The type of list, from the Type parameter in the Input List Description block: NORMAL, SPECIAL, or SUPPRESS(ion). 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. The name of the rule that was used in detecting the match. If AP.MatchType is R, then the AP.MatchRule reflects the deciding rules 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. A number that indicates the score of a match. blank 0100 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.

AP.LB_Prior AP.List_Cnt

5 4

AP.List_Name AP.List_No

20 4

AP.List_Type AP.LL_Error

8 4

AP.MatchRule

20

AP.MatchScore

Chapter 3: Match/Consolidate

83

Match/Consolidate output fields


Field name Length Description

AP.MatchType

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. 1 to 4294967295. This holds the maximum value of the ID1 PW field. Error code for parsing name data. E101 No name data. blank Name was successfully parsed. on DOS, LF on UNIX. For posting to ASCII output files as an end-of-record mark. The output field should be named EOR.
C L

AP.Max_ID1-9 AP.Name_Error

10 4

AP.Newline AP.Num_Names AP.Parse

1 or 2 1 1

R F

The number of individuals found in the input record (0 to 6). If more than 6 individuals are identified, the value is 6. 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. Type of input record. B Business record. R Residential record. Record number from the output file (1 to 4294967295). Record number from the input file (1 to 4294967295). 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. 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.

AP.Parse_Type

AP.Rec_No_Out AP.Record_No AP.SIntraOrd

10 10 1

AP.SIntraType

84

Quick Reference for Views and Job-File Products February 2012

Match/Consolidate output fields


Field name Length Description

AP.Super_Cnt

Super List count. 0 Unique record. 1 to 255 Number of Super Lists represented in the dupe group. Super List name, from the Name parameter in the Super List Description block. Super List number (1 to 255), assigned from the sequence of Super List Description blocks in the job file. 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. 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.

AP.Super_Name AP.Super_No AP.Unique_No

20 3 10

AP.Was_Output

Chapter 3: Match/Consolidate

85

86

Quick Reference for Views and Job-File Products February 2012

Chapter 4: 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 4: Presort

87

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.Line1Line6 PW.ZIP4 PW.ZIP10 PW.Last_Line PW.Line1 Line6 PW.DPBC

Enhanced Carrier Route Subclass, Standard, Periodicals

PW.LOT PW.LOT_Order PW.DPBC PW.Walk_Seq PW.Firm_ID PW.Bus_Ind PW.Country

Required for automation presorts

Walk-sequence preparation, Periodicals or Standard

Detect foreign records

Carrier-route presorts Periodicals Class

PW.CART PW.ZIP4 Prepare firm bundles PW.Firm_ID

Detect and process for- PW.Country eign records PW.Intl_Regn PW.City Claim in-county postage discount PW.County

Advertising Percentage

PW.Ad_Pct

Count paid subscribers PW.Subscriber Fields for multi- Multiple entry points ple-mailing jobs for destination entry PW.Entry_ID 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

Dividing the job into segments

PW.Segment_ID

88

Quick Reference for Views and Job-File Products February 2012

Presort input fields: Selection chart


Type of data Field description Field name Field description Field name

Other fields

Generate multiple cop- PW.Copies ies per input record Deleted records in flat files Overcome format differences among input files PW.Delete 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

GCA Mail.dat, seed file Name Optimizer

PW.Seed_ID PW.Key_Code PW.Priority

Alphabetical listing of input fields

Presort input fields


Field name Length Description

PW.Ad_Pct PW.Bus_Ind

6 1

The percentage of advertising in a Periodicals piece. If Presort detects a different advertising percentage, it creates a new version. 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 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. 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. 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.

PW.CART PW.City

4 13 to 25

PW.Copies

1 to 3

Chapter 4: Presort

89

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 91 and PW.City on page 89. 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. 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. 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. 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 Users Guide.

PW.County

PW.Delete

PW.DPBC

PW.Entry_ID

up to 60

90

Quick Reference for Views and Job-File Products February 2012

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. 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 Users Guide.

PW.Force_SP

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. 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. 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. 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). 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 versionin 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

PW.IMB_MID PW.IMB_Serial

6 or 9 6 or 9

PW.Intl_Regn

up to 60

PW.Key_Code

up to 60

Chapter 4: Presort

91

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. 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 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 dont 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.

PW.Mail_Class

PW.Meter_Rate

92

Quick Reference for Views and Job-File Products February 2012

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 100) 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 100.) 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. 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.

PW.Priority PW.Prt_PLANET

up to 60 1

Chapter 4: Presort

93

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. 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 W Parcel Select Light Weight Notes: Presort only looks at the first character in the database field when assigning rate categories. Presort allows for mixed-rate categories within Periodicals and Standard mail classes. 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 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 Users Guide. 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.

PW.Rate_Cat

PW.Seed_ID

up to 60

PW.Segment_ID

31

PW.SRVC_Type

94

Quick Reference for Views and Job-File Products February 2012

Presort input fields


Field name Length Description

PW_Sub_Opt

Gets the pieces 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). 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. Refer to PW.Height.

PW.Subscriber

PW.Thickness 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 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. 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 89). See PW.Height.

PW.Ver_Name

up to 31

PW.Walk_Seq

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 doesnt 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 4: Presort

95

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. 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 dont 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.) 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 dont use the same field names.

PW

up to 60

user:fieldname

96

Quick Reference for Views and Job-File Products February 2012

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 Field name Field description Field name

Required for Top line package, container, and pallet labels Middle line

AP.Dest_Line AP.Dest_CS AP.Dest_ZIP AP.Cont_Line AP.Cont_Nompc AP.Cont_Pc AP.Orig_Line AP.Pkg_Thk AP.Pkg_Wt

Barcode

AP.Contents AP.Ctn_Barcd AP.Zebra_Req

Trays only

Bottom line Optional info about packages Dimensions

Numbering

AP.Pkg_No_Abs AP.Pkg_No_Ctn AP.Pkg_No_Mlg AP.Pkg_No_Plt AP.Pkg_No_Rel AP.Pkg_Rate

Break marks

AP.Pkg_Brk_F AP.Pkg_Brk_FL AP.Pkg_Brk_L AP.PkgDestZip AP.Pkg_Level AP.No_Pcs AP.Class AP.Postage AP.Dest_Rate AP.Ctn_Size AP.Ctn_Type AP.Ctn_Vol AP.Ctn_Wt AP.Ctn_Brk_F AP.Ctn_Brk_FL AP.Ctn_Brk_L AP.CtnDestZip AP.Ctn_Level AP.No_Pcs AP.No_Pkgs

Postage category

Sort level and destination Number of pieces Other fields Class of mail Postage Optional info about trays and sacks Dimensions

Simplified addressing

AP.Opt_Endrs AP.Opt_En_Txt

End-of-record mark

AP.Newline

Numbering

AP.Ctn_No_Abs AP.Ctn_No_Mlg AP.Ctn_No_Plt AP.Ctn_No_Rel AP.Ctn_Rate AP.Zone AP.Ctn_Fill AP.Tray_Prep AP.Zebra_Req

Break marks

Postage

Sort level and destination Number of...

Trays only

Chapter 4: Presort

97

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 AP.Plt_No_Abs AP.Plt_No_Mlg AP.Plt_No_Rel AP.ZIP_Range AP.Zone AP.Coplt_Dis

Dimensions

AP.Plt_Vol AP.Plt_Wt AP.Plt_Brk_F AP.Plt_Brk_FL AP.Plt_Brk_L Ap.Dest_Cs_Ab AP.Dest_ZIP_C AP.PltDestZip AP.Plt_Level AP.ACS_Code

Numbering

Break marks

Destination

Sort level and destination

Discounts

Optional fields for address labels or mail/ merge documents

Keylines

Postnet barcode

AP.Prt_Req_BC

AP.ACS_Key AP.Mailing_ID AP.Manfst_Key AP.No_Pcs_Ctn AP.No_Pcs_Lbl AP.No_Pcs_Pkg AP.No_Pcs_Plt Optional fields for address labels or mail/ merge documents, cont. 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 AP.Issue_Date AP.RAE_Name AP.RAE_ID AP.RAE_Wt AP.RAE_Thk AP.Piece_Rate AP.Zone

Endorsements

AP.Cart_Endrs AP.Opt_Endrs AP.Rate_Endrs

Multiple versions or editions

AP.Ver _Name AP.Ver_No

Trace back to database record

AP.File_No AP.Record_No

Periodicals

Name Optimizer

AP.Add_Type

Postage

98

Quick Reference for Views and Job-File Products February 2012

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 AP.Ent_Pt_CSZ AP.Ent_Pt_Nam AP.Ent_Pt_No AP.Dest_Rate Multiple schemes AP.Scheme_No

Multiple entry points

Segmenting

AP.Seg_Name AP.Seg_No

Alphabetical list of output fields

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.ACS_Code AP.ACS_Key AP.Add_Type

A A A

up to 9 up to 21 1

Address Change Service participant code. Taken from your ACS/Mailer ID Code entry in the Version Description. ACS keyline, from data entered in the Version Description. Includes pad, check digit, and framing pound signs (#). 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. 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. 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. Maximum Postnet barcode that may be printed on the piece. The value posted is always 11. Bindery name, as entered on the Bindery Name line of the Version Description block.
Chapter 4: Presort

AP.Adr_BC_Min

AP.Adr_BC_dgt

11

AP.Adr_BC_Max AP.Bind_Name

A A P C

2 up to 31

99

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Bind_No

up to 5

Bindery number (1 to 32500), according to the sequence of Bindery Name entries in Version Description blocks in the job file. 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. Y N The piece is in a carrier-route package. The piece is not in a carrier-route package.

AP.CART_Endrs

up to 20

AP.CART_Pkg AP.Class

A A P C P

1 1

Class of mail: 1 First Class Mail. 2 Periodicals Class. 3 Standard Mail. 4 Package Services. 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. 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. Contents line for container and pallet labels. Describes class, piece type, and preparation (for example, STD FLTS 5D BC). Contains the container processing code, right-aligned. USPS contents identifying number (CIN), identifying the mail class and type. Used in generating the container barcode. 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.

AP.CONFIRM

12 or 14

AP.Cont_Line

34

AP.Cont_Nompc AP.Cont_Pc AP.Contents AP.Ctn_Barcd

C C C C

P P

27 8 3 8 sack 10 tray

100

Quick Reference for Views and Job-File Products February 2012

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Ctn_BC_Req AP.Ctn_Brk_F A P

1 1

Y N

This sack or tray label must include a barcode. A barcode on this sack or tray label is optional.

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. Same values, but the first and last pieces or packages are marked. Same values, but only the last piece or package is marked. The container rate charge. Destination ZIP Code for the container in which this piece was included. Notes: This is the ZIP where the container is destinedwhere it will be opened and workednot where it is entered. When the ZIP is only 3 digits, the field is left-aligned and right-padded with spaces. 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.

AP.Ctn_Brk_FL AP.Ctn_Brk_L AP.Ctn_Charge AP.CtnDestZip

A A A A

P P P C P

1 1 6 5

AP.Ctn_Fill

Chapter 4: Presort

101

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Ctn_Level

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 Absolute container number (1 to 999999), no matter how General Output is set up. Container number within the mailing, no matter how General Output is set up. Container number within the pallet, no matter how General Output is set up. Container number per the numbering system chosen in General Output. Not affected by Mailflow. Container number within the segment, no matter how General Output is set up.

AP.Ctn_No_Abs AP.Ctn_No_Mlg AP.Ctn_No_Plt AP.Ctn_No_Rel AP.Ctn_No_Seg

A A A A A

P P P P P

C C C C C

up to 6 up to 6 up to 6 up to 6 up to 6

102

Quick Reference for Views and Job-File Products February 2012

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Ctn_Rate

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. Containers 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 PSLW Parcel Select Lightweight parcels 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. 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). Container (mail) volume in cubic feet (00.1000 to 65.0000). Container (mail) weight in pounds (0001.0000 to 2200.0000). City and state of destination USPS facility. 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.

AP.Ctn_Rt_Cat

up to 7

AP.Ctn_Size

AP.Ctn_Type

AP.Ctn_Vol AP.Ctn_Wt AP.Dest_CS AP.Dest_Cs_Ab P P

C C C C P P

7 9 up to 30 21

Chapter 4: Presort

103

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Dest_Line

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. 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_Rate

AP.Dest_ZIP

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 dont know or dont 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. This posts the same information as in AP.Dest_ZIP described above. Entry point city, state, and ZIP Code; taken from corresponding lines in Entry Point Description. Name of entry point; taken from the Entry Point Name line of the Entry Point Description. Entry point number (1 to 999), according to the sequence of Entry Point Descriptions in the job file. Not affected by Mailflow. 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. 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.

AP.Dest_ZIP_C AP.Ent_Pt_CSZ AP.Ent_Pt_Nam AP.Ent_Pt_No A A A

P P P P

C C C C

P P P P

3 or 5 up to 35 up to 31 up to 3

AP.File_No

up to 3

AP.GCA_Ucid

104

Quick Reference for Views and Job-File Products February 2012

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.IMB_ADR AP.IMB_ADR_AC

A A

31 65

Contains the 31-digit number for the IM barcode. This field is available only for the address output file. 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. Posts the encoded barcode in all upper case to the address output file. Contains the 6- or 9-digit mailer ID for the IM barcode. Contains the 6- or 9-digit serial number for the IM barcode. Contains the Pallet IM barcode. This field is available only for the pallet output file. 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. Contains the 24-digit number for the Tray/Sack IM barcode. This field is available only for the container output file. Date that a publication was issued. Data is taken from your entry at the Periodicals Issue Date parameter in the Version Description block. 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. 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. 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.
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.

AP.IMB_ADR_EC AP.IMB_ADR_MI AP.IMB_ADR_SN AP.IMB_PLT AP.IMB_RTAUTO

A A A P C

65 9 9 21 4

AP.IMB_TRYSCK AP.Issue_Date A

24 up to 15

AP.Mail_Type

AP.Mailing_ID

up to 14

AP.Manfst_Key

up to 24

AP.Newline

1 or 2

Chapter 4: Presort

105

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.No_Ctn_Plt

Number of containers on the pallet (1 to 144). Useful only when preparing a Trays on Pallets or Sacks on Pallets scheme. Blank otherwise. Number of pieces in the package, container, or pallet (1 to 99999). Number of pieces in the container. Number of pieces for the address label (useful when preparing firm packages with the single-label-per-package option). Number of pieces in the package. Number of pieces on the pallet. Number of packages in the pallet (1 to 99999). Useful only when working with a Packages on Pallets scheme. Blank otherwise. Number of packages in the container or pallet (1 to 9999). 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 expressionincluding concatenating AP.Opt_Endrs with another field. Contains the information in AP.Opt_En, with just two of the leading asterisks characters (*). 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. Pallet flag: P This piece, package, or container goes on a pallet. blank Not on pallet. Absolute piece number (1 to 4294967295) within the entire job. Piece number within the container, no matter how General Output is set up.

AP.No_Pcs AP.No_Pcs_Ctn AP.No_Pcs_Lbl AP.No_Pcs_Pkg AP.No_Pcs_Plt AP.No_Pkg_Plt A A A A

up to 5 up to 5 up to 5 up to 5 up to 5

AP.No_Pkgs AP.Opt_Endrs A P

4 36

AP.Opt_En_Txt AP.Orig_Line

P C P

up to 36 25 to 34

AP.Pallet

AP.Pc_No_Abs AP.Pc_No_Ctn

A A

up to 10 up to 10

106

Quick Reference for Views and Job-File Products February 2012

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Pc_No_Mlg AP.Pc_No_Pkg AP.Pc_No_Plt AP.Pc_No_Rel AP.Pc_No_Seg AP.Pc_Rt_Cat

A A A A A A

up to 10 up to 10 up to 10 up to 10 up to 10 up to 8

Piece number within the mailing, no matter how General Output is set up. Piece number within the package, no matter how General Output is set up. Piece number within the pallet, no matter how General Output is set up. Piece number per the numbering system chosen in General Output. Not affected by Mailflow. Piece number within the segment, no matter how General Output is set up. The versions 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 PSLW Parcel Select Lightweight parcels

Chapter 4: Presort

107

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Piece_Rate

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 RM Presorted MNDC for STD Parcels and PSLW RS Presorted SCF for STD Parcels and PSLW RT Regular 3-digit RV Regular 5-digit SP Single-piece Package break mark. Also see AP.Ctn_Brk_F and AP.Plt_Brk_F. # First piece in the container. blank Other piece. Same values, but the first and last pieces are marked. Same values, but only the last piece is marked. 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. Destination ZIP Code for the package in which this piece was included. Notes: This is the ZIP where the package is destinedwhere it will be opened and workednot where it is entered. When the ZIP is only 3 digits, the field is left-aligned and right-padded with spaces.

AP.Pkg_Brk_F

AP.Pkg_Brk_FL AP.Pkg_Brk_L AP.Pkg_Charge

A A A P C P

1 1 5

AP.PkgDestZip

108

Quick Reference for Views and Job-File Products February 2012

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Pkg_Level

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 Absolute package number within the entire job (1 to 9999999), no matter how General Output is set up. Package number within the container, no matter how General Output is set up. Package number within the mailing, no matter how General Output is set up. Package number within the pallet, no matter how General Output is set up. Package number per the numbering system chosen in General Output. Not affected by Mailflow. Package number within the segment, no matter how General Output is set up.

AP.Pkg_No_Abs AP.Pkg_No_Ctn AP.Pkg_No_Mlg AP.Pkg_No_Plt AP.Pkg_No_Rel AP.Pkg_No_Seg

A A A A A A

P P P P P P

up to 7 up to 7 up to 7 up to 7 up to 7 up to 7

Chapter 4: Presort

109

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Pkg_Rate

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. The packages 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 Package thickness in inches. Includes decimal point and six decimal places (for example, 12.123456). Package weight in pounds. Includes decimal point and six decimal places (for example, 12.123456). Pallet break mark. Also see AP.Pkg_Brk_F and AP.Ctn_Brk_F. # First piece in the pallet. blank Other piece. Same values, but the first and last pieces are marked. Same values, but only the last piece is marked. 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 workednot where it is entered. When the ZIP is only 3 digits, the field is left-aligned and right-padded with spaces.

AP.Pkg_Rt_Cat

up to 7

AP.Pkg_Thk AP.Pkg_Wt AP.Plt_Brk_F A

P P P C

up to 9 up to 9 1

AP.Plt_Brk_FL AP.Plt_Brk_L AP.PltDestZip

A A A

P P

C C

1 1 5

110

Quick Reference for Views and Job-File Products February 2012

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Plt_Level

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 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 Absolute pallet number (1 to 999999), no matter how General Output is set up. Pallet number within the mailing, no matter how General Output is set up. Pallet number per the numbering system chosen in General Output. Not affected by Mailflow. Pallet number within the segment, no matter how General Output is set up. The pallets 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 PSLW Parcel Select Lightweight parcels 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_No_Abs AP.Plt_No_Mlg AP.Plt_No_Rel AP.Plt_No_Seg AP.Plt_Rt_Cat

A A A A A

P P P P P

C C C C C

P P P P P

up to 6 up to 6 up to 6 up to 6 up to 7

AP.Plt_Vol

Chapter 4: Presort

111

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Plt_Wt

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. 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.Postage

up to 14

AP.Postnetdgt

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.

112

Quick Reference for Views and Job-File Products February 2012

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Process_Cat

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. 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. Rate endorsement. For 1C and STD jobs only; blank for PER and PSVC jobs. Presort places an endorsement line in every qualified record. The ride-along ID as entered in PER Ride-Along Enclosure Description block. The ride-along name as entered in the PER Ride-Along Enclosure Description block. Thickness of ride-along enclosure in inches. Includes decimal point and four decimal places (for example, 0.25). Weight of ride-along enclosure in pounds. Includes decimal point and four decimal places (for example, 0.205). 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.

AP.Prt_Req_BC

AP.Rate_Endrs

up to 21

AP.RAE_ID AP.RAE_Name AP.RAE_Thk AP.RAE_Wt AP.Record_No

A A A A A

up to 60 up to 31 up to 60 up to 60 up to 10

Chapter 4: Presort

113

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Scheme_No

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. Adds a segment break mark. For each output file that you create, the software posts a pound sign (#) in the record of the first piece in the segment. Segment name; taken from your entry at the Segment Name line of Segment Description. Segment number (1 to 9999), according to the sequence of Segment Descriptions in the job file. Not affected by Mailflow. Method of letter or 1C flats tray preparation: L Loose. S Separator cards. P Packages. Adds a version break mark. For each output file that you create,the software posts a pound sign (#) in the record of the first piece in the version. 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. 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. Weight of mail piece in pounds. Includes decimal point and six decimal places (for example, 12.123456). 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. ZIP range of pieces on the pallet. Includes a hyphen (for example, 54601-54650).

AP.Seg_Brk_F

AP.Seg_Name AP.Seg_No AP.Tray_Prep

A A A

P P P

C C C

P P

up to 31 up to 4 1

AP.Ver_Brk_F

AP.Ver_Name

up to 31

AP.Ver_No

up to 5

AP.Ver_Wt AP.Zebra_Req

A C

up to 9 1

AP.ZIP_Range

11

114

Quick Reference for Views and Job-File Products February 2012

Presort output fields


Available for output-file types Field name Adr Pkg Ctr Plt Length Description

AP.Zone

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. 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

AP.Zone

up to 17

Chapter 4: Presort

115

116

Quick Reference for Views and Job-File Products February 2012

Chapter 5: 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 5: Label Studio

117

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 PW.ACS_Key PW.Adr_Bc_Dgt PW.Adr_Bc_Max PW.Adr_Bc_Min PW.Aux_Ctrl

up to 9 up to 20 up to 11 2 2

Address Change Service participant code. ACS keyline data. Data should include pad, check digit, and framing pound signs (#). If this address label design includes a barcode, this field can be used to input the digits for the barcode. Use this field in a conditional filter to inform Label Studio of the longest (largest) barcode that should be printed on this label. Use this field in a conditional filter to inform Label Studio of the shortest (smallest) barcode that should be printed on this label. 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.

PW.Brk_Lvl1 PW.Brk_Lvl2 PW.Brk_Lvl3

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 LAST CHANGE VALUE

Non-blank or non-zero value Non-blank or non-zero value A change in the field value A change in the field value

The first record in a new element The last record in the current element The first record of a new element The first record of a new element. Blank or zero values are not considered part of the element. Ignore the corresponding PW fi ld

IGNORE

Any value

118

Quick Reference for Views and Job-File Products February 2012

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 **C-001 **WSH**C-001 **WSS**C-001 **AUTOCR**C-001 **ECRLOT**C-001 **ECRWSH**C-001 **ECRWSS**C-001 First Class, carrier route, automation rate. Periodicals, carrier route. Periodicals, walk-sequence high-density. Periodicals, walk-sequence saturation. Standard Mail (S) Enhanced Carrier Route, automation rate. Standard Mail (S) Enhanced Carrier Route, regular rate, LOT sorted. Standard Mail (S) Enhanced Carrier Route, walksequence high-density. Standard Mail (S) Enhanced Carrier Route, walksequence saturation.

PW.City PW.Contents

13 to 25 25 to 34

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. 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. 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. If you want Label Studio to print a barcode on a sack or tray label, use this field for the number valuedigitsof the barcode. 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 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. 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.)

PW.Copies

1 to 3

PW.Ctn_Bc_Dgt PW.Ctn_Bc_Req

10 1

PW.Delete

PW.Demog_Code

up to 60

Chapter 5: Label Studio

119

Label Studio input fields


Field name Length Description

PW.Dest_City PW.Dest_Zip PW.Dest_CS_AB

13 to 25 5 21

The USPS requires two things on the Destination line of labels for sacks, trays, and palletsthe destination city and destination ZIP Code. The Destination city usually includes the destination state. 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. 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. 31-digit number for the IM barcode. 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 youre printing to an inkjet printer, use PW.IMB_ADR_EC or PW.IMB_ADR_AC to print the Intelligent Mail barcode. Prints the encoded barcode in uppercase. If youre printing to an inkjet printer, use PW.IMB_ADR_EC or PW.IMB_ADR_AC to print the Intelligent Mail barcode. Pallet IM barcode. 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. 24-digit number for the tray IM barcode. 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. 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. You can use this field to signal to Label Studio the category that applies to the record. 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. 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.) 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.

PW.DPBC

PW.IMB_ADR PW.IMB_ADR_AC

31 65

PW.IMB_ADR_EC PW.IMB_PLT PW.IMB_RTAUTO PW.IMB_TRAYSCK PW.Last_Line

65 21 5 24 up to 60

PW.Line1- Line6 PW.Mail_Type PW.Mproc_Code

up to 60 3 up to 8

PW.Msg_Link

up to 60

PW.Opt_Endrs

at least 23

120

Quick Reference for Views and Job-File Products February 2012

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 mailers name and the city and state of the mailers location. Use this field for that information. The digits that represent the USPS Planet barcode. 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.Planet PW.State PW.Unt_Brk1 PW.Unt_Brk2 ... PW.Unt_Brk9 PW.Unt_Brk10

up to 14 2

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 LAST CHANGE IGNORE PW.Zebra_Req 1

non-blank or non-zero value non-blank or non-zero value a change in the field value any value

the first record in the mailing unit. the last record in the mailing unit the first record of a new element ignore the corresponding PW field

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 Use these fields for intelligent hyphenation on your labels.

PW.ZIP PW.ZIP4 PW.ZIP10 PW.fieldname

5 4 10 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 dont 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. 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 dont use the same field names.

User:fieldname

up to 60

Chapter 5: Label Studio

121

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

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 printers documentation to see what applies. Contains the check digit for AP.Adr_BC_Dgt. 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). 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. 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

AP.Adr_Chk_Digit AP.Aux_Ctrl_Map_1

A A

1 up to 151

AP.Aux_Ctrl_Map_X

up to 151

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 AP.Ctn_Bc_Dgt AP.Design_Name

S A S

T T P

up to 10 up to 260 up to 260

The digits that represent the sack or tray label barcode. This field must contain exactly 0, 8 (sack), or 10 (tray) digits. 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 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.

AP.Design_Path

122

Quick Reference for Views and Job-File Products February 2012

Label Studio output fields


Field name Label Type (address, sack, tray, or pallet) Length Description

AP.File_No

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. 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). 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. 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. 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. This information is taken from the General Information block of your job file. It contains the description of your job. This field marks the last label in your job with a Y. This information is taken from the General Information block of your job file. It contains your job owner information. The file path of your job file. This field marks the first label in your job with a Y. 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. The number assigned to each label on a page. Label Studio resets this number for each new page of labels. The number assigned to each label that is to be output, within the labels unit. Test labels, quality books, and so on, are not included in this number. The number assigned to each label of a given type (address, sack, tray, or pallet) that is to be output, within the labels subunit. Test labels, quality books, and so on, are not included in this number. This information is taken from the General Information block of your job file. It contains your mailer name information. This field contains the number assigned to each page.

AP.Hopper_Map_1

up to 151

AP.Hopper_Map_X

up to 151

AP.Input_Name

up to 260 up to 260 up to 80 1 up to 20 up to 260 1 up to 10

AP.Input_Path

AP.Job_Desc AP.Job_End AP.Job_Owner AP.Job_Path AP.Job_Start AP.Lbl_No

A A A A A A

S S S S S S

T T T T T T

P P P P P P

AP.Lbl_No_Page AP.Lbl_No_Unt

A A

S S

T T

P P

up to 10 up to 10

AP.Lbl_No_Sub

up to 10

AP.Mailer_Name AP.Page_No

A A

S S

T T

P P

up to 20 up to 10

Chapter 5: Label Studio

123

Label Studio output fields


Field name Label Type (address, sack, tray, or pallet) Length Description

AP.Planet

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. This field contains the check digit for AP.Planet. 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. 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. 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. 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. This field marks the last label in your subunit with a Y. This field marks the first label in your subunit with a Y. This field marks the last label in your unit with a Y. This field marks the first label in your unit with a Y. The subunit number within the current unit.

AP.Planet_Chk_Dgt AP.Qbook

A A

1 1

AP.Record_No

up to 10

AP.Seq_No_Abs

up to 10

AP.Seq_No_Rel

up to 10

AP.Subunit_End AP.Subunit_Start AP.Unit_End AP.Unit_Start AP.Subunt_No AP.Ubrk1_Des AP.Ubrk10_Des AP.Unt_Desc AP.Unt_No AP.Volume_No

A A A A A A A A A

S S S S S S S S

T T T T T T T T

P P P P P P P P

1 1 1 1 up to 10

at least 1 This information is taken from the Unit Break Definition window. You can access this window from the Input Options block. up to 40 up to 10 up to 10 This field contains the value of Unit Break Description for the current unit. This field contains the unit number associated within the current unit. This field represents the value for the current volume.

124

Quick Reference for Views and Job-File Products February 2012

Chapter 6: 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 6: Values, commands, and filter functions

125

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 001 002 003 004 005 006 007 008 009 010 011 012 013 014 015 016 017 018 019 020 021 022 023 024 025

null start of heading start of text end of text end of transmission enquiry acknowledge bell backspace horizontal tab line feed vertical tab form feed carriage return shift out shift in data link escape device control 1 or X-ON device control 2 device control 3 or X-OFF device control 4 negative acknowledge synchronous idle end-of-transmission block cancel end of medium

026 027 028 029 030 031 032 033 034 035 036 037 038 039 040 041 042 043 044 045 046 047 048 049 050 051

substitute escape file separator group separator record separator unit separator space ! (exclamation mark) (double quote) # (pound sign) $ % & ' (apostrophe) ( ) * (asterisk) + , (comma) - (hyphen) . (period) / (forward slash) 0 1 2 3

052 053 054 055 056 057 058 059 060 061 062 063 064 065 066 067 068 069 070 071 072 073 074 075 076 077

4 5 6 7 8 9 : (colon) ; (semicolon) < (less than) = > (greater than) ? @ A B C D E F G H I J K L M

126

Quick Reference for Views and Job-File Products February 2012

Lower ASCII code values


Code Description Code Description Code Description

078 079 080 081 082 083 084 085 086 087 088 089 090 091 092 093 094

N O P Q R S T U V W X Y Z [ \ (back slash) ] ^ (caret)

095 096 097 098 099 100 101 102 103 104 105 106 107 108 109 112 113

_ (underscore) ` (accent) a b c d e f g h i j k l m p q

110 111 114 115 116 117 118 119 120 121 122 123 124 125 126 127

n o r s t u v w x y z { | (vertical bar, pipe) } ~ (tilde) delete

Chapter 6: Values, commands, and filter functions

127

Upper ASCII code values


This section lists characters in the upper ASCII set (values 128255) as defined in code page 1252, the ANSI Latin 1 code page.

Upper ASCII code values


Code Description Code Description Code Description

128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154

(Euro symbol) not used (comma) (ellipses) not used not used not used (single open quote) (single close quote) (double open quote) (double close quote) (bullet) (en dash) (em dash) (tilde) (trademark)

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181

not used (nonbreaking space) (inverted exclamation) (cent) (pound) (section) (umlaut) (copyright) (open quote) (registered trademark) (degree) (plus or minus) (squared) (cubed

182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208

(paragraph) (close quote) (inverted question)

128

Quick Reference for Views and Job-File Products February 2012

Upper ASCII code values


Code Description Code Description Code Description

209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224

(multiply)

225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240

241 242 243 244 245 246 247 248 249 250 251 252 253 254 255

(divide)

Chapter 6: Values, commands, and filter functions

129

Command-line options
Command syntax

Use the command syntax that corresponds to your product to run your jobs.

Product

Command syntax

DataRight ACE: ACE Canada: Match/Consolidate: Presort: International Presort:

pwdtr [options] [path] jobfile.dtr pwace [options] [path] jobfile.ace pwcace [options] [path] jobfile.cac pwmpg [options] [path] jobfile.mpg presort [options] [path] jobfile.pst ipresort [options] [path] jobfile.ips

General commands

Here is a list of other commands that you can use to manipulate how the software outputs information.

Syntax by operating system Windows UNIX Description

/a /lfile.log

-a >file.log

Answer verifier warning messages with Continuethat is, ignore them. 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) Add system time-of-day to progress messages. No stop on verifier error messages. Useful when running jobs via a batch or shell scriptif one job fails, the others are not held up. Display the software version and revision level. 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. Run a job in the background.

/watch /nos

-watch -nos

/rev /v

-rev -v

&:

start / min:

130

Quick Reference for Views and Job-File Products February 2012

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 DOS Windows UNIX Description

/bx /c

/bx /c

-bx -c

Remove excess blank lines so that the maximum number of contiguous blank lines (between blocks) will be x (1-9). 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 errorsjob files found but not updatedin 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 loggedso the log is a handy way to verify that a particular job was updated. -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 dont feel this backup is necessary or you cant spare the disk space, add the n option to suppress the backup. Recursively search for job files in all directories named, and in all subdirectories under them. Produce verbose progress messages. Produce very verbose progress messages. 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 youve followed our advice about setting the PATH and PW_PATH variables (see our System Administrators Guide), Edjob should be able to find the right script by itself. However, to be on the safe side, usually its 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

/n

/n

/s /v /V script.upd

/s /v /V script.upd

-s -v -V script.upd

Chapter 6: Values, commands, and filter functions

131

Edjob command-line options


Syntax by operating system DOS Windows UNIX Description

There are three ways to identify which job files you want to update: jobfile.ext *.ext jobfile.ext *.ext jobfile.ext *.ext Type the full name (with path, if necessary) of one job file. 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). 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.

@joblist

@joblist

@joblist

132

Quick Reference for Views and Job-File Products February 2012

Filter functions and operators

Type

Description

Function/operator syntax

Arithmetic

Perform division and return the remainder Multiplication Addition Subtraction Division (no % modulus available)

mod() * + / < <= > >= <> = $ chr() ctod() lower() upper() proper() asc() val() dtoc() dtos() int() round() abs() str() chrtran() max() min()

Comparison

Less than Less than or equal to Greater than Greater than or equal to Not equal to Is exactly equal to Is contained in or is a subset of

Convert data

ASCII value to character Character mm/dd/yy or mm/dd/yyyy to date Character string to lowercase Character string to UPPERCASE Character string to Mixed Case Character to ASCII value Character to numeric Date to character mm/dd/yyyy Date to character yyyymmdd Numeric decimal to integer by truncation Numeric decimal to n decimal places (or integer) by rounding Numeric to absolute value Numeric to character string Search a string for one character and substitute another

Compare

Select the larger of two numbers Select the smaller of two numbers

Chapter 6: Values, commands, and filter functions

133

Type

Description

Function/operator syntax

Provide data

Character repeated n times Current date from time-of-day clock Current time from time-of-day clock n spaces

replicate() date() time() space() recno() cdow() day() dow() left() cmonth() month() substr() right() year() translated( )

Extract

Number of current record, from input file Day of the week from date (Sunday, Monday, ... Saturday) Day-of-the-month numeric from date (1, 2, ... a1) Day-of-the-week numeric from date (1, 2, ... 7) Leftmost n characters from string Month name from date (January, February, ... December) Month numeric from date (1, 2, ... 12) Range of characters from string Rightmost n characters from string Year numeric from date

Extract (Unicode only)

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 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( )

Fit and trim

Measure the length of a character expression Trim leading spaces Trim trailing spaces Trim leading and trailing spaces

len() ltrim() rtrim() alltrim() & + isupper() isalpha() islower() isdigit() empty() iif()

String concatenation

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

Test

Does expression begin with a capital letter (AZ)? Does expression begin with a letter (AZ or az)? Does expression begin with a lowercase letter (az)? Does expression begin with a number (09)? Does expression contain any data other than spaces? Test; if true, return expression #1; if false, return expression #2

134

Quick Reference for Views and Job-File Products February 2012

Type

Description

Function/operator syntax

Is character expression #1 located within expression #2 (true/false)? How many characters in expression #1 are within expression #2? Where is character expression #1 located within expression #2? Is the input record marked to be deleted? Miscellaneous Not (reverses the sense of a logical true/false) Use parentheses liberally to control precedence (order in which operations are performed).

$ span() at() deleted() ! ()

Chapter 6: Values, commands, and filter functions

135

136

Quick Reference for Views and Job-File Products February 2012

Index

Numerics
10-digit ZIP Code without hyphen, 25, 31, 59

A
abbreviated suffix, 26, 43 absolute pallet number, 111 absolute container number, 102 absolute label number, 123 absolute package number, 109 absolute piece number, 106 ACE Canada address error codes, 70 command-line syntax, 130 ACE U.S. address and assignment results code fields, 31, 60 address error codes, 70 address status codes, 6869 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, 130 dual address-line component fields, 28 geocensus code fields by option, 39, 65 input fields, 2224 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, 2224 ACS, 118 ACS keyline data, 118 ACS participant code, 118 address, 22, 26, 43, 72 multi line, 30 non-postal, 26, 45 primary, 26, 28, 43 secondary, 26, 27, 29, 43 standardized, 28 address barcode, 112 address change service, See ACS address conversion LACSLink, 54 address label, 120 address line components

alias, 27 dual, 28 U.S. ACE, 26, 57 address line remainder, 26, 29 alias input address field type, 28 ANKLink, 54 AP, 99 AP prefix, 81 AP.ACS_Code, 98, 99 AP.ACS_Key, 98, 99 AP.Add_Type, 98, 99 AP.Addr_Chng, 15 AP.Addr_Error, 14 AP.Addr_Qual, 15 AP.Addr_Stat, 16 AP.Address13, 12 AP.Adr_BC_Dgt, 122 AP.Adr_BC_dgt, 99 AP.Adr_BC_Max, 99 AP.Adr_BC_Min, 99 AP.Adr_Chk_Digit, 122 AP.Ageo_Blk, 39 AP.Ageo_Cty, 39 AP.Ageo_Lat, 39 AP.Ageo_Lng, 39 AP.Ageo_MCD, 39 AP.Ageo_Pla, 39 AP.Ageo_Sta, 39 AP.Aline, 26 AP.All_Names, 10 AP.Aud_Pname, 41 AP.Aud_Range, 41 AP.Aud_Srange, 41 AP.Aud_Unit, 41 AP.Aux_Ctrl_Map_1, 122 AP.Aux_Ctrl_Map_X, 122 AP.Bind_Name, 99 AP.Bind_No, 100 AP.Brk_Lvl1_F, 122 AP.Brk_Lvl1_FL, 122 AP.Brk_Lvl1_L, 122 AP.Brk_Lvl2_F, 122 AP.Brk_Lvl2_FL, 122 AP.Brk_Lvl2_L, 122 AP.Brk_Lvl3_F, 122 AP.Brk_Lvl3_FL, 122 AP.Brk_Lvl3_L, 122 AP.Buyer_Cnt, 81 AP.CART, 30 AP.CART_Endrs, 100 AP.CART_Pkg, 100 AP.CASS_Match, 37 AP.CASSrectyp, 31 AP.Cgeo_Blk, 40 AP.Cgeo_CBSA, 39
Index

137

AP.Cgeo_Lat, 40 AP.Cgeo_Lng, 40 AP.Cgeo_Match, 40 AP.Cgeo_Msa, 40 AP.Chk_Digit, 31 AP.City, 12, 25 AP.City_Abbr, 25 AP.City_LLIDX, 25 AP.City_Npref, 25 AP.City_Place, 25 AP.Class, 100 AP.CONFIRM, 100 AP.Congress, 37 AP.Cont_Line, 100 AP.Cont_Nompc, 100 AP.Cont_Pc, 100 AP.Contents, 100 AP.Country, 13 AP.County, 37 AP.CountyName, 37 AP.CR_Sort_Zn, 30 AP.Ctn_Barcd, 100 AP.Ctn_Bc_Dgt, 122 AP.Ctn_BC_Req, 101 AP.Ctn_Brk_F, 101 AP.Ctn_Brk_FL, 101 AP.Ctn_Brk_L, 101 AP.Ctn_Charge, 101 AP.Ctn_Fill, 101 AP.Ctn_Level, 102 AP.Ctn_No_Abs, 102 AP.Ctn_No_Mlg, 102 AP.Ctn_No_Plt, 102 AP.Ctn_No_Rel, 102 AP.Ctn_No_Seg, 102 AP.Ctn_Rate, 103 AP.Ctn_Rt_Cat, 103 AP.Ctn_Size, 103 AP.Ctn_Type, 103 AP.Ctn_Vol, 103 AP.Ctn_Wt, 103 AP.CtnDestZip, 101 AP.Date16, 16 AP.Design_Name, 122 AP.Design_Path, 122 AP.Dest_CS, 103 AP.Dest_Cs_Ab, 103 AP.Dest_Line, 104 AP.Dest_Rate, 104 AP.Dest_ZIP, 104 AP.Dest_ZIP_C, 104 AP.Dname_Stat, 15 AP.DPBC, 31 AP.DPV_cmra, 34 AP.DPV_Ftnote, 34 AP.DPV_NoStat, 34 AP.DPV_Status, 35 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.Email16, 16 AP.Email2ndD16, 16 AP.Email3rdD16, 16 AP.Email4thD16, 16 AP.Email5thD16, 16 AP.EmailAllD16, 16 AP.EmailHost16, 16 AP.EmailTopD16, 16 AP.EmailUser16, 16 AP.Ent_Pt_CSZ, 104 AP.Ent_Pt_Nam, 104 AP.Ent_Pt_No, 104 AP.Err_Stat, 31 AP.Error_Code, 31 AP.EWS_Match, 32 AP.Extra110, 30 AP.Extra112, 17 AP.Extran_PMB, 26 AP.Extran_Sec, 26 AP.Extraneous, 26, 45 AP.FacType, 37 AP.File_No, 17, 81, 104, 123 AP.FIPSCODE, 38 AP.Firm_Chng, 15 AP.Firm_Error, 14, 81 AP.Firm_Line12, 11 AP.Firm_Loc12, 11 AP.Firm_Qual, 15 AP.Firm_Stat, 16 AP.Firm12, 11 AP.FirstName16, 10 AP.Foreign, 32 AP.GCA_Ucid, 104 AP.Gender_Rec, 12 AP.Gender16, 12 AP.Geo_Match, 40 AP.Group_Cnt, 82 AP.Group_No, 82 AP.Group_Ord, 82 AP.Group_Rank, 82 AP.Group_Type, 82 AP.Hopper_Map_1, 123 AP.Hopper_Map_X, 123 AP.ID_INC_NO, 82 AP.IMB_ADR, 105 AP.IMB_ADR_AC, 105 AP.IMB_ADR_EC, 105 AP.IMB_ADR_MI, 105 AP.IMB_ADR_SN, 105 AP.IMB_PLT, 105 AP.IMB_RTAUTO, 105 AP.IMB_TRYSCK, 105 AP.Input_Firm, 55 AP.Input_Name, 123

138

Quick Reference for Views and Job-File Products February 2012

AP.Input_Path, 123 AP.IntCityCd16, 17 AP.IntCtryCd16, 17 AP.IntPhDesc16, 17 AP.IntPhNum16, 17 AP.IntPhone16, 17 AP.IntraOrd, 82 AP.IntraType, 83 AP.Issue_Date, 105 AP.Job_Desc, 123 AP.Job_End, 123 AP.Job_Owner, 123 AP.Job_Path, 123 AP.Job_Start, 123 AP.LACSCODE, 32 AP.Lacsl_Ind, 54 AP.Lacsl_Qry, 54 AP.Lacsl_Ret, 54 AP.Last_Line, 13, 25 AP.Last_Name16, 10 AP.LB_Prior, 83 AP.Lbl_No, 123 AP.Lbl_No_Page, 123 AP.Lbl_No_Sub, 123 AP.Lbl_No_Unt, 123 AP.List_Cnt, 83 AP.List_Name, 83 AP.list_name, 17 AP.List_No, 17, 83 AP.List_Type, 83 AP.LL_Chng, 15 AP.LL_Error, 14, 83 AP.LL_Qual, 15 AP.LL_Stat, 16 AP.LOT, 30 AP.LOT_Order, 31 AP.Mail_Type, 105 AP.Mailer_Name, 123 AP.Mailing_ID, 105 AP.Manfst_Key, 105 AP.Mat_Post16, 10 AP.Match_5, 32 AP.Match_9, 32 AP.Match_Un, 32 AP.MatchRule, 83 AP.MatchScore, 83 AP.MatchType, 84 AP.Max_ID1-9, 84 AP.Mid_Name16, 10 AP.Name_Chng, 14 AP.Name_Cnt, 11 AP.Name_Error, 14, 84 AP.Name_Line16, 11 AP.Name_Qual, 15 AP.Name_Stat, 15 AP.Name16, 10 AP.NameDesig16, 10 AP.NC_Firm, 32 AP.NC_Secaddr, 32 AP.NC_Srange, 32 AP.NC_Unit, 32 AP.Newline, 18, 38, 84, 105

AP.No_Ctn_Plt, 106 AP.No_Pcs, 106 AP.No_Pcs_Ctn, 106 AP.No_Pcs_Lbl, 106 AP.No_Pcs_Pkg, 106 AP.No_Pcs_Plt, 106 AP.No_Pkg_Plt, 106 AP.No_Pkgs, 106 AP.Np_Secaddr, 26 AP.Np_Srange, 26, 45 AP.Np_Unit, 26 AP.Num_Names, 84 AP.Opt_En_Txt, 106 AP.Opt_Endrs, 106 AP.Orig_Line, 106 AP.Oth_Post16, 10 AP.Page_No, 123 AP.Pallet, 106 AP.Parse, 84 AP.Parse_Type, 84 AP.PatnLabel14, 17 AP.Patnsub14_15, 17 AP.Pattern14, 17 AP.Pc_No_Abs, 106 AP.Pc_No_Ctn, 106 AP.Pc_No_Mlg, 107 AP.Pc_No_Pkg, 107 AP.Pc_No_Plt, 107 AP.Pc_No_Rel, 107 AP.Pc_No_Seg, 107 AP.Pc_Rt_Cat, 107 AP.Piece_Rate, 108 AP.Pkg_Brk_F, 108 AP.Pkg_Charge, 108 AP.Pkg_Level, 109 also see AP.Ctn_Level also see AP.Plt_Level AP.Pkg_No_Abs, 109 AP.Pkg_No_Ctn, 109 AP.Pkg_No_Mlg, 109 AP.Pkg_No_Plt, 109 AP.Pkg_No_Rel, 109 AP.Pkg_No_Seg, 109 AP.Pkg_Rate, 110 AP.Pkg_Rt_Cat, 110 AP.Pkg_Thk, 110 AP.Pkg_Wt, 110 AP.PkgDestZip, 108 AP.Planet, 124 AP.Planet_Chk_Dgt, 124 AP.Plt_Brk_F, 110 AP.Plt_Brk_FL, 110 AP.Plt_Brk_L, 110 AP.Plt_Level, 111 AP.Plt_No_Abs, 111 AP.Plt_No_Mlg, 111 AP.Plt_No_Rel, 111 AP.Plt_No_Seg, 111 AP.Plt_Rt_Cat, 111 AP.Plt_Vol, 111 AP.Plt_Wt, 112 AP.PltDestZip, 110
Index

139

AP.PO_Box, 26 AP.POBox, 14 AP.POBox_Line, 14 AP.Postage, 112 AP.Postdir, 26 AP.Postnetdgt, 112 AP.Pre_Name16, 10 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 AP.Prim_Name, 26 AP.Prim_Range, 13, 26 AP.Process_Cat, 113 AP.Prt_Req_BC, 113 AP.Qbook, 124 AP.Qss_Dflt, 38 AP.RAE_ID, 113 AP.RAE_Name, 113 AP.RAE_Thk, 113 AP.RAE_Wt, 113 AP.Rate_Endrs, 113 AP.RDI, 38 AP.Rec_No_Out, 18, 39, 84 AP.Rec_Type, 33 AP.Record_No, 18, 39, 84, 113, 124 AP.Remainder, 26 AP.Results, 81 AP.Results.Level, 81 AP.RR, 14 AP.RR_Box, 26 AP.RR_Line, 14 AP.RR_Number, 26 AP.RRBox, 14 AP.Salute_Rec, 12 AP.Salute16, 12 AP.Scheme_No, 114 AP.Sec_Addr, 13, 26 AP.Sec_Range, 13, 26 AP.seg_brk_f, 114 AP.Seg_Name, 114 AP.Seg_No, 114 AP.Seq_No_Abs, 124 AP.Seq_No_Rel, 124 AP.SIntraOrd, 84 AP.SIntraType, 84 AP.Spec_Name, 11 AP.SSN16, 17 AP.Stat_Code, 33 AP.State, 12, 25 AP.Std_Line112, 30 AP.SteLink_RC, 55 AP.Subunit_End, 124 AP.Subunit_Start, 124 AP.Subunt_No, 124 AP.Suffix, 26 AP.Super_Cnt, 85 AP.Super_Name, 85 AP.Super_No, 85 AP.Title16, 10

AP.Tray_Prep, 114 AP.Ubrk1_Des, 124 AP.Ubrk10_Des, 124 AP.Unique_No, 85 AP.Unit_Desig, 27 AP.Unit_End, 124 AP.Unit_Start, 124 AP.Unt_Desc, 124 AP.Unt_No, 124 AP.Urb, 14, 27 AP.USAreaCod16, 17 AP.USPhone16, 17 AP.USPhoneExt16, 17 AP.USPhoneTyp16, 17 AP.USPhonLin16, 17 AP.USPhonPre16, 17 AP.USPS_Unit, 27 AP.ver_brk_f, 114 AP.Ver_Name, 114 AP.Ver_No, 114 AP.Ver_Wt, 114 AP.Volume_No, 124 AP.Walk_Seq, 36 AP.Was_Output, 85 AP.Zebra_Req, 114 AP.ZIP, 13 AP.ZIP_Move, 33 AP.ZIP_Range, 114 AP.ZIP_Type, 33 AP.ZIP4, 13 AP.ZIP9, 25, 31, 59 AP.Zone, 115 APA fields, 27 APA.Address, 27 APA.Postdir, 27 APA.Prim_Addr, 27 APA.Prim_Name, 27 APA.Prim_Range, 27 APA.Sec_Addr, 27 APA.Sec_Range, 27 APA.Suffix, 27 APA.Type, 28 APA.Unit_Desig, 28 APAL.Postdir, 27 APAL.Suffix, 27 APC field, 19 APC.All_Names, 19 APC.Dual_Name, 19 APC.Firm_Line12, 19 APC.Firm_Loc12, 19 APC.Firm12, 19 APC.FirstName16, 19 APC.Last_Name16, 19 APC.Mat_Post16, 19 APC.Mid_Name16, 19 APC.Name_Line16, 19 APC.Name16, 19 APC.NameDesig16, 19 APC.Oth_Post16, 19 APC.Pre_Name16, 19 APC.Record, 19 APC.Spec_Name, 19

140

Quick Reference for Views and Job-File Products February 2012

APC.Title16, 19 APD fields, 28 APD.Address, 28 APD.Extran_PMB, 28 APD.Extran_Sec, 28 APD.Extraneous, 28 APD.PO_Box, 28 APD.Postdir, 28 APD.Prim_Addr, 28 APD.Prim_Name, 28 APD.Prim_Range, 28 APD.Rec_Type, 29 APD.Remainder, 29 APD.RR_Box, 29 APD.RR_Number, 29 APD.Sec_Addr, 29 APD.Sec_Range, 29 APD.Suffix, 29 APD.Unit_Desig, 29 APD.Urb, 29 APDL.Postdir, 28 APDL.Predir, 28 APL.Postdir, 26 APL.Predir, 26 APL.Suffix, 26 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 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.FirstName12, 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_Name12, 18 APM.Move_Type, 44 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
Index

141

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 APM26.FirstName12, 18 APM26.Mid_Name12, 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.Address13, 12 APU.All_Names, 10 APU.City, 12 APU.Country, 13 APU.Dual_Name, 11 APU.Firm_Line12, 11 APU.Firm_Loc12, 11 APU.Firm12, 11 APU.FirstName16, 10 APU.Gender16, 12 APU.Last_Line, 13 APU.Last_Name16, 10 APU.Mat_Post16, 10 APU.Mid_Name16, 10 APU.Name_Line16, 11 APU.Name16, 10 APU.NameDesig16, 10 APU.Oth_Post16, 10 APU.POBox, 14 APU.POBox_Line, 14 APU.Pre_Name16, 10 APU.Prim_Addr, 13 APU.Prim_Range, 13 APU.RR, 14 APU.RR_Line, 14 APU.RRBox, 14

142

Quick Reference for Views and Job-File Products February 2012

APU.Sec_Addr, 13 APU.Sec_Range, 13 APU.Spec_Name, 11 APU.State, 12 APU.Title16, 10 APU.Urb, 14 APU.ZIP, 13 APU.ZIP4, 13 ASCII code values lower, 126127 upper, 128129 assigned address record type, 33 assignment status code, 33, 48

D
DataRight APM fields, 18 command-line syntax, 130 match standards first and middle names, 18 salutation fields, 12 DataRight IQ address data fields, 1214 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, 72, 90, 119 delivery point barcode, 24, 31, 43, 120 delivery point validation, 34, 35 delivery-point barcode, See DPBC destination city and state, 103 city name abbreviation, 103 container ZIP, 101 entry discount rate, 104 PLANET code, 93 USPS facility city, state, ZIP, 104 destination ZIP Code, 104, 120 container, 104 package, 108 pallet, 110 dimension fields, 91 directional post, 28, 43 discount destination-entry rate, 104 discrete field, 119 DPBC, 24, 31, 43, 90, 120 dupe group lists, 83 order, 82 priority, 76 rank, 82 record count, 82 serial number, 82 type, 82

B
barcode, 119 address, 112 container, 100, 101 sack or tray label, 119 Zebra, 114, 121 blank priority, 83 book version code, 119 break definition, 121 break definitions, 118 break level, 122 breakmark package, 108 pallet, 110 first and last piece, 110 last piece, 110

C
CART, 24, 30, 43, 72, 89 CASS, 31, 37, 46, 63 check digit, Planet barcode, 124 city destination, 103 city name truncate, 68 codes U.S. ACE, 37, 63 command-line options, 130 Edjob, 131 general commands, 130 container, 101 absolute number, 102 barcode, 100 degree of fullness letter trays, 101 destination ZIP, 101 destination ZIP Code, 104 level, 102 number, 102 number within mailing, 102 number within pallet, 102 postage rate, 103 size, 103 type, 103 volume, 103 weight, 103 country, 72 county, 72

E
early warning system, 32, 47 Edjob command-line options, 131 enclosure ride-along, 94, 113 end of record mark, 38, 53, 84, 105 endorsement

Index

143

rate, 113 entry point city, state, ZIP, 104 ID, 90 name, 104 number, 104 error codes ACE U.S., 70 error status code, 31, 46 EWS see early warning system extra field non address data, 30 extraneous data, 26, 28, 45

input file number, 104, 123 input record type, 84 intelligent hyphenation, 121 international mailing vendor, 91 International Presort command-line syntax, 130 issue date, 105

K
key fields Match/Consolidate, 7880

L
label origin line, 106, 121 label data, ??118 label number, 123 absolute, 123 Label Studio AP fields, 122124 input fields, 118121 output fields, 122124 PW fields, 118121 LACS, 32, 47 LACSLink, 54 last line, 23, 25, 43, 95, 120 parsing error code, 83 last_line, 73 latitude and longitude match code, 40, 50, 66 letter tray preparation, 114 level package sortation, 109 Level prefix, 81 line of travel, 24, 30, 43 list count, 83 list priority, 83 Locatable Address Conversion System, 54 LOT, 92 see line of travel

F
federal code state and county, 38, 53 field type alias input address, 28 fields other PW fields, 24 fifth digit US address status codes, 69 filter functions, 133 arithmetic, 133 compare, 133 comparisons, 133 convert data, 133 extract, 134 Unicode only, 134 fit and trim, 134 miscellaneous, 135 provide data, 134 string concatenation, 134 test, 134 FIPS code, 38, 53 firm, 22, 38, 65, 73 identification number, 91 match, 32 firm parsing error code, 81 first digit US address status codes, 68 first name match standards, 18 fourth digit US address status codes, 69

M
mailer name information, 123 mailing sequence number, 105 mail-piece status, 105 manifest keyline, 105 match cause, 84 match score number, 83 match standards first name, 18 middle name, 18 Match/Consolidate command-line syntax, 130 input fields, 7277 key fields, 7880 output fields, 8185 Matchset prefix, 81 messaging, 120 meter rate, 92 middle name match standards, 18

G
gender, 82 geocensus codes address level fields, 39, 65 centroid fields, 39, 66

H
hopper map, 123 house number primary name, 27 primary range, 26, 43

I
input file number, 81 record number, 39, 53, 84, 113, 124

144

Quick Reference for Views and Job-File Products February 2012

move indicator ZIP Code, 33, 48 move record effective date, 44 move type, 44 Mover ID fields NCOALink, 41 multi line address, 30 multi line input components U.S. ACE, 30, 58 multi version version identification, 95 weight, 91 weight in ounces, 91 width, 91

P
P. O. box see post office box package destination ZIP Code, 108 postage rate, 110 sortation level, 109 thickness, 110 weight, 110 package breakmark, 108 package number absolute, 109 from General Output, 109 within container, 109 within mailing, 109 within pallet, 109 within segment, 109 pallet absolute number, 111 destination ZIP Code, 110 range of pieces, 114 sortation level, 111 pallet breakmark, 110 pallet flag, 106 pallet number in General Output, 111 mailing, 111 segment, 111 pallet volume, 111 pallet weight, 112 parcel processing category, 113 parsing error last line, 83 parsing results, 84 participant code, ACS, 118 percent subscriber, 95 piece number, 107 absolute, 106 in container, 106 in package, 107 in pallet, 107 in segment, 107 within mailing, 107 pkg_brk_fl, 108 pkg_brk_l, 108 Planet barcode, 121, 124 PLANET code destination and origin, 93 PMB, 45 post directional abbreviation, 28, 43 post office box, 28 post office box number, 26 postage estimated, 112 meter rate, 92 postage rate package, 110 postal codes U.S. ACE, 30, 58 postal facility type, 37, 47

N
name, 84 name error code E101, 84 name_line, 75 name_line1, 75 NCOALink fields, 41 non-postal address, 26, 45 secondary range, 26, 45 unit designator, 26, 45 number of containers on pallet, 106 packages in container, 106 packages in pallet, 106 pieces for address label, 106 pieces in container, 106 pieces in package, 106 pieces on pallet, 106

O
operators, 133 arithmetic, 133 compare, 133 comparison, 133 convert data, 133 extract, 134 Unicode only, 134 fit and trim, 134 miscellaneous, 135 provide data, 134 string concatenation, 134 test, 134 operators (in filters), 135 optional endorsement, 106, 120 optional endorsement text, 106 origin line, 106, 121 origin PLANET code, 93 Other PW fields, 24 output limit one output per record, 85 output fields U.S. ACE, 25 output file record number, 39, 53, 84

Index

145

PostNet barcode, 120 PostNet required, 113 predir, 26, 28, 43, 57 Pre-LACSLink, 56 Presort command-line syntax, 130 input fields, 8996 input fields selection chart, 8889 output fields, 99115 output fields selection chart, 9799 prim_name, 76 primary address, 26 standardized, 28, 43 primary range house number, 26, 27, 43 primary street name standardized, 26, 28, 43 priority, 93 blank, 83 dupe group, 76 list, 83 private mail box data, 26, 28, 45, 57 private mailbox data, 26, 45 processing category parcel, 113 publication issue date, 105 Puerto Rican urbanization name, 22, 27, 29, 43 PW fields U.S. ACE, 22 PW fields, define your own, 77 PW.ACS_Code, 118 PW.ACS_Key, 118 PW.Ad_Pct, 88, 89 PW.Address, 7, 72 PW.Adr_Bc_Dgt, 118 PW.Adr_Bc_Max, 118 PW.Adr_Bc_Min, 118 PW.Aux_Ctrl, 118 PW.Brk_Lvl1-Lvl3, 118 PW.CART, 24, 72, 89 PW.CART_Endrs, 119 PW.Chk_Digit, 24 PW.City, 7, 22, 72, 89, 119 PW.Contents, 119 PW.Copies, 89, 119 PW.Country, 8, 23, 72, 90 PW.County, 24, 72, 90 PW.Ctn_Bc_Dgt, 119 PW.Ctn_Bc_Req, 119 PW.Date16, 8 PW.Delete, 8, 24, 72, 90, 119 PW.Demog_Code, 119 PW.Dest_City, 120 PW.Dest_CS_AB, 120 PW.Dest_Zip, 120 PW.DPBC, 24, 120 PW.Email16, 8 PW.Entry_ID, 90 PW.fieldname, 121 PW.Firm_ID, 91 PW.Firm1, 73

PW.Firm1-2, 73 PW.Firm12, 6 PW.FirmLine12, 6 PW.Firmline1-2, 73 PW.FirmLoc12, 6 PW.First_Name, 6, 22, 76 PW.Firstpart1-2, 73 PW.Force_SP, 91 PW.Height, 91 PW.ID1-9, 73 PW.IMB_ADR, 120 PW.IMB_ADR_AC, 120 PW.IMB_ADR_EC, 120 PW.IMB_CRID, 91 PW.IMB_MID, 91 PW.IMB_PLT, 120 PW.IMB_Serial, 91 PW.IMB_TRAYSCK, 120 PW.Intl_Regn, 91 PW.Key_Code, 91 PW.Last_Line, 7, 23, 73, 95, 120 PW.Last_Name, 6, 22, 76 PW.Lastpart1-2, 73 PW.Line1- 6, 120 PW.Line1- Line 12, 96 PW.Line1- Line6, 95 PW.Line112, 8, 23 PW.Line1-6, 74 PW.List_ID, 8, 74 PW.LOT, 24 PW.LOT_Order, 24, 92 PW.Mail_Class, 92 PW.Mail_Type, 120 PW.Merg_Purg1-0, 75 PW.Meter_Rate, 92 PW.Mid_Name, 6, 22, 76 PW.Mproc_Code, 120 PW.Msg_Link, 120 PW.Name_Firm1-6, 75 PW.Name_Firm16, 6 PW.Name_Line, 22, 75 PW.Name_Line1, 75 PW.Name_Line1-6, 75 PW.Name_Line16, 6 PW.Non_Addr16, 7 PW.Opt_Endrs, 120 PW.Orig_Line, 121 PW.Pattern14, 8 PW.Phone16, 8 PW.PLANET, 93 PW.Planet, 121 PW.Pmb, 72 PW.Post_Name, 6, 22, 76 PW.Pre_Name, 6, 22, 76 PW.Prim_Name, 76 PW.Priority, 76 PW.Prt_PLANET, 93 PW.RAE_ID, 94 PW.Seed_ID, 94 PW.Segment_ID, 94 PW.SRVC_Type, 94 PW.SSN16, 8

146

Quick Reference for Views and Job-File Products February 2012

PW.State, 7, 22, 72, 121 PW.Subscriber, 95 PW.Title, 22, 76 PW.Title1-6, 76 PW.Title16, 6 PW.Unit, 7, 22, 72 PW.Unt_Brk1, 121 PW.Unt_Brk10, 121 PW.Unt_Brk2, 121 PW.Unt_Brk2-9, 121 PW.Unt_Brk9, 121 PW.Urb, 7, 22 PW.user fieldname, 9 PW.Ver_Name, 95 PW.Version_ID, 95 PW.Walk_Seq, 95 PW.Width, 91, 95 also see PW.Height PW.Wt_Lbs, 91, 95 also see PW.Height PW.Wt_Oz, 91, 95 also see PW.Height PW.Zebra_Req, 121 PW.ZIP, 7, 76, 121 PW.ZIP10, 7, 76, 121 PW.ZIP4, 7, 76, 121 PW_Rate_Cat, 94 PW_Sub_Opt, 95

ride-along enclosure ID, 113 rule name for match, 83 rural route box number, 26, 29, 45

S
sack barcode, 119 scheme number, 114 second digit US address status codes, 68 secondary address complete, 26, 27, 29, 43 secondary address match, 32 secondary range, 26 non-postal, 26, 45 secondary range data, 26, 28, 45, 57 secondary range match, 32 seed file, 94 seed record, 91 segment identification number, 94 segment name, 114 segment number, 114 selection chart Presort input fields, 8889 Presort output fields, 9799 sequention list number, 82 sixth digit US address status codes, 69 sortation level pallet, 111 standardized address line, 27, 28 standardized primary street name, 27 state, 121 state and county federal code, 38, 53 state destination, 103 state name, 22, 25, 43 status code assignment, 33, 48 status codes ACE U.S., 6869 street name primary, 26, 28, 43 sub unit number, 124 subscriber percent, 95 suffix, 26 address, 26 super list count, 85 name, 85 number, 85 syntax command-line options, 130

Q
Q-books, 124

R
range secondary, 26 rate category mail piece, 108 rate endorsement, 113 record limit to one output file, 85 sequential number, 85 record identification field, 73 record number input file, 39, 53, 84, 113, 124 output file, 39, 53, 84 record type assigned address, 33 remainder address line, 26, 29 residential delivery indicator see AP.RDI result codes U.S. ACE, 31, 60 Results prefix, 81 AP., 81 ride-along enclosure ID field, 94 name, 113 thickness, 113 weight, 113

T
thickness, 91, 95 package, 110 ride-along enclosure, 113 third digit US address status codes, 68 title data, 22, 76 tray letter tray preparation, 114 tray barcode, 119 type container, 103

Index

147

U
unassigned address error code, 31, 46 unique record sequential number, 85 unit break description value, 124 unit designator non-postal, 26, 45 unit number current unit, 124 sub unit, 124 unit start and end, 121 unsuitable for delivery, 32, 47 urbanization name Puerto Rico, 22, 27, 29, 43 US address status codes ACE, 68 user fieldname, 24, 77, 96, 121 fieldnames, 121 USPS LACSLink, 54 USPS Planet barcode, 121

W
walk sequence, 95 weight container, 103 multi version, 91 ounces, 91 package, 110 pounds, 91 ride-along enclosure, 113 version, 114 width multi version, 91

Z
Zebra barcode required, 114, 121 zebra code, 121 ZIP, 23, 25, 31, 43, 56, 59, 76, 95 ZIP Code no hyphen, 25, 31, 59 range of pieces, 114 ZIP Code of destination, 104, 120 ZIP Code realignment, 33, 48 ZIP Code type, 33, 48 ZIP10, 23, 25, 31, 43, 56, 59, 76, 95, 96 ZIP4, 23, 25, 31, 43, 56, 59, 76, 96 ZIP9, 56 zone CART sort, 30, 46 zone rating, 115

V
version code, 91 version identification, 95 version name, 114 version number, 114 version weight, 114 volume container, 103 current volume number, 124

148

Quick Reference for Views and Job-File Products February 2012

Vous aimerez peut-être aussi