Summary
Packages a map document and all referenced data sources to create a single compressed .mpk file.
Usage
A warning is issued when this tool encounters an unsupported layer type. The unsupported layer will not be written to the output.
The input layer must have a description for the tool to execute. To add a description, right-click the layer, click Properties, and enter a description.
To unpack a map package, drag the .mpk file into ArcMap or right-click the .mpk file and click Unpack. Alternatively, you can use the Extract Package tool and specify an output folder.
By default, packages will be extracted into your user profile.
- 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. On the Sharing tab, in the Packaging section, check Use user specified location and browse to the new folder location.
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 convert enterprise geodatabase data 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 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 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.
When Support ArcGIS Runtime is checked (arcgisruntime='RUNTIME' in Python), the Version parameter will be overridden and the package will contain geodatabases and a map compatible with current release version only.
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, 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.
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 appears and that layer will be skipped. If the only layer specified is unsupported for schema only, the tool will fail.
Syntax
arcpy.management.PackageMap(in_map, output_file, {convert_data}, {convert_arcsde_data}, {extent}, {apply_extent_to_arcsde}, {arcgisruntime}, {reference_all_data}, {version}, {additional_files}, {summary}, {tags})| Parameter | Explanation | Data Type |
in_map | The map document to be packaged. | ArcMap Document |
output_file | The output map package (.mpk). | 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 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) | Specifies whether the specified extent will be applied to all layers or only to enterprise geodatabase layers.
| Boolean |
arcgisruntime (Optional) | Specifies whether the package will support ArcGIS Runtime. To support ArcGIS Runtime, all data sources will be converted to a file geodatabase and an .msd file will be created in the output package.
| Boolean |
reference_all_data (Optional) | Setting this option to REFERENCED will create a package that references the data needed rather than copying the data. This is valuable when trying to package large datasets that are available from a central location within an organization.
| 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
PackageMap example 1 (Python window)
The following Python script demonstrates how to use the PackageMap tool from the Python window:
import arcpy
arcpy.env.workspace = "C:/arcgis/ArcTutor/Editing"
arcpy.PackageMap_management('Exercise1.mxd', 'EditingExercise1.mpk', "PRESERVE", "CONVERT_ARCSDE", "#", "ALL")
PackageMap example 2 (stand-alone script)
Find and create map packages for all map documents that reside in a specified folder.
# Name: PackageMap.py
# Description: Find all the map documents that reside in a specified folder and create map packages for each map document.
# import system modules
import os
import arcpy
# Set environment settings
arcpy.env.overwriteOutput = True
arcpy.env.workspace = "C:/arcgis/ArcTutor/Editing"
# Loop through the workspace, find all the mxds and create a map package using the same name as the mxd
for mxd in arcpy.ListFiles("*.mxd"):
print("Packaging: {0}".format(mxd))
arcpy.PackageMap_management(mxd, os.path.splitext(mxd)[0] + '.mpk', "PRESERVE", "CONVERT_ARCSDE", "#", "ALL")
Environments
Licensing information
- Basic: Yes
- Standard: Yes
- Advanced: Yes