Common Licensing
Common Licensing
GE Digital
2018
GE Common Licensing
© 2018 General Electric Company.
GE, the GE Monogram, and Predix are either registered trademarks or trademarks of General Electric Company.
All other trademarks are the property of their respective owners.
This document may contain Confidential/Proprietary information of General Electric Company and/or its suppliers
or vendors. Distribution or reproduction is prohibited without permission.
THIS DOCUMENT AND ITS CONTENTS ARE PROVIDED "AS IS," WITH NO REPRESENTATION OR WARRANTIES OF ANY
KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF DESIGN, MERCHANTABILITY,
OR FITNESS FOR A PARTICULAR PURPOSE. ALL OTHER LIABILITY ARISING FROM RELIANCE UPON ANY INFORMATION
CONTAINED HEREIN IS EXPRESSLY DISCLAIMED.
Access to and use of the software described in this document is conditioned on acceptance of the End User
License Agreement and compliance with its terms.
Chapter
1
Licensing Overview
Topics:
• Overview
• Supported Operating Systems
• Supported Virtual Machines
• Licensing Types
• Legal Notices
| Licensing Overview | 4
Overview
Common Licensing simplifies administration and support while providing more secure license activation and
management.
You can use Common Licensing to:
• View current licenses for GE products on your computer.
• Choose your licensing method: Internet, local intranet, GE USB Hardware Key, file-based.
• Manage your licenses: Activate, return, refresh, and clean.
License Client
Use the License Client to activate, review, and update licenses on a client device or a GE USB Hardware Key.
Depending on your configuration, the License Client retrieves licenses from the GE Cloud License Server, a Local
License Server on your intranet, or a GE USB Hardware Key. Unless you are using a GE USB Hardware Key, you
must install the License Client on each computer requiring a GE Software license.
Licensing Client
• VMware ESXi 5.X
| Licensing Overview | 5
Licensing Types
Licensing Types
Common Licensing supports configurable and non-configurable licensing options. You can manage configurable
liceneses without further assistance from GE. Non-configurable licenses, however, cannot be modified at your local
site. To make changes to non-configurable licenses, contact your GE representative.
The following image illustrates the various options available through Common Licensing:
Intranet Computers Not Connected to the Internet, and Local License Server Connected to the
Internet
If computers in an intranet are not connected to the Internet (permanently offline) and a direct connection cannot be
made to the GE Cloud License Server during the activation process, but the Local License Server computer within the
intranet is connected to the Internet, then the licenses are added to the Local License Server computer from the GE
Cloud License Server. Licenses are activated on the Local License Server computer from the intranet computers with
GE software products.
Intranet Computers Not Connected to the Internet, and Local License Server Not Connected to the
Internet
If neither the intranet computers nor the Local License Server are connected to the Internet and a direct connection
cannot be made to the GE Cloud License Server during the activation process, you must use a network drive or
portable media device. Files are transferred between the offline Local License Server and an online computer that
can connect to the Cloud License Server during the activation process. Intranet computers then connect to the Local
License Server to obtain activations.
Legacy Licenses
Legacy licensing options, such as keyless software licenses and M4 USB Keys, continue to be supported by GE. They
are no longer available to customers for licensing GE software products.
| Licensing Overview | 7
Legal Notices
Proprietary Notice
No part of this publication may be reproduced in any form, or stored in a database or retrieval system, or transmitted
or distributed in any form by any means, electronic, mechanical photocopying, recording or otherwise, without the
prior written permission of GE. Information contained herein is subject to change without notice.
The information contained in this publication is believed to be accurate and reliable. However, General Electric
Company assumes no responsibilities for any errors, omissions or inaccuracies.
© 2018, General Electric Company. ALL RIGHTS RESERVED
Trademarks
Microsoft® is a registered trademark of Microsoft Corporation, in the United States and/or other countries.
All other trademarks are the property of their respective holders.
Licensed Components
For a list of open source software made available by GE with this version of Common Licensing, together with the
license terms for such software, consult the Open Source Software List in the Documentation folder on your Common
Licensing install media.
Chapter
2
License Client
Topics:
• Overview
• Installing the License Client
• Removing Existing Licenses
• Upgrading Legacy Licenses
• Viewing Licenses
• Activating Licenses
• Returning Licenses
• Completing Offline Processes
• Advanced Tab Functions
• Command-Line Operations
| License Client | 10
Overview
Use the License Client to activate, review, and update licenses on a client device or a GE USB Hardware Key. The
License Client can retrieve licenses from the GE Cloud License Server, a Local License Server on your intranet, or a
GE USB Hardware Key.
If your client computer is not connected to the Internet, you can activate licenses using a network drive or media
device to transfer request files and response files.
• You do not need to uninstall earlier versions of any Common Licensing software.
• If you are using a legacy license and have received an upgrade file (*.plic), upgrade the license using this file.
• Before migrating to cloud-based licensing, make sure you remove your existing licenses from a License Client.
1. Download the Command Licensing Installer from the GE Software Product Licensing website.
2. Run the Common Licensing Installer.
3. Install the License Client on a client device by selecting License Client.
4. Answer the installation prompts.
If you plan to use the Local License Server, see Installing the Local License Server on page 39.
Viewing Licenses
The View Licenses tab displays information for licenses on this computer. You can display license information for all
products or a particular product. In the following illustration, licenses for all products are being displayed.
| License Client | 11
Header
The license header is shown above the Licensed Products and License Information area of the View Licenses page.
The following information is displayed:
• Customer Service Number – Up to 20 characters representing the customer identification.
• Device ID – For pre-configured hardware keys, an integer representing the license number (or one of the license
numbers, if more than one product is licensed).
• Creation Date – The date the license was created on this computer.
• Expiration Date – The overall key expiration date. All products on the key will expire on this date, regardless of
the expiration date within the product itself (if any). Permanent, non-expiring licenses will say “No Expiration”.
Leased licenses will show the date that the lease expires.
Note: : Leased licenses automatically extend the expiration date each time the license server is contacted.
A leased license will expire after a set amount of time (21 days by default) without communication with
the local license server
• License Source – Information regarding the original source of the license. This information is useful to the support
team if you ever have questions about your license.
Note: License Source will appear as "Multiple" when the Licensed Products displayed on the screen
originate from the combination of a non-configurable software key and a non-configurable hardware key.
• License Type – Information regarding the original type of the license. This information is useful to the support
team if you ever have questions about your license.
Refresh Data
Clicking the Refresh Data button causes the View License Page to re-read the license information (including header
information). This might be useful if you want to verify several hardware keys and do not want to restart the License
Client. The refresh process may take several seconds.
License Information
Product Information The product information displayed below the product
name differs from product to product and includes any
license information related to the number and version of
the product purchased; typically this includes expiration
date, version licensed, number of points, CALs, Tags,
and so on.
Product Options The sections displayed below the product information
show one or more options, which carry the “Enabled”
designation if they are available.
Footer Icons
The icons in the footer represent the following.
Icon Description
Indicates whether a hardware key is inserted in the computer and recognized by the License Client.
The hardware key is detected and readable when illuminated in one of the following colors:
• Blue: Non–configurable hardware key (M5 hardware)
• Green: Configurable hardware key (Advantage hardware key – old type)
• Red: Configurable hardware key (Advantage hardware key – new type)
• White: M4 hardware key
If a hardware key is detected but is unreadable, the icon is illuminated with a red slash, such as .
Indicates whether this computer is connected to the GE Cloud License Server. There is no
connection when a red line appears through this icon, such as .
Indicates whether you have administrative privileges. Without administrative privileges, you can
only view licenses on the computer. You do not have administrative privileges when a red line
appears through this icon, such as .
Activating Licenses
The Activate Licenses tab provides several options for activating a license on your computer. Available options for
your computer are links. For example, if your computer is connected to the GE Cloud License Server, this appears as
a link that you can select to activate a license. Options that are do not apply to your computer configuration appear
with a question mark that you can select for more information.
1. On the Activate Licenses tab, from the "Do you need to activate a license?" menu, click Yes, for this computer
from the GE Cloud License Server.
2. Click Display Available Licenses to refresh the licenses on this server in the display area.
3. Select the check box for each license to activate on this computer.
4. Click Activate.
The View Licenses page appears, displaying all active licenses on this computer.
Note: It takes up to two minutes for the License Client to detect and read the GE USB Hardware Key.
| License Client | 15
3. For each license, enter its activation code and click Add Code to add it to the Activation Codes list.
4. When all activation codes are listed in the Activation Codes list, click Activate.
The View Licenses page appears, displaying all active licenses on your computer.
3. Browse to the media device or network location where the request file will be saved.
4. Enter each activation code and click Add Code to add it to the Activation Codes area.
Note: The activation codes can be found in the email you received from GE.
5. Click Generate File to create and save a request file to the specified location.
The Complete Offline Process page appears. A message indicates the request file location and when it was
created.
• If you are using a portable media device, remove it and go to the online computer. Leave the License Client
application running.
• Generate a response file from the offline client computer.
Note: The response file expires 24 hours after being created. The application indicates how much time is
remaining before the response file expires.
If you are using a portable media device to store the response file, remove it and return to the offline computer.
| License Client | 18
Activating Licenses
After generating a request file from your offline computer and a response file from an online computer, you can
activate licenses on the offline computer.
1. On the Complete Offline Process page, click Use the response file to update licenses on the original offline
computer.
2. If necessary, insert the media device with the response file into the computer.
3. Browse to the location of the response file and select it.
4. Click Update Licenses.
Note: After the response file has been imported, the response file extension is modified to
".response_imported."
Use the Activate Licenses tab in the License Client to activate licenses for a non-configurable software key.
1. On the Activate Licensestab, from the Do you need to activate a license? menu, click Yes, for a non-
configurable Software key.
3. After the non-configurable software key is activated, the View Licenses tab appears, displaying all active licenses
on your computer.
| License Client | 20
After activating a non-configurable software key, you cannot access certain options from the License Client.
Note: You can either activate a license for a non-configurable software key or indicate you want to do
something else.
Note: You cannot refresh or return licenses when a non-configurable software key is activated.
Returning Licenses
The Return Licenses tab is used to return licenses from your computer to the GE Cloud Server or a local license
server.
Return Licenses from a Computer not Connected to the GE Cloud License Server
Use the Return Licenses tab to return licenses from client computers that are not connected to the Internet.
Returning licenses from an offline computer entails the following process:
1. Generate a request file from the offline computer.
2. Generate a response file from a computer that is connected to the Internet.
3. Import the response file and return the licenses from the offline computer.
• Verify that Use GE License Server is selected as the license return mechanism and that the Connection Status is
Online in the Advanced Operations settings.
1. Click the Complete Offline Process tab.
The Complete Offline Process page appears.
2. On the Complete Offline Process page, click Generate a Response File from an Online Computer.
The Generate a Response File page appears.
3. Select the request files, the response folder location, and then click Generate File.
• If you are using a portable media device to store the response file, remove it and return to the offline computer.
• Returning a License on page 22 from an offline computer.
Returning a License
After generating a request file from your offline computer and a response file from an online computer, you can return
licenses from the offline computer.
1. On the Complete Offline Process page, click Use the Response File to Update Licenses on the Original Offline
Computer.
2. If necessary, insert the media device with the response file into the computer.
3. Browse to the location of the response file and select it.
4. Click Return License.
Refresh Licenses
The Refresh Licenses link on the Advanced tab is used to apply new licensing options added on the cloud to the
license installed on your computer. This feature is only applicable to configurable (cloud-bound) licenses. It cannot be
applied to Non-configurable Software or Hardware (M5) licenses or legacy licenses.
| License Client | 23
3. Enter the new values to your Device Name or Device Location and click Save Alias.
4. Click Refresh.
The View Licenses page appears, displaying an updated list of active licenses on this computer.
The "Do you need to do something else?" page appears, displaying several options for advanced operations.
2. Click Refresh existing licenses on this computer.
The Refresh licenses on GE USB Hardware key page appears, displaying the hardware key ID in the header.
3. Click Refresh.
The View Licenses page appears, displaying all active licenses on this USB Hardware Key.
Related tasks
Generating a Response File on page 24
Generate a response file before refreshing licenses on your offline computer.
Clean Licenses
The Clean Licenses link on the Advanced tab is used to remove licensing information cached on your computer.
Note: You cannot clean GE USB Hardware Keys.
5. Click Clean.
6. Click Confirm.
4. To change the alias assigned to this device, update the Device Name or Device Location and click Save.
Note: The logging levels are Debug, Info, Warning, Error, and Severe. All levels above Debug are logged
by default.
5. To define a different log folder location, browse to the location and select it.
6. Click Save.
These changes take effect the next time you start the License Client.
To display log files, click Show log files.
Create Reports
1. From the Advanced tab, click Create reports.
2. To save the current license information to a file, click either of the following options:
a) Save license information to a text file
b) Save license information to a HTML file.
3. Browse to the location where you want to save the file and choose a file type.
4. Click Save.
The file is saved to the specified location.
Note: Re-flashing the licensing information on a non-configurable GE USB Hardware Key overwrites all
existing information and replaces it with the contents of the image file that was supplied by GE.
Note: The image file can be re-flashed only to the non-configurable GE USB Hardware Key it was intended
for. If you attempt to re-flash to a different hardware key, an error message is displayed.
3. Click the ellipsis (...) to open a file explorer window and locate the image file supplied by GE.
4. Select the file and click Open to display the file on the License Client page.
5. Click Re-flash USB Key.
A message indicates that the re-flash of licensing information on the non-configurable GE USB Hardware Key
was successful.
Command-Line Operations
You can also manage licenses by running the command-line operations with Administrator privileges. Each command
is defined by specific parameters that returns either a success or an error message at command completion.
You can view the command-line operation usage examples by entering the following command:
ProficyLicenseWizard.exe -Help
This executes the uninstall command and records a script with the responses to use on subsequent uninstallations.
Note: The script is stored in the indicated output folder. In this example, it is in c:\licensing\temp
\SilentClientUninstall.iss.
To run subsequent uninstalls of the License Client using the script created in step 2, enter the following into a
command-line interpreter window:
echo off
Start/wait ProficyLicenseWizard.exe -
ActivateFromCloud=1111-1111-1111-1111;2222-2222-2222-2222
if errorlevel 1 (
echo The command failed. Error code=%errorlevel%
exit /b %errorlevel%
)
echo Success
| License Client | 31
The command returns 0 when successful, or one of the error codes defined in the command return code table.
echo off
Start/wait ProficyLicenseWizard.exe -
Lease=1111-1111-1111-1111;2222-2222-2222-2222 -Server=http://1.1.1.1 -
Port=1111
if errorlevel 1 (
echo The command failed. Error code=%errorlevel%
exit /b %errorlevel%
)
echo Success
The command returns 0 when successful, or one of the error codes defined in the command return code table.
echo off
Start/wait ProficyLicenseWizard.exe -ActivateNonConfigSWKey="filepath
\Filename.klic" -Password=Password
if errorlevel 1 (
echo The command failed. Error code=%errorlevel%
exit /b %errorlevel%
)
echo Success
The command returns 0 when successful, or one of the error codes defined in the command return code table.
echo off
Start/wait ProficyLicenseWizard.exe -
Return=1111-1111-1111-1111;2222-2222-2222-2222
if errorlevel 1 (
echo The command failed. Error code=%errorlevel%
exit /b %errorlevel%
)
echo Success
The command returns 0 when successful, or one of the error codes defined in the command return code table.
echo off
Start/wait ProficyLicenseWizard.exe -Clean
echo The command failed. Error code=%errorlevel%
exit /b %errorlevel%
)
echo Success
The command returns 0 when successful, or one of the error codes defined in the command return code table.
echo off
Start/wait ProficyLicenseWizard.exe -CleanNonConfigSWKey
if errorlevel 1 (
echo The command failed. Error code=%errorlevel%
exit /b %errorlevel%
| License Client | 34
)
echo Success
The command returns 0 when successful, or one of the error codes defined in the command return code table.
Code Description
0 The licenses were deployed successfully.
1 The license file name is required.
2 The license file does not exist.
3 The license file is invalid.
4 The password is required.
| License Client | 35
Code Description
5 The ActivateFromCloud command is missing activation codes.
6 The Lease command is missing activation codes.
7 The Return command is missing activation codes.
8 The Lease command is missing the port number.
9 The port number is invalid.
10 The Lease command is missing the server URL.
11 The licenses could not be leased from a local license server.
12 The license(s) could not be activated from the GE Cloud Licensing Server.
13 Non-configurable software licenses could not be installed.
14 Non-configurable software licenses could not be removed.
15 The licenses could not be returned.
16 The licenses could not be removed.
17 There are one or more restrictions on this environment that prevent licenses from being
activated from the GE Cloud Licensing Server.
18 There are one or more restrictions on this environment that prevent licenses from being
leased from the specified local license server.
19 There are one or more restrictions on this environment that prevent licenses from being
returned.
20 Not used.
21 There are one or more restrictions on this environment that prevent software licenses
from being removed.
22 The command line argument is invalid.
23 The local license server cannot be contacted.
24 The License Client is already running.
25 The specified local license server cannot be used because there are license(s) being
activated from a different local license server.
26 Exiting due to one or more invalid activation codes.
27 The actions cannot be performed. Pass a single command on the command line.
28 An error occurred while creating the license text file report.
29 An error occurred while creating the license HTML file report.
30 The license report filename is required.
Usage: -LicenseReport="filepath\Filename" -Format=TXT|HTML [-Overwrite]
3
Local License Server
Topics:
• Overview
• Hardware Requirements
• Installing the Local License
Server
• Restricting Access to the Local
License Server
• Local License Server
Administration Tool
• Local License Server Settings
Tool
• Command-Line Operations
| Local License Server | 38
Overview
The Local License Server provides a central location for client devices to access and return required GE software
licenses.
The Local License Server software is small and lightweight, and can be run on any existing computer in the network.
You can run the software on an existing production computer, a dedicated computer, or a virtual machine (VM).
You can use the Local License Server Administration Tool to manage the licenses on a server and perform server
operations, such as changing the server connection.
You can also use the Server Console Tool commands to activate and remove multiple license codes on the Local
License Server.
Communication Requirements
The Local License Server computer requires a port (default is 3333) to communicate with client computers. It does
not require continuous internet connectivity to operate. Internet connectivity may be required to activate or return
licensing information to the cloud. You can perform license activation and license recover using an offline activation
process.
The Local License Server computer must be reachable by all computers requiring GE software licenses. Intermittent
connections are not supported. The expectation is that a production computer communicate with a Local License
Server computer at boot time and then approximately every four hours to verify licenses and extend leases. It is
recommended that a Local License Server computer be local to its client computers (in other words, one Local
License Server per location).
Although you can run one or more Local License Servers on a single network, each client computer can only
communicate with one Local License Server at a time for its licenses.
If a single computer hosts both the Local License Server and its clients, the client software must communicate with
the Local License Server through an open TCP port.
Lease Guidelines
The Local License Server holds a pool of licenses that are leased to client computers that have GE products requiring
licenses. Licenses are allocated to a pool using the Local License Server Administration Tool. The License Client then
activates a license on each production client by choosing a license from the pool.
A license remains leased to a client until one of the following conditions is met:
• The client returns it using the License Client tool.
• The client does not extend the license for a period of 20 consecutive days.
• The license is revoked at the server and returned to the pool (for example, if a client computer becomes non-
functional and the licenses need to be moved to a replacement computer).
Licenses are leased from the Local License Server to the clients for a 21 days. Every time a client successfully
communicates with the server, the timer is reset and that lease is extended for 21 days from the date of the last
successful communication.
If a client does not communicate with the Local License Server for more than ten days, you receive warnings as the
lease expiration of 21 days approaches. Make sure the client computer can communicate with the Local License
Server on a regular basis.
An administrator can use the Local License Server Settings Tool to adjust the lease expiry period, set up email
notifications for license expiry reports, device expiry reports, and license instance count reports, and check or reset
the NIC MAC address settings.
| Local License Server | 39
Hardware Requirements
The computer running the Local License Server software must meet these mimimum hardware requirements.
• 2.0 GHz Intel® Core™2 Duo Processor or greater.
• 2 GB RAM memory or greater.
• 3 GHz computer with 4 GB memory or greater (recommended for better performance).
• 10 GB of free hard drive space.
• 100 MBit or faster Full duplex TCP/IP-compatible network interface adapter.
• SVGA or better color monitor with a 24-bit (16,777,216 colors) graphics card capable of at least 1024x768
resolution.
7. Restrict access to the Local License Server using one or more of these options:
Option Description
IP 1. Select the Scope tab.
addresses2. In the Remote IP Address section, select These IP addresses.
3. Select Add, as shown below.
4. Enter the IP addresses that you want to connect to the Local License Server.
5. Click Apply.
Option Description
3. Select Add, as shown below.
4. Enter users that you want to access the Local License Server.
5. Click Apply.
Computers
1. Select the Computers tab.
2. In the Authorized computers section, select the Only allow connections from these computers
check box.
3. Select Add, as shown below.
4. Enter the computers that you want to connect to the Local License Server.
5. Click Apply.
Functionality
The Local License Server Administration Tool consists of the following tabs to help you manage licenses and perform
server operations:
• Licenses: View, add, remove, and reserve licenses.
| Local License Server | 42
• Connected Clients: View client devices leasing GE licenses, and recover licenses from these clients for use by
other clients.
• Server Operations: Edit server connection settings, refresh licenses, clean license information on the server, and
view the server configuration.
• Complete Offline Activation: Activate, refresh, and return a license for an offline computer.
• More Actions: View the Local License Server error and access logs as well as configure logging for the Local
License Server Administration Tool.
You must be an administrator to perform most of the Local License Server Administration Tool operations. Without
administrative privileges, you can only view licenses and client devices leasing GE licenses on a local host sever. You
cannot access the other Local License Server Administration Tool operations.
Note: For Common Licensing 18.4 and higher, you must use the Local License Server Administration Tool
to manage your server. The Proficy Server Manager is no longer available.
Footer Icons
The icons in the footer represent the following.
Icon Description
Indicates the Local License Server is connected to the GE Cloud License Server. There is no
connection when a red line appears through this icon, such as .
Indicates there is an internet connection to the Local License Server. There is no connection when a
red line appears through this icon, such as .
Indicates whether you have administrative privileges. Without administrative privileges, you
can only view licenses and client devices leasing licenses on a local host sever. You do not have
administrative privileges when a red line appears through this icon, such as .
Manage Licenses
Viewing Licenses on the Server
Use can view a list of available software licenses on the Local License Server and see which licenses are leased
by client devices. This list includes the activation code, product name, description, number of available licenses,
expiration date, client ID, client alias, and device type.
1. In the Local License Server Administration Tool, select the Licenses tab.
The list appears showing the licenses on the Local License Server.
2. To display the most up-to-date license view, select Update Table.
3. Optional: You can use wildcard characters to search for clients based on client ID, client alias, and type in the
Search box.
4. Optional: To save the list of these server licenses, do the following:
a) Select Save List to File.
b) Enter the file name, and then navigate to where you want to save this file.
c) Select Save.
Verify the Local License Server is connected to the GE Cloud License Server ( ). If not, see Performing Offline
License Activation on page 45.
1. In the Local License Server Administration Tool, select the Licenses tab.
The Licenses Activated On Server page appears.
| Local License Server | 43
• Reserved: The number of licenses currently reserved on this server for later use. Expired licenses remain in
this column until you remove them.
• Desired Reserve: The number of licenses that you plan to reserve on this server.
3. In the Desired Reserve column, enter the number of licenses that you want to reserve for each desired product.
You can increase and decrease this number as well as enter a zero to clear the license from the reservation list.
4. Optional: To reserve all available licenses for all products, select Reserve All.
5. Optional: To remove all reservations, select Clear All Reservations.
6. Select Reserve.
The Licenses Activated On Server page appears.
e) For each license you want to delete from the server, enter the number of licenses in the Remove column, and
then select Remove.
f) When finished, select Generate File.
A message appears indicating the request file was created.
g) Transfer the request file to the online computer.
2. From the online computer, send the request file for a verification response by selecting 2, Generate a response
file from an online computer on the Complete Offline Activation tab and do the following:
a) Navigate to the request file and select Open.
b) Select the network drive or media device on which to save the response file.
c) Select Generate File.
A message appears indicating the response file was generated.
d) Transfer the response file to the offline Local License Server.
3. From the offline Local License Server, remove the licenses by selecting 3, Use the response file to update
licenses on the original offline server on the Complete Offline Process tab and do the following:
a) Navigate to the response file.
b) Select Update Licenses.
c) To verify the licenses were removed, select the Licenses tab and then Update Table.
4. Optional: Except for the local host, you can remove a saved server from the drop-down list in the Server or IP
address field by selecting next to its name or IP address.
5. Test that your client device can communicate with the Local License Server by selecting Verify Connection.
A message appears showing the connection status.
6. Make sure you save the specified connection settings by selecting Save.
The connection settings are saved to the Local License Server configuration file.
7. Return to the Server Operations tab by selecting Back.
If you remove a license that is currently in use by a client device, you can no longer extend the lease on that license.
Always consult with GE Technical Support before you perform this task.
You must have connectivity to both the GE Cloud License Server and the Local License Server. Otherwise, the link to
perform a clean is disabled.
1. In the Local License Server Administration Tool, select the Server Operations tab.
2. Select 3, Clean Server.
3. Select Clean.
A message appears informing you whether the task was successful.
4. When finished, select Done to return to the Server Operations tab.
5. Optional: To add new licenses to the Local License Server, go to the Licenses tab and select Add Licenses.
4. Select OK.
5. If the Local License Server NIC MAC address has changed, see What to Do When the LLS NIC MAC Address
Changes on page 67.
Configuring Logging
You can define how to log events for the Local License Server Administration Tool.
1. In the Local License Server Administration Tool, select the More Actions tab.
2. Select 3, Logging Configuration.
The Logging Configuration page appears.
| Local License Server | 49
3. In the Select logging threshold field, select the log-level for generating logs. For example, if you select Info, the
Info and Debug events are logged.
Note: Log-level changes only apply after you restart the Local License Server Administration Tool client.
4. In the Select log folder location field, navigate to the folder in which to save the log files.
5. Select Save.
6. To display the log files, select Show log files.
This takes you directly to the log file where you can open it.
7. To zip all the log files, select Zip log files.
This takes you directly to the zip file containing all the log files.
LLSAdminTool.exe -Help
| Local License Server | 50
Command Description
Shows the server name,
-REPORT=DEVICE [-FILE=[Path]Filename] [-APPEND] server ID, client alias,
[-INPUTFILE=[Path]\Filename][-
client ID, client type, and
EXPIRE=X_NUMBER_OF_DAYS]
lease expiration dates for
the specified device.
Shows details about the
-REPORT=LICENSE [-FILE=[Path]Filename] [-APPEND] licenses to expire within
[-INPUTFILE=[Path]\Filename][-
the specified number
EXPIRE=X_NUMBER_OF_DAYS]
of days, including the
activation codes, the total
and available number of
licenses, the expiration
dates, and the number of
reserved licenses.
Shows the percentage of
-REPORT=LICENSECOUNT [-FILE=[Path]Filename] [- licenses available for each
APPEND]
activation code, including
[-INPUTFILE=[Path]\Filename]
[- the total and available
PERCENT_REMAINING=X_PERCENTAGE_OF_LICENSES_REMAINING] number of licenses, and
the number of reserved
licenses.
This report defaults to
a low instance count of
20%.
Reports on reserved
[-RESERVED] licenses.
| Local License Server | 51
3. Select Save.
By default, your email notifications include licenses expiring in the upcoming 30 days in the License
Expiration Report, and list clients with license leases expiring in the upcoming 15 days in the Device
Expiration Report. These reports are sent each day at the time you specified in the Email Set up tab.
b) To be notified when running low on license instance counts on an activation code, select Notify me if I am
running low of license instances on an activation code.
A low license instance count indicates that 20% of license instances on an activation code are remaining.
c) To receive email notifications of any NIC MAC address change, select the Notify me if the NIC MAC
address has changed check box.
d) Select Save.
Command-Line Operations
You can use the Server Console commands to activate and remove multiple license codes on the Local License
Server.
To execute the Server Console, use the following syntax:
To view the Server Console command-line examples, enter the following command:
ProficyServerConsole.exe -Help
If an error occurs when running a command, an error code and message displays on the Server Console. For more
details on an error, see the Server Console log file.
Note: For more information, see Server Console Parameters on page 53 and Server Console INI File
Format on page 53.
ProficyServerConsole.exe [-INIFILE=[PATH]file.ini] [-
TIMEOUT=timeoutValue]
Note: For more information, see Server Console Parameters on page 53 and Server Console INI File
Format for Removing Activation Codes on page 54.
-TIMEOUT=timeout
Note: The default timeout period is 30 seconds. You must specify a timeout value between 30 and 250
seconds. You can start with 60 seconds and increase the value by 30-second intervals, if needed.
The optional -INIFILE parameter specifies the filename and path of the INI file you are using to manage licenses.
You can modify the -INIFILE parameter using the following syntax:
-INIFILE=[PATH]file.ini
Note: If you do not use -INIFILE, the tool looks for the filename “ProficyServerConsole.ini” in the current
folder, and then in the My Documents folder.
If you do not specify the [PATH] of the INI file, the tool looks in the current folder, and then in the My
Documents folder.
[SERVERCONNECTION]
Address=localhost
PortNumber=3333
[ACTIVATIONS]
Count=3
ActID0=AAAA-AAAA-AAAA-AAAA::1
ActID1=BBBB-BBBB-BBBB-BBBB::3
ActID2=CCCC-CCCC-CCCC-CCCC::0
• If the server already had the ActID0 code with a total of 3 before the ActID0=AAAA-AAAA-AAAA-
AAAA::1 request, then 2 quantities of the code will be removed to adjust to the absolute total of 1.
• The second activation on the list is ActID1
• The ActID1 code followed by (::3) will result in a final total of 3.
• The third activation on the list is ActID2.
• The ActID2 followed by (::0) will result in a final total of 0.
• All quantities of this code are removed and the code is deleted from the local license server.
Use the following tables to format information about the Local License Server:
Specification Description
Address=localhost Type “localhost."
Note: At this time, the Server Console only supports "localhost" for the server
address
Specification Description
Count = n The count indicates the total number of activations in the list. It
includes the activations you are adding as well as those you want
to remove
[SERVERCONNECTION]
Address=localhost
PortNumber=3333
[ACTIVATIONS]
Count=1
ActID0=AAAA-AAAA-AAAA-AAAA::0
For more information about formatting server and activation specifications, see Server Console INI File Format on
page 53.
| Local License Server | 55
4
USB Hardware Keys
Topics:
• Overview
• Configurable GE USB Hardware
Keys
• Configurable GE USB Hardware
Key Installation
• Replacing Defective
Configurable GE USB Hardware
Keys
| USB Hardware Keys | 58
Overview
Licenses can be activated and maintained on GE USB Hardware Keys. There are two types of hardware keys:
• Non-configurable GE USB Hardware Key
• Configurable GE USB Hardware Key (legacy)
Typically, you install your licenses from the Hardware Key as you install the software. If you are upgrading from a
previous version, you usually run the electronic licensing update file for your key before installing the newer version
of your product.
If you insert the key after you install your software, it should be detected automatically when the application is started
for the first time. It is recommended that you shut down your computer before plugging in a new key.
Note: Do not remove the key while your product is running. If you do so, the product features shut down and
you must restart the software. You may also damage the key if you remove it while the product is running.
GE only supports Hardware Keys plugged directly into a computer. At this time, GE does not support Hardware Keys
connected through an external USB hub.
On new installations, you must install the Licensing Software before you plug in the Hardware Key for the first time
on your machine.
5
FAQs and Troubleshooting
Topics:
• Error Messages
| FAQs and Troubleshooting | 63
connects to the host PC using its hostname to check out the license for its own use. Alternatively, you can activate
licenses through the offline process. The Local License Server help has details on how to do this.
If multiple VMs are running concurrently, you will need multiple licenses from the Local License Server. If only one
VM is in running, you can check out the license and return it to the Local License Server when done. You can then
launch the second VM and check out the same license. If you do not release the license, there is an expiration date
when the lease is automatically returned to the host PC. You configure this date in the License License Server Settings
tool in the host PC. The default is 21 days.
1. In the host PC, run Common Licensing and do the following:
a) Select Install Local License Server.
b) Select Install License Server Tools.
c) Launch the Local License Server Administration Tool.
d) Add a license to the server by selecting Add Licenses on the Licenses tab.
e) Enter the activation code of the license and select Next.
The license is retrieved from the GE License Server and stored in the host PC (Local License Server).
f) Verify the license was transferred to the host PC by selecting View Licenses.
g) Specify hostname in the command prompt to determine and record the host PC name. In the following
example, the host PC name is A-Computer.
C:\Users\aUser>hostname
A-Computer
More Licenses are Allocated to Clients than are on the Local Server
The following scenario demonstrates how to recover if more licenses are allocated to clients than are on the local
server:
1. The Local License Server is charged with the following licenses:
• License A - 1 total license
• License B - 2 total licenses
2. Client A activates 1 copy each of License A and License B.
3. Client A gets its licenses returned (for example, because CCFLIC0 expires and is not renewed).
4. Client B activates 1 copy each of License A and License B.
5. Client A attempts to refresh its License A and License B.
Table 2:
Scenario Solution
Allow both Client A and Client B to have both 1. Charge the local license server with another copy
licenses of License A.
2. Refresh Client A.
Allow only Client A to have the licenses 1. Return both licenses from Client B.
2. Refresh Client A.
Allow only Client B to have the licenses 1. Return License A from Client B.
2. Refresh Client A.
3. Reactivate License A from Client B.
The following actions may be required when updating the licensing application:
• Remove any Hardware Keys before installing or upgrading.
• If the License Client does not recognize the key:
1. Unplug the Hardware Key.
2. Reboot the computer.
3. Plug in the key.
The licensing application should then recognize the hardware key.
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\CCFLIC0]
3. Right-click the CCFLIC0 folder, expand New, and select Multi-String Value.
4. Enter DependOnService as the Name.
5. Double-click DependOnService to enter the value.
6. In the Value Data area, enter hasplms, and click OK.
The Registry Editor entry should appear as follows:
| FAQs and Troubleshooting | 67
Changing the Default Port that Checks for NIC MAC Address Changes
The default port number to check for a change in the Local Server License ID/NIC MAC address is 33331.
If you are having issues with the default port, you can change it by following this procedure.
1. Navigate to C:\Program Files (x86)\Proficy\Proficy Common\Proficy Common
Licensing\Proficy License Server Configuration\LLSAdminTool.exe.config.
2. Edit the 33331 value in the ServerHelperPort setting of the LLSAdminTool.exe.config file:
• If you rebuilt the server and must reclaim license codes from the original server, contact GE Customer
Support.
For more details, refer to the Proficy License Manager log file.
Error Messages
Visit https://digitalsupport ge.com/communities/CC_Login to create a Technical Support case.
To resolve this issue, contact Technical Support and they can assist you in recovering your licenses
As a best practice, if you know you are going to be making changes to your machine (e g , rebuilding, changing
machine names, changing NICs), we recommend using the Return feature in License Client to return your activation
prior to making changes, then re-activating after the changes .
6
Known Issues
• You must run the License Client with Administrative privileges in order
to activate, return, or refresh a license. When not run with Administrative
privileges, the License Client displays "No license found.”
• If the License Client detects a hardware key, it no longer reads software
licenses.
• When you license the product more than once, the License Client detects
and displays the first instance.
• Insert one hardware key at a time. If the License Client detects multiple
hardware keys, it ignores them and looks for software keys instead.
• The License Client does not write to hardware keys in a remote session.
• Use a GE USB hardware key or local license server to store licenses for
use in virtual environments. Licenses stored on your hard drive in virtual
environments, including VMware® ESXi™ Server and Hyper-V, are not
supported.
• If you are using Windows Server 2003, you must install the latest service
pack for Windows 2003 Server, and you must also install the update
described in http://support.microsoft.com/kb/938397.
• If you are using Windows Server 2012 R2, you must install the update
described in http://support.microsoft.com/kb/2919355.
• Activating licenses from the GE Cloud Server onto Windows XP SP3 or
Windows Server 2003 SP2 computers is no longer supported.
• The local license server cannot resolve the MAC address of computers
that have a virtual network adapter installed. This is the case in all
installations of Microsoft Hyper-V, and results in an inability to activate
licenses.
• The following procedure enables the IPv4 protocol on your physical
adapter:
General Steps:
1. Access the Network Connections area.
2. Access the properties of the physical adapter listed.
3. Enable IPv4.
Steps for Windows Server 2008 R2:
1. Open the Control Panel.
2. Navigate to the Network and Sharing Center.
3. Click Change Adapter Settings.
4. Right-click Local Area Connection and click Properties.
5. Select Internet Protocol Version 4 check box.
The physical adaptor with IPv4 enabled is then assigned the same MAC
address as the virtual adapter, which can then be located by the GE
License Server when activating licenses.
• If you are logged into a Windows computer with the built-in
administrative account Administrator and you start the License Client
application two or more times in quick succession, you can generate
the following error message (even if you are not running within a
virtual machine):
“Error: Licensing detected a Virtual Machine.
Please change your settings to use a local
license server”
If this error appears, open the Windows Task Manager and
check the list of running applications for multiple instances
of the LicenseManager program. If there is more than one
LicenseManager program running, close all programs and then restart
the LicenseManager.
Note: You should not run multiple License Client applications
at the same time.