UiPath.Studio.Activities.Api.Analyzer.Rules

Nesta seção, você pode encontrar mais informações sobre como criar atividades usando o UiPath.Studio.Activities.Api.Analyzer.Rules.

ActivityMessage

Uma mensagem que indica a atividade que disparou um erro do Analisador de Fluxo de Trabalho.

Herança

InspectionMessage > ActivityMessage

Propriedades

Tipo	Name	Considerações
String	IdDaAtividade	O ID da atividade relacionada à mensagem.
String	ActivityDisplayName	O nome de exibição da atividade.
IMemberModel	SourceMember	Opcional A origem do resultado, por exemplo, uma variável ou uma propriedade.

AnalyzerInspector

Representa a classe base para regras e contadores.

Herança

Propriedades

Tipo	Name	Considerações
String	Name	O nome da regra/contador como aparece na janela Configurações do Analisador de Fluxo de Trabalho.
String	Id	O ID da regra/contador deve ser exclusivo. Use uma notação semelhante a https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compilar-messages/
IDictionary<string, IParameter>	Parâmetros	A coleção de parâmetros que podem ser configurados pelo usuário.
Bool	DefaultIsEnabled	Se true, a regra será habilitada por padrão. Requer o Studio 2019.10.3 ou posterior.
String	DocumentationLink	Um link que pode ser clicado na janela de configurações do WFA. Requer o Studio 2019.10.3 ou posterior.
List<string>	ApplicableScopes	A configuração de destino em que esta regra deve ser aplicada. Consulte RuleConstants para obter alguns exemplos. Requer o Studio 2020.4 ou posterior.

Contador

Interface para definição do contador.

Herança

AnalyzerInspector > Counter

Construtores

public Counter(string counterName, string counterId)

Tipo	Name	Considerações
String	counterName	O nome como ele aparece na janela Configurações do Analisador de Fluxo de Trabalho.
String	counterId	O ID do contador deve ser exclusivo.

Counter <T>

Um contador que se aplica a um determinado ObjetoDeInspeção.

Herança

AnalyzerInspector > Counter > Counter<T>

Genérico Tipo T

Um IInspectionObject que define ao que esse contador se aplica.

Construtores

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

Tipo	Name	Considerações
String	counterName	O nome do contador.
String	counterId	O ID do contador deve ser exclusivo.
Func<IReadOnlyCollection<T>, Counter, InspectionResult>	inspectionFunction	Uma função que recebe os objetos a serem inspecionados e o contador conforme configurado pelo usuário e deve retornar um InspectionResult.

InspectionMessage

Uma mensagem em InspectionResult.InspectionMessages.

Propriedades

Tipo	Name	Considerações
String	Mensagem	A mensagem a exibir. Requer o Studio 2019.10.3 ou posterior.

InspectionResult

Um resultado para uma inspeção.

Herança

IResult > InspectionResult

Propriedades

Tipo	Name	Considerações
Bool	HasErrors
ICollection<string>	Mensagens	Para mensagens mais detalhadas, use MensagemDeInspeção.
ICollection<InspectionMessage>	InspectionMessages	Mensagens melhores, escaláveis e detalhadas. Tipos especializados estão disponíveis (ActivityMessage). Requer o Studio 2019.10.3 ou posterior.
String	RecommendationMessage	A recomendação para este resultado.
Nível de trace	Nível de erro	O nível de erro deste resultado.
String	DocumentationLink	O link da documentação deste resultado.

IParameter

Define a aparência de uma regra ou parâmetro de contador.

Herança

Propriedades

Tipo	Name	Considerações
String	Chave	Chave exclusiva para este parâmetro nesta regra.
String	LocalizedDisplayName	Nome de exibição localizado atual.
String	Valor	Um valor do usuário para este parâmetro.
String	ConstraintRegex	O regex de restrição para o valor. Requer o Studio 2019.10.2 ou posterior.
Bool	ValorPadrão	O valor padrão para este parâmetro. Requer o Studio 2019.10.2 ou posterior.

Parâmetro

Uma implementação simples de IParameter.

Herança

IParameter > Parameter

Propriedades

Tipo	Name	Considerações
String	Chave	Chave exclusiva para este parâmetro nesta regra.
String	LocalizedDisplayName	Nome de exibição localizado atual.
String	Valor	Um valor do usuário para este parâmetro.
String	ConstraintRegex	O regex de restrição para o valor. Requer o Studio 2019.10.2 ou posterior.
Bool	ValorPadrão	O valor padrão para este parâmetro. Requer o Studio 2019.10.2 ou posterior.

ProjectMessage

Observação: essa funcionalidade foi introduzida na versão 20.4 do UiPath.Studio.Activities.Api.

Uma dependência de pacote que disparou um erro do Analisador de Fluxo de Trabalho.

Herança

InspectionMessage > ProjectMessage

Propriedades

Tipo	Name	Considerações
IDependency	Dependência	Opcional A dependência com erro.

Regra

Interface para definição de regras.

Herança

AnalyzerInspector > Rule

Construtores

Regra pública (string RuleName, string RuleId)

Tipo	Name	Considerações
String	ruleName	O nome como ele aparece na janela Configurações do Analisador de Fluxo de Trabalho.
String	ID de regra	O ID da regra deve ser exclusivo.

Propriedades

Tipo	Name	Considerações
Nível de trace	Nível de erro	O nível de erro configurável para esta regra. Use apenas no Runtime para ler o nível de erro efetiva. Não defina isso ao definir a regra. Use DefaultErrorLevel em vez disso.
Nível de trace	DefaultErrorLevel	O nível de erro padrão para esta regra. Requer o Studio 2019.10.2 ou posterior.
String	RecommendationMessage	A mensagem de recomendação configurável.

Rule <T>

Uma regra que se aplica a um determinado ObjetoDeInspeção.

Herança

AnalyzerInspector > Rule > Rule<T>

Genérico Tipo T

Um IInspectionObject que define a que essa regra se aplica.

Construtores

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

Tipo	Name	Considerações
String	ruleName	O nome como ele aparece na janela Configurações do Analisador de Fluxo de Trabalho.
String	ID de regra	O ID da regra deve ser exclusivo.
Func<T, Rule, InspectionResult>	inspectionFunction	Uma função que recebe os objetos a serem inspecionados e a regra conforme configurada pelo usuário e deve retornar um ResultadoDaInspeção.

RuleConstants

Observação: essa funcionalidade foi introduzida na versão 20.4 do UiPath.Studio.Activities.Api.

Define o perfil do Studio ao qual uma regra se aplica.

Constantes

Tipo	Name	Considerações
String	DevelopmentRuleConstant	Representa uma regra que se aplica ao Studio.
String	BusinessRuleConstant	Representa uma regra que se aplica ao StudioX.
String	TestAutomationRuleConstant	Representa uma regra que se aplica ao Studio Pro.

WorkflowMessage

Observação: essa funcionalidade foi introduzida na versão 20.4 do UiPath.Studio.Activities.Api.

A mensagem retornada quando um fluxo de trabalho é analisado.

Herança

InspectionMessage > WorkflowMessage

Propriedades

Tipo	Name	Considerações
IMemberModel	SourceMember	Opcional A origem do resultado.
String	NomeDeExibição	Opcional O nome de exibição da atividade que gerou a mensagem.