Introduction to the Wonderware Historian Driver
This driver is a stand-alone driver. It provides additional functionality to enable ClearSCADA to interface with specific supported systems or devices. To interact successfully with such systems or devices, you need to:
- Install and run the driver
- Ensure that the driver is licensed
- Configure the required database items and settings on the driver
- Ensure that the database items (and any database items on which they depend) have valid, saved, configuration and are 'In Service'.
Intended Audience
This guide is designed to be used by engineer-level users who are responsible for configuring ClearSCADA to export ClearSCADA historic data to a Wonderware Historian On-Premise server or to AVEVA Insight (formerly Wonderware Online).
The guide also contains information for:
- Operators and engineers who use the Wonderware Historian driver to export data.
- Maintenance engineers.
Document Scope
This guide explains how to configure and operate your ClearSCADA system so that it can export ClearSCADA historic data to a Wonderware Historian On-Premise server or to AVEVA Insight (formerly Wonderware Online).
Unless stated otherwise, we use the term 'Wonderware Historian' to refer to the historian that is available on a Wonderware Historian On-Premise server or in AVEVA Insight (formerly Wonderware Online). We use the term 'Wonderware Historian database item' to refer to the database item that you can configure in the ClearSCADA database in order to represent a connection to the historian in either of the above applications.
This guide contains technical information that is intended for users that are sufficiently familiar with ClearSCADA configuration and operation. Before reading this driver guide, ensure that you are familiar with:
- ClearSCADA configuration practices, procedures, and the configuration of properties that are common to many database items. For more information, see the ClearSCADA Guide to Core Configuration, and the ClearSCADA Guide to Core Point Configuration.
- Driver structure, components, and configuration properties, pick actions, and status attributes that are common to many drivers. For more information, see the ClearSCADA Guide to Drivers.
Some sections of this guide are intended for operator-level users. These sections are intended for users that are familiar with the navigational and operational aspects of ClearSCADA. Before reading the operational sections in this guide, ensure that you are familiar with:
- The ClearSCADA user interfaces (ViewX and WebX), the various types of display, their navigation and operation. For more information, see the ClearSCADA Guide to ViewX and WebX Clients.
The Wonderware Historian driver enables you to export ClearSCADA historic data to a Wonderware Historian On-Premise server or to AVEVA Insight (formerly Wonderware Online).
This functionality is only supported by Wonderware Historian 2014 R2 and later.
When you have installed the driver, you can then configure a ClearSCADA point or accumulator so that ClearSCADA can export its data to specific Wonderware Historians. ClearSCADA will automatically start exporting new data for an enabled point or accumulator to the selected Historians. It does this by using an API called HCAL (the Historian Client Access Layer).
HCAL is installed when you install the Wonderware Historian driver. ClearSCADA sends historic data to HCAL, which then manages its onward transmission to the Wonderware Historian. ClearSCADA exports historic data at the same time as it stores the data in the ClearSCADA database. It only exports newly created historic data. It will not export data that was created before you place the Wonderware Historian database item 'in service'. ClearSCADA will not export data that it did not store due to historic compression or filtering (see Historic Data Compression in the ClearSCADA Guide to Core Point Configuration). HCAL applies no further filtering.
HCAL can store exported historic data in a store-and-forward cache. This is useful if the network connection to the Wonderware Historian is intermittent or unavailable. In such a situation, HCAL will cache the export data and when the link becomes available again, it will send it to the Wonderware Historian. For more information about HCAL, see the documentation supplied with Wonderware Historian.
For each enabled point or accumulator, ClearSCADA uses HCAL to create a new tag in the selected Wonderware Historians. It does this when it exports the first data to the Historians (see Wonderware Historian Tags).
To export historic data to a Wonderware Historian, follow this procedure:
- Install the Wonderware Historian Driver.
- Configure the Wonderware Historian Driver Server Setting to set up the store-and-forward cache.
- Add a Wonderware Historian Database Item to the ClearSCADA database for each Wonderware Historian to which you want to export. This database item holds the Wonderware Historian export settings.
- Configure each Wonderware Historian Database item (see Configure a Wonderware Historian Database Item). If you want to export data to AVEVA Insight (formerly Wonderware Online), you need to set the connection token (see Exporting Historical Data to AVEVA Insight).
- Place the Wonderware Historian database items In Service.
- Configure the Historic details for each point or accumulator for which you want to export historic data (see Defining Historic Details for a Point in the ClearSCADA Guide to Core Point Configuration).
Historic data is only exported for points and accumulators for which a Wonderware Historian database item is specified in Export section of the configuration Form. Data that is subsequently stored in the ClearSCADA historian will be exported to the specified Wonderware Historian servers. For more information about both of these requirements, see Define the Historic Export Details in the ClearSCADA Guide to Core Point Configuration.