# Ensoft License Manager

# Introduction

Open iT supports Ensoft usage reporting by collecting log files and converting them to Open iT format.

An Open iT 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 midnight. 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

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 NetUniKeyServer.log debug log file
Optional: Valid UniKey ID

By default, UniKey IDs are used as feature names. To rename the features with their actual UniKey feature names, follow the instructions in the Configuring feature-rename.map section. This information can be obtained from the vendor.

# Configuring Log File Collection

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

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

Locate object node dir and set its value to the location of the Ensoft log files. The log file is usually stored in C:\ProgramData\Ensoft\.

logfilecollector-ensoft.xml
<Object>
	<Name>dir</Name>
	<Description>Directory containing the log files</Description>
	<Value type="DirName">%ENSOFTLOGDIR%</Value>
</Object>

Example: logfilecollector-ensoft.xml
<Object>
	<Name>dir</Name>
	<Description>Directory containing the log files</Description>
	<Value type="DirName">C:\ProgramData\Ensoft</Value>
</Object>

 05/30/2024, 12:30:04 ,Client logoff/disconnect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:26 ,Client logoff/disconnect ,0.0.0.0 ,0 ,
 05/30/2024, 12:34:27 ,Client connect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:27 ,Client logon ,10.0.11.89 ,2 ,1CNGTV3, 180922349, 2, 40
 05/30/2024, 12:34:27 ,Client logoff/disconnect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:28 ,Client connect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:28 ,Client logon ,10.0.11.89 ,2 ,1CNGTV3, 180921642, 1, 40
 05/30/2024, 12:34:29 ,Client logoff/disconnect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:30 ,Client connect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:30 ,Client logon ,10.0.11.89 ,2 ,1CNGTV3, 689780083, 7, 40
 05/30/2024, 12:34:30 ,Client logoff/disconnect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:31 ,Client connect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:31 ,Client logon ,10.0.11.89 ,2 ,1CNGTV3, 689780083, 7, 40
 05/30/2024, 12:34:32 ,Client logoff/disconnect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:33 ,Client connect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:33 ,Client logon ,10.0.11.89 ,2 ,1CNGTV3, 689780083, 7, 40
 05/30/2024, 12:34:34 ,Client logoff/disconnect ,10.0.11.89 ,2 ,1CNGTV3

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 no errors are encountered.

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

Object Name	Accepted Value	Description
source.dir	DirName (e.g., `C:\ProgramData\Ensoft`)	Location of the Ensoft 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 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.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., `ensoft`)	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.

Ensoft Log File Collection Configuration

These instructions assume your configuration directory is /var/opt/openit/etc.

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

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

logfilecollector-ensoft.xml
<Object>
	<Name>dir</Name>
	<Description>Directory containing the log files</Description>
	<Value type="DirName">%ENSOFTLOGDIR%</Value>
</Object>

Example: logfilecollector-ensoft.xml
<Object>
	<Name>dir</Name>
	<Description>Directory containing the log files</Description>
	<Value type="DirName">/root/ensoft/logs</Value>
</Object>

 05/30/2024, 12:30:04 ,Client logoff/disconnect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:26 ,Client logoff/disconnect ,0.0.0.0 ,0 ,
 05/30/2024, 12:34:27 ,Client connect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:27 ,Client logon ,10.0.11.89 ,2 ,1CNGTV3, 180922349, 2, 40
 05/30/2024, 12:34:27 ,Client logoff/disconnect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:28 ,Client connect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:28 ,Client logon ,10.0.11.89 ,2 ,1CNGTV3, 180921642, 1, 40
 05/30/2024, 12:34:29 ,Client logoff/disconnect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:30 ,Client connect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:30 ,Client logon ,10.0.11.89 ,2 ,1CNGTV3, 689780083, 7, 40
 05/30/2024, 12:34:30 ,Client logoff/disconnect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:31 ,Client connect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:31 ,Client logon ,10.0.11.89 ,2 ,1CNGTV3, 689780083, 7, 40
 05/30/2024, 12:34:32 ,Client logoff/disconnect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:33 ,Client connect ,10.0.11.89 ,2 ,1CNGTV3
 05/30/2024, 12:34:33 ,Client logon ,10.0.11.89 ,2 ,1CNGTV3, 689780083, 7, 40
 05/30/2024, 12:34:34 ,Client logoff/disconnect ,10.0.11.89 ,2 ,1CNGTV3

Save the changes.
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 no errors are encountered.

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

Object Name	Accepted Value	Description
source.dir	DirName (e.g., `/root/ensoft/logs`)	Location of the Ensoft 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 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.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 directory location containing the collected log data.
target.module	String (i.e., `license`)	The target type of module (in general).
target.datatype	String (i.e., `ensoft`)	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.

Ensoft Log File Collection Configuration

# Ensoft Events Log File Collection Configuration

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

(104) License Logfile Events v2.0

In data type 104, the feature in check-in event will be left empty due to insufficient information in the raw log file.

There will be no data type 107 since the denial information is unavailable.

# Activating Event Log Data Collection

These are the required steps to activate collection of event log data.

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

Once in the directory, activate the collection of Ensoft event log data, run the command:

Command Syntax
 openit_oconfinit -u "collect_license_ensoft_event-logs.root.scheduler.jobs.collect_ensoft_licenselogs-events.general.active=true"

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

Once in the directory, activate the collection of Ensoft event log data, run the command:

Command Syntax
 ./openit_oconfinit -u "collect_license_ensoft_event-logs.root.scheduler.jobs.collect_ensoft_licenselogs-events.general.active=true"

The collection runs every midnight by default. To configure the intervals, locate the instances attribute under collect_ensoft_licenselogs, preprocess_ensoft_licenselogs-events, preprocess_ensoft_licenselogs-records, or transfer_ensoft_licenselogs in the same file and configure the attributes.

Refer to the Ensoft Log Job Scheduler Instances Configuration table to learn the attributes used to configure Ensoft 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.

Ensoft Log Job Scheduler Instances Configuration

# Verifying Event 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
```
To verify the collection of event log data, run the command:
Command Syntax
```
 openit_executor -r collect_license_ensoft_event-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
```
To verify the collection of event log data, run the command:
Command Syntax
```
 ./openit_executor -r collect_license_ensoft_event-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.

# Ensoft Records Log File Collection Configuration

This will produce the following aggregated data types used for historical 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

In data type 90, the User field will be left empty due to insufficient information in the raw log file.

# Activating Record Log Data Collection

These are the required steps to activate record log data collection.

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

Once in the directory, activate the collection of record log data, run the command:

Command Syntax
 openit_oconfinit -u "collect_license_ensoft_record-logs.root.scheduler.jobs.collect_ensoft_licenselogs-records.general.active=true"

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