topic Re: WAB: How do I customize output messages in GP Widget Output tab? in Web AppBuilder Custom Widgets Questions

WAB: How do I customize output messages in GP Widget Output tab?

FrancescoTonini2 — Wed, 30 Aug 2017 14:52:36 GMT

Can anyone help me understand what file(s) and code chunks I need to look at to customize the info, warning, or error messages that get sent to the Output tab of the GP Widget in WAB? Related to this, what should I do if I wanted to output my own custom messages into an on-screen message window that opens only after GP widget is done executing? Thanks!

Re: WAB: How do I customize output messages in GP Widget Output tab?

RobertScheitlin__GISP — Sun, 12 Dec 2021 10:20:35 GMT

Francesco,

In the Geoprocessing widget.js find the onExecuteComplete function in there you will see that the only messages that are dealt with are warnings and errors:

    onExecuteComplete: function(results){
      this._hideLoading();

      //show messages if there are warning or error
      var msgs;
      if(results.messages && results.messages.length > 0){
        msgs = array.filter(results.messages, function(msg){
          return msg.type === GPMessage.TYPE_WARNING ||
                 msg.type === GPMessage.TYPE_ERROR;
        });
        if(msgs.length > 0){
          this._createErrorMessages(msgs);
        }
      }

      //the results.results is an array of ParameterValue,
      //because it contains one or more parameters
      this._createOutputNodes(results.results);

      html.removeClass(this.exeNode, 'jimu-state-disabled');
    },‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: WAB: How do I customize output messages in GP Widget Output tab?

FrancescoTonini2 — Fri, 01 Sep 2017 13:06:38 GMT

Thanks Rob! Would I still only get warning and error messages even when I set up my GP service to "Info" level? If that is the case, then I could add more warning messages to my GP service code to have those written in the output of the widget (without having to modify it)...am I correct? However, what if I wanted to, say, have an "info" type of message popping up on my screen after running GP widget, with some summary info such as "total CO2 emission" etc? Would I have to modify and add to that same chunk of code you pasted above?

Re: WAB: How do I customize output messages in GP Widget Output tab?

RobertScheitlin__GISP — Fri, 01 Sep 2017 13:23:29 GMT

Yes you are correct on both accounts.

Re: WAB: How do I customize output messages in GP Widget Output tab?

RyanDeBruyn1 — Fri, 27 Oct 2017 15:35:21 GMT

Quick question. Where/how do I find the .js file for the gp widget that was created and configured in WAB? or does this have to be a custom widget?

thanks

Re: WAB: How do I customize output messages in GP Widget Output tab?

RobertScheitlin__GISP — Fri, 27 Oct 2017 15:46:10 GMT

Ryan,

If you are using WAB Developer then you look in the apps widgets folder (i.e. [Install dir]\server\apps\[app#]\widgets\Geoprocessing).

Re: WAB: How do I customize output messages in GP Widget Output tab?

RyanDeBruyn1 — Fri, 27 Oct 2017 15:58:32 GMT

Thanks! This was a GP widget added in WAB online when configuring the web app, so not using WAB Developer directly for widgets. I was thinking might be able to do something similar since the messages are being cleared when task is complete... but most likely limited with the defaults.

Re: WAB: How do I customize output messages in GP Widget Output tab?

RobertScheitlin__GISP — Fri, 27 Oct 2017 16:02:22 GMT

Ryan,

If you are using AGOL WAB app then there is nothing you can do.

Re: WAB: How do I customize output messages in GP Widget Output tab?

AhnaMiller2 — Tue, 07 Nov 2017 20:09:43 GMT

Ryan, I found a work around to help with this if you are doing it in an out of the box GP widget. . Let me know if you are still needing help with this

Re: WAB: How do I customize output messages in GP Widget Output tab?

RyanDeBruyn1 — Tue, 07 Nov 2017 22:51:11 GMT

Ahna that's awesome yes. Just using out of the box online gp widget from web app builder. Would love it if my messages remained in the dialog after execution.

Let me know if you can.

Much thanks!!!

-Ryan

Get Outlook for iOS<https://aka.ms/o0ukef>

Re: WAB: How do I customize output messages in GP Widget Output tab?

AhnaMiller2 — Tue, 07 Nov 2017 22:57:39 GMT

Sure thing, do you have an email I can send to directly?

Re: WAB: How do I customize output messages in GP Widget Output tab?

ErnestoCarreras4 — Mon, 02 Apr 2018 15:03:50 GMT

ahnamiller‌

I am interested in this solution since I am trying to do the same. Is there any way you can share the workaround solution?

Regards,

Re: WAB: How do I customize output messages in GP Widget Output tab?

AhnaMiller2 — Mon, 02 Apr 2018 15:21:29 GMT

Hi Ernestocd

I achieved this by creating a python script from desktop and publishing as a Geoprocessing service that can then be served up in the geoprocessing widget. Your script should contain an output that has an arcpy.AddMessage() and arcpy.SetParameterAsText() . The set parameter as text will be the thing that passes information as an output.
Here's a small snippet of what this looks like:

In the properties of the script tool, set your parameter properties to be Type: Derived & Direction: Output (this makes sure the message you put in for SetParameterAsText() is an output)

Additionally, when you are publishing your service on the Parameters tab of the Service Editor box, set the message level to Info

Hope this helps! Feel free to reach out if you get stuck

Re: WAB: How do I customize output messages in GP Widget Output tab?

ErnestoCarreras4 — Mon, 02 Apr 2018 18:45:36 GMT

Worked like a charm! Thanks

Re: WAB: How do I customize output messages in GP Widget Output tab?

MarcelBuford1 — Mon, 21 May 2018 15:52:25 GMT

@Ahna Miller, this is an excellent technique; I've been attempting to accomplish this for more than a week, thanks! One question: although my messages print to the Output tab, they only appear after the GP widget is finished executing. Is this your experience? Ideally, I would like my users to see messages while the process is running, especially during long-running scripts. Is there a way to output messages while the process is running? Thanks again

Re: WAB: How do I customize output messages in GP Widget Output tab?

AhnaMiller2 — Mon, 21 May 2018 17:00:55 GMT

So glad it worked well for you!

What you describe has been my experience as well, unfortunately. If you, or anyone here has found how to do it, I'd appreciate the advice- maybe the key lies in synchronous or asynchronous publishing of the service?

Re: WAB: How do I customize output messages in GP Widget Output tab?

Anonymous User — Wed, 23 May 2018 15:06:48 GMT

Hey Robert -- just confirming before I edit one of the annoyingly detailed GP services that everything else is in order

Once the geoprocessing/widget.js is updated to pull in the appropriate message types:

and once the job is configured to report 'Info' level messages (and the script is doing so):

and the python script sets an output parameter of the output message, then the geoprocessing widget should show all messages after the geoprocessing task is complete.

Am I missing anything, to your knowledge?

Re: WAB: How do I customize output messages in GP Widget Output tab?

RobertScheitlin__GISP — Wed, 23 May 2018 15:10:56 GMT

Not that I know of.

Re: WAB: How do I customize output messages in GP Widget Output tab?

Anonymous User — Wed, 23 May 2018 15:14:37 GMT

Awesome, i'll give it a go and report back to the team