Subscribe

UiPath Robot

The UiPath Robot Guide

About UiPath Assistant

About

The UiPath Assistant is a tool created specifically to turn the user's interaction with our robots into a great and enjoyable experience from the comfort of their desktops. It's the place where individuals can easily access, manage and run automations with just a couple of clicks. Here you can also connect the Robot to Orchestrator. The interface can be customized to better suit the person behind it by choosing an avatar and a name for the robot, organizing automations in custom folders on the launchpad, or maybe choosing another theme. All of this makes the UiPath Assistant our bridge between humans and Robots.

The first time Assistant is started, you are presented with an interactive guided tour which takes you through its main features. This can always be restarted from the Help section in the Preferences menu.

As a client of the Robot, it can send commands to start or stop jobs and change settings, based on user input.

Although it is specially designed for attended use, UiPath Assistant doesn't impose any limits as to what automations you can start. This means that you're able to easily connect to Orchestrator and have jobs started from there.

During installation, you are able to choose to deploy the Robot in User Mode or Service Mode to better suit your environment. For more details, see the According to Deployment document.

After you install and run the UiPath Assistant, an icon Robot_iconRobot_icon is displayed in the system tray. Clicking this icon brings UiPath Assistant into focus, while right-clicking it brings up a menu from which you can access the Preferences, Orchestrator Settings, bring it to focus or Quit.

UiPath Assistant and Automation Execution icons:

Tray

  • connectedconnected - when the connection is established.
  • disconnecteddisconnected - when not connected.
  • connection_errorconnection_error - when an error is encountered, such as the UiPath Robot service being stopped.
  • warningwarning - when there are new or unread notifications.

Taskbar

  • searchsearch - Simple Assistant
  • searchsearch - Running Automation.
  • searchsearch - Running Automation in PIP.

Statuses

The connection status with Orchestrator can also be viewed by hovering over the tray icon, or in the UiPath Assistant status bar, as follows:

  • Connected, Licensed, protected with EDR system - when a Robot exists and is licensed, and you use the CrowdStrike EDR sensor.
  • Connected, Licensed, EDR protection not detected - when a Robot exists and is licensed, and you don't use the CrowdStrike EDR sensor.
  • Connected, Unlicensed - when a Robot exists, but is not licensed. The following tooltip message is displayed on mouse hover: "There are no available licenses on the server.".
  • Connected, Unlicensed - this status is displayed along with one of the following tooltip messages on mouse hover, in the following cases:
    • "An Orchestrator Robot definition must exist for this user." - if a Machine that hosts the Robot is not defined on Orchestrator. For example, if you deployed your Robots using the ConnectionString without first defining the Robots in Orchestrator.
    • “Robot does not exist.” - when no Robot is defined.
    • “Robot already connected to machine ‘Machine_Name’.” - a floating Robot is already in use on a different machine.
    • "The machine key is linked to another machine!" - the key you used to connect to Orchestrator belongs to another machine in Orchestrator.

For more information, see the Field Descriptions for UiPath Assistant.

Signing In to Your Account

  1. Click the Sign in button from the main window or click PreferencesPreferences to open the Preferences menu, then click Sign In.
10281028
  1. A new browser window opens. Depending on your authentication method, you can either log in with your username and password or by using one of the available authentication providers.
926926

When you log in, you are authenticated against the default Service URL, https://cloud.uipath.com. For more information about using interactive sign-in, see the interactive sign-in documentation.

:information-source: If your organization is using a basic authentication proxy, the UiPath Assistant automatically detects it, and prompts you to enter the username and password. For more information, see the robot documentation on proxy configurations.

:information-source: If your organization defined a trusted IP range using access policies, and your IP falls outside this range, you will be prompted with the following error message: UiPath Robot Error. Response status code does not indicate success: 403 (Forbidden). See more information about Restricting access by IP.

Interface

The UiPath Assistant's Interface is composed of a two-column design:

The left side contains the tabs (Home, Reminders, and Marketplace), while the right side, also named "the Launchpad" has your favorite automations to provide easier access to them. You can drag and drop them, arrange them, and create sections as shown below. The right side also displays the Automation Details when used.

On the bottom of the UiPath Assistant you can find the Robot Identity and the search bar used to find automations easier.

When you have the Automation Store Widget deployed, the search functionality in the Assistant Home tab also returns related ideas that are part of Automation Hub, but not deployed in the Automation Store. It also returns results from the Marketplace Widget.

11881188

The UiPath Assistant is split into the following tabs:

The Home Page Tab

The Home Page tab enables you to:

  • View all the available automations:
    • If UiPath Assistant is connected to Orchestrator, automations from the environments and folders the Robot is a part of are displayed. Hovering over an automation displays its name, version and folder.
    • If UiPath Assistant is not connected to Orchestrator, automations from the %ProgramData%\UiPath\Packages folder are displayed. The Packages folder can be specified, as explained on this page.
  • View all the available Apps, if the Apps Widget is enabled in Automation Ops.
  • View the automations from Automation Store, if the Automation Store Widget is enabled in Automation Ops.
  • Download automations that have a newer version available, or that need to be downloaded and unpacked locally, and view the installation status.
  • Add or remove an automation from the Launchpad. Click the contextual menu and then select "Pin to Launchpad" or simply drag and drop the automation from the left panel to the Launchpad.
  • View all currently running foreground and background automations.
  • Pause, resume, or stop an automation. The Pause button can be disabled for an automation from the Studio Process Settings window. Once an automation is started, the execution status is displayed. You can use the Report Status activity to have custom status messages displayed during execution. UiPath Assistant is minimized while the automation is running.
  • Switch between UiPath Orchestrator tenants by clicking the tenant switcher on the top right.
    :information-source: The tenant switch option is only available when using the base URL (e.g. https://cloud.uipath.com) as the Service URL.
10681068

The UiPath Products Group

In the Launchpad, you can find the UiPath Products Group, which contains the Task Capture Launcher and the option to submit an idea to Automation Hub. They can also be accessed from the menu right next to Home.

This section can be disabled from the Launchpad section in the Preferences menu of the UiPath Assistant, or from the Automation Ops governance policies.

18001800

📘

Note:

To disable Task Capture, open agent-settings.json and add disableTaskCapture: true below (and outside of the) user entry.

The Contextual Menu

The contextual menu searchsearch allows you to manage an automation. Going to the contextual menu and clicking on Delete personal automation removes the automation from both UiPath Assistant and Orchestrator's personal workspace feed. From here you can also use the Send to desktop feature to create a desktop shortcut which can be used to start the automation.

📘

Note:

When deleting an automation from your personal folder, it deletes the automation from the Orchestrator and leaves the package in place.

Automation Details

The Automation Details submenu provides the following:

  • Automation Name and Description - these are based on details provided in Studio when the automation was created.
  • Input Arguments can be found under the Customize section and are used to configure automations that make use of input arguments. If an Input Argument is mandatory, it's marked by an asterisk * next to its name. The following value types are supported: Int32, String, Boolean, and DateTime. For more information, see Configure Input Arguments.
    History - shows the execution history for an automation. Clicking on an event displays additional details.
15191519
  • The Run in PiP toggle is inherited from the project settings in Studio. If an automation is set to Start in PiP in Studio, the toggle is enabled. Changing it from the UiPath Assistant overwrites the setting from Studio.
  • Keyboard shortcut - provides you with the option to set a keyboard shortcut that starts the automation.
11241124

Your Robot

To make the Robot more human, you can give it an identity by choosing a picture and a name. This is done when you open the UiPath Assistant for the very first time, but can be changed at any time by clicking on the Robot next to the search bar and hovering over it displays the name.

732732

The Reminders Tab

The Reminders tab enables you to create a reminder for your automation. You can specify the time, date, and recurrence to receive a notification that will remind you to start the execution. A reminder can be set for any automation available in the Automation List section.

10391039

Automations for which reminders are set appear on the Reminders tab. Then, a notification is displayed as scheduled, to remind you to start the automation. Please note that an automation doesn't start without your consent. You can snooze the reminder for 10 minutes, dismiss it, or start the automation.

Updated 6 days ago


About UiPath Assistant


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.