webServiceAdapterExtension Element

Article
06/14/2014

Specifies extended information for the corresponding webServiceAdapter element in the manifest.xsf.

Usage

  
<webServiceAdapterExtension
	trackDataSetChanges="xsf:xdYesNo"
	ref="xsf:xdTitle"
 queryKey="xsd:string"
 queryFile="xsd:string"
/>

Element Information

Element type	`xsd:complexType`
Namespace	xsf2

Elements and Attributes

Parent Elements

Element	Description
dataConnections	Contains elements that specify data connections.

Child Elements

Element	Description
connectoid	Specifies information that describes a data connection file.
relativeQuery	Specifies a substring of the serviceUrl attribute of the webServiceAdapter element that can be replaced at run time by setting the dataConnectionBaseUrl property of an XmlFormView ASP.NET control hosting a Microsoft Office InfoPath form template.

Attributes

Attribute	Type	Required	Description	Possible Values
trackDataSetChanges	xdYesNo	Optional	Specifies whether change tracking is enabled for a main Web service query data connection that returns a DataSet. If set to "yes", InfoPath will track changes to the DataSet and submit the changes as a diffgram. This attribute must be set to "no" for browser-enabled form templates.	yes no
ref	xdTitle	Required	Specifies the name attribute of the webServiceAdapter element that this element extends. Note This element or attribute is optional in the form definition file (.xsf) of a form template deployed as a browser-compatible form to a server running InfoPath Forms Services.	String
queryKey	`xsd:string`	Optional	Specifies a string value generated by InfoPath and maintained in the manifest.xsf file that dictates whether the data cached in the form template at design time is applicable for the current state of the data connection. Note This element or attribute is optional in the form definition file (.xsf) of a form template deployed as a browser-compatible form to a server running InfoPath Forms Services.	String
queryFile	`xsd:string`	Optional	Specifies the name of an XML file included in the form template that contains the data cached at design time if the user selected the Store a copy of the data in the form template check box in the Data Connection Wizard. The data cached in the XML file will be used by InfoPath if the value generated for queryKey at run time matches the value stored at design time. Note This element or attribute is optional in the form definition file (.xsf) of a form template deployed as a browser-compatible form to a server running InfoPath Forms Services.	String

Note
InfoPath uses the queryKey value for all data connections that cache the query data in the form template, not only parameterized secondary data connections. This is because the data connection properties can be changed by business logic code at run time. For example, a secondary ADO query connection's connection string can changed at run time, so the queryKey value is necessary to validate the applicability of the cached data. Similarly, the URL for a Web service or XML document query data connection can be changed from code at run time.

InfoPath uses the queryKey value for all data connections that cache the query data in the form template, not only parameterized secondary data connections. This is because the data connection properties can be changed by business logic code at run time. For example, a secondary ADO query connection's connection string can changed at run time, so the queryKey value is necessary to validate the applicability of the cached data. Similarly, the URL for a Web service or XML document query data connection can be changed from code at run time.

Definition

  
<xsd:element name="webServiceAdapterExtension">
   <xsd:complexType>
      <xsd:sequence>
         <xsd:element ref="xsf2:connectoid" minOccurs="0" />
         <xsd:element ref="xsf2:relativeQuery" minOccurs="0" />
      </xsd:sequence>
      <xsd:attribute name="trackDataSetChanges" type="xsf:xdYesNo" use="optional" default="no" />
      <xsd:attribute name="ref" type="xsf:xdTitle" use="required" />
      <xsd:attributeGroup ref="xsf2:queryKeyFile" />
   </xsd:complexType>
</xsd:element>

Remarks

InfoPath adds the webServiceAdapterExtension element to the manifest.xsf file when a Web service data connection is defined using one or more of the following features:

The Store a copy of the data in the form template check box is selected in the Data Connection Wizard.
The data connection settings are specified from from a data connection file (.udcx) in a data conection library.
The DataSet change tracking options are set to settings other than the default option supported in Office InfoPath 2003.
The Web service query or submit operation specifies that InfoPath should look for the data connection file (.udcx) relative to the current site collection.

Note This element or attribute is optional in the form definition file (.xsf) of a form template deployed as a browser-compatible form to a server running InfoPath Forms Services.

Example

The following is an example of the webServiceAdapterExtension element.

  
<xsf2:webServiceAdapterExtension ref="List_of_Areas" trackDataSetChanges="no">
   <xsf2:connectoid connectionLinkType="relative" source="InfoPath Data Connections/List_of_Areas.udcx" siteCollection="http://www.example.com/sites/infopath/" name="Area list"></xsf2:connectoid>
</xsf2:webServiceAdapterExtension>