submit
The "Submit" is an action that sends the current form to the backend system.
To do this, an POST message is sent.
An action to be performed is expected in response.
The structure of the message exchange can be found here.
A submit is typically triggered by the user via a button.
Before the submit is sent, validation is performed. The submit is aborted if errors occur during validation.
Overview
action("submit")-
Action to be performed.
payload(SubmitActionPayload)-
Object containing the URL to be specified.
SubmitActionPayload
url(string)-
Server URL. If not specified, the submitUrl in the configuration is used. If this URL is also not specified, the submission fails immediately and the user receives the error message "missing submitUrl".
If Flow is used to connect to Process Engines, a URL can be copied directly from the Flow Manager and pasted here.
Example
In the following example, triggering the submit results in an error because no response is received from the server. However, the submit message containing the current state of the form is sent, as can be seen, for example, in the Network tab of the Developer Tools. A "server-side failure" message is displayed to 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"
}
}
}