Robot
2022.10
false
Banner background image
Robot User Guide
Last updated May 13, 2024

About UiPath Assistant

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. The interface can be customized to better suit the person behind it by choosing an avatar and a name for the robot, organizing processes 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 processes 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 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 Process Execution icons:

Tray

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

Taskbar

  • docs image - Simple Assistant
  • docs image - Running Process.
  • docs image - Running Process in PIP.

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 - when a Robot exists and is licensed.
  • 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.

Installing UiPath Assistant

The UiPath Assistant is available for both Windows and macOS machines. Here's how you install it:

Installing on Windows

On Windows machines, UiPath Assistant comes bundled with the UiPathStudio.msi installer. You can install is using the wizard, or by command line when installing the robot. The application can be deployed in user mode or in service mode.

Use the following command to install UiPath Assistant:

UiPathStudio.msi ADDLOCAL=Robot /QUiPathStudio.msi ADDLOCAL=Robot,RegisterService /QUiPathStudio.msi ADDLOCAL=Robot /QUiPathStudio.msi ADDLOCAL=Robot,RegisterService /Q

Installing on Mac

The UiPath Assistant is available for macOS machines as a .dmg file for both Intel or Apple Silicon devices.

Installation steps:

  1. Download the .dmg file from the Featured Download section in the Automation Cloud Resource Center
    • Download for Intel Macs - x64
    • Download for Apple Silicon
  2. Double-click the DMG file to make its content available.
  3. Drag the application from the DMG window into the Applications directory to install it.
  4. Wait for the copy process to finish.



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 processes to provide easier access to them. You can drag and drop them to arrange them and create sections as shown below. The right side also displays the Process Details when used.

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

When you have the Automation Store Widget deployed, the search functionality also returns related ideas that are part of Automation Hub, but not deployed in the Automation Store.



The UiPath Assistant is split into the following tabs:

The Home Page Tab

The Home Page tab enables you to:

  • View all the available automation processes:
    • If UiPath Assistant is connected to Orchestrator, processes from the environments and folders the Robot is a part of are displayed. Hovering over a process displays its name, version and folder.
    • If UiPath Assistant is not connected to Orchestrator, processes from the %ProgramData%\UiPath\Packages folder are displayed. The Packages folder can be specified, as explained on this page.
  • Download processes that have a newer version available, or that need to be downloaded and unpacked locally, and view the installation status.
  • Add or remove a process from the Launchpad, click the contextual menu and then select "Pin to Launchpad" or simply drag and drop the process from the left panel to the Launchpad.
  • View all currently running foreground and background processes.
  • Pause, resume, or stop a process. The Pause button can be disabled for a process from the Studio Process Settings window. Once a process is started, the execution status is displayed. You can use the Report Status activity to have custom status messages displayed during execution.



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.



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

The Reminders Tab

The Reminders tab enables you to specify a time or period for you to receive a notification for starting a process. For any process available in the Process List section, a reminder can be set.



Processes for which reminders are set, appear on the Reminders tab and a notification is displayed once a process is about to start. Please note that a process does not start without your consent. You can snooze the reminder for 10 minutes, dismiss it, or start the process.

The Contextual Menu

The contextual menu allows you to manage a process. Going to the contextual menu and clicking on Delete personal process removes the process 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 process.

Note: When deleting a process from your personal folder, it deletes the process from the Orchestrator and leaves the package in place.

Process Details

The Process Details submenu provides the following:

  • Process Name and Description - these are based on details provided in Studio when the process was created
  • Input Arguments used to configure processes that make use of input arguments. If an Input Argument is mandatory, it is marked by an asterisk * next to its name.

    History - shows the execution history for a process, clicking on an event displays additional details.



  • The Start in PiP toggle is inherited from the project settings in Studio. If a process 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 process.


Connections in UiPath Assistant

Connections can be used directly from the UiPath Assistant by accessing the Process Details menu.

If a process already has connections set up, the user can select it from the list. Otherwise, they can create a new one from the same menu.

If a connection has multiple accounts tied to it, you can select a specific one from the drop-down.



Your Robot

To make the Robot more human, you can give it an identity by choosing an 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.



Signing In to Your Account

  1. Click the Sign in button from the main window or click docs image to open the Preferences menu, then click Sign In.
  2. 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.
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.
Note:
  • 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.
  • 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.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.