# SketchUp

# Introduction

Open iT supports SketchUp 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.

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
  

The following sections will guide you in setting up the necessary configuration to collect and send the required data to the server.

# 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 account with Administrator access to the Trimble Account Management Portal (AMP)

# Setting up SketchUp Data Collection

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

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_sketchupstat --init --username <amp_username> --password <amp_password> 

   where:

   Parameter	Description
   --init	Use this to set up the AMP configuration.
   --username <amp_username>	Use this to specify the username for accessing the AMP.
   --password <amp_password>	Use this to specify the password for accessing the AMP.

   Parameters for Setting Up SketchUp Data Collection
   
   
   Example

   openit_sketchupstat --init --username jsmith@email.com --password sketchupAdm!n123

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

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

Parameter	Description
--token-url <token_url>	Use this to specify the token URL.
--identity-api-url <identity_api_url>	Use this to specify the identity API URL.
--auth-state-url <auth_state_url>	Use this to specify the authorization state URL.
--details-api <details_api>	Use this to specify the details' API URL.
--products-api <products_api>	Use this to specify the products' API URL.
--users-api <users_api>	Use this to specify the users' API URL.
--licenses-api <licenses_api>	Use this to specify the licenses' API URL.
--activations-api <activations_api>	Use this to specify the activations' API URL.
--member-ids-api <members_ids_api>	Use this to specify the member IDs' API URL.
--users-info-api <users_info_api>	Use this to specify the users' info API URL.
--invitations-api <invitations_api>	Use this to specify the invitations' API URL.
--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 SketchUp data, run the command:

   Command Syntax

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

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

   Command Syntax

   openit_confbuilder --client

   Make sure no errors are encountered.

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

Object Name	Accepted Value	Description
active	Boolean (true or false)	Setting this to true activates SketchUp 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%;sketchup)	This object is defined if a vendor license name other than the default %host%;sketchup will be used.
status-command	FileName (e.g., ${OpeniT.directories.bin}/openit_sketchupstat.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.

SketchUp 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

# Real-time Report

# Next Steps?

   Renaming Vendor License    Renaming Features    Create and Add Report    License Monitor