Configuring and running the adapter using the command-line interface

Integration with IBM® DevOps Test UI (Test UI) is implemented through the use of an adapter. The functional test adapter is installed by default when you install Test UI. You can configure and start the adapter using the command-line interface.

If you are a Engineering Test Management user, ensure that you have the appropriate permissions, including execute permissions, to access the Test UI adapter for Engineering Test Management. If you do not have administrator rights then use the Connector Client Access license. You can obtain this license from the Engineering Test Management administrator.

If the host name of the Engineering Test Management server is not registered with the DNS server, modify the hosts file and map the host name of the Engineering Test Management server to its IP address.

Note: If the adapter connects to the Engineering Test Management server through a proxy server, configure and start the adapter through the command-line interface using the instructions in Configuring and running the adapter through a proxy server.
  1. Configure the adapter to generate logs:
    1. Download the log4j2.xml file.

      The downloaded file may have the name as log4j2_N.xml, where N is some integer.

    2. Rename the file to log4j2.xml, and then place the file in the DevOpsTest\FunctionalTester\RQMAdapter directory.
    3. Copy the following jar files from <Install_Directory>\IBMIMShared\plugins\com.ibm.rqm.integration.client_<version>\lib to the DevOpsTest\FunctionalTester\RQMAdapter directory:
      • commons-logging-1.2.jar
      • log4j-api-2.17.1.jar
      • log4j-core-2.17.1.jar
      • log4j-jcl-2.17.1.jar
    4. Replace start "" %RFT_ARG_JRE% -classpath %RFT_INSTALL_DIR%\rational_ft.jar com.rational.test.ft.RQMAdapterConfigure %* in the configureadapter.bat file with the following command:

      start "" %RFT_ARG_JRE% -Dlog4j2.configurationFile=.\log4j2.xml -classpath .\log4j-api-2.17.1.jar;.\log4j-core-2.17.1.jar;.\log4j-jcl-2.17.1.jar;.\commons-logging-1.2.jar;%RFT_INSTALL_DIR%\rational_ft.jar com.rational.test.ft.RQMAdapterConfigure %*

  2. At the prompt, type the following command-line arguments to run the configureadapter.bat configuration batch file:configureadapter.bat -repository https://<rqmserver>:<port>/qm -user <userid> -password <password> -adapter <adapter name> [-projectArea <projectArea>] [-configfile <configuration file>] [-interactive <true/false>]
    where:
    • <rqmserver> is the host name of the Engineering Test Management server.
    • <port> is the port where the Engineering Test Management server is running.
    • <userid> is a registered user ID in Engineering Test Management that has the license to run the adapter.
    • <password> is the password for the user ID that was used.
    • <adapter name> is the name you give your adapter and by which the Engineering Test Management web UI will identify this instance of the adapter.
    • <projectArea> is the name or alias of the project to which you are logging on. If the name contains spaces, enclose the name in double quotation marks.
    • <configuration file> is the file from which the settings for this adapter must be read. The adapter name is mandatory when you use this option.
    • [-interactive <true/false>]: If you set this value to true, the Test UI Adapter dialog opens if you have not specified values for any of the command-line arguments. You can then specify the missing value in the Test UI Adapter dialog.
    Note: If the Engineering Test Management server is renamed, complete these steps:
    1. If you have an entry for the Engineering Test Management server in the hosts file, update it with the new server name.
    2. Update the <rqmserver> argument with the new server name.
    3. Configure the adapter again to point to the new URL
  3. Start the adapter by running the startadapter.bat batch file, which is in the same location as the configureadapter.bat file. Type the following command-line arguments at the prompt: startadapter.bat -repository https://<rqmserver>:<port>/qm -user <userid> -password <password> -adapter <adapter name> -projectArea <project area> [-configfile <configuration file>]
    where:
    • <rqmserver> is the host name of the Engineering Test Management server.
    • <port> is the port where the Engineering Test Management server is running.
    • <userid> is a registered user ID in Engineering Test Management that has the license to run the adapter.
    • <password> is the password of the user ID used
    • <adapter name> is the name you give your adapter and by which the Engineering Test Management web UI will identify this instance of the adapter.
    • <projectArea> is the name or alias of the project to which you are logging on. If the name contains spaces, enclose the name in double quotation marks.
    • <configuration file> is the file from which the settings for this adapter must be read. The adapter name is mandatory when you use this option.