Introduction to Historian Module
The Historian module enables the storage of tag values and their corresponding timestamps in SQL databases or third-party time-series databases. This module is designed to streamline the collection and storage of data in its time context.
On this page:
Purpose and Key Concepts
Configuration of the Historian module is accomplished through the following sections: Target Database, Historian Table, and Historian Tag.
TargetDB
The TargetBD defines the database where variables will be archived or read to be used in charts and calculations. The Target Database can be any SQL Database or, using the TagProvider Extensibility, it can also use third-party products designed to store long-term time-related values, known as time-series databases or Historian tools.
HistorianTable
The HistorianTable is a logical organization that groups Tags for historical archiving. Each Historian Table has a definition of which Target Database the group of Tags will be archived. You can also configure other standard settings that apply to all tags in that group in the Historian Table, such as when to save new data or how long to keep the data.
HistorianTag
The HistorianTag refers to any value contained in a Historian Table to be archived, whether an internal Tag or an external data reference. These variables are typically Tags defined in this platform, but you can also include dynamic references to external data using the TagProvider functionality.
Historian Functionality
The Historian module provides an out-of-the-box solution for archiving historical data without programming requirements. Although it is possible to include custom data logging procedures in your solution using Scripts (.NET programming) and Datasets (SQL storage), the standard configuration tools of the Historian module can fulfill most typical data logging needs.
This historical data can then be used in Alarms and Displays.
Feature Highlights
Embedded Canary Historian, that includes free 500 Canary Historian Tags with any license – Edge to Unlimited.
We work with all of the industries major players (OSISoftPI, InfluxDB, and more)
Store and Forward
Universal Time and Daylight Saving
Archiving Process
The Historian module has a three-step archiving process:
An event triggers the request to archive a group of values. There are two types of events (Trigger or TagChange), which are configured in a Historian Table.
The Historian archives the values in the Target database. The Target Database can be a SQL Database or a TagProvider that is configured to act as a historian.
If Store and Forward is enabled, the data synchronization is executed. This option stores data in a local database if the Target Database is not available, and sends it to the target when it becomes available.
For a more detailed Historian execution explanation, check Archiving process.
Configuring the Historian module
The typical configuration workflow for the Historian Module has the following sequence:
| Historian module configuration workflow | ||
|---|---|---|
| Action | Where | Comments |
Define the default TagHistorian SQL Database | Historian → TargetDBs | By default, TagHistorian maps to a SQLite database named and located equal as the Solution itslef, followed by the proper FileExtension. You're able to change it as needed. |
If using Canary, modify the default target to the the Canary Historian | Historian → TargetDBs | If using Canary, a connection with the local embedded Canary Historian is already included in new solution. Just use that connection, or modify it willing to connect an external Canary System instead. |
If necessary, add other Target Databases | Historian → TargetDBs | If archiving or retrieving data from other Historian tools is necessary, such as InfluxDB or OSIsoft PI, add the connection in the Tag Providers, making sure to mark "Set as Historian Server" checkbox when creating the provider. |
Create and Edit HistorianTables | Historian → Historian Tables | Add or modify HistorianTables, organizing how the Tags will be grouped for archiving and the Target Databases. Learn more at Historian Tables. |
Add Tags to the HistorianTables | Historian → Historian Tags | Connect Tags to the Historian tables. Either by typing, browsing, pasting or any of the available import methods. Learn more at Historian Tags. |
Default TargetDB
When creating a new solution, the TagHistorian is set by default to use the embedded SQLite database provided in the Datasets module. The Historian Target Database can be chosen from a range of options, including selecting another SQL database for the Tag Historian, the Canary Historian, or any available ExternalTags Historian targets.
Historian Database options | |
|---|---|
Target Database | Description |
SQL Database | Any SQL style database, defined in the object TagHistorian on Datasets → DBs. |
Canary Historian | Embedded CanaryLabs engine included in the framework, or connection with external Canary systems. |
ExternalTags Historian (InfluxDB, OSIsoft PI) | The ExternalTags feature allows for seamless integration with third-party products, which can act as native and fully integrated historian repositories. This feature provides not only current interfaces but also allows for additional products to be easily incorporated using the driver toolkit. |
The SQLite database is suitable for databases up to around 10GB in size. If the number of tags and the save interval are expected to exceed this limit, it is recommended to use another SQL database for the Tag Historian, the Canary Historian, or any of the available ExternalTags Historian targets. It is advisable to select an alternative database option in cases where a solution is expected to create more tags or require frequent saving intervals that exceed the capabilities of the embedded SQLite database.
To configure a different SQL Database for the TagHistorian connection, please refer to the Dataset module configuration.
For other ExternalTags Historian targets, please refer to the ExternalTags configuration to define and configure their use.
More on the Historian Module
To learn more about the Historian Module we recommend you visit the following pages:
Working with the Historian Module.
Information on Runtime Execution
How to Display TrendCharts
How to Query Data on Scripts
Information on Archiving Processes
Historian Runtime Attributes
Best Practices
Troubleshooting
In this section: