Skip to main content
Kofax

How to enable Debugging Tools for the Chromium browser (CEF)

Goal

After completing this how-to you will be able to follow the execution of the steps run in the Chromium browser (CEF) in Design Studio. This is helpful when debugging robot issues (e.g. page load issues, problems clicking or submitting forms).

Keep in mind: the Chromium browser is only available in Kapow versions 10.3 and later and has to be used inside a Device Automation step (using an Open Step).

 Enable Debugging Tools

  • Navigate to the Kapow Installation folder (by default C:\Program Files\Kapow <version>\)
  • go into \nativelib\hub\windows-x32\<id>\node_modules\cef
  • open cef.cfg in a text editor
  • un-comment this line (i.e. remove leading #):

    chrome:remote-debugging-port = 9222

    Note: port 9222 can be changed if needed.
  • Save cef.cfg
  • Restart Design Studio.

Debugging Tools Usage

 

Method #1: for live inspecting & saving a trace (HAR)
  • Open Google Chrome browser on the same machine as Design Studio
  • Load chrome://inspect
  • At this point, since there is no page loaded by Chromium in Design Studio, Debugging Tools will only show:

    clipboard_eda8cd9397b541baa36899b21a08cd390.png
  • Open the Device Automation workflow in Design Studio and run the first Open Step.
  • the chrome://inspect page will contain the link for the url just loaded by the robot.
    E.g.

    clipboard_e441ffc6b047a79059aae6a0bbbcc9164.png
  • Click the "inspect" link. This will open the Developer Tools.

    clipboard_ed8b48c903d7048fec86479dbd8367a9d.png


This page can be used in the same way as Google Chrome's Developer Tools. HAR file can be saved from the Network tab (right click the first request and then select "Save all as HAR with content"

 

Method #2: Use this for live inspecting only

Note: you cannot save a HAR file with the content when using this method. If you want to save a HAR file, use Method #1 above

  • Open Google Chrome browser on the same machine as Design Studio
  • Load http://localhost:9222 (if the port was changed in the previous section, use the correct port)
  • At this point, since there is no page loaded by Chromium in Design Studio, Debugging Tools will only show:

    clipboard_e285ab8fc9dce2852dbc1a150b8d57f75.png
  • Open the Device Automation workflow in Design Studio and run the first Open Step.
  • Refresh the Debugging Tools window and it will contain a link to the debug page for the url that was just loaded:
    E.g.

     clipboard_e207ae4d757e39d57e6000193f344f6bb.png
  • Click this link to access the debug information:
    E.g.
    clipboard_e373242768d384e9cc42b89f4ef08f65f.png
  • This page can be used in the same way as Google Chrome's Developer Tools.