# Computers and Structures, Inc. (CSI) Cloud

# Introduction

Open iT supports CSI Cloud 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

# Setting up CSI Cloud Data Collection

These are the required steps to set up data collection from the CSI portal.

  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_csistat --init --username <username> --password <password> 

    where:

    Parameter Description
    --init Use this to set up the CSI portal configuration.
    --username <csi_username> Use this to specify the username for accessing the CSI portal.
    --password <csi_password> Use this to specify the password for accessing the CSI portal.
    Parameters for Setting Up CSI Cloud Data Collection

    Example
    openit_csistat --init --username jsmith@email.com --password csiAdm!n123

    This example shows how to specify the necessary authentication credentials for accessing the CSI Cloud using the administrator account jsmith@email.com and the password csiAdm!n123.

Parameter Description
--home-url <home_url> Use this to specify the web address of CSI.
--license-monitor-url <license-monitor_url> Use this to specify the web address for retrieving CSI License Monitor data.
--assets-info-url <assets-info_url> Use this to specify the web address for retrieving asset data.
--usages-info-url-matcher <usages-info-url-matcher_url> Use this to match keywords in CSI License Monitor APIs.
--assets-info-url-matcher <assets-info-url-matcher_url> Use this to match keywords in the CSI asset info APIs.
--show-gui Use this to show the web interface.
--debug Use this to turn on debug logging.
-h, --help Use this to display help text.

# Activating Data Collection

These are the required steps to activate collection of 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, activate the collection of CSI Cloud data, run the command:

    Command Syntax
     openit_confinit -c "licpoll.license-types.genericlicense-csi-sample.active=true"
  5. Run the following command to update the configuration files:

    Command Syntax
    openit_confbuilder --client

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

Object Name Accepted Value Description
active Boolean (true or false) Setting this to true activates CSI Cloud usage data collection.
type String (i.e., 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., %host%;csi) This object is defined if a vendor license name other than the default %host%;csi will be used.
status-command FileName (e.g., ${OpeniT.directories.bin}/openit_csistat.exe) The binary used to obtain status from the license manager.
status-command.arguments String (e.g., --show-gui) The arguments used for the status command.
Leave this blank.
CSI Cloud 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 -# 1
  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