Part 8: TM/LMS interface - License Management

The ThruPut Manager™ interface to Compuware's License Management System (LMS) runs in the TM address space as a subtask. The subtask is attached by TM at TM start-up time and remains active until TM is terminated.

LMS Runtime Environment

To achieve correct access to your Compuware TM product license information, you must establish a License Management System Runtime Subsystem for each operating system image upon which TM executes. This is a prerequisite and is not covered in this document. Refer to the License Management System, User/Reference Guide, z/OS Version manual for information.

Function of the TM License Management Interface

The TMLMSIF (TM License Management System Interface) program within module DTMLMSV7 has only one purpose. That is to ensure that TM is running with a currently valid Compuware License. If there is a valid license, then TM will just continue running.

TM/LMS Interface Module DTMLMSV7

The License check is performed by DTMLMSV7, a module which is attached during TM initialization by DTMINIT. The interface module LMSSTUB (which was provided by the LMS) is bound with the DTMLMSV7 module. LMSSTUB provides the linkage between TM and the LMS. The system that DTMLMSV7 runs on must have established a License Management System Runtime Subsystem and should also have a License File deployed that has a license for the TM system that is running.

How is the License Validated?

The License is validated by sending information to the LMS interface via LMCHKOUT and getting a reply and return code indicating the degree of success.

To be successful, the current License Key file must contain a license matching the credentials passed and the license retrieved must not be expired. The information identifying the license to LMCHKOUT is the 10-byte Product Name variable and the two byte product code.

IMPORTANT: The eight-byte version number must also match, at least in the initial offering. Our intent is to have the version number ignored. This is supposed to be done in LMS.

License Validation Processing

The License will be validated whenever TM is started, when the subtask DTMLMSV7 is attached by DTMINIT. The license is validated again every day at 12:00 noon. DTMLMSV7 remains active as long as TM is active. It will wait on a timer and then check the license again.

Every time that the TMLMS software checks the license (regardless of the outcome) the message DTM0051I is issued:

 - The 10-byte product name.

- The 2-byte product code.

The first step in processing is to check the current license (if it was obtained) back in using LMCHKIN. This step is skipped if there is no license checked out (the first time through, for example).

Next the LMS LMCHKOUT module is called to verify the credentials of the License. There are two possible results:

1.  If ThruPut Manager has a valid and up-to-date Compuware ThruPut Manager License the processing is simple:
   1. If there are any warnings the message "DTM0056I TM LICENSE CHECKOUT RETURNED RC=4 REASON=xxx" is issued along with any messages that are returned from the LMS system; for example, the License will expire in 14 days or less. xxx represents a reason code documented in the Enterprise Common Components Messages and Codes manual.
   2. ThruPut Manager is given control and allowed to continue normal processing.
   3. An informative message is issued indicating that license processing was successful: DTM0055I LICENSE VALIDATION SUCCESSFUL. TM PROCESSING CONTINUES
   4. Nothing else will occur until 12:00 (noon). At this time the License will be checked in and the License check process starts again from the beginning.
2. If a valid Compuware ThruPut Manager license cannot be verified:
   If for any reason, a valid Compuware TM license is not obtained, a 24-hour window is opened. The 24-hours is given to provide time to fix the problem. ThruPut Manager will run normally within the window. Every 30 minutes ThruPut Manager will reattempt to check out a valid license. If successful, the window is closed, and the timer is reset to zero. However, if still unsuccessful at the end of the 24-hour period, ThruPut Manager will be forced to shut down. If it is restarted, it will be shut down again immediately unless there is a valid license.

When an error is detected the following steps are taken:

Step 1

The message DTM0056I is always issued displaying the Return Code and the Reason Code from the License checkout routine (LMCHKOUT).

The return and reason codes are documented in Enterprise Common Components - Messages and Codes.

Step 2

There may be messages from the License Management component itself because of the LMCHKOUT call:

If the issue is with the license itself, there should be messages from the LMS component. These will explain the specific reason for the failure. For example:

WLM001I ****************************************************************
WLM002I *******                                                  *******
WLM003I *******        COMPUWARE CORPORATION                     *******
WLM004I *******         LICENSE MANAGEMENT                       *******
WLM005I *******        COPYRIGHT (C) 1998, 2017                  *******
WLM006I ******* BY COMPUWARE CORPORATION. ALL RIGHTS RESERVED.     *******
WLM007I *******                                                    *******
WLM553E ******* A REQUEST FOR AN INVALID PRODUCT HAS OCCURRED
WLM010I ******* TPMSXXXXXX 18.02
WLM011I *******
WLM025I ******* CUSTOMER AND SITE INFORMATION FOLLOWS:
WLM018I ******* COMPUWARE ONLINE LICENSING
WLM019I ******* CUSTOMER NUMBER: 171494
WLM020I ******* COMPUWARE ONLINE LICENSING - 171494-1
WLM021I ******* SITE NUMBER: 001
WLM011I *******
WLM026I ******* CURRENT ENVIRONMENTAL INFORMATION FOLLOWS:
WLM022I ******* CW.ECC.CPWR.LICENSE.KEY.FILE
WLM023I ******* SUBSYSTEM ID: TST1
WLM024I ******* CERTIFICATE ID:
WLM011I *******
WLM012I *******                                                   *******
WLM013I *******    COMPUWARE PRODUCT SUPPORT HOTLINE              *******
WLM014I *******    U.S. AND CANADA....1-800-538-7822              *******
WLM015I *******    ALL OTHER..........1-313-227-5444              *******
WLM016I *******                                                   *******
WLM017I *****************************************************************

If for any reason there are no messages returned from LMCHKOUT, the Return Code and Reason Code will pinpoint the problem.

If the error occurs before the License file has been checked, such as when the License Management System has not been started then there should be some LMSxxxxx type messages which are also documented in Enterprise Common Components Messages and Codes. For example:

Step 3

ThruPut Manager will issue messages depending on the nature of the license failure:

• Enterprise Common Components License Management System is not available:
  For the first occurrence the message is:
  DTM0052I License Verification delayed 5 minutes, LMS not yet active
  The assumption is that ThruPut Manager was started before LMS and a five-minute grace period is given to allow LMS to catch up. ThruPut Manager be allowed to run during the time. This is followed by a 5-minute timeout followed by a license check repeat.
  For subsequent occurrences the message will be:
  DTM0059E License Management Verification Failed - LMS Not Active
  This is followed by a 30-minute timeout followed by a license check repeat.

• There is no license for the requested product:
  DTM0058E 

  Unknown macro: confluence_display. Click on this message for details.

  The [confluence_display] macro is not in the list of registered macros. Verify the spelling or contact your administrator.

   LICENSE NOT FOUND.
  This is followed by a 30-minute timeout followed by a license check repeat.

• There is a License, but it is not valid:
  DTM0050E UNABLE TO VALIDATE COMPUWARE TM LICENSE.
  This is followed by a 30-minute timeout followed by a license check repeat.
• There was a severe error in response to LMCHKOUT call other then LMS not active:
  DTM0068E License Management Severe error RC=xx REASON=yy
  See the Enterprise Common Components Messages and Codes manual for the meanings of the return and reason code.
  This is followed by a 30-minute timeout followed by a license check repeat.
• LMCHKOUT does not respond to the call:
  This should never happen. It could only happen if LMCHKOUT logic was waiting for something that never occurs. If LMCHKOUT does not return to the TM License Interface program within one minute, then the following message is issued:
  DTM0057E LMCHKOUT (LMS) NOT RESPONDING. TM WILL BE ENABLED.

Step 4

The ThruPut Manager address space will be posted so ThruPut Manager can resume normal initialization and perform its functions.

The timer is checked to see if 24-hours has elapsed since the first time that a License validation check failed. If 24-hours has elapsed, then the TM Address Space is terminated after the following message is issued:

If the 24-hour period has not elapsed a new period of a maximum of 30 minutes is initiated with the following message:

*DTM0054E PLEASE RESOLVE ISSUE ASAP.
    TM WILL CONTINUE RUNNING
    TM LICENSE CHECK WILL RETRY IN 30 MINS.
    IF ISSUE NOT RESOLVED, TM WILL BE SHUT DOWN IN hh HRS, mm MIN

Where hh Hrs, mm Mins is the time remaining before the end of the 24-hour window.