Please see Workflow Commons in the Mendix documentation for details.
Workflow Commons
Content Type: Module
Categories: Scheduling
Overview
This module provides out-of-the-box content to get you started with building workflows in Mendix. Read more about this module and how to set it up in our documentation.
Documentation
Releases
Version: 4.0.0
Framework Version: 11.0.0
Release Notes: * We upgraded the module to Mendix 11.0.0-beta.2
* We introduced a new View Entity `WorkflowUserTaskView`, for unified access to user tasks regardless of whether these tasks are in progress or completed. For more information, refer to the Workflow Commons module documentation.
* We removed the state change events microflows `OCh_Workflow_State` and `OCh_WorkflowUserTask_State`, since state-change events are removed in Mendix 11.
* We removed the assignee and key migration microflows that were introduced in version 3.0.0 and 3.6.0 respectively and are no longer applicable. See the first note for more details.
* We added migration logic to perform a one-off migration of your existing data. When using Workflow Commons and upgrading your app to Mendix 11, it is required to perform this migration and update your app accordingly. See the second note for more details.
* We added an icon next to targeted/assigned users to indicate when a user is inactive, only visible for administrators.
* We replaced the List View for displaying assignees with a Data Grid 2 reference set supported feature.
* We fixed an issue where the overdue time was displayed incorrectly in the timeline.
* We updated Atlas Core module compatibility to v3.17.0
* We updated Atlas Web Content module compatibility to v3.8.0
* We updated Data Widgets module compatibility to v2.31.0
Note: When upgrading to v4.0.0 or above, make sure that you are currently using Workflow Commons v3.6.0 or above. If you are using an earlier version, first upgrade to any version between v3.6.0 and (but not including) v4.0.0, using a Mendix 10 version. Perform the required key and/or assignee migrations for all your environments. Any required migration will be shown in the WorkflowAdminCenter page.
Note: As a result of upgrading to Mendix 11, the microflows and snippets that previously used the `WorkflowCommons.UserTaskView` entity have been replaced with documents that uses `WorkflowCommons.WorkflowUserTaskView` or `System.WorkflowEndedUserTask` as a parameter. If you are using one or more of them in your project, see the list below for replacement. Also, in case you have any logic based on the `WorkflowCommons.UserTaskView` entity, make sure to adapt this accordingly.
Microflows:
* ACT_UserTaskView_ShowUserTask Page → replace with ACT_WorkflowUserTaskView_ShowUserTaskPage
* ACT_UserTaskView_ShowWorkflowAdminPage → replace with ACT_WorkflowUserTaskView_ShowDefaultAdminPage
* ACT_WorkflowView_ShowWorkflowAdminPage → replace with ACT_Workflow_ShowWorkflowAdminPage
Snippets:
* Snip_UserTaskView_Assignees → replace with Snip_WorkflowUserTaskView_Assignees
* Snip_UserTaskView_Assignees_Aggregated → replace with Snip_WorkflowUserTaskView_Assignees
* Snip_UserTaskView_Details → replace with Snip_WorkflowUserTaskView_Details
* Snip_UserTaskView_Header → replace with Snip_UserTask_Header or Snip_WorfkflowEndedUserTask_Header
* Snip_UserTaskView_IncompatibleWarning → replace with Snip_WorkflowUserTaskView_IncompatibleWarning
* Snip_UserTaskView_NameColumn → replace with Snip_WorkflowUserTaskView_NameColumn
* Snip_UserTaskView_NameColumnWithIcon → replace with Snip_WorkflowUserTaskView_NameColumnWithIcon
* Snip_UserTaskView_State → replace with Snip_WorkflowUserTaskView_State
* Snip_UserTaskView_TargetUsers → replace with Snip_UserTask_TargetUsers or Snip_WorkflowEndedUserTask_TargetUsers
* Snip_WorkflowView_ActivityTimeline → replace with Snip_Workflow_ActivityTimeline
* Snip_WorkflowView_ActivityTimelineOnly_Full → replace with Snip_Workflow_ActivityTimelineOnly_Full
* Snip_WorkflowView_ActivityTimelineOnly_Tasks → replace with Snip_Workflow_ActivityTimelineOnly_Tasks
* Snip_WorkflowView_AuditTrail → replace with Snip_Workflow_AuditTrail
* Snip_WorkflowView_CommentsAndAttachments → replace with Snip_Workflow_CommentsAndAttachments
* Snip_WorkflowView_CommentsAndAttachments_Admin → replace with Snip_Workflow_CommentsAndAttachments_Admin
* Snip_WorkflowView_CompletedTaskDetails → replace with Snip_Workflow_TaskDetails
* Snip_WorkflowView_Detail → replace with Snip_Workflow_Detail
* Snip_WorkflowView_Header → replace with Snip_Workflow_Header
* Snip_WorkflowView_NotificationArea → replace with Snip_Workflow_NotificationArea
* Snip_WorkflowView_State → replace with Snip_Workflow_State
* Snip_WorkflowView_StateCircleOnly → replace with Snip_Workflow_StateCircleOnly
* Snip_WorkflowView_TaskTimeline → replace with Snip_Workflow_TaskTimeline
* Snip_WorkflowView_TaskTimeline_WithoutNameandDescription → replace with Snip_Workflow_TaskTimeline_WithoutName
* Snip_WorkflowView_TaskTimelineOnly → replace with Snip_Workflow_TaskTimelineOnly
Version: 3.12.1
Framework Version: 10.17.0
Release Notes: - We changed the length of the `Reason` attribute in the `WorkflowAuditTrailRecord` entity to unlimited.
- We fixed the warnings in the module where applicable.
Version: 3.12.0
Framework Version: 10.17.0
Release Notes: - We upgraded the module to Mendix 10.17.0
- We updated Data Widgets module compatibility to v2.28.1
- We fixed an issue where the Reason field was not displayed for Paused workflow instances after locking a workflow definition. We updated the conditional visibility to show the Reason field if available, regardless of the workflow state.
- We fixed an issue where switching between the Minimal, Default and All views did not work correctly for the Audit Trail.
- We added compatibility for changes in the System module that were introduced with Mendix 10.17.0
Version: 3.11.0
Framework Version: 10.14.0
Release Notes: * We added 'Manage task assignments' page. This page provides the workflow administrator the ability to manage the assignment and targeting of user tasks based on a selected user. This is typically done when a user is leaving the organization or a group/role.
* We updated Data Widgets module compatibility to v2.26.0
Version: 3.10.0
Framework Version: 10.14.0
Release Notes: * We added a constant `DueDateExpirationInDays` to configure the period in days for which the workflows/user tasks are to be considered almost due.
* We added visual indicators that indicates workflows/user tasks that are almost due based on the constant `DueDateExpirationInDays` or overdue in pages `Task Inbox`, `Task Dashboard`, `Default Workflow Admin` and `Workflow Definition View`.
* We added `Due in x day(s)` counters to the `Workflow Dashboard` for workflows/user tasks. Where the value of `x` is the `DueDateExpirationInDays` constant value.
* We fixed a bug in the calculation of the overdue counters in the `Workflow Dashboard`.
Version: 3.9.0
Framework Version: 10.14.0
Release Notes: * We upgraded the module to Mendix 10.14.0
* We replaced the usage of the 'WorkflowWaitForTimer' image with the 'WorkflowTimer' image.
* We added compatibility for changes in the System module that were introduced with Mendix 10.14.0
Version: 3.8.1
Framework Version: 10.12.0
Release Notes: * We fixed an issue in the Task Inbox and Task Dashboard pages where the ‘Assignee(s)' column did not display the Assignee name(s).
Version: 3.8.0
Framework Version: 10.12.0
Release Notes: * We upgraded the module to Mendix 10.12.0
* We updated Data Widgets module compatibility to v2.21.2
* We added an option to select if you want to keep the target users or re-run user targeting when retrying a workflow that has a failed user task.
* We added a confirmation pop-up to all actions in the Workflow Admin page.
* We added the microflows ‘ACT_UserTask_AssignToUser’ and ‘ACT_UserTask_AssignToUsers' to the ‘Use me’ folder, that can be used to assign user(s) to a user task. The 'ACT_UserTask_AssignToUsers’ microflow is only applicable for multi-user tasks.
Version: 3.7.0
Framework Version: 10.11.0
Release Notes: * We added a scheduled event to clean-up expired audit trail logs. Refer to module documentation for more details and how to set it up.
* We fixed inconsistent log node names.
Version: 3.6.0
Framework Version: 10.11.0
Release Notes: * We introduced the audit trail feature to track all events and actions that have taken place in the workflows in your application. Refer to the module documentation for more details on how to configure a workflow event handler for audit trails.
* We added a key attribute to WorkflowView and UserTaskView entities, that uniquely identifies the workflow and user task instances. The value is helpful for correlating audit trail data to the related workflow or user task.
Note: If you want to add the keys to existing WorkflowView and UserTaskView data you need to run a migration, you can either:
* Use the migration microflow 'ACT_Key_Migrate' (also added to the 'WorkflowAdminCenter' page), or:
* Add the 'ASu_Key_Migrate' microflow to the project's after startup microflow.