Geocoder - geostan_1 - 2024.01

geocoder formatFile inputFile outputFile /z mmyyyy

geocoder formatFile inputFile outputFile logFile /z mmyyyy

geocoder formatFile - - logfile /z 062006

geocoder formatFile - - /l 100

Permits searching ranges of street addresses.

•0 = Disabled (standard default).

•1 = Enabled.

Note: Invalid for CASS and Exact match modes.

Enable Address Point Interpolation.

•0 = Disabled (standard default).

•1 = Enabled.

•1 = Prefer street lookup first (custom default).

•2 = Prefer firm lookup first.

•3 = Street only lookup (standard default).

Note: Invalid for CASS match mode.

•0 – Default. Do not search for more than one candidate.

•1 – enables continued search for candidates GS_ALWAYS_FIND_CANDIDATES or see GS_FIND_CENTERLN_PROJ_OF_POINT.

In the event that a matched address does not have an associated PreciselyID unique identifier, approxPreciselyID is used to return the PreciselyID unique identifier of the nearest address with an associated PreciselyID unique identifier.

•0 - Default. Disable.

•1 - Enable return of the PreciselyID unique identifier of the nearest address with an associated PreciselyID unique identifier.

•0 – Default. No records copied to an audit file during processing.

•1 to 100000 – Writes every nth record to an audit output file indicated by audFile. See Audit Report for more information.

Fully qualified path and filename for audit record redirection, which is required if not set to 0. A keyword is required if set to 1.

Fully qualified path and filename for CASS Report. (Required if matchMode is set to 4.)

Fully qualified filename of the CASS 3553 form used to generate the report. Required in CASS mode.

Centerline Offset Distance in feet.

Corrects the output lastline if the input address does not match. Provides a valid ZIP Code if possible and/or returns a close match to the input city name.

•0 = Disabled (default)

•1 = Enabled

Directory containing DPV data.

Note:  On z/OS you do not need to include a filename; code only the letter x.

Enable DPV Find.

•0 = Disabled

•1 = Enabled (standard default).

DPV security key.

Specifies whether to enable the return of PreciselyIDs for MLD addresses with ZIP centroid locations.

•0 = Default. Disabled

•1 = Enable return of PreciselyIDs.

To enable returning PreciselyIDs for ZIP centroid locations in MLD, the useCentroids control keyword should be the default value of "1 - Use if no address geocode is available." If useCentroids is any other value, an "E" location code is returned and the results data will not include a geocode or PreciselyID.

•0 – Default. Disables enhanced building name searches.

•1 – Enables enhanced building name searches.

Note: Not available with User Dictionaries. Not valid in CASS match mode.

Specifies whether to return the Extended Match Code (4th hex digit).

•0 = Default. Disabled

•1 = Extends match code to indicate house, unit number and unit type matching.

Expands address search abilities to account for a missing or wrong first letter in the street name.

•0 = Disabled (standard default).

•1 = Enabled.

Note: This setting is ignored in Exact match mode.

Required. Record length of input file. Minimum line length to read if inRecType is 1.

•0 – Records are not delimited. (Must be 0 on z/OS.)

•1 – Default. Records are terminated with cr/lf (DOS/Windows) or lf (UNIX).

If the input address multi-matches (GS_ADDRESS_NOT_RESOLVED), return all candidate matches, each on a separate output line. This will increase the output length of the output file.

•0 = Disabled (default).

•n = Enabled and returns a maximum of n candidates.

•resolveMultiMatch and keepMultiMatch are mutually exclusive

•0 – Do not output records that do not match.

•1 – Default. Output all records.

Fully qualified path for LACS^Link data.

Note:  On z/OS you do not need to include a filename; code only the letter x.

Enable LACS^Link Find.

•0 = Disabled.

•1 = Enabled (standard default).

LACS^Link security key.

Required. Path to your GeoStan license file (geostan.lic).

Address of your organization. Required for DPV and LACS^Link initialization.

City where your organization resides. Required for DPV and LACS^Link initialization.

Name of your organization. Required for DPV and LACS^Link initialization.

2-character state abbreviation where your organization resides. Required for DPV and LACS^Link initialization.

9-digit ZIP Code where your organization resides. Required for DPV and LACS^Link initialization.

•0 – Exact (GS_MODE_EXACT).

•1 – Close (GS_MODE_CLOSE).

•2 – Default. Relaxed (GS_MODE_RELAX).

•4 – CASS (GS_MODE_CASS).

•7 - Custom (GS_MODE_CUSTOM).

•8 - Interactive (GS_MODE_INTERACTIVE).

Note: Only supported in forward geocoding. This setting is ignored in reverse geocoding.

•0 – Default. Return results in upper case. (USPS preferred.)

•1 – Return results in mixed case.

•0 – Default. Address is not multi-line.

•1 – Address is multi-line. Set your preferred address line using multiPref.

Note: This is an optional keyword that may also require a filename definition as an additional optional keyword

•0 – Default. If 2-line address, select first line. If multi-line address, select bottom-most line.

•1 – If 2-line or multi-line address, prefer P.O. Box. Ignored if processing in CASS mode.

•2 – If 2-line or multi-line address, prefer street address. Ignored if processing in CASS mode.

Custom matching option to ensure house number is matched exactly.

•0 = Disabled.

•1 = Enabled (default).

Note: Not valid for singleline address matching.

Custom matching option to ensure street name, predir, postdir, and type match exactly.

•0 = Disabled (default).

•1 = Enabled.

Note: Not valid for singleline address matching.

Custom matching option to ensure city matches exactly.

•0 = Disabled (default).

•1 = Enabled.

Note: Not valid for singleline address matching.

Custom matching option to ensure state matches exactly.

•0 = Disabled (default).

•1 = Enabled.

Note: Not valid for singleline address matching.

Custom matching option to ensure ZIP Code matches exactly.

•0 = Disabled (default).

•1 = Enabled.

Note: Not valid for singleline address matching.

Redirects non-standardized records to a non-standard output file, putting only standardized records in the original output files as specified on the command line. May be non-existent, 0 (Off) (default) or 1 (On).

Note: See Audit Report for more information.

Fully qualified path and filename for non-standardized record output. (Required if nonStand is greater than 0.)

Note:  On z/OS you do not need to include a filename; code only the letter x.

Deprecated. The number of feet GeoStan will squeeze streets when interpolating the geocode for a house number. In addition, the number of feet used  to set the geocode off the street.

Use squeezeDist and setbackDist keywords instead.

USPS Residential Delivery Indicator (requires DPV-confirmed ZIP+4)

•Y - Address is a residence

•N - Address is a business

Blank - Address was not presented to RDI or RDI data not loaded

Required. Record length of output file.

•0 – Records are not delimited. (Must be 0 on z/OS)

•1 – Default. Records are terminated with cr/lf (DOS/Windows) or lf (UNIX).

Required. GeoStan password to enable operation.

Note:  On z/OS you do not need to include a filename; code only the letter x.

Required. Search path for GeoStan data files; delimited with semicolons. For example c:/;d:/geocode.

Note:  On z/OS you do not need to include a filename; code only the letter x.

Prefer ZIP over city when address is the same.

•0 – Disables (default).

•1 – Enabled.

Note: Ignored for CASS and Interactive match modes. Interactive match mode returns the best address regardless of this setting.

Return all candidate matches, each on a separate line. This will increase the length of the output file.

•0 – Disables (default).

•1 – Enabled and returns a maximum of n candidates

Note: printCandidates and keepMultiMatch are mutually exclusive.

Directory containing Residential Delivery Indicator (RDI) data.

•0 – Do not remove line feed characters.

•1 – If inRecType is 0 (indicating records are not delimited), look for and remove line feed characters anyway

Fully qualified path and file name for statistics report file. If this keyword is not present, geocoder writes the report file geocoder.rpt to the current working directory.

Note: On z/OS you do not need to include a filename; code only the letter x.

If the input address multi-matches (GS_ADDRESS_NOT_RESOLVED), select the first candidate to resolve the match.

•0 – Disables (default).

•1 – Enabled.

Note: resolveMultiMatch and keepMultiMatch are mutually exclusive.

Specifies how addresses and unranged streets are processed with reverse geocoding.

•0 – Default. Does not match to an address.

•1 – Matches to points and interpolated addresses, but does not match to any unranged segments.

•2 – Matches to all types of street segments.

In a reverse geocoding operation, specifies whether the match is made to the closest feature or point address.

Note: Implementation of this feature requires that at least one points data set and one streets data set are loaded; otherwise, the match will be made to the closest feature.

•0 – Default. Matches to the closest feature including street segments and intersections in addition to address points.

•1 – Matches to the closest point address within the search radius.

Specifies how GeoStan handles reverse geocoding intersections close to the input geocode.

•0 – Does not return intersections.

•1 – Returns intersections.

Used for reverse geocoding, Predictive Lastline and PreciselyID Fallback. It defines, in feet, the search area.

The number of feet GeoStan will set the geocode back off the street segment when interpolating a geocode from a house number on a segment.

Incompatible with offsetDist. Sets the value for GS_FIND_STREET_OFFSET.

•0 – Supresses messages from GsErrorGetEx (default).

•1 – Prints messages from GsErrorGetEx.

Specifies the frequency with which the application writes status messages indicating the number of processed records.

•0 – No progress message.

•10 – Default. Display messages every 10 records.

Note: By default, the program sets this value to 0 if the command line specifies a log file or if the application is running under z/OS.

The number of sequential records you want processed. stopAt=10000 will end after 10K input records have been processed.

Specifies whether or not to return a street segment geocode as an automatic geocoding fallback.

•0 – Default. Street locator disabled.

•1 – Return street segment geocode.

Note: Invalid for CASS match mode.

The number of feet GeoStan squeezes street segments when interpolating geocodes from house numbers. Reverse Geocoding also uses this same value to reverse interpolate a house number from a geocode along the same segment. Incompatible with offsetDist.

Sets the value for GS_FIND_CORNER_OFFSET.

Directory containing Suite^Link data.

Enable Suite^Link Find.

•0 = Disabled.

•1 = Enabled (standard default).

Obsolete, warning will be logged.

•0 – Default. Process all records whether previously matched or not. Used when processing in CASS mode.

•1 – Process only records that the application has not previously processed successfully. Pass input directly to output without processing if outLat exists (not blank), outLon exists (not blank), outMatchCode exists (not error and not blank), outLocCode exists (not error and not blank), and matchMode does not equal 4.

•0 – Do not assign centroid geocodes.

•1 – Default. Use if no address geocode is available.

•2 – Use ZIP centroid geocoding only (no address matching).

Note: Requires z9dir if a non-0 value.

•0 – Uses the default database search order, determined by the GeoStan database priority ranking. Value 0 is the default and the behavior is therefore backwards compatible with previous versions of geocoder.

•1 – Sets the search order according to how the directories in the path keyword are specified. See also GS_FIND_DB_ORDER.

Date of the GeoStan data media used to process the address file, in the format mmddyy. For z/OS only.

Address line. When using this field, set multiLine to 0.

Second address line. When using this field, set multiLine to 0. Use multiPref to specify a preference for P.O. Box or street address. Ignore if processing in CASS mode.

City name.

Firm name.

Combined city, state, and ZIP Code.

Latitude of the geocode for the desired address.

Multiline mode input fields. When using, set multiLine to 1.

Longitude of the geocode for the desired address.

12-character alpha-numeric PreciselyID unique identifier used to perform a Reverse PreciselyID Lookup.

State name or abbreviation.

Urbanization name. Only valid for Puerto Rico.

ZIP Code.

Compass direction, in decimal degrees, from the point data match to the centerline match. Measured clockwise from 0 degrees north.

Data type used to make the centerline match

• 0 – USPS
• 1 – TIGER
• 2 – TomTom
• 6 – HERE
• 7 – TomTom point-level
• 9 – Auxiliary file
• 10 –  User Dictionary
• 11 –  HERE point-level
• 12 – Master Location Data

Distance between the input point and the centerline in feet

Matched centerline record located via an alias index.

Latitude in millionths, for a centerline match

Longitude in millionths, for a centerline match

Primary street name, for a centerline match

Street postfix directional, for a centerline match

Street prefix directional, for a centerline match

• F – Numbers are forward on a centerline match
• R – Numbers are reversed on a centerline match

Unique segment ID from data vendors, specific to a centerline match

Street type (street suffix), for a centerline match

Address line

Address line less than 30 characters when possible.

Second address line

Address Type regarding number of units:

• S – Single unit
• M – Multiple units
• P – Post Office box
• X – Unknown

Assessor's Parcel Number (APN)

User data from the auxiliary file. Blank if no auxiliary file.

15-digit census block ID

15-digit 2010 Census Block ID

Returns the candidate number when keepMultiMatch or printCandidates is enabled.

Value will be blank or 0-n to indicate candidate number in the possible match list.

Carrier route

• 0 – Default. Do not write the CASS header to the geocoder output file
• 1 – Write the CASS header to the geocoder output file

CBSA division name

CBSA division number

• •Y – CBSA is Metropolitan Statistical Area
• •N – CBSA is Micropolitan Statistical Area
• •Blank – Data is unavailable

CBSA name

CBSA number

CSA name

CSA number

Check digit

City name

City name for the matched address

Preferred city name for the matched address

Short City Name less than13 characters when possible.

CMSA number

CMSA name

County FIPS code

County name

Data type used to make the match:

• 0 – USPS data
• 1 – TIGER data
• 2 – TomTom data
• 6 – HERE data
• 7 – TomTom point-level data
• 9 – Auxiliary file data
• 10 - User Dictionary
• 11 –  HERE point-level data
• 12 – Master Location Data

Matched to Highrise or Rural Route

Delivery point bar code

DPV confirmation indicator

DPV Vacant Indicator.

DPV CMRA indicator

DPV false-positive indicator

DPV Footnote 1

DPV Footnote 2

DPV Footnote 3

DPV Footnote 4

DPV Footnote 5

DPV Footnote 6

DPV no stat indicator.

EWS denied match

Firm name

Highrise default flag

House number of entered address

House number of entered address.

Incorporated Place Indicator.

• I – Incorporated place
• N – Not an incorporated place
• X – Unknown

Matched record located via an alias index

Intersection flag

Complete last line (city, state, ZIP + 4)

Complete Last Line (city, state, ZIP+4) less than 30 characters when possible.

LACS^Link code

LACS^Link return code

LACS^Link indicator

Latitude in millionths

Location code

Longitude in millionths

LOT code

LOT number

Lot size of the parcel expressed in square feet; 0 if none.

Lot size of the parcel expressed in square meters; 0 if none.

Mail Stop

Match code

Database matched against. Use in conjunction with GsGetDBMetadata

Minor Civil Division name from the auxiliary file. Blank if no auxiliary file match.

Minor Civil Division number from the auxiliary file. Blank if no auxiliary file match.

MSA name

MSA number

Primary street name

Second street name (cross street)

Intersection Cross Street Short Name .

Street Short Name corr to outAddressShort.

Distance, in feet, from the input location to the matched street segment, point address, or intersection.

Indicates if the USPS can deliver mail to the output address.

Y - the address is not deliverable by the USPS or the address did not match.

N - the address is deliverable by the USPS.

Return value from GsNumMultiple() not GsDataGet() call.

Elevation, in feet, at the parcel centroid.

Elevation, in meters, at the parcel centroid.

Precisely ID of the address without units or blank if there are no units

This output field is a unique address identifier returned when an address match is returned from the Master Location Dataset. The leading character is a 'P'. For example: P00001XSF1IF

When using approxPBKey, the leading character for this field is an 'X'. For more information, see PreciselyID Fallback

TIGER Place code; 0 if none.

Private mail box designator; always "PMB"

Private mail box number

Percentage along the street segment to the interpolated match. The range is 0.0 - 100.0. The range is always 0.0 for point data and intersections.

Returns the unique point ID of an address

Indicates if the ZIP Code has only PO Box addresses. Those addresses can be either a PO Box or a PO Box street address (PBSA).

Y - The ZIP Code has only PO Box addresses.

N - The ZIP Code does not have only PO Box addresses.

Street postdirectional

Cross street postdirectional

Intersection Cross Street Short Postdirectional.

Street Short Post-directional corr to outAddressShort.

Primary street predirectional

Secondary street predirectional

Intersection Cross Street Short Predirectional.

Street Short Predirectional corr to outAddressShort.

County property account ID

USPS range record type

R – Residential use

B – Business use

M – Mixed use – residential and business

X – Unknown use

Result code.

Rural route default flag

Unique segment ID from data vendor

• F – Numbers are forward
• R – Numbers are reversed

2-letter state abbreviation

Side of the street of the matched address

• L – Left side
• R – Right side
• B – Both sides
• U – Unknown side

Suite^Link Return Code.

TIGER Face Identifier. This field can be used to match to all

Census geocodes using external data; 0 if none.

Runtime for GsFind for each address processed by Geocoder.

Street type (also called street suffix)

Cross street type (also called street suffix)

Intersection Cross Street Short Type.

Street Short Type corr to outAddressShort.

TIGER Urban Area Identifier. Defines the urban area if any; 0 if none.

Census population of the urban area; 0 if none.

Unit number

Second unit number in the address line

Unit type (designator)

Second unit type in the address line

Urbanicity Indicator. An indicator that defines per the Census the

Urbanicity of the Address using TIGER UACE codes for

categorization.

L – Large Urban Area (50,000 or greater population)

S – Small Urban Area (2,500-50,000 population)

R – Rural

X – Unknown

Urbanization name for Puerto Rico

ZIP Code

Describes if the output ZIP Code is valid.

Y:

• For matched (coded) addresses.
• For a failed address, if the input City/State matches the input ZIP.
• For a failed address, if the City/State contains only one ZIP Code, it will be added and the flag set to Y.

N: For all other cases

ZIP + 4

N – ZIP + 4 has not changed

Y – ZIP + 4 changed

9-digit ZIP Code

Specifies how addresses and unranged streets are processed with reverse geocoding.

•0 – Default. Does not match to an address.

•1 – Matches to points and interpolated addresses, but does not match to any unranged segments (such as highways).

•2 – Matches to all types of street segments.

In a reverse geocoding operation, specifies whether the match is made to the closest feature or point address.

Note: Implementation of this feature requires that at least one points data set and one streets data set are loaded; otherwise, the match will be made to the closest feature.

•0 – Default. Matches to the closest feature including street segments and intersections in addition to address points.

•1 – Matches to the closest point address within the search radius.

In a reverse geocoding operation, specifies how GeoStan handles intersections close to the input geocode.

•0 – Does not return intersections.

•1 – Returns intersections.

Latitude of the geocode for the desired address.