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

Introduction

The BPM Engine in yuuvis Momentum 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 (process-definitions in Flowable nomenclature) with the help of a Flowable modeler, pack them and export them as applications, and deploy the applications to the BPM-ENGINE in Momentum. Once deployed in such manner, a process definition can be instantiated and executed in the engine. In case that process instances running in the bpm-engine contain user-tasks, they will be available in the Inbox of client for the user to whom they were assigned. 

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

yuuvis® client as reference implementation offers three specific views that allow the user to handle the processes based on Flowable:

• 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 view Inbox lists all user-tasks that are intended for the authenticated user, such as the reminder tasks of the Follow-up processes that have reached their follow-up date.
  As of version 2021 Autumn, all tasks of processes the currently logged-in user is assigned to are listed as well.
• As of version 2021 Autumn, the new view My processes lists all processes started by the logged-in user.

Recommendations

• If you start a process related to a document, the ID of the document shall be saved in the process variable documentId. The reference client uses this variable to retrieve and display the object details.
• When starting a process, set the process property name to a relevant and meaningful value since it will be shown in the column Process in the My processes view.
• When modeling a workflow, set the meaningful and relevant names to Tasks, since they will be shown in the column Task of the Inbox view.

My follow-ups

This view lists the follow-up processes with the following specific properties:

Inbox

As of version 2021 Autumn, the inbox lists besides the follow-up tasks all other BPM tasks as well. Following properties are displayed:

My processes 

As of version 2021 Autumn, all processes including the follow-ups are listed as soon as they are started by the user. The following properties are affected:

Start a process for an object via plugin action

The object actions can be extended 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 provide the example Two step process action in a client, import the client settings file displayed below. For the settings file import, the user needs an administrative role.

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"
    }
  }
}