Katalon Studio Recording Engine Extension

This document explains how to install Katalon Studio Recording Engine extension on web browsers for Katalon Web Recorder Plus's active browser and custom capability modes.

note

Starting from version 11.1.0, Katalon Studio will no longer install the built-in extension if the packed Katalon Studio Recording Engine extension is already installed on the browser profile. This change prevents session conflicts and duplicated recorded actions that could occur when both versions are present on the same profile. If you set up a browser profile but have not installed the packed extension, recorder capabilities will not be available. Follow the setup guide below to install the packed extension before recording.

Specify a browser profile

Katalon Studio Recording Engine extension is installed and scoped by browser profile. Before you install, switch to that browser profile, and later on configure the browser profile for recording (see Configure browser profile for the recording extension section below).

Chrome limitations

• For Chrome 135+: Using the default profile for recording might cause the browser to hang on launch.
• For Chrome 136+: Chrome blocks access to the default profile folder for security purposes. As a work around, specify a non-default profile folder, or copy your Chrome Profile folder to another location and set user-data-dir to that new path in the Desired Capabilities.

Install Katalon Studio Recording Engine extension

Follow these steps to install the extension on Chrome and Microsoft Edge:

1. Install the extension on a profile

• For Chrome: Install from Chrome Web Store.
• For Microsoft Edge: Install from Edge Add-ons.

2. Check for compatibility:

View your Katalon Studio Recording Engine extension's version.

Chrome

Go to chrome://extensions/ and search for Katalon Studio Recording Engine.

Microsoft Edge

Go to the Extensions page and search for Katalon Studio Recording Engine extension.

Refer to the following table for checking compatibility:

KSE version	Katalon Studio Recording Engine extension version
Before 10.2.4	prior to 1.0.8
10.3.0 to 10.4.3	1.0.13 onwards
11.0.0	1.0.14 onwards

note

As the Chrome Extension Marketplace only provides the latest version, opt for New Browser mode instead in case of incompatibility.

Configure browser profile for the recording extension

Once the extension is installed for a browser profile, add the specified profile to Katalon Studio:

For Chrome

Specify a Chrome profile in Desired Capabilities:

1. Go to Project > Settings > Desired Capabilities > Chrome.
2. Add args, and set the type as List.

3. In the Value cell, click the ... button to open the List Properties Builder dialog.
4. Add the following values:

Type	Value
String	For Windows: user-data-dir=C:\Users\your_username\AppData\Local\Google\Chrome\User Data For macOS: user-data-dir=/Users/your_username/Library/Application Support/Google/Chrome
String	profile-directory=<your_profile_name>

5. Click Apply and Close. Your profile should now be applied.

Alternatively, select a Chrome profile in Preferences > Recorder > Specify Chrome Profile:

Find your Chrome Profile path:

1. Open the browser profile with the extension.
2. Go to chrome://version on Chrome.
3. Check the value of Profile Path (E.g. C:\Users\your_username\AppData\Local\Google\Chrome\User Data\your_profile_name). This is the current profile's path. Go to this directory to view all of your profiles.

For Microsoft Edge

Specify a Microsoft Edge profile in Desired Capabilities:

1. Go to Project > Settings > Desired Capabilities > Edge.
2. Add ms:edgeOptions, and set the type as Dictionary.
3. In the Value cell, click the ... button to open the Dictionary Properties Builder dialog.

4. Add args, and set the type as List.
5. In the Value cell, click the ... button to open the List Properties Builder dialog.

6. Add the following values:

Type	Value
String	For Windows: user-data-dir=C:\Users\your_username\AppData\Local\Microsoft\Edge\User Data For macOS: user-data-dir=/Users/your_username/Library/Application Support/Microsoft Edge
String	profile-directory=<your_profile_name>

7. Click Apply and Close. Your profile should now be applied.

Find your Microsoft Edge Profile path:

1. Open the browser profile with the extension.
2. Go to edge://version on Microsoft Edge.
3. Check the value of Profile Path (E.g. C:\Users\your_username\Library\Application Support\Microsoft Edge\Default). This is the current profile's path. Go to this directory to view all of your profiles.