Summary
Packages one or more layers and all referenced data sources to create a single compressed .lpk file.
Usage
A warning is issued when this tool encounters an unsupported layer type. The unsupported layer will not be written to the output.
All input layers must have a description in order for the tool to execute. To add a description, right-click the layer, click Properties, and enter a description.
Layer packages are backwards compatible with ArcGIS 10 and ArcGIS 9.3.1. To create a layer package that is compatible with previous versions, use the Package version parameter. It is important to note that due to updates and enhanced functionality for some geodatabase elements, not all layer packages will be backwards compatible.
When Convert data to file geodatabase is checked (convert_data='CONVERT' in Python), the following occurs:
- Each unique data source will have a file geodatabase created in the consolidated folder or package.
- Compressed raster and vector formats will be converted to a file geodatabase, and compression will be lost.
- Enterprise geodatabase data will not be consolidated. To have enterprise geodatabase data converted to a file geodatabase, check Include Enterprise geodatabase data instead of referencing the data.
When Convert data to file geodatabase is not checked (convert_data='PRESERVE' in Python), the following occurs:
- The data source format of the input layers will be preserved. The exceptions are formats such as personal geodatabase data (.mdb), VPF data, and tables based on Excel spreadsheets or OLEDB connections. These formats are not supported in 64x environments and therefore will always be converted to a file geodatabase.
- ADRG, CADRG/ECRG, CIB, and RPF raster formats will always convert to file geodatabase rasters. ArcGIS cannot natively write out these formats. They will always be converted to file geodatabase rasters for efficiency.
- In the output folder structure, file geodatabases will be consolidated into a version-specific folder, and all other formats will be consolidated into the commonData folder.
- Compressed raster and vector formats will not be clipped, even if an extent is specified in the Extent parameter.
For layers that contain a join or participate in a relationship class, all joined or related data sources will be consolidated into the output folder.
For feature layers, the Extent parameter is used to select the features that will be consolidated. For raster layers, the Extent parameter is used to clip the raster datasets.
Some datasets reference other datasets. For example, you may have a topology dataset that references four feature classes. Other examples of datasets that reference other datasets include Geometric Networks, Networks, and Locators. When consolidating or packaging a layer based on these types of datasets, the participating datasets will also be consolidated or packaged.
The Schema only parameter, if checked, (schema_only='SCHEMA_ONLY' in Python) will only consolidate or package the schema of the input data sources. A schema is the structure or design of a feature class or table that consists of field and table definitions, coordinate system properties, symbology, definition queries, and so on. Data or records will not be consolidated or packaged.
Data sources that do not support schema only will not be consolidated or packaged. If the Schema only parameter is checked and the tool encounters a layer that is not supported for schema only, a warning message is displayed, and that layer will be skipped. If the only layer specified is unsupported for schema only, the tool will fail.
Consolidating or packaging Coverage or VPF layers will copy the entire Coverage or VPF dataset into the consolidated folder or package.
To unpack a layer package, either drag the .lpk file into ArcMap or right-click the .lpk file and select Unpack. Alternatively, you can use the Extract Package tool and specify an output folder.
By default, Unpack will always extract the package into your user profile under:
- XP—C:\Documents and Settings\<username>\My Documents\ArcGIS\Packages
- Vista and Windows 7—C:\Users\<username>\Documents\ArcGIS\Packages
To change the default location of where your packages will be unpacked, open ArcMap Options from the Customize menu. From the Sharing tab find the Packaging section and check Use user specified location and browse to the new folder location.
Syntax
PackageLayer_management (in_layer, output_file, {convert_data}, {convert_arcsde_data}, {extent}, {apply_extent_to_arcsde}, {schema_only}, {version}, {additional_files}, {summary}, {tags})| Parameter | Explanation | Data Type |
in_layer [in_layer,...] | The layers to package. | Layer |
output_file | The location and name of the output package file (.lpk) to create. | File |
convert_data (Optional) | Specifies whether input layers will be converted into a file geodatabase or preserve their original format.
| Boolean |
convert_arcsde_data (Optional) | Specifies whether input enterprise geodatabase layers will be converted into a file geodatabase or preserve their original format.
| Boolean |
extent (Optional) | Specify the extent by manually entering the coordinates in the extent parameter using the format X-Min Y-Min X-Max Y-Max. To use the extent of a specific layer, specify the layer name.
| Extent |
apply_extent_to_arcsde (Optional) | Determines whether specified extent will be applied to all layers or only to enterprise geodatabase layers.
| Boolean |
schema_only (Optional) | Specifies whether only the schema of the input layers will be consolidated or packaged.
| Boolean |
version [version,...] (Optional) | Specifies the version of the geodatabases that will be created in the resulting package. Specifying a version allows packages to be shared with previous versions of ArcGIS and supports backward compatibility.
| String |
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
PackageLayer example 1 (Python window)
The following Python script demonstrates how to use the PackageLayer tool from within the Python window.
import arcpy
arcpy.env.workspace = "C:/arcgis/ArcTutor/BuildingaGeodatabase/Layers"
arcpy.PackageLayer_management('Parcels.lyr', 'Parcel.lpk', "PRESERVE", "CONVERT_ARCSDE", "#", "ALL", "AlL", "CURRENT", "C:/readme.docx","Summary of package","parcel,montgomery")
PackageLayer example 2 (stand-alone Python script)
Finds and creates individual layer packages for all of the layer files that reside in a specified folder.
# Name: PackageLayerEx1.py
# Description: Find all the layer files that reside in a specified folder and create a layer package for each layer file.
# import system modules
import os
import arcpy
# Set environment settings
arcpy.env.overwriteOutput = True
arcpy.env.workspace = "C:/arcgis/ArcTutor/BuildingaGeodatabase/Layers"
# Loop through the workspace, find all the layer files (.lyr) and create a layer package using the same name as the original layer file.
for lyr in arcpy.ListFiles("*.lyr"):
print ("Packaging {0}".format(lyr))
arcpy.PackageLayer_management(lyr, os.path.splitext(lyr)[0] + '.lpk', "PRESERVE", "CONVERT_ARCSDE", "#", "ALL", "ALL", "CURRENT", "#","Summary of package","tag1, tag2")
PackageLayer example 3 (stand-alone Python script)
Finds and creates a single layer package for all of the layer files that reside in a specified folder.
# Name: PackageLayerEx2.py
# Description: Find all the layer files that reside in a specified folder and create a single layer package that will contain all layers found.
# import system modules
import os
import arcpy
# Set environment settings
arcpy.env.overwriteOutput = True
arcpy.env.workspace = "C:/arcgis/ArcTutor/BuildingaGeodatabase/Layers"
# Find all the layer files (.lyr) in a workspace and create a single layer package.
lyrs = arcpy.ListFiles("*.lyr")
arcpy.PackageLayer_management(lyrs, 'all_layers.lpk', "PRESERVE", "CONVERT_ARCSDE", "#", "ALL", "ALL", "CURRENT", "#","Summary of package","tag1,tag2")
Environments
Licensing information
- ArcGIS Desktop Basic: Yes
- ArcGIS Desktop Standard: Yes
- ArcGIS Desktop Advanced: Yes