Debugging Your Automation Project

Le débogage est le processus d'identification et de suppression des erreurs qui empêchent le projet de fonctionner correctement. Il est recommandé d'effectuer le débogage pendant la phase de conception du projet d'automatisation, au niveau de l'activité, du fichier et du projet.

Debugging can be performed using several options, defined in the ribbon and explained below.

Démarrer le débogage

To start debugging your project, click the Debug tab to access the debugging options available in StudioX. You can start the debug process by clicking Debug ribbon button or using F5.

The default action under the Run/Debug ribbon button can be configured from Backstage View > Settings > Design > Run/Debug Default Behavior option. Pick from Debug File, Run File, Debug Project, or Run Project, as the default action when clicking the button.

Actions de débogage

StudioX provides several different actions to help with the debugging process, located in the Debug ribbon tab.

Next Step

Use Next Step to debug activities one at a time. When this action is triggered, the debugger opens and highlights the activity before it is executed. The keyboard shortcut for Next Step is F11.

Réessayer

Retry re-executes the previous activity, and throws the exception if it's encountered again. The activity which threw the exception is highlighted and details about the error are shown in the Debugging panel.

Ignorer

The Ignore action can be used to ignore an encountered exception and continue the execution from the next activity so that the rest of the project can be debugged.

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

Restart is available after an exception was thrown and the debug process is paused. The action is used for restarting the debugging process from the first activity of the project.

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.

Points d'arrêt (Breakpoints)

Breakpoints are used to purposely pause the debugging process on an activity which may trigger execution issues. You can set a condition and/or hit count to a simple breakpoint and turn it into a conditional one. Adding logging results turns the conditional breakpoint in a conditional tracepoint. Adding only a logging message transforms the breakpoint to a simple tracepoint.

Read more about Breakpoints and how to use them in our in the StudioX guide.

Arrêter (Break)

Break allows you to pause the debugging process at any given moment. The activity which is being debugged remains highlighted when paused. Once this happens, you can choose to Continue, Next Step, or Stop the debugging process.

Piste d'exécution

The Execution Trail ribbon button is disabled by default. When enabled, it shows the exact execution path at debugging. As the process is executed, each activity is marked in the Designer panel, showing you the execution as it happens:

• executed activities are marked in green;
• partially executed activities are marked in orange;
• activities that threw an exception are marked in red.

• les activités qui n’ont pas été exécutées ne sont pas marquées;

  
  

  

  
  

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)

If enabled, debugged activities are displayed as Trace logs in the Output panel. Note that the Highlight Elements and Log Activities options can only be toggled before debugging, and persist when reopening the automation project.

Logs are automatically sent to Orchestrator if connected, but you can have them stored locally by disabling the Allow Development Logging option from the Robot Settings tab in the Add or Edit user window.

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.

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 :

Continuer sur exception

This debugging feature is disabled by default. When disabled in the ribbon, it throws the execution error and stops the debugging, highlights the activity which threw the exception, and logs the exception in the Output panel.

When enabled, the exception is logged in the Output panel and the execution continues.

Ouvrir les journaux (Open Logs)

Clicking Open Logs brings up the %localappdata%\UiPath\Logs folder where logs are locally stored. The naming format of log files is YYYY-DD-MM_Component.log (such as 2018-09-12_Execution.log, or 2018-09-12_Studio.log). Read more about logging in the Studio guide.