Skip to content

Commit bce34a6

Browse files
committed
Proofread whole document.
1 parent 08e3ec4 commit bce34a6

File tree

3 files changed

+35
-22
lines changed

3 files changed

+35
-22
lines changed

content/en/docs/appstore/use-content/platform-supported-content/services/event-broker.md

Lines changed: 35 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -31,27 +31,27 @@ The Event Broker must be enabled on both the app and specific environment levels
3131

3232
### Managing the Mendix Event Broker {#manage-mx-broker}
3333

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.
3535

3636
#### Users for Event Broker Manager
3737

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.
3939

4040
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_internal_user.png" >}}
4141

4242
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_internal_user_2.png" >}}
4343

44-
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.
4545

4646
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_external_user.png" >}}
4747

48-
#### Environments and Spaces
48+
#### Spaces and Environments{#spaces}
4949

50-
**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.
5151

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.
5353

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.
5555

5656
#### Topics and Channels {#topics-channels}
5757

@@ -61,20 +61,20 @@ Events published by Free Apps are published to one shared company channel on a m
6161

6262
#### Event Access Control {#access-control}
6363

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/).
6565

6666
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:
6767

6868
* **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.
7070

7171
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_access_control_overview.png" >}}
7272

7373
Selecting the specific application provides an overview of the application's implemented events with their associated access.
7474

7575
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_access_control_overview_2.png" >}}
7676

77-
From this view, access to the individual events can be configured. Changes take effect immediately upon application.
77+
From this view, access to the individual events can be configured. Changes take effect immediately when **Apply Changes** is clicked.
7878

7979
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_access_control_overview_3.png" >}}
8080

@@ -84,8 +84,11 @@ From the main overview page, an administrator can assign the default behavior of
8484

8585
From here, you can manage the default access settings:
8686

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:**
89+
90+
* **Publish events it implements**
91+
* **Subscribe to events it implements**
8992

9093
## Mendix Event Broker Bridges {#manage-mx-broker-bridge}
9194

@@ -130,38 +133,46 @@ The creation process for AWS SQS bridges contains two further steps on the Mendi
130133

131134
#### Configuration Details
132135

133-
The next step of configuration is to select a [Space](#manage-mx-broker), Name, and Region for the bridge to operate in.
136+
The next step of configuration is to select a [Space](#spaces), Name, and Region for the bridge to operate in.
134137

135138
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_create_3_sqs.png" class="no-border" >}}
136139

140+
Click **Next** to continue the configuration.
141+
137142
#### Choose the Business Events to Integrate
138143

139144
The user must select events from the Event Broker landscape of events to send to or receive from AWS SQS. To do this, do the following:
140145

141146
1. Select **Add Business Events** and search for the appropriate events.
142-
2. Select the checkbox for the event you want to add, then click **Select**.
147+
2. Select the checkbox for the event(s) you want to add, then click **Select**.
143148

144149
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_create_4_sqs.png" class="no-border" >}}
145150

146151
3. Configure each event with its own SQS URL for each direction that the event will be integrated.
147152

148153
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_create_5_sqs.png" class="no-border" >}}
149154

150-
4. Confirm the configuration with the AWS Access Policy.
155+
4. Click **Next** to continue.
156+
157+
5. Confirm the configuration with the AWS Access Policy.
151158

152159
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_create_6_sqs.png" class="no-border" >}}
153160

154-
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**.
155162

156163
You will be taken back to the overview page.
157164

158165
Once the Mendix Event Broker Bridge has been successfully deployed, its configuration and status can be viewed on the **Overview** page.
159166

160167
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/bridges/event_broker_bridges_overview_sqs.png" class="no-border" >}}
161168

162-
#### Configure AWS Access Policy for Sending Messages to Mendix
169+
#### Configure AWS Access Policy
163170

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.
165176

166177
```
167178
{
@@ -179,7 +190,7 @@ Add this object to your Access Policy of the AWS SQS queue if it is sending mess
179190
}
180191
```
181192

182-
#### Configure AWS Access Policy for Receiving Messages from Mendix
193+
##### Receiving Messages from Mendix
183194

184195
Add this object to your Access Policy of the AWS SQS queue if it is receiving messages from Mendix.
185196

@@ -254,7 +265,7 @@ To run the HTTP bridge from your client, include a Bearer token in the request h
254265

255266
## Externally Defined Events {#externally-defined-events}
256267

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.
258269

259270
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).
260271

@@ -288,9 +299,11 @@ Select the spaces where the events will be used. When at least one space is sele
288299

289300
#### Successful Page
290301

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.
303+
304+
Click **Close** to continue.
292305

293-
{{< figure src="/attachments/appstore/platform-supported-content/services/event-broker/event_broker_ede_create_4.png" >}}
306+
For more information on how to use an event, see [Usages](#event-usages).
294307

295308
### Overview Page
296309

-211 KB
Loading

0 commit comments

Comments
 (0)