SLM tag generation in License Key Server Administration and Reporting Tool version 8.1.6

In License Key Server Administration and Reporting Tool version 8.1.6, you can generate Software License Metric (SLM) tags for license usage. The following information explains the License Key Server Administration and Reporting Tool and IBM License Metric Tool integration.

Overview of SLM tag generation

License Key Server Administration and Reporting Tool version 8.1.6 can generate Software License Metric (SLM) tags. The tool generates information for a set of metrics that belongs to a specific set of products. The SLM tag data adheres to a standard ISO format and uses metrics that are authorized by IBM License Metric Tool. Using this feature, License Key Server Administration and Reporting Tool allows IBM License Metric Tool to establish a connection between FlexPoints-based IBM Cloud DevOps Offerings and floating licenses that are served by the License Key Server.

SLM tags

An SLM tag file has a .slmtag file name extension. The file is an XML document that provides a standard format for products to report license metrics (resources that are related to the use of the software asset) consumption. For more information about SLM tags, see SLM tags.

IBM License Metric Tool

IBM License Metric Tool is a product that identifies which software assets you have installed and their license usage. The tool has a readiness process that enables an IBM product for automated inventory detection and license consumption counting. IBM License Metric Tool provides a simple way to track IBM software that you are using. Each software product must enable racking with IBM by using a readiness process. For more information about IBM License Metric Tool, see IBM License Metric Tool 9.2.

FlexPoints

The IBM Cloud Integration offering is delivered under a new consumption model, FlexPoints, that changes the way you can use and deploy the software. This new offering helps simplify planning for the adoption and growth of critical, IBM enterprise products.

Relation between FlexPoints and floating licenses

In License Key Server Administration and Reporting Tool version 8.1.6, you can use SLM tag generation for license usage only for floating licenses that are served by License Key Server. This relation is defined as a mapping of fixed and pre-defined values from either sides. Example:

1 RLKS license for product Rational Functional Tester Floating = 16170 FlexPoint

FlexPoints usage reporting

License Key Server Administration and Reporting Tool version 8.1.6 generates SLM tags for products that are included in the FlexPoint model. Then, IBM License Metric Tool processes these SLM tags to convert the information into equivalent FlexPoint details.

SLM tag generation in License Key Server Administration and Reporting Tool version 8.1.6

License Key Server Administration and Reporting Tool version 8.1.6 generates SLM tags for floating licenses deployment and usage activities. These tags are classified in the following metrics that are recognized by IBM License Metric Tool:

License deployment
The metric generates SLM tags with a metric type value with the name of the IBM License Metric Tool metric that corresponds to the floating license deployed on the license server. These tags show the quantity of the floating license that are currently deployed on the license server. You can check out only those many number of licenses on the server.
Peak of concurrent users
The metric generates SLM tags with a metric type value with PEAK_ prefixed to the name of the IBM License Metric Tool metric that corresponds to the floating license deployed on a license server.

Example: PEAK_FLOATING_USER_SINGLE_INSTALL

These tags show the maximum number of check-outs for a license at a given point of time on a license server.
Total usage by all users
The metric generates SLM tags with a metric type value with ACTUAL_ prefixed to the name of the IBM License Metric Tool metric that corresponds to the floating license deployed on a license server.

Example: ACTUAL_FLOATING_USER_SINGLE_INSTALL

These tags show the total of number of license hours for which a product is used by all users for a specific duration on a license server.

Remember: License Key Server Administration and Reporting Tool version 8.1.6 does not generate SLM tags for token-based and authorized user licenses.

Product coverage

Previously License Key Server Administration and Reporting Tool version 8.1.5.5 was able to generate SLM tags only for a subset of the products that are part of the FlexPoint DevOps bundle. The products are as follows:

IBM® Rational® Functional Tester
IBM Rational Performance Tester
IBM Rational ClearCase®
IBM Rational ClearQuest®
IBM Rational ClearCase MultiSite®
IBM Rational ClearQuest MultiSite

Starting from version 8.1.6, License Key Server Administration and Reporting Tool generates SLM tags for additional products and that are as follows:

Application Developer for WebSphere
IBM Rational Software Architect for WebSphere® Software
IBM Rational Test Virtualization Server
UrbanCode Managed Virtual Server
UrbanCode Session Per Simultaneous Session
UrbanCode Virtual Server
IBM UrbanCode Release

The following table shows the mapping between License Key Server Administration and Reporting Tool and ILMT product names:

License Key Server Administration and Reporting Tool product names	ILMT product names
Application Developer for WebSphere	IBM Rational Application Developer for WebSphere Software
ClearCase	IBM Rational ClearCase
ClearCase MultiSite	IBM Rational ClearCase MultiSite
ClearQuest	IBM Rational ClearQuest
ClearQuest MultiSite	IBM Rational ClearQuest MultiSite
Functional Tester	IBM Rational Functional Tester
Performance Tester	IBM Rational Performance Tester
Software Architect for WebSphere	IBM Rational Software Architect Designer for WebSphere Software
Test 1000 Virtual Tester Pack	IBM Rational Performance Test Pack Virtual Testers
Test 10000 Virtual Tester Pack	IBM Rational Performance Test Pack Virtual Testers
Test 500 Virtual Tester Pack	IBM Rational Performance Test Pack Virtual Testers
Test 5000 Virtual Tester Pack	IBM Rational Performance Test Pack Virtual Testers
Test Virtualization Server	IBM Rational Test Virtualization Server
UrbanCode Managed Virtual Server	IBM UrbanCode Deploy Server Agent
UrbanCode Release	IBM UrbanCode Release
UrbanCode Release Authorized	IBM UrbanCode Release
UrbanCode Session Per Simultaneous Session	IBM UrbanCode Deploy Session
UrbanCode Velocity	IBM UrbanCode Velocity User
UrbanCode Virtual Server	IBM UrbanCode Deploy Server Agent

IBM License Metric Tool picking tag files

IBM License Metric Tool scans for a special directory inside the License Key Server Administration and Reporting Tool installation and picks up the tag files when they are generated.

The default location for the tag files is <ART Installation Directory>\work\rcladmin\logs\slm.
To override the default tag file location, you must modify the license.metric.logger.output.dir key in the ILMTTagConfiguration.properties file available at <ART Installation Directory>\servers\rcladmin\conf\rcladmin location.
When you uninstall License Key Server Administration and Reporting Tool, the work folder is deleted. In order to retain the tag files, you must backup the slm folder before uninstalling the License Key Server Administration and Reporting Tool.

Scheduled report definition

A report definition is a logical bundle of parameters that defines a report. You can create a report definition that defines the nature of the report by using the License Key Server Administration and Reporting Tool interface. Then, you can generate the report manually by running the report definition from License Key Server Administration and Reporting Tool whenever required. For details about report definitions, see Creating a report definition

A scheduled report definition adds automation capability to a report definition. You can automatically generate a report at a specific time interval by using the License Key Server Administration and Reporting Tool report scheduler. For details about scheduled report definition, see Scheduling and viewing reports and Scheduled report definition details.

For FlexPoints DevOps bundle users

If you are using any product that is a part of the FlexPoint DevOps bundle, you must complete the following one-time procedure. License Key Server Administration and Reporting Tool cannot generate SLM tags for these products unless you complete this procedure.

Install the License Key Server Administration and Reporting Tool on the machine that can communicate with the License Key Server Administration Agent. For instructions, see Installing version 8.1.6 of the License Key Server Administration and Reporting Tool.
Install the IBM Db2® Advanced Workgroup Server edition on the machine which can communicate with License Key Server Administration and Reporting Tool. For instructions, see Installing Db2 silently for License Key Server Administration and Reporting Tool on Windows.
Create the required database after the database is installed. For instructions, see Configuring the Db2 database.
Start License Key Server Administration and Reporting Tool and configure it to use the database installed earlier. For instructions, see Configuring a secure communication to Db2 with License Key Server Administration and Reporting Tool.
Start the License Key Server Administration Agent and add it to License Key Server Administration and Reporting Tool. For instructions, see Upgrading License Key Server Administration Agent to version 8.1.6.
After you finish adding the agent in License Key Server Administration and Reporting Tool, select the Start Reporting option from the list.
Wait for 5-10 minutes and create the scheduled report definition.

Mapping between License Key Server Administration and Reporting Tool and ILMT metrics

The following table shows the mapping between License Key Server Administration and Reporting Tool and ILMT metrics:

License Key Server Administration and Reporting Tool metrics	ILMT metrics
License Details	`ILMT Metric Name`
Concurrent Peak Usage	PEAK_`ILMT Metric Name`
User Based	ACTUAL_`ILMT Metric Name`

Feedback