Tracking user-based licenses

If you are using user-based licensing, some setup is required, which includes setting values in a properties file.

Before you begin

The adapter software is installed.

About this task

To log information about each user, you set values in a properties file. Information is logged in to .csv files that are based on those properties. The .csv files are imported into a spreadsheet so you can view and monitor usage over time.

Procedure

  1. The location of the hpqm.license log files is determined by the log4j.properties file in the HPInstallDir/server/tomcat/webapps/hpqm/WEB-INF/classes directory. You can set these log4j.properties parameters:
    • log4j.appender.licenseappender.File=${hpqm.log4j.base}/hpqm.license.csv
    • log4j.appender.licenseappender.RollingPolicy.FileNamePattern=${hpqm.log4j.base}/hpqm.license-%d{yyyy-MM-dd}.csv
    • log4j.logger.com.ibm.oslc.qm.adapter.hpqc.license.DefaultHandler=INFO, licenseappender

    You can use a non-default location for the license files by changing ${hpqm.log4j.base} to the directory path that you want. You can also use a non-default file name by changing hpqm.license to another name. The current date pattern %d{yyyy-MM-dd} rotates the license files daily.

    Use this parameter to rotate monthly:

    %d{yyyy-MM}

    Use this parameter to rotate hourly:

    %d{yyyy-MM-dd-HH}

    If you want to disable logging of licensing activities, change the log level from INFO to OFF.

  2. View the results of one or more log files:
    1. Point your browser to https://fully qualified hostname:port/hpqm. Log in to the Rational® Adapter for HP ALM server. Use an account that has administrator privileges, if applicable.
    2. Click the help icon on any Rational Adapter for HP ALM page. Click About This Application.

      Location of About This Application on the adapter banner.

    3. In the User-based Licensing section, click Download Spreadsheet.

      Download spreadsheet from the About the Rational Adapter for HP ALM page

    4. When prompted, save the file UserLicensing.xltm to a local directory.
    5. Use Microsoft Excel to enable the user licensing macro that you downloaded and run that macro against your log file directory. Save the file with a name such as hp-users-june and a type of Excel Macro Enabled Workbook. Run the macro named UserLicensing and select your log file.

      Each .csv file is imported into the workbook as a separate worksheet. Each worksheet has the same name as the .csv file.

      Each spreadsheet provides this information:
      • Maximum and minimum active user licenses
      • Total users
      • Unique list of users

Results

You can track the number of users that are licensed to use the adapter and can view that information in a spreadsheet.

What to do next

Set up the application server that you chose during the installation process to run the adapter web application, see Setting up the application server.

Feedback