Katalon Studio Preferences
Katalon Studio Preferences define default behaviors of Katalon Studio across projects. You can access the Preferences by selecting Katalon Studio > Preferences from the menu.
Katalon supports an in-app upgrade function for a smooth transition to the latest version (In Help menu > select Check for updates... > in the displayed dialog, download the latest version). The latest version upgraded via this channel will reuse the current version's Preferences configurations.
In case you have to download the latest version from the Katalon website and want to reuse the Preferences configurations of another Katalon Studio instance already installed in your machine, or you want to reuse the Preferences configurations of your project team, do as follows:
Rename the current Katalon Studio instance with its version number. For example, Katalon Studio 7.8.
Download the latest version from the Katalon website.
Open Katalon Studio, select File > Import Settings.
Browse to the config folder of your preferred version. For instance:
- Click Open.
Test Case Preferences
All the preferences under the Test Case group are for controlling the default behaviors that Katalon Studio should perform when test cases are designed.
You can configure the Test Case preferences via Katalon Studio > Preferences > Katalon > Test Case.
Test Case Calling
This is to specify how Katalon Studio should behave when you are calling another test case in your current one.
- Generate variable with default value: Called test case uses the default values for its variables.
- Generate variable with the same name as the exposed variable of the called test case: Called test case uses the default values, which are the same as its variables name.
- Expose variables automatically after choosing the called test case: Called test case uses the default values, which are the same as its variables name. The variables are also added to the current test case at the 'Variables' tab.
You might need to refer back to the Variable Types section for which types of variables are supported in Katalon Studio.
Initially open Test Case
This is to indicate in which view Katalon Studio should display a test case when it is first opened.
- In Manual View: The opened test case will be first in the manual view.
- In Script View: The opened test case will be first in the script view.
Default Keyword Type
- Default Keyword: These default keywords will be available when a new step is added to your test case.
This is to enable Katalon Studio to wrap up the code lines in a script with a customized maximum line width. You can also wrap the code lines when switching from the manual mode to the script mode by pressing a keyboard combination of Command+Shift+F (Mac Users) or Ctrl+Shift+F (Windows and Linux Users).
Before the line-wrapping enabled:
After the line-wrapping enabled:
All the above preferences are saved into the
com.kms.katalon.composer.testcase.prefsfile under the "config\.metadata\.plugins\org.eclipse.core.runtime\.settings" location in your Katalon Studio build folder. You can manually modify the values in this file to change these preference settings.
Starting in Katalon Studio version 7.5.0, the proxy is divided into two categories: Authentication and System proxies. You can apply different proxy configurations for connecting to the Katalon server and your servers during testing.
Please go to Katalon Studio> Preferences > Katalon > Proxy and select Authentication or System section for corresponding proxy configuration of each type.
The proxy configurations in this section are used for all network connections to authenticate with Katalon Servers including Katalon account authentication, Katalon Auto-updater, Katalon TestOps, and Katalon Store integration, sample projects provider, AMI Authentication, and etc.)
System proxy configurations are applied to all network connections generated when using Katalon Studio, including but not limited to recording, spying, executing tests, integrating with other tools, and downloading Web Drivers or Android SDK.
In the Proxy Settings areas of both Authentication and System proxies, you can select one of three options below.
- No proxy: there's no proxy.
- Use system proxy configuration: Katalon Studio guesses which proxy server your system is behind by checking Java, browser and operating system settings, and environment variables.
- Manual proxy configuration: you can manually set up your proxy
- Address: an HTTP Proxy host
- Port: an HTTP Proxy port
- Excludes: A list of addresses separated by comma to exclude
The ability to exclude proxy is available in version 7.2+. Katalon Studio only supports proxy exceptions in web recorder and spying with Chrome and Firefox.
System proxy for test execution's desired capabilities
Katalon Studio applies the System proxy to test execution's desired capabilities on the instance automatically. If you wish to configure different proxy's desired capabilities for a project, you need to do as follows:
- Open your project and go to Katalon Studio/Preferences/Katalon/Proxy/System
- At the bottom of the displayed view, uncheck the Auto-apply to test execution desired capabilities option and click OK to save
Go to Project/Settings/Desired Capabilities and select a testing environment
Specify proxy details and click OK to save
Override proxy details in the test script
Starting from version 7.0.0, Katalon Studio supports an option to pass proxy details via a request object in Web Service testing. Below is an example:
RequestObject requestObject = findTestObject("google") ProxyInformation proxyInfo = new ProxyInformation(); proxyInfo.setProxyServerAddress("localhost") proxyInfo.setProxyServerPort(8001) proxyInfo.setProxyOption(ProxyOption.MANUAL_CONFIG.toString()) proxyInfo.setProxyServerType(ProxyServerType.HTTP.toString()) requestObject.setProxy(proxyInfo)
The proxy information passed in the request object takes precedence over the proxy information set in Preferences.
Troubleshoot proxy issues
If you're behind a Proxy Server, you need to configure the Authentication proxy settings before activating Katalon Studio. Click Configure Authentication Proxy at the bottom of the Activation dialog box.
"New and old proxy mechanisms are not allowed in one command. Please use either the new or the old one."
If you encounter the above error when executing your test with Runtime Engine, please check if you are mixing options of the new mechanism with options for proxy configuration prior to 7.5.0 and correct the commands in use. Learn more about proxy options.
Object Spy Preferences
You can access these preferences at Window > Katalon Studio Preferences > Katalon > Object Spy.
Pin Object Spy Window while spying
Users can check/uncheck this option to pin Object Spy Window on top while spying for more convenience.
Katalon Studio supports customizable hotkeys for Object Spy function so that users can choose the preferred combination or avoid confliction with UAT hotkeys.
This ability to change hotkeys for Object Spy only affects the Chrome browser. Other browsers will be considered for future releases.
Apply Dark theme
By default, Katalon Studio has the Light theme applied. Starting in version 6.3.0, Dark Theme is available. You can enable it at Window > Themes >Dark. Katalon Studio is required restarting to enable another theme to be applied.