Troubleshoot Installation Issues with the SQl adapter
Important
The SQL adapter is available as part of the BizTalk Adapter Pack as well as a separate adapter. If you are accessing this topic to know about installation issues with the SQL adapter that is separate from the BizTalk Adapter Pack, all references to the BizTalk Adapter Pack Setup must be interpreted as SQL adapter Setup.
Installation of the Microsoft BizTalk Adapter Pack copies the product binaries on the computer and registers the bindings for each adapter. This section discusses using troubleshooting techniques to resolve installation errors.
Logging Messages for Setup Actions
The BizTalk Adapter Pack setup program performs the standard task of installing the BizTalk Adapter Pack. Additionally, the setup also performs certain custom actions such as registering the adapter bindings. You can log messages for both the standard as well as custom actions that the setup performs.
The BizTalk Adapter Pack setup installs the adapter-specific files using an MSI. Therefore, the logging for the setup is the standard MSI logging.
All logs for the custom actions that the setup program performs are available at %TEMP%\adaptersetup.log. If the tracing to the log file fails, the traces are also available in the event log.
Known Issues
The following are the most common errors you might encounter when installing the BizTalk Adapter Pack, along with their probable cause and resolution.
Setup fails to register adapter bindings
Problem
The Microsoft BizTalk Adapter Pack Setup Wizard fails to register the adapter bindings, but proceeds with the adapter installation.
Cause
This might result due to problems with Windows Communication Foundation (WCF) installation, Microsoft Windows Communication Foundation (WCF) Line of Business (LOB) Adapter SDK installation, or the machine.config file being corrupt. The adapter bindings are written to the machine.config file.
Resolution
You should manually register the SQL adapter binding.
To register the adapter binding
Navigate to the machine.config file on the computer. For example, on a 32-bit platform, the machine.config is available under <system drive>:\WINDOWS\Microsoft.NET\Framework\<version>\CONFIG.
In this path, <version> is the version of the .NET Framework.
Open the file by using a text editor.
To register the SQL adapter binding:
Search for the element "system.serviceModel" and add the following under it:
<client> <endpoint binding="sqlBinding" contract="IMetadataExchange" name="mssql" /> </client>Search for the element "bindingElementExtensions" under system.serviceModel\extensions.
Look for the missing SQL adapter binding. Add the following section under the "bindingElementExtensions" node.
For SQL adapter, add:
<add name="sqlAdapter" type="Microsoft.Adapters.Sql.SqlAdapterBindingElementExtensionElement,Microsoft.Adapters.Sql, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />Search for the element "bindingExtensions" under system.serviceModel\extensions.
Look for the missing SQL adapter binding. Add the following section under the "bindingExtensions" node.
For SQL adapter, add:
<add name="sqlBinding" type="Microsoft.Adapters.Sql.SqlAdapterBindingCollectionElement,Microsoft.Adapters.Sql, Version=<version>, Culture=neutral, PublicKeyToken=<public key>" />
Note
For information about how to determine the public key and the version, see Determining the Public Key and Version.
Save and close the machine.config file.
Determining the Public Key and Version
Perform the following steps to determine the public key for SQL adapter.
To determine the public key
Navigate to the Windows directory, typically C:\WINDOWS\assembly.
Right-click the DLL for which you want the public key and the version, and then select Properties. The following table lists the name of the DLL for SQL adapter.
Adapter Name of the DLL SQL adapter Microsoft.Adapters.Sql On the General tab, the value against the Public Key Token label specifies the public key for the DLL. Similarly, value against the Version label specifies the version number for the DLL.
Copy the public key, and then click Cancel.
Error while using the Consume Adapter Service add-in or Add Adapter Service Reference plug-in on a 64-bit installation
Problem
Using the Add Adapter Service Reference Visual Studio Plug-in or the Consume Adapter Service BizTalk Project Add-in from Visual Studio on a 64-bit computer running 64-bit version of the BizTalk Adapter Pack results in the following error:
No valid adapters are installed on this machine
Cause
The SQL adapter is a WCF custom binding, which is registered under System.ServiceModel in the machine.config file. A 64-bit platform has two machine.config files, one used by the 32-bit applications and the other used by the 64-bit applications. So, when you install the 64-bit version of the BizTalk Adapter Pack, the setup wizard registers the bindings in the 64-bit version of the machine.config file. However, Visual Studio runs as a 32-bit process and hence when you launch the Consume Adapter Service Add-in from Visual Studio, the plug-in checks for the bindings in the 32-bit version of the machine.config file and fails giving an error.
Resolution
Install both the 32-bit and 64-bit versions of the BizTalk Adapter Pack on a 64-bit WCF LOB Adapter SDK installation.
Important
You must only have a 64-bit WCF LOB Adapter SDK installation. Side-by-side installation of 32-bit and 64-bit WCF LOB Adapter SDK on a single computer is not supported.
Invalid binding error while configuring SQL adapter ports in BizTalk Server Administration Console on a 64-bit installation
Problem
When you try to configure a port for the adapter in BizTalk Server Administration console, you get the following error:
"Unable to create binding configuration element for editing. Check the values of the BindingType and BindingConfiguration properties.
(Microsoft.Biztalk.Adapter.Wcf.Converters.CreateBindingException) Unable to get binding type for binding extension "sqlBinding".
Verify the binding extension is registered in machine.config."
Cause
The SQL adapter is a WCF custom binding, which is registered under System.ServiceModel in the machine.config file. A 64-bit platform has two machine.config files, one used by the 32-bit applications and the other used by the 64-bit applications. So, when you install the 64-bit version of the BizTalk Adapter Pack, the setup wizard registers the bindings in the 64-bit version of the machine.config file. However, BizTalk Server Administration console runs as a 32-bit process and hence when you configure a port for the adapter, it checks for the bindings in the 32-bit version of the machine.config file and fails giving an error.
Resolution
Install both the 32-bit and 64-bit versions of the BizTalk Adapter Pack on a 64-bit WCF LOB Adapter SDK installation.
Important
You must only have a 64-bit WCF LOB Adapter SDK installation. Side-by-side installation of 32-bit and 64-bit WCF LOB Adapter SDK on a single computer is not supported.
See Also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for