Transports and Interfaces: Siebel Enterprise Application Integration > Interfacing with Microsoft BizTalk Server > Connecting to BizTalk Using COM and AIC >
Siebel AIC Inbound Transport
This section describes how to set up and use the AIC Inbound Transport to receive messages from BizTalk.
Setting up the AIC Inbound Transport
AIC can be run either on the Siebel Server machine or on the BizTalk Server machine. Generally, AIC is run on the BizTalk Server machine.
NOTE: AIC (Application Integration Components) and ActiveX Data Controls must both be installed on the same machine, regardless of your configuration setup.
This section explains how to set up the AIC Inbound Transport on either BizTalk Server with IIS 5.0 installed or a Siebel Server machine and covers these topic areas:
Setting Up AIC Inbound Transport to Run Locally on BizTalk Server
This section explains how to set up the required components for running the AIC Inbound Transport on the BizTalk Server machine.
To install Siebel ActiveX Data Controls and AIC on the BizTalk Server machine
- On the BizTalk machine, insert the Siebel Enterprise Server Installation CD and choose Custom Install.
- Deselect other options so that only the EAI Connectors are installed.
- Follow online prompts to complete the remaining pages and click Finish to install the Siebel EAI ActiveX Data Controls for BizTalk on the BizTalk Server machine.
To register AIC as a COM+ Server Application on the BizTalk Server machine
- From the Start menu, select Programs > Administrative Tools > Component Services.
- In the tree pane, click Component Services, and expand Computers. Under Computers, expand My Computer, and then click on COM+ Applications.
- On the Action menu, click New > Application.
- On the Welcome to COM+ Application Install Wizard dialog box, click Next.
- On the next page, select Create an Empty Application.
- Enter the name for the new application to be created, such as Siebel BizTalk Interface for AIC Transport or Siebel BizTalk HTTP Adapter for the HTTP Inbound Transport.Select the Activation Type of "Server application" and click Next.
- On the next screen, select the Application Identity of "Interactive user - the current logged on user" and click Next and then Finish.
You should now have a new COM+ application (which you named in Step 5), as shown in the following sample figure.
- Expand this newly created COM+ Server Application by double-clicking on it.
You see folders appear where the COM+ applications were.
- Click the Components folder and choose Action > New > Component.
The Welcome to COM Component Install Wizard appears.
- On the Welcome to COM Component Install Wizard, click Next.
- Select Install new component or components and click Next.
- On the next page, click Add.
- Browse to the
SIEBSRVR_ROOT\eaiconn\bts\aic directory and select the AIC component, sscaeiba.dll.
You should see BizTalk.SiebelBizTalkAIC component registered and you should be able to see the AIC interfaces and methods.
Or, for the HTTP Inbound Transport, browse to the c:\AIC directory (the directory where you originally copied your .dll from the Siebel Server machine) and select the AIC component, sscaeibh.dll.
You should see the Siebel.BizTalkHTTPAIC component registered and you should be able to see the AIC interfaces and methods.
NOTE: COM+ application functionality is available only with Windows 2000.
Setting Up the AIC Inbound Transport to Run Remotely on the Siebel Server
This section explains how to set up the required components for running the AIC Inbound Transport remotely on the Siebel Server machine.
To copy BizTalk Server DLL and Type Library files to the Siebel Server
- Copy dependency shared DLLs stored in "%Program Files%\Common Files\Microsoft Shared\Enterprise Servers\Commerce" from BizTalk (Commerce server shared DLL) to the Siebel Server machine:
- Open a DOS command prompt window. On the Siebel Server machine:
To register AIC as a COM+ package remote communication
- Register AIC as a COM+ Server Application on the Siebel Server machine.
The steps to register AIC are the same as described above in the previous section, To register AIC as a COM+ Server Application on the BizTalk Server machine.
NOTE: Siebel AIC (Application Integration Components) and ADC (ActiveX Data Controls) are installed as a part of the Siebel Server or the EAI Connectors installation.
To create a COM+ package remote communication on the Siebel machine
Here you create a COM+ package for the remote communication on the Siebel machine and run on the BizTalk Server machine as Application Proxy.
- On the Siebel machine, go to the Start menu. Select Programs > Administrative Tools > Component Services.
- In the tree pane, click Component Services, and expand Computers. Under Computers, expand My Computer, and then expand COM+ Applications. Click Siebel BizTalk Adapter (the COM+ Application you created previously—you may have given it a different name). A sample tree pane is shown in the following illustration.
- On the Action menu, click Export.
- On the Welcome to COM Application Export Wizard dialog, click Next.
- Enter the name of the export installation package to be created.
- In the Export As area, select the Application proxy radio button and click Next.
- Click Next to finish the wizard. You should see a Thank you page. Click Finish.
You should now have two files, named as you specified in Step 5. The files will have two extensions: .MSI and .cab.
- Copy these files to the BizTalk Server machine.
- Run the .MSI file to install the remote client for the Siebel AIC that is on the BizTalk Server machine.
To configure BizTalk Server Messaging Manager with new ASP files
- Copy the BizTalk_SiebelBizTalkAIC_1_post.asp page and the BizTalk_SiebelBizTalkAIC_1.asp page,
from Siebel Machine:
to BizTalk Machine:
BizTalk installation directory
To configure Siebel Server to run workflows
- AppObjMgr_Lang is the Application Object Manager to which AIC connects through ADC to run workflows on Siebel Server. Therefore, make sure that the Siebel Server Workflow component group and the appropriate Siebel application AppObjMgr_Lang (for example, SCCObjMgr_enu, for Siebel Call Center) components are installed and correctly configured.
The Siebel Application Integration Components receive documents from BizTalk Server and deliver them to the Siebel workflow specified in the BizTalk Server channel configuration.
AIC also invokes the Siebel Workflow Engine to run the workflow on either the Siebel client or the Siebel Server using ActiveX Data Controls.
NOTE: For details on enabling server components and connecting to the Application Object Manager using ADC, see the Siebel Installation Guide for the operating system you are using and the Using Siebel Tools guide.
Using the AIC Inbound Transport to Receive Messages from BizTalk
This section explains how to receive messages from BizTalk using the AIC Inbound transport.
NOTE: Microsoft BizTalk Server must be installed. In addition, the appropriate Siebel application AppObjMgr_Lang (for example, SCCObjMgr_enu) component, Siebel Workflow, and Siebel Enterprise Application Integration (EAI) must be enabled before following the procedure below. For more information, see the Siebel Installation Guide for the operating system you are using.
For AIC inbound connections, you define a workflow to process the inbound documents passed by the BizTalk Server using the Siebel Application Integration Component (AIC). This workflow performs the necessary steps to process the document, depending on the business requirements. For example, it could read the document, perform conversions, update the database, call other business services (such as the Siebel Adapter), and so on. This process gives you immense flexibility in the way an inbound XML document is processed.
To create a workflow to receive inbound XML documents over AIC from BizTalk
- From the Site Map choose Administration - Business Process > Workflow Processes.
- Set up the workflow process, as shown below, to receive and process XML document from AIC and give it a name, such as Write XML Doc.
NOTE: For details on creating workflow processes, see the Siebel Business Process Designer Administration Guide.
- Create the following two new process properties for your workflow:
NOTE: AIC passes the XML Document received from BizTalk Server to the process property with Default String set to <Value>. The same process property could be used to retrieve and process the XML document. For example, write this process property to a file or update the Siebel Database by calling EAI Siebel Adapter.
- Convert to the property set using the EAI XML Converter with the XML Document to Integration Object Hierarchy method and the following input and output arguments:
- Write to the database using the EAI Siebel Adapter with the Upsert method and the following input argument:
After you create the workflow, the workflow information must be supplied to the Siebel Application Integration Component (see Step 1 in the To supply the workflow information for AIC Inbound procedure). The Siebel AIC, which is a pipeline component, is implemented as a special kind of COM object that the BizTalk Server state engine calls to deliver data to an application. Therefore, you need to configure a BizTalk Server port and channel in BizTalk to include use of this Siebel AIC pipeline component for application integration.
After you have specified AIC as the primary transport for document interchange with Siebel information, you need to supply BizTalk with configuration data specific to Siebel AIC. You do so by creating a new channel (see Step 2). For details, see Microsoft BizTalk Server documentation.
This data is passed to the Siebel AIC component through the BizTalk Management Desk. One of the configuration items that is passed to the Siebel AIC component is the name of the workflow you defined within the Siebel application. AIC dynamically invokes the Siebel Workflow engine and passes the XML document to the workflow specified in the channel AIC properties.
After Siebel AIC is implemented, the property sheet contains the properties specific to the Siebel AIC implementation, one of which is Siebel Workflow Name.
You can optionally create maps using BizTalk Mapper if data transformation is required for the documents received by Siebel application from the external application. For information on the mapping capabilities of BizTalk, see Microsoft BizTalk Server online documentation.
To supply the workflow information for AIC Inbound
- Run the BizTalk Server Messaging Manager on the BizTalk Server machine.
- Set up a Home Organization for Siebel applications, such as Siebel Sales.
- Set up a Siebel Trading Partner to be the Destination Organization, such as Oracle.
- Create new document specification for the XDR document definition stored in WebDav.
- Set up a new BizTalk Server port to send the document to the Siebel application with the Primary Transport of Application Integration Component—BizTalk SiebelBizTalkAIC.Using BizTalk Messaging Manager, create a new port named Siebel AIC BTS.
- Specify the primary transport type to be Application Integration Component.
- Specify the Component Name to be the AIC component name, BizTalk.AppIntegrationSiebel.
- Save your work.
BizTalk is now configured to deliver messages to Siebel BizTalk AIC.
- Set up a new channel for the port created in Step d.
- Configure the Advanced properties in the final Channel Configuration page.
- Provide the Siebel Workflow name to be invoked as previously defined in Step 2 of To create a workflow to receive inbound XML documents over AIC from BizTalk.
- Enter the user name, password, and connect string for the Active X Data Control to connect to Siebel Server. For example:
SiebelServer = the machine name where the Siebel Server is installed.
lang = the language of the Siebel Server. The default lang is ENU, but for other languages you have to provide this value. Also note that the quotes shown in the example are required.
CAUTION: Make sure the connect string you type is using the correct format, including the use of quotes. The correct connect string format is very important in order for ADC to correctly connect to Siebel Server.
- Configure a File Receive Function from BizTalk Server Administration to poll a file location and deliver to the channel configured in Step 2.
NOTE: This example uses File Transport to receive documents from trading partners for the sake of illustration. In your actual business situations, a trading partner can deliver messages to a Siebel application over any supported transport.
- Open BizTalk Server Administration, expand Microsoft BizTalk Server, and expand the server group to which you want to add the File receive function.
- Select Receive Functions.
- Choose Action > New > File Receive Function and provide the information.
- Click the Advanced tab and enter a Channel Name, such as AIC Oracle To Siebel Channel.
- Click OK to finish.