IBM License Metric Tool collector and reporter overview

The IBM® License Metric Tool IlmtCollector and IlmtReporter script files collect statistics that are related to user-based license metrics that are used in many Enterprise Content Management products, including Content Platform Engine V5.2.0.2 or later.

System Dashboard for Enterprise Content Management 5.0.0.3 relies on the presence of a suitable Java™ virtual machine (JVM) to run. System Dashboard uses information in the launch file to locate the JVM to use. The System Dashboard requires a JVM of version 1.8 or higher for correct operation.

Many enterprise content management products contain a listener that provides a network service. When the collector runs, it inserts the user history records that are collected from the listener and adds them to a Derby database. The user history records accumulate in the Derby database. By using the IlmtReporter script file, you can run a report that is based on the data that is stored in the Derby database. The reporter can generate both CSV format files (for viewing by using a spreadsheet program), and IBM License Metric Tool slmtag files that are read by the IBM License Metric Tool agent.

Choose a single location to store the database and run the collector and reporter. For example you may choose to install the System Dashboard with the collector and reporter tools on the primary server that runs the enterprise content management product that you are monitoring. (In a clustered environment, the primary server is the first server to be installed.) Install the IBM License Metric Tool agent in the location you choose, and configure the tool to run against all servers in the cluster. For information about installing IBM License Metric Tool, see the installation instructions in IBM Knowledge Center.

To ensure all user names are reported in hashed format: If your Derby database contains data collected from older versions of your server software, the ILMT reports might show user names in clear text. To ensure all user names are reported in their hashed format, to address potential privacy concerns, archive the older Derby database and create a new database by running the ILMT collector. You might want to run a final IMLT report against the existing Derby database to save for future reference before you archive it. If a Derby database contains both old and new data, user names will appear in both clear text and as hashed values.

Note: Starting with V5.5.9, the IBM License Metric Tool reports can be configured to show user names in clear text or hashed format. For more information, see topic IBM System Dashboard for Enterprise Content Management Listener configuration.

To ensure all user names are reported in clear text: If your Derby database contains data collected from older versions of your server software, the ILMT reports might show user names in hashed format. To ensure all user names are reported in clear text, archive the older Derby database and create a new database by running the ILMT collector. You might want to run a final IMLT report against the existing Derby database to save for future reference before you archive it. If a Derby database contains both old and new data, user names will appear in both clear text and as hashed values.