Skip to content

Commit d9ca587

Browse files
authored
Merge pull request #11224 from semiramaria/UIA-1555-Global-Inbox-Business-Events-For-Free
UIA-1555 Global Inbox Update Docs add free deployment options
2 parents 0e7a33e + 8aab31d commit d9ca587

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

  • content/en/docs/marketplace/platform-supported-content/modules

content/en/docs/marketplace/platform-supported-content/modules/global-inbox.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -101,24 +101,23 @@ Make sure the Global Inbox app is deployed and running before deploying the Publ
101101
* **AppBaseUrl**: Must include the protocol (http:// or https://) and must not end with a trailing slash. It is used as the base URL when redirecting users to the publisher apps.
102102
5. When a user opens a task from the **Global Inbox**, they are redirected to the corresponding task page in the Publisher Application through a deeplink. Because the user entered the application through the Global Inbox instead of the normal navigation flow, developers must decide how the application should behave when the user completes the user task and/or closes the page. Developers can either change show page action in the deeplink microflow **DL_WorkflowUserTask_ShowUserTaskPage** to redirect to another page or adjust the default deeplink landing page in **UseMe** > **Deeplink** > **Deeplink Landing Page** to meet their business needs. If further customization is required, it is possible to adjust the logic for the outcome buttons in each of the task pages.
103103

104-
### Setting up Business Events
104+
### Setting up Business Events Locally
105105

106-
Configure the [Mendix Event Broker](https://marketplace.mendix.com/link/component/202907) or [your own Kafka](/appstore/services/business-events-deployment/#byok) cluster. Refer to the [Mendix Event Broker](/appstore/services/event-broker/) documentation for relevant steps.
107-
108-
### Local Setup
109-
110-
For local development and testing, the Event Broker can be deployed using the [Local Setup Tool](https://github.com/mendix/event-broker-tools). For more information, see [Deployment](/appstore/services/business-events-deployment/#deployment).
111-
112-
In both the **Global Inbox** and **Global Inbox Connector** modules, configure the following application constants:
106+
For local development and testing, the Event Broker can be deployed using the [Local Setup Tool](https://github.com/mendix/event-broker-tools). For more information, see the [Deployment](/appstore/services/business-events-deployment/#deployment) section in *Deploy a Business Event*. In both the **Global Inbox** and **Global Inbox Connector** modules, configure the following application constants:
113107

114108
* **ServerUrl**: the URL of the local broker instance
109+
115110
* **ChannelName**: the name of the event channel used for publishing and subscribing to Business Events
116111

117112
These settings ensure that Business Events are correctly routed between Publisher Applications and the Global Inbox during local testing.
118113

114+
For instructions on setting up a local test environment, refer to the Mendix Academy guide: [Set up your Local Test Environment](https://academy.mendix.com/index3.html#/modules/622/lectures/4833/Set-up-your-Local-Test-Environment).
115+
119116
### Deployment
120117

121-
For deployment, the Global Inbox requires the Mendix Event Broker or an external Kafka cluster. For more information, see the [Production Deployment](/appstore/services/business-events-deployment/#production-deployment) section in *Deploy a Business Event*.
118+
#### Mendix Public Cloud
119+
120+
For deployment, the Global Inbox requires the Mendix Event Broker or [Bring Your Own Kafka](/appstore/services/business-events-deployment/#byok). For more information, see the [Production Deployment](/appstore/services/business-events-deployment/#production-deployment) section in *Deploy a Business Event*.
122121

123122
Ensure the Mendix Event Broker is enabled for all apps and environments, and deploy applications in the correct order: Global Inbox application must be running before the publisher applications.
124123

@@ -128,6 +127,12 @@ If you are deploying your apps to Mendix Cloud for the first time, you must firs
128127

129128
Ensure the **Global Inbox Connector** constants are configured in each Publisher Application as part of the deployment process.
130129

130+
#### Mendix Free Cloud
131+
132+
When deploying to the Mendix Free Cloud, the [Mendix Event Broker](/appstore/services/event-broker/) is provided as a shared, multi-tenant service.
133+
134+
Within this setup, no additional configuration or license is required. The Event Broker is automatically available after deploying your app and enabling business events.
135+
131136
## Security
132137

133138
Any user that can see a task in Publisher Application can see the same task in the **Global Inbox**. This is based on the **System.User.Name** attribute that is used as the unique identifier to link users across the applications. For this reason:

0 commit comments

Comments
 (0)