ArcGIS for Desktop

  • Documentation
  • Pricing
  • Support

  • My Profile
  • Help
  • Sign Out
ArcGIS for Desktop

ArcGIS Online

The mapping platform for your organization

ArcGIS for Desktop

A complete professional GIS

ArcGIS for Server

GIS in your enterprise

ArcGIS for Developers

Tools to build location-aware apps

ArcGIS Solutions

Free template maps and apps for your industry

ArcGIS Marketplace

Get apps and data for your organization

  • Documentation
  • Pricing
  • Support
Esri
  • Sign In
user
  • My Profile
  • Sign Out

Help

  • Home
  • Get Started
  • Map
  • Analyze
  • Manage Data
  • Tools
  • More...

Consolidate Layer

  • Summary
  • Usage
  • Syntax
  • Code sample
  • Environments
  • Licensing information

Summary

Consolidates one or more layers by copying all referenced data sources into a single 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 consolidating or packaging layers, the resulting layers will be renamed using the convention <integer><layername>.lyr (for example, 0000roads.lyr). This renaming is needed to ensure all layers that reference unique data sources, and have the same layer name within ArcMap, have unique layer names in the consolidated folder.

    Naming convention

  • When Convert data to file geodatabase is checked

    • 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 have enterprise geodatabase data converted to a file geodatabase, check Include Enterprise geodatabase data instead of referencing the data.

  • When Convert data to file geodatabase is unchecked

    • The data source format of the input layers will be preserved. The exception are formats such as personal geodatabase (.mdb) data, VPF data, and tables based on Excel spreadsheets or OLEDB connections. These formats are not supported within 64x environments and therefore 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 into a version-specific folder, and all other formats will be consolidated into 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.

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

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

  • The Schema only parameter, if checked, will only consolidate or package the schema of the input data sources. A schema is the structure or design of a feature class or table that consists of field and table definitions, coordinate system properties, symbology, definition queries, and so on. Data or records will not be consolidated or packaged.

  • Data sources that do not support schema only will not be consolidated or packaged. If the Schema only parameter is checked and the tool encounters a layer that is not supported for schema only, a warning message is displayed, and that layer will be skipped. If the only layer specified is unsupported for schema only, the tool will fail.

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

Syntax

ConsolidateLayer_management (in_layer, output_folder, {convert_data}, {convert_arcsde_data}, {extent}, {apply_extent_to_arcsde}, {schema_only})
ParameterExplanationData Type
in_layer
[in_layer,...]

The input layers to be consolidated.

Layer
output_folder

The output folder that will contain the layer files and consolidated data.

Folder
convert_data
(Optional)

Specifies whether input layers will be converted into a file geodatabase or preserve their original format.

  • CONVERT — Data will be converted to a file geodatabase.
    Note:

    This parameter does not apply to enterprise geodatabase data sources. To convert enterprise geodatabase data, set convert_arcsde_data to CONVERT_ARCSDE.

  • PRESERVE —Data formats will be preserved when possible. This is the default.
    Note:

    The exception to this rule 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 into a file geodatabase or preserve their original format.

  • CONVERT_ARCSDE — Enterprise geodatabase data will be converted to a file geodatabase and 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)

Specify 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 —Union of inputs
  • MINOF —Intersection of inputs
  • DISPLAY —Same extent as current display
  • <Layer> —Same extent as specified layer
Extent
apply_extent_to_arcsde
(Optional)

Determines whether specified extent will be applied to all layers or only to enterprise geodatabase layers.

  • ALL — Specified extent is applied to all layers. This is the default.
  • ARCSDE_ONLY —Specified extent is applied to enterprise geodatabase layers only.
Boolean
schema_only
(Optional)

Specifies whether only the schema of the input layers will be consolidated or packaged.

  • ALL — All features and records will be consolidated or packaged. This is the default.
  • SCHEMA_ONLY — Only the Schema of input layers will be consolidated or packaged.
Boolean

Code sample

ConsolidateLayer example 1 (Python window)

The following Python window script demonstrates how to use the ConsolidateLayer tool in immediate mode.

import arcpy
arcpy.env.workspace = "C:/arcgis/ArcTutor/BuildingaGeodatabase/Layers" 
arcpy.ConsolidateLayer_management('Parcels.lyr', 'Consolidated_folder', "PRESERVE", "CONVERT_ARCSDE", "#", "ALL","ALL")
ConsolidateLayer example 2 (stand-alone Python script)

Finds and creates individual consolidated folders for all of the layer files that reside in a specified folder.

# Name: ConsolidateLayerEx1.py
# Description:  Find all the layer files that reside in a specified folder and create a consolidated folder for each layer file.

# import system modules
import os 
import arcpy

# Set environment settings
arcpy.env.overwriteOutput = True
arcpy.env.workspace = "C:/arcgis/ArcTutor/BuildingaGeodatabase/Layers" 

# Loop through the workspace, find all the layer files (.lyr) and create a consolidated folder for each 
# layer file found using the same name as the original layer file.
for lyr in arcpy.ListFiles("*.lyr"):
    print("Consolidating " +  lyr)
    arcpy.ConsolidateLayer_management(lyr, os.path.splitext(lyr)[0], "PRESERVE", "CONVERT_ARCSDE", "#", "ALL", "ALL")

Environments

  • Current Workspace
  • Extent

Licensing information

  • ArcGIS for Desktop Basic: Yes
  • ArcGIS for Desktop Standard: Yes
  • ArcGIS for Desktop Advanced: Yes

Related topics

  • An overview of the Package toolset
  • Saving layers and layer packages

ArcGIS for Desktop

  • Home
  • Documentation
  • Pricing
  • Support

ArcGIS Platform

  • ArcGIS Online
  • ArcGIS for Desktop
  • ArcGIS for Server
  • ArcGIS for Developers
  • ArcGIS Solutions
  • ArcGIS Marketplace

About Esri

  • About Us
  • Careers
  • Insiders Blog
  • User Conference
  • Developer Summit
Esri
Tell us what you think.
© Copyright 2016 Environmental Systems Research Institute, Inc. | Privacy | Legal