Skip to main content
Version: current

How to migrate from Katalon Studio - Standalone Edition to Platform Edition

This document shows you how to migrate from Katalon Studio - Standalone Edition to Katalon Studio - Platform Edition

From version 8.5.0, Katalon Studio has two editions: Katalon Studio - Standalone Edition and Katalon Studio - Platform Edition.

The Katalon Studio - Platform Edition is a component of the Katalon Platform - a modern, comprehensive quality management platform that enables teams to efficiently test, launch, and optimize testing without any complicated setup.

If your team decides to migrate from Katalon Studio - Standalone Edition the platform solution, your team can collaborate, manage, scale, and continuously improve testing operations, all in one platform.

Before migrating to Platform Edition, make sure that:

  • Your team can use on-cloud solutions

  • Your Git repository can be connected to the Katalon Platform

If your team cannot use Katalon Studio with internet access or your team cannot use Git, then Katalon Studio - Standalone Edition might be a more suitable solution.

Set up your project on Katalon TestOps

To use Katalon Studio - Platform Edition, you first start with Katalon TestOps. Here, you need to create a project, link your project with a Git repository, then open your project in Katalon Studio - Platform Edition.

The Git repository is where you store your test project. You only need to set up your Git repository once, then all your team members can get access to your test project via Katalon TestOps. Katalon Platform enables Git integration by default. You can collaborate with your team by committing directly from Katalon Studio and updating your Git repository on Katalon TestOps.

Create a new project on Katalon TestOps

This section shows you how to create a new project on Katalon TestOps.

  • You are the Admin or Owner of an Organization.

To create a new project on Katalon TestOps, do as follows:
  1. Go to TestOps > Settings > Project Management.
    project management
    The Project dashboard appears.
  2. Click on Create Project.
    project dashboard
  3. Choose your team, then click Next.
    The Manage Projects page appears.
  4. Enter your project name, then click Create.
You have successfully created a new project on Katalon TestOps.

Upload your test projects to Git repositories

To open your project in Katalon Studio - Platform Edition, you need to store your projects on Git repositories.
  1. Create a Git repository for each of your projects created in Katalon Studio - Standalone Edition. This is to ensure better management of your projects. Katalon Studio currently supports GitHub, GitLab, Bitbucket, and Azure Repos. For instructions, see the following document:
  2. Upload your Katalon projects to Git repositories.

Upload test scripts from a Git repository

  • You have an existing test project in Azure Repos / Bitbucket / GitHub / GitLab / AWS CodeCommit.

To upload test scripts from a Git repository to Katalon TestOps, do as follows:
  1. Sign in Katalon TestOps and go to the project you want to upload the test scripts to.
  2. Go to Configurations > Script Repositories. Click Create Git Script Repository.
    create Git script repository
    The Script Repositories tab appears.
  3. In the Source Type dropdown list, choose one of the following source types:
    • Azure Repos
    • Bitbucket
    • GitHub
    • GitLab
    • AWS CodeCommit. When you select the AWS CodeCommit option, the Access Key ID and Secret Access Key fields are enabled. Currently, Katalon Studio does not support AWS CodeCommit yet.
  4. In the Repository URL field, enter the URL of your Git script repository. If you choose AWS CodeCommit, you can refer to this AWS document to retrieve the repository URL: Step 4: Connect to the CodeCommit console and clone the repository.
  5. In the Username field, enter your Azure Repos / Bitbucket / GitHub / GitLab / AWS CodeCommit username.
  6. In the Personal Access Token field, enter your personal access token (PAT). To create a PAT, you can refer to the following documents:
  7. In the Access Key ID and Secret Access Key fields, enter your access key ID and secret access key in AWS CodeCommit. To retrieve the access key ID and secret access key, you can refer to this AWS document: Manage access keys for IAM.
  8. Optional: You can choose Link existing test execution results with test cases having the same paths and names. This option allows TestOps to attach existing test run results to the uploaded test cases and test suites that has the same paths and names.
    For example:
    • You have an existing test run results from the Login test case in the Test Cases/Common Test Cases folder. By default, if this test case is not from an uploaded Git test project, its test results are in the Uploaded Data folder in the Test Management tab.

    • You upload a Git repository that also has a Login test case in the Test Cases/Common Test Cases folder.

    • You check the Link existing test execution results with test cases having the same paths and names option.

    • Once the Git repository is connected successfully, in the Test Management tab, you can see the existing test results of the Login test case in the <your-git-repo-name>/Test Cases/Common Test Cases folder.

  9. Click Connect.

    The following sections appear:

    • Branch: choose a branch.
    • Name: enter your project name.
    • Description: enter your Git project description (optional).

  10. Click Create.
You have successfully uploaded your test scripts from a Git repository to Katalon TestOps. Next, you can start managing your test scripts in Katalon TestOps.

Download Katalon Studio

To download Katalon Studio, follow these steps:
  1. Sign in to Katalon TestOps.
  2. On the right side of the navigation bar, click on Download Studio.
    TestOps download button
  3. Select and download the suitable version of Katalon Studio for your system.
    Download Katalon Studio dialog

Activate Katalon Studio - Platform Edition

To activate Katalon Studio - Platform Edition, follow these steps:
  1. The Katalon Studio - Platform Edition app launches, then the Katalon Studio Activation dialog appears. Sign in to your Katalon account to activate your license. To learn more about license activation steps, see Activate Katalon Studio license.
  2. After you are done, click Activate.
  3. Select your Organization from the dropdown list, then click OK.
Now Katalon Studio - Platform Edition is ready for use.

Open a test project in Katalon Studio - Platform Edition

To open a project in Katalon Studio - Platform Edition, do as follows:
  1. From the main menu, select File > Open Project.
    The Open Project dialog appears.
  2. In the displayed Open Project dialog, select the project you want to open from the dropdown list. Katalon Studio retrieves all linked repositories of that project from the TestOps Serve URL.
    open project dialog
    If you cannot find your project, you can click on Fetch Project to update the latest list of active projects. An active project is a project on Katalon TestOps with linked Git repositories. See Upload test scripts from the Git repository to Katalon TestOps.
  3. To clone your Git repository to Katalon Studio, select your Git repository URL from the dropdown list.
  4. Input your Git Username and Personal Access Token. Granting the Write permission for this token is recommended to work with Katalon Studio. See GitHub document: Repository roles for an organization.
    You can select the option to Save authentication for the next time you open this project.
    To learn how to create a Git Personal Access Token, you can refer to these documents:
  5. Choose your branch to work on.
  6. Select a Local Location to clone your project to your local machine.
  7. Click OK.
You've successfully opened a project in Katalon Studio.