Ready to get started?

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



Use the adapter for Microsoft Planner 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 Microsoft Planner. 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.MicrosoftPlanner;.
  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 Microsoft Planner

Configure credentials and other properties required to connect to Microsoft Planner 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: OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH

    You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
    • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

    When you connect the Driver opens the MS Planner OAuth endpoint in your default browser. Log in and grant permissions to the Driver. The Driver then completes the OAuth process.

    1. Extracts the access token from the callback URL and authenticates requests.
    2. Obtains a new access token when the old one expires.
    3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

  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 Microsoft Planner walks through the steps to create a simple application that uses a solicit-response send port to execute an insert updategram to Microsoft Planner.