Check Out File (Production Mapping)
Summary
Checks out a file from a Product Library.
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.
You must check out a file to edit it.
Usage
Check out locks a file. A file can only be checked out by one person.
The Product Library Workspace must be a geodatabase.
The Product Library Path to the Item 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::File Name.
Check out creates a local copy of the file in the location indicated by Checkout path. Checkout path must be a folder.
Syntax
| Parameter | Explanation | Data 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 |
checkout_location |
The folder that will contain the checked out file. | Folder |
overwrite_flag (Optional) | Indicates whether the checkout process overwrites a local copy of the file if it exists.
| Boolean |
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
The following stand-alone script demonstrates how to check out a file from a Product Library.
# Name: CheckOutFile_Example.py
# Description: Checks out a file from a Product Library
# Requirements: Production Mapping extension
# import arcpy and checkout a Production Mapping license
import arcpy
arcpy.CheckOutExtension("foundation")
#Set local variables
product_library_workspace = "C:\\Data\\ProductLibrary.gdb"
product_library_itempath = "Products::Topographic Maps::QA_QC_carto_checklist.rtf"
checkout_location = "C:\\Data"
overwrite_flag = "OVERWRITE"
# create a production database
arcpy.PLCheckoutFile_production(product_library_workspace, product_library_itempath, checkout_location, overwrite_flag)
print "Script completed successfully."
# Check in the extension
arcpy.CheckInExtension("foundation")