IBM Support

Rational License Key Server Administration and Reporting Tool (ART) and Administration Agent Refresh Pack 6 (8.1.5.6) for Version 8.1.5

Download


Abstract

Refresh Pack 6 for Version 8.1.5 has been made generally available and contains improvements/enhancements to version 8.1.5.

Download Description

Table of Contents
Sections Description

The Change history section provides an overview on what is new in this release with a description of any new functions or enhancements when applicable.

The How critical is this fix section provides information related to the impact of this release to allow you to assess how your environment may be affected.

The Prerequisites section provides important information to review prior to the installation of this release.

The Download package section provides the direct link to obtain the download package for installation in your environment.

The Installation instructions section provides the installation instructions necessary to apply this release into your environment.

The Known side effects section contains a list of known issues identified at the time of this release.

The Deprecated items section contains a list of items that are not valid or supported in this release.

Supporting Documentation
Document Description

Click to review the detailed system requirements information for a complete list of hardware requirements, supported operating systems, prerequisites and optional supported software, with component-level details and operating system restrictions.

IBM Knowledge Center provides an entry point to product documentation. You can view, browse, and search online information related to the product.

Click to review a complete list of the defects (APARs) resolved in this release including a list of resolved defects for the entire version family.

For fixes for security vulnerabilities, see Security Bulletin.

Prerequisites

Attention: Rational License Key Server Administration and Reporting Tool (ART) and IBM Rational License Key Server Administration Agent MUST BE CONFIGURED according to the following hardware and software specifications. Otherwise, failure may occur during license administration and usage reporting.

Prerequisites include:

Version of IBM Installation Manager required: IBM Installation Manager 1.8.9.

Additional notes: Upgrade the agent and ART to version 8.1.5.6. to obtain the RFE and improvements that are included in this release.

Important: If you are upgrading ART from version 8.1.5 or later to 8.1.5.6, you must upgrade the ART component first, before you upgrade the agent.

If you are currently using ART version 8.1.4.9, you can upgrade to version 8.1.5.6 directly. But, if you want the existing data to be migrated, you must upgrade to 8.1.5.4 first and then upgrade to 8.1.5.6.

Data backup and upgrade

When you upgrade from version 8.1.4.9, the installer automatically creates a backup of your license usage data. However, if you prefer to create your own backup, copy this directory: RLKSAdmin/server/conf/lqe.

Hardware requirements

Rational License Key Server Administration and Reporting Tool

  • Memory: 16 GB RAM
  • Disk space: 100 GB

Rational License Key Server Administration Agent

  • Memory: 8 GB RAM
  • Disk space: 50 GB

Software requirements

Web browser requirement for Rational License Key Server Administration and Reporting Tool

  • Mozilla Firefox: 10 ESR and future fix packs
  • Internet Explorer: Version 11
    Important: Switch to Standard View by clicking Tools > Developer tools to work with ART. Internet Explorer does not render ART properly in Compatibility View.

Rational License Key Server Administration and Reporting Tool

  • Rational License Key Server: version 8.1.4 or 8.1.5
  • Jazz team server version 5.0 and later
  • Operating systems: ONLY 64-BIT OPERATING SYSTEMS ARE SUPPORTED

Rational License Key Server Administration Agent

  • Installation prerequisite: The Server Administration Agent MUST BE COLLOCATED with the license server.
  • Operating Systems: All operating systems supported by Rational License Key Server (version 8.1.4 and later versions) and the IBM solution for Collaborative Lifecycle Management (version 5.0 and later versions) server.

Other

Special characters supported by reports

  • For a list of special characters that are supported by reports in ART, see the technical document.

Back to top

Installation Instructions

Before you proceed with the installation of the Rational License Key Server for 8.1.5.6, ensure that you have met all prerequisites.

Instructions for installing the Rational License Key Server Agent
----------------------------------------------------------------------------------------------------------

  1. Download the IBM_RLKS_Administration_And_Reporting_Agent_8156.zip media file from the IBM Fix Central.
  2. Create a temporary directory (for example, ../agent-installer/8156/) and extract the downloaded zip file into this directory.
  3. Complete one of these steps:
    • Install the Installation Manager Version 1.8.6 or later if it is not installed.
    • Update the Installation Manager if the installed version is Installation Manager V1.8.5 or earlier.

       The Installation Manager restarts after completing the installation process.

  4. Open the Installation Manager, add extracted location of downloaded media file, File > Preferences > Repositories, and click Ok.

  5. From the main Installation Manager window, click Install.

  6. In Install Packages window, select the Rational License Key Server Administration Agent > Version 8.1.5.6 package and click Next.
  7. Accept the license agreement and click Next.
  8. Select Create a new package group to create a package group to install the agent into and click Next.

    The agent is supported on 32-bit and 64-bit computers. By default, the package is installed in this directory location:

    • Windows: C:\Program Files\IBM\RCL\RLKSAdminAgent
    • UNIX: /opt/IBM/RCL/RLKSAdminAgent

    Note: Because multiple installations of the agent can be installed on one machine, the installer installs each agent with a profile name that reflects the order of its installation. For example, if two agents are installed on one machine, the profile name of the first agent installation is IBM RLKS Administration Agent. The profile name of the second agent installation is IBM RLKS Administration Agent_1.

  9. Select required languages to install the server administration agent package and click Next.
  10. Select IBM Rational License Key Server Administration Agent feature to proceed with agent installation and click Next.

    Use the applicable table in Agent configuration to determine the server type, server location, license server log file, and license files.

    • Specify the port number that the agent will run on. You must install an agent for each license server on the computer. If you select a port number that is already in use, Installation Manager alerts you with an error message. If you receive this error, select another port number.
    • Select the license server type:
      • Rational License Key Server
      • CLM server - Floating licenses
      • CLM server - Authorized user licenses
    • Perform one of the following actions:
      • Windows with License server type selected as RLKS:Select a Windows service name from the list of the Rational License Key Server license server services that are installed on the machine. Selecting a service displays the corresponding location of RLKS, location of the lmgrd.log file, and location of license files as read only information. If you do not want to use this service, or if you want to manually provide user input, from the list, select --Configure manually--.
      • For platforms other than Windows, with License server type selected as RLKS:Select a Rational License Key Server installation location from the list of servers that are installed on the machine. Selecting an installation location populates these corresponding input fields: Location of RLKS, Location of the lmgrd.log file, and location of license files.
    • If you are not using the pre-populated values, you must enter the location of the Rational License Key Server (lmgrd application) that you want to administer with the Rational License Key Server Administration and Reporting Tool. You can either browse for the license server location or enter the location. By default, Rational License Key Server is installed in one of these directories:
      • Windows: C:\Program Files\IBM\RationalRLKS\common
      • Linux:/opt/IBM/RationalRLKS/bin
    • If you are not using the pre-populated values, you must enter the location of the license server log file. The agent uses the log file to gather license usage data. The reporting tool uses the log files to generate reports. You can either browse for the license server log file or enter the location.
    • Specify the license key file that is configured with the selected Rational License Key Server. You can select multiple files. For Windows operating systems, separate multiple license files with semicolons (;). For Linux operating systems, separate the names with colons (:).
  11. Click Next.
  12. Review the installation summary and then click Install. A summary list of installed packages displays.
  13. Once installation process completes, click Finish to close the Installation Manager.
  14. Select IBM Rational License Key Server Administration Agent to start the application. The agent is installed by default as a Windows service and can be configured as a service on UNIX platforms. If you select None in this step, you can start the application manually as a Windows or UNIX service. See Starting Rational License Key Server Administration and Reporting Tool on system startup.

Instructions for upgrading the Rational License Key Server Agent
----------------------------------------------------------------------------------------------------------

  1. From IBM Fix Central, download the IBM_RLKS_Administration_And_Reporting_Agent_8156.zip media files.
  2. Create a temporary directory (for example, ../8156) and extract the downloaded zip into this directory.
  3. Launch Installation Manager in wizard.
  4. In Installation Manager, click File->Preferences->Repositories and add location of the 8156\RLKS_ADMIN_AGENT\disk1\diskTag.inf file in the extracted directory of downloaded media file.
  5. Click Apply and OK.
  6. From the main Installation Manager window, Click Update.
  7. Select the package group Rational License Key Server Administration Agent that you want to update.
  8. Click Next.
  9. Select the refresh pack Version 8.1.5.6 that you want to update and click Next.
  10. Accept the license agreement, and proceed further to complete the update.

Instructions for installing the Rational License Key Server Administration and Reporting Tool
----------------------------------------------------------------------------------------------------------

   The Installation Manager restarts after completing the installation process.

  1. Download the IBM_RLKS_Administration_And_Reporting_Tool_8156.zip media file from the IBM Fix Central.
  2. Create a temporary directory (for example, ../ART-installer/8156/) and extract the downloaded zip file into this directory.
  3. Complete one of these steps:
    • Install the Installation Manager Version 1.8.6 or later if it is not installed.
    • Update the Installation Manager if the installed version is Installation Manager V1.8.5 or earlier.

  5. Open the Installation Manager, add extracted location of downloaded media file, File > Preferences > Repositories, and click Ok.

  6. From the main Installation Manager window, click Install.

  7. In Install Packages window, select the Rational License Key Server Administration and Reporting Tool > Version 8.1.5.6 package and click Next.
  8. Accept the license agreement and click Next.
  9. Select Create a new package group to create a package group to install the reporting tool into and click Next.

    The reporting tool is supported on 32-bit and 64-bit computers. By default, the package is installed in this directory location:

    • Windows: C:\Program Files\IBM\RCL\RLKSAdmin
    • UNIX: /opt/IBM/RCL/RLKSAdmin

    Note: Rational License Key Server Administration and Reporting Tool and IBM Rational License Key Server Administration Agent cannot be installed in the same directory.

  10. Select required languages to install the server administration reporting tool package and click Next.
  11. Select Rational License Key Server Administration and Reporting Tool feature to proceed with reporting tool installation and click Next.

  12. Review the installation summary and then click Install. A summary list of installed packages displays.

  13. Once installation process completes, click Finish to close the Installation Manager.
  14. Select Rational License Key Server Administration and Reporting Tool to start the application. The reporting tool is installed by default as a Windows service and can be configured as a service on UNIX platforms. If you select None in this step, you can start the application manually as a Windows or UNIX service. See Starting Rational License Key Server Administration and Reporting Tool on system startup.

Instructions for upgrading the Rational License Key Server Administration and Reporting Tool

----------------------------------------------------------------------------------------------------------

  1. From IBM Fix Central, download the IBM_RLKS_Administration_And_Reporting_Tool_8156.zip media files.
  2. Create a temporary directory (for example, ../8156) and extract the downloaded zip into this directory.
  3. Launch Installation Manager in wizard.
  4. In Installation Manager, click File->Preferences->Repositories and add location of the 8156\RLKS_ADMIN\disk1\diskTag.inf file in the extracted directory of downloaded media file.
  5. Click Apply and OK.
  6. From the main Installation Manager window, Click Update.
  7. Select the package group Rational License Key Server Administration and Reporting Tool that you want to update.
  8. Click Next.
  9. Select the refresh pack Version 8.1.5.6 that you want to update and click Next.
  10. Accept the license agreement, and proceed further to complete the update.

Back to top

Download Package

The following sections provide detailed information related to this release.

Click the FC link below to obtain the release from Fix Central.

How critical is this fix?

Impact Assessment
Impact Description

Corrective

This is a release of Rational License Key Server Administration Agent & Reporting Tool version 8.1.5.6. It contains critical fixes and enhancements to Rational License Key Server Administration and Reporting Tool and Administration Agent.

Test Results

Close [x]

Definitions

Regression: An error in the Maintenance Delivery Vehicle (MDV) that produces incorrect or unexpected behavior causing a supported feature to stop functioning as designed.
This includes:

  • Coding errors that cause a regression
  • Documentation or packaging problems that cause a regression
  • Errors reported in a new function delivered in a MDV that cause a regression

Incomplete: An error in the MDV has not regressed, but does not work as designed.
This includes:

  • Fixed APARs which did not solve the original problem but did not break anything new
  • APARs reporting documentation errors, such as readme errors, that cause problems applying an MDV but do not lead to a regression

Notes:
  • Regression and incomplete APARs are considered fix-in-error or MDV-in-error
  • Definitions above apply only to valid APARs that result in product fixes (APARs returned as working-as-designed are not assessed for being fix-in-error)
  • Issues in major releases due to new functionality do not apply in this definition

There are no known regressions to report.

Back to top

Problems Solved

Defects resolved

Click the Fix List link in the table of contents above to review a list of the problems solved in this release.

Known Side Effects

The following are known limitations in this release:
  1. On the Live Reports page, if a username contains multiple words, only the first word is displayed.
  2. On the Live Reports page, the CLM products usage records do not consider the Role information. The highest Token count among the Token counts for each Role of the respective products is displayed under the "Tokens per license" column.
  3. If there are more than a thousand check-outs at a license server and the Rational License Key Administration Agent is processing them as part of the Conversion cycle, the Live Reports page may not show any information. You can refresh the page after few minutes.
  4. If same license definitions are present in more than one license files and all these license files are being used by the license server, the quantity of license as shown in the License Details report may be more than the actual available quantity of license.
  5. When you start or stop the server from a redundant server triad and if the network connectivity is poor, the license server status and therefore the reporting operation might be incorrect.
  6. When you try to view the saved reports from V 8.1.5.3. or earlier in V 8.1.5.4, it fails to export the parameters.
  7. When you run a report after saving it on the create report definition page, the report definition name does not appear in the exported parameters file.
  8. In the Linux operating system, when you import the license and restart the license server, Rational License Key Server Administration and Reporting Tool displays the following error:

       Could not start license server.

    You must start the server manually after some time by clicking Actions > Start Server.

  9. For the scenarios with a charge back group where duplicate users have different cases. If you generate a group based charge back report with this group and the user name case sensitivity is Off, the information in the report for such duplicate users generates incorrectly.
  10. The Administration Agent fix for handling frequent license server restarts, does not handle the following scenarios:
    • Cannot correct the inaccuracies originating due to historical data.
    • If the license server is down for any reason while the hourly conversion occurs, the data generated is inaccurate.
  11. For "Rational Rhapsody Architect for Software" and "Rational Rhapsody Tool & Utilities" products, you may see a difference of token counts between the token value and the user based reports. Because of this difference the license hours in user based report cannot be matched with the product usage hours in the token value report.
  12. The data displayed in "License Hours" column for user based report and "Product Usage Hours" column for token value report for the same set of parameters may be inaccurate. This inaccuracy arises when the products are CLMs and a user has re-attempted the login after a web session timeout.
  13.  Suppose a user exists in LDAP with an ID user1, Rational License Key Server Administration and Reporting Tool V8.1.4.9. is configured to work with this LDAP server. If the user logs in with some case-variant of the ID user1 e.g. User1 or USER1, you cannot retain the data that belongs to particular user when you are upgrading to Rational License Key Server Administration and Reporting Tool V8.1.5 or higher.

Open defects

Review the following list of open defects for Rational License Key Server on the IBM Support Portal.

Review technote 1461170: Open APARs for Rational products available on the Web for information on how to configure your MyNotifications subscription account and subscribe to the APARs you are interested in following.

Back to top

Change History

What's new
  • You can view the total number users who have used the products through a new metric called User Count. This metric represents the total number of users who have used the products on a specific date and day for selected duration.

    Important:

    • The User Count metric is applicable for the products that use token-based licenses.
  • Enhanced Live Reporting functionality to cover the user roles while using CLM applications. Another improvement is to display token deployment details even if there are no active check-outs.
  • The chargeback groups created using LDAP users can now work with entities of custom class objects in addition to traditional class objects like "person".
  • The Windows services entries now have a self-explanatory description.

Here is a list of Knowledge Center topics created/updated for 8.1.5.6 version:

Back to top

Deprecated items
  • The ART/Agent are no longer supported on any HP and Solaris operating systems. The supported platforms are Windows, Linux and AIX.

Back to top

On
[{"DNLabel":"Rational Common Licensing 8.1.5.6 Refresh Pack","DNDate":"19 Dec 2018","DNLang":"English","DNSize":"1","DNPlat":{"label":"Windows","code":"PF033"},"DNURL":"http://www.ibm.com/support/fixcentral/swg/quickorder?parent=ibm%7ERational&product=ibm/Rational/Rational+Common+Licensing&release=All&platform=All&function=all&source=fc","DNURL_FTP":"","DDURL":null}]
[{"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"SSTMW6","label":"Rational License Key Server"},"Component":"Rational License Key Server Administration and Reporting Tool","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"8.1.5.6","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
12 June 2019

UID

ibm10740393

Page Feedback