Katalon Compact Utility

Requirements:

  • Katalon Studio version 8.2.5 onwards.
  • A Chrome Profile. Find more information at Google Help Center: Share Chrome with others.

In restricted environments, unpacked extensions are disabled as a security feature. In that case, using the Spy, Record, and Smart Wait with Chrome might prompt this error: "Loading the unpacked extension is disabled by the administrators."

It is possible to use the packed extension Katalon Compact Utility as an alternative. The extension is available on Chrome Web Store.

This article will show you how to install the extension, configure your Profile, and use the Spy, Record, and Smart Wait in Katalon Studio.

Notes:

This utility is associated with your Chrome Profile, which means you can only have one active session at any given time.

Hence, before executing, make sure you log out of all your Chrome sessions.

Installing Katalon Compact Utility

  1. Open Chrome. Make sure you use the Profile you want to use the Spy, Record, or Smart Wait with.

  2. Navigate to the Chrome Web Store page for this extension: Katalon Compact Utility.

  3. Download and install Katalon Compact Utility.

  4. Make sure the extension is now active. You can find Google Support instructions to manage your Chrome extensions here: Install and Manage Extensions.

Configuring and Using the Compact Utility with Chrome Profile

The next steps will help you associate your Chrome Profile with the Spy, Record, and Smart Wait functions in Katalon Studio.

To configure and use Katalon Compact Utility, you need to update the Desired Capabilities. Do as follows:

  1. Go to Project > Settings > Desired Capabilities.

  2. In the Desired Capabilities section, select Web UI > Chrome.

  3. Click Add to create a new capability named args, for which the type is List.

  4. To add elements to your list, in the Value column of the capability you've created, click on the ... button.

    element
  5. The List Properties Builder dialog appears. Click Add to create two elements as below. When you are done, click OK to save.

    list
Type Value
String

For Windows: user-data-dir=C:/Users/<your_username>/Desktop/User Data
For Mac OS: user-data-dir=/Users/<your_username>/Library/Application Support/Google/Chrome
String profile-directory=<your_profile_name>

Finding your Chrome Profile in the User Data Directory

There are multiple Profiles in a given User Data Directory. To find the name of a Chrome Profile, do as follows:

  • Open Chrome with the Profile you previously used to install Katalon Compact Utility. In the address bar, type chrome://version and press Enter.
  • The line Profile Path displays the path to your active Profile. For example: C:\Users\your_username\AppData\Local\Google\Chrome\User Data\your_profile_name.
  1. To save the Chrome configuration, click Apply and Close.

    You can now use the Spy, Record, and Smart Wait features with the default Chrome option.

Disable XPath visibility

From Katalon Studio version 8.2.5 onwards, you can enable/disable the XPath visibility while recording actions on your app under test. Do as follows:

  1. Open Chrome, then click on the Extension icon.

  2. Click on the More icon of the Katalon Compact Utility, then choose Options.

  3. Click on the XPath Visibility toggle to enable/disable XPath visibility.

    xpath visibility

Known limitation:

  • For web pages saved as HTML local files, Katalon Compact Utility cannot spy and capture objects, while unpacked extensions (from the native Spy and Record utility) can do that.

See also:

Feedback