Integration Server 10.11 | Built-In Services Reference Guide | Event Folder | Summary of Elements in this Folder | pub.event:audit
 
pub.event:audit
WmPublic. Specification for audit event handlers.
Input Parameters
time
String Date and time that the event occurred, in the format yyyy-MM-dd HH:mm:ss z (for example, "2004-10-28 14:46:39 EDT").
Note:
You can set the format for the time parameter in the watt.server.dateStampFmt property.
TID
String Server thread that generated the audit event.
service
String Fully qualified name of the service that generated the event.
sessionID
String Session ID of the service that generated the event.
result
String Description of the audit point. A value of:
*Started indicates that this event marks the beginning of a service.
*Ended indicates that this event marks the end of a service that executed successfully.
*Failed indicates that this event marks the end of a service that executed unsuccessfully (that is, threw an exception) and is not configured to retry. A failed event also marks the end of a service that executed unsuccessfully after exhausting all of its retries.
*Retried indicates that this event is created each time a service is retried.
pipeline
Document Optional. The pipeline that was passed to the service. This parameter is required only if the service is configured to include the pipeline when auditing.
userName
String User ID that invoked the service that generated the event.
Output Parameters
None.
Usage Notes
Events are created for a service only if auditing for that type of event is enabled for the service. For example, start events will not be created unless auditing for service start is enabled for that service.
Remember to register your handler with the Event Manager. Not all audit handlers that you code will log information.
When writing your own audit handler, be careful to not modify the pipeline variable within your handler.
Use the watt.server.event.audit.async server parameter to indicate whether event handlers for audit events are invoked synchronously or asynchronously. When this parameter is set to true, Integration Server invokes the event handlers that subscribe to audit events asynchronously. When this parameter is set to false, Integration Server invokes the event handlers that subscribe to audit events synchronously. The default is true (asynchronous).