Companies are increasingly using data to improve agility, deliver personalized experiences, accelerate time-to-market, and increase customer satisfaction. The Audit Message Framework (AMF)—a powerful message delivery solution that allows users to send configurable messages to external Cassandra or JDBC-compliant database systems (for example, an Azure SQL cloud-based database for SaaS systems)—can help your business achieve these objectives by exposing and extracting data in STEP that can be processed for statistical analysis.
This data can be used to support the auditing of workflows and related data, such as helping users determine where objects in a workflow are spending most of their time, and why conditions fail for particular objects in a workflow. The resulting data can be analyzed and blended with data from third-party systems, via business intelligence (BI) tools, to provide valuable insights that identify issues and improve processes. The gathering and analysis of this data can also help improve legal compliance.
Prerequisites
To access the Audit Message Framework and functionality, the Analytics commercial license must be enabled on your system. Contact Stibo Systems for more information about the Analytics commercial license and its associated components / system licenses.
Additional setup tasks and system configurations must also be performed by Stibo Systems Technical Services and/or SaaS Operations teams. This includes installing and setting up internally required components like Kafka and ZooKeeper and updating system properties. A private endpoint connection can be configured (by the SaaS team) via request. Additional setup on the part of the customer may be needed. If you have the Analytics commercial license and want to implement this solution, submit an issue within the Stibo Systems Service Portal. The appropriate Stibo Systems team will reach out to get the specific information needed to complete the configuration.
About this Guide
The subtopics in this documentation section, listed below, provide an overview on how to get started with the Audit Message Framework, along with sample JavaScript workflow auditing business actions that can be used for entire workflows or on individual workflow transitions.
- Audit Message Framework Functionality Overview
- Audit Message Framework Configuration Properties and Monitoring
- Audit Message Framework JavaScript Binds and Public JavaScript API Methods
- Audit Message Framework Example Message
- Audit Message Framework Database Data Type Mapping
- Audit Message Framework Example Database Output
- Audit Message Framework Workflow Auditing
- Auditing an Entire Workflow
- Auditing by Workflow Transition
The Audit Message Framework is also available to users of systems with the Analytics components enabled, which includes Web UI access to Power BI, Tableau, and Qlik. Refer to the Visual Integration with External Analytics Tools section of this guide for more information.
For additional information about the JavaScript API interface and creating JavaScript based Business Rules in STEP, refer to the Scripting API section of the Technical Documentation. For additional information on Audit Message Receiver plugins, refer to the Extension API section of the Technical Documentation. The Technical Documentation is available at [system]/sdk and is also accessible from the Start Page of your STEP instance.