Skip to main content
Version: 10.2

Reprise License Manager (RLM)

Introduction​

Open iT supports Reprise License Manager (RLM) usage reporting through the autoconfigurator by detecting configurations used to set the license manager data collection automatically. On the other hand, if you need to configure its behavior manually, the following sections will guide you on the required configuration for license manager utility polling and log file parsing.

warning

Apply the configurations shown in the Open iT Core Client.

Configuring License Manager Utility Polling​

Open iT polls the license servers at regular intervals to get the current status of its license use and availability.

An Open iT Core Client is installed on your license server for this collection. The data collector/preprocessor gathers the current license usage information from the license manager every hour using a 5-minute sample interval, triggering the data collection process. It also processes the gathered license usage. Once the data is preprocessed, it is transmitted to the Core Server, according to the client's timezone, for further storage, completing the license usage data collection and processing.

License Manager Utility Polling Workflow

License Manager Utility Polling Workflow

This will produce the following aggregated data types used for historical reporting:

The following sections will guide you in setting up the necessary configuration to collect and send the required data to the server.

Requirements​

Getting the License Status Utility Binary Location​

This configuration requires the path to the license status utility binary, rlmstat, to obtain the license status information. Get this by following these steps:

Through the Interface

  1. Open the Task Manager.
  2. Go to the Details tab.
  3. Locate rlmstat.
  4. Right-click and choose Open file location. The path of the binary will be displayed.

Through the Command Line

  1. Open a command prompt with Administrator level privileges.

  2. Run the following command to locate the binary:

    Command Syntax
    where /r <installation_drive> rlmstat

    where <installation_drive> is the drive where the license manager is installed.

    Example
    where /r C:\ rlmstat

    The path of the binary will be displayed.

After verifying the path of the polling program, make sure that it is running. Open a command prompt in the directory of the license server executable or the polling program and run the following command:

Command Syntax
rlmstat -a
Example
rlmstat -a

Make sure no errors are encountered.

Configuring Data Collection​

These are the required steps to activate and configure collection of RLM usage data.

  1. Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and back up the licpoll.xml configuration file.

  2. Open a command prompt with Administrator level privileges.

  3. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
    cd $BIN_DIR
    Example
    cd C:\Program Files\OpeniT\Core\bin

  4. Once in the directory, activate the collection of RLM data, run the command:

    Command Syntax
    openit_confinit -c "licpoll.license-types.rlm-sample.active=true"

  5. Set the RLM license file location, run the command:

    Command Syntax
    openit_confinit -c "licpoll.license-types.rlm-sample.license-file=<rlm-license-file>"

    where <rlm-license-file> is the filename, including the path, of the RLM license file.

    Example
    openit_confinit -c "licpoll.license-types.rlm-sample.license-file=C:\Program Files\rlm\license.lic"

  6. Set the path to the binary used by the RLM license server, run the command:

    Command Syntax
    openit_confinit -c "licpoll.license-types.rlm-sample.status-command=<binary_path>"

    where <binary_path> is the obtained path in Getting the License Status Utility Binary Path.

    Example
    openit_confinit -c "licpoll.license-types.rlm-sample.status-command=C:\rlm\bin\rlmstat"

  7. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Advanced Configuration

Refer to the RLM Data Collection Configuration table to learn more about RLM configuration in licpoll.xml.

Object NameAccepted ValueDescription
activeBoolean (true or false)Setting this to true activates RLM usage data collection.
typeString (i.e., RLM)The license manager type.
intervalTimespan (e.g., P30S, P5M, P1H)The span of time between each polling round (it is recommended to set a value no less than P1M).
offsetTimespan (e.g., P30S, P5M, P1H)The span of time the aligned poll time decided by interval is shifted.
license-fileFileName (e.g., C:\Program Files\rlm\license.lic)The filename, including the path, to the RLM license file. This file is provided by the vendor and is usually in the license manager installation directory.
license-file-dirDirName (i.e., <rlm-license-dir>)The path to the RLM license directory. Do not change this.
product-nameString (e.g., server;daemon)This object is defined if a vendor license name other than the default RLM=%server%;rlm will be used.
status-commandFileName (e.g., ${OpeniT.directories.bin}/rlmstat)The binary used to obtain status from the license manager.
status-command.argumentsString (i.e., -a)The arguments used for the status command.
RLM Data Collection Configuration

Verifying Data Collection​

After configuration, you can verify that the data is collected by following these steps:

  1. Open a command prompt with Administrator level privileges.

  2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
    cd $BIN_DIR
    Example
    cd C:\Program Files\OpeniT\Core\bin

  3. Run the command:

    Command Syntax
    openit_licpoll -# 1

  4. Verify that the temp directory, which is by default in C:\ProgramData\OpeniT\Data\temp, contains a LicPoll directory containing .data and status-*.log files.

note

Continue reading if you need to configure log file parsing. If not, here are some suggested readings.

Configuring Log File Parsing​

Open iT collects log files and converts them to Open iT format.

An Open iT Core Client is installed on your license server for this collection. The data collector monitors and gathers the license usage history logs from the license manager every 5 minutes. Once the logs are collected, the data collection process triggers and the logs are passed to the data preprocessor. After the data is preprocessed, it is transferred to the Core Server for further storage, completing the history logs collection and processing.

Log File Parsing Workflow

Log File Parsing Workflow

This will produce the following aggregated data types used for historical reporting:

Record Log Data:

Event Log Data:

The following sections will guide you in setting up the necessary configuration to collect and send the required data to the server.

Requirements​

  • An Open iT Core Client connected to an Open iT Core Server or a coexistent Open iT Core setup
  • License server administrative rights
  • Activated Report Log Functionality and the REPORTLOG location (For instructions, please see the REPORTLOG option under The ISV Options File chapter in the RLM manual.)

Configuring Log File Collection​

These are the required steps to configure collection of RLM log files.

  1. Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and back up the logfilecollector-rlm.xml file.

  2. Open a command prompt with Administrator level privileges.

  3. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
    cd $BIN_DIR
    Example
    cd C:\Program Files\OpeniT\Core\bin

  4. Once in the directory, set the location of the RLM log files, run the command:

    Command Syntax
    openit_confinit -c "logfilecollector-rlm.logfilecollector.source.dir=<rlm_log_dir>"

    where <rlm_log_dir> is the location of the RLM log files.

    Example
    openit_confinit -c "logfilecollector-rlm.logfilecollector.source.dir=C:\RLM\home\logs"
    Sample Log File Content
    RLM Report Log Format 0, version 12.3, authenticated
    ISV: cmgl, RLM version 12.3 BL3
    Logfile format Copyright (C) 2006-2017 Reprise Software, Inc.
    For documentation on this format, email info@reprisesoftware.com
    You are encouraged to build tools to process this data.

    START SERVER215551 06/09/2023 00:00:01
    TIMEZONE 0 0 # Coordinated Universal Time Coordinated Universal Time, 0 minutes west of UTC, daylight: 0
    LICENSE FILE E:\CMG\RLMSecure\cmgl.lic
    PRODUCT stars_super 2099.99 6 1200 0 1200 "" "" "" "" "" "" 0 0 0 0 0 0 0 0 0
    PRODUCT combinative 2021.10 13 500 0 500 "" "" "" "" "" "" 0 0 0 0 0 0 0 0 0
    PRODUCT combinative 2021.10 14 600 0 600 "" "" "" "" "" "" 0 0 0 0 0 0 0 0 0
    PRODUCT combinative 2021.10 15 700 0 700 "" "" "" "" "" "" 0 0 0 0 0 0 0 0 0
    INUSE stars_super 2099.99 6 8874lt sample2001 "1044a5b217114cb986756562f01c4b0e" 105 4dd 4dd 616ba 06/09 00:00:01
    INUSE stars_super 2099.99 6 8874lt sample2001 "1044a5b217114cb986756562f01c4b0e" 20 61c 61c 616ba 06/09 00:00:01
    INUSE stars_super 2099.99 6 pqgtzz8 sample024 "423106dc80b54fddbca42944020cf0e4" 20 242 242 da6f 06/09 00:00:01
    INUSE stars_super 2099.99 6 pqgtzz8 sample024 "423106dc80b54fddbca42944020cf0e4" 40 c2 c2 da6f 06/09 00:00:01
    INUSE combinative 2021.10 13 8874lt sample2001 "1044a5b217114cb986756562f01c4b0e" 20 3e6 3e6 616ba 06/09 00:00:01
    OUT stars_super 2020.11 6 atedja upstraz5pt89g4-l "GM 10D0B0 8 0" 20 540 0 25b 25b 8424 "" "" "" 06/09 00:00:01
    OUT stars_super 2020.11 6 atedja upstraz5pt89g4-l "GM 10D0B0 8 0" 40 580 0 91 91 8424 "" "" "" 06/09 00:00:01
    IN 1 stars_super 2020.11 atedja upstraz5pt89g4-l "GM 10D0B0 8 0" 20 560 0 25b 06/09 00:00:03
    IN 1 stars_super 2020.11 atedja upstraz5pt89g4-l "GM 10D0B0 8 0" 40 520 0 91 06/09 00:00:03
    IN 1 combinative 2021.10 8874lt sample2001 "1044a5b217114cb986756562f01c4b0e" 20 40 0 3e6 06/09 00:00:03
    06/09/2023 00:00
    REREAD automatic midnight 06/09 00:00:04
    PRODUCT stars_super 2099.99 6 400 0 400 "" "" "" "" "" "" 0 0 0 0 0 0 0 0 0
    PRODUCT combinative 2021.10 13 500 0 500 "" "" "" "" "" "" 0 0 0 0 0 0 0 0 0
    PRODUCT combinative 2021.10 14 600 0 600 "" "" "" "" "" "" 0 0 0 0 0 0 0 0 0
    PRODUCT combinative 2021.10 15 700 0 700 "" "" "" "" "" "" 0 0 0 0 0 0 0 0 0
    AUTH: 1 60pg453a40qa5y8gbe78dsgvursskg0494v09sg22m08kf0cnc2usucmpnn10s2a4pkrfxncsmhg
    06/09/2023 00:30
    IN 1 stars_super 2021.10 8874lt sample2001 "1044a5b217114cb986756562f01c4b0e" 20 595 0 61c 06/09 00:53:09
    IN 1 stars_super 2021.10 8874lt sample2001 "1044a5b217114cb986756562f01c4b0e" 105 490 0 4dd 06/09 00:53:09
    06/09/2023 01:00
    06/09/2023 03:00
    06/09/2023 07:30
    log 06/09 07:41:51  756164f98d244a30bc3aeda5a351c025 GM202110 0 1 0
    OUT stars_super 2021.10 6 8874lt sample1415 "756164f98d244a30bc3aeda5a351c025" 20 385 0 41b 41b 778e "" "" "" 06/09 07:42:07
    IN 1 stars_super 2021.10 8874lt sample1415 "756164f98d244a30bc3aeda5a351c025" 20 365 0 41b 06/09 07:42:07
    OUT stars_super 2021.10 6 8874lt sample2624 "2836a7cf8e1b4b2f82e7f4d091a543fa" 20 385 0 5bb 5bb 6f0c4 "" "" "" 06/09 08:42:07
    DENY stars_super 2021.10 8874lt sample2624 "2836a7cf8e1b4b2f82e7f4d091a543fa" 105 -22 0 6f0c4 06/09 09:42
    IN 1 stars_super 2021.10 8874lt sample2624 "2836a7cf8e1b4b2f82e7f4d091a543fa" 20 365 0 5bb 06/09 09:42:50
    INUSE stars_super 2099.99 6 pqgtzz8 sample024 "423106dc80b54fddbca42944020cf0e4" 20 242 242 da6f 06/09 09:42:50
    INUSE stars_super 2099.99 6 pqgtzz8 sample024 "423106dc80b54fddbca42944020cf0e4" 40 c2 c2 da6f 06/09 09:42:50

  5. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Advanced Configuration

Refer to the RLM Log File Collection Configuration table to learn more about RLM configuration in logfilecollector-rlm.xml.

Object NameAccepted ValueDescription
source.dirDirName (e.g., C:\RLM\home\logs)Location of the RLM log files.
source.patternString (i.e., *.log)The glob pattern identifying source files in the source directory.
source.seenString (collect, ignore, or tail)Seen files are the previously collected source files.
  • collect - Specify this option to collect from the start each time.
  • ignore - Specify this option to skip collecting from the same file again.
  • tail - Specify this option to continue collection from the end of the file last time (i.e., collect the ones added since last time).
source.cmplinesInteger (e.g., 6, 10, 20)This is required if the value of source.seen is tail. This is the number of lines compared to source files collected before to determine where to start the collection.

Note: If this number is too low, you can end up with an incorrect position, and duplicate data may be in the log files. Usually, it is better to have a few lines more than strictly necessary than even a single line too little.
target.dirDirName (i.e., ${OpeniT.directories.temp}/LogFileCollector)This is the location of the directory containing the collected log data.
target.moduleString (i.e., license)The target type of module (in general).
target.datatypeString (i.e., rlm)The specific type of target data.
target.intervalTimespan (e.g., P30S, P5M, P1D)The span of time between collector runs.
target.rotation-sizeInteger (e.g., 6, 10, 20)The log file rotates if it goes beyond the number (in mb) defined.
target.rotation-globString (e.g., *)The glob pattern to match before the log file rotates.
RLM Log File Collection Configuration

Activating Log Data Collection​

These are steps to activate collection of RLM log data.

  1. Open a command prompt with Administrator level privileges.

  2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
    cd $BIN_DIR
    Example
    cd C:\Program Files\OpeniT\Core\bin

  3. Once in the directory, activate the collection of RLM log data, run the command:

    Command Syntax
    openit_oconfinit -u "collect_license_rlm-logs.root.scheduler.jobs.collect_rlm_licenselogs.general.active=true"
Advanced Configuration

The collection runs every 5 minutes by default. To configure the intervals, locate the instances attribute under collect_rlm_licenselogs, collect_rlm_license_id, preprocess_rlm_licenselogs-events, preprocess_rlm_licenselogs-records, or transfer_rlm_licenselogs in the same file and configure the attributes.

Refer to the RLM Log Job Scheduler Instances Configuration table to learn the attributes used to configure RLM data collection and transfer.

Attribute NameAccepted ValueDescription
max-instancesUint (e.g., 5, 8, 9)The number of instances allowed to run at the same time.
max-handlingString (end-oldest, end-all-old, or end-new)The action done upon reaching the maximum number of instances:
  • end-oldest - Specify this option to stop/kill the oldest instance and start a new one.
  • end-all-old - Specify this option to stop/kill all running instances before starting the new one.
  • end-new - Specify this option to prevent a new instance from starting.
end-timeoutTimespan (e.g., P30S, P5M, P1H)The maximum waiting time before terminating a running instance.
quarantineTimespan (e.g., P30S, P5M, P1H)The waiting time before starting a new instance after a previous one.
RLM Log Job Scheduler Instances Configuration

Configuring License ID Data Collection​

You can activate the license ID data collection to distinguish features with the same name but different license pools to avoid aggregating available and used licenses into only one record.

The string _id=<id> is appended to the feature name when this is activated.

Example:

  • tricore-gcc (_id=10)
  • tricore-gcc (_id=20)
note

Only supports parsing a single license file.

These are steps to activate license ID data collection.

  1. Open a command prompt with Administrator level privileges.

  2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
    cd $BIN_DIR
    Example
    cd C:\Program Files\OpeniT\Core\bin

  3. Once in the directory, activate the collection of license ID data, run the command:

    Command Syntax
    openit_oconfinit -u "collect_license_rlm-logs.root.scheduler.jobs.collect_rlm_license_id.general.active=true"

  4. Set the directory and the format of the license file, run the command:

    Command Syntax
    openit_oconfinit -update "collect_license_rlm-logs.root.scheduler.jobs.collect_rlm_license_id.operations.arguments=--srcdir "<license_dir>" --srcpattern "<license_pattern>" --trgdir "${OpeniT.directories.temp}/LogParserRLM"

    where:

    • <license_dir> - the complete path to the license file directory
    • <license_pattern> - the format of the license file name

    Example
    openit_oconfinit -u "collect_license_rlm-logs.root.scheduler.jobs.collect_rlm_license_id.operations.arguments=--srcdir "C:\reprise\license" --srcpattern "license.dat" --trgdir "${OpeniT.directories.temp}/LogParserRLM"

Deactivating Record Log Data Collection​

Turning on log data collection automatically aggregates record and event log data. If you want to collect event log data only, follow these steps.

  1. Open a command prompt with Administrator level privileges.

  2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
    cd $BIN_DIR
    Example
    cd C:\Program Files\OpeniT\Core\bin

  3. Once in the directory, deactivate the collection of record log data, run the command:

    Command Syntax
    openit_oconfinit -u "collect_license_rlm-logs.root.scheduler.jobs.preprocess_rlm_licenselogs-records.general.active=false"

  4. Change the handling of event logs, run the command:

    Command Syntax
    openit_oconfinit -u "collect_license_rlm-logs.root.scheduler.jobs.preprocess_rlm_licenselogs-events.operations.arguments=--srcdir \"${OpeniT.directories.temp}/LogFileCollector\" --srcpattern raw-rlm-license-LogFileCollector*.data --srcfilehandling rename --trgdir \"${OpeniT.directories.temp}/LogParserRLM\" --module license --datatype event --resolution PT1H --matchobjects \"${OpeniT.directories.conf}/matchobjects-event-rlm.oconf\" --type event --disable-statlogging"

  5. Change the data transfer schedule, run the command:

    Command Syntax
    openit_oconfinit -u "collect_license_rlm-logs.root.scheduler.jobs.transfer_rlm_licenselogs.scheduling.start-triggers.trigger#1.job-name=preprocess_rlm_licenselogs-events"

Verifying Log Data Collection​

After configuration, you can verify that the data is collected by following these steps:

  1. Open a command prompt with Administrator level privileges.

  2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
    cd $BIN_DIR
    Example
    cd C:\Program Files\OpeniT\Core\bin

  3. Run the command:

    Command Syntax
    openit_logfilecollector -c "C:\Program Files\OpeniT\Core\Configuration\logfilecollector-rlm.conf"

  4. Verify that there are *.data files created in the LogFileCollector directory, which is by default in C:\Program Files\OpeniT\Core\Log\temp\LogFileCollector.

Troubleshooting​

API Controller Cannot Upload Parsed Log Data​

Problem​

This issue may be encountered when the total size of parsed RLM data per sending is greater than 2 GB. The large parsed RLM data cannot be sent to the server, showing the error, ApiController: : postUploadData Failed to upload x files in the debug logs.

Resolution​

Compress object nodes for the upload_rlm_logs tasks are added so you can enable compression of the target data before sending them to the server.

warning

Make sure that the receiving Open iT Core Server is version 9.16.190 or later to properly receive the uploaded data and avoid data processing error and data loss.

These are the required steps to activate compression of parsed RLM data before uploading them to the server.

warning

Apply the configurations shown in the Open iT Core Client.

  1. Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and open apicontroller.xml.

  2. Locate the object node compress under the object node upload_rlm_logs and set its value to true.

    apicontroller.xml
    	<Object>
    		<Name>compress</Name>
    		<Description>Compress upload files before upload</Description>
    		<Value type="Bool">true</Value>
    	</Object>

  3. Save the changes.

  4. Open a command prompt with Administrator level privileges.

  5. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
    cd $BIN_DIR
    Example
    cd C:\Program Files\OpeniT\Core\bin

  6. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Max in Us is Greater than Max Available Licenses​

Problem​

The issue is with how the licensing system combines two different models for managing licenses:

  • Model 0 tracks the total number of licenses available.
  • Model 1 reserves a specific number of licenses.

The problem is that reports mix these two models. They show the maximum count from one model but add up license usage from both, creating confusing and inaccurate results, making it hard to understand what's actually happening with the licenses.

Resolution​

warning

Apply the configurations shown in the Open iT Core Server.

Activating Duplicating "out" Model Records​
  1. Go to the filtrator directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components\filtrator, and open olap-license-total-usage.xml.
  2. Locate the object node active under the object node Duplicate:LicensingModelFeatureName and set its value to true.
    olap-license-total-usage.xml
    <Object>
    	<Name>Duplicate:LicensingModelFeatureName</Name>
    	<Description>Duplicate records for RLM to have feature names with licensing model (Online, NamedUser</Description>
    	<SubObjects>
    		<Object>
    			<Name>active</Name>
    			<Description>Filter activation</Description>
    			<Value type="Bool">true</Value>
    		</Object>
  3. Save the changes.
Activating Calculating MaxAvail for the "normal" Feature​
  1. Go to the filtrator directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components\filtrator, and open olap-license-total-usage.xml.
  2. Locate the object node active under the object node CalcSum:LicensingModelFeatureName and set its value to true.
    olap-license-total-usage.xml
    <Object>
    	<Name>CalcSum:LicensingModelFeatureName</Name>
    	<Description>Calculate available licenses across licenseing_model in the "combined" features.</Description>
    	<SubObjects>
    		<Object>
    			<Name>active</Name>
    			<Description>Filter activation</Description>
    			<Value type="Bool">true</Value>
    		</Object>
  3. Save the changes.
Updating Configuration Files​

  1. Open a command prompt with Administrator level privileges.

  2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
    cd $BIN_DIR
    Example
    cd C:\Program Files\OpeniT\Core\bin

  3. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder

    Make sure errors are not encountered.

Proceed with data regeneration after configuring all the necessary files to apply the changes in the real-time and historical reports.

For real-time reports:

Generating License Status Data

For historical reports:

Data Generation

Next Steps?​

Vendor License Renaming
Feature Renaming
Create and Add Report
License Monitor