SCRIPT TO SHARE: Export ArcGIS Pro map layers to .lyrx files

[alwunder]

In my efforts to speed up the creation of GeMS map packages, one thing that always seemed to take more time than it should was exporting layer files for the map. I typically did it manually, right-clicking each layer and saving the layer file. Well, no more! Here's a Python script that can be added to a toolbox or run from the Python window in ArcGIS Pro. I added it to the "Finalize" group of tools in my copy of the GeMS toolbox. See the script notes for more info.

In other good news, this fall ArcGIS Pro 3.2 will debut the "Save items to style" in the Share ribbon Save As section, similar to the ArcMap "Export map styles" tool. [CONFIRMED! THIS WORKS!]

UPDATE 1: Fixed a problem with annotation "sublayers" causing script to fail.
UPDATE 2: Added ability to save layer files with relative paths to data sources and added better error handling

"""
ExportLyrxFiles.py
Andrew L. Wunderlich
[email protected]
9/5/2023
Updated 12/19/2024: Now uses arcpy.SaveToLayerFile_management to add option to store relative or absolute paths to data
sources

Iterates through the current active map tab in ArcGIS Pro and exports all layers to LYRX files.
Layers in group layers are exported to a folder within the output folder using the group layer name. See notes 
regarding layer naming issues.
Works in both a data view and layout view in ArcGIS Pro.

NOTES:
Layer names in map should be simple. The script can find and deal with most illegal file name characters,
however, backslashes are a valid part of group layer names and can't easily be differentiated from 
backslashes that the user may have put in the map layer name. The following characters are explicitly 
forbidden in any Windows environment: " | % : / , . [ ] < > * ?. If the script encounters any of these 
characters, it replaces them with a dash.  Repeating illegal characters are replaced by a single dash 
regardless of the original character: e.g., <<<layer>>> or <?/layer/?> would both become -layer-.
###
When naming layers in the map, spaces and underscores are also discouraged, as well as # pound, & ampersand, 
{ left curly bracket, } right curly bracket, $ dollar sign, ! exclamation point, ' single quotes, @ at sign, 
+ plus sign, ` backtick, and = equal sign.  While not all these characters will cause an error, some 
certainly will and others may produce unexpected or undesirable results.

When adding to a toolbox:
GENERAL:
Name: ExportMapLayersToLyrx
Label: Export map layers to .lyrx
Description: Iterates through the current active map tab in ArcGIS Pro and exports all layers to LYRX files.
             Layers within groups are exported to a folder with the group layer name within the output folder.
             Choose whether LYRX file will store relative or absolute paths to data sources.
             Works in both a data view and layout view in ArcGIS Pro. See notes in code regarding layer naming issues.
SOURCE:
Script File: point to this file
PARAMETERS:
"Output folder" as a Folder
"Save relative paths" as a Boolean; Default value "false"
"""

import arcpy, os, re, sys
import GeMS_utilityFunctions as guf

try:
    # This code can be run directly in the Python code window in ArcGIS Pro if an outFolder is specified
    # Set the output folder. Use sys.argv[1] if used through the toolbox.
    #outFolder = r"C:\temp\LAYERS\LYRX"
    outFolder = sys.argv[1]

    # Set the option to store relative paths
    if sys.argv[2] == "true":
        saveRelative = True
        guf.addMsgAndPrint("Layer files will be stored with relative paths...")
    else:
        saveRelative = False
        guf.addMsgAndPrint("Layer files will be stored with absolute paths...")

    # Get the current ArcGIS Pro project file
    aprx = arcpy.mp.ArcGISProject('CURRENT')

    # Set the map to look for layers to export
    aprxMap = aprx.activeMap

    # Define list of illegal characters for file names in Windows:
    # Can't include the backslash here, it messes up the group layer paths
    illChars = "\"|%:/,.[]<>*?"

    # Iterate through the layers and export them to lyrx files
    for lyr in aprxMap.listLayers():
        # Check if link is broken
        if not lyr.isBroken:
            # Check if layer is a group layer (don't make a lyrx file; will become folder)
            if not lyr.isGroupLayer:
                # Check to make sure the layer is compatible with being saved as a lyrx file
                if lyr.supports("CONNECTIONPROPERTIES"):
                    # Set the lyrx base name (as seen in the TOC; not the FULL name, i.e., lyr.longName)
                    lyrxName = str(lyr.name)
                    #guf.addMsgAndPrint("layer name: " + lyrxName)
                    # Split the full name str(lyr) using the layer base name to get the path
                    grpPath = str(lyr).split(lyrxName)[-2:]
                    #guf.addMsgAndPrint("group path: " + str(grpPath[0]))
                    # Check for characters in the layer name that would cause an OSError
                    for c in illChars:
                        lyrxName = lyrxName.replace(c,"-")
                    # Get rid of a backslash in the layer file name here
                    lyrxName = lyrxName.replace("\\","-")
                    # Replace consecutive dashes with a single dash
                    lyrxName = re.sub(r"--+", "-", lyrxName)
                    # Create the group path name if layer is nested in a group layer (will be blank if not)
                    lyrxPath = str(grpPath[0])
                    # Check for characters in the group name that would cause an OSError
                    # Backslashes in the group layer name WILL create nested folders. NO GOOD BUT HARD TO FIX.
                    for c in illChars:
                        lyrxPath = lyrxPath.replace(c,"-")
                    # Replace consecutive dashes with a single dash
                    lyrxPath = re.sub(r"--+", "-", lyrxPath)
                    # Concatenate the complete path here
                    lyrxPath = os.path.join(outFolder, lyrxPath)
                    # Create the output path (folder) if it doesn't already exist
                    if not os.path.exists(lyrxPath):
                        os.makedirs(lyrxPath)
                    # Set the lyrx file name
                    lyrxFile = os.path.join(outFolder, lyrxPath, lyrxName + ".lyrx")
                    # Save the lyrx file with option to store relative paths
                    if not saveRelative:
                        arcpy.SaveToLayerFile_management(lyr, lyrxFile, "ABSOLUTE")
                        guf.addMsgAndPrint("Saved: " + lyrxFile)
                    else:
                        arcpy.SaveToLayerFile_management(lyr, lyrxFile, "RELATIVE")
                        guf.addMsgAndPrint("Saved: " + lyrxFile)
                # Comment out else statement to clean up tool output
                #else:
                    # Layer isn't exportable as a lyrx file (annotation groups, wms sublayers, etc.)
                    #guf.addMsgAndPrint(str(lyr.longName) + " is not exportable as a lyrx file")
        else:
            # Layer has a broken link, do nothing. Although it probably doesn't matter...
            guf.addMsgAndPrint("Layer " + lyr.name + " has a broken link and will not be saved...")

except:
    guf.addMsgAndPrint("An error has occurred: " + arcpy.GetMessages())

[saberak943]

Thanks for sharing!

This tool map help with creating the .lyrx files and deal with the illegal file name characters.

Out of curiosity, does the geoprocessing tool "Save To Layer File" under Data Management not provide similar functionality?
It has batch functionality too.
https://pro.arcgis.com/en/pro-app/3.3/tool-reference/data-management/save-to-layer-file.htm

For the record, I have not used either method (your code, or Save To Layer File) for submittals yet.
Is your experience that the "Save To Layer File" does not provide adequate results for GeMS submittals?

Love to hear your thoughts!

-Ry

[alwunder]

I'll address your question by comparing this script to the batch version of the Save to Layer File tool. Yes, the functionality is basically the same, however there are a couple of distinct differences:

• The batch command is slower to execute than the scripted version and does not provide meaningful output to the message window. You also have to set parameters to run the batch tool; this script assumes all valid layers in the active map are to be processed.
• The batch command saves grouped items in the TOC as a group layer file and then all the individual layers as layer files. This script opts to save the individual layers within the group and organize them in folders named for the group layer (my preference).
• The batch command can save layer files for tables. This script skips tables (I didn't see any value in saving tables to layer files, but the code could be modified to do so)
• The Save to Layer File tool is also more restrictive of the characters that can be passed to the output file names. This script only replaces the characters explicitly forbidden to be used in file names in a Windows environment: " | % : / , . [ ] < > * ?. For example, the Save to Layer File tool replaces parentheses even though they are not forbidden characters.

As far as whether the batch Save to Layer File is adequate for a GeMS submittal, yes, it's fine. This tool simply streamlines the process and produces results that I find better organized and more intuitive and it makes my workflow easier. Test it out, see what you think.