License configuration

You must first apply a license to start using HCL DevOps Test UI (Test UI).

When you start Test UI for the first time, a licensing dialog is displayed. Specify the server ID or the deployment ID that was provided to you or copy the ID from My HCLSoftware (MHS). When you submit the server ID or deployment ID, the product connects with MHS to verify it and if there is a license available, it is checked out so that you can use the product. If the license is not available, a message is displayed about it.
Notes:
  • If the license is not used for 15 minutes, the license is returned to the server for others to consume it. If the product looses connectivity to MHS, you can use the product for two hours only if the server ID that you entered last time is correct.

  • After the product installation, when you apply the license to the product, the license information is cached in a system directory. If there are any permission issues accessing the directory or the directory is deleted, there can be licensing error when starting the product. The workaround is to create an environment variable HCL_DT_LICENSING_DIR and specify a directory path. The licensing information is now stored in the new directory. For example, Environment variable
You can also apply the license after you open the product by using any of the following methods based on your requirement:
Note: When you upgrade the macOS from an older version or install the latest version of Test UI after uninstalling an older version, you must remove any previously configured licensing information of Test UI by performing the following actions:
  • Unset the three environment variables such as HCL_ONETEST_LICENSING_STORAGE, HCL_ONETEST_LICENSING_URL, and HCL_ONETEST_LICENSING_ID.
  • Comment out the environment variable settings in the .zshrc file.
To apply the license without opening the product, add the licensing parameters as environment variables:
Variables Description
HCL_DT_LICENSING_URL URL of the licensing server. You get this URL when you activate your deployment in My HCLSoftware. For example, https://my.hcllicenserver.com.
HCL_DT_LICENSING_ID Your server ID or deployment ID.
You can add HCL_DT_LICENSING_PRIORITIZE_STUDIO as an environment variable and set the value to "true", if you want to prioritize the checkout of Workbench licenses over Performance seat licenses.
When running the tests from command line, you do not have to specify any licensing argument. However, when running a schedule for HCL DevOps Test Performance or accelerated/distributed tests for HCL DevOps Test UI in an uninterrupted mode, you must specify vmargs -Dhptcostconfirm argument in the command. The uninterrupted mode refers to any of the non-GUI based test execution scenarios such as the following use cases:
  • Running a test from the command line
  • Running a test with Jenkins
  • Running a test with Ant
  • Running a test with HCL DevOps Deploy
  • Running a test with IBM® Engineering Test Management