Débogage à distance

Le comportement des automatisations peut différer selon la machine. Si la machine sur laquelle une automatisation s'exécutera en production a une configuration différente de celle de la machine sur laquelle elle a été conçue (par exemple, la machine a un matériel ou un logiciel différent, des autorisations différentes, ou bien elle se trouve dans un réseau isolé), le processus doit être testé et débogué avec le robot sur cette machine.

Le débogage à distance vous permet d'exécuter et de déboguer des processus assistés et non assistés pour des robots déployés sur des machines distantes, y compris pour des robots Linux pouvant exécuter des projets multiplateformes.

Vous pouvez vous connecter au robot distant en utilisant l'un des types de connexion suivants :

• Machine distante (Remote Machine) - Établissez une connexion TCP/IP avec le robot sur la machine distante.
• Robot non assisté (Unattended Robot) - Connectez-vous à un robot non assisté dans le même locataire en utilisant Orchestrator.

L'utilisation du débogage à distance nécessite que le projet soit ouvert dans Studio. Si vous utilisez le contrôle de code source, nous vous recommandons de vous assurer que vous travaillez avec la dernière version du projet en activant le paramètre de conceptionAppliquer l'archivage avant la publication (Enforce Check-In before Publish ) .

Remarque : vous ne pouvez pas effectuer de débogage à distance sur des automatisations codées.

Connexion de la machine distante

Pour exécuter ou déboguer un projet à l'aide d'une connexion à une machine distante :

1. Assurez-vous que toutes les conditions préalables sont remplies.
2. Sur la machine distante, configurez le robot pour qu'il accepte les requêtes de débogage à distance.

3. Si l'authentification interactive est appliquée dans Orchestrator et que vous souhaitez exécuter ou déboguer un processus de façon non assistée, assurez-vous que le robot distant remplit l'une des conditions suivantes :

   • Il est connecté à Orchestrator à l'aide de la connexion interactive.
   • Il est connecté à l'aide ded informations d’identification client ou de la clé de machine et un utilisateur est également connecté via l'Assistant.
   • Connecté à l'aide des informations d'identification du client ou de la clé de machine, aucun utilisateur n'est connecté à partir de l'Assistant et une session de résolution des problèmes est activée dans Orchestrator pour la machine. Pour plus d'informations, consultez Débogage des processus Unattended (Debugging Unattended Processes).

4. Dans Studio :

   1. Configurez une connexion au robot distant.
   2. Assurez-vous que l’exécution à distance est activée.
   3. Exécutez ou déboguez votre projet.

Prérequis

• Une connectivité TCP/IP existe entre la machine Studio et la machine distante.
• Le Robot distant est de la même version que Studio.

• L’infrastructure .NET compatible est installée sur votre machine distante.

Configurer le robot sur la machine distante

Avant que le robot distant puisse être utilisé pour le débogage, l'utilitaire UiPath.RemoteDebugging.Agent de cette machine doit être configuré de façon à accepter les demandes de débogage à distance de Studio :

1. Accédez au répertoire d'installation :

   • Pour un robot Windows - Ouvrez une invite de commande dans le dossier d'installation UiPath (par défaut %PROGRAMFILES%\UiPath\Studio pour les installations par machine, %localappdata%\Programs\UiPath\Studio pour les installations par utilisateur).
   • Pour un robot Linux - À partir d'un terminal de ligne de commande, accédez à /root/application.
   • Pour un robot macOS : à partir de zsh, accédez à /Applications/UiPath Assistant.app/Contents/Robot.

2. Exécutez la commande suivante :

   • Pour un robot Windows - UiPath.RemoteDebugging.Agent.exe enable --port <port_number> --password <pasword> --verbose
   • Pour un robot Linux - ~/application # dotnet ./UiPath.RemoteDebugging.Agent.dll enable --port <port_number> --password <pasword> --verbose
   • Pour un robot macOS : dotnet UiPath.RemoteDebugging.Agent.dll enable --port <port_number> --password <pasword> --verbose

     Les arguments de la commande sont tous facultatifs :

   • --port <port_number> - Saisissez le port à utiliser pour recevoir les commandes de débogage à distance de Studio. Si aucun port n'est fourni, le port 8573 sera utilisé par défaut.

     Le port doit être ouvert dans le pare-feu et ne doit pas être déjà lié à une autre application.

   • --password <password> - Saisissez un mot de passe qui devra ensuite être saisi dans Studio lors de la configuration de la connexion à l'agent de débogage à distance.
   • --verbose - Enregistrez des informations supplémentaires dans la console.

3. Le message suivant s'affiche :

   Robot on machine <hostname> is waiting for remote debugging instructions on port <port_number>

4. Notez les valeurs de nomhôte (hostname) et numéro_port (port_number) : elles devront être fournies lors de la configuration de la connexion dans Studio.

Aucune tâche assistée ou non assistée ne peut être exécutée à partir d'Orchestrator ou de l'Assistant local lorsque le robot se trouve dans un état de débogage à distance. Vous pouvez envoyer des commandes de débogage à distance même à des machines sur lesquelles l'installation du robot n'est pas sous licence.

Configuration d'une connexion à une machine distante

1. Dans Studio, sélectionnez l'onglet Déboguer (Debug).
2. Dans le ruban, sélectionnez la flèche sous Débogage à distance (Remote Debugging), puis sélectionnez Configurer le débogage à distance (Configure Remote Debugging) pour ouvrir la fenêtre Paramètres de débogage à distance (Debugging Settings).
3. Dans la liste déroulante Type de connexion (Connection Type), sélectionnez Machine distante (Remote Machine).

4. Fournissez les informations suivantes dans les cases correspondantes :

   • Hôte - Le nom d'hôte ou l'adresse IP de la machine distante.
   • Port - Le port à utiliser. Le port par défaut est 8573.
   • Mot de passe - Le mot de passe fourni lorsque l'agent de débogage à distance a été configuré sur la machine robot, le cas échéant.
5. (Facultatif) Pour vous assurer qu'une connexion peut être établie avec la configuration actuelle, cliquez sur Tester la connexion (Tester la connexion).

6. Cliquez sur Enregistrer (Save).

   
   

   

   
   

Connexion au robot non assisté (Unattended Robot)

Pour exécuter ou déboguer à distance un projet à l'aide d'un robot non assisté (Unattended Robot) connecté à Orchestrator :

1. Assurez-vous que toutes les conditions préalables sont remplies.
2. Configurez une connexion au robot distant.
3. Assurez-vous que l’exécution à distance est activée.
4. Exécutez ou déboguez votre projet.

Prérequis

• Studio et le robot cible sont connectés au même locataire Orchestrator.
• Le Robot distant est de la même version que Studio.
• Studio, le robot cible et Orchestrator exécutent la version 2021.10 ou ultérieure.
• L'utilisateur connecté à Studio est autorisé à démarrer des tâches, ainsi qu'à créer et supprimer des compartiments de stockage et des fichiers de stockage dans le même contexte de dossier que le robot cible. En outre, le compte robot doit disposer d'autorisations de consultation pour les compartiments de stockage et les fichiers de stockage.

• Le robot Unattended est configuré et la machine dispose de l'une des licences de runtime suivantes : Unattended, NonProduction ou Test (Testing).

  Remarque : les runtimes Testing pour le débogage à distance sont pris en charge dans Orchestrator 2022.4 et les versions supérieures.
• Pour le débogage des processus de premier plan, l'option Exécuter les automatisations de premier plan (Run foreground automations) est activée pour le robot dans Orchestrator.
• Si une session de résolution des problèmes est utilisée, elle ne doit être activée qu'après avoir connecté le robot à Orchestrator.

Configurer la connexion à un robot non assisté (Unattended Robot)

1. Dans Studio, sélectionnez l'onglet Déboguer (Debug).
2. Dans le ruban, sélectionnez la flèche sous Débogage à distance (Remote Debugging), puis sélectionnez Paramètres de débogage à distance (Remote Debugging Settings).
3. Dans la liste déroulante Type de connexion (Connection Type), sélectionnez Robot non assisté (Unattended Robot).

4. Pour utiliser une machine connectée disponible dans le dossier Orchestrator sélectionné depuis la barre d'état de Studio, cliquez sur Enregistrer (Save). Pour sélectionner la machine à laquelle vous souhaitez vous connecter, utilisez les options suivantes :

   • Utilisateur - Sélectionnez un compte avec un robot non assisté (Unattended Robot) affecté au dossier Orchestrator.
   • Machine - Sélectionnez une machine ou un modèle dans le dossier Orchestrator.

   • Nom d'hôte - Sélectionnez une machine dans la liste des machines connectées.

   • Afficher la diffusion en direct : sélectionnez cette option pour voir les actions effectuées par le robot. Pour plus d'informations, consultez la section Diffusion en direct et contrôle à distance.

     Remarque : si des modifications sont apportées à la configuration du compte dans Orchestrator, actualisez la connexion Orchestrator via le bouton de la barre d'état de Studio afin qu'elles soient répercutées dans cette fenêtre.
     
     

     

     
     

Exécution à distance

Lorsqu'une connexion de débogage à distance est établie, cliquer sur le bouton Débogage à distance (Remote Debugging) dans le ruban permet de basculer entre l'exécution à distance et l'exécution locale. Avant de sélectionner une opération d'exécution ou de débogage, assurez-vous que l'option souhaitée est activée (soit à distance, soit locale).

• Tant que le bouton est surligné en gris, toutes les opérations d'exécution et de débogage (Déboguer le fichier (Debug File), Exécuter le fichier (Run File), Déboguer le projet (Debug Project), Exécuter le projet (Run Project), Pas à pas détaillé/principal/sortant (Step Into/Over/Out), Activité de test (Test Activity), Accéder à/Exécuter à partir de cette activité (Run to/from this activity)) sont effectuées sur le robot distant.

  
  

  

  
  

• Tant que le bouton n'est pas surligné en gris, toutes les opérations d'exécution et de débogage sont effectuées sur le robot local.

  
  

  

  
  

L'expérience de débogage à distance est similaire à l'expérience de débogage local ; toutes les fonctionnalités disponibles pour le débogage local sont également disponibles pour le débogage à distance. Lorsqu'une exécution à distance déclenchée à partir de l'onglet Déboguer est en cours, la barre d'état de Studio est colorée en vert .

Selon le type de connexion utilisé pour le débogage à distance, le robot distant obtient les packages d'activités nécessaires à l'exécution d'un projet comme suit :

• Connexion à une machine distante (Remote machine connection) - Studio envoie la liste des dépendances du projet et des flux d'activité (sources des packages) au robot distant, qui utilise les flux fournis par Studio pour télécharger les packages requis.
• Connexion à un robot non assisté (Unattended Robot connection) : Studio envoie uniquement la liste des dépendances du projet au robot distant, qui utilise les flux Orchestrator et les flux d’activité configurés sur le robot distant pour télécharger les packages requis.

Pour une connexion Robot Unattended, la sélection Afficher la diffusion en direct vous permet de visualiser les actions que le robot effectue en temps réel. Lors de l'exécution à distance, une nouvelle fenêtre de diffusion en direct s'ouvre, que vous pouvez déplacer et redimensionner. Vous pouvez également prendre le contrôle à distance sans interrompre l'automatisation pour un débogage approfondi ou si l'exécution est bloquée (par exemple, par un élément d'IU sur lequel vous devez cliquer). La fenêtre de diffusion en direct disparaît dès la fin du workflow. Bien qu'aucune action supplémentaire ne soit nécessaire pour les Automation Cloud Robots sans serveur, les robots Windows nécessitent quant à eux qu'un serveur VNC soit configuré.

Remarque : il n’est pas recommandé de vous déconnecter de votre compte durant le débogage à distance.

Limites connues

• Lorsque vous utilisez une connexion à une machine distante, si vous suspendez le débogage pendant une période prolongée, une erreur Connexion fermée (Connection Closed) peut se produire dans Studio même si la connexion semble être toujours active sur la machine distante. Pour éviter ce problème, vous pouvez augmenter le délai d'inactivité TCP dans votre équilibreur de charge cloud ou local.
• Le débogage à distance des workflows de longue durée est uniquement pris en charge pour les connexions de robot Unattended.
• Lorsque vous utilisez une connexion à un robot non assisté (Unattended Robot), la sélection de l'option Incrustation d'image (Picture in Picture) n'a pas pour effet de démarrer l'exécution dans une session distincte.
• L'option Afficher la diffusion en direct ne fonctionne que si le service de robot UiPath du Unattended Robot est déployé en mode service. Pour plus d'informations, consultez la section Service de robot UiPath.
• L'option Afficher la diffusion en direct est uniquement prise en charge pour Automation Cloud Orchestrator et Automation Suite Orchestrator.

Fermeture d'une connexion de débogage à distance

Pour désactiver la connexion de débogage à distance, ouvrez la fenêtre Paramètres de débogage à distance (Remote Debugging Setting) lorsqu'aucune exécution de débogage n'est en cours, définissez le Type de connexion (Connection Type) sur Désactivé (Disabled), puis sélectionnez Enregistrer (Save).