How-to install Relay Server 16.5.5 on Windows
and configuring Outbound Enabler
SAP Mobile Platform 3.0 SP06 and higher
How-to install Relay Server 16.5.5 on Windows and configuring Outbound Enabler
TABLE OF CONTENTS
ABSTRACT ....................................................................................................................................................... 3
1.
What is the SAP Relay Server? ......................................................................................................... 3
2.
Requirements .................................................................................................................................... 3
3.
Installation and configuration ............................................................................................................. 3
4.
Relay Server status request .............................................................................................................. 3
5.
Configuring Outbound Enabler to work with SAP Mobile Platform Servers ...................................... 3
6.
Logging .............................................................................................................................................. 3
WHAT IS THE SAP RELAY SERVER? ............................................................................................................ 4
General .............................................................................................................................................................. 4
Relay Server components ................................................................................................................................. 4
Requirements .................................................................................................................................................... 4
a.
Hardware requirements ..................................................................................................................... 4
b.
Supported operating system .............................................................................................................. 4
c.
Supported IIS versions ...................................................................................................................... 4
INSTALLATION AND CONFIGURATION ........................................................................................................ 5
Context............................................................................................................................................................... 5
Installation of the Relay Server files .................................................................................................................. 6
Sample for rs.config ........................................................................................................................................... 8
RELAY SERVER STATUS REQUEST ............................................................................................................. 9
CONFIGURING OUTBOUND ENABLER TO WORK WITH SAP MOBILE PLATFORM SERVERS ........... 10
LOGGING ........................................................................................................................................................ 12
1.
Relay Server .................................................................................................................................... 12
2.
Outbound Enabler ............................................................................................................................ 12
2
How-to install Relay Server 16.5.5 on Windows and configuring Outbound Enabler
ABSTRACT
This white paper provides the following:
1. What is the SAP Relay Server?
1.1. General overview
1.2. Relay Server components
2. Requirements
2.1. Hardware requirements
2.2. Supported operating system
2.3. Supported IIS and Windows version
3. Installation and configuration
4. Relay Server status request
5. Configuring Outbound Enabler to work with SAP Mobile Platform Servers
6. Logging
How-to install Relay Server 16.5.5 on Windows and configuring Outbound Enabler
For this document a Windows Server was used.
All information in this document is tested and verified on Windows Server 2008 R2 and IIS 7.
WHAT IS THE SAP RELAY SERVER?
General
The Relay Server acts as a reverse proxy for client devices communicating with the SAP Mobile Server
(SMP).
Relay Server enables communications from the SMP to client devices, via the Internet, without requiring any
inbound port to be opened on the internal firewall.
In a clustered SAP Mobile Platform environment, Relay Server provides rudimentary load balancing for the
Mobile Platform Server cluster, distributing client requests in a round-robin manner.
Relay Server components
The Relay Server consists of:
a. Web server extensions — one each to handle communication with clients (from the Internet) and
communication with Mobile Platform Servers(on the internal LAN)
b. State Manager — a process that maintains state information across client requests and sessions
The State Manager process runs on the web server host, independent of the Web server application.
Relay Server characteristics and behavior are defined by a configuration file (rs.config), which is
formatted as a properties file
Requirements
a. Hardware requirements
Hardware (minimum) - 1 or more CPUs, 2GHz or higher - 2GB RAM
Disk Space (minimum) for Relay Server 16.5.x 10MB
b. Supported operating system
For a complete list of options that have been tested by SAP, see the SAP Product Availability Matrix
(PAM) https://support.sap.com/release-upgrade-maintenance/pam.html . Click the "Enter the
Product Availability Matrix" button, then search for SAP Mobile Platform 3.0 (search box in upper
right corner), and select SAP Mobile Platform 3.0.
c. Supported IIS versions
IIS 7.0 without WebSocket support for Agentry traffic
IIS 7.5 without WebSocket support for Agentry traffic
IIS 8.0 with WebSocket support for Agentry traffic
IIS 8.5 with WebSocket support for Agentry traffic
How-to install Relay Server 16.5.5 on Windows and configuring Outbound Enabler
INSTALLATION AND CONFIGURATION
The Relay Server components are available in the SAP Mobile Platform Server installation.
By default, the Relay Server files are located in <SMP_HOME>\Server\extras\relayserver in a RelayServer2IIS-<SMP_version>.zip file. Within that .zip file:
• ..\Bin64 contains DLLs.
• ..\relayserver\IIS\bin64 contains rs.dll and the rs.config.sample configuration file.
Figure 1 Relay Server installation package
Context
With the .zip, the \relayserver\IIS\iis7_plus_setup.bat quick setup script performs the following tasks:
1.
2.
3.
4.
Installs the supported version of IIS that is available and turns on the required features
Configures the installed IIS for the Relay Server
Creates a demo application
Generates a quick reference guide
Web Server administrators can customize the script as necessary.
The Relay Server for Windows consists of the following executables:




rs.dll (in RelayServer2-IIS-<SMP_version>.zip\relayserver\iis\bin64)
dblgen16.dll (in RelayServer2-IIS-<SMP_version>.zip\Bin64)
dbicu16.dll (in RelayServer2-IIS-<SMP_version>.zip\Bin64)
dbicudt16.dll (in RelayServer2-IIS-<SMP_version>.zip\Bin64)
How-to install Relay Server 16.5.5 on Windows and configuring Outbound Enabler
Installation of the Relay Server files
1. From any SAP Mobile Platform Server installation, copy the
<SMP_HOME>\Server\extras\relayserver\RelayServer2-IIS-<SMP_version>.zip to a computer
where IIS has been set up to support a Relay Server in your farm.
2. Extract the contents of the ..\Server\extras\relayserver\RelayServer2-IIS-<SMP_version>.zip file
to a folder on that computer.
Instructions that follow use RSfiles to refer to this folder.
PLEASE NOTE: Ensure the path does NOT contain any blank characters.
Figure 2 Extract Relay Server archive
3. Open a command prompt, running as administrator.
4. Set a temporary environment variable SQLANY16 to the RSfiles location.
Figure 3 Set the temporary SQLANY16 variable
5. Add RSfiles\bin64 to your SYSTEM path.
Figure 4 Open the System Path variable
Figure 5 Set the SQLANY16\bin64 variable
How-to install Relay Server 16.5.5 on Windows and configuring Outbound Enabler
6. RSfiles\relayserver\iis\iis7_plus_setup.bat to configure IIS.
Figure 6 Start the IIS configuration file
Figure 7 IIS configuration in process
Figure 8 IIS setup done
7. Run from the command prompt: C:\Windows\system32\iisreset.
Figure 9 Reset of the IIS
How-to install Relay Server 16.5.5 on Windows and configuring Outbound Enabler
8. Update the Relay Server configuration for Microsoft IIS on Windows
For each computer that belongs to the Relay Server farm you are updating:
Copy the updated rs.config configuration file to the "..\relayserver\IIS\Bin64" directory under the
Relay Server web site home directory.
Figure 10 Update of the Relay Server with the new configuration file "rs.config"
Sample for rs.config
#------------------------------------# Relay server options
#------------------------------------[options]
verbosity = 4
#-------------------# Relay server peers
#-------------------[relay_server]
enable
= yes
host
= 192.168.28.25
http_port
= 80
https_port
= 443
description = Machine #1 in RS farm
#--------------# Backend farms
#--------------[backend_farm]
id
= smp3.new.MLFarm
verbosity
=4
description = SMP 3 Testfarm
#----------------# Backend servers
#----------------[backend_server]
farm
= smp3.new.MLFarm
id
= MLServer01
enable = yes
verbosity = inherit
token = a1b2c3d4
How-to install Relay Server 16.5.5 on Windows and configuring Outbound Enabler
9. Run net start w3svc to start the IIS Relay Server, net stop w3svc to stop it.
The Relay Server log file is created under RSfiles\relayserver\iis\bin64\Log.
Figure 11 Relay Server log
RELAY SERVER STATUS REQUEST
10. Verification if the Relay Server is running and the farm is available.
In a Web browser, check the Relay Server status using the following URL:
http://localhost/rs16.5/server/rs.dll/<<farmId>>
Figure 12 Relay Server Farm status page
11. Perform Relay Server administration using the following URL:
http://localhost/rs16.5/admin/rs.dll
Figure 13 Relay Server Admin status page
Note: The Relay Server version is only visible using the administration status request!
How-to install Relay Server 16.5.5 on Windows and configuring Outbound Enabler
CONFIGURING OUTBOUND ENABLER TO WORK WITH SAP MOBILE PLATFORM SERVERS
1. Locate the dbsvc utility executable (dbsvc.exe on Windows) in the SAP Mobile Platform Server
installation tree.
Windows – <SMP_HOME>\Server\db\sa\smp3\win32\Bin64\dbsvc.exe.
Figure 14 Locate the dbsvc utility
2. Set a temporary environment variable SQLANY16 to the RSOE location
Figure 15 Set the temporary SQLANY16 environment variable
3. Run the Relay Server's Service utility to set up each outbound enabler to start automatically as a
service.
To set up an auto-started outbound enabler service named oes (Outbound Enabler service) on IIS
host on Windows from command-line the dbsvc.exe from the "..\smp3\win32\Bin64" needs to be
executed:
dbsvc -as -s auto -w oes "%SQLANY16%\rsoe2.exe"
-cr "host=<host_name_or_IPaddress>; port=<host_port>;
url_suffix=/rs16.5/server/rs.dll"
-cs "host=localhost;port=80"
-f <farm_name> -id <farm id> -t <token>
How-to install Relay Server 16.5.5 on Windows and configuring Outbound Enabler
Figure 16 Run the dbsvc to create the Outbound Enabler service
Figure 17 Start the new Outbound Enabler service
4. To set up an auto-started outbound enabler service named oes (Outbound Enabler service) on IIS
host on Windows to connect to a Relay Server farm without Load Balancer both Relay Server hosts
has to be added to the dbsvc command.
In this example the Outbound Enabler connects to a Relay Server farm containing RS1 and RS2:
dbsvc -as -w oes "%SQLANY16%\rsoe2.exe"
-cr "host=RS1; port=<host_port>; url_suffix=/rs16.5/server/rs.dll;
host=RS2; port=<host_port>; url_suffix=/rs16.5/server/rs.dll "
-cs "host=localhost;port=80"
-f <farm_name> -id <farm id> -t <token>
5. To set up an auto-started outbound enabler service named oes (Outbound Enabler service) on IIS
host on Windows specifying the Outbound Enabler parameters in a command file:
a) Create a new file "oe.config" in the "%SQLANY16%" directory.
Example for the oe.config:
-t rsoe2
-cr "host=<host_name_or_IPaddress>; port=<host_port>; url_suffix=/rs16.5/server/rs.dll"
-cs "host=localhost;port=80"
-f <farm_name>
-id <server_name>
-o <your path>\rsoe2.log
b) Run the dbsvc.exe from the "..\smp3\win32\Bin64" with the following command:
dbsvc -as -s auto -w oes "%SQLANY16%\rsoe2.exe" @%SQLANY16%\oe.config
c) Using the oe.config the oes parameters can be modified easily without accessing the registry.
How-to install Relay Server 16.5.5 on Windows and configuring Outbound Enabler
LOGGING
The Relay Server and Outbound Enabler logging can be enhanced and extended, primarily for
maintenance and/or debugging purposes.
1. Relay Server
Please look at "Configuring a Relay Server" for the complete configuration options.
The most important would be the verbosity and log size limit as shown below:
#------------------------------------# Relay server options
#------------------------------------[options]
verbosity = 4
log_size_limit = 10M
Verbosity:
0 (Default) Log errors only. Use this logging level for deployment.
1 Request logging. All HTTP requests are written to the Relay Server log file.
2 Request logging. Provides a more detailed view of HTTP requests.
3 or higher(up to 5) Detailed logging. Used primarily for Technical Support.
Log size limit:
Sets the maximum size of the Relay Server log file. The supported units are: k, K, m, M, g, and G.
The default value is 0 (no limit).
2. Outbound Enabler
Please look at "Relay Server Outbound Enabler syntax" for the complete configuration options.
The most important additional options would be the verbosity, log size and log maintenance.
Example for the oe.config:
-v 9
-t rsoe2
-cr "host=<host_name_or_IPaddress>; port=<host_port>; url_suffix=/rs16.5/server/rs.dll"
-cs "host=localhost;port=80"
-f <farm_name>
-id <server_name>
-o D:\rsoe2.log
-os 10MB
-v
-o file
-os size
-ot file
Verbosity(same values as for the Relay Server; 0 - 5)
Specifies the file to log output messages to.
Sets the maximum size of the message log files. The minimum size limit is 10 KB.
Truncates the specified log file and logs messages to it.
www.sap.com
© 2015 SAP AG. All rights reserved.
SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP
BusinessObjects Explorer, StreamWork, SAP HANA, and other SAP
products and services mentioned herein as well as their respective
logos are trademarks or registered trademarks of SAP AG in Germany
and other countries.
Business Objects and the Business Objects logo, BusinessObjects,
Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and
other Business Objects products and services mentioned herein as
well as their respective logos are trademarks or registered trademarks
of Business Objects Software Ltd. Business Objects is an SAP
company.
Sybase and Adaptive Server, iAnywhere, Sybase 365, SQL
Anywhere, and other Sybase products and services mentioned herein
as well as their respective logos are trademarks or registered
trademarks of Sybase Inc. Sybase is an SAP company.
Crossgate, m@gic EDDY, B2B 360°, and B2B 360° Services are
registered trademarks of Crossgate AG in Germany and other
countries. Crossgate is an SAP company.
All other product and service names mentioned are the trademarks of
their respective companies. Data contained in this document serves
informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials
are provided by SAP AG and its affiliated companies ("SAP Group")
for informational purposes only, without representation or warranty of
any kind, and SAP Group shall not be liable for errors or omissions
with respect to the materials. The only warranties for SAP Group
products and services are those that are set forth in the express
warranty statements accompanying such products and services, if
any. Nothing herein should be construed as constituting an additional
warranty.