SAP Build Process Automation
SAP Build Process Automation
Content
What Is SAP Build Process Automation?
Supported Data Centers
Supported Languages
Quotas, Restrictions, and Limits
Quotas
Restrictions
Limits
Known Limitations
Technical Prerequisites and System Requirements
Feature Prerequisites
Service Plans and Metering
What's New for SAP Build Process Automation
Integration with SAP Build
Initial Setup
Subscribe to SAP Build Process Automation
Subscribe to SAP Build Process Automation (Standard Plan)
Get Free Access to SAP Build Process Automation
Upgrade the Service Plans
Activate Your SAP Build Process Automation Package
Assign Entitlements for SAP Build Process Automation to Subaccount
Configure Automation Capabilities
Install Desktop Agent and Manage Updates
Create a User in the RBSC (download repository)
Install Desktop Agent 3 for Windows
Install Desktop Agent 3 for MacOS
Desktop Agent Service
Register and Connect Desktop Agent
Automatic Agent Updates
Check Supported Desktop Agent Versions
Manage Desktop Agent Updates
Enable Batch Installation
Create a Business Site Using SAP Build Work Zone
Configure SAP Build Work Zone Content
Assign SAP Build Work Zone Permissions
Create and Access Site
Configure the My Inbox App
Configure Visibility Scenario-Specific Tiles
Configure the Visibility Scenario Instances Application
Configure Monitor Workflows Applications
Configure My Processes Application
Configure My Requests
Configure the Studio Home Application
Configure Product Extensions
Configure SAP Document Management Service for Process Attachments
Create Service Instance and Service Key for SAP Document Management Service
Create Repository in SAP Document Management Service Using API Calls
Configure an Attachment Destination in SAP BTP Subaccount
Configure an SMTP Mail Destination
Configure an Azure Application for SMTP Authentication
Register a Service Principal for a Microsoft Azure Application
Configure Destination for Live Process Projects
Enable Notifications
Integrate and Connect With Other Services
Use SAP Build Process Automation and SAP Task Center Together
Use the Same Subaccount
Establish Trust with Identity Authentication
Adapt Subaccount to Subject Name Identifier
Assign Approval or Form Recipients to Users
Use Different Subaccounts
Add Fully-Qualified Domain Name
Establish Trust with Identity Authentication
Adapt Subaccount to Subject Name Identifier
Set Up Principal Propagation Between Subaccounts
Assign Approval or Form Recipients to Users
Use SAP Build Process Automation, Foundation Add-On by UiPath
Subscribe to SAP Build Process Automation
Assign Entitlements for SAP Build Process Automation, foundation add-on by UiPath
Establish Trust between SAP Cloud Identity Services and SAP Build Process Automation
Create User Groups in SAP Cloud Identity Services
Add SAP Cloud Identity Services User Group to Role Collections for a SAP BTP Subaccount
Create a System User in SAP Cloud Identity Services
Configure a Destination to connect to SAP Cloud Identity Services
Configure SAP Cloud Identity Services as Identity Provider for UiPath
Create a UiPath Tenant
Install UiPath Studio
Integrate Events
Connect with SAP Cloud Application Event Hub
Connect with SAP Integration Suite, Advanced Event Mesh
Connect with SAP Event Mesh
Use Business Processes in SAP Build Apps
Set Up Specific Use Cases
Create a Service Instance
Update a Service Instance
Create a Service Key for the SAP Build Process Automation Instance
Using SAP Build Process Automation APIs
Using Business Rules REST-based APIs
Determine Service Configuration Parameters
Configure SAP Build Process Automation Destinations
Connect to the Identity Directory
Use SAP Build Process Automation
Create a Business Process Project
Create a Business Process
Configure Process Variables
Use Cases for Custom Variables
Configure Process Attributes
Start Your Process
Configure an API Trigger to Start a Process
Configure a Form to Start a Process
Create an Event Trigger to Start a Process
Create a Scheduled Trigger to Start a Process
Create a Queue Trigger to Start a Process
Create a UiPath Connector Trigger
Add Flow Controls
Add and Configure Process Conditions
Add a Branch to a Process
Add Wait for Duration to a Process
Create a Wait for an API Call Trigger
Add Process Steps
Create a Form
Form Input Fields
Configure Data Sources for Form Input Fields
Add and Use Data Sources in Form Input Fields
Form Tables
Configure a Start Trigger Form with SAP Build Work Zone
Create an Approval Form
Generate a Form
Configure Forms and Approval Forms
Add a Notification Template to a Form
Guidelines for Specifying Recipient Users
Add a Notification Step
Create and Configure a Script Task
Generate a Script Using Generative AI in a Script Task
Test Your Code
Scripting Restrictions
About Script Tasks
Known Issues
Add an Automation
Add an Action to a Process
Add an Event Handler to Catch Action Errors
Run Step on Behalf Of
Add a Subprocess to a Process
Run in Parallel
Call a Workflow
Determine the Workflow Definition ID
Import an SAPUI5 Form
Technical Information for Adapting the SAPUI5 Application
Update an SAPUI5 Form
Add Mail Notifications to a Process
Add a Placeholder to a Process
Guidelines for Using a Placeholder
Add an Extract Data Activity to a UiPath Automation
Create a Notification Template
Raise and Handle Escalation and Timer Events
Raise an Escalation Event
Handle Events Using the Parent Process
Handle Timer Events with a Form or Approval
Create and Manage Process Variants
Create a Variant Template Project
Create a Variant Template
Create an Outcome
Create a Step Outcome
Handle Events from a Subprocess
Create a Variant Configuration Project
Create a Process Variant
Add an Outcome
Add a Step Outcome
Handle Events in a Variant
Manage Variants
Generate a Process
Best Practices: Generate Prompts
Create a Guided Process
Add Flow Controls (Guided Process)
Add a Branch to a Process (Guided Process)
Add Wait for Duration to a Process (Guided Process)
Add Process Steps (Guided Process)
Add a Stage (Guided Process)
Add a Subprocess to a Process (Guided Process)
Ensure Availability of Optional List Input Parameters
Import a BPMN Process
Activity Mappings for BPMN Models
Event Mappings for BPMN Models
Gateway Mappings for BPMN Models
Variable Mappings for BPMN Models
Manage Event Triggers
Manage Event Triggers from the Project Overview
Manage Event Triggers from the Triggers View
Create an Automation
Create an Alert
Add an API Trigger to an Automation
Add a Process to an Automation
About Action, Proxy and Certificate
Add an Action to an Automation
Support Proxy to Execute an Action in an Automation
Use the Recorder to Enhance Application Capture and Automation Design
Overview
Guidelines to Use the Recorder
Screen Capture Modes of the Recorder
Automatically Capture Applications with the Recorder
Implement Collection in Recorder Elements
Re-recording an Application
Edit a Custom Activity in Generated Automation
Record SAP GUI for Windows Application
Guidelines to Manage Recording of Workflow
Prerequisites
Handle Multiple Screens with the Same Criteria in SAP GUI for Windows Recorder
Handle Context Menu Button Activity
Maintain Menu Items Automation through Tree View
Record UI Automation
Guidelines for Using the UI Automation Recorder
Record Web Applications
Record SAP GUI for HTML Application
Prerequisites
Record Embedded SAP GUI for HTML Applications
Guidelines to Record Web Applications
Record SAP UI5 Application
Record SucccessFactors Applications
Record ARIBA Application
Record Web Dynpro Application
Record UI Automation Pages from the Recorder
Read and Set Value of an Element During Recording
Different Types of Set Activity Options in the Enhanced Recorder
Qualtrics Survey
Troubleshooting Errors in Recorder
Create Automations in the Automation Editor
Automation Tools Panel Filters
Manage Data within an Automation
Input/Output Parameters
Reserved Words
Activity Default Value
Define Complex Input Parameters
Create and Update Variables
Use Primitive Data Type Variables
Use Complex Data Type Variables
List Management
Date and Time Data Type Variables
Different Types of Data Fields
Expression Editor
Enumerations
Combination of Enumerations
Dates
Add an Activity to an Automation
More Activities
Display an Activity Status
Add an Application Screen to an Automation
Activity Target Inputs
Target Editor
Target Editor Workflow Example
Add a Control to an Automation
Loop Controls
For Each
Assign List of Screen Elements for For Each
Forever
Repeat
Loop End
Condition Controls
Condition
Try Catch
End
Type Switch
Other Controls
Screen Switch
Custom Scripting
Best Practices for Custom Scripts
Reuse Variable Defined in Any Block
Add a User Task to an Automation
Generate a Sub-Automation
Handle Errors in Sub-Automations
Trigger an Automation as a New Job
Support Multi-level Collections in an Automation
Test an Automation
Manage Input Parameters to Test an Automation
Manage Environment Variables in Automation Testing
Watch Variable Value
Watch Variable Value in Custom Script
Add or Remove Variable from Watch in Custom Script
Custom Script Error Containing Line
Timeline
Configure Timeout Duration
Manage Errors within an Automation
Error Management Tutorial
Create your Automation
Create a File
Manage an Error with the On Error Node
Manage an Error with Try/Catch
Catch an Error with Try/Catch
Use the On Error Node
Generate a Business Error with the Stop Automation in Error control
Display List of Errors Associated with Activity
Display Errors in the Timeline
Tips and Tricks
Annotation
Copy, Paste, and Duplicate Items
Deactivate an Automation Step
Replace an Activity
Group and Ungroup Activities
Select or Deselect All Activities
Open Automation Node in Separate Automation Editor
Canvas Controls
Capture and Declare Applications
Application Editor
Capture an Application
Guidelines for Capturing Applications
Application Multi-Captures
Capture Multiple Screens
Warning Messages when Capturing a Screen
Add Multiple Captured Screens to Current Screen
Replace a Captured Screen
Add a Captured Subscreen
Duplicate a Captured Screen
Delete a Captured Screen
Capture on Hover
Support Capture on Hover on MacOS Platform
Capturing Tool
List Application Frames
Capture Options
Manage Screen Ordering
Surface Automation
Declaration Phase
Declare an Application
Application Editor
Declare a Screen
Declare Elements
Declare Element Icons
Capture Operators
Match Capture Operator
Declare an Element
Duplicate Declared Element
Declare a Parent Element as a Collection
Deepness Criteria
Labeled by
Group Declared Elements
Declare an Element as a Collection
Advanced Declaration
Declaration Using Contextual Menu in Tree View
Recognition Tests
Search Option
Test an Application
Quick Fix
Supported Interface Technologies
The Web Technology
Declaring an Application Using the Web Technology
Declaring a Screen Using the Web Technology
Declaring an Element Using the Web Technology
Guidelines for the Web Technology Automation
The SAPUI5 Technology
The UI Automation Technology
Declaring an Application Using the UI Automation Technology
Declaring a Screen Using the UI Automation Technology
Declaring an Element Using the UI Automation Technology
The SAP GUI Technology
Enabling Scripting
Enabling Scripting on the Client Side
Enabling Scripting on the Server Side
Declaring an Application Using the SAP GUI Technology
Guidelines for Declaring Multiple Applications within Same Project
Declaring a Screen Using the SAP GUI Technology
Declaring an Element Using the SAP GUI Technology
Guidelines for the SAP GUI Technology Automation
The Java Technology
Support Capture on Hover
Guidelines for the Java Technology Automation
Tracking Automation Business Performance using BAM
Input Parameters of the BAM Activities
Automation Activities provided by SDK Packages
SDK Packages
Core SDK
Local Agent Variables
Retrieve a Value of a Local Agent Variable
Retrieve a Value of a Local Agent Variable Created in a Dependency
Local Agent Credentials
Retrieve a Value of a Local Agent Credential
Best Practices for Core SDK Activities
SAP GUI Activities
Wait Activities
Call Web Service Activity
Call Web Service with Destination Activity
API Access Token Activity
Activate Screen Activity
Execute Command Activity
WMI Query Activity
Start Web Page and Set Navigator Activities
Click Sync Activity
Execute Script (WEB UI Element) and Execute Script (WEB) Activities
SAPUI5 SDK
Best Practices for SAPUI5 Activities
SAP GUI for HTML SDK
Best Practices for SAP WebGUI Activities
Excel SDK
Best Practices for Excel Activities
Excel Data Mapping
Excel Sort on Multiple Columns
Without Excel Application Activities
Best Practices
Limitations
Word SDK
Best Practices for Word Activities
Outlook SDK
Best Practices for Outlook Activities
Delete Multiple Emails in Outlook
Move Multiple Emails in Outlook
Get Context Overview Activity
Get All Calendar Items Activity
Send Multiple Attachments in an Email
Limitations
PowerPoint SDK
Best Practices for Updating MS PowerPoint
More Information
PDF SDK
Best Practices for PDF Activities
Retrieve Column Data in PDF Table
Use a Regular Expression
SAP BAPI SDK
BAPI Overview
Create an Automation for BAPI
Best Practices for SAP BAPI Activities
BAPI Action Group Overview
BAPI Action Group
SAP Ariba Solution SDK
Add Ariba Dependency
More Information
SAP SuccessFactors SDK
Best Practices for SuccessFactors Activities
Document Information Extraction SDK
Best Practices for Document Information Extraction Activities
Google Workspace SDK
More Information
Best Practices for Google Workspace Activities
Google Authorization SDK
Configure Service Account in Google Cloud Platform
Configure OAuth Client ID in Google Cloud Platform
More Information
Best Practices for Google Authorization Activities
Limitations
Support Single Sign-On (SSO) Authentication to Automate Google Applications
Google Document AI SDK
Best Practices for Google Document AI Activities
Google Vision AI SDK
Google Cloud Storage SDK
Microsoft 365 Cloud SDK
Configure Azure Application and Use with Microsoft 365 SDK
Configure Azure Application
Create External Authentication
Register External Authentication
More Information
Web SDK
More Information
Java SDK
Lifecycle of SDK Activities
SDK Activity Input/Output Details
Attended Automations
Create an Automation Launcher
Create a User Task
Document Processing and Information Extraction
Process Documents Using Online OCR
Process Documents Using Pre-Trained Models
Process Documents Using Templates
Define Template Inside an Automation
Upload Documents and Check Template
Edit Document Template
Supported Languages, Countries, and Regions
Technical Constraints
Create an Environment Variable
Set Values for Environment Variables
Best Practices
Best Practice - Close Applications
Best Practice - Warn User That Bot Is Running
Best Practice - Convert a PDF File into a Base64 String
Best Practice - Handle Unresponsive Application
Best Practices for Creating Resilient Automations
Create a File
Import a File
Integrate a File in an Automation
Create a Data Type
Import an Excel File as a Data Type
Strict Data Types
Constraints in Data Types
Generate a Data Type
Create a Decision
Model a Text Rule
Model a Text Rule with Result Vocabulary
Model a Text Rule for Execute Operations
Model a Rule in a Decision Table
Import or Export a Decision Table
Update Decision Table Result Behaviour
Edit a Rule
Duplicate a Rule
Activate/Deactivate a Rule
Operators
Functions
Add an API Trigger to a Decision
Execute an API Trigger
Create a Visibility Scenario
Configure a Visibility Scenario
Configure Processes
Add Process
Add Observed Process
Push Events to a Visibility Scenario
Supported Event Formats
Sample Event Format
Add Workflow
Add SAP Business Workflow
Add Qualtrics Survey
Add SAP Business Process Management Process
Configure Step for a Process
Configure Step Target
Configure Step Outcomes
Configure Step Navigation Link
Configure Process Groups
Configure Connections
Configure Group Connections (1:N)
Configure Non-Correlated Processes
Map Attributes
Configure Phases
Configure States
Configure Status
Configure Target
Configure Sub Status
Configure Attributes
Configure Default Attributes
Configure Context Attributes
Add Calculated Attributes
Add Entities
Attributes
Configure Actions
Navigational Action
Trigger Workflow Action
Trigger Process Action
Configure Performance Indicators
Sample Performance Indicators
Import a Visibility Scenario
Add Triggers to a Project
Scheduled Trigger
Add Scheduled Triggers to a Process
Add Scheduled Trigger to an Automation
Add an API Trigger
Execute an API Trigger
Working on Live Process Projects
Configure a Process Variant
Configure Start Conditions
Configure Step Conditions
Manage Decisions
Configure a Visibility Scenario
Configure Processes
Add Observed Process
Push Events
Supported Event Formats
Sample Event Format
Add Workflow
Add Process Template
Add SAP Business Workflow
Add Qualtrics Survey
Add SAP Business Process Management Process
Translate User-Defined Texts in a Visibility Scenario
Manage Existing Artifacts
Manage and Configure Business Process Projects
Manage a Project in the Current Tenant
Release a Project
Create a Patch Branch for a Version
Deploy a Project
Upgrade
Redeploy a Project
Downgrade
Undeploy a Project
Deploy a Project Containing a UiPath Automation
Copy a Project
Publish a Project
Transport a Project
Delete a Project
Restore a Project
Manage Project Members
Manage Project Dependencies
Change the Agent Version for a Project
Manage Project Translation Files
Manage a Project Across Tenants
Export a Project
Import a Project
Project Lifecycle Management and Versioning
Using Connectors
Actions
Set Up and Configure Specific API Resources
Live API
Using API Composition
Using SAP Cloud Application Programming Model
Using ABAP RESTful Application Programming Model
Using OData Destinations
Using Unified Customer Landscape (SAP Systems)
Using Developer Hub
Using Integration Flow
Using RFCs
API Specifications
Using SAP Business Accelerator Hub
Uploading API Specifications
Build API Actions from Scratch
Overview of an Action Editor
Managing Input and Output Parameters
Using Filter Conditions ($filter)
Adding Actions
Add a Custom Action
Copy Actions
Testing Actions
Updating Actions
Managing Action Projects
Action Project Settings
CSRF Token
Using X-CSRF-Token in the Actions
Resource Path or URL Prefix
Managing Destinations for the Action Project
Error Messages
Events
Use Events
Create an Event Project
Using Unified Customer Landscape (SAP Systems)
Desktop Agent User Guide
Use the Desktop Agent
Start Jobs With a Disconnected Agent
Add and Manage Tenants
Configure the Connection Settings
Change the Agent Mode
Activate the RDP Manager Mode
Register and Activate RDP Sessions
Manage Sessions
Configure Sessions to Run Unattended Jobs
Install Desktop Agent for Unattended Automations
Configure Credentials for the Unattended Agent
Open and Manage Sessions
Run a Check for Unattended Agent Users and Sessions
Troubleshooting
Monitor the Agent
Set Up Traces
View Trace Reports
Map Agent Groups to an Identity Provider
Configuring Web Browsers
Web Browser Extension Updates
Web Browser Extension Traces
Best Practices for Chrome Extension
Best Practices for the Desktop Agent
How to Migrate Your Desktop Agent
Best Practices when Migrating from Desktop Agent 2 to Desktop Agent 3
Register Authentication on Desktop Agent
Use the Store
Explore the Store
Create Projects from a Template
Update to the Latest Version
Monitor Processes
Process and Workflow Instances
Automation Jobs
Acquired Events
Manage Notifications in Acquired Events
Automation Overview
Simultaneous Quota Usage for Automations
Notifiers
Add an API Notifier
Add a CAI Notifier
Add an Email Notifier
Available Variables for Notifiers
Business Rules
UiPath Test Manager
Use Control Tower
Tenant Configuration
Environments
Create an Environment
Share an Environment
Access Projects in an Environment
Triggers
Copy Form Links in a Process
Activate and Configure a Scheduled Trigger
Activate a Queue Trigger
Activate a UiPath Connector Trigger
Automation Launchers
Configure an Automation Launcher
Agent Management
Add an Agent
Add Alert Handlers
Alert Handler for the Agent Disconnected Event
Variables
Edit an Environment Variable
Add API Keys to an Environment
Visibility Scenarios
Download Archived Data
Manage Notifications in Visibility Scenarios
Processes and Workflows
Generative AI
Configure Agents
Overview of Agents
Create an Agent Group
Add an Agent Group
Mass Agent Registration
Change Agent Groups to the Any Type
Agent Attributes
Agent Inventory
Manage Destinations
API Keys
Add API Keys to Multiple Environments
Use API Keys
UiPath
Create a UiPath Tenant
Integrating SAP Cloud ALM
Configure the SAP Cloud ALM Integration
Use SAP Cloud ALM
Use My Inbox
My Inbox for Citizen Developers
My Inbox for Process Participants
Create and Manage Substitution Rules
Gain Visibility Using Process Workspace
Track Instances Using Visibility Scenario Instances Application
Track Instances Based on User Responsibility
Use My Processes Application
Manage and Personalize your Notifications
Use Preferences
Use Studio Home
Extend and Integrate Your SAP S/4HANA Processes with SAP Build Process Automation
Component Overview
Technical Requirements
Prerequisites
Find the Right Connections for SAP S/4HANA and SAP S/4HANA Cloud
Clean Core
SAP Business Accelerator Hub
RFC and BAPI Connectivity
BAPI SDK
RFC Connectivity Using Actions
SAP Cloud Integration
Custom Java Application
Web Service Wrapper
Consume Data from CDS Views
Consume SOAP and IDOC Connectivity using SAP Integration Suite
Trigger a Process in SAP Build Process Automation with Events from SAP S/4HANA
Extensibility Wizard
Set Up Authentication
Connect Using Remote Calls
Establish the Connection
Set Up the Cloud Connector for SAP S/4HANA
Set Up Communication Management for SAP S/4HANA Cloud
Set Up the Destination
Set Up and Use Actions with SAP Build Process Automation
Configure User Access
Assign Roles in SAP Build Process Automation
Setup in SAP Build Work Zone
Connect Using the Desktop Agent
Security
Architecture
Multi-Tenancy
Authentication
Authorizations
Create Custom Roles for Process Visibility
Create a Role Collection to Access User Tasks based on Global User IDs
Audit Logging
Running Automation Jobs
Data Protection and Privacy
Personal Data
Read Access Logging
Change Log
Deletion of Personal Data
Glossary for Data Protection and Privacy
Customer Data Export
Disaster Recovery
Security Aspects for SAP Build Process Automation, foundation add-on by UiPath
Architecture
Tenant Mapping
Authentication
Authorizations
SAP Key Management Service Integration (Restricted Availability)
Security Aspects of SAP GUI Connector
Risks in Using Custom Scripts/Regex in Automation Design
Enable X.509 Certificates in Bindings or Service Keys
Accessibility Features
Accessibility Features for Desktop Agent 3
Monitor and Troubleshoot
Built-In Support
Troubleshoot Automations
Activate Support Mode
Export Health Metrics
Memory Allocation Limit Reached
Update Deprecated SAP Build Process Automation Roles
Update Destinations for Live Content Packages
Get Support
Support Components