1. Using Siebel Tools
  2. Using the Script Profiler in Web Tools

Using the Script Profiler in Web Tools

The Siebel Script Performance Profiler is used with the eScript ST engine to observe and monitor the performance of a script. It is designed to be used in conjunction with the Siebel Script Debugger and gathers data only during a Siebel Script debugging session. While very basic information will be gathered if you have not set up line debugging rules, if a script executes, there will be an entry in the Script Profiler Window. You must set up Line Profiling Rules to get detailed information about the lines that have executed. The columns in the Script Profiler Call Tree Pane are the same that exist in Siebel Tools. To see more go to Example of the Script Performance Profiler Window.

Note: The Script Profiler does not profile Browser Script. It only works on server eScript.

Setting up Line Profiling Rules

To gather detailed information about individual methods and their constituent lines, you must set up Line Profiling Rules. Once you have enabled the Script Profiler by setting the Enable Profiler check box to true (checked) you can set Line Profile Rules. It is best to set up Line Profiling Rules before your debug session starts, but if you add rules after it starts, they will be picked up the next time the scripts are executed.

  1. Click Set Profile Rules.

  2. Choose the object type for the scripted object. The choices are:

    1. Application (Server Script for an Application)

    2. Service (Server Script for a Business Service)

    3. BusComp (Server script for a Business Component)

    4. WebApplet (Server Script for an Applet)

  3. Type in the name of the object in the Object Name field. You can use wildcards in the name to include more than one object of the same type.

  4. Type the method name in the Function field. You can use wildcards to include more than one method from the objects.

  5. Click Add to add your rule to the list of Line Profile Rules.

    Note: You can also delete rules from this dialog by selecting a rule and clicking Delete.

  6. Do these steps for all the objects and methods you wish to profile.

  7. When finished click OK.

  8. Click OK to close the Debugger Settings dialog.

Note: If you misspell the object type or method you will not get any results for that object. If you choose the wrong Object Type to associate with a method, you will get only general results for that object, no individual lines will be profiled.

Using the Script Profiler in Web Tools

If you have enabled the Script Profiler prior to starting a script debugging session, using the Script Profiler is as simple as starting a debugging session and ensuring the scripts you wish to profile are executed during that session. The Script Profiler pane will show under the script debugger panes.

Note: You can undock the script debugger panes to view them in a larger screen. The Script Profiler pane will remain at the bottom of the panes whether docked or undocked. You may have to scroll to see all the contents of the Script Profiler pane.

  1. Enable the Script Profiler.

  2. Set up any Line Profile Rules you need.

  3. Start a debugging session.

  4. Trigger the scripts that you wish to execute.

  5. Click the Call Tree icon in the script debugger toolbar to open the Script Profiler Call Tree Pane. The button is a toggle button and will also close the Script Profiler Call Tree Pane.

  6. In the Script Profiler Call Tree Pane, you will see the results of all the scripted objects that have executed. If you configured Line Profile Rules, you can expand or collapse each object and its child methods.

  7. If you have enabled Line Profile Rules for a method the call tree will contain the lines of each method that were executed.

    Note: If you did not set up any Line Profile Rules for a particular object and have started your debugging/profiling session, you can click the check box next to the arrow that expands/collapses the call tree for that object. That particular profile rule will be automatically added to the list of Line Profile Rules in Settings. The next time that object executes a script, it will show the lines of script individually. This is a shortcut to creating Line Profile Rules ahead of time.
    Note: If a line (such as a comment or some logic in a switch, if, or other block) is not executed in a script it will not display in the Call Tree. Only lines that are executed show in the Call Tree.

  8. Click on an individual line in a method and it will open that script in the middle script debugging pane with that line highlighted. If you open more than one script, you can switch between them in this middle pane where they are displayed.

  9. Click the arrow next to an object or method in the call tree when it points horizontally to expand that object. Click on the arrow when it points downward collapses that object and its tree.

  10. If the debugging session continues, data for scripted objects will collect in the Script Profiler pane.

  11. When your debugging session ends, the script profiling also stops.

  12. Print the profiling data by clicking the printer icon at the very top of the Call Tree in the Root node. This allows you to print the contents of the Script Profiler Pane.