how to use the web dynpro java debug configurator · the web dynpro java debug configurator is...

11
How to use the Web Dynpro Java Debug Configurator SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com © 2007 SAP AG 1 How to use the Web Dynpro Java Debug Configurator Applies to: The Web Dynpro Java Debug Configurator is available with the SAP NetWeaver 04s release SP 12. Summary Running a Web Dynpro Java application within the SAP NetWeaver Portal offers a wide range of additional features. On the other side it is more complex to find the reason in case that there are problems. The Web Dynpro Debug Configurator provides an easy to use way to define several debug settings for most of the involved runtime components. This document explains how to use the Web Dynpro Java Debug Configurator. Author: Jochen Guertler Company: SAP AG Created on: 1 st February 2007 Author Bio Jochen Guertler works as a development architect within the NetWeaver UI team. His main responsibilities are the integration of Web Dynpro for Java with other components of SAP NetWeaver, especially the integration with the SAP NetWeaver Portal. Jochen is co-author of the “Maximizing Web Dynpro for Java” book.

Upload: hoangthuy

Post on 14-Apr-2018

226 views

Category:

Documents


4 download

TRANSCRIPT

How to use the Web Dynpro Java Debug Configurator

SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com © 2007 SAP AG 1

How to use the Web Dynpro Java Debug Configurator

Applies to: The Web Dynpro Java Debug Configurator is available with the SAP NetWeaver 04s release SP 12.

Summary Running a Web Dynpro Java application within the SAP NetWeaver Portal offers a wide range of additional features. On the other side it is more complex to find the reason in case that there are problems. The Web Dynpro Debug Configurator provides an easy to use way to define several debug settings for most of the involved runtime components. This document explains how to use the Web Dynpro Java Debug Configurator. Author: Jochen Guertler Company: SAP AG Created on: 1st February 2007

Author Bio Jochen Guertler works as a development architect within the NetWeaver UI team. His main responsibilities are the integration of Web Dynpro for Java with other components of SAP NetWeaver, especially the integration with the SAP NetWeaver Portal. Jochen is co-author of the “Maximizing Web Dynpro for Java” book.

How to use the Web Dynpro Java Debug Configurator

SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com © 2007 SAP AG 2

Table of Contents How to use the Web Dynpro Debug Configurator ........................................................................... 1 Applies to: ........................................................................................................................................ 1 Summary.......................................................................................................................................... 1 Author Bio ........................................................................................................................................ 1 Table of Contents ............................................................................................................................ 2 Introduction ...................................................................................................................................... 2 Prerequisites.................................................................................................................................... 3 The Web Dynpro Debug Configurator ............................................................................................. 3 Supported components.................................................................................................................... 4

Web Dynpro HTML Client ............................................................................................................ 4 SAP Application Integrator ........................................................................................................... 5 Web Dynpro Page Builder............................................................................................................ 6

General Information.................................................................................................................. 7 Application Information............................................................................................................. 8 Request parameters to the application..................................................................................... 8 Non personalization map.......................................................................................................... 8 Personalization map................................................................................................................. 8

Distributed Session Management (DSM)..................................................................................... 9 Restrictions .................................................................................................................................... 10 Copyright........................................................................................................................................ 11

Introduction Running a Web Dynpro for Java application within the SAP NetWeaver Portal offers a wide range of additional functionality. On the other side it is more complex to find the reasons in case of problems. The main reasons for this increased complexity are the following:

• Besides the Web Dynpro Runtime there are several other components involved when starting a Web Dynpro application as a Web Dynpro iView. Examples are the SAP Application Integrator or the Distributed Session Management (DSM) of the SAP NetWeaver Portal.

• Most of the involved components are offering some debug functionally (like showing info about the current status of the component in an additional window) in a different way. And even worse: all these components use different mechanisms to turn on / off such debug capabilities or to define the displayed data.

• In "real-life" scenarios it is often really difficult (or even impossible) for a user to know which Web Dynpro iView is executed at the moment. Therefore it is hard to find the related Web Dynpro application.

Besides these restrictions, there were in the past several requirements from customers to provide a possibility to define the debug settings for a specific user for all used Web Dynpro iViews without knowing all these iViews. To overcome the mentioned restrictions and to provide a solution for such user-specific settings we introduced the Web Dynpro Debug Configurator.

How to use the Web Dynpro Java Debug Configurator

SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com © 2007 SAP AG 3

Prerequisites The Web Dynpro Debug Configurator as part of the Web Dynpro Console is part of the SAP NetWeaver 04s SP 12 release.

The Web Dynpro Debug Configurator The Web Dynpro Debug Configurator is part of the Web Dynpro Console, which is accessible within the SAP NetWeaver Portal under System Administration -> System Configuration -> Web Dynpro Console. We cannot describe all the available functionality of the Web Dynpro Console in this document, please have a look to related documents available also in SDN to get more details. To use the Web Dynpro Console you need J2EE Administration permissions or portal super administration permissions. Otherwise you will get an error screen saying that you do not have the required permissions. You can start the Web Dynpro Debug Configurator using the Web Dynpro Debug Configurator link within the Settings section of the navigation panel on the left side of the Web Dynpro Console.

To use the Web Dynpro Debug Configurator you execute always the following three steps:

1. Choose the user for which you want to define the debug settings. 2. Define the needed debug settings using the different tabs. 3. Assign the chosen debug settings to the user by pressing the Assign to User button on the right

bottom side.

The next picture shows the selection of the Administrator user. You can search for any user using a "*" wildcard.

How to use the Web Dynpro Java Debug Configurator

SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com © 2007 SAP AG 4

Supported components The Web Dynpro Debug Configurator currently supports the following components • Web Dynpro HTML client • SAP Application Integrator • Web Dynpro Page Builder • Distributed Session Management (DSM) The following chapters give more details about each component.

Web Dynpro HTML Client The Web Dynpro HTML client renders a Web Dynpro application within a web browser. The Web Dynpro Debug Configurator provides two settings to help in case of errors. First you can turn on the client debug (which allows you to debug the JS sources of the Web Dynpro HTML client. The next picture shows the Web Dynpro HTML Client tab, which offers you the capability to turn on / off the client debugging using the Client Debug check box.

Besides the client debugging, you could start a client trace showing the data which is sent between Web Dynpro runtime and Web Dynpro HTML client. The client trace is shown in an additional window, which is started as soon as the Web Dynpro application is started (as shown in the next picture).

How to use the Web Dynpro Java Debug Configurator

SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com © 2007 SAP AG 5

Depending on the chosen trace level you get more or less detailed data.

SAP Application Integrator The SAP Application Integrator is responsible to redirect the original iView request to the Web Dynpro runtime. Depending on the running Web Dynpro iView type the SAP Application Integrator redirects directly to the Web Dynpro application (for NW04 Web Dynpro iViews) or to the Web Dynpro page builder (for NW04s Web Dynpro iViews). The SAP Application Integrator offers a debug screen showing all parameters passed to the Web Dynpro runtime. This debug screen is shown in an additional window, which is opened as soon as a Web Dynpro iView is launched. To turn on the SAP Application Integrator debug screen you have to use the SAP Application Integrator tab of the Web Dynpro Debug Configurator as shown in the next picture.

How to use the Web Dynpro Java Debug Configurator

SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com © 2007 SAP AG 6

The following picture shows the debug screen of the SAP Application Integrator.

For more details about the debugging of the SAP Application Integrator please have a look to OSS note 857511.

Web Dynpro Page Builder The Web Dynpro Page Builder is responsible to launch a Web Dynpro iView directly or embedded into a Web Dynpro page. To get more details about the Web Dynpro Page Builder please check this document available in SDN. Using the Web Dynpro Debug Configurator you can turn on the Web Dynpro Page Builder debug mode showing different useful information. You turn on the Web Dynpro Page Builder debug mode using the related check box on the Web Dynpro Page Builder tab.

How to use the Web Dynpro Java Debug Configurator

SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com © 2007 SAP AG 7

As soon as the debug mode is turned on, the Web Dynpro Page Builder renders for each Web Dynpro iView a link to show or hide the iView details (displayed in the next screenshot).

This link toggles the iView details screen. The iView details screen shows both some general information about the launched iView like the PCD location and useful runtime related information (like the passed parameters between Web Dynpro Page Builder and Web Dynpro iView (as shown in the next screenshot).

The following data is displayed in the iView details screen: • General information • Application information • Request parameters to the application • Non personalization map • Personalization map Each area contains different data, as described in the following chapters.

General Information The General Information shows the PCD location and the isolation level (EMEBBED or URL) of the launched iView. Besides that it shows whether the View is a Web Dynpro iView. Example:

PCD Location: pcd:portal_content/administrator/super_admin/super_admin_role/com.sap.portal.system_administration/com.sap.portal.system_admin_ws/com.sap.portal.support/com.sap.portal.web_dynpro_test_tools/com.sap.portal.wd_pb/com.sap.portal.wdpb_test_page/com.sap.portal.TabIview

Isolation Level: EMBEDDED

Is WebDynpro Application? yes

How to use the Web Dynpro Java Debug Configurator

SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com © 2007 SAP AG 8

Application Information The application information is only relevant for Web Dynpro iViews. It shows the name of the Web Dynpro development component / Web Dynpro project and the Web Dynpro application name. Example:

Application Name: PageBuilderTestApplication

Deployable Part: sap.com/pb_test

Request parameters to the application Running a NW04s Web Dynpro iView it is not longer possible to use a HTTP trace tool like HttpWatch, to check which parameters are passed to the Web Dynpro application in the end. The reason for that is that the Web Dynpro page builder calls the embedded Web Dynpro application without any HTTP request. To overcome this problem the Web Dynpro Page Builder debug screen shows the list of passed parameters for each iView. Example:

sap-cssurl = [http://vm6152:50000/irj/portalapps/com.sap.portal.design.urdesigndata/themes/portal/sap_tradeshow/ur/ur_ie6.css?7.0.10.0.0],

sap-accessibility = [],

sap-locale = [en],

sap-wd-clientTrace = [4],

sap-cssversion = [7.0.9.0.0],

sap-wd-pb-debugmode = [true],

sap-ext-sid = [GJJix4a1Tnjbr21fFysmpg==oXpaidOHSLISvy1I++OHlQ==/pcd:portal_content/administrator/super_admin/super_admin_role/com.sap.portal.system_administration/com.sap.portal.system_admin_ws/com.sap.portal.support/com.sap.portal.web_dynpro_test_tools/com.sap.portal.wd_pb/com.sap.portal.wdpb_test_page/sap.com/pb_test/PageBuilderTestApplication/variant1],

sap-wd-app-namespace = [zzzz],

sap-rtl = [],

sap-wd-cltwndid = [WID1168611238841],

sap-wd-tstamp = [1168262054562],

sap-ep-version = [7.00.200611091758]

Non personalization map The non personalization map shows the role-based data created using the implicit Web Dynpro personalization.

Personalization map The personalization map shows the end-user personalization data created using the implicit Web Dynpro personalization. Besides the data shown in the iView details screen there is a lot of page builder internal information which is displayed at the end of a page as shown in the next picture.

How to use the Web Dynpro Java Debug Configurator

SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com © 2007 SAP AG 9

Distributed Session Management (DSM) The Distributed Session Management (DSM) (or Session Release Agent) of the SAP NetWeaver Portal ensures that a Web Dynpro application running within the SAP NetWeaver Portal gets notified and destroyed correctly after navigating away or closing the browser window at all. Using the related check box shown under the Session Management tab of the Web Dynpro Debug Configurator you can turn on / off the debug mode of the DSM.

Once this check box is turned on, the DSM automatically displays Session Receipts and Transmission protocols – as described in the CSN Note 596698. Whenever a Web Dynpro iView is started, you get a Session Info Receipt popup in the browser (as shown in the next picture). This signalizes that the portal was informed about a newly opened Web Dynpro session.

When navigating away or closing the browser window, the DSM performs the Termination Notification by sending of Termination Requests for opened sessions. The Transmission protocol of this notification is then displayed either in the current window (when performing a navigation to another iView), or in a new browser window (when closing browser window). The next picture shows the Termination Notification displayed in the current browser window.

How to use the Web Dynpro Java Debug Configurator

SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com © 2007 SAP AG 10

Once the termination requests are sent, the DSM is performing internal acknowledgement between the browser and portal server to make the whole process fail-safe. With activated debug flag, you will get a browser popup yet before this acknowledgment is sent (as shown in the following picture).

Restrictions The debug settings defined by the Web Dynpro Debug Configurator are currently only used in case that a Web Dynpro application is launched as a Web Dynpro iView within the SAP NetWeaver Portal. Both "flavors" of Web Dynpro iViews (i.e. the isolated iViews available since the SAP NetWeaver 04 release and the Web Dynpro iView based on the Web Dynpro page builder available since the SAP NetWeaver 04s release) are supported.

How to use the Web Dynpro Java Debug Configurator

SAP DEVELOPER NETWORK | sdn.sap.com BUSINESS PROCESS EXPERT COMMUNITY | bpx.sap.com © 2007 SAP AG 11

Copyright © Copyright 2007 SAP AG. All rights reserved.

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice.

Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors.

Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation.

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, i5/OS, POWER, POWER5, OpenPower and PowerPC are trademarks or registered trademarks of IBM Corporation.

Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries.

Oracle is a registered trademark of Oracle Corporation.

UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.

Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc.

HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®, World Wide Web Consortium, Massachusetts Institute of Technology.

Java is a registered trademark of Sun Microsystems, Inc.

JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape.

MaxDB is a trademark of MySQL AB, Sweden.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

These materials are provided “as is” without a warranty of any kind, either express or implied, including but not limited to, the implied warranties of merchantability, fitness for a particular purpose, or non-infringement.

SAP shall not be liable for damages of any kind including without limitation direct, special, indirect, or consequential damages that may result from the use of these materials.

SAP does not warrant the accuracy or completeness of the information, text, graphics, links or other items contained within these materials. SAP has no control over the information that you may access through the use of hot links contained in these materials and does not endorse your use of third party web pages nor provide any warranty whatsoever relating to third party web pages.

Any software coding and/or code lines/strings (“Code”) included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, except if such damages were caused by SAP intentionally or grossly negligent.