Depurar snippets

Esta página é para o Desktop Studio. Atualmente, CXone Studio não suporta as opções descritas nesta página.

Você pode depurar snippets na janela do editor Snippet . O depurador permite que você veja as variáveis no código snippet. Isso pode ajudá-lo(a) a resolver problemas com seu código. Há cinco opções para se depurar snippets:

  • Verificar a sintaxe no snippet. Você pode fazer isso a qualquer momento enquanto escreve o código de um snippet. Isso não usa a ferramenta de depuração.
  • Depure o snippet inteiro para ver variáveis e seus valores depois que todo o snippet foi executado.
  • Defina um ponto de pausa para parar de depurar em determinada linha do código.
  • Avance por cada linha no código do snippet e veja como a variável e seus valores mudam linha após linha.
  • Use instruções TRACE para gerar dados ao painel Trace na janela editor Snippet .

Além disso, se o seu código contém objetos dinâmicos ou matrizes, você pode ver os conteúdos deles e como o código é alterado.

Imagem da janela Propriedades do snippet, exibindo os diferentes elementos de depuração.

Verificar sintaxe de snippet

Você pode fazer com que Studio verifique a sintaxe em um snippet.

  1. No Studio, abra um script contendo uma ação Snippet.
  2. Clique duas vezes na ação Snippet.
  3. Adicione código Snippet na guia Text View , se ela ainda não tiver um.

  4. Clique no ícone Check Syntax na parte inferior da janela do editor Snippet .

    Se não forem encontrados erros de sintaxe, o campo de status ao lado do ícone Verificar sintaxe exibe a mensagem Okay.

    Se forem encontrados erros de sintaxe, uma mensagem de erro aparecerá descrevendo o erro. A descrição inclui o número da linha onde o erro está localizado. Além disso, o campo de status ao lado do ícone Verificar sintaxe exibe a mensagem Error at line [#].

  5. Corrija erros de sintaxe encontrados.
  6. Você pode selecionar uma ou mais linhas no código de snippet e clicar no ícone Comment out selected lines . Isso é útil se você quer pular um erro e verificar os outros erros restantes.
  7. Você pode selecionar uma ou mais linhas comentadas no código de snippet e clicar no ícone Uncomment the selected lines .

Usar a Ferramenta de depuração

  1. No Studio, abra um script contendo uma ação Snippet.
  2. Clique duas vezes na ação 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.

Depurar com um ponto de pausa

Você pode definir um ponto de pausa se quiser parar de depurar em uma determinada linha do código snippet. Isso permite que você veja as variáveis e valores em partes do snippet sem ter que avançar linha por linha.

  1. No Studio, abra um script contendo uma ação Snippet.
  2. Clique duas vezes na ação 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.

Avançar pelo código snippet

Você pode usar a ferramenta de depuração para avançar pelo código snippet linha por linha. Isso permite que você veja como as variáveis e seus valores mudam à medida que cada linha é executada.

  1. No Studio, abra um script contendo uma ação Snippet.
  2. Clique duas vezes na ação 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.

Ver conteúdos de objetos dinâmicos e matrizes

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.

Depurar usando TRACE

A palavra-chave TRACE  permite que você depure usando entradas. Esta palavra-chave funciona somente ao usar a ferramenta de depuração na janela de editor Snippet . Ao incluí-la no seu código snippet e executar o depurador, texto é gerado no painel Trace que aparece na parte inferior da janela do editor Snippet .

Imagem da janela Propriedades do snippet, exibindo os diferentes elementos de depuração.

A palavra-chave TRACE é ignorada fora da janela do editor Snippet . Ela só funciona com a ferramenta de depuração.

A sintaxe é TRACE "<text>":

Texto dentro de aspas duplas é gerado na janela do editor Snippet . Ele aparece no painel Trace na parte inferior da janela.

Você pode usar a substituição de variável entre aspas duplas para imprimir o valor de variáveis. Por exemplo:

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

O resultado gerado deste exemplo é:

I = 1

I = 2

I = 3

I = 4

I = 5