Module - SAP GUI for HTML SDK
The SAP GUI for HTML SDK is composed of activities for accessing and manipulating applications using SAP GUI for HTML. You can use these activities directly in your project automation.
Class customTypes.SAPWebGui
No specific activities for this class.
Class SAPWebGuiPage
Subset of activities related to SAP WebGUI Screen control.
| Extends |
Technologies of the class |
| irpa_core.core.WEBPage |
SAPWebGui |
Activities :
| Set Transaction Code (WebGUI Screen) |
Set a transaction code to start the transaction.
| Technical Name |
Type |
Minimal Agent Version |
| setTransactionCode |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| TCODE |
string |
|
Transaction code. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Keystroke (WebGUI Screen) |
Send a sequence of pressed keys like a user keyboard to start the transaction.
| Technical Name |
Type |
Minimal Agent Version |
| keyStroke |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Screen) |
Perform custom actions in the backend for a WebGUI screen.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Class CustomControl
Subset of activities related to custom control used in the backend.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
| Get Value (WebGUI Custom Control) |
Retrieve the value for a selected element in a custom control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Focus (WebGUI Custom Control) |
Set the focus on a specified element in a custom control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Custom Control) |
Perform custom actions in the backend of a custom control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Custom Control) |
Check whether a UI element is rendered within a custom control. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class PRIMARY_WINDOW
Subset of activities related to primary window used in the backend.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
| Custom Action (WebGUI Primary Window) |
Perform custom actions in the backend of a primary window.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Set Size (WebGUI Primary Window) |
Define a Primary Window control, user area control and display size.
| Technical Name |
Type |
Minimal Agent Version |
| setSize |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| width |
number |
|
New Primary Window control width in metrics defined by metrics argument. |
| height |
number |
|
New Primary Window control height in metrics defined by metrics argument. |
| ua_width |
number |
|
New User Area control width in metrics defined by metrics argument. If not specified, then the width argument is used instead to set the UserArea width. |
| ua_height |
number |
|
New User Area control height in metrics defined by metrics argument. If not specified, then the height argument is used instead to set the UserArea height. |
| metrics |
number |
|
Metric for input arguments: width, height, ua_width, ua_height. Possilbe values: 0=DYNPRO, 1=PIXEL. Default DYNPRO metric. |
| displaywidth |
number |
|
Display width in pixels. |
| displayheight |
number |
|
Display height in pixels. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Get Value (WebGUI Primary Window) |
Retrieve the value for a selected element in a Primary Window.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Check Element (WebGUI Primary Window) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class MODAL_WINDOW
Subset of activities related to modal window used in the backend.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
| Close (WebGUI Modal Window) |
Close a modal window pop up.
| Technical Name |
Type |
Minimal Agent Version |
| close |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Get Value (WebGUI Modal Window) |
Retrieve the value for a selected element in a modal window .
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Modal Window) |
Perform custom actions in the backend of a modal window.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Modal Window) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Subset of activities related to SAP WebGUI check button control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a check button control. This activity is only supported if the property HasContextMenu is set to \"true\". After requesting the context menu, it appears in the screen state under the owner window control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Execute a 'double-click' action on a check button control. This activity works only on disabled controls.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the check state to \"true\" in a check button control. The selected property determines the current check state.
| Technical Name |
Type |
Minimal Agent Version |
| check |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the check state to \"false\" in a check button control. The selected property determines the current check state.
| Technical Name |
Type |
Minimal Agent Version |
| unCheck |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Toggle the check state to \"true\" or \"false\" in a check button control. The selected property determines the current check state.
| Technical Name |
Type |
Minimal Agent Version |
| toggleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the value for a selected element in a check button control.
| Technical Name |
Type |
Minimal Agent Version |
| set |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| value |
string |
|
Value to be set. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity argument does not match with the required. |
Retrieve the value for a selected element in a check button control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the focus on a specified element in a check button control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Perform custom actions in the backend of a check button control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class COMBOBOX
Subset of activities related to SAP WebGUI combo box control. The main difference between the combo box and edit control is that combo box supports the value lookup feature. Value lookup icon is rendered when combo box gains focus. Clicking on the lookup icon brings front a search dialog.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a combo box control. This activity is only supported if the property HasContextMenu is set to \"true\". After requesting the context menu, it appears in the screen state under the owner window control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Execute a 'click' action on a combo box control. This activity is only supported if property Clickable is set to \"true\". This activity works only on read-only controls.
| Technical Name |
Type |
Minimal Agent Version |
| click |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Double Click (WebGUI Combo Box) |
Execute a 'double-click' action on a combo box control. This activity works only on disabled or read-only controls.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Cursor Position (WebGUI Combo Box) |
Set the cursor position in a combo box control. The cursor position must be set only for controls with Readonly property set to \"false\". If the cursor position is greater than the size of the text, the action fails with a warning message. For example, in the \"hello\" text string, the cursor position 0 is before the first character, and cursor position 5 is after the last character. If you set the cursor position to 6, it will raise a warning message (101).
| Technical Name |
Type |
Minimal Agent Version |
| setCursorPosition |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
Cursor position. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity argument does not match with the required. |
| Get Value (WebGUI Combo Box) |
Retrieve the value for a selected element in a combo box control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Value (WebGUI Combo Box) |
Set the value for a selected element in a combo box control.
| Technical Name |
Type |
Minimal Agent Version |
| set |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| value |
string |
|
Value to be set. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Set Focus (WebGUI Combo Box) |
Set the focus on a specified element in a combo box control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Combo Box) |
Perform custom actions in the backend of a combo box control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class COMBOCONTROL
Subset of activities related to SAP WebGUI combo control. The main difference between combo box and combo control is that combo control has a predefined list of items (defined by value set control referenced by ValueSetId property) that defines all possible values that can be assigned to the control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a combo control. This activity is only supported if the property HasContextMenu is set to \"true\". After requesting the context menu, it appears in the screen state under the owner window control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Click (WebGUI Combo Control) |
Execute a 'click' action on a combo control.
| Technical Name |
Type |
Minimal Agent Version |
| click |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Get Value (WebGUI Combo Control) |
Retrieve the value for a selected element in a combo control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Value (WebGUI Combo Control) |
Set the value for a selected element in a combo control.
| Technical Name |
Type |
Minimal Agent Version |
| set |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| value |
string |
|
Value to be set. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Set Focus (WebGUI Combo Control) |
Set the focus on a specified element in a combo control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Combo Control) |
Perform custom actions in the backend of a combo control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Combo Box) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class EDIT
Subset of activities related to SAP WebGUI edit control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of an edit control. This activity is only supported if the property HasContextMenu is set to \"true\". After requesting the context menu, it appears in the screen state under the owner window control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Execute a 'click' action on an edit control. This activity is only supported if property Clickable is set to \"true\". This activity works only on read-only controls.
| Technical Name |
Type |
Minimal Agent Version |
| click |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Double Click (WebGUI Edit) |
Execute a 'double-click' action on an edit control. This activity works only on disabled or read-only controls.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Cursor Position (WebGUI Edit) |
Set cursor position in an edit control. The cursor position must be set only for controls with the Readonly property set to \"false\". If the position is greater than the size of the text, the action fails with a warning message. For example, in the \"hello\" text string, the cursor position 0 is before the first character, and cursor position 5 is after the last character. If you set the cursor position to 6, it will raise a warning message (101).
| Technical Name |
Type |
Minimal Agent Version |
| setCursorPosition |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
Cursor position. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Retrieve the value for a selected element in an edit control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the value for a selected element in an edit control.
| Technical Name |
Type |
Minimal Agent Version |
| set |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| value |
string |
|
Value to be set. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Set the focus on a specified element in an edit control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Edit) |
Perform custom actions in the backend of an edit control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Edit) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class LABEL
Subset of activities related to SAP WebGUI label control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a label control. This activity is only supported if the property HasContextMenu is set to \"true\". After requesting the context menu, it appears in the screen state under the owner window control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Execute a 'click' action on a label control. This activity is only supported if property Clickable is set to \"true\". This activity works only for read-only controls.
| Technical Name |
Type |
Minimal Agent Version |
| click |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Double Click (WebGUI Label) |
Execute a 'double-click' action on a label control. This activity works only on disabled or read-only controls.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Retrieve the value for a selected element in a label control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Value of the selected element. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the focus on a specified element in a label control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Label) |
Perform custom actions in the backend of a label control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Label) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class PASSWORD
Subset of activities related to SAP WebGUI password control. The main difference between password and edit control is that the input value is hidden from the user in password control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a password control. This activity is only supported if the property HasContextMenu is set to \"true\". After requesting the context menu, it appears in the screen state under the owner window control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Execute a 'click' action on a password control. This activity is only supported if property Clickable is set to \"true\". This activity works only for read-only controls.
| Technical Name |
Type |
Minimal Agent Version |
| click |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Double Click (WebGUI Password) |
Execute a 'double-click' action on a password control. This activity works only on disabled or read-only controls.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Cursor Position (WebGUI Password) |
Set the cursor position in a password control. The cursor position must be set only for controls with the Readonly property set to \"false\". If the position is greater than the size of the text, the action fails with a warning message. For example, in the \"hello\" text string, the cursor position 0 is before the first character, and cursor position 5 is after the last character. If you set the cursor position to 6, it will raise a warning message (101).
| Technical Name |
Type |
Minimal Agent Version |
| setCursorPosition |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
Cursor position. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Get Value (WebGUI Password) |
Retrieve the value for a selected element in a password control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Value of the selected element. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Value (WebGUI Password) |
Set the value for a selected element in a password control.
| Technical Name |
Type |
Minimal Agent Version |
| set |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| value |
string |
|
Value to be set. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Set Focus (WebGUI Password) |
Set the focus on a specified element in a password control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Password) |
Perform custom actions in the backend of a password control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Password) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Subset of activities related to SAP WebGUI push button control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a push button control. This activity is only supported if the property HasContextMenu is set to \"true\". After requesting the context menu, it appears in the screen state under the owner window control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Press the button in a push button control.
| Technical Name |
Type |
Minimal Agent Version |
| push |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Retrieve the value for a selected element in a push button control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the focus on a specified element in a push button control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Perform custom actions in the backend of a push button control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Subset of activities related to SAP WebGUI radio button control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a radio button control. This activity is only supported if the property HasContextMenu is set to \"true\". After requesting the context menu, it appears in the screen state under the owner window control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Execute a 'double-click' action on a radio button control. This activity works only on disabled or read-only controls.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the check state to \"true\" in a radio button control. The selected property determines the current check state.
| Technical Name |
Type |
Minimal Agent Version |
| check |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Retrieve the value for a selected element in a radio button control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the value for a selected element in a radio button control.
| Technical Name |
Type |
Minimal Agent Version |
| set |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| value |
string |
|
Value to be set. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Set the focus on a specified element in a radio button control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Perform custom actions in the backend of a radio button control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class TABLEVIEW
Subset of activities related to SAP WebGUI table view control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a table view control. This activity is only supported if the property HasContextMenu is set to \"true\". After requesting the context menu, it appears in the screen state under the owner window control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Configuration (WebGUI Table View) |
Open configuration dialog in a table view control. This activity must be triggered when the configuration button is pressed (top-right corner of the control). Configuration button must be visible only if property IsCustomizable is set to \"true\".
| Technical Name |
Type |
Minimal Agent Version |
| config |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Clear Selection (WebGUI Table View) |
Deselect all rows and columns in a table view control. Table View SelectColumns, SelectRows actions can be used as an alternative.
| Technical Name |
Type |
Minimal Agent Version |
| clearSelection |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Select All (WebGUI Table View) |
Select all rows and columns if multiple selection mode is enabled in a table view control. Table View SelectColumns, SelectRows actions can be used as an alternative.
| Technical Name |
Type |
Minimal Agent Version |
| selectAll |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Select Columns (WebGUI Table View) |
Select specified columns in a table view control. 1-based column indexes or index ranges (index pairs separated by a hyphen) separated by semicolon in the arbitrary order for columns are selected. The rest of the columns are deselected. For example, 2;5-7;1;23;9-11. If the parameter format is incorrect, the selection of columns is not set and a warning message (101) returns.
| Technical Name |
Type |
Minimal Agent Version |
| selectColumns |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| columns |
string |
|
Columns index. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Select Rows (WebGUI Table View) |
Select specified rows in a table view control. 1-based row indexes separated by semicolon in the arbitrary order for rows are selected. The rest of the rows are deselected. For example, 2;5;6;7;1;23. If the parameter format is incorrect, the selection of rows is not set and a warning message (101) returns.
| Technical Name |
Type |
Minimal Agent Version |
| selectRows |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rows |
string |
|
Rows index. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Change the position of the vertical scroll bar in a table view control. If the user scrolls the vertical scroll bar, the back-end saves the new position of the scroll bar inside the table view control. Client can access rows that were not available in the screen state after changing the position of the vertical scroll bar.
| Technical Name |
Type |
Minimal Agent Version |
| scrollVertically |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
Position of the vertical scroll bar. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Change the position of the horizontal scroll bar in a table view control. If the user scrolls the horizontal scroll bar, the back-end saves the new position of the scroll bar inside the table view control. Currently RESTGUI does not provide property for horizontal scroll bar position.
| Technical Name |
Type |
Minimal Agent Version |
| scrollHorizontally |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
Position of the horizontal scroll bar. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Resize Column (WebGUI Table View) |
Set the width of a column in a table view control.
| Technical Name |
Type |
Minimal Agent Version |
| resizeColumn |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| column_index |
number |
|
Index of the column to be resized. |
| width |
number |
|
The width of the column in pixels. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Get Value (WebGUI Table View) |
Retrieve the value for a selected element in a table view control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Focus (WebGUI Table View) |
Set the focus on a specified element in a table view control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Table View) |
Perform custom actions in the backend of a table view control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Table View) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class TABLECOLUMN
Subset of activities related to SAP WebGUI table column control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
| Request Menu (WebGUI Table Column) |
Request the context menu of a table column control. This activity is only supported if property HasContextMenu is set to \"true\". After requesting the context menu, it appears in the screen state under the owner window control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Selection (WebGUI Table Column) |
Select a new column and deselect all previously selected columns in a table column control. Table view SelectColumns action can be used as an alternative.
| Technical Name |
Type |
Minimal Agent Version |
| setSelection |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Add Selection (WebGUI Table Column) |
Select a new column without deselecting previously selected columns in a table column control. In case of single selection mode, this activity works in the same way as SetSelection. Table view SelectColumns action can be used as an alternative.
| Technical Name |
Type |
Minimal Agent Version |
| addSelection |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Remove Selection (WebGUI Table Column) |
Deselect a new column in a table column control. Table view SelectColumns action can be used as an alternative.
| Technical Name |
Type |
Minimal Agent Version |
| removeSelection |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Click (WebGUI Table Column) |
Execute a 'click' action on a cell of a table column control. This activity is only supported if the action state Ignored property is \"false\". Click action state is defined in Grid View control state with property Sub-Control Type equal to \"SAPGUI.GridViewCtrl.1.HeaderCell\".
| Technical Name |
Type |
Minimal Agent Version |
| click |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Double Click (WebGUI Table Column) |
Execute a 'double-click' action on a cell in a table column control. This activity is only supported if the action state Ignored property is \"false\". DoubleClick action state is defined in Grid View control state with property Sub-Control Type equal to \"SAPGUI.GridViewCtrl.1.HeaderCell\". Grid view DoubleClick action can be used as an alternative.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Current (WebGUI Table Column) |
Set the header cell as current (focused) in a table column control. Grid view SetCurrentCell action can be used as an alternative.
| Technical Name |
Type |
Minimal Agent Version |
| setCurrent |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Width (WebGUI Table Column) |
Set the width of a column in a table column control.
| Technical Name |
Type |
Minimal Agent Version |
| setWidth |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| size |
number |
|
Size of the column in characters. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Get (WebGUI Table Column) |
Retrieve the value for a selected element in a table column control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Focus (WebGUI Table Column) |
Set the focus on a specified element in a table column control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Table Column) |
Perform custom actions in the backend of a table column control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Table Column) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Subset of activities related to SAP WebGUI context menu control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Remove the context menu from the screen state in a context menu control. The requested context menu remains in the screen state until it's removed by the action. This action is not supported for all child context menus of OMRT toolbar drop down, OMRT toolbar drop menu controls. Use OMRT toolbar close action to remove dynamically requested context menus for OMRT toolbar children.
| Technical Name |
Type |
Minimal Agent Version |
| remove |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Select the menu item in a context menu control.
| Technical Name |
Type |
Minimal Agent Version |
| select |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Return the value for a selected element in a context menu control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the focus on a specified element in a context menu control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Perform custom actions in the backend of a context menu control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class SAPGUI_DOCKINGCTRL_1
Subset of activities related to SAP WebGUI docking container control. It is used to add additional OMRT controls on the screen.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
| Set Size (WebGUI Docking Container) |
Set docking container BaseWidth and/or BaseHeight properties in a docking container control. This action must be used to synchronize docking container size in the back-end when the user changes the splitter bar position associated with the container. The change of docking container base size does not trigger the affected OMRT controls size and position recalculation immediately. Server-side size and position recalculation are done once the next flushing operation is completed. RESTGUI operation POST recalculate can be used to force the recalculation.
| Technical Name |
Type |
Minimal Agent Version |
| setSize |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| width |
number |
|
New container base width in metrics specified by metrics argument. |
| height |
number |
|
New container base height in metrics specified by metrics argument. |
| metrics |
number |
|
Metrics used in width and height arguments. Possible values {0 - default,1 - pexel,2 -mm,3 - DYNPRO}. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Get Value (WebGUI Docking Container) |
Retrieve the value for a selected element in a docking container control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Focus (WebGUI Docking Container) |
Set the focus on a specified element in a docking container control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Docking Container) |
Perform custom actions in the backend of a docking control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Docking Container) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class SAPGUI_GridViewCtrl_1
Subset of activities related to SAP WebGUI grid view control. Each grid view contains one grid view header control, one grid view row collection control, and optionally one OMRT toolbar control. Each grid view header control contains one or more grid view header cell controls. Grid view row collection control contains any string of grid view row controls. Each grid view row control contains any type of grid view cell control. A string of cell controls under the row is equal to the string of columns.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
SAPWebGui Performs click on the cell. Supported only if Hotspot property is set to \"true\" and if the action state Ignored property is \"false\". Click action state is defined in Grid View control state with property Sub-Control Type equal to \"SAPGUI.GridViewCtrl.1.Cell\". If action state is not present for specified action than action is supported
| Technical Name |
Type |
Minimal Agent Version |
| click |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| row |
number |
|
1-based row index of the cell. If the value is set to 0 then a double click is performed on the header cell. |
| column |
number |
|
1-based column index of the cell. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Double Click (WebGUI Grid View) |
Execute a 'double-click' action on a cell in a grid view control. This activity is only supported if the action state Ignored property is \"false\". DoubleClick action state is defined in Grid View control state with property Sub-Control Type equal to \"SAPGUI.GridViewCtrl.1.Cell\". Grid View DoubleClick action can be used as an alternative.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| row_index |
number |
|
1-based row index of the cell. If the value is set to 0 then a double click is performed on the header cell. |
| column_index |
number |
|
1-based column index of the cell. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Press a button cell in a grid view control.
| Technical Name |
Type |
Minimal Agent Version |
| push |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| row_index |
number |
|
1-based row index of the cell. |
| column_index |
number |
|
1-based column index of the cell. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Request the context menu of a grid view control. This activity is only supported if the action state Ignored property is \"false\".
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Hotspot (WebGUI Grid View) |
Execute a 'click' action on a hotspot cell in a grid view control. This activity is only supported if hotspot properties are set to true and the action state Ignored property is set to \"false\". Hotspot action state is defined in grid view control state with property Id equal to \"1\" and property Sub-Control type equal to \"SAPGUI.GridViewCtrl.1.Cell\".
| Technical Name |
Type |
Minimal Agent Version |
| hotspot |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| row_index |
number |
|
1-based row index of the cell. |
| column_index |
number |
|
1-based column index of the cell. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Drop a drag and drop (DnD) source in a grid view control.
| Technical Name |
Type |
Minimal Agent Version |
| drop |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| drag_control_id |
number |
|
OMRT control identifier (OmrtId) for the DnD source control. |
| drag_handle |
number |
|
Handle (DndHandle property) of the DnD source. |
| drop_handle |
number |
|
Handle (DndHandle property) of the DnD target. |
| drop_row |
number |
|
1-based Grid View row index for the DnD target. Required if DnD target is Grid View Cell or Grid View Row control. |
| drop_column |
number |
|
1-based Grid View column index for the DnD target. Required if DnD target is Grid View Cell or Grid View Row control. |
| drag_node_key |
string |
|
Node key for DnD source. Required if DnD source is Table Tree Node control. |
| drag_row |
number |
|
1-based Grid View row index for the DnD source. Required if DnD source is Grid View Cell or Grid View Row control. |
| drag_column |
number |
|
1-based Grid View column index for the DnD source. Required if DnD source is Grid View Cell or Grid View Row control. |
| drag_date |
string |
|
Date of the DnD source. Required if DnD source is Calendar Cell control. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Clear Selection (WebGUI Grid View) |
Deselect all rows, columns, and cells in a grid view control. Grid view SelectColumns, SelectRows actions can be used as an alternative.
| Technical Name |
Type |
Minimal Agent Version |
| clearSelection |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Select Columns (WebGUI Grid View) |
Select specified columns in a grid view control. This activity must be used in combination with SetLastSelectedColumn action.
| Technical Name |
Type |
Minimal Agent Version |
| selectColumns |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| columns |
string |
|
1-based column indexes or index ranges (index pairs separated by hyphen) separated by semicolon in the arbitrary order for columns that should be selected. All left out columns are deselected. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Select Rows (WebGUI Grid View) |
Select specified rows ina grid view control. This activity must be used in combination with SetLastSelectedRow action.
| Technical Name |
Type |
Minimal Agent Version |
| selectRows |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| rows |
string |
|
1-based row indexes or index ranges (index pairs separated by hyphen) separated by semicolon in the arbitrary order for rows that should be selected. All left out rows are deselected. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Select Cells (WebGUI Grid View) |
Select specified cells in a grid view control.
| Technical Name |
Type |
Minimal Agent Version |
| selectCells |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| cells |
string |
|
1-based cell index pairs separated by semicolon. Pair consists of row index and column index separated by comma. All left out cells are deselected. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Clear Current (WebGUI Grid View) |
Clear the value of a focused cell in a grid view control.
| Technical Name |
Type |
Minimal Agent Version |
| clearCurrent |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Current Cell (WebGUI Grid View) |
Set the value of a focused cell in a grid view control.
| Technical Name |
Type |
Minimal Agent Version |
| setCurrentCell |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| row_index |
number |
|
1-based row index of the cell. If set to 0 than Header Cell is focused. |
| column_index |
number |
|
1-based column index of the cell. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Change the position of the back-end vertical scroll bar in a grid view control. The client can access rows that were not available in the screen state after changing the position of the vertical scroll bar.
| Technical Name |
Type |
Minimal Agent Version |
| scrollVertically |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
New vertical scroll position (0-based row index). |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Change the position of the back-end horizontal scroll bar in a grid view control.
| Technical Name |
Type |
Minimal Agent Version |
| scrollHorizontally |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
New horizontal scroll position. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Set the value for a string of visible rows in a grid view control.
| Technical Name |
Type |
Minimal Agent Version |
| setVerticalScrollExtent |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| extent |
number |
|
Number of visible rows. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Set Last Selected Column (WebGUI Grid View) |
Set the value for the last selected column in a grid view control. This activity must be used in combination with SelectColumns action.
| Technical Name |
Type |
Minimal Agent Version |
| setLastSelectedColumn |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| column |
number |
|
1-based last selected column index. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Set Last Selected Row (WebGUI Grid View) |
Set the value for the last selected row in a grid view control. This activity must be used in combination with SelectRows action.
| Technical Name |
Type |
Minimal Agent Version |
| setLastSelectedRow |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| row |
number |
|
1-based last selected column index. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Get Cell Value (WebGUI Grid View) |
Retrieve the text value for a specified cell.
| Technical Name |
Type |
Minimal Agent Version |
| getCellValue |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| column_id |
string |
|
Cell column identifier. |
| row_index |
number |
|
1-based row index of the cell. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Set Cell Value (WebGUI Grid View) |
Set text value for a specified cell.
| Technical Name |
Type |
Minimal Agent Version |
| setCellValue |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| row_index |
number |
|
1-based row index of the cell. |
| column_id |
string |
|
Cell column identifier. |
| value |
string |
|
New text value. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Scroll to the first row (server side scrolling).
| Technical Name |
Type |
Minimal Agent Version |
| scrollToBeginning |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Scroll to the next row (server side scrolling).
| Technical Name |
Type |
Minimal Agent Version |
| scrollToNextRow |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Scroll To Next Page (WebGUI Grid View) |
Scroll to the next page (server side scrolling).The page size is equal to VertScrollExtent.
| Technical Name |
Type |
Minimal Agent Version |
| scrollToNextPage |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Scroll to the previous row (server side scrolling).
| Technical Name |
Type |
Minimal Agent Version |
| scrollToPreviousRow |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Scroll To Previous Page (WebGUI Grid View) |
Scroll to the previous page (server side scrolling).The page size is equal to VertScrollExtent.
| Technical Name |
Type |
Minimal Agent Version |
| scrollToPreviousPage |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Scroll to a specified row (server side scrolling).
| Technical Name |
Type |
Minimal Agent Version |
| scrollToSpecificRow |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
New vertical scroll position (0-based row index). |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Scroll to the last row (server side scrolling).
| Technical Name |
Type |
Minimal Agent Version |
| scrollToLastRow |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Show Specific Row (WebGUI Grid View) |
Request a specified row (server side scrolling on demand).
| Technical Name |
Type |
Minimal Agent Version |
| showSpecificRows |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| fragments |
string |
|
0-based row index ranges (index pairs separated by hyphen), separated by semicolon in the arbitrary order for rows that should be loaded from the server. |
| position |
number |
|
New vertical scroll position (0-based row index). |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Change Column Position (WebGUI Grid View) |
Change the position of a column.
| Technical Name |
Type |
Minimal Agent Version |
| changeColumnPosition |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| source_column_index |
number |
|
1-based source column index. |
| target_column_index |
number |
|
1-based target column position. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Click Total Expander (WebGUI Grid View) |
Click the total expander button. Supported only if the action state Ignored property is set to \"false\". TotalClick action state is defined in Grid View control state with property Sub-Control Type equal to \"SAPGUI.GridViewCtrl.1.Cell\".
| Technical Name |
Type |
Minimal Agent Version |
| clickTotalExpander |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| row_index |
number |
|
1-based row index of the cell. |
| column_index |
number |
|
1-based column index of the cell. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Resize Column (WebGUI Grid View) |
Define the width of a column.
| Technical Name |
Type |
Minimal Agent Version |
| resizeColumn |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| column_index |
number |
|
Index of the column to be resized (1-based index). |
| width |
number |
|
Width of the column in pixels. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Set the check state to true.
| Technical Name |
Type |
Minimal Agent Version |
| check |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Uncheck (WebGUI Grid View) |
Set the check state to false.
| Technical Name |
Type |
Minimal Agent Version |
| unCheck |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Toggle (WebGUI Grid View) |
Toggle the check state in WebGUI grid view.
| Technical Name |
Type |
Minimal Agent Version |
| toggleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Width (WebGUI Grid View) |
Define the width of a column.
| Technical Name |
Type |
Minimal Agent Version |
| setWidth |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| size |
number |
|
Size of the column in characters. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Retrieve text elements in WebGUI grid view.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Focus (WebGUI Grid View) |
Set focus on an element in WebGUI grid view.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Grid View) |
Perform custom actions in the backend of a grid view control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Exist Element (WebGUI Grid View) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class SAPGUI_SplitterCtrl_1
Subset of activities related to SAPWebGui OMRT Splitter Container control, used to host multiple OMRT controls into its area which is split into cells.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
| Set Cell Size (WebGui Splitter Container) |
Define the size of a specified cell. Use this activity to synchronize Splitter Container cells sizes with back-end when the splitter bar position has been changed by the user. Changing the cell size doesn't immediately trigger affected OMRT controls size and position recalculation. Server side size and position recalculation is done after next flushing operation is executed. RESTGUI operation POST recalculate can be used to force the recalculation.
| Technical Name |
Type |
Minimal Agent Version |
| setCellSize |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| cellid |
string |
|
Identifier of the cell. |
| width |
number |
|
New cell width in metrics specified by metrics argument. If XCoordSystem is Relative then the specified value is interpreted as percents of Splitter Container width and cell property RelativeWidth is updated. In that case metrics argument is ignored. If XCoordSystem is Absolute then the cell BaseWidth property is updated. |
| height |
number |
|
New container height in metrics specified by metrics argument. If YCoordSystem is Relative then the specified value is interpreted as percents of Splitter Container width and the cell property RelativeHeight is updated. In that case metrics argument is ignored. If YCoordSystem is Absolute then the cell BaseWidth property is updated. |
| metrics |
number |
|
Metrics used in width and height arguments. Possible values {0 - default,1 - pexel,2 -mm,3 - DYNPRO}. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Get (WebGui Splitter Container) |
Retrieve text elements in WebGUI splitter container.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Focus (WebGui Splitter Container) |
Set focus on an element in WebGUI splitter container.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGui Splitter Container) |
Perform custom actions in the backend of a splitter control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGui Splitter Container) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Subset of activities for SAPWebGui OMRT Toolbar control. SAPWebGui OMRT Toolbar control is defined by following control types { 1. Check Box, 2. Drop Down, 3. Drop Menu, 4. Outlook Button, 5. Push Button, 6. Radio Button, 7. Separator}.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Remove all dynamically requested context menus from screen state for children Drop Down and Drop Menu controls with StaticMenu property set to \"false\".
| Technical Name |
Type |
Minimal Agent Version |
| close |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set check state to true (current check state is determined by Checked property).
| Technical Name |
Type |
Minimal Agent Version |
| check |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set check state to false (current check state is determined by Checked property).
| Technical Name |
Type |
Minimal Agent Version |
| unCheck |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Toggle check state (current check state is determined by Checked property).
| Technical Name |
Type |
Minimal Agent Version |
| toggleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Press the button. Should be triggered when user clicks on the left part of the composite button.
| Technical Name |
Type |
Minimal Agent Version |
| push |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| row |
number |
|
1-based row index of the cell. |
| column |
number |
|
1-based column index of the cell. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Request context menu for the control. Supported only if property StaticMenu is set to \"false\". Requested menu is added to the screen state as a child of the button. In most cases menu is added to the next screen state, but in some corner cases it is possible that menu is not added or added in some future screen state.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Retrieve text elements in WebGui toolbar.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set focus on an element in WebGUI grid view.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Perform custom actions in the backend of a tool bar control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class SAP_TableTreeControl_1
Subset of activities related to SAP WebGUI table tree control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
| Clear Selection (WebGUI Table Tree) |
Deselect all children controls from the selection in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| clearSelection |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Top Node (WebGUI Table Tree) |
Set the top node (first visible node) with a specified node key in a table tree control. If the specified node key does not exist, the error code (invalid argument) returns. As a result, TopNode property gets updated.
| Technical Name |
Type |
Minimal Agent Version |
| setTopNode |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| node_key |
string |
|
Node key. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Drop a drag and drop (DnD) source in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| drop |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| drag_control_id |
number |
|
OMRT control identifier (OmrtId) for the DnD source control. |
| drag_handle |
number |
|
Handle (DndHandle property) of the DnD source. |
| drop_handle |
number |
|
Handle (DndHandle property) of the DnD target. |
| drop_node_key |
string |
|
Node key for DnD target. Required if DnD target is TableTree Node control. |
| drag_node_key |
string |
|
Node key for DnD source. Required if DnD source is Table Tree Node control. |
| drag_row |
number |
|
1-based Grid View row index for the DnD source. Required if DnD source is Grid View Cell or Grid View Row control. |
| drag_column |
number |
|
1-based Grid View column index for the DnD source. Required if DnD source is Grid View Cell or Grid View Row control. |
| drag_date |
string |
|
Date of the DnD source. Required if DnD source is Calendar Cell control. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Get Value (WebGUI Table Tree) |
Retrieve the value for a selected element in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Get Table Tree Data (WebGUI Table Tree) New |
Retrieve the data for table tree control
| Technical Name |
Type |
Minimal Agent Version |
| getTableTreeData |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result New |
any |
Retrieve the content of the complete table tree. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Focus (WebGUI Table Tree) |
Set the focus on a specified element in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Table Tree) |
Perform custom actions in the backend of a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Press a button in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| push |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Click (WebGUI Table Tree) |
Execute a 'click' action on a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| click |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Check (WebGUI Table Tree) |
Set the check state to \"true\" in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| check |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Uncheck (WebGUI Table Tree) |
Set the check state to \"false\" in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| unCheck |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Toggle Click (WebGUI Table Tree) |
Toggle the check state to \"true\" or \"false\" in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| toggleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Double Click (WebGUI Table Tree) |
Execute a 'double-click' action on a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| node_key |
string |
|
Tree node key. |
| type |
string |
|
Tree node action type. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Request the context menu of a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Selection (WebGUI Table Tree) |
Add a control to the selection and remove previously selected controls in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| setSelection |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| node_key |
string |
|
Tree node key. |
| type |
string |
|
Tree node action type. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Remove Selection (WebGUI Table Tree) |
Remove a control from the selection in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| removeSelection |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Add Selection (WebGUI Table Tree) |
Add a control to the selection in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| addSelection |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Expand (WebGUI Table Tree) |
Expand a tree node in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| expand |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| node_key |
string |
|
Tree node key. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Collapse (WebGUI Table Tree) |
Collapse a tree node in a table tree control.
| Technical Name |
Type |
Minimal Agent Version |
| collapse |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| node_key |
string |
|
Tree node key. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Table Tree) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class DIAG_CONTROL
Subset of activities related to SAP WebGUI Diag control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a diag control. This activity is only supported if the action state Ignored property is \"false\". After requesting the context menu, it appears in the screen state under the owner window control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Retrieve the value for a selected element in a diag control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the focus on a specified element in a diag control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Diag) |
Perform custom actions in the backend of a diag control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Diag) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class ATOM
Subset of activities related to SAP WebGUI diag atom control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a diag atom control. This activity is only supported if the action state Ignored property is \"false\".
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Execute a 'click' action on a diag atom control. This activity is only supported if property Clickable is set to \"true\".
| Technical Name |
Type |
Minimal Agent Version |
| click |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Double Click (WebGUI Diag Atom) |
Execute a 'double-click' action on a diag atom control. This activity works only on disabled or read-only controls.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Get Value (WebGUI Diag Atom) |
Retrieve the value for a selected element in a diag atom control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Focus (WebGUI Diag Atom) |
Set the focus on a specified element in a diag atom control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Diag Atom) |
Perform custom actions in the backend of a atom control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Diag Atom) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class TEXT
Subset of activities related to SAP WebGUI text control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a text control. This activity is only supported if property HasContextMenu is set to \"true\". After requesting the context menu, it appears in the screen state under the owner window control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Execute a 'click' action on a text control. This activity is only supported if property Clickable is set to \"true\".
| Technical Name |
Type |
Minimal Agent Version |
| click |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Double Click (WebGUI Text) |
Execute a 'double-click' action on a text control. This activity works only on disabled or read-only controls.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Cursor Position (WebGUI Text) |
Set the cursor position in a text control. The cursor position must be set only for controls with Readonly property set to \"false\". If the cursor position is greater than the size of the text, the action fails with a warning message. For example, in the \"hello\" text string, the cursor position 0 is before the first character, and cursor position 5 is after the last character. Attempt to set the cursor position to 6 leads to a warning message (101).
| Technical Name |
Type |
Minimal Agent Version |
| setCursorPosition |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
Cursor position. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Retrieve the value for a selected element in a text control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the value for a selected element in a text control.
| Technical Name |
Type |
Minimal Agent Version |
| set |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| value |
string |
|
Value to be set. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Set the focus on a specified element in a text control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Text) |
Perform custom actions in the backend of a text control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Text) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Subset of activities related to SAP WebGUI diag toggle button control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a toggle button control. This activity is only supported if the action state Ignored property is \"false\".
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Execute a 'click' action on a toggle button control. This activity is only supported if property Clickable is set to \"true\".
| Technical Name |
Type |
Minimal Agent Version |
| click |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error |
Execute a 'double-click' action on a toggle button control. This activity works only on disabled or read-only controls.
| Technical Name |
Type |
Minimal Agent Version |
| doubleClick |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error |
Retrieve the value for a selected element in a toggle button control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Set the focus on a specified element in a toggle button control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
Perform custom actions in the backend of a toggle button control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class SAP_CalendarControl_1
Subset of activities related to SAP WebGUI OMRT calendar control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a calendar control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Selection (WebGUI Calendar) |
Select the date interval in a calendar control.
| Technical Name |
Type |
Minimal Agent Version |
| setSelection |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| from_date |
string |
|
First date of the date period. |
| to_date |
string |
|
Last date of the date period. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Set Current (WebGUI Calendar) |
Set the focus on a date in the calendar control.
| Technical Name |
Type |
Minimal Agent Version |
| setCurrent |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| date |
string |
|
Date. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Center Visible Range (WebGUI Calendar) |
Center the calendar visible range on the date in a calendar control.
| Technical Name |
Type |
Minimal Agent Version |
| centerVisibleRange |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| date |
string |
|
Date. |
| silent |
boolean |
|
Do not request calendar data from backend, default value 'true'. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Move Visible Range (WebGUI Calendar) |
Move the calendar visible range up or down the time-line in a calendar control.
| Technical Name |
Type |
Minimal Agent Version |
| moveVisibleRange |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| forward_range |
boolean |
|
If set to 'true' move the range of the calendar forward, otherwise move backward. |
| silent |
boolean |
|
Do not request calendar data from backend, default value 'true'. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Pre Selection (WebGUI Calendar) |
Fire a pre-selection event.
| Technical Name |
Type |
Minimal Agent Version |
| preSelection |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| from_date |
string |
|
First date of the date period. |
| to_date |
string |
|
Last date of the date period. |
| sel_mode |
number |
|
Calendar selection mode. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Change the position of the horizontal scroll bar in a calendar control.
| Technical Name |
Type |
Minimal Agent Version |
| scrollHorizontally |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
New scrolling position. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Change the position of the vertical scroll bar in a calendar control.
| Technical Name |
Type |
Minimal Agent Version |
| scrollVertically |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
New scrolling position. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Set Cursor Position (WebGUI Calendar) |
Set the cursor position inside the date picker input field.
| Technical Name |
Type |
Minimal Agent Version |
| setCursorPosition |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| position |
number |
|
New cursor position. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
Drop a drag and drop (DnD) source in a calendar control.
| Technical Name |
Type |
Minimal Agent Version |
| drop |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| drag_control_id |
number |
|
OMRT control identifier (OmrtId) for the DnD source control. |
| drag_handle |
number |
|
Handle (DndHandle property) of the DnD source. |
| drop_handle |
number |
|
Handle (DndHandle property) of the DnD target. |
| drop_node_key |
string |
|
Node key for DnD target. Required if DnD target is TableTree Node control. |
| drag_node_key |
string |
|
Node key for DnD source. Required if DnD source is Table Tree Node control. |
| drag_row |
number |
|
1-based Grid View row index for the DnD source. Required if DnD source is Grid View Cell or Grid View Row control. |
| drag_column |
number |
|
1-based Grid View column index for the DnD source. Required if DnD source is Grid View Cell or Grid View Row control. |
| drag_date |
string |
|
Date of the DnD source. Required if DnD source is Calendar Cell control. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Get Value (WebGUI Calendar) |
Retrieve the value for a selected element in a calendar control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Focus (WebGUI Calendar) |
Set the focus on a specified element in a calendar control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Calendar) |
Perform custom actions in the backend of a calendar control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Calendar) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class SAPGUI_Containerctrl_1
Subset of activities related to SAP WebGUI container control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
| Set Size (WebGUI Container) |
Set container BaseWidth and/or BaseHeight properties in a container control.
| Technical Name |
Type |
Minimal Agent Version |
| setSize |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| width |
number |
|
New container base width in metrics specified by metrics argument. |
| height |
number |
|
New container base height in metrics specified by metrics argument. |
| metrics |
number |
|
Metrics used in width and height arguments. Possible values {0 - default,1 - pexel,2 -mm,3 - DYNPRO}. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Get Value (WebGUI Container) |
Retrieve the value for a selected element in a container control.
| Technical Name |
Type |
Minimal Agent Version |
| get |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| result |
string |
Content of the selected element that has been retrieved. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Set Focus (WebGUI Container) |
Set the focus on a specified element in a container control.
| Technical Name |
Type |
Minimal Agent Version |
| focus |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Custom Action (WebGUI Container) |
Perform custom actions in the backend of a container control.
| Technical Name |
Type |
Minimal Agent Version |
| custom |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| sPrefix |
string |
|
Prefix related to backend. |
| sActionCode |
string |
|
sActionCode related to backend. |
| sType |
string |
|
sType related to backend. |
| aContent |
string |
|
aContent related to backend. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| InvalidArgument |
irpa_core |
provided activity arguments do not match with the required. |
| Check Element (WebGUI Container) |
Check whether a UI element is rendered within an application screen. It can be useful to detect some mandatory UI elements before proceeding.
| Technical Name |
Type |
Minimal Agent Version |
| exist |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Output Parameters:
| Name |
Type |
Description |
| exist |
boolean |
Returns true if the element exists. |
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
Class SAP_HTMLControl_1
Subset of activities related to SAP WebGUI OMRT HTML viewer control.
| Extends |
Technologies of the class |
| irpa_core.core.Element |
SAPWebGui |
Activities :
Request the context menu of a HTML viewer control.
| Technical Name |
Type |
Minimal Agent Version |
| requestMenu |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Errors:
| Error Class |
Package |
Description |
| Timeout |
irpa_core |
timout reached waiting element appearance. |
| SAPWebGuiBackendError |
irpa_sapwebgui |
SAPWebGui backend has thrown a runtime error. |
| Post Data (WebGUI HTML Viewer) |
Submit HTTP POST data that are passed as action arguments to an HTML viewer control. This action supports a variable number of arguments.
| Technical Name |
Type |
Minimal Agent Version |
| postData |
synchronous
|
WIN-2.0.0 (WIN for Windows)
|
Input Parameters:
| Name |
Type |
Attributes |
Description |
| frame_name |
string |
|
HTML document frame name. |
Table of Contents