topic Re: Pulling information from a table into a parameter in a script tool in Python Questions

Pulling information from a table into a parameter in a script tool

VishalShah2 — Thu, 26 Jul 2018 16:12:41 GMT

Hello,

I am working on putting together a custom tool that helps populate information into four fields within each feature class in the database. The script is pretty straight forward and has no issues. My issue is I have to create 22 tools to do the same thing by each feature class and creating a value list in the parameters section of the script tool would be too cumbersome. Is it possible to have one table that can be automatically pulled right into a drop-down and the only thing I'd have to do is update that table whenever it needs to be updated?

Re: Pulling information from a table into a parameter in a script tool

DanPatterson_Retired — Thu, 26 Jul 2018 22:41:49 GMT

Are you referring to using a "value list" for selection? or is it more complicated than that?

Perhaps you could sketchup an example of what you mean

Re: Pulling information from a table into a parameter in a script tool

RandyBurton — Fri, 27 Jul 2018 05:08:04 GMT

I could see the approach you want as being workable. I would look at the updateParameters section of the ToolValidator class. Although it doesn't take your desired approach, this thread on Conditional Drop Down Lists - Tool Validator may give you some ideas in using updateParameters. Unfortunately, the blog posting mentioned in the first post is no longer available (or not yet available) in the new ESRI blogs.

I imagine you would have your users select the appropriate row in your table based on a value in the first column. Then other column values in the selected row would populate several of your tool's option selections.

Can you describe how your table would be organized and how you would use the values from it in your tool?

Re: Pulling information from a table into a parameter in a script tool

RandyBurton — Sat, 11 Dec 2021 12:06:00 GMT

Perhaps something like this for the ToolValidator class (script tool, not python toolbox):

import arcpy
class ToolValidator(object):
  """Class for validating a tool's parameter values and controlling
  the behavior of the tool's dialog."""

  def __init__(self):
    """Setup arcpy and the list of tool parameters."""
    self.params = arcpy.GetParameterInfo()

  def initializeParameters(self):

    fc = r'C:\Path\To\Test.gdb\TableTest' # our table with set-up data
    fld = 'Selection'  # field named 'Selection'
    self.params[0].filter.list = [str(val) for val in sorted(set(row[0] for row in arcpy.da.SearchCursor(fc, fld)))]
    self.params[0].value = self.params[0].filter.list[0] # on init, set to first value in list

    return

  def updateParameters(self):

    if self.params[0].value: # an option has been selected
      fc = r'C:\Path\To\Test.gdb\TableTest' # our table with set-up data
      flds = ( 'Option1', 'Option2', 'Option3','Option4' ) # fields with values we want
      wClause = "Selection = '{}'".format(self.params[0].value) # match field 'Selection'
      values = next(arcpy.da.SearchCursor(fc, flds, where_clause=wClause))
      self.params[1].value = values[0] 
      self.params[2].value = values[1]
      self.params[3].value = values[2]
      self.params[4].value = values[3]         

    return

  def updateMessages(self):
    """Modify the messages created by internal validation for each tool
    parameter.  This method is called after internal validation."""
    return‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: Pulling information from a table into a parameter in a script tool

VishalShah2 — Wed, 12 Sep 2018 19:02:48 GMT

Hi Randy,

I tried to mimic your code but added in my field names in the def updateParameters(self): portion of the script but got an error. The field names in the table that I was to use are AsBuiltSource, AsBuiltCompany, and ConstructionCompany. The other field I need to update is a date field and thus do not need to include that bit in the Validation. As for how the parameters are laid out in my script, they are in this order: AsBuiltSource, AsBuiltCompany, AsBuiltDate, and ConstructionCompany.

How would you set this up in the validation? Sorry about the delay in responding, I was out on vacation for a good bit and then swamped with some work.

Re: Pulling information from a table into a parameter in a script tool

VishalShah2 — Wed, 12 Sep 2018 19:04:32 GMT

The error that I get is that in line 14, the attribute column is not found. I'm assuming because there is no field with that name. What would I substitute 'Selection' out with?

Re: Pulling information from a table into a parameter in a script tool

RandyBurton — Thu, 13 Sep 2018 03:59:41 GMT

Hi Vishal,

It is possible that I don't completely understand your work flow and what you want to accomplish. What I pictured was a table with a row of options. The tool would query the table and populate a dropdown with a list of options. When an option was selected, other values from that row would populate other sections of the tool.

Here's a simplified version of the table I had pictured:

Here's what the tool would look like that would access the table:

When the tool is initialized, the Selection box is populated with the contents of the table's Selection column, with the first row's data being the default selection. The options associated with the Selection are displayed in the tools other boxes. For example, when "Three" is made as the selection, the other option boxes in the tool would be populated with C1...C4.

If this is not what you had in mind, could you provide some examples of the workflow and table layout you were envisioning? Thanks.

Re: Pulling information from a table into a parameter in a script tool

VishalShah2 — Fri, 14 Sep 2018 17:21:43 GMT

Randy,

I do like how you actually used the Selection field to auto populate the other 4 parameters. Using that logic, do those 4 parameters have to be visible then? I would assume that if they get auto populated from a table, then that should be the correct input and the user wouldn't have to make any corrections. So something like this

User selects One in the Selection parameter and then the other 4 parameters (not visible to the user), get populated with A1, A2, A3, and A4 respectively? And then used in the script tool.

As for my workflow that I originally intended for, there would only be 4 parameters. So the tool window will look like this:

Then there would be the following table in the database:

The idea is to get the tool (using validation) to link the table and the 3 fields (AsBuiltType, AsBuilt Company, and ConstCompany; AsBuiltDate will be a manual entry) to be linked to Document Type, Document Company, and Construction Company. So this is the order they'd be paired (field name - Parameter): AsBuiltType - Document Type, AsBuiltCompany - Document Company, and ConstCompany - Construction Company. The idea is that the drop down menu (value list) will get populated with the values in that field. This is so that when a new company's name is added to the table, the drop down menu doesn't have to be manually updated, it'll get auto populated through tool validation. Is this possible?

Just a disclaimer, I have never worked with tool validation so I'm new to it and any insight is greatly appreciated.

Re: Pulling information from a table into a parameter in a script tool

RandyBurton — Fri, 14 Sep 2018 19:21:24 GMT

Thanks for the additional description of your project. To see if I am understanding correctly…

Regarding your question about making the other 4 parameters hidden. I think there is an option for the parameters to be hidden. Showing them could help the user be certain the correct ‘selection’ was made, but it does take space on the tool form.

Regarding the date, Document Creation Date would be a manual entry. So it would not depend on any selection. Would you want it to default to today’s date, the AsBuiltDate, or be left blank?

I am still a bit fuzzy about the selection part. Would the user be presented with ‘Option 1’, ‘Option 2’, etc? If they select ‘Option 1’, then they would get AsBuiltType = Type1, AsBuiltCompany = Company1, and ConstCompany = Company1. I am assuming that whatever ‘Option 1’ is, it would be descriptive enough for your user to choose the best one.

And once a selection is made and a date entered, these parameters will be used to populate a new in a feature class or another table?

Re: Pulling information from a table into a parameter in a script tool

VishalShah2 — Fri, 14 Sep 2018 19:52:16 GMT

The Document Creation Date would be left blank for the user to input the date that can be found on the document they have.

I don't think they'd have a selection. The idea is to point each parameter to a field in the table. So with Document Type parameter pointing to the AsBuildType field, when the user hit's the drop down menu, they'd be presented with the options of Type 1, Type 2, and Type 3. That's because those are the only options. But say the table has over a 1,000 entries with a total of 5 different types. That's pretty easy to manage. AsBuiltCompany could be in the 100s for an option. I'd like for the drop down list for Document Company to auto populate with the values within the AsBuiltCompany field.

Once all the parameters are entered and the user hits Ok, these will populate the appropriate fields within each feature class (10 to be exact right now, may grow).

Hopefully that helped clarify any confusions or questions you may have had.

Re: Pulling information from a table into a parameter in a script tool

RandyBurton — Mon, 17 Sep 2018 06:05:05 GMT

I am still trying to understand your initial selection. My first thought was that the user would select something unique, like a project number, and then get the all other items that are associated with that project. The project number would be a unique identifier for the row.

Perhaps you are needing something like a drill down selection. That is, select an AsBuiltType, then select the AsBuiltCompany from a dropdown who is in that type group, and then continue refining the selection.

If your table looks like this (with 2 Type 1 entries):

Then your tool could present the 2 companies classified as Type 1.

Is this what you would like to accomplish?

Re: Pulling information from a table into a parameter in a script tool

VishalShah2 — Wed, 19 Sep 2018 17:34:53 GMT

Randy,

While the drill selection would be nice, ideally, I'd like to provide all options in the column. So even if you select Type 1 in Document Type, the user would still get Company 1-4 in Document Company. The catch is this, this table will grow and there will be several entries that are the same in some fields. Can they be summed up in the validation of the script tool and then presented in the drop down menu?

Re: Pulling information from a table into a parameter in a script tool

RandyBurton — Wed, 19 Sep 2018 18:00:04 GMT

Would the ProjectID be unique? If so, this would be the selection field, and the tool would pull the other fields on that row. The important thing would be a unique ID that makes sense to the user.

The growth of the table should not be an issue, nor the duplication of entries. The tool reads the table when it is first run and when the user makes a change. You would want to make certain that wherever the tool is used, it will have access to the table. Its location could be hardcoded into the tool, or you could add a box in the tool where the user selects which table to use.

Re: Pulling information from a table into a parameter in a script tool

VishalShah2 — Wed, 19 Sep 2018 18:22:29 GMT

The Project ID would be unique, but I'm not going for making a selection based on an unique entry. When the user opens the tool, I'd want them to have blank parameters and when they hit any drop down menu, it'll give them all of the entries within the table for the associated column. This is so that the user does not have to go in order to drill down or anything. Hopefully that made a bit more sense. Sometimes the user won't have the information for one of the parameters and so with that, they'd have to leave that parameter blank.

Re: Pulling information from a table into a parameter in a script tool

RandyBurton — Wed, 19 Sep 2018 18:31:55 GMT

What question would the user need to answer first?

Re: Pulling information from a table into a parameter in a script tool

VishalShah2 — Wed, 19 Sep 2018 19:35:30 GMT

Are you referring which parameter the user would need to fill in first? If so, it wouldn't matter. Every parameter would have their own values and the user can enter in any order they'd like. Unless that isn't an option?

Re: Pulling information from a table into a parameter in a script tool

RandyBurton — Thu, 20 Sep 2018 18:49:48 GMT

If the user starts by selecting a non-unique identifier, like the AsBuiltCompany, then the tool would need to have the user drill down to select the unique row. If the second selection was for ProjectID, then the tool would have a unique row and could populate the remaining choices. To be able to code the tool, there would need to be a specific order to the selections the user makes.