The Geocode Address step provides latitude and longitude coordinates for addresses using geocoding, requiring a data subscription for processing. It offers various configuration options, including match modes and output casing, and supports multiple address sets. The output includes geocode precision and confidence levels, with specific precision codes indicating the accuracy of the address match.
The Geocode step returns latitude and longitude for each address using geocoding. This requires a data subscription to process addresses. The step can be added to a pipeline without a subscription, but the pipeline will not run without the subscription entitlement for the workspace. Different entitlements are required for different countries.
Geocode returns the latitude and longitude coordinates for an address in decimal degrees to 7 decimal places (which is the practical limit of commercial surveying). Geocoding uses address information to return the geolocation coordinates. For example, the geolocation for the Chrysler Building address (405 Lexington Ave, New York, NY 10174) is latitude 40.7516248 and longitude -73.9776961.
- To use the Geocode step in Data Quality pipelines with a connected Snowpark data source, you must set up an environment for the Snowpark data source that defines verify external functions in Snowflake.
- The name of the external function for the Geocode operator must be precisely_geocode.
- When the Geocode operator is added to a pipeline, address data will be sent to the Precisely Cloud through the Geocode external function.
- The Geocode operator currently only supports the string data type for user-defined functions in Snowflake.
- Related Information: UDF in Snowflake for Address Verification and Geocoding in Data Quality
Configuring the steps
Step Properties Tab
| Field | Description |
|---|---|
| Step Name | Define a meaningful name to identify the purpose of the step. |
| Subscription | Data processing is restricted to specifically subscribed regions.
Select an available region(s) from the drop-down menu. The regions
are divided into AMER, EMEA,
and APAC, and each region is divided into three
tiers:
Note:
|
| Default Country Code | Specifies the country to be used when no country is specified in the input. The selected country must have a subscription entitlement. |
Geocoding options
Geocoding options include address point interpolation for accuracy, and match modes (Exact, Standard, Relaxed, Custom) to determine leniency in matching input addresses. Output casing options (Upper, Lower, Proper) define address output format, with parsed input or alternative language fields available for display customization.
| Field | Description |
|---|---|
| Use address point interpolation | Address point interpolation is a patented process that results in a more accurate interpolated point. It improves upon regular street segment interpolation by using point data in the interpolation process, as opposed to using street segments alone. |
| Match Mode |
Match modes determine the leniency used to make a match between the input address and the reference data. Select a match mode based on the quality of your input and your desired output. The following match modes are available:
|
| Output Casing |
It defines the casing of the address output field. There are three types of casing available: Upper, Lower, and Proper. The output can be returned in two ways:
|
Mapping address sets
An address set schema contains standard address field types. Here are the key schema fields:
| Field | Description | Example |
|---|---|---|
| FirmName | Organization, place, or building | United Nations Headquarters |
| AddressLine1 | Street portion of the address | 10 Downing Street |
| AddressLine2 | Unit, suite, or apartment | Apt 534 |
| City | City or town name | London |
| CitySubdivision | Neighborhood, borough, or other subdivisions | Brooklyn |
| StateProvince | Primary division of the country | New York |
| StateProvinceSubdivision | Secondary division, such as a county | Nassau County |
| PostalCode | Postal code of the address | 10032-3725 |
| Country | Country name or ISO code | USA or GBR |
Additional address set
You can add another address set by clicking Add another address set. This allows mapping of multiple addresses such as shipping and billing addresses. Each added address set is assigned an incremental name (Address_set_2, Address_set_3, etc.), and you can map input fields for each address set.
Output configuration
This tab lists the output fields defined by the Step properties settings. You can include or exclude fields by selecting or clearing checkboxes next to field names. The number of selected fields and the total number of fields are displayed (e.g., Output configuration (3 of 6)) as you configure settings on the Step properties tab.
precisely_geocode. When the
Geocode operator is added to a pipeline, address data will be
sent to the Precisely Cloud through the geocode external
function.Geocode output fields
When you select the Geocode, the following fields are included in the output:
| Field | Description |
|---|---|
address-set-name_Latitude
|
The geocode latitude value in decimal degrees (e.g., 40.7516248). |
address-set-name_Longitude
|
The geocode longitude value in decimal degrees (e.g., -73.9776961). |
address-set-name_GeocodeLevel
|
The type of geocode used to determine
the latitude and longitude. The following outputs are available
under geocode level:
|
address-set-name_GeocodePreciselyID
|
PreciselyID is a unique identifier. It can serve as a lookup key to add attributes to an address from Precisely Enrichment datasets. |
address-set-name_Confidence
|
The level of confidence assigned to the address being returned. Range is from 0 to 100. Zero indicates that no match was found. 100 indicates a very high level of confidence that the match results are correct. The step returns -1 when it is unable to perform verification. |
address-set-name_GeocodePrecisionCode
|
The precision code is a string that describes the precision of the address match for the input address. |
Precision code
The precision code is a string that describes the precision of the address match for the input address. This topic describes the precision codes used to indicate the level of address match for a given input address.
Postal Code Match (Z-category): Matches in the Z category indicate that a match was made at the postal code level.
| Code | Description |
| Z1 | Match to ZIP Code™ or postal code 1. |
| Z2 | Match to ZIP + 2 or partial match to postal code 2. |
| Z3 | Match to ZIP + 4® or postal code 2. |
Area Name Match (G-category): Matches in the G category indicate that the record was matched to an area name.
| Code | Description |
| G1 | Match to state/province (area name 1). |
| G2 | Match to country/region (area name 2). |
| G3 | Match to city/town (area name 3). |
| G4 | Match to suburb/village (area name 4). |
PO Box Match (B-category): Matches in the B category indicate that the record was matched to a PO Box.
| Code | Description |
| B1 | Matched to an unvalidated PO Box. |
| B2 | Matched to a validated PO Box. |
Single Address Match (S-category): Matches in the S category indicate that the record was matched to a single address candidate.
| Code | Description |
| S0 | Single match, coordinates unavailable. |
| S1 | Single match to a ZIP Code™ or postal code 1 level. |
| S2 | Single match to a ZIP + 2 or partial match to postal code 2 level. |
| S3 | Single match to a ZIP + 4® or postal code 2 level. |
| S4 | Single match at the street level. |
| S5 | Single match to the street address. |
| S6 | Single match to a point located at a ZIP centroid. |
| S7 | Single match to a street address that was interpolated between houses. |
| S8 | Single match to the street address or house number. |
| SC | Single match at the house-level projected from the nearest segment. |
| SG | Single match with point at the center of a locality (areaName3) or Locality level geocode derived from topographic feature. (Australia addresses only.) |
| SL | Single match to a sublocality (block or sector) street level match. (India addresses only.) |
| SX | Single match to a point located at a street intersection. |
Street Matched Precision Codes: For S (street matched) precision codes, eight additional characters describe how closely the address matches an address in the database. The characters appear in the order shown.
| Character | Description |
| H | House number match. |
| P | Street prefix (pre-directional). |
| N | Street name match. |
| T | Street/thoroughfare type match. |
| S | Street suffix (post-directional). |
| C | City or town name. |
| Z | Postal code match. |
| A | Addressing dataset match. |
| U | Custom user dictionary match. |