Test Object Configuration XML Overview

This Help file describes the elements and attributes available for creating test object configuration XML content to be used with your UFT One extensibility project.

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

In some environments, 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 UFT One, 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.

    Note: In .NET, test object methods that you add to existing test object classes are available in UFT One only for the custom control specified in the ClassInfo element's Name attribute.

  • If you add an identification property, it appears in UFT One 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.

    Note: You cannot define identification properties for .NET test objects.

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 UFT One 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 UFT One opens, UFT One does not load the information in this XML. 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.

To ensure the structural correctness of your test object configuration file, you can validate it against the ClassesDefintions.xsd file. This file is installed with UFT One, in the <UFT_One_installdir>\dat folder, and may be installed in additional locations when you install certain UFT One add-in extensibility SDKs. (For backward compatibility reasons, UFT One still supports certain XML structures that do not pass validation against this XSD.)

For more information, see How UFT Loads the Test Object Configuration XML.

The sections below describe the information that you can include in a test object class definition.

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).

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

Note:  

  • A test object class inherits the base class' test object operations (methods and properties), generic type, default operation, and icon. Identification properties are inherited only by .NET test object classes.

  • If you create test object classes that extend test object classes defined in another toolkit support set, you create a dependency between the two toolkit support sets. Whenever you select to load the extending toolkit support set in the UFT One Add-in Manager, you must also select to load the toolkit support set that it extends.

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 UFT One 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:

  • The arguments, including the argument type (for example, String or Integer), direction (In or Out), whether the argument is mandatory, and, if not, its default value.
  • Whether a dynamic list of possible values for this argument can be retrieved from the supported control and displayed in the Keyword View, Editor, and Step Generator.
  • The operation description (shown in the Object Spy and as a tooltip in the Keyword View and Step Generator).
  • The Documentation string (shown in the Documentation column of the Keyword View and in the Step Generator).
  • The return value type.
  • A context-sensitive Help topic to open when F1 is pressed for the test object operation in the Keyword View or Editor, or when the Operation Help button is clicked for the operation in the Step Generator. The definition includes the Help file path and the relevant Help ID within the file.

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:

  • The identification properties that are used for the object description.
  • The identification properties that are used for smart identification. (This information is relevant only if smart identification is enabled for the test object class. To enable smart identification, use the Object Identification dialog box in UFT One.)
  • The identification properties that are available for use in checkpoints and output values.
  • The identification properties that are selected by default for checkpoints (in the Checkpoint Properties dialog box).

Note: You cannot define identification properties for .NET test objects.

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.