订阅

UiPath Studio

UiPath Studio 指南

关于工作流分析器

工作流分析器是一种静态代码分析器,可确保您的项目符合高质量和可靠性标准。静态代码分析器可在不实际执行项目的情况下检查不一致问题,这与在执行期间介入的动态分析器不同。

Workflow Analyzer uses a set of rules to check for various inconsistencies unrelated to project execution. The rules are based on Automation Best Practices and take into consideration variable and argument naming, empty sequences or workflows, package restrictions, and so on. The analyzer does not identify errors in execution or compilation.

其位于“设计”功能区选项卡中,分别是“分析文件”和“分析项目”按钮。“分析文件”会对“设计器”面板中设为当前焦点的文件执行分析,而“分析项目”则对自动化项目中的所有文件执行分析。

Studio comes with a set of built-in rules, identifiable by the ST- prefix. The UIAutomation.Activities, Excel.Activities, Testing Activities, and Mail.Activities also have their own rules, identifiable by the prefix.

📘

Note:

Studio 内置规则无法移植到较旧的 Studio 版本,但来自兼容活动包的规则可以在工作流分析器随附的较旧 Studio 版本中使用。

规则命名惯例

Each rule has an ID, name, description, and recommendation. The ID contains the origin, category, and number. For example, Variables Naming Convention has the ST-NMG-001 ID:

管理规则

项目或文件的分析基于“项目设置”窗口中的一组规则:

  • In the Project panel, click the settings_iconsettings_icon icon, then select Workflow Analyzer.
  • 在功能区中,单击“分析文件”按钮,然后从下拉列表中选择“工作流分析器设置”

可以按作用域和操作筛选规则。取消选中每个规则旁边的复选框,即可定义特定于项目的配置。默认情况下,规则按窗口中的代码排列,系统将会首先显示已启用的规则。

范围

每个规则都有一个适用的作用域:

  • Activity: The rules are enforced at activity level, checking variables, arguments, properties. Variables Naming Convention is one such rule.
  • Workflow: Rules perform checks in a single project file, for example Unused Variables.
  • “项目”:在项目级别执行检查。

Action

规则包含许多可设置的操作:

  • “Error”:在“错误列表”面板中生成错误。
  • “Warning”:在“错误列表”面板中生成警告。
  • “Info”:在“错误列表”面板中生成消息。
  • “Verbose”:创建大型日志文件。

Check the Logging Levels page to learn more about logging with Studio.

重置为默认值

对规则的默认值(正则表达式或阈值)作出任何更改后,可以通过右键单击规则,然后选择“重置为默认值”来将值恢复为默认值。

验证

只要触发“工作流分析器”,系统便对文件或项目执行验证。验证选项位于“分析文件”功能区按钮中,分别是“验证文件”和“验证项目”

此操作检查变量、参数、表达式和导入是否已正确配置。可使用 F8 快捷键触发“验证文件”操作,使用 Shift + F8 触发“验证项目”操作。可随时取消验证。

系统会在“项目”面板中以红点标记包含错误的文件,并在“错误列表”和“输出”面板中显示错误信息。

双击“错误列表”面板中的项目将打开 .xaml 并突出显示引发错误的元素,无论是活动、参数还是变量。

除非所有 .xaml 文件都经过验证,否则无法调试、执行或发布项目。不评估断点条件。

管理错误

经触发后,“工作流分析器”会使用配置的规则集检查项目或文件,并根据规则操作在“错误列表”面板中记录发现的错误。

在“错误列表”面板中,您可以按“错误”、“警告”和“消息”筛选项目。您可以使用“作用域”下拉菜单,按项目、当前文件或自动化中的特定文件筛选错误。此外,还可按规则 ID 筛选项目。

单击发现的警告或错误,以显示规则建议和每个规则的文档页面链接。

除了违反规则外,“错误列表”面板还显示在执行工作流分析时可能发生的错误。当“工作流分析器”或已配置的规则之一无法运行时,将记录错误,并在描述中详细说明错误原因。

命令行支持

UiPath.Studio.CommandLine.exe 命令行用户界面包含一组参数,用于根据特定规则检查文件或项目,即使在 CI/CD 管道配置中也是如此。

UiPath.Studio.CommandLine.exe 位于安装文件夹中:

  • 对于 Windows 安装程序 (.msi) 版 Studio,默认路径是 C:\Program Files\UiPath\Studio\
  • 对于使用社区版安装程序(.exe)安装的 Studio,默认路径为 %LocalAppData%\UiPath\[Studio_version]\

配置规则

默认情况下,安装 Studio 时会启用所有工作流分析器规则,但以下情况除外:

您可以配置规则:

  • 在“工作流分析器设置”窗口中,通过单击每个规则旁边的复选框来启用或禁用规则。
  • From the RuleConfig.json file, path %LocalAppData%\UiPath\Rules. Find a specific rule, modify its parameter, change the IsEnabled parameter to false to disable the rule. Optionally, if the path is not accessible, you can place the RuleConfig.json file in a custom location and include the path to the file in the command. For more information, see Analyze Files and Projects.

系统会按规则的唯一 ID 对其进行整理,并且会在“工作流分析器设置”中显示这些规则。

For example, in the image below only the Variables Naming Convention rule was enabled and received the ([A-Z]) Regex expression. This means that variable names must be uppercase. All the other rules were disabled in this example.

分析文件和项目

配置完规则后,请访问 UiPath.Studio.CommandLine.exe 命令行用户界面。

以下工作流分析器命令可用:

  • analyze - 分析整个项目。必须提供 project.json 文件的路径。
  • analyze-file - 分析单个文件。必须提供 .xaml 文件的路径。

以下参数可用于工作流分析器命令:

Argument

Description

-p, --project-path

For analyzing one file, provide the path to the .xaml. For analyzing the entire project, specify the path to the project.json file.

-c, --config-path

Path to the RuleConfig.json file. Specify this path only if the rule configuration file is not placed in the default location (%LocalAppData%\UiPath\Rules).

--help

View the arguments available for each command.

--version

Check the version of UiPath.Studio.CommandLine.exe.

例如,命令 UiPath.Studio.CommandLine.exe analyze-file -p "C:\BlankProcess\Main.xaml" 仅分析项目中的一个文件,即 Main.xaml。该命令的输出返回一个 json 编码的字典,其中包含针对每个违反规则的以下信息:

  • FilePath:所分析文件的路径。
  • ErrorCode:规则 ID。
  • ActivityDisplayName:活动的显示名称(如果不适用,则为 null)。
  • Item - 生成错误消息的项目的名称和类型(例如,活动或变量)。
  • ErrorSeverityDefaultAction 参数(为每个规则配置的日志消息)的值,即 Warning、Error、Info 或 Verbose。
  • Description:规则的说明。
  • RecommendationURL:为解决问题提供的更改建议,以及包含更多信息的文档链接。

如要使用放置在自定义位置的 RuleConfig.json 文件,请将位置添加到命令中。以上一个命令为例,要使用位于 C:\CustomFolder\RuleConfig.json 的文件配置规则,请运行命令,如下所示:UiPath.Studio.CommandLine.exe analyze-file -c "C:\CustomFolder\RuleConfig.json" -p "C:\BlankProcess\Main.xaml"

若要返回命令的退出代码,请在运行后执行 echo %errorlevel%。如果没有包含 ErrorSeverity 错误的消息,则将返回 0 代码。否则,将返回 1

请注意,有些条目可能与规则无关,而是“工作流分析器”生成的错误。例如,在 .xaml 文件为空的情况下,系统会显示错误。

用作条目前缀的全局唯一标识符 (GUID) 在每次运行时生成,并且仅应用于当前结果。

在运行或发布之前强制使用工作流分析器

通过启用“Studio 后台视图”>“设置”>“设计”中的以下选项,可以防止执行和/或发布包含工作流分析器错误的项目:

  • “运行前强制使用分析器”- 每当启动运行/调试文件或项目时,工作流分析器都会使用 Error 操作检查所有规则,并且只有在未发现错误的情况下才允许执行。
  • “在发布前强制使用分析器”- 每当发布启动时,工作流分析器都会检查所有启用的规则,无论它们采取何种操作,并且仅当操作 Error 不违反任何规则时才允许发布。

启用“发布前强制使用分析器”时,如果发布成功(Error 操作没有违反规则),工作流分析结果将包含在文件 project_analysis_results.json(位于 \lib\net45\.analysis\)中已发布的 .nupkg 包中。该文件包含有关每个已启用规则的下列信息:

  • RuleId - 规则 ID。
  • RuleName - 规则的名称。
  • Parameters - 规则中的可自定义参数(如果适用)。
  • ErrorsDescription - 规则生成的错误消息列表(如果适用)。

Updated 19 days ago


关于工作流分析器


建议的编辑仅限用于 API 参考页面

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