Open APIs - Creating personalized queries of the OpenLM Database - KB3050 - OpenLM Software License Management
USA +1 866 806 2068 | JAPAN +81 3 45208991 担当:萩原 info@openlm.com

Open APIs – Creating personalized queries of the OpenLM Database – KB3050

Web interface of OpenLM User Interface has been designed to match our customers’ requirements, and has evolved over many iterations of production and feedback. Nevertheless, clients often want to present the license usage data that has been accumulated in their OpenLM Database in a different and original way. To answer this need, OpenLM provides SOAP interface to open APIs.

XML Legacy Interface

OpenLM’s interface in versions 1.7 and 1.8 has been over XML protocol. Documentation for these APIs is available on the OpenLM blog site. Port number 7014 is the default port for the XML proxy. It can be changed in the OpenLM Server configuration tool –> Port Settings tab.

Testing XML APIs:

In order to test the OpenLM XML APIs, a 3rd party tool such as this one will be required. The OpenLM XML post command is typed in its appropriate text box :

Send_HTTP_Tool

and after execution – the query result is and shown on a separatwe page.

Note:

Slight changes have been applied to these APIs. In order to confirm the exact syntax of these APIs it is recommended to browse the OpenLM proxy log. In order to do so;

1. Open the OpenLM Server configuration tool.

2. Select the Advanced tab.

3. Select the ALL logging level

4. Click  Apply and Restart now. Wait a few minutes for the log to accumulate the required data.

5. Open the openlm_proxy.log file, normally located at:  C:\ProgramData\OpenLM\

SOAP Interface:

OpenLM has integrated API interface implemented in SOAP. API structure can be obtained by accessing a SOAP WSDL file from your browser:

http://<hostname>:7020/OpenLM.Server.Services/AdminAPI?singleWsdl

The following is service help page that shows all supported methods:

http://<hostname>:7020/OpenLM.Server.Services/AdminAPI/web/help

Please note:

  1.  <hostname> stands for the OpenLM Server machine host name.
  2. Port number (7020 in the example above)  is the default port for the SOAP proxy. It can be changed in the OpenLM Server configuration tool –> Port Settings tab.
  3. It is also possible to obtain the API by entering the same URL line in a WCF client tool such as STORM (see below). You can also use other tools such as “SoapUI” https://www.soapui.org/ or “Postman” https://www.getpostman.com/.

Extract API data format

We find the following order of action to be most intuitive for filling in the exact message data required per each API:

  1. Open OpenLM User Interface web application using Chrome.
  2. Click F12 button and select ‘Network’ tab.
  3. Click ‘Record’ button and produce whatever report you need in the User Interface. You will be able to see exact format of the query you wish to employ through API.
  4. Fill in the required data on your WCF testing tool (e.g. Storm) interface.
  5. Please note that some tools fill in empty values within array type variables, perhaps as ‘placeholders’. These will not comply with expected message formats and will need to be taken care of.

General notes

  1. It is not recommended to access OpenLM Database tables directly as OpenLM is not obligated to keep the Database tables’ structure through upcoming version releases.
  2. In any case prior to developing a new type of report that is not found in User Interface – please contact OpenLM support team. Maybe it’s already implemented or currently on the drawing board.
  3. Assistance in the use of OpenLM APIs is out of scope for normal support. If you require it, we suggest turning to our professional services to produce a quote for your implementation.

in Monitoring licenses and usage reportsOpenLM Modules

Related Articles