Check Out File

Resumen

Checks out a file from a Product Library.

Una biblioteca del producto almacena la información y los datos necesarios para la producción de datos cartográficos y digitales en una geodatabase. Esri Mapping and Charting solutions almacenan información espacial, documentos y reglas comerciales en una biblioteca del producto.

You must check out a file to edit it.

Uso

• Check out locks a file. A file can only be checked out by one person.

• El Espacio de trabajo de la Biblioteca de productos debe ser una geodatabase.

• La Ruta del archivo de la biblioteca de productos es la ruta que lleva al nodo de árbol concreto de la biblioteca del producto. Una ruta de biblioteca del producto es una cadena delimitada por dos puntos dobles (::) en este formato: Nombre de la solución::Nombre de la clase de producto::Nombre de la serie::Nombre del producto::Nombre de la instancia::Nombre de AOI::Nombre del archivo.

• Para determinar la ruta de la biblioteca de productos, desplácese hasta un elemento de la ventana Biblioteca de productos, haga clic en el mismo con el botón secundario y, a continuación, haga clic en Copiar como ruta. ruta de la biblioteca de productos debe encontrarse en el Portapapeles. Podrá pegarla en cualquier parámetro que requiera una ruta de la biblioteca de productos.

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

• This tool returns a path as a string to the checked out file. If you are going to check out a file or personal geodatabase (an instance database) by executing tools in ModelBuilder, use the Check Out File As File tool instead of this tool. Check Out File As File returns a file while this tool returns a string.

• If you use this tool in ModelBuilder, insert the Calculate Value tool to convert the returned string to another data type. For example, given a model that checks out an instance database, executes Upgrade Production Database, then checks the instance database back into a product library, you need to connect Check Out File to Calculate Value through a precondition. Calculate Value can convert the string returned by Check Out File to a workspace. The model would look similar to the following image:

  

  The expression r"%Path to checked out file%" is the output data variable of Check Out File. Calculate Value converts this string into the data type listed in the Data type field. The dashed line connecting the output data variable to Calculate Value indicates that Path to checked out file is a precondition in Calculate Value. You can then connect the Calculate Value output data variable (workspace) to the Upgrade Production Database tool.

Sintaxis

PLCheckoutFile(product_library_workspace, product_library_itempath, checkout_location, {overwrite_flag}, {product_library_ownername})

Parámetro	Explicación	Tipo de datos
product_library_workspace	Ruta al espacio de trabajo de biblioteca del producto.	Workspace
product_library_itempath	La ruta de la biblioteca del producto al artículo. Se especifica como Nombre de la solución::Nombre de la clase de producto::Nombre de la serie::Nombre del producto::Nombre de la instancia::Nombre de AOI::Nombre del archivo.	String
checkout_location	The folder that will contain the checked out file.	Folder
overwrite_flag (Opcional)	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
product_library_ownername (Opcional)	Nombre del propietario del esquema de biblioteca de productos. Configure este parámetro si la cuenta de usuario especificada en el product_library_workspace no es el propietario del esquema. Esto es aplicable solamente a bibliotecas de productos almacenadas en geodatabases corporativas.	String

Muestra de código

PLCheckoutFile example (stand-alone script)

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")

PLCheckoutFile example 2 (Python window)

The following Python window script checks out a database .mdf and attaches it to an instance of SQLExpress.

import arcpy, os

# variables for PLCheckOutFile params
productLibrary="c:\\data\\ProductLibrary.gdb"
plPath="Products::Topographic Maps::QA_QC_carto.mdf"
checkOutFolder="c:\\data"

# variable for AttachDatabase tool
sqlExpress="YOUR_SERVER_NAME\\SQLEXPRESS"

# exec PLCheckOutFile
result=arcpy.PLCheckoutFile_production(productLibrary, plPath, checkOutFolder)

# result[0] contains the path to the checked out file
mdf=result[0]
if os.path.exists(mdf):
    print mdf

    # use mdf in Attach Database
    result=arcpy.AttachDatabase_production(sqlExpress,mdf)

    # print out the database name
    print result[0]
    print "Script completed successfully"

Entornos

• Espacio de trabajo actual

Información sobre licencias

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