Skip to main content
Version: current

Record Web Utility in Katalon Studio

Test recording is the easiest way for a tester to create an automation test script. This mean you just need to manually interact with your Web site and perform all the desired actions as a real user while the Katalon Recorder Utility record them.
  • From version 7.7.0, Katalon Studio supports adding Mouse Over and Verification steps by a right-click on an element in the AUT when recording with Chrome, Edge (Chromium-based), and Firefox.

You can create a new test script or edit an existing test script by using the Katalon Recorder Utility. This manual includes a tutorial of how to record test scripts and a brief introduction to each panel of the Katalon Web Recorder.

Record a New Test Case

To record a new test case, please do as follows:

  1. Click on the Web Record Utility icon to open the Web Recorder.

  2. Enter a URL of your web application. For example,

  3. Select a browser to start recording (either Chrome or Firefox from New Browsers type is recommended). You can see the very first test step named "Open Browser" is recorded.

    Katalon Studio default browser is Chrome and its icon is displayed in the top right corner. If you prefer other supported browsers, you can change the default browser in Project/Settings/Execution/Default execution, or click on the drop-down button to select your preferred one:

    recorder browser

    TypeDescriptionSupported browsers
    New BrowsersStart a new browser
    • Firefox

    • Chrome

    • Internet Explorer (only available on Windows)

    • Microsoft Edge (available from version 7.5.10)

    Active BrowsersUse the current browser (only Chrome).

    Katalon Studio installs Katalon Recorder as an add-on to help with recording for this type of browser.

    • Chrome

    • Firefox

    • Edge Chromium (available from version 8.4.0)

  4. A browser instance is launched automatically. Wait for your web page to load and interact with its elements.

  5. The browser highlights and displays its correspondent XPath (on the top of the page) when you hover that element.

    • You can use hotkey to capture objects (pressing the combination of <Alt + back quote>). The captured object will be highlighted with a green border.

  6. Interact with the web page. In this example, try signing in with the provided credentials. The recorded steps are generated automatically in Recorded Actions. When you type in a Password field, Katalon Web Recorder uses the Set Encrypted Text keyword automatically. The input value is encrypted to ensure security.

  7. Stop recording and save your script.

    During your recording, Katalon captures the objects that you have interacted with. When saving test script, Katalon Web Recorder exports a list of objects used in the test case. Choose a directory you want your test objects to reside to continue.

Record Using Existing Test Case

With the new Web Recorder, users can be more productive while modifying existing test cases. Instead of creating a brand new test case whenever there are changes to the UI, risks of overlooking how new changes might effect existing features are now minimized.

  1. Open any existing test case to continue recording.
  2. Click on the Record icon to open Web Recorder.

    All the existing test steps and Test Case variables are imported to the Recorded Actions and Variables tabs in Web Recorder respectively. You do not need to repeat the test steps having been recorded.

  3. Interact with the AUT.

When saving your script, Katalon Studio automatically detects similar existing objects in the Objects Repository and asks you for further action to optimize Object Repository.

Validate UI elements

  • From version 7.7.0, Katalon supports adding Mouse Over and Verification Steps by a right-click on an element displayed in the AUT when recording with Chrome, Edge (Chromium-based), and Firefox.

Given that you enter incorrect username or password, you can validate if the website displays an error message indicating a failed login attempt.

Or you can verify if the next screen after a successful login is "right" by verifying if a specific UI element is present.


In the drop-down list of the Run button, you can find some Run options. The two of them labeled with Debug are advanced options for validating recorded script, and saving you from running all test steps over and over again if you have a Katalon Studio Enterprise license:

  • Run all steps: Execute ALL steps that are enabled on Web Recorder
  • Debug: Run selected steps: Execute only one or many selected steps.

    You can select multiple steps using either Ctrl or Shift key. The selected steps will be highlighted (e.g. steps #2, #6, #9 and #11 are selected for running).

  • Debug: Run from selected step: Execute the currently selected step and all the steps after the selected one (e.g. run the test from step #4.

Katalon Web Recorder Utility Components

Recorded Actions

Available actions in Katalon Web Recorder Utility is the same as Katalon Studio built-in keywords. You can add any action, call another test case, and/or use Custom Keywords.

Captured Objects

During your recording, Katalon captures the objects that you have interacted with. When saving test script, Katalon Web Recorder exports a list of objects used in the test case. Learn more about Web UI test objects.


In Katalon Web Recorder, you can manage the variables directly related to your recording.


When running the recorded actions, you can investigate the execution by looking at its real-time detailed logs. Execution logs are displayed on the Logs tab.

For advanced features such as branching, looping or validation, you can refer to this article: Control Statements.