| Label | Explanation | Data Type |
Input Map | The map (.mapx) to be consolidated. When running this tool within the ArcGIS Pro application, the input can be a map, scene, or basemap. | Map |
Output Folder | The output folder that will contain the consolidated map and data. If the specified folder does not exist, a new folder will be created. | Folder |
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 |
Preserve Mobile Geodatabase
(Optional) | Specifies whether input mobile geodatabase data will be preserved as mobile geodatabase in the output. This parameter overrides the Convert data to file geodatabase parameter when the input data is mobile geodatabase. If the input data is a mobile geodatabase network dataset, the output will always be mobile geodatabase.
| Boolean |
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 |
Summary
Consolidates a map and all referenced data sources to a specified output folder.
Usage
A warning is issued when this tool encounters an unsupported layer type. The unsupported layer will not be written to the output.
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 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.
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.
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.
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.
Parameters
arcpy.management.ConsolidateMap(in_map, output_folder, {convert_data}, {convert_arcsde_data}, {extent}, {apply_extent_to_arcsde}, {preserve_sqlite}, {select_related_rows})| Name | Explanation | Data Type |
in_map [in_map,...] | The map (.mapx) to be consolidated. When running this tool within the ArcGIS Pro application, the input can be a map, scene, or basemap. | Map |
output_folder | The output folder that will contain the consolidated map and data. If the specified folder does not exist, a new folder will be created. | Folder |
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 |
preserve_sqlite (Optional) | Specifies whether input mobile geodatabase data will be preserved as mobile geodatabase in the output. This parameter overrides the convert_data parameter when the input data is mobile geodatabase. If the input data is a mobile geodatabase network dataset, the output will always be mobile geodatabase.
| Boolean |
select_related_rows (Optional) | Specifies whether the specified extent will be applied to related data sources.
| Boolean |
Code sample
The following Python script demonstrates how to use the ConsolidateMap tool from the Python window:
# This code assumes a map named "World1" exists in the current project
import arcpy
arcpy.ConsolidateMap_management('World1', 'c:/projects/World', 'PRESERVE', 'CONVERT_ARCSDE')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