Configuring HCL Z and I Emulator for Windows with Flexera
This document describes the procedure to acquire a license for using the product ‘HCL Z and I Emulator for Windows’ and to configure the product for connecting to a host.
Follow the instructions detailed in each of the below steps :
Setup the License Server (Flexera)
Configure the Product (HCL ZIEWin) with the License Server (Flexera)
Configure the Flexera details in License Manager application
Configure the License Manager application with the Product (HCL ZIEWin)
Copy the below link and paste it in a browser address bar to access the FlexNet login page.
Figure 1: Flexera Login
Enter the authorized login credentials to access the Producer Portal Home page.
Under QuickSearch, select “Products” under Search and “All Products” under For and provide the relevant keywords for finding the required products.
below image shows a keyword entered in the search field, to find the
“HCL ZIE Family products”.
Figure 2 : Producer Portal Home (QuickSearch for Products)
If the Search is successful, all the product packages relevant to the entered keyword will be displayed in the Search results.
Figure 3 : Package Products (Search Results)
Select the required Product package from the list (HCL Z and I Emulator for Windows 1.1).
In the “Create A product” panel that follows, click on the “Download Packages” tab to view and download the required packages.
The below image shows the options selected for downloading ‘HCL ZIE for Windows' and ‘HCL_CLLS’.
Figure 4 : Package Products (Download Packages)
Click on HCL_CLLS to download the ‘HCL Common Local License Sever 1.0’ package to a User defined location.
Click on HCL_ZIE_for_Windows_1.1 to download all the packages related to ‘HCL ZIE For Windows v1.1’ to a User defined location.
Open the downloaded package.
For the product HCL Z and I Emulator for Windows (ZIEWin), the downloaded package ‘HCL_ZIE_for_Windows_1.1.1’ will have the following folder structure,
Figure 5 : HCL ZIE for Windows product package
In the “ZIE License Manager” folder find the ZIE License Manager installer files 'LicenseManager.ear' and 'LicenseManager.war' files.
In the HCL_CLLS package that is selected, the zipped packages shown in the below image are present. Download the relevant installer, based on your OS specification to connect to the Flexera License server.
Figure 6 : Installer Packages in HCL CLLS
For Windows users, download the HCL_CLLS_WIN_1 package.
For Linux users, download the HCL_CLLS_LNX_1 package.
After the download is completed, extract the package which contains the required jars and .bat files.
The flexnetlsadmin.bat file that is used to connect to the Flexera License server is present in : [Extracted CLLS package]\enterprise.
Once the installers are available, follow the steps given in the below link to configure the Flexera License Server.
Note : You can choose the Server deployment mode as Local or Cloud while setting up the license server.
Figure 7 : Server deployment mode
After completing the License server deployment, you will get a custom Flexera URL.
Use your custom URL to replace the following link given in the upcoming procedures.
<https://[license server host]/api/1.0/instances/[license server ID]>
Note: Throughout this document the elements enclosed in the square brackets ( [ ] ) indicate the parameter name/example and has to be replaced with the actual value in the command according to the context.
[license server host] is to be replaced with License Server http address and [license server ID] is to be replaced with License Server’s ID.
For further queries related to Flexera setup, contact the HCL Customer support team using the following link : https://hclpnpsupport.hcltech.com/csm
To configure HCL ZIE for Windows with the License Server, follow the below steps.
Install any open source key tool (like Open SSL or Java key tool) in the machine for key-pair generation.
Configure the Key Tool
Generate the Key-pairs
Upload the public key to Flexera License server
Below is the detailed procedure to Configure ZIEWin with Flexera server using Open SSL:
After installing Open SSL, copy the open SSL folder under C:\ drive.
Configure the Open SSL path in the system environment variables as shown:
Figure 8 : Configuring the Open SSL under system environment variables
The Public/Private key pair generated is used for secure communication. The key pair should be in "RSA 2048-bit" format. The private key format should be "pksc8", and that of the public key should be "DER" format.
The following is the procedure to generate key-pairs using OpenSSL:
(Note: if you are using any other third party tool for key-pair generation, you need to follow the instructions provided by them.)
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
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
Convert private key to pkcs8 format to use it.
The private_key.pem file should 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 9 : Generated keys under C:\OpenSSL\bin
To connect to the Flexera server, the Extracted CLLS package should be available in the local machine. Navigate to the Flexera folder in the local machine. (D:\ [Extracted CLLS package]\enterprise)
Open the Command Prompt and enter the below command,
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)]
flexnetlsadmin.bat -server https:// hclsoftware.compliance.flexnetoperations.com/api/1.0/instances/FED321CBA -authorize admin adminpwd -uploadPublicKey C:\temp\public_key.der
If the public key is successfully uploaded to the Flexera server using the above command, you will receive an acknowledgement as “Client public key has been uploaded successfully” from the Flexera server.
(For any queries related to the Flexera setup, contact the HCL Customer support team using the following link : https://hclpnpsupport.hcltech.com/csm)
Enter the below Flexera server command to check the feature description and the total no. of licenses configured for that feature.
C:\Users\Admin\Desktop\Flexera\Others\[Extracted CLLS package]\enterprise\flexnetlsadmin.bat -server <https://[license server host]/api/1.0/instances/[license server ID] / -authorize <username> <password> -licenses -verbose>
C:\Users\Admin\Desktop\Flexera\Others\[Extracted CLLS package]\enterprise\flexnetlsadmin.bat -server https:// hclsoftware.compliance.flexnetoperations.com/api/1.0/instances/FED321CBA -authorize admin adminpwd -licenses -verbose
Figure 10 : Flexera server command to check Feature description & count of configured licenses
A supported Application server (like WAS or Tomcat) must be installed in the machine.
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 11 : Deploying License manager file (.ear/.war) in Application server
Click and Open the deployed License Manager application.
Configure the context root for the License Manager under: Web Module Properties Context Root for Web Modules.
Figure 12 : Configuring context root for License Manager (in Web Module Properties)
Configure the Flexera parameter details (in the below panel) , under Web Module Properties Initialize Parameters for servlets.
Figure 13 : Configuring Flexera details (in Web Module Properties)
Provide your custom Flexera URL that was generated in the step detailed in section 3.1.
https://[license server host]/api/1.0/instances/[license server ID]
Flexera server Private key path:
The path where the converted private key in pkcs8 format is stored.
Path for creating the User Directory, automatically after configuration. This directory will contain all the License Manager related files and Database file.
After the configuration is completed, launch the HCL ZIE License Manager from a browser.
http://<server ip>:<server port no>/<context-root>/LicenseLogger
Figure 14 : HCL ZIE License Manager Login
Note : If you 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 will be shown as 0 initially since the downloaded product (ZIEWin) is not yet configured with the license manager.
Figure 15 : Active License count in License Manager (without configuring License Manager)
The License Manager 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 ‘License Manager Settings' section of the Advanced tab within the Preferences.
License Manager Settings
License URL : Specifies the HTTP URL of the License Manager Server to which HCL Z and I Emulator for Windows session sends license parameters. It’s mandatory to configure this field to use the product. If this field is not configured the emulator session initiation will be aborted.
Here the <http:addr -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 can be configured by the Administrator.
Interval : Specifies the time period in minutes at which HCL Z and I Emulator for Windows session sends license parameters. It is the request interval after which the server marks the client as timeout if the request is not sent. Default and the minimum value is 5 minutes and the maximum value is 30 minutes
Note: The License Manager Settings set by “Preferences” utility takes precedence over the settings set through installation. If the installation is “user installation” where the application data location is %appdata% in user directory the setting that are set in “Preferences” utility is applicable only for the current user.
Configure the License Manager Settings during the GUI installation of ZIEWIN.
During the installation in the “License Manager Server Details” install panel you can configure the “License Manager URL” and “Interval” fields. You may skip configuration during the installation and can configure using “Preferences” utility after installation.
Figure16: License Manager Server Details section in the ‘InstallShield Wizard' of ZIEWin
Configure the License Manager Settings using “Preferences” utility
The “Preferences” utility can be run from the “Windows Start Menu” under the product “HCL Z IE for Windows” as show below.
Figure17: Preferences utility from the Windows Start Menu
In the “Preferences” utility, go to “Advanced” tab to find the section “License Manager Settings”, you can configure the fields “License URL” and “Interval” here.
Figure18: License Manager Server and ZIE Server Details section within the Advanced tab of Preferences utility in ZIEWin.
Launch the session manager by running “Start or Configure Sessions” from “Windows Start Menu” under the product “HCL Z IE for Windows”. You can “Start” an existing session profile or create an emulator session using “New Session” button.
Figure 19 : Launch the “Session Manager”
Launch the session and check the License count in the License Manager.
Figure 20 : Launch the session from Session Manager
Figure 21 : Updated Active License count in License Manager (after configuring License Manager)
Provide the below Flexera command (same as the command entered previously to upload the public key to Flexera server) and check the acquired licenses as per the session launched from different machines.
C:\Users\Admin\Desktop\Flexera\Others\[Extracted CLLS package]\enterprise\flexnetlsadmin.bat -server <https://[license server host]/api/1.0/instances/[license server ID] -authorize <username> <password> -licenses -verbose>
The Flexera window will also show the Client device information from where the sessions are launched, and licenses are acquired.
Figure 22 : Flexera server command to check acquired licenses