Versions Compared

Key

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

Overview

This Historian Module relies on other modules to store Tags' data. For instance, the Dataset External Tags execute the data insertion for SQL targets. Meanwhile, to save data in external databases, such as Canary or External Tags Historian, the third-party system will save the data.

As the Historian module only manages the process, many potential issues regarding data storage are out of the module's scope. Problems usually relate to the external database repository, which requires specific tools to diagnose the problem. Despite being out of the Historian module scope, you can use the diagnostic tool from Module Information and the Trace Window tool to monitor the Historian module. When the solution is running and the Designer is connected with the runtime, the Historian Monitor page show basic status of its HistorianTable and an User Interface created using the Trend Chart Control, which allows to monitor historical data.

On this page:

Table of Contents
maxLevel3
stylenone


Image Added


Monitoring the Historian Module

You can access the monitor by navigating to Historian → Historian Monitor.

When the solution is runtime, the monitor will display a Trend Chart page, and a table with the runtime properties of the HistorianTables.

Trend Chart Page 

This TrendChart Page an out-of-box User Interface to monitor Historian Data, created using the same tools available to create displays and the Trend Chart Control.  When creating displays in your application there is template in Charts similar to this one embedded in the Designer. 

Tip

Using a Browser, with no installation required, you can verify the Historian Status of remote server. With the following URL.

http://localhost:3101/html5/?Monitor=Historian

Locahost: shall be replaced by the IP or Computer Network Name of the computer you want to access. The port 3101 shall reflect the Port the Runtime is using, typically it is 3101 for production profile, and 3201 for Development profile. The reaming for the URL remains the same.

Historian Monitor Table Columns

The information in this table is constructed from the runtime properties of the object: Historian.Table.<Name>.  

The properties shown in the monitor table can also be accessed in Displays or Scripts using the following syntax:

@Historian.Table.<Name>.<PropertyName>


HistorianTables Monitor Columns

Column

Description

Namespace

Specifies the namespace the item belongs to.

Name

HistorianTable's name

RowCount

The total number of rows of data stored in the HistorianTable.

SuccessCount

The total number of times the system successfully stored data in the table. 

ErrorCount

The number of times the system failed to save data into the table. 

LastStoredTimeStamp

The timestamp of the last data entry stored in the table.

LastStoredErrorMessage

The last error message encountered.



In this section:

Local Diagnostic Tools

Module Information: Historian properties

The diagnostic tool from the Information module updates in real-time information about the execution of the Historian module. Therefore, you can use this solution to monitor the state of connected databases.

By running the ModuleInformation.exe tool, the section Historian updates the following properties:

Module Information - Historian properties

Property

Example Value

Tables

2

Items

6

OpenStatusMessage

OK

IsDeleting

False

StoreAndForward.IsEnabled

0

UseStoreAndForwardDatabaseAlways

False

HasPairRedudantStoreAndForwardPending

False

Redundancy.LastSyncMessage

Redundancy.LastSyncTimestamp

Redundancy.LastSyncErrorMessage

Redundancy.LastSyncErrorTimestamp

StoreAndForward.IsFixingDatabase

False

StoreAndForward.FixDatabaseMessage

StoreAndForward.FixDatabasePercent

0

StoreAndForward.FixDatabaseElapsedTime

00:00:00

The names of properties are self-explanatory, but in many cases, its exact meaning requires a deeper understanding of the implementation of the module. Contact technical support sending the contents of the table for specific analysis. 

When selecting one Specific HistorianTable in the Tree under Historian, the following information is available:

Module Information - Historian Table propertiesItemValue ExampleTable NameSystemMonitoringNumber of History Items6Number of Rows842InitializationMessageOKTargetDisableFalseTimeDeadband00:00:01LifeTime31SaveOnChangeTrueSaveQualityFalseNormalizedFalseDeletingFalseLastStoredTimeStamp7/29/2022 11:48:04 PM -03:00LastStoredErrorMessageLastDeletedTimeStampLastDeletedErrorMessageLastSamplesSavedID: 842, UTCTimestamp_Ticks: 637947460841150000[7/29/2022 11:48:04.115 PM],
LogType: 1, NotSync: False,
ServerMonitorInfo_TServer__Memory: 155.2265625,
ServerMonitorInfo_TServer__CPU: 0,
ServerMonitorInfo_TRichClient_Memory: 60.98046875,
ServerMonitorInfo_TRichClient_CPU: 0,
ServerMonitorInfo_AllModules_Memory: 69.78515625,
ServerMonitorInfo_AllModules_CPU: 0LastStepDuringSavingUpdate samples: OKErrorCount0SuccessCount603StoreAndForward.IsActiveFalseStoreAndForward.NumberOfRows0StoreAndForward.LastStartedTimeStampStoreAndForward.LastSyncTimeStamp

Historian TraceWindow

The TraceWindow diagnostic tool provides real-time logging of events connected with the Historian Module execution. 

Four level of message can be enabled.

Module Information - Historian properties

Diagnostic Level

Types of messages included

Info

Examples of events captured by this level:

Info > PropertyWatch > User logged.

Info > Module Information > User logged.

Info > RichClient > admin > User logged.

Info > Device > modbus > TRunModule.exe for channel modbus is stopped.

Info > TModules.OPCServer > User logged.

Warning

Review the application logs for any warnings.

Error

Review the application logs for any error messages.

Debug

Use debugging tools to inspect the state of the application at runtime

In this section...

Page Tree
root@parent
spacesV10