Configure a Solicit-Response Send Port for the CData BizTalk Adapter for Gmail



Use the adapter for Gmail with a solicit-response 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 solicit-response send port using the CData BizTalk Adapter for Gmail. You can use a static solicit-response send port to execute commands and access the results in BizTalk. You can use send ports to execute updategram commands, SQL commands, and stored procedure operations.

Create and Configure the Send Port

Create a static solicit-response send port and configure it to use the 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 Solicit-Response Send Port. The Send Port Properties dialog is displayed.
  3. In the Send Port properties, enter a name for the receive port.
  4. In the Transport Type menu, select CData.Gmail;.
  5. In the Send pipeline menu, select the default option, PassThruTransmit.
  6. In the Receive pipeline menu, select the default option, PassThruReceive.

Configure the Adapter

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

  1. In the send port properties, click the Configure button. The Adapter 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 Gmail

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

  1. In the send port properties, click Configure. The adapter properties dialog is displayed.
  2. Click the button in the Connection String property. The Connection String Options dialog is displayed.
  3. Enter the 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.

  4. 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. The updategram tutorial for the adapter for Gmail walks through the steps to create a simple application that uses a solicit-response send port to execute an insert updategram to Gmail.

Ready to get started?

Learn more:

Gmail Connectivity Solutions