Versions Compared

Old Version 44

changes.mady.by.user Team Kolibri (Unlicensed)

Saved on

compared with

New Version 45

changes.mady.by.user Technische Redaktion

Saved on

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

Task parameter
(Web-API Gateway GET tasks)		Example formatFlowable variable nameExample formatDescription
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_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:

leveldescription
without levelThe message is rendered in the normal format
infoThe text is rendered in the accent color
errorText is rendered in Red
warningText 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.

Image Removed

taskForm

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

Code Block
"taskForm": {
    "schemaProperties": [
      "Mycompany:strsingle",
      "Mycompany: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": "myProcess:simplefields",
                        "layout": {
                            "align": "column"
                        },
                        "elements": [
                          {
                            "name": "myProcess:date",
                            "labelkey": "Date",
                            "type": "datetime",
                            "required": false,
                            "cardinality": "single",
                            "readonly": false,
                            "resolution": "date"
                          },
                          {
                            "name": "myProcess: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": [
          "tenMycompany:strsingle",
          "tenMycompany: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": "myProcess:simplefields",
                        "layout": {
                            "align": "column"
                        },
                        "elements": [
                          {
                            "name": "myProcess:date",
                            "labelkey": "Date",
                            "type": "datetime",
                            "required": false,
                            "cardinality": "single",
                            "readonly": false,
                            "resolution": "date"
                          },
                          {
                            "name": "myProcess: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.
    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.

    Added the section for starting processes with a startform
    Antje27 OCT 20212021 Winterclient-specific Flowable variables added



    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.

    ...

    Code Block
    titleExample Configuration
    linenumberstrue
    collapsetrue
    {
  "name": "twosteptest_proc:1st_task",
  "situation": "EDIT",
  "script": "",
  "elements": [
    {
      "name": "core",
      "type": "o2mGroup",
      "elements": [
        {
          "type": "o2mGroup", 
          "layout": {
              "align": "row"
          },
          "elements": [
           {
              "type": "o2mGroup", 
              "name": "xyzSimplefields",
              "layout": {
                  "align": "column"
              },
              "elements": [
                {
                  "name": xyzDatetime",
                  "type": "datetime",
                  "required": false,
                  "cardinality": "single",
                  "readonly": false
                },
                {
                  "name": "xyzDate",
                  "type": "datetime",
                  "required": false,
                  "cardinality": "single",
                  "readonly": false,
                  "resolution": "date"
                },
                {
                  "name": "xyzInteger",
                  "type": "integer",
                  "required": false,
                  "cardinality": "single",
                  "readonly": false                },
                {
                  "name": "xyzDecimal",
                  "type": "decimal",
                  "required": false,
                  "cardinality": "single",
                  "readonly": false
                },
                {
                  "name": "xyzString",
                  "type": "string",
                  "required": false,
                  "rows": 1,
                  "readonly": false                },
                {
                  "name": "xyzStringmultirow",
                  "type": "string",
                  "required": false,
                  "rows": 3,
                  "readonly": false
                }
              ]
            },
            {
              "type": "o2mGroup", 
              "name": "xyzComplexfields", 
              "layout": {
                  "align": "column"
              },
              "elements": [
                {
                  "name": "xyzEmail",
                  "type": "string",
                  "cardinality": "single",
                  "readonly": false,
                  "classifications": ["email"]
                },
                {
                  "name": "xyzUrl",
                  "type": "string",
                  "required": false,
                  "readonly": false,
                  "classifications": ["url"]
                },
                {
                  "name": "xyzPhone",
                  "type": "string",
                  "required": false,
                  "readonly": false,
                  "classifications": ["phone"]
                },
                {
                  "name": "xyzUser",
                  "type": "string",
                  "required": false,
                  "cardinality": "single",
                  "readonly": false,
                  "classifications": ["id:organization"]
                },
                {
                  "name": "xyzReference",
                  "type": "string",
                  "required": false,
                  "cardinality": "single",
                  "readonly": false,
                  "classifications": ["id:reference[]"],
                  "label": "Reference"
                },
                {
                  "name": "xyzCatalogcustom",
                  "type": "string",
                  "required": false,
                  "cardinality": "single",
                  "readonly": false,
                  "classifications": ["custom:catalog[/api-web/api/dms/catalogs/tenKolibritenMytenant:processstatus]"],
                  "label": "Catalog status"
                },
                {
                  "name": "xyzBroc:boolean",
                  "type": "boolean",
                  "required": false,
                  "readonly": false,
                  "label": "Boolean"
                }
              ]
            }
          ]
        },
        {
          "name": "xyzTest_table",
          "type": "table",
          "required": false,
          "readonly": false,
          "label": "Notices",
          "description": "List of notices",
          "classifications": "sortable",
          "elements": [
            {
              "name": "xyzColumn_string",
              "type": "string",
              "required": false,
              "cardinality": "single",
              "readonly": false,
              "label": "String"
            },
            {
              "name": "xyzColumn_date",
              "type": "datetime",
              "required": false,
              "cardinality": "single",
              "readonly": false,
              "label": "Date"
            },
            {
              "name": "xyzColumn_user",
              "type": "string",
              "required": false,
              "cardinality": "single",
              "classifications": ["id:organization"],
              "readonly": false,
              "label": "User"
            },
            {
              "name": "xyzColumn_boolean",
              "type": "boolean",
              "required": false,
              "cardinality": "single",
              "readonly": false,
              "label": "Boolean"
            }
          ]
        }
      ]
    },
    {
      "name": "data",
      "type": "o2mGroupStack",
      "elements": [],
          "layout": { "align": "column" },
          "label": "Table group"
    }
  ]
}

    ...

    Task parameter
    (Web-API Gateway GET tasks)    		Example formatFlowable variable nameExample formatDescription
    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 saving setting the variable appClientsystem_attachment.

    taskMessages

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

    Code Block
    {
  "action": "save",
  "variables": [
    {
      "name": "appClientsystem_taskForm",
      "type": "json",
      "value": { 
        "schemaProperties": [
          "tenKolibritenMytenant:strsingle",
          "tenKolibritenMytenant: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 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 Task aspect area in the inbox Inbox.

    The parameter level differentiates 4 types of formating the messages level parameter specifies the formatting of the corresponding messages. The following values are available:

    leveldescription
    without levelThe message is rendered in the normal format
    infoThe text is rendered in the accent color
    errorText is rendered in Red
    warningText is rendered in Orange

    In this case, If the message is a localization key, the key will be translated (see "see messageError" in the example). The keys do not need not '_lalbe' as it is 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 task parameter value specified for taskMessages is responded in retrieved by the GET tasks endpoint of the Web-API Gateway and can only be set by saving 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": [
      "tenKolibritenMytenant:strsingle",
      "tenKolibritenMytenant: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 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": [
          "tenKolibritenMytenant:strsingle",
          "tenKolibritenMytenant: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 Configure the 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 select 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 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

    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.

    The code clock below shows an example for the Flowable representation of a yuuvis table property. Tables are only shown up in a form where the types of the column properties are added as seen above.

    ...