An AQTS field data plugin supporting eHSN (electronic Hydrometric Station Notes) files from Water Survey Canada.
- Requires Visual Studio 2017 (Community Edition is fine)
- .NET 4.7 runtime
- Install it on AQTS 2019.2-or-newer via the System Configuration page
Choose the appropriate version of the plugin for your AQTS app server.
| AQTS Version | Latest compatible plugin Version |
|---|---|
| AQTS 2021.3.Update 1+ | v21.3.0 |
| AQTS 2020.3+ | v20.3.1 |
| AQTS 2020.2 AQTS 2020.1 AQTS 2019.4 AQTS 2019.3 AQTS 2019.2 |
v19.2.26 |
The plugin can be configured via a Config.json JSON document, to control the mapping of eHSN values to your AQTS app server.
The configurable values include:
- Parameter IDs, unit IDs, and monitoring method codes for various sensors
- Configurable picklist values. Values can be mapped to either the
List Item ID(eg."Ice": "IceCover") or theList Item Name(eg."Ice": "Ice - Cover").
The JSON configuration is stored in different places, depending on the version of the plugin.
| Version | Configuration location |
|---|---|
| 20.2.x+ | Use the Settings page of the System Config app to change the settings. Group: FieldDataPluginConfig-EhsnKey: ConfigValue: The entire contents of the Config.json file. If blank or omitted, the plugin's default Config.json is used. |
| 19.2.x | Read from the Config.json file in the plugin folder, at %ProgramData%\Aquatic Informatics\AQUARIUS Server\FieldDataPlugins\EhsnPlugin\Config.json |
Quite possibly not.
The default behavoir of the EHSN plugin is to assume the same configuration as the WSC AQUARIUS Time Series system. If your agency uses the same settings as WSC, then you won't need to configure anything.
If you install the EHSN plugin on your AQTS app server and can successfully import an EHSN XML file, then no configuration changes are needed.
If an EHSN XML file fails to import into your AQTS app server, then some configuration changes will likely be required.
The likely items which may need to be configured are:
- StageLoggerMethodCode and Voltage.SensorMethodCode
ParameterIdvalues for the KnownSensors list.- Picklist mappings for the KnownControlConditions list.
- Load the
src\eHSN.slnfile in Visual Studio and build theReleaseconfiguration. - The
src\EhsnPlugin\deploy\Release\EhsnPlugin.pluginfile can then be installed on your AQTS app server.
Use the included PluginTester.exe tool from the Aquarius.FieldDataFrame package to test your plugin logic on the sample files.
- Open the EhsnPlugin project's Properties page
- Select the Debug tab
- Select Start external program: as the start action and browse to
"src\packages\Aquarius.FieldDataFramework.20.2.0\tools\PluginTester.exe - Enter the Command line arguments: to launch your plugin
/Plugin=EhsnPlugin.dll /Json=AppendedResults.json /Data=..\..\..\..\data\05BG006_20170609_FV.xml
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.
- Set a breakpoint in the plugin's
ParseFile()methods. - Select your plugin project in Solution Explorer and select "Debug | Start new instance"
- Now you're debugging your plugin!
See the PluginTester documentation for more details.