ArcMap

Add File

Summary

Adds a file to a Product Library. This associates the file with a Product Library entry. Once you have added a file to a product library, use Check Out File and Check In File to manage changes made to it.

A product library stores information and data required for cartographic and digital data production in a geodatabase. Esri Mapping and Charting solutions store business rules, documents, and spatial information inside a product library.

Usage

  • The Product Library Workspace must be a geodatabase.

  • The Product Library File Path is the path to the particular Product Library tree node. A product library path is a double colon-delimited string (::) in this format: Solution Name::Product Class Name::Series Name::Product Name::Instance Name::AOI Name.

  • To determine a product library path, browse to an item in the Product Library window, right-click it, and click Copy As Path. The product library path will be placed on the clipboard. You can paste it into any parameter that requires a product library path.

  • This tool will not overwrite existing files in Product Library File Path. The tool will return ERROR 90102: File already exists if it finds an existing file with the same name as the file to add in Product Library File Path.

Syntax

PLAddFile(product_library_workspace, product_library_itempath, filepath, {checkin_comments}, {product_library_ownername})
ParameterExplanationData Type
product_library_workspace

Path to the product library workspace.

Workspace
product_library_itempath

The product library path to the item. This is specified as Solution Name::Product Class Name::Series Name::Product Name::Instance Name::AOI Name::File Name.

String
filepath

Path to the file that is going to be added to the product library.

File
checkin_comments
(Optional)

Comments to associate with the check–in.

String
product_library_ownername
(Optional)

Product library schema owner name. Set this parameter if the user account specified in product_library_workspace is not the schema owner. This applies only to product libraries stored in enterprise geodatabases.

String

Code sample

PLAddFile example (Python window)

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

# Name: PLAddFile_Example.py
# Description: Adds a file to a Product Library
# Requirements: Production Mapping extension

# import arcpy and checkout a Production Mapping license
import arcpy
arcpy.CheckOutExtension("foundation")

# Product library and item path variables
product_library_workspace = "C:\\Data\\ProductLibrary.gdb"
product_library_itempath = "Products::NewSolution::NewClass::NewSeries"

# path to an existing file
file_path = "c:\\data\\script.py"

# execute the Add File tool
try:
    res = arcpy.PLAddFile_production(product_library_workspace, product_library_itempath,file_path)
    print res.getMessages()

except Exception, e:
    print e.message
	
print "Script completed successfully."

Environments

Licensing information

  • ArcGIS Desktop Basic: No
  • ArcGIS Desktop Standard: Requires Production Mapping
  • ArcGIS Desktop Advanced: Requires Production Mapping

Related topics