UiPath Studio

UiPath Studio ガイド

Workflow Analyzer について

Workflow Analyzer is a static code analyzer that ensures your project meets high quality and reliability standards. A static code analyzer checks for inconsistencies without actually executing the project, as opposed to dynamic analyzers which step in during execution.

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.

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

Studio には、一連のルールがあらかじめ組み込まれています。これらのルールはプレフィックス ST- によって見分けることができます。UIAutomation.Activities もプレフィックス UI- によって識別可能な独自のルールを備えています。

ルール命名規則

各ルールには、ID、名前、説明、および推奨事項があります。ID には、発生元、カテゴリ、および番号が含まれます。たとえば、変数命名規則には次の ST-NMG-001 ID があります。

ルールの管理

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

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

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

範囲

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

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

アクション

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

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

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

既定値にリセット

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

検証

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

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

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

[エラーリスト] パネルの項目をダブルクリックすると、.xaml が開き、エラーをスローしたアクティビティが強調表示されます。

すべての .xaml ファイルが検証されない限り、プロジェクトはデバッグ、実行、またはパブリッシュできません。ブレークポイント条件は評価されません。

エラーの管理

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

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

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

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

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

UiPath.Studio.CommandLine.exe コマンドラインユーザーインターフェイスには、CI/CD パイプライン構成であっても、特定のルールに対してファイルまたはプロジェクトをチェックするための一連のパラメーターが含まれています。

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

  • Studio の Windows インストーラー (.msi) バージョンの場合、既定のパスは C:\Program Files (x86)\UiPath\Studio\ です。
  • ユーザー モード (.exe) でインストールされている Studio の既定のパスは %LocalAppData%\UiPath\[Studio_version]\ になります。

ルールの構成

Studio をインストールする際に、既定ではすべての Workflow Analyzer ルールが有効になります。Studio から直接ルールを設定します。

  • [Workflow Analyzer の設定] ウィンドウで、各ルールの横にあるチェックボックスをクリックしてルールを有効または無効化します。
  • RuleConfig.json ファイルから、パス %LocalAppData%\UiPath\Rules。特定のルールを見つけ、そのパラメーターを変更し、IsEnabled パラメーターを false に変更してルールを無効化します。

ルールは Workflow Analyzer の設定にも表示される、一意の ID に基づいて整理されます。

たとえば、以下の図では、変数命名規則ルールのみが有効化されており、正規表現式 ([A-Z]) を受け取っています。これは、変数名が大文字でなければならないことを意味します。この例では、他のすべてのルールが無効化されています。

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

ルールを構成したら、UiPath.Studio.CommandLine.exe コマンドラインユーザーインターフェイスにアクセスします。

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

  • analyze - プロジェクト全体を分析します。project.json ファイルへのパスが必要です。
  • analyze-file - 単一のファイルを分析します。.xaml ファイルへのパスが必要です。

上記の例では、次のコマンド analyze -p "C:\Users\username\Documents\UiPath\BlankProcess\Main.xaml" は、1 つの .xaml ファイルで変数名が大文字であるかどうかを確認します。

上記のコマンドの出力は、次の種類の情報を含む .json エンコードされた辞書を返します。

  • ErrorCode: ルールの ID です。
  • ErrorSeverity: DefaultAction パラメーターの値です。これは、各ルールに対して設定されたログ メッセージであり、Warning、Error、Info、または Verbose のいずれかです。
  • Description: ルールの説明です。
  • Recommendation および URL: 問題を解決するために推奨される変更と、詳細情報が記載されたドキュメントへのリンクです。
  • FilePath: 分析されるファイルへのパスです。

一部のエントリはルールに関連付けられていない場合がありますが、Workflow Analyzer によって生成されたエラーである可能性があることに留意してください。たとえば、空の . xaml ファイルの場合には、エラーが表示されます。

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

2 か月前に更新



Workflow Analyzer について


改善の提案は、API 参照ページでは制限されています

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