- 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
- Variables
- Arguments
- Imported Namespaces
- Recording
- UI Elements
- Control Flow
- Selectors
- Object Repository
- Data Scraping
- Image and Text Automation
- Automating Citrix Technologies
- RDP Automation
- SAP Automation
- VMware Horizon Automation
- Logging
- The ScaleCoordinates Migration Tool
- The ScreenScrapeJavaSupport Tool
- The WebDriver Protocol
- StudioPro
- Extensions
- Troubleshooting
The User Interface
UiPath Studio contains multiple panels for easier access to specific functionalities. They can be docked, act as floating windows, or the Auto-hide option can be enabled from the drop-down list.
No. |
Name |
Description |
---|---|---|
1 |
Access the three main areas of Studio:
| |
2 | ||
3 |
Build your automation by managing the activities added to the current workflow file. | |
4 |
Search within your project using the available search bars: | |
5 |
Manage variables. | |
6 |
Manage arguments. | |
7 |
Manage imported namespaces. | |
8 |
View the contents of your current project, manage files, folders, and dependencies, and adjust project settings. | |
9 |
View all available activities and add activities to your automation. | |
10 |
Use pre-built workflows and add your own reusable automations. | |
11 |
View and configure the properties of a selected activity. | |
12 |
View the hierarchy of the current workflow and all available nodes. | |
13 |
Add resources such as assets, queues, processes, and entities from Orchestrator. | |
14 |
Create and reuse UI taxonomies inside and across projects. | |
15 |
View the output of the Log message and Write Line activities, status information regarding the execution of your project, errors generated by activities packages, and more. | |
16 |
View all the errors generated when running the Workflow Analyzer. | |
17 |
View all the places where an element is referenced in your project. | |
18 |
Manage breakpoints added to the project. | |
19 |
View status information and manage the Orchestrator connection and source control integration. |
The ribbon is straightforward and can be minimized or expanded by clicking the Minimize / Expand button . It consists of the following three tabs:
- Home - create and open projects, configure Studio, or access help and license information from the Studio Backstage View.
-
Design - add sequences, flowcharts and state machines to your project, install and manage activities packages, build interactions with UI elements, export workflows to Excel, and then publish your work to Orchestrator or custom feeds. Keep in mind that wizards and UI Explorer aren't visible in the Ribbon unless you install the
UiPath.UIAutomation.Activities
package. -
Debug - debug your workflow, while using debugging tools to set breakpoints, monitor the execution of activities step by step, and adjust the debugging speed. Open logs to view details regarding execution and any changes made to the project. For more information on debugging, check the About Debugging page.
Note: Files that are not created during the execution of the automation project become read-only when published to Orchestrator. If your business process requires you to write in a specific file at some point, be sure to create it while designing the project.
Send Feedback
There are two types of feedback that you can send directly from within Studio: Submit an idea for the product or Report a bug. Both are accessible from the ribbon by clicking the icon.
The Send Feedback feature must be used only for sending anonymous feedback to the product team. To contact our tech support team, please use the Contact Technical Support form.
Provide the following information, and then click Submit:
- From the I want to drop-down menu, pick either Submit an idea for the product or Report a bug.
- From the For drop-down menu, pick either UiPath Activities, UiPath Studio, UiPath Robot, UiPath Orchestrator or UiPath Assistant.
- From the How important is this to you drop-down menu, pick Nice to have, Important, or Critical.
- In the Subject field, add a short title.
- Add a detailed description and attach up to 6 images, videos, or text files, each with a size smaller than 10MB. The threshold for sending feedback is 3 posts in a timeframe of 5 minutes.
Help
Click the Help icon to quickly access the resources that are also available in the Help tab in Backstage View, as illustrated below:
Sign in to Your Account
UiPathStudio.msi
installer with the Robot in user mode or you are using the Community Edition of Studio, you can connect Studio and the Assistant
to Orchestrator by signing in to your UiPath account:
-
Click on the upper-right side of the Studio window, and then click Sign in. To find out more information about signing in, click Learn more.
- To use a custom URL instead of the default
https://cloud.uipath.com
, enter the URL in the Service URL field. -
To connect to Orchestrator with your machine key, click Use Machine Key.
- To use a custom URL instead of the default
- A new page opens in your web browser. Complete the sign in procedure, and, when prompted by your web browser, click Open UiPath to return to Studio.
After you sign in, an icon with your initials is displayed on the upper-right side of the Studio window. To sign out and disconnect from Orchestrator from both Studio and the Assistant, click the icon, and then select Sign Out.
Connecting to Orchestrator with Your Machine Key
UiPathStudio.msi
installer with the Robot registered as a Windows service, you can only connect to Orchestrator with your machine key:
- Click , and then click Connect.
-
Enter the Orchestrator URL and Machine Key, and then click Continue.
-
If you want to activate a local license key, click Use License Code.
Note: The option to connect to Orchestrator with the machine key is available only if you are an administrator on your machine.
-
Common Errors when Connecting to Orchestrator
The following table documents errors you may encounter when you try to connect to Orchestrator by signing in or using your machine key, along with causes and solutions.
Error |
Cause |
Solution |
---|---|---|
Interactive sign-in is not enabled for this tenant. Enable it from Orchestrator settings, or connect using the machine key |
You are trying to sign in to your account but user authentication is not enabled from Orchestrator. |
Do one of the following:
|
Unauthorized |
No attended Robot is allocated to your user. |
In Orchestrator, go to Tenant > Users and edit the current user. In the Attended Robot tab, select Automatically create an attended robot for this user and select a License Type. |
The remote name could not be resolved: Orchestrator_URL |
Connection to Orchestrator could not be established. |
Make sure your Internet connection is working. |
This is the view you see when you first open Studio. You can also get here by clicking Home in the upper-left corner of the window. Here you can create and open projects, configure Studio, or access help and license information.
The following buttons and tabs are available in this view:
-
Open - Browse to a local automation project and open it. By default, projects are created in C:\Users\<current_user>\Documents\UiPath.
Note: Projects located on network folders where your user only has read permissions cannot be opened in Studio. We recommend using source control systems to collaborate on projects. - Close - Close the automation project that is currently open.
- Start - Create a new automation project or open recently accessed projects. You can create a new project from predefined templates
or open a project you recently worked on. Projects can be pinned or removed from the Open Recent list, while hovering over
them displays the path to the
project.json
file and the project description. - Templates - Create a new project based on a template. In this tab, you can view all available project templates, search and filter them by source. For more information, see Project Templates.
- Team - Manage source control integration for the automation project.
- Tools - Install extensions for Chrome, Firefox, Edge, Java, Silverlight, Citrix, Windows Remote Desktop, VMware Horizon, launch the UI Explorer, Project Dependencies Mass Update Tool, and the Repair Tool for Microsoft Office Interop. For more information about extensions, see About Extensions.
- Settings - Change the look and feel of Studio, set global preferences, and manage activities package sources. For more information, see Configuring Studio Settings.
-
Help - Directs you to product documentation, release notes, online resources, the Community Forum and the RPA Academy.
This is where you can also access a quick tutorial that helps you learn the basics of creating, publishing, and running an automation.
Note: To ensure the tutorial is completed successfully, we recommend that you pause the tutorial before making any changes to the workflow outside of those highlighted in the tutorial steps.Information regarding product version and installation, license availability, update channel and device ID is also found in the Help tab, together with a Copy Info button for quickly copying the details to the clipboard.
The Command Palette is opened by using the Ctrl + Shift + P, F3 keyboard shortcuts, or by clicking the search button. It incorporates the Add activity, the Universal search, the Go to file, and Jump to activity search bars.
The Add activity search bar is opened using the Ctrl + Shift + T keyboard shortcut. You can search for activities in installed packages, and add them after the selected activity in the file. The bar automatically assigns keyboard shortcuts to the first five results, and remembers your previous findings.
Click the icon at the top or bottom of an activity from a sequence to open the Add activity search bar.
The Universal search bar enables you to find snippets, activities, variables, arguments, imports, project dependencies, and files in your current project. Searches return results from all workflow files, including files that are closed.
Option |
Shortcut |
Description |
---|---|---|
Current File |
Ctrl + 1 |
Lists results from the currently opened file that match the search query. |
All Files |
Ctrl + 2 |
Lists results found in all files part of the current project that match the search query. |
Activities |
Ctrl + 3 |
Lists results from activities that match the search query. |
Variables |
Ctrl + 4 |
Finds variables in the current project that match the search query. |
Arguments |
Ctrl + 5 |
Finds arguments defined in the project that match the search query. |
Imports |
Ctrl + 6 |
Finds imported namespaces in the project that match the search query. |
Project Files |
Ctrl + 7 |
Finds files part of the current project that match the search query. |
Dependencies |
Ctrl + 8 |
Lists results found in dependencies installed to the project. |
Snippets |
Ctrl + 9 |
Finds snippet files that match the search query. |
Search results persist until the next time you open the search bar if you use Universal search or Add activity. For Go to file and Jump to activity the previous search query is not persisted.
Double-click an activity or press Enter to add it to the currently opened file. Using the same commands, you can open files from under the All Files or Project Files category, or focus on the desired search result.
Default values of arguments from a process inside the Invoke Workflow activity are not searchable with the Universal Search.
.xaml
files are opened in the Designer panel in Studio, while other files, such as screenshots or Excel files, are opened with their respective default application
on your machine. Double-click or press Enter to open a file.
dci
in the Activities bar, it returns the Double Click Image activity.
The Jump to activity search bar part of Command Palette helps find and focus specific activities in large workflows. It is accessed by using the Ctrl + J keyboard shortcut, or by opening using the F3 or Ctrl + Shift + P shortcuts, and selecting Jump to activity.
.xaml
file currently focused in the Designer panel.
Type the display name or the namespace of an activity, for example Assign. Use the keyboard arrows to select the activity and press Enter to focus it in the Designer panel.
Activities in the Jump to activity bar are arranged in the following order: container, parent, and child activities.
The Designer panel displays your current automation project, enables you to make changes to it, and provides quick access to variables, arguments and imports.
It is possible to navigate within a diagram by double-clicking the activity you want to view. The path is displayed as breadcrumbs in the header of the Designer panel. Please note that when using multiple displays scaled differently the text in the input field part of some activities might be improperly shown.
Activities can be copied using Ctrl + C shortcut or the context menu, to a text editor, receive changes, and then copied back to the Designer panel.
Activate Pan Mode by clicking the icon, holding the Space key or pressing the middle mouse button. Use the zoom drop-down to change the zoom level and click the icon to reset it back to 100%.
The Fit to Screen icon changes the zoom in such a way that the whole workflow fits in the Designer panel. Click the icon to get an overview of the whole project and navigate through sections by adjusting the focus.
The Context Menu
The context menu enables you to perform several operations on your workflow, be it a sequence or a flowchart. You can display it by right-clicking an activity inside your workflow.
Field Descriptions for the Context Menu
Option |
Description |
---|---|
View Parent |
Displays the parent of the target activity in the Designer panel. Note: This option is only displayed for child-activities, if they are opened in the Designer panel.
|
Open |
Opens the selected activity in the Designer panel. Has the same result as double-click. |
Collapse |
Collapses the activity thus reducing the displayed details to "Double-click to view". You can achieve the same result by clicking the Collapse button . Note: Only displayed for sequences.
|
Expand in Place |
Expands the content of the activity, displaying its detailed content. You can achieve the same result by clicking the Expand button . Note: Only displayed for sequences.
|
Cut |
Removes the selected activity and places it onto the Clipboard. |
Copy |
Copies the selected activity and places it onto the Clipboard. Activities from read-only files can be copied to another workflow
or a
.txt file. When copying multiple activities to clipboard, their order is reversed.
|
Paste |
Inserts the content of the Clipboard at the current location. |
Delete |
Deletes the target activity. Note: Since the Context menu is only displayed for a one-activity selection, you can use this command for more activities with the corresponding
keyboard shortcut, Delete.
|
Annotations |
Add, edit, delete, show and hide annotations added to activities in the workflow. |
Copy as Image |
Makes a screenshot of the content displayed in the Designer panel. Note: If you want to make a screenshot of a child activity, make sure to firstly open it in the Designer panel.
|
Save as Image |
Makes a screenshot of the content displayed in the Designer panel and prompts the user to set the details for saving it (Name, Type, Destination). Supported formats: JPG, PNG, GIF, XPS. |
Create Variable |
Creates a variable in the Variable panel. |
Auto Arrange |
Automatically arranges activities in a flowchart. |
Remove Surrounding Sequence |
Removes the selected Sequence activity from the Designer panel. The activities that it contains are moved to the parent sequence. |
Surround with Try Catch (Ctrl + T) |
Inserts the activity in a Try Catch statement. Note: A Try Catch statement is used for handling exceptions caused by data or coding errors. The Try clause encloses the activity to be checked for exceptions. The Catches clause is the exception handler. The Finally clause is used for executing an activity regardless of the status of the first two clauses.
|
Extract as Workflow |
Creates a new workflow containing the targeted activity with the purpose of breaking down a large project into smaller ones.
In the place of the extracted activity an Invoke
<new> workflow activity is created which enables you to edit and import arguments from the newly created workflow. The arguments
are created automatically from the variables used in that activity. The Invoke <new> workflow activity automatically maps the local variables to invoke arguments for the extracted workflow.
|
Open Workflow |
Opens a workflow created using the above option. |
Enable Activity |
Enables a previously disabled activity. |
Disable Activity |
Disables an activity, which is then placed inside a Comment out activity. |
Toggle Breakpoint |
Marks the selected activity as a breakpoint for debugging. Breakpoints can also be toggled by clicking the Breakpoint button in the Execute tab. You can trigger a breakpoint for one activity at a time. |
Edit Breakpoint Settings |
Opens the Breakpoint Settings window. |
Run to this Activity |
Debugs the project and stops before this particular activity is executed. |
Run from this Activity |
Starts debugging from this activity. |
Show All Conditions |
Displays all conditions defined in your project (Properties panel > Conditions). Note: This option is only displayed for flowcharts when you right-click an empty space inside the project; it is not displayed
if you right-click an activity in your flowchart.
|
Hide All Conditions |
Hides all displayed conditions. Note: This option is only displayed for flowcharts when you right-click an empty space inside the project; it is not displayed
if you right-click an activity in your flowchart.
|
Set as Start Node |
Connects the selected activity with the Start node. Note: Only displayed for flowcharts.
|
Set as Initial State |
Connects the State Machine specific activity to with the Start node. Note: Only displayed for state machines.
|
The context menu is also displayed for tabs in the Designer panel. The following options are available:
Option |
Description |
---|---|
Close |
Closes the active tab. |
Close Others |
Closes all tabs but the active one. |
Close All Documents |
Closes all tabs. |
Float |
Undocks the target tab and changes it to a floating state. |
Pin Tab |
Pins the target tab in the Designer panel. Note: The tab pinned last is always moved in front of all other existing tabs (pinned or not). The position of a pinned tab can
only be changed relative to other pinned tabs.
|
New Horizontal Tab Group |
Splits the screen horizontally, enabling you to see two or more instances of the Designer panel within the same screen. The target project is moved onto the panel on the right. Note: Only displayed when your project contains two or more tabs and, implicitly, workflows.
|
New Vertical Tab Group |
Splits the screen vertically, enabling you to see two or more instances of the Designer panel within the same screen. The target project is moved onto the panel at the bottom. Note: Only displayed when your project contains two or more tabs and, implicitly, workflows.
|
Move to Previous Tab Group |
Moves the target tab onto the previous Designer panel displayed. Note: Only displayed if you had used the New Vertical Tab Group or New Horizontal Tab Group options before.
|
Move to Next Tab Group |
Moves the target tab onto the next Designer panel displayed. Note: Only displayed if you had used the New Vertical Tab Group or New Horizontal Tab Group options before.
|
The Activities panel shows available activities that can be added to the current workflow. You can search for activities by name and optionally by description using the search box at the top of the panel, navigate through them using navigation keys, and press Enter to add the selected activity to the currently opened file.
Hovering over an activity in the panel displays the package it belongs to and its description. To add an activity to the list of favorites, right-click it and select Add to favorites.
Right-click an activity in the panel and select Create Test Bench to test out one or more activities before adding them to a project. Read more about this here.
Customizing the Activities Panel
Click the View Options button at the top of the panel to open a menu that allows you to customize the panel. See the following table for a list of available options.
Option |
Description |
---|---|
Show Favorites |
Show a section with favorite activities. This option is selected by default. |
Show Recent |
Show a section with the ten most recently used activities. This option is selected by default. |
Show Available |
Show all available activities. This option is selected by default. |
Show Compatibility |
Option currently not used. This option is not selected by default. |
Show StudioX |
Show activities designed for the StudioX profile. This option is not selected by default. |
Show Classic / Modern |
Show modern UI Automation activities in projects using the classic design experience or show classic UI Automation activities in projects using the modern experience. This option is not selected by default. |
Show Categories |
Group activities by the category they belong to. This option is selected by default. |
Group by Packages |
Group activities by the package they belong to. This option is not selected by default. |
Search by Description |
When searching in the panel, search in activity descriptions, not just in activity names. This option is not selected by default. |
Pin Favorites |
When searching in the panel, keep favorite activities always visible. Available if Show Favorites is selected. This option is not selected by default. |
The Snippets panel enables you to easily reuse automations. It includes, by default, multiple samples and snippets.
You can add your own by clicking the Add Folder button and selecting a directory from your hard drive. Empty folders are not displayed.
To remove a folder, right-click it and select Remove.
The Properties panel is contextual and enables you to view and change the properties of a selected activity. When selecting two activities in the same workflow, common properties can be modified from the Properties panel.
The Expression Editor is accessible with the Ctrl + Shift + E keyboard shortcut when used inside activity input fields. It is also available from the Properties panel, from fields that require inputting text, and from the body of an activity, by adding text directly in the required fields.
Expressions can be written on multiples lines. Keyboard shortcuts for creating variables and arguments directly in expressions are available.
Use Ctrl + F inside the editor to open the search and replace capabilities. Select part of an expression and press Ctrl + F3 to add the text to the search field. Hold the Ctrl key to make the search pane semi-transparent and see the text behind it.
The Outline panel displays the project hierarchy, and all available nodes. You can highlight activities in this panel by selecting them in the Designer panel, or you can go to a specific activity by selecting it in the Outline panel.
The Output panel enables you to display the output of the Log Message or Write Line activities, among other things. Exceptions for packages are also displayed in this panel.
From the Output panel, you can show or hide messages that have different log levels (errors, warnings) by clicking the buttons in the panel’s header. Double-clicking a message displays further details about it, with the option to copy information.
When searching for a log in the Output panel and selecting an item from the search results list, the log is highlighted.
.txt
file. It exports timestamps and error message details as well. Exporting filtered logs is available. For example, if you
want to export only trace level logs, filter the list and then use the Export Logs button.
When debugging, the Output panel shows logs for when an activity starts executing and until it ends. This can be enabled from the Log Activities option in the Debug tab.
The Error List panel displays errors found in the file or project during the validation process, together with errors generated by About Workflow Analyzer rules.
The Clear All button erases all info displayed in the Output panel. Logs and other data stored in this panel are erased when a workflow is run. The Output panel displays up to 2,000 lines at a time.
The Find References panel displays results for references you search for in your project. To find every place in the project where an element is referenced, right-click it and select Find References. This works for the following:
- Files in the Project panel
- Activities in the Activities panel
- Variables in the Variables panel
- Arguments in the Arguments panel
-
Descriptors in the Object Repository panel
The Resources panel in Studio can load assets, queues, processes, and entities, provided that the Robot is connected to Orchestrator. Read the Connecting Robots to Orchestrator page to find the steps.
If the Robot connected to Orchestrator is of type Standard, then the Resources panel can display only the Classic folder which has this Robot provisioned.
If the Robot is of type Floating, then the panel displays all Classic and Modern folders that this Robot has access to. Read more about creating Robots in Orchestrator here.
The panel displays assets, queues, and processes found in Classic or Modern Folders in Orchestrator. Read more about Folders.
View
permissions for the corresponding resources (i.e. Assets, Queues, and Processes) to appear in the panel. Read more about
setting up Roles and permissions in Orchestrator.
To load resources into the panel, click the Refresh button at the top of the panel. Right-click any item in the Resources panel to copy its name and use it in activities that interact with such resources.
Hover over the folder name in the status bar to see the Orchestrator URL, and click the folder name in the status bar to switch to another folder.
Drag and drop assets, queues, or processes from the Resources panel directly to your automation project. Upon doing so, suitable activities are suggested in the Add activity search bar. For example, after dragging a queue in your project, pick the Add Queue Item activity from the Add activity search bar and notice that the queue was automatically assigned to the activity's Queue Name property.
In the status bar, you can view status information and access options related to Orchestrator and source control. This is where you can also view which language is used for expressions in the project (VB or C#).
- Cloud Options - Click Cloud Options to access Orchestrator options: sign in to your cloud account, connect to or disconnect from Orchestrator, and refresh resources.
- Orchestrator Status - Displays the Orchestrator connection status. When connected to Orchestrator, the currently selected folder is displayed. You can click the status to view a list of available folders and select a different folder from which to sync resources.
- Source Control - Depending on whether the project is connected to a source control repository, different options are available to help you manage source control integration. For more information, see About Version Control.
- Overview
- The Ribbon
- Ribbon Tabs
- The Title Bar
- Backstage View
- The Command Palette
- Add Activity
- The Universal Search
- Go to File
- Jump to Activity
- The Panels
- The Designer Panel
- The Activities Panel
- The Snippets Panel
- The Properties Panel
- The Expression Editor
- The Outline Panel
- The Output Panel
- The Find References Panel
- The Resources Panel
- The Status Bar