Transports and Interfaces: Siebel eBusiness Application Integration Volume III > Interfacing with Microsoft BizTalk Server > Connecting to BizTalk Using COM and AIC >

Siebel COM Outbound Transport

This section describes how to set up and use the COM Outbound Transport to send messages to BizTalk Server.

Setting Up the COM Outbound Transport

To use the Siebel application to send documents to BizTalk over COM, you first need to install the BizTalk Server Interchange Application COM+ package from the BizTalk machine to the Siebel client. This is a one-time operation.

Checklist

q

Complete prerequisites (for setting up BizTalk Server and Siebel clients and generating schema from integration objects).

For details, see Preparing to Use the Siebel BizTalk Adapter.

q

Install the Interchange Application COM+ package onto the Siebel client machine from the BizTalk Server machine (one time operation).

For details, see To establish a COM+ remote communication link with BizTalk.

To establish a COM+ remote communication link with BizTalk

  1. On the BizTalk machine, choose Start > Programs > Administrative Tools > Component Services.
  2. In the tree pane, click Component Services, expand Computers and then under Computers, expand My Computer.
  3. Expand COM+ Applications and select BizTalk Server Interchange Application.
  4. Right-click and, from the pop-up menu that appears, select Export.
  5. On the Welcome to COM Application Export Wizard, click Next.
  6. Enter the name of the export application to be created, such as BiztalkInterchange. Use the Browse button as needed.
  7. In the Export As area, select the Application proxy radio button and click Next.
  8. On the final page, click Finish.

    9. You should now have two files, named as you specified in Step 6 above. One should have the extension .MSI, and one should have the extension .cab, such as BiztalkInterchange.MSI and BizTalkInterchange.MSI.cab.

  9. Copy these files to the Siebel client machine and then, on the Siebel client machine, run the *.MSI file to install the remote client for BizTalk Server.

Repeat the steps above for each Siebel client that will need to communicate with BizTalk Server.

Using the COM Outbound Transport to Send Messages to BizTalk

This section explains how to use the COM outbound transport to send messages from Siebel applications to a trading partner or external application through BizTalk Server. COM Outbound Transport is implemented as a business service, so you could potentially use this service as you would use any other business service, such as calling it from Siebel Workflow.You would run the workflow as fits your needs, using any of the usual mechanisms for running workflows in Siebel applications: Workflow Process, eScripting, and so on.

Checklist

q

Set up the Siebel COM Outbound Transport.

For details, see Setting Up the COM Outbound Transport.

q

Create configuration objects in BizTalk, by setting up new organizations, ports, and channels (once for each trading partner).

For details, see To set up BizTalk configuration objects, and COM Outbound Transport Parameters.

q

Create a new workflow in the Siebel application to convert data in the Siebel application and send the data as messages to BizTalk.

For details, see To create the Siebel workflow for COM Outbound.

COM Outbound Transport Parameters

When defining the workflow for COM Outbound transport to BizTalk, you can optionally choose from a number of parameters. These parameters correspond with the BizTalk Server IInterchange Submit() and SubmitSync() parameters.

Table 21 presents the outbound parameters.

Table 21.  COM Outbound Parameters
Parameter
Type
Description
<Value>
String
The document instance submitted.
DocumentName
String
The name of the BizTalkDocument object associated with the instance of the document being submitted.
SourceQualifier
String
The qualifier of the source organization and indicates how the Source is to be interpreted.
Source
String
The value of the qualifier of the source organization.
DestinationQualifier
String
The qualifier of the destination organization, it indicates how the DestinationID parameter is to be interpreted.
DestinationID
String
The value of the qualifier of the destination organization.
Channel
String
Contains the name of the BizTalkChannel object that is executed for this document.
FileName
String
Specifies a fully qualified path that contains the document to be submitted, rather than submitting the document directly as a string.
Envelope
String
Contains the name of the envelope specification to use to break the interchange into documents.

NOTE:  For more details on these parameters, see your Microsoft BizTalk Server documentation.

To set up BizTalk configuration objects

  1. On the BizTalk Server machine, access the BizTalk Messaging Manager.

    2. NOTE:  For details on each BizTalk-specific step, see the Microsoft BizTalk Server documentation and help system.

  2. Set up your home organization as Siebel and then set up applications for the home organization.
  3. Create a new organization and name it appropriately, such as Oracle.

    4. NOTE:  Throughout this chapter, many steps are illustrated with the use of an example. This example uses Oracle, but your actual business requirements dictate the name you give to the actual destination organizations that you set up for your trading partners.

  4. Create a document definition for the previously created document specification in WebDAV and name it, such as Siebel Order. See To import schema into BizTalk Server to save it as a BizTalk document specification.
  5. Create a messaging port to your trading partner.
    1. In the Destination Organization window, select an organization, such as Oracle.
    2. Click Browse under Primary Transport.
    3. Select the appropriate transport for your trading partner.
    4. Complete the remaining pages as needed and click Finish to complete.
  6. Create a new channel for the port created in Step 5.
    1. Create a new channel "From an Application" such as Siebel To Oracle Channel.Click Next.
    2. Select the appropriate inbound document definition, such as Siebel Order.
    3. Select the appropriate outbound document definition for your trading partner, such as Oracle Order.
    4. Select an appropriate map, if necessary.
    5. Complete other pages as required and select Finish to complete.

To create the Siebel workflow for COM Outbound

  1. From the application-level menu, choose View > Site Map > Business Process Administration > Workflow Processes.
  2. Create a new workflow process as shown below to send a message to BizTalk.

    		3.

    NOTE:  For information on how to set up Siebel Workflow, see Siebel Business Process Designer Administration Guide.

  3. Set up the process properties for your workflow as follows:

    4. Name
    Data Type
    Value
    OrderMessage
    Hierarchy
    -
    <Value>
    String
    -
    Object Id
    String
    record # for an order

  4. Set up the first step after Start to use the EAI Siebel Adapter with the Query method to query the order from Siebel Database, using the following input and output arguments:

    5. Input Arguments
    Type
    Value
    Property Name
    Process Property Type
    Output Integration Object Name
    Literal
    Sample Order
    -
    -
    Object Id
    Process Property
    -
    Object Id
    String

    Property Name
    Type
    Value
    Output Argument
    OrderMessage
    Output Argument
    -
    Siebel Message

  5. Set up the second step to use the EAI XML Converter with the Integration Object Hierarchy to XML Document method and the following input and output arguments to convert the order object to an XML document.

    6. Input Arguments
    Type
    Value
    Property Name
    Property Data Type
    Siebel Message
    Process Property
    -
    Order Message
    Hierarchy

    Property Name
    Type
    Value
    Output Argument
    <Value>
    Output Argument
    -
    XML Document

  6. Set up the last step to use the EAI BTS COM Transport with the Send or the SendReceive method and the following input arguments.

    7. NOTE:  You may require asynchronous or synchronous communication, using Send and SendReceive respectively, depending on your unique situation.

    Input Arguments
    Type
    Value
    Property Name
    Property Data Type
    <Value>
    Process Property
    -
    <Value>
    String
    Channel
     
    Literal
    Siebel to Oracle Channel (The channel you created in To set up BizTalk configuration objects.)
    -
    -

    NOTE:  Optionally, you can set any one of the other available input parameters in the pick list, such as Destination, DocumentName, and so on. For the full list of these parameters and their meanings, refer to Table 21.

  7. Make other modifications to your workflow as your situation requires and save the workflow.

 Transports and Interfaces: Siebel eBusiness Application Integration Volume III 
 Published: 23 June 2003