topic Re: Custom URL parameters passing value to Collector? in ArcGIS Survey123 Questions

Custom URL parameters passing value to Collector?

BrentKinal1 — Mon, 11 Dec 2017 16:38:22 GMT

I've been playing around with linking to Collector from Survey123 and the GitHub documentation for Collector custom URL scheme shows that it is possible to both center on a coordinate and pass static attributes to a layer within a web map in Collector. The GitHub documentation however doesn't show how to pass values collected in Survey123 to Collector, similar to the way values can be passed from Collector to Survey123, just curious if this functionality has yet to be implemented or if someone has an example on how to center the map on the geopoint coordinate and send an attribute (GUID) value collected with Survey123 to a feature in Collector?

Re: Custom URL parameters passing value to Collector?

TiffanyRufo — Mon, 11 Dec 2017 16:47:45 GMT

Understanding Survey123s Custom Url Scheme

Best post documentation on how to do it so far. My go to.

Re: Custom URL parameters passing value to Collector?

Anonymous User — Wed, 13 Dec 2017 19:39:39 GMT

I believe they have updated the GitHub site for the Collector URL schema to include how to pass data into Collector.

GitHub - Esri/collector-integration: Multi Language repository that contains documentation and sample code for creating …

I will be looking into this as well.

Good Luck

Re: Custom URL parameters passing value to Collector?

BrentKinal1 — Fri, 15 Dec 2017 14:14:20 GMT

Thanks Tiffany and Mike, I have been working off both the links you sent. Unfortunately neither really explains if there is a way to dynamically write an attribute collected in S123 to Collector. The URL going from S123 to Collector is slightly different than the converse. The GitHub page does show how to write a static value from S123 to the attribute table in collector, which I have been testing so far without success so far. If I get it to work I think I can put something together using concat() to build the link to dynamically pull a value (a GUID) collected in S123 and populate it in the Collector feature, with the ultimate goal of having a relationship class built between the S123 feature and the Collector feature using the GUID. If I am ultimately successful I will share how I did it.

Re: Custom URL parameters passing value to Collector?

Anonymous User — Fri, 15 Dec 2017 18:39:43 GMT

I might have sometime to play around with this also, but it will not be until after next week during our Holiday shutdown; it's the time that I our company shuts down and I get to develop and test away without interruptions, and if I happen to figure something out, then I'll post to this thread also.

Good Luck,

Mike

Re: Custom URL parameters passing value to Collector?

ScottKichman — Mon, 16 Apr 2018 17:06:09 GMT

Hello all, was there every any further action in this thread that was not posted? I am attempting to do exactly the same process. Thanks!

Re: Custom URL parameters passing value to Collector?

ScottKichman — Mon, 16 Apr 2018 17:08:16 GMT

Hi Brent, did you ever figure this out?

Re: Custom URL parameters passing value to Collector?

Anonymous User — Sun, 12 Dec 2021 17:02:46 GMT

Hey Scott,

I have not had the chance to work with this issue, but I have found that they have updated the URL schema for passing information into Collector app. The key will be creating a hyperlink that will concatenate a URL that represents the "expected" URL string that collector is listening for.

Within the link that I provided above; as you scroll down the page to here GitHub - Esri/collector-integration: Multi Language repository that contains documentation and sample code for creating … you will see the URL string that Collector is expecting.

Within this posting I discuss a way to create a URL link to send an email, but you can modify the "Hyperlink" in order to concatenate the sending of data from a Survey123 form into the Collector app.

Not your standard "Note" question; email link

Really take some time to look at the structure of the URL for collector and understand how you can sub in your attribute field names and then the values being passed. You will need to know the URL to the Feature Service Layer along with the data field names (i don not believe you can use the alias field names in passing this information) and the values. When looking at collector you will need to substitute in the question name and then the answers of the questions; similar to my hyperlink for an email.

Quick breakdown of this URL - arcgis-collector://?itemID=5d417865c4c947d19a26a13c7d320323&center=43.524080, 5.445545&featureSourceURL=http://sampleserver5a.arcgisonline.com/arcgis/rest/services/LocalGovernment/Recreation/FeatureServer/0&featureAttributes={”quality”:2,“observed”:1502917218285}

This portion = the unique AGOL identifier for the Hosted Feature service "arcgis-collector://?itemID=5d417865c4c947d19a26a13c7d320323"
This is telling the Collector app to start the new feature at this coordinate pair "&center=43.524080, 5.445545"
This is telling collector which layer to start and write the information to; please note that the layer index at the end of the url "&featureSourceURL=http://sampleserver5a.arcgisonline.com/arcgis/rest/services/LocalGovernment/Recreation/FeatureServer/0"
These are the attributes being passed "&featureAttributes={”quality”:2,“observed”:1502917218285}"
Data field named "quality" and then the value to be written "2"
Data field named "observed" and then the value to be written (date in epoch time) "1502917218285"

Sorry that I cannot provide any further details or example currently as I have been playing catch up for the last month on a high priority project and developing these types of applications for our upcoming field season starting in less then a month.

Give it a shot and let me know if you are still having issue figuring things out.

Good Luck,

Mike

Re: Custom URL parameters passing value to Collector?

BrentKinal1 — Tue, 17 Apr 2018 13:53:26 GMT

Hi Scott,

I did finally figure this out. Basically you have to build the URL within a concat function. The hard part was figuring out all of the html encoding: here is the reference that helped with that:

HTML URL Encoding Reference

Basically I built a Geodabase in Pro with a relationship class built between the survey and the polygon feature and then uploaded it as a AGOL feature service. The relationship was built between a GUID created in Survey123 which is then passed to Collector using the custom URL:

Here is the final statement that I ended up with:

concat('<a href="arcgis-collector://?itemID=00x00xx0x0xx000x0x000000x00x0000&featureSourceURL=https://services6.arcgis.com/ZZZzzZz1zzZZ1zzz/arcgis/rest/services/SPB_S123v1/FeatureServer/2&featureAttributes=%7B%22surveyPointID%22:%22',${pointID},'%22%7D">Create Survey Polygon</a>')

Breaking it down:

'<a href=......</a>' = Hypertext reference

arcgis-collector://?itemID=00x00xx0x0xx000x0x000000x00x0000&featureSourceURL=https://services6.arcgis.com/ZZZzzZz1zzZZ1zzz/arcgis/rest/services/SPB_S123v1/FeatureServer/2 = web map id & polygon feature service url

featureAttributes=%7B%22surveyPointID%22:%22',${pointID},'%22%7D> = write value from Survey123 "pointID" to polygon field "surveyPointID"

translates to: featureAttributes={"surveyPointID""',${pointID},'"}>

Create Survey Polygon = hyper link text in Survey123

Let me know if you have any questions.

Re: Custom URL parameters passing value to Collector?

DougBrowning — Tue, 17 Apr 2018 14:39:47 GMT

Since there is a URL to the HFS in the call does the call work offline? Going from Collector to Survey123 does work offline - but from Survey123 to Collector I am not sure if it just uses the URL to figure out the right layer or if it is going out to the net for something?

Thanks

Re: Custom URL parameters passing value to Collector?

BrentKinal1 — Tue, 17 Apr 2018 15:03:14 GMT

If you download the webmap it does work offline.

Re: Custom URL parameters passing value to Collector?

Anonymous User — Mon, 21 May 2018 18:41:10 GMT

Brent,

I am just now getting around to this and I am having a hiccup with the process - I can launch a Survey123 form, fill it out, then tap on my hyperlink to transfer the information, Collector Opens up, but I am having an issue with getting the point to be placed and attributes transferred?

I wonder if it has to do with a unique display based on an attribute field; TlmtryPntType? DO I need to fully encode the answers that are being passed also? If so, then I'll need to add in some

Jeff Shaner or Craig Gillgrass‌ do you have any ideas on this one?

Here is my original concat () string below that I was going to use for my hyperlink from Survey123 into Collector to start a new feature and pass attributes. I have taken out the "identifiers" on purpose and replaced with a series of "X".

concat('<a href="arcgis-collector://?itemID=XXXXXXXXXXXXXXXXXXXXXXXX&center=',${lat},',',${lon},'&featureSourceURL=https://services3.arcgis.com/XXXXXXXXXXXXXX/arcgis/rest/services/2018_ESI_Mist_Net_Bat_Data/FeatureServer/2&featureAttributes={"ProjectNumber":',${ProjectNumber},'"TlmtryPntType":Telemetry Intermediate Point,"Date":',${FormDate},'"BatID_Freq_Srchd":',${BatFreq_Searching},'}">Link to Collector Telemetry Point</a>')

Here is my revised filly encoded; or possibly not, concat () string.

concat('<a href="arcgis-collector://?itemID=b0a360a4dc8749d9a0d88af86ceafdd5&center=',${lat},'%2C%20',${lon},'&featureSourceURL=https://services3.arcgis.com/pmvd6IDs5lq7p0BT/arcgis/rest/services/2018_ESI_Mist_Net_Bat_Data/FeatureServer/2&featureAttributes=%7B%22ProjectNumber%22:',${ProjectNumber},'%22TlmtryPntType%22:Telemetry%20Intermediate%20Point,%22Date%22:',${FormDate},'%22BatID_Freq_Srchd%22:',${BatFreq_Searching},'}">Link to Collector Telemetry Point</a>')

Any help would be greatly appreciated as I'm trying to implement this for my field crews this week.

Thank you in advance!

Mike

Re: Custom URL parameters passing value to Collector?

UriGilad_EsriAu — Wed, 12 Feb 2020 02:57:38 GMT

I wrote a simple script (attached) that produces the URL (mentioned in this post by Mike J Bruening and Brent Kinal) to match between the fields in your Survey123 form to a layer in a web map in Collector.

If you're already familiar with working with the URL just fill the csv file with your fields, change the variables in the script to match your data and run the script to get the URL.

For those who are not familiar, below is a step by step workflow to get the two apps talking to each other.

----------------------------------------------------------------------------------------------------------------

This methodology will allow you to enjoy the advantages of Survey123 in capturing form/text data, with the advantages of Collector in capturing geometries. This method also allows you to associate multiple geometries with one survey, which is impossible from Survey123.

It might seem like a long process but it's fairly straightforward and easy. Steps 1-4 should already be accomplished anyway if you published and used your survey.

Use:

Transfer Survey123 inputs into a feature's fields in collector.

Workflow:

Create a survey.
Note all the survey field names that you wish to write into the feature class attribute table (that will be created later in Collector).
Create a feature layer with matching fields into which the Survey123 data will be written to (field names can be different but make sure field types match). Make sure the feature class is editable.
Add the feature class into a web map and download to Collector. Only fields visible in the popup could be populated in later steps. Make sure in Settings page that you can open map in Collector.
In a CSV file, list the fields to match between the survey and the feature class (you can modify the attached CSV example).
Run the attached script (after filling lines 24-28 with your input: path to the CSV, web map ID, feature class url, and survey location field).
The script will produce a url (starting with <href...). Copy the URL into a new row in your survey (paste the url in the 'Label' column). This row will be a hyperlink that will open collector and populate all the fields with your survey data.
When you finish the survey click on this hyperlink. It will open Collector at the location of the survey and will allow drawing the feature with Collector, writing it into the specified layer. Fields from Survey123 will populate the feature layer fields in Collector.
Draw the feature in Collector and click submit to save to layer.
Go back to Survey123 and submit survey.

Note that this workflow will results in a point layer created by the survey in Survey123, in addition to the feature layer which is updated in Collector (which can be polygon/line/point).

Any comments/feedback is welcome,

Uri

Re: Custom URL parameters passing value to Collector?

Anonymous User — Tue, 23 Feb 2021 17:49:17 GMT

@UriGilad_EsriAu

Will this work if I want to pass survey123 data to an existing feature. Meaning I don't want to create a new feature in collector, I just want the survey to populate a field in an existing feature.

I'm doing a workflow for pump station inspections

Here's what I want to do:

1. User fills out Survey123 for the inspection of Pump Station A, which populates the related Inspection Table in a GDB. The user fills out the survey and records the gallons of Water Consumed.

2. At the end of the survey, I'd like them to be able to pass the gallons of Water Consumed to the pump station feature layer for Pump Station A in a field called "Latest Gallons Consumed"

Is that possible to do? or is it only possible to create a new feature?

Thanks,

Katie

Re: Custom URL parameters passing value to Collector?

UriGilad_EsriAu — Fri, 26 Feb 2021 00:23:52 GMT

Hi @Anonymous User,

Yes, it's possible. Look for this page for examples:

https://doc.arcgis.com/en/collector/android-phone/help/deploy-map.htm

Here is how it should look like - I color-coded the different components of this sample URL:

https://collector.arcgis.app?itemID=3ac4145c1ac44aea86e9ed42e00fbb0d&referenceContext=updateFeature&featureSourceURL=https//services9.arcgis.com/QjGvjfQhsHAmqfjP/arcgis/rest/services/DamageAssessment_Apr2018_631d0895e7d3404bb78e8e04e92d896e/FeatureServer/1&featureID=bb0a0c92-9f53-4367-a6a1-bc6edc605be0&featureAttributes=%7B%22incidentid%22:%22527%22,%22inspector%22:%22Frank%20Jones%22,%22inspdate%22:1502917218285%7D

So, if we compare it to the URL that is generated by the script, you need to remove

centre=${location}

and replace it with

referenceContext=updateFeature

Then, after the end of the feature source URL (in pink ...FeatureServer/1), you need to add the &featureID=GlobalID, where the feature's GlobalID is of the feature you're going to edit - pass it from your survey. This must be a GlobalID field. After this bit you specify &featureAttributes just like you would in the scripted URL. This is where you'll pass the gallons of Water Consumed.

Hope this helps,

Uri

If this answer solved your question or if you found it helpful please mark it accordingly to help others who have the same question.