ichivite-esristaff

Launching QuickCapture from Survey123

Blog Post created by ichivite-esristaff Employee on Apr 15, 2020

In this post I will describe, step by step, how to launch ArcGIS QuickCapture from the Survey123 field application.  The animation below illustrates the basic concept where a user launches the Survey123 field app, and then through a link launches QuickCapture.   The link sets the target project to be opened in the QuickCapture app and optionally a value to be passed to the project user input.

 

 

There are two basic aspects to all of this: 1) Understanding the syntax for launching QuickCapture from a link and 2) Understanding how to dynamically create a link within a Survey123 survey. The good news, is that both of these things are very easy to do!

 

How to launch QuickCapture from a link

 

ArcGIS QuickCapture, like many other apps in your mobile device, can be launched from a link. The syntax for your link is straight-forward. The following shows the basics for opening a new project and passing a value to the project user input:

 

arcgis-quickcapture://?itemId=<your project item id>&projectInput:<your user input>=<the value you want to pass>

 

To construct the URL as shown above, you can follow these steps:

 

  • Login into QuickCapture designer and open your project in edit mode.
  • Now, get the itemId of your QuickCapture project from the browser address. In the screenshot below the itemId is highlighted in red.  Make sure you do not include the / slashes at the end and beginning.

 

 

  • If you want to also pass a project user input, you obviously need to configure your project user input first in QuickCapture designer. There is plenty about that in Understanding User Inputs in ArcGIS QuickCapture 
  • The name of your user input is essentially its label. Below I highlight where in designer you can get this value. Note that your user input can have spaces in the name.

 

With that, you will have your complete link to get things going. Take the link and test it from your mobile device. In fact, if simply want to do a quick test from your computer, you can trigger your link from your Windows web browser as long as you have the QuickCapture app for windows installed. Sorry if you are running a Mac.

 

To learn more about all the things you can do with QuickCapture links, have a look at: Integrate with other apps—QuickCapture | Documentation 

 

 

How to include a link within a survey

 

Now we are going to include your link within a Survey123 form, and also describe how you can manipulate the link dynamically, to include information from your responses in your survey. This section, by the way, assumes you already know how to work with Survey123 Connect and XLSForm.

 

  • Go into Survey123 Connect and open your survey. In the XLSForm, start by adding a note type of question and wrap your link within an HTML link tag. For example:

 

typenamelabel
texttrailnameEnter a value here
note <a href="arcgis-quickcapture://?itemId=1cf9606a97d0451e83a600ccb5691ef3&userInput:Trail Name=Santa Ana River Trail">QuickCapture link</a>

 

  • Give it a go to try things out.  You can even try from your computer if ArcGIS QuickCapture is installed locally.
  • Next, we are going to dynamically change the value passed in the user input by using an XLSForm variable replacement.

 

typenamelabel
texttrailnameEnter a value here
note <a href="arcgis-quickcapture://?itemId=1cf9606a97d0451e83a600ccb5691ef3&userInput:Trail Name=${trailname}">QuickCapture link</a>

 

There is not much to this. You are now good to go!

Outcomes