Welcome to the Adapter Framework

The Adapter Framework is a developer-focused toolkit for building and extending data connectivity to collect operational and industrial data and publish it in Open Message Format (OMF) for downstream consumption.

It provides a consistent foundation for taking data from various sources (devices, historians, files, protocols, APIs, edge applications) and converting it into OMF 1.2 or OMF 2.0 compliant messages, ready for ingestion into AVEVA PI Server, CONNECT, Edge Data Store, or any other OMF-compatible destination.

Being open source, the Adapter Framework makes it easier for developers to standardize how data collection applications are built and encourage collaboration across the community, so solutions evolve faster, are easier to validate, and can be reused across multiple projects and data sources.

Scope

This guide provides the information required to develop custom adapters using the Adapter Framework. It includes an overview of the framework, package and source code references, adapter development guidance, and a sample adapter.

Use this guide to understand framework capabilities, implement adapter functionality, and apply recommended development patterns when building adapters for supported OMF destinations.

Key Benefits

• Reduces development effort by providing built-in capabilities for configuration, logging, monitoring, security, and data delivery.  

• Expands connectivity coverage beyond the standard AVEVA Adapter portfolio.  

• Enables faster access to operational data from specialized or unsupported systems.  

• Allows customers to work with internal development teams or partners to address connectivity requirements without waiting for AVEVA-developed adapters.  

• Supports connectivity to AVEVA PI Server, CONNECT, and AVEVA Edge Data Store using the same framework technology used by AVEVA Adapters.