Workflow Commons - New WorkflowEndedUserTask + OQL View approach #9506
Conversation
|
We will release the module after Mx11.0.0 beta 2 is GA. |
content/en/docs/appstore/use-content/platform-supported-content/modules/workflow-commons.md
Show resolved
Hide resolved
| @@ -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.
There was a problem hiding this comment.
@PaulJongenMx Sorry, I've missed this message.
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"?
Could you clarify this a bit more? Since we don't have a versioned Workflow Commons page (like our refguide and how-tos), I think it's still valuable to keep the version information. But indeed we need to structure the information better. I am not exactly sure what you mean by the above comment though. Please explain further. Thanks!
content/en/docs/appstore/use-content/platform-supported-content/modules/workflow-commons.md
Show resolved
Hide resolved
content/en/docs/appstore/use-content/platform-supported-content/modules/workflow-commons.md
Outdated
Show resolved
Hide resolved
content/en/docs/appstore/use-content/platform-supported-content/modules/workflow-commons.md
Show resolved
Hide resolved
content/en/docs/appstore/use-content/platform-supported-content/modules/workflow-commons.md
Show resolved
Hide resolved
|
|
||
| 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. | ||
|
|
||
| Starting with Mendix 11, ended user tasks are now stored in the WorkflowEndedUserTask entity in the System module. In order to preserve existing data, it is important to migrate information on ended user tasks from WorkflowCommons.UserTaskView objects into System.WorkflowEndedUserTask objects. A migration microflow is shipped with Workflow Commons v4.0.0 to help you perform this task. |
There was a problem hiding this comment.
... ended user tasks (with state Aborted, Completed) ...
content/en/docs/appstore/use-content/platform-supported-content/modules/workflow-commons.md
Outdated
Show resolved
Hide resolved
content/en/docs/appstore/use-content/platform-supported-content/modules/workflow-commons.md
Show resolved
Hide resolved
| As a result of upgrading to Mendix 11, the pages, microflows, and snippets that previously used the `WorkflowCommons.UserTaskView` entity have either been removed from the WorkflowCommons module or replaced with documents that uses `WorkflowCommons.WorkflowUserTaskView` or `System.WorkflowEndedUserTask` as a parameter. For a full list, refer to the release notes of v4.0.0 of the Workflow Commons module. | ||
| {{% /alert %}} | ||
| The user tasks objects will only be migrate once, even if the migration flow is set in the after-startup microflow and the app is restarted. If the migration is interrupted due to an error, a full rollback will be triggered. For extra assurance and ensuring no user tasks are migrated twice, we added the **IsMigrated** flag attribute to WorkflowCommons.UserTaskView that will be set to true for each migrated user task object. | ||
|
|
There was a problem hiding this comment.
We should add a note somewhere that in case of any modifications to WFC by the developer, they should check if the migration MF should be modified as well to result in the desired migration of data.
| As a result of upgrading to Mendix 11, the pages, microflows, and snippets that previously used the `WorkflowCommons.UserTaskView` entity have either been removed from the WorkflowCommons module or replaced with documents that uses `WorkflowCommons.WorkflowUserTaskView` or `System.WorkflowEndedUserTask` as a parameter. For a full list, refer to the release notes of v4.0.0 of the Workflow Commons module. | ||
| {{% /alert %}} | ||
| The user tasks objects will only be migrate once, even if the migration flow is set in the after-startup microflow and the app is restarted. If the migration is interrupted due to an error, a full rollback will be triggered. For extra assurance and ensuring no user tasks are migrated twice, we added the **IsMigrated** flag attribute to WorkflowCommons.UserTaskView that will be set to true for each migrated user task object. | ||
|
|
There was a problem hiding this comment.
What about a note that in case a lot of ...view entity records need to be migrated, the initial startup of the app may take some time
|
|
||
| As a result of upgrading to Mendix 11, the pages, microflows, and snippets that previously used the **WorkflowCommons.UserTaskView** entity have either been removed from the WorkflowCommons module or replaced with documents that uses **WorkflowCommons.WorkflowUserTaskView** or **System.WorkflowEndedUserTask** as a parameter. For a full list, refer to the release notes of v4.0.0 of the Workflow Commons module. | ||
|
|
||
| WorkflowCommons.WorkflowView and WorkflowCommons.UserTaskView are deprecated and replaced by the WorkflowCommons.WorkflowUserTaskView view entity. In case, you have any logic and pages that rely on WorkflowCommons.WorkflowView and WorkflowCommons.UserTaskView entities, you need to adapt those based on them to the System.Workflow and the new WorkflowCommons.WorkflowUserTaskView entities instead. |
There was a problem hiding this comment.
We should add a not or explanation that after the migration, the data is still in the view entities. What are the steps a developer should take to the delete this data, after verification that everything has been migrated correctly. DO we provide ...view entity clean-up functions in WFC or should a developer build this him/herself
This is still a draft. It needs to be merged when WorkflowCommons v4.0.0 is released to the marketplace.