# Icarus License Manager

# Introduction

Open iT supports Icarus usage reporting by collecting log files and converting them to Open iT format. This will produce the following aggregated data types used for historical and real-time reporting:

(89) Total License Use Licenseevents
(90) Individual License Use Licenseevents
(91) Usergroup License Use Licenseevents
(108) Host License Use Licenseevents
(109) Hostgroup License Use Licenseevents

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

Apply the configurations shown in the Open iT client.

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

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

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

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

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

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

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

Save the changes.
Open a command prompt with Administrator level privileges.
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
```
Update the configuration file, run the command:
Command Syntax
```
 openit_confbuilder --client
```
Make sure that there are no errors 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

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

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

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

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

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

Save the changes.
Open a command prompt with Administrator level privileges.
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
```
Update the configuration file, run the command:
Command Syntax
```
 ./openit_confbuilder --client
```
Make sure that there are no errors 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

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

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

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

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

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

Save the changes.
Open a command prompt with Administrator level privileges.
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
```
Update the configuration file, run the command:
Command Syntax
```
 ./openit_confbuilder --client
```
Make sure that there are no errors 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.

Go to the scheduler directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\scheduler, and open collect_license_icarus-logs.oconf.
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
```
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_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. 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.

Icarus Log Job Scheduler Instances Configuration

Go to the scheduler directory, which is by default in /var/opt/openit/etc/scheduler, and open collect_license_icarus-logs.oconf.
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
```
Save the changes.

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

Icarus Log Job Scheduler Instances Configuration

Go to the scheduler directory, which is by default in /usr/local/openit/etc/scheduler, and open collect_license_icarus-logs.oconf.
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
```
Save the changes.

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

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:

Open a command prompt with Administrator level privileges.
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
```

Run the command:

Command Syntax
 openit_executor -r collect_license_icarus-logs

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.

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

Run the command:

Command Syntax
 ./openit_executor -r collect_license_icarus-logs

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.

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

Run the command:

Command Syntax
 ./openit_executor -r collect_license_icarus-logs

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