AQUARIUS Time-Series Field Data Framework

The Field Data Framework for AQUARIUS Time-Series provides an SDK which can be used to develop custom field visit file parsers to work with AQUARIUS Time-Series 2017.4-and-higher.

Need to install a plugin on your AQTS app server?

If you find yourself here because you need to install a plugin on your server, then you should use the System Config page to install the plugin.

Many plugins come pre-installed, and simply need to be enabled using the System Config page.

You can skip reading the remaining sections below, since they are intended for software developers using the framework to developer their own custom field data plugins.

Useful tools ready for download

Each release of the framework also includes some tools useful to AQTS customers, without requiring any programming knowledge.

• The FieldVisitHotFolderService is a Windows service which can import field visit files dropped into a monitored hot folder.
• The JSON field data plugin can import field data stored in a JSON format. It is often used with the hot folder service.
• The Multi-file plugin can import a ZIP archive of files supported by other installed plugins.

Installing the framework SDK

This framework is available as a NuGet package.

PM> Install-Package Aquarius.FieldDataFramework

Adding the Aquarius.FieldDataFramework as a dependency to your .NET project will install:

• The FieldDataPluginFramework assembly, which contains the IFieldDataPlugin interface every plugin must implement.
• The PluginTester.exe tool, useful for testing your plugin from within Visual Studio.
• The PluginPackager.exe tool, used during a build process to package your plugin into a single *.plugin file for easy deployment.

Documentation

A developer guide is available here.

Getting Help

See the Wiki for answers to common questions.

Contributing

Contributions are always welcome, no matter how large or small. Before contributing, please read the code of conduct.

See Contributing.