Winter 2015

Create a Python Tool That Summarizes ArcMap Layer Properties

By Colin Lindeman, Pacific Disaster Center

This article as a PDF.


What You Will Need

Create a toolbox for the Python script.

Create a toolbox for the Python script.

Fill out the parameters for the script tool.

Fill out the parameters for the script tool.

On the Parameters tab of the Add Script dialog box, select mxd_directory and fill out the Parameter Properties grid as shown in Table 2.

On the Parameters tab of the Add Script dialog box, select mxd_directory and fill out the Parameter Properties grid as shown in Table 2.

This article shows how to create Python script that runs as a tool in ArcToolbox. This tool automatically batch processes ArcMap documents, gathers information about the layers in those documents, and outputs that information as a comma-separated values (CSV) file that can be viewed as a table in Microsoft Excel or another program that can open CSV files.

To work this exercise, you should be familiar with authoring Python scripts that use the ArcPy module, using ArcGIS for Desktop (especially ArcToolbox), and know how to add tools from a script file. This exercise uses several Python packages: ArcPy (the ArcGIS site package), os (miscellaneous operating system interfaces), fnmatch (UNIX file name pattern matching), and csv (CSV file reading and writing).

The Challenge

The goal of this exercise is to create a tool that automatically inventories the map layers in a single ArcMap document or several ArcMap documents contained in a folder and generates a CSV file listing the properties of those layers.

The Goal

To accomplish the challenge, you will develop a Python script that is run as a Python toolbox in ArcMap or ArcCatalog. This script will have user inputs for a directory or an individual ArcMap document (MXD) to parse and generate output as a CSV file. The CSV file can be opened in Microsoft Excel or another program that can read CSV files and be viewed as a table. By creating this tool in a Python toolbox, any ArcGIS user can use ArcPy functionality without knowing Python.

The Solution

Although this example will work with one ArcMap document, the Python script will be able to process all ArcMap documents in a directory and any subdirectories it contains.

Create a new Python script using a Python editor or by simply creating a new text file (.txt) and changing the file extension to .py. [Note: If file extensions are not displayed in Windows, uncheck the Hide extensions for known file types in Folder Options located on Control Panel in the Windows operating system.]

There are a variety of methods for developing this script. Listing 1 provides one example. It imports modules, defines the ArcMap documents that will be processed, defines their paths, parses the documents, and writes the information to a user-defined CSV file.

(This first section imports the modules.)

#Import modules...
import arcpy, os, fnmatch, csv

(The next section defines the user input variables.)

#User input variables...
mxddirectory = arcpy.GetParameterAsText(0)
mxd_single = arcpy.GetParameterAsText(1)
outputcsvlocation = arcpy.GetParameterAsText(2)

(This section defines the ArcMap documents to parse.)

#Create an empty list of ArcMap documents to process...
mxd_list=[]
#If a user defined a single mxd, add its path to the list...
if len(mxd_single) > 0:
  mxd_list.append(mxd_single)
#Otherwise walk through the input directory, adding paths for
each .mxd file found to the list...
else:
  for dirpath in os.walk(mxddirectory): #os.walk returns \
    (dirpath, dirnames, filenames)
    for filename in dirpath[2]:
      if fnmatch.fnmatch(filename, "*.mxd"):
        mxd_list.append(os.path.join(dirpath[0], filename))

(This section parses the documents and writes the information to a user-defined CSV file.)

#Iterate the list of mxd paths and gather property values then
write to csv file...
if len(mxd_list) > 0:
  #Create the csv file...
  outputcsv = open(outputcsvlocation,"wb")
  writer = csv.writer(outputcsv, dialect = 'excel')
  #Write a header row to the csv file...
  writer.writerow(["mxdpath", "layername", "layerdescription", "layersource"])
  #Iterate through the list of ArcMap Documents...
  for mxdpath in mxd_list:
    mxdname = os.path.split(mxdpath)[1]
    try:
      mxd = arcpy.mapping.MapDocument(mxdpath)
      #Iterate through the ArcMap Document layers...
      for layer in arcpy.mapping.ListLayers(mxd):
        layerattributes = [mxdpath, layer.longName, \
        layer.description, layer.dataSource]
        #Write the attributes to the csv file...
        writer.writerow(layerattributes)
    except:
      arcpy.AddMessage("EXCEPTION: {0}".format(mxdpath))
    del mxd
  #close the csv file to save it...
  outputcsv.close()
#If no ArcMap Documents are in the list, then notify via an
error message...
else:
  arcpy.AddError("No ArcMap Documents found. Please check your input \
    variables.")
Listing 1
On the Parameters tab of the Add Script dialog box, select mxd_single and fill out the same Parameter Properties in the grid as in the previous step as shown in Table 2.

On the Parameters tab of the Add Script dialog box, select mxd_single and fill out the same Parameter Properties in the grid as in the previous step as shown in Table 2.

Adding the Script to a Toolbox

Open ArcMap, then open Catalog. In Catalog, navigate to the folder where you want to keep the new toolbox for the script and right-click it. Choose New > Toolbox. Rename the toolbox.

Right-click New toolbox and choose Add > Script. In the Add Script dialog box, enter name (ArcMapDocumentPropertiesToCSV), label (ArcMapDocumentPropertiesToCSV), and description (Parses through one or many ArcMap documents and collects property values into a CSV file) for the script. Check the box next to Enable the Store relative path names to eliminate the need to update the toolbox on the script's source path. Click Next.

Use the Browse button to select the script file. Leave Show command window when executing script box unchecked because the script itself includes the ability to display messages in the Geoprocessing window. Check Run Python script in process to allow it to run faster.

In the next pane, add the user input variables.

In the upper grid, fill in the values in Table 1.

On the Parameters tab of the Add Script dialog box, select output_cvs_location and fill out the Parameter Properties in the grid as shown in Table 3.

On the Parameters tab of the Add Script dialog box, select output_cvs_location and fill out the Parameter Properties in the grid as shown in Table 3.

Display Name Data Type
mxd_directory Folder
mxd_single ArcMap Document
output_csv_location File
Table 1: Inputs for upper grid

Property Value
Type Optional
Direction Input
MultiValue No
Filter None
Table 2: Select mxd_directory and add these parameter properties. Select mxd_single and add the same parameters.

Property Value
Type Required
Direction Output
MultiValue No
Filter File
Table 3: Select output_csv_location and add these parameters.

The CSV file generated by the tool lists map layers and can be viewed in Microsoft Excel.

The CSV file generated by the tool lists map layers and can be viewed in Microsoft Excel.

Running the Tool

Double-click the script tool to invoke it. In the dialog box, click the first Browse button to select a folder directory (mxd_directory) or the second Browse button to select a single ArcMap document.

If parameters are entered for both, the single ArcMap document will be parsed and not the ArcMap documents in the folder directory specified. If no input is given, then an error will occur. Select an output file and directory. It is best to use the wizard for each user input variable.

This script can be expanded to include reading other properties for the MXD and its layers. It can also be used to set the values for certain properties. For example, dates, URLs, and organization names could be updated.

Summary and Conclusion

Python's csv module and ArcPy have made it an easier task to gather information about ArcMap documents and the layers they contain and summarize that information in a format that can be viewed as a standard spreadsheet. Authoring the Python script so it can be used as a script in an Esri toolbox means processing can be used repeatedly by others who may not know how to code in Python or ArcPy.

For more information, contact Colin Lindeman.

About the Author

Colin Lindeman is a senior geospatial data systems analyst at the Pacific Disaster Center. Lindeman has been developing Python scripts for a variety of uses from geoprocessing tasks for use in ArcGIS for Server to batch processing and data conditioning.

Contact Us | Privacy | Legal | Site Map