Documentation Center

Changes to the class EventMonitor 2.5

Describes the changes in the class EventMonitor2.5 that were made in release 2.5 of the API.

Changes in behavior

No logging in Window EventViewer

The EventMonitor.SetEvent method of the EventMonitor Web Services caught all exceptions and tried to log the exception (and the original message) into Window EventViewer.

Starting with Web Services 2.5, EventMonitor no longer catches the exceptions or tries to log anything into Window EventViewer.

You must catch (and handle) the exception if you want the code of the background task to continue when an exception within EventMonitor occurs.

New property "EventAppLevel" to reduce logging

In EventMonitor Web Services every event was logged which generated a lot of unwanted (and unused) information. Starting from Web Services 2.5 there is a new registry setting EventAppLevel which is used to limit the event(details) that are logged. The default value for EventAppLevel is Verbose indicating that everything except debug information must be logged.

Ability to control information on progress of task
Starting from Web Services 2.5 the Event Monitor has 2 levels of information:
  • An event(progress) level which must always be available. The event progress level contains a short description and some extra information about the progress (current and maximum) (see StartEvent).
  • The event detail which corresponds with the previous Event Monitor information. This level contains the action, description and event data (if necessary) (see AddEventDetail)
The progress information can be used to indicate anything needed:
  • The total number of objects to process. In this case you can raise the current progress with each object that is (successful) processed.
  • The timeout duration of an event. If you know that the process will have a duration of about 1 hour, you can initialize the maximum progress to 60 minutes and raise the current progress every minute.
  • The use of percentages. The maximum progress is 100 and after executing x percent of the background process, you can raise the current progress accordingly.