Workflow Commons - New WorkflowEndedUserTask + OQL View approach #9506
Conversation
|
We will release the module after Mx11.0.0 beta 2 is GA. |
| @@ -57,7 +57,7 @@ You can find the following pages in Workflow Commons: | |||
| * **MyInitiatedWorkflows** – This page gives end-users an overview of all their initiated workflows. They can view the current state, task timeline and can withdraw workflows that are in progress, paused, or incompatible. | |||
| * **TaskDashboard** – This page gives end-users an overview of their performance. It contains such information as the number of completed tasks, average time spent to complete a task, and percentage of completed tasks within a deadline. | |||
| * **TaskInbox** – This page contains a list of all tasks that a user can interact with. **My open tasks** shows the tasks assigned to current users, **All open tasks** is a list of tasks they could pick up and **Unassigned tasks** shows all unassigned tasks. | |||
| * **WorkflowAdminCenter** – A navigational page for workflow administrators. From here, a workflow administrator can go the **Workflow Dashboard**, which gives them general statistics of workflows. Workflow administrators also gain access to **Workflow management**, where they can see all the instances of specific workflows and make changes to their data or even abort workflows. | |||
There was a problem hiding this comment.
In the section higher up "Prerequisites", should we not add that the new WFC module only works with Mx11 (due to new entities)?
Also in the "Features" section I suggest to add something like "batch reassignment when users that are assigned to user tasks leave the application or in some other way are not able to complete assigned tasks"
In general: Are there other WFC features we added we should mentioned here?
| @@ -110,11 +110,36 @@ You can find the following microflows in Workflow Commons: | |||
| 2. Views personal performance in the **Task Dashboard**. | |||
| 3. Views workflow progress in the **My Initiated Workflows** overview. | |||
| 3. Make sure the correct user entity is set in the **App Settings**: open **App Settings** > **Workflows** tab and set **User entity** to *Administration.Account*. | |||
| 4. For Workflow Commons v2.1.0 and above, you need to configure the state change microflows in the **App Settings**: open **App Settings** > **Workflows** tab to configure the following state change microflows: | |||
| 4. For Workflow Commons v2.1.0 up to (but not including) v4.0.0, you need to configure the state change microflows in the **App Settings**: open **App Settings** > **Workflows** tab to configure the following state change microflows: | |||
There was a problem hiding this comment.
@Yiyun333 Now there is a single page for all version of WFC combined with all version of MX and it's very confusing. Version numbers are everywhere. With MX 11 there will be a new WFC module that only works with Mx 11 (and up). Can't we have a WFC page that does not mentioned any previous (prior to MX 11) Mx and WFC version other than: "if you want to upgrade WFC from Mx 10 to 11 click here"?
There was a problem hiding this comment.
It's not just here, but also further down.
| ### Upgrading from Mendix 10 to Mendix 11 | ||
|
|
||
| This section explains the required steps when upgrading an existing app that is using Workflow Commons from Mendix 10 to Mendix 11. With the removal of state-change events in Mendix 11, it is required to upgrade Workflow Commons to version 4.0.0 or higher. In addition, it is required to perform a one-off migration for your existing data. | ||
|
|
There was a problem hiding this comment.
We should provide a bit more context: Mentioned the view entities and their purpose. In case a develop wants to keep the old historical data he needs to migrate since the view entities are not in the new module, but replaced with something else.
|
|
||
| This section explains the required steps when upgrading an existing app that is using Workflow Commons from Mendix 10 to Mendix 11. With the removal of state-change events in Mendix 11, it is required to upgrade Workflow Commons to version 4.0.0 or higher. In addition, it is required to perform a one-off migration for your existing data. | ||
|
|
||
| Starting with version 4.0.0, Workflow Commons uses the new [View Entities](https://docs.mendix.com/refguide/view-entities) feature for unified access to user tasks, regardless of whether these tasks are in progress or completed. The WorkflowUserTaskView view entity combines objects from System.WorkflowUserTask and System.WorkflowEndedUserTask into a single view. This removes the need for the custom entities (WorkflowView and UserTaskView) that used to be part of Workflow Commons in versions below v4.0.0, that were kept up to date using state-change events. |
There was a problem hiding this comment.
I suggest to start explaining from the beginning: View entities are replaced by a system module entity that will hold all user task that are ion their final state. Note: You can reference to the core WF doc once it's available. SInce all user task data is now in the system module ther eis no need for the view entities. A combined view of active and complete users tasks is realized using a OQL view entity in WFC.
content/en/docs/appstore/use-content/platform-supported-content/modules/workflow-commons.md
Show resolved
Hide resolved
| 2. In the runtime settings of your app, configure the ASU_UserTaskView_Migrate microflow for the after startup property. If there is already an after startup microflow set, add the ASU_UserTaskView_Migrate microflow as an action to the existing microflow. | ||
|
|
||
| 3. Alternatively, you can manually start the migration by clicking the "Migrate UserTaskView object(s) to WorkflowEndedUserTask entity" button which is available on the Workflow Admin Center page, or use the ACT_UserTaskView_Migrate microflow in your project. | ||
|
|
There was a problem hiding this comment.
pls explain if the MF should be removed after it has run once. What happens if the app is restarted multiple times? What to do when the migration script aborts with an error? Can I safely rerun it again or will it end with duplicates and/or gapes?
This is still a draft. It needs to be merged when WorkflowCommons v4.0.0 is released to the marketplace.