Esri Cloud

Introduction

Open iT supports Esri 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 Core Client connected to an Open iT Core Server or a coexistent Open iT Core setup
• Activated LicenseAnalyzer collection and license poller
• Non-SSO Esri cloud account with administrator access to the Esri portal

Configuring License Manager Utility Polling

Open iT polls 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

This will produce the following aggregated data types used for historical reporting:

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

warning

Apply the configurations shown in the Open iT Core Client.

Setting up Esri Cloud Data Collection

These are the required steps to set up data collection from the Esri 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. Set the username and password, run the command:

   Command Syntax

   genlicutil esri /config

4. Type in the root url of the Sharing API to use when prompted.

   Example: Entering Base URL

   Enter Base URL: https://org.arcgis.com

   then press Enter.

5. Type in the username to use for accessing the Sharing API when prompted.

   Example: Entering Username

   Enter username to use: user123

   then press Enter.

6. Type in the password for the user account to be used for accessing the Sharing API when prompted.

   Example: Entering Password

   Enter password: **********

   then press Enter.

   note

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

Configuring 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, copy the object node genericlicense-sample and rename it to your desired name. In this example, we will use esri. Run the command:

   Command Syntax

   openit_confinit -c "licpoll.license-types.genericlicense-sample=>licpoll.license-types.esri"
   warning

   Element names cannot contain parentheses ( or ) because they are not valid for XML element names.

5. Activate the collection of Esri Cloud data, run the command:

   Command Syntax

   openit_confinit -c "licpoll.license-types.esri.active=true"

6. Set the arguments to the status command, run the command:

   Command Syntax

   openit_confinit -c "licpoll.license-types.esri.status-command.arguments=esri"

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

   Command Syntax

   openit_confbuilder --client

   Make sure no errors are encountered.

Advanced Configuration

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

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

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

5. Verify that the Esri.token file exists in the OpeniT directory, which is by default in C:\ProgramData\OpeniT.

Configuring Poll Parsing

Open iT supports Esri Cloud product assignment reporting by poll parsing.

For this collection, the data source is through an API. The license status utility/data preprocessor requests the product assignment information from the license manager portal every midnight, triggering the data collection process. After the license manager portal provides the requested information, the license status utility/data preprocessor processes the data, preparing it for transmission. Finally, the product assignment data is sent to the Core Server for further storage, completing the product assignment data collection and processing.

Product Assignment Data Collection Workflow

This will produce the following aggregated data types used for historical reporting:

• (139) License Subscription Inventory v2
• (140) License Product Assignment v2

warning

Apply the configurations shown in the Open iT Core Client.

Setting up Esri Cloud Data Collection

These are the required steps to set up data collection from the Esri 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_esristat --init --base-url <esri_url> --username <esri_username> --password <esri_password>

   where:

   Parameter	Description
   --init	Use this to set up the Esri portal configuration.
   --base-url <base_url>	Use this to specify the root url of the Sharing API to use.
   --username <esri_username>	Use this to specify the username to use for accessing the Sharing API.
   --password <esri_password>	Use this to specify the password for the user account to be used for accessing the Sharing API.

   Parameters for Setting Up Esri Cloud Data Collection
   
   
   Example

   openit_esristat --init --base-url https://org.arcgis.com/ --username jsmith@email.com --password esriAdm!n123

   This example shows how to specify the necessary authentication credentials for accessing the Sharing API (https://org.arcgis.com/) using the administrator account jsmith@email.com and the password esriAdm!n123.

   note

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

   
   

Optional Parameters

Parameter	Description
--token-url <token_url>	Use this to specify the web address for retrieving token data.
--purchase-url <purchase_url>	Use this to specify the web address for retrieving purchase data.
--user-entitlements-url <user_entitlements_url>	Use this to specify the web address for retrieving user entitlements data.
--user-licenses-types-url <user_licenses_types_url>	Use this to specify the web address for retrieving user licenses types data.
--total-credits-usage-url <total_credits_usage_url>	Use this to specify the web address for retrieving total credits usage data.
--users-url <users_url>	Use this to specify the web address for retrieving group users data.
--self-url <self_url>	Use this to specify the web address for accessing the self source.
--usages	Use this to output usage data.
--assignments	Use this to output assignment data.
--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.

Optional Parameters

Activating Data Collection

These are the required steps to activate the collection of product assignment data.

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. Once in the directory, activate the collection of Esri product assignment data, run the command:

   Command Syntax

   openit_oconfinit -u "collect_license_esri-cloud.root.scheduler.jobs.collect_esri_cloud.general.active=true"

Advanced Configuration

The collection runs every midnight by default. To configure the intervals, locate the instances attribute under collect_esri_cloud, transfer_esri_cloud_raw, or transfer_esri_cloud_parsed in the same file and configure the attributes.

Refer to the Esri Cloud Job Scheduler Instances Configuration table to learn the attributes used to configure Esri 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 the 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: end-oldest - Specify this option to stop/kill the oldest instance and start a new one. end-all-old - Specify this option to stop/kill all running instances before starting the new one. end-new - Specify this option to prevent a new instance from starting.
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.

Esri Job Scheduler Instances Configuration

Verifying Data Collection

After configuration, you can verify that the data is collected and sent to the Core Server by following these steps:

1. Open a command prompt with Administrator level privileges.

2. Go to 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_esristat --assignments

4. Verify that there are assignment-*.data and inventory-*.data files created in the Esri.Cloud directory, which is by default in C:\ProgramData\OpeniT\Data\temp\Esri.Cloud.

Sample Reports

Historical Reports

Max Available vs Max in Use

This sample report compares max in-use licenses against max available licenses.

It offers several key benefits:

• Optimized License Allocation – helps ensure you are not over-purchasing licenses you don't need or under-provisioning.
• Cost Savings – identifies opportunities to downgrade or redistribute licenses, reducing unnecessary expenses.
• Usage Trends & Capacity Planning – shows peak usage patterns, allowing better forecasting for future needs.
• Avoiding Service Disruptions – helps prevent situations where users cannot access software due to reaching the license limit.
• Compliance & Audit Readiness – provides a usage record to ensure compliance with vendor agreements and avoid penalties.
• Performance & Productivity Insights – helps assess whether certain teams or departments are under-utilizing or over-utilizing software.

Max Available vs Max in Use Licenses per Feature

Feature Elapsed Time per User

This sample report gives you helpful insights into software use, performance trends, and user behavior.

It offers several key benefits:

• User Efficiency Analysis – tracks how much time users spend on specific features to help assess productivity.
• Identifying Workflow Issues – highlights any delays or inefficiencies in processes that could be improved.
• Usability & UX Insights – points out features that take longer to use, which could indicate design or functionality improvements.
• Training & Support Guidance – helps identify users who might need extra training to use a feature more effectively.
• Compliance Tracking – makes sure users are spending the right amount of time on regulated tasks.
• Resource & License Optimization – finds underused features or areas where too much time is spent, helping with better resource allocation.

Feature Elapsed Time per User

Real-time Report

This sample report shows a drilled-down feature view of the assigned licenses in use and the licenses available.

Drilled Down Feature View

Next Steps?

Vendor License Renaming

Feature Renaming

Create and Add Report

License Monitor