Skip To Content

Package Locator

Summary

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

Learn more about sharing an address locator as a locator package

Illustration

locator package
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

  • If you want to create a package for a composite locator, make sure that the participating locators are stored in the file folder.

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

  • The locator package file (.gcpk) can be shared with other users.

    Learn more about sharing an address locator as a locator package.

  • You can use the Extract Package tool and specify an output folder to unpack a locator package.

  • Each locator will be copied to a unique folder created in the consolidated folder.

Syntax

PackageLocator_management (in_locator, output_file, {copy_arcsde_locator}, {additional_files}, {summary}, {tags})
ParameterExplanationData 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)

This parameter has no effect in ArcGIS Pro. It remains only to support backward compatibility.

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_management('Atlanta_composite', 'Altanta_composite.gcpk', "", "#","Summary of package","tag1; tag2; tag3")
PackageLocator example 2 (stand-alone Python 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_management(loc, os.path.splitext(loc)[0] + '.gcpk', "", "#","Summary of package","tag1; tag2; tag3")

Environments

Licensing information

  • ArcGIS Desktop Basic: Yes
  • ArcGIS Desktop Standard: Yes
  • ArcGIS Desktop Advanced: Yes

Related topics