Overview of the Historian System API

This document is intended to help in the development of C and C++ programs that interact with Historian at the System API level. With the System API you can develop programs that perform the following functions:
  • Create, browse, and modify tags of any data type including User Defined Data Types and array data types.
  • Read data as raw samples or using any sampling or calculation mode or filter condition or query modifier.
  • Write, delete, and replace data samples.
  • Get and Set server properties such as product version, archive size, or data store configuration.

Historian has different APIs based on the programming languages. Both the System API and the User API can be called using C or C++. The System API is used only when the User API does not meet your needs. The User API is more widely used and has greater version compatibility.

System API programs are fully capable but they are subject to Proficy Historian security so you will need to have an understanding of security within Historian.

Message and Alarm functions are not documented. However, for more information you can contact the Technical Support team at GE Intelligent Platforms.

The information that you need to write a collector is not included in the System API, but you can create programs that write data. Refer to the Collector Toolkit documentation if you need to write a collector.

Prerequisites

Programs created with the Historian System API must be run on a computer with at least the following software installed and configured:
  • Historian 5.5 Client Tools
  • Visual Studio .NET 2010

The Historian Client Tools are installed when the product is installed. You will be able to install the updates and bug fixes along with the product installation. Do not distribute Historian DLLs directly.

You will need a Data Archiver running locally or on another machine. That Data Archiver can be of any version of Historian. The Historian System API has been tested with Visual Studio .NET 2010. The Historian System API has no additional hardware requirements.
Note: The Historian version where your program is running should be the same as the version of the program you developed.