Toggle navigation
Katalon Studio
Katalon TestOps
Plugins
Videos
Academy
Pricing
Download
Katalon TestOps Tutorials
Visit
here
for Katalon TestOps Tutorials and further discussions.
Feedback
Edit this page
Request docs changes
Products and Licenses
Katalon Studio Enterprise & Runtime Engine Licenses
Types of Licenses
Katalon Studio vs Katalon Studio Enterprise Features
Trial and Free Plans
Activate Katalon License
Configure Proxy Authentication
View License Details
View Machine ID
Troubleshoot
Session Termination Causes
Troubleshoot Activation Problems
Katalon Runtime Engine DevOps Sunsetting
License Administration
Purchases and Billing
Purchase Katalon Licenses
Upgrade Billing Plan
Change Billing Information
Cancel Billing Renewal
Licenses Management
Manage Katalon Licenses
Grant Katalon Licenses
Configure Idle Timeout
Monitor Licenses
View Test Usage and Balance in the Usage Dashboard
License Utilization Dashboard
Set up an On-Premises License Server
Katalon TestOps Subscriptions
Overview
Pricing and Feature Comparisons
Trial Plans
Manage Subscriptions
Subscribe to TestOps
Ugrade Subscriptions
Cancel Subscriptions
Katalon Studio Enterprise
What's new
What's new in v8.1.0?
What's new in v8.0.0?
What's new in v7.9.0?
What's new in v7.8.0?
Release Notes
Version 8.x
Version 7.x
Version 6.x
Get Started
Welcome to Katalon Studio
Supported Technologies
Supported Environments
Unique Capabilities
Installation and Activation
Installation Overview
Update Katalon Studio
Katalon Studio for Linux (GUI)
Configuration for Web Testing
Internet Explorer Configurations
Katalon Addon for Chrome
Configuration for Mobile Testing
Mobile on macOS
Installing WebDriverAgent for iOS devices
Tutorials and Samples
Quick Start
Sample Projects
Sample Projects
Shopping Cart Project
Health Care Project
Web Service Samples
BDD Samples
iOS
[Mobile] iOS Setup
[Mobile] Create and Run iOS Test Case
Android
[Mobile] Android Setup
[Mobile] Configure Android Studio (Emulator)
[Mobile] Create and Run Android Test Case
Web UI
[WebUI] Create and Run Web UI Test Case using Record and Playback
[Web UI] Plan Test Suite
GUI and Preferences
Toolbars and Views
Katalon Help
Katalon Studio Preferences
Projects
Manage Test Project
API/Web Service Project
Project Settings
Test Design
Search Function
Create Test Case
Elements of Test Cases
Statements
Call Test Case
Variable Types
Value Types
Failure Handling
Test Fixtures and Test Listeners (Test Hooks)
Sensitive Text
External Libraries
Execute and Debug a Test Case
Decompile Class File for Debugging
Fixing broken Web Test Objects with Time Capsule
Desired Capabilities
Introduction to Desired Capabilities
Desired Capabilities Management
Start browsers in private mode
Test different browser locales in Chrome with Desired Capabilities
Usage Examples
Custom Keywords
How to perform Database Testing using Katalon Studio
How to use a custom keyword from other custom keywords and step definition classes
Web Testing
Generating reliable object selector using Spy Web utility
Solving Pop-up dialog issue with Katalon Studio
Handling iFrame issue with Katalon Studio
Solving Wait-time issue with Katalon Studio
Handling drag and drop testing for web applications with Katalon Studio
Handling static and dynamic Test Objects
How to Handle Alerts
How to Handle Textbox Checkbox and Radio Button
How to Handle File Uploads
How to handle Web Tables
How to handle Drop-down menu
How to use Selenium WebDriver in Katalon Studio
Common tips for using Xpath in Katalon Studio
Handling Web element locators using Katalon Studio
Web Element Locators - How to group elements into a unique block
Automation testing of Shadow DOM elements with Katalon Studio
How to check element status in conditional statement?
API Testing
How to parse JSON responses in Katalon Studio
How to verify API responses in Katalon Studio
Mobile Testing
Performing Pinch to Zoom In Action
How to Perform Multi-touch Actions in Mobile App
Handling Alert Dialog in Mobile App
Handling Drag and Drop in Mobile App
Using List to Store the Mobile Elements to Validate Data
Handling Spinner in Mobile Automation Testing
Handling Vertical Swipe in Mobile Automation
Handling Horizontal Swipe in Mobile Automation
Handling Scroll to Element in Mobile Automation
Web Test Design
Introduction to Web Testing
Creating test case using Record & Playback
Self-healing Tests
Self-healing Tests
Selection Methods for Web Tests
Detecting Objects with XPath
Image-based Testing
Web Test Objects
Manage Web Test Objects
Parameterize Web Test Objects
Web Record and Spy Utilities
Record Web Utility
Record with Chrome using Packed Extension
Spy Web Utility
Katalon Compact Utility
Web Locators Settings (since v5.7.1)
How to use synchronization commands while recording
Handle WebDrivers
Terminate WebDrivers
Upgrade or Downgrade WebDrivers
Handle WebDrivers with EventFiringWebDriver
Testing Web App on Mobile Browsers
Mobile Test Design
Locators and Object Identification
Mobile Test Objects
Manage Mobile Test Objects
Create Mobile Test Object in Memory at Runtime
Parameterize Mobile Test Object Properties
[Mobile] Image-based Testing
Mobile Record and Spy Utilities
An Introduction to Katalon Mobile Recorder
Mobile Recorder Tutorial - 7.6 onwards
Mobile Recorder Tutorial - before 7.6
Mobile Spy Tutorial
Spy and Record Utilities for testing an existing application
Testing Mobile Apps using Katalon Studio and Kobiton's cloud-based device farm
Testing Mobile Apps using Custom Cloud Devices
Remote Execution for Mobile Testing
Capture elements in hybrid Android apps
Web Services Test Design
Introduction to API Testing
Create your first API test with Katalon Studio
Create REST API requests manually
Introduction to Web Services Test Object
Create Web Service Object in Script Mode
RESTful
SOAP
Authorization
Authorization Basic
Authorization OAuth 1.0
Authorization OAuth 2.0
Web Services Builder
Verification Snippets
Using Web Services in a Test Case
Working with API/Web Services Project
Request History
Draft Request
Import Web Service Objects
Import RESTful requests from OpenAPI Specification 3.0
Import RESTful requests from Swagger 2.0
Import RESTful from Postman
Import RESTful requests from SoapUI
Import RESTful requests from WADL
Import SOAP requests from WSDL
Parameterize a Web Service Object
Handle Response Messages
Windows Desktop Apps Test Design
Introduction to Desktop App Testing
Set up WinAppDriver
Windows Record and Spy Utilities
Introduction to Windows Spy Utility
Introduction to Windows Record Utility
Windows Spy Tutorials
Windows Record Tutorials
Native Windows Recorder
Windows Test Objects
Test Artifacts Sharing
Test Maintenance
Test Objects Refactoring
Keywords
Web UI Keywords
[WebUI] Accept Alert
[WebUI] Authenticate
[WebUI] Back
[WebUI] Check
[WebUI] Click
[WebUI] Click Image
[WebUI] Click Offset
[WebUI] Close Browser
[WebUI] Close Window Index
[WebUI] Close Window Title
[WebUI] Close Window Url
[WebUI] Delete All Cookies
[WebUI] Deselect All Option
[WebUI] Deselect Option By Index
[WebUI] Deselect Option By Label
[WebUI] Deselect Option By Value
[WebUI] Dismiss Alert
[WebUI] Double Click
[WebUI] Drag And Drop By Offset
[WebUI] Drag And Drop To Object
[WebUI] Enhanced Click
[WebUI] Execute JavaScript
[WebUI] Focus
[WebUI] Forward
[WebUI] Get Alert Text
[WebUI] Get All Links On Current Page
[WebUI] Get Attribute
[WebUI] Get CSS Value
[WebUI] Get Element Height
[WebUI] Get Element Left Position
[WebUI] Get Element Width
[WebUI] Get Number Of Selected Option
[WebUI] Get Number Of Total Option
[WebUI] Get Page Height
[WebUI] Get Page Width
[WebUI] Get Text
[WebUI] Get Url
[WebUI] Get Viewport Height
[WebUI] Get Viewport Left Position
[WebUI] Get Viewport Top Position
[WebUI] Get Viewport Width
[WebUI] Get Window Index
[WebUI] Get Window Title
[WebUI] Maximize Window
[WebUI] Modify Object Property
[WebUI] Mouse Over
[WebUI] Mouse Over Offset
[WebUI] Navigate to Url
[WebUI] Open Browser
[WebUI] Refresh
[WebUI] Remove Object Property
[WebUI] Right Click
[WebUI] Right Click Offset
[WebUI] Scroll To Element
[WebUI] Scroll To Position
[WebUI] Select All Option
[WebUI] Select Option By Index
[WebUI] Select Option By Label
[WebUI] Select Option By Value
[WebUI] Send Keys
[WebUI] Set Alert Text
[WebUI] Set Encrypted Text
[WebUI] Set Masked Text
[WebUI] Set Text
[WebUI] Set View Port Size
[WebUI] Smart Wait Function
[WebUI] Submit
[WebUI] Switch To Default Content
[WebUI] Switch To Frame
[WebUI] Switch To Window Index
[WebUI] Switch To Window Title
[WebUI] Switch To Window Url
[WebUI] Take Area Screenshot
[WebUI] Take Element Screenshot
[WebUI] Take Full Page Screenshot
[WebUI] Take Screenshot
[WebUI] Type On Image
[WebUI] Un-check
[WebUI] Upload File
[WebUI] Upload File by Drag-and-Drop
[WebUI] Verify Alert Not Present
[WebUI] Verify Alert Present
[WebUI] Verify All Links On Current Page Accessible
[WebUI] Verify Element Attribute Value
[WebUI] Verify Element Checked
[WebUI] Verify Element Clickable
[WebUI] Verify Element Has Attribute
[Web UI] Verify Element Not Checked
[WebUI] Verify Element Not Clickable
[WebUI] Verify Element Not Has Attribute
[WebUI] Verify Element Not Present
[WebUI] Verify Element Not In Viewport
[WebUI] Verify Element Not Visible
[WebUI] Verify Element Present
[WebUI] Verify Element Text
[WebUI] Verify Element Visible
[WebUI] Verify Element In Viewport
[WebUI] Verify Image Present
[WebUI] Verify Links Accessible
[WebUI] Verify Option Not Present By Label
[WebUI] Verify Option Not Present By Value
[WebUI] Verify Option Not Selected By Index
[WebUI] Verify Option Not Selected By Label
[WebUI] Verify Option Not Selected By Value
[WebUI] Verify Option Present By Label
[WebUI] Verify Option Present By Value
[WebUI] Verify Option Selected By Index
[WebUI] Verify Option Selected By Label
[WebUI] Verify Option Selected By Value
[WebUI] Verify Options Present
[WebUI] Verify Text Not Present
[WebUI] Verify Text Present
[WebUI] Wait For Alert
[WebUI] Wait For Angular Load
[WebUI] Wait For Element Attribute Value
[WebUI] Wait For Element Clickable
[WebUI] Wait For Element Has Attribute
[WebUI] Wait For Element Not Clickable
[WebUI] Wait For Element Not Has Attribute
[WebUI] Wait For Element Not Present
[WebUI] Wait For Element Not Visible
[WebUI] Wait For Element Present
[WebUI] Wait For Element Visible
[WebUI] Wait For Image Present
[WebUI] Wait for jQuery Load
[WebUI] Wait For Page Load
Visual-based Web Testing Keywords
[WebUI] Take Area Screenshot As Checkpoint
[WebUI] Take Element Screenshot As Checkpoint
[WebUI] Take Full Page Screenshot As Checkpoint
[WebUI] Take Screenshot As Checkpoint
Mobile Keywords
[Mobile] Close Application
[Mobile] Clear Text
[Mobile] Close Notifications
[Mobile] Check Element
[Mobile] Drag And Drop
[Mobile] Double Tap
[Mobile] Execute Mobile Command
[Mobile] Find Image Element
[Mobile] Find Image Elements
[Mobile] Get Attribute
[Mobile] Get Element Height
[Mobile] Get Element Left Position
[Mobile] Get Element Top Position
[Mobile] Get Element Width
[Mobile] Get Current Orientation
[Mobile] Get Device Height
[Mobile] Get Device Manufacturer
[Mobile] Get Device OS
[Mobile] Get Device OS Version
[Mobile] Get Device Width
[Mobile] Get Text
[Mobile] Hide Keyboard
[Mobile] Long Press
[Mobile] Open Notifications
[Mobile] Press Back
[Mobile] Press Home
[Mobile] Pinch To Zoom In At Position
[Mobile] Pinch To Zoom Out At Position
[Mobile] Run iOS App in Background and Wait
[Mobile] Scroll To Text
[Mobile] Send Keys
[Mobile] Select List Item By Index
[Mobile] Select List Item By Label
[Mobile] Set Encrypted Text
[Mobile] Set Slider Value
[Mobile] Set Text
[Mobile] Switch To Landscape
[Mobile] Switch To Native
[Mobile] Switch To Portrait
[Mobile] Switch To Web View
[Mobile] Start Application
[Mobile] Start Existing Application
[Mobile] Swipe
[Mobile] Take Screenshot
[Mobile] Take Area Screenshot
[Mobile] Take Element Screenshot
[Mobile] Tap
[Mobile] Tap At Position
[Mobile] Tap And Hold
[Mobile] Tap And Hold At Position
[Mobile] Tap on Image
[Mobile] Toggle Airplane Mode
[Mobile] Unlock Screen
[Mobile] Uncheck Element
[Mobile] Verify Image Present
[Mobile] Verify Is Landscape
[Mobile] Verify Is Portrait
[Mobile] Verify Element Attribute Value
[Mobile] Verify Element Checked
[Mobile] Verify Element Exist
[Mobile] Verify Element Has Attribute
[Mobile] Verify Element Not Checked
[Mobile] Verify Element Not Exist
[Mobile] Verify Element Not Has Attribute
[Mobile] Verify Element Not Visible
[Mobile] Verify Element Visible
[Mobile] Wait For Element Attribute Value
[Mobile] Wait For Element Has Attribute
[Mobile] Wait For Element Not Has Attribute
[Mobile] Wait For Element Present
[Mobile] Wait For Element Not Present
Visual-based Mobile Testing Keywords
[Mobile] Take Area Screenshot As Checkpoint
[Mobile] Take Element Screenshot As Checkpoint
[Mobile] Take Screenshot As Checkpoint
Web Service Keywords
[WS] Contains String
[WS] Send Request
[WS] Verify Element Property Value
[WS] Verify Elements Count
[WS] Verify Element Text
[WS] Verify Response Status Code
[WS] Verify Response Status Code In Range
[WS] Get HAR File Generation
[WS] Set HAR File Generation
Windows Keywords
[Windows] Clear Text
[Windows] Close Application
[Windows] Click
[Windows] Click Element Offset
[Windows] Double-click
[Windows] Find Element
[Windows] Find Elements
[Windows] Get Attribute
[Windows] Get Element Position
[Windows] Get Element Rectangle
[Windows] Get Text
[Windows] Get Driver
[Windows] Right-click
[Windows] Right-click Element Offset
[Windows] Set Encrypted Text
[Windows] Switch to Window
[Windows] Switch to Window Title
[Windows] Send Keys
[Windows] Set Text
[Windows] Start Application with Title
[Windows] Start Application
[Windows] Switch To Desktop
[Windows] Switch To Application
[Windows] Switch to Window Title
[Windows] Switch to Window
[Windows] Verify Element Attribute Value
[Windows] Verify Element Not Present
[Windows] Verify Element Present
[Windows] Wait for Element Attribute Value
[Windows] Wait for Element Not Present
[Windows] Wait for Element Present
Cucumber Keywords
[Cucumber] Run Feature File with Tags
[Cucumber] Run Feature File
[Cucumber] Run Feature Folder with Tags
[Cucumber] Run Feature Foler
[Cucumber] Run with Cucumber Runner
Common Assertions
[Common] Verify Checkpoint
[Common] Verify Equal
[Common] Verify Greater Than
[Common] Verify Greater Than Or Equal
[Common] Verify Less Than
[Common] Verify Less Than Or Equal
[Common] Verify Match
[Common] Verify Not Equal
[Common] Verify Not Match
Utilities Keywords
[Common] Call Test Case
[Common] Comment
[Common] Concatenate
[Common] Delay
Custom Keywords
Introduction to Custom Keywords
Sample Custom Keywords
Flutter-based application testing with custom SetText keyword
Import/Export Keywords
Custom Keywords Refactoring
Import Custom Keywords classes recursively
Mark test's status for a Custom Keyword
Handling Databases
Checkpoints
Execution
Test Suite
Test Suite Collection
Skip Test Cases
Execute tests periodically on remote machines
Headless Browsers Execution
Selenium Grid - Execution on Remote Machines
Execute Tests on Multiple Devices in Parallel
Set a new default JRE for test projects
Link Execution with TestOps Release using CLI
Reports and Execution Log
Test Suite and Test Suite Collection Reports
View and Customize Execution Log
Capture Screenshots
Record Screen-based Videos
Record Browser-based Videos
View Execution Summary and Advanced Reports
Data-driven Testing
Data-driven Testing with Katalon Studio
Global Variables and Execution Profile
Test Case Variables
Run Test Case with an external data source
Enhanced Variable Binding
Manage Test Data
Database Settings
How to implement Data-driven Testing with MySQL?
Combine Multiple Data Sources
BDD Testing Framework (Cucumber integration)
Integration
Katalon API Keys
Jira Integration
Git Integration
Git Integration
Git Integration Authentication with SSH Keys
Slack Integration
Kobiton Integration
Sauce Labs Integration
BrowserStack Integration
LambdaTest Integration
JMeter Integration
Applitools Integration
Rally Integration
qTest Integration
TestRail Integration
TestLink Integration
App Center Integration
AWS Device Farm Integration
Integration with Azure DevOps Test Plans
Migration from other tools
Selenium/TestNG/JUnit Migration
Import Selenium IDE v3 projects
Katalon Studio Plugins
Using Plugins
Installing Plugin Offline
Integration Plugins
Auto-healing Smart XPath
Test Case Management With Tags
Basic Search For Dynamic Test Suite
Test Suite Collection Scheduler
Extend Katalon Studio
Create your first Katalon Studio plugin
How to develop a Custom Keywords plugin
Debug your platform plugin using Eclipse IDE
Build custom keywords with Settings
How to resolve external dependencies for a plugin
Develop a customized report plugin
How to generate groovydoc for a plugin
Example plugin: Build Katalon Studio's TestRail Integration plugin
Troubleshooting
Troubleshoot common exceptions
Troubleshoot web automated testing
Troubleshoot mobile automated testing
Troubleshoot Windows automated testing
Known issues
Tips and Tricks
Connect to SQL using Windows Authentication
Execute Windows commands
Execute Xpath functions
Executing tests on Mobile Browser and app in a single test case
Force stop execution
Get SQL query results as variables
Handle file upload control on hidden input
How to pass exitCode from Katalon to Jenkins in order to inform of Test Case failures
How to use different browser versions
Install Chrome extensions at runtime
Katalon with Winium for Desktop Applications
Manage Android's permission
Open Chrome with extensions
Optimizing Object Identification and Tools
Override desired capabilities at runtime
Reduce Execution Time in Mobile Testing
Retrieve OS, browser and screen resolution of the machine perfoming tests
Retrieve chromedriver.log and firefoxdriver.log when you run Record/Spy
Retrieve mobile's session
Understand waiting keywords
Using autoIT for authentication in Katalon Studio
Proof of Concept
Dependencies Management with Native Gradle Support (Poc)
Parameterize Azure DevOps Test Case ID List (PoC)
Javadoc
Deprecated Documentation
VSTS/TFS/VSO Integration
Jenkins Integration
Katalon Runtime Engine
Introduction to Runtime Engine
Install Runtime Engine
Export Test Results in JUnit Format
Command Syntax (Command-line/Console Mode Execution)
Specify a path to Android SDK root folder
Terminate Execution Conditionally
Docker Image
Run with Cloud CIs
Continuous integration with Gitlab
CI/CD Plugins
Common Configuration
Jenkins Plugin
On Windows
On Ubuntu
Integrate Jenkins on Docker hosted in Ubuntu
Passing scenario tags at runtime when building with Jenkins
Bamboo Add-on
Azure DevOps Extension
TeamCity Plugin
CircleCI - Katalon Orb
Katalon Studio Github Action
Troubleshoot
joptsimple.IllegalOptionSpecificationException: $ is not a legal option character
Katalon Store
Overview
Install, use, and review a Plugin
Access to Katalon Store in Katalon Studio
Manage API Keys
Essential Plugins Bundle
Submit and publish plugins
Submit and publish a new plugin
Plugin document guidelines
Brand guidelines for Katalon Store publishers
Plugin approval guidelines
Manage published plugins
Katalon TestOps
Overview
TestOps Overview
Terminology and Formulas
What's New
April 2021
March 2021
Release Notes
Get Started
Roles and permissions
Set up an account
Create Organization and Project
Set up Teams
Manage Users
Install TestOps On-premises with Docker
Remote Execution
Overview
Script Repository
Upload Test Scripts to a Script Repository
Upload Test Scripts from a Git Repository
Local Test Environments
Create a Local Test Environment with an Agent
Load Balancing for Local Test Environments
Run multiple Test Suites in parallel with Agents
Auto-Distributed Executions
Docker Test Environments
Kubernetes Test Environments
Test Planning
Overview
Schedules
Schedule Test Runs
Execute Test Runs
Releases
Builds
Test Management
Writing BDD in Jira
View BDD Test Results
Link Test Runs to Jira Defects
Link Test Cases to Jira Requirements
Integrations
Katalon Studio Integration
Framework Integration
Upload JUnit and Katalon Studio Test Results using Katalon Report Uploader
Upload JUnit and Katalon Studio Test Results via a web browser
Upload Test to Katalon TestOps via Mocha
Upload Test to Katalon TestOps via Jest
Upload Test to Katalon TestOps via Jasmine
Upload Test to Katalon TestOps via Pytest
Jira Integration
Kobiton Integration
Slack Integration
Jenkins Integration
Test Maintenance
Change the Test Result from failing to passing
Compare Test Results
Reporting
View TestOps Dashboard
Filter Test Runs list by Build name
View Re-run Test Results
Visual Testing
View Requirement Coverage heat map
View Test Case reports
Detect abnormal Web Services
Settings
Delete data
Enable/Disable Strict Domain
IP Address Restrictions
Subdomain Configurations
Single Sign-On Configurations
Configure Session Timeout
Notification Emails
API Keys
REST API
Tutorials
Katalon Recorder
Get started
Overview
GUI Overview
What's new
What's new
What's new in 5.3.x
Release notes
Production Evaluation Center
Katalon Recorder vs Selenium IDE
Katalon Recorder vs Alternatives
Get your job done
Automate scenarios
Selenese (Selenium IDE) Commands Reference
Create your first automation script
Control the flows
Back up data automatically
Execute scenarios
Use the Self-Healing function
Use the Commande-Line Runner
Execution report
View execution reports in TestOps
Export scenarios
Export automation scripts to other frameworks
Writing Custom Script Formatter
Data-driven excecution
Extend Katalon Recorder
Katalon Recorder Helper Tool
Extension Scripts (AKA user-extensions.js) for Custom Locator Builders and Actions
Import Tests from Selenium IDE
Command Compatibility between Selenium IDE and KR
Help & Resources
FAQ & Troubleshooting Instructions
Samples
Acknowledgments
Katalium Framework
Overview
Get Started
In Visual Studio Code
In other IDEs
Create a Test Case
Page Object Model
Create a Test Suite
Configure Browsers
Other Utilities
Real-time Monitoring and Reporting
Katalium Server
Overview
Get Started
Katalium Server - Execute Katalon Studio's scripts on Remote Machines
WebDriver Auto-update
Sessions Monitoring
Contributing Guidelines
Contents