0% found this document useful (0 votes)
54 views72 pages

Common Licensing

The GE Common Licensing Getting Started Guide provides an overview of the Common Licensing system, which simplifies license management for GE products. It outlines the supported operating systems, licensing types, and the License Client's functionalities for activating and managing licenses. The document also includes legal notices and instructions for migrating to cloud-based licensing and managing licenses through various methods, including USB hardware keys and local servers.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
54 views72 pages

Common Licensing

The GE Common Licensing Getting Started Guide provides an overview of the Common Licensing system, which simplifies license management for GE products. It outlines the supported operating systems, licensing types, and the License Client's functionalities for activating and managing licenses. The document also includes legal notices and instructions for migrating to cloud-based licensing and managing licenses through various methods, including USB hardware keys and local servers.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 72

GE Common Licensing

Getting Started Guide

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.

Migrating to Cloud-based Licensing


Before migrating to cloud-based licensing, you must remove your existing licenses on the client devices.
If you are currently using a legacy license and have received an upgrade file, update your legacy license.

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.

Local License Server


You have the option to use a Local License Server as a central location for client devices to access and return required
GE software licenses. You can manage these licenses on the server using the Local License Server Administration
Tool. You can also 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.

Supported Operating Systems


Common Licensing was tested on the following operating systems:
• Microsoft® Windows® 7
• Microsoft® Windows® 8.1
• Microsoft® Windows® 10
• Microsoft® Windows® Server 2016 Standard
• Microsoft® Windows® Server 2012 Standard
• Microsoft® Windows® Server 2012 Standard R2
• Microsoft® Windows® Server 2008 Standard
• Microsoft® Windows® Server 2008 Standard R2
Note: Microsoft® Windows® XP and Microsoft® Windows® Server 2003 are no longer supported in
Common Licensing 18.4 and higher. If you are using one of these operating systems, use Common Licensing
18.3.

Supported Virtual Machines

Licensing Client
• VMware ESXi 5.X
| Licensing Overview | 5

• Microsoft Hyper-V on Windows Server 2008 R2 , 2012 , 2016

Local License Server


• VMware ESXi 5.x
• Microsoft Hyper-V 6.1, 6.3
Common Licensing was tested on VMware and the Parallels virtual machine software running on a Macintosh
computer.

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:

Configurable Licenses on Computers or Local License Servers


The following are possible configurations for licenses residing on local computers or local license servers:

Computers Connected to the Internet


If computers are connected to the Internet and a direct connection can be made to the GE Cloud License Server during
the activation process, licenses are downloaded directly from the GE Cloud License Server to the computer.

Computers Not Connected to the Internet


If computers are not 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 computer and an online computer that can connect to the GE Cloud License Server during the activation
process.
| Licensing Overview | 6

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.

Licenses on USB Hardware Keys


Licenses can be activated and maintained on GE USB Hardware Keys. This includes:
• Non-configurable GE USB Hardware Keys
• Configurable GE USB Hardware Keys

Non-configurable GE USB Hardware Key


Non-configurable GE USB Hardware Keys are pre-loaded with the licensing information for your products. You
cannot modify the licensing information contained in these keys. However, if you need additional licenses, you can
purchase them from GE and then re-flash keys with a GE-supplied image file that overwrites all existing information
and replaces it with updated licensing information.

Configurable GE USB Hardware Key


Configurable GE USB Hardware Keys will continue to be supported by GE. These configurable keys are plugged into
computers connected to the Internet in order to activate licenses on them.
Once activated, a USB key can be used to license a physical or virtual computer that does not need to online.
However, changes, upgrades, or returns require the key to be plugged into a computer connected to the Internet so the
GE Licensing Server can be accessed.
The final legacy licensing option, keyless software licenses, continues to be supported by GE but will eventually be
phased out.

Non-Configurable Software Keys


Non-Configurable Software Keys are file-based licenses that do not require internet connectivity to be activated. You
cannot modify the licensing information contained in these software keys. However, if you need additional licenses,
you may purchase them from GE.
You may only use this type of license if you have previously signed an agreement with GE. Non-Configurable
Software Keys cannot be loaded onto a Local License Server for ease of management and do not provide any of the
advantages that configurable licenses do.

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.

Installing the License Client


You must install the License Client on all client devices that require GE software licenses.
Installing the License Client deploys the PFKeyUpdate, iKeyUpdate, and Gemalto/SafeNet HASP drivers v 7.54.
Note: If performing a License Client installation upgrade that has new drivers, all Sentinel dependencies are
removed.

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

Removing Existing Licenses


Before migrating to cloud-based licensing, you must remove your existing licenses.
1. Stop all GE software products on your computer.
2. Remove any hardware keys that are plugged into your computer.
3. Uninstall keyless licenses using the Windows Control Panel.

Upgrading Legacy Licenses


If you received an upgrade file for a legacy license, you can use that file to update the legacy license instead of the
License Client.
Double-click the <*.plic> file to upgrade the legacy license.
For more information about installing and updating legacy licenses, go to the GE Software Product Licensing website.

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.

Your Licensed Products


Products List Area This area displays a scrolling list of all the licensed
products on this computer.
Show All Products Check Box At the bottom of the list is the Show All Products check
box.
| License Client | 12

If this check box is selected, as in the illustration above,


the Product Details for all products are displayed in the
License Information area, and any highlighted product in
the product list box is automatically de-selected.
If you click on a product in the list, that product is
shown in the License Information area, and the Show All
Products check box is automatically cleared.

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 no hardware key is detected, the icon is not illuminated, such as .

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.

Activating Licenses on a Computer Connected to the GE Cloud License Server


| License Client | 13

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.

The "Activate licenses from the GE cloud server" page appears.


Note: Internet connectivity is verified before this page is displayed. An error message is displayed if the
GE Cloud License Server is not accessible, and the No Licenses on this Computer page is automatically
displayed.
2. For each license, enter its activation code and click Add Code to add it to the Activation Codes list.
3. When your activation codes are added to the Activation Codes list, click Activate.
The View Licenses page appears, displaying all active licenses on your computer.

Activating Licenses on a Computer Connected to a Local License Server


Verify that the Local Server URL and port are correctly configured.
1. On the Activate Licenses tab, from the "Do you need to activate a license?" menu, click Yes, for this computer
from a Local License Server.
| License Client | 14

The "Lease licenses from a local license server" page appears:

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.

Activating Licenses on a Computer with a GE USB Hardware Key Inserted


1. Insert the GE USB Hardware Key.
2. On the Activate Licenses tab, from the "Do you need to activate a license?" menu, click Yes, for the inserted
Hardware Key.

Note: It takes up to two minutes for the License Client to detect and read the GE USB Hardware Key.
| License Client | 15

The "Activate License on GE USB Hardware Key" page appears.

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.

Activating Licenses on a Computer not Connected to the GE Cloud License Server


Use the Activate Licenses tab to activate licenses on client computers that are not connected to the Internet.
Activating licenses on 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 activate the licenses on the offline computer.

Generating a Request File


Generate a request file from an offline computer.
1. From the License Client, click the Activate Licenses tab.
The License Client detects that the client computer is not connected to the Internet. The "Do you need to activate a
License?" page appears.
2. Click Yes, for a permanently offline computer.
The Generate a Request File to activate licenses page appears.
| License Client | 16

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.

Generating a Response File


Generate a response file from an online computer.
• Start the License Client.
• Verify that Use GE License Server has been selected as the license activation mechanism and that the Connection
Status is Online in Advanced Operations.
| License Client | 17

1. Click Complete Offline Process.


The Complete Offline Process page appears. A message indicates the response file location and when it expires.
2. Click Generate a response file from an online computer.
The Generate a Response File page appears.

3. If necessary, insert the media device into the computer.


4. Select the request files and the response folder location, then click Generate File.
The response file is generated and saved to the specified location on a media device or network drive that can be
accessed by the offline 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.

The Use the Response File to Update Licenses page displays.

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

Activating Licenses for a Non-Configurable Software Key


| License Client | 19

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.

The Activate a non-configurable software key page appears.


2. Navigate to the non-configurable software key file and enter the password you received in the email from GE.

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 Connected to the GE Cloud License Server


Use the License Client Return Licenses tab to return licenses from a client computer connected to the GE Cloud
License Server.
Verify that you have installed and are running the latest Common Licensing from the GE Software Product Licensing
website.
1. From the License Client, click the Return Licenses tab.
The Return Licenses to the GE Cloud Server page displays information for each license found on your computer.
2. Select the check box for each license to return.
3. Click Return.
The Activate Licenses tab appears, indicating that licenses have been successfully returned to the GE Cloud Server.
| License Client | 21

Returning Licenses from a Computer Connected to a Local License Server


Use the License Client Return Licenses tab to return licenses from a client computer connected to a Local License
Server.
Verify that you have installed and are running the latest Common Licensing from the GE Software Product Licensing
website.
1. From the License Client, click the Return Licenses tab.
The Return Licenses to a Local License Server page displays information for each license found on this computer.
2. Select the check box for each license to return.
3. Click Return.
The Activate Licenses tab appears, indicating that licenses have been successfully returned to the Local License
Server.

Returning Licenses from a Computer with a GE USB Hardware Key Inserted


Use the License Client Return Licenses tab to return licenses from a client computer using a GE USB Hardware Key.
Verify that you have installed and are running the latest Common Licensing from the GE Software Product Licensing
website.
1. From the License Client, click the Return Licenses tab.
The Return Licenses from GE USB Hardware Key page displays information for each license found on this
hardware key.
2. Select the check box for each license to return.
3. Click Return.
The Activate Licenses tab appears, indicating that licenses have been successfully returned from the GE USB
Hardware Key.

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.

Generating a Request File


Generate a request file from an online computer before returning licenses from an offline computer.
1. From the License Client application on the offline client computer, click the Return Licenses tab.
The License Client detects that the client computer is not connected to the Internet. The Generate a Request File to
Return Licenses page appears.
2. Select the licenses to be returned.
3. Enter or browse to the location where you want to save the request file.
4. Save the license request file to a device or network drive that can be accessed by the online computer.
5. If you are using a portable media device, remove it and return to the online computer.
Generate a Response File for the offline computer.
Note: The request file expires if you do not complete the offline activation process within 24 hours.

Generating a Response File


Generate a response file from an online computer before returning licenses from an offline computer.
• Start the License Client.
| License Client | 22

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

Completing Offline Processes


When you activate, return, or refresh a license and the computer is not connected to the GE Cloud License Server, the
Complete Offline Process tab opens automatically and guides you through the steps necessary to complete the task.
The complete procedures are documented in the "Computer Not Connected to the GE Cloud Server" topics in the
Activate Licenses, Return Licenses, and Refresh Licenses sections.
1. From the offline computer, generate a request file.
2. From a computer able to access the GE Cloud License Server, generate a response file.
3. On the offline computer, use the response file to complete the task.
Refer to the following topics for more information on completing the offline process:Activating Licenses on a
Computer not Connected to the GE Cloud License Server on page 15
Return Licenses from a Computer not Connected to the GE Cloud License Server on page 21

Advanced Tab Functions


Use the Advanced tab to refresh and clean licenses, update application settings, and download the latest License
Client to a computer.

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

Refreshing Licenses on a Computer Connected to the GE Cloud License Server


Use the Advanced tab in the License Client to refresh licenses on a computer connected to the GE Cloud License
Server.
1. From the License Client, click the Advanced tab.
The "Do you need to do something else?" page appears.

2. Click Refresh existing licenses on this computer.


The Refresh licenses from the GE Cloud Server page appears.
3. To change the Device Name or Device Location, enter the new values and click Save Alias.
4. Click Refresh.
The View Licenses page appears, displaying all active licenses on this computer.

Refreshing Licenses on a Computer Connected to a Local License Server


Use the License Client Advanced tab to refresh licenses on an computer connected to a local license server.
1. From the License Client, click the Advanced tab.
The "Do you need to do something else?" page appears.
2. Click Refresh existing licenses on this computer.
The Refresh licenses from a local license server page appears.

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.

Refreshing Licenses on a Computer with a GE USB Hardware Key Inserted


Use the License client Return License tab to refresh licenses on a USB Hardware Key from the GE Cloud Server.
1. From the License Client, click the Advanced tab.
| License Client | 24

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.

Refresh Licenses on a Computer Not Connected to the GE Cloud


Use the License client Refresh Licenses tab to refresh licenses on offline client computers from the GE Cloud License
Server.

Generating a Request File


Generate a request file on your offline computer before refreshing licenses.
1. From the License Client application on the offline client computer, click the Advanced tab.
The "Do you need to do something else?" page appears.
2. Click Refresh existing licenses on this computer.
The Generate a Request File to Refresh licenses page appears.
3. Enter a media device or network drive where the request file will be stored.
4. To edit the Device Name or Device Location, enter the new information and then click Save.
5. Click Generate File.
The Complete Offline Process page appears.
If you are using a portable media device, remove it from the offline client and return to the online computer.
Note: Leave the License Client running on the offline client.

Related tasks
Generating a Response File on page 24
Generate a response file before refreshing licenses on your offline computer.

Generating a Response File


Generate a response file before refreshing licenses on your offline computer.
Start theLicense Client.
Verify that the license refresh mechanism is set to "Use GE License Server" and that the Advanced Operations
settings displays an online connection status.
1. Click the Complete Offline Process tab.
The Complete Offline Process page appears.
2. Click Generate a response file from an online computer.
The Generate a Response File page appears.
3. Insert any necessary media devices into the computer.
4. Select the request files to be used for generating the response file.
5. Select the response folder location on a media device or network drive that can be accessed by the offline client
computer.
6. Click Generate File.
The License Client generates the response file and saves it to the specified location on a media device or network
drive.
If you are using a portable media device to store the response file, remove it from the online computer. Return to the
original offline client computer and use the response file to update licenses.
Related tasks
Generating a Response File on page 24
Generate a response file before refreshing licenses on your offline computer.
| License Client | 25

Refreshing Licenses Offline


After generating a request file and a response file, refresh licenses on your offline computer.
1. On the Complete Offline Process page, click Use the response file to update licenses on the original offline
computer.
The Use the Response File to Update Licenses page displays.
2. If necessary, insert the media device containing the response file into the computer.
3. Locate and select the response file.
4. Click Update Licenses to refresh the licenses for products on this client computer.
The View Licenses page appears and displays the active licenses on this 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.

Cleaning Licenses on a Computer Connected to the GE Cloud License Server


Use the Clean command to remove licenses from an online computer connected to the cloud license server.
You must stop running all GE Software products on your local client. You can restart the products when the operation
is finished.
This operation stops the Common Licensing software for about 30 seconds.
Note: You cannot clean GE USB hardware keys.

1. From the License Client, click the Advanced tab.


The "Do you need to do something else?" page appears.
2. Click Clean license information on this computer.
3. Click Clean.
4. Click Confirm.
Note: You cannot select certain options from the Clean and Refresh Licenses menu while cleaning non-
configurable software keys.

5. Click Clean.
6. Click Confirm.

Cleaning Licenses on a Computer Connected to a Local License Server


Use the Clean command to remove licenses from an online computer connected to a local license server.
| License Client | 26

1. From the License Client, click the Advanced tab.


The "Do you need to do something else?" page appears with several options for advanced operations.
2. Click Clean license information on this computer.
The "Clean and Refresh licenses for this computer" page appears.
3. Select one of the following actions.
Option Description
Clean Permanently remove all license information from this
computer.
Clean and Refresh Clean license information and then refresh the licenses
from the Local License Server.
4. Click Confirm to perform the selected action.

Cleaning Licenses on a Computer not Connected to the GE Cloud License Server


Use the Clean command to remove licenses from an offline computer.
1. From the License Client click the Advanced tab.
The "Do you need to do something else?" page appears.
2. Click Clean license information on this computer.
3. To remove all licenses from this computer, click Clean.
4. Click Confirm.
Reactivate your licenses.

Cleaning Licenses on a Computer with a Non-Configurable Software Key


Use the Clean command to remove licenses on a computer with a non-configurable software key.
1. From theLicense Client, click the Advanced tab.
The "Do you need to do something else?" page appears.
2. Click Clean license information on this computer.
3. Select Clean Non-Configurable Software Key.
4. Click Confirm.
5. Select Clean.
6. Click Confirm.

Update Application Settings


Use the Update Application Settings link on the Advanced tab to check your GE Cloud License Server connection,
change the name and location of your computer, set up application event logs, and add and remove sentinel
dependencies.

Checking the GE Cloud License Server Connection


Check your connection to the GE Cloud License Server from the Advanced tab of the License Client.
1. From the License Client, click the Advanced tab.
2. From the Advanced tab, click Update application settings.
The Update Application Settings page appears with the Cloud Connectivity tab selected.
3. Click Test cloud connectivity.
The result of the test is displayed.

Changing the Device Name and Location


Change the device name and location of your computer from the Advanced tab of the License Client.
Changing device name and location information does not affect the licenses on your computer. The alias helps you
search for your assets in the IT (SFDC self -service) system. If you are using a local license server, it appears in the
"Viewing the Client Computer List" in the Local License Server Settings Tool.
| License Client | 27

1. From the License Client, click the Advanced tab.


2. From the Advanced tab, click the Update application settings link.
The Update Application Settings page appears.
3. Click Device Alias to view the alias assigned to this device.

4. To change the alias assigned to this device, update the Device Name or Device Location and click Save.

Setting up Application Event Logs


1. From the License Client, click the Advanced tab.
2. From the Advanced tab, click Update application settings.
The Update Application Settings page appears.
3. Click Logging to display the current logging configuration for this device:

4. To define a different logging threshold, select it from the drop-down list.


| License Client | 28

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.

Adding and Removing Sentinel Dependency


Adding Sentinel Dependency
A Sentinel dependency ensures that the Sentinel and Common Licensing services start up in the correct order.
Use the Advanced tab of the Licence Client to add Sentinel Dependency.
Note: When you perform a License Client installation upgrade that has new drivers, all Sentinel
dependencies are removed.

1. From the License Client, select the Advanced tab.


2. From the Advanced tab, select Update Application Settings.
3. Select the Sentinel Service tab.
4. Select Add Sentinel Dependency.
5. Select Yes to add the dependency to the service.
Removing Sentinel Dependency
Use the Advanced tab of the Licence Client to add Sentinel Dependency.
1. From the License Client, click the Advanced tab.
2. From the Advanced tab, click Update Application Settings.
3. Click the Sentinel Service tab.
4. Click Remove Sentinel Dependency.
5. Click Yes to remove the dependency from the service.

Download the Latest License Client


1. On the Advanced Tab, click "Download the latest License Client".
The GE Software Product Licensing page in a new browser window.
2. Click the green download icon and follow the directions provided to install the License Client.

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.

Re-Flash a Nonconfigurable USB Hardware Key


From the Advanced tab of the License Client, you can re-flash the licensing information on a nonconfigurable GE
USB Hardware Key.
| License Client | 29

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.

1. From the License Client, click the Advanced tab.


The Do you need to do something else? page appears.
2. If necessary, plug in a non-configurable GE USB Hardware Key.
Note: It takes about 30-40 seconds for the software to read the key. Return to the Advanced tab to re-
display the Do you need to do something else? page.

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

Installing the License Client


You can install the License Client using the command line.
1. Open a command-line interpreter window with Administrator privileges.
2. Enter the following:

start /wait ProficyClientInstaller.exe /nomsg /quiet

Unistalling the License Client


You can uninstall the License Client using the command line.
1. Open a command-line interpreter window with Administrator privileges.
2. Enter the following:

ProficyClientInstaller.exe /uninst /r /f1c:\licensing\temp


\SilentClientUninstall.iss

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.

3. Click Yes to remove the License Client.


4. Click Yes to restart your computer now or No to restart your computer later.
| License Client | 30

To run subsequent uninstalls of the License Client using the script created in step 2, enter the following into a
command-line interpreter window:

start /wait ProficyClientInstaller.exe /uninst /s /f1c:\licensing\temp


\SilentClientUninstall.iss

Installing the Local License Server


You can install the Local License Server using the command line.
1. Open a command line interpreter window with Administrator privileges.
2. Enter the following:

start /wait ProficyLicenseServerInstaller.exe /s /v"/qn"

Uninstalling the Local License Server


You can uninstall the Local License Server using the command line.
1. Open a command-line interpreter window with Administrator privileges.
2. Enter the following:

start /wait ProficyLicenseServerInstaller.exe /x /s /v"/qn"

Activating Licenses from the GE Cloud Server


Make sure the License Client is not running concurrently.
You may activate licenses from the GE Cloud Server from the DOS command line or by using a batch file.
Note: You may activate one or more activation codes by separating them with a semicolon. Do not use
spaces between the activation codes.

• To activate licenses from the command line:


a) Open a command-line interpreter window with Administrator privileges.
b) Enter the following:
"c:\Program Files (x86)\Proficy\Proficy Common\Proficy Common Licensing
\ProficyLicenseViewer"
c) Activate a license from the Cloud:
"Start/wait ProficyLicenseWizard.exe -
ActivateFromCloud=1111-1111-1111-1111;2222-2222-2222-2222"
You should receive the following response:
"License(s) were deployed successfully."
Note: If there is an error executing the command, a message displays. More details can be found in the
Proficy License Client log file
• To activate licenses using a batch file, enter your commands in the following format in your batch file:

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.

Activating Licenses from a Local License Server


You can activate licenses from a Local License Server using the command line or a batch file.
Make sure the License Client is not running concurrently.
Note: You can activate one or more activation codes by separating them with a semicolon. Do not use spaces
between the activation codes.

• To activate licenses from the DOS command line:


a) Open a command line interpreter window with Administrator privileges.
b) Enter the following:
"c:\Program Files (x86)\Proficy\Proficy Common\Proficy Common Licensing
\ProficyLicenseViewer"
c) Activate a license from a local license server at IP=1.1.1.1 by entering:
"Start/wait ProficyLicenseWizard.exe -
Lease=1111-1111-1111-1111;2222-2222-2222-2222 -Server=http://1.1.1.1 -
Port=1111"
Note: For the parameters Server and Port, use the server and port number that correspond to your
local license server.

You should receive the following response:


"License(s) were deployed successfully."
Note: If there is an error executing the command, a message will display. More details can be found in the
Proficy License Client log file
• To activate licenses using a batch file, enter your commands in the following format in your batch file:

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.

Activating Licenses for a Non-Configurable Software Key


You can activate licenses for a non-configurable software key using the command line or a batch file.
Make sure the License Client is not running concurrently.
You may activate licenses for a non-configurable software key by using the DOS command line or a batch file.
• To activate licenses from the DOS command line:
a) Open a command-line interpreter window with Administrator privileges.
b) Enter the following:
"c:\Program Files (x86)\Proficy\Proficy Common\Proficy Common Licensing
\ProficyLicenseViewer"
c) Activate a license from a non-configurable software key by entering:
Start/wait ProficyLicenseWizard.exe -ActivateNonConfigSWKey="filepath
\Filename.klic" -Password=Password
| License Client | 32

You should receive the following response:


"License(s) were deployed successfully."
If there is an error executing the command, a message displays. More details can be found in the Proficy License
Client log file.
• To activate licenses using a batch file, enter your commands in the following format in your batch file:

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.

Returning Licenses to GE Cloud Server or Local License Server


You can return licenses to the GE Cloud Server or the Local License Server using the command line or a batch file.
Make sure the License Client is not running concurrently.
Note: You may return one or more activation codes by separating them with a semicolon. Do not use spaces
between the activation codes.

• To return licenses using the DOS command line:


a) Open a command line interpreter window with Administrator privileges.
b) Enter the following:
"c:\Program Files (x86)\Proficy\Proficy Common\Proficy Common Licensing
\ProficyLicenseViewer"
c) Return a license by entering:
"Start/wait ProficyLicenseWizard.exe -
Return=1111-1111-1111-1111;2222-2222-2222-2222"
You should receive the following response:
License(s) were returned successfully.
If there is an error executing the command, a message will display. More details can be found in the Proficy
License Client log file.
• To return licenses using a batch file, enter your commands in the following format in your batch file:

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.

Cleaning Licenses on GE Cloud Server or Local License Server


You can remove licenses from the GE Cloud Server or the Local License Server using the command line or a batch
file. This action is known as “cleaning” licenses.
| License Client | 33

Make sure the License Client is not running concurrently.


• Cleaning is irreversible and removes all existing licenses from your computer. The command-line option does not
display any additional warnings.
• Licenses may be reactivated once the cleaning process is complete.
• To clean licenses from the DOS command line:
a) Open a command-line interpreter window with Administrator privileges.
b) Navigate to C:\Program Files (x86)\Proficy\Proficy Common\Proficy Common
Licensing\ProficyLicenseViewer.
c) Clean licenses by entering "Start/wait ProficyLicenseWizard.exe -Clean".
The following response appears:
"License(s) were removed successfully."
Note: If there is an error executing the command, a message displays. More details can be found in the
Proficy License Client log file
• To clean licenses using a batch file, enter the commands using the following format in your batch file:

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.

Cleaning Licenses from a Non-Configurable Software Key


You can remove licenses from a non-configurable software key using the command line or a batch file. This action is
known as “cleaning” licenses.
Make sure the License Client is not running concurrently.
• Cleaning is irreversible and removes all existing licenses from your computer. The command-line option does note
display any additional warnings.
• You can activate licenses after the cleaning process is complete.
• To clean licenses from the DOS command line:
a) Open a command line interpreter window with Administrator privileges.
b) Navigate to C:\Program Files (x86)\Proficy\Proficy Common\Proficy Common
Licensing\ProficyLicenseViewer.
c) Clean licenses by entering "Start/wait ProficyLicenseWizard.exe -
CleanNonConfigSWKey".
The following response appears:
"License(s) were
removed successfully."
Note: If there is an error executing the command, a message appears. See the Proficy License Client log
file for more details.
• To clean licenses using a batch file, enter your commands in the following format in your batch file:

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.

Adding Sentinel Dependency


You can add Sentinel Service Dependency using the command line. By adding this dependency, you ensure that the
Sentinel Service and Common Licensing start up in the correct order.
Make sure the License Client is not running concurrently.
1. Open a command-line interpreter window with Administrator privileges.
2. Navigate to the following directory:

c:\Program Files (x86)\Proficy\Proficy Common\Proficy Common Licensing


\ProficyLicenseViewer

3. Add sentinel service dependency by entering:

Start/wait ProficyLicenseWizard.exe -AddSentinelDependency

4. You should receive the following response:


“The Sentinel Service dependency was added successfully.”

Removing Sentinel Dependency


You can remove Sentinel Dependency using the command line.
Make sure the License Client is not running concurrently.
1. Open a command-line interpreter window with Administrator privileges.
2. Navigate to the following directory:

c:\Program Files (x86)\Proficy\Proficy Common\Proficy Common Licensing


\ProficyLicenseViewer

3. Remove sentinel dependency by entering:

Start/wait ProficyLicenseWizard.exe -RemoveSentinelDependency

4. You should receive the following response:


“The Sentinel Service dependency was removed successfully.”

Command Return Codes


Commands run in a batch file return success or error codes at completion.
For more information, check the ProficyLicenseClient log file.

Table 1: Return Codes

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]

31 - The license report file format is required.


Usage: -LicenseReport="filepath\Filename" -Format=TXT|HTML [-Overwrite]

32 The license report file format is not valid.


Usage: -LicenseReport="filepath\Filename" -Format=TXT|HTML [-Overwrite]
Code Description
33 The license report file already exists. Please use a different filename.
34 The Lease command server url is invalid. Please prefix the server url with http://
Usage: -Lease=1111-2222-3333-4444;AAAA-BBBB-CCCC-DDDD -Server=http://
serverUrl -Port=3333

35 Unable to add the Sentinel Service dependency.


36 Unable to remove the Sentinel Service dependency.
37 The Sentinel Service dependency was previously added.
38 The Sentinel Service dependency was previously removed or never added.
Chapter

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.

Installing the Local License Server


Use the GE Digital Common Licensing installation software to install the Local License Server, the Local License
Server Settings Tool, and the Local License Server Administration Tool.
• You must install the Local License Server software and the Local License Server Settings Tool on the same
computer, and this computer must communicate with the GE Cloud License Server.
• Locate and back up the FnSvrPro.ini file, which avoids reactivating licenses if you need to reinstall Common
Licensing. After a reinstall, place FnSvrPro.ini in its original location in the install directory.
• You do not need to uninstall earlier versions of any Common Licensing software.
1. Download the latest Common Licensing software from the GE Sofware Product Licensing website.
2. Run the Common Licensing Installer.
3. Install both the Local License Server and the Local License Server Settings Tool on the same computer by
selecting Install Local License Server.
4. Answer the installation prompts.
5. Install the Local License Server Administration Tool on any computer in the network by selecting Install License
Server Tools.
6. Answer the installation prompts.
7. Optional: You can copy the Common Licensing installation software to a flash drive to install the License Client
and the Local License Server Administration Tool on offline computers.

Restricting Access to the Local License Server


The Licensing Software installer automatically creates the FNEServerPortAccess firewall inbound rule that allows
full access to the GE Local License Server (FNE_Server.exe) on port 3333. You can edit this rule to provide certain
users, computers, and IP addresses access to the Local License Server.
Consult with your IT department about making edits to the FNEServerPortAccess firewall inbound rule.
1. In Microsoft Windows, navigate to Control Panel > System and Security > Windows Firewall.
2. Select Advanced Settings.
The Windows Firewall with Advanced Security on Local Computer screen appears.
3. Select Inbound Rules.
A list of the firewall inbound rules appears.
4. If there are more than one instance of the FNEServerPortAccess firewall inbound rule, delete all instances except
one.
5. Right-click the FNEServerPortAccess firewall inbound rule, and then select Properties.
The FNEServerPortAccess Properties screen appears.
6. Select the General tab, shown below, and then do the following:
| Local License Server | 40

a) Select the Enabled check box.


b) If providing users or computers access to the Local License Server, select Allow the connection if it is secure
in the Action section.

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.

Users 1. Select the Users tab.


2. In the Authorized users section, select the Only allow connections from these users check box.
| Local License Server | 41

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.

Local License Server Administration Tool


Use the Local License Server Administration Tool to manage licenses for client devices connected to a Local License
Server. You can quickly add and remove licenses on the server as well as recover GE licenses from clients.

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.

Adding Licenses to the Server


You can add licenses retrieved from the GE Cloud License Server to the Local License Server.

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

2. Select Add Licenses.


The Add Licenses To Server page appears.
3. For each license you want to add, enter the activation code and select Add Code.
As you specify these activation codes, they appear on the page.
4. When all codes are entered, select Activate.
Messages about the progress of the license transfer appear.
5. When finished, select Back to return to the Licenses Activated On Server page to view the licenses you just
added.
6. If you do not see these licenses, select Update Table to refresh the view on this page.

Removing Licenses from the Server


You can remove licenses from the Local License Server that are no longer in use.

Verify the Local License Server is connected to the GE Cloud License Server ( ). If not, see Performing Offline
License Removal on page 44.
• Before you remove any licenses, save their activation codes in case you want to reactivate them in the future.
1. In the Local License Server Administration Tool, select the Licenses tab.
2. Select Remove Licenses.
The Remove Licenses from Server page appears listing all the activated licenses.
3. For each activation code, enter the number of licenses to delete from the server in the Remove column.
4. Select Remove.
5. When finished, select Back to return to the Licenses Activated On Server page to verify the licenses were
removed from the server.
6. Select Update Table to refresh the view on this page.

Recovering Licenses from a Client


You can retrieve all licenses leased to a client device that are no longer in use. These licenses are returned to the Local
License Server pool for lease by other clients.
1. In the Local License Server Administration Tool, select the Connected Clients tab.
A page displays showing all clients leasing licenses from the server.
2. Optional: You can use wildcard characters to search for client devices based on client ID, client alias, and type in
the Search box.
3. Optional: To save this list of current leased licences, 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.
4. Select the check boxes of the clients whose licenses you want to recover.
5. Select Recover Licenses.
All licences issued to the clients are returned to the server license pool.

Reserving Licenses on the Server


You can reserve available licenses on a Local License Server to use at a later time. After you reserve a license, it is no
longer accessible to any client.
1. In the Local License Server Administration Tool, select the Licenses tab.
The Licenses Activated On Server page appears.
2. Select Reservation Licenses.
The Reserve Licenses On Server page appears showing the following columns:
• Total: The total number of licenses on this server.
• Avail: The number of available licenses for clients connected to this server.
• In Use: The number of licenses on this server currently in use by clients.
| Local License Server | 44

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

Viewing Client Computers Leasing Licenses


You can display a list of client devices leasing GE licenses from the Local License Server. This list provides the client
ID, client alias, type, product name, lease expiration information, and activation code.
1. In the Local License Server Administration Tool, select the Connected Clients tab.
A list of client devices that lease licenses from the Local License Server appears.
2. To display the most up-to-date license view, select Refresh Data.
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 connnected clients, 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.

Performing Offline License Removal


When the Local License Server is not connected to the GE Cloud License Server, you can use a connected computer
to process the information required to remove licenses from the offline Local License Server.
• Before you remove any licenses, save their activation codes in case you want to reactivate them in the future.
• Review the offline license management process instructions in the Complete Offline Process page.
• Verify you have access to a computer connected to the GE Cloud License Server and that computer has the Local
License Server Administration Tool installed.
This process requires that you complete the following steps:
1. From the offline Local License Server, create a request file with the license codes for the GE Cloud License Server
to remove. This generated request file in the permanently offline computer is transferred to a computer connected
to the internet.
2. From the online computer, request a response file, which sends the request file to the GE Cloud License Server
for verification. The GE Cloud License Server returns a response file containing the needed informaton to remove
the licenses on the Local License Server. The response file generated in the computer connected to the internet is
transferred to the computer permanently offline where the request file was originally generated.
3. Within 24 hours of receiving a response file, transfer the file into the offline Local License Server to remove the
licenses.
1. To create a request file in the offline Local License Server, do the following:
a) In the Local License Server Administration Tool, select the Licenses tab.
The Licenses activated on server page appears.
b) Select Remove Licenses.
When the Local License Server is not connected to the GE Cloud License Server ( ), the Generate a
Request File to remove licenses on Server page appears.
c) Select Remove Licenses.
d) Specify the file path in Save request file to.
| Local License Server | 45

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.

Performing Offline License Activation


When the Local License Server is not connected to the GE Cloud License Server, you can use a connected computer
to process the information required to activate and update licenses on the offline Local License Server.
• Review the offline license management process instructions in the Complete Offline Process page.
• Make sure you have the email containing the activation codes sent by GE.
• Verify you have access to a computer connected to the GE Cloud License Server and that computer has the Local
License Server Administration Tool installed.
This process requires that you complete the following steps:
1. From the offline Local License Server, create a request file with the license codes for the GE Cloud License Server
to verify. This generated request file in the permanently offline computer is transferred to a computer connected to
the internet.
2. From the online computer, request a response file, which sends the request file to the GE Cloud License Server
for verification. The GE Cloud License Server returns a response file containing the needed informaton to activate
and update licenses on the Local License Server. The response file generated in the computer connected to the
internet is transferred to the computer permanently offline where the request file was originally generated.
3. Within 24 hours of receiving a response file, transfer the file into the offline Local License Server to activate and
update licenses.
1. To create a request file in the offline Local License Server, do the following:
a) In the Local License Server Administration Tool, select the Licenses tab.
The Licenses activated on server page appears.
b) Select Add Licenses.
When the Local License Server is not connected to the GE Cloud License Server ( ), the Generate a
Request File to activate licenses on Server page appears.
c) Select Add Licenses.
d) Specify the file path in Save request file to.
e) For each license you want to add, enter the activation code and select Add Code.
As you specify these activation codes, they appear on the page.
f) When all codes are entered, 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:
| Local License Server | 46

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, activate 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 view the new and updated licenses, select the Licenses tab and then Update Table.

Perform Server Operations


Editing the Server Connection Settings
You can connect your client device to the Local License Server and verify this connection. You can also change the
server name or server IP address, the server port number, and the communications timeout value of the Local License
Server.
1. In the Local License Server Administration Tool, select the Server Operations tab.
2. Select 1, Edit Connection Settings.
3. You can edit these connection values:
• Server Name or IP address.
• Server port number (default is 3333).
• Communications timeout (default is 30 seconds). This applies to both the Local License Server and the GE
Cloud License Server.

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.

Refreshing Licenses on the Server


You can refresh the licenses on the Local License Server with newer versions from the GE Cloud License Server. A
refresh also retrieves any new licenses from the GE Cloud License Server.
You must have connectivity to both the GE Cloud License Server and the Local License Server. Otherwise, the link to
perform a refresh is disabled.
1. In the Local License Server Administration Tool, select the Server Operations tab.
2. Select 2, Refresh Server.
The Refresh Licenses on Server page appears.
3. Select Refresh.
A message appears indicating if the task was successful.
4. When finished, select Done to return to the Server Operations tab.
5. Optional: You can view the updated licenses on the Licenses tab.

Cleaning Licenses on the Server


You can permanently remove all license information from the Local License Server. These licenses are not returned to
the GE Cloud License Server.
| Local License Server | 47

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.

Viewing Server Configuration Information


You can view details about the server, such as its status, type, platform, and number of client connections.
1. In the Local License Server Administration Tool, select the Server Operations tab.
2. Select 4, View Server Information.
The Server Details page appears.
3. Return to the Server Operations tab by selecting Back.

Checking Connectivity to the Cloud


You can verify the connection between the Local License Server and the GE Cloud License Server.
1. In the Local License Server Administration Tool, select the Server Operations tab.
2. Select 5, Cloud Connectivity.
The Cloud Connectivity page appears.
3.
Select .
When connected, a message appears indicating the GE Cloud License Server is accessible.

Checking for LLS NIC MAC Address Change


Use the Local License Server Administration Tool to check for a change made to the Local License Server NIC MAC
address (Server ID).
The current Local License Server ID, such as ID=18DBF2012A5B, appears at the top of each Local License Server
Administration Tool page.
1. In the Local License Server Administration Tool, select the Server Operations tab.
2. Select 1, Edit Connection Settings.
3. If the Local License Server NIC MAC address has changed, the following message appears:
| Local License Server | 48

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.

View Server Logs and Settings


Viewing the Error Log
The error log lists each Local License Server error, including log-level type, description, and date and time stamp.
1. In the Local License Server Administration Tool, select the More Actions tab.
2. Select 1, View Error Log.
The View Error Log page appears.
3. To display the most up-to-date error view, select Refresh Data.
4. To save the error log to a file:
a) Select Save Log to File.
b) Enter the file name, and then navigate to where you want to save this file.
c) Select Save.

Viewing the Access Log


The access log lists all received calls requesting license information from the Local License Server.
1. In the Local License Server Administration Tool, select the More Actions tab.
2. Select 2, View Access Log.
The View Access Log page appears.
3. To display the most up-to-date error view, select Refresh Data.
4. To save the access log to a file:
a) Select Save Log to File.
b) Enter the file name, and then navigate to where you want to save this file.
c) Select Save.

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.

Create and Schedule Reports


Schedule Reports
You can schedule license and device reports to run periodically by creating a batch file, INI file, or script. You can
also schedule expiration reports or run them on-demand from the Windows command prompt using command-line
operations.
Note: For Common Licensing 18.4 and higher, you must use the Local License Server Administration Tool
to run your reports. The Proficy Server Manager is no longer available.

To view command-line operation usage examples, enter the following command:

LLSAdminTool.exe -Help
| Local License Server | 50

Command-Line Options for Creating Reports


You can create and schedule various license and device reports using command-line options.

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

Shows details about


-REPORT=LICENSE [-RESERVED] [-FILE=[Path]Filename] reserved licenses,
[-APPEND]
including the activation
[-INPUTFILE=[Path]\Filename]
codes, the total and
available number of
licenses, the number
of in-use licenses, the
number of reserved
licenses, and the
expiration dates.
Creates either a license
-REPORT=[LICENSE|DEVICE] or device type report.
The reports generated
are the same as clicking
the "Save to File" button
on the View Server
Licenses or View Client.
Computers pages in
the License Server
Configuration Tool.
Note: You
cannot use
LICENSE and
DEVICE at the
same time.

Reports on reserved
[-RESERVED] licenses.
| Local License Server | 51

Local License Server Settings Tool


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.
During installation, the Local License Server Settings Tool is deployed on the same computer as the Local License
Server, and must communicate with the GE Cloud License Server.
Note: Only an administrator can access and use the Local License Server Settings Tool.

Modifying Lease Expiry Period


Use the Local License Server Settings Tool to indicate when leased licenses will expire.
1. In the Local License Server Settings Tool, select the Lease Expiry tab.
2. Enter your lease expiry period: Indicate the number of days when the licenses leased from your Local License
Server will expire.
Note: You can set your Lease Expiry period for a minimum of 7 days and a maximum of 54 days. The
default is 21 days.

3. Select Save.

Setting Up and Sending Email Notifications


Using the Email Notifications page, you can set up the SMTP connection, compose the email notification structure,
select whether to include a License Instance Count report in your email notifications, and indicate whether you want
to be notified when the NIC MAC address changes.
Email notifications are turned off by default. To turn on email notifications, do the following:
1. In the Local License Server Settings Tool, select the Email Notifications tab.
2. Select Turn ON/OFF Email Notifications.
3. In the SMTP Connection tab, enter the following information:
a) Server: SMTP server URL or IP address.
b) Port: SMTP server port.
c) To set SSL authentication, select Enable SSL.
d) To enable anonymous authentication, select Anonymous.
e) If user credentials are required by the SMTP server, select User/Password, and then enter the user name and
password.
f) Select Save.
4. Select the Email Set up tab to define the following email components, set the time for sending email notifications,
and then send a test email:
a) From: Indicate the email address from which you are sending the email notifications.
b) Subject: The application comes with a preconfigured subject that you can modify accordingly.
c) To: Enter the email addresses to receive the notifications. You can send email notifications to multiple
recipients by separating each email address with a semi-colon.
d) Message: Enter the contents of your message.
e) Set the hour and minutes for sending daily email notifications.
f) Send a test email by selecting Send Test Email.
g) Select Save.
5. In the Other Settings tab, do the following:
a) Enter the license expiration days for the License Expiration Report and the Device Expiration Report.
| Local License Server | 52

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.

Checking NIC MAC Address Settings


Although licenses leased and activated by your Local License Server are still valid, a change in the NIC MAC address
(Server ID) prevents subsequent cloud-based activities, such as activating, returning, and refreshing licenses. You can
check to see if the NIC MAC address has changed, and, if required, reset this address.
1. Select Check Now to see if the NIC MAC Address has changed since your last check.
If the address has changed, a message appears outlined in red showing the previous and current NIC MAC
addresses, and the steps you must complete. If the address has not changed, a message appears outlined in green.
2. Select Reset Value to clear the original cached NIC MAC address value, and then reset it to the current NIC MAC
address of the Local License Server.
A message appears indicating if the NIC MAC address reset was successful.

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:

ProficyServerConsole.exe [-INIFILE=[PATH]file.ini] [-TIMEOUT=timeout]

Note: Providing specifications inside [] is optional.

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.

Adding Multiple Activation Codes


You can activate multiple license codes from the Local License Server using the Server Console Tool.
1. Open a command-line window with Administrator privileges.
2. Enter the command in the following format:

ProficyServerConsole.exe [-INIFILE=[PATH]file.ini] [-TIMEOUT=timeout]

Note: For more information, see Server Console Parameters on page 53 and Server Console INI File
Format on page 53.

Removing Multiple Activation Codes


You can remove multiple license codes from the Local License Server using the Server Console Tool.
| Local License Server | 53

1. Open a command-line window with Administrator privileges.


2. Enter the command in the following format:

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.

Server Console Parameters


Use the Server Console parameters to specify timeout values and the location of the INI file.
The optional -TIMEOUT parameter uses the specified communications timeout period when connecting to the local
license server and the GEIP Web Server. If your server communication is timing out or if you have a big list of codes
to add to the local license server, you can use this command line option to increase the timeout period.
You can modify the -TIMEOUT parameter using the following syntax:

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

Server Console INI File Format


You can create an INI-formatted file to specify the server connection and activation codes for the Server Console. You
can add or remove licenses in the same INI file.
The following example illustrates how to format an INI file to manage multiple licenses:

[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

In the above example:


• There are 3 activations on the list
• The list starts at ActID0.
• The ActID0 code followed by (::1) will result in a final total of 1.
• If the server did not have this code, then the code will be added with an absolute total of 1.
• If this code already existed in the server before the request is made, the total will adjust to the quantity that was
just requested.
| Local License Server | 54

• 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

PortNumber=3333 The default port is 3333.


Enter your server port number if your local license server is configured for something
else.

This table explains how to format activation information.

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

ActID0=AAAA-AAAA-AAAA- Where AAAA... is your activation code and 1 is the total


AAAA::1 requested for this particular code.

ActID1=BBBB-BBBB-BBBB-BBBB::3 Where BBBB... is your activation code and 3 is the total


requested.

ActID2=CCCC-CCCC-CCCC-CCCC::0 Where CCCC... is your activation code and 0 is the total


requested.

Server Console INI File Format for Removing Activation Codes


You can use the Server Console INI file to remove activation codes from the Local License Server. You can also
remove all quantities of a code and delete the code from the Local License Server.
To remove all quantities of a code and delete the code from the local license server, the total request must be 0.
The following example illustrates how you can format an INI file to create a removal request:

[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

Checking NIC MAC Address Changes using the Command Line


You can use the command line to check for any changes made to the Local License Server ID/NIC MAC address.
This command runs immediately and displays a message in the command line window.
1. Open a command-line interpreter window with Administrator privileges.
2. Enter the following:

"c:\program files (x86)\Proficy\Proficy License Server


\ProficyLicenseReport.exe" -VALIDATESERVERID
Chapter

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)

Non-configurable GE USB Hardware Key


Non-configurable GE USB Hardware Keys or M5 Keys are pre-loaded with the licensing information for your
products. You cannot modify the licensing information contained in these keys. However, if you need additional
licenses, you can purchase them from GE and then re-flash keys with a GE-supplied image file that overwrites all
existing information and replaces it with updated licensing information.

Configurable GE USB Hardware Key


Configurable GE USB Hardware Keys will continue to be supported by GE. These configurable keys are plugged into
computers connected to the Internet in order to activate licenses on them.
Once activated, a USB key can be used to license a physical or virtual computer that does not need to online.
However, changes, upgrades, or returns require the key to be plugged into a computer connected to the Internet so the
GE Licensing Server can be accessed.
The final legacy licensing option, Keyless software licenses, continues to be supported by GE but will eventually be
phased out.

Configurable GE USB Hardware Keys


Using a Configurable GE USB Hardware Key is another option for licensing your GE software product.
Note: If you are using a Configurable GE USB Hardware Key, be sure to install the Licensing Software
before you plug in the Hardware Key for the first time on your machine. This will install the necessary device
drivers and allow the system to recognize and configure the Hardware Key correctly when it is plugged in. It
may take a few minutes for the system to configure the Hardware Key for the first time, before it is ready to
be used.
The Configurable GE USB Hardware Key that is currently offered supports USB port configurations. The key you
use to run your product:
• Controls and enables software options available to your installation.
• Uses a utility to electronically reprogram options you choose to upgrade or change.
If a license key is not installed or found, your product will run in demo mode for two hours.
Note:
• In some cases, an electronic file update is not available for reprogramming your key.
• You can exchange the older key by contacting your sales representative.
Be sure to file your Configurable GE USB Hardware Key packing slip in a safe location. The codes on this slip are
necessary for GE to quickly duplicate the key in case it is damaged or misplaced. You can verify that your serial
number matches the serial number on the Hardware Key packing slip by using the License Viewer utility to detect and
display your Hardware Key settings.

Configurable GE USB Hardware Key Installation


If a Configurable GE USB Hardware Key is included with your GE software product, you must install your licenses
from the Hardware Key in order to access all the components of the software you purchased.
| USB Hardware Keys | 59

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.

Replacing Defective Configurable GE USB Hardware Keys


A defective Configurable GE USB Hardware Key causes your GE software product to run in demo mode. Make sure
the key is firmly inserted into your USB port before assuming it is defective. Additionally, if the indicator light at the
end of the key is off, then the key is not communicating correctly. You can also use the License Viewer to determine
if the key is defective. If your key is defective, the License Viewer does not display the proper enabled options, or an
error message stating that a hardware key is required to view the enabled options may appear.
GE replaces defective keys as quickly as possible. To obtain a replacement hardware key:
1. Call your local GE technical support representative.
The support representative will instruct you to FAX a completed copy of a Merchandise Return Authorization
form. After receiving the form, GE can program a new hardware key and send it to you overnight.
2. When you receive the hardware key, you must return the old one along with a copy of the form sent with the new
key.
Note: GE reserves the right to invoice you for defective keys that are not returned.
Chapter

5
FAQs and Troubleshooting
Topics:

• How can I troubleshoot


technical issues with my license
activation?
• What are the Rules for
Using Licenses in a Virtual
Environment?
• Licensing Virtual Machines
• Can I Run the Licensing Client
in a Virtual Environment on a
Macintosh?
• Local License Server Does Not
Return Error Responses
• More Licenses are Allocated to
Clients than are on the Local
Server
• Updating Common Licensing:
USB Key Not Recognized
• When can I plug in the
Hardware Key?
• Troubleshooting USB Hardware
Installation
• Changing the Default Local
License Server Port
• Changing the Default Port that
Checks for NIC MAC Address
Changes
• What to Do When the LLS NIC
MAC Address Changes
• What do the lights at the end of
the Hardware Key indicate?
• If I move the Hardware Key to
another port, is it automatically
detected?
• Managing Licenses when your
Network Proxy Server Requires
Credentials
• Setting the Security Protocol in
Commands
| FAQs and Troubleshooting | 62

• Error Messages
| FAQs and Troubleshooting | 63

How can I troubleshoot technical issues with my license activation?


The following are suggestions you can try to resolve the issue or isolate the problem:
• Make sure you have the latest version of Common Licensing Review the License Documentation and visit https://
www.ge.com/digital/licensing-and-product-authorization for more information
• Use the Support Knowledge Base at https://digitalsupport.ge.com/communities to research the issue
• Contact Technical Support at https://digitalsupport.ge.com/communities/CC_Login to create a technical support
case

How do I log in to the GE Digital Support website?


In order to download Common Licensing, you are required to log into the GE Digital support site with an SSO
(Single Sign On) ID. You need to register for an SSO account (click the ‘Register’ link on webpage), or contact Sales
Support to help set up your SSO account.
Note: This is a different login than the one used to log cases at the Customer Center (https://digitalsupport ge
com/communities/CC_Login).

How do I get an emergency activation code or license?


If you have a plant-down situation, GE Digital can issue a temporary activation code or license that can be installed
immediately on your computer. Contact Sales Support for assistance, or if the issue occurs outside of business hours,
contact Technical Support. Visit https://digitalsupport.ge.com/communities and click Contact Us for support phone
numbers.

What are the Rules for Using Licenses in a Virtual Environment?


The License Client supports virtualization for both local license server-based licenses and GE Hardware Keys.
If you are using GE Hardware Keys in a virtual environment:
• When mounting USB devices from the client side and not using the physical host USB ports, the USB storage
device should be mounted before the GE Hardware Key.
• If you are mounting more than one SafeNet USB Key at a time, wait for the first SafeNet Key to successfully
connect to the virtual machine before mounting additional keys.
• If you are activating a blank GE Hardware Key for the first time, activate the key outside of the virtual machine
before using it in a virtual environment.
• Software-based licenses do not work in virtual environments.
• Hardware-key licenses can be used in virtual environments.
• Local license server-based licenses can be used in virtual environments.
• The local license server can run on either a physical machine or a virtual machine.
Note: Hardware-key licenses are not supported for license-server configuration.

Licensing Virtual Machines


Use a host personal computer as the Local License Server to license virtual machines (VMs). This is particularly
useful when your PC has multiple product software versions, each running on a unique VM.
The host PC must be connected to the internet for the initial licensing of the Local License Server from the GE Cloud
License Server. After the license is activated, the host PC does not need to stay connected. The VM computer then
| FAQs and Troubleshooting | 64

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

2. In the VM computer, do the following:


a) Ping the host PC in the VM command prompt to verify connectivity, as shown below.
C:\Users\aUser>ping A-Computer
When connected, replies from the host PC appear.
b) Run Common Licensing and select Install License Client.
c) Launch the Local License Client in the VM.
d) When prompted to activate the license in the Activate Licensing tab, select option 2 (Yes, for this computer
from a local license server).
e) In the next screen, change the value in the Local Server connection URL field to http://<host PC name>,
such as https://LicenseServer.GE.com, select Display Available Licenses, select the license, and then select
Activate.
f) Verify the license exists in the client in the View Licenses tab.
After the lease expiration date, you may need to reconnect to the host PC to check out its license.

Can I Run the Licensing Client in a Virtual Environment on a Macintosh?


You can run the Licensing Client in a Virtual Machine environment on a Macintosh computer.
The following tests have been performed for this configuration:
• Connectivity to the GE Cloud License Server.
• Changing logging level to debug.
• Leasing licenses from a Local License Server.
• Cleaning and refreshing leased licenses.
• Viewing licenses from a pre-configured license key.
• Generating an error if too many hardware keys are inserted.
• Displaying licenses after removing hardware key.
• Returning leased licenses to a Local License Server
Note: If you run the License Client on a Virtual Machine, you cannot activate licenses directly from the GE
Cloud License Server or on a GE USB Hardware Key.
| FAQs and Troubleshooting | 65

Local License Server Does Not Return Error Responses


When the local license server does not return error responses, no licenses are changed on the server.
The Local License Server may not return error responses if: .
• There is a Local License Server that already has licenses assigned.
• A request is generated to add or remove licenses.
• The request contains an error that the server cannot process.

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.

Issue/Error Title/Error Category


Client A will get License B, but will fail with License A because they have all been activated. Client A is notified of
this by a "Feature Count insufficient" pop-up. The problem is that Client A will now show no licenses in the License
Client (while it appears that Client A should have a License A as well as License B).
CauseAll of the total licenses for License A have been activated.

SolutionThe solutions depend on which clients should have the licenses:

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.

Updating Common Licensing: USB Key Not Recognized


Rebooting the computer after removing hardware keys can help the License Client recognize the keys during the
upgrade process.
| FAQs and Troubleshooting | 66

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.

When can I plug in the Hardware Key?


You must install the Licensing Software before you plug in the hardware key for the first time on your machine. This
will install the necessary device drivers and allow the system to recognize and configure the hardware key correctly
when it is plugged in.
It may take a few minutes for the system to configure the hardware key for the first time, before it is ready to be used

Troubleshooting USB Hardware Installation


The License Client requires between 20 and 60 seconds to recognize and read a GE USB Hardware Key. The USB
icon in the footer indicates the status of the hardware key. If no hardware key is detected, the icon is not illuminated.
If the hardware key is detected and successfully read, the icon is illuminated. If the key is detected but has not been
successfully read and is unable to interact with the License Client, the icon is illuminated with a red slash.
Note:
• When you plug in the hardware key, an alert message may be displayed indicating that the computer is
interacting with the hardware key, and the License Client does not automatically refresh.
• On some older Windows operating systems, when you plug in the hardware key, there is no indication
that the License Client is interacting with the hardware key, and the License Client does not automatically
refresh.
In both of these cases, you may need to click the Refresh Data button on the View Licenses page to
display the license information from the hardware key.

Adding a Dependency for Hardware Keys


If you have startup issues when using a hardware key, you can add a dependency on the "hasplms" service. Refer to
the Adding Sentinel Dependency on page 34 topic for more information.
1. From the Windows Start menu, in the Search Programs and Files box, enter "regedit.exe" and press Return.
2. In the Registry Editor dialog box, navigate to the following folder:

[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

7. Close the Registry Editor dialog box.


For any other GE software products starting as a system service (such as iFIX, CIMPLICITY, and Historian) and for
the IGS driver, you should add this dependency.

Changing the Default Local License Server Port


The default port for the Local License Server is 3333.
If you are having issues with the default port, you can change it by following this procedure.
1. In the Local License Server Administration Tool, select the Server Operations tab.
2. Select Edit Connection Settings.
3. Enter the new server port number.
4. Select Save.

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:

<setting name="ServerHelperPort" serializeAs="String">


<value>33331</value>
</setting>
<setting name="CheckServerIdChanged" serializeAs="String">
<value>True</value>
</setting>

3. Save the file.

What to Do When the LLS NIC MAC Address Changes


Licenses leased and activated by your Local License Server are still valid in the event of a NIC MAC address (Server
ID) change. However, a NIC MAC address change prevents subsequent cloud-based activities, such as activating,
returning, and refreshing licenses.
You can do one of the following:
• Revert back to the original NIC MAC address.
• If you rebuilt the server and do not need to reclaim any license codes from the original server, you must
remove all licenses from the Local License Server, as explained in Cleaning Licenses on the Server on
page 46, and then reset the cached NIC MAC address value, as explained in Setting Up and Sending Email
Notifications on page 51.
| FAQs and Troubleshooting | 68

• If you rebuilt the server and must reclaim license codes from the original server, contact GE Customer
Support.

What do the lights at the end of the Hardware Key indicate?


For keys with a single light, the light indicates that the key and the software are communicating. If this light is off, it
indicates a problem with the key or the hardware driver.
For keys with two lights, the red light indicates that the computer sees the key. If the light is off, it indicates a problem
with the key or the hardware driver. The blue light, when flashing, indicates that data is being sent between the
computer and the key.

If I move the Hardware Key to another port, is it automatically detected?


Yes. The hardware key is automatically detected when moved to another USB port. No additional screens requesting
software installation will appear.

Managing Licenses when your Network Proxy Server Requires Credentials


1. Launch the License Manager application. You should be able to find it in the following location
2. Click Manage Licenses.
3. Select either Activate License or Return License.
4. Enter your username, password, and domain (if applicable).
Note: Please contact your IT professional for more information regarding your domain credentials.

For more details, refer to the Proficy License Manager log file.

Setting the Security Protocol in Commands


You can set TLS (Transport Layer Security) 1.1 or TLS 1.2 as an option in any of the Local License Server
commands.
To set TLS as the security protocol, specify -TLS11 or -TLS12 in the command.

Error Messages
Visit https://digitalsupport ge.com/communities/CC_Login to create a Technical Support case.

What does "activation ID count exceeded" mean?


You will receive this error if you try to use an activation code that is already in use on another computer To resolve
it, locate the computer that has the license in use and use License Client to Return the license Then it will become
available for use elsewhere If you are unable to return the license because of a hard failure, contact Technical Support
and they can assist you in recovering your licenses.

What does "storage binding break found" mean?


You will get this error message if you have changed the computer name, NIC.
| FAQs and Troubleshooting | 69

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 .

What does "activation ID ownership mis-match" mean?


Each activation code is associated with your CSN (Customer Service Number). Each machine can only be associated
with one CSN. When you activate licenses to the GE Digital Cloud License Server, your machine will be assigned a
CSN. If you then try to use another activation code that is associated with a different CSN (even if you had returned
the previous license), you will get this error message.
To resolve this issue, contact Technical Support and they can assist you in associating your machine with the correct
CSN

Why am I getting an "option is not enabled" error?


This error can occur if:
• You are trying to use a feature or product and do not have that option enabled on your license.
Use the License Client to verify the options available on your license If you need to add options, contact Sales
Support or your local representative
• You do not have the latest version of Common Licensing.
There may be discrepancies between the options on the license and how the older version of Common Licensing
is interpreting them. Install the latest version of licensing from https://www ge com/digital/licensing-and-product-
authorization.
• You have installed the latest Common Licensing software and verifed that you have the option in License Client.
There could be an issue with the license configuration that needs to be corrected by GE Digital. Contact GE
Digital Technical Support for assistance
Chapter

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.

You might also like