Event Logs
From Sym3 V6.2, all Controls in the Operator Toolbox now support the ability to enable an event log for the control. The event log is stored (and globally configured) in the Alarm Server database so is dependant upon this functionality (if connection can not be made to the Alarm Server then the Event can not be logged).
All events are triggered from the Client. Some events are enabled by default and cannot be disabled:
- Client starts
- Client ends (in a controlled manner)
- User logs in
- User logs out (manual or auto)
- User login failed
- Client connection to Server
- Client disconnection from Server
Event logs can be also be generated from the client or server via scripting.
Example creating an Event log from the Client (in MainClientScript)
...
Client.Events.AddLog("This is a Client custom log"); // Time and user fron current client values
...
Example creating an Event log from the Server (in MainServerScript)
...
Server.Events.AddLog("This is a Server custom log"); // Time from server value. No user entry
...
In these examples the event can be created when a Tag value changes if a callback is Subscribing to a Tag value change.
If Event Logs are enabled for a control then any events created by that control are logged in the database by time, machine and user. The new Event Display control allows these events to be viewed and filtered much the same as the Alarms can be viewed and filtered.
Events in the log are read only. Event logs past the retention period specified in the Server settings are automatically removed.
The controls that support User Event Logs are:
| Control | Type | Default log entry |
|---|---|---|
| Hotkey | On key pressed | Hot key ‘%This.Key%’ pressed |
| Menu | On clicked | %This.Text% clicked on menu %This.Menu.Name% |
| Button | On button clicked | %This.FullName% clicked |
| Text Display | On value changed | %This.FullName% Value Changed to %This.Value% |
| Numeric Display | On value changed | %This.FullName% Value Changed to %This.Value% |
The state and values for the log can be found in the Event Log section on each of these controls.
A variable for the control can be specified in the log entry that is expanded to the full name when evaluated. This can be specified just as Aliases are used. The default variables that are accepted can be found from the tooltip popup at the right hand side of the log entry field;
