Passing Object Names as String Variables in Katalon Studio

While working on a Custom Keyword, I noted the code could be even more modular if I was able to pass in the object name. It doesn’t need to be an object, just the path to the object in the Object Repository. As a simple example, take the code to read the value from a Select or Input field. The code is the same except for the referenced object.
The code would look like:

int resultsPerPage=WebUI.getAttribute(findTestObject('Sales Data/Sales Table/select-Results Per Page'),'value').toInteger()

With that in mind, we could create a variable with the path, then call the Custom Keyword with that variable. The code would then look like:

objectPath="Sales Data/Sales Table/select-Results Per Page"
CustomKeywords.'commonCode.DataCollection.getResults'(objectPath)

We could then change the path and call the Keyword again, still using the same code.
As a slightly more involved example, we have a page with three sets of filters. Each row has a different definition which meant three objects in the repository. When setting up code to manipulate those filters, everything is the same except for the object name. In order to verify all three rows of filters, 3 code blocks would be needed.
However, setting a variable to the path of the object means the code can be re-used.

//Validate the second row of filters
for (loop = 1; loop <=3; loop++) {
WebUI.click(findTestObject(filterName)
CustomKeywords.'commonCode.verifyFilter.verifyTableData'(objectPath, loop, filterType[loop], filterDescriptionText[loop])
WebUI.delay(2)
}

It would also be possible to make a List of path names and refer to that as well.
This may not be the best or most effective way to work with objects, but it’s very straightforward and easy to understand. This has come up a couple of times already where I’ve been able to substitute the object path and parameterize larger portions of my code blocks.

Other articles of interest:

Leave a Reply

Your email address will not be published. Required fields are marked *

Recent Comments
  • How To Disable the Quicken Registration Prompt (24)
    • Joe SR>: My monthly income is deposited into my Credit Union account. I use debit whenever possible. I write checks manually and mail them. I use Quicken 2012 off-line only. I have entered all my money and investment accounts. I...
    • Prtet: Never say never….every time I swear I will never use Quicken again, I discover that there are still no viable alternatives. Amazing that there is no decent personal finance software.
    • Joe D.: Holding CTRL + Shift keys and selecting On Line | One Step Update from the main menu worked for my Quicken 2004. I’m grateful that you wrote a synopsis (“Simply put, …”) just beneath the link to the blog...
    • Susan Long: I bought my quicken disc in the beginning and it came with a registration number. I rang the helpline and they gave me the code to put in and talked me through it. It you downloaded your version then you don’t own it...
    • Peter: You might consider running your old version of Quicken on an ancient computer. This is what I have done for years. The newer versions are fraught with problems- criminal, in my opinion. One version made mathmatical errors when...
    • Roslyn Chamberlain: Can I stop the countdown in quicken 2001 says only 8 sessions left. and what will happen after?
  • Parsing Strings in Katalon – Split, Substring and Readlines (1)
    • Ellen: Thanks for sharing!! I like your contributions to Katalon topics.
  • Working with Dates and Date Formatting in Katalon Studio (6)
    • Ajoo: Thank you for the details. How do i remove leading “0” from dates. i.e. while formatting i receive 04/21/2019, but i need 4/21/2019. (same applies for date)
  • What is Katalon Studio? A Distro of Selenium, Groovy and Eclipse (1)
    • Mahesh: Looking for more posts on katalon studio.your katalon stuffs are always exiting
  • Simple wildcard searches for pattern matching (2)
    • Don Pedro: For that scenario it seems .contains would be your choice. For example, variable.contains(‘amazo n.com’) to see if the url had amazon.com. In that case, www.amazon.com, forum.amazon.com, retail.amazon.com would all...
    • Jony: Hi, How can I use a wild card to assert a URL is the one I want. I just want to verify the domain ==expected but not anything after it. Tried * but not working and only works when I have full URL.
  • Create a Dynamic Object at Runtime (2)
    • Saish: How to add shadow root parent to this runtime object..
    • Jeremy Brien: I appreciate this! I saw this post on LinkedIn this morning and was able to find a use case for it! I found that defining my xpath with an iterable variable allows me to loop through and capture text from tables created...
  • Output status messages and test information by writing to the Log File Viewer in Katalon Studio (2)
    • Don Pedro: That would be things like: log.logWarning(‘The import date listed on the site is: ‘ + importDate) log.logWarning(‘The value from the site is: ‘ + salesFigure) log.logWarning(‘Filter Results for ‘ +...
  • Setting up a repeatable Search Method in Katalon Studio (1)
    • RJ: Thanks a lot! This is very helpful 🙂