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


...

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

...

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

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

Inbox

As of version 2021 Autumn, the inbox lists besides the follow-up tasks all other BPM tasks as well. 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 creating the follow-up.
TaskTask nameThe time the follow-up (process) was created.
ReceivedTask CreateTimeThe due date was entered while creating the follow-up.

...

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 timeProcess-instance parameter startTimeThe time the process was created
StatusDerived from process-instance parameters completed and suspended

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

The status is given in the user's language.

Start a process for an object via plugin action

You can extend the 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.

Image RemovedImage Added

To get this example action offered the following code must be imported as a file in the settings of the client. The 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.

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

Code Block
languageyml
titleClient Settings for '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"
    }
  }
}

...