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 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 for 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 for the Extent parameter.

• Some datasets reference other datasets. For example, a topology dataset may reference 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

Dialog

Label	Explanation	Data Type
Input Map	The map (.mapx file) that will be consolidated. When running this tool in ArcGIS Pro, 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 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. Checked—All data will be converted to a file geodatabase. This option does not apply to enterprise geodatabase data sources. To include enterprise geodatabase data, check the Include Enterprise Geodatabase data instead of referencing the data parameter. Unchecked—Data formats will be preserved when possible. This is the default.	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. Checked—All enterprise geodatabase data sources will be converted to a file geodatabase. This is the default. Unchecked—All enterprise geodatabase data sources will be preserved and will be referenced in the resulting package.	Boolean
Extent (Optional)	Specifies the extent that will be used to select or clip features. Current Display Extent —The extent will be based on the active map or scene. Draw Extent —The extent will be based on a rectangle drawn on the map or scene. Extent of a Layer —The extent will be based on an active map layer. Choose an available layer or use the Extent of data in all layers option. Each map layer has the following options: All Features —The extent of all features. Selected Features —The extent of the selected features. Visible Features —The extent of visible features. Browse —The extent will be based on a dataset. Intersection of Inputs —The extent will be the intersecting extent of all inputs. Union of Inputs —The extent will be the combined extent of all inputs. Clipboard —The extent can be copied to and from the clipboard. Copy Extent —Copies the extent and coordinate system to the clipboard. Paste Extent —Pastes the extent and coordinate system from the clipboard. If the clipboard does not include a coordinate system, the extent will use the map’s coordinate system. Reset Extent —The extent will be reset to the default value. When coordinates are manually provided, the coordinates must be numeric values and in the active map's coordinate system. The map may use different display units than the provided coordinates. Use a negative value sign for south and west coordinates.	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. Unchecked—The specified extent will be applied to all layers. This is the default. Checked—The specified extent will be applied 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. If the input data is a mobile geodatabase network dataset, the output will always be mobile geodatabase. Unchecked—Mobile geodatabase data will be converted to file geodatabase. This is the default. Checked—Mobile geodatabase data will be preserved as SQLite in the consolidated folder.	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. Unchecked—Related data sources will be consolidated in their entirety. This is the default. Checked—Only related data corresponding to records within the specified extent will be consolidated.	Boolean
Consolidate to a single file geodatabase (Optional)	Specifies whether map layers will be consolidated to a single file geodatabase or to multiple file geodatabases based on the number of unique data sources in the input map. Unchecked—The output will include a file geodatabase for each unique data source in the input map. Each unique data source in the input map will remain as a dedicated data source in the output. For example, if the input map has two layers, and each layer has a data source in a different enterprise geodatabase, the output layer data sources will be in separate geodatabases. This is the default. Checked—All map layers will be consolidated into a single file geodatabase.	Boolean

Python

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

Name	Explanation	Data Type
in_map [in_map,...]	The map (.mapx file) that will be consolidated. When running this tool in ArcGIS Pro, 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 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 the convert_arcsde_data parameter to 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 to enterprise geodatabase layers only. 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)	Specifies whether input mobile geodatabase data will be preserved as mobile geodatabase in the output. If the input data is a mobile geodatabase network dataset, the output will always be mobile geodatabase. PRESERVE_SQLITE—Mobile geodatabase data will be preserved as SQLite in the consolidated folder. CONVERT_SQLITE—Mobile geodatabase data will be converted 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
consolidate_to_one_fgdb (Optional)	Specifies whether map layers will be consolidated to a single file geodatabase or to multiple file geodatabases based on the number of unique data sources in the input map. SINGLE_OUTPUT_WORKSPACE—All map layers will be consolidated into a single file geodatabase. MULTIPLE_OUTPUT_WORKSPACES—The output will include a file geodatabase for each unique data source in the input map. Each unique data source in the input map will remain as a dedicated data source in the output. For example, if the input map has two layers, and each layer has a data source in a different enterprise geodatabase, the output layer data sources will be in separate geodatabases. This is the default.	Boolean

Code sample

ConsolidateMap example 1 (Python window)

The following Python script demonstrates how to use the ConsolidateMap function.

# In this code, it is assumed that a map named "World1" exists in the current project
import arcpy
arcpy.management.ConsolidateMap('World1', 'c:/projects/World', 'PRESERVE', 'CONVERT_ARCSDE')

Environments

Current Workspace, Extent, Parallel Processing Factor

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