TestingOptions.CompareDocuments クラス

このクラスを使用すると、ドキュメントをコード化されたオートメーション API「 ComparePdfDocuments 」で比較するためのオプションを設定できます。

定義

名前空間: UiPath.Testing.API.Models

アセンブリ: UiPath.Testing.Activities.API (in UiPath.Testing.Activities.Api.dll)

構文

public class TestingOptions : CompareDocuments

コンストラクター

public TestingOptions.CompareDocuments()

TestingOptions.CompareDocuments : TestingOptions.CompareDocuments クラスの新しいインスタンスを初期化します。

プロパティ

AdditionalOutputFilePath string : 追加の出力ファイルへのパスです。OutputDiffTypeが PDF の場合は設定する必要があります。

ContinueOnError Boolean : メソッドが例外をスローした場合でも、オートメーションを継続するかどうかを指定します。このパラメーターでは Boolean 値 ( true や falseなど) のみがサポートされています。既定値は [ falseです。そのため、パラメーターが空白でエラーが発生すると、プロジェクトの実行が停止します。値を trueに設定すると、プロジェクトの実行はエラーに関係なく継続されます。

GenerateSemanticResult Boolean 値:^AutopilotTM が提供する AI 機能を使用して検証を実行し、差分を意味的に解釈します。これにより、意味的差分を含む追加の結果が生成されます。

注:

Semantic の結果の種類では、登録しているライセンス プランに応じて、コード化されたオートメーション API の実行ごとに次のいずれかが消費されます。

• Flex ライセンス プランの場合、[ セマンティック ] の結果の種類では 1 AI ユニットが消費されます。
• ユニファイド プライシング ライセンス プランの場合、 セマンティック の結果の種類では 1 プラットフォーム ユニットが消費されます。 消費について詳しくは、「テスト アクティビティ パッケージについて」をご覧ください。

IgnoreIdenticalItems ブール値: Trueに設定すると、比較時に同一の項目が無視されます。これは、ウォーターマークやヘッダーなどの静的オブジェクトを比較するときに便利です。既定では Trueに設定されています。

IgnoreWidgetsLocation ブール値 : Trueに設定すると、比較対象のドキュメント内の画像または URL の場所が無視されます。既定では Falseに設定されています。

IncludeWidgets Boolean の場合: Trueに設定すると、画像と URL も比較されます。既定では Trueに設定されています。

OutputDiffType DocumentOutputDiffType : ドキュメント間の差分を返すために使用する型です。

OutputFilePath String : ベース ドキュメントの出力パスです。

Rules List<ComparisonRule> : 適用するルールのリスト。RegexRule型またはWildcardRule型のいずれかです。

WordSeparators string : 比較時に単語の区切り文字と見なされるようにするオブジェクト (文字列) です。たとえば、比較対象のドキュメントで単語を区切るためにピリオド . またはバックスラッシュ / を使用する場合は、これらを単語の区切り文字として定義できます。

メソッド

これらは、ドキュメント比較オプションを設定するために使用できる方法です。

WithContinueOnError

メソッドが例外をスローした場合でもオートメーションを継続するかどうかを設定します。

定義

名前空間: UiPath.Testing.API.Models

アセンブリ: UiPath.Testing.Activities.API (in UiPath.Testing.Activities.Api.dll)

WithContinueOnError(bool)

WithIgnoreRegexRule(
    bool continueOnError
)

continueOnError Boolean : メソッドが例外をスローした場合でも、オートメーションを継続するかどうかを指定します。このパラメーターでは Boolean 値 (true、 false) のみがサポートされています。既定値は [ falseです。そのため、パラメーターが空白でエラーが発生すると、プロジェクトの実行が停止します。値を trueに設定すると、プロジェクトの実行はエラーに関係なく継続されます。

WithGenerateHtml

2 つのドキュメントまたはテキスト間で特定された差分を強調表示した HTML ファイルを生成します。

定義

名前空間: UiPath.Testing.API.Models

アセンブリ: UiPath.Testing.Activities.API (in UiPath.Testing.Activities.Api.dll)

WithGenerateHtml(string)

WithGenerateHtml(
    string filePath
)

filePath 文字列 : ドキュメントまたはテキストを比較するときに識別された差分を格納する HTML ファイルのパス。

WithGeneratePDF

ベースライン ドキュメントとの比較に使用される、ベースライン ドキュメントとターゲット ドキュメントの両方の差分が強調表示された新しい PDF ファイルを生成します。

定義

名前空間: UiPath.Testing.API.Models

アセンブリ: UiPath.Testing.Activities.API (in UiPath.Testing.Activities.Api.dll)

WithGeneratePDF(string, string)

WithGeneratePDF(
    string baselinePath,
    string targetPath
)

baselinePath文字列 : 特定された差分を強調表示した PDF ファイルを保存するベースライン ドキュメントの新しいパスです。

targetPath文字列 : 特定された差分を強調表示した PDF ファイルを保存するターゲット ドキュメントの新しいパスです。

WithGenerateSemanticResult

Autopilot^TM が提供する AI 機能を使用して検証を実行し、差分を意味的に解釈します。これにより、意味的差分を含む追加の結果が生成されます。

注:

Semantic の結果の種類では、登録しているライセンス プランに応じて、コード化されたオートメーション API の実行ごとに次のいずれかが消費されます。

• Flex ライセンス プランの場合、[ セマンティック ] の結果の種類では 1 AI ユニットが消費されます。
• ユニファイド プライシング ライセンス プランの場合、 セマンティック の結果の種類では 1 プラットフォーム ユニットが消費されます。 消費について詳しくは、「テスト アクティビティ パッケージについて」をご覧ください。

定義

名前空間: UiPath.Testing.API.Models

アセンブリ: UiPath.Testing.Activities.API (in UiPath.Testing.Activities.Api.dll)

WithGenerateSemanticResult(bool)

WithGenerateSemanticResult(
    bool generateSemanticResult = false
)

generateSemanticResult ブール値: trueに設定すると、AI 機能を使用して検証が実行されます。既定では falseに設定されています。

戻り値

SemanticDifferences

AI 機能を使用して実行された検証プロセスの結果です。

WithIgnoreIdenticalItems

true に設定すると、比較時に同一の行が無視されます。これは、特にウォーターマークやヘッダーなどの静的オブジェクトを比較するときに便利です。

定義

名前空間: UiPath.Testing.API.Models

アセンブリ: UiPath.Testing.Activities.API (in UiPath.Testing.Activities.Api.dll)

WithIgnoreIdenticalItems(bool)

CompareDocumentsOptions WithIgnoreIdenticalItems<CompareDocumentsOptions>( 
    bool ignoreIdenticalItems = true
)

ignoreIdenticalItems Boolean : 同一の項目を比較時に無視するかどうかを指定します。既定では、このパラメーターは [ trueに設定されています。

WithIgnoreWidgetsPageAndPosition

true に設定すると、画像または URL の位置とページが無視されます。

定義

名前空間: UiPath.Testing.API.Models

アセンブリ: UiPath.Testing.Activities.API (in UiPath.Testing.Activities.Api.dll)

WithIgnoreWidgetsPageAndPosition(this, bool)

WithIgnoreWidgetsPageAndPosition(
    bool ignoreWidgetsPageAndPosition = false
)

ignoreWidgetsPageAndPosition ブール値 : trueに設定すると、画像または URL の位置とページが無視されます。既定では、このパラメーターの値は falseです。

WithIgnoreRegexRule

True に設定すると、Rules パラメーターに設定した正規表現ルールがすべて無視されます。これにより、比較するテキストまたはドキュメントの特定の部分を除外できます。

定義

名前空間: UiPath.Testing.API.Models

アセンブリ: UiPath.Testing.Activities.API (in UiPath.Testing.Activities.Api.dll)

WithIgnoreRegexRule(string, string, [bool])

WithIgnoreRegexRule(
    string ruleName,
    string regexPattern,
    [bool usePlaceholders = true]
)

ruleName 文字列 : Rulesのリストで設定した、比較時に無視するルールの名前です。

regexPattern文字列 : 前に入力したruleNameを表す実際の正規表現です。

usePlaceholder Boolean (任意) : True に設定すると、ドキュメントまたはテキストの無視される部分がプレースホルダー値に置き換えられます。プレースホルダー値は ruleNameです。既定では、このパラメーターは [ trueに設定されています。

WithIgnoreWildcardRule

True に設定すると、Rules パラメーターに設定したワイルド カード ルールがすべて無視されます。これにより、比較するテキストまたはドキュメントの特定の部分を除外できます。

定義

名前空間: UiPath.Testing.API.Models

アセンブリ: UiPath.Testing.Activities.API (in UiPath.Testing.Activities.Api.dll)

WithIgnoreWildcardRule(string, string, bool)

WithIgnoreWildcardRule(
    string ruleName,
    string wildcardPattern,
    [bool usePlaceholder = true]
)

ruleName 文字列 : Rulesのリストで設定した、比較時に無視するルールの名前です。

wildcardPattern 文字列 : 前に入力した ruleName を表す実際のワイルドカードです。

usePlaceholder Boolean (任意) : True に設定すると、ドキュメントまたはテキストの無視される部分がプレースホルダー値に置き換えられます。プレースホルダー値は ruleNameです。既定では、このパラメーターは [ trueに設定されています。

WithIncludeWidgets

比較時に画像と URL を含めます。このメソッドを True に設定すると、ドキュメントとテキストの等価性を検証するときに、画像と URL も比較されます。

定義

名前空間: UiPath.Testing.API.Models

アセンブリ: UiPath.Testing.Activities.API (in UiPath.Testing.Activities.Api.dll)

WithIncludeWidgets(bool)

WithIncludeWidgets(
    bool includeWidgets
)

includeWidgets ブール値 : Trueに設定すると、コード化されたオートメーション API はドキュメントとテキストの等価性を検証するときに、画像と URL も比較します。

WithWordSeparators

単語の区切り文字として定義する文字を指定します。文字は文字列に保存される必要があります。

定義

名前空間: UiPath.Testing.API.Models

アセンブリ: UiPath.Testing.Activities.API (in UiPath.Testing.Activities.Api.dll)

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)

wordSeparators 文字列 : 単語の区切り文字と見なす文字を含む文字列です。