Adding external software dependencies for SAP

Before you can develop message flows that use WebSphere® Adapters nodes, you must add prerequisite files to the runtime environment.

Before you begin

  • Ensure that either a IBM® MQ client or a IBM MQ server is installed on the same computer as the integration node. For more information about using IBM MQ with IBM Integration Bus, see Installing IBM MQ.
  • Ensure that you have the relevant prerequisite files for your SAP system. (For information about the versions of files that IBM Integration Bus supports, see IBM Integration Bus system requirements.)
    • sapidoc3.jar
    • sapjco3.jar
    • Windows platformOn Windows:
      • sapjco3.dll
    • Linux platformz/OS platform On z/OS® and Linux®:
    Note: You can download these files for your operating system from the external SAP Web site, SAP Support Portal, and save them to a directory, such as C:\SAP_LIB. (On Windows, the directory cannot be a mapped network drive on a remote Windows computer; the directory must be local or on a Storage Area Network (SAN) disk.) You must have an SAPNet account to be able to access this Web site.
    • Windows platformOn Windows, download the .dll files that come with the SAP JCo download.
    • Linux platformz/OS platformOn z/OS and Linux, download the .so and .o files that come with the SAP JCo download.

Locating the SAP support files in the runtime environment

About this task

To add the SAP prerequisite files to the runtime environment, take the following steps.


  • Linux platformWindows platformOn Windows and Linux:
    1. Ensure that the integration node has started.
    2. Either open the Command Console, or open a Windows command prompt and enter mqsiprofile to initialize the environment.
    3. Enter the following command to display the locations of the prerequisite JAR files and native libraries:
      mqsireportproperties IBNODE -c EISProviders -o AllReportableEntityNames  -r  
      The following example shows what typically is displayed when you run this command:
    4. Set the location of the SAP prerequisite files using the following command:
      mqsichangeproperties IBNODE -c EISProviders -o SAP  -n jarsURL -v C:\SAP_LIB
      mqsichangeproperties IBNODE -c EISProviders -o SAP  -n nativeLibs -v C:\SAP_LIB
    5. To check that the values have been set correctly, run the following command:
      mqsireportproperties  IBNODE -c EISProviders -o SAP -r  
      The following example shows what is displayed by the mqsireportproperties command.
      ReportableEntityName=' '
      	SAP=' '
      BIP8071I: Successful command completion.
    6. Restart the integration node.
  • z/OS platformOn z/OS: Run the mqsireportproperties command by customizing and submitting the BIPCHPR utility. For more information about this utility, see Contents of the integration node PDSE.

Locating the SAP support files through the IBM Integration Toolkit

About this task

To add the SAP prerequisite files through the IBM Integration Toolkit, take the following steps.


  • Windows platformOn Windows: When you run the Adapter Connection wizard, you are prompted to specify the paths to the required libraries.
  • Linux platformOn Linux: Append the directory that contains the SAP libraries to the LD_LIBRARY_PATH environment variable:
    export LD_LIBRARY_PATH
    You must set this variable either for the whole system, or in the same shell or environment from which the IBM Integration Toolkit is launched.

What to do next

configure the SAP system to work with the adapter