assistant
2024.10
false
- UiPath Assistant
- About UiPath Assistant
- Preferences
- Installing UiPath Assistant
- Configuring UiPath Assistant
- Assistant on MacOS
- Picture in picture
- Configuring attended automations
- Governance
- Widgets in Assistant
Assistant user guide
Last updated Sep 3, 2025
You can access the Preferences menu by selecting your user icon in the top-right corner of the Assistant window. The menu diplays:
- Your user name. Hover over your name to see a tooltip with the email address used for login.
- Tenant—The tenant where you are currently signed in. If you are a member of multiple tenants, you can switch to another tenant from the dropdown.
- Preferences—Opens the Preferences settings window.
- Help—Opens the Help section in the Preferences settings window.
- Sign out—Disconnects the robot from Orchestrator.
- Sign in—Connects the robot to Orchestrator.
- Quit—Closes Assistant.
Important: All running automations are stopped upon switching tenants, disconnecting, or signing out.
To access Assistant-related settings, navigate to the Preferences menu, then select Preferences.
The next windows displays the following settings options:
- General—Configure settings related to:
- Theme—Change the theme for Assistant.
- Zoom—Increase or decrease the size of the content in Assistant.
- Language—Change the interface language of Assistant and Studio.
- Automations—Decide how automations are displayed in the Dashboard panel:
- Group by folder organizes the automations in groups by Orchestrator folders.
- Focus the Jobs tab after an automation starts focuses on the running tab when an automation starts.
- Show in Windows Start Menu makes the automations from Dashboard accessible from the Windows Start Menu.
- System—Enable Automatically start Assistant with Windows to allow Assistant to launch at startup, in tray mode. A similar option exists for Assistant on MacOS. This setting is ignored when the Automatically Start Assistant with Windows option in the MSI installer is enabled during setup.
- EDR protection—The Crowdstrike EDR (Endpoint Detection Response) protection status of your robot machines is visible in this window. You can control the visibility of this message from the Automation Ops policies, by choosing the 22.10.0 or later policy template, or by adding this information in the policies.json file.
- Log Level—Select the level at which the Robot should log information. The following levels are available: Verbose, Trace, Information, Warning, Error, Critical, and Off. You can control if the users can change the log level from Assistant from Automation Ops.
- Keyboard Shortcuts—Configure for diverse automation-related commands, such as:
- Pause, resume, or stop an automation
- Run a specific automation
Note: In order to prevent stop/pause/resume actions that can affect multiple jobs at once, the keyboard shortcuts do not apply to background jobs. - Orchestrator Settings—Configure your connection to Orchestrator:
- Connection Type—Select the connection type to Orchestrator:
- Service URL asks you to provide the Orchestrator URL where you want to connect using Interactive Sign In.
- Client ID asks you to provide the Orchestrator URL where you want to connect using your Cliend ID and Client Secret.
- Machine Key asks you to provide the Orchestrator URL where you want to connect using your Machine Name and Machine Key. The machine name is automatically identified and filled in. The machine key is created once you provision the machine.
- Sign in—Initiates the authentication automation when Interactive Sign In is used.
- Sign out—Logs you out from Orchestrator and disconnects the Robot.
- Connect—Connects the Robot to Orchestrator when Cliend ID or Machine Key options are used.
- Disconnect—Disconnects the Robot from Orchestrator.
- Status—Informs you about the Robot connection to Orchestrator.
- Use Assistant in offline mode—Turn on to use Assistant in offline mode.
- Connection Type—Select the connection type to Orchestrator:
-
UiPath Products—Decide to show or hide launchers for the following products or features:
- Tools—Migrate the automations that are only available on your machine and publish them to your Personal Workspace in Orchestrator. When an automation is migrated to your Personal Workspace for the first time, a new folder is automatically created in the local feed location. This folder is later used to store all future automations that are migrated from the local feed to Orchestrator.
- Help—Quick access to the guided tour, documentation, feedback, build and runtime information, or starting the diagnostic tool.
