ja-submit-form
The schema defines the following additional types:
Use this action to submit form - usually as a primary Action of Jig.
Properties of the JASubmitFormInBackgroundConfig object:
Property | Type | Required | Description |
type | action.submit-form | true | |
instanceId | InstanceId | Expression | false | |
when | Expression | boolean | false | When the property is set to 'false', the action will not execute. Default is 'true'. |
options | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | Generic Options | true | Options related to Jig Actions on bottom panel |
When the property is set to 'false', the action will not execute. Default is 'true'.
options (DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | Generic Options, required)
Options related to Jig Actions on bottom panel
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_ONEDRIVE | true | |
entity | data-provider-definition | string | true | |
method | create | true | |
data | Parameters | string | true | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
file | string | string | false | The file path |
fileName | string | string | false | The name of the file |
tokenType | string | string | true | Token type |
The file path
The object must be any of the following types:
The name of the file
The object must be any of the following types:
Token type
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_ONEDRIVE | true | |
entity | data-provider-definition | string | true | |
method | update | true | |
data | Parameters | string | true | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
file | string | string | false | The file path |
fileName | string | string | false | The name of the file |
tokenType | string | string | true | Token type |
id | string | string | false | The id of the record |
The file path
The object must be any of the following types:
The name of the file
The object must be any of the following types:
Token type
The object must be any of the following types:
The id of the record
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_ONEDRIVE | true | |
entity | data-provider-definition | string | true | |
method | save | true | |
data | Parameters | string | true | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
file | string | string | false | The file path |
fileName | string | string | false | The name of the file |
tokenType | string | string | true | Token type |
id | string | string | false | The id of the record |
The file path
The object must be any of the following types:
The name of the file
The object must be any of the following types:
Token type
The object must be any of the following types:
The id of the record
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_ONEDRIVE | true | |
entity | data-provider-definition | string | true | |
method | delete | true | |
data | Parameters | string | true | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
tokenType | string | string | true | Token type |
id | string | string | false | The id of the record |
Token type
The object must be any of the following types:
The id of the record
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_ONEDRIVE | true | |
entity | data-provider-definition | string | true | |
method | download | true | |
data | Parameters | string | true | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
fileName | string | string | false | The name of the file |
tokenType | string | string | true | Token type |
id | string | string | false | The id of the record |
The name of the file
The object must be any of the following types:
Token type
The object must be any of the following types:
The id of the record
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_ONEDRIVE | true | |
entity | data-provider-definition | string | true | |
method | string | true | |
data | Parameters | string | true | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
fileName | string | string | false | The name of the file |
file | string | string | false | The file path |
tokenType | string | string | true | Token type |
id | string | string | false | The id of the record |
The name of the file
The object must be any of the following types:
The file path
The object must be any of the following types:
Token type
The object must be any of the following types:
The id of the record
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_DYNAMIC | true | |
entity | data-provider-definition | string | true | |
method | create | true | |
data | Parameters | string | false | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
id | string | string | false | The id of the record |
The id of the record
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_DYNAMIC | true | |
entity | data-provider-definition | string | true | |
method | update | true | |
data | Parameters | string | false | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
id | string | string | true | The id of the record |
The id of the record
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_DYNAMIC | true | |
entity | data-provider-definition | string | true | |
method | save | true | |
data | Parameters | string | false | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
id | string | string | false | The id of the record |
The id of the record
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_DYNAMIC | true | |
entity | data-provider-definition | string | true | |
method | delete | true | |
data | IdParameter | string | false | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
The object must be any of the following types:
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | DATA_PROVIDER_DYNAMIC | true | |
entity | data-provider-definition | string | true | |
method | string | true | |
data | Parameters | string | false | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
id | string | string | false | The id of the record |
The id of the record
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
provider | data-provider-definition | string | true | |
method | data-provider-definition | string | true | |
entity | data-provider-definition | string | false | |
function | string | string | false | |
functionParameters | Expression | Primitive | false | |
data | Expression | Primitive | string | false | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
The object must be any of the following types:
The object must be any of the following types:
The object must be any of the following types:
The object must be any of the following types:
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the NextActions object:
Property | Type | Required | Description |
title | string | Expression | TextWithFormat | TextLocale | false | |
description | string | Expression | TextWithFormat | TextLocale | false | |
actions | false | |
actions (keg-action-on-button[])
The object is an array with all elements of the type keg-action-on-button.
Named parameters with values or expressions
Properties of the IdParameter object:
Property | Type | Required | Description |
id | string | string | true | The id of the record |
The id of the record
The object must be any of the following types:
Properties of the JASubmitFormOnButtonConfig object:
Property | Type | Required | Description |
type | action.submit-form | true | |
instanceId | InstanceId | Expression | false | |
when | Expression | boolean | false | When the property is set to 'false', the action will not execute. Default is 'true'. |
options | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | Generic Options | true | Options related to Jig Actions on bottom panel |
When the property is set to 'false', the action will not execute. Default is 'true'.
options (DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_ONEDRIVE | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | DATA_PROVIDER_DYNAMIC | Generic Options, required)
Options related to Jig Actions on bottom panel
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
title | string | Expression | TextWithFormat | TextLocale | true | Title of action displayed on a button. |
icon | icon-name | string | false | Icon of action displayed on a button. |
style | object | false | More of them can be true. It will be evaluated based on priority. |
isHidden | boolean | string | false | Hides the button when `true` |
provider | DATA_PROVIDER_ONEDRIVE | true | |
entity | data-provider-definition | string | true | |
method | create | true | |
data | Parameters | string | true | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
Title of action displayed on a button.
icon (icon-name | string)
Icon of action displayed on a button.
The object must be any of the following types:
More of them can be true. It will be evaluated based on priority.
Hides the button when true
The object must be any of the following types:
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
file | string | string | false | The file path |
fileName | string | string | false | The name of the file |
tokenType | string | string | true | Token type |
The file path
The object must be any of the following types:
The name of the file
The object must be any of the following types:
Token type
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
title | string | Expression | TextWithFormat | TextLocale | true | Title of action displayed on a button. |
icon | icon-name | string | false | Icon of action displayed on a button. |
style | object | false | More of them can be true. It will be evaluated based on priority. |
isHidden | boolean | string | false | Hides the button when `true` |
provider | DATA_PROVIDER_ONEDRIVE | true | |
entity | data-provider-definition | string | true | |
method | update | true | |
data | Parameters | string | true | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
Title of action displayed on a button.
icon (icon-name | string)
Icon of action displayed on a button.
The object must be any of the following types:
More of them can be true. It will be evaluated based on priority.
Hides the button when true
The object must be any of the following types:
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |
file | string | string | false | The file path |
fileName | string | string | false | The name of the file |
tokenType | string | string | true | Token type |
id | string | string | false | The id of the record |
The file path
The object must be any of the following types:
The name of the file
The object must be any of the following types:
Token type
The object must be any of the following types:
The id of the record
The object must be any of the following types:
Id of a record you want to update.
Whether or not to go back after Action is executed
onSuccess (keg-action-in-background | NextActions)
Display follow-up actions when primary Action was successfully done.
The object must be any of the following types:
Properties of the options object:
Property | Type | Required | Description |
title | string | Expression | TextWithFormat | TextLocale | true | Title of action displayed on a button. |
icon | icon-name | string | false | Icon of action displayed on a button. |
style | object | false | More of them can be true. It will be evaluated based on priority. |
isHidden | boolean | string | false | Hides the button when `true` |
provider | DATA_PROVIDER_ONEDRIVE | true | |
entity | data-provider-definition | string | true | |
method | save | true | |
data | Parameters | string | true | |
formId | string | true | Id of a form that should be submit. |
recordId | string | false | Id of a record you want to update. |
goBack | enum<string> | false | Whether or not to go back after Action is executed |
onSuccess | keg-action-in-background | NextActions | false | Display follow-up actions when primary Action was successfully done. |
Title of action displayed on a button.
icon (icon-name | string)
Icon of action displayed on a button.
The object must be any of the following types:
More of them can be true. It will be evaluated based on priority.
Hides the button when true
The object must be any of the following types:
The object must be any of the following types:
The object must be any of the following types:
Named parameters with values or expressions
Properties of the data object:
Property | Type | Required | Description |