Use the BPM Engine for process and task management within your client.

Introduction

The BPM Engine is provided by the BPM-ENGINE service based on the workflow functionality of the open-source software Flowable. In yuuvis® client as reference implementation, it can be integrated in order to support process and task management via the browser application.

Administrators can model process models with the help of a Flowable editor and deploy them to the BPM engine. Once deployed a process instance based on that model can be started and resulting tasks being executed. 

The following information is intended to support administrators to set up Flowable processes that are supported by the reference client.

Processes and Tasks in the reference client

The reference client offers three specific views that allow the user to handle the processes based on Flowable. The first process that was as a standard delivered with yuuvis® was for supporting follow-ups. A user can create follow-ups for each object via the action menu. The view 'My follow-ups' lists all active follow-ups with their follow-up date. The inbox lists all follow-ups that have reached their follow-up date.

With version 2021 Autumn the user is offered the new view 'My processes' that lists all processes he has started, and the inbox is listing all tasks of processes he is assigned to.

The process history as well as actions on the processes like suspending, resume, cancel, as well as on tasks like forwarding will with the next version.

Recommendations

If you start a process:

• Map the yuuvis parameter system:objectID to the Flowable parameter businessKey. The reference client uses this parameter to load the object details.
• Map the yuuvis parameter appClient:clientTitle to the Flowable parameter name and optionally to the variable whatabout as well. The reference client uses these parameters to show them in the Inbox column Task as well as in the My processes column Process.

My follow-ups

The view My follow-ups lists on the follow-up processes with the following specific parameters that are affected:

Inbox

Beginning with version 2021 Autumn the inbox lists besides the follow-up tasks all other BPM tasks as well.  The view My follow-ups lists on the follow-up processes with the following specific parameters that are affected:

My processes 

Beginning with version 2021 Autumn the new view My process lists all processes including the follow-up ones the user has started. The following yuuvis and Flowable parameters are affected:

Start a process for an object via plugin action

You can extend the object actions with a plugin action that can be offered in the action group MORE ACTIONS. The following example offers the action Two step process that starts a process based on the process model twosteptest_proc ( mapped to Flowable processDefinitionKey) for a single marked object.

To get this example action offered the following code must be imported as a file in the settings of the client. The user needs an administrative role.

And the process model twosteptest_proc has to be deployed to the Flowable BPM engine

{
  "disabled": false,
  "actions": [
    {
      "id": "yuv.custom.action.two.step.label",
      "label": "yuv.custom.action.two.step.label",
      "description": "yuv.custom.action.two.step.description",
      "priority": 0,
      "icon": "<svg height=\"24\" viewBox=\"0 0 24 24\" width=\"24\" xmlns=\"http://www.w3.org/2000/svg\"> <path d=\"M0 0h24v24H0V0z\" fill=\"none\"></path> <path d=\"M4 10h12v2H4zM4 6h12v2H4zM4 14h8v2H4zM14 14v6l5-3z\"></path> </svg>",
      "group": "further",
      "range": "SINGLE_SELECT",
      "isExecutable": "(item) => item.id",
      "run": "(selection) => this.http.post('/bpm/processes', {'businessKey': selection[0].id, 'name': selection[0].title || selection[0].id, 'processDefinitionKey': 'twosteptest_proc', 'variables': [ { 'name': 'documentId', 'type': 'string', 'value': selection[0].id},{ 'name': 'whatAbout', 'type': 'string', 'value': selection[0].title}]}, 'api-web').then(() => this.util.notifier.success(this.util.translate('yuv.custom.action.two.step.success')))"
    },
    "yuv-download-action",
    "yuv-delete-action",
    "yuv-delete",
    "yuv-upload",
    "yuv-upload-action",
    "yuv-move-action",
    "yuv-move",
    "yuv-follow-up-action",
    "yuv-follow-up",
    "yuv-reference-action",
    "yuv-open-context-action",
    "yuv-open-versions-action",
    "yuv-clipboard-action",
    "yuv-clipboard-link-action"
  ],
  "translations": {
    "en": {
      "yuv.custom.action.two.step.label": "Two step process",
      "yuv.custom.action.two.step.description": "Starts simple process with two steps",
      "yuv.custom.action.two.step.success": "Process has started"
    },
    "de": {
      "yuv.custom.action.two.step.label": "Zweischritteprozess",
      "yuv.custom.action.two.step.description": "Startet einen einfachen Prozess mit zwei Schritten",
      "yuv.custom.action.two.step.success": "Prozess wurde gestartet"
    }
  }
}