2.2.1.2.53 submit

The submit element specifies the necessary information for configuring the submit operation for the form. This includes information regarding the method to use, UI elements that call the operation, and related actions to perform after the submit operation is complete. A submit element can be associated with a data adapter, rule set, script handler, or HTTP handler as follows:

  • Data adapter: The form file is submitted using a data adapter if the target for the submit operation is a data source with an associated data adapter, as specified by the davAdapter element (section 2.2.1.2.29), emailAdapter element (section 2.2.1.2.32), submitToHostAdapter element (section 2.2.1.2.39), and webServiceAdapter element (section 2.2.1.2.20). The data adapter child element MUST have the submitAllowed attribute set to "yes".

  • Rule Set: The form file is submitted by an associated collection of rules that run associated actions specified by the ruleSetAction element (section 2.2.1.2.113).

  • Script Handler: The form file is submitted by associated form code specified by the useScriptHandler element (section 2.2.1.2.58).

  • HTTP Handler: The form file is submitted using the HTTP method specified by the useHttpHandler element (section 2.2.1.2.57).

Prior to the submit operation being performed, the form file MUST fully conform to the XML schema specified in section 2.3 and to any custom validation defined in the form template, as specified by the customValidation element (section 2.2.1.2.43).

Parent Elements

xDocumentClass

Child Elements

davAdapter

emailAdapter

errorMessage

ruleSetAction

submitAction

submitToHostAdapter

successMessage

useHttpHandler

useQueryAdapter

useScriptHandler

webServiceAdapter

Attributes:

caption: This attribute specifies the name of the submit button. A corresponding button MUST appear on the form view toolbar when the form is loaded. If this attribute is not present, its value MUST be interpreted as "Submit".

disableMenuItem: This attribute specifies whether the button for submitting the form file is available. If this attribute’s value is "yes", the button MUST be removed from the toolbar. If this attribute is not present, its value MUST be interpreted as "no".

onAfterSubmit: This attribute specifies an action that MUST be taken upon successful submission of the form file. If this attribute is not present, its value MUST be interpreted as "keepOpen". The specified value MUST be one of the following:

  • close: If this value is specified, the form closes on successful submission of the form.

  • keepOpen: If this value is specified, the form does NOT close on successful submission of the form.

  • openNew: If this value is specified, the form closes and a new instance of the form is opened on successful submission of the form.

showSignatureReminder: This attribute MUST be ignored.

showStatusDialog: This attribute specifies that a dialog box MUST be shown after the form file is submitted if this attribute’s value is "yes". If this attribute is not present, its value MUST be interpreted as "yes".

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.

 <xsd:element name="submit">
   <xsd:complexType>
     <xsd:all>
       <xsd:element name="submitAction" minOccurs="0">
         <xsd:complexType>
           <xsd:attribute name="adapter" type="xsf:xdTitle" use="required"/>
         </xsd:complexType>
         <xsd:keyref name="submitAdapter_name_keyref" refer="xsf:adapter_name_key">
           <xsd:selector xpath="."/>
           <xsd:field xpath="@adapter"/>
         </xsd:keyref>
       </xsd:element>
       <xsd:element ref="xsf:useHttpHandler" minOccurs="0"/>
       <xsd:element ref="xsf:useScriptHandler" minOccurs="0"/>
       <xsd:element ref="xsf:ruleSetAction" minOccurs="0"/>
       <xsd:element ref="xsf:useQueryAdapter" minOccurs="0"/>
       <xsd:element ref="xsf:webServiceAdapter" minOccurs="0"/>
       <xsd:element ref="xsf:davAdapter" minOccurs="0"/>
       <xsd:element ref="xsf:emailAdapter" minOccurs="0"/>
       <xsd:element ref="xsf:submitToHostAdapter" minOccurs="0"/>
       <xsd:element name="successMessage" type="xsd:string" minOccurs="0"/>
       <xsd:element name="errorMessage" type="xsd:string" minOccurs="0"/>
     </xsd:all>
     <xsd:attribute name="caption" type="xsd:string" use="optional"/>
     <xsd:attribute name="onAfterSubmit" use="optional">
       <xsd:simpleType>
         <xsd:restriction base="xsd:NMTOKEN">
           <xsd:enumeration value="close"/>
           <xsd:enumeration value="keepOpen"/>
           <xsd:enumeration value="openNew"/>
         </xsd:restriction>
       </xsd:simpleType>
     </xsd:attribute>
     <xsd:attribute name="showStatusDialog" type="xsf:xdYesNo" use="optional"/>
     <xsd:attribute name="showSignatureReminder" type="xsf:xdYesNo" use="optional"/>
     <xsd:attribute name="disableMenuItem" type="xsf:xdYesNo" use="optional"/>
   </xsd:complexType>
   <xsd:keyref name="submit_ruleSetAction" refer="xsf:ruleset_name_key">
     <xsd:selector xpath="./xsf:ruleSetAction"/>
     <xsd:field xpath="@ruleSet"/>
   </xsd:keyref>
 </xsd:element>