AdapterFramework.Data.DataModel 2.1.0

AVEVA Adapter Framework

The AVEVA Adapter Framework is a cross-platform, modular .NET framework for building Edge Data Store and AVEVA Adapter applications that collect data from various data sources and egress it to OMF (Open Message Format) endpoints, such as CONNECT data services and on-premises PI Server via PI Web API.

The framework is published as a set of composable NuGet packages that provide the runtime, abstractions, and supporting services needed to build, host, and operate adapters on modern .NET. Reference only the packages you need — each is designed to be used independently or together as part of a complete adapter host.

Features

• Adapter hosting and lifecycle management
• Common abstractions and base classes for building adapters
• Configuration, registry, component identity, and endpoint management
• Data buffering, compression, and durable persistent queueing
• Reliable OMF egress with failover and high-availability support
• Serialization, messaging, and message processing pipelines
• Structured logging, diagnostics, health monitoring, and data protection

Getting started

Install the packages you need from NuGet. For example, to implement and run a basic adapter:

dotnet add package AdapterFramework.Data.Framework.Abstractions
dotnet add package AdapterFramework.Data.Framework.AdapterCommon
dotnet add package AdapterFramework.Data.Framework.Host

Typical usage:

• Reference Abstractions and AdapterCommon to implement an adapter.
• Reference Host to compose and run the full adapter system.
• Add capability-specific packages (buffering, compression, failover, etc.) as your scenario requires.

See the package reference below for the capability each package provides.

Package reference

The AVEVA Adapter Framework is distributed as the following NuGet packages. All packages share the AdapterFramework.Data prefix and can be installed with dotnet add package <PackageName>.

Core

Configuration and identity

Messaging and data flow

Buffering and delivery

Diagnostics, logging, and security

Target framework

These packages target .NET 10.

Project and source

• Project site: https://github.com/AVEVA/adapter-framework
• Source repository: https://github.com/AVEVA/adapter-framework

License

Licensed under the Apache License, Version 2.0.

Copyright 2018-2026 AVEVA Group Limited

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

SPDX-License-Identifier: Apache-2.0

About AVEVA

AVEVA is a global leader in industrial software. For more information, visit https://www.aveva.com.