portal troubleshoot

.

How to…

Troubleshoot SAP Enterprise

Portal 6.0 SAP ENTERPRISE PORTAL 6.0

PUBLIC

ASAP “How to…” Paper

Applicable Releases: EP 6.0 SP2

May 2004

HOW TO TROUBLESHOOT SAP ENTERPRISE PORTAL 6.0 SP2 PUBLIC

2004 SAP AG 1

Table of Contents Table of Contents............................................................................................................................1

1 Introduction..............................................................................................................................5

2 Architecture Overview.............................................................................................................6 2.1 PORTAL PLATFORM .......................................................................................................................... 6

2.1.1 Portal Framework ................................................................................................................... 6 2.1.1.1 Portal Runtime (PRT).......................................................................................................... 7

2.1.1.1.1 Portal Components........................................................................................................ 7 2.1.1.1.2 Portal Services .............................................................................................................. 7 2.1.1.1.3 Portal Content Directory (PCD) ................................................................................... 7

2.1.2 User Management Engine (UME)........................................................................................... 7 2.2 KNOWLEDGE MANAGEMENT............................................................................................................ 8

2.2.1 Content Management (CM) ..................................................................................................... 8 2.2.2 Text Retrieval and Classification (TREX) ............................................................................... 9

3 Tools - Logs - Traces.............................................................................................................10 3.1 LOGFILE OVERVIEW ....................................................................................................................... 10

3.1.1 Portal Platform Log- and Tracefiles ..................................................................................... 10 3.1.2 J2EE Logfiles ........................................................................................................................ 12

3.2 TOOLS TO VIEW LOGFILES .............................................................................................................. 14 3.2.1 Built in Log Viewer (iView) ................................................................................................... 14 3.2.2 Standalone Log Viewer 6.30 (Offline Tool)........................................................................... 15

3.2.2.1 Installation (Standalone Version 6.30) .............................................................................. 15 3.2.2.2 Working with the logviewer .............................................................................................. 17

3.2.3 Log and File Viewer (iView) ................................................................................................. 19 3.2.4 Java Logging Console (iView) .............................................................................................. 20

3.2.4.1 General .............................................................................................................................. 21 3.2.4.2 Log Level........................................................................................................................... 22 3.2.4.3 Output Media..................................................................................................................... 23 3.2.4.4 Configuring Loggers with logger.xml................................................................................ 23

3.3 OS-LEVEL TOOLS........................................................................................................................... 24 3.3.1 Monitor.................................................................................................................................. 24

3.3.1.1 Windows: Task Manager (taskmgr)................................................................................... 24 3.3.1.2 Windows: Performance Monitor (perfmon) ...................................................................... 24 3.3.1.3 Windows: Process Explorer............................................................................................... 24 3.3.1.4 Windows: PsList (List detailed information about processes) ........................................... 25 3.3.1.5 UNIX: Prstat / Top / Glance .............................................................................................. 25

3.3.2 Http Analysis ......................................................................................................................... 26 3.3.2.1 Isolating Individual URLs with the Browser ..................................................................... 26 3.3.2.2 PortalSniffer ...................................................................................................................... 27 3.3.2.3 Wfetch (Troubleshooting HTTP-Connections) ................................................................. 31

3.3.3 Network Analysis ................................................................................................................... 32 3.3.3.1 Niping (Checks latency and bandwidth of a network connection)..................................... 32 3.3.3.2 Netstat (UNIX and Windows) ........................................................................................... 33 3.3.3.3 Active Ports (Windows) .................................................................................................... 33 3.3.3.4 Ethereal (Network protocol analyzer for UNIX and Windows) ........................................ 33 3.3.3.5 Snoop (Packet Sniffer for UNIX) ...................................................................................... 33

3.3.4 Others .................................................................................................................................... 34 3.3.4.1 Windiff (Graphical File Comparison Tool) ....................................................................... 34 3.3.4.2 Filemon (Displays file system activity on a system in real-time)....................................... 35

3.4 SAP J2EE ENGINE 6.20 RELATED TOOLS ....................................................................................... 35 3.4.1 SAP J2EE Engine Console Log............................................................................................. 35 3.4.2 SAP J2EE Engine Managers and Services Logs ................................................................... 37 3.4.3 SAP J2EE Engine HTTP Service Logs .................................................................................. 38 3.4.4 SAP J2EE Engine Monitoring and Command Line Tools..................................................... 40 3.4.5 Full thread dump................................................................................................................... 41


2004 SAP AG 2

3.4.5.1 How to make a thread dump on UNIX .............................................................................. 42 3.4.5.2 How to make a thread dump on Windows ......................................................................... 42 3.4.5.3 Full Thread dump from J2EE Engine 6.20 running as Windows service .......................... 43 3.4.5.4 Common Problems and Notes ........................................................................................... 44

3.4.6 SAPJ2EE Engine 620 Analyzer ............................................................................................. 44 3.4.7 J2EE Engine HTTP Tracing.................................................................................................. 45 3.4.8 xdProf (Tool to capture and analyze stack traces in a distributed JAVA System)................. 46

3.5 PORTAL PLATFORM RELATED TOOLS ............................................................................................. 46 3.5.1 Client Framework Tools........................................................................................................ 46 3.5.2 PCD Tools ............................................................................................................................. 47

3.5.2.1 PCD Configuration Tool ................................................................................................... 47 3.5.2.1.1 File system configuration parameters for PCD ........................................................... 47 3.5.2.1.2 PCD Parameter Configuration (pcdStartup.installer.properties)................................. 48 3.5.2.1.3 PCD Traces................................................................................................................. 48 3.5.2.1.4 Database connection parameters................................................................................. 50

3.5.2.2 PCD Administration Tool.................................................................................................. 50 3.5.2.3 PCD Permission List Tool ................................................................................................. 50 3.5.2.4 Object Locking Tool.......................................................................................................... 51 3.5.2.5 PCD Browser..................................................................................................................... 52 3.5.2.6 PCD Persistence Layer Editor (plbrowser)........................................................................ 52

3.5.3 PRT Tools .............................................................................................................................. 54 3.5.3.1 Test and Configuration Tools ............................................................................................ 54

3.5.3.1.1 SOAP Admin .............................................................................................................. 54 3.5.3.1.2 Log Admin.................................................................................................................. 54 3.5.3.1.3 Log and File Viewer ................................................................................................... 54 3.5.3.1.4 Browse Deployment.................................................................................................... 55

3.5.3.2 "Portal Anywhere" Admin Tools....................................................................................... 55 3.5.3.2.1 Administration Console .............................................................................................. 55 3.5.3.2.2 Deployment Overview................................................................................................ 56 3.5.3.2.3 Application Console ................................................................................................... 57 3.5.3.2.4 PortalAnywhere.Go .................................................................................................... 57

3.5.3.3 JNDI Browsers .................................................................................................................. 58 3.5.4 Integration of SAP Applications............................................................................................ 58

3.5.4.1 SAP Transaction................................................................................................................ 58 3.5.4.2 Logger for Distributed Session Management (DSM Logger)............................................ 59 3.5.4.3 DSM Monitor .................................................................................................................... 59 3.5.4.4 Application Test with specified Parameters....................................................................... 60

3.5.5 Request Support Tools........................................................................................................... 61 3.5.6 Tools for Themes ................................................................................................................... 62 3.5.7 Performance Monitoring Tools ............................................................................................. 62

3.5.7.1 Request Summary.............................................................................................................. 62 3.5.7.2 Request Overview.............................................................................................................. 63 3.5.7.3 Component Overview........................................................................................................ 65 3.5.7.4 Thread Overview............................................................................................................... 66

3.5.8 Sherlok................................................................................................................................... 67 3.5.8.1 Telnet Console................................................................................................................... 67 3.5.8.2 iView Test-Bench .............................................................................................................. 69 3.5.8.3 iView Monitor ................................................................................................................... 69

3.6 UME RELATED TOOLS ................................................................................................................... 70 3.6.1 User Management Configuration Tool (sapum.properties) .................................................. 70 3.6.2 Logged On Users................................................................................................................... 71 3.6.3 User Account History ............................................................................................................ 72 3.6.4 Single Activity Trace (SAT) ................................................................................................... 72

3.6.4.1 Activating the SAT ............................................................................................................ 72 3.6.4.2 Analyzing the SAT ............................................................................................................ 73 3.6.4.3 Maintaining the SAT-Controller Service........................................................................... 75

3.6.5 UME Logs.............................................................................................................................. 76 3.6.5.1 Usermanagement.log ......................................................................................................... 76

3.6.5.1.1 Loglevel Configuration using the Logging Console ................................................... 76


2004 SAP AG 3

3.6.5.2 Sapum.log (Security Logging)........................................................................................... 78 3.6.6 Test and Configuration Tools................................................................................................ 79

3.6.6.1 Status of UME properties .................................................................................................. 79 3.6.6.2 Cache monitor of UME objects ......................................................................................... 80 3.6.6.3 Performance monitor of UME objects............................................................................... 81 3.6.6.4 Test component for UME objects...................................................................................... 82

3.6.7 Download complete User Management Configuration (config.zip)...................................... 83 3.7 CM RELATED TOOLS ...................................................................................................................... 83

3.7.1 Knowledge Management Log (KM Log) ............................................................................... 83 3.7.2 KM Monitoring...................................................................................................................... 85

3.7.2.1 Component Monitor .......................................................................................................... 85 3.7.2.2 Cache Monitor ................................................................................................................... 85 3.7.2.3 Crawler Monitor ................................................................................................................ 87 3.7.2.4 Application Log................................................................................................................. 87

3.7.3 DBPING Tool (CM Database Connection Test Tool) ........................................................... 88 3.8 TREX RELATED TOOLS.................................................................................................................. 89

3.8.1 TREX Monitor ....................................................................................................................... 89 3.8.2 Search Engine Trace ............................................................................................................. 90 3.8.3 TREX Mining Trace............................................................................................................... 91 3.8.4 Python Trace ......................................................................................................................... 93 3.8.5 TREXNameServer Trace........................................................................................................ 94 3.8.6 TREXPreprocessor Trace...................................................................................................... 95 3.8.7 TREX Filter Trace ................................................................................................................. 96 3.8.8 TREX Queue Client ............................................................................................................... 97 3.8.9 TREX Queue Server Trace .................................................................................................... 97 3.8.10 Dump_index Command ....................................................................................................... 100 3.8.11 TREX Index Server Trace.................................................................................................... 101

3.9 BACKEND RELATED TOOLS .......................................................................................................... 103 3.9.1 DB related Tools ................................................................................................................. 103

3.9.1.1 Monitoring DB ................................................................................................................ 103 3.9.1.2 Oracle Alert File .............................................................................................................. 103 3.9.1.3 Oracle User Trace Files ................................................................................................... 104 3.9.1.4 MS SQL Server Database Logs ....................................................................................... 104

3.9.2 LDAP related Tools............................................................................................................. 105 3.9.2.1 LDAP Tracer ................................................................................................................... 105 3.9.2.2 Java LDAP Debugging .................................................................................................... 105 3.9.2.3 SSL Debugging................................................................................................................ 106 3.9.2.4 LDAP Browser ................................................................................................................ 107

3.9.3 R/3 ....................................................................................................................................... 107 3.9.3.1 Monitoring R/3 backend connections .............................................................................. 107 3.9.3.2 SAPJCo Trace ................................................................................................................. 107

4 Problem-oriented Troubleshooting....................................................................................108 4.1 SAP J2EE ENGINE 6.20................................................................................................................ 108

4.1.1 First Aid............................................................................................................................... 109 4.1.1.1 URL Check...................................................................................................................... 109

4.1.2 Starting and stopping the SAPJ2EE Engine 620................................................................. 109 4.1.2.1 Files service.ini and cmdline.properties........................................................................... 111 4.1.2.2 Configuring r3startup service .......................................................................................... 113 4.1.2.3 Installing and uninstalling the Windows service SAP J2EE Engine Dispatcher ............. 114 4.1.2.4 Common Problems and Notes ......................................................................................... 114

4.1.3 Upgrade............................................................................................................................... 115 4.1.3.1 Upgrading SAPJ2EE Engine 6.20 ................................................................................... 115 4.1.3.2 Upgrading Java Development Kit (JDK)......................................................................... 116 4.1.3.3 Upgrading SAP Java Connector (SAP JCo) .................................................................... 116 4.1.3.4 Upgrading Additional libraries ........................................................................................ 117

4.1.4 Out of memory ..................................................................................................................... 117 4.1.4.1 Common Problems and Notes ......................................................................................... 117

4.1.5 DBMS issue during startup ................................................................................................. 118


2004 SAP AG 4

4.1.6 Page cannot be displayed (or only parts are displayed) ..................................................... 118 4.1.6.1 Common Problems and Notes ......................................................................................... 118

4.1.7 Configuration check ............................................................................................................ 118 4.1.8 Improvement of Performance and Stability......................................................................... 119

4.2 PCD ............................................................................................................................................. 120 4.2.1 PCD related problem or UME related problem?................................................................ 120 4.2.2 Pre-Check............................................................................................................................ 120 4.2.3 Problem categories.............................................................................................................. 120

4.2.3.1 Basis (PCD GL) Problems............................................................................................... 121 4.2.3.2 Performance Problems..................................................................................................... 121 4.2.3.3 Permission Problems ....................................................................................................... 122 4.2.3.4 Permission and Roles....................................................................................................... 122 4.2.3.5 Import of EP5 content...................................................................................................... 122 4.2.3.6 JavaScript errors .............................................................................................................. 123

4.2.4 Important files and logs to attach to OSS-Message............................................................. 124 4.3 DB ............................................................................................................................................... 124

4.3.1 Portal is hanging since DB is not responding..................................................................... 125 4.4 UME............................................................................................................................................ 125

4.4.1 LDAP Issues ........................................................................................................................ 125 4.4.1.1 Caching............................................................................................................................ 125 4.4.1.2 LDAP search uses non-indexed attributes ....................................................................... 125

4.4.2 Important files and logs to attach to OSS-Message............................................................. 126 4.5 SINGLE SIGN ON ........................................................................................................................... 126

4.5.1 Single Sign-On with SAP Logon Tickets.............................................................................. 126 4.5.1.1 R/3 Configuration ............................................................................................................ 127 4.5.1.2 Portal Configuration ........................................................................................................ 130 4.5.1.3 Common Problems and Notes ......................................................................................... 131

4.5.2 Single Sign-On with User ID and Password ....................................................................... 131 4.5.3 FAQ Single Sign On ............................................................................................................ 132

4.6 SECURE COMMUNICATION ........................................................................................................... 132 4.6.1 SSL Troubleshooting ........................................................................................................... 133

4.6.1.1 SAPJ2EE Engine ............................................................................................................. 134 4.6.1.1.1 Check Certificate ...................................................................................................... 135 4.6.1.1.2 Check SSL Service ................................................................................................... 136

4.6.1.2 SSL between Portal Server and LDAP ............................................................................ 137 4.6.2 SNC Troubleshooting .......................................................................................................... 138

4.7 KNOWLEDGE MANAGEMENT........................................................................................................ 139 4.7.1 CM Database related issues ................................................................................................ 139

4.7.1.1 Wrong configuration in config_local.properties ............................................................. 139 4.7.1.2 Wrong Username/Password Setting for the Connection Pools ........................................ 140 4.7.1.3 Property Files of Connection pools ................................................................................. 140 4.7.1.4 Maximum Number of Processes Exceeded (Oracle specific) .......................................... 141

4.8 MISCELLANEOUS .......................................................................................................................... 141 4.8.1 Platform Availability Matrix (PAM).................................................................................... 141 4.8.2 Sizing ................................................................................................................................... 141 4.8.3 Portal Development Kit ....................................................................................................... 142

5 Appendix...............................................................................................................................142 5.1 REMOTE ACCESS.......................................................................................................................... 142

5.1.1 NetMeeting .......................................................................................................................... 142 5.1.2 PcAnywhere......................................................................................................................... 143 5.1.3 Telnet ................................................................................................................................... 143 5.1.4 Http-Connect (in preparation)............................................................................................. 143


2004 SAP AG 5

1 Introduction

This how-to guide was created to provide a comprehensive overview of the checks, tools, traces, and logging mechanisms available within the SAP Enterprise Portal 6.0 landscape. This guide, however, cannot cover all potential problems or provide a first-hand solution for all possible issues. Detailed and up-to-date problem handling can only be covered by the Support Services.

The document is divided into three central chapters. Chapter 2 gives a short overview of the archi-tecture of the SAP Enterprise Portal 6.0. In chapter 3 the technical details of tools, traces and logs are described. Finally, chapter 4 contains problem-oriented troubleshooting suggestions.

For additional information/documentation please have a look at the “SAP Enterprise Portal Docu-mentation” (http://help.sap.com -> SAP NetWeaver -> SAP Enterprise Portal -> Release EP6.0 SP2).

Moreover you can find helpful information in the SAP Service Marketplace, Alias “nw-ep” (http://service.sap.com/nw-ep).

To get the latest news on EP6.0 recommendations, check the various notes that are mentioned in this guide (http://service.sap.com/notes).

Another source of topic oriented documentation is the area “ep60howtoguides” in the SAP Service Marketplace (http://service.sap.com/ep60howtoguides).

Finally you can join the SAP Developer Network (http://sdn.sap.com). SAP Developer Network serves a vast community of SAP experts in the world and includes: Weblogs by experts from SAP and other companies, original articles, white papers and how-to guides, moderated discussion forums, access to SAP notes, downloads and eLearning offerings.

Note: All non SAP-tools in this document are only described exemplarily. That means that SAP does not recommend any of these tools explicitly. There are similar tools available that can be used instead.


2004 SAP AG 6

2 Architecture Overview

2.1 Portal Platform

Internally, the portal platform is integrated with SAP J2EE Engine, which is an SAP proprietary Java application server based on the Java 2 Enterprise Edition (J2EE) standards. The application server provides an HTTP server servlet engine that handles HTTP related processes for the por-tal.

Structurally, the portal platform is composed of the Portal Framework. As an integral part of SAP Enterprise Portal, the portal platform is responsible for all processes, including components that pass messages to other platforms, and interfaces such as Knowledge Management and Collabo-ration.

2.1.1 Portal Framework

The portal framework is a logical environment that consists of a collection of software compo-nents:

• Portal Runtime (PRT)

• Portal Content Directory (PCD), service-based implementation of the portal infrastructure that interfaces with the portal system database.

• Portal System Database (repository), a database that serves as a central location in which an aggregation of specific portal data is maintained and selectively obtained at runtime for further processing. The PCD has interfaces to the database.


2004 SAP AG 7

• User Management Engine (UME), an SAP proprietary mechanism that manages user, group, and role data. It connects to the User Persistence Store.

2.1.1.1 Portal Runtime (PRT)

The PRT is the system that gathers and runs iViews. In other words, it is a gateway between the portal and iViews. The PRT is integrated into the SAP J2EE Engine. In addition, the PRT is a host to portal applications which consist of Java software programmed for the portal. It is packaged in an EAR file called IRJ (iView Runtime for Java). The PRT contains the objects Portal Compo-nents and Portal services.

2.1.1.1.1 Portal Components

A portal component is custom Java code that is executed according to user requests, and gener-ates HTML output for display on the client.

For example, when a user requests an iView, the portal runtime (PRT) first generates a corre-sponding portal component, if one does not exist already. The portal component that is invoked is then returned to the PRT, before being passed on to the client.

2.1.1.1.2 Portal Services

Portal services are an extension of the Web services technology. They usually include some com-bination of programming, data, and resources that are accessible to portal applications from the portal runtime (PRT).

Portal services act as the middleware, that is, interfaces that are enabled to exchange procedures and data. Also, services provide a means of standardizing data formats, and can access protocols such as SOAP, JCo, XML, HTTP(s) and TCP/IP.

There are two groups of portal services: the core services that are part of the PRT, and the ex-ternal services that extend the procedures and functionality of the PRT.

2.1.1.1.3 Portal Content Directory (PCD)

From the architectural point of view, the PCD is a logical layer of services that interfaces with por-tal components on one hand, and with the Portal System Database on other.

The PCD is the central storage mechanism of the portal. It stores data from portal content objects such as roles, pages, worksets, system landscape, and many more. The details of such data are in portal archive (PAR) files that have been deployed on the portal.

2.1.2 User Management Engine (UME)

SAP User Management Engine (UME) consists of a user management service in the Portal Server that connects to and manages user and group data stored in the user persistence store. As such, the individual portal applications do not have to rely on their own user management. Instead, the administrator can administer user data centrally through UME.


2004 SAP AG 8

UME user data is stored in one or more data sources (LDAP Directory, Database, SAP System). Each type of data source has its own persistence adapter. The persistence manager consults the persistence adapters when creating, reading, writing, and searching user management data. The application programming interface (API) is a layer on top of the persistence manager.

In the persistence manager, you configure which data is written to or read from which data source, so that the applications using the API do not have to know any details about where user manage-ment data is stored.

2.2 Knowledge Management

2.2.1 Content Management (CM)

The Knowledge Management platform consists of a set of iViews, roles and services that run within the PRT on the SAP J2EE Engine.


2004 SAP AG 9

The repository manager framework is the physical storage location for documents. It provides a range of basic functions for documents and folders. It enables the integration of documents into a virtual hierarchy and a namespace. The documents can be stored on different systems (Windows, Lotus Notes, WebDAV, or HTTP). The repository services use additional services, such as indexing, subscription, and status management to combine the individual repositories. Global services are responsible for many CM tasks. For example, for indexing, crawlers are used that deliver objects and structures from internal or external repositories. Automatic notifications arrive in your inbox.

2.2.2 Text Retrieval and Classification (TREX)

Knowledge Management services can access TREX functionality through the TREX Java Client. TREX itself comprises a series of portal-independent services that typically run on a separate server. These services can communicate via HTTP or TCP/IP and provide individual tracers in most cases.


2004 SAP AG 10

3 Tools - Logs - Traces

3.1 Logfile Overview

There are a couple of tools for viewing logfiles. Most of the logfiles are plain text. Therefore you can view them by navigating through the OS to their location and then using an editor like word-pad. Another possibility is to look at them using the portal-UI. There you can use the Logging Console (-> chapter 3.2.3), the Log and File Viewer (-> chapter 3.2.3) or the built in LogViewer (-> chapter 3.2.1). The most convenient way, especially in a clustered environment or if the J2EE Engine does not start up properly, is to use the Standalone LogViewer (-> chapter 3.2.2).

Moreover there is a central alerting tool, called Computing Center Management System (CCMS). This will not be covered in this document. For further information you can have a look at the “Enterprise Portal 6.0 System Landscape Monitoring – Best Practice for Solution Monitoring”. This can be in the Service Marketplace (http://service.sap.com/nw-ep -> Product Information -> Enterprise Portal 6.0 -> Documentation and More).

3.1.1 Portal Platform Log- and Tracefiles

The following logfiles can be found in:

\..\cluster\server\services\servlet_jsp\work\ jspTemp\irj\root\WEB-INF\portal\logs

They can be displayed with the Logging Console, Log and File Viewer, Standalone Logviewer 6.30 and the built in Logviewer.

The loggers can be activated/configured in the Logging Console (-> chapter 3.2.4).

Loggername Logfile Logger for

acl_logger acl.log ACL service

appdesigner_logger Appdesigner.log Application Designer - to track app designer activities

asyncresponse_logger delegeeName=portal_logger Asynchronous Response Event (for dev)

broker_logger delegeeName=portal_logger Portal Application Broker

debug_logger debug.log used by different components and services

default_logger delegeeName=portal_logger Default Logger is used to output messages to portal.log

diagnostic_logger diagnostic.log Use during development to prevent UNIX compliance problems

dsm_logger dsm.log Distributed Session Management

dynamic_logger dynamic.log Use during development to dynamically change the output file

generic_creator_logger generic_creator.log Generic Creator (component which create the initial content) and proxy service

http_logger http.log HTTP and proxy service

iview_logger iview.log Information coming from iviews. Used for components that do not have a specific logger

iviewserver iviewserver.log Iviewserver components


2004 SAP AG 11

JCOClientPoolLogger JCOClientPool.log Logging of JCO client pool activities in JCO client service

jsp_logger jsp.log Applications using JSP pages - gives gener-ate java file name, result of the jsp compila-tion, exceptions of compilation and execution

monitor_logger monitor.log Monitor component and service - to track monitor tasks, number of users…monitor ac-tivities

navigation_logger navigation.log Navigation Service and iViews - to track navi-gation process

notification_logger notification.log Notification component and service - to track topics subscription and messages published and received.

page_logger pageBuilder.log PageBuilder component - to track page build-ing process

pcd_admin_tools_logger pcdadmintools.log PCD admin tools

pcd_logger

(-> chapter 4.2.3.1)

pcd.log PCD

portal_logger portal.log Use by the default logger and system logger

prtcache_logger delegeeName=portal_logger Cache

sapapplication_logger sapapplication.log Application Integration

service_logger service.log Information coming from services. Used for services that do not have a specific logger

soap_logger soap_log SOAP framework and Portal Web Services

stylearchive.logger com.sapportals.portal.design.StyleArchive.log

styleeditor.logger com.sapportals.portal.design.StyleEditor.log

styleservice.logger com.sapportals.portal.design.StyleService.log

system_logger delegeeName=portal_logger Use to output INFO messages to console and portal.log

TestAPI_logger TestAPI.log Testing APIs component

time_logger time.log An example of custom logger

transport_logger

(-> chapter 4.2.3.1)

transport.log Transport application

um_info_logger usermanagement.log


2004 SAP AG 12

umWebService_logger umWebService.log UmWebService service - to track userman-agement for web services infos

unification_logger unification.log Unification - to track Unification activities

usermanage-ment_logger

(-> chapter 3.6.4)

delegeeName=um_info_logger

Usermanagement service - to track user management activities, user info, connec-tion…

yahoo_logger yahoo.log Yahoo service and components

pcm_default_logger pcm_default_impl.log

textrepository_logger textrepository.log

contentFetcher_logger fetcher.log

global_portal_consumer_logger

global_portal_consumer.log

global_portal_producer_logger

global_portal_producer.log

The following logfiles cannot be displayed with all available viewers.

Logfile / Trace

Location

Activation Stand-alone Log-

Viewer (Offline Tool)

Built In Log-

Viewer (iView)

Log and File

Viewer (iView)

Java Log-ging Con-sole

(iView)

sat.trc (-> chapter 3.6.4.1)

(\..\cluster\server\log)

Portal UI: Activity Tracing

X

(recom-mended)

X

(other format)

ccms_jmon.trc

ccms_agent.trc

knowledgemanagement.%g.log

(\..\cluster\server\services\servlet_jsp\work\ jspTemp\irj\root\WEB-INF\portal\logs)

Via log-ging.properties

(-> chapter 3.7.1)

X X

sapum.log (-> chapter 3.6.5.2)

(\..\cluster\server\managers)

Sapum. properties

X X X

System.log

(\..\cluster\server\log)

X X

3.1.2 J2EE Logfiles

Logfile / Trace

Location

Compo-

nent

Activation Stand-alone Log-

Viewer

Built In Log-

Viewer (iView)

Log and File

Viewer (iView)

Java Log-ging Con-


2004 SAP AG 13

(Offline Tool)

sole (iView)

YYYY_DD_MM_at_HH_MM_SS_output.log

(\..\cluster\dispatcher\managers\console_logs)

(\..\cluster\server\managers\console_logs)

(-> chapter 3.4.1)

J2EE con-sole_logs. properties

X

X

X

YYYY_DD_MM_at_HH_MM_SS_error.log

(\..\cluster\dispatcher\managers\console_logs)

(\..\cluster\server\managers\console_logs)

(-> chapter 3.4.1)

J2EE con-sole_logs. properties

X X X

INFO.log, NOTICE.log, WARNING.log, ER-ROR.log, EMERGENCY.log, ALERT.log

(\..\cluster\dispatcher\managers\log )

(\..\cluster\dispatcher\managers\log\classloader)

(\..\cluster\dispatcher\managers\log\cluster )

(\..\cluster\dispatcher\managers\log\connections )

(\..\cluster\dispatcher\managers\log\lockbackup )

(\..\cluster\dispatcher\managers\log\memory )

(\..\cluster\dispatcher\managers\log\ports )

(\..\cluster\dispatcher\managers\log\r3startup )

(\..\cluster\dispatcher\managers\log\service)

(\..\cluster\dispatcher\managers\log\swap)

(\..\cluster\dispatcher\managers\log\thread )

(\..\cluster\dispatcher\managers\log\timeout )

all files can be found as well in the

\..\cluster\server\managers\ -structure

(-> chapter 3.4.2)

J2EE X X X

At the default locations

<inst>/cluster/dispatcher/services/log/work and <inst>/cluster/dispatcher/services/r3startup/log as well as at <inst>/cluster/server/services and the subfolders /ejb/log, log/work, ts/log, http/log and PRTBridge/log you will find logfiles with the following signature:

• INFO.log

• NOTICE.log

• WARNING.log


2004 SAP AG 14

• ERROR.log

• ALERT.log

• EMERGENCY.log

• CRITICAL.log

• DEFAULT.log

• DEFAULTCRITICAL.log

Notice that there are not necessarily all mentioned logfiles.

If you are using the logviewer you will find the logviewer_server.log at <inst>/cluster/server.

3.2 Tools to view Logfiles

3.2.1 Built in Log Viewer (iView)

For a quick check you can use the built in LogViewer. There you can look at the most commonly used logfiles. Currently there is a difference between the built in Log Viewer and the Standalone LogViewer. You can only see logfiles, in which corresponding loggers have been activated before. So you can get a quick overview about the active logfiles.

The built in Log Viewer is an iView in the Portal and can only be used if the portal is up and run-ning (-> the Standalone Logviewer can also be used, if the portal is down).

Path: System Administration -> Support -> SAP J2EE Log Viewer -> Log Viewer for J2EE 620

Only these Logfiles are dis-played in the built in Log-Viewer, where the correspond-ing logger has been activated before.

-> Select one file -> DONE


2004 SAP AG 15

-> Log File will be displayed

-> You are able to search in the logfile

Under Messages you can see many lines with …FileNotFoundExceptions…

The corresponding loggers have not been activated before, so the files could not be found and the log file will not be dis-played in the upper log files area.

3.2.2 Standalone Log Viewer 6.30 (Offline Tool)

A convenient way to analyze all log files, especially in a clustered environment or if the J2EE En-gine does not start, is to use the standalone logviewer. This logviewer is a tool based on a client/ server architecture to show the content of logfiles at a single point even if you are using a clus-tered environment.

3.2.2.1 Installation (Standalone Version 6.30)

Depending on the patch level of your J2EE Engine you may find the logviewer-standalone.zip file at <inst>/admin. If not, then download this file from the SAP Service Marketplace. Distribute this file to all server nodes of interest and to the machine where you want to analyze the log files and unzip them. An Enduser Administration Guide can be found on the SAP Service Marketplace (http://service.sap.com/nw-ep -> Product Information -> Enterprise Portal 6.0 -> Documentation & More -> Fundamentals).

Be sure that the environment variables JAVA_HOME and LV_HOME (Logviewer home) are set properly. Open the file LogViewerServer.properties. At the very end you see the entries

Logviewer_LogDirectoryReadFromFile = /tmp/ReadableLogDirectory.xml and

Logviewer_LogDirectoryWriteToFile = /tmp/WritableLogDirectory.xml

You should change the foldername “tmp” to another reliable name.

The file ReadableLogDirectory.xml is an initial file which may contain the default logs to be dis-played. It is not necessary that this file exists. Also, if you have such a file you can rename it or you can change the name inside the properties file. The content of this file is copied to WriteableLog-Directory.xml when the logviewerserver is launched the first time.


2004 SAP AG 16

On each server node run server.bat (Windows) or server.sh (UNIX). On the client machine (the machine where you want to look at the log files) run client.bat (Windows) or client.sh (UNIX) re-spectively. If you later want to stop the server, run stopserver.bat or stopserver.sh respectively.

After launching the client there will appear a popup where you have to enter the required server nodes.

1. On the Configuration window, choose Add.

2. On the new window (Add a Log Viewer Server), you will see the following fields:

Name: name of the server

Host Name: is the name of the host system to be monitored

Port: is the number of the port on the system where the server is listening for new logs

Connection: Options from: J2EE / Standalone / NI/Standalone

User: Enter user name, when using the J2EE Engine. This field will be grayed out when running the Standalone Log Viewer version.

Password: Enter password (optional). The password is only used for connecting to the J2EE server and is the same you have to enter in the Visual Adminis-trator. Changing it is only possible in the User Management Engine con-figuration screens of the WebAS.

Router String: This field will be visible when using the NI socket connection. It will be grayed out in other cases.

3. Enter information in the required fields and choose Ok.

4. Select / highlight the server name. Choose Test Connection to test the connection to the

server before you save the configuration.

5. Choose Ok to save your configuration and connect to the server. The connected server


2004 SAP AG 17

name will be refreshed on the side menu navigation tree / table.

6. To edit the application settings, select the application name. Choose Edit.., and change the

settings as required. Choose Ok. Alternatively the entries can be edited directly in the

corresponding fields.

7. To remove a monitored application, highlight the server name and choose Delete.

8. If you later want to add a new connection to the server in the Log Viewer, select File -> Configu-ration from the main menu.

After you have entered all desired nodes you are able to work with the logviewer.

3.2.2.2 Working with the logviewer

After the client is launched and the server nodes are entered you can see a screen similar to the following:

To view a particular logfile click on its name in the file tree on the left side. Its content is then dis-played on the right side.

If you want to refresh the tree structure click on . To refresh the log in the right pane click on

. To refresh a subnode right-click on the subnode and choose Refresh this node.

If you are not interested in each column you can hide/show them by clicking on the column header. Then a list will be displayed where you can deselect/select the columns you want to see. Furthermore, you can separate wanted lines from unwanted in two ways. First you can select all lines which contain a specific search string by right-clicking in the column (not in the header!!!) where you want to search. Choose “Search for a String Message” from the popup window. Enter a search string (case sensitive) and click OK. In a new pane you will get an excerpt from the original logfile in which only lines which include the search string inside the chosen column are displayed. Secondly, you can do the exact opposite, i.e. you can hide all lines containing a specific string. This is done by right-clicking in the desired column (not in the header!!!) and choosing “ Add a filter to message”. Then enter a filter string and click OK. As a result you see only the lines of the logfile which do not contain the filter string inside the chosen column.

You can view the logfile within the LogViewer’s application window (dock) or as a separate window (undock).

• To undock a logfile first double-click on the logfile in the tree to display the logfile in the right pane. In this pane click on the top tab (where a number is displayed). A separate window is launched with the log records.

• To dock the logfile again click on the dock icon


2004 SAP AG 18

There is also a merge function. If you first select two or more files in the left pane and then right-click you can choose Merge files and display. The merged result is displayed in the right pane. But be aware that you can only merge files with a similar sequence and only out of the following three format types: List format, SQL Trace format and SAT Trace format.

To add a logfile to the tree click on file and choose Add a file… A new window pops up. Search the desired logfile and choose an appropriate format. Click on add.

Supported Formats

Logfiles are written in a particular format. The Logviewer supports the following formats:

• Trace format

• ASCII format

• List format

• SQL Trace format

• SAT Trace format

The trace format is the most commonly used format. This format can be customized by use of a pattern. For example, this format is used by the com.sapportals.portal.prt.logger.ILogger logger interface.

The ASCII format is appropriate for plain text files with no particular format.

The list format is for files where the different fields are hash-separated.


2004 SAP AG 19

The SQLTrace format and the SAT Trace format (Single Activity Trace) apply for specialized Log-files, written in this format.

For detailed information about administration and use, see the separate Administration and User Guide for the Log Viewer, which is included in the installation zip-file.

Relevant OSS notes/links

621466 Log Viewer note overview

3.2.3 Log and File Viewer (iView)

The Log and File Viewer is another tool to search, display and analyze Enterprise Portal files.

<GroupName>.<Component Name>: com.sap.portal.runtime.admin.logviewer.default

Path: System Administration -> Support -> Portal Runtime -> Log Viewer

-> Press the Browse But-ton

-> You are able to navigate through the whole direc-tory.

-> Pressing the SELECT Button you are able to see the content of each file

You can view and download directly the se-lected file from the portal-UI.

Clicking on ERRORS you can see an Exceptions Analysis.

Scrolling down you can find Hyperlinks which direct you to a short analysis of the exception.


2004 SAP AG 20

3.2.4 Java Logging Console (iView)

The Portal Runtime provides a logging mechanism that allows the administrator to diagnose prob-lems more easily. This consists of:

• A Java API that developers of iViews can use to allow their iViews to log all relevant in-formation. iView developers can find detailed documentation on how to call the logging API from an iView on the iView studio at www.iviewstudio.com.

• A Logging Console (System Administration -> Monitoring -> Portal -> Logging Console) that can be accessed through the administrator role in the Enterprise Portal. This allows administrators to view the content of loggers and to configure logging with the Logging Console.

Configuration files in which the administrator can create new loggers and assign logging classes to loggers

There are a few basic concepts that explain logging with the Logging Console:

Each package that outputs logging information using the Java API is assigned to a logger, either by default or explicitly by the administrator. A logger is a virtual entity that works with one or more log files. One or more logger classes can be assigned to each logger, and each logger class writes to a different log file.

Logger classes define the output format of the logging information. For example the logger class SimpleFileLogger writes logging information in text format. The XMLFileLogger writes logging in-formation in xml format.

In addition, you can define a different logging level at which the logger class writes logging infor-mation to the log file for each separate logger class. For example, if a logger class is configured to write logging information at level severe only, messages indicating a serious error will be written to the log file associated with the logger class.


2004 SAP AG 21

3.2.4.1 General

At the logging console you can select the server, the logger, the logger class and the displayed Logger Levels. Afterwards one can view the assigned logfile by clicking “Display”. By choosing “Configuration Mode” one can change the following settings for a log file that is a specific combi-nation of server, logger and logging class:

• Activate/deactivate logger

• Change logger pattern

• Change logging level

• Change name and/or location of log file

• Change the maximum size of the log file

• Activate/deactivate logging for packages associated to the logger

These operations can be done for one server, or for all servers of the cluster.


2004 SAP AG 22

Activating/deactivating a logger

Set Logger Activated to TRUE to activate the logger.

Set Logger Activated to FALSE to deactivate the logger.

When you deactivate the logger, the logger stops writing logging in-formation to the log file associated with the selected logger class.

Changing logger pattern By changing the logger pattern, you change the formatting of the output to the log files. However you should use this option with cau-tion, as the Logging Console cannot display all formats. For more information refer to the administration guide.

Changing logging level By changing the logging level in the Level field, you change the level at which logging messages are written to the log file. For a detailed description of the possible levels see later on.

Changing name and/or location of log file

In the Log file field, you can specify the relative path of the log file. The path is relative to <servlet-engine>/irj. By changing the value in this field, you can make the logger write to a new log file. The system automatically creates the file in the directory you specified.

Changing the maximum size of the log file

Specify the maximum size in bytes of the log file in the corresponding field.

Activating/deactivating logging for packages as-sociated to the logger

One can assign one or more packages to a logger. In administration mode the list of packages assigned to a logger is displayed. For each package you can choose to activate or deactivate it through an entry in the classLogger.xml file. When a package is deactivated, the log-ging messages from that package are no longer written to the log file. For a detailed description refer to the administration guide.

Relevant OSS notes/links 589014 Information about the DSM Logger

589012 Information about the Usermanagement Logger

To confirm your changed settings for all the servers of the cluster, choose Apply.

To confirm your changed settings for only the selected server, choose Apply locally. To display the logfile choose View Mode.

Logger Types

The Portal Builder Runtime API offers various ways to log and trace iViews and services. A list of the PRT loggers that are implemented on the PRT API, can be found in chapter 3.1.1.

3.2.4.2 Log Level

You can set log levels to trace different problems in different depths. Log messages are classified from SEVERE to INFO, depending on the severity of the (error) message. The verbosity of each logger class can be adjusted separately by modifying its log level. Possible log levels are:

Log Level Description

OFF Special level that can be used to turn off logging.

SEVERE Message level that indicates a serious failure. Only SEVERE mes-sages are raised.

WARNING Level indicating a potential problem. All WARNING messages as well as SEVERE messages are raised.

INFO Message level for informational messages. All INFO messages as well as WARNING and SEVERE messages are raised.


2004 SAP AG 23

ALL All messages are logged.

3.2.4.3 Output Media

Each logger can address different output media depending on the logger class with which the log-ger is associated. Available logging classes are:

Logging Classes Description

ConsoleLogger Writes log messages on the screen.

ListFileLogger Writes log messages in a file with a simple hash-separated-field format.

SimpleFileLogger Writes log messages in a file. The administrator can specify the pat-tern used for the format.

XmlFileLogger Writes log messages in a file with XML format.

3.2.4.4 Configuring Loggers with logger.xml

Instead of using the Logging Console to change each logger separately, you can edit and modify the logger configuration file logger.xml directly. This file is located at \..\irj\root\WEB-INF\portal\system\xml.

All available loggers are configured by the corresponding section in the logger.xml configuration file. The following extract of the logger.xml file shows a sample configuration of portal_logger:

<Logger name=”portal_logger” loggerInterface=”com.sapportals.portal.prt.logger.ILogger'”isActive=”true” pattern=”%d # %20t %15s %m #”>

<LoggerClass className=”com.sapportals.portal.prt.logger.SimpleFileLogger” level=”ALL”>

<param filename=”logs/portal.log” append=”false” limit=”800000”>

</param>

</LoggerClass>

<LoggerClass className=”com.sapportals.portal.prt.logger.XmlFileLogger” level=”OFF”>

<param filename=”logs/portal.xml” append=”false”>

</param>

</LoggerClass>

<LoggerClass className=”com.sapportals.portal.prt.logger.ConsoleLogger” level=”INFO”>

</LoggerClass>

</Logger>

The following table shows the attributes that can be changed:


2004 SAP AG 24

Attribute Value Description

isActive true/false (De)activates the logger

level OFF/SEVERE/WARNING/INFO/ALL Verbosity level of logger class

filename <filename> Log file name

append true / false Logs are attached to log file or new log file is created for each session

pattern For a detailed description refer to the Administration Guide

Set the output format. Be careful, not every format is supported

limit filesize Limits the length of the logfile

In addition to (de)activating a log file and modifying its pattern, verbosity level or size, you can cus-tomize some output files of the Java services in their related properties files:

Usermanagement: <inst dir>\..\..\global\config\pcd\pcdStartup.installer.properties look inside <inst dir>\..\..\global\config\pcd\pcdStartup.installer.properties for an explanation. (note 589012)

DSM logger: move to System Administration -> Support -> SAP Application. There you can switch the DSM logger on or off. (Note 645976)

Possible modifications are described/referred to inside the note in brackets.

Please note: These specific implementations and centralized access to the configuration of log files are still being developed. Single logs are still handled differently, depending on how they are implemented by the development team. Therefore slight changes may occur in the future.

3.3 OS-Level Tools

3.3.1 Monitor

3.3.1.1 Windows: Task Manager (taskmgr)

The task manager provides snapshot information on the whole operating system resource con-sumption and on individual processes. Processes of top interest are server.exe (J2EE Engine) (or java.exe, depending on the way the server node is started). It may be useful to customize the “processes” view to display additional columns: Use the menu path View -> Select columns to ac-tivate the items Thread Count, Handle Count, and I/O read bytes. For analysis, you can sort by any column in the process view, e.g. CPU, mem usage, or I/O read bytes.

3.3.1.2 Windows: Performance Monitor (perfmon)

The Windows performance monitor provides the infrastructure to monitor performance data from a large choice of performance counters over longer periods of time. You can use it for ad-hoc moni-toring (System Monitor) or for scheduled monitoring (Performance Logs and Alerts->Counter Logs). In particular the scheduled monitoring is useful for monitoring customer systems if the por-tal has non-permanent performance problems.

3.3.1.3 Windows: Process Explorer

The tool Process Explorer allows you with a right mouse click on the process -> Properties to see the current directory of a process. In this example you can identify, which java.exe belongs to the dispatcher.


2004 SAP AG 25

Additional information: http://www.sysinternals.com/ntw2k/freeware/procexp.shtml

3.3.1.4 Windows: PsList (List detailed information about processes)

Most UNIX operating systems ship with a command-line tool called "ps" (or something equivalent) that administrators use to view detailed information about process CPU and memory usage. Win-dows NT/2K comes with no such tool natively, but you can obtain similar tools with the Windows NT Workstation or Server Resource Kits. The tools in the Resource Kits, pstat and pmon, show you different types of information, and will only display data regarding the processes on the system on which you run the tools.

PsList is a utility that shows a combination of the information obtainable individually with pmon and pstat. You can view process CPU and memory information, or thread statistics.

pslist –d can be used for thread analysis: for the java VM, you may find out that native ID of a thread that consumes extremely much CPU time. In combination with the full thread dump (-> chapter 3.4.4), which provides a mapping between java threads and OS threads, you can use this information to identify the java thread that consumes too much CPU.

Additional information: http://www.sysinternals.com/ntw2k/freeware/pslist.shtml

3.3.1.5 UNIX: Prstat / Top / Glance

Prstat and Top are two commands in UNIX which show similar information as the taskmanager in Windows.

Top has to be installed separately.


2004 SAP AG 26

Prstat is shipped with Solaris per default.

The same tool under HP-UX is called “Glance”.

3.3.2 Http Analysis

3.3.2.1 Isolating Individual URLs with the Browser


2004 SAP AG 27

As a quick tool to identify the URL for a browser window or a HTML <frame> or <iframe> that has, e.g., a high loading time or that reports errors, right-click on the frame and select Properties. The popup displays the address (URL) and the size of the document. For long URLs, the address field is too small. Use the mouse to highlight the complete URL (try moving down a little bit to collect all hidden lines). Using copy and paste you can transfer the URL to any editor. You can also directly enter this URL in the address bar of the portal. Try if the URL behaves in the same way in the cur-rent browser window (where you opened the properties popup) and in a newly launched browser. If you see the performance problem only for this URL, you managed to isolate the problem to a single URL.

3.3.2.2 PortalSniffer

This tool has been developed by SAP and is available in the SDN (http://sdn.sap.com à use the search function).

Configuration Steps:

Maintain your LAN-Settings: use as proxy server localhost 8001

Make sure, that you have installed j2sdk1.4.2 and the path in the Batch-file is maintained accord-ingly.

There are several ways to configure PortalSniffer:

No SSL SSL

No Proxy go.bat goSSL.bat

Proxy goProxy.bat goSSLProxy.bat

If you do not need SSL and no Proxy, you should use the go.bat:


2004 SAP AG 28

If you do not need SSL but a Proxy (e.g. for Internet Connection), use goProxy.bat:

If you do not a Proxy, but SSL use the goSSL.bat:

If you need SSL and a Proxy, use the goSSLProxy.bat:

Start the PortalSniffer in the CommandPrompt with corresponding batch-file (here goSSL.bat):


2004 SAP AG 29

The GUI will be opened. Type in a Transaction Name. This transaction name will be written in the httptrace-CSV-File. With a transaction you can group all requests belonging to one action/click (e.g. the login to the portal).

By clicking on the Start Transaction, every “click” in the browser will be recorded.

When the browser page has been loaded or your transaction is finished, click on End Transaction. Before clicking on “End Transaction” you should wait until all HTTP-Connections has been closed (the value of Open HTTP connection is “0”).

You can repeat these steps for several actions/clicks.

The trace will be written in a csv-file, which is located in the installation folder:

You can modify the view of the comma separated data with the following steps:


2004 SAP AG 30

Data -> select Text to Columns…

Select “Delimited”

Select “Comma”

Select “Finish”


2004 SAP AG 31

In the line with “-1” you can find the Begin and End of the transaction.

In the Line “End of Transaction” the number of Request and other parameters are summarized.

A lot of other features of this tool will be explained in a separate documentation, which will be available soon.

3.3.2.3 Wfetch (Troubleshooting HTTP-Connections)

WFetch 1.2 is available for use with Microsoft Windows 2000/Microsoft Windows NT 4.0.

To download WFetch 1.2, visit the following Microsoft Web site:

http://download.microsoft.com/download/d/e/5/de5351d6-4463-4cc3-a27c-3e2274263c43/wfetch.exe

The following features are available in the current version of WFetch:

• Multiple HTTP verbs (GET, HEAD, PUT, DELETE, TRACE, POST, OPTIONS)

• Configurable host name

• Configurable TCP port

• HTTP 1.0 and HTTP 1.1 support

• Multiple authentication types (Anonymous, Basic, NTLM, Kerberos, Digest, Negotiate)

• Client-certificate support

• Multiple connection types (HTTP, HTTPS, PCT 1.0, SSL 2.0, SSL 3.0, TLS 3.1)

• Proxy support


2004 SAP AG 32

• Advanced requests that are entered manually or read from a file

• On-screen and file-based logging

WFetch does not log the TCP handshake data that is used to establish and close TCP sessions.

Usage

After you extract the utility to a client with TCP/IP access to a Web server, start the Wfetch.exe application.

1. In the Host box, type the name of a Web site.

2. In the Path box, select the path of the file, folder, or application on the Web site that you used In step 1 (for example, /default.asp).

3. Add any additional options based on the test that is being performed.

4. Click Go.

3.3.3 Network Analysis

3.3.3.1 Niping (Checks latency and bandwidth of a network connection)

To help diagnose the network or measure network metrics you can test the connection using SAP's NIPING program. You can use NIPING to analyze the network connection between any two machines running SAP software, for example between:

Frontend PC and application server

• Two application servers, perhaps belonging to different SAP systems

• Application server and database server or live cache server

• RFC server or client programs and application server

The machines can be connected either by a local area network (LAN) or wide area network (WAN).

In contrast to the normal PING command, NIPING operates on the TCP socket layer, which is the same layer used by SAP application programs. Therefore, NIPING can be used to identify also errors related to the TCP and socket implementation on the platform.

Please fetch the latest version of NIPING via FTP from sapserv3 in directory gen-eral/misc/saprouter. (Refer also to OSS note 30289). If this is not possible for you, you can use the NIPING which is located in the executables directory on any SAP server.

How to use NIPING:

Starting NIPING without arguments displays a short help message. Find a short explanation of the most important options below:

First start the NIPING server on computer A (e.g., the Application Server) with the command line:

niping -s -I 0 (the last character is zero, not the letter O)

Then start the client (e.g. on the front-end machine) with the command:

niping -c -H <nipingsvr> [ -B <buffersize> -L <loops> -D <delay> ]

<nipingsvr> may also be the host name or the IP address of host A. The remaining arguments are optional.

<buffersize> (default 1000 bytes) determines the size of the data packets. Please test at least the values 500, 1000, 1400, 1500, 4000 and 10000. This test is especially important to find errors re-lated to the maximum transmission unit (MTU). Please also refer to notes 26086, 107407, 67098 and 44803.


2004 SAP AG 33

<loops> is the number of packets sent (default 10). To find spurious errors it may help to simulate high network load using 1000 loops or more. For a permanent test use a number of e.g. 1000000 loops.

If you test during productive hours and don't want to consume too much bandwidth you can set a <delay> between requests (<delay> is in milliseconds).


500235 Network Diagnosis with NIPING

3.3.3.2 Netstat (UNIX and Windows)

The Netstat command can be used with UNIX and Windows to display protocol statistics and cur-rent TCP/IP network connections.

With <netstat –an> you can display addresses and port numbers of all connections. You can e.g. see if the state is LISTENING or ESTABLISHED and how many connections are open.

3.3.3.3 Active Ports (Windows)

Active Ports is a tool for Windows that enables you to monitor all open TCP and UDP ports on the local computer. Active Ports maps ports to the owning application so you can watch which process has opened which port. It also displays a local and remote IP address for each connection and allows you to terminate the owning process.

Additional information: http://www.ntutility.com/freeware.html

3.3.3.4 Ethereal (Network protocol analyzer for UNIX and Windows)

Ethereal is a free network protocol analyzer for UNIX and Windows. It allows you to examine data from a live network or from a capture file on disk. You can interactively browse the capture data, viewing summary and detailed information for each packet. Ethereal has several powerful fea-tures, including a rich display filter language and the ability to view the reconstructed stream of a TCP session.

Additional information: http://www.ethereal.com/

3.3.3.5 Snoop (Packet Sniffer for UNIX)

Snoop is a UNIX Command. Snoop captures packets from the network and displays their con-tents. Snoop uses both the network packet filter and streams buffer modules to provide efficient capture of packets from the network. Captured packets can be displayed as they are received, or saved to a file (which is RFC 1761-compliant) for later inspection.


2004 SAP AG 34

3.3.4 Others

3.3.4.1 Windiff (Graphical File Comparison Tool)

Sometimes you may experience unusual program behaviour and may suspect that a file is dam-aged, or you may suspect that two files have the same byte count but different dates. Therefore, you want to make sure that they are the same. If a file is suspect, the typical solution is to recopy from a known good file. This solution may solve the problem, but it prevents you from knowing whether the original file was damaged. It can be important to determine this, as file damage can indicate an underlying network or system problem.

The WinDiff tool takes two files or two directories and does a byte-for-byte file comparison. It then displays the results in a scrollable window, lining up the identical parts, and marking with colour the parts of the files that differ.

The following line shows Windiff command-line syntax:

windiff [path1] [path2]

where path1 and path2 indicate the files to be compared. Windiff uses the following rules to de-termine what is to be compared:

• If you invoke Windiff without specifying path1 or path2, you can click Compare Files or Compare Directories from the File menu to specify the files to compare.

• If you invoke Windiff with a filename for path1, but nothing for path2, Windiff compares the file with a file of the same name in the current directory.

• If you invoke Windiff with a directory name for path1, but nothing for path2, Windiff com-pares the files in the specified directory with the files in the current directory.

• If you invoke Windiff specifying files for path1 and path2, Windiff compares the two files.

• If you invoke Windiff specifying directories for path1 and path2, Windiff compares the files in those directories.

The results are initially displayed in outline mode. Windiff lists the files that were compared and indicates whether they are identical or whether one file is newer than the other. To view the differ-ences in expanded mode, select the file from the display and click the Expand button. The parts that are common to both files are displayed on a white background. The parts that belong to the file listed on the left are displayed on a red background. The parts that belong to the file listed on the right are displayed on a yellow background. To return to outline mode, click the Outline button.

In Microsoft Windows 2000 and later, Windiff.exe is included on the original CD-ROM in the Sup-port\Tools folder. To install the support tools, run Setup.exe from the Support\Tools folder. Win-diff.exe is also in the Support.cab file. Support.cab is included with every service pack.


2004 SAP AG 35

3.3.4.2 Filemon (Displays file system activity on a system in real-time)

FileMon monitors and displays file system activity on a system in real-time. Its advanced capabili-ties make it a powerful tool for exploring the way Windows works, seeing how applications use the files and DLLs, or tracking down problems in system or application file configurations. Filemon's time stamping feature will show you precisely when every open, read, write or delete, happens, and its status column tells you the outcome. FileMon is so easy to use that you'll be an expert within minutes. It begins monitoring when you start it, and its output window can be saved to a file for off-line viewing. It has full search capability, and if you find that you're getting information over-load, simply set up one or more filters.

FileMon works on NT 4.0, Windows 2000, Windows XP, Windows XP 64-bit Edition, Windows 2003 Server, Windows 95, Windows 98 and Windows ME. Sysinternals also has a version of Filemon for Linux.

Additional information: http://www.sysinternals.com/ntw2k/source/filemon.shtml

3.4 SAP J2EE Engine 6.20 related Tools

3.4.1 SAP J2EE Engine Console Log

The output that normally appears on the SAP J2EE console (if the engine is started with go scripts) is also written to the console logs. The log consists of two parts (output and error) and is managed through the configuration file console_log.properties in \..\<J2EE direc-tory>\cluster\dispatcher\managers and \..\<J2EE directory>\cluster\server\managers.

Name YYYY_DD_MM_at_HH_MM_SS_output.log and YYYY_DD_MM_at_HH_MM_SS_error.log

Location Set parameter LogDir in the console_logs.properties to specify the directory where the log files are stored. By default, this folder is \..\<J2EE direc-tory>\cluster\dispatcher\managers\console_logs respectively \..\<J2EE direc-tory>\cluster\server\managers\console_logs

(De)activation Set parameter LogConsoleStreams in console_logs.properties to Yes or No.

Trace levels -

Setting trace levels

-

Log size No fixed size for the log files.

Log backup New log files are created with the new data and time after each restart of the SAP J2EE Engine. The old log files are kept in the log directory.

Parameter “DaysToKeepLogs” in “console_logs.properties” defines how long the log files are kept (in days). The default value is 7.


604564 Initial help for SAP J2EE problems in WebAS 6.20 environment

Example: Output.log of server node: SAP J2EE Engine Version 6.20 PatchLevel 67440.20 is starting... Loading: LogManager ... Loading: SystemThreadManager ... Loading: ThreadManager ... Loading: TimeoutManager ... Loading: MemoryManager ...


2004 SAP AG 36

Loading: PoolManager ... Loading: PolicyManager ... Loading: IpVerificationManager ... Loading: ClusterManager ... Loading: ClassLoaderManager ... Loading: SwapManager ... Loading: LockManager ... Loading: R3StartupManager ... Loading: ServiceManager ... Loading core services: Starting core service monitor ... done. Starting core service p4 ... done. Starting core service file ... done. Starting core service log ... done. Starting core service dbms ... done. Starting core service security ... done. Starting core service admin ... done. Starting core service naming ... done. Starting core service deploy ... done. Core services loaded successfully. Loading additional services: Starting service ts ... done. Starting service keystore ... done. Starting service telnet ... done. Starting service javamail ... done. Starting service ssl ... done. Starting service appclient ... done. Starting service logviewer ... done. Starting service jms ... done. Starting service runtimeinfo ... done. Starting service shell ... done. Starting service http ... done. Starting service PRTBridge ... done. Starting service pinger ... done. Starting service eisconnector ... done. Starting service dbpool ... done. Starting service rfcengine ... done. Starting service ejb ... done. Starting service servlet_jsp ... done. Additional services loaded successfully. SAP J2EE Engine Version 6.20 PatchLevel 67440.20 is running! PatchLevel 67440.20 December 11, 2003 08:40 GMT ...

The first line of the log displays the patch level of the SAP J2EE engine. This information is also contained in the file version.txt located in \..\<J2EE direc-tory>\cluster\dispatcher\managers and \..\<J2EE directory>\cluster\server\managers.

Example: Error.log of server node:

... Portal initialization in progress ... Loading core applications: Loading application: com.sap.portal.pcd.lockservice Loading application: com.sap.portal.license.runtime Loading application: com.sap.portal.umeregistration Loading application: com.sap.portal.usermanagement Loading application: com.sap.portal.runtime.system.clusterinformation Loading application: com.sap.portal.runtime.system.notification


2004 SAP AG 37

Loading application: com.sap.portal.pcd.aclservice Loading application: com.sap.portal.pcd.basicrolefactory Loading application: com.sap.portal.pcd.admintools.plbrowser Loading application: com.sap.portal.pcd.admintools.administration Loading application: com.sap.portal.pcd.glservice Loading application: com.sap.portal.runtime.system.authentication Loading application: com.sap.portal.runtime.system.permission Loading application: com.sap.portal.pcd.softcacheservice Loading application: com.sap.portal.pcd.umwrapperservice Loading application: com.sap.portal.pcd.basictransport Loading application: com.sap.portal.runtime.config Loading application: com.sap.portal.pcd.configservice Loading application: com.sap.portal.runtime.system.inqmy Loading application: com.sap.portal.pcd.traceservice Loading application: com.sap.portal.pcm.admin.apiservice Loading application: com.sap.portal.runtime.system.repository Loading application: com.sap.portal.pcd.plconnectionservice Loading services: Loading service: com.sap.portal.pcd.lockservice|locks Loading service: com.sap.portal.license.runtime|license Loading service: com.sap.portal.umeregistration|ume_registration Loading service: com.sap.portal.usermanagement|usermanagement Loading service: com.sap.portal.usermanagement|user_management_engine Loading service: com.sap.portal.usermanagement|security Loading service: com.sap.portal.runtime.system.notification|notification Loading service: com.sap.portal.pcd.aclservice|aclconnector Loading service: com.sap.portal.pcd.basicrolefactory|factory Loading service: com.sap.portal.pcd.glservice|generic_layer ...

These logs contain all the errors and information detected by the PRT. These errors and informa-tion are also mirrored in the Java logs of the portal (-> portal.log).

3.4.2 SAP J2EE Engine Managers and Services Logs

The log system of the SAP J2EE Engine consists of a log manager and log service for each dis-patcher and server node.

The log manager creates a directory for each manager in which all data associated with the par-ticular manager is stored in plain text format. These directories reside in:

\..\<J2EE directory>\cluster\dispatcher\managers\log respective

\..\<J2EE directory>\cluster\server\managers\log.

You can access the logs by starting the Administration console of the SAP J2EE Engine, logging on to the engine (Login), and choosing Dispatcher or Server → Managers → <Manager> on the left panel. The logs can be displayed through the Log Viewer tab on the right side. Select the Log type dropdown menu on the toolbar to view all log messages.

Use the log manager Properties tab from within the Administrator tool to modify these settings.


2004 SAP AG 38

The log service stores all data associated with the services in plain text format in

\..\<J2EE directory>\cluster\dispatcher\services\log\work respective

\..\<J2EE directory>\cluster\server\services\log\work.

You can access the logs by starting the Administration console of the SAP J2EE Engine, logging on to the engine (Login), and choosing Dispatcher or Server → Services → <Service> on the left panel. The logs can be displayed through the Log Viewer tab on the right side. Select the Log type dropdown menu on the toolbar to view all log messages.

The most relevant log is the one for the HTTP Service which is covered in more detail in the next chapter.

3.4.3 SAP J2EE Engine HTTP Service Logs

The SAP J2EE Engine runs its own HTTP service that listens to the port you specified during the configuration prior to portal installation. This service receives and processes the requests that usually retrieve resources (/irj/resource/…) or issue requests to the PRT (/irj/servlet/prt/…).

Name The names of the log files can be set in the properties of the log service. Navi-gate to Cluster → Server (or Dispatcher) → Services → Log and select the Properties tab.


2004 SAP AG 39

Location Dispatcher node: \..\<J2EE directory>\cluster\dispatcher\services\log\work. Choose Dispatcher → Services → HTTP from the Cluster tree in the left panel of Visual Administrator to view the dispatcher log messages. Choose Log Viewer in the right panel. All significant events that occur on the dispatcher node are written to log files that correspond to each module. Select the Log type dropdown menu on the toolbar to view all log messages.

Server node: The HTTP service on the server node creates log messages in \..\<J2EE directory>\cluster\server\services\http\log by default. Choose Server

→ Services → HTTP from the Cluster tree in the left panel of the Visual Admin-istrator. Choose Properties → General in the right panel. You can change the log format, file name, and directory of the HTTP service log files in this tab. Choose Save Properties to save the changes and restart the HTTP service for the changes to take effect.

(De)activation Always active

Trace levels • EMERGENCY (log level 0) – System is not usable

• ALERT (log level 1) – Immediate action must be taken

• CRITICAL (log level 2) – Critical conditions

• ERROR (log level 3) – Error conditions

• WARNING (log level 4) – Warning conditions

• NOTICE (log level 5) – Normal but significant events for the system

• INFO (log level 6) – Information

• TRACE (log level 7) – Events that occur as a result of application methods execution

• DEBUG (log level 8) – Debug level messages


Trace levels can be set in the Properties of the log service. Navigate to Cluster

→ Server (or Dispatcher) → Services → Log and select the Properties tab.

Log size The size of the log file can be limited by configuring parameter MaxFileLength in the Properties of the log service. Navigate to Cluster → Server (or Dis-

patcher) → Services → Log and select the Properties tab.

Log backup The name of the directory to which the backups are written is defined under ZipDirectory. Choose Add, select Save Properties on the toolbar and restart the corresponding log manager or service for the changes to take effect. If you have trouble finding the parameter, make sure that you are in cluster view mode (make sure that it is selected in the left toolbar). Select Cluster → Server (or Dispatcher) → Services → Log in the left panel of the J2EE Engine 6.20 Visual Administrator. Choose Properties in the right panel.

The log files are added to the archive when they reach the length specified in the MaxFileLength property. The default directory where the archived log files are stored is named logBackup.

The maximum period between two consecutive archiving operations is speci-fied by the MaxDelayTime property.

Relevant OSS notes

604126 SAP J2EE Engine 6.20: Error starting service http.null


2004 SAP AG 40

You can edit log file settings, levels and formats by selecting the log service in the left panel. If you want to log the access of the HTTP service in Common Log Format (CLF), select Log in Common Log Format in the Properties panel of the HTTP service. You can also specify the name and loca-tion of the CLF log file (parameter LogFile (CLF)). By default, the path to the common log file is \..\<J2EE directory>\services\http\log\http.log.

Example: HTTP Service log: 10.19.24.98 - - [10/Jan/2003:12:53:24 -0000] "GET /irj/resources/PCDEditor/images/jstree/tree/role.gif?10421992978300" 200 118 10.19.24.98 - - [10/Jan/2003:11:11:35 -0000] "GET /irj/servlet/prt/portal/prttheme/sap_mango_polarwind/prtroot/PCDEditor.Message?gIframeWndId=eaIframeWndId_1" 200 0

The return codes for the requests are displayed in bold green (twice ‘200’ for OK in this case) and can serve as a starting point for error analysis.

3.4.4 SAP J2EE Engine Monitoring and Command Line Tools

The SAP J2EE Engine comes with a powerful monitoring infrastructure which is not activated by default. The monitor is started via the batch file <J2EEDIR>\tools\monitor.bat and configured via the file monitorServer.properties in the same directory. Monitoring can also be configured to start automatically when the J2EE Engine is launched. Details for this setup are explained in SAP Note 498179. In any case, the monitoring data can be displayed via the J2EE Administrator in the moni-tor service.

The J2EE monitoring reports information on the current workload that may be useful for perform-ance analysis. Values of interest are the memory consumption, thread usage, number of HTTP requests and sessions, HTTP request processing time, etc.

By default, J2EE monitoring does not maintain historical data. To get periodic reports, enable re-porting into the filesystem (monitor.system.FS.mode=on in monitorServer.properties). The file format can be html or csv for excel import (comment out file format property).

Historical monitoring data is also maintained by CCMS if the J2EE monitoring is connected to CCMS. Details on this setup are also part of Note 498179.

If the monitoring cannot be started for the J2EE Engine, a set of console commands is available to get snapshot information. The table lists some useful commands. Some commands must be acti-vated by a preceding call of add <someservice>.

Command Required add command Use

Msc Memory status

Lst Thread status (running threads, queued re-quests)

httpsessions full servlet_jsp Detailed list of all http sessions

Lscon List the number of open connections (dis-patcher only)

info –status 5 2 measurements of memory and thread usage with 5 secs delay


2004 SAP AG 41

3.4.5 Full thread dump

A full thread dump might prove helpful under the following circumstances:

• The Enterprise Portal application or the J2EE Engine itself is hanging and there are no er-ror messages in the log files or in the server console. Sometimes, the CPU load stays at 100% (hinting at deadlocks or endless loops).

• The Enterprise Portal application or the J2EE Engine itself is hanging because the data-base does not respond. The Portal might execute an SQL statement which lasts ex-tremely long. There might be a database deadlock or the database is in an erroneous state.

• You are dissatisfied with the performance of the Enterprise Portal and want to investigate if there are several threads doing one and the same job.

• You were asked by Technical Support to send them a thread dump to better analyze your current problem.

A thread dump will allow you to count the threads used, see to which method they belong to and what task they were performing. A full thread dump is a request to the Java Virtual Machine to “dump” its current state. The JVMs will direct the stack traces of all running threads to the console.

Note: The invocation of a thread dump does not affect the JVM. The JVM will continue to run normally. Make sure that the -Xrs option is not used (for details please see http://www.java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/java.html).

Examples:

The full thread dump begins with the words Full thread dump.


2004 SAP AG 42

Java can detect simple deadlocks automatically. Look at the end of the dump if this happens.

For a more detailed introduction to thread dumps, please see http://developer.java.sun.com/developer/technicalArticles/Programming/Stacktrace.

xdProf is a convenient tool that helps with interpreting stack traces. It is a cross-platform tool that captures and analyzes stack traces that are sent from Java Virtual Machines in a distributed sys-tem at fixed intervals (-> chapter 3.4.8).

3.4.5.1 How to make a thread dump on UNIX

Compared to Windows boxes creating a full thread dump on UNIX is quite easy. You just have to directly send a QUIT signal to the Java process (kill -3 <pid>). In a standard EP6.0 installation the server node of the SAPJ2EE engine 620 is started by the dispatcher node using the r3startup ser-vice. Therefore you have to take into consideration that the output is written to directory /../<J2EE direc-tory>/cluster/dispatcher/services/r3startup/work. Note that the server output goes to a dispatcher directory.

3.4.5.2 How to make a thread dump on Windows

You can request a thread dump on Windows systems by pressing CTRL-BREAK unless the SAP J2EE Engine is running as a Windows service. In that case, you have to restart the SAPJ2EE En-gine via the go.bat scripts.

In the command prompt window where the server node of the engine is running, open the proper-ties dialog box by right clicking on the title bar and selecting Properties. Select the Layout tab and assign large values to the parameters Width and Height (e.g. 2000 and 9999, under Screen Buffer Size):


2004 SAP AG 43

Click OK.

Alternatively, you may want to redirect the output to a file: add the command >threaddump.txt 2>&1 at the very end of your starting script of the server (go.bat) where threaddump.txt is the name of the file where the output will be written to. This file can be found in the directory <J2EE directory>\cluster\server after the dump has finished.

Press CTRL-BREAK (not CTRL-C as this will stop the engine without creating the dump) when the problem occurs. On a German keyboard layout, the Break button corresponds to the Untbr button. This will trigger a full thread dump that will be written to the console or the file you chose.

If you have not redirected the output to a file as shown above, you can scroll up in the command window until you reach the beginning of the dump (it starts with the words Full thread dump) and select the text for manual copying.

3.4.5.3 Full Thread dump from J2EE Engine 6.20 running as Windows service

Attached to note 686254 you will find the files that need to be installed for creating a full thread dump even the SAPJ2EE engine 620 is running as Windows service. The note includes the instal-lation instructions too.


2004 SAP AG 44

3.4.5.4 Common Problems and Notes

Relevant OSS notes

Additional info on how to trigger the thread dump is provided in CSN note 599539 and 686254 if SAPJ2EE Engine 6.20 runs as Windows service

Enterprise Por-tal hangs with almost 100% CPU usage

If the <init> method is called from two different threads simultaneously, the alone.exe uses almost 100% of CPU but does not respond in time.

For a full description of the problem, read CSN note 625509.

3.4.6 SAPJ2EE Engine 620 Analyzer

Use this tool to locally or remotely gather information about the SAP J2EE Engine without interfer-ing the system resources, but viewing their copy instead. This tool can be started using the script file analyze in the \..\<J2EE directory>\tools\analyze directory.

The Analyze Tool can be used in two ways:

Offline - in this case the tool collects all the system properties, the file structure of the installation directory, the output of some operational system dependent commands and files like logs, go scripts, service and manager properties, service.ini, etc.

Online - tries to connect to all known SAP J2EE ports and stores the responses. If the tool suc-ceeds to connect using Telnet port, it will try to log on to SAP J2EE Engine. Then executes many shell commands for each cluster element and tries to start Offline Analyze from the shell for each new host it goes. If it does not succeed on a host, it executes some Operational System depend-ent commands on the host.

The following opions are available:

-v Starts the verbose mode. Otherwise, the console of the tool is silent.

-j <J2EE_HOME> SAP J2EE Engine directory to be analyzed. If it is spezified, the tool scans first offline and then tries online scan.

-h <remote_host> Host name for online analysis. If <J2EE_HOME> and <remote_host> are spezified the tool scans them both, but all the data is collected in one .ZIP file, that is <analyse.zip>

-p <password> User password. The default is an empty string.

-z <analyze.zip> The analysis result .ZIP file. The default value is ./analyze.zip.

-telnet <port> The port number for Telnet analysis.

-http <port> The port number for the HTTP scan.

-port <port> The port number for the raw scan.

Example on starting an offline analyze:

java com.inqmy.tools.analyze.Analyze -v -j C:\SAP_J2EEngine6.20

Example on starting an online analyze:

java com.inqmy.tools.analyze.Analyze -v -h localhost


2004 SAP AG 45

Relevant OSS notes

681693 Analyze Tool for SAP J2EE Engine 6.20

3.4.7 J2EE Engine HTTP Tracing

With the J2EE Engine HTTP Tracing Tool, you can trace the requests and responses to and from the J2EE Engine in order to detect a possible request/response handling problem.

(De)activation Properties file of http service on dispatcher node

HttpTrace:

It can have several values depending on what you want to be logged. HttpTtace=disable is the default value which does not save any info about re-quests and responses.

HttpTrace=textFull - logs the requests and responses in text format

HttpTrace=textHeaders - logs only the headers in text format

HttpTrace=hexFull - logs the entire request/response in Hex format

HttpTrace=hexHeaders - logs only the headers in Hex format

HttpTraceRequestOutput:

Specifies where the requests should be logged. The default value is HttpTraceRequestOutput="", it will dump the received requests to standard out-put (System.out). You can also specify a file name as a value to this property. For example HttpTraceRequestOutput=request.txt. In this case a file called re-quest.txt and containing all info about the requests received by the j2ee engine will be created in the dispatcher folder.

HttpTraceResponseOutput:

Specifies where the responses should be logged. The default value is HttpTraceResponseOutput="", it will dump the received responses to standard output (System.out). You can also specify a file name as a value to this prop-erty. For example HttpTraceResponseOutput=response.txt. In this case a file called response.txt and containing all info about the responses sent by the j2ee engine will be created in the dispatcher folder.

Relevant OSS notes

657765 How to turn on j2ee engine http tracing capability


2004 SAP AG 46

3.4.8 xdProf (Tool to capture and analyze stack traces in a distributed JAVA System)

xdProf is a cross-platform tool that captures and analyzes stack traces sent at a fixed interval from Java Virtual Machines in a distributed system. The xdProf client uses the JVMPI and works with any compliant implementation; no access to application source code is necessary, no library modi-fications are needed, and there is no run-time instrumentation of Java byte code. Configuration options given at virtual machine startup specify the interval for stack trace transmission and the remote xdProf server. The xdProf server collects information from multiple xdProf clients and pro-vides an extensible interface for analysis. Current tools include a GUI for viewing the most recent stack traces from multiple VMs and the generation of control flow graphs for each VM. The per-formance impact of the xdProf client sending data over a local area network is minimal: less than an 8% increase in total elapsed time for a set of standard benchmarks. Future plans include real-time visualization, reliability estimation, trace capture, and performance analysis.

Additional information: http://xdprof.sourceforge.net/

3.5 Portal Platform related Tools

You can directly launch the Tools via Portal-UI using the specified path in each chapter. But you are able to launch the tool as well by entering the following URL (a super-admin role is required):

http://<host>:<http-Port>/irj/servlet/prt/portal/prtroot/ <GroupName>.<ComponentName>

3.5.1 Client Framework Tools

Path: System Administration -> Support -> Client Framework

Tool

<GroupName>.<Component Name> Description

Client Framework: Environment

(com.sap.portal.epcf.loader.Environment)

Checks the system functions of the client framework, especially user agent detection.

Client Framework: Eventing

(com.sap.portal.epcf.loader.Eventing)

Configurable event sender and event re-ceiver with the event log.

Client Framework: Databag

(com.sap.portal.epcf.loader.DataBag) Store or retrieve data in the client databag.

Client Framework: Dirty, WorkProtect mode, Cross Navigation

(com.sap.portal.epcf.loader.Dirty)

Test component for Dirty, WorkProtect and Cross Navigation.

Client Framework: Relaxing of document.domain

(com.sap.portal.epcf.loader.Relaxing)

Relaxing of document.domain (JavaScript origing policy).


2004 SAP AG 47

Relevant OSS notes

588960 EP 6.0: Central Note for EP-PIN-CS (Client Services)

3.5.2 PCD Tools

There is much more tracing as compared to SP1. Up to SP1, the trace levels should be set to “Severe” to see all messages. Since SP2, the trace level works like a filter (set to “Debug” to see all messages, “Severe” to see only error messages).

Note that the pcd_logger logs into file and console concurrently, the levels are set separately in the Logging Console.

Relevant OSS notes

588904 EP 6.0: Central note for Portal Content Directory

3.5.2.1 PCD Configuration Tool

<GroupName>.<Component Name>: com.sap.portal.pcd.admintools.configuration.default

Path: System Administration -> Support -> Portal Content Directory

The PCD Configuration Tool displays all PCD configuration parameters with their current values.

The system accesses the two configuration files pcdStartUp.installer.properties and pcd.properties.

3.5.2.1.1 File system configuration parameters for PCD

The parameter Pcd.Home and Pcd.Share are configured in file pcd.properies, which can be found under:

\..\cluster\server\services\servlet_jsp\work\jspTemp\irj\root\WEB-INF\portal\system\ properties\

• Pcd.Home/Pcd.Share

The value is the path to a folder in the file system, where central (i.e. shared between several portal servers belonging to the same cluster) files are stored. Other then in EP 5.0 a database is used as storage for the PCD content in EP 6.0. However, for e.g. im-port/export there are still files stored in this central folder. In a clustered portal environ-ment, customers should define a central share (as mapped drive our mounted directory) and specify its path as value for Pcd.Home (in the platform independent notation with "/" as path separator).

• Pcd.Temp

Some PCD applications need a folder where temporary data can be stored. It's required, that folders and files can be created and deleted in this location. However, this folder should not be shared between nodes in a clustered environment. The property-name for this value is Pcd.Temp. A typical value would be e.g. /tmp in a UNIX environment.

Note: Under windows the path length shouldn´t be too long (-> see chapter 4.2.3.5)


2004 SAP AG 48

3.5.2.1.2 PCD Parameter Configuration (pcdStartup.installer.properties)

The PCD is configured using the PCD Configuration tool. Therefore you have to edit the file pcdStartup.installer.properties, which can be found under:

\..\global\config\pcd

After editing the file, press the button RELOAD in the Portal Configuration UI.

You can reload the changed parameters from the corresponding files for:

• PCD Trace Levels

• PCD Softcache Settings

• PCD Locking

• Database Connection

• PCD Persistence Layer Configuration

• PCD Generic Layer Configuration

• PCD GL transport Configuration

• Portal Content Migration Application

• Transport Application

• AclService Configuration

The parameter pcdStartup.template.properties holds the default parameters and some docu-mentation. It can be found under:

\..\WEB-INF\portal\system\pcd\pcdStartup.template.properties

For further problem-oriented PCD-topics refer to chapter 0.

3.5.2.1.3 PCD Traces

If you can‘t find information in the log files above, you may need to change the trace level and re-produce the bug in order to get log entries.

Under “Parameters for PCD Trace”, you find the trace locations that are registered with the PCD logger. By default, the trace levels are “Severe” for most locations. In order to change the trace level, edit the properties file displayed under “Configuration.Status” and hit “Reload”


2004 SAP AG 49

PCD Traces: which trace for which area?

Pcd.Tracelevel.BasicRoleFactory Interface PCD roles -> UME

Pcd.Tracelevel.BasicTransport Transport

Pcd.Tracelevel.Gl.Access Access to semantic objects

Pcd.Tracelevel.Gl.Admin Initialization, setup, shutdown

Pcd.Tracelevel.Gl.Aspect Aspect handling

Pcd.Tracelevel.Gl.BasicNotification Notification (xfs-> basic layer, basic layer -> gl)

Pcd.Tracelevel.Gl.EventNotification Notification for registered event listeners

Pcd.Tracelevel.Gl.NotificationEngine Starting point of Notification

Pcd.Tracelevel.Gl.ObjectNotification Notification (gl -> Semantic objects)

Pcd.Tracelevel.Gl.Xfs.Cache Cache

Pcd.Tracelevel.Gl.Xfs.Search Search queries, performance

Pcd.Tracelevel.Gl.XfsNotification Notification along deltalink chains

Pcd.Tracelevel.Lock Locking

Pcd.Tracelevel.Pl.Access General problems from the Persistence layer

Pcd.Tracelevel.PlConnectionPool DB Pool, SQL traces

Pcd.Tracelevel.RoleNavigationService Interface PCD -> Navigation

Pcd.Tracelevel.SoftCache.Access Cache read

Pcd.Tracelevel.SoftCache.CleanUp Deletion of unused soft references

Pcd.Tracelevel.SoftCache.CrossServer Cross server notification (Cluster environment


2004 SAP AG 50

Relevant OSS notes

676113 How to trace PCD cross-server-notification

690310 EP 6.0: logging and tracing for transport

3.5.2.1.4 Database connection parameters

During the installation all these parameters will be maintained. But if you change e.g. the database from Oracle to MS SQLserver, then you have to maintain these properties.

Pcd.Pl.DatabaseType (value: oracle or sqlserver)

Pcd.Pl.InitialContextFactory (default value: com.inqmy.services.jndi.InitialContextFactoryImpl)

Pcd.Pl.ProviderUrl (default value: localhost)

Pcd.Pl.Datasource (default value: jdbc/sapep)

More files can be found in the pcdStartup.template.properties (-> chapter 3.5.2.1.2)

3.5.2.2 PCD Administration Tool

With the PCD Administration Tool you can check, whether a problem is caused by the cache.

Clicking on “Release Cache” the cache will be cleared. Be carefull using this tool in a productive system, because it can temporarily influence the performance.

<GroupName>.<Component Name>: com.sap.portal.pcd.admintools.administration.default

Path: System Administration -> Support -> Portal Content Directory

3.5.2.3 PCD Permission List Tool

<GroupName>.<Component Name>: com.sap.portal.pcd.admintools.permissions.default

With the PCD Permission List Tool you can check, which permission a user has for a special PCD-object.

For further use cases regarding Permission Problems please refer chapter 4.2.3.3 and 4.2.3.4.


2004 SAP AG 51

Additional error analysis can be done, e.g. for missing authorizations with acl.log and transport.log (-> chapter 3.1.1).

3.5.2.4 Object Locking Tool

The Object Locking Tool enables you to locate objects being edited and currently in locked mode. The locks could be due to lock expiry. This is not a bug, but a feature. The timeout can be config-ured in the PCD Configuration Tool (-> chapter 3.5.2.1).

Path: System Administration -> Monitoring -> Portal -> Object Locking


2004 SAP AG 52

You can manually release or take over locked objects (-> Search for locked objects -> Click on UNLOCK)

3.5.2.5 PCD Browser

<GroupName>.<Component Name>: com.sap.portal.runtime.system.console.PCDBrowser

Path: System Administration -> Support -> Portal Runtime -> PCD Browser

With the PCD Browser you can navigate through the PCD and display attributes and the related values.

3.5.2.6 PCD Persistence Layer Editor (plbrowser)

Be carefull with the PLbrowser! If you only need to navigate through the PCD, please use the PCD Browser (-> chapter 3.5.2.5).

Use the PlBrowser to check the database content if you need to know what‘s really in the persis-tence and/or if the portal is not running.


2004 SAP AG 53

With the PCD Persistance Layer Editor you can access and modify the central application reposi-tory (complete applications and .PAR files).

If the PlBrowser doesn‘t work, consult the readme file in the PlBrowser directory.

com.sap.portal.pcd.admintools.plbrowser

Windows: /profiles/plbrowser.bat

Unix: /profiles/plbrowser.sh

Menu: DataBase – Initialization

The folder applications contains the deployed applications.

The folder archives contains the deployed archives.

Using right mouse click you can see the attributes.


2004 SAP AG 54

Be very careful with the update features of the PLBrowser!

Before changing data with the PLBrowser in a productive environment, consult with SAP!

Don’t run the update features while the portal is running, because the cache will not be updated which will result inconsistent data!

3.5.3 PRT Tools

Path: System Administration -> Support -> Portal Runtime

Relevant OSS notes

645976 EP 6.0: Central Note for Portal Runtime

3.5.3.1 Test and Configuration Tools

3.5.3.1.1 SOAP Admin

<GroupName>.<Component Name>: com.sap.portal.runtime.application.soap.SOAPAdmin

Path: System Administration -> Support -> Portal Runtime -> SOAP Admin

The SOAP Admin console allows you to display the SOAP services that are enabled and their con-figurations.

It is possible to the check the validity and to Update Queuing.

3.5.3.1.2 Log Admin

<GroupName>.<Component Name>: com.sap.portal.runtime.admin.logadmin.default

Path: System Administration -> Support -> Portal Runtime -> Log Admin

Administration of the logging configuration. It allows you to browse content of individual log files.

Corresponds to the Logging Console (-> chapter 3.2.3).

3.5.3.1.3 Log and File Viewer

See chapter 3.2.3


2004 SAP AG 55

3.5.3.1.4 Browse Deployment

<GroupName>.<Component Name>: com.sap.portal.support.browse.default

Path: System Administration -> Support -> Portal Runtime -> Browse Deployment

File browser on Web server portal deployment. This tool allows you to browse and download portal installation elements.

3.5.3.2 "Portal Anywhere" Admin Tools

3.5.3.2.1 Administration Console

<GroupName>.<Component Name>: com.sap.portal.runtime.system.console.ClusterAdminConsole

Corresponds to the PortalAnywhere.ClusterAdminConsole and PortalAnywhere.default

Path: System Administration -> Support -> Portal Runtime -> Administration Console

The Cluster Administration shows the list of cluster nodes and allows upgrading, deploying and removing Portal Applications. For each PRT Server a link also allows to start the Local Deploy-ment Checker.

The Local Deployment Checker expects the host name as a query parameter and only displays the list of applications that are to be updated (i.e: applications deployed locally and having a mani-fest version that differs from the manifest version available in the repository). It is also possible to display the full list of applications in order to provide an overview of all archives that were deployed locally. In this mode the component provides the same features as the Archive Deployment Checker (i.e: Install/Update/Delete buttons).

Note: This component cannot be included in a page directly since it expects several request pa-rameters.


2004 SAP AG 56

The Archive Uploader component is used to upload PAR Files into the repository. A checkbox allows notifying all PRT servers in order to also trigger an update of the local deployment.

The Archive Deployment Checker should be used by the admin to check whether the local de-ployment is up-to-date or not. This component allows selecting an archive (from the repository) and displays the manifest version of the archive for each PRT server and compares it with version of the repository. An Install button is available when the application has never been deployed lo-cally before. An Update button and a Delete button are available when the local deployment exists:

• the Update button should be used to update the local deployment without removing local users settings (if any)

• the Delete button has to be used with care since it removes all files deployed locally and might also remove some user settings in some cases

The Archive Remover is used to delete a Portal Archive (PAR).

3.5.3.2.2 Deployment Overview

<GroupName>.<Component Name>: com.sap.portal.runtime.system.console.DeploymentOverview

Corresponds to the PortalAnywhere.DeploymentOverview

Path: System Administration -> Support -> Portal Runtime -> Deployment Overview

The deployment overview is a page including both the Cluster Administration component and the Local Deployment Checker component for each of the declared PRT servers. It provides a com-plete overview over the deployment.


2004 SAP AG 57

3.5.3.2.3 Application Console

<GroupName>.<Component Name>: com.sap.portal.runtime.system.console.ApplicationConsole

Path: System Administration -> Support -> Portal Runtime -> Application Console

Allows refreshing Portal Applications, Portal Components and Portal Services.

3.5.3.2.4 PortalAnywhere.Go

<GroupName>.<Component Name>: PortalAnywhere.Go

List of available Components. Clicking on GO, you can start the selected portal component.


2004 SAP AG 58

3.5.3.3 JNDI Browsers

Tools


Portal Registry Browser

(com.sap.portal.runtime.system.console.PortalRegistryBrowser)

A browser of the Portal Regis-try.

JNDI Support Browser

(com.sap.portal.runtime.system.console.JNDISupportBrowser)

A browser of the PRT JNDI Support context showing regis-tered JNDI Naming Providers

PCD Browser (-> chapter 3.5.2.5)

(com.sap.portal.runtime.system.console.PCDBrowser)

A browser of the PCD generic layer context.

Security Zones Browser

(com.sap.portal.runtime.system.console.SecurityZonesBrowser)

Browses the Security Zones and displays the list of Portal Components bound to the cur-rent one.

3.5.4 Integration of SAP Applications

Relevant OSS notes

589014 EP 6.0: Central Note for EP-PIN-AI (App. Integration)

Known Is-sues/Solutions

When you start an SAP Application in the portal, only an exception or error message is displayed.

Solution: Check the sapapplication.log for more details. Typically such prob-lems are caused by incorrect system landscape configuration or failed authen-tication.

Remaining server sessions after you finish processing any of the following SAP applications: IAC, MiniApp, Transaction displayed in SAP GUI for HTML

Solution: Attach the DSM Logger for the current client and process the SAP application again. After the processing has finished, the dsm.log will contain all session objects and also transmission protocol of the session termination.

3.5.4.1 SAP Transaction

<GroupName>.<Component Name>: com.sap.portal.appintegrator.sap.Transaction

Path: System Administration -> Support -> SAP Application -> SAP Transaction

The SAP Transaction Tool allows you to launch any SAP transaction with the parameters that have been specified before. You can test e.g. a specified transaction code with different SAP GUI Types. Moreover you can activate the Debug Mode.


2004 SAP AG 59

-> Maintain specific parameters

3.5.4.2 Logger for Distributed Session Management (DSM Logger)

<GroupName>.<Component Name>: com.sap.portal.dsm.Logger

Path: System Administration -> Support -> SAP Application -> DSM Logger

The DSM Logger Tool activates/deactivates the Logger for Distributed Session Management. The logger is automatically deactivated when you close the browser.

The DSM Logger records following data in the dsm.log (-> for location see chapter 3.1)

• Client-Side: All processed SessInfo Objects

• Server-Side: Transmission protocol of the session termination

SessInfo Receipt displays each incoming SessInfo Object in a Browser Popup.

3.5.4.3 DSM Monitor

<GroupName>.<Component Name>: com.sap.portal.dsm.Monitor

Path: System Administration -> Support -> SAP Application -> DSM Monitor

With the DSM Monitor Tool you are able to test DSM interfaces.


2004 SAP AG 60

3.5.4.4 Application Test with specified Parameters

Path: System Administration -> Support -> SAP Application

With this tool you are allowed to start various application types with parameters you specified. You can start an SAP Transaction, a BSP, a BW-Report, a WebDynpro, an IAC, a Miniapp and a Crys-tal Report.

-> Select one Appli-cation


2004 SAP AG 61

-> maintain specific parameters, e.g. here for a BSP

3.5.5 Request Support Tools

<GroupName>.<Component Name>: com.sap.portal.epsolman.EPSolman

Path: System Administration -> Support -> SAP Request Support

With the Request Support Tool you are able to create a Support message directly from the portal. As a prerequisite you need a connected backend SAP Solution Manager.

Relevant OSS notes

641707 EP 6.0: Central note for EPSolman ("Request Support")


2004 SAP AG 62

3.5.6 Tools for Themes

Path: System Administration -> Support -> Themes

Tool


SP1 Migration

(com.sap.portal.themes.personalization.upgrader)

Migrate SP1 theme administration and theme personalization to all available desktops

Theme Editor Version Display Theme Editor version infor-mation

Theme Integrity Tests

(com.sap.portal.themes.integrity.default)

Perform theme integrity checks and test components summary

Browse Theme Database

(com.sap.portal.themes.integrity.browse)

Browse the database persistency of all themes

Update Customer Theme Parameters

(com.sap.portal.themes.integrity.update) Update customer theme parameters

Cluster Theme Integrity Tests

(com.sap.portal.themes.integrity.serverFrameworkCockpit)

Cluster Perform cluster theme integ-rity checks and test components summary

Relevant OSS notes

589013 EP 6.0: Central Note for Themes and Theme Editor

602336 EP 6.0 Theme Editor: Missing Previews

3.5.7 Performance Monitoring Tools

3.5.7.1 Request Summary

The most important performance data for the portal server is shown here, collected in different categories. You can find detailed information about the individual requests, components, and threads by selecting the corresponding entries in the detailed navigation for Portal Monitoring.

Path: System Administration -> Monitoring -> Portal

You can look at the performance data for each portal server in the cluster:

In the Select Server dropdown list, select the portal server and choose Display.


2004 SAP AG 63

With these values, 0 bytes can also mean that data was passed, but development did not inform performance monitoring of this fact via the API.

Category Meaning

Accumulated Amount of Outbound Data Total amount of outbound data (in bytes)

Time for all Requests Total time needed for editing all requests in the backend system (in msec)

Average Amount of Outbound Data per Re-quest

Average amount of outbound data per request (in bytes)

Average Number of Component Calls per Re-quest

Average number of component calls per re-quest

Average Time of a Request Average time per request needed for editing in the backend system (in msec)

Number of Calls with Outbound Data Number of component calls with outbound data

Number of Component Calls for all Requests Number of component calls for all requests

Number of Requests since First Request Number of requests since the first request started

Requests per Second Number of requests per second

Time Stamp of First Request Starting time of monitoring

3.5.7.2 Request Overview

An overview is given here of the completed requests of a portal server in the cluster that had the greatest effect on the performance.

The Request Overview displays the most expensive requests to portal components. Sorting the view by duration will yield the java components behind the top expensive iViews. This top list of the most expensive requests is often dominated by the first execution of a component after startup. For this reason, it is currently of limited value and must be interpreted carefully.

A request can consist of a number of components and subcomponents. The requests are listed in the overview with their names. By clicking on this name you get detailed information about all the components involved and their hierarchy within the request.

The names of the components are defined according to the following convention:

<solution>:<component>:<localization>


2004 SAP AG 64

<solution>:<component>:<details> (for actions)

Component name EP:UM:getUser

indicates that the action „get user data“ was executed when component User Management logged onto the portal.


A value of 0 bytes for the amount of outbound data means that no data was transferred.

A value of N/A indicates that it is not possible to specify a value.

Column Header Meaning

Starting Time / Starting Date Time when the request was started

First Component of Request Request name

User ID ID of the user who started this request

Outbound Data Amount of outbound data for a request

Duration Total time for the request. The time needed to process the request in the corresponding backend system is measured.

Component with the largest net time Name of the component that has the largest net time in this request, that is the „slowest“ com-ponent. The net time of a component is the gross time of the component less the gross time of their subcomponents.

Largest Net Time Duration of the component with the greatest net time

Amount of Outbound Data Amount of outbound data for the component with the largest net time

Component entries Number of components that comprise this re-quest. Components that are used more than once are counted more than once.


2004 SAP AG 65

3.5.7.3 Component Overview

Here you find an overview of the portal components running in the cluster node that have the larg-est load on the resources. The components are displayed without taking the corresponding re-quests into consideration.

The names of the components are defined according to the following convention:

<solution>:<component>:<localization>

<solution>:<component>:<details> (for actions)

Component name EP:UM:getUser

indicates that the action „get user data“ was executed when component User Management logged onto the portal.

Example:

Calling the component overview tells you if a component only created a time load once, or if the component is generally slow and reduces system performance. A component can, for example, be slow the first time it is called. If it is called repeatedly, the net time will generally be shorter be-cause data is kept in the cache. If you sort the slow components by their average net time and the average net time is approximately the same as in the first call, the component will generally reduce performance. In custom components you should check the coding in such cases.



Component Name Name of the main components or subcompo-nents

Number of Calls Total number of calls of this component in all requests

Gross Time Total time of the components (including the time for all subcomponents involved) for all calls

Net Time Total net time of the components (computed from the gross time minus the gross time of their subcomponents) for all calls

Amount of Outbound Data Total amount of outbound data of the compo-nents for all calls

Average Gross Time Total average time of the components for all calls


2004 SAP AG 66

Average Net Time Average net time of the components for all calls

Average Amount of Outbound Data Average amount of outbound data of the com-ponents for all calls

3.5.7.4 Thread Overview

An overview of the threads currently used by the portal applications in the cluster node is displayed here. The active threads and running components that are currently involved are displayed.

The Thread Overview is a „snapshot“ of the data collected for the Request Overview and Compo-nent Overview. The current state of the thread is shown. It is not possible to display a history of the thread for the entire runtime of the request.

Clicking on “Display” creates a new snapshot of the thread.

A request normally consists of a number of components and subcomponents that can also be nested. The components in the request can launch specific actions.

The threads can only be evaluated if all the components and subcomponents of a request run in the same thread.


You will get information about the

• Processed Component

• Elapsed Time for Component

• Processed Action

• Request Name

• Elapsed Time for Request

• Sum of elapsed Time for Thread

• Thread Name


Processed Components Name of the component that is currently being processed

Elapsed Time for Component Time elapsed since calling this component

Processed Action Action processed with this component. The component creates the text for the action.

Request name Name of the request


2004 SAP AG 67

Elapsed Time for Request Time elapsed since the request was started (the time for processing in the backend system is measured).

Sum of Elapsed Times for Thread Time for all requests (sum) that already ran in this thread

Active „Yes“ – thread executes a request at the time of the thread overview. „No“ – thread does not execute a request at the time of the thread overview.

User ID ID of the user who started the request

Thread Name Technical name of the thread (thread ID)

3.5.8 Sherlok

The Sherlok tool developed by SAP is designed to analyze Java applications. For that purpose, Sherlok uses the Virtual Machine Profiler Interface (JVMPI) and the Virtual Machine Debugger Interface (JVMDI) in order to get information from the Java VM.

The most important questions that can be clarified with Sherlok are:

• Which application consumes how much memory or time?

• Which threads and methods are currently active?

• How much time does a certain method use or is this method called at all?

• Why is the VM slow?

Sherlok consists of three parts: The Telnet Console, the iView Testbench and the iView Moni-tor.

For more information about the installation refer to the documentation delivered with Sherlok (see note 684907).

3.5.8.1 Telnet Console

Sherlok telnet console is an expert tool and allows to evaluate:

• Trace for program execution

• Trace for methods call parameter

• Trace for exceptions (suspend exection at OOM)

• Memory and time measurement

• HotSpot analysis to find time consuming execution path


2004 SAP AG 68

Command Meaning

man / help Shows list of all commands and a short description

lsc [options] Shows a list of all classes monitored by Sherlok, ordered by their size, i.e. the total memory occupied by all instances. You can pass a ‘minimum size’ to shorten the list.

lsm [options] Shows the list of all monitored methods (ProfilePoints) sorted by their accumulated processing times. As parameter you can specify a minimum time.

lss Shows status overview of the monitor.

ctrlb Shows thread dump on the Java console.

start monitor Activates monitoring mode where memory usage is accumulated under the ProfilePoints.

start trace Starts the trace mode where also method calls can be logged.

start log Starts logging of Sherlok output to the logfile “sherlok.log” that is written at the same place as the config file is found.

stop monitor Stops the monitoring mode.

stop trace Stops the trace mode.

stop log Stops output to the log file.

reset Rereads the config file. This allows to define


2004 SAP AG 69

new ProfilePoints etc. but not changing the scope.

gc Triggers a garbage collection in the Java VM.

dt “dump threads”=Lists all threads of the Java VM (thread dump)

repeat [n] Repeat the last command – optionally every n seconds.

trace [options] Enable/disable different trace options.

3.5.8.2 iView Test-Bench

iView TestBench is a memory tracker and tracer for Java applications. iView TestBench allows you to check how much memory and time an iView or any other Java component needs to run. You can see the memory it needs to start up, and the memory needed per step, i.e. user interaction. With the iView TestBech you will be able to find out

• which iView is currently responsible for a certain amount of memory

• which iView produces a huge amount of temporary objects (to service a request)

• which iView methods are performance relevant (take much time)

It is notoriously hard to track memory usage in Java, since memory is shared by all. All compo-nents allocate memory, and the garbage collector (GC) collects no longer referenced objects. iView TestBench allows to find out which component allocated and holds a certain amount of memory.

3.5.8.3 iView Monitor

iView Monitor is a heap analyzer and memory leak detector. iView Monitor allows to check how much memory and time an iView or any other Java compo-nent needs to run. You are able to generate a heap dump to find:


2004 SAP AG 70

• the number of objects allocated

• the name of the classes

• the cumulated size for each class

• growing classes

Relevant OSS notes

684907 Installation of the Sherlok tool

3.6 UME related Tools

Relevant OSS notes

589012 EP 6.0: Central Note for EP-BC-UME (User Management)

3.6.1 User Management Configuration Tool (sapum.properties)

All UME configuration data is stored in sapum.properties file in the Portal Database.

Sapum.properties contains references of configuration files for the user persistence storage.

Configuration files are called dataSourceConfiguration_<description>.xml

Each configuration file contains a list of data sources for multiple systems (LDAP server + DB, multiple LDAP servers).

Path: System Administration -> System Configuration -> UM Configuration -> Tapstrip “Direct Editing”

Or: http://<server:host>/irj/servlet/prt/portal/prteventname/HtmlbEvent/prtroot/ com.sap.portal.usermanagement.admin.UMPropertyEditor


2004 SAP AG 71

Before changing the User Repository, make sure that you have a superuser in the new repository (e.g. acitivate sap*), cf. note 675633.

After changing settings using the configuration tool, you must restart the Portal Runtime for changes to take effect!

For further information on how to maintain the sapum.properties-file, please have a look at the Online Documentation:

http://help.sap.com -> SAP Netweaver -> SAP Enterprise Portal -> Administration Guide -> Portal-Platform -> System Administration -> User Management Configuration -> Configuration Files -> User Management Properties (sapum.properties)

3.6.2 Logged On Users

User management informs the user overview service each time a user logs on or off from the por-tal. The service keeps a list of this data, together with a time stamp for the logon. This is displayed in the user overview.

Number of Logged On Users tells you the total number of active users.

Path: System Administration -> Monitoring -> Portal -> Logged On Users

Known Issue If a user does not use the LOG OFF Link, but closes only the browser, he will still appear in the list of Logged On Users until the ticket has been expired.

This is not problematic because there are no threads running for this user.


2004 SAP AG 72

3.6.3 User Account History

Shows events such as user account locked or last login time for a single user since the creation of that user. You can view a user’s account history in the user profile for that user.

Path: User Administration -> Users -> Search -> Select one user

3.6.4 Single Activity Trace (SAT)

In case of performance problems Activity Trace is used to analyze a single component in detail. You can sequentially record the activities of individual requests and their components for a defined period of time, and then analyze their performance and errors in the Log Viewer of the SAP J2EE Engine. Technically, activity tracing is based on the Java Application Responsetime Measurement (JARM).

3.6.4.1 Activating the SAT

The tracing is activated on a user base and the results are written to a trace file named sat.trc.0 (this file can only be viewed with the LogViewer) in \..\cluster\server\log

Path: System Administration -> Monitoring -> Portal -> Activity Tracing


2004 SAP AG 73

When you launch this page, the Area “Activated Tracings” at the bottom of this page, shows which users are currently active for this function, who activated this function, and when activity tracing will expire (default value is 30 minutes). The time when activity tracing will expire is the time zone of the Java Virtual Machine. This could differ from your local system time.

3.6.4.2 Analyzing the SAT

The SAT trace file is displayed by the Log Viewer. Currently you have to use the Standalone Log-viewer to view this file (-> chapter 3.2.2).

The calls from requests (red name), components (blue name) and actions (gray name) are written record-by-record sequentially to the trace file together with the corresponding performance data (columns) of the individual users. You can configure the display of the performance data by hiding or showing columns. You can also define the order of the individual columns. For more informa-tion, see the separate Administrations and User Guide for the Log Viewer.

Example of SAT Log displayed in the Standalone LogViewer:

Meaning for Column Header

Requests (red) Components (blue) Actions (gray)

ClassName N/A = not available (planned for a later release)

classVersion N/A = not available (planned for a later release)

Datasource Storage path of the trace file as <servername>:<path>

Date Time when this data record was written


2004 SAP AG 74

Description N/A = not available Description of the action performed. The name is defined ac-cording to the convention: <solution>:<component>: <details>

GrossTime Total time of the request or component (in-cluding time for all subcomponents)

-1 = not available

Level -1 = not applicable Nesting Level

0 = main component 1 = component was called from the main component, etc.

-1 = not applicable

Location Source of the data record, normally the class name

Message SATRecord = ID of the activity trace file

Message ID ID of the message permitting unique cross references to messages in dif-ferent log files

Request name (red) Component name (blue)

Name

The name is defined according to the con-vention: <solution>:<component>:<localization>

N/A = not available

NetTime Net time of the request or component (com-puted from its gross time less the gross time of the subcomponents).

-1 = not available

Number Of Sub Rec

Number of compo-nents contained

Number of actions contained

-1 = not applicable

outData Amount of outbound data for a request

-1 = not available

Properties Specific properties, displayed in square brackets [ ]

Provider Source of the trace information

1 = JARM 3 = TREX

RecType Data record type

10 = JARM request 11 = JARM component 12 = JARM action 30 = TREX trace

SequenceNumber -1 = not applicable Position in the call sequence within a request (start-ing with 0 = first call)

Severity Degree of severity assigned to the trace data record

Source Name Name of the log controller from which the data record origins

startTS Time when the request, component or action was started

State 0 = OK 1 = Call not ended correctly 2 = Overflow (e.g. too many component calls)

-1 = not available

Thread Technical name of the thread (thread ID) in which the request, component


2004 SAP AG 75

or action is running

Username ID of the portal user N/A = not available N/A = not available

You are also able to see the SAT Log using the built in LogViewer. But then the output will be for-matted in another way and is not as easy to read as with the Standalone Logviewer. So the Stand-alone Logviewer is the most suitable Viewer for the SAT Log.

Example of SAT Log displayed in the built in LogViewer:

3.6.4.3 Maintaining the SAT-Controller Service

By default, activity tracing is activated for each user for 30 minutes. You can change the time in-terval in the Service Configuration (Administration -> System Configuration -> Service Configura-tion -> Application “com.sap.portal.runtime.application.monitor” -> Service -> SAT-Controller).


2004 SAP AG 76

The change is effective for all users. A user-dependent configuration is not possible.

In a cluster environment, activity tracing is activated automatically for all cluster nodes.

3.6.5 UME Logs

3.6.5.1 Usermanagement.log

You can read the usermanagement.log using the Standalone Logviewer (-> chapter 3.2.2), the built in Log Viewer (-> chapter 3.2.1), the Log and File Viewer (-> chapter 3.2.3) and the Java Logging Console (-> chapter 3.2.4).

The location of usermanagement.log is:

\<J2EE>\cluster\server\services\servlet_jsp\work\jspTemp\irj\root\WEB-INF\portal\logs.

3.6.5.1.1 Loglevel Configuration using the Logging Console

The log-level is configured in the file WEB-INF\portal\system\xml\logger.xml. You should set the entry “usermanagement_logger” level = “INFO” in order to get all debug information.

The easiest way to maintain the logger.xml is using the Logging Console in the Portal (-> chapter 3.2.4).

Path: System Administration -> Monitoring -> Portal -> Logging Console

If you start the logging console, you are in the User Mode. To switch to the Administration Mode, click on -> Configuration Mode.

-> switch to Configuration Mode


2004 SAP AG 77

-> In the Configuration Mode you are able to activate a package. A functional description of each package can be found in the table below.

Changing the trace level to ALL for all usermanagement packages, results in a very large log file. This is usually not recommended.

Instead: Depending on the problem, only activate a specific (or multiple) packages. Deactivate all other components.

Here is a description of the areas, which can be logged by activating a package:

Package name Activate for problems

com.sap.security.api

com.sap.security.core.acl ACL implementation

com.sap.security.core.admin User Administration

Group Administration

Self Registration

com.sap.security.core.imp All other classes

com.sap.security.core.persistence LDAP or database or R/3

com.sap.security.core.role Role Assignment

com.sap.security.core.session Single Sign-On, Log on

com.sap.security.core.ticket Single Sign-On

com.sap.security.core.umap Usermapping

com.sap.security.core.util

com.sapportals.portal.prt.service.usermanagement Usermanagement service

NOTE:

There is a correlation between the usermanagement_logger and the um_info_logger:

In the usermanagement_logger you can activate packages. But the location for the related logfile usermanagement.log will be defined in the um_info_logger. That means, regarding the file location maintenance, you will be redirected from the usermanagement_logger with logger class “…LoggerDelegator” to the um_info_logger with logger class “…SimpleFileLogger”, where the file location will be defined. You can see this correlation in the file logger.xml.


2004 SAP AG 78

Redirection to um_info_logger through logger class “LoggerDelegator”:

Location of the usermanagement.log will be maintained in um_info_logger with logger class “Sim-pleFileLogger”:

Do not maintain a location for the usermanagement.log in the usermanagement_logger with log-ger class “…LoggerDelegator” or “…ConsoleLogger”. This will not take effect.

The defined location will only be considered, if you choose logger class “…SimpleFileLogger”.

3.6.5.2 Sapum.log (Security Logging)

Path: \..\cluster\server\sapum.log

In the sapum.log file all security relevant information will be logged as:

• User login (successful/failed)

• IP address of user logged in

• User logoff

• User created/modified

• User approval/denial

• User locked/unlocked

• Role assignment changed

[TimeStamp] | [Severity] | [Actor] | [Event] | [ObjectType] = [ObjectID]

The parts of the log file entries are described in more detail below:

Timestamp Includes time zone (UTC)

Severity Info = Low

Warning = Medium

Error = High


2004 SAP AG 79

Fatal = Very High

Actor The logged in user or <systemuser> if no user was logged in (optional).

Event Consists of a category (such as USER, LOGIN, ACL) and an action (such as CREATE, DELETE).

ObjectType The type of object involved in the event, for example, USER, USERAC-COUNT, ROLE, GROUP, PRINCIPIAL or NONE

ObjectName Human readable description of the object (optional).

Details Additional information as a comma-separated list of key=value pairs.

The sapum.log will be activated/maintained in sapum.properties (-> chapter 3.6.1).

Property of sapum.properties Value Description

ume.secaudit.log_actor Default value is TRUE.

FALSE = Actor of event is not logged.

Defines whether the actor of an event is written to the log file.

ume.secaudit.get_object_name Default value is TRUE. Defines whether the display name of an object is written to the log file in addition to the object ID.

ume.trace.trace_level Default value is 1.

0 = Fatal

1 = Error

2 = Warning

3 = Info

Defines the severity level at which events are logged.

3.6.6 Test and Configuration Tools

3.6.6.1 Status of UME properties

This tool is helpful to check, if there are different values in sapum.properties in the database and the PCD. If you maintain the file sapum.properties and you do not restart the engine, you will have different entries in the Tab “File Property View” and “Active Property View”. In the Tab “File Prop-erty View” you can find the values of the sapum.properties in the Database. After a restart of the engine, these values will be uploaded to the PCD, so that you find the same values then in the “Active Property View”.

Use case: Maybe somebody maintained the sapum.properties and forgot/was not able to restart the engine. You would like to check, which current values are used. One way is to restart the engine and check then in the “direct editing” tab of the UM configuration. But maybe you are not able to restart the engine at the moment. In that case, this tool will help you to compare the values of sapum.properties in the database and PCD.

Path: System Administration -> Support -> Area “User Management” -> Test and Configuration Tools “Status of UME properties”.


2004 SAP AG 80

Or: http://<server:port>/irj/servlet/prt/portal/prtroot/

com.sap.portal.usermanagement.admin.UMPropertyViewer

3.6.6.2 Cache monitor of UME objects

This tool shows the cache status of UME principal objects.

Path: System Administration -> Support -> Area “User Management” -> Test and Configuration Tools “Cache monitor of UME objects”.

Item counter: Number of items in the cache

Hit counter: Number of successful hits in the cache

Miss counter: Number of unsuccessful hits in the cache

In this example almost every hit is a successful hit in the cache (more than 98 %). If the hit counter would be low and the miss counter would be high, you should check the cache settings.


2004 SAP AG 81

3.6.6.3 Performance monitor of UME objects

Shows the performance status of UME datasource adapters. With this tool you can check very basically the performance of a UME datasource adapter, e.g. the minimum time, the average time and the maximum time of user logins.

This can give you a first impression where to do further investigation, if e.g. a login needs a lot of time.

Path: System Administration -> Support -> Area “User Management” -> Test and Configuration Tools “Performance monitor of UME objects”

-> Activate User Management Performance Monitor

-> New Login to the portal with another user

-> Click Refresh


2004 SAP AG 82

Populate principal: time to populate 1 object from the database

Populate single attribute: time to populate 1 attribute of 1 object from the database

3.6.6.4 Test component for UME objects

Use input fields to get information about principals.

Path: System Administration -> Support -> Area “User Management” -> Test and Configuration Tools “Test component for UME objects”.

You can display information about user and edit attrib-utes.

-> as User data


2004 SAP AG 83

-> assigned Groups

-> assigned Roles

3.6.7 Download complete User Management Configuration (config.zip)

The complete User Management Configuration can be downloaded directly from the Portal. This might be helpful in case you need to write an OSS-Message. Then you can easily attach the con-fig.zip file.

Path: System Administration -> Support -> Area “User Management” -> Test and Configuration Tools “Status of UME properties” -> Tabstrip “Configuration Download”.

Or: http://<server:port>/irj/servlet/prt/portal/prtroot/

com.sap.portal.usermanagement.admin.UMPropertyViewer

3.7 CM related Tools

3.7.1 Knowledge Management Log (KM Log)

The KM log provides you with system information for the Knowledge Management platform. This information can be used to monitor the system and analyze errors. You can use a text editor or the log viewer of the J2EE engine to display the logged data.

Configuration file

logging.properties

usr/sap/<instanceName>/j2ee/j2ee_<instanceNunber>/cluster/server/services/servlet_jsp/work/jspTemp/irj/root/WEB-INF/portal/portalapps/com.sap.netweaver.bc.util/lib/

Name knowledgemanagement.*.log

* is a value from 0 to 9.

If the maximum number of log files already exists in the system, the oldest log file is overwritten if a defined file size is exceeded.

The name can be set in the file logging.properties with the log[File].pattern parameter:

log[File].pattern = ./services/servlet_jsp/work/jspTemp/irj/root/WEB-INF/portal/logs/knowledgemanagement.%g.log

Default Location usr/sap/<instanceName>/j2ee/j2ee_<instanceNunber>/cluster/server/services/servlet_jsp/work/jspTemp/irj/root/WEB-INF/portal/logs/


2004 SAP AG 84

(De)activation To deactive the log

Set *.severity = NONE

Or comment out the line with #

Severity levels NONE, MAX, FATAL, ERROR, WARNING, INFO, PATH, DEBUG, MIN, ALL

Setting severity levels

The severity levels can be set for individual java classes and packages via the severity parameter in logging.properties:

<Java class>.severity = <severity level> or

<Package>.serverity = <severity level>

Log size Can be set with parameter log[File].limit in logging.properties:

log[File].limit = n (Default: n = 1000000)

Log backup Can be set with parameter log[File].cnt in logging.properties:

log[File].cnt = n (Default: n = 10)

Example of the configuration file: logging.properties

# Configure console and file loggers with their formatters log[Console] = ConsoleLog log[Console].formatter = formatter[Console] log[File] = FileLog log[File].pattern = ./services/servlet_jsp/work/jspTemp/irj/root/WEB-INF/portal/logs/knowledgemanagement.%g.log log[File].limit = 1000000 log[File].cnt = 10 #log[File].formatter = formatter[File] #formatter[File] = TraceFormatter #formatter[File].pattern = %24d (%p) %l [%t] %s: %m # Configure loggers and severities for locations # Example for com package (please avoid such general configurations): # com.logs = log[File],log[Console] # com.severity = WARNING com.sapportals.config.logs = log[File],log[Console] com.sapportals.wcm.logs = log[File],log[Console] com.sap.netweaver.bc.rf.logs = log[File],log[Console] com.sapportals.config.severity = WARNING com.sapportals.wcm.severity = WARNING com.sap.netweaver.bc.rf.severity = WARNING com.sapportals.wcm.repository.runtime.CmSystem.severity = INFO com.sapportals.wcm.repository.security.SecurityAudit$Log.severity = NONE # Configure loggers and severities for categories # Example for com package (please avoid such general configurations): # /.logs = log[File],log[Console] # /.severity = WARNING

Please note that the Knowledge Management Log and the Application Log (described in 3.7.2.4) do not contain congruent information.

Therefore, to make sure that all the logged errors are checked, both sources need to be taken into account when investigating errors.


2004 SAP AG 85

3.7.2 KM Monitoring

The following KM monitoring and logging functions are available as iViews in the portal.

3.7.2.1 Component Monitor

Use: To identify wrongly configured objects of the following components of the KM platform.

· Filters

· Repository managers

· Repository services

· Global services

Path: System Administration -> Monitoring ->Knowledge Management -> Component Monitor

The status of an object is displayed in the form of a coloured symbol. The colour helps you to iden-tify whether an object is wrongly configured. A message text helps you to find the error and correct the configuration of the object.

If a component has objects that are either wrongly configured or that couldn’t be started, a yellow or red symbol is displayed in the tree view. Open the components affected, and read the error messages for any objects with errors. You correct errors by calling up the configuration of the ob-ject (for example, repository manager) and correcting the errors there.

3.7.2.2 Cache Monitor

Use: To monitor the current status of all active caches. The data displayed in the cache monitor can be used to determine appropriate cache configuration.

Path: System Administration -> Monitoring ->Knowledge Management -> Cache Monitor


2004 SAP AG 86

Cache Monitor Entries:

Entry Description

Name Cache name

Size Current size of cache in bytes.

The size of the entries is not known for all caches. This is because not every program specifies this entry explicitly when an entry is generated. However, in the case of a Web repository manager, the size is given and can therefore be displayed.

Capacity Capacity of the cache, specified during the configuration of the cache.

Current Current number of entries in the cache.

Peak Maximum number of entries ever stored in each cache.

Added Number of objects that have been added to the cache since recording began.

Removed Number of objects that have been removed from the cache since recording began.

These objects have been overwritten by new objects, or have become invalid because they have exceeded the Entry Default Time to Live.

Gets Number of all successful requests to web server.

Hits Number of all successful access attempts to the cache entries.

A successful access attempt means that the entry the system was searching for was found in the cache.

Hits/Gets Ratio of hits to gets, specified as percentage value.

The higher the value, the more effective the cache.

The Cache Monitor provides important statistics about the caches configured for KM. If the dis-played peak value over a long period is significantly smaller than the capacity of the cache, you can reduce the capacity of the cache using Content Management -> Utilities -> Caches. However, if the peak value and the current number of entries in the cache reach the maximum capacity value, increase the capacity of the cache.

Cache Monitor can improve performance by making frequently used resources more readily avail-able. Memory caches provide short-term improvements, whereas persistent caches provide long-term improvements.


2004 SAP AG 87

3.7.2.3 Crawler Monitor

Use: To monitor and control the activity of crawlers on your server.

Path: System Administration -> Monitoring ->Knowledge Management -> Crawler Monitor

Each crawler carries out a crawling process on the server. A list of these crawling processes is displayed in the crawler monitor. When a crawler completes its activity, it remains in the list for a certain amount of time.

You can toggle between three different views: Parameters, Status, and Statistics (see below).

You can sort the lists according to different criteria. Select the sort criteria you want from the sort field in the upper right-hand corner. The arrow to the right of the sort field shows if the list is sorted in ascending or descending order. You can reverse the sort order by clicking on this arrow.

3.7.2.4 Application Log

Use: To display error messages, warnings, and other information generated by KM applications and services.

Path: System Administration -> Monitoring ->Knowledge Management -> Application Log

The Application Log entries are written in the table wcm_applog of the CM database wcm. For ex-ample, the content exchange service and crawler service write entries to the application log. Above all, system changes that cannot be reconstructed are logged (for example, deletion).


2004 SAP AG 88

Application log output can be filtered, adjusted and downloaded with the Options tags:

• In the Filters area, you can set the log level, relevant period of time, and search criteria for the column and principal (user, group or role).

• In the Display area, you select the columns that should be displayed in the output.

• The log can be downloaded via the Download area. The size of the downloaded log de-pends on the selected log level and the period of time.

Please note that the Application Log and the Knowledge Management Log do not contain congru-ent information.

Therefore, to make sure that all the logged errors are checked, both sources need to be taken into account when investigating errors.

3.7.3 DBPING Tool (CM Database Connection Test Tool)

You can use this database connection test tool (DBping) to monitor the state of your CM database connection. The DBPING tool was initially delivered with CM SP4 Patch 3 Hotfix 2 and is now available via ftp://sapserv3/general/SAPPortals/notes/note.0591829 (see Note 583057).

Name DBping CM database connection test tool

Location The ZIP files dbping_mssql.zip or dbping_oracle.zip containing the DBPing tool have to be downloaded from /sapserv3 :

ftp://sapserv3/general/SAPPortals/notes/note.0591829

Make sure you download the file in binary mode and extract it to a temporary directory on the portal server.

Execution Execute the dbping_<dbtype>.bat command script:

dbping_<dbtype>.bat <server> <database/SID> <user> <password> [<intv>]

• <dbtype>: "mssql" or "oracle" server

• <server>: Name of the database server.

• <database/SID>: SQL Server: database name, Oracle: SID.


2004 SAP AG 89

• <user>: User logon ID. Logon IDs are case-sensitive.

• <password>: Password of the user. Passwords are case-sensitive.

• <interval>: Time interval between ping requests. Optional, default is 10 seconds.

The dbping tool should run on the servlet engine server and ping the database server (which is usually on a different machine). The output can be redirected to a text file by adding >dbping.log at the end of the command line.

Relevant OSS notes

591829 CM database connection test tool DBPING

Example: dbping command:

3.8 TREX related Tools

3.8.1 TREX Monitor

The TREX Monitor provides information on the status of the queue server, index server and name server. The administrator can modify the settings for the queue server. Queues can also be moni-tored and administered from here.

Name: TREX Monitor iView

How to use: In the top-level navigation bar of the portal, select System Administration →

Monitoring → Knowledge Management →TREX Monitor


2004 SAP AG 90

3.8.2 Search Engine Trace

This trace contains information about general TREX-related error messages. Depending on the trace level, it contains information on all search requests and activities on the index server. You are recommended to keep the trace level at ‘error’ and increase it to ‘debug’, if necessary, for a more thorough problem investigation.

The following table is valid for TREX 6.0:

Name TREXIndexServer<XXXX>.<YYY>.trc

<XXXX> Process ID

<YYY> Number of the trace file (starting with 000)

Example: TREXIndexServer.01328.002.trc

Location <SAP_RETRIEVAL_PATH> \trace

The trace folder is located in the TREX installation folder.

(De)activation The search engine trace can be toggled in TREXIndexServer.ini, which is lo-cated in the TREX installation folder (<SAP_RETRIEVAL_PATH>). Restart the index server to activate the new settings.

Trace levels none, fatal, error, warning, info, debug.

Default trace level is error.

You are recommended to use debug for problem analysis only. If possible, do not use info as your standard trace level as otherwise the trace file will grow rapidly.


2004 SAP AG 91


Change parameter trex_se.

Log size The size and number of trace files can be defined by setting the following pa-rameters:

maxfilesize maximum size of the file in bytes, e.g. 10000000 stands for 10 MB

maxfiles maximum number of trace files for a given process ID, e.g. 10 means that a maximum of 10 trace files are allowed for the same PID. If the system creates the 11

th trace file, it overwrites the 1

st (oldest) trace file.

Log backup -

Relevant OSS notes

-

3.8.3 TREX Mining Trace

The mining trace helps to identify errors in the text mining engine. Typical problems related to the mining engine are issues with categorization and classification or if the See also feature does not work.


Name TrexIndexServer<XXXX>.<YYY>.trc

<XXXX> Process ID



Location <SAP_RETRIEVAL_PATH>\trace


(De)activation The mining trace can be toggled in TREXIndexServer.ini, which is located in the TREX installation folder (<SAP_RETRIEVAL_PATH>). Restart the index server to activate the new settings.





2004 SAP AG 92


Change parameter textmining.






Log backup -

Relevant OSS notes

-


2004 SAP AG 93

3.8.4 Python Trace

The python trace keeps track of all incoming requests to the TREX. This trace file is useful for in-depth problem analysis and is usually requested by development support. For TREX 6.0 this is part of the standard delivery.

Attention: The python trace file grows very fast. Do not forget to switch it off.

Name servertrace.py

Location TREX 6.0: <SAP_RETRIEVAL_PATH>\trace


(De)activation The python trace can be switched on in the TREXIndexserver.ini file, which is located in the TREX installation folder (<SAP_RETRIEVAL_PATH>)

The new settings are active immediately (without TREX service restart).

Trace levels On, off


Change the trace parameter. The python trace is switched off by default.

Log size There is no file size limit.

Log backup -

Relevant OSS notes

-


2004 SAP AG 94

3.8.5 TREXNameServer Trace

The name server trace helps with the analysis of errors raised by the name server (if the name server is available). The following data is valid for TREX 6.0:

Name TREXNameServer<XXXX>.<YYY>.trc

<XXXX> Process ID


Example: TrexNameServer.01328.002.trc



(De)activation The TREX name server trace can be switched on in the TREXNameServer.ini file, which is located in the TREX installation folder (<SAP_RETRIEVAL_PATH>). The new settings are active after restarting the name server.





Change parameter default.

Log size The size and number of trace files can be defined with the following parame-ters:




st

(oldest) trace file.

Log backup -

Relevant OSS notes

-


2004 SAP AG 95

3.8.6 TREXPreprocessor Trace

The pre-processor trace identifies errors raised when pre-processing and filtering retrieved docu-ments.

The following data is valid for TREX 6.0:

Name TrexPreprocessor.<XXXX>.<YYY>.trc

<XXXX> Process ID


Example: TrexPreprocessor.00820.000.trc



(De)activation The preprocessor trace can be switched on in the TREXPreProcessor.ini file, which is located in the TREX installation folder (<SAP_RETRIEVAL_PATH>).

The new settings are active after restarting the preprocessor.











Log backup -

Relevant OSS notes

-


2004 SAP AG 96

3.8.7 TREX Filter Trace

In addition to the TREX pre-processor trace, the TREX filter trace also helps to identify errors raised when pre-processing and filtering retrieved documents. The following data is valid for TREX 6.0:

Name TREXFilter<XXXX>.<YYY>.trc

<XXXX> Process ID


Example: TREXFilter.01328.002.trc



(De)activation The TREX filter trace can be switched on in the TREXFilter.ini file, which is lo-cated in the TREX installation folder (<SAP_RETRIEVAL_PATH>).

The new settings are active after restarting the server.








maxfiles maximum number of trace files for a given process ID, e.g. 10 means that a maximum of 10 trace files is allowed for the same PID. If the system creates the 11


st


Log backup -

Relevant OSS notes

-


2004 SAP AG 97

3.8.8 TREX Queue Client

The functions of the TREX queue client are an extension to the functions of the TREX Monitor (-> chapter 3.8.1). They provide information about the status of the queue server, queue monitoring, and administration, as well as information about error codes, change index parameters, activate queues etc.

Name TREXQueueClient

How to use • Select Run from the Start menu of Windows. Enter trexqueueclient and press Return.

• Enter the host name of the TREX server and the port for the queue server (default value is 8352)

3.8.9 TREX Queue Server Trace

The TREX queue server trace provides information about requests issued to the queue server.


Name TREXQueueServer<XXXX>.<YYY>.trc

<XXXX> Process ID


2004 SAP AG 98


Example: TREXQueueServer.01328.002.trc



(De)activation There are two ways to toggle the TREX queue server trace:

• In the TREXQueueServer.ini, which is located in the TREX installation folder (<SAP_RETRIEVAL_PATH>). The new settings are active after restarting the server. In the TREXQueueServer.ini file you can define the trace level for the queue server and for each index.

• With the TREXQueueClient tool. The new settings are active immedi-ately; you do not need to restart the server.





• TREXQueueServer.ini

Change parameter default or _q_<index ID>, e.g. default = debug or _q_documents = DEBUG.

• TREXQueueClient.exe

Select Run from the Start menu of Windows. Enter trexqueueclient and press Return.

Choose Set QS Trace → Component: queueserver → Threshold: DE-BUG


2004 SAP AG 99

Choose Set Parameters and enter the index ID to set the trace level for individual indices:


2004 SAP AG 100





st


Log backup -

Relevant OSS notes

-

3.8.10 Dump_index Command

This command accesses detailed information about the content of a single index (terms, words, documents). The dump_index tool is part of a standard TREX installation.

Name Dump_index

How to use Open a cmd prompt and issue the following command:

dump_index <option [-t |-d |-w]> <IndexId> <output_file> [<term>]

-d Dump all indexed (not optimized) documents

-w Dump all words (available after optimizing only)

-t [<term>] Dump all document references for the corresponding term (one


2004 SAP AG 101

term only, enter in lower case)

-i[1-4] Dump all documents in the index with only the number(1), a list of keys(2), a list of keys and attributes(3) or content(4).

Example:

The index ID must be specified with the language extension (as given in the index folder in the TREX installation directory): <SAP_RETRIEVAL_PATH>\index

The output file is written to the directory where the dump_index command was run. The content of the file looks something like this:

3.8.11 TREX Index Server Trace

The TREX index server trace is the most important TREX trace. It helps you to analyze problems that occur during indexing and issues with the search engine, text mining engine, index optimiza-tion, etc.

This trace contains general error messages and, depending on the trace level, information about search requests and related activities in the index server.


Name TREXIndexServer<XXXX>.<YYY>.trc

<XXXX> Process ID




2004 SAP AG 102



(De)activation The index server trace can be switched on in the TREXIndexServer.ini file, which is located in the TREX installation folder (<SAP_RETRIEVAL_PATH>).

Various parameters allow you to define trace levels for different TREX compo-nents, the most important ones being:

trex_se Defines the trace level for the search engine

textmining Defines the trace level for the text mining engine

trex_c_store Defines the trace level for indexing, index optimization, etc.

The new settings are active after restarting the server.

Trace levels none, fatal, warning, info, debug, error


You are recommended to use debug for problem analysis. If possible, do not use info as otherwise the trace file will grow rapidly.


Change parameter default, trex_se, textmining or trex_c_store.



maxfiles maximum number of trace files for a given process ID, e.g. 10 means that a maximum of 10 trace files is allowed for the same PID. If the sys-tem creates the 11



Log backup -

Relevant OSS notes

-


2004 SAP AG 103

3.9 Backend Related Tools

3.9.1 DB related Tools

Relevant OSS notes

580358 Central notes for Oracle DB for EP 6.0

3.9.1.1 Monitoring DB

Monitoring of relational databases needs to be performed with tools and monitors available at the customer side. The standard set for monitoring of DB would be:

Product Standard Monitoring Tool

SQL Server SQL Server Profiler

Oracle Oracle Monitoring

3.9.1.2 Oracle Alert File

If issues within your portal landscape indicate that there are problems with the Oracle database (e.g. if Java logs contain related exceptions), you should check the Oracle alert log. Once you de-termined the data and point of time of the error, you can search through the respective alert log to identify related errors from the Oracle database. There are OSS Notes available for most Oracle error codes. We suggest that you search for EP* or BC-DB-ORA to track and resolve Oracle-related problems.

Name <SID>alrt.log

This is the background process trace file.

Location The Oracle alert file is located in \%SAPDATA_HOME%\saptrace\background by default. Parameter background_dump_dest in Oracle configuration file init<SID>.ora in %ORACLE_HOME%\database determines the location of the log file.

(De)activation Always active.

Trace levels -


-

Log size Log size depends on the database load. There is no set size limit.

Log backup You must perform backups manually by renaming the alert file. Oracle then automatically creates a new alert file. This should be done on a regular basis to keep the file size smaller than 1 MB.

Relevant OSS notes

You can search component BC-DB-ORA for Notes by submitting the Oracle error message (e.g. ORA-0060) in OSS.


2004 SAP AG 104

3.9.1.3 Oracle User Trace Files

For a general approach for resolving Oracle-related issues, see the introduction to chapter 3.9.1.1.

Name Ora<XXXXX>.trc

<XXXXX> is a 5-digit number defining the Windows thread ID. These trace files are created for individual user threads.

Location The Oracle user trace files are normally located in %SAPDATA_HOME%\saptrace\usertrace. Parameter user_dump_dest in the configuration file of Oracle init<SID>.ora in %ORACLE_HOME%\database de-fines where these traces are written.


Relevant OSS notes

You can search on component BC-DB-ORA for Notes by submitting the Oracle error message (e.g. ORA-0060) in OSS.

3.9.1.4 MS SQL Server Database Logs

Name ERRORLOG

This is the log file of the MS SQL Server database. A new log file is generated each time the SQL Server is started. The old log file is renamed to ERROR-LOG.1 and remains in the same directory. Older log files are archived in as-cending order (ERRORLOG.<number>).

SQLAGENT.OUT

There is a separate process running on operating system level called SQLA-GENT. This process is responsible for scheduling internal database jobs. It has a separate log file called SQLAGENT.OUT. A new log file is generated each time the SQLAGENT is started. Old log files are archived as SQLA-GENT.<number>.

Location Default path: \..\Program Files\Microsoft SQL Server\Mssql\Log\

You can define the path where the log files are stored when the database is installed. You can also check the error log from within an R/3 system. Execute transaction st04 and select Detail analysis menu -> Error Logs.


Trace levels Events written to the log file are assigned to different severity levels, but it is not possible to define a trace level for the log files.


-

Log size Each time the SQL Server is started, a new error log is generated. The error log has no customizable size limit.

Log backup Old error logs are archived in the same directory as the log files. The number of archived files can be defined in the SQL ServerEnterprise Manager (a tool pro-vided with the SQL server for managing the database). Start the SQL Server

Enterprise Manager, go to <SQL Server name> → Management → SQL Server Logs in the tree. Mark SQL Server Logs in the tree, right-click and select Con-figure.


2004 SAP AG 105

3.9.2 LDAP related Tools

3.9.2.1 LDAP Tracer

In the LDAP Tracer you can see, how long an LDAP-access has taken (in milliseconds).

At the end of the trace file you can find a summary per component.

Location After the activation of the LDAP Tracer you can find in \..\cluster\server the file sapum.access.audit

(De)activation The LDAP Tracer can be (de)activated in the Direct Editing Tab of the UM Con-figuration (file sapum.properties) (-> chapter 3.6.1).

Change the property ume.ldap.connection_pool.monitor_level=2000 and ume.ldap.record_access=true. Restart the J2EE Engine.

3.9.2.2 Java LDAP Debugging

You can create a Java LDAP trace to get a detailed look at the data exchange between the SAP J2EE Engine and the LDAP directory server. A trace of the requests from SAP Enterprise Portal to the LDAP directory server and the triggered responses can contain valuable information.

Location After activation, all traffic between the Java servlet and the LDAP directory server is traced in the default log of the SAP J2EE Engine located at \..\<J2EE directory>\cluster\server\managers\console_logs.

(De)activation Start the SAP J2EE Engine with the option -DLDAP_DEBUG=true to activate LDAP debugging by adding the option in service.ini (if the J2EE Engine is started as an NT service) and restarting the SAP J2EE Engine or to go.bat if the engine is started from the console.

Example: LDAP trace:


2004 SAP AG 106

<- p72201:389 0000: 30 82 01 07 02 01 35 64 82 01 00 04 3C 63 6E 3D 0.....5d....<cn= 0010: 48 39 43 43 4C 4E 54 38 30 30 5F 53 41 50 5F 42 H9CCLNT800_SAP_B 0020: 43 5F 42 41 54 43 48 5F 41 44 4D 49 4E 2C 6F 75 C_BATCH_ADMIN,ou 0030: 3D 50 6F 72 74 61 6C 72 6F 6C 65 73 2C 6F 3D 53 =Portalroles,o=S 0040: 41 50 50 4F 52 54 41 4C 53 30 81 BF 30 40 04 10 APPORTALS0..0@.. 0050: 4D 65 6D 62 65 72 41 73 73 69 67 6E 6D 65 6E 74 MemberAssignment 0060: 31 2C 04 06 54 53 54 42 54 43 04 04 54 45 53 54 1,..TSTBTC..TEST 0070: 04 05 46 45 4C 53 4E 04 0B 4D 41 43 44 4F 4E 41 ..FELSN..MACDONA 0080: 4C 44 41 4C 04 08 6D 66 72 69 65 64 6D 61 30 2E LDAL..mfriedma0. 0090: 04 0B 6F 62 6A 65 63 74 43 6C 61 73 73 31 1F 04 ..objectClass1.. 00A0: 0C 67 72 6F 75 70 4F 66 4E 61 6D 65 73 04 0A 50 .groupOfNames..P 00B0: 6F 72 74 61 6C 52 6F 6C 65 04 03 74 6F 70 30 24 ortalRole..top0$ 00C0: 04 0B 64 65 73 63 72 69 70 74 69 6F 6E 31 15 04 ..description1.. 00D0: 13 42 61 74 63 68 20 41 64 6D 69 6E 69 73 74 72 .Batch Administr 00E0: 61 74 6F 72 30 25 04 02 63 6E 31 1F 04 1D 48 39 ator0%..cn1...H9 00F0: 43 43 4C 4E 54 38 30 30 5F 53 41 50 5F 42 43 5F CCLNT800_SAP_BC_ 0100: 42 41 54 43 48 5F 41 44 4D 49 4E BATCH_ADMIN <- p72201:389

3.9.2.3 SSL Debugging

You can trace SSL activities between the SAP J2EE Engine and the LDAP directory server by ac-tivating SSL debugging. This provides additional insight into processes such as the SSL hand-shake, encryption, etc.

Location After activation, all SSL traffic between the SAP J2EE Engine and the LDAP directory server is traced in the console_logs of the SAP J2EE Engine.

(De)activation To activate SSL debugging, you have to start the SAP J2EE Engine with the option –Dcom.sap.security.ssl.debug=true by adding the option in service.ini (if the J2EE Engine is started as an NT service) and restarting the SAP J2EE En-gine or with go.bat if the engine is started from the console.

The default output of the Java server now looks like this:


2004 SAP AG 107

3.9.2.4 LDAP Browser

The LDAP Browser/Editor allows users to view the items stored in an LDAP directory in a hierar-chical manner. It also allows modifications of the LDAP contents if the user is logged in as the Di-rectory Manager.

The LDAP objects are displayed in the form of a tree and all attributes of the entries in the form of a table.

The current status of the browser is displayed on the status bar. All status messages are displayed in black, warning messages in yellow and error messages in red.

The DN tree is expanded or collapsed by a double click on a node. With each selection change on a DN tree, attributes for the selected DN will be retrieved and displayed in the attribute table.

The attribute names and values displayed in the attribute table can be sorted in ascending order by clicking on the column names. To sort in descending order, hold the shift key down while click-ing on the column header.

To display pop-up menus over a tree or table select an entry or an attribute and then press the right mouse button.

Additional information: http://www-unix.mcs.anl.gov/~gawor/ldap/ or http://www.iit.edu/~gawojar/ldap/

3.9.3 R/3

3.9.3.1 Monitoring R/3 backend connections

To test a RFC link use sapinfo according to Note 42692. It is determined easily whether in princi-pal R/3 system via RFC is available from the calling machine (on which you installed an RFC-SDK available from Presentation CD or from service market place).

The same method could be used to check if some necessary and used by the Enterprise Portal function in R/3 is available. (See Note 34998).

RFC connection could be established directly to some R/3 server or to the message server, which will send the requests to some assigned to it R/3 server. In order to test the connection to a mes-sage server use lgst (Note 64015).

3.9.3.2 SAPJCo Trace

Java iViews that connect to an R/3 system via SAPGUI for Windows or SAPGUI for Java invoke the SAP Java connector (JCo) to place RFC calls. JCo activity can be recorded by triggering the JCo trace.

Name/location You can set the name and path of the trace with the Java environment parame-ter

-Djco.trace_path=<path>/<name>

If a trace path is set, the trace is written to the specified directory. Otherwise the trace is written to the standard output stream (default is the console). You must restart the SAP J2EE Engine to activate the trace.


2004 SAP AG 108

(De)activation The JCo trace can be turned on by setting the following Java environment pa-rameter:

-Djco.trace_level=N, where 0 ≤ N ≤ 5

Example:

java -Djco.trace_level=5 -Djco.trace_path=. jco_trace.log

Trace levels 0 ≤ N ≤ 5


See (De)activation.

Log size The JCo trace should be turned off after the tracing process because the logs are not overwritten after a given time or amount of data.

One log file is written for each connection to the target system. The number of connections depends on the application or service that issues the request.

Log backup Backups have to be made manually.

Relevant OSS notes

628962 How to switch on the SAP JCo trace

Activation of RFC in addition:

532918 RFC trace generation scenarios

Further Information:

The official JCo documentation JCo Tutorial.pdf can be found at \..\<JCo directory>\docs\jco. This documentation describes how to write a stack trace using the method ex.printStackTrace(); in your own coding.

You can define the JCo version with the DOS box command java -classpath \..\sapjco.jar com.sap.mw.jco.About –stdout.

You can receive more detailed information by setting the environment variable RFC_TRACE to 1. See Note 532918 for details on Generating RFC trace information or http://service.sap.com/connectors for more information regarding JCo.

4 Problem-oriented Troubleshooting

4.1 SAP J2EE Engine 6.20

This chapter deals with issues related to the SAPJ2EE Engine 6.20 that serves as the J2EE server of the Enterprise Portal 6.0. The central logs for the SAP J2EE Engine are the console_logs that have been described in detail in chapter 3.4.1. The logging mechanism of the HTTP service of the SAP J2EE Engine is the focus of chapter 3.4.3.

Relevant OSS notes

647662 SAP J2EE Engine 6.20: Road Map


2004 SAP AG 109

4.1.1 First Aid

In general, you can start with the following note to figure out whether an issue is related to the SAPJ2EE engine:

• 604564 Initial help for SAP J2EE problems in a WebAS 6.20 environment

Although note 604564 was not explicitly written for the Enterprise Portal 6.0, it contains pertinent information with respect to its troubleshooting.

4.1.1.1 URL Check

URL check: http://<ServerName>:<HTTP port of SAPJ2EE Engine>/

Run this check to see if the SAPJ2EE engine is up and running. The documentation page for the SAP J2EE Engine should be displayed (if the documentation is installed). Otherwise copy any HTML page to <J2EE directory>\docs\index.html. This page should be displayed when you call the above mentioned URL.

In case of problems, make sure the SAPJ2EE Engine is started. On Windows look for the dis-patcher.exe and java.exe process in the NT task manager (or two java.exe, if the dispatcher is also started via go.bat) and check the CPU usage of the processes. On Unix check whether the java processes for dispatcher and server are still available. Also verify the console_logs of dis-patcher and server (see chapter 3.4.1).

Typical Enterprise Portal error message:

SAP J2EE Engine server node is down:

4.1.2 Starting and stopping the SAPJ2EE Engine 620

There are different possibilities to start the SAPJ2EE Engine 620:


2004 SAP AG 110

1. via Unix daemon respectively Windows service (called SAP J2EE Engine Dispatcher)

2. via running the script go (go.bat on Windows) of the dispatcher

3. StartupFramework640 (available since PL19 – 70633.20)

Since PL19 SAP recommends to use the StartupFramework640. The advantages of the new StartupFramework are explained in the administration guide (<J2EE direc-tory>\docs\adminmanual.pdf - chapter Planning the Architecture of a Cluster / Cluster Startup) de-livered with the SAPJ2EE engine 620.

File <J2EE directory>\docs\startup.pdf contains the detailed installation guide for Unix and Win-dows.

Relevant OSS notes

701278 Location of Files for the Startup Framework for 6.20

696410 Java VM settings for EP6 on J2EE 6.20

(regarding –server option and StartupFramework640)

If you still stay with a patch level less than PL19 or want to use the other possibilities see the next chapters.

In SAP Enterprise Portal 6.0 installations, the SAPJ2EE Engine is normally started and stopped by the Windows service SAP J2EE Engine Dispatcher respectively Unix daemon. This means that the dispatcher node of the SAPJ2EE Engine is started. SAP delivers EP6.0 in a configuration that starts the server nodes of the SAPJ2EE Engine automatically using the r3startup service of the dispatcher (see chapter 4.1.2.1).

How to use Unix: Make sure you are logged on as operating system user j2eeadm and run the following commands for starting the engine

cd <J2EE directory>/configtool

./unixdaemon –start

To shut it down type in

cd <J2EE directory>/configtool

./unixdaemon –stop

Windows: start the Windows service SAP J2EE Engine Dispatcher

stop the Windows service SAP J2EE Engine Dispatcher

Relevant OSS notes

448151 In-Q-My application server as Windows service / Unix daemon

608533 How to get debug output from UnixDaemon or service.exe

659581 SAP J2EE Engine 6.20 - Error starting DBMS service (Unix)

For starting the SAPJ2EE Engine 620 dispatcher as Windows service or Unix daemon the con-figuration file service.ini is read. The configuration file for starting server nodes with r3startup ser-vice is <J2EE directory>\cluster\<server dir>\cmdline.properties (see chapters 4.1.2.1, 4.1.2.2 for more details).


2004 SAP AG 111

If you are having trouble starting the Windows service or Unix daemon and no obvious errors can be found in the console_logs (chapter 3.4.1), you can start the SAPJ2EE Engine with the go script in <J2EE directory>\cluster\dispatcher to see whether the issue is related to the service/daemon or the SAPJ2EE Engine itself.

Windows only: Run the go scripts in a command prompt window rather than double-clicking it in the Explorer. This way, the prompt will stay around even if the process dies.

If the SAPJ2EE Engine is started with the go script type in shutdown at the console prompt or just close the command prompt window to stop it.

If the issue seems to lie with the service but the file service.ini looks fine, uninstall and install the service again (chapter 4.1.2.3). If this does not help either, you can create additional debug infor-mation according to note 608533.

4.1.2.1 Files service.ini and cmdline.properties

The file service.ini is stored in folder <J2EE directory>\configtool. This file can be created or edited with the configtool (recommended!) or with any editor (e.g. notepad).

Mark the node cluster\dispatcher and check the Enabled checkbox for the NT Service respective Daemon for Unix and apply the changes.

For all server nodes cluster\server the Enabled checkbox for the NT Service/Unix daemon should not be checked since the servers are started by the dispatcher.


2004 SAP AG 112

The file service.ini therefore contains only information about the SAPJ2EE Engine dispatcher (ServiceCount=1). The root directory of the dispatcher (Service_0_RootDir), the path to the Java installation (Service_0_JavaPath) and the Java Virtual Machine options (Ser-vice_0_JavaParameters) etc.

For the server nodes of the SAPJ2EE Engine 620 you find the Java Virtual Machine options (JavaParameters) in file cmdline.properties. You have to edit this file if you want to change any JVM options of the server node.


2004 SAP AG 113

4.1.2.2 Configuring r3startup service

The configuration of the r3startup service of the SAPJ2EE Engine dispatcher could be done either with the configtool (recommended!) or editing the respective files. In the configtool select clus-ter/dispatcher -> services -> r3startup and set the Startup Mode to Always. This enables the dis-patcher to start server nodes. Set the Startup Mode to Manual if you want to startup the server node(s) in another way (with go scripts or with its own Windows service respectively with Unix daemon).

The dispatcher needs to know which server(s) it should start. Therefore properties are set in file <J2EE directory>\cluster\dispatcher\services\r3startup\properties. How many servers should be started by the dispatcher is set with property elements. For each server node two additional prop-erties have to be maintained. Property element_<no>_id holds the ClusterElementId of the server node (see cluster/server -> managers -> ClusterManager). If there is only one server to be started <no> is 0. For a second server add the property element_1_id etc. The second property for each server is element_<no>_dir and holds the value of the directory name of the server node.

The value for the startup mode is written to file <J2EE directory>\cluster\dispatcher\services\ r3startup\runtime.xml.


2004 SAP AG 114

4.1.2.3 Installing and uninstalling the Windows service SAP J2EE Engine Dispatcher

The command service is used to create or delete the service manually:

How to use Open a cmd prompt and issue the following command with the path set to <J2EE directory>\configtool:

service <-install | -remove>

-install Install the service

-remove Remove the service

Relevant OSS notes

448151 In-Q-My application server as windows service

608533 How to get debug output from UnixDaemon or service.exe


Java process does not start

If the java process does not start at all, make sure that the Java Virtual Ma-chine options are set properly. You can refer to the following URL for the syn-tax:

http://java.sun.com/docs/hotspot/VMOptions.html

Not all options for the SUN JVM are valid for other JVM vendors. But all Java Virtual Machine options are case sensitive. The option for the Java Type (e.g. –server) must be the first one in the line.


2004 SAP AG 115

Restrictions with IBM JDK for AIX

Notes 667711, 667841 refer to restrictions with AIX JDK 1.3.1

HP-UX: java.lang.OutOfMemoryError: unable to cre-ate new native thread

If you find this message In the console logfile of the server during startup it's because the UNIX kernel restricts the number of threads per process as well as the total number of threads. The solution is given in note 534867.

Check as well the chapter “Startup and Shutdown of the Portal Server” in document “Template for

SAP EP 6.0 Operations Manual” (http://service.sap.com/ep60howtoguides).

4.1.3 Upgrade

As with all software components of the Enterprise Portal, we recommend to keep the Java-related parts up-to-date too. These are:

1. SAPJ2EE Engine 6.20

2. Java Development Kit (JDK)

3. SAP Java Connector (SAP JCo)

4. Additional libraries

Please check as well the PAM -> OS -> DB (for PAM see chapter 4.8.1).

4.1.3.1 Upgrading SAPJ2EE Engine 6.20

Please refer to the following notes for a list of bugfixes and update procedure:

Relevant OSS notes

529088 Upgrading the SAP J2EE engine

604530 SAP J2EE Engine 6.20: List of fixes done in SP8-SP10

609463 SAP J2EE Engine 6.20: List of fixes done in SP11










2004 SAP AG 116

700864 Upgrade to SP19 or upper version from lower

700632 Central Note for DBMS service: fixes and updates since SP19

703421 SAP J2EE Engine 6.20: List of fixes done in PL20



4.1.3.2 Upgrading Java Development Kit (JDK)

We recommend running the latest patch level available for JDK 1.3.1. Do not use JDK1.4, how-ever, as the Enterprise Portal will not run with this release.

Relevant OSS notes

540264 Java installation for SAP J2EE Engine 6.20

575774 Installing a new JDK

481019 Java path should not contain spaces

4.1.3.3 Upgrading SAP Java Connector (SAP JCo)

SAP JCo is not upgraded automatically with the SAPJ2EE Engine. With the Enterprise Portal only version 2.0 of SAP JCo is supported.

You can down the latest available patch from SAP Service Marketplace:

http://service.sap.com/patches -> SAP Enterprise Portal -> SAP Enterprise Portal 6.0 -> Binary Patches -> SAP JCO 2.0 -> <operating system>

The packed file contains the whole SAP JCo documentation and demo coding. The only three files you need from the patch are

• sapjco.jar

- java archive containing SAP JCo's Java runtime classes

• librfccm.<os extension> respectively saplibrfc32.dll on Windows

- native RFC library used by JCo for handling remote function calls to and from an SAP Sys-tem

• libsapjcorfc. <os extension> respectively sapjcorfc.dll on Windows

- JNI runtime library containing SAP JCo's native code

On Unix run the commands

gunzip JCO20_<patchlevel>-xxxxxxxx.TGZ tar -xvf JCO20_<patchlevel>-xxxxxxxx.TGZ

to extract the content of the patch.

For Windows it’s a .ZIP file

Note: Stop the SAPJ2EE Engine before making any changes.


2004 SAP AG 117

sapjco.jar has to be replaced for every server node in folder <J2EE directory>\cluster\<server dir>\additional-lib.

The two new libraries replace the old files in folder <J2EE directory>\os_libs.

On Windows saplibrfc32.dll might be replaced in folder <windows dir>\system32 too.

Relevant OSS notes

608600 Upgrade of the SAP J2EE Engine 6.20- sapjco.jar not upgraded

549268 SAP JCO release and support strategy

336693 Replacing the librfc32.dll on a Win 32 Platform

4.1.3.4 Upgrading Additional libraries

You can find the Additional-Libs on the SAP Service Marketplace, Alias “patches” (http://service.sap.com/patches -> SAP Enterprise Portal -> SAP Enterprise Portal 6.0 -> Binary Patches -> SAP Basic Java Libs 6.20).

4.1.4 Out of memory

Two are the major issues concerning memory settings:

• Insufficient memory allocated due to an increase in resource consumption, resulting in an Out Of Memory failure: java.lang.OutOfMemoryError, java.lang.StackOverflowError

• An excess of allocated memory over the actual demand, resulting in a performance de-crease.

A java.lang.OutOfMemoryError is not a bug; it is a natural consequence of the fact that the arising data volume is more than the machine or the current settings can handle.

When an OutOfMemoryError is thrown by the SAP J2EE Engine or by the Enterprise Portal, you will find error messages like OutOfMemoryError and Out of memory in the console logs (chapter 3.4.1Error! Reference source not found.). According to SUN the system state after an OutOf-MemoryError is unpredictable and a restart of the affected system is recommended. Therefore it is vital to know when and why this problem occurs and how to prevent it.

Please see OSS note 634689 which describes different scenarios of OutOfMemory situations to-gether with the recommended actions.


Relevant OSS notes

CSN note 634689 is an entry point for all known issues related to memory fail-ures.

Several other notes for specific memory issues are referenced in this note.


2004 SAP AG 118

4.1.5 DBMS issue during startup

One may receive various errors in dbms area and as a result the engine could not start. In many cases the java –server option causes dbms corruptions. So the first step is to remove this option from the configuration files (go scripts, cmdline.properties, service.ini, configuration files for Start-upFramework – see chapter 4.1.2).

The easiest way to come across this issue is to restore the dbms files back from a recently made backup. The dbms files are stored in <J2EE directory>\cluster\<server dir>\services\dbms\work.

If you have no backup available you normally have to build up your portal installation from scratch.

Fortunately a workaround is available. It is described in note 703570. In addition to this note you have to apply note 706216 too since the application clearing tool used in note 703570 deletes also the database pools needed for EP6.

Relevant OSS notes

703570 Avoiding redeploying from scratch after corruption of DBMS

706216 Creating Portal and MetaMatrix DB Pool and EISConnectors

4.1.6 Page cannot be displayed (or only parts are displayed)

The Microsoft Internet Explorer sometimes throws a Page cannot be displayed message without any obvious reason, or it displays the HTTP response page only partially. It might even revert to a page displayed previously, or return a broken HTML page. Clicking Refresh helps in some cases.

Since this is a very generic issue several scenarios can lead to these symptoms. We collected the known issues in central note 634691.


Relevant OSS notes

CSN note 634691 is an entry point for all currently known issues related to this error message.

Several other notes are referenced from here.

4.1.7 Configuration check

In a complex SAPJ2EE engine 620 installation with multiple dispatcher and server nodes even spread over multiple servers it is hard to keep the nodes identical configured.

This includes two levels:

1. Settings for the SAPJ2EE engine 620 nodes itself (Java memory parameters, properties) as describes in the next chapter 4.1.8.

2. Keeping the deployed applications in sync.

Regarding the first point SAP developed a Configuration Check Tool (-> use the search func-tionality in the SDN -> http://sdn.sap.com).

For the second point SAPJ2EE engine 620 provides already the needed functionality. The deploy service of SAPJ2EE engine 620 keeps a version number for each deployed applica-tion which changes with every deployment or synchronization.


2004 SAP AG 119

If a server node joins a cluster this version number is compared with the one of the primary server node (since PL21 this is the State Controller or Backup State Controller). Only if the numbers dif-fer the whole folder of this application (<J2EE directory>\cluster\<server dir>\services\servlet_jsp\work\jspTemp\<application>) is zipped on the primary server and copied to the joining server node where it is unzipped again. If different primary servers exist the first started gets contacted.

This means that manual changes in the filesystem below the application folder are not visible to the engine and therefore are not automatically distributed to other server nodes.

So to get applications in sync it is possible to just delete the application(s) on the server node which should be synched. To do so SAP delivers the tool Appclear (<J2EE direc-tory>\cluster\<server dir>). For more details to this tool please see the administration guide (<J2EE directory>\docs\adminmanual.pdf).

Before running tool appclear please shutdown the concerned server node. Next time this node joins the cluster the applications are copied as already explained above.

4.1.8 Improvement of Performance and Stability

The settings of the Java VM parameters and properties of SAPJ2EE engine 620 can improve the performance and stability of the application server.

The Guide “How to…Fine-Tune Performance of Enterprise Portal 6.0” describes how to con-figure JVM settings for SAP J2EE Engine. It can be found in the SAP Service Marketplace (http://service.sap.com/ep60howtoguides) or in the SDN (http://sdn.sap.com à use the search function).

The note 696410 Java VM settings for EP6 on J2EE 6.20 gives information about the latest rec-ommended settings.

Relevant OSS notes

696410 Java VM settings for EP6 on J2EE 6.20

492222 SAP Software on UNIX

534867, 590984 for HP UX configuration

667841, 667711 for AIX configuration

552522 Java Hotspot VM Memory Parameters

634689 Central Note for Memory Issues, SAP J2EE Engine 6.20

684884 Java process crashes when using the Configuration UI

690839 Forcing Java VM to create core dumps after memory corruption

690841 Analyzing Sun VM Hotspot Crash IDs

691944 Analyzing potential JIT errors for the Sun Java VM

698100 Analyzing Java VM crashes based on JNI misuse

More documentation/training material can be found in the following guides:

IBM diagnostic guide: http://www-106.ibm.com/developerworks/java/jdk/diagnosis/diag131rev1.pdf

Solaris 8 Tunable Parameters Reference Manual: http://docs.sun.com/db/doc/806-6779/6jfmsfr7j

Java HotSpot VM Options: http://java.sun.com/docs/hotspot/VMOptions.html

How to tune Garbage collection on JVM 1.3.1: http://java.sun.com/docs/hotspot/gc/index.html

Big Heaps and Intimate Shared Memory (ISM): http://java.sun.com/docs/hotspot/ism.html

HP Java home: http://www.hp.com/go/java


2004 SAP AG 120

HP-UX Patches required for Java: http://www.hp.com/products1/unix/java/patches/index.html

4.2 PCD

The PCD GL (Generic Layer) API serves as an abstraction layer between the persistence and the application objects in the portal. Being an API, the PCD GL is used by many applications in many different ways. This means that not all problems that occur in the PCD are really “PCD” problems.

If at all possible, if a problems appears to be a PCD problem, the application calling the PCD GL API should be checked first, for example if an application tries to create two objects with the same name in the same folder, a NamingException will be thrown by the PCD GL.

Relevant OSS notes

588904 EP 6.0: Central note for Portal Content Directory (PCD)

4.2.1 PCD related problem or UME related problem?

The User Management Engine (UME) connects to the PCD using a “persistence adapter” infra-structure. As a result of this architecture there might be misunderstandings, if a problem is PCD related or UME related.

Problems with role creation, content, etc. are PCD problems, because the PCD owns role exis-tence and role content.

Problems with role-user assignment are UME problems, because UME mainly owns role-user assignment.

4.2.2 Pre-Check

Before looking specifically into the PCD for problems, check that

• JAVA VM is running fine (server processes are not blocked, memory not exhausted, gar-bage collector logs)

• Database and UME are initialized correctly, database connections are working (check the console/portal.log for errors during server startup, check whether the database has blocked connections open)

• Database connections: J2EE server console -> add dbpool -> get_pools to get the pool name (sapep is the default); with list_conn <poolname>, you can get the open db connec-tions

• No other applications are blocking database connections or other resources (again, server processes, memory)

• Client side problems (javascript): clear server and browser caches

4.2.3 Problem categories

“PCD”-problems can be categorized into

• Basis (PCD Generic Layer) problems

o Initialization of the PCD GL service

o Basic Transport problems

o Locking

o Cache

o Database


2004 SAP AG 121

• Performance problems

o Search

• Permission problems

o PermissionControlExceptions

• Other problem categories

o Transport of portal objects

o Problems occurring in applications using the PCD GL API

§ Admin Environment

§ PCM API

o Import of EP5 content

4.2.3.1 Basis (PCD GL) Problems

• Initialization of the PCD GL service

o Logger: portal_logger / pcd_logger

o Default location of log files: \..\WEB-INF\portal\logs\portal.log and pcd.log

• Basic Transport

o Logger: transport_logger

o Default location of log file: WEB-INF\portal\logs\transport.log

• Locking

o Loss of locks could be due to lock expiry - not a bug, but a feature, timeout can be configured in the PCD configuration tool (-> chapter 3.5.2.1)

o Hanging locks can be unlocked with the Object locking tool (-> chapter 3.5.2.3).

• Cache

o No tool for investigating cache (yet); cache trace will provide information about ob-jects retrieved from cache, but no statistics, etc.

o In the PCD Administration tool (-> chapter 3.5.2.2), you can clear the PCD cache in order to check whether a problem is caused by the cache, but be careful in a productive system (performance)

• Database

o Use PCD trace for database (-> chapter 3.5.2.1)

o Use database tools to check (needs specific DB knowledge) (-> chapter 3.9)

4.2.3.2 Performance Problems

• Search

o Depending on the search criteria and the number of returned objects, search can be quite slow (example: search for all roles in User Administration UI).

o For common search queries, optimization was done by introducing the “Database” search. The search trace will inform you whether a DB search was done for the query.

o If the search is still too slow, look at the search traces, if the query is big, then long response times are no bug.

• Import

o Notification can take a long time when objects are changed that have a lot of de-pendent objects (see note 644626).


2004 SAP AG 122

4.2.3.3 Permission Problems

PermissionControlExceptions

• “Protecting” the wrong folders (system folders) via ACLs can make the system inoperative

o In this case, try to switch off ACL checks (Parameter “Pcd.Gl.PermissionCheck” to “false”) in the PCD config tool (-> chapter 3.5.2.1) and see whether the portal works again, maintain the affected folder ACLs and switch ACL checks on again; alternatively, activate sap* user

• Trying to access the PCD without providing a security principal will result in meaningful log messages

• If the specific user doesn’t have the proper ACLs, then the PermissionControlException is not a fault

• Failed permission checks are logged into the pcd_logger (with log level “INFO”) (-> chap-ter 3.2.4)

• Note that overwriting ACLs on an object will override ALL permissions from the parent (no “enrichment”, but replacement)

• Tool to display permissions: com.sap.portal.pcd.admintools.permissions.default (-> chapter 3.5.2.3)

4.2.3.4 Permission and Roles

If the user should have permissions (because he/she got the object through a role), check whether the ACLs are set properly

• Roles have a special feature “Extended ACL checks” which rely on automatically gener-ated ACLs (starting with SP2).

• These permissions are not visible in the ACL editor and they don’t follow ACL inheritance rules (the “normal” ACL inheritance is not affected, of course).

• Generation is done through event listeners, check notification traces (success messages are also written).

• Permission list tool should be able to display them soon (-> chapter 3.5.2.3).

4.2.3.5 Import of EP5 content

• Import is “self-logging” - a log will be written for each import

• In the Pcd Configuration Tool (-> chapter 3.5.2.1) there is a separate section for the con-tent migration:

############################################################################

# Content Migration Application

############################################################################

# Root directory of the temporary Pcd 5.0 (file system based Pcd)

Pcd.Migration.TempPcdRootDirectory=C:\\_EP6\\temppcd

# Directory in which the content migration logs should be stored

Pcd.Migration.ContentMigrationLogDirectory=C:\\_EP6\\logs

# Debug level in the Migration Protocol (default value false)

Pcd.Migration.Debug = true


2004 SAP AG 123

# Path to the Mapping property file

# Pcd.Migration.Path.Mapfile = ${Pcd.Share}/Migration/mapping/cms_mapping.properties

# Log into an Xml file (true= Xml, false=HTML, default value false)

# Pcd.Migration.XmlLogger = true

# Write a status Xml log for each migration object in a separate Xml file (de-fault = false)

Pcd.Migration.XmlObjectStatusLog = true

• If debug mode is true, a detailed process log is created. Additionally a memory log will be written.

• User needs file system read/write permissions for import of content, files must not be write protected

• In the case of import problems please re-import the package with debug = true and pro-vide the detailed log file. If possible also include the .epa file.

• Additional information: note 627570 (released internally)

• Path length problem under windows: make sure the Pcd.Migration.TempPcdRootDirectory path is not too long

• Root path is also used for upgrade: you need to copy the EP5.0 PCD to this location

• Mapping file: consult note 642999 (file changed between SP1 and SP2) if objects in Busi-ness Packages don‘t work

4.2.3.6 JavaScript errors

Strange popup: “A Runtime Error has occurred. Do you wish to Debug? Line …, Error: …”

If this popup appears, the problem is related to client-side scripting.

Click “Yes” and attach the shown JS-function to the problem message (this requires that a script debugger in installed):


2004 SAP AG 124

4.2.4 Important files and logs to attach to OSS-Message

In case you have a problem, that cannot solved by yourself and you have to open an OSS mes-sage, it would speed up the message handling, if the following files are attached:

• PCD Filesystem configuration: Location: \..\WEB-INF\portal\system\properties\pcd.properties

• PCD Configuration: Location: \..\WEB-INF\portal\system\pcd\pcdStartup.installer.properties

• Logfiles (default folder): Location: \..\WEB-INF\portal\logs

• Import of EP 5.0 content (default folder) Location: \..\WEB-INF\portal\system\pcd\Migration\logs

• Import of EP 5.0 content: attach .epa file if possible for easier reproduction from SAP side.

When attaching log files to an OSS-Message, try to send only the relevant part (for example, all entries of the last five minutes).

4.3 DB

Under http://service.sap.com/db you can find documentation on the supported DBs for EP6.0.

Information about the Startup and Shutdown of ORACLE / MS SQL DB can be found in the Guide “Template for SAP EP 6.0 Operations Manual” (http://service.sap.com/ep60howtoguides).


2004 SAP AG 125

4.3.1 Portal is hanging since DB is not responding

The Enterprise Portal application or the J2EE Engine itself is hanging because the database does not respond.

• The Portal might execute an SQL statement which lasts extremely long.

• There might be a database deadlock or the database is in an erroneous state.

This can be checked with a full thread dump (-> chapter 3.4.5)

4.4 UME

4.4.1 LDAP Issues

If you use an LDAP as data source with the User Management Engine (UME4.0) in EP6.0 SP2 you should have in mind some comments, recommendations and restrictions.

4.4.1.1 Caching

The LDAP Persistence Adapter uses a short term none-distributable cache. That means that in a clustered environment, every cluster has its own cache and no notification about updates in the cache are send to another cluster node. The cache is used to hold different search request and results on the directory server and existence checks for different objects. It is not possible to in-validate the complete cache or single entries from outside. The cache has a default lifetime for each entry of 5 minutes and a maximum size of 100 entries, if nothing is specified in the UME con-figuration. The cache is also invalidated if an object on the directory server is updated, created or deleted. You have the possibility to change this cache configuration with two properties that have to be added to the sapum.properties file. This can be done up to EP6.0 SP2.

The first one defines the lifetime of the cache entries in seconds. ume.ldap.cache_lifetime=<xxxx>

The second one defines the size cache. ume.ldap.cache_size=<yyyy>

Using this cache can lead to problems if you change data directly in the directory server, that has been read before. It could be that you have to wait some time, before the user management rec-ognizes the new or changed data. This is also the case if some data that has been read before is changed on another cluster node. You will have to wait up to the cache life time (the default is 5 minutes) until the caches are updated with the correct data again.

We recommend reducing the cache life time if data is changed very often on the directory server and if you want to see the changes immediately. Reducing the cache life time has some impacts on the performance as during the logon some searches are cached that are done more than once.

4.4.1.2 LDAP search uses non-indexed attributes

You may encounter bad performance in the Permission Editor tool due to the fact that the search filter used for searching users contains attributes that are not indexed in your LDAP server.


2004 SAP AG 126

The default search filter used for searching users in the Permission Editor looks like this:

(&(objectclass=InetOrgPerson)(|(displayname=Sam*)(uid=Sam*) ))

Solution: Create an index on attribute displayname

You may also encounter bad performance or a time out in the Role Assignment iview when searching for groups. The default search filter uses also the description to find groups.

For example:(&(objectclass=group)(|(cn=*)(description=*))) In general the description is not in-dexed.

Solution: Create a substring index on the attribute description or configure the Role As-signment Iview not to use the description when searching for groups as described in the official documentation.


673824 LDAP Issues for UME40

4.4.2 Important files and logs to attach to OSS-Message

In case you have a problem, that cannot be solved by yourself and you have to open an OSS message, it would speed up the message handling, if the following files are attached:

• PCD Filesystem configuration: Location: \..\WEB-INF\portal\system\properties\pcd.properties

4.5 Single Sign On

A detailed documentation on Single Sign-On can be found in the SAP Enterprise Portal Security Guide (http://service.sap.com/securityguide), Chapter “Single Sign On”.

4.5.1 Single Sign-On with SAP Logon Tickets


701205 EP6.0: Single Sign On using SAP Logon Tickets

177895 Refitting the mySAP.com Single Sign-On capability

495911 Trace analysis for logon problems

654326 Domain restrictions in a portal environment

677118 SP31-> Fully Qualified Domain Names Check

654982 URL requirements due to Internet standards


2004 SAP AG 127

4.5.1.1 R/3 Configuration

Import of cer-

tificate into R/3

As a prerequisite for SSO to SAP Systems, you need to import the certificate of the Portal to the SAP System using the transaction STRUSTSSO2. Moreover, the certificate needs to be imported to the Single Sign-On ACL. The WPS Sys-tem of the Single Sign-On ACL must match the System ID of the MYSAPSSO2 cookie. The System ID is a three letters uppercase ID for the Portal. It can be specified in the sapum.properties using the parameter login.ticket_issuer (e.g. login.ticket_issuer=EP6). You can edit this value in the UM Configuration under Direct Editing. The WPS Client is a three digits client identifier of the Portal. It must match the Client of the MYSAPSSO2 Cookie. You can maintain the value in the sapum.properties using the parameter login.ticket_client (e.g. login.ticket_client=000).

R/3 Parameters Make sure that the SAP System is maintained to accept SSO2 Tickets (Pa-rameters login/accept_sso2_ticket, login/create_sso2_ticket).

Select every instance profile for the following settings:

• login/accept_sso2_ticket=1

• login/create_sso2_ticket=0

• SAPSECULIB must point to the library file itself (Release 4.0 and 4.5)

SAP Security Library

Check whether the SAPSECULIB is up-to-date (see also note 177895). This library is required to verify the digital signature of the ticket issuer. It is down-wards compatible. You can download the most recent version for your operat-ing system from one of the sapserv servers:

/../general/misc/security/SAPSECU/<platform> You can determine the version by calling transaction sso2 and entering 'NONE' (Upper Case!) in the field 'RFC Destination'. The 'SECUDE(tm) Version' at the end of the list gives you the ver-sion (works only for 4.6C or higher).

Maintenance of ACL

Was table TWPSSO2ACL maintained? This is done automatically if transaction strustsso2 is used.


2004 SAP AG 128

Compare en-tries in strust and TWPSSO2ACL

You can create a security trace to find out more about the ticket and certificate handling within R/3 and identify possible reasons of failure (see Note 495911). Make sure the R/3 system is not ex-periencing a heavy load when you carry out the following operations:

• Run transaction sm50 (this example shows a 4.6D system) and select some of the first work processes listed.

• Raise the trace level for the Security component to 2:


2004 SAP AG 129

• Log on to the portal and try to access your R/3 system again.

• Select the trace files of the work processes that you selected (place the cursor on a line and select Process -> Trace -> Display file):


2004 SAP AG 130

4.5.1.2 Portal Configuration

UserID Please ensure that the UserID is the same in the R/3 and the portal if you are not using User Mapping.

Logon Tickets for multiple domains

The SSO2 Ticket is sent to Web Access Points (e.g. WAS, ITS) via the MYSAPSSO2 cookie. Thus the Portal and the Web Access Points have to re-side in the same domain. Using SSO with SAP Logon Tickets for multiple do-mains, please check the document “How to…Perform Cross Domain Single Sign-On with SAP Logon Tickets” (http://service.sap.com/ep60howtoguides). You can use domain relaxing, if the domains differ only in a subdomain name. You can specify the number of subdomains to be cut from the Portal host name using the parameter ume.logon.security.relax_domain.level in the sa-pum.properties (under Direct Editing in the UM Configuration). E.g., you have portal.wdf.sap.com as portal host and specify ume.logon.security.relax_domain.level=2, then the MYSAPSSO2 Cookie is sent to all servers within the domain sap.com (for domain issues see also note 654326).

Fully qualified domain name

Please ensure that you use the fully qualified name of the Web Access Points (e.g. ITS, WAS) in the System Configuration, and that you call the portal with the fully qualified domain name in the address field of the browser.

MYSAPSSO Cookie

You can check whether the MYSAPSSO2 Cookie is issued properly by prompt-ing in the browser for per sessions cookies. If you are using SP1 or SP2 you can use the attached Portal Component (attachted to note 701205) to display the properties of the MYSAPSSO2 cookie and to verify the digital signature.

• Internet Explorer 5.x: Select Tools -> Internet options -> Security. Choose the correct security zone for the portal according to your land-scape setup. Navigate to Custom level -> Cookies -> Allow per session cookies and select Prompt.


2004 SAP AG 131

• Internet Explorer 6.x: Cookie handling under Tools -> Internet Options changed with IE 6.x. There is a new tab called Privacy where you can override the cookie handling for certain sites to make the browser prompt for (and show) the cookie. Make sure that Override automatic cookie handling is marked under the Advanced options and that all pa-rameters are set to Prompt. Edit the Web sites in the relevant section and make sure that the portal website is not listed with the managed websites. Because cookie handling only applies to the Internet zone and the current zone for the portal might be set to Intranet; you might have to modify the zone setting as well. Go to the Security tab -> Local intranet -> Sites. Make sure that all parameters are unmarked. This will place all intranet addresses in the internet zone.

You should then be prompted for the cookie if it is issued properly. You can also see which domain it was issued for. This cookie is only valid within its do-main and will only be accepted by applications (ITS, WAS etc.) that are located there.

Check log file Check for any error in \..\irj\root\WEB-INF\portal\logs\usermanagement.log.


Digital signa-ture incorrect

Error message 2W 002 indicates this error, see Note 497321.

4.5.2 Single Sign-On with User ID and Password

This type of Single Sign-On is easier to implement and configure than the SAPLOGONTICKETS approach, but you should be aware of the fact that Single Sign-On with SAP logon tickets or with client certificates is recommended by SAP for security reasons.


2004 SAP AG 132

For troubleshooting SSO with user ID (UID) and password, refer to the log files mentioned in chapter 4.5.1:

• Usermanagement.log (-> chapter 3.6.5.1)

• R/3 security traces

• Java console logs (-> chapter 3.4.1)

4.5.3 FAQ Single Sign On

For further information you can have a look at the FAQ-List for Single Sign On in the SAP Service Marketplace (http://service.sap.com/netweaver -> SAP Netweaver in detail -> Security -> FAQ -> FAQ Single Sign On).

4.6 Secure Communication

There are two secure communication protocols that could be used for data encryption: Secure Sockets Layer (SSL), which secures HTTP and Secure Network Communications (SNC), which secures RFC.

Communication channels between internal Enterprise Portal components:

This diagram displays a secure network architecture where a Web server is placed in a demilita-rized zone (DMZ) in front of the Portal Server. It is also possible to have a network architecture in which the client communicates directly with the Portal Server.


2004 SAP AG 133

Communication channels between Enterprise Portal components and SAP Systems:

For detailed information on the configuration of Secure Communications, you can have a look at the SAP Enterprise Portal 6.0 Security Guide. You can find the Securityguide in the SAP Service Marketplace, Alias “securityguide” (http://service.sap.com/securityguide).

4.6.1 SSL Troubleshooting

Document Name Location

Configuring the Use of SSL on the SAP J2EE Engine

SAP Library -> SAP NetWeaver -> SAP Web Application Server -> SAP Web Application Server 6.20 -> SAP Web Application Server -> SAP J2EE Engine -> Integration of the Security Functions of SAP Web Application Server and SAP J2EE Engine -> Configuring the Use of SSL on the SAP J2EE Engine

Or

http://service.sap.com/security -> Security in Detail -> Secure System Management -> Con-figuring the Use of SSL on the SAP J2EE En-gine.

SAPJ2EE Engine SSL Installation Guide <SAP_J2EE_Engine_installation_directory> \tools\lib\IIS_module\ssl\ SAPJ2EE_Engine_SSL_installation_guide.doc


2004 SAP AG 134

Configuring the Use of Client Certificates for Authentication

SAP Library -> SAP NetWeaver -> SAP Web Application Server -> SAP Web Application Server 6.20 -> SAP Web Application Server -> SAP J2EE Engine -> Integration of the Security Functions of SAP Web Application Server and SAP J2EE Engine -> Configuring the Use of SSL on the SAP J2EE Engine -> Configuring the Use of Client Certificates for Authentication

Using SSL With an Intermediary Server SAP Library -> SAP NetWeaver -> SAP Web Application Server -> SAP Web Application Server 6.20 -> SAP Web Application Server -> SAP J2EE Engine -> Integration of the Security Functions of SAP Web Application Server and SAP J2EE Engine -> Configuring the Use of SSL on the SAP J2EE Engine -> Using SSL With an Intermediary Server

Configuring User Management Service for SSL to an LDAP Directory

Security Guide (http://service.sap.com/securityguide) -> Chap-ter “Configuring User Management Service for SSL to an LDAP Directory”.

4.6.1.1 SAPJ2EE Engine

If you encounter problems with SSL for SAP Enterprise Portal, make sure the secure communica-tion to the SAP J2EE Engine works correctly on its own without any portal. A simple URL check should prove if the SAP J2EE Engine is set up properly for SSL:

https://<PortalServer>:<J2EESecurePort>/index.html

This should display the documentation page of the SAP J2EE Engine if the documentation is installed. If the documentation is not installed, copy any html page to <J2EE directory>\docs\. This page is displayed when the above-mentioned URL is called.


2004 SAP AG 135

If this URL check fails, look at the SAP J2EE Engine console logs (chapter 3.4.1). Make sure that the services keystore and ssl are loaded and running. Their startup mode is defined in the J2EE configtool (should be set to always).

If any of these services fails to load, make sure that the required cryptographic software is copied to the following locations and that these archives exist only(!) there (see also Note 540946):

• <J2EE directory>\cluster\dispatcher\additional-lib must contain iaik_jce.jar, iaik_jsse.jar, iaik_ssl.jar and w3c_http.jar

• <J2EE directory>\cluster\server\additional-lib must contain iaik_jce.jar, iaik_jsse.jar, iaik_ssl.jar and w3c_http.jar

• <J2EE directory>\admin\lib must contain iaik_jce.jar, iaik_jsse.jar and iaik_ssl.jar

The following references must be set in

<J2EE directory>\cluster\dispatcher\managers\reference.txt and

<J2EE directory>\cluster\server\managers\reference.txt:

• reference irj library:IAIKSecurity

• reference irj library:jsse

• reference irj library:jcert

• reference irj library:jnet

4.6.1.1.1 Check Certificate

Error messages like invalid signature indicate that there are problems with the certificate itself. You can view details of the certificate in the SAP J2EE administrator console. Navigate to the key-store service (Runtime - Keystore Admin) and scroll down in the info window to find important de-tails like the CA that signed the certificate (make sure you do not to use a self-signed certificate) or its validity. It is very important that the subject contains the fully-qualified domain name of the J2EE server as CN.


2004 SAP AG 136

4.6.1.1.2 Check SSL Service

You also have to assign the certificate to the new and active sockets in the J2EE administrator console. You only get a new tab named Trusted Certificates after you have done this. A checkbox Require certificate authentication appears there. It should not be selected. When you deselect this option, make sure you do this for both new and active sockets, and be aware that this also needs to be done for both ports under active sockets.

If the box is selected, you typically run into an error message like:

Failed to send the URL:

https://<host>:<port>/irj/servlet/prt/prtroot/InitialLogonSupport.default?IntegrityToken=20021219230542LxdH8SaGMdsRnS7Mz0mtzHa85O1Qvgf9&URL=

Error Number: -2147012852

Error Description: A certificate is required to complete client authentication


2004 SAP AG 137

Note: This part of the ssl administrator was modified and renamed with Service Pack 10 of the SAP J2EE Engine 6.20. In newer versions, this tab is named Client Authentication and it contains a radio button Do not request client certificate, which should be selected.

4.6.1.2 SSL between Portal Server and LDAP

The steps for configuring an SSL connection between SAP J2EE Engine and the LDAP directories are described in the SAP Enterprise Portal Security Guide.

• Compare the LDAP secure port defined in your LDAP with the port specified in file reposi-tory_configuration_ldap.xml and in the user management configuration in the portal:

• Make sure the certificate path is defined correctly. The path must include the file name of the certificate itself.

• Was the directory server set up for SSL? Do you get a security pop-up and are you able to view the directory server’s certificate when the following URL is called?

https://<DirectoryServer>:<LDAPSecurePort>

Make sure that you always use the fully-qualified domain name of the server. Note: This only works from a client where the certificate was not yet installed.


2004 SAP AG 138

Use the following logs and traces to troubleshoot the secure connection between SAP Enterprise Portal and the LDAP directory server after you made sure that the directory server is SSL-enabled:

• Usermanagement.log (-> chapter 3.6.5.1)

• LDAP Tracer (-> chapter 3.9.2.1)

• SSL Debugging (-> chapter 3.9.2.3)

4.6.2 SNC Troubleshooting

If you experience problems with the SNC connection, do the following:

• Check whether the SECUDIR environment variable is set correctly.

• If you have SECUDE PSE management on the computer, log off (otherwise the two creden-tials may interfere with each other).

• Check that you created credentials for the correct user.

• Set the TRACE option for the JCo connection by entering the following in the UME properties file, sapum.properties:

ume.r3.connection.<adapterID>.trace=1

The RFC layer will then create log files called dev_rfc.trc and rfc_XXXXX_XXXXX.trc (where X denotes a digit).

For further information on how to set up an SNC Configuration between User Management En-gine and SAP System please have a look at the SAP Enterprise Portal 6.0 Security Guide in the SAP Service Marketplace, Alias “securityguide” (http://service.sap.com/securityguide).

Moreover you can information on SNC Configuration in the SNC User´s Guide in the SAP Service Marketplace, Alias “security” (http://service.sap.com/security) -> Security in Detail -> Secure Sys-tem Management -> SNC User´s Guide.


2004 SAP AG 139

4.7 Knowledge Management

4.7.1 CM Database related issues

One of the most frequently occurring problems in CM is the database connection issue. If the is-sue occurs, an error message like “Failed to connect to CM database” or “jdbc.ConnectionPools - connection refused” will be displayed in the portal when accessing some cm-relevant iview. After verifying that the DB server and DB services are running, you should go through the following paragraphs, which describe the possible reasons and solutions for this issue.

4.7.1.1 Wrong configuration in config_local.properties

Background The Content Management Configuration Property File config_local.properties defines the address of the database server, systemID of the CM database, da-tabase port etc. These entries are used for the JDBC connection pools to con-nect to the CM database. Therefore, a wrong configuration of the entries in the config_local.properties file can lead to the database connection error.

Path The config_local.properties file can be found under: usr/sap/<instanceName>/j2ee/j2ee_<instanceNumber>/cluster/server/services/servlet_jsp/work/jspTemp/irj/root/WEB-INF/portal/portalapps/com.sap.km.application/lib

Check Verify that the database name is maintained correctly. In config_local.properties the parameter dbsid (see below) should be entered correctly (default is WCM). The parameter dbsid defines the CM database name for MSSQL and for Ora-cle it defines the DB SID.

After any change in the config_local.properties you need to restart the SAP J2EE Engine.

Relevant OSS notes

687576 Connection to CM database


2004 SAP AG 140

4.7.1.2 Wrong Username/Password Setting for the Connection Pools

Background The username and password set for the connection pools will be checked when the pools connect to the database. Therefore, the CM database user-name/password have to be correctly entered when configuring a connection pool. With wrong username/password the CM database cannot be connected.

Path System Administration -> System Configuration -> Knowledge Management ->

Configuration -> Content Management -> Utilities -> JDBC Connection pools -> Connection Pools

Check Follow the path and check the maintained database username/password for the connection pools. For EP60 the default user is SAPWCM. (See below).

In case you are not sure if the maintained username and password for the con-nection pools are correct, you can check them by trying to log on to the Query-Analyzer for MSSQL or the Enterprise Manager Console for ORACLE with the username and password. See the note 687576 for detail.

If you forgot the password, you can set a new password for the CM Database user in the Enterprise Manager. See the note 687576 for detail. Use this new password for all connection pools.

After any changes at this point you are required to restart the SAP J2EE En-gine.

Relevant OSS notes

687576 Connection to CM database

4.7.1.3 Property Files of Connection pools

Background The property files of the connection pools, usually named dbcon_<poolname>.xml, define the configuration of the connection pools. The


2004 SAP AG 141

property files are used by the servlet engine to connect the CM database and they should reside in a specific folder.

Path ../usr/sap/<instanceName>/global/config/cm/config/local/data/cm/utilities/connection_pools

Check If you cannot see the connection pools in the portal under System Administra-tion -> System Configuration -> Knowledge Management -> Configuration -> Content Management -> Utilities -> JDBC Connection pools -> Connection Pools, you can check whether the property files dbcon_<poolname>.xml reside in the correct folder.

4.7.1.4 Maximum Number of Processes Exceeded (Oracle specific)

If a large number of connections are open to the CM database, the maximum number of proc-esses is exceeded, and a new connection to the DB cannot be opened.

In this case you need to change the settings for the number of processes for the Oracle database specified in the initialization file. The initialization file usually is of the form init<%SID%>.ora, which generally resides in .../oracle/ora81/database folder. Open the initialization file and go to the entry:

PROCESSES = <NUMERIC_VALUE> where <NUMERIC_VALUE> by default is 80. You can change this value to a higher value. After changing the PROCESSES value, you need to change the entry SESSIONS in the same file as well. The value of SESSIONS should be 1.2 times the value of PROCESSES. E.g. processes = 200, then sessions = 240.

For the changes to take effect, you need to restart the database. After that you need to restart the servlet engine as well.

Relevant OSS Note 539755 ORACLE-ERROR: Maximum Number of Processes(80) Exceeded

4.8 Miscellaneous

4.8.1 Platform Availability Matrix (PAM)

If you would like to know, if a new feature is available or if a new platform is supported etc. you can have a look at the Platform Availability Matrix (PAM).

You can find the PAM in the SAP Service Marketplace, Alias “pam60”

(http://service.sap.com/pam60).

4.8.2 Sizing

If you need information about the Sizing you can have a first look at the QUICKSIZER. You can find the Quicksizer in the SAP Service Marketplace, Alias “quicksizer”

(http://service.sap.com/quicksizer).

For EP6.0 SP2 Hardware Requirements you can find more information in note 681704.

Moreover there is the How-to-Guide “How to Perform Initial Sizing of SAP Enterprise Portal 6.0”, which can be found in the SAP Service Marketplace, Alias “ep60howtoguides”.

(http://service.sap.com/ep60howtoguides).

At any rate you should contact your Hardware Implementation Partner for the Sizing.


2004 SAP AG 142

4.8.3 Portal Development Kit

You can find the Portal Development Kit from the SAP iViewStudio (www.iviewstudio.com

-> content catalog -> specialists -> other).

5 Appendix

5.1 Remote Access

One prerequisite for supporting SAP Enterprise Portal is remote connectivity. SAP Support needs to be able to access the customer system remotely via a service connection. Remote Support within SAP always uses SAPRouter due to firewall restrictions. SAPRouter is a proxy server that controls relaying of SAPProtocol or TCP/IP connections between SAPRouter hosts and com-puters. All connections from SAP to customers are currently handled by SAPRouter hosts:

The application sharing tools that are currently supported are NetMeeting, Telnet and pcAny-where. HTTP-Connect, a new connection type, is in preparation. For remote access, you must set up and open the relevant service connection to the SAP Enterprise Portal host in SAPNet R/3 frontend or Service Marketplace. You can find further information in the Service Marketplace, Alias “serviceconnection” (http://service.sap.com/serviceconnection).

5.1.1 NetMeeting

NetMeeting is delivered with Windows 2000 or is part of the Internet Explorer package as of 4.01. As of NetMeeting version 3.01, desktop sharing is also possible.


2004 SAP AG 143

Through remote sessions, you can either demonstrate the error to the remote person or give the supporting person full control to reproduce the error. However, the local admin always has to ac-cept the incoming call from the support engineer. Due to restrictions within SAPRouter, it is not possible at the moment to open a NetMeeting connection and to accept all incoming calls by de-fault. The local admin has to be present when the call comes in.

Notes 356635 and 390990 give a detailed description for setting up a NetMeeting connection in SAPNet R/3 frontend.

5.1.2 PcAnywhere

PcAnywhere is an alternate application sharing tool. PcAnywhere has to be installed at the cus-tomer site and must be purchased separately. It always offers full control to the person who re-motely accesses the host. However, the support engineer can access the host at any time once the customer has opened the pcAnywhere connection. The local admin does not need to be pre-sent when the host is being accessed remotely.

Note 100740 provides information for the customer on how to establish a pcAnywhere connection.

5.1.3 Telnet

If the Enterprise Portal is based on a UNIX Platform, Telnet can be used to access the customer system.

Note 37001 provides information for the customer on how to establish a Telnet connection.

5.1.4 Http-Connect (in preparation)

At present, this service is still in a TESTPHASE.

If errors are returned by a Java/BSP application, the service employee must also be able to oper-ate the browser-based user interface of the application from SAP-side. The HTTP-Connect Ser-vice will provide a solution for this requirement.

This procedure does not apply to swing-based interfaces.

Note 592085 will provide information for the customer on how to establish an HTTP-Connect ser-vice.


2004 SAP AG 144

nNo part of this publication may be reproduced or transmitted in any form or for any purpose with-out the express permission of SAP AG. The information contained herein may be changed without prior notice.

nSome software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors.

nMicrosoft®, WINDOWS®, NT®, EXCEL®, Word®, PowerPoint® and SQL Server® are regis-tered trademarks of Microsoft Corporation.

n IBM®, DB2®, DB2 Universal Database, OS/2®, Parallel Sysplex®, MVS/ESA, AIX®, S/390®,

AS/400®, OS/390®, OS/400®, iSeries, pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner,

WebSphere®, Netfinity®, Tivoli®, Informix and Informix® Dynamic ServerTM are trademarks of IBM Corporation in USA and/or other countries.

nORACLE® is a registered trademark of ORACLE Corporation.

nUNIX®, X/Open®, OSF/1®, and Motif® are registered trademarks of the Open Group.

nCitrix®, the Citrix logo, ICA®, Program Neighborhood®, MetaFrame®, WinFrame®, Vide-

oFrame®, MultiWin® and other Citrix product names referenced herein are trademarks of Citrix Systems, Inc.

nHTML, DHTML, XML, XHTML are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology.

nJAVA® is a registered trademark of Sun Microsystems, Inc.

nJAVASCRIPT® is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape.

nMarketSet and Enterprise Buyer are jointly owned trademarks of SAP AG and Commerce One.

nSAP, SAP Logo, R/2, R/3, mySAP, mySAP.com and other SAP products and services men-tioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are trademarks of their respective companies.

portal troubleshoot

Documents