Interfacing the OpenText License Manager (Broker v3.3) – KB4001s
These instructions are valid for older versions of OpenLM Broker. If you’re running OpenLM Broker v4.8.8 or higher, please consult this document instead.
OpenLM supports license monitoring of a wide, and ever growing variety of license managers. This application note elaborates the steps required to configure OpenLM to interface the OpenText License Manager, and obtain reliable license reports and usage statistics.
How does it work:
- The OpenText license manager directs usage data into a log file.
- A lightweight Java application (EventLog_Monitor) is run on the OpenText license server. It detects changes made to the log file and produces an OpenLM generic XML file which holds this data.
- The OpenLM Broker reads this XML file, and propagates it to the OpenLM Server.
- The OpenLM Server parses this XML and presents it in the OpenLM EasyAdmin web application.
OpenText License server configuration
1. The OpenText license manager needs to be configured to log all information to a specific file (e.g. opentext.log). Make sure that the log size and rotation are adequate for containing the entire license usage information over a few minutes.
2. Download the EventLog_Monitor and copy the entire EventLog_Monitor folder to the OpenText server, preferably under the OpenLM Broker installation folder (see OpenLM Broker configuration, below).
3. Type in the license information in the <full_path>\EventLog_Monitor\binaries\LicenseInfo.txt file. For example:
Product: VME Used Seats: 8 Total Seats: 106
4. Open the <full path>\EventLog_Monitor\binaries\config.properties file and configure it as follows:
- server = OpenText hostname or IP (e.g.: OpenText_server)
- port = number to identify the output (e.g. 12345)
- vendor = vendor used for logging in OpenText LM log file
- monitored.log = filename and path as specified in #1 above (e.g. opentext.log)
- license.info = filename and path as specified in #3 above.
- unified.xml = xml output file to be addressed by the OpenLM Broker
- sync.interval = number of seconds to update the xml file. Should be smaller than the interval specified in “data_inquiry” command on the OpenLM Broker configuration tool.
Make sure to use ‘/’ instead of ‘\’ as a separator for full paths in this file.
This file configures the OpenText logging. Please note the following:
Event log message IDs
The “Event log message IDs” part marks the information to be logged. ID numbers are attributed a value;
- ‘1’ – Enable logging of an event
- ‘0’ – Do not log this event.
For example, the line
will cause an event of successful license check-out to be logged, whereas
will cause an event of successful license check-out not to be logged.
Event Log File
- Event Log File Max Size: Maximal size of the log file in MB. Set it to be large (see note below).
- Event Log File Max Duration: Number of days for running the log. Set it for 365 days(see note below).
When either Max Size or Max Duration limits are surpassed, a new log file will be commenced, and it will be named according to the commencement date (e.g.: ImgLM_01_17_14.log started at January 17, 2014). Since OpenLM is configured to monitor a specific log file – this will end the OpenLM monitoring. The user should head this issue.
OpenLM Opentext event monitor
Click the LogMonitorService.exe icon in the EventLog_Monitor directory to start the “OpenLM Opentext event monitor” service.
Make sure the services has been started. The unified XML file should consequently be created now.
Configuration of the OpenLM Server
In order to configure OpenLM to work with the OpenText License Manager, follow this procedure:
2. Open the OpenLM Server configuration tool.
3. Select the License Servers tab, and click Add.
4. From the Type drop-down menu, select “OpenLM Generic“.
5. Type in a descriptive text in the Description text box (e.g.: “my OpenText license server”).
6. Set the Time Zone to where the License Server physically resides (e.g.: Istanbul UTC+3).
7. Type in the license server’s hostname or IP in the Hostname text box (e.g. opentext_server). This should be the same name as configured in the OpenText server.
Note that the exact same name will need to be used in the OpenLM Broker configuration as well (see below).
8. Type in the port number in the port text box. This should be the same name as configured in the OpenText server (e.g. 12345).
Note that the same number will need to be used in the OpenLM Broker configuration as well (see below).
9. “Is Triad Configuration”: OpenLM supports multiple server redundancy configurations for several types of license servers (e.g.: FlexLM, DSLS, IBM LUM). At the time of writing this article, OpenLM does not yet support multiple server redundancy for OpenText. Keep this box unchecked.
10. Use Broker check box:
- Unchecked (Default): The OpenLM Server actively queries the license manager. Keep this configuration when not employing the OpenLM Broker.
- Checked: Usage information is obtained solely by the OpenLM Broker installation on the License manager machine.
11. Click Apply.
OpenLM Broker Configuration
1. Download and install the latest OpenLM Broker version from the ‘Downloads’ section in the OpenLM website. Please refer to the OpenLM Broker quick guide or comprehensive guide documentation for more information.
2. Type in the OpenLM Server hostname (e.g. my_openLM_server)
3. Set the OpenLM Broker – OpenLM Server communication port number (default: 7016). Make sure the OpenLM server Port is open for inbound communication.
4. Set the License Servers characteristics exactly as in the OpenLM Server Configuration tool (listed above):
- Highlight the License Servers node
- Click ‘Add’ -> “License Server”.
- Type in the License server’s hostname (e.g. opentext_server), and click Apply.
5. Add a Port to the the newly named License server:
- Click on the opentext_server node
- Click ‘Add’ → ‘Port’, and click OK.
- Type in the same port number as configured on the OpenLM Server configuration tool (e.g. 12345)
- In the “License Manager Type” drop box, select OpenLM_Generic.
- Click Apply and then OK.
6. Open the Commands section and select data_inquiry. Configure the Broker’s “data_inquiry” command text box to periodically read the unified.xml output file defined above:
cmd /C type <full_path>\unified.xml
In this example, the command is:
cmd /C type “C:\tmp\unified.xml”
7. Click the ‘Execute’ button to check the operation of the Data Inquiry command.
8. Click the Apply button.
9. Repeat stages 6 thru 8 for the ‘Status’ command.
10. Expand the Vendors ‘+’ sign and type ‘ImgLM’ (case sensitive) in the Vendor text box.
11. Click ‘Apply’. If prompted by the “Vendor details changed, do you want to update the commands with the new data” – click ‘No’.
12. Click the “Restart Broker” button.
Run the EventLog_Monitor.jar command on the OpenText license server machine. Note that at the time of writing these lines the EventLog_Monitor is not run as a service, but should remain running permanently. One option to bypass this obstacle is to use a 3rd party tool such as”alwaysUp” that would run it as a Windows service.
That’s it !
Your OpenLM system is configured to present OpenText license usage information. Open the EasyAdmin web application to monitor historical and real-time usage informationIf you require any further assistance on this subject – please contact Support@OpenLM.com, and our team will be glad to assist.