| Label | Explanation | Data Type |
Input Map | The map to be packaged. When running this tool in ArcGIS AllSource, the input can be a map, scene, or basemap. | Map |
Output File | The output map package (.mpkx file). | 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 |
Support ArcGIS Maps SDKs (Optional) | Specifies whether the package will support ArcGIS Maps SDKs. To support ArcGIS Maps SDKs, 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 for Runtime (Optional) | Specifies whether a package that references the necessary data will be created rather than copying the data. This is helpful when trying to package large datasets that are available from a central location in an organization.
| 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) | The additional files that will be added 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) | The summary information that will be added to the properties of the package. | String |
Tags (Optional) | The tag information that will be added 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.
| Boolean |
Summary
Packages a map and all referenced data sources to create a single compressed .mpkx 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 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.
When Support ArcGIS Runtime is checked, 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 value, based on the extent specified for 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, only the schema of the input data sources will be consolidated or packaged. 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.
Parameters
—The extent will be based on the active map or scene. This option is only available when there is an active map.
—The extent will be based on an existing dataset.
—The extent will be based on the minimum or intersecting extent of all inputs. If no inputs overlap, a null extent with all zeros will result.
—The extent will be based on the maximum or combined extent of all inputs.
—The extent will be reset to the default value.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}, {select_related_rows}, {preserve_sqlite})| Name | Explanation | Data Type |
in_map [in_map,...] | The map to be packaged. When running this tool in ArcGIS AllSource, the input can be a map, scene, or basemap. | Map |
output_file | The output map package (.mpkx file). | 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 |
arcgisruntime (Optional) | Specifies whether the package will support ArcGIS Maps SDKs. To support ArcGIS Maps SDKs, 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) | Specifies whether a package that references the necessary data will be created rather than copying the data. This is helpful when trying to package large datasets that are available from a central location in 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 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) | The additional files that will be added 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) | The summary information that will be added to the properties of the package. | String |
tags (Optional) | The tag information that will be added 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.
| Boolean |
Code sample
The following Python script demonstrates how to use the PackageMap function from the Python window.
# This code assumes a map named "World1" exists in the current project
import arcpy
outputFile = "c:/outputPackages/world_map.mpkx"
arcpy.management.PackageMap("World1", outputFile, "PRESERVE", "CONVERT_ARCSDE", "#", "ALL")Environments
Special cases
- Parallel Processing Factor
If the environment is not specified, the tool will use one half of the available cores.