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.

Additionally, if you run into any issues while using the Assistant, you can start the UiPath^® Diagnostic Tool from the error dialog box to gather data related to the error.

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

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

The Orchestrator connection status is also displayed in the UiPath^® Assistant next to the preferences menu.

Note: To troubleshoot connection errors, click on the link in the error description, or read the Connections Errors documentation.

Taskbar

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

Interface

The user interface of UiPath^® Assistant consists of mainly two panels:

• The left side panel contains the Home, Reminders, and Marketplace tabs.

• The right side panel, also referred to as "The Launchpad", displays your favorite processes for instant access. Additionally, the right side panel displays the details of the automation selected in the left side panel.

At the bottom, the UiPath^® Assistant houses the Robot Identity avatar and a search bar for finding processes. Depending on governance policies, search results can also include items from the Automation Store, Marketplace, or Studio Web templates.

The Home tab

The Home 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, processes from the %ProgramData%\UiPath\Packages folder are displayed. The Packages folder can be specified, as explained on this page.

• View all available Apps (from UiPath^® Apps).

• View all available Actions (from UiPath^® Action Center).

• Update automations that have a newer version available.
• Add an automation to the Launchpad, by clicking the contextual menu, and then selecting Add to favorites, or by simply dragging and dropping the automation from the left side 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 Reminders tab

The Reminders tab enables you to specify a time or period for you to receive a notification for starting an automation.

You can reminders for any automation in the Home tab.

Automations with reminders are listed under the Reminders tab and a notification pops up just before an automation is set to begin. Your approval is required for an automation to start. You can snooze the reminder for 10 minutes, dismiss it, or start the process.

Automation Details

Downloading the package

For automations marked with the Awaiting install status, UiPath^® Assistant first downloads the automation package. During this operation, the Automation details panel displays the size of the package and its dependencies.

Information

• Automation name, description, package version, and publication folder - details derived from the information provided in Studio during the creation of the process. If an automation is associated with a particular idea, the URL for the Automation Hub can be found under the description. The Automation Hub URL can be filled in via Project Settings in Studio.

• Copy link to automation - provides a shareable link to your automation, accessible only by users with the necessary permissions.

• 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.
• The Run 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.

History

Displays the job history for the selected automation, along with the job state and time stamp. Clicking on an entry displays the job details, such as machine name, error message, or output values (if applicable).

Running/Recent job

Displays the ongoing steps of a running automation.

The automation steps are configured using the Report Status activity in the workflow. This allows you to have a better view on how the automation runs and how long it takes for each step to complete.

Note: You can split a status message on multiple lines when configuring the message in Studio. For this, use Environment.NewLine or vbNewLine as a line separator for the status message text.

Once the execution of an automation ends, the run history details are kept until you click on Dismiss, start the process again, or quit and restart the UiPath^® Assistant. Additionally, the Running tab is renamed to Recent job.

The More actions menu

The More actions menu allows you to manage an automation:

• Click on Delete personal automation to remove the automation from both UiPath^® Assistant and Orchestrator's personal workspace feed.
  Note: When deleting a process from your personal folder, it deletes the process from the Orchestrator and leaves the package in place.
• Click Create desktop shortcut to start automations directly from your desktop.
• Click Add to favorites to add the automations to the Favorites section of the Launchpad.
• Click Copy link to automation to create a link that, when accessed, opens Assistant to that automation. You can also do this by clicking the Share button next to the automation name in the Automation details panel. This button is only visible for automations installed in shared folders.

  You can control this feature from the Automation Ops policy. Make sure you choose the 23.4.0 policy template.

The UiPath^® Products Group

In the launchpad, you can find the UiPath^® Products, which based on the governance policies applied can contain thefollowing products or features:

• Task Capture Launcher
• Assisted Task Mining launcher
• Studio Web
• Submit an idea to Automation Hub

Note: Assisted Task Mining launcher only works with an Automation Cloud license.

This section can be disabled from the Launchpad section in the Preferences menu of the UiPath^® Assistant.

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 /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.

Signing In to Your Account

1. Click the Sign in button from the main window or click 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.

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 dropdown menu.