Mendix Business Events

Category: Modules
Subcategory: Messaging

Overview

The Business Events module should be used with Studio Pro 9.18.0+

Introduction

With Mendix Business Events, applications can signal when something important has happened, and can independently subscribe to these events if they want to be informed. Events are delivered in near real-time, to minimize the time your users have to wait. Business events are like a mailing list to share event notifications between apps.

The key difference between business events and traditional communication between apps, like REST or Web Services, is that there is no direct communication between the different apps. Applications publish events to, or subscribe to events with, an event broker. This optimizes availability for your applications, as applications are not impacted by downtime of other applications. It also simplifies your applications, as you reduce the need for applications to be aware of other applications, simplifying dependency management and impact analysis when changing your software.

To deliver events reliably between your applications, a Mendix Event Broker is required. For apps running the Mendix cloud on licensed nodes, you'll need to purchase a license for a Mendix Event Broker. A limited multi-tentant Event Broker is provided for free apps in the Mendix cloud. If desired for development, you can run your own broker cluster.

Currently, business events can only be deployed to the Mendix Cloud, with other deployment models expected in forthcoming releases.

Typical Use Cases

Business events help you automate the resulting actions when something happens in your organization. The following are examples of when business events can be useful:

  • Registering payments in a financial app, with another app sending a receipt

  • Making an appointment with a service provider in an appointment app, then needing it to be added to the scheduling app of the service provider

  • Customers placing an order in a webshop, and other apps need to take follow-up actions like scheduling shipment, sending the invoice, and reordering inventory stock

Pre-Requisites

To use Mendix Business Events, you will need the following:

  • The Mendix Business Events module from the Mendix Marketplace

  • Studio Pro 9.18 and above

  • At least two Mendix apps: one that publishes the business events and makes them available, and one that subscribes to the business events (you can have as many publishing and consuming apps as you require)

  • An event broker, either a licensed Mendix Event Broker for apps running in the Mendix Cloud or for local testing the local testing broker (see Deployment in mendix docs)

  • Docker for local deployment

 

Documentation

Please see Business Events in the Mendix documentation for details.

Releases

Version: 3.2.0
Framework Version: 9.18.0
Release Notes: Changes in version 3.2.0 - Removed consume business event java action from mendix toolbox, users do not have to set it up manually. - Restructured documents in the module.
Version: 3.1.1
Framework Version: 9.18.0
Release Notes: General notes First public release of the Business Events module, it should be used with Studio Pro 9.18.0 and newer. With the Mendix Business Events module, applications can signal when something important happens, and can independently subscribe to these events if they want to be informed. See the Mendix docs for more information https://docs.mendix.com/appstore/modules/business-events/. Changes in version 3.1.1 - upgrade kafka clients to 3.1.2 to address vulnerability CVE-2022-34917