topic How to Implement Custom tool Validation for Geoprocessing Widget in ArcGIS Web AppBuilder Questions

How to Implement Custom tool Validation for Geoprocessing Widget

AlexisGreen — Wed, 16 Sep 2015 17:11:13 GMT

I've added a geoprocessing service to the Geoprocessing widget in Web AppBuilder. Within the GP tool that was authored in ArcGIS Desktop, I have some custom validation logic written using Python, which works fine when running the GP tool in ArcGIS Desktop, but which is ignored when publishing the tool as a GP service and running it via Web AppBuilder's Geoprocessing widget. The UI for my tool consists of 2 drop-down menus to collect the 2 input parameters from the user. The parameter validation needs to happen before tool execution, and I need the validation logic to update the values in the 2nd drop-down menu based on the value that the user chooses in the 1st drop-down menu.

It seems that a possible approach to implementing this type of special validation code would entail using the Developer Edition of Web AppBuilder to customize the "Settings UI". Anyone have experience with this type of client-side parameter validation in Web AppBuilder who would be willing to share some tips with me? Is this something that would be relatively easy to do, or does it require advanced JavaScript development or experience with the API? Thanks for any feedback.

Re: How to Implement Custom tool Validation for Geoprocessing Widget

JianWang3 — Thu, 17 Sep 2015 02:05:37 GMT

The Geoprocessing widget in Web AppBuilder is a general purpose tool. It doesn't provide such method to set the validation rules for each parameter. Maybe it's a good idea to valid parameter in the client, but all information of Geoprocessing widget in setting page comes from the service definition where there is nothing about the validation rules for input parameters.

I think it's better to develop a custom widget to do the things you want if possible.

Re: How to Implement Custom tool Validation for Geoprocessing Widget

AlexisGreen — Thu, 17 Sep 2015 13:42:48 GMT

Thanks for your feedback. In planning a strategy, I was under the impression that modifying/extending the Out of Box Geoprocessing widget in the Web AppBuilder would be easier than starting "from scratch" writing a whole new custom widget, but perhaps not. Anyone built a custom widget with parameter validation logic similar to what can be done in a Python script tool? I'm leaning toward the JavaScript API for cross-platform support. I would be very grateful for advice on how to get started doing this.

Re: How to Implement Custom tool Validation for Geoprocessing Widget

DougBrowning — Tue, 03 May 2016 21:02:13 GMT

Every get anywhere on this? I agree the code site in the query widget so no need to start over.

Re: How to Implement Custom tool Validation for Geoprocessing Widget

RichardHughes2 — Fri, 06 Dec 2019 17:03:51 GMT

It is my understanding based on what I've seen, that only a Python Toolbox published as a GP Service will provide dynamically updating Choice Lists. I don't know why a script tool would not also work. Does Esri have any guidance on this. Does a Python Toolbox run the Custom Validation Code when it gets published as a GP Service?

Re: How to Implement Custom tool Validation for Geoprocessing Widget

JulioGaspar1 — Mon, 02 Mar 2020 17:35:40 GMT

Hi guys,

I have the same problem here.

Re: How to Implement Custom tool Validation for Geoprocessing Widget

JyotiRohodia — Mon, 20 Apr 2020 18:52:45 GMT

I am running into the same a problem. Along with this, apparently even multivalue parameter in a script tool doesn't work as expected when published as a gp service.

Any guidance on custom widget would be greatly appreciated!

Re: How to Implement Custom tool Validation for Geoprocessing Widget

RichardHughes2 — Tue, 21 Apr 2020 11:55:53 GMT

I have seen this working in a python toolbox. but I have not yet tested myself. I am thinking that the extra python may have more control over the input drop down list. This is just a hunch based on one other GP service I've seen that I believe had an updating pickList. I've not found much documentation on this either.

Re: How to Implement Custom tool Validation for Geoprocessing Widget

JyotiRohodia — Tue, 21 Apr 2020 12:05:05 GMT

Hi Richard,

Thank you for your reply.

I tested the multi-value parameter in python toolbox (.pyt). Apparently both script tool and .pyt toolbox allows multivalue parameter.

But, when we publish these tools to Arc Server (10.6), they allow you to choose multiple inputs based on the data layers which were copied over along with the tool- so the inputs become STATIC. I would like to have the option to upload my own multiple layers while running the tool - more like DYNAMIC inputs.

This behavior could be seen when you publish a basic Merge gp tool as well (this tool which is suppose to accept multiple inputs).

Re: How to Implement Custom tool Validation for Geoprocessing Widget

LanceKirby2 — Fri, 26 Jun 2020 03:06:42 GMT

Any update on this? I am trying to publish a gp service to be used in WAB that allows the user to select any layer within the first parameter and have a dropdown in the second parameter of fields associated with that layer.

Re: How to Implement Custom tool Validation for Geoprocessing Widget

JyotiRohodia — Fri, 26 Jun 2020 06:26:01 GMT

Hi Lance,

I think you can achieve this workflow using a script tool in ArcGIS Pro. Configure Field type parameter and set "Dependency" on the input layer.- inside script tool properties.

Hope this helps.

Re: How to Implement Custom tool Validation for Geoprocessing Widget

LanceKirby2 — Fri, 26 Jun 2020 16:25:32 GMT

Thanks Jyoti. I've tried to get that to work several times. I was hoping someone could confirm that they have actually implemented it!

Re: How to Implement Custom tool Validation for Geoprocessing Widget

tigerwoulds — Fri, 29 Oct 2021 03:49:59 GMT

Unfortunately, I can confirm that validation code does not carry over from a Python Toolbox to GP Server. I have a Python Toolbox (not a Script Tool) published as a GP Service to ArcGIS Enterprise 1081. The toolbox has validation code to update a parameter's drop down lists based on the user updating another parameter. This functionality does not carry over to the GP Widget in Web AppBuilder after publishing as a GP Service.

Re: How to Implement Custom tool Validation for Geoprocessing Widget

tigerwoulds — Fri, 29 Oct 2021 03:54:14 GMT

I'm hitting the same wall with a very similar issue. Unfortuatenly I think validation code from a working Python toolbox does not carry over to the GP Widget in WAB. This guy had this same problem and 2016 and suggests building the functionality in JS rather than python. Ugh...

3 Lessons I Learned from Publishing Geoprocessing Services in ArcMap (ifeomacollins.com)

Re: How to Implement Custom tool Validation for Geoprocessing Widget

SerjStol — Tue, 03 Sep 2024 13:00:34 GMT

I ran into this issue now on ArcGIS Enterprise 11.3, validation of the parameters does not work when you publish a Web Tool from ArcGIS Pro, while it works in Pro. I have made a tool using Python Toolbox and require dropdown to be populated based on the layer chosen in the first parameter.

I embeded the custom GP Tool in the Experience Builder Analysis Widget and it still seems that its not possible, the parameters remain static with the values you used when you run the tool in Pro.