Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 2.21 KB

Readme.md

File metadata and controls

45 lines (28 loc) · 2.21 KB

AQUARIUS Time-Series Field Data Framework

Build status

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:

  • Download the latest FieldDataPluginTool.zip archive from here
  • Extract the archive on your AQTS app server
  • Run the FieldDataPluginTool.exe as Administrator
  • Click the "Add..." button and select your plugin file to install

See the FieldDataPluginTool page for full details.

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.

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.
  • The FieldDataPluginTool.exe tool, used by customers to install and manage field data plugins on their AQTS app servers.

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.