IBM® System Dashboard for Enterprise Content Management contains several tools for collecting and reporting detailed usage metrics to help in the determination of license compliance. Previous versions contained the utilities FileNet P8 Usage Collector.exe and FileNet P8 Usage Reporter.exe. The Collector.exe and Reporter.exe utilities are renamed to usage_collector.bat and usage_reporter.bat (on UNIX systems, the "*.sh" is used instead of the "*.bat" scripts). If your system is Content Engine 4.5.x, you can still gather the peak usage statistics that were license metrics for Content Engine 4.5.x Software.
The new utilities are designed to collect statistics that are related to the User Value Unit (UVU) license metrics that are used in many Enterprise Content Management products, including Content Platform Engine version 5.2.0.2 or higher.
The basic design of the old tools and the new tools is similar. Many new Enterprise Content Management products contain a listener that provides a network service on port 32775 (typical). Run the IlmtCollector script file every day (use a Windows scheduled task, or a UNIX cron job, or something similar). When the collector runs, it inserts the user history records that are collected from the listener and adds them to a Derby database. You can configure the location of that database by using the collector command line. Since the collector runs every day, 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. Run the collector, database, and reporter on the primary server that runs the Enterprise Content Manager product that you are monitoring. Install and run the IBM License Metric Tool agent on the primary server. You can run the IlmtReporter script file as often as needed for whatever period you want to cover. However, to correctly compute the number of regular users and infrequent users for UVU type licenses, run the IlmtReporter script file to cover the previous 12 month period. For example, you can run the script file on the same day each year.
The IlmtCollector.bat or IlmtCollector.sh script is in the installation directory where you installed IBM System Dashboard for Enterprise Content Management 5.0.0.1. You can run a command-line utility manually, or you can schedule the utility to run daily by using any scheduling tool on your operating system (such as UNIX cron).
Run C:\Program Files (x86)\IBM\FileNet\Dashboard\IlmtCollector.bat -h to display the following output:
IlmtCollector -h
Usage: IlmtCollector OPTION CONFIG_FILE [ LISTENER_HOST LISTENER_PORT | PURGE_YEAR]
Where OPTION can be one of the following:
-u downloads user session history into database (removes the history data from the server)
-t tests connection to the database, host, port
-p deletes database history records older than date (yyyy)
-h help
Example: IlmtCollector -u IlmtReporter.conf localhost 32775
Example: IlmtCollector -t IlmtReporter.conf localhost 32775
Example: IlmtCollector -p IlmtReporter.conf 2013
IlmtCollector -u IlmtReporter.conf localhost 32775
When
you run the command in the preceding example, user history data is
collected from the server that is called localhost and
from port number 32775. Then, the collected data
is stored in the Derby database that is specified in the configuration
file. In the example above, the configuration file is named IlmtReporter.conf. Number of active users | Frequency to run the IlmtCollector script file |
---|---|
1 - 25,000 | Once every 24 hours |
25,001 - 50,000 | Once every 12 hours |
50,001 - 75,000 | Once every 8 hours |
75,001 - 100,000 | Once every 6 hours |
The IlmtReporter script file reads only data from the Derby database. It does not change or update it. Therefore, it is safe to run any time. Run the reporter at least one time each year to correctly report User Value Unit (UVU) data to the IBM License Metric Tool agent.
IlmtReporter -h
Usage: IlmtReporter CONFIG_FILE -s START_DATE -e END_DATE
Where:
CONFIG_FILE - is the location (path/name) of the IlmtReporter.conf file
START_DATE - is the starting date for the report (MM/DD/YYYY).
END_DATE - is the ending date for the report (MM/DD/YYYY).
(Note: if the path/name contains spaces, the parameter must be enclosed with double quotes)
For example:
IlmtReporter IlmtReporter.conf -s 01/01/2013 -e 12/31/2013
The usage data that the IlmtReporter script file requires to generate reports is in the database directory. Run backups on this directory on a regular schedule. It is also important to back up the IBM System Dashboard for Enterprise Content Management installation directory where any configuration files are kept. The current installation files, configuration files, and database directory are all required to fully restore an operational system if a disaster recovery is required.
Maintaining database integrity
The IlmtCollector and IlmtReporter script files use Derby for their internal database.
Maintaining database integrity