Survey123 Field Data Plugin

The Survey123 plugin is now obsolete

Please use the Tabular CSV Plugin instead, which can read CSVs intended for this plugin, plus many more.

See this example Tabular configuration which can parse the sample Survey123 form data.

Maintained for archive purposes only

An AQTS field data plugin for AQTS 2018.4-or-newer systems, which can read Survey123 survey results exported to CSV.

Want to install this plugin?

• Download the latest release of the plugin here
• Install it using the FieldVisitPluginTool

CSV file format

See the plugin documentation for CSV format and configuration information.

Requirements for building the plugin from source

• Requires Visual Studio 2017 (Community Edition is fine)
• .NET 4.7.2 runtime

Building the plugin

• Load the src\Survey123.sln file in Visual Studio and build the Release configuration.
• The src\Survey123\deploy\Release\Survey123.plugin file can then be installed on your AQTS app server.

Testing the plugin within Visual Studio

Use the included PluginTester.exe tool from the Aquarius.FieldDataFramework package to test your plugin logic on the sample files.

1. Open the HydstraGauging project's Properties page
2. Select the Debug tab
3. Select Start external program: as the start action and browse to "src\packages\Aquarius.FieldDataFramework.18.4.2\tools\PluginTester.exe
4. Enter the Command line arguments: to launch your plugin

/Plugin=Survey123.dll /Json=AppendedResults.json /Data=..\..\..\..\data\survey_123_sample.csv

The /Plugin= argument can be the filename of your plugin assembly, without any folder. The default working directory for a start action is the bin folder containing your plugin.

5. Set a breakpoint in the plugin's ParseFile() methods.
6. Select your plugin project in Solution Explorer and select "Debug | Start new instance"
7. Now you're debugging your plugin!

See the PluginTester documentation for more details.

Installation of the plugin

Use the FieldDataPluginTool to install the plugin on your AQTS app server.