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.

首次启动 Assistant 时，系统会为您提供交互式导览，带您浏览其中的主要功能。这始终可以从“首选项”菜单的“帮助”版块重新启动。

作为机器人的客户端，该应用程序可根据用户输入发送命令，启动或停止作业以及更改设置。

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.

在安装过程中，您可以选择以用户模式或服务模式部署机器人，以更好地适应您的环境。如需了解详情，请参阅根据部署文档。

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:

托盘

• - 已建立连接。
• - 未连接。
• - when an error is encountered, such as the UiPath^® Robot service being stopped.
• - 有新的或未读的通知时。

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

注意：要对连接错误进行故障排除，请单击错误说明中的链接，或阅读连接错误文档。

任务栏

• - 空闲状态的 Assistant
• - 正在运行流程。
• - 正在 PIP 中运行流程。

界面

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

• 左侧面板包含“主页”、“提醒”和“UiPath Marketplace”选项卡。

• 右侧面板也称为“启动台”，其中显示您的收藏流程以供即时访问。此外，右侧面板还会显示已在左侧面板中选择的自动化的详细信息。

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.

“主页”选项卡

“主页”选项卡用于：

• 查看所有可用的自动化：
  • 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).

• 更新具有可用新版本的自动化。
• 将自动化添加到启动台，方法是单击上下文菜单，然后选择“添加到收藏夹”，或者只需将自动化从左侧面板拖放到启动台即可。
• 查看目前正在运行的所有前台和后台流程。
• 暂停、恢复或停止流程。可通过“Studio 流程设置”窗口禁用流程的“暂停”按钮。启动自动化后，系统将显示执行状态。您可以使用“报告状态”活动在执行期间显示自定义状态消息。

提醒选项卡

“提醒”选项卡用于指定接收自动化启动通知的时间或周期。

您可以在“主页”选项卡中为任何自动化设置提醒。

带提醒的自动化将在“提醒”选项卡下列出，并且在自动化设置为开始之前会弹出通知。自动化需要得到您的批准才能启动。您可以将提醒推迟 10 分钟，将其关闭或开始流程。

自动化详细信息

正在下载包

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.

信息

• 自动化名称、说明、包版本和发布文件夹 - 在创建流程期间从 Studio 中提供的信息中派生的详细信息。如果自动化与特定概念相关联，则可以在说明下方找到 Automation Hub 的 URL。可以通过 Studio 中的“项目设置”填写 Automation Hub URL。

• 将链接复制到自动化 - 提供指向自动化的可共享链接，仅具有必要权限的用户可以访问。

• “输入参数”用于配置使用输入参数的流程。如果输入参数是必需的，则其名称旁边会显示星号 *。
• 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.
• 键盘快捷键 - 提供了用于设置启动流程的键盘快捷键的选项。

历史

显示所选自动化的作业历史记录，以及作业状态和时间戳。单击条目将显示作业详细信息，例如计算机名称、错误消息或输出值（如果适用）。

正在运行/最近的作业

显示正在运行的自动化正在进行的步骤。

使用工作流中的“报告状态”活动配置自动化步骤。该操作使您可以更好地了解自动化的运行方式以及完成每个步骤所需的时间。

注意：在 Studio 中配置消息时，可以将状态消息拆分为多行。为此，请使用 Environment.NewLine 或 vbNewLine 作为状态消息文本的行分隔符。

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.

“更多操作”菜单

“更多操作”菜单 用于管理自动化：

• Click on Delete personal automation to remove the automation from both UiPath^® Assistant and Orchestrator's personal workspace feed.
  注意：从您的个人文件夹中删除流程时，它会从 Orchestrator 中删除该流程并将软件包保留在原位。
• 单击“创建桌面快捷方式”，以直接从桌面启动自动化。
• 单击“添加至收藏夹”，将自动化添加到启动台的“收藏夹”部分。
• 单击“将链接复制到自动化”以创建一个链接，访问该链接时，将打开该自动化的 Assistant。您也可以通过在“自动化详细信息”面板中单击自动化名称旁边的“共享”按钮来执行此操作。此按钮仅对安装在共享文件夹中的自动化可见。

  您可以通过 Automation Ops 策略控制此功能。确保选择 23.4.0 版本的策略模板。

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 启动器
• Assisted Task Mining 启动器
• Studio Web
• 向 Automation Hub 提交概念

注意：Assisted Task Mining 启动器仅适用于 Automation Cloud 许可证。

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:

在 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

在 Mac 上安装

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

安装步骤：

1. 从 Automation Cloud 资源中心的“精选下载”部分下载 .dmg 文件
   • 适用于 Intel Mac - x64 的下载
   • 适用于 Apple 处理器的下载
2. 双击 DMG 文件以使其内容可用。
3. 将应用程序从 DMG 窗口拖动到应用程序目录中以进行安装。
4. 等待复制过程完成。

登录到您的帐户

1. 单击主窗口中的“登录”按钮，或单击 打开“首选项”菜单，然后单击“登录”。
2. 将打开一个新的浏览器窗口。根据您的身份验证方法，您可以使用用户名和密码登录，也可以使用可用的身份验证提供程序之一登录。

登录时，将根据默认服务 URL https://cloud.uipath.com 进行身份验证。有关使用交互式登录的更多信息，请参阅交互式登录文档。

备注：

• 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.
• 如果您的组织使用访问策略定义了受信任的 IP 范围，并且您的 IP 不在此范围内，系统将提示您以下错误消息：UiPath Robot Error. Response status code does not indicate success: 403 (Forbidden)。请参阅有关按 IP 限制访问的更多信息。

Connections in UiPath^® Assistant

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

如果某个流程已建立连接，则用户可以从列表中选择。否则，他们可以从同一菜单创建一个新连接。

如果一个连接绑定了多个帐户，可以从下拉列表中选择一个特定帐户。