Summary
Consolidate a locator or composite locator by copying all locators into a single folder.
Illustration
Usage
This tool is located in the Geocoding toolbox. For convenience, a copy of this tool also resides in the Data Management toolbox Package toolset.
A warning is issued when this tool encounters an invalid locator. The invalid locator will not be packaged.
Beginning with version 10.4, by default, if the locator to be consolidated or packaged is a composite locator, the Composite locator only: copy participating locators in Enterprise Geodatabase instead of referencing them option is checked and the following will occur:
- The composite locator and all its participating locators, including locators in an enterprise geodatabase, will be copied to the consolidated folder.
- Each locator will be copied to a unique folder created in the consolidated folder.
Syntax
ConsolidateLocator_management (in_locator, output_folder, {copy_arcsde_locator})
Parameter | Explanation | Data Type |
in_locator | The input locator or composite locator that will be consolidated. | Locator |
output_folder | The output folder that will contain the locator or composite locator with its participating locators. | Folder |
copy_arcsde_locator (Optional) |
| Boolean |
Code sample
ConsolidateLocator example 1 (Python window)
The following Python script demonstrates how to use the ConsolidateLocator tool from the Python window:
import arcpy
arcpy.env.workspace = "C:/MyData/Locators"
arcpy.ConsolidateLocator_Geocoding('Atlanta_composite', 'Consolidate_folder')
ConsolidateLocator example 2 (stand-alone script)
Finds and creates individual consolidated folders for all the locators that reside in a specified folder.
# Name: ConsolidateLocator.py
# Description: Find all the locators that reside in a specified folder and create a consolidated folder for each locator.
# import system modules
import os
import arcpy
# Set environment settings
arcpy.env.overwriteOutput = True
arcpy.env.workspace = "C:/MyData/Locators"
# Loop through the workspace, find all the loc and create a consolidated folder using the same
# name as the original locator
for loc in arcpy.ListFiles("*.loc"):
print("Consolidating " + loc)
arcpy.ConsolidateLocator_geocoding(loc, os.path.splitext(loc)[0])
Environments
Licensing information
- ArcGIS Desktop Basic: Yes
- ArcGIS Desktop Standard: Yes
- ArcGIS Desktop Advanced: Yes