Home > Articles > Programming

This chapter is from the book

Evolving Custom Scripting into Reusable Methods

Up to this point, you have learned how to make different types of enhancements to your scripts, making them more robust. You saw how to add delays, introduce timers, work with the Windows Clipboard, manipulate different objects you recorded (such as test objects and verification points), and so on. Rational Functional Tester enables you to expand these techniques by turning them into generic, reusable methods.

Methods that are reusable and, ideally generic, enable you to apply them to more than one object or script. You can often use them across your entire test project. This enables you to create methods that benefit everybody on your team, saving time on your overall test automation effort.

The first thing that is involved with creating custom methods is setting up the signature. Basically, you specify the type of data your method needs to receive and the type of data it needs to send back when it’s done executing. You can work with the typical data types and objects that the Java and VB.NET languages work with. For example, you might have an add method with a signature that looks like the following:

public int add(int i, int j)

The VB.NET equivalent is:

Public Function add(ByVal i As Integer, ByVal j As Integer) As Integer

In both instances, you are merely passing two integers into the method (function in VB.NET), returning the sum of them as an integer.

Rational Functional Tester enables you to pass and return test objects. This gives you the ability to create custom methods for the objects that you capture in your test object map. A simple instance of this might be a method to test if an object is enabled or not. The method signature would like the following Java example:

public Boolean isEnabled(TestObject myGuiObject)

In VB.NET, you see:

Public Function isEnabled(ByVal myGuiObject As TestObject) As Boolean

If you use a signature, such as the preceding examples, you can pass any test object that contains enabled property to your custom method. You can test if a button is enabled before you click it, a tree is enabled before you navigate it, a text box is enabled before typing in it, and so on.

After you have the signature defined for your method, it is a matter of providing the code that accomplishes your desired task. You might write reusable methods that wait for test object properties to change, that acquire data from test objects, and set properties for test objects. Regardless of the methods that you create, you can organize and package them into Helper Superclasses, calling them from your scripts.

Helper Superclasses (also called Helper Base Classes in the VB.NET version of the tool) are an excellent way for you to create a simple, project-wide means for storing your reusable methods. You can easily create a Helper Superclass in Rational Functional Tester by performing the following steps:

  1. Click File > New > Helper Superclass (this launches the Create Script Helper Superclass Wizard).
  2. Select the location to store your Helper Superclass.
  3. Provide a name for your Helper Superclass.
  4. Click the Finish button.

If you are using the VB.NET version, the steps are:

  1. Click File > New > Add Helper Base Class (this will launch the Add New Item Wizard, preselecting the Script Helper Base Class template).
  2. Provide a name for your Helper Base Class.
  3. Provide a location for your Helper Base Class.
  4. Click the Add button.

In either case, you end up with an empty class, prebuilt to extend the default capabilities of Rational Functional Tester’s RationalTestScript class. This is where you start constructing your custom, reusable methods. The following code samples, contained in Listing 3.18, show a Java and a .NET helper class. These contain the following sample methods from prior sections:

  • printValueProperties()—“Retrieving All Properties of a Test Object” section
  • getAllListElements()—“Using getTestData to Extract Data from a List” section
  • printRootNodes()—“Using getTestData to Extract Data from a Tree” section

Listing 3.18. Helper Classes

package HelperSuperclasses;

import java.util.Enumeration;
import java.util.Hashtable;

import com.rational.test.ft.object.interfaces.TestObject;
import com.rational.test.ft.script.RationalTestScript;
import com.rational.test.ft.vp.ITestDataElement;
import com.rational.test.ft.vp.ITestDataElementList;
import com.rational.test.ft.vp.ITestDataList;
import com.rational.test.ft.vp.ITestDataTree;
import com.rational.test.ft.vp.ITestDataTreeNode;
import com.rational.test.ft.vp.ITestDataTreeNodes;

public abstract class MyHelperSuperclass extends RationalTestScript
      public void printValueProperties(TestObject testObject) {

            Hashtable valueProperties = testObject.getProperties();
            Enumeration valuePropNames = valueProperties.keys();
            Enumeration valuePropValues = valueProperties.elements();
            while (valuePropNames.hasMoreElements()) {
                  System.out.println(valuePropNames.nextElement() + ":"
                              + valuePropValues.nextElement());

      public String[] getAllListElements(TestObject testObject) {
            String[] all = null;
            ITestDataList iList = (ITestDataList)
            int count = iList.getElementCount();
            all = new String[count];
            ITestDataElementList iElementList = iList.getElements();
            for (int i = 0; i < count; i++) {
                  ITestDataElement iElement = iElementList.getElement(i);
                  String value = iElement.getElement().toString();
                  all[i] = value;
            return all;

      public void printRootNodes( TestObject tree ) {
            String selectedNode = null;

            ITestDataTree iTreeData =
            ITestDataTreeNodes iNodes = iTreeData.getTreeNodes();
            ITestDataTreeNode[] rootNodes = iNodes.getRootNodes();
            for(int i = 0; i < rootNodes.length; i++) {
                  String nodeData = rootNodes[i].getNode().toString();
                  System.out.println( nodeData );
Imports Rational.Test.Ft.Script
Imports Rational.Test.Ft.Vp
Imports System
Imports System.Collections
Imports Rational.Test.Ft.Object.Interfaces

Namespace ScriptHelperBaseClasses

    Public MustInherit Class MyScriptHelperBaseClass
        Inherits RationalTestScript

        Public Sub printValueProperties(ByVal testobject As TestObject)
            Dim valueProperties As Hashtable = testobject.GetProperties
            Dim valuePropNames As ICollection = valueProperties.Keys
            Dim valuePropValues As ICollection = valueProperties.Values

            Dim enumPropNames As IEnumerator = valuePropNames.GetEnumerator()
            Dim enumPropVals As IEnumerator = valuePropValues.GetEnumerator()

            Do While enumPropNames.MoveNext And enumPropVals.MoveNext
                Dim currentProp As String = enumPropNames.Current
                Dim currentPropVal As Object = enumPropVals.Current
                If TypeOf currentPropVal Is Object Then
                    If Not (TypeOf currentPropVal Is String) Then
                        currentPropVal = currentPropVal.ToString
                    End If
                End If
                Console.WriteLine(currentProp + ":" + currentPropVal)
        End Sub

        Public Function getAllListElements(ByVal testObject As TestObject) As
            Dim iData As ITestDataList = testObject.GetTestData("list")
            Dim count As Integer = iData.GetElementCount()
            Dim all(count - 1) As String
            Dim iElementList As ITestDataElementList = iData.GetElements()

            For i As Integer = 0 To count - 1
                Dim iElement As ITestDataElement = iElementList.GetElement(i)
                Dim value As String = iElement.GetElement().ToString()
                all(i) = value

            Return all
        End Function

        Public Sub printRootNodes(ByVal tree As TestObject)
            Dim selectedNode As String = Nothing
            Dim iTreeData As ITestDataTree = tree.GetTestData("tree")
            Dim iNodes As ITestDataTreeNodes = iTreeData.GetTreeNodes()

            Dim rootNodes As ITestDataTreeNode() = iNodes.GetRootNodes()
            For i As Integer = 0 To rootNodes.length - 1
                Dim nodeData As String = rootNodes(i).GetNode.ToString
        End Sub

    End Class
End Namespace

Please note that you might need to import certain packages and namespaces (depending on whether you are using Java or VB.NET). You receive errors from the compiler that let you know that certain classes, structures, objects, and so on do not exist. In the Java version of the tool, you can usually perform a <Ctrl> + O keystroke combination. This imports the necessary packages. There might be instances where you have to review the error messages to get an idea of what package needs to be imported. The VB.NET version of the tool requires you to import the necessary namespace.

After you have your Helper Superclass set up, creating the desired reusable methods, you need to perform two more steps. The first is to tell your test scripts to use the new class. In other words, you want to tell your scripts about the new methods that you created. The second step is to actually call your custom methods from your script.

You can associate your new Helper Superclass either at the individual script level or at the project level. Associating your Helper Superclass at the project level causes any new script to be aware of your custom methods. If you already have scripts created, you need to associate your Helper Superclass to each of them. To associate your Superclass to your project, you do the following:

  1. Right-click your project node in the Functional Test Projects view (Solution Explorer, if you’re using Rational Functional .NET).
  2. Click Properties.
  3. Click Functional Test Project (on the left-hand side of the Properties window).
  4. Click the Browse button next to the Script Helper Superclass property (Script Helper Base Class property if you are using Rational Functional Tester .NET).
  5. Select your created Helper Superclass (Helper Base Class).

    Note: You might need to type the first few letters of the name of your Super Helper class to get it to display in the list when using the Java version of Rational Functional Tester.

  6. Click the OK button.

Associating your Helper Superclass to individual scripts is a similar process. You need only to perform the following steps:

  1. Right-click an existing script in your project node in the Functional Test Projects view (Solution Explorer, if you are using Rational Functional .NET).
  2. Click Properties.
  3. Click Functional Test Script (on the left-hand side of the “Properties” window).
  4. Click the Browse button next to the Helper Superclass property.
  5. Click the created Helper Superclass (Helper Base Class).

    Note: You might need to type the first few letters of the name of your Super Helper class to get it to appear in the list when using the Java version of Rational Functional Tester.

  6. Click the OK button.

After you make the necessary Helper Superclass associations, the last thing you need to do is to actually use the custom work that you created. Referring to the methods and functions in Listings 3.17 and 3.18, you simply need to call the specific custom method(s) that you need.

Figures 3.24 and 3.25 show scripts that make calls to the custom methods contained in the Helper Superclass. This should give you an idea of how your custom work can save time for the other members on your team. They do not have to reinvent the wheel you already created. They can simply reuse the code that you built and use the method(s) that you placed in a Helper Superclass.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020