Administration Manual - archive.sap.com Manual SAP J2EE Engine 6.20 2/453 Contents About This Manual ... The SAP J2EE Engine 6.20 Visual Administrator is a graphical user interface

SAP J2EE Engine 6.20

Administration Manual

Administration Manual SAP J2EE Engine 6.20

2/453

Contents

About This Manual .............................................................................12 Target Audience and Prerequisites ..................................................12 Structure .......................................................................................12 Documentation Conventions ...........................................................14 Further Reading.............................................................................14

Administration Tools .........................................................................15 Overview ...........................................................................................16 Visual Administrator ...........................................................................17

Logging on to SAP J2EE Engine 6.20...............................................17 Visual Administrator Utilities ...........................................................18

Shell Console Administrator.................................................................24 Property Files Administration...............................................................25 Config Tool ........................................................................................26

Config Tool Overview .....................................................................26 Configuring SAP J2EE Engine 6.20 Managers and Services................26 Adding Nodes to SAP J2EE Engine 6.20 Cluster................................28 Removing Nodes from SAP J2EE Engine 6.20 Cluster .......................30 SAP J2EE Engine 6.20 as an NT/2000 Service or a Unix Daemon ......31 Configuring Cluster Elements with Identical Names in Different Clusters as Separate NT Services.................................................................35 SAP J2EE Engine 6.20 in Remote Debug Mode.................................36

Console Config Tool............................................................................38 Overview.......................................................................................38 Description of Console Config Tool Functions...................................38

Deployment Tools ..............................................................................43 LogViewer Tool ..................................................................................44

Introduction ..................................................................................44


3/453

Viewing Logs .................................................................................45 Configuration.................................................................................46

Appclear Tool.....................................................................................61 DBTool ..............................................................................................62

DBTool Overview ...........................................................................62 DBTOOL.XML.................................................................................62

Library Tool .......................................................................................68 RMIC Tool..........................................................................................70

GUI RMIC Tool ..............................................................................70 Console RMIC Tool.........................................................................71

ShutDown Tool ..................................................................................72 User Tool...........................................................................................74

User Tool Overview........................................................................74 XML Structure for User Tool............................................................74

Analyze Tool ......................................................................................76 Analyze Tool Overview ...................................................................76

Administration of SAP J2EE Engine 6.20 Cluster ..............................78 Overview ...........................................................................................79

Cluster Management with the Visual Administrator Tool ...................79 Cluster Management with the Console Administrator Tool ................80

Planning the Architecture of a Cluster..................................................81 SAP J2EE Engine Cluster Introduction...........................................81

Adding Nodes to SAP J2EE Engine 6.20 Cluster ....................................87 Creating Cluster Nodes...................................................................87 Configuring the Additional Nodes ....................................................88

Managing the Load Balancing System..................................................97 Configuring the Load Balancing Power of the Machines Within the Cluster ..........................................................................................97

Configuring a Cluster When Multiple LAN Adapters are Available (Windows) .........................................................................................99


4/453

Procedure......................................................................................99 Administration of SAP J2EE Engine 6.20 Stand-Alone Version .......100

Overview .........................................................................................101 Stand-Alone Server Services and Managers........................................102 Stand-Alone Server Administration and Application Deployment ..........103

Configuration Tasks.........................................................................104 Overview .........................................................................................105 Configuration of Additional Libraries ..................................................106

System-Lib ..................................................................................106 Lib ..............................................................................................106 Additional-Lib ..............................................................................106

How to Set up SAP J2EE Engine 6.20 Web Server ..............................112 Setting Ports................................................................................112 Setting Various Virtual Hosts on One Server ..................................113 Caching.......................................................................................115 Mime Types.................................................................................116 Log Files......................................................................................118 Setting Security Constraints..........................................................119

Using the Log System and Monitoring................................................121 Log System .................................................................................121 Monitoring...................................................................................124

Managing Security............................................................................146 Architecture.................................................................................146 Integration ..................................................................................147 Login to SAP J2EE Engine.............................................................148 Features......................................................................................149 Tasks ..........................................................................................151 Login ..........................................................................................151 Users and Groups ........................................................................153 Managing SSL Connections...........................................................156


5/453

Remote Administration Using Telnet ..................................................160 Overview.....................................................................................160 How to Connect and Work Using Telnet ........................................160

Connecting Internet Information Server to SAP J2EE Engine 6.20 .......162 Running Apache Web Server with SAP J2EE Engine 6.20 ...................163

Configuring Apache Web Server....................................................163 Setting up SAP J2EE Engine 6.20 for Application Tracing ....................166

Setting SAP J2EE Engine Tracing Mode .........................................166 Traced Components .....................................................................168

Setting up SAP J2EE Engine 6.20 for Remote Debugging ....................169 Configuring an Application Node as a Debug Node.........................169 Initiate Debugging Session ...........................................................170 Configuration of Debug Nodes via the Config Tool .........................171

Managers Administration Reference...............................................172 Classloader Manager ........................................................................173

Visual Administrator .....................................................................173 Cluster Manager...............................................................................175

Visual Administrator .....................................................................175 Critical Information and Troubleshooting Tips................................182

Connections Manipulator...................................................................183 Visual Administrator .....................................................................183 Critical Information and Troubleshooting Tips................................184

IpVerification Manager......................................................................185 Visual Administrator .....................................................................185 Critical Information and Troubleshooting Tips................................186

Lock Manager ..................................................................................188 Visual Administrator .....................................................................188

Log Manager....................................................................................191 Visual Administrator .....................................................................191

Memory Manager .............................................................................197


6/453

Policy Manager.................................................................................198 Visual Administrator .....................................................................198

Pool Manager...................................................................................199 Visual Administrator .....................................................................199

Ports Manager..................................................................................200 Visual Administrator .....................................................................200

R3Startup Manager ..........................................................................202 Visual Administrator .....................................................................202

Service Manager ..............................................................................204 Visual Administrator .....................................................................204

Swap Manager .................................................................................207 Visual Administrator .....................................................................207 Critical Information and Troubleshooting Tips................................208

SystemThread Manager ....................................................................209 Visual Administrator .....................................................................209

Thread Manager...............................................................................210 Visual Administrator .....................................................................210 Critical Information and Troubleshooting Tips................................214

Timeout Manager .............................................................................215 Visual Administrator .....................................................................215 Critical Information and Troubleshooting Tips................................217

Services Administration Reference .................................................218 Admin Service ..................................................................................219

Visual Administrator .....................................................................219 Critical Information and Troubleshooting Tips................................219

Appclient Service..............................................................................221 Visual Administrator .....................................................................221 Console Administrator ..................................................................222

DBMS Service...................................................................................223 Visual Administrator .....................................................................223


7/453

Console Administrator ..................................................................224 Critical Information and Troubleshooting Tips................................225

DBPool Service.................................................................................226 Visual Administrator .....................................................................226 Console Administrator ..................................................................228 Critical Information and Troubleshooting Tips................................228

Deploy Service .................................................................................230 Visual Administrator .....................................................................230 Console Administrator ..................................................................232

EISConnector Service .......................................................................233 Visual Administrator .....................................................................233

EJB Service ......................................................................................238 Visual Administrator .....................................................................238

EJB20 Service ..................................................................................240 Visual Administrator .....................................................................240 Console Administrator ..................................................................241

File Service ......................................................................................242 Visual Administrator .....................................................................242

HTTP Service ...................................................................................243 Visual Administrator .....................................................................243 Console Administrator ..................................................................250 Critical Information and Troubleshooting Tips................................250

HTTP Heartbeat Service....................................................................254 Integration ..................................................................................254 Visual Administrator .....................................................................255

HTTP Tunneling Service....................................................................256 Visual Administrator .....................................................................256

IIOP Service.....................................................................................257 Visual Administrator .....................................................................257

JavaMail Service...............................................................................258


8/453

Visual Administrator .....................................................................258 JMS Service .....................................................................................259

Visual Administrator .....................................................................259 Console Administrator ..................................................................261 Critical Information and Troubleshooting Tips................................262

Keystore Service ..............................................................................263 Visual Administrator .....................................................................263 Console Administrator ..................................................................265 Critical Information and Troubleshooting Tips................................265

Log Viewer Service ...........................................................................266 Log Service ......................................................................................267

Visual Administrator .....................................................................267 Console Administrator ..................................................................274

Monitor Service ................................................................................275 Visual Administrator .....................................................................275 Console Administrator ..................................................................276

Naming Service ................................................................................277 Visual Administrator .....................................................................277 Console Administrator ..................................................................278

P4 Service........................................................................................279 Visual Administrator .....................................................................279

Pinger Service ..................................................................................281 Visual Administrator .....................................................................281

R3Startup Service.............................................................................282 Visual Administrator .....................................................................282

RFC Engine Service ..........................................................................284 Visual Administrator .....................................................................284

Runtime Info Service ........................................................................287 Visual Administrator .....................................................................287

Security Service ...............................................................................288


9/453

Visual Administrator .....................................................................288 Console Administrator ..................................................................300 Critical Information and Troubleshooting Tips................................301

Servlet_jsp Service ...........................................................................303 Visual Administrator .....................................................................303 Console Administrator ..................................................................305 Property Files ..............................................................................305 Critical Information and Troubleshooting Tips................................306

Shell Service ....................................................................................313 Visual Administrator .....................................................................313

SSL Service......................................................................................314 Visual Administrator .....................................................................315 Critical Information and Troubleshooting Tips................................317

Telnet Service ..................................................................................319 Visual Administrator .....................................................................319 Console Administrator ..................................................................320

Transaction Service ..........................................................................321 Visual Administrator .....................................................................321

Shell Commands Reference.............................................................323 Administration..................................................................................324

Shell Language Conventions .........................................................324 Help............................................................................................324 Adding a Group of Commands ......................................................325 System Variables .........................................................................325

Dispatcher .......................................................................................327 ADMIN ........................................................................................327 DEBUG........................................................................................335 KEYSTORE...................................................................................336 LOG ............................................................................................337 MONITOR....................................................................................339


10/453

R3STARTUP.................................................................................340 SSL .............................................................................................341 SYSTEM ......................................................................................343

Application Nodes and State Controller ..............................................352 ADMIN ........................................................................................352 APPCLIENT..................................................................................361 DBMS..........................................................................................362 DBPOOL ......................................................................................364 DEPLOY ......................................................................................375 EISCONNECTOR ..........................................................................382 EJB20..........................................................................................389 HTTP ..........................................................................................395 JMS.............................................................................................395 KEYSTORE...................................................................................396 LOG ............................................................................................399 LOGIN.........................................................................................401 MONITOR....................................................................................403 NAMING......................................................................................404 INTEGRATION .............................................................................415 POLICY .......................................................................................417 RESOURCE ..................................................................................420 SERVLET_JSP ..............................................................................423 SYSTEM ......................................................................................424 USERS.........................................................................................432

Shell Language Description ...............................................................436 The Backus-Naur MetaLanguage...................................................436

Property Files Reference .................................................................443 Overview .........................................................................................444 General Properties............................................................................445

Dispatcher Node ..........................................................................445


11/453

Application Node and State Controller ...........................................445 Module Properties ............................................................................447

Dispatcher Node ..........................................................................447 Application Node and State Controller ...........................................450


12/453

About This Manual

This 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 Prerequisites

The 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

Structure

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

Administration Tools

This 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 Cluster

This 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.


13/453

Administration of SAP J2EE Engine 6.20 Stand-Alone Version

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

Configuration Tasks

This section provides information on typical administration tasks.

Managers Administration Reference

This section gives administrators information about general and SAP J2EE Engine 6.20 managers-specific properties, critical information, and troubleshooting tips. The section on managers-specific properties describes how to set the properties specified with the Visual Administrator tool, with the Console Administrator tool, and from the property files, as well as important issues from the administration of each manager.

Services Administration Reference

This section gives system administrators information about general and SAP J2EE Engine 6.20 services-specific properties, critical information, and troubleshooting tips. The section on services-specific properties describes how to set the properties specified with the Visual Administrator tool, with the Console Administrator tool, and from the property files, as well as important issues from the administration of each service module.

Shell Commands Reference

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

Property Files Reference

This section contains information about the content of SAP J2EE Engine 6.20 property files.

Index

This is an index of the keywords used in the Administration Manual in alphabetical order.


14/453

Documentation Conventions

The 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 versions, the directory paths are the same, except that slashes are used instead of backslashes to separate directories. Example: java.exe, ../cluster/dispatcher/managers/framework.properties

Monospaced font This font denotes Java source code or contents of any other specific file. Examples: Service_0_Name=cluster\dispatcher Service_0_RootDir=C:\SAP_J2EEngine6.20_SP2\cluster\dispatcher Service_0_JavaPath=C:\jdk\1.3\bin

Further Reading

For 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 the following URL:

http://java.sun.com/


15/453

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


16/453

Overview

The 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.


17/453

Visual Administrator

The 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.20

To 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


18/453

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 Utilities

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

General Utilities

Main Menu and Toolbar

The main menu provides the following options:

Connect o Login connects the user to the server. The same operation can

be performed by choosing (Login) on the toolbar. o Logout disconnects the user from the server. The same operation

can be performed by choosing (Logout) on the toolbar. o Exit closes the SAP J2EE Engine 6.20 Visual Administrator. The

same operation can be performed by choosing (Exit) on the toolbar.

View o Tab View shows the cluster elements, managers and services in

three tabs. The Tab View mode can be chosen by selecting (Tab View) on the toolbar.

o Cluster View shows the cluster elements with their managers and services. The Cluster View mode can be chosen by selecting (Cluster View) on the toolbar.

o Element View shows all Managers and Services. The Element View mode can be chosen by selecting (Element View) on the toolbar.


19/453

o Expand expands the tree in the selected tab. The same operation can be performed by choosing (Expand tree) on the toolbar.

o Collapse collapses the tree in the selected tab. The same operation can be performed by choosing (Collapse tree) on the toolbar.

Tools This menu contains a single command Properties. The following properties can be set o Ping Time (ms) the ping time in milliseconds. This is the interval

at which Visual Administrator checks if the connection with SAP J2EE Engine 6.20 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 at which the refresh of diagrams and statistics is made, in milliseconds. 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. The properties can also be set by choosing (Properties) on the toolbar.

Help o Help Topic opens a help topic using the HTML Browser specified

in the Tools Properties menu. The same operation can be performed by choosing (Help) on the toolbar.

o About opens a window with information about SAP J2EE Engine 6.20. The same operation can be performed using the Shift + F1 key combination.

The toolbar provides additional options for administration of cluster nodes:

Shuts down the selected cluster node

The toolbar enables you to start or stop SAP J2EE Engine 6.20 modules:

Starts the server or dispatcher part of a service (or both)


20/453

Stops the server or dispatcher part of a service (or both)

The toolbar provides the following options for saving or resetting SAP J2EE Engine 6.20 modules properties:

Saves the properties that were changed in the Properties or in the Control Descriptor tab

Resets the properties from the last change

Status Bar

The Status bar provides information about system events.

Provides detailed information about system events

Module Information

The 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 provides three available options o STARTUP_ALWAYS the service is started always when the server

is started o STARTUP_AUTOMATIC the service is started when another

service invokes it o STARTUP_ MANUAL the service is started manually

Note 1: All core services must be in STARTUP_ALWAYS mode.


21/453

Note 2: All transport services (HTTP, IIOP, P4) must be in either STARTUP_ALWAYS or STARTUP_MANUAL mode.

Properties

The Properties tab provides information about cluster services 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

Setting Properties

Properties

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:


22/453

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 Control

The 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 Viewing

All 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


23/453

Warning warning conditions

Notice normal but significant events for the system

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 (Save log messages) on the toolbar, all displayed log messages in the table are saved.

By choosing (Reset log messages) on the toolbar, all displayed log messages in the table are deleted and pointers are nullified.

By choosing (Next log) on the toolbar, the next log of the selected type in the table is displayed and the log message content is shown.

By choosing (Next log messages) on the toolbar, the next X log messages are added in the table, where X is the number specified in the CountField.

By choosing (Auto on) on the toolbar, the next X log messages are added in the table in the defined period automatically.

By choosing (Auto off) on the toolbar, the Auto on option is turned off.


24/453

Shell Console Administrator

SAP 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. Console Administrator enables remote administration through telnet clients, or applets that simulate telnet client, as well as continuous deployment of applications and additional libraries.

SAP J2EE Engine 6.20 Shell Language commands are described in detail in the Shell Commands Reference section in this document.


25/453

Property Files Administration

Property files contain the configuration logic of SAP J2EE Engine 6.20. Application server 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.


26/453

Config Tool

Config Tool Overview

This 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-like 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: If you are running the Config Tool with JDK 1.3.1 build 10 or lower and you are using an Intel processor with enabled Hyper Threading mode, then you may have difficulties with visualizing some parts of the Config Tool GUI correctly. To avoid these problems, disable the Hyper Threading mode. For more information, see SAPNote 720183.

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

Application Node Configuration

SAP 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.


27/453

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 tree is the SAP J2EE Engine 6.20 cluster . If the installation type is alone (for 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 ( ). 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.


28/453

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 FileApply, or on the toolbar. You can also save the configuration in an XML file by choosing FileExport 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 application nodes to the SAP J2EE Engine 6.20 Cluster. This option is available only for cluster installation mode.


29/453

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. 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


30/453

nodes in the cluster. Otherwise, the life cycle of the new node will not be managed by the startup framework.

New Cluster Node has been Added Successfully

Removing Nodes from SAP J2EE Engine 6.20 Cluster

The 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 the frame and choose on the toolbar.


31/453

Removing Cluster Nodes

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

Running a Cluster Node in Background Mode

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 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 Daemon, the following steps must be performed:


32/453

Step 1. Select the NT Service tab of the frame and set the Enable NT Service 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.


33/453

Step 2. To apply the changes, choose FileApply 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:

Service_0_MainClass=com.inqmy.boot.Start ServiceCount=1 Service_0_RootDir=C:\SAP_J2EEngine6.20\cluster\server Service_0_Timeout=10000 Service_0_JavaPath=C:\jdk1.3.1_09\ 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.ORBSingletonProxy -Djavax.rmi.CORBA.PortableRemoteObjectClass=com.inqmy.system.PortableRemoteObjectProxy

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_0_Name a mnemonic name of this element Service_0_RootDir the directory where the specified cluster element

is installed Service_0_JavaPath contains the classpath to JDK directory Service_0_JavaParameters contains additional parameters to be

passed to JVM Service_0_MainClass the main class to run Service_0_Parameters main class input parameters, if needed. In

this case, no parameters are specified 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_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.


34/453

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 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 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.

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.

Note: The following points should be considered when running the J2EE Engine 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.


35/453

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.

Removing SAP J2EE Engine 6.20 in Background Mode

To 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-like platforms, use the following option:

unixdaemon stop

Even after you have removed or stopped SAP J2EE Engine service or daemon on Windows or Unix-like 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 Services

If 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:


36/453

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.

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 Daemon section.

SAP J2EE Engine 6.20 in Remote Debug Mode

The 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


37/453

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.


38/453

Console Config Tool

Overview

The 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-like 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 Functions

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

Step 1: Main Menu

This 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


39/453

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 Configuration

This step enables you to modify dispatcher services and managers properties.

lists all services lists all managers sets the cluster element to run as a Windows NT/2000 Service,

or a Daemon on Unix-like 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 Properties

This 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


40/453

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 Properties

This 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-Like Platforms

This step enables you to set the cluster element (dispatcher) as a Windows NT/2000 Service, or a Daemon on Unix-like platforms. The default settings are displayed:

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.


41/453

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-like platforms, refer to Confil Tool SAP J2EE Engine 6.20 as a Windows NT/2000 Service or Unix Daemon the section in this manual.


Step 3: Application Node Configuration

This 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-like platforms; if the cluster element is already


42/453

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


Step 3.1: Services Properties

This 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.


Step 3.2: Managers Properties

This 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.


Step 3.3: Enable Debug Mode

This 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-Like Platforms

This step enables you to set application node, state controller, and backup state controller as a Windows NT/2000 Service, or a Daemon on Unix-like platforms. It is the same as for dispatcher nodes therefore, refer to Step 2.3.

Step 4: State Controller Configuration

The state controller configuration is the same as the configuration for application nodes. Refer to the corresponding section.


43/453

Deployment Tools

All 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.


44/453

LogViewer Tool

Introduction

This guide discusses features and navigation for the Log Viewer application.

Purpose

The 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)

Context

Monitoring

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.


45/453

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.

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.


46/453

Use the Refresh Selected Log File icon to show the most current part of the log.

You can also view the most recent part of the log (the top) using the CONTROL-HOME 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.

Configuration

Add a Monitored Application

1. To add a new monitored application in the Log Viewer, select Tools Config from the 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.

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.


47/453


48/453

To test the connection to verify that it works, do the following:

1. Click Connect.

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 Template

Computing 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.


49/453

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.

J2EE ApplicationCreates New Log

New log listener

loglogNew Log Command

Log Viewer

Add to log list

Index

AgentTemplatecontains pattern

Update the log file template index

CCMS R/3

CCMS Agent

Create CCMS Agent template

Notify CCMS of finds

Monitor log for patterns

Read Template

RFC

12

3

4

7

5

68

9

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.


50/453

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 location c:\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.

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.


51/453

Example for Unix-based 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.


52/453

The Pattern part specifies the text string pattern to be searched for. Examples are:

Error Warning Information

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 text 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 text 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 text 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 text Warning and will be displayed on the CCMS monitor screen with color yellow.

Example Properties File

logviewer 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.


53/453

# 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 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 = GREEN SATLog_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.


54/453

Example of a CCMS Agent Template File

LOGFILE_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 Socketport

This 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\properties

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

Attribute Setting

Log 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).


55/453

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.


56/453

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 Log

You can view the log file within the Log Viewer application window (dock) or as a separate window (undock).

This may be helpful for the case where you want to compare two or more log files simultaneously in separate windows.


57/453

Procedure

1. Right click on the log file tab in the Log Viewer window, and select Undock. This action launches a new log file window.

2. To dock the file, click on the dock icon .

Search Strings

Searches for the first (and next) log messages that contain the search string. The messages of each row in the log can be searched for a regular expression substring (like the Unix grep tool).

You can perform search on the rows as well as the columns:


58/453

Procedure

1. Right click anywhere on the row or the column (not on the column header). The highlighted text indicates the name of the column. Select GREP to search strings.

2. On the dialog window, enter the search string as the input value and click Ok. The search results appear in the split window. Inside the search result window, when you double click on one row, the upper log file window will automatically scroll to the particular position and highlight the line you have clicked in the log file.

3. The search results appear in the split window. Inside the search result window, when you double click on one row, the upper log file window will automatically scroll to the particular position and highlight the line you have clicked in the log file.

Note: All search strings are case sensitive.


59/453

Show / Hide Columns

You can show or hide columns in the Log Viewer. Right click on the column header and select / deselect the column name which you want to show / hide.

It is also possible to move columns. Drag and drop them at the new position.


60/453

Icons

Icons Meanings

Configure LogViewer Client.

Set the attributes of the selected log file (if it is controlled by the logging.jar service).

Dock.

Toggle displaying the search