How to Generate SQL Command Schemas for the CData BizTalk Adapter for FedEx

The CData BizTalk Adapter makes it easy to process FedEx data in BizTalk by returning the data as XML. You can use this data in a BizTalk orchestration by creating an XML schema file for the table you want to access in BizTalk.

This article will show how to generate a schema to process FedEx 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 FedEx to execute SQL commands to FedEx.

Add the Adapter for FedEx 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: Server='https://gatewaybeta.fedex.com:443/xml';DeveloperKey='alsdkfjpqoewiru';Password='zxczxqqtyiuowkdlkn';AccountNumber='110371337';MeterNumber='240134349'; PrintLabelLocation='C:\users\username\documents\mylabels';CacheProvider='org.sqlite.JDBC';CacheConnection='jdbc:sqlite:C:\users\username\documents\fedexcache.db';

    There are five pieces of information needed in order to authenticate its actions with the FedEx service. This information is below.

    • Server: This controls the URL where the requests should be sent. Common testing options for this are: "https://gatewaybeta.fedex.com:443/xml", "https://wsbeta.fedex.com:443/xml", "https://gatewaybeta.fedex.com:443/web-service", and "https://wsbeta.fedex.com:443/web-service"
    • DeveloperKey: This is the identifier part of the authentication key for the sender's identity. This value will be provided to you by FedEx after registration.
    • Password: This is the secret part of the authentication key for the sender's identity. This value will be provided to you by FedEx after registration.
    • AccountNumber: This valid 9-digit FedEx account number is used for logging into the FedEx server.
    • MeterNumber: This value is used for submitting requests to FedEx. This value will be provided to you by FedEx after registration.
    • PrintLabelLocation: This property is required if one intends to use the GenerateLabels or GenerateReturnLabels stored procedures. This should be set to the folder location where generated labels should be stored.

    The Cache Database

    Many of the useful tasks available from FedEx require a lot of data. To ensure this data is easy to input and recall later, utilizes a cache database to make these requests. You must set the cache connection properties:

    • CacheProvider: The specific database you are using to cache with. For example, org.sqlite.JDBC.
    • CacheConnection: The connection string to be passed to the cache provider. For example, jdbc:sqlite:C:\users\username\documents\fedexcache.db

  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 FirstName, Phone FROM Senders WHERE SenderID = ab26f704-5edf-4a9f-9e4c-25

  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.