Viz Arc User Guide

Version 2.0 | Published July 03, 2024 ©

Debugging

DevTools

You can use any chrome based web browser (for example, Google Chrome or Microsoft Edge) to step through Viz Arc scripts.

  1. Open your browser.

  2. Enter chrome://inspect/ in the address bar.

    images/download/attachments/154394937/inspectchrome.png



  3. Click Configure...

    images/download/attachments/154394937/dicovery_config.png


    Add the host name where Viz Arc is running and specify the debug script port (by default, port 9222 for the global script and port 9223 for the template builder script). Confirm by clicking the Done button.

  4. Open a template in Viz Arc's template builder and start it.

    images/download/attachments/154394937/templatebuilder.png
  5. In the Chrome browser, you should now see the Viz Arc script available for debugging.

    images/download/attachments/154394937/devtools_view.png
  6. Click the inspect link to open the debugger. The first time you open the debugger it does not show any code.

    images/download/attachments/154394937/emptydevtool.png


    Hit CTRL + P and select Module.

    images/download/attachments/154394937/devtoolsctrlp.png


    You'll now be able to set breakpoints and see the code.

    images/download/attachments/154394937/inspecclicked.png
  7. Set a breakpoint and analyze your variables and code.

    images/download/attachments/154394937/debugging.png

Visual Studio Code

You can debug scripts with Visual Studio Code when using V8 JavaScript in the global script or in any scripted template.

  1. Install and launch Visual Studio Code.

  2. Set up one or more Viz Arc V8 debug configurations:

    1. Click File > Preferences > Settings to open your user settings.

    2. Locate or search for the Launch configuration and click Edit in settings.json.

    3. Add the following section to the file:

      {
      "debug.javascript.usePreview": false,
      "launch": {
      "version": "1.2.0",
      "configurations": [
      {
      "name": "Attach to Viz Arc Global Script on port 9222",
      "type": "node",
      "request": "attach",
      "protocol": "inspector",
      "address": "localhost",
      "port": 9222
      },
      {
      "name": "Attach to Viz Arc Template Scrip on port 9223",
      "type": "node",
      "request": "attach",
      "protocol": "inspector",
      "address": "localhost",
      "port": 9223
      }
      ]
      }
      }
    4. You can specify additional configurations for different hosts, port numbers, and other options. See Node.js debugging in VS Code for more information.

    5. Click File > Save.

  3. If you’d like to debug your application remotely, you must also make sure that your firewall allows incoming connections to your TCP port.

  4. Attach the Visual Studio Code debugger to your application:

    1. Click View > Debug to bring up the Debug view.

    2. Select the appropriate debug configuration at the top of the Debug Side Bar.

    3. Click Debug > Start Debugging.

Note: There are two different ports in use: One for the global script (default 9222) and one for template scripts (default 9223). Template scripts can be debugged only when running in the designer. The ports can be configured in the global configuration settings.

images/download/attachments/154394937/snapVSCore.png

The screenshot above shows a global script being stopped at a breakpoint.

See Also