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_taskForm",
"type": "json",
"value": {
"schemaProperties": [
"tenMytenant:strsingle",
"tenMytenant: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"
}
]
}
]
} |
| 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.  Image Modified
|
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 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. 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. |