CYME

Power Engineering Software

CYME - License Manager -

Reference and Users Guide
ALL RIGHTS RESERVED
No part of this publication may be reproduced, or transmitted in any form or by any means without the written permission
of CYME International T&D. Possession or use of the CYME software described in this publication is authorized only
pursuant to a valid written license agreement from CYME.

CYME makes no warranty, either expressed or implied, including but not limited to any implied warranties of
merchantability or fitness for a particular purpose, regarding these materials and makes such materials available solely on
an "as-is" basis.

CYME International T&D reserves the right to revise and improve its products as it sees fit. The information in this manual
is subject to modification without notice.

While every precaution has been taken in the preparation of this manual, CYME assumes no responsibility for errors or
omissions, or for damages resulting from the use of the information contained herein.

CYME International T&D Inc.

1485 Roberval, Suite 104
St. Bruno QC J3V 3P8
Canada

Tel.: (450) 461-3655

Fax: (450) 461-0966
Canada & United States: Tel.:1-800-361-3627

Internet : www.eaton.com\cyme
E-mail: [email protected]

Other Trademarks: The names of all products and services other than CYME’s mentioned in this document are the
trademarks or trade names of the respective owners.

 Copyright CYME International T&D Inc.

CYME
Power Engineering Software Contents

Contents
1 – Getting Started ............................................................................................................ 1
Overview of the License Manager ........................................................................ 1
Recommended System Requirements ................................................................. 2

2 – Installing Software Licenses ...................................................................................... 5

Software Licenses ................................................................................................ 5

Hardware Licenses ............................................................................................... 7

3 – License Manager Interface ......................................................................................... 9

The Licenses Window ........................................................................................... 9
The Detachable Licenses Window ...................................................................... 10
The Registration / Admin Window ....................................................................... 11

4 – Advanced Configuration of the License Manager .................................................. 13

Index................................................................................................................................. 15

Doc-To-Help Standard Template iii

CYME
Power Engineering Software 1 – Getting Started

1 – Getting Started

Overview of the License Manager

The License Manager program is a dedicated interface created to assist the user in configuring access
to the CYME software applications.

Note: Throughout this manual, the word CYME is used to refer to any of the CYME,
CYMCAP, CYMGRD and CYMTCC applications.

Two types of protection key are available: a hardware USB physical key connected behind the
computer or a software license key residing in the memory. Both are available as a standalone version
(used only on a single computer) or as a network version that is generally installed on a dedicated
server that counts the number of concurrent users.
The following USB hardware keys are available:

Standalone (local) perpetual key.

Standalone (local) Time period or expiration date key.

Network perpetual key.

Network time period or expiration date key.

And the following software license keys are also available :

• Standalone (local) perpetual key.

• Standalone (local) Time period or expiration date key.
• Network perpetual key.
• Network time period or expiration date key.

CYME - License Manager - Reference and Users Guide 1

 CYME
1 – Getting Started Power Engineering Software

Recommended System Requirements

Hardware Requirements
The CYME license manager requires a computer using Microsoft Windows® 7, 8, 8.1 or 10; or using
Microsoft Server 2008, 2008R2, 2012 or 2012R2. The minimum hardware requirements are:

• An Intel I5-based computer

• A minimum of 2 GB of RAM
• 1 GB of hard disk space

Software Requirements
The Microsoft .NET Framework Version 2.0 is strongly recommended to be installed on the computer.

Access Rights
After the CYME software is installed successfully, please make sure the user has read access to the
following folder:
C:\ProgramData\CYME\Common Files

Please also make sure the user has at least read access right to the following folder:
C:\ProgramData\CYME\License Manager

For access rights relating to configuration files, please refer to the sections titled “Configuration File
Management” of the respective chapters depending on the type of installation.

Installing the License Manager

The License Manager is installed automatically with any of the CYME software. The related files will
appear in a sub-folder of the main application installation directory. Should you want to install only the
License Manager on a server, without any CYME main application, you may do so by downloading only
the License Manager package from the download section of the user portal (my.cyme.com).

The following installation procedures are valid if you have a hardware USB physical key connected
behind the computer or a software license key residing in the memory. Both of these types of keys are
available as a standalone version (used only on a single computer without a possible remote
connection) or as a network version that is generally installed on a dedicated server and counts the
number of concurrent users. The installation procedure varies depending if you have a hardware or a
software key, and the installation procedure for both are described in more details in chapter 2 –
Installing Software Licenses.

2 CYME - License Manager - Reference and Users Guide

CYME
Power Engineering Software 1 – Getting Started

Hardware Keys Setup

The following instructions are valid for all type of keys:

• Make sure you install your application or the License Manager setup installation package prior to
connecting the key. By default, the License Manager driver will be installed by the application
package. If you wish to install only the License Manager driver on a server, you may download the
installation package via the https://my.cyme.com/downloads/ user portal.
Please note that an account is required to access the user portal.

• Connect the key to the USB port. If the LED lights up, then the key is being recognized by the
system. If the LED does not light up, please contact us at [email protected] to diagnose
the problem.

Software Keys Setup

The following instructions are valid for all type of keys:

• Make sure you install your application or the License Manager setup installation package. If you are
installing the license on a server, please make sure the license is being installed on the computer
that will act as the server.

Running the License Manager

The License Manager program can be started under the Windows Start button > All Programs >
CYME > License Manager > License Manager Setup x.x rev x.

CYME - License Manager - Reference and Users Guide 3

CYME
Power Engineering Software 2 – Installing Software Licenses

2 – Installing Software Licenses

Software Licenses

New Software Licenses

New software licenses are activated using a “Registration Number” normally sent via an e-mail that
should look like this:
Registration Number

Your registration number to enable your software: 1234567891234567890»

…
Order information:

Company Name
Contact Name
Contact e-mail
Customer #
Order Number:

The first line contains your registration number that you will use to activate your software license. You
will need to open the License Manager Interface (see chapter 3 – License Manager Interface for more
details about this interface).

CYME - License Manager - Reference and Users Guide 5

 CYME
2 – Installing Software Licenses Power Engineering Software

1. Go to the Windows Start button > All Programs > CYME > License Manager > License
Manager 2.x.
2. In the dialog box that appears, select the Registration / Admin tab.

3. Copy and paste the registration number you have received from us in the Registration Number
field and click on Register. This process could take a few seconds.

4. Now, your application is ready to use. To verify that the licenses are working correctly, go to the
Licenses tab window (see section titled The Licenses Window in chapter 3).

5. Check at the bottom part of the dialog box for details if an error occurs. If an error occurs, you may
use the Test function to see if any Internet connection or firewall issues could be the source of the
problem. Depending on the security level of your Web browser, you might have to confirm that you
trust this source. The resulting Web page should display messages similar to the following:
Project (HASPClient) - Test Results
Tests:

Database connection : PASSED

System Information: Server System Time : 2009-05-14 14:58:02
Server Version:
Version : 3.50
VersionEx : 3.50.117
VersionDB : 3.50.117.243

Network License: If you are receiving a network license, the steps mentioned above have to be
performed on the computer that will act as the license server.

6 CYME - License Manager - Reference and Users Guide

CYME
Power Engineering Software 2 – Installing Software Licenses

Updating Software License

An update of your current software licenses may be required when a license has expired, when a
product version has changed, or when additional modules are added, etc. For such license update, you
will be receiving a “V2C” file by e-mail. To introduce this update, open the License Manager Interface
(see above for more details), go to the Registration / Admin tab window and click on the Apply V2C
Update button, as shown below. Browse for the V2C file and click the Open button. The process could
take a few seconds, but once the process is completed, a confirmation message is displayed in the
bottom part of the dialog box.

Hardware Licenses

New Hardware Protection Key

Please refer to section titled Hardware Keys Setup in Chapter 1. Once the setup step is completed,
simply connect the USB key to either the local PC or to the server.

Updating the Hardware Protection Key

Updating the hardware protection key follows the same procedure as for updating a software license.
Make sure the USB key that is to be updated is connected to your computer and please refer to section
titled Updating Software License earlier in this chapter 2 for information.

Replacing an Older USB Protection Key by an Updated One

This procedure described in this section is mandatory when updating an existing CYME software from
an older version to a newer one, and that you already have a USB key provided by CYME which
measures 1.5” long TIP-TO-TIP. If you have a 2” long key, please contact us at
[email protected] as that key will need to be physically replaced by a 1.5” key.
The procedure described in this section is applicable when performing the following upgrades:

• Older version of CYMDIST to CYME 5.x and above

• Older version of CYMTCC to CYMTCC 5.x and above
• Older version of CYMCAP to CYMCAP 5.1r2 and above
• Older version of CYMGRD to CYMGRD 6.3.8 and above
• Older version of PSAF to PSAF 3.3.1.1 and above

CYME - License Manager - Reference and Users Guide 7

 CYME
2 – Installing Software Licenses Power Engineering Software

When the hardware key requires an update for any of the software upgrade listed here above, please
follow the steps indicated below:
1. Connect the USB key if it is not already connected to the computer.

2. Start the License Manager application.

3. Go to the Registration / Admin tab.
4. Click the Update USB Key Firmware button.

5. A “successful” message should be displayed at the bottom of the dialog box. If such message is
not displayed, please stop the process and contact us at [email protected].
6. Click the Collect C2V button; this will open a dialog box.

7. Two options are available in the drop-down menu, please select the Hardware key option as
shown in the illustration below.

8. Save the file on your computer and send it to us by e-mail to [email protected]

9. Once we receive the file, a license file (.V2C file) will be generated accordingly and sent to you by
e-mail.
10. Once you receive the new *.V2C file, please save it on your computer (the location at which the file
is saved is not important).
11. In the CYME License Manager > Registration / Admin tab, click the Apply C2V button. Browse
for the *.V2C file you have saved and click Open.

12. Now, your CYME application is ready to use. To verify that the licenses are working correctly, go
to the Licenses tab window of the dialog box (see section titled The Licenses Window in chapter
3).

8 CYME - License Manager - Reference and Users Guide

CYME
Power Engineering Software 3 – License Manager Interface

3 – License Manager Interface

The Licenses Window

The Licenses window lists the software or modules that are accessible from your computer and the
availability of each depending on the number of licenses acquired and the number in use concurrently.

• From the left-hand side pane, you can filter the license listing by selecting a specific
server/software or chose to see the licenses for all software available. There could be licenses
available from a remote computer on the server, and there also could be licenses available from a
key residing locally on your computer.
• To disable access to a certain module, uncheck the check box in the Enable column.

CYME - License Manager - Reference and Users Guide 9

 CYME
3 – License Manager Interface Power Engineering Software

The Detachable Licenses Window

When a network license protection key is used, it is possible to “Detach” a license from the server to
enable the module to work as standalone when the computer is not connected to the server or to a
physical key. Note that it is possible to block or restrict the possibility to detach a license in the network
server license manager. See Chapter 4 – Advanced Configuration of the License Manager for more
details.
To detach a license, follow the steps listed below:
1. Open the License Manager application and click on the Detachable Licenses tab.

2. Select the module license(s) to be detached by enabling the right-most checkbox of the
corresponding row.
3. Set the expiration date of such license detaching, after which the detached licenses will not be
available when working without being connected to a license key physically or remotely.
4. Click on the Detach button next to the Expiration Date to complete the detach process.

Once a license has been detached from the server, it can only be re-attached while being connected to
your company network or until the expiration date is reached.

10 CYME - License Manager - Reference and Users Guide

CYME
Power Engineering Software 3 – License Manager Interface

The Registration / Admin Window

While working in a network environment or using a protection key connected to a server, the
Registration /Admin tab window of the License Manager provides the most important options to
connect to the server.

• Allow Remote Access to ACC

This option makes it possible for a remote user to change some of the license settings. When
checked, this option enables other network users to access and perform actions on the Admin
Control Center (ACC) on this machine.

• Enable Detachable Licenses

When selected, this option enables detachable license option described in section titled The
Detachable Licenses Window in this chapter 3.

• Aggressive Search for Remote Licenses

Enable this option when having problems finding a remote server. This option could be required on
some network due to firewall restrictions. Selecting this option will enable this machine to connect
to remote HASP License Managers, even though they cannot be detected using UDP datagram
search methods. The Aggressive Search method reduces the update frequency of remote HASP
information, but may enable firewalls to be transverse.

CYME - License Manager - Reference and Users Guide 11

 CYME
3 – License Manager Interface Power Engineering Software

If the problem of finding a remote server persists after enabling the Aggressive Search option, type the
IP Address or server name in the Server field. Such operation defines the specific machines that may
be searched by this machine for remote HASP License Managers. You must enter information in this
field even if you have not enabled the Allow Remote Access to ACC checkbox, as follows:

• Specify data as IP addresses (e.g. 10.1.1.17), Broadcast addresses (e.g. 10.1.1.255), or machine
names (e.g. hklm001.ecomp.com)
• When using the IPv6 protocol, use the IPv6 address format. For example, type FF02::1 to access
all remote HASP License Managers that are part of the default local group defined in the IPv6
subnet.
• Each entry must be on a separate line.

12 CYME - License Manager - Reference and Users Guide

CYME
Power Engineering Software 4 – Advanced Configuration of the License Manager

4 – Advanced Configuration of the License Manager

An additional interface is availaible to further customize the protection key. To access it, you may use
the Open Admin Control Center hyperlink provided in the Registration / Admin tab of the License
Manager or you may directly type the following address in your Web browser: http://localhost:1947
You will be presented with the SafeNet Admin Control Center Help as shown below, where help
topics and instructions are presented. Once into any of the pages of this interface, you can return to the
mainhelp topics and instructions page using via the Help hyperlink located at the bottom right of each
page of this web interface.

CYME - License Manager - Reference and Users Guide 13

CYME
Power Engineering Software Index

Index

1 – Getting Started ........................................................ 1

2 – Installing Software Licenses .................................... 5
3 – License Manager Interface ...................................... 9
4 – Advanced Configuration of the License
Manager .................................................................. 13

Access Rights ............................................................... 2

Hardware Keys Setup ................................................... 3
Hardware Licenses ....................................................... 7
Hardware Requirements ............................................... 2
Installing the License Manager...................................... 2

New Hardware Protection Key ...................................... 7

New Software Licenses................................................. 5
Overview of the License Manager ................................. 1
Recommended System Requirements.......................... 2
Replacing an Older USB Protection Key by an
Updated One ............................................................. 7

Running the License Manager ...................................... 3

Software Keys Setup..................................................... 3
Software Licenses ......................................................... 5
Software Requirements................................................. 2
The Detachable Licenses Window .............................. 10

The Licenses Window ................................................... 9

The Registration / Admin Window ............................... 11
Updating Software License ........................................... 7
Updating the Hardware Protection Key ......................... 7

CYME - License Manager - Reference and Users Guide 15