Defines submissions.
Type
- uiplugin
Property Summary
- abortTrigger
- Displays the Cancel button while the process is running.
- action
- Server URL to conduct submission. URL of the data to bind.
- customHandler
- User-defined handler
- description
- Defines the submission for the communication with the web terminal.
- encoding
- Encoding method on the server side
- errorHandler
- Handler to be executed upon error occurrence
- id
- Submission ID.
- instance
- Instance ID
- mediatype
- Communication method with the server. (Asynchronous or synchronous.)
- method
- Request method
- mode
- Communication method with the server. (Asynchronous or synchronous.)
- processMsg
- Message to be displayed during the process
- ref
- XPath of the instance or DataCollection of the source to send to the server
- replace
- Subject to be replaced with the response document returned by the submission action
- target
- XPath of the instance or DataCollection to store the data sent by the server
- useModal
- [default:false, true] Creates a modal to disable other components while the submission is running and the process message is being displayed.
- userData1
- User-defined parameter for submission communication.
- userData2
- User-defined parameter for submission communication.
- webtopRef
- Defines the IO mapping rules for submission communication.
Event Summary
- submit
- Pre-processing before a submission request.
- submitdone
- Triggered when the response status code is normal.
- submiterror
- Triggered when the response status code is an error (smaller than 200 or higher than 300).
Method Summary
Property Detail
- abortTrigger
-
Displays the Cancel button while the process is running.
- action
-
Server URL to conduct submission. URL of the data to bind.
- customHandler
-
User-defined handler
- description
-
Defines the submission for the communication with the web terminal.
- encoding
-
Encoding method on the server side
- errorHandler
-
Handler to be executed upon error occurrence
- id
-
Submission ID.
The submission ID is allocated as a global object. The script can access each object through the component ID. - instance
-
Instance ID
- mediatype
-
Communication method with the server. (Asynchronous or synchronous.)
- method
-
Request method
- mode
-
Communication method with the server. (Asynchronous or synchronous.)
- processMsg
-
Message to be displayed during the process
- ref
-
XPath of the instance or DataCollection of the source to send to the server
- replace
-
Subject to be replaced with the response document returned by the submission action
- target
-
XPath of the instance or DataCollection to store the data sent by the server
- useModal
-
[default:false, true] Creates a modal to disable other components while the submission is running and the process message is being displayed.
- userData1
-
User-defined parameter for submission communication.
- userData2
-
User-defined parameter for submission communication.
- webtopRef
-
Defines the IO mapping rules for submission communication.
Event Detail
- submit
-
Pre-processing before a submission request. If false is returned, submission will not be made.
Parameter name type description e Object Submission object <String:N> e.id : Returns the ID of the Submission object. - submitdone
-
Triggered when the response status code is normal.
Parameter name type description e Object Submission object <String:N> e.id : Returns the ID of the Submission object. <String:N> e.resourceUri : Returns the communication URI. <String:N> e.responseHeaders : Returns the contents of the Response Headers. <String:N> e.responseStatusCode : Returns the Response Status Code. <String:N> e.responseReasonPhrase : Returns the Response Status Text. <String:N> e.responseBody : Parses the response data into XML and returns the XML data. (When the Response Content-Type is JSON, the JSON object will be parsed into XML.) <String:N> e.responseText : Returns the response data as a string. <String:N> e.responseJSON : Returns the response data in JSON format. - submiterror
-
Triggered when the response status code is an error (smaller than 200 or higher than 300).
Parameter name type description e Object Submission object <String:N> e.id : Returns the ID of the Submission object. <String:N> e.errorType : Returns the fixed value as the target-error. <String:N> e.resourceUri : Returns the communication URI. <String:N> e.responseHeaders : Returns the contents of the Response Headers. <String:N> e.responseStatusCode : Returns the Response Status Code. <String:N> e.responseReasonPhrase : Returns the Response Status Text. <String:N> e.responseBody : Parses the response data into XML and returns the XML data. (When the Response Content-Type is JSON, the JSON object will be parsed into XML.) <String:N> e.responseText : Returns the response data as a string. <String:N> e.responseJSON : Returns the response data in JSON format.