Proficy HMI/SCADA - CIMPLICITY 7.

0 (and
Higher) Licensing Checklist v1.1

Overview
All current GE Intelligent Platforms Inc. (GE IP) Software including Proficy HMI/SCADA - CIMPLICITY 7.0,
and higher, uses a third party licensing engine by SafeNet Inc. (Formerly Aladdin Knowledge Systems
Ltd.). This robust and secure licensing solution allows a common platform for all GE IP software via USB
licensing keys. With this licensing mechanism, only one USB key is supported per operating system
instance; however, many GE IP products may be licensed from the one USB key.

Note: Soft keys that replace the physical USB key are available under specific circumstances and are
considered outside the scope of this document.

As Figure 1.1 depicts, there are three primary elements to be concerned with in regards to how
licensing is accessed by Proficy HMI/SCADA - CIMPLICITY. At the lowest level there is the hardware
layer and operating system which detects the presence of the USB key. Next in the licensing sequence
is the Proficy licensing drivers (HASP Drivers), License Viewer, and Proficy Licensing service software.
These features give the operating system and Proficy applications the ability to read the license
information from the USB key. The final step in this sequence is the cached licensing system used by
Proficy HMI/SCADA - CIMPLICITY to request and manage the licensing information from the licensing
client software.

Thus, when troubleshooting Proficy licensing it is importation to verify each of these three core areas in
a sequential manner to find the problematic link in the Proficy licensing chain.
USB License Key

License Viewer -
Proficy.ManagementConsole.exe

Show License - Showlicense.exe

Windows Device
Proficy Licensing - Services.msc

1 2 3

Figure 1.1 – Proficy HMI/SCADA -CIMPLICITY 7.0, and Higher, Licensing Overview

1. Verifying the USB Licensing Key and PC Hardware.

1.1 Insert the USB key into the system and ensure it is detected and installed by Windows. To verify
it is installed correctly go into the Windows Device Manager (via Control Panel->System-
>Hardware->Device Manager), or via the run command (via Start->Run->devmgmt.msc). If the
USB key is properly installed there will be a valid entry for it under the “Universal Serial Bus
controllers” section in the device manager.

Note: If it is installed properly please proceed to “Step 2 – Verify License Client.”

 Figure 1.2 – Executing the Windows Device Manager via the Start->Run command.

Figure 1.3 – Review Windows Device Manager

Note: The name of the driver will change based upon which version of the USB key you are
using. These names include Aladdin HASP HL Key, Aladdin HASP Key, Aladdin USB Key, SafeNet
Inc. HASP Key, SafeNet Inc. Sentinel HL Key, and SafeNet Inc. USB Key.

1.2 If the USB device was not detected by Windows the USB port needs to be verified for
functionality by plugging in a known working device into it and ensuring proper installation and
operation.

1.3 If the USB device is detected by Windows Device Manager but an issue is encountered this will
be indicated in the Device Manager by a Yellow Triangle with and “!” or “?” in the center.

Note: The errors may vary depending on the problem encountered. See Figure 1.4 for samples
of what an error would look like.
 Figure 1.4 – Windows Device manager with example errors

1.4 Stop all GE IP Software that is currently running on the computer.

If any GE IP Software is running as a Windows Service, then stop these services from the
Windows Services Panel (i.e. Start->Run->services.msc)

Now go to add/remove programs and uninstall any M4 Common Licensing, GE Fanuc Licensing,
Intellution Licensing, or Sentinel System Drivers software.

Once the software is uninstalled then reboot computer.

Figure 1.5 – Removing Proficy Licensing from Programs and Features.

 Note: In Windows 7/2008 the utility used to remove or add software is now called “Programs
and Features”, whereas in Window XP/2003 it is called “Add/Remove Programs”.

1.5 Download the latest Proficy Licensing software.

Open a Web browser and navigate to http://support.ge-ip.com and click the link “Licensing Key
Updates” under the “Quick Picks->Tools” on the right side of page.

Go to the “Updating the Max/M4 or Pro/M1 Key” section and go to Step C “Download and install
the latest Proficy Licensing Software” section to obtain the latest Licensing software and HASP
drive for your key.

Note: The latest version of the Proficy Licensing software can also be found by searching for
DN2266 at http://support.ge-ip.com.

1.6 Once the Proficy Client Licensing software is downloaded then run the installation to install the
drivers onto the computer.

1.7 Now shutdown computer, attach the USB hardware key to the appropriate working USB port
and restart computer.

Note: Ensure the USB port is functional by testing alternate USB devices.

1.8 Validate that the Window device manager properly detects the USB Key installation. If the key is
still not recognized please call GE IP Technical Support for more details at 1-800-433-2682.
2. Verification of the USB key via the Proficy Common
License Client
2.1 Open the Windows Services panel and Verity that the “Proficy Licensing” service is running. The
services control panel can be found via Start->Run->Services.msc .

Figure 2.1 – Checking the Proficy Licensing Service Status.

2.2 In Windows open the Proficy License Viewer by going to Start->Programs->Proficy Common-
>License Viewer. If the license does not gives an error upon opening and the license information
displayed is correct please proceed to “Step 3 – Updating the Proficy HMI/SCADA CIMPLICITY
License Cache”. If any error message appears please continue on to step 2.2.

Figure 2.2 – Opening the Proficy Common License Viewer.

 Figure 2.3 – Viewing the contents of a key via the Proficy Licensing Viewer.

Figure 2.4 – Checking the version and SIM via the CIMPLICITY Workbench.
This can be done via the Help->About Workbench dialog.

When reviewing the Proficy HMI/SCADA - CIMPLICITY licensing information on the key it is
important to ensure the licensed version matches the installed version of Proficy HMI/SCADA
CIMPLICITY, and that all options/protocols configured in the project are licensed. If you are
licensed for a version of Proficy HMI/SCADA – CIMPLICITY that is higher than the version you
are currently running (which is greater than CIMPLICITY 7.0) then the licensing should be
adequate. However, if the license on the USB Key is lower than the version of CIMPLICITY
installed this will not function and you must call your local distributor to help you initiate the
upgrade process.

Figure 2.5 – Example Proficy License Viewer Errors.

 Figure 2.6 – Errors due to an older version of Proficy Licensing software installed.

When using a USB key, the Proficy Licensing software must be at least the same version that
the key was generated on, or newer. If the version of the Proficy Licensing software is lower
than what the USB Key was generated with then the errors as shown in Fig 2.5 and Fig 2.6 will
occur. To remedy this situation the newer version of the Proficy Licensing software must be
downloaded and installed.

Figure 2.6 – Errors due to an expired USB Key.

If the USB license key has expired then a notification dialog (see Fig 2.7) will appear and the key
will be non-functional. It will require an update to a valid license to function properly.

2.3 Shut down all GE IP Software on the computer. If any GE IP Software is currently running as a
Service, please stop these services from the Windows Services Panel (Start->Run->services.msc
).

2.4 Navigate to Add/Remove programs and uninstall any M4 Common Licensing, GE Fanuc
Licensing, Intellution Licensing, or Sentinel System Drivers.

Once this is uninstalled please reboot the computer.

2.5 Using your Web browser, please navigate to http://support.ge-ip.com and select the link for
“Licensing Key Updates” under the “Quick Picks->Tools” on the right side of the page.

2.6 Navigate to the “Updating the Max/M4 or Pro/M1 Key” section and go to Step C “Download and
install the latest Proficy Licensing Software” section to obtain the latest Licensing software and
HASP drive for your key.

Note: The latest version of the Proficy Licensing software can also be found by searching for
Download DN2266 at http://support.ge-ip.com.

2.7 Download the Proficy Client Licensing software and run the installer.

2.8 Shut down the computer, attach the USB hardware key to the appropriate working USB port
and then restart computer.

2.9 Open the Proficy License Viewer again. If the key is still not recognized please call GE IP
Technical Support for more details at 1-800-433-2682.
3. Updating the Proficy HMI/SCADA - CIMPLICITY License
Cache
In some situations it is possible that the Proficy HMI/SCADA - CIMPLICITY processes will start and
access an out of date licensing cache. This can result in the system thinking it is unlicensed, when in
fact the correct licensing key is plugged into the system. This situation typically occurs in development
situations where keys are plugged and unplugged from the system while some of the Proficy
HMI/SCADA - CIMPLICITY software is still running, or due to timing issues due to auto-start of a project
on boot.

In these situations it is possible that the software has not read a recent update to the licensing, or the
licensing was unavailable at the time of the process start. Additionally it is also possible that the
CIMPLICITY HMI Service (or any CIMPLICITY Service) has lost its dependency on the Proficy Common
Licensing software. This can result in CIMPLICITY attempting to start before the licensing is properly
running and available (see KB12183 for instructions on how fix this).

As such, it is possible to update the cached copy of the license so that the Proficy HMI/SCADA -
CIMPLICITY software has the correct up-to-date license. To do this the “showlicense” utility must be
used.

Note: The “showlicense” utility is specific to Proficy HMI/SCADA – CIMPLICITY and is not available for
any other GE IP licensed products.

To update the Proficy HMI/SCADA – CIMPLICITY cache using “showlicense” please do the following:

3.1 Stop all CIMPLICITY Projects, programs, and services.

3.2 Make sure the USB key is inserted in the computer on which the utility will be run.

3.3 In Windows click the Start Button->Run

3.4 Type "Showlicense.exe" and press "ENTER"

Figure 3.1 – The showlicense utility dialog.

3.5 In order to update the CIMPLICITY licensing cache please click on the "Direct" radio button. This
display should reflect the correct values of what are on the key and displayed in the Proficy
License Viewer.

3.6 Now click on the Refresh button. This will force the license utility to update with what is on the
physical key via the Proficy Licensing Service.

Note: The Proficy Licensing Service can take up to 30 seconds to detect a USB Key change.

3.7 Click "Update Cache". This will update the cached copy of the license. This basically copies the
contents of the license from the physical key into the CIMPLICITY license cache. After doing this,
the Direct/Cache displays should contain the same information.

3.8 Click "OK" and then close the Show License utility.

3.9 If all the licensing information looks good up to this point you should be able to now start your
Proficy HMI/SCADA - CIMPLICITY application/project without any licensing relates issues. If the
issue persists please call GE IP Technical Support for more details at 1-800-433-2682.