# Icarus License Manager

# Introduction

Open iT supports Icarus License Manager usage reporting by collecting log files and converting them to Open iT format.

An Open iT client is installed on your license server, and the license server does not create license usage history logs for this collection. The data collector initiates the raw data collector to request license usage history logs from the license manager every midnight, triggering the data collection process. Once the logs are received, the raw data collector passes them to the data collector. The collected data is then sent to a data preprocessor for processing. After preprocessing, the final preprocessed data is sent and stored in the Core Server.

Log File Parsing Workflow with Raw Collector

Log File Parsing Workflow with Raw Collector

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 Icarus license and usage file

# Configuring Log File Collection

These are the required steps to configure collection of Icarus log files if your Icarus license server is not installed in the default location.

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

  2. Locate object node license-file and set its value to the location of the Icarus license file.

    Example: icaruspoll.xml
     26|	<Object>
 27|		<Name>license-file</Name>
 28|		<Description>The license file that tracks all licenses currently being served by Icarus. Has a default in-code value.</Description>
 29|		<Value type="FileName">C:\Windows\System32\config\systemprofile\AppData\Roaming\SciTools\Icarus\icarus.dat</Value>
 30|	</Object>

  3. Locate object node usage-file and set its value to the location of the Icarus usage file.

    Example: icaruspoll.xml
     32|	<Object>
 33|		<Name>usage-file</Name>
 34|		<Description>This file tracks the individual usage of Understand for each user by day. Has a default in-code value.</Description>
 35|		<Value type="FileName">C:\Windows\System32\config\systemprofile\AppData\Roaming\SciTools\Icarus\usagebyuser.ic</Value>
 36|	</Object>

  4. Save the changes.

  5. Open a command prompt with Administrator level privileges.

  6. 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

  7. Update the configuration file, run the command:

    Command Syntax
     openit_confbuilder --client

    Make sure no errors are encountered.

Refer to the Icarus Log File Collection Configuration table to learn more about Icarus configuration in icaruspoll.xml.

Object Name Accepted Value Description
input.license-file FileName (i.e., C:/Windows/System32/config/systemprofile/AppData/Roaming/SciTools/Icarus/icarus.dat) Location of the Icarus license file that tracks all licenses served by Icarus. This has a default in-code value.
input.usage-file FileName (i.e., C:/Windows/System32/config/systemprofile/AppData/Roaming/SciTools/Icarus/usagebyuser.ic) Location of the Icarus usage file that tracks the individual usage of each user by day. This has a default in-code value.
output.icaruspoll-dir DirName (i,e., ${OpeniT.directories.temp}/IcarusPoll) This is the location of the directory where the Icarus license and usage file will be copied prior to parsing. It will also contain the output CSV file and cache file.
output.csv-file FileName (i.e., icarus_poll.csv) This is the CSV output file based on the contents of the license-file and usage-file.
output.cache-file FileName (i.e., icarus_poll.cache) The cache file used to determine where to start reading the usage-file based on checkout date.
Icarus Log File Collection Configuration

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

  2. Locate object node license-file and set its value to the location of the Icarus license file.

    Example: icaruspoll.xml
     26|	<Object>
 27|		<Name>license-file</Name>
 28|		<Description>The license file that tracks all licenses currently being served by Icarus. Has a default in-code value.</Description>
 29|		<Value type="FileName">/root/.config/SciTools/Icarus/icarus.dat</Value>
 30|	</Object>

  3. Locate object node usage-file and set its value to the location of the Icarus usage file.

    Example: icaruspoll.xml
     32|	<Object>
 33|		<Name>usage-file</Name>
 34|		<Description>This file tracks the individual usage of Understand for each user by day. Has a default in-code value.</Description>
 35|		<Value type="FileName">/root/.config/SciTools/Icarus/usagebyuser.ic</Value>
 36|	</Object>

  4. Save the changes.

  5. Open a command prompt with Administrator level privileges.

  6. 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

  7. Update the configuration file, run the command:

    Command Syntax
     ./openit_confbuilder --client

    Make sure no errors are encountered.

Refer to the Icarus Log File Collection Configuration table to learn more about Icarus configuration in icaruspoll.xml.

Object Name Accepted Value Description
input.license-file FileName (i.e., /root/.config/SciTools/Icarus/icarus.dat) Location of the Icarus license file that tracks all licenses served by Icarus. This has a default in-code value.
input.usage-file FileName (i.e., /root/.config/SciTools/Icarus/usagebyuser.ic) Location of the Icarus usage file that tracks the individual usage of each user by day. This has a default in-code value.
output.icaruspoll-dir DirName (i,e., ${OpeniT.directories.temp}/IcarusPoll) This is the location of the directory where the Icarus license and usage file will be copied prior to parsing. It will also contain the output CSV file and cache file.
output.csv-file FileName (i.e., icarus_poll.csv) This is the CSV output file based on the contents of the license-file and usage-file.
output.cache-file FileName (i.e., icarus_poll.cache) The cache file used to determine where to start reading the usage-file based on checkout date.
Icarus Log File Collection Configuration

  1. Go to the Components directory, which is by default in /usr/local/openit/etc/Components, and open icaruspoll.xml.

  2. Locate object node license-file and set its value to the location of the Icarus license file.

    Example: icaruspoll.xml
     26|	<Object>
 27|		<Name>license-file</Name>
 28|		<Description>The license file that tracks all licenses currently being served by Icarus. Has a default in-code value.</Description>
 29|		<Value type="FileName">/Library/Application Support/SciTools/Icarus/icarus.dat</Value>
 30|	</Object>

  3. Locate object node usage-file and set its value to the location of the Icarus usage file.

    Example: icaruspoll.xml
     32|	<Object>
 33|		<Name>usage-file</Name>
 34|		<Description>This file tracks the individual usage of Understand for each user by day. Has a default in-code value.</Description>
 35|		<Value type="FileName">/Library/Application Support/SciTools/Icarus/usagebyuser.ic</Value>
 36|	</Object>

  4. Save the changes.

  5. Open a command prompt with Administrator level privileges.

  6. Go to the bin directory, which is by default in /usr/local/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /usr/local/openit/bin

  7. Update the configuration file, run the command:

    Command Syntax
     ./openit_confbuilder --client

    Make sure no errors are encountered.

Refer to the Icarus Log File Collection Configuration table to learn more about Icarus configuration in icaruspoll.xml.

Object Name Accepted Value Description
input.license-file FileName (i.e., /Library/Application Support/SciTools/Icarus/icarus.dat) Location of the Icarus license file that tracks all licenses served by Icarus. This has a default in-code value.
input.usage-file FileName (i.e., /Library/Application Support/SciTools/Icarus/usagebyuser.ic) Location of the Icarus usage file that tracks the individual usage of each user by day. This has a default in-code value.
output.icaruspoll-dir DirName (i,e., ${OpeniT.directories.temp}/IcarusPoll) This is the location of the directory where the Icarus license and usage file will be copied prior to parsing. It will also contain the output CSV file and cache file.
output.csv-file FileName (i.e., icarus_poll.csv) This is the CSV output file based on the contents of the license-file and usage-file.
output.cache-file FileName (i.e., icarus_poll.cache) The cache file used to determine where to start reading the usage-file based on checkout date.
Icarus Log File Collection Configuration

# Activating Log Data Collection

These are the required steps to activate collection of Icarus 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 Icarus log data, run the command:

    Command Syntax
     openit_oconfinit -u "collect_license_icarus-logs.root.scheduler.jobs.collect_icarus_data.general.active=true"

  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. Once in the directory, activate the collection of Icarus log data, run the command:

    Command Syntax
     ./openit_oconfinit -u "collect_license_icarus-logs.root.scheduler.jobs.collect_icarus_data.general.active=true"

  1. Go to the scheduler directory, which is by default in /usr/local/openit/etc/scheduler, and open collect_license_icarus-logs.oconf.

  2. Locate and set root.scheduler.jobs.collect_icarus_data.general.active to true to activate the collection of Icarus log data.

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

  3. Save the changes.

The collection runs every midnight by default. To configure the intervals, locate the instances attribute under collect_icarus_data, collect_icarus_licenselogs, parse_icarus_data, send_icarus_raw_data, or send_icarus_parsed_data in the same file and configure the attributes.

Refer to the Icarus Log Job Scheduler Instances Configuration table to learn the attributes used to configure Icarus 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:
  • end-oldest - Specify this option to stop/kill the oldest instance and starts 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-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.
Icarus Log Job Scheduler Instances Configuration

# Verifying 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_icarus-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_icarus-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.

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

    Command Syntax
     cd $BIN_DIR
    Example
     cd /usr/local/openit/bin

  2. Run the command:

    Command Syntax
     ./openit_executor -r collect_license_icarus-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.

# 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