Product Logo

HCL ZIE License Manager



Table of Contents


Introduction


License manager is a tool that facilitates effective software management between end users and software vendors, thereby enabling organization to track and document the usage of the company's software products. HCL ZIE License Manager is the license control tool used to track the license information for Mainframe Terminal emulator products like HCL ZIE for Web and HCL ZIE for Windows.

 

The HCL ZIE License Manager can be configured for the following versions of HCL Terminal Emulators:

* HCL ZIE for Web version 1.0 & above

* HCL ZIE for Windows version 1.0 & above

 

HCL ZIE License Manager (LM) can track license usage for both ZIE for Web and ZIE for Windows, when it is installed and configured with WebSphere Application Server (WAS), ZIEWeb Embedded Server or Tomcat.

 

Installation and configuration of HCL ZIE License Manager Server for Z and I Emulator for Web (ZIEWeb) and Z and I Emulator for Windows (ZIEWin)

 

Prerequisites for the installation of License Manager:


Application Server

Flexera licensing details 

Installation of HCL ZIE License Manager:

Follow the below procedure to install License Manager: 

  1. Download the zip file from Flexnet Operations.
  2. Extract the zip file into a folder.
  3. Install the .ear or .war file on the application server by following the deployment instructions for the respective application server.
  4. Enter the URL to access the License Manager Web application:  

For example:  

http://<appserver-address>:<port-num>/<context-root> 

where,  

<appserver-address>    :    is the hostname or IP address of the server on which license manager is installed, 

 <port-num>     :    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.


Steps to configure the License Manager:

1. Client-based configuration:

 

For ZIE For Web:


 For all the client types (ZIEWeb Lite Client Launcher and Java Webstart client add the following parameters to the configuration file (config.properties), that is located in the ZIEWEB server publish directory.
 

 For example:

licenseserverurl=http://127.0.0.1:9080/LicenseManager/LicenseLogger

timeout=5

enableMacAddress=true

 

For Host Access Client Library (HACL):

 

For HACL applications, developers can set the License server URL and timeout values with the below session parameters and statements:


p.put(Session.LICENSE_SERVER_URL,"http://<server-address>:<server-port>/<context-root>/LicenseLogger");
p.put(Session.LICENSE_SERVER_TIME_OUT,"5");
p.put(Session. LICENSE_SERVER_MAC_ADDRESS,"true");
p.put(Session. LICENSE_SERVER_MACHINE_NAME,"false");

  

2. Configuration of Unique License Count

 

Administrators can mandate license uniqueness, based on different values, by modifying the “adminConfig.properties” file in the License Manager installed directory. 

 

For Example:               

  defineUniqueUser=systemusername;macaddress

 

image-20190513125011-1

Below are the available parameters that need to be modified to define uniqueness. 

 

               IP address                      ip

               System user name        :   systemusername

               MAC address               :   macaddress

               Machine name            :   machinename 

 

Any combination of the above attributes can be used to define license uniqueness. If more than one parameter value has to be configured, then each parameter should be separated by a semi colon (;). 

 

Note : 

a).  While re-defining a unique user with existing logs, provide a different installation location for License manger in the servlet parameters (or delete the existing License manager folder) and restart, to avoid errors during license count calculation.

b).  Restart the HCL ZIE License manager, after re-defining the unique user.

 

3. Configuring the ZIE License Manager Servlet Parameters

 

 Following is a list of parameters that can be used to configure the License Manager:

 

Property

Value

Description

ZIE_WIN_Enabled

true/false

Enable/ disable ZIE for Windows client

ZIE_WEB_Enabled

true/false

Enable/ disable ZIE for Web client

FLEXERA_SERVER_URL

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

Flexera server URL for ZIE for Windows

FLEXERA_SERVER_PVT_KEY

C:\\Users\PrivateKey.pem

Flexera private key location for ZIE for Windows

FLEXERA_SERVER_URL_ZIEWEB

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

Flexera server URL for ZIE for Web

FLEXERA_SERVER_PVT_KEY_ZIEWEB

C:\\Users\PrivateKey.pem

Flexera private key location for ZIE for Web

Directory_Location

C:\\dir_location

Directory Location for logs

 

Depending on the application server that is used to deploy the License Manager application, the path from which the above properties can be initialized may change.


For WebSphere Application Server (WAS):

For Embedded Web Server:

For Tomcat Server:

Return to Top

 

Using the HCL ZIE License Manager:

 

After the server module is successfully installed, Administrators can use the license logger to monitor the client login from the License Manager Admin console.

The console can be accessed by navigating to:  
http://appserver-address:port-num/<context-root>/ 

When prompted for a username and password, Users may login with the default username admin and password password.

 

image

After logging in as a License Manager Admin, you can change the password by clicking on “admin on the menu bar. Refer to the ”Create New User" and "Change User Password"  sections below, for more information.

image-20180831145648-2

 As a License Manager Administrator, you can perform the following tasks:

License Information:

Total active licenses
- Number of active concurrent licenses for both ZIE for Web & ZIE for Windows combined.
 

License Count Statistics:

Highest Concurrent License Count
 -  Highest concurrent license count gives the maximum number of distinct users who have accessed the product (ZIE for Web / ZIE for Windows) simultaneously, since the installation of License Manager.
 

Highest Authorized License Count
- Highest authorized license count gives the maximum number of authorized users who have accessed either of the products ZIE for Web / ZIE for Windows) on a day.

 
Cumulative Authorized License Count
 -  Cumulative Authorized License Count gives the total number of distinct authorized users who have accessed either of the products (ZIE for Web or ZIE for Windows) till date, since the installation of License Manager.
 


 
More
- Clicking on the More option takes us to the License Summary Report for both the products combined.

 By default, the report shows a daily summary of licenses for the individual products, ZIE for Web and ZIE for Windows. The filter feature can be used to view the license usage for a specified date interval. It includes the following information for each product:

 The Admin can sort specific columns as required.

 

image

 

License Count Statistics specific for ZIE for Web and ZIE for Windows:

 

image 

 

Each section/tab shows the following information for the corresponding product. 

  1. Active Licenses
  2. Highest Concurrent License Count (Today)
  3. Highest Concurrent License Count
  4. Total Authorized Used License (Today)
  5. Highest Authorized License Count
  6. Cumulative Authorized License Count 

Active Licenses
 Active concurrent licenses for ZIE for Web / ZIE for Windows (for the active sessions). Admin can view the active client details by clicking the highlighted Active Licenses link. Active clients report shows the below information about all active clients at that time.
 

 The Administrator can sort specific columns as required.

Highest Authorized License Count
Highest Authorized license count gives the maximum number of authorized license users accessing the product (ZIE for Web /ZIE for Windows) on any day since the installation of License Manager.

Cumulative Authorized License Count
Cumulative Authorized license count of distinct authorized users since the installation of license Manager for the product (ZIE for Web and ZIE for Windows).
  

License usage details:

License details report for the current day (ZIE for Web and ZIE for Windows). 

Log level

This option is available on "License usage details" page. 

Select the log level (from 1-LOW to 3-HIGH) to filter the number of entries to be logged. The default log level, which is Level 3 (HIGH), logs all the entry parameters, including connection closed entry along with the periodic client check-ins. All the other log levels (1 and 2) will log only the first client check-in and the connection closed entry. 

 

Following are the parameters which are logged: 

image

 

Level 3:  All Parameters

Level 2:  Timestamp, IP, System User Name, Client Type, Sub-Client Type, Machine Name, Connection Status   

Level 1:  Timestamp, IP, System User Name, Client Type, Sub-Client Type, Connection Status  

The license usage report containing Log level 3 (HIGH) with license usage information can be extracted by the Admin into a .csv file (that can be opened as an Excel Workbook). 

 

User Management: 

To manage Users who can access the License Manager Admin console, click on Users on the menu bar.

 

image-20180831150956-11

To Create a New User

 

To create a new user, follow the below steps:  

Note: New users for license manager can be created only by the Admin.

 

To Delete an Existing User

 

Under the Existing Users section, there is an option to delete the existing user, by selecting the icon image-20180831153902-1 next to the username.

 

To Reset the Password for an Existing User

 

If required, Admin can reset the password for a selected user to the default password (‘password’), by clicking on icon image-20180831155312-2 next to the username in the existing users list.

 

To Change User Password

 

User can change the current password, by hovering the mouse pointer over the Username field displayed on top of the screen. After specifying the current and new password, Click Submit. 

Return to Top

 

Flexera Licensing integration for HCL ZIE License Manager

 

The licensing tool that is integrated with the HCL ZIE License Manager is Flexera, which provides a floating license model using the Flexera REST API client.

 

The usage of HCL ZIE License Manager sessions and requests are tracked and granted by Flexera licensing. For licensing to work in HCL ZIE License Manager applications, the Flexera server and the required runtime properties need to be pre-configured.

 

HCL ZIE License Manager Users may configure an on-premise license server or use HCL's Flexera Cloud Server. After configuration of the license server, License Manager Administrators need to create a public/private key pair, out of which, the public key is to be uploaded to the License server and the private key is used to configure the License Manager for communication with the server.

 

Secure License Server Configuration

Secure communication between License Manager and the Flexera License Server (cloud or local) involves signed content using a public/private keypair. A License Manager Administrator needs to generate and distribute this key pair. License Manager signs the licensing requests with the private key and the license server verifies the signatures with the corresponding public key.

 

1. Generate Public/Private Keypair :

 

The public/private keypair generated is used for secure communication. The keypair should be in "RSA 2048-bit" format. The private key format should be "pkcs8", and that of the public key should be "DER" format.

 

Various third-party tools are available for generating this keypair.Refer to the documentation supplied with the third-party tool for instructions. The following is an example of keypair generation using OpenSSL:

 

# Generate private key.

$openssl genrsa -out private_key.pem 2048

# Get the public key.

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

# Convert private key to pkcs8 format to use it 

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

 

2. Upload Public Key :

 

The public key must be uploaded to the license server using the command line tool "flexnetlsadmin", provided by Flexera. This tool requires Java 1.8 to run and requires the license server's Admin password to be set. Follow the instructions in the "Introduction to the HCL License Server" document to set the Admin password, and Run the "flexnetlsadmin" tool as follows:

 

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 adminpwd -uploadPublicKey C:\temp\ public_key.der

 

For resolving SSL issues that occur while using the "flexnetlsadmin" tool, try one of the following: 

Another method to upload the public key to Flexera server, is by using Flexera admin REST API /rest_licensing_keys, for which, an authorization bearer token needs to be generated using the /authorize API, and attached to the /rest_licensing_keys API header. For more information about instructions for Flexera licensing and generating authorization bearer tokens, refer to the information available at https://resources.flexera.com/instructions/productlicensing/en/FNL.htm

 

Enable Runtime Licensing in License Manager

 

Below are the parameters that can be modified to enable runtime licensing in HCL ZIE License Manager:

 

Flexera Server URL:

This parameter contains the URL of the Flexera license server. License Manager users may configure an on-premises server or they may use HCL's Flexera Cloud. The server URL, in either of this case, must be configured for this parameter.

If the user does not set a value for this parameter, an empty value is assigned, by default. 

If the user does not set a value for this parameter, default value is assigned. 

The Syntax for this parameter is as follows: 

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

 

Flexera Private Key path:

This parameter contains the absolute path of the license server private key in the .pem file 

For example:

D:\Users\key\PrivateKey\ PrivateKey.pem 

Return to Top

 

Limitations of HCL ZIE License Manager: 

National Translation is not available. Help files are currently available only in English.


 
 

Return to Top