EventMonitor 2.5 AddEventDetailWithProgress
Adds a new action to an existing event which is specified by the parameter plProgressId .
Parameters
| Name | Type | Direction | Description |
|---|---|---|---|
| psAuthContext | String | InOut | Deprecated 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. |
| plProgressId | Long | In | The unique identifier of the event |
| peLevel | eEventLevel | In | One of the enumeration values that specifies the event level for the event detail |
| psAction | String | In | Action of the event (e.g. Request queued) |
| psDescription | String | In | Description of the event |
| peStatus | eDetailStatus | In | Indicates the status for the event detail |
| peDataType | eEventDataType | In | Indicates the data type of the event data content. |
| pbData | Blob | In | The event data content |
| piCurrentProgress | In | Indicates 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. | |
| piMaximumProgress | In | The number with the expected workload for the event | |
| plOutDetailId | Long | Out | The 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
EventLevelis lower than the configured EvenAppLevel. For example,EventAppLevelVerbosewill log messages of level 'Exception', 'Warning', 'Information' and 'Verbose' but not the messages of level 'Debug'. - The size of
psActionis 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
psDescriptionis limited to 2000 characters. If the string is too large, the string will be truncated! Creation dateis set to the current date (and time)ProcessId,ThreadIdandHostNameare set automaticallyThe
piMaximumProgressspecifies 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
piCurrentProgressand/orpiMaximumProgressdoesn't need updating.