Create Address Locator

Title  Create Address Locator

Summary

Geoprocessing tool to create an address locator


Usage


Syntax

Parameter Explanation
in_address_locator_style

The address locator style on which to base the new address locator.

  • US Address-Dual Ranges—Use when the reference data is a line feature class that contains house number ranges on both sides of a street segment, and you want to search for an address on a specific side of the street or a street intersection.
  • US Address-One Range—Use when the reference data is a line feature class with one house number range for each road segment, and you want to search for an address (where side is not needed) or a street intersection.
  • US Address-Single House—Use when the reference data is a point or polygon feature class where each feature represents a single address, and you want to search for an exact address for a parcel, building, or address point.
  • US Address-Single House Subaddress—Use when the reference data is a point or polygon feature class where each feature represents a single address with optional subaddress elements, and you want to search for apartment units, townhouses, duplexes, or stores in a shopping plaza.
  • US Address-Street Name—Use when the reference data is a line feature class, and you want to search for addresses using only the street name. Address range information is not required.
  • US Address-City State—Use when the reference data is a point or polygon feature class, and you want to search for a specific city in a state.
  • US Address-ZIP 5 Digit—Use when the reference data is a point or polygon feature class where each feature represents a ZIP Code centroid or geographic area, and you want to search for a specific ZIP Code location.
  • General-Gazetteer—Use when the reference data is a point or polygon feature class where each feature represents any unique feature, and you want to search for a place-name, landmark, water meter, or any unique value.
in_field_map

The mapping of reference data fields used by the address locator style to fields in the reference datasets. Fields with an asterisk (*) next to their names are required by the address locator style.

To determine the alias name for a reference data field used by a locator style, open the Create Address Locator tool dialog box and choose the locator style. The name that appears in the Field Name column of the Field Map control is the field's alias name.

config_keyword (Optional)

The configuration keyword that determines the storage parameters of the table in a Relational Database Management System (RDBMS)—enterprise and file geodatabases only.

enable_suggestions (Optional)

Allows character-by-character auto-complete suggestions to be generated for user input in a client application. This capability facilitates the interactive search user experience by reducing the number of characters that need to be typed before a suggested match is obtained. The idea is that a client application can provide a list of suggestions which is updated with each character entered by a user until the place they are looking for is returned in the list.

Only the locator styles provided by Esri can be used to build locators with suggestions enabled. The suggestion functionality is only exposed when such a locator is published as a geocode service. Locators with suggestions enabled can only be saved in a file folder; they cannot be saved in a geodatabase.

  • Checked—Suggestions are enabled for the locator.
  • Unchecked—Suggestions are disabled for the locator. This is the default.

Code Samples

CreateAddressLocator example (stand-alone script)

The following Python script demonstrates how to use the CreateAddressLocator function.


# Create a street address locator using a street centerline feature class 
# in a file geodatabase as reference data.
# The new address locator will be created in a separate file folder.

# Import system modules
import arcpy

arcpy.env.workspace = "C:/ArcTutor/Geocoding/atlanta.gdb"
Atlanta_AddressLocator_OutputPath = "C:/ArcTutor/Geocoding/Atlanta"

arcpy.CreateAddressLocator_geocoding("US Address - Dual Ranges", "streets 'Primary Table'", "'Feature ID' OBJECTID VISIBLE NONE;'*From Left' L_F_ADD VISIBLE NONE;'*To Left' L_T_ADD VISIBLE NONE;'*From Right' R_F_ADD VISIBLE NONE;'*To Right' R_T_ADD VISIBLE NONE;'Prefix Direction' PREFIX VISIBLE NONE;'Prefix Type' PRE_TYPE VISIBLE NONE;'*Street Name' NAME VISIBLE NONE;'Suffix Type' TYPE VISIBLE NONE;'Suffix Direction' SUFFIX VISIBLE NONE;'Left City or Place' CITYL VISIBLE NONE;'Right City or Place' CITYR VISIBLE NONE;'Left ZIP Code' ZIPL VISIBLE NONE;'Right ZIP Code' ZIPR VISIBLE NONE;'Left State' STATE_ABBR VISIBLE NONE;'Right State' STATE_ABBR VISIBLE NONE", Atlanta_AddressLocator_OutputPath, "", "DISABLED")
 

                    

Tags

Credits

Use limitations