The Test Object Configuration XML File

This topic describes the test object configuration file and information that you can include in a test object class definition.

In this topic:

Overview

In a test object configuration XML, you define the test object classes (for example, the test object methods they support and their identification properties).

You can also create a definition for an existing test object class in the test object configuration XML. This definition is added to the existing definition of this test object class, affecting all test objects of this class. It is therefore not recommended to modify existing test object classes in this way. For example:

• If you add a test object method, it appears in the list of test object methods in OpenText Functional Testing, but if you use the test object method in a test, and it is not implemented for the specific object, a run-time error occurs.

  If you add test object methods to existing test object classes, you might add a prefix to the method name that indicates the toolkit support for which you added the method (for example, CustomButtonClick, CustomEditSet). This enables test designers to easily identify the custom methods and use them in test steps only if they know that the custom method is supported for the specific object.

• If you add an identification property, it appears in OpenText Functional Testing in the list of properties for all test objects of this class, but has no value unless it is implemented for the specific supported object.

In the test object configuration XML file, you create a ClassInfo element for each test object class that you want to define. In addition, you define the name of the environment or custom toolkit for which the test object classes are intended (in the PackageName attribute of the TypeInformation element), and the OpenText Functional Testing add-in which these test object classes extend (in the AddinName attribute of the TypeInformation element).

If the relevant add-in is not loaded when OpenText Functional Testing opens, the information in this XML is not loaded. Similarly, if the name of the environment or custom toolkit is displayed in the Add-in Manager dialog box and its check box is not selected, the information in this XML is not loaded.

For more information, see How the Test Object Configuration XML is Loaded.

Back to top

A Test Object Class Definition

The sections below describe the information that you can include in a test object class definition. Class name and type, methods and properties, an icon file, and a Help file.

Class Name and Base Class

The name of the test object class and its attributes, including the base class—the test object class that the new test object class extends (relevant only when defining new test object classes). A new test object class extends an existing JavaOpenText Functional Testing test object class, directly or indirectly. The base class may be a class delivered with OpenText Functional Testing or a class defined using Java Add-in Extensibility.

By default, the base class is JavaObject.

The test object class name must be unique among all of the environments whose support might be loaded simultaneously. For example, when defining a new test object class, do not use names of test object classes from existing OpenText Functional Testing add-ins, such as JavaButton or JavaEdit.

Generic Type

The generic type for the test object class, if you are defining a new test object class and you want the new test object class to belong to a different generic type than the one to which its base class belongs. (For example, if your new test object class extends JavaObject (whose generic type is object), but you would like to group this test object class with the edit test object classes.)

Generic types are used when filtering objects (for example, in the Step Generator's Select Object for Step dialog box and when adding multiple test objects to the object repository). Generic types are also used when creating documentation strings for the Documentation column of the Keyword View (if they are not specifically defined in the test object configuration file).

Test Object Operations

A list of operations for the test object class, including the following information for each operation:

Default Operation

The test object operation that is selected by default in the Keyword View and Step Generator when a step is generated for an object of this class.

Identification Properties

A list of identification properties for the test object class. You can also define:

Icon File

The path of the icon file to use for this test object class. (Optional. If not defined, the base class' icon is used.) The file can be a .dll, .exe, or .ico file.

Help File

A context-sensitive Help topic to open when F1 is pressed for the test object in the Keyword View or Editor. The definition includes the .chm Help file path and the relevant Help ID within the file.

You can practice creating support for a custom control that is mapped to a new test object class in the tutorial lesson Learning to Support a Complex Control.

You can validate your test object configuration file against: <OpenText Functional Testing installdir>\bin\java\sdk\eclipse\plugins\com.mercury.qtjext.plugin.QTJavaExt_1.0.0\ClassesDefintions.xsd

For information on the structure and syntax of a test object configuration file, see the Test Object Schema Help.

For information on the location in which to store the test object configuration file, see Deploying and Running the Custom Toolkit Support.

Back to top

Test Object Configuration File Example

The following example shows parts of the test object configuration file that defines the Calculator test object class definition for the javaboutique custom toolkit:

<TypeInformation Load="true" PackageName="javaboutique" AddinName="Java">
    <ClassInfo BaseClassInfoName="JavaApplet"DefaultOperationName="Calculate" Name="Calculator">
        <IconInfo IconFile="C:\Program Files\OpenText\Unified Functional Testing\samples\Javaboutique\Calculator_3D.ico"/>
        <TypeInfo>
            <Operation ExposureLevel="CommonUsed" Name="Calculate"PropertyType="Method">
                <Description>Builds the whole calculation process</Description> 
                <Documentation><![CDATA[Perform %a1 operation with %a2 and %a3 numbers]]></Documentation> 
                <Argument Direction="In" IsMandatory="true" Name="operator">
                    <Type VariantType="Variant"/>
                </Argument>
                <Argument Direction="In" IsMandatory="true" Name="num1">
                    <Type VariantType="Variant"/>
                </Argument>
                <Argument Direction="In" IsMandatory="true" Name="num2">
                    <Type VariantType="Variant"/>
                </Argument>
            </Operation>
            ...
        </TypeInfo>
        <IdentificationProperties>
            <IdentificationProperty ForVerification="true" ForDefaultVerification="true "Name="value"/>
            <IdentificationProperty ForVerification="true" Name="objects count"/> 
            <IdentificationProperty Name="width"/>
            <IdentificationProperty ForDescription="true" Name="toolkit class"/>
            ...
        </IdentificationProperties>
    </ClassInfo>
</TypeInformation>

This example shows that the Calculator test object class extends the JavaApplet test object class. It uses the Calculator_3D.ico icon file, and its default test object method is Calculate (which has three mandatory input parameter of type Variant:operator, num1 and num2).

The PackageName attribute in the TypeInformation element indicates that the Calculator test object class is created for the javaboutique toolkit support.

The following identification properties are defined for the Calculator test object class:

• value. Available for checkpoints and selected by default in the Checkpoint Properties dialog box in OpenText Functional Testing.

• objects count. Available for checkpoints but not selected by default.

• toolkit class. Used for the test object description but not available for checkpoints.

Back to top

See also:

• The Custom Toolkit Support Set