Overview
This Historian module relies on other modules to store Tags' 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 result, many potential issues regarding data storage are out of the module's scope. Problems are usually related to 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 such Module Information and Trace Window to acquire additional information regarding the Historian module operationWhen 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 | ||||
|---|---|---|---|---|
|
Monitoring the Historian
moduleThe 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. |
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 is 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 a template in Charts similar to the 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:
|
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. |
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
The diagnostic tool from the Information module updates in real-time information about the execution of the several 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 monitor the state of connected databases. 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 available:
Property
Description
Table NameThe Historian Table's name.Number of History ItemsNOT SURE ABOUT THIS ONENumber of RowsThe total number of row's data stored in the Historian Table.Initialization MessageMessage provided when stating the Historian.TargetNOT SURE ABOUT THIS ONEDisableInform if the Historan Table was disabled by the user before or while running the solution. You can control this option by accessing Runtime → Runtime Diagnostics.Time DeadbandThe dead band time defined configured for the Historian Table.Life TimeThe duration in days for retaining records on the Archive Location. The system automatically deletes data older than the specified value.Save On ChangeInform if the Historian Table is using the Save On Change configuration to store new data. If true, whenever Tag's value change triggers an event to store the new data.Save QualityInform if the Historian Table is using the Save Quality feature. For more information related to the Save Quality, access Historian Tables.NormalizedInforme if the Historian Table is using the Normalize table schema for SQL databases. For more information on SQL database schemes, refer to the Archiving Process.DeletingNOT SURE ABOUT THIS ONELast Stored Time StampThe date and time of the last data stored into the database.Last Stored Error MessageMessage informing the problem related to the last problem preventing data to be stored.Last Deleted Time StampThe date and time of the last time data was removed from the database.Last Deleted Error MessageMessage informing the problem related to the last problem preventing data to be removed from the database.Last Samples SavedNOT SURE ABOUT THIS ONELast Step During SavingNOT SURE ABOUT THIS ONEError CountTotal number of errors related to the Historian Table operation.Success CountTotal number of sucessfull data storage actions.StoreAndForward.IsActiveInform if the Historian Table is using the Store And Forward feature. NOT SURE ABOUT THIS ONEStoreAndForward.NumberOfRowsNOT SURE ABOUT THIS ONEStoreAndForward.LastStartedTimeStampInform the last time the Store And Forward process was started to synchonize data with the database.StoreAndForward.LastSyncTimeStampInform the last time database data was synchonized.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 runtimeIn this section:
| Page Tree | ||||
|---|---|---|---|---|
|