Table of Contents

Overview of the UPG 25
Chapter I: SYSTEM OVERVIEW 36
I.1 Introduction 37
I.2 System Functionality 41
I.3 Introduction to Geographic Retrieval Consistency 44
I.4 The Geosupport Function Suite 47
I.5 Overview of System Architecture 60
The Foreground Component 60
The Background Component 61
Foreground Component Updating: New File Releases 62
Foreground Component Updating: New Software Versions and Vestigial Features 64
Character-Only Work Areas (COWs) 67
User Feedback of Rejects 67
I.6 Technical References 70
Chapter II: INTRODUCTION TO THE GEOSUPPORT API 73
II.1 Introduction 75
II.2 Geosupport Return Codes and Reject Handling 80
II.3 Geosupport API User Programming Procedure 85
II.4 One-Work-Area and Two-Work-Area Calls 88
II.5 Coding Geosupport API Calls 92
II.6 The Work Area C/C++ Header Files and Visual Basic Typedef File 95
II.7 Coding API Calls When Using Geosupport C/C++ 95
II.7.1 C/C++ Source Code Statement 96
II.8 Creating a Geosupport Desktop Edition Application 99
II.9 Sample Programs with Descriptions 99
II.9.1 C/C++ Sample Program with Descriptions 100
II.9.2 Visual Basic(VB/VBA) Sample Program with Descriptions 120
II.10 The Long Work-Area-2 Option 139
II.11 The Auxiliary Segment Option (COW Only) 142
II.12 The Extended Work Area 2 Option - via Mode Switch (COW Only) 142
II.13 The Enhanced Work Area 2 Option - via Mode Switch (NMF Only) 145
Chapter III: STREET NAME PROCESSING 147
III.1 Introduction 149
III.2 Street Name Normalizing and the SNL Parameter 153
III.3 Street Name Sorting and Normalization Format Options 158
III.4 Partial Street Names 165
III.5 The Similar Names Feature 171
III.6 Unconventional Geographic Feature Names 183
Paper Streets 184
Non-Street Features 184
Addressable Place Names 185
Non-Addressable Place Names (NAPs) 186
Support of Non-Addressable Place Names (NAPs) with address numbers 188
Pseudo-Street Names 191
Duplicate Address Pseudo-Street Names (DAPSs) 191
Intersection Names 193
III.7 Street Name Browsing and Functions BB and BF 194
III.8 Selection of Output Street Names (COW only) 198
CHAPTER IV: STREET CODES 201
IV.1 Introduction: Street Codes and Geographic Retrieval Consistency 203
IV.2 Street Name Relationships: Aliases and Locally Valid Street Names 206
IV.3 Five-Digit and Ten-Digit Street Codes 208
IV.4 Resynchronization of Street Codes Stored in User Files 213
Resynchronization procedure using B5SCs 216
Resynchronization procedure using street names 218
Resynchronization procedure using B10SCs 218
Summary of Street Code Resynchronization 222
IV.5 Seven-Digit Street Codes: Local Street Name Validity, Local Group Codes 225
Local Group Codes (LGCs) 227
Street Name Codes (SNCs) 229
IV.6 Functions D, DG and DN; Primary, Principal and Preferred Street Names 232
Input Data 233
Output Data 235
Preferred Street Names 238
IV.7 Street Codes and Non-Addressable Place Names 243
IV.8 Street Code Input Feature 246
Functions 1, 1A, 1B, 1E, and AP and Street Code Input 248
NAPs and Street Code Input 250
IV.9 Summary of Street Codes 250
Table IV-1: Notation for Street Code Items 255
Table IV-2: Summary of Street Code Items 256
CHAPTER V: ADDRESS PROCESSING - FUNCTIONS 1, 1A, 1B, 1E, AP 258
V.1 Introduction 260
V.2 Address Numbers (‘House’ Numbers), Normalization and Formats: HNI, HNS and HND 260
Processing of HNIs or HNSs by the Display Functions 263
HNIs or HNSs as Input to the Address-Processing Functions 264
House Number Format Standards 265
V.3 Specifying Input Data to the Address-Processing Functions: NAPs, Parsed-Form Addresses, Free-Form Addresses and Unit Information 274
V.4 Input Address Acceptance/Rejection and its Validation Significance 278
Function 1E 280
Function 1A 281
Function AP 282
Function 1B Input Address Processing and Return Code Processing 283
V.5 Output Data Returned in Work Area 2 of Address Processing Functions 285
Function 1 285
Function 1E 291
Function 1A 292
Function AP (COW Only) 294
Function 1B (COW Only) 295
Work Area 2 for Function 1B 296
V.5.1 Mainframe GOAT Screen for Function 1B 299
V.6 Duplicate Addresses 300
V.7 Marble Hill/Rikers Island 312
V.8 Special Ruby Street Processing 315
V.9 Vanity Addresses 316
V.10 Out-of-Sequence Addresses 318
V.11 ZIP Code as Input Instead of Borough Code 320
V.12 Fuzzy Search for Address Functions 1, 1A, 1B, and 1E 321
V.13 Special Place Name Processing 322
V.14 ‘No Cross Street’ Segment Processing 322
V.15 UNIT Information Feature (COW Only) 323/td>
CHAPTER VI: TAX LOT AND BUILDING PROCESSING - FUNCTIONS 1A, BL, BN / ADDRESS POINT PROCESSING - FUNCTION AP 335
VI.1 Introduction 337
VI.2 Tax Lots and BBLs 338
VI.3 Buildings and Building Identification Numbers (BINs) 341
VI.4 Condominiums and Billing BBLs 345
VI.5 Vacant Street Frontages and Pseudo-Addresses 347
VI.6 Function 1A 349
VI.7 Function BL 356
VI.8 Standard and Legacy Versions of Functions 1A and BL 359
VI.9 Function BN 360
VI.10 Function AP (COW Only) 361
VI.11 Transitional Property Address Directory (TPAD) Building Identification Number (BIN) and status information for Functions 1A, 1B, BL and BN (COW Only) 363
CHAPTER VII: STREET CONFIGURATION PROCESSING - FUNCTIONS 2, 3, 3C, 3S 374
VII.1 Introduction 376
VII.2 Intersections:Function 2 and Function 2W 381
Nodes 382
The Two-Node Case 388
Overview of Function 2 Node Enhancements 393
VII.3 Three-Street Configurations - Concepts and Terminology 419
Street Stretches and Street Segments 420
Logical Direction Assigned to Streets 426
Blockfaces 427
T-Intersections 429
VII.4 Street Segments and Related Configurations: Function 3 434
Input Data Examples for Function 3 436
Ambiguous Function 3 Input Data 440
Function 3 Output Data 441
Cross Street Reversal Flag 446
Segment Orientation 448
Consistent Retrieval of Application Data by ‘On’ Street and Two Cross Streets 450
Converting Address-Keyed Application Data to ‘On’ Street/Cross Streets 452
VII.5 Blockfaces: Function 3C 453
VII.6 Street Stretches: Function 3S 458
Locally Valid Street Name or Street Code processing 468
Roadbed Street Stretches: Function 3S Partial Implementation 469
Coincident Segments: Function 3S Processing 473
VII.7 Borough Boundary Processing (Functions 2, 3 and 3C) 474
VII.8 Fuzzy Name Search Processing for Functions 3, 3C, and 3S – Front-truncated street names 476
CHAPTER VIII: THE GEOSUPPORT API - USER PROGRAM CODING AND JCL 479
VIII.1 Introduction 481
VIII.2 Review of the Geosupport API 483
Important note for CICS applications written in NATURAL 486
VIII.3 Coding API Calls 487
VIII.4 The Geosupport COPY Files 489
Overview of COPY Files in General 490
The Geosupport COPY Libraries 493
VIII.5 Coding API Calls When Using Geosupport COPY Files 500
COBOL Source Code Statements 502
Assembler Source Code Statements 506
PL/1 Source Code Statements 508
IBM/C Source Code Statements 510
NATURAL Source Code Statements 514
VIII.6 JCL for the Compile Step 519
VIII.7 JCL for the Linkage Editor Step 522
VIII.8 JCL for the Execute Step (Batch Applications) 525
CHAPTER IX: GEOSUPPORT BATCH ADDRESS TRANSLATOR (GBAT) 528
IX.1 Introduction 530
IX.2 JCL Considerations 531
IX.3 GBAT Processing and Programmed Abnormal Terminations 539
IX.4 The Input Data File (DDNAME=INFILE or INVSAM) 545
IX.5 The Input Control File (DDNAME=CARDIN) 546
IX.6 The Input Alias File (DDNAME=ALIASES) 552
IX.7 The Output File of Accepted Records (DDNAME=OUTFILE) 557
IX.8 The Output Files of Rejected Records (DDNAME=ERRFILx) 565
IX.8.1 ERRFILE 566
IX.8.2 ERRFIL2 (for use by Function 1B only) 567
IX.8.3 ERRFIL3 (for use by Function2 with RELATEDNODES=YES) 569
IX.8.4 ERRFIL4 (for use with WORKAREA1=YES) 573
IX.8.5 ERRFIL5 (for use by Function 1B with WORKAREA1=YES) 574
IX.9 The Output Print File (DDNAME=SYSPRINT) 575
CHAPTER X: Desktop Edition GBAT 577
X.1 What is GBAT 579
X.2 Using GBAT 580
X.2.1 Before You Begin 581
X.2.2 Starting the Application 581
X.2.3 Selecting an ODBC Data Source 581
X.2.4 Configuring a New Text Data Source 583
X.2.5 Function Selection 592
X.2.6 Function-Specific Configuration 594
X.2.7 General Input Configuration 611
X.2.8 Output Configuration 614
X.2.9 Function Processing 618
CHAPTER XI: Desktop Edition GOAT 621
XI.1 Introduction 623
XI.2 How to Use GOAT 624
XI.3 Invoking Function 1 or Function 1E 626
XI.4 Invoking Function 1A 629
XI.5 Invoking Function 2 632
XI.6 Invoking Function 3 or Function 3C 635
XI.7 Invoking Function 3S 639
XI.8 Invoking Function B 644
XI.9 Invoking Function BL 644
XI.10 Invoking Function BN 647
XI.11 Invoking Function D 648
Appendices and Glossary 653
APPENDIX 1: GEOSUPPORT FUNCTIONS - QUICK REFERENCE 655
Introduction 655
Function 1 663
Function 1A 669
Function 1E 676
Function 1B 679
Function 1N 682
Function 2 (and 2W) 684
Function 3 692
Function 3C 699
Function 3S 705
Function AP 711
Functions BB and BF 716
Function BL 719
Function BN 722
Functions D, DG and DN 725
APPENDIX 2: MAINFRAME-SPECIFIC WORK AREA LAYOUTS (MSW) 732
Work Area 1 (MSW) All Functions 735
Regular Work Area 2 (MSW) Layout for Function 1 740
Long Work Area 2 (MSW) Layout for Function 1 743
Regular Work Area 2 (MSW) Layout for Functions 1A, BL, BN 744
Long Work Area 2 (MSW) Layout for Functions 1A and BL 747
Regular Work Area 2 (MSW) Layout for Function 1E 750
Long Work Area 2 (MSW) Layout for Function 1E 753
Work Area 2 (MSW) Layout for Function 2 754
Work Area 2 (MSW) Layout for Function 3 756
Long Work Area 2 (MSW) Layout for Function 3 759
Work Area 2 (MSW) Layout for Function 3C 761
Work Area 2 (MSW) Layout for Function 3S 764
APPENDIX 3: DATA ITEM DICTIONARY 766
APPENDIX 4: GEOSUPPORT RETURN CODES, REASON CODES AND MESSAGES 922
TPAD WARNING MESSAGES and TPAD Conflict Flag / REASON CODE QUALIFIERS in( ) 938
APPENDIX 5: GEOSUPPORT COPY FILES (MSW) 940
COBOL COPY Files (MSW) 941
ASSEMBLER COPY FILES (MSW) 1010
PL/1 COPY Files (MSW) 1066
C COPY File (MSW) 1147
NATURAL LDAs (MSW) 1183
APPENDIX 6: USER FEEDBACK PROCEDURES 1249
APPENDIX 7: MAINFRAME DATA CENTERS WHERE GEOSUPPORT IS INSTALLED 1252
APPENDIX 8: SAMPLE APPLICATION PROGRAMS AND JCL 1254
COBOL SAMPLE PROGRAM #1 1259
COBOL SAMPLE PROGRAM #2 1303
ASSEMBLER SAMPLE PROGRAM #1 1342
ASSEMBLER SAMPLE PROGRAM #2 1443
PL/1 SAMPLE PROGRAM #1 1495
PL/1 SAMPLE PROGRAM #2 1525
C SAMPLE PROGRAM #1 1540
C SAMPLE PROGRAM #2 1571
NATURAL SAMPLE PROGRAM #1 1600
NATURAL SAMPLE PROGRAM #2 1629
APPENDIX 9: GBAT REFERENCE TABLES 1657
Table A9-1: GBAT Control Entry Descriptions by Keyword 1657
Table A9-2: Summary of GBAT Control Entries by Keyword 1703
Table A9-3: Summary of GBAT Control Entry Usage by Function 1711
Table A9-4: MSW Appended Items for GEOCODE=NO 1723
Table A9-5: MSW Format- Length of GBAT‑Appended Datad 1727
APPENDIX 10: SAMPLE GBAT JOBS 1730
SAMPLE GBAT JOB #1 1731
SAMPLE GBAT JOB #2 1759
APPENDIX 11: GUIDELINES FOR APPLICATION DESIGN 1790
APPENDIX 12: CHARACTER-ONLY WORK AREAS (COW) 1796
Introduction 1796
Overview 1798
Comparison of COWs and MSWs 1800
Consideration When Using the COWs 1804
Work Area Lengths (COWs and MSWs) 1805
Specifying a Work Area Format (COW or MSW) 1807
GBAT Considerations for COWs 1808
COPY Files for COWs 1822
APPENDIX 13: CHARACTER-ONLY WORK AREA LAYOUTS (COW) 1828
Character-Only Work Area 1 (COW) – All Functions 1834
Work Area 2 (COW) - Functions 1, 1E 1846
Work Area 2 (COW) - Functions 1, 1E Extended 1852
Work Area 2 (COW) - Functions 1A, BL, BN 1860
Long Work Area 2 (COW) - Functions 1A, BL 1868
TPAD Long Work Area 2 (COW) - Functions 1A, BL 1870
Work Area 2 (COW) - Functions 1A, BL, BN Extended 1871
Work Area 2 (COW) - Function 1B 1874
Work Area 2 (COW) - Function AP 1896
Work Area 2 (COW) - Function AP Extended 1901
Work Area 2 (COW) - Function 2 1904
Work Area 2 (COW) - Function 2W (Wide) 1908
Work Area 2 (COW) - Function 3 1911
Work Area 2 (COW) - Function 3 with Auxiliary Segment List 1919
Work Area 2 (COW) - Function 3 Extended 1920
Work Area 2 (COW) - Function 3 Extended with Auxiliary Segment List 1925
Work Area 2 (COW) - Function 3C 1926
Work Area 2 (COW) - Function 3C with Auxiliary Segment List 1931
Work Area 2 (COW) - Function 3C Extended 1932
Work Area 2 (COW) - Function 3C Extended with Auxiliary Segment List 1936
Work Area 2 (COW) - Function 3S 1936
APPENDIX 14: GEOSUPPORT COPY FILES (COW) 1939
COBOL COPY Files (COW) 1942
P1COB COPY File 1942
P2COB COPY File 1952
P2COB1A COPY File 2014
P2COB1AL COPY File 2020
P2COB3S COPY File 2059
P2COBAP COPY File 2070
ASSEMBLER COPY Files (COW) 2079
P2BAL COPY File 2090
P2BAL1A COPY File 2152
P2BAL3S COPY File 2202
P2BALAP COPY File 2205
PL/1 COPY Files (COW) 2218
P1PL1 COPY File 2218
P2PL1 COPY File 2227
P2PL11A COPY File 2292
P2PL11AL COPY File 2299
P2PL13S COPY FIle 2351
P2PL1AP COPY File 2353
C COPY File (COW) 2363
PAC COPY File 2363
NATURAL LDAs (COW) 2440
GEOLP1 COPY File 2440
GEOLP2 COPY File 2445
GEOLP21A COPY File 2508
GEOLP2AL COPY File 2515
GEOLP23S COPY File 2564
GEOL2AP COPY File 2565
GEOL2APX COPY File 2567
APPENDIX 15: 2010 CENSUS GEOGRAPHY – Functions 1, 1E, 2, 3, and 3C 2571
APPENDIX 16: NEIGHBORHOOD TABULATION AREAS (NTAS) AND PUMAS 2582
APPENDIX 17: TPAD - ADDITIONAL INFORMATION 2585
APPENDIX 18: RESERVED FOR FUTURE USE 2595
APPENDIX 19: GEOSUPPORT COPY FILES (COW) 2596
Character-Only Work Areas 2596
Work Area 1 (COW) - All Functions 2598
Work Area 2 (COW) - Functions 1 and 1E 2503
Work Area 2 (COW) - Functions 1A, BL and BN 2607
Long Work Area 2 (COW) - Functions 1A and BL 2614
Work Area 2 (COW) - Function 2 2615
Work Area 2 (COW) - Function 3 2618
Work Area 2 (COW) - Function 3C 2623
Work Area 2 (COW) - Function 3S 2627
APPENDIX 20: Geosupport Header And Typedef Files 2632
C/C++ Header File 2632
Visual Basic Typedef File 2664
APPENDIX 21: Geosupport System And General Overview 2682
Geosupport System General Overview 2685
I Goals And Objectives of The Geosupport Systems 2686
II System requirements, Availability And Enhancements 2693
III Accessing Geosupport: The Application Programming Interface And Utility Programs 2695
IV Geosupport Update Cycles And User Feedback 2698
APPENDIX 22: GeoX Programming Guide 2703
GeoX Overview 2703
Setup 2704
Using GeoX in a .NET Program 2705
Sample Code for Function 1E 2707
Sample Code for Function BL 2710
Selecting the Broker to Use 2713
Which Functions to Use 2717
Which Options to Use 2718
Selecting the Proper Work Area 2 2723
List of Classes and Overview 2726
Classes 2727
Supporting Classes for Work Areas 2731
Glossary of Terms and Acronyms 2733
About Us 2765