Monitoring the Sparx License Manager with OpenLM

Sparx is one of the many license managers supported by OpenLM. In this step-by-step guide, we will explore how to configure OpenLM to monitor with the Sparx License Manager in order to obtain license statistics.

Diagram of how OpenLM Broker interfaces with the Sparx License Manager and the OpenLM Server

Requirements

1. OpenLM Server v21.x or higher installed on a machine in your organization.
2. OpenLM Broker v21.x or higher installed on the same machine as the Sparx license manager.

OpenLM Broker configuration

1. Download and install the latest OpenLM Broker version. Follow the Broker configuration guide for step-by-step instructions.
2. Select the hostname node (e.g. L312MD) and then click on Add Port.
   
3. Enter the Sparx server port number (default: 7770) and select the License Manager Type as Sparx from the drop-down menu.
4. Click Apply.
5. Under the newly created node, right-click Log Files → Add Log File.Configure the Log File Definition screen as follows:
   Type – SSKS Log
   Name (Descriptive) – a name to help you identify the purpose of the log
   Path – click on the […] button and navigate to the logs folder where your installation of Sparx is located. The required file is named ssksLog.log
   Vendor – select the Vendor that you have defined in the Vendors node (by default: “Vendor Name to Be Filled”).
   

Default Encoding UTF -16 for Sparx License Manager:The default encoding set is UTF -16 for Sparx License Manager. For the log files stored in UTF -16 encoding, this encoding must also be configured to UTF -16 in OpenLM Broker to read these log files, as shown in the image below.Note: A UTF -16 log file will have BOM prefix. In such a case, OpenLM Broker should be configured (as mentioned below) to read a log file as UTF -16. OpenLM Broker reads BOM and applies proper order. If UTF -16 encoding fails and BOM prefix is missing in the log file for any unknown reason, you can configure UTF -16LE manually in OpenLM Broker. To configure encoding manually, the option to select Encoding is available under the Advanced section in the Log File Definition screen. Select the required encoding, for example: UTF – 16, from the drop-down options available for the Encoding field.

1. Click Apply to save the changes.
2. Click Restart Broker, wait a couple of seconds then finally click OK on the “Service started successfully” dialog pop-up.
3. Open the EasyAdmin interface either by accessing (http://<OpenLM Server FQDN>:5015 or Cloud.openlm.com) in your browser or through the Start Menu → OpenLM → OpenLM EasyAdmin User Interface shortcut).
4. In the License Servers window, click “Approve” on the Sparx entry that has been added automatically.

Additional: Configure the OpenLM Broker to monitor Sparx using Broker UI

1. Access your Broker UI in the Chrome/Edge/Firefox e.g: http://localhost:5090/.
2. Navigate to the License Managers tab → Add License Manager. A pop-up appears.
3. From the drop-down list select LM type Sparx and enter the Port number (ex: 7770)
4. Click ADD.
   
5. Commands tab options:

• Use the operating system start/stop commands toggle – 0N/OFF
• Parallel execution toggle – ON/OFF
• Allow license file sorting
• Inquiry:
  PERIODIC
  ON-DEMAND: start/stop toggle.

1. In the Executable path field input the actual path executable on the SPARX license server.
2. Switch to the Vendors tab. Set the name correctly.
3. Switch to the Log Files tab. Click Add Log File. The ADD LOG FILE pop-up appears.
4. Configure the Log File Definition screen as follows:
   Type – SSKS Log
   Name (Descriptive) – a name to help you identify the purpose of the log
   Path – click on the […] button and navigate to the logs folder where your installation of Sparx is located. The required file is named ssksLog.log
   Vendor – select the Vendor that you have defined in the Vendors node (by default: “Vendor Name to Be Filled”).
5. Encoding – UTF -16
   
6. Click CONTINUE.
7. Click on SAVE.

Manual OpenLM Server Configuration

If the automatic configuration has failed, you can manually configure OpenLM Server to connect to the OpenLM Broker installation. The hostname and port settings must match those that have been configured for OpenLM Broker.

Adding Spark License Server

1. Give a Display name.
2. From the Type drop-down menu, select Sparx.
3. Insert a description in the Description text box (e.g. “SparxLM”)
4. Set the Time Zone to where the license server physically resides.
5. Enter the Hostname and Port number of the machine where the Sparx License Manager is configured in the Broker.
6. Is Triad Configuration box: unchecked.
7. Use Broker box: checked.
8. Click Save.

OpenLM Server is now configured to monitor the incoming data from OpenLM Broker.

Verify the Sparx License Manager configuration

Open the EasyAdmin user interface (access http://<OpenLM Server FQDN>:5015 or Cloud.openlm.com in your browser) by accessing the shortcut in the Windows Start Menu → OpenLM → OpenLM EasyAdmin User Interface.

2. Click EasyAdmin Start → Widgets → License Manager Servers. Verify that the configured license manager(s) appears in the server list. A green circle node indicates an active connection to the license server.

Known Limitations

• License denials are currently not monitored