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

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

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

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

📘

注:

Studio の組み込みルールを旧バージョンの 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:

• 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 - ルール番号です。

ルールの管理

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

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

ルールは、範囲と操作でフィルター処理することができます。各ルールの横にあるチェックボックスをオフにして、プロジェクトに固有の設定を定義します。既定では、ルールはウィンドウ内でコード順に並べられていますが、有効なルールは最初に表示されます。

範囲

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

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

操作

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

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

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

既定値にリセット

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

検証

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

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

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

Double-clicking an item in the Error List panel opens the .xaml and highlights the element which threw the error, whether it's an activity, argument, or variable.

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

エラーの管理

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

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

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

[エラー リスト] パネルには、ルール違反のほか、ワークフロー分析の実行中に発生する可能性のあるエラーも表示されます。ワークフロー アナライザーまたは設定されたルールのいずれかが実行に失敗すると、エラーがログに記録され、エラーの原因の詳細が [説明] に表示されます。

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

★削除★ 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 using the Community Edition installer (.exe), the default path is %LocalAppData%\UiPath\[Studio_version]\ です。

ルールの設定

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.

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

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

以下のワークフロー アナライザーのコマンドを使用できます。

• 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.

ワークフロー アナライザーのコマンドでは以下の引数を使用できます。

For example, the command UiPath.Studio.CommandLine.exe analyze-file -p "C:\BlankProcess\Main.xaml" analyzes only one file in a project, Main.xaml. The output of the command returns a json-encoded dictionary with the following information for each rule violation:

• FilePath: 分析されるファイルへのパスです。
• ErrorCode: ルールの ID です。
• ActivityDisplayName: The display name of the activity (null if not applicable).
• Item - エラー メッセージが生成された項目 (アクティビティや変数など) の名前と種類。
• 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.

To return the exit code of the command, execute echo %errorlevel% after you run it. If there are no messages with the ErrorSeverity Error, the code 0 is returned. Otherwise, 1 is returned.

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) は実行ごとに生成され、現在の結果にのみ適用されます。

実行またはパブリッシュ前のワークフロー アナライザーの実行

ワークフロー アナライザーのエラーが含まれるプロジェクトを実行および/またはパブリッシュできないようにするには、Studio の Backstage ビュー > [設定] > [デザイン] から以下のオプションを有効化します。

• Enforce Analyzer before Run - Whenever running/debugging a file or project is initiated, the Workflow Analyzer checks all the rules with the Error action and execution is allowed only if no errors are found.
• Enforce Analyzer before Publish - Whenever publishing is initiated, the Workflow Analyzer checks all enabled rules regardless of their action and publishing is allowed only if there are no rule violations with the action Error です。

When Enforce Analyzer before Publish is enabled, if publishing is successful (there are no rule violations with the action Error) the results of the workflow analysis are included in the published .nupkg package in the file project_analysis_results.json located in \lib\net45\.analysis\. The file contains the following information about each enabled rule:

• RuleId - ルールの ID です。
• RuleName - ルールの名前です。
• Parameters - ルール内のカスタマイズ可能なパラメーターです (該当する場合)。
• ErrorsDescription - ルールによって生成されるエラー メッセージのリストです (該当する場合)。