SAP GUI Automation Actions

SAP GUI Automation is a key feature in Zoho RPA that allows you to automate UI interactions with SAP-based applications. There are many organizations that use and depend on SAP applications. All those human actions of reading data to and from SAP applications can be automated by RPA Software. The actions that could be automated are described in detail in this guide.

Supported Version: SAP WinGUI 8.00

Supported Platforms: SAP S/4HANA , SAP ECC

Important Note : To perform SAP GUI automation, scripting needs to be enabled on BOTH the SAP Server and Client. Learn more.

Available Actions

Connect to SAP

This action allows you to connect to a SAP system using the provided server and credentials.

Configuration

SAP Instance: The SAP instance name.

Connection type: Specify the connection type as existing or SAP GUI.

Existing: Select this option to use the current existing connection.

SAP GUI: Select this option to use the new SAP GUI connection.

Note: The SAP GUI connection has to be created in the SAP instance and the details of that connection has to be mentioned here.

Instance path: Enter the instance path.

Connection name: Enter the connection name.

Client: Enter the client number.

Username: Enter the user name.

Password: Enter the password.

Click

Allows the RPA bot to click on buttons, links, menus, or any other clickable elements within a SAP application's user interface.

Configuration

UI element: The UI element to click on.

SAP instance: Choose the SAP instance.

Element path ID: Enter the element path ID.

Click Type: Specify the type of click, whether it is a single click, double click, or right-click.

Set text

Allows to set a string value to the text attribute of a specified SAP UI element.

Configuration

UI element: The UI element that you want to set text for.

SAP instance: Choose the SAP instance.

Variable name: The variable name will be auto filled (can be changed if needed) that will be used in other tasks as and when needed.

Element path ID: Enter the element path ID.

Set text: The text to be entered into the input field.

When the input field already has text: If there is existing text in the input field, determine how to handle it.

If we need to replace or add to the existing text.

Replace text - Replace the existing text with the new text.
Append text - Add the given text to the existing text.

Get text

Extracts text from various parts of a SAP application's interface, such as labels, text boxes, or tables.

Configuration

UI element: The UI element that you want to extract text from.

SAP instance: Choose the SAP instance.

Variable name: The variable name will be auto filled (can be changed if needed) that will be used in other tasks as and when needed.

Element path ID: Enter the element path ID.

Set checkbox

Selects or clears checkboxes or toggle switches in a SAP application's user interface.

Configuration

UI element: The UI Element for which you want to set a checkbox value.

SAP instance: Choose the SAP instance.

Variable name: The variable name will be auto filled (can be changed if needed) that will be used in other tasks as and when needed.

Element path ID: Enter the element path ID.

Checkbox value: The value that should be assigned for the checkbox field, that is check, uncheck or toggle.

Select item

Selects an item from a SAP applications, drop-down box or list box by value or index.

Configuration

UI element: The UI element that you want to select

SAP instance: Choose the SAP instance.

Element path ID: Enter the element path ID.

Operation: Specify if the select item is by value or by index.

List item value: The specific value of the list item you want to select.

Extract table data

Extracts tabular data from a SAP grid or table control.

Configuration

UI element: The UI element to click on.

SAP instance: Choose the SAP instance.

Variable name: The variable name will be auto filled (can be changed if needed) that will be used in other tasks as and when needed.

Element path ID: Enter the element path ID.

Use the output data in subsequent cloud app actions or custom function?: Choose Yes if you want to use the data read from the table in your cloud app actions or in a custom function in the same flow.

Data columns to extract: Specify which data columns to extract from the table

All columns: Extract all data columns from the identified table.
Include specific columns: Extract only the specified columns. Enter the column numbers separated by commas (e.g., 1,3,5). The first column is 1.
Exclude specific columns: Skip the specified columns during data extraction. Enter the column numbers to exclude, separated by commas (e.g.: 2, 7).

Number of data rows to extract

Specify the number of data rows you want to extract from the table, starting from the first row.

If no value is set, all available data rows will be extracted.
To extract a specific number of initial rows, enter that number (e.g., 10).
If the specified number exceeds the total number of rows, all available rows will be extracted.
Example: If a table has 15 rows and you specify 20, all 15 available rows will be extracted.

Select tree node

Selects a specified node in a SAP tree control.

Configuration

UI element: The UI element to click on.

SAP instance: Choose the SAP instance.

Element path ID: Enter the element path ID.

Tree node path: Enter the tree node path.

Click Type: Specify the type of click, whether it is a single click, double click, or right-click.

Select radio button

Selects a radio button in the SAP application.

Configuration

UI element: The specific radio button you want to select.

SAP instance: Choose the SAP instance.

Element path ID: Enter the element path ID.

Send hot keys

Sends a keyboard shortcut or hot key combinations to the SAP application.

Configuration

UI element:The specific UI element to which the hotkey will be sent.

SAP instance: Choose the SAP instance.

Element path ID: Enter the element path ID.

Virtual key: Choose the hotkey combination that you want to use from the drop-down list.

Type into

Sends keystrokes or simulates typing keyboard input into a specified SAP input field.

Configuration

UI element: Specify the UI element, such as an input field or text area, where you want to enter the text.

SAP instance: Choose the SAP instance.

Element path ID: Enter the element path ID.

Input text: Enter the text you want to type into the field

Insert keys: Use this option to include special keys like Enter, Tab, Esc and Shift+Enter within the input text.

When the input field already has text: Lets you choose how to handle existing text in the input field.

Replace text: Replace the existing text with the new text.
Append text: Add the new text to the end of the existing text.

Click before typing: Use this option to ensure the UI element is active before attempting to type.

Delay between keystrokes (in ms): Set the desired time delay (in milliseconds) between each keystroke to simulate a more natural typing pace.

Check if element exists

Verifies if a specified SAP UI element exists on the current screen.

Configuration

UI element: Specify the UI element you want to check.

SAP instance: Choose the SAP instance.

Variable name: The variable name will be auto filled (can be changed if needed) that will be used in other tasks as and when needed.

Element path ID: Enter the element path ID.

Check if application: Check if the application contains the element or a text.

Text: Enter the text you want to search for.

Disconnect from SAP

Automate the closure of the active SAP application to free up system resources.

Configuration

SAP instance: Choose the SAP instance.

Delay Settings

Delay settings allow you to configure a delay for an action. This option ensures that the actions do not fail due to loading or UI elements not present on the screen. Sometimes UI elements take time or display or load on the application so a delay may be required.

Delay before action (Time in ms): The amount of time to wait before performing the action.

Delay after action (Time in ms): The amount of time to wait after performing the action.

Wait for element (Time in ms): The amount of time to wait for an element to appear before performing the action. The distinction between wait before action and wait for element is that wait before action will wait for the specified amount of time before beginning the activity. The wait for element is the amount of time spent waiting during the action. For instance, displaying options in a dropdown field may take a few seconds.