What is the IBM Rational ClearQuest Licensing Model?
These topics explain the various components of the ClearQuest Licensing Model.
License Policy for ClearQuest
ClearQuest can uses two types of licenses.
- Node locked License: ClearQuest is available with a node locked license, which allows a user to use all of the Microsoft® Windows® / UNIX® and Linux® Clients and ClearQuest Designer components of the product from a single assigned workstation. The user can invoke multiple copies of ClearQuest on the same workstation without the need for additional licenses.
- Floating License: ClearQuest is also available with a floating license, which allows for any single user, on a single workstation, on a network to use all of the Windows/UNIX/Linux Client and Designer components of the product. This license may also be used to allow full Web Client access via the web. Only one user at a time may use this license and at no time may more than the total number of floating licenses be used at any one time. These licenses may be used on any supported workstations in the network. The user can invoke multiple copies of the Client or Designer, but not the Web Client, on the same workstation without the need for additional licenses.
In any configuration of ClearQuest, the administrator may set up a limited access web site that allows the submission of change requests and the use of a single, administrator-defined query by any user who has access via the Internet or intranet. This limited web access, termed Restricted Query Access, does not require a license.
There are two license types that are used internally for enforcement of the licensing policy.
- Nodelock license: a license that is assigned to a single workstation. This license type is issued to a single machine's Host Name/Host ID combination (no license server needed).
- Floating license: a concurrent user license that can be checked out from the license server by a single user, on a single workstation, at any location. This license type is enforced with FlexLM license technology and requires a FlexLM license server.
ClearQuest Web Entry Interface
Full web access is available when the user(s) check out a floating license to use with their session. Restricted Query Access is available for use via the Web without checking out a license. This allows users to submit defects and perform a single, administrator-defined query.
NOTE: Rational ClearQuest Web server will not work with a node locked license. It requires a floating license and license server for unrestricted operation.
How License Keys Are Used / Checked Out
This can be set using the License Usage Mapper in the Rational License Key Administrator. (See solution 1131254 on how to use the License Usage Mapper).
Web Entry Clients
It is a feature of ClearQuest that limited access via the web may be granted based on the login ID.
The determination of granting limited access can be done based on:
- Web site
- Group that the User is in
The timing of the returning of licenses differs somewhat by type of license and client being used.
Node-lock licenses are only available for the desktop that they are installed on, and are always available on that desktop.
A floating license will time out at the FlexLM license server after a sufficiently long period, if the server does not hear a heartbeat from the from the client. The default time-out value is 120 minutes. This is the "license timeout interval". ClearQuest clients send periodic "heartbeat" signals to the license server as long as the user is actively using the client. If no heartbeat signal is received during the timeout interval, the Rational License server will release the license to the available pool fro another client to use. If this happens and the user then performs another ClearQuest operation, the client automatically makes three attempts (once every 10 minutes) to re-acquire a new license from the license server. If this fails, an exception is raised saying that no license is available.
In addition, the web client and the Eclipse client have "session timeout intervals." A session timeout interval causes the client to automatically log out the user if there is no activity for this period of time. When the user is automatically logged out, the license is released just as if the user had manually logged out. The native Windows client does not have a session timeout interval, so it releases licenses only when the user manually logs out.
In the 2003.06.13 release and later, the default web session timeout interval is 30 minutes. This is a site configuration parameter that an administrator can change. In the 2003.06.12 release and earlier, the default timeout period of 20 minutes could be changed using the IIS console.
Keys for floating licenses that are used by any ClearQuest clients are returned (checked back in) to the FlexLM license server under three circumstances:
- When the user logs out from the client.
- When client session times out (if applicable for this client).
- When the license times-out after the default 120 minutes.
If a user brings up a form to be filled in and then submitted, ClearQuest keeps the license alive for up to 4 hours so that the license will be available when the form is submitted, even if this takes longer than the minimum license timeout interval. This prevents manual work from being lost if the user takes longer than that to complete the operation due to unexpected interruptions.
Restricted Query Access clients are not licensed, so no keys are checked out or returned.
In all cases, returned license keys are immediately available for use by the same or another user.
Note: Prior to the 18.104.22.168-iFix01, 22.214.171.124-iFix01, and 7.1.1 releases, a floating license could time-out, and ClearQuest might not reclaim it immediately, which could allow the client to continue to a point without consuming a license. This occurrence would free this license to be used by a separate client, potentially allowing for more concurrent users than total available licenses should allow for. This issue was identified as a product defect under APAR PK32588.
License usage for Integrations
Rational ClearQuest supports integrations with several Rational products including IBM Rational ClearCase® UCM, Visual Source Safe, Robot, and IBM RequisitePro®. These integrations are required to go through a ClearQuest integration server, called cqintsrv. The use of cqintsrv requires a ClearQuest license on the desktop where it is launched, typically a Windows client box. Starting in ClearQuest 2002, the integration server has a default time out of 20 minutes. Holding on to the license during this interval improves performance. Consequently, the integration server returns the ClearQuest license after 20 minutes of idle time. This timeout value cannot be configured.
The Base ClearCase/ClearQuest V2 Integration, does not use the ClearQuest integration server. Instead, administrators can configure the V2 integration to use either the ClearQuest PERL API or ClearQuest Web Java (versions 2003.06.13 and later) or ClearQuest ASP (versions 2003.06.12 and earlier) web protocol.
Base ClearCase/ClearQuest V2 Integration via Web
The integration will consume a ClearQuest license when performing integration activities if configured to use the ClearQuest Web Protocol. See Technote 1193472 for more information regarding how to configure the integration to use the Web.
Base ClearCase/ClearQuest V2 Integration via PERL API
PERL scripts that access ClearQuest will consume one license. Any scripts that run concurrently on the same machine, with the same operating system login will not require an additional license. See Technote 1142614 for more information regarding the Base ClearCase/ClearQuest V2 Integration.
License usage for the Rational E-Mail Reader
Rational ClearQuest provides a mail reader tool that allows customers to submit and modify records by sending an email to the tool. The mail reader tool checks emails sent to a predefined account and processes them accordingly. As such, the mail reader tool must be running at all times.
While the mail reader tool is running, it remains logged in to ClearQuest and requires a license to operate. It is subject to loss of functionality if it uses a floating license. This could happen if the license times out on the server and no additional licenses are available. It might be wise to use a node locked license if the mail reader service is critical to your ClearQuest deployment.
For more information on time-outs in ClearQuest, see the following topics in the ClearQuest Information Center: