Share via

2.2.39 webServiceAdapter

  • Article

The webServiceAdapter element specifies the properties of a data adapter that MUST be created to query and submit data to a Web service.

When a form is submitted to a Web service, a SOAP message containing data from the form file is sent to the Web service. The SOAP message is generated from an XML template file, as specified by section 2.6, which is populated by data extracted from the form file.

Parent Elements

dataAdapters

query

submit

Child Elements

operation

Attributes:

name: The name of the data adapter. The specified name MUST be unique for all data adapters within the form template. If this attribute is not present, its value MUST be interpreted as an empty string.

queryAllowed: Specifies whether the data adapter is allowed to query the Web service for data. If this attribute is not present, its value MUST be interpreted as "yes".

submitAllowed: Specifies whether the data adapter is allowed to submit data to the Web service. If this attribute is not present, its value MUST be interpreted as "yes".

useDataSet: Specifies whether the data adapter supports the ADO.Net DataSet type. The ADO.Net DataSet is used if the Web service queries data from and submits data to an internal database. If this attribute is not present, its value MUST be interpreted as "no".

wsdlUrl: The URL of the Web service. If this attribute is not present, its value MUST be interpreted as an empty string.

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

 <xsd:element name="webServiceAdapter">
   <xsd:complexType>
     <xsd:choice>
       <xsd:element ref="xsf:operation"/>
     </xsd:choice>
     <xsd:attribute name="name" type="xsf:xdTitle" use="optional"/>
     <xsd:attribute name="wsdlUrl" type="xsd:string" use="required"/>
     <xsd:attribute name="queryAllowed" type="xsf:xdYesNo" use="optional"/>
     <xsd:attribute name="submitAllowed" type="xsf:xdYesNo" use="optional"/>
     <xsd:attribute name="useDataSet" type="xsf:xdYesNo" use="optional"/>
   </xsd:complexType>
 </xsd:element>