| Overview of the UPG |
16 |
| Chapter I: SYSTEM OVERVIEW |
22 |
| I.1 Introduction |
23 |
| I.2 System Functionality |
25 |
| I.3 Introduction to Geographic Retrieval Consistency |
27 |
| I.4 The Geosupport Function Suite |
28 |
| I.5 Overview of System Architecture |
36 |
| The Foreground Component |
36 |
| The Background Component |
36 |
| Foreground Component Updating: New File Releases |
37 |
| Foreground Component Updating: New Software Versions and Vestigial Features |
39 |
| Character-Only Work Areas (COWs) |
40 |
| User Feedback of Rejects |
40 |
| I.6 Technical References |
42 |
| Chapter II: INTRODUCTION TO THE GEOSUPPORT API |
45 |
| II.1 Introduction |
47 |
| II.2 Geosupport Return Codes and Reject Handling |
50 |
| II.3 Geosupport API User Programming Procedure |
53 |
| II.4 One-Work-Area and Two-Work-Area Calls |
54 |
| II.5 Coding Geosupport API Calls |
57 |
| II.6 The Work Area C/C++ Header Files and Visual Basic Typedef File |
60 |
| II.7 Coding API Calls When Using Geosupport C/C++ |
59 |
| II.7.1 C/C++ Source Code Statement |
60 |
| II.8 Creating a Geosupport Desktop Edition Application |
61 |
| II.9 Sample Programs with Descriptions |
61 |
| II.9.1 C/C++ Sample Program with Descriptions |
62 |
| II.9.2 Visual Basic(VB/VBA) Sample Program with Descriptions |
73 |
| II.10 The Long Work-Area-2 Option |
87 |
| II.11 The Auxiliary Segment Option (COW Only) |
88 |
| II.12 The Extended Work Area 2 Option - via Mode Switch (COW Only) |
88 |
| II.13 The Enhanced Work Area 2 Option - via Mode Switch (NMF Only) |
90 |
| Chapter III: STREET NAME PROCESSING |
92 |
| III.1 Introduction |
93 |
| III.2 Street Name Normalizing and the SNL Parameter |
95 |
| III.3 Street Name Sorting and Normalization Format Options |
98 |
| III.4 Partial Street Names |
102 |
| III.5 The Similar Names Feature |
105 |
| III.6 Unconventional Geographic Feature Names |
112 |
| Paper Streets |
112 |
| Non-Street Features |
112 |
| Addressable Place Names |
113 |
| Non-Addressable Place Names (NAPs) |
113 |
| Support of Non-Addressable Place Names (NAPs) with address numbers |
115 |
| Pseudo-Street Names |
116 |
| Duplicate Address Pseudo-Street Names (DAPSs) |
116 |
| Intersection Names |
118 |
| III.7 Street Name Browsing and Functions BB and BF |
118 |
| III.8 Selection of Output Street Names (COW only) |
120 |
| CHAPTER IV: STREET CODES |
122 |
| IV.1 Introduction: Street Codes and Geographic Retrieval Consistency |
123 |
| IV.2 Street Name Relationships: Aliases and Locally Valid Street Names |
124 |
| IV.3 Five-Digit and Ten-Digit Street Codes |
126 |
| IV.4 Resynchronization of Street Codes Stored in User Files |
129 |
| Resynchronization procedure using B5SCs |
130 |
| Resynchronization procedure using street names |
131 |
| Resynchronization procedure using B10SCs |
132 |
| Summary of Street Code Resynchronization |
134 |
| IV.5 Seven-Digit Street Codes: Local Street Name Validity, Local Group Codes |
135 |
| Local Group Codes (LGCs) |
137 |
| Street Name Codes (SNCs) |
137 |
| IV.6 Functions D, DG and DN; Primary, Principal and Preferred Street Names |
139 |
| Input Data |
140 |
| Output Data |
141 |
| Preferred Street Names |
142 |
| IV.7 Street Codes and Non-Addressable Place Names |
145 |
| IV.8 Street Code Input Feature |
147 |
| Functions 1, 1A, 1B, 1E, and AP and Street Code Input |
148 |
| NAPs and Street Code Input |
149 |
| IV.9 Summary of Street Codes |
149 |
| Table IV-1: Notation for Street Code Items |
152 |
| Table IV-2: Summary of Street Code Items |
153 |
| CHAPTER V: ADDRESS PROCESSING - FUNCTIONS 1, 1A, 1B, 1E, AP |
154 |
| V.1 Introduction |
156 |
| V.2 Address Numbers (‘House’ Numbers), Normalization and Formats: HNI, HNS and HND |
156 |
| Processing of HNIs or HNSs by the Display Functions |
157 |
| HNIs or HNSs as Input to the Address-Processing Functions |
158 |
| House Number Format Standards |
159 |
| V.3 Specifying Input Data to the Address-Processing Functions: NAPs, Parsed-Form Addresses, Free-Form Addresses and Unit Information |
164 |
| V.4 Input Address Acceptance/Rejection and its Validation Significance |
166 |
| Function 1E |
167 |
| Function 1A |
168 |
| Function AP |
168 |
| Function 1B Input Address Processing and Return Code Processing |
169 |
| V.5 Output Data Returned in Work Area 2 of Address Processing Functions |
170 |
| Function 1 |
170 |
| Function 1E |
173 |
| Function 1A |
174 |
| Function AP (COW Only) |
175 |
| Function 1B (COW Only) |
176 |
| Work Area 2 for Function 1B |
177 |
| V.5.1 Mainframe GOAT Screen for Function 1B |
178 |
| V.6 Duplicate Addresses |
179 |
| V.7 Marble Hill/Rikers Island |
186 |
| V.8 Special Ruby Street Processing |
187 |
| V.9 Vanity Addresses |
188 |
| V.10 Out-of-Sequence Addresses |
189 |
| V.11 ZIP Code as Input Instead of Borough Code |
190 |
| V.12 Fuzzy Search for Address Functions 1, 1A, 1B, and 1E |
191 |
| V.13 Special Place Name Processing |
191 |
| V.14 ‘No Cross Street’ Segment Processing |
192 |
| V.15 UNIT Information Feature (COW Only) |
192 |
| CHAPTER VI: TAX LOT AND BUILDING PROCESSING - FUNCTIONS 1A, BL, BN / ADDRESS POINT PROCESSING - FUNCTION AP |
200 |
| VI.1 Introduction |
202 |
| VI.2 Tax Lots and BBLs |
203 |
| VI.3 Buildings and Building Identification Numbers (BINs) |
205 |
| VI.4 Condominiums and Billing BBLs |
206 |
| VI.5 Vacant Street Frontages and Pseudo-Addresses |
208 |
| VI.6 Function 1A |
209 |
| VI.7 Function BL |
213 |
| VI.8 Standard and Legacy Versions of Functions 1A and BL |
215 |
| VI.9 Function BN |
215 |
| VI.10 Function AP (COW Only) |
215 |
| VI.11 Transitional Property Address Directory (TPAD) Building Identification Number (BIN) and status information for Functions 1A, 1B, BL and BN (COW Only) |
217 |
| CHAPTER VII: STREET CONFIGURATION PROCESSING - FUNCTIONS 2, 3, 3C, 3S |
224 |
| VII.1 Introduction |
225 |
| VII.2 Intersections:Function 2 and Function 2W |
227 |
| Nodes |
228 |
| The Two-Node Case |
232 |
| Overview of Function 2 Node Enhancements |
236 |
| VII.3 Three-Street Configurations - Concepts and Terminology |
250 |
| Street Stretches and Street Segments |
252 |
| Logical Direction Assigned to Streets |
255 |
| Blockfaces |
255 |
| T-Intersections |
257 |
| VII.4 Street Segments and Related Configurations: Function 3 |
260 |
| Input Data Examples for Function 3 |
260 |
| Ambiguous Function 3 Input Data |
261 |
| Function 3 Output Data |
263 |
| Cross Street Reversal Flag |
266 |
| Segment Orientation |
267 |
| Consistent Retrieval of Application Data by ‘On’ Street and Two Cross Streets |
269 |
| Converting Address-Keyed Application Data to ‘On’ Street/Cross Streets |
269 |
| VII.5 Blockfaces: Function 3C |
270 |
| VII.6 Street Stretches: Function 3S |
273 |
| Locally Valid Street Name or Street Code processing |
279 |
| Roadbed Street Stretches: Function 3S Partial Implementation |
279 |
| Coincident Segments: Function 3S Processing |
281 |
| VII.7 Borough Boundary Processing (Functions 2, 3 and 3C) |
282 |
| VII.8 Fuzzy Name Search Processing for Functions 3, 3C, and 3S – Front-truncated street names |
283 |
| CHAPTER VIII: THE GEOSUPPORT API - USER PROGRAM CODING AND JCL |
286 |
| VIII.1 Introduction |
287 |
| VIII.2 Review of the Geosupport API |
288 |
| Important note for CICS applications written in NATURAL |
290 |
| VIII.3 Coding API Calls |
290 |
| VIII.4 The Geosupport COPY Files |
291 |
| Overview of COPY Files in General |
292 |
| The Geosupport COPY Libraries |
293 |
| VIII.5 Coding API Calls When Using Geosupport COPY Files |
298 |
| COBOL Source Code Statements |
399 |
| Assembler Source Code Statements |
301 |
| PL/1 Source Code Statements |
302 |
| IBM/C Source Code Statements |
304 |
| NATURAL Source Code Statements |
307 |
| VIII.6 JCL for the Compile Step |
310 |
| VIII.7 JCL for the Linkage Editor Step |
313 |
| VIII.8 JCL for the Execute Step (Batch Applications) |
314 |
| CHAPTER IX: GEOSUPPORT BATCH ADDRESS TRANSLATOR (GBAT) |
316 |
| IX.1 Introduction |
318 |
| IX.2 JCL Considerations |
318 |
| IX.3 GBAT Processing and Programmed Abnormal Terminations |
322 |
| IX.4 The Input Data File (DDNAME=INFILE or INVSAM) |
326 |
| IX.5 The Input Control File (DDNAME=CARDIN) |
327 |
| IX.6 The Input Alias File (DDNAME=ALIASES) |
330 |
| IX.7 The Output File of Accepted Records (DDNAME=OUTFILE) |
333 |
| IX.8 The Output Files of Rejected Records (DDNAME=ERRFILx) |
337 |
| IX.8.1 ERRFILE |
338 |
| IX.8.2 ERRFIL2 (for use by Function 1B only) |
338 |
| IX.8.3 ERRFIL3 (for use by Function2 with RELATEDNODES=YES) |
339 |
| IX.8.4 ERRFIL4 (for use with WORKAREA1=YES) |
341 |
| IX.8.5 ERRFIL5 (for use by Function 1B with WORKAREA1=YES) |
342 |
| IX.9 The Output Print File (DDNAME=SYSPRINT) |
343 |
| CHAPTER X: Desktop Edition GBAT |
345 |
| X.1 What is GBAT |
347 |
| X.2 Using GBAT |
348 |
| X.2.1 Before You Begin |
348 |
| X.2.2 Starting the Application |
348 |
| X.2.3 Selecting an ODBC Data Source |
348 |
| X.2.4 Configuring a New Text Data Source |
350 |
| X.2.5 Function Selection |
356 |
| X.2.6 Function-Specific Configuration |
358 |
| X.2.7 General Input Configuration |
370 |
| X.2.8 Output Configuration |
372 |
| X.2.9 Function Processing |
374 |
| CHAPTER XI: Desktop Edition GOAT |
377 |
| XI.1 Introduction |
379 |
| XI.2 How to Use GOAT |
379 |
| XI.3 Invoking Function 1 or Function 1E |
381 |
| XI.4 Invoking Function 1A |
383 |
| XI.5 Invoking Function 2 |
384 |
| XI.6 Invoking Function 3 or Function 3C |
387 |
| XI.7 Invoking Function 3S |
390 |
| XI.8 Invoking Function B |
393 |
| XI.9 Invoking Function BL |
394 |
| XI.10 Invoking Function BN |
395 |
| XI.11 Invoking Function D |
396 |
| Appendices and Glossary |
399 |
| APPENDIX 1: GEOSUPPORT FUNCTIONS - QUICK REFERENCE |
401 |
| Introduction |
401 |
| Function 1 |
405 |
| Function 1A |
408 |
| Function 1E |
412 |
| Function 1B |
412 |
| Function 1N |
415 |
| Function 2 (and 2W) |
416 |
| Function 3
|
422 |
| Function 3C |
425 |
| Function 3S |
428 |
| Function AP |
432 |
| Functions BB and BF |
434 |
| Function BL |
436 |
| Function BN |
438 |
| Functions D, DG and DN |
440 |
| APPENDIX 2: MAINFRAME-SPECIFIC WORK AREA LAYOUTS (MSW) |
444 |
| Work Area 1 (MSW) All Functions |
446 |
| Regular Work Area 2 (MSW) Layout for Function 1 |
449 |
| Long Work Area 2 (MSW) Layout for Function 1 |
451 |
| Regular Work Area 2 (MSW) Layout for Functions 1A, BL, BN |
451 |
| Long Work Area 2 (MSW) Layout for Functions 1A and BL |
453 |
| Regular Work Area 2 (MSW) Layout for Function 1E |
455 |
| Long Work Area 2 (MSW) Layout for Function 1E |
457 |
| Work Area 2 (MSW) Layout for Function 2 |
458 |
| Work Area 2 (MSW) Layout for Function 3 |
459 |
| Long Work Area 2 (MSW) Layout for Function 3 |
461 |
| Work Area 2 (MSW) Layout for Function 3C |
462 |
| Work Area 2 (MSW) Layout for Function 3S |
464 |
| APPENDIX 3: DATA ITEM DICTIONARY |
466 |
| APPENDIX 4: GEOSUPPORT RETURN CODES, REASON CODES AND MESSAGES |
556 |
| TPAD WARNING MESSAGES and TPAD Conflict Flag / REASON CODE QUALIFIERS in( ) |
567 |
| APPENDIX 5: GEOSUPPORT COPY FILES (MSW) |
569 |
| COBOL COPY Files (MSW) |
570 |
| ASSEMBLER COPY FILES (MSW) |
619 |
| PL/1 COPY Files (MSW) |
660 |
| C COPY File (MSW) |
718 |
| NATURAL LDAs (MSW) |
745 |
| APPENDIX 6: USER FEEDBACK PROCEDURES |
774 |
| APPENDIX 7: MAINFRAME DATA CENTERS WHERE GEOSUPPORT IS INSTALLED |
776 |
| APPENDIX 8: SAMPLE APPLICATION PROGRAMS AND JCL |
777 |
| COBOL SAMPLE PROGRAM #1 |
780 |
| COBOL SAMPLE PROGRAM #2 |
807 |
| ASSEMBLER SAMPLE PROGRAM #1 |
829 |
| ASSEMBLER SAMPLE PROGRAM #2 |
893 |
| PL/1 SAMPLE PROGRAM #1 |
926 |
| PL/1 SAMPLE PROGRAM #2 |
945 |
| C SAMPLE PROGRAM #1 |
955 |
| C SAMPLE PROGRAM #2 |
974 |
| NATURAL SAMPLE PROGRAM #1 |
991 |
| NATURAL SAMPLE PROGRAM #2 |
1009 |
| APPENDIX 9: GBAT REFERENCE TABLES |
1027 |
| Table A9-1: GBAT Control Entry Descriptions by Keyword |
1027 |
| Table A9-2: Summary of GBAT Control Entries by Keyword |
1053 |
| Table A9-3: Summary of GBAT Control Entry Usage by Function |
1059 |
| Table A9-4: MSW Appended Items for GEOCODE=NO |
1065 |
| Table A9-5: MSW Format- Length of GBAT‑Appended Datad |
1067 |
| APPENDIX 10: SAMPLE GBAT JOBS |
1069 |
| SAMPLE GBAT JOB #1 |
1069 |
| SAMPLE GBAT JOB #2 |
1086 |
| APPENDIX 11: GUIDELINES FOR APPLICATION DESIGN |
1105 |
| APPENDIX 12: CHARACTER-ONLY WORK AREAS (COW) |
1109 |
| Introduction |
1109 |
| Overview |
1110 |
| Comparison of COWs and MSWs |
1111 |
| Consideration When Using the COWs |
1114 |
| Work Area Lengths (COWs and MSWs) |
1114 |
| Specifying a Work Area Format (COW or MSW) |
1115 |
| GBAT Considerations for COWs |
1116 |
| COPY Files for COWs |
1124 |
| APPENDIX 13: CHARACTER-ONLY WORK AREA LAYOUTS (COW) |
1128 |
| Character-Only Work Area 1 (COW) – All Functions |
1131 |
| Work Area 2 (COW) - Functions 1, 1E |
1137 |
| Work Area 2 (COW) - Functions 1, 1E Extended |
1141 |
| Work Area 2 (COW) - Functions 1A, BL, BN |
1145 |
| Long Work Area 2 (COW) - Functions 1A, BL |
1150 |
| TPAD Long Work Area 2 (COW) - Functions 1A, BL |
1150 |
| Work Area 2 (COW) - Functions 1A, BL, BN Extended |
1151 |
| Work Area 2 (COW) - Function 1B |
1153 |
| Work Area 2 (COW) - Function AP |
1165 |
| Work Area 2 (COW) - Function AP Extended |
1168 |
| Work Area 2 (COW) - Function 2 |
1169 |
| Work Area 2 (COW) - Function 2W (Wide) |
1171 |
| Work Area 2 (COW) - Function 3 |
1173 |
| Work Area 2 (COW) - Function 3 with Auxiliary Segment List |
1177 |
| Work Area 2 (COW) - Function 3 Extended |
1178 |
| Work Area 2 (COW) - Function 3 Extended with Auxiliary Segment List |
1181 |
| Work Area 2 (COW) - Function 3C |
1181 |
| Work Area 2 (COW) - Function 3C with Auxiliary Segment List |
1184 |
| Work Area 2 (COW) - Function 3C Extended |
1185 |
| Work Area 2 (COW) - Function 3C Extended with Auxiliary Segment List |
1187 |
| Work Area 2 (COW) - Function 3S |
1187 |
| APPENDIX 14: GEOSUPPORT COPY FILES (COW) |
1189 |
| COBOL COPY Files (COW) |
1191 |
| P1COB COPY File |
1191 |
| P2COB COPY File |
1198 |
| P2COB1A COPY File |
1244 |
| P2COB1AL COPY File |
1246 |
| P2COB3S COPY File |
1264 |
| P2COBAP COPY File |
1265 |
| ASSEMBLER COPY Files (COW) |
1269 |
| P2BAL COPY File |
1276 |
| P2BAL1A COPY File |
1322 |
| P2BAL3S COPY File |
1359 |
| P2BALAP COPY File |
1361 |
| PL/1 COPY Files (COW) |
1371 |
| P1PL1 COPY File |
1371 |
| P2PL1 COPY File |
1378 |
| P2PL11A COPY File |
1425 |
| P2PL11AL COPY File |
1430 |
| P2PL13S COPY FIle |
1469 |
| P2PL1AP COPY File |
1470 |
| C COPY File (COW) |
1477 |
| PAC COPY File |
1477 |
| NATURAL LDAs (COW) |
1510 |
| GEOLP1 COPY File |
1510 |
| GEOLP2 COPY File |
1513 |
| GEOLP21A COPY File |
1560 |
| GEOLP2AL COPY File |
1565 |
| GEOLP23S COPY File |
1601 |
| GEOL2AP COPY File |
1602 |
| GEOL2APX COPY File |
1604 |
| APPENDIX 15: 2010 CENSUS GEOGRAPHY – Functions 1, 1E, 2, 3, and 3C |
1606 |
| APPENDIX 16: NEIGHBORHOOD TABULATION AREAS (NTAS) AND PUMAS |
1612 |
| APPENDIX 17: TPAD - ADDITIONAL INFORMATION |
1614 |
| APPENDIX 18: RESERVED FOR FUTURE USE |
1621 |
| APPENDIX 19: GEOSUPPORT COPY FILES (COW) |
1622 |
| Character-Only Work Areas |
1622 |
| Work Area 1 (COW) - All Functions |
1623 |
| Work Area 2 (COW) - Functions 1 and 1E |
1626 |
| Work Area 2 (COW) - Functions 1A, BL and BN |
1628 |
| Long Work Area 2 (COW) - Functions 1A and BL |
1632 |
| Work Area 2 (COW) - Function 2 |
1633 |
| Work Area 2 (COW) - Function 3 |
1635 |
| Work Area 2 (COW) - Function 3C |
1637 |
| Work Area 2 (COW) - Function 3S |
1639 |
| APPENDIX 20: Geosupport Header And Typedef Files |
1643 |
| C/C++ Header File |
1643 |
| Visual Basic Typedef File |
1663 |
| APPENDIX 21: Geosupport System And General Overview |
1676 |
| Geosupport System General Overview |
1677 |
| I Goals And Objectives of The Geosupport Systems |
1678 |
| II System requirements, Availability And Enhancements |
1682 |
| III Accessing Geosupport: The Application Programming Interface And Utility Programs |
1683 |
| IV Geosupport Update Cycles And User Feedback |
1685 |
| APPENDIX 22: GeoX Programming Guide |
1688 |
| GeoX Overview |
1688 |
| Setup |
1688 |
| Using GeoX in a .NET Program |
1689 |
| Sample Code for Function 1E |
1690 |
| Sample Code for Function BL |
1692 |
| Selecting the Broker to Use |
1694 |
| Which Functions to Use |
1696 |
| Which Options to Use |
1697 |
| Selecting the Proper Work Area 2 |
1700 |
| List of Classes and Overview |
1701 |
| Classes |
1702 |
| Supporting Classes for Work Areas |
1704 |
| Glossary of Terms and Acronyms |
1706 |
| About Us |
1725 |