Locator role fields

Each locator role has fields that are used to store the information that is necessary for searching and displaying geocoding results. Below is a table of these fields with additional information about what they are used for, such as whether the field is used during the search process, for display purposes only, for displaying results on the map, or for prioritizing similar matches.

Tip:

For the reference data fields to be automatically assigned to the locator role fields in the Create Locator tool, the field alias names in the reference data must match the field names that are displayed in the Field Mapping parameter of the Create Locator tool.

Locator role field usage

Field name	Used for search	Description
Feature ID		ID field used to collapse duplicate features in the reference data for each primary locator role.
Place Join ID		JoinID used to link alternate place-names and alternate categories for a point of interest (POI) locator.
Place Name		The formal name of a geocode match candidate, such as Paris or Starbucks.
Place Category		The high-level category associated with a place, such as Food or Education. Note: Geocoding results can be filtered by these values.
Place Subcategory		The lower-level category associated with a place, such as American food for the Food category or College for the Education category. Note: Geocoding results can be filtered by these values.
Address Join ID		JoinID to link alternate house numbers.
House Number		The house number associated with an address. Either House Number, House Number From, and House Number To or Building Name is required for the Point Address role.
House Number From		A value representing the beginning number of a range. It is not always the smallest number in the range. Either House Number, House Number From and House Number To, or Building Name is required for the Point Address role. Left House Number From and Right House Number From are required for the Street Address role.
House Number To		A value representing the ending number of a range. It is not always the largest number in the range. Either House Number, House Number From and House Number To, or Building Name is required. Left House Number To and Right House Number To are required for the Street Address role.
Parity		The parity of the house number range. The supported values are Not applicable, NA, N/A, 0, D, Default, Z; Even, E, 1; Odd, O, 2; Mixed, M, Both, B, and 3. Note: When Even is specified, only even numbered house numbers will match to the record. When Odd is specified, only odd numbered house numbers will match to the record. If Mixed or Both are specified, all house numbers in the range will match for the record.
Distance		This is the input field used with the Distance Marker role to specify distance values for each distance marker. This is not the same as the distance output field, which indicates how far the result is from the location that is passed in when geocoding.
Distance From		A value representing the beginning number of a distance range. It is not always the smallest number in the range. This value is at the starting point of the digitized line.
Distance To		A value representing the ending number of a distance range. It is not always the largest number in the range. This value is at the end point of the digitized line.
Distance Unit		The distance unit associated with the distance value. The supported values are KM, Kilometers, MI, Miles, M, and Meters.
Building Name		The building name associated with an address. Either House Number, House Number From and House Number To, or Building Name is required.
Parcel Join ID		JoinID used to link Parcel records to PointAddress records to minimize duplicate geocoding results. It is also used to return Parcel candidate by address search and to show the linked Parcel name in the PointAddress candidate details
Parcel Name		The value that represents the Parcel Identification Number (PIN), for example 17 011100120063.
Street Join ID		JoinID to link alternate street names for the following roles: Street Address, Distance Marker, Distance Range, PointAddress, Parcel, and POI. The field is also used to link dependent street names, and alternate house ranges in the Street Address role.
Prefix Direction		The prefix direction of the address, such as East, West, North, or South.
Prefix Type		The leading type of a street in an address, for example, the Spanish term Avenida in Avenida Central.
Street Name		The street name of the address.
Suffix Type		The trailing type of a street in an address, such as St, Blvd, or Ave.
Suffix Direction		The suffix direction of the address, such as East, West, North, or South.
Full Street Name		The full street name of the address. This value is used for display purposes and is part of the output label unless it is not used. In the case where it is not used, the street components are concatenated together with spaces for the output label. Note: Applies to countries where street types are concatenated, such as Germany.
Primary Street Name Indicator		If the reference data is normalized and the primary table contains street name values, the Primary Street Name Indicator field can be mapped to a field in the primary table that contains a value indicating whether the record is the primary name. The Street Name role field must be mapped because it and the Primary Street Name indicator value are used to define the Preferred Street Name that is returned when geocoding. The supported values are true, Y, Yes, 1, false, N, No, or 0.
Unit		The unit value of the address, such as 201 in an address that contains Unit 201.
Unit From		The unit starting value for the range associated with an address.
Unit To		The unit ending value for the range associated with an address.
Unit Type		The unit type of the address, such as Apartment or Suite.
Level		The level of the address, such as Mezzanine or 2 in Floor 2.
Level Type		The level type of the address, such as Floor in Floor 2.
Building Unit		The building unit of the address, such as M in building M.
Building Unit Type		The building unit type of the address, such as building in building M.
Side		The side of the street that the address is on, such as left (L) or right (R) in the United States. The supported values are 1, Right, R, 2, Left, L, 3, Both, B, 0, No, Not Applicable, NA, N/A
Block Join ID		JoinID to link alternate block names.
Block		The name of the block-level administrative division for a candidate. A block is the smallest administrative area for a country. It can be described as a subdivision of a sector or neighborhood or as a named city block. This is not commonly used.
Sector Join ID		JoinID to link to alternate sector names.
Sector		The name of the sector-level administrative division for a candidate. A sector is a subdivision of a neighborhood or district or represents a collection of blocks. This is not commonly used.
Neighborhood Join ID		JoinID to link alternate neighborhood names.
Neighborhood		The name of the neighborhood-level administrative division for a candidate. A neighborhood is a subsection of a city or district.
District Join ID		JoinID to link alternate district names.
District		The name of the district-level administrative division for a candidate. A subdivision of a city.
City Join ID		JoinID to link alternate city names.
City		The name of the city-level administrative division for a candidate. A city is a subdivision of a subregion or region.
Metro Area Join ID		JoinID to link alternate metro names.
Metro Area		The name of the metropolitan area-level administrative division for a candidate. An urban area consisting of a large city and the smaller cities surrounding it. It can potentially intersect multiple subregions or regions. An example is Kolkata Metropolitan Area in India.
Subregion Join ID		JoinID to link alternate subregion names.
Subregion		The name of the subregion-level administrative division for a candidate. A subregion is a subdivision of a region.
Region Join ID		JoinID to link alternate region names.
Region		The name of the region-level administrative division for a candidate. This is a subdivision of a country or territory. Typically, the largest administrative area for a country if the Territory administrative division is not used. These values are used to apply regional geocoding logic, for example, to help create different forms of state highways that are specific to each region or state. For example, CA-38 is equal to STHY 38 in the state of California. The region abbreviation in this example is CA.
Region Abbreviation		An abbreviated region name, such as CA for California.
Territory Join ID		JoinID to link alternate territory names.
Territory		The name of the territory-level administrative division for a candidate. This is a subdivision of a country and it is not commonly used. The Sudeste macroregion of Brazil—which encompasses the states of Espírito Santo, Minas Gerais, Rio de Janeiro, and São Paulo—is an example.
Zone Join ID		JoinID to link alternate zone names.
Zone		Any administrative area that doesn't fit into the above administrative hierarchy.
Postal Join ID		JoinID to link alternate postal values as well as alternate values from the AlternatePostalCityName table.
Postal		An alphanumeric address element defining the primary postal code, for example, V7M 2B4 for a Canadian postal code and 92374 for a USA postal code.
Postal Extension Join ID		JoinID used for deduplicating geometry.
Postal Extension		An alphanumeric address element defining the postal code extension, for example, 8110 in the United States postal code 92373-8110.
Country Join ID		JoinID to link alternate country names.
Country		The name of the highest administrative division for a candidate. This is the country name.
Country Code		A three-character code for a country, such as CAN for Canada. A list of supported countries and codes is available in the Supported Country Codes column referenced in the Geocode coverage map.
Language Code		A three-character language code representing the language of the address, such as ENG for English. A list of supported three-character language codes is available in the Supported Language Codes column referenced in the Geocode coverage map.
Rank		A floating-point number value indicating the importance of a result relative to other results with the same name. For example, there are cities in France and Texas named Paris. Paris, France, has a greater population than Paris, Texas, so it has a higher rank. The smaller numbers represent higher-ranked features. Rank is used to sort results for ambiguous queries such as Lincoln, where no additional information (state) is available. Rank values are based on population or feature type.
Display X		For PointAddress, Parcel, and POI locators, this value represents the actual location of the address (that is, the building or parcel centroid). It differs from the x-value, which is derived from a location along the street or the street entry for an address. For all other locators, this value is equal to the x-value. Values should be in the same coordinate system as the primary reference data’s geometry. Including this field when building the locator allows you to specify the preferred location for where the result is displayed on the map.
Display Y		For PointAddress, Parcel, and POI locators, this value represents the actual location of the address (that is, the building or parcel centroid). It differs from the y-value, which is derived from a location along the street or the street entry for an address. For all other locators, this value is equal to the y-value. Values should be in the same coordinate system as the primary reference data’s geometry. Including this field when building the locator allows you to specify the preferred location for where the result is displayed on the map.
Min X		The Min X, Max X, Min Y, and Max Y values can be combined to set the map extent for zooming to a geocode result. Values should be in the same coordinate system as the primary reference data’s geometry.
Max X		The Min X, Max X, Min Y, and Max Y values can be combined to set the map extent for zooming to a geocode result. Values should be in the same coordinate system as the primary reference data’s geometry.
Min Y		The Min X, Max X, Min Y, and Max Y values can be combined to set the map extent for zooming to a geocode result. Values should be in the same coordinate system as the primary reference data’s geometry.
Max Y		The Min X, Max X, Min Y, and Max Y values can be combined to set the map extent for zooming to a geocode result. Values should be in the same coordinate system as the primary reference data’s geometry.
Phone		The primary phone number of a place. For other searches, such as address, intersection, and postal code, the field is empty. For example, for Knott's Berry Farm, Phone is [phone].
URL		The URL of the primary website for a place. For other searches, such as address, intersection, and postal code, the field is empty. For example, for the University of Georgia, URL is http://www.uga.edu/.
Primary Name Indicator		If the reference data is normalized and the primary table does not contain name values, but the alternate name table does, the Primary Name Indicator field can be mapped to a field in the alternate name table that contains a value indicating whether the record is the primary name. The Street Name role field must be mapped because it and the Primary Name indicator value are used to define the Preferred Street Name that is returned when geocoding. The supported values are true, Y, Yes, 1, false, N, No, or 0.