Search
SupportConsoleDevelopersStart a trialContact

Chapter 8. Using the Red Hat Fuse SAP Tool Suite

download PDF

The Red Hat Fuse SAP Tool Suite makes it possible to integrate your Camel routes with a remote SAP Application Server. A variety of SAP components are provided to support Remote Function Calls (RFC) and the sending and receiving of Intermediate Documents (IDocs). The SAP Tool Suite depends on the JCo and IDoc client libraries from SAP. To install and use these libraries, you must have an SAP Service Marketplace Account.

8.1. Installing the Red Hat Fuse SAP Tool Suite

Overview

The Red Hat Fuse SAP Tool Suite provides the Edit SAP Connection Configuration dialog, which helps you to create and manage the SAP Application Server and Destination connections. The suite is not installed by default, because it requires third-party JCo and IDoc client libraries, which are licensed separately by SAP.

Platform restrictions for SAP tooling

Because the SAP tool suite depends on the third-party JCo 3.0 and IDoc 3.0 libraries, it can only be installed on the platforms that these libraries support. For more details about the platform restrictions for SAP tooling, see Red Hat Fuse Supported Configurations.

Prerequisites

Before you can install the Fuse SAP Tool Suite, you must download the JCo and IDoc libraries from the following location:

To download these libraries, you must have an SAP Service Marketplace Account. Be sure to choose the appropriate JCo and IDoc libraries for your operationg system. Also:

  • Only version 3.0.11 or greater of the JCo library is supported.
  • Only version 3.0.10 or greater of the IDoc library is supported.

For this installation procedure, you can leave the downloaded files in archive format. There is no need to extract the contents.

Procedure

To install the Fuse SAP Tool Suite into Red Hat CodeReady Studio, perform the following steps:

  1. In Red Hat CodeReady Studio, select File Import to open the Import wizard.
  2. In the Select screen of the Import wizard, select Fuse Install Fuse SAP Tool Suite, and then click Next.
  3. The Install the Red Hat Fuse SAP Tool Suite screen opens, which displays the instructions for downloading the JCo and IDoc libraries from the SAP Service Marketplace. Click Next.

  4. The Select JCo3 and IDoc3 Archive to Import screen opens. Next to the JCo Archive File field, use the Browse button to select the JCo archive that you downloaded from the SAP Service Marketplace. After selecting the JCo archive, the Archive Version and Archive OS Platform fields are automatically filled in, so that you can check whether the library you are installing has the correct version and OS platform.

    Next to the IDoc3 Archive File field, use the Browse button to select the IDoc archive that you downloaded from the SAP Service Marketplace.

    After selecting both archive files, click Finish.

  5. A new Install wizard (for installing Eclipse plug-ins) opens automatically. This wizard displays the following to plug-ins to be installed:

    • Fuse SAP Tool Suite

    • SAP JCo3 and IDoc3 Libraries

      Make sure that both of these plug-ins are selected. Click Next.

      Note

      The SAP JCo3 and IDoc3 Libraries plug-in is dynamically constructed from the selected JCo and IDoc libraries.

  6. The Install Details screen allows you to review the plug-ins to be installed. Click Next.
  7. The Review Licenses dialog opens. Select the I accept radiobutton option, and then click Finish.
  8. If you encounter a Security Warning dialog (warning of unsigned content), click OK to ignore the warning and continue installing.
  9. The Restart Eclipse dialog opens. Click OK to restart Eclipse.

8.2. Create and Test SAP Destination Connection

Overview

In Fuse SAP Tool suite, the Edit SAP Connection Configuration dialog helps you to create and manage the SAP Application Destination connections. This section describes how to create and test the SAP destination connection.

Procedure

To create and test an SAP destination connection, perform the following steps:

  1. Navigate to the global Configurations tab of the route editor and click Add.

    The Create new global element view appears.

  2. Under SAP, select the type of connection you would like to create. Choose the SAP Connection and click Ok.

    The Edit SAP Connection Configuration dialog appears. It allows you to create, edit and delete the Destination and Server Connection Configurations.

  3. To create a new Destination Data Store, click the Add Destination tab.

    The Create Destination dialog appears.

  4. Enter a name for the destination in the Destination Name field and click Ok.

  5. In the Properties dialog,

    1. Click the Basic tab to configure the basic properties required to connect to an SAP destination. In this tab, fill in the following property fields to configure the connection:

      • SAP Application Server
      • SAP System Number
      • SAP Client
      • Logon User
      • Logon Password
      • Logon Language

    2. Click the Connection tab to add values required to connect to an SAP destination. Fill in the following property fields to configure the connection:

      • SAP System Number
      • SAP Router String
      • SAP Application Server
      • SAP Message Server
      • SAP Message Server Port
      • Gateway Host
      • Gateway Port
      • SAP System ID
      • SAP Application Server Group

    3. Click the Authenticate tab to add values required to validate an SAP destination. Fill in the following property fields to configure the connection.

      • SAP Authentication type
      • SAP Client
      • Logon User
      • Logon User Alias
      • Logon Password
      • SAP SSO Logon Ticket
      • SAP X509 Login Ticket
      • Logon Language

    4. Click the Special tab. In this tab, fill in the following property fields to configure the connection:

      • Select CPIC Trace
      • Initial Codepage

    5. Click the Pool tab and fill in the following property fields to configure the connection:

      • Connection Pool Peak Limit
      • Connection Pool Capacity
      • Connection Pool Expiration Time
      • Connection Pool Expire Check Period
      • Connection Pool Max Get Client Time

    6. Click the SNC tab and fill in the following property fields to configure the connection:

      • SNC Partner Name
      • SNC Level of Security
      • SNC Name
      • SNC Library Path

    7. Click the Repository tab and fill in the following property fields to configure the connection:

      • Repository Destination
      • Repository Logon User

      • Repository Logon Password

        Note

        If you need more information about these settings, refer the SAP documentation.

  6. You are now ready to test the destination connection. In the Edit SAP Connection Configuration dialog, right-click on the destination name and select Test.

    The Test Destination Connection dialog opens.

  7. The dialog uses the current destination configuration settings to connect to the SAP Destination Data Store. If the test is successful, you will see the following message in the status area: 

    Connection test for destination 'YourDestination' succeeded.

    Otherwise, an error report appears in the status area.

  8. Click Close to close the Test Destination Connection dialog.
  9. Click Finish. The newly created SAP Destination Connection appears under SAP.

8.3. Create and Test SAP Server Connection

Overview

In Fuse SAP Tool suite, the Edit SAP Connection Configuration dialog helps you to create and manage the SAP Application Server connections. This section describes how to create and test the SAP Server connection.

Procedure

To create and test the SAP Server connection, perform the following steps:

  1. Navigate to the global Configurations tab of route editor and click Add.

    The Create new global element view appears.

  2. Under SAP, select the type of connection you would like to create. Choose the SAP Connection and click Ok.

    The Edit SAP Connection Configuration dialog appears. It allows you to create, edit and delete the Destination and Server Connection Configurations.

  3. To create a new Server Data Store, click the Add Server tab.

    The Create Server dialog appears.

  4. Enter a name for the Server in the Server Name field and click Ok.

  5. In the Properties dialog,

    1. Click the Mandatory tab to configure the basic properties required to connect to an SAP server. In this tab, fill in the following property fields to configure the connection:

      • Gateway Host
      • Gateway Port
      • Program ID
      • Repository Destination
      • Connection Count

    2. Click the Optional tab and fill in the following property fields to configure the connection:

      • SAP Router String
      • Worker Thread Count
      • Minimum Worker Thread Count
      • Maximum Startup Delay
      • Repository Map

    3. Click the SNC tab and fill in the following property fields to configure the connection.

      • SNC Level of Security
      • SNC Name

      • SNC Library Path

        Note

        For more information about the settings, refer the SAP documentation.

  6. You are now ready to test the server connection. In the Edit SAP Connection Configuration dialog, right-click on the server name and select Test.

    The Test Server Connection dialog opens.

  7. The dialog uses the current server configuration settings to connect to the SAP Server Data Store. If the test is successful, you will see the following message in the status area: 

    Server state: STARTED
Server state: ALIVE

    If the test fails, the server status is reported as DEAD.

  8. Click Stop to shut down the Test Sever.
  9. Click Close to close the Test Server Connection dialog.
  10. Click Finish. The newly created SAP Server Connection appears under SAP.

8.4. Deleting Destination and Server Connections

Overview

This following section describes how to delete the SAP Destination and Server connections in the Edit SAP Connection Configuration dialog.

Procedure

If you want to delete the Destination and Server connections, perform the following steps:

  1. Navigate to the global Configurations tab of route editor and click Add.

    The Create new global element view appears.

  2. Under SAP, select the SAP Connection and click Ok.

    The Edit SAP Connection Configuration dialog appears. It allows you to create, edit and delete the Destination and Server Connection Configurations.

  3. In the Edit SAP Connection Configuration dialog, select the Destination and Server Data Stores which you want to delete.

  4. Click Delete. It will delete the selected connections.

    Atlast, click Finish. It will save all the changes.

8.5. Create a New SAP Endpoint

Overview

You can use the Components palette in the route editor to add SAP components to a route with the help of the Edit SAP Connection Configuration dialog.

Note

If you are using the SAP Connection view, remember to paste the requisite SAP connection configuration data into your Blueprint XML or Spring XML code.

Prerequisites

You must already have created some SAP destination connections and/or server connections with the help of the Edit SAP Connection Configuration dialog.

Note

If you are using the SAP Connection view, export this configuration to a file of the appropriate type (Blueprint XML or Spring XML).

Procedure

To create a new SAP endpoint, perform the following steps:

  1. It is assumed that you already have a Fuse project and a Camel XML file to work with (which could either be in Blueprint XML or Spring XML format).

  2. Open your Camel XML file in the route editor. If you have already installed the Red Hat Fuse SAP Tool Suite, you should be able to see the SAP components under the Components palette in the route editor. The following SAP components are provided by the tool suite:

    • SAP IDoc Destination
    • SAP IDoc List Destination
    • SAP IDoc List Server
    • SAP qRFC Destination
    • SAP Queued IDoc Destination
    • SAP Queued IDoc List Destination
    • SAP sRFC Destination
    • SAP sRFC Server
    • SAP tRFC Destination

    • SAP tRFC Server

      In the Design tab of the route editor, drag one of these components onto the canvas to create a new SAP endpoint in the current camelContext.

      Note

      The SAP Netweaver component does not belong to the Red Hat Fuse SAP Tool Suite. It is hosted in the Apache Camel project.

  3. Switch to the Source tab of the route editor, by clicking the Source tab at the bottom of the canvas. You can see the XML source of the routes.

  4. When specifying an SAP endpoint URI, you must embed either a destination name or a server connection name in the URI format. For example, the sap-srfc-destination component has the following URI format: 

    sap-srfc-destination:destinationName:rfcName

    To reference a particular destination, use the value of the relevant entry element’s key attribute as the destinationName in this URI.

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.