- 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-026 - Delay Activity Usage
- ST-DBP-027 - Persistence Best Practice
- ST-DBP-028 - Arguments Serialization Prerequisite
- ST-USG-005 - Hardcoded Activity Arguments
- 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
- Trigger-based Attended Automation
- Recording
- UI Elements
- Selectors
- Object Repository
- Data Scraping
- Image and Text Automation
- Citrix Technologies Automation
- RDP Automation
- VMware Horizon Automation
- Salesforce Automation
- SAP Automation
- macOS UI Automation
- The ScreenScrapeJavaSupport Tool
- The WebDriver Protocol
- 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
- Test Suite - Studio
- 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
2024.10.5
Release date: 21 October 2024
Autopilot can also generate activity output variables which are then automatically used in subsequent activities (for example, Autopilot will use the output variable generated for a Create Event activity in the Event field of a Forward Event activity).
The new Autopilot panel makes the development process more accessible and efficient.
Two new Workflow Analyzer rules are now available to help with migrating projects from the Windows - Legacy to the Windows compatibility.
Workflow Analyer rules for code
- ST-DPB-010: Make sure that
within any coded workflow or test case, only one
method is marked with either the
[Workflow]
or[Test Case]
attribute. - ST-NMG-017: Ensures that a class name is distinct from the default namespace.
- Erratum - Added October 30, 2024: ST-REL-001: Ensures that the argument types of In/Out parameters are matching.
XML documentation file for your custom code and libraries
XML
documentation files after you
publish a project and enjoy the benefit of code documentation for
your custom code and libraries. After the project is published, the
XML
files are generated alongside the
DLL
and PDB
files in your
project folder. You can also find them in the lib folder of the
generated NUPKG
file. Visit Working with Coded automations to learn
more about publishing projects that contain coded automations.
Erratum - Added October 30, 2024: Modify arguments as properties for coded automations in libraries
You can now seamlessly adjust the properties of a coded automation reused as an invoked workflow through the properties present in the body of the activity. This applies when you export a coded automation to a library, install that library into another project, and invoke the coded automation within your current XAML workflow. In invoked workflow added as an activity, modify the available properties of the invoked coded automation as needed.
Additionally, inside the library project, you can also configure the layout of an activity from the Activity Properties window. Configuring the activity properties before exporting the coded automation involves editing options such as the Display Name, Tooltip, or Help Link.
For more information, visit Invoking coded automations using libraries.
Erratum - Added October 30, 2024: Declaring In/Out arguments
using Output
Output
. Naming any argument as
Output
treats it as an In/Out argument,
even if it's only declared once in the method. For more information
about using arguments in coded automations, visit Working with Input and Output arguments.
XBrowser Test Template
Streamline your testing processes of websites and web applications by using the XBrowser Test Template. This template allows you to test the same test data of a web application with multiple browsers, all into one single automation. Visit XBrowser Test Template for more information.
Generating low-code test cases using AI
You can now generate a fully automated low-code test case using natural language, with the help of AutopilotTM. Visit Generating test cases using AI to check how to generate low-code test cases.
We have made several improvements to the way in which you can manage cloud projects.
When a cloud project is edited in Studio Web, you can only open it in Studio in read-only mode (the project cannot be opened in edit mode both in Studio Web and Studio).
Studio now informs you every time you lose editing access (for example, when the project is edited by someone else or the cloud connection is lost), to avoid possible future conflicts when trying to save the project.
When a project is saved in a different location on your machine, you now have the option to either unlink the project from the cloud or use the new local path to the project.
When you open a project, Studio automatically detects if you manually moved the project to a different location on your machine, and your input is not needed.
Lastly, local and cloud projects are now clearly labeled as such in the Studio Backstage.
- New designs for the Start, State, and Final nodes.
- An infinite canvas Designer panel, with a new grid system to better position your activities.
- Improvements to the design and functionality of activities and connectors, complete with support for adding annotations.
- Fixing line spacing and text alignment.
- Improving the layout of the Fix and Use Variables buttons.
- Adding dedicated Undo and Redo buttons.
- The following keyboard shortcuts now allow you to expand or reduce your current
code selection as follows:
Ctrl + Shift + <Num+
: Expand your current code selection to include the next larger syntax node. From the current line, you can expand to include the current block, then the current method, the current class, the namespace, and finally the entire file.Ctrl + <Shift + Num-
: Contract the current syntax node selection incrementally.
- You can now record your interactions with UI elements and translate them into coded automations.
AI-generated test data improvements
- When using Autopilot for generating test data, you can instruct it to introduce additional arguments, which will be included in the test case once you import the generated data set.
- Now, you initially offer a prompt instruction to Autopilot to get a primary test data set. This is a change from the previous behavior where Autopilot initially created a test data set that you were able to refine using prompt instructions.
- You can instruct Autopilot to generate a certain number of data variations.
Improved error messages for Postman integration
We've made improvements to the API Test Automation. Error messages from the Postman integration are now more clearly displayed in the user interface.
Converting text into code improvements
You can now turn text into code by selecting the Autopilot icon or by choosing the existent Generate Code action.
- The
UiPathStudio.msi
installer no longer supports thePackages
command line feature flag . This does not impact the installation process, as the feature flag was kept for backwards compatibility and had no real function. UiPathStudio.msi
does not support direct upgrade from Studio 2018.4 or lower. Upgrading from such a version must be done through an intermediary upgrade to the latest 24.10 patch.
- Optimized compile times for complex projects including low-code and coded test cases, execution templates, and entities.
- You can now improve the alignment of flowchart nodes and connectors in the Designer panel by using the Auto arrange context menu option. You can choose to make your flowcharts more readable by arranging them either horizontally or vertically.
- Project validation is now faster.
- GIT integration in Studio now supports Schannel.
- The Dictionary Builder now supports complex expressions both in the Key and Value fields. You can also switch between the Expression Editor and the Dictionary Builder in activity properties that only used the Dictionary builder.
- You can now add a top level annotation to the main sequence of a project by right-clicking the Designer panel and selecting Annotations > Add Annotation. The main sequence is now hidden by default.
- We have improved the message you see in the Manage Packages window when you select an activities package that is not compatible with your project.
- The Project Dependencies Mass Update Tool now has an Install Missing Package option for updating dependencies which are already part of projects or installing dependencies in projects that do not contain them.
- To reduce the size of published packages, .git and .svn folders are now excluded from the resulting NUPKG file.
-
Several performance improvements have been made to RAM usage.
Coded Automations
To avoid conflicts when you use connections from the same Orchestrator folders, you now need to use a different naming convention when establishing connections in coded automations. After you create the connection in Integration Service, call it in your coded automation using both the Orchestrator folder and subfolder name where the connection resides.
var myGmailConnection =
connections.Gmail.My_Workspace_john_doe_gmail_com
, where
My_Workspace
is the Orchestrator folder name, you now need to
include the subfolder name where the connection was first made. So if the Gmail
connection is in the My Gmail Workspace
subfolder, you would change the
connection name to: var myGmailConnection =
connections.Gmail.My_Workspace_My_Gmail_Workspace_john_doe_gmail_com
.
For more details on the new way to set up service connections in coded automations, visit Creating Connections for services in coded automations.
Studio Logs
Fatal
severity logs appear as Trace
logs in the
Output panel and are filtered as Trace
logs when clicking
the Trace
button
in the panel’s header.
- While debugging a XAML workflow within a project that contained CS files, an 'Unexpected error during library compilation: Value cannot be null. (Parameter 'type')' error occurred, which caused the compilation to fail.
- A Root element is missing error occurred when publishing some background processes.
- Some projects with missing dependencies were incorrectly reported as published when using the Project Dependencies Mass Update Tool.
- Studio logged Bad IL format compilation errors when running some projects migrated from Windows - Legacy. These errors did not affect project execution.
- Unused dependencies were not correctly identified when analyzing some projects migrated from Windows - Legacy.
- Compilation failed for some projects where the combined length of user strings exceeded the allowed limit.
- Renaming a project caused invalid references in projects with XAML files referencing code assemblies.
- When creating custom activities using code, the UiPath.Workflow 6.0.0-20231211-03 package led to a version conflict with Microsoft.CodeAnalysis.Common. The solution involved adding a previously missing dependency.
- Publishing some projects with missing dependencies in a GitHub CI/CD pipeline did not return validation errors.
- The ST-NMG-004 - Display Name Duplication rule incorrectly detected repetitive activities names.
- The Locals panel did not display any information when debugging some projects saved on a network drive.
- Elastic Robot Pools were not displayed in the Machine drop-down menu when configuring an Unattended Robot remote debugging connection.
- Studio incorrectly detected workflow changes when debugging some projects using Step Into.
- The Text Builder showed a non-functional Plus button in cross-platform projects.
- Multiple BC31424 and BC30652 validation errors occurred when trying to publish some projects created in earlier versions of Studio.
- Publishing some projects that contained a large number of test cases (200+) took longer than expected.
- Compiling some projects containing a large number of workflows (1000+) took longer than expected.
- Application tracking does not work for applications used in libraries.
- When working with coded workflows or
test cases, an error can occur. If you attempt to create arguments of any type
(including In, Out, and In/Out) with certain names such as
result
,newResult
,codedWorkflow
andisolated
, you may encounter a compilation error.
UiPathStudio.msi
installer and can be found in the
local feed.
Activity package |
Version |
---|---|
UiPath.UIAutomation.Activities | |
UiPath.System.Activities | |
UiPath.Excel.Activities | |
UiPath.Mail.Activities | |
UiPath.Word.Activities | |
UiPath.ComplexScenarios.Activities | |
UiPath.Presentations.Activities | |
UiPath.Testing.Activities | |
UiPath.WebAPI.Activities | |
UiPath.Form.Activities | v24.10.5 |
UiPath.Callout.Activities | v24.10.5 |
- What's New
- New Autopilot™ features
- New Workflow Analyzer rules
- Coded automations features
- Test automation features
- Improvements
- Improved save to the cloud experience
- State machine improvements
- Improved Expression Editor
- Coded automations improvements
- Test automation improvements
- Installation and upgrade
- Other improvements
- Breaking Changes
- Bug Fixes
- Known Issues
- Activity package versions