Split Match Narrative Into Fields (Geocoding Tools)

Summary

Splits match narrative results into multiple fields and appends them to a geocoded feature class.

Usage

Use this tool when you want to see the details of how each geocoded address was matched and query those fields to learn more about the data.
You must select the MatchNarrative field from the dropdown for the Match Narrative Field parameter to populate the fields returned by this tool.
When working with data that requires many geocoded addresses to be rematched, use the output of this tool as the input for the Rematch Addresses tool. The appended fields can be queried for improved address rematch and review workflows.
- You can also rematch addresses using a SQL query based on the match narrative fields created by this tool.
Using this tool appends populated match narrative fields to the input geocoded feature class and increases the number of records. The size of the feature class and number of records will increase after using this tool.
A geocoded point feature class with a field containing the match narrative text is required.
- This tool can only be run if you use a locator built in ArcGIS Pro 3.7 to geocode a table with the Geocode Addresses tool or Batch Geocode tool and the Add match narrative to output option selected for the Match Narrative parameter.
This tool adds the following fields by default:
- MatchNarr_ID—The join field between the geocoded input table and newly created split fields table.
- seq—The position of the component in the input string, represented as a number. This field records the address component's original sequence in the input string so that the order can be preserved.
- field—The address component that the input part was matched to.
- code—A code that describes how the input part was matched. Multiple codes may be used to describe the match narrative for a particular input part.
  - c—Classified. The input part was recognized as an address value from the reference data, an alias, or an indicator of some kind.
  - m—Matched. The input part was matched to an address value in the reference data.
  - i—Inexact. The input part is spelled differently than what it matched to.
  - p—Partial. The input part matched to a portion of a value in the reference data.
  - s—Split/concatenated. Indicates that a match was made to a value in the reference data by splitting one word from the input into multiple words, or by concatenating multiple words from the input into a single word.
  - a—Aliased. The input part matched to an alias of a reference data value.
  - r—Repositioned. Indicates that the input part was matched to a value in the reference data but in the wrong part of the overall address.
  - d—Different. Indicates that the input part was recognized as a particular address component but matched to a different reference data value for that component.
  - n—Nearby. Indicates that the input part matched to a postal code or administrative zone which is adjacent to the postal or zone that the geocoded address is actually within.
  - e—Extrapolated. Indicates that the input part matched outside of the house number range for a StreetAddress record in the reference data.
- input_field—The classification of the input part of the string.
  - Address—A string that represents the first line of a street address. This field is used for street name and house number input, but it can also be used to input building name or place-name.
  - Address2—A string that represents the second line of a street address. This can include street name/house number, building name, place-name, or subunit.
  - Address3—A string that represents the third line of a street address. This can include street name/house number, building name, place-name, or subunit.
  - Neighborhood—The smallest administrative division associated with an address, typically, a neighborhood or a section of a larger populated place. A neighborhood is a subdivision of a city.
  - City—The next largest administrative division associated with an address, typically, a city or municipality. A city is a subdivision of a subregion or a region.
  - Subregion—The next largest administrative division associated with an address. Depending on the country, a subregion can represent a county, state, or province.
  - Region—The largest administrative division associated with an address, typically, a state or province.
  - Postal—The standard postal code for an address, typically, a three- to six-digit alphanumeric code.
  - PostalExt—A postal code extension, such as the United States Postal Service ZIP+4 code.
- input—The part of the input string that is being described.
- datum—The value in the locator reference data that the input part matched to.

Label	Explanation	Data type
Input Geocoded Features	The point features that are the output of geocoding a table with the Geocode Addresses tool or Batch Geocode tool.	Feature Layer
Match Narrative Field	The field from the Input Geocoded Features parameter value that contains the unparsed match narrative text.	Field

Derived output

Label	Explanation	Data type
Updated Geocoded Features	The updated input geocoded feature class with the parsed match narrative text and match narrative fields joined to it.	Feature Layer

arcpy.geocoding.SplitMatchNarrativeIntoFields(in_geocoded_features, match_narrative_field)

Name	Explanation	Data type
in_geocoded_features	The point features that are the output of geocoding a table with the Geocode Addresses tool or Batch Geocode tool.	Feature Layer
match_narrative_field	The field from the `in_geocoded_features` parameter value that contains the unparsed match narrative text.	Field

Derived output

Name	Explanation	Data type
out_geocoded_features	The updated input geocoded feature class with the parsed match narrative text and match narrative fields joined to it.	Feature Layer

Code sample

SplitMatchNarrativeIntoFields example 1 (stand-alone script)

This script demonstrates how to parse the complete match narrative text in the MatchNarrative`` field of a geocoded feature class, split that text into fields, and append them using the SplitMatchNarrativeIntoFields` function.

# Import system modules
import arcpy

# Set variables
in_geocoded_features = r"C:\Data\MyDatabase.gdb\Customers_withMN"
match_narrative_field = "MatchNarrative"

# Run SplitMatchNarrativeIntoFields
arcpy.geocoding.SplitMatchNarrativeIntoFields(in_geocoded_features, match_narrative_field)

Environments

Current Workspace

Licensing information

Basic: Yes
Standard: Yes
Advanced: Yes

Split Match Narrative Into Fields (Geocoding Tools)

Summary

Usage

Parameters

Derived output

Environments

Licensing information

Related topics