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
Martin24 SEP 20212021 WinterAdded the section for starting processes with a startform


Hallo Antje, ich würde gerne noch eine Sektion einbauen, die Client-spezifische Flowable Variablen listet und beschreibt.

Task parameter
(Web-API Gateway GET tasks)
Example formatFlowable variable nameExample formatDescription
subject
appClientsystem_subject

attachments
appClientsystem_attachments

taskMessages

Example code for the GET tasks response of the Web-API Gateway:

Code Block
"taskMessages": [
  {
    "message":
    "tenKolibri:text1"
  },
  {
    "level": "error",
    "message": "text 2"
  },
  {
   "level": "warning",
   "message": "text 3"
  },
  {
   "level": "info",
   "message": "text 4"
  } 
] 


appClientsystem_taskMessages

Example code for saving the Flowable variable via BPM-API PUT tasks:

Code Block
{
  "action": "save",
  "variables": [
    {
      "name": "appClientsystem_taskMessages",
      "type": "json",
      "value": [ 
        {
          "message": "tenKolibri:text1"
        },
        {
          "level": "error",
          "message": "text 2"
        },
        {
          "level": "warning",
          "message": "text 3"
        },
        {
          "level": "info",
          "message": "text 4"
        }
      ]
    }


Dynamic Task Messages

This parameter can be used to present necessary information for working on this particular task. The messages are presented on the top of the task aspect area in the inbox.

The parameter level differentiates 4 types of formating the messages:

leveldescription
without levelThe message is rendered in the normal format
infoThe text is rendered in Green
errorText is rendered in Red
warningText is rendered in Yellow

In this case, the message is a localization key the key will be translated (see "tenKolibri:text1" in the example).

The task parameter taskMessages is responded in the GET tasks endpoint of the Web-API Gateway and can only be set by saving the Flowable variable appClientsystem_taskMessages.




appClientsystem_taskForm



Excerpt

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

...

Column in yuuvis® clientCorresponding Counterpart in BPM EngineDescription

Description (not available anymore as of version 2021)

Process variable whatAboutThe description that was entered while creating the follow-up.
as of 2021 Winter: SubjectWeb-API Gateway parameter subject, represented as Flowable string variable subjectSet while creating the process.
Created 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.
StatusDerived from process parameters endTime and suspendedPossible values for Status are running, completed and suspended.

...