How to Generate SQL Command Schemas for the CData BizTalk Adapter for Avalara AvaTax

This article will show how to generate a schema to process Avalara AvaTax data retrieved using the CData BizTalk Adapter. You will generate a schema for a SELECT command.

This guide shows how to use the CData BizTalk Adapter for Avalara AvaTax to execute SQL commands to Avalara AvaTax.

Add the Adapter for Avalara AvaTax to Your Project

Follow the steps below to add the adapter to a BizTalk Server project.

1. If you have not already done so, create a new BizTalk Server project in Visual Studio.
2. Right-click on the project in the Solution Explorer and click Add -> Add Generated Items.
3. Select Add Adapter Metadata in the resulting dialog box.
4. In the resulting Add Adapter wizard, select the adapter from the list.
5. In the Port menu, leave the selection blank. You can also select a receive location or send port that has the adapter configured as its transport type.

Generate a Schema for an SQL Command

After you select the adapter in the Add Adapter wizard, the Schema wizard is displayed. Follow the steps below to configure connection properties and retrieve the metadata for the results of the command.

1. In the Connection String page, enter authentication credentials and other connection properties, if you did not select an adapter that you have already configured in your BizTalk application. Below is a typical connection string: User=MyUser;Password=MyPassword;

   The primary method for performing basic authentication is to provide your login credentials, as follows:

   • User: Set this to your username.
   • Password: Set this to your password.

   Optionally, if you are making use of a sandbox environment, set the following:

   • UseSandbox: Set this to true if you are authenticating with a sandbox account.

   Authenticating Using Account Number and License Key

   Alternatively, you can authenticate using your account number and license key. Connect to data using the following:

   • AccountId: Set this to your Account Id. The Account Id is listed in the upper right hand corner of the admin console.
   • LicenseKey: Set this to your Avalara Avatax license key. You can generate a license key by logging into Avalara Avatax as an account administrator and navigating to Settings -> Reset License Key.

2. In the General Options section on the next page, Schema Information, select Send Port or Receive Location, depending on the adapter configuration.
3. If you want to generate the schema for the entire result set, select the Single Message option in the Message Mode menu. If you want to generate one schema for each row in the result set, select the Message Per Row option and confirm that the root element of the message is 'row'.
4. In the Command Type menu, select SQL Command.

5. In the SQL Command Text box on the Statement Information page, enter an SQL command. (If you have configured a receive location or send port, the SQL command you configured is entered in the box.) This example uses the query below:

   SELECT Id, TotalTax FROM Transactions WHERE Code = '051349'

6. Confirm the settings in the summary displayed by the wizard and click Finish to generate the schema.xsd file.

Processing Schemas

To use schemas in a simple BizTalk application, see the tutorial.