Package Project (Data Management)

Summary

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

Usage

• All elements of a project are 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, by default, are created for internal use. The Share outside of organization parameter allows you to control if a package is to be created for either 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 UNC file path to create an internal package where the data remains referenced. Local data paths will always be consolidated and packaged. Creating an internal package where 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. A project template (.aptx file) can help you create a new project by defining layers, maps, and data as well as required connections.

  Learn more about project templates

• Toolboxes that are part of a project are analyzed using the Analyze Tools for Pro tool before the consolidation process is performed. Identified errors will stop the consolidation process. You will need to either fix those 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 executing a geoprocessing tool) will be included in the package. Data required to execute 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 execution) or where data cannot be found will cause the packaging process to halt. You will need to 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 are 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, 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.

• 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 with the Additional Files parameter.

Caution:

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

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 to create a project template or a project package. Project templates can include maps, layouts, connections to databases and servers, and so on. A project template makes it easy to standardize a series of maps for different projects and to ensure the correct layers are immediately available for everyone to use in their maps. Unchecked—Creates a project package. This is the default. Checked—Creates a project template.	Boolean
Extent (Optional)	Specifies the extent that will be used to select or clip features. Default—The extent will be based on the maximum extent of all participating inputs. This is the default. Union of Inputs—The extent will be based on the maximum extent of all inputs. Intersection of Inputs—The extent will be based on the minimum area common to all inputs. Current Display Extent—The extent is equal to the visible display. The option is not available when there is no active map. As Specified Below—The extent will be based on the minimum and maximum extent values specified. Browse—The extent will be based on an existing dataset.	Extent
Apply Extent only to enterprise geodatabase layers (Optional)	Specifies whether the specified extent will be applied to all layers or only to enterprise geodatabase layers. Unchecked—Extent will be applied to all layers. This is the default. Checked—Extent will be applied to enterprise geodatabase layers only.	Boolean
Additional Files (Optional)	Adds additional files 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)	Adds summary information to the properties of the package.	String
Tags (Optional)	Adds tag information to the properties of the package. Multiple tags can be added or separated by 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 previous versions of ArcGIS and supports backward compatibility. Note: A package saved to a previous version may lose properties available only in the newer version. All versions — The package will contain geodatabases and maps compatible with all versions (ArcGIS Pro 2.1 and later). Current version — The package will contain geodatabases and maps compatible with the version of the current release. 2.1 —The package will contain geodatabases and maps compatible with version 2.1. 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.	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 inside 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 be excluded from 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 re-execute said history item. History items will be included —History items will be included in the output package. This is the default. History items will be excluded —History items will be excluded from 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—Project will be read only. Unchecked—Project is 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

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})

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 to create a project template or a project package. Templates can include maps, layouts, connections to databases and servers, and so on. A project template makes it easy to standardize a series of maps for different projects and to ensure the correct layers are immediately available for everyone to use in their maps. Learn more about project templates PROJECT_PACKAGE — A normal project package will be created. This is the default. PROJECT_TEMPLATE —A project template (.aptx file) 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 only to enterprise geodatabase layers. ALL — Specified extent will be applied to all layers. This is the default. ENTERPRISE_ONLY —Specified extent will be applied to enterprise geodatabase layers only.	Boolean
additional_files [additional_files,...] (Optional)	Adds additional files 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)	Adds summary information to the properties of the package.	String
tags (Optional)	Adds tag information to the properties of the package. Multiple tags can be added or separated by 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 previous versions of ArcGIS and supports backward compatibility. Note: A package saved to a previous version may lose properties available only in the newer version. ALL — The package will contain geodatabases and maps compatible with all versions (ArcGIS Pro 2.1 and later). CURRENT — The package will contain geodatabases and maps compatible with the version of the current release. 2.1 —The package will contain geodatabases and maps compatible with version 2.1. 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.	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 be excluded from 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 re-execute said history item. HISTORY_ITEMS —History items will be included in the output package. This is the default. NO_HISTORY_ITEMS —History items will be excluded from 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 —Project will be read only. READ_WRITE —Project is 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

Code sample

PackageProject example 1 (Python window)

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

import arcpy
p = arcpy.mp.ArcGISProject("CURRENT")
arcpy.PackageProject_management(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.upper():
            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.PackageProject_management(project, outputFile, "EXTERNAL")

Environments

Current Workspace

Licensing information

• Basic: Yes
• Standard: Yes
• Advanced: Yes