pscad updating pscad software and licensing pscad x4 (v4_5... · 2014-12-22 · updating pscad™...

PSCAD™

Updating PSCAD™ Software and Licensing

Written for PSCAD X4: Version 4.5 November 28, 2014 Revision: 4

Updating PSCAD™ Software and Licensing (v4.5)

©2014 Manitoba HVDC Research Centre a division of Manitoba Hydro International Ltd. Rev.4, Nov. 28, 2014

Contents

1. INTRODUCTION ............................................................................................................................................. 1

1.1 OVERVIEW ...................................................................................................................................................... 1 1.2 RELEASE NUMBERING SYSTEM ............................................................................................................................ 3 1.3 DETERMINING YOUR UPDATE .............................................................................................................................. 4

2. UPDATING THE SOFTWARE AND LICENSE (MUL) ........................................................................................... 5

2.1 UPDATING THE SOFTWARE ON THE SERVER ........................................................................................................... 6 2.2 CONFIGURING THE LICENSE MANAGER ............................................................................................................... 10 2.3 UPDATING THE LICENSE ON THE SERVER ............................................................................................................. 13 2.4 UPDATING SOFTWARE ON THE CLIENT COMPUTERS .............................................................................................. 15 2.5 ACTIVATING A LICENSE TO RUN PSCAD .............................................................................................................. 19

3. UPDATING SOFTWARE (MUL) ..................................................................................................................... 25

3.1 UPDATING THE SOFTWARE ON THE SERVER ......................................................................................................... 26 3.2 CONFIGURING THE LICENSE MANAGER ............................................................................................................... 30 3.3 UPDATING SOFTWARE ON THE CLIENT COMPUTERS .............................................................................................. 31 3.4 ACTIVATING A LICENSE TO RUN PSCAD .............................................................................................................. 35

4. UPDATING THE SOFTWARE AND LICENSE (SUL) .......................................................................................... 36

4.1 UPDATING SOFTWARE ..................................................................................................................................... 37 4.2 UPDATING THE LICENSE ................................................................................................................................... 40 4.3 ACTIVATING A LICENSE TO RUN PSCAD .............................................................................................................. 42

5. UPDATING SOFTWARE (SUL) ....................................................................................................................... 47

5.1 UPDATING SOFTWARE ..................................................................................................................................... 48 5.2 ACTIVATING A LICENSE TO RUN PSCAD .............................................................................................................. 51

6. SWITCHING BETWEEN LEGACY AND ADVANCED LICENSING ....................................................................... 52

6.1 OVERVIEW .................................................................................................................................................... 52 6.2 SWITCHING TO LEGACY LICENSING ..................................................................................................................... 53 6.3 SWITCHING TO ADVANCED LICENSING ................................................................................................................ 56

7. SILENT INSTALLATIONS ............................................................................................................................... 57

7.1 BACKGROUND................................................................................................................................................ 57 7.2 AVAILABILITY ................................................................................................................................................. 57 7.3 UNATTENDED INSTALLATION WHEN INSTALLING FROM WRITEABLE MEDIA ................................................................ 58 7.4 UNATTENDED INSTALLATIONS WHEN USING READ-ONLY MEDIA .............................................................................. 59 7.5 END-USER CUSTOMIZED UNATTENDED INSTALLATIONS ......................................................................................... 60

8. RESOLVING ISSUES ...................................................................................................................................... 61

8.1 ISSUES WITH UPDATING THE SOFTWARE ............................................................................................................. 62 8.2 ISSUES WITH CONFIGURING THE LICENSE MANAGER .............................................................................................. 63 8.3 ISSUES WITH UPDATING A LICENSE USING THE LICENSE UPDATE UTILITY .................................................................... 64 8.4 ISSUES WITH ACTIVATING A LICENSE ................................................................................................................... 65 8.5 DETECTING YOUR PSCAD VERSION AND LICENSE NUMBER .................................................................................... 66 8.6 CONTACTING THE SUPPORT DESK ...................................................................................................................... 68

APPENDIX A LICENSING ACROSS NETWORKS ................................................................................................. 69


©2014 Manitoba HVDC Research Centre a division of Manitoba Hydro International Ltd. Rev.4, Nov. 28, 2014 Page 1

1. Introduction

1.1 Overview

This manual provides instructions for updating the PSCAD™ software and license. If this is a

new installation rather than an update, refer instead to “Installing PSCAD X4”, available at

the following link:

https://hvdc.ca/knowledge-library/reference-material

Instructions for the following products are included:

Update to PSCAD X4 v4.5 software (v4.5.0, v4.5.1, v4.5.2, v4.5.3, v4.5.4), for

both the Professional and Educational licenses.

Update for a Professional license from V4 to X4. The V4 license runs v4.2; the X4

license runs v4.2 and later.

Update to the Standalone License Manager (v1.31, v1.32, v1.33, v1.34, v1.35)

(also known as simply “License Manager")

Note

The License Manager is installed only when running a Multi-User license.

The installation of the GFortran compiler v4.2.1, LiveWire and LiveWire Lite if

required (no update is available)

The installation of Sentinel Drivers 7.150.10 (Sentinel Driver installer v7.5.7 is

used with PSCAD v4.5.0 to v4.5.1 and License Manager v1.31 to v1.32; Sentinel

Driver installer v7.5.8 is used with PSCAD v4.5.2 to v4.5.4 and License Manager

v1.33 to v1.35)




This manual covers Lock-Based Licensing configuration, for both Multi-User and Single-User

licenses for all v4.5 releases. Lock-Based Licensing (also known as Legacy Licensing or

Intranet Licensing) uses a combination of USB lock and license database file to validate

licensing.

Note

If you are using the Free Edition, refer instead to the guide “Managing MyCentre”,

posted at the link listed below. The Free Edition uses an alternative licensing

configuration, Certificate Licensing (also known as Advanced Licensing or Internet

Licensing), and is authorized through a website portal.


Note

If you are using Lockless Trial Licensing for versions up to and including v4.5.3,

refer instead to the guide “How to Install a Trial License”, posted at the above link.

Lockless Trial Licensing is free time-limited fully-featured licensing, and is locked to

a particular computer.

Note

If you are using a Trial License for v4.5.4, refer instead to the guide “How to Install

a Trial License”, posted at the above link. Trial Certificate Licensing is free time-

limited fully-featured licensing, and is authorized through a website portal.

Licensing configuration instructions for the following products are included:

PSCAD

Expanded Licensing

LiveWire Pro

Note

If you are running LiveWire Lite, this limited-feature edition does not require any

licensing configuration.




1.2 Release Numbering System

Software releases are identified by a numbering system, which is used to designate the

release type. There are three types of release, as follows:

A major release contains a significant number of new features and functionalities,

such that it warrants a brand new product. These types of releases have

historically occurred every several years (for example, version 3, version 4, etc.).

A minor release typically provides a handful of new and enhanced features, but

not enough to justify a new product. Minor releases may be released yearly (for

example, version 4.3, version 4.4, version 4.5, etc.).

A maintenance patch is purely a bug fix release. Patches may be released

multiple times per year (for example, version 4.5.1, version 4.5.2, etc.).

The numbering system is illustrated in the following image. The first number on the left

represents the major release. The version 4 product was first released in 2003. The second

number represents the minor release; version 4.5 was released in the spring of 2012. The

third number represents the maintenance patch.

This mnual provides instructions for updating minor releases and maintenance patches.



1.3 Determining your Update

The following table may help to determine which instructions are applicable to your setup.

This is based on your type of license (Professional or Educational, and Multi-User or Single-

User), and which software version you are updating from.

Type of License

Type of Update

Professional License1 Educational License2

Multi-User License (MUL)

Single-User License (SUL)

Multi-User License (MUL)

Single-User License (SUL)

Updating from v4.2.11

Section 2 Section 4 Section 3 Section 5

Updating from v4.3.0 or later

Section 3 Section 5 Section 3 Section 5

1For a professional license, updating from v4.2 requires that the license be updated in addition to the software. When updating from v4.3 or later, only the software requires updating. 2For an educational license, updating from v4.2 or later requires only that the software be updated; the license is not required to be updated.



2. Updating the Software and License (MUL)

This section provides instructions for performing the following updates, and should be

completed in the order presented:

Update and configure the License Manager software on the license host

Update the Professional Multi-User license for PSCAD V4 (v4.2) on the license

host. The license will be renumbered, and in addition to licensing PSCAD V4, it

will also license PSCAD X4 (v4.3 and later).

Update the PSCAD software on the Client machines

Activate a license

Additionally, the GFortran compiler and LiveWire may also be installed during this section.

The instructions for the Professional and Educational licenses are very similar; any

differences are as noted.



2.1 Updating the Software on the Server

This section provides instructions for updating the License Manager (and PSCAD, if

applicable) on the Server. Proceed as follows:

Notes

1. This section is applicable to a Professional Multi-User license for v4.2.

2. If operating on Windows Vista or later, ensure that you have administrator

privileges prior to beginning the installation.

3. On a computer running the 32-bit Windows operating system, only the 32-bit

version of PSCAD will be installed.

4. On a computer running the 64-bit Windows operating system, both the 32-bit

and 64-bit versions of PSCAD will be installed. The 64-bit version may be

launched using the automatically generated link in the Windows Start menu.

5. If you encounter any installation issues, refer to Section 8.1.

a. To initiate an update to your license and software, request the update from our sales

desk at [email protected]. Indicate the update is from v4.2, and include your license

number, which is typically listed on your USB lock.

b. Upon approval, our sales desk will forward the following:

The software installation files

The license update files

c. Save the installation files and license update files to the Server desktop.

Note

The installation must be run from a local drive rather than from a network drive.

d. If applicable, shut down all instances of PSCAD.

mailto:[email protected]



e. Stop the current License Manager service as follows:

On a Server running Windows Vista or later, from the Windows “Start” menu,

right-click “Stop License Manager Service”, then select “Run as administrator”.

On a Server running Windows XP, double left-click on “Stop License Manager

Service” in the Windows Start menu.

f. From the installation files, run “setup.exe” (if running on Windows Vista or later,

select the option to launch the installation as administrator).

g. In Windows Vista and later, the “User Account Control” dialog box may display to

inquire whether you want to allow “setup.exe” to make changes to your computer.

This message is a standard warning to protect your computer when an executable

file is detected. Select “Yes” to begin the installation.



h. The InstallShield Wizard will launch. During the installation, the various installation

screens will prompt you to make selections. When the following screens are

displayed, perform as follows:

From the “Product Listing” screen, select all required programs, then select

“Next”. Normally, only the “License Manager” is selected on a Server. For Servers

also running PSCAD, however, also select “PSCAD” (and “GFortran Compiler” if

you do not have a commercial compiler, “LiveWire Lite (Demo)” to use the free

limited-feature version, or “LiveWire” to use the fully-featured version using

either a trial or permanent license).

WARNING

Ensure that all software to be updated or retained is selected. All previously

installed software that is deselected will be uninstalled.

Select “PSCAD will use a License Manager on this machine”, then select “OK”.

Display for PSCAD v4.5.0 to v4.5.3

Display for PSCAD v4.5.4



i. If selected, PSCAD will be updated next, followed by the License Manager.

j. When the Setup Tool displays, go to Section 2.2 to configure the License Manager,

then return to Step (k) below.

k. When prompted to install a license, select “Yes – install/update product licenses”.

This will display the “License Update Utility”. Proceed to Section 2.3 to update the

license, then return to Step (l) below.

l. If GFortran and/or LiveWire were selected, you will be prompted through these

installations.

m. You will be prompted to finalize the software update on the Server.

n. Log out or restart the Server after all software has been installed. The License

Manager will then be ready to issue licenses.

o. If PSCAD was installed on the Server, go to Section 2.5 to activate a license, then go

to Step (p) below.

p. If applicable, go to Section 2.4 to update the software on the Client computers.



2.2 Configuring the License Manager

The License Manager “Setup Tool” utility is used to configure networking between the

License Manager and Client computers for sharing licenses. Configure the License Manager

as follows:

Notes

1. If you encounter any issues, refer to Section 8.2.

2. When configuring the Setup Tool, view the contents in the “Help” menu of the

tool for further references.

a. Display the License Manager Setup Tool using one of the following manners:

If this is a continuation from Section 2.1, the Setup Tool will automatically

display.

If the License Manager software was previously installed, the Setup Tool may be

displayed from the Windows “Start” menu (All Programs | PSCAD | License

Manager | Setup Tool), or

Download the utility from the following link, extract the files to a folder on your

local drive, and run the “SetupTool.exe” file.

http://updater.pscad.com/utilities/SetupTool.zip

b. For Expanded Licensing Only: If your license includes Expanded Licensing,

configure the “Networks” tab. If you require assistance, please contact our support

desk (Section 8.6).

Notes

1. The license for Expanded Licensing is included as part of your “License.txt" file.

This file will be updated in Section 2.3.

2. See Appendix A for more information on Expanded Licensing.

http://updater.pscad.com/utilities/SetupTool.zip



c. In the “Adapters & IPs” tab, select the network on which the Server and Client

computers will communicate. There are two methods for configuring the networking:

Note

This step is applicable for all Multi-User licenses, regardless whether you have

Expanded Licensing or not. If you do not have Expanded Licensing, this tab

permanently sets the network communication between the Server and Client

computers. If you do have Expanded Licensing, this tab sets the default network

communication between the Server and Client computers if the Expanded Licensing

expires.

The preferred method to set the network is to lock communication to a specific

network, which lists the specific IP address. Proceed as shown.

Notes

1. The IP address 127.0.0.1 is typically never selected since this is the IP address

of the current computer, and networking to other computers would not be

possible if selected.

2. Alternatively, select IP address 127.0.0.1 if the following two conditions are

both met:

Note

This method will permit you to run two or more instances of PSCAD on your

computer at one time.

o Your PSCAD license has multiple PSCAD seats, and

o You will not share these seats with other computers over the network.



The second method of configuring the networking is to lock to an adapter type,

such as wired or wireless, as shown. The License Manager will lock to the first

detected adapter of the type selected. This is not the preferred method of setting

the networking, as the IP address can vary depending on which adapter type is

detected first. Proceed as shown.

d. If required, the networking permission that was set in the “Adapters & IPs” tab may

be relaxed or restricted by configuring the “Override” tab. Use the up and down

arrows to restrict or loosen permission in the “Class” field. For more detailed

information on networking permissions, see Appendix A.

e. Save settings and close the utility by selecting “Save Settings and Exit” in the

“Actions” menu.



2.3 Updating the License on the Server

This section provides instructions for updating a Professional license from V4 (v4.2) to X4

(v4.3 and later). The “License Update Utility” will be used to update the license. Proceed as

follows:

Note

1. Before proceeding, ensure you have administrator privileges on the computer.

2. This procedure requires the update package as supplied by our Sales Desk

(contains the update utility and associated license files).

3. This procedure is not intended for installing or replacing a license. For that

procedure, refer instead to the “Installing PSCAD” manual, available from the

following page:



a. Ensure that the Upgrade.txt file and License.txt file are saved to your desktop.

b. Ensure that the USB lock is plugged in.

c. If applicable, shut down all instances of PSCAD.

d. If applicable, stop the License Manager service as follows:

If operating on Windows XP: From the Windows Start menu, browse to and select

“Stop License Manager Service”.

If operating on Windows Vista, Windows 7, or Window 8: From the Windows Start

menu, browse to and right-click on “Stop License Manager Service”, then select

“Run as administrator”.

e. If the “License Update Utility” is not already displayed (i.e. per continuation from

previous section), it may be displayed in one of the following three manners:

Run the utility from the zipped update folder provided by the Sales Desk, or

If available, browse to and run the “Enter License Key” from the Windows Start

menu, or

Download the utility from the following link, extract the files to a local folder, and

run the “LicenseUpdate.exe” file:

http://updater.pscad.com/utilities/LicenseUpdate.zip





f. From the “Actions” menu, select “Upgrade license keys and lock”.

g. When prompted to install the “Upgrade.txt” file, this is one of the files saved to your

desktop as per Step (a). Browse to this file, then select “Open”.

h. When prompted to install the “License.txt” file, this is one of the files saved to your

desktop as per Step (a). Browse to this file, then select “Open”.

i. The license database and the USB lock will be updated to a new license number, with

the ability to license both PSCAD V4 and PSCAD X4.

Note

Once the update has been completed, the “License Update Utility” will display

information about the installed license. Take note of your new PSCAD license

number. Also, it is recommended to attach a tag that lists the new number to the

USB lock to easily identify your license number when contacting the sales or

support desk.

j. Close the “License Update Utility”.

Note

Following this procedure, the USB lock along with the License.txt file that was

provided in the update package make up your new PSCAD license. Together, these

may be installed on any computer to host the PSCAD license.



2.4 Updating Software on the Client Computers

This section provides instructions for updating software on the Client computers using the

InstallShield Wizard.

Notes

1. If PSCAD and GFortran are to be installed on numerous computers, you may

prefer instead to perform the installations using the “silent” (unattended)

method as per Section 7.

2. If operating on Windows Vista or Windows 7, ensure that you have local

administrator privileges prior to beginning the installation.







a. To initiate a software update, inform our sales desk at [email protected]. Indicate

the update is from v4.2, and include your license number, which is typically listed on

your USB lock.

b. Upon approval, our sales desk will forward the following:


The license update files (the license is updated on the Server as per Section 2.3).

c. Save the installation files to your computer desktop.

Note



e. From the installation files, run “setup.exe” (if running on Windows Vista or later,


f. In Windows Vista and later, the “User Account Control” dialog box may display to







g. The InstallShield Wizard will launch. During the installation, the various installation


displayed, perform the following:


“Next”. Normally, “PSCAD” is selected (and “GFortran Compiler” if you do not

have a commercial compiler, and “LiveWire Lite (Demo)” to use the free limited-

feature version, or “LiveWire” to use the fully-featured version with either a trial

or permanent license).

WARNING

Do not select “License Manager”. This may cause licensing issues.

WARNING





In the following dialog box, proceed as follows:



If you know the server name or IP address, select “PSCAD will use a License

Manager on another computer on your network”. For v4.5.0 to v4.5.3, also enter

this name or address.

If you do not know the Server name or IP address, select “PSCAD will use self-

licensing”. You will be prompted for this information during the licensing.

At v4.5.4, if prompted, enter the Server name or IP address in the field provided,

then select “Next”.



At v4.54, if incorrect information is entered in the above dialog box, an error

message will display. Proceed as follows:

o To try entering the License Manager host information again, select “No” to

return to the previous dialog.

o To continue the installation without the License Manager host information,

select “Yes”, and proceed to the next step.

h. The PSCAD software will be updated, and the GFortran compiler and LiveWire will be

installed next if selected.

i. Proceed to Section 2.5 to activate a license on the Client computer.



2.5 Activating a License to Run PSCAD

Activate a license to run PSCAD on the Client or Server computer as follows:

Note

If you encounter any licensing issues, refer to Section 8.4.

a. On the Server, ensure the USB lock is plugged in.

b. For a Professional License: Using the following table, launch PSCAD according to

your Windows operating system and PSCAD version:

PSCAD

Version

Operating System1

Windows 32-bit Windows 64-bit

v4.5.0

Browse as shown in the

Windows “Start” menu:



v4.5.1

and later

Browse as shown in the Windows “Start” menu:

Note

The version corresponding to the computer’s operating

system (32-bit or 64-bit) will be displayed. 1The selections in this table assume operation on Windows Vista or later. If

operating on Windows XP, select the “(non-elevated)” option instead.



c. For an Educational License: Using the following table, launch PSCAD according to


PSCAD

Version

Operating System1


v4.5.0


Notes

1. The 64-bit version of v4.5.0 is not available for an

Educational license.

2. The 64-bit version of v4.5.1 and later is available for an

Educational license (see below).

v4.5.1

and later


Note

The “PSCAD v45” link will correspond to your operating

system (i.e. 32-bit or 64-bit).

1The selections in this table assume operation on Windows Vista or later. If




d. If you agree with the software license agreement, select “I agree”.

e. The following message will display to indicate that a license is not available. Select

“OK”.

f. Display the “System Settings” dialog box if not automatically displayed (from the

PSCAD Start button, browse to “System Settings”).



g. For v4.5.4 only: In the System Settings dialog, ensure the licensing configuration is

set correctly, to Legacy Licensing. The upper left tab will help to determine this, as

shown:

Correct Configuration: If the tab is listed as “License” (left view in above

snapshot), then the correct configuration is set (“Legacy Licensing”). Continue to

Step (h) below.

Incorrect Configuration: If the tab is listed as “Certificate Licensing” (right view in

above snapshot), then the wrong configuration is set (“Advanced Licensing”).

Licensing must therefore be changed to the “Legacy Licensing” configuration as

per Section 6.2. Following this change, resume licensing from Step (h) below.



h. Activate the license on the Server or Client computer as follows:

On the Server: Configure the license on the Server as shown:

On the Client computer: Configure the licensing on the Client as shown:



Note

The “Trial License” fields were removed from the dialog box at v4.5.4. The above

two screenshots show the configuration at v4.5.4, the screenshot below shows the

configuration for v4.5.0 to v4.5.3.

i. If the license has successfully been activated, a message similar to the one shown

will display. Select “OK”. PSCAD will be licensed to run.



3. Updating Software (MUL)

This section provides instructions for performing the following updates, and should be


Update and configure the License Manager software on the license host

Update the PSCAD software on the Client machines

Activate a license






3.1 Updating the Software on the Server

This section provides instructions for updating the License Manager (and PSCAD, if

applicable) on the Server. Proceed as follows:

Notes

1. This section is applicable to a Professional Multi-User license for v4.3 and later,

and to an Educational Multi-User license for v4.2 and later.










desk at [email protected]. Include your license number, which is typically listed on

your USB lock.

b. Upon approval, our sales desk will forward the software installation files.

c. Save the installation files to the Server desktop.

Note






e. Stop the current License Manager service as follows:

On a Server running Windows Vista or later, from the Windows “Start” menu,

right-click “Stop License Manager Service”, then select “Run as administrator”.

On a Server running Windows XP, double left-click on “Stop License Manager

Service” in the Windows Start menu.

f. From the installation files, run “setup.exe” (if running on Windows Vista or later,


g. In Windows Vista and later, the “User Account Control” dialog box may display to






h. The InstallShield Wizard will launch. During the installation, the various installation




“Next”. Normally, only the “License Manager” is selected on a Server. For Servers

also running PSCAD, however, also select “PSCAD” (and “GFortran Compiler” if

you do not have a commercial compiler, “LiveWire Lite (Demo)” to use the free

limited-feature version, or “LiveWire” to use the fully-featured version using


WARNING



Select “PSCAD will use a License Manager on this machine”, then select “OK”.





i. If selected for installation, PSCAD will be updated, followed by the License Manager.

j. When the Setup Tool displays, go to Section 3.2 to configure the License Manager,

then return to Step (k) below.

k. When prompted to install a license, select “No – don’t install/update any licenses”.

l. If GFortran and/or LiveWire were selected, you will be prompted through these

installations.

m. You will be prompted to finalize the software update on the Server.

n. Log out or restart the Server after all software has been installed. The License

Manager will then be ready to issue licenses.

o. If PSCAD was installed on the Server, go to Section 3.4 to activate a license, then go

to Step (p) below.

p. If applicable, go to Section 3.3 to update the software on the Client computers.



3.2 Configuring the License Manager

Configure the License Manager as per Section 2.2, with the following notes:

Disregard the note at Step (b) related to updating a license. A license will not be

updated for this configuration.



3.3 Updating Software on the Client Computers

This section provides instructions for updating software on the Client computers using the

InstallShield Wizard.

Notes

1. If PSCAD and GFortran are to be installed on numerous computers, you may

prefer instead to perform the installations using the “silent” (unattended)

method as per Section 7.

2. If operating on Windows Vista or Windows 7, ensure that you have local








a. To initiate a software update, inform our sales desk at [email protected]. Include

your license number, which is typically listed on your USB lock.

b. Upon approval, our sales desk will forward the software installation files.


Note














displayed, perform the following:






WARNING


WARNING





In the following dialog box, proceed as follows:



If you know the server name or IP address, select “PSCAD will use a License

Manager on another computer on your network”. For v4.5.0 to v4.5.3, also enter

this name or address.

If you do not know the Server name or IP address, select “PSCAD will use self-

licensing”. You will be prompted for this information during the licensing.

At v4.5.4, if prompted, enter the Server name or IP address in the field provided,

then select “Next”.



At v4.54, if incorrect information is entered in the above dialog box, an error

message will display. Proceed as follows:

o To try entering the License Manager host information again, select “No” to

return to the previous dialog.

o To continue the installation without the License Manager host information,

select “Yes”, and proceed to the next step.



i. Proceed to Section 3.4 to activate a license on the Client computer.




Once PSCAD has been updated on the Server or Client computer as per Section 3.1 or 3.3,

activate a license to run the software as per Section 2.5.



4. Updating the Software and License (SUL)

This section provides instructions for performing the following procedures, and should be


Update the PSCAD software

Update the Professional Multi-User license for PSCAD V4 (v4.2). The license will

be renumbered, and in addition to licensing PSCAD V4, it will also license

PSCAD X4 (v4.3 and later).

Activate a license






4.1 Updating Software

This section provides instructions for updating software, as follows:

Notes

1. This section is applicable to a Professional Single-User license for v4.2.










desk at [email protected]. Indicate the update is from v4.2, and include your license

number, which is typically listed on your USB lock.

b. Upon approval, our sales desk will provide the following:


The license update files

c. Save the installation files and license update files to your computer desktop.

Note















From the Product Listing” screen, select all required programs, then select



feature version, or “LiveWire” to use the fully-featured licensed version with


WARNING


WARNING





Select “PSCAD will use self-licensing”, then select “OK”.





i. Proceed to Section 4.2 to update the license.



4.2 Updating the License

This section provides instructions for updating a Professional license from V4 (v4.2) to X4

(v4.3 and later). Proceed as follows:

Notes

1. Before proceeding, ensure you have administrator privileges on the computer.

2. This procedure requires the update package as supplied by our Sales Desk

(contains the update utility and associated license files).

3. If you encounter any issues, contact our support desk (Section 8.3).

a. Ensure that the Upgrade.txt file and License.txt file from the update package are

saved to your desktop.

b. Ensure that the USB lock is plugged in.

c. If applicable, shut down all instances of PSCAD.

d. If the “License Update Utility” is not already displayed (i.e. per continuation from the

previous section), it may be displayed in one of the following three manners:

Run the utility from the update package provided by the Sales Desk, or

If available, browse to and run the “Enter License Key” from the Windows Start

menu, or

Download the utility from the following link, extract the files to a local folder, and

run the “LicenseUpdate.exe” file:


e. From the “Actions” menu, select “Upgrade license keys and lock”.

f. When prompted to install the “Upgrade.txt” file, browse to this file, then select

“Open”.

g. When prompted to install the “License.txt” file, browse to this file, then select

“Open”.




h. The license database and the USB lock will be updated to a new license number, with

the ability to license both PSCAD V4 and PSCAD X4.

Note

Once the update has been completed, the “License Update Utility” will display

information about the installed license. Take note of your new PSCAD license

number. Also, it is recommended to attach a tag that lists the new number to the

USB lock to easily identify your license number when contacting the sales or

support desk.

i. Close the “License Update Utility”.

Note

Following this procedure, the USB lock along with the License.txt file that was

provided in the update package make up your new PSCAD license. Together, these

may be installed on any computer to host the PSCAD license.

j. Go to Section 4.3 to activate the license.




Activate a license to run PSCAD as follows:

Note

If you encounter any issues, refer to Section 8.4.

a. Ensure the USB lock is plugged in and the license was updated as per Section 4.2.

b. For a Professional License: Using the following table, launch PSCAD according to


PSCAD

Version

Operating System1


v4.5.0

Browse as shown in the Windows

“Start” menu:


“Start” menu:

v4.5.1

and later


Note

The version corresponding to the computer’s operating system

(32-bit or 64-bit) will be displayed.





c. For an Educational License: Using the following table, launch PSCAD according to


PSCAD

Version

Operating System1


v4.5.0


Notes

1. The 64-bit version of v4.5.0 is not available for an Educational

license.



v4.5.1

and later


Note

The “PSCAD v45” link will correspond to your operating system

(i.e. 32-bit or 64-bit).





d. If you agree with the software license agreement, select “I agree”.

e. The following message will display to indicate that a license is not available. Select

“OK”.

f. Display the “System Settings” dialog box if not automatically displayed (from the

PSCAD Start button, browse to “System Settings”).



g. For v4.5.3 or v4.5.4 only: In the System Settings dialog, ensure the licensing

configuration is set correctly, to Legacy Licensing. The upper left tab will help to

determine this, as shown:

Correct Configuration: If the tab is listed as “License” (left view in above

snapshot), then the correct configuration is set (“Legacy Licensing”). Continue to

Step (h) below.

Incorrect Configuration: If the tab is listed as “Certificate Licensing” (right view in

above snapshot), then the wrong configuration is set (“Advanced Licensing”).

Licensing must therefore be changed to the “Legacy Licensing” configuration as

per Section 6.2. Following this change, resume licensing from Step (h) below.

h. Configure the license as shown.



Note

The “Trial License” fields were removed from the dialog box at v4.5.4. The above

screenshot shows the configuration at v4.5.4, the screenshot below shows the

configuration for v4.5.0 to v4.5.3.

i. If the license has successfully been activated, a message similar to the one shown

will display. Select “OK”.

j. PSCAD will be licensed to run.



5. Updating Software (SUL)

This section provides instructions for performing the following procedures, and should be


Update the PSCAD software

Activate a license






5.1 Updating Software

This section provides instructions for updating software, as follows:

Notes

1. This section is applicable to a Professional Single-User license for v4.3 and later,

and to an Educational Single-User license for v4.2 and later.

2. If operating on Windows Vista or Windows 7, ensure that you have









desk at [email protected]. Include your license number, which is typically listed on

your USB lock.

b. Upon approval, our sales desk will provide the software installation files.


Note




















WARNING


WARNING





Select “PSCAD will use self-licensing”, then select “OK”.





i. Proceed to Section 5.2 to activate the license.




Once the PSCAD software has been updated as per Section 5.1, activate the license as per

Section 4.3.



6. Switching Between Legacy and Advanced Licensing

6.1 Overview

This section provides instructions for setting the configuration from “Advanced Licensing” to

“Lock-Based Licensing”, if required, and is only applicable for v4.5.3 or v4.5.4.

Lock-Based Licensing (also known as Legacy Licensing, and Intranet Licensing) refers to

using a combination of USB lock (dongle) and license database file to authorize licensing.

Lock-based licensing is used in this manual, and instructions for setting this licensing are in

Section 6.2.

Advanced licensing (also known as Certificate Licensing or Internet Licensing), refers to

using login credentials in a web tool to authorize licensing. When the web tool, MyCentre,

authorizes the licensing, a License Certificate is issued to the computer running PSCAD.

Advanced licensing is not used in this manual, but instructions for configuring this licensing

are included in this manual for your information only (Section 6.3). The following products

use advanced licensing:

The v4.5.4 Trial License: Refer to the manual “How to obtain a Trial License”,

available on the following webpage:


The Free Edition: Refer to the guide “Managing MyCentre”, available on the above

webpage.




6.2 Switching to Legacy Licensing

Configure PSCAD to use Legacy Licensing as follows:

a. For a Professional License: Using the following table, launch PSCAD according to


PSCAD

Version

Operating System1


v4.5.0


“Start” menu:



v4.5.1

and later


Note

The version corresponding to the computer’s operating system

(32-bit or 64-bit) will be displayed.





b. For an Educational License: Using the following table, launch PSCAD according to


PSCAD

Version

Operating System1


v4.5.0


Notes

1. The 64-bit version of v4.5.0 is not available for an Educational

license.



v4.5.1

and later


Note

The “PSCAD v45” link will correspond to your operating system

(i.e. 32-bit or 64-bit).





c. Close out of all dialog boxes, then display the “Application Options” dialog box (from

the PSCAD Start button, select “Options”).

d. From the drop-down menu, select the “Advanced Licensing” page.

e. From the “Licensing Service” drop-down menu, select “Legacy licensing (intranet)”,

then select “Ok”.

f. The licensing will now be configured to Legacy Licensing.



6.3 Switching to Advanced Licensing

Configure PSCAD to use Advanced Licensing as follows:

a. Perform Steps (a) to (d) of Section 6.2.

b. From the “Licensing Service” drop-down menu, select “Advanced licensing (internet)

*new*”, then select “Ok”.

c. The licensing will now be configured to Advanced Licensing. Proceed to the manual

“Managing MyCentre” for more information on this type of licensing, posted on the

following webpage:





7. Silent Installations

7.1 Background

In an unattended, or silent, update (installation), an installation is run in “record” mode, in

which all responses are logged by the installer to a response file. When the same installation

is run on another computer in silent mode, with the response file present, the installation

will run in total silence, with NO dialogs being displayed. This then allows an organization to

use automation tools to deploy (install) a product on multiple computers without any

manual user intervention.

This section provides instructions for performing silent installations in three different

manners:

When the installation files are being run from a writeable media (Section 7.3)

When the installation files are being run from a read-only media (Section 7.4)

Customized (Section 7.5)

7.2 Availability

As of the release of PSCAD 4.5.4, unattended or silent installations are supported for the

following products:

PSCAD 4.5.4

GFortran 4.2.1



7.3 Unattended Installation when Installing from Writeable Media

This method may be used when installing from shared folders or writeable USB devices.

WARNING

Before proceeding, be aware that the initial computer (on which the responses are being

recorded) must have the same PSCAD and GFortran configuration as the other

computers (on which the recorded responses will be run). For example, the first

computer should have the same version of PSCAD as the other computers. Otherwise,

during the silent installation, a new dialog may display, prompting you to make a

selection.

Generate the response file on the first computer as follows:

a. Ensure that the product is not already installed; otherwise the generated response

file will be incorrect.

b. Browse to the product’s installation folder on the media.

c. Run the “RecordSilentInstall.bat” command batch file.

d. The installer will launch, and you may then configure the software installation

appropriately.

e. All of your responses will be recorded to a response file called setup.iss located in the

same folder.

f. Copy the entire installer folder, which now also contains the response file, to an

accessible shared folder, or to a USB stick.

For all other computers, perform the following:

a. Open a File browser and browse the installation folder on the shared folder or USB

stick.

b. Run the “RunSilentInstall.bat” file.

c. The installation will proceed, and the batch file will exit when done.



7.4 Unattended Installations when using Read-only Media

This method may be used when installing from a CD-ROM or a write-protected USB device.

WARNING






selection.

Note

If possible, copy the installer files and folders to a shared folder or a writeable USB

device, then follow the instructions in Section 7.3 (preferred method).




b. Insert the media, and browse to the product’s installation folder on the media.

c. Run the “RecordSilentInstallToTempFolder.bat” command batch file.

d. The installer will launch, and you may then configure the software installation

appropriately.

e. All of your responses will be recorded to a response file called

“<product>_Install.iss”.

f. When the installation is complete, it will tell you where the response file is located.

g. Copy the response file to an accessible shared folder, or to a USB stick.

For all other computers:

a. Insert the media.

b. Open a command prompt and browse to the product’s folder on the media.

c. Type in the following, and press “Enter”:

RunSilentInstallUsingSpecifiedResponse.bat <absolute path to response file>.

d. The installation will proceed, and the batch file will exit when done.



7.5 End-User Customized Unattended Installations

This method may be used when customizing a silent installation.

WARNING






selection.




b. Open a command prompt and browse to the product’s installation folder on the

media.

c. Type in the following, and press Enter:

Setup.exe /r /f1Absolute_Path_And_Name_Of_Response_File

d. For example:

Setup.exe /r /f1"D:\Installer\setup.iss"

To perform a silent installation on another computer,



b. Open a command prompt and browse to the product’s installation folder on the

media

c. Type in the following, and press enter:

Setup.exe /s /f1Absolute_Path_And_Name_Of_Response_File

d. For example:

Setup.exe /s /f1"D:\Installer\setup.iss"



8. Resolving Issues

Refer to the following sections if you encounter any issues:

See Section 8.1 for issues when updating the software

See Section 8.2 for issues when configuring the License Manager

See Section 8.3 for issues when updating a license

See Section 8.4 for issues when activating a license

See Section 8.5 for instructions on detecting your PSCAD version and license

number

See Section 8.6 to contact our support desk



8.1 Issues with Updating the Software

If you encounter any software installation issues, you may troubleshoot them using the

“Resolving Installation Errors” manual, available on the following page:

If you are still unable to resolve the problem, please contact our support desk (Section 8.6).

Ensure to include as much information as possible to describe when the problem occurred

and snapshots of any error messages, as well as a “Get Info” log file, which is generated as

described in Step 8.4(a).




8.2 Issues with Configuring the License Manager

If you encounter any issues when using the Setup Tool to configure the License Manager,

proceed as follows:

a. Select “Save Messages As” in the “Actions” menu.

b. When prompted, specify a folder in which to save the messages. The message log

file will be named “Setup Tool”, followed by the date and time.

c. Forward the saved log file to our support desk as per Section 8.6.



8.3 Issues with Updating a License using the License Update Utility

If you encounter any issues with updating a license using the License Update Utility,

proceed as follows:

a. Select “Save Messages” in the “Actions” menu.

b. When prompted, enter a file name and browse to a folder in which to save the

messages. The messages will be saved as a log file.

c. Forward the log file to our support desk (Section 8.6).



8.4 Issues with Activating a License

If you encounter any issues with activating a license, please forward the following log files

as applicable to our support desk (Section 8.6) to determine the reason:

a. GetInfo.txt file: This file is available on computers running the License Manager or

PSCAD, as follows:

Download the Get Info utility from the following link and save to your computer:

http://updater.pscad.com/utilities/GetInfo32.zip

Select the “GetInfo32.exe” file to run the utility.

The generated file will be saved to your computer and opened on your desktop;

the file location will be listed within the file, towards the bottom.

b. PscadLmgr.txt file: This file is available on computers running the PSCAD

application. The location of this file is related to your Windows operating system, as

follows:

o On Windows XP:

C:\Documents and Settings\All Users\Application Data\Manitoba HVDC Research Centre\LicenseManager\PscadLmgr.txt

o On Windows Vista, Win7, Win8 (send all as available):

C:\Users\All Users\Manitoba HVDC Research Centre\LicenseManager\PscadLmgr.txt

C:\Users\<Your User ID>\AppData\Local\Manitoba HVDC Research Centre\LicenseManager\PscadLmgr.txt

C:\ProgramData\Manitoba HVDC Research Centre\LicenseManager\PscadLmgr.txt

c. Lmgrd-log.txt file: This file is available on computers running the Standalone

License Manager. The location of this file is related to your Windows operating

system, as shown:

o On Windows XP:

C:\Documents and Settings\All Users\Application Data\Manitoba HVDC Research Centre\LicenseManager\Lmgrd-log.txt

o On Windows Vista, Win7, Win8 (send all as available):

C:\Users\All Users\Manitoba HVDC Research Centre\LicenseManager\Lmgrd-log.txt

C:\Users\<Your User ID>\AppData\Local\Manitoba HVDC Research Centre\LicenseManager\Lmgrd-log.txt

C:\ProgramData\Manitoba HVDC Research Centre\LicenseManager\Lmgrd-log.txt




8.5 Detecting your PSCAD Version and License Number

When requesting technical support from our Support Desk, your PSCAD version and license

number are required. These may be detected in a few different manners.

8.5.1 Using the PSCAD Application

The application may be used to detect the PSCAD version, and the license number if

activated, as follows:

Launch PSCAD and close out of any automatically displayed dialog boxes.

Display the “About PSCAD” dialog box:

The PSCAD version and license number will be displayed:

Note

If the license number is not displayed, then it may instead be determined as

per Section 8.5.2.



8.5.2 Using the Get Info Utility

The Get Info utility may be used to detect your PSCAD version and license number, if the

software and licensing are installed, as follows:

a. Ensure the PSCAD USB lock is securely plugged in.

b. Download our latest “GetInfo32.zip” utility from the following link:

c. Save the file to a local directory (e.g. desktop).

d. Run “GetInfo32.exe” from the download files. When prompted whether to test

shortcuts, select “No”.

e. The Get Info utility will gather information about your system.

f. Once the utility has finished running, scroll to “PSCAD info: Installed:”. All installed

versions will be displayed.

g. Scroll to “Lock Info (direct access)”. If detected, the licensing information related to

the license database file and USB lock will be displayed, as shown in the following

snapshot.




8.6 Contacting the Support Desk

If you are unable to resolve any installation or licensing issues, you may submit a support

request to our support desk. This is performed as follows:

Refer to Section 8.6.1 for a description of the information that should be included

in a support request.

Refer to Section 8.6.2 for instructions for submitting a support request.

8.6.1 Relevant Information for a Support Request

Ensure to include all relevant information in your support request to expedite assistance,

including:

Your PSCAD version and license number (determined as per Section 8.5)

A detailed description of the issue

Any log files as specified in Sections 8.2 to 8.4

Snapshots of any error messages (if applicable)

8.6.2 How to Submit a Support Request

Contact the support desk in one of the following three manners, ensuring to include the

relevant information outlined in Section 8.6.1:

Send an e-mail to [email protected].

Submit the support request through the PSCAD application as described in the

manual, “Requesting Support”, available on the following webpage:


Submit the support request through MyCentre, as described in the manual,

“Managing MyCentre”, available on the following webpage:


Note

Registration in MyCentre is required for this step; registration instructions are

also available in the above manual.






Appendix A Licensing Across Networks

This appendix provides information about licensing software across networks, and is used to

determine the appropriate configuration for your networking system.

For Multi-User licenses (MULs), the License Manager resides on a Server and issues licenses

remotely to Client computers across the networking system. There are two kinds of remote-

licensing, briefly described as follows:

Legacy Licensing: Legacy Licensing is the traditional configuration, in which the

Client computers are on the same network as the Server.

Expanded Licensing: Expanded Licensing occurs more infrequently, when the

Client computers are not on the same network as the Server.

Legacy Licensing is the recommended method for licensing across networks as it is simple

to configure within the License Manager. Conversely, the Expanded Licensing is only

recommended if absolutely essential due to the following limitations:

It requires prior approval

It is limited to two networks

Updated maintenance is required on a Professional license

It expires, and must be re-applied for

Legacy Licensing

This section provides the background on network classes, and how the License Manager

applies them for issuing licenses. This information may be used to determine whether your

networking system supports Legacy Licensing. If it does not support Legacy Licensing,

proceed to the section on Expanded Licensing to support your networking requirements.

The Standalone License Manager adheres to networks as defined according to RFC-960.

Classes and class levels of networks are shown in Table 1.

Network Class

Start Address End Address Class Level

A 1.0.0.0 126. 0. 0.0 ↑ Higher class

B 128.0.0.0 191.255. 0.0

C 192.0.0.0 223.255.255.0

D 224.0.0.0 239.255.255.0 ↓ Lower class



Four network classes, from A to D, are listed in Table 1. Each network class possesses a

range of network addresses, as listed in the “Start Address” and “End Address” columns.

Each network address consists of four sets of digits separated by periods.

The four network classes are ranked according to their networking restrictions, as shown in

the “Class Level” column. The higher the class level, the lower the networking restrictions.

Networking restrictions are more fully explained using Table 2. This is the same table as

Table 1, with the addition of the “IP Mask” column.

Network Class

Start Address

End Address

Class Level

IP Mask

A 1.0.0.0 126. 0. 0.0 ↑ Higher class 255. *. *. *

B 128.0.0.0 191.255. 0.0 255.255. *. *

C 192.0.0.0 223.255.255.0 255.255.255. *

D 224.0.0.0 239.255.255.0 ↓ Lower class 255.255.255.255



For each network class, the “IP Mask” column specifies the IP address configuration that is

required for a computer to reside on a particular network. The digits “255” represent those

digits in the Client computer’s IP address that must be exactly the same as the

corresponding digits on the Server’s IP address in order for the Client computer to reside on

the same network as the Server. The “*” is a wild card, and represents the digits in the

Client computer’s IP address that do not have to match the corresponding digits on the

Server’s IP address in order for the Client computer to reside on the same network as the

Server.

Table 2 demonstrates the limitations of a Class D network. A Class D network requires all

four sets of digits to be the same for the Server and Client computer. Therefore, a Class D

network may only network to itself, and thus may only issue a license to itself. This network

is typically not used, except in a very uncommon situation, in which a Multi-User license

with two or more seats is installed, with the result that multiple instances of PSCAD may be

run on a single computer.

The License Manager may be configured to alter the IP Mask restrictions in Table 2. In this

manner, certain network classes may be artificially elevated to a higher class, and certain

network classes may be artificially lowered to a lower class.

Elevating a class is useful for lowering the restriction, thereby permitting more computers to

network to that Server. Lowering a class is useful for increasing restriction, thereby

restricting the access of Client computers.

Table 3 lists all of the available re-configurations for classes A to C. Table 3 assumes a

License Manager version 1.30 or later and NET Framework 4.0 (or better). The latest

version of License Manager may be obtained by contacting the support desk (Section 8.6).

Original Configuration Re-Configuration After Re-Configuration

Network Class

Example of IP Address

IP Mask IP Address Network Class

A 12.11.21.31 12. *. *.*

No Change→

Increase Restriction→


12. *. *.*

12.11. *.*

12.11.21.*

A

B

C

B 132.11.21.31 132.11. *.*

Lower Restriction→

No Change→


132. *. *.*

132.11. *.*

132.11.21.*

A

B

C

C 192.11.21.31 192.11.21.*

Lower Restriction→

No Change→

192.11. *.*

192.11.21.*

B

C



The following may be observed from this table:

In all classes, the first set of digits must always match.

Class A may remain Class A, or be lowered to Class B or Class C.

Class B may remain Class B, or be either raised to Class A or lowered to

Class C.

Class C may remain Class C, or be raised to Class B.

If you have determined that the Server and Client computers are on different networks after

reviewing your configuration against Table 3, then the License Manager will refuse to issue a

license if it is configured for Legacy Licensing. In this case, Expanded Licensing may be

required.

Expanded Licensing

Expanded Licensing must be obtained if the PSCAD Client computer is on a different

network than the Server. This is determined by reviewing the section on Legacy Licensing.

Expanded Licensing permits the License Manager to be configured to issue licenses to Client

computers that reside on different networks than the Server. To request approval for this

license, please forward the following information to our support desk in accordance with

Section 8.6:

Your license number.

Your networking configuration (the networks on which the Server and Client

computers reside).

If approved, we will provide a license containing the time-limited Expanded Licensing along

with installation and configuration instructions.