Skip to main content
Version: 10.2

SciTool (STI) License Manager

Introduction​

Open iT supports STI usage reporting by polling the license servers at regular intervals to get the current status of its license use and availability.

An Open iT Core Client is installed on your license server for this collection. The data collector/preprocessor gathers the current license usage information from the license manager every hour using a 5-minute sample interval, triggering the data collection process. It also processes the gathered license usage. Once the data is preprocessed, it is transmitted to the Core Server, according to the client's timezone, for further storage, completing the license usage data collection and processing.

License Manager Utility Polling Workflow

License Manager Utility Polling 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.

warning

Apply the configurations shown in the Open iT Core Client.

Requirements​

Getting the License Status Utility Binary Location​

This configuration requires the path to the license status utility binary, almstatus, to obtain the license status information. Get this by following these steps:

Through the Interface​

  1. Open the Task Manager.
  2. Go to the Details tab.
  3. Locate almstatus.
  4. Right-click and choose Open file location.
    The path of the binary will be displayed.

Through the Command Line​

  1. Open a command prompt with Administrator level privileges.

  2. Run the following command to locate the binary:

    Command Syntax
    where /r <installation_drive> almstatus

    where <installation_drive> is the drive where the license manager is installed.

    Example
    where /r C:\ almstatus

    The path of the binary will be displayed.

After verifying the path of the polling program, make sure that it is running.
Open a command prompt in the directory of the license server executable or the polling program and run the following command:

Command Syntax
almstatus

Make sure no errors are encountered.

Configuring Data Collection​

These are the required steps to activate and configure collection of STI 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, activate the collection of STI data, run the command:

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

  5. Set the STI license file location, run the command:

    Command Syntax
    openit_confinit -c "licpoll.license-types.sti-sample.license-file=<sti-license-file>"

    where <sti-license-file> is the filename, including the path, of the STI license file.

    Example
    openit_confinit -c "licpoll.license-types.sti-sample.license-file=C:\sti\sti_tools\LICENSE"

  6. Set the path to the binary used by the STI license server, run the command:

    Command Syntax
    openit_confinit -c "licpoll.license-types.sti-sample.status-command=<binary_path>"

    where <binary_path> is the obtained path in Getting the License Status Utility Binary Path.

    Example
    openit_confinit -c "licpoll.license-types.sti-sample.status-command=C:\sti\almstatus"

  7. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Advanced Configuration

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

Object NameAccepted ValueDescription
activeBoolean (true or false)Setting this to true activates STI usage data collection.
typeString (i.e., STI)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 STI=%server%;sti will be used.
license-fileFileName (e.g., C:\sti\ sti_tools\LICENSE)The filename, including the path, to the STI license file. This file is provided by the vendor and is usually in the license manager installation directory.
status-commandFileName (e.g., ${OpeniT. directories.bin}/ almstatus)The binary used to obtain status from the license manager.
status-command.argumentsString (i.e., -l $license -a)The arguments used for the status command.
STI 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.

Next Steps?​

Renaming Vendor License
Renaming Features
Create and Add Report
License Monitor