InsightObject description properties

Object description properties can be used in the object repository description, in some programmatic descriptions, in checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

The InsightObject test object supports the description properties listed in the table below.

Property Name



The ordinal identifier that UFT One assigns to the object to indicate the order in which the object appears in the code relative to other objects with an otherwise identical description. This property cannot be used with GetROProperty.

Values begin with 0.


The path to an image file. When specified in a programmatic description, UFT One searches within the parent object for a visual match to the image file.

Supported file types include JPEG, BMP, and PNG.

To specify an ALM path to a file located in the ALM Test Resources module, type: [QualityCenter\Resources] Subject\<folder and file name>.

Note: This property is intended only for use in programmatic descriptions and does not support the use of regular expressions.


The ordinal identifier that UFT One assigns to the object to indicate where the object appears within the window, frame, or dialog box. Values are assigned from top to bottom, and left to right. This property cannot be used with GetROProperty.

Values begin with 0.


(Percentage). Specifies how similar a control in the application has to be to the test object image for it to be considered a match.

Possible values are 1-100. If a value is entered that is not in range, the default value (80%) is used.

Note: You can manually set similarity values for the test object, and then view and retrieve those test object values. You cannot view, retrieve, or set values for the application object.


Specifies whether to skip the step that makes sure the object is visible before trying to identify it.

For example, if you see that UFT One's attempt to make the object visible causes the application window to close before the object can be identified.

This property is usually used to troubleshoot identification errors.

Possible values:

  • True: Skip the step that makes sure the object is visible before trying to identify it.

  • False: (Default) Make the object visible to UFT One before trying to identify it.


Specifies the order in which the image matching algorithms are used by UFT One for object identification.

UFT One uses the following three algorithms:

  • pixel: Matching an Insight object in the application according to the pixel of the object.

  • edge: Identifying an Insight object in the application by comparing its boundaries with the boundaries of the application page or screen.

  • feature: Considering features of an Insight object and identifies the correct match in the application based on these features.

Set this property to only one algorithm or multiple algorithms and use commas (,) to separate algorithms.

Default value: pixel,edge


The threshold of the ratio of a feature's distance from its closest match to the distance of its second closest match.

This is a control parameter of the feature algorithm. It is used by UFT One to identify the correct Insight object. The default value is 0.8.

The following example shows how UFT One uses this parameter to determine whether an object it finds on the application is the correct Insight object.

Example: For a feature F extracted from an Insight object, assume that UFT One finds two matches M1 (closest match) and M2 (second closest match) on the application. The distance of F from M1 is less than that from M2. UFT One then calculates the ratio (distance of F from M1/distance of F from M2) and compares it with the defined threshold.

  • If the ratio is greater than the threshold, UFT One identifies M1 as the Insight object.

  • If the ratio is smaller than the threshold, UFT One discards M1.


  • If UFT One incorrectly identified an object as the Insight object when no application object should have matched, try a lower threshold.

  • If UFT One didn't find the Insight object when there was a matching object in the application, try a higher threshold.

visual relations

Represents the test object's visual relations identifier.

Use this property in GetTOProperty and SetTOProperty steps to return or apply a VisualRelationsCollection object for a test object. The VisualRelationsCollection object enables you to retrieve or replace the visual relation identifier settings of a test object during a run session.


SetVRIColl = TestObject.GetTOProperty("visual relations")

TestObject.SetTOProperty "visual relations", VRIColl

For details, see VisualRelationsCollection Object in the Utility section of the UFT One Object Model Reference for GUI Testing.

This property is not listed in the Object Spy. It is not retrieved when you use the GetTOProperties method. It cannot be used in the Object Identification dialog box, the description area of the object repository, checkpoint or output value steps, and so on.

See also: