Debug Console (ifs app8)
Debug ConsoleSome grammatical errors and unclear sentences(marked). Use of IEE.All the menu commands, tab names, button names etcshould be formatted.
Documentation should be written in 2nd person(you) instead of "user", "developer" etc
There is no description on how to start the debugconsole
The Debug Console is an analysis tool assisting developers and support teamsto debug Enterprise Explorer. The Debug Console can be used for analyzing clientas well as server traces.
This guide describes how the Debug Console works.
Contents
[*]Using the Debug Console
[*]Running the debug console under different modes
[*]Configuring modes
[*]Tracing Custom APF Messages
[*]Analyzing the server trace
[*]Analyzing PLSQL Invokes
[*]Using Copy/Copy Special
[*]Creating a memory dump
[*]Remote Debugging
Using the Debug ConsoleThe Debug Console consist of three sections.
[*]Toolbar
[*]List view for traces.
[*]Panel section showing detailed information for a selected record.
In the toolbar you can do the following:
[*]Switch debug mode.
[*]Attach / Detach debugger.
[*]Clear trace list.
[*]Add page break to trace list
[*]Set all filters to show everything.
[*]Clear all entries in the filter boxes.
[*]Export trace to XML.
[*]Toggle detail panes (horizontal/vertical orientation).
Below the toolbar is the filtering panel which consist of one group box foreach column that is visible in the trace view. The group boxes are populatedwith all unique entries that has been displayed in the corresponding column. Ifa group box is not empty then the user may filter the trace output by one of theunique entries that can be found. Filtering can be applied on multiple columnssimultaneously if desired.
Underneath the filtering pane is the main trace window in which all tracesare outputted. Each item in the list can be selected. When an item is selectedin the trace view more detailed information related to the item is shown belowthe trace window. The information section consists of a number of customizablepanes (user may choose to hide/show panes by configuring the modes) showing moredetailed and formatted information related to the trace item.
Running the debug console under different modes
The debug console can be run under different modes. Three predefined modesexists in the mode selection box. The predefined modes are the following;
• Framework: Focused on the framework developers. Most of the traceoptions are enabled to make the debug console outputs as much as possible.Translations is the only option that is not enabled in this mode as default.
• Application: Focused on the application developers. Only outputstraces related to application forms. Both client and server traces are enabledbut server traces are only focused on application forms.
• Translation: Focused on tracing translations in EE. Translationsmode disables most of the client traces in EE and all of the server traces. Onlytraces for translations are shown in this mode as default.
Note: As the number of translations is fairly high the user should note that itmight affect the performance of the application when running in this mode.
Default settings for the predefined modes are listed in the table below.
Configuring modes
Each debug mode that is available in theDebug Console can be configured. Navigate to the Tools menu and then select the“Configure modes…” menu item. This will open up the options dialog in which theuser can configure the modes’.
The upper part of the options dialog isa area dedicated for switching, creating and removing modes. The selection boxcontains all modes that are currently available in the Debug Console. The areabelow the selection box reflects the settings that apply for the currentlyselected mode. Selecting another mode from the selection box will cause thedialog to change the settings located in the the tab windows to the values thatapplies for the selected mode. If a user has done changes to one of the preconfiguredmodes (Application, Framework or Translation) and saved the changes. The name ofthe mode is extended with "(Mod)", indicating that the mode has been modifiedfrom its default configuration. The "Reset Mode" button located in the bottomleft section of the dialog is enabled when a predefined mode is modified.Pressing this button will cause the currently selected predefined mode to bereset to the default values that applies for that mode Note: Default values are "hard coded" and cannot bechanged from within the Debug Console.
Creating and configuring custom modesBesides configuring the three default modes, users canalso create their own custom mode. In the upper section in the "Configure modes"dialog there is a button marked with a plus sign. By pressing this button theuser is presented with an input dialog in which the user is asked to enter thename for the new mode. Pressing OK will create a new custom mode. A prefix of astar symbol (*) is added to the name for the custom mode to mark that it is acustom mode. The user can select the new mode from the mode selection box in theoptions dialog as well as from the selection box in the main debug consolewindow.
Note: Acustom mode does not have any default settings which the user can reset the modeto. So the “Reset Mode” button located in the bottom of the options dialog isalways disabled when configuring a custom mode.Tracing custom APF messagesClient trace messages can be added by calling theIfs.Fnd.FndTrace.WriteLine function, these will end up in the Featurecathegory. Client Call Stack shows all method calls inside client.This can be very useful to track client-side problems.
Analyzing the server traceTraces related to server calls often contain traceinformation received from the server. This information can be found in the"Server Trace"-tab. The top section of this pane contains two checkboxes that are related to how the server trace text is filtered. If none of thetwo check boxes are selected, which they aren't by default, results in that theentire trace received from the server is show in the text area below the checkboxes. grammarThe two filtering modes are the following:
[*]PL/SQL Invokes: Filters out PL/SQL invoke statements from the server trace.
[*]PL/SQL Trace: Filters out PL/SQL method traces from the server trace. This filtering mode also performs a formatting on the result to clarify the timestamps and method names.
Analyzing PL/SQL Invokes
When a user of IFS Enterprise Explorer conducts an operation that results in a server invoke, twosignificant trace messages are sent to the debug console. The first message,highlighted in green in the picture below (highlighting is done fordocumentation purpose and will not be present in runtime), is traced from theapplication level. The second one comes when the requested operation has beeninvoked. When analyzing PL/SQL invokes, the focus should be put on the latertrace message, as both the request and response information is contained withinthat trace message. The second trace does however not contain the names for theparameters that were used in the application code. In order for the user to knowwhich parameter is which he needs to check for them in the first message.
The PL/SQL Details tab is dedicated for showing the command information ofthe server invoke. The command is shown in the first field while the parameterinformation are shown in the table below. Response values for the parameters are shown in thelast column in the parameter table.
Note: One server invoke may contain more that one command in which case theprevious and next buttons should be used for iterating through them.
Analyzing Exceptions
Exceptions do sometimes occur, and when they do occur, they are highlightedin a red color in the trace message list. The exception information can be foundin the server trace if the user unchecked both of the filtering options locatedin the "Server trace"-tab.
Scanning though the server trace is often time-consuming so there's also thepossibility to open the Exceptions-tab in which a filtering of the server tracehas been done. The filtering filters out the most common client and server exceptions.
Note: All exceptions are not shown in the Exceptions-tab. In those cases theuser should search for them in the server trace.
Using Copy/Copy Special
Copy / Copy special functionality adds support for copying the PL/SQL codefrom a trace message (categories as "Server Invoke ") and converting it into an executable code snippet.All bind variables in the snippet are set so that the code snippet is ready forexecution.
The copy/copy special functionality is located under the PL/SQL Detail tab thatcan be enabled from the options dialog. Pressing the Copy button will format thecurrent statement into an executable one, making it possible to run in e.g.SQL/Plus or PL/SQL Developer. Copy Special works the same as Copy but only available for PL/SQL statements asit will also include a “Dbms_Output” section (printing out trace information),making it possible to trace the output in whatever external tool used.
Creating a memory dump
Creating a memory dump will save the current state of the application into adump file.To create a memory dump from within the debug console, users can navigate tothe debug console menu and under the Tools menu select “Create memory dump…”. The file can then be used for debugging and analysis of the currentstate of the application. Support personnel can use the memory dump fordebugging. The memory dumps can e.g. be used by developer to see the exactversion of files that are being used in the application and thereby excludepossible error sources. Developer can also use the file to rebuild the entireenvironment and try and run the same application locally in order to reproducethe errors.
Remote Debugging
Prerequisites:
[*]Grant role FND_DEVELOPER to user IFSSYS.
Note: The application server will most likely require a restart for the changes to take place.
Setup in Developer Studio
[*]Make sure to debug compile the package you want to debug.
[*]Set breakpoint where you want to stop. Make sure to do this in Database Source, source is grey (This can be done via the context menu by selecting "Go To Database Source").
[*]Select "Attach debugger..." from the the Debug menu.
[*]Specify theconnection information in the Attach-dialog and make sure theConnector-field is set to "SocketAttach".
Setup in IFS Enterprise Explorer
[*]Open the debug console from the Tools menu.
[*]In debug console, navigate to the configuration dialog and open the "Remote Debugging"-tab.
[*]Specify the host address and port you want to connect to and then save the changesand close the dialog.
[*]Remote debugging is now configured and breakpoints should be hit when server invokes are made.
頁:
[1]