SAP Help Home SAP Intelligent RPA Help Portal SAP Intelligent RPA Community

Table of Contents

SAPUI5 API
Enumerations and Constants
Errors
SAPUI5 Application Management Updated
Classes
Class SAPUI5Page Wait Ready (SAPUI5 Screen) Get User Name Get User ID Get User Email UI5 Login Class SAPUI5Button Is Element Visible Class SAPUI5PseudoButton Is Element Visible Class SAPUI5Input Is Element Visible Class SAPUI5Slider Set Range Slider Is Element Visible Class SAPUI5CheckBox Check/Uncheck Value Get Checkbox State Is Element Visible Class SAPUI5InputSwitch Set Toggle Switch Is Element Visible Class SAPUI5Radio Select Radio Button Value Get Radio Button State Is Element Visible Class SAPUI5ComboBox Get List from Combo Box Add Element to Combo Box Set Value in Combo Box Set Value in Combo Box Using Key Get Status in Combo Box Is Element Visible Class SAPUI5Calendar Add Appointment Is Element Visible Class SAPUI5ActionSelect Open Action List Is Element Visible Class SAPUI5SearchField Search String Is Element Visible Class SAPUI5MultiInput Add Token Remove All Tokens Remove Token by Value Get Tokens Is Element Visible Class SAPUI5FeedContent Set FeedContent Subheader Get FeedContent Subheader Set FeedContent Text Get FeedContent Text Click FeedContent Is Element Visible Class SAPUI5SegmentButton Get Segmented Buttons Add Segmented Button Is Element Visible Class SAPUI5NavigationList Add Item to Navigation List Get Navigation List Items Is Element Visible Class SAPUI5TAccount Add Credit to T Account Add Debit to T Account Get T Account Credit Get T Account Debit Is Element Visible Class SAPUI5TreeTable Expand Tree Table Row Collapse Tree Table Row Is Element Visible Class SAPUI5Table Select All Table Data Clear Table Data Selection Get Table Data Get Table Row Count Get Table Row Data Set Selected Row Index Table Data Filter Is Element Visible Class SAPUI5Carousel Next Screen Previous Screen Is Element Visible Class SAPUI5ToggleButton Change Toggle Button State Get Toggle State Is Element Visible Class SAPUI5TableRow Is Element Visible Class SAPUI5SuggestionSearchField Set Suggestion Search Deprecated Is Element Visible Class SAPUI5MultiCombobox Set Multiple Items in Multi Combo Box Clear Selection in Multi Combo Box Get Selected Text Items in Multi Combo Box Is Element Visible Class SAPUI5FeedInput Is Element Visible Class SAPUI5Icon Is Element Visible Class SAPUI5UploadCollection Upload File Is Element Visible Class SAPUI5FileBrowser Browse File Is Element Visible Class SAPUI5Recorder Click Element (SAPUI5 Recorder) Set Element (SAPUI5 Recorder) Is Element Visible Class SAPUI5SmartFilterBar Enable Filter New Is Element Visible New Class SAPUI5MTable Get Row Count New Get Column Count New Get Table Data New Load Next Page New Is Element Visible New

Module - SAPUI5 Application Management

Collection of activities related to SAPUI5 Applications. SAPUI5 is a Web technology which extends standard HTML objects. The following functions are designed to work seamlessly with the UI5 objects such as fields, buttons, etc.

Class SAPUI5Page

Collection of activities related to SAPUI5 screens.
Extends Technologies of the class
irpa_core.core.WEBPage SAPUI5


Activities :

Wait Ready (SAPUI5 Screen)

Keep the runtime execution in wait mode, if the screen is in a busy wait state. A particularity of SAPUI5 is that a control can have a busy state that's different from that of the screen. A screen can be loaded although some controls are still loading. To handle this behavior, the Wait Ready activity checks the state of all controls on a screen. The screen is not ready until all controls are ready.


Technical Name Type Minimal Agent Version
waitReady asynchronous WIN-2.0.0 (WIN for Windows)

Sample Code:

await SAPUI5.pUI5.waitReady();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance


Get User Name

Retrieve the full user name in S/4 system.


Technical Name Type Minimal Agent Version
getUserName synchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
result string Returns the user name or an error if the user is not logged in.

Sample Code:

SAPUI5.pUI5.getUserName();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get User ID

Retrieve the full user ID in S/4 system.


Technical Name Type Minimal Agent Version
getUserId synchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
result string Returns the user ID or an error if the user is not logged in.

Sample Code:

SAPUI5.pUI5.getUserId();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get User Email

Retrieve the full user email in S/4 system.


Technical Name Type Minimal Agent Version
getUserEmail synchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
result string Returns the user email or an error if the user is not logged in.

Sample Code:

SAPUI5.pUI5.getUserEmail();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


UI5 Login

Activity to log in to an S/4 system: provide username and password details of the S/4 system and choose the login form type.


Technical Name Type Minimal Agent Version
login asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
userName string Username for the UI5 system.
password string Password for the UI5 system.
loginPageType irpa_sapui5.enums.loginPageType Type of login page for the UI5 system.

Sample Code:

SAPUI5.pUI5.login('ABC','ABC123', 'SAPCloudForm');

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Class SAPUI5Button

The SAPUI5 Button control enables you to trigger actions.
Extends Technologies of the class
irpa_core.core.Button SAPUI5


Activities :

Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5PseudoButton

The SAPUI5 Pseudo Button displays header, sub header, and a customizable main area in a tile format.
Extends Technologies of the class
irpa_core.core.Button SAPUI5


Activities :

Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5Input

The SAPUI5 Input control allows you to enter and edit text or numeric values in one line.
Extends Technologies of the class
irpa_core.core.Edit SAPUI5


Activities :

Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5Slider

The purpose of the SAPUI5 Slider is to enable visual selection of sub-ranges within a given interval.
Extends Technologies of the class
irpa_core.core.Slider SAPUI5


Activities :

Set Range Slider

Set the range values into the range slider.


Technical Name Type Minimal Agent Version
setRange asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
min number Minimum value to be set.
max number Maximum value to be set.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.setRange(0,100);

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid max min value provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5CheckBox

SAPUI5 Checkbox allows you to set a binary value, such as true/false or yes/no for an element.
Extends Technologies of the class
irpa_core.core.CheckBox SAPUI5


Activities :

Check/Uncheck Value

Set the value to check, or clear the check box.


Technical Name Type Minimal Agent Version
check asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value boolean optional Value to be set.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.check(true);

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid argument provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get Checkbox State

Retrieve the status of an checkbox (Checked/Unchecked).


Technical Name Type Minimal Agent Version
getCheckBoxState asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Returns true if the checkbox is checked, false if not.

Sample Code:

SAPUI5.pUI5.oItem.getCheckBoxState();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5InputSwitch

A SAPUI5 Switch is a user interface control on mobile devices that is used for change between binary states.
Extends Technologies of the class
irpa_core.core.CheckBox SAPUI5


Activities :

Set Toggle Switch

Set the value of a toggle switch (On/Off).


Technical Name Type Minimal Agent Version
toggleSwitch asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value boolean optional Value to be set.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Returns true if the toggle switch value has been set, false if not.

Sample Code:

SAPUI5.pUI5.oItem.toggleSwitch(true);

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid argument provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5Radio

SAPUI5 Radio Button is similar to a checkbox, but it allows you to choose only one of the predefined set of options.
Extends Technologies of the class
irpa_core.core.RadioButton SAPUI5


Activities :

Select Radio Button Value

Set the value of an element (Selected/Unselected).


Technical Name Type Minimal Agent Version
select asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value boolean optional Value to be set: true or false.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.select();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid argument provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get Radio Button State

Retrieve the status of an element (Selected/Unselected).


Technical Name Type Minimal Agent Version
getRadioButtonState asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Returns true if the radio button is selected, false if not.

Sample Code:

SAPUI5.pUI5.oItem.getRadioButtonState();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5ComboBox

The SAPUI5 Combo Box provides a drop-down list for selecting and filtering values. You can either type a value directly into the control or choose from a list of existing elements.
Extends Technologies of the class
irpa_core.core.ComboBox SAPUI5


Activities :

Get List from Combo Box

Retrieve a list of elements from the Combo Box.


Technical Name Type Minimal Agent Version
getList asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Returns the list of values set into the Combo Box.

Sample Code:

SAPUI5.pUI5.oItem.getList();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Add Element to Combo Box

Add a new element and associated key to the Combo Box list.


Technical Name Type Minimal Agent Version
addItem asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
data string Data value to be set.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.addItem("{"text": "SampleText", "key": "SampleKey"}");

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Set Value in Combo Box

Set a value to an element in the Combo Box.


Technical Name Type Minimal Agent Version
setByValue asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
data string Data value to be set.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.setByValue("Cuba");

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Set Value in Combo Box Using Key

Set a value to an element in the Combo Box using a key


Technical Name Type Minimal Agent Version
setByKey asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
key string Provide the key for the data value to be set
testExist boolean optional If true, tests if the element exists before setting a value
ifDefined boolean optional If true, sets the value only if defined

Output Parameters:

Name Type Description
result any Value

Sample Code:

SAPUI5.pUI5.oItem.setByKey("BH");

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get Status in Combo Box

Retrieve the status (enabled/disabled) of an element in the Combo Box.


Technical Name Type Minimal Agent Version
getEnabled asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.

Output Parameters:

Name Type Description
result any Returns true if the element is enabled, false if not.

Sample Code:

SAPUI5.pUI5.oItem.getEnabled();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5Calendar

The SAPUI5 Calendar displays a calendar of a single entity (such as a person or a resource) for a selected time period.
Extends Technologies of the class
irpa_core.core.Element SAPUI5


Activities :

Add Appointment

Create a new appointment in the calendar.


Technical Name Type Minimal Agent Version
addItem asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
title string Title of the appointment.
subTitle string Subtitle of the appointment.
type irpa_sapui5.enums.meetingType Meeting type to set for the appointment. For example, to set a team meeting, select TeamMeeting from the drop down list. Other meeting types are: Personal, Discussions, OutofOffice, PrivateMeeting.
startDate string Start date of the appointment. Example: "2018, 7, 9, 5, 0, 0". i.e. "YYYY,MM,DD,HH,MM,SS".
endDate string End date of the appointment. Example: "2018, 7, 9, 6, 0, 0". i.e. "YYYY,MM,DD,HH,MM,SS".
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Returns 'success' if the appointment has been successfully created.

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5ActionSelect

The SAPUI5 Action Select control provides a list of predefined items that allows you to choose options and additionally trigger some actions.
Extends Technologies of the class
irpa_core.core.ComboBox SAPUI5


Activities :

Open Action List

Open the action drop-down list.


Technical Name Type Minimal Agent Version
open asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.open('myUser');

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5SearchField

The SAPUI5 Search Field control is needed when you wants to find specific information in large amounts of data. The search field is also the control of choice for filtering down a given amount of information.
Extends Technologies of the class
irpa_core.core.Edit SAPUI5


Activities :

Set a text to be searched in the search text field.


Technical Name Type Minimal Agent Version
search asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Value to be set.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.search();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5MultiInput

The SAPUI5 Multi Input field allows you to enter multiple values, which are displayed as tokens.
Extends Technologies of the class
irpa_core.core.Edit SAPUI5


Activities :

Add Token

Set a value to add a new token.


Technical Name Type Minimal Agent Version
addToken asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
data string Value to be set. Format: "{"text": "SampleText", "key": "SampleKey"}".
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.addToken("{"text": "SampleText", "key": "SampleKey"}");

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Remove All Tokens

Remove all the tokens.


Technical Name Type Minimal Agent Version
removeAllTokens asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.removeAllTokens();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Remove Token by Value

Remove a token corresponding to a defined value.


Technical Name Type Minimal Agent Version
removeToken asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
data string Data value to be removed.
testExist boolean optional If set to true, tests the existence of the element before removing a value.
ifDefined boolean optional If set to true, remove the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.removeToken("Token 1");

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get Tokens

Retrieve the available tokens.


Technical Name Type Minimal Agent Version
getToken asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Returns all the available tokens that can be set.

Sample Code:

SAPUI5.pUI5.oItem.getToken();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5FeedContent

The SAPUI5 FeedContent control displays a tile containing the text of the feed, a subheader, and a numeric value.
Extends Technologies of the class
irpa_core.core.Button SAPUI5


Activities :

Set FeedContent Subheader

Set the subheader value of a FeedContent control.


Technical Name Type Minimal Agent Version
setSubheader asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Value to be set.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.setSubheader("text");

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get FeedContent Subheader

Retrieve the subheader value of a FeedContent control.


Technical Name Type Minimal Agent Version
getSubheader asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Returns the subheader value.

Sample Code:

SAPUI5.pUI5.oItem.getSubheader();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Set FeedContent Text

Set the text of a FeedContent control.


Technical Name Type Minimal Agent Version
setContentText asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Value to be set.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.setContentText("text");

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get FeedContent Text

Retrieve all the text content of a FeedContent control.


Technical Name Type Minimal Agent Version
getAltText asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Returns all text values available in the FeedContent control.

Sample Code:

SAPUI5.pUI5.oItem.getAltText();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Click FeedContent

Click a FeedContent control.


Technical Name Type Minimal Agent Version
press asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.press();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5SegmentButton

The SAPUI5 Segmented Button allows you to pick one out of many options for displaying the content of the current page.
Extends Technologies of the class
irpa_core.core.List SAPUI5


Activities :

Get Segmented Buttons

Retrieve the list of buttons and keys available in segmented buttons.


Technical Name Type Minimal Agent Version
getItems asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Returns all the available segmented buttons.

Sample Code:

SAPUI5.pUI5.oItem.getItems();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Add Segmented Button

Add a new segmented button.


Technical Name Type Minimal Agent Version
addItem asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Value to be set. Format: "{"text": "SampleText", "key": "SampleKey"}".
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.addItem("{"text": "SampleText", "key": "SampleKey"}");

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5NavigationList

The SAPUI5 Navigation List control is an interactive control, which provides a choice of different items, ordered as a list.
Extends Technologies of the class
irpa_core.core.List SAPUI5


Activities :

Add Item to Navigation List

Add an item to a navigation list.


Technical Name Type Minimal Agent Version
addItem asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Value to be set. Format: "{"text": "SampleText", "key": "SampleKey"}".
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.addItem("{"text": "SampleText", "key": "SampleKey"}");

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get Navigation List Items

Retrieve all the items of a navigation list.


Technical Name Type Minimal Agent Version
getItems asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Returns all navigation list items.

Sample Code:

SAPUI5.pUI5.oItem.getItems();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5TAccount

The SAPUI5 T Account control displays debit and credit entries on a general ledger account. It can be used to visualize the flow of transactions through the accounts where these transactions are stored.
Extends Technologies of the class
irpa_core.core.Element SAPUI5


Activities :

Add Credit to T Account

Add a credit amount to the credit part of a T account.


Technical Name Type Minimal Agent Version
addCredit asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
val number Value to be set.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.addCredit(2000);

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Add Debit to T Account

Add a debit amount to the debit part of a T account.


Technical Name Type Minimal Agent Version
addDebit asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
val number Value to be set.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.addDebit(200);

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get T Account Credit

Retrieve the amount of a selected credit entry in a T account.


Technical Name Type Minimal Agent Version
getCredit asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value number Value to retrieve credit amount.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Returns the selected credit data.

Sample Code:

SAPUI5.pUI5.oItem.getCredit(0);

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get T Account Debit

Retrieve the amount of a selected debit entry in a T account.


Technical Name Type Minimal Agent Version
getDebit asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value number Value to retrieve debit amount.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Returns the selected debit data.

Sample Code:

SAPUI5.pUI5.oItem.getDebit(0);

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5TreeTable

The SAPUI5 Tree Table control provides a comprehensive set of features to display hierarchical data.
Extends Technologies of the class
irpa_core.core.Tree SAPUI5


Activities :

Expand Tree Table Row

Expand a row in a tree table.


Technical Name Type Minimal Agent Version
expand asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value number Value to be set.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.expand(0);

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Collapse Tree Table Row

Collapse an expanded row in a tree table.


Technical Name Type Minimal Agent Version
collapse asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value number Value to be set.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.collapse(0);

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5Table

The SAPUI5 Table control provides a comprehensive set of features for displaying and dealing with vast amounts of data.
Extends Technologies of the class
irpa_core.core.Element SAPUI5


Activities :

Select All Table Data

Select all the data from a table.


Technical Name Type Minimal Agent Version
selectAll asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.selectAll();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Clear Table Data Selection

Clear the selected data in a table.


Technical Name Type Minimal Agent Version
clearSelection asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.clearSelection();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get Table Data

Retrieve the entire data from a table in JSON format.


Technical Name Type Minimal Agent Version
getTableData asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.

Output Parameters:

Name Type Description
result any Returns entire table data in JSON format.

Sample Code:

SAPUI5.pUI5.oItem.getTableData();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get Table Row Count

Retrieve the number of rows in a table.


Technical Name Type Minimal Agent Version
getRowCount asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.

Output Parameters:

Name Type Description
result any Returns the total number of rows of the table.

Sample Code:

SAPUI5.pUI5.oItem.getRowCount();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get Table Row Data

Retrieve the data of a row in a table based on a selected index.


Technical Name Type Minimal Agent Version
getRowDatabyIndex asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
Index number Index of the row.
testExist boolean optional If set to true, tests the existence of the element before setting a value.

Output Parameters:

Name Type Description
result any Returns the row data of a selected index.

Sample Code:

SAPUI5.pUI5.oItem.getRowDatabyIndex();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Set Selected Row Index

Set a specific row in a table via the row index.


Technical Name Type Minimal Agent Version
setSelectedIndex asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value number Index of the row for selection.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.setSelectedIndex(0);

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Table Data Filter

Filter the data in a table.


Technical Name Type Minimal Agent Version
filter asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
data string Data to provide to perform filter in the table.
columnNumber number Column number.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.filter();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5Carousel

The SAPUI5 Carousel allows you to browse through a set of items by swiping right or left.
Extends Technologies of the class
irpa_core.core.Element SAPUI5


Activities :

Next Screen

Swipe to move to the next screen.


Technical Name Type Minimal Agent Version
next asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.next();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Previous Screen

Swipe to move to the previous screen.


Technical Name Type Minimal Agent Version
previous asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.previous();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5ToggleButton

The SAPUI5 Toggle Button component is an enhanced UI5 button that can be toggled between pressed and normal states. You can use the component as a switch to turn a setting on or off. It can also be used to represent an independent choice similar to a check box.
Extends Technologies of the class
irpa_core.core.CheckBox SAPUI5


Activities :

Change Toggle Button State

Change the state of a toggle button.


Technical Name Type Minimal Agent Version
toggle asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value boolean optional Value.
testExist boolean optional If true, tests if the element exists before setting a value.

Output Parameters:

Name Type Description
result any Result.

Sample Code:

SAPS4.pHome.btToggleFilter.toggle(true);

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get Toggle State

Retrieve the state of a toggle button.


Technical Name Type Minimal Agent Version
getToggleState asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
result any Returns the state of the toggle button.

Sample Code:

SAPS4.pHome.btToggleFilter.getToggleState();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5TableRow

SAPUI5 Table Row is a subclass of the SAPUI5 Table control.
Extends Technologies of the class
irpa_core.core.Element SAPUI5


Activities :

Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5SuggestionSearchField

The SAPUI5 Suggestion Search Field is an input field to search for a specific item. Used to make specific searches in SAP SuccessFactors.
Extends Technologies of the class
irpa_core.core.ComboBox SAPUI5


Activities :

Set Suggestion Search Deprecated

Set the value to be searched in SAP SuccessFactors.


Technical Name Type Minimal Agent Version
suggestionSearch asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Value to be searched.
testExist boolean optional If set to true, tests the existence of the element before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.oItem.suggestionSearch('myUser');

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5MultiCombobox

The SAPUI5 Multi Combo Box control provides a list box with items and a text field allowing you to either type a value directly into the control or choose from the list of existing items.
Extends Technologies of the class
irpa_core.core.ComboBox SAPUI5


Activities :

Set Multiple Items in Multi Combo Box

Set multiple items in Multi Combo Box. The Multi Combo Box control provides a list box with items and a text field allowing the user to either type a value directly into the control or choose from the list of existing items.


Technical Name Type Minimal Agent Version
setMultiple asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
values string Values to set for Multi Combo Box.
testExist boolean optional Set to true to test the existence before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.multiCombobox.setMultiple("["Goldberry", "Comfort Easy", "Smart Design"]");

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Clear Selection in Multi Combo Box

Clear item selections in Multi Combo Box. The Multi Combo Box control provides a list box with items and a text field allowing the user to either type a value directly into the control or choose from the list of existing items.


Technical Name Type Minimal Agent Version
clear asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
values string optional Optional: do not provide any parameter to clear all data. For single or multiple data removal, provide "["Goldberry", "Comfort Easy", "Smart Design"]".
testExist boolean optional Set to true to test the existence before setting a value.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pUI5.multiCombobox.clear();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid data format provided
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Get Selected Text Items in Multi Combo Box

Retrieve all the selected text items in Multi Combo Box. The Multi Combo Box control provides a list box with items and a text field allowing the user to either type a value directly into the control or choose from the list of existing items.


Technical Name Type Minimal Agent Version
getSelected asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
result any Returns the values of selected elements from the Multi Combo Box.

Sample Code:

SAPUI5.pUI5.multiCombobox.getSelected();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5FeedInput

The SAPUI5 Input control allows you to enter and edit text or numeric values in one line.
Extends Technologies of the class
irpa_core.core.Edit SAPUI5


Activities :

Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5Icon

The SAPUI5 Icon control uses embedded font instead of pixel image.
Extends Technologies of the class
irpa_core.core.Button SAPUI5


Activities :

Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5UploadCollection

The SAPUI5 Icon control uses embedded font instead of pixel image.
Extends Technologies of the class
irpa_core.core.Button SAPUI5


Activities :

Upload File



Technical Name Type Minimal Agent Version
uploadFile asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Value to be set.
serviceURL string optional Service URL where the file needs to be uploaded.
testExist boolean optional If set to true, tests existence before setting value.
ifDefined boolean optional If set to true, sets the value only if defined.

Output Parameters:

Name Type Description
result any Result.

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
InvalidArgument irpa_core Invalid data format provided
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5FileBrowser

The SAPUI5 File Browser control allow you to browse file from file system.
Extends Technologies of the class
irpa_core.core.Button SAPUI5


Activities :

Browse File

Click on an &#x2018Add file button&#x2019 and upload a file from the file system.


Technical Name Type Minimal Agent Version
browseFile asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Absolute file path of the file to upload.
testExist boolean optional Set to true to test the existence before setting a value.
ifDefined boolean optional If set to true, set the value only if defined.

Output Parameters:

Name Type Description
result any Result.

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found
InvalidArgument irpa_core Invalid data format provided
SAPUI5APICallError irpa_sapui5 SAPUI5 injected mothods thrown a runtime error


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5Recorder

The SAPUI5 recorder control to handle all the recorder based interactions.
Extends Technologies of the class
irpa_core.core.Element SAPUI5


Activities :

Click Element (SAPUI5 Recorder)

Click on a clickable SAPUI5 recorded element.


Technical Name Type Minimal Agent Version
click asynchronous WIN-2.0.0 (WIN for Windows)

Sample Code:

SAPUI5.pHome.oItem.click();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
NotFound irpa_core item not found


Set Element (SAPUI5 Recorder)

Set the value to a recorded SAPUI5 control.


Technical Name Type Minimal Agent Version
set asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Value to be set.
key string optional If true, implements the keyboard &#x201CEnter&#x201D.

Sample Code:

SAPUI5.pUI5.oItem.set('myUser');

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
InvalidArgument irpa_core Invalid argument provided
NotFound irpa_core item not found


Is Element Visible

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5SmartFilterBar

SmartFilterBar creates a FilterBar based on the OData metadata
Extends Technologies of the class
irpa_core.core.Element SAPUI5


Activities :

Enable Filter New

Enables the specified filters in the SmartFilterBar


Technical Name Type Minimal Agent Version
enableSmartFilter asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
filtersToEnable New string Name of the filters to be enabled, separated by a comma.

Output Parameters:

Name Type Description
result New string Result

Sample Code:

SAPUI5.pUI5.oItem.enableSmartFilter('Status');

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid argument provided
NotFound irpa_core Item not found.
SAPUI5APICallError irpa_sapui5 Runtime Error by SAPUI5 Methods.


Is Element Visible New

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible New boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();



Class SAPUI5MTable

The SAPUI5MTable control provides a set of sophisticated and convenient functions for responsive table design.
Extends Technologies of the class
irpa_core.core.Element SAPUI5


Activities :

Get Row Count New

Returns the row count of the table that contains total rows and actually loaded row counts


Technical Name Type Minimal Agent Version
getRowCount asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
rowCount New any Object that contains 'totalRows' and 'loadedRows' rows in the table

Sample Code:

SAPUI5.pUI5.oItem.getRowCount();

Errors:

Error Class Package Description
Timeout irpa_core Timeout reached waiting activity completion.
NotFound irpa_core Item not found.
SAPUI5APICallError irpa_sapui5 Runtime Error by SAPUI5 Methods.


Get Column Count New

Returns the column count of the table


Technical Name Type Minimal Agent Version
getColumnCount asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
colummCount New any The total number of columns in the table

Sample Code:

SAPUI5.pUI5.oItem.getColumnCount();

Errors:

Error Class Package Description
Timeout irpa_core Timeout reached waiting activity completion.
NotFound irpa_core Item not found.
SAPUI5APICallError irpa_sapui5 Runtime Error by SAPUI5 Methods.


Get Table Data New

Returns the loaded row items from the m.Table


Technical Name Type Minimal Agent Version
getMTableData asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
startIndex New number optional Index of start row. Default value is '0'.
length New number optional Number of rows to fetch. The default value is the page size of the table (number of rows in a page).

Output Parameters:

Name Type Description
tableData New any Specifed number of row items from the table

Sample Code:

SAPUI5.pUI5.oItem.getMTableData();

Errors:

Error Class Package Description
Timeout irpa_core Timeout reached waiting activity completion.
NotFound irpa_core Item not found.
SAPUI5APICallError irpa_sapui5 Runtime Error by SAPUI5 Methods.


Load Next Page New

Loads the next page or the number of row items specified in the m.Table


Technical Name Type Minimal Agent Version
loadNextPage asynchronous WIN-2.0.0 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
numberOfRows New number optional Number of rows to load. If this is not specified, the system fetches the next page.

Sample Code:

SAPUI5.pUI5.oItem.loadNextPage();

Errors:

Error Class Package Description
Timeout irpa_core Timeout reached waiting activity completion.
NotFound irpa_core Item not found.
SAPUI5APICallError irpa_sapui5 Runtime Error by SAPUI5 Methods.


Is Element Visible New

Check if a UI element is visible or not


Technical Name Type Minimal Agent Version
isElementVisible asynchronous WIN-2.0.0 (WIN for Windows)

Output Parameters:

Name Type Description
isVisible New boolean Returns &#x2018True&#x2019 if the element is visible

Sample Code:

SAPUI5.pUI5.oItem.isElementVisible();