Debugging in SAP R/3

PMI Project Version 1.0

Title: Author: Created on: Description:

Version History:

Document Information Debugging in SAP R/3 Anji Reddy Gade 01.01.2007 The document describes general Debugging Overview and Techniques. The document shall be useful for Functional Consultant and ABAP Learner. ABAP experts also may find this paper bit useful. 1.0 Initial Version

Table of Contents Overview I: SIMPLE DEBUGGING TECHNIQUES IN SAP Traditional Debugging Programmed Break-Points Soft Break-Points Debugging in SAP Scripts II: DOS AND DONTS

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 2/18

Overview: Debugging is a term, which is directly associated with programming. It is a general term used by all Software Professionals, irrespective of the language and platform. Debugging, as the name suggests, is used to debug the program. IN other words it is slow motion, step by step execution of the program, so that one can closely find, how the program/ software is working. Debugging is typically used to fix the Bugs in the program but in SAP debugging is invariably used for understanding the flow of program itself. Debugging has been a vital discussion and development point across the software industry for Years. Still, there are some languages, where fixing a bug is a nightmare. In SAP, debugging had been a quite easy task. In SAP there are various ways to debug the program, additionally one can know the values of the variable withing the execution, which is a big help to the programming professionals. The purpose of this document is to give overview of the various debugging techniques available in SAP along with Dos and Donts of debugging. The primary focus of the document is the SAP functional consultants and ABAP learners. This document might not be fully useful for an expert ABAP consultant but can give bit of insight. SECTION I explains the Simple Debugging Techniques in SAP which could be utilized by functional consultant to analyse the problem more technically and advising the technical team for the fix. SECTION II gives an overview about Dos and Dons of Debugging. The document does not explain: Debugging Methodology Debugging in - Reporting tools like Report Writer or Report Painter - Business Warehouse reporting - Internet Transaction Server (ITS) related development - Etc.

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 3/18

I: Simple Debugging Techniques in SAP

SAP Provedes a variety of techniques for Debugging: Traditional Debugging Programmed break points Soft break points Debugging in SAP Scripts We will look into each of the options one by one. Traditional Debugging: Debugger in SAP can be started by typing /h in the command fileds before executing the program. Normally all the Report programs has selection screen. Most of the program code gets executed after the selection screen is displayed, so the debugging can safely be started after the selection screen is displayed. If it is required to debug the portion of the code, which gets executed even before selection screen, then it is not recommended to start the debugging by this method. This method is not suitable for the Reports without selection screen. To debug SAP module pools also, this method should be used, if it is required debugging the program after first screen is displayed.

Once the debugging starts following window is displayed.

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 4/18

Initially, Dynpro Flow logic is displayed in the above window if debugging has been started for module pool. If a report program is being debugged then directly program code is seen. Before going into details, it is necessary to discuss the term BREAK-POINT. Break point is a technique to stop the execution at particular line in the code and starting the debugging.

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 5/18

There are four different ways in which you can go through the source code of a program you want to analyze:

Execution Types in Debugging Mode Single step Execute Use this option to execute the program statement by statement. This allows you to branch to other program units. Use this option to process a program line by line. All of the statements on the current line are processed in a single step. This allows you to process the whole program. The Debugger returns to the point at which control is passed back to the main program. Use this option to return from other program units. Use this option to process the program up to the next breakpoint. If there are no more breakpoints in the program, the system exits debugging mode and executes the rest of the program normally. Once can set Watch on a variable. Whenever the value of that variable changes or reaches at pre-defined value, the execution stops in debugging mode.

Return Continue

Watch-point

The only exception to all above 5 option is the hard or soft break point. If a hard or soft break point is already set then program stop at that point, irrespective of the option selected. The current value of the variable can be retrieved by double clicking on the variable. The value and the variable are displayed in the bottom portion of debugging window. It is possible to change the value of variable to test a particular scenario. This is controlled by the authorization. It is very dangerous to have this access in Production System. To change the value of variable, type in the new value against the variable in the window below and hit change icon displayed one per record. It is not possible to change the value of some variables like import parameter of a function etc. To view the content of internal table go to tables tab on the Debug window and double click on the internal table. It displays the content of Internal table. If one knows the name of internal table/Variable, it can directly be written in bottom of window. On hitting enter the values are displayed.

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 6/18

The structures are displayed as strings as shown above S_MTART. If one wants to see as fields, then double click on the structure name in the above window then structure is displayed as fields as below:

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 7/18

Additional Icon in front of the structure name shows that the string is a internal table. To go to this internal table, click on that icon. And the view is like the following window.

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 8/18

The internal table is displayed as a tabular structure when the string size is quite long, the need is felt to display the particular record of internal table in Field Format. To achieve this, double click on the very first column of the table, where the record number is displayed.

If you know the internal table name and want to see the contents, then select button Table and put the name of internal table in the field so, at the bottom part of window. Overwrite the old value, if any exists and hit enter. The button Breakpoints is used to see all the breakpoints (of any type) set currently. This is useful when debugging within a loop or want to delete or deactivate a particular break point.

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 9/18

Similar to Breakpoints button Watchpoints button is used to display all the watch-points currently set in the session. Watch points are discussed in details at later part of this document.

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 10/18

The tab Calls gives an Idea about all the active stacks of the current call. In the following example the program is stopped at statement IF. This IF statement is within a FORM F_FILL_LIST_WITH_BOM, which in turn is in the event START-OF-SELECTION. So it gives a very good idea about the complete path of current call.

The button Overview used to have an overview of all the Modules, Routines, Functions called. It is helpful to get an idea about the execution path program took to come to current stage. It displays the overview of the current program only.

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 11/18

Programmed Break-Points: This technique can be used in custom developments only. No SAP standard software can be debugged using this technique. In this method a command has to be embedded in the program to make the execution stop at that point. These techniques should be used if the Soft Break-Point Technique does not suffice the purpose. There are two ways of writing the break point in the program. 1. BREAK-POINT: Use of this command will make the program execution to stop at this point. The above technique should not be used in Field-Exits, using this command in field exits will result in the short dump. This technique should be used if program is in development stage and no one is using. 2. BREAK <UNAME>: If the program in in testing mode and is in use also, then this technique can be used. In this technique the break point is effective for the user <UNAME> only. All other users will continue to execute the program in normal fashion. It should be noted that there are high chances that these break points are embedded in the program even after the solution and program is transported to Production System with Break Points. So special care should be taken to remove these break points. Soft Break-Points: The Soft Break Point is the best way of debugging, it should be preferred over all the techniques. One way is to go to the portion of the code, where break points need to be set and hit STOP Icon. It sets a break point for the current User Login. The break-point will be effective in all the sessions of that particular login. The break point will be effective from the next execution of the program.

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 12/18

One can set soft break points in debugging window itself by double clicking command. This technique is used to fasten the debugging process. If one knows particular places, where debugger needs to stop, the break points should be set on all those places. Only limitation of this method is that the break point can be set in the current program only. If there are other include programs, then one has to wait until the control reaches to that program. These break points are applicable for that execution of the program. In next execution one has to set it again, if required to stop. It is possible to save the break point set this way. Upon saving the break points are like method 1 of this section. SAP debugger gives an option to set the soft break point in few more ways. You can set the direct break point at: 1. ABAP/4 Statements 2. Subroutines 3. Function modules 4. System Exception

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 13/18

One can set break point using ABAP/4 statements like SELECT, MESSAGE, CALL FUNCTION, PERFORM, Etc. As displayed in the figure below, a small window pops up, when this option is selected. An ABAP key word has to be typed in this window. Once the enter is pressed on this popup, the soft break points are set on all the lines of all the programs, where this statement is used. Similarly, if one wants to set a break point at particular point at particular Perform/Function module, the relevant option should be selected. A popup is displayed to enter the name of Perform/ Function module. It should be noted that the break points set by this method are set in all the programs in the Call Stack.

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 14/18

Debugging in SAP Scripts Generally SAP Scripts are called by a ABAP Transactions. The Debugging of program is described above. The debugging of SAP Scripts is slightly different than the report. In SAP Scripts, there are not many options. To set the break point in SAP Scripts, go to transaction SE71, Write Form Name and the Language, then go to Utilities->Activate Debugger. Once the program is executed after activating debugger, following window occurs.

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 15/18

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 16/18

Hit OK to start debugging and CANCEL to continue without debugging. EXIT will deactivate the debugger and continue. After Hitting OK, Debugging WINDOW appears as follows:

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 17/18

Other things are similar like Report Debugging after this window is displayed.

II: Dos and Donts

Do not set a break in a program, which is called by another program in back ground. Typical example is Call Transaction XXXX. If one has set a break point in Transaction XXXX, then there will be errors. Avoid setting break point with Select-Endselect. There will short dump because of implicit commit. Remove programmed Break Points before sending the program to Production System. Never change the value of variable in Debugging in Production system. It might lead to inconsistency in the system. It is not possible to set up break point in Field Exit, but Message command can be used to display the value of some variable.

IBM India Pvt. Ltd. / Anji Reddy Gade / 01-Jan-2008

/ 18/18