Intergraph Smart Licensing

User's Guide
Version 2019 (14.0) - Updated
March 2019/June 2019
Copyright
Copyright © 2017-2019 Hexagon AB and/or its subsidiaries and affiliates. All rights reserved.
This computer program, including software, icons, graphic symbols, documentation, file formats, and audio-visual displays; may be
used only as pursuant to applicable software license agreement; contains confidential and proprietary information of Hexagon AB
and/or third parties which is protected by patent, trademark, copyright law, trade secret law, and international treaty, and may not be
provided or otherwise made available without proper authorization from Hexagon AB and/or its subsidiaries and affiliates.
Portions of the user interface copyright 2018-2019 Telerik AD.

U.S. Government Restricted Rights Legend

Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the
United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Hexagon PPM
305 Intergraph Way
Madison, AL 35758

Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.

Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, box.net, or the Hexagon PPM documentation web site, any documentation related to work processes, workflows, and
best practices that is provided by Intergraph as guidance for using a software product.

Terms of Use
a. Use of a software product and Documentation is subject to the Software License Agreement ("SLA") delivered with the software
product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the Licensee has
a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take precedence and
govern the use of this software product and Documentation. Subject to the terms contained within the applicable license
agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the Documentation as
defined in the applicable license agreement and delivered with the software product for Licensee's internal, non-commercial
use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a SLA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial use. The Other Documentation
may not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and
for any reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the SLA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.

Intergraph Smart Licensing User's Guide 2

Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.

Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.

Export Controls
Intergraph Corporation’s commercial-off-the-shelf software products, customized software and/or third-party software, including any
technical data related thereto (“Technical Data”), obtained from Intergraph Corporation, its subsidiaries or distributors, is subject to
the export control laws and regulations of the United States of America. Diversion contrary to U.S. law is prohibited. To the extent
prohibited by United States or other applicable laws, Intergraph Corporation software products, customized software, Technical Data,
and/or third-party software, or any derivatives thereof, obtained from Intergraph Corporation, its subsidiaries or distributors must not
be exported or re-exported, directly or indirectly (including via remote access) under the following circumstances:
a. To Cuba, Iran, North Korea, the Crimean region of Ukraine, or Syria, or any national of these countries or territories.
b. To any person or entity listed on any United States government denial list, including, but not limited to, the United States
Department of Commerce Denied Persons, Entities, and Unverified Lists, the United States Department of Treasury Specially
Designated Nationals List, and the United States Department of State Debarred List
(https://build.export.gov/main/ecr/eg_main_023148).
c. To any entity when Customer knows, or has reason to know, the end use of the software product, customized software,
Technical Data and/or third-party software obtained from Intergraph Corporation, its subsidiaries or distributors is related to the
design, development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or
sensitive nuclear uses.
d. To any entity when Customer knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export/re-export of relevant Intergraph Corporation software product, customized software, Technical Data
and/or third-party software obtained from Intergraph Corporation, its subsidiaries or distributors, should be addressed to PPM’s
Export Compliance Department, 305 Intergraph Way, Madison, Alabama 35758 USA or at [email protected].
Customer shall hold harmless and indemnify PPM and Hexagon Group Company for any causes of action, claims, costs, expenses
and/or damages resulting to PPM or Hexagon Group Company from a breach by Customer.

Trademarks
Intergraph®, the Intergraph logo®, Intergraph Smart®, SmartPlant®, SmartMarine, SmartSketch®, SmartPlant Cloud®, PDS®,
FrameWorks®, I-Route, I-Export, ISOGEN®, SPOOLGEN, SupportManager®, SupportModeler®, SAPPHIRE®, TANK, PV Elite®,
CADWorx®, CADWorx DraftPro®, GTSTRUDL®, CAESAR II® , and HxGN SDx® are trademarks or registered trademarks of
Intergraph Corporation or its affiliates, parents, subsidiaries. Hexagon and the Hexagon logo are registered trademarks of Hexagon
AB or its subsidiaries. Microsoft and Windows are registered trademarks of Microsoft Corporation. Other brands and product names
are trademarks of their respective owners.

Intergraph Smart Licensing User's Guide 3

Contents
Preface .......................................................................................................................................................... 7
Smart Licensing documentation.............................................................................................................. 7

Welcome to Smart Licensing ..................................................................................................................... 8

What's New in Smart Licensing? ............................................................................................................ 8

Getting Started ........................................................................................................................................... 10

Smart Licensing Basics ............................................................................................................................ 11

Find your way around Smart Licensing Client ...................................................................................... 11
Compare features between SmartPlant License Manager and Smart Licensing ................................. 12

Client Settings ........................................................................................................................................... 14

Change project or client settings........................................................................................................... 14

Checkout .................................................................................................................................................... 15
Check out licenses ................................................................................................................................ 15
Check in licenses .................................................................................................................................. 16

Client Configurations ................................................................................................................................ 17

Add a configuration connection ............................................................................................................. 19
Edit a configuration connection ............................................................................................................. 19

Licensing Status ........................................................................................................................................ 21

View status of licensing services and keystores ................................................................................... 21

Licensing History ...................................................................................................................................... 22

View and export licensing history.......................................................................................................... 22

Updating Smart Licensing ........................................................................................................................ 23

Update client software .......................................................................................................................... 23

Frequently Asked Questions (FAQs) ....................................................................................................... 24

License Reservation and Release ........................................................................................................ 24
Can I test license reservation and release in Smart Licensing? .................................................... 24
My application stopped responding. Do I need to restart my client to release the
license back to Smart Licensing? ................................................................................................... 24
How does scavenging happen in Smart Licensing? ...................................................................... 24
How long does it take to return a license after an application crashes? ........................................ 25
Checkout ............................................................................................................................................... 25

Intergraph Smart Licensing User's Guide 4

 Contents

Can I check out a license for a virtual machine by Remote Desktop Connection?
Are there any limitations? ............................................................................................................... 25
Can I check out a license from a keystore with a pending key? .................................................... 25
When exactly does a checked out license expire? ........................................................................ 25
I do not see my product listed on the Check Out tab. How can I check out a
license? .......................................................................................................................................... 25
I checked out a license using Smart Licensing checkout and was using the
license offline, and then my application stopped responding. Do I need to
scavenge the checked out license to reuse it? .............................................................................. 25
Can I install Smart Licensing Client and SmartPlant License Manager Checkout
Utility on the same computer? ........................................................................................................ 26
User A checked out a license using Smart Licensing. Can User B check in the
license from the same device? ....................................................................................................... 26
How does Smart Licensing Client checkout differ from SmartPlant License
Manager Checkout Utility? ............................................................................................................. 26
I'm using a legacy application that isn't built with Smart Licensing. Can I use
Smart Licensing for checkout? ....................................................................................................... 26
Keys ...................................................................................................................................................... 27
How many pending keys can be loaded into a keystore? .............................................................. 27
Can I get a key in advance if I use Smart Licensing? .................................................................... 27
Projects ................................................................................................................................................. 27
In what order are projects displayed on the Client Settings tab? ................................................... 27
Why is my license request showing an unexpected project? ......................................................... 27
What should I do if I get a "Project is invalid" message? ............................................................... 27
Configuration Connection Info (.CCI) Files ........................................................................................... 28
Can anyone use the configuration connection info (.cci) file to get a license? Are
there any permissions or restrictions? ............................................................................................ 28
My configuration connection info (.cci) file has more than one license type
(mechanism) for my product. What is the order of license types? ................................................. 28
How often are changes to configurations pushed to client computers?......................................... 28
Environment Variables .......................................................................................................................... 28
Does Smart Licensing support the use of environment variables? ................................................ 28
Are environment variables in Smart Licensing case-sensitive? ..................................................... 29
How do the SPLM environment variables map to the columns on the Current
License Usage page in the Portal? ................................................................................................ 29
Why are the values on the Current License Usage page different from the values
in the environment variables? ........................................................................................................ 29
Citrix and Virtual Environments............................................................................................................. 30
I am using Citrix and crossing multiple time zones. Are there any limitations in this
situation? ........................................................................................................................................ 30
Does Smart Licensing support virtual environments? .................................................................... 30
Licensing Portal..................................................................................................................................... 30
Can I use any version of Smart Licensing Client with the Licensing Portal? ................................. 30
How do I monitor license usage? ................................................................................................... 30
Why is the Login User value on the Current License Usage page not the same as
the Login User value found in Smart Licensing Client? ................................................................. 30
SmartPlant License Manager (SPLM) .................................................................................................. 31
Can I continue to use SmartPlant License Manager (SPLM) for licensing? .................................. 31
How do I switch from SmartPlant License Manager (SPLM) to Smart Licensing? ........................ 31
I have SmartPlant License Manager (SPLM) Client installed on my computer. Can
I install Smart Licensing on the same computer and use both? .................................................... 31

Intergraph Smart Licensing User's Guide 5

 Contents

Miscellaneous ....................................................................................................................................... 31
Do I need to turn the Windows firewall off to work with Smart Licensing? ..................................... 31
Is virus scan software allowed to run on Smart Licensing clients? ................................................ 31
Which ports need to be open for Smart Licensing? ....................................................................... 32
Is there a way to stop getting the message about an expired license? ......................................... 32

Troubleshooting ........................................................................................................................................ 33
Troubleshoot the licensing environment ............................................................................................... 33
Connectivity issues with licensing .................................................................................................. 34
How to find my user name, computer name, and device identifier to troubleshoot
licensing .......................................................................................................................................... 34
Checked out license expired and cannot obtain another one ............................................................... 35
Checkout in a virtual environment......................................................................................................... 35
Connection Authentication box asking for a password ......................................................................... 35
Messages about "SmartPlant License Manager" or "SPLM" ................................................................ 35
Status tab shows services down ........................................................................................................... 36
Unable to check in a license ................................................................................................................. 36
Unable to check out a license ............................................................................................................... 36
Unable to obtain a license ..................................................................................................................... 37
Unable to load configuration connection info (.cci) file ......................................................................... 37
Unable to open application using launch option ................................................................................... 39

Command Line Options for Smart Licensing ......................................................................................... 40

Command line options for loading or removing configuration connection info (.cci) files ..................... 40
Command line options for launching the client ..................................................................................... 42
Command line options for downloading and installing latest client ...................................................... 44

Acronyms ................................................................................................................................................... 46

Glossary ..................................................................................................................................................... 47

Index ........................................................................................................................................................... 50

Intergraph Smart Licensing User's Guide 6

Preface
This document provides conceptual information and procedural instructions for Intergraph
Smart® Licensing. The content is the same as the online Help delivered as part of Smart
Licensing.

Smart Licensing documentation

Smart Licensing documentation is available as Help and as PDF files. To view printable guides
for Smart Licensing, open the help, and then open the Printable Guides topic.
We give our customers permission to print as many copies of the delivered PDF files as they
need for their non-commercial use. Do not print the PDF files for resale or redistribution.

Release bulletin
Intergraph Smart Licensing Release Bulletin - Describes the new features in the current release
of Smart Licensing.

Installation and setup guide

Intergraph Smart Licensing Installation and Setup Guide - Provides installation and setup
instructions for Smart Licensing administrators.
Intergraph Smart Licensing Installation and Setup Checklist - Presents the installation and setup
instructions for Smart Licensing in an easy-to-use grid. A Microsoft Excel version is also
provided so that you can create a custom checklist to better match your business processes.

User's guide
Intergraph Smart Licensing User's Guide - Provides information and instructions to help users
work in Smart Licensing Client.

Troubleshooting guide
Intergraph Smart Licensing Network Connectivity Troubleshooting Guide - Contains information
to troubleshoot the connection to Smart Licensing services.

Customer Support
For the latest support information for this product, use a web browser to connect to
http://hexagonppm.com/ppm-support (http://hexagonppm.com/ppm-support). Also, you can
submit any documentation comments or suggestions you might have on our support site.

Intergraph Smart Licensing User's Guide 7

SECTION 1

Welcome to Smart Licensing

is the next-generation software licensing product for Hexagon PPM.
Smart Licensing Cloud contains servers with license keys. The cloud is connected to a portal
web site, which can be accessed from a browser anywhere there is an internet connection.
License administrators use the portal to set up configurations and generate license keys.
Configurations control how users access licenses.
Smart Licensing Client is a small application that must be installed on each client computer
where a licensed application is running. A client computer is connected to the cloud for licensing
using a configuration connection info (.cci) (page 47) file.

What's New in Smart Licensing?

Version 2019 (14.0) - Update 1
▪ In the Smart Licensing Client, the Status tab appearance has changed. Keystores are now
listed in the order defined in Smart Licensing Portal, and you can no longer sort the list.
Also, the section has been renamed to Keystore Order for Project. These changes help
users understand that they cannot change which keystores are used for a project, or the
order they are used in. (CR-PB-211571)
▪ In the Smart Licensing Client, the status of the Software Delivery service is now reported on
the Status tab. This service is a download service used to deliver the latest version of the
client for users to update. (CR-PB-214913)

Intergraph Smart Licensing User's Guide 8

 Welcome to Smart Licensing

Version 2019 (14.0)

▪ Smart Licensing is now available to all customers.

Version 2018 (13.0)

▪ Smart Licensing is a new product from Hexagon PPM. This is the beta release.

Intergraph Smart Licensing User's Guide 9

SECTION 2

Getting Started
To get started in Smart Licensing:
1. Install Smart Licensing Client. For more information, see the .
2. Load a configuration connection info (.cci) file, if not loaded during installation. See Client
Configurations (on page 17).
3. Start your licensed application.

Intergraph Smart Licensing User's Guide 10

SECTION 3

Smart Licensing Basics

This section helps you get started in Smart Licensing Client and shows you some of the basics
of using the software.

Find your way around Smart Licensing Client

After opening Smart Licensing Client, you can easily view and change settings as well as check
licenses in or out.

Click To see What it does

Client Settings Project and custom fields Displays the currently selected project
and a table of custom fields and their
values. You can select a different
project and choose different values.
The administrator specifies
custom fields in the Licensing Portal.

Check Out Products with checkout-able Allows you to select a product and enter
licenses for offline use the number of licenses and length of
time for checkout.

Check In List of checked out licenses Displays information for each checked-
out license, including product, version,
expiration, and if the product is in use.

Configuration List of configurations Allows you to load a configuration

connection info (.cci) file, which affects
your client settings and products
available for checkout.

Status Connectivity status Displays connection information for

licensing services and keystores.

History Notification messages Provides a notifications log, which

includes date, time, username,
obfuscated username, and message
text. You can export the information to a
.csv (comma-separated values) file.

Intergraph Smart Licensing User's Guide 11

 Smart Licensing Basics

Compare features between SmartPlant License

Manager and Smart Licensing
The following table compares features in the previous licensing solution, SmartPlant License
Manager (SPLM), and the current licensing solution, Smart Licensing. In general, Smart
Licensing provides more features and enhanced usage reporting.

SmartPlant License Manager Smart Licensing

Checkout Utility (SPLMCU) Checkout tab

The Checkout Utility for SmartPlant License
Manager required a separate installation; in
Smart Licensing, the checkout feature is
included with the licensing client installation.
Not all products have checkout-
able licenses. Only products with checkout-
able licenses appear on the Checkout tab in
Smart Licensing.

Daily license options In the Smart Licensing Portal, daily license

usage can be controlled by creating a
keystore with only daily licenses and then
adding or removing the keystore to/from a
configuration as needed.

Key file A key file is no longer necessary. Generating

a key in the Portal automatically loads the
key.

License server or machine In SmartPlant License Manager, the server

contained one key. In Smart Licensing, the
cloud server contains multiple keystores, each
with its own active key. In a sense, a keystore
is analogous to a SPLM server.
In Smart Licensing, you do not
need to allocate a separate computer to be a
license server. Keystores reside in the
Hexagon PPM cloud.

Log file No equivalent, but the History tab in Smart

Licensing Client shows a historical record of
all messages sent to that client. Peak usage
and total usage reports are an enhancement
to the SPLM log file and are available in the
Smart Licensing Portal, under Reports.

Intergraph Smart Licensing User's Guide 12

 Smart Licensing Basics

SmartPlant License Manager Smart Licensing

Report Utility (SPLMRU) In Smart Licensing, there is no need to upload

journal files. Peak usage and total usage
reports are available in the Smart Licensing
Portal, under Reports.

Scavenging There is no need for scavenging in Smart

Licensing. Licenses are returned
automatically when they are no longer in use.

Stacked keys Anytime a key is generated, it is immediately

loaded with a Pending status and will become
active on the specified start date.

Test Seat Reservation No equivalent, but you can check the Status
tab and History tab in Smart Licensing Client
Test Seat Release
for connectivity information and license-
related messages, respectively.
Your administrator can also check the
Current License Usage report in the Smart
Licensing Portal.

Intergraph Smart Licensing User's Guide 13

SECTION 4

Client Settings
In Smart Licensing Client, you can change projects and settings as you do your daily work. For
example, you might work for a while in a certain project and then switch to a different project.
This information can be tracked for accounting or billing purposes.

▪ In order to specify client settings in Smart Licensing Client, your administrator must set up
configurations. For more information, contact your licensing administrator.
▪ Changes made on the Client Settings tab apply to the current user logged onto the
computer. If your product is not using the currently logged-on user name in license requests,
any changes you make on this tab are not relevant.
▪ Smart Licensing reads environment variables and displays the values you have set. If the
project or a client setting was set using an environment variable, you will not be able to
change that value on the Client Settings tab.

Change project or client settings

Why would I change the project or settings?
The project and settings are used for accounting and billing. You should update the project and
settings before you start working or whenever you switch projects.

1. On the Client Settings tab, in the Project list, select the project you'll be working on.
By default, the list at the top of the Client Settings tab is labeled Project.
However, it's possible that the label above this list is something else, such as Site. Your
licensing administrator can change the label text in the Licensing Portal.
2. Make selections in the Value column of the grid.
Examples:

Name Value

Department 3581

Location Huntsville

3. Click Save.

Intergraph Smart Licensing User's Guide 14

SECTION 5

Checkout
In Smart Licensing Client, you can check licenses out when you're going to be working offline.
When you're back online, you can check the licenses back in.
The check out and check in operations that you do in Smart Licensing Client apply to all users
on a device, which can be a physical computer or a virtual computer.

Checkout and virtual environments

▪ Checkout is supported on Hyper-V, XenServer, and VMware ESXi. However, checkout is
not supported in all virtual environments.
▪ If licenses are checked out on a virtual machine in the cloud, such as Microsoft Azure, be
sure to shut down the virtual machine in Windows before stopping the machine in the cloud.
Otherwise, the checked out licenses may be lost and not available for use until they have
expired.

▪ With Smart Licensing Client, you no longer need to use the SmartPlant License Manager
(SPLM) Checkout Utility.
▪ Environment variables are not honored when licenses are checked out.

What do you want to do?

▪ Check out licenses (on page 15)
▪ Check in licenses (on page 16)

Check out licenses

Why do I need to check out a license?
Checking out a license allows you to work in the licensed application when your computer is not
connected to the license service. You should check out a license any time you will need to use
the licensed application without an Internet connection.

1. In Smart Licensing Client, click Check Out.

2. Type the number of licenses to check out.
3. Type the number of days or hours for checkout (1 day = 24 hours).
4. Select the product(s) for which you want to check out licenses.

Intergraph Smart Licensing User's Guide 15

 Checkout

To update the product list from the server, click Refresh .

5. Click Check Out.
The licensing administrator can specify the products, licenses, and duration for
checkout in the Licensing Portal.
See Also
Check in licenses (on page 16)

Check in licenses
When should I check in a license?
Check in the license when you have finished using the licensed application offline and are back
online.

1. Exit the application that is using a checked out license.

It's not possible to check in a license if it's currently being used.
2. Connect to the network.
3. On the Check In tab, select licenses to check in.

To update the In Use status of the checked out licenses, click Refresh .
4. Click Check In.

Intergraph Smart Licensing User's Guide 16

SECTION 6

Client Configurations
Your administrator specifies a configuration on the Licensing Portal and downloads a
configuration connection info (.cci) (page 47) file, which contains information about the
configuration. A configuration connection info (.cci) file must be loaded on each client computer
before using Smart Licensing.
There are three types of configurations: user, group, and device.

User configurations
A user configuration is used for all license requests for a specific user.
A user can be defined by the login to the device or by the Hexagon PPM application. Please
contact Hexagon PPM Support (http://hexagonppm.com/ppm-support) to determine if the
application you are running defines the user name.

Group configurations
A group configuration can be defined for an Active Directory group of users.
Using group configurations can save time when setting up and maintaining a licensing system
with many different users. If a group configuration connection info (.cci) file is loaded on a client
computer, and users are added or removed from the Active Directory group, these changes take
effect immediately on the client computer. For example, a user added to the Active Directory
group can use licenses from that group configuration immediately.
Group configurations require the following:
▪ Intergraph Smart Licensing Client is installed on a computer on the domain
▪ The Intergraph Smart Licensing Client service is modified to run as a domain user to allow
access to Active Directory

Configure the Intergraph Smart Licensing Client service to run as a domain user
Before changing the logon account in this procedure, check in all licenses that were
checked out for offline use on the computer. Otherwise, these licenses will be unusable until
their expiration.
1. Open the Control Panel, and then double-click Administrative Tools.
2. In the Administrative Tools window, double-click Services.
3. Right-click Intergraph Smart Licensing Client, and then select Properties from the
shortcut menu.
4. In the Service status section, click Stop.
5. On the Log On tab, select This account, and then type the domain user name.
6. In the Password and Confirm password boxes, type the password for the domain user
account, and then click Apply.
7. In the Service status section, click Start, and then click OK.

Intergraph Smart Licensing User's Guide 17

 Client Configurations

Device configurations
A device configuration is used for license requests from a particular device (computer).
Typically, a device configuration connection info (.cci) file is loaded during installation. However,
it is possible to load a configuration connection info (.cci) file after installation, using Smart
Licensing Client or command line options.

Order of precedence for configurations

When a license is requested, the software determines the configuration to use based on the
following order of precedence:
1. User configuration for the specific user
2. Group configuration for the Active Directory group of which the user is a member, if any
3. Device configuration for the device being used

Passwords on configurations
Your administrator can assign a password to a configuration. When you load the corresponding
configuration connection info (.cci) file into Smart Licensing Client, you must enter the correct
password.
If your administrator changes the password for the configuration and the corresponding
configuration connection info (.cci) file is currently loaded on your client, you will be prompted to
enter the new password.

Loading or adding configuration connection info (.cci) files

Before a configuration connection info (.cci) file is loaded, the software checks the connection to
the configuration server, checks the validity of the file, and if a password is required, checks the
password. If there is a problem, the file is not loaded.

Adding and editing configuration connections

You must run Smart Licensing Client as an administrator with UAC on in order to:
▪ Add or edit a user configuration connection for anyone other than yourself
▪ Add or edit a group configuration connection
▪ Add or edit a device configuration connection
▪ Remove any kind of configuration connection

What do you want to do?

▪ Add a configuration connection (on page 19)
▪ Edit a configuration connection (on page 19)

Intergraph Smart Licensing User's Guide 18

 Client Configurations

Add a configuration connection

Add a configuration connection for a user
If you are running Smart Licensing Client as an administrator, you can add or change
the configuration connection for any user. Otherwise, you can add or change a configuration
connection only for yourself.

1. On the Configuration tab, click .

2. In the Add Connection dialog box, select User.
3. In the Username box, type a user name.
The user name is case-sensitive, so be sure to enter it with the proper case.
4. In the Configuration Connection Info File box, browse to select a file.

Add a configuration connection for a group

You must run Smart Licensing Client as an administrator to add a group configuration
connection.

1. On the Configuration tab, click .

2. In the Add Connection dialog box, select Group.
3. In the Group Name box, type the name of the Active Directory group.
4. In the Configuration Connection Info File box, browse to select a file.

Edit a configuration connection

Edit a device configuration connection
You must run Smart Licensing Client as an administrator to add or edit a device
configuration connection.

1. On the Configuration tab, click in the device configuration row.

2. In the Edit Connection dialog box, browse to select a configuration connection info (.cci)
file.

Edit a user or group configuration connection

You must run Smart Licensing Client as an administrator to edit a user configuration
connection (for a user other than yourself).
Likewise, you must run Smart Licensing Client as an administrator to edit a group configuration
connection.

1. On the Configuration tab, click in the configuration row.

2. In the Edit Connection dialog box, browse to select a configuration connection info (.cci)
file.

Intergraph Smart Licensing User's Guide 19

 Client Configurations

Intergraph Smart Licensing User's Guide 20

SECTION 7

Licensing Status
You can view the current status and response times of the licensing services and keystores on
the Status tab. This information can help when troubleshooting the licensing system.

View status of licensing services and keystores

1. Click Status.
2. Check the status and response times for the services and keystores.

▪ A green check icon means the Client can connect to the service or keystore.

▪ A red exclamation point icon means the Client cannot connect to the service or
keystore. This could mean the service is unavailable or the request timed out.

3. If a service or keystore is showing , contact your license administrator.

You can pause the mouse over the icons to see a more detailed message. Click the
icon to copy the message and in the case of an error, go to Help.
See Also
Connectivity issues with licensing (on page 34)

Intergraph Smart Licensing User's Guide 21

SECTION 8

Licensing History
You can see messages about events in the software on the History tab in Smart Licensing
Client. This information can help when troubleshooting the licensing system.

View and export licensing history

1. Click History.
2. Look at the messages that have been sent to the Client.

3. To save a copy of the data, click Export .

Save this file to a location that you (as the user logged on and running the Client
user interface) have write permissions to.

Intergraph Smart Licensing User's Guide 22

SECTION 9

Updating Smart Licensing

If you see a red dot on the three-dot menu , that means there is an updated Smart Licensing
Client available.

Update client software

You must run Smart Licensing Client as an administrator to update the software using
this procedure.

1. Click > Check for Updates.

2. Click Download and then click Update.
The update process preserves previously loaded configuration connection info (.cci)
files, licenses in use, and notification messages.

Intergraph Smart Licensing User's Guide 23

SECTION 10

Frequently Asked Questions (FAQs)

In This Section
License Reservation and Release ................................................. 24
Checkout ........................................................................................ 25
Keys ............................................................................................... 27
Projects .......................................................................................... 27
Configuration Connection Info (.CCI) Files .................................... 28
Environment Variables................................................................... 28
Citrix and Virtual Environments ..................................................... 30
Licensing Portal ............................................................................. 30
SmartPlant License Manager (SPLM) ........................................... 31
Miscellaneous ................................................................................ 31

License Reservation and Release

Can I test license reservation and release in Smart
Licensing?
No, it is not possible to test license reservation and release in Smart Licensing.
However, you or your licensing administrator can view license usage on the Curent License
Usage report page in Smart Licensing Portal. In addition, you can check connectivity of services
on the Status tab in Smart Licensing Client.

My application stopped responding. Do I need to restart my

client to release the license back to Smart Licensing?
No, you do not need to restart your client. Smart Licensing automatically releases the seat and
reacquires it if necessary.

How does scavenging happen in Smart Licensing?

Scavenging is not necessary in Smart Licensing. Abandoned licenses are immediately returned
whenever the server loses connection with a client.

Intergraph Smart Licensing User's Guide 24

 Frequently Asked Questions (FAQs)

How long does it take to return a license after an application

crashes?
Wait for 15 minutes for the license to be returned. If it's longer than that, contact your license
administrator.

Checkout
Can I check out a license for a virtual machine by Remote
Desktop Connection? Are there any limitations?
Licenses can be checked out on most virtual machines. Checkout is not supported on VirtualBox
or VMware Player clients.

Can I check out a license from a keystore with a pending

key?
Yes, but only if the license is currently available on both the active and pending key.

When exactly does a checked out license expire?

If a license is checked out at 5:30 p.m. for two (2) days, the license will expire at the next check
after 5:31 p.m. two (2) days later. Days are in 24-hour increments. The software checks for
expired licenses at regular intervals.

I do not see my product listed on the Check Out tab. How

can I check out a license?
If your product is not listed on the Check Out tab, a license for that product is not available for
you to check out for offline use.

I checked out a license using Smart Licensing checkout and

was using the license offline, and then my application
stopped responding. Do I need to scavenge the checked out
license to reuse it?
When you connect back online, the license is collected automatically. You do not need to
scavenge the license.

Intergraph Smart Licensing User's Guide 25

 Frequently Asked Questions (FAQs)

Can I install Smart Licensing Client and SmartPlant License

Manager Checkout Utility on the same computer?
This is not recommended. SmartPlant License Manager Checkout Utility (SPLMCU) is not
supported with Smart Licensing. You should use the Smart Licensing Client checkout feature to
check out licenses for offline use.
▪ If you are using SmartPlant License Manager (SPLM) Client, use SmartPlant License
Manager Checkout Utility (SPLMCU) to check out licenses.
▪ If you are using Smart Licensing Client, use the Check Out tab to check out licenses. If
SPLMCU was previously installed on the client computer, uninstall it manually. The
installation for Smart Licensing Client does not remove SPLMCU automatically.
See Also
How does Smart Licensing Client checkout differ from SmartPlant License Manager Checkout
Utility? (on page 26)

User A checked out a license using Smart Licensing. Can

User B check in the license from the same device?
Yes. Checkout applies to the device; therefore, any user can check in a license not in use on the
same computer.

How does Smart Licensing Client checkout differ from

SmartPlant License Manager Checkout Utility?
The checkout feature in Smart Licensing Client is easier to use and is the same for all products.
Checkout in Smart Licensing provides more flexibility and control of the checkout options such
as number of licenses and time per device. SmartPlant License Manager Checkout Utility
(SPLMCU) had specific compatibility requirements, which increased complexity. In addition,
licenses that were checked out by SPLMCU could not be checked in.

I'm using a legacy application that isn't built with Smart

Licensing. Can I use Smart Licensing for checkout?
All Hexagon PPM legacy applications will work with Smart Licensing. If your application has
checkout-able licenses, Smart Licensing should allow you to check out licenses for offline use.

Intergraph Smart Licensing User's Guide 26

 Frequently Asked Questions (FAQs)

Keys
How many pending keys can be loaded into a keystore?
There can be one pending key that starts at the beginning of the next month. This pending key
can only be cut during the grace period, which is usually 10 days before the beginning of the
month.

Can I get a key in advance if I use Smart Licensing?

Yes, there is a grace period (usually 10 days) at the end of the month when the licensing
administrator can generate a key that will be effective for the next month. For example, on
January 25, you could generate a February key that would not become active until February 1.

Projects
In what order are projects displayed on the Client Settings
tab?
The order of the projects in the list on the Client Settings tab may not be the same as the order
of the projects defined in the client configuration in the Licensing Portal.
The projects on the Client Settings tab are not in alphabetical order; they're in random order.

Why is my license request showing an unexpected project?

This situation can happen if your licensed application (for example, a web application) uses a
login for license requests that is not the current logged on user.
This situation can also happen if you save the client settings as one user and then log off and
log back on as a different user.
The settings saved on the Client Settings tab apply to the current logged on Windows user
only.

What should I do if I get a "Project is invalid" message?

Contact your licensing administrator. Your administrator can assign different projects or set a
fallback project in a configuration.
The "Project is invalid" message can appear if the project name in the license request does not
match the project name in the configuration connection info (.cci) file.

Intergraph Smart Licensing User's Guide 27

 Frequently Asked Questions (FAQs)

Configuration Connection Info (.CCI) Files

Can anyone use the configuration connection info (.cci) file
to get a license? Are there any permissions or restrictions?
The licensing administrator can specify a password for the configuration, which is loaded onto a
client using a configuration connection info (.cci) file. Anyone with the password can use the
configuration connection info (.cci) file.
Specifying a password is optional, but if the licensing administrator sets up a password on the
configuration, users will need to know the password in order to load and authenticate the
configuration connection info (.cci) file and use it to get a license.
Keystores, which are part of configurations, can also be restricted to specific domains.

My configuration connection info (.cci) file has more than

one license type (mechanism) for my product. What is the
order of license types?
Licenses are obtained from the keystore order defined in the configuration and selected project.
Purchased licenses are obtained before leased licenses. 24-hour licenses are used before
limited use licenses (12-hour).

How often are changes to configurations pushed to client

computers?
Smart Licensing checks for configuration changes every hour. If you want changes (such as
added or removed keystores or projects) immediately, click Refresh on any tab in Smart
Licensing Client on a client computer.

Environment Variables
Does Smart Licensing support the use of environment
variables?
Yes, Smart Licensing supports environment variables. For more information, see Appendix:
Environment Variables in the Smart Licensing Installation and Setup Guide.

Intergraph Smart Licensing User's Guide 28

 Frequently Asked Questions (FAQs)

Are environment variables in Smart Licensing case-

sensitive?
Environment variable names and values are case-insensitive; in other words, you can have any
combination of upper- and lowercase. This is true for the SPLM environment variables as well
as the Smart Licensing environment variables.
For more information, see Appendix: Environment Variables in the Smart Licensing Installation
and Setup Guide.

How do the SPLM environment variables map to the

columns on the Current License Usage page in the Portal?
This table shows how the SPLM environment variables correspond to the columns on the
Current License Usage page in the Licensing Portal.

SPLM Environment Variable Column in Licensing Portal

ProjectName Project

NodeName Device Name

UserNameEx User

Why are the values on the Current License Usage page

different from the values in the environment variables?
This can happen in the case of batch jobs using Intergraph Batch Manager.
For example, say that you have set environment variables on the batch server. When you run
the batch job, you expect the reported values to be those from the environment variables on the
server. However, the reported values for the license are different.
In batch jobs, the values from the environment variables for the current logged on user (not the
batch user set in account mapping) are reported with the license pulled by the batch user.

Intergraph Smart Licensing User's Guide 29

 Frequently Asked Questions (FAQs)

Citrix and Virtual Environments

I am using Citrix and crossing multiple time zones. Are there
any limitations in this situation?
There are no limitations when crossing multiple time zones with Smart Licensing.

Does Smart Licensing support virtual environments?

Smart Licensing supports virtual environments for clients. However, offline checkout is not
supported on VirtualBox or VMwarePlayer clients.

Licensing Portal
Can I use any version of Smart Licensing Client with the
Licensing Portal?
You can use the delivered version of Smart Licensing Client with the Licensing Portal.
For more information about product compatibility, see the Hexagon PPM Compatibility Matrix -
Product Report on Intergraph Smart Support (https://smartsupport.intergraph.com).

How do I monitor license usage?

Open the Licensing Portal, and navigate to Reports > Current License Usage.

Why is the Login User value on the Current License Usage

page not the same as the Login User value found in Smart
Licensing Client?
This situation can happen in the case of batch jobs.
If the batch account is not the same as the current login, the obfuscated Login User value for
the batch job license on the Current License Usage page is not the same as the obfuscated
Login User value on the Obfuscation Info dialog box in Smart Licensing Client.
The batch account is the mapped account set in Intergraph Batch Manager.

Intergraph Smart Licensing User's Guide 30

 Frequently Asked Questions (FAQs)

SmartPlant License Manager (SPLM)

Can I continue to use SmartPlant License Manager (SPLM)
for licensing?
You can continue to use SmartPlant License Manager (SPLM), but only with products that do
not require Smart Licensing.

How do I switch from SmartPlant License Manager (SPLM)

to Smart Licensing?
Install Smart Licensing Client on your client computers. For more information, see the Smart
Licensing Installation and Setup Guide.

I have SmartPlant License Manager (SPLM) Client installed

on my computer. Can I install Smart Licensing on the same
computer and use both?
No. SPLM is removed automatically when you install Smart Licensing Client. Note that all prior
versions of Hexagon PPM software work with Smart Licensing Client.

Miscellaneous
Do I need to turn the Windows firewall off to work with Smart
Licensing?
No, you don't need to turn the firewall off.

Is virus scan software allowed to run on Smart Licensing

clients?
Yes, virus scan software can run on the same computers as Smart Licensing.

Intergraph Smart Licensing User's Guide 31

 Frequently Asked Questions (FAQs)

Which ports need to be open for Smart Licensing?

This table lists the port that is used by default for communications between Smart Licensing
Client and Smart Licensing Portal.
This port must be open on all Smart Licensing Client computers as well as on the computers
where Smart Licensing Portal is accessed.

Port Number TCP/UDP Communication Comments

443 TCP From client to server Standard HTTPS port. Must be

open to hexagonppm.com and
hexagonsmartlicensing.com.

For online documentation, ensure that docs.hexagonppm.com and

hexagonppm.fluidtopics.net are accessible.

Is there a way to stop getting the message about an expired

license?
Smart Licensing is designed to display a message when a license expires and the system
cannot obtain a new one. Exit the application and contact your license administrator.

Intergraph Smart Licensing User's Guide 32

SECTION 11

Troubleshooting
The following section provides troubleshooting help for licensing-related issues.

Troubleshoot the licensing environment

If you're encountering software issues related to licensing, there are a few places to look for
more information.

Status tab
Displays the current status and response times of the licensing services and keystores.
▪ Intergraph Smart Licensing Services - This section displays the current connectivity
between the client computer and Smart Licensing services. If a service is down, click the
icon in the Status column to copy the error message or get more information.
The Software Delivery service is a download service used to deliver the latest
version of the client for users to update.
▪ Keystore Order for Project - This section displays the current connectivity to the keystores
for the selected project.
The keystores are listed in the order that the License Client will use them when
trying to obtain a license. That order is defined by an administrator in Smart Licensing
Portal.

History tab
Displays messages about events in the software. To save a copy of the data, click Export .
You can send this information to your license administrator for troubleshooting purposes.

Obfuscation Info dialog box

Displays your user name, computer name, and device identifier as obfuscated strings (encoded

text). Click Copy to Clipboard to copy all of the information on this dialog box. You can
send this information to your license administrator for troubleshooting purposes.
For more information, see How to find my user name, computer name, and device identifier to
troubleshoot licensing (on page 34).

Intergraph Smart Licensing User's Guide 33

 Troubleshooting

Connectivity issues with licensing

In Smart Licensing Client, click Status to view information about connectivity between the client
computer and Hexagon PPM cloud services. This information can help diagnose network
issues.
The available keystores are listed on this tab. Use this information to verify network connectivity
to the keystores for the selected project.
If a service or keystore is down, contact your IT or license administrator, and give them the
following instructions.

Troubleshoot connectivity
1. Open Network and Sharing Center from Control Panel, and make sure the computer has
LAN or Wi-Fi capabilities.
2. Check the proxy settings in Windows. Smart Licensing Client uses these settings to connect
to Smart Licensing cloud services.
3. If your company uses a network device to restrict web traffic, ensure that the target aliases
hexagonppm.com and hexagonsmartlicensing.com are listed as exceptions, or whitelisted.
4. For online documentation, ensure that docs.hexagonppm.com and
hexagonppm.fluidtopics.net are whitelisted.

How to find my user name, computer name, and device

identifier to troubleshoot licensing
Smart Licensing helps protect your user name, computer name, and device identifier using
obfuscation, which replaces your personally-identifying information with encoded text. You can
send this information to an administrator for troubleshooting purposes.

1. In Smart Licensing Client, click > Obfuscation Info.

You'll see the following fields:
▪ Login User - Obfuscated name of the user logged into the computer where the licensed
application is running.
▪ Machine Name - Obfuscated name of the computer where the licensed application is
running.
▪ Device ID - Obfuscated string used to uniquely identify the computer where the licensed
application is running.
If you're running Smart Licensing Client on a computer that you connect to remotely, you'll
also see the following fields:
▪ Remote User - Obfuscated name of the user logged into the computer from where the
remote connection originates.
▪ Remote Machine Name - Obfuscated name of the computer from where the remote
connection originates.

2. Click Copy to Clipboard to copy all the information on this dialog box.
3. Send the information to your administrator.

Intergraph Smart Licensing User's Guide 34

 Troubleshooting

The Login User, Machine Name, Remote User, and Remote Machine Name fields
also appear on the Current License Usage page in the Smart Licensing Portal.

Checked out license expired and cannot obtain

another one
Message
Checked-out license for <product name> expired; unable to obtain another license

Description
When you get this message, it means that a checked out license expired and a new license was
not found for offline use. Contact your licensing administrator.

Checkout in a virtual environment

Message
Unable to check out in this virtual environment

Description
Checkout is not supported in all virtual environments. If you see this message, you might be
working in an unsupported virtual environment, for example, VirtualBox or VMware Player. You
should talk with your licensing administrator.
Checkout is supported on the following platforms: Hyper-V, XenServer, VMware ESXi.

Connection Authentication box asking for a password

A Connection Authentication box popped up, asking for a password.
This box appears when a password-protected configuration is being loaded. Contact your
licensing administrator for the password.

Messages about "SmartPlant License Manager" or

"SPLM"
Message
Messages that have "SmartPlant License Manager" or "SPLM" in the text, for example:
Could not get a license from SmartPlant License Manager:
SPLM Failed : Unable to connect to Intergraph Smart® Licensing Server
Please refer to the SPLM documentation.

Intergraph Smart Licensing User's Guide 35

 Troubleshooting

Description
These messages might appear when you're working in older applications that are compatible
with SmartPlant License Manager (SPLM).

Status tab shows services down

Problem
The Status tab is showing some of the services are down or not connected.

Solution
Contact your IT administrator. For more information, see Connectivity issues with licensing (on
page 34).

Unable to check in a license

Message
Unable to check in license for <product name>
Unable to check in license for <product name>; license is still in use

Description
This message can occur when the checkin process did not proceed as expected, for example, if
the product is still using the checked out license. Exit the licensed application, and try to check
in the license again. If the problem persists, contact your licensing administrator.

Unable to check out a license

Message
Unable to check out license

Description
This message can occur when the checkout process did not proceed as expected. Contact your
licensing administrator.

Intergraph Smart Licensing User's Guide 36

 Troubleshooting

Unable to obtain a license

Message
Unable to obtain license; no licenses available for <product tag>
Unable to obtain license; no license is available for this version of <product tag>
Unable to obtain license; all licenses for <product tag> are expired
Unable to obtain license; all <product tag> licenses are in use
Unable to obtain license; project <project name> is invalid
Unable to obtain license; environment variable <environment variable name> is invalid
Unable to obtain license from keystore; keystore <keystore name> is not responding
Unable to obtain license; keystore <keystore name> is restricted. No licenses available for
<product tag>
Unable to obtain a license; no configuration loaded for user <username>
Unable to obtain a license; configuration for user <username> must be authenticated

Description
These messages can occur when:
▪ No licenses are available for a specific product tag
▪ No licenses are available for a specific version of a product
▪ All licenses for a product tag have expired
▪ All licenses for a product tag are currently in use
▪ There is a problem with a project
▪ The project is set by an environment variable or by the application to a project that is not in
the client configuration and there is no fallback project specified for the configuration.
▪ A keystore is not responding or has a restriction on it
▪ There is no configuration loaded for the user requesting a license
▪ The configuration for the user requesting a license must be authenticated (the user needs to
enter the correct password)

Solution
If you see any of these messages, you should talk with your licensing administrator. Tell your
administrator if there is additional information in the message, such as a particular product tag or
numerical code.

Unable to load configuration connection info (.cci) file

Messages
▪ The Configuration Connection Info file has been corrupted. Select a different file.

Intergraph Smart Licensing User's Guide 37

 Troubleshooting

▪ The Configuration Connection Info file path is not valid. Provide a valid file path.
▪ An error occurred while loading the Configuration Connection Info file.
▪ The configuration is invalid.
▪ Unable to contact Configuration Server (URL); could not load Configuration Connection Info
▪ Unable to contact (URL)

Description
These messages appear when there is a problem loading a configuration connection info (.cci)
file. This situation can happen due to the following reasons:
▪ The configuration connection info (.cci) file is not valid or is corrupted - for example, the file
name extension used to be something other than .cci, and then the file was renamed to
have the file name extension .cci
▪ The configuration connection info (.cci) file cannot be accessed - perhaps due to file or
folder permissions
▪ The configuration connection info (.cci) file points to a configuration that was removed from
the Licensing Portal
▪ Problem connecting to the URL for the configuration server
▪ Configuration server is down or has been moved
▪ Proxy settings are not correct
▪ Ports are blocked
▪ Network is down

Solution
Contact your licensing administrator and note which configuration connection info (.cci) file you
were trying to load. You might need to load a different file.
For connectivity issues related to the configuration server or proxy settings, see Connectivity
issues with licensing (on page 34).
For more information about ports, see the section about port assignments in the Smart
Licensing Installation and Setup Guide.

Intergraph Smart Licensing User's Guide 38

 Troubleshooting

Unable to open application using launch option

Message
Invalid project was set by SLENV_ProjectName environment variable and cannot be changed.
Invalid value was set by SLENV_<Client Setting> environment variable and cannot be changed.

Description
These messages occur when the Smart Licensing Client is called with the launch option but
would be unable to obtain a license due to an environment variable containing an invalid value.

Solution
In order to be able to launch an application using Smart Licensing Client, the value of the
environment variable indicated by the message will need to be changed to a valid value

Intergraph Smart Licensing User's Guide 39

SECTION 12

Command Line Options for Smart

Licensing
Smart Licensing provides command line options for administrators to do the following:
▪ Load or remove configuration connection info (.cci) files
▪ Specify client settings before launching an application
▪ Download and install the latest client

Command line options for loading or removing

configuration connection info (.cci) files
The Client Configuration tool allows administrators to load or remove configuration connection
info (.cci) (page 47) files on client computers.
The ClientConfigTool.exe program is located in the Smart Licensing Client
installation folder (for example, C:\Program Files\Intergraph Smart Licensing\Client).

Syntax
ClientConfigTool.exe {{-d | -g <groupname> | -u <username>} {-r | -f
<filename> [-p <password>]} [-pause]} | -h

Parameters
Parameter Description

-d Loads a configuration connection

info (.cci) file for all users on the
device. A file name must be
provided.

-g <groupname> Loads a configuration connection

info (.cci) file for a group of users.
Contact your IT organization for the
name of this group. The group name
and file name must be provided.
Do not include the domain
name in front of the group name.

Intergraph Smart Licensing User's Guide 40

 Command Line Options for Smart Licensing

Parameter Description

-u <username> Loads a configuration connection

info (.cci) file specific to one user.
The user name and file name must
be provided.
Do not include the domain
name in front of the user name.

-r Removes a configuration connection

info (.cci) file.

-f <filename> Specifies the name of the

configuration connection info (.cci)
file. This parameter is required when
loading a configuration connection
info (.cci) file.

-p <password> Specifies the password for the

configuration, if it requires a
password for authentication.

-pause Pauses after execution to display

results.

-h Displays help at the command

prompt.

Remarks
▪ The command fails if you try to load more than one type of configuration connection info
(.cci) file (d, g, u) at the same time.
▪ If d, g, or u is not specified, the action is performed for the current user.
▪ Before loading a configuration connection info (.cci) file, this command performs various
checks, including whether there is a connection to the configuration server, whether the
configuration connection info (.cci) file is valid, and if a password is required, whether it is
correct. If there is a problem, the file is not loaded.

Examples
To load a configuration connection info (.cci) file for the device, type:
"C:\Program Files\Intergraph Smart
Licensing\Client\ClientConfigTool.exe" -d -f "C:\Config
Files\ConfigConnectionInfoA.cci"
To load a configuration connection info (.cci) file for a group, type:
"C:\Program Files\Intergraph Smart
Licensing\Client\ClientConfigTool.exe" -g groupname -f "C:\Config
Files\ConfigConnectionInfoB.cci"

Intergraph Smart Licensing User's Guide 41

 Command Line Options for Smart Licensing

To load a configuration connection info (.cci) file for a user, type:

"C:\Program Files\Intergraph Smart
Licensing\Client\ClientConfigTool.exe" -u username -f "C:\Config
Files\ConfigConnectionInfoC.cci"
To load a password-protected configuration connection info (.cci) file for a user, type:
"C:\Program Files\Intergraph Smart
Licensing\Client\ClientConfigTool.exe" -u username -f "C:\Config
Files\ConfigConnectionInfo.cci" -p password
To remove a configuration connection info (.cci) file for the device, type:
"C:\Program Files\Intergraph Smart
Licensing\Client\ClientConfigTool.exe" -d -r
To remove a configuration connection info (.cci) file for a group, type:
"C:\Program Files\Intergraph Smart
Licensing\Client\ClientConfigTool.exe" -g groupname -r
To remove a configuration connection info (.cci) file for a specified user, type:
"C:\Program Files\Intergraph Smart
Licensing\Client\ClientConfigTool.exe" -u username -r
To remove a configuration connection info (.cci) file for the current user, type:
"C:\Program Files\Intergraph Smart
Licensing\Client\ClientConfigTool.exe" -r

See Also
Client Configurations (on page 17)

Command line options for launching the client

The launch option starts Smart Licensing Client, waits for the user to specify or confirm the client
settings, and then starts the licensed application.
This option is helpful in Citrix environments to guarantee that the client settings are
saved on the same computer from which the licensed application runs.

Syntax
ISLClient.exe [-nocheck] [-keep] -launch <Application>
[<ApplicationArguments>]

Intergraph Smart Licensing User's Guide 42

 Command Line Options for Smart Licensing

Parameters
Parameter Description

-n or -nocheck Skips the network connectivity

check when starting the Client.
This process includes checking
the communication with the
client service, cloud data
service, and keystores.
This is an optional parameter.

-k or -keep Keeps Smart Licensing Client

displayed after the user clicks
Continue.
This is an optional parameter.

-l or -launch <Application> Starts the application specified

by a path and executable file
name.
The -launch parameter must
come after the -nocheck and
-keep parameters, if they are
used.

<ApplicationArguments> Specifies arguments for the

application. These arguments
are optional. For more
information, see the
documentation for your licensed
application.

When using the client launch options, the Check Out, Check In, and Configuration
tabs are not available.
▪ The Check Out and Check In tabs are not available because checkout is not supported in a
Citrix environment.
▪ The Configuration tab is not available because changing the configuration connection info
(.cci) file could affect other users that are using the same Citrix system.
The Client Settings, Status, and History tabs are available so users can specify
settings and view status information and notification messages. The Obfuscation Info and
About Intergraph Smart Licensing dialog boxes are also available.

Workflow
1. Smart Licensing Client is launched with the command line option.
2. The user can specify a project and values for the custom fields, and click Continue.
3. The licensed application starts.

Intergraph Smart Licensing User's Guide 43

 Command Line Options for Smart Licensing

Example
To launch Smart Licensing Client and then start SmartSketch, type:
"C:\Program Files\Intergraph Smart Licensing\Client\ISLClient.exe" -
launch "C:\Program Files\SmartSketch\SmartSketch.exe"
To launch Smart Licensing Client, start SmartSketch, and keep Smart Licensing Client
displayed, type:
"C:\Program Files\Intergraph Smart Licensing\Client\ISLClient.exe" -
keep -launch "C:\Program Files\SmartSketch\SmartSketch.exe"

Command line options for downloading and installing

latest client
The Client Download tool allows administrators to download and install the latest Smart
Licensing Client.
The ClientDownloadTool.exe program is located in the Smart Licensing Client
installation folder (for example, C:\Program Files\Intergraph Smart Licensing\Client).

Syntax
ClientDownloadTool.exe {{-c | -d [<directory>] | -i } [-pause] | -h}

Parameters
Parameter Description

-c Checks for the latest version of

Smart Licensing Client.

-d <directory> Downloads the latest version of

the client to the given directory.

-i Downloads and installs the

latest version of Smart
Licensing Client.

-pause Pauses after execution to

display results.

-h Displays help at the command

prompt.

Examples
To check for the latest version, type:
"C:\Program Files\Intergraph Smart
Licensing\Client\ClientDownloadTool.exe" -c
To download the latest client installation to a folder:

Intergraph Smart Licensing User's Guide 44

 Command Line Options for Smart Licensing

"C:\Program Files\Intergraph Smart

Licensing\Client\ClientDownloadTool.exe" -d C:\Temp\SmartLicensing
To download and install the latest client, type:
"C:\Program Files\Intergraph Smart
Licensing\Client\ClientDownloadTool.exe" -i

Intergraph Smart Licensing User's Guide 45

SECTION 13

Acronyms
The following table shows a list of acronyms and their associated meaning in this
documentation.

Acronym Meaning

ISL Intergraph Smart Licensing

SPLM SmartPlant License Manager

SPLMCU SmartPlant License Manager Checkout

Utility

Intergraph Smart Licensing User's Guide 46

Glossary
acquire
Process by which a license is obtained directly from the cloud. Contrast this term with checkout
(on page 47).
application
A software product that requires a license to be used.
checkin
Process by which a checked out license is returned.
checkout
Process by which a license is obtained for offline use (no network or internet connection).
Cloud Data Service
Component that is used to collect customizable reportable data on license requests. Using this
data, customers can create reports on license usage.
The connectivity status of this component can be viewed on the Status page in Smart Licensing
Client.
configuration
A grouping of projects and their keystores.
A valid configuration must have at least one project. Each project in the configuration must have
at least one associated keystore.
configuration connection info (.cci)
A file that contains information about where to obtain a license.
custom fields
A list of settings, each of which consists of a name and a value, for example, Department =
3281, 3233, 3422. In this example, users can set the value of Department in Smart Licensing
Client.
Custom fields are optional for a project. However, if a project has a custom field, it must have at
least one value for that custom field.
device
A physical computer or a virtual computer (virtual machine).
group
Active Directory (AD) group.
When adding a group configuration, do not include the domain name in front of the group name.
Smart Licensing does not support local groups.

Intergraph Smart Licensing User's Guide 47

 Glossary

Intergraph Smart Application Data Services Processor

A service that is necessary for licensing to run.
key
A list of products and corresponding license information for those products.
keystore
A container on a license server that provides license keys.
Each project in a configuration has an ordered list of keystores. The same project can have a
different ordered list of keystores if the project exists in multiple configurations.
keystore connection info (.kci)
A file that contains information about where to obtain a license.
This file type is not currently supported.
license
A contractual right to run an application.
notification
A message about an event that occurred in the software. You can view notifications on the
History tab in Smart Licensing Client.
obfuscation information
Data about the user and device requesting licenses.
pending key
A key with a starting date in the future. See also key (on page 48).
project
A way to group the activity of users working on a set of tasks using the licensed software. A
licensing administrator can create and name any number of projects.
Each configuration must have at least one project.
By default, the list at the top of the Client Settings tab is labeled Project. However,
it's possible that the label above this list is something else, such as Site. Your licensing
administrator can change the label text in the Licensing Portal.
user
In Smart Licensing, a user can be a local user, domain user, or user created for the licensed
application.
When adding a user configuration, do not include the computer name or domain name in front of
the user name.

Intergraph Smart Licensing User's Guide 48

 Glossary

Intergraph Smart Licensing User's Guide 49

Index
Command line options for loading or
A removing configuration connection info
acquire • 47 (.cci) files • 40
Acronyms • 46 Command Line Options for Smart Licensing
Add a configuration connection • 19 • 40
application • 47 Compare features between SmartPlant
Are environment variables in Smart License Manager and Smart Licensing •
Licensing case-sensitive? • 29 12
configuration • 47
C configuration connection info (.cci) • 47
Configuration Connection Info (.CCI) Files •
Can anyone use the configuration
28
connection info (.cci) file to get a license?
Connection Authentication box asking for a
Are there any permissions or restrictions?
password • 35
• 28
Connectivity issues with licensing • 34
Can I check out a license for a virtual
custom fields • 47
machine by Remote Desktop
Connection? Are there any limitations? •
25 D
Can I check out a license from a keystore device • 47
with a pending key? • 25 Do I need to turn the Windows firewall off to
Can I continue to use SmartPlant License work with Smart Licensing? • 31
Manager (SPLM) for licensing? • 31 Does Smart Licensing support the use of
Can I get a key in advance if I use Smart environment variables? • 28
Licensing? • 27 Does Smart Licensing support virtual
Can I install Smart Licensing Client and environments? • 30
SmartPlant License Manager Checkout
Utility on the same computer? • 26 E
Can I test license reservation and release in
Smart Licensing? • 24 Edit a configuration connection • 19
Can I use any version of Smart Licensing Environment Variables • 28
Client with the Licensing Portal? • 30
Change project or client settings • 14 F
Check in licenses • 16 Find your way around Smart Licensing
Check out licenses • 15 Client • 11
Checked out license expired and cannot Frequently Asked Questions (FAQs) • 24
obtain another one • 35
checkin • 47
checkout • 47 G
Checkout • 15, 25 Getting Started • 10
Checkout in a virtual environment • 35 group • 47
Citrix and Virtual Environments • 30
Client Configurations • 17 H
Client Settings • 14
How do I monitor license usage? • 30
Cloud Data Service • 47
How do I switch from SmartPlant License
Command line options for downloading and
Manager (SPLM) to Smart Licensing? •
installing latest client • 44
31
Command line options for launching the
client • 42

Intergraph Smart Licensing User's Guide 50

 Index

How do the SPLM environment variables keystore connection info (.kci) • 48

map to the columns on the Current
License Usage page in the Portal? • 29 L
How does scavenging happen in Smart
Licensing? • 24 license • 48
How does Smart Licensing Client checkout License Reservation and Release • 24
differ from SmartPlant License Manager Licensing History • 22
Checkout Utility? • 26 Licensing Portal • 30
How long does it take to return a license Licensing Status • 21
after an application crashes? • 25
How many pending keys can be loaded into M
a keystore? • 27 Messages about • 35
How often are changes to configurations Miscellaneous • 31
pushed to client computers? • 28 My application stopped responding. Do I
How to find my user name, computer name, need to restart my client to release the
and device identifier to troubleshoot license back to Smart Licensing? • 24
licensing • 34 My configuration connection info (.cci) file
has more than one license type
I (mechanism) for my product. What is the
I am using Citrix and crossing multiple time order of license types? • 28
zones. Are there any limitations in this
situation? • 30 N
I checked out a license using Smart notification • 48
Licensing checkout and was using the
license offline, and then my application
stopped responding. Do I need to
O
scavenge the checked out license to obfuscation information • 48
reuse it? • 25
I do not see my product listed on the Check P
Out tab. How can I check out a license? • pending key • 48
25 Preface • 7
I have SmartPlant License Manager project • 48
(SPLM) Client installed on my computer. Projects • 27
Can I install Smart Licensing on the same
computer and use both? • 31
I'm using a legacy application that isn't built S
with Smart Licensing. Can I use Smart Smart Licensing Basics • 11
Licensing for checkout? • 26 SmartPlant License Manager (SPLM) • 31
In what order are projects displayed on the Status tab shows services down • 36
Client Settings tab? • 27
Intergraph Smart Application Data Services T
Processor • 48
Is there a way to stop getting the message Troubleshoot the licensing environment • 33
about an expired license? • 32 Troubleshooting • 33
Is virus scan software allowed to run on
Smart Licensing clients? • 31 U
Unable to check in a license • 36
K Unable to check out a license • 36
key • 48 Unable to load configuration connection info
Keys • 27 (.cci) file • 38
keystore • 48 Unable to obtain a license • 37

Intergraph Smart Licensing User's Guide 51

 Index

Unable to open application using launch

option • 39
Update client software • 23
Updating Smart Licensing • 23
user • 48
User A checked out a license using Smart
Licensing. Can User B check in the
license from the same device? • 26

V
View and export licensing history • 22
View status of licensing services and
keystores • 21

W
Welcome to Smart Licensing • 8
What should I do if I get a • 27
What's New in Smart Licensing? • 8
When exactly does a checked out license
expire? • 25
Which ports need to be open for Smart
Licensing? • 32
Why are the values on the Current License
Usage page different from the values in
the environment variables? • 29
Why is my license request showing an
unexpected project? • 27
Why is the Login User value on the Current
License Usage page not the same as the
Login User value found in Smart
Licensing Client? • 30

Intergraph Smart Licensing User's Guide 52