# AVEVA Cloud

# Introduction

Open iT supports AVEVA Cloud usage reporting. The following sections will guide you on the required configuration for license manager utility polling and poll parsing.

# Requirements

• An Open iT Client connected to an Open iT Server or a coexistent Open iT setup
• Activated LicenseAnalyzer collection and license poller
• Non-SSO AVEVA cloud account with Administrator access to CONNECT

# Setting up AVEVA Cloud Data Collection

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

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_avevastat --init --username <aveva_username> --password <aveva_password>

   where:

   Parameter	Description
   --init	Use this to set up CONNECT configuration.
   --username <aveva_username>	Use this to specify the username for accessing CONNECT.
   --password <aveva_password>	Use this to specify the password for accessing CONNECT.

   Parameters for Setting Up AVEVA Cloud Data Collection
   
   
   Example

   openit_avevastat --init --username jsmith@email.com --password avevaAdm!n123

   This example sets up AVEVA cloud data collection using the administrator account jsmith@email.com with password avevaAdm!n123.

   Open iT saves the hashed AVEVA credential file, avevastat.ini in the OpeniT directory, which is by default in C:\ProgramData\OpeniT.

   Parameter	Description
   --from <YYYY-MM-DDTHH:MM:SS>	Use this to specify the date for which to start collection.
   --to <YYYY-MM-DDTHH:MM:SS>	Use this to specify the date for which to end collection.
   --force	By default, data recollection from the same day is not allowed. However, you can use this parameter to force data collection within your desired --from and --to dates. Note that we do not recommend using this due to the significant risk of data duplication.
   --interval <interval>	Use this to specify the interval of collection in minutes.
   --tz-offset <tz_offset>	Use this to specify the timezone offset.
   --usages	Use this to output usage data.
   --use-package	Use this to use package in generic output.
   --home-page-url <home_page_url>	Use this to specify the CONNECT web address.
   --credits-transactions-url <credits_transactions_url>	Use this to specify the web address for retrieving credit transaction data.
   --contracts-url <contracts_url>	Use this to specify the web address for retrieving contract data.
   --contract-products-url <contract_products_url>	Use this to specify the web address for retrieving contract product data.
   --page-with-token-url <page_with_token_url>	Use this to specify the web address for retrieving token data.
   --products-url <products_url>	Use this to specify the web address for retrieving product data.
   --login-url <login_url>	Use this to specify the web address of the CONNECT log in page.
   --runtime-timeout <runtime_timeout>	Use this to specify the duration for which the binary will run in seconds. Specify a value lower than 300 seconds to avoid conflict with other jobs.
   --requests-timeout <requests_timeout>	Use this to specify the API request timeout in seconds.
   --debug	Use this to turn on debug logging.
   -h, --help	Use this to display help text.

   
   
   To ensure data collection, the period between the --from and --to dates should be at most three (3) months.

# Configuring License Manager Utility Polling

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

• (49) Host User License Use
  
• (93) OLAP Raw Hourly
  
• (94) OLAP User Concurrency
  
• (95) Usergroup License Use v3.0
  
• (102) OLAP Total Use
  

# 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 AVEVA Cloud data, run the command:

   Command Syntax

    openit_confinit -c "licpoll.license-types.genericlicense-aveva-sample.active=true"

5. Run the following command to update the configuration files:

   Command Syntax

   openit_confbuilder --client

   Make sure that there are no errors encountered.

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

Object Name	Accepted Value	Description
active	Boolean (true or false)	Setting this to true activates AVEVA Cloud 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., cloud;avevacloud)	This object is defined if a product name other than the default %host%;avevacloud will be used.
license-server	String (e.g., hou105lin)	The AVEVA License Server name.
status-command	FileName (i.e., ${OpeniT.directories.bin}/openit_avevastat.exe)	The binary used to obtain status from the license manager.
status-command.arguments	String (i.e., --usages)	The arguments used for the status command.

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

# Configuring Poll Parsing

Open iT supports AVEVA Cloud usage reporting by collecting license usage data by polling through another utility from the license server. This will produce the following aggregated data types used for historical and real-time reporting:

• (137) License Token Individual Usage
  
• (138) License Token Total Usage
  

# Activating Data Collection

These are the required steps to activate the collection of usage data.

1. Go to the scheduler directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\scheduler, and open collect_license_aveva-cloud.oconf.

2. Locate and set root.scheduler.jobs.collect_aveva_cloud.general.active to true to activate the collection of AVEVA Cloud data.

   collect_license_aveva-cloud.oconf

    13|	    }
    14|		general
    15|		{
    16|			active
    17|			{
    18|				type=bool
    19|				value=true

3. Save the changes.

The collection runs daily by default. The primary data is then transferred to the server every night according to the client timezone for processing. To configure the intervals, locate the instances attribute under collect_aveva_cloud, transfer_aveva_cloud_raw, or transfer_aveva_cloud_parsed in the same file and configure the attributes.

Refer to the AVEVA Cloud Job Scheduler Instances Configuration table to learn the attributes used to configure AVEVA Cloud usage data collection and transfer.

Attribute Name	Accepted Value	Description
max-instances	Uint (e.g., 5, 8, 9)	The number of instances allowed to run at the same time.
max-handling	String (end-oldest, end-all-old, or end-new)	The action done upon reaching the maximum number of instances. Specify end-oldest to stop/kill the oldest instance and then start the new, specify end-all-old to stop/kill all running instances and then start the new, or specify end-new to not start the new instance.
end-timeout	Timespan (e.g., P30S, P5M, P1H)	The maximum waiting time before terminating a running instance.
quarantine	Timespan (e.g., P30S, P5M, P1H)	The waiting time before starting a new instance after a previous one.

AVEVA Cloud Job Scheduler Instances Configuration

# Verifying Data Collection

After configuration, you can verify that the data is collected and sent to the server 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_executor -r collect_license_aveva-cloud

4. Verify that there are archiver*.in files created in the server in the archiver directory, which is by default in C:\ProgramData\OpeniT\Data\incoming\archiver.

# Sample Reports

# Historical Reports

# Real-time Report

# Next Steps?

   Renaming Vendor License    Renaming Features    Create and Add Report    License Monitor