Souscrire

UiPath Studio

Le guide de Studio UiPath

À propos de l'analyseur de workflow

L'Analyseur de flux de travail (Workflow Analyzer) est un analyseur de code statique qui garantit que votre projet répond à des normes de qualité et de fiabilité élevées. Un analyseur de code statique vérifie les incohérences sans exécuter réellement le projet, par opposition aux analyseurs dynamiques qui interviennent au cours de l’exécution.

L'analyseur de workflow utilise un ensemble de règles pour vérifier diverses incohérences sans rapport avec l'exécution du projet. Les règles sont basées sur les Bonnes pratiques d'automatisation et tiennent compte du nommage des variables et des arguments, des séquences ou flux de travail vides, des restrictions sur les paquets, etc. L'analyseur n'identifie pas les erreurs d'exécution ou de compilation.

Il est disponible dans l'onglet Conception (Design) du ruban, les boutons Analyser le fichier (Analyze File) et Analyser le projet (Analyze Project). Le premier effectue une analyse dans le fichier actuellement activé dans le panneau Concepteur (Designer), tandis que le second analyse tous les fichiers dans le projet d'automatisation.

Studio comes with a set of built-in rules, identifiable by the ST- prefix. The UIAutomation.Activities, Excel.Activities, Testing Activities, and Mail.Activities also have their own rules, identifiable by the prefix.

📘

Remarque :

Les règles intégrées de Studio ne peuvent pas être portées vers les anciennes versions de Studio. Toutefois, les règles des packages d’activités compatibles peuvent être utilisées dans les anciennes versions de Studio fournies avec l’Analyseur de flux de travail.

Conventions d'affectation de noms des règles

Each rule has an ID, name, description, and recommendation. The ID contains the origin, category, and number. For example, Variables Naming Convention has the ST-NMG-001 ID:

  • ST : révèle que la règle est intégrée à Studio.
  • NMG - montre que la règle fait partie de la catégorie Naming Rules . Les règles faisant partie de la catégorie Project Anatomy Rules ont l'abréviation ANA, celles faisant partie de Design Best Practices la DBP, etc.
  • 001 : est le numéro de la règle.

Portée

Chaque règle comporte une étendue à laquelle elle s'applique :

  • Activity: The rules are enforced at activity level, checking variables, arguments, properties. Variables Naming Convention is one such rule.
  • Workflow: Rules perform checks in a single project file, for example Unused Variables.
  • Projet (Project) : les vérifications sont effectuées au niveau du projet.

Action

Les règles comportent un certain nombre d'actions pouvant être définies :

  • Erreur (Error) : génère une erreur dans le panneau Liste d'erreurs (Error List).
  • Avertissement (Warning) : génère un avertissement dans le panneau Liste d'erreurs (Error List).
  • Information (Info) : génère un message dans le panneau Liste d'erreurs (Error List).
  • Logs détaillés (Verbose) : crée des fichiers journaux volumineux.

Check the Logging Levels page to learn more about logging with Studio.

Gestion des règles

Le projet ou le fichier est analysé selon un ensemble de règles disponibles dans la fenêtre Paramètres du projet (Project Settings) :

  • In the Project panel, click the settings_iconsettings_icon icon, then select Workflow Analyzer.
  • Dans le ruban, cliquez sur le bouton Analyser le fichier (Analyze File), puis sélectionnez Paramètres d'analyseur de workflow (Workflow Analyzer Settings) depuis la liste déroulante.

Rules can be filtered by scope and action. By default, rules are arranged by code in the window, and enabled rules are displayed first.

Configurer les règles

You can enable/disable a rule using the checkbox on its left, or change the default action using the dropdown on its right.

Some rules require no additional configuration, while others contain parameters that you can configure, such as thresholds not to be exceeded, or lists of specific items that are allowed or prohibited. Please note that when you configure rules that contain text fields (for example SecureString Misusage or Package Restrictions), text shouldn't be entered between quotes.

Rétablir les paramètres par défaut

Une fois que des modifications ont été apportées aux valeurs par défaut des règles, qu'il s'agisse de Regex ou de seuils, les valeurs par défaut peuvent être rétablies . Il suffit pour cela de faire un clic droit sur la règle, puis de sélectionner Rétablir les paramètres par défaut (Reset to Default).

Validation

La validation du fichier ou du projet est effectuée à chaque déclenchement de l'Analyseur de workflow (Workflow Analyzer). Les options de validation sont disponibles dans le bouton Analyser le fichier (Analyze File) du ruban, Valider le fichier (Validate File) et Valider le projet (Validate Project).

Cette action vérifie si les variables, les arguments, les expressions et les importations sont correctement configurés. L'action Valider le fichier (Validate File) peut être déclenchée à l'aide du raccourci F8, tandis Valider le projet (Validate Project) peut l'être à l'aide de Maj + F8. Vous pouvez annuler la validation à tout moment.

Le ou les fichiers qui contiennent des erreurs sont marqués dans le panneau Projet (Project) avec un point rouge, et les erreurs sont affichées dans les panneaux Liste d'erreurs (Error List) et Sortie (Output).

Un double-clic sur un élément dans le panneau Liste d'erreurs ouvre le .xaml et met en évidence l'élément qui a provoqué l'erreur, qu'il s'agisse d'une activité, d'un argument ou d'une variable.

Sauf si tous les fichiers .xaml sont validés, vous ne pouvez pas déboguer, exécuter ou publier le projet. Les conditions de point d'arrêt ne sont pas évaluées.

Gestion des erreurs

Une fois déclenché, l'Analyseur de workflow (Workflow Analyzer) utilise l'ensemble de règles configuré pour vérifier le projet ou le fichier, puis consigne les erreurs trouvées dans la Liste d'erreurs (Error List), conformément à l'action de la règle.

Le panneau Liste d'erreurs (Error List) filtre les éléments par Erreurs (Errors), Avertissements (Warnings) et Messages (Messages). Le menu déroulant de l'étendue est utile pour le filtrage des erreurs par projet, fichier actuel ou un fichier spécifique de l'automatisation. En outre, les éléments peuvent être filtrés par ID de règle.

Cliquez sur un avertissement ou une erreur trouvé pour afficher la recommandation de la règle et un lien vers la page de documentation de chaque règle.

En plus des violations de règles, le panneau Liste d'erreurs affiche également les erreurs qui peuvent se produire lors de l'exécution de l'analyse du flux de travail. Lorsque l'analyseur de flux de travail ou l'une des règles configurées ne fonctionne pas, l'erreur, ainsi que des détails sur sa cause, est enregistrée dans la description.

Prise en charge des lignes de commande

L'interface utilisateur de ligne de commande UiPath.Studio.CommandLine.exe contient un ensemble de paramètres permettant de vérifier des fichiers ou des projets par rapport à certaines règles, même dans les configurations du pipeline CI/CD.

UiPath.Studio.CommandLine.exe est disponible dans le dossier d'installation :

  • Pour les installations par machine, le chemin par défaut est %ProgramFiles%\UiPath\Studio\
  • Pour les installations par utilisateur, le chemin par défaut est %LocalAppData%\Programs\UiPath\Studio

Configurer les règles

Par défaut, toutes les règles de l'Analyseur de workflow sont activées lors de l’installation de Studio, à l’exception des règles suivantes :

Vous pouvez configurer des règles :

  • Dans la fenêtre Paramètres d'analyseur de workflow (Workflow Analyzer Settings), activez ou désactivez les règles en cochant la case en regard de chacune d’elles,
  • From the RuleConfig.json file, path %LocalAppData%\UiPath\Rules. Find a specific rule, modify its parameter, change the IsEnabled parameter to false to disable the rule. Optionally, if the path is not accessible, you can place the RuleConfig.json file in a custom location and include the path to the file in the command. For more information, see Analyze Files and Projects.

Les règles sont organisées en fonction de leur ID unique, visibles également dans Paramètres d'analyseur de workflow (Workflow Analyzer Settings).

For example, in the image below only the Variables Naming Convention rule was enabled and received the ([A-Z]) Regex expression. This means that variable names must be uppercase. All the other rules were disabled in this example.

Analyser des fichiers et des projets

Après avoir configuré les règles, accédez à l'interface utilisateur de ligne de commande UiPath.Studio.CommandLine.exe.

Les commandes d'analyseur de workflow suivantes sont disponibles :

  • analyze : Analyse l'ensemble du projet. Requiert le chemin d'accès au fichier project.json.
  • analyze-file : Analyse un fichier unique. Requiert le chemin d'accès au fichier .xaml.

Les arguments suivants sont disponibles pour les commandes d'analyseur de workflow :

Argument

Description

-p, --project-path

For analyzing one file, provide the path to the .xaml. For analyzing the entire project, specify the path to the project.json file.

-c, --config-path

Path to the RuleConfig.json file. Specify this path only if the rule configuration file is not placed in the default location (%LocalAppData%\UiPath\Rules).

--help

View the arguments available for each command.

--version

Check the version of UiPath.Studio.CommandLine.exe.

Par exemple, la commande UiPath.Studio.CommandLine.exe analyze-file -p "C:\BlankProcess\Main.xaml" analyse un seul fichier dans un projet, Main.xaml. La sortie de la commande renvoie un dictionnaire codé json avec les informations suivantes pour chaque violation de règle :

  • FilePath : chemin d'accès au fichier analysé.
  • ErrorCode : ID de règle.
  • ActivityDisplayName : le nom d'affichage de l'activité (null si non applicable).
  • Item - Nom et type de l’élément (par exemple, une activité ou une variable) où le message d’erreur a été généré.
  • ErrorSeverity : valeur du paramètre DefaultAction, qui est le message de journal configuré pour chaque règle, soit Avertissement (Warning), Erreur (Error), Information (Info) ou Logs détaillés (Verbose).
  • Description : Description de la règle.
  • Recommendation et URL : modifications recommandées pour résoudre le problème, ainsi que le lien de documentation contenant plus d'informations.

Pour utiliser un fichier RuleConfig.json placé dans un emplacement personnalisé, ajoutez l’emplacement à la commande. En reprenant la commande précédente à titre d’exemple, pour configurer des règles avec le fichier situé dans C:\CustomFolder\RuleConfig.json, exécutez la commande comme suit : UiPath.Studio.CommandLine.exe analyze-file -c "C:\CustomFolder\RuleConfig.json" -p "C:\BlankProcess\Main.xaml".

Pour renvoyer le code de sortie de la commande, entrez echo %errorlevel% après l’exécution. Si aucun message n'affiche l’Erreur ErrorSeverity, le code 0 est retourné. Sinon, le code 1 est retourné.

Notez que certaines entrées peuvent ne pas être associées à une règle, mais peuvent être des erreurs générées par l'analyseur de workflow. Par exemple, dans le cas d'un fichier .xaml vide, une erreur est affichée.

Les identificateurs uniques universels (GUID) utilisés comme préfixes pour une entrée sont générés à chaque exécution et s'appliquent uniquement au résultat actuel.

Exporter les résultats de l'analyseur de workflow

Pour configurer Studio afin d'exporter les résultats de chaque analyse de workflow vers le dossier du projet, accédez au mode Backstage de Studio (Studio Backstage View) > Paramètres (Settings) > Conception (Design) et activez l'option Exporter les résultats de l'analyseur (Export Analyzer results).

Lorsque cette option est activée, les résultats de chaque analyse de workflow sont enregistrés dans le sous-dossier \.local\.analysis\ du dossier du projet, dans un fichier dont le nom est constitué de l'horodatage de l'analyse suivi soit de project_analysis_results.json (lorsque l'option Analyser le projet est utilisée) ou file_analysis_results.json (lorsque l'option Analyser le fichier est utilisée).

📘

Remarque :

Le dossier .local est masqué. Vous pouvez activer l'affichage des éléments masqués à partir des paramètres de l'explorateur de fichiers Windows.

Les fichiers contiennent les informations suivantes sur chaque règle activée :

  • RuleId – l'identifiant de règle.
  • RuleName - Le nom de la règle.
  • Parameters - Les paramètres dans la règle pouvant être personnalisés, le cas échéant.
  • Severity - L'action de la règle, si la règle est violée.
  • ErrorsDescription - Liste des messages d’erreur générés par la règle, le cas échéant.

Enforcing the Workflow Analyzer before Run, Publish, or Push/Check in

You can prevent executing, publishing, and pushing/checking in to remote repositories projects that contain Workflow Analyzer errors by enabling the following options from Studio Backstage View > Settings > Design:

  • Appliquer l’Analyseur avant la publication - Chaque fois que l’exécution ou le débogage d’un fichier ou d’un projet est lancé, l’Analyseur de workflow vérifie toutes les règles avec l’action Error, et l’exécution n’est autorisée que si aucune erreur n’est trouvée.
  • Appliquer l'Analyseur avant la publication - Chaque fois que la publication est lancée, l’Analyseur de workflow vérifie toutes les règles activées indépendamment de leur action et la publication n’est autorisée que si l’action Error ne trouve aucune violation de règles.
  • Enforce Analyzer before Push/Check-in - Whenever sending a project to a remote repository is initiated (Commit and Push for GIT, Check in for SVN and TFS), the Workflow Analyzer checks all enabled rules regardless of their action and the operation is allowed only if there are no rule violations with the action Error.

Quand Appliquer l’analyseur avant la publication est activé et si la publication est réussie ( l’action Error ne constate pas de violation des règles), les résultats de l’analyse du workflow sont inclus dans le package publié .nupkg dans le fichier project_analysis_results.json situé dans \lib\net45\.analysis\. Le fichier contient les informations suivantes sur chaque règle activée :

  • RuleId – l'identifiant de règle.
  • RuleName - Le nom de la règle.
  • Parameters - Les paramètres dans la règle pouvant être personnalisés, le cas échéant.
  • Severity - L'action de la règle (si la règle est violée).
  • ErrorsDescription - Liste des messages d’erreur générés par la règle, le cas échéant.

Mis à jour il y a 2 mois


À propos de l'analyseur de workflow


Les modifications suggérées sont limitées sur les pages de référence de l'API

Vous pouvez uniquement suggérer des modifications au contenu du corps de Markdown, mais pas aux spécifications de l'API.