# Tasking License Management System (TLM)

# Introduction

Open iT supports TLM usage reporting. The following sections will guide you on the required configuration for license manager utility polling and log file parsing.

Apply the configurations in the Open iT client.

# Configuring License Manager Utility Polling

Open iT supports Tasking License Management System (TLM) usage reporting through the generic license type 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

Configured TLM License Server
Valid URL with the port number of the TLM API
An Open iT Client connected to an Open iT Server or a coexistent Open iT setup
Activated LicenseAnalyzer collection and license poller

# Configuring Data Collection

These are the required steps to activate and configure collection of TLM usage data.

Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and back up the licpoll.xml configuration file.
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, copy the object node genericlicense-sample and rename it to your desired name. In this example, we will use tlm. Run the command:
Command Syntax
```
 openit_confinit -c "licpoll.license-types.genericlicense-sample=>licpoll.license-types.tlm"
```
Element names cannot contain parentheses ( or ) because they are not valid for XML element names.
Activate the collection of TLM data, run the command:
Command Syntax
```
 openit_confinit -c "licpoll.license-types.tlm.active=true"
```

Set the arguments to the status command, run the command:

Command Syntax
 openit_confinit -c "licpoll.license-types.tlm.status-command.arguments=TLM <api_url>"

where <api_url> is the corresponding valid URL with the port number of the TLM API.

Example
 openit_confinit -c "licpoll.license-types.tlm.status-command.arguments=TLM http://localhost:9090"

Update the configuration file, run the command:
Command Syntax
```
 openit_confbuilder --client
```
Make sure that there are no errors encountered.

Refer to the TLM Data Collection Configuration table to learn more about TLM configuration in licpoll.xml.

Object Name	Accepted Value	Description
active	Boolean (`true` or `false`)	Setting this to `true` activates TLM usage data collection.
type	String (e.g., `GenericLicense`)	The license manager type.
interval	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The span of time between each polling round (it is recommended to set a value no less than P1M).
offset	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The span of time the aligned poll time decided by interval is shifted.
product-name	String (e.g., `server;daemon`)	This object is defined if a vendor license name other than the default `GenericLicense=%hosttype%` will be used.
license-server	String (e.g., `hou105win`)	The License Server name.
status-command	FileName (i.e., `${OpeniT.directories.bin}/genlicutil`)	The binary used to obtain status from the license manager.
status-command.arguments	String (e.g., `TLM http://localhost:9090`)	The arguments used for the status command. Use the format `TLM <api_url>`.

TLM Data Collection Configuration

# Verifying Data Collection

After configuration, you can verify that the data is collected 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_licpoll -# 1
```
Verify that the temp directory, which is by default in C:\ProgramData\OpeniT\Data\temp, contains a LicPoll directory containing .data and status-*.log files.

# Configuring Log File Parsing

Open iT collects log files and converts them to Open iT format. This will produce the following aggregated data types used for historical reporting:

(104) License Logfile Events v2.0
(107) Denied 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.

# 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

# Configuring Log File Collection

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

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

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

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

Example: logfilecollector-tlm.xml
<Object>
	<Name>dir</Name>
	<Description>Directory containing the log files</Description>
	<Value type="DirName">C:\tlm\logs</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 TLM Log File Collection Configuration table to learn more about TLM configuration in logfilecollector-tlm.xml.

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

TLM Log File Collection Configuration

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

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

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

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

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

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

Object Name	Accepted Value	Description
source.dir	DirName (e.g., `/tlm/logs`)	Location of the TLM 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., `tlm`)	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.

TLM Log File Collection Configuration

# Activating Log Data Collection

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

Go to the scheduler directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\scheduler, and open collect_license_tlm-logs.oconf.
Locate and set root.scheduler.jobs.collect_tlm_licenselogs.general.active to true to activate the collection of TLM log data.
collect_license_tlm-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_tlm_licenselogs, preprocess_tlm_licenselogs-events, preprocess_tlm_licenselogs-records, or transfer_tlm_licenselogs in the same file and configure the attributes.

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

TLM Log Job Scheduler Instances Configuration

Go to the scheduler directory, which is by default in /var/opt/openit/etc/scheduler, and open collect_license_tlm-logs.oconf.
Locate and set root.scheduler.jobs.collect_tlm_licenselogs.general.active to true to activate the collection of TLM log data.
collect_license_tlm-logs.oconf
```
 13|	}
 14|		general
 15|		{
 16|			active
 17|			{
 18|				type=bool
 19|				value=true
```
Save the changes.

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

TLM 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_tlm-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_tlm-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