Installation (SAP Library - SAP Exchange Infrastructure (BC-XI))

Installation

Purpose

You install the Adapter Engine, including available adapters, so that you can then configure and use them to convert the respective message formats. You can configure adapters individually or together as required, but always separately for inbound processing (inbound adapter) and outbound processing (outbound adapter) by the Integration Engine.

You must specify every adapter that you want to use at the start of the installation process.

Prerequisites

To install adapters, you require the following:

A Java development kit (JDK) 1.3

The optional package Java Servlet Version 2.3 or above (servlet.jar). This can be located, for example, on the SAP Web Application Server or directly at http://java.sun.com/products/servlet/index.html (download from servlet.jar). You can copy the package directly to the adapter installation directory (tech_adapter); otherwise it must be located in the Java CLASSPATH.

Additionally for the JMS adapter

The optional package Java Messaging Service (jms.jar). This can be located, for example, on the SAP Web Application Server or directly at http://java.sun.com/products/jms/index.html (download from jms.jar).

A JMS driver installation for the queue system to be connected to (for example, MQSeries). The required Java libraries are product-specific and can be obtained from either the product vendor or other providers. The Java libraries must be located in the Java CLASSPATH following installation so that the JMS adapter can access the required Java classes at runtime.

Additionally for the JDBC adapter

A JDBC driver installation (version 2.0) for the database product to be connected to. The required Java libraries are product-specific and can be obtained from either the database vendor or other providers. The Java libraries must be located in the Java CLASSPATH following installation so that the JDBC adapter can access the required Java classes at runtime.

Additionally for HTTPS protocol

If the adapters are to communicate using HTTPS, additional libraries to implement the SSL protocol are required. You can download the Java libraries iaik_jce.jar and iaik_ssl.jar from the SAP Service Marketplace (http://service.sap.com) Software Distribution Center, under SAP Cryptographic Software, but ensure that you follow the regulations outlined there.

You must copy both libraries to the Java CLASSPATH after installation.

If the inbound adapter is to communicate with the Integration Server using HTTPS, you can use the HTTPS protocol instead of HTTP for XMB.TargetURL (https:// instead of http://).

If the outbound adapters from the Integration Server are to be communicated with using HTTPS protocol, you must configure the HTTP server correspondingly for the adapters. This is achieved using the HttpServer service.

If the browser is to be connected to the Adapter Engine configuration screen using HTTPS protocol, you must configure the GuiBrowserEngine service correspondingly.

The Java runtime (java.exe) is located in the search path, if installation was performed correctly.

The packed adapter-installation file has been unpacked in a directory of your choice and you have retained the path structure.

Process Flow

New Installation

Within the directory you used to unpack the installation file you will find the sub-directory tech_adapter with further sub-directories such as Administration, Configuration and LogFiles.

To install an adapter, switch to the directory tech_adapter.

To install the file adapter, execute the following:

Windows: install_fileadapter.bat

UNIX: install_fileadapter.cmd

To install the JDBC adapter, execute the following:

Windows: install_jdbcadapter.bat

UNIX: install_jdbcadapter.cmd

To install the JMS adapter, execute the following:

Windows: install_jmsadapter.bat

UNIX: install_jmsadapter.cmd

To install the SOAP adapter, execute the following:

Windows: install_soapadapter.bat

UNIX: install_soapadapter.cmd

To start the installed adapter, execute the following:

Windows: run_adapter.bat

UNIX: run_adapter.cmd

When you have executed run_adapter.bat or run_adapter.cmd, you can call the Adapter Engine using a browser. The corresponding default URL is http://<hostname>:8200; when logging on for the first time, enter the user SAP and the password init. When you have created new users, you must delete this initial user as soon as possible.

If the standard port 8200 of the Adapter Engine is already in use, you must enter a free port under port= in the file GuiBrowserEngine.properties.

If this port is also already being used, the Adapter Engine displays the following error message in the window in which it was started and then it closes itself.

ERROR starting Adapter engine base service ´GUI´

Installation is now complete. On the Adapter Engine configuration screen you find two adapters (inbound and outbound) for each of the adapter types that you can configure there (for example, a SOAP adapter).

Note

You define the difference between inbound and outbound for the SOAP adapter during configuration. This means that following installation, there is only one SOAP adapter for which you must then configure two different instances, if necessary.

To run multiple adapters of the same adapter type or different adapter types simultaneously, or to start adapters automatically, go to the configuration screen of the Adapter Engine.

Reinstallation

If you want to install a more recent adapter version, or want to repeat the installation, you have two options:

The existing adapter configuration is not to be saved

In this case, delete the existing installation beneath the installation directory completely and install the adapter as described above; the adapter does not contain any other data apart from this directory structure.

The existing adapter configuration and user management are not to be saved

Switch to the directory tech_adapter beneath the installation directory and execute the following file:

Windows: save_configuration.bat

UNIX: save_configuration.cmd

Besides the directory tech_adapter, the system creates a new directory adapter_configuration.backup that contains all relevant files for adapter configuration and user management.

If you have also changed the configuration of services and if these configurations also need to be saved, execute the following file as well:

Windows: save_baseconfiguration.bat

UNIX: save_baseconfiguration.cmd

Delete the directory tech_adapter beneath the installation directory.

Install the adapter as described above. Instead of the installation script, execute the following file in the directory tech_adapter:

Windows: restore_configuration.bat

UNIX: restore_configuration.cmd

This file reproduces the adapter configurations, including user management. The services configurations are also reproduced if you have also saved them. Otherwise the services are available in their original configuration, as is the case following a new installation.

Continuous Operation

To ensure that the adapter configuration is continually available, the Adapter Engine can be started automatically when a computer is restarted. The procedure you need to follow depends on the operating system:

Unix platforms usually have a directory dedicated for the purpose of saving programs that are to be executed when the operating system is started up (../etc/rc).

If you are running a Windows platform you must save a scheduled task for the batch file run_adapter.bat by choosing Start ® Accessories ® System Tools. Together with the option described above of starting the individual adapters automatically when the Adapter Engine is started, this enables you to automate start-up throughout.

Accessing the System Landscape Directory

You can access the System Landscape Directory (SLD) from the Adapter Engine. When the Adapter Engine starts, it can log on to the SLD, whereby the Runtime Workbench recognizes it as an SAP Exchange Infrastructure component, thus making it globally accessible. Moreover, this enables information connected with business systems to be exported. For more information about configuring this service, see the section SLDaccessor in Services.

Note that this service is not mandatory and the Adapter Engine can function without being connected to the SLD.

Monitoring with the Runtime Workbench

The Runtime Workbench can access the Adapter Engine for monitoring purposes. The same HTTP port as for configuration is used for this purpose. To log on you require the technical user XIRWBUSER and the password XIPASS, but no other authorizations. This user is created automatically when the Adapter Engine is installed. If this user is deleted (for example, when an older configuration is implemented following installation), or if the Runtime Workbench requires another user, you must create this user manually. The user to be created only requires the authorization group Locked. For more information about creating users, see user management.

You can also call the Adapter Engine administration screen from the Runtime Workbench. To be able to do so, both administration and monitoring settings must be maintained in the System Landscape Directory. For more information, see the Runtime Workbench documentation.