# Hexagon

# Introduction

Open iT supports Hexagon 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.

Apply the configurations 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
Configured Hexagon license server
License server administrative rights
Generated Client ID and Client Secret from Hexagon

# Configuring Hexagon with Client ID and Client Secret

# Generating Client ID and Client Secret

These steps generate a Client ID and Client Secret required to read data from the Integraph Smart Licensing Cloud via its API.

Go to https://licensing.hexagonppm.com/.
Log in with your credentials.
Expand the user menu, then click on API Clients.
API Clients
In the bottom-right corner, click on the blue button to add a new Client ID/Secret pair. A pop-up will appear.
In the pop-up window, select 90 days in the token duration, then click OK.
Take note of the Client ID and Secret.

# Updating Hexagon Configuration to use Generated Client ID and Client Secret

These steps configure Hexagon to use your generated Client ID and Client Secret.

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
```
Set the Client ID and Secret, run the command:
Command Syntax
```
 genlicutil Hexagon /config
```
Type in the generated Client ID when prompted,
Example: Entering Client ID
```
 Enter ClientId: client_123456a1-7bcd-8e90-e123-4567f890g12h
```
then press Enter.
Type in the generated Client Secret when prompted,
Example: Entering Client Secret
```
 Enter ClientSecret: ab1c2de3-45fg-67h8-i901-234567890j01
```
then press Enter.
Type in your desired company code when prompted,
Example: Entering Company Code
```
 Enter CompanyCode: OpeniT
```
then press Enter.

Confirm if the entries are correct,

Example: Confirm Entries
 ClientId: client_123456a1-7bcd-8e90-e123-4567f890g12h
 ClientSecret: ab1c2de3-45fg-67h8-i901-234567890j01
 CompanyCode: OpeniT

then press Enter.

# Configuring Data Collection

These are the required steps to activate and configure collection of Hexagon 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 hexagon. Run the command:
Command Syntax
```
 openit_confinit -c "licpoll.license-types.genericlicense-sample=>licpoll.license-types.hexagon"
```
Element names cannot contain parentheses ( or ) because they are not valid for XML element names.
Activate the collection of Hexagon data, run the command:
Command Syntax
```
 openit_confinit -c "licpoll.license-types.hexagon.active=true"
```
Set the arguments to the status command, run the command:
Command Syntax
```
 openit_confinit -c "licpoll.license-types.hexagon.status-command.arguments=hexagon"
```
If you want to separate the usage data per keystore, run the command:
Command Syntax
```
 openit_confinit -c "licpoll.license-types.hexagon.status-command.arguments=hexagon /divided"
```
This includes the keystore information in the vendor license names (e.g., host557;hexagon (keystore_name 1) ) in historical and real-time reports.
Update the configuration file, run the command:
Command Syntax
```
 openit_confbuilder --client
```
Make sure no errors are encountered.

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

Object Name	Accepted Value	Description
active	Boolean (`true` or `false`)	Setting this to `true` activates Hexagon 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., `hexagon /divided`)	The arguments used for the status command.

Hexagon 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 -# 12
```
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.

# Hexagon

# Introduction

# Requirements

# Configuring Hexagon with Client ID and Client Secret

# Generating Client ID and Client Secret

# Updating Hexagon Configuration to use Generated Client ID and Client Secret

# Configuring Data Collection

# Verifying Data Collection

# Sample Reports

# Historical Reports

# Real-time Report

# Next Steps?