Share a project package

Project packages (.ppkx files) allow you to share complete projects. A project package is a file that contains all maps and the data referenced by its layers, as well as folder connections, toolboxes, geoprocessing history, and attachments. Project packages can be used for sharing projects between colleagues in a work group, across departments in an organization, or with any other ArcGIS users through ArcGIS Online or ArcGIS Enterprise. You can also package projects to create an archive or snapshot of a particular project in its current state.

Create a project package

When sharing your content within your organization, it's likely that enterprise databases, UNC path data, styles, and connections are accessible to those consuming the project package. In this case, unchecking the Share outside of organization option limits access to these resources. Enterprise database data, UNC path data, styles, and connections in your map are referenced, not copied, to the project package. However, when sharing your content outside your organization, enterprise databases, UNC path data, styles, and connections to folders, servers, and databases are not accessible, and you can check the Share outside of organization option to include the data in your package. If you check this option, data is extracted from enterprise databases and UNC path folders and copied to a file geodatabase, styles are copied, and all connections are removed.

Project itemShare inside organizationShare outside of organizationNotes

Maps

Consolidate local data, reference UNC path and enterprise geodatabase data.

Consolidate local data, UNC path, and enterprise geodatabase data.

Data that is reused is only copied to the project package once.

Scenes

Consolidate local data, reference UNC path and enterprise geodatabase data.

Consolidate local data, UNC path, and enterprise geodatabase data.

Data that is reused is only copied to the project package once.

Basemaps

Consolidate local data, reference UNC path and enterprise geodatabase data.

Consolidate local data, UNC path, and enterprise geodatabase data.

Data that is reused is only copied to the project package once.

Layouts

Consolidate local data, reference UNC path and enterprise geodatabase data.

Consolidate local data, UNC path, and enterprise geodatabase data.

Data that is reused is only copied to the project package once.

Reports

Consolidate local data, reference UNC path and enterprise geodatabase data.

Consolidate local data, UNC path, and enterprise geodatabase data.

Data that is reused is only copied to the project package once.

Toolboxes

Consolidate local data, reference UNC path and enterprise geodatabase data.

Consolidate local data, UNC path, and enterprise geodatabase data.

Input, output, and intermediate data is not copied.

Model project data is copied, but input data is not.

The default toolbox is always copied to the project package.

See additional considerations below.

To exclude all toolboxes from the package except the default project toolbox, uncheck the Include Toolboxes option.

Geoprocessing History

Included

Included

Geoprocessing history is copied as well as all resources (models, scripts, data, layers, and files) needed to rerun tools.

To exclude all geoprocessing history from the package, uncheck the Include History Items option.

Data Connections

Consolidate local data and remove connections from the Catalog pane.

Maintain UNC path connections.

Maintain enterprise geodatabase connections.

Copy the project default.gdb.

Consolidate local data, UNC path, and enterprise geodatabase data.

Remove all connections from the Catalog pane.

Copy the project default.gdb.

Attachments

Consolidate local attachments.

Reference UNC path attachments.

Consolidate local attachments.

Consolidate UNC path attachments.

When a project package is extracted, attachments are stored in <extracted location>\commondata\userdata. For more information about where projects are extracted, see Open a project.

Styles

Consolidate local styles.

Reference UNC path styles.

Consolidate local styles.

Consolidate UNC path styles.

Tasks

Included

Included

Locators

Consolidate local data, reference UNC path and enterprise geodatabase data.

Consolidate local data, UNC path, and enterprise geodatabase data.

Folder connections

Included

Removed

Items in the connection are not copied.

Server connections

Included

Removed

Items in the connection are not copied.

Database connections

Included

Removed

Items in the connection are not copied.

Workflow connections

Included

Removed

Items in the connection are not copied.

Data Reviewer connections

Consolidate local data, reference UNC path and enterprise geodatabase data.

Consolidate local data, UNC path, and enterprise geodatabase data.

All result sessions are included.

Data Reviewer batch jobs

Included

Included

  1. On the ribbon, click the Share tab. In the Package group, click Project Package Project Package.

    The Package Project pane appears.

  2. Specify where to save your package, either to your online account or as a file on disk.
  3. Provide the name and, if saving the package to a file, the location for your new package on disk.
  4. Optionally, complete the Summary and Tags fields.

    A summary and tags are required when sharing to an ArcGIS Enterprise 10.9 or earlier portal.

    You can enter a maximum of 128 tags.

  5. Optionally, check the Share outside of organization option to include data from an enterprise database or UNC path location, include styles, and remove connections to folders, servers, and databases.
  6. Optionally, check the Include Toolboxes option to include all project toolboxes and the data referenced by their tools.

    If this option is not checked, project toolboxes, except the default toolbox, are not included. Toolboxes in connected folders are not considered project toolboxes and are not impacted by this setting.

  7. Optionally, check the Include History Items option to include all geoprocessing history items and the data required to rerun the history item.

    If this option is not checked, none of the project's geoprocessing history items are included. If history items are included, ensure that all data required to rerun the tool still exists and is accessible. If it's not, packaging will not be successful.

  8. If you are uploading your package to an online account, use the Folder menu to specify where the package will be stored in your portal content. The package is stored in the root of your content by default. Optionally, click the Browse button Browse to create a folder or choose an existing one. You can also type the name of the desired folder in the text box.
  9. If you're uploading your package to an online account, specify how it will be shared:
    • Everyone—Share your content with the public. Anyone can access and see it.
    • My Organization—Share your content with all authenticated users in the organization. This option is available when you are signed in with an organizational account.
    • Groups—Share your content with groups to which you belong and their members.

    Leave all options unchecked to set the sharing level to the owner of the item.

  10. Add the items you want to include to Attachments. This option allows you to include other content, such as detailed documentation, reports, and graphs. The following types of files cannot be included: .js, .vbs, .py, .pyc, .pyo, .bat, and .ocx. Also, only signed .dll and .exe files are allowed.
  11. Under Finish Sharing, click Analyze Analyze to review for potential problems.

    Errors and warnings are listed on the Messages tab. Right-click a message to open its help topic or take corrective action in the software. Errors Error must be resolved before you can share your GIS resource. Resolving warnings Warning is recommended but not required.

    Learn more about analyzing GIS resources

  12. Once the package is validated, click Package to create your package.

See Open a project to learn how to unpack your project package.

Geoprocessing considerations

A project package includes any tool (model or script) contained in a toolbox that has been added to the project. The tools and any data required to run them are included in the project package. This is similar to tools in the project geoprocessing history; any tool that has been run is packaged, including any data required to rerun the tool. A common practice when building script tools is to build paths to datasets using a relative path from the toolbox location. With a project, you can reference data based on the .aprx project file location, rather than the toolbox location. Consolidating and packaging a project moves items relative to the .aprx file. Use the following approach to build paths to datasets:

import os
prjLocation = arcpy.mp.ArcGISProject("CURRENT").homeFolder
oilwells = os.path.join(prjLocation, "data\\oil.gdb\\wells")
print (oilwells)
# 'C:\\MyProjects\\OilExploration\\SouthWestWells.aprx\\data\\oil.gdb\\wells'

Related topics