Desktop Studio Developer Guide
Desktop Studio Developer Guide
Content
Developer Guide Overview
Architecture Overview
About Desktop Agent
How Desktop Agent Works
Software Architecture of Desktop Agent
About Desktop Studio
The Explorer Perspective
The Project Tree
The Capture Panel
Page View Panels
The Workflow Perspective
The Editor Perspective
The UI Designer Perspective
The Debug Perspective
Accessibility Features
Code Editing Features
Navigation Features
Search Features
Code Editor Help Features
About Projects
Overview of Project Development
Project Structure and Organization
Project Management
Create a Project
Open a Project
Edit a Project
Archive a Project
Export a Project
Capturing, Declaring and Controlling Applications
Technology Connectors
The Web Connector
Declaring Entities Using the Web Connector
Declaring an Application
Declaring a Page
Declaring an Item
Controlling Entities Using the Web Connector
The UI Automation Connector
Declaring Entities Using the UI Automation Connector
Declaring an Application
Declaring a Page
Optimizing Page Recognition Performance
Declaring an Item
Recognition With the UI Automation Connector
Controlling Entities Using the UI Automation Connector
Controlling an Application
Controlling a Page
Controlling an Item
Advanced Use Cases
The SAP GUI Connector
Enabling Scripting on the Client Side
Enabling Scripting on the Server Side
Declaring Entities Using the SAP GUI Connector
Declaring a Page
Declaring an Item
Recognition with the SAP GUI Connector
Controlling Entities Using the SAP GUI Connector
Controlling a Page
Stop and Start SAP Scripting
Check Whether the SAP GUI Server is Busy
Extend the Wait Period When the SAP Session is Busy
Suspend Automatic Refresh
Force Manual Refresh
Avoid the SAP GUI Busy Server Message
Controlling an Item
Advanced Use Cases
Handling Multiple Themes with SAPGUI
Using the GridView Component
Using the GuiToolbar Component
Using Scrolling with the GuiTableControl
Best Practices
The SAPUI5 and S/4HANA Connectors
Capturing SAPUI5 and S/4HANA Applications
Loading Pages
Applying Type ToggleButton
Applying Type TableRowClick
Automation with SAPUI5 Tables
The Win32 Connector
Declaring Entities Using the Win32 Connector
Declaring an Application
Declaring a Page
Declaring an Item
Recognition With the Win32 Connector
Controlling Entities Using the Win32 Connector
The Java Connector
Declaring Entities Using the Java Connector
Capturing an Application
Declaring an Application
Declaring a Page
Declaring an Item
Recognition with the Java Connector
Controlling Entities Using the Java Connector
The HLLAPI Connector
Declaring Entities Using the HLLAPI Connector
Controlling Entities Using the HLLAPI Connector
Advanced Use Cases
The OCR Connector
Template Matching
Handling Multi-Template Matches
Identifying the Right Text from Multiple Matches
Controlling Individual Entities
Multi-Instance Management
Controlling Entities Using the Desktop SDK
The Declaration Phase: General Information
Entities for a Desktop Application
Entities for a Web Application
Entities for a Mainframe Application
Declaring Applications
Setting Application Criteria
Setting Application Parameters
Declaring Pages
Capture a Page
Capture a Subpage
Capture an HLLAPI Page
Multi-Capture Management
Page Definition
Declaration of Page Items
Criteria Management
Controlling Pages with Event-Driven UI Updates
Advanced Declaration
About the Recognition Mechanism
Making Robust Capture and Declaration
Advanced Recognition Capabilities
MustExist Method
MustNotExist Method
Root Item Method
Ancestor Method
Labelled By Method
Items Pattern Method
Order of Declared Pages
Designing Scenarios
Bootstrap your Project with Workflow Designer
Main Steps in Creating a Workflow
Setting Timeout Values
Workflows and Functional Events
Activities and Where to Use Them
Application Activities
Credentials
Event Activities
Excel Lib Activities
Factory API Activities
File and Folder Activities
Flow Activities
Item - Click Activities
Item - Get Activities
Item - Set Activities
Item - Wait Activities
Key Activities
Outlook Lib Activities
Page Activities
Popup Activities
SAP GUI Activities
SAP UI5 Activities
Scenario Activities
Setting Activities
System Activities
Web Service Activities
Word Lib Activities
PDF Activities
Scenario Overview
Control Sequences
Designing Control Sequences
Managing Data
Designing Scenarios Through Code
Managing Steps and Scenarios Using Desktop SDK
Declaring Steps with Desktop SDK
Declaring Scenarios with Desktop SDK
Managing Merge Requests
Managing Loops and Conditional Switches in Scenarios
Managing Data Within a Scenario
Starting a Scenario
Stopping a Scenario
Managing Errors
Managing Timeouts in Scenarios
Setting a Timeout for Each Step
Overriding Timeout for One Step
Handling Job Timeout in SAP Intelligent RPA Factory
Managing the Timeout of a Main Scenario Containing Sub-Scenarios
Handling Timeout in a Sub-Scenario
Disabling Timeout
Declaring Environment Variables from SAP Intelligent RPA Factory
Designing Scenarios Involving Citrix or RDP
Example Project
Business Activity Monitoring (BAM)
Use BAM in a Project
BAM Statements
Alert Statements
Counter Statements
Timer Statements
Start Timer Statement
Split Timer Statement
Reset Timer Statement
Configure and send notifications
Script Management
Add a New Script
Edit a Script
Move a Script to Another Folder
Rename a Script
Exclude a Script
Delete a Script
Editing the XML List of Scripts
Systray and Menu Bar Management
Display Message Boxes
Display Tooltips
Managing Popups With Desktop SDK
Create a Popup
Customize the Popup
Open the Popup
Wait Until the Popup Closes and Get the Popup Result
Managing Custom Pages With UI Designer
The UIDesigner Perspective
Advanced Techniques for Custom Page Design
Testing and Deploying Your Project
Building a Project for Testing
Compiling a Project
Exporting a Project for Deployment
Exporting a Project
Converting a Project
Deploy
Debugging
Debugging Your Code with Script Debugger
Debugging and Testing with the Debugger
Debugging Offline with Debug Sessions
Offline Debugging – Trace Management
Offline Debugging – Audit and Diagnoses
Using TraceViewer
Recognition Error Cases
References
Commands Reference
Main Window Commands
Code Editor Commands
Project Tree and Script Tree Commands
Code Snippets Reference
File and Folder Management
Multilingual Management
Registry Management
XML/JSON Management
Clipboard Management
Cryptography Management
Microsoft Office Excel Library
Microsoft Office Outlook Library
PDF Library
Single Sign On Management
Managing External Parameters
Web Service Calls and Remote File Download
Understanding Asynchronous and Synchronous Processes
Managing Technical Events Using the Desktop SDK
Customizing a Windows Application
Customizing a Web Application
Best Practices for the Desktop Studio