topic Re: AddData Widget Modifications in ArcGIS Web AppBuilder Questions

AddData Widget Modifications

JamesCrandall — Mon, 04 Dec 2017 21:17:53 GMT

Problem: The AddData widget does not filter out ESRI Premium Content from its search results and publicly shared WAB apps will have many non-organizational account users. The WAB refreshes if attempting to add ESRI premium content (after signing in) and is a very confusing user experience.

Question: Is there an easy way to filter out ESRI Premium Content from the AddData widget search results?

We're interested in an interim quick solution that we can implement to our WAB apps we build with WAB Developer and would like to alter the AddData widget as described above. In the longer term, an enhancement request will be made to fix this issue as it seems to be a design flaw in general. There should not be interruptions to the logical flow and is quite confusing to the user.

Re: AddData Widget Modifications

RobertScheitlin__GISP — Sun, 12 Dec 2021 07:36:04 GMT

James,

I am having a hard time verifying it working but see if this works for you (since you know what was returning for you) widgets\AddData\search\SearchPane.js line 29:

define(["dojo/_base/declare",
    "dojo/_base/lang",
    "dojo/_base/array",
    "dojo/on",
    "dojo/dom-class",
    "dijit/_WidgetBase",
    "dijit/_TemplatedMixin",
    "dijit/_WidgetsInTemplateMixin",
    "dojo/text!./templates/SearchPane.html",
    "dojo/i18n!../nls/strings",
    "./SearchBox",
    "./BBoxOption",
    "./ScopeOptions",
    "./TypeOptions",
    "./SortOptions",
    "./ResultsPane",
    "./Paging",
    "./ResultCount"
  ],
  function(declare, lang, array, on, domClass, _WidgetBase, _TemplatedMixin,
    _WidgetsInTemplateMixin, template, i18n) {

    return declare([_WidgetBase, _TemplatedMixin, _WidgetsInTemplateMixin], {

      i18n: i18n,
      templateString: template,

      qDefaultFilter: null,
      qRequiredFilter: "tags:(* NOT 'premium content')",
      searchOnStart: true,‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: AddData Widget Modifications

JamesCrandall — Tue, 05 Dec 2017 13:55:50 GMT

Much appreciated, Robert -- I'll dig into this today and give it a go.

Re: AddData Widget Modifications

JamesCrandall — Tue, 05 Dec 2017 14:08:29 GMT

Robert -- that definitely had an affect. However, it filters out all "My Organization" content if signed in. I think the most desired solution is to filter out ESRI premium content from the "ArcGIS Online" drop-down, but if the user is signed in then do not apply any filter.

Re: AddData Widget Modifications

RobertScheitlin__GISP — Tue, 05 Dec 2017 14:18:19 GMT

James,

Hmm. Strange the filter is set for item tagged with "Premium content" to not show. So I am not sure why your content would be filtered out when signed in. So are you saying you only want to apply the filter when the "ArcGIS Online" source is selected and the user is Not signed in?

Re: AddData Widget Modifications

JamesCrandall — Tue, 05 Dec 2017 14:46:10 GMT

So are you saying you only want to apply the filter when the "ArcGIS Online" source is selected and the user is Not signed in?

Yes, that sounds like what we'd want to see. If we have a public WAB deployed to our domain then no login is required if the app is opened and no ESRI premium content should be listed in any search result at all because it will automatically redirect to the sign in. This is very disruptive to the user experience -- it should prompt the user to ask if they'd like to sign in and offer the opportunity to cancel so that the WAB does not refresh and the session content lost.

However, we can have all internal resources point to the WAB with url parameters so that it opens at the org sign-in rather than open as a public user. This forces the user to sign in first -- this way any AddData search results should then contain all public content, content shared with the organization and ESRI premium content would be fine to add and there will not be any refresh because the user is already signed into the org.

Re: AddData Widget Modifications

RobertScheitlin__GISP — Sun, 12 Dec 2021 07:36:07 GMT

James,

OK, here is what I came up with.

SearchPane.js (remove the change from the previous post and make this change):

      buildQueryParams: function(task) {
        var qRequired = null;
        if (typeof this.qRequiredFilter === "string" && this.qRequiredFilter.length > 0) {
          qRequired = this.qRequiredFilter;
        }
        var params = {
          q: qRequired,
          canSortByRelevance: false
        };
        array.forEach(this.getComponents(), function(component) {
          component.appendQueryParams(params, task);
        });
        if(params.q.indexOf("orgid") === -1 && params.q.indexOf("owner") === -1){
          var portal = this.searchContext.portal;
          if(!portal.haveSignIn()){
            var q = "(tags:(* NOT 'premium content'))";
            if (params.q !== null && params.q.length > 0) {
              params.q += " AND " + q;
            } else {
              params.q = q;
            }
          }
        }
        delete params.canSortByRelevance;
        if (params.q === null && typeof this.qDefaultFilter === "string" &&
          this.qDefaultFilter.length > 0) {
          params.q = this.qDefaultFilter;
        }
        return params;
      },
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: AddData Widget Modifications

JamesCrandall — Tue, 05 Dec 2017 19:06:19 GMT

Thank you. Does this have to be added in any particular location within SearchPane.js or other call to buildQueryParams?

Re: AddData Widget Modifications

RobertScheitlin__GISP — Tue, 05 Dec 2017 19:09:16 GMT

James,

Sorry for not making it clear that is a replacement buildQueryParams function (so replace your current buildQueryParams function with this one).

Re: AddData Widget Modifications

JamesCrandall — Tue, 05 Dec 2017 19:10:20 GMT

Got it. Thanks a million.

Re: AddData Widget Modifications

JamesCrandall — Tue, 05 Dec 2017 19:18:15 GMT

Edit: perhaps it actually does filter it out -- I've gone thru several iterations of clearing browser history and kept seeing the usgs content in the search results until now when I just made another attempt. I'll continue to test but looks promising. Thanks again!

Robert,

I've deployed a test WAB with the changes and have set it and its web map source to shared public. When it opens I am not prompted to login (expected) and open the AddData widget, which defaults to "ArcGIS Online" as the search location (expected). If I type in "usgs", I get the USGS Live Stream Gauges (Flooding) map service that is considered "subscriber" content and distributed by ESRI.

Do you get the same?

Re: AddData Widget Modifications

RobertScheitlin__GISP — Tue, 05 Dec 2017 20:28:21 GMT

James,

What is your app extent when opening? A City, State, the US, the World?

Re: AddData Widget Modifications

JamesCrandall — Tue, 05 Dec 2017 20:32:56 GMT

State (majority of Florida)

Re: AddData Widget Modifications

RobertScheitlin__GISP — Tue, 05 Dec 2017 20:54:59 GMT

I see that the

Live Stream Gauges (Flooding)

does not have the tag "Premium Content".

Re: AddData Widget Modifications

RobertScheitlin__GISP — Sun, 12 Dec 2021 07:36:09 GMT

James,

This change should do it:

      buildQueryParams: function(task) {
        var qRequired = null;
        if (typeof this.qRequiredFilter === "string" && this.qRequiredFilter.length > 0) {
          qRequired = this.qRequiredFilter;
        }
        var params = {
          q: qRequired,
          canSortByRelevance: false
        };
        array.forEach(this.getComponents(), function(component) {
          component.appendQueryParams(params, task);
        });
        if(params.q.indexOf("orgid") === -1 && params.q.indexOf("owner") === -1){
          var portal = this.searchContext.portal;

          if(!portal.haveSignIn()){
            var q = "(-\"Requires Subscription\")";
            if (params.q !== null && params.q.length > 0) {
              params.q += " AND " + q;
            } else {
              params.q = q;
            }
          }
        }
        delete params.canSortByRelevance;
        if (params.q === null && typeof this.qDefaultFilter === "string" &&
          this.qDefaultFilter.length > 0) {
          params.q = this.qDefaultFilter;
        }
        return params;
      },‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: AddData Widget Modifications

JamesCrandall — Wed, 06 Dec 2017 15:57:36 GMT

I do believe this is it!

Much appreciated!