Using a python toolbox for automation

TobiasPlischke

Hello there.

I'm currently trying to set up a python toolbox in order to automate the process of updating .csv-files, importing them, setting up the layers in the .gdb-file and finally colorizing the polygons.
If i paste the raw code (without the layout the toolbox needs) all methods work as desired but as soon as i fill the python toolbox with my methods and call them in the execute method, some of arcpy's methods don't seem to work properly.

The update of the .gdb-file seems to work in this toolbox, the TableToTable-conversion is the first one to fail. The table doesn't get imported into ArcGIS, which leads to problems later on when it comes to the colorization. The reason why i use arcpy.TableToTable_conversion() is because otherwise it wouldn't let me use these methods at all.

I am fairly new to ArcGIS/Arcpy and these toolboxes but i think the reason behind this could be the nonexisting access to some database/libraries..?

It just bothers me that everything works perfectly fine in the python window but doesn't work the same way when using the toolbox.

BTW: The goal is to be able to execute a single tool, pasting the code everytime should be avoided.

Let me know if you need more information and thanks in advance!

from arcgis.gis import GIS
import arcpy


class businessLogic(object):
    global gdbPath
    gdbPath = r"D:\example\test.gdb"
    global featureClass
    featureClass = r"Kreisgrenzen_2020\polygons"

    def updateGDB(self):
        arcpy.Delete_management(gdbPath)
        arcpy.CreateFileGDB_management(r"D:\example", "test.gdb")
        lyr_Kreisgrenzen = r"D:\example\Kreisgrenzen_2020.lyrx"
        arcpy.mp.LayerFile(lyr_Kreisgrenzen)
        aprx = arcpy.mp.ArcGISProject("CURRENT")
        aprxMap = aprx.listMaps("Karte")[0]
        aprxMap.addDataFromPath(lyr_Kreisgrenzen)

        arcpy.AddMessage(fr"{gdbPath}")

    def setLayers(self):
        arcpy.env.workspace = gdbPath
        arcpy.TableToTable_conversion(r"D:\example\qryexport01.csv", gdbPath,
                                      "name")
        arcpy.FeatureClassToFeatureClass_conversion(featureClass, gdbPath, "Kreisgrenzen_name")
        arcpy.CreateRelationshipClass_management("name", fr"{gdbPath}\Kreisgrenzen_name",
                                                 "joined_layer_name", "SIMPLE", "polygons", "name",
                                                 "NONE", "ONE_TO_MANY", "NONE", "ags_name", "ags", '', '')
        arcpy.AddJoin_management("Kreisgrenzen_name", "AGS", "name", "ags_name", "KEEP_ALL")
        arcpy.FeatureClassToFeatureClass_conversion(f"Kreisgrenzen_name", gdbPath, "Faelle_name")


def parameter(displayName, name, datatype, defaultValue=None, parameterType='Optional', direction='Input'):
    # create parameter with a few defaults
    param = arcpy.Parameter(
        displayName=displayName,
        name=name,
        datatype=datatype,
        parameterType=parameterType,
        direction=direction)

    # set new parameter to a default value
    param.value = defaultValue

    # return the complete parameter object
    return param


class Toolbox(object):
    def __init__(self):
        self.label = 'Toolbox'
        self.alias = ''

        # List of tool classes associated with this toolbox
        self.tools = [Tool1]


class Tool1(object):

    def __init__(self):
        self.label = 'Tool'
        self.canRunInBackground = True

        self.parameters = [
            parameter('username', 'un', 'GPString', '', 'Required'),
            parameter('password', 'pw', 'GPStringHidden', '', 'Required'),
        ]

    def execute(self, parameters, messages):
        instance = businessLogic()
        instance.updateGDB()
        instance.setLayers()
        return

 

HannesZiegler

If I'm understanding correctly, you'd like to see the intermediate and result data added to the map?

I think the issue is this: Python Window will add the results of a geoprocessing tool to the map, but when the same code is run in a tool only the output parameter(s) (if specified) is added to the map. So while your code works for Python Window, when it is run in a tool, the expectation that the intermediate data (like that produced on line 25) will be available in the map/contents is no longer valid. You'll need to define an output parameter.

Can you try this (this is not the full solution but might get you unstuck):

1) Define another parameter, make it an output parameter

param1 = arcpy.Parameter(
            name='outjoin',
            direction='Output',
            datatype='GPFeatureLayer',
            parameterType='Required'
        )

2) Collect that parameter in your execute method and pass it on to your setLayers method

outjoin = parameters[1].valueAsText

instance = businessLogic()
instance.updateGDB()
instance.setLayers(outjoin)

3) Add the new output parameter to your setLayers method and update as follows:

def setLayers(self, outjoin):
        arcpy.env.workspace = gdbPath
        arcpy.TableToTable_conversion(r"D:\example\qryexport01.csv", gdbPath,
                                      "name")
        arcpy.FeatureClassToFeatureClass_conversion(featureClass, gdbPath, "Kreisgrenzen_name")
        arcpy.CreateRelationshipClass_management("name", fr"{gdbPath}\Kreisgrenzen_name",
                                                 "joined_layer_name", "SIMPLE", "polygons", "name",
                                                 "NONE", "ONE_TO_MANY", "NONE", "ags_name", "ags", '', '')
        joined = arcpy.AddJoin_management("Kreisgrenzen_name", "AGS", "name", "ags_name", "KEEP_ALL")
        arcpy.FeatureClassToFeatureClass_conversion(joined, gdbPath, outjoin)

 

Or you could use the same approach you used in the updateGDB method to add data to your map.

table = arcpy.TableToTable_conversion(r"D:\example\qryexport01.csv", gdbPath, "name")
aprx = arcpy.mp.ArcGISProject("CURRENT")
aprxMap = aprx.listMaps()[0]
aprxMap.addDataFromPath(table)