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

Table of Contents

Errors
SAP SuccessFactors application management

Module - SAP SuccessFactors application management

Collection of activities related to SAP SuccessFactors Applications. You can use these activities directly in your project automation.

Class SuccessFactorsPage

SuccessFactors Screen.
Extends Technologies of the class
irpa_core.core.WEBPage SuccessFactors


Activities :

Wait Ready (SuccessFactors)

Keep the runtime execution in wait mode, if the screen is in a busy wait state. A particularity of SAP SuccessFactors based applications 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) MAC-3.17 (WIN for Windows)

Sample Code:

await SAPSF.pSF.waitReady();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance


Class SuccessFactorsSuggestionSearchField

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


Activities :

Search Suggestion Value

Set the value to be searched in SAP SuccessFactors.


Technical Name Type Minimal Agent Version
suggestionSearch synchronous WIN-2.0.0 (WIN for Windows) MAC-3.17 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Value to be searched.
suggestionIndex number optional Index of the suggestion item to be selected. Default value is -1.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SF.pSF.oItem.suggestionSearch('myUser');

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
SuccessFactorsAPICallError irpa_successfactors SAP SuccessFactors injected methods can throw a runtime error.


Class SuccessFactorsSearchInput

The Successfactors Search Input (SFSearchableComboBox will be called here).
Extends Technologies of the class
irpa_core.core.Element SuccessFactors


Activities :

Search Input Value



Technical Name Type Minimal Agent Version
searchInputValue synchronous WIN-2.0.0 (WIN for Windows) MAC-3.17 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Value to be searched.
suggestionIndex number optional Index of the suggestion item to be selected. Default value is -1.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SF.pSF.oItem.searchInputValue('myUser');

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
SuccessFactorsAPICallError irpa_successfactors SAP SuccessFactors injected methods can throw a runtime error.


Class SuccessFactorsElement

The SuccessFactors Element.
Extends Technologies of the class
irpa_core.core.Element SuccessFactors


Activities :

Set Value and Filter Results

Set the value and filter the results in combo box based input controls.


Technical Name Type Minimal Agent Version
SuccessFactorsSet synchronous WIN-2.0.0 (WIN for Windows) MAC-3.17 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Value to be set.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SF.pSF.oItem.SFSet('myUser');

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
SuccessFactorsAPICallError irpa_successfactors SAP SuccessFactors injected methods can throw a runtime error.


Set Value and Press Enter

Set the value and initiate the search for search fields associated with table like controls.


Technical Name Type Minimal Agent Version
SuccessFactorsSearch synchronous WIN-2.0.0 (WIN for Windows) MAC-3.17 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Value to be searched.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SF.pSF.oItem.SFSearch('myUser');

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
SuccessFactorsAPICallError irpa_successfactors SAP SuccessFactors injected methods can throw a runtime error.


Click Element

Simple click activity.


Technical Name Type Minimal Agent Version
SuccessFactorsClick synchronous WIN-2.0.0 (WIN for Windows) MAC-3.17 (WIN for Windows)

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SF.pSF.oItem.SFClick('myUser');

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
SuccessFactorsAPICallError irpa_successfactors SAP SuccessFactors injected methods can throw a runtime error.


Class SuccessFactorsSelect

The SuccessFactors select.
Extends Technologies of the class
irpa_core.core.ComboBox SuccessFactors


Activities :

Select Value By Text

Take the OPTION to be selected from the SELECT control as text and sets/changes the OPTION in the control.


Technical Name Type Minimal Agent Version
SuccessFactorsSelectSet synchronous WIN-2.0.0 (WIN for Windows) MAC-3.17 (WIN for Windows)

Input Parameters:

Name Type Attributes Description
value string Text of the option to be selected.

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SF.pSF.oItem.SFSelectSet('myUser');

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
SuccessFactorsAPICallError irpa_successfactors SAP SuccessFactors injected methods can throw a runtime error.


Class Recorder

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


Activities :

SuccessFactorsRecorder Set

Set the value to a recorded control.


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

Input Parameters:

Name Type Attributes Description
value string Value to be set.
suggestionIndex number optional Index of the suggestion item to be selected. Default value is -1.
pressEnter boolean optional Perform the 'Enter' keystroke after setting the value (false by default).

Output Parameters:

Name Type Description
result any Value.

Sample Code:

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

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
SuccessFactorsAPICallError irpa_successfactors SAP SuccessFactors injected methods can throw a runtime error.


SuccessFactorsRecorder Click

Click a control.


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

Output Parameters:

Name Type Description
result any Value.

Sample Code:

SAPUI5.pSF.oItem.click();

Errors:

Error Class Package Description
Timeout irpa_core timeout reached waiting screen appearance
SuccessFactorsAPICallError irpa_successfactors SAP SuccessFactors injected methods can throw a runtime error.