Config Tool

Config Tool Overview

This tool provides an easy way to add and configure SAP J2EE Engine 6.20 cluster elements. In addition, you can set and use SAP J2EE Engine 6.20 in background mode as a Windows NT/2000 Service or a Daemon on Unix-like platforms. Config Tool can be used without a running SAP J2EE Engine 6.20. The only requirement is to have the server installed on the local machine.

Note : Config Tool is XML-based, which enables third-party visualizations to be developed or integrated as part of a more complicated configuration system. For more information, refer to the Development Manual .

Configuring SAP J2EE Engine 6.20 Managers and Services

Server Configuration

SAP J2EE Engine 6.20 Config Tool enables the modification of service or manager module properties. The current server configuration is detected automatically and displayed immediately after running the tool.

Cluster Installation Mode

To load another server configuration, you must specify the directory where SAP J2EE Engine 6.20 has been installed by choosing the File ® Scan… command, or on the toolbar.

A tree structure is displayed in the left-hand tab of the window. The main section of the tree is the SAP J2EE Engine 6.20 cluster – . If the Setup type is “alone” (for stand-alone version of SAP J2EE Engine 6.20), the “alone” ( ) configuration is displayed.

There are two subsections for each cluster node – managers ( ) and services ( ). They contain a list of managers ( ) and services ( ) running on the cluster nodes. When a module is selected, its properties are displayed in the right-hand tab of the Config Tool frame.

Modifying Configuration Properties

When a particular service or manager is selected, its properties are displayed with their keys and values in the right-hand tab of the window.

Changing Module Properties

To modify a property, first select it. Its key and value are shown in the corresponding text fields at the bottom of the pane, and can be modified.

To add a new property, type its key and value and select “Add” to append it to the list of available properties. To remove one, select it and delete it by choosing “Remove”.

Note: For information on SAP J2EE Engine 6.20 module properties, refer to the Managers Administration Reference and Services Administration Reference sections in this manual.

Exporting and Applying Configuration

To apply the changes, select File ® Apply, or on the toolbar. You can also save the configuration in an XML file by choosing File ® Export properties to XML…, or on the toolbar.

Adding Nodes to SAP J2EE Engine 6.20 Cluster

The Config Tool enables you to add dispatcher and server nodes to the SAP J2EE Engine 6.20 Cluster. This option is available only for cluster installation mode.

Adding Cluster Nodes

A new node can be added using the New menu. To specify the type of the cluster node to be added, select either New Dispatcher or New Server ( or on the toolbar respectively). A dialog box appears. Choose a name for the new cluster element from a list of available options. For server elements, you can choose whether the application data on the primary server, which is already running in the cluster, should be copied to the new server. It is recommended that the application data be cleared by selecting the “Clear all application data” option, which starts the AppClear Tool.

If the new cluster node is added successfully, the Config Tool window displays the updates. The new cluster node is displayed along with the managers and services running on it. Their properties can be modified as described in the Managers Administration Reference and Services Administration Reference sections in this manual.

New Cluster Node has been Added Successfully

Critical Information and Troubleshooting Tips

You cannot run a cluster without a primary server. Attempts to start a cluster consisting of a dispatcher and non-primary server node will fail. To set non-primary server nodes as primary elements, set the “Primary element” indicator.

SAP J2EE Engine 6.20 as an NT/2000 Service or a Unix Daemon

SAP J2EE Engine 6.20 can be run as a Windows NT/2000 Service or a Daemon on Unix-like platforms. The task of this service is to run SAP J2EE Engine 6.20 in background mode, thus increasing security and providing for optional reboot on startup. The server can be run either as a cluster or as a stand-alone version.

When the cluster version is chosen, each cluster node is set to run separately in background mode. In this case, it is important that at least one dispatcher node is set to run in background mode; otherwise, the SAP J2EE Engine 6.20 system cannot function properly.

When SAP J2EE Engine 6.20 is set to run in background mode, it can be accessed using Telnet. The console output is available in the corresponding log files.

To set a cluster node to run as an NT/2000 Service or a Unix Daemon, the following steps must be performed:

Step 1 . Select the “NT Service” tab of the frame and set the “Enabled” indicator.

Setting a Node to Run in Background Mode

Java Path must be specified. This is the path to the Java home directory.
Shutdown port must be specified. The cluster element listens to this port for a request to shut down. Make sure that the specified port is not already in use.
Shutdown timeout has a default value 10000 but it can be modified. When the service stops its process, there is a timeout period (in milliseconds), after which the cluster element is shut down.
Java parameters for starting cluster elements as a NT service. You can configure them using this field.

Step 2 . To apply the changes, choose File ® Apply or on the toolbar. The settings are saved to service.ini file in the configtool subdirectory of SAP J2EE Engine 6.20 installation directory. This file has the following format:

ServiceCount=2

Service_0_Name=cluster\dispatcher
Service_0_RootDir=C:\SAP_J2EEngine6.20 b3\cluster\dispatcher
Service_0_JavaPath=C:\jdk\jdk1.3.1\
Service_0_JavaParameters=-classpath ".;./system-lib/boot.jar;./system-lib/jndi1.2.jar;./system-lib/iiop.jar;./system-lib/jaas.jar"
-Djava.library.path=..\..\tools\r3startup

-Djava.security.policy=.\\java.policy
-Dorg.omg.CORBA.ORBClass=com.inqmy.services.iiop.internal.ORB
-Dorg.omg.CORBA.ORBSingletonClass=com.inqmy.services.iiop.internal
.ORB
-Djavax.rmi.CORBA.PortableRemoteObjectClass=com.inqmy.system.Porta
bleRemoteObjectProxy
-Djavax.rmi.CORBA.UtilClass=com.inqmy.system.UtilDelegateProxy
Service_0_MainClass=com.inqmy.boot.Start
Service_0_Paramaters=
Service_0_Port=5501
Service_0_Timeout=10000

Service_1_Name=cluster\server
Service_1_RootDir=C:\ SAP_J2EEngine6.20 b3\cluster\server
Service_1_JavaPath=C:\jdk\jdk1.3.1\
Service_1_JavaParameters=-classpath ".;./system-lib/boot.jar;./system-lib/jndi1.2.jar;./system-lib/iiop.jar;./system-lib/jaas.jar"
-Djava.security.policy=.\\java.policy
-Dorg.omg.CORBA.ORBClass=com.inqmy.services.iiop.internal.ORB
-Dorg.omg.CORBA.ORBSingletonClass=com.inqmy.services.iiop.internal
.ORB
-Djavax.rmi.CORBA.PortableRemoteObjectClass\=com.inqmy.system.Por
tableRemoteObjectProxy
-Djavax.rmi.CORBA.UtilClass\=com.inqmy.system.UtilDelegateProxy
Service_1_MainClass=com.inqmy.boot.Start
Service_1_Paramaters=
Service_1_Port=5561
Service_1_Timeout=10000

According to this example, the SAP J2EE Engine 6.20 system to be run in background mode consists of one dispatcher and one server node. A detailed description of each field is provided below:

ServiceCount – the number of SAP J2EE Engine 6.20 nodes to be started in background mode. Indices of these nodes are in the range [ 0 , ServiceCount-1 ].
Service_i_Name – a mnemonic name of this element
Service_i_RootDir – the directory where the specified cluster element is installed
Service_i_JavaPath – contains the classpath to JDK directory
Service_i_JavaParameters – contains additional parameters to be passed to JVM
Service_i_MainClass – the main class to run
Service_i_Parameters – main class input parameters, if needed. In this case, no parameters are specified
Service_i_Port – port to be used when shutting this element down. When the operating system sends a signal for shutdown, the program sends a specially generated random key to this port. The key is generated when this element is started and the same key is used at shutdown for verification. The program waits until specified timeout passes. After the timeout, if the element is still running, it is forced to shut down.
Service_i_Timeout – this timeout is used when the element is shut down. It specifies the time (in milliseconds) after which the element is stopped by the system if it has failed to shut down.

Step 3 . Start SAP J2EE Engine 6.20 in background mode according to the operating system on which SAP J2EE Engine 6.20 system runs.

Windows NT/2000

Start Service.exe , which is in the configtool subdirectory of SAP J2EE Engine 6.20 installation directory. It works with three parameters:

Service.exe –install – the service(s) is (are) registered as NT/2000 Service(s). For each specified cluster node, a separate service is generated. All services have startup mode automatic . To start the service(s), open the Control Panel ®Services folder. Find the service in the list of available services (for example: SAP J2EE Server 1 , SAP J2EE Dispatcher 1 , SAP J2EE Server 2 , and so on). Select it, and choose “Start” on the right-hand side. No “Startup Parameters” are needed for the service to run. The system starts the particular SAP J2EE Engine 6.20 node in background mode. It can be used and administered as usual. The only difference is that the server does not run in a console window.
Service.exe –remove – used to remove SAP J2EE Engine 6.20 from the list of available NT/2000 Services
Service.exe –debug – used to run the service as a console application for debugging

Note: Service.exe cannot be run within a 4NT™ DOS console. Start the service in another DOS console window.

Unix-Like Platforms

Open a console in the directory where Config Tool is installed. To start SAP J2EE Engine 6.20 as a Unix Daemon, enter:

unixdaemon –start

This command starts the SAP J2EE Engine 6.20 system in background mode. It uses service.ini file to obtain the parameters of the cluster nodes.

To stop SAP J2EE Engine 6.20 running as a Unix Daemon, enter:

unixdaemon –stop

Note: The following points should be considered when running the server as an NT Service or Unix Daemon:

1. When Config Tool is started, the “Java parameters” field is loaded from the cmdline.properties file, located in the directory of the corresponding cluster element.

2. When the “NT Service” (“Daemon” for Unix) indicator is set, the “Apply” command modifies the service.ini file, as described above.

3. When the “NT Service” (“Daemon” for Unix) indicator is not set, the “Apply” command erases the information for this cluster element in the service.ini file.

4. Config Tool modifies only service.ini . To specify some new properties permanently, you must modify the corresponding cmdline.properties .

SAP J2EE Engine 6.20 in Remote Debug Mode

SAP J2EE Engine 6.20 Config Tool enables you to run the server in remote debug mode. This task can be performed on Stand-alone configuration or on server nodes of SAP J2EE Engine 6.20 Cluster. This section concerns the Cluster configuration; the Stand-alone is similar. To run the server node in remote debug mode, complete the following steps:

Step 1 . On a selected server node, choose the “Debug” tab of the frame displayed, and set the “Enabled” indicator.

Setting the Server Node in Debug Mode

To run the cluster element in remote debug mode, you must set additional parameters to the Virtual Machine. One of them is the debug port that enables debugger clients connections. Therefore, the next step is:

Step 2 . In the “Debug port” field type a number corresponding to the port that you want to set for debugger client connections.

This port is opened by the Virtual Machine and must not be among the ports that SAP J2EE Engine uses.

The cluster element remote debug performance is paused until a remote debugger client connects to the system. This client must be JPDA compatible.