OpenText AutoPass License Server

To monitor licenses served by OpenText AutoPass License Server (APLS) in OpenLM Platform, give OpenLM Broker an APLS user and the products to monitor. APLS, formerly a Micro Focus product, serves concurrent licenses for OpenText software such as Dimensions RM and UFT One. OpenLM Broker reads license totals, the licenses in use, and rejected license requests from the APLS REST API on a schedule and reports them to OpenLM Platform. You give Broker an APLS user to sign in with and the list of products to monitor.

Note

This page covers OpenText products licensed by OpenText AutoPass License Server (APLS). For OpenText Desktop Viewer, formerly Spicer Imagenation, which uses the ImgLM license manager, see OpenText (Spicer).

Before you begin

Confirm these prerequisites:

• OpenLM Platform.
• OpenLM Broker v26.10.13.929 or higher, installed on a machine that reaches APLS over HTTPS. Earlier Broker versions do not list AutoPass as a license manager type.
• The Broker approved in Broker Hub. OpenLM Platform accepts license manager data only from approved Brokers, so the AutoPass entry does not reach Pending Servers until the Broker itself is approved.
• An APLS username and password for Broker. A view-only user is enough, because Broker only reads usage.
• The product definition identifier of each product you want to monitor. See Find the product identifiers.

What you can monitor

OpenLM Broker monitors the following for OpenText AutoPass License Server:

LM Type in the Broker	Commands	Logs	Quantity	Expiration date	Denied	Borrowing	Allocations	Report resolution
AutoPass	Yes	No	Yes	No	Yes	Yes	No	Seconds

OpenLM Broker uses the APLS REST API for commands. Denials require APLS 24.3 or higher.

On every data inquiry, Broker reports:

• Feature name: the feature description from APLS. A feature with no description is reported by its feature ID and version, for example 7001:1.
• Version: the feature version.
• Product: the product code and version from the product identifier, for example UFT 14.50 for 10027_1.0_UFT_14.50.
• Total: the total capacity of the feature from the APLS license summary.
• In use: the capacity checked out in the APLS In Use report. When APLS reports capacity in use without checkout records, Broker reports that capacity.
• Username: the username of each checkout, without a domain prefix such as CORP\.
• Workstation: the host name of each client, or its IP address when APLS has no host name.
• Start time: the start of each checkout, converted to UTC.
• Borrowed: Commuter and Remote Commuter checkouts, reported as borrowed licenses.
• Denials: license requests that APLS rejected since the previous data inquiry, with the rejection reason that APLS gives. APLS 24.3 or higher has this report.
• License type: Broker reports every feature as Floating.
• Vendor: Broker reports OpenText unless you add a different vendor on the Vendors tab.

License expiration dates and license allocations are not available for OpenText AutoPass License Server.

How OpenLM Platform interfaces with AutoPass

When you configure an AutoPass port, Broker fills in only the settings in this list. The remaining license manager settings stay empty:

• Commands: data_inquiry only, which the Broker UI shows as Data Inquiry. Its default command line is the base address of the APLS REST API, not a program:

  https://{$host}:{$port}/autopass

  In the Broker UI, the command line already shows the Host from the License Managers page and the port of the license manager in place of {$host} and {$port}. On every run, Broker sends these requests to that address:

  • POST /services/v10.5/feature/usage/summary, once for each product you list, for the features of the product and their totals.
  • GET /services/v10.3/feature/usage/raw?reportType=0, for each feature in use, for its checkouts (the In Use report).
  • GET /services/v24.3/feature/usage/raw?reportType=3, for each feature, for the requests rejected since the previous run (the Rejected report). APLS versions earlier than 24.3 do not have this report. Broker then stops asking for it until the Broker service restarts.

  Every request carries the APLS username and password with HTTP Basic authentication. AutoPass has no status command, so Broker reports the license server as active whenever the requests succeed.

• Advanced options: username, password, and products, on the Advanced tab of the license manager. Broker stores the password encrypted and shows it masked.

• License file: None.

• Log file: None. The Log Files tab stays empty.

• Polling: The data inquiry runs every 55 seconds by default. Checkouts that start and end between 2 runs do not reach OpenLM Platform. Denials do, because Broker reads every rejected request since the previous run.

Prepare the AutoPass License Server

Broker needs three things from APLS: a user to sign in with, the identifiers of the products to monitor, and a certificate that the Broker machine trusts.

Choose an APLS user

Broker signs in to APLS with a username and password from the license manager's Advanced tab. A view-only user is enough, because Broker never changes anything in APLS. APLS comes with a view-only user named aplsUser. If your APLS administrators changed its password or set up a separate read-only user for monitoring, use that one.

Find the product identifiers

Broker cannot list the products installed on APLS, so you list the products to monitor. Each product is identified by its product definition (PD) identifier, in the form pdfid_pdfVersion_productCode_productVersion. It is the name of the product's PD file without the .pd extension, for example 10027_1.0_UFT_14.50.

Your APLS administrator can tell you the identifier of each product. Broker monitors only the products that you list, so add every product whose licenses you want to see in OpenLM Platform.

Check the certificate

APLS serves its REST API over HTTPS, on port 5814 by default. Broker validates the APLS certificate like any HTTPS client, so the Broker machine must trust that certificate or the certificate authority that issued it. On Windows, Broker uses the Windows certificate store. On Linux, it uses the trust store of its Java runtime.

If APLS uses a certificate that the Broker machine does not trust yet, import it as described in Import a TLS certificate for the Broker, and restart the Broker service.

Configure OpenLM Broker

To configure OpenLM Broker for AutoPass:

1. Open the Broker UI for the Broker that monitors APLS.

   • On the Broker machine: open http://localhost:5090/. Local access needs no credentials.
   • From any other machine: open Broker Hub in OpenLM Platform and select the Broker UI icon of that Broker. This opens the interface with the remote access token handled for you.

2. On the License Managers page, confirm that Host holds the APLS host name.

   OpenLM Platform lists the license server under this host name, and the field holds the host for every license manager on the page, not for APLS alone.

   • If the field is empty, enter the APLS host name and select the save icon next to the field.
   • If it names a different machine, leave it as it is, and enter the APLS address in the data inquiry command instead.

3. Select License Managers, then Add License Manager.

4. From LM Type, select AutoPass.

   Add OpenText AutoPass License Server as a license manager

5. Enter the APLS port, 5814 unless your administrators changed it.

6. Select Add.

7. On the Advanced tab, set the three options. For each option, select its edit icon, enter the value, and select Continue:

   • username: the APLS username, for example aplsUser.
   • password: the password of that user.
   • products: the identifiers of the products to monitor, separated by commas, for example 10027_1.0_UFT_14.50,10000_1.0_DimensionsRM_25.4.

   If the list disappears after you select Continue, select another tab and then Advanced again.

   The APLS user and the products to monitor, on the Advanced tab

8. On the Commands tab, select the Data Inquiry command.

9. Check its command line.

   • Host set to the APLS machine: keep the default command line.
   • APLS on another host: replace {$host}:{$port} with the APLS host name and port, for example https://apls01:5814/autopass.

   Keep /autopass at the end of the address, and do not add anything after it. Broker adds the paths of the APLS reports itself.

   The default Data Inquiry, with Host and the APLS port filled in

10. (Optional) Change Watch interval (sec) from the default of 55 seconds. Timeout (sec), 60 seconds by default, limits how long Broker waits for each APLS answer.

11. Leave the Vendors and Log Files tabs empty.

12. (Optional) To show a vendor name other than OpenText, add a vendor on the Vendors tab.

13. Select Save.

14. Reopen the AutoPass license manager from the License Managers list.

15. Select the Commands tab.

16. Select Execute to test the data inquiry.

    A successful test returns the license server XML, with a feature for each licensed feature of the products you listed and a user entry for each checkout. If the test fails, the server_status of the SERVER line holds the reason. See Troubleshooting. Broker refuses Execute on a license manager that you have never saved, and answers Need to save first in order to execute command.

17. Wait about a minute.

    Execute only tests the command inside the Broker UI and sends nothing to OpenLM Platform. Broker reports APLS to OpenLM Platform on the periodic data inquiry, so the license server reaches Pending Servers about a minute after you save.

Approve AutoPass in OpenLM Platform

Broker reports APLS with the OpenLM Generic protocol and names the license server after the Host you set in the Broker UI, so the pending entry is listed by that host name and the port you entered, with License Manager Type shown as AutoPass.

To approve AutoPass in OpenLM Platform:

1. Sign in to OpenLM Platform with the URL your administrator gave you.

2. Select Navigation (the grid icon in the OpenLM Platform header), then Licenses and Features, then License Servers.

3. Under Management, select Pending Servers.

4. Find the row whose Host Name and Port match the license manager you configured in Broker.

   Its License Manager Type is AutoPass, and Source names the Broker.

5. Select that row, then Approve and merge.

Verify the integration

To verify the integration:

1. In OpenLM Platform, select License Servers, then under Operational, select Live Servers Statistics.

2. Find the row for the host and port you configured, and confirm that Status is Up.

   Confirm that RSQT (Recent Successful Query Time), the last time OpenLM Platform read licenses and usage from the server, is recent, and that Quantity and Used carry numbers.

3. Select Navigation, then Licenses and Features, then Licenses, and select Live Statistics.

   The features of the products you listed appear as their own rows, with License Type Floating and the Total and Used counts from APLS. Compare them with the License Usage pane of APLS.

4. Select a feature's Used count to confirm that sessions arrived.

   The count opens the Usage app on Currently Consumed Licenses, where each checkout appears with its username, workstation, and start time.

5. If you use APLS 24.3 or higher, open Denials after a license request is rejected, to confirm that denials arrive.

Note

It can take up to 3 minutes for the status to update for a new connection.

Troubleshooting

The following entries cover APLS that does not reach Pending Servers, APLS that shows no features, missing denials, and Broker logs.

Why does APLS never reach Pending Servers?

Open Broker Hub and confirm that this Broker appears under Brokers with status Up, and not under Pending Brokers. OpenLM Platform accepts license manager data only from approved Brokers.

Why does APLS show no features?

If the Broker is approved and up, or if APLS appears with no features, go back to the Commands tab in the Broker UI and select Execute. Broker writes the reason for a failed data inquiry into the server_status of the SERVER line. Compare it with this list:

• No products configured for the AutoPass port <port>: the products option on the Advanced tab is empty. Enter the identifiers of the products to monitor.
• APLS returned no licensed features for product <identifier>, or APLS error <code>: <message> such as Product Definition is not found: APLS does not know that identifier, or has no license installed for it. Check the identifier with your APLS administrator, including its version parts.
• A status that ends with 401 and Check username and password in the AutoPass port settings: APLS rejected the username or password. Correct the username and password options on the Advanced tab.
• A certificate error, such as PKIX path building failed or unable to find valid certification path: the Broker machine does not trust the APLS certificate. Import it as described in Import a TLS certificate for the Broker, and restart the Broker service.
• Connection refused, or a timeout: nothing answers on that host and port. Check the host and port in the data inquiry, and that a firewall does not block the port between the Broker machine and APLS.
• A status that ends with 404: the command line does not point at the APLS REST API. Confirm that it ends with /autopass, for example https://apls01:5814/autopass.

Why do features arrive but denials never do?

Check the APLS version. APLS versions earlier than 24.3 have no Rejected report, and the Broker log then shows APLS has no denial report, it is older than 24.3.

Where do I find more detail?

The Broker log holds the detail, in the logs folder of the Broker installation. A manual Execute writes to broker-service.log, and the periodic data inquiry writes to port-<port>-AutoPass.log.

Known limitations

These limits apply to OpenText AutoPass License Server monitoring:

• Broker cannot discover the products installed on APLS. It monitors only the products listed in the products option, so add a product there when you install a new one on APLS.
• Broker does not report license expiration dates or license allocations, and does not upload usage history. Usage in OpenLM Platform starts when you configure the license manager.
• Denials are available only on APLS 24.3 or higher.
• Broker reads the current In Use report, not a log, so it sees only the checkouts that are open when the data inquiry runs. Broker can miss a checkout shorter than the watch interval.
• Multiple server redundancy is not available for OpenText AutoPass License Server.