Documentation Center

EventMonitor 2.5 AddEventDetailWithProgress

Adds a new action to an existing event which is specified by the parameter plProgressId .


Parameters

NameTypeDirectionDescription
psAuthContextStringInOutDeprecated proprietary authentication context only used by .ASMX web services based on internal username/password authentication. Claims based security standards drive all the WCF .SVC web services making this parameter redundant.
plProgressIdLongInThe unique identifier of the event
peLeveleEventLevelInOne of the enumeration values that specifies the event level for the event detail
psActionStringInAction of the event (e.g. Request queued)
psDescriptionStringInDescription of the event
peStatuseDetailStatusInIndicates the status for the event detail
peDataTypeeEventDataTypeInIndicates the data type of the event data content.
pbDataBlobInThe event data content
piCurrentProgressInIndicates how much of the expected workload for the event was done. A negative number can be used to indicate that the current progresss doesn't need updating.
piMaximumProgressInThe number with the expected workload for the event
plOutDetailIdLongOutThe unique identifier of the newly added event detail

Note that:
  • The event must exist. So, make sure that the event is initialized by calling StartEvent
  • The event is only logged if the given EventLevel is lower than the configured EvenAppLevel. For example, EventAppLevel Verbose will log messages of level 'Exception', 'Warning', 'Information' and 'Verbose' but not the messages of level 'Debug'.
  • The size of psAction is limited to 255 characters. So, try to keep the action short. If the string is too large, the string will be truncated!
  • The size of psDescription is limited to 2000 characters. If the string is too large, the string will be truncated!
  • Creation date is set to the current date (and time)
  • ProcessId , ThreadId and HostName are set automatically
  • The piMaximumProgress specifies the upper limit for the current progress. If everything went well at the end of your (background) process, the current progress should be the same as the maximum progress.

    The value of the maximum progress can be anything you want:
    • The total number of objects to process. In this case you can raise the current progress with each object that is (successfully) processed
    • The timeout duration of an event. So, 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.
    • Another possibility is to use percentages. The maximum progress is 100 and after executing x percent of the background process, you can raise the current progress accordingly.
  • A negative number can be used to indicate that piCurrentProgress and/or piMaximumProgressdoesn't need updating.