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

Table of Contents

Core SDK
Automation Alerting
Base64 Encoding
Clipboard
Converters (JS, JSON, XML...)
Cryptography collection
Data Type Management
Diagnostics
SAP Document Management System (DMS) Module
Enumerations and Constants
Errors
File System (FS)
File Transfer Protocol (FTP)
Information
List Management
Monitoring
Mouse
Dialogs
Registry
HTTP Request
SAP GUI
SAP S/4HANA Cloud API Access Token Module
Security
UIAutomation
Variable Management
Local Agent Variables
Local Agent Credentials
WMI Client

Module - Dialogs

Collection of functions to display a dialog for users. Users can receive or supply information.

Activities

Information Dialog (Blocking)

Opens a simple information dialog. The dialog needs to be closed by the user and may put on hold the rest of the automation.


Technical Name Type Minimal Agent Version
openMessageDialog asynchronous WIN-3.24, MAC-3.24

Input Parameters:

Name Type Attributes Default Description
dialogParams irpa_core.messageDialogParameters mandatory Dialog parameters.

Output Parameters:

Name Type Description
clickedButton string Clicked button ID.

Sample Code:

const res = await irpa_core.dialog.openMessageDialog({ message: 'a message', template: irpa_core.enums.popup.messageDialogType.OkCancel });



Information Dialog (Non-blocking)

Opens a simple and asynchronous information dialog . The dialog doesn't need to be closed by the user.


Technical Name Type Minimal Agent Version
openMessageDialogAsync asynchronous WIN-3.24, MAC-3.24

Input Parameters:

Name Type Attributes Default Description
dialogParams irpa_core.messageDialogParameters mandatory Dialog parameters.

Output Parameters:

Name Type Description
dialogId string Dialog identifier (to be used by the "Close Dialog" activity if needed).

Sample Code:

const res = await irpa_core.dialog.openMessageDialogAsync({ message: 'a message', template: irpa_core.enums.popup.messageDialogType.OkCancel });



Input Dialog

Open a simple input dialog.


Technical Name Type Minimal Agent Version
openInputDialog asynchronous WIN-3.24, MAC-3.24

Input Parameters:

Name Type Attributes Default Description
dialogParams irpa_core.inputDialogParameters mandatory Dialog parameters.

Output Parameters:

Name Type Description
inputValue string Returns the input value given by the user if the 'Ok' button is clicked. Returns null otherwise.

Sample Code:

const res = await irpa_core.dialog.openInputDialog({ identifier: 'anId', inputId: 'username', inputLabel: 'Username', template: irpa_core.enums.popup.inputDialogType.OkCancel });



Close Dialog

Closes a dialog with a specific and valid ID.


Technical Name Type Minimal Agent Version
closeDialog synchronous WIN-3.24, MAC-3.24

Input Parameters:

Name Type Attributes Default Description
dialogId any mandatory Dialog ID.

Sample Code:

irpa_core.dialog.closeDialog('anID');



Open Progress Dialog

Opens a dialog containing a text and a progress indicator


Technical Name Type Minimal Agent Version
progressDialog.openProgressDialog asynchronous WIN-3.24, MAC-3.24

Input Parameters:

Name Type Attributes Default Description
progressDialogParameters irpa_core.progressDialogParameters mandatory

Sample Code:

await irpa_core.dialog.progressDialog.openProgressDialog({message: 'test', progressValue: 25, progressMethod: 'ValueBased', progressDialogTemplate: 'Hide'});



Update Progress Dialog

Updates a progress dialog


Technical Name Type Minimal Agent Version
progressDialog.updateProgressDialog synchronous WIN-3.24, MAC-3.24

Input Parameters:

Name Type Attributes Default Description
updateProgressDialogParameters irpa_core.updateProgressDialogParameters mandatory

Sample Code:

irpa_core.dialog.progressDialog.updateProgressDialog({message: 'test', progressValue: 25});



Close Progress Dialog

Closes a progress dialog


Technical Name Type Minimal Agent Version
progressDialog.closeProgressDialog synchronous WIN-3.24, MAC-3.24

Sample Code:

irpa_core.dialog.progressDialog.closeProgressDialog();