TestLink Integration

This custom keywords plugin is a useful tool to integrate with TestLink.


Integration of Katalon with TestLink

TestLink Installation:

  • Download XAMPP from the below link. https://www.apachefriends.org/download.html

  • Upon successful installation, Tomcat will be started by default.

  • Start the Apache and MySQL services from XAMPP Control Panel.

  • Download the TestLink from the below link. Currently, the latest version of TestLink is 1.9.19. You can use the latest version for the Integration. https://sourceforge.net/projects/testlink/files/TestLink%201.9/

  • Extract TestLink and place it on XAMPP’s “htdocs” directory.

  • Hit the below URL in any browser. http://localhost/phpmyadmin/

  • Create a new database called “testlink” from the database menu.

  • Add a user account from the “Privileges” tab under “More” options for “testlink” database.

  • The below permissions will be failed.

  • Navigate to the testlink package and open the “config.inc.php” file.

  • Update the parameters as below

$tlCfg->log_path = ‘D:/xampp/htdocs/testlink-1.9.16/logs/’; (Path of testlink package)

$grepositoryPath = ‘D:/xampp/htdocs/testlink-1.9.16/uploadarea/’; (Path of testlink package)

  • Refresh the page and the above “failed” status will be resolved.

  • Click the “Continue” button.

  • Enter the Database name as “testlink”.

  • Enter the Database admin login and password as “admin”.

  • Enter your database username and password for “TestLink DB login and password”.

  • Click the “Process TestLink Setup!” button.

  • Once the installation is completed, a window will be displayed to notify that the Installation was successful.

TestLink Login:

  • Once you login to TestLink, it prompts to create a Test Project.

  • Create a Test Plan, Build, Test suite with Test cases by selecting the corresponding links from the Dashboard.

Test Project Creation:

Test Plan Creation:

Build Creation:

Test Suite Creation:

Test Case Creation:

API Key Generation and Execution Type Changes on TestLink:

  1. Generate the API Key on TestLink as below.

• Click the “My Settings” icon next to logout.

• Personal API access Key will be “none” under the “API Interface” section.

• Click “Generate a new key” button.

• Key will be generated from “Personal API access key”.

  1. After generating a key, update the test execution status as “Automated” as below.

Integration of Katalon test scripts with TestLink:

Make a note of the TestLink Key, Testlink Url, Project Name, Test Plan Name, and Build Name created on TestLink. These details need to be used in our configuration in below:

Go to Project Settings > Plugin > TestLink Integration and setup these following configurations:

This plugin provides the only custom keyword updateResults to update the test results on Testlink.

Test Execution Results update on TestLink:

Before execution, the test status will be “Not Run” on Testlink. If the test case is passed, the status will be updated as “Passed”.

If the test case is failed, the status will be updated as “Failed”.

Visit Katalon Forum for Plugin related discussions.

2 Rating(s)
Nathaly Tsang
May 18, 2019

May 13, 2019

so useful 👍🏻

  • 1 license
  • Non-transferable license
  • Suitable for one single user
  • 5-license bundle
  • Non-transferable licenses
  • Ideal for teams from 2 to 5 members
  • 6 licenses minimum
  • Transferable licenses
  • Best for corporates with multiple teams



You will have one license for every Individual subscription. This license is tied to the buyer's account and is non-transferable.


You will have a fixed number of 5 licenses in the Team bundle. If your team purchase more than 5 licenses, we will upgrade you to the Corporate subscription.


The Corporate subscription is the most adjustable package for large teams. Each subscription includes 6 licenses minimum. These licenses are transferable among team members, allowing for better teamwork flexibility. You can request to add, change, or remove as many accounts as you desire.

You only have one subscription for each plugin. If you acquire additional licenses, the new subscription will be calculated upon your current billing cycle. The remaining credits of your current subscription will be refunded to the new subscription. You can review the billing summary before making additional license payment.
Individual subscription
  1. Click Manage My Orders in the payment confirmation page, or click the link in the payment confirmation email
  2. You will see your purchased plugin in the Orders tab
    • To view/download invoice and payment details: Click Order History
    • To activate a plugin, click View ⇒ You will be directed to the My Plugins page ⇒ click Activate ⇒ The plugin status is now Reload plugin in Katalon Studio
Team and Corporate subscriptions
  1. Click Manage My Orders in the payment confirmation page, or click the link in the payment confirmation email
  2. You will see your purchased plugin in the Orders tab
    • To view/download invoice and payment details: Click Order History
    • To invite/remove other member Katalon accounts: .
To invite users:
  1. Go to My Account menu ⇒ Orders.
  2. Choose the plugin in which you want to manage members
  3. Enter your team member’s Katalon account* into the textbox

*To be invited to co-use the plugin, every team member must have a Katalon account. You can create a Katalon account here.

To remove users:
  1. In the list of members, click the icon next to the Katalon email account you want to remove from the list
  2. The plugin will be removed from the selected account.

You will receive an invitation email with the link to the My Plugins page.

To start using the plugin, click Activate, then reload in Katalon Studio.

Annual subscriptions are automatically renewed. You will receive a notification email 30 days prior to the renewal date. You will also have the option to cancel the auto-renewal process anytime.
For inquiries of plugin usage:
  1. Under the plugin page, go to the Q&A tab. You will be directed to Katalon Community.
  2. Sign in or sign up for a Katalon Community account
  3. Post your questions in the discussion thread. The plugin publisher will provide the according support.
For inquiries of Katalon account (e.g. adding account, removing account, payment, cancellation, renewal, etc.) please email store@katalon.com.

The Katalon Plugin License Agreement is applied for all plugins developed by Katalon team.

The Standard Plugin License Agreement can be applied for plugins developed by third-party publishers who are not Katalon team members.

Please review the license agreements carefully before installing any plugin in Katalon Store.

Please contact our Store team at store@katalon.com for details.

Yes. There will be a 30-day trial period for all paid plugins with the same complete features. After the trial period, you will need to subscribe to one of the annual subscriptions: Individual, Team, or Corporate to continue using the plugin.

Please note that the trial period only applies to one single, non-transferable license.

You may cancel your subscription at any time by clicking Unsubscribe on the plugin or emailing us at store@katalon.com. However, there is no refund for the remaining duration of the subscription.
If your payment is not accepted, please make sure:
  • All payment information is correct
  • There are sufficient funds in your account
  • Payment Card is Not blocked because of unusual or suspicious activities
If you still have problems with payment, please contact us at store@katalon.com.
API keys are required in Katalon Studio Commandline Execution. Generate Key
Project details
Custom Keywords Plugin
Last updated
July 25, 2019 8:32 am
Privacy and License Agreement