Enabling the audit log

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
You can enable an audit log to track configuration changes and administrative actions in your workflow environment. The audit log captures changes made by any user through various interfaces, including the Process Admin Console, REST APIs, and command-line tools.

Procedure

By default, the audit log is disabled. To enable it, add the following configuration in the 100Custom.xml file.
  • audit-file-location: The full path name to an existing directory where the logs will be stored. This parameter must be set.
  • audit-file-name: Name of the audit file to use, ending in .log. The default is bawaudit.log.
  • audit-rollover-size: Size (in MB) at which the audit file will roll over. The default is 100.
  • audit-enabled: Enable auditing. The default is false.
  • verbose: Add additional information to the log message. This additional information requires database queries, for example originalData to see the previous value. The default is true.
  • max-historical-files: Maximum number of rolled-over files to keep before the old ones get removed. Use -1 for no cleanup. The default is 5.
See the following example.

<server>
   <audit-config>
      <audit-file-location merge="replace">C:/BAW/AppServer/profiles/StandAloneProfile/logs/server1</audit-file-location>
      <audit-file-name merge="replace">bawaudit.log</audit-file-name>
      <audit-rollover-size merge="replace">100</audit-rollover-size>
      <audit-enabled merge="replace">false</audit-enabled>
      <verbose merge="replace">true</verbose>
      <max-historical-files merge="replace">5</max-historical-files>
    </audit-config>
</server>

What to do next

The audit log captures a wide range of activities and events, including:

  • Process runtime events (starting, suspending, resuming, terminating, and deleting process instances)
  • Task management actions (claiming, assigning, completing, and updating tasks)
  • Administrative operations (managing exposed process values, event managers, instance migration, environment variables, and server variables)
  • User, group, and team management activities (synchronization, creation, updates, and deletion)

For a complete list of all audit events that can be logged, see Business Automation Workflow audit log events.