This Historian module relies on other modules to store Tags' data. Therefore, the Historian Monitor provides exclusive information regarding the Historian system that manages Tags' information storing process. However, the Historian Monitor will not provide information regarding the database's 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 as Module Information and Trace Window, to acquire additional information regarding the Historian module operation.
On this page:
Monitoring the 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 can't edit or interact with HistorianTags, HistorianTables, or ArchiveLocations.
The information available when you access the Historian Monitor is described in the table below.
Monitor information | Description |
|---|---|
ID | HistorianTable unique identifier. |
Name Space | Specifies the namespace the item belongs to. |
Name | HistorianTable's name |
Rows Count | The total number of rows of data stored in the HistorianTable. |
Success Count | The total number of times the system successfully stored data in the database. |
Error Count | The number of times the system failed to save data into the database. |
Last Stored Time Stamp | The timestamp of the last data entry stored in the database. |
Last Stored Error Message | The last error message encountered. |
Access to the Historian Monitor
Your solution must be running to have access to the Historian Monitor information. Use the Runtime to start the solution.
Local Diagnostic Tools
As the Historian Monitor cannot provide additional information regarding the connected databases, you can use the Diagnostics tools for it. You will acquire additional information from the Module Information and the Trace Window. You can find the Diagnostic tools by accesing Runtime → Runtime Diagnostics.
Access to Module Information and Trace Window
You can only access these tools while your solution is running. Use the Runtime to start the solution.
Module Information
The diagnostic tool from the Information module updates real-time information about the execution of several modules. 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 describes each available property when you select the Historian.
| Property | Description |
|---|---|
| Tables | The total number of HistorianTables. |
| Items | The numbers of items on the tables |
| OpenStatusMessage | Status message when staring the Module |
| IsDeleting | Flag to indicate the module is executing delete operations |
| StoreAndForward.IsEnabled | Specify if the system is using the Store and Forward feature. |
| UseStoreAndForwardDatabaseAlways | Flat to indicate to always use StoreAndForward instaed of writing directly to historian. |
| 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 failed. |
| Redundancy.LastSyncErrorTimestamp | Specify when the last failed synchronization happened. |
| StoreAndForward.IsFixingDatabase | Inform if the system is currently fixing the database data after facing issues synchronizing data. |
| StoreAndForward.FixDatabaseMessage | Status message on StoreAndForward database management |
| StoreAndForward.FixDatabasePercent | The total percentage already fixed from the database (Archive Location). |
| StoreAndForward.FixDatabaseElapsedTime | The time spent since the Store and Forward had 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 Name | The Historian Table's name. |
| Number of History Items | Items connected with that table |
| Number of Rows | The total number of rows of data stored in the Historian Table. |
| Initialization Message | The message provided when stating the Historian Table. |
| Target | The Storage Location connected with this table |
| Disable | Notifies if the Historian Table was disabled by the user before or while running the solution. You can control this option by accessing Runtime → Runtime Diagnostics. |
| Time Deadband | The dead band time configured for the Historian Table. For additional information, access Historian Tables. |
| Life Time | The duration in days for retaining records on the Archive Location. The system automatically deletes data older than the specified value. |
| Save On Change | Notifies if the Historian Table uses the Save On Change configuration to store new data. If true, whenever Tag's value changes, it triggers an event to store the new data. |
| Save Quality | Notifies if the Historian Table is using the Save Quality feature. Access Historian Tables for additional information related to the Save Quality. |
| Normalized | Notifies if the Historian Table uses the Normalize table schema for SQL databases. For more information on SQL database schemes, refer to the Archiving Process. |
| Deleting | The Table is executing Delete operation on records |
| Last Stored Time Stamp | The date and time of the previous data stored in the database. |
| Last Stored Error Message | Message alerting about the issue connected to the previous problem that is preventing the storage of data. |
| Last Deleted Time Stamp | The timestamp indicating the most recent instance when data was deleted from the database. |
| Last Deleted Error Message | Message alerting of an issue linked to the previous problem that hinders the removal of data from the database. |
| Last Samples Saved | Information on the last set of data save to the table |
| Last Step During Saving | Status messages when saving records |
| Error Count | Total number of errors related to the Historian Table operation. |
| Success Count | The total number of successful data storage actions. |
| StoreAndForward.IsActive | Flag if the Historian Table is using the Store And Forward feature. |
| StoreAndForward.NumberOfRows | Number of current rows in the StoreAndForward cache database |
| StoreAndForward.LastStartedTimeStamp | Provides information on the most recent synchronization of data between the Store and Forward process and the database. |
| StoreAndForward.LastSyncTimeStamp | Notifies the last time the database was synchronized. |
Note that some information available when selecting the HistorianTable from the Module Information are the same ones you can access when using the Historian Monitor.
Historian Trace Window
The Trace Window logs events connected with the Historian module execution. The Trace Window logs can have four message levels:
- Info: Report actions related to the usage of the Historian module.
- Warning: Alerts you to potential issues not currently blocking the system but may require your attention.
- Error: Report problems blocking one or more features from working properly, such as a database connection issue.
- Debug: Generated when you use debugging tools to inspect the state of an application at Runtime.
In this section: