Audit Message Framework Workflow Auditing

By using the Audit Message Topic bind, JavaScript business rules can be applied to entire workflows or to individual workflow transitions to send audit messages. The JavaScript creates a JSON message object and uses the bind's API sendMessageAsync method. The JSON message is received and handled by the plugin associated with a specific topic. The examples in this guide use the out-of-the-box Audit Message Receiver JDBC database delivery plugin, but the functionality is the same when using the Audit Message Receiver Cassandra database delivery plugin.

Note: The JSON message format is required for both the Audit Message Receiver JDBC Delivery plugin and Audit Message Receiver Cassandra Delivery plugin. A custom plugin could handle messages in an entirely different format if desired (e.g., a comma separated list).

The topics in this documentation section provide configuration instructions and sample JavaScript code for auditing workflows both at the workflow-wide level and at the individual transition level:

  • The Auditing an Entire Workflow topic provides information about the default 'Workflow Audit Action' business action that is automatically created in STEP when the Audit Message Framework component is activated on your system.
  • The Auditing by Workflow Transition topic provides two sample audit message business actions that can be used to audit individual workflow transitions. One example captures information about a workflow business condition failure, and the second captures a workflow state 'on entry' audit message.