Python Toolbox Parameter Question

543
1
Jump to solution
10-03-2021 03:38 AM
PedroMiguelBispoRosa
New Contributor

Hello, I want to specify an input for each column of the 'field compare' parameter, so it would be 'baseFeatures' would link just to the 'Base Fields' column and 'updatedFeatures' would just link to the 'Updated Fields' column. This is basically what 'Compare Fields' do in the 'Detect Feature Changes' tool.

This is what I did. 

class Tool(object):
    def __init__(self):
        """Define the tool (tool name is the name of the class)."""
        self.label = "Compare Features"
        self.description = "Compare the features from two datasets (a base one and an updated one)" + \
                           "and returns the desired outputs."
        self.canRunInBackground = False

    def getParameterInfo(self):
        """Define parameter definitions"""
        baseFeatures = arcpy.Parameter(displayName="Input Base Features", name="base_Features", datatype="GPFeatureLayer", parameterType="Required", direction="Input")

        updatedFeatures = arcpy.Parameter(displayName="Input Updated Features", name="updated_Features", datatype="GPFeatureLayer", parameterType="Required", direction="Input")

        linearUnit = arcpy.Parameter(displayName="Search Distance", name="search_distance", datatype="GPLinearUnit", parameterType="Required", direction="Input")

        fieldCompare = arcpy.Parameter(displayName="Compare Fields", name="compareFields", datatype="GPValueTable", parameterType="Optional", direction="Input")
        paramNames = [baseFeatures.name, updatedFeatures.name]
        fieldCompare.parameterDependencies = paramNames
        fieldCompare.columns = [['Field', 'Base Fields'], ['Field', 'Updated Fields']]

        geometryOutput = arcpy.Parameter(displayName="Geometry Changes Output", name="newandnochange_Features", datatype="GPBoolean", parameterType="Optional", direction="Input")

        attributeChangeOutput = arcpy.Parameter(displayName="Attribute Changes Output", name="attributechanges_Features", datatype="GPBoolean", parameterType="Optional", direction="Input")

        delAndNewOutput = arcpy.Parameter(displayName="Deleted/New Features", name="delandnew_Features", datatype="GPBoolean", parameterType="Optional", direction="Input")

        params = [baseFeatures, updatedFeatures, linearUnit, fieldCompare, geometryOutput, attributeChangeOutput ,delAndNewOutput]

        return params

 

I thought that with parameter dependencies I could specify two names, instead it only takes into account the first name I choose in the dependencies list (if Ihave 'baseFeatures.name' first both columns will only have the baseFeatures columns / if I have 'updatedFeatures.name' first it will only have the updatedFeature columns), and I can't "link" one parameter with the desired cloumn.

Does anyone know what am I missing?

 

0 Kudos
1 Solution

Accepted Solutions
DrewFlater
Esri Contributor

You can get info about the tool properties by right clicking a tool and select Properties, then go to the Parameters page. 

 

The Detect Feature Changes tool uses a value table parameter with two string columns.

DrewFlater_1-1633723470962.png

 

Use some code like this to have two parameter for picking the base and update layers, and a value table to pick the matching fields from the two datasets

    def getParameterInfo(self):
        """Define parameter definitions"""
        p1 = arcpy.Parameter(displayName="Input Base Features", 
                             name="base_Features", 
                             datatype="GPFeatureLayer", 
                             parameterType="Required", 
                             direction="Input")
        p2 = arcpy.Parameter(displayName="Input Updated Features", 
                             name="updated_Features", 
                             datatype="GPFeatureLayer", 
                             parameterType="Required", 
                             direction="Input")
        p3 = arcpy.Parameter(displayName="Compare Fields", 
                             name="compareFields", 
                             datatype="GPValueTable", 
                             parameterType="Optional", 
                             direction="Input")
        p3.columns = [['GPString', 'Base Fields'], ['GPString', 'Updated Fields']]

        params = [p1,p2,p3]
        return params

    def isLicensed(self):
        """Set whether tool is licensed to execute."""
        return True

    def updateParameters(self, parameters):
        """Modify the values and properties of parameters before internal
        validation is performed.  This method is called whenever a parameter
        has been changed."""
        if parameters[0].valueAsText and parameters[1].valueAsText:
            desc_b = arcpy.Describe(parameters[0].value)
            desc_u = arcpy.Describe(parameters[1].value)
            parameters[2].filters[0].list = [field.name for field in desc_b.fields]
            parameters[2].filters[1].list = [field.name for field in desc_u.fields]
        return

results like this:

DrewFlater_0-1633723452299.png

 

View solution in original post

1 Reply
DrewFlater
Esri Contributor

You can get info about the tool properties by right clicking a tool and select Properties, then go to the Parameters page. 

 

The Detect Feature Changes tool uses a value table parameter with two string columns.

DrewFlater_1-1633723470962.png

 

Use some code like this to have two parameter for picking the base and update layers, and a value table to pick the matching fields from the two datasets

    def getParameterInfo(self):
        """Define parameter definitions"""
        p1 = arcpy.Parameter(displayName="Input Base Features", 
                             name="base_Features", 
                             datatype="GPFeatureLayer", 
                             parameterType="Required", 
                             direction="Input")
        p2 = arcpy.Parameter(displayName="Input Updated Features", 
                             name="updated_Features", 
                             datatype="GPFeatureLayer", 
                             parameterType="Required", 
                             direction="Input")
        p3 = arcpy.Parameter(displayName="Compare Fields", 
                             name="compareFields", 
                             datatype="GPValueTable", 
                             parameterType="Optional", 
                             direction="Input")
        p3.columns = [['GPString', 'Base Fields'], ['GPString', 'Updated Fields']]

        params = [p1,p2,p3]
        return params

    def isLicensed(self):
        """Set whether tool is licensed to execute."""
        return True

    def updateParameters(self, parameters):
        """Modify the values and properties of parameters before internal
        validation is performed.  This method is called whenever a parameter
        has been changed."""
        if parameters[0].valueAsText and parameters[1].valueAsText:
            desc_b = arcpy.Describe(parameters[0].value)
            desc_u = arcpy.Describe(parameters[1].value)
            parameters[2].filters[0].list = [field.name for field in desc_b.fields]
            parameters[2].filters[1].list = [field.name for field in desc_u.fields]
        return

results like this:

DrewFlater_0-1633723452299.png