调试代码片段

本页适用于 Desktop Studio。目前，CXone Studio 不支持本页所述选项。

可以从 Snippet 编辑器窗口调试代码片段。调试器允许查看代码片段中的变量。这可以帮助您解决代码中的问题。调试代码段有五个选项：

此外，如果代码包含动态对象或数组，您可以查看其内容及其变化方式。

“代码片段属性”窗口的图像，显示了不同的调试元素。

Check Snippet Syntax

您可以让 Studio 检查代码段中的语法。

  1. 在 Studio 中，打开一个包含 Snippet 操作的脚本。
  2. 双击 Snippet 操作。
  3. 如果尚未包含某些代码，请在 Text View 选项卡上添加 Snippet 代码。

  4. 单击 Snippet 编辑器窗口底部的 Check Syntax 图标。

    如果未发现语法错误，“检查语法”图标旁边的状态字段将显示消息 Okay。

    如果发现语法错误，则会弹出一条错误消息来描述该错误。描述包括错误所在的行号。此外，“检查语法”图标旁边的状态字段会显示消息 Error at line [#]。

  5. 纠正发现的任何语法问题。
  6. 您可以选择代码片段中的一行或多行，然后单击 Comment out selected lines 图标。如果您想跳过某个错误并检查其他错误，这将很有帮助。
  7. 您可以在代码片段中选择一个或多个注释行，然后单击 Uncomment the selected lines 图标。

Use the Debugger Tool

  1. 在 Studio 中，打开一个包含 Snippet 操作的脚本。
  2. 双击 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.

Debug with a Breakpoint

如果希望调试在片段代码的某一行停止，可以设置断点。这样，您就可以查看代码片段中的部分变量和值，而无需逐行查看。

  1. 在 Studio 中，打开一个包含 Snippet 操作的脚本。
  2. 双击 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.

Step Through Snippet Code

您可以使用调试器工具逐行单步执行代码片段。这样就可以看到每一行执行时变量及其值的变化情况。

  1. 在 Studio 中，打开一个包含 Snippet 操作的脚本。
  2. 双击 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.

View Contents of Dynamic Objects and Arrays

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.

使用 TRACE 进行调试

TRACE  关键字允许您使用日志进行调试。该关键字仅在Snippet 编辑器窗口中使用调试器工具时才有效。将其加入代码片段并运行调试器后，文本就会输出到 Snippet 编辑器窗口底部的 Trace 窗格中。

“代码片段属性”窗口的图像，显示了不同的调试元素。

在 Snippet 编辑器窗口之外，TRACE 关键字将被忽略。它仅适用于调试器工具。

语法为：TRACE "<text>"

双引号内的文本将输出到 Snippet 编辑器窗口。它会显示在窗口底部的 Trace 窗格中。

您可以使用双引号之间的变量替换来打印变量值。例如：

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

此示例的输出为：

I = 1

I = 2

I = 3

I = 4

I = 5