Skip to main content

Configuration Steps

Enabling SAP GUI Scripting​

In order to enable Studio to interact with SAP GUI for Java, you need to perform the following configurations steps on the server side and the client side. This enables the default and recommended element detection framework SAP for interactive selection.

note

In relation to any security concerns, the SAP server sees no difference between SAP GUI for Java communication generated by a script and the one generated by a user. The script has the same rights to run SAP transactions and enter data, just like a user would.

On the Server Side​

  1. Launch SAP GUI for Java, log in to your SAP server using your credentials. The SAP Easy Access window is displayed.
  2. Run transaction RZ11. Specify the parameter name sapgui/user_scripting and press Enter on the keyboard or Display in the SAP interface.

docs image docs image 3. In the Display Profile Parameter Attributes window, select the Change Value button on the toolbar and set the New value of sapgui/user_scripting to TRUE. Save the changes.

docs image

note

In case your organisation is using more than 1 instance of an SAP system, do not forget to activate the checkbox “Switch on all servers” to ensure a proper activation of SAP scripting across all servers.

Depending on the SAP server version, the following parameters may be set to TRUE by default. In this case, change their value to FALSE.

  • sapgui/nwbc_scripting
  • sapgui/user_scripting_disable_recording
  • sapgui/user_scripting_force_notification
  • sapgui/user_scripting_per_user
  • sapgui/user_scripting_set_readonly
    important

    All changes to parameters in transaction RZ11 are applied with immediate effect and are lost when the system restarts. For changes to be permanent, please contact your SAP System Administrator and use transaction RZ10.

    Log off, then log on again for the changes to take effect.

On the Client Side​

  1. From the Main SAP Logon window, access the File > Preferences menu (on Windows) or SAPGUI > Settings (on Mac OS**)**.
  2. Go to Web AS ABAP and click on Scripting.
  3. Check the Enable scripting option.
  4. Clear the checkboxes for the following options:
    • Notify when an external script accesses SAP GUI
    • Notify when an external script attempts to open a connection
  5. Save the changes by clicking OK. The SAP GUI for Java scripting is now enabled.

docs image

Enable Modal Dialog Boxes​

Control (amodal) display options are not supported by SAP scripting. In this case, you must enable Dialog (modal) display options.

  1. From the SAP Easy Access window, select Settings under the Help menu. The Personal Settings for User window is displayed.
  2. Access the F1 Help tab and select the in Modal Dialog Box option from the Display section.
  3. Access the F4 Help tab and select the Dialog (modal) option from the Display section.
  4. Select the Apply button to save changes, and close the Personal Settings for User window.
    note

    This is a per-user setting. This configuration needs to be set for each client which creates a SAP automation. The default setting to Dialog (modal) for the entire system can be configured by the system administrator.

    docs image

Authorization Rights​

The authorization rights verification or settings need to be performed only if the sapgui/user_scripting_per_user parameter is set to True.

SAP GUI Scripting is only available for those users that have the authorization for the Execute(16) action of the authorization object S_SCR in class BC_A.

Please speak to your SAP System Administrator and ensure that the user has appropriate authorization rights.