# Petroleum Experts (PetEx)

# Introduction

Open iT supports Petroleum Experts (PetEx) usage reporting. The following sections will guide you on the required configuration for license manager utility polling and log file parsing.

Apply the configurations in the Open iT client.

# Configuring License Manager Utility Polling

Open iT supports PetEx usage reporting by polling 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

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

Configured PetEx License Server
Host name of the valid IP Address of the PetEx License Server
An Open iT Client connected to an Open iT Server or a coexistent Open iT setup
Activated LicenseAnalyzer collection and license poller

# Configuring Data Collection

These are the required steps to activate and configure collection of PetEx 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, copy the object node genericlicense-sample and rename it to your desired name. In this example, we will use petex. Run the command:
Command Syntax
```
 openit_confinit -c "licpoll.license-types.genericlicense-sample=>licpoll.license-types.petex"
```
Element names cannot contain parentheses ( or ) because they are not valid for XML element names.
Activate the collection of PetEx data, run the command:
Command Syntax
```
 openit_confinit -c "licpoll.license-types.petex.active=true"
```

Set the arguments to the status command, run the command:

Command Syntax
 openit_confinit -c "licpoll.license-types.petex.status-command.arguments=PetEx <servername>"

where <servername> is the host name of the valid IP Address of the PetEx license server.

Example
 openit_confinit -c "licpoll.license-types.petex.status-command.arguments=PetEx hou150win"

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

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

Object Name	Accepted Value	Description
active	Boolean (`true` or `false`)	Setting this to `true` activates PetEx usage data collection.
type	String (e.g., `GenericLicense`)	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.
product-name	String (e.g., `server;daemon`)	This object is defined if a vendor license name other than the default `GenericLicense=%hosttype%` will be used.
license-server	String (e.g., `hou105win`)	The License Server name.
status-command	FileName (i.e., `${OpeniT.directories.bin}/genlicutil`)	The binary used to obtain status from the license manager.
status-command.arguments	String (e.g., `PetEx hou150win`)	The arguments used for the status command. Use the format `PetEx <servername>`.

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

Continue reading if you need to configure log file parsing. If not, here are some suggested readings.

# Configuring Log File Parsing

Open iT supports PetEx usage reporting by collecting log files and converting them to Open iT format.

An Open iT 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 3 hours. 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

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

(89) Total License Use Licenseevents
(90) Individual License Use Licenseevents
(91) Usergroup License Use Licenseevents
(108) Host License Use Licenseevents
(109) Hostgroup License Use Licenseevents

# Requirements

An Open iT Client connected to an Open iT Server or a coexistent Open iT 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 PetEx log files.

Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and back up the logfilecollector-hasp2.xml 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, set the location of the PetEx log files, run the command:
Command Syntax
```
 openit_confinit -c "logfilecollector-hasp2.logfilecollector.source.dir=<petex_log_dir>"
```
where <petex_log_dir> is the location of the PetEx log files.

Use semicolons(;) as separators to include multiple log file directories.
Example
```
 openit_confinit -c "logfilecollector-hasp2.logfilecollector.source.dir=C:\Users\user1\Petex\home\logs;C:\Users\user1\Petex\logs"
```
Update the configuration file, run the command:
Command Syntax
```
 openit_confbuilder --client
```
Make sure no errors are encountered.

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

Object Name	Accepted Value	Description
source.dir	DirName (e.g., `C:\Users\user1\Petex\home\logs`)	Location of the PetEx log files.
source.pattern	String (i.e., `*.log`)	The glob pattern identifying source files in the source directory.
source.seen	String (`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.cmplines	Integer (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.dir	DirName (i.e., `${OpeniT.directories.temp}/LogFileCollector`)	This is the location of the directory containing the collected log data.
target.module	String (i.e., `license`)	The target type of module (in general).
target.datatype	String (i.e., `haspevents2`)	The specific type of target data.
target.interval	Timespan (e.g., `P30S`, `P5M`, `P1D`)	The span of time between collector runs.
target.rotation-size	Integer (e.g., `6`, `10`, `20`)	The log file rotates if it goes beyond the number (in mb) defined.
target.rotation-glob	String (e.g., `*`)	The glob pattern to match before the log file rotates.

PetEx Log File Collection Configuration

# Activating Event Log Data Collection

These are the required steps to activate collection of PetEx event log data.

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

Command Syntax
 openit_oconfinit -u "collect_license_hasp2_event-logs.root.scheduler.jobs.collect_hasp2_licenselogs_event.general.active=true"

The collection runs every 3 hours by default. To configure the intervals, locate the instances attribute under collect_hasp2_licenselogs_event, preprocess_hasp2_licenselogs-events, or transfer_hasp2_licenselogs-event in the same file and configure the attributes.

Refer to the PetEx Event Log Job Scheduler Instances Configuration table to learn the attributes used to configure PetEx events data collection and transfer.

Attribute Name	Accepted Value	Description
max-instances	Uint (e.g., `5`, `8`, `9`)	The number of instances allowed to run at the same time.
max-handling	String (`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-timeout	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The maximum waiting time before terminating a running instance.
quarantine	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The waiting time before starting a new instance after a previous one.

PetEx Event Log Job Scheduler Instances Configuration

# Activating Record Log Data Collection

These are the required steps to activate collection of PetEx record log data.

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

Command Syntax
 openit_oconfinit -u "collect_license_hasp2_record-logs.root.scheduler.jobs.collect_hasp2_licenselogs_record.general.active=true"

The collection runs every 3 hours by default. To configure the intervals, locate the instances attribute under collect_hasp2_licenselogs_record, preprocess_hasp2_licenselogs-records, transfer_hasp2_licenselogs-record, or transfer_hasp2_licenselogs-raw in the same file and configure the attributes.

Refer to the PetEx Record Log Job Scheduler Instances Configuration table to learn the attributes used to configure PetEx events data collection and transfer.

Attribute Name	Accepted Value	Description
max-instances	Uint (e.g., `5`, `8`, `9`)	The number of instances allowed to run at the same time.
max-handling	String (`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-timeout	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The maximum waiting time before terminating a running instance.
quarantine	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The waiting time before starting a new instance after a previous one.

PetEx Record Log Job Scheduler Instances Configuration

# Verifying Log 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_logfilecollector -c "C:\Program Files\OpeniT\Core\Configuration\logfilecollector-hasp2.conf" --target "C:\Program Files\OpeniT\Core\Log\temp\Raw.Hasp2.Event"

Verify that there are *.data files created in the Raw.Hasp2.Event directory, which is by default in C:\Program Files\OpeniT\Core\Log\temp\Raw.Hasp2.Event.

# Next Steps?

Renaming Vendor License Renaming Features Create and Add Report License Monitor