SYSTEM User Programming Guide SOFTWARE VERSION 10.1 Department of City Planning / City of New York Information Technology Division Geographic Systems Section CITY OF NEW YORK Michael R. Bloomberg, Mayor DEPARTMENT OF CITY PLANNING Amanda M. Burden, AICP, Director Richard Barth, Executive Director INFORMATION TECHNOLOGY DIVISION Anne Kelly, Director Michael S. Miller, Deputy Director GEOGRAPHIC SYSTEMS SECTION Rudy Lopez, Director Michele Liss, AICP, Deputy Director Sue Finkelstein, Assistant Director for Software Development George Minicucci, User Liaison and Supervisor of Data Management Frank Chin, GIS Programming Supervisor Thomas Costa, AICP, Deputy Supervisor of Data Management Jean Pressley, Administrative Associate PROGRAMMING STAFF Michele Basco Halina Chow Gloria Katz Yoel Lebel Steve Oliver Tatyana Vechnyak ______________________________________________________________________________ The Geosupport logo is a trademark of the Department of City Planning / City of New York. Geosupport Desktop Edition is a trademark of the Department of City Planning / City of New York Windows is a registered trademark of Microsoft Corporation in the United States and/or other countries. Other product and company names mentioned herein may be the trademarks or registered trademarks of their respective owners. SYSTEM User Programming Guide Software Version 10.1 January, 2007 TABLE OF CONTENTS SUMMARY OF CHANGES AND NEW FEATURES ...................................... vii CHAPTER I: SYSTEM OVERVIEW ...................................................I-1 I.1 Introduction ............................................................... I-1 I.2 System Functionality ........................................................ I-2 I.3 Introduction to Geographic Retrieval Consistency .................................. I-3 I.4 The Geosupport Function Suite ................................................ I-4 I.5 Overview of System Architecture............................................... I-7 The Foreground Component ............................................... I-7 The Background Component ............................................... I-8 Foreground Component Updating: New File Releases ........................... I-8 Foreground Component Updating: New Software Versions and Vestigial Features .... I-9 Character-Only Work Areas......................................... I-9 User Feedback of Rejects ................................................. I-9 I.6 Overview of the User Programming Guide ...................................... I-11 CHAPTER II: INTRODUCTION TO THE GEOSUPPORT API ........................... II-1 II.1 Introduction .............................................................. II-1 II.2 Geosupport Return Codes and Reject Handling .................................. II-3 II.3 Geosupport API User Programming Procedure ................................... II-4 II.4 One-Work-Area and Two-Work-Area Calls ..................................... II-5 II.5 The Long Work-Area-2 Option ............................................... II-6 CHAPTER III: STREET NAME PROCESSING ....................................... III-1 III.1 Introduction .............................................................III-1 Function 1N ...........................................................III-2 III.2 Street Name Normalizing and the SNL Parameter ................................III-2 III.3 Street Name Sorting and Normalization Format Options ...........................III-3 III.4 Partial Street Names .......................................................III-6 III.5 The Similar Names Feature .................................................III-7 i III.6 Unconventional Geographic Feature Names ...................................III-10 Paper Streets .........................................................III-10 Non-Street Features ....................................................III-10 Addressable Place Names ...............................................III-11 Non-Addressable Place Names (NAPs) .....................................III-11 Pseudo-Street Names ...................................................III-12 Intersection Names ....................................................III-12 III.7 Street Name Browsing and Functions BB and BF ...............................III-13 CHAPTER IV: STREET CODES .................................................... IV-1 IV.1 Introduction: Street Codes and Geographic Retrieval Consistency ................. IV-1 IV.2 Street Name Relationships: Aliases and Locally Valid Street Names ............... IV-2 IV.3 Five-Digit and Ten-Digit Street Codes ....................................... IV-2 IV.4 Resynchronization of Street Codes Stored in User Files .......................... IV-4 Street Code Change File (SCCF) Record Layouts ............................. IV-6 IV.5 Seven-Digit Street Codes: Local Street Name Validity, Local Group Codes .......... IV-8 Local Group Codes (LGCs) .............................................. IV-9 Street Name Codes (SNCs) .............................................. IV-9 IV.6 Functions D, DG and DN; Primary, Principal and Preferred Street Names .......... IV-10 IV.7 Street Codes and Non-Addressable Place Names .............................. IV-13 IV.8 Street Code Input Feature ................................................ IV-14 IV.9 Recapitulation ......................................................... IV-15 CHAPTER V: ADDRESS PROCESSING - FUNCTIONS 1, 1A, 1E ......................... V-1 V.1 Introduction .............................................................. V-1 V.2 Address Numbers (‘House’ Numbers), Normalization and Formats: HNI, HNS and HND . V-1 House Number Ranges .................................................. V-4 Hyphenated House Numbers .............................................. V-4 V.3 Specifying Input Data to the Address-Processing Functions: NAPs, Parsed-Form Addresses and Free-Form Addresses ................. V-6 V.4 Input Address Acceptance/Rejection and its Validation Significance .................. V-7 Function 1 ............................................................ V-7 Function 1E ........................................................... V-7 Function 1A ........................................................... V-8 V.5 Output Data Returned in Work Area 2 ......................................... V-8 Function 1 ............................................................ V-8 Function 1E ........................................................... V-9 Function 1A ........................................................... V-9 V.6 Duplicate Addresses....................................................... V-9 V.7 Marble Hill/Rikers Island .................................................. V-12 V.8 Special Ruby Street Processing .............................................. V-13 V.9 Vanity Addresses ........................................................ V-14 V.10 Out-of-Sequence Addresses ................................................ V-15 CHAPTER VI: TAX LOT AND BUILDING PROCESSING - FUNCTIONS 1A, BL, BN ...... VI-1 VI.1 Introduction ............................................................ VI-1 VI.2 Tax Lots and BBLs ...................................................... VI-1 VI.3 Buildings and Building Identification Numbers (BINs) .......................... VI-2 VI.4 Condominiums and Billing BBLs ........................................... VI-3 ii VI.5 Vacant Street Frontages and Pseudo-Addresses ................................ VI-4 VI.6 Function 1A ............................................................ VI-5 VI.7 Function BL ............................................................ VI-6 VI.8 Standard and Legacy Versions of Functions 1A and BL .......................... VI-7 VI.9 Function BN ........................................................... VI-7 CHAPTER VII: STREET CONFIGURATION PROCESSING - FUNCTIONS 2, 3, 3C, 3S ....VII-1 VII.1 Introduction ........................................................... VII-1 VII.2 Intersections: Function 2 ................................................. VII-2 Nodes ............................................................... VII-2 Conventional intersection of two streets .............................. VII-3 City Limit Point................................................ VII-3 Dead End ..................................................... VII-3 Bend......................................................... VII-3 Number of Intersections of a Pair of Streets ................................. VII-4 The Two-Node Case ................................................... VII-4 Specifying Function 2 Input Data ......................................... VII-5 Possible Outcomes of a Function 2 Call .................................... VII-6 Function 2 Output Data ................................................. VII-7 Multi-Street Intersections and Retrieval Consistency .......................... VII-9 Note Concerning the ‘Vestigial’ Function 2C ................................ VII-9 VII.3 Three-Street Configurations - Concepts and Terminology ....................... VII-10 Street Stretches and Street Segments ...................................... VII-10 Logical Direction Assigned to Streets ..................................... VII-11 Block Faces ......................................................... VII-12 T-Intersections....................................................... VII-12 VII.4 Street Segments and Related Configurations: Function 3 ....................... VII-13 Function