SAP GUI Library

Performs a single click on a given element. Used only for buttons, tabs and menu items.

Arguments

In case you want to change a value of an element like checkboxes of selecting an option in dropdown lists, use select checkbox or select from list by label instead.

Clicks a button of a toolbar within a GridView 'table_id' which is contained within a shell object. Use the Scripting tracker recorder to find the 'button_id' of the button to click

Arguments

Connects to an open connection. If the connection matches the given connection_name, the session is connected to this connection.

Arguments

Connects to an open session SAP.

Arguments

See Opening a connection / Before running tests for details about requirements before connecting to a session.

Optionally set explicit wait can be used to set the explicit wait time.

Examples:

Disables automatic screenshots on error.

Performs a double-click on a given element. Used only for shell objects.

Arguments

Checks whether an element is present on the screen.

Arguments

Checks whether the element value is the same as the expected value. The possible expected values depend on the type of element (see usage).

Arguments

Usage:

Checks whether the element value contains the expected value. The possible expected values depend on the type of element (see usage).

Arguments

Usage:

Enables automatic screenshots on error.

Returns the cell value for the specified cell.

Arguments

Returns the Sap element location for the given element.

Arguments

Returns the Sap element type for the given element.

Arguments

Returns the number of rows found in the specified table.

Arguments

Returns the scroll position of the scrollbar of an element 'element_id' that is contained within a shell object.

Arguments

Gets the value of the given element. The possible return values depend on the type of element (see Return values).

Arguments

Return values:

Retrieves the window title of the given window.

Arguments

Inserts the given password into the text field identified by locator. The password is not recorded in the log.

Arguments

Inserts the given text into the text field identified by locator. Use keyword input password to insert a password in a text field.

Arguments

Maximizes the SapGui window.

Arguments

Opens a connection to the given connection name. Be sure to provide the full connection name, including the bracket part.

Arguments

Runs a Sap transaction. An error is given when an unknown transaction is specified.

Arguments

Scrolls the scrollbar of an element 'element_id' that is contained within a shell object. 'Position' is the number of rows to scroll.

Arguments

Selects checkbox identified by locator. Does nothing if the checkbox is already selected.

Arguments

Selects an item from the context menu by clicking a button or right-clicking in the node context menu.

Arguments

Selects the specified option from the selection list.

Arguments

Selects a node of a TableTreeControl 'tree_id' which is contained within a shell object.

Arguments

Use the Scripting tracker recorder to find the 'node_id' of the node. Expand can be set to True to expand the node. If the node cannot be expanded, no error is given.

Selects a link of a TableTreeControl 'tree_id' which is contained within a shell object.

Arguments

Use the Scripting tracker recorder to find the 'link_id1' and 'link_id2' of the link to select.

Sets radio button to the specified value.

Arguments

Selects an entire column of a GridView 'table_id' which is contained within a shell object.

Arguments

Use the Scripting tracker recorder to find the 'column_id' of the column to select.

Selects an entire row of a table. This can either be a TableControl or a GridView 'table_id' which is contained within a shell object. The row is an index to select the row, starting from 0.

Arguments

Sends a SAP virtual key combination to the window, not into an element. If you want to send a value to a text field, use input text instead.

Arguments

To send a vkey, you can either use te VKey ID or the Key combination.

Sap Virtual Keys (on Windows)

Examples:

Sets the cell value for the specified cell of a GridView 'table_id' which is contained within a shell object.

Arguments

Use the Scripting tracker recorder to find the 'col_id' of the cell to set.

Sets the delay time that is waited after each SapGui keyword.

Arguments

The value can be given as a number that is considered to be seconds or as a human-readable string like 1 second or 700 ms.

This functionality is designed to be used for demonstration and debugging purposes. It is not advised to use this keyword to wait for an element to appear or function to finish.

Possible time formats:

Example:

Sets the focus to the given element.

Arguments

Takes a screenshot, only if 'screenshots on error' has been enabled, either at import of with keyword enable screenshots on error.

Arguments

This keyword uses Robots' internal Screenshot library.

Removes selection of checkbox identified by locator. Does nothing if the checkbox is not selected.

Arguments