Editing a HCL OneTest API configuration file

After you generate an XML configuration file, you might need to change it if the target computer is different from the generated configuration. For example, the libraries and their locations in the configuration file do not match the libraries and their locations on the target computer.

About this task

To edit a configuration file, follow these steps:


  1. After you generate a HCL OneTest™ API configuration file (as described in Generating a HCL OneTest API configuration file), you can apply it to another computer. If the configuration for the target computer must be modified, you must edit the configuration file manually.
  2. Open the configuration file in a text editor and modify its contents as required.

    The provider-type is defined in the provider element. Specific providers (displayName) and their default library locations (base) are defined in the pathSet element. Specific libraries for each provider are defined in the pathElement element by using the location (for the path) and name (for the specific file) attributes.

    The environment that is described by the configuration file (that is, the libraries and their locations) must be valid on the target computer. In other words, ensure that the files in the configuration exist in the proper locations on the target computer.

    Note: If the library file location is on a mapped network drive, you might get errors while running tests in a project. To prevent this, ensure that the files are available on a local drive that can be accessed by HCL OneTest API and its Agent.

Example: Adding a provider

It is not possible to modify file paths or file names for the pre-defined entries. In the GUI version of the tool, you add your configuration by copying an existing entry and editing the new one. This example shows you how to do this with a text editor and adds a new JDBC provider for DB2® on z/OS.

The file to use is /opt/IBM/RTVS_JARs/db2jcc_license_cisuz.jar

Locate the provider section of librarysettings.xml for the technology, JDBC in this case. Each section consists of the provider element and a number of pathSets for each provider. Each pathSet has a display name for use in the GUI, and a unique id such as "db2". It contains pathElements for each file. The provider element has the selectedPathSets attribute to define which of the providers are enabled.

Here is a partial listing of the default JDBC section:

<provider id="com.ghc.jdbc" selectedPathSets="org.apache.derby,com.ibm.db2.jdbc,com.oracle.jdbc">
  <pathSet displayName="Apache Derby (pre-installed)" id="org.apache.derby" userDefined="false"/>
  <pathSet displayName="IBM DB2 (pre-installed)" id="com.ibm.db2.jdbc" userDefined="false"/>
  <pathSet base="/opt/SQLLIB/" displayName="IBM DB2 App driver" id="db2" userDefined="false">
     <pathElement location="/opt/SQLLIB/" name="db2java.zip"/>
  <pathSet base="/opt/IBM/db2/V9.7/sqllib/" displayName="IBM DB2 Connect (for connecting to DB2 on z/OS)" id="db2-zos" userDefined="false">
     <pathElement location="/opt/IBM/db2/V9.7/sqllib/java" name="db2jcc_license_cisuz.jar"/>
  <pathSet base="/opt/Sybase/jConnect-6_0/" displayName="Sybase (jConnect 6.05)" id="syb-jcon-605" userDefined="false">
     <pathElement location="/opt/Sybase/jConnect-6_0/classes" name="jconn3.jar"/>
There are three providers that are enabled by default: Derby, Db2, and Oracle, all identified by their ids:
Duplicate the pathSet section and edit:
  • base location – use /
  • id – make this unique
  • userDefined
  • location
  • name

Add a pathElement for each additional file as required, in this case it is a single file.

<pathSet base="/” displayName="IBM DB2 Connect (for connecting to DB2 on z/OS)" id="db2-zos-custom" userDefined="true">
     <pathElement location="/opt/IBM/RTVS_JARs" name="db2jcc_license_cisuz.jar"/>

Add the new id to selectedPaths to enable this provider:


Save the file.