Event logger

An event logger records the properties of a single or multiple events of interest types.

Database configuration

Databases are automatically configured for event loggers.
When you select a database for an event logger, a table for each Event logger object is created in database. Each table column corresponds to a data/property of interest of the event.
Depending on the design requirements, you can record a single type of event or several types of events with the same event logger.
A logger for each event of interest type
Every event type has a dedicated table in the database. Each column of the table corresponds to a property of interest of a given event type. In each table row (for each event), the same columns are assigned a value.
A logger for several events of interest types
The properties of all events are recorded in a single database table. The table columns relate to all properties of interest of all event types recorded. In each table row (for each event), only the columns that relate to the reference event type are assigned a value.
TIP:
An
Audit event logger
 object is available in the template library and is configured to record these events.
  • UserSessionEvent
  • RecipeApplicationEvent
  • AuditConditionEventType
TIP: You can export the event logger data to a CSV file or view it in the application in a data grid. See Export a database table to a CSV file.

Events source

For each event of interest type, you can choose from these sources:
  • A specific object
  • A project node with its child nodes/objects
    TIP: Typically, a project node that contains several objects that generate the events of interest.
  • All objects in the project
The Event logger records the data of all events of interest generated by all objects considered as event sources.
TIP: You can set the
Non-interactive sessions excluded
 property to record only the events generated by user interactions with the application and exclude the events generated by other logics (for example, a change event).

Events auditing

You can record the operations that users perform at runtime. Use this data to perform quality checks or to certify applications in specific contexts.
An event logger can record audit events concerning these operations.
  • Write on variables
  • Edit node attributes
  • Create and destroy nodes
  • Execute methods
  • Login and logout
For example, an audit event is generated when a user selects an object, which invokes a method. However, an audit event is not generated when the application logic independently of the user actions invokes the same method.
Common audit event types
Audit event type
Description
AuditEventType
All audit events
AuditNodeManagementEventType
Creation or destruction of nodes
AuditWriteUpdateEventType
Change of the variable value or a node attribute
AuditUpdateMethodEvent
Execution of a method
AuditConditionEventType
Execution of alarm methods
AuditConditionAcknowledgeEventType
Execution of the alarm
Acknowledge
 method
AuditConditionCommentEventType
Execution of the alarm
Add comment
 method
AuditConditionConfirmEventType
Execution of the alarm
Confirm
 method
AuditConditionEnableEventType
Change of the alarm enabled/disabled status
RecipeApplicationEvent
Recipe applications
UserSessionEvent
User login and logout events
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.