AI self-healing

Hi all,

I saw that AI self-healing was supported on the latest version. But I did not see that option. So do we have to enable any configuration somewhere? I just installed the Enterprise Trial version.

Thank you.

2 Likes

@Elly_Tran can you help?

1 Like

You’re asking about AI self-healing in Katalon Studio. Based on the official documentation, there are actually two different self-healing features in Katalon Studio, and the configuration depends on which one you’re looking for:

1. Standard Self-Healing (Enabled by Default)

This feature is enabled by default in your Enterprise Trial and doesn’t require additional configuration. It automatically tries alternative locators when an element’s primary locator fails.

Location: Project Settings > Test Design > WebUI (or Mobile)

2. AI Self-Healing (Requires Configuration)

This is the advanced AI-powered version that uses OpenAI’s LLM to intelligently recover broken locators. This requires additional setup.


Root Cause

If you’re not seeing the AI self-healing option, it’s likely because:

  • You haven’t enabled it yet - It’s not enabled by default; you must explicitly enable it
  • You don’t have an OpenAI API key configured - This is required for AI self-healing to work

Solutions

Solution 1: Enable AI Self-Healing

Step-by-step instructions:

  1. Go to Project Settings > Self-Healing > WebUI
  2. Check the box for Enable AI-self healing
  3. Select the input data sources for AI analysis (more sources = higher accuracy but slower processing):
    • Page source
    • Accessibility tree
    • Full-page screenshot
    • Element screenshot

Source: Katalon Studio Self-Healing Documentation

Solution 2: Configure Your OpenAI API Key

AI self-healing requires a personal OpenAI API key. You have two options:

Option A: Via Launch Arguments (Simpler but less secure)

  1. Go to Project Settings > Execution > Launch Arguments
  2. Enter: -DOPENAI_API_KEY=${{ YOUR_API_KEY }}

Option B: Via Global Variable (More secure)

  1. Store your API key in a Global Variable
  2. Add this script to your test case or test listener:
System.setProperty("SELF_HEALING_AI_MODEL", "${{ YOUR_AI_MODEL }}")
System.setProperty("OPENAI_API_KEY", "${{ YOUR_API_KEY }}")

Replace ${{ YOUR_AI_MODEL }} with your model name (defaults to gpt-4o-mini if not specified) and ${{ YOUR_API_KEY }} with your OpenAI API key.

Source: Katalon Studio Self-Healing Documentation


Key Notes

:white_check_mark: Standard self-healing is already enabled in your Enterprise Trial - no configuration needed
:white_check_mark: AI self-healing is optional - only enable if you want LLM-powered locator recovery
:warning: AI self-healing requires an OpenAI API key - this is a personal requirement, not a Katalon license feature

Hi @Monty_Bagati,

I did not see the AI self-healing option on the place that you mentioned

And with Solution#2, I input the option A, will the Katalon proceed AI self-healing automatically? is it correct?

Thank you.

Hi,

AI Self-healing requires your personal API key from OpenAI, please follow these steps:

  1. Obtain a personal API key from OpenAI
  2. Enable AI self-healing in ​Project > Self-healing > WebUI
  3. Allow different input data sources for the AI to increase healing accuracy
  4. Provide your OpenAI API key in ​Project Settings > Execution > Launch Arguments​ with the argument -DOPENAI_API_KEY=${{ YOUR_API_KEY }}

If you still can’t see AI self-healing option, please upgrade to the latest version. Thank you

Hi Elly,

I’m using the latest version 10.

@Elly_Tran @Monty_Bagati

I’m also not able to see the AI self healing option.

Do we have to do some configurations at project level?

I’m using KS 10.4.2

Thank you for sharing with us. We will check with my team and let you know soon

1 Like

Hi all,

This feature will be available in the RC version which’s not yet been released. If you want to try, you can download that version here:

Please note that this build is for evaluation purpose only, not ready for production use yet. We will update this content on our Doc and welcome all the feedback.

Thank you

Hi Elly,

I can find that option on the build.

Thanks for your support.

Hi @Elly_Tran,

1 more question, when will the version with AI self-healing supporting be released to PROD?

Thank you.

Hi @ductranviet,

Happy new year. Sorry for my late response. We plan to have v11 officially released by the end of this January. Thank ypu

Thank you for the notice!