# Hexagon

# Introduction

Open iT supports Hexagon usage reporting through the generic license type format. This will produce the following aggregated data types used for historical and real-time reporting:

The following sections will guide you in setting up the necessary configuration to collect and send the required data to the server.

# Requirements

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

  1. Go to https://licensing.hexagonppm.com/.
  2. Log in with your credentials.
  3. Expand the user menu, then click on API Clients. LicenseAnalyzer Levels
    API Clients
  4. In the bottom-right corner, click on the blue button to add a new Client ID/Secret pair. A pop-up will appear.
  5. In the pop-up window, select 1 day in the token duration, then click OK.
  6. 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.

  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. Set the Client ID and Secret, run the command:

    Command Syntax
     genlicutil Hexagon /config
  4. Type in the generated Client ID when prompted,

    Example: Entering Client ID
     Enter ClientId: client_123456a1-7bcd-8e90-e123-4567f890g12h

    then press Enter.

  5. Type in the generated Client Secret when prompted,

    Example: Entering Client Secret
     Enter ClientSecret: ab1c2de3-45fg-67h8-i901-234567890j01

    then press Enter.

  6. Type in your desired company code when prompted,

    Example: Entering Company Code
     Enter CompanyCode: OpeniT

    then press Enter.

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

  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, copy the object node genericlicense-sample, run the command:

    Command Syntax
     openit_confinit -c "licpoll.license-types.genericlicense-sample=>licpoll.license-types.hexagon"
  5. Activate the collection of Hexagon data, run the command:

    Command Syntax
     openit_confinit -c "licpoll.license-types.hexagon.active=true"
  6. 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.

  7. Update the configuration file, run the command:

    Command Syntax
     openit_confbuilder --client

    Make sure that there are no errors 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 product 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:

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

# Sample Reports

# Historical Reports

Max Available vs Max in Use Licenses per Feature

Max Available vs Max in Use Licenses per Feature

Feature Elapsed Time per User

Feature Elapsed Time per User

# Real-time Report

Drilled Down Feature View

Drilled Down Feature View

# Next Steps?

   Renaming Vendor License    Renaming Features    Create and Add Report    License Monitor

We value your feedback!

Please take a few minutes to complete our survey and share your thoughts on your recent experience with our documentation.

Take survey

Close