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 - List Management

Collection of activities to work with lists.

Activities

Add Item (List)

Add an item to an existing list.


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

Input Parameters:

Name Type Attributes Default Description
list Array. mandatory An existing list.
itemToAdd any mandatory Item to add to the list.

Errors:

Error Class Package Description
InvalidArgument irpa_core Invalid provided list


Add All

Concatenate a list of items to another list.


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

Input Parameters:

Name Type Attributes Default Description
list Array. mandatory An existing list.
listToConcatenate Array. mandatory Items to add to the list.


Remove by Index

Remove an item from a list based on its index in the list.


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

Input Parameters:

Name Type Attributes Default Description
list Array. mandatory An existing list.
indexToRemove number mandatory Index of the item in the list to remove. If the index is higher than the length of the list, no item is removed.


Remove Item

Remove an item from a list based.


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

Input Parameters:

Name Type Attributes Default Description
list Array. mandatory An existing list.
itemToRemove any mandatory Item in the list to remove.
allOccurences boolean optional false If true removes all the occurrences of the item if it is found several times in the list. If false, only the first item will be removed. Note that in case of dataObject, the remove is performed by reference but not by value, that means only the repetition of the same instance corresponding to itemToRemove will be removed but not the other instances with the same property values.

Note:

: In case of dataObject, the remove is performed by reference but not by value, that means only the repetition of the same instance corresponding to itemToRemove will be removed but not the other instances with the same property values.