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
Antje	27 OCT 2021	2021 Winter	client-specific Flowable variables added

...

Column in yuuvis® client	Corresponding Counterpart in BPM Engine	Description
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 process parameters `endTime` and `suspended`	Possible values for Status are `running`, `completed` and `suspended`.

...

To provide the example Two step process action in a client, import the client plug-in configuration file shown below. To be able to import a settings file, users need an administrative role.
>> Extending the Clients with Plug-ins

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

...

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 Subject column of the Inbox.

The parameter can be set using the Web-API Gateway GET/PUT endpoints for tasks or the corresponding BPM-API endpoints for setting 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 tasks' Attachments aspect area of the Inbox. The value is an array of object GUIDs. The title of the corresponding objects is displayed in the list of attachments for users.

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

taskMessages

Example code for the GET task's 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 setting the Flowable variable appClientsystem_taskMessages via BPM-API PUT tasks:

Code Block

{
  "action": "save",
  "variables": [
    {
      "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"
        }
      ]
    }
  ]
}

Configure 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 level parameter specifies the formatting of the corresponding messages. The following values are available:

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

If the message is a localization key, the key will be translated (see messageError in the example). The keys do not need an appended _label as required for the name for a form field.

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

The value specified for taskMessages is retrieved by the GET tasks endpoint of the Web-API Gateway and can only be set by via the Flowable variable appClientsystem_taskMessages.

taskForm

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

Code Block
"taskForm": { "schemaProperties": [ "tenMytenant:strsingle", "tenMytenant: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 setting the Flowable variable appClientsystem_taskForm via BPM-API PUT tasks using schemaProperties:

Code Block
{ "action": "save", "variables": [ { "name": "appClientsystem_taskForm", "type": "json", "value": { "schemaProperties": [ "tenMytenant:strsingle", "tenMytenant: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                
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          }
      }
    }
  ]
}

Configure the Task Form

This client-specific task parameter can be used to select specify user-relevant properties to be displayed in the task form. Each property is specified by its name. The attributes of this property will be used in determine the style of the form field.

Form fields can be handled either by

listing the relevant properties in schemaProperties or
configuring a more complex form with form model syntax in a model.

If name does not have a representation in the schema, it will be ignored.

...

As of version 2021 Winter, a plug-in action is available that allows to start a process via a start form as shown in the example screenshot. If all form fields are filled with valid values, the Start button is enabled. Both form fields User and Comment are required variables for starting a process. The code block below shows the corresponding plug-in configuration offering a start form with the name taskform in the object action view (displayed after a click on the object action Test process with role assignment).

...

Versions Compared

Old Version 47

New Version 48

Key