Skip to main content

Private Plugins in Katalon Studio

Private plugins are Katalon plugins that are developed for private use. With private plugins supported, you can build, distribute, install, and use your plugins without publishing them on Store for public access.

Requirements​

  • Katalon Studio version 7.0.0 onwards.
  • An active Katalon Studio Enterprise license. To learn more about activating licenses, you can refer to this document: Activate Katalon licenses.

Build Private Plugins​

If you don't know how to build a plugin that can be used in Katalon Studio, refer to the documents on how to develop platform plugins and custom keywords plugins.

If you have already written custom keywords, then code reuse across projects can be achieved easily by distributing the keywords as plugins. This utility is especially helpful when you need to test a set of products that frequently encounter recurring problems. Before, you would have to copy and paste every custom keyword class from projects to projects. Whenever the implementation of the custom keyword changes, you would need to update that change in all projects. Now, you can deploy and install custom keyword plugins through only a few commands and manual steps.

Store Private Plugins​

You need to store private plugins in the <project_name>/Plugins folder for Katalon Studio to treat them as local plugins. There are two types of plugins: Platform and Custom Keyword. Noticeably, Platform plugins need storing in the <project_name>/Plugins/platform folder.

Below is the structure of the Plugins folder:

Plugins

 |

 |___ platform

         |___ IDE plugin 1.jar

         |___ IDE plugin 2.jar

         |___ ....

         |___ IDE plugin n.jar

 |___ Custom keyword plugin 1.jar

 |___ Custom keyword plugin 2.jar

 |___ ...

 |___ Custom keyword plugin n.jar

Use Private Plugins in Katalon Studio​

In Project > Settings > Plugins, select one of the following options:

  • Katalon Store and Local: Katalon Studio will install plugins from the Store and the Plugins folder of each project.
  • Local: Katalon Studio will install plugins from the Plugins folder only.
Note: