topic Re: q:queryparameter URL parameter for Survey123 Windows and iOS in ArcGIS Survey123 Questions

q:queryparameter URL parameter for Survey123 Windows and iOS

JamieLambert — Thu, 03 Dec 2020 06:18:15 GMT

Hi All,

Does anyone have a working example of using the q:queryparameter URL parameter to launch Survey123 (Windows or iOS/Android) [edit] from a pop-up and open an existing survey for editing? So far my attempts get me as far as the Inbox, but I cannot load the form with a specific record to edit. I’m assuming that this parameter can be used this way!

The q:queryparameter "Queries the feature layer for an existing record. It can be used to retrieve content that is not on the device." So I should be able to have nothing preloaded in the Inbox.

The example in Integrate with other apps is q:objectIds=12. I assume this could be q:objectId={objectID} (not sure if 'objectIds' is a typo in the web page?) or even better q:globalID={globalID}.

This is what I have so far and it doesn't work. I have tried a few variations around these with no success (I did also try ObjectID).

arcgis-survey123://?itemID=<form ID>&q:globalId={globalID}&action=edit
https://survey123.arcgis.app/?itemID=<form ID>&q:globalId={globalID}&action=edit

I had no issue with creating the URL to open a specific survey in edit mode in the web. The app version is just not working for me. If anyone could provide a working example or point out what I am doing wrong I would very much appreciate it.

Thanks, Jamie.

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

Shwu-jingJeng — Mon, 11 Jan 2021 19:34:15 GMT

Hi Jamie,

With 3.11 version of the field app, we are having issue with edit mode using the URL partameters. We had a backlog issue for this and will try to address this in the next release.

In the meantime, I'd suggest you to contact Esri Support. Our Support team will assign an official bug number for your records. This number can be used to search for and subscribe to the bug on the Esri Support site. If the issue is reported by other customers it will be attached to the same bug report, which helps us assess the impact of the issue and prioritize it accordingly.

Thanks,

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

David0044 — Tue, 16 Mar 2021 21:01:23 GMT

Was this resolved in the latest update? Also, do you have a working example as requested in the OP? I have the same issue/question.

Thanks

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

Shwu-jingJeng — Tue, 16 Mar 2021 23:17:59 GMT

Hi David,

This issue is still in our backlog list. You may track the status from this salesforce issue. Our internal issue covers all the cases using custom URL parameters, and when the fix is availalbe, it will be included in this salesforce.

BUG-000137679 ArcGIS Survey123 3.11 field app opens the inbox instead of an individual form when the query parameter is used in the custom URL.

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

RonParis — Mon, 12 Apr 2021 16:11:51 GMT

Hi @Shwu-jingJeng

Is there an update on BUG-000137679 please?

Many thanks

Josh

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

ChelseyAiton2 — Tue, 18 May 2021 20:53:55 GMT

Thank you for providing the specific URL parameters. Though it doesn't automatically open the survey, if you refresh the inbox it will provide the correct survey as the only item to select in the inbox. Which is a couple more user actions than necessary, but does get the job done.

I had been attempting to use the following, which does work but the survey has to already be in the inbox. When you refresh the inbox it loads all the surveys, or just those in the map extent depending upon how you load them. (Lots of extra steps to do this) So, while still not perfect, it is slightly better than what I had.

arcgis-survey123://?itemID=<item ID>&action=edit&folder=inbox&update=true&filter=globalId:{globalId}

Does anyone know how this workflow would work Offline, if the survey is not already loaded to the inbox?

Also, wondering if anyone has successfully gotten callbacks to work when finished editing an existing record.

Thanks,

Chelsey

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

JamieLambert — Wed, 19 May 2021 05:20:16 GMT

Status of BUG-000137679 'Under Consideration'

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

skykasko — Mon, 04 Apr 2022 16:53:09 GMT

BUG-000137679 is marked fixed as of version 3.14, but I still encounter the issues described in the original post when using 3.14 on both Android and Windows. If the bug is fixed, a response to this request from the original post would be appreciated:

Does anyone have a working example of using the q:queryparameter URL parameter to launch Survey123 (Windows or iOS/Android) [edit]from a pop-up and open an existing survey for editing?

Thanks,

Skyler

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

JamesTedrick — Wed, 18 May 2022 19:57:20 GMT

Apologies for the delay in reply.

The Survey123 documentation shows how the q:queryparameter URL parameter can be used:

q:queryparameter - Queries the feature layer for an existing record. It can be used to retrieve content that is not on the device.

Examples:

q:where=ws_stationnumber=5171

q:where=waterbodytype='Lake'

q:globalId=1d392670-33e2-456d-8435-7fad3abd8bb9

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

skykasko — Thu, 19 May 2022 19:06:52 GMT

Thanks for the reply, @JamesTedrick. I was aware of that documentation page; the reason I asked for a working example is that I was running into the same issue as the original poster:

So far my attempts get me as far as the Inbox, but I cannot load the form with a specific record to edit.

After further testing, I've found that when I open a link on my Android device it will take me directly to the correct record to edit as long as I include update=true in the URL, as in

https://survey123.arcgis.app?itemID=<item ID>&action=edit&q:where=ws_stationnumber=5171&update=true

However, this link does not work for me on Windows, in that it will not directly open the correct record for editing (switching the link to use the arcgis-survey123:// URL scheme also doesn't work). I have still not found any way to create a q:queryparameter link that works on Windows. I think the problem may be that update=true is not having any effect on Windows, which may be a separate bug.

It would be great if the q:queryparameter URL parameter would directly open the correct record without the need to refresh the Inbox, as long as the relevant record is already in the Inbox. If that is not possible, the documentation for q:queryparameter should mention that update=true must be included in the URL to open a specific record in the Inbox.

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

JimW — Thu, 09 Jun 2022 12:45:23 GMT

What did end up using for the query parameter in constructing your URL? I am attempting to do the same thing and can't get the query parameter correct. I can't figure out how the query parameter in line 5 needs to be constructed to get the inbox to open to the specific record. Thanks!

var urlsource ='arcgis-survey123://?'; var params = { itemID:'d27d6fc327754039b87a62eae3042092', action:'edit', q:'globalid='+$feature.GlobalID, folder:'inbox', update:'true' }; return urlsource + UrlEncode(params);

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

skykasko — Thu, 09 Jun 2022 14:39:53 GMT

In line 5, you need to specify that there is a query parameter q:globalId with the value $feature.GlobalID. What you've specified above is a query parameter q with the value 'globalid='+$feature.GlobalID. Try this instead:

var urlsource = 'arcgis-survey123://?'; var params = { itemID: 'd27d6fc327754039b87a62eae3042092', action: 'edit', 'q:globalId': $feature.GlobalID, folder: 'inbox', update: 'true' }; return urlsource + UrlEncode(params);

Note that the property name q:globalId must be enclosed in quotes since it contains a special character other than _ and $. Also note that I've capitalized the I in q:globalId to match what's shown in the documentation; I believe you have to capitalize the query parameter that way, regardless of the capitalization of you actual global ID attribute.

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

JimW — Fri, 10 Jun 2022 12:00:06 GMT

I don't think I was ever going to figure out the correct syntax for the query parameter. I didn't see any of that in the help. Maybe it's there and I just missed it. Thank you for the help! It worked like a charm!

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

FrancisCorbett — Sat, 21 Jan 2023 21:08:26 GMT

Is there a way of getting this to work offline? I've tried using the filter and query parameters with globalid, but if I download an offline area in Field Maps and download the Survey123 form and refresh the inbox, I get a Code 0 error in Survey123 when offline. I suspect this is because I'm using update=true. My Arcade popup:

var urlsource = 'arcgis-survey123://?'; var params = { itemID: <itemID>, action: 'edit', 'q:globalId': $feature.GlobalID, folder: 'inbox', update: 'true', callback: 'https://fieldmaps.arcgis.app' }; return urlsource + UrlEncode(params);

Thanks in advance!

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

RobertAnderson3 — Mon, 21 Aug 2023 15:23:39 GMT

Thank you so much @skykasko for this it got my link working! I had been struggling so much with it, honestly still not entirely sure what was wrong in mine vs what you had that made it work but hey.

You do need the update=true to open the record, even if it was already in the Inbox of the device in question, which is odd but sure.

The issue I'm running into now though is that this works only if the record is in the INBOX, if the record happens to be in the SENT folder of the device, it does not find the record and cannot open it.

Any insight on this part? I guess I could just turn off the sent folder to avoid this issue but it still seems kind of silly.

I guess for my work flow I'll probably need a second survey form with the same submission URL so only my supervisors can see and edit via the Inbox, and leave the other workers to just their sent folder. Hopefully this works the same way then.

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

skykasko — Mon, 21 Aug 2023 15:54:40 GMT

I'm glad it helped!

It's been quite a while since I've used Survey123, so unfortunately I don't have any insight into your issue with records in the Sent folder. If you haven't yet, I would probably try using the filter parameter along with folder=sent or folder=*, but I can't remember if I ever got the filter parameter working.

Re: q:queryparameter URL parameter for Survey123 Windows and iOS

RobertAnderson3 — Mon, 21 Aug 2023 17:14:18 GMT

All good, thank you for the advice on that, I will look into it! Maybe that * idea will work, or I can try that newer Overview folder too.

Permissions wise I may need the second survey anyways so it might not be critical either.

EDIT: Okay, so I got it working!

https://survey123.arcgis.app/?itemID={itemID}&update=true&action=edit&folder=*&filter=globalId:{globalid}

Had to add the folder=* and then the filter=globalId: and that seemed to get it working with surveys from the sent and inbox, which is awesome.