# Tekla Online

# Introduction

Open iT supports Tekla Online 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

# Setting up Tekla Online Data Collection

These are the required steps to set up data collection from the Tekla Online 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_teklastat --init --username <username> --password <password> 

    where:

    Parameter Description
    --init Use this to set up the Tekla Online portal configuration.
    --username <tekla_username> Use this to specify the username for accessing the Tekla Online portal.
    --password <tekla_password> Use this to specify the password for accessing the Tekla Online portal.
    Parameters for Setting Up Tekla Cloud Data Collection

    Example
    openit_teklastat --init --username jsmith@email.com --password teklaAdm!n123

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

Parameter Description
--authorize-url <authorize_url> Use this to specify Tekla Online's authorization URL.
--identity-api-url <identity-api_url> Use this to validate user identity to initialize authentication.
--auth-state-url <auth-state_url> Use this to get the authorization state for the authentication.
--organization-api <organization_api> Use this to specify the web address for retrieving organization data.
--licenses-api <licenses_api> Use this to specify the web address for retrieving licenses data.
--license-users-api <licenses_users_api> Use this to specify the web address for retrieving license users data.
--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 Tekla Online data, run the command:

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

    Command Syntax
    openit_confbuilder --client

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

Object Name Accepted Value Description
active Boolean (true or false) Setting this to true activates Tekla Online 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%;teklaonline) This object is defined if a product name other than the default %host%;teklaonline will be used.
status-command FileName (e.g., ${OpeniT.directories.bin}/openit_teklastat.exe) The binary used to obtain status from the license manager.
status-command.arguments String (e.g., --debug) The arguments used for the status command.
Leave this blank.
Tekla Online 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