# SmartPlant License Manager (SPLM)

# Introduction

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

An Open iT 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

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.

Apply the configurations shown in the Open iT client.

# Requirements

An Open iT Client connected to an Open iT Server or a coexistent Open iT setup
Activated LicenseAnalyzer collection and license poller
License server administrative rights
Running license manager utility binary and its location

# Getting the License Status Utility Binary Location

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

# Through the Interface

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

# Through the Command Line

Open a command prompt with Administrator level privileges.
Run the following command to locate the binary:
Command Syntax
```
 where /r <installation_drive> pdlice
```
where <installation_drive> is the drive where the license manager is installed.
Example
```
 where /r C:\ pdlice
```
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
pdlice

Make sure no errors are encountered.

Run the following command to locate the binary:

Command Syntax
find . | grep pdlice

The path of the binary will be displayed.

# Configuring Data Collection

These are the required steps to activate and configure collection of SPLM 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, activate the collection of SPLM data, run the command:
Command Syntax
```
 openit_confinit -c "licpoll.license-types.splm-sample.active=true"
```
Set the path to the binary used by the SPLM License Server, run the command:
Command Syntax
```
 openit_confinit -c "licpoll.license-types.splm-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.splm-sample.status-command=C:\splm\pdlice"
```
Update the configuration file, run the command:
Command Syntax
```
 openit_confbuilder --client
```
Make sure no errors are encountered.

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

Object Name	Accepted Value	Description
active	Boolean (`true` or `false`)	Setting this to `true` activates SPLM usage data collection.
type	String (i.e., `SPLM`)	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.
license-file	FileName (e.g., `C:\splm\splm_tools\license.dat`)	The filename, including the path, to the SPLM license file. This file is provided by the vendor and is usually in the license manager installation directory.
product-name	String (e.g., `server;daemon`)	This object is defined if a vendor license name other than the default `SPLM=%server%;splm` will be used.
status-command	FileName (e.g., `${OpeniT.directories.bin}/pdlice`)	The binary used to obtain status from the license manager.
status-command.arguments	String (i.e., `-m`)	The arguments used for the status command.

SPLM Data Collection Configuration

These instructions assume your configuration directory is /var/opt/openit/etc.

Go to the Components directory, which is by default in /var/opt/openit/etc/Components, and back up the licpoll.xml configuration file.
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
```

Once in the directory, activate the collection of SPLM data, run the command:

Command Syntax
 ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.splm-sample.active=true"

Set the path to the binary used by the SPLM License Server, run the command:

Command Syntax
 ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.splm-sample.status-command=<binary_path>"

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

Example
 ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.splm-sample.status-command=/var/splm/pdlice"

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

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

Object Name	Accepted Value	Description
active	Boolean (`true` or `false`)	Setting this to `true` activates SPLM usage data collection.
type	String (i.e., `SPLM`)	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.
license-file	FileName (e.g., `/root/splm/splm_tools/license.dat`)	The filename, including the path, to the SPLM license file. This file is provided by the vendor and is usually in the license manager installation directory.
product-name	String (e.g., `server;daemon`)	This object is defined if a vendor license name other than the default `SPLM=%server%;splm` will be used.
status-command	FileName (e.g., `${OpeniT.directories.bin}/pdlice`)	The binary used to obtain status from the license manager.
status-command.arguments	String (i.e., `-m`)	The arguments used for the status command.

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

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_licpoll -# 1
```
Verify that the temp directory, which is by default in /var/opt/openit/temp, contains a LicPoll directory containing .data and status-*.log files.

# Next Steps?

Renaming Vendor License Renaming Features Create and Add Report License Monitor