Skip to main content

Generate screen-based videos in Katalon Studio reports

Katalon Studio supports screen-based recording when browser-based recordingrunning WebUI tests.

Note:

  • Screen-based recorder is available for Katalon Studio version 7.8.0 onwards.

  • Screen-based recorder is only applicable for local WebUI testing.

  • Screen-based recorder is available for single test suite execution only. To record parallel executions, you can refer to Record Browser-based Videos.

Screen-based Recorder is currently available for single Test Suite execution only. To record parallel executions, you can follow these instructions instead: Record Browser-based Videos.

We recommend the K-Lite Codec to play the recorded video.

Enable Screen-based Recorder​

To use the screen-based recorder, you need to enable it in Katalon Studio.

Note:

If you use macOS, make sure you first enable Katalon Studio for screen recording. Go to Privacy & Security settings > Privacy > Screen Recording > Allow Katalon Studio to do Screen Recording.

For version 7.8.0 and onwards​

To enable screen recorder for version 7.8.0 and onwards, follow these steps:

  1. Go to Project > Settings > Execution.
  2. In the During-Execution Options panel, enable Video Recorder by checking Record Video during execution.
    During-execution options in KS
  3. Select Screen Recorder and specify video settings based on your preferences.

    We recommend AVI (.avi) format and low quality to save disk space. Higher video quality means bigger file size.

    • Video format: AVI (.avi) or MOV (.mov).
    • Video quality: Low; Medium or High.
  4. Click Apply and Close.

For versions before 7.8.0​

To enable screen recorder for Katalon Studio versions before 7.8.0, follow these steps:
  1. After creating a test suite in Katalon Studio, go to Project > Settings > Report to open the Report view.
    KS Settings - Report section

  2. Check Enable Video Recorder during execution option.

    By default, Katalon Studio only captures Failed test cases. However, you can decide to either capture the Passed or Failed test cases, or both.

    Enabled Video recorder during execution option

  3. Specify Video settings based on your preferences.

    We recommend AVI (.avi) format and low quality to save disk space. The higher the video quality is, the bigger the file size is.

    • Video format: AVI (.avi) or MOV (.mov).
    • Video quality: Low; Medium or High.
  4. Click OK.

View recorded videos​

After running the test suite, navigate to the Result tab. You can see a list of test cases. A recorded video is attached to each test case accordingly.

Click on the Play icon in the Video column to play the video or navigate to the video folder and use any available video player.

KS test suite result video column

Recorded video

Each test step in a video has a description embedded like a subtitle.