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 - SAP Document Management System (DMS) Module

Collection of functions related to SAP Document Management System (DMS) activities, see: https://help.sap.com/docs/SAP_ERP_SPV/e67a211ceab947049f6fa7074f7c750f/4af6e75227db9972e10000000a4450e5.html?version=6.00.31

Activities

Select DMS

Get access to DMS


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

Input Parameters:

Name Type Attributes Default Description
dmsDestination any mandatory DMS destination variable
options any optional additional options (optional)

Sample Code:

await irpa_core.dms.access(destination);



Upload DMS Document

Make an HTTP request to upload a file to a remote DMS service. See https://help.sap.com/docs/SAP_ERP_SPV/e67a211ceab947049f6fa7074f7c750f/4af6e75227db9972e10000000a4450e5.html?version=6.00.31


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

Input Parameters:

Name Type Attributes Default Description
documentName string mandatory The document name
folderName string mandatory The folder name
inputPath string mandatory The full path of the input file.

Sample Code:

const res = await irpa_core.dms.uploadDocument('myFile.pdf', 'folder1', '%fileDir%/someFile.pdf');

Errors:

Error Class Package Description
RequestError irpa_core Request error


Download DMS Document

Create and send an HTTP request to download a document from a remote DMS service. See https://help.sap.com/docs/SAP_ERP_SPV/e67a211ceab947049f6fa7074f7c750f/4af6e75227db9972e10000000a4450e5.html?version=6.00.31


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

Input Parameters:

Name Type Attributes Default Description
documentName string mandatory The document name
folderName string mandatory The folder name
outputPath string mandatory The local full path of the file downloaded

Sample Code:

const res = await irpa_core.dms.downloadDocument('invoice.pdf', 'myDMSRoot/aDMSFolder', '%fileDir%/invoice.pdf');

Errors:

Error Class Package Description
RequestError irpa_core Request error


Delete DMS File or Folder

Make an HTTP request to a remote DMS service to delete a file or a folder. See https://help.sap.com/docs/SAP_ERP_SPV/e67a211ceab947049f6fa7074f7c750f/4af6e75227db9972e10000000a4450e5.html?version=6.00.31


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

Input Parameters:

Name Type Attributes Default Description
folderPath string mandatory The folder path
dmsObjectId string mandatory The file or folder object ID

Output Parameters:

Name Type Description
true boolean if erased

Sample Code:

const res = await irpa_core.dms.deleteItem('myRoot/myFolder', dmsObjectId);

Errors:

Error Class Package Description
RequestError irpa_core Request error


Create DMS Folder

Make an HTTP request to a remote DMS service to create a folder. See https://help.sap.com/docs/SAP_ERP_SPV/e67a211ceab947049f6fa7074f7c750f/4af6e75227db9972e10000000a4450e5.html?version=6.00.31


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

Input Parameters:

Name Type Attributes Default Description
folderName string mandatory The new folder name
folderPath string mandatory The folder path

Output Parameters:

Name Type Description
the string folder DMS object ID

Sample Code:

const res = await irpa_core.dms.createFolder('mySubFolder', 'myRoot/myFolder');

Errors:

Error Class Package Description
RequestError irpa_core Request error


Get DMS Folder Content

Make an HTTP request to a remote DMS service to list a folder content. See https://help.sap.com/docs/SAP_ERP_SPV/e67a211ceab947049f6fa7074f7c750f/4af6e75227db9972e10000000a4450e5.html?version=6.00.31


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

Input Parameters:

Name Type Attributes Default Description
folderPath string mandatory The new folder name

Output Parameters:

Name Type Description
the Array.<irpa_core.folderItem> folder items

Sample Code:

const res = await irpa_core.dms.getFolderContent('myRoot/myFolder');

Errors:

Error Class Package Description
RequestError irpa_core Request error


Remove DMS Folder Content

Make an HTTP request to a remote DMS service to erase a folder content. See https://help.sap.com/docs/SAP_ERP_SPV/e67a211ceab947049f6fa7074f7c750f/4af6e75227db9972e10000000a4450e5.html?version=6.00.31


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

Input Parameters:

Name Type Attributes Default Description
folderPath string mandatory The new folder name

Output Parameters:

Name Type Description
the number number of items deleted

Sample Code:

const res = await irpa_core.dms.removeFolderContent(destination, 'myDMSFolder');

Errors:

Error Class Package Description
RequestError irpa_core Request error


Download All Files From the SAP Document Management Service Folder

Download all files from an SAP Document Management Service folder.


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

Input Parameters:

Name Type Attributes Default Description
folderObjectId string mandatory - The object ID of the SAP Document Management Service folder.
outputFolderPath string optional - The output folder path. By default, this is irpa_core.enums.path.log. (This location is cleared periodically.)

Output Parameters:

Name Type Description
downloadedFilesPath Array. - The absolute paths of the downloaded files.