TestingOptions.CompareDocuments-Klasse

Verwenden Sie diese Klasse, um Optionen für den Vergleich von Dokumenten mit der codierten Automatisierungs-API ComparisonPdfDocuments zu konfigurieren.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

Syntax

public class TestingOptions : CompareDocuments

Konstruktoren

public TestingOptions.CompareDocuments()

TestingOptions.CompareDocuments : Initialisiert eine neue Instanz der TestingOptions.CompareDocuments -Klasse.

Eigenschaften

AdditionalOutputFilePath Zeichenfolge : Pfad zur zusätzlichen Ausgabedatei. Muss festgelegt werden, wenn OutputDiffType PDF ist.

ContinueOnError Boolescher Wert : Gibt an, ob die Automatisierung auch dann fortgesetzt werden soll, wenn die Methode einen Fehler ausgibt. Dieser Parameter unterstützt nur boolesche Werte wie true oder false. Der Standardwert ist false. Wenn der Parameter leer ist und ein Fehler ausgelöst wird, wird die Ausführung des Projekts angehalten. Wenn der Wert auf true gesetzt ist, wird die Ausführung des Projekts ungeachtet eines Fehlers fortgesetzt.

GenerateSemanticResult Boolescher Wert : Führen Sie die Verifizierung mithilfe der KI-Funktionen durch, die Autopilot^TM bietet, um eine semantische Interpretation der Unterschiede zu erhalten. Dadurch wird ein zusätzliches Ergebnis mit den semantischen Unterschieden generiert.

Hinweis:

Je nach Lizenzierungsplan, für den Sie sich angemeldet haben, verbraucht der Ergebnistyp „Semantik“ für jede Ausführung der codierten Automatisierungs-API Folgendes:

• Für den Flex-Lizenzierungsplan verbraucht der Ergebnistyp Semantisch eine AI Unit.
• Beim Lizenzierungsplan Unified Pricing verbraucht der Ergebnistyp Semantik eine Plattformeinheit. Weitere Informationen zum Verbrauch finden Sie unter Über das Testing-Aktivitätspaket.

IgnoreIdenticalItems Boolean : Wenn auf True festgelegt, werden identische Elemente beim Vergleich ignoriert. Dies ist nützlich beim Vergleichen statischer Objekte wie Wasserzeichen oder Header. Standardmäßig auf True festgelegt.

IgnoreWidgetsLocation Boolescher Wert : Wenn auf True festgelegt, wird der Speicherort eines Bildes oder einer URL in den verglichenen Dokumenten ignoriert. Standardmäßig auf False festgelegt.

IncludeWidgets Boolescher Wert : Wenn auf True festgelegt, enthält der Vergleichsprozess auch Bilder und URLs. Standardmäßig auf True festgelegt.

OutputDiffType DocumentOutputDiffType : Der Typ, den Sie für die Rückgabe der Unterschiede zwischen den Dokumenten verwenden möchten.

OutputFilePath Zeichenfolge : Der Ausgabepfad des Basisdokuments.

Rules List<ComparisonRule> : Liste der anzuwendenden Regeln. Sie können vom Typ RegexRule oder WildcardRule sein.

WordSeparators String : Die Objekte, als Strings, die Sie im Vergleichsprozess als Worttrennzeichen berücksichtigen möchten. Wenn in den Dokumenten, die Sie vergleichen, beispielsweise häufig ein Punkt . oder umgekehrte Schrägstriche / zum Trennen von Wörtern verwendet werden, können Sie diese als Worttrennzeichen definieren.

Methoden

Mit diesen Methoden können Sie die Dokumentvergleichsoptionen konfigurieren.

WithContinueOnError

Konfigurieren Sie, ob die Automatisierung auch dann fortgesetzt werden soll, wenn die Methode einen Fehler ausgibt.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithContinueOnError(bool)

WithIgnoreRegexRule(
    bool continueOnError
)

continueOnError Boolescher Wert : Gibt an, ob die Automatisierung auch dann fortgesetzt werden soll, wenn die Methode einen Fehler ausgibt. Dieser Parameter unterstützt nur boolesche Werte (true, false). Der Standardwert ist false. Wenn der Parameter leer ist und ein Fehler ausgelöst wird, wird die Ausführung des Projekts angehalten. Wenn der Wert auf true gesetzt ist, wird die Ausführung des Projekts ungeachtet eines Fehlers fortgesetzt.

WithGenerateHtml

Generiert eine HTML-Datei mit den hervorgehobenen Unterschieden, die zwischen den beiden Dokumenten oder Texten identifiziert wurden.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithGenerateHtml(string)

WithGenerateHtml(
    string filePath
)

filePath String : Der Pfad der HTML-Datei, die die beim Vergleichen der Dokumente oder Texte identifizierten Unterschiede speichert.

WithGeneratePDF

Erstellt neue PDF-Dateien mit den hervorgehobenen Unterschieden sowohl für das Ausgangsdokument als auch für das Zieldokument, die zum Vergleich mit dem Ausgangsdokument verwendet werden.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithGeneratePDF(string, string)

WithGeneratePDF(
    string baselinePath,
    string targetPath
)

baselinePath String – Der neue Pfad des Basisdokuments, in dem Sie die PDF-Datei speichern möchten, in der die identifizierten Unterschiede hervorgehoben wurden.

targetPath Zeichenfolge : Der neue Pfad des Zieldokuments, in dem Sie die PDF-Datei speichern möchten, in der die identifizierten Unterschiede hervorgehoben wurden.

WithGenerateSemanticResult

Führen Sie die Überprüfung mithilfe der KI-Funktionen durch, die Autopilot^TM bietet, um eine semantische Interpretation der Unterschiede zu erhalten. Dadurch wird ein zusätzliches Ergebnis mit den semantischen Unterschieden generiert.

Hinweis:

Je nach Lizenzierungsplan, für den Sie sich angemeldet haben, verbraucht der Ergebnistyp „Semantik“ für jede Ausführung der codierten Automatisierungs-API Folgendes:

• Für den Flex-Lizenzierungsplan verbraucht der Ergebnistyp Semantisch eine AI Unit.
• Beim Lizenzierungsplan Unified Pricing verbraucht der Ergebnistyp Semantik eine Plattformeinheit. Weitere Informationen zum Verbrauch finden Sie unter Über das Testing-Aktivitätspaket.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithGenerateSemanticResult(bool)

WithGenerateSemanticResult(
    bool generateSemanticResult = false
)

generateSemanticResult Boolescher Wert : Wenn auf true festgelegt, wird die Überprüfung mithilfe von KI-Funktionen durchgeführt. Standardmäßig auf false festgelegt.

Rückgabewert

SemanticDifferences

Das Ergebnis des Verifizierungsprozesses, der mit KI-Funktionen durchgeführt wird.

WithIgnoreIdenticalItems

Wenn auf True festgelegt, werden identische Zeilen beim Vergleich ignoriert. Dies ist insbesondere beim Vergleichen statischer Objekte wie Wasserzeichen oder Header nützlich.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithIgnoreIdenticalItems(bool)

CompareDocumentsOptions WithIgnoreIdenticalItems<CompareDocumentsOptions>( 
    bool ignoreIdenticalItems = true
)

ignoreIdenticalItems Boolescher Wert : Gibt an, ob identische Elemente beim Vergleich ignoriert werden sollen. Standardmäßig ist dieser Parameter auf true festgelegt.

WithIgnoreWidgetsPageAndPosition

Bei „true“ werden die Position und Seite eines Bildes oder einer URL ignoriert.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithIgnoreWidgetsPageAndPosition(this, bool)

WithIgnoreWidgetsPageAndPosition(
    bool ignoreWidgetsPageAndPosition = false
)

ignoreWidgetsPageAndPosition Boolescher Wert : Wenn auf true festgelegt, werden Position und Seite eines Bildes oder einer URL ignoriert. Standardmäßig ist der Wert des Parameters false.

WithIgnoreRegexRule

Wenn auf True festgelegt, wird jede Regex-Regel ignoriert, die Sie für den Parameter Rules konfiguriert haben. Auf diese Weise können Sie bestimmte Teile der Texte oder Dokumente ausschließen, die Sie vergleichen.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithIgnoreRegexRule(string, string, [bool])

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

ruleName String : Der Name der Regel, wie Sie sie in der Liste von Rules konfiguriert haben, die Sie im Vergleichsprozess ignorieren möchten.

regexPattern String : Der tatsächliche reguläre Ausdruck, der der zuvor eingegebene ruleName darstellt.

usePlaceholder Boolean (Optional) : Wenn auf True festgelegt, ersetzt der ignorierte Teil eines Dokuments oder Texts durch einen Platzhalterwert. Der Platzhalterwert ist ruleName. Standardmäßig ist dieser Parameter auf true festgelegt.

WithIgnoreWildcardRule

Wenn auf True festgelegt, werden Platzhalterregeln ignoriert, die Sie für den Parameter Rules konfiguriert haben. Auf diese Weise können Sie bestimmte Teile der Texte oder Dokumente ausschließen, die Sie vergleichen.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithIgnoreWildcardRule(string, string, bool)

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

ruleName String : Der Name der Regel, wie Sie sie in der Liste von Rules konfiguriert haben, die Sie im Vergleichsprozess ignorieren möchten.

wildcardPattern String : Der tatsächliche Platzhalter, der den zuvor eingegebenen ruleName darstellt.

usePlaceholder Boolean (Optional) : Wenn auf True festgelegt, ersetzt der ignorierte Teil eines Dokuments oder Texts durch einen Platzhalterwert. Der Platzhalterwert ist ruleName. Standardmäßig ist dieser Parameter auf true festgelegt.

WithIncludeWidgets

Bezieht Bilder und URLs in den Vergleichsprozess ein. Wenn Sie diese Methode auf True festlegen, werden bei der Überprüfung der Äquivalenz zwischen Dokumenten oder Texten auch Bilder und URLs verglichen.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithIncludeWidgets(bool)

WithIncludeWidgets(
    bool includeWidgets
)

includeWidgets Boolescher Wert : Wenn auf True festgelegt, vergleicht die codierte Automatisierungs-API auch Bilder und URLs bei der Überprüfung der Äquivalenz zwischen Dokumenten und Texten.

WithWordSeparators

Geben Sie die Zeichen an, die Sie als Worttrennzeichen definieren möchten. Die Zeichen müssen in einer Zeichenfolge gespeichert werden.

Definition

Namespace: UiPath.Testing.API.Models

Assembly: UiPath.Testing.Activities.Api (in UiPath.Testing.Activities.Api.dll)

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)

wordSeparators Zeichenfolge – Die Zeichenfolge, die die Zeichen enthält, die Sie als Worttrennzeichen berücksichtigen möchten.