Step 4: Create and Configure the LOB Target
Updated: October 22, 2014
To connect to an on-premises LOB application, create LOB Relays and LOB Targets in your BizTalk Services application. Development and Runtime Architecture: BizTalk Adapter Service describes how LOB Relays and LOB Targets manage connectivity with an on-premises LOB application.
This section provides instruction on how to create a SQL Server table where the sales order data is inserted, how to create a LOB Relay and target for the Insert operation on the SQL Server table, and how to generate the schema for the Insert operation on the SQL Server table. Specifically:
Create the SQL Server table
Use these steps to create the OrderDetails table in SQL Server in which the sales order data is inserted. The script is also available in the FTP_EAI_Tutorial sample at http://go.microsoft.com/fwlink/?LinkId=247973. This script assumes that you already have an Orders database created.
Open SQL Server Management Studio.
Run the following script to create the OrderDetails table:
USE [Orders] GO /****** Object: Table [dbo].[OrderDetails] Script Date: 04/02/2012 20:35:57 ******/ IF EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[OrderDetails]') AND type in (N'U')) DROP TABLE [dbo].[OrderDetails] GO USE [Orders] GO /****** Object: Table [dbo].[OrderDetails] Script Date: 04/02/2012 20:35:57 ******/ SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO SET ANSI_PADDING ON GO CREATE TABLE [dbo].[OrderDetails]( [Id] [int] IDENTITY(1,1) NOT NULL, [OrderId] [varchar] (200), [QuantityOrdered] [int], [TotalAmount] [int] PRIMARY KEY CLUSTERED ( [Id] ASC )WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY] ) ON [PRIMARY] GO SET ANSI_PADDING OFF GO
Confirm the table is created in the target database.
Create a SQL Server LOBTarget
Create the LOB Relay and the LOB Target for the Insert operation on the OrderDetails table:
In the BizTalk Service project, from Server Explorer, right-click BizTalk Adapter Services, and then click Add BizTalk Adapter Service. This prompts for the BizTalk Adapter Service Management URL. Specify the management URL. The BizTalk Adapter Service Management URL is path to the ManagementService.svc WCF service hosted in IIS. Runtime Components: BizTalk Adapter Service provides more information on the BizTalk Adapter Service components within IIS.
If the BizTalk Adapter Service Runtime is installed locally with the default settings, enter: http://localhost:8080/BAService/ManagementService.svc/
If the BizTalk Adapter Service Runtime is installed remotely with the default settings, enter: http://ServerName:8080/BAService/ManagementService.svc/
- If the BizTalk Adapter Service Runtime is installed locally with the default settings, enter: http://localhost:8080/BAService/ManagementService.svc/
Expand the newly added server, expand LOB Types, right-click SQL, and select Add SQL Target. The Add a Target wizard starts.
In Before You Begin, select Next.
On Connection Parameters, enter the SQL Server details and the credentials to use for the connection. Select Next.
Note You can use the Advanced button to build the SQL Server connection URI and also specify the binding properties for the connection.The SQL Server Connection URI provides additional information about how to build the URI. For binding properties, see Working with BizTalk Adapter for SQL Server Binding Properties. For this tutorial, leave the default setting as-is for the binding properties.
In Operations, expand Tables, expand OrderDetails, select Insert, and then select the right arrow. The Insert operation is now listed under the Selected operations section.
In Runtime Security, select Fixed Windows credential, specify the credentials, and then click Next.
This security type determines how the client message is authenticated with the LOB Target. Options include:
Select this option if you are using a username and password created locally on the LOB system.
Fixed Windows credential
Select this option to use a Windows domain account.
Custom SOAP Header
Select this option if you create a custom SOAP header to include the username and password.
Select this option if you are including the logon credentials in the WS-Security header of the message.
In Deployment, choose an existing LOB Relay or create a new LOB Relay. To create a new LOB Relay:
Tip A single LOB Relay can be used with multiple LOB Targets. There are restrictions based on the security model. As a best practice, group the same security method in one LOB Relay. For example, use the same LOB Relay to host the LOB Targets that use Message Credential or Fixed Windows security type.
Required. Enter your Service Bus namespace because the LOB relay will be created in the Service Bus. The namespace name is available in the Azure Management Portal after you sign-in.
For example, if myNamespace is the namespace, this will update the Management address to be:
Required. Specify the Service Bus Issuer Name.
Required. Specify the Service Bus Issuer Secret key..
Required. Enter the desired name of the relay path. For this tutorial, set this property to SQLLOBRelay.
Required. Enter a sub-path to make this target unique. For example, you can enter OrderDetails.
Target runtime URL
This is automatically populated with the namespace name, relay path and target sub-path specified. If using the examples above, it will be populated with something like:
In Summary, review your values. Select Create.
When the wizard completes, select Finish. The following activities occur in the background:
The LOB Target is created in Server Explorer. It can be disabled, started and deleted. Its configuration can also be exported.
The LOB Target is created as an application in IIS. This application uses the Runtime for this specific LOB Target. Runtime Components: BizTalk Adapter Service describes the IIS components.
To use the LOB Target:
Set the Runtime Security property for the relay endpoint.
Right-click the relay endpoint in Server Explorer and select Properties.
In the Properties grid, click the ellipsis (…) against the Runtime Security property.
In the Edit Security dialog box, select Fixed Windows Credentials and specify username and password to connect to the SQL Server.
- Right-click the relay endpoint in Server Explorer and select Properties.
Drag and drop the LOB Target onto the design surface. Note the Entity Name property of the LOB Target. The default value is Relay-Path_target-sub-path. If using the examples above, it will be sqllobrelay_orderdetails.
Open the .config file for the LOB target, which typically has the naming convention as YourRelayPath_target-sub-path.config. Specify the Service Bus issuer name and issuer secret, as shown below:
<tokenProvider> <sharedSecret issuerName="owner" issuerSecret="issuer_secret" /> </tokenProvider>
Generate the Schema
Generate the schema for the Insert operation on the OrderDetails table.
In the BizTalk Service project, in the Server Explorer, right click the LOB Target you just created, and then select Add schemas to FTP_EAI_Tutorial. The Schema Generation dialog opens.
Set the file name prefix to FTP_EAI_Tutorial_. Leave the folder name to its default value of LOB Schemas.
Select credential type as Windows to use Windows authentication to connect to SQL Server, and then click OK.
The schemas are added to the FTP_EAI_Tutorial project under the LOB Schemas folder.