Consolidate Project (Data Management)

Summary

Consolidates a project (an .aprx file) and referenced maps and data into a specified output folder.

Usage

  • All elements of a project will be consolidated and included in the .aprx file, including maps, the data referenced by the layers, toolboxes, styles, layouts, and connections when appropriate.

  • The Share outside of organization parameter controls whether the data will be consolidated into the folder.

    • Unchecked—Packages will be created for your internal environment, meaning the data will not be consolidated. UNC paths and enterprise geodatabase layers, styles, and connections will remain referenced in the consolidated project.
    • Checked—All required data sources for the package will be copied to the consolidated folder. Items that would not be available outside your network, such as enterprise geodatabase connections and paths to UNC folders, will not be included. However, if data from these sources is included in a map or layout in the project, it will be copied to the output folder.

    Note:

    Data and maps will be consolidated if the project references them from a local path, such as c:\gisdata\landrecords.gdb\, regardless of the Share outside of organization parameter setting.

  • Templates can be created using the Consolidate as template parameter. You can use a project template to define layers, maps, and data as well as required connections when creating a project.

    Learn more about creating a project template

  • Use the Analyze Tools For Pro tool to analyze toolboxes that are part of a project before the consolidation routines are performed. Errors that are identified will stop the consolidation process. You must either fix the errors or remove the tool from the project. Input data that the tools require will be consolidated regardless of whether the data is part of a map in the project.

  • Connections such as folder, server, database, workflow, and data reviewer will only be included in an internal package. These items will be removed if the package is created to be shared outside your organization.

  • Items such as attachments, styles, and tasks will be referenced for internal packages if they were part of the project from a UNC path. These items will be copied and packaged in all other situations.

  • For feature layers, use the Extent parameter to select the features that will be consolidated. For raster layers, use the Extent parameter to clip the raster datasets.

Parameters

LabelExplanationData Type
Input Project

The project (.aprx file) to be consolidated.

File
Output Folder

The output folder that will contain the consolidated project and data. If the specified folder does not exist, a folder will be created.

Folder
Share outside of organization
(Optional)

Specifies whether the project and all data will be consolidated into a single folder (for sharing outside your organization) or referenced (for sharing within your organization). Data paths referenced from enterprise geodatabases or a UNC file system can be shared internally. If the project was not built with data paths like this, the data will be consolidated into the project package.

Note:

Data and maps will be consolidated and packaged if the project references them from a local path, such as c:\gisdata\landrecords.gdb\ regardless of this parameter's setting.

  • Unchecked—The project and its data sources will not be consolidated into the output folder. This is the default. This parameter applies to enterprise geodatabase data sources, including enterprise geodatabases and folders referenced through a UNC path.
  • Checked—The project and its data sources will be copied and preserved when possible.
Boolean
Extent
(Optional)

Specifies the extent that will be used to select or clip features.

  • Current Display Extent Map View—The extent will be based on the active map or scene. This option is only available when there is an active map.
  • Draw Extent Square and Finish—The extent will be based on a rectangle drawn on the map or scene. This option will create a feature class in the project geodatabase and add a layer to the map. The feature class will have the same coordinate system as the map.
    Note:

    This option is not available in the Environments dialog box. It is only available from a tool parameter with an extent data type or from the Environments tab on a tool dialog box.

    Note:

    When the Enable and disable editing from the Edit tab editing option is checked, you must enable editing on the Edit ribbon tab to draw the extent.

  • Extent of a Layer Layer—The extent will be based on an active map layer. Use the drop-down list to choose an available layer or use the Extent of data in all layers option to get the combined extent of all active map layers, excluding the basemap. This option is only available when there is an active map with layers.

    Each map layer has the following options:

    • All Features Select All—The extent of all features in the layer.
    • Selected Features Area from Selected Features—The extent of the selected features in the layer.
    • Visible Features Extent Indicator—The extent of visible features in the layer.
      Note:

      The extents from the Selected Features Area from Selected Features and Visible Features Extent Indicator options are only available for feature layers.

  • Browse Browse—The extent will be based on an existing dataset.
  • Intersection of Inputs Intersect—The extent will be based on the minimum or intersecting extent of all inputs. If no inputs overlap, a null extent with all zeros will result.
  • Union of Inputs Union—The extent will be based on the maximum or combined extent of all inputs.
  • Clipboard Paste—The extent can be copied to and from the clipboard.
    • Copy Extent Copy—Copies the extent coordinates and coordinate system to the clipboard.
    • Paste Extent Paste—Pastes the extent coordinates and, optionally, the coordinate system from the clipboard. If the clipboard values do not include a coordinate system, the extent will use the map’s coordinate system.
    Note:

    The extent coordinates are copied to and pasted from the clipboard using the same formatting and order as the ArcPy Extent object: x-min, y-min, x-max, y-max, and the spatial reference.

  • Reset Extent Reset—The extent will be reset to the default value.
  • Manually entered coordinates—The coordinates must be numeric values and in the active map's coordinate system.
    Caution:

    The map may use different display units than the entered coordinates. The use of a cardinal direction (N, S, E, W) is not supported. Use a negative value sign for south and west coordinates.

Extent
Apply Extent only to enterprise geodatabase layers
(Optional)

Specifies whether the Extent parameter value will be applied to all layers or to enterprise geodatabase layers only.

  • Unchecked—The extent will be applied to all layers. This is the default.
  • Checked—The extent will be applied to enterprise geodatabase layers only.

Boolean
Consolidate as template
(Optional)

Specifies whether the project will be consolidated as a template or a regular project. Templates can include maps, layouts, connections to databases and servers, and so on. A project template allows you to standardize a series of maps for use in a project and ensure that the correct layers are immediately available for use.

  • Unchecked—The project will be consolidated as a project into a folder. This is the default.
  • Checked—The project will be consolidated as a template into a folder.

Boolean
Preserve Mobile Geodatabase
(Optional)

Specifies whether mobile geodatabases will be preserved or converted to file geodatabases.

Note:

This parameter applies only to mobile geodatabases (.geodatabase) used primarily for offline workflows in ArcGIS Runtime apps. SQLite databases with .sqlite or .gpkg file extensions will be converted to file geodatabases.

  • Unchecked—Mobile geodatabases will be converted to file geodatabases. This is the default.
  • Checked—Mobile geodatabases will be preserved.

Boolean
Version
(Optional)

Specifies the ArcGIS AllSource version that the consolidated project will be saved as. Saving to an earlier version will ensure tool backward compatibility. If you attempt to consolidate a toolbox to an earlier version and capabilities that are only available in the newer version are included, an error will occur. You must remove tools that are incompatible with the earlier version, or specify a compatible version.

  • Current version The consolidated folder will contain geodatabases and maps compatible with the version of the current release.
  • ArcGIS AllSource 2.2 The consolidated folder will contain geodatabases and maps compatible with version 2.2.
  • ArcGIS AllSource 2.3The consolidated folder will contain geodatabases and maps compatible with version 2.3.
  • ArcGIS AllSource 2.4The consolidated folder will contain geodatabases and maps compatible with version 2.4.
  • ArcGIS AllSource 2.5The consolidated folder will contain geodatabases and maps compatible with version 2.5.
  • ArcGIS AllSource 2.6The consolidated folder will contain geodatabases and maps compatible with version 2.6.
  • ArcGIS AllSource 2.7The consolidated folder will contain geodatabases and maps compatible with version 2.7.
  • ArcGIS AllSource 2.8The consolidated folder will contain geodatabases and maps compatible with version 2.8.
  • ArcGIS AllSource 2.9The consolidated folder will contain geodatabases and maps compatible with version 2.9.
  • ArcGIS AllSource 3.0The consolidated folder will contain geodatabases and maps compatible with version 3.0.
  • ArcGIS AllSource 3.1The consolidated folder will contain geodatabases and maps compatible with version 3.1.
  • ArcGIS AllSource 3.2The consolidated folder will contain geodatabases and maps compatible with version 3.2.
  • ArcGIS AllSource 3.3The consolidated folder will contain geodatabases and maps compatible with version 3.3.
String
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

arcpy.management.ConsolidateProject(in_project, output_folder, {sharing_internal}, {extent}, {apply_extent_to_enterprise_geo}, {package_as_template}, {preserve_sqlite}, {version}, {select_related_rows})
NameExplanationData Type
in_project

The project (.aprx file) to be consolidated.

File
output_folder

The output folder that will contain the consolidated project and data. If the specified folder does not exist, a folder will be created.

Folder
sharing_internal
(Optional)

Specifies whether the project and all data will be consolidated into the output folder so it can be shared externally.

  • INTERNAL The project and its data sources will not be consolidated into the output folder. This is the default.
    Note:

    This parameter applies to enterprise geodatabase data sources, including enterprise geodatabases and folders referenced through a UNC path.

  • EXTERNALThe project and its data sources will be consolidated (copied) into the output folder when possible.
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_enterprise_geo
(Optional)

Specifies whether the extent parameter value will be applied to all layers or to enterprise geodatabase layers only.

  • ALL The extent will be applied to all layers. This is the default.
  • ENTERPRISE_ONLYThe extent will be applied to enterprise geodatabase layers only.
Boolean
package_as_template
(Optional)

Specifies whether the project will be consolidated as a template or a regular project. Templates can include maps, layouts, connections to databases and servers, and so on. A project template allows you to standardize a series of maps for use in a project and ensure that the correct layers are immediately available for use.

Learn more about creating a project template

  • PROJECT_PACKAGEThe project will be consolidated as a project into a folder. This is the default.
  • PROJECT_TEMPLATEThe project will be consolidated as a template into a folder
Boolean
preserve_sqlite
(Optional)

Specifies whether mobile geodatabases will be preserved or converted to file geodatabases.

Note:

This parameter applies only to mobile geodatabases (.geodatabase) used primarily for offline workflows in ArcGIS Runtime apps. SQLite databases with .sqlite or .gpkg file extensions will be converted to file geodatabases.

  • CONVERT_SQLITEMobile geodatabases will be converted to file geodatabases. This is the default.
  • PRESERVE_SQLITEMobile geodatabases will be preserved.
Boolean
version
(Optional)

Specifies the ArcGIS AllSource version that the consolidated project will be saved as. Saving to an earlier version will ensure tool backward compatibility. If you attempt to consolidate a toolbox to an earlier version and capabilities that are only available in the newer version are included, an error will occur. You must remove tools that are incompatible with the earlier version, or specify a compatible version.

  • CURRENT The consolidated folder will contain geodatabases and maps compatible with the version of the current release.
  • 2.2 The consolidated folder will contain geodatabases and maps compatible with version 2.2.
  • 2.3The consolidated folder will contain geodatabases and maps compatible with version 2.3.
  • 2.4The consolidated folder will contain geodatabases and maps compatible with version 2.4.
  • 2.5The consolidated folder will contain geodatabases and maps compatible with version 2.5.
  • 2.6The consolidated folder will contain geodatabases and maps compatible with version 2.6.
  • 2.7The consolidated folder will contain geodatabases and maps compatible with version 2.7.
  • 2.8The consolidated folder will contain geodatabases and maps compatible with version 2.8.
  • 2.9The consolidated folder will contain geodatabases and maps compatible with version 2.9.
  • 3.0The consolidated folder will contain geodatabases and maps compatible with version 3.0.
  • 3.1The consolidated folder will contain geodatabases and maps compatible with version 3.1.
  • 3.2The consolidated folder will contain geodatabases and maps compatible with version 3.2.
  • 3.3The consolidated folder will contain geodatabases and maps compatible with version 3.3.
String
select_related_rows
(Optional)

Specifies whether the specified extent will be applied to related data sources.

  • KEEP_ONLY_RELATED_ROWSOnly related data corresponding to records within the specified extent will be consolidated.
  • KEEP_ALL_RELATED_ROWSRelated data sources will be consolidated in their entirety. This is the default.
Boolean

Code sample

ConsolidateProject example 1 (Python window)

The following Python script demonstrates how to use the ConsolidateProject function from the Python window.

import arcpy
arcpy.management.ConsolidateProject('c:\\projects\\SE_Pipelines\\PipeDevelopment.aprx', 
                                    'E:\\gisShare\\projects\\Pipelines\\SE_Pipeline',
                                    'INTERNAL')
ConsolidateProject example 2 (stand-alone script)

The following script takes an input directory in which project files (.aprx) reside on a UNC share and consolidates the project onto a local drive. The data will still be accessible to the now local project, as the INTERNAL keyword is used.

import os
import arcpy

enterpriseProjectDir = "\\\\centralFileServer\\gisData\\ArcGISProProjects"
localProjectDir = "c:\\GISdata\\localProjects"

walk = arcpy.da.Walk(enterpriseProjectDir, datatype="Project")

for dirpath, dirnames, filenames in walk:
    for fname in filenames:
        project = os.path.join(dirpath, fame)
        outputFolder = os.path.join(localProjectDir, 
                                    os.path.splitext(os.path.basename(project))[0])
        print("Consolidating: {0} to {1}".format(project, outputFolder))
        arcpy.management.ConsolidateProject(project, outputFolder, "INTERNAL")

Environments

Special cases

Parallel Processing Factor

If the environment is not specified, the tool will use one half of the available cores.

Related topics