Configuring HCL Z and I Emulator for Windows with HCL License Server

Table of Contents

  1. I. Introduction
  2. II. Pre-requisites
  3. III. Configuration Steps
    1. Direct HCL Licensing
    2. HCL Licensing via License Manager

I. Introduction:

We can use the "HCL Licensing” or “License Manager” to acquire the license and connect to the host.

This document describes the procedure to configure licensing with HCL License Server (HCL Software License & Download Portal).

There are two ways to configure the ZIEWin client to HCL Licensing.
  1. Direct HCL Licensing

    The ZIEWin client directly communicates with the "HCL License Server" for licensing using this method.

  2. HCL Licensing via “License Manager”

    The HCL License Manager (LM) manages the licensing mechanism in this method.

Note: The user can also use the product without licensing (Disable Licensing).

II. Pre-requisites:

Direct HCL Licensing:

The ZIEWin communicates with the "HCL License Server" or "HCL Common Local License Server" (CLLS) for Licensing.

  • Registration to HCL Software License & Download Portal ( Click here )
  • User ID, HCL License Server device, Licensing Entitlements in HCL Software License & Download Portal ( Click here )
  • ZIEWin package
  • The “HCL Common Local License Server” (CLLS) package, only in case of ZIEWin configuration with the “HCL Common Local License Server” (CLLS) - ZIEWin supports the “HCL Common Local License Server” (CLLS) 2.0 onwards.

HCL Licensing via “License Manager":

The License Manager administers license acquisition and release for all its clients. ZIEWin, as a client, sends the license acquisition and release requests to the License Manager server, which forwards them to the "HCL License Server. The HCL License Server can be "HCL License Server" or "HCL Common Local License Server" (CLLS).

  • Registration to HCL Software License & Download Portal ( Click here )
  • User ID, HCL License Server device, Licensing Entitlements in HCL Software License & Download Portal ( Click here)
  • ZIEWin package
  • CLLS package, only in case of “License Manager” configuration with “HCL Common Local License Server” (CLLS)
  • Public and Private SSH Key Pair
Note: The user can use Cloud deployed HCL License Server from the HCL Software License & Download Portal ( Click here ) or the CLLS installed in Windows or Linux Server.

Download and install instructions for “HCL Common Local License Server” (CLLS),

Refer the following articles for more information:

III. Configuration Steps:

  1. A. Direct HCL Licensing
  2. B. HCL Licensing via License Manager

A. Configuration Steps for “Direct HCL Licensing"

Step-1 : Download the Product from HCL Software License & Download Portal

  1. Copy and paste the following link in a browser address bar to access the HCL Software License & Download Portal login page.

    https://hclsoftware.flexnetoperations.com/flexnet/operationsportal/logon.do

  2. Enter the authorized login credentials and click Login, it redirects to Home Page.

  3. From the Downloads, click List Downloads. It redirects to Downloads page.

  4. Select the HCL Z & I Emulator (ZIE) from the list of products. It redirects to the Download Packages page. The below image displays a keyword entered in the search field, to find the “HCL ZIE Family products”.

  5. Select the required product package from the list (HCL Z and I Emulator for Windows x.x).

  6. Click on File Name (hyperlink) to download the product files to a user defined location.

    Example: HCL ZIE For Windows v2.0

    Note:
    • The ZIEWIN supports “HCL Common Local License Server” (CLLS) 2.0 onwards.
    • Perform the below Step-2 and Step-3 if it is required to configure ZIEWin with the HCL CLLS.
Step-2 : Download License Server from the HCL Software License & Download Portal
  1. Repeat the steps from step 1 to step 3 given in Download the Product from the HCL Software License & Download Portal Operations section.
  2. Select Uncategorized Products from the list of products. It redirects to the Download Packages Page.

  3. Select the HCL Common Local License Server (CLLS) 2.0 from the list.

  4. Select the appropriate and required file from the list and click on File Name (hyperlink) to download the files to a user-defined location.

Step-3: Configure the ZIEWin with the “HCL License" URL

The "HCL License Server" Cloud-based (HCL Software License & Download Portal) or "HCL Common Local License Server" (CLLS) settings either be configured by providing the required server details in the 'InstallShield Wizard' at the time of the ZIEWin installation itself or it can be added/updated in the 'Licensing Settings' section under Advanced tab within the Preferences. Licensing Settings

Mode:

The License Mode field is populated with the “HCL Licensing”,” License Manager,” and “Disable Licensing ” options. By default, select the“HCL Licensing” mode.

  • Select the “HCL Licensing”, the license is acquired by connecting to the “HCL License server,” and the user must configure the “HCL License server” URL in the “License URL” section.
  • Select the “License Manager”, the license is acquired by connecting to the “License Manager,” and the user must configure the “License Manager” URL in the “License URL “section.
  • Select the “Disable License”, the user can connect to the host without acquiring the license, and the status bar update with the below message. Also, the “License URL” and “Renewal Interval” fields are disabled.
Connecting without acquiring the License, as licensing is disabled. The value of “Disablelicensing” is set to yes in the pcswin.ini file.”
To use the “License Manager” setup, the user can configure the “pcswin.ini” file as below.
[License]
UseLicenseManager = Y
DisableLicensing = N
Similarly, to use the “HCL Licensing” setup, the user can configure the “pcsws.ini” file as below.
[License]
UseLicenseManager = N
DisableLicensing = N
And, to “Disable Licensing”, the user can configure the “pcsws.ini” file as below.
[License]
DisableLicensing = Y

License URL:

Once the installers are available, follow the below given steps and the article link to obtain the Licensing URL and configure the HCL Licensing.

https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0073344&sys_kb_id=c75b269c1b79dc54f37655352a4bcb47
Note: The user choose the Server deployment mode as Local or Cloud while setting up the license server.

  • After completing the License server deployment, the user gets a custom HCL License Server ID. Replace the ip/hostname of license server host and the license server ID in the following licensing URL.

    <https://[license server host]/api/1.0/instances/[license server ID]>

  • Use custom URL to replace the following link given in the upcoming procedures.

    <https://[license server host]/api/1.0/instances/[license server ID]>

  • "Set Password”, click “Action” for the newly created device, select “Set Password” option from the drop down and setup a password. This password is used to upload the “public” key for License Manager auto SSH login.
  • Throughout this document, the elements enclosed in the square brackets ( [ ] ) indicate the parameter name/example and it replaced with the actual value in the command according to the context.

    For Example:

    [license server host] is to be replaced with License Server http address and [license server ID] is replaced with License Server’s ID.

    For further queries related to HCL License Server setup, contact the HCL Customer support team using the following link : https://support.hcltechsw.com/csm

Renewal Interval:

Specifies the time in minutes when HCL Z and I Emulator for Windows session sends license parameters. The minimum value is 288 minutes (1/5th of a day), and the maximum value is 1440 minutes (1 day) while using "Direct HCL Licensing." When no value is configured, the default value of 864 minutes (3/5th of the day) is considered. The minimum value is 5 minutes, and the maximum value is 30 minutes in the case of using "License Manager", the default value is 5mins.

The "borrow interval" of the license request is five times of "renewal interval" in the case of "Direct HCL Licensing" without using "License Manager". In the case of "License Manager," the "borrow interval" is equal to the "renewal interval". The "borrow interval" specifies the time the client reserves the license.

In the case of "Direct HCL Licensing," during a communication failure after acquiring the license, the subsequent connection attempts are allowed till the borrow interval elapses. Hence, having a large "borrow interval" is recommended. The maximum borrow interval set to "5 x 1440 mins," which is equivalent to 5 days.
Note: The Licensing Settings set by the "Preferences" utility take precedence over the settings set through installation. If the installation is "user installation" where the application data location is %appdata% in the user directory, the setting that is set in the "Preferences" utility is applicable only for the current user.
  1. Configure the Licensing Settings during the GUI installation of ZIEWin

    During the installation in the “License Server Details” install panel, the users can configure the “Mode”, “License URL,” and “Renewal Interval” fields. Users may skip configuration during the installation and can configure using the “Preferences” utility after installation.

    Figure 9 : Use License Manager

  2. Configure the Licensing Settings during the Silent installation of ZIEWin

    The “License Server Details” is configured during the silent installation by setting the Properties in the “custom.ini” file used for the silent installation. Here are the Property names for the respective settings.

    By default, the “Disable Licensing” is disabled, and the “LICENSEMODE” property is set to “1” in the custom.ini file.
    LICENSEMODE property supported values are,
Set LICENSEMODE  =1 for the “HCL Licensing”
Set LICENSEMODE  =2 -> for the  “License Manager”
Set LICENSEMODE  =3 -> for the “Disable Licensing”

Use License Manager – USELICENSEMANAGER
License URL – LMSERVERURL
Renewal Interval– LMSERVERINTERVAL
  3. Configure the Licensing Settings using “Preferences” utility

    The “Preferences” utility can run from the “Windows Start Menu” under the product “HCL ZIE for Windows,” as shown below.

    Figure 10: Preferences utility from the Windows Start Menu

    In the “Preferences” utility, go to the “Advanced” tab to find the section “Licensing Settings”, the user configures the fields “License URL” and “Interval” here.

    Figure 11: Licensing Settings and ZIE Server Details section within the Advanced tab of Preferences utility in ZIEWin.

B. Configuration Steps for "HCL Licensing" via “License Manager”

Step-1 : Download the Product from the HCL Software License & Download Portal

  1. Copy and paste the following link in a browser address bar to access the HCL Software License & Download Portal login page. https://hclsoftware.flexnetoperations.com/flexnet/operationsportal/logon.do

  2. Enter the authorized login credentials and click Login, it redirects to Home Page .

    Figure 12: Home Page

  3. From the Downloads, click List Downloads. It redirects to Downloads page.

    Figure 13: Products List

  4. Select HCL Z & I Emulator (ZIE) from the list of products. It redirects to the Download Packages page.

    The below image displays a keyword entered in the search field, to find the “HCL ZIE Family products”.

    Figure 14 : Products List

  5. Select the required Product package from the list (HCL Z and I Emulator for Windows x.x).

    Figure 15 : Download Packages

  6. Click on File Name (hyperlink) to download the product files to a user defined location.

    Example: HCL ZIE For Windows v1.1.1

    Figure 16 : HCL ZIE For Windows

    Note:
    • The ZIEWin supports “HCL Common Local License Server”(CLLS) 2.0 onwards.
    • Perform the below Step-2 only if it is required to configure ZIEWin with the HCL CLLS or to upload the product key.

Step-2 : Download the License Server from the HCL Software License & Download Portal

  1. Repeat the steps from step 1 to step 3 given in Download the Product from the HCL Software License & Download Portal Operations section.

  2. Select Uncategorized Products from the list of products. It redirects to the Download Packages Page.

    Figure 17 : Products List

  3. Select the HCL Common Local License Server 2.0 from the list.

    Figure 18 : Download Packages

  4. Select the appropriate and required file from the list and click on File Name (hyperlink) to download the files to a user defined location .

    Figure 19 : Downloads

Step-3 : Extract the Installers (for the Product and License Manager)

  1. Open the downloaded package. For the product HCL Z and I Emulator for Windows (ZIEWin), the downloaded package ‘HCL_ZIE_for_Windows_x.x.x.x’ have the following folder structure.

    Figure 20 : HCL ZIE for Windows product package

  2. In the “ZIE License Manager” folder, find the ZIE License Manager installer files 'LicenseManager.ear' and 'LicenseManager.war' files.

Step-4 : Configure the License Manager and the Product for usage

4.a Setup the HCL Licensing

Once the download is complete follow the below procedures.

  • Extract the appropriate OS Specification package, which contains the required jars and .bat files.

  • The flexnetlsadmin.bat file which is used to connect to the HCL Licensing is present in : [Extracted CLLS package]\enterprise.

  • Once the installers are available, follow the below given steps and article URL to configure the HCL Licensing.

https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0073344&sys_kb_id=c75b269c1b79dc54f37655352a4bcb47

Note: The user choose the Server deployment mode as Local or Cloud while setting up the license server.

Figure 21 : Server deployment mode

  • After completing the License server deployment, the user gets a custom HCL License URL.

  • Use custom URL to replace the following link given in the upcoming procedures.

<https://[license server host]/api/1.0/instances/[license server ID]>

  • "Set Password”, click “Action” for the newly created device, select “Set Password” option from the drop down and setup a password. This password is used to upload the “public” key for License Manager auto SSH login.
Note: Throughout this document, the elements enclosed in the square brackets ( [ ] ) indicate the parameter name/example and it replaced with the actual value in the command according to the context.

For Example:

[license server host] is to be replaced with License Server http address and [license server ID] is replaced with License Server’s ID.

For further queries related to HCL License Server setup, contact the HCL Customer support team using the following link : https://support.hcltechsw.com/csm

4.b Configure the Product (HCL ZIEWin) with the HCL License Server

To configure HCL ZIE for Windows with the License Server, follow the below steps.

Pre-requisite for Key-pair generation:

  • Install any open source key tool (like Open SSL or Java key tool) in the machine for key-pair generation.

Steps to Configure the product with the HCL Licensing:

a. Configure the Key Tool

b. Generate the Key-pairs

c. Upload the public key to HCL License Server

Below are the detailed procedure to Configure ZIEWin with HCL License Server using Open SSL:

a.Key Tool Configuration (for Open SSL):

  1. After installing Open SSL, copy the open SSL folder under C:\ drive.

  2. Configure the Open SSL path in the system environment variables as shown:

Figure 22 : Configuring the Open SSL under system environment variables

b.Generation of Key-pairs (using Open SSL tool)

The Public/Private key pair generated is used for secure communication. The key pair must be in "RSA 2048-bit" format. The private key format must be "pksc8", and that of the public key must be "DER" format.

The following is the procedure to generate key-pairs using OpenSSL:
Note: If users are using any other third-party tool for key-pair generation, the user need to follow the instructions provided.)

  1. Generate Private Key.

    Open Command Prompt as an Administrator and enter the Open SSL path to change the path from the root directory (C:\OpenSSL\bin). Enter the below command, to generate the private key under C:\OpenSSL\bin,

    openssl genrsa -out private_key.pem 2048

  2. Get the Public Key.

    After the private key is generated, enter the below command to generate the public key also in the same path.

    openssl rsa -in private_key.pem -pubout -outform DER -out public_key.der

  3. Convert Private Key to pkcs8 Format to use it.

    The private_key.pem file must be converted into pcks8 format for strong encryption. To do this conversion, enter the below command,

    openssl pkcs8 -topk8 -inform PEM -outform PEM -in private_key.pem -out private_key_pkcs8.pem -nocrypt

    Figure 23 : Generated keys under C:\OpenSSL\bin

c.Uploading the Public Key to the HCL License Server

  1. To connect to the HCL License Server, the Extracted CLLS package must be available in the local machine. Navigate to the HCL License Server folder in the local machine. (D:\ [Extracted CLLS package]\enterprise)

  2. Open the Command Prompt and enter the below command. Set the password while creating the device in HCL Software License & Download Portal using the “Set Password” option or the default password for HCL CLLS is “HCLDefault1@”.

    flexnetlsadmin.bat -server https://[license server host]/api/1.0/instances/[license server ID] -authorize admin [license sever admin password] -uploadPublicKey [local path to public key (in DER format)]

    For example:

    flexnetlsadmin.bat -server https:// hclsoftware.compliance.flexnetoperations.com/api/1.0/instances/FED321CBA -authorize admin xxxx -uploadPublicKey C:\temp\public_key.der

  3. If the public key is successfully uploaded to the HCL License Server using the above command, the user receives an acknowledgment as “Client public key has been uploaded successfully” from the HCL License Server.

    (For any queries related to the HCL License Server setup, contact the HCL Customer support team using the following link : https://support.hcltechsw.com/csm)

  4. Enter the below HCL License Server command to check the feature description and the total no. of licenses configured for that feature.

    C:\Users\Admin\Desktop\HCL License Server\Others\[Extracted CLLS package]\enterprise\flexnetlsadmin.bat -server <https://[license server host]/api/1.0/instances/[license server ID] / -authorize <username> <password> -licenses -verbose>

    For example:

    C:\Users\Admin\Desktop\HCL License Server\Others\[Extracted CLLS package]\enterprise\flexnetlsadmin.bat -server https:// hclsoftware.compliance.flexnetoperations.com/api/1.0/instances/FED321CBA -authorize admin xxxx -licenses -verbose

    Figure 24 : HCL License Server command to check Feature description & count of configured licenses

4.c Configure the HCL License Server details in the License manager application (via any supported Application server)

Pre-requisite:
  1. A supported Application server (like WAS or Tomcat) must be installed in the machine.
  2. Deploy the License Manager .ear or .war file in the Application server. The below image shows the deployment of License Manager using WebSphere Application sever’.

    Figure 25 : Deploying License manager file (.ear/.war) in Application server

    Configuration:

    1. Click and Open the deployed License Manager application.
    2. Configure the context root for the License Manager under: Web Module Properties à Context Root for Web Modules.


    3. Configure the HCL License Server parameter details (in the below panel) , under theWeb Module Properties Initialize Parameters for servlets.Figure 26 : Configuring context root for License Manager (in Web Module Properties)

      Figure 27 : Configuring HCL License Server details (in Web Module Properties)
      • HCL License Server URL: Provide user custom HCL License Server URL that is generated in the step detailed in section 3.a.
      https://[license server host]/api/1.0/instances/[license server ID]

      • HCL License Server Private Key Path: The path where the converted private key in pkcs8 format is stored.
      D:\HCL License Server\private_key_pkcs8.pem

      • User Directory: Path for creating the User Directory, automatically after configuration. This directory contains all the License Manager related files and Database file.
      C:\LMDATA

    4. After the configuration is completed, launch the HCL ZIE License Manager from a browser.

      Example: http://10.115.50.68:9080/LicenseManager/Login.jsp


Figure 28 : HCL ZIE License Manager Login
Note: If user cannot see the HCL ZIE License Manager login page, restart the License Manager application on the Application server where it is deployed.
Login to the License Manager with the default credentials (username: “admin”, password: “password”), and check the Total Active license count. The count is shown as 0 initially since the downloaded product (ZIEWin) is not configured with the license manager.



Figure 29 : Active License count in License Manager (without configuring License Manager)

4.d Configure the License Manager with the product (HCL ZIE For Windows)

The Licensing settings can either be configured by providing the required server details in the ‘InstallShield Wizard' at the time of ZIEWin installation itself, or can be added/updated in the ‘Licensing Settings' section of the Advanced tab within the Preferences.

Licensing Settings

Mode:

The License Mode field is populated with the “HCL Licensing”,” License Manager,” and “Disable Licensing ” options. By default, select the“HCL Licensing” mode.

  • Select the “HCL Licensing”, the license is acquired by connecting to the “HCL License server,” and the user must configure the “HCL License server” URL in the “License URL” section.
  • Select the “License Manager”, the license is acquired by connecting to the “License Manager,” and the user must configure the “License Manager” URL in the “License URL “section.
  • Select the “Disable License”, the user can connect to the host without acquiring the license, and the status bar update with the below message. Also, the “License URL” and “Renewal Interval” fields are disabled.
Connecting without acquiring the License, as licensing is disabled. The value of “Disablelicensing” is set to yes in the pcswin.ini file.”
To use the “License Manager” setup, the user can configure the “pcswin.ini” file as below.
[License]
UseLicenseManager = Y
DisableLicensing = N
Similarly, to use the “HCL Licensing” setup, the user can configure the “pcsws.ini” file as below.
[License]
UseLicenseManager = N
DisableLicensing = N
And, to “Disable Licensing”, the user can configure the “pcsws.ini” file as below.
[License]
DisableLicensing = Y

License URL: Specifies the URL of the HCL License” server (FNO/CLLS) in case of the HCL Licensing” and in case of using “License Manager” it specifies the URL of the “License Manager”.

Example: “http://<http:address>:<port>/<context-root>/LicenseLogger”

Here, the <http:address> is the hostname or IP address of the server on which license manager is installed, <port> is the port that is specified during the deployment of the application server and <context-root> is the location name that is configured by the Administrator.

Renewal Interval:

Specifies the time in minutes when HCL Z and I Emulator for Windows session sends license parameters. The minimum value is 288 minutes (1/5th of a day), and the maximum value is 1440 minutes (1 day) while using "Direct HCL Licensing." When no value is configured, the default value of 864 minutes (3/5th of the day) is considered. The minimum value is 5 minutes, and the maximum value is 30 minutes in the case of using "License Manager", the default value is 5mins.

The "borrow interval" of the license request is five times of "renewal interval" in the case of "Direct HCL Licensing" without using "License Manager". In the case of "License Manager," the "borrow interval" is equal to the "renewal interval". The "borrow interval" specifies the time the client reserves the license.

In the case of "Direct HCL Licensing," during a communication failure after acquiring the license, the subsequent connection attempts are allowed till the borrow interval elapses. Hence, having a large "borrow interval" is recommended. The maximum borrow interval set to "5 x 1440 mins," which is equivalent to 5 days.
Note: The Licensing Settings set by the "Preferences" utility take precedence over the settings set through installation. If the installation is "user installation" where the application data location is %appdata% in the user directory, the setting that is set in the "Preferences" utility is applicable only for the current user.
1. Configure the Licensing Settings during the GUI installation of ZIEWin.

During the installation in the “License Server Details” install panel, users can configure the “License URL” and “Renewal Interval” fields. Users may skip configuration during the installation and can configure using “Preferences” utility after installation.

Figure 30 : Use License Manager

2. Configure the Licensing Settings during the Silent installation of ZIEWin

The “License Server Details” is configured during the silent installation by setting the Properties in the “custom.ini” file used for silent installation. Here are the Property names for the respective settings.

By default, “Disable Licensing” is disabled, and the “LICENSEMODE” property set to “1” in the custom.ini file.
Set LICENSEMODE=2 for using the “License Manager.”
LICENSEMODE property supported values are,
Set LICENSEMODE =1 for the “HCL Licensing”
Set LICENSEMODE =2 -> for the “License Manager”
Set LICENSEMODE =3 -> for the “Disable Licensing”
Use License Manager – USELICENSEMANAGER 
License URL – LMSERVERURL 
Renewal Interval– LMSERVERINTERVAL

3. Configure the Licensing Settings using the “Preferences” utility

  1. The “Preferences” utility can be run from the “Windows Start Menu” under the product “HCL ZIE for Windows” as show below.

  2. In the “Preferences” utility, go to the “Advanced” tab to find the section “Licensing Settings”, user can configure the fields “License URL” and “Interval” here.

  3. Launch the session manager by running “Start or Configure Sessions” from “Windows Start Menu” under the product “HCL ZIE for Windows”. User “Start” an existing session profile or create an emulator session using “New Session” button.

  4. Launch the session and check the License count in the License Manager.

  5. Provide the below HCL License Server command (same as the command entered previously to upload the public key to HCL License Server) and check the acquired licenses as per the session launched from different machines.
    C:\Users\Admin\Desktop\HCL License Server\Others\[Extracted CLLS package]
\enterprise\flexnetlsadmin.bat -server <https://[license server host]
/api/1.0/instances/[license server ID] -authorize <username> <password> -licenses -verbose>
  6. The HCL License Server window also show the Client device information from where the sessions are launched, and licenses are acquired.

    Figure 36 : HCL License Server command to check acquired licenses.