The Title of the page is not clear. I would use a colon instead of a comma or remove everything after the comma. As is, the titles in the page tree are hard to understand.
Introduction to the Historian Module
The Historian module lets allows you to store tag values, and their corresponding timestamps, in SQL or third-party time-series databases. With this module, you can streamline the collection and storage of data in its time context. This is not clear. What does it mean by in its time context?
On this page:
| Table of Contents | ||||
|---|---|---|---|---|
|
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.
You can use the data archived through your application's Historian module in Alarms and Displays.
Feature Highlights
Embedded Canary Historian, which includes 500 free Canary Historian Tags with any license – Edge to Unlimited.
The Historian module works with the industry's major players (OSISoftPI, InfluxDB, and more).
Store and Forward function, which ensure your data will not be lost in case the database is not available.
Universal Time and Daylight Saving.
Main components
To configure the Historian module, you need to understand and set up three main components:
- Archive Locations (Databases)
- Historian Tables
- Historian Tags
You find a brief description of each feature below.
Archive Location
The Archive Location defines in which database variables will be archived or read to be used in charts and calculations. You can use any SQL Database. In case you want to integrate third-party products designed to store long-term time-related values, known as time-series databases or Historian tools, you need to use the Tag Provider.
Historian Tables
Historian Tables group Tags for historical archiving. Using the Historian Table, you can define the Tags to archive to each Target Database. Moreover, you can configure additional standard settings to apply to all tags in one particular group, such as when to save new data or how long to keep the data on the database.
HistorianTag
A Historian Tag refers to any, internal or external, Tag which values are archived into a Historian Table. In addition to Tags from the FrameworX, you can also include dynamic references to external data using the Tag Provider function.
Configuring the Historian module
The basic process to configure the Historian module follows the sequence below:
Define the default SQL Database through the Archive Database menu. By default, FrameworX uses TagHistorian, mapping tags to a SQLite database. The default database uses TagHistorian as its name and is located in the TagHistorian repository. Learn more at Archive Locations.
- You can add other Archive Databases if you need to store data separately.
- Create and Edit Historian Tables. You can use more than one Historian Table to better organize your Tags or if your process has too much information. Access the Historian Tables page to learn more about it.
Add Tags to the Historian Tables. Learn more at Historian Tags.
Use the Historian Monitor to superviseyour data on Runtime. Check the Historian Monitor page for more information.
The above steps are a simplified explanation of the configuration process. For additional information on how to configure the Historian module, access Configuring The Historian Module.
How Archiving works
The Historian module follows a three-step process to archive information:
Trigger: An event triggers the request to archive a group of values. There are two types of events, Trigger and TagChange, which you configure in a Historian Table.
Archive: The Historian archives the values in the selected database. You can use a SQL Database or a TagProvider, configured to act as a historian.
Synchronize data: If you enable Store and Forward, the data synchronization is executed. This option stores data in a local database if the selected database is unavailable. The system sends the stored data to the selected database when it becomes available.
For more details about the Historian's execution, check the Archiving process.
More on the Historian Module
To learn more about the Historian module, you can use the additional documentation pages available on the documentation:
Get more information about the Historian module Runtime Execution.
Learn how to display TrendCharts to analyze and compare historical and real-time data, making it easier to identify patterns and trends in system performance.
Check how to Query Data on Scripts from the Historian module to create custom logic and solution-specific analysis. (LINK NO WORKING. Link NOT FOUND ON THE DOCUMENTATION)
The Advanced Historian Topics page presents complementary information about the following:
- Archiving processes
Historian Runtime attributes
Use the Historian Best Practices and Common Issues pages to access best practices tips and troubleshooting guides.
In this section:
| Page Tree | ||||
|---|---|---|---|---|
|
...