Proficy* Historian - GE Intelligent Platforms: Support Home

Proficy* Historian - GE Intelligent Platforms: Support Home

Proficy Historian Getting Started Guide

comparison modes are:

AllBitSet (^) comparison mode returns True when the binary value of the Filter Tag is equal to all the bits in the condition.

AnyBitSet (~) comparison mode returns True when the binary value of the Filter Tag is equal to any of the bits in the condition.

AnyBitNotSet (!~) comparison mode returns True when the binary value of the Filter Tag is not equal to any one of the bits in the condition.

AllBitNotSet (!^) comparison mode returns True when the binary value of the Filter Tag is not equal to all the bits in the condition.

For more information, refer to the Using Filter Expression topic in the Advanced Topics e-book.

New Sampling Mode

Proficy Historian now gives you a new sampling mode which can be used on retrieval of data that has already been collected in the arhive.

RawByFilterToggle sampling mode is a form of filtered data query. A filtered data query returns data values for a particular time period whereas RawByFilterToggle sampling mode returns the time periods where the condition becomes TRUE or FALSE.

For more information, refer to the Sampling Modes topic in the Advanced Topics e-book.

Overview of Historian

Proficy Historian is a high performance data archiving system designed to collect, store, and retrieve time-based information at extremely high speed efficiently. The system architecture consists of the following:

Historian Server: The Historian server is the central point for managing all of the client and collector interfaces, storing and (optionally) compressing data and retrieving data. All tag data (numbers, strings, BLOBs) are stored in a proprietary format in the archive database. The Archive Database consists of several files, each of which represents a specific time period of historical data.

If licensed for the ”Alarm and Event” option then the server also manages the storage and retrieval of OPC alarms and events in a SQL Server SQL Server Express.


Getting Started with Historian

Collectors: The Historian includes several types of data collectors for collecting data from a wide variety of applications including: iFIX, Proficy Machine Edition, OPC, OPC Alarms & Events, Text Files (csv or xml), and OSI PI.

NOTE: To collect data from a CIMPLICITY, you must use the Historian OPC collector with the


The Calculation collector is designed to perform math and analysis on Historian data and store the results in tags, on the server. The Server-to-Server collector has the same calculation capabilities as the Calculation collector, but it stores the results in tags, on a remote server.

Most collectors are capable of performing first-order ”dead band” compression as well as a ”browse & add” configuration and store & forward buffering.

Clients: All client applications retrieve archived data through the Historian API. The Historian API is a client/server programming interface that maintains connectivity to the Historian Server and provides functions for data storage and retrieval in a distributed network environment.


Proficy Historian Getting Started Guide


Typical Historian System

Getting Started with Historian

The Historian Archive indexes all information by Tagname and Timestamp. The Tagname is, a unique identifier for a specific measurement attribute. For iFIX users, an Historian Tagname normally represents a

Node.Tag.Field (NTF). Searching by Tagname and Time Range is a common and convenient way to retrieve data from Historian. If you use this technique to retrieve data from the Archiver, you do not need to know which archive file on the Historian Server contains the data. You can also retrieve data using a filter tag.

Historian is capable of storing many different data types, such as Floating Point, Integer, String, and BLOB

(undetermined binary data type), such as an Excel spreadsheet, a PDF file, or a Word file. The source of the data defines the ability of Historian to collect specific data types.

System Components

A Typical Historian System contains several components:

One or more Historian Data or alarm Collectors to data sources

One or more Historian Servers for data or alarms

One or more Historian Non-Web Administrators

Historian OLE DB provider

One or more Historian HDA Servers

One or more Excel Add-In packages, installed on any client node

Programs using Historian User API

Programs using Software Development Kit (SDK)

All clients communicate with the Server through the Historian API. The subsections that follow list the functions performed by each component.

Historian Alarms and Events

Historian Alarms and Events provides tools to collect, archive, and retrieve alarm and event data in Historian.

Refer to the Historian Alarms and Events manual for more information

Historian Data Collectors

Data Collectors are the interface between a data source and the data archiver. They:

Collect data using a specific acquisition interface, such as iFIX EDA, OPC Alarms and Events,


Proficy Historian Getting Started Guide

Machine Edition View, OSI PI, or OPC 1.0 or 2.0.

Perform first level data compression (deadband/update by exception).

Buffer data (store and forward) whenever a server connection is lost.

Refer to the Historian Data Collectors manual for more information.

Historian File Collector

File Collectors import .CSV or .XML files into Historian. The files can contain data, alarms, tagnames or other configuration information, and messages that you can import with a File Collector.

Refer to the Historian Data Collectors manual for more information.

Historian Administrator

An Historian Administrator provides a graphical user interface for performing Historian maintenance functions including:

Tag addition, deletion, and configuration.

Maintaining and backing up archive files.

Data collector configuration.

Security configuration.

Searching and analyzing system alerts and messages.

Refer to the Using the Historian Administrator manual for more information.

Historian Server

An Historian Server performs the following tasks:

Manages all system configuration information.

Manages system security, audit trails, and messaging.

Services write and read requests from distributed clients.

Performs final data compression.

Manages archive files.


Getting Started with Historian

Excel Add-In

The Historian Excel Add-In is a very useful tool for presenting and analyzing data stored in archive files. Using this tool, you can design custom reports of selected data, automatically process the information, and analyze the results. You can also use it for performing tag maintenance functions in Historian, such as adding tags, importing or exporting tags, or editing tag parameters.

Refer to the Using the Historian Excel Add-In manual for more information.

Historian OPC HDA Server

The Proficy Historian OPC HDA Server reads the raw data stored in Historian and sends it to the connected

OPC HDA clients. The Proficy Historian OPC HDA Server is in compliance with OPC Server HDA 1.20 standards.

Refer to the Historian OPC HDA Server manual for more information.

Historian User API

The Historian User API is intended to provide high speed read/write access to Historian data and read access to

Historian tags. There is no access to alarms, events, or messages.

Use the API to develop applications in C or C++, which read and write data to the Historian server when the

Historian SDK and Historian OLEDB do not meet your project requirements for performance or programming language.

Proficy Historian allows you to develop both 32-bit and 64-bit User API programs.

NOTE: If you want to build a 32-bit User API program on a 64-bit operating system, then you need to rename the ihuapi32.lib to ihuapi.lib and include it in your program.

Refer to the ihUserApi Help system for more information.

Historian SDK

The Software Development Kit (SDK) is designed for writing Visual Basic (VB) or Visual Basic for

Applications (VBA) Scripts. Using the SDK, you can develop your own scripts to perform selected repetitive or complex tasks or to make your own custom user interface. To use the SDK, create a VB/VBA project with the

SDK as a project reference.

Refer to the SDK Help system for more information.


Proficy Historian Getting Started Guide

Historian Client Access API

Most applications today rely on .Net based development platforms from Microsoft. To enable easier integration with Historian, a .Net API is provided. The Client Access API supports both 32-bit and 64-bit Windows

Operating Systems.

Historian Migration Tools

Historian provides migration tools to allow you to migrate your existing Classic Historian configurations and data and your iFIX Alarm and Event data into the Historian environment. Tags, collection rates, and deadbands for tags configured in Classic Historian can be transferred into Historian by the migration tools.

Refer to the Migrating Advanced and Classic Historian Data manual for more information.

Understanding the System Architecture

You have wide flexibility in configuring your Historian application. Since Historian can support a fully distributed architecture, you can spread the data collection, server, administration, and client data retrieval functions across many different nodes in a network, or you can install all components on a single computer.

Since the Historian API is the basic building block for connectivity, all Historian functions, including data collection, administration, and data retrieval, use the Historian API.

You can connect the Historian API to a local Historian Server in the same manner as to a remote Historian

Server by simply providing the name of the server. This name must be the Computer Name or IP Address of the target Historian Server, and the server must have TCP/IP connectivity. If you use the Computer Name of the server rather than the IP Address, the IP Address must be available to the client through DNS, a WINS server, or through the local host table.

It is recommended that you install the Historian Server on a central dedicated server, as shown in the Typical

Historian System figure. Next, install data collectors on each data source, and point them back to the central

Historian Server by specifying the appropriate server Computer Name. Install a separate data collector for each type of collection interface used in your system.

Observe the following constraints when you install collectors:

iFIX Collector, File Collector, Simulation Collector, Calculation Collector, Server-to-Server

Collector, Windows Performance Collector, or – install only one collector of each type per computer.

OPC Collectors – install only on a computer where the OPC Server is running locally. You can install multiple collectors on a single computer, however, by installing a collector for each OPC Server.


Getting Started with Historian

You can install various types of collectors on a single computer, subject to the preceding constraints.

iFIX Implementation Guidelines

With an iFIX implementation, install data collectors on each SCADA Server that contains the Node.Tag.Fields

(NTFs) you want to collect. You can minimize system load in this way because you are not relying on FIX networking to pull remote data into the node where the collector is running.

In a distributed environment, remote data collectors automatically buffer collected data in the event of loss of a network connection between the collector and the Historian Server. When the network connection is reestablished, the data collectors automatically re-establish data flow and forward all buffered data to the server.

The store and forward feature does not apply when you use iFIX networking for data collection. Since iFIX network connections are located ahead of the data collector in the data flow path, the store and forward feature does not protect against loss of data when an iFIX network connection is interrupted, as illustrated in the following figure.

Ineffective Use of Store and Forward in an iFIX Network


Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF


Table of contents