Skip to main content
Version: legacy

Libraries management

Katalon Studio allows using external Java .jar libraries either through project settings or adding them to a designated folder. You can leverage this to extend the capabilities of Katalon Studio and handle specific situations when needed. This article will show you how to add external libraries to Katalon Studio or replace the built-in libraries with the external ones in a test project.

Add external libraries

You can add external libraries to a Katalon Studio project in three different ways:

  • Use Gradle.
  • Go to Libraries Management of the Project Settings of a project.
  • Copy and past a library's .jar file to Driver folder of a project.

Use Gradle

Katalon Studio supports automatically downloading libraries from Maven repositories using Gradle. Learn more.

Use Katalon Studio project settings

To add external libraries using Katalon Studio project settings, do as follows:
  1. In Katalon Studio, go to Project > Settings > Library Management.
    For Katalon Studio In older than 7.8.0, go to Project > Settings > External Library.
  2. In Library Management, click Add to browse your .jar file(s) (and its dependencies if any).
    Add external libraries
    To remove an added external libraries, select a library, click Remove > OK.
  3. Click on Apply and Close to save the settings.
After saving the settings, Katalon will add the library file(s) to the project Drivers folder and load the libraries.

Libraries added in the Drivers folder

Manually copy and paste .jar files to the Drivers folder

You can also manually copy and paste your .jar file (and its dependencies if any) into the Drivers folder of a project. You have to restart Katalon Studio (close and open the project again) to reload its class paths.
Manually add the library

When your .jar library is recognized by the test engine, you should be able to use it. Refer to how to create a Custom Keyword fIn or more information on how to use the email validation functionality from Apache open-source library commons-validator-1.5.1.jar.

Exclude built-in libraries

With the ability to remove built-in libraries stored in the .classpath file of a project folder, you can replace a built-in library with an external one for flexible libraries usage in a test project.
Note:
  • This feature applies to all libraries in classpath, excluding:
    • com.kms.katalon.*.jar
    • selenium-server-standalone-3.141.59.jar
    • poi-3.17.jar
    • poi-ooxml-3.17.jar
    • poi-ooxml-schemas-3.17.jar
    • java-client-7.0.0.jar
    • io.cucumber.*.jar
  • Excluding those libraries may cause failure of the relevant features.

Important:
  • An active Katalon Studio Enterprise license.
  • Katalon Studio version 7.8.0

  1. In Katalon Studio, go to Project > Settings > Library Management.
  2. In the Exclude the following built-in libraries section, click Add to add a built-in library's name that will be removed.
  3. In the External Libraries section, click Add to browse an external library to replace the excluded one.
    Exclude libraries