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

Module - Enumerations and Constants

Collection of enumerations and constants for various object models in the SAP Intelligent RPA application.
Auto-completion can help discovering the possible enumerated values.

Enumerations

platform

Specifies the computer operating system

Type:

string

Parameters:

Name Description
darwin Mac OS
win32 Windows

architecture

Specifies the CPU architecture

Type:

string

Parameters:

Name Description
arm ARM 32 bits processor
arm64 ARM 64 bits processor
ia32 Intel 32 bits architecture
x64 Intel 64 bits architecture

error

Specifies a standard error or status information returned from the server.

Type:

string

Parameters:

Name Description
None Undefined error.
OK Standard response for successful requests.
KO Generic failure.
Fail Generic failure.
NotImplemented Not implemented functions.
NotSupported Not supported functions.
InvalidArgument Invalid arguments in a function call.
InvalidCommand Unknown command in a function call.
NotConnected Unconnected channel.
UndefinedObject Undefined object.
NotFound Object not found.
Duplicated Name or identifier is not unique.
Reserved Name or identifier is reserved.
TimeOut Treatment or automation failed in timeout.
Canceled Treatment or automation was cancelled.
NoAttendedLicence No license to run attended jobs.
ConcurrentQuotaReached Maximum number of concurrent attended execution reached. Cannot add job.
NoUnattendedLicence No license to run unattended jobs.
JobFailed Generic message when job fails.
AddJobFailed Generic message when a job cannot be added.

path

Project Path. Note that this location is cleared periodically.

Type:

string

Parameters:

Name Description
root Main project root directory,
current Current project root directory,
files Current project files directory,
log Main Project log directory,

file.encoding

File encoding (ASCII, UTF-8, ...)

Type:

string

Parameters:

Name Description
ASCII ASCII.
Binary Binary.
UTF8 UTF-8.
UTF16 UTF-16.
Base64 Base64.

file.carriageReturn

Carriage return (CRLF, CR, ...)

Type:

string

Parameters:

Name Description
None None.
CRLF CR+LF.
CR CR.

html.event

HTML attribute type (ID, name, class, ...).

Type:

string

Parameters:

Name Description
blur blur
click click
change change
dbclick dbclick
focus focus
focusin focusin
focusout focusout
input input
keydown keydown
keypress keypress
keyup keyup
contextmenu contextmenu
dblclick dblclick
mousedown mousedown
mouseup mouseup
mousemove mousemove
mouseover mouseover
mouseout mouseout
mouseenter mouseenter
mouseleave mouseleave
submit submit

html.type

HTML attribute type (ID, name, class, ...)

Type:

string

Parameters:

Name Description
id Object ID
name Object Name
tag Object Tag
class Object Class

html.position

Relative insertion position for HTML objects

Type:

string

Parameters:

Name Description
beforeBegin Inserts HTML immediately before the object.
afterBegin Inserts HTML after the start of the object but before all other content in the object.
beforeEnd Inserts HTML immediately before the end of the object but after all other content in the object.
afterEnd Inserts HTML immediately after the end of the object.

key

Special keyboard keys (Shift, Ctrl, F1, F2, ...).

Type:

string

Parameters:

Name Description
Add + key.
Alt Alt key.
Attn ATTN key.
Back Back key.
BackTab Back Tab key (HLLAPI specific)
Clear Clear key (HLLAPI specific).
ContextMenu Context Menu key.
Ctrl Control key.
Decimal Decimal key.
Del Delete key.
Divide / key.
Down Down key.
End End key.
Enter Enter key.
Erase Erase key (HLLAPI specific).
Esc Escape key.
F1 F1 key.
F2 F2 key.
F3 F3 key.
F4 F4 key.
F5 F5 key.
F6 F6 key.
F7 F7 key.
F8 F8 key.
F9 F9 key.
F10 F10 key.
F11 F11 key.
F12 F12 key.
F13 F13 key.
F14 F14 key.
F15 F15 key.
F16 F16 key.
F17 F17 key.
F18 F18 key.
F19 F19 key.
F20 F20 key.
F21 F21 key.
F22 F22 key.
F23 F23 key.
F24 F24 key.
Home Home key.
Insert Insert key.
Left Left key.
Multiply * key.
NumEnter Enter key on numeric keyboard.
PA1 PA1 key (HLLAPI specific).
PA2 PA2 key (HLLAPI specific).
PA3 PA3 key (HLLAPI specific).
PageDown Page Down key.
PageUp Page Up key.
Pause Pause key.
PrintScreen Print Screen key.
Reset Reset key (HLLAPI specific).
Right Right key.
ScrollLock Scroll Lock key.
Shift Shift key.
Space Space key.
Substract - key.
Tab Tab key.
Up Up key.

launchFlag

Collection of process launch flags for various window states of the application such as Show, Hide, Maximized, Minimized...

Type:

string

Parameters:

Name Description
Maximize When the application is started or launched, the application window covers the whole working area.
Minimize When the application is started or launched, the application window is minimized.
Hide When the application is started or launched, the application window is hidden in the system.
Show The application is visible in the system.
ShowMaximized When the application is started or launched, the application window is displayed in maximized mode.

logEventType

Type used to store a message in Windows Event Viewer.

Type:

number

Parameters:

Name Description
Success Success.
Error Error.
Warning Warning.
Information Information.
AuditSuccess Audit success.
AuditFailure Audit failure.

logType

Type used to display an irpa_core.log icon.

Type:

number

Parameters:

Name Description
Info Info.
Error Error.
Question Question.
Warning Warning.
Event Event.
Data Data.
Action Action.
UserAction User action.

Standard Web navigators.

Type:

string

Parameters:

Name Description
Chrome Google Chrome.
Edge Edge
IE Internet Explorer.
Firefox Firefox.

popup.display

Screen used to display a popup.

Type:

string

Parameters:

Name Description
Main 'Main' display.
Left 'Left' display.
Right 'Right' display.
Primary 'Primary' display.
Secondary 'Secondary' display.
Third 'Third' display.
Fourth 'Fourth' display.
Undefined Undefined.

popup.horizontalPosition

Horizontal position.

Type:

string

Parameters:

Name Description
None Undefined position.
Left Left position.
Right Right position.
Center Center position.

popup.verticalPosition

Vertical position.

Type:

string

Parameters:

Name Description
None Undefined position.
Top Top position.
Bottom Bottom position.
Center Center position.

popup.messageDialogType

Buttons to display to answer a question in a message popup.

Type:

string

Parameters:

Name Description
Ok Display template with 'OK' button.
Close Display template with 'Close' button.
YesNo Display template with 'Yes', 'No' buttons.
OkCancel Display template with 'OK', 'Cancel' buttons.

popup.inputDialogType

Buttons to display to answer a question in an input popup.

Type:

string

Parameters:

Name Description
Ok Display template with 'OK' button.
OkCancel Display template with 'OK', 'Cancel' buttons.

registry.root

Registry Key root.

Type:

string

Parameters:

Name Description
CurrentUser HKEY_CURRENT_USER.
LocalMachine HKEY_LOCAL_MACHINE.
ClassesRoot HKEY_CLASSES_ROOT.
Users HKEY_USERS.
CurrentConfig HKEY_CURRENT_CONFIG.

registry.type

Registry Key type.

Type:

string

Parameters:

Name Description
Binary Binary value.
ExpandString Expandable string.
MultiString Array of strings.
Number Number.
String String.

targetFrame

Target frame name of the frame in which to display the resource.

Type:

string

Parameters:

Name Description
Blank Load the link into a new unnamed window.
Parent Load the link into the immediate parent of the document that contains the link.
Self Load the link into the same window in which the link was clicked.
Top Load the link into the full body of the current window.

windowBarType

Browser bar style.

Type:

string

Parameters:

Name Description
AddressBar Address bar.
Browser Full browser.
MenuBar Menu bar.
StatusBar Status bar.
ToolBar Tool bar.

tiffCompression

Enumeration to define the TIFF compression. There is no compression by default.

Type:

string

Parameters:

Name Description
compressionLZW LZW compression for TIFF.
compressionCCITT3 CCITT3 compression for TIFF.
compressionCCITT4 CCITT4 compression for TIFF.
compressionRle CCITT4 compression for TIFF.

imgType

Enumeration to define an image format.

Type:

string

Parameters:

Name Description
imgTypeJPG Image in JPG format.
imgTypeTIFF Image in TIFF format.
imgTypeBMP Image in BMP format.
imgTypePNG Image in PNG format.

captureRenderer

Enumeration to define the capture rendering. The default capture rendering is Print window.

Type:

string

Parameters:

Name Description
printWindow Print window
screenshot Simple screenshot

cryptography.algorithmEncryption

Encryption algorithm

Type:

string

Parameters:

Name Description
NIST_AES128_CBC NIST_AES128_CBC
NIST_AES192_CBC NIST_AES192_CBC
NIST_AES256_CBC NIST_AES256_CBC
NIST_AES128_WRAP NIST_AES128_WRAP
NIST_AES192_WRAP NIST_AES192_WRAP
NIST_AES256_WRAP NIST_AES256_WRAP

cryptography.algorithmSignature

Signature algorithm

Type:

string

Parameters:

Name Description
RSAES_OAEP RSAES_OAEP
NIST_sha256 NIST_sha256
NIST_sha384 NIST_sha384
NIST_sha512 NIST_sha512

cryptography.usage

Cyphering key type

Type:

string

Parameters:

Name Description
signature signature/authentication
encryption encryption/decryption

cryptography.storeLocation

Certificate store location

Type:

number

Parameters:

Name Description
currentUser Current user
localMachine Local machine
currentService Current service
services Services
users Users
currentUserGroupPolicy Current user group policy
localMachineGroupPolicy Local machine group policy
localMachineEnterprise Local machine enterprise

cryptography.keyLocation

Key store location

Type:

number

Parameters:

Name Description
currentUser Current user
localMachine Local machine

variableScope

Local variable scope: project only, cross-project

Type:

number

Parameters:

Name Description
project Current project
global Global

credentialLocation

Credential location: current user, local machine

Type:

number

Parameters:

Name Description
currentUser Current user
localMachine Local machine

monitoring.severityLevel

Severity Level

Type:

string

Parameters:

Name Description
info Information
warning Warning
error Error

typeFtp

FTP connection types

Type:

string

Parameters:

Name Description
ftp FTP
ftps FTPS
sftp SFTP

infos.componentType

Component Type

Type:

string

Parameters:

Name Description
project Project
sdk SDK
binary Binary
extension Extension

checkPathRules

Check Path Rules

Type:

string

Parameters:

Name Description
None None
WorkFolder WorkFolder

escapingType

Escaping Type

Type:

string

Parameters:

Name Description
HTML HTML
URL URL

pathEnvVariables

Environment variables for the resolution of paths

Type:

string

Parameters:

Name Description
USERNAME User Name
HOMEDIR Home Directory

jobType

Enumeration to define the type of job. Automation is the type of job defined by default.

Type:

string

Parameters:

Name Description
automation Automation.
process SBPA process

progressDialog.progressMethod

Progress Dialog Method

Type:

string

Parameters:

Name Description
ValueBased Value-based
StepBased Step-based
Infinite Infinite

progressDialog.progressDialogTemplate

Progress Dialog Template

Type:

string

Parameters:

Name Description
None None
Cancel Cancel
Hide Hide
CancelHide Cancel Hide

SAPScripting.key

Special keyboard keys (Shift, Ctrl, F1, F2, ...).

Type:

string

Parameters:

Name Description
_Enter_ Enter key.
_F1_ F1 key.
_F2_ F2 key
_F3_ F3 key.
_F4_ F4 key.
_F5_ F5 key.
_F6_ F6 key.
_F7_ F7 key.
_F8_ F8 key.
_F9_ F9 key.
_F10_ F10 key.
_Ctrl_S_ Ctrl + S key.
_F12_ F12 key.
_Shift__F1_ Shift + F1 key.
_Shift__F2_ Shift + F2 key.
_Shift__F3_ Shift + F3 key.
_Shift__F4_ Shift + F4 key.
_Shift__F5_ Shift + F5 key.
_Shift__F6_ Shift + F6 key.
_Shift__F7_ Shift + F7 key.
_Shift__F8_ Shift + F8 key.
_Shift__F9_ Shift + F9 key.
_Shift__Ctrl_0 Shift + Ctrl + 0 key.
_Shift__F11_ Shift + F11 key.
_Shift__F12_ Shift + F12 key.
_Ctrl__F1_ Ctrl + F1 key.
_Ctrl__F2_ Ctrl + F2 key.
_Ctrl__F3_ Ctrl + F3 key.
_Ctrl__F4_ Ctrl + F4 key.
_Ctrl__F5_ Ctrl + F5 key.
_Ctrl__F6_ Ctrl + F6 key.
_Ctrl__F7_ Ctrl + F7 key.
_Ctrl__F8_ Ctrl + F8 key.
_Ctrl__F9_ Ctrl + F9 key.
_Ctrl__F10_ Ctrl + F10 key.
_Ctrl__F11_ Ctrl + F11 key.
_Ctrl__F12_ Ctrl + F12 key.
_Ctrl__Shift__F1_ Ctrl + Shift + F1 key.
_Ctrl__Shift__F2_ Ctrl + Shift + F2 key.
_Ctrl__Shift__F3_ Ctrl + Shift + F3 key.
_Ctrl__Shift__F4_ Ctrl + Shift + F4 key.
_Ctrl__Shift__F5_ Ctrl + Shift + F5 key.
_Ctrl__Shift__F6_ Ctrl + Shift + F6 key.
_Ctrl__Shift__F7_ Ctrl + Shift + F7 key.
_Ctrl__Shift__F8_ Ctrl + Shift + F8 key.
_Ctrl__Shift__F9_ Ctrl + Shift + F9 key.
_Ctrl__Shift__F10_ Ctrl + Shift + F10 key.
_Ctrl__Shift__F11_ Ctrl + Shift + F11 key.
_Ctrl__Shift__F12_ Ctrl + Shift + F12 key.
_Ctrl_E Ctrl + E key.
_Ctrl_F Ctrl + F key.
Ctrl + \\\\ key.
_Ctrl_N Ctrl + N key.
_Ctrl_O Ctrl + O key.
_Ctrl_X Ctrl + X key.
_Ctrl_C Ctrl + C key.
_Ctrl_V Ctrl + V key.
_Ctrl_Z Ctrl + Z key.
_Ctrl__PageUp_ Ctrl + Page Up key.
_PageUp_ Page Up key.
_PageDown_ Page Down key.
_Ctrl__PageDown_ Ctrl + Page Down key.
_Ctrl_G Ctrl + G key.
_Ctrl_R Ctrl + R key.
_Ctrl_P Ctrl + P key.