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 yuuvis® Momentum. Once deployed in such a manner, a process definition can be instantiated and executed in the engine. If process instances running in the bpm engine contain user tasks, they will be available in the Inbox of 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 users to handle processes based on Flowable:

• Users can create follow-ups for each object via the action menu. The My follow-ups view lists all active follow-ups with their follow-up date.
• The Inbox view lists all user tasks that are intended for the authenticated user, such as reminder tasks of 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 My processes view lists all processes started by the logged-in user.

Recommendations

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

My follow-ups

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

Inbox

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

My processes 

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

Starting a Process for an Object via a Plug-in Action

The object actions can be extended with a plug-in action that can be offered in the MORE ACTIONS action group. The following example shows the Two step process action, which starts a process based on the twosteptest_proc process model (mapped to Flowable processDefinitionKey) for a single marked object or for multiple selected objects. Beginning with 2021 Winter Alph2, the objects are shown in the attachment task of the task details for a selected task in the inbox. 

To provide the example Two step process action in a client, import the client plugin settings file shown below.  To be able to import a settings file, users will need an administrative role. 

The twosteptest_proc process model has to be deployed to the Flowable BPM engine.

{
  "disabled": false,
  "actions": [
    {
      "id": "yuv.custom.action.two.step.multi.label",
      "label": "yuv.custom.action.two.step.multi.label",
      "description": "yuv.custom.action.two.step.multi.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": "MULTI_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', attachments: selection.map((s) => s.id), subject: selection[0].title, variables: [{ name: 'myVariable', type: 'string', value: 'Lorem ipsum' }]},'api-web').then(() => this.util.notifier.success(this.util.translate('yuv.custom.action.two.step.multi.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.multi.label": "Two step process",
      "yuv.custom.action.two.step.multi.description": "Starts simple process with two steps, also for many objects",
      "yuv.custom.action.two.step.multi.success": "Process has started"
    },
    "de": {
      "yuv.custom.action.two.step.multi.label": "Zweischritteprozess",
      "yuv.custom.action.two.step.multi.description": "Startet einen einfachen Prozess mit zwei Schritten, auch für mehrere Prozesse",
      "yuv.custom.action.two.step.multi.success": "Prozess wurde gestartet"
    }
  }
}