Configure a One-Way Send Port for the CData BizTalk Adapter for SAP Ariba Source

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

Configure credentials and other properties required to connect to SAP Ariba Source 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: API=SupplierDataAPIWithPagination-V4;APIKey=wWVLn7WTAXrIRMAzZ6VnuEj7Ekot5jnU;Environment=SANDBOX;Realm=testRealm;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH

   In order to connect with SAP Ariba Source, set the following:

   • API: Specify which API you would like the provider to retrieve SAP Ariba data from. Select the Supplier, Sourcing Project Management, or Contract API based on your business role (possible values are SupplierDataAPIWithPaginationV4, SourcingProjectManagementAPIV2, or ContractAPIV1).
   • DataCenter: The data center where your account's data is hosted.
   • Realm: The name of the site you want to access.
   • Environment: Indicate whether you are connecting to a test or production environment (possible values are TEST or PRODUCTION).

   If you are connecting to the Supplier Data API or the Contract API, additionally set the following:

   • User: Id of the user on whose behalf API calls are invoked.
   • PasswordAdapter: The password associated with the authenticating User.

   If you're connecting to the Supplier API, set ProjectId to the Id of the sourcing project you want to retrieve data from.

   Authenticating with OAuth

   After setting connection properties, you need to configure OAuth connectivity to authenticate.

   • Set AuthScheme to OAuthClient.
   • Register an application with the service to obtain the APIKey, OAuthClientId and OAuthClientSecret.

     For more information on creating an OAuth application, refer to the Help documentation.

   Automatic OAuth

   After setting the following, you are ready to connect:

   APIKey: The Application key in your app settings. OAuthClientId: The OAuth Client Id in your app settings. OAuthClientSecret: The OAuth Secret in your app settings.

   When you connect, the provider automatically completes the OAuth process:

   1. The provider obtains an access token from SAP Ariba and uses it to request data.
   2. The provider refreshes the access token automatically when it expires.
   3. The OAuth values are saved in memory relative to the location specified in OAuthSettingsLocation.

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 SAP Ariba Source.
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.