Configuring Service Auditing

When you configure auditing for a service, you can determine if and when a service generates audit data and whether the service log includes a copy of the service’s input pipeline or select fields. Make sure that you select options that will provide the service log with the audit data you require.

Keep the following points in mind when configuring service auditing:

Before you select options for generating audit data, check with your Integration Server Administrator to determine what kind of service log exists. A service log can be a flat file or a database.

The options you select in the Audit category of the Properties view can be overwritten at run time by the level set for the Service Logger in Integration Server. View the Service Logger level on the Logs > Logging Configuration > Service Logger > View Service Logger Details page of Integration Server Administrator.

The service generates audit data only when it satisfies the selected option under Enable auditing and the selected option in the Log on property. For example, if When top-level service only is selected and the service is not the root service in the flow service, it will not generate audit data.

The pipeline data saved in the service log is the state of the pipeline just before the invocation of the service. It is not the state of the pipeline at the point the service generates audit data.

Including the pipeline in the service log is useful only when the service log is a database. Integration Server cannot save the pipeline to a flat file service log.

When a service generates audit data, it also produces an audit event. If you want the audit event to cause another action to be performed, such as sending an e-mail notification, write an event handler. Then subscribe the event handler to audit events. For more information about events and event handlers, see Subscribing to Events

If you want audit events generated by a service to pass a copy of the input pipeline to any subscribed event handlers, set Include pipeline to On errors only or Always.

Integration Server can also log select fields from the service signature. Logged fields can be viewed in the webMethods Monitor. For information about field logging, see Logging Input and Output Fields.

You can associate a custom value with an auditing context. The custom value can be used to search for service audit records in the webMethods Monitor. For information about creating and logging custom values for auditing contexts, see Assigning a Custom Value to an Auditing Context.

To configure service auditing, you must have write access to the service and own the lock on the service or have it checked out.

For detailed information about the Audit properties, see Audit Properties.

1. In the Package Navigator, double-click the service for which you want to configure service auditing.

2. In the Audit category of the Properties view, select an Enable auditing option to indicate when you want the service to generate audit data.

3. For Log on, select an option to determine when the service generates audit data.

4. For Include pipeline, select an option to indicate when Integration Server should include a copy of the input pipeline in the service log.