Connect to Siebel eBusiness Applications in a BizTalk Services Project

 

Important

Microsoft Azure BizTalk Services (MABS) is being retired, and replaced with Azure Logic Apps. If you currently use MABS, then Move from BizTalk Services to Logic Appsprovides some guidance on moving your integration solutions to Logic Apps.

If you're brand new to Logic Apps, then we suggest getting started here:

There are three overall steps to connect to Siebel eBusiness Suite from a BizTalk Services project.

  • Create an LOB Target for Siebel eBusiness Suite.

    Important

    • To create an LOB Target for Siebel, you must be a member of the local Administrators group and have the System Administrator right on the on-premises Siebel system.

    • Visual Studio must be opened with Administrative privileges to use BizTalk Adapter Service.

  • Use the LOB Target

  • Generate schema for the operation to be performed on the Siebel application.

Important

These steps assume you have a Service Bus namespace. Install Azure BizTalk Services SDK lists the requirements.

To add an LOB Target for Siebel eBusiness Application

  1. In Server Explorer, expand BizTalk Adapter Service, expand the Management URL, and then expand LOB Types.

  2. Right-click Siebel and select Add Siebel Target. The Add a Target wizard opens:

    1. In the Welcome window, select Next.

    2. In Connection Parameters, enter the following:

      • Siebel Gateway: The Siebel server name and optionally, the port number. If the port number is not entered, port 2321 is used. To use a different port, enter ComputerName:PortNumber.

      • Siebel Object Manager: The Siebel object manager on the enterprise server.

      • Siebel Enterprise Server: The Siebel Enterprise Server.

      • Advanced: Select this button to configure additional Connection Properties and any Binding Properties:

        Compression

        Optional. The compression algorithm to use between the Siebel adapter and the Siebel system. Default is zlib. Supported values include:

        • none

        • zlib

        Encryption

        Optional. The type of encryption to use between the Siebel adapter and the Siebel system. Default is none. Supported values include:

        1. none

        2. mscrypto

        3. rsa

        Language

        Optional. The object manager language. Default is enu.

        SiebelEnterpriseServer

        Required. The Siebel Enterprise Server.

        SiebelGateway

        Required. The Siebel server name.

        SiebelObjectManager

        Required. The Siebel object manager on the enterprise server.

        SiebelRepository

        Required if more than one Siebel repository exists on the server. Otherwise, it is optional.

        Note

        If there is more than one repository on the server, you must enter a target repository.

        SiebelServer

        Required for all Siebel 7.5 server connections. Otherwise, do not set this parameter.

        Transport

        Optional. Only tcpip is supported. Default is tcpip.

        To configure these **Binding Properties**, refer to [Working with BizTalk Adapter for Siebel Binding Properties](https://go.microsoft.com/fwlink/p/?linkid=228988). The following binding properties are also available: BatchFields Required. Default is **False**. Options include: False When setting field values in a business component, fields are not batched. True When setting field values in a business component, fields are batched. [The Siebel System Connection URI](https://go.microsoft.com/fwlink/p/?linkid=228987) provides additional information on the Siebel adapter. - **Specify the credentials**: Enter the credentials to authenticate to the on-premises Siebel system. Options include:

        Use Windows Credentials

        The logged on user credentials are used to connect to the Siebel system.

        Use the following username and password

        Enter a User name and Password that can connect to the Siebel system.

                > [!NOTE]
                > <P>Not all options may be available for this LOB adapter.</P>
        
                
                Select **Next**.
        
        3.  In Operations, expand the node, select the database operation, and select the right arrow:
            
            ![Configure Siebel URI](images/Hh689882.a7bbfe59-72a3-46d6-af74-8518decd010e(Azure.100).jpeg "Configure Siebel URI")
            
            [Browsing, Searching, and Retrieving Metadata for Siebel Operations](https://go.microsoft.com/fwlink/p/?linkid=228989) provides additional details on selecting an operation.
            
            To see the operation’s generated WSDL, select the operation, and select **Properties**.
            
            Select **Next**.
        
        4.  In Runtime Security, enter the security type. This security type determines how the client message is authenticated with the LOB Target. Options include:
            
            <table>
            <colgroup>
            <col style="width: 50%" />
            <col style="width: 50%" />
            </colgroup>
            <tbody>
            <tr class="odd">
            <td><p>Fixed Username</p></td>
            <td><p>Select this option if you are using a username and password created locally on LOB system.</p></td>
            </tr>
            <tr class="even">
            <td><p>Custom SOAP Header</p></td>
            <td><p>Select this option if you create a custom SOAP header to include the username and password.</p></td>
            </tr>
            <tr class="odd">
            <td><p>Message Credential</p></td>
            <td><p>Select this option if you are including the logon credentials in the WS-Security header of the message.</p></td>
            </tr>
            </tbody>
            </table>
            
            Select **Next**.
        
        5.  In Deployment, choose an existing LOB Relay or create a new LOB Relay.
            
        
            > [!TIP]
            > <P>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 the Message Credential or Fixed Windows security type.</P>
        
            
            To create a new LOB Relay:
            
            <table>
            <colgroup>
            <col style="width: 50%" />
            <col style="width: 50%" />
            </colgroup>
            <tbody>
            <tr class="odd">
            <td><p>Namespace</p></td>
            <td><p><strong>Required</strong>. Enter your Service Bus namespace. The namespace name is available in the <a href="https://go.microsoft.com/fwlink/p/?linkid=517414">Azure classic portal</a>.</p></td>
            </tr>
            <tr class="even">
            <td><p>Issuer Name</p></td>
            <td><p><strong>Required</strong>. A valid Service Bus Issuer Name is required.</p></td>
            </tr>
            <tr class="odd">
            <td><p>Issuer Secret</p></td>
            <td><p><strong>Required</strong>. A valid Service Bus Issuer Secret key is required.</p></td>
            </tr>
            <tr class="even">
            <td><p>Relay Path</p></td>
            <td><p><strong>Required</strong>. Enter the desired name of the relay path. For example, if you use chose Fixed Windows credential option for Runtime Security, you can enter something like <em>WindowsAuthRelay</em>.</p></td>
            </tr>
            <tr class="odd">
            <td><p>Target Sub-path</p></td>
            <td><p><strong>Required</strong>. Enter a sub-path to make this target unique. For example, you can enter <em>GetOrder</em>.</p></td>
            </tr>
            <tr class="even">
            <td><p>Target runtime URL</p></td>
            <td><p>This is automatically populated with the namespace name, relay path and target sub-path entered. If using the examples above, it is populated with something like:</p>
            <p>https://MyNamespace.servicebus.windows.net/WindowsAuthRelay/GetOrder</p></td>
            </tr>
            </tbody>
            </table>
            
            Select **Next**.
        
        6.  Summary shows your configured values. Select **Create**.
        
        7.  When complete, 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](hh689786\(v=azure.100\).md) describes the IIS components.
        

        To use the LOB Target

        1. Right-click anywhere on the BizTalk Service project design area, select Properties, and update the BizTalk Service URL property to include your BizTalk Services name. This is the name that you entered in Azure classic portal when creating the BizTalk Services.

        2. Set the security property for the relay endpoint:

          1. Right-click the relay endpoint in Server Explorer. and select Properties.

          2. In the Properties grid, select the ellipsis (…) next to the Runtime Security property.

          3. In the Edit Security dialog box, select the security method you want to use, and enter their values.

          4. Select OK.

        3. Drag and drop the LOB Target onto the design area. Note the Entity Name property of the LOB Target. The default value of the property is Relay-Path_target-sub-path.

        4. Open the .config file for the LOB target, which typically has the RelayPath_target-sub-path.config naming convention. Enter the Service Bus issuer name and issuer secret, as shown:

          <tokenProvider>
            <sharedSecret issuerName="owner" issuerSecret="issuer_secret" />
          </tokenProvider>
          

          Save changes to the config file.

        Once a LOB Target is configured and added to the design area, add a XML One-Way Bridge or a XML Request-Reply Bridge to be the source. Use Connector in the Toolbox to connect the bridge to the LOB Target, similar to the following:

        Bridge Connection

        Create an XML One-Way Bridge and Create an XML Request-Reply Bridge provide more specific information on the XML bridge and any additional properties that must be configured.

        Tip

        The bridge uses the Relative Address property of the LOB Target to send messages to the on-premises LOB system.

        To generate the schema

        1. In the BizTalk Service project, in the Server Explorer, right click the LOB Target you created, and then select Add schemas to <project_name>. The Schema Generation dialog opens.

        2. Enter a file name prefix. This value is prefixed with all the schema files that are generated. You can also enter the folder name under which the schemas are added in the Visual Studio Solution Explorer. The default value for the folder is LOB Schemas.

        3. Select a credential type to generate the schema, provided appropriate values for authentication, and then select OK.

          The schemas are added to the project under the folder name.

        See Also

        Connect to Oracle Database or eBusiness Suite in a BizTalk Services Project
        Connect to mySAP Business Suite in a BizTalk Services Project
        Connect to SQL Server in a BizTalk Services Project
        PowerShell Cmdlets for the BizTalk Adapter Service
        Connect to LOB systems from a BizTalk Services Project