ClientMonitor
ClientMonitor
The ClientMonitor is a specialized table object that allows you to monitor the real-time status of connections your SCADA system makes as a Client to external sources or servers (TCP, UDP, WebSocket, SetupClientMode, MQTT Publisher/Subscriber, Pages, etc.).
For standard Properties, Advanced, and Events Panel settings not covered here, please refer to the Common Object Features page.
Basic Operation and Column Structure
When the object is added to the screen, it comes with default columns summarizing the connection statuses. When the page is closed and reopened, the last information continues to be retained on the screen. The structure of the table is as follows:
- Object: Displays the name of the connected Client protocol or object (e.g., WebServer, Pages, MQTT, etc.).
- State: Indicates whether the Client is currently active (Enable). The State is represented by colors defined in the Advanced Panel.
- Status: Indicates whether the Client has successfully connected to the server. Like the State column, this area is filled with colors (e.g., Green=Connected, Red=Fault).
- Server Address: Displays the IP or address information of the server the Client is connected to.
- Last Access Time: Displays the time of the last successful query. If a connection error occurs (disconnection, etc.), the time is not reset; the last successful time is preserved on the screen.
- Comment: The description field entered by the project engineer for the relevant connection during the setup phase.
Advanced Panel – Key Properties
- 0. Settings (Color Configuration)
This is the main area where the fill colors for the State and Status columns in the table are defined:- StateDisableColor / StateEnableColor: Colors to be applied to the “State” cell when the Client is passive or active (e.g., Light Green for Active, Gray for Passive).
- StatusConnectedColor / StatusFaultColor / StatusInactiveColor: Colors to be applied to the “Status” cell when the connection is Connected, Fault, or Inactive.
- 1. Child Controls
These are the pop-up window settings used to customize the internal table structure of the object in detail:- _ResultGrid: The area where basic settings for the main grid structure of the table (DataGrid features) are configured.
- _ResultGridColumns: Opens a new window allowing you to manage the columns in the table individually. From this window, you can configure details for each column, such as its header (HeaderText), width (Width), visibility (Visible), and auto-sizing mode (AutoSizeMode).
General Usage Examples
Example: WebServer Connection Tracking
- Add a ClientMonitor to your screen.
- When the system is running and the WebServer protocol successfully connects to the server, the Status column takes your defined StatusConnectedColor (e.g., Green), and the Last Access Time column starts displaying the last access time by updating it instantly.
- If a network disconnection occurs or the connection is lost, the ClientMonitor detects this instantly in the background and automatically changes the Status column to the StatusFaultColor (e.g., Red).
- Meanwhile, the “Last Access Time” freezes at the last successful time before the error and continues to preserve this information on the screen.
