Skip to main content
Version: 10.2

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.

warning

Apply the configurations in the Open iT Core Client.

Configuring License Manager Utility Polling​

Open iT polls the license servers at regular intervals to get the current status of its license use and availability.

For this collection, the data source is through an API. The data collector/preprocessor initiates the license status utility every hour using a 5-minute sample interval, triggering the data collection process. The license status utility requests the current license usage data from the license manager portal. After the license manager portal provides the requested data, the license status utility passes this information to the data collector/preprocessor. The data collector/preprocessor processes the data, preparing it for transmission. Finally, the preprocessed data is sent to the Core Server every night, according to the client's timezone, for further storage, completing the license usage data collection and processing.

License Manager Utility Polling Workflow through API

License Manager Utility Polling Workflow through API


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​

Configuring Data Collection​

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

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

  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, 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"
    warning

    Element names cannot contain parentheses ( or ) because they are not valid for XML element names.

  5. Activate the collection of TLM data, run the command:

    Command Syntax
    openit_confinit -c "licpoll.license-types.tlm.active=true"

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

  7. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Advanced Configuration

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

Object NameAccepted ValueDescription
activeBoolean (true or false)Setting this to true activates TLM usage data collection.
typeString (e.g., GenericLicense)The license manager type.
intervalTimespan (e.g., P30S, P5M, P1H)The span of time between each polling round (it is recommended to set a value no less than P1M).
offsetTimespan (e.g., P30S, P5M, P1H)The span of time the aligned poll time decided by interval is shifted.
product-nameString (e.g., server;daemon)This object is defined if a vendor license name other than the default GenericLicense=%hosttype% will be used.
license-serverString (e.g., desktop123win)The license server name.
status-commandFileName (i.e., ${OpeniT.directories.bin}/genlicutil)The binary used to obtain status from the license manager.
status-command.argumentsString (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:

  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_licpoll -# 1

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

An Open iT Core 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 5 minutes. 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

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.

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 debug log file

Configuring Log File Collection​

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

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

  2. 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>
    Sample Log File Content
    2024-09-07 05:05:14 Connect from 10.246.120.190 (user01/DEVICE001) key 1234-5678-9012-3456 - SW16080005062000
    2024-09-07 05:05:14 Valid floating license 1234-5678-9012-3456 - SW16080005062000 ID:2229255772
    2024-09-07 05:16:07 License 1234-5678-9012-3456 detached from ID:2229255772
    2024-09-07 05:52:23 Connect from 10.73.7.42 (user02/DEVICE002) key 1234-5678-9012-3456 - SW16080005062000
    2024-09-07 05:52:23 Valid floating license 1234-5678-9012-3456 - SW16080005062000 ID:919656862
    2024-09-07 06:03:40 Connect from 10.246.43.106 (user03/DEVICE003) key 1234-5678-9012-3456 - SW16080005062000
    2024-09-07 06:03:40 Valid floating license 1234-5678-9012-3456 - SW16080005062000 ID:3973612245
    2024-09-07 06:10:07 Connect from 10.246.48.83 (user04/DEVICE004) key 1234-5678-9012-3456 - SW16080005063000
    2024-09-07 06:10:07 Key for 10.246.48.83 (user04/DEVICE004) changed to 1234-5678-9012-3456 due to access list
    2024-09-07 06:10:07 Valid floating license 1234-5678-9012-3456 - SW16080005063000 ID:2958034473
    2024-09-07 06:11:20 Connect from 10.246.48.75 (user05/DEVICE005) key 1234-5678-9012-3456 - SW16080005063000
    2024-09-07 06:11:20 Key for 10.246.48.75 (user05/DEVICE005) changed to 1234-5678-9012-3456 due to access list
    2024-09-07 06:11:20 Valid floating license 1234-5678-9012-3456 - SW16080005063000 ID:3047207371
    2024-09-07 06:14:07 License 1234-5678-9012-3456 detached from ID:3973612245

  3. Save the changes.

  4. Open a command prompt with Administrator level privileges.

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

  6. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Advanced Configuration

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

Object NameAccepted ValueDescription
source.dirDirName (e.g., C:\tlm\logs)Location of the TLM log files.
source.patternString (i.e., *.log)The glob pattern identifying source files in the source directory.
source.seenString (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.cmplinesInteger (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.dirDirName (i.e., ${OpeniT.directories.temp}/LogFileCollector)This is the location of the directory containing the collected log data.
target.moduleString (i.e., license)The target type of module (in general).
target.datatypeString (i.e., tlm)The specific type of target data.
target.intervalTimespan (e.g., P30S, P5M, P1D)The span of time between collector runs.
target.rotation-sizeInteger (e.g., 6, 10, 20)The log file rotates if it goes beyond the number (in mb) defined.
target.rotation-globString (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.

  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 TLM log data, run the command:

    Command Syntax
    openit_oconfinit -u "collect_license_tlm-logs.root.scheduler.jobs.collect_tlm_licenselogs.general.active=true"
Advanced Configuration

The collection runs every 5 minutes by default. 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 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 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-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.
TLM 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_tlm-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