Overview
This page presents information about historian diagnostics. This Historian Module relies on other modules when storing the data. For instance, for SQL targets, the final database insertion is executed by the Dataset Tag provider; for external database, such as Canary or Tag Provider Historian tools, the related third party system will perform the access. Therefore, many potential issues regrind data storage are not at the Historian Module level, but related to the external database repository, which requires diagnostics with other specific tools, according to the Target Database. The execution status of the Historian module itself, can be easily monitored using the Module Information diagnostic tools, and the Trace Window tool as described in this Section.
On this page:
Local Diagnostic Tools
Module Information: Historian properties
The diagnostic tool Module Information updates in real-time advanced information about the Execution of the Historian Module.
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 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 | <<<<. Brief description of the types of events captured by this level ======== |
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 |
Example of Use of the SaveQuality Column
There are instances where the graph displays lines and values where there is no data. An example is on the Trending page in Factory Studio where we notice these instances in which we know there is no data, yet the graph displays a continuous line connecting the end and beginning of the points where data exists. If the user clicks on such areas, the cursor will show values that are misleading because it is known that there is no data for that particular moment.
It's possible to remove the line connecting the endpoint and the startup point on the graph, thus avoiding a continuous line where there is no data.
To do this, you have to enable a property called SaveQuality in your HistorianTable, as shown in the image below:
If there is no column with this option, you have to right-click on the top orange line and select SaveQuality. After this, you will be able to check the SaveQuality in the table you need.
The image below displays a graph without lines where there is no data.
In this section...