User Interface
User Interface
that users interact with within the UiPath Studio environment to build,
debug, and manage robotic process automation (RPA) projects. It provides
a graphical environment for designing and executing workflows, managing
activities, and interacting with applications during automation.
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.
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.
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:
Backstage View
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.
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, which
displays the description, target framework, language used for expressions, and
project source (local, Studio Web, or GIT/SVN/TFS repository) for each project.
Hovering over an entry in the Open Recent list displays the path to
the project.json file and when the project was last opened.
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.
Select the Apps tab for the UI Explorer, Project Dependencies Mass Update
Tool, and the Repair Tool for Microsoft Office.
Select the Plugins tab to enable or disable source control and test
automation plugins.
Settings - Change the look and feel of Studio, set global preferences, and manage
activities package sources. For more information, see Configuring Studio Settings.
This is where you can also access a quick tutorial that helps you learn the basics of
creating, publishing, and running an automation.
Add Activity
The Add activity search bar is opened using the Ctrl + Shift + T keyboard shortcut. You can
search for activities in installed and installable 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.
If the Enable AI activity suggestions option in the Studio design settings is selected, a
UiPath AI service analyzes the location in the workflow where you opened the Add activity
search bar and suggests activities that you may want to add next based on the current
context. If there is no context (for example, you press Ctrl + Shift + T when no activity is
selected in the Designer panel) activity suggestions are not provided.
If the Show activities available to install option in the Studio design settings is selected, you
can search for activities that are not included in your installed packages. Searching for
available activities is only possible for packages from the Official and Orchestrator
Tenant feeds. Adding an available activity also installs its corresponding activity package.
Selecting the installation button installs the package without adding the activity to the
workflow.
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.
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.
Go to File
The Go to file bar searches and opens files part of the current project folder. .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.
NOTE: The Activities, Project panels, and the Command Palette support fuzzy search,
which means that a list of results is returned even if the search terms don't match exactly.
The search terms could be slightly incomplete, misspelled or include only the first letter of
each word. For example, if you type dci in the Activities bar, it returns the Double Click
Image activity.
Jump to 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.
When opened, the Jump to activity bar displays the list of all activities in the .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 Panels
The Designer Panel
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. You can undo / redo an
action you performed in the panel using the buttons in the Studio ribbon or by
pressing Ctrl + Z / Ctrl + Y.
If an activity has validation errors, an error icon is displayed on the right side of the
activity title bar in the Designer panel and a warning icon is displayed for all its parent
activities. The error message is also displayed at the top of the Properties panel for the
activity affected by the issue.
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.
NOTE: If you select more activities, the menu is not displayed at all.
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 the clipboard, their order is reversed.
:warning: Copying an activity to a project with a different compatibility (e.g.
from Windows - Legacy to cross-platform) can cause the execution of the
destination workflow to fail.
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
Option Description
prompts the user to set the details for saving it (Name, Type, Destination).
Supported formats: JPG, PNG, GIF, XPS.
Remove Removes the selected Sequence activity from the Designer panel. The
Surrounding activities that it contains are moved to the parent sequence.
Sequence
Extract as 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
Workflow
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. Please note that this applies
only to variables you create, arguments are not created from variables created
implicitly by parent activities such as For Each.
Disable Activity Disables an activity, which is then placed inside a Comment out activity.
Toggle Marks the selected activity as a breakpoint for debugging. Breakpoints can
Breakpoint also be toggled by clicking the Breakpoint button in the Execute tab. You
can trigger a breakpoint for one activity at a time.
Run to this Debugs the project and stops before this particular activity is executed.
Activity
Show All Displays all conditions defined in your project (Properties panel
Conditions > 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 Connects the selected activity with the Start node.
NOTE: Only displayed for flowcharts.
Node
Set as Initial Connects the State Machine specific activity with the Start node.
NOTE: Only displayed for state machines.
State
The context menu is also displayed for tabs in the Designer panel. The following options
are available:
Option Description
New Horizontal Splits the screen horizontally, enabling you to see two or more instances of
Tab Group 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 Splits the screen vertically, enabling you to see two or more instances of
Group 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 Moves the target tab onto the previous Designer panel displayed.
NOTE: Only displayed if you had used the New Vertical Tab
Tab Group
Group or New Horizontal Tab Group options before.
Move to Next Moves the target tab onto the next Designer panel displayed.
NOTE: Only displayed if you had used the New Vertical Tab
Tab Group
Group or New Horizontal Tab Group options before.
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.
NOTE: The search box can be used for finding activities by their class name, regardless of
the interface language set in Studio.
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.
To add an available activity to your project, double-click it or drag and drop it in your
workflow. When you add an available activity to a project, the package that contains it is
installed as a project dependency. You can also add an available package to your project by
right-clicking its name and selecting Install.
1. Add an available Integration Service activity, or right click the name of the category
in the Available section and select Install to add the UiPath Integration Service
Activities package as a project dependency.
2. Add other Integration Service activities from the Available category, without
installing additional packages. The available activities included in the Integration
Service package are added to your workflow instantly.
For more information about working with Integration Service activities, see the Integration
Service activities guide.
Click the Group by button to group available activities by the category they belong to or by
the package they belong to. You can also clear the two options to see an ungrouped list of
activities arranged alphabetically.
Click the Filter by button to filter activities based on the options below.
For cross-platform projects
Filter by availability:
Installed - Show activities that are part of packages installed in your project
(this filter cannot be deactivated)
Available - Show activities that are part of uninstalled packages that you can
add to you project
Filter by type:
Installed - Show activities that are part of packages installed in your project
(this filter cannot be deactivated)
Available - Show activities that are part of uninstalled packages that you can
add to you project
Filter by type:
Filter by category:
Filter by category:
You can add your own by clicking the Add Folder button and selecting a directory from
your hard drive. Empty folders are not displayed.
In projects with the cross-platform compatibility, all activity properties are available in the
activity card in the Designer panel if the Show activity properties inline design setting is
enabled. This also applies to some activities in projects using the Windows compatibility.
The Expression Editor includes intelligent code completion features. 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.
When you close the editor, its position on the display, window size, and text zoom level are
saved and applied the next time you open it.
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.
The Export Logs button is used for exporting logs into a .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 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 Output panel is not intended for production monitoring and should only be used
when developing automations. Events might not be displayed as expected if, for example, a
large number of Log Message activities are used. To monitor production runs, use
the Orchestrator logs.
Debugging Panels
The following panels are available to help you debug your projects: Breakpoints, Call
Stack, Locals, Watch, and Immediate.
Cloud Project - For cross-platform projects that use the VB language, a menu is
available with options related to editing the project in Studio Web. If a project is not
already synced with Studio Web, the label Cloud Compatible is displayed. If the
project is already synced with Studio Web, the label Cloud Project is displayed. For
more information, see Designing Cross-platform Projects.