Skip To Content

Quick reference

An intuitive and versatile data gathering tool, Survey123 for ArcGIS makes collecting data in the field straightforward. After a survey is designed in Survey123 Connect, downloading and using it in the Survey123 field app is a matter of a few steps. This quick reference guide covers all the essential details of the Survey123 field app, allowing you to use it to its fullest in collecting data.

My Surveys

When starting the Survey123 field app and signing in with your ArcGIS organizational account, the app opens to the My Surveys page. This is the table of contents for all of your currently installed surveys, although it will be empty on first launching the app. Note that, once there is a survey downloaded onto your device, you will no longer need to sign in at launch.

My Surveys page

To access the menu for a particular form, select its icon. Numbers in the corner of a survey's icon indicate unfinished or unsent results. If one has unfinished draft entries, the number of them will be listed in an orange circle, while the surveys queued to be sent later are numbered in a green circle. If a survey has inbox editing enabled, the amount of downloaded surveys in the inbox are numbered in a blue circle.

Us the Menu Menu at the upper-right to access the Download Surveys page, sign in with your ArcGIS organizational account, or view settings.

Download Surveys

On the Download Surveys page, all surveys currently available to your account are listed alphabetically. In the following screen shot, the bottom survey has been downloaded, evidenced by Download Download being replaced by Refresh Refresh.

Download Surveys page

To download a new survey, press either Download Download or the survey name. Choosing Refresh Refresh on a downloaded survey will replace the locally saved survey with the latest update. You can also open a downloaded survey directly from this page by pressing the survey name.

Survey contents

The survey contents page can be accessed by selecting a survey from My Surveys. Here, you can start collecting new data or access previously collected surveys.

Survey contents page

The options on this page are as follows:

  • Collect—Opens a new, blank survey page for inputting data.
  • Drafts—Opens to a form currently left uncompleted by closing the survey before sending it.
  • Outbox—Opens to a listing of all forms finished but unsent, either by choice or due to the device being offline when submitting.
  • Sent—Contains the records of all forms submitted to the survey's creator.
  • Inbox—Opens to an inbox of responses within the feature service. This is only present if Inbox has been enabled. For more information, see edit existing survey data.
The Menu Menu at the upper right contains the options to delete the survey from your device and to download an associated basemap (if this choice is not available, the survey has no basemap associated with it).

The Drafts, Outbox, and Sent pages have similar layouts, with standardized buttons and functions. The following screen shot is of the Outbox page, but be aware that all three pages look and behave similarly:

Outbox page

The options on these pages are as follows:

  1. Press the field for the form to reopen it. On the Sent page, this instead opens a copy of the form and its answers. The text in this field defaults to the raw data of the survey. To replace it with something else, see instance names.
  2. The Send Surveys button on the Outbox page submits all forms currently listed within it. This button does not exist on the Sent page; however, the Sent page instead has an Empty Sent Surveys button, which clears the listing of all sent forms. It does not delete the surveys from their destination. There is no equivalent button on the Drafts page.
  3. Delete Delete deletes the form from the device. This button is not present on the Sent page.

Survey

On the individual survey page, you can fill in the data requested by the survey's creator. Surveys are modular and designed for specific purposes, so the actual layout and presentation will vary from survey to survey. However, the Menu button Menu and its contents remain the same throughout.

Survey menu

Favorites

To create a set of favorite answers that you can reuse, first complete a survey with your preferred answers, then open the Menu Menu and select Set as favorite answers (1a) before submitting it. This saved survey will now be marked with a star icon in the Sent list, and the Paste answers from favorite option (1b) will become visible. This menu option will apply your favorite answers to the current survey automatically.

Note:

Favorite answers are saved as a marker on the sent survey, signified by a gold star on their entry on the Sent page. If this survey is deleted from your device, the favorite answers will also be deleted.

Languages

If the survey has more than one language assigned to it, the additional languages will appear as options in the menu (2). Select the preferred language to translate the questions and labels in your survey (where translations have been provided). For more information, see Multiple language support.

Geopoint questions

Geopoint questions have two forms of presentation. Initially, they are represented by a location panel on the form. When you press the location panel, it expands into a full-screen map with additional locating functions. You can capture a point on either the location panel or the full-screen map.

Geopoint question by default

The Location Averaging button Location Average at the top right of the location panel captures an average of locations rather than a single result when it's pressed. This can also be used with an accuracy threshold to ensure only reliable results can be used. For more information, see Geopoints.

When you tap the location panel, it expands to a full-screen map.

Geopoint entry page
  1. The geosearch bar allows you to locate an address or point of interest by searching for it, before snapping your geopoint and map to that location. The globe icon next to the search bar provides options to limit the extent of the geosearch capability, and to change the geocoder being used. For more information, see Geosearch and geocode.
  2. The Menu button Menu provides a number of alternative basemaps to the default, for a range of different purposes. This is also where any directly associated basemaps can be selected.
  3. Home Home returns the map marker to where the survey creator has defined a home location. If no home location has been defined, it instead returns the marker to the user's location.
  4. The Location icon Location starts displayed in black, indicating the location sensor is disabled. Select the button to switch to Navigation Navigation mode, enabling Location and tracking the device's current location. Moving the map marker from here, either directly on the map or by changing the coordinates, still changes the location and coordinates of the answer, but the device's location remains visible as a pulsing blue dot while doing so. When this happens, the button switches to an Active Location icon Active Location; select it to return to Navigation Navigation.
  5. The coordinates of your current location are listed here, using whatever coordinate format that has been set for that survey in Survey123 Connect. Pressing the area copies the location coordinates into the geosearch bar, allowing you to define a different location. Altitude will also be included here if it has been enabled for the question; for more information, see Geopoints. In addition, pressing and holding on these coordinates will perform a reverse geocode to give you the location, placed above the coordinates. As with the coordinates, pressing the location will copy it into the geosearch bar.

Settings

Accessed from the Menu Menu on the app's initial page, Settings contains a number of options and choices to customize the Survey123 field app to your preference.

Text settings

Text scale settings

The slider on the Text tab allows you to alter the scale of text within the app, up to 200 percent of the default. The text preview updates in real time to display the currently selected scale.

Map settings

Designate the Map Library Folder, from which the app will pull offline basemaps. The Map Library can be accessed within the app through the Menu button Menu in the Settings pages.

Advanced Settings

  • Reinitialize Database returns the device's survey database to the default; all surveys, complete or incomplete, are deleted, and the submitted surveys list is cleared.
  • Fix Database fixes the existing entries in the survey database on your device when the folder path for the database has changed. This is required when you update the version of the Survey123 field app on iOS from the App Store. When the app is updated, its location on the device changes. Fixing the database ensures the new folder path is used for existing records. This tool is also useful if you want to copy a database from one device to another to send records. After copying the .sqlite database from one device to another, click Fix Database on the destination device to fix the data paths. For additional details, see Recover data from a mobile device.
  • Delete Submitted Surveys clears the submitted surveys list for all surveys saved onto the device.
  • Clear Map Cache deletes the cache of map tiles that surveys have loaded. The button also lists the current size of the cache on the device.

Diagnostic settings

The Diagnostics tab provides you with a way to log information to a file, or a console on the network or online. For more information, see Troubleshoot.