submit
The submit is an action that transmits the current form to the backend system.
A POST message is sent for this.
An action to be performed is expected in response.
The structure of the message exchange can be found here.
A submit is usually triggered by the user via a button.
A validation is performed before the submit is sent. The submit is canceled if errors occur during validation.
Overview
action("submit")-
Action to be executed.
payload(SubmitActionPayload)-
Object containing the url to be specified.
SubmitActionPayload
url(string)-
Url of the server. If not specified, the submitUrl in the configuration is used. If this url is also not specified, the submit fails directly and the user receives the error message "missing submitUrl".
If Flow is used for the connection to process engines, a url can be copied directly from the Flow Manager and pasted here.
Example
In the following example, triggering the submit leads to an error as no message is returned from a server. However, the submit message with the current status of the form is sent, which can be seen in the Network tab of the developer tools, for example. A "server-side failure" message is displayed for the user.
Example submit.json
{
"metaData": {
"id": 0,
"version": 0
},
"configuration": {
"submitUrl": "http://localhost:3000/test"
},
"components": [
{
"type": "container",
"label": "Submit",
"components": [
{
"type": "button",
"action": "submit",
"label": "Submit Button"
},
{
"type": "textfield",
"value": "${/data/someValue}"
}
]
}
],
"state": {
"data": {
"someValue": "Hello"
}
}
}