API Reference

SAP GUI for Windows

SAP GUI automation via SAP GUI Scripting COM. Requires SAP GUI for Windows with scripting enabled.

SapGui

Full signatures for dolphin_desktop._sap.SapGui are generated from the package docstrings — use help() in Python or autocomplete in your IDE.

SapConnection

Full signatures for dolphin_desktop._sap.SapConnection are generated from the package docstrings — use help() in Python or autocomplete in your IDE.

SapSession

Full signatures for dolphin_desktop._sap.SapSession are generated from the package docstrings — use help() in Python or autocomplete in your IDE.

SapLocator

Full signatures for dolphin_desktop._sap.SapLocator are generated from the package docstrings — use help() in Python or autocomplete in your IDE.

Quick reference

from dolphin_desktop import SapGui

sap = SapGui.connect()
session = sap.session()

session.transaction("SE16")
session.find_by_id("wnd[0]/usr/ctxtDATABROWSE-TABLENAME").set_text("T000")
session.find_by_id("wnd[0]/tbar[1]/btn[8]").click()

assert session.find_by_id("wnd[0]/sbar").text() is not None

See the SAP GUI guide for usage notes and requirements.