Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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. 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 retainedHistorianTables organize HistorianTags for logical grouping and management. A table defines the storage parameters for a specific set of tags. This includes how and when tags are saved, storage locations, and triggers for data storage (such as time intervals or value changes). HistorianTables allow customization of data retention periods. They are used to structure historical process data for retrieval and analysis, supporting applications such as process optimization, troubleshooting, and reporting.

On this page:

Table of Contents
maxLevel3
stylenone

Tip
titleSolution Example

Historian Examples



Configuring Historian Tables HistorianTables

You can By default, FrameworX provide a Historia Table you can use to group your Tags. However, you can create as many Historian Tables HistorianTables as you need to better organize your archives better and optimize for disk space and performance. To create a new Historian TableHistorianTable, follow the steps below:

  1. Access Historian → Historian Tables/ HistorianTables.
  2. Click on the plus Plus icon.Define the settings to the new Historian Table on the Dialog. The next section
  3. Fill in the fields and set the HistorianTable settings. The following section on this page describes each option available.
  4. Click OK.

Image Added

Info
titleConfiguration option availability

Specific options may be unavailable depending on the selected database or property chosen. For example, you can't define a Trigger trigger if you check the the Normalized option option for the new Historian Table. Therefore, it's important to essential to consider your options carefully.


The new table will show up on the Datagrid list. If you need, you You can edit the Historian Table you can select and change HistorianTable by selecting and changing the desired property if you need to. ALternativelyAlternatively, you can select choose the Historian Table HistorianTable and click on the pencil Pencil icon.

Image Removed

It's a good practice to store only the necessary data at the required frequency. To achieve this, you can take advantage of You can use features like deadbandsDeadbands, OnTagChangeOn Tag Change, or Trigger events to achieve this. These features help you organize your storage and save only what's required only save important data without overloading the system or slowing down data recovery.

Historian Tables Properties

HistorianTable Properties

When configuring a Historian TableHistorianTable, 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

ArchiveLocation

Defines the Archive Location used. By default, the TagHistorian based on SQLite is used. For more information, access the

Archive
Table name

TableName

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

AutoCreate

If you

check

select this option, the Historian module

verifies

will verify if this table

is

has already been created in your SQL

DB

database. If the table does not exist, it will create a new one

will be created

.

Save on Change

SaveOnChange

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 it happens, will

ignite

trigger the

acrchiving

archiving of all Tags

in

associated

to

with the current

Historian Table to

HistorianTable in the database. You can use any tag, object, or property from the

objects

object's namespaces as a trigger. Click

on

the

elllipses

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

prevents excessive record creation in the database, especially if you're using the SaveOnChange option.

If

left

set as

zeros

zero, this setting is inactive. 

As an example, consider you set a

5

five-second

Deadband

deadband. After a Tag is archived, the counter begins.

While

If the counter doesn't reach

5

five seconds, no Tag information will be saved, independent of how

significant

big its value

change was

changes. The table below exemplifies the example.

Tag's value

Current Time

Will be saved on Database?

5

12:05:05:00

Yes

20

12:05:07:00

No

25

12:05:10:00

Yes

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


LifeTime

Set the duration in days for retaining records on the Storage Location. The system automatically deletes data older than the specified lifetime.

If you set the value to 0 or leave it blank, the system will not perform automatic data deletion, ensuring the data remains untouched.

SaveQuality

When checked, a column in your SQL DB

store

stores the Quality property of the Tag argon with the value. The quality level defines how

much

reliable

is

the Tag

value

is, and it follows the OPC standard specification. By checking this option, only points with real data will be displayed when you access a graph. Check more about this option in the section on this page

Normalized

When checked, the system uses the Normalize table schema for SQL

database,

databases or the Standard schema otherwise. For more information on SQL database schemes, refer to the Archiving Process.

Value Columns Type

ValueColumnsType

Select the

Type for Value Columns used to store the tag values

type of value to be stored in the value columns, which defines the Tags' value type in the SQL database.

This field can be edited ONLY when first

You can change this property only when creating the HistorianTable.

Options:
  • Float (4 bytes) - Default option
  • Double (8 bytes)

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.

 

Description

Description for this HistorianTable object.



Save Quality

In certain instances, the graph may exhibit lines and values even in timestamps where there is no data present. For instance, when you access a graph that you know lacks data and you see a continuous line connecting the endpoints of existing data points, despite the absence of data in between, you can infer that you are leading with unreal information. If you click on such areas, the value shown can lead you to misleading cursor values, as no data exists for those specific moments.

To address this issue, you can remove the line connecting the points of the graph where there is no data. This can be achieved by enabling the SaveQuality property in your HistorianTable, as depicted in the image below. If the SaveQuality option is not available in any column, you can enable it by right-clicking on the top of any column name and select SaveQuality.

Image Added

You can also configure this option when creating the HistorianTable by checking the SaveQuality option, as shown in the image below.
Image Added
The image below demonstrates a graph without lines in areas where no data exists, offering a clearer representation.

Image Added


In this section...

Page Tree
root@parent
spacesV10