License Metrics Calculation column in the above table mentions the calculation for the Authorized Users for the products with Charged Unit as User Value Unit or UVU .

SLM Tags & ILMT Tool reports display these Authorized Users Count for those products.

Users / Auditors must then determine the User Value Unit from the Authorized User count as below:

Once the number of Authorized Users is determined, the UVU can be determined from the Conversion Tables mentioned in the license file (li_language) that is present in the Atlas Installation folder.            

Table of Products and Component Parameters

Following table specifies the configuration of the component parameters in PolicyAtlas. If the component parameter is “No component check”, this implies that component parameter configuration will NOT be checked while reporting the license metrics.

If a component parameter is specified, then the license metrics will be captured in the SLM Tag file, ONLY if the Policy Atlas has the component parameter configured appropriately as mentioned in the table below: 

SLM Tags Concept

SLM Tags (Software License Metrics Tags) are XML files that contain the Product License Metrics reported periodically by the product.

IBM Atlas Fix Pack 6.0.3.8 has implemented the SLM Tags functionality. This enables the Atlas product to report its usage or License Metrics as defined in the Product & Metrics table above, in to an SLM Tag file.

Sample SLM Tag file generated for the product IBM Atlas eDiscovery Process Management Authorized:

<SchemaVersion>2.1.1</SchemaVersion>

<SoftwareIdentity>

                <PersistentId>c63aabc3a98d4ceab1ddfd443d81d53b</PersistentId>

                <Name>IBM Atlas eDiscovery Process Management Authorized</Name>

                <InstanceId>/ibm/slm/PA</InstanceId>

</SoftwareIdentity>

<Metric logTime="2019-09-04T05:02:25-07:00">

                <Type>USER_VALUE_UNIT</Type>

                <SubType></SubType>

                <Value>120</Value>

                <Period>

                                <StartTime>2019-09-03T04:39:59-07:00</StartTime>

                                <EndTime>2019-09-04T05:02:25-07:00</EndTime>

                </Period>

</Metric>

 Note that in the above example, the count of 120 is the number of Authorized Users. Using this count, user will need to look up in the User Value Unit Conversion Table from the license file.

Atlas-SLM Implementation 

Atlas generates SLM Tags periodically (daily by default). Configuration of the SLM functionality needs to be done in the properties file. Once configured, Atlas will log the License metrics based on the tables mentioned above, into the XML based SLM Tag files.

Following are the mandatory properties in the PolicyAtlas.properties. If the following mandatory properties are not specified, Atlas will NOT log the metrics in the slmtag file.

ENABLE_SLMTAG_METRICS_LOGGER – This property is set to TRUE by default to enable SLM tag logging

INSTANCE_PATH – To set path name where the PolicyAtlas is installed and deployed.

HOSTNAME – To set host name or IP address where PolicyAtlas is installed and deployed.

LOGGER_FILE_SIZE – To set the maximum size of slmtag file. If a specified value is beyond the scope, then the default value will be used.

LOGGER_FILE_NUMBER – To set the maximum number of slmtag file for one software identity instance. If a specified value is beyond the scope, then the default value will be used.

Other properties

LOGGER_OUTPUT_DIRECTORY – Provide the fully qualified path to the output directory directory for SLM tag files.

If the value is not specified, default path is used -

on Windows: %ProgramFiles%\ibm\common\slm

on Unix         : /var/ibm/common/slm

 LOGGER_FREQUENCY – To set the frequency with which the metrics would be logged in the SLM tag file. Provide the value in number for Logger_frequency. Default - 24 hours.

LOGGER_FREQUENCY_UNIT - Mention MINUTES, HOURS or DAYS in logger_frequency_unit for logger frequency.

Refer to the Appendix section for the details of the SLM related properties in PolicyAtlas.properties.  

Integration with IBM License Metrics Tool 

Versions of IBM License Metric Tool (ILMT) that support IBM Software License Metric Tag (SLMT) can generate license consumption reports. An ILMT agent can scan in configurable intervals the file system for. slmtag files, collect information, and send it to the corresponding ILMT server.

By default, these files are stored in the following location where PolicyAtlas is installed:

on Windows: %ProgramFiles%\ibm\common\slm

on Unix         : /var/ibm/common/slm

 ILMT reports the Authorized Users or number of Connections as per the table of Products & Metrics above.

For the products that have the Charged Unit as User Value Unit (UVU), the users will need to map the value reported by ILMT tool to the appropriate User Value Unit as per the License Conversion table specified in the License File (li_languagecode) file that comes with the Atlas installation.

ILMT Reports

For more information about using reports from IBM License Metric Tool for SLM Tags (e.g. Resource Utilization, All IBM Metrics ,Software Classification) , see the IBM License Metric Tool documentation.

Important

Logging frequency specified in the properties should not be less than 24 Hours

LOGGER_FREQUENCY=24

LOGGER_FREQUENCY_UNIT=HOURS

Specifying the frequency less than 24 HOURS i.e. less than a day duration will lead to inaccurate reporting of the metrics, as ILMT will attempt to aggregate all the metrics counted in one day.

This would not be correct for the Atlas License metrics. 

Appendix          

SLM Properties in the PolicyAtlas.properties

 #Instance path - provide the pathname where the software identity is installed - mandatory property

#Example: /ibm/slm/POLICYATLAS

INSTANCE_PATH=

 #Provide the host name or IP address where the software identity is installed - mandatory property

HOSTNAME=

 # The maximum size of slmtag file - mandatory property

# Unit: bytes

# Minimum value: 10240 (10kB)

# Maximum value: 1048576 (1MB)

# Default value: 102400 (100kB)

# Note: If a specified value is beyond the scope, then the default value will be used.

LOGGER_FILE_SIZE=

# The maximum number of slmtag file for one software identity instance - mandatory property

# Unit: number

# Minimum value: 1

# Maximum value: 100

# Default value: 10

# Note: If a specified value is beyond the scope, then the default value will be used.

LOGGER_FILE_NUMBER=

# Provide the fully qualified path to the output directory directory for SLM tag files.

# Unit: string (path)

# Example: C:\\Users\\ibm\\slm

# Notes: if the value is not specified, a default value is used:

#        on Windows: %ProgramFiles%\ibm\common\slm

#        on Unix:    /var/ibm/common/slm

LOGGER_OUTPUT_DIRECTORY=

#Provide frequency with which the metrics would be logged in the SLM tag file. Default - 24 hours.

#Provide the value in number for Logger_frequency and mention MINUTES, HOURS or DAYS in logger_frequency_unit

LOGGER_FREQUENCY=24

LOGGER_FREQUENCY_UNIT=HOURS

Notices, Copyright License and Trademarks

Notices

This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation

North Castle Drive

Armonk, NY 10504-1785

U.S.A.

For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION

"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,

INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Deutschland GmbH

Department M358

IBM-Allee 1

71139 Ehningen

Germany

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee.

The licensed program described in this information and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement or any equivalent agreement between us.

Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems.

Furthermore, some measurement may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subject to change without notice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject to change before the products described become available.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

Copyright License

This information contains sample application programs in source language, which illustrates programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs.

If you are viewing this information softcopy, the photographs and color illustrations may not appear.

Trademarks

IBM, the IBM logo, and ibm.com are trademarks of International Business Machines Corporation, registered in many jurisdictions worldwide. A current list of IBM trademarks is available on the web at "Copyright and trademark information" at http://www.ibm.com/legal/copytrade.shtml.

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other countries.

The Oracle Outside In Technology included herein is subject to a restricted use license and can only be used in conjunction with this application.

Other product and service names might be trademarks of IBM or other companies.