# OLicense Server

# Introduction

Open iT supports Olicense usage reporting by collecting log files and converting them to Open iT format. 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

  • An Open iT Client connected to an Open iT Server or a coexistent Open iT setup
  • License server administrative rights
  • Full path to the debug log file

# Specifying Olicense Log File Path

These are the required steps to specify the path to the Olicense log files.

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

  2. Locate object node dir and set its value to the location of the Olicense log files.

    logfilecollector-olicense.xml
     14|	<Object>
 15|		<Name>dir</Name>
 16|		<Description>Directory containing the log files</Description>
 17|		<Value type="DirName">%OLICENSELOGDIR%</Value>
 18|	</Object>
    Example: logfilecollector-olicense.xml
     14|	<Object>
 15|		<Name>dir</Name>
 16|		<Description>Directory containing the log files</Description>
 17|		<Value type="DirName">C:\Users\Administrator\Desktop\olicense</Value>
 18|	</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 that there are no errors encountered.

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

Object Name Accepted Value Description
source.dir DirName (e.g., C:\Users\Administrator\Desktop\olicense) Location of the Olicense log files.
source.pattern String (i.e., *.log) The glob pattern identifying source files in the source directory.
source.seen String (collect, ignore, or tail) Seen files are source files collected from before. Specify collect to collect from the start every time, specify ignore to never collect from the same file again, or specify tail to continue collection from the end of the file last time (i.e., collect the ones added since last time).
source.cmplines Integer (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.dir DirName (i.e., ${OpeniT.directories.temp}/LogFileCollector) This is the location of the directory containing the collected log data.
target.module String (i.e., license) The target type of module (in general).
target.datatype String (i.e., olicense) The specific type of target data.
target.interval Timespan (e.g., P30S, P5M, P1D) The span of time between collector runs.
target.rotation-size Integer (e.g., 6, 10, 20) The log file rotates if it goes beyond the number (in mb) defined.
target.rotation-glob String (e.g., *) The glob pattern to match before the log file rotates.
Olicense Log File Collection Configuration

  1. Go to the Components directory, which is by default in /var/opt/openit/etc/Components, and open logfilecollector-olicense.xml.

  2. Locate object node dir and set its value to the location of the Olicense log files.

    logfilecollector-olicense.xml
     14|	<Object>
 15|		<Name>dir</Name>
 16|		<Description>Directory containing the log files</Description>
 17|		<Value type="DirName">%OLICENSELOGDIR%</Value>
 18|	</Object>
    Example: logfilecollector-olicense.xml
     14|	<Object>
 15|		<Name>dir</Name>
 16|		<Description>Directory containing the log files</Description>
 17|		<Value type="DirName">/var/opt/olicense</Value>
 18|	</Object>

  3. Save the changes.

  4. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  5. Update the configuration file, run the command:

    Command Syntax
     ./openit_confbuilder --client

    Make sure that there are no errors encountered.

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

Object Name Accepted Value Description
source.dir DirName (e.g., /var/opt/olicense) Location of the Olicense log files.
source.pattern String (i.e., *.log) The glob pattern identifying source files in the source directory.
source.seen String (collect, ignore, or tail) Seen files are source files collected from before. Specify collect to collect from the start every time, specify ignore to never collect from the same file again, or specify tail to continue collection from the end of the file last time (i.e., collect the ones added since last time).
source.cmplines Integer (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.dir DirName (i.e., ${OpeniT.directories.temp}/LogFileCollector) This is the location of the directory containing the collected log data.
target.module String (i.e., license) The target type of module (in general).
target.datatype String (i.e., olicense) The specific type of target data.
target.interval Timespan (e.g., P30S, P5M, P1D) The span of time between collector runs.
target.rotation-size Integer (e.g., 6, 10, 20) The log file rotates if it goes beyond the number (in mb) defined.
target.rotation-glob String (e.g., *) The glob pattern to match before the log file rotates.
Olicense Log File Collection Configuration

# Olicense Events Log File Collection Configuration

# Activating Event Log Data Collection

These are the required steps to activate collection of the Olicense log file for events.

  1. Go to the scheduler directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\scheduler, and open collect_license_olicense-logs.oconf.

  2. Locate and set root.scheduler.jobs.collect_olicense_licenselogs.general.active to true to activate log file collection

    collect_license_olicense-logs.oconf
     13|	}
 14|		general
 15|		{
 16|			active
 17|			{
 18|				type=bool
 19|				value=true

  3. Save the changes.

  1. Go to the scheduler directory, which is by default in /var/opt/openit/etc/scheduler, and open collect_license_olicense-logs.oconf.

  2. Locate and set root.scheduler.jobs.collect_olicense_licenselogs.general.active to true to activate log file collection.

    collect_license_olicense-logs.oconf
     13|	}
 14|		general
 15|		{
 16|			active
 17|			{
 18|				type=bool
 19|				value=true

  3. Save the changes.

The collection runs hourly using a 5-minute sample interval by default. The primary data is then transferred to the server every night according to the client timezone for processing. To configure the intervals, locate the instances attribute under collect_olicense_licenselogs, preprocess_olicense_licenselogs-events, or transfer_olicense_licenselogs in the same file and configure the attributes.

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

Attribute Name Accepted Value Description
max-instances Uint (e.g., 5, 8, 9) The number of instances allowed to run at the same time.
max-handling String (end-oldest, end-all-old, or end-new) The action done upon reaching the maximum number of instances. Specify end-oldest to stop/kill the oldest instance and then start the new, specify end-all-old to stop/kill all running instances and then start the new, or specify end-new to not start the new instance.
end-timeout Timespan (e.g., P30S, P5M, P1H) The maximum waiting time before terminating a running instance.
quarantine Timespan (e.g., P30S, P5M, P1H) The waiting time before starting a new instance after a previous one.
Olicense Log Job Scheduler Instances Configuration

# Changing the Vendor License Name for License Events

These are the required steps to change the vendor license names for Olicense license events monitoring and reporting:

  1. Go to the Configuration directory, which is by default in C:\Program Files\OpeniT\Core\Configuration, and open matchobjects-event-olicense.oconf.

  2. Locate the data-process1 node under the post-processing node and set the vendor license name.

    matchobjects-event-olicense.oconf
     106|		data-process1
 107|		{
 108|			type=string
 109|			value=product="MNL473WIN_OLICENSE"
 110|		}

  3. Save the changes.

  1. Go to the Configuration directory, which is by default in /var/opt/openit/etc, and open matchobjects-event-olicense.oconf.

  2. Locate the data-process1 node under the post-processing node and set the vendor license name.

    matchobjects-event-olicense.oconf
     106|		data-process1
 107|		{
 108|			type=string
 109|			value=product="MNL473WIN_OLICENSE"
 110|		}

  3. Save the changes.

# Verifying Event Log Data Collection

After configuration, you can verify that the data is collected and sent to the server 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_executor -r collect_license_olicense-logs

  4. Verify that there are archiver*.in files created in the server in the archiver directory, which is by default in C:\ProgramData\OpeniT\Data\incoming\archiver.

  1. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  2. Run the command:

    Command Syntax
     ./openit_executor -r collect_license_olicense-logs

  3. Verify that there are archiver*.in files created in the incoming directory in your defined data_dir ($ROOT_DATA_DIR) upon Open iT server installation.

# Olicense Records Log File Collection Configuration

# Activating Record Log Data Collection

These are the required steps to activate collection of the Olicense log file for records.

  1. Go to the scheduler directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\scheduler, and open collect_license_olicense-record-logs.oconf.

  2. Locate and set root.scheduler.jobs.collect_olicense_licenselogs-records.general.active to true to activate log file collection.

    collect_license_olicense-record-logs.oconf
     13|	}
 14|		general
 15|		{
 16|			active
 17|			{
 18|				type=bool
 19|				value=true

  3. Save the changes.

The collection runs hourly using a 5-minute sample interval by default. The primary data is then transferred to the server every night according to the client timezone for processing. To configure the intervals, locate the instances attribute under collect_olicense_licenselogs-records, preprocess_olicense_licenselogs-records, or transfer_olicense_licenselogs-records in the same file and configure the attributes.

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

Attribute Name Accepted Value Description
max-instances Uint (e.g., 5, 8, 9) The number of instances allowed to run at the same time.
max-handling String (end-oldest, end-all-old, or end-new) The action done upon reaching the maximum number of instances. Specify end-oldest to stop/kill the oldest instance and then start the new, specify end-all-old to stop/kill all running instances and then start the new, or specify end-new to not start the new instance.
end-timeout Timespan (e.g., P30S, P5M, P1H) The maximum waiting time before terminating a running instance.
quarantine Timespan (e.g., P30S, P5M, P1H) The waiting time before starting a new instance after a previous one.
Olicense Log Job Scheduler Instances Configuration

  1. Go to the scheduler directory, which is by default in /var/opt/openit/etc/scheduler, and open collect_license_olicense-record-logs.oconf.

  2. Locate and set root.scheduler.jobs.collect_olicense_licenselogs-records.general.active to true to activate log file collection.

    collect_license_olicense-record-logs.oconf
     13|	}
 14|		general
 15|		{
 16|			active
 17|			{
 18|				type=bool
 19|				value=true

  3. Save the changes.

The collection runs hourly using a 5-minute sample interval by default. The primary data is then transferred to the server every night according to the client timezone for processing. To configure the intervals, locate the instances attribute under collect_olicense_licenselogs-records, preprocess_olicense_licenselogs-records, or transfer_olicense_licenselogs-records in the same file and configure the attributes.

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

Attribute Name Accepted Value Description
max-instances Uint (e.g., 5, 8, 9) The number of instances allowed to run at the same time.
max-handling String (end-oldest, end-all-old, or end-new) The action done upon reaching the maximum number of instances. Specify end-oldest to stop/kill the oldest instance and then start the new, specify end-all-old to stop/kill all running instances and then start the new, or specify end-new to not start the new instance.
end-timeout Timespan (e.g., P30S, P5M, P1H) The maximum waiting time before terminating a running instance.
quarantine Timespan (e.g., P30S, P5M, P1H) The waiting time before starting a new instance after a previous one.
Olicense Log Job Scheduler Instances Configuration

# Changing the Vendor License Name for License Records

These are the required steps to change the vendor license names for Olicense license records monitoring and reporting:

  1. Go to the Configuration directory, which is by default in C:\Program Files\OpeniT\Core\Configuration, and open matchobjects-record-olicense.oconf.

  2. Locate the data-process1 node under the post-processing node and set the vendor license name.

    matchobjects-record-olicense.oconf
     111|		data-process1
 112|		{
 113|			description=Product Name
 114|			type=string
 115|			value=product="MNL473WIN_OLICENSE"
 116|		}

  3. Save the changes.

  1. Go to the Configuration directory, which is by default in /var/opt/openit/etc, and open matchobjects-record-olicense.oconf.

  2. Locate the data-process1 node under the post-processing node and set the vendor license name.

    matchobjects-record-olicense.oconf
     111|		data-process1
 112|		{
 113|			description=Product Name
 114|			type=string
 115|			value=product="MNL473WIN_OLICENSE"
 116|		}

  3. Save the changes.

# Setting Max Available Licenses

The raw log file does not include information on the max available licenses. Set this manually by following these steps:

  1. Go to the Configuration directory, which is by default in C:\Program Files\OpeniT\Core\Configuration, and open matchobjects-record-olicense.oconf.

  2. Locate the data-process3 node under the post-processing node and set it to the number of max available licenses.

    matchobjects-record-olicense.oconf
     122|		data-process3
 123|		{
 124|			description=Max available license. Set manually.
 125|			type=string
 126|			value=licenses=100
 127|		}

  3. Save the changes.

  1. Go to the Configuration directory, which is by default in /var/opt/openit/etc, and open matchobjects-record-olicense.oconf.

  2. Locate the data-process3 node under the post-processing node and set it to the number of max available licenses.

    matchobjects-record-olicense.oconf
     122|		data-process3
 123|		{
 124|			description=Max available license. Set manually.
 125|			type=string
 126|			value=licenses=100
 127|		}

  3. Save the changes.

# Verifying Record Log Data Collection

After configuration, you can verify that the data is collected and sent to the server 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_executor -r collect_license_olicense-record-logs

  4. Verify that there are archiver*.in files created in the server in the archiver directory, which is by default in C:\ProgramData\OpeniT\Data\incoming\archiver.

  1. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  2. Run the command:

    Command Syntax
     ./openit_executor -r collect_license_olicense-record-logs

  3. Verify that there are archiver*.in files created in the incoming directory in your defined data_dir ($ROOT_DATA_DIR) upon Open iT server installation.

# Sample Reports

# Historical Reports

89 - Total License Use Licenseevents

89 - Total License Use Licenseevents

90 - Individual License Use Licenseevents

90 - Individual License Use Licenseevents

91 - Usergroup License Use Licenseevents

91 - Usergroup License Use Licenseevents

108 - Host License Use Licenseevents

108 - Host License Use Licenseevents

109 - Hostgroup License Use Licenseevents

109 - Hostgroup License Use Licenseevents

# Real-time Reports

Product View

Product View

Feature View

Feature View

# Troubleshooting

# Max in Use is Greater than Max Available Licenses

# Problem

This issue may be encountered when the license check outs were processed even though there weren't license check ins.

# Resolution

A new command line option --autooff is added so you can configure the duration before checked out licenses are automatically checked in.

These are the required steps to configure:

  1. Open collect_license_olicense-record-logs.oconf in the scheduler directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\scheduler.
  2. Locate the --autooff argument in root.scheduler.jobs.preprocess_olicense_licenselogsrecords.operations.arguments and set its value to the desired duration before automatically checking in checked out licenses.
    collect_license_olicense-record-logs.oconf
     151|	arguments
 152|	{
 153|		type=string
 154|		value=--srcdir "${OpeniT.directories.temp}/Raw.Olicense.Record" --srcpattern raw-olicense-license-LogFileCollector*.data --srcfilehandling delete --trgdir "${OpeniT.directories.temp}/LogParserOlicense" --module license --datatype record --resolution PT1H --matchobjects "${OpeniT.directories.conf}/matchobjects-record-olicense.oconf" --type record --autooff PT5M
 155|	}
  3. Save the changes.
  1. Open collect_license_olicense-record-logs.oconf in the scheduler directory, which is by default in /var/opt/openit/etc/scheduler.
  2. Locate the --autooff argument in root.scheduler.jobs.preprocess_olicense_licenselogsrecords.operations.arguments and set its value to the desired duration before automatically checking in checked out licenses.
    collect_license_olicense-record-logs.oconf
     151|	arguments
 152|	{
 153|		type=string
 154|		value=--srcdir "${OpeniT.directories.temp}/Raw.Olicense.Record" --srcpattern raw-olicense-license-LogFileCollector*.data --srcfilehandling delete --trgdir "${OpeniT.directories.temp}/LogParserOlicense" --module license --datatype record --resolution PT1H --matchobjects "${OpeniT.directories.conf}/matchobjects-record-olicense.oconf" --type record --autooff PT5M
 155|	}
  3. Save the changes.

# Next Steps?

   Renaming Vendor License    Renaming Features    Create and Add Report    License Monitor

Powered by Open iT ® Open iT Docs All rights reserved.

We value your feedback!

Please take a few minutes to complete our survey and share your thoughts on your recent experience with our documentation.

Take survey

Close