ArcMap

Check Out File As File

Summary

Checks out a file from a Product Library. This tool is similar to the Production Mapping Check Out File geoprocessing tool but returns a file instead of a string. Use this tool in ModelBuilder to chain the output file to another tool as an input parameter.

For example, in ModelBuilder, you can use this tool to check out an instance database .mdf file from a Product Library. The checked out .mdf file can be used as the MDF File Path input parameter in the Attach Database tool.

Usage

  • Checkout 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 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.

  • 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.

  • Checkout creates a local copy of the file in the location indicated by Check Out Path. Check Out Path must be a folder.

Syntax

PLCheckOutFileAsFile(Product_Library_Workspace, Product_Library_Path, Check_Out_Path, {Overwrite_Existing_File}, {Workspace_Owner_Name})
ParameterExplanationData Type
Product_Library_Workspace

Path to the product library workspace.

Workspace
Product_Library_Path

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
Check_Out_Path

The folder that will contain the checked out file.

Folder
Overwrite_Existing_File
(Optional)

Indicates whether the checkout process overwrites a local copy of the file if it exists.

  • DO_NOT_OVERWRITE —Do not overwrite an existing local copy of the file. This is the default.
  • OVERWRITE —Overwrite an existing local copy of the file.
Boolean
Workspace_Owner_Name
(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

PLCheckOutFileAsFile example (stand–alone script)

The following example demonstrates how to use the PLCheckOutFileAsFile tool.

# 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
result = arcpy.PLCheckOutFileAsFile_production(product_library_workspace, product_library_itempath, checkout_location, overwrite_flag)

print result
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