- Release Notes
- Getting Started
- Setup and Configuration
- Automation Projects
- Dependencies
- Types of Workflows
- Control Flow
- File Comparison
- Automation Best Practices
- Source Control Integration
- Debugging
- Logging
- The Diagnostic Tool
- Workflow Analyzer
- About Workflow Analyzer
- ST-NMG-001 - Variables Naming Convention
- ST-NMG-002 - Arguments Naming Convention
- ST-NMG-004 - Display Name Duplication
- ST-NMG-005 - Variable Overrides Variable
- ST-NMG-006 - Variable Overrides Argument
- ST-NMG-008 - Variable Length Exceeded
- ST-NMG-009 - Prefix Datatable Variables
- ST-NMG-011 - Prefix Datatable Arguments
- ST-NMG-012 - Argument Default Values
- ST-NMG-016 - Argument Length Exceeded
- ST-NMG-017 - Class name matches default namespace
- ST-DBP-002 - High Arguments Count
- ST-DBP-003 - Empty Catch Block
- ST-DBP-007 - Multiple Flowchart Layers
- ST-DPB-010 - Multiple instances of [Workflow] or [Test Case]
- ST-DBP-020 - Undefined Output Properties
- ST-DBP-021 - Hardcoded Timeout
- ST-DBP-023 - Empty Workflow
- ST-DBP-024 - Persistence Activity Check
- ST-DBP-025 - Variables Serialization Prerequisite
- ST-DBP-027 - Persistence Best Practice
- ST-DBP-028 - Arguments Serialization Prerequisite
- ST-USG-005 - Hardcoded Activity Properties
- ST-USG-009 - Unused Variables
- ST-USG-010 - Unused Dependencies
- ST-USG-014 - Package Restrictions
- ST-USG-017 - Invalid parameter modifier
- ST-USG-020 - Minimum Log Messages
- ST-USG-024 - Unused Saved for Later
- ST-USG-025 - Saved Value Misuse
- ST-USG-026 - Activity Restrictions
- ST-USG-027 - Required Packages
- ST-USG-028 - Restrict Invoke File Templates
- ST-USG-032 - Required Tags
- ST-USG-034 - Automation Hub URL
- Variables
- Arguments
- Imported Namespaces
- Coded automations
- Introduction
- Registering custom services
- Before and After contexts
- Generating code
- Generating coded test case from manual test cases
- Troubleshooting
- Trigger-based Attended Automation
- Object Repository
- The ScreenScrapeJavaSupport Tool
- Extensions
- About extensions
- SetupExtensions tool
- UiPathRemoteRuntime.exe is not running in the remote session
- UiPath Remote Runtime blocks Citrix session from being closed
- UiPath Remote Runtime causes memory leak
- UiPath.UIAutomation.Activities package and UiPath Remote Runtime versions mismatch
- The required UiPath extension is not installed on the remote machine
- Screen resolution settings
- Group Policies
- Cannot communicate with the browser
- Chrome extension is removed automatically
- The extension may have been corrupted
- Check if the extension for Chrome is installed and enabled
- Check if ChromeNativeMessaging.exe is running
- Check if ComSpec variable is defined correctly
- Enable access to file URLs and Incognito mode
- Multiple browser profiles
- Group Policy conflict
- Known issues specific to MV3 extensions
- List of extensions for Chrome
- Chrome Extension on Mac
- Group Policies
- Cannot communicate with the browser
- Edge extension is removed automatically
- The extension may have been corrupted
- Check if the Extension for Microsoft Edge is installed and enabled
- Check if ChromeNativeMessaging.exe is running
- Check if ComSpec variable is defined correctly
- Enable access to file URLs and InPrivate mode
- Multiple browser profiles
- Group Policy conflict
- Known issues specific to MV3 extensions
- List of extensions for Edge
- Extension for Safari
- Extension for VMware Horizon
- Extension for Amazon WorkSpaces
- SAP Solution Manager plugin
- Excel Add-in
- Studio testing
- Troubleshooting
- About troubleshooting
- Assembly compilation errors
- Microsoft App-V support and limitations
- Internet Explorer X64 troubleshooting
- Microsoft Office issues
- Identifying UI elements in PDF with Accessibility options
- Repairing Active Accessibility support
- Validation of large Windows-legacy projects takes longer than expected
Studio user guide
Working with Coded automations
This page provides instructions on debugging, running, and publishing your coded automations.
Debugging
Debugging coded automations resembles the debugging process for low-code automations. You can set breakpoints, utilize debugging panels, and enable profile execution. Also, the debug running mode stops on each affected line, so you can troubleshoot. Visit About Debugging to learn more about debugging automations in Studio.
You can't perform remote debugging on coded automations.
Running
You can run coded automations similarly to how you would run a low-code automation. In the Design tab in Studio, click Run to run the whole project, or Run File to run the current file.
Visit Start Debugging at the bottom of the page, to learn about running automations in Studio.
Validation
You can run the Workflow Analyzer to check your project for inconsistencies unrelated to project execution. This ensures that your project meets high quality and reliability standards. After you run the Workflow Analyzer, in the Error List panel you can see compilation messages and errors. The panel shows validation errors, warnings, and messages specific to both XAML (low-code automations) and CS files (coded automations).
In comparison to low-code automations, you are unable to manage the rules that govern the analysis process.
Visit About Workflow Analyzer to learn more about how to analyze your project.
Publishing
To publish a Studio project, you can select the Publish option in the Design tab ribbon. By default, all files in the project folder are published except for test cases.
You can prevent a specific file from being included in the published package by right-clicking it in the Project panel and selecting Ignore from Publish. Otherwise, right-click a file in the Project panel and select Set as publishable.
Projects can be published to Orchestrator, a custom NuGet feed, or locally. After publishing to Orchestrator, the archived project is displayed on the Packages page, and you can create a process to be distributed to Robots. To publish a project, the project.json and design.json files in the project folder must not be in a read-only location.
When you publish a project that contains coded automations, an XML file is generated for any custom code or libraries. This XML documentation file is included both in the project folder, and in the lib subfolder of the generated NUPKG file.
Visit About Publishing Automation Projects to learn how to publish your projects.
Supported runtimes
Coded automations support the following runtimes:
- Robot - You can deploy coded automations on Robots that support the Windows framework versions 2022.4 and higher.
- Orchestrator - You can deploy coded automations on any version of Orchestrator that's in support.
Converting coded automations
You can convert a coded workflow to a coded test case and the other way around. To convert a coded automation, right-click the file in the Project panel and select Convert to Test Case or Convert to Workflow.
Coded automations and UiPath CLI
For projects that contain coded automations and run using UiPath CLI version 2023.10, you must to commit the CodedWorkflow.cs file located in your local project file using the GIT integration. Follow the path structure .local/install/CodedWorkflow.cs for the files you need to commit.
