You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/appstore/use-content/platform-supported-content/services/event-broker.md
+35-22Lines changed: 35 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,27 +31,27 @@ The Event Broker must be enabled on both the app and specific environment levels
31
31
32
32
### Managing the Mendix Event Broker {#manage-mx-broker}
33
33
34
-
Technical Contacts with a license to the Mendix Event Broker can manage its features on the [Event Broker Manager](https://broker.mendix.com/) page.
34
+
Technical Contacts with a license for the Mendix Event Broker can manage its features on the [Event Broker Manager](https://broker.mendix.com/) page.
35
35
36
36
#### Users for Event Broker Manager
37
37
38
-
Users within the company's email domain that have a Mendix login can participate in the administration of the Mendix Event Broker as either a View or Admin user. They can also be blocked from participation.
38
+
Users within the company's email domain that have a Mendix login can participate in the administration of the Mendix Event Broker as either a View or Admin user. They can also be blocked from participation.
Users that are not part of the customer organization (not within the email domain of the customer) can be invited within the same levels of access. Such users still require a standard Mendix login.
44
+
Users that are not part of the customer organization (not within the email domain of the customer) can be invited with the same levels of access. Such users still require a standard Mendix login.
**Space** define which applications can exchange events with each other. When Business Events is enabled for an environment, it is placed in an Event Broker **Space** based on the environment name. This enables apps deployed under the same **Space** to publish and consume events. For example, apps in acceptance environment can only exchange events with other apps' acceptance environments. You can check the **Space** of an app's environment on the [Event Broker Manager](https://broker.mendix.com/) page.
50
+
Spaces define which applications can exchange events with each other. When Business Events is enabled for an environment, it is placed in an Event Broker space based on the environment name. This enables apps deployed under the same space to publish and consume events. For example, apps in acceptance environment can only exchange events with other apps' acceptance environments. You can check the space of an app's environment on the [Event Broker Manager](https://broker.mendix.com/) page.
51
51
52
-
Spaces are created and assigned based on the app environment name and allow isolation of your business events. The default behavior can be changed if needed. Contact [Mendix Support](https://support.mendix.com/) if you would like to change the **Space** of a specific app environment.
52
+
Spaces are created and assigned based on the app environment name and allow isolation of your business events. The default behavior can be changed if needed. Contact [Mendix Support](https://support.mendix.com/) if you would like to change the space of a specific app environment.
53
53
54
-
See [Enabling the Mendix Event Broker Service](#enable-mx-event-broker) for more information.
54
+
See [Enabling the Mendix Event Broker Service](#enable-mx-event-broker), above, for more information.
55
55
56
56
#### Topics and Channels {#topics-channels}
57
57
@@ -61,20 +61,20 @@ Events published by Free Apps are published to one shared company channel on a m
61
61
62
62
#### Event Access Control {#access-control}
63
63
64
-
The Mendix Event Broker allows for access control to be applied down to the event level. Each application can be granted or denied access to events using the [Event Broker Manager](https://broker.mendix.com/).
64
+
The Mendix Event Broker allows access control to be applied down to the event level. Each application can be granted or denied access to events using the [Event Broker Manager](https://broker.mendix.com/).
65
65
66
66
The overview page contains a list of applications by environment within the organization's event landscape. The table contains columns that provide cases with exceptions:
67
67
68
68
***Implemented but no access** - an application has implemented an event that it is not allowed to access, guaranteeing a failure to subscribe to and/or publish the event
69
-
***Has access but not implemented** - an application has been provided with more access than is required and thus can be secured more accurately
69
+
***Has access but not implemented** - an application has been provided with more access than is required and you could make it more secure.
@@ -84,8 +84,11 @@ From the main overview page, an administrator can assign the default behavior of
84
84
85
85
From here, you can manage the default access settings:
86
86
87
-
***An app can access events defined in it** – allows newly-deployed applications to always have access to any events defined within that application (see [Creating a New Business Event Service](/appstore/services/business-events/#two-way-be-create) for more information)
88
-
***For other events, in all environments, the app can:** – allows administrators to turn on or off the default assigning of event access
87
+
* Allowing **An app can access events defined in it** – allows newly-deployed applications to always have access to any events defined within that application (see [Creating a New Business Event Service](/appstore/services/business-events/#two-way-be-create) for more information)
88
+
* Administrators can check two options under **For other events, in all environments, the app can:**
5. After all events have been configured, click **Start** to start the Mendix Event Broker Bridge. This process will take several minutes to complete. You can also choose to **Start Later**.
161
+
6. After all events have been configured, click **Start** to start the Mendix Event Broker Bridge. This process will take several minutes to complete. You can also choose to **Start Later**.
155
162
156
163
You will be taken back to the overview page.
157
164
158
165
Once the Mendix Event Broker Bridge has been successfully deployed, its configuration and status can be viewed on the **Overview** page.
#### Configure AWS Access Policy for Sending Messages to Mendix
169
+
#### Configure AWS Access Policy
163
170
164
-
Add this object to your Access Policy of the AWS SQS queue if it is sending messages to Mendix.
171
+
You need to configure AWS access policies for both sending and receiving messages.
172
+
173
+
##### Sending Messages to Mendix
174
+
175
+
Add this object to the Access Policy of your AWS SQS queue if it is sending messages to Mendix.
165
176
166
177
```
167
178
{
@@ -179,7 +190,7 @@ Add this object to your Access Policy of the AWS SQS queue if it is sending mess
179
190
}
180
191
```
181
192
182
-
####Configure AWS Access Policy for Receiving Messages from Mendix
193
+
#####Receiving Messages from Mendix
183
194
184
195
Add this object to your Access Policy of the AWS SQS queue if it is receiving messages from Mendix.
185
196
@@ -254,7 +265,7 @@ To run the HTTP bridge from your client, include a Bearer token in the request h
254
265
255
266
## Externally Defined Events {#externally-defined-events}
256
267
257
-
Externally defined events refer to events that are defined outside the Mendix application, specifically outside of Studio Pro.
268
+
Externally defined events refer to events that are defined outside the Mendix application, specifically outside Studio Pro.
258
269
259
270
The Mendix Event Broker allows users to upload an AsyncAPI document for these external events. Once uploaded, users can download a new AsyncAPI document compatible with [Mendix Business Events](/appstore/services/business-events/), which can then be imported into Studio Pro to share the events across Mendix applications or use them in a new [Bridge](#manage-mx-broker-bridge).
260
271
@@ -288,9 +299,11 @@ Select the spaces where the events will be used. When at least one space is sele
288
299
289
300
#### Successful Page
290
301
291
-
The externally defined events have been successfully uploaded and are now ready to be used in Bridges or applications. For more information on how to use an event, see [Usages](#event-usages).
302
+
You will get a confirmation that the externally defined events have been successfully uploaded and are now ready to be used in Bridges or applications.
0 commit comments