This article shows you how to activate KRE licenses.

Table of content:

• Online license
• Offline license
• Trial license

Online license

Katalon Runtime Engine

Any members of an Organization can use the Katalon Runtime Engine online licenses that the Organization has purchased. Learn about how to add a new user to your Organization.

To avoid sessions termination or optimize license usage, the Organization Owner/Admins should remember the following rules:

• Each process accounts for one license.
• The number of parallel processes conducted cannot exceed the license quota.
• The number of registered machines cannot exceed the license quota.
• Users need API Keys to activate an online RE license.

All users of an organization can use RE online licenses as long as the total number of active online licenses does not exceed the license quota.

To run Katalon Studio or Katalon Studio Enterprise with Katalon Runtime Engine, you need to:

1. Log in to your Katalon account on Katalon Studio.

2. In the command generator, generate a command with the auto-filled Katalon API Key and customized information.

3. Copy and paste the generated command into Terminal (for macOS/Linux) or Command Prompt (for Windows).

4. Open the command prompt and navigate to the folder of Katalon Studio Engine: katalonc.exe (Windows), Applications folder (Mac OS), or katalonc (Linux) file.

   macOS:

   cd /Applications/Katalon\ Studio\ Engine.app/Contents/MacOS
   

5. Enter the following syntax to execute automation test:

   For example: katalonc -noSplash -runMode=console -consoleLog -noExit -projectPath="C:\Users\Katalon Studio\Project\YourProject.prj" -retry=0 -testSuitePath="Test Suites/TS_RegressionTest" -browserType="Chrome (headless)" -apiKey=abczxzxz

   Katalon API Key is required for activating RE.

   Please refer to Command Syntax for further instructions on working with RE.

For Enterprise users with a private network, you may encounter a situation where you fail to execute test scripts or integrate Katalon Studio due to the network security error. Please contact your IT team to whitelist the following domains:

• store.katalon.com
• update.katalon.com
• analytics.katalon.com
• testops.katalon.com
• admin.katalon.com
• katalon-test.s3-accelerate.amazonaws.com (used for uploading reports to Katalon TestOps)

Learn more about how to install and execute Katalon Runtime Engine here.

Offline license

Only node-locked Katalon Runtime Engine (KRE) licenses with a yearly billing cycle can be converted to offline licenses.

A KRE license once converted to an offline license binds to a machine until it expires (in 60 days). It would be best if you were careful in deciding to generate an offline license since this decision is irreversible.

There are two roles in this tutorial:

• Owner/Admins of the organization that have purchased KSE licenses.

• Users need offline licenses.

  Here we only refer to organization roles since a Katalon user may have both roles

Step 1: Users view and send a machine ID to Owner/Admins

To copy and send the machine ID on which Katalon Studio is executed, Users need to do the following steps:

1. Download and open Katalon Studio

2. In the Katalon Studio Activation window, click Offline Activation to view and copy the machine ID

   

3. Send the machine ID to the Organization Owner/Admins

Step 2: Owner/Admins create and send back offline licenses

• Create an Offline license for the computer that will execute Katalon Studio from the command line:

1. Go to Katalon Admin

2. Select Organization

   

3. Select License > Katalon Runtime Engine- Node-locked

4. Click Create Offline License on the top right corner

   

5. Enter a machine ID and click Create

6. Confirm your action. The newly created offline license is added to the Offline Licenses list.

7. Download the offline license and store it on its machine. The newly created offline license is named KRE_<machineID>.lic.

Step 3: Users use offline licenses

Users can use the KRE offline licenses to execute Katalon Studio/Katalon Studio Enterprise from the command-line and in the offline environment.

• Execute a single session: Put the offline license file named KRE_<machineID>.lic in the license folder.
• Execute multiple sessions in parallel: Put multiple license files in the license folder.

The license folder can be found:

• Windows: C:\Users<user_name>.katalon\license

  

• Linux: /home/<user_name>/.katalon/license

• macOS: /Users/<user_name>/.katalon/license

Trial License

Valid email registration is eligible for a 30-day trial of both Katalon Studio Enterprise and Katalon Runtime Engine floating licenses.

The trial licenses are automatically generated and activated when you first log into the Katalon Studio application.

Each trial license can be activated on only one machine at a time. When your trial period expires, you need to subscribe to the paid license of each product to continue using it. Otherwise, the Katalon Studio free license will be automatically activated.

Notes:

Katalon Studio Enterprise and Katalon Runtime Engine trial licenses can only be registered with business emails.

Trial licenses work in online or offline environments for 30 days.

For Offline license, you cannot remove a machine ID registered for the trial licenses once it has been activated.

To purchase licenses, please follow this instruction.

Activate Katalon Runtime Engine with Trial License

To run Katalon Studio or Katalon Studio Enterprise with Katalon Runtime Engine, you need to:

1. Log in to your Katalon account on Katalon Studio.

2. In the command generator, generate a command with the auto-filled Katalon API Key and customized information.

3. Copy and paste the generated command into Terminal (for macOS/Linux) or Command Prompt (for Windows).

4. Open the command prompt and navigate to the folder of Katalon Studio Engine: katalonc.exe (Windows), Applications folder (Mac OS), or katalonc (Linux) file.

   macOS:

   cd /Applications/Katalon\ Studio\ Engine.app/Contents/MacOS
   

5. Enter the following syntax to execute automation test:

   For example: katalonc -noSplash -runMode=console -consoleLog -noExit -projectPath="C:\Users\Katalon Studio\Project\YourProject.prj" -retry=0 -testSuitePath="Test Suites/TS_RegressionTest" -browserType="Chrome (headless)" -apiKey=abczxzxz

   Notes

   Katalon API Key is required for activating RE.

   Please refer to Command Syntax for further instructions on working with RE.