Extraits de débogage

Cette page concerne Desktop Studio. Actuellement, CXone Studio ne prend pas en charge les options décrites sur cette page.

Vous pouvez déboguer les snippets à partir de la fenêtre de l'Éditeur de snippets de Snippet . Le débogueur vous permet de voir les variables dans le code snippet. Cela peut vous aider à résoudre des problèmes dans votre code. Cinq options sont disponibles pour déboguer les snippets :

En outre, si votre code contient des objets dynamiques ou des tableaux, vous pouvez voir leur contenu et la façon dont il change.

Image de la fenêtre Propriétés de l'extrait de code, affichant les différents éléments de débogage.

Vérification de la syntaxe d’un snippet

Vous pouvez demander à Studio de vérifier la syntaxe d'un snippet.

  1. Dans Studio, ouvrez un script contenant une action Snippet.
  2. Double-cliquez sur l'action Snippet.
  3. Ajoutez le code Snippet dans l'onglet Text View , s'il n'en contient pas déjà.

  4. Cliquez sur l'icône Check Syntax en bas de la fenêtre de l'éditeur Snippet .

    Si aucune erreur de syntaxe n'est trouvée, le champ de statut situé à côté de l'icône Vérifier la syntaxe affiche le message Okay.

    Si des erreurs de syntaxe sont détectées, un message d'erreur descriptif s'affiche. La description comprend le numéro de ligne où se trouve l'erreur. En outre, le champ de statut situé à côté de l'icône Vérifier la syntaxe affiche le message Error at line [#].

  5. Corrigez les éventuels problèmes de syntaxe détectés.
  6. Vous pouvez sélectionner une ou plusieurs lignes dans le code snippet et cliquer sur l'icône Comment out selected lines . Cette fonction est utile si vous souhaitez sauter une erreur et en rechercher d’autres erreurs.
  7. Vous pouvez sélectionner une ou plusieurs lignes commentées dans le code du snippet et cliquer sur l'icône Uncomment the selected lines .

Utilisation de l'outil de débogueur

  1. Dans Studio, ouvrez un script contenant une action Snippet.
  2. Double-cliquez sur l'action Snippet.
  3. Add Snippet code on the Text View tab, if it doesn't already contain some.
  4. On the right side of the Snippet editor window, click the Debugger tab.
  5. Click the down-arrow button on the right side of the Debug icon An icon of a window with a green right-facing triangle. On the right side of the icon is a down-facing black triangle that opens a drop-down menu. and select StartAn icon of a green play button triangle..

  6. If there are any syntax errors in the code, the Snippet editor window expands. All errors in the code appear in a pane at the bottom of the window. If there are no errors, skip to the next step.

    The Snippet editor window, showing the errors pane at the bottom of the window.
    1. Correct the errors.
    2. When the errors have been corrected, click the Close or Clear Trace Output icons An X. to close the error pane.
    3. Start the debugger again.
  7. View the contents of the Variables as Text tab. The tab shows the variables and their values when all of the code has been executed if you didn't set a breakpoint.
  8. You can select one or more lines in the snippet code and click the Comment out selected lines icon An icon with open and closed angle brackets next to each other with a blue forward slash between them.. This is helpful if you want to remove some code to see how the outcome of the debugging changes.
  9. You can select one or more lines of commented-out code and click the Uncomment the selected lines icon An icon with open and closed angle brackets next to each other with a forward slash between them. A large red forward slash crosses the other characters. to add those lines back into the snippet.

Débogage avec un point d'arrêt

Vous pouvez définir un point d'arrêt si vous souhaitez que le débogage s'arrête à une ligne spécifique du code de du snippet. Cela vous permet de voir les variables et les valeurs à mi-chemin du snippet sans avoir à le faire défiler ligne par ligne.

  1. Dans Studio, ouvrez un script contenant une action Snippet.
  2. Double-cliquez sur l'action Snippet.
  3. Add Snippet code on the Text View tab, if it doesn't already contain some.

  4. Click in the column to the left of the line numbers in the Snippet editor window. A red circle appears at that line number.

    Image showing the red sphere and highlighted red line of code of a breakpoint.
  5. On the right side of the Snippet editor window, click the Debugger tab.
  6. Click the down-arrow button on the right side of the Debug icon An icon of a window with a green right-facing triangle. On the right side of the icon is a down-facing black triangle that opens a drop-down menu. and select StartAn icon of a green play button triangle..

  7. If there are any syntax errors in the code, the Snippet editor window expands. All errors in the code appear in a pane at the bottom of the window. If there are no errors, skip to the next step.

    The Snippet editor window, showing the errors pane at the bottom of the window.
    1. Correct the errors.
    2. When the errors have been corrected, click the Close or Clear Trace Output icons An X. to close the error pane.
    3. Start the debugger again.
  8. View the contents of the Variables as Text tab. The tab shows the variables and their values at the breakpoint, if you set one. The line where the debugging paused for the breakpoint is highlighted in the Snippet Editor window.
  9. If you're done with the breakpoint, click the red circle again to clear it.
  10. Set another breakpoint, if you need one.
  11. To continue debugging from the breakpoint, click the Resume icon An icon of a green play triangle..
  12. To stop debugging, click the Stop Debugging A black square. icon.

Défilement dans le code de snippet

Vous pouvez utiliser l'outil de débogage pour faire défiler le code de snippet par ligne. Cela vous permet de voir comment les variables et leurs valeurs changent au fur et à mesure de l'exécution de chaque ligne.

  1. Dans Studio, ouvrez un script contenant une action Snippet.
  2. Double-cliquez sur l'action Snippet.
  3. Add Snippet code on the Text View tab, if it doesn't already contain some.
  4. On the right side of the Snippet editor window, click the Debugger tab.
  5. Click the down-arrow button on the right side of the Debug icon An icon of a window with a green right-facing triangle. On the right side of the icon is a down-facing black triangle that opens a drop-down menu. and select StartAn icon of a green play button triangle..

  6. If there are any syntax errors in the code, the Snippet editor window expands. All errors in the code appear in a pane at the bottom of the window. If there are no errors, skip to the next step.

    The Snippet editor window, showing the errors pane at the bottom of the window.
    1. Correct the errors.
    2. When the errors have been corrected, click the Close or Clear Trace Output icons An X. to close the error pane.
    3. Start the debugger again.
  7. View the contents of the Variables as Text tab. It displays the variables in the code and their values when the snippet code starts.
  8. Click the Step icon An icon to move to the next line in the snippet.
  9. Repeat steps the preceding two steps for each line in the snippet.
  10. If you want to skip the remaining lines of code, click the Resume icon An icon of a green play button triangle.. The Variables as Text tab displays the variables and their values when all of the snippet code has executed.
  11. To stop debugging, click the Stop Debugging A black square. icon, then repeat this process starting from step 3.

Consultation du contenu des objets dynamiques et des tableaux

You can view the contents of dynamic objects in the Snippet editor window when you run the debugger. This allows you to verify that the object holds the data it's supposed to at each step in your code.

  1. In Studio, double-click on a Snippet action.
  2. Add snippet code, if necessary.
  3. On the Debugger tab, click the Variables as Tree tab.
  4. On the Debugger tab, click the down arrow next to the Start Debugging icon An image of a triangular green play buttonand select Step Into A series of horizontal lines with an arrow pointing from one line to the one beneath it.. If you don't want to step through the code line by line, click the Start Debugging icon.
  5. Click the Step A series of horizontal lines with an arrow pointing from one line to the one beneath it. icon and observe the contents on the Variables as Tree tab. Each time you click Step, this field updates with the variables and objects in the script after the previous line of code. Skip this step if you clicked Start Debugging.
  6. When you have stepped through all lines of code or if you clicked Start Debugging, the Variables as Tree tab displays all variables, objects, and their contents at the end of the snippet.

  7. You can click the + icon next to any string arrays or dynamic objects in the code to expand them. If the content is another array or object, you can continue to expand the tree to see what each entity contains.

    The Snippet editor window in debug mode, showing the contents of objects and arrays on the Variables as Tree tab.

Débogage à l'aide de TRACE

Le mot-clé TRACE vous permet de déboguer en utilisant la journalisation. Ce mot-clé ne fonctionne que lors de l'utilisation de l'outil de débogage dans la fenêtre de l'éditeur Snippet . Lorsque vous l'incluez dans votre code d'extrait et que vous lancez le débogueur, le texte est affiché dans le volet Trace qui apparaît en bas de la fenêtre de l'éditeur Snippet .

Image de la fenêtre Propriétés de l'extrait de code, affichant les différents éléments de débogage.

Le mot-clé TRACE est ignoré en dehors de la fenêtre de l'Éditeur de snippets de Snippet . Il fonctionne uniquement avec l'outil de débogage.

La syntaxe est la suivante : TRACE "<text>"

Le texte entre guillemets doubles est affiché dans la fenêtre de l'éditeur de Snippet . Il apparaît dans le volet Trace au bas de la fenêtre.

Vous pouvez utiliser la substitution de variables entre les guillemets doubles pour imprimer la valeur des variables. Par exemple :

FOR i=1 TO 5
{
   TRACE "I = {i}"
}

Le résultat de cet exemple est le suivant :

I = 1

I = 2

I = 3

I = 4

I = 5