Skip to main content

OpenText Exceed TurboX

Introduction​

Open iT supports OpenText Exceed TurboX usage reporting starting Open iT version 10.2.580.

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 1 hour. 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 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
  • TurboX account with administrator access to the TurboX license portal
  • License server administrative rights

Initializing TurboX Data Collection​

Before configuring data collection, it is necessary to follow the steps below:

  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_turbox --url <turbox_url> --username <turbox_username> --password <turbox_password> --months <number_of_months>

    where:

    ParameterDescription
    --url <turbox_url>Use this to specify the URL of TurboX license server.
    --username <turbox_username>Use this to specify the username for accessing the TurboX license server.
    --password <turbox_password>Use this to specify the password for accessing the TurboX license server.
    --months <number_of_months>Use this to specify the number of months of historical data to be collected.
    Parameters for Initializing Turbox Data Collection

    Example
    openit_turbox --url https://server.company.com --username john_doe@company.com --password turboXAdm!n123 --months 12

    This example initializes TurboX data collection using the administrator account john_doe@company.com with passsword turboXAdm!n123. It is configured to collect 12 months of historical data.

    note

    Open iT saves the hashed TurboX credential file in C:\ProgramData\OpeniT\Data\var\TurboX\etc.

Activating Raw Data Collection​

These are the required steps to obtain raw data from the TurboX server.

  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 raw TurboX data, run the command:

    Command Syntax
    openit_oconfinit -u "collect_license_turbox-raw.root.scheduler.jobs.collect_turbox_licenselogs-raw.general.active=true"

  4. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Configuring Available Licenses for Past Dates​

By default, the system reports the maximum available licenses only for the current date. To include past dates in the report, you need to configure the available-licenses.map file.

  1. Open available-licenses.map in the Configuration directory, which is by default in C:\Program Files\OpeniT\Core\Configuration.

    Notice that it contains instructions on how to edit the file.

  2. Specify the number of available licenses and the date range of the historical data you want to regenerate using the following syntax:

    Mapping Syntax
    MAP: <number_of_licenses> : <from_date> : <to_date>
    TurboX\*;turbox

    where:

    ParameterDescription
    <number_of_licenses>Use this to specify the number of available licenses within the date range.
    <from_date>Use this to specify the starting date of the historical data range to regenerate.
    <to_date>Use this to specify the end date of the historical data range to regenerate.
    Parameters for Configuring Available Licenses for Past Dates

    First Mapping Example
    MAP: 100 : 2025-07-03 : 2025-08-03
    TurboX\*;turbox

    In this example, the number of available licenses for TurboX is set to 100 from July 3, 2025 to August 3, 2025.

    Second Mapping Example
    MAP: 100 : * : 2025-08-03
    TurboX\*;turbox

    In this example, the number of available licenses for TurboX is set to 100, from the earliest available raw data up to August 3, 2025.

  3. Save the changes.

TurboX Event Log File Collection Configuration​

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

Activating Event Log Data Collection​

TurboX event log data collection is active by default. If it is inactive, follow these instructions to activate:

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

    Command Syntax
    openit_oconfinit -u "collect_license_turbox_event-logs.root.scheduler.jobs.collect_turbox_licenselogs-events.general.active=true"
Advanced Configuration

The collection runs every 5 minutes by default. To configure the intervals, update the collect_license_turbox_event-logs.oconf file in the scheduler directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\scheduler. Locate the instances attribute under collect_turbox_licenselogs-events, preprocess_turbox_licenselogs-events, or transfer_turbox_licenselogs-events in the same file and configure the attributes.

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

Verifying Event Log Data Collection​

After configuration, you can verify that the data can be collected and parsed into the Open iT format successfully:

  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. Verify that Open iT can collect raw data, run the command:

    Command Syntax
    openit_logfilecollector -c "<config_dir>\logfilecollector-turbox.conf"

    where <config_dir> is the absolute path to the Configuration directory, which is by default in C:\Program Files\OpeniT\Core\Configuration.

    Example
    openit_logfilecollector -c "C:\Program Files\OpeniT\Core\Configuration\logfilecollector-turbox.conf"

  4. Once done, verify that there are *.status and raw-turbox-license-LogFileCollector*.data files created in the LogFileCollector directory, which is by default in C:\ProgramData\OpeniT\Data\temp\LogFileCollector.

  5. Verify that Open iT can parse the collected raw data to the Open iT format, run the command:

    Command Syntax
    openit_logparsergeneric --srcdir "C:\ProgramData\OpeniT\Data\temp\LogFileCollector" --srcpattern raw-turbox-license-LogFileCollector*.data --srcfilehandling rename --trgdir "C:\ProgramData\OpeniT\Data\temp\LogParserTurboX" --module turbox --datatype event --resolution PT1H --matchobjects "C:\Program Files\OpeniT\Core\Configuration\matchobjects-event-turbox.oconf" --debug warning

  6. Once done, verify that there are event-turbox-LogParserGeneric*.data files created in the LogParserTurboX directory, which is by default in C:\ProgramData\OpeniT\Data\temp\LogParserTurboX.

TurboX Record Log File Collection Configuration​

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

Activating Record Log Data Collection​

TurboX Record Log Data Collection is active by default. If it is inactive, follow these instructions to activate:

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

    Command Syntax
    openit_oconfinit -u "collect_license_turbox_record-logs.root.scheduler.jobs.collect_turbox_licenselogs-records.general.active=true"
Advanced Configuration

The collection runs every 5 minutes by default. To configure the intervals, update the collect_license_turbox_record-logs.oconf file in the scheduler directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\scheduler. Locate the instances attribute under collect_turbox_licenselogs-records, preprocess_turbox_licenselogs-records, or transfer_turbox_licenselogs-records in the same file and configure the attributes.

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

Verifying Record Log Data Collection​

After configuration, you can verify that the data can be collected and parsed into the Open iT format successfully:

  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. Verify that Open iT can collect raw data, run the command:

    Command Syntax
    openit_logfilecollector -c "<config_dir>\logfilecollector-turbox.conf" --target "<temp_dir>\Raw.TurboX.Record"

    where:

    ParameterDescription
    <config_dir>Use this to specify the path to the Configuration directory, which is by default in C:\Program Files\OpeniT\Core\Configuration.
    <temp_dir>Use this to specify the path to the temp directory, which is by default in C:\ProgramData\OpeniT\Data\temp.
    Parameters for Verifying Record Log Data Collection

    Example
    openit_logfilecollector -c "C:\Program Files\OpeniT\Core\Configuration\logfilecollector-turbox.conf" --target "C:\ProgramData\OpeniT\Data\temp\Raw.TurboX.Record"

  4. Once done, verify that there are *.status and raw-turbox-license-logfilecollector*.data files created in the Raw.TurboX.Record directory, which is by default in C:\ProgramData\OpeniT\Data\temp\Raw.TurboX.Record.

  5. Verify that Open iT can parse the collected raw data into the Open iT format, run the command:

    Command Syntax
    openit_logparsergeneric --srcdir "C:\ProgramData\OpeniT\Data\temp\Raw.TurboX.Record" --srcpattern raw-turbox-license-LogFileCollector*.data --srcfilehandling delete --trgdir "C:\ProgramData\OpeniT\Data\temp\LogParserTurboX" --module turbox --datatype record --resolution PT1H --matchobjects "C:\Program Files\OpeniT\Core\Configuration\matchobjects-record-turbox.oconf" --debug warning

  6. Once done, verify that there are record-turbox-LogParserGeneric*.data files created in the LogParserTurboX directory, which is by default in C:\ProgramData\OpeniT\Data\temp\LogParserTurboX.

Sample Reports​

Historical Reports​

License Efficiency​

This sample report gives you helpful insights on how much time a software license has been used. It shows whether licenses are being actively used or left idle, giving you a quick way to understand how efficiently your licenses are being managed.
It offers several key benefits:

  • License Utilization Tracking – monitors how long licenses are in use during a given period and see if any licenses are not being used so they can be reassigned.
  • 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.
  • Compliance & Audit Readiness – provides a usage record to ensure compliance with vendor agreements and avoid penalties.

License Efficiency

License Efficiency

Heatmap​

This sample report provides a visual representation of license usage by day of the week and hour of the day for the selected application.
It offers several key benefits:

  • Peak Usage Identification – highlights the specific days and hours with the highest demand for licenses.
  • Workload Distribution – helps balance activity by identifying underutilized periods where tasks can be scheduled.
  • Resource Planning – supports better allocation of licenses by anticipating peak and off-peak usage times.
  • User Behavior Insights – reveals patterns in how and when users access software, such as evening or weekday activity.
  • Avoiding Bottlenecks – reduces delays by planning critical tasks during low-usage hours.
  • Historical & Predictive Trends – combines weekly usage patterns with historical insights to inform long-term planning and decision-making.

Heatmap

Heatmap

Summary Page to Detail Page​

This sample report provides an overview of application license usage and denial trends over time, offering a clear summary-to-detail view of software utilization.
It offers several key benefits:

  • Comprehensive License Monitoring – delivers a detailed insight into license availability and usage patterns.
  • Denial Detection – identifies instances where license requests exceeded availability, helping pinpoint potential access issues.
  • Usage Trend Analysis – tracks how license consumption fluctuates over time to reveal usage trends and user behavior.
  • Capacity Planning – assists in evaluating whether current license counts are sufficient to meet demand, ensuring optimal resource allocation.
  • Performance Optimization – supports decisions to adjust license pools, improve distribution, and prevent future denials.

License Usage Trend

License Usage Trend

Next Steps?​

Renaming Vendor License
Renaming Features
Analysis Server: License Monitor Portal
Analysis Server: Reporting