| Label | Explanation | Data Type |
Input Layer | The layers that will be packaged. | Layer; Table View |
Output File | The location and name of the output package file (.lpkx) that will be created. | File |
Convert data to file geodatabase (Optional) | Specifies whether input layers will be converted to a file geodatabase or preserved in their original format.
| Boolean |
Include Enterprise Geodatabase data instead of referencing the data (Optional) | Specifies whether input enterprise geodatabase layers will be converted to a file geodatabase or preserved in their original format.
| Boolean |
Extent
(Optional) | Specifies the extent that will be used to select or clip features.
| Extent |
Apply Extent only to enterprise geodatabase layers (Optional) | Specifies whether the specified extent will be applied to all layers or to enterprise geodatabase layers only.
| Boolean |
Schema only (Optional) | Specifies whether only the schema of the input layers will be consolidated or packaged.
| Boolean |
Package 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 earlier versions of ArcGIS and supports backward compatibility. Note:A package saved to an earlier version may lose properties that are only available in the later version.
| String |
Additional Files (Optional) | Adds 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 |
Keep only the rows which are related to features within the extent
(Optional) | Specifies whether the specified extent will be applied to related data sources.
| Boolean |
Preserve Mobile Geodatabase
(Optional) | Specifies whether input mobile geodatabase data will be preserved in the output or written to file geodatabase format. If the input data is a mobile geodatabase network dataset, the output will be a mobile geodatabase. This parameter overrides the Convert data to file geodatabase parameter when the input data is a mobile geodatabase.
| Boolean |
Exclude Network Dataset
(Optional) | For network analysis layers, specifies whether the network dataset will also be packaged.
| Boolean |
Summary
Packages one or more layers and all referenced data sources to create a single compressed .lpkx 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 include a description for the tool to run. To add a description, right-click the layer, click Properties, and provide a description.
When the Convert data to file geodatabase parameter is checked, 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 convert enterprise geodatabase data to a file geodatabase, check the Include Enterprise Geodatabase data instead of referencing the data parameter.
When the Convert data to file geodatabase parameter is not checked, the following occurs:
- The data source format of the input layers will be preserved when possible.
- ADRG, CADRG/ECRG, CIB, and RPF raster formats will convert to file geodatabase rasters. ArcGIS cannot natively write out these formats. They will be converted to file geodatabase rasters for efficiency.
- In the output folder structure, file geodatabases will be consolidated in a version-specific folder, and all other formats will be consolidated in 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. By default, joined or related data sources will be consolidated in their entirety or, depending on the Select Related Rows parameter value, based on the extent specified using the Extent parameter.
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.
If the Schema only parameter is checked, the tool 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 appears and that layer will be skipped. If the only layer specified is unsupported for schema only, the tool will fail.
To unpack a layer package (.lpkx file), browse to the folder containing it in the Catalog window, right-click the package, and click Add to Current Map. Alternatively, you can use the Extract Package tool and specify an output folder.
By default, Add to Current Map extracts the package into your user profile under C:\Users\<username>\Documents\ArcGIS\Packages. To change the extraction location, update the path under Other Packages and Files on the Share and Download Options dialog box.
Note:
Layer packages created in ArcGIS Pro are not backward compatible with ArcGIS 10 and ArcGIS 9.3.1. Packages created in ArcGIS Pro can only be used in ArcGIS Pro.
Parameters
arcpy.management.PackageLayer(in_layer, output_file, {convert_data}, {convert_arcsde_data}, {extent}, {apply_extent_to_arcsde}, {schema_only}, {version}, {additional_files}, {summary}, {tags}, {select_related_rows}, {preserve_sqlite}, {exclude_network_dataset})| Name | Explanation | Data Type |
in_layer [in_layer,...] | The layers that will be packaged. | Layer; Table View |
output_file | The location and name of the output package file (.lpkx) that will be created. | File |
convert_data (Optional) | Specifies whether input layers will be converted to a file geodatabase or preserved in their original format.
| Boolean |
convert_arcsde_data (Optional) | Specifies whether input enterprise geodatabase layers will be converted to a file geodatabase or preserved in their original format.
| Boolean |
extent (Optional) | Specifies the extent that will be used to select or clip features.
| Extent |
apply_extent_to_arcsde (Optional) | Specifies whether the specified extent will be applied to all layers or to enterprise geodatabase layers only.
| 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 earlier versions of ArcGIS and supports backward compatibility. Note:A package saved to an earlier version may lose properties that are only available in the later version.
| String |
additional_files [additional_files,...] (Optional) | Adds 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 |
select_related_rows (Optional) | Specifies whether the specified extent will be applied to related data sources.
| Boolean |
preserve_sqlite (Optional) | Specifies whether mobile geodatabase data will be preserved in the output or written to file geodatabase format. If the input data is a mobile geodatabase network dataset, the output will be a mobile geodatabase. This parameter overrides the convert_data parameter when the input data is a mobile geodatabase.
| Boolean |
exclude_network_dataset (Optional) | For network analysis layers, specifies whether the network dataset will also be packaged.
| Boolean |
Code sample
The following Python script demonstrates how to use the PackageLayer function in the Python window.
# In this code, it is assumed that the current project has a map open with a layer named "Streets".
import arcpy
outputFile = "c:/packages/streetsLayer.lpkx"
arcpy.management.PackageLayer("Streets", outputFile, "PRESERVE",
"CONVERT_ARCSDE", "#", "ALL", "ALL", "CURRENT",
"C:/readme.docx", "Summary of package",
"parcel,montgomery")Package all feature layers in the first map of a given project to their own individual layer package files.
# Import system modules
import os
import arcpy
prj = arcpy.mp.ArcGISProject(r"\\fileServe\projects\Timbuktu\Timbuktu.aprx")
maps = prj.listMaps()[0]
lyrs = maps.listLayers()
for lyr in lyrs:
if lyr.isFeatureLayer:
arcpy.management.PackageLayer(lyr, os.path.join("c:/temp", lyr.name + ".lpkx"))Environments
Special cases
- Parallel Processing Factor
If the environment is not specified, the tool will use one half of the available cores.
Licensing information
- Basic: Yes
- Standard: Yes
- Advanced: Yes