admin manual

Administration Manual

SAP J2EE Engine 6.20



ContentsAbout This Manual ...................................................................................... 10 Target Audience and Prerequisites........................................................... 10 Structure ............................................................................................... 10 Documentation Conventions.................................................................... 11 Further Reading ..................................................................................... 11 Administration Tools ................................................................................... 12 Overview.................................................................................................... 13 Visual Administrator .................................................................................... 14 Logging on to SAP J2EE Engine 6.20........................................................ 14 Visual Administrator Utilities .................................................................... 14 Cluster View with the Visual Administrator Tool......................................... 18 Shell Console Administrator ......................................................................... 19 Cluster Management with the Console Administrator Tool .......................... 19 Property Files Administration........................................................................ 20 Config Tool ................................................................................................ 21 Config Tool Overview ............................................................................. 21 Configuring SAP J2EE Engine 6.20 Managers and Services ......................... 21 Adding Nodes to SAP J2EE Engine 6.20 Cluster......................................... 22 Removing Nodes from SAP J2EE Engine 6.20 Cluster................................. 24 SAP J2EE Engine 6.20 as an NT/2000 Service or a UNIX/Linux Daemon ...... 24 Configuring Cluster Elements with Identical Names in Different Clusters as Separate NT Services ............................................................................. 27 SAP J2EE Engine 6.20 in Remote Debug Mode.......................................... 28 Console Config Tool .................................................................................... 30 Overview............................................................................................... 30 Description of Console Config Tool Functions............................................ 30 Deployment Tools ....................................................................................... 34 LogViewer Tool........................................................................................... 35 Introduction .......................................................................................... 35 Viewing Logs ......................................................................................... 36 Configuration ......................................................................................... 36 Appclear Tool ............................................................................................. 48 DBTool....................................................................................................... 49 DBTool Overview ................................................................................... 49

2/336



DBTOOL.XML......................................................................................... 49 Library Tool................................................................................................ 54 RMIC Tool .................................................................................................. 55 GUI RMIC Tool....................................................................................... 55 Console RMIC Tool ................................................................................. 56 ShutDown Tool........................................................................................... 57 User Tool ................................................................................................... 58 User Tool Overview ................................................................................ 58 XML Structure for User Tool .................................................................... 58 Analyze Tool............................................................................................... 59 Analyze Tool Overview............................................................................ 59 Administration of SAP J2EE Engine 6.20 Cluster......................................... 60 Overview.................................................................................................... 61 J2EE Engine Cluster Concepts ...................................................................... 62 Introduction .......................................................................................... 62 Why Working in a Cluster? ...................................................................... 64 Mechanisms for Automatic Restarts in Case of Cluster Node Failures .......... 64 Cluster Startup....................................................................................... 64 Cluster Life-Cycle ................................................................................... 67 Cluster Size Restrictions.......................................................................... 68 Synchronization of Libraries and Applications Within the Cluster ................. 68 Adding Nodes to SAP J2EE Engine 6.20 Cluster ............................................. 71 Creating Cluster Nodes ........................................................................... 71 Configuring the Additional Nodes............................................................. 72 Configuring the J2EE Engine Cluster ............................................................. 74 Configuring a Dispatcher Node to Distribute Requests Only to the Local Application Nodes .................................................................................. 74 Tuning the Cluster Nodes to Detect Network Disconnection ....................... 74 Detecting Failures Within the Cluster ....................................................... 76 Triggering a Restart of the Cluster Nodes ................................................. 78 Managing the Load Balancing System ...................................................... 78 Configuring a Cluster When Multiple LAN Adapters are Available (Windows) 79 Administration of SAP J2EE Engine 6.20 Stand-Alone Version ................... 80 Overview.................................................................................................... 81 Stand-Alone Server Services and Managers ................................................... 82 Stand-Alone Server Administration and Application Deployment ...................... 83 Configuration Tasks..................................................................................... 84 Overview.................................................................................................... 85 3/336



Configuration of Additional Libraries ............................................................. 86 System-Lib ............................................................................................ 86 Lib ........................................................................................................ 86 Additional-Lib......................................................................................... 86 How to Set up SAP J2EE Engine 6.20 Web Server .......................................... 91 Setting Ports.......................................................................................... 91 Setting Various Virtual Hosts on One Server ............................................. 92 Caching................................................................................................. 93 Mime Types ........................................................................................... 94 Log Files................................................................................................ 94 Setting Security Constraints .................................................................... 95 Using the Log System and Monitoring ........................................................... 97 Log System ........................................................................................... 97 Monitoring ............................................................................................. 99 Managing Security .................................................................................... 117 Architecture......................................................................................... 117 Integration .......................................................................................... 117 Login to SAP J2EE Engine ..................................................................... 118 Features.............................................................................................. 119 Tasks .................................................................................................. 120 Login .................................................................................................. 120 Users and Groups................................................................................. 122 Managing SSL Connections ................................................................... 124 Remote Administration Using Telnet ........................................................... 127 Overview............................................................................................. 127 How to Connect and Work Using Telnet ................................................. 127 Connecting Internet Information Server to SAP J2EE Engine 6.20 ................. 129 Running Apache Web Server with SAP J2EE Engine 6.20 ............................. 130 Configuring Apache Web Server ............................................................ 130 Setting up SAP J2EE Engine 6.20 for Application Tracing .............................. 132 Setting SAP J2EE Engine Tracing Mode .................................................. 132 Traced Components ............................................................................. 133 Setting up SAP J2EE Engine 6.20 for Remote Debugging .............................. 134 General Debugging............................................................................... 134 Debugging in a Cluster ......................................................................... 134 Configuration of Debug Nodes via the Config Tool................................... 135 Managers Administration Reference ......................................................... 136 Classloader Manager ................................................................................. 137 4/336



Visual Administrator ............................................................................. 137 Cluster Manager ....................................................................................... 138 Visual Administrator ............................................................................. 138 Critical Information and Troubleshooting Tips ......................................... 143 Connections Manipulator Manager .............................................................. 144 Visual Administrator ............................................................................. 144 Critical Information and Troubleshooting Tips ......................................... 145 File Manager ............................................................................................ 146 Visual Administrator ............................................................................. 146 IpVerification Manager .............................................................................. 147 Visual Administrator ............................................................................. 147 Critical Information and Troubleshooting Tips ......................................... 147 Lock Manager........................................................................................... 149 Visual Administrator ............................................................................. 149 Log Manager ............................................................................................ 151 Visual Administrator ............................................................................. 151 Memory Manager...................................................................................... 154 Policy Manager ......................................................................................... 155 Visual Administrator ............................................................................. 155 Pool Manager ........................................................................................... 156 Visual Administrator ............................................................................. 156 Ports Manager .......................................................................................... 157 Visual Administrator ............................................................................. 157 R3Startup Manager ................................................................................... 158 Visual Administrator ............................................................................. 158 Service Manager ....................................................................................... 160 Visual Administrator ............................................................................. 160 Swap Manager.......................................................................................... 162 Visual Administrator ............................................................................. 162 Critical Information and Troubleshooting Tips ......................................... 163 SystemThread Manager............................................................................. 164 Visual Administrator ............................................................................. 164 Thread Manager ....................................................................................... 165 Visual Administrator ............................................................................. 165 Critical Information and Troubleshooting Tips ......................................... 167 Timeout Manager...................................................................................... 168 Visual Administrator ............................................................................. 168 Critical Information and Troubleshooting Tips ......................................... 169 5/336



Services Administration Reference ........................................................... 170 Admin Service .......................................................................................... 171 Visual Administrator ............................................................................. 171 Critical Information and Troubleshooting Tips ......................................... 171 Ageing Service.......................................................................................... 172 Visual Administrator ............................................................................. 172 Appclient Service ...................................................................................... 174 Visual Administrator ............................................................................. 174 Console Administrator........................................................................... 174 DBMS Service ........................................................................................... 175 Visual Administrator ............................................................................. 175 Console Administrator........................................................................... 176 Critical Information and Troubleshooting Tips ......................................... 176 DBPool Service ......................................................................................... 177 Visual Administrator ............................................................................. 177 Console Administrator........................................................................... 178 Critical Information and Troubleshooting Tips ......................................... 179 Deploy Service.......................................................................................... 180 Visual Administrator ............................................................................. 180 Console Administrator........................................................................... 181 EISConnector Service ................................................................................ 182 Visual Administrator ............................................................................. 182 Critical Information and Troubleshooting Tips ......................................... 186 EJB Service .............................................................................................. 189 Visual Administrator ............................................................................. 189 EJB20 Service........................................................................................... 190 Visual Administrator ............................................................................. 190 Console Administrator........................................................................... 190 File Service............................................................................................... 192 Visual Administrator ............................................................................. 192 HTTP Service............................................................................................ 193 Visual Administrator ............................................................................. 193 Console Administrator........................................................................... 198 Critical Information and Troubleshooting Tips ......................................... 198 HTTP Heartbeat Service ............................................................................ 202 Integration .......................................................................................... 202 Visual Administrator ............................................................................. 202 HTTP Tunneling Service ............................................................................ 204 6/336



Visual Administrator ............................................................................. 204 IIOP Service ............................................................................................. 205 Visual Administrator ............................................................................. 205 JavaMail Service ....................................................................................... 206 Visual Administrator ............................................................................. 206 JMS Service.............................................................................................. 207 Visual Administrator ............................................................................. 207 Console Administrator........................................................................... 209 Critical Information and Troubleshooting Tips ......................................... 209 Keystore Service ....................................................................................... 210 Visual Administrator ............................................................................. 210 Console Administrator........................................................................... 211 Critical Information and Troubleshooting Tips ......................................... 211 Log Viewer Service.................................................................................... 213 Leakdetector Service ................................................................................. 214 Visual Administrator ............................................................................. 214 Log Service .............................................................................................. 215 Visual Administrator ............................................................................. 215 Console Administrator........................................................................... 218 Monitor Service......................................................................................... 219 Visual Administrator ............................................................................. 219 Console Administrator........................................................................... 220 Naming Service ........................................................................................ 221 Visual Administrator ............................................................................. 221 Console Administrator........................................................................... 222 Critical Information and Troubleshooting Tips ......................................... 222 P4 Service ................................................................................................ 223 Visual Administrator ............................................................................. 223 R3Startup Service ..................................................................................... 224 Visual Administrator ............................................................................. 224 RFC Engine Service ................................................................................... 226 Visual Administrator ............................................................................. 226 Runtime Info Service................................................................................. 228 Visual Administrator ............................................................................. 228 Security Service ........................................................................................ 229 Visual Administrator ............................................................................. 229 Console Administrator........................................................................... 237 Critical Information and Troubleshooting Tips ......................................... 238 7/336



Servlet_jsp Service.................................................................................... 239 Visual Administrator ............................................................................. 239 Console Administrator........................................................................... 241 Property Files....................................................................................... 241 Critical Information and Troubleshooting Tips ......................................... 241 Shell Service............................................................................................. 247 Visual Administrator ............................................................................. 247 SSL Service .............................................................................................. 248 Visual Administrator ............................................................................. 249 Critical Information and Troubleshooting Tips ......................................... 250 Telnet Service........................................................................................... 252 Visual Administrator ............................................................................. 252 Transaction Service................................................................................... 253 Visual Administrator ............................................................................. 253 Shell Commands Reference ....................................................................... 255 Administration .......................................................................................... 256 Shell Language Conventions.................................................................. 256 Help.................................................................................................... 256 Adding a Group of Commands............................................................... 256 System Variables.................................................................................. 257 ADMIN ................................................................................................ 257 DEBUG................................................................................................ 262 HTTP .................................................................................................. 263 KEYSTORE........................................................................................... 263 LOG .................................................................................................... 264 MONITOR............................................................................................ 265 R3STARTUP......................................................................................... 265 SSL ..................................................................................................... 266 SYSTEM .............................................................................................. 267 Application Nodes and State Controller ....................................................... 273 ADMIN ................................................................................................ 273 APPCLIENT .......................................................................................... 278 DBMS.................................................................................................. 279 DBPOOL .............................................................................................. 280 DEBUG................................................................................................ 287 DEPLOY .............................................................................................. 288 EISCONNECTOR................................................................................... 292 EJB20 ................................................................................................. 296 8/336



HTTP .................................................................................................. 299 JMS .................................................................................................... 300 KEYSTORE........................................................................................... 300 LOG .................................................................................................... 302 LOGIN................................................................................................. 303 MONITOR............................................................................................ 304 NAMING .............................................................................................. 305 INTEGRATION ..................................................................................... 311 POLICY ............................................................................................... 313 RESOURCE .......................................................................................... 314 SERVLET_JSP ...................................................................................... 317 SYSTEM .............................................................................................. 317 USERS................................................................................................. 322 Shell Language Description ........................................................................ 324 The Backus-Naur MetaLanguage ........................................................... 324 Property Files Reference ........................................................................... 329 Overview.................................................................................................. 330 General Properties .................................................................................... 331 Dispatcher Node .................................................................................. 331 Application Node and State Controller .................................................... 331 Module Properties ..................................................................................... 332 Dispatcher Node .................................................................................. 332 Application Node and State Controller .................................................... 334

9/336



About This ManualThis Administration Manual is a guide for the initial and runtime configuration of SAP J2EE Engine 6.20. It introduces application server administration tools and provides comprehensive information and troubleshooting tips on specific points of SAP J2EE Engine 6.20 administration.

Target Audience and PrerequisitesThe Administration Manual is addressed to system administrators whose task is the initial configuration and further maintenance of SAP J2EE Engine 6.20 System. This section must also be considered by administrators and developers who perform deployment tasks and runtime administration of the system. This manual assumes that you are familiar with the following topics: The Internet and the World Wide Web Java programming language J2EE specification

StructureThe contents of this manual is organized into several subsections, as described below:

Administration ToolsThis section introduces the tools provided for administration of SAP J2EE Engine 6.20. It provides detailed description of the Visual Administrator tool, Console Administrator tool, Config Tool, and Property Files.

Administration of SAP J2EE Engine 6.20 ClusterThis section presents an overview of fundamental clustering concepts implemented in SAP J2EE Engine 6.20. It also describes the general requirements for cluster configuration, how to add nodes to the cluster, and how to administer it with the tools provided.

Administration of SAP J2EE Engine 6.20 Stand-Alone VersionThis section provides an overview of SAP J2EE Engine 6.20 Stand-Alone Version concepts, and guidelines for its administration.

Configuration TasksThis section provides information on typical administration tasks.

Managers Administration ReferenceThis section provides information about general and SAP J2EE Engine manager-specific properties, critical information, and troubleshooting tips. The section on manager-specific properties describes how to set the properties by using the Visual Administrator tool and how to use the manager-specific Console Administrator options.

10/336



Services Administration ReferenceThis section provides information about general and SAP J2EE Engine service-specific properties, critical information, and troubleshooting tips. The section on service-specific properties describes how to set the properties by using the Visual Administrator tool and how to use the service-specific Console Administrator options.

Shell Commands ReferenceThis section contains a full description of all SAP J2EE Engine 6.20 Shell language commands, their syntax, properties, and example usage.

Property Files ReferenceThis section contains information about the content of SAP J2EE Engine 6.20 property files.

Documentation ConventionsThe following font styles are used in SAP J2EE Engine 6.20 documentation to denote specific text expressions, words, and so on: Italic style Used for file and directory names, system paths, and so on. File and directory paths are given in Windows format (with backslashes separating directory names). For UNIX/Linux platforms, the directory paths are the same, except that slashes are used instead of backslashes to separate directories. Example: Monospaced font

java.exe, ../cluster/dispatcher/managers/framework.properties

Service_0_Name=cluster\dispatcher Service_0_RootDir=C:\SAP_J2EEngine6.20_SP2\cluster\dispatcher Service_0_JavaPath=C:\jdk\1.3\bin

This font denotes Java source code or contents of any other specific file. Examples:

Further ReadingFor information on SAP J2EE Engine 6.20 functions, refer to the following documents: Getting Started Development Manual Deployment Manual The official specifications on J2EE can be found at: http://java.sun.com/

11/336



Chapter

1

Administration Tools Overview Visual Administrator Shell Console Administration Property Files Administration Config Tool Console Config Tool Deployment Tools Log Viewer Tool Appclear Tool DBTool Library Tool RMIC Tool ShutDown Tool User Tool Analyze Tool

12/336



OverviewThe job of an administrator covers several tasks: Configuration the setting up of the system, both initial and runtime Initial administration of services and managers Managing security Runtime administration and control of services and managers Deployment of applications and additional libraries Managing the log system

SAP J2EE Engine 6.20 provides three basic tools for administration Visual Administrator, Console Administrator, and Config Tool (both Visual and Console). SAP J2EE Engine 6.20 modules can be also configured by setting properties in the corresponding Property Files. In addition, DBTool, Library Tool, RMIC Tool, Shutdown Tool, and User Tool provide specific functions for the runtime administration of particular modules. Note: SAP J2EE Engine 6.20 tools run on all platforms supported by SAP Web Application Server.

13/336



Visual AdministratorThe SAP J2EE Engine 6.20 Visual Administrator is a graphical user interface (GUI) that enables the administration of the whole cluster, of the cluster nodes, and all modules running on them. The Visual Administrator is written in the Java programming language and can be run in any environment where a Java Virtual Machine is available. It enables remote monitoring and management of the cluster, and for each cluster element, and enables the system administrator to monitor all managers and services working on each node in a single GUI. The current limitation, in terms of size, for a cluster which can be administered with the Visual Administrator is eight nodes. When you have more, use the Telnet as an alternative. The Visual Administrator includes functions for: Obtaining general information about a service or manager (for example, its name, group, and so on) Administering and changing the properties either specific or common for each service or manager Runtime administration and control Deployment of applications on all cluster elements Log viewing

Logging on to SAP J2EE Engine 6.20To connect to SAP J2EE Engine 6.20, the following parameters must be specified in the Login dialog box: User Name a valid user name (case insensitive) must be specified. The default value is Administrator. Password a user password. The default value is (empty string). Host host name or IP address. The default value is localhost. Port server port for connection (RMI). The default value is 3011. Connect connects the user to the server. The server must be started before trying to connect to it. Cancel cancels the operation and closes the dialog box. Transport layers the available modes are o No layer the connection is done using RMI/P4 protocol. This is the default mode. o HTTP Tunneling this enables communication through proxies and firewalls. If HTTP Tunneling is used, Proxy Host and Port must be specified using the Settings option. The default Proxy Port is 3080. o SSL SSL protocol provides privacy and reliability of communication between applications over the Internet using cryptographic security. The default port is 3044. When Visual Administrator is started for the first time, the fields of the Login dialog box contain the default values. Each time Visual Administrator is started, the last-known values for User Name, Host, and Port are displayed.

Visual Administrator UtilitiesVisual Administrator utilities enable you to obtain general information about services and managers, setting the properties, runtime control, and log viewing.

14/336



General UtilitiesMain Menu and Toolbar The main menu provides the following options: Connect on the toolbar) connects the user to the server. o Login ( on the toolbar) disconnects the user from the server. o Logout ( o Exit ( on the toolbar) closes the SAP J2EE Engine 6.20 Visual Administrator. View on the toolbar) shows the cluster elements, managers and o Tab View ( services in three tabs. on the toolbar) shows the cluster elements with their o Cluster View ( managers and services. on the toolbar) shows all managers and services. o Element View ( on the toolbar) expands the tree in the selected tab. o Expand ( on the toolbar) collapses the tree in the selected tab. o Collapse ( on the toolbar). The Tools This menu contains a single command Properties ( following properties can be set: o Ping Time (ms) the ping time in milliseconds. This is the interval at which the Visual Administrator checks if the connection with SAP J2EE Engine is still alive. The default value is 1500. o Status msg history the number of messages in the Status bar. The default value is 20. o Statistics pooling interval (ms) the interval (in milliseconds) at which the diagrams and statistics is refreshed. The default value is 1500. o LogViewer Ping Time (ms) the Log Viewer ping time in milliseconds. The default value is 1500. o HTML Browser the browser used to visualize the help topics o Look and Feels displays the installed look-and-feel and the one in use. The Look and Feel of the GUI can be changed by selecting one of the available modes: Metal, CDE/Motif, or Windows. A new Look and Feel can be added by specifying its name and class that extends the standard javax.swing.LookAndFeel. The default mode is Metal. Help on the toolbar) opens a help topic using the HTML Browser o Help Topic ( specified in the Tools Properties menu. o About opens a window with information about the SAP J2EE Engine. The same operation can be performed by using the Shift + F1 key combination. The toolbar provides additional options for administration of the cluster nodes: (Shut Down) Shuts down the selected cluster node.

(Mark for Shut down) Marks the selected application node for shut down. (Start service) Starts the selected service. According to the chosen view, this options starts the service either on the selected cluster node or on all cluster nodes. (Stop service) Stops the selected service. According to the chosen view, this options stops the service either on the selected cluster node or on all cluster nodes. (Save Properties) Saves the properties that were changed in the Properties or in the Control Descriptor tab. (Reset Properties) Resets the properties from the last change.

15/336



Status Bar The Status bar provides information about the system events. Provides detailed information about system events

Module InformationThe Control Descriptor tab provides the following subtabs with information about each service. General This tab provides general information about the SAP J2EE Engine 6.20 services. The tab contains the following fields: Service Name the service name cannot be changed Display Name sets a name defined by the user Service Group refers to services visual representation only Server Frame Class Name and Dispatcher Frame Class Name the main service classes. If the service is an application, the Server Frame Class Name must be specified. If it is a session service, the Server Frame Class Name and the Dispatcher Frame Class Name must be specified. Startup Mode: o ALWAYS the service is started always when the J2EE Engine is started o AUTOMATIC the service is started when another service invokes it o MANUAL the service is started manually

Note 1: All core services must be in ALWAYS mode. Note 2: All transport services (HTTP, IIOP, P4) must be in either in ALWAYS or in MANUAL mode. Properties The Properties tab provides information about cluster service properties. The usage of the Properties tab is described in Setting the Properties section below. Distribute Service Version displays the version of the service according to the Java Package Versioning Specification Provider Name displays the name of the service provider Service Directory specifies the work directory of the current service Protocol Remote Support for Service describes the list of support protocols for the service with the Support and Service Name Service References describes the list of service references of the service to other services and libraries Additional The Additional tab provides basic information about each service. You can change the Running Service Icon, Stopped Service Icon, and Suspended Service Icon fields, or set their default values. Description for a brief descriptive text about the service and its purpose, where is the name of the service

16/336



Setting PropertiesProperties The Properties tab contains the cluster modules properties that can be modified. These properties are specific for each service and are used to start the service. Each property has Key and Value according to java.util.Properties. Control Descriptor The subtab Properties of the Control Descriptor tab provides information about the service properties: Properties Editor Class Name the name of the editor class that enables the editing of the service properties. If the service has its own properties, you must provide an editor for them. Runtime Class Name the name of the class that contains information about the visual part of the service Deployment Class Name the class that controls the deployment. It implements a specific interface with methods, which are invoked before or after deploying or undeploying a service. This class is used only for the deployment of services whose implementations differ from the standards described in the corresponding specifications. Debug mode properties - if the Enable Debug Mode indicator is set, the Server Frame Class and the Dispatcher Frame Class are started to enable displaying of debug information from the service. These classes are specific for each service. Note: For detailed information about the service properties, refer to the Services Administration Reference and Managers Administration Reference sections in this manual.

Runtime ControlThe Runtime tab provides options to modify certain service properties at runtime. The toolbar provides additional options for each Runtime tab, which are described when the corresponding service Runtime tab is considered. Note: Service-specific Runtime tabs are described in the corresponding Services Administration Reference sections in this manual.

Log ViewingAll significant events that occur on cluster nodes are written to log files that correspond to each module. A list of these events is displayed in the Log Viewer tab. You can view the following types of log messages: Emergency system is unusable Alert immediate action must be taken Critical critical conditions Error error conditions Warning warning conditions Notice normal but significant events for the system

17/336



Info information Trace events that occur during application methods execution Debug debug-level messages All shows all existing events Log messages can be displayed in ascending or descending order by type, date and time, caller (the specific service), user, client IP, and cluster. By choosing are saved. (Save log messages) on the toolbar, all displayed log messages in the table

(Reset log messages) on the toolbar, all displayed log messages in the By choosing table are deleted and pointers are nullified. (Next log) on the toolbar, the next log of the selected type in the table is By choosing displayed and the log message content is shown. (Next log messages) on the toolbar, the next X log messages are added By choosing in the table, where X is the number specified in the CountField. (Auto on) on the toolbar, the next X log messages are added in the table By choosing in the defined period automatically. By choosing (Auto off) on the toolbar, the Auto on option is turned off.

Cluster View with the Visual Administrator ToolThe Visual Administrator tool enables you to view the different nodes in a SAP J2EE Engine 6.20 cluster and configure the modules running on them. The tool provides the following modes for viewing the cluster nodes, and the modules running on them: Tab View three tabs are displayed in the left-hand pane of the Visual Administrator. Cluster tab displays the running state controller, back-up state controller, application nodes, and dispatcher nodes in the cluster. It provides information about the port, host, ID, type, and name of each node. Managers displays a list of all managers running in the cluster. Services displays a list of all services running in the cluster. Cluster View provides a tree view in which the main elements are the cluster nodes. The managers and services running on each cluster node can be displayed by expanding the tree. Element View displays a tree of all managers and services running in the cluster. When expanded, the tree also shows the nodes on which each module runs. You can modify the administrable properties of the modules in each of the options for cluster viewing. Note: For detailed information about SAP J2EE Engine 6.20 cluster, see Chapter 2. For more information about the J2EE Engine services and managers, refer to the Services Administration Reference and Managers Administration Reference chapters. 18/336



Shell Console AdministratorSAP J2EE Engine 6.20 Console Administrator is an alternative to the Visual Administrator tool. Unlike the Visual Administrator, it is not a GUI and the runtime control and administration is done using specific commands in the Shell language. The commands are entered on the command line in the console where the cluster node is running. This tool enables monitoring on the processes started on the different elements of the cluster and provides the opportunity for prompt and adequate reaction whenever problems occur. The Console Administrator also enables remote administration through telnet clients, or applets that simulate telnet client, as well as continuous deployment of applications and additional libraries.

Cluster Management with the Console Administrator ToolThe SAP J2EE Engine 6.20 Console Administrator tool enables you to administer cluster nodes. When using a telnet client, the system administrator must first run a state controller, a dispatcher, and an application node. The administrator can then connect to the cluster (that is, to the dispatcher node) and to configure all other nodes in the cluster remotely. The Console Administrator commands are divided into groups, containing commands with different functions. Two of them System Commands and Admin Commands refer to SAP J2EE Engine 6.20 cluster administration. Note: For more information about how to administer the cluster using Telnet, refer to the Configuration Tasks -> Remote Administration Using Telnet section in this manual. For more information about the shell language commands, refer to the Shell Commands Reference section in this manual.

19/336



Property Files AdministrationProperty files contain the configuration logic of SAP J2EE Engine 6.20. The J2EE Engine GUI administration tools Visual Administrator and Config Tool read the properties from these files to visualize them. If some modifications are made, they are stored in the corresponding property files. Properties can also be configured by editing the property files. For a list of SAP J2EE Engine 6.20 property files, refer to the Property Files Reference section in this document. All properties separated by modules are described in the Managers Administration Reference and Services Administration Reference sections in this manual.

20/336



Config ToolConfig Tool OverviewThis tool provides an easy way to add, remove, 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/Linux platforms. Config Tool can be used without a running SAP J2EE Engine 6.20. The only requirement is to have the J2EE Engine installed on the local machine. Note: The 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 ServicesApplication Node ConfigurationSAP J2EE Engine 6.20 Config Tool enables the modification of service or manager module properties. The current J2EE Engine configuration is detected automatically and displayed immediately after running the tool.

Cluster Installation Mode

To load another configuration, you must specify the directory where SAP J2EE Engine 6.20 has been installed by choosing the FileScan command, or on the toolbar. A tree structure is displayed in the left-hand tab of the window. The main section of the . If the installation type is alone (for tree is the SAP J2EE Engine 6.20 cluster standalone version of SAP J2EE Engine 6.20), the alone ( ) configuration is displayed. By default, the J2EE Engine consists of one dispatcher, one application node, and one state controller. There are two subsections for each cluster node managers ( ) and services 21/336



( ). 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 ConfigurationTo apply the changes, select FileApply, or on the toolbar. You can also save the on the configuration in an XML file by choosing FileExport properties to XML, or toolbar.

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

22/336



Adding Cluster Nodes

A new node can be added using the New menu. To specify the type of the cluster node to or on the toolbar be added, select either New Dispatcher or New Server ( respectively). A dialog box appears. Choose a name for the new cluster element from a list of available options. If you are creating an application node, then the data from the existing application node is copied to the new application node. You can clear this data by selecting the Clear all application data option, which starts the AppClear Tool. It is recommended to clear the application data. 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. Note: You cannot add a state controller using the Config Tool. If you want to create a state controller, then use the upgrade procedure. For more information, see Upgrading SAP J2EE Engine 6.20 in the Installation and Upgrade Manual. Note: When you add nodes to an existing cluster, which is already configured to work with the startup framework, make sure you also configure the new node to use the startup framework, as you have already configured the other nodes in the cluster. Otherwise, the life cycle of the new node will not be managed by the startup framework.

23/336



New Cluster Node has been Added Successfully

Removing Nodes from SAP J2EE Engine 6.20 ClusterThe Config Tool enables you to remove nodes from the SAP J2EE Engine 6.20. This option is available for cluster installation mode. It is possible to remove a dispatcher node only if there is more than one dispatcher in the cluster. Also, you cannot remove the initial application node created from the installation, it is used when creating a new application node for copying the existing application data. Note: Do not remove the state controllers. To remove an application node, select it from the cluster tree from the left-hand side of on the toolbar. the frame and choose

SAP J2EE Engine 6.20 as an NT/2000 Service or a UNIX/Linux DaemonRunning a Cluster Node in Background ModeSAP J2EE Engine 6.20 can be run as a Windows NT/2000 Service or a Daemon on UNIX/Linux 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 J2EE Engine 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/Linux Daemon, the following steps must be performed: 24/336



Step 1. Select the NT Service tab of the frame and set the Enable NT Service indicator. Specify the following options:

Setting a Node to Run in Background Mode

Java Home the path to the Java home directory. Shutdown Port 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 when the service stops its process, this is the timeout period (in milliseconds), after which the cluster element is shut down. The default value is 10000. Java Parameters the Java parameters for starting a cluster element as an NT service. on the toolbar. The settings are Step 2. To apply the changes, choose FileApply or saved to service.ini file in the configtool subdirectory of SAP J2EE Engine 6.20 installation directory. This file has the following format:Service_0_MainClass=com.inqmy.boot.Start ServiceCount=1 Service_0_sfSupport=yes Service_0_RootDir=C:\SAP_J2EEngine6.20\cluster\server Service_0_Timeout=10000 Service_0_JavaPath=C:\jdk1.3.1_11\ Service_0_Name=cluster\server Service_0_Port=5561 Service_0_Parameters= Service_0_JavaParameters=-Dmemory.manager=64M -Xmx64M -classpath ".;.\system-lib\boot.jar;.\system-lib\jaas.jar;" Djava.security.policy=.\java.policy Dorg.omg.CORBA.ORBClass=com.inqmy.system.ORBProxy Dorg.omg.CORBA.ORBSingletonClass=com.inqmy.system.ORBSingletonProx y -

25/336



Djavax.rmi.CORBA.PortableRemoteObjectClass=com.inqmy.system.Portab leRemoteObjectProxy -DstartAging=true

Description of each field is provided below: Service_0_MainClass the main class to run 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_0_sfSupport if set to true, specifies the startup framework relies on the J2EE Engine to store information about the nodes (such as, process state, http/https port, telnet port, p4 port, and so on) in the administration shared memory. When the property is set to no, the J2EE Engine stores only process state RUNNING. Service_0_RootDir the directory where the specified cluster element is installed Service_0_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. Service_0_JavaPath contains the classpath to JDK directory Service_0_Name a mnemonic name of this element Service_0_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_0_Parameters main class input parameters, if needed. In this case, no parameters are specified Service_0_JavaParameters contains additional parameters to be passed to JVM (the DstartAging=true parameter specifies that the Ageing Service is configured and running, and in case of a cluster node shutdown, the corresponding node will be automatically restarted. For more information about the Ageing Service, see Services Administration Reference -> Ageing Service). 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. To add the SAP J2EE Engine 6.20 node to the Windows services, start service.exe as follows: Service.exe install user pass the service(s) is (are) registered as NT/2000 Service(s) with user and password. For each specified cluster node, a separate service is generated. All services have startup mode automatic. To start the service(s), open the Control PanelServices 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. Note: Service.exe cannot be run within a 4NT DOS console. Start the service in another DOS console window.

26/336



UNIX/Linux Platforms Open a console in the directory where Config Tool is installed. To start SAP J2EE Engine 6.20 as a UNIX/Linux 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. Note: The following points should be considered when running the J2EE Engine as an NT Service or UNIX/Linux 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/Linux) indicator is set, the Apply command modifies the service.ini file, as described above. 3. When the NT Service (Daemon for UNIX/Linux) 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.

Removing SAP J2EE Engine 6.20 Nodes Running in Background ModeTo remove all SAP J2EE Engine 6.20 nodes running in background mode on Windows NT/2000 platform, start service.exe in a DOS console (but not in 4NT) as follows:Service.exe remove

To stop SAP J2EE Engine 6.20 running as a daemon on UNIX/Linux platforms, use the following option:unixdaemon stop

Even after you have removed or stopped SAP J2EE Engine service or daemon on Windows or UNIX/Linux platform respectively, you can still run them in background mode following the steps described in the previous section. To disable the option for running a SAP J2EE Engine 6.20 node in background mode, complete the following steps: Select the relevant SAP J2EE Engine node in the left-hand pane of the Config Tool; Deselect the Enable check-box in the right-hand pane; Choose Apply on the toolbar.

Configuring Cluster Elements with Identical Names in Different Clusters as Separate NT ServicesIf various clusters reside on a single machine simultaneously, cluster elements with identical names running in different clusters can be set as separate NT services as follows: 1. In the service.ini file of the corresponding cluster, locate the Service_i_Name element, where i specifies the number of the service, which name has to be modified. 2. Change the name on the right side of the expression as you wish. 27/336



3. Install the service as described above. Note 1: If this procedure is not accomplished, only one of the cluster elements is run as an NT service. Note 2: The execution of these steps must take place between Step 2 and Step 3 of J2EE Engine 6.20 as an NT/2000 Service or a UNIX/Linux Daemon section.

SAP J2EE Engine 6.20 in Remote Debug ModeThe Config Tool enables you to run the J2EE Engine in remote debug mode. This task can be performed on state controllers and application nodes of SAP J2EE Engine 6.20 Cluster. To run the cluster node in remote debug mode, complete the following steps: Step 1. Select an application node, choose the Debug tab, 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.

Setting Debug Mode on NT/2000 Services and UNIX/Linux DaemonsIf some of the cluster elements are running as NT/2000 Services or UNIX/Linux Daemons, then you have to manually set the debug mode on them. Follow the steps below:

28/336



1. Enable the debugging mode by selecting the Enabled indicator in the Debug tab of the Config Tool. This action sets the SuspendedElement property of the Service Manager to true, DEBUG_PORT and DEBUG_PARAMS in the go script of the cluster element, and adds the following parameters to the existing Java parameters in the service.ini file, located under the configtool directory: -Xdebug -Xnoagent -Djava.compiler=NONE Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=. They are appended to the Java parameters of the corresponding cluster element Service__JavaParameters, where n is a number specifying the type of the element. For example, 0 is a state controller, 1 is an application node, and so on. You can see which number to what type corresponds from the Service_n_Name parameter. 2. Copy jdk_home>\jre\bin\dt_socket.dll to the configtool directory. 3. Restart the NT/2000 Service. For UNIX/Linux Daemons, you have to follow step 1 and 3.

29/336



Console Config ToolOverviewThe Console Config Tool handles SAP J2EE Engine 6.20 configuration, adding new nodes to the cluster, and running the J2EE Engine in background mode as a Windows NT/2000 Service, or a Daemon on UNIX/Linux platforms. Console Config Tool has the same functions as the GUI Config Tool. There are several ways to run the Console Config Tool: Run Tools -> Console Config Tool from the SAP J2EE Engine 6.20 program folder. Doubleclick the consoleconfig script file in configtool directory of the installed SAP J2EE Engine 6.20. Open a console window in the directory where the consoleconfig script file is located, enter consoleconfig on the command line, and choose Enter. 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.

Description of Console Config Tool FunctionsThe Console Config Tool functions for the cluster type of configuration are explained below. The stand-alone configuration procedure is similar.

Step 1: Main MenuThis step lists the available cluster elements and the Console Config Tool general options. displays the available dispatcher nodes displays the available application nodes displays the available state controller or backup state controller saves the configuration in an XML file saves the changes scans the directory where SAP J2EE Engine 6.20 has been installed adds a new dispatcher node (the maximum number of dispatcher nodes is 60) adds a new application node (the maximum number of server nodes is 60) removes a dispatcher removes an application node exits the Console Config Tool

The next step depends on the choice in step 1. To modify the properties of dispatcher services and managers, select .

Step 2: Dispatcher Node ConfigurationThis step enables you to modify dispatcher services and managers properties. lists all services lists all managers

30/336



sets the cluster element to run as a Windows NT/2000 Service, or a Daemon on UNIX/Linux platforms; if the cluster element is already enabled to run in background mode, at this step you can disable this option displays the Main Menu (step 1) exits the Console Config Tool If is the selected option, continue as follows:

Step 2.1: Services PropertiesThis step displays a numbered list of SAP J2EE Engine 6.20 services. To choose a service, enter the corresponding number. The last option from the list returns to the previous step. Each service has the following configuration menu: lists all service properties enables you to add a new property by specifying its name and value displays a numbered list of all properties and enables you to delete properties displays a numbered list of all properties and enables you to change their values enables you to change the startup type of the service. By default, the type is set to always but can be changed as follows o always starts the service o starts the service automatically that is, the first time the service is requested, it starts o the service is started manually that is, the service must be started by the system administrator o returns to the previous step saves the changes made in the previous choices lists the used ports o lists the used TCP ports o lists the used UDP ports o returns to the previous menu o exits the Console Config Tool returns to the previous menu exits the Console Config Tool Note: After each modification, a confirmation question is displayed with two options: Y for yes and N for no. If is the choice in Step 2, continue as follows:

Step 2.2: Managers PropertiesThis step displays a numbered list of SAP J2EE Engine 6.20 managers. To choose a manager, enter the corresponding number. The last option from the list returns to the previous step. The managers configuration menu does not differ from the services configuration menu. For detailed information on the configuration menu, refer to Step 2.1. If the choice in Step 2 is (that is, you want to enable the cluster element to run in background mode), continue as follows:

Step 2.3: Cluster Element as a Windows NT/2000 Service or a Daemon on UNIX/Linux PlatformsThis step enables you to set the cluster element (dispatcher) as a Windows NT/2000 Service, or a Daemon on UNIX/Linux platforms. The default settings are displayed:

31/336



Port on which the cluster element listens for requests the default value is 5501. Make sure the specified port is not already in use. Timeout specifies the timeout period (in milliseconds) before the cluster element is shut down if the service stops its process. The default value is 10000. Main class specifies the main class to run. The default is com.inqmy.boot.Start. Root directory the directory where the cluster element has been installed. Default is /cluster/dispatcher Java executable path the path to the Java home directory. The default is C:\jdk\1.3.1_09\bin\java. Parameters main class input parameters, if required. In this case, no parameters are specified. Java parameters for starting cluster elements as an NT service The cluster element default settings described above can be modified using the following options: sets port value sets timeout sets main class sets root directory sets Java executable path sets main class parameters sets Java parameters sets the cluster element to be a Windows NT/2000 Service confirms the current cluster element status and returns to the previous step exits the Console Config Tool

Note: For detailed information about setting SAP J2EE Engine 6.20 cluster elements as a Windows NT/2000 Services or a Daemon on UNIX/Linux platforms, refer to Confil Tool SAP J2EE Engine 6.20 as a Windows NT/2000 Service or UNIX/Linux Daemon the section in this manual. If is the choice in Step 1, continue as follows:

Step 3: Application Node ConfigurationThis step enables you to modify the properties of the services and managers running on the application nodes of the SAP J2EE Engine 6.20 cluster. lists all services lists all managers enables debug mode sets the cluster element to run as a Windows NT/2000 Service, or a Daemon on UNIX/Linux platforms; if the cluster element is already enabled to run in background mode, at this step you can disable this option displays the Main Menu (step 1) exits the Console Config Tool

If is the selected option, continue as follows:

Step 3.1: Services PropertiesThis step displays a numbered list of SAP J2EE Engine 6.20 services. It is the same as for dispatcher nodes therefore, refer to Step 2.1. If is the choice in Step 3, continue as follows:

32/336



Step 3.2: Managers PropertiesThis step displays a numbered list of SAP J2EE Engine 6.20 managers. It is the same as for dispatcher nodes therefore, refer to Step 2.2. If is the selected option, continue as follows:

Step 3.3: Enable Debug ModeThis step enables you to run the J2EE Engine in remote debug mode. This task can be performed on application nodes and state controllers of SAP J2EE Engine 6.20 Cluster. To run the cluster element in remote debug mode, set a debug port that enables debugger clients connections. It is opened by the Virtual Machine and must not be among the ports that SAP J2EE Engine uses.

Step 3.4: Cluster Element as a Windows NT/2000 Service or a Daemon on UNIX/Linux PlatformsThis step enables you to set application node, state controller, and backup state controller as a Windows NT/2000 Service, or a Daemon on UNIX/Linux platforms. It is the same as for dispatcher nodes therefore, refer to Step 2.3.

Step 4: State Controller ConfigurationThe state controller configuration is the same as the configuration for application nodes. Refer to the corresponding section.

33/336



Deployment ToolsAll tools that carry out deployment-related tasks on SAP J2EE Engine 6.20 are located in /deploying. These are tools for RMI classes compilation, J2EE components generation, application assembling, and actual application deployment on different cluster nodes. For information on how to deploy J2EE applications, how to use the different deployment tools, and view some sample deployment scenarios, refer to the Deployment Manual.

34/336



LogViewer ToolIntroductionThis section discusses features and navigation for the Log Viewer application.

PurposeThe J2EE Engine listens to logging activity and makes every log file available as it is created. The user can open log files and if possible, the data will be parsed such that columns of data can be accessed. The most recent log messages are displayed first. It is possible to open and view many log files at one time. You can view logs side-by-side, search each column, or merge the logs based on time stamps in each record. The Log Viewer: Displays application and system logs Gives insight into system problems, helps debugging and improve performance by providing insights into the inner workings. Tries to display the information in a useful form (it understands the information in a log) Brings logs together from the J2EE Engine and related systems in one place Searches logs Merges logs that have some kind of compatible sequence information across application nodes Allows to control the amount of log data created (by controlling the severity threshold on Logs)

ContextMonitoring Running a query across many logs while searching for 'Error' on the Severity column is an easy way to keep track of problems. The Log Viewer also can generate template files for the CCMS agent. Alerts will then be generated in the CCMS. Problem Diagnostics The messages in log files provide hints to the cause of problematic application behavior. Performance Tuning The SAT logs show execution times for user transactions. The SQL trace provides details on the database interactions through the OpenSQL interface.

Prerequisites for Running the Log Viewer You must have Java runtime 1.3 or greater installed Log Viewer client is a Swing application. The Log Viewer Service on the SAP J2EE Engine is required. It is assumed that the Log Viewer is installed and configured properly on your system, according to the Installation and Configuration Guide Log Viewer listed under Related Documentation, below.

35/336



Viewing Logs

When a log is displayed in the Log Viewer window, as shown in the figure above, the section most recent in time is initially displayed. You have the following controls to view the log: You can move up and down the log using the up and down arrows, or using the scroll bar. icon to show the most current part of the log. Use the Refresh Selected Log File You can also view the most recent part of the log (the top) using the CONTROLHOME keys. You can view the oldest part of the log (the bottom) using the CONTROL-END keys. The buttons on the column tops, shown below, allow you to sort the log lines presented by the column headings.

ConfigurationAdd a Monitored Application1. To add a new monitored application in the Log Viewer, select Tools menu. 2. On the Monitored Application Setting window, click Add. 3. Enter the following: a. Application Name this is descriptive title only, and should help the user to remember the application being monitored. b. Host Name an IP address pointing to the host c. Port Number -- the standard service port for the P4 RMI service d. Click OK.

Config from the

36/336



4. Click Connect to test the connection to the J2EE Engine, before you save the configuration. 5. Click Save to save your configuration and connect to the J2EE Engine. The monitored application name will be refreshed on the side menu navigation tree.

To test the connection to verify that it works, do the following: 1. Click Connect. 37/336



2. If connection does not work, possible reasons are: a. Wrong port. To determine the correct port, see the Configuring the Remote Configuration Socketport section. b. Wrong host name. Either the host J2EE Engine is not running, or the IP address is not correct. Verify the IP address. Try pinging the host to see if it is working. To edit the application settings, do the following: 1. Select the application name. 2. Click Edit. 3. Change the settings as required. 4. Click Save. To remove a monitored application, click Delete.

Generation of the CCMS Monitoring TemplateComputing Center Management System (CCMS) is an application running on an SAP R/3 system that monitors the state and quality of SAP execution, both within the R/3 System, and in external servers. CCMS receives information from CCMS Agent applications running within the R/3 system and on external servers. This section describes the format and creation of CCMS Agent Template files (templates) used by CCMS Agents within servers external to R/3. These templates define to the CCMS Agent what log files to monitor, where they are located in the directory structure, and what log output patterns to look for. A CCMS Agent Template is created whenever the Log Viewer receives notification that a new log has been created. The contents of a template file are created, according to the values specified in a Properties file. Flow As illustrated in the figure below, the Log Viewer receives a New Log command (from a J2EE application, for example) to initiate the creation of the CCMS Agent Template file.

38/336



J2EE Application Creates New LogNew Log Command

log

New log listener

1

CCMS Agent

2Add to log list

3Create CCMS Agent template

7 6Agent Template contains pattern Index

Read Template

8

Monitor log for patterns Notify CCMS of finds RFC

4

Update the log file template index

9

5CCMS R/3

Log Viewer

The sequence of events is shown by the numbers in the figure above. The Log Viewer gets the location of the log in the file system, and adds the log file to the list of log files to be monitored by the Log Viewer (log list). The Log Viewer then reads the Log Viewer Properties file to determine the text pattern to search for, and in what color CCMS is to display each such line found. Log Viewer then creates the template file, inserting the log file path name, the search pattern, and the color value. The Log Viewer then stores the template file in the template output directory, as specified in the Properties file. When the CCMS Agent finds a new template, it gets the template, corresponding to the new log, from the template output directory. The CCMS Agent begins monitoring the log for text patterns specified in the template. When the agent finds one of the specified text patterns, it notifies CCMS on the R/3 system via an RFC. Description of the Log Viewer Properties File The Log Viewer Properties file is an unformatted text file that specifies configurable properties of the Log Viewer. It can be created and edited with any text editor. The file name is of the form: log_timestamplogmon.iniwhere the file name is composed of two parts: a unique log time stamp prefix, log_timestamp. Example: 1054170026516. the required end characters, logmon.ini, that indicate this is a log initialization file. Example:1054170026516logmon.ini

The Properties file is stored in the installation directory of the SAP J2EE Engine 6.20. Typically in locationC:\SAPJ2EE6.20\cluster\server\services\logviewer

An example of the Properties is shown in the Example Properties File section. The description of the purpose and format of each property follows.

39/336



Output_directory This output_directory property specifies where in the directory structure the template files are stored. It has the format:output_directory = directory file path

where directory file path defines the location where the template files are stored. Example for MS Windows-based system:output_directory = C:\\usr\\sap\\PRFCLOG\\logmon

Note: Note that double backslashes (\\) are required as directory separators, because the backslash has special meaning in Microsoft Windows. The first backslash serves as the escape character and indicates that the following backslash is actually part of the text string that identifies the directory. Example for UNIX/Linux system:output_directory = /usr/sap/PRFCLOG/logmon

Flag for Generating the CCMS Template File This property gives you the option not to create a CCMS Template file. It has the format:FlagForGeneratingCCMSTemplate = binary digit

where binary digit is: 0, to specify that no template file is to be created 1, to specify that the template file is to be created, as specified by properties below. Example:FlagForGeneratingCCMSTemplate = 1

Search Patterns and CCMS Display Color This property defines the text string pattern that CCMS is to search for, the log type, and the color in which the corresponding line in the log is to be displayed. It has the format:TypeOfFormatter_Pattern = Color Value

The TypeOfFormatter_Pattern property is composed of two parts, separated by the underscore (_) character: The TypeOfFormatter part specifies the type of log to monitored, and can have one of the following values: Specify SAPJLog for the List Format log type. Specify ASCIILog for the ASCII logs log type. Specify SATLog for the SATTraces log type. The Pattern part specifies the text string pattern to be searched for. Examples are:Error Warning Information

40/336



The Color Value property can have one of three values:GREEN YELLOW RED

Putting the two parts together is illustrated in the following examples: SAPJLog_Fatal = RED, indicating a List Format log is to be searched for Fatal and will be displayed on the CCMS monitor screen with color red. ASCIILog_Warning = YELLOW, indicating an ASCII log is to be searched for Warning and will be displayed on the CCMS monitor screen with color yellow. ASCIILog_Debug = GREEN, indicating an ASCII log is to be searched for Debug and will be displayed on the CCMS monitor screen with color green. SATLog_Warning = YELLOW, indicating an SATTraces log is to be searched for Warning and will be displayed on the CCMS monitor screen with color yellow. Example Properties Filelogviewer 6.20 ##specify the configuration directory that holds properties file for logviewer ## (mainly 'LogViewerLogging.properties' & 'startupLogging.properties') ##default: no value/commented, and the directory is \sapmarkets\properties ##Note that you'll have to use double backslashes for Windows systems ##(e.g.: c:\\sapmarkets\\properties). #cfg.path= MBeanServerName=RemoteMBeanServer socketPort=3011 # The above part is not relevant to the CCMS Agent template generation. # This rest of this file defines the properties needed for creating the CCMSAgent Template. # The property output_directory defines the location where the template files should be put. The following directory must already exist & LV has write permission. Diff formats for diff Oss # The directory is where the CCMS agent is going to look for the templates # example for windows based system output_directory = C:\\usr\\sap\\PRFCLOG\\logmon #example for unix based system #output_directory = /usr/sap/PRFCLOG/logmon # FlagForGeneratingCCMSTemplate: If 0, Do not generate template file; If 1, Generate the ccmsTemplate files. FlagForGeneratingCCMSTemplate = 1 # The following properties defines the Pattern to search for and the value for. # The format is TypeOfFormatter_Pattern = Value. # So if a pattern to be searched was "Error" in the ListFormatFiles # and the display color was Pink, then the definition is: # SAPJLOG_Error = Pink # For List format log type = SAPJLog # patterni = Fatal, for example in first one SAPJLog_Fatal = RED SAPJLog_Error = RED SAPJLog_Warning = YELLOW SAPJLog_Debug = GREEN

text text text text

41/336



SAPJLog_Info = GREEN # For Ascii logs log type = ASCIILog ASCIILog_Fatal = RED ASCIILog_Error = RED ASCIILog_Warning = YELLOW ASCIILog_Debug = GREEN ASCIILog_Info = GREEN # For SATTraces. log type = SATLog SATLog_Fatal = RED SATLog_Error = RED SATLog_Warning = YELLOW SATLog_Debug = GREENSATLog_Info = GREEN

Description of the CCMS Agent Template File This file is created by the Log Viewer and stored in the template output directory, output_directory, as specified in the Log Viewer Properties file. The contents are created, based on the example properties specified in the Log Viewer Properties file, as described in the previous section. The following is an example of a template, based on the previous properties file. Example of a CCMS Agent Template FileLOGFILE_TEMPLATE FILENAME=LogFile0.log DIRECTORY=C:\Documents and Settings\i803727\properties\CombinedLogMergeLogrecordCounterTest2 PATTERN_0=ERROR VALUE_0=Pink PATTERN_1=Warning VALUE_1=Yellow PATTERN_2=Info VALUE_2=White PATTERN_3=FATAL VALUE_3=Red PATTERN_4=Debug VALUE_4=Blue .

Configuring the Remote Configuration SocketportThis is the same port as defined for the P4 Service for RMI. It is usually 3011, but can change. To determine its value, look in the P4 properties file. The properties file can be found at the following location:C:\usr\sap\epb3\j2ee\j2ee_00\cluster\dispatcher\services\p4\proper ties

The following is an example P4 properties file with the port emphasized.#p4 #Fri May 16 09:51:52 PDT 2003

allTransports=httptunneling\:ssl\: ssl=50006 port=50004 httptunneling=50005

42/336



Attribute SettingLog files attributes include the formatter used and the log level. Only the log level an be set through the log viewer user interface. The attribute settings just change the log level on the log, not the location. Procedure 1. Select (highlight) the log file for which you want to set the attribute settings. Right click on the log file name and select Attribute Setting (alternatively click Tools Attribute Setting.. from the top menu).

2. On the Attribute Setting window, select Severity. The possible values appear under the values column. Select the severity value (Log Level) that you wan to display in the Log Viewer. The severity is an attribute that can be set for the SAP Java Logging framework. To adjust the logging level, the logging framework will only write those log records whose severity is higher than the severity level you set.

43/336



Note: If you select the value Error then all the values below Error (implies increasing severity) will be visible in the log file updates. All log records with severity settings above Error (lesser severity levels) will not appear under the column Severity in the log. The settings are applied as new log records are written by the application running on the J2EE Engine. This does not impact the display of records written before the setting was changed.

Docking / Undocking the Application LogYou can view the log file within the Log View

admin manual

Documents

console administrator

visual administrator

config tool overview

logviewer tool

appclear tool

shell console administrator

cluster elements

cluster view