Configure a One-Way Send Port for the CData BizTalk Adapter for SingleStore

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SingleStore BizTalk Adapter

Powerful BizTalk Adapters that allow you to easily connect BizTalk Server with live SingleStore data through standard orchestrations.

Use the SingleStore Adapters to synchronize with SingleStore. Perfect for data synchronization, local back-ups, workflow automation, and more!



Use the adapter for SingleStore with a one-way send port to execute updategrams and data manipulation SQL in BizTalk.

This section provides step-by-step instructions for creating, configuring, and testing a static one-way send port using the CData BizTalk Adapter for SingleStore. You can use static one-way send ports to execute updategrams, SQL commands, and stored procedures. Send ports are useful for operations that modify SingleStore data but do not have any response data. Typically, this would be DELETE or UPDATE SQL commands or updategrams, and occasionally stored procedure operations.

If you want to trigger actions that will return a response, such as executing SELECT commands or retrieving the Id of a record that you have created, use a solicit-response send port.

Create and Configure the One-Way Send Port

Create a static one-way send port and configure it to use the SingleStore adapter as its transport type.

  1. If you have not already done so, open your BizTalk application in the BizTalk Administration Console.
  2. In the node for your BizTalk application, right-click Send Ports and select New -> Static One-Way Send Port. The send port properties dialog is displayed.
  3. In the Name menu, enter a name for the send port.
  4. In the Type menu, select CData.SingleStore.
  5. In the Send Pipeline menu, select the default option, PassThruTransmit.

Configure the Adapter

Define the command that the adapter will execute in the Transport Properties dialog.

  1. In the send port properties, click the Configure button. The CData.SingleStore Transport Properties dialog is displayed.
  2. In the CommandType property, select the command type you want.
  3. If you want to execute an SQL command, enter the command in the SQL Command box.
Refer to the "Adapter Configuration" chapter in the help documentation for a description of the various properties and their functions.

Configure the Connection to SingleStore

Configure credentials and other properties required to connect to SingleStore in the Connection String Options dialog.

  1. In the send port properties dialog, click Configure. The adapter properties dialog is displayed.
  2. Click the button in the Connection String property.
  3. Click the box in the Connection String property. The Connection String Options dialog is displayed.
  4. Enter connection properties. Below is a typical connection string: User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;

    The following connection properties are required in order to connect to data.

    • Server: The host name or IP of the server hosting the SingleStore database.
    • Port: The port of the server hosting the SingleStore database.
    • Database (Optional): The default database to connect to when connecting to the SingleStore Server. If this is not set, tables from all databases will be returned.

    Connect Using Standard Authentication

    To authenticate using standard authentication, set the following:

    • User: The user which will be used to authenticate with the SingleStore server.
    • Password: The password which will be used to authenticate with the SingleStore server.

    Connect Using Integrated Security

    As an alternative to providing the standard username and password, you can set IntegratedSecurity to True to authenticate trusted users to the server via Windows Authentication.

    Connect Using SSL Authentication

    You can leverage SSL authentication to connect to SingleStore data via a secure session. Configure the following connection properties to connect to data:

    • SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
    • SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
    • SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
    • SSLClientCertType: The certificate type of the client store.
    • SSLServerCert: The certificate to be accepted from the server.

    Connect Using SSH Authentication

    Using SSH, you can securely login to a remote machine. To access SingleStore data via SSH, configure the following connection properties:

    • SSHClientCert: Set this to the name of the certificate store for the client certificate.
    • SSHClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
    • SSHClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
    • SSHClientCertType: The certificate type of the client store.
    • SSHPassword: The password that you use to authenticate with the SSH server.
    • SSHPort: The port used for SSH operations.
    • SSHServer: The SSH authentication server you are trying to authenticate against.
    • SSHServerFingerPrint: The SSH Server fingerprint used for verification of the host you are connecting to.
    • SSHUser: Set this to the username that you use to authenticate with the SSH server.

  5. Click Test Connection to verify the values and test connectivity.
Refer to the "Connection String Options" chapter in the help documentation for a description of the various properties and their functions.

After you connect successfully and define the command the adapter will execute, the send port is ready for use. See the following section for an example of using a one-way send port in a simple application. The application reads updategram commands contained in a file and uses a send port to execute the command.

In the example, filters are used to move the messages that contain the updategram from the receive location to the send port. See the following section for more information on filters.

Create Filters to Route BizTalk Messages Through an Application

To associate a send port with the messages you want, create a filter rule in the Filters section of the properties for that send port. Messages matching the criteria will be routed to the send port. See the following example to filter on a receive location.

Example: Execute Updategrams with a One-Way Send Port

This section shows how to use a one-way send port in a simple application. The application reads updategram commands contained in a file and executes the commands:

  1. A one-way receive location picks up the XML document containing the updategram.
  2. The receive location creates a BizTalk message containing the results of the command.
  3. A one-way send port filters on the URI of the receive location. The document is routed to the one-way send port.
  4. The send port executes the updategram command.

As in the preceding example, the followings steps show how to set up a receive location to read updategrams from a file and use a send port to execute the commands:

  1. Create and configure a static one-way receive location. Use the File transport type. You can follow the same procedure to create and configure a receive location for the CData BizTalk Adapter for SingleStore.
  2. Create a static one-way send port.
  3. In the send port properties, click Filters.
  4. In an empty property, set the following values:
    Property
    Select BTS.InboundTransportLocation from the menu.
    Value
    Enter the URI of the newly created one-way receive location.