Business Event Services

1 Introduction

Studio Pro 9.18 and above integrates with Mendix Business Events module functionality. With the Mendix Business Events module, applications can signal when something important happens, and can subscribe to these events if they want to be informed. Business events are like a mailing list to share event notifications between apps.

This page references the Business Event Service documents in Studio Pro. See Mendix Business Events for the complete documentation.

2 Business Event Service Documents

The Business Event Service document is added to your app in Studio Pro when you create a business event service.

The service documents themselves, and way to create a business event service, differ depending on which version of Studio Pro you are using.

2.1 Business Event Services in Studio Pro 9.18 through 9.23

Business event services in Studio Pro 9.18 through 9.23 are published by one app and consumed by one or more other apps.

2.1.1 Published Business Event Services

A Published Business Event Service is the document defining various events, like a REST API spec. To add a published business event service, right-click on a module in your app and go to Add other > Published Business Event Service. The published business event service document is open in Studio Pro:

2.1.2 Consumed Business Event Services

To subscribe to a business event, you first need to create a Consumed Business Event Service. Right-click on a module in your app and go to Add other > Consumed Business Event Service. The published business event service document is open in Studio Pro:

2.2 Business Event Services in Studio Pro 9.24 and Above

Business event services in Studio Pro 9.24 and above are defined centrally by one app for a specific use case. Other apps can send or receive these predefined events.

2.2.1 Creating a New Business Event Service

To create a new business service in Studio Pro 9.24 and above, right-click on a module in your app and go to Add other > Business event service > Create a new business event service. The business event service document is open in Studio Pro:

See the Creating a New Business Event Service section of Mendix Business Events for more extensive documentation.

2.2.2 Using an Existing Business Event Service

To create a new business service in Studio Pro 9.24 and above, right-click on a module in your app and go to Add other > Business event service > Use an existing business event service. After importing the YAML file, the business event service document is open in Studio Pro:

See the Using an Existing Business Event Service section of Mendix Business Events for more extensive documentation.