Classe TestingOptions.CompareDocuments

Use essa classe para configurar opções para comparar documentos com a API de automação codificada ComparePdfDocuments .

Definição

Namespace: UiPath.Testing.API.Models

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

Sintaxe

public class TestingOptions : CompareDocuments

Construtores

public TestingOptions.CompareDocuments()

TestingOptions.CompareDocuments : Inicia uma nova instância de classe TestingOptions.CompareDocuments .

Propriedades

AdditionalOutputFilePath String : caminho para o arquivo de saída adicional. Precisa ser definido se OutputDiffType for PDF.

ContinueOnError Booleano : especifica se a automação deve continuar mesmo quando o método gera um erro. Este parâmetro aceita apenas valores Booleanos, como true ou false. O valor padrão é false. Como resultado, se o parâmetro estiver em branco e um erro for gerado, a execução do projeto será interrompida. Se o valor for definido como true, a execução do projeto continua independentemente de qualquer erro.

GenerateSemanticResult Booleano : execute a verificação usando os recursos de IA que o Autopilot^TM oferece para obter uma interpretação semântica das diferenças. Isso gera um resultado adicional com as diferenças semânticas.

Observação:

Dependendo do plano de licenciamento no qual você se inscreveu, o tipo de resultado semântico consome um dos seguintes:

• Para o plano de licenciamento Flex, o tipo de resultado semântico consome uma AI Unit.
• Para o plano de licenciamento de Preços Unificados, o tipo de resultado Semântico consome uma Platform Units. Para obter mais informações sobre consumo, acesse Sobre o pacote de atividades Testing.

IgnoreIdenticalItems Booleano : se definido como True, itens idênticos serão ignorados durante a comparação. Isso é útil ao comparar objetos estáticos, como marcas d'água ou cabeçalhos. Por padrão, é definido como True.

IgnoreWidgetsLocation Booleano : se definido como True, ignora o local de uma imagem ou URL nos documentos comparados. Por padrão, é definido como False.

IncludeWidgets Booleano : se definido como True, o processo de comparação também inclui imagens e URLs. Por padrão, é definido como True.

OutputDiffType DocumentOutputDiffType : o tipo que você deseja usar para retornar as diferenças entre os documentos.

OutputFilePath String : o caminho de saída do documento base.

Rules List<ComparisonRule> : lista de regras a serem aplicadas. Elas podem ser do tipo RegexRule ou WildcardRule.

WordSeparators String : os objetos, como Strings, que você deseja considerar como separadores de palavras no processo de comparação. Por exemplo, se os documentos que você está comparando comumente usam um período . ou barras invertidas / para separar palavras, você pode defini-los como separadores de palavras.

Métodos

Esses são os métodos que você pode usar para configurar as opções de comparação de documentos.

WithContinueOnError

Configure se a automação deve continuar mesmo quando o método gera um erro.

Definição

Namespace: UiPath.Testing.API.Models

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

WithContinueOnError(bool)

WithIgnoreRegexRule(
    bool continueOnError
)

continueOnError Booleano : especifica se a automação deve continuar mesmo quando o método gera um erro. Este parâmetro aceita apenas valores Booleanos (true, false). O valor padrão é false. Como resultado, se o parâmetro estiver em branco e um erro for gerado, a execução do projeto será interrompida. Se o valor for definido como true, a execução do projeto continua independentemente de qualquer erro.

WithGenerateHtml

Gera um arquivo HTML com as diferenças destacadas identificadas entre os dois documentos ou textos.

Definição

Namespace: UiPath.Testing.API.Models

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

WithGenerateHtml(string)

WithGenerateHtml(
    string filePath
)

filePath String : o caminho do arquivo HTML que armazena as diferenças identificadas ao comparar os documentos ou textos.

WithGeneratePDF

Gera novos arquivos PDF com as diferenças destacadas para o documento de linha de base e o documento de destino, usado para comparar com o documento de linha de base.

Definição

Namespace: UiPath.Testing.API.Models

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

WithGeneratePDF(string, string)

WithGeneratePDF(
    string baselinePath,
    string targetPath
)

baselinePath String : o novo caminho do documento de linha de base, onde você deseja armazenar o arquivo PDF que destacou as diferenças identificadas.

targetPath String : o novo caminho do documento de destino, onde você deseja armazenar o arquivo PDF que destacou as diferenças identificadas.

WithGenerateSemanticResult

Execute a verificação usando os recursos de IA que o Autopilot^TM oferece para obter uma interpretação semântica das diferenças. Isso gera um resultado adicional com as diferenças semânticas.

Observação:

Dependendo do plano de licenciamento no qual você se inscreveu, o tipo de resultado semântico consome um dos seguintes:

• Para o plano de licenciamento Flex, o tipo de resultado semântico consome uma AI Unit.
• Para o plano de licenciamento de Preços Unificados, o tipo de resultado Semântico consome uma Platform Units. Para obter mais informações sobre consumo, acesse Sobre o pacote de atividades Testing.

Definição

Namespace: UiPath.Testing.API.Models

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

WithGenerateSemanticResult(bool)

WithGenerateSemanticResult(
    bool generateSemanticResult = false
)

generateSemanticResult Booleano : se definido como true, executa a verificação usando recursos de IA. Por padrão, é definido como false.

RetornarValor

SemanticDifferences

O resultado do processo de verificação, realizado usando recursos de IA.

WithIgnoreIdenticalItems

Se definidas como True, linhas idênticas serão ignoradas durante a comparação.Isso é útil, em especial, ao comparar objetos estáticos, como marcas d'água ou cabeçalhos.

Definição

Namespace: UiPath.Testing.API.Models

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

WithIgnoreIdenticalItems(bool)

CompareDocumentsOptions WithIgnoreIdenticalItems<CompareDocumentsOptions>( 
    bool ignoreIdenticalItems = true
)

ignoreIdenticalItems Boolean : especifica se itens idênticos devem ser ignorados durante a comparação. Por padrão, esse parâmetro é definido como true.

WithIgnoreWidgetsPageAndPosition

Se definido como verdadeiro, ignora a posição e a página de uma imagem ou URL.

Definição

Namespace: UiPath.Testing.API.Models

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

WithIgnoreWidgetsPageAndPosition(this, bool)

WithIgnoreWidgetsPageAndPosition(
    bool ignoreWidgetsPageAndPosition = false
)

ignoreWidgetsPageAndPosition Booleano : se definido como true, ignora a posição e a página de uma imagem ou URL. Por padrão, o valor do parâmetro é false.

WithIgnoreRegexRule

Se definido como True, ignora qualquer regra Regex que você configurou para o parâmetro Rules.Isso permite que você exclua certas partes dos textos ou documentos que você está comparando.

Definição

Namespace: UiPath.Testing.API.Models

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

WithIgnoreRegexRule(string, string, [bool])

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

ruleName String : o nome da regra, como você a configurou na lista de Rules, que você deseja ignorar no processo de comparação.

regexPattern String : o regex real que representa o ruleName inserido anteriormente.

usePlaceholder Booleano (Opcional) : se definido como True substitui a parte ignorada de um documento ou texto com um valor de espaço reservado. O valor do espaço reservado é o ruleName. Por padrão, esse parâmetro é definido como true.

WithIgnoreWildcardRule

Se definido como True, ignora qualquer regra de curinga que você configurou para o parâmetro Rules.Isso permite que você exclua certas partes dos textos ou documentos que você está comparando.

Definição

Namespace: UiPath.Testing.API.Models

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

WithIgnoreWildcardRule(string, string, bool)

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

ruleName String : o nome da regra, como você a configurou na lista de Rules, que você deseja ignorar no processo de comparação.

wildcardPattern String : o curinga real que representa o ruleName inserido anteriormente.

usePlaceholder Booleano (Opcional) : se definido como True substitui a parte ignorada de um documento ou texto com um valor de espaço reservado. O valor do espaço reservado é o ruleName. Por padrão, esse parâmetro é definido como true.

WithIncludeWidgets

Inclui imagens e URLs no processo de comparação. Se você definir este método como True, ele também compara imagens e URLs ao verificar a equivalência entre documentos ou textos.

Definição

Namespace: UiPath.Testing.API.Models

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

WithIncludeWidgets(bool)

WithIncludeWidgets(
    bool includeWidgets
)

includeWidgets Booleano : se definido como True, a API de automação codificada também compara imagens e URLs ao verificar a equivalência entre documentos e textos.

WithWordSeparators

Especifique os caracteres que você deseja definir como separadores de palavras. Os caracteres devem ser armazenados em uma string.

Definição

Namespace: UiPath.Testing.API.Models

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

WithWordSeparators(string)

WithWordSeparators(
    string wordSeparators
)

wordSeparators String : a string que contém os caracteres que você deseja considerar como separadores de palavras.