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/marketplace/platform-supported-content/modules/global-inbox.md
+8-12Lines changed: 8 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,14 +28,10 @@ While the architecture can support broader use cases, the current scope focuses
28
28
* Intended for Mendix Applications that use [Mendix Workflows](https://docs.mendix.com/refguide/workflows/) to manage workflows. Support for non-Mendix Workflows will be introduced at a later stage.
29
29
* Redirects users to Publisher Applications to act on the user task.
30
30
31
-
{{% alert color="info" %}}
32
-
For Global Inbox version 2.4.0 and above, attachments are (an optional) part of comments. This means that the **WorkflowAttachment** entity is associated with the **WorkflowComment** entity. Security settings for the **WorkflowAttachment** entity are based on the workflows in which a user is involved, since the context of a specific workflow is not known in advance in [Workflow Commons](/appstore/modules/workflow-commons/). If you would like to set custom security for attachments, you need to configure the attachment entity in your domain model and associate it with the workflow context entity of the workflow.
33
-
{{% /alert %}}
34
-
35
31
### Prerequisites
36
32
37
33
* Mendix 11.6.0 or above
38
-
* Single Sign-On (SSO) is required for user authentication, as the **User.Name** attribute is used to match users across the Global Inbox and Publisher Applications. For security reasons, ensure that the username is not modifiable by the end user and is only set by the SSO provider.
34
+
* Single Sign-On (SSO) is required for user authentication, as the **System.User.Name** attribute is used to match users across the Global Inbox and Publisher Applications. For security reasons, ensure that the username is not modifiable by the end user and is only set by the SSO provider.
39
35
40
36
### Dependencies
41
37
@@ -69,18 +65,18 @@ The Global Inbox operates with the following event flow:
69
65
70
66
1. Publisher App registration: Each publisher application registers with the Global Inbox by publishing a **PublisherAppRegisteredEvent**. This ensures the Global Inbox knows which apps are available to send task events.
71
67
2. Task update and event publication: When a workflow or task is created, updated, or completed in a publisher application that includes the Global Inbox Connector, the connector publishes the following events:
72
-
* WorkflowUpdatedEvent – triggered when the workflow is updated.
73
-
* UserTaskUpdatedEvent – triggered when a user task is updated.
74
-
* UserTaskEndedEvent – triggered when a user task is completed or aborted.
75
-
* UserTaskOutcomeSelectedEvent – triggered when a user completes a task by selecting an outcome.
68
+
***WorkflowUpdatedEvent** – triggered when the workflow is updated.
69
+
***UserTaskUpdatedEvent** – triggered when a user task is updated.
70
+
***UserTaskEndedEvent** – triggered when a user task is completed or aborted.
71
+
***UserTaskOutcomeSelectedEvent** – triggered when a user completes a task by selecting an outcome.
76
72
3. Event consumption: The Global Inbox consumes these events and updates or creates the corresponding task entries in the central task list.
77
73
4. Task visibility and navigation: Tasks become visible in the Global Inbox. Users can click a button to navigate directly to the corresponding task page in the Publisher Application to take action.
78
74
79
75
## Setup Guide
80
76
81
77
### Setting up Global Inbox
82
78
83
-
1. Import the [Global Inbox module](https://marketplace.mendix.com/link/component/259162) into the application that will serve as the central task overview. This application aggregates tasks from multiple Publisher Applications and provides a single interface where users can view all active tasks. It acts as the consumer of task events and maintains the consolidated task list.
79
+
1. Import the [Global Inbox](https://marketplace.mendix.com/link/component/259162) module into the application that will serve as the central task overview. This application aggregates tasks from multiple Publisher Applications and provides a single interface where users can view all active tasks. It acts as the consumer of task events and maintains the consolidated task list.
84
80
2. Add the **ACT_GlobalTaskInbox_Open** microflow to your navigation. You can find it in **GlobalInbox** > **UseMe** > **Microflows** > **ACT_GlobalTaskInbox_Open**. This microflow opens the **GlobalTaskInbox** page and ensures that users are able to see their tasks.
85
81
86
82
{{% alert color="info" %}}If you want to customize the **GlobalTaskInbox** page, make sure to copy it with the **ACT_GlobalTaskInbox_Open** microflow to your own module, as this microflow includes the logic to link the app users to their user tasks.{{% /alert %}}
@@ -134,10 +130,10 @@ Ensure the **Global Inbox Connector** constants are configured in each Publisher
134
130
135
131
## Security
136
132
137
-
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:
133
+
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:
138
134
139
135
* Single Sign-On (SSO) is required for user authentication
140
-
* Users MUST have the same username (System.User.Name attribute) across the Global Inbox application and all Publisher Applications.
136
+
* Users MUST have the same username (**System.User.Name** attribute) across the Global Inbox application and all Publisher Applications.
141
137
* The username should NOT be modifiable and should only be set by the SSO provider.
0 commit comments