Subscribe

UiPath Studio

The UiPath Studio Guide

Supported SAP WinGUI Elements

The SAP interfaces contain a variety of specific controls with which you can interact as exemplified in this page.

SAP Buttons

Represents any button found in the SAP WinGUI windows. There are several types, each defined by a particular element:

Icons

Icons are interactive buttons which do not display text labels.

Push Buttons

A push button is a simple UI element which gives you direct access to a command in the application.

Radio Buttons

Radio buttons present a set of options. There are at least two radio buttons in a list, and you can only select one.

You can use the Click activity to interact with buttons.

SAP Calendar

The SAP Calendar allows you to select single dates or periods of time.

You can use the Select Dates in Calendar activity to interact with the SAP Calendar.

📘

Note:

This SAP control is not supported by Recording in Studio.

SAP Checkbox

Checkbox elements represent a list of multiple choices. One, more, or no options can be selected.

You can use the Click activity to interact with checkboxes.

SAP Context Menu

Represents a list of items inside a context menu. Note that multiple child context menus can be available in a parent context menu.

You can use the Click activity to interact with the SAP Context Menu. The AA element detection framework is required for interactive selection.

SAP Dialog Box

Represents an external window which can hold different types of other SAP controls such as buttons, text messages, or popup windows.

Selectors inside a dialog box are generated according to the element they represent.

If you want to close a dialog box using the Close button, you need to use the AA element detection framework.

You can use UIAutomation activities such as Click or Type Into to interact with dialog boxes.

SAP Dropdown Lists

Dropdown lists allow you to select items from predefined lists.

You can use the Select Item activity to interact with list items.

SAP HTML Content

The HTML controls are used to display HTML content inside the SAP WinGUI.

To interact with an HTML page inside the SAP WinGUI, you need to use the AA element detection framework. UIAutomation activities can be used to build processes for SAP HTML content.

SAP Input Field

Represents a specialized field which accepts user input.

You can use the Type Into activity to interact with input fields.

SAP Logon

SAP Logon is a locally installed program that you use to directly log on to an SAP system.

You can use the SAP Logon activity to open SAP.

This activity requires 2 parameters:

  • The exact SAP connection name from the SAP Logon or the SAP Logon Pad window used to log on to your SAP system
  • The path to your SAP Logon or SAP Logon Pad program. The default path is obtained from the corresponding system registry entry.

📘

Note:

The Indicate on screen function is not required. The SAP scripting interface is used to connect to your SAP system.

SAP Login

Provides the possibility to log into an SAP system.

You can then use the SAP Login activity.

The Multiple Logon Option dropdown gives you the possibility to decide which action should be performed if a user attempts to log into the system several times and the license information for multiple logon window popups is shown. You can select from the following options:

  • Continue with this logon and end any other logons in system
  • Continue with this logon, without ending any other logons in system
  • Terminate this logon

SAP Menu

Allows you to select items from the SAP Menu. The SAP Menu is only available in the main SAP WinGUI window.

You can use the SAP Select Menu Item activity to interact with a menu item.

📘

Note:

This SAP control is not supported by Recording in Studio.

SAP Picture

Displays a picture in the SAP WinGUI.

You can use the SAP Click Picture on Screen activity to click the specified image.

📘

Note:

This SAP control is not supported by Recording in Studio.

SAP Statusbar

Represents a section at the bottom of the SAP WinGUI window which displays messages. It does not show system and login information.

You can use the SAP Read Statusbar activity to extract the message type, text, and data from the SAP Statusbar.

📘

Note:

This SAP control is not supported by Recording in Studio.

SAP Session Information

Displays detailed information about the current SAP session, such as System, Client, logged User or current opened program and transaction.

The following optional selector attributes are available in UIExplorer, and can be used with other activities such as the Get Attribute activity when you build your SAP automation:
sapClient, sapLanguage, sapProgram, sapScreen, sapSession, sapSysName, sapSysNumber, sapSysSessionId, sapTransaction, sapUser

SAP Tab

SAP Tab represents a set of buttons which let you access specific information and controls.

You can use the Click activity to select a single tab at a time, or you can use the Select Item activity to choose the tab of interest from a list.

Special automation case

Some SAP transactions have slash / in their names, which may lead to identification issues, while using a wildcard in the selector.

For example, in SAP Transaction: /COCKPIT/1, the selector for one of SAP Tab inside the transaction can be:
<sap id='usr/subSUB_MAIN:/COCKPIT/SAPLDISPLAY46:0389/subSUB_HDR:/COCKPIT/SAPLDISPLAY46:04051/tabsG_STRIP_HDR/tabpTAB4' />

The dynamic part of selector is: SAPLDISPLAY46:0389, where the number 0389 is dynamically changing and does not allow a stable identification.

The structure of selector is:

For purpose of stable identification, you would need to use wildcard in between hierarchy separators and then all (and only) the slashes between those separators/slashes need to be replaced by ?

Before <sap id='usr/subSUB_MAIN:/COCKPIT/SAPLDISPLAY46:0389/subSUB_HDR:/COCKPIT/SAPLDISPLAY46:04051/tabsG_STRIP_HDR/tabpTAB4' />
After <sap id='usr/subSUB_MAIN:?COCKPIT?SAPLDISPLAY46:038*/subSUB_HDR:/COCKPIT/SAPLDISPLAY46:04051/tabsG_STRIP_HDR/tabpTAB4' />

SAP Tables

The SAP Table represents a standard set of controls for elements displayed in a tabular structure.

Common Operations

In SAP, there are multiple types of tables available. The most common used are Standard (default) tables, Grid Tables and ALV Tables. All kind of SAP Tables can be automated with Studio.

You can use the following activities to interact with SAP Tables and their content:

SAP Standard Table

The SAP Standard Table supports all of the common operations that are available, as mentioned above.

SAP Grid Table

The SAP Grid Table supports all of the common operations that are available, as mentioned above, as well as Select/Deselect operations and Data Scraping.

Select/Deselect

With help of the Click activity or the Check activity you are able to perform all the necessary operations during your SAP automation project, such as:

  • Select/Deselect Column
  • Select/Deselect Row
  • Select/Deselect All

Data Scraping

Data scraping enables you to extract structured data from SAP Tables, as exemplified below.

In case you are automating a table that contains multiple columns that have the same name, the scraping mechanism automatically increments the column names (e.g. column1, column2, column3, etc.).

The Extract Structure Data activity provides additional possibilities while extracting the data from the SAP GridView table. You can use the following values for the columns_name_source parameter to define the way you want to get the table information:

  • Longest - The full name of column is extracted and used.
  • Shortest - The short name of column is extracted and used.
  • Displayed - The visible/displayed name in SAP WinGUI is used.
  • Technical - The technical header name of the column is extracted and used.
  • Tooltip - The tooltip name which appears after hovering the mouse over a column name.

SAP ALV Table

The SAP ALV Table supports all common operations that are available, as mentioned above, as well as Data Scraping for simple and multiple header tables and Screen Scraping. One or multiple ALV tables on the SAP screen can be extracted.

Data Scraping

This works exactly the same way as mentioned above in Data Scraping for SAP Grid Tables. Pay attention that in some cases, the column tooltip name can be different from the display name in SAP ALV Tables.

Use columns_name_source='Tooltip' parameter to define the right way to get the table information.

Multiple header tables

UiPath Studio can extract the proper data from tables that have headers spread in two or more lines.

To do this, the metadata exposes the following:

join_type = ['LeftOuter' | 'Inner']

These options correspond to the SQL joins with the respective names. Left outer join also extracts rows for which only the first header is present. The other missing column values are populated with a NULL placeholder text: null_value_text = ['(null)' | 'any other user provided value']

Inner join only extracts rows with complete data, ignoring the ones without data for all the headers.

Screen Scraping

In case you decide to use Screen Scraping, the recommended scraping method is FullText, and the Ignore Hidden check box should be selected. Please note that only visible text on the SAP screen is extracted by using this method.

To learn more about Screen scraping, please visit this page.

ColorIndex

The ColorIndex, ColorIntensified, and ColorInverse attributes enable you to identify the background color of elements.

This can be used in both robotic process automation and test automation scenarios.

Attribute Name

Object Type

ColorIndex

int32

ColorIntensified

boolean

ColorInverse

boolean

SAP ALV Hierarchical Table

The SAP ALV Hierarchical Table represents a list of elements organized in a table with hierarchical structure.

You can use the Expand ALV Hierarchical Table activity to identify any cell inside SAP ALV Hierarchical Table. After the identification of the cell, all typical UI activities can be performed, such as Click, Double Click, Get Text, and others.

There are two ways of working with the activity: at design time or at run time.

Design time

During the design time, you have to select any cell of interest inside the table. The activity captures the coordinates of this cell in activity. The changes are possible anytime.

Run time

The target cell is set in focus and the corresponding UiElement is returned as an output argument.

Navigate within the table

For example, I want to get information about the flight time (6:01) for a specific airline (AA) and for a specific flight number (17).

Level / Focused column: defines which element is set as the focused.
Level 0 / Header column: defines which column and value to find in the header column.
Level 1 / Position column: defines which column and value to find in the position column.

The coordinates of cell containing 6:01 are stored as Output value, variable type UiElement.

SAP ALV Tree List

The SAP ALV Tree represents a list of elements organized in a tree structure.

You can use the Expand ALV Tree activity to select an ALV node and display the node path in the activity. This enables you to use any other supported activities to work with the specified element.

SAP Textedit

The SAP Textedit control represents an editable text field/editor.

You can use the following activities to interact with this control:

SAP Toolbar

The SAP Toolbar represents a set of buttons, which you can interact with. In SAP, there are multiple types of toolbars, depending on the SAP Transaction or SAP Program.

  • SAP System Toolbar (1)
  • SAP Application Toolbar (2)
  • SAP Special Toolbar (3)
  • SAP GridTable Toolbar (4)
  • SAP Generic Object Services (5)

You can use the Click Toolbar Button activity to interact with buttons inside the toolbars.

📘

Note:

This SAP control is not supported by Recording in Studio.

SAP Transaction Code

Represents an alphanumerical code which allows you to access SAP functions or running SAP programs.

Only the transaction code is required when you use the SAP Call Transaction activity.

The transaction code is executed in the current SAP GUI window.

📘

Note:

When you provide a transaction code (for example VA01), the activity sends the /nVA01 + Enter (keystroke) command to call a transaction.

Please note that unsaved changes in the current transaction are discarded without warning.

SAP Tree

The SAP Tree represents a list of elements organized in a tree structure. Several types of SAP Tree controls are available:

  • Simple Tree
  • List Tree
  • Column Tree

You can use the Click, Double Click, or the Get Text activity to interact with a node or an item in any of the SAP Tree control types.

📘

Note:

It is recommended to use the SimulateClick property when you interact with SAP Trees.

Expand Tree

If the tree contains a large number of child elements, selection is done as follows:

  1. Expand the tree in SAP WinGUI and select the element of interest.
  2. Use Indicate on screen to select the entire SAP Tree.

The nodes to the selected item are displayed in the activity.

📘

Note:

This SAP control is not supported by Recording in Studio.

If the tree is collapsed and the node or item of interest is not visible, you need to use the SAP Expand Tree activity, which expands the parent tree to an active node or an active item.

Updated 2 months ago

Supported SAP WinGUI Elements


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.