topic Re: Custom Parameters when Adding a WebService to a Map Viewer in ArcGIS Enterprise Portal Questions

Custom Parameters when Adding a WebService to a Map Viewer

AdamRepsher_BentEar — Thu, 19 Jan 2023 19:21:11 GMT

Hello All,

When setting up a Map Viewer, using the Add a Web Service tool, You can add Custom Parameters.

The only information I can find on this feature is HERE. Starting at step 4. There is no other reference to what type of queries that will work here.

It is quite frustrating because there is no information on how to set up the Parameter or the Value. It is not the same as just configuring a query in a service's ArcGIS REST Services Directory page. For example, I fell into a discovery that you need a '/' AFTER the layer number (..../rest/services/folder/service_name/0/) when you enter the URL to get the custom parameter to work.

After that, it has been trial and error to figure out what will work here. I have used this to limit the timespan like this:
Parameter: where
Value: clock >= CURRENT_TIMESTAMP - INTERVAL '10' MINUTE

Right now, I am trying to figure out how to return features within an envelope that I define.
geometry=-8415875.889,4309499.194,-8403034.469,4330137.192&geometryType=esriGeometryEnvelope&inSR=3857&spatialRel=esriSpatialRelIntersects

Do all of these types of queries work within the Custom Parameter layer settings in the new Map Viewer?
If so, where do we go to get help with configuring the parameter and value?

Thanks,

--Adam

Re: Custom Parameters when Adding a WebService to a Map Viewer

LindsaySpencer — Wed, 05 Apr 2023 18:50:17 GMT

Hi @AdamRepsher_BentEar ,

I'm having a similar issue, but with the geometry not being reflective of the parameter that was added. Only the table is actually performing the query, but the visualizations in the map have not changed to reflect the query results. In the image below, I have a parameter set on a service I pulled in, and it's a simple where clause, which is reflected in the 25 records shown in the table. However, there are WAY more than those 25 points on the map. It is a sea of blue.

Anyone else experiencing a similar issue, and have you found a resolution?

Thanks!

Lindsay

Re: Custom Parameters when Adding a WebService to a Map Viewer

AdamRepsher_BentEar — Thu, 06 Apr 2023 18:00:35 GMT

Hi Lindsay,

Most of the work I have done using custom parameters did not involve needing the map visualization.

Quick thought: Did you add the custom parameters when you added the service to the map, or did you enter them after, in the 'Properties' section? I remember that being an issue. When I tried to enter them through the Properties section, I did not see any filtering. I just don't remember if I looked at the table too, (Funny, since I wasn't needing the map visualization, only the data...)

--Adam

Re: Custom Parameters when Adding a WebService to a Map Viewer

LindsaySpencer — Thu, 06 Apr 2023 20:50:30 GMT

Hi @AdamRepsher_BentEar ,

So I added the 0 layer endpoint to the map, and then used the custom parameters in the properties section for the SQL. But I will give it a try the other way too, and see if that ends up making a difference!

Thanks!

Re: Custom Parameters when Adding a WebService to a Map Viewer

AshleyGahl — Tue, 07 Nov 2023 11:14:47 GMT

Just in case you guys still have issues with parameterized map services | queries

I've also spent almost two days trying to figure this out!

What helped me was the following : loading your map service layer to the MapServer/9/query endpoint and then add your custom parameter name and value , e.g. where and suburb = 'Boksburg'

This will load your data parameterized query successfully

Re: Custom Parameters when Adding a WebService to a Map Viewer

acarmody — Fri, 22 Mar 2024 05:44:34 GMT

Hi @AdamRepsher_BentEar,

I contacted Esri support asking the same question you posted here - I too am trying to spatially filter a web service using custom parameters.
Below is what Esri replied with - unfortunately it isn't as detailed as I'd hoped... Hope it helps you. I'm no closer to solving the spatial filter....

Typically, the requirement for custom parameters in a web service would be specified in the service’s documentation or API reference. However, not all services may provide this information explicitly.

In the context of ArcGIS Online, when you’re adding a layer from a web service, you have the option to add custom parameters. These parameters are appended to all requests made to the service. The parameters and their values would depend on the specific web service you’re working with.

If the service’s documentation does not provide the necessary details, you might need to contact the service provider or seek advice from relevant forums or communities.

In short, these custom parameters are generally used for accessing the service. You can however access other functionality by using URL parameters instead as found here: Use URL parameters in Map Viewer (esri.com)

Re: Custom Parameters when Adding a WebService to a Map Viewer

AdamRepsher_BentEar — Fri, 22 Mar 2024 13:30:45 GMT

To keep this going and to resolve one previous problem...

*** I did discover that if you enter the new parameters in the "properties" area, the query will succeed...
IF you then SAVE the webmap, and then RELOAD the entire page. @LindsaySpencer - I know this is a long time since your post, but you should be able to find success with this.

Now - for the creation of the query, I am finding this link to be the best starting point for information on how to construct them: Query (Map Service/Layer)—ArcGIS REST APIs | ArcGIS Developers
I hope it helps others!

--Adam

Re: Custom Parameters when Adding a WebService to a Map Viewer

acarmody — Mon, 25 Mar 2024 23:34:26 GMT

Thank you for this tip regarding the properties section! I have my spatial filter working now.

For anyone who gets a bit lost finding this, here's a screenshot for reference.

Add layer from service url (don't add any parameters) > go to properties > add custom parameters

Format parameters - e.g.

I've found that the minimum custom parameters to use are inSR and geometry. It seems that you don't need to include geometryType or spatialRel for the filter to work. outSR stops the filter from working.

The 'spatial inputs' section on the api explorer is handy for getting the geometry coordinates in the correct order - especially if you're working with data outside of the US/northern hemisphere https://hub.arcgis.com/datasets/b85233f0b21a4a9c9044ad21f459ed4a/api?layer=0

Cheers

Re: Custom Parameters when Adding a WebService to a Map Viewer

Becca_ — Wed, 29 May 2024 13:12:12 GMT

I am also having this problem. I want to add a custom parameter in a way so that other users in my Portal cannot remove them. I've tried adding the custom parameter when adding the service to my portal through the URL and I've tried putting my query in the URL that I'm adding. Any wisdom someone could share with me?

Re: Custom Parameters when Adding a WebService to a Map Viewer

AdamRepsher_BentEar — Wed, 29 May 2024 13:19:35 GMT

@Becca_ - What version of Portal (Enterprise) are you trying this in?

Re: Custom Parameters when Adding a WebService to a Map Viewer

Becca_ — Wed, 29 May 2024 13:23:30 GMT

We're currently on 10.9.1. but hoping to upgrade later this year.

Re: Custom Parameters when Adding a WebService to a Map Viewer

AdamRepsher_BentEar — Wed, 29 May 2024 13:39:40 GMT

Okay. I have been using this feature for some time in 10.9.1 and it is working well. Unless a user gets into one of the Web Maps and knows how to find the "Add Parameter" setting for an individual layer, there is no other easy way for anyone to change it... and that is almost impossible for one of my normal users to accomplish.

I wonder if you are talking about adding parameters to the link that you are supplying to someone when you want them to open an app? Like here: Use URL parameters to create and modify maps—ArcGIS Online Help | Documentation In this case, the user would easily be able to remove parameters before browsing to a Web Map. In what I am doing, the user would have to go to the Web Map and then change the properties within any layers that I had set parameters for.

I apologize if I am incorrect in that assumption. I just want to make sure that we are talking about the same thing.

--Adam

Re: Custom Parameters when Adding a WebService to a Map Viewer

AshleyGahl — Thu, 30 May 2024 07:57:37 GMT

Hey, just to get the scope and context of your question are we talking about map services in a federated environment or standalone. If federated than the map services are by default listed in your portal, if not then you'll have to add them yourself to portal as items. We had a request a month ago where we had to display layers in experience builder but not listed in the layer list. We got it to work, so I'm not sure if we are talking about the same thing.

Re: Custom Parameters when Adding a WebService to a Map Viewer

AdamRepsher_BentEar — Thu, 30 May 2024 12:48:02 GMT

Hi Ashley,

Yes. I believe we are talking about the same thing.
I do understand the difference between services from a federated ArcGIS Server and those in a non-federated AGS.
You should be able to add either to a Web Map and then add parameters to either layer.

The difference in what you are doing and what I am doing is in "hiding the layer" from the layer list in the application. I was not attempting to do that - and am wondering how you accomplished that.