Global Geocoding Module
PB Support Location for Geocoding Product Documentation
We now have a permanent location for geocoding product documentation on the PB Support Site at Geocoding Support. Go here first to find user guides, developer guides, database and software release notes for our geocoding products.
PBLocator REST API for ArcGIS
Spectrum Technology Platform's PBLocator for Geocoding service is an option that provides Pitney Bowes geocoding services within an ESRI environment.
PBLocator for Geocoding requires an installation of Spectrum Technology Platform 2018.2.0 and a licensed Global Geocoding Module.
PBLocator supports the following ESRI operations:
- findAddressCandidates: Geocode one location or address at a time using a GET request.
- geocodeAddress: Geocode a list of addresses as a batch with a single POST request.
- reverseGeocode: Return address or place candidates when given an XY location in a GET request.
- suggest: Provide suggested candidates based on user input character-by-character typing in a GET request.
For more information, see the Global Geocoding REST Web Services Guide.
Custom Dataset Builder
Custom Dataset Builder is a utility to create new datasets for use in the Global Geocoding Module and web service API. This tool allows users to integrate their own location data in a consumable format for use in any of Pitney Bowes's existing geocoders in the same way standard address datasets are used.
Custom Dataset Builder creates custom datasets using location data from more than 100 countries and languages. Data must be in TAB format (native or nativeX).
Custom Dataset Builder can create datasets for address ranges and point locations. Supported operations include forward geocoding of streets, street intersections and address points. Forward geocoding is supported for all supported countries except Israel. Reverse geocoding is supported for all countries except USA. Data created with Custom Dataset Builder does not support interactive geocoding at this time.
Datasets created with Custom Dataset Builder are compatible with Spectrum 12.2 and later and the Q2 2018 and later data refreshes. It is not backward compatible.
The result code for street geocoding contains a "U" for user datasets to distinguish it from "A" when candidates are from the standard address datasets. For example: S5HPNTSCZU instead of S5HPNTSCZA.
Custom Dataset Builder is a command line driven tool. Configuration is done through JSON.
The Custom Dataset Builder User Guide is included in the .zip file with the tool. Instructions are also provided in the Global Geocoding User Guide.
Interactive Geocoding for World Places
Now available for the Global Geocoding Module is a World Places Interactive dataset that allows you to locate world cities and postcodes with minimal typing. The World Places dataset is optimized to return potential match candidates when only a few characters are typed in. This makes this dataset ideal for use in mobile applications that need to find places easily.
This dataset bridges the gap where there is no country-level interactive dataset available. It contains world cities, administrative areas above the city level and postcodes. There is no street data. It supports names in multiple languages if they exist. Input is a string containing city name or postcode, and optional XY coordinates and country.
Use World Places with the GGM Interactive stage to search for city names or post codes. A new search type called World Places is available for this purpose. The REST API parameter name is SEARCH_WORLD_PLACES. The Match Mode is Standard.
World Geocoder Only Preference
New in this release of the Global Geocoding Module is the ability to set that only the World Geocoder is used for geocoding. Since you can only configure one database for GGM, add all of your data in GGM, then use this preference to run World data without having to configure it separately. This preference is available for forward geocoding only.
Fallback to World Geocoder
Fallback to World Geocoder geocoding preference in Global Geocoding Module has been enhanced to be used with any country geocoder. This setting will return a match candidate from the World Places dataset if a street match with the country geocode cannot be made. Previously it would only fallback if the country geocoder was missing.
Updated USA Geocoder
Global Geocoding Module has been updated with the latest geocoder for USA.
Allow PBKey Fallback for USA
Use Allow PBKey Fallback when an address that does not match one in the Master Location Data (MLD), matches to a different dataset. The pbKey™ unique identifier of the nearest MLD point located within the search distance is returned. The fallback pbKey™ unique identifier distinguishes itself from an exact MLD pbKey™ unique identifier with a leading “X” in the return value, for example X00001XSF1IF. An exact match MLD pbKey™ unique identifier begins with a “P”.
Expanded Centroids
The Expanded Centroids feature is available for geocoding U.S addresses when Master Location Data (MLD) and the optional purchase Master Location Structure Centroid Data Set (MLDB) is installed. If an address match is found in MLD, the MLDB data set is searched for additional geocodes for the matched address. If additional candidates are found for the matched address, these are returned. Previously when more than one point-level geocode is found for an address only the highest quality geocode candidate is returned.
POI Matching
User of the Global Geocoding Module can now take advantage of matching U.S. addresses to buildings, firms and other points of interest by using a point of interest index file (poi.gsi) included with Master Location Data and HERE Point addresses. This optional file provides expanded support in alias name matching.
To take advantage of this, check the Building Search on Address Line
checkbox in Management Console or Enterprise Designer. For REST calls the preference is
FIND_BUILDING_SEARCH. The POI Index file will automatically be searched
when this option is enabled and a firm, building or POI name is specified in the
mainAddress input field. POI matches are returned in the
IsStreetAlias field. Enable the return of this fields by setting the
Segment checkbox Return Values preference.
New Return Values for IsAlias
The USA geocoder has been updated to provide new return values for the IS_ALIAS field:
- 13 - ZIPMove match (when using us.gsz)
- 14 - Expanded Centroids match (when using us_cent.gsc).
The us.gsz data file contains ZIP+4 codes that have been realigned and a change in city name and/or finance number has occurred. Specifically, ZIPMove allows a change in finance area because CASS searching does not allow a change of finance area unless the input city occurs in more than one finance area, or ZIPMove data contains the old address.
Expanded centroids are additional candidates for the matched address when MLD and MLDB (us_cent.gsc) are both loaded.
Improvements in Singleline Address Matching for USA
Prefer Input Street Information over PO Box
Improvements have been made in singleline processing to prefer the input street information over a PO Box. For example:
Input: MARVIN R BECK PT 1108 E PATTERSON/ POB 160 KIRKSVILLE MO 63501
Old match: PO BOX 160
New match: 1108 E PATTERSON ST
Embedded POIs
Enhancements have been made in singleline POI matching to recognize one or more embedded POIs. For example:
Input: FIRST SHORE FEDERAL SAVINGS & LOAN W GREEN ST & PEARL ST SNOW HILL
Result: FIRST SHORE FEDERAL SAVINGS & LOAN, SNOW HILL MD 21863
Ambiguous Street Names
Improvements have been made in handling of street names that could also be city names in singleline address processing. For example:
Input: BOX 58 ASHAWAY RI 02804
Previous match: 58 ASHAWAY RD, 02804
New match: BOX 58, ASHAWAY RI 02804
Post Office Box or #
Improved singleline matching for PO Boxes when entered as POST OFFICE BOX, or when the number is preceded by #.
Multiple Intersections
Improved handling and reporting of singleline matching of addresses containing multiple intersections when using Master Location Data. For example: 8th & laurel & 9th 21851.
Missing or Out of Range House Numbers
Improved handling of singleline input addresses with missing or out of range house numbers. Matches and non-matches are now returned more accurately.
Enhancements to POI Matching for USA
- Singleline input address containing a POI that ends with a city name that matches a given ZIP Code. For example: CHARTER HOSP OF DENVER 80228
- Singleline input address containing a POI that ends with a state name that matches a given ZIP Code. For example: BANK OF COLORADO 80720
- Two-line or singleline input address containing a POI that ends with a number. For example: KBIQ 102 7 80920
Matching Enhancements for USA
Addresses with PO Box #
Improvements have been made in the handling and matching of PO Box addresses that contain a “#” sign in front of the box number. For example: PO BOX #14.
Addresses with Underscore
Improvements have been made in the handling of input addresses containing underscores. For example: __4750 Walnut St. 80301_.