Skip to main content

StudioAssist Ask mode

This document explains how to use StudioAssist Ask mode in Katalon Studio.

requirements
  • Katalon Studio Enterprise version 10.1.0 onwards.
  • An AI provider selected. For more details, see StudioAssist Preferences.

StudioAssist Ask mode is a chat interface built into Katalon Studio that lets you interact with an AI assistant without leaving your workspace. Use it to:

  • Ask questions about Katalon Studio features and built-in keywords
  • Generate and explain test scripts (Web, Mobile, API)
  • Create and explain custom keywords
  • Troubleshoot execution failures
  • Refactor and optimize existing test code

Open chat window​

The StudioAssist chat window opens automatically on the right panel when Katalon Studio starts. If it is not visible, click the StudioAssist icon in the main toolbar to open it.

StudioAssist icon in Katalon Studio

Common use cases​

Write test scripts​

Write a web test script using existing objects​

Specify the application type, test objects, variables, and steps clearly. If you already have test objects in your project, reference them directly.

I have the following test objects:
- Make appointment button: 'Page_CuraHomepage/btn_MakeAppointment'
- Username: 'Page_Login/txt_UserName'
- Password: 'Page_Login/txt_Password'
- Login button: 'Page_Login/btn_Login'
- Appointment div: 'Page_CuraAppointment/div_Appointment'

I also have a URL stored in GlobalVariable.G_SiteURL and two string variables: Username and Password.

Write a test case that:
1. Opens the browser to G_SiteURL
2. Clicks the Make Appointment button
3. Fills in username and password using the variables
4. Clicks the Login button
5. Closes the browser

For a ready-made set of test objects to practice with, refer to Sample WebUI Healthcare project.

Write a mobile test script​

Provide the app ID and a list of test objects captured with Mobile Object Spy.

Write me a mobile test case with the following steps:
1. Start application, uninstalling the application automatically after run
2. Tab on the linear layout, timeout 0
3. Get text 'HorizontalNestedScrollView', timeout 0
4. Close the app
My app ID: 6261b88f-275b-4ae5-b0d1-b95fbf2560bd
Object list:
findTestObject('Object Repository/android.widget.LinearLayout')
findTestObject('Object Repository/android.widget.TextView - HorizontalNestedScrollView')

Write an API test script​

Specify the endpoint, HTTP method, and expected behavior explicitly.

Write me an API test case with the following steps:
1. Send a GET request to 'https://reqres.in/api/users?page=2'
2. Verify that the response status code is 200

Use the object ID: findTestObject('getAllUsers')

Create a custom keyword​

Provide detailed requirements for the keyword.

Write a custom keyword for login handling:
- Method name: login
- Accept TestObjects for username, password fields, login button
- Accept Strings for username, password

If your project already has a custom keyword library, you can reference them directly in your request to build new test scripts.

I have the following custom keywords available:
- com.example.keywords.WebActions.clickElement(TestObject element)
- com.example.keywords.WebActions.fillField(TestObject field, String value)
- com.example.keywords.WebActions.waitForPageLoad(int timeoutSeconds)

I have these test objects:
- Login button: findTestObject('Page_Login/btn_Login')
- Email field: findTestObject('Page_Login/txt_Email')
- Password field: findTestObject('Page_Login/txt_Password')

Write a test case that:
1. Waits for the page to load (timeout: 10 seconds)
2. Fills in the email field with GlobalVariable.G_Email
3. Fills in the password field with GlobalVariable.G_Password
4. Clicks the login button

Troubleshoot failures using real error output​

Instead of describing a failure in abstract terms, attach the execution log directly to the chat. StudioAssist can identify the root cause and suggest a fix with the actual error context in scope.

My test case failed with the following error. Identify the most likely cause and suggest a fix:
//Paste your execution log here

Refactor existing test code​

Clarify the optimization intent, make general requests to improve or refactor your code.

Optimize this code for better performance:
for (int i = 0; i < array.length; i++) {  
    if (array[i] % 2 == 0) {  
        System.out.println(array[i]);  
    }  
}

Attach files and images​

You can now include files from your project or local machine directly in a conversation to give StudioAssist more context.

  1. In the StudioAssist chat window, click the paperclip icon to attach files.

    Click paperclip icon to attach files

  2. Choose one of the following:

    • Select from project: Browse test cases, test suites, listeners, Groovy/Java files, feature files, etc.
    • Select from computer: Upload external files such as CSV data files, images and screenshots.
note
  • You can send up to 10 files per question.
  • Each file must be text-based and under 10MB.
  • Invalid files are flagged and won't be sent.
  • Attachments appear above the input field and are also shown under each sent message.
  1. After you sent the file(s), StudioAssist will return the result according to your request.

Use current file as context​

In addition to manual file attachment, StudioAssist automatically includes the content of the file you're actively working on as context. This removes the need to manually copy-paste file content into the chat.

In the chat window, the Current file box is selected by default to include the file you're working on. When you switch between files, the context also automatically updates. If you want to turn this off, simply untick the box.

Use current file as context
Supported file types
  • Test case
  • Test suite
  • Dynamic test suite
  • Test listener
  • Web service request
  • Custom keyword
  • BDD feature file
  • Profile
  • Step definition (.groovy file)
  • Java class (.java file).

Tips for getting better responses​

To get the best results when asking StudioAssist to generate a test case, provide clear and specific details. Here are some tips:

  1. Clearly specify your input in certain format. When you need to perform multiple actions, provide a list of actions.
 * 1. Open a browser to a URL
 * 2. Log in to the website
 * 3. Click the login button
 * 4. Input username and password
 * 5. Clock the browser

  1. Clearly specify the type of application under test (Web. Mobile, API).

    Write me a mobile test case.

  2. Enable Auto-include project context information in StudioAssist Preferences to auto-populate object IDs.

  3. Regularly clear the conversation when switching contexts. All attached files remain in context until the conversation is cleared. A large or mixed context can reduce response relevance.

  4. Set completion tokens to 16000 for optimal responses.

Known limitations​

StudioAssist Ask mode currently has a few limitations:

  • Limited knowledge base: StudioAssist does not yet pull information directly from Katalon Studio’s official documentation. For complex or uncommon queries, use Agent mode.
  • Project context limitations: StudioAssist is not aware of global variables, custom keywords, other test cases, test data, etc. To make sure that the code is generated with proper variables and locators, we recommend specifying them in your question, or use Agent mode.
  • Single conversation mode: StudioAssist supports only one active conversation at a time. Refresh the chat window (close/re-open) as you switch contexts for better accuracy.
  • AI response accuracy disclaimer: Responses may be inaccurate or misleading due to hallucination, a common issue in LLM AI models. Always verify AI-generated output before implementation. You may rate responses as Good or Not Relevant. However, your feedback is not used to train the AI model or track your conversations.
  • Performance: Projects with large number of test objects (more than 200 test objects) may cause timeouts when StudioAssist attempts to enumerate all objects.
Was this page helpful?