Matching to auxiliary files - geostan_1 - 2024.01

GeoStan Geocoding Suite Reference for Windows, Linux, and z/OS

Product type
Software
Portfolio
Locate
Product family
GeoStan Geocoding Suite
Product
GeoStan Geocoding Suite > GeoStan
Version
2024.01
Language
English
Product name
GeoStan
Title
GeoStan Geocoding Suite Reference for Windows, Linux, and z/OS
Copyright
2024
First publish date
1994
Last updated
2024-07-29
Published on
2024-07-29T23:01:18.924000

GeoStan performs the following steps when matching an input address to an auxiliary file.

  1. GeoStan determines if there is an auxiliary file present.

    GeoStan only accepts one auxiliary file. If more than one auxiliary files is present, GeoStan attempts to match against the first file. GeoStan ignores any additional auxiliary files for matching, regardless if Geostan found a match to the first auxiliary file.

    If a record within the auxiliary files is invalid, GeoStan returns a message indicating the auxiliary file has an invalid record. GeoStan continues to process input addresses against the auxiliary file, but will not match to the invalid auxiliary file record.

  2. If an auxiliary file is present, GeoStan first attempts to match to the auxiliary file.

    GeoStan assumes that the auxiliary file is the most accurate data set and first attempts to find a match to the input address in the auxiliary file. If GeoStan cannot find a match in the auxiliary file, it continues to process as normal against the traditional GeoStan data sets.

    Note: GeoStan only matches your input address to your auxiliary file if there is an exact match. Therefore, your input address list should be as clean as possible; free of misspellings and incomplete addresses.
  3. If GeoStan finds an exact record match to the auxiliary file, it standardizes the match to USPS regulations and returns the output of the auxiliary file match.

Note: You cannot update the auxiliary file while GeoStan is running. If you want to update the auxiliary file, you need to terminate GeoStan before attempting to replace or edit the file.

Record type matching rules

When attempting a match against an auxiliary file, GeoStan abides by the following rules:

Street record match

  • The input house number must fall within or be equal to the low and high house number values of the auxiliary record.

  • The input house number must agree with the parity of the auxiliary record.

  • The input ZIP Code must exactly match the ZIP Code of the auxiliary record.

Landmark record match

  • The input data must contain both a ZIP Code and address line, and they must exactly match the values on the auxiliary record.

  • The input address cannot have any other data, such as a house number, unit number, or Private Mail Box (PMB).

Note: GeoStan only matches the ZIP Code against the auxiliary file. GeoStan does not verify that the ZIP Code of the input address record is correct for the city and state. You should validate this information in your input address before processing against the auxiliary file.

Unavailable GeoStan features and functions

The following contains the features and functions that do not apply when GeoStan makes an auxiliary file match.

  • GeoStan does not match to:

    • two-line addresses

    • multi-line addresses

    • intersection addresses

    • dual addresses

  • You cannot use auxiliary file matching when processing in CASS mode

  • GeoStan does not perform EWS, ZIPMove, LACSLink, or DPV processing on auxiliary matches

  • You cannot create an auxiliary file for the reverse geocoding option

  • You can only access the auxiliary file with processing through the Find function. You cannot access the auxiliary file through the Find First/Next or MBR functions

  • You can only accesses the auxiliary file logic using the address code option of the Find function; not the geocode option.

  • The following are not executed:

    C

    COBOL

    Java

    .Net

    GsGetCoords

    GSSETSEL

    GeoStan.getCoords

    Coordinate

    GsSetSelection

    GSSSELR

    GeoStan.select

    GeoStan.select

    GsSetSelectionRange

    GSHGET

    Range.select

    Range.select

    GsHandleGet

    GSMGET

    Street.getData

    Street.getData

    GsHandleGetCoords

    GSMGH

    Segment.getData

    Segment.getData

    GsMultipleGetHandle

    GSHGCRD

    Range.getData

    Range.getData

    GsMultipleGetHandle

    GSMGH

    GeoStan.getRange

    GeoStan.getRange

    GsHandleGetCoordsEx

    GSHGCRDX

    Segment.getCoords

    Segment.Coords

Auxiliary match output

Several standard GeoStan outputs do not apply to an auxiliary match since GeoStan matches to an exact auxiliary match and does not perform any additional validation for the match.

GeoStan provides special match codes and location code values for auxiliary matches. See Status codes for more information.

When GeoStan finds a match to an auxiliary file, the default output follows the following conventions:

  • GeoStan formats the output of auxiliary file match as a street-style address.

  • GeoStan follows the casing setting you indicate by the casing function. GeoStan does not maintain the casing in the auxiliary file for mixed cased values. For example, GeoStan returns O'Donnell as ODONNELL or Odonnell depending on the setting of the casing function.

Note: GeoStan does not change the casing for the User Data field.
  • GeoStan removes spaces at the beginning and ending of fields in the auxiliary file.

Note: GeoStan does not remove spaces for the User Data field.

Auxiliary file layout

Required

Field

Description

For Street Segment Match

For Landmark Match

Requires Exact Match

Length

Position

ZIP Code

5-digit ZIP Code.

X

X

X

5

1-5

Street name

Name of the street or landmark.

X

X

X

30

6-35

Street type abbreviation

Street type. Also called street suffix.

See the USPS Publication 28 for a complete list of supported street types.

X

4

36-39

Predirectional

USPS street name predirectional abbreviation. Supported values are N, E, S, W, NE, NW, SE, and SW.

X

2

40-41

Postdirectional

USPS street name postdirectional abbreviations. Supported values are N, E, S, W, NE, NW, SE, and SW.

X

2

42-43

RESERVED

RESERVED

4

44-47

Low house number

Low house number of the address range.

X

11

48-58

High house number

High house number of the address range.

X

11

59-69

House number parity a

Parity of the house number in the range.

E – Even

O – Odd

B – Both

1

70

Segment direction

Direction the house numbers progress along the segment:

F – Forward (default) or A - Ascending

R – Reverse or D - Descending

1

71

RESERVED

RESERVED

1

72

FIPS state

US government FIPS state code.

2

73-74

FIPS county

US government FIPS county code.

3

75-77

Census tract

US Census tract number.

6

78-83

Census block group

US Census block group number.

1

84

Census block ID

US Census block ID number.

3

85-87

RESERVED

RESERVED

5

88-92

State abbreviation

USPS state abbreviation.

2

93-94

County name

Name of the county.

25

95-119

MCD code

Minor Civil Division code.

5

120-124

MCD name

Minor Civil Division name.

40

125-164

CBSA code

Core Based Statistical Area code.

5

165-169

CBSA name

Core Based Statistical Area name.

49

170-218

RESERVED

RESERVED

5

219-223

City Name

City name. Overrides the city/state preferred city name upon a return.

40

224-263

RESERVED

RESERVED

237

264-500

User-defined data

User-defined data.

300

501-800

Record ID Number

User-defined unique record identifier.

10

801-810

Side of street

Side of the street for the address:

L – Left side

R – Right side

B – Both sides

U – Unknown side (default)

This is relative to the segment end points and the segment direction.

1

811

Beginning longitude

Beginning longitude of the street segment in millionths of degrees.

X

X

11

812-822

Beginning latitude

Beginning latitude of the street segment in millionths of degrees.

X

X

10

823-832

Ending longitude

Ending longitude of the street segment in millionths of degrees.

11

833-843

Ending latitude

Ending latitude of the street segment in millionths of degrees.

10

844-853

>a For even and odd house number parity records, this specifies on which side of the street the house lays. For records containing both even and odd house numbers, the odd house numbers are on the specified side of the street, and the even house numbers are on the other side. This is a factor when using street offset.