Troubleshooting Consumed Web Services

An orchestration cannot consume some Web services.

Debugging consumed Web services

If you get a generic XLANGSOAPException in the Event Viewer when consuming a Web service, you can get details on the exception using the BizTalk Server Health and Activity Tracking (HAT) tool.

User Action

Open HAT and view the context properties for the suspended message. The AckDescription field of the context property collection provides details about the error message.

Updating Web references

When you change your target Web service, your code may attempt to use a non-existing Web method, Web service, or an outdated namespace.

User Action

Update your Web references when you change your target Web service. For more information about adding Web references, see Adding Web References.

Naming conflicts

BizTalk Server requires that your BizTalk project have a different name from the consumed Web service.

User Action

If you encounter a naming conflict, rename your BizTalk project and rebuild your solution.

Web service times out before the orchestration completes

Request-response (two-way) Web services may time out before a called orchestration is able to complete. This may occur when the orchestration is a long running process or when a call to a transport or an adapter takes longer than the time-out settings on the Web client.

User Action

To prevent a time-out, ensure that the orchestration completes the transaction before the settings on the Web client time out or increase the time-out period for the Web client by setting the time-out value to a greater than expected completion time of the orchestration.

You can increase the response time by setting the SOAP.ClientConnectionTimeOut context property for the message. You specify the time-out value in milliseconds.

Imported Web services have different root element names

When you import a Web service into BizTalk Server, the root element of the Reference.xsd schema is not the same root element that the Web service class uses. This issue occurs when consumed Web services use the XmlRoot attribute to change the root element name of a class.

Although the root element is different, you can successfully consume (call) the Web service. However, modifying the root element in the Reference.xsd schema breaks the Business Process Execution Language (BPEL) import and export actions since the root element of the schema must match the XmlRoot attribute in the Web service class. For more information about creating an instance of a SOAP header root element, see "Using BizTalk Editor to create an instance of a SOAP header root element" in Using SOAP Headers in Orchestrations.

User Action

You should modify the Web service so that it does not use XmlRoot attributes on class definitions.

Errors when trying to consume a Web service

If the Web server is not running (stopped) when a published Web service is consumed (called), the Web client may encounter the following error:

System.Net.WebException. 
The underlying connection was closed: Unable to connect to the remote server.

User Action

Restart the Web server.

See Also

Consuming Web Services