Web Dynpro for ABAP (WDA, WD4A, WDF4A) Release NW2004S SPS8 P A B A D W C B P. L E H SAP Online Help 08.06.2006 Copyright © Copyright 2006 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 Web Dynpro for ABAP NW2004s SPS8 2 SAP Online Help 08.06.2006 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. Web Dynpro for ABAP NW2004s SPS8 3 SAP Online Help 08.06.2006 Icons in Body Text Icon Meaning Caution Example Note Recommendation Syntax Additional icons are used in SAP Library documentation to help you identify different types of information at a glance. For more information, see Help on Help → General Information Classes and Information Classes for Business Information Warehouse on the first page of any version of SAP Library. Typographic Conventions Type Style Description Example text Words or characters quoted from the screen. These include field names, screen titles, pushbuttons labels, menu names, menu paths, and menu options. Cross-references to other documentation. Example text Emphasized words or phrases in body text, graphic titles, and table titles. EXAMPLE TEXT Technical names of system objects. These include report names, program names, transaction codes, table names, and key concepts of a programming language when they are surrounded by body text, for example, SELECT and INCLUDE. Example text Output on the screen. This includes file and directory names and their paths, messages, names of variables and parameters, source text, and names of installation, upgrade and database tools. Example text Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation. <Example text> Variable user entry. Angle brackets indicate that you replace these words and characters with appropriate entries to make entries in the system. EXAMPLE TEXT Keys on the keyboard, for example, F2 or ENTER. Web Dynpro for ABAP NW2004s SPS8 4 SAP Online Help 08.06.2006 Contents Web Dynpro for ABAP...........................................................................................................24 Web Dynpro ABAP Configuration.......................................................................................26 Fully Qualified Domain Names (FQDN)..........................................................................28 Web Dynpro Architecture...................................................................................................33 Web Dynpro Component................................................................................................34 View............................................................................................................................36 View Set..................................................................................................................37 Plugs and Navigation Links......................................................................................37 Web Dynpro Window...................................................................................................38 Window Plugs..........................................................................................................40 Controller.....................................................................................................................41 Context....................................................................................................................43 Context Node: Properties.....................................................................................45 Data Binding and Mapping.......................................................................................49 Event.......................................................................................................................51 Action...................................................................................................................52 Interfaces of Web Dynpro Components..........................................................................52 Web Dynpro Application.................................................................................................54 Web Dynpro Model.........................................................................................................55 Web Dynpro ABAP: Development in Detail........................................................................56 Basics.............................................................................................................................56 Component..................................................................................................................57 Web Dynpro View........................................................................................................57 UI Elements of the View...........................................................................................59 Structure of the View Context..................................................................................61 Data Binding............................................................................................................62 UI Element Actions..................................................................................................63 Parameter Mapping..............................................................................................64 Action Event Handlers.............................................................................................65 Component Controller.................................................................................................68 Context Mapping......................................................................................................68 Programming Controller Methods................................................................................70 Reference Variable WD_CONTEXT........................................................................71 Reference Variable WD_THIS and Local Controller Interface..................................71 Methods of the Local Controller Interface................................................................72 Hook Methods: Methods Called by the Runtime...................................................73 Predefined Methods of the Local Controller Interface...........................................74 Events and Event Handlers..................................................................................75 Supply Function...................................................................................................77 Web Dynpro for ABAP NW2004s SPS8 5 SAP Online Help 08.06.2006 Free Methods of the Application Development.....................................................81 Cross-Controller Method Call...............................................................................82 Web Dynpro Runtime APIs......................................................................................83 Filling the Context....................................................................................................84 Phase Model............................................................................................................85 Client Implementation..............................................................................................89 Web Dynpro Window...................................................................................................89 Navigation Between Two Views...............................................................................90 Web Dynpro Application..............................................................................................93 URL of a Web Dynpro Application...............................................................................94 Fully Qualified Domain Names (FQDN)...................................................................97 URLs and Namespaces.........................................................................................101 Calling a Web Dynpro Application Using Parameters................................................103 Cross-Component Programming..................................................................................104 Controllers of a Web Dynpro Component..................................................................104 Component Usages...................................................................................................106 Component Usage without Controller Access........................................................107 Component Usage with Controller Access.............................................................109 Navigation Through Window Plugs........................................................................111 Cross-Component Context Mapping......................................................................111 External Context Mapping..................................................................................112 Working with Web Dynpro Component Interfaces.....................................................114 Creating a Web Dynpro Component Interface Definition.......................................117 Implementing a Web Dynpro Interface Definition...................................................117 Example for the Implementation of an Interface Definition.....................................118 Working With Faceless Components.........................................................................120 Dynamic Programming.................................................................................................121 Dynamic Layout Manipulation...................................................................................121 Working Dynamically with Parameter Mappings....................................................123 Dynamic Context Manipulation..................................................................................125 Working Dynamically with Component Usages.........................................................126 Dynamically Creating Component Usages.............................................................126 Dynamically Embedding an Interface View............................................................128 Method Call in a Dynamically Created Component Usage.....................................130 Dynamically Registering an Event Handler to an Event.........................................130 Advanced Concepts......................................................................................................131 Working with the Assistance Class............................................................................131 Service Calls in a Web Dynpro Application................................................................132 Creating a Service Call..........................................................................................132 Using a Service Call..............................................................................................133 Web Dynpro for ABAP NW2004s SPS8 6 SAP Online Help 08.06.2006 Data Binding Concepts..............................................................................................134 Data Binding of User Interface Element Properties................................................135 Data Binding Using Index and Key........................................................................136 Fixed Values of Attributes......................................................................................137 Context Change Log (Recording User Entries)......................................................139 Modification-Free Enhancements..............................................................................141 Implementing Enhancements in a View.................................................................142 Implementing Enhancements in the Controller......................................................143 Implementing Enhancements in a Window............................................................143 Debugging Web Dynpro ABAP Applications..............................................................144 Version Comparisons in Web Dynpro for ABAP........................................................145 File Export.................................................................................................................146 Handling Web Icons..................................................................................................147 Working with Dialog Boxes........................................................................................150 Calling Dialog Boxes of the Same Component......................................................150 Calling Dialog Boxes of a Used Component..........................................................152 Calling a Confirmation Dialog Box.........................................................................153 Input Help..................................................................................................................154 ABAP Dictionary Search Help................................................................................154 OVS Input Help......................................................................................................156 Freely Programmed Input Help..............................................................................158 Messages..................................................................................................................159 Integration of Messages in the Message Log.........................................................162 Help Texts in and for Web Dynpro Applications........................................................164 Personalization and Configuration.............................................................................166 Component Configuration......................................................................................166 Application Configuration.......................................................................................168 Personalization......................................................................................................170 Delta Handling in Customization and Personalization............................................171 Notes on Working with Adjustment Data................................................................173 Configuration of an Included ALV Component.......................................................173 Portal Integration.......................................................................................................174 Binding to Portal: Prerequisites..............................................................................175 Integrating an Application in the Portal..................................................................176 Portal Events.........................................................................................................178 Triggering a Portal Event....................................................................................178 Registering and Handling an Event....................................................................179 Portal Navigation...................................................................................................181 Object-Based Navigation (OBN).........................................................................181 Absolute Navigation...........................................................................................183 Web Dynpro for ABAP NW2004s SPS8 7 SAP Online Help 08.06.2006 Relative Navigation............................................................................................186 Resume Plugs and Portal Navigation.................................................................187 Work Protect Mode................................................................................................188 Integrating Forms......................................................................................................190 Integrating a PDF Form in a Web Dynpro Application............................................191 Inserting (Interactive) Forms...............................................................................192 Inserting Existing Forms.....................................................................................193 Digital Signatures in Form Integration................................................................195 Supported Elements of the Adobe Library.............................................................196 Interactive Form Use.............................................................................................197 Forms with Function Module-Based Interface........................................................197 SAP List Viewer in Web Dynpro for ABAP.................................................................198 Integration of ALV in Your Application...................................................................199 Defining the Component Usage.........................................................................201 Providing the Data..............................................................................................202 Using the ALV Views..........................................................................................203 Objects of the ALV Configuration Model.............................................................204 Getting the ALV Configuration Model.................................................................205 Class Diagram....................................................................................................205 Managing ALV Output Areas.................................................................................206 ALV Output Header............................................................................................207 Fields.................................................................................................................208 Columns.............................................................................................................209 Column Headers.............................................................................................210 Position of Columns........................................................................................212 Footer and Paginators........................................................................................213 Header and Footer Areas...................................................................................215 Creating Design Objects and Elements..........................................................216 Design Object Settings...................................................................................218 Examples of Design Objects...........................................................................219 Settings Dialog Box............................................................................................221 Appearance of ALV Output....................................................................................222 Assigning Properties to Columns and Cells........................................................222 Size of ALV Output, Columns, and Cells............................................................223 Visibility of Individual Areas................................................................................224 Color of ALV Output, Columns, and Cells..........................................................225 Text Properties...................................................................................................226 Lines Between Columns and Rows....................................................................227 Table as Hierarchy.............................................................................................228 Table Data as Business Graphics......................................................................229 Web Dynpro for ABAP NW2004s SPS8 8 SAP Online Help 08.06.2006 Predefining Standard ALV Functions.....................................................................233 Sorting................................................................................................................233 Filters.................................................................................................................236 Calculation (Aggregation)...................................................................................238 Settings for Aggregation.................................................................................239 Intermediate Results.......................................................................................240 Managing Views.................................................................................................242 Export.................................................................................................................243 Microsoft Excel...............................................................................................243 Adobe Acrobat................................................................................................244 Functions, Interactions, and Events.......................................................................248 Providing Functions............................................................................................248 Providing Standard ALV Functions.................................................................249 Generating, Getting, and Deleting Functions..................................................251 Preparing the Context.....................................................................................253 Specifying User Interface Elements................................................................253 Specifying the Position in the Toolbar.............................................................254 Controlling Visibility and Activation Status......................................................255 Events for Handling Functions........................................................................256 Handling Interaction with no Data Changes.......................................................256 Selecting Rows...............................................................................................256 Using Hyperlinks, Buttons, and Toggle Buttons..............................................258 Handling Interaction in Editable ALV..................................................................259 Write-Protection and Activation.......................................................................259 Adding and Deleting Rows..............................................................................260 Changing Cell Content....................................................................................261 Defining the Checking Time............................................................................261 Providing Help for Users....................................................................................262 Methods and Events of the Interface Controller.....................................................263 DATA_CHECK...................................................................................................264 GET_CONFIG_DATA........................................................................................265 Configuration Key...........................................................................................267 GET_MODEL.....................................................................................................268 GET_MODEL_EXTENDED................................................................................269 SET_DATA.........................................................................................................270 ON_AFTER_CONFIG........................................................................................271 ON_CLICK.........................................................................................................271 ON_DATA_CHECK............................................................................................272 ON_FUNCTION.................................................................................................272 ON_LEAD_SELECT...........................................................................................273 Web Dynpro for ABAP NW2004s SPS8 9 SAP Online Help 08.06.2006 ON_STD_FUNCTION_AFTE.............................................................................273 ON_STD_FUNCTION_BEFO.............................................................................274 Accessibility of a Web Dynpro Application.................................................................275 Internationalization and Translation...........................................................................278 Quality Assurance.....................................................................................................279 Web Dynpro Trace Tool.........................................................................................279 ICM Tracing...........................................................................................................281 HTTP Browser Tracing..........................................................................................283 HTTP Proxy........................................................................................................287 System Logon...........................................................................................................288 Prerequisites..........................................................................................................291 Configuration Settings............................................................................................292 Password Logon Scenarios...................................................................................296 Changing You Password with Basic Authentication...........................................298 Password Changes in the SSO Environment.....................................................298 User-specific Changes...........................................................................................299 Example.............................................................................................................301 URL Generation in an AS-ABAP - Web Dispatcher Configuration.........................302 Host Header.......................................................................................................303 Absolute URL Generation..................................................................................303 Configuration Table HTTPURLLOC...................................................................304 Programming Interface.......................................................................................305 Scenario 1: Direct Browser - AS-ABAP Communication.....................................306 Scenario 2: Browser - AS-ABAP Communication Through a Reverse Proxy.....307 Scenario 3: Direct Communication Through a Reverse Proxy............................307 Scenario 4: Communication with Protocol Switch Through Reverse Proxy........309 Special Case: Combination with the Logon Application......................................309 Examples of the Logon Screen..............................................................................310 Web Dynpro ABAP Administration...................................................................................312 Web Dynpro Trace Tool................................................................................................313 ICM Tracing..................................................................................................................315 HTTP Browser Tracing.................................................................................................317 HTTP Proxy...............................................................................................................321 Logging.........................................................................................................................322 Fully Qualified Domain Names (FQDN)........................................................................323 Monitoring Web Dynpro ABAP Applications..................................................................327 Security Issues in Web Dynpro for ABAP.........................................................................329 Application Logoff Page................................................................................................332 Application Error Page..................................................................................................335 URL Parameters...........................................................................................................336 Web Dynpro for ABAP NW2004s SPS8 10