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 - Data Type Management

Contains the functions to work with data types.

Activities

Validate Data Object

Validate an object which is an instance of a data type.


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

Input Parameters:

Name Type Attributes Default Description
objectToValidate any mandatory Data type object to be validated.
throwError boolean optional false Throws an error if the object is not validated. If this error is not caught later, the automation will stop.

Output Parameters:

Name Type Description
validationResult irpa_core.dataObjectValidation Returns true if the object is valid according to its definition, returns false otherwise.


Create Data Object

Create a data object which is an instance of a data type. Can create object which contains data or default data according to the given parameters.


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

Input Parameters:

Name Type Attributes Default Description
datatype any mandatory The data type containing the JSON schema to be used as source for the structure of the generated object.
generateAllProperties boolean optional false If true, generates an object with all properties. If false, generates an object only with required properties or properties requested in the structureAndData parameter.
structureAndData Array. optional An array which contains first a header row representing the properties of the data type, and then the corresponding data.

Output Parameters:

Name Type Description
generatedObject any Object generated from the jsonSchema.


Create Data Objects

Create a list of data objects which are instances of a specific data type.


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

Input Parameters:

Name Type Attributes Default Description
datatype any mandatory The full JSON definition containing the jsonSchema to be used as source for the structure of the generated object.
generateAllProperties boolean optional false If true, generates an object with all properties. If false, generates an object only with required properties or properties requested in the structureAndData parameter.
structureAndData Array. optional An array which contains first a header row representing the properties of the data type, and then the corresponding data.

Output Parameters:

Name Type Description
generatedObject Array. Object generated from the jsonSchema.


Set Field Value

Change the field of a data object. Then the data object is validated according to its data type to check if it is valid or not. If it is not valid, an error is thrown.


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

Input Parameters:

Name Type Attributes Default Description
dataObject any mandatory An instance of a data type.
propertyMapping any mandatory Property Name, property path which should have to be added/updated or JSON mapping.
value any optional Value used for the update.