Check In File (Production Mapping)

Summary

Checks a file back in to 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 check out files from a Product Library using the Product Library Check Out File tool.

Checking in the file allows you to increment the file's minor version number or overwrite it.

Usage

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

• The path of the file to check in must match the path saved in the Product Library as the checked out location for that file.

• When checking in an instance geodatabase, you must overwrite the current version.

• The KEEP_CHECKEDOUT option of the Keep this file checked out parameter overwrites the Keep local copy parameter. If you choose KEEP_CHECKEDOUT, a local copy of the checked out file will remain on disk.

Syntax

PLCheckinFile_production (product_library_workspace, product_library_itempath, overwrite_version, keep_checkedout, keep_localcopy, {checkin_comments}, {product_library_ownername})

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
overwrite_version	Indicates if the tool will overwrite the current version of the file in the Product Library. DO_NOT_OVERWRITE_VERSION —Saves a new version of the file to the Product Library and increments the version number. This is the default. OVERWRITE_VERSION —Overwrites the current version of the file within the Product Library and doesn't increment the version number.	Boolean
keep_checkedout	Indicates if the tool will keep the file checked out after checking in changes to the Product Library. DO_NOT_KEEP_CHECKEDOUT — Saves the file to the Product Library and marks the file as checked in. This is the default. KEEP_CHECKEDOUT — Saves the file to the Product Library, but keeps the file marked as checked out.	Boolean
keep_localcopy	Indicates if the tool will leave a local copy of the file on disk. REMOVE_LOCAL_COPY —Removes the local copy of the file from disk. This is the default. KEEP_LOCAL_COPY —Keeps a local copy of the file on disk.	Boolean
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

PLCheckinFile example (stand-alone script)

The following stand-alone script demonstrates how to use the PLCheckinFile tool.

# Name: PLCheckinFile_Example.py
# Description: Checks in a file to 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"
overwrite_version = "DO_NOT_OVERWRITE_VERSION"
keep_checkedout = "DO_NOT_KEEP_CHECKEDOUT"
keep_localcopy = "REMOVE_LOCAL_COPY"

# create a production database
arcpy.PLCheckinFile_production(product_library_workspace, product_library_itempath, overwrite_version, keep_checkedout, keep_localcopy)

print "Script completed successfully."

# Check in the extension
arcpy.CheckInExtension("foundation")

PLCheckinFile example 2 (stand-alone script)

The following stand-alone script demonstrates how to use the PLCheckinFile tool to check in an instance geodatabase to a Product Library.

# Name: PLCheckinFile_InstancePD_Example.py
# Description: Checks in an instance geodatabase
# 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::Texas::Travis County::Buda Texas::Buda Texas::PD_1.gdb"
overwrite_version = "OVERWRITE_VERSION"
keep_checkedout = "DO_NOT_KEEP_CHECKEDOUT"
keep_localcopy = "REMOVE_LOCAL_COPY"

# create a production database
arcpy.PLCheckinFile_production(product_library_workspace, product_library_itempath, overwrite_version, keep_checkedout, keep_localcopy)

print "Script completed successfully."

# Check in the extension
arcpy.CheckInExtension("foundation")

Environments

Current Workspace

Licensing Information

ArcGIS for Desktop Basic: No

ArcGIS for Desktop Standard: Requires Production Mapping

ArcGIS for Desktop Advanced: Requires Production Mapping