SAP GUI Automation Using VBScript (WScript)

[Kunal_SAP-871]

What is WScript and How can it be used to Automate SAP?

WScript is part of the Windows Script Host (WSH), a Microsoft tool for running scripts written in VBScript or JScript. It automates tasks and interacts with the Windows operating system. Scripts can perform actions like file manipulation, registry changes, or automating applications.

SAP provides an option named SAP recording and playback, using that you can record your clicks/actions and run it again as needed. The file is created in .vbs format. See the steps below to do a recording.

Step 1: Click Script recording and playback

Step 2: Save To

Step 3: Call Transaction IW21 and update few fields.

Step 4: Select Save and you will get a notification on Status bar

Step 5: Select Exit and stop recording

Now, you can analyze your VBScript, open with Notepad. Your code will look like as shown below:

If Not IsObject(application) Then
Set SapGuiAuto = GetObject("SAPGUI")
Set application = SapGuiAuto.GetScriptingEngine
End If
If Not IsObject(connection) Then
Set connection = application.Children(0)
End If
If Not IsObject(session) Then
Set session = connection.Children(0)
End If
If IsObject(WScript) Then
WScript.ConnectObject session, "on"
WScript.ConnectObject application, "on"
End If

session.findById("wnd[0]").maximize
session.findById("wnd[0]/tbar[0]/okcd").text = "IW21"
session.findById("wnd[0]").sendVKey 0
session.findById("wnd[0]/usr/ctxtRIWO00-QMART").text = "M2"
session.findById("wnd[0]/usr/ctxtRIWO00-QMART").caretPosition = 2
session.findById("wnd[0]").sendVKey 0
session.findById("wnd[0]/usr/subSCREE[shortened command...]").text = "My Notification Short Text"
session.findById("wnd[0]/usr/tabsTAB_[shortened command...]").text = "010"
session.findById("wnd[0]/usr/tabsTAB_[shortened command...]").text = "0001"
session.findById("wnd[0]/usr/tabsTAB_[shortened command...]").text = "MAIN"
session.findById("wnd[0]/usr/tabsTAB_[shortened command...]").setFocus
session.findById("wnd[0]/usr/tabsTAB_[shortened command...]").caretPosition = 4
session.findById("wnd[0]/tbar[0]/btn[11]").press
session.findById("wnd[0]/tbar[0]/btn[15]").press

Let’s understand the code and syntax

You can use VB script in both UiPath and Power Automate. In UiPath you can use Invoke VB script and in Power Automate desktop you can use Run VB Script.

While automating, it’s very important to get the ‘GuiTextField’ name accurately and then use it in code.

How to get the ‘GuiTextField’ value?

There are two options:

1. SAP GUI Field Help (F1) and Technical Information

While working within the SAP GUI, pressing F1 on a field opens the Performance Assistant, which provides detailed information about that field. To assess technical details:

• Press F1: While the cursor is in the desired field, press the F1 key.
• Click on "Technical Information": In the Performance Assistant window, click the "Technical Information" button (usually represented by a hammer and wrench icon).
• View Field Details: A new window will display the field's technical name, table, data element, domain, and other relevant technical details. Using Selectors from PAD or UiPath, you can find the GuiTextfield value in attributes.

2. Summary of the benefits of VBScript vs. actions for SAP GUI automation

Prerequisites

• SAP GUI for Windows

• SAP GUI Scripting enabled on application server

• SAP GUI Scripting enabled on client

• Authorization for scripting (parameter: sapgui/user_scripting)

• Windows Script Host enabled

Best Practices for SAP GUI Scripting

• Avoid absolute screen coordinates

• Always reference fields using technical names

• Handle multiple SAP sessions carefully

• Avoid hard-coded delays; prefer wait conditions

• Keep SAP theme consistent across environments

• Use scripting primarily for stable transactions

Conclusion

SAP GUI scripting remains a powerful option for automating legacy SAP systems where APIs or BAPIs are unavailable. When implemented carefully using technical field identifiers and consistent layouts, VBScript-based automation can provide stable and efficient enterprise automation.