There are typically two components of ArcGIS Survey123 to install: Survey123 Studio or Survey123 Connect on a desktop to create surveys, and Survey123 Mobile or the Survey123 field app on a device to collect survey data.
The Survey123 website (which includes the web designer and web app) can be used without installation; however, some organizations may choose to install the Survey123 website alongside a deployment of ArcGIS Enterprise to support a disconnected environment.
Install Survey123 Studio
Survey123 Studio is available from the Microsoft Store. You can install Survey123 Studio directly onto your device from this store.
You can also download the Survey123 Studio installation file for Windows from the Survey123 Downloads page.
To install the download only for the current user, double-click the file, and click Install. If a previous version of Survey123 Studio is already installed, you are prompted to click Update. If you need to install the app for all users on the computer, you can use the Microsoft PowerShell Add-ProvisionedAppPackage command.
The application files are in the following location on Windows: C:\Program Files\WindowsApps. Typically, you will not browse to these files. If you want to uninstall Survey123 Studio, click Settings > Apps > Installed Apps > ArcGIS Survey123 Studio, and choose Uninstall.
Survey data files are in the following location on Windows: C:\Users\<username>\Documents\ArcGIS\Survey-Studio.
Note:
Survey123 Studio can be installed side by side with Survey123 Connect.
Install Survey123 Mobile
The Survey123 Mobile app is available from Google Play, the App Store, and the Microsoft Store. You can install Survey123 Mobile directly onto your device from these stores.
You can also download the Survey123 Mobile installation files for Windows or Android from the Survey123 Downloads page.
On Windows, to install the download only for the current user, double-click the file, and click Install. If a previous version of Survey123 Mobile is already installed, you are prompted to click Update. If you need to install the app for all users on the computer, you can use the PowerShell Add-ProvisionedAppPackage command.
On Android, you must first run the desktop executable on Windows to get the APK file. The APK file can then be copied to an Android device for installation, or installed using an MDM.
The application files are in the following location on Windows: C:\Program Files\WindowsApps. Typically, you will not browse to these files. If you want to uninstall Survey123 Mobile, click Settings > Apps > Installed Apps > ArcGIS Survey123 Mobile, and choose Uninstall.
Survey data files are located in the following places:
- Windows—C:\Users\<username>\Documents\ArcGIS\Survey123-Mobile
- Android—Android/data/com.esri.survey123.mobile/files (The device must be connected to a desktop PC, and a PC file browser must be used to locate these files.)
Note:
Data files are not accessible on iOS because the app does not request permission to access local files for privacy.
Survey123 Mobile can be installed side by side with the Survey123 field app.
Install Survey123 Connect
Survey123 Connect is available from the Microsoft Store. You can install Survey123 Connect directly onto your device from this store.
You can also download the Survey123 Connect installation file for Windows from the Survey123 Downloads page.
To install Survey123 Connect, double-click the file to install, and do the following:
- Click Next.
- Choose the installation folder (the default is preferred).
- Accept the license agreement.
- Nominate the start menu name.
- Click Install.
The application files are in the following location on Windows: C:\Users\<username>\Applications\ArcGIS\ArcGISSurvey123Connect.
Typically, you will not edit these files. If you want to uninstall Survey123 Connect, browse to this folder, and choose Uninstall ArcGISSurvey123Connect.
Survey data files are in the following location: C:\Users\<username>\ArcGIS\My Survey Designs.
Note:
If a previous version of Survey123 Connect is already installed, a prompt appears asking if you want to continue.Install the Survey123 field app
The Survey123 field app is available from Google Play, the App Store, and the Microsoft Store. You can install Survey123 directly onto your device from these stores.
You can also download the Survey123 field app installation file for Windows and Android from the Survey123 Downloads page, and install it in the same way as Survey123 Connect.
Once the installation is complete, a desktop shortcut named Survey123 is created. The installation location for all Survey123 field app files on the desktop is the same as for Survey123 Connect.
Survey data files are located in the following places:
- Windows—C:\Users\<username>\ArcGIS
- iOS—On My iPad/Survey123/ArcGIS or On My iPhone/Survey123/ArcGIS
- Android—Android/data/com.esri.survey123/files/ArcGIS (The device must be connected to a desktop PC, and a PC file browser must be used to locate these files.)
Note:
On Windows, if a previous version of the Survey123 field app is already installed, a prompt appears asking if you want to continue. On Android and iOS, previous versions of the Survey123 field app will automatically be overwritten.Unattended installation and uninstallation
Survey123 Studio and Survey123 Mobile can be installed and uninstalled using PowerShell commands.
Survey123 Connect and the Survey123 field app can be installed and uninstalled using provided script files.
Survey123 Studio and Survey123 Mobile
Survey123 Studio and Survey123 Mobile are provided as MSIX files for Windows, and you can use the PowerShell commands below to install and uninstall.
To install when the file name is the file you downloaded, use Add-AppxPackage -Path "C:\Downloads\Survey123-Mobile_x64_26.1.0.100.msix".
To uninstall, use the following:
- Survey123 Studio—Get-AppxPackage -Name "Esri.ArcGISSurvey123Studio*" | Remove-AppxPackage
- Survey123 Mobile—Get-AppxPackage -Name "Esri.ArcGISSurvey123Mobile*" | Remove-AppxPackage
Survey123 Connect and the Survey123 field app
When you install Survey123 Connect or the Survey123 field app on Windows, you're also provided with script files to help perform future unattended installations or uninstallations.
To prepare for these actions, complete the following steps after first installing the app on one device, using Survey123 Connect as an example:
- Browse to the location where the app was installed, which, by default on Windows, is C:\Users\<username>\Applications\ArcGIS\ArcGISSurvey123Connect.
- Copy the following files to another location on your device, a network folder, or USB drive. For example, create a folder named InstallScripts on your desktop.
- silent-install-controller.qs
- silent-uninstall-controller.qs
- silent-uninstall-install-ArcGISSurvey123Connect
- When the time comes to install a new version of Survey123 Connect, copy the app installation file to your created InstallScripts folder, and rename the file to a name that will remain constant, for example, Survey123ConnectInstallFile.exe.
Once this location has been established, the .qs and script files don't change. To perform unattended installations and uninstallations, only the installation files will need to change.
If you have multiple apps that are based on AppStudio on your computer, you only need one copy of silent-install-controller.qs and silent-uninstall-controller.qs. Copy only the different silent-uninstall-install-appName script files to your created InstallScripts folder alongside the .qs files.
By default, the unattended installation and uninstallation will be performed in the background, with no user interface to show progress. To display a user interface for these unattended installations and uninstallations, add the command line parameter showui=true when running the script files.
Note:
If your scripts are from a version earlier than Survey123 3.10, update your scripts to the latest version to ensure that hiding the interface is the default behavior.
To uninstall the app using these scripts, browse to your created InstallScripts folder in a command window and enter the following command:
silent-uninstall-install-ArcGISSurvey123Connect.bat .
The period at the end is important, as it indicates that nothing will be installed.
To install the app, browse to your created InstallScripts folder in a command window and enter the following command:
silent-uninstall-install-ArcGISSurvey123Connect.bat Survey123ConnectInstallFile.exe
The same command uninstalls all existing versions of the app before installing the new version, allowing you to upgrade the app with one command.
Install the Survey123 website
The Survey123 website can be installed alongside a deployment of ArcGIS Enterprise to support a disconnected environment, or for organizations to host the website on their own infrastructure. The following are included in the installation:
- Survey123 website for management of surveys and viewing of survey results
- Survey123 REST API to convert survey configurations (.xlsx files) to forms for use in the Survey123 field and web apps
The file required to install the Survey123 website is downloaded from My Esri and can be installed on the same machine as your Portal for ArcGIS instance or on a stand-alone web server. A system administrator should perform the following:
- Install the downloaded files.
- On Windows, unzip the downloaded file to the machine where you want to install the Survey123 website, run setup.exe, and complete the wizard installation steps.
- On Linux, extract the contents of the .tar.gz file on the machine where you want to install the Survey123 website using the command gunzip [filename].tar.gz followed by tar xf [filename].tar in Terminal. Once extracted, run ./Setup in Terminal, and complete the wizard installation steps.
- Run the postinstallation utility and complete the questions. Depending on the authentication method your deployment uses, this step differs. Full details are described in the How To: Install and configure the ArcGIS Survey123 website Knowledge Base article.
- ArcGIS Enterprise with built-in authentication—Launch the wizard at https://localhost:5443/share/post-install.html.
- ArcGIS Enterprise with IWA authentication (on same host URL)—Launch the wizard at https://webadaptorhost.domain.com:5443/share/post-install.html (where webadaptorhost and domain are replaced with information about your server).
- ArcGIS Enterprise with IWA authentication (on different host URL)—Follow manual postinstallation steps in the How To: Install and configure the ArcGIS Survey123 website Knowledge Base article.
Note:
If you receive a security warning in your browser, accept the warning and continue to the web page to complete the postinstallation steps. The postinstallation steps address the warning.
- Click Submit to complete the following:
- Update the config.json file.
- Import your certificate files to the ~\ArcGIS\Survey123website\server\cert\ folder.
- Append your Survey123 enterprise host URL as a redirect URI to the survey123hub AppID.
For more information, see the following related Knowledge Base articles: