<< Click to Display Table of Contents >>
Events Recording Tab |
Events are divided into System Default Events and Manual Events categories.
System Default Events are events automatically generated by Elipse Power and that may have their registration enabled or disabled individually. The available events are the following:
•User login or logout
•Changes in user passwords
•Failures in user logins
•Changes on the user database
•Blocking user accounts
•Starting or ending a Domain
•Changes in a Domain, such as inserting, removing, enabling, or disabling projects and libraries, or changing the configuration of a Domain
•Updates in a Domain, that is, when a user applies changes performed in projects using Elipse Power Studio
•Manual switching of servers in Hot-Standby mode
•Creating users
•Modifying users
•Removing users
•Renaming users
•Changing user policies
•Creating groups
•Modifying groups
•Removing groups
•Renaming groups
•Changing group policies
•Changes on the Events recording tab
•Changes on the Security group of the Properties tab
•Unblocking user accounts
Manual Events are events defined by an application. These events are generated by user-defined scripts, by using the Application.TrackEvent method. These events can be generated both in Elipse Power Viewer and in E3Run.
Elipse Power Viewer is only a generator of manual events. Use the Application.TrackEvent method to send an event to E3 Server.
The diagram on the next figure shows how different Elipse Power processes generate and handle system events.
Process diagram
Every E3 Server maintains an internal list of events that must be stored on a database. These events can come from the following sources:
•Events generated by Elipse Power Viewers using the Application.TrackEvent method
•Events generated internally by an E3 Server
•Events generated by a E3 Server in Standby mode
The E3 Server Standby periodically sends an event list to the E3 Server Hot, because only this one is capable of storing events on a database. These events are placed on E3 Server Hot's event queue, along with other system events, that is, the E3 Server Hot centralizes event recording.
If there is a server switching, events that were not recorded yet are automatically sent to the new E3 Server Hot.
E3Run stores on a database all records sent by the E3 Server Hot. E3 Server then informs the name of the Database and the table to store data.
To configure event recording in Elipse Power, right-click the E3 Admin icon on Windows Notification Area, select the Domain - Options option to open the window on the next figure, and then click the Events recording tab.
Events recording tab
The available options on this tab are displayed on the next table.
Available options on the Events recording tab
Option |
Description |
---|---|
Enable system events recording |
Enables event recording in Elipse Power. When selecting this option, the Table name option must be filled in |
Table name |
Indicates a table where events are stored. This table is created automatically by E3Run. Fields on this table are E3TimeStamp (Date/Time): This field is configured by E3Run and contains the date and time when E3Run sent that event to the database, EventTime (Date/Time): Date and time this event actually happened, server's current date and time, Hot or Standby, when this event was created, or else the dtTimeStamp parameter specified by the Application.TrackEvent method, EventMessage (String): Event message, with a maximum of 200 characters, and EventComment (String): Comment about this event, with a maximum of 200 characters |
Automatically select application database |
Enable this option to let E3Run pick up a Database object to store data. If an application contains only one Database, this Database is used. If there is more than one Database, it is recommended to select the Use this database option |
Use this database |
Enable this option to specify a Database where events are stored. If the name of a Database was incorrectly informed, all events remain stored on E3 Server's event queue, in memory, until a valid Database is selected |
Check below the events to be logged |
Lists all available events in an application for storage |
If E3Run must select among several Databases, usually the first Database activated during Domain execution is selected. If during Domain execution users disable the project containing the Database used to store events, E3Run automatically picks up another Database available in the application and uses this Database until the previous Database is re-activated. This implies that, if there are more than one Database in a project, some events may be stored in one Database while other events are stored in another Database. That is why it is advisable to indicate a specific Database when there is more than one Database in a project.
When selecting an event on the list and pressing the F2 key, a dialog box for editing that event is opened, displayed on the next figure.
Event editor
Deselect the Use default message option to change the message of an event. Click to insert a macro in a message. Only macros allowed for that selected event are displayed on the contextual menu of a message.
Viewing available macros for the selected event
Macros are always in the %MACRO% format. The following macros can be used:
•%%: Inserts a percent sign in a message
•%NAME%: Inserts the name of a user or group that was affected by an event
•%NEWNAME%: Inserts the new name of a user or group that was renamed by an event
•%USER%: Inserts the name of the user that generated the event, or "Anonymous" if there is no user logged in
•%MACHINE%: Inserts the name of the computer where the event was generated
•%SESSION%: Inserts the name of the application where a user was logged in, that is, Elipse Power Viewer, Elipse Power Studio or E3 Server
•%CAUSE%: Additional information about an event
For example, if the message of a Login Failure event is changed to:
"%USER% user login has failed at computer %MACHINE% (using a %SESSION%): %CAUSE%"
If the Admin user mistypes the password while logging to Elipse Power Viewer, which is executing on the computer CLIENT004, the following event is then generated:
"Admin user login has failed at computer CLIENT004 (using a Viewer): incorrect login or password"
Default system events are described on the next topics.