SDK

Plus récente (Latest)

False

Guide du développeur

Dernière mise à jour 23 mars 2024

UiPath.Studio.Activities.Api.Analyzer.Rules

Dans cette section, vous trouverez plus d'informations sur la création d'activités à l'aide de UiPath.Studio.Activities.Api.Analyzer.Rules.

ActivityMessage

Message qui indique l'activité qui a déclenché une erreur d'analyseur de workflow.

Héritage

InspectionMessage > ActivityMessage

Propriétés

Saisie de texte	Nom	Remarques
string	ActivitéID	L'identifiant de l'activité associée au message.
string	ActivityDisplayName	Le nom d’affichage de l’activité.
IMemberModel	SourceMember	Facultatif (Optional) La source du résultat, par exemple, une variable ou une propriété.

AnalyzerInspector

Représente la classe de base pour les règles et les compteurs.

Héritage

Propriétés

Saisie de texte	Nom	Remarques
string	Nom	Le nom de la règle/du compteur tel qu'il apparaît dans la fenêtre Paramètres de l'analyseur de workflow (Workflow Analyzer Settings).
string	Id	L'ID de la règle/du compteur doit être unique. Utilisez une notation similaire à https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/
IDictionary<string, IParameter>	Paramètres	La collection de paramètres qui peuvent être configurés par l'utilisateur.
Bool	DefaultIsEnabled	Si `true`, la règle est activée par défaut. Nécessite Studio 2019.10.3 ou une version ultérieure.
string	DocumentationLink	Un lien cliquable dans la fenêtre des paramètres WFA. Nécessite Studio 2019.10.3 ou une version ultérieure.
List<string>	ApplicableScopes	La configuration cible où cette règle doit s'appliquer. Voir RuleConstants pour quelques exemples. Nécessite Studio 2020.4 ou une version ultérieure.

Compteur

Interface de définition des compteurs.

Héritage

AnalyzerInspector > Counter

Constructeurs

public Counter(string counterName, string counterId)

Saisie de texte	Nom	Remarques
string	counterName	Le nom tel qu'il apparaît dans la fenêtre Paramètres de l'analyseur de workflow (Workflow Analyzer Settings).
string	counterId	L'ID du compteur doit être unique.

Counter <T>

Un compteur qui s'applique à un certain ObjetInspection.

Héritage

AnalyzerInspector > Counter > Counter<T>

Type générique T

Objet IInspectionObject qui définit ce à quoi ce compteur s'applique.

Constructeurs

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

Saisie de texte	Nom	Remarques
string	counterName	Le nom du compteur.
string	counterId	L'ID du compteur doit être unique.
Func<IReadOnlyCollection<T>, Counter, InspectionResult>	inspectionFunction	Une fonction qui reçoit les objets à inspecter et le compteur tel que configuré par l'utilisateur et doit renvoyer un Résultat d'inspection ( InspectionResult).

InspectionMessage

Un message au InspectionResult.InspectionMessages.

Propriétés

Saisie de texte	Nom	Remarques
string	Message	Le message à afficher. Nécessite Studio 2019.10.3 ou une version ultérieure.

InspectionResult

Résultat d'une inspection.

Héritage

IResult > InspectionResult

Propriétés

Saisie de texte	Nom	Remarques
Bool	HasErrors
ICollection<string>	Messages	Pour obtenir des messages plus détaillés, utilisez Message d'inspection ( InspectionMessage).
ICollection<InspectionMessage>	InspectionMessages	Des messages de meilleure qualité, évolutifs et détaillés. Des types spécialisés sont disponibles (ActivityMessage). Nécessite Studio 2019.10.3 ou une version ultérieure.
string	RecommendationMessage	Recommandation pour ce résultat.
Niveau du traçage	Niveau d'erreur (Error Level)	Le niveau d’erreur de ce résultat.
string	DocumentationLink	Le lien de documentation de ce résultat.

IParameter

Définit l'apparence d'un paramètre de règle ou de compteur.

Héritage

Propriétés

Saisie de texte	Nom	Remarques
string	Clé (Key)	Clé unique pour ce paramètre dans cette règle.
string	LocalizedDisplayName	Nom complet localisé actuel.
string	Valeur (Value)	Une valeur provenant de l'utilisateur pour ce paramètre.
string	ConstraintRegex	L'expression régulière de contrainte pour la valeur. Nécessite Studio 2019.10.2 ou une version ultérieure.
Bool	ValeurParDéfaut	Valeur par défaut de ce paramètre. Nécessite Studio 2019.10.2 ou une version ultérieure.

Paramètre

Une implémentation simple de IParameter.

Héritage

IParameter > Parameter

Propriétés

Saisie de texte	Nom	Remarques
string	Clé (Key)	Clé unique pour ce paramètre dans cette règle.
string	LocalizedDisplayName	Nom complet localisé actuel.
string	Valeur (Value)	Une valeur provenant de l'utilisateur pour ce paramètre.
string	ConstraintRegex	L'expression régulière de contrainte pour la valeur. Nécessite Studio 2019.10.2 ou une version ultérieure.
Bool	ValeurParDéfaut	Valeur par défaut de ce paramètre. Nécessite Studio 2019.10.2 ou une version ultérieure.

ProjectMessage

Remarque : cette fonctionnalité a été introduite dans UiPath.Studio.Activities.Api v20.4.

Une dépendance de package qui a déclenché une erreur d'analyseur de workflow.

Héritage

InspectionMessage > ProjectMessage

Propriétés

Saisie de texte	Nom	Remarques
IDependency	Dépendance	Facultatif Dépendance avec erreur.

Règles

Interface pour la définition des règles.

Héritage

AnalyzerInspector > Rule

Constructeurs

public Rule(string ruleName, string ruleId)

Saisie de texte	Nom	Remarques
string	ruleName	Le nom tel qu'il apparaît dans la fenêtre Paramètres de l'analyseur de workflow (Workflow Analyzer Settings).
string	ID de règle	L'ID de la règle doit être unique.

Propriétés

Saisie de texte	Nom	Remarques
Niveau du traçage	Niveau d'erreur (Error Level)	Niveau d'erreur configurable pour cette règle. À n'utiliser qu'au moment du Runtime pour lire le niveau d'erreur effectif. Ne le définissez pas lors de la définition de la règle. Utilisez `DefaultErrorLevel` à la place.
Niveau du traçage	DefaultErrorLevel	Niveau d'erreur par défaut de cette règle. Nécessite Studio 2019.10.2 ou une version ultérieure.
string	RecommendationMessage	Le message de recommandation configurable.

Rule <T>

Une règle qui s'applique à un certain ObjetInspection.

Héritage

AnalyzerInspector > Rule > Rule<T>

Type générique T

Objet IInspectionObject qui définit ce à quoi cette règle s’applique.

Constructeurs

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

Saisie de texte	Nom	Remarques
string	ruleName	Le nom tel qu'il apparaît dans la fenêtre Paramètres de l'analyseur de workflow (Workflow Analyzer Settings).
string	ID de règle	L'ID de la règle doit être unique.
Func<T, Rule, InspectionResult>	inspectionFunction	Une fonction qui reçoit les objets à inspecter et la règle telle que configurée par l'utilisateur et doit renvoyer un Résultat d'inspection ( InspectionResult).

RuleConstants

Remarque : cette fonctionnalité a été introduite dans UiPath.Studio.Activities.Api v20.4.

Définit le profil Studio auquel une règle s'applique.

Constantes

Saisie de texte	Nom	Remarques
string	DevelopmentRuleConstant	Représente une règle qui s'applique à Studio.
string	BusinessRuleConstant	Représente une règle qui s’applique à StudioX.
string	TestAutomationRuleConstant	Représente une règle qui s’applique à Studio Pro.