Interfacing the Intergraph Smart Licensing Cloud

This document describes the steps required to interface OpenLM with the Intergraph Smart® Licensing Cloud in order to monitor license usage and obtain license statistics.

Requirements

To query the Intergraph Smart Licensing Cloud license manager:

1. OpenLM Server v5.0 or higher must be installed on a machine in your organization.
2. OpenLM Broker v4.11 or higher. Can be installed on any machine since the Intergraph Smart Licensing Cloud is cloud-based.

Monitoring capabilities and features

The following monitoring capabilities are available for Intergraph Smart Licensing Cloud:

Interfacing Intergraph Smart Licensing Cloud using OpenLM Broker

Diagram of how OpenLM interfaces with the Intergraph Smart Licensing Cloud

OpenLM Broker can interface with Intergraph Smart Licensing Cloud via its API. You will have to log-in to the Intergraph portal and create an API client in order to obtain a Client ID and Client Secret key (described in section 3.1 below). Once the cloud API is queried by Broker, the data is sent back to OpenLM Server for processing.

Please note that OpenLM Broker must already be installed and configured to report to OpenLM Server before proceeding further.

Obtaining Intergraph Smart Licensing Cloud API client ID & secret

A Client ID and Client Secret is required to read data from the Intergraph Smart Licensing Cloud via its API. This can be obtained using the licensing portal:

1. Go to https://licensing.hexagonppm.com/
2. Login with your credentials.
3. Expand the left menu and click on API Clients.
   
4. In the bottom-right corner, click on the blue round (+) button to add a new Client ID/Secret pair.
5. In the pop-up window, select token duration as “1 day”, click OK.
6. Write down the Client ID and Secret as you will need them in the steps below.

OpenLM Broker configuration

To have OpenLM Broker query the cloud license service, in the OpenLM Broker configuration tool (Windows Start → OpenLM → OpenLM Broker):

1. Click Add Port
2. Enter any port number (irrelevant for this license manager)
3. Select Intergraph from the “License Manager Type” drop-down menu.
4. Click Apply.
5. In a text editor, open the intergraph@XXXX.properties file that has just been created in the Broker folder (typically C:Program FilesOpenLMOpenLM Broker), where XXXX is the port number you defined.
6. Add the Client ID and Secret that you obtained in section 3.1. to the oauth.client_id and oauth.client_secret variables and save the file.
7. In the OpenLM Broker configuration tool, select the data_inquiry node under Commands.
8. Edit the {$company_code} part of the command to indicate your company code. The company code is visible in the Licensing Portal pages as well as the URL. To obtain it:
   • • Log into the Licensing Portal
     • Click Live Usage in the sidebar
     • If you are assigned to multiple companies, select the company for which you need the company code
     • The title of the Live Usage page will be “YOURCOMPANYCODE – All Cloud Locations”
     • NOTE: If your company name includes spaces or special characters you will need to consult the “Licensing Portal API Documentation” on how to correctly escape those characters.

   An example command looks like:

   https://ppm-licensingportalapi-prod.hexagonsmartlicensing.com/Servers/CompanyLicenseUsage(companyCode='OPENLM')

9. Click Apply then Restart Broker.
10. Click Execute to make sure that the command is successfully querying the cloud service. You should see data in the execution output window.

 OpenLM Server configuration

Once the Broker has been configured, it should send data to the OpenLM Server. The final step in interfacing Intergraph Smart Licensing Cloud with OpenLM is to approve the configuration in EasyAdmin.

Automatic OpenLM Server configuration via EasyAdmin

1. Open the EasyAdmin interface (Windows Start → OpenLM → OpenLM EasyAdmin User Interface.
2. In the License Servers window, click on the red row that contains the details of the newly added Intergraph Smart Licensing Cloud server entry and click Approve.

The Intergraph Smart Licensing Cloud configuration has now been automatically added to OpenLM Server and should also be present in the OpenLM Server configuration tool.

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

How to verify your Intergraph Smart Licensing Cloud configuration

To check if the Intergraph Smart Licensing Cloud is monitored correctly:

1. Open the EasyAdmin interface (Windows Start → OpenLM → OpenLM EasyAdmin User Interface or navigate to http://<OpenLM Server host>:7019/EasyAdmin2/)
2. Click EasyAdmin Start → Widgets → License Servers.

The License Servers window will open. Verify that the configured license manager(s) appears on the list. A green circle node indicates an active connection to the license server.

Please note that sometimes it may take up to 3 minutes for the status indicator to change for new connections.