This document tells you what you must know and do to install and use the SAP R/3 Gateway successfully. Before performing the installation, please read the Software AG Legal Notice.
The following are the prerequisites for deploying and running SAP R/3 Gateway. You can also use this information as an installation checklist.
To install the SAP R/3 Gateway
Select a gateway machine.
Create a user sag for SAP R/3 Gateway.
Access the gateway machine with Telnet, SSH or Windows Terminal Client (mstsc).
Create a HOME directory. We recommend creating a
directory on a partition with 1 GB of available disk space.
Connect the gateway machine with FTP and newly-created user, if no CD-ROM is available for the installation.
Ensure that an HTTP connection is available from your local web browser to the gateway machine. This is necessary if your environment runs with a secured proxy or has a Firewall.
Ensure that the SAP R/3 Application Server can be reached from your gateway machine.
Ensure that you have an ANSI C-Compiler for generating the communication kernels.
Under Windows, use the Microsoft Developer Studio C/C++ Compiler version 6 (or higher). The Professional version is sufficient.
Under UNIX, you will find the GNU C-Compiler for most platforms under http://gcc.gnu.org. Alternatively, you can use a compiler provided by your platform vendor.
Install webMethods EntireX SDK on the same machine on which the SAP R/3 Gateway is installed, and ensure you have access to the webMethods EntireX Broker. See the section Installing webMethods EntireX Components
The SAP RfcSdk is needed for your production environment. You can
download this software from SAP’s Support System OSS. After downloading, unpack
the CAR file with car -xvf rfc.car to a temporary location in the
file system. Later, after installing SAP R/3 Gateway, move the temporary files to their
proper location as described in the section Directory Structure.
For your Java environment, JDK 1.3 or higher is required.
A web application server with servlet container is required to run the SAP R/3 Gateway Portal. For the current version, deployment has been tested with Tomcat. For more information, see Installing and Starting the Web Server.
To process XML documents, you need an XML parser and an XSLT processor. SAP R/3 Gateway uses Xalan and Xerces. For more information, see Installing Xerces and Xalan.
When configuring the communication kernels, various connection parameters are required which differ depending on the direction of the communication.
The Rpc2Rfc kernel needs:
CPIC User ID
Password
Client
System number
DNS name of Application Server
The Rfc2Rpc kernel needs:
DNS name of Application Server
TCP/IP Port of Application Server
Program ID of RFC-Destination created by SM59
You should know the value of these parameters before starting work with SAP R/3 Gateway.
Install webMethods EntireX SDK on your
gateway machine platform. Under UNIX, create a sag user. Install
the RPCServer from the webMethods EntireX SDK on the
gateway machine (see component list below).
The installation of webMethods EntireX Broker is optional if you already have an installation on another platform. In this case, you must modify the webMethods EntireX Broker Attribute File to establish connectivity.
During the installation process, you are prompted to select from the following components (required components are indicated):
webMethods EntireX Common Files (please select).
webMethods EntireX Broker (select if not already installed on another platform).
webMethods EntireX Runtime:
DCOM Runtime (optional, not required).
Developer's Kit Runtime (please select).
webMethods EntireX SDK:
DCOM SDK (optional, not required).
Developer's Kit SDK (please select).
webMethods EntireX Starter Kit (optional, not required).
System Management Hub (optional, not required).
Extended Transport Service (please select).
Software AG Common Tomcat (please select).
The SAP R/3 Gateway is delivered as a web application. For this reason you need a web server. Currently, the deployment process has only been tested with Tomcat 4. Optionally, it is possible to use an existing JBoss as web application server.
It is easier for your UNIX Administrator to declare a separate user to
the operating system to run the application server because the SAP R/3 Gateway starts the
kernels as subprocesses. The user of the application server must have the same
group as the sag user.
The SAP R/3 Gateway can run in JBoss. This makes sense only if you already have a running JBoss installation with existing applications and you do not want to install a Tomcat, too. JBoss delivers many features which are not used by SAP R/3 Gateway.
The deployment of SAP R/3 Gateway with JBoss differs from deployment with Tomcat, because the JBoss does not unpack the web application.
To deploy SAP R/3 Gateway with JBoss
Unpack the sapr3gateway.war file into a directory with the namesapr3gateway.war. Use the ZIP utility or the command
jar -xvf sapr3gateway.war
Copy the directory sapr3gateway.war to JBoss server\default\deploy. After copying, create a subdirectory sapr3gateway.war in this directory.
(Re-) start JBoss.
Go to License Agreement and Setup Wizard.
Check Xalan installation.
Download a version from http://tomcat.apache.org/index.html.
The Windows installation of Jakarta Tomcat supports configuration as a
Windows Service. We recommend installing Tomcat without spaces in the directory
names. You can avoid this restriction by using the short directory name or
later in the Setup Wizard. To evaluate
the short directory name, use the DOS command dir /x. For example,
replace the long name of the c:\Program Files\... installation
directory by c:\PROGRA~1\... during the Tomcat installation
setup.
Under UNIX after installation of SAP R/3 Gateway, you will find a script to start Tomcat at boot time. This is described in the section Startup at Boot Time, below.
The SAP R/3 Gateway can run inside Tomcat 5. From Tomcat 4 to 5, the mail API is dropped. To solve this problem, please copy mail.jar and activation.jar into $TOMCAT_HOME/common/lib directory.
Update 11 contains the mail API inside the SAP R/3 Gateway web application. There are no additional installation steps for the web application server.
To control the web deployment in Tomcat, one user must be created with the roles of "manager" and "admin". Create and edit a user in the tomcat/conf/tomcat-users.xml file.
<?xml version='1.0' encoding='utf-8'?> <tomcat-users> <role rolename="manager"/> <role rolename="admin"/> <role rolename="sapr3gateway"/> <user username="admin" password="admin" fullName="" roles="admin,manager"/> </tomcat-users>
Add a role "sapr3gateway" if you want to secure the SAP R/3 Gateway application itself. Later, you will see that creating an Access Control List depends on the logged-in users.
Start the application server when the operating system is booted. There is a script example in the file webapps/sapr3gateway/setup/tomcat.sh.
#!/bin/sh -ex
#
JAVA_HOME=/usr/j2se
export JAVA_HOME
TOMCAT_HOME=/home/sag/jakarta-tomcat-4.1.31
export TOMCAT_HOME
# Set memory requirements for IDoc XML Gateway
# -Xms for initialization
# -Xmx for maximum
JAVA_OPTS="-Xms100M -Xmx500M"
export JAVA_OPTS
# Run Tomcat under control of ...
userid=sag
case "$1" in
start)
su $userid -c "rm $TOMCAT_HOME/logs/catalina.out"
su $userid -c "nohup $TOMCAT_HOME/bin/startup.sh >$TOMCAT_HOME/logs/nohup.log"
;;
restart)
su $userid -c "$TOMCAT_HOME/bin/shutdown.sh"
su $userid -c "rm $TOMCAT_HOME/logs/catalina.out"
su $userid -c "nohup $TOMCAT_HOME/bin/startup.sh >$TOMCAT_HOME/logs/nohup.log"
;;
stop)
su $userid -c "$TOMCAT_HOME/bin/shutdown.sh"
;;
*)
echo "Usage: $0 {start|stop|restart}"
exit 1
;;
esac
exit 0
Adapt and copy this file to /etc/init.d (on Sun Solaris or Linux) and create soft links:
ln -s /etc/init.d/tomcat /etc/init.d/rc3.d/S90tomcat ln -s /etc/init.d/tomcat /etc/init.d/rc3.d/K10tomcat
Note:
On Linux, there is already a tomcat startup script in
/etc/init.d. Adapt the existing one or use this one.
Xerces (http://xerces.apache.org/xerces2-j/index.html) is used to read and write XML documents and Xalan (http://xml.apache.org/xalan-j/index.html) is used to generate output for the Browser application.
You can download Xalan from the web site http://xml.apache.org/xalan-j/index.html or use the delivered version in the 3rdparty/xalan directory on CD. The following table contains information on installation.
| Component | JDK 1.3 | JDK 1.4 |
|---|---|---|
| Xerces | Is included and running in web application. See Installing the Gateway Portal. | Is included. |
| Xalan | Is included and running in web application. See Installing the Gateway Portal. | An older version is included in JVM or Tomcat. Therefore, use a version 2.4 or 2.5 (not 2.6.0) and install in Tomcat's directory common/endorsed. Another possibility is to use the Endorsed Standards Override Mechanism. Place the xalan.jar, in the <java-home>\jre\lib\endorsed directory, where <java-home> is where your JDK is installed. With JBoss, you must use the last described mechanism. |
After installing Xerces or Xalan into Tomcat or JDK, you must restart the web server (see the section Installing and Starting the Web Server).
Tip:
After Installing the Gateway
Portal, it is possible to check the running Xerces and
Xalan versions by clicking and
choosing
(http://YourGateway:8080/sapr3gateway/manager/version) and
Xalan Version
(http://YourGateway:8080/sapr3gateway/manager/xalanVersion)
The following table illustrates the directory structure on your UNIX file system after all of the required components have been installed:
| Directory | Description |
|---|---|
| $HOME/sag | General home directory |
| $HOME/sag/exx | webMethods EntireX installation |
| $HOME/sag/exx/vXXX | webMethods EntireX Installation, version XXX |
| $HOME/sag/tomcat | Application Server installation |
| $HOME/sag/tomcat/webapps/sapr3gateway | SAP R/3 Gateway home directory |
| $HOME/sag/tomcat/webapps/sapr3gateway/RfcSdk.XXX | Installation of SAP RfcSdk. XXX is the name of the platform |
| $HOME/sag/tomcat/webapps/sapr3gateway/WEB-INF/lib | Installed Open Source components Xerces and Xalan |
| $HOME/sag/tomcat/common/endorsed | Installed Open Source components Xerces and Xalan for all applications |
Before you complete the next installation commands, you must read and accept the terms of Software AG's Legal Notice.
SAP R/3 Gateway is delivered as a web application. Install this web application using one of the following steps:
The installation CD contains one sapr3gateway.war file for all Windows platforms and one for all UNIX target platforms. Select one of these from one of the subdirectories windows or unix.
Copy sapr3gateway.war to the tomcat/webapps directory, or
Use Tomcat Manager (or http://YourGateway:8080/manager/html/list) to upload sapr3gateway.war from the local file system. The application server will transport the package and automatically unpack it.
If you use JBoss as web application server, install the Gateway Portal as described in the section Using JBoss.
Once the web application has been installed, you can access SAP R/3 Gateway using the following URI: http://YourGateway:8080/sapr3gateway/manager/index.
Optionally, it is possible to install the IDoc XML Gateway with sapr3idocxmlgateway.war with the same steps that are described above. More installation hints are described in the section Installation.
After you have deployed the gateway portal, you must start the Setup Wizard by clicking and choosing ; or from http://YourGateway:8080/sapr3gateway/manager/setupWizard. This wizard evaluates your environment and prompts you for more information.
Activate application security.
Choose the platform-dependent makefile.
Set the path to the SAP RfcSdk.
Set the path to C-Compiler.
Set SAG home, SAG environment script or environment variable to Windows Operating System.
Please read the Release Notes for more installation and configuration information about related products.
Optionally, it is possible to start the setup wizard for the IDoc XML Gateway.