Skip to main content
Version: 10.2

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 Core 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

Log File Parsing 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.

warning

Apply the configurations shown in the Open iT Core Client.

Requirements​

  • An Open iT Core Client connected to an Open iT Core Server or a coexistent Open iT Core 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.

note

You can safely skip this step if Icarus license server is installed in the default location.

  1. Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and back up the icaruspoll.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 Icarus license file, run the command:

    Command Syntax
    openit_confinit -c "icaruspoll.icaruspoll.input.license-file=<icarus_license_dir>"

    where <icarus_license_dir> is the location of the Icarus license file.

    Example
    openit_confinit -c "icaruspoll.icaruspoll.input.license-file=C:\Windows\System32\config\systemprofile\AppData\Roaming\SciTools\Icarus\icarus.dat"
    Sample License File Content
    -Start-
    IdProduct ****-****
    Expiration 2020-12-30
    NumConcurrent 25
    NumInstall 25
    NumAway 5
    TimeOut 15
    LicenseCode *************
    DeregisterLimit 15
    Hash ************************************
    -End-

  5. Set the location of the Icarus usage file, run the command:

    Command Syntax
    openit_confinit -c "icaruspoll.icaruspoll.input.usage-file=<icarus_usage_dir>"

    where <icarus_usage_dir> is the location of the Icarus usage file.

    Example
    openit_confinit -c "icaruspoll.icaruspoll.input.usage-file=C:\Windows\System32\config\systemprofile\AppData\Roaming\SciTools\Icarus\usagebyuser.ic"
    Sample Usage File Content
    user03,2024-02-11,1
    user05,2024-02-11,0
    user03,2024-02-12,464
    user04,2024-02-12,0
    user03,2024-02-13,364
    user03,2024-02-17,484
    user03,2024-02-18,45
    user03,2024-02-19,446
    user03,2024-02-20,91
    user03,2024-02-21,463
    user03,2024-02-24,489
    user04,2024-02-25,476
    user03,2024-02-25,256
    user03,2024-02-26,474
    user03,2024-02-27,395
    user06,2024-02-27,575
    user06,2024-02-28,1378
    user03,2024-02-28,484
    user06,2024-02-29,1438
    user06,2024-03-01,1436

  6. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Advanced Configuration

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

Object NameAccepted ValueDescription
input.license-fileFileName (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-fileFileName (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-dirDirName (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-fileFileName (i.e., icarus_poll.csv)This is the CSV output file based on the contents of the license-file and usage-file.
output.cache-fileFileName (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"
Advanced Configuration

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 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 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-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.
Icarus Log Job Scheduler Instances Configuration

Verifying Log Data Collection​

After configuration, you can verify that the data is collected and sent to the Core 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 Core Server's archiver directory, which is by default in C:\ProgramData\OpeniT\Data\incoming\archiver.

Next Steps?​

Renaming Vendor License
Renaming Features
Create and Add Report
License Monitor