Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue
idPROGRESS

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

NameDateProduct VersionAction
Antje23 JUL 20212021 Autumncreated
Martin26 JUL 20212021 Autumn

draft

Bratislav29 JUL 20212021 Autumndraft
Antje29 JUL 20212021 Autumnformatting, published
Agnieszka25 AUG 20212021 AutumnrLANG



Excerpt

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

Introduction

The BPM Engine in yuuvis 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. In case that If 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 users to handle the processes based on Flowable:

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

...

  • If you start a process related to a document, the ID of the document shall should 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 specify a meaningful value for the process property name to a relevant and meaningful value since it will be shown in the Process column Process in the My processes view.
  • When modeling a workflow, set the specify meaningful and relevant names to for Tasks, since they will be shown in the Task column Task of in the Inbox view.

My follow-ups

...

Column in yuuvis® clientCorresponding Counterpart in BPM EngineDescription
DescriptionProcess variable whatAboutThe description that was entered during while creating the follow-up.
Start timeCreated onProcess parameter startTimeThe time the follow-up (process) was created.
Follow-up dateProcess variable expiryDateTimeThe due date that was entered while creating the follow-up.

...

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

Column in yuuvis® clientTechnical detailsDescription
Type

If the process parameter processDefinitionName is Follow-up, then Follow-up. Otherwise Task.

The description that was entered during while creating the follow-up.
TaskTask nameThe time the follow-up (process) was created.
ReceivedTask CreateTimeThe due date that was entered while creating the follow-up.

...

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:

Column in yuuvis® clientTechnical detailsDescription
TypeProcess-definition parameter processDefinitionNameProcess definition name
ProcessProcess-instance parameter name (as set when starting the process instance)Process instance name (e.g., a case number)
Start timeCreated onProcess-instance parameter startTimeThe time the process was created.
StatusDerived from the process-instance parameters completed and suspended

The status of the process can be running, suspended, or deleted completed

The status is given in the user's language.

...

Starting a

...

Process for an

...

Object via a Plug-in Action

The object actions can be extended with a plugin plug-in action that can be offered in the MORE ACTIONS action groupMORE ACTIONS. The following example offers shows the action Two step process that action, which starts a process based on the process model  twosteptest_proc process model (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 shown below. For the To be able to import a settings file import, the user needs , users will need an administrative role.

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

Code Block
languageyml
titleClient Settings for an Example 'Two step pocess' as an example
collapsetrue
{
  "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"
    }
  }
}

...