UiPath.Studio.Activities.Api.Analyzer.Rules

このセクションでは、 UiPath.Studio.Activities.Api.Analyzer.Rules を使用してアクティビティを構築する方法について詳しく説明します。

ActivityMessage

ワークフロー アナライザーのエラーをトリガーしたアクティビティを示すメッセージです。

継承

InspectionMessage > ActivityMessage

プロパティ

入力	名前	備考
string	アクティビティ ID	メッセージに関連するアクティビティの ID です。
string	ActivityDisplayName	アクティビティの表示名です。
IMemberModel	SourceMember	オプション 結果のソースです (変数やプロパティなど)。

AnalyzerInspector

ルールとカウンターの基本クラスを表します。

継承

プロパティ

入力	名前	備考
string	名前	[ワークフロー アナライザーの設定] ウィンドウに表示されるルール/カウンターの名前です。
string	ID	ルール/カウンターの ID は一意である必要があります。 https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/ に類似した表記を使用します。
IDictionary<string, IParameter>	パラメーター	ユーザーが設定できるパラメーターのコレクションです。
Bool	DefaultIsEnabled	true の場合、ルールは既定で有効化されます。Studio 2019.10.3 以降が必要です。
string	DocumentationLink	WFA 設定ウィンドウでクリックできるリンク。 Studio v2019.10.3 以降が必要です。
List<string>	ApplicableScopes	このルールを適用するターゲットの設定です。いくつかの例については、「 RuleConstants 」を参照してください。v2020.4 以降の Studio が必要です。

カウンター

カウンター定義のインターフェイス。

継承

AnalyzerInspector > Counter

コンストラクター

public Counter(string counterName, string counterId)

入力	名前	備考
string	counterName	[ワークフロー アナライザーの設定] ウィンドウに表示される名前です。
string	counterId	カウンターの ID は一意である必要があります。

Counter <T>

特定の検査オブジェクトに適用されるカウンターです。

継承

AnalyzerInspector > Counter > Counter<T>

一般型 T

このカウンターの適用対象を定義する IInspectionObject です。

コンストラクター

public Rule(string ruleName, string ruleId, Func<T, Rule, InspectionResult> inspectionFunction)

入力	名前	備考
string	counterName	カウンターの名前です。
string	counterId	カウンターの ID は一意である必要があります。
Func<IReadOnlyCollection<T>, Counter, InspectionResult>	inspectionFunction	検査対象のオブジェクトと、ユーザーが設定したカウンターを受け取り、 InspectionResult を返す必要がある関数。

InspectionMessage

InspectionResult.InspectionMessagesのメッセージ。

プロパティ

入力	名前	備考
string	メッセージ	表示するメッセージです。 Studio v2019.10.3 以降が必要です。

InspectionResult

検査結果です。

継承

IResult > InspectionResult

プロパティ

入力	名前	備考
Bool	HasErrors
ICollection<string>	Messages	より詳細なメッセージについては、 InspectionMessage を使用してください。
ICollection<InspectionMessage>	InspectionMessages	より優れた、スケーラブルな、詳細なメッセージ。特殊な型 (ActivityMessage) を使用できます。Studio 2019.10.3 以降が必要です。
string	RecommendationMessage	この結果に対する推奨事項。
トレース レベル	ErrorLevel	この結果のエラー レベルです。
string	DocumentationLink	この結果のドキュメントのリンクです。

IParameter

ルールまたはカウンター パラメーターの外観を定義します。

継承

プロパティ

入力	名前	備考
string	キー	このルールのこのパラメーターの一意のキーです。
string	LocalizedDisplayName	現在のローカライズされた表示名です。
string	値 (Value)	このパラメーターのユーザーからの値です。
string	ConstraintRegex	値の制約正規表現。 Studio v2019.10.2 以降が必要です。
Bool	DefaultValue	このパラメーターの既定値です。 Studio v2019.10.2 以降が必要です。

パラメーター

IParameter の簡単な実装です。

継承

IParameter > Parameter

プロパティ

入力	名前	備考
string	キー	このルールのこのパラメーターの一意のキーです。
string	LocalizedDisplayName	現在のローカライズされた表示名です。
string	値 (Value)	このパラメーターのユーザーからの値です。
string	ConstraintRegex	値の制約正規表現。 Studio v2019.10.2 以降が必要です。
Bool	DefaultValue	このパラメーターの既定値です。 Studio v2019.10.2 以降が必要です。

ProjectMessage

注:

この機能は UiPath.Studio.Activities.Api v20.4 で導入されました。

ワークフロー アナライザーのエラーをトリガーしたパッケージの依存関係です。

継承

InspectionMessage > ProjectMessage

プロパティ

入力	名前	備考
IDependency	依存関係	オプション エラーを伴う依存関係。

ルール

ルール定義のインターフェイスです。

継承

AnalyzerInspector > Rule

コンストラクター

パブリック ルール (文字列ルール名、文字列ルール ID)

入力	名前	備考
string	ruleName	[ワークフロー アナライザーの設定] ウィンドウに表示される名前です。
string	ルール ID	ルールの ID は一意である必要があります。

プロパティ

入力	名前	備考
トレース レベル	ErrorLevel	このルールに設定できるエラー レベルです。 効果的なエラー レベルを読み取る場合は、実行時にのみ使用します。 ルールを定義する際にはこの設定をしないでください。 代わりに DefaultErrorLevel を使用してください。
トレース レベル	DefaultErrorLevel	このルールの既定のエラー レベルです。 Studio v2019.10.2 以降が必要です。
string	RecommendationMessage	設定可能な推奨事項のメッセージ。

Rule <T>

特定の検査オブジェクトに適用されるルールです。

継承

AnalyzerInspector > Rule > Rule<T>

一般型 T

この規則の適用先を定義する IInspectionObject 。

コンストラクター

public Rule(string ruleName, string ruleId, Func<T, Rule, InspectionResult> inspectionFunction)

入力	名前	備考
string	ruleName	[ワークフロー アナライザーの設定] ウィンドウに表示される名前です。
string	ルール ID	ルールの ID は一意である必要があります。
Func<T, Rule, InspectionResult>	inspectionFunction	検査対象のオブジェクトと、ユーザーが設定したルールを受け取り、 InspectionResult を返す必要がある関数。

RuleConstants

注:

この機能は UiPath.Studio.Activities.Api v20.4 で導入されました。

ルールの適用先となる Studio プロファイルを定義します。

定数

入力	名前	備考
string	DevelopmentRuleConstant	Studio に適用されるルールを表します。
string	BusinessRuleConstant	StudioX に適用されるルールを表します。
string	TestAutomationRuleConstant	Studio Pro に適用されるルールを表します。

WorkflowMessage

注:

この機能は UiPath.Studio.Activities.Api v20.4 で導入されました。

ワークフローが分析されるときに返されるメッセージです。

継承

InspectionMessage > WorkflowMessage

プロパティ

入力	名前	備考
IMemberModel	SourceMember	オプション 結果のソースです。
string	表示名	オプション メッセージを生成したアクティビティの表示名です。