ArcMap

Check In File

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. ArcGIS Defense Mapping, ArcGIS Production Mapping, ArcGIS Maritime, ArcGIS Bathymetry, and ArcGIS Aviation store business rules, documents, and spatial information in 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 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::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.

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

  • If the Keep this file checked out parameter is checked (keep_checked out = "KEEP_CHECKEDOUT" in Python), the Keep local copy parameter (keep_localcopy in Python) is overwritten and a local copy of the checked out file will remain on disk.

Syntax

arcpy.production.PLCheckinFile(product_library_workspace, product_library_itempath, overwrite_version, keep_checkedout, keep_localcopy, {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
overwrite_version

Specifies whether the current version of the file in the product library will be overwritten.

  • DO_NOT_OVERWRITE_VERSION —The current version of the file will not be overwritten and a new version will be saved to the product library with an incremental version number. This is the default.
  • OVERWRITE_VERSION —The current version of the file in the product library will be overwritten without an incremental version number.
Boolean
keep_checkedout

Specifies whether the file will remain checked out after checking in changes to the product library.

  • DO_NOT_KEEP_CHECKEDOUT —The file will not remain checked out and will be saved to the product library marked as checked in. This is the default.
  • KEEP_CHECKEDOUT — The file will remain checked out after it has been saved to the product library.
Boolean
keep_localcopy

Specifies whether a local copy of the file will be kept on disk.

  • REMOVE_LOCAL_COPY —A local copy of the file will not be kept on disk. This is the default.
  • KEEP_LOCAL_COPY —A local copy of the file will be kept on disk.
Boolean
checkin_comments
(Optional)

The comments associated 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

Licensing information

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

Related topics