Package Result (Data Management)

License Level:BasicStandardAdvanced

Summary

Packages one or more geoprocessing results, including all tools and input and output datasets, into a single compressed file (.gpk).

Usage

Syntax

PackageResult_management (in_result, output_file, {convert_data}, {convert_arcsde_data}, {extent}, {apply_extent_to_arcsde}, {schema_only}, {arcgisruntime}, {additional_files}, {summary}, {tags})
ParameterExplanationData Type
in_result

The result that will be packaged.

The input can be either a result added by dragging and dropping directly from the Results window or by browsing to a result file (.rlt).

File; String
output_file

The name and location of the output package file (.gpk).

File
convert_data
(Optional)

Specifies whether input layers will be converted into a file geodatabase or preserve their original format.

  • CONVERT Data will be converted to a file geodatabase.
    NoteNote:

    This parameter does not apply to enterprise geodatabase data sources. To convert enterprise geodatabase data, set convert_arcsde_data to CONVERT_ARCSDE.

  • PRESERVEData formats will be preserved when possible. This is the default.
    NoteNote:

    The exception to this rule are formats that are not supported in a 64x environment (personal geodatabase (.mdb) data, VPF data, and tables based on Excel spreadsheets or OLEDB connections) and raster formats that ArcGIS cannot write out natively (ADRG, CADRG/ECRG, CIB, and RPF).

Boolean
convert_arcsde_data
(Optional)

Specifies whether input enterprise geodatabase layers will be converted into a file geodatabase or preserve their original format.

  • CONVERT_ARCSDE Enterprise geodatabase data will be converted to a file geodatabase and included in the consolidated folder or package. This is the default.
  • PRESERVE_ARCSDE Enterprise geodatabase data will be preserved and will be referenced in the consolidated folder or package.
Boolean
extent
(Optional)

Specify the extent by manually entering the coordinates in the extent parameter using the format X-Min Y-Min X-Max Y-Max. To use the extent of a specific layer, specify the layer name.

  • MAXOFUnion of inputs
  • MINOFIntersection of inputs
  • DISPLAYSame extent as current display
  • <Layer>Same extent as specified layer
Extent
apply_extent_to_arcsde
(Optional)

Determines whether specified extent will be applied to all layers or only to enterprise geodatabase layers.

  • ALL Specified extent is applied to all layers. This is the default.
  • ARCSDE_ONLYSpecified extent is applied to enterprise geodatabase layers only.
Boolean
schema_only
(Optional)

Specifies whether only the schema of input and output datasets will be consolidated or packaged.

  • ALL All records for input and output datasets will be consolidated or packaged. This is the default.
  • SCHEMA_ONLY Only the schema of input and output datasets will be consolidated or packaged.
Boolean
arcgisruntime
(Optional)

Specifies whether the package will support ArcGIS Runtime. To support ArcGIS Runtime, all data sources will be converted to a file geodatabase and a .msd will be created in the package.

  • DESKTOPOutput package will not support ArcGIS Runtime.
  • RUNTIME Output package will support ArcGIS Runtime.
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

Code Sample

PackageResult example 1 (Python window)

The following Python script demonstrates how to use the PackageResult tool from within the Python window:

import arcpy
arcpy.env.workspace = "C:/ResultFiles" 
arcpy.PackageResult_management('Parcel.rlt', 'Parcel.gpk', "PRESERVE", "CONVERT_ARCSDE", "#", "ALL", "ALL", "DESKTOP", r"C:\docs\readme.txt", "Summary text", "Tag1; tag2; tag3")
PackageResult example 2 (stand-alone Python script)

Finds and creates individual geoprocessing packages for all the result files that reside in a specified folder.

# Name: PackageResultEx1.py
# Description:  Find all the result files that reside in a specified folder and create a geoprocessing package for each result file.

# import system modules
import os
import arcpy

from arcpy import env

# Set environment settings
env.overwriteOutput = True
env.workspace = "C:/ResultFiles" 

# Loop through the workspace, find all the result files (.rlt) and create a geoprocessing package using the same name as the original result file.
for rlt in arcpy.ListFiles("*.rlt"):
    print "Packaging " + rlt
    arcpy.PackageResult_management(rlt, os.path.splitext(lyr)[0] + '.gpk', "PRESERVE", "CONVERT_ARCSDE", "#", "ALL", "ALL", "DESKTOP", r"C:\docs\readme.txt", "Summary text", "Tag1; tag2; tag3")
PackageResult example 3 (stand-alone Python script)

Finds and creates a single geoprocessing package for all the result files that reside in a specified folder.

# Name: PackageResultEx2.py
# Description:  Find all the result files that reside in a specified folder and create a single geoprocessing package.

# import system modules
import os
import arcpy

from arcpy import env

# Set environment settings
env.overwriteOutput = True
env.workspace = "C:/ResultFiles" 

# Find all the result files (.rlt) in a workspace and create a single geoprocessing package.
rlts = arcpy.ListFiles("*.rlt")
arcpy.PackageResult_management(rlts, 'all_layers.gpk', "PRESERVE", "CONVERT_ARCSDE", "#", "ALL", "ALL", "DESKTOP", r"C:\docs\readme.txt", "Summary text", "Tag1; tag2; tag3")

Environments

This tool does not use any geoprocessing environments

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Yes
ArcGIS for Desktop Standard: Yes
ArcGIS for Desktop Advanced: Yes
5/7/2015