nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Help with Survey123 link from Field Maps with callback to Field Maps

DavidHood_USFS

I'm trying to create a link to launch a survey123 survey with attributes passed from the selected feature in field maps and then use the callback to return to field maps and update an attribute on the feature that the survey was launched from. I've been reading ESRI's documentation at https://doc.arcgis.com/en/survey123/reference/integratewithotherapps.htm and https://doc.arcgis.com/en/field-maps/ios/help/deploy-your-map.htm along with posts here in the community but can't get the attributes to update with the callback and not sure what I'm missing. I'm using the Arcade content within the popup to add the link and I've attached my Arcade code below. It launches Survey123 and populates attributes in the Survey as I want and returns to field maps when the survey is submitted, but I can't get the attribute to update on the callback.

featureSourceURL is the url to the hosted feature service and the layer within that service is layer 0. I'm thinking this might be part of the problem as if I past the url into the browser I get a token required page, but I've tried generating a token and adding the token to the url and that broke the callback.

var S123 = "arcgis-survey123://?itemID=###"
var S123_Attributes = "&field:Stand_Habitat_Type={Stand_Habitat_Type}&field:incoming={GlobalID}"

var Callback = "&callback="
var CallbackFM = UrlEncode("https://fieldmaps.arcgis.app/?referenceContext=updateFeature")
var callbackID = UrlEncode("&itemID=###")
var callbackFeatureSource = UrlEncode("&featureSourceURL=https://services1.arcgis.com/###/arcgis/rest/services/AspenSurvey/FeatureServer/0")
var callbackFeatureID = UrlEncode("&featureID=")
var callbackFeatureGlobalID = UrlEncode($feature.GlobalID)
var callbackFeatureAttributes = UrlEncode('featureAttributes={"ConditionSurvey":"Yes"}')
var fullCallback = CallbackFM + callbackID + callbackFeatureSource + callbackFeatureID + callbackFeatureGlobalID + callbackFeatureAttributes
var fullURL = S123 + S123_Attributes + Callback + fullCallback

return { 
	type : 'text', 
	text : '<a href=' + fullURL + '>Open Survey with Callback</a>' 
}

Find more posts tagged with

Accepted answers

DavidHood_USFS

Thanks again for the help Doug. I was able to get this working with some help from another coworker and wanted to share what I did in case anyone else has similar issues.

Confirgure popups for the layer and go to Options > Attribute Expressions. I created a new expression with the code below. I then used the Add Content and added a text element to the popup and used the field for that expression to create the link. This didn't really change anything from what I had originally so not sure what exactly the problem was, but glad I got it working.

// To launch survey123 from map
// EDIT THIS LINK TO MATCH YOUR SURVEY LINK (Only edit AFTER itemID= and BEFORE &

var urlsource ="arcgis-survey123://?itemID=###&"
 
//Format globalid to "link" survey point to map data  -- MUST have globalid field for this script to work. DO NOT EDIT THIS LINE

var fglobalid = Mid($feature.GlobalID, 1,36)

//Generate other url parameters to pass to survey123. -- These are the values you wish to transfer from Field Maps to your Survey123 form.
// Edit or delete fields as necessary. The line containing $feature.GlobalID MUST NOT BE REMOVED, but the field to the left of $feature.GlobalID may
// be changed to reflect the field in your Survey to store the GlobalID.

var params = {
  "field:incoming": $feature.GlobalID,
  "field:Stand_Habitat_Type": $feature.Stand_Habitat_Type,  
};


// Create callback portion of link using itemID (map ID) and featureSourceURL (services link to the layer containing the feature to be edited following survey submission)
// EDIT THIS LINK FOR LNF MAP AND LNF POINT FEATURE CLASS.  updateFeature&itemID=<your maps ID>&featureSourceURL=<link to the feature class to be edited>

var callback = {
  callback:"https://fieldmaps.arcgis.app/?referenceContext=updateFeature&itemID=###&featureSourceURL=https://services1.arcgis.com/###/arcgis/rest/services/AspenSurvey/FeatureServer/0",

}

// // Add featureID (must be var fglobalid) portion of callback link
// THIS LINE MUST NOT BE CHANGED. This line is what tells the script which point in the feature class will be edited

var callbackid = "featureID=" + fglobalid


var callbackattribute = 'featureAttributes={"ConditionSurvey":"Complete"}'  // -- this would edit the ConditionSurvey field to reflect survey at the current point is complete


// Return the entire link/URL. This is what the FieldMaps app is following when you click the link to enter survey data. This should not be changed unless there is no callback
// attribute to pass back to Field Maps

return urlsource + UrlEncode(params) + "&" + UrlEncode(callback) + "%26" + UrlEncode(callbackid) + "%26" + UrlEncode(callbackattribute)


// For use in the pop-up for your featureclass, simply enter the expression name in the link field (i.e. {expression/expr0})

All comments

dougbrowning

These can be really hard.

The issue I had was the URL is static when made and cannot send back any new data which makes sense but you seem to have static data. I think I got away with no encoding but I do not remember.

This post may help you https://community.esri.com/t5/arcgis-field-maps-questions/is-it-possible-to-send-data-back-from-survey123-in/m-p/1062015

Good luck

DavidHood_USFS

Thanks Doug, I have read that previous post of your and the replies several times and was where I got some of my arcade script from. Yeah, I'm pulling attributes from data in the map and the link has those replaced properly when I check in within map viewer.

Though I just went to double check the link that is being created in Map Viewer and the FeatureID is properly populating with the features GlobalID, I did noticed the featureAttribute part is still showing up with the " in the URL (featureAttributes%3D%7B"ConditionSurvey"%3A"Yes"%7D) using the Arcade UrlEncode function so I tried manually encoding it then encoding it again and I'm able to rid of them but still not updating the feature as it appears should happen (featureAttributes%253D%257B%2522ConditionSurvey%2522%253A%2522Yes%2522%257D).

Here is the full URL (double encoded on the featureAttribute part) I'm getting, though I've redacted ItemID's with ## as well as part of the Feature URL: arcgis-survey123://?itemID=##&field:Stand_Habitat_Type=Talus&field:incoming=82cf6bd4-a4d6-43d7-a955-9ed42e2f1ea4&callback=https%3A%2F%2Ffieldmaps.arcgis.app%2F%3FreferenceContext%3DupdateFeature%26itemID%3D##%26featureSourceURL%3Dhttps%3A%2F%2Fservices1.arcgis.com%2F##%2Farcgis%2Frest%2Fservices%2FAspenSurvey%2FFeatureServer%2F0%26featureID%3D82cf6bd4-a4d6-43d7-a955-9ed42e2f1ea4featureAttributes%3D%7B%22ConditionSurvey%22%3A%22Yes%22%7D

dougbrowning

If I remember right I never got using fields to work in the callback but hardcoding like you did I think I did get one of these two to work. Trying to remember but I think when I did it I made the whole URL then encoded it on a website encoder then pasted that in the popup.

Maybe it will give you a hint. Sorry I do not know more.

arcgis-survey123://?itemID=9269d29cfc56ee345&field:LOCAL_ID={LOCAL_ID}&field:GeoGUID={globalid}&callback=https%3A%2F%2Ffieldmaps.arcgis.app%3FitemID%3D60898699d9194370985ba5d1b88ac966%26referenceContext%3DupdateFeature%26featureSourceURL%3Dhttps%3A%2F%2Fservices1.arcgis.com%2FHp6G80Pky0om7QvQ%2Farcgis%2Frest%2Fservices%2FPFCRCTest4%2FFeatureServer%2F0%26featureID%3D431c51d1-2570-4677-a13e-4a42d582cf66%26featureAttributes%3D%257B%2522LOCAL_ID%2522%3A%2522testhardcode%2522%2C%2522FormGUID%2522%3A%2522hardid%2522%257D

arcgis-survey123://?itemID=92656ee345&field:LOCAL_ID={LOCAL_ID}&field:GeoGUID={globalid}&callback=https%3A%2F%2Ffieldmaps.arcgis.app%3FitemID%3D60898699d9194370985ba5d1b88ac966%26referenceContext%3DupdateFeature%26featureSourceURL%3Dhttps%3A%2F%2Fservices1.arcgis.com%2FHp6G80Pky0om7QvQ%2Farcgis%2Frest%2Fservices%2FPFCRCTest4%2FFeatureServer%2F0%26featureID%3D431c51d1-2570-4677-a13e-4a42d582cf66%26featureAttributes%3D%257B%2522LOCAL_ID%2522%3A%2522testhardcode%2522%2C%2522FormGUID%2522%3A%2522hardid%2522%257D

Only thing I see is you have referenceContext then the itemid and I have itemid then referenceContext. I remember playing with that but not sure if that is it.

DavidHood_USFS

Thanks again for the help Doug. I was able to get this working with some help from another coworker and wanted to share what I did in case anyone else has similar issues.

// To launch survey123 from map
// EDIT THIS LINK TO MATCH YOUR SURVEY LINK (Only edit AFTER itemID= and BEFORE &

var urlsource ="arcgis-survey123://?itemID=###&"
 
//Format globalid to "link" survey point to map data  -- MUST have globalid field for this script to work. DO NOT EDIT THIS LINE

var fglobalid = Mid($feature.GlobalID, 1,36)

//Generate other url parameters to pass to survey123. -- These are the values you wish to transfer from Field Maps to your Survey123 form.
// Edit or delete fields as necessary. The line containing $feature.GlobalID MUST NOT BE REMOVED, but the field to the left of $feature.GlobalID may
// be changed to reflect the field in your Survey to store the GlobalID.

var params = {
  "field:incoming": $feature.GlobalID,
  "field:Stand_Habitat_Type": $feature.Stand_Habitat_Type,  
};


// Create callback portion of link using itemID (map ID) and featureSourceURL (services link to the layer containing the feature to be edited following survey submission)
// EDIT THIS LINK FOR LNF MAP AND LNF POINT FEATURE CLASS.  updateFeature&itemID=<your maps ID>&featureSourceURL=<link to the feature class to be edited>

var callback = {
  callback:"https://fieldmaps.arcgis.app/?referenceContext=updateFeature&itemID=###&featureSourceURL=https://services1.arcgis.com/###/arcgis/rest/services/AspenSurvey/FeatureServer/0",

}

// // Add featureID (must be var fglobalid) portion of callback link
// THIS LINE MUST NOT BE CHANGED. This line is what tells the script which point in the feature class will be edited

var callbackid = "featureID=" + fglobalid


var callbackattribute = 'featureAttributes={"ConditionSurvey":"Complete"}'  // -- this would edit the ConditionSurvey field to reflect survey at the current point is complete


// Return the entire link/URL. This is what the FieldMaps app is following when you click the link to enter survey data. This should not be changed unless there is no callback
// attribute to pass back to Field Maps

return urlsource + UrlEncode(params) + "&" + UrlEncode(callback) + "%26" + UrlEncode(callbackid) + "%26" + UrlEncode(callbackattribute)


// For use in the pop-up for your featureclass, simply enter the expression name in the link field (i.e. {expression/expr0})

LindsayRaabe_FPCWA

For those looking at the above solutions, here's my cutback version of the code provided which still passes attributes from the selected feature to the survey and does the callback, but without the portion of the code that updates the feature in FieldMaps after completing the survey (simply put, launches a survey but returns you to FieldMaps with the original feature selected but no edits occur).

Thanks @DavidHood_USFS for this code - it works a treat!

// To launch survey123 from map
// EDIT THIS LINK TO MATCH YOUR SURVEY LINK (Only edit AFTER itemID= and BEFORE &

var urlsource ="arcgis-survey123://?itemID=##############################&"
 
//Format globalid to "link" survey point to map data  -- MUST have globalid field for this script to work. DO NOT EDIT THIS LINE

var fglobalid = Mid($feature.GlobalID, 1,36)

//Generate other url parameters to pass to survey123. -- These are the values you wish to transfer from Field Maps to your Survey123 form.
// Edit or delete fields as necessary. 

var params = {
  "field:plantation": $feature.Field1,
  "field:compartment": $feature.Field2,  
  "field:stand": $feature.Field3,  
};


// Create callback portion of link using itemID (map ID)
// Only edit AFTER itemID=

var callback = {
  callback:"https://fieldmaps.arcgis.app/?referenceContext=open&itemID=################################",

}

// // Add featureID (must be var fglobalid) portion of callback link
// THIS LINE MUST NOT BE CHANGED. This line is what tells the script which point in the feature class will be selected

var callbackid = "featureID=" + fglobalid

// Return the entire link/URL. This is what the FieldMaps app is following when you click the link to enter survey data. This should not be changed unless there is no callback
// attribute to pass back to Field Maps

/// return urlsource + UrlEncode(params) + "&" + UrlEncode(callback)
return urlsource + UrlEncode(params) + "&" + UrlEncode(callback)

// For use in the pop-up for your featureclass, simply enter the expression name in the link field (i.e. {expression/expr0})

dougbrowning

One note - if you want to simply flip back to Field Maps all you have to do is this &callback=https://fieldmaps.arcgis.app and it will quickly flip back to the app. No need to specify a item or anything else. It just returns to whatever state it was and is fast.

For me I skip Arcade totally to build the URL and simply use a custom popup with HTML. I use Arcade to grab any data I want from a parent but other than that you can just reference the field you want then ref the the URL using {expression/expr13}. Also no need to Encode the URL. It works fine.

arcgis-survey123://?itemID=a44a3e1513ecf36567&field:PointID={PointID}&field:EvaluationID={expression/expr0}&field:CollectTNTP={expression/expr13}&field:CollectTurbidity={expression/expr14}&field:Project={Project}&field:ProtocolType={ProtocolType}&field:StreamName={expression/expr35}&callback=https://fieldmaps.arcgis.app

I am sure there may be times when you need Arcade for the URL but for most cases I just build them out in a text doc and then add the URL in the pop up. Been working for years now.

Hope that helps someone.

LindsayRaabe_FPCWA

Thanks for the additional tips. I have no HTML knowledge so the seemingly more convoluted Arcade method works for me (eventually). Learning as I go though so may try the HTML option soon! Will amend the callback based on your suggestion.

LindsayRaabe_FPCWA

Hi Doug. I've just been playing around with the HTML code you posted and I have 2 queries.

1. Does this need the GlobalID info referenced somewhere as per the Arcade version to link the features?

2. Do you know how to format it to appear nicely in the popup

For Example;

My URL

instead of;

arcgis-survey123://?itemID=a587781fd350430cadec4&field:plantation=Grimwade&field:compartment=2&field:stand=65&field:year_planted=1995&field:species=P.RAD&field:tenure=State Forest / Timber Reserve&field:AR_Cat=State&callback=https://fieldmaps.arcgis.app

dougbrowning

You use the custom popup and then the URL button like this. This is Map Viewer Classic but same concept in new map viewer.

I only create new features not edit. To edit yes you would need the globalid also. I think you can add this by using Arcade to just get the globlalid and add that to the URL using {expression/expr0} notation.

I do that a lot since I need to call from the child to the parent to get a number of fields I need that I then send to the form.

arcgis-survey123://?itemID=38e3353292dsfsdfsdfcb121a6&field:PointID={PointID}&field:EvaluationID={expression/expr0}&field:DesignLat={expression/expr6}&callback=https://fieldmaps.arcgis.app

The Arcade I use for the lookup to the parent is this below.

DesignLat {expression/expr6}
var tbl = FeatureSetByRelationshipName($feature, "Points", ['DesignLat'], false);
return First(tbl).DesignLat

But I think for you if you are in the linking feature just

return $feature.GlobalID should work.

Hope that helps

LindsayRaabe_FPCWA

Post edited after I sorted out most of my own issues by undoing other supposed "fixes" (see comments above about the MID function and globalID's).

I have managed to get my code working almost perfectly now. The only spot that I was getting stuck at and for which I've implemented a workaround, is passing back a date value to Field Maps instead of a text value to update the selected features attribute as done (instead of saying "Complete", it states when it was completed). Breif explanation of my code below, as I've extended it to use multiple fields from the source feature.

The source (launching) feature in Field Maps has multiple fields which are checked to see at what "stage" an inspection process is up to (happens at various stages over 2 years). These are checked to find the first empty value and that is used to populate the type of inspection being done.
This value is also used to then determine which date (now text) field should be edited upon callback to show that the corresponding inspection has been completed.
The selected features centroid coordinates are also returned and converted into Lat/Long and passed as a parameter to Survey123 for the geopoint location.

I couldn't for the life of me though figure out how to get the updateFeature section (Line 80) to work with a date value/field in Field Maps. I've change the fields to text and have now passed a string formatted as "my_username @ 2024-05-14 09:59 17.510" (Lines 45-47):

Below is the full code I have implemented.

// Calculate inspection number

var Inspection = IIF(IsEmpty($feature.insp_2_weeks)==True,"2 weeks",
IIF(IsEmpty($feature.insp_4_weeks)==True,"4 weeks",
IIF(IsEmpty($feature.insp_6_weeks)==True,"6 weeks",
IIF(IsEmpty($feature.insp_8_weeks)==True,"8 weeks",
IIF(IsEmpty($feature.insp_10_weeks)==True,"10 weeks",
IIF(IsEmpty($feature.insp_12_weeks)==True,"12 weeks",
IIF(IsEmpty($feature.insp_4_months)==True,"4 months",
IIF(IsEmpty($feature.insp_5_months)==True,"5 months",
IIF(IsEmpty($feature.insp_6_months)==True,"6 months",
IIF(IsEmpty($feature.insp_9_months)==True,"9 months",
IIF(IsEmpty($feature.insp_12_months)==True,"12 months",
IIF(IsEmpty($feature.insp_15_months)==True,"15 months",
IIF(IsEmpty($feature.insp_18_months)==True,"18 months",
IIF(IsEmpty($feature.insp_21_months)==True,"21 months","24 months"))))))))))))))

// Get matching inspection number field name

var InspFieldName = IIF(Inspection=="2 weeks","insp_2_weeks",
IIF(Inspection=="4 weeks","insp_4_weeks",
IIF(Inspection=="6 weeks","insp_6_weeks",
IIF(Inspection=="8 weeks","insp_8_weeks",
IIF(Inspection=="10 weeks","insp_10_weeks",
IIF(Inspection=="12 weeks","insp_12_weeks",
IIF(Inspection=="4 months","insp_4_months",
IIF(Inspection=="5 months","insp_5_months",
IIF(Inspection=="6 months","insp_6_months",
IIF(Inspection=="9 months","insp_9_months",
IIF(Inspection=="12 months","insp_12_months",
IIF(Inspection=="15 months","insp_15_months",
IIF(Inspection=="18 months","insp_18_months",
IIF(Inspection=="21 months","insp_21_months","insp_24_months"))))))))))))))

// Get centroid Lat and Long

var originShift = 2.0 * PI * 6378137.0 / 2.0;
var lon = (Centroid($feature).X / originShift) * 180.0;

var lat = (Centroid($feature).Y / originShift) * 180.0;
lat = 180.0 / PI * (2.0 * Atan( Exp(lat * PI / 180.0)) - PI / 2.0);

// Generate callback attribute

var user = GetUser($layer).username
var date = left(Date(),10)
var cbvalue = user + " on " + date

// Source: https://community.esri.com/t5/arcgis-survey123-questions/help-with-survey123-link-from-field-maps-with/td-p/1306591

// To launch survey123 from map
// EDIT THIS LINK TO MATCH YOUR SURVEY LINK (Only edit AFTER itemID= and BEFORE &

var urlsource ="arcgis-survey123://?itemID=b40c1e4d99084cbca8170ff273c74977&"
 
//Format globalid to "link" survey point to map data  -- MUST have globalid field for this script to work. DO NOT EDIT THIS LINE

var fglobalid = Mid($feature.GlobalID, 1,36)

//Generate other url parameters to pass to survey123. -- These are the values you wish to transfer from Field Maps to your Survey123 form.
// Edit or delete fields as necessary. The line containing $feature.GlobalID MUST NOT BE REMOVED, but the field to the left of $feature.GlobalID may
// be changed to reflect the field in your Survey to store the GlobalID.

var params = {
  "field:plantation": $feature.Plantation,
  "field:years_planted": $feature.PlantingYear,  
  "field:tree_species": $feature.Species,  
  "field:tenure": $feature.RENDER_LABEL, 
  "field:inspection_number": Inspection, 
};

// Get map center coordinates

var center = concatenate([lat,lon],",")

// Create callback portion of link using itemID (map ID) and featureSourceURL (services link to the layer containing the feature to be edited following survey submission)
// EDIT THIS LINK FOR MAP AND FEATURE SERVICE.  updateFeature&itemID=<your maps ID>&featureSourceURL=<link to the feature class to be edited>

var callback = {
  callback:"https://fieldmaps.arcgis.app/?referenceContext=updateFeature&itemID=##############&featureSourceURL=https://services3.arcgis.com/############/arcgis/rest/services/#################/FeatureServer/0",
//var callback = {callback:"https://fieldmaps.arcgis.app",

}

// // Add featureID (must be var fglobalid) portion of callback link
// THIS LINE MUST NOT BE CHANGED. This line is what tells the script which point in the feature class will be edited

var callbackid = "featureID=" + fglobalid

var callbackattribute = 'featureAttributes={"' + InspFieldName + '":"' + cbvalue + '"}'


// Return the entire link/URL. This is what the FieldMaps app is following when you click the link to enter survey data. This should not be changed unless there is no callback
// attribute to pass back to Field Maps

/// return urlsource + UrlEncode(params) + "&" + UrlEncode(callback) + "%26" + UrlEncode(callbackid) + "%26" + UrlEncode(callbackattribute)
return urlsource + UrlEncode(params) + "&center=" + UrlEncode(center) + "&" + UrlEncode(callback) + "%26" + UrlEncode(callbackid) + "%26" + UrlEncode(callbackattribute)

// For use in the pop-up for your featureclass, simply enter the expression name in the link field (i.e. {expression/expr0})

Join the Conversation

Signed in members can post, follow updates, and more. New here? Register a free account.

Quick Links

Community Help
Find useful guides, FAQs, and documents to help you navigate and make the most of Esri Community.