Introduction to Custom Keywords and some sample keywords in katalon

Create a custom keyword

Following are the steps to create a custom keyword:

1. Follow this order File - > New - > Keyword. After this, a new keyword dialog box will appear to enter the keyword's name and specify the package you want to use for the keyword. 

2. A new keyword will be created under the specified package accordingly.

3. Enter this code snippet in your class to define a custom keyword.

@Keyword (keywordObject = "<name>")
     def keywordName(params) { }

4. Now save the keyword file.

Use custom keywords

In manual view

Follow the below steps to use custom keywords in the manual view:

1. First, open a test case in the manual view, and after that select the custom keyword from the command toolbar.

2. Now you can select any of the custom keywords.

In script view

Follow the steps below to use custom keywords in the script view:

 1. The class CustomKeywords of the Katalon Studio allows you to access all the custom keywords. Just enter this in the script editor:

CustomKeywords.

2. Now when you put a dot after CustomKeywords in the script editor then a series of custom keywords will appear on your screen. This is a feature of Katalon Studio which is called Content Assist it helps users by providing suggestions to users for code completion.

3. Select the keyword and provide the parameters.

Following is a list of classes that may prove to be helpful while working with custom keywords: 

Sample Custom Keywords

When we create a new Custom Keyword, we can generate sample custom keywords used for Web, Mobile, or API testing. All the options are displayed directly when a user creates a new custom keyword.

Users can either select one of the three options, or he/she can select all the options to generate sample keywords. For example, if a user selects all the options then the generated custom keyword would look like this:

class codingNinjas {
    @Keyword
    def CN() {
        KeywordUtil.logInfo("Katalon")
        WebDriver webDriver = DriverFactory.getWebDriver()
        webDriver.navigate().refresh()
        KeywordUtil.markPassed("Ninja in making")
    }


    /**
     * element click
     * @param to Katalon test object
     */
    @Keyword
    def elementClick(TestObject to) {
        try {
            WebElement element = WebUiBuiltInKeywords.findWebElement(to);
            KeywordUtil.logInfo("Clicking an element")
            element.click()
            KeywordUtil.markPassed("Element clicked once")
        } catch (WebElementNotFoundException e) {
            KeywordUtil.markFailed("Not found")
        } catch (Exception e) {
            KeywordUtil.markFailed("Failed to click an element")
        }
    }


    /**
     * To get all rows of an HTML table
     */
    @Keyword
    def List<WebElement> getHtmlTableRows(TestObject tbl, String tgName) {
        WebElement mails = WebUiBuiltInKeywords.findWebElement(tbl)
        List<WebElement> rows = mails.findElements(By.xpath("./" + tgName + "/tr"))
        return rows
    }


    /**
     * Check if element is present in timeout
     */
    @Keyword
    def ifElementIsPresent_Mobiel(TestObject test, int time){
        try {
            KeywordUtil.logInfo("Finding an eleement with id " + test.getObjectId())


            WebElement element = MobileElementCommonHelper.findElement(test, time)
            if (element != null) {
                KeywordUtil.markPassed("Obj " + test.getObjectId() + " is present")
            }
            return true
        } catch (Exception e) {
            KeywordUtil.markFailed("Obj " + test.getObjectId() + " is not present")
        }
        return false;
    }



    /**
     * Send request and verify the status code
     */
    @Keyword
    def verifyStatusCode(TestObject req, int status) {
        if (req instanceof RequestObject) {
            RequestObject requestObject = (RequestObject) req
            ResponseObject response = WSBuiltInKeywords.sendRequest(requestObject)
            if (response.getStatusCode() == status) {
                KeywordUtil.markPassed("Matched")
            } else {
                KeywordUtil.markFailed("Does not match. Expected: " +
                        status + " - Actual: " + response.getStatusCode() )
            }
        } else {
            KeywordUtil.markFailed(req.getObjectId() + " is not a reqObject")
        }
    }



    /**
     * Add Header authorization field
     */
    @Keyword
    def addBasicAuthorizationProperty(TestObject req, String name, String pass) {
        if (req instanceof RequestObject) {
            String authValue = name + ":" + pass
            authValue = "Basic " + authValue.bytes.encodeBase64().toString()


            List<TestObjectProperty> header = req.getHttpHeaderProperties()
            boolean exist = false
            for (int i = 0; i < header.size(); i++) {
                TestObjectProperty headField = header.get(i)
                if (headField.getName().equals('Authorization')) {
                    KeywordUtil.logInfo("Found existent basic authorization field and now replacing its value.")
                    headField.setValue(authValue)
                    exist = true
                    break
                }
            }


            if (!exist) {
                TestObjectProperty authProperty = new TestObjectProperty("Authorization",
                        ConditionType.EQUALS, authValue, true)
                header.add(authProperty)
            }
            KeywordUtil.markPassed("Basic authorization field added to request header")
        } else {
            KeywordUtil.markFailed(req.getObjectId() + "is not a RequestObject")
        }
        return req
    }

}

Frequently Asked Questions

What are keywords in Katalon?

Built-in keywords are intended to make it easier for users to automate with less coding experience. Katalon Studio has a custom keyword feature that makes it easier for users to expand automation capabilities. 

Which framework does Katalon Studio use?

Katalon Studio uses the language Groovy, which is built using Java. Groovy is a scripting language with a syntax similar to Java. Groovy uses dot-separated notation makes it easier to write code while maintaining and allowing syntax to operate collections, Strings, and JavaBeans.

Is Katalon Studio free for use?

Yes, Katalon studio is free to use. Many users find its fully functional version free for use. The testing services which KMS Technology offers are used to pay for product development at Katalon.

What are the advantages of using Katalon studio?

• Katalon Studio uses several types of testing.
• It has a user-friendly GUI.
• It is free to use.
• Intuitive Analytics and Dashboard report.

Can we use Java in Katalon?

Yes, as Katalon Studio is based on Java, we can write code in Java in Katalon Studio. When we write scripts and custom keywords, we can either write them in Groovy or Java. 

Conclusion

We have discussed the custom keyword and sample keywords in Katalon. We started with custom, then we looked into some sample custom keywords, and in the end, we discussed an example that had some custom keywords in it.

We hope this blog has helped you. We recommend you to visit our articles on different topics of Katalon Studio, such as

1. Tips and Tricks in Katalon Studio.
2. Keyboard shortcuts in Katalon studio.
3. Toolbars and views in Katalon Studio.

If you liked our article, do upvote our article and help other ninjas grow.  You can refer to our Guided Path on Coding Ninjas Studio to upskill yourself in Data Structures and Algorithms, Competitive Programming, System Design, and many more!

Head over to our practice platform Coding Ninjas Studio to practice top problems, attempt mock tests, read interview experiences and interview bundles, follow guided paths for placement preparations, and much more!!