Connect to mySAP Business Suite in a BizTalk Services Project

There are three overall steps to connect to mySAP Business Suite application from a BizTalk Services project.

• Create an LOB Target for mySAP Business Suite.

  Important

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

  • Visual Studio must be opened with Administrative privileges.

  • On a 64-bit server, also install the 32-bit SAP client libraries to the drive:\Windows\SysWOW64 folder.

• Use the LOB Target

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

To add an LOB Target for mySAP Business Suite

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

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

   1. In the Welcome window, select Next.

   2. In Connection Parameters, enter the following:

      • Application Server: The server name or IP address of the SAP server.

      • System Number: The SAP system number.

      • Client: The SAP client number.

      • Language: The SAP language.

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

        Important

        The SAP adapter supports the following client connection types:

        • A: An application host-based connection to SAP.

        • B: A load balanced connection to SAP.

        • D: A destination-based connection using the destination in the saprfc.ini file to SAP.

        Application Server Host	A	Required. The host name or the IP address of the SAP Application server.
        Gateway Host	A, B, D	Optional. The Gateway Host being used. Used for outbound connections only.
        Gateway Service	A, B, D	Optional. The Gateway Server being used. Used for outbound connections only.
        System Number	A	Required. Default is 00.
        Destination Name	D	Optional. The name of the Destination listed in the saprfc.ini file.
        AbapDebug	A, B, D	Optional. Default is False. Options include: False Adapter executes normally. True When adapter executes, the SAP GUI displays automatically and break into the AGAP code.
        RfcSdkTrace	A, B, D	Optional. Default is False. Options include: False RFC SDK traces are not written to the .trc files. True RFC SDK traces are written to the .trc files. The level tracing is determined by the RFC_TRACE environment variable: If RFC_TRACE is missing or set to 0 (zero), tracing is not enabled. If RFC_TRACE is set to 1, tracing is enabled.
        Client	A, B, D	Optional. Default is 800. The client number within SAP.
        Language	A, B, D	Optional. Default is EN. The logon language used.
        Application Server Group	A, B, D	Optional. The application server group name in SAP.
        Message Server Host	B	Optional. The host name or the IP address of the SAP Message server.
        Message Server Service	A, B, D	Optional. The Message Service in SAP.
        R/3 System Name	B	Optional. The R/3 System name in SAP.
        Connection Type	A, B, D	Required. Default is A. Options include: A Uses an application host-based connection. B Uses a destination-based connection. D Uses a load balanced connection.
        Destination Name	D	Optional. The name of the Destination listed in the saprfc.ini file.
        Gateway Host	A, B, D	Optional. The Gateway Host being used. Used for outbound connections only.
        Gateway Service	A, B, D	Optional. The Gateway Server being used. Used for outbound connections only.
        Program Id	A, B, D	Required. Used for RFC/TRFC Server scenarios. Used for inbound operations. If you enter the Destination Name property, this value is taken from the saprfc.ini file.
        Use Snc	A, B, D	Optional. Default is False. Options include: False Secure Network Communication (SNC) is not used. True Secure Network Communication (SNC) is used: Do not enter a user name and password in the Connection. The SncLibrary and SncPartnerName binding properties must be specified in the Connection.

        To configure the Binding Properties tab, refer to Working with BizTalk Adapter for mySAP Business Suite Binding Properties.

        The following binding properties are also available:

        LogOnTicketPassword	Optional	The LogOn ticket that is passed to SAP. Important Cannot be used with BizTalk Server.
        LogOnTicketType	Optional	Default is None. Determines whether the LogOn ticket is used for authentication to SAP. Options include: None No LogOn ticket is used to authenticate to SAP. > [!IMPORTANT] > <P>Can be used with BizTalk Server.</P> <p>MySapSSO1</p> <p>MySapSSO1 LogOn ticket is used to authenticate to SAP.</p> > [!IMPORTANT] > <P>Cannot be used with BizTalk Server.</P> <p>MySapSSO2</p> <p>MySapSSO2 LogOn ticket is used to authenticate to SAP.</p> > [!IMPORTANT] > <P>Cannot be used with BizTalk Server.</P>
        ExternalIdentificationData	Optional	Gets or sets the External Identification Data. Used when the Use SNC Connection property is set to True.
        ExternalIdentificationType	Optional	Gets or sets the External Identification Type. Required when ExternalIdentificationData is entered.

        [The SAP System Connection URI](https://go.microsoft.com/fwlink/p/?linkid=228976) provides additional information on the SAP adapter. - **Specify the credentials**: Enter the credentials to authenticate to the on-premises SAP system. Options include:

        Use Windows Credentials	The logged on user credentials are used to connect to the SAP system.
        Use the following UserName and Password	Enter a User name and Password that can connect to the SAP 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 SAP URI](images/Hh689843.439119b6-688b-4475-ad4d-308f4e77c624(Azure.100).jpeg "Configure SAP URI")
            
            The following links provide additional details on selecting an operation:
            
            [Browsing, Searching, and Retrieving Metadata for RFC Operations](https://go.microsoft.com/fwlink/p/?linkid=228978)
            
            [Browsing, Searching, and Retrieving Metadata for BAPI Operations](https://go.microsoft.com/fwlink/p/?linkid=228979)
            
            [Browsing, Searching, and Retrieving Metadata for IDOC Operations](https://go.microsoft.com/fwlink/p/?linkid=228980)
            
            [Browsing, Searching, and Retrieving Metadata for tRFC Operations](https://go.microsoft.com/fwlink/p/?linkid=228981)
            
            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 the 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 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 credentials 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 specified. 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 name. 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:

        

        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, enter the 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 SQL Server in a BizTalk Services Project
        Connect to Siebel eBusiness Applications in a BizTalk Services Project
        PowerShell Cmdlets for the BizTalk Adapter Service
        Connect to LOB systems from a BizTalk Services Project