Execute Stored Procedures to SFTP in BizTalk

Stored procedures implement SFTP actions that cannot be represented as SELECT, INSERT, UPDATE, and DELETE statements. This article shows how to generate a schema for a stored procedure. You can use the schema to execute the stored procedure from a send port.

Add the Adapter to Your Project

Use the Add Adapter wizard to add the adapter to a BizTalk Server project in Visual Studio. The adapter will return metadata about the inputs of the stored procedure and its results. This metadata is needed to create the schema.

1. Right-click on the project in the Solution Explorer and click Add -> Add Generated Items.
2. Select Add Adapter Metadata in the resulting dialog box.
3. In the resulting Add Adapter wizard, select the adapter from the list.
4. In the Port menu, leave the selection blank. Or, select a receive location or send port that has been configured to use the SFTP Adapter.

5. On the Connection String page, enter authentication credentials and other connection properties if they were not already configured in the send port or the receive location.

   Below is a typical connection string:

   RemoteHost=MyFTPServer;

   SFTP can be used to transfer files to and from SFTP servers using the SFTP Protocol. To connect, specify the RemoteHost;. service uses the User and Password and public key authentication (SSHClientCert). Choose an SSHAuthMode and specify connection values based on your selection.

   Set the following connection properties to control the relational view of the file system:

   • RemotePath: Set this to the current working directory.
   • TableDepth: Set this to control the depth of subfolders to report as views.
   • FileRetrievalDepth: Set this to retrieve files recursively and list them in the Root table.
   Stored Procedures are available to download files, upload files, and send protocol commands. See gdatamodel for more on using SQL to interact with the server.

Generate the Schema

After you enter connection properties in the Add Adapter wizard, the Schema wizard is displayed.

1. On the next page, Schema Information, select the Send Port that you have configured to use the SFTP Adapter.
2. If you have configured the CData SFTP Adapter in a solicit-response send port, disable the One-Way option.
3. In the Command Type menu, select Stored Procedure.
4. Select the stored procedure from the menu and enter the values for the input parameters.
5. 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.