| Label | Explanation | Data Type |
Input Project
| The project (.aprx file) that will 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 to network data (for sharing within your organization). 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 value.
| Boolean |
Extent
(Optional) | Specifies the extent that will be used to select or clip features.
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 extent will be applied to all layers or 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.
| 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.
| Boolean |
Version
(Optional) | Specifies the ArcGIS Pro version to which objects such as projects, maps, and layers will be persisted. Saving to an earlier version is useful if the project will be used with earlier versions of ArcGIS Pro. Note:A project saved to an earlier version may lose functionality or properties that are only available in later versions.
| 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.
| Boolean |
Summary
Consolidates an ArcGIS Pro project (.aprx file) and referenced maps and data into a folder.
Usage
The data and elements in the 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 referenced from networked resources will be consolidated into the folder.
- Unchecked—Packages will be created for your internal environment, meaning the data will not be consolidated. Data stored on UNC paths, enterprise geodatabase layers, feature services, 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 be unavailable outside your network—such as enterprise geodatabase connections, feature services, and data stored on shared folders—will be converted or 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 value.
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.
Use the Analyze Tools For Pro and Analyze Toolbox for Version tools to analyze toolboxes that are part of a project before consolidation. Errors that are identified can stop the consolidation process. You must either fix the errors or remove the tool from 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
—The extent will be based on the active map or scene.
—The extent will be based on a rectangle drawn on the map or scene.
—The extent will be based on an active map layer. Choose an available layer or use the 
—The extent of all features.
—The extent of the selected features.
—The extent of visible features.
—The extent will be based on a dataset.
—The extent will be the intersecting extent of all inputs.
—The extent will be the combined extent of all inputs.
—The extent can be copied to and from the clipboard.
—Copies the extent and coordinate
system to the clipboard.
—The extent will be reset to the default value.arcpy.management.ConsolidateProject(in_project, output_folder, {sharing_internal}, {extent}, {apply_extent_to_enterprise_geo}, {package_as_template}, {preserve_sqlite}, {version}, {select_related_rows})| Name | Explanation | Data Type |
in_project | The project (.aprx file) that will 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 a single folder (for sharing outside your organization) or referenced to network data (for sharing within your organization).
| Boolean |
extent (Optional) | Specifies the extent that will be used to select or clip features.
| Extent |
apply_extent_to_enterprise_geo (Optional) | Specifies whether the extent will be applied to all layers or 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
| 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.
| Boolean |
version (Optional) | Specifies the ArcGIS Pro version to which objects such as projects, maps, and layers will be persisted. Saving to an earlier version is useful if the project will be used with earlier versions of ArcGIS Pro. Note:A project saved to an earlier version may lose functionality or properties that are only available in later versions.
| String |
select_related_rows (Optional) | Specifies whether the specified extent will be applied to related data sources.
| Boolean |
Code sample
The following Python script demonstrates how to use the ConsolidateProject function from the Python window.
import arcpy
arcpy.management.ConsolidateProject(r'c:\projects\SE_Pipelines\PipeDevelopment.aprx',
r'E:\gisShare\projects\Pipelines\SE_Pipeline',
'INTERNAL')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 = r"\\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.
Licensing information
- Basic: Yes
- Standard: Yes
- Advanced: Yes