UK-ROI Geocoder Macro

Use the UK-ROI Geocoder to geocode UK and ROI addresses by querying and downloading data from TomTom's Geocoder API. The UK-ROI Geocoder produces a record-for-record geocode result, including lat/long coordinates and a spatial object. In addition, it produces a summary output that provides a count of records per match type.

Macro Tool

This tool is a macro that requires a separate data install and license. To use this tool, contact your Account Executive.

Configure the Tool

There are 2 tabs that require your input to successfully configure this tool: Input and Output.

Input Tab

Configure the address fields:

Multiple Address Fields: If address information is contained in multiple fields, select this option. Use the dropdowns to select the fields in the incoming data stream that map to these address fields:

Address
Locality
Post Town
Postcode
Country

Single Address Field: If address information is contained in a single field, select this option. Use the dropdown to select the field in the incoming data stream that contains the address information.

Options Tab

Select Output Fields: Check the fields to include in the Geocoded (G) output. Output fields are described in detail below.
GeoLevel Match Summary: Specify how records should be sorted in the Summary (S) output. Choices are...
- Sort by Accuracy (Best - Worst): The GeoLevels are sorted by their accuracy, with the most accurate GeoLevel at the top.
- Sort by Match Count (Max - Min): The GeoLevels are sorted by the number of input records that match each GeoLevel, with the maximum number at the top.
Additional Options: Configure these additional options, as needed.
- Preserve Input Fields: When checked, the tool outputs the original field names specified on the Input tab. Left unchecked, the specified fields are renamed to Address, City, State, and ZIP.
- Select Match Threshold Level: Use the dropdown to specify the match threshold:
  - 2 (default)
  - 3
  - 4 (lowest match threshold - slowest speed)

Output Details

There are 2 outputs from this tool:

G Anchor

G anchor: Geocoded records stream out of the tool, labeled with a G. This data stream includes your original data records and Address fields, along with the additional fields you selected to output from the Geocoder Options tab.

Field Name	Description
FreeformAddress	An address line formatted according to the formatting rules of the result's country of origin.
StreetNumber	The building number on the street.
StreetName	The street name.
MunicipalitySubdivision	Sub or Super City
Municipality	City or Town
CountrySecondarySubdivision	County
CountrySubdivision	State or Province
Country	Country Name
CountryCode	A country's code (This is a two-letter code, not a country name.)
CountryCodeISO3	ISO alpha-3 country code.
PostalCode	Postal Code or Zip Code
Lat	Latitude
Lon	Longitude
Score	The score of the result. A larger score means the probability of a result meeting the query criteria is higher.
Type	The type of the result. Returns one of `Street`, `Geography`, `Point Address`, `Address Range`, `Cross Street`.
SpatialObj	The geographic representation of the address as a single point.

S Anchor

S anchor: A Data summary streams out of the tool, labeled with an S. The data stream includes 2 fields: Match type and Count, to signify the success of the geocoding process. There are 6 possible GeoLevels listed below in order of best to worst.

Field Name	Description
Point Address	The input address matches points on a map where a specific address with a street name and number can be found.
Address Range	The input address matches an address range. For some streets, address points are interpolated from the beginning and end of the street. These points are represented as address ranges.
Geography	The input address matches an area on the map that represents an administrative division of a land, such as a country, state, or city.
Street	Input address matches to a house number along an address range. The data returned is an interpolated location of the requested address within that range.
Cross Street	Input address matches two streets that intersect.
None	The geocoder can't find a location that matches the input data.

In this section: