Overview

The Dynamic Case Management Commons module helps Mendix developers to quickly get started with building case-driven applications using the Dynamic Case Management Add-On. The module provides reusable components and best practices for starting, managing and tracking cases, making it easier to develop dynamic case management solutions.

Documentation

1 Introduction

The Dynamic Case Management Commons (DCMC) module helps Mendix developers to quickly get started with building case-driven applications using the Dynamic Case Management Add-On. The module provides reusable components and best practices for starting, managing and tracking cases, making it easier to develop dynamic case management solutions, even with limited experience.

1.1 Features

• Example pages, microflows, and reusable snippets

• Task inbox for managing tasks

• Team management to configure and re-use case teams per case model

• Case management for viewing and managing case instances and their tasks

• Event logs for tracking case events

1.2 Prerequisites

• Mendix 10.24.4

1.3 Dependencies

• Dynamic Case Management Add-On

• Nanoflow Commons

2 Configuration

1. Add the ASU_CaseManagement_Startup microflow as the After startup microflow of your app. If there is already an after startup microflow set, add the microflow as an action in the existing after startup microflow.

2. Add the DynamicCaseManagementCenter page to your app navigation.

3. Assign the module role(s) to the relevant app roles:

   1. CaseWorker role:

      1. Can view and complete human tasks

      2. Can view and manage case instances

   2. TeamManager role:

      1. Can define and manage case teams

Note: The above module roles only give access to certain functionality, and does not determine the access rights for actual cases. Access to cases (and all related data) is handled by the CaseFabric engine, and is based on the case team that is assigned to a case when starting it. Therefore, before starting a case, the TeamManager should navigate to the Dynamic Case Management Center in the running app, open the Team Management page and configure at least one team for each case model. Ensure that all case team roles are mapped to the appropriate Mendix app roles, so that the correct users will be able to work on the case.

4 Components

You can find several useful documents in the UseMe folder that you can leverage to quickly get started with building case-driven applications.

Note: All documents in the Private folder are meant for internal use within the module itself. Do not use these documents in your app, as these might change in future releases without notice.

4.1 Pages

The Dynamic Case Management Commons module comes with several ready-to-use pages to help you and your users get started with dynamic case management. These pages work out of the box. Simply add them to your app navigation to start using them.

The following pages are included:

• DynamicCaseManagementCenter - A central page that acts as the main entry point for both case workers and team managers.

  • Case Workers have access to:

    • Task Inbox – This page displays a list of human tasks a case worker can work with:

      • My Claimed Tasks shows tasks that the case worker has already claimed.

      • My Tasks lists tasks available to the case worker but not yet claimed.

    • Case Management – This page displays a list of all cases that the case worker has access to. For each case, the case worker can view its details, including the associated tasks and case events, and has the ability to terminate cases or individual tasks when necessary.

    • Additionally, the Case Dashboard section is included as a placeholder for future functionality.

  • Team Managers have access to:

    • Team Management - This page allows team managers to manage case teams per case model. For each case model, the team manager can define which Mendix app roles should be mapped for each of the available case team roles. These mappings ensure that, when a case starts, the correct users are assigned based on their roles.

• HumanTask_Example - This is an example page where the case worker can view task details, event logs, complete the task, or plan discretionary items if available. It includes reusable snippets that can be used when building custom task pages.

4.2 Microflows

Pre-configured microflows help you assign human tasks or update the state of case instances.

You can find the following reusable microflows in Dynamic Case Management Commons:

• SUB_CaseTeam_Get - Retrieves the case team definition based on case model name and case team definition name. It then maps the case team definition to an actual case team instance and returns the case team, which can then be used for starting a new case.

• ACT_HumanTask_ClaimTask - Claims a human task for the current user. The task is passed as a parameter. When using this action, the task status gets updated to Assigned.

• ACT_HumanTask_ShowTaskPage - Opens the appropriate task page for the selected human task, allowing the case worker to view and work on the task.

• ACT_HumanTask_CompleteTask - Completes a human task. The task is passed in as a parameter. To complete the task successfully, you need to update the applicable values required by the Java action, as these are dependent on the relevant context.

In addition, the following example microflow is included:

• ACT_ContextEntity_StartCase - This is an example microflow that starts a new case using the case model name and case team definition name as parameters. The case is started for the specified case model, and a case team instance is created based on the given case team definition. It uses the ‘SUB_CaseTeam_Get' microflow to retrieve the case team, and starts the case. The case identifier is then stored in your context entity.

  Note: You should replace the input parameter with your own context entity and rename the microflow accordingly. Make sure to also use your context entity when calling the Java action that start the case and link it to your entity.