# Altium365

# Introduction

Open iT supports Altium365 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

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

# Updating Altium365 Configuration with the Altium365 Dashboard Credentials

These steps configure Altium365 to use your credentials.

  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 username and password, run the command:

    Command Syntax
     genlicutil Altium365 /config
  4. Type in the username (or email) when prompted,

    Example: Entering Username
     Enter username to use: sample-config@company.com

    then press Enter.

  5. Type in the password when prompted,

    Example: Entering Password
     Enter password: **********

    then press Enter.

# Configuring Data Collection

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

    Command Syntax
     openit_confinit -c "licpoll.license-types.genericlicense-altium365-sample.active=true"
  5. Update the configuration file, run the command:

    Command Syntax
     openit_confbuilder --client

    Make sure no errors are encountered.

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

Object Name Accepted Value Description
active Boolean (true or false) Setting this to true activates Altium365 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 (i.e., altium365) The arguments used for the status command.
Altium365 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