SAP GUI Scripting Requirements

Table of contents
1 Introduction: Why is SAP GUI Scripting needed?............................................................2 2 SAP GUI Scripting Configuration..................................................................................... 2 2.1 Configuration for the Client......................................................................................... 2 2.2 Configuration for the Server.........................................................................................3 3 Known SAP GUI Scripting API Limitations ................................................................... 8 3.1 SAP Windows Theme.................................................................................................. 8 3.2 F4 Help Display Settings..............................................................................................9

SAP GUI Scripting Requirements

1 Introduction: Why is SAP GUI Scripting needed? The Knoa monitoring solution for SAP GUI utilizes SAP GUI Scripting API to provide comprehensive context-rich coverage for all operations within all SAP transactions. Some of the benefits of leveraging SAP GUI Scripting API include: Ability to monitor text of messages within all SAP dialog boxes. Ability to monitor all operations (including buttons and tab press events) even if they do not result in an operation. Knoa add-on features, such as Field Level Monitoring (FLM), which provides ability to capture field values, requires the SAP GUI Scripting API integration.

Note: Visit the following page to learn more about SAP GUI Scripting API: SAP GUI Scripting. 2 SAP GUI Scripting Configuration The Knoa monitoring solution for SAP GUI requires that SAP GUI Scripting API be enabled for the SAP Windows GUI.
2.1 Configuration for the Client

On any client PC, SAP GUI Scripting is only available if it has been installed. SAP GUI Scripting support is included in the SAP GUI installation as a default option. The SAP GUI Scripting option should be selected while installing a standard SAP GUI 640, 710 or 720 client on the client machine.

Page 2

SAP GUI Scripting Requirements

Please make sure SAP GUI Scripting is selected at the second step where you can choose which items you want to be installed.
2.2 Configuration for the Server

There are three SAP server profile parameters that should be set to the following values: sapgui/user_scripting : true sapgui/user_scripting_set_readonly : false sapgui/user_scripting_disable_recording : false

For more details, please refer to SAP GUI Scripting Security Guide How to check if the SAP GUI Scripting is installed or enabled Log on the SAP Font End and click "Customize Local Layout" button from top or press Alt +F12.
Page 3

SAP GUI Scripting Requirements

If the SAP GUI Scripting was installed and enabled, the "Scripting Recording and Playback..." should be available from the drop down list:

If the "Scripting Recording and Playback..." is not available from the drop down list above, select "Script Development Tools...":

Page 4

SAP GUI Scripting Requirements

Select "Troubleshoot SAP GUI Scripting" and press OK:

Page 5

SAP GUI Scripting Requirements

The Script Development Tools will show the status of SAP GUI Scripting. If the SAP GUI Scripting is not installed, the Script Development Tools will show "Scripting is not installed":

Page 6

SAP GUI Scripting Requirements

If the SAP GUI Scripting is not enabled on the server, the Script Development Tools will show "Scripting is disabled on the server":

Page 7

SAP GUI Scripting Requirements

3 Known SAP GUI Scripting API Limitations Knoa has identified the following limitations when SAP GUI Scripting API is enabled and utilized by the Knoa monitoring solution. These limitations may manifest themselves in a form of errors or short dumps within some client environments when SAP GUI Scripting API is exercised by the Knoa Agent. These known limitations with corresponding SAP Notes and solutions are documented below.
3.1 SAP Windows Theme

Knoa will require that the SAP Windows Theme that is used is not the "Signature Theme", due to SAP known issues with the theme. Knoa suggests that the "Tradeshow Theme" be used. Knoa team can configure this directly in the web meeting session if needed. Changing the SAP GUI Theme Instructions for changing SAP GUI theme are available in the attached SAP Help file: 6. Adjusting the Local Layout, 6.1 Theme.
Page 8

SAP GUI Scripting Requirements

sapguien.chm

3.2 F4 Help Display Settings

According to the following SAP Note: SAP Note 977583 - Search Help: Scripting not supported in Control mode F4, the SAP GUI scripting API has a known issue with F4 Control/Amodal dialogs. If the dialog setting in the SAP landscape is set to Control Amodal, then any dialogs of this type will not have messages or operations monitored. Usage metrics will still be collected for the dialog. For more information, please see the F4 Dialog Monitoring section in the Knoa SAP GUI Application model: Application Model 7.0 - SAP GUI Scripting Alternatively, the dialog mode can be changed to be modal, which would result in all dialogs being fully monitored by the solution. Please note that making this change could affect the look and feel of previously amodal F4 dialogs. A summary can be seen in the following diagram:

The following instructions outline how to make the change from Control (amodal) mode to Dialog (modal): F4 Help Display Settings Configuration for the Server The F4 help display mode can be set at the server by following these instructions:
1. 2. 3.

4.

Execute t-code (SU10 User Maintenance: Mass Changes) Select all USERS Change/Set Parameters for USERS Parameter ID: F4METHOD Parameter Value: NoActiveX Save

F4 Help Display Settings Configuration for the Client The F4 help display mode can be set at the end user by following these instructions:
1.

Select Setting menu item under Help menu

SAP GUI Scripting Requirements

2. 3.

Personal Settings for User Dialog will appear Select "F4 Help" and select "Dialog (modal)" instead of "System defaults"

Page 10

SAP GUI Scripting Requirements

4.

Close SAP GUI and restart/reopen.

Page 11