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 - Local Agent Variables

Collection of activities to retrieve and read variables from the local Agent.

Activities

Get Local Agent Variable

Retrieve a variable from the local Agent.


Technical Name Type Minimal Agent Version
getLocalAgentVariable asynchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
variableName string mandatory Variable name. To access a sub-project variable, you must prefix it with the relevant project name, for example 'subProj.myVarName’.
variableScope irpa_core.enums.variableScope optional project Variable scope.
defaultValue any optional Default value: undefined if not set.

Output Parameters:

Name Type Description
value any Variable value.

Errors:

Error Class Package Description
InvalidArgument irpa_core arguments should be defined


Set Local Agent Variable

Set or update a persisted local Agent variable.


Technical Name Type Minimal Agent Version
setLocalAgentVariable asynchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
variableName string mandatory Variable name. To update a sub-project variable, you must prefix it with the relevant project name, for example 'subProj.myVarName’.
variableValue any mandatory Variable value.
variableScope irpa_core.enums.variableScope optional project Variable scope.
cyphered boolean optional false If the variable value is set to true, it is encrypted. (If it is not true, it is persisted as plain text.)

Output Parameters:

Name Type Description
result boolean True if set.

Errors:

Error Class Package Description
InvalidArgument irpa_core arguments should be defined


Delete Local Agent Variable

Delete a local Agent persistent variable.


Technical Name Type Minimal Agent Version
deleteLocalAgentVariable asynchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
variableName string mandatory Variable name.
variableScope irpa_core.enums.variableScope optional project Variable scope.

Errors:

Error Class Package Description
InvalidArgument irpa_core arguments should be defined


List Local Agent Variables

List local Agent persistent variables.


Technical Name Type Minimal Agent Version
listLocalAgentVariables asynchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
variableScope irpa_core.enums.variableScope optional project Variable scope.

Output Parameters:

Name Type Description
list Array. List of variables.


Clear Local Agent Variables

Clear local Agent persistent variables.


Technical Name Type Minimal Agent Version
clearLocalAgentVariables asynchronous WIN-3.24, MAC-3.24, CLOUD-3.34

Input Parameters:

Name Type Attributes Default Description
confirm boolean mandatory Confirm status.
variableScope irpa_core.enums.variableScope optional project Variable scope.