[WebUI] Smart Wait Function

Estimated reading time: 2 minutes

Starting in Katalon Studio version 7.0, the Smart Wait function is available.

Currently, one of the most common problems that Katalon users may have encountered is that elements cannot be interacted with since they are not visible, interactable or other elements would receive the operations instead of the intended ones. This issue is because the page hasn't completely loaded or some operations including adding, removing or modifying elements of that page haven't finished performing yet. To solve this issue, a smart waiting function is introduced in Katalon Studio version 7.0. The Smart Wait will tell the web driver to wait for the web page to become static before any operations perform.

Apply Smart Wait to all elements in a project

To enable the Smart Wait function for the whole project in Katalon Studio, navigate to Project > Settings > Execution> Select Enable in Default Smart Wait.

Apply Smart Wait to specific elements in a script

If you want to use Smart Wait function for certain test elements only, it's important that you disable Default Smart Wait in Project Settings. Navigate to Project > Settings > Execution> Select Disable in Default Smart Wait. Then use enableSmartWait and disableSmartWait keywords to enable and disable this function respectively.

enableSmartWait

Description: Enable the Smart Wait function when it's disabled by default in project settings.
Keyword name: enableSmartWait.

disableSmartWait

Description: Disable the Smart Wait function when it's enabled by using the above keyword.
Keyword name: disableSmartWait.
Example:

WebUI.openBrowser('')

WebUI.navigateToUrl('https://store.katalon.com/')

WebUI.maximizeWindow()

WebUI.click(findTestObject('signin-link'))

WebUI.enableSmartWait()

WebUI.setText(findTestObject('username'), 'demo@katalon.com')

WebUI.setEncryptedText(findTestObject('password'),'3zBGMH+v8QQXwX1AbEAx2g==')

WebUI.click(findTestObject('signin-button'))

WebUI.click(findTestObject('menu-dropdown'))

WebUI.click(findTestObject('dashboard-item'))

WebUI.click(findTestObject('plugins-item'))

WebUI.disableSmartWait()

WebUI.closeBrowser()

Note: The Smart Wait function is only available in Chrome and Firefox.

Sample Test

Sample tests are available for your download.

User Contributed Notes