Skip to main content

Activate licenses

In this article, we will guide you through the activation of your Katalon Studio Enterprise (KSE) and Katalon Runtime Engine (KRE) licenses.

Note:
  • To learn more about the details of Katalon licenses, see: Types of Licenses.
  • If you are behind a proxy server, before activating Katalon licenses, you need to configure the Authentication proxy settings. To learn more about how to configure a proxy, see Configure Proxy for Authentication.

Activate a KSE license​

  • The Owner or Admin of your Organization have assigned a KSE license to your user account before doing this step; or you're a Trial user who can evaluate KSE for 30 days.

  • You have downloaded and installed Katalon Studio Enterprise. For detailed instruction, see Install Katalon Studio.

  1. Once you open the application, the log in dialog will automatically pop up.
    The Katalon Studio activation dialog box.
    1. If you are already logged in to a Katalon account in Katalon Studio, then click on the Profile button and select Log out to prompt the dialog.
      The profile button and the log out option in Katalon Studio.
  2. Select Log in from Browser and log in using your preferred credentials.

    If you log in with SSO, see Log in to Katalon Studio with SSO.

Once you've successfully logged in, you can start using Katalon Studio Enterprise.

Activate a KRE license​

After the owner or admin of your organization has granted you a KRE license, the license is activated automatically.

To use KRE, you need to authenticate your account with your Katalon API key.

To view your API key, refer to this guide: API Keys.

Note:

Activate a license while offline​

An offline license needs to be activated before it can be used.

  • A machine ID. To view your machine ID, see How Katalon generates a machine ID.
  • A KSE_<machine_ID>.lic or KRE_<machine_ID>.lic file.
    • To get this license file, provide your machine ID to your organization's owner or administrator and ask them to grant you an offline license.

    • They can learn how to grant an offline license through this guide: Grant an offline license to users.

Receive your license file from your organization owner or administrator and execute the following steps:
Put your .lic file in its appropriate license folder.
Note that .katalon is a hidden folder. To find the license folder in your computer, search for:
  • Windows: C:\\Users\\<user_name>\\.katalon\\license
  • Linux: /home/<user_name>/.katalon/license
  • macOS: /Users/<user_name>/.katalon/license

Activate KSE offline license​

Perform this step only after you have copied your corresponding .lic file to its directory. If you have not yet, read: Activate a license while offline.

Upon opening Katalon Studio for the first time, or while you are logged out, you will automatically be prompted to activate your license by a pop-up window.
  1. In the login dialog, click Offline license.
    The Katalon Studio activation dialog.
  2. In the License file section, click Choose file to select your .lic file.
  3. Click Activate.
Katalon Studio Enterprise offline is ready for use.

Activate KRE offline license​

Determine the correct directory for your license file before executing this step. If you have not yet, read: Activate a license while offline.

Activate KRE offline by:
Putting your KRE_<machine_ID>.lic file in the license folder.
Note:

  • To execute multiple sessions in parallel, put multiple license files in the license folder.

Your KRE license is now activated. Every time you start running a test with KRE, KRE automatically verifies that your license file is available and valid.

It should look as the image below.Activating Katalon Runtime Engine offline.

Activate a license with Private Instance​

Activate a KSE license with Private Instance​

  • You have downloaded and installed Katalon Studio Enterprise.
  • A private instance URL. To learn more about Private Instance, contact our sales team via business@katalon.com.
  1. Open the application. The Welcome to Katalon Studio Enterprise dialog automatically pops up.
    The Katalon Studio activation dialog box.
    1. If you are already logged in to a Katalon account in Katalon Studio, then click on the Profile button and select Log out to prompt the dialog.
      The profile button and the log out option in Katalon Studio.
  2. Click License server and input the following:
    • In the License server address field: the Private Instance URL used for authentication
    • The licensed user account email and password
  3. Click Log in.

Activate a KRE license with Private Instance​

To activate a KRE license with Private Instance, pass the Private Instance URL used for authentication to the -serverUrl parameter.

For example:

./katalonc -noSplash -runMode=console -projectPath="/Users/katalon/Downloads/web-visual-testing-samples-master/Web UI Tests with TestOps Vision.prj" -retry=0 -testSuitePath="Test Suites/TS_RegressionTest_With TestOps Vision" -browserType="Chrome" -executionProfile="default" -apiKey=<your-API-key> --config -proxy.auth.option=NO_PROXY -proxy.system.option=NO_PROXY -proxy.system.applyToDesiredCapabilities=true -serverURL="https://admin-tenant1.katalon-cloudops.com/"
Note: