Module - SAP GUI
Collection of activities related to SAP GUI for Windows. SAP GUI is the Windows full client frontend for accessing SAP ECC. The following activities are designed to work seamlessly with the SAP GUI objects such as fields, buttons...
Class GuiVComponent
Activities :
Retrieve the name of an icon within a SAP GUI Frame Window.
| Technical Name |
Type |
Minimal Agent Version |
| getIconName |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| iconName |
string |
Returns the icon name. |
Sample Code:
const name = await SAPLogon750App.pSAPEasyAccess.oItem.getIconName();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Execute a custom action from SAP GUI Scripting API documentation
| Technical Name |
Type |
Minimal Agent Version |
| custom |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| actionName |
string |
|
Provide an SAP GUI action name (Eg. exec_Press, set_Text, etc). |
| paramA |
string |
optional
|
Parameter 1 for Custom Action. |
| paramB |
string |
optional
|
Parameter 2 for Custom Action. |
| paramC |
string |
optional
|
Parameter 3 for Custom Action. |
| paramD |
string |
optional
|
Parameter 4 for Custom Action. |
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Result of the action. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.oItem.custom("set_Text", "APOR");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
Class GuiComponent
No specific activities for this class.
Class GuiContainer
No specific activities for this class.
Class GuiVContainer
No specific activities for this class.
Class GuiItem
No specific activities for this class.
Class GuiApplication
| Extends |
Technologies of the class |
| irpa_core.core.Application |
SAPGUI |
No specific activities for this class.
No specific activities for this class.
| Extends |
Technologies of the class |
| irpa_core.core.ScrollBar |
SAPGUI |
No specific activities for this class.
Class GuiConnection
No specific activities for this class.
Class GuiSession
Subset of activities related to SAP GUI Session. Use to Start or End a transaction or simply create a Session. Retrieve contextual information related to the User Session which can be useful when designing an automation.
| Extends |
Technologies of the class |
| irpa_core.core.Screen |
SAPGUI |
Activities :
| Start Transaction (GUI Session) |
Start a transaction by moving to a new screen.
| Technical Name |
Type |
Minimal Agent Version |
| startTransaction |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| transactionCode |
string |
|
Code of the transaction. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if the transaction starts by moving to a new screen, false if it does not. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.startTransaction(transactionId);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter transactionCode. |
| End Transaction (GUI Session) |
End a transaction by coming back to the previous screen.
| Technical Name |
Type |
Minimal Agent Version |
| endTransaction |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if the transaction ends by coming back to a previous screen, false if it does not. |
Sample Code:
await SAPLogon750App.pDisplaySalesDocument.endTransaction();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Create Session (GUI Session) |
Create a new SAP GUI Session (it will trigger a new main window).
| Technical Name |
Type |
Minimal Agent Version |
| createSession |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if the new session is created, false if not. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.createSession();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
Check whether SAP GUI is busy or not. Use this function before performing an action. This function is available at a screen and at an element level.
| Technical Name |
Type |
Minimal Agent Version |
| isSAPGuiBusy |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if SAP GUI is busy, false if not. |
Sample Code:
var sH = await SAPLogon750.pTCURRDisplayOfEnt.isSAPGuiBusy(); var sW = await SAPLogon750.pTCURRDisplayOfEnt.btExit.isSAPGuiBusy();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Get System Name (GUI Session) |
Retrieve the system name from a SessionInfo.
| Technical Name |
Type |
Minimal Agent Version |
| getSystemName |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| systemName |
string |
Returns the system name of SAP GUI session. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.getSystemName(); await SAPLogon750App.pSAPEasyAccess.oItem.getSystemName();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Get App Server Details (GUI Session) |
Retrieve details of an application server from a SessionInfo.
| Technical Name |
Type |
Minimal Agent Version |
| getApplicationServer |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| server |
string |
Returns the application server details of SAP GUI session. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.getApplicationServer(); await SAPLogon750App.pSAPEasyAccess.oItem.getApplicationServer();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Get Client Name (GUI Session) |
Retrieve a client name from a SessionInfo.
| Technical Name |
Type |
Minimal Agent Version |
| getClientName |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| clientName |
string |
Returns the client name of SAP GUI session. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.getClientName(); await SAPLogon750App.pSAPEasyAccess.oItem.getClientName();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Get User Name (GUI Session) |
Retrieve a user name from a SessionInfo.
| Technical Name |
Type |
Minimal Agent Version |
| getUserName |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| userName |
string |
Returns the user name of SAP GUI session. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.getUserName(); await SAPLogon750App.pSAPEasyAccess.oItem.getUserName();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Get Transaction Details (GUI Session) |
Retrieve the details of a transaction from a SessionInfo.
| Technical Name |
Type |
Minimal Agent Version |
| getTransaction |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| transaction |
string |
Returns the current transaction of SAP GUI session. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.getTransaction(); await SAPLogon750App.pSAPEasyAccess.oItem.getTransaction();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Get Programs Details (GUI Session) |
Retrieve a list of installed programs from a SessionInfo. The activity collects the list of installed programs (as listed in the 'Programs and Features' Control Panel) and stores it in the 'programs' attribute of the object provided in the argument.
| Technical Name |
Type |
Minimal Agent Version |
| getProgram |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| program |
string |
Returns the list of installed programs of SAP GUI session. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.getProgram(); await SAPLogon750App.pSAPEasyAccess.oItem.getProgram();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Get Screen Number (GUI Session) |
Retrieve a screen number from a SessionInfo.
| Technical Name |
Type |
Minimal Agent Version |
| getScreenNumber |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| screenNumber |
string |
Returns the screen number of SAP GUI session. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.getScreenNumber(); await SAPLogon750App.pSAPEasyAccess.oItem.getScreenNumber();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Get System Number (GUI Session) |
Retrieve a system number from a SessionInfo.
| Technical Name |
Type |
Minimal Agent Version |
| getSystemNumber |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| systemNumber |
string |
Returns the system number of SAP GUI session. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.getSystemNumber(); await SAPLogon750App.pSAPEasyAccess.oItem.getSystemNumber();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Get Session Number (GUI Session) |
Retrieve a session number from a SessionInfo.
| Technical Name |
Type |
Minimal Agent Version |
| getSessionNumber |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| sessionNumber |
string |
Returns the session number of SAP GUI session. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.getSessionNumber(); await SAPLogon750App.pSAPEasyAccess.oItem.getSessionNumber();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
Class GuiModalWindow
No specific activities for this class.
Class GuiMessageWindow
| Extends |
Technologies of the class |
| irpa_core.core.Screen |
SAPGUI |
No specific activities for this class.
Class GuiTextEdit
| Extends |
Technologies of the class |
| irpa_core.core.Edit |
SAPGUI |
No specific activities for this class.
Class GuiHTMLViewer
No specific activities for this class.
No specific activities for this class.
Class GuiCheckBox
| Extends |
Technologies of the class |
| irpa_core.core.CheckBox |
SAPGUI |
No specific activities for this class.
Class GuiComboBox
Subset of activities related to SAP GUI ComboBox UI element. Use to retrieve or define the keys (or values) from this component.
| Extends |
Technologies of the class |
| irpa_core.core.ComboBox |
SAPGUI |
Activities :
Retrieve the key for a selected element in SAP GUI ComboBox.
| Technical Name |
Type |
Minimal Agent Version |
| getKey |
synchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| key |
string |
Returns the key of a selected element in the ComboBox. |
Sample Code:
await SAPLogon750.oPage.oComboBox.getKey();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Set a key for a selected element in SAP GUI ComboBox.
| Technical Name |
Type |
Minimal Agent Version |
| setKey |
synchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| key |
string |
|
Key for an element which will be set in the ComboBox. |
Sample Code:
await SAPLogon750.oPage.oComboBox.setKey(key);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter key. |
Retrieve the value of a selected element in SAP GUI ComboBox.
| Technical Name |
Type |
Minimal Agent Version |
| getValue |
synchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| value |
string |
Returns the value of a selected element in the ComboBox. |
Sample Code:
await SAPLogon750.oPage.oComboBox.getValue();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Set a value for a selected element in SAP GUI ComboBox.
| Technical Name |
Type |
Minimal Agent Version |
| setValue |
synchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| value |
string |
|
Value to be set for a selected element in the ComboBox. |
Sample Code:
await SAPLogon750.oPage.oComboBox.setValue(value);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter value. |
Class GuiCalendar
Subset of activities related to SAP GUI Calendar.
Activities :
Retrieve a specified date in YYYYMMDD format.
| Technical Name |
Type |
Minimal Agent Version |
| getDate |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| selectedDate |
string |
Returns the specified date in YYYYMMDD format. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.oItem.getDate();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Select Date (GUI Calendar) |
Select a specified date in YYYYMMDD format.
| Technical Name |
Type |
Minimal Agent Version |
| selectDate |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| date |
string |
|
Date in YYYYMMDD format. |
Sample Code:
Selects date given in 'YYYYMMDD' format await SAPLogon750App.pSAPEasyAccess.oItem.selectDate();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter date. |
| Get Date Range (GUI Calendar) |
Retrieve a specified date range in YYYYMMDD format separated by a comma.
| Technical Name |
Type |
Minimal Agent Version |
| getDateRange |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| selectedDateRange |
string |
Returns the selected date range in YYYYMMDD format separated by a comma. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.oItem.getDateRange();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Select Date Range (GUI Calendar) |
Select a specified date range in YYYYMMDD format.
| Technical Name |
Type |
Minimal Agent Version |
| selectDateRange |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| fromDate |
string |
|
'From' date in YYYYMMDD format. |
| toDate |
string |
|
'To' date in YYYYMMDD format. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.oItem.selectDateRange();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters fromDate, toDate. |
| Set Focus Date (GUI Calendar) |
Focus a specified date in the GUI Calendar.
| Technical Name |
Type |
Minimal Agent Version |
| setFocusDate |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| date |
string |
|
Date in YYYYMMDD format. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.oItem.setFocusDate();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter date. |
| Set Selection Interval (GUI Calendar) |
Set the selected interval of given 2 dates in YYYYMMDD format in GUI Calendar.
| Technical Name |
Type |
Minimal Agent Version |
| setSelectionInterval |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| combinedDate |
string |
|
Provide concatenated date strings separated by a comma eg.("20210412,20210415"). |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.oItem.setSelectionInterval();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter date. |
| Set First Visible Date (GUI Calendar) |
Focus on the earliest date visible in the calendar control in the YYYYMMDD format.
| Technical Name |
Type |
Minimal Agent Version |
| setFirstVisibleDate |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| date |
string |
|
Date in YYYYMMDD format. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.oItem.setFirstVisibleDate();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter date. |
Class GuiTree
Subset of activities related to SAP GUI Tree.
| Extends |
Technologies of the class |
| irpa_core.core.Tree |
SAPGUI |
Activities :
| Get Selected Element (GUI Tree) |
Retrieve a selected element. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selected |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns selected node key. |
Sample Code:
await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.selected();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Select/Deselect Element (GUI Tree) |
Select or deselect a specified element. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| select |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| isSelected |
boolean |
|
Set to true if the element is to be selected, false if it is to be deselected. |
| key |
string |
|
Node key. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if successful, false if not. |
Sample Code:
const sNodeKey = '0000000004'; await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.select(true, sNodeKey);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter isSelected and key. |
Expand a node. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| expand |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| key |
string |
|
Node key. |
Sample Code:
const sNodeKey = '0000000004'; await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.expand(sNodeKey);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter key. |
Collapse a node. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| collapse |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| key |
string |
|
Node key. |
Sample Code:
const sNodeKey = '0000000004'; await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.collapse(sNodeKey);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter key. |
| Double Click Node (GUI Tree) |
Execute a double click on a node. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| clickDoubleNode |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| key |
string |
|
Node key. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if successful, false if not. |
Sample Code:
const sNodeKey = '0000000004'; await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.clickDoubleNode(sNodeKey);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter key. |
| Get Node Key by Text (GUI Tree) |
Retrieve a node key using node text. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getNodeKeyByText |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| inputText |
string |
|
Text to use to get node key. |
Output Parameters:
| Name |
Type |
Description |
| key |
string |
Returns a node key. |
Sample Code:
const sNodeText = 'SAP Menu'; await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.getNodeKeyByText(sNodeText);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter inputText. |
| Get Node Key by Path (GUI Tree) |
Retrieve a node key using node path. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getNodeKeyByPath |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| inputPath |
string |
|
Node path to use to get node key. A node path consists of indexes separated by "/". The index starts from 1 in GUI Tree. |
Output Parameters:
| Name |
Type |
Description |
| key |
string |
Returns a node key. |
Sample Code:
const sNodePath = '2/1/2'; await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.getNodeKeyByPath(sNodePath);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter inputPath. |
Return a collection of the node keys for all top nodes in a GUI tree. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getNodesCol |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| Returns |
Array. |
Collection of node keys. |
Sample Code:
await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.getNodesCol();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Get Sub Node Keys (GUI Tree) |
Return a collection of all the sub nodes keys for a node specified by a given node key. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getSubNodesCol |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| inputKey |
string |
|
Node key to provide to get sub nodes keys. |
Output Parameters:
| Name |
Type |
Description |
| Returns |
Array. |
Collection of sub node keys. |
Sample Code:
await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.getSubNodesCol(key);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Get Column Names (GUI Tree) |
Retrieve the column names. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getColumnNames |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| columns |
Array. |
Returns an array of column names. |
Sample Code:
await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.getColumnNames();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Is Column a Tree? (GUI Tree) |
Check whether a column is a tree or not. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| isColumnTree |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if the column is a tree, false if not. |
Sample Code:
await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.isColumnTree();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Retrieve a context menu element using a text element. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectContextMenuItemByText |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
| itemText |
string |
|
Text of the context menu element. |
| columnPos |
number |
|
Position of the column as number from left (0 by default). |
Output Parameters:
| Name |
Type |
Description |
| selected |
boolean |
Returns true if a context menu element of a cell or row is selected using its text, false if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.selectContextMenuItemByText('Logistics', 'Open folder', 0)
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters nodeKey, itemText, columnPos. |
Select a Context menu element using an element position. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectContextMenuItemByPosition |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
| itemPosition |
string |
|
Position of the context menu element. |
| columnPos |
number |
|
Position of the column as number from left (0 by default). |
Output Parameters:
| Name |
Type |
Description |
| selected |
boolean |
Returns true if a context menu element of a cell or row is selected using its position, false if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.selectContextMenuItemByPosition('logistics', 0,0);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters nodeKey, itemPosition, columnPos. |
Open the tree item's context menu in a Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| itemContextMenu |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
| colName |
string |
|
Provides a column name. |
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.itemContextMenu("00000001")
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters nodeKey, itemID, columnPos |
Open the context menu of a tree node in a Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| contextMenu |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.contextMenu("00000001")
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters nodeKey |
Select a context menu element using an element ID. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectContextMenuItem |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| itemID |
string |
|
Provides a context menu item ID. |
Output Parameters:
| Name |
Type |
Description |
| selected |
string |
Returns true if a context menu item of a cell or row is selected using its ID, false if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.selectContextMenuItem("XXEXPD")
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters nodeKey, itemID, columnPos |
Select a Context menu element using an element ID. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectContextMenuItemByID |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
| itemID |
string |
|
ID of the context menu element. |
| columnPos |
number |
|
Position of the column as number from left (0 by default). |
Output Parameters:
| Name |
Type |
Description |
| selected |
boolean |
Returns true if a context menu element of a cell or row is selected using its ID, false if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.selectContextMenuItemByID("Logistics", "XXEXPD", 0)
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters nodeKey, itemID, columnPos. |
| Select Node Element (GUI Tree) |
Select a node element. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectNodeItem |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
| columnPos |
number |
|
Position of the column as number from left (starts with 0). |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if the node element is selected, false if not. |
Sample Code:
await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.selectNodeItem('logistics', 0);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters nodeKey, columnPos. |
| Select Node Item By Column Name (GUI Tree) |
Select the node Item in a Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectNodeItemByColName |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Provides the node key. |
| colName |
string |
|
Provides the column name. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if the node element is selected, false if not. |
Sample Code:
await SAPLogon750.pSAPEasyAccess.oSAPTableTreeControl.selectNodeItemByColName('000000001', 'logistics');
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters nodeKey, columnPos |
| Get Node Element Text (GUI Tree) |
Retrieve the text from different elements of a node in a column of type tree. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getNodeItemText |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
| columnPos |
number |
|
Position of the column as number from left (starts with 0). |
Output Parameters:
| Name |
Type |
Description |
| text |
string |
Returns a text element. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.getNodeItemText('logistics', 0);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters nodeKey, columnPos. |
| Click Node Element Link (GUI Tree) |
Click the link of a node element. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| clickNodeItemLink |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
| columnPos |
number |
|
Position of the column as number from left (starts with 0). |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if successful, false if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.clickNodeItemLink('logistics', 0);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters nodeKey, columnPos. |
| Click Node Item Link by Column Name (GUI Tree) |
Click the link of a node item in a Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| clickNodeItemLinkByColName |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Provides the node key. |
| colName |
string |
|
Provides a column name. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns True if successful, False if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.clickNodeItemLinkByColName('00000001', logistics');
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters nodeKey, columnPos |
Click the button of a node element. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| pressNodeItemButton |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
| columnPos |
number |
|
Position of the column as number from left (starts with 0). |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if successful, false if not. |
Sample Code:
await APLogon760.pSAPEasyAccess.oSAPTableTreeControl.pressNodeItemButton('logistics', 0);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters nodeKey, columnPos. |
Click the button of a node Item in a Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| pressNodeItemButtonByColName |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Provides the node key. |
| colName |
string |
|
Provides a column name. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns True if successful, False if not. |
Sample Code:
await APLogon760.pSAPEasyAccess.oSAPTableTreeControl.pressNodeItemButtonByColName('00000001', 'logistics');
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters nodeKey, columnPos |
| Double Click Node Element (GUI Tree) |
Double-click a node element in a column tree. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClickNodeItem |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
| columnPos |
number |
|
Position of the column as number from left (starts with 0). |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if successful false if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.doubleClickNodeItem('logistics', 0);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters nodeKey, columnPos. |
| Double Click Node Item (GUI Tree) |
Double-click the node item in a column tree. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClickNodeItemByColName |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Provides the node key. |
| colName |
string |
|
Provides a column name. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns True if successful, False if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.doubleClickNodeItemByColName('00000001', 'logistics');
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters nodeKey, columnPos |
| Get Checkbox State (GUI Tree) |
Retrieve the state of a Checkbox. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| checked |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
| columnPos |
number |
|
Position of the column as number from left (starts with 0). |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if successful, false if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.checked('logistics', 0);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters nodeKey, columnPos. |
| Change Checkbox State (GUI Tree) |
Check a checkbox in a tree node. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| changeCheck |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Provides the node key. |
| colName |
string |
|
Position of the column as number from left (starts with 0). |
| value |
number |
|
Provides 0 or 1 for the value. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns True if successful, False if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.changeCheck('00000001', 'logistics', 0);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters nodeKey, colName |
| Select Checkbox (GUI Tree) |
Check a Checkbox. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| check |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
| columnPos |
number |
|
Position of the column as number from left (starts with 0). |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if successful, false if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.check('logistics', 0);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters nodeKey, columnPos. |
| Unselect Checkbox (GUI Tree) |
Uncheck a Checkbox. This activity is available for the Tree View Control.
| Technical Name |
Type |
Minimal Agent Version |
| unCheck |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Node key. |
| columnPos |
number |
|
Position of the column as number from left (starts with 0). |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if successful, false if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.unCheck('logistics', 0);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters nodeKey, columnPos. |
Set the top node in a GUI Tree.
| Technical Name |
Type |
Minimal Agent Version |
| setTopNode |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Key of the node. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.setTopNode('logistics');
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters nodeKey |
| Set Selected Node (GUI Tree) |
Set the selected node in a GUI Tree.
| Technical Name |
Type |
Minimal Agent Version |
| setSelectedNode |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| nodeKey |
string |
|
Key of the node. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oSAPTableTreeControl.setSelectedNode('logistics');
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters nodeKey |
Class GuiFrameWindow
Subset of activities related to SAP GUI Frame Window.
Activities :
Minimize a frame window in the background. This function is available in any window.
| Technical Name |
Type |
Minimal Agent Version |
| iconify |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await SAPLogon750App.pSAPEasyAccess.oItem.iconify();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
Send a sequence of keys or text using a predefined list.
| Technical Name |
Type |
Minimal Agent Version |
| keyStroke |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| command |
irpa_core.enums.SAPScripting.key |
|
Command key sequence or text to be sent (see irpa_core.enums.SAPScripting.key). |
| timer |
number |
optional
|
Delay after key sequence (default is 100 ms). |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if a sequence of keys is sent, false if not. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.keyStroke(ctx.enums.key.Enter);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter command. |
| Take Screenshot (GUI Frame) |
Create a screenshot of a window in PNG format.
| Technical Name |
Type |
Minimal Agent Version |
| screenshot |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| filename |
string |
|
Name of the file to be created. |
Output Parameters:
| Name |
Type |
Description |
| result |
any |
Returns the generated file name. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.screenshot();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter filename. |
| Restore Window (GUI Frame) |
Restore a window from its iconified state. This function is available in any window.
| Technical Name |
Type |
Minimal Agent Version |
| restore |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await SAPLogon750App.pSAPEasyAccess.restore();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Minimize Window (GUI Frame) |
Minimize a frame window in the background. This function is available in any window.
| Technical Name |
Type |
Minimal Agent Version |
| minimize |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await SAPLogon750App.pSAPEasyAccess.minimize();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Maximize Window (GUI Frame) |
Maximize a frame window in the background. This function is available in any window.
| Technical Name |
Type |
Minimal Agent Version |
| maximize |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await SAPLogon750App.pSAPEasyAccess.maximize();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
Close an opened window.
| Technical Name |
Type |
Minimal Agent Version |
| close |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await APLogon750App.pSAPEasyAccess.close();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
Execute a custom action from SAP GUI Scripting API documentation
| Technical Name |
Type |
Minimal Agent Version |
| custom |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| actionName |
string |
|
Provide an SAP GUI action name (Eg. exec_Press, set_Text, etc). |
| paramA |
string |
optional
|
Parameter 1 for Custom Action. |
| paramB |
string |
optional
|
Parameter 2 for Custom Action. |
| paramC |
string |
optional
|
Parameter 3 for Custom Action. |
| paramD |
string |
optional
|
Parameter 4 for Custom Action. |
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Result of the action. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.oItem.custom("set_Text", "APOR");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Resize Working Pane (GUI Frame) |
Resize the working area based on width and height parameters.
| Technical Name |
Type |
Minimal Agent Version |
| resizeWorkingPane |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| width |
number |
|
Width parameter of the working area. |
| height |
number |
|
Height parameter of the working area. |
| throwOnFail |
boolean |
|
Parameter for success or failure. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.resizeWorkingPane(10,20,false);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter . |
Holds the SAPGui Session. In IRPA, after each SAPGui action, the scripting access is released and obtained while performing the next action. If uninterrupted scripting access is needed for a few set of actions, encapsulate those actions with Hold Session and Release Session activities. Example Scenario: It is used while opening a file dialog to always get the SAPGui Popup.
| Technical Name |
Type |
Minimal Agent Version |
| holdSession |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await SAPLogon750App.pSAPEasyAccess.holdSession(); await SAPLogon750App.pSAPEasyAccess.openPopup.Click(); await SAPLogon750App.pSAPEasyAccess.releaseSession();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Release Session (GUI Frame) |
Releases the SAPGui Session. Use only if Hold Session activity is added in the automation.
| Technical Name |
Type |
Minimal Agent Version |
| releaseSession |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await SAPLogon750App.pSAPEasyAccess.holdSession(); await SAPLogon750App.pSAPEasyAccess.openPopup.Click(); await SAPLogon750App.pSAPEasyAccess.releaseSession();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Set Automation Connection (GUI Frame) |
Limit an automation to the current screen connection only.
| Technical Name |
Type |
Minimal Agent Version |
| setAutomationConnection |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
SAPLogon750.pSAP.wait(function(ev) { await SAPLogon750.pSAP.setAutomationConnection(); await SAPLogon750.pSAP.edMandant.set(rootData.SAPLogon750Data.pSAPData.edMandant); await SAPLogon750.pSAP.edUtilisateur.set(rootData.SAPLogon750Data.pSAPData.edUtilisateur); await SAPLogon750.pSAP.oMotPasse.set(rootData.SAPLogon750Data.pSAPData.oMotPasse); await SAPLogon750.pSAP.edLangueDeTravail.set(rootData.SAPLogon750Data.pSAPData.edLangueDeTravail); await SAPLogon750.pSAP.keyStroke(ctx.enums.SAPScripting.key._Enter_); sc.endStep(); // end Scenario return; });
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Set Busy Wait Time (GUI Frame) |
Set a maximum wait time before an action when a session is busy.
| Technical Name |
Type |
Minimal Agent Version |
| setBusyWaitTime |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| busyTimeOut |
number |
|
Timeout value in milliseconds. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.setBusyWaitTime(2000);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
| Reset Busy Wait Time (GUI Frame) |
Reset the maximum wait time to the default value.
| Technical Name |
Type |
Minimal Agent Version |
| resetBusyWaitTime |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.resetBusyWaitTime();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the screen. |
Class GuiMainWindow
No specific activities for this class.
| Extends |
Technologies of the class |
| irpa_core.core.Button |
SAPGUI |
No specific activities for this class.
Class GuiOkCodeField
| Extends |
Technologies of the class |
| irpa_core.core.Edit |
SAPGUI |
No specific activities for this class.
Class GuiStatusbar
Subset of activities related to SAP GUI Status Bar.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPGUI |
Activities :
| Get Message ID (GUI Status Bar) |
Retrieve the name of the message class used in an ABAP message call.
| Technical Name |
Type |
Minimal Agent Version |
| getMessageId |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| messageId |
string |
Returns the name of the message class used in the ABAP message call. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.oItem.getMessageId();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Get Message Number (GUI Status Bar) |
Retrieve the number of the message used in an ABAP message call. This is usually a number not enforced by the system.
| Technical Name |
Type |
Minimal Agent Version |
| getMessageNumber |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| messageNumber |
string |
Returns the number of the message used in the ABAP message call. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.oItem.getMessageNumber();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Get Message Type (GUI Status Bar) |
Retrieve a message type such as, Success, Warning, Error, Abort, and Information.
| Technical Name |
Type |
Minimal Agent Version |
| getMessageType |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| messageType |
string |
Returns the message type: Success, Warning, Error, Abort, or Information. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.oItem.getMessageType();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Class GuiTableControl
Subset of activities related to SAP GUI Table Control.
| Extends |
Technologies of the class |
| irpa_core.core.Table |
SAPGUI |
Activities :
Scroll down one row at a time and a new row appears in the lower part of the table.
| Technical Name |
Type |
Minimal Agent Version |
| scrollDownByOneRow |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if scrolled down by one row, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.scrollDownByOneRow();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Scroll up by one row.
| Technical Name |
Type |
Minimal Agent Version |
| scrollUpByOneRow |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if scrolled up by one row, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.scrollUpByOneRow();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Scroll to a defined position.
| Technical Name |
Type |
Minimal Agent Version |
| scrollToPosition |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
Scroll position as a number. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.scrollToPosition(1);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter position. |
Retrieve the maximum value up to which scrolling is possible within a table.
| Technical Name |
Type |
Minimal Agent Version |
| getVerticalScrollMax |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
number |
Returns the maximum value up to which scrolling is possible within the table. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.getVerticalScrollMax();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Retrieve the current position of a scrollbar.
| Technical Name |
Type |
Minimal Agent Version |
| getVerticalScrollPosition |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
number |
Returns the current position of the scrollbar. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.getVerticalScrollPosition();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Get Visible Rows (GUI Table) |
Retrieve all the visible rows present in a table.
| Technical Name |
Type |
Minimal Agent Version |
| getVisibleRows |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| rows |
Array. |
Returns all the visible rows present in the table. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.getVisibleRows();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Retrieve data of a specified row.
| Technical Name |
Type |
Minimal Agent Version |
| getRow |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rowNumber |
number |
|
Row index of which you want to get the values. |
Output Parameters:
| Name |
Type |
Description |
| row |
Array. |
Returns an array containing all the values present in the given row. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.getRow(7);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter rowNumber. |
| Get Column Names (GUI Table) |
Retrieve the column names present in a table.
| Technical Name |
Type |
Minimal Agent Version |
| getColumnNames |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| columnNames |
Array. |
Returns an array containing all the column names present in the table. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.getColumnNames();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Scroll to Next Page (GUI Table) |
Scroll to the next set of visible rows present in a table.
| Technical Name |
Type |
Minimal Agent Version |
| scrollToNextPage |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if scrolled to the next page, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.scrollToNextPage();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Scroll to Previous Page (GUI Table) |
Scroll to the previous set of visible rows present in a table.
| Technical Name |
Type |
Minimal Agent Version |
| scrollToPreviousPage |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if scrolled to the previous page, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.scrollToPreviousPage();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Get Visible Rows Count (GUI Table) |
Retrieve the number of visible rows in a table.
| Technical Name |
Type |
Minimal Agent Version |
| getVisibleRowCount |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| count |
number |
Returns the number of visible rows in a table. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.getVisibleRowCount();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Select a specified row.
| Technical Name |
Type |
Minimal Agent Version |
| selectRow |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rowNumber |
number |
|
Number of the row you want to select. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if the row is selected, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.selectRow(15);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter rowNumber. |
Deselect a specified row.
| Technical Name |
Type |
Minimal Agent Version |
| deSelectRow |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rowNumber |
number |
|
Number of the row you want to deselect. |
Output Parameters:
| Name |
Type |
Description |
| deselected |
boolean |
Returns true if the row is deselected, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.deSelectRow(15);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter rowNumber. |
| Select Visible Row (GUI Table) |
Select a specified visible row.
| Technical Name |
Type |
Minimal Agent Version |
| selectVisibleRow |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rowNumber |
number |
|
Number of the visible row you want to select. |
Output Parameters:
| Name |
Type |
Description |
| selected |
boolean |
Returns true if the row is selected, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.selectVisibleRow(5);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter rowNumber. |
| Deselect Visible Row (GUI Table) |
Deselect a specified visible row.
| Technical Name |
Type |
Minimal Agent Version |
| deSelectVisibleRow |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rowNumber |
number |
|
Number of the visible row you want to deselect. |
Output Parameters:
| Name |
Type |
Description |
| deselected |
boolean |
Returns true if the row is deselected, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.deSelectVisibleRow(5);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter rowNumber. |
| Select All Visible Row (GUI Table) |
Select all visible rows.
| Technical Name |
Type |
Minimal Agent Version |
| selectAllVisibleRows |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| selected |
boolean |
Returns true if the rows are selected, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.selectAllVisibleRows();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Deselect All Visible Rows (GUI Table) |
Deselect all visible rows.
| Technical Name |
Type |
Minimal Agent Version |
| deSelectAllVisibleRows |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| deselected |
boolean |
Returns true if the rows are deselected, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.deSelectAllVisibleRows();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Set the position of the vertical scroll bar in a GuiTableControl.
| Technical Name |
Type |
Minimal Agent Version |
| setVerticalScrollBarPosition |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| positionValue |
number |
|
Provides the position value. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns True if scrolling is successful, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.setVerticalScrollBarPosition();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for Position parameter. |
Set the position of the horizontal scroll bar in a GuiTableControl.
| Technical Name |
Type |
Minimal Agent Version |
| setHorizontalScrollBarPosition |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| positionValue |
number |
|
Provides the position value. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns True if scrolling is successful, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiTableItem.setHorizontalScrollBarPosition();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for Position parameter. |
Class GuiTab
| Extends |
Technologies of the class |
| irpa_core.core.Button |
SAPGUI |
No specific activities for this class.
Class GuiTabStrip
| Extends |
Technologies of the class |
| irpa_core.core.Button |
SAPGUI |
No specific activities for this class.
Class GuiUserArea
Subset of activities related to SAP GUI User Area. Use to scroll down or up within this UI component.
Activities :
| Scroll to Next Page (GUI User Area) |
Scroll to the next page. Scroll down through the content of a GuiUserArea component to bring into view content that is below the page level if there is a vertical scroll bar.
| Technical Name |
Type |
Minimal Agent Version |
| scrollToNextPage |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if scrolled to the next page, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiUserArea.scrollToNextPage();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Scroll to Previous Page (GUI User Area) |
Scroll to the previous page. Scroll up through the content of a GuiUserArea component to bring into view content that is above the page level if there is a vertical scroll bar.
| Technical Name |
Type |
Minimal Agent Version |
| scrollToPreviousPage |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if scrolled to the previous page, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiUserArea.scrollToPreviousPage();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Set the position of the vertical scroll bar in a GuiUserArea.
| Technical Name |
Type |
Minimal Agent Version |
| setVerticalScrollBarPosition |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| positionValue |
number |
|
Provides the position value. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns True if scrolling is successful, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiUserArea.setVerticalScrollBarPosition();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for Position parameter. |
Set the position of the horizontal scroll bar in a GuiUserArea.
| Technical Name |
Type |
Minimal Agent Version |
| setHorizontalScrollBarPosition |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| positionValue |
number |
|
Provides the position value. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns True if scrolling is successful, false if not. |
Sample Code:
await SAPLogon750.oPage.oGuiUserArea.setHorizontalScrollBarPosition();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for Position parameter. |
Class GuiCTextField
No specific activities for this class.
Class GuiPasswordField
No specific activities for this class.
Class GuiTextField
Subset of activities related to SAP GUI Text Field.
| Extends |
Technologies of the class |
| irpa_core.core.Edit |
SAPGUI |
Activities :
| Set Caret Position (GUI Text Field) |
Set the caret position within a text field. This activity is available for the Text Field Control.
| Technical Name |
Type |
Minimal Agent Version |
| setCaretPosition |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| caretPosition |
number |
|
Caret position as number. |
Sample Code:
await SAPLogon750.oPage.oTextBox.setCaretPosition();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for caretPosition command |
Class GuiGridViewCheckBox
No specific activities for this class.
No specific activities for this class.
| Extends |
Technologies of the class |
| irpa_core.core.CheckBox |
SAPGUI |
No specific activities for this class.
Class GuiStatusPane
No specific activities for this class.
Class GuiLabel
| Extends |
Technologies of the class |
| irpa_core.core.Text |
SAPGUI |
Activities :
| Set Caret Position (GUI Label) |
Set the caret position within a GUI label.
| Technical Name |
Type |
Minimal Agent Version |
| setCaretPosition |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| caretPosition |
number |
|
Caret position as number. |
Sample Code:
await SAPLogon750.oPage.oLabel.setCaretPosition(1);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for caretPosition command |
No specific activities for this class.
No specific activities for this class.
Subset of activities related to SAP GUI Toolbar.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPGUI |
Activities :
Click the toolbar button in a GUI Toolbar control.
| Technical Name |
Type |
Minimal Agent Version |
| clickToolbar |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| buttonId |
string |
|
Provides the Button ID. |
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oGuiCtrlToolbar.clickToolbar("BTNID");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters buttonId |
| Press Context Button (GUI Toolbar) |
Press the toolbar context button in a GUI Toolbar Control.
| Technical Name |
Type |
Minimal Agent Version |
| pressContextButton |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| buttonId |
string |
|
Provides the Button ID. |
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGuiCtrlToolbar1.pressContextButton("BTNID");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters buttonId |
Select the context menu item in a GUI Toolbar Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectContextMenuItem |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| functionCode |
string |
|
Provides the function code. |
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGuiCtrlToolbar1.selectContextMenuItem("BTNID");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters buttonId |
Click the toolbar element.
| Technical Name |
Type |
Minimal Agent Version |
| click |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await SAPLogon750.pCentralAccess.oToolBarMenu.click()
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Select a toolbar menu item by text.
| Technical Name |
Type |
Minimal Agent Version |
| selectToolbarMenuButtonByText |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| text |
string |
|
Menu item text. |
Sample Code:
await SAPLogon750.pCentralAccess.oToolBarMenu.selectToolbarMenuButtonByText(text);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter text. |
Select a toolbar menu item by position.
| Technical Name |
Type |
Minimal Agent Version |
| selectToolbarMenuButtonByPosition |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
string |
|
Menu item position as a number. |
Sample Code:
await SAPLogon750.pCentralAccess.oToolBarMenu.selectToolbarMenuButtonByPosition(2);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter position. |
Select a toolbar menu item by ID.
| Technical Name |
Type |
Minimal Agent Version |
| selectToolbarMenuButtonByFunCode |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| menuItemId |
string |
|
Menu item ID. |
Sample Code:
await SAPLogon750.pCentralAccess.oToolBarMenu.selectToolbarMenuButtonByFunCode(menuItemId);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter menuItemId. |
Class GuiGridViewPane
No specific activities for this class.
No specific activities for this class.
No specific activities for this class.
Class GuiGridView
Subset of activities related to SAP Grid View.
| Extends |
Technologies of the class |
| irpa_core.core.Table |
SAPGUI |
Activities :
Click a toolbar button in the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| clickToolbar |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| buttonId |
string |
|
Provides the Button ID. |
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.clickToolbar("BTNID");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters buttonId |
| Press Toolbar Context Button (GUI Grid) |
Press the toolbar context button in a Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| pressToolbarContextButton |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| buttonId |
string |
|
Provides the Button ID. |
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.pressToolbarContextButton("BTNID");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters buttonId |
Select the context menu item in a Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectContextMenuItem |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| itemID |
string |
|
Provides the function code. |
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.selectContextMenuItem("BTNID");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| InvalidArgument |
irpa_core |
invalidArgument provide value for parameters buttonId |
Retrieve a toolbar component. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getToolbar |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
Array. |
Returns an array of string containing toolbar information. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.getToolbar();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Retrieve column keys. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getColumns |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
any |
Returns a list of columns. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.getColumns();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Retrieve row values. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getRow |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| row |
number |
|
Row index. |
Output Parameters:
| Name |
Type |
Description |
| result |
Array. |
Returns an array containing values of the specified row. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.getRow(2);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter row. |
| Get Rows Count (GUI Grid) |
Retrieve the number of rows. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getRowCount |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
number |
Returns the number of rows. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.getRowCount();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Retrieve a specified set of rows. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getRows |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| startRow |
number |
|
Starting row number (0 by default). |
| numRows |
number |
|
Number of rows to be returned (all by default). |
Output Parameters:
| Name |
Type |
Description |
| rows |
Array. |
Returns an array of rows. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.oPane.getRows(2, 10);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters startRow, numRows. |
| Get Visible Rows (GUI Grid) |
Retrieve the rows that are currently visible on a screen. This activity is available in the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getVisibleRows |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| rows |
Array. |
Returns an array of rows. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.getVisibleRows();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Get Columns Rows (GUI Grid) |
Retrieve the values from a specified column in a subset of rows. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getRowsByColumn |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| columnId |
string |
|
Column ID. |
| startRow |
number |
|
Starting row number (0 by default). |
| numRows |
number |
|
Number of rows to be returned (all by default). |
Output Parameters:
| Name |
Type |
Description |
| rows |
Array. |
Returns an array of rows. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.getRowsByColumn(columnId,2, 10);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters columnId, startRow, numRows. |
Select a cell. This activity is available in the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectCell |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rowNumber |
number |
|
Row index number. |
| columnKey |
string |
|
Column key. |
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.selectCell(2, 10);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters rowNumber, columnKey. |
Select a row. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectRow |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| row |
number |
|
Row index number. |
Output Parameters:
| Name |
Type |
Description |
| selected |
boolean |
Returns true if the row is selected, false if not. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.selectRow(2);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter row. |
| Get Selected Row (GUI Grid) |
Retrieve the selected row. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectedRow |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
number |
Returns the index of the currently selected row. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.selectedRow();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Get Selected Column (GUI Grid) |
Retrieve the selected column. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectedCol |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns the ID of the currently selected column. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.selectedCol();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Get Cell Value (GUI Grid) |
Retrieve cell value. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| getCell |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rowNumber |
number |
|
Row index number. |
| columnKey |
string |
|
Column key. |
Output Parameters:
| Name |
Type |
Description |
| value |
string |
Returns the cell value. |
Sample Code:
const aColumns = await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.getColumns(); const nRow = 0; const sCol = aColumns[1]; await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.getCell(nRow, sCol);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters rowNumber, columnKey. |
| Set Cell Value (GUI Grid) |
Set a value on a cell. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| setCell |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| value |
string |
|
Value of the cell. |
| rowNumber |
number |
|
Row index number. |
| columnKey |
string |
|
Column key. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if successful, false if not. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.setCell(value, nRow, sCol);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters value, rowNumber, columnKey. |
| Click Current Cell (GUI Grid) |
Execute a click on a cell in a Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| clickCurrentCell |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.clickCurrentCell();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
Execute a click on a cell. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| clickCell |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rowNumber |
number |
|
Row index number. |
| columnKey |
string |
|
Column key. |
Sample Code:
const aColumns = await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.getColumns(); const nRow = 0; const sCol = aColumns[1]; await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.clickCell(nRow, sCol);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters rowNumber, columnKey. |
| Double Click Cell (GUI Grid) |
Execute a double click on a cell. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| clickDoubleCell |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rowNumber |
number |
|
Row index number. |
| columnKey |
string |
|
Column key. |
Sample Code:
const aColumns = await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.getColumns(); const nRow = 0; const sCol = aColumns[1]; await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.clickDoubleCell(nRow, sCol);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters rowNumber, columnKey. |
| Select All Rows (GUI Grid) |
Select all rows of a Grid View pane. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| selectAllRows |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.selectAllRows(); await SAPLogon750.pTCURRDisplayOfEnt.oPane.selectAllRows();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Deselect All Rows (GUI Grid) |
Deselect all rows of a Grid View pane. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| deselectAllRows |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.deselectAllRows(); await SAPLogon750.pTCURRDisplayOfEnt.oPane.deselectAllRows();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Click the button in a cell in a Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| clickCurrentButtonCell |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.clickButtonCell();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
Click the button in a cell. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| clickButtonCell |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rowNumber |
number |
|
Row index number. |
| columnKey |
string |
|
Column key. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.clickButtonCell(); await SAPLogon750.pTCURRDisplayOfEnt.oPane.clickButtonCell();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameters rowNumber, columnKey. |
Select a Context Menu Item using its text. This activity is available for a Grid View row or cell.
| Technical Name |
Type |
Minimal Agent Version |
| selectContextMenuItemByText |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| itemText |
string |
|
Text of the Context Menu Item. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if successful, false if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oPane.selectContextMenuItemByText("Logistics");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter itemText. |
Select the Context Menu Item using its position. This activity is available for a Grid View row or cell.
| Technical Name |
Type |
Minimal Agent Version |
| selectContextMenuItemByPosition |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| itemPosition |
string |
|
Position of the Context Menu Item. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if successful, false if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oPane.selectContextMenuItemByPosition(0);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter itemPosition. |
Open the context menu for a GuiGridView cell. This activity is available for the Grid View Control.
| Technical Name |
Type |
Minimal Agent Version |
| contextMenu |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oGridView.contextMenu();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
Select the Context Menu Item using the ID of the item. This activity is available for a Grid View Control row or cell.
| Technical Name |
Type |
Minimal Agent Version |
| selectContextMenuItemByID |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| itemID |
string |
|
ID of the Context Menu Item. |
Output Parameters:
| Name |
Type |
Description |
| result |
boolean |
Returns true if successful, false if not. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oPane.selectContextMenuItemByID("&FIND");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter itemID. |
| Set First Visible Row (GUI Grid) |
Set the first visible row using row index in a GuiGridView.
| Technical Name |
Type |
Minimal Agent Version |
| setFirstVisibleRow |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rowNumber |
number |
|
Provides a row index number. |
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Returns an exception message in case of failure. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oGridView.setFirstVisibleRow("10");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter rowNumber. |
| Set Selected Rows (GUI Grid) |
Set the selected rows using row index in a GuiGridView.
| Technical Name |
Type |
Minimal Agent Version |
| setSelectedRows |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| indexes |
string |
|
Provide a comma separated row index number. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oGridView.setSelectedRows("1,2,4");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter index. |
| Set Current Cell (GUI Grid) |
Set the current cell using row and column in a GuiGridView.
| Technical Name |
Type |
Minimal Agent Version |
| setCurrentCell |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rowValue |
number |
|
Provide a row value number. |
| colValue |
string |
|
Provide a column value. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oGridView.setCurrentCell(1,"2");
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter row and column. |
| Set Current Cell Row (GUI Grid) |
Set the row of current cell using row index in a GuiGridView.
| Technical Name |
Type |
Minimal Agent Version |
| setCurrentCellRow |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| index |
number |
|
Provide a row index number (starting from 0, -1 is for title row). |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oGridView.setCurrentCellRow();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter index. |
| Double Click Current Cell (GUI Grid) |
Emulate a mouse double click on the current cell in a GuiGridView.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClickCurrentCell |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await SAPLogon760.pSAPEasyAccess.oGridView.doubleClickCurrentCell();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| Set First Visible Column (GUI Grid) |
Set the first visible column using index in a GuiGridView.
| Technical Name |
Type |
Minimal Agent Version |
| setFirstVisibleColumn |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| index |
string |
|
Provide a column index number. |
Sample Code:
await SAPLogon760.pSAPEasyAccess.oGridView.setFirstVisibleColumn();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter index. |
Click Toolbar Menu Button. This activity is available for the Grid View and Toolbar controls.
| Technical Name |
Type |
Minimal Agent Version |
| selectToolbar |
synchronous
|
WIN-3.24 (WIN for Windows)
|
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.selectToolbar(); await SAPLogon750.pTCURRDisplayOfEnt.oPane.selectToolbar();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Select a toolbar menu item by text. This activity is available for the Grid View Button and Menu and controls.
| Technical Name |
Type |
Minimal Agent Version |
| selectToolbarMenuButtonByText |
synchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| text |
string |
|
Menu item text. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.selectToolbarMenuButtonByText(text); await SAPLogon750.pTCURRDisplayOfEnt.oPane.selectToolbarMenuButtonByText(text);
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter text. |
Select a toolbar menu item by position. This activity is available for the Grid View Button and Menu controls.
| Technical Name |
Type |
Minimal Agent Version |
| selectToolbarMenuButtonByPosition |
synchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
string |
|
Menu item position as a number. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.selectToolbarMenuButtonByPosition(position); await SAPLogon750.pTCURRDisplayOfEnt.oPane.selectToolbarMenuButtonByPosition();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter position. |
Select a toolbar menu item by ID. This activity is available for the Grid View Button and Menu controls.
| Technical Name |
Type |
Minimal Agent Version |
| selectToolbarMenuButtonByFunCode |
synchronous
|
WIN-3.24 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| menuItemId |
string |
|
Menu item ID. |
Sample Code:
await SAPLogon750.pTCURRDisplayOfEnt.oSAPGUIGridViewCtrl1.selectToolbarMenuButtonByFunCode(menuItemId); await SAPLogon750.pTCURRDisplayOfEnt.oPane.selectToolbarMenuButtonByFunCode();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
| InvalidArgument |
irpa_core |
InvalidArgument provide value for parameter menuItemId. |
No specific activities for this class.
Class GuiGridViewGroup
No specific activities for this class.
No specific activities for this class.
No specific activities for this class.
Subset of activities related to SAP GUI Button.
| Extends |
Technologies of the class |
| irpa_core.core.Button |
SAPGUI |
Activities :
Execute a synchronous click on an element.
| Technical Name |
Type |
Minimal Agent Version |
| clickSync |
asynchronous
|
WIN-3.24 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
any |
Result. |
Sample Code:
await SAPLogon750App.pSAPEasyAccess.btExit.clickSync();
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
Execution timeout while waiting for the element. |
Class GuiShell
No specific activities for this class.
Class GuiCustomControl
No specific activities for this class.
Class GuiContainerShell
No specific activities for this class.
Class GuiDockShell
No specific activities for this class.
Class GuiSimpleContainer
No specific activities for this class.
No specific activities for this class.
Class GuiSplitterContainer
No specific activities for this class.
Class GuiTitlebar
No specific activities for this class.
No specific activities for this class.
Class GuiGOSShell
No specific activities for this class.
Class GuiSplitterShell
No specific activities for this class.
Class GuiDialogShell
No specific activities for this class.
Class GuiContainerItem
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPGUI |
No specific activities for this class.
Class GuiBox
No specific activities for this class.
Class GuiPicture
No specific activities for this class.
Class GuiGridViewSeparator
No specific activities for this class.
No specific activities for this class.
Class GuiGridViewThumb
No specific activities for this class.
No specific activities for this class.
No specific activities for this class.
Class GuiPane
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPGUI |
No specific activities for this class.
Table of Contents