sap-webgui

SAP WebGUI — UI Mechanics and Locator Rules

For bounded, self-contained support work, use sap-task-helper with explicit inputs, allowed writes, and an output contract.

Non-negotiable execution gate

The abapfs_run_playwright_tests tool verifies the workflow artifacts produced from WebGUI exploration and will reject affected cases when required screen mappings or script checks are missing. Do not guess locators or skip live verification.

Related workflows

Apply the guidance below for WebGUI mechanics and pitfalls. When the task also requires another workflow:

• follow analyze-and-plan for code coverage, explore-ui for _screens.md, and design-cases for test cases;
• follow sap-webgui-recording to decide when and how to obtain a focused user recording;
• follow build-scripts to translate a case into code;
• follow helpers-reference for exact SapSession/SapArtifacts methods and signatures.

Labels versus IDs

SAP WebGUI DOM IDs, generated reference numbers, row indexes, and CSS class suffixes can change across sessions, themes, support-package levels, and screen rerenders. Do not use them as test contracts.

Prefer, in order:

1. semantic role + exact accessible name;
2. role/name scoped to a verified dialog or group;
3. stable title or aria-label for toolbar controls;
4. visible cell text for grids;
5. sap.setGridCell(columnTitle, rowIndex, value) for editable ALV cells whose inputs have no accessible name (see “Editable ALV grid cells” below);
6. { technicalName: "<ABAP_FIELD>" } on sap.setField(...) when two visible fields share the same label — last-resort disambiguator via the SAP data-dictionary name inside lsdata (see “The lsdata attribute” below);
7. a narrowly-contained sap.raw() locator using role/name when no helper fits.

The on-screen label and DOM accessible name are often—but not always—the same. Exploration must record both when they differ. English UI language is required because labels are part of the locator contract.