ArcMap

List Items

Summary

Returns a list of child items that are associated with a node in the Product Library tree.

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 inside a product library.

Usage

  • The Product Library Workspace must be a geodatabase. If it is an enterprise geodatabase, use a path to an SDE connection file.

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

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

Syntax

arcpy.production.PLListItems(product_library_workspace, product_library_itempath, {product_library_ownername})
ParameterExplanationData Type
product_library_workspace

Path to the product library workspace.

Workspace
product_library_itempath

The path to the product library level that contains the files you want to view. This is specified as Solution Name::Product Class Name::Series Name::Product Name::Instance Name::AOI Name.

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

PLListItems example (stand-alone script)

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

# Name: PLListItems_Example.py
# Description: List the items associated with a Series in a Product Library
# Requirements: Production Mapping extension

# import arcpy and checkout a Production Mapping license
import arcpy
arcpy.CheckOutExtension("foundation")

#Set local variables
production_database_workspace = "C:\\Data\\ProductLibrary.gdb"
product_library_itempath = "Products::Topographic Maps::Texas::Travis County"

# List items in this item path
result = arcpy.PLListItems_production(production_database_workspace, product_library_itempath)
item_list = result.getOutput(0).split(";")

# print out the items in this list
for i in item_list:
	print i

# print out the messages from PLListItems
print result.getMessages()

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