12feb quickref views en

8/13/2019 12feb Quickref Views En

1/148

February 2012

Quick Reference for Views and Job-File

Products


2/1482 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 wellas 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.


3/148

Contents 3

Contents

Chapter 1:

DataRight IQ.................................................................................................. 5DataRight 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


5/148

Chapter 1: DataRight IQ 5

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.



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.


Field name(s) Length Description Example of data

PW.Pre_NamePW.First_NamePW.Mid_NamePW.Last_NamePW.Post_Name

up to 254 If the input database contains discrete fields for name data, usethese PW fields to present the data to DataRight IQ. If you usethese input fields, at a minimum you must use Last_Name andeither Pre_Name or First_Name.

Mr.JohnB.SmithJr., CPA

PW.Title16 up to 254 If the input database contains a separate job-title field, presentthe field to DataRight IQ as Titlex. Use this field only if you areconfident that the field contains only job titles. DataRight IQdoes not apply its own parsing to this field.

Accountant

PW.Name_Line16 up to 254 If the input database stores names as whole lines, present each

line to DataRight IQ as Name_Linex. A name line may containmore than one name.

Mr. John B. Smith

Jr., CPA, AccountantMr. and Mrs. DavidZaimanJones, John and Doe,Mary

PW.Name_Firm16 up to 254 If an input field contains name data in some records but con-tains firm (company) data in other records, present the field toDataRight IQ as Name_Firmx. DataRight IQ parses name andfirm data from this field; any other data (including address data)is parsed as extra data.

Record 1: Mr. JohnB. Smith, Jr., CPARecord 2: BusinessObjects, Sales Dept.

PW.Firm12 up to 254 If an input field contains the name of a company or organiza-

tion, present the field to DataRight IQ as Firmx.Note:If you use any Linexfields, do not use the Firmxfields.Instead, use FirmLinex. (If you use any Firmxfields and alsouse Linexfields, any firm names found in the Linexfields will

be parsed as extra data.)

Business Objects

PW.FirmLoc12 up to 254 If an input field contains information that identifies a locationwithin a company, such as a department or mail stop, presentthe field to DataRight IQ as FirmLocx.Note:If you use any Linexfields, do notuse the Firm_Locxfields. Instead, use Firm_Linex. (If you use any FirmLocxfieldsand also use Linexfields, any firm location data found in theLinexfields will be parsed as extra data.)

Accounting Dept.

PW.FirmLine12 up to 254 If an input field contains both firm-name and firm-locationdata, present the field to DataRight IQ as FirmLinex. You mayalso use FirmLinexif a field contains firm-name data in somerecords but contains firm-location data in other records.Note:If you use any Firmxor FirmLocxfields, you may not useFirmLine1-2.

Business Objects,Accounting Dept.


7/148


PW.Non_Addr16 up to 254 If the input database stores any type of data in one single fieldexcept address type information. This would include names,firm names, telephone numbers, social security numbers, dates,and e-mail addresses.

Mr. John B. Smith,Jr., CPABusiness Objects,Sales Dept.

(608)555-1212

PW.Address up to 60 If the input database contains only one field for address-linedata (street address, PO box, rural route), present the field toDataRight IQ as Address. Through the Address field, DataRightIQ can accept dual addresses, where one field contains both astreet address and PO box, or a rural and fire address.Note:If the input database has more than one address-line field,do notuse Address for any of those fields. Instead, use Linexfor all the address-line fields.

1234 W Main St1234 W Main St,Apt. 51234 W Main St, PO

box 123

PW.Unit up to 60 If the input database has a separate field for unit information(apartment or suite), use Address for the primary (street)

address and Unit for the unit information.

Apt. 5

PW.City up to 60 If the input database has separate fields for city and state,present them to DataRight IQ through the input fields City andState.

La Crosse

PW.State 2 Note:You cannot use the discrete City and State fields if youstore city and state together in one field or use state abbrevia-tions other than those set by the U.S. Postal Service. In theseinstances, you must instead use Last_Line.

WI

PW.ZIP 5 If the input database has a field specifically for the 5-digit ZIPCode, present the field to DataRight IQ as ZIP.

54601

PW.ZIP4 4 If the input database has a separate field for the 4-digit ZIP+4extension, define the field as ZIP4.

4051

PW.ZIP10 10 If the input database has a combined field for ZIP and ZIP4,present the field to DataRight IQ as ZIP10. It doesnt matterwhether or not there is a hyphen between the codes.

54601-4051546014051

PW.Last_Line up to 60 If one field in the input database contains city, state, and ZIPdata, present the field to DataRight IQ as Last_Line.In some situations, you must set up Last_Line to include (con-catenate) two or more fields containing city, state, and ZIP data:If you store city and state data together in one field but storeZIP 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 abbrevia-tions other than those set by the U.S. Postal Service, you cannotuse the discrete State field. Set up Last_Line to include yourcity, state, and ZIP fields. For example, Last_Line = DB.CITY& DB.STATE & DB.ZIP.

La Crosse WI 54601-4051

PW.Urb up to 60 If the input database contains a separate field for the PuertoRican urbanization name, present the field to DataRight IQ asUrb.

Urb Radioville





PW.Country up to 60 If the input database contains a separate field for country name,present the field to DataRight IQ as Country. DataRight IQ doesnot do anything with the data in this field except apply capitali-zation.

Canada

PW.Line112 up to 60 If the content of an input field varies from record to record,present the field to DataRight IQ as Linex. DataRight IQ willidentify and parse name, title, firm, and U.S. address data.Use Linexonly if an input field is trulya multiline field withfloating data. If an input field consistently contains a certaintype of data, define the field as specifically as possible.Note:Do not use Linexfor discrete name components (firstname, middle name, last name, and so on).

Any data

PW.List_ID up to 254 Use this field to define logical lists. You can define an inputfield (for example, List_ID = DB.Broker), or you can define aconstant for all records in a file (for example, List_ID = Bro-

ker A).

Broker A

PW.Delete 1 Some fixed-length and ASCII files include a field that is used tomark files for deletion. If your file includes such a field, youcan present it as Delete. DataRight IQ checks the Delete field todetermine if the record is marked to be deleted. If thefirst char-acterof the field is an asterisk (*), the record is treated asdeleted. If the first character is any other character or if the fieldis blank, the record is not considered deleted.You can control whether DataRight IQ processes deletedrecords through the Process Deleted Recordsparameter in theInput File block.

*

PW.Date16 up to 60 If the input database contains a field for the date, present it to

DataRight IQ through Date1-6.

1977-08-16

PW.Email16 up to 60 If the input database contains a field for e-mail addresses,present it to DataRight IQ through EMail1-6.

[email protected]

PW.Phone16 up to 60 If the input database contains a field for phone numbers (eitherNorth American or International), present it to DataRight IQthrough Phone1-6.

(608)-555-555561 7 4035 2170

PW.SSN16 up to 60 If the input database contains a field for social security num-bers, present it to DataRight IQ through SSN1-6.

111-22-3333

PW.Pattern14 254 If youve created a user-defined pattern for a particular item inyour database, present the field that contains this data to DataR-

ight IQ through Pattern1-4.

PN160-345




9/148


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 differencesamong input files. If your input files contain different fieldnames (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 postingand filters.Note: When you type an entry for a User: field in the DEF file,do not include the PW prefix. For example, typeUser:CUST_ID, notUser:PW.CUST_ID.

Any data





DataRight IQ output fields selection chart

There are four types of DataRight IQ application fields:

APfields contain parsed, standardized data. DataRight IQ applies the

standardization specified in the Standardization/Assignment Control block in

the job file.

APUfields contain parsed, unstandardized data.

APCfields contain parsing-confidence scores.

APMfields 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


AP.NameDesig16

APU.NameDesig16254 Name designator such asAttn:or c/o. Attn:

AP.Pre_Name16

APU.Pre_Name16

254 Prename, such asMr.,Ms.,Dr. The prename may be parsedfrom the input data or assigned by DataRight IQ.

Mr.

AP.FirstName16

APU.FirstName16

254 First name or firstname initial. John

AP.Mid_Name16

APU.Mid_Name16

254 Middle name or middle initial. B.

AP.Last_Name16

APU.Last_Name16

254 Surname. Smith

AP.Mat_Post16

APU.Mat_Post16

254 Postname indicating heritage, such asJr., Sr.,III. Jr.

AP.Oth_Post16

APU.Oth_Post16

254 Postname indicating certification, academic degree, or affilia-tion, such as CPA,Ph.D., USMC.

CPA

AP.Title16APU.Title16

254 Job title. DataRight IQ associates the title with a name when-ever possible, so the job title in AP.Title1 is the title for the per-son in AP.Name1, and so on.

Accountant

AP.All_NamesAPU.All_Names

1500 AP.All_Names or APU.All_Names will concatenate allAP.NAMExor APU.NAMEx fields together.

AP.Name16APU.Name16 254 The entire name for one person, not including job title. Attn: Mr. John B.Smith, Jr., CPA


11/148


Firm data

AP.Name_Line16APU.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 theinput records contain name data in name lines or multilinefields, each Name_Linexfield contains all of the name and title

data found in the original input line. Name components are inthe same order as they appear on the input line. Note:Numbersfor the name linefields may not always correspond to the num-

bers for the name componentfields. For example,AP.FirstName2 may contain the first name of the second personfound on AP.Name_Line1.

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

Jones, Mr. John andDoe, Ms. Mary

AP.Dual_NameAPU.Dual_Name

254 The first dual name found by the parser. Name components arein the same order as they appear on the input line. (A dual nameis two names that share one last name.) Note:If DataRight IQfinds a dual name, it places the dual name into the appropriateAP.Name_Linexfield and alsointo AP.Dual_Name.

Mr. and Mrs. CraigPesik

AP.Spec_Name

APU.Spec_Name

254 Generic name words such as Occupant, Current Resident, orFamily.

Occupant

AP.Name_Cnt 1 The number of personal names found in the record (up to six). 2

DataRight IQ output fields: Name and title data


DataRight IQ output fields: Firm data


AP.Firm12APU.Firm12

up to 60 The name of a company or organization. Input data:FIRSTLOGICINCORP.

AP.Firm1: Firstlogic, Inc.APU.Firm1: FIRSTLOGICINCORP.

AP.Firm_Loc12APU.Firm_Loc12

up to 30 A location within a company or organization, such as adepartment, room, or mail stop. Usually this information isused for internal mail or fax delivery.

Input data: SALES DEPART-MENT

AP.Firm_Loc1: Sales Dept.APU.Firm_Loc1: SALESDEPARTMENT

AP.Firm_Line12APU.Firm_Line12

up to 60 All the firm data found in one input firm line or multilinefield. May contain company-name data, firm location data,or both.

Business Objects, SalesDept.



Gender codes andsalutations

Address data The output fields for address data are listed in address order, and not

alphabetically.

DataRight IQ output fields: Gender codes and salutations


AP.Gender16

APU.Gender16

1 Gender codes for AP.Name16. For a list of gender codes, see

AP.Gender_Rec.

5

AP.Gender_Rec 1 Overall gender for the entire record.1 High confidence male.2 Some confidence that the name is male.3 The name could be either male or female.4 Some confidence that the name is female.5 High confidence that the name is female.6 Multiple names, some male and some female.7 Multiple names, all male.8 Multiple names, all female.9 Multiple names, at least one ambiguous (but none

unasigned).0 Unassigned. DataRight IQ could not find any gender datafor the name.

6

AP.Salute16 up to 60 Salutation for the person in the corresponding AP.Namexfield. Dear Mr. Smith

AP.Dual_Salut up to 60 Salutation for AP.Dual_Name. Dear Mr. and Mrs.Pesik

AP.Salute_Rec up to 60 Salutation for all persons in the record. Dear Mr. Smith andMr. Jones

DataRight IQ output fields: Address data


AP.Address13APU.Address13

up to 60 Address line. May be a street address, post office box,or rural address. Address1 is the first address linefound by the parser as it worked its way up the address

block.Note: DataRight IQ strips all punctuation from stan-dardized (AP) address lines.

1234 W Main St, Apt 5PO box 123

AP.CityAPU.City

13 to 28 Discrete city name.Note:The standardized (AP) city field may contain adifferent city name than the input file (seeAP.Last_Line for an example). Results depend uponyour setting at the NonMailing Cities parameter in theStandardization/Assignment block.

Input data:LA CROSSAP.City: La CrosseAPU.City: LA CROSS

AP.StateAPU.State

2 to 15 Discrete state data. AP.State contains the standard U.S.Postal Service abbreviation, though only if Standardize

Last Line is turned on.

Input data: WiscAP.State: WIAPU.State: Wisc


13/148


AP.CountryAPU.Country

up to 60 If the input database contains a separate field for coun-try name, present the field to DataRight IQ as Country.DataRight IQ does not do anything with the data in thisfield except apply capitalization.

Canada

AP.ZIPAPU.ZIP

5 5digit ZIP Code.Note: DataRight IQ will not change or assign ZIPCode data unless the Standardize Last Line parameterin the Standardization/ Assignment Control block is setto Yes.ZIP Code data is also available from our ACE pro-gram. ACE is more reliable for ZIP Code assignment

because it can verify data with the national ZIP+4directory.

Input data:La Crosse WI54600

AP.ZIP: 54601APU.ZIP: 54600

AP.ZIP4APU.ZIP4

4 Last 4 digits of ZIP+4 code. This field will be blankunless 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.

Input data:La Crosse WI54601-4051

AP.ZIP4: 4051APU.ZIP4: 4051

AP.Last_LineAPU.Last_Line

up to 30 Combined city, state, and ZIP Code (and possiblyZIP4).Note:The example shows the fullest possible stan-dardization. Results depend upon your settings in theStandardization/Assignment block, particularly the

Non-Mailing Cities parameter and Standardize LastLine parameter.

Input data: Shelby, WISC.AP.Last_Line: La Crosse WI54601APU.Last_Line: Shelby,WISC.

AP.Prim_Addr

APU.Prim_Addr

20 to 60 Primary address (street address). Input data: 1000 VINESTREET WEST, APT. 123AP.Prim_Addr: 1000 VineStreet WestAPU.Prim_Addr: 1000 VINESTREET WEST

AP.Prim_RangeAPU.Prim_Range

up to 10 Primary range (house numberonly). Input data: 1000 VINESTREET WEST, APT. 123

AP.Prim_Range: 1000APU.Prim_Range: 1000

AP.Sec_AddrAPU.Sec_Addr

15 to 60 The complete secondary address (apartment or suite),including unit designator (such as Apt.) and unit num-

ber.

Input data: 1000 VINESTREET WEST, APT. 123

AP.Sec_Addr: Apt 123APU.Sec_Addr: APT. 123

AP.Sec_RangeAPU.Sec_Range

up to 8 Secondary range (apartment or suite numberonly). Input data: 1000 VINESTREET WEST, APT. 123

AP.Sec_Range: 123APU.Sec_Range: 123





Error, change, andquality codes

AP.POBox_LineAPU.POBox_Line

up to 18 Complete line for post office box. Input data:P.O. BOX 12AP.POBox_Line: PO box 12APU.POBox_Line: P.O. BOX12

AP.POBoxAPU.POBox

up to 11 Post-office box number. Input data:P.O. Box 12AP.POBox: 12APU.POBox: 12

AP.RR_LineAPU.RR_Line

up to 18 Complete line for rural-route or highway-contractaddresses.

Input data:RR 2, BOX 59AP.RR_Line: RR 2, Box 59APU.RR_Line: RR 2, BOX59

AP.RRAPU.RR

up to 11 Rural-route or highway-contract number. Input data:RR 2, Box 59AP.RR: 2APU.RR: 2

AP.RRBoxAPU.RRBox up to 11 Box number for rural-route or highway-contractaddress. Input data:RR 2, Box 59AP.RRBox: 59APU.RRBox: 59

AP.UrbAPU.Urb

up to 60 Puerto Rican urbanization name. Urb Radioville



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


AP.Name_Error 4 E101 if DataRight IQ did not parse any name data from theinput record. Blank if any name data was found.

E101

AP.Firm_Error 4 E201 if DataRight IQ did not parse any company-name datafrom the input record. Blank if any company name data wasfound.

E201

AP.Addr_Error 4 E301 if DataRight IQ did not parse any address-line data fromthe input record. Blank if any address-line data was found.

E301

AP.LL_Error 4 Parsing error code for last-line data:E401 No last-line data was parsed from the record.E402 The last-line is either incomplete or not valid.E403 Foreign last line.

E402

AP.Name_Chng 8 A code indicating which name components DataRight IQ stan-dardized during processing. For values and decoding instruc-tions, see theDataRight IQ Users Guide.

C0000004


15/148


Status codes

AP.Firm_Chng 3 A code indicating which firm components DataRight IQ stan-dardized during processing. For values and decoding instruc-tions, see theDataRight IQ Users Guide.

C01

AP.Addr_Chng 2 A code indicating whether DataRight IQ dropped any address-line 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 arecord, it keeps the first street address line found and drops anyadditional street address lines. The same concept also applies tomultiple PO box addresses and multiple rural-route addresses.

C0

AP.LL_Chng 3 A code indicating which last-line components DataRight IQchanged (standardized) during processing. For values anddecoding instructions, see theDataRight IQ Users Guide.

C01

AP.Name_Qual 9 A code indicating which name components DataRight IQ foundin the input data. For values and decoding instructions, see the

DataRight IQ Users Guide.

Q00023046

AP.Firm_Qual 3 A code indicating which firm components DataRight IQ foundin the input data. For values and decoding instructions, see the

DataRight IQ Users Guide.

Q01

AP.Addr_Qual 3 A code indicating which address-line components DataRight IQfound in the input data. For values and decoding instructions,see theDataRight IQ Users Guide.

Q03

AP.LL_Qual 2 A code indicating which last-line components DataRight IQfound in the input data. For values and decoding instructions,see theDataRight IQ Users Guide.

C7

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


DataRight IQ output fields: Status codes


AP.Name_Stat 7 A 6-digit numeric status code prefixed with an S. Eachnumeric digit indicates the status of one AP.Namexfield. Theleftmost digit is for AP.Name1, the rightmost for AP.Name6:0 AP.Namexis 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).

S100000This status code indi-cates that forAP.Name1 the gen-

der of the prenameand first name agree(1). AP.Name26 areempty (0).

AP.Dname_Stat 2 Status code for AP.Dual_Name:S0 AP.Dual_Name is empty.S1 AP.Dual_Name is populated.

S1



Miscellaneous fields

AP.Firm_Stat 3 A 2-digit numeric status code prefixed with an S. The left-most digit indicates the status of AP.Firm1. The right-most digitindicates the status of AP.Firm2.0 AP.Firmxis empty.

1 The data in AP.Firmxhas a format typical of a firm name.3 The data in AP.Firmxhas a format typical of a persons

name.

S10This status code indi-cates that the data inAP.Firm1 has a firm-

name format (1) andthat AP.Firm2 isempty (0).

AP.Addr_Stat 4 A 3-digit numeric code prefixed with an S. Each numericdigit indicates the status of one AP.Addressxfield. The left-most digit is for AP.Address1, the second digit is forAP.Address2, the right-most digit is for AP.Address3.0 AP.Addressxis empty.1 AP.Addressxis populated.

S110This status code indi-cates that data is

present inAP.Address1 andAP.Address2 (1), andAP.Address3 isempty (0).

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

S1

DataRight IQ output fields: Status codes


DataRight IQ output fields: Miscellaneous fields


AP.Bypass 1 T True if the record was bypassed during processing by

meeting a certain condition in the bypass filter.

F False if the record was not bypassed during processingby meeting a certain condition in the bypass filter

T

F

AP.Date16 up to 60 Contains the parsed date. 1977-08-16

AP.Email16 up to 60 Contains the parsed e-mail address. [email protected]

AP.EmailUser16 up to 80 Contains the user name from the parsed e-mail address. joex

AP.EmailAllD16 up to 80 Contains the entire domain name, without the user name, fromthe parsed e-mail address (everything after the @ symbol).

univer-sity.rr.sci.rm.edu.uk

AP.EmailTopD16 up to 80 Contains the top level domain from the parsed e-mail address. uk

AP.Email2ndD16 up to 80 Contains the second level domain from the parsed e-mailaddress.

edu

AP.Email3rdD16 up to 80 Contains the third level domain from the parsed e-mail address. rm

AP.Email4thD16 up to 80 Contains the fourth level domain from the parsed e-mailaddress.

scil

AP.Email5thD16 up to 80 Contains the fifth level domain from the parsed e-mail address. rr

AP.EmailHost16 up to 80 Contains the host domain from the parsed e-mail address. university


17/148


AP.EmailISP16 1 Contains a value indicating whether the domain of this e-

mail looked up in the ISP file.

T or F

AP.USPhone16 up to 60 Contains the parsed North American (U.S. and Canada) phone

number.

(608)-555-1212

AP.USAreaCod16 3 Contains the area code from the parsed U.S. phone number. 608

AP.USPhonPre16 3 Contains the prefix from the parsed U.S. phone number. 555

AP.USPhonLin16 4 Contains the line number from the parsed U.S. phone number. 1212

AP.USPhonExt16 10 Contains the extension from the parsed U.S. phone number. ext2500

AP.USPhoneTyp16 32 Contains the type of U.S. phone number. business

AP.IntPhone16 up to 60 Contains the parsed international (non-North American) phonenumber.

011 44 4035 2170

AP.IntCtryCd16 4 Contains the country code from the parsed international phonenumber.

44

AP.IntCityCd16 up to 32 Contains the city code from the parsed international phonenum-ber.

4035

AP.IntPhNum16 up to 32 Contains the line number from the parsed international phonenumber.

2170

AP.IntPhDesc16 up to 64 Contains the description from the parsed international phonenumber.

United Kingdom

AP.SSN16 up to 60 Contains the parsed U.S. Social Security number. 111-22-3333

AP.Pattern14 up to 60 Contains the parsed user-defined pattern. PN160-345

AP.PatnLabel14 up to 80 Contains the text label from the user defined file that identifiesthe pattern matched.

AP.Patnsub1-4_15 up to 254 Up to 5 sub patterns that make up your pattern rule.

AP.Extra112 up to 60 Excess data that could not be identified or sent to other APfields. In general, excess data will be arranged in the same orderthat it appeared in the input record. DataRight IQ fills thesefields from the top down (1 to 12).

25E-95C4

AP.File_No up to 3 Input file number, according to the sequence ofInput Fileblocks in the job file.

1

AP.List_No up to 3 List number, according to the sequence ofInput List Descrip-tionblocks in the job file. Identifies the list to which the record

belongs.

1

AP.list_name up to 60 The name of the output list that was defined.





Match standards forfirst and middle names

APM fields contain match standards that can be used for Match/Consolidate

processing.

AP.Rec_No_Out up to 10 Output record number, numbered separately for each outputfile. 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 recordDataRight IQ appends to the file.

42568

AP.Record_No up to 10 Record number from the input file. 127046

AP.Newline 1 to 2 CRLFon DOS, LFon UNIX. Use this as the end-of-record markwhen posting to ASCII output files.

CRLF



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

are intended for use in later match processing. DataRight

IQ returns up to six match standards for each first name.

If AP.FirstName1

contains Pat:

APM.FirstName1:

Patricia

APM2.FirstName1:

Patrick

APM.Mid_Name16

APM26.Mid_Name16

254 Match standards for AP.Mid_Name16. Match stan-

dards 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


19/148


Confidence scores forname, title, and firmdata

DataRight IQ output fields: Confidence scores for name, title, and firm data

Field name(s) Length Description

APC.NameDesig16APC.Pre_Name16

APC.FirstName16

APC.Mid_Name16

APC.Last_Name16

APC.Mat_Post16

APC.Oth_Post16

3 Confidence scores for each of the parsed name components.A confidence score is a number from 1 to 100 indicating the confidence that thedata was parsed correctly.

APC.Name16 3 Confidence scores for AP.Name16 and APU.Name16.

APC.Name_Line16 3 Confidence scores for AP.Name_Line16 and APU.Name_Line16.

APC.All_Names Confidence scores for AP.All_Names and APU.All_Names.

APC.Dual_Name 3 Confidence score for AP.Dual_Name and APU.Dual_Name.APC.Spec_Name up to 60 Confidence scores for AP.Spec_Name and APU.Spec_Name.

APC.Title16 3 Confidence scores for AP.Title16 and APU.Title16.

APC.Firm12 3 Confidence scores for AP.Firm12 and APU.Firm12.

APC.Firm_Loc12 3 Confidence scores for AP.Firm_Loc12 and APU.Firm_Loc12.

APC.Firm_Line12 3 Confidence scores for AP.Firm_Line12 and APU.Firm_Line12.

APC.Record 3 Composite parsing-confidence score for all name, title, and firm data parsedfrom the record.


21/148

Chapter 2: ACE U.S. 21

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 theACE Job File

Referenceor the ACE Views online help.



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

Name (discretename compo-nents)

PW.Pre_NamePW.First_NamePW.Mid_NamePW.Last_NamePW.Post_Name

up to 60 If youre performing Mover ID NCOALinkprocessing, ACE can take thesediscrete name components as input. You can achieve the best NCOALinkmatching results by using discrete name components.

Title PW.Title up to 60 ACE doesnt do anything with Titledata except capitalize it.

Firm PW.Firm up to 60 Some firms have their own ZIP+4 code. So if you present your company fieldto ACE, ACE can assign more specifically. Without the Firmfield, ACE

would have to fall back to assigning a more general ZIP+4 code that coversthe whole building or block.

Street address PW.AddressPW.Unit

up to 60up to 60

If you store both the primary (street) address and the secondary address(apartment or suite) in separate fields, then you should present your data toACE through the Addressand Unitfields. For example: Address = 1000Main Street, Unit = Apt. 5.Present only the Addressfield if you have one field combining the primaryand secondary address (for example, 1000 Main Street Apt. 5). Throughthe Addressfield, ACE also can accept dual addresses, where one field con-tains both a street and PO-box address, or a rural and fire address (for exam-

ple, 1000 Vine St., PO box 510 or RR 1 Box 510, 1000 Cedar Rd).

PW.Urb up to 60 In Puerto Rico only, an Urbanizationis a place name that denotes a neigh-borhood or subdivision (for example, Urb Los Olmos or Urb Paseo LasVistas). When matching a Puerto Rican address to the ZIP+4 directory, ACEoccasionally needs the urbanization to break a tie. This is because two differ-ent urbanizations may contain streets of the same name and house numbers.If your input address does not include an urbanization, ACE may be able toadd it.

City PW.City up to 60 If you have separate database fields for city and state, present them to ACEthrough the input fields Cityand State. ACE uses this information to assign aZIP Code.You cannot use the discrete fields Cityand Stateif: 1) You store city andstate together in a combined field, or 2) You use state abbreviations other than

those set by the U.S. Postal Service. See the Last_Linefield below.

State PW.State 2


23/148


ZIP Code PW.ZIP 5 If you have a field specifically for the ordinary, 5-digit ZIP Code, thenpresent it to ACE through the ZIPfield. ACE uses this information to con-firm, or perhaps to complete, the city and state data.

PW.ZIP4 4 ZIP4codes are required for Postnet barcoding. They are also important forthe GeoCensus Option. Notice that the proper field name does not include theplus sign (+).

PW.ZIP10 10 If you have a combined field for ZIP and ZIP+4, present it through the ZIP10field 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, itwill insert a hyphen intelligently.

Country PW.Country up to 60 ACE uses Countrydata to detect foreign addresses. ACE does not attempt toassign any addresses outside the U.S. and its possessions, territories, and pro-tectorates. For domestic addresses, the Countryfield may be blank or con-tain any reasonable spelling such as USA, United States, and so on.

Multiline PW.Line112 up to 60 Some companies store name-address data in an open format of four or morelines. We call this type of record format a multilineformat. ACE can accepttwo to 12 lines of multiline input. However many of these fields you need touse, be sure to start with Line1 and use fields consecutively. (ACE wouldreport an error if you try to use lines 2, 3, and 5, for example.) All your multi-line fields must be the same length if you want ACE to apply the SwapLines feature.

Last line PW.Last_Line up to 60 There are some situations in which you should use the ACE field Last_Lineinstead of the separate City, State, and ZIP fields:If you have a combined city-state-ZIP field, well, thats exactly what ACEcalls 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. Inthat situation you have to set up the Last_Linefield to include (concatenate)both of your fields; for example, Last_Line = DB.City_State & DB.ZIP. Youdo not have to physically merge your fields. Note, with concatenated fields,ACE cannot apply automatic updating. You will have to manually post APfields.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, presentyour city, state, and ZIP fields together through the Last_Line field. Forexample: Last_Line = DB.City & DB.State & DB.ZIP





Postal Codes If you already have postal codes in your input data, you can use the fieldsbelow to pass your codes intoACE. ACE will not use your original codes inthe assignment process at all. However, these input fields are useful for otherreasons; for example:

ACE automatically updates these fields. So they can make it easier to updatethe postal-code fields in your database.ACE can compare the codes it assigned with the codes you input. ACE Viewsand ACE Job, on their summary reports, give statistics about this. ACELibrary and Transaction give you tools to create your own before-and-afterstatistics.

PW.DPBC 2 DPBCmeans delivery point bar code. Youll need this for Postnet barcodeson letter mail, for LOT sortation., and for Periodicals (unless you do a truewalk sequence).

PW.Chk_Digit 1 Chk_Digitis short for check digit. Some label-printing systems requirethis digit for Postnet barcoding. If you use Label Studio you dont need it

from ACE; Label Studio can generate the check digit for itself.PW.CART 4 CARTmeans carrier route. You will need CART numbers if you intend to

sort mail to carrier routes for a postage discount.

PW.LOTPW.LOT_Order

41

LOT(line of travel) codes enable Presort to sort mail nearly to walksequence. LOT and LOT_Order codes are required only if you mail StandardMail, Enhanced Carrier-Route Subclass, or Periodicals (unless you do a truewalk sequence).

County PW.County 3 Although ACE assigns them from a postal database, Countynumbers are notreally postal codes used in mail handling (except in Periodicals Class).

Numbers start at 001 within each state.

Mark recordsfor deletion

PW.Delete 1 When processing non-dBASE files, you can use the Deletefield to signalACE when a record is marked to be deleted (nondestructive). ACE checks theDelete field to determine if the record is marked to be deleted. If the firstcharacter is an asterisk (*), the record is treated as deleted. If the first charac-ter is anything else, the record is not considered deleted. You can controlwhether ACE processes deleted records through the Process Deleted Recordsoption in the Input File section.

Other PW fields PW up to 60 ACE can accept a large number of other PW fields not listed here. Find acomplete list in the Index. ACE doesnt necessarily process or use those otherfields, but they are handy in posting or filters when you are working with filesthat dont use the same field names.

user-defined

fields

user:fieldname You may define your own PW fields by using the prefix user:in your DEF

file. For example, if you define user:Status = DB.STATUS, then you canwork 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 fieldnames.




25/148


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 mailingpurposes, this field will always yield a converted city name, no matter how the place-nameoption is set.

AP.City_Abbr 13 AP.City_Abbr yields the official USPS abbreviation of the city name, if one is available. Thisfield 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_LLIDX 13 to 28 AP.City_LLIDXyields a city name that is more geographically precise than AP.City. LLIDX(last-line index) is a USPS number that ties a ZIP+4 record to a particular city, state, and ZIP.

AP.City_Npref 13 to 28 Compare with AP.City_LLIDX. When the input city is not recognized as a valid mailing cityfor 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 namecapital-ized and with spelling corrected as necessarywill be output through AP.City_Npref, so youcan retain it if you wish. If there is no input city or the input city is not valid in the assignedfinance area, then the default city for the assigned finance area will be output throughAP.City_Npref.

AP. City_Place 13 to 28 Standardized city name; city names invalid for mailing are always preserved, never converted,regardless of the values set for the Assign City From Input/ LL IDX and Non-Mailing Cit-ies options.

AP.Last_Line 28 to 43 If the address is fully assigned, this component yields a complete, standardized last line, includ-ing 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 setMultiline Style parameter Include ZIP+4.If the last line cannot be matched, this component yields ACEs best attempt at a standardizedlast 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 outputfield. If a 13-character city abbreviation does not exist, the full city name is output to theLast_Line field.

AP.State 2 Standard USPS abbreviation for the state (AK, AL, AR, and so on)

AP.ZIP 5 Either the 5-digit ZIP assigned by ACE or, if ACE could not assign, then the ZIP found in theinput record. You can decide whether ACE will do the same thing with ZIP+4. Refer to theUnverified Postal Code optionwe recommend the Erase setting.

AP.ZIP10 10 ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen.

AP.ZIP4 4 ZIP+4 add-on.

AP.ZIP9 9 ZIP and ZIP+4 add-on without hyphen.



Assigned address-linecomponents

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


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), nomatter how the Strict/Loose parameter was set.This component will contain the USPS street abbreviation if that option is enabled.

AP.Aline up to 60 Complete address line: Primary, secondary, urbanization, dual address, and remainder.This component will contain the USPS street abbreviation if that option is enabled.

AP.Dual_Line 20 to 60 Complete, standardized address line, including primary and secondary, if available.

AP.Extran_PMB 14 Extraneous data retained in this field is our best guess at Private Mail Box data, based on

the position in the address line and other information contained in the address.

AP.Extran_Sec 14 Extraneous data retained in this field is our best guess at secondary range data, based on

the position in the address line and other information contained in the address.

AP.Extraneous 28 Consists of the data from EXTRAN_SEC and EXTRAN_PMB respectively. Any addi-

tional # data is placed in the remainder or extra components.

AP.Np_Secaddr 20 Complete secondary non-postal address (PMB 10).

AP.Np_Srange 10 Non-postal secondary range (PMB number only, does not include designator).

AP.Np_Unit up to 10 Non-postal unit designator (PMB).

AP.PO_Box up to 9 Post-office box number.

AP.PostdirAPL.Postdir

29

Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW).Postdirectional spelled out (North, Northeast, East, and so on).

AP.PredirAPL.Predir

29

Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW).Predirectional spelled out (North, Northeast, East, and so on).

AP.Prim_Addr up to 60 Complete, standardized, primary address line (for example, 100 Main St.).This component will contain the USPS street abbreviation if that option is enabled.

AP.Prim_Name up to 28 Standardized primary name (most often street name). Caution: When the true street nameincludes a directional word (for example, North Ridge) this field may give you an incompletestreet name (Ridge) because of USPS base-data patterns.

AP.Prim_Range up to 10 Primary range (house number, such as 1000 in 1000 Vine Street).

AP.Remainder up to 60 Extraneous data found on the address line, which either cant be identified by the parser ordoes not belong in a standardized address.

AP.RR_Box up to 9 Rural-route box number.

AP.RR_Number up to 9 Rural-route number.

AP.Sec_Addr up to 60 Complete secondary address (for example, Apt 10, Set 500, Box 34, Am 7, 5thFlr).

AP.Sec_Range up to 8 Secondary range (apt. or suite number only, does not include designator).

AP.SuffixAPL.Suffix

410

Abbreviated suffix (St, Ave, Blvd, Rd, and so on).Suffix spelled out (Street, Avenue, Boulevard, and so on).


27/148


Alias address-linecomponents

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

theACE Users Guidefor background information and examples of aliases and

alternates.

AP.Unit_Desig up to 10 Unit designator (#, Apt, Ste, and so on).

AP.Urb up to 60 Urbanization name; produced only when the address is in Puerto Rico.

AP.USPS_Unit up to 10 Unit designator from ZIP+4 directory, or blank if none was found.

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


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


APA.Address 20 to 60 Complete, standardized primary and secondary address line. Style of suffixes, directionals,and unit designators depends on how you set the Style parameters.This component will contain the USPS street abbreviation if that option is enabled.

APA.PostdirAPAL.Postdir

29

Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW).Postdirectional spelled out (North, Northeast, East, and so on).

APA.PredirAPAL.Predir

29

Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW).Predirectional spelled out (North, Northeast, East, and so on).

APA.Prim_Addr up to 60 Complete, standardized, primary address line. Short or long style of suffixes and directionalsdepends on how you set the Style parameters.

This component will contain the USPS street abbreviation if that option is enabled.

APA.Prim_Name up to 28 Standardized primary name (most often street name). Caution: When the true street nameincludes a directional word (for example, North Ridge) this field may give you an incom-

plete street name (Ridge) because of USPS base-data patterns.

APA.Prim_Range up to 10 Primary range (house number, such as 1000 in 1000 Vine Street) for the alternateaddress.

APA.Sec_Addr up to 60 Complete secondary address (for example, Apt 10, Ste 500, Box 34, Rm 7, 5thFlr) for thealternate address.

APA.Sec_Range up to 8 Secondary range (apt. or suite number only, does not include designator).

APA.SuffixAPAL.Suffix 410 Abbreviated suffix (St, Ave, Blvd, Rd, and so on).Suffix spelled out (Street, Avenue, Boulevard, and so on).



Dual address-linecomponents

APA.Type 1 Alias type. Describes the input address, not the output address.A Input address matched an abbreviated street name.

B The input address matched the high-rise alternate default base record.

C Input street name is out of date; to get new street name, convert your record to

the preferred alias.

H Input address was an undesirable alternate, subject to conversion to a USPS

preferred street address (high-rise alternate).

O Input address was a street nickname or other alias.

P Input address was a preferred alias.

blank Input address was not an alias or was unassigned.

APA.Unit_Desig up to 10 Unit designator (#, Apt, Ste, and so on) for the alternate address.

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


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


APD.Address 20 to 60 Complete, standardized address line, including primary and secondary, if available.

APD.Extran_PMB 14 Extraneous data in this field is the best guess at Private Mail Box data, based onposition in the address line and other information contained in the address.

APD.Extran_Sec 14 Extraneous data in this field is our best guess at secondary range data, based onposition in the address line and other information contained in the address.

APD.Extraneous 28 Consists of the data from EXTRAN_SEC and EXTRAN_PMB respectively.

Any additional # data is placed in the remainder or extra components.

APD.PO_Box up to 9 Post-office box number for the dual address.

APD.PostdirAPDL.Postdir

29

Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW) of the dual address.Postdirectional spelled out (North, Northeast, East, and so on) of the dual address.

APD.PredirAPDL.Predir

29

Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW) of the dual address.Predirectional spelled out (North, Northeast, East, and so on) of the dual address.

APD.Prim_Addr up to 60 Standardized primary address.

APD.Prim_Name up to 28 Standardized primary name (most often street name) of the dual address. Caution:When the true street name includes a directional word (for example, North Ridge),this field may give you an incomplete street name (Ridge) because of USPS base-data patterns.

APD.Prim_Range up to 10 Primary range (house number, such as 1000 in 1000 Vine Street) of the dualaddress.


29/148


APD.Rec_Type 1 When a dual address is identified but not assigned, ACE will provide an address-type indication based on the way that the input data was parsed. This is not guaran-tee. ACE may indicate that a street, rural route, highway contract, general delivery,or PO box was parsed.

F FirmG General deliveryH High-rise apartment or office buildingP Post Office BoxR Rural route or highway contractS Streetblank Unassigned.

APD.Remainder up to 60 Extra data found on the address line, which either cant be identified by the parseror does not belong in a standardized address.

APD.RR_Box up to 9 Rural-route box number for the dual address.

APD.RR_Number up to 9 Rural-route number for the dual address.APD.Sec_Addr up to 60 Standardized secondary address (for example, Apt 210 or Ste 300).

APD.Sec_Range up to 8 Secondary range (apartment or suite number only, does not include designator) ofthe dual address.

APD.SuffixAPDL.Suffix

410

Abbreviated suffix (St, Ave, Blvd, Rd, and so on) of the dual address.Suffix spelled out (Street, Avenue, Boulevard, and so on) of the dual address.

APD.Unit_Desig up to 10 Unit designator (#, Apt, Ste, and so on) of the dual address.

APD.Urb up to 60 Urbanization name; produced only when the address lies in Puerto Rico.

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




Components availablefor multiline input

Postal codes

ACE U.S. output fields: Components available for multiline input


AP.Extra1-10 up to 60 The Extra fields contain whatever non addressdata ACE can find above the address data.

The first Extra field populated is AP.Extra10, then AP.Extra9, and so on. For example:

The Extra fields were added before DataRight was available. If you want to convert multilineaddress 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 set-tings.These fields enable you to output a record that contains both the original and standardizedaddress.When planning your field length, please select a length that is greater than or equal to thelength of the input, multiline fields (Line112).If you have chosen to abbreviate the city name, the abbreviated city name appears in this outputfield. If a 13-character city abbreviation does not exist, the full city name is output to theLast_Line field.If using multiline, this component will contain the USPS street abbreviation if that option isenabled.

Input record Output record

Line1 = John Dough Extra7 =

Line2 = American Bakery Supply Extra 8 =

Line3 = 308 2nd Ave #152 Extra9 = John Dough

Line4 = Ames IA 50014 Extra10 = American Bakery Supply

Line5 = Address = 308 2nd Ave Ste 152

Line6 = City = Ames

State = IA

ZIP = 50014

ACE U.S. output fields: Postal codes


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

AP.CR_Sort_Zn 1 Carrier-route sort zone; indicates eligibility for Standard Mail Automation Enhanced CarrierRoute. Tip: This field is for convenience only. Presort will determine for itself where to applyCART discounts, and does not need this field from ACE.A Carrier route rates are available and merging is allowed.B Carrier route rates are available and merging is not allowed.C Carrier route rates are not available and merging is allowed.D Carrier route rates are not available and merging is not allowed.

AP.LOT 4 Line-of-Travel number


31/148


Codes that describethe address andassignment results

AP.LOT_Order 1 Line-of-Travel sortation:A AscendingD DescendingLOT codes are required for non automated, CART presorting in Standard Mail, Enhanced Car-

rier Route Subclass. LOT codes enable Presort to prepare letters in near walk sequence. See thePresort documentation for instructions.

AP.Chk_Digit 1 If ACE can make a full assignment, this component contains the check-digit for 11-digit deliv-ery-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 theunverified input ZIP.This check digit is not valid for printing a 9-digit barcode.

AP.DPBC 2 Numeric 2-digit code for delivery-point barcode. Also used in LOT sortation (see LOT above).Blank when ZIP+4 could not be assigned.

AP.ZIP 5 Either the 5-digit ZIP assigned by ACE or, if ACE could not assign, then the ZIP found in theinput record. You can decide whether ACE will do the same thing with ZIP+4. Refer to theUnverified Postal Code optionwe recommend the Erase setting.

AP.ZIP10 10 ZIP, hyphen, and ZIP+4. If no ZIP+4 is available, ACE suppresses the hyphen.

AP.ZIP4 4 ZIP+4 add-on.

AP.ZIP9 9 ZIP and ZIP+4 add-on without hyphen.

ACE U.S. output fields: Postal codes


ACE U.S. output fields: Codes that describe the address and assignment

results


AP.CASSrectyp 1 This component posts the record type necessary for posting on the CASS test. The validrecord types are:

F (firm)

G (general delivery)

H (high-rise)

P (PO box)

R (rural route or hwy contract)S (street)

blank unassigned

AP.Err_Stat 6 Error code, if address is unassigned; or status code, if assigned.

AP.Error_Code 6 Error code, if address is unassigned; or blank, if assigned.



AP.EWS_Match 1 If the address is located in the EWS directory, the address is an EWS match and a T isreturned. If the address is not located in the EWS directory, an F is returned.

AP.Foreign 1 Foreign address flag: Ffor foreign addresses, blank for domestic U.S.

AP.LACSCODE 1 LACS (Locatable Address Conversion System) indicator:T Address needs 9-1-1 conversion (from box to street address) and should be submitted to

a LACS vendor.F Address does not need conversion.blank Address was not assigned.

AP.Match_5 1 T Last line was matched to a City/ZCF record.F Last line was notmatched to a City/ZCF record.

AP.Match_9 1 T Address line was matched to a ZIP+4 record.

F Address line was notmatched 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_9and Match_5 will be T.Note:Undeliverable addresses are 9-digit matches and they get a Match_9 value of T. But theyhave no ZIP+4 code. Therefore if you filter only on Match_9 you may get some blank ZIP+4fields in your output. To filter out undeliverable addresses, filter on the Match_Un field.

AP.Match_Un 1 T The address is tagged by the USPS as unsuitable for mail delivery. This includes E600records (for example, a cemetary or parking lot) as well as E601 records which aredeemed undeliverable using DPV processing.

F The address either was not matched to a ZIP+4 record, or was matched to a record thatindicates the address is suitable for mail delivery.

AP.NC_Firm Up to

60

The firm match that was made using the input ZIP+4 for missing or invalid firm informa-

tion.

AP.NC_Secaddr Up to

60

The secondary address match that was made using the input ZIP+4 for missing or invalid

secondary address information.

AP.NC_Srange Up to 8 The secondary range match that was made using the input ZIP+4 for missing or invalid

secondary range information.

AP.NC_Unit Up to

10

The unit designator match that was made using the input ZIP+4 for missing or invalid unit

designator information.


results



33/148


AP.Rec_Type 2 Record-type indicator for the assigned address.The first character indicates the type of record in the ZIP+4 directory to which the address wasmatched: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 Dor blank. The Dstands for default; it means that ACEdetected, from the ZIP+4 directory, that a finer level of ZIP+4 assignment would be possible iffurther input information were available.

FD Firm default. ACE did not assign a firm-level ZIP+4, but could do so if given more orbetter 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 num-ber 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 toassign the ZIP+4 for the block.

UD Unique default. Either the owner of the unique ZIP has not provided ZIP+4 assign-ments, or the address could not be matched.

When ACE cannot assign an address, it will provide an address-type indication based on theway that the input data was parsed. This is not foolproof. ACE may indicate that a street, ruralroute, highway contract, general delivery, or PO box was parsed.

AP.Stat_Code 6 Status code (whether assigned or not). The sixth character returned for this field is currentlyunused and will be blank.

AP.ZIP_Move 1 ZIP Move indicator:T The address is affected by a USPS ZIP Code realignment. ACE has assigned the new

ZIP Code and, if applicable, the new city name.F The address is not affected by any USPS ZIP Code realignment.

AP.ZIP_Type 1 Type of ZIP Code assigned by ACE:

M Military.U Unique (specific to a university, large firm, or other institution).blank Ordinary ZIP, or ZIP was not assigned.


results




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 The address is a valid Commercial Mail Receiving Agency.N The address is not a Commercial Mail Receiving Agency.L The address triggered DPV locking.blank This component is blank when the DPV 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 followinginformation: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 12characters in length.

AP.DPV_NoStat 1 No Stat indicator. No Stat means that the address is a vacant property, it receives mail as a partof 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.


results



35/148


AP.DPV_Status 1 The following values are available for AP.DPV_Status:Y The address is a confirmed delivery point. The primary range and secondary range (if

present) are valid.N The address is not a valid delivery point.S The primary range is a valid delivery point, but the parsed secondary range (including

extran_sec # sign data) is not valid in the DPV directory.D The primary range is a valid delivery point, but the secondary range data is not avail-

able on input.L This address triggered DPV Locking. Refer to the Delivery Point Validation Alert sec-

tion of the Job Summary for details.blank This field is blank when the DPV mode is not enabled, DPV processing is currently

locked, or ACE cannot assign the input address.

AP.DPV_Vacant 1 Vacant address indicator.Y Address is vacant.

N Address is not vacant.blank Address was not looked up

AP.DSF_Tback 1 Throwback indicator.Y Customer with street address wants delivery

at PO Box instead.N No throwback necessary.blank Address was not looked up.

AP.DSF_Season 1 Seasonal address indicator.Y Address is seasonally occupied.N Address is not seasonal.blank Address was not looked up.

AP.DSF_Busind 1 Residential/business indicator. You may use this information to lower your parcel-shippingcosts. (Some parcel delivery services charge more for delivery to residential addresses.)Y Business address.N Not a business address.blank Address was not looked up.

AP.DSF_Rectyp

1 Record type.B Business address.R Residential address.U Unknown. AP.DSF_Deltype is blank.blank No information available.

AP.DSF_Deltyp

1 Delivery type.1 Curb-side delivery.2 NDCBU (Neighborhood Delivery Centralized

Box Unit) delivery.3 Central delivery.4 Door-slot delivery.blank Address was not looked up.


results




AP.DSF_Dropin

1 Drop indicator.Y Delivery point serves multiple businesses or

families. For example, delivery point may be aCMRA (Commercial Mail Receiving Agency).

N Delivery address is not a CMRA.blank Address was not looked up.

AP.DSF_Dropct

3 Drop count. If AP.DSF_Dropin or APM.DSF_Dropin contains Y or AP.DPV_CMRA containsY, then this field contains a value from 000 to 999, indicating the number of businesses or fami-lies served by this delivery point.

AP.DSF_Edu

1 Educational indicator.Y Address is an educational institution.N Address is not an educational institution.blank Address was not looked up.

AP.DSF_LACS

1 LACS (Locatable Address Conversion System) indicator.Y Address is LACS convertible.N Address is not LACS convertible.blank Address was not looked up.

AP.Walk_Seq 4 Walk Sequence number.Contains sequence number 0000-9999.If you perform NCOALinkand DSF2processing at the same time, the assigned sequence numberis based on the move-updated address if one exists. If no move-updated address exists, then theassigned sequence is based on the original address.

AP.DSF_Seqsrc 1 DSF sequence source.Indicates which address is the basis for the assigned walk sequence (AP.Walk_Seq).O Original address.M Move-updated address (available if youre performing NCOALinkprocessing also).


results



37/148


Other useful codes

ACE U.S. output fields: Other useful codes


AP.CASS_Match 1 Use this field to indicate which option was used to make the assignment.0 The Non-CASS and DPV tie break options are disabled or were not used to make an

assignment.1 Inexact ZIP move assignment.2 Input ZIP+4 assignment.3 DPV tie-breaking was used to make this assignment.blank ACE could not assign an input address.

AP.Congress 3 District number for the U.S. House of Representatives. May be blank for any of four reasons:

District numbers are available only when the address is fully assigned.

District numbers are assigned only in areas that have congressional representation; thisexcludes 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 notinclude names or addressesof representatives. Toobtain such information, contact your local or state government, or the local chapter of theLeague of Women Voters.

AP.County 3 FIPS county code. Numbers are unique within states. (FIPS stands for Federal InformationProcessing Standard.)

AP.CountyName 25 Fully spelled county name (for example, La Crosse instead of 63).

AP.FacType 1 Indicates a type of postal facility. For ordinary addressesexcept those specifically for apostal facilityyou will most often get a P, B, C, or N. This component is blank when theaddress is unassigned.

A Airport Mail Facility (AMF) K Network Distribution Center (NDC)

B Branch Office M Money Order Unit

C Community Post Office (CPO) N City place name, invalid for mailing

D Area Distribution Center (ADC) P Post Office (main)

E Sectional Center Facility (SCF) S Station

F Delivery Distribution U Urbanization (Puerto Rico only)

G General Mail Facility (GMF)



AP.FIPSCODE 5 Federal code for state and county. Uniquely identifies a county within the nation. Combines a2-digit state number with 3-digit county code.

Notes: When ACE makes a full assignment, the county fields are based on ZIP+4. When onlya 5-digit match is possible, county is based on ZIP. Usually it will be right, but may be wrongwhere 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 Pacificislands.

AP.Firm 20 to 60 Firm name from ZIP+4 directory, if matched; or if not matched, then the Firm data from theinput record (if the discrete Firm field was input). Do not use this component if the input ismultiline. If you want to extract a discrete firm field from a multiline address block, useDataRight or the TrueName Library.

AP.Newline 1 or 2 CRLFon DOSand Windows, LFon UNIX. For posting to ASCIIoutput files as an end-of-recordmark. The output field should be named EOR.

AP.Qss_Dflt 1 Indicates whether the record qualified as a default match rather than qualifying as a match athigher level of assignment.

AP.RDI 1 The residential delivery indicator (RDI) that tells if the address is residential ornonresidential.

Y Residential address

N Nonresidential address

RDI is an add-on feature.



01 Alabama 17 Illinois 30 Montana 44 Rhode Island

02 Alaska 18 Indiana 31Nebraska 45 South Carolina

04 Arizona 19 Iowa 32Nevada 46 South Dakota

05 Arkansas 20 Kansas 33New Hampshire 47 Tennessee

06 California 21 Kentucky 34New Jersey 48 Texas

08 Colorado 22 Louisiana 35New Mexico 49 Utah

09 Connecticut 23 Maine 36New York 50 Vermont

10 Delaware 24 Maryland 37North Carolina 51 Virginia

11 Dist. Of Colum-bia25 Massachusetts 38North Dakota 53 Washington

12 Florida 26 Michigan 39 Ohio 54 West Virginia

13 Georgia 27 Minnesota 40 Oklahoma 55 Wisconsin

15 Hawaii 28 Mississippi 41 Oregon 56 Wyoming

16 Idaho 29 Missouri 42 Pennsylvania blank territories,possessions, and pro-tectorates


39/148


Geocensus codes The Geocensus codes are listed by option.

AP.Rec_No_Out up to 10 The record number of a record as it is written to an outputfile. You may post it to an outputfile or to an Error Report in the Custom format. Note:If you create a Standardization Report ina Custom format, do not post this component. An output record number means nothing on aStandardization Report, because that report ignores your output file setup.

AP.Record_No up to 10 The record number of a record as it was read from the inputfile. It is a true record number andis not affected by your job setup, input filter, and so on You may post it to output files, to giveyourself an audit trail between input and output records. Or you may use it when preparing anError or Standardization report in the Custom format.



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.123456Longitude (degrees east of the Greenwich Meridian) in the format:+12.123456

AP.Ageo_Lng 11 In North America, latitudes are positive and longitudes are negative. Forexample, the White House is located at Latitude = 38.898556, Longitude =-077.037852 (about 39 north, 77 west).

AP.Ageo_Sta 2 FIPS state code.

AP.Ageo_Cty 3 FIPS county code.

AP.Ageo_Pla 5 FIPS place code. A number assigned by the U.S. government to each

incorporated municipality (city, village, town, etc.).

AP.Ageo_Blk 10 U.S. Census tract and Block Numbering Area (BNA).

AP.Ageo_MCD 6 U.S. Census Bureau minor civil division (MCD) data or, if MCD data isunavailable, census county division (CCD) data.

Centroid AP.Cgeo_CBSA 5 A Core-Based Statistical Area (CBSA) consists of:

A county with an incorporated place or a census-designated place

that has a population of at least 10,000.

Adjacent counties with at least 25 percent of employed residents of

the county who work in the CBSAs core or central county.

CBSAs are either metropolitan (population of at least 50,000) or mic-

ropolitan (population between 10,000 and 50,000). With CBSAs, youcan collect statistics for less urban areas of the country. CBSAs cover

approximately 90 percent of the entire U.S. population.



AP.Cgeo_Lat 10 Latitude (degrees north of the Equator) in the format: +12.123456Longitude (degrees east of the Greenwich Meridian) in the format:+12.123456

AP.Cgeo_Lng 11 In North America, latitudes are positive and longitudes are negative. Forexample, the White House is located at Latitude = 38.898556, Longitude =-077.037852 (about 39 north, 77 west).

AP.Cgeo_Msa 4 Metropolitan Statistical Area (MSA) number. 0000indicates the addressdoes not lie in any MSA; usually a rural area.

AP.Cgeo_Blk 10 U.S. Census tract and block-group number. The first 6 digits are the tractnumber, and the first of the final four digits are the block-group numberwithin the tract.These codes are used for matching to demographic-coding databases.To uniquely specify a census block-group within the whole country, com-

bine the FIPSCODE and GEO_BLK fields. The FIPSCODE field is not part ofthe GeoCensus option.

Centroid AP.Cgeo_Match Match code indicating the precision of the centroid latitude and longi-tude assignment.The lower the number, the more precise the assign-ment.

1 9-digit match in Centroid.4 7-digit match in Centroid.

5 5-digit match in Centroid.7 No match in Centroid.blank Not tried.

Both Address-Level andCentroid

AP.Geo_Match 1 Match code indicating the precision of the latitude and longitude assign-ment. 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.

ACE U.S. output fields: Geocensus codes

Option Field name Length Description


41/148


Mover ID componentsfor NCOALink

Audit components The fields listed below are for use only during NCOALinkaudit testing. The USPS

requires them and dictates their content and length.

ACE U.S. output fields: Mover ID components

for NCOALink Audit components


AP.Aud_Pname up to 28 This is the primary name that was sent to NCOALinkfor matching. This field is required foraudits.

AP.Aud_Range up to 10 This is the range that was sent to NCOALinkfor matching. This field is required for audits.

AP.Aud_Srange up to 10 This is the secondary range that was sent to NCOALinkfor matching. This field is requiredfor audits.

AP.Aud_Unit up to 8 This is the unit data that was sent to NCOALinkfor matching. This field is required foraudits.

APM.Aud_Fields 700 This field contains information for Stage I and Stage II tests, specifically query data,

result data, and hint bytes, as the USPS requires. Use this field for audit purposes only.

This field is required for audits.

For more information about the content of this field, see the NCOALink User Technical Ref-erence at http://ribbs.usps.gov/.This field can also contain ANKLink(Attempted Not Known) return codes.

APM.Aud_Mid 2 This field contains the truncated middle name, as stored in the NCOALinkdata. Use thisfield for audit purposes only. This field is required for audits.

APM.Aud_Pname up to 28 This is the primary name according to the NCOALinkmove record. This field is required foraudits.

APM.Aud_Range up to 10 This is the range data according to the NCOALink

move record. This field is required foraudits.

APM.Aud_Srange up to 10 This is the secondary range according to the NCOALinkmove record. This field is requiredfor audits.

APM.Aud_Unit up to 8 This is the unit data according to the NCOALinkmove record. This field is required foraudits.

APM.Drop 1 This field is used for audit testing.This field is also populated when an ANKLinkmatch is made.

APM.Drop_N 1 This field is used for audit testing.This field is also populated when an ANKLinkmatch is made.

APM.Firm 60 If the change of address was made based on a firm (company) name, that firm name will beposted in this field.This field is also populated when an ANKLinkmatch is made.

APM.Gender 1 This field is used for audit testing.This field is also populated when an ANKLinkmatch is made.

APM.Hint_byte 8 This field is used for audit testing.
http://ribbs.usps.gov/http://ribbs.usps.gov/



APM.Int_Codes 185 IntCodes stands for intermediate codes. These codes provide information that the USPSrequires when youre performing NCOALinkcertification or audit testing. This informationgoes into the Test Client Output File. See yourMover ID Users Guidefor details

APM.Pre_NameAPM.First_NameAPM.Mid_NameAPM.Last_NameAPM.Post_Name

61515206

These fields contain the name data used to make an NCOALinkmatch.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 firmdata.These fields are also populated when an ANKLinkmatch is made.

ACE U.S. output fields: Mover ID components

for NCOALink Audit components



43/148


NCOALinkdata The output components listed below contain data exactly as it appears in the

NCOALinkdirectories.

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

NCOALink data


Address-line components

APM.Address up to 60 Complete standardized primary and secondary address line (for example, 100 Main St Apt 10).This component will contain the USPS street abbreviation if that option is enabled.

APM.Postdir 2 Abbreviated postdirectional (N, NE, E, SE, S, SW, W, NW). Long form not available.

APM.Predir 2 Abbreviated predirectional (N, NE, E, SE, S, SW, W, NW). Long form not available.

APM.Prim_Addr up to 60 Complete, standardized, primary address line (for example, 100 Main St).This component will contain the USPS street abbreviation if that option is enabled.

APM.Prim_Name up to 28 Standardized primary name (most often street name). Caution: When the true street name

includes a directional word (for example, North Ridge) this field may give you an incompletestreet name (Ridge) because of USPS base-data patterns.

APM.Prim_Range up to 10 Primary range (house number, such as 1000 for the address 1000 Vine Street).

APM.Sec_Addr up to 60 Complete secondary address (for example, Apt 10, Ste 500, Box 34, Rm 7, 5thFlr).

APM.Sec_Range up to 8 Secondary range (apt. or suite number only, does not include designator).

APM.Suffix 4 Abbreviated suffix (St, Ave, Blvd, Rd, and so on). Long form not available.

APM.Unit_Desig up to 10 Unit designator (#, Apt, Ste, and so on).

12feb quickref views en

Documents