Package Project (Data Management)

Summary

Consolidates and packages a project file (.aprx) of referenced maps and data to a packaged project file (.ppkx).

Usage

• All elements of a project will be consolidated into the project package (.ppkx), including maps and 3D views, the data and layers in the maps, toolboxes, geoprocessing history items, styles, layouts, and folders or connections (server, workflow, and so on) when appropriate.

• Project packages are created for internal use by default. The Share outside of organization parameter allows you to control whether a package will be created for internal (inside your organizations network) or external use. When Share outside of organization is checked, enterprise geodatabase layers and data referenced from a UNC path will be included in the project package.

  Note:

  Data sources must be referenced from either an enterprise geodatabase or a UNC file path to create an internal package in which the data remains referenced. Local data paths will always be consolidated and packaged. Creating an internal package in which data is only referenced will open with broken links if shared outside your environment or to colleagues who do not have access to either the enterprise geodatabase or the UNC data shares.

• Templates can be created using the Package as template parameter. You can use a project template (.aptx file) to create a project by defining layers, maps, and data as well as required connections.

  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 process is performed. Identified errors will stop the consolidation process. You must either fix the errors or remove the tool from the project. Input data used by the tool will be consolidated, regardless of whether the data is part of a map in the project. Toolboxes can be excluded from the output project package by unchecking the Include Toolboxes parameter.

• Similar to project toolboxes, geoprocessing history (the result information from running a geoprocessing tool) will be included in the package. Data that is required to process the history item will be included in the output package regardless of whether it exists in a map or scene. Any history items that are invalid (failed during processing) or where data cannot be found will cause the packaging process to stop. You must remove or fix the history item in question. History items can be excluded from a project package by unchecking the Include History Items parameter.

• Connections—such as folder, server, database, and workflow—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.

• Files that document maps and data or provide additional information can be included in the package. Images, PDFs, Word documents, and .zip files can be included in the package by referencing them using the Additional Files parameter.

Caution:

Project packages (.ppkx files) can only be created and opened with ArcGIS AllSource.

Parameters

Dialog

Label	Explanation	Data Type
Input Project	The project (.aprx file) to be packaged.	File
Output File	The output project package (.ppkx file).	File
Share outside of organization (Optional)	Specifies whether the project will be consolidated for your internal environment or will move all data elements so it can be shared externally. 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—Enterprise data sources, such as enterprise geodatabases and data from a UNC path, will not be copied to the local folder. This is the default. Checked—Data formats will be copied and preserved when possible.	Boolean
Package as template (Optional)	Specifies whether a project template or a project package will be created. Project templates can include maps, layouts, connections to databases and servers, and so on. A project template can be used to standardize a series of maps for different projects and to ensure that the correct layers are immediately available for everyone to use in their maps. Unchecked—A project package will be created. This is the default. Checked—A project template will be created.	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. This option is only available when there is an active map. Draw Extent —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 —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 —The extent of all features in the layer. Selected Features —The extent of the selected features in the layer. Visible Features —The extent of visible features in the layer. Note: The extents from the Selected Features and Visible Features options are only available for feature layers. Browse —The extent will be based on an existing dataset. Intersection of Inputs —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 —The extent will be based on the maximum or combined extent of all inputs. Clipboard —The extent can be copied to and from the clipboard. Copy Extent —Copies the extent coordinates and coordinate system to the clipboard. Paste Extent —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 —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 specified extent 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
Additional Files (Optional)	The additional files that will be added to a package. Additional files, such as .doc, .txt, .pdf, and so on, are used to provide more information about the contents and purpose of the package.	File
Summary (Optional)	The summary information that will be added to the properties of the package.	String
Tags (Optional)	The tags that will be added to the properties of the package. Separate multiple tags with a comma or semicolon.	String
Package version (Optional)	Specifies the version of the geodatabases that will be created in the resulting package. Specifying a version allows packages to be shared with earlier versions of ArcGIS and supports backward compatibility. Note: A package saved to an earlier version may lose properties that are only available in the later version. All versions— The package will contain geodatabases and maps compatible with all versions (ArcGIS AllSource 2.1 and later). Current version— The package will contain geodatabases and maps compatible with the version of the current release. ArcGIS AllSource 2.2— The package will contain geodatabases and maps compatible with version 2.2. ArcGIS AllSource 2.3—The package will contain geodatabases and maps compatible with version 2.3. ArcGIS AllSource 2.4—The package will contain geodatabases and maps compatible with version 2.4. ArcGIS AllSource 2.5—The package will contain geodatabases and maps compatible with version 2.5. ArcGIS AllSource 2.6—The package will contain geodatabases and maps compatible with version 2.6. ArcGIS AllSource 2.7—The package will contain geodatabases and maps compatible with version 2.7. ArcGIS AllSource 2.8—The package will contain geodatabases and maps compatible with version 2.8. ArcGIS AllSource 2.9—The package will contain geodatabases and maps compatible with version 2.9. ArcGIS AllSource 3.0—The package will contain geodatabases and maps compatible with version 3.0. ArcGIS AllSource 3.1—The package will contain geodatabases and maps compatible with version 3.1. ArcGIS AllSource 3.2—The package will contain geodatabases and maps compatible with version 3.2. ArcGIS AllSource 3.3—The package will contain geodatabases and maps compatible with version 3.3.	String
Include Toolboxes (Optional)	Specifies whether project toolboxes, and the data referenced by the tools in the project toolboxes, will be consolidated and included in the output package. All projects require a default toolbox, and the default toolbox will be included regardless of this setting. A toolbox in a connected folder is not considered a project toolbox and is not impacted by this setting. Checked—Project toolboxes will be included in the output package. This is the default. Unchecked—Project toolboxes will not be included in the output package.	Boolean
Include History Items (Optional)	Specifies whether geoprocessing history items will be consolidated and included in the output package. Included history items will consolidate the data required to reprocess the history item. History items will be included—History items will be included in the output package. This is the default. History items will not be included—History items will not be included in the output package. Only valid history items will be included—Only valid history items will be included in the output package. History items are invalid if any of the original input layers or tools cannot be found.	String
Read Only Package (Optional)	Specifies whether the project will be read-only. Read-only projects cannot be modified or saved. Checked—The project will be read-only. Unchecked—The project will be writable. This is the default.	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
Preserve Mobile Geodatabase (Optional)	Specifies whether input mobile geodatabase data will be preserved in the output or written to file geodatabase format. If the input data is a mobile geodatabase network dataset, the output will be a mobile geodatabase. Unchecked—Mobile geodatabase data will be converted to file geodatabase format. This is the default. Checked—Mobile geodatabase data will be preserved as mobile geodatabase data in the output. The geodatabase will be included in its entirety.	Boolean

Python

arcpy.management.PackageProject(in_project, output_file, {sharing_internal}, {package_as_template}, {extent}, {apply_extent_to_arcsde}, {additional_files}, {summary}, {tags}, {version}, {include_toolboxes}, {include_history_items}, {read_only}, {select_related_rows}, {preserve_sqlite})

Name	Explanation	Data Type
in_project	The project (.aprx file) to be packaged.	File
output_file	The output project package (.ppkx file).	File
sharing_internal (Optional)	Specifies whether the project will be consolidated for your internal environment or will move all data elements so it can be shared externally. INTERNAL— Enterprise data sources, such as enterprise geodatabases and data from a UNC path, will not be copied to the local folder. This is the default. EXTERNAL—Data formats will be copied and preserved when possible.	Boolean
package_as_template (Optional)	Specifies whether a project template or a project package will be created. Project templates can include maps, layouts, connections to databases and servers, and so on. A project template can be used to standardize a series of maps for different projects and to ensure that the correct layers are immediately available for everyone to use in their maps. Learn more about creating a project template PROJECT_PACKAGE— A project package will be created. This is the default. PROJECT_TEMPLATE—A project template will be created	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. ENTERPRISE_ONLY—The specified extent will be applied to enterprise geodatabase layers only.	Boolean
additional_files [additional_files,...] (Optional)	The additional files that will be added to a package. Additional files, such as .doc, .txt, .pdf, and so on, are used to provide more information about the contents and purpose of the package.	File
summary (Optional)	The summary information that will be added to the properties of the package.	String
tags (Optional)	The tags that will be added to the properties of the package. Separate multiple tags with a comma or semicolon.	String
version [version,...] (Optional)	Specifies the version of the geodatabases that will be created in the resulting package. Specifying a version allows packages to be shared with earlier versions of ArcGIS and supports backward compatibility. Note: A package saved to an earlier version may lose properties that are only available in the later version. ALL— The package will contain geodatabases and maps compatible with all versions (ArcGIS AllSource 2.1 and later). CURRENT— The package will contain geodatabases and maps compatible with the version of the current release. 2.2— The package will contain geodatabases and maps compatible with version 2.2. 2.3—The package will contain geodatabases and maps compatible with version 2.3. 2.4—The package will contain geodatabases and maps compatible with version 2.4. 2.5—The package will contain geodatabases and maps compatible with version 2.5. 2.6—The package will contain geodatabases and maps compatible with version 2.6. 2.7—The package will contain geodatabases and maps compatible with version 2.7. 2.8—The package will contain geodatabases and maps compatible with version 2.8. 2.9—The package will contain geodatabases and maps compatible with version 2.9. 3.0—The package will contain geodatabases and maps compatible with version 3.0. 3.1—The package will contain geodatabases and maps compatible with version 3.1. 3.2—The package will contain geodatabases and maps compatible with version 3.2. 3.3—The package will contain geodatabases and maps compatible with version 3.3.	String
include_toolboxes (Optional)	Specifies whether project toolboxes will be consolidated and included in the output package. All projects require a default toolbox, and the default toolbox will be included regardless of this setting. TOOLBOXES—Project toolboxes will be included in the output package. This is the default. NO_TOOLBOXES—Project toolboxes will not be included in the output package.	Boolean
include_history_items (Optional)	Specifies whether geoprocessing history items will be consolidated and included in the output package. Included history items will consolidate the data required to reprocess the history item. HISTORY_ITEMS—History items will be included in the output package. This is the default. NO_HISTORY_ITEMS—History items will not be included in the output package. VALID_HISTORY_ITEMS_ONLY—Only valid history items will be included in the output package. History items are invalid if any of the original input layers or tools cannot be found.	String
read_only (Optional)	Specifies whether the project will be read-only. Read-only projects cannot be modified or saved. READ_ONLY—The project will be read-only. READ_WRITE—The project will be writable. 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
preserve_sqlite (Optional)	Specifies whether mobile geodatabase data will be preserved in the output or written to file geodatabase format. If the input data is a mobile geodatabase network dataset, the output will be a mobile geodatabase. CONVERT_SQLITE—Mobile geodatabase data will be converted to file geodatabase format. This is the default. PRESERVE_SQLITE— Mobile geodatabase data will be preserved in the output. The geodatabase will be included in its entirety.	Boolean

Code sample

PackageProject example 1 (Python window)

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

import arcpy
p = arcpy.mp.ArcGISProject("CURRENT")
arcpy.management.PackageProject(p.filePath, 'E:\\gisShare\\projects\\Pipelines\\SE_Pipeline.ppkx', 'INTERNAL')

PackageProject example 2 (stand-alone script)

The following Python script turns all projects from a directory, with the word oil in the file name, into a project package (.ppkx).

import os
import arcpy

enterpriseProjectDir = "\\\\centralFileServer\\gisData\\ArcGISProProjects"
sharedProjectDir = "c:\\publicFiles\\sharedProjects"

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

for dirpath, dirnames, filenames in walk:
    for filename in filenames:
        if "oil" in filename.lower():
            project = os.path.join(dirpath, filename)
            outputFile = os.path.join(sharedProjectDir, os.path.splitext(os.path.basename(project))[0] + ".ppkx")
            print("Packaging: {0} to {1}".format(project, outputFile))
            arcpy.management.PackageProject(project, outputFile, "EXTERNAL")

Environments

Current Workspace, Parallel Processing Factor

Special cases

Parallel Processing Factor

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