Deploying the Custom Toolkit Support

To deploy the toolkit support set that you create, you must place the files in specific locations within the UFT One installation folder.

Note: Before you begin, create a folder with the name of your custom toolkit in the <UFT One Installation folder>\dat\Extensibility\Web folder, if one does not already exist.

The following table describes the appropriate location for each of the toolkit support files:

File Name

Location

<Custom Toolkit Name>TestObjects.xml

Note: This is the recommended file name convention. You can have more than one test object configuration XML file, and name them as you wish.

  • <UFT One Installation folder>\dat\Extensibility\ Web

  • <UFT One Add-in for ALM Installation folder>\dat\Extensibility\ Web

    (Optional. Required only if the folder exists, which means the UFT One Add-in for ALM was installed independently from the ALM Add-ins page and not as part of the UFT One installation.)

<Custom Toolkit Name>.xml

<UFT One Installation folder>\dat\Extensibility\Web\Toolkits\<custom toolkit name>

JavaScript files

Specify the location in the in <Custom Toolkit Name>.xml

Icon files for new test object classes (optional)

The file can be a .dll, .exe, or .ico file, located on the computer on which UFT One is installed, or in an accessible network location.

Specify the location in <Custom Toolkit Name>TestObjects.xml

Help files for the test object classes (optional)

Must be a .chm file, located on the computer on which UFT One is installed.

Specify the location in <Custom Toolkit Name>TestObjects.xml

External JavaScript libraries

These are not part of the toolkit support set, but when you deploy the support set you must make sure that the library files are located in the location specified in the toolkit configuration file.

A .js file, located on the computer on which UFT One is installed, or in an accessible network location.

Specify the location in <Custom Toolkit Name>.xml

Recommended File Locations

You specify the locations of the JavaScript, Help, and icon files in the toolkit support set's configuration files. You can specify these locations using relative paths. For more information, see the Test Object Schema Help and the Toolkit Configuration Schema Help.

The recommended locations for these files are described in the following table:

File Name

Location

JavaScript files

<UFT One Installation folder>\dat\Extensibility\Web\Toolkits\<custom toolkit name>\JavaScript

Icon files

<UFT One Installation folder>\dat\Extensibility\Web\Toolkits\<custom toolkit name>\Res

Help files

<UFT One Installation folder>\dat\Extensibility\Web\Toolkits\<custom toolkit name>\Help

Settings to Use During Design Stages

  • If you modify attributes of Identification Property elements in the test object configuration file, keep the DevelopmentMode attribute of the TypeInformation element set to true during the design stages of the custom toolkit support. Before you deploy the custom toolkit support set for regular use, be sure to remove this attribute (or set it to false). For more information, see Modifying Identification Property Attributes in a Test Object Configuration File.

  • To instruct UFT One to re-inject the JavaScript file into the Web page every time it is refreshed, define a Controls\Settings\Variable element in the toolkit configuration file, set its name attribute to cache scripts and its value attribute to false. If you do this, then after you modify your JavaScript functions and deploy them, if you have not changed anything in the XML files or reopened UFT One, you only need to refresh the Web page containing your custom controls to test your changes. You do not have to close and reopen the Web page.

    Before you deploy the custom toolkit support set for regular use, be sure to remove this element or set its value attribute to true to avoid performance degradation.