Classe OptionsTest.CompareDocuments

Utilisez cette classe pour configurer les options de comparaison de documents avec l'API d'automatisation codée ComparePdfDocuments .

Définition

Espace de noms:  UiPath.Testing.API.Models

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

Syntaxe

public class TestingOptions : CompareDocuments

Constructeurs

public TestingOptions.CompareDocuments()

TestingOptions.CompareDocuments : initialise une nouvelle instance de la classe TestingOptions.CompareDocuments .

Propriétés

AdditionalOutputFilePath String : chemin d'accès au fichier de sortie supplémentaire. Doit être défini si la valeur OutputDiffType est PDF.

ContinueOnError Booléen : spécifie si l'automatisation doit se poursuivre même lorsque la méthode génère une erreur. Ce paramètre prend uniquement en charge les valeurs booléennes telles que true ou false. La valeur par défaut est false. Par conséquent, si le paramètre est vide et qu’une erreur est générée, l’exécution du projet s’arrête. Si le champ indique au contraire true, l'exécution du projet se poursuit même en cas d'erreur.

GenerateSemanticResult Booléen : effectuez la vérification à l’aide des capacités d’IA proposées par Autopilot^TM afin d’obtenir une interprétation sémantique des différences. Cela génère un résultat supplémentaire avec les différences sémantiques.

Remarque :

Selon le plan de licence auquel vous vous êtes inscrit, le type de résultat Semantic consomme l'un des éléments suivants pour chaque exécution d'API d'automatisation codée :

• Pour le régime Flex, le type de résultat Semantic consomme une AI Unit.
• Pour le régime de licence Unified Pricing, le type de résultat Sémantique consomme une unité Platform Units. Pour plus d’informations sur l’utilisation, consultez À propos du package d’activités Testing.

IgnoreIdenticalItems Booléen : si défini sur True, les éléments identiques sont ignorés lors de la comparaison. Cela est utile lors de la comparaison d’objets statiques, tels que des filigranes ou des en-têtes. Par défaut, il est défini sur True.

IgnoreWidgetsLocation Booléen : si défini sur True, ignore l’emplacement d’une image ou d’une URL dans les documents comparés. Par défaut, il est défini sur False.

IncludeWidgets Booléen : si défini sur True, le processus de comparaison inclut également les images et les URL. Par défaut, il est défini sur True.

OutputDiffType DocumentOutputDiffType : le type que vous souhaitez utiliser pour renvoyer les différences entre les documents.

OutputFilePath String : le chemin de sortie du document de base.

Rules List<ComparisonRule> : Liste des règles à appliquer. Elles peuvent être de type RegexRule ou WildcardRule.

WordSeparators Chaîne : les objets, sous la forme de chaînes, que vous souhaitez prendre en compte comme séparateurs de mots dans le processus de comparaison. Par exemple, si les documents que vous comparez utilisent généralement un point . ou une barre oblique inverse / pour séparer des mots, vous pouvez définir ces caractères comme séparateurs de mots.

Méthodes

Voici les méthodes que vous pouvez utiliser pour configurer les options de comparaison de documents.

WithContinueOnError

Configurez si l’automatisation doit se poursuivre même lorsque la méthode génère une erreur.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithContinueOnError(bool)

WithIgnoreRegexRule(
    bool continueOnError
)

continueOnError Booléen : spécifie si l'automatisation doit se poursuivre même lorsque la méthode génère une erreur. Ce paramètre prend uniquement en charge les valeurs booléennes (true, false). La valeur par défaut est false. Par conséquent, si le paramètre est vide et qu’une erreur est générée, l’exécution du projet s’arrête. Si le champ indique au contraire true, l'exécution du projet se poursuit même en cas d'erreur.

WithGenerateHtml

Génère un fichier HTML avec les différences mises en évidence entre les deux documents ou textes.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithGenerateHtml(string)

WithGenerateHtml(
    string filePath
)

filePath String : le chemin d'accès du fichier HTML qui stocke les différences identifiées lors de la comparaison des documents ou des textes.

WithGeneratePDF

Génère de nouveaux fichiers PDF avec les différences mises en évidence pour le document de base et le document cible, utilisés pour effectuer la comparaison avec le document de base.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithGeneratePDF(string, string)

WithGeneratePDF(
    string baselinePath,
    string targetPath
)

baselinePath String : le nouveau chemin d'accès du document de base, où vous souhaitez stocker le fichier PDF qui a mis en évidence les différences identifiées.

targetPath String : le nouveau chemin d'accès au document cible, où vous souhaitez stocker le fichier PDF qui a mis en évidence les différences identifiées.

WithGenerateSemanticResult

Effectuez la vérification à l’aide des capacités d’IA proposées par Autopilot^TM afin d’obtenir une interprétation sémantique des différences. Cela génère un résultat supplémentaire avec les différences sémantiques.

Remarque :

Selon le plan de licence auquel vous vous êtes inscrit, le type de résultat Semantic consomme l'un des éléments suivants pour chaque exécution d'API d'automatisation codée :

• Pour le régime Flex, le type de résultat Semantic consomme une AI Unit.
• Pour le régime de licence Unified Pricing, le type de résultat Sémantique consomme une unité Platform Units. Pour plus d’informations sur l’utilisation, consultez À propos du package d’activités Testing.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithGenerateSemanticResult(bool)

WithGenerateSemanticResult(
    bool generateSemanticResult = false
)

generateSemanticResult Booléen : si défini sur true, effectue la vérification à l’aide des capacités d’IA. Par défaut, il est défini sur false.

RetournerValeur

SemanticDifferences

Le résultat du processus de vérification, effectué à l’aide des capacités de l’IA.

WithIgnoreIdenticalItems

Si défini sur True, les lignes identiques sont ignorées lors de la comparaison. Ce point est particulièrement utile lors de la comparaison d’objets statiques, tels que des filigranes ou des en-têtes.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithIgnoreIdenticalItems(bool)

CompareDocumentsOptions WithIgnoreIdenticalItems<CompareDocumentsOptions>( 
    bool ignoreIdenticalItems = true
)

ignoreIdenticalItems Booléen : spécifie si les éléments identiques doivent être ignorés lors de la comparaison. Par défaut, ce paramètre est défini sur true.

WithIgnoreWidgetsPageAndPosition

Si défini sur True, ignore la position et la page d'une image ou d'une URL.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithIgnoreWidgetsPageAndPosition(this, bool)

WithIgnoreWidgetsPageAndPosition(
    bool ignoreWidgetsPageAndPosition = false
)

ignoreWidgetsPageAndPosition Booléen : si défini sur true, ignore la position et la page d’une image ou d’une URL. Par défaut, la valeur du paramètre est false.

WithIgnoreRegexRule

Si défini sur True, ignore toute règle Regex que vous avez configurée pour le paramètre Rules. Cela vous permet d’exclure certaines parties des textes ou des documents que vous comparez.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithIgnoreRegexRule(string, string, [bool])

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

ruleName String : le nom de la règle, tel que configuré dans la liste de Rules, que vous souhaitez ignorer dans le processus de comparaison.

regexPattern String : l’expression régulière réelle qui représente l’objet ruleName précédemment saisi.

usePlaceholder Booléen (Facultatif) : si défini sur True , remplace la partie ignorée d'un document ou d'un texte par une valeur d'espace réservé. La valeur de l’espace réservé est ruleName. Par défaut, ce paramètre est défini sur true.

WithIgnoreWildcardRule

Si défini sur True, ignore toute règle de caractère générique que vous avez configurée pour le paramètre Rules. Cela vous permet d’exclure certaines parties des textes ou des documents que vous comparez.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithIgnoreWildcardRule(string, string, bool)

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

ruleName String : le nom de la règle, tel que configuré dans la liste de Rules, que vous souhaitez ignorer dans le processus de comparaison.

wildcardPattern Chaîne : le caractère générique réel qui représente l'objet ruleName précédemment saisi.

usePlaceholder Booléen (Facultatif) : si défini sur True , remplace la partie ignorée d'un document ou d'un texte par une valeur d'espace réservé. La valeur de l’espace réservé est ruleName. Par défaut, ce paramètre est défini sur true.

WithIncludeWidgets

Inclut des images et des URL dans le processus de comparaison. Si vous définissez cette méthode sur True, elle compare également les images et les URL lors de la vérification de l'équivalent entre les documents ou les textes.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithIncludeWidgets(bool)

WithIncludeWidgets(
    bool includeWidgets
)

includeWidgets Booléen : si elle est définie sur True, l'API d'automatisation codée compare également les images et les URL lorsqu'elle vérifie l'équivalence entre les documents et les textes.

WithWordSeparators

Spécifiez les caractères que vous souhaitez définir comme séparateurs de mots. Les caractères doivent être stockés dans une chaîne.

Définition

Espace de noms:  UiPath.Testing.API.Models

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

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)

wordSeparators Chaîne : la chaîne contenant les caractères à prendre en compte comme séparateurs de mots.