Custom Preferences - geo_addressing_sdk - 23.1

Spectrum Global Geocoding Guide
Product type
Software
Portfolio
Locate
Product family
Spectrum
Product
Spectrum > Geo Addressing > Global Geocoding
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Global Geocoding Guide
Copyright
2023
First publish date
2007
Last updated
2024-09-10
Published on
2024-09-10T01:25:02.872726

The following table lists the preferences that are unique for USA. These custom fields are optional , and unless otherwise noted, they are available for both Geocoding and Reverse Geocoding. For the standard set of preferences available to all countries and their definitions, see the chapters covering Global Geocode and Global Reverse Geocode.

Option Name Description
Global Geocode preferences: Matching tab > Search Criteria
Search Area These preferences set the search constraints to use when matching. These can assist in finding a match when the input address contains limited or inaccurate city or ZIP Code information.
Note: The following Search Area preferences are ignored in CASS match mode; the default value is used.
Finance Area
Searches the entire Finance Area for possible streets. Default.
Note: This preference has no effect when performing a ZIP centroid match or a geographic geocode.
City
Searches the specified city.
Search Radius
Allows the setting of the search radius distance to use when matching.
Search Radius - limit to state
Allows for limiting the search to the state.
Note: Supported only in forward geocoding.
Search Radius Distance When the Search Radius preference is selected, this field allows you to enter the search radius distance to use when matching. You can select either miles or kilometers. The max. radius setting is 99 miles/159 kilometers. The default radius distance is 25 meters.
Note: Ignored in CASS match mode.
Note: In Global Reverse Geocode, the Search Distance is a Global Defaults preference.
Then enter the radius value in the Search Radius Distance input textfield and select your unit of measurement using the dropdown menu.
Search on first letter of Street Address Specifies whether to look for the correct first letter of a street name if the first letter is missing or incorrect. If selected, the Spectrum Global Geocoding searches through the alphabet looking for the correct first letter to complete the street address. Default = disabled.
Note: Ignored in Exact match mode.
Note: Supported only in forward geocoding.
Check for first letter Missing/Wrong Enables extra processing for bad first letter (missing, wrong, etc.). Default = disabled.
Note: Ignored in Exact match mode.
Note: Supported only in forward geocoding.
Global Geocode preferences: Matching tab > Conflicting input
Prefer Zip over City Prefers candidates matching the input ZIP Code over matches to input city. Default = disabled.
Note: Ignored for CASS and Autocomplete match modes. Autocomplete match mode attempts to return the best address regardless of this setting.
Note: Supported only in forward geocoding.
Prefer PO Box over Street Address If both a street address and a PO Box are provided in the input address, the PO Box is used for matching. Default = disabled.
Note: Ignored in CASS match mode.
Note: Supported only in forward geocoding.
Firm name lookup Determines whether the preferred lookup is to look for only a street match, the streets first or the firms first.
Disabled
Do not use firm name matching. Default.
Match street only
Matches to the address line.
Attempt street match first
Matches to the address line, if a match is not made, then matches to the Place Name line.
Attempt firm match first
Matches to the Place Name line, if a match is not made, then matches to the address line.
Note: Ignored in CASS match mode.
Note: Supported only in forward geocoding.
Global Geocode preferences: Matching tab > Find Options
Building Search on Address Line Attempts to obtain a street address when the input address contains a building name with no suite or unit number.

When this preference is disabled, Global Geocoding is able to match to building names only if there is a unit number in the input. Default = disabled.

Note: Ignored in CASS match mode.
Note: Supported only in forward geocoding.
Allow Ranged Address Numbers Some business locations are identified by address ranges. For example, a shopping plaza could be addressed as 10-12 Front St. This is how business mail is typically addressed to such a business location. These address ranges can be geocoded to the interpolated mid-point of the range. Default = disabled.
Note: Ignored in Exact or CASS match modes (an address range is not an actual, mailable USPS® address).
Note: Supported only in forward geocoding.
Street Locator Specifies whether to return a street segment geocode as an automatic geocoding fallback. Default = disabled.
Note: Ignored in CASS match mode.
Note: Supported only in forward geocoding.
Global Geocode preferences: Geocoding tab
ZIP Code Centroid Level A ZIP Code centroid match returns the center point of an area defined by one of the following types of ZIP Codes:
Any
Returns the most accurate ZIP Code centroid match found. Default.
9-Digit ZIP
Returns the center point of a ZIP + 4 Code area.
7-Digit ZIP
Returns the center point of a ZIP + 2 Code area.
5-Digit ZIP
Returns the center point of a ZIP Code area. This is the least accurate of the ZIP Code centroids.
Note: Supported only in forward geocoding.
Calculate Centerline Projection of Point Computes the closest point on the street from the parcel point. Default = disabled. Use this with Centerline Offset to set a new point along the centerline that may be more appropriate for some use cases, such as routing where you want the geocoded point closer to the edge of the parcel.
Note: This feature requires that a point-level geocoding dataset is installed.
Note: The result code for centerline matches is SC.
Centerline offset Centerline matching is used with point-level matching to tie a point-level geocode with its parent street segment. This functionality is useful for routing applications.

The centerline offset specifies the distance to move the point from the street centerline toward the parcel point. Default = 0 meters.

You can select either Feet or Meters for your unit of measurement.

Note: Centerline matching requires that a point-level geocoding dataset is installed.
Note: Supported only in forward geocoding.
Global Geocode preferences: Return Values tab
For information about the return fields for USA, see Custom Output Fields.
Mixed case output address Returns candidate information in mixed case rather than uppercase. Default = mixed case.
Output corrected last line Corrects elements of the output lastline, providing a good ZIP Code or close match on the soundex even if the address would not match or was non-existent.
Note: Supported only in forward geocoding.
Return coordinates as integer Returns the LAT and LON custom output fields as integer values in millionths of degrees. The default is the LAT and LON custom output fields are returned as decimal values.
Note: Supported only in forward geocoding.
Global Reverse Geocode preferences: Reverse Geocoding tab > Find Options
Find Options - These preferences set the constraints to use when matching.
Nearest Address Attempts to match to the nearest address. Default = enabled.
Nearest Intersection Attempts to match to the nearest intersection match. Default = disabled.
Nearest Unranged Segment Attempts to match to the nearest unranged segment. Default = disabled.
Prefer Match to Closest Point Attempts to match to the nearest point address within the search radius, rather than to the closest feature (for example, street segment or intersection as well as point addresses). Default = disabled.
Note: This feature requires that at least one points dataset and one streets dataset are loaded; otherwise, the match will be made to the closest feature.
Keep multiple matches Select this preference to return candidate addresses whenever the match attempt produces candidates. If you enable this preference, the geocoder will return candidates both when the input address matches to a single address and when the input address matches multiple addresses. Default =disabled.
Global Reverse Geocode preferences: Return Values tab
For information about the return fields for USA, see Custom Output Fields.
FIND_APPROXIMATE_PBKEY When set to true, enables the PBKey Fallback preference. If an address match is not made to Master Location Data (MLD), but is made to a different dataset, the pbKey™ unique identifier of the nearest MLD point located within the search distance is returned. To distinguish when a fallback pbKey™ unique identifier is returned, the PB_KEY return value contains a leading character of "X" rather than "P", for example: X00001XSF1IF. Note, all of the other fields returned for the address match, including the geocode and all associated data, reflect the match results for the input address. The fallback pbKey™ unique identifier can then be used for the lookup to the GeoEnrichment dataset(s), and the attribute data for the fallback location is returned for the match. Default = false.

For more information, see PreciselyID Fallback.

The search distance for the nearest MLD point that contains a pbKey™ unique identifier is configurable:

  • For forward geocoding, use the FIND_SEARCH_DIST preference. For more information, see FIND_SEARCH_DIST.
  • For reverse geocoding, the search distance is the same that is used for the reverse geocoding search radius, use preferences:distance. For more information, see Reverse Geocode POST Request.
The allowable search radius is 0-5280 feet. The default is 150 feet.
FIND_SEARCH_DIST When FIND_APPROXIMATE_PBKEY is enabled, this parameter sets the distance to use when searching for the nearest address record with an associated pbKey™ unique identifier. The allowable range is 0-5280 feet. Default = 150 feet.
Note: Supported only in forward geocoding.