SAP GUI Automation Command Reference Guide

Introduction

This comprehensive reference guide provides detailed documentation for all SAP automation commands available in the ACCELQ platform. These commands are designed to be used within Actions and Scenarios, enabling powerful no-code automation for complex SAP applications.

Each command is highly configurable with intuitive parameters, natural language templates, and context-aware inputs that make building robust SAP test automation accessible to both technical and non-technical users. The commands abstract the complexity of SAP GUI scripting while providing the flexibility needed for comprehensive test coverage.

Quick Note: Element Identification in ACCELQ

ACCELQ provides two powerful approaches for element identification in SAP applications: Label-Based Interaction (zero-maintenance) and Smart Locators (element-based).

The "Locator-Free" or "Label" Approach

ACCELQ's most powerful element identification capability is label-based identification. If a field has a visible text label next to it, use Label-based commands.

Example Commands: Enter text in SAP Input Field with label, Click on a SAP element with label

Note: Commands containing the word "label" indicate a command that uses a locator-free approach for element identification.

Practitioner Tip: This method requires no captured elements in the repository, making your scripts immune to most UI upgrades or technical property changes. Simply type the onscreen label into the command to target the required element.

The "Smart Locator" Approach

For elements that lack text labels—such as toolbar icons, specific table cells, or dropdowns—use the View Capture process. Smart Locators are repository-based element definitions that ACCELQ captures and stores. They contain multiple identifying attributes, making them robust against certain types of UI changes.

Process: Capture the SAP screen using the ACCELQ plugin, right-click the target element, and save it to the Repository. Learn more

Benefits:

• Works for elements without labels
• Centralized maintenance in a Context, and reusable across all Actions belonging to it

Example Command: Click on a SAP UI Element (using the saved element)

Note: Commands containing the word "element" (without "label") indicate a command that uses a smart-locator approach for element identification.

Session & Application Commands

These commands control the SAP application lifecycle, including launching the application, creating sessions, and managing transactions.

Initialize SAP Logon Application

Command: Initialize SAP Logon Application

Statement: Launch SAP Logon app using the executable located at: <SAP Logon exe path>

Starts the SAP Logon app by executing the specified executable.

Parameters:

• SAP Logon exe path (Required) - Executable file path (can be absolute path or relative path from Agent's user_data folder)

Log In to SAP Session

Command: Log In to SAP Session

Statement: Log in to SAP session using <login type>. Connection name: <connection name>

Creates a new SAP session using the specified connection name and logs in using either SSO or login credentials.

Parameters:

• connection name (Required) - Connection name of the target SAP Session
• login type (Required) - Type of login to perform
  • Options: sso login, credentials
• username - Username to use for SAP login (Required when login type is 'credentials')
• password  - Password to use for SAP login (Required when login type is 'credentials')
• client - Client to use for SAP login (Optional when login type is 'credentials')
• language - Language to use for SAP login (Optional when login type is 'credentials')

Note: The parameters username, password, client, and language are conditional based on the selected login type.

Call Transaction in current SAP Session

Command: Call Transaction in current SAP Session

Statement: Execute transaction code <transaction code> in the current SAP session

Executes a specified transaction within the current SAP session.

Parameters:

• transaction code (Required) - The T-Code to execute (e.g., VA01, FB60).

  Note: Passing \n allows the system to navigate back to the previous screen.

Press Keyboard Key on Current SAP Window

Command: Press Keyboard Key on Current SAP Window

Statement: Press <keyboard key> key on currently active SAP window

Presses the specified keyboard key or key combination on the currently active SAP window.

Parameters:

• keyboard key (Required) - Select key to be pressed from the given options. Key combo to be pressed, separated by '+'.
  • Options: Enter, PageUp, PageDown, F1-F12, Ctrl+C, Ctrl+V, Ctrl+X, Ctrl+N, Ctrl+O, Ctrl+S, Ctrl+P, Ctrl+E, Ctrl+F, Ctrl+G, Ctrl+R, Ctrl+Z, Ctrl+/, Ctrl+\, Ctrl+F1-F12, Ctrl+PageUp, Ctrl+PageDown, Shift+F1-F12, Ctrl+Shift+F1-F12, Shift+Ctrl+0

Select Menu in Current SAP Window

Command: Select Menu in Current SAP Window

Statement: Select menu with text: <menu texts> in the current active SAP window

Selects a menu item from the SAP UI menu using the specified texts, separated by semicolons.

Parameters:

• menu texts (Required) - Semicolon-separated path, e.g., System;User Profile;Own Data

Status Information Commands

These commands retrieve status information from the SAP window, useful for validation and conditional logic.

Get Status Message from SAP Window

Command: Get Status Message from SAP Window

Statement: Get the current status message from the SAP window

Retrieves the current status message displayed in the SAP window.

Returns: status message (String) - The current status message text from the SAP window

Get Status Type from SAP Window

Command: Get Status Type from SAP Window

Statement: Get the current status type from the SAP window

Retrieves the current status type (such as success, warning, error) displayed in the SAP window.

Returns: status type (String) - The current status type (e.g., S, W, E)

Get Status Number from SAP Window

Command: Get Status Number from SAP Window

Statement: Get the current status number from the SAP window

Retrieves the current status number displayed in the SAP window.

Returns: status number (String) - The current status number from the SAP window

Locator-Free (Label-Based) Commands

These commands use the locator-free approach, identifying elements by their visible labels on screen. This eliminates the need for element capture and provides zero-maintenance automation that survives UI changes.

Common Parameters for Label-Based Element Commands

Most locator-free commands share a common set of parameters for identifying elements by their labels. These parameters are used across the commands in this section.

label (Required)

The visible text label associated with the element on the screen (e.g., "Submit").

label operator (Required)

Defines the matching criterion used to locate the label on the screen.

• Options: equals, equals ignore case, contains, contains ignore case, starts with, starts with ignore case, ends with, ends with ignore case, matching regex
• Default: equals, ignore case

search area (Required)

Determines whether to search for the label throughout the entire page or only near a specified anchor text.

• Options: anywhere on screen, near given text
• Default: anywhere on screen

anchor text (Optional)

The reference text that serves as the starting point for locating the element. Used only when search area is "near given text". This helps narrow the search area on complex screens. This text must be chosen so it exists top/left of the required element label.

anchor operator (Optional)

Defines the matching criterion used to locate the anchor text on the screen.

• Options: equals, equals ignore case, contains, contains ignore case, starts with, starts with ignore case, ends with, ends with ignore case, matching regex
• Default: equals, ignore case
• Used when: search area is "near given text"

Instance Selection (Index Notation)

When multiple elements match the given label, specify the instance by appending an index value in the format "#n" to the label text (e.g., "Submit#2" to target the second instance of a "Submit" button). To prevent index interpretation for a label that literally includes the "#" sign, prepend a backslash before the hash (e.g., "\#").

Click on a SAP element with label

Command: Click on a SAP element with label

Statement: Click on SAP <elem type>: <label>

Execute a click action on a SAP element identified by its text or label, without the need for specific locators. This command is versatile and can be applied to a variety of desktop SAP elements, including buttons, input fields, combo-boxes, checkboxes, radio buttons, etc.

Parameters:

• elem type (Required) - Identifies the type of the element to be clicked.
  • Options: button/screen-text, checkbox, combobox, input field, radio button
  • Default: button/screen-text
• label, label operator, search area, anchor text, anchor operator - See Common Parameters above

Enter text in SAP Input Field with label

Command: Enter text in SAP Input Field with label

Statement: Enter text in SAP Input Field: <label>. Text to enter: <text>

Types the specified text into an SAP input field identified by its label, without requiring element capture.

Parameters:

• text (Required) - The text value to enter into the field
• label, label operator, search area, anchor text, anchor operator - See Common Parameters above

Get text from SAP Input Field with label

Command: Get text from SAP Input Field with label

Statement: Get text from SAP Input Field: <label>

Retrieves the current text value from an SAP input field identified by its label.

Parameters:

• label, label operator, search area, anchor text, anchor operator - See Common Parameters above

Returns: field text (String) - The current text value from the input field

Select item in SAP ComboBox with label

Command: Select item in SAP ComboBox with label

Statement: Select item in SAP ComboBox: <label>. Item to select (<selection type>): <item>

Selects an item from an SAP ComboBox dropdown identified by its label.

Parameters:

• selection type (Required) - Specifies whether to select by visible text (value) or internal key
  • Options: key, value
  • Default: value
• item (Required) - The key or value of the item to select (based on selection type)
• label, label operator, search area, anchor text, anchor operator - See Common Parameters above

Get selected item from SAP ComboBox with label

Command: Get selected item from SAP ComboBox with label

Statement: Get selected item (<selection type>) from SAP ComboBox: <label>

Retrieves the currently selected item (key or value) from an SAP ComboBox identified by its label.

Parameters:

• selection type (Required) - Specifies whether to retrieve the visible text (value) or internal key
  • Options: key, value
  • Default: value
• label, label operator, search area, anchor text, anchor operator - See Common Parameters above

Returns: selected item (String) - The currently selected key or value from the ComboBox

Set SAP Checkbox with label

Command: Set SAP Checkbox with label

Statement: Set SAP Checkbox: <label> to <state>

Sets an SAP Checkbox to the specified state (checked or unchecked) identified by its label.

Parameters:

• state (Required) - The desired state for the checkbox
  • Options: checked, unchecked
• label, label operator, search area, anchor text, anchor operator - See Common Parameters above

Get SAP Checkbox state with label

Command: Get SAP Checkbox state with label

Statement: Get state of SAP Checkbox: <label>

Retrieves the current state (checked or unchecked) of an SAP Checkbox identified by its label.

Parameters:

• label, label operator, search area, anchor text, anchor operator - See Common Parameters above

Returns: is checked (Boolean) - True if the checkbox is checked, false otherwise

Select SAP Radio Button with label

Command: Select SAP Radio Button with label

Statement: Select SAP Radio Button: <label>

Selects an SAP Radio Button identified by its label.

Parameters:

• label, label operator, search area, anchor text, anchor operator - See Common Parameters above

Get SAP Radio Button state with label

Command: Get SAP Radio Button state with label

Statement: Get state of SAP Radio Button: <label>

Retrieves the current selection state of an SAP Radio Button identified by its label.

Parameters:

• label, label operator, search area, anchor text, anchor operator - See Common Parameters above

Returns: is selected (Boolean) - True if the radio button is selected, false otherwise

SAP Table Commands (Locator-Free)

These commands provide comprehensive table interaction capabilities using the locator-free approach. Tables can be identified by index or nearby text.

Common Parameters for Table Identification

All table commands in this section share common parameters for identifying tables without requiring element capture.

table id type (Required)

How to identify the table.

• Options: index, nearby text

table index (Optional)

Index to identify the required table. First table on the page is assigned an index value of 1. This value is determined by the table's relative location measured from the upper-left corner of the page.

• Used when: table id type is "index"

nearby text (Optional)

Nearby anchor text (upper or left) to uniquely identify the SAP table.

• Used when: table id type is "nearby text"

nearby text operator (Optional)

Operator used as matching criterion for specifying the nearby text.

• Options: equals, equals ignore case, contains, contains ignore case, starts with, starts with ignore case, ends with, ends with ignore case, matching regex
• Default: equals, ignore case
• Used when: table id type is "nearby text"

Note: Row and column numbering starts from 1 for all table commands.

Click on cell in SAP Table

Command: Click on cell in SAP Table

Statement: Click on cell at row <row number> and column (<column id type>) <column> in SAP Table

Clicks on a specific cell in an SAP Table identified by its index or nearby anchor text.

Parameters:

• table id type, table index, nearby text, nearby text operator - See Common Parameters above
• row number (Required) - Row number of the cell to click (starts at 1)
• column id type (Required) - How to identify the column
  • Options: column number, column name
• column number (Optional) - Column number (starts at 1) when column id type is 'column number'
• column name (Optional) - Column name when column id type is 'column name'

Double-click on cell in SAP Table

Command: Double-click on cell in SAP Table

Statement: Double-click on cell at row <row number> and column (<column id type>) <column> in SAP Table

Double-clicks on a specific cell in an SAP Table.

Parameters:

• table id type, table index, nearby text, nearby text operator - See Common Parameters above
• row number (Required) - Row number of the cell (starts at 1)
• column id type (Required) - How to identify the column
  • Options: column number, column name
• column number (Optional) - Column number when using 'column number'
• column name (Optional) - Column name when using 'column name'

Enter text in SAP Table cell

Command: Enter text in SAP Table cell

Statement: Enter text in SAP Table cell at row <row number> and column (<column id type>) <column>. Text: <text>

Enters text into a specific cell in an SAP Table.

Parameters:

• table id type, table index, nearby text, nearby text operator - See Common Parameters above
• row number (Required) - Row number of the cell (starts at 1)
• column id type (Required) - How to identify the column
  • Options: column number, column name
• column number (Optional) - Column number when using 'column number'
• column name (Optional) - Column name when using 'column name'
• text (Required) - The text to enter into the cell

Get text from SAP Table cell

Command: Get text from SAP Table cell

Statement: Get text from SAP Table cell at row <row number> and column (<column id type>) <column>

Retrieves the text value from a specific cell in an SAP Table.

Parameters:

• table id type, table index, nearby text, nearby text operator - See Common Parameters above
• row number (Required) - Row number of the cell (starts at 1)
• column id type (Required) - How to identify the column
  • Options: column number, column name
• column number (Optional) - Column number when using 'column number'
• column name (Optional) - Column name when using 'column name'

Returns: cell text (String) - The text value from the specified table cell

Select row in SAP Table

Command: Select row in SAP Table

Statement: Select row <row number> in SAP Table

Selects a specific row in an SAP Table by row number.

Parameters:

• table id type, table index, nearby text, nearby text operator - See Common Parameters above
• row number (Required) - Row number to select (starts at 1)

Find row containing text in SAP Table

Command: Find row containing text in SAP Table

Statement: Find row in SAP Table where column (<column id type>) <column> (<matching criteria>): <text>

Finds and returns the row number of the first row in an SAP Table that contains the specified text in a given column.

Parameters:

• table id type, table index, nearby text, nearby text operator - See Common Parameters above
• column search type (Required) - How to specify which column to search
  • Options: any column, column number, column name
• column number (Optional) - Column number when search type is 'column number'
• column name (Optional) - Column name when search type is 'column name'
• matching criteria (Required) - Text matching criterion
  • Options: equals, equals ignore case, contains, contains ignore case, starts with, starts with ignore case, ends with, ends with ignore case, matching regex
  • Default: equals, ignore case
• text (Required) - The text to search for in the specified column

Returns: row number (String) - The row number of the first matching row, or empty if not found

Get row count in SAP Table

Command: Get row count in SAP Table

Statement: Get row count in SAP Table

Retrieves the total number of rows in an SAP Table.

Parameters:

• table id type, table index, nearby text, nearby text operator - See Common Parameters above

Returns: row count (String) - The total number of rows in the table

Get column names in SAP Table

Command: Get column names in SAP Table

Statement: Get column names in SAP Table

Retrieves all column names from an SAP Table as a JSON array.

Parameters:

• table id type, table index, nearby text, nearby text operator - See Common Parameters above

Returns: column names (String) - JSON array of column names, e.g., ["Column1", "Column2", "Column3"]

Smart Locator (Element-Based) Commands

These commands work with SAP elements captured in the ACCELQ repository using the View Capture process. They provide robust identification using multiple attributes and are ideal for elements without visible labels.

Click on a SAP UI Element

Command: Click on a SAP UI Element

Statement: Click on <SAPElement> SAP UI element

Clicks on a given SAP UI element that has been captured in the repository.

Parameters:

• SAPElement (Required) - The SAP UI element from the repository to click on

Select Context Menu Item from SAP UI Toolbar/Shell

Command: Select Context Menu Item from SAP UI Toolbar/Shell

Statement: Select the context menu item <context menu item> from the SAP UI Toolbar/Shell element <SAPElement>

Selects the specified context menu item by its text from the SAP UI toolbar or shell.

Parameters:

• SAPElement (Required) - The SAP UI Toolbar/Shell element from the repository
• context menu item (Required) - Text of the context menu item to select

Enter text in SAP UI Element

Command: Enter text in SAP UI Element

Statement: Enter text <text> in the SAP UI element <SAPElement>

Enters the specified text into a SAP UI input element from the repository.

Parameters:

• SAPElement (Required) - The SAP UI input element from the repository
• text (Required) - The text to enter into the element

Get text from SAP UI Input Element

Command: Get text from SAP UI Input Element

Statement: Get text from the SAP UI input element <SAPElement>

Returns the text from the given SAP UI input element.

Parameters:

• SAPElement (Required) - The SAP UI input element from the repository

Returns: elem text (String) - Text from the given SAP UI element

Select item in SAP UI ComboBox

Command: Select item in SAP UI ComboBox

Statement: Select item (<selection type>) <item> in the SAP UI ComboBox element <SAPElement>

Selects an item from a SAP UI ComboBox element by key or value.

Parameters:

• SAPElement (Required) - The SAP UI ComboBox element from the repository
• selection type (Required) - The type of identifier to use for selection
  • Options: key, value
  • Default: value
• item (Required) - The key or value of the item to select

Get selected item from SAP UI ComboBox Element

Command: Get selected item from SAP UI ComboBox Element

Statement: Get currently selected item (<selection type>) of the SAP UI ComboBox element <SAPElement>

Returns the key/value of the currently selected item from the specified SAP UI ComboBox element.

Parameters:

• SAPElement (Required) - The SAP UI ComboBox element from the repository
• selection type (Required) - The type of property to retrieve for the currently selected item
  • Options: key, value
  • Default: value

Returns: selected item (String) - The currently selected key/value from the specified SAP UI ComboBox element

Check/Uncheck a SAP UI Checkbox

Command: Check/Uncheck a SAP UI Checkbox

Statement: Set the SAP UI Checkbox element <SAPElement> to <state> state

Sets the SAP UI Checkbox to given checked or unchecked state.

Parameters:

• SAPElement (Required) - The SAP UI Checkbox element from the repository
• state (Required) - State to set (check or uncheck)
  • Options: checked, unchecked

Is a SAP UI Checkbox Element checked

Command: Is a SAP UI Checkbox Element checked

Statement: Is the SAP UI Checkbox element <SAPElement> in checked state?

Determines if the specified SAP UI Checkbox element is in the checked state. Note that this is just for verification and it does not fail the test execution.

Parameters:

• SAPElement (Required) - The SAP UI Checkbox element from the repository

Returns: is checked (Boolean) - True if the SAP UI Checkbox element is checked, otherwise false

Select a SAP UI Tab Element

Command: Select a SAP UI Tab Element

Statement: Select SAP UI Tab Button element <SAPElement>

Selects the given SAP UI Tab button element.

Parameters:

• SAPElement (Required) - The SAP UI Tab element from the repository

Is SAP UI Element exists

Command: Is SAP UI Element exists

Statement: Does SAP UI element <SAPElement> exist?

Determines if the given SAP UI element exists on the screen. Note that this is just for verification and it does not fail the test execution.

Parameters:

• SAPElement (Required) - The SAP UI element from the repository

Returns: is exists (Boolean) - True if the SAP UI element exists on screen, otherwise false

Wait for SAP UI Element to appear

Command: Wait for SAP UI Element to appear

Statement: Wait up to <N> seconds for SAP UI element <SAPElement> to appear. If timed out, <failure action>

Test execution waits for a SAP UI element to appear. Maximum wait time is limited by the timeout specified for the command. You may choose to ignore or give an error in case the command times out without success. You may also abort the test case completely.

Parameters:

• SAPElement (Required) - The SAP UI element from the repository to wait for
• N (Required) - Number of seconds to wait
  • Default: 30
• failure action (Required) - Action to take if timeout occurs
  • Options: report as info, report as error, abort test case
  • Default: report as error

SAP Table Commands (Smart Locator)

These commands provide table interaction capabilities for SAP UI Table elements captured in the repository.

Note: Row number and column number starts from 1 for all table commands in this section.

Click a cell in SAP UI Table

Command: Click a cell in SAP UI Table

Statement: Click the cell at row number <row number> and <column id type> <column> of the SAP UI Table <SAPElement>

Clicks the specified cell in an SAP UI Table element.

Parameters:

• SAPElement (Required) - The SAP UI Table element from the repository
• row number (Required) - Row number of the SAP UI table cell to click (starts at 1)
• column id type (Required) - How to identify the column
  • Options: column id, column number
• column number (Optional) - Column number when using 'column number' (starts at 1)
• column id (Optional) - Column id when using 'column id'

Double click a cell in SAP UI Table

Command: Double click a cell in SAP UI Table

Statement: Double click the cell at row number <row number> and <column id type> <column> of the SAP UI Table <SAPElement>

Double clicks the specified cell in an SAP UI Table element.

Parameters:

• SAPElement (Required) - The SAP UI Table element from the repository
• row number (Required) - Row number of the SAP UI table cell to double-click (starts at 1)
• column id type (Required) - How to identify the column
  • Options: column id, column number
• column number (Optional) - Column number when using 'column number' (starts at 1)
• column id (Optional) - Column id when using 'column id'

Get text from cell in SAP UI Table

Command: Get text from cell in SAP UI Table

Statement: Get text from the cell at row number <row number> and <column id type> <column> of the SAP UI Table <SAPElement>

Retrieves the text from the specified cell in an SAP UI Table element.

Parameters:

• SAPElement (Required) - The SAP UI Table element from the repository
• row number (Required) - Row number of the SAP UI table cell (starts at 1)
• column id type (Required) - How to identify the column
  • Options: column id, column number
• column number (Optional) - Column number when using 'column number' (starts at 1)
• column id (Optional) - Column id when using 'column id'

Returns: cell text (String) - Text from the specified SAP UI table cell

Enter text in cell of SAP UI Table

Command: Enter text in cell of SAP UI Table

Statement: Enter text <text> in the cell at row number <row number> and <column id type> <column> of the SAP UI Table <SAPElement>

Enters the specified text into a cell in an SAP UI Table element.

Parameters:

• SAPElement (Required) - The SAP UI Table element from the repository
• row number (Required) - Row number of the SAP UI table cell (starts at 1)
• column id type (Required) - How to identify the column
  • Options: column id, column number
• column number (Optional) - Column number when using 'column number' (starts at 1)
• column id (Optional) - Column id when using 'column id'
• text (Required) - The text to enter into the table cell

Select row in SAP UI Table

Command: Select row in SAP UI Table

Statement: Select row number <row number> of the SAP UI Table <SAPElement>

Selects the specified row in an SAP UI Table element.

Parameters:

• SAPElement (Required) - The SAP UI Table element from the repository
• row number (Required) - Row number to select (starts at 1)

Find row containing given text in SAP UI Table

Command: Find row containing given text in SAP UI Table

Statement: Find row number with matching text in <column type> <column> (<cell value operator>): <cell value> of SAP UI Table <SAPElement>

Returns the first row index of an SAP UI table containing given text.

Parameters:

• SAPElement (Required) - The SAP UI Table element from the repository
• column type (Required) - Indicate how the required row should be identified by the type of column value
  • Options: any column, column number, column name
• column number (Optional) - Column number when type is 'column number' (starts at 1)
• column name (Optional) - Column name when type is 'column name'
• cell value operator (Required) - Matching criteria for the text to look for and find the row number
  • Options: equals, equals ignore case, contains, contains ignore case, starts with, starts with ignore case, ends with, ends with ignore case, matching regex
  • Default: equals, ignore case
• cell value (Required) - Value of the SAP table cell that you want to find

Returns: row num (String) - First row index of the SAP UI table matching the given text

Get row count of SAP UI Table

Command: Get row count of SAP UI Table

Statement: Get row count of the SAP UI Table <SAPElement>

Returns the total number of rows in an SAP UI Table element.

Parameters:

• SAPElement (Required) - The SAP UI Table element from the repository

Returns: row count (String) - Total number of rows in the SAP UI Table

Get column count of SAP UI Table

Command: Get column count of SAP UI Table

Statement: Get column count of the SAP UI Table <SAPElement>

Returns the total number of columns in an SAP UI Table element.

Parameters:

• SAPElement (Required) - The SAP UI Table element from the repository

Returns: column count (String) - Total number of columns in the SAP UI Table

Best Practices

• Prefer Locator-Free commands whenever elements have visible labels—they require no maintenance and are immune to most UI changes.
• Use Smart Locator commands for elements without labels (toolbar icons, specific table cells, etc.).
• Use anchor text to narrow search areas and improve performance when working with complex screens.
• Take advantage of flexible matching operators (contains, starts with, regex) for more resilient element identification.
• For tables, prefer identifying by column name over column number for better maintainability.
• Use index notation (#n) when multiple elements share the same label to target specific instances.