ArcMap

Consolidate Map

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

  • 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})
ParameterExplanationData Type
in_map

The map document (.mxd) to be consolidated.

ArcMap Document
output_folder

The output folder that will contain the consolidated map and data.

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. The exceptions are formats that are not supported in a 64x environment (personal geodatabase .mdb data, VPF data, and tables based on Excel spreadsheets or OLEDB connections) and raster formats that ArcGIS cannot write out natively (ADRG, CADRG/ECRG, CIB, and RPF).
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 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.

  • MAXOF —The union of inputs will be used.
  • MINOF —The intersection of inputs will be used.
  • DISPLAY —The same extent as the current display will be used.
  • <Layer> —The same extent as the specified layer will be used.
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

Code sample

ConsolidateMap example 1 (Python window)

The following Python script demonstrates how to use the ConsolidateMap tool from the Python window:

import arcpy
arcpy.env.workspace = "C:/arcgis/ArcTutor/Editing" 
arcpy.ConsolidateMap_management('Exercise1.mxd', 'Consolidate_folder', 'PRESERVE', 'CONVERT_ARCSDE')
ConsolidateMap example 2 (stand-alone script)

Finds and consolidates all map documents that reside in a specified folder.

# Name: ConsolidateMap.py
# Description:  Find all the map documents that reside in a specified folder and create a consolidated
# folder for each map document found.

# 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 consolidated folder using the same 
# name as the original mxd
for mxd in arcpy.ListFiles('*.mxd'):
    print('Consolidating ' + mxd)
    arcpy.ConsolidateMap_management(mxd, os.path.splitext(mxd)[0], 'PRESERVE', 'CONVERT_ARCSDE')

Environments

Licensing information

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

Related topics