CODE-1 Plus Working With Guide - Support

CODE-1 Plus Working With Guide - Support
CODE-1 Plus™
Release 4.0.0 - March 2015
Working with CODE-1 Plus™ Guide
for IBM i
© 2015 Pitney Bowes Software, Inc. All rights reserved. MapInfo, and Group 1 Software are trademarks of Pitney Bowes Software
Inc. All other marks and trademarks are property of their respective holders.
Pitney Bowes Inc. holds a non-exclusive license to publish and sell ZIP + 4® databases on optical and magnetic media. The
following trademarks are owned by the United States Postal Service: CASS, CASS Certified, DPV, eLOT, FASTforward, First-Class
Mail, Intelligent Mail, LACSLink, NCOALink, PAVE, PLANET Code, Postal Service, POSTNET, Post Office, RDI, SuiteLink, United
States Postal Service, Standard Mail, United States Post Office, USPS, ZIP Code, and ZIP + 4. This list is not exhaustive of the
trademarks belonging to the Postal Service.
Pitney Bowes Inc. is a non-exclusive licensee of USPS® for NCOALink® processing.
Prices for Pitney Bowes Software Inc. products, options and services are not established, controlled or approved by the USPS®
or United States Government. When utilizing RDI™ data to determine parcel-shipping costs, the business decision on which
parcel delivery company to use is not made by the USPS® or United States Government.
Pitney Bowes Inc.
Documentation Team
[email protected]
One Global View
Troy, New York 12180
www.pb.com/software
www.g1.com/support
[email protected]
Support: +1 (800) 367-6950
TABLE OF CONTENTS
CHAPTER 1. PARAMETER REFERENCE
ADDRDF Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AE OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AM OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AM2OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AP OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Example of Storing Additional Input Data/Unmatched
Data - Fixed Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Example of Storing Additional Input Data/Unmatched
Data - Concatenated Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AUXIL1 Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BYPEXP Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CASSA1 Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CASSA4 Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CASSA7 Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CHCKPT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MVS Checkpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONFIG Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONFRM Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONTRL Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CR OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CS OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CS ZIP Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DPVIN Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DPVOUT Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working With CODE-1 Plus
13
13
16
17
20
20
27
27
30
31
36
37
38
38
39
39
40
40
42
42
43
43
44
44
45
46
47
53
54
56
56
57
57
60
61
65
65
69
71
75
75
3
EXITOP Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
FILEDF Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
File Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Limiting Processing With FILEDF . . . . . . . . . . . . . . . . . . . . . . . . . 85
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
FIRMNM Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
G9 OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
G9XOUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
G9ZIP9 Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
HEADER Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
LACS Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
L CODE Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
LISTID Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
LISTNM Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
LOTOUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
MAILER Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
MOVE I Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
MOVE O Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
NTHSEL Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Field-by-Field. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Performing Cross-Sectional Sampling . . . . . . . . . . . . . . . . . . . . 113
Including/Excluding Nth Records . . . . . . . . . . . . . . . . . . . . . . . . 114
PAGESZ Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
PGMNAM Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
REPORT Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
SA OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
SA2OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
SEQCHK Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
4
Software Release 4.0.0/March 2015
STELNK Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TESTIT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UFTxx Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UHDxx Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Z4 OUT Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Z5 OUT Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
135
135
138
138
139
139
140
140
141
141
145
146
CHAPTER 2. INTERACTIVE SCREEN REFERENCE
The Command Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Concatenated Commands. . . . . . . . . . . . . . . . . . . . . . . . . .
Screens that Support Address Matching . . . . . . . . . . . . . . . . . . . . . .
Address Match Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delivery Sequence Footnotes Screen. . . . . . . . . . . . . . . . . . . . . .
Miscellaneous Information/Base Address Screen . . . . . . . . . . .
Expanded Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Geographic Coding Information . . . . . . . . . . . . . . . . . . . . . . . . . .
Match Settings Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multiple Elements Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parsed Elements Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Return Codes Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Statistics Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Address Stack Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screens that Support Database Inquiry . . . . . . . . . . . . . . . . . . . . . . .
Apartments at a House Range . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cities in a State Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cities in a ZIP Code Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
City Information Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Firms in a House Range Screen . . . . . . . . . . . . . . . . . . . . . . . . . .
Houses on a Street Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Streets in a City or Streets in a ZIP Code Screen . . . . . . . . . . . .
Geographic Coding Plus Interface . . . . . . . . . . . . . . . . . . . . . . . .
Screens that Support Site Customization . . . . . . . . . . . . . . . . . . . . .
Administration Sign-on Screen. . . . . . . . . . . . . . . . . . . . . . . . . . .
Interactive Customization Screens . . . . . . . . . . . . . . . . . . . . . . . .
Database Information Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customization File Administration . . . . . . . . . . . . . . . . . . . . . . . . . . .
File Backup and Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
File Repair, Re-Initialization, and Password Display . . . . . . . . .
Batch Uncoded Records Interface (G1CPBNC) . . . . . . . . . . . . . . . . .
How it Works. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UR COMMAND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UW COMMAND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
151
156
156
157
159
162
165
165
166
168
171
174
177
184
188
192
192
194
197
199
201
203
206
208
214
214
215
223
224
225
225
226
226
227
228
Working With CODE-1 Plus
5
Program Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Description of Supplied Sample G1CPBNC . . . . . . . . . . . . . . . . . 230
6
CHAPTER 3. USING THE Z4CHANGE OPTION
What is the Z4CHANGE Option? . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The Z4CHANGE Option Database . . . . . . . . . . . . . . . . . . . . . . . . .
Rules for Using the Z4CHANGE Option . . . . . . . . . . . . . . . . . . . .
Activating the Z4CHANGE Option, C1P430 . . . . . . . . . . . . . . . . . .
Using Z4CHANGE Option Processing . . . . . . . . . . . . . . . . . . . . . . . . .
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling C1P430 From Your Own Driver. . . . . . . . . . . . . . . . . . . . . . . .
234
234
234
235
235
235
237
CHAPTER 4. LINE OF TRAVEL (LTO10)
What is Line of Travel? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Why Use Line of Travel?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Accessing Line of Travel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Getting Started with Line of Travel . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sorting Your LOT Coded Records . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling the LTO10 Subroutine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Area — Parameter 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Area — Parameter 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COBOL Calling Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The Line of Travel Exit Routine (LTO60) . . . . . . . . . . . . . . . . . . . . . . .
EXITOP Parameter for the LTO60 Exit Routine . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Control Totals Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
242
242
243
243
243
244
245
246
248
248
249
250
253
CHAPTER 5. USING DELIVERY POINT VALIDATION
What is Delivery Point Validation?. . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multiple Matches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Getting Started with Delivery Point Validation . . . . . . . . . . . . . . . . . .
Installing the DPV Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delivery Point Validation and Seed Records . . . . . . . . . . . . . . . .
Residential Delivery File Processing . . . . . . . . . . . . . . . . . . . . . . . . .
What is Residential Delivery File Processing? . . . . . . . . . . . . . .
Building the Residential Delivery File in CODE-1 Plus . . . . . . . . . . .
C1DBRDI Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Importing the RDI Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Activating the RDI Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RDI Large Memory Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The DPV Parameters and Return Codes . . . . . . . . . . . . . . . . . . . . . .
DPVIN Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DPVOUT Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Expiration of DPV Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Open/Read Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
“Seed Records” and Stop DPV Processing . . . . . . . . . . . . . . . . .
Software Incompatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
256
256
258
258
259
265
265
265
266
267
268
268
268
268
269
270
270
270
271
271
Software Release 4.0.0/March 2015
DPV by List Code Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DPV Processing Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . .
Residential Delivery File Build Report . . . . . . . . . . . . . . . . . . . . . . . .
Residential Delivery File Build Execution Log . . . . . . . . . . . . . . . . . .
272
272
273
273
CHAPTER 6. AUXILIARY FILE PROCESSING
What is the Early Warning System? . . . . . . . . . . . . . . . . . . . . . . . . . .
Auxiliary File Processing and EWS . . . . . . . . . . . . . . . . . . . . . . . .
Building the Auxiliary File with the Early Warning System . . . . . . .
C1AUXBLD Utility Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AUXIL Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Activating the Auxiliary File/EWS File Option. . . . . . . . . . . . . . . . . . .
EWS With C1BM00 (submitting through screens) . . . . . . . . . . . .
EWS When Calling C1MATCHx or C1BMCBD. . . . . . . . . . . . . . . .
Auxiliary File Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Auxiliary File Build (C1AUXBLD) Reports. . . . . . . . . . . . . . . . . . .
Auxiliary File Build Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Auxiliary File Build Execution Log . . . . . . . . . . . . . . . . . . . . . . . . . . .
Auxiliary File Reporting in the CODE-1 Plus Matcher. . . . . . . . . . . .
276
276
277
277
279
279
280
281
281
281
282
282
282
283
283
CHAPTER 7. USING G1G001
What is G1G001? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using G1G001 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input File and Header/Footer Parameters. . . . . . . . . . . . . . . . . . . . .
FILEDF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HEADER. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HEADxx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UFTxx. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UHDxx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Report Layout and Content Parameters. . . . . . . . . . . . . . . . . . . . . . .
CONTRL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONSTANT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FORMAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MOVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGESZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TESTIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UNPK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Record Selection Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SELECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CHANGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sample Control Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
286
286
286
287
288
289
290
291
292
292
295
295
298
299
300
301
302
302
303
303
CHAPTER 8. CALLING CODE-1 PLUS MATCHING AND
ANALYZER MODULES
CODE-1 Plus Matching Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is C1MATCHx?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is C1ANZADR?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is C1BMCBD? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
306
306
307
307
Working With CODE-1 Plus
7
8
What is EXTADDR2? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is G1CP? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is G1CP1? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Call Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the COBOL Stub Program (Optional) . . . . . . . . . . . . . . . . . . . .
Selecting the COBOL Stub Program. . . . . . . . . . . . . . . . . . . . . . .
Calling C1MATCHx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Casing Your Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Format of Cased Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Special Casing Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COBOL Call to Batch Version of C1MATCHx . . . . . . . . . . . . . . . .
The Input Call Area (P9IN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The Output Results Call Area (P9OUT) . . . . . . . . . . . . . . . . . . . . .
The Output Audit Call Area (P9AUDIT) . . . . . . . . . . . . . . . . . . . . .
Unmatched Data Call Area (P9INTRF) . . . . . . . . . . . . . . . . . . . . .
Calling C1ANZADR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ANALYSIS-PARAMETERS Call Area . . . . . . . . . . . . . . . . . . . . . . .
ANALYSIS-NORMALIZATION Call Area . . . . . . . . . . . . . . . . . . . .
Calling C1BMCBD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling the Address Line Extraction Module (EXTADDR2) . . . . . . . .
Calling EXTADDR2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Supplied Copybooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling G1CP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling G1CP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
307
307
307
308
308
309
309
310
310
310
311
312
320
349
350
351
351
352
355
357
357
358
361
361
CHAPTER 9. CALLING C1PRPT, C1CTYLKP, OR G1CPLKX
What is C1PRPT? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling C1PRPT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The C1PRPT Call Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is C1CTYLKP? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ZIP Code Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
City and State Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ZIP Code and City/State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling C1CTYLKP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The C1CTYLKP Call Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is G1CPLKB? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling G1CPLKC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G1CPLK-USER-REQUEST-AREA . . . . . . . . . . . . . . . . . . . . . . . . .
G1CPLK-USER-RESULT-AREA . . . . . . . . . . . . . . . . . . . . . . . . . . .
G1CPLK-IPC-AREAS-LENGTH . . . . . . . . . . . . . . . . . . . . . . . . . . .
364
365
367
377
377
378
378
378
379
379
383
384
384
388
390
CHAPTER 10. USING LACSLINK
What is LACSLink? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What are the Benefits of LACSLink?. . . . . . . . . . . . . . . . . . . . . . .
Who is Eligible to Use LACSLink?. . . . . . . . . . . . . . . . . . . . . . . . .
How Does LACSLink Work?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the LACSLink Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How do I Install the LACSLink Option? . . . . . . . . . . . . . . . . . . . . .
392
392
393
393
394
394
Software Release 4.0.0/March 2015
Installing the LACS Database . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How Do I Activate LACSLink? . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LACSLink Processing Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LACSLink Information on USPS Form 3553. . . . . . . . . . . . . . . . .
Seed Record Violations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What If My Mailing Generates a Seed Violation? . . . . . . . . . . . . .
395
395
397
401
403
403
403
404
CHAPTER 11. USING SUITELINK
What is SuiteLink? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What are the Benefits of SuiteLink? . . . . . . . . . . . . . . . . . . . . . . .
Who is Eligible to Use SuiteLink? . . . . . . . . . . . . . . . . . . . . . . . . .
How Does SuiteLink Work? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the SuiteLink Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How do I Install the SuiteLink Option? . . . . . . . . . . . . . . . . . . . . .
How do I Install the SuiteLink Database?. . . . . . . . . . . . . . . . . . .
How Do I Activate SuiteLink?. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DD Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SuiteLink Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input and Output Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SuiteLink Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
408
408
409
409
410
410
411
412
413
417
417
418
418
INDEX
Working With CODE-1 Plus
9
10
Software Release 4.0.0/March 2015
CHAPTER 1
Parameter Reference
This chapter is a comprehensive technical reference for each parameter. For each
parameter, we include the function, a picture, a table of all of the fields and possible
values, and an example.
NOTE: For any of the parameters that specify file positions and lengths, you can use
the open position to the left of the range indicated, if you have records which are
more than 999 bytes or field lengths that are greater than 99 bytes.
Pitney Bowes may require up to 80 bytes for the definition of our products
parameter records. If sequence numbers are posted in positions 73-80 of the
defined parameter records, then abnormal terminations may result when processing.
ADDRDF Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AE OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AM OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AM2OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AP OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AUXIL1 Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BYPEXP Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CASSA1 Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CASSA4 Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CASSA7 Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CHCKPT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONFIG Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONFRM Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONTRL Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CR OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CS OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CS ZIP Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working With CODE-1 Plus
13
16
20
27
30
38
39
40
42
43
44
46
53
56
57
60
65
11
1
Parameter Reference
DPVIN Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
DPVOUT Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
EXITOP Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
FILEDF Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
FIRMNM Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
G9 OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
G9XOUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
G9ZIP9 Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
HEADER Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
LACS Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
L CODE Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
LISTID Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
LISTNM Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
LOTOUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
MAILER Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
MOVE I Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
MOVE O Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
NTHSEL Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
PAGESZ Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
PGMNAM Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
REPORT Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
SA OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
SA2OUT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
SEQCHK Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
STELNK Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
TESTIT Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
UFTxx Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
UHDxx Parameter Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Z4 OUT Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Z5 OUT Parameter Record. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
12
Software Release 4.0.0/March 2015
ADDRDF Parameter Record
1
ADDRDF Parameter Record
The required ADDRDF parameter is used to define the location, length, and format
of the addresses in the input record.
In this context, the term “field” means any continuous series of characters in the
input file. You can define a field to start at any position in the input file, and extend
fields for any length you choose. For example, you could specify that positions 100140 in the input file make up one field.
A line is also a continuous series of characters in the input file. The difference is that
CODE-1 Plus assumes that a line contains all of the information that would appear
on one line of an address label.
NOTE: If you specify that your input address is in lines, you should define the lines
in the order in which the USPS would like them to appear on a mailing label. In
other words, the first line (left-most) is the least significant, and the last line (rightmost) is the most significant.
CODE-1 Plus will treat the last line you define (that actually contains data) as the
primary address line unless you include the formatted City/State/ZIP Code in the
last line.
The length of an address cannot exceed 99 bytes.
Field-by-Field
Table 1: Fields on the ADDRDF Parameter (Part 1 of 3)
Position
Field Name
Description
Comments
1-6
KEYWORD
ADDRDF is the only acceptable entry.
Required.
8
ADDRESS FORMAT
Enter one of the following codes to
describe the format of the street address
information in the input record:
Required.
No Default.
M
A single line
L
2, 3, 4, 5, or 6 lines (with or
without city, state, and ZIP Code)
F
2, 3, 4, 5, or 6 fields.
10-12
Location of
ADDRESS 1
Location of the first field or line.
Required.
No default.
14-15
Length of
ADDRESS 1
Length of the first field or line.
Required.
No default.
Working With CODE-1 Plus
13
1
Parameter Reference
Table 1: Fields on the ADDRDF Parameter (Part 2 of 3)
Position
Description
Comments
17-19
Location of
ADDRESS 2
Location of the second field or line.
Optional.
No default.
21-22
Length of
ADDRESS 2
Length of the second field or line.
Optional.
No default.
24-26
Location of
ADDRESS 3
Location of the third field or line.
Optional.
No default.
28-29
Length of
ADDRESS 3
Length of the third field or line.
Optional.
No default.
31-33
Location of
ADDRESS 4
Location of the fourth field or line.
Optional.
No default.
35-36
Length of
ADDRESS 4
Length of the fourth field or line.
Optional.
No default.
38-40
Location of
ADDRESS 5
Location of the fifth field or line.
Optional.
No default.
42-43
Length of
ADDRESS 5
Length of the fifth field or line.
Optional.
No default.
45-47
Location of
ADDRESS 6
Location of the sixth field or line.
Optional.
No default.
49-50
Length of
ADDRESS 6
Length of the sixth field or line.
Optional.
No default.
52-54
Location of
INPUT
URBANIZATION
NAME
Location of the urbanization name in the
input record.
Optional.
No default.
Length of
INPUT
URBANIZATION
NAME
Length of the urbanization name in the
input record.
Location for
EXTRACTED
URBANIZATION
NAME
Storage location for the extracted (input)
urbanization name in the output record.
56-57
59-61
14
Field Name
NOTE: If the urbanization name can be
found among the address lines, enter a U
in position 52. If you enter a U, CODE-1
Plus attempts to locate the name in the
locations you have already identified for
the address.
Optional.
No default.
NOTE: If you put a U in position 52, do not
enter a value in this field.
Optional.
No default.
Software Release 4.0.0/March 2015
ADDRDF Parameter Record
1
Table 1: Fields on the ADDRDF Parameter (Part 3 of 3)
Position
Field Name
Description
Comments
63-64
Length of
EXTRACTED
URBANIZATION
NAME
Length of the extracted (input)
urbanization name in the output record.
Optional.
No default.
65
LEFT JUSTIFY
Code indicating whether to left justify:
Optional.
Default is
blank.
• Contents of the primary and
secondary address lines
• Firm name (if assigned)
• Urbanization name (if assigned)
Enter one of the following codes:
Working With CODE-1 Plus
L
Left justify all fields listed above.
Blank
Do not left justify the fields listed
above.
15
1
Parameter Reference
AE OUT Parameter Record
The optional AE OUT parameter tells CODE-1 Plus where on the output file to store
the individual address elements.
Notice that you must specify a length for the street name element and the Private
Mailbox Number only. Each of the other elements have predetermined lengths. The
following figure shows the different address elements.
4235
House
Number
RR
Rural Route/
Highway
Route Type
PMB
Private
Mailbox
Designator
N
MAIN
Leading
Directional
123
Street
Name
BOX
Rural Route/
Highway
Contract
Number
ST
Suffix
NW
Trailing
Directional
STE
Apartment
Designator
100
Apartment
Number
19
Rural/Route Highway
Contract or PO Box
Number
456
Private
Mailbox
Number
NOTE: These elements are stored from the base street name, not the alias, if you
have specified Y in column 51 of the SA OUT parameter.
16
Software Release 4.0.0/March 2015
AE OUT Parameter Record
1
Field-by-Field
Table 2: AE OUT Parameter Fields (Part 1 of 2)
Position
Field Name
Description
Comments
1-6
KEYWORD
AE OUT is the only acceptable entry.
Required.
8-10
Location for
HOUSE NUMBER
Location on the output record for the
left-justified 10-character house number.
Optional.
No default.
12-14
Location for
LEADING
DIRECTIONAL
Location on the output record for the
left-justified 2-character leading directional.
Optional.
No default.
16-18
Location for
STREET NAME
Location on the output record for the
left-justified street name.
Optional.
No default.
20-21
Length of
STREET NAME
Length of the street name on the output
record (the maximum is 40).
Optional.
No default.
23-25
Location for
SUFFIX
Location on the output record for the
left-justified 4-character street suffix.
Optional.
No default.
27-29
Location for
TRAILING
DIRECTIONAL
Location on the output record for the
left-justified 2-character trailing directional.
Optional.
No default.
31-33
Location for
APARTMENT
DESIGNATOR
Location on the output record for the
left-justified 4-character apartment
designator.
Optional.
No default.
35-37
Location for
APARTMENT
NUMBER
Location on the output record for the
left-justified 8-character apartment number.
Optional.
No default.
39-41
Location for
RURAL ROUTE/
HIGHWAY
CONTRACT
ROUTE TYPE
Location on the output record for the
2-character rural route/highway contract
route type code.
Optional.
No default.
43-45
Location for
RURAL ROUTE/
HIGHWAY
CONTRACT
NUMBER
Location on the output record for the
left-justified 3-character rural route/highway
contract route number.
Optional.
No default.
47-49
Location for
BOX NUMBER
Location on the output record for the
left-justified 10-character box number.
Optional.
No default.
Working With CODE-1 Plus
17
1
Parameter Reference
Table 2: AE OUT Parameter Fields (Part 2 of 2)
Position
51
53-55
Field Name
DISPOSITION
INDICATOR
Location for
PRIVATE
MAILBOX
DESIGNATOR
Description
Comments
Code indicating what should be stored in
cases where standardized elements could not
be stored (because no match was found).
Enter one of the following codes:
B
Store blanks.
M
Store elements from normalized
address merging secondary address
line elements with primary address
line elements. In cases where an
element appears in both the primary
and secondary address lines, use the
element from the primary address
line.
N
Store elements from normalized
address using the primary address
line only.
X
Store nothing.
Location on the output record for the
left-justified 4-character Private Mailbox
Designator.
PMB
Standard Private Mailbox Designator
#
Nonstandard Private Mailbox
Designator
Optional.
Default is B.
Optional.
No default.
NOTE: In order to have a designator in your
output record, you must specify a length and
location for your Private Mailbox Number in
positions 57-59 and 61-62.
57-59
Location for
PRIVATE
MAILBOX
NUMBER
Location on the output record for the Private
Mailbox Number.
Required if
location
information
exists in
positions
53-55.
No default.
61-62
Length of
PRIVATE
MAILBOX
NUMBER
Length of the Private Mailbox Number on the
output record (the maximum is 16
characters).
Required if
data exists in
positions
57-59.
No default.
64
PRIVATE
MAILBOX
DESIGNATOR/
NUMBER
STORAGE OPTION
Enter one of the following codes:
Optional.
Default is
blank.
X
Store all Private Mailbox Designator/
Numbers
Blank
Store only Standard Private Mailbox
Designator/Numbers
NOTE: If X is chosen, a non-CASS certified
configuration will be created. No PS Form
3553 will be generated.
18
Software Release 4.0.0/March 2015
AE OUT Parameter Record
1
NOTE: CODE-1 Plus only produces a standardized address if an SA OUT
parameter is used to store a standardized address. If you request elements of the
standardized address on the AE OUT parameter, you must also define an SA OUT
parameter.
Working With CODE-1 Plus
19
1
Parameter Reference
AM OUT Parameter Record
The optional AM OUT parameter tells CODE-1 Plus where to store the various return
codes on the output record.
These address matching return codes tell you what resulted when CODE-1 Plus
attempted to match the records against the information in the CODE-1 Plus
database. These codes are very useful when you are analyzing the results you received
from CODE-1 Plus.
If you do not specify a location for any return code listed above, CODE-1 Plus will not
store that return code on the output record.
Delivery Sequence File (DSF2) footnotes are 2-character, USPS-defined codes that
represent the changes that were made to the input address during the matching
process. Up to 50 of these codes can be stored by CODE-1 Plus for each record,
resulting in a 100-character output field. After CODE-1 Plus finishes processing, you
can run your output file through a delivery sequence program (not provided by
Pitney Bowes) to sort your records into delivery sequence. The delivery sequence
program will look at these footnotes when sorting the records.
Field-by-Field
Table 3: AM OUT Parameter Fields (Part 1 of 7)
Position
Field Name
Description
Comments
1-6
KEYWORD
AM OUT is the only acceptable entry.
Required.
8-10
Location for
USPS RECORD
TYPE CODE
Location on the output record for the
1-character record type code. One of the
following codes is stored:
Optional.
No default.
Blank
No match found.
F
Firm
G
General delivery
H
High rise (apartment complex)
P
Post office box
R
Rural route or highway contract
S
Normal street address
NOTE: CODE-1 Plus will not produce the
USPS 3553 form if the USPS Record Type
Code is posted.
20
Software Release 4.0.0/March 2015
AM OUT Parameter Record
1
Table 3: AM OUT Parameter Fields (Part 2 of 7)
Position
12-14
Field Name
Location for
GENERAL
RETURN CODE
Description
Location on the output record for the
1-character general return code. One of the
following codes is stored.
Blank
Successful address match attempt.
A
Apartment number missing or not
found in database, and an apartmentlevel match was required.
B
Insufficient (or blank) address
information.
Comments
Optional.
No default.
NOTE: When CODE-1 Plus
determines address information is
insufficient (or blank) and returns a
“B” for a specific address record, the
record is skipped.
16-18
Working With CODE-1 Plus
Location for
DIRECTIONAL
RETURN CODE
E
External match—auxiliary file
processing.
H
House/box number not found on
street.
M
Multiple matches were found.
S
Street name not found in ZIP Code.
X
The CODE-1 Plus Master File has
expired.
Z
ZIP Code not found in database.
Location on the output record for the
1-character directional return code. One of
the following codes is stored:
Blank
The directional match was
successful, or no address match was
found.
N
No directional was found on the input
address, but a directional was
present on the database.
F
The directional was correct, but was
in the wrong location (e.g., trailing
directional should have been leading
directional).
D
The directional does not match the
database.
L
New address obtained from LACS
processing.
Optional.
No default.
21
1
Parameter Reference
Table 3: AM OUT Parameter Fields (Part 3 of 7)
Position
20-22
24-26
28-30
22
Field Name
Location for
SUFFIX
RETURN CODE
Location for
APARTMENT
RETURN CODE
Location for
FIRM NAME
RETURN CODE
Description
Comments
Location on the output record for the
1-character suffix return code. One of the
following codes is stored:
Blank
The suffix match was successful, or
no
address match was found.
L
New address obtained from LACS
processing.
N
No suffix was found on the input
address, but a suffix was present on
the database.
S
The suffix does not match the
database.
Location on the output record for the
1-character apartment return code. One of
the following codes is stored:
Blank
No address match was found, or the
apartment (or lack thereof) matches
the database.
L
New address obtained from LACS
processing.
N
No apartment was found on the input
address, but an apartment was
present on the database at the street
address.
A
The apartment does not match the
database.
F
Suite number appended due to a firm
name match.
Location on the output record for the
1-character firm name return code. One of
the following codes is stored:
Blank
No address match was found, or the
firm name match successful, or no
input firm name was found.
F
The input firm name does not match
the database.
L
New address obtained from LACS
processing.
M
A firm name was present in the input
record, but there were no firm names
on the database for the matched
address.
Optional.
No default.
Optional.
No default.
Optional.
No default.
Software Release 4.0.0/March 2015
AM OUT Parameter Record
1
Table 3: AM OUT Parameter Fields (Part 4 of 7)
Position
32-34
36-38
Field Name
Location for
OVERALL
PROBABLE
CORRECTNESS
CODE
Location for
ALTERNATE
ADDRESS
SCHEME
INDICATOR
Description
Location on the output record for the
1-character overall probability of
correctness. One of the following codes is
stored:
Blank
No match was found.
0
The match is exact.
1-8
The match has an intermediate
probability of correctness on a sliding
scale.
9
The match is least likely to be correct.
Location on the output record for the type of
alternate address scheme to use to obtain a
match. One of the following codes is stored:
Blank
No alternate address scheme used.
D
Delivery point alternate logic used.
E
Enhanced high rise alternate match
logic used.
L
New address obtained from LACS
processing.
U
Unique ZIP Code logic used.
Comments
Optional.
No default.
Optional.
No default.
40-42
Location for
STREET NAME
MATCH SCORE
A 1-digit score, on a scale of 0 - 9, reflecting
the closeness of the street-name match (after
transformations by the analyzer, if any),
where 0 indicates an exact match and 9
indicates the least likely match. If no match
was found, this field is blank.
Optional.
No default.
44-46
Location for
FIRM NAME
MATCH SCORE
Location on the output record for the
1-character firm name match score. This
number represents the number of “errors”
that were found when matching the firm name
to the database.
Optional.
No default.
48-50
Location for
ADDRESS
PROBABLE
CORRECTNESS
CODE
Location on the output record for the
1-character address probability of
correctness. One of the following codes is
stored:
Optional.
No default.
Working With CODE-1 Plus
Blank
No match was found.
0
The match is most likely to be
correct.
1-8
The match has an intermediate
probability of correctness on a sliding
scale.
9
The match is least likely to be correct.
L
New address obtained from LACS
processing.
23
1
Parameter Reference
Table 3: AM OUT Parameter Fields (Part 5 of 7)
Position
52-54
Field Name
Location for
DELIVERY
SEQUENCE
FILE
FOOTNOTES
Description
Comments
Location on the output record for up to 50
2-character delivery sequence footnotes. One
of the following codes is stored:
Optional.
No default.
• AA — The record matched the ZIP+4
database the CODE-1 Plus database.
• A1 — No match was found.
• A2 — The alias street name was matched to
a base street name on the database.
• A3 — A match was made to an alternate
record on the database.
• BB — The input address matched to DPV
(all components).
• CC — The input address primary number
matched to DPV but secondary number not
matched (present but invalid).
• D — City name or state was changed.
• E — Primary address was changed.
• F — Secondary address was changed.
• F1 — Input address matched to a military
ZIP Code.
• G1 — Input address matched to a General
Delivery Address.
• H — ZIP Code was changed.
• J — City, state, and ZIP Code could not be
validated.
• K — Multiple matches in primary address.
• K1 — Multiple matches due to missing or
incorrect directionals.
• K2 — Multiple matches due to missing or
incorrect suffix.
24
Software Release 4.0.0/March 2015
AM OUT Parameter Record
1
Table 3: AM OUT Parameter Fields (Part 6 of 7)
Position
Field Name
Location for
DELIVERY
SEQUENCE
FILE
FOOTNOTES,
continued
Description
Comments
• M1 — Missing street number.
• M2 — Address not found.
• M3 — No such primary number.
• M4 — Firm name not matched.
• N1 — Missing secondary address number.
• N2 — Secondary address number not
found on file.
• P1 — Missing rural route/highway contract
box number.
• P2 — Rural route/highway contract box
number not found on file.
• Q1 — Missing PO Box number.
• Q2 — PO Box number not found on file.
NOTE: Although there are currently only 25
footnote codes defined, CODE-1 Plus will use
the entire 100-character array, back-filling
with spaces as necessary.
56-58
Working With CODE-1 Plus
Location for
OUTPUT ZIP
CODE STATUS
Location on the output record for the
1-character code indicating the status of the
INPUT ZIP Code. One of the following codes is
stored:
A
Altered—the original ZIP Code was
altered via an address match.
B
Blank—a unique address match
could not be obtained; the original ZIP
Code was blank.
C
Confirmed—the input ZIP Code was
confirmed by an address match.
I
Invalid -- No match could be
obtained; the output ZIP code
contains blanks because the input ZIP
Code was invalid.
O
Original—a unique address match
could not be obtained; the original ZIP
Code was kept.
U
Blank—A unique address match
could not be obtained and there was
no correlation between the input
unique ZIP Code and the city/state.
The original ZIP Code was blanked.
Optional.
No default.
25
1
Parameter Reference
Table 3: AM OUT Parameter Fields (Part 7 of 7)
Position
60-62
26
Field Name
Location for
ALTERNATE/
BASE
INDICATOR
Description
Comments
Location on the output record for a
1-character code indicating whether the input
address matched a ZIP + 4 base record or a
ZIP + 4 alternate record. One of the following
codes is stored:
A
Input address matched an alternate
ZIP + 4 record.
B
Input address matched a base ZIP + 4
record.
Optional.
No default.
64-66
Location for
LAST LINE
NUMBER
Location on the output file for the USPS
6-character last line number from the output
ZIP + 4 Code.
Optional.
No default.
68-70
Location for
FINANCE
NUMBER
Location on the output file for the USPS
6-character finance number from the output
city.
Optional.
No default.
72-74
Location for
250 BYTES OF
ADDITIONAL
INFORMATION
FOR VERIMOVE
Location on the output file to attach 250 bytes
of additional information codes to your output
file. This parameter was designed for use with
the Pitney Bowes VeriMove move update
product.
Optional.
No default.
Software Release 4.0.0/March 2015
AM2OUT Parameter Record
1
AM2OUT Parameter Record
The optional AM2OUT parameter, a continuation of the AM OUT parameter, tells
CODE-1 Plus where to store the various return codes on the output record.
The USPS considers a match to a default record when the input address matches to a
high rise default record OR when the input address had the potential to match a
USPS high rise record, but is either missing an input secondary number or does not
match the USPS high rise records and no high rise default record exists in the
database. When this second circumstance occurs, the ZIP + 4 code is assigned
according to the USPS street record type. This is also reported as a high rise default
match.
Regarding rural route and military addresses with box numbers, the default is set
when the input box number does not match the box range on the USPS database.
Field-by-Field
Table 4: AM2OUT Parameter Fields (Part 1 of 3)
Position
Field Name
Description
Comments
1-6
KEYWORD
AM2OUT is the only acceptable entry.
Required.
8-10
Location for
HIGH RISE DEFAULT
Location on the output record for the High
Rise Default. One of the following codes is
stored:
Optional.
No default.
12-14
16-18
Working With CODE-1 Plus
Location for
RURAL ROUTE
DEFAULT
Location for
MILITARY DEFAULT
H
Record matched to a High Rise
Default record.
Blank
No match was made. Matched
record was not a default record.
Location on the output record for the
Rural Route Default. One of the following
codes is stored:
R
Record matched to a Rural Route
Default record.
Blank
No match was made. Matched
record was not a default record.
Location on the output record for the
Military Default. One of the following
codes is stored:
M
Record matched to a Military
Default record.
Blank
No match was made. Matched
record was not a default record
Optional.
No default.
Optional.
No default.
27
1
Parameter Reference
Table 4: AM2OUT Parameter Fields (Part 2 of 3)
Position
20-22
28-30
Field Name
Location for
UNIQUE ZIP CODECITY/STATE
CORRELATION
RETURN CODE
Location for
AUXILIARY FILE
NAME MATCH
Description
Location on the output record for the
Unique ZIP Code-City/State Correlation
Return Code. One of the following codes
is stored:
U
The original ZIP Code was unique
and did not correspond to the
input city/state.
Blank
Input ZIP Code was either not
unique or was unique and
corresponded to the input city/
state.
Location on the output record for the
Auxiliary File Name Match code. Only one
code option:
1
32-34
36-38
Location for
SECONDARY
COMPONENT
PROCESSING
INDICATOR
Location for
OVERRIDE CITY
NAME INDICATOR
Comments
Optional.
No default.
Optional.
Early Warning System (EWS)
File.
Location on the output record for the
Secondary Component Processing
Indicator:
Blank
No multiple secondary
component logic used.
E
Exact match.
S
Multiple Secondary Match logic
used.
Override City Name refers to the city
name for the Preferred Last Line Key
(PLL) from the USPS ZIP + 4 File. The
Default City Name refers to the city name
for the PPL Key on the USPS City/State
File.
Optional.
Optional.
The output location for the Override City
Name Indicator.
40-42
44-46
28
INPUT CITY TYPE
INDICATOR
MILITARY ADDRESS
INDICATOR
Blank
Default City Name stored.
O
Override City Name stored.
Indicator of Input city type:
P
Primary city
S
Secondary city
V
Vanity city.
Indicator of military address:
M
Optional.
Optional.
Indicates a military address.
Software Release 4.0.0/March 2015
AM2OUT Parameter Record
1
Table 4: AM2OUT Parameter Fields (Part 3 of 3)
Position
48-50
52-54
56-58
60-62
Working With CODE-1 Plus
Field Name
ESM INDICATOR
LACSLink RETURN
CODE
LACSLink INDICATOR
Location for Street
Default Flag
Description
Indicates that enhanced street matching
(ESM) or all street matching (ASM) was
performed for matching:
Blank
No ASM or ESM performed.
A
Matched using All Street
Matching (matched misspelled
first letter)
F
ASM performed but no match
found
M
Matched using ESM
P
ESM performed but no match
found.
Indicates the success of the LACSLink
process:
Blank
No LACS processing occurred.
A
LACS record match
00
No match
09
LACSLink was able to find the
input address on its internal
tables but for some reason did
not return the new (converted)
address.
14
Match found LACS record but
would not convert.
92
Match with secondary
information.
Indicates if a table was matched:
Blank
No LACS processing occurred.
F
LACS seed violation has occurred
N
No match occurred or a new
address would not convert at run
time.
S
Input address contained both
primary and secondary
information but match occurred
using only primary information
Y
Full match occurred.
The output location for the Street Default
flag:
Blank
Record matched is not a Street
Default record.
S
Record is matched to a Street
Default record.
Comments
Optional.
Optional.
Optional.
Optional.
No default.
29
1
Parameter Reference
AP OUT Parameter Record
The optional AP OUT parameter is used to tell CODE-1 Plus where, on the output
file, to store the information that was dropped during the analysis process, as well as
the normalized address lines. This parameter defines the following:
•
Format, location, and length of additional input data
•
Format, location, and length of extra data from the matcher (unmatched data)
•
Conditions under which to store the first normalized address line
•
Location and length of the first normalized address line
•
Conditions under which to store the second normalized address line
•
Location and length of the second normalized address line
•
Location and length of the “care of” information dropped from the parsed address
lines
•
Type of address normalization
Normalized address information is formatted to conform to USPS conventions.
Dropped address information is data that CODE-1 Plus ignored during the analysis
and matching process.
30
Software Release 4.0.0/March 2015
AP OUT Parameter Record
1
Field-by-Field
Table 5: AP OUT Parameter Fields (Part 1 of 5)
Position
Field Name
Description
Comments
1-6
KEYWORD
AP OUT is the only acceptable entry.
Required.
8
Format of EXTRA
DATA IN OUTPUT
RECORD
This field defines how two types of extra
data display in the output record.
Optional.
Default is F.
• Additional input data - Any information
that is defined on the input address
lines but is not sent to the matcher for
processing is identified as additional
input data.
• Unmatched data - Any information
passed to the matcher that is not used
in the matching process is identified as
unmatched data.
Enter one of the following codes:
• F - Fixed length format. Extra data will
be posted “as is” in eleven output
fields:
–
Six 100-byte length fields will
contain additional input data
(information that is defined on the
input address lines but is not sent
to the matcher for processing).
–
Five 100-byte length fields will
contain unmatched data
(information passed to the matcher
that was not used in the matching
process).
• C - Concatenated format.
Additional input data (information that
is defined on the input address lines
but is not sent to the matcher for
processing) is concatenated and
written into one field that:
–
Starts in the location specified in
position 10 of this parameter.
–
Is separated by the character
specified in position 26 of this
parameter.
Any information passed to the matcher
that is not used in the matching
process is identified as unmatched
data. Unmatched data is concatenated
and written into one field that:
Working With CODE-1 Plus
–
Starts in the location specified in
position 18 of this parameter.
–
Is separated by the character
specified in position 26 of this
parameter.
31
1
Parameter Reference
Table 5: AP OUT Parameter Fields (Part 2 of 5)
Position
Field Name
Description
Comments
10-12
Location for
ADDITIONAL INPUT
DATA
Location on the output record for
additional input data. (Any information
that is defined on input address lines but
is not sent to the matcher for processing
is identified as additional input data.)
Optional.
No default.
14-16
Length of
ADDITIONAL INPUT
DATA
Length of the additional input data
specified in position 10 of this parameter.
Optional.
Default is 600.
• If you specify F in position 8 and a value
other than 600 in this field, CODE-1
Plus generates an error and stops
processing.
• If you specify C in position 8, CODE-1
Plus truncates any data posted beyond
the length specified here.
18-20
Location for EXTRA
DATA FROM
MATCHER
Location on the output record for extra
data from the matcher. (Any information
passed to the matcher that is not used in
the matching process is identified as
unmatched data.)
Optional.
No default.
22-24
Length of EXTRA
DATA FROM
MATCHER
Length of output extra data from the
matcher (unmatched data) specified in
position 18.
Optional.
Default is 500.
• If you specified F in position 8 of this
parameter and some value other than
500 is posted in this field, CODE-1 Plus
generates an error and stops
processing.
• If you specified C in position 8 of this
parameter, CODE-1 Plus truncates any
data posted beyond the length specified
here.
26
DATA SEPARATOR
If you specified C in position 8 of this
parameter, specify a character to
separate the additional input data or the
extra data from the matcher (unmatched
data).
Optional.
Default is
semicolon “;”.
30
Storage conditions
— NORMALIZED
PRIMARY ADDRESS
LINE
Conditions under which the normalized
primary address line should be stored.
Enter one of the following codes:
Optional.
Default is X.
32-34
32
Location for
NORMALIZED
PRIMARY ADDRESS
LINE
A
Store for all records.
X
Store only when standardized
address is not stored.
Location on the output record for the
normalized primary address line.
Optional.
No default.
Software Release 4.0.0/March 2015
AP OUT Parameter Record
1
Table 5: AP OUT Parameter Fields (Part 3 of 5)
Position
Field Name
Description
Comments
36-37
Length of
NORMALIZED
PRIMARY ADDRESS
LINE
Length of the normalized primary address
line.
Optional.
No default.
39
Storage conditions
— NORMALIZED
SECONDARY
ADDRESS LINE
Conditions under which the normalized
secondary address line should be stored.
Enter one of the following codes:
Optional.
Default is X.
A
Store for all records.
D
Store dropped dual address from
matched address.
X
Store only when standardized
address is not stored.
41-43
Location for
NORMALIZED
SECONDARY
ADDRESS LINE
Location on the output record for the
normalized secondary address line.
Optional.
No default.
45-46
Length of
NORMALIZED
SECONDARY
ADDRESS LINE
Length of the normalized secondary
address line.
Optional.
No default.
Working With CODE-1 Plus
33
1
Parameter Reference
Table 5: AP OUT Parameter Fields (Part 4 of 5)
Position
48-50
Field Name
Location for
DROPPED
PRIMARY “CARE
OF” DATA
Description
Comments
Location on the output record for the
“Care of” data dropped from the primary
address line. Valid "Care of" data
includes:
Optional.
No default.
• CO
• C/O
• C/O/
• ATTN
• %
• MC:
• MS:
• MAILSTOP
• MAIL STOP
• CAMPUS BOX
• CAMPUS BX
• COLLEGE BOX
• HALL:
• DORM:
• LEAVE ON PORCH
• REAR ENTRANCE
• CIMS:
• BLDG:
• BLD:
• FL:
• FLR:
NOTE: All "Care of" prefixes must be
separated by a space from the content
(e.g. C/O Mary, not C/OMary or
"DORM: 123", not "DORM:123").
52-53
34
Length of
DROPPED
PRIMARY “CARE
OF” DATA
Length of the "care of" data dropped from
the primary address line.
Optional.
No default.
Software Release 4.0.0/March 2015
AP OUT Parameter Record
1
Table 5: AP OUT Parameter Fields (Part 5 of 5)
Position
55-57
Field Name
Location for
DROPPED
SECONDARY “CARE
OF” DATA
Description
Location on the output record for the
“Care of” data dropped from the
secondary address line. Valid "Care of"
data includes:
Comments
Optional.
No default.
• CO
• C/O
• C/O/
• ATTN
• %
• MC:
• MS:
• MAILSTOP
• MAIL STOP
• CAMPUS BOX
• CAMPUS BX
• COLLEGE BOX
• HALL:
• DORM:
• LEAVE ON PORCH
• REAR ENTRANCE
• CIMS:
• BLDG:
• BLD:
• FL:
• FLR:
All "Care of" prefixes must be separated
by a space from the content (e.g. C/O
Mary, not C/OMary or
"DORM: 123").
59-60
Length of
DROPPED
SECONDARY “CARE
OF” DATA
Length of the “care of” data dropped from
the secondary address line.
Optional.
No default.
70
NORMALIZATION
TYPE (No match)
Code indicating whether all address types
or only selected address types should be
normalized. The selected address types
are the following: “GENERAL DELIVERY”
keywords, PO BOX keywords, and RR/HC
keywords.
Optional.
Default is
blank.
Working With CODE-1 Plus
Blank
Normalize specified address line
regardless of address type.
X
Normalize select address types
otherwise return input.
If X is selected,
position 19 of
SA OUT must
be I.
35
1
Parameter Reference
Example of Storing Additional Input Data/Unmatched Data - Fixed Format
The following is an example that stores the additional input data and unmatched data
to the output (COK) file in a fixed format. The AP OUT parameter looks like this:
....5...10....5...20....5...30....5...40....5...50....5...60....5...70....5...80
AP OUT F 701
1301
Where:
AP OUT position 8 = F (Fixed length format). Extra data will be posted “as is” in eleven
output fields (six additional input data fields and five unmatched data fields).
Additional input data is stored in position 701 for the default length of 600.
Unmatched data is stored in position 1301 for the default length of 500.
Input Address:
GROUP 1
ATTN ALICE ROSE SMITH
VILLAGE LOCALE PROPERTY
4200 PARLIAMENT PL STE 600 PO BOX 8511
6 W GLEN ST SUITE 201
LANHAM MD 20706
COK File - Additional Input Data:
Example of additional input data stored in position 701 for the default length of 600:
..701.. … ..801..
…
ATTN ALICE ROSE SMITH
..901..
…
VILLAGE LOCALE PROPERTY
COK File - Unmatched Data:
Example of unmatched data stored in position 1301 for the default length of 500:
..1301.. …
..1401..
PO BOX 8511
…
..1501..
6 W GLEN ST SUITE 201
NOTE: All data used in this example is for illustration purposes only and should
not be interpreted as actual USPS address data.
36
Software Release 4.0.0/March 2015
AP OUT Parameter Record
1
Example of Storing Additional Input Data/Unmatched Data - Concatenated
Format
The following is an example that stores the additional input data and unmatched data
to the output (COK) file in concatenated format using the default semicolon as the
data delimiter. The AP OUT parameter looks like this:
....5...10....5...20....5...30..
AP OUT C 701 4001101 400
Where:
AP OUT position 8 = C (Concatenated format).
Additional input data is stored in position 701 for a length of 400.
Unmatched data is stored in position 1101 for a length of 400.
Input Address:
GROUP 1
ATTN ALICE ROSE SMITH
VILLAGE LOCALE PROPERTY
4200 PARLIAMENT PL STE 600 PO BOX 8511
6 W GLEN ST SUITE 201
LANHAM MD 20706
COK File - Additional Input Data:
Example of additional input data stored in position 701 for a length of 400:
..701..
;ATTN ALICE ROSE SMITH;VILLAGE LOCALE PROPERTY OWNERS;…
COK File - Unmatched Data:
Example of unmatched data stored in position 1101 for a length of 400:
..1101...
PO BOX 8511;6 W GLEN ST SUITE 201;…
NOTE: All data used in this example is for illustration purposes only and should
not be interpreted as actual USPS address data.
Working With CODE-1 Plus
37
1
Parameter Reference
AUXIL1 Parameter Record
The optional AUXIL1 parameter identifies the presence of an auxiliary reference file
for matching purposes. This file must be preprocessed through the Pitney Bowessupplied C1AUXBLD program (using the specified Pitney Bowes input format). There
is flexibility in the record size, allowing for additional user-defined data. For more
information on using the C1AUXBLD program, refer to Chapter 6, "Auxiliary File
Processing". This parameter defines the location of the file on the output record.
Field-by-Field
Table 6: AUXIL1 Parameter Fields
Position
38
Field Name
Description
Comments
1-6
KEYWORD
AUXIL1 is the only acceptable entry.
Required.
70
Location of
FILE
Code indicating where to write the
auxiliary file in the output:
Optional
Default is N.
N
Write record to the NCO file.
C
Write record to the COK file.
Software Release 4.0.0/March 2015
BYPEXP Parameter Record
1
BYPEXP Parameter Record
The optional BYPEXP parameter tells CODE-1 Plus to override an expired database.
This parameter only takes effect when the database is truly expired, that is, the
database is beyond the USPS grace period as defined in DMM 708. If your CODE-1
Plus database is expired and you use this parameter, CODE-1 Plus will not produce a
USPS Form 3553.
NOTE: It is very important to use a current CODE-1 Plus database. The BYPEXP
parameter is provided for use in an emergency situation only and should not be
used in “normal” processing.
Field-by-Field
Table 7: BYPEXP Parameter Fields
Position
1-6
Working With CODE-1 Plus
Field Name
KEYWORD
Description
BYPEXP is the only acceptable entry.
Comments
Required.
39
1
Parameter Reference
CASSA1 Parameter Record
The optional CASSA1 parameter tells CODE-1 Plus to override the CASS
certification data as it appears in box A1 of USPS Form 3553. This allows you to
CASS-certify CODE-1 Plus and use your own company name and/or software name
and version number.
NOTE: Using this parameter will invalidate the USPS Form 3553 if you have not
previously received a CASS certificate from the USPS for the vendor name and
software name.
Using the CASSA1 parameter with no values will cause a parameter error. The
software version number must be presented in the V.RR.MM format, including the
periods. The software version number in box A1 of USPS Form 3553 is very
specific and cannot be modified. This format is a USPS requirement.
If you specify a new software name, the new name will replace the CODE-1 Plus
product name on all report headers with the exception of the parameter Listing
report and the Execution Log. Any other information can be added to the report
heading by using the UHDxx and UFTxx parameters.
NOTE: Your particular licensing agreement may not permit your company to
certify the CODE-1 Plus product under your company name. See your software
licensing agreement for permitted scope and use of the product.
Field-by-Field
The following table is an overview of each field on the CASSA1 parameter.
Table 8: Fields on the CASSA1 Parameter (Part 1 of 2)
Position
1-6
40
Field Name
KEYWORD
Description
Comments
CASSA1 is the only acceptable entry.
Required.
Software Release 4.0.0/March 2015
CASSA1 Parameter Record
1
Table 8: Fields on the CASSA1 Parameter (Part 2 of 2)
Position
8-32
Field Name
Description
CASS-CERTIFIED
COMPANY NAME
CASS-certified company name as it
appears on your CASS certificate (up to
25 characters).
34-63
CASS-CERTIFIED
SOFTWARE NAME
CASS-certified software name as it
appears on your CASS certificate (up to
30 characters).
65-71
CASS-CERTIFIED
SOFTWARE
VERSION NUMBER
CASS-certified software version
number, in V.RR.MM format. CASS
requires the following information:
V
Version number
R
Release number
M
Modification number
Comments
These three
fields are all
optional.
However, you
must fill in at
least one field, or
an error will
occur. Any field
not filled in will
retain its current
Pitney Bowes
value.
For example, CODE-1 Plus 4.0, released
in 2015 would appear as follows: 4.00.15.
Working With CODE-1 Plus
41
1
Parameter Reference
CASSA4 Parameter Record
The optional CASSA4 parameter allows you to override the Z4CHANGE certification
data as it appears in boxes A4 - A5 of the USPS Form 3553. For more information on
Z4CHANGE certification, refer to Chapter 3, "Using the Z4CHANGE Option".
Field-by-Field
Table 9: CASSA4 Parameter Fields
Position
Field Name
Description
Comments
1-6
KEYWORD
CASSA4 is the only acceptable entry.
8-32
Z4CHANGECERTIFIED
COMPANY NAME
Z4CHANGE-certified company name as
it is to appear on your USPS certificate
(up to 25 characters).
Z4CHANGECERTIFIED
SOFTWARE NAME
and VERSION
NUMBER
Z4CHANGE-certified software name as it
is to appear on your USPS certificate (up
to 30 characters) and Z4CHANGEcertified software version number in
V.RR.MM format.
34-67
V
Version number
R
Release number
M
Modification number
Required.
These two fields
are optional.
However, you
must fill in at
least one field, or
an error will
occur. Any field
not filled in will
retain its current
Pitney Bowes
value.
For example, CODE-1 Plus 4.0, released
in 2015 would appear as follows: 4.00.15.
42
Software Release 4.0.0/March 2015
CASSA7 Parameter Record
1
CASSA7 Parameter Record
The optional CASSA7 parameter allows you to override LOT certification data as it
appears in boxes A7 - A8 of the USPS Form 3553. For more information on LOT
certification, refer to Chapter 4, "Line of Travel (LTO10)".
Field-by-Field
Table 10: CASSA7 Parameter Fields
Position
Field Name
Description
1-6
KEYWORD
CASSA7 is the only acceptable entry.
8-32
ELOT-CERTIFIED
COMPANY NAME
LOT-certified company name as is to
appear on your USPS certificate (up to 25
characters).
ELOT-CERTIFIED
SOFTWARE NAME
LOT-certified software name as it is to
appear on your USPS certificate (up to 30
characters). and LOT-certified software
version number in V.RR.MM format.
34-67
V
Version number
R
Release number
M
Modification number
Comments
Required.
These two fields
are optional.
However, you
must fill in at
least one field, or
an error will
occur. Any field
not filled in will
retain its current
Pitney Bowes
value.
For example, CODE-1 Plus 4.0, released
in 2015 would appear as follows: 4.00.15.
Working With CODE-1 Plus
43
1
Parameter Reference
CHCKPT Parameter Record
The optional CHCKPT parameter specifies to take a checkpoint every n records
(where n is a number you specify) so that if your job is terminated for any reason, you
can restart the job from the last successful checkpoint, instead of running the entire
job again. A checkpoint is simply the number of records processed up to that point.
For example, if you take a checkpoint every 500 records, and your job terminates in
the middle, you could look at the checkpoint file and determine the last checkpoint
taken. If the last checkpoint was 47,500, you would know that you could skip the first
47,500 records when you restarted your job.
NOTE: This parameter is only used in IBM mainframe environments.
Checkpoints cannot be issued using CBUF processing of VSAM files (shareoptions
3,3). You must ensure that your CODE-1 Plus database is defined with
shareoptions specified as (1,3) or (2,3).
MVS Checkpoints
You must make the following modifications to your MVS JCL if you are using the
CHCKPT parameter. Refer to the IBM MVS/DFP Checkpoint/Restart Manual for
details on using checkpoints.
•
Define the checkpoint file with a C1BMCHK DD statement. To have your
checkpoints written serially to the file, specify DISP=MOD. To store only the
latest checkpoint, specify DISP=NEW.
NOTE: If you use DISP=NEW to save only the latest checkpoint, and for some
reason a checkpoint cannot be taken successfully, there will be no checkpoint
available for restart until another checkpoint is successfully taken.
44
Software Release 4.0.0/March 2015
CHCKPT Parameter Record
1
Field-by-Field
Table 11: CHCKPT Parameter Fields
Position
Field Name
Description
Comments
1-6
KEYWORD
CHCKPT is the only acceptable entry.
Required.
8-16
CHECKPOINT
COUNT
The number of records that are to be
processed before each checkpoint is
taken. You must enter leading zeros.
Required.
No default.
18-21
DEVICE TYPE
The type of device on which this file
resides. Enter one of the following
codes:
Not used for
MVS.
Default is 2314.
TAPE
2311
2314
3310
3330
3340
3350
3370
3375
3380
FBA
Working With CODE-1 Plus
45
1
Parameter Reference
CONFIG Parameter Record
The optional CONFIG parameter is used to identify the matching configuration that
is being used in this job. If this configuration matches one of the configurations that
Pitney Bowes has CASS-certified with the USPS, a USPS Form 3553 prints at the end
of the CODE-1 Plus job.
NOTE: If you do not include this parameter in your job, the CASS report will not
be generated. If you mix strictness of Street name match, firm name match and
directional/suffix match, DPV process will be disabled.
This feature enables you to specify configuration information for CASS certification.
Some of the information that is stored on this parameter is the same as information
stored on other parameters.
NOTE: If you specify values for the fields on the CONFIG parameter, they override
the values specified on the other parameters.
This configuration information is particularly useful when you want to use an existing
job, but you want to make sure that it qualifies for automation-based discounts.
Instead of checking all of the information stored on the other parameters, you could
just add CONFIG information, which overrides the information in the other
parameters. For more information on CASS-certified configurations, refer to your
CODE-1 Plus Reference Guide.
NOTE: A USPS form 3553 will be printed only when the information on a job’s
parameters corresponds to a configuration that Pitney Bowes has previously
certified.
46
Software Release 4.0.0/March 2015
CONFIG Parameter Record
1
Field-by-Field
Table 12: CONFIG Parameter Fields (Part 1 of 6)
Position
Field Name
Description
Comments
1-6
KEYWORD
CONFIG is the only acceptable entry.
Required.
8
STREET NAME
MATCH CODE
Code indicating the strictness of the
street name match. Enter one of the
following codes:
Optional.
Default is M.
10
12
14
FIRM NAME MATCH
CODE
DIRECTIONAL/
SUFFIX MATCH
CODE
MULTIPLE MATCH
ACCEPTANCE
E
Equal
T
Tight
M
Medium
L
Loose.
Code indicating the strictness of the firm
name match. Enter one of the following
codes:
E
Equal
T
Tight
M
Medium
L
Loose.
Code indicating the strictness of the
directional/suffix match. Enter one of the
following codes:
E
Equal
T
Tight
M
Medium
L
Loose.
Code indicating if standardized
components should be stored if multiple
matches are found. Enter one of the
following codes:
Y
Accept multiple matches. The
standardized address that will
be returned will be the last one
in the stack of multiple matches
that were found.
N
Do not accept multiple matches.
Optional.
Default is M.
Optional.
Default is M.
Optional.
Default is N.
NOTE: A Y in this position will result in a
non-CASS certified configuration. No
CASS report will be generated.
16
Working With CODE-1 Plus
MAXIMUM ADDRESS
CORRECTNESS
Maximum acceptable address
probability of correctness. Enter a
number between 0 and 9, where 0
indicates the best case and 9 indicates
the worst case.
Optional.
No default.
47
1
Parameter Reference
Table 12: CONFIG Parameter Fields (Part 2 of 6)
Position
Field Name
Description
Comments
18
MAXIMUM OVERALL
CORRECTNESS
Maximum acceptable overall probability
of correctness. Enter a number between
0 and 9, where 0 indicates the best case
and 9 indicates the worst case.
Optional.
No default.
20-21
USER-SPECIFIED
CONFIGURATION
NUMBER
Two-digit ID number to assign to this
configuration.
Optional.
No default.
TERMINATE IF NONCASS
Terminate the CODE-1 Plus job if an
option has been selected that results in a
non-CASS-certified configuration.
23
25-27
EXECUTION LOG
COUNTER
NOTE: This has no relation to the Pitney
Bowes's CASS-certified configuration
IDs; it is for your reference only.
Y
Terminate if non-CASS-certified
configuration
N
Do not terminate if non-CASScertified configuration.
Number of records (in thousands) to
trigger progress reporting in execution
log.
Optional.
Default is N.
Optional.
Default is 10,000
(100 for VAX).
(100=100,000)
36
48
OUTPUT CASE
OPTION
Code indicating whether to return mixed
case in all address components. Enter
one of the following codes:
Blank
Matched output will be returned
in all uppercase.
C
All address components that
contain text will be returned in
mixed case.
L
All address components that
contain text will be returned in
lower case.
Optional.
Default is Blank.
Software Release 4.0.0/March 2015
CONFIG Parameter Record
1
Table 12: CONFIG Parameter Fields (Part 3 of 6)
Position
38
Field Name
DUAL ADDRESS
MATCH LOGIC
Description
Code indicating how to handle addresses
with multiple non-blank address lines or
multiple address types on the same
address line.
Blank
Normal match scoring for street
address elements, input ZIP
Code, matching address line,
and so on.
S
Return a street match,
regardless of the address line.
P
Return a PO Box match,
regardless of the address line.
Comments
Optional.
Default is blank.
NOTE: Under normal conditions, a PO
Box cannot match if the city name and
input ZIP Code are both changed.
NOTE: If S or P is selected, a non-CASScertified configuration will be generated.
No PS Form 3553 will be generated.
DMM 708 states to match to a PO Box
first when on the same address line or
the PO Box address is the primary
address line.
40
UNIQUE ZIP
HANDLING
Code indicating whether the Input ZIP
Code should be returned when there is
no correlation between the input city/
state and ZIP Code.
Blank
Do NOT store the Input ZIP Code.
X
Store the Input ZIP Code.
Optional.
Default is blank.
NOTE: If X is chosen, a non-CASS
certified configuration will be created.
No PS Form 3553 will be generated.
42
PMB HANDLING
Code indicating whether to store nonstandard private mailbox numbers.
Blank
Store ONLY standard private
mailbox numbers.
X
Store ALL private mailbox
numbers.
Optional
Default is blank.
NOTE: If X is chosen, a non-CASS
certified configuration will be created.
No PS Form 3553 will be generated.
Working With CODE-1 Plus
49
1
Parameter Reference
Table 12: CONFIG Parameter Fields (Part 4 of 6)
Position
44
Field Name
ENHANCED
HIGH RISE
ALTERNATE
MATCHING
Description
Comments
Enhanced High Rise Alternate Matching
allows you to convert a building name
used as a street address to the correct,
USPS-preferred address street name
associated with that building.
Y
Yes, attempt to match to the
base record when an alternate
match is made and the input
address contains secondary
address information.
N
No, do not attempt to match to
the base record.
Optional
Default is Y.
NOTE: Selecting N will create a NonCASS-certified configuration.
46
50
MULTIPLE
SECONDARY
COMPONENT
PROCESSING
Y
Attempt secondary match.
N
Assign default ZIP + 4 Code.
Optional
Default is Y.
NOTE: Selecting N will create a NonCASS-certified configuration.
Software Release 4.0.0/March 2015
CONFIG Parameter Record
1
Table 12: CONFIG Parameter Fields (Part 5 of 6)
Position
49
Field Name
USE NONSTANDARD CITY
NAMES
Description
Code indicating whether or not the
matcher should return vanity city names
when they most closely match the input
record. Enter one of the following codes:
Blank
No, never return vanity city
names.
X
Yes, return vanity city names
when they most closely match
the input city names. When this
option is selected, if you input a
city name that is not a USPS
primary city, but is a valid vanity
name, the vanity name is
returned.
Comments
Optional.
Default is blank.
NOTE: Please note the following when
defining the Use Non-Standard City
Names field:
• If X is chosen, a CASS certified
configuration will be created, but you
will not be able to get a postal
automation presort discount.
• If you leave this field blank, and the
only matching city on the database is a
vanity city, the word “ZIP” and the ZIP
Code is stored in the Standardized
City location on your output record.
• If a vanity city name is greater than 13
characters, CODE-1 Plus will not
return the input vanity city name if
CODE-1 Plus is set up to accept vanity
city names. Instead, CODE-1 Plus will
return the primary city name or, if the
primary city name has a short city
name, the primary short city name
will be returned. The USPS does not
store short city names for vanity cities
and CASS regulations state that the
software will return the primary city
name/primary short city name when
the input vanity long city name is
entered.
51
Working With CODE-1 Plus
ENHANCED STREET
MATCHING OPTION
Code indicating whether to use
enhanced street matching during
CODE-1 Plus processing.
Blank
Do not use enhanced street
matching
A
Use all street matching.
S
Use enhanced street matching.
Optional.
Default is blank.
51
1
Parameter Reference
Table 12: CONFIG Parameter Fields (Part 6 of 6)
Position
53
Field Name
LIMITED LOCALITY
OPTION
Description
Comments
Code indicating whether to perform
address matching against multiple
localities during CODE-1 Plus
processing.
Blank
Conduct standard processing
X
Limit address match to ZIP Code
locality.
Optional.
Default is blank.
NOTE: Setting this option to X will
produce a non-CASS-certified
configuration. No USPS Form 3553 will
be generated.
55
SPLIT INDICA
Code indicating whether to perform Split
Indicia processing:
Y
Perform split indicia processing
N
Do not perform split indicia
processing.
Optional.
Default is Y.
NOTE: Setting this option to N will
produce a non-CASS-certified
configuration. No USPS Form 3553 will
be generated.
57
59
C/O DATA FLAG
Code indicating whether to append careof (C/O) data to the end of the output
address line.
Blank
Do not append C/O data
Y
Append C/O data.
Optional.
Default is blank.
Reserved
NOTE: Remember that only an “MMM” strictness code is a CASS-certified
configuration which will print a USPS form 3553. Any other combination of
strictness code (for example, “MEM”) will not generate a USPS form 3553.
NOTE: The values in the Maximum Address Correction and Maximum Overall
Correction fields must match the values in similar fields in the CR OUT, CS OUT,
SA OUT, Z4 OUT, and Z5 OUT parameters. If these fields do not match in all
parameters, an invalid CASS form will be generated.
52
Software Release 4.0.0/March 2015
CONFRM Parameter Record
1
CONFRM Parameter Record
The optional CONFRM parameter is used to specify that records containing either
special ZIP Codes or “confirmation flag values” should be confirmed without
undergoing the matching process. These special ZIP Codes are APO/FPO, military
base, and government agency ZIP Codes.
This feature enables you to have special records automatically confirmed, without
CODE-1 Plus attempting to match them to the contents of the database. Often
CODE-1 Plus is unable to successfully match APO/FPO, military base, and
government agency ZIP Codes. This parameter enables you to have these types of
records written to the confirmed records output file instead of the rejected records
file.
Using confirmation flags in your records enables you to automatically confirm
records you know are correct, even though CODE-1 Plus does not match them.
As an example, let’s look at an insurance agency that wants to mail solicitations to new
homeowners. This agency has a standard mailing list, and has also bought lists of
addresses from several builders that have just finished new housing developments.
Because the streets in these new developments are so new, they have not yet been put
on the USPS database. The insurance agency will merge these new lists with its
standard mailing list, but will first insert confirmation flags in the records on the
builders’ lists. In their CODE-1 Plus job, they will include a CONFRM parameter that
looks for these confirmation flags and confirms the records automatically. In this way,
the records will be confirmed, even though the addresses are not on the CODE-1 Plus
database.
You can enter up to 4 confirmation values on each parameter, up to a maximum of
250 confirmation values. You can use as many CONFRM parameters as are necessary
to indicate the confirmation values you desire. If a string of blank spaces is one of the
confirmation values, it must be the first value on a parameter.
Working With CODE-1 Plus
53
1
Parameter Reference
Field-by-Field
Table 13: CONFRM Parameter Fields (Part 1 of 2)
Position
Field Name
Description
Comments
1-6
KEYWORD
CONFRM is the only acceptable entry.
Required.
8-10
Location for OUTPUT
CONFIRMATION
CODE
Code indicating whether or not the record
was confirmed without processing, and if so,
why. One of the following codes is stored:
Optional.
No default.
12
14
CONFIRM APO/FPO
ZIP CODES
CONFIRM MILITARY
BASE ZIP CODES
Blank
Not confirmed (record was addressmatched)
V
Confirmed by comparison to an
input confirmation flag value
A
Confirmed as an APO/FPO ZIP Code
M
Confirmed as a military ZIP Code
G
Confirmed as a government agency.
Code indicating whether or not to confirm
APO/FPO ZIP Codes automatically. Enter
one of the following codes:
Blank
Process APO/FPO ZIP Codes as
normal records.
A
Confirm APO/FPO ZIP Codes.
Code indicating whether or not to confirm
military base ZIP Codes automatically. Enter
one of the following codes:
Blank Process military base ZIP Codes as
normal records.
M
16
54
CONFIRM
GOVERNMENT
AGENCY ZIP CODES
Optional.
Default is to
process the
records.
Optional.
Default is to
process the
records.
Confirm military base ZIP Codes.
Code indicating whether or not to confirm
government agency ZIP Codes
automatically. Enter one of the following
codes:
Blank
Process government agency ZIP
Codes as normal records.
G
Confirm government agency ZIP
Codes.
Optional.
Default is to
process the
records.
18-20
Location of
CONFIRMATION
FLAG
Location in the input record of the
confirmation flag.
Optional.
No default.
22
Length of
CONFIRMATION
FLAG
Length of the confirmation flag in the input
record. Must be 9 or less.
Optional.
No default.
Software Release 4.0.0/March 2015
CONFRM Parameter Record
1
Table 13: CONFRM Parameter Fields (Part 2 of 2)
Position
24-25
Field Name
EQUAL/NOT EQUAL
CODE
Description
Code indicating whether the confirmation
flag in the records should be equal to or not
equal to the confirmation value(s) on this
parameter. Enter one of the following codes:
EQ
The confirmation flag in the record
must be equal to one of the
confirmation values on this
parameter for the record to be
confirmed automatically.
NE
The confirmation flag in the record
must not be equal to any of the
confirmation values on this
parameter for the record to be
confirmed automatically.
Comments
Optional.
No default.
NOTE: The EQUAL/NOT EQUAL CODE must
be the same on all CONFRM parameters.
27-35
CONFIRMATION
VALUE 1
A value to which the confirmation flag in the
input record is compared. If positions 24-25
above are EQ, and the confirmation flag in
the record is equal to this value, the record
will be confirmed. Conversely, if positions
24-25 above are NE, and the confirmation
flag in the record is not equal to this value,
the record will be confirmed.
Optional.
No default.
37-45
CONFIRMATION
VALUE 2
A value to which the confirmation flag in the
input record is compared. If positions 24-25
above are EQ, and the confirmation flag in
the record is equal to this value, the record
will be confirmed. Conversely, if positions
24-25 above are NE, and the confirmation
flag in the record is not equal to this value,
the record will be confirmed.
Optional.
No default.
47-55
CONFIRMATION
VALUE 3
A value to which the confirmation flag in the
input record is compared. If positions 24-25
above are EQ, and the confirmation flag in
the record is equal to this value, the record
will be confirmed. Conversely, if positions
24-25 above are NE, and the confirmation
flag in the record is not equal to this value,
the record will be confirmed.
Optional.
No default.
57-65
CONFIRMATION
VALUE 4
A value to which the confirmation flag in the
input record is compared. If positions 24-25
above are EQ, and the confirmation flag in
the record is equal to this value, the record
will be confirmed. Conversely, if positions
24-25 above are NE, and the confirmation
flag in the record is not equal to this value,
the record will be confirmed.
Optional.
No default.
Working With CODE-1 Plus
55
1
Parameter Reference
CONTRL Parameter Record
CONTRL is a required parameter with no individual fields.
Field-by-Field
As shown in the following table, the parameter keyword field is the only field on the
CONTRL parameter.
Table 14: CONTRL Parameter Field
Position
1-6
56
Field Name
KEYWORD
Description
Comments
CONTRL is the only acceptable entry.
Required.
Software Release 4.0.0/March 2015
1
CR OUT Parameter Record
CR OUT Parameter Record
The optional CR OUT parameter tells CODE-1 Plus where on the output record to
store the carrier route data.
NOTE: The carrier route is stored in USPS standard format, as defined under
positions 12-14 of this parameter.
Field-by-Field
Table 15: CR OUT Parameter Fields (Part 1 of 3)
Position
Field Name
Description
Comments
1-6
KEYWORD
CR OUT is the only acceptable entry.
Required.
8-10
Location for
CARRIER ROUTE
RETURN CODE
Location on the output record for the
1-character carrier route return code. One
of the following codes is stored:
Optional.
No default.
Working With CODE-1 Plus
Blank
The match attempt was successful.
A
Apartment number missing or not
found in database, and an
apartment-level match was
required.
B
Insufficient (or blank) address
match information.
C
The address probable correctness
or overall probable correctness
was too high.
D
Information was dropped.
H
House/box number not found on
street.
L
The standardized address was too
long.
M
Multiple matches of equal quality
were found.
N
The carrier route wasn't stored
because the processing
requirements specified that it was
not to be stored.
S
Street name not found in ZIP Code.
U
Unavailable—auxiliary file
processing.
Z
ZIP Code not found in database.
57
1
Parameter Reference
Table 15: CR OUT Parameter Fields (Part 2 of 3)
Position
12-14
60
58
Field Name
Location for
CARRIER ROUTE
CODE
Storage conditions
— INFORMATION
DROPPED
Description
Comments
Location on the output record for the
4-character carrier route code, which is
stored in one of the following formats:
Bnnn
PO box address
Cnnn
Street address
Gnnn
General delivery address
Hnnn
Highway contract route address
Rnnn
Rural route address.
Code indicating whether the carrier route
code should be stored in cases in which
information was dropped during the match
process. Enter one of the following codes:
Blank
Store the carrier route code
anyway.
X
Do not store the carrier route code.
Optional.
No default.
Optional.
Default is to
store the
carrier
route code
anyway.
62
MAXIMUM ADDRESS
CORRECTNESS
Maximum acceptable address probability of
correctness to store the carrier route. Enter
a number between 0 and 9, where 0
indicates the best case and 9 indicates the
worst case.
Optional.
Default is 9.
64
MAXIMUM OVERALL
CORRECTNESS
Maximum acceptable overall probability of
correctness to store the carrier route. Enter
a number between 0 and 9, where 0
indicates the best case and 9 indicates the
worst case.
Optional.
Default is 9.
68
Storage conditions
— MULTIPLE
CARRIER ROUTE
Code indicating whether or not the
standardized carrier route code should be
stored if multiple matching carrier route
codes were found. Enter one of the
following codes:
Optional.
Default is to
store
whatever is
indicated in
position 72.
Blank
Do not store the returned carrier
route code. Instead, store the
information indicated in position
72.
M
Store the returned carrier route
code.
Software Release 4.0.0/March 2015
CR OUT Parameter Record
1
Table 15: CR OUT Parameter Fields (Part 3 of 3)
Position
70
72
Working With CODE-1 Plus
Field Name
Storage conditions
— MULTIPLE ZIP
CODE
DISPOSITION
INDICATOR
Description
Code indicating whether the standardized
carrier route code should be stored if
multiple matching ZIP codes were found.
Enter one of the following codes:
Blank
Do not store the returned carrier
route code. Instead, store the
information indicated in position
72.
M
Store the returned carrier route
code.
Code indicating what should be stored when
the standardized carrier route code was not
stored, either because no match was found,
or due to storage conditions. Enter one of
the following codes:
B
Store blanks.
I
Store carrier route code from the
input record.
X
Store nothing.
Comments
Optional.
Default is to
store
whatever is
indicated in
position 72.
Optional.
Default is B.
59
1
Parameter Reference
CS OUT Parameter Record
The optional CS OUT parameter is used to tell CODE-1 Plus where in the output
record to put the standardized city and state information.
NOTE: If a vanity city name is greater than 13 characters, CODE-1 Plus will not
return the input vanity city name if CODE-1 Plus is set up to accept vanity city
names. Instead, CODE-1 Plus will return the primary city name or, if the primary
city name has a short city name, the primary short city name will be returned. The
USPS does not store short city names for vanity cities and CASS regulations state
that the software will return the primary city name/primary short city name when
the input vanity long city name is entered.
Remember, standardized city/state information is formatted to conform to USPS
conventions and matched against the master file. Dropped information is data that
was present in the input city/state line, but was ignored during the analysis process.
60
Software Release 4.0.0/March 2015
CS OUT Parameter Record
1
Field-by-Field
Table 16: CS OUT Parameter Fields (Part 1 of 4)
Position
Field Name
Description
Comments
1-6
KEYWORD
CS OUT is the only acceptable entry.
Required.
8-10
Location for
CITY/STATE
RETURN CODE
Location on the output record for the 1-character
city/state return code. One of the following codes
is stored to indicate the reason the output city and
state were or were not stored.
Optional.
No default.
Blank
An output city/state was stored.
A
Apartment number missing or not found
in database, and an apartment-level
match was required.
B
Insufficient (or blank) address match
information.
C
The probable correctness was higher
than the specified maximum.
D
Information was dropped during the
match.
H
House/box number not found on street.
M
Multiple matches of equal quality were
found.
P
Primary City/State information returned
for input ZIP Code when no match found
to database.
S
Street name not found in ZIP Code.
U
Unavailable—auxiliary file processing.
X
The only match was the default record.
Z
ZIP Code not found in database.
12-14
Location for
CITY NAME
Location on the output record for the returned city
name.
Optional.
No default.
16-17
Length of
CITY NAME
Length of the returned city name.
Optional.
No default.
18
Storage
conditions —
SHORT CITY
NAME
Code indicating what should be stored, on the
output record, in the position pointed to by
columns 12-14.
Optional.
Default is
blank.
Working With CODE-1 Plus
Blank
Store the standardized city name anyway.
I
Store the short city name (regardless if it
was the input city name).
61
1
Parameter Reference
Table 16: CS OUT Parameter Fields (Part 2 of 4)
Position
19
Field Name
Storage
conditions — NO
ADDRESS
MATCH
Description
Comments
Code indicating what should be stored when no
address match is found. Enter one of the following
codes:
Blank
Store the information indicated in position
72.
I
Store the input city.
Z
Store the primary city for the valid input
ZIP Code. If you specify “Z”, CODE-1 Plus
does not generate a USPS Form 3553
(CASS Summary Report).
Optional.
Default is to
store blanks
or nothing,
whichever is
indicated in
position 72.
21-23
Location for
SHORT CITY
NAME
Location on the output record for the 13-character
short city name. When no short city name
available, ZIP xxxxx will be returned in this output
area.
Optional.
No default.
25-27
Location for
STATE
ABBREVIATION
Location on the output record for the 2-character
state abbreviation.
Optional.
No default.
29
Storage
conditions — NO
STATE MATCH
Code indicating what should be stored when no
state match is found. Enter one of the following
codes:
Optional.
Default is to
store blanks
or nothing,
whichever is
indicated in
position 72.
Blank
Store the information indicated in position
72.
I
Store the input state abbreviation.
NOTE: These options are ignored when position 19
contains an I.
31-33
Location for
STANDARDIZED
CITY/STATE
LINE
Location on the output record for the standardized
city/state line. Enter a 3-digit location, or “INP” to
specify the standardized city/state line should be
stored in the same location as the input city/state
line. (INP is only valid if CS ZIP col. 8 is C or A.)
Optional.
No default.
35-36
Length of
STANDARDIZED
CITY/STATE
LINE
Length of the standardized city/state line.
Optional.
No default.
38
Format of
STANDARDIZED
CITY/STATE
LINE
Format of the standardized city/state line. Enter
one of the following codes:
Optional.
No default.
40-42
62
Location of
STANDARDIZED
URBANIZATION
NAME
9
City, state, ZIP Code, and ZIP + 4 Code
S
City and state only
Z
City, state, and 5-digit ZIP Code.
Location on the output record for the standardized
urbanization name.
Optional.
No default.
Software Release 4.0.0/March 2015
CS OUT Parameter Record
1
Table 16: CS OUT Parameter Fields (Part 3 of 4)
Position
Field Name
Description
Comments
44-45
Length of
STANDARDIZED
URBANIZATION
NAME
Length of the standardized urbanization name.
Optional.
No default.
47-49
Location for
USPS COUNTY
NAME
Location for the 25-character USPS county name
on the output record.
Optional.
No default.
51-53
Location for
USPS FIPS
COUNTY CODE
Location for the 3-character USPS FIPS county
code on the output record.
Optional.
No default.
55-57
Location for
CONGRESSIONAL DISTRICT
Location for the 2-character congressional
district code on the output record.
Optional.
No default.
59
Storage
conditions —
PREFERRED
LAST LINE CITY
NAME
Code indicating whether the preferred last line
city name should be stored:
Optional.
Default is Z.
NOTE: You may want to post the FIPS county code
to your record if you plan on handling IN-COUNTY
Periodicals Mailings in MailStream Plus. MSP
now needs the FIPS county code to determine the
county for in and out of county presort coding.
C
Store the USPS-preferred City Name
from USPS City/State File.
NOTE: If you select C, CODE-1 Plus does
not generate a CASS certified
configuration and does not generate the
USPS 3553 Report.
Z
Store the Preferred Last Line City Name
from the USPS ZIP+4 File (Override City
Name). (See the AM2OUT parameter for a
description of the Override City Name.)
NOTE: If you select Z, CODE-1 Plus
generates a CASS certified configuration
and the USPS 3553 Report.
P
Store the Primary City Name from the
USPS City/State File.
NOTE: If you select P, CODE-1 Plus does
not generate a CASS certified
configuration and does not generate the
USPS 3553 Report.
60
Working With CODE-1 Plus
Storage
conditions —
INFORMATION
DROPPED
Code indicating whether the standardized city/
state line should be stored when information was
dropped during the standardization process.
Enter one of the following codes:
Blank
Store the information anyway.
X
Do not store if information was dropped.
Optional.
Default is
blank.
63
1
Parameter Reference
Table 16: CS OUT Parameter Fields (Part 4 of 4)
Position
Description
Comments
62
MAXIMUM
ADDRESS
CORRECTNESS
Maximum acceptable address probability of
correctness to store the standardized city/state
line. Enter a number between 0 and 9, where 0
indicates the best case and 9 indicates the worst
case.
Optional.
Default is 9.
64
MAXIMUM
OVERALL
CORRECTNESS
Maximum acceptable overall probability of
correctness to store the standardized city/state
line. Enter a number between 0 and 9, where 0
indicates the best case and 9 indicates the worst
case.
Optional.
Default is 9.
66
Storage
conditions — NO
CITY MATCH
Code indicating what should be stored when no
city name match was found. Enter one of the
following codes:
Optional.
Default is
blank.
68
69
70
72
64
Field Name
Storage
conditions —
MULTIPLE ZIP +
4
Storage
Conditions—
MULTIPLE
URBANIZATION
NAME
Storage
conditions —
MULTIPLE ZIP
CODE
DISPOSITION
INDICATOR
Blank
Store the default city name.
X
Store the information indicated in position
72.
Code indicating whether the standardized city/
state line should be stored when multiple ZIP + 4
matches were found. Enter one of the following
codes:
Blank
Store the information indicated in position
72.
M
Store the standardized city/state line
anyway.
Code indicating whether to store the standardized
urbanization name when multiple matches were
found on the database.
Blank
Store the information indicated in position
72.
M
Store the standardized urbanization
name.
Code indicating whether the standardized city/
state line should be stored when multiple ZIP
Code matches were found. Enter one of the
following codes:
Blank
Store the information indicated in position
72.
M
Store the standardized city/state line
anyway.
Code indicating what should be stored in cases
where the standardized city/state line was not
stored, either because no match was found or due
to storage conditions. Enter one of the following
codes:
B
Store blanks.
X
Store nothing.
Optional.
Default is to
store blanks
or nothing,
whichever is
indicated in
position 72.
Optional.
Default is to
store blanks
or nothing,
whichever is
indicated in
position 72.
Optional.
Default is to
store blanks
or nothing,
whichever is
indicated in
position 72.
Optional.
Default is B.
Software Release 4.0.0/March 2015
CS ZIP Parameter Record
1
CS ZIP Parameter Record
The required CS ZIP parameter is used to tell CODE-1 Plus the location, length, and
format of the city, state, and ZIP Code in the input record.
NOTE: CODE-1 Plus considers a ZIP Code of 00000 to be invalid. If you want to
preserve an input ZIP Code that is all zeros, you will have to use either a MOVE I
parameter or an exit routine.
Field-by-Field
The following table is an overview of each field on the CS ZIP parameter.
Table 17: CS ZIP Parameter Fields (Part 1 of 3)
Position
Field Name
Description
Comments
1-6
KEYWORD
CS ZIP is the only acceptable entry.
Required.
8
Format of CITY/
STATE/ZIP CODE
Format of the city/state and ZIP Code
information on the input record. Enter one of
the following codes:
Required.
No default.
Working With CODE-1 Plus
A
City/state/ZIP Code are amongst the
address lines (position 8 on ADDRDF
must be L). If you select this value,
your city/state/ZIP must be together
in the right-most (last) non-blank
address line defined.
C
City/state mixed with address lines;
ZIP separate
M
City/state together in one field; ZIP in
a separate field
S
City, state, and ZIP in three separate
fields
X
City/state/ZIP in a single field
separate from the address.
65
1
Parameter Reference
Table 17: CS ZIP Parameter Fields (Part 2 of 3)
Position
66
Field Name
Description
Comments
10-12
Location of
SEPARATE ZIP CODE
Location on the input record for the separate
ZIP Code.
Optional.
No default.
Can not be
used with
option A
above.
14
Format of
SEPARATE ZIP CODE
Format of the separate ZIP Code. Enter one of
the following codes:
Optional.
No default.
9
ZIP Code is 9 digits binary stored in
4-character format.
B
ZIP Code is in 3-character binary
format.
C
ZIP Code is stored in 5-character
format.
P
ZIP Code is in a 3-character packed
format (the sign digit is ignored so
that the start of a 5-character packed
9-digit ZIP + 4 Code can be used with
this option).
16-18
Location of
CITY, CITY/STATE, or
CITY/STATE/ZIP
Location on the input record for the field that
contains the city, city/state, or city/state/ZIP.
Required if
“M” is
entered in
position 8.
No default.
20-21
Length of
CITY, CITY/STATE, or
CITY/STATE/ZIP
Length of the city, city/state, or city/state/ZIP
field.
Required if
“M” is
entered in
position 8.
No default.
23-25
Location of
SEPARATE STATE
Location on the input record for the separate
state.
Optional.
No default.
27-28
Length of
SEPARATE STATE
Length of the separate state.
Optional.
No default.
30-32
Location for storage
of EXTRACTED ZIP
CODE
Location on the output record where the
extracted ZIP Code should be stored. If the
input ZIP Code field is non-numeric, or is all
zeros, then blanks are stored in the location
you specify here.
Optional.
No default.
34-36
Location of
ORIGINAL ZIP + 4
CODE
Location on the input record of the ZIP + 4
add-on code.
Optional.
No default.
Software Release 4.0.0/March 2015
CS ZIP Parameter Record
1
Table 17: CS ZIP Parameter Fields (Part 3 of 3)
Position
38
Field Name
Format of ORIGINAL
ZIP + 4 CODE
Description
Format of the ZIP + 4 add-on code. Enter one
of the following codes:
C
4-character format
B
3-character binary format
P
3-character packed format (the sign
digit is ignored so that the start of a
5-character packed 9-digit ZIP + 4
code can be used with this option).
Comments
Optional.
No default.
40-42
Location of
ORIGINAL CARRIER
ROUTE CODE
Location on input record of the carrier route
code.
Optional.
No default.
44-46
Location of MASTER
FILE VINTAGE DATE
Location on the input records of the master
file vintage date. This field or the vintage of
MASTER FILE LITERAL in positions 50-55
activate Z4CHANGE processing.
Optional.
No default.
Code indicating the input format of the
master file vintage date in the input records.
This field is ignored if positions 44-46 are
blank. Enter one of the following codes:
Optional.
No default.
48
50-55
Working With CODE-1 Plus
Format of MASTER
FILE VINTAGE DATE
MASTER FILE
LITERAL DATE
B
2-byte binary format YYMM
C
4-byte character format YYMM
P
3-byte packed decimal format YYMM
3
3-byte binary format YYYYMM
6
6-byte character format YYYYMM
4
4-byte packed decimal format
YYYYMM.
Master file vintage date in YYYYMM format.
NOTE: If this field is filled in, positions 50-51
must contain “19” or “20”, and positions 5455 must contain “01” through “12”.
Either a
location is
specified in
this field, or
a date is
specified in
positions
50-55, but
not both.
Required if a
location is
specified in
positions
44-46
Optional.
No default.
Either a
literal date
is specified
in this field,
or a location
is specified
in positions
44-46, but
not both.
67
1
Parameter Reference
NOTE: If you specify a location of original ZIP + 4 CODE and CARRIER ROUTE
CODE, CODE-1 Plus tracks the number of times the returned ZIP + 4 Code and
carrier code were identical to the originals. These statistics are printed on the
Analysis of Matched Records Report.
68
Software Release 4.0.0/March 2015
DPVIN Parameter Record
1
DPVIN Parameter Record
The optional DPVIN parameter activates DPV and RDI processing and enables you
to process options on multiple matches to the ZIP + 4 database. For more information
on DPV and RDI, refer to Chapter 5, "Using Delivery Point Validation".
Currently, the USPS ZIP + 4 file consists of ranges of addresses. This means that if a
given house number is entered on the input and that number falls within the range
of the USPS ZIP + 4 file, the address will be validated regardless of whether the house
number actually exists. Delivery Point Validation (DPV) allows you to determine
whether an actual address exists, right down to the apartment or suite level. DPV
allows you to validate that your address information is a physical address served by
the Postal Service. RDI allows you to determine if an address is a residential or
business delivery point.
NOTE: The DPV and RDI processing use a separate license from CODE-1 Plus. The
license must be loaded in order for this parameter to properly function.
Working With CODE-1 Plus
69
1
Parameter Reference
What is a Multiple Match?
A multiple match occurs when one part of an input address has the possibility of
coding several different ways in CODE-1 Plus. Below are examples of the different
types of multiple matches that can be Delivery Point Validated.
Input Addresses
Example of
Multiple
ZIP Code
Match
Example of
Multiple
ZIP Code and
Street Match
Example of
Multiple
Suffix Match
Example of
Multiple
Suffix/Directional
Correction Match
Example of
Multiple
Street Address
Match
Example of
Multiple
Carrier Route
Match
PO Box 155
New Yor k, N Y
CODE-1 Plus Results
PO Box 155
New York, NY 10002- 0155
PO Box 155
New York, NY 10008- 0155
1559 45th Street
Los Angeles, CA
67 Williams St
Woburn, MA 01801
1050 17th Str eet N
W ashington, DC
4 Calle 1
San Juan, PR
107 Pear l Street
Timpsin, TX 75975
1559 E 45th Street
Los Angeles, CA 90011- 4341
1559 W 45th Str eet
Los Angeles, C A 90062- 2045
67 W illiams Ct
Wobur n, MA 01801-1738
67 Williams Ln
Wobur n, MA 01801-1216
1050 17th St N W
Washington, DC 20036-5503
1050 17th St NE
Washington, DC 20036-7362
4 C alle 1
San Juan PR 00926-1408
4 Calle 1
San Juan PR 00927-4629
Two post
offices
boxes have
the same
number, but
different ZIP
Codes.
Two streets
with the
same name,
but with
different ZIP
Codes.
67 Williams
S treet in
Woburn, MA
does not
exist, but
both 67
W illiams Ct
and 67
Williams Ln
do exist.
17th St N
does not
exist in
Washington
DC, but
there is both
a 17th St
NW and a
17th St NE.
In San Juan,
there are two
streets called
Calle 1 with
the same
hous e
number.
Two different Carrier Routes
result for this address after
processing by CODE-1 Plus:
R002 and R003
Figure 1: Examples of Multiple Matches in CODE-1 Plus
70
Software Release 4.0.0/March 2015
DPVIN Parameter Record
1
Field-by-Field
Table 18: DPVIN Parameter Fields (Part 1 of 4)
Position
Field Name
Description
Comments
1-6
KEYWORD
DPVIN is the only acceptable entry.
Required.
8
Multiple Match
Option - ZIP CODE
AND PO BOX OR
RURAL ROUTE/
HIGHWAY
CONTRACT
ADDRESS TYPE
If your input file contains multiple matches of
the ZIP Code and the PO Box or Rural Route/
Highway Contract:
Optional.
Default is Y.
Multiple Match
Option - ZIP CODE
AND STREET
ADDRESS TYPE
If your input file contains multiple matches of
the ZIP Code and the street address type:
Multiple Match
Option - CARRIER
ROUTE
If your input file contains multiple matches of
the Carrier Route in CODE-1 Plus:
10
12
14
16
18
Working With CODE-1 Plus
Multiple Match
Option DIRECTIONAL
Multiple Match
Option - SUFFIX
Multiple Match
Option - SUFFIX/
DIRECTIONAL
CORRECTION
Y
Yes, attempt to DPV confirm.
N
No, do not attempt to DPV confirm.
Y
Yes, attempt to DPV confirm.
N
No, do not attempt to DPV confirm.
Y
Yes, attempt to DPV confirm.
N
No, do not attempt to DPV confirm.
If your input file contains multiple matches of
the directional:
Y
Yes, attempt to DPV confirm.
N
No, do not attempt to DPV confirm.
If your input file contains multiple matches of
the suffix:
Y
Yes, attempt to DPV confirm.
N
No, do not attempt to DPV confirm.
If your input file contains multiple matches of
the suffix/directional correction:
Y
Yes, attempt to DPV confirm.
N
No, do not attempt to DPV confirm.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
71
1
Parameter Reference
Table 18: DPVIN Parameter Fields (Part 2 of 4)
Position
20
Field Name
Multiple Match
Option - MULTIPLE
INPUT SECONDARY
COMPONENTS WITH
NO DESIGNATOR
Description
Comments
If your input file contains multiple matches of
the secondary components with no designator:
Y
Yes, attempt to DPV confirm.
N
No, do not attempt to DPV confirm.
Optional.
Default is Y.
NOTE: By selecting N you will generate a nonCASS-certified configuration. No PS Form
3553 will be generated.
Below is an example of secondary components
with no designator:
John Jones
12 Main St. #12 #5
New York, NY 10012
#12 and #5 have no indication of being an
apartment, PO Box or otherwise.
22
24
UNIQUE ZIP/SMALL
TOWN DEFAULT ZIP
+ 4 ASSIGNMENT
OPTION
DPV SECONDARY
ADDRESS
VALIDATION
If an address has been assigned a ZIP + 4 by
CODE-1 Plus during regular processing, you
may select one of the following options
regarding this ZIP + 4 assignment:
Y
Yes, attempt to DPV confirm.
N
No, do not attempt to DPV confirm.
DPV automatically attempts to validate
primary and secondary information on input
addresses. Then, if no match is made, DPV will
attempt to validate using the primary
information only. Turning off this option will
reduce the number of look-ups to DPV files
and may increase processing. Select one of
the following:
Y
Perform DPV validation using
secondary address information.
N
No, do not perform DPV validation
using secondary address information.
Selecting this value will generate a
non-CASS certified configuration
Optional.
Default is Y.
Optional
Default is Y
NOTE: By selecting N you will generate a nonCASS-certified configuration. No PS Form
3553 will be generated.
26
72
CMRA LOOKUP
This option allows you to determine whether
or not an input address is a Commercial Mail
Receiving Agency (CMRA). Select one of the
following:
Y
Yes, perform CMRA lookup.
N
No, do not perform CMRA lookup.
Optional
Default is Y
Software Release 4.0.0/March 2015
DPVIN Parameter Record
1
Table 18: DPVIN Parameter Fields (Part 3 of 4)
Position
28
Field Name
PBSA LOOKUP
Description
DPV processing uses the PBSA Table to
identify P. O. Box Street Addresses (PBSA).
PBSA addresses are street addresses that
really represent a USPS P. O. Box. This field
determines whether CODE-1 Plus uses the
PBSA Table to return the PBSA result in
output.
Comments
Optional.
Default is N.
• Blank — Do not perform PBSA lookup.
• Y — Yes, perform PBSA lookup.
• N — No, do not perform PBSA lookup.
NOTE: If you specify "Y", you must define a
location for the DPV PBSA Flag in positions
32-34 of the DPVOUT parameter (location on
the output record for a 1-character code
indicating whether this address was found in
the PBSA table).
52
54
Working With CODE-1 Plus
RDI INDICATOR
DPV File Option
This option allows you to choose whether to
perform RDI processing.
Blank
Do DPV processing only.
Y
Attempt both DPV and RDI processing.
N
Do not attempt DPV processing.
Perform RDI processing only. If you
specify “N” in position 52, you will
generate a non-CASS-certified
configuration and CODE-1 Plus will
not generate a USPS Form 3553.
This option allows you to specify the DPV file to
match against.
Blank
Process the DPV split file.
S
Process the DPV split file.
F
Process the DPV flat file.
H
Process the DPV full (hash) file.
Optional.
Default is
blank.
Required.
Default is
blank.
73
1
Parameter Reference
Table 18: DPVIN Parameter Fields (Part 4 of 4)
Position
56
Field Name
DPV Memory Module
Size Indicator
58
CMRA/PMB
CONVERSION
INDICATOR
(CONVERT
SECONDARY
INFORMATION TO
PMB?)
Description
Comments
This option allows you to specify size of DPV
module.
Blank
DPV process will be using Medium
memory model (default).
P
Pico memory model (no files in
memory).
U
Micro memory model (no files in
memory, only indexes).
S
Small memory model (HSC and HSF in
memory).
M
Medium memory model (LCD also in
memory).
L
Large memory model (HSX also in
memory).
H
Huge memory model (all files in
memory).
This option allows you to specify whether to
convert secondary information to PMB.
Required.
Default is
blank.
Optional.
Default is N.
• Blank — Do not convert secondary
information to PMB.
• Y — Yes, convert secondary information to
PMB where appropriate.
• N — No, do not convert secondary
information to PMB.
Example
In the following example parameter record we specify:
•
Multiple Match Option for the ZIP Code and PO Box or Rural Route/Highway
Contract address type
•
Multiple Match Option for the ZIP Code and street address type
•
Multiple Match Option for the Carrier Route
•
Multiple Match Option for the Directional.
....+....1....+....2....+....3....+....4....+....5....+....6
DPVIN..Y.Y.Y.Y.N.N.N.N......................................
74
Software Release 4.0.0/March 2015
DPVOUT Parameter Record
1
DPVOUT Parameter Record
The optional DPVOUT parameter posts all answers from DPV and RDI processing.
For more information on DPV and RDI, refer to Chapter 5, "Using Delivery Point
Validation".
DPV Footnote Codes are 2-character, USPS-defined codes that represent the changes
that were made to the input address during the matching process. Up to 10 of these
codes can be stored by CODE-1 Plus for each record. Even if your address is not
presented for DPV processing, those footnote codes that pertain to the match to the
ZIP + 4 database will be returned.
NOTE: The DPV and RDI processing add-on options must be licensed in order for
this parameter to properly function.
Field-by-Field
Table 19: DPVOUT Parameter Fields (Part 1 of 5)
Position
Field Name
Description
Comments
1-6
KEYWORD
DPVOUT is the only acceptable entry.
Required.
8-10
Location for
DPV RETURN CODE
Location on the output record for a
1-character DPV Return Code. The DPV Return
Codes are listed below:
Optional
Working With CODE-1 Plus
M
Unable to Multiple Condition resolve.
N
No Delivery Point Validation.
Y
Delivery Point validated. Primary
number valid and second number
(when present) valid.
S
Valid primary number; but secondary
number (primary for Rural Route)
present and is not confirmed. Also,
can indicate that the house range
contained a single trailing alpha that
was dropped to attempt Delivery Point
Validation.
D
Valid primary number; input missing
secondary number (primary Rural
Route).
Blank
Address not presented to DPV table.
75
1
Parameter Reference
Table 19: DPVOUT Parameter Fields (Part 2 of 5)
Position
12-14
Field Name
Location for
DPV CMRA FLAG
Description
Comments
In this field, you indicate the location on the
output record for a 1-character Commercial
Mail Receiving Agency (CMRA) Flag (indicates
a private business that acts as a mailreceiving agent for specific clients). This field
contains the results of the call to the DPV
CMRA Hash Table (dph.hsc):
Y
Yes, address was found in CMRA
table.
N
No, address was not found in CMRA
table.
Blank
Address not presented to hash table.
Optional
NOTE: The CMRA lookup automatically occurs
when the DPV return code is Y or S, unless
otherwise specified in the DPVIN parameter
record.
16-18
Location for
DPV FALSE/
POSITIVE FLAG
If the DPV return code is N, CODE-1 Plus will
automatically begin a false/positive look-up. In
this field, you indicate the location on the
output record for a 1-character False/Positive
Flag:
Y
False.
N
Not false.
Blank
Not presented.
Optional
NOTE: A Y indicates that you have hit a “seed
record” in your processing.
76
Software Release 4.0.0/March 2015
DPVOUT Parameter Record
1
Table 19: DPVOUT Parameter Fields (Part 3 of 5)
Position
20-22
Working With CODE-1 Plus
Field Name
Location for
DPV FOOTNOTE
CODES
Description
Location on the output record for a
20-character area to accommodate DPV
Footnote Codes.
AA
Input address matched to the ZIP + 4
file.
A1
Input address not matched to the ZIP +
4 file.
BB
Input address matched to DPV (all
components).
CC
Input address primary number
matched to DPV but secondary
number not match (present but not
valid).
F1
Input address is military; DPV
bypassed.
G1
Input address is general delivery; DPV
bypassed.
M1
Input address primary number
missing.
M3
Input address primary number invalid.
N1
Input address primary number
matched to DPV but high rise address
missing secondary number.
P1
Input address missing RR or HC Box
number.
P3
Input address missing PO, RR, or HC
Box number.
PB
Input address is a P. O. Box Street
Address (PBSA).
RR
Input address matched to CMRA.
R1
Input address matched to CMRA but
secondary number not present.
R7
Input address matched to phantom
carrier route R777 (not eligible for
street delivery).
U1
Input address is unique ZIP; DPV
bypassed.
Comments
Optional
77
1
Parameter Reference
Table 19: DPVOUT Parameter Fields (Part 4 of 5)
Position
24-26
Field Name
Location for NO
STAT FLAG
Description
Comments
A 1-character code indicating the presence of
statistics for this address. A “Y” indicates that
the address is not a valid delivery address even
though it has been validated by DPV.
Blank
Not presented
Y
Found match to ‘No Stat’ DPV hash
table
N
No match found to “No stat” DPV hash
table.
Optional.
No default.
NOTE: If this option is present in the DPVOUT
parameter, the DPV DLL will look up
addresses in the “No Stat” table. If this
position is blank, CODE-1 Plus will not look
up address in the “No Stat” table.
28-30
Location for VACANT
TABLE FLAG
A 1-character code indicating that this address
was found in the Vacant table.
Blank
Not presented
Y
Indicates that the address has been
vacant for at least last 90 days.
N
Indicates that the address is not
vacant.
NOTE: If this option is present in the DPVOUT
parameter, the DPV DLL will perform an
address search in the “Vacant” table,
otherwise, for performance reasons, DPV
will not look up the address in the “Vacant”
table.
32-34
Location for DPV
PBSA FLAG
Location on the output record for a 1character code indicating whether this
address was found in the PBSA table.
Optional.
No default.
• Blank — Not presented
• Y — Found in the DPV PBSA Table.
• N — Not found in the DPV PBSA Table.
NOTE: If you specify a location for the DPV
PBSA Flag, you must specify "Y" in position
28 of the DPVIN parameter (PBSA Lookup).
DPVIN position 28 determines whether
CODE-1 Plus uses the PBSA Table to return
the PBSA result in output. If you specify a
value for DPVOUT positions 32-34 and do not
specify "Y" in position 28 of the DPVIN
parameter (PBSA Lookup), a parameter
error occurs.
78
Software Release 4.0.0/March 2015
DPVOUT Parameter Record
1
Table 19: DPVOUT Parameter Fields (Part 5 of 5)
Position
50-52
54-56
Field Name
Location for
RESIDENTIAL FLAG
Location for
BUSINESS FLAG
Description
In this field, you indicate the location on the
output record for a 1-character Residential
Flag:
Blank
Not a residential delivery point.
R
Yes, this address is a residential-only
delivery point.
In this field, you indicate the location on the
output record for a 1-character Business Flag:
Blank
Not a business delivery point.
B
Yes, this address is a business-only
delivery point.
M
Yes, this address is mixed residential
and business delivery point.
Comments
Optional.
No default.
Optional.
No default.
NOTE: You can only receive a business flag of
M if you have enabled the business flag option
in position 58.
58
BUSINESS FLAG
OPTION
This option enables you to have two different
business flag values returned in the Business
Flag output location (specified in position 5456):
Blank
Return B for all Business Delivery
Points.
R
Return Residential Delivery Points.
M
Return M for Mixed Business and
Residential Delivery Points.
Optional.
NOTE: The “M” option is a combination of
both residential and business deliveries for
that ZIP + 4, but is considered a business
delivery point by the USPS, for example a
Highrise.
59
TERMINATE DPV
PROCESSING
This option allows DPV to stop batch jobs when
a false-positive (seed record) has been
encountered:
S
Shuts down CODE-1 Plus processing
when a false-positive (seed record) is
encountered.
W
Allows CODE-1 Plus to continue
processing to completion of the entire
job, generating form 3553.
Optional
Default: W
NOTE: CODE-1 Plus will output to the
execution log the seed record information
necessary to reactivate the DPV license.
Working With CODE-1 Plus
79
1
Parameter Reference
Example
In the following example parameter record we specify:
•
The DPV Return Code should be stored in position 120
•
The DPV CMRA Flag should be stored in position 122
•
The DPV False/Positive Flag should be stored in position 124.
•
The DPV Footnote Codes should be stored in position 126.
....+....1....+....2....+....3....+....4....+....5....+....6
DPVOUT.120.122.124.126.....................................
80
Software Release 4.0.0/March 2015
EXITOP Parameter Record
1
EXITOP Parameter Record
The optional EXITOP parameter names an operating exit routine that you want
CODE-1 Plus to call after the record has been processed but before it is written to an
output file. The only system-defined field on this parameter contains the name of the
operating exit routine. You can use the remaining 63 bytes to specify information
that your exit routine needs.
Note that if you have also specified an output exit routine, the operating exit routine
specified on the EXITOP parameter is called first. The operating exit routine then
does its processing and passes the record back to CODE-1 Plus. CODE-1 Plus then
passes the same record to the output exit routine that you have specified for that
specific output file.
CODE-1 Plus will call your exit routine with the following four parameters in the
linkage section:
•
•
PARM1: This parameter is 1-character, which will contain one of the following
codes to tell your program what type of processing is to be performed:
–
O for open the output file
–
W for write a record to the output file
–
C for close the output file.
PARM2: This parameter is the output file indicator.
If you are using Pitney Bowes’s Barcoding Option or another exit routine that you
used with CODE-1 Plus, you must place a P in column 7 of the EXITOP parameter,
and you must indicate the file identifiers on your parameter (see your Barcoding
Option documentation for specific placement). CODE-1 Plus will then pass one
of the following 2-byte file identifiers to your exit routine: OK for C1BMCOK; CO
for C1BMNCO; ZP for C1BMIZP; or P4 for C1BMZP4.
If you are not using one of the Pitney Bowes exit routines, and you do not put a
“P” in column 7, one of the following 7-byte file identifiers will be passed:
C1BMCOK, C1BMNCO, C1BMIZP, or C1BMZP4.
•
PARM3: This parameter contains the output record to be passed from
CODE-1 Plus to your program. The length of this parameter will be the length of
the output record as defined on the FILEDF parameter for the output file named
in PARM2, above. This parameter is only valid when PARM1 is set to “W” in order
to write a record to the output file.
•
PARM4: This parameter contains the image of your EXITOP parameter, and is 80
bytes in length.
Working With CODE-1 Plus
81
1
Parameter Reference
Field-by-Field
Table 20: EXITOP Parameter Fields
Position
82
Field Name
Description
Comments
1-6
KEYWORD
EXITOP is the only acceptable entry.
Required.
7
CODE-1 PLUS
IDENTIFIER
If you are going to use this program with
the Pitney Bowes Barcoding Option, or
the Geocoder, you must enter “P” in this
position and then use the 2-character
file identifiers as parameter 2.
Optional.
Use only if you
are using 2character file
identifiers as
parameter 2 in
your linkage
section.
8-17
OPERATING EXIT
ROUTINE NAME
Name of the exit routine that you want
CODE-1 Plus to call before writing each
record to an output file (or before calling
an output exit routine).
Required.
No Default.
Name must be
left-justified.
18-80
USER-DEFINED
DATA
Enter any information that you need
CODE-1 Plus to pass to your exit routine.
Optional.
No default.
Software Release 4.0.0/March 2015
FILEDF Parameter Record
1
FILEDF Parameter Record
The required FILEDF parameter is used to identify your input and output file
structures, as well as any input or output exit routine that you want CODE-1 Plus to
call with this job.
This information tells CODE-1 Plus what files to use, and what to do each time
CODE-1 Plus is ready to read a record from the input file or write a record to an
output file.
File Names
CODE-1 Plus has five file names that you will use for your input file and output files,
regardless of their actual dataset names. You use CODE-1 Plus-defined file names on
the FILEDF parameter, but you will use your own file names in the JCL you write to
run a CODE-1 Plus batch file.
Table 21: Valid File Names for the FILEDF Parameter
File Name
Description
C1BMNAM —
This is your input name-and-address file. C1BMNAM stands for CODE-1
Plus Batch Match Name file. This file is designated as C1BMNAM in the job
control file (JCL, DCL, Script, etc.).
C1BMCOK —
This is the output file to which CODE-1 Plus writes all of the records that
are verified or corrected. C1BMCOK stands for CODE-1 Batch Match
Coded OK. This file is designated as C1BMCOK in the job control file (JCL,
DCL, Script, etc.).
C1BMNCO —
This is the output file to which CODE-1 Plus writes all of the records that
have valid input ZIP Codes (i.e., the ZIP Code was valid somewhere in the
U.S.) but were not matched for some reason. C1BMNCO stands for
CODE-1 Batch Match Not Coded. This file is designated as C1BMNCO in
the job control file (JCL, DCL, Script, etc.).
C1BMIZP —
This is the output file to which CODE-1 Plus writes all of the unmatched
records that have invalid input ZIP Codes. An invalid input ZIP Code is one
that is not valid anywhere in the U.S. C1BMIZP stands for CODE-1 Batch
Match Invalid ZIP. This file is designated as C1BMIZP in the job control file
(JCL, DCL, Script, etc.).
C1BMZP4 —
This is the output file to which CODE-1 Plus writes all of the records that
were ZIP + 4 coded. C1BMZP4 stands for CODE-1 Batch Match ZIP + 4. This
file is designated as C1BMZP4 in the job control file (JCL, DCL, Script,
etc.).
C1BMSTA —
This is the output file to which CODE-1 Plus writes all of the output
statistics. These records are fixed length. The only required field on the
parameter is record length, positions 19-22, and may be any numeric
value.
Working With CODE-1 Plus
83
1
Parameter Reference
Exit Routines
The FILEDF parameter allows you to specify an input exit routine that CODE-1 Plus
should call each time it is ready to read a record from your input name-and-address
file, or the output exit routine that CODE-1 Plus should call each time it is ready to
write a record to your output file. If you are using an input exit routine, CODE-1 Plus
calls your exit routine—rather than reading the record—and waits for the exit
routine to pass a record back. If you are using an output exit routine, CODE-1 Plus
passes the record to the output exit routine, instead of writing the record to the file.
For example, you might have an input exit routine named CODEIT that adds a special
code to a record. If you want to add that code to each record before the record is
passed to CODE-1 Plus, you would specify CODEIT as the name of the exit routine.
Then, every time CODE-1 Plus is ready to accept a record, it passes control to
CODEIT, which reads the record, adds the code to the record, and then passes the
record to CODE-1 Plus so that CODE-1 Plus can process that record.
When you use the FILEDF parameter to call an exit routine, CODE-1 Plus will call that
exit routine with the following four parameters in the linkage section at each I/O
request.
•
84
PARM1—a total of 9 bytes and has two components, as follows:
–
Bytes 1-8: The file name (C1BMNAM, C1BMCOK, C1BMNCO, C1BMIZP, or
C1BMZP4)
–
Byte 9: Function indicator. This byte will contain one of the following codes
to tell your program the type of processing to perform:
–
O to Open the input or output file
–
R to Read a record from the input file
–
W to Write a record to the output file
–
C to Close the input or output file.
•
PARM2—a 5-digit length (less than or equal to 32,760) packed into a 3-byte
field (COBOL “PIC S9(5) COMP-3”). This parameter must be filled in by your exit
routine if byte 9 of PARM1 is O or R. When byte 9 of PARM1 is R, the input exit
routine signals the end of the file by setting this to 0.
•
PARM3—contains the output record to be passed from CODE-1 Plus to your
program (when EXITFC is W), or the input record to be passed from your program
to CODE-1 Plus (when EXITFC is R). The length of this parameter will be the
length specified by the exit routine in PARM2 above (maximum of 32,760).
•
PARM4— contains the image of your FILEDF parameter and is 80 bytes in
length.
Software Release 4.0.0/March 2015
FILEDF Parameter Record
1
Limiting Processing With FILEDF
There are three ways to limit the number of records CODE-1 Plus processes. First, you
can skip a portion of the file before any records are selected. Second, you can enter
a fraction to select a portion of the records, evenly spaced throughout the file. Third,
you can specify a maximum number of records that should be processed; in this case
CODE-1 Plus will start at the beginning of the file and process every record until the
maximum number is reached.
You can use these fields in conjunction with each other. For example, you could enter
a number of records to skip, and a maximum number of records to read if you wanted
to process the middle of the file, but not the beginning or the end.
Fractional Record Selection
The fractional record selection feature enables you to sample records throughout the
file, from beginning to end, without processing consecutive records. To determine
the number to enter in this 7-byte field, divide the number of records you want to
process by the number of records in the file. This will give you a decimal number.
Drop the decimal, and enter the first 7 digits of the number. For example, you have a
file with 102986 records, and you want to process 2000 records. You would divide
2000 by 102986 and get .0194201153. Dropping the decimal, you would enter
0194201 in the fractional record selection field. This will ensure that the 2,000
records processed are evenly distributed throughout the file.
NOTE: The maximum sample is every other record (half of the file). If you enter a
fraction greater than .5000000, the record selection process yields every record
in the file.
NOTE: Limiting the number of records to process (by skipping records, specifying
a maximum, or sampling the file) should be done on the input FILEDF parameter.
If you limit processing on an output FILEDF parameter, CODE-1 Plus will process
all of your input records, but will limit the number of records written to the output
file.
Working With CODE-1 Plus
85
1
Parameter Reference
Field-by-Field
Table 22: FILEDF Parameter Fields (Part 1 of 3)
Position
Field Name
Description
Comments
1-6
KEYWORD
FILEDF is the only acceptable entry.
Required.
8-15
FILE NAME
Name of the input or output file. Enter one of
the following names:
Required.
No default.
C1BMNAM Input file
C1BMCOK Matched records output file
C1BMNCO Unmatched records output file
C1BMIZP Invalid ZIP Code output file.
C1BMZP4 ZIP + 4 coded records output file.
C1BMSTA Output statistics file. The only
required field on the parameter is
record length, positions 19-22, and
may be any numeric value.
17
RECORD FORMAT
Code indicating the format of the input and
output file records. Enter one of the following
codes:
F
Fixed length with no end of record
delimiter, pads with blanks to set
record length (byte stream,
mainframe fixed blocked and
unblocked).
V
Mainframe and HPUX OpenVMS/VAX
input and output files
Required.
Default is F.
NOTE: Not
valid for file
C1BMSTA.
MVS: 4-byte record.
OpenVMS: 2- or 4-byte record.
L
Line-sequential with delimiter(s) at
end of record.
Unix: New line, 1 byte.
U
Records are variable-length and the
file contains an end-of-file indicator.
(Unix environments only)
NOTE: Under Unix, and Windows, variable
means ACUCOBOL-GT variable format files.
Output files can also be variable in Unix and
Windows.
19-22
RECORD LENGTH
The length, in bytes, of the records in the file.
For variable-length records, this is the
maximum record length.
NOTE: If you need to enter a 5-digit number,
use columns 18-22.
86
Required,
except for
MVS.
No default.
Maximum is
32,760.
Software Release 4.0.0/March 2015
FILEDF Parameter Record
1
Table 22: FILEDF Parameter Fields (Part 2 of 3)
Position
24-28
Field Name
BLOCK SIZE
Description
The size, in bytes, of the blocks in the file.
Comments
Required,
except for
MVS, Unix, and
VAX.
No default.
NOTE: Not
valid for file
C1BMSTA.
30-33
DEVICE TYPE
The type of device on which this file resides.
Enter one of the following codes:
TAPE
2311
2314
3310
3330
3340
3350
3370
3375
3380
FBA
34
TAPE REEL
HANDLING
NOTE: Not
valid for file
C1BMSTA.
Code indicating how to handle tape reels.
Enter one of the following codes:
Blank
Not used for
MVS, Unix, or
VAX.
Default is
TAPE.
Tape reels are rewound at open or
close operations. For non-labeled
tapes, this will be changed to “U” if a
multi-reel situation is detected.
M
Tape input file consists of more than
one standard-label file. The operator
will be queried for EOF/EOV at the end
of each of the input files.
U
Tape reels are rewound at open
operations and unloaded at close
operations.
X
Tape reels are not repositioned at
either open or close operations.
Not used for
MVS.
Default is
blank.
NOTE: Not
valid for file
C1BMSTA.
In general, use blank for intermediate
references to a single-reel file; “U” for multireel files and for the final reference to a
single-reel file; and “X” for files that require
non-standard positioning of tape reel (which
can be accomplished via MTC commands or
the equivalent).
35
LABEL TYPE
Working With CODE-1 Plus
Code indicating whether the records on the file
have standard or omitted labels. Enter one of
the following codes:
N
No labels
S
Standard labels.
Default is S.
NOTE: Not
valid for file
C1BMSTA.
87
1
Parameter Reference
Table 22: FILEDF Parameter Fields (Part 3 of 3)
Position
39-46
Field Name
EXIT ROUTINE
NAME
Description
Comments
Name of the input exit routine that should be
called when CODE-1 Plus is ready to read a
record from this file, or the name of the output
exit routine that should be called when CODE1 Plus is ready to write a record to the file.
Optional.
No default.
Name must be
entered leftjustified.
NOTE: Not
valid for file
C1BMSTA.
50-56
NUMBER OF
RECORDS TO SKIP
Number of records CODE-1 Plus should skip
before selecting the first record.
Optional.
No default.
NOTE: Not
valid for file
C1BMSTA.
58-64
66-72
88
FRACTIONAL
RECORD
SELECTION
MAXIMUM
NUMBER OF
RECORDS
Number indicating the fraction of records in
the file that should be processed. CODE-1 Plus
assumes a decimal point before the first digit.
Optional.
No default.
NOTE: A number greater than 5000000 selects
the entire file.
NOTE: Not
valid for file
C1BMSTA.
Maximum number of records CODE-1 Plus
should read from or write to this file.
Optional.
No default.
NOTE: Not
valid for file
C1BMSTA.
Software Release 4.0.0/March 2015
FIRMNM Parameter Record
1
FIRMNM Parameter Record
The optional FIRMNM parameter is used to tell CODE-1 Plus about the location and
length of firm names (company names) in the input record.
The standardized firm name is the firm name derived from an address match and is the
firm name stored from the USPS ZIP + 4 database file. Alternatively, it may be the
input firm name in uppercase format when the standardized firm name could not be
derived from a successful address match.
If you include the FIRMNM parameter in your job, when CODE-1 Plus processes a
record, it compares the firm name in the input record with firm names that are
associated with the matched address. Each firm name has a ZIP + 4 Code associated
with it. The ZIP + 4 Codes associated with firm names are more specific than other
ZIP + 4 Codes. If a firm name match is found, CODE-1 Plus will assign that ZIP + 4
Code to the record instead of the ZIP + 4 Code that would be assigned based on the
address alone. For example, let’s consider the high-rise office building where an
address is located. The building, which has six floors, has the ZIP + 4 Code of 1852.
There are 4 firms within this building that are assigned ZIP + 4 Codes by the USPS,
as follows:
Suite Number
204
300
600
600
Firm Name
State Farm
Maxima
Comnet
PB Software
ZIP + 4 Code
1805
1834
1882
1844
Mail that is addressed to one of these suites and does not have a firm name is assigned
a ZIP + 4 Code of 1852, which is the default building code for the high-rise building.
Mail that contains one of the firm names shown above is assigned the appropriate ZIP
+ 4 Code for the firm, regardless of suite number.
For instance:
Input Address
PITNEY BOWES SOFTWARE
ONE GLOBAL VIEW
ZIP + 4 Code Assigned
ONE GLOBAL VIEW
1852
PITNEY BOWES SOFTWARE
ONE GLOBAL VIEW
1844
ONE GLOBAL VIEW
1852
Working With CODE-1 Plus
1844
89
1
Parameter Reference
CODE-1 Plus will append a missing suite to the address if a firm name was obtained.
A missing suite is appended only if the input suite was missing and a match to the firm
name was found. The following example shows how CODE-1 Plus appends a missing
suite.
The apartment return code is “F” when this happens.
NOTE: USPS CASS regulations require SuiteLink processing for CASS certification
and to generate the USPS Form 3553 (USPS CASS Summary Report).
NOTE: The FIRMNM parameter is required when you use the STELNK parameter
to perform SuiteLink processing.
Field-by-Field
Table 23: FIRMNM Parameter Fields (Part 1 of 2)
Position
Field Name
Description
Comments
1-6
KEYWORD
FIRMNM is the only acceptable entry.
Required.
8-10
Location of
FIRM NAME
Specify one of the following to indicate
the location of the firm name in the input
record.
Required.
No default.
nnn
Specify 1-4 numerics to indicate
the location of the firm name in
your input record.
U
Specify U in position 8 to indicate
the firm name is located within
specified input address lines.
NOTE: If U is used in this field, the option
L is required in the ADDRDF parameter
in position 8.
90
Software Release 4.0.0/March 2015
FIRMNM Parameter Record
1
Table 23: FIRMNM Parameter Fields (Part 2 of 2)
Position
Field Name
Description
Comments
12-13
Length of
FIRM NAME
Length of the firm name in the input
record (the maximum is 40).
Required if an
input location is
specified in
positions 8-10.
No default.
15-17
Location for
STANDARDIZED
FIRM NAME
Location for the standardized firm name
on the output record.
Optional.
No default.
19-20
Length of
STANDARDIZED
FIRM NAME
Length of the standardized firm name on
the output record.
Optional.
No default.
72
FIRM NAME
DISPOSITION
INDICATOR
Code indicating what should be stored in
cases where the standardized firm name
was not stored, because no address
match was found, or a multiple address
match was found. Enter one of the
following codes:
Optional.
Default is I.
Working With CODE-1 Plus
I
Store the extracted input.
B
Store blanks.
X
Store nothing.
91
1
Parameter Reference
G9 OUT Parameter Record
The optional G9 OUT parameter is used to define output storage locations for the
elements returned by Geographic Coding Plus and GeoTAX. These elements are
written to records in the C1BMCOK and C1BMZP4 files for all records successfully
coded by Geographic Coding Plus or GeoTAX. If you include this parameter in your
CODE-1 Plus job, you must also include the G9ZIP9 parameter. Please refer to the
User’s Guide that you received with your Geographic Coding or GeoTAX software for
details.
NOTE: You must have Geographic Coding Plus or GeoTAX for CODE-1 Plus to
process this parameter.
Field-by-Field
Table 24: G9 OUT Parameter Fields (Part 1 of 2)
Position
Field Name
Description
Comments
1-6
KEYWORD
G9 OUT is the only acceptable entry.
Required.
8-10
Location for
GENERAL
RETURN CODE
Location on the output record for the
1-character General Return Code. One of
the following codes is stored:
Optional.
No default.
12-14
Location for
CENSUS
GEOCODE
Blank
No 5-digit ZIP Code match was
found.
5
5-Digit ZIP Code match was
successful.
9
9-Digit ZIP Code match was
successful.
The starting location on the output record
for the following information:
Optional.
No default.
2-character FIPS state code
3-character FIPS county code
6-character census tract
1-character census block group.
92
16-18
Location for
FIPS STATE CODE
Location on the output record for the
2-character FIPS state code.
Optional.
No default.
20-22
Location for
FIPS COUNTY
CODE
Location on the output record for the
3-character FIPS county code.
Optional.
No default.
24-26
Location for
CENSUS TRACT
Location on the output record for the
6-character census tract.
Optional.
No default.
Software Release 4.0.0/March 2015
G9 OUT Parameter Record
1
Table 24: G9 OUT Parameter Fields (Part 2 of 2)
Position
Field Name
Description
Comments
28-30
Location for
CENSUS BLOCK
GROUP
Location on the output record for the
1-character census block group.
Optional.
No default.
32-34
Location for
STATE
ABBREVIATION
Location on the output record for the
2-character state abbreviation.
Optional.
No default.
36-38
Location for
COUNTY NAME
Location on the output record for the
20-character county name.
Optional.
No default.
40-42
Location for
MSA CODE
Location on the output record for the
4-character MSA code.
Optional.
No default.
44-46
Location for
MSA NAME
Location on the output record for the
50-character MSA name.
Optional.
No default.
48-50
Location for
LATITUDE/
LONGITUDE
Location on the output record for the
16-character latitude/longitude (4-decimal
precision).
Optional.
No default.
52-54
Location for
LATITUDE/
LONGITUDE
LEVEL
Location on the output record for the
1-character latitude/longitude level.
Optional.
No default.
56-58
Location for
LATITUDE/
LONGITUDE
COORDINATE
Location for latitude/longitude coordinate
(6-decimal precision).The coordinate has a
total length of 20 characters: 9 digits
(decimal implied after sixth position), 1
directional, 9 digits (decimal implied after
sixth position), 1 directional.
Optional.
No default.
Working With CODE-1 Plus
93
1
Parameter Reference
G9XOUT Parameter Record
The optional G9XOUT parameter is used to define output storage locations for
elements returned by Geographic Coding Plus or GeoTAX. These elements are in
addition to those returned via the G9 OUT parameter. If you include this parameter
in your CODE-1 Plus job, you must also include the G9ZIP9 parameter. Please refer
to the User's Guide that you received with your Geographic Coding or GeoTAX
software for details.
NOTE: You must have Open Systems Geographic Coding Plus or GeoTAX for
CODE-1 Plus to process this parameter. Please refer to the Geographic Coding Plus
or GeoTAX User’s Guide for details.
This parameter defines the following for GeoTAX customers:
•
Location for the Place Code
•
Location for the Place Name
•
Location for the Class Code
•
Location for the Incorporated Flag
•
Location for last annexed date
•
Location for last updated date
•
Location for last verified date
•
Location for the GeoTAX output key
•
Location for the GeoTAX Return Code
This parameter also includes the following for Geographic Coding customers:
•
Location for the PRIZM Cluster
•
Location for the PRIZM Cluster Code Name
•
Location for the PRIZM Social Group Code
•
Location for the PRIZM Social Group Name
Additionally, the following options are available for both GeoTAX and Geographic
Coding customers:
•
Location for the Minor Civil Division/Census Civil Division (MCD/CCD)
•
Location for the Confidence Code
These elements are written records in the C1BMCOK and C1BMZP4 files for all
records successfully coded by Geographic Coding Plus or GeoTAX.
94
Software Release 4.0.0/March 2015
G9XOUT Parameter Record
1
NOTE: The GeoTAX output key and the GeoTAX Return Code options in this
parameter are only available to GeoTAX customers who are also licensed users of
the Vertex Quantum or ComTax21 products. Additional information on this
subject can be found in the GeoTAX User’s Guide.
Field-by-Field
Table 25: G9XOUT Parameter Fields (Part 1 of 3)
Position
Field Name
Description
Comments
1-6
KEYWORD
G9XOUT is the only acceptable entry.
Required.
8-10
Location for
PLACE CODE
Location on the output record for the
5-character place code.
Optional.
No default.
NOTE: This option is only available for
GeoTAX customers.
12-14
Location for
PLACE NAME
Location on the output record for the
40-character place name returned by
Geographic Coding Plus.
Optional.
No default.
NOTE: This option is only available for
GeoTAX customers.
16-18
Location for
MCD/CCD
Location on the output record for the
5-character Minor Civil Division/Census
County Division (MCD/CCD) returned by
Geographic Coding Plus.
Optional.
No default.
20-22
Location for
CONFIDENCE CODE
Location on the output record for the
4-character confidence code returned by
Geographic Coding Plus.
Optional.
No default.
NOTE: Spaces are used for the last three
characters for compatibility with prior
Geographic Coding releases.
24-26
Location for
PRIZM CLUSTER
Location on the output record for the
2-character PRIZM cluster returned by
Geographic Coding Plus.
Optional.
No default.
NOTE: This option is only available for
Geographic Coding customers.
28-30
Location for
PRIZM CLUSTER
CODE NAME
Location on the output record for the
20-character PRIZM cluster code name
returned by Geographic Coding Plus.
Optional.
No default.
NOTE: This option is only available for
Geographic Coding customers.
Working With CODE-1 Plus
95
1
Parameter Reference
Table 25: G9XOUT Parameter Fields (Part 2 of 3)
Position
32-34
Field Name
Location for
PRIZM SOCIAL
GROUP CODE
Description
Comments
Location on the output record for the
2-character PRIZM cluster social group
code returned by Geographic Coding Plus.
Optional.
No default.
NOTE: This option is only available for
Geographic Coding customers.
36-38
Location for
PRIZM SOCIAL
GROUP NAME
Location on the output record for the
20-character PRIZM cluster social group
name returned by Geographic Coding
Plus.
Optional.
No default.
NOTE: This option is only available for
Geographic Coding customers.
40-42
Location for
CLASS CODE
Location on the output record for the
2-character class code.
Optional.
No default.
NOTE: This option is only available for
GeoTAX customers.
44-46
Location for
INCORPORATED
FLAG
Location on the output record for the
1-character incorporated flag, which
specifies whether the place is
incorporated or unincorporated as stored
in the U.S. Department of Commerce FIPS
Place Code Roster. One of the following
codes is stored:
Blank
Not in a roster
I
Incorporated
O
Unincorporated.
Optional.
No default.
NOTE: This option is only available for
GeoTAX customers.
48-50
52-54
56-58
96
Location for
LAST ANNEXED
DATE
Location in the output record for the
7-character last annexed date (MM/YYYY).
Location for
LAST UPDATED
DATE
Location in the output record for the
7-character last updated date (MM/YYYY).
Location for
LAST VERIFIED
DATE
Location in the output record for the
7-character last verified date.
Optional.
No default.
NOTE: This option is only available for
GeoTAX customers.
Optional.
No default.
NOTE: This option is only available for
GeoTAX customers.
Optional.
No default.
NOTE: This option is only available for
GeoTAX customers.
Software Release 4.0.0/March 2015
G9XOUT Parameter Record
1
Table 25: G9XOUT Parameter Fields (Part 3 of 3)
Position
60-62
64-66
Field Name
Description
Location for
GEOTAX OUTPUT
KEY
Location in the output record for the
9-character GeoTAX output key.
Location for
GEOTAX RETURN
CODE
Location in the output record for the
GeoTAX return code.
Comments
Optional.
No default.
NOTE: This option is only available for
GeoTAX customers.
Blank
No matching GTMASTR GeoTAX
record found
E
Exact match using state/county/
place/ZIP Code/place name.
P
Partial match using state/county/
place
A
Alternate match using ZIP Code
and place name
N
Record is default coded based on
valid state code.
Optional.
No default.
NOTE: This option is only available for
GeoTAX customers.
Working With CODE-1 Plus
97
1
Parameter Reference
G9ZIP9 Parameter Record
The optional G9ZIP9 parameter is used to define the location and format of the ZIP
Code and ZIP + 4 Code for Geographic Coding Plus or GeoTAX. If you include the
G9 OUT and/or the G9XOUT parameters in your job, you must also include the
G9ZIP9 parameter.
NOTE: You must have Geographic Coding Plus or GeoTAX for this parameter to
be processed by CODE-1 Plus. Please refer to the User’s Guide that you received
with your Geographic Coding or GeoTAX software for details.
Field-by-Field
Table 26: G9ZIP9 Parameter Fields (Part 1 of 2)
Position
Field Name
Description
Comments
1-6
KEYWORD
G9ZIP9 is the only acceptable entry.
Required.
8-10
Location of
ZIP CODE
The location on the record, after address
matching has taken place, of the ZIP
Code that should be used for Geographic
Coding.
Required.
No default.
NOTE: In most cases, this is the output
location you specified on the Z5 OUT
parameter. However, you can specify the
location of the input ZIP Code if your
CODE-1 Plus output elements do not
over-write that location.
12
98
Format of
ZIP CODE
The format of the ZIP Code that can be
found in the location you specified in
positions 8-10. Enter one of the
following codes:
C
5-character format
P
3-character packed decimal
format.
Optional.
Default is C.
Software Release 4.0.0/March 2015
G9ZIP9 Parameter Record
1
Table 26: G9ZIP9 Parameter Fields (Part 2 of 2)
Position
14-16
Field Name
Location of
ZIP + 4 CODE
Description
The location on the record, after address
matching has taken place, of the ZIP + 4
Code that should be used for Geographic
Coding. If you leave this field blank, the
Geographic Coding results will be based
on the 5-digit ZIP Code only.
Comments
Optional.
No default.
NOTE: In most cases, this is the output
location you specified on the Z4 OUT
parameter. However, you can specify the
location of the input ZIP + 4 Code if your
CODE-1 Plus output elements do not
over-write that location.
18
Working With CODE-1 Plus
Format of
ZIP + 4 Code
The format of the ZIP + 4 Code that is
found in the location you specified in
positions 14-16. Enter one of the
following codes:
C
4-character format
P
3-character packed decimal
format.
Optional.
Default is C.
99
1
Parameter Reference
HEADER Parameter Record
The required HEADER parameter is used to specify a date and text to be printed at
the top of every page of each report and, if desired, to limit processing to a specified
ZIP Code range.
NOTE: Any date or text heading you specify prints at the top of the first page of
each report.
NOTE: The HEADER parameter is validated for correct start/stop ZIP Code
columns and for a blank in column 18 (between the date and heading text). An
error will occur if your parameter is not adjusted from previous releases.
Field-by-Field
Table 27: HEADER Parameter Fields
Position
100
Field Name
Description
Comments
1-6
KEYWORD
HEADER is the only acceptable entry.
Required.
8-17
DATE
The date that you want printed at the top
line of the first page of each report.
Optional.
Default is to print
the system date.
19-58
HEADING
The text you want to be printed on the top
line of every page of each report.
Optional.
No default.
60-64
START ZIP CODE
The lowest ZIP Code you want
CODE-1 Plus to process. Records with
lower ZIP Codes are ignored.
Optional.
No default.
67-71
STOP ZIP CODE
The highest ZIP Code you want
CODE-1 Plus to process. Records with
higher ZIP Codes are ignored.
Optional.
No default.
Software Release 4.0.0/March 2015
LACS Parameter Record
1
LACS Parameter Record
The optional LACS parameter indicates whether LACSLink processing is performed
and whether to perform LACSLink processing before or after the ZIP + 4 processing.
NOTE: USPS CASS regulations require LACSLink processing for CASS certification
and to generate the USPS Form 3553.
Field-by-Field
Table 28: LACS Parameter Fields (Part 1 of 2)
Position
Field Name
Description
Comments
1-4
KEYWORD
LACS is the only acceptable entry.
Required.
8
LACSLink Processing
Type
The type of LACSLink processing to be
performed:
Required.
Default is blank.
Z
10
TERMINATE LACS
Perform the ZIP + 4 processing
prior to LACSLink.
This option allows LACSLink to stop batch
jobs when a false-positive (seed record)
has been encountered:
S
Shuts down CODE-1 Plus
processing when a falsepositive (seed record) is
encountered.
W
Allows CODE-1Plus to continue
processing to completion of the
entire job, generating form
3553.
Optional
Default: W
NOTE: CODE-1 Plus will output to the
execution log the seed record
information necessary to reactivate
the LACSLink license.
Working With CODE-1 Plus
101
1
Parameter Reference
Table 28: LACS Parameter Fields (Part 2 of 2)
Position
14
Field Name
LACSLink Seed
Processing
Description
Comments
Y
Do not produce “99” return code
for LACS seed record
processing.
N
LACS seed record processing
results in “99” return code.
NOTE: An “S” in pos. 10 overrides this
option.
16
102
LACSLink Memory
Module Size
Indicator
This option allows you to specify size of
LACSLink module.
Blank
LACS process will be using
Medium memory model
(default).
P
Pico memory model (no files in
memory).
U
Micro memory model (no files in
memory, only indexes).
S
Small memory model (Rv9
expansion in memory).
M
Medium memory model.
L
Large memory model.
H
Huge memory model (all files in
memory).
Required
Software Release 4.0.0/March 2015
L CODE Parameter Record
1
L CODE Parameter Record
The optional L CODE parameter tells CODE-1 Plus about the location and length of
a list code in the input record.
NOTE: There is an identical C1BM00XL driver program that allows for up to
10,000 list codes, and requires 2.25 MB of memory to run. (The standard
C1BM00 driver program allows for 200 list codes, and requires 390 K of memory.)
To take advantage of the additional list code processing, change your control
language appropriately.
The term list code comes from the practice of merging several mailing lists together,
using a code imbedded in the records to identify the source list of each record. You
can use the L CODE parameter to designate any field of 9 bytes or less in the input
records. CODE-1 Plus has four reports that print information about your job by list
code. The most common use of the L CODE parameter is to identify the list where a
record originated. You can then use the list code reports to analyze the quality of the
addresses on each of your original mailing lists.
Field-by-Field
Table 29: LCODE Parameter Fields
Position
Field Name
Description
Comments
1-6
KEYWORD
L CODE is the only acceptable entry.
Required.
8-10
Location of
LIST CODE
Location on the input record of the list
code.
Required.
No default.
12
Length of
LIST CODE
Length of the list code.
Required.
No default. Must
be 9 bytes or
less.
14-22
CLIENT CODE
1-9 character Client Code.
Optional.
24-31
DATE RECEIVED
The date the file was received in
CCYYMMDD format.
Default is blank.
50-52
Location of SYSTEM
DATE
Location on the output record of the
system date.
Optional.
NOTE: If only this field is specified, all
other fields on this parameter record
become optional. The format is
MMDDCCYY.
Working With CODE-1 Plus
103
1
Parameter Reference
LISTID Parameter Record
The optional LISTID parameter prints the name or ID of the current
name-and-address input file in box B4 of USPS Form 3553, and the number of nameand-address lists used to produce the current mailing in box B5. This parameter
defines the following information:
NOTE: You can define one LISTID parameter in a job.
Field-by-Field
Table 30: LISTID Parameter Fields
Position
Field Name
Description
Comments
1-6
KEYWORD
LISTID is the only acceptable entry.
Required.
8-27
LIST ID
The name or ID of the current nameand-address list.
Required.
No default.
29-48
LIST ID, CONTINUED
More text indicating the name or ID for
the current name-and-address list. The
continued field provides a second line for
the name, because box B4 has a limited
number of characters across, but has
two print lines.
Optional.
No default.
50-54
NUMBER OF LISTS
A 5-digit number indicating the number
of lists used to produce the mailing. The
number of lists. If there is more than one
list, the Address List Name or ID# box
will not be populated.
Optional.
For example, if you want to tell
CODE-1 Plus that you used one list, the
number entered here would be 00001.
104
Software Release 4.0.0/March 2015
LISTNM Parameter Record
1
LISTNM Parameter Record
The optional LISTNM parameter prints the List Processor’s name on the USPS Form
3553 in box B1. The list processor’s name is the name of the company who coded the
name and address list(s) and/or performed the ZIP + 4 barcoding using CASScertified software. You can define up to three lines of information to identify the list
processor, because box B1 has a limited number of characters across, but has three
print lines.
NOTE: You can define one LISTNM parameter in a job.
Field-by-Field
Table 31: LISTNM Parameter Fields
Position
Field Name
Description
Comments
1-6
KEYWORD
LISTNM is the only acceptable entry.
Required.
8-27
LIST PROCESSOR
NAME
A 20-character name that identifies the
organization that coded the name and
address list(s) and/or performed the ZIP
+ 4 barcoding using CASS-certified
software.
Required.
No default.
29-48
LIST PROCESSOR
NAME CONTINUED 2
Another 20-character field that you can
use to identify the list processor of this
name-and-address list.
Optional.
No default.
50-69
LIST PROCESSOR
NAME CONTINUED 3
Another 20-character field that you can
use to identify the list processor of this
name-and-address list.
Optional.
No default.
Working With CODE-1 Plus
105
1
Parameter Reference
LOTOUT Parameter Record
The optional LOTOUT parameter identifies where on the output record to store the
information returned from the Line of Travel Master file.
NOTE: Line of Travel is NOT the same as a Walk Sequence Code. If you are trying
to obtain Walk Sequence Codes, they are provided through licensed DSF2
(Delivery Sequence File) Vendors.
Ordinarily, to sort mail in line of travel sequence, you must sort your mail by ZIP
Code, Carrier Route, Line of Travel code, ZIP + 4 Code, and DPBC (delivery point
barcode) add-on. The DPBC must be sorted in either ascending or descending
sequence based on the alphabetic portion of the Line of Travel code. Instead of doing
this cumbersome task, two sequence fields are provided so the entire sortation string
can be sorted in ascending sequence.
A two-character alternate alphanumeric sequence field is returned based upon the
DPBC and the alphabetic portion of the Line of Travel Code. This two-character field
consists of an uppercase letter followed by a single digit. The range of possible values
is from A0 through T9. The one-character hexadecimal sequence field works the same
way but has a range of values from hexadecimal “21” (binary numeric 33) to
hexadecimal “E8” (binary numeric 232). Both alternate sequence fields work the
same way to be used for sortation purposes. In other words, you do not need to post
both alternate sequence fields.
106
Software Release 4.0.0/March 2015
LOTOUT Parameter Record
1
Field-by-Field
Table 32: LOTOUT Parameter Fields
Position
Field Name
Description
Comments
1-6
KEYWORD
LOTOUT is the only acceptable entry.
Required.
8-10
Location of
LOT RETURN CODE
Location on the output record for the
1-character LOT return code. One of the
following codes is stored:
Optional.
No default.
9
ZIP + 4 matched the LOT master
file.
C
Call to LOT matcher failed.
D
Default coded. ZIP + 4 not found
in the LOT master file.
F
Master file access failure
V
Incompatible Master file
Blank
ZIP Code and/or ZIP + 4 was
neither numeric nor zeroes.
12-14
Location of
NUMERIC PORTION
OF LOT CODE
Location on the output record for the
4-character LOT code (numeric portion).
Required.
No default.
16-18
Location of
ALPHABETIC
PORTION OF LOT
CODE
Location on the output record for the
1-character USPS sequence code.
Optional.
No default.
20-22
Location of
2-character
ALTERNATE
SEQUENCE CODE
(alphanumeric)
Location on the output record for the
2-character alternate sequence code
used for sortation purposes.
Optional.
No default.
24-26
Location of
1-character
ALTERNATE
SEQUENCE CODE
(hexadecimal)
Location on the output record for the
1-character alternate sequence code
used for sortation purposes.
Optional.
No default.
28
DISPOSITION
INDICATOR
Code indicating what should be stored in
cases where no LOT code was
determined. Enter one of the following
codes:
Optional.
Default is B.
Working With CODE-1 Plus
B
Store blanks.
X
Store nothing.
107
1
Parameter Reference
MAILER Parameter Record
The MAILER parameter is required if you are running DPV and optional if you are
not. It prints the mailer’s name and address on the USPS Form 3553 in box D2. The
name and address is of the individual whose signature appears in box D1. In DPV,
MAILER is used to supply information in the DPV SEED File in the unlikely event a
DPV Seed is encountered.
NOTE: You can define up to six MAILER parameters in a job to accommodate up
to six lines of information that prints on the form.
If you are running DPV, you must have a set of five MAILER parameter records as
input to program C1BM00. The five parameters are necessary in case a DPV seed
record violation occurs. The above information is required in such cases. The format
must be as follows:
Record No.
Contents of Positions 1-137
1
Company name
2
Street address
3
City
4
State abbreviation
5
9-digit ZIP
State abbreviation must be in positions 8-9. ZIP and ZIP + 4 may be separated by a
space, a hyphen, or be contiguous.
Field-by-Field
Table 33: MAILER Parameter Fields
Position
108
Field Name
Description
Comments
1-6
KEYWORD
MAILER is the only acceptable entry.
Required.
8-37
MAILER NAME
30-character name and address of the
individual whose signature appears in box D1 of
USPS Form 3553. If you leave this field blank,
the corresponding line in box D2 on USPS Form
3553 remains blank.
Required.
No default.
Software Release 4.0.0/March 2015
MOVE I Parameter Record
1
MOVE I Parameter Record
The optional MOVE I parameter allows you to rearrange the pieces of the input
record before the record is processed. This parameter defines the following:
•
Current starting location of the information you want to copy (source)
•
Length of the information you want to copy
•
Starting location to which you want to copy the information (target)
This feature enables you to rearrange the components of your input records before
any other CODE-1 Plus processing takes place. Note that the information you
identify is copied to the location you specify, but it is not removed from its original
location in the input record. This feature is useful for “saving” data that might
otherwise be overwritten by data returned by CODE-1 Plus. A maximum of 100
MOVE I parameters can be defined for a job. They are processed one at a time, in
sequence from top to bottom.
Before CODE-1 Plus does any processing, it first copies the entire input record into
an input record array. Then, if you specify any MOVE I operations, CODE-1 Plus
copies the entire record into a temporary work area. It then takes data from a
specified position in the work area, and puts it in a specified position in the input
record array. Once CODE-1 Plus executes all of the MOVE I operations, it clears the
work area and processes the record as it now appears in the input record array.
For example, let’s use an input record with a structure as follows:
AAAAABBBBBCCCCC
If we move the information in positions 11-15 to positions 1-5, CODE-1 Plus copies
the record to the work area, and executes the move operation. When the operation is
complete, our input record array and work area is:
Input Record Array
Work Area
CCCCCBBBBBCCCCC
AAAAABBBBBCCCCC
Then, if we move the information from positions 1-5 to positions 11-15, our input
record array and work area appear as follows:
Input Record Array
Work Area
CCCCCBBBBBAAAAA
AAAAABBBBBCCCCC
Working With CODE-1 Plus
109
1
Parameter Reference
NOTE: This feature does not alter your input name-and-address file.
Field-by-Field
Table 34: MOVE I Parameter Fields
Position
110
Field Name
Description
Comments
1-6
KEYWORD
MOVE I is the only acceptable entry.
Required.
8-10
Location of
SOURCE
Location in the work area of the
information to be copied. Optionally, you
can enter one of the following codes to
copy one of the following types of generic
information to the target location:
Required.
No default.
SPC
Spaces
X00
Binary zeros
ZRO
Character zeros.
12-13
Length of
SOURCE/TARGET
Length of the information to be copied to
the target location.
Required.
No default.
15-17
Location of
TARGET
Location in the input array to which you
want the source information copied.
Required.
No default.
Software Release 4.0.0/March 2015
MOVE O Parameter Record
1
MOVE O Parameter Record
The optional MOVE O parameter allows you to rearrange pieces of the output record
before the record is written to the output file. CODE-1 Plus processes the record and
copies it to an output record array. If you specify any output move operations, CODE1 Plus copies the entire record to a temporary work area, and then copies data from
a specific location in the work area back to a specific location in the output record
array. This information is then written directly to your output file (or passed to an
output exit routine). A maximum of 100 MOVE O parameters can be defined for a job.
The parameters are processed one at a time, in sequence from top to bottom.
Field-by-Field
Table 35: MOVE O Parameter Fields
Position
Field Name
Description
Comments
1-6
KEYWORD
MOVE O is the only acceptable entry.
Required.
8-10
Location of SOURCE
Location in the work area of the
information to be copied (source).
Optionally, you can enter one of the
following codes to copy different types of
generic information to the target
location:
Required.
No default.
SPC
Spaces
X00
Binary zeros
ZRO
Character zeros.
12-13
Length of SOURCE/
TARGET
Length of the information to be copied to
the target location.
Required.
No default.
15-17
Location of TARGET
Location in the output record to which
you want the source information copied
(target).
Required.
No default.
Working With CODE-1 Plus
111
1
Parameter Reference
NTHSEL Parameter Record
The optional NTHSEL parameter specifies that when you run your job, CODE-1 Plus
will process a fraction of your input records or every nth input record and ignore the
others.
NOTE: You can define one NTHSEL parameter per job. You can use the NTHSEL
parameter in conjunction with the fractional sampling option on the FILEDF
parameter.
Field-by-Field.
Table 36: NTHSEL Parameter Fields
Position
1-6
Field Name
KEYWORD
Description
Comments
Must be NTHSEL.
Required.
8-14 Sampling Method 1 — Including or Excluding Nth Number of Input Records
8-10
Nth NUMBER
The nth number of records the user
wants to either include or exclude from
the input records to be read.
Required if you do
not use Sampling
Method 2.
Valid numbers include 002 through 999.
12-14
INCLUDE/
EXCLUDE
OPTION
An option indicating whether to include
or exclude the specified nth number of
input records for processing:
INC
Include the nth number of input
records.
EXC
Exclude the nth number of
input records.
Required if you do
not use Sampling
Method 2.
No default.
16-22 Sampling Method 2 — Selecting a Fraction of Input Records
16-22
FRACTION OF
RECORDS
A 7-digit positive number specifying the
fraction of total input records to
process. A decimal point is implied
before the first digit.
Required if you do
not use Sampling
Method 1.
If FILEDF fractional processing is also
defined, CODE-1 Plus will select a
fraction (defined by FILEDF) of a
fraction (defined by NTHSEL).
112
Software Release 4.0.0/March 2015
NTHSEL Parameter Record
1
Performing Cross-Sectional Sampling
Cross-sectional sampling allows you to sample records throughout the file, from
beginning to end. You can specify cross-sectional sampling for the input name-andaddress file using a FILEDF parameter. With the NTHSEL parameter, you can specify
cross-sectional for the input name-and-address file only.
NOTE: If you specify cross-sectional sampling for the input name-and-address file
on the FILEDF and the NTHSEL parameter, a fraction of a fraction of the file will
be selected for processing.
To determine the number to enter in the FILEDF's 7-character DECIMAL FRACTION
field, divide the number of records you want to process by the number of records in
the file. This gives you a decimal number. Drop the decimal, and type the first 7 digits
of the number. For example, suppose you wanted to process 2,000 records from a file
containing 102,986 records. To select 2,000 records for processing, divide 102,986
into 2,000. The answer is .0194201153. Drop the decimal and keep 7 digits
(0194201) to type in the DECIMAL FRACTION field. This ensures that the 2,000
records processed are evenly distributed throughout the file. You can use this
sampling with the NTHSEL parameter as well.
Cross-Sectional Sampling of a File
First Record
Evenly Select
0.0194201 Records = 2,000 Records
Last Record
1 . . . . . . . . . . . . . . . . ......... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102,986
Figure 2: Skipping and Limiting Record Example
Working With CODE-1 Plus
113
1
Parameter Reference
Including/Excluding Nth Records
Including or excluding every nth record in the input name-and-address file allows
you to process or bypass every user-specified number of records in the file. For
example, we want to specify to process every third record in the input file.
Nth Record Selection
First Record
Select Every Third Record
. . 3. .6 . .9 . .12 . .15 . .18 . .21 . .24 . .27 . .30 . .33 . .36 . .39 . .42 . .45 . .48.. etc.
Figure 3: Including Every Third Record Example
The table on the following page shows you how to fill out the NTHSEL parameter for
this specification.
NOTE: For the input name-and-address file, you can use the NTHSEL inclusion
and exclusion sampling function in conjunction with a FILEDF cross-sectional
function. This allows you to include/exclude a fraction of every nth record.
Table 37: NTHSEL Parameter
These Specifications
114
Define the Following
NTHSEL in positions 1
through 6
KEYWORD — Specify record sampling specifications.
003 in positions 8 through
10
Nth NUMBER — Three is the user-specified “nth” number.
INC in positions 12 through
14
INCLUDE/EXCLUDE OPTION — CODE-1 Plus will process (include)
every third record in the input name-and-address file.
Software Release 4.0.0/March 2015
PAGESZ Parameter Record
1
PAGESZ Parameter Record
The optional PAGESZ parameter indicates how many lines to print on each page of
either the Execution Log or the reports in the reports file.
NOTE: If you want to specify the number of lines to print on each page for both
the Execution Log and all of the other reports, you must include two PAGESZ
parameters in your job.
Field-by-Field
Table 38: PAGESZ Parameter Fields
Position
Field Name
Description
Comments
1-6
KEYWORD
PAGESZ is the only acceptable entry.
Required.
8-10
LINES-PER-PAGE
The number of lines you want printed on
each page of the Execution Log or the
other reports.
Required.
Default is 60.
Minimum is 25;
maximum is 225.
12-14
REPORT OR LOG
CODE
Code indicating whether the specified
line number applies to the Execution Log
or to all of the other reports. Enter one of
the following codes:
Required.
Default is RPT.
Working With CODE-1 Plus
RPT
Reports
XLG
Execution Log.
115
1
Parameter Reference
PGMNAM Parameter Record
The optional PGMNAM parameter enables you to call an alternate address matching
module, instead of the standard C1MATCHB module. Additionally, the PGMNAM
parameter enables you to select an alternate module for your RDI processing. The
alternate address matching modules offer different memory models, from which you
can select one appropriate for your site. A larger memory model generally improves
performance. The default C1MATCHB module uses 3MB of memory. The alternate
memory modules are the following:
•
Small (1 MB)
•
Medium (6 MB)
•
Large (12 MB)
•
Huge (28 MB)
NOTE: You can have multiple PGMNAM parameters in your C1BM00 job. One for
each RDI large memory model and one for a CODE-1 Plus memory model. For
more information on DPV and RDI processing, refer to Chapter 5, "Using Delivery
Point Validation".
116
Software Release 4.0.0/March 2015
PGMNAM Parameter Record
1
Field-by-Field
Table 39: PGMNAM Parameter Fields
Position
Field Name
Description
Comments
1-6
KEYWORD
PGMNAM is the only acceptable entry.
Required.
8-15
INTERNAL
PROGRAM NAME
The only acceptable entries for this field
are C1MATCHB and DPV040.
Required.
C1MATCHB Address matching module.
C1MATCHB is the internal program name
of the CODE-1 Plus batch address
matching module (Pitney Bowes
delivered). The program in positions 17-24
will be called instead of C1MATCHB.
FOR RDI PROCESSING ONLY:
DPV040 RDI Program override.
DPV040 is the internal program name of
the Residential Delivery Point Validation
module. If you wish to use the Alternate
RDI Large Memory Module for your RDI
processing, you must place DPV040 in this
position.
17-24
MEMORY
CONFIGURATION
PROGRAM NAME
The name of the program called instead of
C1MATCHB. You can choose the program
with a memory model appropriate for your
site. Enter one of the following program
names (memory models):
C1MATCHS
Required.
Small memory model (1 MB)
C1MATCHM Medium memory model
(6 MB)
C1MATCHL
Large memory model
(12 MB)
C1MATCHH Huge memory model
(28 MB). (This is not available
on the OpenVMS platforms.)
CODE-1 Plus customers should be aware
that batch jobs running with DPV Split,
LACSLink, and SuiteLink may require up
to 377M of GETVIS.
FOR RDI PROCESSING ONLY:
DPV040L will be called instead of DPV040:
DPV040LAlternate RDI Large Memory
Module.
NOTE: When DPV040 is in positions 8-15,
DPV040L is required in positions 17-24.
Working With CODE-1 Plus
117
1
Parameter Reference
REPORT Parameter Record
The optional REPORT parameter specifies the reports to print at the end of your
CODE-1 Plus job.
The default, in all cases except the NDI report and the separate USPS Form 3553, is
to print the report. Therefore, if you want to print all of the reports except the NDI
report and the separate USPS Form 3553, you don't have to use this parameter.
NOTE: NOTES: There are four reports that are printed automatically for all jobs:
parameter List; Execution Log; Control Totals; and Address Match Execution
Statistics. You cannot specify whether or not you want to print these reports. You
also cannot specify whether or not you want to print the USPS Form 3553. If you
are using a CASS-certified configuration, the report will print; otherwise, it will
not.
The Line of Travel reports will print only if the LOTOUT parameter is defined.
The REPORT parameter also gives you the option of printing the reports in all upper
case or in mixed case (upper and lower case).
NOTE: If you want to print the reports in mixed case, you must specify the
REPORT parameter at the top of the parameter list. If you include the REPORT
parameter near the bottom of the parameter list, it is possible that some of the
reports will still print in all upper case.
Field-by-Field
Table 40: REPORT Parameter Fields (Part 1 of 3)
Position
118
Field Name
Description
Comments
1-6
KEYWORD
REPORT is the only acceptable entry.
Required.
8
ANALYSIS OF
MATCHED RECORDS
Indicate whether to print this report.
Optional.
Default is Y.
Y
Print the report.
N
Do not print the report.
Software Release 4.0.0/March 2015
REPORT Parameter Record
1
Table 40: REPORT Parameter Fields (Part 2 of 3)
Position
10
12
14
16
18
20
22
24
26
28
30
Working With CODE-1 Plus
Field Name
ZIP + 4 CODING BY
STATE
CARRIER CODING BY
STATE
ZIP + 4 CODING BY
LIST CODE
CARRIER CODING BY
LIST CODE
ZIP + 4 CODING BY
3-DIGIT ZIP
CARRIER CODING BY
3-DIGIT ZIP
SUMMARY BY STATE
SUMMARY BY LIST
CODE
SUMMARY BY 3DIGIT ZIP
PRINT UPPER/
LOWER
CASE
NATIONAL
DELIVERABILITY
INDEX (NDI) REPORT
Description
Indicate whether to print this report.
Y
Print the report.
N
Do not print the report.
Indicate whether to print this report.
Y
Print the report.
N
Do not print the report.
Indicate whether to print this report.
Y
Print the report.
N
Do not print the report.
Indicate whether to print this report.
Y
Print the report.
N
Do not print the report.
Indicate whether to print this report.
Y
Print the report.
N
Do not print the report.
Indicate whether to print this report.
Y
Print the report.
N
Do not print the report.
Indicate whether to print this report.
Y
Print the report.
N
Do not print the report.
Indicate whether to print this report.
Y
Print the report.
N
Do not print the report.
Indicate whether to print this report.
Y
Print the report.
N
Do not print the report.
Indicate whether to print this report.
Y
Print the reports in all upper
case.
N
Print the reports in mixed case.
Indicate whether to print this report.
Y
Print the report.
N
Do not print the report.
Comments
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is N.
119
1
Parameter Reference
Table 40: REPORT Parameter Fields (Part 3 of 3)
Position
32
34
36
38
40
42
44
70
120
Field Name
LINE OF TRAVEL
CODING BY STATE
Description
Comments
Indicate whether to print this report.
Y
Print the report.
N
Do not print the report.
LINE OF TRAVEL
CODING BY LIST
CODE
Indicate whether to print this report.
LINE OF TRAVEL
CODING BY 3-DIGIT
ZIP CODE
Indicate whether to print this report.
DELIVERY POINT
VALIDATION
PROCESSING
SUMMARY
Indicate whether to print this report.
DELIVERY POINT
VALIDATION
PROCESSING BY
LIST CODE
Indicate whether to print this report.
RESIDENTIAL
DELIVERY
INDICATOR (RDI)
PROCESSING
SUMMARY COUNTS
Indicate whether to print this report.
RESIDENTIAL
DELIVERY
INDICATOR (RDI)
PROCESSING
COUNTS BY LIST
CODE
Indicate whether to print this report.
USPS FORM 3553
SEPARATE PRINT
FILE
Indicate whether to print this report.
Y
Print the report.
N
Do not print the report.
Y
Print the report.
N
Do not print the report.
Y
Print the report.
N
Do not print the report.
Y
Print the report.
N
Do not print the report.
Y
Print RDI counts.
N
Do not print RDI counts.
Y
Print the RDI List Code Report.
N
Do not print the RDI List Code
Report.
Y
Print in a separate print file.
N
Do not print in a separate print
file.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is Y.
Optional.
Default is N.
Software Release 4.0.0/March 2015
REPORT Parameter Record
1
NOTE: To print the above reports, type an Y in the appropriate position on the
REPORT parameter. For all other reports, except the NDI report, the reports print
by default.
The NDI report is suppressed by default. The USPS CASS Form 3553 by default
does not print in a separate print file. The Y in position 70 specifies to print the
USPS CASS Form 3553 in a separate print file. The N in position 28 specifies to
print the reports in mixed case.
Working With CODE-1 Plus
121
1
Parameter Reference
SA OUT Parameter Record
The optional SA OUT parameter allows you to specify where in the output file you
want the standardized address to be stored. Standardized address information is
formatted to conform to USPS conventions and matched against the master file.
Dropped information is dropped from the address during the standardization
process.
NOTE: Standardized addresses with and without apartment information do not
refer to individual records that can or cannot have apartment information
included in their addresses. It is assumed that all records have apartment
information, and we specify whether or not to store that information separately
from the rest of the standardized address.
Alias and Base Street Names
It is possible for a single street to have more than one name. In such cases, the USPS
differentiates between a base street name and one or more alias street names.
Typically, either the alias or the base refers to only a portion of the street (i.e., a
particular house range or ranges). A base name is the preferred name for the entire
street. Every street in the USPS database has one and only one base name. However,
a base street can have multiple alias names. The USPS has identified three types of
alias street names:
•
USPS preferred street name
•
Official street name change (as a result of a Chamber of Commerce Action)
•
Other
If the alias street name is preferred, CODE-1 Plus always stores the alias name instead
of the base name. If the alias street name is an official street name change,
CODE-1 Plus always stores the base name. However, if the alias street name is of type
“other,” CODE-1 Plus stores the alias or base, depending on the option you chose on
the SA OUT parameter. Note that you never have the option of returning the alias
street name if the input address matches the base street name. It is important to
remember, however, that both the base street and the alias street are valid,
deliverable addresses.
For example, in Bethesda, Maryland there is a street called Rockville Pike. Another
valid name for Rockville Pike in Bethesda is Wisconsin Avenue. In this case, the USPS
designated Rockville Pike as the base street name and Wisconsin as the alias street
name.
122
Software Release 4.0.0/March 2015
SA OUT Parameter Record
1
The sample input addresses below illustrate what CODE-1 Plus would return (this
example assumes that all alias street names are of type “other”).
Table 41: Alias and Base Street Name Output
Input Address
Return Base Street if
Alias Street is Matched?
Output Address
9650 Wisconsin Avenue
Yes
9650 Rockville Pike
9650 Rockville Pike
Yes
9650 Rockville Pike
9650 Wisconsin Avenue
No
9650 Wisconsin Avenue
9650 Rockville Pike
No
9650 Rockville Pike
Using the INP Option
Instead of storing your output standardized address in a new location, you have the
option of storing it where the input address lines were located. To understand how
CODE-1 Plus stores your output address when you use the INP option in columns 1214 of the SA OUT parameter, it is important to remember that CODE-1 Plus
considers the most significant address line to be the one that was defined last on the
ADDRDF parameter. CODE-1 Plus follows the rules listed below when you specify the
INP option in columns 12-14 on the SA OUT parameter.
1. When an apartment number is located in an address line by itself, and the rest of
the street address is located in another address line, CODE-1 Plus will combine
the two lines into a single address line and store the new line where the most
significant of the two input lines was located.
2. If only one input address line actually contains data, the output address line will
be moved to the next most significant location, and the location that contained
the original address line will be blank. If the address line that is provided is
already in the most significant location, then no adjustment in address line
positions takes place.
3. If more than one address line is provided, and they are separated by one or more
blank address lines, no movement of address lines takes place.
4. If an address line is provided that is not part of a valid street address (i.e., C/O
JOHN DOE), then the following rules apply:
If this address line is the only one supplied, the match fails and no adjustment in
address line positions takes place.
If this address line is in the most significant location, and more than one other
address line is supplied, the match fails and no adjustment in address line
positions takes place.
Working With CODE-1 Plus
123
1
Parameter Reference
If this address line is in the most significant location and only one other address
line is supplied, the match succeeds and the positions of the two address lines are
swapped.
NOTE: This swapping can only occur if the lengths of the input lines are the same.
If you use the INP option, and you also choose to store nothing if your standardized
address is too long, the standardized address is stored unless it is longer than two
input lines put together. In other words, even if CODE-1 Plus used only address
information from one input address line, it will overwrite two input address lines if
there is not enough room on one line alone.
The LACS Indicator
The Locatable Address Conversion Service (LACS) indicator describes records that
have been converted to the LACS system (which allows mailers to identify and convert
a rural route address to its new city-style address). Rural route addresses are being
converted and some city-style addresses are being modified so that emergency
vehicles (ambulances, police cars, etc.) can find these locations.
Private Mailbox Designation (PMB)
Commercial Mail Receiving Agents (CMRA) are private companies offering mailbox
rental services to individuals and businesses.
The USPS requires a private mailbox (PMB) designator within the address on mail
destined for delivery through a CMRA. The PMB address information is required to
exist separately from the delivery address of the CMRA, as shown in the following
example address:
John Doe
PMB 234
123 Main St Ste 10
Anytown, ST 12345-1234
Recipient
Private Mailbox within the CMRA
CMRA street address
CMRA City, State, and ZIP
If a PMB is present, CODE-1 Plus concatenates the PMB to the Address with
Apartment field.
124
Software Release 4.0.0/March 2015
SA OUT Parameter Record
1
Field-by-Field
Table 42: SA OUT Parameter Fields (Part 1 of 6)
Position
Field Name
Description
Comments
1-6
KEYWORD
SA OUT is the only acceptable entry.
Required.
8-10
Location for
ADDRESS RETURN
CODE
Location on the output record for the
1-character address return code. One of the
following codes is stored:
Optional.
No Default.
Working With CODE-1 Plus
Blank
The address match attempt was
successful.
A
Apartment number missing or not
found in database, and an apartmentlevel match was required.
B
Insufficient (or blank) address
information for a match.
C
The record's probable correctness
was higher than the specified
maximum.
D
Information was dropped during the
address match attempt.
H
House/Box number not found on this
street.
L
The returned address was too long to
be stored.
M
Multiple matches were found.
S
Street name not found in ZIP Code.
T
The complete standardized address
was too long to be stored and there is
no location specified in which to store
the address with secondary
information. This only occurs if you
are storing the address without the
secondary information.
U
Unavailable—auxiliary file
processing.
Z
ZIP Code was not found on database.
125
1
Parameter Reference
Table 42: SA OUT Parameter Fields (Part 2 of 6)
Position
Field Name
Description
Comments
12-14
Location for
ADDRESS WITH
APARTMENT
Location on the output record for the
standardized address, including apartment
information. Enter a location, or “INP” to store
the standardized address in the same location
as the input address. (INP is only valid if
ADDRDF col. 8 is L or M.)
Required.
No default.
16-17
Length of
ADDRESS WITH
APARTMENT
Length of the standardized address with
apartment information.
Required.
No default.
18
BLANK UNUSED
ADDRESS LINES
This option is only allowed when the “INP”
option is specified in columns 12-14. If set to
“X” then the unused address lines are blanked
out.
Optional
Storage conditions
— ADDRESS WITH
APARTMENT
Code indicating what should be stored when
the standardized address with apartment
number is too long, or if there was no match
found.
Optional.
Default is to
store
nothing.
19
Blank
Store information indicated in
position 72.
I
Store the input address
Default: Do
not blank
out the input
address
lines.
21-23
Location for
ADDRESS
WITHOUT
APARTMENT
Location on the output file for the
standardized address, excluding apartment
information.
Optional.
No default.
25-26
Length of
ADDRESS
WITHOUT
APARTMENT
Length of the standardized address without
apartment information.
Optional.
No default.
28
Storage conditions
— ADDRESS
WITHOUT
APARTMENT
Code indicating whether or not the
standardized address without apartment
number should be stored if the standardized
address with apartment has already been
stored.
Optional.
Default is to
store
nothing.
Blank
Store nothing.
X
Store the information anyway.
NOTE: If you enter “X,” this information is
stored even if it is longer than the specified
length for the receiving field. If it is too long,
the information will be truncated. A return
code of “L” will not be stored.
30-32
126
Location for
APARTMENT/PMB
Location on the output record for the
apartment information. Use this output area
to store the PMB number when presented
separately in secondary input address line.
Optional.
No default.
Software Release 4.0.0/March 2015
SA OUT Parameter Record
1
Table 42: SA OUT Parameter Fields (Part 3 of 6)
Position
Field Name
Description
Comments
34-35
Length of
APARTMENT/PMB
Length of the apartment/PMB information on
the output record.
Optional.
No default.
37
Storage conditions
— APARTMENT/
PMB
Code indicating what should be stored in
positions 30-32.
Optional.
Default is
blank.
39-41
43-45
Working With CODE-1 Plus
Location for
ADDRESS SOURCE
CODE
Location for
DROPPED
INFORMATION
CODE
Blank
Do not store apartment information if
successfully stored in standardized
address with apartment.
P
Store PMB number when unable to
store in primary address line due to
truncation.
X
Store the apartment information
anyway.
Location on the output record for the
1-character code indicating which input
address line CODE-1 Plus used to obtain a
standardized address. One of the following
codes is stored:
M
Both address lines
P
Primary address line only
S
Secondary address line only
Blank
No match was found.
Location on the output record for the
1-character code indicating the type of
information dropped during the
standardization process. One of the following
codes is stored:
Blank
Either no match was obtained, or no
information was dropped.
A
A street address was dropped in order
to obtain a Rural Route/Highway
Contract/or PO Box match.
R
A Rural Route/Highway Contract/PO
Box/General Delivery address was
dropped in order to obtain a street
address match.
W
One or more characters were
dropped during the address parsing
process.
Optional.
No default.
Optional.
No default.
127
1
Parameter Reference
Table 42: SA OUT Parameter Fields (Part 4 of 6)
Position
47-49
51
Field Name
Location for
LACS INDICATOR
ALIAS/BASE
RETURN OPTION
Description
Comments
Location for the Locatable Address Correction
Service indicator on the output record. This
indicator flags any rural addresses that
changed to urban addresses, such as RR 4
BOX 1 changing to 2200 MAIN ST. The next
time you process the file, you can identify and
process only those records on the ZIP + 4
database with rural address changes. One of
the following codes is stored:
Blank
Address was not LACS converted (no
change).
L
Address was LACS converted
(changed to an urban address).
Code indicating whether or not you want
CODE-1 Plus to return the base street name if
the input address matched an alias street.
Y
Return the base street name.
N
Return the alias street name.
Optional.
No default.
Optional.
Default is N.
NOTE: This option is only used when the alias
type code is “O” or “A.”
NOTE: No CASS Report is generated if you
enter Y. For a CASS-certified configuration
you must enter N.
53-55
57-59
128
Location for
ALIAS RETURN
CODE
Location for
ALIAS TYPE CODE
Location on the output record for the
1-character alias return code. One of the
following codes is stored:
Blank
The address did not match an alias
street name.
A
The address matched an alias street.
Location on the output record for the
1-character alias type code. One of the
following codes is stored:
Blank
Street record matched was not an
alias street.
A
Street record was abbreviated.
C
Official street name change (Chamber
of Commerce action.
O
Street record matched was a USPS
“other” alias.
P
Street record matched was a USPS
“preferred” alias.
Optional.
No default.
Optional.
No default.
Software Release 4.0.0/March 2015
SA OUT Parameter Record
1
Table 42: SA OUT Parameter Fields (Part 5 of 6)
Position
60
Field Name
Storage conditions
— INFORMATION
DROPPED
Description
Code indicating whether the standardized
address should be stored when information
was dropped during the standardization
process.
Blank
Store the information anyway.
X
Do not store if information was
dropped.
Comments
Optional.
Default is to
store the
information
anyway.
62
MAXIMUM
ADDRESS
CORRECTNESS
Maximum acceptable address probability of
correctness to store the standardized
address. Enter a number between 0 and 9,
where 0 indicates the best case and 9
indicates the worst case.
Optional.
Default is 9.
64
MAXIMUM
OVERALL
CORRECTNESS
Maximum acceptable overall probability of
correctness to store the standardized
address. Enter a number between 0 and 9,
where 0 indicates the best case and 9
indicates the worst case.
Optional.
Default is 9.
66-68
Location for
PMB RETURN
CODE
Location on the output record for the
1-character code indicating the disposition of
the PMB number.
69
70
Working With CODE-1 Plus
Storage conditions
— MULTIPLE
STANDARDIZED
ADDRESSES
Storage conditions
— MULTIPLE ZIP
CODE
Blank
No PMB found.
A
Appended to standardized address.
S
Secondary address input.
L
Returned address was too long to be
stored.
Code indicating whether the standardized
address should be stored when multiple
address matches were found.
Blank
Store the information indicated in
position 72.
M
Store the standardized address
anyway.
Code indicating whether the standardized
address should be stored when multiple ZIP
Code matches were found.
Blank
Store the information indicated in
position 72.
M
Store the standardized address
anyway.
Optional.
Default is to
store blanks
or nothing,
whichever is
indicated in
position 72.
Optional.
Default is to
store blanks
or nothing,
whichever is
indicated in
position 72.
129
1
Parameter Reference
Table 42: SA OUT Parameter Fields (Part 6 of 6)
Position
72
130
Field Name
DISPOSITION
INDICATOR
Description
Comments
Code indicating what should be stored in
cases where the standardized address was
not stored, either because no match was
found or because of specified storage
conditions.
B
Store blanks.
X
Store nothing.
Optional.
Default is B.
Software Release 4.0.0/March 2015
SA2OUT Parameter Record
1
SA2OUT Parameter Record
The optional SA2OUT parameter is a continuation of the SA OUT parameter which
allows you to specify where in the output file you want CODE-1 Plus to store the
standardized address.
Field-by-Field
Table 43: SA2OUT Parameter Fields (Part 1 of 2)
Position
Field Name
Description
Comments
1-6
KEYWORD
SA2OUT is the only acceptable entry.
Required.
8-10
Location for
PRIVATE MAILBOX
(PMB)
Location on the output record for the
formatted PMB when presented in a
separately-defined input address line.
Optional.
12-13
Length of
PRIVATE MAILBOX
(PMB)
Length of the PMB information on the
output record.
Required if the
location is
specified in
position 8-12.
15
Preferred Alias
Processing Indicator
Indicates if preferred alias processing
should be performed:
Required for
CASS
certification
Y
Perform preferred alias
processing.
N
Do not perform preferred alias
processing. (default)
NOTE: A “Y” in this position is required
to generate a CASS report. Selecting
“N” will generate a non-CASS-certified
configuration. No PS FORM 3553 will
be generated.
17-19
21
Working With CODE-1 Plus
Location for
Preferred Alias
Processing Return
Code
Abbreviated Alias
Processing Indicator
Location on the output record for a
1-byte flag.
Blank
No preferred alias processing
attempted.
A
Input address matched to an
alias (preferred alias processing
is only attempted for base
addresses).
N
Did not match to preferred alias.
Y
Matched to preferred alias.
Indicates if abbreviated alias processing
should be performed:
Y
Perform abbreviated alias
processing.
N
Do not perform abbreviated
alias processing. (default)
131
1
Parameter Reference
Table 43: SA2OUT Parameter Fields (Part 2 of 2)
Position
23-25
50
Field Name
Location for
Abbreviated Alias
Processing Return
Code
Enhanced Alternate
High Rise Match
Storage Options
Description
Comments
Location on the output record for a
1-byte flag.
Blank
No abbreviated alias processing
attempted.
B
Output address set to base
address.
L
Original standardized address
length already <= max.
N
Abbreviated alias not found for
input address.
Y
Abbreviated alias found for input
address and used in output
standardized address.
Code indicating whether the enhanced
alternate high rise match should be
returned. Enter one of the following
codes:
B
Return Base Address.
A
Return Alternate Address.
Optional.
Default is B
NOTE: Selecting A will generate a nonCASS-certified configuration. No PS
FORM 3553 will be generated.
52-54
132
Location for
Seasonal Delivery
Flags
Location of the 12-byte code indicating
when mail can be delivered to a specific
address:
Y
Mail can be delivered.
N
Mail cannot be delivered.
Software Release 4.0.0/March 2015
SEQCHK Parameter Record
1
SEQCHK Parameter Record
The optional SEQCHK parameter enables you to specify up to nine fields on the
input record, by which to check the sequence of the input file. Sequence errors are
indicated on the Execution Log, and if a record is bypassed, it does not affect the
Control Totals report.
NOTE: The total length of all the sequence field lengths cannot exceed 255 bytes.
Field-by-Field
Table 44: SEQCHK Parameter Fields (Part 1 of 2)
Position
Field Name
Description
Comments
1-6
KEYWORD
SEQCHK is the only acceptable entry.
Required.
8
SEQUENCE ERROR
TREATMENT
Indicate the action to take when a sequence
error is encountered in the input file.
Optional.
No default.
B
(Bypass) Bypass the offending
record and continue sequence
checking.
C
(Continue) Continue processing the
offending record and continue
sequence checking.
E
(End of file) Bypass the offending
record, and then gracefully end the
process as if the input file had
reached an end-of-file.
I
(Ignore) Continue processing the
offending record, but abandon any
further sequence checking.
NOTE: If there is a sequence error, it is
indicated in the Execution Log. If a record is
bypassed, it does not affect the Control
Totals report.
(10-15) Sequence Field Segment 1
10-12
17-19
24-26
31-33
38-40
45-47
52-54
59-61
66-68
Working With CODE-1 Plus
Location of
SEQUENCE FIELD
SEGMENTS
Location of segments of the data to be
checked for an input file sequence error.
Required.
No default.
133
1
Parameter Reference
Table 44: SEQCHK Parameter Fields (Part 2 of 2)
Position
134
Field Name
13
20
27
34
41
48
55
62
69
Format of
SEQUENCE FIELD
SEGMENTS
14-15
21-22
28-29
35-36
42-43
49-50
56-57
63-64
70-71
Length of
SEQUENCE FIELD
SEGMENTS
Description
Comments
Code indicating whether or not a field
segment is in a packed format that should be
unpacked before checking the sequence.
Enter one of the following codes for each
segment:
Blank
Field segment is not packed.
P
Field segment is packed.
Length of field segments. The total number
of field segments cannot exceed 255 bytes. If
the field segment is packed (“P” in previous
field), the field length cannot exceed 9.
Optional.
Default is
blank.
Required.
No default.
Software Release 4.0.0/March 2015
STELNK Parameter Record
1
STELNK Parameter Record
The optional STELNK parameter record allows you to activate the SuiteLink feature
of CODE-1 Plus. The following criteria must be met for SuiteLink will be called:
•
This parameter record is present.
•
A firm name is present and a valid ZIP Code, ZIP + 4 Code, and primary number
exist.
•
A match has been made to a high-rise default record.
•
The CODE-1 Plus and SuiteLink databases are current.
NOTE: USPS CASS regulations require SuiteLink processing for CASS certification
and to generate the USPS Form 3553 (USPS CASS Summary Report).
NOTE: The FIRMNM Parameter Record parameter is also required when you use
the STELNK parameter.
Field-by-Field
Table 45: STELNK Parameter Fields (Part 1 of 3)
Position
Field Name
Description
Comments
1-6
KEYWORD
STELNK is the only acceptable entry.
Required.
8
SuiteLink Error
Shutdown Indicator
Determines whether to shut down when
SuiteLink reports an error.
Optional.
Default is S.
• I — Ignore error and continue to
attempt SuiteLink processing. CODE-1
Plus does not generate a USPS Form
3553 (USPS CASS Summary Report) if
you specify the value “I”.
• S — Shutdown when SuiteLink reports
an error (default). Specify the value
“S” if you want to generate a USPS
Form 3553 (USPS CASS Summary
Report).
• W — Issue warning message and turn
off SuiteLink processing. CODE-1 Plus
does not generate a USPS Form 3553
(USPS CASS Summary Report) if you
specify the value “W”.
Working With CODE-1 Plus
135
1
Parameter Reference
Table 45: STELNK Parameter Fields (Part 2 of 3)
Position
10
12-14
16-18
20-22
Field Name
SuiteLink Memory
Model Flag
SuiteLink Return
Code Location
SuiteLink Match Code
Location
SuiteLink Fidelity
Code Location
Description
Comments
This option allows you to specify size of
SuiteLInk memory module.
Blank
SuiteLink process will use the
Medium memory model
(default.)
P
Pico memory model (no files in
memory).
U
Micro memory model (no files in
memory, only indexes).
S
Small memory model (slkhdr,
slknormal, slknoise in memory).
M
Medium memory model (slknine
file also in memory.)
L
Large memory model (lcd file
also in memory.)
H
Huge memory model (slk file
also in memory.)
Location for SuiteLink return code:
A
Business name matched.
00
Business name not matched.
Location for SuiteLink match code:
A
Matched
B
Not matched
C
Business name was all noise
D
Highrise default record not
found
E
Database is expired.
Location for SuiteLink match fidelity:
1
Exact match
2
Acceptable match (one word not
matched)
3
Unacceptable match (more than
one word not matched).
Required
Optional
Optional
Optional
NOTE: You should ignore the Fidelity
Code if the MatchCode is not 'A'. The
Fidelity Code is '0' if the MatchCode is
B (no match), C (business name
consisted entirely of "noise" words), or
D (9-digit zip not recognized as a high
rise default).
136
Software Release 4.0.0/March 2015
STELNK Parameter Record
1
Table 45: STELNK Parameter Fields (Part 3 of 3)
Position
24
Field Name
Include/Exclude
Secondary
Description
Use this options to call SuiteLink without
appending the secondary information to
the output address line. All other fields,
ZIP + 4 value, DPC code, are determined
using the secondary information
returned by SuiteLink.
I
Include secondary information
from SuiteLink on the output
address line.
E
Exclude secondary information
from SuiteLink from the output
address line.
Comments
Optional
Blank — Defaults to I.
25
Include/Exclude
Extraneous Input
Secondary
Information
Use this option to include or exclude any
invalid (extraneous) input secondary
information.
Optional. Default
is I.
• I — Include the invalid input
secondary information.
• E — Exclude the invalid input
secondary information.
• Blank — Defaults to I.
Working With CODE-1 Plus
137
1
Parameter Reference
TESTIT Parameter Record
The optional TESTIT parameter allows you to check the syntax of your job setup and
parameters before you run the entire job. If you have this parameter in your job,
CODE-1 Plus will check the syntax of your parameters, and print a parameter report
so that you can verify the information stored on the parameters. Then, if all looks
good and there are no errors, you can remove this parameter and submit the job to
run.
Field-by-Field
The parameter keyword is the only field on the TESTIT parameter.
Table 46: Fields on the TESTIT Parameter
Position
1-6
138
Field Name
KEYWORD
Description
Comments
TESTIT is the only acceptable entry.
Required.
Software Release 4.0.0/March 2015
UFTxx Parameter Record
1
UFTxx Parameter Record
The optional UFTxx parameter allows you to specify any text that you want printed
at the bottom of every page of each report.
NOTE: Any footer you specify is printed at the bottom of every page of each
report. You can specify up to four footer lines.
Field-by-Field
Table 47: UFTxx Parameter Fields
Position
Field Name
Description
Comments
1-3
KEYWORD
UFT is the only acceptable entry.
Required.
4
LINE NUMBER
The footer line number. Enter 1, 2, 3, or
4.
Required.
No default.
5
LINE SIDE
Indicate the side of the footer line on
which this text should appear.
Required.
No default.
7-72
Working With CODE-1 Plus
FOOTER TEXT
A
Left side of the line
B
Right side of the line.
The text that you want to appear at the
bottom of every page of each report.
Required.
No Default.
139
1
Parameter Reference
UHDxx Parameter Record
The optional UHDxx parameter allows you to specify any additional text that you
want printed at the top of each page of each report.
NOTE: Any heading you specify is printed at the top of every page of each report.
You can specify up to four header lines.
Field-by-Field
Table 48: UHDxx Parameter Fields .
Position
Description
Comments
1-3
KEYWORD
UHD is the only acceptable entry.
4
LINE NUMBER
The header line number. Enter 1, 2, 3, or
4.
5
LINE SIDE
Indicate the side of the header line on
which this text should appear.
7-72
140
Field Name
HEADER TEXT
A
Left side of the line
B
Right side of the line.
The text that you want to appear at the
top of each page of every report.
Required.
Required.
No default.
Required.
No Default.
Software Release 4.0.0/March 2015
Z4 OUT Parameter Record
1
Z4 OUT Parameter Record
The optional Z4 OUT parameter tells CODE-1 Plus where on the output record to
store the ZIP + 4 Code and Delivery Point Barcode (DPBC) information.
Field-by-Field
Table 49: Z4 OUT Parameter Fields (Part 1 of 4)
Position
Field Name
Description
Comments
1-6
KEYWORD
Z4 OUT is the only acceptable entry.
Required.
8-10
Location for
ZIP + 4 RETURN
CODE
Location on the output record for the
1-character ZIP + 4 return code. One of the
following codes is stored:
Optional.
No default.
12-14
Working With CODE-1 Plus
Location for
ZIP + 4 CODE
Blank
The match attempt was successful.
7
The ZIP+4 was suppressed. Record
matched to a Carrier Route R777
(phantom).
A
Apartment number missing or not
found in database, and an apartmentlevel match was required.
B
Insufficient (or blank) address match
information.
C
The address probable correctness or
overall probable correctness was too
high.
D
Information was dropped.
H
House/box number not found on
street.
L
The standardized address was too
long.
M
Multiple matches of equal quality
were found.
N
The ZIP + 4 Code wasn't stored
because the processing
requirements specified that it was not
to be stored.
S
Street name not found in ZIP Code.
U
Unavailable—auxiliary file
processing.
V
The record was matched to a nondeliverable street address (in this
case, the ZIP + 4 will be blank, but the
carrier route could have a value).
Z
ZIP Code not found in database.
Location on the output record for the ZIP + 4
Code.
Optional.
No default.
141
1
Parameter Reference
Table 49: Z4 OUT Parameter Fields (Part 2 of 4)
Position
16
Format of
ZIP + 4 CODE
Description
Comments
Format of the ZIP + 4 Code on the output
record. Enter one of the following codes:
C
4-byte number
P
3-byte packed number
-
4-byte number stored with a
preceding
hyphen (-).
Optional.
Default is C.
18-20
Location for
DELIVERY POINT
BARCODE
Location on the output record for the
6-character delivery point barcode.
Optional.
No default.
22-24
Location for
DELIVERY POINT
BARCODE ADDON WITH CHECK
DIGIT
Location on the output record for the
2-character delivery point barcode add-on
with the 1-character check digit (a total of 3
characters is stored).
Optional.
No default.
26-28
Location for
MASTER FILE
VINTAGE DATE
Location on the output records for the master
file vintage date of the current master file.
Optional.
No default.
30
Format of
MASTER FILE
VINTAGE DATE
Code indicating the format of the master file
vintage date on the output records. Enter one
of the following formats:
Optional.
Default is C.
32-34
142
Field Name
Location for
Z4 CHANGE
RETURN CODE
B
2-byte binary format YYMM
C
4-byte character format YYMM
P
3-byte packed decimal format YYMM
3
3-byte binary format YYYYMM
6
6-byte character format YYYYMM
4
4-byte packed decimal format
YYYYMM.
Location on the output records for the Z4
Change Return Code. One of the following
codes is stored:
0
Address matching was not performed
for this record.
4
Address matching was performed for
this record.
8
A fatal error occurred.
If a location
is specified in
this position,
a location for
ZIP + 4 Code
and format of
ZIP + 4 Code
must be
specified in
positions 1214 and 16 of
this
parameter.
Optional.
No default.
Software Release 4.0.0/March 2015
Z4 OUT Parameter Record
1
Table 49: Z4 OUT Parameter Fields (Part 3 of 4)
Position
Field Name
Description
Comments
36-38
Location for
DPBC ADD-ON
Location on the output record for the
2-character DPBC Add-on. Valid only when
positions 12-14 are defined.
Optional.
No default.
40-42
Location for
DPBC ADD-ON
CHECK DIGIT
Location on the output record for the
1-character DPBC Add-on Check Digit. Valid
only when positions 18-20 or 36-38 are
defined.
Optional.
No default.
58
Storage
conditions —
R777 CARRIER
ROUTE FOUND
Addresses with Carrier Route R777 are
phantom routes and are not eligible for street
delivery. Since these addresses are assigned
a ZIP + 4 code by the USPS, CODE-1 Plus
marks these addresses as deliverable. If you
do not want addresses with Carrier Route
R777 marked as deliverable, set this option to
Y and the following actions are performed for
the address:
Optional.
Default is to
store ZIP+4
(DPBC).
• No ZIP + 4 Code is assigned
• Address is not counted on the USPS Form
3553 (CASS Summary Report)
• DPV Footnote of R7 is returned
Valid values are:
60
Storage
conditions —
INFORMATION
DROPPED
Y
Yes, if Carrier Route R777 is found,
add to the ZIP + 4 Suppressed Count
on the USPS Form 3553. R777
addresses are not deliverable. Do not
store the ZIP + 4 (DPBC).
Blank
If Carrier Route R777 is found, do not
add to the ZIP + 4 Suppressed Count
on the USPS Form 3553. R777
addresses are deliverable. Store the
ZIP + 4 (DPBC).
Code indicating whether the standardized
ZIP + 4 and DPBC should be stored when
information was dropped during the
standardization process. Enter one of the
following codes:
X
Do not store if information was
dropped.
Blank
Store the information anyway.
Optional.
Default is to
store the
information.
62
MAXIMUM
ADDRESS
CORRECTNESS
Maximum acceptable address probability of
correctness to store the standardized ZIP + 4
and DPBC. Enter a number between 0 and 9,
where 0 indicates the best case and 9
indicates the worst case.
Optional.
Default is 9.
64
MAXIMUM
OVERALL
CORRECTNESS
Maximum acceptable overall probability of
correctness to store the standardized ZIP + 4
and DPBC. Enter a number between 0 and 9,
where 0 indicates the best case and 9
indicates the worst case.
Optional.
Default is 9.
Working With CODE-1 Plus
143
1
Parameter Reference
Table 49: Z4 OUT Parameter Fields (Part 4 of 4)
Position
68
70
71
72
Field Name
Storage
conditions —
MULTIPLE ZIP + 4
Storage
conditions —
MULTIPLE ZIP
CODE
FILE
ALLOCATION —
ZIP + 4 OF ZEROS
OR 9999
DISPOSITION
INDICATOR
Description
Comments
Code indicating whether the standardized ZIP
+ 4 and DPBC should be stored when multiple
ZIP + 4 matches were found. Enter one of the
following codes:
Blank
Store the information indicated in
position 72.
M
Store the standardized ZIP + 4 and
DPBC anyway.
N
Store the information indicated in
position 72 and write the record to the
NCO file.
Code indicating whether the standardized ZIP
+ 4 and DPBC should be stored when multiple
ZIP Code matches were found. Enter one of
the following codes:
Blank
Store the information indicated in
position 72.
M
Store the standardized ZIP + 4 and
DPBC anyway.=
Indicator that specifies which output file to
write the record when ZIP + 4 is zeros or
“9999.”
Blank
Write the record to the COK file
N
Write the record to the NCO file.
Code indicating what should be stored in
cases where the standardized ZIP + 4 and
DPBC were not stored, either because no
match was found, or due to storage
conditions. Enter one of the following codes:
B
Store blanks.
I
Store input ZIP + 4 Code.
X
Store nothing.
Optional.
Default is to
store
whatever is
indicated in
position 72.
Optional.
Default is to
store
whatever is
indicated in
position 72.
Default is
blank.
Optional.
Default is B.
NOTE: If you specify I, and the input ZIP + 4
Code is non-numeric or all zeros, then
blanks are stored.
144
Software Release 4.0.0/March 2015
Z5 OUT Parameter Record
1
Z5 OUT Parameter Record
The optional Z5 OUT parameter tells CODE-1 Plus where on the output record to
store the 5-digit ZIP Code information.
NOTE: Although Z5 OUT is an optional parameter, if you run a job without it,
CODE-1 Plus will not write any results to the C1BMCOK output file.
NOTE: CODE-1 Plus considers an input ZIP Code of 00000 to be invalid. If you
want to preserve an input ZIP Code that is all zeros, you will have to do so with
either a MOVE I parameter or an exit routine.
Working With CODE-1 Plus
145
1
Parameter Reference
Field-by-Field
Table 50: Z5 OUT Parameter Fields (Part 1 of 3)
Position
146
Field Name
Description
Comments
1-6
KEYWORD
Z5 OUT is the only acceptable entry.
Required.
8-10
Location for
ZIP CODE RETURN
CODE
Location on the output record for the
1-character ZIP Code return code. One of the
following codes is stored:
Optional.
No default.
Blank
The match attempt was successful.
7
The ZIP + 4 was suppressed. Record
matched to a Carrier Route R777
(phantom).
A
Apartment number missing or not
found in database, and an apartmentlevel match was required.
B
Insufficient (or blank) address match
information.
C
The address probable correctness or
overall probable correctness was too
high.
D
Information was dropped.
E
External match—auxiliary file
processing.
H
House/box number not found on
street.
L
The standardized address was too
long.
M
Multiple matches of equal quality were
found.
N
The ZIP Code wasn't stored because
the processing requirements specified
that it was not to be stored.
S
Street name not found in ZIP Code.
Z
ZIP Code not found in database.
12-14
Location for
ZIP CODE
Location on the output record for the
standardized ZIP Code.
Optional.
No default.
16
Format of
ZIP CODE
Format of the standardized ZIP Code.
Optional.
Default is C.
C
5-byte number
P
3-byte packed number.
Software Release 4.0.0/March 2015
Z5 OUT Parameter Record
1
Table 50: Z5 OUT Parameter Fields (Part 2 of 3)
Position
18-20
22-24
Field Name
Location for
SOURCE OF FINAL
ZIP CODE
Location for PO
BOX-ONLY ZIP
CODE
Description
Comments
Location on the output record for the source of
the final ZIP Code, a 1-character code
reflecting the source of the final ZIP Code.
B
No ZIP Code was determined.
F
The final ZIP Code was determined
from the finance number.
L
New address obtained from LACS
processing.
M
The final ZIP Code was determined
from the ZIPMOVE database.
Z
The original ZIP Code was retained.
Location on the output record for the P. O. Boxonly ZIP Code indicator. Addresses located
within a P. O. Box-only delivery zone can only
receive postal delivery through the use of a
P. O. Box. No other postal delivery method is
available for these addresses.
Optional.
No default.
• Y — P. O. Box-only ZIP Code.
• Blank — Not a P. O. Box-only ZIP Code.
26-28
Location for VALID
ZIP CODE FLAG
Location on the output record for the Valid ZIP
Code flag.
Optional.
No default.
• Y — Input City, State, and ZIP Code
correspond.
• N — Input city, state, ZIP Code do not
correspond, or is invalid.
• Blank — ZIP Code could not be determined
for input address.
60
Storage conditions
— INFORMATION
DROPPED
Code indicating whether the standardized ZIP
Code should be stored when information was
dropped during the standardization process.
Blank
Store the information anyway.
X
Do not store if information was
dropped.
Optional.
Default is to
store the
information.
62
MAXIMUM
ADDRESS
CORRECTNESS
Maximum acceptable address probability of
correctness to store the standardized ZIP
Code. Enter a number between 0 and 9, where
0 indicates the best case and 9 indicates the
worst case.
Optional.
Default is 9.
64
MAXIMUM
OVERALL
CORRECTNESS
Maximum acceptable overall probability of
correctness to store the standardized ZIP
Code. Enter a number between 0 and 9, where
0 indicates the best case and 9 indicates the
worst case.
Optional.
Default is 9.
Working With CODE-1 Plus
147
1
Parameter Reference
Table 50: Z5 OUT Parameter Fields (Part 3 of 3)
Position
66
Field Name
UNIQUE ZIP CODE
HANDLING
Description
Comments
Code indicating whether the Input ZIP Code
should be returned if it is unique and does not
correlate with the input city/state.
Blank
Do not store the Input ZIP Code.
X
Store the information indicated in
position 72.
Optional.
Default is to
not store the
input ZIP
Code.
NOTE: If X is chosen, a non-CASS certified
configuration will be created. No PS 3553 Form
will be generated.
70
72
Storage conditions
— MULTIPLE ZIP
CODE
DISPOSITION
INDICATOR
Code indicating whether the standardized ZIP +
4 and DPBC should be stored when multiple
ZIP Code matches were found.
Blank
Store the information indicated in
position 72.
M
Store the standardized ZIP + 4 and
DPBC anyway.=
Code indicating what should be stored in cases
where the standardized ZIP Code was not
stored either because no match was found, or
due to storage conditions. Enter one of the
following codes:
B
Store blanks.
I
Store input ZIP Code.
X
Store nothing.
Optional.
Default is to
store
whatever is
indicated in
position 72.
Optional.
Default is I.
NOTE: If you specify I, and the input ZIP Code
is non-numeric or all zeros, then blanks is
stored.
148
Software Release 4.0.0/March 2015
CHAPTER 2
Interactive Screen Reference
This chapter provides a complete reference for the CODE-1 Plus interactive screens.
Each screen is presented, along with its fields and function keys. For information on
getting started with interactive processing, please refer to Chapter 13, Getting
Started With Interactive Processing in your Getting Started with CODE-1 Plus Guide.
The Command Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using Concatenated Commands. . . . . . . . . . . . . . . . . . . . . . . . . .
Screens that Support Address Matching . . . . . . . . . . . . . . . . . . . . . .
Address Match Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delivery Sequence Footnotes Screen. . . . . . . . . . . . . . . . . . . . . .
Miscellaneous Information/Base Address Screen . . . . . . . . . . .
Expanded Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Geographic Coding Information . . . . . . . . . . . . . . . . . . . . . . . . . .
Match Settings Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multiple Elements Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parsed Elements Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Return Codes Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Statistics Screen. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Address Stack Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Screens that Support Database Inquiry . . . . . . . . . . . . . . . . . . . . . . .
Apartments at a House Range . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cities in a State Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cities in a ZIP Code Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
City Information Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Firms in a House Range Screen . . . . . . . . . . . . . . . . . . . . . . . . . .
Houses on a Street Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Streets in a City or Streets in a ZIP Code Screen . . . . . . . . . . . .
Geographic Coding Plus Interface . . . . . . . . . . . . . . . . . . . . . . . .
Screens that Support Site Customization . . . . . . . . . . . . . . . . . . . . .
Administration Sign-on Screen. . . . . . . . . . . . . . . . . . . . . . . . . . .
Interactive Customization Screens . . . . . . . . . . . . . . . . . . . . . . . .
Database Information Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customization File Administration . . . . . . . . . . . . . . . . . . . . . . . . . . .
File Backup and Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
File Repair, Re-Initialization, and Password Display . . . . . . . . .
Batch Uncoded Records Interface (G1CPBNC) . . . . . . . . . . . . . . . . .
How it Works. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UR COMMAND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working With CODE-1 Plus
151
156
156
157
159
162
165
166
168
171
174
177
184
188
192
192
194
197
199
201
203
206
208
214
214
215
223
224
225
225
226
226
227
149
2
Interactive Screen Reference
UW COMMAND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Program Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Description of Supplied Sample G1CPBNC . . . . . . . . . . . . . . . . . 230
150
Software Release 4.0.0/March 2015
The Command Field
2
The Command Field
There is one field that appears on every screen in the Interactive CODE-1 Plus
System: the Command field. This field enables you to move gracefully through
address match attempt results as well as database inquiry data. The following table
lists all of the commands that you can enter in the Command field. In addition, the
table lists alternate actions you can take to accomplish the same results as the
command. For each command listed, the underlined portion is all that is required for
entry (you can enter the entire command string, however).
Table 1: Valid Entries in the Command Field (Part 1 of 6)
Command
Description
Alternate Method
General Commands
BOTTOM
Move to the bottom of the data. In the
address match function, this command
brings you to the Base Address/Dropped
Information screen. In the database inquiry
function this command repositions the list
of data to the last entry.
None.
DOWN
Move down one display of data. In the
address match function this command
moves you to the next match results screen.
In the database inquiry function this
command repositions the list of data down
one display.
Press F8
F8 with a number
between 1 and 9998 on
the command line will
scroll down that
number of lines.
NOTE: If the cursor is placed on a specific
line, “DOWN” will result in that line
appearing as the first displayed line on the
screen.
EXTEND
Allows you to override database expiration,
so you can match interactively with an
expired database.
None.
NOTE: You must use the “EXTEND”
command each time an expired database is
identified by the software initialization.
FLIP
Flip the screen from the combined functions
to the zoomed database inquiry function or
from the zoomed database inquiry function
to the combined functions, whichever is
appropriate.
Press F10.
HELP
Access the online help system.
Press F1.
Right
Scroll right to see more of the firm/alias
name on the Houses on a Street screen.
None.
LEft
Scroll left to see first part of firm/alias name
on the Houses on a Street screen.
None.
QUIT
Exit from the Interactive CODE-1 Plus
System.
Press F3.
Working With CODE-1 Plus
151
2
Interactive Screen Reference
Table 1: Valid Entries in the Command Field (Part 2 of 6)
Command
Description
Alternate Method
TOP
Move to the top of the data. In the address
match function this command brings you to
the Return Code screen. In the database
inquiry function, this command repositions
the list of data to the first entry.
None.
UP
Move up one display of data. In the address
match function this command moves you to
the previous match results screen. In the
database inquiry function this command
repositions the list of data up one display.
Press F7
F7 with a number
between 1 and 9998 on
the command line will
scroll up that number of
lines.
NOTE: If the cursor is placed on a specific
line, “UP” will result in that line appearing
as the last displayed line on the screen.
Customizing Interface Commands
152
ADMIN
Go to the Administration Sign-on screen.
Can be called from the split match/inquiry
or full (flip) screens.
None.
NAVIGATE
Toggle navigation mode on and off.
Positions inquiry screen as close as possible
to the lowest level of match success on a
non-matched address.
None.
DPV
Toggle DPV mode on and off. When turned
on you will be able to do Delivery Point
Validation processing.
On the Interactive
Customization Screen,
you can enter blank or x
under Perform DPV
Process.
DPVKEY
Displays the Seed Code of the DPV seed
record encountered which disabled DPV
processing.You will need to be provide this
Seed Code to Pitney Bowes before you can
receive another permanent License
Management key to continue your DPV
processing.
None.
DPVZAP
Initializes the customization area that
contains the Seed Code. This does NOT
inhibit DPV processing.
None.
LOT
Toggle LOT mode on and off. When turned
on you will be able to do Line of Travel
matching.
LTO
LTO
Toggle LOT mode on and off. When turned
on you will be able to do Line of Travel
matching.
LOT
RDI
Toggle RDI mode on and off. When turned
on you will be able to do Residential Delivery
File matching
RDI
Software Release 4.0.0/March 2015
The Command Field
2
Table 1: Valid Entries in the Command Field (Part 3 of 6)
Command
Description
Alternate Method
Database Inquiry Commands
AH <line number>
Move to the Apartments at a House Range
screen for the house range displayed on line
<line number>.
This command is only valid from the Houses
on a Street screen.
ALIAS <line number>
Display the base street name for the alias
street listed on line <line number>.
For the Apartments at a House Range
screen and Firms on a Street screen only.
Type the desired line
number in the
Command field and
press F4.
or
Position your cursor on
the desired line and
press F4.
Type the desired line
number in the
Command field and
press F2.
or
Position your cursor on
the desired line and
press F2.
BACK
Return to the previous database inquiry
level. (For example, if you were at the
Streets in a City screen, this command
would take you back to the Cities in the
Database screen.)
Press F6.
CI <city>
Go to the City Information screen.
None.
CS <state abr.>
Go to the Cities in a State screen for the two
character state abbreviation that is entered
as <state abr.>.
None.
CZ <line number>
Move to the Cities in a ZIP Code screen for
the ZIP Code that is displayed on line <line
number>.
Type the desired line
number in the
Command field and
press F5.
or
CZ <ZIP Code>
or
Move to the Cities in a ZIP Code screen for
the ZIP Code entered as <ZIP Code>.
or
Position your cursor on
the desired line and
press F5.
DB
Display the information for your database,
including software release and the
expiration date of your databases.
None.
FM <line number>
Move to the Firms on a Street screen for the
street name or house range displayed on
line <line number>.
Type the desired line
number in the
Command field and
press F5.
This command is only valid from the Houses
on a Street, or Apartments at a House Range
screens.
Working With CODE-1 Plus
or
Position your cursor on
the desired line and
press F5.
153
2
Interactive Screen Reference
Table 1: Valid Entries in the Command Field (Part 4 of 6)
Command
HS <line number>
Description
Alternate Method
Move to the Houses on a Street screen for
the street name that is displayed on line
<line number>.
This command is only valid from the Streets
in a City or Streets in a ZIP Code screens.
LOCATE <string>
Generally positions the database inquiry to
the first entry that starts with <string>.
Type the desired line
number in the
Command field and
press F4.
or
Position your cursor on
the desired line and
press F4.
None.
NOTE: If there are multiple cities with the
same name, they will be listed by finance
number, highest to lowest.
MATCH
Go to the address match function. (The
match results screen that appears when you
access the database inquiry function reappears.)
Press F9.
SC <line number>
Move to the Streets in a City screen for the
city name that is displayed on line <line
number>.
Type the desired line
number in the
Command field and
press F4.
This command is only valid from the Cities in
the Database screen.
SL <line number>
Display all streets in the city locality
displayed on line <line number> on the
Streets in a City screen.
or
Position your cursor on
the desired line and
press F4.
Type the desired line
number in the
Command field and
press F4.
or
Position your cursor on
the desired line and
press F4.
SZ <line number>
Move to the Streets in a ZIP Code screen for
the ZIP Code that is displayed on line <line
number>.
This command is only valid from the Cities in
a ZIP Code screen.
SZ <ZIP Code>
154
Type the desired line
number in the
Command field and
press F4.
or
Position your cursor on
the desired line and
press F4.
Move to the Streets in a ZIP Code screen for
the ZIP Code entered as <ZIP Code>
None.
Software Release 4.0.0/March 2015
The Command Field
2
Table 1: Valid Entries in the Command Field (Part 5 of 6)
Command
ZC <line number>
Description
Display all ZIP Codes for the city locality
displayed on line <line number> on the City
Information and Cities in a State screens.
Alternate Method
Type the desired line
number in the
Command field and
press F2.
or
Position your cursor on
the desired line and
press F2.
Address Match Commands
INQUIRY
Go to the database inquiry function. If you
had previously used the database inquiry
function during this session, the screen that
appeared when you left the database inquiry
function reappears.
Press F9.
AS
Display address stack entries for the
address you entered.
None.
ASM
Turn on or off All Street Matching function.
DB
Display current CODE-1 Plus database
vintage and expiration date.
None.
ESM
Turn on or off Enhanced Street Matching
function.
None
SUITE
Invokes SuiteLink processing.
None
LACS
Invokes LACSLink processing.
None
RC
Go to the Return Codes screen.
None.
DS
Go to the Delivery Sequence Footnotes
screen.
None.
PE
Go to the Parsed Elements screen.
None.
ME
Go to the Multiple Elements screen.
None.
ST
Go to the Statistics screen.
None.
DI
Go to the Miscellaneous Address Values
screen.
None.
ER
Go to the Expanded Return Codes screen.
None.
GC
Go to the Geographic Coding Information
screen.
None.
This command is only valid if you have
Geographic Coding Plus installed.
Working With CODE-1 Plus
155
2
Interactive Screen Reference
Table 1: Valid Entries in the Command Field (Part 6 of 6)
Command
Description
Alternate Method
MS
Go to the Match Settings screen, and
unprotect the match control fields on the
Address Match screen.
Press F4.
REFRESH
Clear all fields on all address match
function screens.
Press F5.
Using Concatenated Commands
You can concatenate commands at the command line or the initial G1CP transaction
in CICS. A combination of the primary screen commands CI, CS, CZ, or SZ; a locate
command; and “FLIP” can be concatenated, or delimited by the semicolon (;)
character. From a blank CICS screen, the following string would produce a full screen
display positioned at “Baltimore” on a “cities in state” screen (with the state of
Maryland):
G1CP, CS MD;L BALTIMORE;FLIP
This command is separated from the transid by a comma, and semicolons delimit the
portions of the command string. From the command line on any split screen, the same
result would be achieved by the following command:
CS MD;L BALTIMORE;FLIP
If this command were entered on a full inquiry screen display, the final result would
be a split screen (match and inquiry) display.
Screens that Support Address Matching
The screens shown in this section of the chapter support the address matching
function. They are listed in alphabetical order.
NOTE: To minimize maintenance, the interactive screens in this chapter do not
display the database version and the date stamp. We also use “__ of __” to represent
the screen currently displayed, instead of “1 of 62,381,” for example.
156
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Address Match Screen
The Address Match screen occupies the top half of the physical screen in the
Interactive CODE-1 Plus System, unless you have entered the FLIP command to
cause the database inquiry function to be displayed on the entire physical screen.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name:
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr:
Correct ZIP Y
City, ST:
Output Case: U
ZIP Code:
Urb Name:
Mult Secondary: Y
Override City: Z
Matched Addr:
CRRT:
City,State ZIP:
DPBC:
------------------------------------------------------------------------------Command:
Nav DPV
__ of __
City Information
LN City
State
ZIP Range
Type
URB Unique-ZIP
1 A A R P
CA
90848
V
2 A A R P INS
PA
19187
V
Y
3 A A R P PHARMACY
CA
90848
V
Y
4 A A R P PHARMACY
CT
06167
V
Y
5 A C NIELSEN
TX
79966-79974
V
Y
6 A H MCCOY FEDERAL BLDG
MS
39269
V
7 A M F GREENSBORO
NC
27425
V
8 A M O R C
CA
95191
V
Y
The match settings have been changed.
1=Help
2=ZC
3=Quit
4=SC
5=CZ
8=Down
9=Mat
10=Flip
This screen enables you to enter an input address that you want CODE-1 Plus to
match against the database. CODE-1 Plus will return the matched, standardized
address for you.
NOTE: If you attempt to use the DPV option without having a license to do so, the
following message will appear at the bottom of this screen:
DPV UNAVAILABLE - NO LICENSE FOUND
or
DPV UNAVAILABLE - LICENSE INVALID.
Fields
The following table presents a description of, and acceptable values for, each field on
the Address Match screen.
Working With CODE-1 Plus
157
2
Interactive Screen Reference
NOTE: Shaded fields are required.
Table 2: Fields on the Address Match Screen
Field Name
Description
Firm Name
The name of the firm for the record you want to match —
optional
Secondary Addr
The secondary address line for the record you want to match
— optional
Primary Addr
The primary address for the record you want to match.
City, ST
The city and state for the record you want to match. You can
enter the state name or abbreviation — optional if ZIP Code is
entered.
ZIP Code
The ZIP Code for the record you want to match — optional if
City, St is entered
USPS County Name or
Urb. Name
If the address matches to a Puerto Rican address which has
an urbanization name associated with it, this field contains
that urbanization name. Otherwise, the field contains the
USPS county name where the matched address is located. If
Geographic Coding Plus is installed, you can optionally
display the Geographic Coding county name.
Matched Addr.
The matched standardized address, including apartment
number
City, State ZIP
The matched standardized city/state/ZIP Code line
CRRT (Carrier Route)
The matched standardized Carrier Route Code
DPBC + Check
The matched delivery point barcode (DPBC) and check digit
Function Keys
The following table describes the action taken by each function key on the Address
Match screen.
Table 3: Function Keys on the Address Match Screen
Function Key
158
Name
Description
F1
HELP
Obtain online help.
F2
ZC
List ZIP Codes in City screen.
F3
QUIT
Exit from the Interactive CODE-1 Plus System.
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Table 3: Function Keys on the Address Match Screen
Function Key
Name
Description
F4
SC
Go to the Streets in a City screen.
F5
CZ
Go to the Cities in a ZIP Code screen.
F8
DOWN
Go to the next screen of data.
F9
MAT
Go to the Return Codes screen.
F10
FLIP
Expand the database inquiry function to fill the
entire screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER.)
Delivery Sequence Footnotes Screen
The Delivery Sequence Footnotes screen shows you all of the Delivery Sequence
Footnotes (DSF2 codes) that were applicable to your match attempt. This screen is
accessed by entering DS in the Command field, or by pressing F8 from the Return
Codes screen or F7 from the Parsed Elements screen.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name: LOCUS INC
Firm: T D/Suf: T
Secondary Addr:
St: T Vcity: S
Primary Addr: 2560 HUNTington ave #302
Correct ZIP: Y
City, ST: alexandria va
Output Case: U
ZIP Code: 22303
Urb Name:
Mult Secondary: Y
USPS County: Fairfax
Override City: Z
Matched Addr: 2560 Huntington Ave Ste 302
CRRT: C009
City,State ZIP: Alexandria VA 22303-1493
DPBC: 149360 7
------------------------------------------------------------------------------Command:
Nav Off
2 of 6
DS - Delivery Sequence Footnotes
AA :
F :
1=Help
Working With CODE-1 Plus
Record matched the ZIP+4 database.
Secondary address was changed.
3=Quit
4=MS
5=RE
6=Geo
7=Up
8=Down
9=Inq
10=Flip
159
2
Interactive Screen Reference
Fields
The following table presents a description of, and acceptable values for, each field on
the Delivery Sequence Footnotes screen.
Table 4: Delivery Sequence Footnotes Screen (Part 1 of 2)
DSF2 Code
160
Description
AA
The record matched the ZIP+4 database (the CODE-1 Plus database).
A1
No match was found.
A2
The alias street name was matched to a base street name on the database.
A3
A match was made to an alternate record on the database.
BB
The record was matched to the DSF2 file.
B1
No acceptable match was made to the DSF2 file.
B2
An alias street name matched a base street name on the DSF2 file.
B3
A match was made to an alternate record on the DSF2 file.
CC
The record matched the DSF2 file, but is missing secondary information.
C1
The input record matched but is missing secondary information.
D
City name or state was changed.
E
Primary address was changed.
F
Secondary address was changed.
G
The delivery point is vacant.
H
ZIP Code was changed.
I
The input address could not be parsed.
J
City, state, and ZIP Code could not be validated.
K
Multiple matches in primary address.
K1
Multiple matches due to missing or incorrect directionals.
K2
Multiple matches due to missing or incorrect suffix.
L
Multiple matches in secondary address.
M1
Missing street number.
M2
Address not found.
M3
No such primary number.
M4
Firm name not matched.
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Table 4: Delivery Sequence Footnotes Screen (Part 2 of 2)
DSF2 Code
Description
N1
Missing secondary address number.
N2
Secondary address number not found on file.
P1
Missing rural route/highway contract box number.
P2
Rural route/highway contract box number not found on file.
Q1
Missing PO Box number.
Q2
PO Box number not found on file.
Function Keys
The following table describes the action taken by each function key on the Delivery
Sequence Footnotes screen.
Table 5: Function Keys on the Delivery Sequence Footnotes Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Exit from the Interactive CODE-1 Plus System.
F4
MS
Go to the Match Settings screen.
F5
RE
Refresh (erase) all of the input and output data
from the screen.
F6
GEO
Go to the Geographic Coding Interface (you must
have purchased and installed Geographic Coding
Plus separately).
F7
UP
If the top of the list of DSF2 codes is displayed,
return to the previous match results screen. If the
top of the list of DSF2 codes is not currently
displayed, page up the list of codes.
F8
DOWN
If the bottom of the list of DSF2 codes is displayed,
go to the next match results screen. If the bottom
of the list of DSF2 codes is not currently displayed,
page down the list of codes.
F9
INQ
Go to the database inquiry function.
F10
FLIP
Go to the database inquiry function and expand it to
fill the entire physical screen.
Working With CODE-1 Plus
161
2
Interactive Screen Reference
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or
in the Command field, type HELP and press ENTER).
Miscellaneous Information/Base Address Screen
The Miscellaneous Information/Base Address screen shows you the base address for the
street that was matched (if applicable) and additional information about the matched
address.
To access the screen, enter the DI command, or press F8 from the Statistics screen.
The following is a sample of the Miscellaneous Information/Base Address screen.
CODE-1 Plus Coding System
--------------------------------------------------------------------------Firm Name: Pitney Bowes Business Insight
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr: 4200 parliament pl #600
Correct ZIP: Y
City, ST: lanham md
Output Case: U
ZIP Code: 207061844 Urb Name:
Mult Secondary: Y
USPS County: Prince Georges
Override City: Z
Matched Addr: 4200 Parliament Pl Ste 600
CRRT: C059
City,State ZIP: Lanham MD 20706-1844
DPBC: 184400 8
--------------------------------------------------------------------------Command:
__ of __
DI - Misc Address Values
(6 of 6)
Base Address:
Preferred Alias: Y Abbrev Alias: Y Line of Travel Results: 0001A K0
Finance Number: 235076
Last Line Number: V23825
Standardized Firm Name: Pitney Bowes Business Insight
County Name: Prince Georges
County Number: 033
Congressional District: 04
LACS:
Matching Primary Range Low:
4200 High:
4200
Parity: B
Matching Secondary Range Low:
600 High:
600
Parity: B
1=Help
162
3=Quit
4=MS
5=RE
6=Geo
7=Up
9=Inq
10=Flip
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Fields
The following table presents a description of, and acceptable values for, each field on
the Miscellaneous Information/Base Address screen.
Table 6: Fields on Miscellaneous Information/Base Address Screen
(Part 1 of 2)
Field Name
Description
Base Address
The base street address for the alias street that the input record
matched
Preferred Alias
Preferred Alias Processing Indicator
Abbreviated Alias
Abbreviated Alias Processing Indicator
Line of Travel Results
A 5-character sequence code plus 2-character alternate
sequence code
Finance Number
The USPS finance number
Last Line Number
The alphanumeric, cross-reference value between the CODE-1
Plus City/State file and the ZIP Code file
Standardized Firm Name
The firm name that was returned during the matching process
USPS County Name
The county where the address resides
USPS County Number
A USPS-assigned number for the county name
Congressional District
A USPS-assigned, 2-digit number representing the address’
congressional district
LACS
Location for the Locatable Address Correction Service indicator
on the output record. This indicator flags any rural addresses that
changed to urban addresses, such as RR 4 BOX 1 changing to
2200 MAIN ST. The next time you process the file, you can identify
and process only those records on the ZIP+4 database with rural
address changes. One of the following codes is stored:
Blank
Address was not LACS converted (no change).
L
Address was LACS converted (changed to an urban
address).
Matching Primary
Working With CODE-1 Plus
Range Low
The low house range used for the matching process
Range High
The high house range used for the matching process
Parity
Even or odd numbers in range
163
2
Interactive Screen Reference
Table 6: Fields on Miscellaneous Information/Base Address Screen
(Part 2 of 2)
Field Name
Description
Matching Secondary
(if it exists)
Range Low
The low unit range used for the matching process
Range High
The high unit range used for the matching process
Parity
Even or odd numbers in range
Function Keys
The following table describes the action taken by each function key on the
Miscellaneous Information/Base Address screen.
Table 7: Function Keys on the Miscellaneous Information/Base
Address Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Exit from the Interactive CODE-1 Plus System.
F4
MS
Go to the Match Settings screen.
F5
RE
Refresh (erase) all of the input and output data
from the screen.
F6
GEO
Go to the Geographic Coding Interface (you must
have purchased and installed Geographic Coding
Plus separately).
F7
UP
Return to the previous match results screen.
F9
INQ
Go to the database inquiry function.
F10
FLIP
Go to the database inquiry function and expand it to
fill the entire physical screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER).
164
Software Release 4.0.0/March 2015
2
Screens that Support Address Matching
Expanded Return Codes
The Expanded Return Codes screen shows you textual descriptions of each of the return
codes that are displayed on the Return Codes screen. You can access this screen by
entering the ER command in the Command Field. The following is a sample of the
Expanded Return Codes screen.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name: LOCUS INC
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr: 2560 HUNTington ave #302
Correct ZIP: Y
City, ST: alexandria va
Output Case: U
ZIP Code: 22303
Urb Name:
Mult Secondary: Y
USPS County: Fairfax
Override City: Z
Matched Addr: 2560 Huntington Ave Ste 302
CRRT: C009
City,State ZIP: Alexandria VA 22303-1493
DPBC: 149360 7
------------------------------------------------------------------------------Command:
Nav Off
1 of 1
ER - Expanded Return Codes
General RC:
Record Type:
Unit RC:
Firm RC:
Source of Adr:
ZIP Status:
Source of ZIP:
The address match was successful.
Firm
The input unit doesn’t match the units for house range.
There were no firms on the database for this address.
The output address was taken from the primary line.
The input ZIP was confirmed by an address match.
The original ZIP Code was retained.
1=Help
3=Quit
4=MS
5=RE
6=Geo
9=Inq
10=Flip
Fields
There are no fields to fill in the Expanded Return Codes screen.
Function Keys
The following table describes the action taken by each function key on the Expanded
Return Codes screen.
Table 8: Function Keys on the Expanded Return Codes Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Exit from the Interactive CODE-1 Plus System.
F4
MS
Go to the Match Settings screen.
F5
RE
Refresh (erase) all of the input and output data from the
screen.
Working With CODE-1 Plus
165
2
Interactive Screen Reference
Table 8: Function Keys on the Expanded Return Codes Screen
Function Key
Name
Description
F6
GEO
Go to the Geographic Coding Interface (you must have
purchased and installed Geographic Coding Plus
separately).
F9
INQ
Go to the database inquiry function.
F10
FLIP
Go to the database inquiry function and expand it to fill
the entire physical screen.
Geographic Coding Information
The Geographic Coding Information screen shows you the geographic coding data for
your matched address.
You can access this screen by entering the GC command in the Command Field. The
following is a sample of the Geographic Coding Information screen.
Settings Fields
1=Help
166
3=Quit
4=MS
5=RE
6=Geo
9=Inq
Information Only
MSA: 8840 WASHINGTON DC-MD-VA-WV
Setting Fields
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name: LOCUS INC
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr: 2560 HUNTington ave #302
Correct ZIP: Y
City, ST: alexandria va
Output Case: U
ZIP Code: 22303
Urb Name:
Mult Secondary: Y
USPS County: Fairfax
Override City: Z
Matched Addr: 2560 Huntington Ave Ste 302
CRRT: C009
City,State ZIP: Alexandria VA 22303-1493
DPBC: 149360 7
------------------------------------------------------------------------------Command:
Nav Off
1 of 1
GC - Geographic Coding Information
Match Level: 9
Lat/Long Level: 4
State: 51
Latitude: 038.7968 N
County: 059 FAIRFAX
Longitude: 077.0765 W
Census Tract: 420400
Census Block Grp: 1
10=Flip
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Fields
The following table presents a description of, and acceptable values for, each field on
the Geographic Coding Information screen.
Table 9: Fields on the Geographic Coding Information Screen
Field Name
Match Level
Description
The level of match obtained against the Geographic Coding
Master File. One of the following codes appears:
9
Both the ZIP Code and ZIP +4 Code matched the
Master File
5
The input ZIP Code matched, but the ZIP+4 Code
did not
X
The Geographic Coding Master File data has
expired.
State
The FIPS state code of the matched address.
County
The FIPS county number and name of the matched address.
MSA
The Metropolitan Statistical Area that encompasses this
address.
Census Tract
The 6-digit number representing the census tract division
within the county.
Census Block Group
The single-digit numeric code indicating the block group
division of the census tract.
Lat/Long Level
The level of latitude and longitude determined for the
matched address. One of the following codes will be
displayed.
Z
Latitude and longitude represent the area center of
the matched address.
T
Latitude and longitude represent the population
center of the census tract determined for the
matched address.
B
Latitude and longitude represent the population
center of the census block group determined for
the matched address.
Latitude
The latitude of the standardized address.
Longitude
The longitude of the standardized address.
Working With CODE-1 Plus
167
2
Interactive Screen Reference
Function Keys
The following table describes the action taken by each function key on the Geographic
Coding Information screen.
Table 10: Function Keys on the Geographic Coding Information Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Exit from the Interactive CODE-1 Plus System.
F4
MS
Go to the Match Settings screen.
F5
RE
Refresh (erase) all of the input and output data
from the screen.
F6
GEO
Go to the Geographic Coding Interface (you must
have purchased and installed Geographic Coding
Plus separately).
F9
INQ
Go to the database inquiry function.
F10
FLIP
Go to the database inquiry function, and expand it
to fill the entire physical screen.
Match Settings Screen
The Match Settings screen enables you to tailor your processing requirements. You
can also specify whether or not CODE-1 Plus should perform ZIP Code correction.
For each of the matching algorithms, you can change the default tightness/looseness
settings. These settings indicate how close the data on the database must be to the
input address in order for a match to occur. The tighter the setting, the more closely
the input address must match the database information.
You can access this screen by entering MS in the Command field, or by pressing the
function key F4 from any match results screen.
Note that the fields you can modify are actually on the top half of the physical screen,
along with the address matching fields. When the Match Settings screen is displayed,
the only fields in which you can enter data are the settings fields on the upper right
portion of the screen. To save your new settings and return to the previous screen,
just press ENTER. Once you have changed the settings, they stay changed for
subsequent matches until you change them again or exit.
168
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
The following is a sample of the Match Settings screen.
1=Help
-
Firm, Dir/Suf, St(reet) - T=Tight, M=Medium, L=Loose, E=Equal
X = Accept vanity city names, S = Do not accept
Y = Correct input ZIP Code if necessary, N = Do not correct
U = Uppercase, L= Lowercase, C = Mixed case
Y = Attempt to find ZIP+4 Match, N = Match to the default
Z = Return preferred ZIP+4 lastline, C = Return default USPS
3=Quit
Information Only
Algorithms
V(anity)city
Correct ZIP
Output Case
Mult 2ry Cmp
Override City
Settings Only
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name:
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr:
Correct ZIP Y
City, ST:
Output Case: U
ZIP Code:
Urb Name:
Mult Secondary: Y
Override City: Z
Matched Addr:
CRRT:
City,State ZIP:
DPBC:
------------------------------------------------------------------------------Command:
Nav DPV
1 of 1
Specify Match Settings
10=Exit
NOTE: Although this screen enables you to change the default matching
algorithm settings, we suggest that you maintain the default settings: (M)edium for
all matching, and Y(es) for ZIP correction.
Working With CODE-1 Plus
169
2
Interactive Screen Reference
Fields
The following table presents a description of, and acceptable values for, each field on
the Match Settings screen.
Table 11: Fields on the Match Settings Screen
Field Name
Algorithms
(V)anity City
Correct ZIP
Output Case
Mult Secondary
Override City
170
Description
A 1-character code indicating the tightness/looseness of
the firm name, directional and suffix, and street name
match:
E
Only equal matches are accepted.
T
Only tight matches are accepted.
M
Medium Matches are accepted (default).
L
Loose matches are accepted.
A 1-character code indicating whether or not a vanity city
name should be returned if it is the best match (i.e., it most
closely matches the input). Type one of the following codes:
X
Yes, return the vanity city name if it is the best
match.
S
No, return the standard city name (default).
A one-character code indicating whether or not you want
CODE-1 Plus to attempt to correct incorrect ZIP Codes —
optional. Type one of the following codes:
Y
Attempt ZIP Code correction, if necessary (default).
N
No, don't attempt ZIP Code Correction.
A 1-character code indicating whether or not the matched
address should be presented in mixed case, lower case, or
upper case:
C
Mixed case
L
Lower case
U
Upper case
A 1-character code indicating whether to attempt multiple
secondary component processing:
Y
Attempt secondary match.
N
Assign default ZIP+4 Code.
A 1-character code indicating whether the preferred last
line city name should be stored:
C
Store the city name from USPS City/State File
(default city name)
Z
Store the ZIP+4 File Preferred Last Line City Name
(override city name).
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Function Keys
The following table describes the action taken by each function key on the Match
Settings screen.
Table 12: Function Keys on the Match Settings Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Exit from the Interactive CODE-1 Plus System.
F10
CANCEL
Return to the previous screen without modifying
the match settings.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER.)
Multiple Elements Screen
The Multiple Elements screen shows you whether multiple match elements were found
during the match attempt. This screen can be accessed by entering the ME command,
or by pressing F8 from the Parsed Elements screen or F7 from the Statistics screen.
Working With CODE-1 Plus
171
2
Interactive Screen Reference
The following sample is a of the Multiple Elements screen.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name: LOCUS INC
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr: 2560 HUNTington ave #302
Correct ZIP: Y
City, ST: alexandria va
Output Case: U
ZIP Code: 22303
Urb Name:
Mult Secondary: Y
USPS County: Fairfax
Override City: Z
Matched Addr: 2560 Huntington Ave Ste 302
CRRT: C009
City,State ZIP: Alexandria VA 22303-1493
DPBC: 149360 7
------------------------------------------------------------------------------Command:
Nav Off
4 of 6
--ME - Multiple Elements
Was the city standardized?:
Was the state standardized?:
Was apartment detected in input?: Y
Was 'default record' matched?:
Were multiple input elements found?
Leading dir:
Street name:
LACSLINK ACTIVATED
1=Help
3=Quit
4=MS
5=RE
ASM/ESM Flag: A
SuiteLink RC:
SuiteLink MC:
SuiteLink FID:
Suffix:
6=Geo
7=Up
LACSLink RC: A
LACSLink Ind: Y
Trailing dir:
8=Down
9=Inq
10=Flip
Fields
The following table presents a description of, and acceptable values for, each field on
the Multiple Elements screen.
Table 13: Fields on the Multiple Elements Screen (Part 1 of 2)
Field Name
Was the city standardized?
Was the state
standardized?
Was apartment detected
in input?
172
Description
Code indicating whether or not the input city name was
standardized:
Blank
No match was found, or the input city name was the
same as either the long or short city name on the
database.
C
The input city name was standardized to either the
long or short city name.
Code indicating whether or not the input state was
standardized:
Blank
No match was found, or the input state was the same
as the state abbreviation on the database.
S
The input state was standardized to the appropriate
abbreviation.
A 1-character code indicating whether or not CODE-1 Plus
detected an apartment (or unit) in the input record:
Y
An apartment was detected in the input.
N
No apartment was detected in the input.
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Table 13: Fields on the Multiple Elements Screen (Part 2 of 2)
Field Name
Was “default record”
matched?
Were multiple input
elements found?
Alternate addressing
scheme
Leading dir
Street name
Suffix
Trailing dir
Working With CODE-1 Plus
Description
Code indicating whether or not the default record was
matched:
Blank
The record matched was not the default record, or no
match was obtained.
H
Highrise default.
R
Rural Route default.
M
Military default.
Code indicating whether multiple input elements were found
for the leading directional segment of the standardized
address:
Blank
Only one value was found.
M
Multiple values were found.
Code indicating the type of alternate address scheme to use
to obtain a match:
Blank
No alternate address scheme used.
D
Delivery point alternate logic used.
S
Small town default logic used.
U
Unique ZIP Code logic used.
Code indicating whether or not multiple leading directional
matches were found:
Blank
Only one leading directional was found.
M
Multiple leading directionals were found.
Code indicating whether or not multiple street name matches
were found:
Blank
Only one street name was found.
M
Multiple street names were found.
Code indicating whether or not multiple suffix matches were
found:
Blank
Only one suffix was found.
M
Multiple suffixes were found.
Code indicating whether or not multiple trailing directional
matches were found:
Blank
Only one leading directional was found.
M
Multiple trailing directionals were found.
173
2
Interactive Screen Reference
Function Keys
The following table describes the action taken by each function key on the Multiple
Elements screen.
Table 14: Function Keys on the Multiple Elements Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Exit from the Interactive CODE-1 Plus System.
F4
MS
Go to the Match Settings screen.
F5
RE
Refresh (erase) all of the input and output data
from the screen.
F6
GEO
Go to the Geographic Coding Interface (you must
have purchased and installed Geographic Coding
Plus separately).
F7
UP
Return to the previous match results screen.
F8
DOWN
Go to the next match results screen.
F9
INQ
Go to the database inquiry function.
F10
FLIP
Go to the database inquiry function and expand it to
fill the entire physical screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER.)
Parsed Elements Screen
The Parsed Elements screen shows you the individual elements that make up the
standardized address. If no address match was found, the fields on this screen are
blank. This screen is accessed by entering the PE command, or by pressing F8 from
the Delivery Sequence Footnotes screen or F7 from the Multiple Elements screen.
174
Software Release 4.0.0/March 2015
2
Screens that Support Address Matching
The following sample of the Parsed Elements screen.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name: LOCUS INC
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr: 2560 HUNTington ave #302
Correct ZIP: Y
City, ST: alexandria va
Output Case: U
ZIP Code: 22303
Urb Name:
Mult Secondary: Y
USPS County: Fairfax
Override City: Z
Matched Addr: 2560 Huntington Ave Ste 302
CRRT: C009
City,State ZIP: Alexandria VA 22303-1493
DPBC: 149360 7
------------------------------------------------------------------------------Command:
Nav Off
3 of 6
PE - Parsed Elements
House: 2560
Street: Huntington
Lead Dir:
Suffix: Ave
RR/HC #:
PO Box:
Short City: Alexandria
ZIP Code: 22303 1493
1=Help
Trail Dir:
RR/HC Box:
Apt Info: Ste 302
Private Mail Box:
3=Quit
4=MS
5=RE
6=Geo
7=Up
8=Down
9=Inq
10=Flip
Fields
The following table presents a description of, and acceptable values for, each field on
the Parsed Elements screen.
Table 15: Fields on the Parsed Elements Screen (Part 1 of 2)
Field Name
Description
Lead Dir
The returned leading directional
House
The returned house number
Street
The returned street name
Suffix
The returned suffix
Trail Dir
The returned trailing directional
RR/HC #
The returned rural route or highway contract route number
RR/HC Box
The returned rural route or highway contract box number
PO Box
The returned post office box number
Apt. Information
The returned apartment designator (i.e., STE, APT) and
number
Short City
The returned short city name
Working With CODE-1 Plus
175
2
Interactive Screen Reference
Table 15: Fields on the Parsed Elements Screen (Part 2 of 2)
Field Name
Description
ZIP Code
The returned 9-digit ZIP Code.
Private Mail Box
The returned Private Mailbox information.
Function Keys
The following table describes the action taken by each function key on the Parsed
Elements screen.
Table 16: Function Keys on the Parsed Elements Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Exit from the Interactive CODE-1 Plus System.
F4
MS
Go to the Match Settings screen.
F5
RE
Refresh (erase) all of the input and output data from the
screen.
F6
GEO
Go to the Geographic Coding Interface (you must have
purchased and installed Geographic Coding Plus
separately).
F7
UP
Return to the previous match results screen.
F8
DOWN
Go to the next match results screen.
F9
INQ
Go to the database inquiry function.
F10
FLIP
Go to the database inquiry function and expand it to fill
the entire physical screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER.)
176
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Return Codes Screen
The Return Codes screen shows you the return codes that correspond to your match
attempt. This screen is accessed by entering the RC command in the Command field,
or pressing the F7 function key from the Delivery Sequence Footnotes screen. The
following is a sample of the Return Codes screen.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm name:
Firm: M D/Suf: M
Secondary Addr:
St: M
City: S
Primary Addr: 1401 Peartree Ln
Correct ZIP: Y
City, ST:
Output Case: U
ZIP Code: 20721
Urb Name:
Mult Secondary: Y
USPS County: PRINCE GEORGES
Override City: C
Matched Addr: 1401 PEARTREE LN
CRRT: R002
City,State ZIP: BOWIE MD 20721-3004
DPBC: 300401 0
------------------------------------------------------------------------------Command: ________________________________________
Nav DPV
1 of 6
RC - Return Codes
General RC:
City RC: B
Firm RC:
Address Prob: 0
Overall Prob: 0
USPS Rec. Type: S
City Type:
Dir. RC:
Suffix RC:
Unit RC:
Firm Score:
Street Score: 0
Source of Addr: P
Alias RC:
ZIP Status: C
Source of ZIP: Z
POB ZIP Code: N
'best fit' ZIPs: 1
PBSA Ind:
Alt Addr Scheme:
Alias Type:
Line of Travel RC: 9
DPV Flag: Y
NoStat: N
Vacant: N CMRA: N
RDI Flag:
First four additional ZIPs:
Drop Info Type:
Data:
1=Help
3=Quit
4=MS
5=RE
6=Geo
8=Down
9=Inq
10=Flip
NOTE: If you hit a “seed record” during DPV processing, a note similar to the
following will appear on the bottom of this screen:
DPV KEY IS: S06430475462316207
In order for you to continue DPV processing, you will have to return to the Pitney
Bowes website and provide the code to get a new permanent key. See Chapter 6
for more information on DPV processing, “seed records,” and license keys. You will
also be required to extract and build a DPV Seed file and supply it on the Pitney
Bowes website in order to get a new permanent key.
Working With CODE-1 Plus
177
2
Interactive Screen Reference
Fields
The following table presents a description of, and acceptable values for, each field on
the Return Codes screen.
Table 17: Fields on Return Codes Screen (Part 1 of 6)
Field Name
General RC
Description
A 1-character return code indicating the success or reason
for failure of the match attempt:
• Blank — The address match attempt was successful.
• A — Unit number missing or not found on database.
• B — Insufficient (or blank) address in formation for a
match.
• E — External match—auxiliary file processing.
• H — House/box number not found on street.
• M — Multiple matches were found.
• S — Street name not found in ZIP Code.
• X — The CODE-1 Plus Master File has expired.
• Z — ZIP Code not found on database.
City RC
A 1-character return code indicating the success or reason
for failure of the city match attempt:
• Blank — No address match was found, or the input city was
correct.
• B — No input city and state were found.
• C — Mismatched city for valid input state/ZIP.
• I — The input city was used; no cities available for the ZIP
Code.
• N — The input city name was not used.
• S — Spelling errors in the input were corrected.
Firm RC
A 1-character return code indicating the success or reason
for failure of the firm name match attempt:
• Blank — The firm name match was successful, or no firm
name was indicated in the input record.
• F — The input firm name does not match the firm name on
the database.
• M — A firm name was in the input, but there were no firm
names on the database for the matched address.
Address Prob
A single digit that indicates the probable correctness of the
address match:
• Blank — No address match was found.
• 0 — The address match is most likely to be correct.
• 1-8 — These values represent intermediate values on a
sliding scale.
• 9 — The address match is least likely to be correct.
178
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Table 17: Fields on Return Codes Screen (Part 2 of 6)
Field Name
Overall Prob
Description
A single digit that indicates the probable correctness of the
address and firm name match:
• Blank — No match was found.
• 0 — The match is most likely to be correct.
• 1-8 — These values represent intermediate values on a
sliding scale.
• 9 — The match is least likely to be correct.
USPS Rec. Type
The USPS-defined type code of the ZIP+4 record used for
matching:
• Blank — No match was obtained.
• F — Firm record
• G — General delivery record
• H — High rise (apartment complex) record
• P — PO Box record
• R — Rural route or highway contract record
• S — Normal street address record.
City Type
This is a 1-character code describing the input city type:
• P — Primary city
• S — Secondary city
• V — Vanity city.
Dir. RC
A 1-character return code indicating the success or reason
for failure of the directional match attempt:
• Blank — No address match was found, or the directional
was correct.
• D — The directional does not match the database.
• F — The directional was correct, but was in the wrong
location (i.e., trailing directional should have been a
leading directional).
• N — No directional was found on the input address, but a
directional was present on the database.
Suffix RC
A 1-character return code indicating the success or reason
for failure of the suffix match attempt:
• Blank — No address match was found, or the suffix was
correct.
• S — The suffix does not match the database.
• N — No suffix was found on the input address, but a suffix
was present on the database.
Working With CODE-1 Plus
179
2
Interactive Screen Reference
Table 17: Fields on Return Codes Screen (Part 3 of 6)
Field Name
Unit RC
Description
A 1-character return code indicating the success or reason
for failure of the unit (or apartment) match attempt:
• Blank — No address match was found, or the input unit
was correct.
• A — The unit does not match the database.
• N — No unit was found on the input address, but a unit was
present on the database.
• F — Suite number appended due to a firm name match.
Firm Score
A single digit that indicates the probable correctness of the
firm name match:
• Blank — No match was obtained.
• 0 — The input firm name matched the output firm name
exactly.
• 1-9 — These represent intermediate values on a sliding
scale.
Street Score
A single digit that indicates the probable correctness of the
street name match:
• Blank — No match was obtained.
• 0 — The input street name matched the output street name
exactly.
• 1-9 — These represent intermediate values on a sliding
scale.
Source of Addr.
A 1-character code indicating whether the output street
address was matched from the primary address line or the
secondary address line:
• M — A combination of information from the two lines.
• P — Primary line
• S — Secondary line
Alias RC
A 1-character return code indicating whether or not the input
address matched an alias street name, as follows:
• Blank — The address matched a base street, or no match
was found.
• A — The address matched an alias street.
180
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Table 17: Fields on Return Codes Screen (Part 4 of 6)
Field Name
ZIP Status
Description
A 1-character code specifying the status of the output ZIP
Code:
• A — The output ZIP Code is different from the original ZIP
Code.
• B — The output ZIP Code is blank.
• C — The original ZIP Code is the output ZIP Code.
• I — Invalid -- No match could be obtained; the output ZIP
code contains blanks because the input ZIP code was
invalid.
• O — The original ZIP Code is in the output location because
no match was obtained.
• U — Blank—A unique address match could not be obtained
and there was no correlation between the input unique ZIP
Code and the city/state. The original ZIP Code was blanked.
Source of ZIP
A 1-character code indicating the source of the final ZIP Code:
• B — No ZIP Code was determined.
• C — The final ZIP Code was determined from the city-based
locality.
• F — The final ZIP Code was determined from the ZIP-based
locality.
• M — The final ZIP Code was determined from the ZIPMOVE
file.
• Z — The original ZIP Code was retained.
POB ZIP Code
A 1-character code indicating whether the address is located
in a P. O. Box-only delivery zone. P. O. Box-only delivery zone
addresses can only receive postal delivery through the use of
a P. O. Box. No other postal delivery method is available for
these addresses.
• Y — P. O. Box-only ZIP Code.
• N — Not a P. O. Box-only ZIP Code.
“best fit” ZIPs
The number of “best fit” ZIP Codes that were found during the
match attempt.
PBSA Ind
A 1-character code indicating whether this address was found
in the PBSA table. DPV processing uses the PBSA Table to
identify P. O. Box™ Street Addresses (PBSA). PBSA addresses
are street addresses that really represent a USPS P. O. Box.
• Blank — Not presented
• Y — Found in the DPV PBSA Table.
• N — Not found in the DPV PBSA Table.
Working With CODE-1 Plus
181
2
Interactive Screen Reference
Table 17: Fields on Return Codes Screen (Part 5 of 6)
Field Name
Alt. Adr. Scheme
Description
A 1-character code indicating the type of alternate address
scheme that was used to obtain a match:
• Blank — No alternate address scheme used.
• D — Delivery point alternate logic used.
• E — Enhanced high rise alternate match logic
used.
• S — Small town default logic used.
• U — Unique ZIP Code logic used.
Alias Type
A 1-character code indicating the alias type:
• Blank — Street record matched was not an alias street.
• A — Abbreviation street name. This USPS abbreviation is
for streets that are over 30 characters long.
• C — Official street name change (Chamber of Commerce
action.
• O — Street record matched was a USPS “other” alias.
• P — Street record matched was a USPS “preferred” alias.
Line of Travel RC
A 1-character code describing the Line of Travel match
obtained:
• Blank — Invalid data passed to matcher
• 9 — 9-digit ZIP+4 match was successful
• C — Call to LOT matcher failed.
• F — Master file access failure.
• V — Incompatible Master file.
• D — 9-digit ZIP+4 match was unsuccessful (default coded).
DPV Flag
A 1-character return code indicating the result of your DPV
processing:
• D — Valid primary number; input missing secondary
number (primary RR).
• M — Unable to resolve the Multiple Condition.
• N — No Delivery Point Validation.
• S — Valid primary number; but secondary number (primary
for RR) present and is not confirmed.
• Y — Delivery Point validated. Primary number valid and
second number (when present) valid.
• Blank — Address not presented to DPV table.
NoStat Flag
A 1-character code indicating the presence of statistics for
this address. A “Y” indicates that the address is not a valid
delivery address even though it has been validated by DPV.
• Blank — Not presented
• Y — Found match to ‘No Stat’ DPV hash table
• N — No match found to “No stat” DPV hash table.
182
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Table 17: Fields on Return Codes Screen (Part 6 of 6)
Field Name
Vacant Table Flag
Description
A 1-character code indicating that this address was found in
the Vacant table.
• Blank — Not presented
• Y — Indicates that the address has been vacant for at least
last 90 days.
• N — Indicates that the address is not vacant.
CMRA Flag
This is a 1-character code indicating whether a CMRA look-up
has occurred:
• Y — Yes, this is a CMRA.
• N — No, this is not a CMRA.
• Blank — Not presented.
NOTE: This code will only be presented if the DPV flag is Y, S,
or D.
RDI Flag
This is a 1-character code describing the Residential Delivery
File (RDI) match obtained:
Blank — RDI match not attempted or not found.
B — Business confirmed.
M — Address is mixed business and residential.
R — Residence confirmed.
First Four Additional ZIPs
The first four additional ZIP Codes that matched the input
record but were not used as the output ZIP Code.
Dropped information type
A 1-character code indicating the type of information, if any,
that was dropped by the matcher during the match attempt:
• Blank — Either no match was obtained, or no information
was dropped.
• A — A street address was dropped in order to obtain an RR/
HC or PO Box match.
• R — An RR/HC or PO Box address was dropped in order to
obtain a street address match.
• W — One or more characters were dropped during the
address parsing process.
Data
Any miscellaneous characters that were dropped during the
address matching process.
NOTE: The Dropped Info. Type code refers to the type of information that was
dropped by the matcher during the match attempt. The Data field contains
characters dropped during the address analysis process, before the matcher even
attempts a match. Therefore, it is possible to have a Dropped Info. Type that is
not blank, but a blank Data field.
Working With CODE-1 Plus
183
2
Interactive Screen Reference
Function Keys
The following table describes the action taken by each function key on the Return
Codes screen.
Table 18: Fields on the Return Codes Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Return to the Main Menu.
F4
MS
Go to the Match Settings screen.
F5
RE
Refresh (erase) all of the input and output data
from the screen.
F6
GEO
Go to the Geographic Coding Interface (you must
have purchased and installed Geographic Coding
Plus separately).
F8
DOWN
Go to the next match results screen.
F9
INQ
Go to the database inquiry function.
F10
FLIP
Go to the database inquiry function and expand it to
fill the entire physical screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER.)
Statistics Screen
The Statistics screen shows execution statistics about the number of calls that were
made to the matcher while this address was being processed. This screen is
particularly useful if you are encountering some kind of problem with Interactive
CODE-1 Plus. If that is the case, these statistics can aid the Pitney Bowes Customer
Support Representatives in solving your problem.
184
Software Release 4.0.0/March 2015
2
Screens that Support Address Matching
This screen is accessed by entering the ST command, or by pressing F8 from the
Multiple Elements screen or F7 from the Dropped Information/Base Address screen. On
the following page is a sample of the Statistics screen.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name: LOCUS INC
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr: 2560 HUNTington ave #302
Correct ZIP: Y
City, ST: alexandria va
Output Case: U
ZIP Code: 22303
Urb Name:
Mult Secondary: Y
USPS County: Fairfax
Override City: Z
Matched Addr: 2560 Huntington Ave Ste 302
CRRT: C009
City,State ZIP: Alexandria VA 22303-1493
DPBC: 149360 7
------------------------------------------------------------------------------Command:
Nav Off
5 of 6
ST - Statistics
City-based locality match results:
Finance number-based locality match results:
Original ZIP-Based match results:
Number of match attempts:
Master File Reads
ZIP Index
City Details
2
3
1=Help
3=Quit
4=MS
1
Locality
2
5=RE
6=Geo
Std.Address
ZIP
ZIP+4
CR-RT
RC:
RC:
RC:
RC:
Street Details
1
7=Up
8=Down
9=Inq
County
1
10=Flip
Fields
The following table presents a description of, and acceptable values for, each field on
the Statistics screen.
Table 19: Fields on the Statistics Screen (Part 1 of 3)
Field Name
City-based locality match
results
Finance number-based
locality match results
Working With CODE-1 Plus
Description
A 1-character code indicating the results of the match
attempt in the city-based locality:
Blank
Not attempted
I
Attempted, improved (a match was found).
N
Attempted, no match found
A 1-character code indicating the results of the match
attempt in the finance number-based locality:
Blank
Not attempted
I
Attempted, improved (a match was found).
N
Attempted, no match found
185
2
Interactive Screen Reference
Table 19: Fields on the Statistics Screen (Part 2 of 3)
Field Name
Original ZIP-based match
results
A 1-character code indicating the results of the match
attempt in the original ZIP Code-based locality:
Blank
Not attempted
I
Attempted, improved (a match was found).
N
Attempted, no match found
Number of match
attempts
The number of attempts that were made to obtain the match
results.
Std. Address RC
A 1-character return code indicating the success or reason
for failure of the standardized address match attempt:
ZIP RC
186
Description
Blank
The address match attempt was successful.
A
Unit number missing or not found on database.
B
Insufficient (or blank) address information for a
match.
H
House/Box number not found on street.
M
Multiple matches were found.
S
Street name not found in ZIP Code.
Z
ZIP Code not found on database.
A 1-character return code indicating the success or reason
for failure of the 14-digit ZIP Coding attempt (i.e., was an
output ZIP Code returned? If not, why not):
Blank
The match attempt was successful.
A
Unit number missing or not found on database.
B
Insufficient (or blank) address information for a
match.
H
House/Box number not found on street.
M
Multiple matches were found.
S
Street name not found in ZIP Code.
Z
ZIP Code not found on database.
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Table 19: Fields on the Statistics Screen (Part 3 of 3)
Field Name
ZIP+4 RC
Description
A 1-character return code indicating the success or reason
for failure of the ZIP+4 Coding attempt (i.e., was an output
ZIP+4 Code returned? If not, why not):
Blank
The match attempt was successful.
A
Unit number missing or not found on database.
B
Insufficient (or blank) address information for a
match.
H
House/Box number not found on street.
M
Multiple matches were found.
S
Street name not found in ZIP Code.
V
The input matched a non-deliverable street address.
NOTE: A non-deliverable ZIP+4 Range is typically a
new ZIP range where the USPS has not finalized
assignments of ZIP+4 codes, thus not permitting
assignment of postal code information at this time.
Z
CR-RT RC
ZIP Code not found on database.
A 1-character return code indicating the success or reason
for failure of the Carrier Route coding attempt (i.e., was an
output carrier route code returned? If not, why not):
Blank
The match attempt was successful.
A
Unit number missing or not found on database.
B
Insufficient (or blank) address information for a
match.
H
House/Box number not found on street.
M
Multiple matches were found.
S
Street name not found in ZIP Code.
Z
ZIP Code not found on database.
ZIP Index
The number of database reads done on the ZIP Index file in
order to obtain the match.
City Details
The number of database reads performed on the City Details
file in order to obtain the match.
Locality
The number of database reads performed on the Locality file
in order to obtain the match.
Street Details
The number of database reads performed on the Street
Details file in order to obtain the match.
County
The number of database reads performed on the County file
in order to obtain the match.
Working With CODE-1 Plus
187
2
Interactive Screen Reference
Function Keys
The following table describes the action taken by each function key on the Statistics
screen.
Table 20: Function Keys on the Statistics Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Exit from the Interactive CODE-1 Plus System.
F4
MS
Go to the Match Settings screen.
F5
RE
Refresh (erase) all of the input and output data
from the screen.
F6
GEO
Go to the Geographic Coding Interface (you must
have purchased and installed Geographic Coding
Plus separately).
F7
UP
Return to the previous match results screen.
F8
DOWN
Go to the next match results screen.
F9
INQ
Go to the database inquiry function.
F10
FLIP
Go to the database inquiry function and expand it to
fill the entire physical screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER.)
Address Stack Screen
The Address Stack screen shows information related to as many as 10 addresses that
have been identified by the matcher as multiples for the address entered on the
match portion of the screen. The displayed data and headers are variable in length.
Up to three screens of information can be accessed by the Left and Right commands
(showing additional information) and up to two screens with the Up and Down
commands (showing additional addresses).
188
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
The following is a sample of the information available on the Address Stack screens.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name: Pitney Bowes Business Insight
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr: calle 1 a-15
Correct ZIP: Y
City, ST: bayamon pr
Output Case: U
ZIP Code:
Urb Name:
Mult Secondary: Y
Override City: Z
Matched Addr:
CRRT:
City,State ZIP:
DPBC:
------------------------------------------------------------------------------Command:
Nav On
1 of 2
AS - Address Stack
Address---- City---- St ZIP---ZIP4 DPC C-Rt RTP Cnty/CD Primary---- LL#--A15 CALLE 1 SAN JUAN PR 00921-4848 158 C043 S 1 127
A10 - A24 B V18250
A15 CALLE 1 SAN JUAN PR 00921-4504 159 C043 S 1 127
A12 - A22 B V19361
A15 CALLE 1 SAN JUAN PR 00924-5306 155 C058 S 1 127
A1 - A43 B V18276
A15 CALLE 1 SAN JUAN PR 00924-5314 156 C058 S 1 127
A1 - A15 B V18278
A15 CALLE 1 SAN JUAN PR 00926-5239 158 C084 S 1 127
A3 - A24 B V18355
A15 CALLE 1 SAN JUAN PR 00926-5950 158 C085 S 1 127
A1 - A24 B V18384
A15 CALLE 1 SAN JUAN PR 00956-2323 154 C014 S 1 021
A1 - A16 B V18476
A15 CALLE 1 SAN JUAN PR 00956-4416 159 C009 S 1 021
A15 - A19 B V19089
1=Help
3=Quit
4=MS
5=RE
6=Geo
8=Down
9=Inq
10=Flip
The picture below shows additional Address Stack screen information.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name: Pitney Bowes Business Insight
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr: calle 1 a-15
Correct ZIP: Y
City, ST: bayamon pr
Output Case: U
ZIP Code:
Urb Name:
Mult Secondary: Y
Override City: Z
Matched Addr:
CRRT:
City,State ZIP:
DPBC:
------------------------------------------------------------------------------Command:
Nav On
1 of 2
AS - Address Stack
Fin-Nr Urbanization------- Firm-----------428460 PARQ DE SAN IGNACIO PITNEY BOWES BUSINESS INSIGHT
428460 PARQ DE SAN IGNACIO PITNEY BOWES BUSINESS INSIGHT
428460 PARQ DE SAN IGNACIO PITNEY BOWES BUSINESS INSIGHT
428460 PARQ DE SAN IGNACIO PITNEY BOWES BUSINESS INSIGHT
428460 PARQ DE SAN IGNACIO PITNEY BOWES BUSINESS INSIGHT
428460 PARQ DE SAN IGNACIO PITNEY BOWES BUSINESS INSIGHT
428460 PARQ DE SAN IGNACIO PITNEY BOWES BUSINESS INSIGHT
428460 PARQ DE SAN IGNACIO PITNEY BOWES BUSINESS INSIGHT
1=Help
Working With CODE-1 Plus
3=Quit
4=MS
5=RE
6=Geo
8=Down
9=Inq
10=Flip
189
2
Interactive Screen Reference
Fields
The following table presents a description of, and acceptable values for, each field on
the Address Stack screens.
Table 21: Fields on the Address Stack Screen
Field Name
Description
Address
Street name along with directorionals, prefix/suffix, and house
number
City
City name
St
State name
ZIP
ZIP Code and ZIP+4
DPC
Delivery point code and check digit
C-Rt
Carrier Route Code (Cnnn, blank if none)
RTP
A three-digit combination of codes:
USPS record type of record matched:
F
Firm
G
General delivery
H
High rise (apartment complex)
P
PO Box
R
Rural route/Highway contract
S
Normal Street Address
“Default” match:
H
High Rise Default
R
Rural Route Default
M
Military Default
blank
Not a default record.
Overall probability of match correctness:
0-9
190
0 is most probably correct
Cnty/CD
County number
Primary
Primary range information (and parity)
Secondary
Secondary range information (and parity)
LL#
Last line number
Fin-Nr
Finance number
Urbanization
Puerto Rican urbanization
Firm
Firm name
Software Release 4.0.0/March 2015
Screens that Support Address Matching
2
Function Keys
The following table describes the action taken by each function key on the Address
Stack screen
Table 22: Function Keys on the Address Stack Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Exit from the Interactive CODE-1 Plus System.
F4
MS
Go to the Match Settings screen.
F5
RE
Refresh (erase) all of the input and output data from the
screen.
F6
GEO
Go to the Geographic Coding Interface (you must have
purchased and installed Geographic Coding Plus
separately).
F7
UP
If the second of the Address Stack screens is displayed,
return to the previous screen. If the first of the Address
Stack screens is currently displayed, this area will be
blank.
F8
DOWN
If the first of the Address Stack screens is displayed, go
to the next screen. If the second of the Address Stack
screens is currently displayed, this area will be blank.
F9
INQ
Go to the database inquiry function.
F10
FLIP
Go to the database inquiry function and expand it to fill
the entire physical screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or
in the Command field, type HELP and press ENTER).
NOTE: By typing SELECT and the appropriate line number in the Command
field, you can choose which record of the displayed multiple addresses you would
like in the input address field.
Working With CODE-1 Plus
191
2
Interactive Screen Reference
Screens that Support Database Inquiry
The screens shown in this section all support the database inquiry function. They are
listed in alphabetical order.
Apartments at a House Range
The Apartments at a House Range screen shows you all of the apartments at a particular
house number. For each number (house), CODE-1 Plus displays the address, ZIP
Code range, apartment number ranges, ZIP Codes, ZIP+4 Code ranges, carrier route
codes, USPS record types (indicating the type of apartment), and number of firms.
This screen is accessed by entering the AH <line number> command (or pressing F4)
from the Houses on a Street screen. The following is a sample of the Apartments at a
House Range screen.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name:
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr:
Correct ZIP: Y
City, ST:
Output Case: U
ZIP Code:
Urb Name:
Mult Secondary: Y
Override City: Z
Matched Addr:
CRRT:
City,State ZIP:
DPBC:
------------------------------------------------------------------------------Command:
Nav Off
__ of __
Apts in 350 5TH AVE, ZIP Code 10118
LN
Apt Range
ZIP
Z+4 Range Rte
Record Type
Apt Type Firms
1
Default
10118 0110
C020 H Highrise
2
10118 0199
C020 H Highrise
LOWR
3
1
10118 0199
C020 H Highrise
FRNT
4
1
10118 0199
C020 H Highrise
LBBY
5
1
10118 0109
C020 H Highrise
LOWR
2
6
2-14
10118 0199
C020 H Highrise
LBBY
7
3
10118 0167
C020 F Firm
LBBY
1
8
4
10118 0111
C020 F Firm
LBBY
1
1=Help
2=Alias
3=Quit
5=FM
6=Back
8=Down
9=Mat
10=Flip
NOTE: To view more lines of data at once, enter the FLIP command in the
Command field, or press F10.
192
Software Release 4.0.0/March 2015
Screens that Support Database Inquiry
2
Fields
The following table presents a description of, and acceptable values for, each field on
the Apartments at a House Range screen.
Table 23: Fields on the Apartments at a House Range Screen
Field Name
Description
LN
The line number assigned to this apartment range.
Apt Range
The apartment number range.
ZIP
The ZIP Code for the apartments in this range.
Z+4 Range
The range of ZIP+4 Codes that are valid for this apartment
range.
Rte
The carrier or rural route number for the apartments in this
range.
Record Type
The USPS record type for the ZIP+4 records in this apartment
range.
Apt Type
The unit designator for the apartments in this range (i.e., APT,
STE).
Firms
The number of firms in this apartment range.
Function Keys
The following table describes the action taken by each function key on the
Apartments at a House Range screen.
Table 24: Function Keys on the Apartments at a House Range Screen (Part 1 of 2)
Function Key
Name
Description
F1
HELP
Obtain online help.
F2
ALIAS
Show the base street name for the house range shown.
F3
QUIT
Return to the Main Menu.
F5
FM
Go to the Firms on a Street screen.
F6
BACK
Return to the previous screen.
F7
UP
Scroll the list so that the previous 8 house ranges are
displayed.
F8
DOWN
Scroll the list so that the next 8 house ranges are
displayed.
Working With CODE-1 Plus
193
2
Interactive Screen Reference
Table 24: Function Keys on the Apartments at a House Range Screen (Part 2 of 2)
Function Key
Name
Description
F9
MAT
Go to the address matching function.
F10
FLIP
Change the screen so that the data fills the entire physical
screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER.)
Cities in a State Screen
The City Information screen shows you an alphabetical listing of all of the city names
in a particular state. For each city, this screen also displays the state abbreviation and
the ZIP Code (or range of ZIP Codes) that is valid for the city.
This screen is displayed when you enter the CS <state abbr.> command. You can enter
this command from any screen in the system. The following is a sample of the Cities in
a State screen.
NOTE: As a short cut to entering a Locate command after the CS command, you
can enter CS <state abbr.> <location string> as a single command.
194
Software Release 4.0.0/March 2015
2
Screens that Support Database Inquiry
CODE-1 Plus Coding System
-------------------------------------------------------------------------Firm Name:
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr: 4200 PARLIAMENT ST
Correct ZIP: Y
City, ST: LANHAM MD
Output Case: U
ZIP Code: 20706
Mult Secondary: Y
USPS County: PRINCE GEORGES
Override City: Z
Matched Addr: 4200 PARLIAMENT PL
CRRT: C005
City,State ZIP: LANHAM MD 20706-1852
DPBC: 185200 9
-------------------------------------------------------------------------Command:
__ of __
Cities in Maryland
LN City
State
ZIP Range
Type Urb Unique-ZIP
1 ABELL
MD
20606
P
2 ABER PROV GRD
MD
21005-21010
p
3 ABERDEEN
MD
21001
P
4 ABERDEEN PROVING GROUND
MD
210014-21010
P
5 ABINGDON
MD
21009
P
6 ACCIDENT
MD
21520
P
7 ACCOKEEK
MD
20607
P
8 ADAMSTOWN
MD
21710
P
1=Help
2=ZC
3=Quit
4=SC
5=CZ
6=Back
8=Down
9=Mat
10=Flip
NOTE: To view more lines of data at once, enter the FLIP command in the
Command field, or press F10.
Fields
The following table presents a description of, and acceptable values for, each field on
the Cities in a State screen.
Table 25: Fields on the Cities in a State Screen
Field Name
Description
LN
The line number of the city.
City
The city name.
State
The abbreviations for the state in which the city is located.
ZIP Range
The range of ZIP Codes that are valid for the city.
Type
Code indicating the type of city. One of the following codes
appear:
Working With CODE-1 Plus
P
Primary city
S
Secondary city
V
Vanity city.
195
2
Interactive Screen Reference
Table 25: Fields on the Cities in a State Screen
Field Name
Description
Urb
Code indicating whether the city is a Puerto Rican
urbanization area. One of the following codes appear:
Unique ZIP
Blank
The city is not a Puerto Rican urbanization area.
Y
The city is a Puerto Rican urbanization area.
A code indicating whether the ZIP Code for the city is unique
to that city or resides in multiple cities. One of the following
codes appear:
Blank
The ZIP Code is not unique to the city.
Y
The ZIP Code is unique to the city.
Function Keys
The following table describes the action taken by each function key on the Cities in a
State screen.
Table 26: Function Keys on the Cities in a State Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F2
ZC
Go to the ZIP Codes in a City screen.
F3
QUIT
Return to the Main Menu.
F4
SC
Go to the Streets in a City screen.
F5
CZ
Go to the other Cities in a ZIP Code screen.
F6
BACK
Return to the previous screen.
F7
UP
Scroll the list so that the previous 8 cities are
displayed.
F8
DOWN
Scroll the list so that the next 8 cities are
displayed.
F9
MAT
Go to the address matching function.
F10
FLIP
Change the screen so that the data fills the entire
physical screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER.)
196
Software Release 4.0.0/March 2015
2
Screens that Support Database Inquiry
Cities in a ZIP Code Screen
The Cities in a ZIP Code screen shows you all of the cities in a given ZIP Code. For each
city, CODE-1 Plus displays the long city names, short city names, and city type.
This screen is accessed by entering the CZ <line number> or the CZ <ZIP Code>
command, or by pressing F5 from the Cities in the Database screen or Cities in a State
screen. The following is a sample of the Cities in a ZIP Code screen.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name:
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr:
Correct ZIP: Y
City, ST:
Output Case: U
ZIP Code:
Urb Name:
Mult Secondary: Y
Override City: Z
Matched Addr:
CRRT:
City,State ZIP:
DPBC:
------------------------------------------------------------------------------Command:
Nav Off
__ of __
Cities in ZIP Code 00730
LN
Long City Name
State
Short City Name
City Type
1
ALT DEL MADRIGAL
PR
Vanity
2
ALTS DE JACARANDA
PR
Vanity
3
BDA BORINQUEN
PR
Vanity
4
BDA CLAUSELLS
PR
Vanity
5
BDA FERRAN
PR
Vanity
6
BDA TAMARINDO
PR
Vanity
7
BO LA PONDEROSA
PR
Vanity
8
BO MAGUEYES
PR
Vanity
1=Help
3=Quit
4=SZ
6=Back
8=Down
9=Mat
10=Flip
NOTE: To view more lines of data at once, enter the FLIP command in the
Command field, or press F10.
The USPS enables city names to be up to 28 characters long. However, if a city name
is longer than 13 characters, a USPS short city name is provided. Typically, long city
names are shortened by removing vowels.
In cases where a ZIP Code has more than one city name, the screen shows these city
names, and their accompanying city type. These city types indicate the USPS-preferred
city name, and any alternate city names associated with the same ZIP Code. Preferred
city names have a city type of “primary;” alternate city names have city types of
“secondary” or “vanity.”
For example, ZIP Code 70510 has three city names associated with it: Abbeville, Cow
Island, and Meaux. Since Abbeville is preferred, it has a city type of primary; all other
city names have a city type of secondary.
Working With CODE-1 Plus
197
2
Interactive Screen Reference
Fields
The following table presents a description of, and acceptable values for, each field on
the Cities in a ZIP Code screen.
Table 27: Fields on the Cities in a ZIP Code Screen
Field Name
Description
LN
The line number for this city name.
Long City Name
The full name for the city.
State
The 2-character state abbreviation for the city.
Short City Name
The USPS shortened city name.
City Type
The USPS designated city type. One of the following city types
appears: Primary, Secondary, Vanity.
Function Keys
The following table describes the action taken by each function key on the Cities in a
ZIP Code screen.
Table 28: Fields on the Cities in a ZIP Code Screen
Function Key
198
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Return to the Main Menu.
F4
SZ
Go to the Streets in a ZIP Code screen.
F6
BACK
Return to the previous screen.
F7
UP
Scroll the list so that the previous 8 cities are
displayed.
F8
DOWN
Scroll the list so that the next 8 cities are
displayed.
F9
MAT
Go to the address matching function.
F10
FLIP
Change the screen so that the data fills the entire
physical screen.
Software Release 4.0.0/March 2015
Screens that Support Database Inquiry
2
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER.)
City Information Screen
The City Information screen shows you an alphabetical listing of all of the city names
in the CODE-1 Plus database. For each city, this screen also displays the state
abbreviation and the ZIP Code (or range of ZIP Codes), the type urbanization name,
and the unique ZIP that applies to the city.
The screen on the following page is displayed when you first access the Interactive
CODE-1 Plus System. If you switch to any of the address match results screens, you
can return to this screen by typing CI in the Command field.
NOTE: As a short cut to entering a Locate command after the CI command, you
can enter CI <location string> as a single command. <location string> on this screen
may be either a city name or a city state combination.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name:
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr:
Correct ZIP Y
City, ST:
Output Case: U
ZIP Code:
Urb Name:
Mult Secondary: Y
Override City: Z
Matched Addr:
CRRT:
City,State ZIP:
DPBC:
------------------------------------------------------------------------------Command:
Nav DPV
__ of __
City Information
LN City
State
ZIP Range
Type
URB Unique-ZIP
1 A A R P
CA
90848
V
2 A A R P INS
PA
19187
V
Y
3 A A R P PHARMACY
CA
90848
V
Y
4 A A R P PHARMACY
CT
06167
V
Y
5 A C NIELSEN
TX
79966-79974
V
Y
6 A H MCCOY FEDERAL BLDG
MS
39269
V
7 A M F GREENSBORO
NC
27425
V
8 A M O R C
CA
95191
V
Y
The match settings have been changed.
1=Help
2=ZC
3=Quit
4=SC
5=CZ
8=Down
9=Mat
10=Flip
To view more lines of data, enter the FLIP command in the Command field, or press
F10.
Working With CODE-1 Plus
199
2
Interactive Screen Reference
Fields
The following table presents a description of, and acceptable values for, each field on
the City Information screen.
Table 29: Fields on the City Information Screen
Field Name
Description
LN
The line number of the city
City
The city name
State
The abbreviations for the state in which the city is located
ZIP Range
The range of ZIP Codes that are valid for the city
Type
Code indicating the type of city. One of the following codes
appear:
URB
P
Primary city
S
Secondary city
V
Vanity city.
Code indicating whether the city is a Puerto Rican
urbanization area. One of the following codes appear:
Unique ZIP
Blank
The city is not a Puerto Rican urbanization area.
Y
The city is a Puerto Rican urbanization area.
A code indicating whether the ZIP Code for the city is unique
to that city or resides in multiple cities. One of the following
codes appear:
Blank
The ZIP Code is not unique to the city.
Y
The ZIP Code is unique to the city.
Function Keys
The following table describes the action taken by each function key on the City
Information screen.
Table 30: Function Keys on the City Information Screen (Part 1 of 2)
Function Key
200
Name
Description
F1
HELP
Obtain online help.
F2
ZC
Go to the ZIP Codes in a City screen.
F3
QUIT
Return to the Main Menu.
F4
SC
Go to the Streets in a City screen.
F5
CZ
Go to the other Cities in a ZIP Code screen.
Software Release 4.0.0/March 2015
Screens that Support Database Inquiry
2
Table 30: Function Keys on the City Information Screen (Part 2 of 2)
Function Key
Name
Description
F8
DOWN
Scroll the list so that the next 8 cities are
displayed.
F9
MAT
Go to the address matching function.
F10
FLIP
Change the screen so that the data fills the entire
physical screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER.)
Firms in a House Range Screen
The Firms in a House Range screen shows you all of the firms located on a particular
house range on a street. The firm information includes the house number ranges,
apartment number ranges within a dwelling, the name of the firm located at each
apartment/suite, ZIP Codes, ZIP+4 Codes, and carrier route codes.
This screen is accessed by entering the command FM <line number> (or by pressing
F5) from the Streets in a City or Streets in a ZIP Code, Houses on a Street, or Apartments
at a House Range screens.
Working With CODE-1 Plus
201
2
Interactive Screen Reference
The following is a sample of the Firms in a House Range screen.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name:
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr:
Correct ZIP: Y
City, ST:
Output Case: U
ZIP Code:
Urb Name:
Mult Secondary: Y
Override City: Z
Matched Addr:
CRRT:
City,State ZIP:
DPBC:
------------------------------------------------------------------------------Command:
Nav Off
__ of __
Firms in 350 5TH AVE, NEW YORK, NY
LN
House Range
Apt Range
Firm Name
ZIP Code
C-Rt
1
350
1
NY COFFEE STATION
10118-0119 C020
2
350
1
SHOW BRAN PHOTO
10118-0145 C020
3
350
3
BIG APPLE RESTAURANT
10118-0167 C020
4
350
4
DAIKICHI SUSHI
10118-0111 C020
5
350
5
AU BON PAIN
10118-0112 C020
6
350
6
FINESSE CASSINI JEWLERY
10118-0149 C020
7
350
7
FEDERAL EXPRESS
10118-0129 C020
8
350
8
DUANE READE
10118-0138 C020
1=Help
2=Alias
3=Quit
6=Back
8=Down
9=Mat
10=Flip
NOTE: To view more lines of data at a time, in the Command field type FLIP
command and press ENTER, or press F10.
Fields
The following table presents a description of, and acceptable values for, each field on
the Firms on a House Range screen.
Table 31: Fields on a Firms on a House Range Screen
Field Name
202
Description
LN
The line number for this firm.
House Range
The house number ranges that are valid for this firm.
Apt Range
The apartment number ranges that are valid for this firm.
Firm Name
The firm name.
ZIP Code
The 9-digit ZIP Code assigned to this firm.
C-Rt
The carrier route number for this firm.
Software Release 4.0.0/March 2015
Screens that Support Database Inquiry
2
Function Keys
The following table describes the action taken by each function key on the Firms on a
House Range screen.
Table 32: Function Keys on the Firms on a House Range Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F2
ALIAS
Show the base street name for the line on which
the cursor is currently placed.
F3
QUIT
Return to the Main Menu.
F6
BACK
Return to the City Information screen.
F7
UP
Scroll the list so that the previous 8 firms are
displayed.
F8
DOWN
Scroll the list so that the next 8 firms are
displayed.
F9
MAT
Go to the address matching function.
F10
FLIP
Change the screen so that the data fills the entire
physical screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER.)
Houses on a Street Screen
The Houses on a Street screen shows you a listing of all of the house number ranges on
a particular street. In addition to even/odd house number ranges, CODE-1 Plus
shows you ZIP and ZIP+4 Code ranges, carrier routes, and firm/alias name.
This screen is accessed by entering the command HS <line number> (or pressing
F4) from the Streets in a City or Streets in a ZIP Code screens. The following is a sample
of the Houses on a Street screen.
Working With CODE-1 Plus
203
2
Interactive Screen Reference
NOTE: As a short cut to entering a Locate command after the HS command, you
can enter HS <line number> <location string> as a single command.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name:
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr: 163 conover rd
Correct ZIP: Y
City, ST: trenton nj
Output Case: U
ZIP Code: 08691
Urb Name:
Mult Secondary: Y
GEO County: MERCER
Override City: Z
Matched Addr: 163 CONOVER RD
CRRT: R003
City,State ZIP: PRINCETON JUNCTION NJ 08550-3233
DPBC: 323363 2
------------------------------------------------------------------------------Command:
Nav Off
__ of __
Houses on CONOVER RD, ZIP Code 08691
LN
House Range
E/O ZIP Z+4 Range Rte Typ
Firm/Alias Name
1 Z
1-99
O 08691 3228
R004 S
2 Z
2-98
E 08691 3229
R004 S
3 Z
100-120
E 08691 3230
R004 S
4 Z
101-161
O 08691 3231
R004 S
5 Z
122-170
E 08691 3232
R004 S
6 Z
163-199
O 08691 3233
R004 S
7 Z
172-198
E 08691 3234
R004 S
8 Z
200-298
E 08691 3235
R004 S
1=Help
3=Quit
4=AH
5=FM
6=Back
8=Down
9=Mat
10=Flip
NOTE: To view more lines of data, in the Command field, type FLIP and press
ENTER, or press F10.
NOTE: House ranges that are on an alias portion of the street appear with an “A”
in the left-most column next to the house range. To see the base name for the
house range, position your cursor on the alias house range and press F2, or enter
the ALIAS <line number> command. The base street name appears on the bottom
line of the screen.
The ZIPMove Record Indicator appears in the example above as a “Z” and uses the
same field location as the alias street range indicator. The ZIPMove Record
Indicator supersedes the alias indicator.
204
Software Release 4.0.0/March 2015
Screens that Support Database Inquiry
2
Fields
The following table presents a description of, and acceptable values for, each field on
the Houses on a Street screen.
Table 33: Fields on the Houses on a Street Screen
Field Name
Description
LN
The line number of the house range.
House Range
The house number range.
E/O
An E or an O indicating whether this is a range of only evennumbered or only odd-numbered houses.
ZIP
The ZIP Code for the houses in this range.
Z+4 Range
The range of ZIP+4 Codes that are valid for this house range.
Rte
The carrier or rural route number for the houses in this
range.
Typ
The USPS record type for the ZIP+4 records in this house
range.
Firm/Alias Name
Firm name or range street alias name.
Function Keys
The following table describes the action taken by each function key on the Houses on
a Street screen.
Table 34: Function Keys on the Houses on a Street Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Return to the Main Menu.
F4
AH
Go to the Apartments on a Street screen.
F5
FM
Go to the Firms on a Street screen.
F6
BACK
Return to the City Information screen.
F7
UP
Scroll the list so that the previous eight house
ranges are displayed.
F8
DOWN
Scroll the list so that the next eight house ranges
are displayed.
Working With CODE-1 Plus
205
2
Interactive Screen Reference
Table 34: Function Keys on the Houses on a Street Screen
Function Key
Name
Description
F9
MAT
Go to the address matching function.
F10
FLIP
Change the screen so that the data fills the entire
physical screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or,
in the Command field, type HELP and press ENTER.)
Streets in a City or Streets in a ZIP Code Screen
The Streets in a City or Streets in a ZIP Code screen shows an alphabetical listing of all
of the street names in a given city or ZIP Code. For each street listed, CODE-1 Plus
displays directionals, such as NE and SW, and suffixes, such as STand BLVD.
This screen is accessed by entering the SC or SL command (or pressing F4) from the
Cities in the Database screen, or Cities in a State screen, or pressing F4 from the Cities
in a ZIP Code screen. You can enter the SZ command from any database inquiry
screen. On the following page is a sample of the Streets in a City screen.
NOTE: As a short cut to entering a Locate command after the SC, SZ, or SL
command, you can enter SC <line number> <location string> as a single
command.
206
Software Release 4.0.0/March 2015
2
Screens that Support Database Inquiry
.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name:
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr:
Correct ZIP: Y
City, ST:
Output Case: U
ZIP Code:
Urb Name:
Mult Secondary: Y
Override City: Z
Matched Addr:
CRRT:
City,State ZIP:
DPBC:
------------------------------------------------------------------------------Command:
Nav Off
__ of __
Streets in NEW YORK, NY
LN
Dir StreetName
Sfx
Dir
ZIP Codes
1
ABINGDON
SQ
10014
2
ABP FULTON J SHEEN
PL
10017
3
ACADEMY
ST
10034
4
ADAM CLAYTON POWELL JR
BLVD
10026-10039
5
ALBANY
ST
10006-10280
6
ALEX ROSE
PL
10033
7
ALLEN
ST
10002
8
ALPHONSO B DEAL
ST
10031
1=Help
3=Quit
4=HS
6=Back
8=Down
9=Mat
10=Flip
NOTE: To view more lines of data, enter the FLIP command in the Command
field, or press F10.
Fields
The following table presents a description of, and acceptable values for, each field on
the Streets in a City or Streets in a ZIP Code screen.
Table 35: Fields on the Streets in a City or Streets in a ZIP Code Screen
Field Name
Description
LN
The line number of the street.
Dir
The leading directional for the street.
Street Name
The names of the street.
Sfx
The suffix for the street.
Dir
The trailing directional for the street.
ZIP Codes
The ZIP Code or Codes that are valid for this street. Note that
this field will only appear if you accessed this screen from the
Cities in the Database screen, not the Cities in a ZIP Code
screen.
Working With CODE-1 Plus
207
2
Interactive Screen Reference
Function Keys
The following table describes the action taken by each function key on the Streets in
a City or Streets in a ZIP Code screens.
Table 36: Fields on the Streets in a City or Streets in a ZIP Code Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Return to the Main Menu.
F4
HS
Go to the Houses on a Street screen.
F6
BACK
Return to the City Information screen.
F7
UP
Scroll the list so that the previous eight streets are
displayed.
F8
DOWN
Scroll the list so that the next eight streets are
displayed.
F9
MAT
Go to the address matching function.
F10
FLIP
Change the screen so that the data fills the entire
physical screen.
NOTE: Entering the name of a key in the Command field is the same as pressing
the function key (for example, to access online help, you could either press F1 or
in the Command field, type HELP and press ENTER.)
Geographic Coding Plus Interface
Please refer to the
User's Guide that
came with
Geographic Coding
Plus for further
reference on the
fields and function
keys on this screen.
208
If you have purchased Geographic Coding Plus from Pitney Bowes, you can access
that product directly from CODE-1 Plus. To do so, type the command GEO in the
Command field on any CODE-1 Plus screen. The Geographic Coding Interface
screen will appear. If you do a match attempt before you enter the GEO command,
your matched ZIP Code and ZIP+4 Code appear in ZIP Code fields on the Geographic
Software Release 4.0.0/March 2015
2
Screens that Support Database Inquiry
Coding Interface screen. This is the first screen of geographic coding data for your
matched address.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Command:
Top
Geographic Coding Interface
ZIP: 20902 ZIP+4: 1104
DPBC: 18
House#: 12018
Match Level:
State Code:
County Code:
Census Tract:
Block Group:
MSA Code:
MSA Name:
ZIP: 20706 ZIP+4: 1844
DPBC: 99
House#: 4200
9
24
031 MONTGOMERY
703404
2
8840
WASHINGTON DC-MD-VA-WV
Lat/Long Level: 4
Latitude: 039.053630 N
Longitude: 077.069344 W
Software: 04.0
4
038.950609 N
076.834870 W
File: February 2003
1=Help
9
24
033 PRINCE GEORGES
803510
1
8840
WASHINGTON DC-MD-VA-WV
Distance in miles:
14.459
8=Down
10=Exit
Fields
The following table presents a description of, and acceptable values for, each field on
the first Geographic Coding Interface screen.
Table 37: Fields on the First Geographic Coding Interface Screen
(Part 1 of 2)
Field Name
Description
ZIP Code
The 5-digit ZIP Code for the entered address.
ZIP+4 Code
The 4-digit ZIP+4 Code for the entered address.
DPBC
Delivery Point Barcode for the entered address.
House#
House Number for the entered address.
Match Level
A code indicating the level of match obtained against the
Geographic Coding Master File. One of the following codes
appears:
State Code
Working With CODE-1 Plus
5
The input ZIP Code matched, but the ZIP+4 Code
did not.
9
Both the ZIP Code and ZIP +4 Code matched the
Master File.
X
The Geographic Coding Master File data has
expired.
The 2-character FIPS state code of the matched address.
209
2
Interactive Screen Reference
Table 37: Fields on the First Geographic Coding Interface Screen
(Part 2 of 2)
Field Name
210
Description
FIPS County Code
The 2-character FIPS county number and 20-character
county name of the matched address.
Census Tract
The 6-digit number representing the census tract division
within the county.
Block Group
The 1-digit numeric code indicating the block group division
of the census tract.
MSA Code
The 4-character Metropolitan Statistical Area that
encompasses this address.
MSA Name
The 50-character Metropolitan Statistical Area name.
Lat/Long Level
A code indicating the level of latitude and longitude
determined for the matched address. One of the following
codes appears.
B
Latitude and longitude represent the population
center of the census block group determined for
the matched address.
T
Latitude and longitude represent the population
center of the census tract determined for the
matched address.
Z
Latitude and longitude represent the area center of
the matched address.
Latitude
A 9-digit number (with six decimal places implied) followed
by a 1-character directional (N or S) that occupy the first
eight bytes of this area.
Longitude
A 9-digit number (with six decimal places implied) followed
by a 1-character directional (E or W) that occupy the last
eight bytes of this area.
Software Vintage
Indicates the version of Geographic Coding you are using.
File
Indicates the expiration date of the Geographic Coding File
that you are using.
Distance in Miles
The number of miles between the two specified addresses,
if necessary.
Software Release 4.0.0/March 2015
Screens that Support Database Inquiry
2
Function Keys
The following table describes the action on the first Geographic Coding Interface
screen.
Table 38: Function Keys on the First Geographic Coding
Interface Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F8
DOWN
Go to the last screen of the Geographic Coding
Interface.
F10
CANCEL
Exit from the Geographic Coding Interface.
This is the second and last screen of geographic coding data for your matched
address.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Command: ________________________________________
Bot
Geographic Coding Interface Additional Information
ZIP: 20902 ZIP+4: 1104
DPBC: 18
House#: 1201
MCD/CCD Code:
Confidence:
PRIZM Cluster:
Cluster Group:
91160
1
21 THE AFFLUENTIALS
S2 SUBURBAN SPRAWL
Place Code: 83837
Class Code: U2 Incorporated:
Place Name: WHEATON-GLENMONT
GeoTAX Key: 21031
Date Annexed
01/1990
1=Help
Working With CODE-1 Plus
ZIP: 20706 ZIP+4: 1844
DPBC: 99
House#: 4200
Updated
No
RC: N
91164
1
52975
U1 No
MITCHELLVILLE
21033
Verified
Annexed
01/1990
7=Up
N
Updated
Verified
10=Exit
211
2
Interactive Screen Reference
Fields
The following table presents a description of, and acceptable values for, each field on
the second and last Geographic Coding Interface screen.
Table 39: Fields on the Second Geographic Coding Interface Screen
(Part 1 of 2)
Field Name
212
Description
ZIP Code
The 5-digit ZIP Code for the entered address.
ZIP+4 Code
The 4-digit ZIP+4 Code for the entered address.
DPBC
Delivery Point Barcode for the entered address.
House#
House Number for the entered address.
MCD/CCD Code
MCDs (Minor Civil Divisions) are the primary political or
administrative divisions of a county, representing many
kinds of legal entities with a variety of governmental and
administrative functions. CCDs (Census County Divisions)
are established in states where there are no legally
established MCDs.
Confidence
A 1-character code that indicates the confidence code
source. One of the following codes appears:
Z
ZIP level
0
ZIP default
1
ZIP sector method
2
5-digit household default method
3
5-digit boundary method
PRIZM Cluster
A 2-character PRIZM cluster code and a 20-character
PRIZM cluster name. PRIZM codes are lifestyle segment
codes and definitions enabling for more precise
information about the lifestyle and demographic features of
a population.
Cluster Group
A 2-character PRIZM cluster social group code and a 20character group name.
Place Code
A 5-character FIPS place code.
Incorporated
A 1-character code indicating whether the entered address
is in an incorporated area.
Y
Incorporated
N
Not incorporated
Class Code
A 2-character class code.
Place Name
A 30-character place name.
Software Release 4.0.0/March 2015
Screens that Support Database Inquiry
2
Table 39: Fields on the Second Geographic Coding Interface Screen
(Part 2 of 2)
Field Name
Description
GeoTAX Key
NOTE: This field is only available to GeoTAX customers who
are also licensed users of the Vertex Quantum or
ComTax21 products.
Up to 9 digits can be displayed in this field. The first 2 digits
of this number represent the Vertex state code, the next 3
digits are the FIPS county code, and the next 4 digits, a
Vertex city code.
This information will only be displayed for those GeoTAX
customers who have a subscription to the MATCHMST file
from Vertex. Additional information on this subject can be
found in the GeoTAX User’s Guide.
GeoTAX Key Return Code
A 1-character code indicating the match results for the
GeoTAX Key:
Blank
No matching GTMASTR GeoTAX record found
E
Exact match using state/county/place/ZIP Code/
place name.
P
Partial match using state/county/place
A
Alternate match using ZIP Code and place name
N
Record is default coded based on valid state code.
Date Annexed
Place last annexed date.
Updated
Place last updated date.
Verified
Place last verified date.
Function Keys
The following table describes the resulting action for each function key on the
second and last Geographic Coding Interface screen.
Table 40: Function Keys on the Second Geographic Coding
Interface Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F7
UP
Go to the first screen of the Geographic Coding
Interface.
F10
CANCEL
Exit from the Geographic Coding Interface.
Working With CODE-1 Plus
213
2
Interactive Screen Reference
Screens that Support Site Customization
The screens shown in this section all support the interactive site customization
function.
Administration Sign-on Screen
If you do not have
your initial
password, contact
Pitney Bowes
support at
800-367-6950.
The Administration Sign-on screen allows you to type in, and optionally update, the
password required to access the site default update screens. This screen is accessed
by typing “ADMIN” from any match or database inquiry screen. If a new password is
typed in, the screen will return with an area to “Confirm New Password.”
The password change process can be stopped by pressing the space bar through both
new password fields, or by selecting Quit or Cancel. The Administration Sign-on screen
is shown below.
CODE-1 Plus Coding System
------------------------------------------------------------------------Command:
CODE-1 Plus Administration Sign-on Screen
Password:
New Password:
G1M01I Enter Current Password and optional New Password
1=Help
214
3=Quit
10=Cancel
Software Release 4.0.0/March 2015
Screens that Support Site Customization
2
Fields
The following table presents a description of each field on the Administration Sign-on
screen.
Table 41: Fields on the Administration Sign-On Screen
Field Name
Description
Password
Area to type in current password
New Password
Area to type in a new password. The new password must be
1-8 alphanumeric characters with no leading or embedded
spaces.
Confirm New Password
Area to re-type the new password for confirmation. This
field will only be displayed if a new password has been
entered.
Function Keys
The following table describes the action initiated by each function key on the
Administration Sign-on screen.
Table 42: Function Keys on the Administration Sign-On Screen
Function Key
Name
Description
F1
HELP
Obtain online help.
F3
QUIT
Exit from the Interactive CODE-1 Plus System.
F10
CANCEL
Return to screen from which “ADMIN” was
invoked.
Interactive Customization Screens
The Interactive Customization screens allow you to view, and optionally update, the
site-specific values you choose for your system. These screens are accessed by
successfully entering the existing system password on the Administration Sign-on
screen (accessed by the “ADMIN” command). Values on these screens are not
updated unless F5 is pressed (or “Save” on the command line is selected), and the
changed values are not validated until either the ENTER key or “Save” are pressed.
Working With CODE-1 Plus
215
2
Interactive Screen Reference
The first Interactive Customization screen is shown below.
CODE-1 Plus Coding System
--------------------------------------------------------------------------Command: ________________________________________
Interactive Customization Screen
Page 1 of 3
Display Options
Address Match Settings
Initial Screen: S (S, F)
Expiration Warning: D (D, S)
Initial Command:
Firm: M (T, M, L, E)
Dir/Suffix: M (T, M, L, E)
Street: M (T, M, L, E)
Vanity City Name: X (X, S)
Correct Input ZIP: Y (Y, N)
Use Output Case: U (U, L, C)
Multiple Secondary: Y (Y, N)
Preferred City Name: C (C, Z)
Perform DPV Process:
(Blank, X)
Perform LTO Process:
(Blank, X)
Perform RDI Process:
(Blank, X)
Last Updated on: 09/09/2002 15:43:37
G1M06I Change current Site Default Settings as desired
1=Help
Enter=Verify
3=Quit
5=Save
8=Down
9=Reset
10=Exit
Fields
The following table describes the fields available for update on the first Interactive
Customization Screen.
Table 43: Fields on the First Interactive Customization Screen
(Part 1 of 3)
Field Name
Initial Screen
Expiration Warning
Firm
216
Description
Indicates Split or Full Screen display on entry to system
S
Split screen display
F
Full screen display
Display or suppress database warning
D
Display database warning
S
Suppress database warning
Firm Match Setting Value. Refer to the “Match Settings
Screen” section earlier in this chapter for an explanation of
these values.
T
Tight
M
Medium
L
Loose
E
Equal
Software Release 4.0.0/March 2015
Screens that Support Site Customization
2
Table 43: Fields on the First Interactive Customization Screen
(Part 2 of 3)
Field Name
Dir/Suffix
Street
Vanity City
Correct Input ZIP
Output Case
Multiple Secondary
Working With CODE-1 Plus
Description
Directional/Suffix Match Setting Value. Refer to the “Match
Settings Screen” section earlier in this chapter for an
explanation of these values.
T
Tight
M
Medium
L
Loose
E
Equal
Street Match Setting Value. Refer to the “Match Settings
Screen” section earlier in this chapter for an explanation of
these values.
T
Tight
M
Medium
L
Loose
E
Equal
Match Setting for Vanity Cities. Refer to the “Match Settings
Screen” section earlier in this chapter for an explanation of
these values.
X
Allow vanity city names in standardized output.
S
Only allow primary/secondary city names in
standardized output.
Match Setting for ZIP correction. Refer to the “Match
Settings Screen” section earlier in this chapter for an
explanation of these values.
Y
Correct input ZIP Codes
N
Do not correct input ZIP Codes.
Returned address settings. Refer to the “Match Settings
Screen” section earlier in this chapter for an explanation of
these values.
C
Display matched address in mixed case.
L
Display matched address in lower case only.
U
Display matched address in upper case only.
Match Setting for Multiple Secondary Components. Refer to
“Match Settings Screen” section earlier in this chapter for
an explanation of these values.
Y
Attempt secondary match.
N
Assign default ZIP+4 Code.
217
2
Interactive Screen Reference
Table 43: Fields on the First Interactive Customization Screen
(Part 3 of 3)
Field Name
Preferred City Name
Perform DPV Process
Description
Match Setting for Preferred City Name. Refer to Override
City Name in the table from the “Match Settings Screen”
section earlier in this chapter for an explanation of these
values.
C
Store the city name from USPS City/State File
(default city name)
Z
Store the ZIP+4 File Preferred Last Line City Name
(override city name).
Here you can select whether or not you wish to perform
DPV processing:
X
Perform DPV processing.
Blank
Do not perform DPV processing.
NOTE: This can also be selected by entering DPV on the
command line of the Address Match screen.
Perform LTO Process
Here you can select whether or not you wish to perform
Line of Travel Option (LOT) processing:
X
Perform LTO processing.
Blank
Do not perform LTO processing.
NOTE: This can also be selected by entering LTO or LOT on
the command line of the Address Match screen.
Perform RDI Process
Here you can select whether or not you wish to perform
Residential Delivery File (RDI) processing:
X
Perform RDI processing.
Blank
Do not perform RDI processing.
NOTE: This can also be selected by entering RDI on the
command line of the Address Match screen.
Initial Command
218
Command to be invoked upon entry of the system. Can be
a combination of screen (CI, CS, CZ, or SZ) and locate
commands separated by a semicolon. If ‘FLIP’ is entered,
‘Initial Screen’ is set to ‘F’.
Software Release 4.0.0/March 2015
Screens that Support Site Customization
2
Function Keys
The following table describes the resulting action for each key on the first Interactive
Customization screen.
Table 44: Function Keys on the First Interactive Customization Screen
Function Key
Name
Description
F1
Help
Obtain online help.
Enter
Verify
Validate the fields. If the validation is
unsuccessful, the screen is redisplayed, an error
message is displayed, and the first field in error is
indicated.
F3
Quit
Exit the system as defined on the customization
database.
F5
Save
Save current entries after validation. Remain on
screen after save.
F8
Down
Go to the second customization screen.
F9
Reset
Restore screen values to current database entries
(at last update to customization file).
F10
Exit
Return to the screen from which “ADMIN” was
entered.
This is the second Interactive Customization screen.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Command:
Interactive Customization Screen
Page 2 of 3
Processing Options
Geographic Coding Available: Y
(N, Y)
GEO Lat/Long Data Source: A
(B = Base, A = Advanced, F = Finest)
Use GEO County: Y
(N, Y)
ZIP Match Centroid: C
(Z = ZIP, C = Census Tract)
Return Alias Base on Match: N
(N, Y)
Seed Stop Bypass Message
Custom Page Title
Use Navigation
(N is the default)
Enhanced/All Street Matching
(space is the default)
Preferred Alias Processing
(no default)
Abbreviated Alias Processing
(no default)
G1M07I Change current Processing Options as desired
1=Help
Enter=Verify
3=Quit
5=Save
7=Up
Working With CODE-1 Plus
8=Down
9=Reset
10=Exit
219
2
Interactive Screen Reference
Second Interactive Customization Screen With Seed Violation Bypass Option
RXX.XM00 Month Year
CODE-1 Plus Coding System
MM/DD/YYYY HH:MM:SS
------------------------------------------------------------------------------Command:
Interactive Customization Screen
Page 2 of 3
Processing Options
Geographic Coding Available: N
(N, Y)
Geo Lat/Long Data Source:
(B = Base, A = Advanced, F = Finest)
Use Geo County: N
(N, Y)
ZIP Match Centroid: C
(Z = ZIP, C = Census Tract)
Return Alias Base on Match: N
(N, Y)
*** SEED STOP BYPASS IS ON ***
Custom Page Title: CODE-1 Plus for Windows
Use Navigation: N
(N, Y)
Enhanced/All Street Matching: A
(E = ESM, A = ASM)
Preferred Alias Processing: Y
(N, Y)
Abbreviated Alias Processing: Y
(N, Y)
G1M07I Change current Processing Options as desired
1=Help
Enter=Verify
3=Quit
5=Save
7=Up
220
8=Down
9=Reset
10=Exit
Software Release 4.0.0/March 2015
Screens that Support Site Customization
2
Fields
The following table describes the fields available for update on the second Interactive
Customization screen.
Table 45: Fields on the Second Interactive Customization Screen
(Part 1 of 2)
Field Name
Geographic Coding Available
GEO Lat/Long Data source
Use GEO County
ZIP Match Centroid
Return Alias Base on Match
Seed Violation Bypass
Description
Indicates whether Geographic Coding Plus is installed on
the system or whether the legacy Geographic Coding
System is installed.
N
Geographic Coding Plus is not installed on the
system.
Y
Geographic Coding Plus is installed on the system.
L
Legacy Geographic Coding System is installed.
Indicates which GEO file to use.
B
Use base master file.
A
Use advanced file.
F
Get finest granularity available on either base or
advanced file.
Indicates whether to return the Geographic Coding county
on the CODE-1 Plus Match screen on a successful match.
Y
Use Geographic Coding county.
N
Use USPS county.
Indicates centroid to return on a ZIP Code match.
C
Census tract centroid
Z
ZIP Centroid
Indicates whether to change an alias street name displayed
on a match to the base street name.
Y
Display base street name.
N
Retain alias street name.
You can determine if the system should bypass any seed
record violations during processing. To activate this option,
enter "STOPBYPASS" on the command line of the admin
function screen. Once you have entered "STOPBYPASS" on
the command line, the following text will appear on that
line: SEED STOP BYPASS IS ON. Enter "STOPBYPASS" to
disable the option.
NOTE: You will be required to have knowledge of the
ADMIN password to access this process. If you enter
"STOPBYPASS" on the command line on other screens
you will receive an error message.
Custom Page Title
Working With CODE-1 Plus
The interactive system page title (for all screens) can be
customized using this option.
221
2
Interactive Screen Reference
Table 45: Fields on the Second Interactive Customization Screen
(Part 2 of 2)
Field Name
Description
Use Navigation
The default setting for Intelligent Navigation can be set
here.
Y
Navigation on.
N
Navigation off.
Enhanced/All Street Matching
Enhanced/All Street Matching Indicator
Preferred Alias Processing
Abbreviated Alias Processing Indicator
Abbreviated Alias Processing
Abbreviated Alias Processing Indicator
Return Transid
Indicates Transid to be invoked upon exit from system (CICS
only)
TS Queue Utilization
Indicates whether Auxiliary or Main Storage is to be used
for TS Queues (CICS only).
A
Auxiliary storage is to be used.
M
Main storage is to be used.
Function Keys
The following table describes the resulting action for each function key on the
second Interactive Customization screen.
Table 46: Function Keys on the Second Interactive
Customization Screen
Function Key
222
Name
Description
F1
Help
Obtain online help.
F3
Quit
Exit the system as defined on the customization
database.
F5
Save
Save current entries after validation. Remain on
screen after save.
F7
Up
Go to the first Interactive Customization screen.
F9
Reset
Restore screen values to current database entries
(at last update to customization file).
F10
Cancel
Return to the screen from which “ADMIN” was
entered.
Software Release 4.0.0/March 2015
Database Information Screen
2
Definition of PFKEYS
The third and last customization screen allows you to define your program function
keys (PFKEYS). This will enable you to maintain any in-house standards for PFKEY
usage within the CODE-1 Plus system.
Working within this third screen, you can change the assigned PFKEY of a certain
function or the Text associated with a particular PFKEY. For example, looking at the
screen capture below, you can tab down to PFKEY 01 and change the text from “Help”
to “Info.”
CODE-1 Plus Coding System
----------------------------------------------------------------------------Command:
Interactive Customization Screen
Page 3 of 3
PFKEY Assignments
Pfkey
Help: 01
Quit: 03
Down/Next: 08
Back:
06
Save, Reset:
ZC, SC, CZ:
MS, Refresh, GEO:
Alias, AH, FM:
Text
Help
Quit
Down
Up/Previous:
Match, Inquiry:
Flip, Exit/Cancel:
Back
HS:
SZ:
Pfkey
05
02
04
02
Text
Save
ZC
MS
Alias
Pfkey
09
04
05
04
Pfkey
07
09
10
04
04
Text
Reset
SC
RE
AH
Text
Up
Mat
Flip
Text
Inq
Exit
HS
SZ
Pfkey
05
06
05
Text
CZ
Geo
FM
G1M06I Change current Site Default Settings as desired
1=Help
Enter=Verify
3=Quit
5=Save
7=Up
9=Reset
10=Exit
NOTE: You CANNOT assign one PFKEY to have several functions. If you do so, the
screen will state that “Key designation conflicts with a Multi-Screen Key.” Any
errors in defining PFKEYS will appear in red when you hit the ENTER key after
making your changes.
Database Information Screen
The Database Information screen shows information related to the software and
database installed for CODE-1 Plus. Specific fields included in the screen are the
software release and modification numbers, the CASS expiration date of the software,
the database vintage date and expiration date (after which inquiry but not matching
is permitted) and the days remaining until expiration. The following is a sample of the
information available on the Database Information screen.
Working With CODE-1 Plus
223
2
Interactive Screen Reference
NOTE: The DPV database vintage date will appear only if you have performed a
match with DPV turned on.
CODE-1 Plus Coding System
------------------------------------------------------------------------------Firm Name:
Firm: M D/Suf: M
Secondary Addr:
St: M Vcity: S
Primary Addr:
Correct ZIP: Y
City, ST:
Output Case: U
ZIP Code:
Urb Name:
Mult Secondary: Y
Override City: Z
Matched Addr:
CRRT:
City,State ZIP:
DPBC:
------------------------------------------------------------------------------Command:
Nav Off
__ of __
DB - Database Information
(1 of 1)
CODE-1 Plus software release RXX.X mod 00 for the current CASS cycle expires
beginning.
CODE-1 Plus MONTH YEAR database expires after MM/DD/YYYY.
There are NNN days remaining until this database expires.
DPV database vintage is MM/YYYY.
Programs and Design (C) Copyright Pitney Bowes Software Inc. 2015.
1=Help
3=Quit
4=MS
5=RE
6=Geo
9=Inq
10=Flip
Customization File Administration
The site customization file (G1CPFDF) is an updateable indexed file for the
interactive system. If you plan on modifying default initialization and processing
values for your site, you need to install the customization file. Otherwise, the
interactive system will function with the default match settings and processing on
entry to and exit from the CODE-1 Plus software.
NOTE: The customization file is required for accessing the Geographic Coding
Interface screen. If the customization file is not available, the Geographic Coding
Interface is not available.
224
Software Release 4.0.0/March 2015
Customization File Administration
2
File Backup and Security
Because the site customization file can be modified any time the interactive system is
available, it is critical to perform regular backups of the file at your site. This ensures
ease of recovery of the current site settings in case the file is accidentally lost.
You should limit update access to the interactive system, because the settings in this
file apply to all users. Online access to this file is controlled through a password
screen; however, security precautions may be appropriate.
File Repair, Re-Initialization, and Password Display
If a backup copy of the customization file is not available and recovery is required, a
number of options exist using program G1CPDFL. For mainframe users there are two
options.
The first option is to physically delete the file and re-run the initialization job,
DEFCUSTM.
A second option involves the same customization utility, but using job CUSTMUTL.
In this case the utility can be used to repair the G1CPFDF file or display the
encrypted password. This job performs the following tasks:
1. If an error is detected on the open to the customization file, the program will
attempt to create the file.
2. If the attempt is not successful, the program will issue an appropriate error
message and terminate.
3. If the file is opened successfully, a read will be attempted for the control record.
4. If the read for the control record fails, the customization utility will add the
control record to the file.
5. If the read for the control record is successful, the customization utility will
search for the admin (password) record.
6. If the admin (password) record is found, the customization utility will display the
encrypted password stored on the record.
If the admin record is not found, the initial install password will be written to the
file.
Working With CODE-1 Plus
225
2
Interactive Screen Reference
If required, a decryption of the password can be obtained by calling Pitney Bowes
Technical Support at (800) 367-6950. Given the 16-character hexadecimal
representation of the password, the Technical Support Representative can provide
you with the current text value of the password.
Batch Uncoded Records Interface (G1CPBNC)
The Interactive CODE-1 Plus System includes a user exit that you can use to correct
records that were not coded by the batch product. The interface, G1CPBNC, reads
an uncoded records file produced by batch CODE-1 Plus (C1BMNCO).The user exit
is designed so that you can pull one record at a time into the screen input area,
correct the record, and then write the corrected record out to a corrected file.
NOTE: To take advantage of the batch non-coded records interface to Interactive
CODE-1 Plus, you or someone at your site must have modified the sample
program, called G1CPBNC, to read records from the C1BMNCO file, pass them to
Interactive CODE-1 Plus, wait for the user to correct the record, receive the
records back from Interactive CODE-1 Plus, and then write the corrected records
to an output file. This is discussed later in this section.
Once you modify a G1CPBNC user exit program, follow the instructions in the
previous chapter, “Understanding the Interactive Functions,” to use the UR and UW
commands from the CODE-1 Plus Interactive screen.
1. Type the UR (User Read) command in the Command field. An address is pulled
from the input file and placed in the address input area.
How it Works
When you enter the UR command, the user exit program G1CPBNC is invoked and
the functionality supplied by the UR command is contained within this program. The
same situation applies to the UW command. You must customize the G1CPBNC to
suit the need of your specific environment. A sample user exit program that you can
customize is supplied as part of the product.
In addition to the input and output addresses, the complete Command field
containing the UR or UW command is passed to the user exit so that additional
command parameters can be required as part of the UR or UW commands (for
example, record number of the address being corrected). You can specify several
screen presentation options to control how the screen appears upon command
completion.
226
Software Release 4.0.0/March 2015
Batch Uncoded Records Interface (G1CPBNC)
2
These screen presentation options control:
•
The message that appears
•
The clearing of the Command field to blanks
•
The sounding of an audible alarm
•
The clearing of the address area to blanks
•
The cursor position upon the completion of the UR and UW commands.
A sample program, G1CPBNC, is supplied with the CODE-1 Plus software. The
program is written to read the supplied IVPFILE and write the coded records to a
user-defined output file. Your input file may have different attributes (for example,
record length or address element location) and will need to be modified accordingly.
In the following section, the required functionality for both the UR and UW
commands is described, the calling interface for G1CPBNC is explained, and excerpts
from the sample G1CPBNC program are shown. The UR and UW commands are
enabled simply by making G1CPBNC available in the run-time environment.
NOTE: The remaining sections in this chapter are intended for programmers
writing the G1CPBNC user-exit program.
UR COMMAND
When you enter a UR (User Read) command, the G1CPBNC user exit program is
invoked with UXIT-FUNCTION set to UXIT-READ-FILE. The available functionality
includes the following:
•
Select and read a record from a user file containing addresses which are to be
supplied when the UR command is entered. The selected address is passed to the
calling program through the UXIT-P9IN field. The user exit must enable for
multiple terminal operators working at the same time.
•
The entire Command field containing the UR command is available to the
G1CPBNC program so that additional user-defined parameters can be defined as
part of the UR command. The Command field is passed from the calling program
through the UXIT-COMMAND-LINE field.
•
Specify the message that appears on the terminal screen at the completion of the
UR command in the UXIT-PROMPT-MESSAGE field.
•
Specify whether or not the Command field on the terminal screen is to be
blanked-out upon completion of execution for the UR command. This is specified
via the UXIT-COMMAND field.
Working With CODE-1 Plus
227
2
Interactive Screen Reference
•
Specify whether or not an audible alarm is to sound at the completion of
execution for the UR command. This is specified via the UXIT-ALARM field.
•
Specify whether the cursor on the terminal screen is to be positioned on the
address input lines or the Command field at the completion of execution for the
UR command. Since CODE-1 Plus automatically performs an attempted match
subsequent to a UR command, UXIT-CURSOR-CMD-ON-MTCH can be used to
position the cursor on the command line (for an anticipated UW command) on a
match or in the address area on a non-match or multiple. This is specified via the
UXIT-CURSOR field.
•
In order to coordinate the execution of UR and UW commands, an area of
statically allocated memory is made available that is specific to one individual
terminal user. This area is UXIT-SAVE-AREA.
UW COMMAND
When you enter a UW (User Write) command, the G1CPBNC user exit program is
invoked with UXIT-FUNCTION set to UXIT-WRITE-FILE.
The results from attempting to match the address currently on the terminal screen
are passed to the user exit in the UXIT-P9OUT and UXIT-P9AUDT fields. The user
exit should determine whether to accept the address and write it to a user file
containing corrected addresses or reject the address and display an error message on
the terminal screen. The user exit must enable for multiple terminal operators
working at the same time.
228
•
The entire Command field containing the UW command is available to the
G1CPBNC program so that additional user-defined parameters can be defined as
part of the UW command. The Command field is passed from the calling program
through the UXIT-COMMAND-LINE field.
•
Specify the message which appears on the terminal screen at the completion of
the UW command in the UXIT-PROMPT-MESSAGE field.
•
Specify whether or not the Command field on the terminal screen is to be
blanked out upon completion of execution for the UW command. This is specified
via the UXIT-COMMAND field.
•
Specify whether or not an audible alarm is to sound at the completion of
execution for the UW command. This is specified via the UXIT-ALARM field.
•
Specify whether or not to clear the address input fields on the terminal screen at
the completion of execution for the UW command. This is specified via the UXITADDRESS field.
•
Specify whether the cursor on the terminal screen is to be positioned on the
address input lines or the Command field at the completion of execution for the
UW command. This is specified via the UXIT-CURSOR field.
Software Release 4.0.0/March 2015
Batch Uncoded Records Interface (G1CPBNC)
•
2
In order to coordinate the execution of UR and UW commands, an area of
statically allocated memory is made available that is specific to one individual
terminal user and common to both the UR and UW commands. This area is UXITSAVE-AREA.
Program Parameters
Eleven logical parameters are passed in a single 01 level. These eleven parameters are
as follows:
Table 47: The G1CPBNC Option Call Areas (Part 1 of 2)
Position
1-2
Name
EXITFUNCTION
Length
in Bytes
2
Contents
The function code for this call. Your program must
pass one of the following function codes:
CL
Close the file.
OP
Open the file.
UR
Perform a read.
UW
Perform a write.
3-42
UXITCOMMANDLINE
40
The command line from the Interactive CODE-1 Plus
Command field.
43-121
UXITPROMPTMESSAGE
79
The message prompt that appears on the online
screen after the return from this program.
122
UXITCOMMAND
1
Indicates whether or not to clear the command after
completion of the UR or UW command.
123
124
Working With CODE-1 Plus
UXIT-ALARM
UXITADDRESS
1
1
Y
Clear the Command field after completion of
the UR or UW command.
N
Do not clear the Command field.
Indicates whether or not to sound an audible alarm
at the completion of the UR or UW command.
Y
Sound an audible alarm at the completion of
the UR or UW command.
N
Do not sound an alarm.
Indicates whether or not to clear the address upon
completion of the UW command. Not used during the
processing for a UR command.
Y
Clear the address area upon completion of
the UR or UW command.
N
Do not clear the address area.
229
2
Interactive Screen Reference
Table 47: The G1CPBNC Option Call Areas (Part 2 of 2)
Position
125
Name
UXIT-CURSOR
Length
in Bytes
1
Contents
Indicates whether or not to place the cursor in the
address fields at the completion of the UR or UW
command.
Y
Place the cursor in the address area.
N
Place the cursor at the Command field.
M
Place the cursor at the Command field on a
match, or in the address area on a nonmatch or multiple.
126-221
UXITRESERVED
96
These bytes are reserved.
222-721
UXIT-P9IN
500
During the processing for a UR command, this
program should place the address which it is
preparing to enter onto the online screen into this
area. This field is not used during the processing of a
UW command.
722-5721
UXIT-P9OUT
5,000
During the processing for a UW command, this area
contains the P9OUT area for the current address at
the time the UW command was invoked. Not used
during the processing of a UW command.
5722-6121
UXIT-P9AUDT
400
During the processing for a UW command, this area
contains the P9AUDT area for the current address at
the time the UW command was invoked. Not used
during the processing of a UR command.
6122-6621
UXIT-SAVEAREA
500
Memory that is statically allocated and preserved
between invocations of the user exit.
Description of Supplied Sample G1CPBNC
When the UR command is invoked, this sample program sequentially reads an address
record from the G1CPIVP file. As each address is displayed in response to each UR
command, the Command field on the terminal screen is cleared to blanks, a message
is displayed on the terminal screen indicating a successful read, no audible alarm is
given, and the cursor is positioned to the address input area on the terminal screen.
If at the end of the file (“end of file”), the Command field is not cleared to blanks, an
error message is displayed on the terminal screen, an audible alarm is sounded, and
the cursor is positioned to the Command field on the terminal screen.
230
Software Release 4.0.0/March 2015
Batch Uncoded Records Interface (G1CPBNC)
2
When the UW command is invoked, the program first checks to ensure that a UR
command preceded the UW command. If it did, then it next checks to see if an
address match was successful for the current address. The corrected address could
then be written to an user file. If the UW command was successful, then the
Command field on the terminal screen is cleared to blanks, a message is displayed on
the terminal screen indicating a successful write, and no audible alarm is given. If the
UW command was not successful, then the Command field is not cleared to blanks,
an error message is displayed on the terminal screen, and an audible alarm is
sounded. In either case, the cursor is positioned to the Command field on the
terminal screen.
NOTE: The delivered version of G1CPBNC is set up to perform file I/O against the
IVP output unmatched records file C1BMNCO. In CICS, the program reads and
writes to extra partition datasets. The transient data queues are “G1IV” (readq)
and “G1OV” (write). On all other platforms, the input sequential dataset is
“G1CPIVP,” and the output is to “G1CPOVP”. All datasets have LRECL=256, and
BLKSIZE is determined by the job control language.
Working With CODE-1 Plus
231
2
232
Interactive Screen Reference
Software Release 4.0.0/March 2015
CHAPTER 3
Using the Z4CHANGE Option
This chapter discusses the Z4CHANGE Option program within CODE-1 Plus.
Instructions are included for running a Z4CHANGE Option CODE-1 Plus job and
calling the Z4CHANGE program, C1P430, from your own driver.
What is the Z4CHANGE Option? . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The Z4CHANGE Option Database . . . . . . . . . . . . . . . . . . . . . . . . .
Rules for Using the Z4CHANGE Option . . . . . . . . . . . . . . . . . . . .
Activating the Z4CHANGE Option, C1P430 . . . . . . . . . . . . . . . . . .
Using Z4CHANGE Option Processing . . . . . . . . . . . . . . . . . . . . . . . . .
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Process Your Entire List Through CODE-1 Plus . . . . . . . . . .
Each Month, Process Your File Again . . . . . . . . . . . . . . . . . .
Calling C1P430 From Your Own Driver. . . . . . . . . . . . . . . . . . . . . . . .
Working With CODE-1 Plus
234
234
234
235
235
235
235
236
237
233
3
Using the Z4CHANGE Option
What is the Z4CHANGE Option?
The Z4CHANGE Option is a product provided by the United States Postal Service
(USPS) that can save you a considerable amount of processing time. The Z4CHANGE
Option is extremely useful if you have large name-and-address files that you use
frequently. The Z4CHANGE Option enables you to run that file through
CODE-1 Plus and attempt to match:
•
Only those records with ZIP + 4 Codes changed by the USPS since the file was last
processed
•
Records that were not successfully coded on previous CODE-1 Plus runs.
In other words, if you have a list that you already processed using CODE-1 Plus, you
can run the list each month using the Z4CHANGE Option processing, and attempt
to match those records with new ZIP + 4 Codes.
NOTE: Before you use the Z4CHANGE Option, you must run your entire file
through CODE-1 Plus one time without using Z4CHANGE Option. Then, each
time you want to mail records from your file, run the file again using Z4CHANGE
Option processing. Your list stays current, but you do not expend processing time
confirming records that were already correct.
The Z4CHANGE Option Database
Included with your CODE-1 Plus software is a Z4CHANGE Option database. The
database is published by the USPS every month and contains all of the ZIP + 4 Codes
that the USPS changed in the previous 12-month period.
Rules for Using the Z4CHANGE Option
The USPS instituted the following rules regarding Z4CHANGE Option processing:
234
•
You must initially run your entire mailing list through CASS-certified software.
•
Subsequently, it is sufficient to use Z4CHANGE Option processing on that list to
maintain its compliance with CASS rules.
•
You must run the entire file again at the end of the third year following initial
Z4CHANGE Option certification. (This means that you do not need to run the file
through CASS-certified software every year, as long as you are using Z4CHANGE
Option processing.)
Software Release 4.0.0/March 2015
Using Z4CHANGE Option Processing
3
NOTE: If the USPS determines that significant changes were made to the CASS
requirements, you must reprocess your entire list using recently-certified
software.
Activating the Z4CHANGE Option, C1P430
To activate and use Z4CHANGE, you can either pass, as parameters, the names of predefined call areas, or use the CS ZIP parameter and the Z4 OUT parameter to provide
all the information necessary to perform the function accurately and return the
appropriate information.
For complete
parameter
reference material,
refer to Chapter 1.
The call areas and the procedures for filling in the parameters are described later in
this chapter.
Using Z4CHANGE Option Processing
This section explains the changes you need to make to your CODE-1 Plus jobs in
order to user Z4CHANGE Option processing, program C1P430.
Parameters
Using Z4CHANGE Option processing is a simple matter of adding fields to the CS ZIP
and Z4 OUT parameters from a standard job. Follow the instructions below to
perform Z4CHANGE Option processing in your batch job.
Process Your Entire List Through CODE-1 Plus
If you want to have CODE-1 Plus write the database vintage date in the output
records, do the following:
1. In position 26-28 of the Z4 OUT parameter, specify the location for the database
vintage date.
2. In position 30 of the Z4 OUT parameter, specify one of the following codes to
indicate the format of the vintage date:
•
Working With CODE-1 Plus
C — 4-byte character format (YYMM) (this is the default)
235
3
Using the Z4CHANGE Option
•
P — 3-byte packed decimal format (YYMM)
•
B — 2-byte binary format (YYMM)
•
3 — 3-byte binary format (YYYYMM)
•
6 — 6-byte character format (YYYYMM)
•
4 — 4-byte packed decimal format (YYYYMM)
Each Month, Process Your File Again
If the vintage date is stored in your input records:
1. In positions 44-46 of the CS ZIP parameter, write the location of the master file
vintage date in the input records.
2. In position 48 of the CS ZIP parameter, write one of the following format codes
to tell CODE-1 Plus the format of the vintage date in the input records:
•
C — 4-byte character format (YYMM) (this is the default)
•
P — 3-byte packed decimal format (YYMM)
•
B — 2-byte binary format (YYMM)
•
3 — 3-byte binary format (YYYYMM)
•
6 — 6-byte character format (YYYYMM)
•
4 — 4-byte packed decimal format (YYYYMM)
3. In positions 32-34 of the Z4 OUT parameter, write the location for the output
Z4CHANGE Option Return Code. One of the following codes will be stored in the
position you specify:
•
0 — Address matching was not required for this record (the USPS has not
changed this ZIP + 4 Code since the database vintage date).
•
4 — Address matching was required for this record (the USPS has changed
this ZIP + 4 Code since the database vintage date).
•
8 — A fatal error occurred during processing.
If the vintage date is not stored in your input records:
4. In positions 50-55 of the CS ZIP parameter, specify the vintage date of the
master file that was used to process this list the last time the list was processed.
Write the date in YYYYMM format.
5. In positions 32-34 of the Z4 OUT parameter, write the location for the output
Z4CHANGE Option Return Code. One of the following codes is stored in the
position you specify:
236
Software Release 4.0.0/March 2015
Calling C1P430 From Your Own Driver
3
•
0 — Address matching was not required for this record (the USPS has not
changed this ZIP + 4 Code since the database vintage date).
•
4 — Address matching was required for this record (the USPS has changed
this ZIP + 4 Code since the database vintage date).
•
8 — A fatal error occurred during processing.
Calling C1P430 From Your Own Driver
If you are using your own batch driver for CODE-1 Plus, and you want to use the
Z4CHANGE Option program, you will use the following call area to invoke C1P430.
A COBOL copy book of this area is included on your software distribution media as
Z4CPARM.
NOTE: The C1PRPT callable report program will not print a USPS Form 3553 that
reflects Z4CHANGE Option processing. If you want an automated Form 3553
facsimile, you must use the C1BM00 batch driver to run CODE-1 Plus.
The Z4CHANGE Option call area is laid out as follows:
Table 1: The Z4CHANGE Option Call Areas (Part 1 of 3)
Position
1
Name
PARM-FUNCTION
Length
1
Contents
The function code for this call. Your program must
pass one of the following function codes:
O
Open the Z4CHANGE Option database and
(optionally) check dates.
P
Process ZIP check request.
C
Close the Z4CHANGE Option database.
2-6
PARM-5-DIGIT ZIP
5
The 5-digit ZIP Code.
7-10
PARM-4-DIGIT ZIP
4
The 4-digit ZIP + 4 Code.
Working With CODE-1 Plus
237
3
Using the Z4CHANGE Option
Table 1: The Z4CHANGE Option Call Areas (Part 2 of 3)
Position
11-16
Name
PARM-DATECODED-VINTAGE
YYYYMM format
Length
6
Contents
If PARM-FUNCTION is set to O, your program must
pass the date of the CODE-1 Plus database being
used for this CODE-1 Plus run. This date will be
compared to the date of the Z4CHANGE Option
database to ensure that they are the same. CODE1 Plus will then pass the vintage date on the
Z4CHANGE Option database back to your calling
program through this field.
If PARM-FUNCTION is set to P, your program must
pass the date (in YYYYMM format) of the master file
that was last used to match the record whose ZIP
Code is now being checked.
If PARM-FUNCTION is set to C, this field is
ignored.
NOTE: This field uses a four-digit year in YYYY
format. If leading zeroes are passed in lieu of
century, century will be calculated using the 80/20
rule. That is, YY less than 80 will assume
century=20, otherwise will assume century=19.
238
17-29
Reserved
13
30-39
PARM-DBLIB
10
The name of the library that holds the Z4CHANGE
Option master file. Used for IBM i only.
Software Release 4.0.0/March 2015
Calling C1P430 From Your Own Driver
3
Table 1: The Z4CHANGE Option Call Areas (Part 3 of 3)
Position
40
Name
PARM-RETURNCODE
Length
1
Contents
This 1-character field is filled by C1P430 after the
ZIP Code is checked. One of the following codes
will be placed in this field:
0
If PARM-FUNCTION is O, this means the
file has been successfully opened and the
dates match.
If PARM-FUNCTION is P, this means the
9-digit ZIP Code has not been changed by
the USPS since the last time the record
was checked.
If PARM-FUNCTION is C, this means the
file has been closed.
4
If PARM-FUNCTION is O, this means the
database was already opened.
If PARM-FUNCTION is P, this means
either the 9-digit ZIP Code has changed
since the last time the record was
checked, or the ZIP Code was not
numeric.
If PARM-FUNCTION is C, this means the
file wasn't open, and therefore could not
be closed.
8
If PARM-FUNCTION is O, this means the
database could not be opened
successfully, or the dates don't match.
If PARM-FUNCTION is P, this means that
the database was not open.
If PARM-FUNCTION is C, this code is
never returned.
41-65
Working With CODE-1 Plus
Reserved
25
239
3
240
Using the Z4CHANGE Option
Software Release 4.0.0/March 2015
CHAPTER 4
Line of Travel (LTO10)
This chapter describes the Line of Travel (LOT) option, its features and benefits, and
what is involved in using LOT. Although LOT is incorporated in CODE-1 Plus, you
may call the Line of Travel matcher from other applications by calling the Line of
Travel subroutine (program LTO10). This chapter explains the LOT subroutine and
lists the parameters associated with it. Additionally, it explains how to use the LTO60
exit routine to access LOT information from other Pitney Bowes applications.
What is Line of Travel? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Why Use Line of Travel?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Accessing Line of Travel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Getting Started with Line of Travel . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sorting Your LOT Coded Records . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling the LTO10 Subroutine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Area — Parameter 1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Area — Parameter 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COBOL Calling Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The Line of Travel Exit Routine (LTO60) . . . . . . . . . . . . . . . . . . . . . . .
EXITOP Parameter for the LTO60 Exit Routine . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Control Totals Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working With CODE-1 Plus
242
242
243
243
243
244
245
246
248
248
249
250
253
241
4
Line of Travel (LTO10)
What is Line of Travel?
LOT is also referred
to eLOT or
Enhanced Line Of
Travel.
Line of Travel (LOT) is a feature that assigns a code to your address records, allowing
you to qualify your Standard letters and flats for USPS Enhanced Carrier Route rates.
Using Line of Travel, your mailing will be eligible for the USPS non-automation Basic
Rate. To qualify for this rate, your mail must be in LOT sequence. Assigning a LOT
Code to your mailings saves you mailing time and money.
For more
information on nonautomation-based
discounts, refer to
the Domestic Mail
Manual (DMM).
The Line of Travel code indicates the order in which delivery will be made within a
given ZIP + 4 carrier route and whether delivery will be made in ascending or
descending sequence. Line of Travel appends a four digit number and a sequence
code to all name and address records with a ZIP + 4 Code. This LOT code is then used
for sortation purposes to simulate walk sequence mailing within the number range
associated with the ZIP + 4 Code. After the ZIP + 4 file is LOT-coded, the file is then
sorted sequentially by 5-byte ZIP Code, 4-byte carrier route, 4-byte LOT number,
and a 2- or 1-character sequence code.
The information contained in a LOT-coded record includes:
•
ZIP + 4 Code
•
Delivery Point Code (DPC)
•
Carrier Route
•
Line of Travel number
•
Ascending/descending sequence code
•
Optional sequence codes used for sortation provided by the Line of Travel
software.
NOTE: Per USPS regulations, records with missing (blank) or invalid (0000) LOT
information are to be sorted to the end of the CRRT.
Why Use Line of Travel?
For more
information on
these
requirements, refer
to the Domestic
Mail Manual (DMM).
242
Sorting your Standard letters and flats in line-of-travel sequence is the only way to
qualify your mailings for USPS Enhanced Carrier Route rates when your mail does not
meet the non-automation saturation and high-density rate requirements. The
saturation and high-density categories require that your mail be sorted in walksequence. Line of Travel simulates walk-sequence, but only for ten or more pieces per
carrier route.
Software Release 4.0.0/March 2015
Accessing Line of Travel
4
Accessing Line of Travel
There are four ways to invoke Line of Travel:
•
Matcher (C1MATCHB)—Line of Travel information can be returned by setting
a switch in the matcher.
•
LOTOUT parameter—Line of Travel information can be returned via the
CODE-1 Plus batch driver using the LOTOUT parameter.
•
Callable subroutine (LTO10)—You can call LTO10 as a subroutine from any
program, as long as you use the parameters defined in this chapter. The LTO10
callable subroutine determines a 4-digit number and a 1-character sequence
code for a record. These parameters accept your input and return a LOT code.
Based on your output parameter, LTO10 returns the LOT code to your executable
program.
•
Exit Routine (LTO60)—The LTO60 exit routine posts Line of Travel
information onto your name-and-address record when passed from any Pitney
Bowes EXEC- level program. Batch driver processing requirements are passed via
the EXITOP parameter.
NOTE: CODE-1 Plus does not use LTO60. LTO60 is used from other Pitney Bowes
applications.
Getting Started with Line of Travel
Line of Travel derives a Line of Travel (LOT) code, which is comprised of a 4-digit Line
of Travel sequence number and a 1-character Line of Travel sequence code. The Line
of Travel sequence code is either “A” for ascending, or “D” for descending. Line of
Travel then appends the LOT code to all name and address records with a Delivery
Point Barcode and a Carrier Route that matches the Line of Travel Master File.
Sorting Your LOT Coded Records
In order to use Line of Travel to obtain the maximum discount, the USPS Line of Travel
Technical Guide requires that you sort your LOT-coded records in ascending order in
the following sequence:
1. 5-digit ZIP Code
2. 4-byte Carrier Route Code
3. 4-digit Line of Travel Code
Working With CODE-1 Plus
243
4
Line of Travel (LTO10)
NOTE: This includes only the numeric portion of the LOT code. It does
not include the sequence code.
4. 4-digit ZIP + 4 Code
5. 2-digit Delivery Point Barcode in ascending AND descending order
depending on the Line of Travel sequence code that is appended to each record.
NOTE: The Line of Travel sequence code (either “A” or “D”) is essential
for this step.
Since sorting in ascending and descending order can be unwieldy, Line of Travel
returns two types of alternate codes that can be used for sortation. Rather than
sorting your output file using the 2-digit Delivery Point Barcode, you should sort
it using either the alternate sequence code or the hexadecimal sequence code.
The alternate sequence code is a two-byte code used for final sortation in place of
the DPC add-on. It consists of an uppercase letter followed by a digit 0 through
9. Values range from “A0” (99 descending) through “J9” (00 descending), and
“K0” (00 ascending) through “T9” (99 ascending).
The hexadecimal sequence code is a single-byte code, and it also allows you to sort
your file in ascending order only. There are 200 values ranging from 99
descending through 00 descending, then 00 ascending through 99 ascending.
Both the hexadecimal and alternate sequence codes are determined from the
DPC add-on and the LOT sequence code. Refer to Chapter 8 of the CODE-1 Plus
Reference Guide for a table of these codes.
NOTE: You must sort your output file as discussed above prior to presorting your
mailing using, for example, the Pitney Bowes MailStream Plus software.
Calling the LTO10 Subroutine
The LTO10 callable subroutine determines a 4-digit sequence number and a 1character sequence code for a record. In order to call LTO10, you must pass two
parameters:
•
244
Input Parameter — A 50-byte input area containing user-provided data passed
from your executable program to LTO10.
Software Release 4.0.0/March 2015
Calling the LTO10 Subroutine
•
4
Output Parameter — A 100-byte output area containing information returned
from LTO10.
Using the input parameter, you must pass a 5-digit ZIP Code, a 4-digit ZIP + 4 Code,
a 2-digit DPC, and a 4-byte Carrier Route as input.
LTO10 then derives a Line of Travel (LOT) code, which is comprised of a
4-digit Line of Travel sequence number and a 1-character Line of Travel sequence
code. Based on your output parameter, LTO10 returns the LOT code to your
executable program.
The Line of Travel sequence code is either “A” for ascending, or “D” for descending.
Since sorting in ascending and descending order can be unwieldy, Line of Travel
returns two types of alternate codes that can be sorted in ascending order only.
The alternate sequence code is a two-byte code used for final sortation in place of the
DPC add-on. It consists of an uppercase letter followed by a digit 0 through 9. Values
range from “A0” (99 descending) through “J9” (00 descending), and “K0” (00
ascending) through “T9” (99 ascending).
The hexadecimal sequence code is a single-byte code, and it also allows you to sort your
file in ascending order only. There are 200 values ranging from 99 descending
through 00 descending, then 00 ascending through 99 ascending. Both the
hexadecimal and alternate sequence codes are determined from the DPC add-on and
the LOT sequence code. Refer to Chapter 8 of the Reference Guide for a table of these
codes.
Refer to the next two sections for information on these parameters.
Input Area — Parameter 1
The following table maps the positions in input area Parameter 1.
Table 1: Parameter 1 Input Area Positions
Position
1
Name
FUNCTION TO
PERFORM
Length
1
Description
Enter one of the following codes:
E
Perform end-of-job functions, for example,
closing the Line of Travel Master File and
any platform-specific functions. NOTE:
This option will not free memory.
Other
Perform match to the Master File.
2-10
RESERVED
9
These bytes are reserved.
11-15
ZIP CODE
5
The input ZIP Code to be matched against the Line
of Travel Master File.
Working With CODE-1 Plus
245
4
Line of Travel (LTO10)
Table 1: Parameter 1 Input Area Positions
Position
Name
Length
Description
16-19
ZIP + 4 CODE
4
The input ZIP + 4 Code to be matched against the
Line of Travel Master File.
20-21
DELIVERY POINT
CODE
2
The input Delivery Point Code (DPC) add-on.
22-25
CARRIER ROUTE
CODE
4
The input Carrier Route Code to be matched against
the Line of Travel Master File.
26-50
RESERVED
25
Output Area — Parameter 2
The following table maps the positions in output area Parameter 2.
Table 2: Parameter 2 Output Area Positions (Part 1 of 2)
Position
1
2-5
Name
MATCH LEVEL
LINE OF TRAVEL
(LOT) SEQUENCE
NUMBER
Length
1
4
Description
Indicates the level of match obtained against the
Line of Travel Master File.
Blank
Invalid input was presented. Records with
invalid input contain zeroes or non-numeric
data in the ZIP and/or ZIP + 4 Code field or
non-numeric DPC or invalid Carrier Route
Code.
9
Match against the Master File was
successful.
C
Call to matcher failed.
D
Valid input was presented, but no match
was successful with the Master File.
Records with valid input contain numeric,
non-zero data in the ZIP and ZIP + 4 Code
fields, plus a numeric DPC, and a valid
formatted Carrier Route Code.
F
Master file open/read failure.
V
Master file not compatible with Line of
Travel software.
A 4-digit Line of Travel (LOT) sequence number
generated from the input data defined in Parameter
1.
If valid input was presented, but no match was
successful with the Master File, the record is
default coded, and this field contains zeroes. Please
note that default-coded records are eligible for the
basic enhanced carrier route rate.
If invalid input was presented, this field is blank.
246
Software Release 4.0.0/March 2015
Calling the LTO10 Subroutine
4
Table 2: Parameter 2 Output Area Positions (Part 2 of 2)
6
LINE OF TRAVEL
(LOT) SEQUENCE
CODE
1
A 1-character Line of Travel (LOT) sequence code
generated from the input data defined in Parameter
1.
Blank
No LOT number could be determined, due
to invalid input.
A
Ascending
D
Descending
Note: If valid input was presented, but no match was
successful with the Master File, the record will be
default coded, and this code will be returned.
7-8
ALTERNATE
SEQUENCE CODE
2
A two-character code used for final sortation in
place of the DPC add-on, which allows you to sort
your file in ascending sequence only, instead of both
ascending and descending. This code is determined
from the DPC add-on field and the LOT sequence
code. It consists of an uppercase letter followed by
a digit 0 through 9. Values range from "A0" (99
descending) through "J9" (00 descending), and "K0"
(00 ascending) through "T9" (99 ascending).
9
HEXADECIMAL
SEQUENCE CODE
1
A single-character code used for final sortation in
place of the DPC add-on, which allows you to sort
your file in ascending sequence only, instead of both
ascending and descending. This hexadecimal value
is determined from the DPC add-on field and the
LOT sequence code. There are 200 values ranging
from 99 descending through 00 descending, then 00
ascending through 99 ascending.
NOTE: LTO10 returns both an alternate sequence code and a hexadecimal sequence code.
10-13
RESERVED
4
14-17
SOFTWARE
RELEASE
NUMBER
4
The Line of Travel release number, shown as nn.n.
18-19
SOFTWARE
MODIFICATION
NUMBER
2
The Line of Travel modification number, shown as
nn.
20-39
MASTER FILE
IDENTIFICATION
20
The Line of Travel Master File version identification
string.
40-79
MASTER FILE
CREATION
SOFTWARE
IDENTIFICATION
STRING
40
Identifies the version of Line of Travel software that
created the Master File.
80-100
RESERVED
21
Working With CODE-1 Plus
247
4
Line of Travel (LTO10)
COBOL Calling Example
An example for calling the Line of Travel Subroutine can be found in your Sample
Library in member SMPLDLOT. This is a COBOL program that must be compiled
before you run it. You can run it using JCL in member RUNDLOT in your Sample
Library.
The Line of Travel Exit Routine (LTO60)
If you want to post the Line of Travel code to your output file, use the LTO60 exit
routine. You have access to this exit routine via the EXITOP parameter. The EXITOP
parameter is available from most Pitney Bowes EXEC-level programs.
The EXITOP parameter defines your input and locations for your output. You must
pass a 5-digit ZIP Code, a 4-digit ZIP + 4 Code, a 2-digit DPC, and a 4-byte Carrier
Route Code as input.
LTO10 then derives a Line of Travel (LOT) code, which is comprised of a
4-digit Line of Travel sequence number and a 1-character Line of Travel sequence
code, and returns it to the LTO60 exit routine.
The Line of Travel sequence code is either “A” for ascending, or “D” for descending.
Since sorting in ascending and descending order can be unwieldy, Line of Travel
returns two types of alternate codes that can be sorted in ascending order only.
The alternate sequence code is a two-byte code used for final sortation in place of the
DPC add-on. It consists of an uppercase letter followed by a digit 0 through 9. Values
range from “A0” (99 descending) through “J9” (00 descending), and “K0” (00
ascending) through “T9” (99 ascending).
The hexadecimal sequence code is a single-byte code, and it also allows you to sort your
file in ascending order only. There are 200 values ranging from 99 ascending
through 00 descending, then 00 ascending through 99 ascending. Both the
hexadecimal and alternate sequence codes are determined from the DPC add-on and
the LOT sequence code.
The LTO60 exit routine subsequently returns the information to your
Pitney Bowes EXEC-level program.
We present this process graphically in Figure 17 on the next page.
248
Software Release 4.0.0/March 2015
EXITOP Parameter for the LTO60 Exit Routine
4
The following graphic represents how information is processed when you use the
LTO60 exit routine.
Group 1 Program
Input File
Output File
Group 1 EXEC-level Program
PASS INPUT:
ZIP and ZIP+4 Codes,
DPC, CRRT
PASS OUTPUT:
Line of Travel Information
LTO 60 Exit Routine
Call Line of Travel
Information
Return Line of Travel
Information
LTO10 Subroutine
Figure 1: LTO60 Exit Routine Processing
EXITOP Parameter for the LTO60 Exit Routine
The EXITOP parameter allows you to call the LTO60 exit routine.
Working With CODE-1 Plus
249
4
Line of Travel (LTO10)
Field-by-Field
The following table is an overview of the fields on the EXITOP parameter used to
access the LTO60 exit routine.
Table 3: Fields on the EXITOP Parameter (Part 1 of 2)
Position
Description
Comments
1-6
KEYWORD
EXITOP is the only acceptable entry.
Required.
8-15
EXIT ROUTINE
NAME
LTO60 is the only acceptable entry.
Required.
19-22
Location of
ZIP CODE
Location of the input record ZIP Code.
Required.
23
Format of
ZIP CODE
Code indicating the format of your input
record ZIP Code. Enter one of the following:
Required.
LTO60 is dynamically loaded when you
enter this parameter.
C
5-digit ZIP Code in character
format
P
5-digit ZIP Code stored in a 3-byte
packed field
R
9-digit ZIP + 4 Code stored in a 5byte packed field
B
5-digit ZIP Code stored in a 3- byte
binary field
9
9-digit ZIP + 4 Code stored in a 4byte binary field.
24-27
Location of
ZIP + 4 Code
Location of the input record ZIP + 4 Code.
Required.
28
Format of
ZIP + 4 Code
Format of the input record ZIP + 4 Code.
Enter one of the following:
Required.
29-32
250
Field Name
Location of
DELIVERY
POINT CODE
C
Character format
P
3-byte packed field
B
2-byte binary field.
Location of the input record Delivery Point
Code.
Required.
Software Release 4.0.0/March 2015
EXITOP Parameter for the LTO60 Exit Routine
4
Table 3: Fields on the EXITOP Parameter (Part 2 of 2)
Position
33-36
Field Name
Location for
LOT CODE
Description
Location for the 5-character Line of Travel
(LOT) code on the output record.
Comments
Required.
NOTE: If invalid input was presented, this
field will be left blank on the output record.
If valid input was presented, but no match
was successful with the Master File, the
record is default coded, and this field will
contain four zeroes followed by a
descending flag (0000D). Please note that
default-coded records are eligible for the
basic enhanced carrier route rate.
37-40
Location for
ALTERNATE
SEQUENCE
CODE
Location for the 2-character Alternate
Sequence code on the output record.
41-44
Location for
HEXADECIMAL
SEQUENCE
CODE
Location for the 1-character Hexadecimal
Sequence code on the output record.
45-48
Location for
CARRIER
ROUTE CODE
Location for the input record Carrier Route
Code on the output record.
Required.
50
REPORT
SUPPRESSION
CODE
Determines whether the Control Totals
Report will be printed. Enter one of the
following codes:
Optional.
51-66
RESERVED
Blank
The report will be printed (default).
X
The report will not be printed.
Optional.
One of these fields
are required if you
want the program
to help you sort
your records in the
sequence required
by the USPS to
obtain the basic
enhanced carrier
route rate.
These fields are reserved for future use.
NOTE: To allow non-COBOL II driver programs to interface with Line of Travel,
see the section titled “Calling C1PRPT” in Chapter 10 for instructions on using
the COB2INIT and/or COB2INI programs provided.
We will use the following input record for Line of Travel.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7....
JOSEPH.BELL...18684.BLUE.BIRD.DRIVE.......GAITHERSBURG..MD20879-123084C001
Working With CODE-1 Plus
251
4
Line of Travel (LTO10)
The following parameter shows you how to fill out the EXITOP parameter for this
input record.
....+....1....+....2....+....3....+....4....+....5....+....6....+....7..
EXITOP.LTO60.......059C.065C.069.256.261.263.072.X......................
•
EXITOP is the name of the parameter.
•
LTO60 is the name of the exit routine to be called.
•
059 in columns 19-22 defines the location of the input record ZIP Code, and C
in column 23 specifies a character ZIP Code format.
•
065 in columns 24-27 defines the location of the input record ZIP + 4 Code, and
C in column 28 specifies a character ZIP + 4 Code format.
•
069 in columns 29-32 defines the location of the Delivery Point Code.
•
256 in columns 33-36 defines the location for the Line of Travel code on the
output record.
•
261 in columns 37-40 defines the location for the Alternate Sequence Code.
•
263 in columns 41-44 defines the location for the Hexadecimal Sequence Code.
•
072 in columns 46-48 defines the location of the Carrier Route Code.
•
X in column 50 indicates that the Control Totals Report will not be printed.
Based on the EXITOP parameter defined on the previous page, the following picture
shows you how the output record will appear after Line of Travel returns the LOT
code.
Alternate Sequence
Code
200....+....1....+....2....+....3....+....4....+....5....+....6....
..........................................................0028DB5
Line of Travel Code
Hexadecimal
Sequence Code, where
g equals (X"30")
252
Software Release 4.0.0/March 2015
Control Totals Report
4
Control Totals Report
The Control Totals Report shows you statistics about processed, matched, and
unmatched records for a job. This report is printed automatically when your job is
run, unless you type an “X” in position 50 of the EXITOP parameter. If you need to
call Pitney Bowes Customer Support about a problem with any of your jobs, please
have this report handy for reference. Numbers and percentages are listed for the
following:
•
Records Processed — The number of records that were processed from your
input file.
•
Valid Format ZIP Code Presented — The number of records processed that
contained 5-digit ZIP Codes in valid format. 5-digit ZIP Codes in valid format
consist of numeric, non-zero data.
•
Zero Or Non-numeric ZIP + 4 Codes Presented — The number of records
processed that contained zeros or non-numeric data in the ZIP + 4 field.
•
Valid Format ZIP + 4 Code Presented — The number of records processed that
contained 9-digit ZIP + 4 Codes in valid format. 9-digit ZIP Codes in valid format
consist of numeric, non-zero data.
•
Valid Format DPC Values Presented — The number of records processed that
contained 2-digit DPC add-on codes in valid format.
•
Invalid Carrier Route Codes Presented —The number of records processed
that contained a 4-digit Carrier Route Code in invalid format.
•
Valid Carrier Route Codes Presented —The number of records processed that
contained a 4-digit Carrier Route Code in valid format.
•
Records Not Matching Master File, Invalid Input — The number of records
that were not successfully matched against the Line of Travel Master File, due to
invalid input. Records with invalid input contain zeroes or non-numeric data in
the ZIP and/or ZIP + 4 Code field, or a non-numeric DPC or invalid Carrier Route
Code format.
•
Records Not Matching Master File, Default Coded — The number of records
processed that did not match the Line of Travel Master file, but contained valid
input. These records were default coded, which means the LOT code is four zeroes
followed by a descending flag (0000D). Please note that default-coded records do
qualify for the basic enhanced carrier route rate.
•
Records Matching LOT Master File — The number of records processed that
contained valid input and were successfully matched against the Line of Travel
Master File.
•
Line of Travel Codes Determined — The number of records processed that
were LOT coded. This number is equal to number of records matching at the ZIP
+ 4 Code level plus the number of records that were default coded.
•
LOT Numbers with Ascending Sequence Codes — The number of LOT
numbers that are followed by an ascending (A) flag.
•
LOT Numbers with Descending Sequence Codes — The number of LOT
numbers returned that are followed by a descending (D) flag.
Working With CODE-1 Plus
253
4
Line of Travel (LTO10)
•
Alternate DPC Sequence Codes Determined — The number of records
processed for which alternate DPC sequence codes were determined. Please note
that LTO60 returns an alternate sequence code only if positions 37-44 of the
EXITOP parameter are not blank.
Below is an example of the Control Totals Report.
Line of Travel Option
LTO60: Control Totals
Line of Travel Option Master File Version:
Total Records Presented To Processing Logic
Records Processed
Valid Format ZIP Code Presented
Zero Or Non-numeric ZIP+4 Codes Presented
Valid Format ZIP+4 Code Presented
Non-numeric DPC Values Presented
Valid Format DPC Values Presented
Invalid Carrier Route Codes Presented
Valid Carrier Route Codes Presented
Line of Travel Matching Attempts
Records Not Matching Master File, Invalid Input
Records Not Matching Master File, Default Coded
Records Matching Line of Travel Master File
February 2009
5,890
5,890 100.00% of Total Records
5,890 100.00% of Records Processed
884
10.11% of Records Processed
5,006
84.99% of Records Processed
884
15.01% of Records Processed
5,006
84.99% of Records Processed
868
14.74% of Records Processed
5,022
85.26% of Records Processed
5,890
868
319
4,703
Line Of Travel Codes Determined
5,022
LOT Numbers with Ascending Sequence Codes 3,308
LOT Numbers with Descending Sequence Codes 4,703
Alternate DPC Sequence Codes Determined
Line of Travel Option
254
MM/DD/YYYY
5,022
LTO60: Control Totals
14.74% of Matching Attempts
5.42% of Matching Attempts
79.85% of Matching Attempts
65.87% of LOT Numbers
34.13% of LOT Numbers
100.00% of LOT Coded Records
03/14/2009
Software Release 4.0.0/March 2015
CHAPTER 5
Using Delivery Point Validation
This chapter introduces Delivery Point Validation (DPV). It describes what DPV is
and does, its features and benefits, and what is involved in using DPV.
NOTE: The USPS has specific export rules that regulate the distribution of postal
databases. At this time, DPV, LACSLink, and SuiteLink databases are not available to
customers operating outside of the United States. For more information on the USPS
export rules regulating postal databases, go to http://ribbs.usps.gov/.
What is Delivery Point Validation?. . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multiple Matches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is a Multiple Match?. . . . . . . . . . . . . . . . . . . . . . . . . . . .
Getting Started with Delivery Point Validation . . . . . . . . . . . . . . . . . .
Installing the DPV Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delivery Point Validation and Seed Records . . . . . . . . . . . . . . . .
Reporting a Seed Record Match . . . . . . . . . . . . . . . . . . . . . . .
DPV Seed Record Reporting . . . . . . . . . . . . . . . . . . . . . . . . . .
Residential Delivery File Processing . . . . . . . . . . . . . . . . . . . . . . . . .
What is Residential Delivery File Processing? . . . . . . . . . . . . . .
C1DBRDI Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Importing the RDI Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RDI Large Memory Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The DPV Parameters and Return Codes . . . . . . . . . . . . . . . . . . . . . .
DPVIN Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DPVOUT Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Expiration of DPV Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Open/Read Failure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
“Seed Records” and Stop DPV Processing . . . . . . . . . . . . . . . . .
Software Incompatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DPV by List Code Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DPV Processing Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . .
Residential Delivery File Build Report . . . . . . . . . . . . . . . . . . . . . . . .
Residential Delivery File Build Execution Log . . . . . . . . . . . . . . . . . .
Working With CODE-1 Plus
256
256
257
258
258
259
260
263
265
265
266
267
268
268
268
269
269
270
270
270
270
270
271
271
272
272
273
273
255
5
Using Delivery Point Validation
What is Delivery Point Validation?
Delivery Point Validation (DPV) is a new technology product introduced by the
United States Postal Service that will help you validate the accuracy of your address
data, right down to the physical delivery point. This product is available to you only
through a CASS-certified vendor, such as Pitney Bowes.
NOTE: The USPS regulations require Delivery Point Validation (DPV) processing
for CASS certification.
See the section in
this chapter entitled
“DPVIN Parameter”
for more
information on
resolving multiple
matches using DPV
CODE-1 Plus does not validate addresses at the specific delivery-point level; it only
confirms whether an address falls within the low-to-high address range encoded for
the named street. By incorporating the DPV option, CODE-1 Plus can determine
whether the actual address exists, all the way down to the apartment or suite
information. Using the DPV option will reduce your undeliverable-as-addressed
(UAA) mail volume that results from inaccurate addresses, reducing postage costs and
other business costs associated with the handling of inaccurate address information.
DPV will identify
CMRAs and PMBs
DPV will not only confirm the delivery address, it will confirm whether the address is
a commercial mail receiving agency (CMRA) which uses private mail boxes (PMB).
You can use DPV to determine the potential validity of PMB information on an input
address.
DPV won’t create
new address lists.
Although DPV can validate the accuracy of an existing address, it cannot be used to
create address lists. The DPV product is a secure dataset of USPS addresses and does
NOT contain addresses that are not delivered by the USPS.
DPV will help
resolve multiple
matches to the ZIP
+ 4 database.
DPV can also resolve multiple matches from the ZIP + 4 database. This optional
process has the potential for increasing the number of ZIP + 4 coded records in your
address list.
Multiple Matches
With the DPV option, every record ZIP + 4 coded is automatically processed against
the DPV files. DPV can resolve multiple matches to the ZIP + 4 database. Attempting
to resolve ZIP + 4 multiple responses will increase your ZIP + 4 match rate, but will
also increase processing time. For this reason, you may wish to turn off some of these
options.
The DPVIN parameter sets up the options for multiple match conditions. When
verifying proper candidates for DPV processing, the multiple condition is first
checked at the ZIP Code level, Carrier Route, Directional, and then Suffix (or left to
right on the parameter record). There are times when the multiple condition occurs
in multiple categories.
256
Software Release 4.0.0/March 2015
What is Delivery Point Validation?
5
Two other options are available on the DPVIN parameter pertaining the Unique ZIP
and Small Town default assignments and multiple secondary components. The figure
on the following page shows examples of the different types of multiple matches that
can be Delivery Point Validated. Please refer to the section “The DPV Parameters and
Return Codes” for details on how you tell DPV to solve these multiple matches.
What is a Multiple Match?.
Input Addresses
Example of
Multiple
ZIP Code
Match
Example of
Multiple
ZIP Code and
Street Match
Example of
Multiple
Suffix Match
Example of
Multiple
Suffix/Directional
Correction Match
Example of
Multiple
Street Address
Match
Example of
Multiple
Carrier Route
Match
PO Box 155
New York, NY
CODE-1 Plus Results
PO Box 155
New York, NY 10002-0155
PO Box 155
New York, NY 10008-0155
1559 45th Street
Los Angeles, CA
67 Williams St
Woburn, MA 01801
1050 17th Street N
Washington, DC
4 Calle 1
San Juan, PR
107 Pearl Street
Timpsin, TX 75975
1559 E 45th Street
Los Angeles, CA 90011-4341
1559 W 45th Street
Los Angeles, CA 90062-2045
67 Williams Ct
Woburn, MA 01801-1738
67 Williams Ln
Woburn, MA 01801-1216
1050 17th St NW
Washington, DC 20036-5503
1050 17th St NE
Washington, DC 20036-7362
4 Calle 1
San Juan PR 00926-1408
4 Calle 1
San Juan PR 00927-4629
Two post
offices
boxes have
the same
number, but
different ZIP
Codes.
Two streets
with the
same name,
but with
different ZIP
Codes.
67 Williams
Street in
Woburn, MA
does not
exist, but
both 67
Williams Ct
and 67
Williams Ln
do exist.
17th St N
does not
exist in
Washington
DC, but
there is both
a 17th St
NW and a
17th St NE.
In San Juan,
there are two
streets called
Calle 1 with
the same
house
number.
Two different Carrier Routes
result for this address after
processing by CODE-1 Plus:
R002 and R003
Figure 1: Examples of Multiple Matches in CODE-1 Plus
Working With CODE-1 Plus
257
5
Using Delivery Point Validation
Getting Started with Delivery Point Validation
Delivery Point Validation consists of a separate database that you must load on to
your system, just like the CODE-1 Plus database. After the initial installation of the
DPV database, Pitney Bowes will provide you with an updated DPV database
approximately every 120 days.
Before you can run Delivery Point Validation, you must license the DPV option from
Pitney Bowes and install a License Management key as required by the USPS. Please
refer to the License Management Guide for more information on obtaining your
permanent license key for DPV.
Installing the DPV Database
In this section, we provide instructions for installing your DPV database.
Please note that the DPV database has a 120-day expiration cycle. Databases expire
on the following schedule:
Table 1: DPV Database Expiry Cycle
Database Month
Expiration
January
April 30
February
May 31
March
June 30
April
July 31
May
August 31
June
September 30
July
October 31
August
November 30
September
December 31
October
January 31
November
February 28
December
March 31
To install the DPV database in an IBM i environment, complete the following steps:
1. From the Work With Jobs screen, press F20 to access Database Functions.
2. From the Database Functions screen, select option 2: Install Database.
258
Software Release 4.0.0/March 2015
Getting Started with Delivery Point Validation
5
3. On the Install CODE-1 Plus Databases screen (shown below), fill in “Install DPV
Database?” with Y and specify an install source of C for CD-ROM or I for IDS
(downloaded). DPV should be installed into the same library as your US Postal
Database.
HH:MM:SS
MM/DD/YYYY
CODE-1 Plus Name/Address Coding System
Replace with screen heading desired
Install CODE-1 Plus Databases
Specify database installation parameters:
Install US Postal Database?
Reduce US Postal Database?
Include ELOT?
Include Enhanced Street?
Install DPV Flat DB? Install DPV Hash DB? Install DPV Split
DB?
Install LACSLink Database? Install SuiteLink Database?
Install Source . . . . . .
C=CD-ROM, I=Internet
Download
Install to Library . . . . C1PJUL08
F3=Exit
F6=Install
Delivery Point Validation and Seed Records
Seed records are artificially manufactured addresses provided as part of the DPV
option. There are a number of seed records residing in a False/Positive table to
prevent list creation. For each negative response that occurs in a DPV query, a query
must be made to the False/Positive table. A match to this table will stop DPV
processing, but CODE-1 Plus processing will continue to the end of your job.
When you encounter a seed record during processing (i.e. a False/Positive match),
you are required to do two things:
1. Report the seed record match to Pitney Bowes.
2. Get a new license key to turn DPV back on.
You can accomplish both tasks by going to the Pitney Bowes website. Details of how
to do so are provided on the following page.
Working With CODE-1 Plus
259
5
Using Delivery Point Validation
Reporting a Seed Record Match
If you get a match to the False/Positive table, you have matched a seed record, and
you are required to report it to Pitney Bowes per your DPV license agreement. Pitney
Bowes is then required to report it to the USPS. Seed record matches are identified
by individual codes, which you provide to Pitney Bowes when you report a seed
match. The seed code can be found in your execution log, as well as in the DPV
Processing Summary report. Your execution log might say, for example:
THE FOLLOWING CODE IS NEEDED WHEN ACCESSING THE ABOVE-NOTED
GROUP 1 WEBSITE TO OBTAIN YOUR NEW DPV LICENSE KEY.
S0000000000000000
The alphanumeric in bold above is the code you need to report to Pitney Bowes.
As of the September 2004 CASS Cycle, all customers using DPV must keep
information and statistics on the use of the DPV data and report on this data upon
encountering a false-positive seed record. The following information must be
maintained:
•
Mailer’s Company Name
•
Mailer’s Address
•
Mailer’s’ City Name
•
Mailer’s State Name
•
Mailer’s ZIP Code
•
Total Records Processed
•
Total Records DPV Matched.
CODE-1 Plus Batch
CODE-1 Plus Batch DPV customers must use the MAILER parameter records in each
batch (C1BM00) job to indicate the mailer’s Company Name, Address, City Name,
State Name, and ZIP Code. Total Records Processed, Total Records DPV Matched,
and other statistical information will be maintained and reported to the DPVSEED
file.
The DPVSEED — DSF False-Positive File contains all of the necessary information for
reporting a false-positive record. This file must be reported with the DPV Seed Record
Code to obtain a new DPV license from the Pitney Bowes Web site. The layout of the
header and detail records of that file are shown in Tables 6-1 and 6-2.
260
Software Release 4.0.0/March 2015
Getting Started with Delivery Point Validation
5
The header record contains the mailer’s information from the MAILER Parameter
Record and statistics gathered by CODE-1 Plus. The detail record contains DPV falsepositive record information.
Table 2: DPVSEED Header Record
Position
Length
Description
Format
1-40
40
Mailer’s company name
alphanumeric
41-98
58
Mailer’s address line
alphanumeric
99-126
28
Mailer’s city name
alphanumeric
127-128
2
Mailer’s state abbreviation
alphabetical
129-137
9
Mailer’s 9-digit ZIP code
numeric
138-146
9
Total records processed
numeric
147-155
9
Total records DPV matched
numeric
156-164
9
% match rate to DSF
numeric
165-173
9
% match rate to ZIP + 4
numeric
174-178
5
Number of ZIP codes on file
numeric
179-180
2
Number of false positives
numeric
Table 3: DPVSEED Detail Record
Position
Working With CODE-1 Plus
Length
Description
Format
1-2
2
Street pre-directional
alphanumeric
3-30
28
Street name
alphanumeric
31-34
4
Street suffix abbreviation
alphanumeric
35-36
2
Street post-directional
alphanumeric
37-46
10
Address primary number
alphanumeric
47-50
4
Address secondary abbreviation
alphanumeric
51-58
8
Address secondary number
numeric
59-63
5
Matched ZIP code
numeric
64-67
4
Matched ZIP + 4
numeric
68-180
113
Filler
261
5
Using Delivery Point Validation
CODE-1 Plus Interactive
CODE-1 Plus Interactive DPV customers who use the CODE-1 Plus Interactive
screens must run the G1CPDPS job to create the required DPVSEED file after a DPV
Seed Record is encountered.
CODE-1 Plus will automatically log the information needed to create the DPVSEED
file if a DPV Seed Record is encountered while invoking DPV from the CODE-1 Plus
Interactive screens. This information will be stored in the Customization File. Users
must then run the batch job G1CPDPS in order to extract the seed information from
the Customization File and create the DPVSEED file. The Interactive Screens will
prompt the user when a DPV Seed Record has been encountered. Because the
Interactive Screens do not have the ability to record the mailer name and address
data, the user will need to manually insert this information into the DPVSEED file
header record after the file has been created. Please refer to the CODE-1 Plus batch
section for detailed information on the DPVSEED header record.
CODE-1 Plus Callable
CODE-1 Plus Callable DPV customers who call CODE-1 Plus from their own
application must capture the information above in their application interfacing with
the API and write this information to a file.
DPV customers who call CODE-1 Plus from their own application must record certain
information to report to the USPS when a seed record is encountered; this
information must be tracked within the customer’s calling application. This
information includes the house number, street name, and ZIP Code, among others.
Table 6-3 indicates which fields on the P9OUT call area need to be used in order to
properly create the Detail Record of the DPVSEED file.
262
Software Release 4.0.0/March 2015
Getting Started with Delivery Point Validation
5
In order to determine if a DPV Seed Record has been encountered, customers should
examine the field P9ODPVF (P9OUT position 46). If the value in this field is a ‘Y’, a
DPV Seed Record has been encountered and the DPVSEED file must be generated.
Table 4: DPVSEED/P9OUT Map
DPVSEED
Position
DPVSEED
Description
P9OUT
Position
P9OUT
Field Name
1-2
Street pre-directional
813-814
P9ODI1
3-30
Street name
815-842
P9OSTR
31-34
Street suffix abbreviation
843-846
P9OSFX
35-36
Street post-directional
847-848
P9OD12
37-46
Address primary number
803-812
P9OHS-LB
47-50
Address secondary abbreviation
938-941
P9OATP
51-58
Address secondary number
942-949
P9OAP-LB
59-63
Matched ZIP code
1720-1724
P9OCZP
64-67
Matched ZIP + 4
29-32
P9ODPBC
68-180
Filler
N/A
N/A
CODE-1 Plus API Series
CODE-1 Plus customers must capture the information listed above in their
application interfacing with the DPV-called API and write this information to a file.
DPV customers who call the CODE-1 Plus APIs must record certain information to
report to the USPS when a seed record is encountered; this information must be
tracked within the customer’s calling application. This information includes the
house number, street name, and ZIP Code, among others. Table 6-4 indicates which
fields on the output call area need to be used in order to properly create the Detail
Record of the DPVSEED file.
In order to determine if a DPV Seed Record has been encountered, customers should
examine the field cDPVFalPos (C and Java API) or DPVFalPos (Visual Basic API). If the
value in this field is a ‘Y’, a DPV Seed Record has been encountered and the DPVSEED
file must be generated.
DPV Seed Record Reporting
1. Go to My Products.
2. Select CODE-1 Plus.
Working With CODE-1 Plus
263
5
Using Delivery Point Validation
3. Select the appropriate platform with which you are running CODE-1 Plus.
4. Under the Database section, you will see listings for: Delivery Point Validation
(DPV), SuiteLink, and LACSLink. For each, there will be a View Available Downloads
link under the LICENSE column of the Database table. Click this View Available
Downloads link for the database of the function that the violation was incurred.
You have now reported your seed record violation and you must obtain a new key to
continue using DPV processing.
Obtaining a DPV License
To obtain a DPV License, you will need to select, via the license form, one of the
following:
1. New License. To obtain your CODE-1 Plus DPV first time activation license,
contact Pitney Bowes Technical Support. To install this license, execute your
license management installation process. This process is the same the one
executed to install your CODE-1 Plus product license.
2. Batch. If you encounter a DPV Seed Violation with your CODE-1 Plus batch job,
you must enter the Seed Code and attach the Seed File to be issued a
re-activation license. The Seed Code is written out to the PRNTXLG log. You will
also be required to attach the Seed File that is generated by CODE-1 Plus. The
Seed File is defined to CODE-1 Plus using the DPVSEED DD statement that exists
in the JCL, Job Script or Batch file that is used to submit the batch job. Once the
Seed Code and the Seed File have been entered, you can select the Download
License button to acquire your DPV reactivation license. To install the
reactivation license, perform the following:
For Mainframe, execute the LMDBIND JCL.
Interactive. If you encounter a DPV Seed Violation using the Matcher-Inquiry/G1CP
Transaction, please report the address causing the seed violation to Technical
Support. A seed file will be created for you to report via our Support site. You will not
be required to enter a Seed Code if you select the Interactive Seed Violation option.
Once the Seed File has been attached, you can select the Download License button
to acquire your DPV reactivation license. To install the reactivation license, you can
1. Go to My Products.
2. Select CODE-1 Plus.
3. Select the appropriate platform with which you are running CODE-1 Plus.
4. Under the Database section, you will see listings for: Delivery Point Validation
(DPV), SuiteLink, and LACSLink. For each, there will be a View Available Downloads
link under the LICENSE column of the Database table. Click this View Available
Downloads link for the database of the function that the violation was incurred.
You have now reported your seed record violation and you must obtain a new key to
continue using DPV processing.
264
Software Release 4.0.0/March 2015
Residential Delivery File Processing
5
Residential Delivery File Processing
This section discusses Residential Delivery File Processing (RDI) within
CODE-1 Plus. Here, you will find a description of the C1DBRDI program and
instructions for using the Residential Delivery Indicator to run RDI in a CODE-1 Plus
job. You can find a list of supporting reports starting on page 272.
What is Residential Delivery File Processing?
RDI processing can
help you shop for
the lowest delivery
cost.
The Residential Delivery Indicator is a licensed product of the USPS. Residential
Delivery File (RDI) processing can help you determine the best cost for shipping your
packages based upon the fact that some delivery services charge a higher price for
delivery to a residential address than they do to a business address. RDI processing
can help you shop for the lowest delivery cost for a specific address by identifying
whether an address is listed as a business or a residential address in the USPS Address
Management Systems database.
NOTE: You must license the raw RDI file directly from the USPS. RDI data is valid
for CODE-1 Plus processing for 105 days from the 1st day of the month of issue.
For example, the July 2015 RDI data is valid for CODE-1 Plus processing starting
on July 1, 2015 and expires on October 14, 2015.
RDI is designed to be used in conjunction with CODE-1 Plus. It works similarly to the
DPV process, in that the RDI data is supplied as hash tables. However, it is a much
simpler process than DPV in that the standard hash algorithm is only determined for
the 9-digit and 11-digit ZIP Code rather than the entire address.
While this is called Residential Delivery Indicator, the Residential Delivery File also
provides information regarding business deliveries. The residential status of an input
address to which a ZIP + 4 CODE is assigned is determined by the fact that it does
not match to a record in either RDI table.
Turn to page 269 for
more information
on the DPVOUT
parameter and the
RDI flags.
Using the DPVOUT parameter, CODE-1 Plus provides flags that will allow you to
determine between a residential, business, or mixed (residential and/or business)
address.
Building the Residential Delivery File in CODE-1 Plus
There are three major steps you must perform to use RDI in your CODE-1 Plus jobs:
1. Receive the 9-digit and 11-digit hash tables on a CD-ROM from the USPS.
Working With CODE-1 Plus
265
5
Using Delivery Point Validation
2. Run the program C1DBRDI to build the RDI master file.
3. Tell CODE-1 Plus you want to use the RDI option.
C1DBRDI Program
CODE-1 Plus provides the C1DBRDI program so you can build an RDI file as often as
needed. This program builds a Pitney Bowes-formatted file that the RDI lookup
program uses.
In order to build the Residential Delivery Indicator with the RDI file, do the following:
1. Receive the latest RDI file from the USPS.
2. Run C1DBRDI to build the RDI file.
3. Transfer the RDI file to the platform on which you are running
CODE-1 plus.
In the following section, follow the steps to complete building your RDI file.
266
Software Release 4.0.0/March 2015
Building the Residential Delivery File in CODE-1 Plus
5
Importing the RDI Files
1. Using FTP, transfer the files you received from the USPS to the IBM i. You can
transfer the files into the predefined RDI9IN and RDI11IN physical files in your
product library (G1C1PGMS by default) or create your own files with a record
length of 24,566 bytes.
2. Select option 3, Import RDI Tables into Database, from the Database Functions
menu (F20 from the Work with Jobs screen).
3. Fill in RDI File Date, or leave blank to use the current date.
[Time]
[Date]
CODE-1 Plus Name/Address Coding System
Replace with screen heading desired
Import RDI Tables
Enter parameters for RDI table import:
RDI File Date . . . . . . . . . . . . . ______
C1CPDB00
C1CPDB30
[Release]
YYYYMM Format
Input Files:
RDI9IN File . . . . . . . . . . . . . . RDI9IN
Library . . . . . . . . . . . . . . . . G1C1PGMS
Member . . . . . . . . . . . . . . . . . RDI9IN
RDI11IN File . . . . . . . . . . . . . . RDI11IN
Library . . . . . . . . . . . . . . . . G1C1PGMS
Member . . . . . . . . . . . . . . . . . RDI11IN
Output File:
RDIMSTR File . . . . . . . . . . . . . . RDIMSTR
Library . . . . . . . . . . . . . . . . G1C1FILES
F3=Exit
F6=Execute
4. Specify your Input Files. If you have used the defaults noted in step 1, you should
not need to make any changes to the default values. If you have created your own
files, specify their locations here.
5. Specify your Output File. The default is to store RDIMSTR in your default
database library. For CODE-1 to find the file during job execution, it must be
called RDIMSTR and be in the active database library.
6. Press F6 to build the RDI file. After building the RDI file, the Database Functions
screen (C1CPDB01) displays.
7. Review the PRNTXLG spoolfile to ensure the file was successfully built.
8. When you finish using the database functions, press F3 to return to the Work with
Jobs screen (C1CPMM03).
Working With CODE-1 Plus
267
5
Using Delivery Point Validation
Activating the RDI Option
Turn to page 268 for
more information
on the DPVIN
parameter.
Once you have built the RDI file, you can use RDI in your CODE-1 Plus processing.
You turn on the Residential Delivery Indicator system by placing a Y in column 52 of
the DPVIN parameter. The results for your RDI processing will be printed on the
Delivery Point Validation Processing Summary Report.
Turn to page 272 for
a sample of the
Delivery Point
Validation
Processing
Summary Report.
You can also produce an RDI Build Report by placing a Y in column 42 of the
REPORT parameter. Or, you can produce the RDI Counts by List Code Report by
placing a Y in column 44 of the REPORT parameter.
Turn to Chapter 1 of
the Reference
Guide for more
information on the
REPORT
parameter.
RDI Large Memory Module
We offer the RDI Large Memory Module (DPV040L) to improve speed during RDI
processing. Please refer to Chapter 1 of the Reference Guide and the PGMNAM
parameter for more information on using DPV040L.
The DPV Parameters and Return Codes
The DPVIN and DPVOUT parameters accommodate all processing requirements for
Delivery Point Validation certification:
•
Delivery Point Validation Processing (presence of DPVIN parameter record)
•
Delivery Point Validation Options
•
Delivery Point Validation Return Codes
•
Delivery Point Validation Footnote Codes.
DPVIN Parameter
The DPVIN parameter activates DPV processing and provides processing options
based on matches to the ZIP + 4 database.
This parameter record defines the following:
268
•
Multiple match options for ZIP Code and PO Box or RR/HC address type
•
Multiple match options for ZIP Code and street address type
•
Multiple match options for Carrier Route
•
Multiple match options for Directionals
•
Multiple match options for Suffix
•
Multiple match options for Suffix/Directional correction
Software Release 4.0.0/March 2015
The DPV Parameters and Return Codes
5
•
Multiple input secondary components with no designator
•
Option to DPV confirm a unique ZIP/small town default ZIP + 4 assigned by
CODE-1 Plus.
•
Option to bypass DPV secondary address validation and CMRA lookup
•
Option to attempt PBSA Table lookup
•
Option to attempt Residential Delivery File (RDI) processing.
•
Option to determine whether to match against a split file or a flat file
NOTE: The DPV and RDI processing add-on options must be licensed in order for
this parameter and all its options to properly function.
Field-by-Field
For a field-by-field description of the DPVIN parameter, refer to “DPVIN Parameter
Record” on page 69.
DPVOUT Parameter
The optional DPVOUT parameter posts all answers from DPV processing. This
parameter record defines the following:
•
Delivery Point Validation Return Codes
•
Delivery Point Validation Footnote Codes.
•
Location for DPV return code on the output record
•
Location for DPV Commercial Mail Receiving Agency (CMRA) flag on the output
record
•
Location for DPV false/positive flag on the output record
•
Location for DPV Footnote Codes on the output record
•
Location for a PBSA Flag
•
Location for a Residential Flag
•
Location for a Business Flag
•
Option to produce different types of Business Flags.
DPV Footnote Codes are 2-character, USPS-defined codes that represent the changes
that were made to the input address during the matching process. Up to 10 of these
codes can be stored by CODE-1 Plus for each record. Even if your address is not
presented for DPV processing, those footnote codes that pertain to the match to the
ZIP + 4 database will be returned.
Working With CODE-1 Plus
269
5
Using Delivery Point Validation
Field-by-Field
For a field-by-field description of the DPVOUT parameter, refer to “DPVOUT
Parameter Record” on page 75.
Error Messages
Listed below are possible error messages that you may receive while doing your DPV
processing.
NOTE: Although DPV processing may cease during an execution of CODE-1 Plus,
processing will continue to end-of-file. Any DPV errors you encounter will NOT
affect your CODE-1 Plus processing.
Expiration of DPV Processing
The DPV option will stop working at the end of the fourth month from the release of
the database.
If you have an expired DPV database, this message will appear:
****************************************************************************
*DELIVERY POINT VALIDATION SUPPRESSED DUE TO DATABASE EXPIRATION DATE CHECK*
****************************************************************************
Open/Read Failure
If you have an open/read failure on the DPV database, this message will appear:
***********************************
*OPEN/READ FAILURE ON DPV DATABASE*
**********************************
270
Software Release 4.0.0/March 2015
Error Messages
5
“Seed Records” and Stop DPV Processing
Seed records are artificially manufactured addresses provided as part of the DPV
option. There are approximately 5 million seed records residing in a False/Positive
table to prevent list creation. For each negative response that occurs during DPV
processing, a query must be made to the False/Positive table. A match to this table
will stop DPV processing with the error message on the following page:
********************************************************************************
*DPV PROCESSING WAS TERMINATED DUE TO THE DETECTION OF WHAT IS DETERMINED
*
*TO BE AN ARTIFICIALLY CREATED ADDRESS. NO ADDRESS BEYOND THIS POINT HAS
*
*BEEN DPV VALIDATED. IN ACCORDANCE WITH THE LICENSE AGREEMENT BETWEEN USPS
*
*AND GROUP 1 SOFTWARE, DPV SHALL BE USED TO VALIDATE LEGITIMATELY OBTAINED
*
*ADDRESSES ONLY, AND SHALL NOT BE USED FOR THE PURPOSE OF ARTIFICIALLY
*
*CREATING ADDRESS LISTS. THE WRITTEN AGREEMENT BETWEEN GROUP 1 SOFTWARE AND
*
*ANY CUSTOMER OF GROUP 1 SOFTWARE SHALL ALSO INCLUDE THIS SAME RESTRICTION
*
*AGAINST USING DPV TO ARTIFICIALLY CREATE ADDRESS LISTS. CONTINUING USE OF
*
*DPV REQUIRES COMPLIANCE WITH ALL TERMS OF THE LICENSE AGREEMENT. IF YOU
*
*BELIEVE THIS ADDRESS WAS IDENTIFIED IN ERROR,PLEASE CONTACT GROUP 1 SOFTWARE. *
*DPV LICENSE UPDATE URL:HTTP://WWW.G1.COM/SUPPORT/LICENSE/DPV.ASP THE FOLLOWING*
*CODE IS NEEDED WHEN ACCESSING THE ABOVE-NOTED GROUP 1WEBSITE TO OBTAIN YOUR
*
*NEW DPV LICENSE KEY.S9999999999999999
*
********************************************************************************
NOTE: To continue DPV processing, you must provide the Seed Code listed in the
error message to the Pitney Bowes website. When you provide this Seed Code you
will receive another permanent License Management key which will allow you to
continue your DPV processing.
Software Incompatibility
If your software is not compatible with ZIP + 4 database (or master file), this error
message will appear:
************************************************************************
*DPV MASTER FILE IS NOT COMPATIBLE WITH THE DPV SOFTWARE. DPV DISABLED.*
************************************************************************
Working With CODE-1 Plus
271
5
Using Delivery Point Validation
DPV by List Code Report
The DPV by List Code Report shows you the results of your DPV processing by list
code. This report is printed automatically when your job is run, unless you have an N
in column 40 of the REPORT parameter. If you need to call Pitney Bowes Customer
Support about a problem with any of your jobs, please have this report handy for
reference. You will find the following information on this report:
•
All of the list codes used in DPV processing
•
Total number of records presented for DPV processing
•
Total number of DPV validated records
•
Total number of streets DPV validated
•
Total number of high rises DPV validated
•
Total number of PO Boxes DPV validated
•
Total number of Rural Routes/Highway Contractors DPV validated
•
Total number of Firms DPV validated
•
Total number of General Delivery DPV validated
•
Total number of primary number errors
•
Total number of secondary number errors.
DPV Processing Summary Report
The DPV Processing Summary Report is printed automatically when your job is run,
unless you have an N in column 38 of the REPORT parameter. If you need to call
Pitney Bowes Customer Support about a problem with any of your jobs, please have
this report handy for reference. Numbers and percentages are listed for the following:
272
•
Delivery Point Validation attempts with percentages
•
Multiple attempts confirmed
•
Unique/Small Town Default ZIP + 4 confirmed
•
Number of ZIP + 4 coded records
•
Street Records validated
•
High Rise Records validated
•
PO Box Records validated
•
Rural Route/Highway Contract Records validated
•
Firm Records validated
•
Primary Number Errors
•
Secondary Number Errors
•
Total Residential/Business (RDI) attempts
•
Total Residences
Software Release 4.0.0/March 2015
Residential Delivery File Build Report
5
•
Total Businesses—broken down by firms, streets, high rises, rural routes, PO
Boxes, and general delivery
•
False/Positives.
NOTE: A zero in the False/Positive section indicates that you did not hit any seed
records during your DPV processing. A one indicates that you hit a seed record,
which halted your DPV processing.
Residential Delivery File Build Report
You will find the following information on this report:
•
The parameter records given
•
Control Totals for your RDI build job.
Residential Delivery File Build Execution Log
You will find the following information on the execution log:
•
The date and time of the RDI File build
•
The number of 9-digit input records
•
The number of 11-digit input records.
Working With CODE-1 Plus
273
5
274
Using Delivery Point Validation
Software Release 4.0.0/March 2015
CHAPTER 6
Auxiliary File Processing
This chapter discusses the Auxiliary File Processing within CODE-1 Plus. A
description of the C1AUXBLD program, instructions for using the Early Warning
System (EWS) to run the Auxiliary File Option in a CODE-1 Plus job, and supporting
reports are included.
What is the Early Warning System? . . . . . . . . . . . . . . . . . . . . . . . . . .
Auxiliary File Processing and EWS . . . . . . . . . . . . . . . . . . . . . . . .
Building the Auxiliary File with the Early Warning System . . . . . . .
C1AUXBLD Utility Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Building Your Auxiliary File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AUXIL Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Field-by-Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Activating the Auxiliary File/EWS File Option. . . . . . . . . . . . . . . . . . .
EWS With C1BM00 (submitting through screens) . . . . . . . . . . . .
EWS When Calling C1MATCHx or C1BMCBD. . . . . . . . . . . . . . . .
Auxiliary File Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Auxiliary File Build (C1AUXBLD) Reports. . . . . . . . . . . . . . . . . . .
Auxiliary File Build Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Auxiliary File Build Execution Log . . . . . . . . . . . . . . . . . . . . . . . . . . .
Auxiliary File Reporting in the CODE-1 Plus Matcher. . . . . . . . . . . .
Working With CODE-1 Plus
276
276
277
277
277
279
279
280
281
281
281
282
282
282
283
283
275
6
Auxiliary File Processing
What is the Early Warning System?
The Early Warning System (EWS) was devised by the USPS to prevent address records
from miscoding due to a delay in postal data reaching the USPS address matching
files. The less recent the ZIP + 4 File, the higher potential you have for miscoding
addresses. When a valid address is miscoded because the matching address in the ZIP
+ 4 File is inexact, it will result in what is termed a “broken address.” Once an address
is broken, the effect is permanent without manual intervention.
Using the EWS Auxiliary File with CODE-1 Plus will prevent “broken addresses.” EWS
contains records with partial address information limited to the ZIP Code, street
name, pre- and post-directionals, and a suffix. For an address record to be EWSeligible, it must be an address not present on the most recent monthly production
ZIP + 4 File.
Auxiliary File Processing and EWS
CODE-1 Plus implements EWS through Auxiliary File processing. There are two steps
to setting up your auxiliary file. First, you must reformat the record into a structure
recognizable by the CODE-1 Plus matching engine. Second, CODE-1 Plus must
recognize the additional auxiliary file.
For more on the
Control Totals
Report, please refer
to Chapter 11 of
Getting Started
With CODE-1 Plus.
When you activate the Auxiliary File, addresses that match to the EWS File will not be
coded. CODE-1 Plus will report these records as neither matched nor mismatched
records. Additionally, addresses that match to the EWS file will appear on the Control
Totals Report as “Confirmed via Match to Auxiliary File.”
NOTE: You must build the Auxiliary File using the C1AUXBLD program, supplied
with your CODE-1 Plus software. On the Database Functions menu, this is option 9.
NOTE: The USPS refreshes the EWS file on a weekly basis (Thursdays). You can
download the EWS file from the USPS website at http://ribbs.usps.gov/files/CASS/
It is a line sequential file containing about 4000 records and is about 350 KB in
size. The numbers are subject to change.
276
Software Release 4.0.0/March 2015
Building the Auxiliary File with the Early Warning System
6
Building the Auxiliary File with the Early Warning System
There are three major steps you must perform to use EWS in your CODE-1 Plus jobs:
•
Step 1 — Download the latest EWS File from the USPS website,
http://ribbs.usps.gov/files/CASS/.
•
Step 2 — Translate the downloaded EWS File into a form that is recognized by
CODE-1 Plus by using the C1AUXBLD utility.
•
Step 3 — Tell CODE-1 Plus you want to use the translated EWS database, the
Auxiliary File, in your job by using the AUXIL1 parameter.
Each step is detailed below, with platform-specific detail where needed.
C1AUXBLD Utility Program
CODE-1 Plus provides the C1AUXBLD utility program so you can build an EWS file
as often as needed. This utility builds a Pitney Bowes-formatted file that will be
utilized by the EWS module/lookup program.
In order to build the Auxiliary File with the EWS File, do the following:
1. Download the latest EWS File from the USPS website, http://ribbs.usps.gov/files/
CASS/.
2. Unzip the file and transfer it to the platform on which you are running
CODE-1 Plus.
NOTE: For non-PC-based platforms, convert to a fixed length file with a
record length of 89 bytes. Also, if transferring to a mainframe platform, be
sure the character set is converted to EBCDIC. There are approximately
4,000 records on the EWS file, which are subject to change.
In the following section, follow the steps to complete building your Auxiliary File.
Building Your Auxiliary File
To build your Auxiliary File, follow these steps:
1. Create a file (CRTPF) on your IBM i with a record length of 89.
2. FTP or otherwise upload the EWS file into the file you just created.
Working With CODE-1 Plus
277
6
Auxiliary File Processing
3. From the Work With Jobs screen, press F20 to access the Database Functions screen
(shown below).
CODE-1 Plus Name/Address Coding System
Replace with screen heading desired
Database Functions
Select one of the following:
1. Reduce CODE-1 Plus Database
2. Install Database
3. Import RDI Tables into Database
5.
6.
7.
8.
9.
10.
11.
P.
Print CODE-1 Plus Database Detail Reports
Print CODE-1 Plus Database State Size Report
Display CODE-1 Plus Database Information
Change default CODE-1 Plus Database Library
Convert EWS file into CODE-1 Plus format
Load License Management key file
Print License Management report
Display encrypted administration password
Option
__
F3=Exit
4. Select Option 9: Convert EWS file into CODE-1 Plus format.
5. On the next screen, fill in the Input EWS file parameters with the name of the file
you created. The output file is automatically placed in your database library. The
Output File and Address Element Locations are not changeable at this time.
HH:MM:SS
MM/DD/YYYY
CODE-1 Plus Name/Address Coding System
Replace with screen heading desired
Database Functions
MMCPDB00
C1CPDB20
Rls XX.X
[AUXIL] Enter parameters for EWS file conversion:
Input EWS file . . . . . . . . . . . . .
Library . . . . . . . . . . . . . . .
Member . . . . . . . . . . . . . . . . . *FIRST
Format . . . . . . . . . . . . . . . . . E
A, E
A=Street, Suffix, Direcs in single addr line, E=Address elements separately
Output work file . . . . . . . . . . . . G1C1AUX
Library. . . . . . . . . . . . . . . . C1DBFILES
Member . . . . . . . . . . . . . . . . . G1C1AUX
Address Element Locations:
Pos
Len
5-digit ZIP. . . . . . . . . . . . . . .
1
Street Name/Address Line . . . . . . . .
8
28
Street Suffix. . . . . . . . . . . . . .
36
Pre-directional. . . . . . . . . . . . .
6
Post-directional . . . . . . . . . . . .
40
House Range. . . . . . . . . . . . . . .
Secondary Range. . . . . . . . . . . . .
Secondary Designator . . . . . . . . . .
______________________________________________________________________________
__
F3=Exit
F6=Execute
6. Press F6 to run the conversion. When you return to the menu, your file has been
successfully converted and can be used as input to your CODE-1 job using the
AUXIL1 parameter.
278
Software Release 4.0.0/March 2015
AUXIL Parameter
6
AUXIL Parameter
The AUXIL parameter is used with the C1AUXBLD program, and is used to define the
field positions on the input Auxiliary File. This parameter record defines the
following:
•
Input file number and format
•
5-Digit ZIP location
•
Street name/address line length and location
•
Street suffix, pre-directional, post-directional, house range, secondary range, and
secondary designator locations.
Field-by-Field
The following table is an overview of each field on the AUXIL parameter record.
Table 1: Fields on the AUXIL Parameter Record (Part 1 of 2)
Position
Field Name
Description
Comments
1-5
KEYWORD
AUXIL is the only acceptable entry.
Required.
6
NUMBER OF THE
INPUT FILE
Only numbers 1 through 9 are
acceptable in this position.
Required.
8
FORMAT OF
INPUT
PARAMETER
Code indicating the format type of your
input parameter. Choose one of the
following codes:
Required.
A
Street, Suffix, and Directionals
in a single address line.
E
Address elements separate.
10-12
Location of
5-DIGIT ZIP CODE
Location on the input record of the
5-digit ZIP Code.
Optional.
14-16
Location of
STREET NAME/
ADDRESS LINE
Location on the input record of the street
name or address line.
Optional.
18-19
Length of
STREET NAME/
ADDRESS LINE
Length of the street name or address
line.
Optional.
21-23
Location of
STREET SUFFIX
Location on the input record of the street
suffix.
Optional.
25-27
Location of
PREDIRECTIONAL
Location on the input record of the predirectional information.
Optional.
Working With CODE-1 Plus
279
6
Auxiliary File Processing
Table 1: Fields on the AUXIL Parameter Record (Part 2 of 2)
Position
Field Name
Description
Comments
29-31
Location of
POSTDIRECTIONAL
Location on the input record of the postdirectional information.
Optional.
33-35
Location of
HOUSE RANGE
Location on the input record of
20-character house range formatted as
follows: 10-character low range
followed by 10-character high range.
Optional.
NOTE: If there is no house range
information in the input record, populate
this field with leading zeros.
37-39
Location of
SECONDARY
RANGE
Location on the input record of
16-character secondary range
formatted as follows: 8-character low
range followed by 8-character high
range.
Optiona.l
NOTE: If there is no secondary range
information in the input record, populate
this field with leading zeros.
41-43
Location of
SECONDARY
DESIGNATOR
Location on the input record of the
secondary designator.
Optional.
Example
In this example we specify that:
•
The number of the input file is 1
•
The address elements are separate in the input file
•
The 5-digit ZIP Code starts in position 62
•
The street name starts in position 22
•
The length of the street name is 15
•
The street suffix starts in position 40
•
The pre-directional information starts in position 20
•
The post-directional information starts in position 38
•
There is no house range information in the input record
•
There is no secondary range information in the input record
•
We do not include a location for a secondary designator.
....+....1....+....2....+....3....+....4....+....5....+....6....+
AUXIL1.E.62..22..15.40..20..38..000.000..........................
280
Software Release 4.0.0/March 2015
Activating the Auxiliary File/EWS File Option
6
Activating the Auxiliary File/EWS File Option
For more
information on the
Input Call Area, see
Chapter 8.
Auxiliary File matching is only available through the CODE-1 Plus batch driver
(C1BM00), the callable batch driver (C1BMCBD), or a user-defined program calling
the batch matcher C1MATCHx.
EWS With C1BM00 (submitting through screens)
Use the Submit CODE-1 Plus Job screen below to create the AUXIL1 parameter record
and indicate the location and usage of the EWS file during job submission:
CODE-1 Plus Name/Address Coding System
Replace with screen heading desired
Submit CODE-1 Plus Job
[AUXIL1] Enter auxiliary reference file information, if desired:
Use Auxiliary reference file? N Y, N
Auxiliary reference file . . . . . . . . . . . . . . . .
Library. . . . . . . . . . . . . . . . . . . . . . . . .
Member . . . . . . . . . . . . . . . . . . . . . . . . .
File Location. . . . . . . . . . . . . . . . . . . . . .
N=Write to NCO file
C=Write to COK file
N, C
Bottom
F3=Exit
F6=Submit
F7=Parm Test
If CODE-1 Plus detects an EWS file in the database library, the filename is
automatically filled in, and CODE-1 Plus will create an override for G1C1AUX.
EWS When Calling C1MATCHx or C1BMCBD
When calling C1MATCHx through a user-defined program, you must populate
P9IAUX as defined in the Input Call Area (P9IN).
When using C1BMCBD to activate and match to the Auxiliary File, you must include
the AUXIL1 parameter in your CODE-1 Plus batch job. This is not the same
parameter used in the C1AUXBLD program. The AUXIL1 parameter for the
CODE-1 Plus batch driver is as follows:
....+....1....+....2....+....3....+....4....+....5
AUXIL1............................................
Working With CODE-1 Plus
281
6
Auxiliary File Processing
When calling C1MATCHx or C1BMCBD, you must make the Auxiliary File known to
CODE-1 Plus by defining it in your job control set-up script as G1C1AUX. This file
definition should be overridden to the file you created using the C1AUXBLD program
described earlier in this chapter.
NOTE: The Auxiliary matcher is not available as a stand-alone program or as a
callable routine.
Auxiliary File Reports
In this section, we describe the two reports that are generated when using the
Auxiliary File Option in CODE-1 Plus.
Auxiliary File Build (C1AUXBLD) Reports
The Auxiliary File Build program (C1AUXBLD), generates a standard Pitney Bowes job
report (PRNTRPT) and an execution log (PRNTXLG). The report lists the parameter
record given and the control totals for the job. The execution log shows when the job
started and ended. You should check both reports for any error messages.
NOTE: Because of the way the Auxiliary File is built for use by CODE-1 Plus, the
number of records read will not equal the number of records written to the output
G1C1AUX Auxiliary File.
On the following pages are descriptions of the two reports from the C1AUXBLD
program.
Auxiliary File Build Report
You will find the following information on this report:
282
•
The parameter record given
•
Control totals for your Auxiliary File build job.
Software Release 4.0.0/March 2015
Auxiliary File Build Execution Log
6
Auxiliary File Build Execution Log
You will find the following information on the execution log:
•
The date and time of the Auxiliary File build
•
The number of records read
•
The number of virtual records written
•
The number of actual records written.
Auxiliary File Reporting in the CODE-1 Plus Matcher
There are no new or separate reports from the CODE-1 Plus matcher as a result of
Auxiliary File matching. The records presented to the CODE-1 Plus matcher that
match to the Auxiliary File will show on a new line of the Control Totals Report under
the heading “Confirmed via Match to Auxiliary File.” These records will not be
included in the counts for any of the following major headings on the Control Totals
Report:
For more
information on the
Control Totals
Report and the PS
Form 3553, please
refer to Chapter 11
of Getting Started
With CODE-1 Plus.
•
Total records for which Address Match attempted
•
Total Unmatched Records
•
Total Records successfully Matched.
Another new report line, “Total records Matched to EWS,” will appear on the Control
Totals Report when there are EWS matching records. This count will also appear on
the PS Form 3553 in Section E under the heading of EWS.
Working With CODE-1 Plus
283
6
284
Auxiliary File Processing
Software Release 4.0.0/March 2015
CHAPTER 7
Using G1G001
This chapter discusses the executable routine G1G001, which enables you to print
detailed reports using your coded records output file. The module is explained, along
with each of the parameters used to execute the module. Additionally, sample
control language is included.
What is G1G001? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using G1G001 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input File and Header/Footer Parameters. . . . . . . . . . . . . . . . . . . . .
FILEDF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HEADER. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HEADxx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UFTxx. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UHDxx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Report Layout and Content Parameters. . . . . . . . . . . . . . . . . . . . . . .
CONTRL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONSTANT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FORMAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MOVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGESZ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TESTIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UNPK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Record Selection Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SELECT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CHANGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sample Control Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working With CODE-1 Plus
286
286
286
287
288
289
290
291
292
292
295
295
298
299
300
301
302
302
303
303
285
7
Using G1G001
What is G1G001?
Use the G1G001 program to print customized reports of records from CODE-1 Plus
output files (CODE-1 Plus output file becomes the G1G001 input file). You can:
•
Define which record elements to print on the report
•
Format those input elements with constant data
•
Print multiple 132-character print lines per input record
•
Print a main header and a date on your reports
•
Print up to three lines of additional header
•
Select or reject records to print based on a list code or a mismatch reason code.
If you use a mismatch reason code, you also have the option of printing a
20-character reason (derived from the reason code)
•
Select records by comparing pairs of fields in a single record: if the value of the
first field is different from the value of the second field, the record will print
•
Include or exclude a specific number of records
•
Limit the report to a specific number of pages.
Using G1G001
To use G1G001, define parameters to perform the following functions:
•
Identify your input file.
•
Print Header information on your report.
•
Identify the content and layout of your print lines.
•
Select or reject records for processing.
When printing multiple print lines for each input record, the order of the parameters
makes a difference. Parameters that affect a print line should be grouped together.
After defining your parameters, you will write control language and submit the job.
Input File and Header/Footer Parameters
The following parameters are used to define your input file and the header and footer
lines that are to print on your reports:
286
•
FILEDF
•
HEADER
•
HEADxx
•
UFTxx
•
UHDxx.
Software Release 4.0.0/March 2015
Input File and Header/Footer Parameters
7
FILEDF
The required FILEDF parameter enables you to define the input file for the G1G001
program.
Field-by-Field
Table 1: FILEDF Parameter Fields (Part 1 of 2)
Position
Field Name
Description
Comments
1-6
KEYWORD
FILEDF is the only acceptable entry.
Required.
8-15
FILE NAME
Name of the input or output file. Enter
the following name:
Required.
No default.
G1GNAM Input file
NOTE: For VSE, use SYS010 for tape.
17
RECORD FORMAT
Code indicating whether the records in
the file are fixed-length.
F
Required.
Default is F.
Records are fixed-length.
19-22
RECORD LENGTH
The length, in bytes, of the records in the
file.
Required.
No default.
24-28
BLOCK SIZE
The size, in bytes, of the blocks in the file.
Required.
No default.
30-33
DEVICE TYPE
The type of device on which this file
resides. Enter one of the following
codes:
Required for
VSE.
Not used for
MVS, Unix, or
VAX.
Default is
TAPE.
TAPE
2311
2314
3310
3330
3340
3350
3370
3375
3380
FBA
35
39-46
Working With CODE-1 Plus
LABEL TYPE
EXIT ROUTINE NAME
Code indicating whether the records on
the file have standard or omitted labels.
Enter one of the following codes:
N
No labels
S
Standard labels.
Name of the input exit routine that
should be called when G1G001 is ready
to read a record from this file, or the
name of the output exit routine that
should be called when G1G001 is ready
to write a record to the file.
Required for
VSE.
Default is S.
Optional.
No default.
Name must be
entered leftjustified.
287
7
Using G1G001
Table 1: FILEDF Parameter Fields (Part 2 of 2)
Position
Field Name
Description
Comments
50-56
NUMBER OF
RECORDS TO SKIP
Number of records G1G001 should skip
before selecting the first record.
Optional.
No default.
58-64
CROSS-SECTIONAL
SAMPLING
Number indicating the portion of the
records in the file that should be
processed. G1G001 assumes a decimal
point before the first digit.
Optional.
No default.
66-72
MAXIMUM NUMBER
OF RECORDS
Maximum number of records G1G001
should read from or write to this file.
Optional.
No default.
HEADER
The required HEADER parameter enables you to define a date and header text that
identifies the report.
Field-by-Field
Table 2: HEADER Parameter Fields
Position
288
Field Name
Description
Comments
1-6
KEYWORD
HEADER is the only acceptable entry.
Required.
8-17
DATE
The date that G1G001 was executed. If
you leave this field blank, the current
system date is printed on your report.
Optional.
Default is
current
system date.
19-58
HEADER TEXT
Any text that identifies the report.
Optional.
No default.
Software Release 4.0.0/March 2015
Input File and Header/Footer Parameters
7
HEADxx
The optional HEADxx parameter enables you to define up to three additional header
lines to print at the top of the report. You can define up to six HEADxx parameters
(two for each line).
Field-by-Field
Table 3: HEADxx Parameter Fields
Position
Field Name
Description
Comments
1-4
KEYWORD
HEAD is the only acceptable entry.
Required.
5-6
HEADING LINE
DESIGNATOR
One of the following codes to determine the line
number and line side on which this header text
should be printed:
Required.
No default.
1A
Left side, line 1
1B
Right side, line 1
2A
Left side, line 2
2B
Right side, line 2
3A
Left side, line 3
3B
Right side, line 3
The left side refers to positions 1-66, the right side
refers to positions 67-132.
7
8-73
Working With CODE-1 Plus
SPACE BEFORE
HEADER (for this
heading print
line)
HEADER TEXT
Enter one of the following codes to tell G1G001 how
many blank lines should be printed before this
header line:
S
Single space (no blank lines)
D
Double space (one blank line)
T
Triple space (two blank lines).
Any text that you want printed on the top of your
report. If you include the string “MM/DD/YY” or
“MM/DD/YYYY” in this field, G1G001 will print the
date specified in columns 8-17 of the HEADER
parameter in your header text. If columns 8-17 on
the HEADER record are blank, the current system
date will be used. For example, if MM/DD/YY is
specified, then columns 8-15 will be “05/19/10”. If
MM/DD/YYYY is specified, then columns 8-17 will
be “05/19/2010”.
Optional.
Default is S.
Optional.
No default.
289
7
Using G1G001
UFTxx
The optional UFTxx parameter enables you to specify any text to print at the bottom
of every page of each report. You can specify up to four footer lines.
Field-by-Field
The following table is an overview of each field on the UFTxx parameter.
Table 4: UFTxx Parameter Fields
Position
Description
Comments
1-3
KEYWORD
UFT is the only acceptable entry.
Required.
4
LINE NUMBER
The footer line number. Enter 1, 2, 3, or
4.
Required.
No default.
5
LINE SIDE
The side of the footer line on which this
text should appear. Enter one of the
following codes:
Required.
No default.
7-72
290
Field Name
FOOTER TEXT
A
Left side of the line
B
Right side of the line.
The text that you want to appear at the
bottom of every page of each report.
Required.
No Default.
Software Release 4.0.0/March 2015
Input File and Header/Footer Parameters
7
UHDxx
The optional UHDxx parameter enables you to specify any additional text to print at
the top of each page of each report. You can specify up to four additional header
lines.
Field-by-Field
The following table is an overview of each field on the UHDxx parameter.
Table 5: UHDxx Parameter Fields
Position
Field Name
Description
Comments
1-3
KEYWORD
UHD is the only acceptable entry.
Required.
4
LINE NUMBER
The header line number. Enter 1, 2, 3, or
4.
Required.
No default.
5
LINE SIDE
The side of the header line on which this
text should appear. Enter one of the
following codes:
Required.
No default.
7-72
Working With CODE-1 Plus
HEADER TEXT
A
Left side of the line
B
Right side of the line.
The text that you want to appear at the
top of each page of every report.
Required.
No Default.
291
7
Using G1G001
Report Layout and Content Parameters
The following parameters define how the report lines look and what data prints on
them:
•
CONTRL
•
CONSTANT
•
FORMAT
•
MOVE
•
PAGESZ
•
TESTIT
•
UNPK.
NOTE: G1G001 does not generate the Execution Log.
This section describes these parameters in detail.
CONTRL
The required CONTRL parameter enables you to define the following information:
292
•
Location and length of the key code in the input records (this key code will be
compared to the value entered on the SELECT parameter, explained later in this
chapter, to determine if the record is to be printed).
•
Number of pages that are to be printed.
•
Whether or not page numbers are to be printed on the report.
Software Release 4.0.0/March 2015
Report Layout and Content Parameters
7
•
Location of the mismatch reason code in the input record, and the location on
the print line for the mismatch reason.
•
Whether to print the report in mixed case or upper case.
The following table lists the mismatch reason codes for G1G001. These are codes
that CODE-1 Plus stores as General Return Codes. You can identify the mismatch
reason code location in your input record as the location where CODE-1 Plus stored
the General Return Code.
Table 6: General Return Codes.
A
Apartment match
required
M
Multiple matches
B
Insufficient address
P
Unmatched post-code
C
Unmatched city name
R
Rte Srvc not found
D
Out of sequence
S
Unmatched street
E
External File Match
U
Not attempted
F
Unmatched FSA
V
Non-deliverable ZIP + 4
H
Unmatched house/box
X
Out of sequence
I
Unmatched initial
Z
Unmatched ZIP Code
L
Locality failure
Field-by-Field
The following table is an overview of each field on the CONTRL parameter.
NOTE: All input record position fields can be extended one column to the left to
accommodate 4-byte positions, if necessary.
Table 7: CONTRL Parameter Fields (Part 1 of 2)
Position
Field Name
Description
Comments
1-6
KEYWORD
CONTRL is the only acceptable entry.
Required.
8-10
KEY CODE
LOCATION
The starting position in the input record
of the key code.
Required.
No default.
12
LENGTH OF KEY
CODE
The length of the key code in the input
record.
Required.
No default.
Working With CODE-1 Plus
293
7
Using G1G001
Table 7: CONTRL Parameter Fields (Part 2 of 2)
Position
294
Field Name
Description
Comments
14-16
NUMBER OF PAGES
The maximum number of pages of the
report that are to be printed.
Optional.
Default is to
print the entire
file.
18
PAGE NUMBERS
Enter a “P” in this column if you want
page numbers printed on your report.
These page numbers will be printed in
positions 125-132 of the first header line.
Optional.
No default.
20-22
MISMATCH REASON
CODE LOCATION
The position in the input record of the
1-character mismatch reason code. Only
records with a non-blank character in
this position will be eligible for printing.
If you do not enter a location, all records
will be eligible for printing.
Optional.
No default.
24-26
MISMATCH REASON
PRINT POSITION
The position on the print line for the
20-character mismatch reason (derived
from the mismatch reason code).
Optional.
No default.
28
PRINT UPPER/
LOWER CASE
Enter one of the following codes to
specify whether your report is to be
printed in all upper case or in mixed
case.
Optional.
Default is Y.
N
Print in mixed case.
Y
Print in all upper case.
Software Release 4.0.0/March 2015
Report Layout and Content Parameters
7
CONSTANT
The optional CONSTANT parameter enables you to define constants to print on the
reports. With the CONSTANT parameter, you can define the data that is the constant,
but not where on the report line that constant is to be printed. You can use MOVE
and FORMAT parameters to specify where to print the constants on the report line.
There are up to eight CONSTANT parameters available, each specifying a single
constant.
Field-by-Field
Table 8: CONSTANT Parameter Fields
Position
Field Name
Description
Comments
1-8
KEYWORD
CONSTANT is the only acceptable entry.
Required.
9-10
CONSTANT ID
NUMBER
The number that identifies this constant:
01 - 08. The constant will later be
referenced by C01-C08.
Required.
No default.
12-21
CONSTANT DATA
The data string that is to be associated
with this CONSTANT ID NUMBER. You
can use leading and trailing blanks.
However, depending on the length you
specify for printing the constant on the
MOVE or FORMAT parameters, trailing
blanks can be truncated.
Required.
No default.
FORMAT
The optional FORMAT parameter specifies print line locations for several elements
of your input file and/or constants. G1G001 will concatenate these fields and
constants according to the following rules:
•
FORMAT parameters are executed in the order in which they are defined.
•
The first field to be formatted must not be a constant.
•
There must be at least two fields to be formatted.
•
Two consecutive non-constant fields (i.e., input record elements) automatically
have a space between them.
•
All leading blanks of non-constant fields (i.e., input record elements) are
suppressed and are not printed on the print line.
•
No spaces print between constants and input record elements unless enabled for
in the length of the constant. (In other words, if there is a 2-byte constant, and
you want to print a space between the constant and the input record element that
follows it, define a length of 3 for the constant.)
Working With CODE-1 Plus
295
7
Using G1G001
Field-by-Field
NOTE: All input record position fields can be extended one column to the left to
accommodate 4-byte positions, if necessary.
Table 9: FORMAT Parameter Fields (Part 1 of 2)
Position
296
Field Name
Description
Comments
1-6
KEYWORD
FORMAT is the only acceptable entry.
Required.
7-8
COMMENT
You can enter any value you wish here to
identify this format operation; G1G001
will ignore this field.
Optional.
No default.
10-12
PRINT LOCATION
The location on the print line to which
you want the input record elements or
constants moved.
Required.
No default.
14-15
TOTAL LENGTH
The length the data concatenated with
this format is to occupy on the print line.
You can enter a number between 1 and
99.
Required.
No default.
17-19
25-27
33-35
41-43
49-51
57-59
65-67
73-75
LOCATION OF
FIELDS TO BE
FORMATTED
The starting position in the input record
for the data that is to be printed on the
print line, or the constant ID number. You
can enter an input position or C01-C08
for each of these LOCATION fields. You
must enter at least 2 fields, and no more
than 8. The first blank field will
terminate the processing of this line.
Required.
No default.
20
28
36
44
52
60
68
76
CONSTANT
TREATMENT
A code controlling the formatting of the
constant (this is only valid if the
corresponding LOCATION field is a
constant):
Required.
No default.
21-22
29-30
37-38
45-46
53-54
61-62
69-70
77-78
LENGTH OF FIELDS
TO BE FORMATTED
*
Do not print this constant if the
preceding field contains only
blanks.
Blank
Do not print this constant if the
succeeding field contains only
blanks.
The length of each of the input record
elements or constants defined in the
LOCATION fields.
Required.
No default.
Software Release 4.0.0/March 2015
Report Layout and Content Parameters
7
Table 9: FORMAT Parameter Fields (Part 2 of 2)
Position
Field Name
Description
Comments
23
31
39
47
55
63
71
79
ZERO SUPPRESSION
A code indicating whether or not leading
zeros should be suppressed from the
corresponding input record element or
constant. Enter a Z if leading zeros
should be suppressed.
Optional.
Default is to
not print
leading zeros.
80
FORCE PRINT OF
CURRENT LINE
Enter one of the following codes to
indicate whether or not you want to force
the current line to be printed:
Optional.
Default is to
not print the
current line.
Working With CODE-1 Plus
P
Print the current line.
Blank
Do not print the current line
297
7
Using G1G001
MOVE
The optional MOVE parameter enables you to specify locations on the print line for
input file elements or constants defined with the CONSTANT parameter. You can
define up to 100 MOVE parameters.
Field-by-Field
NOTE: All input record position fields can be extended one column to the left to
accommodate 4-byte positions, if necessary.
Table 10: MOVE Parameter Fields
Position
298
Field Name
Description
Comments
1-4
KEYWORD
MOVE is the only acceptable entry.
Required.
5-6
COMMENT
You can enter any value you wish here to
identify this move operation; G1G001 will
ignore this field.
Optional.
No default.
8-10
DESTINATION
The location on the print line to which
you want the input record element or
constant moved.
Required.
No default.
Position
Field Name
Description
Comments
12-13
LENGTH
The length this data is to occupy on the
print line. You can enter a number
between 1 and 99.
Required.
No default.
15-17
SOURCE
The starting position in the input record
for the data that is to be printed on the
print line, or the constant ID number. You
can enter an input position or C01-C08.
Required.
No default.
19
FORCE PRINT OF
CURRENT LINE
Enter one of the following codes to
indicate whether or not you want to force
the current line to be printed:
Optional.
Default is to
not print the
current line.
Blank
Do not print the current line
P
Print the current line.
Software Release 4.0.0/March 2015
Report Layout and Content Parameters
7
PAGESZ
The optional PAGESZ parameter enables you to specify how many lines to print on
each page of the report.
Field-by-Field
Table 11: PAGESZ Parameter Fields
Position
Field Name
Description
Comments
1-6
KEYWORD
PAGESZ is the only acceptable entry.
Required.
8-10
LINES-PER-PAGE
The number of lines you want printed on
each page of the report.
Required.
Default is 60.
Minimum is 25;
maximum is 225.
12-14
REPORT
Code indicating whether the specified
line number applies to the reports. Enter
the following code:
Required.
Default is RPT.
RPT
Working With CODE-1 Plus
G1G001 report.
299
7
Using G1G001
TESTIT
The optional TESTIT parameter enables you to check the syntax of the parameters
before running the entire job. This parameter has no fields.
If you have this parameter in your job, CODE-1 Plus will check the syntax of your
parameters, and print a parameter report so that you can check that the information
stored on the parameters is really what you intended to store. Then, if all looks good
and there are no errors, you can remove this parameter and submit the job to run.
Field-by-Field
As shown in the table below, the keyword is the only field on the TESTIT parameter.
Table 12: TESTIT Parameter Field
300
Position
Field Name
Description
Comments
1-6
KEYWORD
TESTIT is the only acceptable entry.
Required.
Software Release 4.0.0/March 2015
Report Layout and Content Parameters
7
UNPK
The optional UNPK parameter enables you to print, in an unpacked format, data that
is in the input record in packed format. You can enter up to 100 UNPK parameters.
Field-by-Field
NOTE: All input record position fields can be extended one column to the left to
accommodate 4-byte positions, if necessary.
Table 13: UNPK Parameter Fields
Position
Field Name
Description
Comments
1-4
KEYWORD
UNPK is the only acceptable entry.
Required.
5-6
COMMENT
You can enter any value you wish here to
identify this unpack operation; G1G001
will ignore this field.
Optional.
No default.
Position
Field Name
Description
Comments
8-10
DESTINATION
The location on the print line to which
you want the input record element
printed in unpacked format.
Required.
No default.
12-13
DESTINATION
LENGTH
The length this unpacked data is to
occupy on the print line. This number can
not exceed 18.
Required.
No default.
15-17
SOURCE
The starting position in the input record
of the packed data that is to be unpacked
and printed.
Required.
No default.
19-20
SOURCE LENGTH
The length this packed data occupies in
the input record. This length must not
exceed 10.
Required.
No default.
Working With CODE-1 Plus
301
7
Using G1G001
Record Selection Parameters
The record selection parameters are used to select or reject records to be printed, or
limit the number of records that are to be printed.
SELECT
The required SELECT parameter enables you to specify a value in the input record
key code field that is to be used to select records for printing. If the value in the input
record matches the value you specify on the SELECT parameter, the record will be
selected for printing. If the value in the record is different than the value on the
SELECT parameter, the record will not be selected. You can also choose to select all
records, regardless of the value in the key code field, or you can choose to select all
records that do not contain blanks in the key code field.
NOTE: The key code location and length are specified on the CONTRL parameter.
You can define up to 200 SELECT parameters.
Field-by-Field
Table 14: SELECT Parameter Fields
Position
Field Name
Description
Comments
1-6
KEYWORD
SELECT is the only acceptable entry.
Required.
8-16
KEY CODE
COMPARISON
VALUE
The value that should be compared to
the key code in the input record. Or, you
can enter one of the following special
values:
Required.
No default.
ALLKEYS—Every record will be selected,
regardless of the data that is in the input
record key code.
NON BLANK—Only records with nonblank key codes will be selected.
NOTE: If you enter one of these special
values, you can only define one SELECT
parameter.
302
Software Release 4.0.0/March 2015
Sample Control Language
7
CHANGE
The optional CHANGE parameter enables you to specify a pair of fields that should
be used to determine if a record is to be selected for printing. For each record, the
data in the first field will be compared to the data in the second field. If the data in
the two fields is different, the record will be selected for printing. If the data is
identical, the record will not be selected for printing. You can enter up to 10
CHANGE parameters.
Field-by-Field
NOTE: All input record position fields can be extended one column to the left to
accommodate 4-byte positions, if necessary.
Table 15: CHANGE Parameter Fields
Position
1-6
Position
Field Name
KEYWORD
Field Name
Description
CHANGE is the only acceptable entry.
Description
Comments
Required.
Comments
8-10
FIRST COMPARISON
FIELD
The location in the input record of the
first field that is to be used for
comparison.
Required.
No default.
12-13
LENGTH
The length of the two fields that are to be
used for comparison.
Required.
No default.
15-17
SECOND
COMPARISON FIELD
The location in the input record for the
second field that is to be used for
comparison.
Required.
No default.
Sample Control Language
The following file assignments are used for executing the G1G001 program:
Table 16: File Names Used for Executing Program G1G001
File Name
Working With CODE-1 Plus
Description
G1GPRM
The input parameter file
PRNTRPT
The output printer file
G1GNAM
The input file
303
7
304
Using G1G001
Software Release 4.0.0/March 2015
CHAPTER 8
Calling CODE-1 Plus Matching and
Analyzer Modules
This chapter describes how to call program modules that match input addresses and
add ZIP + 4 and carrier route codes or analyze the input lines.
CODE-1 Plus Matching Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is C1MATCHx?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is C1ANZADR?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is C1BMCBD? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is EXTADDR2? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is G1CP? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is G1CP1? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Call Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the COBOL Stub Program (Optional) . . . . . . . . . . . . . . . . . . . .
Selecting the COBOL Stub Program. . . . . . . . . . . . . . . . . . . . . . .
Calling C1MATCHx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Casing Your Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Format of Cased Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Special Casing Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COBOL Call to Batch Version of C1MATCHx . . . . . . . . . . . . . . . .
The Input Call Area (P9IN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The Output Results Call Area (P9OUT) . . . . . . . . . . . . . . . . . . . . .
The Output Audit Call Area (P9AUDIT) . . . . . . . . . . . . . . . . . . . . .
Unmatched Data Call Area (P9INTRF) . . . . . . . . . . . . . . . . . . . . .
Calling C1ANZADR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ANALYSIS-PARAMETERS Call Area . . . . . . . . . . . . . . . . . . . . . . .
ANALYSIS-NORMALIZATION Call Area . . . . . . . . . . . . . . . . . . . .
Calling C1BMCBD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling the Address Line Extraction Module (EXTADDR2) . . . . . . . .
Calling G1CP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling G1CP1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working With CODE-1 Plus
306
306
307
307
307
307
307
308
308
309
309
310
310
310
311
312
320
349
350
351
351
352
355
357
361
361
305
8
Calling CODE-1 Plus Matching and Analyzer Modules
CODE-1 Plus Matching Modules
What is C1MATCHx?
Callable matching modules are programs that CODE-1 Plus uses to analyze your
input addresses and attempt to match those addresses to the CODE-1 Plus database.
These modules, designed to be called from your own applications, enable you to tailor
CODE-1 Plus to meet very specific processing needs.
The following callable modules match your input addresses against the CODE-1 Plus
database.
Table 1: Callable Matching Modules
Module
Description
Memory Used
C1MATCHI
Matcher for interactive processing
C1MATCHB
Default matcher for batch processing
3 MB
C1MATCHS
Matcher for batch processing
1 MB (small
memory model)
C1MATCHM
Matcher for batch processing
6 MB (medium
memory model)
C1MATCHL
Matcher for batch processing
12 MB (large
memory model)
C1MATCHH
Matcher for batch processing
28 MB (huge
memory
model).
These modules:
•
Process instructions you specify
•
Match the input record against the CODE-1 Plus database
•
Store the match results (standardized addresses and return codes) and
processing statistics
NOTE: SMDRC, a sample COBOL batch program that demonstrates the
techniques used to call C1MATCHx, the Address Line Extraction module
EXTADDR2, and the callable print program C1PRPT, has been provided for your
convenience. You will find the source code for this program with the other sample
files that you received with CODE-1 Plus in source file G1C1PGMS/SOURCE. An
ILE RPG sample, SMDRR, is also provided.
306
Software Release 4.0.0/March 2015
CODE-1 Plus Matching Modules
8
What is C1ANZADR?
C1ANZADR is the callable module that analyzes an input address. C1ANZADR
analyzes the elements of an address for use by the C1MATCHx modules during the
matching process. The specialized nature of the analyzer implies that it can not be
used for standardizing mailing addresses. The analyzer performs various
transformations on the input address to facilitate the matching process. These
transformations make the output unusable for label printing, etc.
You can use the analyzer to normalize input addresses to USPS standards.
C1ANZADR formats the address elements into a human-readable string that you can
use on mailing labels, envelopes, etc.
What is C1BMCBD?
C1BMCBD allows a user-supplied program to submit one address at a time to
CODE-1 Plus for matching.
What is EXTADDR2?
EXTADDR2 uses up to six address lines to return two lines to be passed to the
CODE-1 Plus matcher.
What is G1CP?
G1CP displays the combined database match/inquiry screens available from the
Work with Jobs screen.
What is G1CP1?
G1CP1 displays the database inquiry screen in “Flip” mode positioned at a city of
your choice.
Working With CODE-1 Plus
307
8
Calling CODE-1 Plus Matching and Analyzer Modules
Call Areas
When you call a module, you must pass, as parameters, the names of pre-defined call
areas. These call areas map the data that is stored in each byte of the call area.
Therefore, instead of passing individual fields between the driver and the callable
module, the only parameter that is passed between the two programs is the name of
the call area.
NOTE: If you call C1MATCHx from your program, the Pitney Bowes Global
Functions Library ([email protected]@PGMS) must be in the user library list, and we
recommend that the CODE-1 Plus library (G1C1PGMS) also be in the user library
list. We recommend you use the ADDLIBLE command at the beginning of a job and
RMVLIBLE at the end of the job. We do not recommend adding these libraries to
QUSRLIBL or QSYSLIBL. If Pitney Bowes product libraries are permanently added
to the system library list, this could adversely affect product installation.
Using the COBOL Stub Program (Optional)
NOTE: IMPORTANT! These programs are designed to correct performance issues
regarding Pitney Bowes callables. If you see that the Pitney Bowes libraries are
being allocated and de-allocated on every call, then the CBLSTUB program can
correct this function. Allocated and de-allocated libraries will cause serious
performance problems.
The CODE-1 Plus COBOL Stub program enables multiple CODE-1 Plus programs,
such as the address matcher, to be kept in memory as a job processes. This improves
performance so that each program does not have to re-initialize every time it is used.
Pitney Bowes provides two versions of this COBOL Stub program with CODE-1 Plus:
•
•
Program CBLSTUB has two required parameters;
–
Program name, which is 10 bytes
–
Work area, which is 2,000 bytes of data.
Program CBLSTUB1 has one required parameter:
–
Program name, which is 10 bytes.
If you do not use a COBOL Stub program, or do not need to change the COBOL Stub
program that you are currently using to CBLSTUB1, the instructions in the following
section are optional.
308
Software Release 4.0.0/March 2015
Calling C1MATCHx
8
Selecting the COBOL Stub Program
To select a COBOL Stub program, follow the instructions below:
1. Check for an existing version of CBLSTUB.
2. If a version of program CBLSTUB already exists, rename the existing program.
3. Rename CBLSTUB 1 to CBLSTUB.
4. Perform the following instructions:
RNMOBJ OBJ(XXC1PGMS/CBLSTUB1) OBJTYPE(*PGM)
NEWOBJ(CBLSTUB)
XXC1PGMS = Your CODE-1 Plus library
(Default = G1C1PGMS)
The selected COBOL Stub program will now be used during processing.
Calling C1MATCHx
The C1MATCHx modules (C1MATCHB, C1MATCHS, C1MATCHM, C1MATCHL,
C1MATCHH) take, as parameters, the names of the following call areas:
•
A 600-character input call area called P9IN, which contains the input address
information and the processing requirements
•
A 5,000-character output call area called P9OUT, which contains the match
results and return codes
•
An 800-character output call area called P9AUDIT, which contains audit
statistics.
•
An optional 2048-character output call area called P9INTRF, which contains
unmatched data.
NOTE: COBOL copy members of the call areas are provided on your installation
media in the sample source file G1C1PGMS/SOURCE. These copy books are
named P9IN, P9OUT, P9AUDIT, and P9INTRF. ILE RPG versions are also provided
and are named P9INR, P9OUTR, P9AUDITR, AND P9INTRFR.
You must initialize the call areas to SPACES before the first call to C1MATCHx.
C1MATCHx then initializes all the numeric fields in P9AUDIT.
Working With CODE-1 Plus
309
8
Calling CODE-1 Plus Matching and Analyzer Modules
Casing Your Output
You can choose to output your CODE-1 Plus results in upper, lower or mixed case.
This option is part of the input parameter to program C1MATCHx. Position 10,
P9ICASE, may contain either a C, an L, or a blank to specify whether or not to case
the output results from calling program C1MATCHx. A value of C specifies that mixed
casing is to be performed, a value of L specifies that lower casing is to be performed,
and a blank specifies that upper casing is to be performed
Format of Cased Output
All fields that are returned in mixed case have the exception of known USPS
addressing recommendations, including the following:
•
All pre-and post-directionals are uppercase.
•
All box numbers containing alphabetic characters are returned all uppercase.
•
All state abbreviations remain all uppercase.
•
PO, HC, and RR literals remain all uppercase.
There are no exceptions for fields returned in lower case.
Special Casing Requirements
Keep in mind the following special casing requirements for mixed-case output:
310
•
All words with a length greater than three characters and starting with “MC” are
returned with the letter following “MC” in upper case. For example, MCKEE
becomes McKee.
•
An alphabetic character following a non-space, non-alphabetic character is
returned uppercase. For example, F2F remains F2F. This rule has two exceptions:
–
All ordinal numbers are recognized and cased properly. Both consonants
following digits are lowercase. For example, 2ND becomes 2nd.
–
All words ending with “‘S” are cased properly. For example, ALEXANDER’S
becomes Alexander’s.
–
There are no special casing requirements for output returned in lower case.
Software Release 4.0.0/March 2015
Casing Your Output
8
COBOL Call to Batch Version of C1MATCHx
The following is a sample COBOL call to C1MATCHx (including C1MATCHI).
CALL WS-C1MATCHx USING P9IN
P9OUT
P9AUDT
P9INTRF
NOTE: You must set P9I-PRM4 to “Y” to indicate the presence of P9INTRF
(P9INTRF is not supported in C1MATCHI).
The remainder of this section presents the maps for each call area.
Working With CODE-1 Plus
311
8
Calling CODE-1 Plus Matching and Analyzer Modules
The Input Call Area (P9IN)
The following table is a map of the positions in the 500-byte P9IN input call area.
NOTE: Where applicable, fields in the P9IN Input Call Area should be leftjustified, and padded with blank spaces when necessary.
Table 2: Input Call Area (P9IN) (Part 1 of 9)
Position
1
Name
P9IFNC
Length
1
Contents
A 1-character code indicating what you want C1MATCHx
to do with the information in this call area. Type one of the
following values:
5
C1MATCHx will perform an address match,
including ZIP Code correction, if necessary.
9
C1MATCHx will perform an address match, but
will not attempt any ZIP Code correction (that is,
the match will be restricted to those addresses in
the original input ZIP Code, if there are any).
E
End-of-job indicator; C1MATCHx will not perform
an address match, but will close its files and
subprograms.
NOTE: With this option, no standardized city and state
will be returned.
Any other value is interpreted the same as 5, above.
2
P9ILLO
1
A 1-character code indicating if you want to conduct a
limited address match based on ZIP Code locality.
Blank
Standard Processing (default)
X
Limit Address Match to ZIP locality
NOTE: Setting this option will to “X” will produce a nonCASS certified configuration. No PS Form 3553 will be
generated.
3
P9ISTM
1
A 1-character code indicating the strictness of the street
name match. Type one of the following codes:
E
The input street name must match the database
exactly.
T
The matching algorithm is to be “tight.”
M
The matching algorithm is to be “medium”
(default).
L
The matching algorithm is to be “loose.”
Any other value is treated as M. (To generate Form 3553,
a value must be typed.)
312
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 2: Input Call Area (P9IN) (Part 2 of 9)
Position
4
Name
P9IFMM
Length
1
Contents
A 1-character code indicating the strictness of the firm
name match. Type one of the following codes:
E
The input firm name must match the database
exactly.
T
The matching algorithm is to be “tight.”
M
The matching algorithm is to be “medium”
(default).
L
The matching algorithm is to be “loose.”
Any other value is treated as M. (To generate Form 3553,
a value must be typed.)
5
P9IDSM
1
A 1-character code indicating the strictness of the
directional/suffix match. Type one of the following codes:
E
The input directional and suffix must match the
database exactly.
T
The matching algorithm is to be “tight.”
M
The matching algorithm is to be “medium”
(default).
L
The matching algorithm is to be “loose.”
Any other value is treated as M. (To generate Form 3553,
a value must be typed.)
6
P9INAD
1
A 1-character code indicating whether the match should
return normalized address information. You can obtain
normalized address elements simultaneously with the
regular address match call—a single call can provide both
standardized and normalized address elements.
Additionally, if normalized address information is
requested, DSF2 footnotes are also returned.
N
Provide normalized address elements for input
address lines.
Any other value does not return normalized address
elements.
7
P9ITEST
1
A 1-character code indicating whether to invoke a special
database mode function.
V
Override database expiration.
Any other value invokes the normal matching operations.
8
P9IFC9
1
A 1-character code indicating whether or not the matcher
should return a vanity city name if it is the best match for
the input city name. Type one of the following codes:
Blank
Never return a vanity city (default).
X
Return a vanity city if it is the best match.
Any other value is treated as blank.
NOTE: Setting this indicator to X will produce a non-CASScertified configuration. No USPS Form 3553 will be
generated.
Working With CODE-1 Plus
313
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 2: Input Call Area (P9IN) (Part 3 of 9)
Position
9
Name
P9IDUAL
Length
1
Contents
A one-character code indicating how CODE-1 Plus should
return a match if multiple non-blank address lines are
present or multiple address types are on the same
address line.
Blank
Normal match scoring for street address
elements, input ZIP Code, matching address line,
and so on (default).
S
Return a street match, regardless of the address
line.
P
Return a PO Box match, regardless of the address
line.
NOTE: Under normal conditions, a PO Box cannot match if
the city name and input ZIP Code are both changed.
DMM 708 states to match to a PO Box first when on the
same address line or the PO Box address is the primary
address line.
10
11
12
P9ICASE
P9ILOT
P9IEALT
1
1
1
A one-character code indicating whether or not to case
the output results from calling program C1MATCHx.
C
Results will be output in mixed case where
appropriate
L
All output will be returned in lower case.
Blank
All output will be returned in upper case (default).
A one-character code indicating whether to attempt Line
of Travel matching.
Blank
Do not attempt to perform Line of Travel matching
(default).
X
Perform Line of Travel matching
A one-character code indicating the matching preference
when a match is made to an alternate highrise record and
the input address contains secondary address data.
Y
Attempt to match to the base address (default).
N
Return the match to the alternate highrise record.
NOTE: Setting this indicator to N will produce a nonCASS-certified configuration. No USPS Form 3553 will be
generated.
13
P9ISCM
1
A one-character code indicating the matching preference
when multiple secondary components are found on the
input address.
Y
Attempt to find an exact ZIP + 4 match to each
secondary component (default).
N
Match to the default.
NOTE: Setting this indicator to N will produce a nonCASS-certified configuration. No USPS Form 3553 will be
generated.
314
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 2: Input Call Area (P9IN) (Part 4 of 9)
Position
14
Name
P9IZCT
Length
1
Contents
A one-character code indicating the preferred city name.
Z
Return ZIP + 4 File Preferred Last Line City Name
(override city name).
C
Return city name from USPS City/State File
(default city name)
P
Return the Primary City
NOTE: The default for this field is Z when calling
C1MATCHx. The default for C1BM00 is C.
15
16
17
18
19
20
21
22
23
P9IDPV
P9IDPV-ZCP
P9IDPV-ZCA
P9IDPV-CR
P9IDPV-DR
P9IDPV-SFX
P9IDPV-SDC
P9IDPV-SC
P9IDPV-USD
Working With CODE-1 Plus
1
1
1
1
1
1
1
1
1
Blank
Do not attempt to perform DPV processing
(default).
X
Perform DPV processing
Blank
Perform DPV (default).
N
Do not attempt to DPV when multiple condition is
due to ZIP Code - PO Box/Rural/HC
Blank
Perform DPV (default).
N
Do not attempt to DPV when multiple condition is
due to ZIP CODE – Street Address
Blank
Perform DPV (default).
N
Do not attempt to DPV when multiple condition is
due to Carrier Route
Blank
Perform DPV (default).
N
Do not attempt to DPV when multiple condition is
due to Directional (non-Cardinal rule)
Blank
Perform DPV (default).
N
Do not attempt to DPV when multiple condition is
due to Suffix (none on input)
Blank
Perform DPV (default).
N
Do not attempt to DPV when multiple condition is
due to Suffix or Directional Correction
Blank
Perform DPV (default).
N
Do not attempt to DPV when Multiple Input
Secondary Components with no Designator
Blank
Perform DPV (default).
N
Do not attempt to DPV confirm when Small Town
Default ZIP + 4 assigned or Unique ZIP Default ZIP
+ 4 assigned.
315
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 2: Input Call Area (P9IN) (Part 5 of 9)
Position
24
25
26
27
28
29
Name
P9IDPV-10L
P9IDPV-CMRA
P9IDPV-BYS
P9IRDI
P9IDPV-40L
P9ISTE
Length
1
1
1
1
1
1
Contents
This field allows you to process the DPV large memory
module to increase processing speed. Please note this
will require 18MB of memory.
Blank
Use DPV010 for DPV processing (default).
X
Use DPV Large memory Module DPV010L for DPV
processing.
Controls the CMRA lookup bypass
Blank
Perform CMRA lookup (default).
N
Do not perform CMRA lookup.
Controls bypass of DPV validation on secondary
addresses.
Blank
Perform DPV validation on secondary addresses
(default).
N
Do not perform DPV validation on secondary
addresses.
Controls whether or not to perform RDI processing.
Blank
Do not attempt RDI processing (default).
X
Attempt RDI processing.
This field allows you to process the RDI large memory
module to increase processing speed. Please not this will
require 16 MB of memory.
Blank
Use DPV040 for RDI processing (default).
X
Use Large Memory Module DPV010L and
DPV0130L for processing.
This field allows you to specify how SuiteLink errors will be
treated.
• I — Ignore error and continue to attempt SuiteLink
processing. CODE-1 Plus does not generate a USPS
Form 3553 (USPS CASS Summary Report) if you specify
the value “I”.
• S — Shutdown when SuiteLink reports an error
(default). Specify the value “S” if you want to generate a
USPS Form 3553 (USPS CASS Summary Report).
• W — Issue warning message and turn off SuiteLink
processing. CODE-1 Plus does not generate a USPS
Form 3553 (USPS CASS Summary Report) if you specify
the value “W”.
30
316
P9ISTE-BYP
1
This field allows you to specify if an expired SuiteLink
database will cause the job to terminate.
N
Do not bypass SuiteLink database expiration date
processing (default).
Y
Bypass SuiteLink database expiration processing.
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 2: Input Call Area (P9IN) (Part 6 of 9)
Position
31
Name
P9ISTE-SMM
Length
1
32-34
Reserved
3
35
P9ICMRAPMB
1
36
37
38
39
P9IR777-ZP4
P9IDPV-PBSA
P9IDPV-NOST
P9IDPV-VACT
Working With CODE-1 Plus
1
1
1
1
Contents
Controls the SuiteLink memory module size to use for
processing.
Blank
DPV process will be using Medium memory
model (default).
P
Pico memory model (no files in memory).
U
Micro memory model (no files in memory, only
indexes).
S
Small memory model
M
Medium memory model
L
Large memory model
H
Huge memory model (all files in memory).
Controls whether to convert secondary information to
PMB.
Blank
Do not convert secondary information to PMB.
Y
Yes, convert secondary information to PMB where
appropriate.
N
No, do not convert secondary information to PMB.
Controls whether to suppress ZIP + 4 for addresses
assigned a phantom Carrier Route R777 (not eligible for
street delivery).
Y
Yes, if Carrier Route R777 is found, add to the
ZIP + 4 Suppressed Count on the USPS Form
3553. R777 addresses are not deliverable. Do not
store the ZIP + 4 (DPBC).
Blank
If Carrier Route R777 is found, do not add to the
ZIP + 4 Suppressed Count on the USPS Form
3553. R777 addresses are deliverable. Store the
ZIP + 4 (DPBC).
Controls P. O. Box Street Address (PBSA) Table lookup.
Blank
Do not perform PBSA Table lookup.
Y
Yes, perform PBSA Table lookup.
N
No, do not perform PBSA Table lookup. (Default)
Controls DPV No Stat Lookup Bypass.
Y
Perform DPV No Stat Lookup.
N
Do not perform DPV No Stat lookup. (Default)
Controls DPV Vacant Lookup Bypass.
Y
Perform DPV Vacant Lookup.
N
Do not perform DPV Vacant lookup. (Default)
317
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 2: Input Call Area (P9IN) (Part 7 of 9)
Position
40
Name
P9I-ZLACS
Length
1
Contents
This field allows you to specify if you want to perform
LACSLink processing.
• Blank — Do not attempt to perform LACSLink
processing (default)
• Y — Perform LACSLink processing
• L — Invoke limited LACSLink subsystem processing.
Provides the CODE-1 Plus non-LACS converted street
address, city, and state data to the output standardized
address and parsed elements fields
41
P9I-PRM4
1
Code indicating whether the fourth parameter, P9INTRF,
is present and to be processed.
• Blank — The fourth parameter, P9INTRF, is not present
and should not be processed.
• Y — The fourth parameter, P9INTRF, is present and
should be processed.
42
43
44
318
P9ISIN
P9ICZO
P9ISSM
1
1
1
Code indicating whether to perform Split Indicia
processing:
Blank
Do not perform split indicia processing (default).
Y
Perform split indicia processing
Controls the population of the CITY/STATE P9OUT areas
for the input ZIP Code when there is no match to the US
Postal Database. P9OUT areas are: P9OCL9, P9OCS9,
P9OCTL, P9OCTS, and P9OSTA.
Blank
Do not return city/state for input ZIP Code
(default).
Z
Return city/state for input ZIP Code.
Controls whether to do enhanced street matching (ESM)
or All Street Matching (ASM).
Blank
Do not use enhanced street matching (default).
A
Attempt match to all streets in locality (matches
to misspelled first letter in street name)
S
Use enhanced street matching.
45
Reserved
1
46-50
P9IZIP
5
The 5-digit ZIP Code for the address to be matched.
51-54
P9IZIP4
4
The 4-digit ZIP + 4 Code for the address to be matched.
55-154
P9IAD1
100
The primary address line.
155-254
P9IAD2
100
The secondary address line.
255-354
P9IFRM
100
The firm name, left-justified, in human-readable format.
If no firm name is available, or if you do not wish firm-level
ZIP + 4 matching to be performed, leave this field blank.
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 2: Input Call Area (P9IN) (Part 8 of 9)
Position
355-454
Name
P9ICST
Length
100
Contents
The city/state information. (Each component must be
separated by at least one blank.) You can use the first 99
bytes of this field, but do not use byte 100. It is reserved for
internal processing.
455-489
P9IURB
35
Urbanization name (without state name).
490
P9IENV
1
A one-character code indicating the environment in which
the C1MATCHx program is executing:
B
C1MATCHx is being called in a batch environment
(default).
I
C1MATCHx is being called in an interactive
environment.
Any other value is treated as B.
491-500
P9IDBL
10
These bytes are reserved for the IBM i platform.
501
P9IAUX
1
A one-character code indicating Auxiliary File processing:
502-525
Reserved
24
526
P9I-PREFER
1
Blank
Not performed (default).
X
Perform Auxiliary File processing.
A one-character code indicating Preferred Alias
Processing.
Y
Use Preferred Alias Processing.
N
Do Not Use Preferred Alias Processing (default).
NOTE: A “Y” in this position is required to generate a
CASS report.
527
528
P9I-ABBREV
P9IDPV-FTI
1
1
A one-character code indicating Abbreviated Alias
Processing.
Y
Use Abbreviated Alias Processing.
N
Do Not Use Abbreviated Alias Processing
(default).
A one-character code that allows you to specify the DPV
file to match against:
Blank
Process the DPV split file.
S
Process the DPV split file.
F
Process the DPV flat file.
H
Process the DPV full (hash) file.
529-530
P9IDPB2
2
Two characters for the DPBC input add on.
531
P9I-CASSOK
1
A one-character code that indicates whether a valid CASS
configuration is intended.
Working With CODE-1 Plus
N
Force non-CASS configuration
Y
CASS configuration (default).
319
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 2: Input Call Area (P9IN) (Part 9 of 9)
Position
532
533
534
Name
P9IDPV-MMS
P9ILACS-MMS
P9ISEASONAL
Length
1
1
1
Contents
Controls the DPV memory module size to use for
processing.
Blank
DPV process will be using Medium memory
model (default).
P
Pico memory model (no files in memory).
U
Micro memory model (no files in memory, only
indexes).
S
Small memory model
M
Medium memory model
L
Large memory model
H
Huge memory model (all files in memory).
Controls the LACS memory module size to use for
processing.
Blank
LACS process will be using Medium memory
model (default).
P
Pico memory model (no files in memory).
U
Micro memory model (no files in memory, only
indexes).
S
Small memory model
M
Medium memory model.
L
Large memory model.
H
Huge memory model (all files in memory).
Code indicating if CODE-1 Plus should retrieve and return
seasonal delivery flags:
Y
Retrieve and return seasonal delivery flags.
NOTE: Any value other than Y will not retrieve seasonal
flags.
535-600
Reserved
66
The Output Results Call Area (P9OUT)
The following table is a map of the 5,000-byte P9OUT output call area. You should
initialize this area to blank spaces before your first call to C1MATCHx.
When C1MATCHx processing does not find a valid match for an address:
1. The address is sent for LACSLink processing.
2. If LACSLink finds that the address is convertible, the LACSLink converted address
is written back to the P9IAD1 field.
3. The P9IAD2 field is filled with blank spaces.
320
Software Release 4.0.0/March 2015
Casing Your Output
8
4. The LACSLink converted address in the P9IAD1 field is sent back through
C1MATCHx processing for another matching attempt.
NOTE: The output parsed A1 elements will not be blank when an address has been
LACSLink converted.
Table 3: Output Call Area (P9OUT) (Part 1 of 28)
Position
1
2
Name
P9OGRC
P9OPRB
Length
1
1
Contents
A one-character code indicating the success or reason
for failure of the address-match attempt:
Blank
The address-match attempt was successful.
A
Apartment number missing or not found in
database, and an apartment-level match was
required.
B
Insufficient (or blank) address information for
a match.
C
Critical error (CICS and IMS only).
E
External match—auxiliary file processing.
H
House/Box number not found on street.
M
Multiple address matches were found.
S
Street name not found in ZIP Code.
X
Database access issue. One example of a
database access issue would be that the
database has expired. This value may also
indicate a license issue.
Z
ZIP Code not found in database.
A one-character code indicating the (relative)
probable correctness of the overall match that was
found:
Blank
No match was found.
0
The match is most likely correct.
1-8
These values represent intermediate values
on a sliding scale.
9
The match is least likely to be correct.
NOTE: These values reflect the program's estimate of
“relative probable correctness” only; it is possible that
some matches given a score of 0 are not correct, and
probable that matches given a score of 9 are
nevertheless correct.
3
P9OSSC
Working With CODE-1 Plus
1
A 1-digit score, on a scale of 0 - 9, reflecting the
closeness of the street-name match (after
transformations by the analyzer, if any), where 0
indicates an exact match and 9 indicates the least
likely match. If no match was found, this field is blank.
321
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 2 of 28)
Position
4
5
6
322
Name
P9ODRC
P9OSRC
P9OARC
Length
1
1
1
Contents
A 1-character code indicating the result of the
directional match, as follows:
Blank
No address match, or directional (or lack
thereof) matches the database.
D
The directional does not match the database
at all.
F
The complete directional does not match the
database, but its first character does (for
example, N versus NW).
N
No directional was found on the input
address, but a directional was present on the
database.
A 1-character code indicating the result of the suffix
match:
Blank
No address match or suffix (or lack thereof)
matches the database.
N
No suffix was found on the input address, but
a suffix was present on the database.
S
The suffix does not match the database.
A 1-character code indicating the result of the
apartment match:
Blank
No address match or apartment (or lack
thereof) matches the database.
A
The apartment does not match the database.
F
Apartment appended because of firm name
match.
N
No apartment was found on the input address,
but an apartment was present on the
database at the street address.
7-10
P9O-LB-AM
4
The number of attempts required to match the
address. The number will be right-justified, with
leading blanks.
11
P9OAPR
1
A 1-character code indicating whether an apartment
number was detected in the input address:
Y
An apartment number was detected in the
input address.
N
No apartment number was detected in the
input address.
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 3 of 28)
Position
12
Name
P9OPRA
Length
1
Contents
A 1-character code indicating the (relative) probable
correctness of the address match (only):
Blank
No address-match was found.
0
The address match is most likely to be
correct.
1-8
These values represent intermediate values
on a sliding scale.
9
The address match is least likely to be
correct.
NOTE: These values reflect the program's estimate of
“relative probable correctness” only; it is possible that
some matches given a score of 0 are not correct, and
probable that most matches given a score of 9 are
nevertheless correct.
13
P9OFRC
1
A 1-character code indicating the result of the firm
name match:
Blank
No address match or firm name matches, or
no firm name is present on the input.
F
The input firm name does not match the
database.
M
An input firm name was present, but there
were no firm names on the database for the
matched address.
14
P9OFSC
1
A 1-digit score, on a scale of 0 - 9, reflecting the
closeness of the firm-name match, where 0 indicates
an exact match and 9 indicates the least likely match.
If no (firm) match was obtained, this field will be blank.
15
P9OSMA
1
A 1-character code reflecting the source of the
matched address:
Working With CODE-1 Plus
Blank
No match was found.
M
The matched address was synthesized from
information in both the primary and
secondary address lines.
P
The matched address was taken from the
primary address line.
S
The matched address was taken from the
secondary address line.
323
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 4 of 28)
Position
16
17
18
19
20
324
Name
P9ODIT
P9ODFR
P9OALT-ADDR
P9OSCM
P9OALT
Length
1
1
1
1
1
Contents
A 1-character code indicating which type of
information, if any, was dropped in order to get
the match:
Blank
Either no match was obtained, or no
information was dropped.
A
A street address was dropped in order to
obtain an RR/HC or PO Box match.
R
RR/HC or PO Box information was dropped in
order to obtain a street address match.
W
One or more characters were dropped during
the address parsing process. These
characters are placed in positions 201-300
and/or 401-500 described below.
A 1-character code indicating whether or not a default
record was matched:
Blank
Record matched was not default record, or no
match was obtained.
H
Highrise default.
R
Rural Route default.
M
Military default.
S
Street default.
A 1-character code indicating the alternate
addressing scheme:
Blank
No alternate address scheme used.
D
Delivery point alternate logic used.
E
Enhanced Highrise Alternate Match logic
used.
S
Small town default logic used.
U
Unique ZIP Code logic used.
A 1-character return code indicating multiple
secondary component matching:
Blank
Multiple secondary component logic not used.
E
Exact match to secondary component.
S
Multiple secondary component logic used.
A 1-character code indicating whether the input
record was matched to a base ZIP + 4 record or an
alternate ZIP + 4 record.
A
An alternate ZIP + 4 record was matched.
B
A base ZIP + 4 record was matched.
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 5 of 28)
Position
21
Name
P9O9RC
Length
1
Contents
A 1-character code reflecting the success or reason
for failure of the ZIP + 4 coding attempt:
Blank
The address-match attempt was successful.
7
ZIP + 4 matched to a Carrier Route R777
(phantom) and was suppressed.
A
An apartment number was missing or not
found in the database, and an apartment-level
match was required.
B
Insufficient (or blank) address information for
a match.
H
House/Box number not found on street.
M
Multiple matches of equal quality were found.
S
Street name was not found in the ZIP Code.
U
Unavailable—auxiliary file processing.
V
Record matched a non-deliverable address.
NOTE: A non-deliverable ZIP + 4 Range is
typically a new ZIP range where the USPS has
not finalized assignments of ZIP + 4 codes,
thus not permitting assignment of postal code
information at this time.
Z
22
23
P9OCRC
P9OOGER-N
Working With CODE-1 Plus
1
1
ZIP Code was not found in the database.
A 1-character code reflecting the success or reason
for failure of the carrier route coding attempt:
Blank
The address-match attempt was successful.
A
An apartment number was missing or not
found in the database, and an apartment-level
match was required.
B
Insufficient (or blank) address information for
a match.
H
House/Box number not found on street.
M
Multiple matches of equal quality were found.
N
Carrier Route coding not attempted - auxiliary
processing.
S
Street name was not found in the ZIP Code.
U
Unavailable—auxiliary file processing.
Z
ZIP Code was not found in the database.
For internal use only.
325
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 6 of 28)
Position
24
25
26
27
326
Name
P9OCIT
P9OSAB
P9OURC
P9ONTP
Length
1
1
1
1
Contents
A 1-character code indicating whether or not the input
city name was standardized:
Blank
No match, or the input city name was the
same as either the long or short city name
returned in fields P9OCTL and P9OCTS.
C
The input city name was standardized to the
long or short city name returned in fields
P9OCTL and P9OCTS.
I
Input city name was identical to short city
name.
A 1-character code indicating whether or not the input
state was standardized:
Blank
No match, or the input state name was the
same as the state name returned in the
P9OSTA field.
S
The state abbreviation was standardized to
the value returned in the P9OSTA field.
A 1-character code reflecting the urbanization name
match attempt:
Blank
No urbanization name match, or urbanization
name matches, or no urbanization is present
on the input.
M
Multiple matches were found.
A 1-character code indicating the matched alias street
name type.
Blank
Street record matched was not an alias
street.
A
Street record was abbreviated.
C
Official street name change (Chamber of
Commerce action).
O
Street record matched was a USPS “other”
alias.
P
Street record matched was a USPS
“preferred” alias.
28
P9ODPC
1
The check-digit for the 11-digit delivery point barcode
(DPBC).
29-34
P9ODPBC
6
The delivery point barcode (DPBC) determined for the
input address, or blanks if none could be determined.
The ZIP + 4 Code can be taken from the first four
characters of this field.
35-38
P9OCRT
4
The carrier route code, in Cnnn format, determined
for the input address; this field is blank if no match
could be obtained.
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 7 of 28)
Position
39
Name
P9ORTP
Length
1
Contents
The USPS Record Type of the ZIP + 4 record that was
matched. If no match could be obtained, this field is
blank. Otherwise, the field will contain one of the
following record types:
Blank
No match found.
F
Firm record
G
General delivery record
H
High Rise (apartment complex) record
P
Post office box record
R
Rural Route or Highway Contract record
S
Normal street address record
NOTE: Electing to store the record type will produce a
non-CASS-certified configuration. No USPS Form
3553 will be generated.
40
41
42
43
P9OSNA
P9OLACS
P9OAUX-M
P9ODPV-RC
Working With CODE-1 Plus
1
1
1
1
The alias return code. The field will contain one of the
following codes:
Blank
The record matched a base street name.
A
The record matched an alias street name.
The matched address Locatable Address Correction
Service (LACS) indicator. The field will contain one of
the following codes:
L
The record was LACS converted and moved to
an urban address.
Blank
The record was not LACS converted and did
not move to an urban address.
A 1-character code indicating the auxiliary file match:
Blank
Non-match.
1
Early Warning System (EWS) File.
A 1-character code indicating the type of match to the
Delivery Point Validation file:
Blank
not attempted or processing successful.
E
Expired Database.
F
Open/Read failure on DPV database.
V
Software Not Compatible with ZIP + 4
Software.
S
Seed Record Encountered.
X
DPV Software/Database Incompatible.
327
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 8 of 28)
Position
44
Name
P9ODPV
Length
1
Contents
DPV Confirmation Indicator:
Blank — Not presented.
45
46
328
P9ODPVC
P9ODPVF
1
1
D
Valid primary; input missing secondary
(primary rural route).
M
Unable to DPV confirm multiple condition.
N
No Delivery Point Validation.
S
Valid primary; however, secondary (primary
for rural route) and/or single trailing alpha
present and is not confirmed.
Y
Delivery Point Validated. Primary valid and
secondary number (when present) valid.
DPV CMRA (Commercial Mail Receiving Agency)
Indicator:
Blank
Not Presented.
Y
Yes CMRA.
N
Not CMRA.
DPV False/Positive Indicator:
Blank
Not Presented.
Y
False.
N
Not False.
47-48
P9OSWM
2
Indicates the modification level of the matching
program C1MATCHx.
49-52
P9OSWV
4
Indicates the release number of the matching
program C1MATCHx.
53-62
P9OSWD
10
Indicates the date on which the matching program
was installed.
63-82
P9ODBV
20
Identifies the version of the CODE-1 Plus database
used to obtain matches.
83-102
P9OCSV
20
Identifies the software used to create the CODE-1 Plus
database.
103-302
Reserved
200
Filler
303-402
P9OCO1
100
The 100-byte output area returned by C1ANZADR
containing “care of” data dropped from the primary
address line. This field will be cased if there is a value
of “C” in P9ICASE.
403-602
Reserved
200
Filler
603-702
P9OCO2
100
The 100-byte output area returned by C1ANZADR
containing “care of” data dropped from the secondary
address line. This field will be cased if there is a value
of “C” in P9ICASE.
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 9 of 28)
Position
Name
Length
Contents
703-704
P9OSAL
2
The length of the standardized address string in the
P9OSAD field.
705-802
P9OSAD
98
Contains the complete standardized address,
including apartment information. This field will be
cased if there is a value of “C” in P9ICASE.
The following fields contain isolated elements of the standardized address, as noted.
803-812
P9OHS-LB
10
The house number.
813-814
P9ODI1
2
The leading directional.
815-842
P9OSTR
28
The street name. This field will be cased if there is a
value of “C” in P9ICASE.
843-846
P9OSFX
4
The street suffix. This field will be cased if there is a
value of “C” in P9ICASE.
847-848
P9ODI2
2
The trailing directional.
849-887
P9OSTN
39
The complete street name (a combination of fields
P9ODI1-P9ODI2, above). This field will be cased if
there is a value of “C” in P9ICASE.
888-937
P9OSTH
50
The street address, without apartment information.
This field will be cased if there is a value of “C” in
P9ICASE.
938-941
P9OATP
4
The apartment designator. This field will be cased if
there is a value of “C” in P9ICASE.
942-949
P9OAP-LB
8
The apartment number.
950-962
P9OAT-LB
13
The apartment number, preceded by the apartment
designator, if required. This field will be cased if there
is a value of “C” in P9ICASE.
963-968
P9ORR-LB
6
The rural route or highway contract number extracted
from the matched address, in the standard USPS form
(RR1, for example).
969-978
P9ORB-LB
10
The box number associated with the RR or HC route in
field P9ORR-LB.
979-988
P9OBX-LB
10
The post office box number.
989-990
P9OSAL-BASE
2
The number of bytes used for the base address
information.
9911088
P9OSAD-BASE
98
The base address information. This field will be cased
if there is a value of “C” in P9ICASE.
10891090
P9ODI1-BASE
2
The base leading directional.
Working With CODE-1 Plus
329
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 10 of 28)
Position
Length
Contents
10911118
P9OSTR-BASE
28
The base street name. This field will be cased if there
is a value of “C” in P9ICASE.
11191122
P9OSFX-BASE
4
The base street suffix. This field will be cased if there
is a value of “C” in P9ICASE.
11231124
P9ODI2-BASE
2
The base trailing directional.
11251163
P9OSTN-BASE
39
The base complete street. This field will be cased if
there is a value of “C” in P9ICASE.
11641213
P9OSTH-BASE
50
The base address without apartment information. This
field will be cased if there is a value of “C” in P9ICASE.
1214
P9OCITY-TYPE-IN
1
A 1-character code indicating the input city type:
1215
330
Name
P9OLACSLINK-IND
1
P
Primary city name
S
Secondary city name
V
Vanity city name.
Indicates if a table was matched:
Blank
No LACS processing occurred.
F
LACS seed violation has occurred
N
No match occurred or a new address would
not convert at run time
S
Input address contained both primary and
secondary information but match occurred
using only primary information
Y
Full match occurred.
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 11 of 28)
Position
12161217
12181226
Name
P9OLACSLINK-RC
P9OLACSLINK-DBINFO
Length
2
9
Contents
Indicates the success of the LACSLink process:
Blank
No LACS processing occurred.
A
LACS record match
00
No match
0
Address was passed to LACS process, but
could not be coded by LACS.
1
Address was successfully coded through the
LACS process.
2
A LACS False/Positive record was
encountered, but software is operating in a
NCOA/No Stop Capacity. As such, NCOA/No
Stop Capacity allows for the LACS function to
continue processing when a seed record is
encountered.
09
LACSLink was able to find the input address on
its internal tables but for some reason did not
return the new (converted) address.
14
Match found LACS record but would not
convert.
92
Match with secondary information.
Indicates the date of the database in YYYYMM format.
Also contains error codes for LACSLink. If the value of
P9OERR is “K” then the first five bytes of this field
contain the error code.
20120: LACS DB EXPIRATION
20121: CAN'T OPEN SECURITY FILE
20122: CORRUPTED SECURITY FILE
20123: CHECK DIGIT VIOLATION ON SECURITY KEY
20124: PREVIOUS SEED VIOLATION, SYSTEM LOCKED
20126: RESTART KEY OR SECURITY FILE NOT
CORRECT
20127: UNKNOWN
30000: LACS SEED VIOLATION
31000: LACS SYSTEM ERROR
32000: UNKNOWN as due to missing or corrupted
LACSLink security file or key file.
12271239
P9OLACSLINKVERSION
13
Version number of the LACSLink database,
12401244
P9ODPV-DB-TY
5
A 5-character code indicating the DPV database type.
FLAT
Indicates a DPV flat file
SPLIT Indicates a DPV split file
FULL
Working With CODE-1 Plus
Indicates a DPV full file.
331
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 12 of 28)
Position
1245
Name
P9OVALID-ZIP
Length
1
Contents
A 1-character code indicating the ZIP Code status.
Y — Valid ZIP Code.
N — Invalid ZIP Code.
1246
P9ODPV-PBSA
1
A 1-character code indicating whether a P. O. Box
Street Address (PBSA) was found.
Y — PBSA found.
N — No PBSA found.
1247
P9OPOBZIP
1
A 1-character code indicating whether this is a P. O.
Box only ZIP Code.
Y — P. O. Box only ZIP Code.
Blank — Not P. O. Box only ZIP Code.
12481259
P9OSEASONAL
12
A 12-byte code indicating when mail can be delivered
to a specific address.
1260
P9ODPV-VACT
1
A 1-character code indicating the presence of a DPV
vacant address.
1261
1262
1263
332
P9ODPV-NOST
P9ORDI
P9ORDI-RC
1
1
1
Blank
Not presented.
Y
Vacant address.
N
Not vacant address.
A 1-character code indicating the presence of
statistics for this address. A “Y” indicates that the
address is not a valid delivery address even though it
has been validated by DPV.
Blank
Not presented.
Y
Found match to ‘No Stat’ DPV hash table.
N
No match found to “No stat” DPV hash table.
A 1-character code indicating the type of match to the
Residential Delivery Indicator (RDI) file:
Blank
Not presented
M
MIxed Residential/Business
B
Business only
R
Residential
A 1-character code identifying the success or failure
of RDI processing:
Blank
Not attempted or processing successful
E
Expired database
F
Open/Read failure
V
Software not compatible with ZIP + 4 software
S
Executing DPV040 — Table(s) > 8 MB
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 13 of 28)
Position
1264
1265
1266
1267
1268
Name
P9OSAR
P9OD1R
P9OSNR
P9OSFR
P9OD2R
Length
1
1
1
1
1
Contents
A 1-character code indicating the success or reason
for failure of the standardized address match attempt:
Blank
The address match attempt was successful.
A
Apartment number missing or not found in
database, and an apartment-level match was
required.
B
Insufficient (or blank) address information for
a match.
H
House/Box number not found on street.
M
Multiple matches were found of equal quality.
S
Street name not found in ZIP Code.
U
Unavailable—auxiliary file processing.
Z
ZIP Code not found in database.
A 1-character code indicating whether multiple values
were found for the leading directional segment of the
standardized address:
Blank
Only one value was found.
M
Multiple values were found.
A 1-character field indicating whether multiple values
were found for the root street name:
Blank
Only one value was found.
M
Multiple values were found.
A 1-character field indicating whether multiple values
were found for the street suffix:
Blank
Only one value was found.
M
Multiple values were found.
A 1-character field indicating whether multiple values
were found for the trailing directional:
Blank
Only one value was found.
M
Multiple values were found.
12691270
P9OFRM-LN
2
The length of the standardized firm name.
12711310
P9OFRM
40
The standardized firm name. This field will be cased if
there is a value of “C” in P9ICASE.
The following A1 elements pertain to the input primary address:
NOTE: The output parsed A1 elements will not be blank for addresses that have been LACSLinkconverted.
13111320
P9O-A1-HOUSE-NR
Working With CODE-1 Plus
10
The left-justified, primary normalized house number.
333
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 14 of 28)
Position
334
Name
Length
Contents
13211322
P9O-A1-PRE-DIR
2
The normalized pre-directional indicator.
13231367
P9O-A1-STREET-NAME
45
The normalized street name, which is any information
that remains after the address is matched. This field
will be cased if there is a value of “C” in P9ICASE.
13681371
P9O-A1-SUFFIX
4
The normalized street suffix. This field will be cased if
there is a value of “C” in P9ICASE.
13721373
P9O-A1-POST-DIR
2
The normalized post directional indicator.
13741377
P9O-A1-APT-TYPE
4
The normalized apartment type (designator). This field
will be cased if there is a value of “C” in P9ICASE.
13781385
P9O-A1-APT-NR
8
The left-justified, normalized apartment string.
13861387
P9O-A1-RR-TYPE
2
A 2- character code indicating the normalized rural
route/highway contract type. One of the following
codes is stored:
Blank
No type was stored.
HC
The address contains a highway contact
number.
RR
The address contains a rural route number.
13881390
P9O-A1-RRT-NR
3
The normalized rural route number, rural route/
highway contract number.
13911400
P9O-A1-BOX-NR
10
The left-justified, normalized box number.
14011404
P9O-A1-PMB-D
4
The left-justified Private Mailbox (PMB) Designator.
14051420
P9O-A1-PMB-NR
16
The left-justified Private Mailbox (PMB) Number.
14211422
P9O-A1-STREET-LEN
2
The normalized length of the street name.
14231443
Reserved
21
1444
P9O-A1-STD-PRE-DIR
1
A 1-character pre-directional standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 15 of 28)
Position
1445
1446
1447
1448
1449
1450
1451
14521460
Name
P9O-A1-STD-SUFFIX
P9O-A1-STD-POST-DIR
P9O-A1-STD-RR-TYPE
P9O-A1-STD-GD
P9OP9O-A1-STD-APTTYPE
P9O-A1-STD-PMB
P9O-A1-STD-BOX
Reserved
Working With CODE-1 Plus
Length
1
1
1
1
1
1
1
Contents
A 1-character suffix standard format indicator. One of
the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character post-directional standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character rural route/highway contract type
standard format indicator. One of the following codes
is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character general delivery standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character apartment type standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character PMB type standard format indicator.
One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character box number type standard format
indicator. One of the following codes is stored:
Blank
There was no box number.
B
Input was a box number.
N
Input was present, but was neither a box or
Post Office Box.
P
Input was a Post Office Box.
9
335
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 16 of 28)
Position
Name
Length
Contents
The following A2 elements pertain to the input secondary address:
336
14611470
P9O-A2-HOUSE-NR
10
The left-justified, normalized house number.
14711472
P9O-A2-PRE-DIR
2
The normalized pre-directional indicator.
14731517
P9O-A2-STREET-NAME
45
The normalized street name, which is any information
that remains after the address is matched. This field
will be cased if there is a value of “C” in P9ICASE.
15181521
P9O-A2-SUFFIX
4
The normalized street suffix. This field will be cased if
there is a value of “C” in P9ICASE.
15221523
P9O-A2-POST-DIR
2
The normalized post directional indicator.
15241527
P9O-A2-APT-TYPE
4
The normalized apartment type (designator).
15281535
P9O-A2-APT-NR
8
The left-justified, normalized apartment string.
15361537
P9O-A2-RR-TYPE
2
A 2-character code indicating the normalized rural
route/highway contract type. One of the following
codes is stored:
Blank
No type was stored.
HC
The address contains a highway contact
number.
RR
The address contains a rural route number.
15381540
P9O-A2-RRT-NR
3
The left-justified, normalized rural route number,
rural route/highway contract number.
15411550
P9O-A2-BOX NR
10
The left-justified, normalized box number.
15511554
P9O-A2-PMB-D
4
The left-justified Private Mailbox (PMB) Designator.
15551570
P9O-A2-PMB-NR
16
The left-justified Private Mailbox (PMB) Number.
15711572
P9O-A2-STREET-LEN
2
The normalized length of the street name.
15731593
Reserved
21
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 17 of 28)
Position
1594
1595
1596
1597
1598
1599
1600
Name
P9O-A2-STD-PRE-DIR
P9O-A2-STD-SUFFIX
P9O-A2-STD-POST-DIR
P9O-A2-STD-RR-TYPE
P9O-A2-STD-GD
P9O-A2-STD-APT-TYPE
P9O-A2-STD-PMB
Working With CODE-1 Plus
Length
1
1
1
1
1
1
1
Contents
A 1-character pre-directional standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character suffix standard format indicator. One of
the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character post-directional standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character rural route/highway contract type
standard format indicator. One of the following codes
is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character general delivery standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character apartment type standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character Private Mailbox (PMB) standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
337
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 18 of 28)
Position
1601
P9O-A2-STD-BOX
Length
1
Contents
A 1-character box number type standard format
indicator. One of the following codes is stored:
Blank
There was no box number.
B
Input was a box number.
N
Input was present, but was neither a box or
Post Office Box.
P
Input was a Post Office Box.
16021610
Reserved
9
16111620
P9OPRG-LOW
10
The low primary range for the matching address.
16211630
P9OPRG-HIGH
10
The high primary range for the matching address.
1631
P9OPRG-PARITY
1
The primary odd/even indicator for the matching
address.
16321639
P9OSRG-LOW
8
The low secondary range for the matching address.
16401647
P9OSRG-HIGH
8
The high secondary range for the matching address.
1648
P9OSRG-PARITY
1
The secondary odd/even indicator for the matching
address.
1649
P9O5RC
1
A 1-character code indicating the success or reason
for failure of the ZIP Code to be corrected:
16501651
338
Name
P9O-LB-ZL
2
Blank
The match attempt was successful.
A
Apartment number missing or not found on
database, and an apartment-level match was
required.
B
Insufficient (or blank) address match
information.
E
External match—auxiliary file processing.
H
House/Box number was not found on street
M
Multiple ZIP matches were found of equal
quality.
S
Street name not found in ZIP Code.
Z
ZIP Code was not found on database.
The number of best-fit ZIP Codes found. If the number
is less than 10, the left-most character is blank.
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 19 of 28)
Position
1652
1653
1654
1655
Name
P9OICR
P9OOCR
P9OCAO
P9OOVC
Working With CODE-1 Plus
Length
1
1
1
1
Contents
A 1-character code indicating the city match condition
which resulted when the input city name was used to
find a locality:
Blank
Match successful.
B
No input city could be found.
C
No match could be found for the input city/
state.
N
No locality attempt was made.
A 1-character code indicating the success or reason
for failure of the final output city match attempt (trying
to find the right city name for the ZIP Code
determined):
Blank
Input city/state matched.
N
Not used.
B
No input city/state found.
C
City/state mismatch.
I
Input used, no cities available for ZIP.
S
Spelling error(s) in input were corrected.
A 1-character code specifying the status of the output
ZIP Code field, P9OCZP:
A
P9OCZP contains a ZIP Code other than the
original, due to the address match found.
B
P9OCZP contains blanks; no match was
available, and the original ZIP Code was
blank.
C
P9OCZP contains the original ZIP Code, which
was confirmed by address match.
I
P9OCZP contains blanks; no match was
available, and the original ZIP Code was
invalid.
O
P9OCZP contains the original ZIP Code,
because no address match was found.
U
P9OCZP contains the original ZIP Code. The
original ZIP Code was unique and did not
correspond to the input city/state.
ZIP + 4 Override City Name Indicator:
Blank
Not stored.
O
ZIP + 4 Override City Name Stored.
339
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 20 of 28)
Position
1656
1657
1658
1659
340
Name
P9OSFZ
P9OOZA
P9OCBA
P9OFBA
Length
1
1
1
1
Contents
A 1-character code reflecting the source of the final
ZIP Code:
B
No ZIP Code was determined.
M
The final ZIP Code was based on a match to
the USPS ZIPMOVE database.
F
The final ZIP Code was determined from the
finance number locality.
Z
The original ZIP Code was retained.
A 1-character code indicating the results of the match
attempt in the original ZIP Code (only):
Blank
Not attempted.
I
Attempted, improved (a match was obtained).
N
Attempted, no match found.
A 1-character code indicating the results of the match
attempt in the city-based locality:
Blank
Not attempted.
I
Attempted, improved (a match was obtained).
N
Attempted, no match found.
A 1-character code indicating the results of the match
attempt in the finance number-based locality:
Blank
Not attempted.
I
Attempted, improved (a match was obtained).
N
Attempted, no match found.
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 21 of 28)
Position
16601679
Name
P9OFNT-DPV-GRP
Length
20
Contents
A 20-byte area to accommodate DPV footnote codes.
• AA — Input address matched to the ZIP+4 file.
• A1 — Input address not matched to the ZIP+4 file.
• BB — Input address matched to DPV (all
components).
• CC — Input address primary number matched to
DPV but secondary number not match (present but
not valid).
• F1 — Input address is military; DPV bypassed.
• G1 — Input address is general delivery; DPV
bypassed.
• M1 — Input address primary number missing.
• M3 — Input address primary number invalid.
• N1 — Input address primary number matched to
DPV but high rise address missing secondary
number.
• P1 — Input address missing RR or HC Box number.
• P3 — Input address missing PO, RR, or HC Box
number.
• PB — Input address is a P. O. Box Street Address
(PBSA).
• RR — Input address matched to CMRA.
• R1 — Input address matched to CMRA but
secondary number not present.
• R7 — Input address matched to phantom Carrier
Route R777 (not eligible for street delivery).
• U1 — Input address is unique ZIP; DPV bypassed.
16801681
16821683
16841686
P9OLIA-RC
P9OLIA-STATUS-RC
Reserved
Working With CODE-1 Plus
2
2
License Management Return Code:
Blank
Successful
F1
License File Not Found
F2
Client Record Missing
F9
Unknown Function Requested
GI
Generic I/O Failed
License Management Status Code:
Blank
Product/Key Combination is Good
XX
Product/Key Combination is Not Good
3
341
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 22 of 28)
Position
1687
P9OCSS
Length
1
Contents
A 1-character code indicating the status of city/state
information in the following output fields: P9OCL9,
P9OCS9, P9OCTL, P9OCTS, and P9OSTA.
Blank
No information available.
M
Fields populated based upon match to
database.
Z
No match to database; based upon input ZIP
Code.
16881693
P9OFIN
6
The USPS finance number from the output matched
city.
16941699
P9OLLN
6
The USPS last line number from the matched ZIP + 4
record.
17001719
P9OZ-GRP
20
The first four additional ZIP Codes found, (that is, in
addition to the ZIP Code returned in field P9OCZP
below) if multiple ZIP matches were obtained. Each
ZIP Code is presented as a 5-digit number. If fewer
than five ZIP Code matches were obtained, the unused
fields contain zeros.
17201724
P9OCZP
5
Final ZIP Code, as best as it could be determined. This
field will be blank if no ZIP Code could be determined
and the original ZIP Code was invalid.
17251767
P9OCL9
43
Standardized City/State/ZIP + 4 line, constructed
using the long (28-byte maximum) city name. This
field will be cased if there is a value of “C” in P9ICASE.
17681795
P9OCS9
28
Standardized City/State/ZIP + 4 line, constructed
using the short (13-byte maximum) city name. This
field will be cased if there is a value of “C” in P9ICASE.
17961823
P9OCTL
28
The long city name. This field will be cased if there is
a value of “C” in P9ICASE.
18241836
P9OCTS
13
The short city name. This field will be cased if there is
a value of “C” in P9ICASE.
18371838
P9OSTA
2
The USPS standard state abbreviation.
1839
P9OCITY-TYPE
1
The USPS standardized city name type:
18401859
342
Name
P90PMB
20
P
Primary. Preferred mailing name (the USPS
last line name).
S
Secondary. Allowable mailing name (not the
USPS last line name).
V
Vanity. Non-mailing name.
The formatted Private Mailbox (PMB) (from input).
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 23 of 28)
Position
1860
1861
1862
1863
1865
1866
Name
P9OPMB-TYP
P9OZIP-CLASS
P9OESM-FLAG
P9OSTELNK-RC
P9OSTELNK-MATCHRC
P9OSTELNK-MATCHFID
Length
1
1
1
2
1
1
1867
P9OSTELNK-RLS-NUM
12
1879
Reserved
1
Working With CODE-1 Plus
Contents
A 1-character return code indicating the type of
Private Mailbox (PMB):
S
Standard PMB number
N
Non-standard PMB number
#
Non-standard, pound sign PMB number
A 1-character code indicating the ZIP classification:
Blank
Regular ZIP
M
Military ZIP
P
P.O. Box
U
Unique ZIP
A 1-character code indicating whether enhanced
street matching (ESM) or All Street Matching (ASM)
processing was performed:
Blank
No ESM performed
A
Matched using All Street Matching (matched
misspelled first letter)
F
ASM performed but no match found
M
Matched using ESM
P
ESM performed but no match found
SuiteLink return code:
A
Business name matched.
00
Business name not matched
SuiteLink match code:
A
Matched
B
Not matched
C
Business name was all noise
D
Highrise default record not found
E
Database is expired
SuiteLink match fidelity:
1
Exact match
2
Acceptable match (one word not matched)
3
Unacceptable match (more than one word not
matched)
SuiteLink release number.
343
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 24 of 28)
Position
1880
344
Name
P9OLOT-RC
Length
1
Contents
A 1-character character indicating the level of match
obtained against the Line of Travel master file:
Blank
Invalid input (zero or non-numeric ZIP/ZIP + 4
add-on)
9
9-digit ZIP + 4 match successful
C
Call to LTO10/LTO10C failed
D
Unsuccessful 9-digit match, default coded
F
Open/read failure on Line of Travel master file
V
Line of Travel matcher software not
compatible with the Line of Travel master file
18811884
P9OLOT-CODE-NUM
4
Numeric portion of Line of Travel code.
1885
P9OLOT-CODE-SEQ
1
A 1-character character indicating USPS Line of
Travel sequence, as follows:
A
Ascending
D
Descending
18861887
P90LOT-ALT-SEQ
2
The 2-character alternate alphanumeric sequence
code (A0-T9).
1888
P9OLOT-ALT-HEX
1
The 1-character alternate hexadecimal sequence
code (X’21’ - X’E8’)
1889
P9OXRC
1
Master file expiration code. One of the following codes
will be in this area:
Blank
The master file is still “fresh.”
W
The master file is in the USPS grace period
(60-105 days old). Check P9OMFX for the
number of days left until the end of the grace
period.
B
The master file expiration has been bypassed.
V
The database and software are incompatible.
X
The master file has expired (it is over 105 days
old).
18901892
P9OMFX
3
A 3-byte number indicating the number of days left
until the master file expires.
18931902
P9OMFD
10
Expiration date of the master file in MM/DD/YYYY
format.
19031912
P9OMFV
10
Vintage date of the master file in MM/DD/YYYY format.
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 25 of 28)
Position
1913
1914
Name
P9OCASS
P9OEXP
Length
1
1
Contents
CODE-1 Plus CASS cycle expiration return code.
Blank
CODE-1 Plus is certified for the current CASS
cycle.
C
The CASS cycle that certified this version of
CODE-1 Plus has expired.
Master file expiration return code.
Blank
Master file is ok (within USPS file life-cycle)
W
Master file has exceeded its life-cycle and is
within the USPS grace period (check P9OMFX
for days left until the end of the grace period)
B
Master file expiration bypassed
X
Master file has expired (grace period
exceeded).
19151924
P9OCASS-X-DATE
10
The USPS CASS cycle expiration date. This is the date
that CODE-1 Plus will stop providing a USPS Form
3553 for this CASS cycle. You can bypass this
expiration date.
1925
P9OERR
1
Represents the database for which an error occurred:
Blank: unknown
Z
ZIPIDX
L
LCLDB
D
DTLDB
U or C CITYDB
1926
P9OERR-TYPE
1
19271928
P9OFST
2
19291934
Reserved
6
19351940
P9ODPV-DB-VINTAGE
6
19411945
P9ODPV-DBSFW
Working With CODE-1 Plus
5
N
COUNTY
S
C1STRDB
V
DPVMST
Represents the operation being attempted:
C
Close
O
Open
R
Read
N
Record Number
File status code returned by COBOL.
DPV Database Vintage Date — MMYYYY format:
• P9ODPV-DB-MONTH
2
• P9ODPV-DB-YEAR
4
Software version used to create DPV file.
345
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 26 of 28)
Position
19461951
P9ORDI-DB-VINTAGE
Length
6
Contents
RDI Database Vintage Date — MMYYYY format:
• P9ORDI-DB-MONTH
2
• P9ORDI-DB-YEAR
4
19521956
P9ORDI-DBSFW
5
Software version used to create RDI file.
19571961
P9ODB-VERS
5
Database vintage for “database incompatible”
condition.
1962
Reserved
1
19631990
P9OURB
28
USPS urbanization name. This field will be cased if
there is a value of “C” in P9ICASE.
19911993
P9OCOUNTY-NR
3
The USPS FIPS county number.
19942018
P9OCOUNTY
25
The USPS county name. This field will be cased if there
is a value of “C” in P9ICASE.
20192020
P9OCONGRESS
2
The congressional district.
20212120
P9OFNT-GRP
100
Up to 50, 2-character Delivery Sequence Footnotes
(DSF2).
2121
P9OSTELNK-RLSNAME
30
SuiteLink release name.
2151
P9OSTELNK-DB-DATE
10
SuiteLink database date (MM/DD/YYYY).
2161
P9OSTELNK-DB-EXPDATE
10
SuiteLink expiration date (MM/DD/YYYY).
2171
P9OMATAL2-PREFERRC
1
Location on the output record for a 1-byte flag.
2172
346
Name
P9OMATAL2-ABBREVRC
1
Blank
No preferred alias processing attempted.
A
Input address matched to an alias (preferred
alias processing is only attempted for base
addresses).
N
Preferred alias not found for input address.
Y
Preferred alias found for input address and
used in output standardized address.
Location on the output record for a 1-byte flag.
Blank
No abbreviated alias processing attempted.
B
Output address set to base address.
L
Original standardized address length already
<= max.
N
Abbreviated alias not found for input address.
Y
Abbreviated alias found for input address and
used in output standardized address.
Software Release 4.0.0/March 2015
Casing Your Output
8
Table 3: Output Call Area (P9OUT) (Part 27 of 28)
Position
Name
Length
21732220
Reserved
48
22212222
P9OSTACK-USED
2
Contents
Number of entries in address stack.
The following fields (positions 2223-2475) occur 10 times. The previous field, P9OSTACK-USED, indicates the
number of occurrences that are non-blank. Only the first occurrence of each field is listed.
2223
P90AS-RC
1
Return code
2224
P9OAS-OPRB
1
Overall probability of correctness
2225
P9OAS-RTP
1
USPS record type
2226
P90AS-DFR
1
Code indicating the “default” match:
H
High Rise Default
R
Rural Route Default
M
Military Default
S
Street Default
Blank
Not a default record.
22272290
P9OAS-SAD
64
Formatted standard address
22912292
P90AS-SAL
2
Length of standardized address
22932302
P9OAS-PRG-LOW
10
Primary range (low)
23032312
P90AS-PRG-HIGH
10
Primary range (high)
2313
P90AS-PRG-PARITY
1
Primary range parity
23142321
P9OAS-SRG-LOW
8
Secondary range (low)
23222329
P9OAS-SRG-HIGH
8
Secondary range (high)
2330
P9OAS-SRG-PARITY
1
Secondary range parity.
23312370
P9OAS-FIRM
40
Firm name
23712398
P9OAS-CTL
28
Long city name
23992411
P9OAS-CTS
13
Short city name
Working With CODE-1 Plus
347
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 3: Output Call Area (P9OUT) (Part 28 of 28)
Position
Name
Length
Contents
24122439
P9OAS-URB
28
Puerto Rico Urbanization name
24402441
P9OAS-STA
2
State abbreviation
24422446
P90AS-ZIP
5
ZIP Code
24472450
P90AS-ZP4
4
ZIP + 4 Add-on
24512452
P9OAS-DP
2
Delivery point add-on
2453
P90AS-DPC
1
Delivery point check digit
24542457
P90AS-CRT
4
Carrier route code
24582460
P90AS-COUNTY
3
County number
24612462
P9OAS-CONGRESS
2
Congressional district
24632468
P9OAS-LL
6
Last line number
24692474
P9OAS-FIN
6
Finance number
2475
P90AS-SCORE
1
Score:
0-9
0 is the best score
Positions 2476-4752 contain the Address Stack return fields for each entry in the address stack.
47535000
348
Reserved
248
Software Release 4.0.0/March 2015
Casing Your Output
8
The Output Audit Call Area (P9AUDIT)
The following table is a map of the 800-byte Audit call area, which consists of
subfields (counters) that are maintained by C1MATCHx. You must initialize the
P9AUDIT area with blank spaces before your first call to C1MATCHx.
When C1MATCHx is first called, all numeric fields in this area are set to zero.
Thereafter, they are incremented as indicated by the field usage. You can, however,
clear all or some of these fields to zero after each match attempt, so that you can
report on the resource requirements of individual match attempts.
Each counter is a 9-digit packed number occupying 5 bytes, unless otherwise noted.
Table 4: Output Audit Call Area (P9AUDIT)
Positions
Name
Length
Contents
1-5
P9AZPX
5
Database read operations for the ZIP Index file.
6-10
P9ACTX
5
Database read operations for the City Details file.
11-15
P9ALCL
5
Database read operations for the Locality file.
16-20
P9ADTL
5
Database read operations for the Street Details file.
21-25
P9ACNT
5
Database read operations for the County file.
26-30
P9ASTR
5
Database read operations for Street information.
31-85
Reserved
55
86-90
P9ARZPX
5
Database read requests (whether or not an I/O
operation resulted) for the ZIP Index file.
91-95
P9ARCTX
5
Database read requests (whether or not an I/O
operation resulted) for the City Details file.
96-100
P9ARLCL
5
Database read requests (whether or not an I/O
operation resulted) for the Locality file.
101-105
P9ARDTL
5
Database read requests (whether or not an I/O
operation resulted) for the Street Details file.
106-110
P9ARCNT
5
Database read requests (whether or not an I/O
operation resulted) for the County file.
111-115
P9ARSTR
5
Database read operations for Street Name details.
116-800
Reserved
685
Working With CODE-1 Plus
349
8
Calling CODE-1 Plus Matching and Analyzer Modules
Unmatched Data Call Area (P9INTRF)
The following table is a map of the optional 2048-byte P9INTRF unmatched data call
area.
You must set P9I-PRM4 to 'Y' to indicate the presence of P9INTRF.
Table 5: Unmatched Data Call Area P9INTRF)
Positions
Length
Contents
1-100
P9INT-EXTRAADD1
100
Any unmatched data returned by the matcher that was
taken from the primary address line
101-200
P9IINT-EXTRAADD2
100
Any unmatched data returned by the matcher that was
taken from the secondary address line
201-300
P9INT-EXTRADUAL
100
Unmatched/unused portion of a dual address (e.g. 123
MAIN ST PO BOX 456)
301-400
P9INT-EXTRAFRM
100
Unused at this time
401-500
P9INT-EXTRACST
100
Unused at this time
501
P9INT-DUALSOURCE
1
Indicates the source of the dual address line (P9INTEXTRA-DUAL):
502-2048
350
Name
Reserved
P
Primary input line
S
Secondary input line
1547
Software Release 4.0.0/March 2015
Calling C1ANZADR
8
Calling C1ANZADR
The C1ANZADR module analyzes the ANALYSIS-PARAMETERS call area, which is
2,512 bytes and contains the input address. C1ANZADR returns normalized address
information through the 150-byte ANALYSIS-NORMALIZATION parameter. Based
on the analysis, CODE-1 Plus determines the appropriate address standardization.
NOTE: A COBOL copy member of the call area is provided on your installation
media in the sample source file G1C1PGMS/SOURCE. The COBOL copybook is
ANZPARM. An ILE RPG version, ANZPARMR, is also provided.
ANALYSIS-PARAMETERS Call Area
The following table is a map of the positions in the call area passed to C1ANZADR.
Table 6: Call Area Passed To C1ANZADR (Part 1 of 2)
Position
1
2
3
Working With CODE-1 Plus
Name
ANALYZEFNC
ADDRORIGIN
DIR-SPLIT
Length
1
1
1
Contents
A 1-character code indicating the analyzation control
function. Specify one of the following codes:
E
End the program, close the tables, and do not
return any output.
P
Analyze the input address string and return
analyzed output (default).
A 1-character code indicating from where the input
address string originated. One of the following codes is
stored:
U
This is user address data.
Z
This is the USPS ZIP + 4 street name.
A 1-character code indicating whether to split a
complete directional word from the beginning of the
word (i.e., “WESTERN” becomes “W ERN”). Specify one
of the following codes:
Y
Attempt to split the complete directional word
(default).
N
Do not attempt to split the complete directional
word.
351
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 6: Call Area Passed To C1ANZADR (Part 2 of 2)
Position
4
5
Name
SUFFIXSPLIT
NORMALIZEFNC
Length
1
Contents
A 1-character code indicating whether to split a
complete street suffix word from the end of the word
(i.e., “BROADWAY” becomes “BROAD WAY”). Specify
one of the following codes:
1
Y
Attempt to split the complete suffix word
(default).
N
Do not attempt to split the complete suffix
word.
A 1-character code indicating the normalize control
function. Specify one of the following codes:
N
Analyze the input address string and return
“normalized” output.
X
Do not return “normalized” address elements
(default).
6-10
Reserved
5
11-110
ADDRESSSTRING
100
The input address string. C1ANZADR assumes that the
last byte is always blank.
1112,512
N/A
2,402
These bytes are reserved for internal matching
variables.
NOTE: For Unisys-A users, this position is 111-2516 and
the length for this position is 2,406.
ANALYSIS-NORMALIZATION Call Area
The following table is a map of the positions in the call area passed to C1ANZADR.
Table 7: Call Area Passed To C1ANZADR (Part 1 of 3)
Position
Name
Length
Contents
Normalized Address Elements
352
1-10
HOUSE-NR
10
The left-justified, normalized house number.
11-12
PRE-DIR
2
The normalized pre-directional indicator.
13-57
STREET-NAME
45
The normalized street name, which is any information
that remains after all other address elements are
identified and extracted
58-61
SUFFIX
4
The normalized street suffix.
62-63
POST-DIR
2
The normalized post directional indicator.
64-67
APT-TYPE
4
The normalized apartment type (designator).
Software Release 4.0.0/March 2015
Calling C1ANZADR
8
Table 7: Call Area Passed To C1ANZADR (Part 2 of 3)
Position
Name
Length
Contents
68-75
APT-NR
8
The left-justified, normalized apartment string.
76-77
RR-TYPE
2
A 2- character code indicating the normalized rural
route/highway contract type. One of the following
codes is stored:
Blank
No type was stored.
HC
The address contains a highway contact
number.
RR
The address contains a rural route number.
78-80
RRT-NR
3
The left-justified, normalized rural route/highway
contract number.
81-90
BOX-NR
10
The left-justified, normalized box number.
91-94
PMB-D
4
Private Mailbox Descriptor
#
Nonstandard Private Mailbox Designator
PMB
Standard Private Mailbox Designator
95-110
PMB-NR
16
The left-justified, formatted Private Mailbox (PMB)
string. This does not include the Private Mailbox
Descriptor.
111-112
STREET-LEN
2
The normalized length of the street name.
113-133
Reserved
21
134
STD-PRE-DIR
1
135
136
Working With CODE-1 Plus
STD-SUFFIX
STD-POST-DIR
1
1
A 1-character pre-directional standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character suffix standard format indicator. One of
the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character post-directional standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
353
8
Calling CODE-1 Plus Matching and Analyzer Modules
Table 7: Call Area Passed To C1ANZADR (Part 3 of 3)
Position
137
138
139
140
141
142-150
354
Name
STD-RR-TYPE
STD-GD
STD-APT-TYPE
STD-PMB
STD-BOX
Reserved
Length
1
1
1
1
1
Contents
A 1-character rural route/highway contract type
standard format indicator. One of the following codes
is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character general delivery standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character apartment type standard format
indicator. One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character Private Mailbox (PMB) string indicator.
One of the following codes is stored:
Blank
The element was not present in the input.
N
The input was in a non-standard format.
S
The input is in a standard format.
A 1-character box number type standard format
indicator. One of the following codes is stored:
Blank
There was no box number.
B
Input was the literal “Box.”
N
Input was present, but was neither of the
above.
P
Input was the literal “Post Office Box.”
9
Software Release 4.0.0/March 2015
Calling C1BMCBD
8
Calling C1BMCBD
The callable batch driver C1BMCBD allows a program supplied by the user to submit
one address at a time to CODE-1 Plus for matching. The batch driver analyzes the
address and attempts a match with the database. When an “END” call is issued to
C1BMCBD, it produces the same reports as batch driver C1BM00. The USPS form
3553 is also produced. C1BMCBD runs with all parameters used by C1BM00.
The ADDRDF, CS ZIP, FILEDF, HEADER, and at least one xx OUT parameters are
required. When calling C1BMCBD for matching, send a space in the
CBD-ACTION-CODE and the input record in CBD-INPUT. C1CBCBD will use the
input file parameters (ADDRDF, CS ZIP, and FIRMNM) to define the input and
returns an output record formatted as described by any xx OUT parameters in
CBD-OUTPUT. C1BMCBD will close processing and produce reports when an “E” is
sent in CBD-ACTION-CODE.
The following parameters will not function with C1BMCBD. Their data are ignored:
•
FILEDF—except for C1BMSTA
•
CHCKPT
•
NTHSEL
•
SEQCHK
However, if present, these parameters must be in proper format to pass validation.
The FILEDF parameter for C1BMNAM must be present, although data from it will be
ignored (instead, the program supplied by the user defines the input file).
NOTE: The source code for SMCBDC, a sample COBOL program for calling
C1BMCBD, is included with the other sample files you received with CODE-1 Plus
in source file G1C1PGMS/SOURCE. An ILE RPG version, SMCBDR, is also
provided.
Working With CODE-1 Plus
355
8
Calling CODE-1 Plus Matching and Analyzer Modules
The parameters to pass to C1BMCBD are described below.
NOTE: A COBOL copy member of the call area is provided in source file
G1C1PGMS/SOURCE. The COBOL copy book is CBDPARM. An ILE RPG version,
CBDPARMR, is also provided.
Table 8: Call Area Passed to C1BMCBD (CBDPARM)
Positions
1
2-3
356
Name
CBD-ACTIONCODE
CBD-RC
Length
1
2
Contents
Code indicating whether C1BMCBD should match
address or print reports.
Blank
Match address given in input area.
E
End processing, close files, and print reports.
Return code from C1BMCBD
1
Parameter Error
4
Z4 Change Error
8
Z4 Change Error
12
Parameter Error
16
Parameter Error
22
General CODE-1 Plus Error
24
Geographic Coding Error
26
Z4 Change Error
99
General Error
4-32763
CBD-INPUT
32760
Input record of name and address file.
3276465523
CBD-OUTPUT
32760
Output record.
Software Release 4.0.0/March 2015
Calling the Address Line Extraction Module (EXTADDR2)
8
Calling the Address Line Extraction Module (EXTADDR2)
The CODE-1 Plus Address Line Extraction Module (EXTADDR2):
1. Accepts up to six address lines as input.
2. Processes the input address lines and returns the following fields:
•
Primary address field
•
Secondary address field
•
Firm name field
•
Urbanization name field for Puerto Rican addresses
•
City/state
•
ZIP Code
3. Passes the returned fields to the CODE-1 Plus matcher to code the address
4. Returns input information that was not used to create the returned fields. This
unused information is not necessary for the matcher to code an address and is
being provided for your convenience.
Calling EXTADDR2
EXTADDR2 is a separate routine that can be called independently of the CODE-1
Plus matcher. The EXT2PARMR and EX2DATAR parameters are required to call
EXTADDR2. Pitney Bowes supplies the EXT2PARMR and EX2DATAR parameters as
COBOL copybooks with the CODE-1 Plus software. For more information on these
copybooks, please refer to “Supplied Copybooks” on page 358.
When first calling EXTADDR2:
1. The entire EXT2PARMR structure should be initialized to spaces before being
called and not thereafter.
2. The “Input Types” value should be set to “A
and not modified thereafter.
" (uppercase "A" and five spaces)
3. The EXT2DATAR call area should be initialized to spaces for each and every call.
Sample COBOL Batch Program
Pitney Bowes supplies a sample COBOL batch program, SMDRC, that demonstrates
techniques for calling:
Working With CODE-1 Plus
357
8
Calling CODE-1 Plus Matching and Analyzer Modules
•
C1MATCHx
•
EXTADDR2
•
C1PRPT (callable print program)
You can find the source code for the SMDRC program with the other sample files
included with your CODE-1 Plus software. An ILE RPG version, SMDRR, is also
provided.
Special Processing Switches
As stated previously, EXTADDR2 parses the input lines and returns the primary
address field, secondary address field, Firm name field, city and state in one field, and
the ZIP Code in a separate field.
•
If you do not need EXTADDR2 to identify the input line that contains the Firm
name, set the "Firm Identification Switch” to "S".
•
If you do not need EXTADDR2 to identify the City, State, and ZIP Code, set the
"City/State/ZIP Identification Switch" to "S".
•
If you do not need EXTADDR2 to identify the Urbanization name, set the
"Urbanization Identification Switch" to "S".
Supplied Copybooks
The two call areas for EXTRADDR2 are defined in the supplied EXT2PARMR
copybook and as a 600-byte array defined in the EXT2DATAR copybook. The
EXT2PARMR and EXT2DATAR copybooks are defined below.
EXT2PARMR Copybook
Position
Field Name
Length
Description
Input Fields
358
1
EXT2-ADDR-LINE-1
100
Address Line 1
101
EXT2-ADDR-LINE-2
100
Address Line 2
201
EXT2-ADDR-LINE-3
100
Address Line 3
301
EXT2-ADDR-LINE-4
100
Address Line 4
401
EXT2-ADDR-LINE-5
100
Address Line 5
501
EXT2-ADDR-LINE-6
100
Address Line 6
Software Release 4.0.0/March 2015
Calling the Address Line Extraction Module (EXTADDR2)
Position
Field Name
Length
601
Reserved
20
621
EXT-NO-MERGE-SEC-PMB
1
8
Description
Secondary and PMB merge switch:
• Blank — Merge any secondary or
PMB information with the primary
address.
• S — Do not merge secondary or PMB
information with the primary address
line.
622
EXT-SKIP-FIRM
1
Firm identification switch:
• Blank — Identify the likely firm line
from the input lines.
• S — Do not attempt to identify the
firm from the input lines.
623
EXT-SKIP-URB
1
Urbanization identification switch:
• Blank — Attempt to identify the
urbanization line from the input
lines.
• S — Do not attempt to identify the
urbanization line from the input
lines.
624
EXT-SKIP-CSZ
1
City, State, and ZIP Code identification
switch:
• Blank — Attempt to identify the city,
state, and ZIP Code from the input
lines.
• S — Do not try to identify the city,
state, and ZIP Code from the input
lines.
625
Reserved
76
EXT2-P9IZIP
5
Output Fields
701
Output ZIP Code.
ZIP Code identified unless the City/
State/ZIP identification switch was set
to “S”.
706
EXT2-P9IZIP4
4
Output ZIP+4 add-on.
ZIP + 4 add-on code identified unless
the City/State/ZIP identification switch
was set to “S”.
710
EXT2-P9IAD1
100
Primary address line.
810
EXT2-P9IAD2
100
Secondary address line.
910
EXT2-P9IFRM
100
Firm name.
1010
EXT2-P9ICST
100
City/state.
Working With CODE-1 Plus
359
8
Calling CODE-1 Plus Matching and Analyzer Modules
Position
Field Name
Length
1110
EXT2-P9IURB
35
1145
Reserved
11
1156
EXT2-INPUT-TYPES
6
Description
Urbanization name.
Input types.
Should be set to “A “ (uppercase "A"
and five spaces) to activate processing
using the Firm, Urbanization, and City/
State/ZIP identification switches.
1162
Reserved
39
EXT2DATAR Copybook
The second parameter that must be passed to EXTADDR2 is defined in the table
below and in the EXT2DATAR copybook. EXTADDR2 returns information from the
six input lines that was not used to create the data fields that are passed to the
matcher to code an address (this data is referred to as Additional Input Data). This
call area is required but the information is returned for your convenience and is not
needed to code an address.
Position
360
Field Name
Length
Description
1
EXTRA-DATA-LINE1
100
Extra data from input line 1
101
EXTRA-DATA-LINE2
100
Extra data from input line 2
201
EXTRA-DATA-LINE3
100
Extra data from input line 3
301
EXTRA-DATA-LINE4
100
Extra data from input line 4
401
EXTRA-DATA-LINE5
100
Extra data from input line 5
501
EXTRA-DATA-LINE6
100
Extra data from input line 6
Software Release 4.0.0/March 2015
8
Calling G1CP
Calling G1CP
G1CP has no calling parameters. The module provides access to the combined
interactive database match/inquiry screens available from the Work with Jobs screen.
For example,
CALL G1C1PGMS/G1CP
The combined match/inquiry screen appears.
CODE-1 Plus Coding System
-------------------------------------------------------------------------Firm Name:
Firm: M D/Suf:M
Secondary Addr:
St: M Vcity:S
Primary Addr:
Correct ZIP: Y
City, ST:
Mixed Case: Y
ZIP Code:
Urb Name:
Mult Secondary: Y
Override City: Z
Matched Addr:
CRRT:
City,State ZIP:
DPBC:
------------------------------------------------------------------------Command:
__ of __
City Information
LN City
ST
ZIP Range
Type Urb Unique-ZIP
1 AARP
CA
90847-90848
V
Y
2 A A R P INS
PA
19187
V
Y
3 A A R P PHARMACY
CA
90848
V
Y
4 A A R P PHARMACY
CT
06167
V
Y
5 A C
NJ
08401
V
6 A C NIELSEN
TX
79966-79974
V
Y
7 A H MCCOY FEDERAL BLDG
MS
39269
V
8 A M F GREENSBORO
NC
27425
V
1=Help
3=Quit
4=SC
5=CZ
8=Down
9=Mat
10=Flip
Calling G1CP1
The G1CP1 input call area has one call parameter. The call area accesses the
interactive database inquiry screen in Flip mode and optionally positioned at a city
name of your choice. Flip mode displays the database inquiry information only.
For example,
CALL G1C1PGMS/G1CP1 PARM(‘FLIP;L cityname’)
(cityname refers to the city to which you want the screen positioned.)
NOTE: All characters in the above parameter must be in uppercase letters.
Working With CODE-1 Plus
361
8
Calling CODE-1 Plus Matching and Analyzer Modules
The database inquiry screen appears positioned at the city that you specified.
CODE-1 Plus Coding System
--------------------------------------------------------------------------Command:
__ of __
City Information
LN
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
City
LANHAM
LANHAM
LANHAM
LANHAM
LANHAM
LANHAM SEABRK
LANHAM-SEABRK
LANHAM-SEABROOK
LANIER
LANKIN
LANNON
LANOKA HARBOR
LANSDALE
LANSDALE
LANSDOWNE
LANSDOWNE
1=Help
362
2=ZC
3=Quit
ST
MD
MD
NE
TX
WV
MD
MD
MD
TX
ND
WI
NJ
CA
PA
MD
PA
4=SC
5=CZ
ZIP Range
20784
20703-20706
68415
76538
25159
20703-20706
20703
20703-20706
75563
58250
53046
08734
94960
19446
21227
19050
7=Up
8=Down
Type Urb
V
P
V
V
S
S
V
V
V
P
P
P
V
P
S
P
9=Mat
Unique ZIP
10=Flip
Software Release 4.0.0/March 2015
CHAPTER 9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
This chapter discusses the callable routines C1PRPT and C1CTYLKP. C1PRPT allows
you to print the CODE-1 Plus reports without using C1BM00, the Pitney Bowesprovided CODE-1 Plus batch driver. By using C1PRPT, you can call
CODE-1 Plus from your own applications and still generate the CODE-1 Plus
reports. C1CTYLKB enables you to match ZIP Codes to city/state combinations.
G1CPLKB enables you to browse the CODE-1 Plus database from your own
application.
What is C1PRPT? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling C1PRPT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The C1PRPT Call Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is C1CTYLKP? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ZIP Code Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
City and State Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ZIP Code and City/State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calling C1CTYLKP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
The C1CTYLKP Call Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What is G1CPLKB? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
G1CPLK-USER-REQUEST-AREA . . . . . . . . . . . . . . . . . . . . . . . . .
G1CPLK-USER-RESULT-AREA . . . . . . . . . . . . . . . . . . . . . . . . . . .
G1CPLK-IPC-AREAS-LENGTH . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working With CODE-1 Plus
364
365
367
377
377
378
378
378
379
379
383
384
388
390
363
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
What is C1PRPT?
C1PRPT is a callable routine that you can use to generate the CODE-1 Plus reports
when you are calling CODE-1 Plus from your own batch driver. The CODE-1 Plus
batch driver provided by Pitney Bowes prints these reports:
•
NDI Report
•
Control Totals Report
•
Analysis of Matched Records Report
•
Address-Match Execution Statistics Report
•
ZIP + 4 Coding by State
•
Carrier Route Coding by State
•
Line of Travel Coding by State
•
ZIP + 4 Coding by List Code
•
Carrier Route Coding by List Code
•
Line of Travel Coding by List Code
•
ZIP + 4 Coding by 3-Digit ZIP Code
•
Carrier Route Coding by 3-Digit ZIP Code
•
Line of Travel Coding by 3-Digit ZIP Code
•
Processing Summary by State
•
Processing Summary by List Code
•
Processing Summary by 3-Digit ZIP Code.
You can specify which of these reports are to be printed, based on information in the
call area passed to C1PRPT. You also have the option of producing these reports in
all upper case or in upper and lower case.
NOTE: The USPS Form 3553 will not be printed from C1PRPT. Current USPS
regulations require any user-written program calling CODE-1 Plus for the
purpose of claiming automation discounts to undergo CASS certification.
Therefore, the user-written program must generate and print the USPS Form
3553.
364
Software Release 4.0.0/March 2015
Calling C1PRPT
9
Calling C1PRPT
When you call C1PRPT, you must pass the P9IN, P9OUT, P9AUDIT, and C1PRPT call
areas, in that order. The P9IN, P9OUT, and P9AUDIT areas are the same areas that
you use when you call the C1MATCHx modules.
NOTE: You must initialize the C1PRPT call area to spaces and the counters to
zeros prior to your first call to C1PRPT. The COBOL copy member RPTPARM is
provided in the G1C1PGMS/SOURCE member.
Each time you place a call to the C1MATCHx, you must also call C1PRPT (i.e., call
C1PRPT once for each input record in your file, plus once more to close processing).
On all but the last call to C1PRPT, C1PRPT compiles statistics based on the match
results of each record. On the last call (as indicated by an E in P9IFNC), C1PRPT
prints the requested reports, using the statistics compiled on previous calls.
Between each call to C1MATCHx and C1PRPT, you must increase the counters for
the number of input records read (RP-CT-AMA) and the number of input records
processed (RP-CT-PRC). Additionally, you must reset the return code fields in the
C1PRPT call area to reflect the return codes from C1MATCHx for your input record.
These return code fields are RP-BM0ARC, RP-BM0CRC, RP-BM0SRC, RP-BM05RC,
18RP-BM09RC, and RP-BM0LOT.
Please refer to the following example call program (continued on the next page) for
clarification of the issues discussed above.
0050-INITIALIZE.
* INITIALIZE FOR C1PRPT ROUTINE
MOVE SPACES TO C1PRPT-CALL
MOVE ZEROS TO
RP-CT-NAM
RP-CT-PRC
RP-CT-BYP
RP-CT-COK
RP-CT-NCO
RP-CT-IZP
RP-CT-ZP4
RP-CT-AMA
RP-CT-VAL
RP-CT-APO
RP-CT-MIL
RP-CT-GOV
* OTHER INITIALIZATION LOGIC
...
0050-EXIT. EXIT.
0100-MAIN-LOOP.
* READ INPUT RECORD
PERFORM 0200-GET-INPUT-RECORD THRU 0200-EXIT
IF END-OF-FILE
PERFORM 0800-WRAPUP
ELSE
Working With CODE-1 Plus
THRU 0800-EXIT
365
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
ADD 1 TO RP-CT-NAM
* MANIPULATE INPUT
PERFORM 0300-PROCESS-RECORD THRU 0300-EXIT
IF BYPASS-THIS-RECORD
ADD 1 TO RP-CT-BYP
PERFORM 0350-BYPASS-PROCESS THRU 0350-EXIT
ELSE
* INITIALIZE P9IN FIELDS
PERFORM 0400-SETUP-P9IN THRU 0400-EXIT
CALL 'C1MATCHx' USING P9IN P9OUT P9AUDIT
ADD 1 TO RP-CT-AMA
ADD 1 TO PR-CT-PRC
MOVE
MOVE
MOVE
MOVE
MOVE
P9OSAR
P9OCRC
P9OSRC
P9O5RC
P9O9RC
TO
TO
TO
TO
TO
RP-BM0ARC
RP-BM0CRC
RP-BM0SRC
RP-BM05RC
RP-BM09RC
* THE PR-BMOXXX CODES ABOVE CAN BE ADJUSTED AS REQUIRED
...
CALL 'C1PRPT' USING P9IN P9OUT P9AUDIT RPTPARM
* PROCESS OUTPUT AND WRITE IT
ADD 1 TO RP-CT-COK
PERFORM 0500-WRITE THRU 0500-EXIT.
0100-EXIT. EXIT.
...
0800-WRAPUP.
MOVE 'E' TO P9IFNC
CALL 'C1MATCHx' USING P9IN P9OUT P9AUDIT
* SET THE REPORT SELECTION FLAGS
MOVE 'Y' TO RP-RPNDI
...
* SET THE REPORT DATE, HEADER, ADDITIONAL HEADERS & FOOTERS
...
CALL 'C1PRPT' USING P9IN P9OUT P9AUDIT RPTPARM.
0800-EXIT. EXIT.
366
Software Release 4.0.0/March 2015
Calling C1PRPT
9
The C1PRPT Call Area
The following table provides a map of the 1,348-byte C1PRPT call area.
NOTE: A copybook, RPTPARM, of this area is provided it's in the G1C1PGMS/
SOURCE member.
Table 1: C1PRPT Call Area (Part 1 of 10)
Position
Name
Length
Contents
The following detail-level parameters are used for all but the last call to C1PRPT.
1
Working With CODE-1 Plus
RP-RETURNCODE
1
A code filled in by C1PRPT when control is passed
back to your driver program. It will contain one of
the following codes:
Blank
C1PRPT encountered no problems during
processing.
E
C1PRPT encountered an error. Look for a
message in your print file.
367
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
Table 1: C1PRPT Call Area (Part 2 of 10)
Position
2
Name
RP-BM0ARC
Length
1
Contents
A code indicating whether or not the standardized
address was stored in the output record, and if not,
why not. Your driver should construct this field by
moving the value that is in the P9OSAR area (as
returned by C1MATCHx) to the RP-BM0ARC area.
RP-BM0ARC will then contain one of the following
values:
Blank
The standardized address was stored
successfully.
A
Apartment number missing or not found in
database, and an apartment level match
was required.
B
Insufficient (or blank) address information
for a match.
H
House/Box number not found on street.
M
Multiple matches of equal quality were
found.
S
Street name not found in ZIP Code.
U
Auxiliary File Processing unavailable.
Z
ZIP Code not found in database.
Additionally, if P9OSAR was blank, your driver
program may place one of the following codes in
this area:
C
The address probable correctness or
overall probable correctness was too high.
D
Information was dropped.
L
The standardized address was too long.
M
Multiple ZIP Codes or multiple
standardized addresses were found.
N
The standardized address wasn't stored
because the processing requirements
specified that it was not to be stored.
If any other value is in RP-BM0ARC, the report
program will assume that the standardized address
was not stored for some unknown reason.
368
Software Release 4.0.0/March 2015
Calling C1PRPT
9
Table 1: C1PRPT Call Area (Part 3 of 10)
Position
3
Name
RP-BM0CRC
Length
1
Contents
A code indicating whether or not the carrier route
was stored in the output record, and if not, why not.
Your driver should construct this field by moving the
value that is in the P9OCRC area (as returned by
C1MATCHx) to the RP-BM0CRC area. RP-BM0CRC
will then contain one of the following values:
Blank
The carrier route was stored successfully.
A
Apartment number missing or not found in
database, and an apartment level match
was required.
B
Insufficient (or blank) address information
for a match.
H
House/Box number not found on street.
M
Multiple matches of equal quality were
found.
S
Street name not found in ZIP Code.
U
Auxiliary File Processing unavailable.
Z
ZIP Code not found in database.
Additionally, if P9OCRC was blank, your driver
program may place one of the following codes in
this area:
C
The address probable correctness or
overall probable correctness was too high.
D
Information was dropped.
L
The standardized address was too long.
M
Multiple ZIP Codes or multiple
standardized addresses were found.
N
The carrier route wasn't stored because the
processing requirements specified that it
was not to be stored.
If any other value is in RP-BM0CRC, the report
program will assume that the carrier route was not
stored for some unknown reason.
Working With CODE-1 Plus
369
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
Table 1: C1PRPT Call Area (Part 4 of 10)
Position
4
Name
RP-BM0SRC
Length
1
Contents
A code indicating whether or not the standardized
city and state were stored in the output record, and
if not, why not. Your driver should construct this
field by moving the value that is in the P9O5RC area
(as returned by C1MATCHx) to the RP-BM0SRC
area. This field is constructed from the P9O5RC,
which is the return code for the 5-digit ZIP Code.
RP-BM0SRC will contain one of the following
values:
Blank
The input ZIP Code was stored successfully.
Z
ZIP Code not found in database.
A
Apartment number missing or not found in
database, and an apartment level match
was required.
B
Insufficient (or blank) address information
for a match.
H
House/Box number not found on street.
M
Multiple matches of equal quality were
found.
S
Street name not found in ZIP Code.
Additionally, if P9O5RC was blank, your driver
program may place one of the following codes in
this area:
C
The address probable correctness or
overall probable correctness was too high.
D
Information was dropped.
L
The standardized address was too long.
M
Multiple ZIP Codes or multiple
standardized addresses were found.
N
The standardized city and state were not
stored because the processing
requirements specified that it was not to be
stored.
X
No city match was found and we chose not
to store the default name (i.e, P9OOCR was
not a blank and the default name returned
by C1MATCHx was not stored).
If any other value is in RP-BM05RC, the report
program will assume that the standardized city and
state were not stored for some unknown reason.
370
Software Release 4.0.0/March 2015
Calling C1PRPT
9
Table 1: C1PRPT Call Area (Part 5 of 10)
Position
5
Name
RP-BM05RC
Length
1
Contents
A code indicating whether or not the matched 5-digit
ZIP Code was stored in the output record, and if not,
why not. Your driver should construct this field by
moving the value that is in the P9O5RC area (as
returned by C1MATCHx) to the RP-BM05RC area.
RP-BM05RC will then contain one of the following
values:
Blank
The ZIP Code was stored successfully.
A
Apartment number missing or not found in
database, and an apartment level match
was required.
B
Insufficient (or blank) address information
for a match.
E
External match — Auxiliary File Processing.
H
House/Box number not found on street.
M
Multiple matches of equal quality were
found.
S
Street name not found in ZIP Code.
Z
ZIP Code not found in database.
Additionally, if P9O5RC was blank, your driver
program may place one of the following codes in
this area:
C
The address probable correctness or
overall probable correctness was too high.
D
Information was dropped.
L
The standardized address was too long.
M
Multiple ZIP Codes or multiple
standardized addresses were found.
N
The matched ZIP Code wasn't stored
because the processing requirements
specified that it was not to be stored.
If any other value is in RP-BM05RC, the report
program will assume that the matched ZIP Code
was not stored for some unknown reason.
Working With CODE-1 Plus
371
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
Table 1: C1PRPT Call Area (Part 6 of 10)
Position
6
Name
RP-BM09RC
Length
1
Contents
A code indicating whether or not the matched ZIP +
4 Code was stored in the output record, and if not,
why not. Your driver should construct this field by
moving the value that is in the P9O9RC area (as
returned by C1MATCHx) to the RP-BM09RC area.
RP-BM09RC will then contain one of the following
values:
Blank
The ZIP + 4 Code was stored successfully.
A
Apartment number missing or not found in
database, and an apartment level match
was required.
B
Insufficient (or blank) address information
for a match.
H
House/Box number not found on street.
M
Multiple matches of equal quality were
found.
S
Street name not found in ZIP Code.
U
Auxiliary File Processing unavailable.
V
The input record matched a nondeliverable address.
NOTE: A non-deliverable ZIP + 4 range is
typically a new ZIP range where the USPS
has not finalized assignments of ZIP + 4
codes, thus not permitting assignment of
postal code information at this time.
Z
ZIP Code not found in database.
Additionally, if P9O9RC was blank, your
driver program may place one of the
following codes in this area:
C
The address probable correctness or
overall probable correctness was too high.
D
Information was dropped.
L
The standardized address was too long.
M
Multiple ZIP Codes or multiple
standardized addresses were found.
N
The matched ZIP + 4 Code wasn't stored
because the processing requirements
specified that it was not to be stored.
If any other value is in RP-BM09RC, the report
program will assume that the matched ZIP + 4 Code
was not stored for some unknown reason.
372
Software Release 4.0.0/March 2015
Calling C1PRPT
9
Table 1: C1PRPT Call Area (Part 7 of 10)
Position
7
Name
RP-BM0LOT
Length
1
Contents
A code indicating the level of match obtained against
the Line of Travel masterfile. Your driver should
construct this field by moving the value that is in the
P9OLOT area (as returned by C1MATCHx) to the RPBM0LOT area. RP-BM0LOT will then contain one of
the following values:
Blank
Invalid input (zero or non-numeric ZIP/
ZIP + 4 add-on)
9
9-digit ZIP + 4 match successful
C
Call to LTO10/LTO10C failed
D
Unsuccessful 9-digit match, default coded
F
Open/read failure on Line of Travel master
file
V
Line of Travel matcher software not
compatible with the Line of Travel master
file
Additionally, if P9OLOT was blank, your driver
program may place one of the following codes in
this area:
C
The address probable correctness or
overall probable correctness was too high.
D
Information was dropped.
L
The standardized address was too long.
M
Multiple ZIP Codes or multiple
standardized addresses were found.
N
The matched ZIP + 4 Code wasn't stored
because the processing requirements
specified that it was not to be stored.
If any other value is in RP-BM0LOT, the report
program will assume that the matched LOT code
was not stored for some unknown reason.
8-16
RP-LCDNEW
9
The list code for the current record.
17
RP-INP-ZP4
1
A code indicating if an input ZIP + 4 Code was
defined for the input file. Moved for every record
whether it was a blank or not.
18-21
RP-INP-ZP4-VAL
4
The ZIP + 4 Code that was in the input record, if RPINP-ZP4 is Y.
22-57
Reserved
36
The following total-level parameters are used for the last call to C1PRPT. These areas are not
referenced for any call to C1PRPT except the last.
NOTE: All of these fields should be initialized to zero and then updated by your own program, as
necessary.
58-67
Working With CODE-1 Plus
RP-CT-NAM
10
A counter that reflects the number of input records
read.
373
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
Table 1: C1PRPT Call Area (Part 8 of 10)
Position
Name
Length
Contents
68-77
RP-CT-PRC
10
A counter that reflects the number of input records
processed.
78-87
RP-CT-BYP
10
A counter that reflects the number of input records
bypassed.
88-97
RP-CT-COK
10
A counter that reflects the number of records
written to the C1BMCOK (or equivalent) output file.
98-107
RP-CT-ZP4
10
A counter that reflects the number of records
written to the C1BMZP4 (or equivalent) output file.
108-117
RP-CT-NCO
10
A counter that reflects the number of records
written to the C1BMNCO (or equivalent) output file.
118-127
RP-CT-IZP
10
A counter that reflects the number of records
written to the C1BMIZP (or equivalent) output file.
128-137
RP-CT-AMA
10
A counter that reflects the number of calls made to
the address match routine.
138-147
RP-CT-VAL
10
A counter that reflects the number of records that
were confirmed without processing due to a flag in
the records.
148-157
RP-CT-APO
10
A counter that reflects the number of records that
were confirmed without processing due to APO ZIP
Codes.
158-167
RP-CT-MIL
10
A counter that reflects the number of records that
were confirmed without processing due to military
ZIP Codes.
168-177
RP-CT-GOV
10
A counter that reflects the number of records that
were confirmed without processing due to
government agency ZIP Codes.
178-227
N/A
50
These bytes are reserved.
NOTE: All of the report flags listed below default to Y except the RP-RPNDI report flag, which defaults
to N.
228
229
374
RP-RPNDI
RP-RPANMR
1
1
A code that indicates whether or not the National
Deliverability Index (NDI) Report should be printed.
Y
Print the report (default).
N
Do not print the report.
A code that indicates whether or not the Analysis of
Matched Records Report should be printed.
Y
Print the report (default).
N
Do not print the report.
Software Release 4.0.0/March 2015
Calling C1PRPT
9
Table 1: C1PRPT Call Area (Part 9 of 10)
Position
230
231
232
233
234
235
236
237
238
Working With CODE-1 Plus
Name
RP-RPZ4ST
RP-RPCRST
RP-RPLTST
RP-RPZ4LC
RP-RPCRLC
RP-RPLTLC
RP-RPZ43D
RP-RPCR3D
RP-RPLT3D
Length
1
1
1
1
1
1
1
1
1
Contents
A code that indicates whether or not the ZIP + 4
Coding by State Report should be printed.
Y
Print the report (default).
N
Do not print the report.
A code that indicates whether or not the Carrier
Route Coding by State Report should be printed.
Y
Print the report (default).
N
Do not print the report.
A code that indicates whether the Line of Travel
Coding by State Report should be printed.
Y
Print the report (default).
N
Do not print the report.
A code that indicates whether or not the ZIP + 4
Coding by List Code Records Report should be
printed.
Y
Print the report (default).
N
Do not print the report.
A code that indicates whether or not the Carrier
Route Coding by List Code Report should be printed.
Y
Print the report (default).
N
Do not print the report.
A code that indicates whether the Line of Travel
Coding by List Code Report should be printed.
Y
Print the report (default).
N
Do not print the report.
A code that indicates whether or not the ZIP + 4
Coding by 3-Digit ZIP Code Report should be
printed.
Y
Print the report (default).
N
Do not print the report.
A code that indicates whether or not the Carrier
Route Coding by 3-Digit ZIP Code Report should be
printed.
Y
Print the report (default).
N
Do not print the report.
A code that indicates whether the Line of Travel
Coding by 3-Digit ZIP Report should be printed.
Y
Print the report (default).
N
Do not print the report.
375
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
Table 1: C1PRPT Call Area (Part 10 of 10)
Position
239
240
241
242
376
Name
RP-RPSMST
RP-RPSMLC
RP-RPSM3D
RP-RPUPLO
Length
1
1
1
1
Contents
A code that indicates whether or not the Summary
by State Report should be printed.
Y
Print the report (default).
N
Do not print the report.
A code that indicates whether or not the Summary
by List Code Report should be printed.
Y
Print the report (default).
N
Do not print the report.
A code that indicates whether or not the Summary
by 3-Digit ZIP Code Report should be printed.
Y
Print the report (default).
N
Do not print the report.
A code indicating whether or not the reports should
be printed in all upper case.
Y
Print the reports in all upper case (default).
N
Print the reports in mixed case.
243-252
RP-DATE
10
The date that is to be printed at the top of the
reports.
253-292
RP-HEADER
40
The main header that is to be printed at the top of
the reports.
293-424
RP-UHD-(1)
132
The first line of the additional header that is to be
printed at the top of the reports.
425-556
RP-UHD-(2)
132
The second line of the additional header that is to be
printed at the top of the reports.
557-688
RP-UHD-(3
132
The third line of the additional header that is to be
printed at the top of the reports.
689-820
RP-UHD-(4)
132
The fourth line of the additional header that is to be
printed at the top of the reports.
821-952
RP-UFT-(1)
132
The first line of the footer that is to be printed at the
bottom of the reports.
953-1084
RP-UFT-(2)
132
The second line of the footer that is to be printed at
the bottom of the reports.
10851216
RP-UFT-(3)
132
The third line of the footer that is to be printed at the
bottom of the reports.
12171348
RP-UFT-(4)
132
The fourth line of the footer that is to be printed at
the bottom of the reports.
Software Release 4.0.0/March 2015
What is C1CTYLKP?
9
What is C1CTYLKP?
C1CTYLKP is a COBOL subroutine that you can call from your own program; it uses
your copy of the CODE-1 Plus database to obtain its results. C1CTYLKP allows you
to match ZIP Codes to city/state combinations. By using C1CTYLKP, you can have
CODE-1 Plus retrieve a city/state for a given ZIP Code, a ZIP Code for a given city/
state (see important restrictions below), or provide verification that a given ZIP Code
and city/state combination is correct. C1CTYLKP can also be used to retrieve
detailed information for a given city/state, including the short city name.
NOTE: C1CTYLKP can return a correct ZIP Code for a given city/state only if the
city/state has a unique ZIP Code. Many cities have more than one ZIP Code
assigned to them. When this is the case, C1CTYLKP returns the lowest ZIP Code
in the range of the ZIP Codes for the input city/state and all the ZIP Codes that
the city/state falls within. This answer must be considered to be unreliable, as
C1CTYLKP has no way to determine which ZIP Code is the correct one. When this
is the case, the only reliable information returned is the short city name, long city
name, and state abbreviation.
If at all possible, sort your input file in ZIP Code sequence before it is run through
C1CTYLKP. This gives you the best possible performance. If this is not possible,
sort the file by city name to produce the next best performance level.
C1CTYLKP can provide three different functions, depending upon the type of data
that is passed from the calling program. The functions for each data type are
described in the following sections.
ZIP Code Only
When C1CTYLKP is passed only a ZIP Code with no city/state, it attempts to return
a city/state for that ZIP Code, as follows:
1. If a primary city/state is found on the database for the ZIP Code, it is returned.
2. If no primary city/state is found for that ZIP Code, the first secondary city/state
combination is returned, if one exists.
3. If no primary or secondary city/state is found for the input ZIP Code, the first
city/state on the database that matches the ZIP Code is returned.
Working With CODE-1 Plus
377
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
NOTE: Under certain conditions, no city/state is returned. For example, if vanity
city names are not allowed, and only vanity cities are found for a ZIP Code, no city/
state is returned.
City and State Only
When C1CTYLKP is passed the city and state without a ZIP Code, C1CTYLKP
attempts to return the ZIP Code for that city and state. C1CTYLKP can return a
correct ZIP Code for a given city/state only if the city/state has a unique ZIP Code.
Many cities have more than one ZIP Code assigned to them. When this is the case,
C1CTYLKP returns the lowest ZIP Code in the range of the ZIP Codes for the input
city/state and all the ZIP Codes that the city/state fall within. This answer must be
considered to be unreliable, as C1CTYLKP has no way to determine which ZIP Code
is the correct one. When this is the case, the only reliable information returned is the
short city name, long city name, and state abbreviation.
ZIP Code and City/State
When C1CTYLKP is passed the ZIP Code and the city and state, it attempts to find a
match for the ZIP Code as if only the ZIP Code was passed. If a match is found,
C1CTYLKP attempts to find the input city/state on the list of city/states for the input
ZIP Code. If the city/state is not found within the ZIP Code, a new city/state is
returned (following the rules for determining a city/state when only a ZIP Code is
passed). If the input ZIP Code is not on the database, C1CTYLKP performs as if only
a city and state were passed. If neither the input ZIP Code nor the input city and state
are found on the database, no match is returned.
Output Results
When a match is found for an input ZIP Code, city and state, or combination, the
following information is returned to your program:
378
•
USPS City name
•
USPS Short city name
•
USPS State abbreviation
•
City type (primary, secondary, or vanity)
•
USPS Finance number
•
USPS Last line number
Software Release 4.0.0/March 2015
Calling C1CTYLKP
9
•
A table of up to 100 cities that are found to be within the returned ZIP Code.
Each entry in the table contains the information listed above.
•
A table of up to 999 ZIP Codes that a city/state falls within. Each entry includes
the information listed above including the USPS ZIP Code.
•
USPS ZIP Code
•
Return Codes indicating the results of the match attempt
•
Audit trail information showing I/O counts.
Vanity City Names
A field has been provided in the calling interface that indicates whether vanity city
names are to be allowed or not allowed. Not allowing vanity city names can prevent
any city names from being returned, if the only cities for the ZIP Code are vanity
cities. If the input city name is a vanity city name, and vanity city names are allowed,
the output city name can be a vanity city name if one is found on the database. If
vanity city names are not allowed, only primary or secondary city names is returned.
Calling C1CTYLKP
When you call C1CTYLKP, you must pass a ZIP Code, a city and state, or all of the
above. In addition, you can set the Vanity City flag to “X” if you want to allow vanity
city names to be returned. Finally, there is also a function code that should be set to
“E” when making the last call to C1CTYLKP to have C1CTYLKP close its open files.
This should be done after the last match attempt has been made, but before
terminating the calling program.
A COBOL copy member called CSPRM is supplied with the CODE-1 Plus software.
Please use this copy member when calling C1CTYLKP.
A sample driver, C1SMCCTY, is distributed with the software. This sample driver calls
the CICTYLKB program.
The C1CTYLKP Call Area
The following table shows you a map of the 14,523-byte C1CTYLKP call area.
Working With CODE-1 Plus
379
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
NOTE: A copybook, called CSPRM, of this area is provided on your installation
tape.
Table 2: The C1CTYLKx Call Area (Part 1 of 4)
Position
Length
Contents
1-5
CS-PRM-ZIPI
5
The input ZIP Code.
6-105
CS-PRM-CSTI
100
The input city and state.
106
CS-PRM-FNC
1
The input function code. Leave this blank for a match
call, set this to E for the final call.
107
CS-PRM-VANITYCTY
1
The vanity city name flag. If you want C1CTYLKx to
return vanity city names, set this to X. Otherwise,
when C1CTYLKx matches a vanity city, it will return
the primary or secondary city name.
108-117
CS-PRM-DBL
10
Database library name (IBM i specific).
118-150
Reserved
33
151
CS-PRM-GRC
1
152
380
Name
CS-PRM-INPUTZIP-RC
1
The general return codes for the match attempt. One
of the following codes is returned:
blank
Match was successful.
A
The original ZIP Code was altered to match a
single-ZIP city.
B
Insufficient information for a match.
D
City-state mismatch (different spelling
found, or city-state was a vanity name and
vanity matching was not allowed, or citystate did not match ZIP Code).
E
End of job encountered, so the job was
terminated.
L
The original ZIP Code was altered to be the
lowest ZIP Code of the matched city's ZIP
Code range. This is an unreliable answer.
M
Multiple matches on city-state.
X
CODE-1 Plus master file has expired;
processing aborted.
Z
ZIP Code not found in the database.
The input ZIP Code return code. One of the following
codes is returned:
Blank
Match was successful.
B
Original ZIP Code no good, or blank.
Z
ZIP Code not found in database.
Software Release 4.0.0/March 2015
Calling C1CTYLKP
9
Table 2: The C1CTYLKx Call Area (Part 2 of 4)
Position
153
154
155
Name
CS-PRMOUTPUT-ZIP-RC
CS-PRM-INPUTCITY-RC
CS-PRMOUTPUT-CITY-RC
Length
1
1
1
Contents
The output ZIP Code return code. One of the following
codes is stored:
A
The original ZIP Code was altered to match a
single-ZIP city.
B
Original ZIP Code no good, or blank.
C
Original ZIP Code was confirmed.
L
The original ZIP Code was altered to be the
lowest ZIP Code of the matched city's ZIP
Code range. This is an unreliable answer.
Z
The ZIP Code was not found in the database.
The input city return code. One of the following codes
is stored:
Blank
Match was successful.
B
Input city was blank, or no match found.
The output city return code. One of the following
codes is stored:
Blank
Match was successful.
B
Input city was blank, or no match found.
D
City-state mismatch (different spelling
found, or city-state was a vanity name and
vanity matching was not allowed, or citystate did not match ZIP Code).
M
Multiple matches on city-state.
156-170
Reserved
15
171-198
CS-PRM-CITYO
28
The output USPS full city name
199-211
CS-PRM-SHORTCITYO
13
The output USPS short city name.
212-213
CS-PRM-STATEO
2
The output USPS state abbreviation.
214
CS-PRM-CTYPEO
1
The output city type for the matched city name. One
of the following codes is stored:
P
Primary
S
Secondary
V
Vanity.
215-220
CS-PRM-FINO
6
The output USPS finance number for the matched
city name.
221-226
CS-PRM-LL-LBO
6
The USPS last line number for the output city/state/
ZIP Code combination.
227-231
CS-PRM-ZIPO
5
The output USPS ZIP Code.
Working With CODE-1 Plus
381
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
Table 2: The C1CTYLKx Call Area (Part 3 of 4)
Position
232
233
Name
CS-PRM-SZIP
CS-PRM-NUMZIP-ENTRIES
Length
1
3
Contents
A code indicating whether there is more than one ZIP
Code in the input city. If a successful match based on
the input ZIP Code is obtained, this code will not be
set. One of the following codes is stored:
Blank
This city has more than one ZIP Code.
S
This city has only a single ZIP Code.
The number of ZIP Codes that are in the output table
of ZIP Codes for the input city/state.
The following CSP-ZIP CODE field occurs 999 times.
The previous CS-PRM-NUM-ZIP-ENTRIES field indicates the number of occurrences that are nonblank.
236-240
(1st
occurren
ce)
CSP-ZIP-CODE
5
The output USPS ZIP Code.
52315233
CS-PRM-NUMCITY-ENTRIES
3
The number of cities that are in the output table of
cities for the input ZIP Code. The maximum is 150
times.
The following fields occur 150 times.
The previous CS-PRM-NUM-CITY-ENTRIES field indicates the number of occurrences that are nonblank.
382
5234 (1st
occurren
ce)
CSP-CITYO
28
The output USPS city name.
5262 (1st
occurren
ce)
CSP-SHORTCITYO
13
The output USPS short city name.
5275 (1st
occurren
ce)
CSP-STATEO
2
The output USPS state name.
5277 (1st
occurren
ce)
CSP-CTYPEO
1
The output city type. One of the following codes is
stored:
P
Primary
S
Secondary
V
Vanity.
5278 (1st
occurren
ce)
CSP-FINO
6
The output USPS finance number.
5284 (1st
occurren
ce)
CSP-LL-LBO
6
The output USPS last line number.
Software Release 4.0.0/March 2015
What is G1CPLKB?
9
Table 2: The C1CTYLKx Call Area (Part 4 of 4)
Position
Name
Length
5290 (1st
occurren
ce)
CSP-ZIP-TABLE
5
1438414433
Reserved
50
Contents
The output USPS ZIP Code.
The following fields are statistical fields for the audit trail.
14,434 14,442
CS-PRM-READCTY
9
The number of times a read request was made for the
cities in a ZIP Code logical file.
14,443 14,451
CS-PRM-READZPX
9
The number of times a read request was made for the
ZIP Codes in a city logical file.
14,452 14,460
CS-PRM-READLCL
9
The number of times a read request was made for the
locality street directory logical file.
14,461 14,478
Reserved
18
14,479 14,487
CS-PRM-IO-CTY
9
The number of actual I/O calls that were made to the
cities in a ZIP Code logical file.
14,488 14,496
CS-PRM-IO-ZPX
9
The number of actual I/O calls that were made to the
ZIP Codes in a City logical file.
14,497 14,505
CS-PRM-IO-LCL
9
The number of actual I/O calls that were made to the
locality street directory logical file.
14,506 14,523
Reserved
18
What is G1CPLKB?
The G1CPLKB callable module enables you to browse the contents of the
CODE-1 Plus database. The following is a list of the three areas that G1CPLKB uses:
•
G1CPLK-USER-REQUEST-AREA—controlled by the caller and contains all
information pertinent to the input request (150 bytes).
•
G1CPLK-USER-RESULT-AREA—accessed by the caller and should not be
modified. It contains all information necessary to produce the output (2,450
bytes).
•
G1CPLK-IPC-AREAS—used and accessed by G1CPLKB and should not be
modified (a minimum of 0 bytes and maximum of 10,000 bytes).
Working With CODE-1 Plus
383
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
Calling G1CPLKC
Pitney Bowes provides the sample program G1CPDSM, which calls the G1CPLKC
callable routine for your platform. The following example is a sample from G1CPDSM.
For the most current version, please refer to G1CPDSM included with your CODE-1
Plus software.
01 WS-C1P-DBLOOK-PGM
PIC X(8) VALUE ’G1CPLKC’.
01 WS-MISC-LENGTHS.
05 WS-LENGTH-DBLOOK-AREAS
PIC S9(04) COMP.
.
01 WS-C1P-DBLOOK-AREAS COPY LOOKREQ.
.
MOVE LENGTH OF WS-C1P-DBLOOK-AREAS TO WS-LENGTH-DBLOOK-AREAS.
EXEC CICS LINK
PROGRAM (WS-C1P-DBLOOK-PGM)
COMMAREA (WS-C1P-DBLOOK-AREAS)
LENGTH (WS-LENGTH-DBLOOK-AREAS)
END-EXEC.
To ensure the integrity of the database to be passed, initialize the following areas in
the calling program, along with any other fields accessing data to be passed:
•
Move spaces to G1CPLK-USER-REQUEST-AREA
•
Move LOW-VALUES to G1CPLK-MAX-RETURN-CONTROL.
NOTE: The CODE-1 Plus installation contains sample copybooks for COBOL and
RPG.
G1CPLK-USER-REQUEST-AREA
The following table provides a map of the user input call area for G1CPLKx.
384
Software Release 4.0.0/March 2015
What is G1CPLKB?
9
Table 3: G1CPLK-USER-REQUEST-AREA Call Area (Part 1 of 3)
Name
G1CPLK-COMMAND
Working With CODE-1 Plus
Length
6
Contents
This field is required for all G1CPLKx calls, and specifies the
command executed by G1CPLKx. Type one of the following:
AH
G1CPLKx returns all the apartments within a specific
house range. For each apartment, the results rows
display the address, ZIP Code range, apartment
number ranges, ZIP Codes, ZIP + 4 Code ranges, carrier
route codes, USPS record types, and number of firms.
You may execute this command only immediately after
an HS command.
CM
G1CPLKx returns an alphabetical listing of all the cities
within the CODE-1 Plus database. For each city, the
results row displays the state abbreviation and the ZIP
Code (or range of ZIP Codes) valid for the city.
CS
G1CPLKx returns an alphabetical listing of all the cities
within the specified state. For each city, the results row
displays the state abbreviation state and the ZIP Code
(or range of ZIP Codes) valid for the city.
CZ
G1CPLKx returns an alphabetical listing of all the cities
within the specified ZIP Code. For each city, the results
row displays the long city names, short city names, and
city type.
FM
G1CPLKx returns all the firms within the specified
street. The results rows display the house number
ranges, apartment number ranges within a dwelling,
the name of the firm located at each apartment/suite,
ZIP Codes, ZIP + 4 Codes, and carrier route codes. You
may execute this command only immediately after an
HS or AH command.
HS
G1CPLKx returns all the house ranges within the
specified street. In addition to even/odd house number
ranges, the results rows display ZIP and ZIP + 4 Code
ranges, carrier routes, number of apartments, and
number of firms. You may execute this command only
immediately after an SC or SZ command.
SC
G1CPLKx returns an alphabetical listing of all the
streets within the specified city. For each street, the
results rows display directionals (NE, SW, etc.), suffixes
(ST, BLVD, etc.), number of houses, number of firms,
and ZIP Code ranges. You may execute this command
only immediately after a CM or CS command.
385
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
Table 3: G1CPLK-USER-REQUEST-AREA Call Area (Part 2 of 3)
Name
Length
Contents
G1CPLK-COMMAND, continued
ZC
G1CPLKx returns all ZIP Codes within a specified city.
You may execute this command only immediately after
a CM or CS command.
SZ
G1CPLKx returns an alphabetical listing of all the
streets within the specified ZIP Code. For each street,
the results rows display directionals (NE, SW, etc.),
suffixes (ST, BLVD, etc.), number of houses, number of
firms, and ZIP Code ranges.
OPEN G1CPLKx validates the database version and returns
the database “signature” of the CODE-1 Plus database
currently in use.
QUIT
G1CPLKx closes the database and relinquishes all
work areas.
*
Use the asterisk (*) to continue searching.
BOT
Moves to bottom of current data list — all data
positions.
TOP
Moves to top of current data list — all data positions.
DOWN Moves down in data at same level (equivalent to *).
UP
Moves up in data at same level.
BACK
Returns to previous level. NOTE: If you use the BACK
command, CS and CZ display the Cities screen,
because the Cities screen cannot move back any
farther.
LOCAT Generally positions the database inquiry to the first
entry that starts with <string>.
ALIAS Displays alias information in G1CPLK-ALIASINFO field.
You may execute this command only immediately after
an AH or FM command.
RIGHT Scrolls to right of firm/alias name field. You may
execute this command only immediately after an HS
command.
LEFT
386
Scrolls to original position for firm/alias name field.
You may execute this command only immediately after
an HS command.
Software Release 4.0.0/March 2015
What is G1CPLKB?
9
Table 3: G1CPLK-USER-REQUEST-AREA Call Area (Part 3 of 3)
Name
G1CPLK-SEARCHCRITERIA
Length
105
Contents
This element specifies the various address components used in
the address search for the following commands:
CM
Specify the leading characters of a city name. Blanks
cause the search to begin from the beginning of the
database.
CS
Specify the state abbreviation in the first two
characters. You can specify the leading characters of a
city name.
CZ
Specify a ZIP Code.
HS
Specify the leading characters of a house range
returned in the results.
SC
Specify the leading characters of a street name
returned in the results.
SZ
Specify the leading characters of a street name
returned in the results.
G1CPLK-MAXRETURN-CONTROL
2 (x 6)
This field is required for all G1CPLKx calls (except OPEN) and
consists of six, 2-byte binary fields. Specify the number of data
rows you want returned by the current command. The
maximum is 25. You may access additional rows by
subsequently invoking G1CPLKx multiple times (using the “*”
(asterisk) command). Specify the count desired in the
appropriate counter. There is one counter for each of the
address elements that can be returned. The counters include
the following: G1CPLKx-MAX-CITIES, G1CPLKx-MAXSTREETS, G1CPLKx-MAX-ZIPS, G1CPLKx-MAX-HOUSES,
G1CPLKx-MAX-APTS, and G1CPLKx-MAX-FIRMS. Populate the
desired counter with a value and clear out the rest.
G1CPLK-SELECT
2
Specify the occurrence of data to be used for browsing further
into the database. For example,“02” for second city name to be
used for a street lookup.
Reserved
25
Working With CODE-1 Plus
387
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
G1CPLK-USER-RESULT-AREA
The following table provides a map of the returned information area for G1CPLKB.
Table 4: G1CPLK-USER-RESULT-AREA Call Area (Part 1 of 2)
Name
Length
Contents
G1CPLK-RMSG
79
This field contains any returned error or informational message.
G1CPLKRETURN-CODES
4
G1CPLKx returns one of the following codes:
Blank
The command was successful.
IN01 through IN09
Non-fatal error — An invalid command string was specified in
G1CPLK-COMMAND. The command may be invalid for one of two
reasons:
1
2
It is an illegal command string.
The requested command is not allowed from
this point in the database hierarchy.
IN11
Attempt to back up a level when none exists.
LK01
Fatal error — Invalid command requested.
LK02
Fatal error — Non-numeric SELECT FIELD passed.
LK03
Fatal error — MAX-RETURN-CONTROL counter was out
LK04
Fatal error — Incompatible database found.
0040
Non-fatal error — ZIP Codes do not exist for the selected
0041
Non-fatal error — No firms exist for the selected item.
0042
0043
G1CPLK-IPCAREA-LENGTH
388
2
of range.
item.
Non-fatal error — No houses/apartments exist for the
selected item.
Non-fatal error — No apartments exist for the selected
item.
0045
Non-fatal error — No streets exist for the selected item.
0050
Information — Alias information was returned in the
G1CPLK-ALIASINFO field only. (Usually information is
returned to the table in G1CPLK-DATA-TABL.)
This is a 2-byte binary field, that contains the length of a
communication area used internally. Do not modify this field.
Software Release 4.0.0/March 2015
What is G1CPLKB?
9
Table 4: G1CPLK-USER-RESULT-AREA Call Area (Part 2 of 2)
Name
G1CPLK-DBSIGNATURE
Length
95
Contents
The fields in this group item are populated as the result of the
“OPEN” command. The field contains the month and year string of
the vintage date of the database, as well as the expiration data.
This field includes the following subfields:
• G1CPLK-DB-DATE-STRING. This field contains the database
month and year string for a length of 15.
• G1CPLK-DB-PRODUCT. This field contains the software
product name and version for a length of 50.
• G1CPLK-DB-VINTAGE-DATE. This field contains the database
vintage date in the MM/DD/YY format for a length of 10.
• G1CPLK-DB-QUARTER-DATE. This field contains the database
quarterly vintage date in the MM/DD/YY format for a length of
10.
• G1CPLK-DB-EXPIRATION-DATE. This field contains the
database expiration date in the MM/DD/YY format for a length
of 10.
G1CPLK-LINEBREAKDOWN
79
Used by the caller to examine lines returned by the call. Once a
result set is returned, move each line here for further
examination.
G1CPLK-BEGCOUNT
4
The position of the first database element reserved relative to all
successive data in the database. For example, 40 for the 40th city
in Maryland.
NOTE: This field is packed decimal consisting of 7 nibbles of
binary-coded decimal digits and one nybble of sign.
G1CPLK-ENDCOUNT
4
The relative position of the last data elements available on the
database.
NOTE: This field is packed decimal consisting of 7 nibbles of
binary-coded decimal digits and one nybble of sign.
G1CPLKALIASINFO
80
The type and street name of the house range alias.
G1CPLKRESULT-DATA
96
Data identified by G1CPLKx as required by the user (through
G1CPLK-SELECT) to search further into the data.
G1CPLK-DATATABLE
25 (X 79)
25 occurrences of 79 bytes of data returned from the current
request. The number of occurrences of valid data depends on the
applicable G1CPLK-MAX-RETURN-CONTROL value.
Filler
32
Reserved.
Working With CODE-1 Plus
389
9
Calling C1PRPT, C1CTYLKP, or G1CPLKx
G1CPLK-IPC-AREAS-LENGTH
The following table provides a map of the last area used for G1CPLKB.
Table 5: The G1CPLK-IPC-AREAS LENGTH Call Area
Name
G1CPLK-IPCAREAS
390
Length
10,000
Contents
This area is reserved for inter-program
communications.
(THIS FIELD MUST NEVER BE MODIFIED BY THE
CALLER)
Software Release 4.0.0/March 2015
CHAPTER 10
Using LACSLink
This chapter introduces LACSLink. It describes what LACSLink is and does, its features
and benefits, and what is involved in using LACSLink.
NOTE: The USPS has specific export rules that regulate the distribution of postal
databases. At this time, DPV, LACSLink, and SuiteLink databases are not available to
customers operating outside of the United States. For more information on the USPS
export rules regulating postal databases, go to http://ribbs.usps.gov/.
What is LACSLink? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What are the Benefits of LACSLink?. . . . . . . . . . . . . . . . . . . . . . .
Who is Eligible to Use LACSLink?. . . . . . . . . . . . . . . . . . . . . . . . .
How Does LACSLink Work?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the LACSLink Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How do I Install the LACSLink Option? . . . . . . . . . . . . . . . . . . . . .
Installing the LACS Database . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How Do I Activate LACSLink? . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Activating LACSLink in Batch Mode . . . . . . . . . . . . . . . . . . . .
Activating LACSLink in Interactive Mode . . . . . . . . . . . . . . . .
Activating LACSLink in Callable Mode . . . . . . . . . . . . . . . . . .
LACSLink Processing Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LACSLink Information on USPS Form 3553. . . . . . . . . . . . . . . . .
Seed Record Violations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What If My Mailing Generates a Seed Violation? . . . . . . . . . . . . .
LACSLink Seed Record Reporting . . . . . . . . . . . . . . . . . . . . .
Obtaining a LACSLink License . . . . . . . . . . . . . . . . . . . . . . . .
Working With CODE-1 Plus
392
392
393
393
394
394
395
395
398
398
399
401
403
403
403
404
404
405
391
10
Using LACSLink
What is LACSLink?
LACSLink is a CODE-1 Plus feature that allows users to implement the Locatable
Address Conversion System (LACS) service offered by the USPS. LACS is used to
provide computerized address list correction for addresses in areas affected by rural
route and box numbers to city-style address conversion, and city-style to city-style
address conversions.
LACS provides mailers an automated method of obtaining new addresses when a 911
emergency system has been implemented. The 911 address conversions normally
involve changing rural-style addresses to city-style addresses, but in some instances
conversions may result in the renaming or renumbering of existing city-style
addresses.
NOTE: The USPS regulations require LACSLink processing for CASS certification.
What are the Benefits of LACSLink?
LACSLink provides the following benefits to those who use it:
392
•
Ensures compliancy with USPS CASS regulations. LACSLink processing is a USPS
CASS certification requirement.
•
Ensures preparedness for future USPS CASS regulations. In future CASS cycles,
the USPS may expand LACSLink processing requirements.
•
Reduces undeliverable mail by providing the most current address information
for matches made to the LACSLink file.
•
Prevents the need for duplicate mailpieces or re-mailings after address
corrections are received since the address correction is applied prior to the
mailing.
•
Lowers your costs by reducing the number of undeliverable and/or duplicate
mailpieces by using the most current address information.
•
Provides the opportunity for faster marketing through accurate mail delivery.
Software Release 4.0.0/March 2015
What is LACSLink?
10
Who is Eligible to Use LACSLink?
The LACS service is available only through NCOA licensees. This service is offered as
a stand-alone process or as a back-end process with the NCOA service to ensure a
high quality mailing list. All CODE-1 Plus customers are eligible to use LACSLink.
NOTE: The USPS has specific export rules that regulate the distribution of postal
databases. At this time, DPV, LACSLink, and SuiteLink databases are not available to
customers operating outside of the United States. For more information on the USPS
export rules regulating postal databases, go to http://ribbs.usps.gov/.
How Does LACSLink Work?
LACSLink works in a series of two steps: input address information is standardized to
conform with Postal Service requirements including the ZIP + 4 Code, and then an
attempt is made to match the address against the LACS file. If an exact match is made
with the old address information on the LACS file, the address is updated accordingly.
After LACSLink processing takes place and a match is found, you will receive the
following information from CODE-1 Plus:
•
the original input address from the mailer
•
the input address, standardized and appended with the ZIP + 4 Code, if possible
•
a standardized new address when the standardized input address matches the old
address on the LACS file
•
a National Delivery Index (NDI) report, which includes a breakdown of
deliverable address information.
If no match is found, you will receive the following information from CODE-1 Plus:
•
the original input address
•
the standardized ZIP + 4 coded version of the input address
•
PS Form 3553
•
NDI report.
Working With CODE-1 Plus
393
10
Using LACSLink
Using the LACSLink Option
The following information discusses the explanation and use of LACSLink.
How do I Install the LACSLink Option?
The LACSLink Option is installed as part of your standard CODE-1 Plus installation.
The installed LACSLink Option contains all data needed to perform LACSLink
processing (e.g., the security key and the security file). After installing CODE-1 Plus,
you must activate the LACSLink Option to perform LACSLink processing.
Please note that the LACS database has a 120-day expiration cycle. Databases expire
on the following schedule:
Table 1: LACSLink Database Expiry Cycle
Database Month
394
Expiration
January
April 30
February
May 31
March
June 30
April
July 31
May
August 31
June
September 30
July
October 31
August
November 30
September
December 31
October
January 31
November
February 28
December
March 31
Software Release 4.0.0/March 2015
Using the LACSLink Option
10
Installing the LACS Database
In this section, we provide instructions for installing your LACS database. To install
the LACS database in an IBM i environment, do the following steps.
1. From the Work With Jobs screen, press F20 to access Database Functions.
2. From the Database Functions screen, select option 2: Install Database.
3. On the Install CODE-1 Plus Databases screen (shown below), fill in “Install
LACSLink database?” with a Y and specify an install source of C for CD-ROM or I
for IDS (downloaded). LACS should be installed into the same library as your US
Postal Database.
[Time]
[Date]
CODE-1 Plus Name/Address Coding System
Replace with screen heading desired
Install CODE-1 Plus Databases
Specify database installation parameters:
Install US Postal Database?
Reduce US Postal Database?
Include ELOT?
Include Enhanced Street?
Install DPV Flat DB? Install DPV Hash DB? Install DPV Split
DB?
Install LACSLink Database? Install SuiteLink Database?
Install Source . . . . . .
C=CD-ROM, I=Internet
Download
Install to Library . . . . C1PFEB09
F3=Exit
F6=Install
How Do I Activate LACSLink?
This section describes the methods available for activating LACSLink processing:
•
Use the IBM i SuiteLink Processing Definition Screen
•
Use the LACS parameter record for batch processing
•
Enter “LACS” in the command line for Interactive processing
•
Call the CODE-1 Plus matcher from a user-written application and set the
LACSLink indicator in the P9IN area.
Working With CODE-1 Plus
395
10
Using LACSLink
Using the IBM i Confirmation Options/LACSLink Processing Screen to Activate
LACSLink
You can use the IBM i Confirmation Options/LACSLink Processing screen
(C1CPID50) to activate LACSLink processing.
HH:MM:SS
MM/DD/YYYY
[Job]
CODE-1 Plus Name/Address Coding System
C1CPID00
Replace with screen heading desired
C1CPID50
Name/Address File Layout
RXX.XM00
Confirmation Options/LACSLink Processing
[CONFRM] Specify confirmation by class of ZIP Code, if desired:
Confirm APO/FPO ZIP Codes . . . . . . . . . . . . . .
N, Y (Dft N)
Confirm Military Installation ZIP Codes . . . . . . .
N, Y (Dft N)
Confirm Government Agency ZIP Codes . . . . . . . . .
N, Y (Dft N)
[CONFRM] Specify input file confirmation mark Comparison Type, if desired:
Comparison type . . . . . . . . . . . . . . . . . . .
EQ, NE
(Press F10 to define compare values/location/length)
[CONFRM] Specify location for output confirmation code, if desired:
Location for output confirmation code . . . . . . . .
1
[LACS] Specify LACSLink Processing
LACSLink Processing Type . . . . . . . . . . . . . . .
Z
Z = Process Zip+4 and call LACSLink
LACSLink Seed Record treatment . . . . . . . . . . . .
S=Shutdown, W=Cont
LACSLink Alternate Option. . . . . . . . . . . . . . .
L=Limited, R=Full
LACSLink Suppress 99 Return Code . . . . . . . . . . .
Y, N
Memory Model . . . . . . . . . . . . . . . . . . . . .
P, U, S, M, L, H
P=Pico, U=Micro, S=Small, M=Medium, L=Large, H=Huge, Default=M
More...
F3=Exit
396
F6=Update
F10=Compare Values
F24=Field Search
Software Release 4.0.0/March 2015
Using the LACSLink Option
10
Fields
Table 2: Confirmation Options/LACSLink Processing Screen Fields (Part 1 of 2)
Field Name
LACSLink
Processing Type
Format
Blank or
Z
Description
The type of LACSLink processing to be
performed:
Z
LACSLink Seed
Record treatment
LACSLink Alternate
Option
Working With CODE-1 Plus
S or W
L or F
Comments
Required.
No default.
Perform the ZIP + 4 coding
process and only call LACSLink
if the ZIP + 4 process returns a
LACS indicator.
This option allows LACSLink to stop
batch jobs when a false-positive (seed
record) has been encountered:
S
Shuts down CODE-1 Plus
processing when a falsepositive (seed record) is
encountered.
W
Allows CODE-1 Plus to continue
processing to completion of the
entire job, generating Form
3553.
Required.
Default is W.
This field allows you to specify if you
want to perform alternated LACSLink
processing.
R
Perform LACSLink processing.
L
Invoke limited LACSLink
subsystem processing.
Provides the CODE-1 Plus nonLACS converted street address,
city, and state data to the output
standardized address and
parsed elements fields.
397
10
Using LACSLink
Table 2: Confirmation Options/LACSLink Processing Screen Fields (Part 2 of 2)
Field Name
LACSLink Suppress
99 Return Code
Format
Y or N
Description
Comments
This option allows you to specify
whether to produce a “99” return code
for LACS seed record processing.
Y
Do not produce “99” return
code for LACS seed record
processing.
N
LACS seed record processing
results in “99” return code.
NOTE: An “S” in “LACSLink Seed
Record treatment” overrides this
option.
Memory Model
P, U, S,
M, L, or H
This option allows you to specify size of
LACSLink module.
Blank
LACS process will be using
Medium memory model
(default).
P
Pico memory model (no files in
memory).
U
Micro memory model (no files
in memory, only indexes).
S
Small memory model (Rv9
expansion in memory).
M
Medium memory model.
L
Large memory model.
H
Huge memory model (all files in
memory).
Required
Activating LACSLink in Batch Mode
To activate LACSLink in batch mode, define the LACS parameter record. For more
information on the LACS parameter, please refer to “LACS Parameter Record” on
page 101.
Activating LACSLink in Interactive Mode
To activate LACSLink processing, be sure the LACSLink databases are in your database
library and enter “LACS” in the command line.
398
Software Release 4.0.0/March 2015
Using the LACSLink Option
10
Activating LACSLink in Callable Mode
To use LACSLink when calling C1MATCHI from your own driver, one of three
conditions must be returned from C1MATCHI:
•
The matched P9O output address has a LACS indicator from the database
(P9OLACS)
•
The P9O General Return Code is not set to blank, B, or X in the output area
(P9OGRC)
•
The P9O default record indicator and the USPS record type are returning a value
of “R” in the output area (P9ODFR and P9ORTP).
To activate LACSLink in callable mode, call the CODE-1 Plus matcher and set the
LACSLink indicator as shown below.
Table 3: P9IN Input Call Area for LACSLInk
Position
40
Working With CODE-1 Plus
Name
P9I-ZLACS
Length
1
Contents
This field allows you to specify if you want to perform
LACSLink processing.
Blank
Do not attempt to perform LACSLink processing
(default)
Y
Perform LACSLink processing
L
Invoke limited LACSLink subsystem processing.
Provides the CODE-1 Plus non-LACS converted
street address, city, and state data to the output
standardized address and parsed elements fields
399
10
Using LACSLink
The following field has been added to the P9OUT call area structure.
Table 4: P9OUT Output Call Area
Position
1215
12161217
400
Field Name
P9OLACSLINK-IND
P9OLACSLINK-RC
Length
1
2
Comments
Indicates if a table was matched:
Blank
No LACS processing occurred.
F
LACS seed violation has occurred
N
No match occurred or a new address
would not convert at run time
S
Input address contained both primary and
secondary information but match
occurred using only primary information
Y
Full match occurred.
Indicates the success of the LACSLink process:
Blank
No LACS processing occurred.
A
LACS record match
00
No match
0
Address was passed to LACS process, but
could not be coded by LACS.
1
Address was successfully coded through
the LACS process.
2
A LACS False/Positive record was
encountered, but software is operating in
a NCOA/No Stop Capacity. As such,
NCOA/No Stop Capacity allows for the
LACS function to continue processing
when a seed record is encountered.
09
LACSLink was able to find the input
address on its internal tables but for
some reason did not return the new
(converted) address.
14
Match found LACS record but would not
convert.
92
Match with secondary information.
Software Release 4.0.0/March 2015
Using the LACSLink Option
10
Table 4: P9OUT Output Call Area
Position
Field Name
12181226
Length
P9OLACSLINK-DBINFO
9
Comments
Indicates the date of the database in YYYYMM
format. Also contains error codes for LACSLink. If
the value of P9OERR is “K” then the first five bytes
of this field contain the error code.
20120: LACS DB EXPIRATION
20121: CAN'T OPEN SECURITY FILE
20122: CORRUPTED SECURITY FILE
20123: CHECK DIGIT VIOLATION ON SECURITY
KEY
20124: PREVIOUS SEED VIOLATION, SYSTEM
LOCKED
20126: RESTART KEY OR SECURITY FILE NOT
CORRECT
20127: UNKNOWN
30000: LACS SEED VIOLATION
31000: LACS SYSTEM ERROR
32000: UNKNOWN as due to missing or corrupted
LACSLink security file or key file.
12271239
P9OLACSLINKVERSION
13
Version number of the LACSLink database,
LACSLink Processing Codes
The following return codes indicate the success of LACS processing:
Table 5: LACS API Return Codes
Return Code
Description
LACS_SEED_NCOA
2
Seed, but NCOA
LACS_SUCCESS
1
Successfully coded
LACS_FAIL
0
Failed to code
LACS_ERROR
-1
System error
LACS_SEED_VIOLATION
-2
LACS False/Positive record was encountered,
LACS function was stopped.
LACS_DB_EXPIRED
-3
LACS database expired.
LACS_KEY_ERROR
-4
User defined LACSKEY is invalid.
LACS_ERROR_DATA
-5
Data file read error
LACS_ERROR_HINT
-6
Error in set table
Working With CODE-1 Plus
401
10
Using LACSLink
Table 5: LACS API Return Codes
Return Code
Description
LACS_ERROR_DBASE0
-70
Database open error
LACS_ERROR_DBASE1
-71
Database open error
LACS_ERROR_DBASE2
-72
Database open error
LACS_ERROR_DBASE3
-73
Database open error
LACS_ERROR_DBASE4
-74
Database open error
LACS_ERROR_DBASE5
-75
Database open error
LACS_ERROR_PLAT
-8
Error in platform detection
LACS_ERROR_INFO
-9
Error in LACS information
LACS_ERROR_INIT
-10
Error in LACS initialization
LACS_ERROR_STATS
-11
Error in LACS statistics
LACS_ERROR_SECDE
-12
Error in LACS Secde
LACS_ERROR_SECIN
-13
Error in LACS Sedin
LACS_ERROR_PARSE
-14
Error in LLPARSE
LACS_ERROR_RV9
-15
Error in rv9esd
LACS_ERROR_STMEM
-16
Error getting st. member
LACS_TEST_BREAK
-17
Break for test
Table 6: LACS Return Codes
Return Code
402
Description
LACSRTN_MATCH
A
LACS record match
LACSRTN_NOMATCH
00
No match
LACSRTN_NOCONV
14
Match found LACS record but would not convert.
LACSRTN_UNIT
92
Match with secondary information.
LACSRTN_HRD
09
LACSLink was able to find the input address on its
internal tables but for some reason did not return
the new (converted) address.
Software Release 4.0.0/March 2015
Seed Record Violations
10
LACSLink Information on USPS Form 3553
The Qualitative Statistical Summary (QSS) section of the USPS Form 3553 (CASS
Summary Report) displays as shown below if you are processing with the LACSLink
Option.
HIGH RISE :HIGH RISE :RURAL RTE :RURAL RTE : LACS/
:
EWS
:SUITELINK :
: DEFAULT : EXACT
: DEFAULT : EXACT
: LACSLINK :
:
:
:___________:__________:__________:__________:__________:__________:________:
: 2 :
17 :
0 :
0 :
0 :
0 :
0 :
:___________________________________________________________________________:
PS FORM 3553, FEBRUARY 2013
See DMM Sec 708 for more information
Seed Record Violations
This section provides information on LACSLink seed record violations.
Introduction
Seed records are artificially manufactured addresses provided as part of the LACSLink
option. The USPS has put in place security measures to ensure mailers using LACSLink
processing do not use these applications to generate mailing lists. If the USPS
identifies a mailer as repetitively generating false-positive violations, the USPS may
direct Pitney Bowes to invalidate their license. Towards that end, the USPS has
created and monitors addresses that generate a false-positive result. The USPS
requires Pitney Bowes to report any organization generating a false-positive result
during LACSLink processing. If you generate a false-positive result, CODE-1 Plus
generates an error message and the security file becomes invalidated. CODE-1 Plus
continues to process your mailing file; however, LACSLink processing is flagged as
unavailable. The mailing that generated the false-positive result is identified as not
CASS certified.
NOTE: If you wish to test your file using seed records, go to the Rapid Information
Bulletin Board System (RIBBS) Web site at http://ribbs.usps.gov/, click LACSLink, and
click the LACSLINK_PUBLICSEED.txt file to see a list of seed records for LACSLink.
Working With CODE-1 Plus
403
10
Using LACSLink
What If My Mailing Generates a Seed Violation?
If your mailing generates a false-positive result during CODE-1 Plus processing, you
are required to do two things:
1. Report the seed record match to Pitney Bowes.
2. Contact Pitney Bowes Technical Support to get a new license key to turn LACSLink
back on.
LACSLink Seed Record Reporting
For all forms of processing with CODE-1 Plus, if you encounter a seed, it must be
reported to the USPS. We have made available via the Pitney Bowes Support site,
http://www.g1.com/Support, a method in which to report all seeds to the USPS.
When you go through our Support site to report the seed violation, you will also be
given a reactivation license or key to be applied to restart the function in which the
violation occurred. To access the Seed Reporting/License area of our Support site:
1. Login to the Pitney Bowes Support site, http://www.g1.com/Support. If for some
reason you cannot access the Pitney Bowes website, you can also report seed
violations to Technical Support at 800-367-6950.
NOTE: If you do not know your User ID and password for the Support website,
please go to the Login screen (http://www.g1.com/support/login.asp) and select
the option to have it e-mailed to you. When you enter your e-mail address as
instructed, it must be an exact match to our customer database. If a successful
match is found, your User ID and password will be e-mailed to the address entered.
2. Go to My Products.
3. Select CODE-1 Plus.
4. Select the appropriate platform with which you are running CODE-1 Plus.
5. Under the Database section, you will see listings for: Delivery Point Validation
(DPV) and LACSLink. For each, there will be a View Available Downloads link under
the LICENSE column of the Database table. Click this View Available Downloads
link for the database of the function that the violation was incurred.
You have now reported your seed record violation and you must obtain a new key to
continue using LACSLink processing.
404
Software Release 4.0.0/March 2015
Seed Record Violations
10
Obtaining a LACSLink License
To obtain a replacement LACSLink License File from the Pitney Bowes Web site,
customers must attach the associated LACSSEED file. In turn, Pitney Bowes Technical
Support will supply and replace the LACSLink License File and report the associated
Seed Record information to the USPS.
To obtain a LACSLink Key, you will need to select via the license form, one of the
following:
1. Batch. If you encounter a LACSLink Seed Violation with your CODE-1 Plus batch
job, you must enter the current LACSLink Key and attach the Seed File to be issued
a reactivation key.
a.
The LACSLink Key can be obtained from your LACSKEY file in the program
library.
NOTE: The LACSLink Key file can be opened with any text editor, and
contains only the 16-byte alpha-numeric LACSLink Key (not including
hyphens) used by CODE-1 Plus.
b.
The Seed File is defined to CODE-1 Plus using the DPVSEED DD statement
that also exists in the JCL, Job Script or Batch file that is used to submit the
batch job.
2. Interactive. If you encounter a LACSLink Seed Violation using the MatcherInquiry/G1CP Transaction, you must enter the current LACSLink Key and attach
the Seed File to be issued a reactivation key.
a.
The LACSLink Key can be obtained from your LACSKEY file in the program
library.
Working With CODE-1 Plus
405
10
Using LACSLink
b.
The Seed File contains all of the necessary information for reporting a falsepositive record. You must create this file using any text editor, reporting
the following information in the specified record position:
Table 7: LACSLink SEED File Detail Record
Position
Length
Description
Format
1-2
2
Street pre-directional
alphanumeric
3-30
28
Street name
alphanumeric
31-34
4
Street suffix abbreviation
alphanumeric
35-36
2
Street post-directional
alphanumeric
37-46
10
Address primary number
alphanumeric
47-50
4
Address secondary abbreviation
alphanumeric
51-58
8
Address secondary number
numeric
59-63
5
Matched ZIP code
numeric
64-67
4
Matched ZIP + 4
numeric
68-180
113
Filler
Once the key and Seed File have been entered, you can select the Download
License button to acquire your LACSLink reactivation key. To apply your
reactivation key, edit your LACSKEY file and replace the existing key with the
reactivation key.
NOTE: LACSLink does not have a New License option for processing, as
the initial license key is packaged and delivered with the installation of
the CODE-1 Plus software application.
406
Software Release 4.0.0/March 2015
CHAPTER 11
Using SuiteLink
This chapter introduces SuiteLink. It describes what SuiteLink is and does, how it’s
used within CODE-1 Plus, and its benefits.
NOTE: The USPS has specific export rules that regulate the distribution of postal
databases. At this time, DPV, LACSLink, and SuiteLink databases are not available to
customers operating outside of the United States. For more information on the USPS
export rules regulating postal databases, go to http://ribbs.usps.gov/.
What is SuiteLink? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
What are the Benefits of SuiteLink? . . . . . . . . . . . . . . . . . . . . . . .
Who is Eligible to Use SuiteLink? . . . . . . . . . . . . . . . . . . . . . . . . .
How Does SuiteLink Work? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the SuiteLink Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How do I Install the SuiteLink Option? . . . . . . . . . . . . . . . . . . . . .
How do I Install the SuiteLink Database?. . . . . . . . . . . . . . . . . . .
How Do I Activate SuiteLink?. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Activating SuiteLink in Batch Mode . . . . . . . . . . . . . . . . . . . .
Activating SuiteLink in Interactive Mode . . . . . . . . . . . . . . . .
Activating SuiteLink in Callable Mode . . . . . . . . . . . . . . . . . .
DD Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SuiteLink Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input and Output Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SuiteLink Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Working With CODE-1 Plus
408
408
409
409
410
410
411
412
414
414
415
417
417
418
418
407
11
Using SuiteLink
What is SuiteLink?
According to the USPS, 26% of all mail addressed to high-rise addresses (business
and residential) ZIP + 4 Code to a high-rise default code. The purpose of SuiteLink is
to improve business addressing by adding known secondary (suite) numbers to allow
delivery sequencing where it would otherwise not be possible.
The USPS defines SuiteLink as: “a data-only product containing business addressing
information specifically identified as high-rise default records as a result of CASS
processing. This product provided by the USPS allows developers to create a software
interface that will have the capability of appending the secondary (suite) information
to a business address, providing the input address is determined to be a high-rise
default record.”
NOTE: SuiteLink cannot be used as part of a standalone process; it must be used
in conjunction with CODE-1 Plus.
What are the Benefits of SuiteLink?
SuiteLink enables customers to provide improved business addressing information by
adding known suite information to business addresses, which will allow USPS delivery
sequencing where it would not otherwise be possible.
The SuiteLink Option provides you with the ability to improve deliverability for the
business addresses in your mailing list. SuiteLink improves business address
information by adding accurate secondary (suite) information to the business
addresses in your mailing list. Adding this additional information makes USPS
delivery sequencing available for addresses in your mailing list that previously were
not eligible. Some of the benefits available to CODE-1 Plus customers through
SuiteLink processing are described below.
408
•
Improves the business address information in your mailing list by appending
secondary (suite) information to business addresses.
•
Ensures USPS delivery sequencing for the business addresses in your mailing list.
•
SuiteLink processing provides another method to ensure postal coding accuracy
resulting in less undeliverable mail.
Software Release 4.0.0/March 2015
What is SuiteLink?
11
Who is Eligible to Use SuiteLink?
SuiteLink is available to all CODE-1 Plus customers. Records that have been processed
through CASS-Certified ZIP + 4 address-matching software and identified as highrise
defaults are potential candidates for SuiteLink processing.
NOTE: The USPS has specific export rules that regulate the distribution of postal
databases. At this time, DPV, LACSLink, and SuiteLink databases are not available to
customers operating outside of the United States. For more information on the USPS
export rules regulating postal databases, go to http://ribbs.usps.gov/.
How Does SuiteLink Work?
CODE-1 Plus performs SuiteLink processing in the situations described below.
1. CODE-1 Plus calls SuiteLink when the following conditions are met:
•
SuiteLink has been activated via either batch mode, interactive mode, or
callable mode and all required SuiteLink parameters are defined with valid
values
•
CODE-1 Plus successfully coded the address and the following information
exists in the address record:
- Firm name
- Valid ZIP code
- Valid ZIP + 4 code
- Primary number exists
•
A match has been made to a high-rise default record
•
The CODE-1 Plus database is current
•
The SuiteLink database is current.
2. If SuiteLink returns secondary data, CODE-1 Plus performs another match
attempt using the corrected data.
3. CODE-1 Plus prints statistics at end of job.
Working With CODE-1 Plus
409
11
Using SuiteLink
Using the SuiteLink Option
The following information discusses the installation and use of the SuiteLink Option.
How do I Install the SuiteLink Option?
The SuiteLink Option is installed as part of your standard CODE-1 Plus installation.
The installed SuiteLink Option contains all data needed to perform SuiteLink
processing. After installing CODE-1 Plus and the SuiteLink database, you must
activate the SuiteLink Option to perform SuiteLink processing.
Please note that the SLKDB database has a 120-day expiration cycle. Databases
expire on the following schedule:
Table 1: SuiteLink Database Expiry Cycle
Database Month
410
Expiration
January
April 30
February
May 31
March
June 30
April
July 31
May
August 31
June
September 30
July
October 31
August
November 30
September
December 31
October
January 31
November
February 28
December
March 31
Software Release 4.0.0/March 2015
Using the SuiteLink Option
11
How do I Install the SuiteLink Database?
In this section, we provide platform-specific instructions for installing your SuiteLink
database.
To install the SuiteLink database in an IBM i environment, do the following steps.
1. From the Work With Jobs screen, press F20 to access Database Functions.
2. From the Database Functions screen, select option 2: Install Database.
3. On the Install CODE-1 Plus Databases screen (shown below), fill in “Install
SuiteLink Database?” with a Y and specify an install source of C for CD-ROM or I
for IDS (downloaded). SuiteLink should be installed into the same library as your
US Postal Database.
[Time]
[Date]
CODE-1 Plus Name/Address Coding System
Replace with screen heading desired
Install CODE-1 Plus Databases
Specify database installation parameters:
Install US Postal Database?
Reduce US Postal Database?
Include ELOT?
Include Enhanced Street?
Install DPV Flat DB? Install DPV Full (Hash) DB? Install DPV Split DB?
Install LACSLink Database?
Install SuiteLink Database?
Install Source . . . . . . C=CD-ROM, I=Internet Download
Install to Library . . . . C1PJUL08
F3=Exit
Working With CODE-1 Plus
F6=Install
411
11
Using SuiteLink
How Do I Activate SuiteLink?
This section describes the methods available for activating SuiteLink processing.
•
Use the IBM i SuiteLink Processing Definition Screen
•
Use the STELNK parameter record for batch processing
•
Enter “SUITE” in the command line for Interactive processing
•
Call the CODE-1 Plus matcher from a user-written application and set the
SuiteLink indicator in the P9IN area.
Using the IBM i SuiteLink Processing Definition Screen to Activate SuiteLink
You can use the IBM i SuiteLink Processing Definition Screen (C1CPID45) to activate
SuiteLink processing.
HH:MM:SS
MM/DD/YYYY
[Job]
CODE-1 Plus Name/Address Coding System
Replace with screen heading desired
Name/Address File Layout
SuiteLink Processing
C1CPID00
C1CPID45
RXX.XM00
[STELNK] Specify SuiteLink Process
Shutdown Indicator . . . . . . . . . . . . . . . . . . . .
S, W, I (Dft S)
S=Shutdown, W=Warn and Stop, I=Ignore
Location of SuiteLink return code. . . . . . . . . . . . .
Location of SuiteLink match code . . . . . . . . . . . . .
Location of SuiteLink fidelity code. . . . . . . . . . . .
Memory Model . . . . . . . . . . . . . . . . . . . .
P, U, S, M, L, H
P=Pico, U=Micro, S=Small, M=Medium, L=Large, H=Huge (Dft M)
Exclude Secondary from Output Address Line . . . . . . . .
I, E (Dft I)
I=Include, E=Exclude
Exclude any Invalid/Extraneous Secondary Information
from Output Address Line. . . . . . . . . . . . . . . . .
I, E (Dft I)
I=Include, E=Exclude
More...
F3=Exit
412
F6=Update
F24=Field Search
Software Release 4.0.0/March 2015
11
Using the SuiteLink Option
Fields
Table 2: SuiteLink Processing Definition Screen Fields (Part 1 of 2)
Field Name
Shutdown
Indicator
Format
S, W, or I
Description
Specifies how to proceed if SuiteLink reports an
error:
Comments
Optional.
Default is S.
• I — Ignore error and continue to attempt
SuiteLink processing. CODE-1 Plus does not
generate a USPS Form 3553 (USPS CASS
Summary Report) if you specify the value “I”.
• S — Shutdown when SuiteLink reports an error
(default). Specify the value “S” if you want to
generate a USPS Form 3553 (USPS CASS
Summary Report).
• W — Issue warning message and turn off
SuiteLink processing. CODE-1 Plus does not
generate a USPS Form 3553 (USPS CASS
Summary Report) if you specify the value “W”.
SuiteLink
Memory
Model Flag
P, U, S, M, L,
or H
Location of
SuiteLink
Return Code
2
Location of
SuiteLink
Match Code
1
Working With CODE-1 Plus
This option allows you to specify size of SuiteLink
memory module.
Blank
SuiteLink process will use the Medium
memory model (default.)
P
Pico memory model (no files in memory).
U
Micro memory model (no files in
memory, only indexes).
S
Small memory model (slkhdr,
slknormal, slknoise in memory).
M
Medium memory model (slknine file also
in memory.)
L
Large memory model (lcd file also in
memory.)
H
Huge memory model (slk file also in
memory.)
SuiteLink return code:
A
Business name matched.
00
Business name not matched.
SuiteLink match code:
A
Matched
B
Not matched
C
Business name was all noise
D
Highrise default record not found
E
Database is expired.
Optional.
Default is
M.
Optional.
No default.
Optional.
No default.
413
11
Using SuiteLink
Table 2: SuiteLink Processing Definition Screen Fields (Part 2 of 2)
Field Name
Location of
SuiteLink
Fidelity Code
Exclude
Secondary
from Output
Address Line
Exclude any
Invalid/
Extraneous
Secondary
Information
from Output
Address Line
Format
1
1
1
Description
Comments
SuiteLink match fidelity:
1
Exact match
2
Acceptable match (one word not
matched)
3
Unacceptable match (more than one
word not matched)
Select this option to call SuiteLInk without
appending the secondary information to the
output address line. All other fields, the ZIP + 4
value, and the DPC code, are determined using
the secondary information returned by SuiteLInk.
The default for this field is to include secondary
information from SuiteLInk on the output address
line
I
Include
E
Exclude
Use this option to include or exclude any invalid
(extraneous) input secondary information.
Optional.
No default.
Optional.
Default is I.
Optional.
Default is I.
• I — Include the invalid input secondary
information.
• E — Exclude the invalid input secondary
information.
• Blank — Defaults to I.
Activating SuiteLink in Batch Mode
To activate SuiteLink in batch mode, define the STELNK parameter record. For more
information on the STELNK parameter, please refer to “STELNK Parameter Record”
on page 135.
Activating SuiteLink in Interactive Mode
To activate SuiteLink in Interactive mode, verify that the SuiteLink databases are
defined in your database library and enter “SUITE” on the command line.
414
Software Release 4.0.0/March 2015
Using the SuiteLink Option
11
Activating SuiteLink in Callable Mode
To use SuiteLink when calling C1MATCHI from your own driver, five conditions must
be returned from C1MATCHI:
•
There must be a firm name in the P9I input area (P9IFRM) AND
•
There must be a house number in the P9O output area (P9OHS-LB) AND
•
The default record indicator must be returning a value of “H” in the P9O output
area (P9ODFR) AND
•
The USPS record type must be returning a value of “H” in the P9O output area
(P9ORTP) AND
•
There must be spaces in both the P9O General Return Code and the 9-digit
Return Code in the output area (P9OGRC and P9O9RC)
Additionally, you must link to SuiteLink using the following COBOL statement:
EXEC CICS LINK
PROGRAM (WS-G1CPDSU)
COMMAREA (WS-STELNK-AREA)
LENGTH
(LENGTH OF WS-STELNK-AREA)
END-EXEC
<-- "G1CPDSU"
<-- See STECOMM
If you get a match back from SuiteLink, you need to re-invoke the matcher with the
new data. However, do not use the firm name that is returned; just use the secondary
information.
NOTE: You can find the P9COMM copybook (a combination of P9IN, P9OUT, and
P9AUDIT for use with CICS) with other copybooks delivered.
You can also optionally perform the following.
•
Determine the action to take for SuiteLink errors.
•
Determine whether an expired SuiteLink database can cause a job to terminate.
•
Set the Small Memory Model flag.
Working With CODE-1 Plus
415
11
Using SuiteLink
.
Table 3: P9IN Input Call Area for SuiteLInk
Position
29
Name
P9ISTE
Length
1
Contents
This field allows you to specify how SuiteLink errors will be
treated.
• I — Ignore error and continue to attempt SuiteLink
processing. CODE-1 Plus does not generate a USPS
Form 3553 (USPS CASS Summary Report) if you specify
the value “I”.
• S — Shutdown when SuiteLink reports an error
(default). Specify the value “S” if you want to generate a
USPS Form 3553 (USPS CASS Summary Report).
• W — Issue warning message and turn off SuiteLink
processing. CODE-1 Plus does not generate a USPS
Form 3553 (USPS CASS Summary Report) if you specify
the value “W”.
30
31
P9ISTE-BYP
P9ISTESMM
1
1
This field allows you to specify if an expired SuiteLink
database will cause the job to terminate.
N
Do not bypass SuiteLink database expiration date
processing (default).
Y
Bypass SuiteLink database expiration processing.
This field allows the small memory model version of
SuiteLink to be used.
N
Do not use the Small Memory Model (default).
Y
Use the Small Memory Model.
NOTE: See positions 1863-1878 and 2121-2170 of the P9OUT callable area for
SuiteLink output.
416
Software Release 4.0.0/March 2015
Using the SuiteLink Option
11
The output from the SuiteLink job posts as follows in the P9OUT call area:
Table 4: P9OUT Output Call Area for SuiteLInk
Position
Name
1863
1864
1865
1866
P9OSTELNK-RC
P9OSTELNKMATCH-RC
P9OSTELNKMATCH-FID
P9OSTELNKRLS-NUM
Length
2
1
1
12
Contents
SuiteLink return code:
A
Business name matched.
00
Business name not matched.
SuiteLink match code:
A
Matched
B
Not matched
C
Business name was all noise
D
Highrise default record not found
E
Database is expired.
SuiteLink match fidelity:
1
Exact match
2
Acceptable match (one word not matched)
3
Unacceptable match (more than one word not
matched)
SuiteLink release number.
DD Name
The DD name for SuiteLink is BSLKD.
SuiteLink Return Codes
The following return codes indicate the success of SuiteLink processing:
Table 5: SuiteLink Return Codes
Return Code
Working With CODE-1 Plus
Description
00
No SuiteLink record match found
A
SuiteLink record match found
417
11
Using SuiteLink
Input and Output Examples
The following examples show examples of potential input and output with SuiteLink.
Input:
1
2
3
4
5
6
----+----0----+----0----+----0----+----0----+----0----+---2070618524200
Pitney Bowes
009269786300
RAMALLO BROS PKG
Output:
1
2
3
4
5
6
----+----0----+----0----+----0----+----0----+----0----+---STE 600
A 1Pitney Bowes
STE 1
A 2BROTHERS PKG RAMALLO
SuiteLink Reporting
The CASS 3553 report and the Control Reports include SuiteLink information.
CASS 3553 Report
SuiteLink information has been added to the Qualitative Statistical Summary section
of the CASS 3553 report:
Control Reports
Line items for SuiteLink are on the Control Reports as follows:
SuiteLink Database version: March 2013, Product Version: 0650
Total Number of SuiteLink Match Attempts
xxxxxxxxx
nn.nn%
Total Number of Successful SuiteLink Match Attempts
xxxxxxxxx
nn.nn%
Total Number of Successful SuiteLink Matches with Corrected Suites xxxxxxxxx
nn.nn%
418
Software Release 4.0.0/March 2015
GLOSSARY
This section contains an alphabetical listing of terms used in this guide. Its
purpose is to define and clarify programming terms, terms that may have multiple
definitions, and terms that apply only to this guide.
Alphabetic character
Alphanumeric
character
Any one of the letters A through Z (upper case and lower case).
Any one of the alphabetic characters, or any one of the digits 0 through 9.
Batch job
A batch job consists of a predefined group of processing actions that are done
with little or no interaction between a user and the system. A user puts the batch
job on a job queue (or list), where it waits until the system is ready for it.
Bit
A unit of data used to make up the bytes of information to be used in processing.
Either of the binary digits 0 or 1.
Byte
Character
Carrier code
Coded output file
Constant
A group of 8 adjacent bits. In the EBCDIC and ASCII coding systems, 1 byte
represents a character, such as 1 letter in the alphabet. In the double-byte
coding system, 2 bytes represent a character.
Any letter, number or other symbol in the data character set that is part of the
organization, control, or representation of data.
A code assigned to each address on a mail carrier’s route.
Output file that contains processed records coded with ZIP + 4 and/or carrier
route codes.
Data that has an unchanging, predefined value to be used in processing. A
constant does not change during the running of the program, while the contents
of a field or variable can.
Customer file
An input or output file that contains customer’s names and addresses.
Default value
A value supplied by the system that is used when no other value is specified by
the user.
Working With CODE-1 Plus
419
GL
Directional
A prefix or suffix on an address that identifies a direction. Predirectionals precede
street names, such as W. Terry Avenue. Post directionals follow street names, such as
23 Democracy Avenue, NW.
Dropped address
information
Address elements dropped during the matching process.
Embedded blank
A space between the characters in a unit of data.
Exit routine
Programming that enables another routine or module, separate from CODE-1 Plus,
to execute a series of operations and then return to CODE-1 Plus.
Field
A group of related characters (such as a name or amount) that are treated as a unit in
a record.
File
Firm name
General delivery
A generic term for a set of related records treated as a unit.
The company name associated with an address.
Mail picked up at post offices by customers who do not use a post office box.
High-rise delivery
point
An address in an apartment or office building that accepts mail for tenants or
companies within the building.
Highway contract
route
A mail route assigned to a private carrier on a contract basis. The post office
sometimes assigns contracts for sparsely populated rural areas.
Input file
Invalid ZIP Code
File
Job description
Job queue
Library
420
Contains variable data used for input. It is typically a name-and-address file, but may
contain any type of data. The input file is described by the user. It may have any file
attributes and may reside on either disk, diskette, or tape.
Output file that contains addresses that have invalid ZIP Codes.
A set of characters that defines how the system handles a job.
A waiting list. In this case, a list of the jobs waiting for processing.
An object on disk that serves as a directory of other objects. A library groups related
objects, and enables you to find objects by name.
Software Release 4.0.0/March 2015
GL
Leading zeros
Zeroes that are place-holders to the left of numbers that are right-aligned and smaller
than the specified field length.
List codes
A generic term for codes placed next to records in a file. A list code might be used to
sort records or perform other operations that require codes to identify like records.
Match attempts
Matching
algorithm
Member
Number of tries the system made to match the input address.
Program logic that controls address matching.
Different files within a library.
National
character
One of the characters $, @, #, or _ (underscore).
Numeric
character
Any one of the digits 0 through 9.
Packed data
Data that is in a packed decimal format.
Packed field
A field that contains data in packed decimal format.
Packed decimal
format
Parameter
Record
Record layout
Record position
Representation of a decimal value in which each byte within a field represents two
numeric digits except the rightmost byte, which contains one digit in bits 0 through
3 and the sign in bits 4 through 7. For all other bytes, bits 0 through 3 represent one
digit; bits 4 through 7 represent one digit. For example, the decimal value for +123
would be represented as 0001 0010 0011 1100 in binary notation, or X'123C' in
hexadecimal notation. Note that some computers use alternative representations for
packed decimal numbers.
Data passed to or received from another program.
A collection of related data or words, treated as a unit, such as one name, address, and
telephone number.
Layout of a record, showing all the fields it contains along with each field's length,
type, and position in the record.
The position in a record where a field is located.
Working With CODE-1 Plus
421
GL
Record types
The Postal Service categorizes addresses and assigns each category a code called a
record type. For example a rural route is assigned a record type of “R.”
Return codes
Codes produced by the system that indicate matching success and either changes
made or discrepancies found in the input address during matching.
Rural route
A delivery route operated in communities lacking convenient postal facilities and
maintained by area residents.
Uncoded output
file
Output file that contains processed records left uncoded with either ZIP + 4 or
carrier route codes.
ZIP Code
A 5-digit code identifying the post office or delivery station associated with an
address.
ZIP + 4 Code
422
A 4-digit code added to a ZIP Code. The first two digits designate a sector that
corresponds to a portion of a zone, rural route, several city blocks, or a large building.
A company on one floor of a large office building can have its own ZIP + 4 Code.
Software Release 4.0.0/March 2015
INDEX
Numerics
5-digit ZIP Code
where to store on the output record, 145
A
Accessing Line of Travel, 243
Activating the Auxiliary File/Early Warning System File
Option, 281
ADDRDF parameter record
ADDRESS fields, 13
ADDRESS FORMAT, 13
defined, 13
field-by-field, 13
picture, 13
URBANIZATION NAME fields, 14
Address Correction
maximum
Z4 OUT parameter record, 143
Address elements, 16
definition locations, 16
Address example
CMRA, 124
ADDRESS FORMAT field (ADDRDF), 13
Address line extraction module (EXTADDR2), 357
EXT2Parm, 357
Address Match Execution Statistics Report, 118
Address matching function (interactive environment)
Address Match Screen, 157
Address Stack Screen, 188
Delivery Sequence Footnotes Screen, 159
Dropped Information/Base Address Screen, 162
Expanded Return Codes Screen, 165
Geocoder Information Screen, 166
Match Settings Screen, 168
Multiple Elements Screen, 171
Parsed Elements Screen, 174
Return Codes Screen, 177
Statistics Screen, 184
Address Match Screen (Interactive), 157
Address Return Code
SA OUT parameter record, 125
Address Source Code
SA OUT parameter record, 127
Address Stack Screen, 188
Address with Apartment
SA OUT parameter record, 126
storage conditions, 126
Working With CODE-1 Plus
Address without Apartment
SA OUT parameter record, 126
storage conditions, 126
Administration Sign-on Screen (Interactive), 214
AE OUT parameter record
APARTMENT DESIGNATOR, 17
BOX NUMBER, 17
defined, 16
DISPOSITION INDICATOR, 18
field-by-field, 17
HOUSE NUMBER, 17
LEADING DIRECTIONAL, 17
picture, 17
RR/HC NUMBER, 17
RR/HC ROUTE TYPE, 17
STREET NAME, 17
SUFFIX, 17
Alias/Base Return Option
SA OUT parameter record, 128
Alias and Base street name output
table, 123
Alias and Base street names
defined, 122
Alias Return Code
SA OUT parameter record, 128
ALIAS RETURN CODE field (SA OUT), 128
Alias Type Code
SA OUT parameter record, 128
ALIAS TYPE CODE field (SA OUT), 128
Alphabetic Portion of LOT Code
LOTOUT parameter record, 107
Alternate city name, defined, 197
Alternate Sequence Code
LOTOUT parameter record, 107
AM2OUT parameter record
defined, 27
field-by-field, 27
HIGH RISE DEFAULT, 27
RURAL ROUTE DEFAULT, 27
street default flag, 29
AM OUT parameter record
ADDRESS PROBABLE CORRECTNESS CODE, 23
APARTMENT RETURN CODE, 22
defined, 20, 27
DELIVERY SEQUENCE FILE FOOTNOTES, 24, 25
DIRECTIONAL RETURN CODE, 21
field-by-field, 20
FIRM NAME MATCH SCORE, 23
FIRM NAME RETURN CODE, 22
GENERAL RETURN CODE, 21
OVERALL PROBABLE CORRECTNESS CODE, 23
picture, 20
423
IX
Index
STREET NAME MATCH SCORE, 23
SUFFIX RETURN CODE, 22
USPS RECORD TYPE CODE, 20
ANALYSIS-NORMALIZATION call area
defined (for C1ANZADR), 351
Analysis of Matched Records
REPORT parameter record, 118
ANALYSIS OF MATCHED RECORDS field (REPORT), 118
ANALYSIS-PARAMETERS call area
defined (for C1ANZADR), 351, 352
Apartment/PMB
SA OUT parameter record, 126
storage conditions, 127
Apartments at a House Range Screen (Interactive), 192
APO/FPO ZIP Codes, 53
AP OUT, 30
AP OUT parameter record
defined, 30
DROPPED PRIMARY CHARACTERS, 34
DROPPED SECONDARY CHARACTERS, 35
Format of extra data in output record, 31
Location for additional input data, 32
NORM. PRIMARY ADDRESS LINE, 32, 33
NORM. SECONDARY ADDRESS LINE, 33
Ascending/descending sequence, 242
Automation-based postal discounts, 46
AUXIL, 38
AUXIL0 parameter record
Example, 280
G1AUXBLD program, 38
AUXIL1, 38
AUXIL1 parameter record
Field-by-Field, 38
G1AUXBLD program, 38
Auxiliary File Build (C1AUXBLD) Reports, 282
Auxiliary File Build Execution Log, 283
Auxiliary File Build Report, 282
Auxiliary File processing
introduction, 275
Auxiliary File Reporting in the CODE-1 Plus Matcher, 283
Auxiliary File Reports, 282
Auxiliary Reference File, 38
AUXIL Parameter, 279
AUXIL parameter record
Field-by-Field, 279
B
BLANK UNUSED ADDRESS LINES
SA OUT parameter record, 126
Block Size
FILEDF parameter record, 87
BLOCK SIZE field (FILEDF), 87, 287
Browsing database
from CICS application, 384
424
Building the Auxiliary File with the Early Warning System,
277
Bypassing an expired database, 39
BYPEXP parameter record
defined, 39
field-by-field, 27
C
C1ANZADR callable module
defined, 351
C1AUXBLD Utility Program, 277
C1BM00XL driver program
L CODE parameter record, 103
C1BMCOK output file, 83
C1BMIZP output file, 83
C1BMNAM input file, 83
C1BMNCO output file, 83
C1BMZP4 output file, 83
C1CTYLKP callable module
calling, 379
defined, 377
output results, 378
passing city and state, 378
passing ZIP Code and city/state, 378
passing ZIP Code only, 377
vanity city name indicator, 379
C1CTYLKP call area
CSP-CITYO, 382
CSP-CTYPEO, 382
CSP-FINO, 382
CSP-LL-LBO, 382
CS-PRM-CITYO, 381
CS-PRM-CSTI, 380
CS-PRM-CTYPEO, 381
CS-PRM-FINO, 381
CS-PRM-FNC, 380
CS-PRM-GRC, 380
CS-PRM-INPUT-CITY-RC, 381
CS-PRM-INPUT-ZIP-RC, 380
CS-PRM-IO-FCZ, 383
CS-PRM-IO-FLD, 383
CS-PRM-IO-FZC, 383
CS-PRM-LL-LBO, 381
CS-PRM-OUTPUT-CITY-RC, 381
CS-PRM-OUTPUT-ZIP-RC, 381
CS-PRM-READ-FCZ, 383
CS-PRM-READ-FLD, 383
CS-PRM-READ-FZC, 383
CS-PRM-STATEO, 381
CS-PRM-SZIP, 382
CS-PRM-ZIPI, 380
CS-PRM-ZIPO, 381
CSP-SHORT-CITYO, 382
CSP-STATEO, 382
Software Release 4.0.0/March 2015
IX
C1MATCHx, 358
C1MATCHx address matching, 306
alternate memory modules, 116
C1MATCHx call areas
P9AUDIT, defined, 309
P9AUDIT, mapped, 349, 350
P9IN, defined, 309
P9IN, mapped, 312
P9OUT, defined, 309
P9OUT, mapped, 320
C1PRPT, 358
C1PRPT callable module
defined, 364
C1PRPT call area
mapped, 367
RP-BMOARC, 368, 369, 370, 371, 372
RP-CT-AMA, 374
RP-CT-APO, 374
RP-CT-BYP, 374
RP-CT-COK, 374
RP-CT-GOV, 374
RP-CT-IZP, 374
RP-CT-MIL, 374
RP-CT-NAM, 373
RP-CT-NCO, 374
RP-CT-PRC, 374
RP-CT-VAL, 374
RP-DATE, 376
RP-HEADER, 376
RP-INP-ZP4, 373
RP-INP-ZP4-VAL, 373
RP-LCDNEW, 373
RP-RETURN-CODE, 367
RP-RPANMR, 374
RP-RPCR3D, 375
RP-RPCRLC, 375
RP-RPCRST, 375
RP-RPSM3D, 376
RP-RPSMLC, 376
RP-RPSMST, 376
RP-RPUPLO, 376
RP-RPZ43D, 375
RP-RPZ4LC, 375
RP-RPZ4ST, 375
Callable modules
defined, 306
Callable subroutine
LTO10 callable subroutine, 243
Call areas
defined, 308
for C1ANZADR defined, 351
for C1CTYLKP, 379
for C1PRPT, 367
for G1CPLKP, 383
maps, defined, 308
P9AUDIT (for C1MATCHx) defined, 309
P9AUDIT (for C1MATCHx) mapped, 349
P9IN (for C1MATCHx) defined, 309
Working With CODE-1 Plus
P9IN (for C1MATCHx) mapped, 312
P9OUT (for C1MATCHx) defined, 309
P9OUT (for C1MATCHx) mapped, 320
Unmatched data call area (for C1MATCHx) mapped,
350
Calling CODE-1 Plus
from your applications, 306
Calling Z4CHANGE
from your own driver, 237
Carrier Coding by 3-Digit ZIP
REPORT parameter record, 119
CARRIER CODING BY 3-DIGIT ZIP field (REPORT), 119
Carrier Coding by 3-Digit ZIP Report, 119
Carrier Coding by List Code
REPORT parameter record, 119
CARRIER CODING BY LIST CODE field (REPORT), 119
Carrier Coding by List Code Report, 119
Carrier Coding by State
REPORT parameter record, 119
CARRIER CODING BY STATE field (REPORT), 119
Carrier Coding by State Report, 119
Carrier Route, 242
Carrier Route Data
CR OUT, 57
Carrier route data
CR OUT parameter record, 57
CASS
certification, 46
CASSA1 parameter record
defined, 40
field-by-field, 40
CASSA4, 42
Z4CHANGE-certified Software Name, 42
CASSA4 parameter record
defined, 42
Field-by-Field, 42
Z4CHANGE-certified Company Name, 42
CASSA7, 43
CASSA7 parameter record
defined, 43
ELOT-certified Company Name, 43
ELOT-certified Software Name, 43
Field-by-Field, 43
CASS Configurations
CONFIG parameter record, 46
CASS Form
separate print file, 120
Census Block Group
G9 OUT parameter record, 93
Census Geocode
G9 OUT parameter record, 92
Census Tract
G9 OUT parameter record, 92
CENSUS TRACT field, 92
CHANGE parameter record (for G1G001)
defined, 303
CHCKPT, 44
CHCKPT parameter record
425
IX
Index
Checkpoint Count, 45
Device Type, 45
CHCKPT parameter record, defined, 44
Cities in a State Screen (Interactive), 194
Cities in a ZIP Code Screen (Interactive), 197
City Information Screen (Interactive), 199
City name
alternate, 197
short, 197
City Type, defined, 197
City types
returned, 51
CLASS CODE field, 96
Client Code
L CODE parameter record, 103
CMRA, 256, 269
defined, 124
CMRA address example, 124
Commercial Mail Receiving Agency, 269
commercial mail receiving agency, 256
Commercial Mail Receiving Agents
defined, 124
Concatenated commands
using in interactive system, 156
CONFIDENCE CODE field, 95
CONFIG, 46
CONFIG parameter record
defined, 46
DIRECTIONAL/SUFFIX MATCH CODE, 47
DUAL ADDRESS MATCH LOGIC, 49
ENHANCED HIGH RISE ALTERNATE MATCHING, 50
FIRMN NAME MATCH CODE, 47
MAXIMUM ADDRESS CORRECTNESS, 47
MAXIMUM OVERALL CORRECTNESS, 48
MULT. SECONDARY COMPONENT PROCESSING, 50
MULTIPLE MATCH ACCEPTANCE, 47
OUTPUT CASE OPTION, 48
PMB HANDLING, 49
STREET NAME MATCH CODE, 47
TERMINATE IF NON-CASS, 48
UNIQUE ZIP HANDLING, 49
USE NON-STANDARD CITY NAMES, 51
USER-SPECIFIED CONFIG. NUMBER, 48
CONFIRM APO/FPO ZIP field (CONFRM), 54
Confirmation flags, 53
eliminates matching, 53
CONFIRMATION VALUE fields (CONFRM), 55
Confirming records without processing, 53
CONFIRM MILITARY BASE ZIPS field (CONFRM), 54
CONFRM, 53
CONFRM parameter record
CONFIRM APO/FPO ZIPs, 54
CONFIRMATION FLAG, 54
CONFIRMATION VALUE fields, 55
CONFIRM GOVERNMENT AGENCY ZIPS, 54
CONFIRM MILITARY BASE ZIPs, 54
defined, 53
EQUAL/NOT EQUAL CODE, 55
426
OUTPUT CONFIRMATION CODE, 54
CONSTANT parameter record (for G1G001)
defined, 295
CONTRL parameter record
defined, 56
example, 57
field-by-field, 56
CONTRL parameter record (for G1G001)
defined, 292
field-by-field, 293
Control Totals Report, 118
Correcting uncoded records
G1CPNBC user exit program, 226
interactive system, 226
Correctness
maximum overall
SA OUT parameter record, 129
Z4 OUT parameter record, 143
CROSS SECT. SAMPLING field (FILEDF), 288
Cross-sectional sampling, 113
CR OUT parameter record
CARRIER ROUTE CODE, 58
CARRIER ROUTE RETURN CODE, 57
defined, 57
DISPOSITION INDICATOR, 59
MAXIMUM ADDRESS CORRECTNESS, 58
MAXIMUM OVERALL CORRECTNESS, 58
Storage conditions INFO. DROPPED, 58
Storage conditions MULTIPLE CR-RT ROUTE, 58
Storage conditions MULTIPLE ZIP CODE, 59
CS OUT, 60
CS OUT parameter record
CITY/STATE RETURN CODE, 61
CITY NAME, 61
defined, 60
DISPOSITION INDICATOR, 64
MAXIMUM ADDRESS CORRECTNESS, 64
MAXIMUM OVERALL CORRECTNESS, 64
SHORT CITY NAME, 62
STANDARDIZED CITY/STATE LINE, 62
STANDARDIZED URBANIZATION NAME, 62
STATE ABBREVIATION, 62
Storage conditions INFO. DROPPED, 63
Storage conditions INPUT SHORT CITY NAME, 61
Storage conditions MULTIPLE ZIP+4, 64
Storage conditions MULTIPLE ZIP CODE, 64
Storage conditions NO ADDRESS MATCH, 62
Storage conditions NO CITY MATCH, 64
Storage conditions NO STATE MATCH, 62
CSP-CITYO call area field, 382
CSP-CTYPEO call area field, 382
CSP-FINO call area field, 382
CSP-LL-LBO call area field, 382
CS-PRM-CITYO call area field, 381
CS-PRM-CSTI call area field, 380
CS-PRM-CTYPEO call area field, 381
CS-PRM-FINO call area field, 381
CS-PRM-FNC call area field, 380
Software Release 4.0.0/March 2015
IX
CS-PRM-GRC call area field, 380
CS-PRM-INPUT-CITY-RC call area field, 381
CS-PRM-INPUT-ZIP-RC call area field, 380
CS-PRM-IO-FCZ call area field, 383
CS-PRM-IO-FLD call area field, 383
CS-PRM-LL-LBO call area field, 381
CS-PRM-OUTPUT-CITY-RC call area field, 381
CS-PRM-OUTPUT-ZIP-RC call area field, 381
CS-PRM-READ-FCZ call area field, 383
CS-PRM-READ-FLD call area field, 383
CS-PRM-READ-FZC call area field, 383
CS-PRM-STATEO call area field, 381
CS-PRM-SZIP call area field, 382
CS-PRM-ZIPI call area field, 380
CS-PRM-ZIPO call area field, 381
CSP-SHORT-CITYO call area field, 382
CSP-STATEO call area field, 382
CS ZIP parameter record
CITY/STATE/ZIP CODE, 65, 66
defined, 65
EXTRACTED ZIP CODE, 66
field-by-field, 65
MASTER FILE LITERAL DATE, 67
MASTER FILE VINTAGE DATE, 67
ORIGINAL CARRIER ROUTE CODE, 67
ORIGINAL ZIP+4 CODE, 66, 67
SEPARATE STATE, 66
SEPARATE ZIP CODE, 66
D
Database
browsing from CICS application, 384
for Z4CHANGE, 234
Database expiration
bypassing, 39
Database inquiry function (interactive system)
Apartments at a House Range Screen, 192
Cities in a State Screen, 194
Cities in a ZIP Code Screen, 197
City Information Screen, 199
Firms on a Street Screen, 201
Houses on a Street Screen, 203
Streets in a City Screen, 206
DATE field (HEADER), 100
Date Received
L CODE parameter record, 103
Delivery Point Barcode
location for (Z4 OUT), 141
Delivery Point Barcode (DPBC)
Z4 OUT parameter record, 141
Delivery Point Validation
error messages, 270
false/positive flag, 269
introduction, 255
Working With CODE-1 Plus
Delivery Point Validation database
verify the install, 403
Delivery Point Validation processing
expiration of, 270
Delivery Sequence File Footnotes, 20
Delivery Sequence Footnotes Screen (Interactive), 159
Device Type
FILEDF parameter record, 87
DIR./SUFFIX MATCH CODE field
(CONFIG), 47
Disposition Indicator
LOTOUT parameter record, 107
SA OUT parameter record, 130
Z4 OUT parameter record, 144
Z5 OUT parameter record, 148
DISPOSITION INDICATOR field
(AE OUT), 18
(CR OUT), 59
(CS OUT), 64
(SA OUT), 130
(Z4 OUT), 144
(Z5 OUT), 148
Domestic Mail Manual, 242, 256
DPBC
Z4 OUT parameter record, 141
DPV
error messages, 270
false/positive flag, 269
introduction, 255
DPV010L, 268
DPV by List Code Report, 272
DPV CMRA
DPV parameter record, 76
DPV database
verify the install, 403
DPV errors
interactive, 157
DPV False/Positive
DPV parameter record, 76
DPV Footnote Codes
description, 269
DPVIN Parameter, 268
DPV Large Memory Module, 268
DPV message
interactive, 157
DPVOUT Parameter, 269
DPV parameter record
description, 69
DPV CMRA, 76
DPV FALSE/POSITIVE, 76
DPV RETURN CODE, 75
example, 74, 80
Multiple Match Option, 71
DPV Parameters and Return Codes, 268
DPV processing
expiration of, 270
improving speed of, 268
DPV Processing Summary Report, 272
427
IX
Index
DPV Return Code
DPV parameter record, 75
Dropped address information
defining locations for, 30
Dropped Information/Base Address Screen (Interactive),
162
Dropped Information Code
SA OUT parameter record, 127
Dual address match logic, 49
E
Early Warning System
what is it?, 276
ELOT
overriding certification data (CASSA7), 43
Enhanced Alternate Highrise Match
storage options
SA2OUT parameter record, 132
Enhanced Carrier Route, 242, 256
Enhanced High Rise Alternate Matching, 50
EQUAL/NOT EQUAL CODE field (CONFRM), 55
Error messages
DPV, 270
EWS
what is it?, 276
EWS download address
USPS website, 276
Examples of Multiple Matches in CODE-1 Plus, 257
Excluding
nth records, 114
Executing Line of Travel, 243
Execution Log, 118
Execution Log Counter, 48
EXITOP parameter record
defined, 81
OPERATING EXIT ROUTINE NAME, 82
picture, 82
Exit routine
LTO60 exit routine, 243
Exit Routine Name
FILEDF parameter record, 88
EXIT ROUTINE NAME field (FILEDF), 88, 287
Exit routines
input, defined, 84
operating exit routine, 81
output, defined, 84
Expanded Return Codes Screen (Interactive), 165
Expired database
bypassing, 39
EXT2PARM, 357
EXTADDR2, 357, 358
address line extraction module, 306
EXT2PARM, 357
SMDRC sample COBOL batch program, 357, 358
428
SMDRR sample ILE RPG program, 358
special processing switches, 358
EXTRADDR2
supplied copybooks, 358
F
False/Positive
seed record
report, 273
false/positive, 269
False/Positive Table
reporting a match, 260
Field, 61, 115, 117, 118
FILEDF, 112
FILEDF parameter record
BLOCK SIZE, 87
defined, 83
DEVICE TYPE, 87
EXIT ROUTINE NAME, 88
field-by-field, 86
FILE NAME, 86
FRACTIONAL RECORD SELECTION, 88
fractional record selection, 85
LABEL TYPE, 87
limiting processing, 85
MAXIMUM NUMBER OF RECORDS, 88
NUMBER OF RECORDS TO SKIP, 88
RECORD FORMAT, 86
RECORD LENGTH, 86
TAPE REEL HANDLING, 87
FILEDF parameter record (for G1G001)
BLOCK SIZE, 287
CROSS SECTIONAL SAMPLING, 288
defined, 287
EXIT ROUTINE NAME, 287
FILE NAME, 287
MAXIMUM NUMBER OF RECORDS, 288
NUMBER OF RECORDS TO SKIP, 288
RECORD FORMAT, 287
RECORD LENGTH, 287
File Name
FILEDF parameter record, 86
FILE NAME field (FILEDF), 86, 287
File names
C1BMCOK output file, 83
C1BMIZP output file, 83
C1BMNAM input file, 83
C1BMNCO output file, 83
C1BMZP4 output file, 83
Final ZIP Code
source of, 147
FIPS County Code
G9 OUT parameter record, 92
FIPS State Code
Software Release 4.0.0/March 2015
IX
G9 OUT parameter record, 92
Firm Name
defined, 89
FIRMNM parameter record, 90
FIRM NAME MATCH CODE field (CONFIG), 47
FIRMNM parameter record
defined, 89
FIRM NAME, 90, 91
Firms on a Street Screen (Interactive), 201
First Interactive Customization Screen (Interactive), 215
Footers
UFTxx parameter record, 139
Footer Text
UFTxx parameter record, 139
FOOTER TEXT field (UFTxx), 139, 290
FORM, 120
FORMAT parameter record (for G1G001)
defined, 295
Fractional Record Selection
FILEDF parameter record, 88
Fractional record selection
FILEDF parameter record, 85
Fraction of Records
NTHSEL parameter record, 112
G
G1C1AUX, 282
G1CPBNC user exit program
correcting uncoded records (interactive system), 226
for correcting uncoded records, 230
G1CPFDF, 224
G1CPLKC browsing database (from CICS)
calling, 384
defined, 383
LOOKREQ call area, 384
G1G001 parameter records
CHANGE, 303
CONSTANT, 295
CONTRL, 292
FILEDF, 287
FORMAT, 295
HEADER, 288
HEADxx, 289
MOVE, 298
PAGESZ, 299
SELECT, 302
TESTIT, 300
UFT, 290
UHD, 291
UNPK, 301
G1G001 report generator program
defined, 286
headers and footers, 288
input file, 286
Working With CODE-1 Plus
report layout, 292
using, 286
G9 OUT parameter record
CENSUS BLOCK GROUP, 93
CENSUS GEOCODE, 92
CENSUS TRACT, 92
defined, 92
FIPS COUNTY CODE, 92
FIPS STATE CODE, 92
LATITUDE/LONGITUDE, 93
MSA CODE, 93
MSA NAME, 93
G9XOUT parameter record
CLASS CODES, 96
CONFIDENCE CODE, 95
defined, 94
GEOTAX OUTPUT KEY, 97
GEOTAX RETURN CODE, 97
INCORPORATED FLAG, 96
LAST ANNEXED DATE, 96
LAST UPDATED DATE, 96
LAST VERIFIED DATE, 96
Minor Civil Division/Census County Division, 95
picture, 95
PRIZM CLUSTER, 95
PRIZM SOCIAL GROUP CODE, 96
G9ZIP9 parameter record
defined, 98
Geocoder Information Screen (Interactive), 166
Geographic Coding Plus
G9ZIP9 parameter record, 98
storage locations, 92, 94
Geographic Coding System
storage locations, 92
Geographic Coding System Interface (Interactive), 208
GeoTAX Key, 213
GeoTAX Key Return Code, 213
GeoTAX Output Key
G9XOUT parameter record, 97
GeoTAX Return Code
G9XOUT parameter record, 97
Getting Started with Delivery Point Validation, 258
Government agency ZIP Codes, 53
H
HEADER parameter record
DATE, 100
defined, 100
HEADING, 100
START ZIP CODE, 100
STOP ZIP CODE, 100
HEADER parameter record (for G1G001)
defined, 288
Header Text
429
IX
Index
UHDxx parameter record, 140
HEADER TEXT field (UHDxx), 140, 291
Heading
HEADER parameter record, 100
HEADING field (HEADER), 100
Headings
UHDxx parameter record, 140
HEADxx parameter record (for G1G001)
defined, 289
Houses on a Street Screen (Interactive), 203
I
Include/Exclude Option
NTHSEL parameter record, 112
Including
nth records, 114
INCORPORATED FLAG field, 96
Information Dropped
SA OUT parameter record
storage conditions, 129
storage conditions
Z4 OUT parameter record, 143
Z5 OUT parameter record, 147
INP Option
using, 123
Input exit routine, 84
Input file
check sequence of (SEQCHK), 133
Input record array, 109
Installing
DPV database
verify the install, 403
Installing the DPV Database, 395
Interactive Screen Reference
GeoTAX Key, 213
Interactive site customization
Administration Sign-on screen, 214
First Interactive Customization screen, 215
Second Interactive Customization screen, 219
Interactive system
Address Match Screen, 157
Address Stack Screen, 188
Administration Sign-on Screen, 214
Apartments at a House Range Screen, 192
Cities in a State Screen, 194
Cities in a ZIP Code Screen, 197
City Information Screen, 199
Delivery Sequence Footnotes Screen, 159
Dropped Information/Base Address Screen, 162
Expanded Return Codes Screen, 165
Firms on a Street Screen, 201
First Interactive Customization Screen, 215
Geocoder Information Screen, 166
Houses on a Street Screen, 203
430
Match Settings Screen, 168
Multiple Elements Screen, 171
Parsed Elements Screen, 174
Return Codes Screen, 177
Second Interactive Customization Screen, 219
site customization file (G1CPFDF), 224
Statistics Screen, 184
Streets in a City Screen, 206
using concatenated commands, 156
Internal Program Name
PGMNAM parameter record, 117
Invoking Line of Travel, 243
L
Label Type
FILEDF parameter record, 87
LACS
See Locatable Address Correction Service (LACS), 124
LACS Indicator
SA OUT parameter record, 128
LACSLink
eligibility, 393
introduction, 407
using Interactive processing, 398, 399
LACSLink
LACS parameter record, 101
LACS parameter record, 101
defined, 101
Latitude/Longitude
G9 OUT parameter record, 93
LATITUDE/ LONGITUDE COORDINATE field, 93
LATITUDE/ LONGITUDE LEVEL field, 93
L CODE parameter record
CLIENT CODE, 103
DATE RECEIVED, 103
defined, 103
LIST CODE, 103
picture, 101, 103
processing up to 10,000 list codes (C1BM00XL), 103
Limiting processing, 100
FILEDF parameter record, 85
Line Number
UFTxx parameter record, 139
UHDxx parameter record, 140
LINE NUMBER field
(UFTxx), 139, 290
(UHDxx), 140, 291
Line of Travel
accessing, 243
executing, 243
LTO10 callable subroutine, 243
LTO60 exit routine, 243
output records, 242
Line of Travel code
Software Release 4.0.0/March 2015
IX
LOT code, 242
Line of Travel Coding by 3-Digit ZIP Code
REPORT parameter record, 120
Line of Travel Coding by List Code
REPORT parameter record, 120
Line of Travel Coding by State
REPORT parameter record, 120
Line of Travel number, 242
Line of Travel reports
LOTOUT parameter record must be defined, 118
Line of Travel sequence code, 242
Line Side
UFTxx parameter record, 139
UHDxx parameter record, 140
LINE SIDE field
(UFTxx), 139, 290
(UHDxx), 140, 291
Lines-per-page
PAGESZ parameter record, 115
LINES-PER-PAGE field (PAGESZ), 115, 299
List Code
defined in L CODE parameter record, 103
L CODE parameter record, 103
List Code Report
DPV, 272
List codes
processing up to 10,000 list codes (C1BM00XL driver
program), 103
List ID
LISTID parameter record, 104
LISTID parameter record
defined, 104
List name
LISTNM parameter record
LISTNM parameter record
defined, 105
LISTNM parameter record
LIST PROCESSOR NAME, 105
picture, 105
List Processor Name
LISTNM parameter record, 105
Locatable Address Correction Service (LACS)
description, 124
LONGITUDE field, 93
LOOKREQ call area (for G1CPLKC)
defined, 384
LOT code, 242, 256
defined, 242
LOT coded records
alternate sequence code, 244
hexadecimal sequence code, 244
Sorting, 243
LOT Coding by 3-Digit ZIP Code
REPORT parameter record, 120
LOT Coding by List Code
REPORT parameter record, 120
LOT Coding by State
REPORT parameter record, 120
Working With CODE-1 Plus
LOTOUT parameter record
ALPHABETIC PORTION OF LOT CODE, 107
ALTERNATE SEQUENCE CODE, 107
defined, 106
DISPOSITION INDICATOR, 107
LOT RETURN CODE, 107
NUMERIC PORTION OF LOT CODE, 107
LOT reports
LOTOUT parameter record must be defined, 118
LOT Return Code
LOTOUT parameter record, 107
M
Mailer information
MAILER parameter record, 108
MAILER parameter record
defined, 108
picture, 108
Maps
of call areas, 308
Master File Literal Date
CS ZIP parameter record, 67
Master File Vintage Date
CS ZIP parameter record, 67
Z4 OUT parameter record, 142
Match
reporting a seed record, 260
Matching modules, 306
Match Settings Screen (Interactive), 168
Maximum Address Correctness
SA OUT parameter record
Address correctness
maximum
SA OUT parameter record, 129
Z4 OUT parameter record, 143
MAXIMUM ADDRESS CORRECTNESS field
(CONFIG), 47
(CR OUT), 58
(CS OUT), 64
(SA OUT), 129
(Z4 OUT), 143
(Z5 OUT), 147
Maximum Number of Records
FILEDF parameter record, 88
Maximum Overall Correctness
SA OUT parameter record, 129
Z4 OUT parameter record, 143
MAXIMUM OVERALL CORRECTNESS field
(CONFIG), 48
(CR OUT), 58
(CS OUT), 64
(SA OUT), 129
(Z4 OUT), 143
MAXIMUM RECORDS field (FILEDF), 88, 288
431
IX
Index
MCD/CCD field, 95
Memory Configuration Program Name
PGMNAM parameter record, 117
Military base ZIP Codes, 53
Minor Civil Division/Census County Division
G9XOUT parameter record, 95
Mixed case
how to print reports in, 118
MOVE I parameter record
defined, 109
picture, 110
SOURCE, 110
SOURCE/TARGET, 110
TARGET, 110
MOVE O parameter record
defined, 111
picture, 111
SOURCE, 111
SOURCE/TARGET, 111
TARGET, 111
Move output fields
MOVE O parameter record, 111
MOVE parameter record (for G1G001)
defined, 298
MSA Code
G9 OUT parameter record, 93
MSA Name
G9 OUT parameter record, 93
MULT. MATCH ACCEPT. field (CONFIG), 47
multiple conditions, 256
Multiple Elements Screen (Interactive), 171
Multiple Match Option
DPV parameter record, 71
Multiple match options, 268
Multiple Standardized Addresses
storage conditions
SA OUT parameter record, 129
Multiple ZIP+4
storage conditions
Z4 OUT parameter record, 144
Multiple ZIP Code
storage conditions
SA OUT parameter record, 129
Z4 OUT parameter record, 144, 148
N
NDI
REPORT parameter record, 119
Normalized address
defining locations for, 30
Nth Number
NTHSEL parameter record, 112
NTHSEL parameter record
defined, 112
432
field-by-field, 112
FRACTION OF RECORDS, 112
INCLUDE/EXCLUDE OPTION, 112
Nth NUMBER, 112
sampling used with FILEDF, 112
skipping and limiting record example, 113
NUM. RECORDS TO SKIP field (FILEDF), 88, 288
Number of Records to Skip
FILEDF parameter record, 88
Numeric Portion of LOT Code
LOTOUT parameter record, 107
O
of, 103, 126, 127
Open/Read failure
DPV, 270
Operating exit routine, 81
Operating Exit Routine Name
EXITOP parameter record, 82
OPERATING EXIT ROUTINE NAME field (EXITOP), 82
Operating exit routines
EXITOP parameter record, 81
Output exit routine, 84
operating (EXITOP), 81
Output record array, 111
Output records, 242
Overriding other parameter records with CONFIG, 46
P
P9AUDIT, 349
P9AUDIT call area (for C1MATCHx)
defined, 309
mapped, 349, 350
P9IAD2 call area field, 318
P9IAUX, 281
P9ICST call area field, 319
P9IDSM call area field, 313
P9IENV call area field, 319
P9IFMM call area field, 313
P9IFNC call area field, 312
P9IFRM call area field, 318
P9IN call area (for C1MATCHx)
defined, 309
mapped, 312
P9IAD2, 318
P9ICST, 319
P9IDSM, 313
P9IDUAL, 314
P9IENV, 319
P9IFMM, 313
P9IFNC, 312
Software Release 4.0.0/March 2015
IX
P9IFRM, 318
P9ISTM, 312
P9ITEST, 313
P9IZIP, 318
P9ISTM call area field, 312
P9IZIP call area field, 318
P9O#AM call area field, 322
P9O9RC call area field, 325
P9OAP# call area field, 329
P9OAPR call area field, 322
P9OARC call area field, 322
P9OAT# call area field, 329
P9OATP call area field, 329
P9OBX# call area field, 329
P9OCAO call area field, 339
P9OCBA call area field, 340
P9OCIT call area field, 326
P9OCL9 call area field, 342
P9OCRC call area field, 325
P9OCRT call area field, 326
P9OCS9 call area field, 342
P9OCSV call area field, 328
P9OCZP call area field, 342
P9OD2R call area field, 333
P9ODBV call area field, 328
P9ODFR call area field, 324
P9ODI1 call area field, 329
P9ODI2 call area field, 329
P9ODIT call area field, 324
P9ODPC call area field, 326
P9ODRC call area field, 322
P9OFBA call area field, 340
P9OFRC call area field, 323
P9OFSC call area field, 323
P9OGRC call area field, 321
P9OHS# call area field, 329
P9OICR call area field, 339
P9OOCR call area field, 339
P9OOZA call area field, 340
P9OPRA call area field, 323
P9OPRB call area field, 321
P9ORP# call area field, 329
P9ORR# call area field, 329
P9ORTP call area field, 327
P9OSAB call area field, 326
P9OSAD call area field, 329
P9OSAL call area field, 329
P9OSAR call area field, 333
P9OSFR call area field, 333
P9OSFX call area field, 329
P9OSFZ call area field, 340
P9OSMA call area field, 323
P9OSNR call area field, 333
P9OSRC call area field, 322
P9OSSC call area field, 321
P9OSTA call area field, 342
P9OSTH call area field, 329
P9OSTN call area field, 329
Working With CODE-1 Plus
P9OSTR call area field, 329
P9OSWD call area field, 328
P9OSWV call area field, 328
P9OUT call area (for C1MATCHx)
defined, 309
mapped, 320
P9O#AM, 322
P9O9RC, 325
P9OAP#, 329
P9OAPR, 322
P9OARC, 322
P9OAT#, 329
P9OATP, 329
P9OBX#, 329
P9OCAO, 339
P9OCASS, 345
P9OCASS-X-DATE, 345
P9OCBA, 340
P9OCIT, 326
P9OCITY-TYPE, 342
P9OCL9, 342
P9OCRC, 325
P9OCRT, 326
P9OCS9, 342
P9OCSV, 328
P9OCZP, 342
P9OD2R, 333
P9ODBV, 328
P9ODFR, 324
P9ODI1, 329
P9ODI2, 329
P9ODIT, 324
P9ODPBC, 326
P9ODPC, 326
P9ODRC, 322
P9OFBA, 340
P9OFRC, 323
P9OFSC, 323
P9OGRC, 321
P9OHS#, 329
P9OICR, 339
P9OMFD, 344
P9OMFV, 344
P9ONTP, 326
P9OOCR, 339
P9OOZA, 340
P9OPRA, 323
P9OPRB, 321
P9ORR#, 329
P9ORTP, 327
P9OSAB, 326
P9OSAD, 329
P9OSAL, 329
P9OSAR, 333
P9OSFR, 333
P9OSFX, 329
P9OSFZ, 340
P9OSMA, 323
433
IX
Index
P9OSNR, 333
P9OSRC, 322
P9OSSC, 321
P9OSTA, 342
P9OSTH, 329
P9OSTN, 329
P9OSTR, 329
P9OSWD, 328
P9OSWV, 328
P9OURC, 326
P9OXRC, 344
P9OZ, 342
P9OZ call area field, 342
PAGESZ parameter record
defined, 115
LINES-PER-PAGE, 115
REPORT OR LOG CODE, 115
PAGESZ parameter record (for G1G001)
defined, 299
LINES-PER-PAGE, 299
REPORT OR LOG CODE, 299
Parameter Record List Report, 118
Parsed Elements Screen (Interactive), 174
Password
finding, 404
PFKEYS (Interactive)
Definition of, 223
PGMNAM parameter record
defined, 116
INTERNAL PROGRAM NAME, 117
MEMORY CONFIGURATION PROGRAM NAME, 117
PLACE CODE fields, 95
PMB, 256
SA2OUT parameter record, 131
PMB designation, 124
PMB Return Code
SA OUT parameter record, 129
PMBs
requirements for, 124
PO Box-only ZIP Code, 147
Postal discounts, automation-based, 46
Preferred city name, defined, 197
Print upper/lower case
REPORT parameter record, 119
Private Mailbox
SA2OUT parameter record, 131
Private Mailboxes
requirements for, 124
private mail boxes, 256
Private Mailbox Handling, 49
PRIZM CLUSTER fields, 95
PRIZM SOCIAL GROUP CODE field, 96
Processing Summary Report
DPV, 272
Program parameters
for correcting uncoded records, 229
434
Q
Qualifying for automation-based discounts, 46
R
R777, 325
R777 record suppression of ZIP+4 (DPBC)
Z4 OUT parameter record, 143
RDI processing
Activating, 73
Specifying location for RDI flag, 79
Rearrange input fields
MOVE I parameter record, 109
Rearrange output fields
MOVE O parameter record, 111
Record Format
FILEDF parameter record, 86
RECORD FORMAT field (FILEDF), 86, 287
Record Length
FILEDF parameter record, 86
RECORD LENGTH field (FILEDF), 86, 287
Rejecting
nth records, 114
Reporting a match
seed record, 260
Report or Log Code
PAGESZ parameter record, 115
REPORT OR LOG CODE field (PAGESZ), 115, 299
REPORT parameter record
ANALYSIS OF MATCHED RECORDS, 118
CARRIER CODING BY 3-DIGIT ZIP, 119
CARRIER CODING BY LIST CODE, 119
CARRIER CODING BY STATE, 119
defined, 118
LINE OF TRAVEL CODING BY 3-DIGIT ZIP CODE, 120
LINE OF TRAVEL CODING BY LIST CODE, 120
LINE OF TRAVEL CODING BY STATE, 120
NATIONAL DELIVERABILITY INDEX (NDI) REPORT
National Deliverability Index Report (NDI)
REPORT parameter record, 119
PRINT UPPER/LOWER CASE, 119
SUMMARY BY 3-DIGIT ZIP, 119
SUMMARY BY LIST CODE, 119
SUMMARY BY STATE, 119
USPS FORM 3553 SEPARATE PRINT FILE, 120
ZIP+4 CODING BY 3-DIGIT ZIP Code, 119
ZIP+4 CODING BY LIST CODE, 119
ZIP+4 CODING BY STATE, 119
Reports
Address-Match Execution Statistics, 118
Carrier Coding by 3-Digit ZIP, 119
Carrier Coding by List Code, 119
Carrier Coding by State, 119
Control Totals, 118
Software Release 4.0.0/March 2015
IX
Execution Log, 118
how to print in mixed case, 118
Parameter Record Listing, 118
printed automatically, 118
Summary by 3-Digit ZIP, 119
Summary by List Code, 119
Summary by State, 119
USPS Form 3553, 118
ZIP+4 Coding by 3-Digit ZIP Code, 119
ZIP+4 Coding by List Code, 119
ZIP+4 Coding by State, 119
Return codes
batch matching, 20
defining locations for, 20, 27
for geographic coding, 92
Return Codes Screen (Interactive), 177
RP-BMOARC call area field, 368, 369, 370, 371, 372
RP-CT-AMA call area field, 374
RP-CT-APO call area field, 374
RP-CT-BYP call area field, 374
RP-CT-COK call area field, 374
RP-CT-GOV call area field, 374
RP-CT-IZP call area field, 374
RP-CT-MIL call area field, 374
RP-CT-NAM call area field, 373
RP-CT-NCO call area field, 374
RP-CT-PRC call area field, 374
RP-CT-VAL call area field, 374
RP-DATE call area field, 376
RP-HEADER call area field, 376
RP-INP-ZP4 call area field, 373
RP-INP-ZP4-VAL call area field, 373
RP-LCDNEW call area field, 373
RP-RETURN-CODE call area field, 367
RP-RPANMR call area field, 374
RP-RPCR3D call area field, 375
RP-RPCRLC call area field, 375
RP-RPCRST call area field, 375
RP-RPS4ST call area field, 375
RP-RPSM3D call area field, 376
RP-RPSMLC call area field, 376
RP-RPSMST call area field, 376
RP-RPUPLO call area field, 376
RP-RPZ43D call area field, 375
RP-RPZ4LC call area field, 375
S
SA2OUT parameter record
defined, 131
ENHANCED ALTERNATE HIGHRISE MATCH STORAGE
OPTIONS, 132
PRIVATE MAILBOX (PMB), 131
Sampling your input file
cross-sectional sampling, 113
Working With CODE-1 Plus
nth record inclusion/exclusion, 114
SA OUT parameter record
ADDRESS RETURN CODE, 125
ADDRESS SOURCE CODE, 127
ADDRESS WITH APARTMENT, 126
ADDRESS WITHOUT APARTMENT, 126
ALIAS/BASE RETURN OPTION, 128
Alias and Base street names, 122
ALIAS RETURN CODE, 128
ALIAS TYPE CODE, 128
APARTMENT/PMB, 126
BLANK UNUSED ADDRESS LINES, 126
defined, 122
DISPOSITION INDICATOR, 130
DROPPED INFORMATION CODE, 127
LACS INDICATOR, 128
Location for PMB RETURN CODE, 129
MAXIMUM ADDRESS CORRECTNESS, 129
MAXIMUM OVERALL CORRECTNESS, 129
Storage conditions ADDRESS WITH APARTMENT, 126
Storage conditions ADDRESS WITHOUT APARTMENT,
126
Storage conditions APARTMENT/PMB, 127
Storage conditions INFORMATION DROPPED, 129
Storage conditions MULTIPLE STANDARDIZED
ADDRESSES, 129
Storage conditions MULTIPLE ZIP CODE, 129
using the INP Option, 123
Screens (Interactive)
Address Match Screen, 157
Address Stack Screen, 188
Administrative Sign-on Screen, 214
Apartments at a House Range Screen, 192
Cities in a State Screen, 194
Cities in a ZIP Code Screen, 197
City Information Screen, 199
correcting uncoded records, 226
Delivery Sequence Footnotes Screen, 159
Dropped Information/Base Address Screen, 162
Expanded Return Codes Screen, 165
Firms on a Street Screen, 201
First Interactive Customization Screen, 215
Geocoder Information Screen, 166
Geographic Coding System Interface, 208
Houses on a Street Screen, 203
Match Settings Screen, 168
Multiple Elements Screen, 171
Parsed Elements Screen, 174
program parameters for correcting records, 229
Return Codes Screen, 177
Second Interactive Customization Screen, 219
Statistics Screen, 184
Streets in a City Screen, 206
Second Interactive Customization Screen (Interactive), 219
Seed ID
interactive, 177
what does it look like?
interactive, 177
435
IX
Index
Seed Record
reporting a match, 260
Seed records
definition, 271
Selecting
nth records, 114
SELECT parameter record (for G1G001)
defined, 302
SEQCHK parameter record
defined, 133
Short city name, defined, 197
Site customization file (G1CPFDF), 224
recovering, 225
Skipping and Limiting Record Example, 113
SMDRC
sample COBOl batch program, 306
SMDRC sample COBOL batch program, 357, 358
SMDRR
ILE RPG sample program, 306
SMDRR sample ILE RPG program, 358
Sorting LOT-coded records, 243
Source
MOVE I parameter record, 110
MOVE O parameter record, 111
Source/Target
MOVE I parameter record, 110
MOVE O parameter record, 111
Source of Final ZIP Code
Z5 OUT parameter record, 147
Special ZIP Codes, 53
Speed of
improving DPV processing, 268
Standardized
city, state, ZIP (CS ZIP), 65
city and state (CS OUT), 60
firm name (FIRMNM), 89
Standardized Urbanization Name
CS OUT, 62
START ZIP CODE field (HEADER), 100
Statistics Screen, 184
STOP ZIP CODE field (HEADER), 100
Street Default Flag, 29
STREET NAME MATCH CODE field
(CONFIG), 47
Streets in a City Screen (Interactive), 206
SuiteLink
defined, 408
eligibility, 409
input and output examples, 418
mainframe DD names, 417
reporting, 418
return codes, 417
using batch processing, 398, 414
using Interactive processing, 396, 399, 412, 414, 415
SuiteLink Processing Definition Screen (C1CPID45)
fields, 413
SUMMARY BY 3-DIGIT ZIP field (REPORT), 119
Summary by 3-Digit ZIP Report, 119
436
Summary by List Code
REPORT parameter record, 119
SUMMARY BY LIST CODE field (REPORT), 119
Summary by List Code Report, 119
Summary by State
REPORT parameter record, 119
SUMMARY BY STATE field (REPORT), 119
Summary by State Report, 119
Support website, 404
Syntax
checking with TESTIT parameter record, 138
Syntax, checking with TESTIT, 300
T
Tape Reel Handling
FILEDF parameter record, 87
Target
MOVE I parameter record, 110
Temporary work area, 109, 111
TESTIT parameter record
defined, 135, 138
field-by-field, 135, 138
TESTIT parameter record (for G1G001)
defined, 300
field-by-field, 300
U
UAA, 256
UFTxx parameter record
defined, 139
FOOTER TEXT, 139
LINE NUMBER, 139
LINE SIDE, 139
picture, 139
UFTxx parameter record (for G1G001)
defined, 290
field-by-field, 290
FOOTER TEXT, 290
LINE NUMBER, 290
LINE SIDE, 290
UHDxx parameter record
defined, 140
HEADER TEXT, 140
LINE NUMBER, 140
LINE SIDE, 140
UHDxx parameter record (for G1G001)
defined, 291
field-by-field, 291
HEADER TEXT, 291
LINE NUMBER, 291
LINE SIDE, 291
Software Release 4.0.0/March 2015
IX
Uncoded records
correcting in Interactive environment, 226
undeliverable-as-addressed, 256
Unique Zip and Small Town, 257
Unique ZIP Handling, 49
Z5 OUT parameter record, 148
UNPK parameter record (for G1G001)
defined, 301
UR command
for correcting uncoded records, 227
User exit routines
for correcting uncoded records Interactive, 230
User ID
finding, 404
USER-SPECIFIED CONFIG. field (CONFIG), 48
USPS FIPS COUNTY CODE field, 92
USPS Form 3553, 46, 118
define list ID (LISTID), 104
define list name (LISTNM), 105
define mailer information (MAILER), 108
overriding certification data (CASSA1), 40
separate print file, 120
USPS Form 3553 Separate Print File
REPORT parameter record, 120
USPS-preferred
city name, defined, 197
USPS rules and exception
for Z4CHANGE processing, 234
USPS website
EWS download address, 276
UW command
for correcting uncoded records, 228
V
Vanity city names, returned, 51
W
Walk Sequence Codes
not the same as Line of Travel, 106
Website
support, 404
What is a Multiple Match?, 257
What is Auxiliary File Processing?, 276
What is Delivery Point Validation?, 256
What is EWS?, 276
What is Line of Travel?, 242
What is the Early Warning System?, 276
Why Use Line of Travel?, 242
Working With CODE-1 Plus
Z
Z4CHANGE
overriding certification data (CASSA4), 42
Z4CHANGE processing
activating, 235
calling from your own driver, 237
database requirements, 234
defined, 234
parameter records, 235
using, 235
USPS rules and exception, 234
Z4 OUT parameter record
defined, 141
DELIVERY POINT BARCODE, 142
DISPOSITION INDICATOR, 144
DPBC WITH CHECK DIGIT, 142
MASTER FILE VINTAGE DATE, 142
MAXIMUM ADDRESS CORRECTNESS, 143
MAXIMUM OVERALL CORRECTNESS, 143
picture, 141
Storage conditions INFORMATION DROPPED, 143
Storage conditions MULTIPLE ZIP+4, 144
Storage conditions MULTIPLE ZIP CODE, 144, 148
Storage conditions ZIP+4 (DPBC) suppressed for R777
records, 143
ZIP+4 CODE, 141, 142
ZIP+4 RETURN CODE, 141
Z5 OUT parameter record
defined, 145
DISPOSITION INDICATOR, 148
location for SOURCE OF FINAL ZIP CODE, 147
MAXIMUM ADDRESS CORRECTNESS, 147
MAXIMUM OVERALL CORRECTNESS, 147
PO BOX-ONLY ZIP CODE, 147
Storage conditions INFORMATION DROPPED, 147
UNIQUE ZIP HANDLING, 148
Valid ZIP Code flag, 147
ZIP CODE, 146
ZIP CODE RETURN CODE, 146
ZIP+4 Code
Z4 OUT parameter record, 141
ZIP+4 Coding by 3-Digit ZIP Code
REPORT parameter record, 119
ZIP+4 CODING BY 3-DIGIT ZIP field (REPORT), 119
ZIP+4 Coding by 3-Digit ZIP Report, 119
ZIP+4 Coding by List Code
REPORT parameter record, 119
ZIP+4 CODING BY LIST CODE field (REPORT), 119
ZIP+4 Coding by List Code Report, 119
ZIP+4 Coding by State
REPORT parameter record, 119
ZIP+4 CODING BY STATE field (REPORT), 119
ZIP+4 Coding by State Report, 119
ZIP+4 Return Code
Z4 OUT parameter record, 141
ZIP Code
437
IX
Index
handling of unique, 148
Valid ZIP Code flag, 147
where to store on the output record, 145
Z5 OUT parameter record, 146
ZIP Code Return Code
Z5 OUT parameter record, 146
ZIP Codes, confirming special, 53
438
Software Release 4.0.0/March 2015
Feedback
Document Title:
CODE-1 Plus Working With Guide
Document Date:
March 2015
Software Version: 4.0.0
Comment regarding page: 1
Contact Preferences
May we contact you if we have questions about your comments?
Yes
No
Contact Information
Name:
Email:
Phone:
Best time to contact: Any time
Comments
Enter you comments here:
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement