Consolidate Map (Data Management)

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 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 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, 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.

Syntax

arcpy.management.ConsolidateMap(in_map, output_folder, {convert_data}, {convert_arcsde_data}, {extent}, {apply_extent_to_arcsde}, {preserve_sqlite}, {select_related_rows})

Parameter	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. CONVERT — Data will be converted to a file geodatabase. This option does not apply to enterprise geodatabase data sources. To convert enterprise geodatabase data, set convert_arcsde_data = 'CONVERT_ARCSDE'. PRESERVE —Data formats will be preserved when possible. This is the default.	Boolean
convert_arcsde_data (Optional)	Specifies whether input enterprise geodatabase layers will be converted to a file geodatabase or preserved in their original format. CONVERT_ARCSDE — Enterprise geodatabase data will be converted to a file geodatabase and will be included in the consolidated folder or package. This is the default. PRESERVE_ARCSDE — Enterprise geodatabase data will be preserved and will be referenced in the consolidated folder or package.	Boolean
extent (Optional)	Specifies the extent that will be used to select or clip features. MAXOF—The maximum extent of all inputs will be used. MINOF—The minimum area common to all inputs will be used. DISPLAY—The extent is equal to the visible display. Layer name—The extent of the specified layer will be used. Extent object—The extent of the specified object will be used. Space delimited string of coordinates—The extent of the specified string will be used. Coordinates are expressed in the order of x-min, y-min, x-max, y-max.	Extent
apply_extent_to_arcsde (Optional)	Specifies whether the specified extent will be applied to all layers or only to enterprise geodatabase layers. ALL — The specified extent will be applied to all layers. This is the default. ARCSDE_ONLY —The specified extent will be applied to enterprise geodatabase layers only.	Boolean
preserve_sqlite (Optional)	Instead of converting to a file geodatabase format, input SQLite data can be preserved as SQLite output. This parameter overrides the convert_data parameter when the input data is SQLite. If the input data is a SQLite network dataset, the output will always be SQLite. PRESERVE_SQLITE —Preserve data as SQLite. CONVERT_SQLITE —Convert data from SQLite to file geodatabase. This is the default.	Boolean
select_related_rows (Optional)	Specifies whether the specified extent will be applied to related data sources. KEEP_ONLY_RELATED_ROWS —Only related data corresponding to records within the specified extent will be consolidated. KEEP_ALL_RELATED_ROWS —Related data sources will be consolidated in their entirety. This is the default.	Boolean

Code sample

ConsolidateMap example 1 (Python window)

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

Current Workspace, Extent

Licensing information

• Basic: Yes
• Standard: Yes
• Advanced: Yes