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

This section provides step-by-step instructions for creating, configuring, and testing a static one-way send port using the CData BizTalk Adapter for Gmail. You can use static one-way send ports to execute updategrams, SQL commands, and stored procedures. Send ports are useful for operations that modify Gmail 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 Gmail 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.Gmail.
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.Gmail 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.

Configure the Connection to Gmail

Configure credentials and other properties required to connect to Gmail 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=username;Password=password;

   There are two ways to authenticate to Gmail. Before selecting one, first ensure that you have enabled IMAP access in your Gmail account settings. See the "Connecting to Gmail" section under "Getting Started" in the installed documentation for a guide.

   The User and Password properties, under the Authentication section, can be set to valid Gmail user credentials.

   Alternatively, instead of providing the Password, you can use the OAuth authentication standard. To access Google APIs on behalf on individual users, you can use the embedded credentials or you can register your own OAuth app.

   OAuth also enables you to use a service account to connect on behalf of users in a Google Apps domain. To authenticate with a service account, you will need to register an application to obtain the OAuth JWT values.

   In addition to the OAuth values, you will need to provide the User. See the "Getting Started" chapter in the help documentation for a guide to using OAuth.

5. Click Test Connection to verify the values and test connectivity.

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 Gmail.
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.