Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated several small techincal details


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



Excerpt

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 editor modeler, pack them and export them as applications, and deploy them the applications to the BPM engine-ENGINE in Momentum. Once deployed in such manner, a process instance based on that model definition can be started and resulting tasks being executedinstantiated 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.

...

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 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.

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 businessKeythat relates to a document, the ID of the document shall be saved in the process variable documentId. The reference client uses this parameter variable to load and show 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
  • 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

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

Descriptionyuuvis®FlowableTechnical details
The description that was entered during creating the follow-up.Column DescriptionProcess variable whatAbout
The time the follow-up (process) was created.Column Start timeProcess parameter startTime
The due date was entered while creating the follow-up.Column Follow-up dateProcess variable expiryDateTime

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 affectedshows the following information:

Descriptionyuuvis®FlowableTechnical details
The type of task that can be Follow-up or Task in case of other process models.Column Type

If the process parameter processDefinitionName is Follow-up then Follow-up otherwise Task

The specific Task is either the follow-up description that was entered during creating the follow-up or the name of the processa taskColumn TaskTask name
The time the follow-up task was received by the usercreated.Column ReceivedTask CreateTime

...

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:

Descriptionyuuvis®FlowableTechnical details
Process model definition name as deployed.Column TypeProcess-definition parameter processDefinitionName
Process instance name (e.g. a case number)Column ProcessProcess-instance parameter name (is any user-entered string while startingas set when starting the process instance)
The time the follow-up ( process ) was createdColumn Start timeProcess-instance parameter startTime

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

The status is given in the user's language.

Column Statusderived Derived from process parameter -instance parameters completed and suspended

Start a process for an object via plugin action

...