Command line license utility

The Licensing command line interface is used to manage licenses for your customers:

You can download the latest copy of the utility for jdk8 here:

a jdk17 version is available here

Command Line Interface Operation

You need a Java Runtime Environment (JRE) installed to operate the command line interface.  Download a JRE 1.8 or higher from .  

Use the java command with the -jar flag to reference the command line java archive, followed by the options you require.  For example, to get command-line help, issue:

java -jar HCILicensing.jar -h


Heirloom Computing, Inc. Licensing-as-a-Service
Cloud Based License and Transaction System

Usage: java HCILicensing [-f]
   [-u https://.../licensecheck]
   [-s subscription-id] [-e email-address]
   [-c transaction-count]
   [-i import-file] [-x export-file]
   [-p product-code] [-r] [-q] [-l] [-h]
   -f -- licensing properties file containing license checking info, default
         '' in your home directory
   -u -- license / transaction checking URL, default
   -s -- subscription-id to check against, replacing or
      initializing licensing properties file
   -d -- licensing domain name, default contained in licensing properties file
   -e -- email-address authentication to check against, replacing or
      initializing licensing properties file
   -p -- product-code to check, default taken from or added to
      licensing properties file
   -c -- add transaction count to total, default 1
   -x -- export the current license file
   -i -- import the given file and merge it with the current license file
   -r -- require a check against the LaaS server
   -l -- list the current counts, when to check the license again,
      remaining grace period
   -q -- quiet, do not print anything
   -h -- this list of options
   exit code 0 if OK, 1 if expired but within grace period, 2 if expired
   outside grace period, or 100 communications problem
(c) 2013 Heirloom Computing Inc.,




Assuming you have a valid format license file on the machine you can use the utility to check the license and force a license request if needed.

The following product codes can be used, one per command line in the following examples:

Eclipse IDE: hpaas-cbl-sdk
Elastic Batch Platform:hpaas-ebp-rts
PLI Compiler: hceplicmp
PLI Runtime: hceplirts

The examples below assume the license file is in the default location. If you have moved the license file you can use the -f flag, or set the java variable heirloom.license to the correct location, like this:

java -Dheirloom.licensefile=<location> -jar HCILicensing.jar ..


Verifying a License

You can verify whether a license is currently up-to-date  without necessarily checking it with the license server.  Issue

java -jar HCILicensing.jar -l -p hcjes

to generate a report on the status of the Elastic Batch Platform license:

Heirloom Computing, Inc. Licensing-as-a-Service
Cloud Based License and Transaction System

License not checked against server
Product: hcjes
License Server Will Be Checked: 2014-02-20 23:03:59
Grace Period: 29days 23hours 48minutes
Queued Transaction Count: 0

If the license shows that it will next be checked at a later date, or if it has a grace period then the license is valid. Your license grace period is controlled by the license server and can be modified there, along with the number of cores, expiry date etc.

If you have license issues you should use the -l command for each product on the machine and include the output in any tickets you raise with support. You should also include the license file as an attachment on those tickets (there is no confidential information in the file).

Forcing a license check

Regardless of if a license is still within the "grace period" you can require that the HCILicensing command verify it against the license server.  Issue

java -jar HCILicensing.jar -r -p hcjes

The -r option will force the license to be checked and will update the cores,grace period and expiry date accordingly.


Client machines behind true Proxy Servers



Proxy Checker (supporting systems without internet access)

When Internet communications are not allowed from the system under license control, a separate computer that is connected to a network can serve as a proxy license checker.  The proxy checker will use the LaaS Command Line utility to transmit transaction counts and check license validity.  Follow this process:
  1. Use the command-line utility on the client machine with the -x (export) operands to create a proxy.txt file
  2. Copy the proxy.txt file from the client system using a secure transfer mechanism to the proxy-checker machine
  3. Upload the transaction count to the LaaS Server and verify the license and expiration date with the command-line utility on the proxy-checker machine.  Reference proxy.txt with the -f option.  Require that the update take place (-r option) but don't include any additional transaction counts other than what's in the proxy.txt file (-c 0 option).  This process updates the proxy.txt file with updated license information.
  4. If "License is OK" is printed by the command line utility then reverse the steps.  Securely transfer the proxy.txt file back to the client machine.
  5. Use the command-line utility on the client machine with -i (import) operand to merge verified license information with the then-current transaction count information on the client.

There are quick reference steps for this process detailed here :

You must have do this process for each product on the client application server(s) -- do not combine multiple exported license properties files into a single proxy checker license file before transmission to the LaaS (limited time restriction).  You can import a file only once.  You cannot tamper with (or edit or restore from backup) the license properties file, the export file, or the import file.  If you do an error occurs during one of the steps and you will have to ask that the license be reset by Heirloom support.
The customer (or you) must go through the "proxy checker process" before the end of the client license and any grace period or any products affected by the license will cease to function.  The command line(-l option) can be used to list when the license server will (attempt to be) next contacted unless a new license is imported. 
You should renew the license just prior to the expiry date to obtain the full "grace period."
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request


Please sign in to leave a comment.
Powered by Zendesk