NextGen Archiver Backend-API

This document provides step by step instructions on how to build and run a custom backend and describes the NGA backend architecture.

The NGA Backend API provides a C++ interface for integrating databases that are not natively supported by WinCC OA into the NextGen Archiver framework. By implementing the defined backend interface, you can use any database technology as the storage layer for historical process data.

Key capabilities

  • Implement read and write handlers for custom database technologies
  • Manage metadata such as archive groups, elements, and segments
  • Support different work modes (in-process, out-of-process, direct read)
  • Integrate with the NGA redundancy framework
  • Handle database activity monitoring and lifecycle management

Use cases

Use the NGA Backend API when you need to connect a database system (e.g., a time-series database or cloud storage) that is not yet available as a built-in NGA backend.

Important:
Implementing a full read/write backend is a substantial development effort that may require several hundred hours.

All sub chapters referenced in the following contents are referring to System Management -> Database -> NextGen Archiver (NGA). The NGA API is included in the WinCC OA API package setup. For the architecture, backend and segment management, see the chapters:

Important:
This documentation is only intended for experienced users with programming knowledge. As this documentation uses code examples to describe how to create and operate a user-defined backend. Also note the requirements in the chapter API development.