Page History

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 the your application's Historian module in Alarms and Displays in your application.

Feature Highlights

• Embedded Canary Historian, that which includes 500 free 500 Canary Historian Tags with any license – Edge to Unlimited.

• The Historian module works with all industries the industry's major players (OSISoftPI, InfluxDB, and more).

• Store and Forward 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 Databases
• Historian Tables
• Historian Tags

You find a briefly brief description of each featue feature below.

Archive Database

The Archive Database defines where 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 TagProvider Extensibility (not sure what it is).

Historian Tables

Historian Tables group Tags for historical archiving. You Using the Historian Table, you can define the Tags to archive to each Target Database using the Historian Table. 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 proccess to process to configure the Historian module follows the sequence below:

1. Define the default SQL Database thorugh through the Archive Databese Database menu. By default, FrameworX uses TagHistorian, mapping tags to a SQLite database. The default database uses TagHistorian as its name and is located at in the TagHistorian repository. Learn more at Archive Locations.If necessary, you

2. You can add other
Target
3. Archive Databases
to better organize the Tags archived
4. if you need to store data separately. 
5. 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.

6. Add Tags to the Historian Tables. Learn more at Historian Tags.

7. Use the Historian Monitor to suppervise your superviseyour data on Runtime. Check the Historian Monitor page for more information.

The above steps , are a simplified explanation about 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:

1. 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.

2. Archive: The Historian archives the values in the selected database. You can set to use a SQL Database or a TagProvider, configured to act as a historian.

3. Synchronize data: If you enable Store and Forward is enabled, the data synchronization is executed. This option stores data in a local database if the selected database is not availableunavailable. The system sends the stored data to the selected database when it becomes available.

For a more details about the Historian's execution, check the Archiving process.

More on the Historian Module

To learn more about the Historian Module we recommend you visit the following pages:module, you can use the additional documentation pages available on the documentation

Access the Working with the Historian Module. page to:

• Get more information about the Information on Runtime Execution.

• How Access guide on how to Display TrendCharts.

• How Check wow to Query Data on Scripts from the Historian module.

The Advanced Historian Topics presents complementary information about the following:

• Archiving processesInformation on Archiving Processes

• Historian Runtime Attributesattributes

Use the Historian Best Practices

pages to access best practices tips and troubleshooting guides.

In this section: