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 - Monitoring

Collection of functions to add monitoring activities to your automations; these activities will send messages to be collected by the Factory.

Activities

Start Timer

Start the timer.


Technical Name Type Minimal Agent Version
startTimer synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
id string mandatory Timer ID (maximum length: 256 characters).
stepName string optional Step name (maximum length: 50 characters).
stepDescription string optional Step description.
category string optional Category (maximum length: 50 characters).


Split Timer

Split the timer.


Technical Name Type Minimal Agent Version
splitTimer synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
id string mandatory Timer ID; should match a previously defined startTimer ID.
stepName string optional Step name (maximum length: 50 characters).
stepDescription string optional Step description


Stop Timer

Send a notification and resets timer to zero.


Technical Name Type Minimal Agent Version
stopTimer synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
id string mandatory Timer ID; should match a previously defined startTimer ID.
stepName string optional Step name (maximum length: 50 characters).
stepDescription string optional Step description


Cancel Timer

Reset timer to zero.


Technical Name Type Minimal Agent Version
cancelTimer synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
id string mandatory Timer ID; should match a previously defined startTimer ID.


Initialize Counter

Initialize the counter.


Technical Name Type Minimal Agent Version
initCounter synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
id string mandatory Counter ID (maximum length: 256 characters).
value number optional 0 Initial value to set on the counter (default: 0).
category string optional Category (maximum length: 50 characters).


Increment Counter

Increment a counter.


Technical Name Type Minimal Agent Version
incrementCounter synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
id string mandatory Counter ID; should match a previously defined ID.
incrementValue number optional 1 Value by which to increment (default: 1).


Notify

Notify message event.


Technical Name Type Minimal Agent Version
notify synchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
message string mandatory Message to notify.
severity irpa_core.enums.monitoring.severityLevel mandatory Message severity.
category string optional Category (maximum length: 50 characters).