UiPath Studio Guide

The User Interface

UiPath Studio contains multiple panels for an easier access to specific functionalities. They can be docked, act as floating windows, or the Auto-hide option can be enabled.

The Ribbon

The ribbon is straightforward and can be minimized or expanded by clicking the Minimize / Expand button image alt text. It consists of the following four tabs:

  1. Start - create a project or open a previously created one, switch to a Beta or Stable version, go to the online documentation or submit a request. By default, projects are created in C:\Users\Username\Documents\UiPath.
  1. Design - create or launch sequences, flowcharts or state machine diagrams, access wizards, manage variables, and inspect user interface elements from third-party apps.
  1. Execute - run or stop projects, start the debug process, slow down steps and open logs.
  1. Setup - publish a project or create a shortcut for it, schedule tasks, and install extensions with just one click.

Note:

Files that are not created during the execution of the automation project become read-only when published to Orchestrator. As a result, you can only read them, and not write to them when starting the process from 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 Quick Access Toolbar

The Quick Access Toolbar is located by default on the title bar, above the ribbon, yet you can easily move it below.

It provides shortcuts for the most used commands, and you can easily add new ones to it by right-clicking a desired button and selecting the Add to Quick Access Toolbar option.

The Universal Search Bar

The Universal Search bar enables the user to find anything contained in the Activities, Libraries, Project and Designer panels of Studio.

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.

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.

Note

If you select more activities, the menu is not displayed at all.

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 **Collapse**.
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 **Expand**.
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.

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.

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.

Remove Sequence

Removes the selected Sequence activity from the Designer panel.

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.

Open Workflow

Opens a workflow created using the above option.

Disable Activity

Disables an activity, which is then placed inside a Comment out activity.

Enable Activity

Enables a previously disabled 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.

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

The Activities panel provides quick access to all available activities that can be dragged to the current project.

It features a search box, and the Show Activities list enables you to hide or show the Favorites, Recent and Available folders of activities.

The Manage Packages functionality enables you to install additional activity packages. For more information, see the Managing Packages chapter.

The Library Panel

The Library panel enables you to easily reuse automations. A search box is included to facilitate finding items faster.

It includes, by default, multiple samples and snippets, and you can add your own by clicking the Add Folder button and selecting a directory from your hard drive.

To remove a folder, right-click it and select Remove.

Note:

If you add empty folders, they will not be displayed.

The Project Panel

The Project panel enables you to view the contents of the current project and open the file location in a Windows Explorer window.

You can connect to a type of source control, either TFS or SVN, and create a new project directly from this panel.

For more information, see the Connecting to Team Foundation Server chapter.

Version control is available through the context menu, and it is also possible to view the history of a selected file.

The Properties Panel

The Properties panel is contextual and enables you to view and change the properties of a selected activity.

The properties can be sorted alphabetically, while the search box enables you to look for a specific one.

The Outline Panel

The Outline panel displays the project hierarchy, all available variables and nodes, and includes a search box. This enables you to easily navigate through large automations.

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

The Output panel enables you to display the output of the Log Message or Write Line activities, as well as the logs when the debug mode is activated.

When debugging, the logs are more or less detailed, depending on the option you selected in the Execute tab, under Options > Logging Level.

You can hide or show timestamps, errors, warnings, information or trace data, by clicking the buttons in the panel’s header. Additionally, the Clear All button erases all info displayed in the Output panel.

Double-clicking a message displays further details about it.

The Locals Panel

The Locals panel displays all the variables that are in the scope of the activity that is currently running. This panel is only visible at runtime or while debugging.

It can be used to track the usage of variables during execution, as well as viewing their values while they change. This can be done in the Property Value window, which can be accessed by hovering over the Value field of a variable and clicking the image alt text button.

The User Interface