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

  • If you require transactional support for SAP nodes, ensure that an IBM® MQ client or server is installed on the same computer as the integration server. If you do not require the nodes in the flow to be transactional, you can set the Transaction mode property of the SAP node to No, and access to IBM MQ will not be required. For more information about using IBM MQ with IBM App Connect Enterprise, 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 App Connect Enterprise supports, see IBM App Connect Enterprise system requirements.)
    • sapidoc3.jar
    • sapjco3.jar
    • Windows platformOn Windows:
      • sapjco3.dll
    • Linux platformUNIX platform On Linux® and UNIX:
      • libsapjco3.so
    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 platformUNIX platformOn Linux and UNIX, 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

The integration server configuration file (server.conf.yaml) contains a section for connector providers, which defines the location of the required JAR files and native libraries, as you can see in the following example:
ConnectorProviders:
  SAPConnectorProvider:
    jarsURL: default_Path     # Set to the absolute path containing the SAP JCo JARs
    nativeLibs: default_Path  # Set to the absolute path containing the SAP JCo libraries 
By default, the location is set to default_Path, which indicates that the JAR files and libraries can be found in the integration server's shared-classes directory.

To specify a location for the SAP prerequisite files, complete the following steps.

Procedure

Linux platformWindows platformUNIX platform On Windows, Linux, and UNIX:
  1. Use a YAML editor to open the server.conf.yaml file, then find the ConnectorProviders section.
  2. Set the jarsURL property to the absolute path where the JAR files are stored.
  3. Set the nativeLibs property to the absolute path where the native libraries are stored.
  4. Save the server.conf.yaml file, then restart the integration server.

Locating the SAP support files through the IBM App Connect Enterprise Toolkit

About this task

To add the SAP prerequisite files through the IBM App Connect Enterprise Toolkit, take the following steps.

Procedure

  • 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:
    LD_LIBRARY_PATH=DIRECTORY_CONTAINING_SAP_LIBRARIES:${LD_LIBRARY_PATH}
    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 App Connect Enterprise Toolkit is launched.

What to do next

Configure the SAP system to work with the adapter