Setting up licensing

Before you begin

For a cloud license server

Ensure you must have completed the following tasks, if you want to set up a cloud license server:

Purchased the licenses.
Configured the URL of the licensing server with the appropriate entitlements. The URL of the HCL Cloud License Server is in this form: https://my.hcl-software.com
Obtained the Pool ID of the HCL Cloud License Server.

For a local license server

Ensure you must have completed the following tasks, if you want to set up a local license server:

Purchased the licenses.
Installed and configured the Local License Server with the appropriate entitlements. See Managing HCL Local License Server.

About this task

You must set up either a cloud license server or a local license server by configuring environment variables based on the operating system.

Setting up a Cloud License Server

Before you start using the product, you must configure the following environment variable on the computer on which you have installed Test Embedded

You can add the licensing parameters as environment variables described in the following table:


Environment variable	Description
HCL_DTE_ LICENSING_URL	URL of the licensing server. You get this URL when you activate your deployment in the My HCLSoftware (MHS) portal. For example, `https://my.hcl-software.com`.
HCL_DTE_LICENSING_ID	Your Pool ID or deployment ID.

When you launch the product, it connects to the My HCLSoftware (MHS) portal to verify this server ID 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, in the console.

Note: If the license is not used for 10 minutes, the license is returned to the License server for others to consume it.

Setting up a Local License Server

When you install the product on computers which cannot access the internet and are behind a firewall, you must set up a Local License Server. You must install the Local License Server on a physical computer and not on a virtual machine. For more information about installing and configuring the Local License Server, see the documentation of the local license server from where you downloaded the product bits. As part of configuration, the local license server is already mapped your entitlements of software with the Local License Server to serve your requests.

Note: If the license is not used for 10 minutes, the license is returned to the License server for others to consume it.

Before you start using the product, you must set the following environment variable as described in the following table:


Environment variable	Description
HCL_DTE_LICENSING_URL	The value specifies the URL of the local license server. The URL must be set up to point to your local server.
HCL_DTE_LICENSING_ID	You can get the Pool ID or deployment ID while setting up the local server.

Note: Ensure the HCL_DTE_LICENSING_URL matches the hostname of your computer where the local server is installed. You must be attentive to the case sensitivity of the licensing server URL. You can obtain the accurate and case-sensitive information from the system administrators responsible for installing the local server. This information is important for you to properly configure and establish connectivity on the local server for licensing services.

Optional configurations

License lease configuration

The following optional environment variables can be used to configure license lease behavior, including how often licenses are renewed, how many times operations are retried, and the delay between retry attempts.


Environment variable	Description
HCL_DTE_LICENSING_BORROW_INTERVAL	This environment variable defines the interval, in seconds, at which the client borrows and renews licenses from the server, with an integer type, a default value of 600 seconds (10 minutes). The value below 180 seconds (3 minutes) minimum is clamped to default borrow interval.
HCL_DTE_LICENSING_MAX_RETRY	This environment variable defines the maximum number of retry attempts for license operations, with an integer type, a default and minimum value of 5, and any value below this being clamped to the minimum.
HCL_DTE_LICENSING_RETRY_DELAY	This environment variable defines the delay, in milliseconds, between retry attempts, with an integer type, a default and minimum value of 1000 ms (1 second), and any value below this being clamped to the minimum.