Overview
The Historian module uses the classical table system to organize data. With the Historian Tables, you can define generic characteristics that will apply to all Tags linked to each table. Thus, you can customize settings such as table name, data type, and data lifespan, providing advantages in potential database architectural migrations.
With the Historian Tables, you can configure settings to specify the Tag's Archive Location and define how and when the associated Tags will be archived.
On this page:
| Table of Contents | ||
|---|---|---|
|
Historian Tables Configuration
The Historian module creates a default HistorianTable using Dataset-TagHistorian SQL as the Target Database, with an additional HistorianTable being created if the Canary Historian is enabled. This setup offers a range of flexible options to choose from when selecting and configuring the target database for your solution's specific needs.
The HistorianTable settings allow you to define rules for saving the tags connected with it.You can set triggers such as a time deadband, specifying the minimum interval between saves, and a lifetime value, determining how long saved tag values will be retained.
On this page:
| Table of Contents | ||
|---|---|---|
|
Configuring Historian Tables
By default, FrameworX provide a Historia Table you can use to group your Tags. However, you can create as many Historian Tables as you need to better organize your archives. To create a new Historian Table, follow the steps below:
- Access Historian → Historian Tables.
- Click on the plus icon.
- Define the settings to the new Historian Table on the Dialog. The next section describes each option available.
- Click OK.
| Info | ||
|---|---|---|
| ||
Specific |
options may be unavailable depending on the |
selected database or property chosen. For example, you can't define a Trigger if you check the Normalized option for the new Historian Table. Therefore, it's important to |
consider your options carefully. |
The new table will show up on the Datagrid list. If you need, you can edit the Historian Table you can select and change the desired property. ALternatively, you can select the Historian Table and click on the pencil icon.
It's a good practice to store Storing only the necessary data at the required frequency is a good practice to follow. You can use features such as . To achieve this, you can take advantage of features like deadbands, OnTagChange, or Trigger events to . These features help you organize your storage and save only what's required without overloading the system or slowing down data recovery.
HistorianTable configuration fieldsNew HistorianTables can be create with the NEW button, on Historian → Historian Tags, or editing the table on Historian →
Historian Tables
.To modify History Tables, on Historian → Historian Tags, select the Table in the ComboBox and Config button, or editing the datagrid on Historian → Historian Tables.
Either using the Dialog view or datagrid view, the HistorianTable has the following configuration fields:
HistorianTable configuration propertiesProperties
When configuring a Historian Table, you need to specify some properties defining when and how data will be archived. The following table describes each of the properties available.
Field | Description |
|---|
Archive Location | Defines the |
Archive Location used. By default, |
According to the Target option, some other fields on the configuration may be disabled
the TagHistorian based on SQLite is used. For more information, access the Archive Locations. |
Table name |
Name of the HistorianTable object. |
This name is also the table name inside the SQL DB for SQL databases. For other databases, this name is used as a logical grouping name. |
Auto |
create | If you check this option, the Historian module verifies |
if this table is already created in your SQL DB. If not, a new one will be created. |
Save on Change |
If you check this option, an action event to archive |
Tag data is generated whenever the Tags value changes. |
Trigger |
The Trigger option enables you to choose an event that, when happens, will ignite the acrchiving of all Tags in associated to the current Historian Table to the database. |
You can |
use any tag, |
object, or property from the objects namespaces |
as trigger. Click on the elllipses button (...) to access all options available. |
TimeDeadband |
Specify the minimum logging interval |
using HH:MM:SS:MS (Hours, minutes, seconds, milliseconds) |
format. This parameter determines the duration the system must wait after storing one tag value |
before storing a new |
one. |
It is used |
to prevent excessive record creation in the database, especially if you're using the SaveOnChange option. If left as zeros, this setting is inactive. As an example, consider you set a 5-second Deadband. After a Tag is archived, the counter begins. While the counter doesn't reach 5 seconds, no Tag information will be saved, independent of how significant its value change was. The table below exemplifies the example.
|
| ||||||||||
Life Time | Here you can set in days how long the records will be stay on the Target Database. Every day, if the Historian Modules find data on the HistorianTables older than the lifetime, that data is automatically deleted. If its the value is 0 or blank, no automatic data deletion is executed. Data is no longer automatically deleted. | |||||||||
Save Quality | When checked, a column in your SQL DB store the Quality property of the Tag argon with the value. The quality level defines how much reliable is the Tag value and it follows the OPC standard specification. | |||||||||
Normalized | When checked, uses the Normalize table schema for SQL database, or the Standard schema otherwise. For more information on SQL database schemes refer to Archiving Process. | |||||||||
Value Columns Type | Select the Type for Value Columns used to store the tag values in the SQL database. This field can be edited ONLY when first creating the HistorianTable. Options:
| |||||||||
GetSamples Method | Name of a method defined on Script → Class to allow customization when retrieving data from this tables. | |||||||||
Description | Description for this HistorianTable object. |
In this section...
| Page Tree | ||||
|---|---|---|---|---|
|