Skip to main content
Version: 10.2

Ensoft License Manager

Introduction​

Open iT supports Ensoft usage reporting by collecting log files and converting 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 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

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.

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

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.

  1. Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and back up the logfilecollector-ensoft.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 Ensoft log files, run the command:

    Command Syntax
    openit_confinit -c "logfilecollector-ensoft.xml.logfilecollector.source.dir=<ensoft_log_dir>"

    where <ensoft_log_dir> is the location of the Ensoft log files.

    Example
    openit_confinit -c "logfilecollector-ensoft.logfilecollector.source.dir=C:\ProgramData\Ensoft"
    Sample Log File Content
    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

  5. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Advanced Configuration

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

Object NameAccepted ValueDescription
source.dirDirName (e.g., C:\ProgramData\Ensoft)Location of the Ensoft 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., ensoft)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.
Ensoft Log File Collection Configuration

Ensoft Events Log File Collection Configuration​

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

warning

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.

  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 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"
Advanced Configuration

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 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.
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 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. To verify the collection of event log data, run the command:

    Command Syntax
    openit_executor -r collect_license_ensoft_event-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.

Ensoft Records Log File Collection Configuration​

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

warning

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.

  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 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"
Advanced Configuration

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

Verifying Record 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. To verify the collection of record log data, run the command:

    Command Syntax
    openit_executor -r collect_license_ensoft_record-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.

Sample Reports​

Historical Reports​

Max Available vs Max in Use​

This sample report compares max in-use licenses against max available licenses. It offers several key benefits:

  • Optimized License Allocation – helps ensure you are not over-purchasing licenses you don't need or under-provisioning.
  • Cost Savings – identifies opportunities to downgrade or redistribute licenses, reducing unnecessary expenses.
  • Usage Trends & Capacity Planning – shows peak usage patterns, allowing better forecasting for future needs.
  • Avoiding Service Disruptions – helps prevent situations where users cannot access software due to reaching the license limit.
  • Compliance & Audit Readiness – provides a usage record to ensure compliance with vendor agreements and avoid penalties.
  • Performance & Productivity Insights – helps assess whether certain teams or departments are under-utilizing or over-utilizing software.

Max Available vs Max in Use Licenses per Feature

Max Available vs Max in Use Licenses per Feature

Feature Elapsed Time per User​

This sample report gives you helpful insights into software use, performance trends, and user behavior. It offers several key benefits:

  • User Efficiency Analysis – tracks how much time users spend on specific features to help assess productivity.
  • Identifying Workflow Issues – highlights any delays or inefficiencies in processes that could be improved.
  • Usability & UX Insights – points out features that take longer to use, which could indicate design or functionality improvements.
  • Training & Support Guidance – helps identify users who might need extra training to use a feature more effectively.
  • Compliance Tracking – makes sure users are spending the right amount of time on regulated tasks.
  • Resource & License Optimization – finds underused features or areas where too much time is spent, helping with better resource allocation.

Feature Elapsed Time per User

Feature Elapsed Time per User

Real-time Reports​

This sample report shows a drilled-down feature view of the online licenses in use and the licenses available.

Drilled Down Feature View

Drilled Down Feature View

Next Steps?​

Vendor License Renaming
Feature Renaming
Create and Add Report
License Monitor