robotframework-velo-sapgui 0.2.2

Robot Framework keyword library for SAP GUI automation (Java and Windows)

robotframework-velo-sapgui

Robot Framework keyword library for SAP GUI automation on Java (py4j) and Windows (COM Scripting).

Backends

Backend	Platform	Prerequisites
java	Linux Docker / Mac via Docker	SAP GUI for Java + sapgui-engine gateway on port 8081
windows	Native Windows laptop	Customer-installed SAP GUI for Windows + scripting enabled
auto	Default	windows on win32, java elsewhere

Set Library SapLibrary client=auto or export VELO_SAP_CLIENT=java|windows|auto.

Architecture

.robot suite
    │
    └─► SapLibrary (Python)
              │
              ├─► JavaGatewayBackend ── py4j ──► sapgui-engine ──► SAP GUI for Java
              │
              └─► WindowsScriptingBackend ── COM ──► SAP GUI for Windows

Connection is lazy — resources are opened on the first keyword.

Installation

pip install robotframework-velo-sapgui

# Windows COM backend
pip install "robotframework-velo-sapgui[windows]"

Usage

*** Settings ***
Library    SapLibrary    client=auto    port=8081    recording=True

*** Test Cases ***
Create Sales Order
    Connect             /H/my-sap-host/S/3200
    Type                User        MY_USER
    Type                Password    ${PASSWORD}
    Press Enter
    Open Transaction    VA01
    [Teardown]          Cleanup

Credentials and connection strings live in each suite so multi-role SAP flows can switch users within one test.

Scripting event capture

recording=True captures SAP scripting interaction events (not video) to events.jsonl under $RESULTS_DIR:

{"timestamp": "...", "action": "Type", "element_id": "...", "name": "User", "type": "", "value": "MY_USER", "screen_context": "...", "source": "automation"}

Optional keywords: Start Event Capture, Stop Event Capture, Get Captured Events.

Video MP4 for cloud runs is produced by the execution container (entrypoint.sh), not this library.

Library arguments

Argument	Default	Description
client	auto	SAP client backend: auto, java, or windows
port	8081	Java gateway port (java backend only)
recording	False	Start scripting event capture on first connect

Environment variables

Variable	Description
VELO_SAP_CLIENT	Override client library argument
RESULTS_DIR	Output directory for screenshots and events.jsonl
VELO_EVENTS_PATH	Override path for event capture file

SAP prerequisites

• Server: sapgui/user_scripting = TRUE
• Client: SAP GUI scripting enabled
• Optional: sapgui/user_scripting_disable_recording = 0 (avoid recorder dialog during event capture)

Error handling

• SapConnectionError — backend not reachable or scripting disabled
• SapKeywordError — SAP action failed; message included in RF output