Generating license compliance reports

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.

About this task

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 IlmtReporter.bat (Windows) and IlmtReporter.sh (UNIX) script files are located in the installation directory where you installed IBM System Dashboard for Enterprise Content Management.

The IlmtReporter script file only reads data from the Derby database. It does not change or update data. Therefore, the script 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.

You can also use the IlmtReporter script file to generate a concurrent user report, concurrent_user_output.cs, in the output directory specified in the IlmtReporter configuration file. This report shows the peak concurrent usage for the period specified in the command line parameters. The report also shows the list of users that were using the system.

The syntax and the options for the IlmtCollector script are as follows:

Usage: IlmtReporter -f CONFIG_FILE -s START_DATE -e END_DATE
Where:
  -f CONFIG_FILE is the location (path and file name) of the IlmtReporter.conf file
  -s START_DATE is the starting date for the report (MM/DD/YYYY), inclusive.
  -e END_DATE is the ending date for the report (MM/DD/YYYY), inclusive.

Note: If the path or file name contains spaces, the parameter must be enclosed with double quotes.

Note: Include the -c option at the end of the command to generate a concurrent user report.

Procedure

To generate a license compliance report, open a command-line prompt and enter the command for your operating system:

Option	Description
UNIX	`installation_directory`/IlmtReporter.sh -f `configuration_file` -s `start_date` -e `end_date`
Windows	`installation_directory`\IlmtReporter.bat -f `configuration_file` -s `start_date` -e `end_date`

To generate a concurrent user report, open a command-line prompt and enter the command for your operating system:

Option	Description
UNIX	`installation_directory`/IlmtReporter.sh -f `configuration_file` -s `start_date` -e `end_date` -c
Windows	`installation_directory`\IlmtReporter.bat -f `configuration_file` -s `start_date` -e `end_date` -c

Example

The following Windows command reports user history data for the year of 2015. In the example, the configuration file is named IlmtReporter.conf and is located in the directory where the command is run.

IlmtReporter.bat -f IlmtReporter.conf -s 01/01/2015 -e 12/31/2015

The following Windows command reports concurrent user data for the year of 2015. In the example, the configuration file is named IlmtReporter.conf and is located in the directory where the command is run.

IlmtReporter.bat -f IlmtReporter.conf -s 01/01/2015 -e 12/31/2015 -c