Versions Compared

Key

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

Overview

When the solution is running , and the Designer is connected with the runtime, the Historian Monitor page show basic status of its Historian Table 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. a table of properties with real-time information about the alarms module. 

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 TrendChart 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 Alarm Historian Status of remote server. With the following URL.

http://localhost:3101/html5/?Solution=Monitor&StartupLayout=HistorianTrendHistorian

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.

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.

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

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 CountRowCount

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

Success CountSuccessCount

The total number of times the system successfully stored data in the databasetable

Error CountErrorCount

The number of times the system failed to save data into the databasetable

Last Stored Time StampLastStoredTimeStamp

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

Last Stored Error MessageLastStoredErrorMessage

The last error message encountered.

Info
titleAccess 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.

Image Removed

Info
titleAccess 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.

PropertyDescription
TablesThe total number of HistorianTables.
Items
The numbers of items on the tables
OpenStatusMessageStatus message when staring the Module
IsDeletingFlag to indicate the module is executing delete operations
StoreAndForward.IsEnabledSpecify if the system is using the Store and Forward feature.
UseStoreAndForwardDatabaseAlwaysFlat to indicate to always use StoreAndForward instaed of writing directly to historian.
HasPairRedudantStoreAndForwardPendingIndicates if a Forward process to update the database is waiting due to connection issues.
Redundancy.LastSyncMessageThe last message received after synchronizing data with the database.
Redundancy.LastSyncTimestampSpecify when the last synchronization happened.
Redundancy.LastSyncErrorMessageInform the last error message received when the synchronization failed.
Redundancy.LastSyncErrorTimestampSpecify when the last failed synchronization happened.
StoreAndForward.IsFixingDatabaseInform if the system is currently fixing the database data after facing issues synchronizing data.
StoreAndForward.FixDatabaseMessageStatus message on StoreAndForward database management
StoreAndForward.FixDatabasePercentThe total percentage already fixed from the database (Archive Location).
StoreAndForward.FixDatabaseElapsedTimeThe 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 NameThe Historian Table's name.Number of History ItemsItems connected with that tableNumber of RowsThe total number of rows of data stored in the Historian Table.Initialization MessageThe message provided when stating the Historian Table.TargetThe Storage Location connected with this tableDisableNotifies 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 DeadbandThe dead band time configured for the Historian Table. For additional information, access Historian Tables.Life TimeThe duration in days for retaining records on the Archive Location. The system automatically deletes data older than the specified value.Save On ChangeNotifies 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 QualityNotifies if the Historian Table is using the Save Quality feature. Access Historian Tables for additional information related to the Save Quality.NormalizedNotifies if the Historian Table uses the Normalize table schema for SQL databases. For more information on SQL database schemes, refer to the Archiving Process.DeletingThe Table is executing Delete operation on recordsLast Stored Time StampThe date and time of the previous data stored in the database.Last Stored Error MessageMessage alerting about the issue connected to the previous problem that is preventing the storage of data.Last Deleted Time StampThe timestamp indicating the most recent instance when data was deleted from the database.Last Deleted Error MessageMessage alerting of an issue linked to the previous problem that hinders the removal of data from the database.Last Samples SavedInformation on the last set of data save to the tableLast Step During SavingStatus messages when saving recordsError CountTotal number of errors related to the Historian Table operation.Success CountThe total number of successful data storage actions.StoreAndForward.IsActiveFlag if the Historian Table is using the Store And Forward feature. StoreAndForward.NumberOfRowsNumber of current rows in the StoreAndForward cache databaseStoreAndForward.LastStartedTimeStampProvides information on the most recent synchronization of data between the Store and Forward process and the database.StoreAndForward.LastSyncTimeStampNotifies 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:

    Page Tree
    root@parent
    spacesV10