UiPath.Studio.Activities.Api.Analyzer.Rules

En esta sección puedes encontrar más información sobre cómo crear actividades usando UiPath.Studio.Activities.Api.Analyzer.Rules.

ActivityMessage

Un mensaje que indica la actividad que desencadenó un error del Analizador de flujo de trabajo.

Herencia

InspectionMessage > ActivityMessage

Propiedades

Tipo	Nombre	Observaciones
String	IdDeActividad	El ID de la actividad relacionada con el mensaje.
String	ActivityDisplayName	El nombre para mostrar de la actividad.
IMemberModel	SourceMember	Opcional El origen del resultado, por ejemplo, una variable o una propiedad.

AnalyzerInspector

Representa la clase base de reglas y contadores.

Herencia

Propiedades

Tipo	Nombre	Observaciones
String	Nombre	El nombre de la regla / contador tal como aparece en la ventana Configuración del analizador de flujo de trabajo.
String	ID	El ID de la regla / contador debe ser único. Utilice una notación similar a https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/
IDictionary<string, IParameter>	Parámetros	La colección de parámetros que puede configurar el usuario.
Booleano	DefaultIsEnabled	Si es true, la regla está habilitada de forma predeterminada. Requiere Studio 2019.10.3 o posterior.
String	DocumentationLink	Un enlace en la ventana de configuración de WFA. Requiere Studio 2019.10.3 o posterior.
List<string>	ApplicableScopes	La configuración de destino donde se debe aplicar esta regla. Consulta Constantes de reglas para ver algunos ejemplos. Requiere Studio 2020.4 o posterior.

Contador

Interfaz para la definición de contadores.

Herencia

AnalyzerInspector > Counter

Constructores

public Counter(string counterName, string counterId)

Tipo	Nombre	Observaciones
String	counterName	El nombre tal como aparece en la ventana Configuración del analizador de flujo de trabajo.
String	counterId	El ID del contador debe ser único.

Counter <T>

Un contador que se aplica a un determinado Objeto de Inspección.

Herencia

AnalyzerInspector > Counter > Counter<T>

Tipo genérico

Un IInspectionObject que define a qué se aplica este contador.

Constructores

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

Tipo	Nombre	Observaciones
String	counterName	El nombre del contador.
String	counterId	El ID del contador debe ser único.
Func<IReadOnlyCollection<T>, Counter, InspectionResult>	inspectionFunction	Una función que recibe los objetos que se van a inspeccionar y el contador según lo configurado por el usuario y debe devolver un Resultado de Inspección.

InspectionMessage

Un mensaje en InspectionResult.InspectionMessages.

Propiedades

Tipo	Nombre	Observaciones
String	Mensaje	El mensaje que se va a mostrar. Requiere Studio 2019.10.3 o posterior.

InspectionResult

El resultado de una inspección.

Herencia

IResult > InspectionResult

Propiedades

Tipo	Nombre	Observaciones
Booleano	HasErrors
ICollection<string>	Mensajes	Para mensajes más detallados, utiliza InspectionMessage.
ICollection<InspectionMessage>	InspectionMessages	Mensajes mejores, escalables y detallados. Los tipos especializados están disponibles (ActivityMessage). Requiere Studio 2019.10.3 o posterior.
String	RecommendationMessage	La recomendación para este resultado.
Nivel de seguimiento	Nivel de error	El nivel de error de este resultado.
String	DocumentationLink	El enlace de la documentación de este resultado.

IParameter

Define el aspecto de una regla o un parámetro de contador.

Herencia

Propiedades

Tipo	Nombre	Observaciones
String	Clave	Clave única para este parámetro en esta regla.
String	LocalizedDisplayName	Nombre para mostrar localizado actual.
String	Valor	Un valor del usuario para este parámetro.
String	ConstraintRegex	La expresión regular de restricción para el valor. Requiere Studio 2019.10.2 o posterior.
Booleano	ValorPredeterminado	El valor predeterminado para este parámetro. Requiere Studio 2019.10.2 o posterior.

Parámetro

Una simple implementación de IParameter.

Herencia

IParameter > Parameter

Propiedades

Tipo	Nombre	Observaciones
String	Clave	Clave única para este parámetro en esta regla.
String	LocalizedDisplayName	Nombre para mostrar localizado actual.
String	Valor	Un valor del usuario para este parámetro.
String	ConstraintRegex	La expresión regular de restricción para el valor. Requiere Studio 2019.10.2 o posterior.
Booleano	ValorPredeterminado	El valor predeterminado para este parámetro. Requiere Studio 2019.10.2 o posterior.

ProjectMessage

Nota: esta característica se introdujo en UiPath.Studio.Activities.Api v20.4.

Una dependencia del paquete que ha desencadenado un error del Analizador de flujo de trabajo.

Herencia

InspectionMessage > ProjectMessage

Propiedades

Tipo	Nombre	Observaciones
IDependency	Dependencia	Opcional La dependencia con error.

Regla

Interfaz para definición de reglas.

Herencia

AnalyzerInspector > Rule

Constructores

regla pública (cadena NombreDeRegla, cadena IDDeRegla)

Tipo	Nombre	Observaciones
String	ruleName	El nombre tal como aparece en la ventana Configuración del analizador de flujo de trabajo.
String	ID de la regla	El ID de la regla debe ser único.

Propiedades

Tipo	Nombre	Observaciones
Nivel de seguimiento	Nivel de error	El nivel de error configurable para esta regla. Usar solo en Runtime para leer el nivel de error efectivo. No establezca esto al definir la regla. Utilice DefaultErrorLevel en su lugar.
Nivel de seguimiento	DefaultErrorLevel	El nivel de error predeterminado para esta regla. Requiere Studio 2019.10.2 o posterior.
String	RecommendationMessage	El mensaje de recomendación configurable.

Rule <T>

Una regla que se aplica a un determinado Objeto de Inspección.

Herencia

AnalyzerInspector > Rule > Rule<T>

Tipo genérico

Un IInspectionObject que define a qué se aplica esta regla.

Constructores

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

Tipo	Nombre	Observaciones
String	ruleName	El nombre tal como aparece en la ventana Configuración del analizador de flujo de trabajo.
String	ID de la regla	El ID de la regla debe ser único.
Func<T, Rule, InspectionResult>	inspectionFunction	Una función que recibe los objetos que se van a inspeccionar y la regla según la configuración del usuario y que debe devolver un Resultado de Inspección.

RuleConstants

Nota: esta característica se introdujo en UiPath.Studio.Activities.Api v20.4.

Define el perfil de Studio al que se aplica una regla.

Constantes

Tipo	Nombre	Observaciones
String	DevelopmentRuleConstant	Representa una regla que se aplica a Studio.
String	BusinessRuleConstant	Representa una regla que se aplica a StudioX.
String	TestAutomationRuleConstant	Representa una regla que se aplica a Studio Pro.

WorkflowMessage

Nota: esta característica se introdujo en UiPath.Studio.Activities.Api v20.4.

El mensaje devuelto cuando se analiza un flujo de trabajo.

Herencia

InspectionMessage > WorkflowMessage

Propiedades

Tipo	Nombre	Observaciones
IMemberModel	SourceMember	Opcional El origen del resultado.
String	NombreParaMostrar	Opcional El nombre para mostrar de la actividad que generó el mensaje.