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

Table of Contents

Authorization
Cloud Files Management (Microsoft OneDrive and SharePoint)
Excel Online
Outlook Online
Sharepoint List
Design Only
Teams
OneNote
Enumerations
Error

Module - Design Only

Set of activities to be used when designing an automation.

Activities

Get Recent Files

Retrieve files recently opened. Please note that you must only use this activity during the design of your automation. You cannot use this activity during the execution of your automation.


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

Input Parameters:

Name Type Attributes Default Description
filter irpa_365online.fileFilter optional Criteria to filter on.

Output Parameters:

Name Type Description
recentList Array.<irpa_365online.fileDescription> The list of 200 recently opened files.

Sample Code:

await irpa_365online.design.getRecentFiles();

Note:

This activity is a design tool that helps the automation developer to get the remote driveId and/or the fileId of shared files that will be used by the automation being designed. Once the information is retrieved during the developement phrase, it can be copy/pasted as input of activities that need them. This design only activity must NOT be used in production automations, as its performances my be very slow, depending on the number of involved files.

Note:

Only manually modified files will be returned, after a possibly long time. Files modified by API are not part of recent files.

Errors:

Error Class Package Description
RequestError irpa_core Error getting recent files.
InvalidAuthenticationToken irpa_365online Invalid token was retrieved to call graphAPI.


Get Shared Files

Retrieve files shared with me. Please note that you must only use this activity during the design of your automation. You cannot use this activity during the execution of your automation.


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

Input Parameters:

Name Type Attributes Default Description
filter irpa_365online.fileFilter optional Criteria to filter on.

Output Parameters:

Name Type Description
sharedList Array.<irpa_365online.fileDescription> The list of the files shared with me.

Sample Code:

await irpa_365online.design.getFilesSharedWithMe();

Note:

This activity is a design tool that helps the automation developer to get the remote driveId and/or the fileId of shared files that will be used by the automation being designed. Once the information is retrieved during the developement phrase, it can be copy/pasted as input of activities that need them. This design only activity must NOT be used in production automations, as its performances my be very slow, depending on the number of involved files. The results are ordered by last modification date time.

Errors:

Error Class Package Description
RequestError irpa_core Error getting files shared with me.
InvalidAuthenticationToken irpa_365online Invalid token was retrieved to call graphAPI.


List Email Folders

Retrieves a list of email folders. If there is input for both the parameters knownFolder and folderId, the parameter folderId takes priority.


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

Input Parameters:

Name Type Attributes Default Description
knownFolder irpa_365online.enums.mail.folders optional Known folder in which you want to search
folderId string optional The folder in which you want to search.
filter string optional Filter by folder name

Output Parameters:

Name Type Description
folderList Array.<irpa_365online.mailFolder> The list of folders.

Sample Code:

const folderList = await irpa_365online.design.listFolder();

Errors:

Error Class Package Description
RequestError irpa_core Error searching foder.
InvalidAuthenticationToken irpa_365online Invalid token was retrieved to call grapAPI.


Enumerate Lists

Enumerate lists from the current site. To change the current site, use the Select Site activity to change the site before you enumerate the list.


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

Output Parameters:

Name Type Description
lists Array.<irpa_365online.listInformation> Retrieves a list of the enumeration.

Sample Code:

await irpa_365online.design.enumerateLists();

Errors:

Error Class Package Description
RequestError irpa_core Error enumerating lists.
InvalidAuthenticationToken irpa_365online Invalid token was retrieved to call graphAPI.


Search Sites

Search Sites


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

Input Parameters:

Name Type Attributes Default Description
siteDisplayName string optional Site display name. If this is empty then all sites are enumerated.

Output Parameters:

Name Type Description
sites Array.<irpa_365online.siteInformation> Retrieves a list of sites corresponding to the search.

Sample Code:

await irpa_365online.design.searchSite('mySite');

Errors:

Error Class Package Description
RequestError irpa_core Error searching site.
InvalidAuthenticationToken irpa_365online Invalid token was retrieved to call graphAPI.