Package Locator

Summary

Package a locator or composite locator to create a single compressed .gcpk file.

Legacy:

Locators should be stored in a file folder so you take advantage of new features that are not supported for locators stored in geodatabases, such as performance improvements, multithreading capabilities, and suggestions support. ArcGIS 10.4 is the last release to support storing locators in geodatabases.

Learn more about sharing your locator as a locator package

Illustration

The folder structures of an unpacked locator package that contains a locator, and an unpacked composite locator package that contains the composite locator and its participating locators.

Usage

• The input locator must have a description in order for the tool to execute. To add summary and tags, click the Description tab of a locator in ArcCatalog, and click the Edit button to enter the information on the Item Description window.

• A warning is issued when this tool encounters an invalid locator. The invalid locator will not be packaged.

• By default, starting at ArcGIS 10.5, 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 unchecked and the following will occur:

  • Participating locators that are stored in an enterprise geodatabase, cannot be accessed and will not be copied to the consolidated folder and will therefore not be included.

• The locator package file (.gcpk) can be shared with other users or can be loaded to your ArcGIS online account.

  Learn more about sharing a package

• To unpack a locator package, drag the .gcpk file into ArcMap or right-click on the .gcpk file and click Unpack.

  Unpack will extract a package into your user profile under:

  • XP—C:\Documents and Settings\username\My Documents\ArcGIS\Packages
  • Vista and Windows 7—C:\Users\username\My Documents\ArcGIS\Packages

  Alternatively, you can use the Extract Package tool and specify an output folder.

  Learn more about unpacking a locator package

Syntax

arcpy.management.PackageLocator(in_locator, output_file, {copy_arcsde_locator}, {additional_files}, {summary}, {tags})

Parameter	Explanation	Data Type
in_locator	The locator or composite locator that will be packaged.	Address Locator
output_file	The name and location of the output locator package (.gcpk).	File
copy_arcsde_locator (Optional)	Legacy: Prior to version 10.4, this parameter allowed you to specify whether participating locators (for composite locators only) in an enterprise geodatabase will be copied to the consolidated folder or package. As of version 10.4 by default, all participating locators, including locators in an enterprise geodatabase, will be copied to the consolidated folder or package. As this is an optional parameter, it can simply not be specified. As of version 10.5, locators in an enterprise geodatabase, cannot be accessed and will not be copied to the consolidated folder or package. Packaging composite locators that reference locators stored in enterprise geodatabases or file geodatabases will fail. COPY_ARCSDE —All participating locators, including locators in an enterprise geodatabase, will be copied to the consolidated folder or package. This is the default. PRESERVE_ARCSDE — Connection information of the participating locators that are stored in an enterprise geodatabase will be preserved in the composite locator. Legacy: This value will default to COPY_ARCSDE as of version 10.4. However, packaging will fail if composite locator contains any locators stored in file geodatabases or in enterprise geodatabases.	Boolean
additional_files [additional_files,...] (Optional)	Adds additional files to a package. Additional files, such as .doc, .txt, .pdf, and so on, are used to provide more information about the contents and purpose of the package.	File
summary (Optional)	Adds summary information to the properties of the package.	String
tags (Optional)	Adds tag information to the properties of the package. Multiple tags can be added or separated by a comma or semicolon.	String

Code sample

PackageLocator example 1 (Python window)

The following Python script demonstrates how to use the PackageLocator tool from within the Python window.

import arcpy
arcpy.env.workspace = 'C:/MyData/Locators'
arcpy.PackageLocator_geocoding('Atlanta_composite', 'Altanta_composite.gcpk', 'COPY_ARCSDE', '#', 'Summary of package', 'tag1; tag2; tag3')

PackageLocator example 2 (stand-alone script)

Finds and creates individual locator packages for all of the locators that reside in a specified folder.

# Name: PackageLocatorEx.py
# Description:  Find all the locators that reside in a specified folder and create a locator package 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 locators and create a locator package using the same name as the locator.
for loc in arcpy.ListFiles('*.loc'):
    print('Packaging ' + loc)
    arcpy.PackageLocator_geocoding(loc, os.path.splitext(loc)[0] + '.gcpk', 'COPY_ARCSDE', '#', 'Summary of package', 'tag1; tag2; tag3')

Environments

• Current Workspace

Licensing information

• Basic: Yes
• Standard: Yes
• Advanced: Yes