通知を受け取る

UiPath Studio

UiPath Studio ガイド

ワークフロー アナライザーについて

ワークフロー アナライザーは、プロジェクトが高品質と信頼性の基準を確実に満たせるようにする静的コード アナライザーです。静的コード アナライザーは、実行時にステップ インする動的アナライザーとは対照的に、プロジェクトを実際に実行せずに不整合がないかを確認します。

ワークフロー アナライザーは、プロジェクトの実行に関係のないさまざまな不整合を一連のルールを使用してチェックします。ルールはオートメーションのベスト プラクティスに基づいており、変数と引数の命名、空のシーケンスまたはワークフロー、パッケージの制限などが考慮されます。ワークフロー アナライザーは、実行時またはコンパイル時のエラーを区別しません。

11191119

[デザイン] リボン タブの [ファイルを分析] ボタンと [プロジェクトを分析] ボタンで使用できます。最初のボタンは、デザイナー パネルで現在フォーカスされているファイルを分析し、2 つ目のボタンは、オートメーション プロジェクトのすべてのファイルを分析します。

Studio comes with a set of built-in rules, identifiable by the ST- prefix. UIAutomation.Activities also has a set of its own rules, identifiable by the UI- prefix.

ルール命名規則

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:

  • ST - ルールが Studio に組み込まれていることを示します。
  • NMG - shows that the rule is part of the Naming Rules category. Rules part of Project Anatomy Rules category have the ANA abbreviation, those part of Design Best Practices the DBP, and so on.
  • 001 - ルール番号です。
808808

ルールの管理

プロジェクトまたはファイルは、[プロジェクト設定] ウィンドウで利用可能な一連のルールに基づいて分析されます。

  • [プロジェクト] パネルで settings_iconsettings_icon アイコンをクリックして ワークフロー アナライザー を選択します。
  • リボンで [ファイルの分析] ボタンをクリックして、ドロップダウンから [Workflow Analyzer の設定] を選択します。

ルールは、範囲と操作で絞り込むことができます。各ルールの横にあるチェックボックスをオフにして、プロジェクトに固有の構成を定義します。

10681068

範囲

各ルールには、適用される範囲があります。

  • アクティビティ: ルールはアクティビティレベルで適用され、変数、引数、プロパティをチェックします。変数命名規則は、そのようなルールです。
  • ワークフロー: ルールは、単一のプロジェクト ファイルでチェックを実行します (例: 未使用の変数)。
  • プロジェクト: チェックはプロジェクト レベルで実行されます。

操作

ルールには、設定可能な多くの操作があります。

  • エラー: [エラー リスト] パネルにエラーを生成します。
  • 警告: [エラー リスト] パネルに警告を生成します。
  • 情報: [エラー リスト] パネルにメッセージを生成します。
  • 冗長: 大きなログ ファイルを作成します。

Studio でのログの詳細については、「ログ レベル」ページをご覧ください。

既定値にリセット

正規表現やしきい値など、ルールの既定値に何らかの変更を加えた場合、それらのルールを右クリックして [既定値にリセット] を選択すれば、値を規定値に戻すことができます。

997997

検証

Workflow Analyzer がトリガーされるたびに、ファイルまたはプロジェクトの検証が行われます。検証オプションは [ファイルの分析] リボンボタン、検証ファイル検証プロジェクトで使用できます。

この操作は、変数、引数、式、およびインポートが適切に構成されているかどうかを確認します。ファイルの検証操作は F8 ショートカットを使用してトリガーすることができ、プロジェクトの検証操作は Shift + F8 を使用してトリガーできます。検証はいつでもキャンセルできます。

エラーを含むファイルは、[プロジェクト] パネルで赤い点でマークされ、エラーは [エラー リスト] パネルと [出力] パネルに表示されます。

Double-clicking an item in the Error List panel opens the .xaml and highlights the activity which threw the error.

Unless all .xaml files are validated, the project cannot be debugged, executed or published. Breakpoint conditions are not evaluated.

エラーの管理

トリガーされると、ワークフロー アナライザー はプロジェクトまたはファイルをチェックするように設定されたルールセットを使用し、ルールの操作に従って [エラー リスト] パネルに見つかったエラーを記録します。

10681068

[エラー リスト] パネルは項目をエラー警告メッセージごとに絞り込みます。範囲ドロップダウン メニューは、プロジェクト、現在のファイル、またはオートメーション内の特定のファイルごとにエラーを絞り込むのに役立ちます。さらに、項目はルール ID で絞り込むことができます。

11801180

見つかった警告またはエラーをクリックして、ルールの推奨事項と各ルールのドキュメントページへのリンクを表示します。

未解決の依存関係からのアクティビティを含むプロセスを検証または分析する際、[エラー リスト] パネルには、見つかったエラーとともに、推奨される対策およびドキュメントへのリンクが表示されます。

コマンドラインのサポート

★削除★ UiPath.Studio.CommandLine.exe command-line user interface contains a set of parameters for checking files or projects against certain rules, even in CI/CD pipeline configurations.

UiPath.Studio.CommandLine.exe は、インストール フォルダーにあります。

  • Studio の Windows インストーラー (.msi) バージョンの場合、既定のパスは次のとおりです: C:\Program Files (x86)\UiPath\Studio\
  • For Studio installed in User Mode (.exe), the default path is %LocalAppData%\UiPath\[Studio_version]\ です。

ルールの設定

Studio をインストールする際に、既定ではすべてのワークフロー アナライザーのルールが有効化されます。Studio から直接ルールを設定します。

  • [Workflow Analyzer の設定] ウィンドウで、各ルールの横にあるチェックボックスをクリックしてルールを有効または無効化します。
  • 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.

ルールは Workflow Analyzer の設定にも表示される、一意の 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.

625625

ファイルとプロジェクトの分析

After configuring the rules, access the UiPath.Studio.CommandLine.exe command-line user interface.

Workflow Analyzer コマンドは次のとおりです。

  • analyze - Analyzes the whole project. Requires the path to the project.json file.
  • analyze-file - Analyzes a single file. Requires the path to the .xaml file.

In the example above, the following command analyze -p "C:\Users\username\Documents\UiPath\BlankProcess\Main.xaml" checks if the variable names are uppercase in one .xaml file.

10991099

The output of the above command returns a .json encoded dictionary with the following type of information:

  • ErrorCode: ルールの ID です。
  • ErrorSeverity: The value of the DefaultAction parameter, which is the configured log message for each rule, either Warning, Error, Info or Verbose.
  • Description: ルールの説明です。
  • Recommendation and URL: The recommended changes for solving the issue, together with the documentation link with more information.
  • FilePath: 分析されるファイルへのパスです。

Please note that some of the entries may not be associated with a rule, but can be errors generated by the Workflow Analyzer. For example, in the case of an empty .xaml` file, an error is displayed.

エントリの接頭辞として使用されるグローバル一意識別子 (GUID) は実行ごとに生成され、現在の結果にのみ適用されます。

2 年前に更新


ワークフロー アナライザーについて


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。