Page Comparison

Page Properties

hidden	true
id	PROGRESS

Product Version
Report Note
Assignee

Resources & Remarks

Modification History

Name	Date	Product Version	Action
Antje	23 JUL 2021	2021 Autumn	created
Martin	26 JUL 2021	2021 Autumn	draft
Bratislav	29 JUL 2021	2021 Autumn	draft
Antje	29 JUL 2021	2021 Autumn	formatting, published
Agnieszka	25 AUG 2021	2021 Autumn	rLANG
Martin	24 SEP 2021	2021 Winter	Added 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 format Flowable variable name Example format Description

subject

"subject": "My subject"

appClientsystem_subject

Code Block
{ "action": "save", "variables": [ { "name": "appClientsystem_subject", "type": "string", "value": "My subject" }

Process subject

The client-specific task parameter subject is presented in the Inbox column Subject.

The parameter can be set using the Web-API Gateway GET/PUT endpoints for tasks or the corresponding BPM-API endpoints for saving the variable appClientsystem_subject.

attachments

"attachments": ["GUID1","GUID2", "GUID2"]

appClientsystem_attachments

Code Block
{ "action": "save", "variables": [ { "name": "appClientsystem_attachments", "type": "json", "value": [ "GUID1", "GUID2" ] }

Process attachments

The client-specific task parameter attachment is used for the task aspect Attachments in the Inbox. This parameter contains an array of object GUIDs. The user sees the title of the corresponding objects in the list of attachments.

The parameter can be set using the Web-API Gateway GET/PUT endpoints for tasks or the corresponding BPM-API endpoints for saving the variable appClientsystem_attachment.

taskMessages

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

Code Block

"taskMessages": [
  {
    "message": "messageWithoutColor"
  },
  {
    "level": "error",
    "message": "messageError",
    "type": "ul"
  },
  {
    "level": "warning",
    "message": "messageWarning",
    "type": "ul"
  },
  {
    "level": "info",
    "message": "messageError"
  },
  {
    "message": "Not translated message"
  }
]

appClientsystem_taskMessages

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

Code Block

{
  "action": "save",
  "variables": [
    {
      "name": "appClientsystem_taskForm",
      "type": "json",
      "value": { 
        "schemaProperties": [
          "tenKolibri:strsingle",
          "tenKolibri:datesingle"
        ]
      }
    },
    {
      "name": "appClientsystem_taskMessages",
      "type": "json",
      "value": [ 
        {
          "message": "messageWithoutColor"
        },
        {
          "level": "error",
          "message": "messageError",
          "type": "ul"
        },
        {
          "level": "warning",
          "message": "messageWarning",
          "type": "ul"
        },
        {
          "level": "info",
          "message": "messageError"
        },
        {
          "message": "Not translated message"
        }
      ]
    }
  ]
}

Dynamic Task Messages

This client-specific task 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:

level	description
without level	The message is rendered in the normal format
info	The text is rendered in the accent color
error	Text is rendered in Red
warning	Text is rendered in Orange

In this case, the message is a localization key the key will be translated (see "messageError" in the example). The keys need not '_lalbe' as it is for the name for a form field.

'"Type": "ul" can be used to render messages with this setting in a list.

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.

taskForm

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

Code Block
"taskForm": { "schemaProperties": [ "tenKolibri:strsingle", "tenKolibri:datesingle" ]

Example code for the GET tasks response of the Web-API Gateway using a form model:

Code Block

"taskForm": {
    "model": {
            "name": "twosteptest_proc:2nd_task",
            "situation": "EDIT",
            "script": "",
            "elements": [
              {
                "name": "core",
                "type": "o2mGroup",
                "elements": [
                  {
                    "type": "o2mGroup", 
                    "layout": {
                        "align": "row"
                    },
                    "elements": [
                    {
                        "type": "o2mGroup", 
                        "name": "twosteptest_proc:simplefields",
                        "layout": {
                            "align": "column"
                        },
                        "elements": [
                          {
                            "name": "twosteptest_proc:date",
                            "labelkey": "Date",
                            "type": "datetime",
                            "required": false,
                            "cardinality": "single",
                            "readonly": false,
                            "resolution": "date"
                          },
                          {
                            "name": "twosteptest_proc:string",
                            "type": "string",
                            "cardinality": "single",
                            "required": false,
                            "rows": 1,
                            "readonly": false                
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
     ]

appClientsystem_taskForm

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

Code Block
{ "action": "save", "variables": [ { "name": "appClientsystem_taskForm", "type": "json", "value": { "schemaProperties": [ "tenKolibri:strsingle", "tenKolibri:datesingle" ] } } ] }

Example code for saving the Flowable variable appClientsystem_taskForm via BPM-API PUT tasks using a form model:

Code Block

{
  "action": "save",
  "variables": [
    {
      "name": "appClientsystem_taskForm",
      "type": "json",
      "value": { 
        "model":
          {
            "name": "twosteptest_proc:2nd_task",
            "situation": "EDIT",
            "script": "",
            "elements": [
              {
                "name": "core",
                "type": "o2mGroup",
                "elements": [
                  {
                    "type": "o2mGroup", 
                    "layout": {
                        "align": "row"
                    },
                    "elements": [
                    {
                        "type": "o2mGroup", 
                        "name": "twosteptest_proc:simplefields",
                        "layout": {
                            "align": "column"
                        },
                        "elements": [
                          {
                            "name": "twosteptest_proc:date",
                            "labelkey": "Date",
                            "type": "datetime",
                            "required": false,
                            "cardinality": "single",
                            "readonly": false,
                            "resolution": "date"
                          },
                          {
                            "name": "twosteptest_proc:string",
                            "type": "string",
                            "cardinality": "single",
                            "required": false,
                            "rows": 1,
                            "readonly": false                
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
      }
    }
  ]
}

Dynamic Task Form

This client-specific task parameter can be used to present dynamically only those form fields that are relevant to be handled by the user. If the given property name does not have a representation in the schema it will be ignored other the attributes of this property will be used in the form.

There are two ways to handle a dynamic form offered:

Using schemaProperties the relevant property names can be listed.
Using model a usual form model syntax can be used for more complex forms.

...

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

...

Inbox

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

Column in yuuvis® client

Corresponding Counterpart in BPM EngineFollow-up dateProcess variable expiryDateTimeThe due date

Technical details	Description

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.

Type

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

As of 2021 Winter, an icon is displayed. If the process parameter processDefinition.idPrefix is follow-up, then a bell is shown and the tooltip shows Follow-up. Otherwise, a general process icon is shown and a tooltip with the localized prefix. If no localization is configured, the technical prefix is displayed.

The description that was entered while creating the follow-up.

StatusDerived from process parameters endTime and suspendedPossible values for Status are running, completed and suspended.

Inbox

...

Task Task name The time the follow-up (process) was created.

as of 2021 Winter: Subject Web-API Gateway parameter subject, represented as Flowable string variable subject Set while creating the process or during the process while saving the Flowable process variable appClientsystem_subject of type string

Received

as of 2021 Winter: Received on

Task CreateTime

The date and time the task was created.

The value corresponds to the due date that was entered while creating the follow-up.

As of version 2021 Winter, the inbox offers a task details area with the aspects Task, History, and Attachments (not on the following screenshot).

The following screenshot shows the three possible elements of the aspect Task:

A static task description is shown if the task name (here: 2nd_task_dynform) that is set in the Flowable process model has a description representation in the localization for the language the user has set. Use the key <task name>_description for the task description and <task name>_title for localizing the task name itself.
Dynamic messages if the Flowable variable appClientsystem_taskMessages of type JSON have been saved. Message can be plane text lines or as unformatted lists. Colors are given by a level parameter. More details are given here: (link will come soon).
A static or dynamic form. The static form is set via Flowable formKey and a form model that was saved with this name.
The dynamic form can be set by saving the Flowable variable appClientsystem_taskMessages of type JSON. More details are given here: (link will come soon)

Image Added

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:

The date and time the task was created.

The value corresponds to the due date that was entered while creating the follow-up.

Column in yuuvis® client	Technical details	Description
Type	If the process parameter `processDefinitionName` is `Follow-up`, then `Follow-up`. Otherwise `Task.`Process-definition parameter `processDefinitionName` As of 2021 Winter, an icon is displayed. If the process parameter `processDefinition.idPrefix` is `follow-up`, then a bell is shown and the tooltip shows `Follow-up`. Otherwise, a general process icon is shown and a tooltip with the localized prefix. If no localization is configured, the technical prefix is displayed.	The description that was entered while creating the follow-up.
Task	Task `name`	The time the follow-up (process) was created.
as of 2021 Winter: Subject	Web-API Gateway parameter `subject`, represented as Flowable string variable `subject`	Set while creating the process.
Received as of 2021 Winter: Received on	Task `CreateTime`

My processes

...

	Process definition name
Process (not available anymore as of version 2021)	Process-instance parameter `name` (as set when starting the process instance)	Process instance name (e.g., a case number)
Created on	Process-instance parameter `startTime`	The time the process was created.
Status	Derived from the process-instance parameters `completed` and `suspended`	The status of the process can be running, suspended, or completed. The status is given in the user's language.

My follow-ups

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

Column in yuuvis® client

Technical detailsCreated onProcess-instance parameter startTimeThe time the process was created

Corresponding Counterpart in BPM Engine	Description

Type

Process-definition parameter processDefinitionName

As of 2021 Winter, an icon is displayed. If the process parameter processDefinition.idPrefix is follow-up, then a bell is shown and the tooltip shows Follow-up. Otherwise, a general process icon is shown and a tooltip with the localized prefix. If no localization is configured, the technical prefix is displayed.

Process definition nameProcess (not available anymore as of version 2021)Process-instance parameter name (as set when starting the process instance)Process instance name (e.g., a case number)

Description (not available anymore as of version 2021)	Process variable `whatAbout`	The description that was entered while creating the follow-up.
as of 2021 Winter: Subject	Web-API Gateway parameter `subject`, represented as Flowable string variable `subject`	Set while creating the process.
Created on	Process parameter `startTime`	The time the follow-up (process) was created.
Follow-up date	Process variable `expiryDateTime`	The due date that was entered while creating the follow-up.
Status	Derived from

the

process

-instance

parameters

completed and suspended

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

The status is given in the user's language

endTime and suspended Possible values for Status are running, completed and suspended.

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

...

Versions Compared

Old Version 40

New Version 41

Key

My follow-ups

Inbox

Inbox

My processes

My processes

My follow-ups

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