Overview
This Historian Module 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.Therefore, the Historian Monitor provides exclusive information regarding the Historian system that manages the process of storing Tags' information. Therefore, the Historian Monitor will not provide information regarding the databases operation status.
As a resultAs the Historian module only manages the process, many potential issues regarding data storage are out of the module's scope. Problems are usually relate related 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 Diagnostic Tool such Module Information and the Trace Window tool to monitor acquire additional information regarding the Historian module operation.
On this page:
| Table of Contents | ||||
|---|---|---|---|---|
|
Historian module
The Historian Monitor menu provides a way to monitor real-time information related to the Historian module operation. As the Historian Monitor has a monitoring-only function, you will not be able to edit or interact with Historian Tags, Historian Tables, or Archive Locations
The information available you you access the Historian Monitor is described in the table below.
Monitor information | Description |
|---|---|
ID | Historian Table unique identifier. |
Name Space | Specifies the namespace the item belongs to. |
Name | Historian Table's name |
Rows Count | The total number of row's data stored in the Historian Table. |
Success Count | The total number of times the system successfully store data into the database. [NOT SURE ABOUT THIS ONE] |
Error Count | Records the number of times the system failed to save data into the database. [NOT SURE ABOUT THIS ONE] |
Last Stored Time Stamp | Marks the timestamp of the last entry stored. |
Last Stored Error Message | Logs the last error message encountered. |
| Info | ||
|---|---|---|
| ||
To have access to the Historian Monitor information, your solution must be running. Use the Runtime to start the solution. |
Local Diagnostic Tools
As the Historian Monitor is not capable of providing additional information regarding the connected databases, you can use the Diagnostics toll for it. You will use the Module Information and the Trace Window to acquire additional information. To access these Diagnostic toll, access Runtime → Runtime Diagnostics.
| Info | ||
|---|---|---|
| ||
You can only access these toll while your solution is running. Use the Runtime to start the solution. |
Module Information
: Historian propertiesThe diagnostic tool from the Information module updates in real-time information about the execution of the Historian module. Thereforeseveral module. To verify the Historian information, access the Module Information (info icon) and select the Historian option in the tree. By doing this, 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 following table describe each available information when you select the Historian.
| Property | Description |
|---|---|
| Tables | The total number of Historian Tables. |
| Items | NOT SURE ABOUT THIS ONE |
| OpenStatusMessage | NOT SURE ABOUT THIS ONE |
| IsDeleting | NOT SURE ABOUT THIS ONE |
| StoreAndForward.IsEnabled | Specify if the system is using the Store and Forward feature. |
| UseStoreAndForwardDatabaseAlways | NOT SURE ABOUT THIS ONE |
| HasPairRedudantStoreAndForwardPending | Indicates if a Forward process to update the database is waiting due to connection issues. |
| Redundancy.LastSyncMessage | The last message received after synchronizing data with the database. |
| Redundancy.LastSyncTimestamp | Specify when the last synchronization happened. |
| Redundancy.LastSyncErrorMessage | Inform the last error message received when the synchronization failled. |
| Redundancy.LastSyncErrorTimestamp | Specify when the last failled synchronization happened. |
| StoreAndForward.IsFixingDatabase | Inform if the system is currently fixing the database data after facing issues synchronizing data. |
| StoreAndForward.FixDatabaseMessage | Message describing the origin problem when synchronization failed. |
| StoreAndForward.FixDatabasePercent | The total percentage already fixed. |
| StoreAndForward.FixDatabaseElapsedTime | The amount of time spent since the Store and Forward has started. |
If you select one specific Historian Table in the tree under Historian, additional information, described in the following table, will be
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 properties | |
|---|---|
| Item | Value Example |
Table Name | SystemMonitoring |
Number of History Items | 6 |
Number of Rows | 842 |
InitializationMessage | OK |
Target | |
Disable | False |
TimeDeadband | 00:00:01 |
LifeTime | 31 |
SaveOnChange | True |
SaveQuality | False |
Normalized | False |
Deleting | False |
LastStoredTimeStamp | 7/29/2022 11:48:04 PM -03:00 |
LastStoredErrorMessage | |
LastDeletedTimeStamp | |
LastDeletedErrorMessage | |
LastSamplesSaved | ID: 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: 0 |
LastStepDuringSaving | Update samples: OK |
ErrorCount | 0 |
SuccessCount | 603 |
StoreAndForward.IsActive | False |
StoreAndForward.NumberOfRows | 0 |
StoreAndForward.LastStartedTimeStamp | |
StoreAndForward.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 |
Properties Reference
Historian Monitor
Property
Description
ID
Identifies the item.
NameSpace
Specifies the namespace the item belongs to.
Name
Names the item.
RowsCount
Counts the total number of rows.
SuccessCount
Tallies the number of successful entries.
ErrorCount
Records the number of errors encountered.
LastStoredTimeStamp
Marks the timestamp of the last entry stored.
LastStoredErrorMessage
In this section:
| Page Tree | ||||
|---|---|---|---|---|
|