Actions de débogage

Le débogage d’un seul fichier ou de l’ensemble du projet peut être effectué depuis les onglets Conception (Design) ou Débogage (Debug) du ruban. En revanche, le processus de débogage n'est pas disponible si les fichiers projet contiennent des erreurs de validation.

Pas à pas détaillé (Step into)

Utilisez Pas à pas détaillé (Step Into) pour déboguer les activités une à la fois. Lorsque cette action est déclenchée, le débogueur s'ouvre et met en surbrillance l'activité avant son exécution.

Lorsque Pas à pas détaillé (Step Into) est utilisé avec les activités Invoke Workflow File, le workflow est ouvert dans un nouvel onglet en mode ReadOnly et chaque activité est exécutée une par une.

Le raccourci clavier pour Pas à pas détaillé (Step Into) est F11.

Pas à pas principal (Step over)

Contrairement à l'action Pas à pas détaillé (Step Into), Pas à pas principal (Step Over) n'ouvre pas le conteneur actuel. Lorsque vous l'utilisez, l'action débogue l'activité suivante, met en surbrillance les conteneurs (tels que les organigrammes, les séquences ou les activités Invoke Workflow File) sans les ouvrir.

Cette action s'avère utile pour ignorer l'analyse de grands conteneurs qui ne risquent pas de déclencher de problèmes lors de l'exécution.

Pas à pas principal (Step Over) est disponible à l'aide du raccourci clavier F10.

Pas à pas sortant

Comme son nom l'indique, cette action est utilisée pour sortir du pas à pas et suspendre l'exécution au niveau du conteneur actuel. Pas à pas sortant (Step Out) termine l'exécution des activités dans le conteneur actuel, avant de suspendre le débogage. Cette option fonctionne bien avec les séquences imbriquées.

Pas à pas sortant (Step Out) est disponible à l'aide du raccourci clavier Maj + F11.

Réessayer

L'option Réessayer (Retry) réexécute l'activité précédente et lève l'exception si elle est à nouveau rencontrée. L'activité qui a levé l'exception est mise en surbrillance et des informations sur l'erreur sont affichées dans les panneaux Variables locales (Locals) et Pile d'appels (Call Stack).

Ignorer

L'action Ignorer (Ignore) peut être utilisée pour ignorer une exception rencontrée et poursuivre l'exécution à partir de l'activité suivante afin que le reste du workflow puisse être débogué.

Cette action est utile pour contourner l'activité qui a levé l'exception et poursuivre le débogage de la partie restante du projet.

Redémarrer

L'option Redémarrer (Restart) est disponible après qu'une exception est levée et que le processus de débogage est suspendu. L'action est utilisée pour le redémarrage du processus de débogage à partir de la première activité du projet. Utilisez Pas à pas lent (Slow Step) pour ralentir la vitesse de débogage et inspecter correctement les activités à mesure de leur exécution.

Notez que lorsque vous utilisez cette option après Exécuter à partir de cette activité (Run from this Activity), le débogage est redémarré à partir de l'activité auparavant indiquée.

Arrêter (Break)

Interrompre (Break) permet de suspendre le processus de débogage à un moment donné. L'activité en cours de débogage reste en surbrillance lorsqu'elle est interrompue. Une fois que cela arrive, vous pouvez choisir Continuer (Continue), Pas à pas détaillé (Step Into), Pas à pas principal (Step Over) ou Arrêter (Stop) le processus de débogage.

Il est recommandé d'utiliser Interrompre (Break) avec Pas à pas lent (Slow Step) pour savoir exactement lorsque le débogage doit être suspendu.

Une alternative à l'utilisation de l'option Étape lente (Slow Step) dans ce cas est de surveiller le panneau Sortie (Output) et d'utiliser Break dans l'activité en cours de débogage.

Cibler

L'option Cibler le point d'exécution (Focus Execution Point) aide à revenir au point d'arrêt ou à l'activité en cours qui a entraîné une erreur lors du débogage. Le bouton Cibler (Focus) est utilisé après avoir navigué dans le processus, comme méthode simple pour revenir à l'activité qui a entraîné l'erreur et reprendre le processus de débogage.

Sinon, lorsque le débogage est suspendu, car un point d'arrêt a été atteint, l'option Cibler (Focus) permet de revenir au point d'arrêt indiqué, après avoir navigué dans les activités contenues dans le processus d'automatisation.

Un troisième cas est utilisé lorsque le débogage est suspendu après avoir utilisé Pas à pas détaillé (Step Into) ou Pas à pas principal (Step Over) et après avoir navigué dans le processus. Dans ce cas, l'option Cibler (Focus) permet de revenir à l'activité qui a suspendu le processus de débogage.

Depuis le menu contextuel Points d'arrêt (Breakpoints), vous pouvez sélectionner Focus (Focus) pour mettre en surbrillance l'activité avec le point d'arrêt.

Étape lente (Slow Step)

Pas à pas lent (Slow Step) permet d'examiner de plus près les activités lors du débogage. Tandis que cette action est activée, les activités sont surlignées dans le processus de débogage. En outre, les conteneurs tels que les organigrammes, les séquences ou les activités Invoke Workflow File) s'ouvrent. Cette étape est semblable à l'utilisation de l'option Pas à pas détaillé (Step Into), mais sans devoir suspendre le processus de débogage.

L'option Étape lente (Slow Step) peut être activée avant ou pendant le processus de débogage. L'activation de l'action ne suspend pas le débogage.

Bien qu'elle soit appelé Étape lente (Slow Step), l'action s'effectue à l'aide de 4 vitesses différentes. L'étape de vitesse sélectionnée exécute le processus de débogage plus lentement que la précédente. Par exemple, le débogage en utilisant Étape lente (Slow Step) à 1x l'exécute à la vitesse la plus lente, et à la vitesse la plus rapide à 4x. En d'autres termes, la vitesse dicte la rapidité à laquelle le débogueur passe d'une activité à la suivante.

Chaque fois que vous cliquez sur Étape lente (Slow Step), la vitesse change d'une étape. Vous pouvez facilement le savoir par l'icône, qui est mise à jour en conséquence.

Piste d'exécution

Le bouton ruban Piste d'exécution est désactivé par défaut. Lorsqu’il est activé, il affiche le chemin d’exécution exact lors du débogage. Au fur et à mesure que le processus est exécuté, chaque activité est mise en surbrillance et marquée dans le panneau Designer, vous montrant l’exécution telle qu’elle se produit :

• les activités exécutées sont marquées et mises en évidence en vert;
• les activités qui n’ont pas été exécutées ne sont pas marquées;

• les activités qui ont déclenché une exception sont marquées et mises en évidence en rouge.

  
  

  

  
  

Surligner les éléments (Highlight Elements)

Si cette option est activée, les éléments d'IU sont surlignés lors du débogage. Vous pouvez utiliser cette option avec le débogage normal et pas à pas.

Consigner les activités (Log Activities)

Si cette option est activée, les activités déboguées s'affichent en tant que Journaux de suivi dans le panneau Sortie (Output). Notez que les options Surligner les éléments (Highlight Elements) et Consigner les activités (Log Activities) ne peuvent être activées/désactivées qu'avant le débogage, et sont conservées lors de la réouverture du projet d'automatisation. Cela n'est pas applicable pour les workflows invoqués, sauf si ces fichiers sont ouverts dans le panneau Concepteur (Designer).

Les journaux sont automatiquement envoyés à Orchestrator si connecté, mais vous pouvez les stocker localement en désactivant l'option Autoriser la consignation du développement (Allow Development Logging) dans l'onglet Paramètres du Robot (Robot Settings) de la fenêtre Ajouter ou modifier un utilisateur (Add or Edit user).

La désactivation de l'option Consigner les activités (Log Activities) peut être une méthode d'envoi de fichiers journaux plus petits à Orchestrator.

Remarque : lors de l'exécution de processus à partir de Studio, les journaux envoyés à Orchestrator sont toujours Trace lorsque Log Activities est désactivé et Verbose lorsque Log Activities est activé. Cela remplace à la fois le paramètre Robot et le paramètre Orchestrator.

Par défaut, le débogueur consigne les activités pour que chaque étape s'affiche dans le panneau Sortie (Output). Nous recommandons de laisser cette option activée pour simplifier le traçage, comme vous pouvez le voir sur l'image ci-dessous :

Le problème ici est qu'un ou plusieurs champs d'entrée provenant de la séquence Entrée utilisateur sont vides. Cela est une condition True pour l'activité Flow Decision. Vous pouvez le savoir par le fait que, lors du débogage, la séquence Entrée utilisateur est exécutée deux fois. Cela implique qu'un ou plusieurs champs sont restés vides lors de la première exécution.

Si vous décidez de désactiver l'option Consigner les activités (Log Activities) pour le débogage, les journaux de suivi ne s'affichent pas dans le panneau Sortie (Output). En cas d'exécution normale sans erreur, vous pouvez uniquement voir les heures de début et de fin de l'exécution du débogage. En revanche, l'ajout d'une activité Log Message peut aider à déterminer l'origine des problèmes.

Par exemple, vous pouvez ajouter une activité Log Message pour vous informer que, dans ce cas, un ou plusieurs champs d'entrée sont vides. Ce message s'affiche dans le panneau Sortie (Output) lors du débogage, même si l'option Consigner les activités (Log Activities) est désactivée, comme vous pouvez le voir ci-dessous :

Veillez à toujours filtrer les messages affichés dans le panneau Sortie (Output) en sélectionnant simplement les types d'alertes d'intérêt, voire supprimer tous les messages.

Notez que par défaut, tous les journaux de débogage sont envoyés à Orchestrator. Vous pouvez désactiver cette option en décochant l'option Autoriser la journalisation du développement (Allow Development Logging) dans l'onglet Paramètres (Settings) de la fenêtre Ajouter ou Modifier un robot (Add ou Edit Robot). Si cette option est désactivée, les journaux de débogage sont uniquement stockés localement.

Continuer sur exception

Cette fonction de débogage est désactivée par défaut. Lorsqu’elle est désactivée dans le ruban, elle lance l’erreur d’exécution et arrête le débogage, met en évidence l’activité qui a déclenché l’exception, et enregistre l’exception dans le panneauSortie. Si un gestionnaire d’exception global a déjà été défini dans le projet, l’exception est transmise au gestionnaire.

Lorsqu’elle est activée, l’exception est enregistrée dans le panneau Sortie, l’exécution se poursuit.

Incrustation d’image

L'option de ruban Incrustation d'image de l'onglet Débogage permet l'exécution et le débogage de processus ou de bibliothèques dans une session distincte sur votre ordinateur.

Si cette option est activée, chaque fois que vous sélectionnez Exécuter (Run) ou Exécuter le fichier (Run File), Déboguer (Debug) ou Déboguer le fichier (Debug File), le processus démarre dans une session distincte ou sur un poste de travail virtuel dans la session utilisateur. Si Incrustation d'image (Picture in Picture) est désactivé, le débogage et l’exécution sont effectués dans la session en cours.

Avoir la possibilité d'exécuter un processus dans Incrustation d'image (PiP) peut s'avérer très utile dans l'automatisation assistée. Vérifiez si un processus s'exécute avec succès dans PiP, puis mettez à jour les paramètres du projet pour indiquer si ce dernier peut être exécuté à l'aide de cette fonctionnalité après sa publication :

1. Dans le panneau Projet, cliquez sur Paramètres pour ouvrir la fenêtre Paramètres du projet.

2. Dans l'onglet Général :

   • Options d'incrustation d'image (PiP Options) : indiquez si le projet a été testé en utilisant le mode Incrustation d'image (Picture in Picture) et s'il doit démarrer par défaut dans ce mode.

     • Testé pour l'utilisation de l'incrustation d'image ; Démarre en incrustation d'image (Tested for PiP usage; Starting in PiP) : l'automatisation en mode incrustation d'image a été validé. Elle démarrera donc par défaut dans ce mode lors de son exécution.
     • Testé pour l'utilisation de l'incrustation d'image ; Ne démarre pas avec l'incrustation d'image activée par défaut (Tested for PiP usage; Not starting in PiP by default) : l'automatisation en mode incrustation d'image a été validé. Lorsque le projet d'automatisation est exécuté, il démarre par défaut dans la session principale ou sur le poste de travail.
     • Non testé pour l'utilisation de l'incrustation d'image (Not tested for PiP usage) : l'automatisation n'a pas été approuvée pour s'exécuter en mode incrustation d'image. Lorsque le projet d'automatisation est exécuté, il démarre par défaut dans la session principale ou sur le poste de travail. S'il est exécuté en mode incrustation d'image, une boîte de dialogue informe l'utilisateur qu'il n'a pas été testé à l'aide de cette fonctionnalité et lui demande confirmation avant de continuer.
   • Type d'incrustation d'image (PiP Type) : sélectionnez comment isoler l'automatisation de la session utilisateur lors de l'exécution du projet en mode incrustation d'image : Nouvelle session (New Session), (session enfant sur la machine) ou Nouveau poste de travail (New Desktop) (poste de travail virtuel dans la session utilisateur).

Pour en savoir plus, notamment sur les limitations de cette fonctionnalité, voir Incrustation d'image dans le Guide du robot.

Débogage à distance

Lorsque cette fonctionnalité est activée, toutes les opérations d'exécution et de débogage sont effectuées sur un robot distant spécifié au lieu du robot installé localement, vous permettant de tester l'automatisation dans différents environnements. Pour plus d'informations, consultez la section Débogage à distance (Remote Debugging).

Profiler l'exécution

Vous pouvez identifier les goulots d'étranglement des performances dans le workflow lorsque vous déboguez le fichier. Pour en savoir plus, consultez la section Exécution de profil (Profile Execution).

Ouvrir les journaux (Open Logs)

Cliquer sur Ouvrir les journaux (Open Logs) ouvre le dossier %localappdata%\UiPath\Logs dans lequel les journaux sont stockés localement. Le format de nommage des fichiers journaux est YYYY-DD-MM_Component.log (tel que 2018-09-12_Execution.log ou 2018-09-12_Studio.log). Pour en savoir plus sur la journalisation, cliquez ici.