UiPath Studio

UiPath Studio 指南

用户界面

UiPath Studio 包含多个面板,便于您更轻松地访问特定功能。这些面板可以停靠,充当浮动窗口,也可以下拉列表中启用“自动隐藏”选项。

功能区

The ribbon is straightforward and can be minimized or expanded by clicking the Minimize / Expand button minimize_expand. It consists of the following three tabs:

  1. Home - Start a new project from predefined templates or open a project you recently worked on. Projects can be pinned or removed from the Open Recent list, while hover over them displays the entire project Description. By default, projects are created in C:\Users\<current_user>\Documents\UiPath. The Open a Local Project button searches for project.json files.

Note:

若将 Studio 更新到 v2018.3 以上版本,系统将会重置“打开最近的项目”项目列表。

  1. 设计 - 向项目中添加序列、流程图和状态机,安装和管理活动包,与用户界面元素构建交互,将工作流导出到 Excel,然后将您的工作发布到 OrcheStrator 或自定义订阅源。请记住,除非您安装 UiPath.UIAutomation.Activities 包,否则“功能区”中将不会显示“向导”和“用户界面探测器”
  1. Debug - debug your workflow, while using debugging tools to set breakpoints, monitor the execution of activities step by step, and adjust the debugging speed. Open logs to view details regarding execution and any changes made to the project. For more information on debugging, check the About Debugging page.

Note:

不是在执行自动化项目期间创建的文件在发布到 Orchestrator 之后将变为只读文件。如果您的业务流程要求您在某个时候写入特定的文件,请确保在设计项目时创建该文件。

工具选项卡

The Tools tab can be used for installing extensions for Chrome, Firefox, Edge, Java, Silverlight, Citrix, and Windows Remote Desktop, and for launching the UI Explorer and Project Dependencies Mass Update Tool. For more information on extensions, check the About Extensions page.

The Project Dependencies Mass Update Tool is also located under the Tools tab, offering a user-interface tool for updating dependencies versions on multiple projects at once, located locally or in remote source control repositories.

设置选项卡

The Settings tab has options for changing the interface language, theme, setting global preferences, and managing activity feeds.

常规

“常规”子部分中含有相应选项,可通过选取以下其中一种可用语言来更改 Studio 和机器人的界面语言:“英语”、“日语”、“法语”、“俄语”、“中文简体”、“德语”、“西班牙语”、“西班牙语(拉美)”、“葡萄牙语(葡萄牙)”、“葡萄牙语(巴西)”、“韩语”或“土耳其语”

The Studio interface theme can be changed from the drop-down menu, by choosing either Light or Dark theme, and restarting Studio for the changes to apply.

Studio 在计算机上检测到“高对比度”并在重启时切换为此模式。

Note:

为正常使用“深色”主题,自动化项目必须至少具有 UiPath.System.Activities v18.4.2 和 UiPath.UIAutomation.Activities v18.4.1 依赖项。

The Reset Settings button reverts all General and Design settings in Studio to their default state. However, please note that it has no effect on feeds or favorite activities.

Aside from this, the following settings are reverted to their default state:

  • The list of Recent files;
  • “收藏夹”中的活动列表;
  • Studio 布局调整;
  • The Break on Exceptions option in the Execute tab > Options;
  • Show Activities options and pinned activities in the Activities panel;
  • User-added folders in the Snippets panel, the last directory where you opened a project from, and the Update Channel, which is switched to Stable.

设计

这一子部分中包含一组全局设置,它们会应用到此版本的 Studio 中打开的所有项目。

保存并发布

The Auto backup interval allows you to set a regular interval at which projects are automatically backed up. This is useful for restoring the last saved copy of the workflow. The default value is set at 30,000 milliseconds. The minimum value is 10,000 milliseconds, while the maximum one is 9,999,999 ms.

“发布项目超时”可设置发布项目的超时值。默认值为 30 秒。最大超时为 999,999 秒,最小值为 1 秒。

您可通过“打开项目行为”下拉列表,选择重新打开项目时默认打开哪些文件。选择“保存上一次打开的选项卡”、“打开主入口点”或“无选项卡”

The Enforce Analyzer before Publish toggle allows or restricts publishing of projects with Workflow Analyzer errors.

The Enforce Analyzer before Run toggle allows or restricts running projects with Workflow Analyzer errors.

When the Enforce Check-In before Publish option is enabled, publishing to source control repositories is not allowed if the project has local changes.

执行

“输出控制台大小”可设置“输出”面板中显示的单个会话中的行数,最多可显示 9,999 行。默认值为 2,000 行。可添加的最大值为 9,999 行,最小值在为 1 行。

The Run/Debug Default Behavior option allows you to configure the default action for the Run/Debug ribbon button. Pick from Debug File, Run File, Debug Project, or Run Project.

“运行时最小化”可用于将 Studio 在运行项目时最大化或最小化窗口显示。

活动设计样式

“创建固定注释”切换开关用于为项目中的活动创建固定或浮动注释。

位置

若要更改创建项目的默认位置,只需在“项目路径”框中添加新路径。

“发布库 URL”框可用于添加一个默认位置,选择自定义订阅源选项时所有库将发布到这个位置。

“发布流程 URL”的工作方式相同,但仅适用于流程。您可以通过它提供一个默认路径,在选择自定义订阅源选项时流程将发布到这个路径。

管理源

从 Studio 后台视图管理活动包订阅源,而不必打开项目。此选择与“管理包”窗口中的类似,允许您调整各个项目的订阅源。

Note:

默认情况下启用“本地”活动订阅源。如果机器人连接到 Orchestrator,则也启用“Orchestrator”订阅源。

许可证和配置文件

Use this tab to activate a Community or Enterprise license, or license Studio through Orchestrator. Read more about Licensing Studio.

此外,您还可在 Studio 和 StudioX 配置文件之间进行切换。

Team

Enable or disable Source Control plugins, read more about Version Control.

Labs

The Labs tab is available with a Community license only. This section holds features marked as Experimental that are still under development and may cause breaking changes before they're fully released. UiPath does not support backward compatibility for Experimental features.

From the Labs tab, you can enable or disable the Objects Browser.

帮助选项卡

The Help tab directs you to product documentation, release notes, online resources, the Community Forum and the RPA Academy.

有关产品版本和安装、许可可用性、更新通道和设备 ID 的信息也可以在“帮助”页面中找到,还有一个“复制信息”按钮,用于将详细信息快速复制到剪贴板。

The ribbon hosts a shortcut with Help links, accessible through the icon illustrated below:

发送反馈

There are two types of feedback that you can send directly from within Studio: Submit an idea for the product or Report a bug. Both are accessible from the ribbon by clicking the send_feedback icon.

The Send Feedback feature must be used only for sending anonymous feedback to the product team. To contact our tech support team, please use the Contact Technical Support form.

From the I want to drop-down menu pick either Submit an idea for the product or Report a bug. Pick either UiPath Activities, UiPath Studio, UiPath Robot, UiPath Orchestrator or UiPath Assistant from the drop-down menu under the For section.

Add a severity to your request by picking from Nice to have, Important, or Critical from the drop-down menu. In the Subject field, add a short title.

Add a detailed description and attach up to 6 images, videos, or text files, each with a size smaller than 10MB. The threshold for sending feedback is 3 posts in a timeframe of 5 minutes.

命令面板

The Command Palette is opened by using the Ctrl + Shift + P, F3 keyboard shortcuts, or by clicking the search button. It incorporates the Add activity, the Universal search, the Go to file, and Jump to activity search bars.

Note:

Studio supports prioritizing activities by scope. Click the plus_icon icon inside an activity scope and notice that the Command Palette offers suggestions of activities which fit the current scope. Support for this feature is rolling out in stages in official activities packages, check release notes periodically.

添加活动

使用 Ctrl + Shift + T 键盘快捷键即可打开“添加活动”搜索栏。您可以在已安装的包中搜索活动,并将其添加到文件中选定的活动之后。该搜索栏会向前五个结果自动分配键盘快捷方式,并记住之前的搜索结果。

Click the plus_icon icon at the top or bottom of an activity from a sequence to open the Add activity search bar.

通用搜索

“通用搜索”栏可用于查找当前项目中的代码片段、活动、项目依赖项和文件。

选项
快捷方式
描述

当前文件

Ctrl + 1

列出当前打开的文件中与搜索查询相匹配的结果。

所有文件

Ctrl + 2

列出当前项目的所有文件中与搜索查询相匹配的结果。

活动

Ctrl + 3

Lists results from activities that match the search query.

变量

Ctrl + 4

查找当前项目中与搜索查询相匹配的变量。

参数

Ctrl + 5

查找项目中定义的与搜索查询相匹配的参数。

导入

Ctrl + 6

在项目中查找与搜索查询相匹配的已导入命名空间。

项目文件

Ctrl + 7

查找当前项目中与搜索查询相匹配的文件。

依赖项

Ctrl + 8

列出安装到项目的依赖项中的查询结果。

代码片段

Ctrl + 9

查找与搜索查询匹配的代码片段文件。

若使用“通用搜索”或“添加活动”,系统会在您下一次打开搜索栏之前一直保留搜索结果。若使用“转到文件”和“跳转到活动”,则不会保留之前的搜索查询。

双击活动或按 Enter 键,将活动添加至当前打开的文件。通过使用相同命令,您可以打开“所有文件”或“项目文件”类别下的文件,或聚焦所需的搜索结果。

Default values of arguments from a process inside the Invoke Workflow activity are not searchable with the Universal Search.

转到文件

“转到文件”栏用于搜索及打开当前项目文件夹中的文件。.xaml 文件将在 Studio 的“设计器”面板中打开,其他文件(例如屏幕截图或 Excel 文件)则由计算机上的对应默认应用程序打开。双击或按 Enter 键即可打开文件。

Note:

“活动”、“项目”面板和“命令面板”支持模糊搜索。这表示,即使搜索词并不完全匹配,系统也会返回结果列表。搜索词可能仅缺失一小部分、出现拼写错误或仅包含每个词的首字母。例如,如果在“活动”栏键入 dci,系统将返回“双击图像”活动。

跳转到活动

The Jump to activity search bar part of Command Palette helps find and focus specific activities in large workflows. It is accessed by using the Ctrl + J keyboard shortcut, or by opening using the F3 or Ctrl + Shift + P shortcuts, and selecting Jump to activity.

打开后,“跳转到活动”栏将显示“设计器”面板中目前聚焦的 .xaml 文件内的完整活动列表。

键入活动的显示名称或命名空间,例如“分配”。使用键盘箭头选择该活动,并按 Enter 键以在“设计器”面板中将它设为焦点。

在“跳转到活动”栏中,活动依以下顺序排列:容器、父活动和子活动。

The Panels

设计器面板

The Designer panel displays your current automation project, enables you to make changes to it, and provides quick access to variables, arguments and imports.

It is possible to navigate within a diagram by double-clicking the activity you want to view. The path is displayed as breadcrumbs in the header of the Designer panel. Please note that when using multiple displays scaled differently the text in the input field part of some activities might be improperly shown.

您可使用 Ctrl + C 快捷键或上下文菜单将活动复制到文本编辑器、对其作出更改,然后复制回“设计器”面板中。

Activate Pan Mode by clicking the pan_mode icon, holding the Space key or pressing the middle mouse button. Use the zoom drop-down to change the zoom level and click the reset_zoom icon to reset it back to 100%.

The Fit to Screen fit_screen icon changes the zoom in such a way that the whole workflow fits in the Designer panel. Click the overview icon to get an overview of the whole project and navigate through sections by adjusting the focus.

上下文菜单

上下文菜单用于在工作流上执行多个操作,无论是序列还是流程图。可以通过右击工作流中的某个活动来显示上下文菜单。

Note

如果选择更多个活动,那么不会显示任何菜单。

上下文菜单的字段描述

选项
描述

查看父项

在“设计器”面板中显示目标活动的父项。
注意:只有在“设计器”面板中打开子活动时,才会对子活动显示此选项。

Open

在“设计器”面板中打开选定的活动。结果与双击相同。

折叠

Collapses the activity thus reducing the displayed details to "Double-click to view". You can achieve the same result by clicking the Collapse button **Collapse**.
Note: Only displayed for sequences.

原地展开

Expands the content of the activity, displaying its detailed content. You can achieve the same result by clicking the Expand button **Expand**.
Note: Only displayed for sequences.

剪切

删除选定的活动,并将其放在剪贴板上。

复制

Copies the selected activity and places it onto the Clipboard. Activities from read-only files can be copied to another workflow or a .txt file. When copying multiple activities to clipboard, their order is reversed.

粘贴

在当前位置插入剪贴板的内容。

Delete

删除目标活动。

注意:由于只有选择了单个活动时才会显示“上下文”菜单,因此您可以通过对应的键盘快捷方式 Delete 对更多个活动使用此命令。

us

添加、编辑、删除、显示和隐藏添加到工作流中的活动的批注。

复制为图像

生成“设计器”面板中所显示内容的屏幕截图。

注意:如果您想要创建一个子活动的屏幕截图,请确保首先在“设计器”面板中打开该子活动。

保存为图像

生成“设计器”面板中所显示内容的屏幕截图,并提示用户设置详细信息以便保存(名称、类型和目标位置)。支持的格式:JPG、PNG、GIF 和 XPS。

创建变量

在“变量”面板中创建一个变量。

自动排列

在流程图中自动安排活动。

删除围绕的序列

从“设计器”面板中删除选定的“序列”活动。其包含的活动将移入父级序列。

用“Try Catch” (Ctrl+T)包围

Inserts the activity in a Try Catch statement.

注意:“Try Catch 异常处理”语句用于处理由数据或编程错误引起的异常。“Try”子句包括要检查异常的活动。“Catch”子句是异常处理程序。无论前两个子句的状态如何,“Finally”子句都用于执行活动。

提取为工作流

创建包含目标活动的新工作流,目的是将大型项目分解为较小的项目。在提取活动的位置上,将创建一个“调用”<“新”>“工作流”活动,用于从新创建的工作流中编辑和导入参数。这些参数从该活动中使用的变量自动创建而成。“调用”<“新”>“工作流”活动自动映射本地变量,以调用所提取工作流的参数。

打开工作流

打开使用上述选项创建的工作流。

启用活动

启用以前禁用的活动。

禁用活动

禁用一个活动,然后将该活动放置在“注释掉”活动中。

切换断点

将选定的活动标记为断点以进行调试。也可以通过单击“执行”选项卡中的“断点”按钮来切换断点。一次可以为一个活动触发一个断点。

编辑断点设置

打开“断点设置”窗口。

运行至此活动

调试项目并在执行此特定活动之前停止调试。

从此活动运行

从此活动开始调试。

显示所有条件

显示项目中定义的所有条件(“属性”面板>“条件”)。

注意:仅当您在项目中右击空白空间时才会对流程图显示该选项;如果您在流程图中右击某个活动,那么不会显示该选项。

隐藏所有条件

隐藏显示的所有条件。

注意:仅当您在项目中右击空白空间时才会对流程图显示该选项;如果您在流程图中右击某个活动,那么不会显示该选项。

设置为开始节点

将选定的活动与“开始”节点连接起来。
注意:仅对流程图显示。

设置为初始状态

将“状态机”专用活动与“开始”节点连接起来。
注意:仅对状态机显示。

还会对“设计器”面板中的选项卡显示上下文菜单。可用的选项如下:

选项
描述

关闭

关闭活动选项卡。

关闭其他

关闭除活动选项卡之外的所有选项卡。

关闭所有文档

关闭所有选项卡。

浮动

取消停靠目标选项卡并将其更改为浮动状态。

固定选项卡

将目标选项卡固定到“设计器”面板中。
注意:固定到最后的选项卡总是移动到所有其他现有选项卡的前面(无论是否固定)。固定选项卡的位置只能相对于其他固定选项卡进行更改。

新建水平选项卡组

水平分割屏幕,使您能够在同一屏幕中看到“设计器”面板的两个或多个实例。目标项目被移到右侧的面板。
注意:只有当项目包含两个或更多个选项卡以及隐含的工作流时,才会显示该面板。

新建垂直选项卡组

垂直分割屏幕,使您能够在同一屏幕中看到“设计器”面板的两个或多个实例。目标项目被移到底部的面板上。
注意:只有当项目包含两个或更多个选项卡以及隐含的工作流时,才会显示该面板。

移至上一个选项卡组

将目标选项卡移到显示的上一个“设计器”面板上。
注意:只有以前使用过“新建垂直选项卡组”或“新建水平选项卡组”选项时才会显示该面板。

移至下一个选项卡组

将目标选项卡移到显示的下一个“设计器”面板上。
注意:只有以前使用过“新建垂直选项卡组”或“新建水平选项卡组”选项时才会显示该面板。

活动面板

The Activities panel shows available activities that can be added to the current workflow. Use the search box to find activities, navigate through them using navigation keys and press Enter to add an activity to the currently opened file.

“显示活动”按钮可打开一个选项列表,其中的选项可用于显示收藏的、最近使用的、可用的和兼容的活动。“固定收藏夹”选项可用于使收藏的活动在面板中始终保持可见。

To group activities by packages they belong to click the View Options button and select Group by Packages. They are now grouped in the Activities panel.

将鼠标悬停在面板中的活动上方,即可显示该活动所属的包及其工具提示。

Right-click an activity in the panel and select Create Test Bench to test out one or more activities before adding them to a project. Read more about this here.

Note:

无论 Studio 中设置了哪种界面语言,搜索框都可以按类名称来查找活动。

代码片段面板

“代码片段”面板使您可以轻松地重复使用自动化。默认情况下,它包括多个示例和代码片段。

要添加自己的示例和代码段,可以单击“添加文件夹”按钮并从硬盘驱动器中选择一个目录。不会显示空文件夹。

要删除某个文件夹,请右击该文件夹并选择“删除”。

项目面板

“项目”面板可用于查看当前项目的内容,添加文件夹,打开文件位置,管理依赖项,以及调整项目设置。

Copy and paste files from File Explorer directly into the Project panel. The same can be done using drag and drop on one or multiple files, including .xaml workflows. Using Ctrl + C and Ctrl + V shortcuts you can also copy a file and duplicate it anywhere in the tree.

选项
描述

全部展开expand_all

展开自动化项目中的所有节点。

全部折叠collapse_all

折叠自动化项目中的所有节点。

刷新刷新

刷新项目。

显示所有文件show_files

显示从属于自动化项目的所有文件,包括 project.json

文件资源管理器file_explorer

打开项目在计算机上的位置。

项目设置project_settings

打开流程或库的“项目设置”窗口。

删除未使用的屏幕截图remove_screenshots

删除运行自动化项目时未使用的屏幕截图。

项目的上下文菜单

右键单击“项目”面板中的任意位置即可打开上下文菜单,其中包含以下选项:

选项
描述

打开项目文件夹

打开包含项目的本地文件夹。

项目设置

打开用于调整屏幕首选项的“项目设置”窗口。

添加

Opens a list of items that can be added to the project: folder, sequence, flowchart, state machine or global handler.

导入工作流

.xaml 文件导入到项目中,如果文件名与主文件的名称一致,则会在文件名中添加“导入”。

Import Files

Opens the File Explorer window for importing various files into your project.

添加到来源控件

Adds the current project to source control using Git Init, Copy to Git, Add to TFS, or Add to SVN options. Please note that this option is only visible when right-clicking the project node.

Open

使用默认程序打开所选文件。

打开文件位置

打开包含该文件的本地文件夹。

重命名

用于重命名选定的文件或文件夹,并打开“重命名项目”窗口。系统随即会在此项目出现的所有位置处将其重命名。

Delete

仅会从本地计算机中删除选定的项目。

选择进行比较

选择当前文件以进行比较。

与选定项比较

Compares the current file with the previously selected file using Compare Files.

运行

运行选定的 .xaml 文件。

设置为“主要”

Sets the selected .xaml file as Main in the project definition, meaning that the project execution starts with that file. There can only be one Main project file.

设为私有或公共

将库中包含的工作流设置为公共或私有。发布后,公共工作流可在“活动”面板中使用。

属性

打开库的“属性”窗口,以添加工具提示和“帮助链接”。

设置为全局处理程序

.xaml 文件设置为项目的“全局异常处理程序”。这适用于每个项目/流程的工作流。

删除处理程序

.xaml 文件中删除“全局异常处理程序”标签。

属性面板

“属性”面板包含上下文,用于查看和更改所选活动的属性。在同一工作流中选择两个活动时,可以从“属性”面板中修改公共属性。

The Expression Editor

The Expression Editor is accessible with the Ctrl + Shift + E keyboard shortcut when used inside activity input fields. It is also available from the Properties panel, from fields that require inputting text, and from the body of an activity, by adding text directly in the required fields.

Expressions can be written on multiples lines. Keyboard shortcuts for creating variables and arguments directly in expressions are available.

Use Ctrl + F inside the editor to open the search and replace capabilities. Select part of an expression and press Ctrl + F3 to add the text to the search field. Hold the Ctrl key to make the search pane semi-transparent and see the text behind it.

大纲面板

“大纲”面板显示项目层次结构、所有可用变量和节点。您可以通过在“设计器”面板中选择活动来高亮显示该面板中的活动,也可以通过在“大纲”面板中选择活动来切换到特定的活动。

输出面板

“输出”面板使您能够显示“日志消息”或“写入行”活动的输出等内容。此面板中也会显示包的例外情况。

在“输出”面板中,通过单击面板标题中的按钮,可以显示或隐藏具有不同日志级别(错误、警告)的消息。双击消息会显示关于此消息的更多详细信息,并包含用于复制信息的选项。

在“输出”面板中搜索日志并在搜索结果列表中选择项目时,相应日志将会高亮显示。

“导出日志”按钮用于将日志导出至 .txt 文件。该按钮还会导出时间戳和错误消息详情。此外还可导出筛选后的日志。例如,若想仅导出 Trace 级日志,您可筛选列表,然后使用“导出日志”按钮。

调试时,“输出”面板将显示日志,表示活动开始执行时间,直至结束的时间。您可通过“调试”选项卡中的“日志活动”选项启用此功能。

The Error List panel displays errors found in the file or project during the validation process, together with errors generated by About Workflow Analyzer rules.

“全部清除”按钮会擦除“输出”面板中显示的所有信息。在运行工作流时,将擦除此面板中存储的日志和其他数据。“输出”面板一次最多显示 2,000 行。

The Find References Panel

Note:

The Find References panel is available only with a Community license.

The Find References panel in Studio searches for file references, selector, and object references in your project. Right-click on a file in the Project panel and select Find References to view if the file is referenced anywhere in the project. Use the UI Objects Browser to find selector references.

The Orchestrator Resources Panel

The Orchestrator Resources panel in Studio can load assets, queues and processes, provided that the Robot is connected to Orchestrator. Read the Connecting Robots to Orchestrator page to find the steps.

If the Robot connected to Orchestrator is of type Standard, then the Orchestrator Resources panel can display only the Classic folder which has this Robot provisioned.

如果是浮动型机器人,则面板将显示该机器人可访问的所有传统文件夹和新式文件夹。如要详细了解如何在 Orchestrator 中创建机器人,请参阅此处

The panel displays assets, queues, and processes found in Classic or Modern Folders in Orchestrator. Read more about Folders.

Note:

When using a classic, manually provisioned robot, it must be granted View permissions for the corresponding resources (i.e. Assets, Queues, and Processes) to appear in the panel. Read more about setting up Roles and permissions in Orchestrator.

要将资源加载到面板中,请单击 Studio 状态栏中的“刷新”按钮。单击箭头旁边的文本,即可在文件夹之间切换,如上图所示。

Hover over the text in the status bar to see the Orchestrator URL and the name of the current folder. Right-click on any item in the Orchestrator Resources panel to copy its name and use it in activities that interact with such resources.

Note:

Logs generated from processes located in subfolders are visible in Orchestrator only if the subfolder is selected in the Orchestrator Resources panel.

Updated 2 months ago



用户界面


Suggested Edits are limited on API Reference Pages

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