topic Re: Custom Survey123 URL with Field Maps Callback in ArcGIS Field Maps Questions

Custom Survey123 URL with Field Maps Callback

erica_poisson — Tue, 01 Feb 2022 13:39:36 GMT

Hi -

I am migrating some workflows from Collector to Field Maps and I am running into issues with my callback URL parameters.

The workflow:

Click a polygon feature in Field Maps to view pop-up. Custom pop-up displays URL to launch Survey123 form and pass certain attributes to Survey123.
Survey is completed by user. When user submits survey, Field Maps re-opens via callback to specified map.

This worked very well with Collector and was simple to configure. With Field Maps, I am getting some weird errors, even though I am following the documentation on both Survey123 and Field Maps help pages.

If I use a URL formatted like below, I get an error when attempting to open Survey123 from the URL. The error is in Survey123 and says "Error Unpacking":

https://survey123.arcgis.app/?itemID=10242016ba5b4ab3883bf40bb8ae76fb&field:Ag_Guid={GlobalID }&callback=https://fieldmaps.arcgis.app /?referenceContext=open&itemID=6b34dffb1c0b41b3907c61a97d0b1e4a

This same error occurs when I modified the URL to be something like this:

https://survey123.arcgis.app/?itemID=10242016ba5b4ab3883bf40bb8ae76fb&field:Ag_Guid={GlobalID}&callback=https://fieldmaps.arcgis.app://?referenceContext=open&itemID=6b34dffb1c0b41b3907c61a97d0b1e4a

https://survey123.arcgis.app/?itemID=10242016ba5b4ab3883bf40bb8ae76fb&field:Ag_Guid={GlobalID}&callback=https://fieldmaps.arcgis.app//?referenceContext=open&itemID=6b34dffb1c0b41b3907c61a97d0b1e4a

If I use the callback URL without the referenceContext parameter included, the callback seems to work, but does display an on-screen error when returning to Field Maps; this happens with either of the formats below:

https://survey123.arcgis.app/?itemID=10242016ba5b4ab3883bf40bb8ae76fb&field:Ag_Guid={GlobalID }&callback=https://fieldmaps.arcgis.app ://?itemID=6b34dffb1c0b41b3907c61a97d0b1e4a

https://survey123.arcgis.app/?itemID=10242016ba5b4ab3883bf40bb8ae76fb&field:Ag_Guid={GlobalID }&callback=https://fieldmaps.arcgis.app /?itemID=6b34dffb1c0b41b3907c61a97d0b1e4a

Error:

I did check and the Survey123 data submits properly. I am returned to the proper map in Field Maps, but see this error each time.

Does anyone have advice on how to resolve this issue?

Thank you,

Re: Custom Survey123 URL with Field Maps Callback

Anonymous User — Tue, 01 Feb 2022 14:44:03 GMT

Have you tried URL encoding the callback parameter?

There's a couple examples in the doc about it.

Re: Custom Survey123 URL with Field Maps Callback

GeorgiannaStrobin — Tue, 01 Feb 2022 23:23:09 GMT

We are having the exact same issue. We have several linked Survey123's and Field Maps. We set up the latest link on January 6, 2022 and it was working fine at that time. It was brought to our attention today that a user was having problems, so we went in to see if we could replicate his issue and discovered that now all of our linked apps are broken. We tried the same things as above with the URLs and are getting the same results.

Did something change on Esri's end? How do we solve this issue?

Thank you!

Re: Custom Survey123 URL with Field Maps Callback

himalaya_GIS — Tue, 01 Feb 2022 23:51:24 GMT

We are also getting the same error message in Andriod devices and in ios it doesn't even open the field map from Srvey123

Thank you

Re: Custom Survey123 URL with Field Maps Callback

Anonymous User — Wed, 02 Feb 2022 01:22:38 GMT

I am able to reproduce the issue on both iOS and Android when the callback URL is not encoded. Once it's encoded, it works correctly.

For example:

arcgis-survey123://?portalUrl=https://www.arcgis.com&itemID=6e9276bfdf164a2bafa236f40a1eb4f8&callback=https://fieldmaps.arcgis.app/?referenceContext=open&itemID=1223e990f9314fe996fb6e69eefab9a9

Results in the Error Unpacking message in Survey123.

But the following works since it's URL encoded.

arcgis-survey123://?portalUrl=https://www.arcgis.com&itemID=6e9276bfdf164a2bafa236f40a1eb4f8&callback=https%3A%2F%2Ffieldmaps.arcgis.app%2F%3FreferenceContext%3Dopen%26itemID%3D1223e990f9314fe996fb6e69eefab9a9

All you have to do is copy the callback URL and run it through an online encoder like https://www.urlencoder.org/ and use the result in your app link URL.

It's always recommended to encode parameters if they contain special characters like "&".

Re: Custom Survey123 URL with Field Maps Callback

erica_poisson — Wed, 02 Feb 2022 17:44:06 GMT

Hi @Anonymous User - I will test this to see if it fixes my issue.

If this is the recommended way of doing this, I would recommend an update to the documentation available on the Field Maps and Survey123 help pages because it is not clear at all.

Thank you,

Re: Custom Survey123 URL with Field Maps Callback

erica_poisson — Thu, 03 Feb 2022 20:18:02 GMT

@Anonymous User -

This is the encoded URL I am using - Survey123 launches from Field Maps just fine, but the callback doesn't happen. I submit the Survey and am returned to the Survey123 home instead of Field Maps.

Any advice would be useful.

arcgis-survey123://?portalUrl=https://www.arcgis.com&itemID=10242016ba5b4ab3883bf40bb8ae76fb&field:Ag_Guid={GlobalID}&callback=https%3A%2F%2Ffieldmaps.arcgis.app%20%2F%3FreferenceContext%3Dopen%26itemID%3D6b34dffb1c0b41b3907c61a97d0b1e4a

Thank you,

Re: Custom Survey123 URL with Field Maps Callback

Anonymous User — Fri, 04 Feb 2022 00:14:39 GMT

@erica_poissonIt looks like you have a space in your callback URL after ".app" and before "/". This seems to be causing the issue. I took your app link and plugged in a different survey id and it never returned to Field Maps. I then removed the space (which is encoded to "%20") and tried again and then it worked as expected.

Re: Custom Survey123 URL with Field Maps Callback

erica_poisson — Fri, 04 Feb 2022 13:26:06 GMT

Thank you! I did not notice that, or know that %20 corresponded with a space. I appreciate the help. I do think a blog or something on this would be helpful for others though.

Re: Custom Survey123 URL with Field Maps Callback

JessicaJThompson — Thu, 28 Jul 2022 13:09:50 GMT

Thank you for the examples @Anonymous User !

One of my surveyors has put a wrench in all of my URLs by having a Dell tablet that runs on Microsoft Operating system (all the rest use Ipads). There is no field maps app to download for this. Any ideas if a callback could work for a WebApp Builder? And if it might work, how would the callback be structured...?

Current workflow is

Select an asset in webmap
click on Survey Hyperlink/Custom URL in the pop-up
Survey opens in Survey123 app with data from map populating geopoint and 2 fields
Submit survey
Exit survey123 app
Reopen webmap

This particular surveyor is not the most tech savvy and hesitant to move from paper surveys to a digital platform. I am trying to make it as seamless as possible for her.

Thank you for any thoughts on this!

Jessica

Re: Custom Survey123 URL with Field Maps Callback

CatherineHall678 — Sun, 11 Sep 2022 05:07:02 GMT

This post really helped my troubleshooting...was having the same issue. Much appreciate you @Anonymous User . And thank you @erica_poisson for pursuing and even posting some examples.

Re: Custom Survey123 URL with Field Maps Callback

Anonymous User — Tue, 11 Apr 2023 14:35:37 GMT

Just wondering how pop-ups are being configured to include the URL with additional parameters. Is it stored in the attribute table? I believe pop-ups could be configured to link to surveys etc. in map viewer classic but I am unaware of how they can be included in map viewer (it's been a while since I've had to use URL parameters).

Re: Custom Survey123 URL with Field Maps Callback

GeorgiannaStrobin — Tue, 11 Apr 2023 14:43:43 GMT

This article helped me when I was configuring the custom URLs to link Survey123 and Field Maps for my organization: https://doc.arcgis.com/en/survey123/reference/integratewithotherapps.htm

Re: Custom Survey123 URL with Field Maps Callback

BryceHancock — Mon, 29 Apr 2024 21:47:45 GMT

Hi Erica,

When I return to fieldmaps after completing the survey123 form, the popup in fieldmaps is still open. Do you know if there is a way to callback to the Fieldmaps map with the popup closed? Maybe something I need to put in the url? Thanks.

Re: Custom Survey123 URL with Field Maps Callback

erica_poisson — Fri, 03 May 2024 14:49:15 GMT

Hi Bryce - this isn't something I've looked into at all, so I do not know. Sorry!