Consolidate Map (Data Management)

Summary

Consolidates a map document and all referenced data sources to a specified output folder.

Illustration

The output folder structure of a map document that has been consolidated using the default settings.

Usage

• A warning is issued when this tool encounters an unsupported layer type (a schematics or tool layer). The unsupported layer will not be written to the output.

• When Convert Data to File Geodatabase is checked

  • Each data source will have a unique file geodatabase created in the consolidated folder.
  • Compressed raster and vector formats will be converted to file geodatabase, and compression will be lost.

• When Convert Data to File Geodatabase is unchecked

  • The format of the input layers will be preserved with one exception; layers that reference data in a personal geodatabase are always converted to file geodatabase.
  • Every data source will preserve its original format. File geodatabases will be consolidated into a version-specific folder, and all other formats will be consolidated in the commonData folder.
  • Layers that point to ArcSDE data sources will preserve their connection information and remain pointing to the ArcSDE data source in the consolidated folder or package.
  • 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.
  • 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.

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

• Consolidating or packaging Coverage or VPF layers will copy the entire Coverage or VPF dataset into the consolidated folder or package.

Syntax

ConsolidateMap_management (in_map, output_folder, {convert_data}, {convert_arcsde_data}, {extent}, {apply_extent_to_arcsde})

Parameter	Explanation	Data Type
in_map	The input map document (.mxd) that will be consolidated.	ArcMap Document
output_folder	The output folder that will contain the consolidated map document and data.	Folder
convert_data (Optional)	Specifies whether input layers will be converted into file geodatabase or preserve their original format. CONVERT — Data will be copied to a file geodatabase. PRESERVE — Data formats will be preserved. This is the default.	Boolean
convert_arcsde_data (Optional)	Specifies whether input layers will be converted into file geodatabase or preserve their original format. CONVERT_ARCSDE — ArcSDE data will be copied to a file geodatabase. This is the default. PRESERVE_ARCSDE — ArcSDE data will be preserved and will be referenced in the resulting consolidated folder or package.	Boolean
extent (Optional)	Specify the extent by manually entering the coordinates in the extent parameter using the format X-Min Y-Min X-Max Y-Max. Additionally, to use the extent of a specific layer, simply add the layer name for the extent parameter. MAXOF —Union of inputs MINOF —Intersection of inputs DISPLAY —Same as Display <Layer> —Same as Layer...	Extent
apply_extent_to_arcsde (Optional)	Specifies the extent that will be used to select ArcSDE data sources. ALL — Specified extent is applied to all layers. This is the default. ARCSDE_ONLY —Specified extent is applied to ArcSDE layers only.	Boolean

Code Sample

ConsolidateMap Example (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", "#", "ALL")

ConsolidateMap Example (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.
# Author: ESRI

# import system modules
import os
import arcpy

from arcpy import env

# Set environment settings
env.overwriteOutput = True
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", "#", "ALL")

Environments

Current Workspace, Extent

Licensing Information

ArcView: Yes

ArcEditor: Yes

ArcInfo: Yes