- Release Notes
- Getting Started
- Setup and Configuration
- Automation Projects
- Dependencies
- Types of Workflows
- File Comparison
- Automation Best Practices
- Source Control Integration
- Debugging
- 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-DBP-002 - High Arguments Count
- ST-DBP-003 - Empty Catch Block
- ST-DBP-007 - Multiple Flowchart Layers
- ST-DBP-020 - Undefined Output Properties
- 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-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
- Variables
- Arguments
- Imported Namespaces
- Recording
- UI Elements
- Control Flow
- Selectors
- Object Repository
- Data Scraping
- Image and Text Automation
- Citrix Technologies Automation
- RDP Automation
- Salesforce Automation
- SAP Automation
- VMware Horizon Automation
- Logging
- The ScreenScrapeJavaSupport Tool
- The WebDriver Protocol
- Test Suite - Studio
- Extensions
- Troubleshooting
Studio User Guide
Configuring Studio Settings
C:\Users\your_user_name\AppData\Roaming\UiPath
.
Select General in the Settings tab to configure general Studio settings.
- Language- Change the interface language for Studio and Assistant, by picking one of the available languages: English, Japanese, French, Russian, Chinese (Simplified), German, Spanish, Spanish (Latin America), Portuguese (Portugal), Portuguese (Brazil), Korean, or Turkish.
-
Theme - The Studio interface theme can be changed by choosing either Light or Dark from the drop-down menu, and restarting Studio for the changes to apply.
If you select the High Contrast option from the Windows operating system, Studio switches to High Contrast mode after you restart it.
Note: For the Dark theme to work, automation projects must have at leastUiPath.UIAutomation.Activities
v18.4.2 andUiPath.System.Activities
v18.4.1, as dependencies. - Telemetry - Select whether to allow Studio to collect and send anonymous usage data and UI Descriptors created using the Object Repository. For more information about anonymous data collection, see Opting Out of Telemetry in the Installation and Upgrade Guide.
-
Reset Settings - Revert the following settings in Studio to their default state:
- All General and Design settings.
- The list of Recent files;
- The list of Favorites activities;
- Studio layout adjustments;
- The Break on Exceptions option in the Execute tab > Options;
- Show Activities options and pinned activities in the Activities panel;
-
User-added folders in the Snippets panel, the last directory where you opened a project from, and the Update Channel, which is switched to Stable.
Please note that resetting settings has no effect on feeds.
Select Design in the Settings tab to configure a set of global design settings that apply to all projects opened in this version of Studio.
-
Save and Publish
- Auto backup interval - Set a regular interval at which projects are automatically backed up. This is useful for restoring the last saved copy of the workflow. The default value is set at 30,000 milliseconds. The minimum value is 10,000 milliseconds, while the maximum one is 9,999,999 ms.
- Publish project timeout - Set the timeout value for publishing projects. The default value is 30 seconds. The maximum timeout is 999,999 seconds while the minimum one is 1 second.
- Open Project Behavior - Select what files to open by default when reopening a project. Pick from Keep Last Opened Tabs, Open Main Entry Point or No Tabs.
- Enforce Analyzer before Publish - Select this option to prohibit publishing projects with Workflow Analyzer errors.
- Enforce Analyzer before Run - Select this option to prohibit running and debugging files or projects with Workflow Analyzer errors.
- Analyze RPA XAML Files Only - Select this option to exclude XAML files with test cases from analysis when running the Workflow Analyzer for a project. If not selected, both RPA and test case XAML files are analyzed. This setting applies when the analyzer is triggered manually, as well as when it is enforced and triggered automatically before running/debugging a project and publishing test cases or a project.
- Export Analyzer results - Select this option to export the results of each workflow analysis to a JSON file in the project folder.
-
Enable AI activity suggestions - Select this option to enable or disable AI activity suggestions in the Add activity search bar. If this option is enabled, when you open the activity search bar, Studio sends information about the current context to a UiPath AI service that suggests activities you may want to add based on the location in the workflow from which the search bar was opened.
Note: The service does not collect or record any information, it only analyzes the current context and returns a list of suggested activities. - Enforce Check-In before Publish - Select this option to restrict publishing projects added to source control repositories when they have local changes.
-
Execution
- Output console size - Set the maximum number of lines that can be displayed in the Output panel in a single session. The default value is 2,000 lines. The maximum value that can be added is 9,999 lines, while the minimum one is 1 line.
- Run/Debug Default Behavior - Configure the default action for the Run/Debug ribbon button. Pick from Debug File, Run File, Debug Project, or Run Project.
- Minimize on run - Use the toggle to set Studio to maximize or minimize when running projects.
-
Design Style
-
Use C# Language - Select the default language to use for expressions in new projects. If selected, C# is by default the language used for expressions in new projects. If not selected, new projects use VB. You can select a different language than the default whenever you create a new project.
This option is available only in the Studio profile. Projects created in the StudioX profile use the VB language for expressions.
- Create docked annotations - Select the default way in which annotations are added to activities: docked inside the activity (if the option is selected) or floating next to the activity (if the option is not selected).
- Default to managed connections - Select this option to use the Integration service in Automation Cloud as the default way to manage connections in all activities that support it. This option is enabled by default if the Integration service is available in the Orchestrator tenant that Studio is connected to. When enabled, the activities in the GSuite, Mail. and Office 365 packages that support this feature default to using Integration service connections for authentication.
-
Use Modern for new projects - Enable a modern design experience of working with UI and Excel automation in all new projects. The modern experience brings:
- For UI automation - New and improved activities, recorders, and wizards, as well as support for the Object Repository. For more information, see Modern Design Experience.
- For Excel automation - New activities and a deep integration with Microsoft Excel. For more information, see About the Excel Activities Pack. This setting applies to Excel only if the Excel Design Experience option is set to UseGlobalSetting in the Excel activities project settings.
- Object Repository enforced - Select to allow only elements from the Object Repository in UI Automation activities.
- Slim View for Collapsed Activities - Reduce the space collapsed activities take up by enabling a view that only displays the title bar.
-
Select Locations in the Settings tab to configure default locations for projects, publishing, and custom Workflow Analyzer rules.
- Project path - The default location where projects are created.
- Publish process URL - The default location where processes are published when the custom feed option is selected.
- Publish library URL - The default location where libraries are published when the custom feed option is selected.
- Publish project templates URL - The default location where project templates are published when the custom feed option is selected.
- Custom Workflow Analyzer rules location - The folder from which to add custom Workflow Analyzer rules to Studio. If no location is provided, the default location for custom rules is used.
For each option, you can browse to and select the the desired location, or enter the full path in the provided text box.
Select Manage Sources in the Settings tab to manage feeds for activities packages from Studio Backstage view without having to open a project. This section is similar to the one in the Manage Packages window, which lets you adjust feeds per project.
Select License and Profile in the Settings tab to add a local license key or switch to another user profile.
- To add a new license key when Studio is licensed locally, click Change Local License, enter the new license key, and click Continue.
-
To switch to another profile, click Change Profile, and then select Studio or StudioX.
Note: If you activated a Citizen Developer license, you can only use the StudioX profile.
Select Team in the Settings tab to enable or disable Source Control plugins. For more information, see About Version Control.
This section holds features marked as Experimental that are still under development and may cause breaking changes before they're fully released. UiPath does not support backward compatibility for Experimental features.
From the Labs tab, you can enable or disable Editor enhancements in your processes and libraries.
If this option is enabled, a Plus button is displayed when you hover the mouse over the right side of any text input field in the body of an activity or in the Properties panel. Click this button to open a menu with the following options:
- Open in Advanced Editor - Open the Expression Editor.
- Create Variable - Create a variable of the same type as the type required for the activity.
-
Clear Value - If a value already exists in the field, this option enables you to clear the value.