Installation Manual 15.2 en
Installation Manual 15.2 en
Installation Manual 15.2 en
DIG
PowerFactory
I N T E G R AT E D P O W E R S Y S T E M A N A LY S I S S O F T W A R E
DIgSILENT
PowerFactory 15.2
Installation Manual
DIgSILENT GmbH
Heinrich-Hertz-Strae 9
72810 Gomaringen / Germany
Tel.: +49 (0) 7072-9168-0
Fax: +49 (0) 7072-9168-88
[email protected]
2014-10-17
CONTENTS
Contents
1 Introduction 1
1.2 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
2 Basic Installation 5
2.1 Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3 Advanced Installation 35
3.1.2 Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
5 Reference 85
5.4.2 Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Chapter 1
Introduction
Values given as example or ones the user can chose according to his needs are written in italic.
File names, directories, listings and values the user is asked to enter are written in fixed width
font.
Button and window captions or menu entries the user is asked to click or select are written in bold
fixed width font.
Menus and sub menu structures are denoted by an arrow in front of the first element and all
following sub entries e.g. Menu Sub Menu Sub Sub Menu.
Internet addresses are written in http://underlined.fixed.width/font.
1.2 Overview
Depending on the installation type, a PowerFactory system can have several components which have
to be installed and configured separately.
chapter 2 on page 5 covers the basic installation options Demo Version, Workstation Version, and
Server Version
More advanced installation options e.g. multi-user database, installation on an application server,
and the Offline mode installation covers chapter 3 on page 35.
DIgSILENT PowerFactory is a standard Windows desktop application. Both a 32-bit and a 64-bit ver-
sion are available. For PowerFactory 15.2 run efficiently should, as a minimum, be equipped with:
Operating system: Windows Vista, Windows 7, Windows 8. Windows Server 2008, 2008 R2,
2012.
Processor: x86- or x64-bit with 1 GHz or faster
Memory: 2 GB RAM minimum
Hard disk with 1 GB of available disk space
SVGA graphic card with a resolution of at least 1280x1024 pixels
Requirements for DIgSILENT License Server are described in section 2.4.1.1 on page 18.
Some parts of the PowerFactory documentation are available only in PDF format. In order to read
these documents a separate viewer application (e.g. Adobe Acrobat Reader) is required.
Additional Software, Documents, and Examples for PowerFactory can be downloaded from the Down-
load Area on the DIgSILENT website
http://www.digsilent.de/index.php/downloads.html
In order to get access to the Download Area youve to provide the customer credentials. They can be
found in the license agreement document.
This section gives a short overview over the installation-relevant changes in recent PowerFactory ver-
sions.
Oracle Client version 11.2 is no more supported. Use version 12.1 instead (see section sec-
tion 3.1.2.1 on page 37).
New database migration modes Full vs. Minimal (see section section 4.4 on page 78)
The PowerFactory installation is now implemented according to official Microsoft Windows guidelines
which brings many essential changes for users of former PowerFactory versions.
instead of C:\DIgSILENT\pf151.
During normal operation PowerFactory does not write into the installation directory. The only
action that requires write access is changing the PowerFactory configuration (which is now stored
in a readable PowerFactory.ini file). In such rare cases Windows Administrator credential must
be provided in an User Account Control dialogue (see figure 2.1.1 on page 6).
The configuration is now stored in a readable and editable text file PowerFactory.ini (instead of
the binary set.dz).
PowerFactory does not write to the installation directory. So any user data (e.g. the database or
temporary files) have to be somewhere else. As suggested by Microsoft PowerFactory stores its
data now in a Workspace directory inside the Windows user profile e.g. in
C:\Users\UserName\AppData\Local\DIgSILENT\PowerFactory 15.1
The workspace concept including workspace backup and restore and workspace migration is
covered in section 2.5 on page 31.
The PowerFactory executable is now PowerFactory.exe instead of digpf.exe or digkernel.exe
The installation on Application Server is much simpler now (section 3.2 on page 54).
The PowerFactoryDemo activation process was simplified (see section 2.2 on page 7).
This document has been thoroughly revised for 15.1.
New features:
Chapter 2
Basic Installation
This chapter describes the basic PowerFactory installation types: Demo Version (see section 2.2),
Workstation Version (see section 2.3 on page 12), and Server Version (see section 2.4 on page 18).
More advanced installation options (e.g. Multi-User Database, installation on Application Server, and
Offline Mode) are discussed in chapter 3 on page 35.
Note: Installing PowerFactory requires Windows Administration rights. Otherwise the installation will
fail. On newer Windows versions Windows asks for Administrator credentials when needed sec-
tion 2.1.1 on page 6.
2.1 Installer
DIgSILENT PowerFactory is an application for standard Windows operation systems. Both a 32 bit
and a 64bit version are available. The 32-bit version is shipped via CD. If the 64 bit version is required,
please download the installation file from the DIgSILENT Download Area (section 1.4 on page 2).
Installation from CD Insert the PowerFactory 15.2 CD into your CD or DVD drive. This will launch the
DIgSILENTSoftware PreInstaller which guides you the installation options. If the PreInstaller is
not started automatically, run PreInstall.exe manually.
Installation with installer Start the setup PF-15.2.X x64.exe (32 bit) or PF-15.2.X x86.exe (64 bit)
Windows User Account Control dialogue shows a list of Administrator users that are allowed to perform
administrative actions (see figure 2.1.1)
The PreInstaller provides several install options which are described in the next sections:
The demo version can run most implemented options and features, allows calculation of small networks
and the prepared tutorials and examples. It comes with a full tutorial net, accompanied with an on-
line do-it-yourself tutorial. This tutorial explains the principles and functionality of PowerFactory by
letting you build the tutorial net yourself, step by step. The tutorial net contains all the major features of
PowerFactory , and calculations for this network configuration are permitted by the program.
Note: Using the Demo version requires a license activation (see section 2.2.2).
Start the DIgSILENT Software PreInstaller as described in section 2.1 on page 5. A DIgSILENT Soft-
ware PreInstaller dialogue is shown (see figure below).
Click Next and step through the wizard pages. Use the default settings.
Click Finish
Besides two short cuts are created in Windows Start menu (Start All Programs DIgSILENT Software).
Run PowerFactory 15.2 (Configuration) for configuring the application (section 5.2 on page 86). Run Pow-
erFactory 15.2 (Administrator) for administrative purposes (section 5.1 on page 85).
The software must be activated on your computer before it can be used. The activation involves several
steps:
1. Start PowerFactory which will create an Activation Request text for your installation.
2. Send an email with the Activation Request text to DIgSILENT
3. DIgSILENT s sales department sends an email with the Activation Key text back to you.
Send the Activation Request text to DIgSILENT along with some customer information:
Otherwise send the email manually to [email protected]. Copy and paste the email subject
and email text from the dialogue.
DIgSILENT s Sales Team will send a response email. Besides other information it will contain an Acti-
vation Key text that resembles the text below:
In the License Overview Dialogue (figure 2.2.6) press Enter Activation Key.
Copy the text (including the BEGIN ACTIVATION KEY line and the END ACTIVATION KEY line) from
the email and paste it into the text field.
Press Apply Activation Key
Restart PowerFactory
PowerFactoryWorkstation is delivered with a license hardlock (also known as hardware license key
or dongle). DIgSILENT provides USB hardlocks.
Only one hardlock can be connected to one computer at the same time (see figure 2.3.1). The Power-
FactoryWorkstation installation takes two steps:
Start the DIgSILENT Software PreInstaller as described in section 2.1 on page 5. A DIgSILENT Soft-
ware PreInstaller dialogue is shown (see figure below).
After having installed the hardlock driver successfully, the DIgSILENT License Server Setup wizard is
started (see figure 2.3.4).
Press Next and follow the instructions of the installer. Use the default settings.
A success message confirms that the License Server service correctly configured (see figure 2.3.5).
Click Next and step through the wizard pages. Use the default settings.
Click Finish
Besides two short cuts are created in Windows Start menu (Start All Programs DIgSILENT Software).
Run PowerFactory 15.2 (Configuration) for configuring the application (section 5.2 on page 86). Run Pow-
erFactory 15.2 (Administrator) for administrative purposes (section 5.1 on page 85).
An activation is simply downloading an activation file from the DIgSILENT Download Area (section 1.4
on page 2), and saving it to the PowerFactory and License Server installation folder. DIgSILENT
provides the tool digactivate.exe which does the downloading for you:
run the activation tool digactivate.exe in the License Server installation directory
A License Activation Wizard dialogue is shown and will guide you through the activation process (see
figure below).
Press Next
Activate directly from the Internet Download the activation file and save it to the appropriate installa-
tion directories.
Download the activation file without installation Download the activation file only. This options is
useful when the computer you installed License Server has no direct access to the internet.
Activate using a local activation file Save a previous downloaded activation file into to the installation
directories. The path to the previously downloaded activation file must be specified.
DIgSILENT offers the Network License to simplify the handling of hardlocks for companies using Pow-
erFactory on several computers. Network Licenses are shipped with a special hardlock, the Network
Hardlock. This hardlock is plugged to one computer in the computer network e.g. to a server or an-
other machine that runs continuously. All PowerFactory processes installed on any workstation in the
network is able to access a license from this server (see figure 2.4.1).
The network license requires an additional program which is also part of the installation package pro-
vided by download or CD-ROM: the DIgSILENT License Server . Setting up PowerFactory in an
License Server environment requires two steps:
1. Install and configure License Server on the server machine (see section 2.4.1).
2. Install and configure PowerFactory on all workstation machines (see section 2.4.2 on page 25).
The License Server does not need to be installed on a separate server computer. Instead the installa-
tion on one of the Workstation computers is also possible. License Server is started automatically as
a service when Windows starts up.
2.4.1.1 Requirements
Operating System: Windows Vista, Windows 7, Windows 8, Windows Server 2008, 2008 R2,
2012.
Note: The installation has to be done on the console. A remote desktop session as Adminstrator will
not work correctly.
Start the DIgSILENT Software PreInstaller as described in section 2.1 on page 5. A DIgSILENT Soft-
ware PreInstaller dialogue is shown (see figure below).
The Software PreInstaller dialogue allows now to choose the components to install (see figure 2.4.3).
After having installed the hardlock driver successfully, the License Server Setup wizard is started (see
figure 2.4.5).
The default installation directory is C:\Program Files\DIgSILENT\License Server (see figure 2.4.6).
Verify that the dongle is valid and can be accessed by running License Server as a normal Windows
desktop application (and not as Windows service).
A small DIgSILENT License Server application window appears (see figure 2.4.7).
Error messages will be shown in case of any Hardlock or Hardlock driver problems.
Menu About displays useful information about the dongle (see figure 2.4.8).
DIgSILENT License Server is now configured correctly. Now it has to be registered as a service starting
automatically when Windows starts up.
Run the License Server Service Configuration tool diglsvc32.exe in the installation directory
(see figure 2.4.9).
Verify that the License Server service process is really started automatically at the Windows
startup. Note that it can take up to one minute until the process diglise.exe is up and running.
Check for existence of the processes diglise.exe.
Note: After installation of a License Server which is Softkey (instead of Hardlock) protected, the Li-
cense Server has to be started as a Windows application first. A dialogue box will pop up, please
follow the instructions.
Note: A network hardlock cannot be used as a local key for PowerFactoryWorkstation. It can only
be accessed PowerFactoryServer. However PowerFactory and the License Server may be in-
stalled and run on the same machine, so that a network hardlock may be used on a local machine
as long as the License Server is also running.
Any firewall between license server and PowerFactory should open RPC port 135 (TCP) and also
the preconfigured RPC-Endpoint port 4000 (TCP).
Advanced License Server configuration options are covered in the reference chapter (see section 5.4
on page 96).
An activation is simply downloading an activation file from the DIgSILENT Download Area (section 1.4
on page 2), and saving it to the PowerFactory and License Server installation folder. DIgSILENT
provides the tool digactivate.exe which does the downloading for you:
run the activation tool digactivate.exe in the License Server installation directory
A License Activation Wizard dialogue is shown and will guide you through the activation process (see
figure below).
Press Next
Activate directly from the Internet Download the activation file and save it to the appropriate installa-
tion directories.
Download the activation file without installation Download the activation file only. This options is
useful when the computer you installed License Server has no direct access to the internet.
Activate using a local activation file Save a previous downloaded activation file into to the installation
directories. The path to the previously downloaded activation file must be specified.
On each workstation computer PowerFactory must be installed and configured to connect to the Li-
cense Server .
Start the DIgSILENT Software PreInstaller as described in section 2.1 on page 5. A DIgSILENT Soft-
ware PreInstaller dialogue is shown (see figure below).
The Software PreInstaller dialogue allows now to choose the components to install (see section 2.4.13).
Click Next and step through the wizard pages. Use the default settings.
Click Finish
Besides two short cuts are created in Windows Start menu (Start All Programs DIgSILENT Software).
Run PowerFactory 15.2 (Configuration) for configuring the application (section 5.2 on page 86). Run Pow-
erFactory 15.2 (Administrator) for administrative purposes (section 5.1 on page 85).
Open Windows Start menu and run Start All Progams DIgSILENT Software PowerFactory
(Configuration) (see figure 5.1.1 on page 85).
switch to the License page and insert the setting as shown below (see figure 2.4.18)
License Server can be configured with advanced settings (see section 5.4.1 on page 96). These must
be also set on the Advanced sub page.
Windows eventually shows an User Access Control dialogue and asks for an Administrator users
credentials in order to save the configuration file into the PowerFactory installation directory (see fig-
ure 4.2.1 on page 75). Select an Administrative Windows user from the list, insert the users password,
and press Yes.
The License Server s task is to provide license information for each PowerFactory process. This task
includes the monitoring of the number of concurrent users as well as the monitoring of the number of
concurrently used functions. The access to the various calculation functions is thus controlled by the
License Server .
If the license agreement contains different number of functions, e.g. 4 base packages and 2 stability
functions for 4 concurrent users, then it is also possible to configure the users account such that the
users functionality is limited.
The users dialogue box itself determines the functions this user has access to when he is logged on to
PowerFactory .
A right mouse click on a certain user in the data manager offers the menu entry Edit. Selecting this
entry opens the users dialogue box, which appears as figure 2.4.19 shows.
The License page includes a list of all PowerFactory functions. Each function can be enabled or
disabled for this user. The standard setting enables the base package only.
Hint: Only the PowerFactory Administrator user has the right to modify these settings. Section sec-
tion 5.1 on page 85 who start PowerFactory as Administrator.
If there are not enough licenses already occupied, the user will get an appropriate message when
starting PowerFactory . The Help About dialogue in PowerFactory then includes a list of all functions
the user occupies (see figure 2.4.20).
Since version 15.1 PowerFactory stores data in a workspace directory in the Windows user profile.
When a user named Frodo runs PowerFactory , the application data is stored usually in e.g.
C:\Users\Frodo\AppData\Local\DIgSILENT\PowerFactory 15.2\Workspace.ComHLsIb
Log files which are very useful when analysing application problems.
Temporary files.
Its possible to manipulate e.g. backup and copy Workspace directories directly. However PowerFac-
tory provides functionality for saving a workspace (including all files in all subdirectories) as a conve-
nient *.zip archive which can be used as data backup. Similarly an exported workspace *.zip file
can be easily be re-imported into the same PowerFactory installation (i.e. restoring a backup) or into a
completely different PowerFactory installation on another computer (data transfer, data migration).
Note: A Workspace import replaces the current Workspace with the imported Workspace i.e. the cur-
rent Workspace is completely deleted and can not be recovered.
Storing the Workspace in the Windows user profile is convenient, but it might not be suitable under
some special circumstances. Customers might want to choose a different Workspace directory:
A company-wide policy recommends that application data should be stored inside a given direc-
tory (e.g. D:\Data) which is part of the company-wide backup strategy.
Several Windows users e.g. Frodo, Sam, and Pippin want to work on the very same local
database. Though they cant work concurrently at the same time, they might work in turns. Then
the workspace should be in a directory accessible by all three users.
Several Windows users are running PowerFactory concurrently on an Application Server. The
installation on Application Server is described in section 3.2 on page 54.
If youre already working with PowerFactory and want to use the existing workspace to the new
location, export the workspace as described in section 2.5.1 on page 31.
Open Windows Start menu and run Start All Progams DIgSILENT Software PowerFactory
(Configuration) (see figure 5.1.1 on page 85).
Windows eventually shows an User Access Control dialogue and asks for an Administrator users
credentials in order to save the configuration file into the PowerFactory installation directory (see fig-
ure 4.2.1 on page 75). Select an Administrative Windows user from the list, insert the users password,
and press Yes.
If you have exported the Workspace before: import the workspace now as described in sec-
tion 2.5.1 on page 31.
Windows Program and Features dialogue (available via Control Panel Programs Programs and Fea-
tures) allows to un-install PowerFactory and/or License Server from the computer (see figure 2.6.1).
Note: The un-installer removes the whole PowerFactory installation folder. Ensure that you saved im-
portant files somewhere else.
Un-installer doesnt remove the Workspace (see section 2.5 on page 31) which is usually stored in the
Windows users profile directory e.g. in
C:\Users\Frodo\AppData\Local\DIgSILENT\PowerFactory 15.2
If youre sure that you dont need this data any more: delete the Workspace directory manually
e.g. with Windows Explorer
Chapter 3
Advanced Installation
The installation variants in this chapter usually make only sense in a multi-user context with a the
PowerFactory Server version (section 2.4 on page 18).
A multi-user database allows several PowerFactory users to work concurrently and share their
data (see section 3.1).
Several users can work on the same application server (see section 3.2 on page 54).
Offline Mode is based on a multi-user database. It allows to run PowerFactory without a perma-
nent connection to the server (see section 3.3 on page 58).
Normally PowerFactory stores the user data in a local database on the computer where PowerFac-
tory is installed. When three PowerFactory users working three computers want to exchange data
between their database by exporting data to files from one database and importing the files into the
other database (see figure 3.1.1).
In a multi-user database all data is stored in one central database server (see figure 3.1.2).
Steps:
1. Install PowerFactoryServer Version (see section 2.4 on page 18). Verify that the application runs
smoothly before proceeding with the next actions
2. Install and configure Oracle Database Server (see section 3.1.2 on page 37) or Microsoft SQL
Server (see section 3.1.3 on page 43) and configure connection settings in PowerFactory
3. (Optionally) Set up and configure a Vault directory (see section 3.1.4 on page 47)
4. Administrate the PowerFactory database e.g. create PowerFactory user accounts and user
groups (see section 3.1.5 on page 49).
5. (Optionally) Import projects, libraries, or other data from other PowerFactory installations
3.1.2 Oracle
3.1.2.1 Requirements
PowerFactory uses Oracles OCCI/OCI programming interface to communicate with the server. OCCI/OCI
itself uses a proprietary communication scheme on top of TCP/IP.
Server Requirements: The Oracle server machine should fulfil requirements as follows:
Dedicated server: the server machine should be used exclusively for PowerFactory .
CPU: two or more cores/processors
Memory: 2GB RAM or more
Hard disk: 100 GB or more
High network bandwidth (100 Mbit/s or higher) connection between the Oracle server and the
machines where PowerFactory is running.
Depending on the number of users and projects the above numbers have to be adapted.
This section describes the installation and usage of the Oracle database server and client.
Before you set up and configure the client computers in section 3.1.2.3 (Client Installation), the server
must be prepared as explained in section 3.1.2.2 (Server Installation).
Install the Oracle server software on the server computer (ORACLESERVER being the server computer
name used in this section). Please follow the Oracle Server installation instructions.
Let us assume that ORACLESERVER is accessible by the name oracleserver.domain.com in the net-
work. In order to use the Oracle server for PowerFactory you have to do the steps as follows:
Create a new Oracle database with a database name (SID) of PFSERVER (stands for: Power-
Factory Server) or use an existing one. The character set for the Oracle instance should be
WE8MSWIN1252.
An Oracle listener is needed on the server, in order to pass on connection requests from
clients to the database. If you created the database with the Oracle installer, the listener
is configured for you automatically. If you create the database manually, then configure the
listener using the Oracle Net Configuration Assistant tool.
(Recommended but not essential) create the database with redo log files sized at 500MB.
PowerFactory needs a place to store its data. Oracle stores data in so-called tablespaces. It is
suggested to create a new tablespace where PowerFactory (and only PowerFactory) stores its
data. You might adapt and use the SQL statement below to your purposes:
The statement creates a new tablespace named POWERFACTORYTABLESPACE which is stored in a POWERFACTORYTABLESPAC
file in the given directory. The file size is restricted to 5000M i.e. about 5GB.
In order to use the Oracle instance for PowerFactory one new Oracle schema is required. Create
a new schema with the default profile. We suggest the schema name PF.
Define a password for PF. In this example we use aPasswordForPf.
Associate default and temporary tablespaces to schema PF. It is assumed that a temporary ta-
blespace TEMP is available.
Grant the roles CONNECT and RESOURCE and the system privileges UNLIMITED TABLESPACE and
ALTER SESSION to PF. You might use and adapt the SQL script below to create the schema:
CREATE USER PF
PROFILE DEFAULT
IDENTIFIED BY aPasswordForPf
DEFAULT TABLESPACE POWERFACTORYTABLESPACE
TEMPORARY TABLESPACE TEMP
ACCOUNT UNLOCK;
Start the Oracle instance process and Oracle listener process if they are not already started.
Note: The amount of tablespace space PowerFactory requires depends heavily on how PowerFac-
tory is used. The space is roughly proportional to the number of objects in PowerFactory . Ob-
serve the tablespace fill-state regularly (e.g. once per month) and increase the size limit accord-
ingly.
Note: Regarding the recommended sizing of the redo log files when creating the database; this con-
figuration of the redo log files is to increase performance. PowerFactory can generate very large
quantities of redo data in short bursts. This is particularly the case when importing data, copying
large projects or deleting large projects. If for other reasons you require smaller redo log files, (for
example to reduce database recovery time), you should increase the number of log file groups as
an alternative to increasing the file size.
Note: It is highly recommended to backup the Oracle schema on a daily basis. A backup procedure is
described in section 3.1.2.5 on page 42
(Normal) Oracle Client: This package includes many Oracle tools (e.g. management console,
management tools, networking services, utilities etc.) which are not actually required for using
PowerFactory ; supports TNS names.
Oracle Instant Client: This package contains only the files required for using PowerFactory ;
doesnt support TNS names.
Both (normal) Oracle Client and Oracle Instant Client are available for 32bit applications and 64bit
applications. PowerFactory 64bit requires a 64bit Oracle Client; PowerFactory 32bit requires a 32bit
Oracle Client.
Note: The Windows version is not relevant: if you install PowerFactory 32bit on Windows 7 64bit, you
will have to install Oracle Client 32bit.
Install and configure Oracle Instant Client Instant Client is a package of DLL files which can be
downloaded freely from the Oracle website. The package names are:
32bit: instantclient-basic-nt-12.1.0.1.0.zip
64bit: instantclient-basic-windows.x64-12.1.0.1.0.zip
The packages are ZIP archives that can be extracted anywhere e.g. to c:\instantclient 12 1 (see
figure 3.1.3). PowerFactory uses these DLL files in order to communicate with the Oracle Database
server.
Please use the newest version of the 12.2 client and follow the installation documentation. When
asked for choose to install the Runtime installation option. It is assumed that the client software
is installed in C:\app\client\product\12.1.0\client 1 (see figure 3.1.4).
(Optionally) Its possible to add an TNS name entry for PFSin the configuration file
C:\app\client\product\12.1.0\client_1\network\admin\TNSNAMES.ORA
PFS =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = TCP)(HOST = oracleserver)(PORT = 1521))
)
(CONNECT_DATA =
(SERVICE_NAME = PFSERVER)
)
)
Then the PFS TNS name can be used in the PowerFactory configuration.
Open Windows Start menu and run Start All Progams DIgSILENT Software PowerFactory
(Configuration) (see figure 5.1.1 on page 85).
Insert the database connection settings as described below (see figure 3.1.5)
Database service this field describes the connection. It must be conform to the format
//host[:port][/servicename]
With the values used above (host=oracleserver, port=1521 (default port), and SID=PFSERVER)
the connection name is
//oracleserver/PFSERVER
//oracleserver:8888/PFSERVER
If youve installed a (normal) Oracle Client and made an entry (e.g. PFS) in the TNSNAMES.ORA
configuration file, you can use the TNS name instead. Then the Database service is just
PFS
Username and Password During the Oracle server setup an Oracle schema PF with the password
aPasswordForPf has been created. Enter these values in the Username and Password fields.
PowerFactory uses files in the Oracle Client installation folder the communication with the server. In
order to find them, the installation folders must be configured explicitly:
C:\instantclient_12_1\vc11
C:\instantclient_12_1
C:\app\client\product\12.1.0\client_1\oci\lib\msvc\vc11
C:\app\client\product\12.1.0\client_1\bin
Windows eventually shows an User Access Control dialogue and asks for an Administrator users
credentials in order to save the configuration file into the PowerFactory installation directory (see fig-
ure 4.2.1 on page 75). Select an Administrative Windows user from the list, insert the users password,
and press Yes.
3.1.2.5 Backup
Create Backup Describing Oracles backup facilities is far beyond the scope of this installation man-
ual. In this section only a simple technique is described. Please consult the Oracle documentation for
detailed information or other backup strategies. One backup method is the creation of database dumps.
The exp.exe and imp.exe tools are part of the Oracle distribution. To export all data of the schema PF
run the exp.exe tool:
where PF is the schema, aPasswordForPf is his password, PFS is the TNS name, and d:\backup
\database.dump is the filename of the dump file.
Note: During the export or import process no PowerFactory user should must not be active. This
backup strategy is suitable only for e.g. nightly backups.
Oracle also supports so-called hot backups where clients can still use the database during the backup
process. Please consult the Oracle documentation for this backup strategy.
Restore Backup To re-import a database dump, first drop and re-create the Oracle schema PF. Then
run the imp.exe tool:
If you import the dump into another Oracle instance ensure that there is a tablespace with the same
name as the source instance.
Microsoft provides several editions of its relational database system SQL Server, depending on Version
used (2005, 2008 and 2012 are supported):
Enterprise Edition
Standard Edition
Workgroup Edition
Express Edition
DIgSILENT PowerFactory is capable to use all editions as database engine. The free Express Edition
provides almost the same functionality as the other editions but limits database size to 4 GB and lacks
some of the more advanced administration tools. For a complete list of features for all editions consult
the official SQL Server Homepage.
SQL Server operates as a service. Services are applications that run as background processes. The
behaviour of services differs from that of other applications. For example, while most applications
are executed only when a user launches the application from the Start menu, services such as SQL
Server are generally started and stopped by the operating system environment. A service runs in the
background and waits for processing requests. In the case of SQL Server, these requests are for
database operations.
All actions described in this section are to be done on the server computer. Throughout this section
SERVERNAME is used as computer name.
Before the SQL Server service can be used it must be configured to allow for connections over the
network.
Your newly installed instance is now configured to allow network connections. With the next steps a
database for PowerFactory is created.
You have now created a database named pfdb with a corresponding login named pf which uses the
password aPasswordForPf. Feel free to change the values according to your needs.
Note: It is highly recommended to create daily backups of the database. The backup procedure for
SQL Server is described in section 3.1.3.4
Open Windows Start menu and run Start All Progams DIgSILENT Software PowerFactory
(Configuration) (see figure 5.1.1 on page 85).
Windows eventually shows an User Access Control dialogue and asks for an Administrator users
credentials in order to save the configuration file into the PowerFactory installation directory (see fig-
ure 4.2.1 on page 75). Select an Administrative Windows user from the list, insert the users password,
and press Yes.
3.1.3.4 Backup
Create a Backup As with Oracle, SQL Servers backup facilities are far beyond the scope of this
documentation. It is highly suggested you consult the official Microsoft documentation for detailed
backup strategies. We present a very simple method to backup a database and must stress that this
method only satisfies the most basic needs.
A full SQL Server database backup can be easily created from a DOS console on the server computer.
Open a new batch file e.g. d:\backupdir\backup.bat with a text editor (e.g. Windows Notepad
editor).
Insert the above text into the file (all in one line!).
Close the file.
Windows Scheduled Tasks utility allows you to run this batch script automatically, for example every
day at midnight.
Add a new scheduler task PowerFactory backup and configure it as follows (see the Windows
documentation for further information)
This configuration creates nightly backups. The pfdb.dump file is overwritten each time. If you want to
keep the latest three backup dumps enhance the above backup.bat script as follows.
Restore a Backup The RESTORE DATABASE command recovers a database from a dump file. To
restore a database backup on the same database server where it was created follow the instructions
below.
Restoring the database on a different SQL Server installation is more complicated. Let c:\msde2 be
the installation folder of the target SQL Server. All commands are to be run inside sqlcmd.
USE pfdb
GO
sp_change_users_login AUTO_FIX, pf
GO
The Vault is a shared directory where all PowerFactory instances can read and write files. Two Pow-
erFactory features require a Vault:
Shared Result Files PowerFactory stores almost all data in the database. Result Files are an
exception. Result Files are binary files containing the result of simulation calculation. Due to
performance reasons (these results can be arbitrarily large) they are not stored in the database
but directly in files on the hard disk of the local computer.
Result Files are actually redundant since they are re-created when re-running the calculation.
However since a simulation calculation can take hours to finish, its worth to keep them at hand.
In a multi-user database scenario where two PowerFactory users USER1 and USER2 work on
the very same project, USER2 cannot access the Result Files created by USER1 because theyre
stored on USER1s hard disk.
Result Files in a Vault directory can be accessed by all PowerFactory users working on the same
multi-user database (see figure 3.1.8).
Project Archiving: since PowerFactory version 15.1 users can archive their projects. The projects
are exported into an Archive folder in the Vault directory and then deleted from the database.
Users can restore them later. The Housekeeping configuration allows to archive projects that
have not been used for a long time automatically.
The Vault is a shared directory on a file server where all PowerFactory users (i.e. the Windows users
running PowerFactory ) have read and write access. The Vault directory path has to be configured in
PowerFactory .
Open Windows Start menu and run Start All Progams DIgSILENT Software PowerFactory
(Configuration) (see figure 5.1.1 on page 85).
E:\path\to\vault\directory
\\vaultserver\path\to\vault\directory
The specified directory must exist and the current Windows must have read and write access to
this directory.
Windows eventually shows an User Access Control dialogue and asks for an Administrator users
credentials in order to save the configuration file into the PowerFactory installation directory (see fig-
ure 4.2.1 on page 75). Select an Administrative Windows user from the list, insert the users password,
and press Yes.
Note: A Vault directory is required only in rare scenarios e.g. when PowerFactory users often run
long-running simulations and work on the very same shared project, or when using the project
archiving feature. In all other cases dont set up a Vault.
Note: Its strongly suggested to create backups of the Vault directory on a regular basis.
In this section the term User always refers to a PowerFactory user (and not to physical database server
user e.g. on Oracle, SQL Server, or the Windows users).
In a multi-user database users usually have to log in with user credentials i.e. user name and password
(see figure 3.1.10).
Administrative actions have to be carried out as a special built-in PowerFactory user: the Administrator
user. The default Administrator password is Administrator. In a multi-user environment it is strongly
suggested to change this password immediately after the installation:
Open Windows Start menu and run Start All Progams DIgSILENT Software PowerFactory
(Administrator) (see figure 5.2.1 on page 87).
If no Data Manager window is opened: create a new one by clicking on the icon .
Double-click the Administrator.IntUser object in the data manager.
The PowerFactory Administrator user is able to create and modify PowerFactory user accounts in a
multi-user database.
Open Windows Start menu and run Start All Progams DIgSILENT Software PowerFactory
(Administrator) (see figure 5.2.1 on page 87).
A new user object (e.g. Frodo.IntUser) is created and shown in the data manager. Assign the function
rights to the new user.
Press OK.
Over the course of time the database grows and is cluttered with old data that might have a general
negative impact on the database performance. PowerFactory provides a Housekeeping job that can
be configured to be run as periodical background job e.g. every night.
Deletion of items older than a configurable age in all users recycle bin.
Archiving (or even complete deletion) of projects that have not been activated recently.
Regular purge of project storage.
The PowerFactory Administrator user is able to configure the Housekeeping settings (see figure 3.1.14).
Please find the details in the PowerFactoryUser Manual.
This is an optional installation step that can be carried out at a later date. Housekeeping is described in
the Program Administration chapter of the PowerFactory User Manual.
Housekeeping is executed via a Windows Scheduled Task from a computer with PowerFactory in-
stalled. Typically this will be a terminal server (e.g. Citrix) or some other application server. Housekeep-
ing makes use of a command line initiation of PowerFactory . An example execution is as follows:
In the example above, 8 specifies the maximum run duration of the housekeeping as eight hours. If
the housekeeping is scheduled to start at 11 p.m. and is still not finished at 7 a.m., it will exit after
completing its current action.
In the example above, 60 specifies the sleep period, in seconds, after a housekeeping action. If there
were no sleep period the housekeeping would place a heavy workload on the system, possibly affecting
other active users.
The housekeeping execution should be triggered via a Windows Scheduled Task (Windows 2008: Con-
trol Panel/Administrative Tools/Task Scheduler/Create Task). An example of the action configuration is
shown in figure 3.1.15.
The leading and trailing quote characters (") are required since the path contains space charac-
ters.
Add arguments (optional) Insert the housekeeping parameters e.g.
/housekeeping:8:60
Windows scheduled tasks can be automatically stopped. It is preferable to configure this via the house-
keeping maximum run duration parameter, but the scheduled task configuration can be used as a back-
stop. When configuring the scheduled task, choose an appropriate operating system user to run the
task. The user does not need to be logged on.
An Application Server (e.g. Citrix Application Server) allows to run an application several times in
parallel Windows sessions. A typical scenario for a PowerFactory installation is shown in figure 3.2.1.
Several machines and components are involved:
Many Workstations The actual PowerFactory user works locally on his Workstation. When the user
starts the application, a PowerFactory process is started on the Application Server. The applica-
tion windows is shown on the Workstation.
One or more Application Servers One or more instances of PowerFactory are running on this server.
There might be several Application Server Computers organized in a Server Farm.
Database Server Manages the central PowerFactory database. All PowerFactory instances commu-
nicate with it.
Vault File Server (Optional) provides a shared Vault directory (section 3.1.4 on page 47).
License Server Part of a normal Server Version installation (see section 2.4 on page 18). The License
Server doesnt have to run necessarily on a separate computer, it can be hosted on the Application
Server.
Installing PowerFactory on an Application Server offers several advantages over a normal multi-user
database installation:
PowerFactory has to be configured only once on the Application Server computer, but can be
used by potentially hundreds of Workstations.
A high-bandwidth network connection is necessarily required between PowerFactory and a database
server. Bigger companies have their PowerFactory users distributed over several remote loca-
tions with low-bandwidth network.
Figure 3.2.1 suggests that all components have to be installed on different machines. But its possible
to deploy several components on the same computer e.g. the Application Server machine can host
PowerFactory , License Server , and the Vault directory.
Note: PowerFactory is executed in its entirety on the application server. It is important that the server
complies with PowerFactory s computing requirements: RAM, CPU(s), hard disk space, etc.
This section describes how to configure PowerFactory on application server for three Windows users
Frodo, Sam, and Pippin. It is assumed that
PowerFactory Server Version is already installed on the computer according to section 2.4 on
page 18.
PowerFactory the application binary PowerFactory.exe along with several DLL files
C:\
+ Program Files
+- DIgSILENT
+- PowerFactory 15.2
+- PowerFactory.exe // executable
+- PowerFactory.ini // configuration
+- ...
Each Windows user that runs PowerFactory requires a separate workspace directory which will hold
temporary data and log files. The workspace directories are subfolder of a common workspace directory
e.g. d:\Data\PowerFactory Workspaces:
D:\
+- Data
+- PowerFactory Workspaces
+- Frodo // Frodos workspace directory
+- Sam // Sams workspace directory
+- Pippin // Pippins workspace directory
+- ...
+- vault // (optional) common Vault data
The vault directory is optional (see section 3.1.4 on page 47). The workspaces directory must not be
necessarily on a local hard disk. It can be on an network drive instead e.g. \\SERVER\PowerFactory
Workspaces.
D:\Data\PowerFactory Workspaces
D:\Data\PowerFactory Workspaces\Frodo
D:\Data\PowerFactory Workspaces\Sam
D:\Data\PowerFactory Workspaces\Pippin
Verify that each Windows user has read and write access to his Workspace directory
(optional) Create a Vault directory e.g.
D:\Data\PowerFactory Workspaces\vault
Verify that each Windows user has read and write access to the Vault directory.
Open Windows Start menu and run Start All Progams DIgSILENT Software PowerFactory
(Configuration) (see figure 5.1.1 on page 85).
D:\Data\PowerFactory Workspaces\%USERNAME%
(Optional) If your using a vault directory, set the Vault Directory on the Database as described in
section 3.1.4 on page 47.
Windows eventually shows an User Access Control dialogue and asks for an Administrator users
credentials in order to save the configuration file into the PowerFactory installation directory (see fig-
ure 4.2.1 on page 75). Select an Administrative Windows user from the list, insert the users password,
and press Yes.
Since Version 15.0 PowerFactory provides the ability to work in Offline Mode when a network con-
nection to the database server is unavailable. The required project data is cached to the users local
machine, which can then later be synchronized to the server database. Floating licenses are generated
which allow to work without a permanent connection to a License Server .
Note: Offline Mode requires Multi-user database and Floating Licenses module.
Note: Offline Mode can not be combined with the Project Archiving functionality.
This section describes the installation and configuration of the Offline Proxy Service , a software com-
ponent of PowerFactory to be used with the Offline Mode database driver on Microsoft Server 2008
R2. Figure 3.3.1 gives an overview over all components.
1. First a PowerFactory environment in normal (i.e. not-offline) mode has to be set up. It contains at
least a PowerFactory installation, a License Server , and a multi-user database server (Oracle
or SQL Server) (see section 3.3.1).
2. Installation of the Offline Proxy Service on an application server (see section 3.3.2).
3. Configuration of an Offline PowerFactory (see section 3.3.3).
A final section describes the procedure when upgrading to a newer PowerFactory version (see sec-
tion 3.3.4).
Before Offline Mode can be set up PowerFactory Server Version (see section 2.4 on page 18) must
be installed and a multi-user database must be configured and initialized (see section 3.1 on page 35).
The Floating License module must be part of the license.
The Database page of the PowerFactory Configuration might resemble figure 3.3.3
Relevant for the Offline Proxy Service configuration are the parameters below:
Figure 3.3.4: Offline Mode Components Overview for Offline Proxy Service
Either Oracle Instant Client 11.2 or a normal Oracle Client 11.2 is required. The architecture must
match the one of the Offline Proxy Service to be installed, either 32 Bit or 64 Bit.
Oracle Instant Client To be able to access the Oracle Database you need to install a driver called Or-
acle Instant Client. It is also used with PowerFactory and can be obtained from the Oracle Homepage.
The Offline Proxy Service requires version 11.2.
(Normal) Oracle Client Install the Oracle Client using the installer.
The Offline Proxy Service is installed using a Microsoft Installer (MSI) package. The installer files can
be found in the offlinemode sub directory in the PowerFactory installation directory. They are named
Both PowerFactory 32bit and 64bit works with both the 32bit and the 64bit version of the Offline Proxy
Service .
The installer will first check if the prerequisites are fulfilled. You will get the error shown below if the
Microsoft .NET Framework 3.5 is missing (see figure 3.3.5).
Press No in this dialogue and add the Application Server Role using the Server Manager Tools.
To do this, navigate from the Start Menu to Administrative Tools / Server Manager. Select the Roles
section to the left. In the right pane click on Add Role and select the Application Server role.
Continue until the Role Services are shown. Make sure the .NET framework is selected and continue
until the installation starts.
If you meet the prerequisites for installing the Offline Proxy Service you will be greeted by the Setup
Wizard (see figure 3.3.6).
Press Next until you can select the Installation Folder (see figure 3.3.7).
Press Next
Press Next
Press Close
The Offline Proxy Service executable and configuration files are located in the folder
Navigate to the directory where you have installed the Offline Proxy Service and find the file offline.ini.
Open it with any Text Editor, for example Notepad. It will look like this:
[Network]
Port=9401
[Database]
Type=Oracle
DataSource=//servername/instancename
UserId=schemaname
Password=schemapassword
VaultPath=\\vaultserver\vaultfolder
[Folders]
DataRoot=E:\temp\offline
AdditionalPath=C:\oracle\instantclient_11_2
Network Settings
[Network]
Port=9401
Port This port is opened by the server machine to accept incoming connections. It may be necessary
to add an inbound rule to the Windows Firewall. This is covered later in this document.
[Database]
Type=Oracle
DataSource=//servername/instancename
UserId=schemaname
Password=schemapassword
VaultPath=\\vaultserver\vaultfolder
UserId The Oracle user/schema id where the PowerFactory database schema is stored.
Password The encrypted (!) password for the Oracle user. Must be set using the console.exe using
the /setdbpassword command from a command shell. Open a command window in the installa-
tion directory and type
These values should match the Database settings in the Online PowerFactory log on dialogue as
described in section 3.3.1.
[Database]
Type=SqlServer
Server=servername\instancename
UserId=sqlserverUsername
Password=sqlserverPassword
Database=sqlserverDatabase
VaultPath=\\vaultserver\vaultfolder
These values should match the Database settings in the Online PowerFactory log on dialogue as
described in section 3.3.1.
Folder settings
[Folders]
DataRoot=E:\temp\offline
AdditionalPath=C:\oracle\instantclient_11_2
DataRoot This is a directory for temporary files created by the Offline Proxy Service . It may be
necessary to change the access rights on this directory. This is covered later in this document.
AdditionalPath The directories added here are temporarily added to the system PATH variable for
this application only. This can be used to tell the Offline Proxy Service where to find the Ora-
cle Instant Client libraries without modifying the systems PATH variable using Windows system
settings.
Per default, the Offline Proxy Service will write log messages to the Windows application log. This
behaviour is configurable through the file service.exe.config.
The Offline Proxy Service is run as using the system NETWORK SERVICE user account.
It is mandatory for the NETWORK SERVICE account to have read and write access to the directory
specified as Folders/DataRoot folder. It is also mandatory to allow incoming connections on the
port specified under Network/Port.
It is mandatory for the NETWORK SERVICE account to have read&write access to the directory
specified as Database/VaultPath
It is mandatory for the NETWORK SERVICE account to have read&write access to the folder con-
figured for logging C:\Program Files\DIgSILENT\Offline Service
Oracle only: Besides the NETWORK SERVICE account requires a read access to the Oracle Instant
Client directory.
To allow connections from remote clients to the Offline Proxy Service , the configured port must be
added as Inbound Rule to the Windows Firewall. Open the Windows Firewall with Advanced Secu-
rity MMC Snap-In via Start / Administrative Tools.
Service Configuration in the MMC: No special actions needed. All general settings are working as usual.
Log on to the server as the Windows user, which will run the Offline Proxy Service as Windows
service.
Now the Offline Proxy Service is started as a normal console application and writes messages into the
console window:
If there are any errors, adapt the configuration accordingly and restart console until there are no more
errors.
Having resolved all configuration errors Offline Proxy Service is ready to run as a Windows Service.
Open Windows Services console window and start the Service.
Right-click on Offline Service, and select Start in the context menu (see figure 3.3.11).
Before you proceed with the next section, verify that this log file was created and that there are no error
messages in the log file.
On each of the Workstations PowerFactory has to be configured in order to communicate with the
Offline Proxy Service (see figure 3.3.13).
Open Windows Start menu and run Start All Progams DIgSILENT Software PowerFactory
(Configuration) (see figure 5.1.1 on page 85).
Insert the database connection settings as described below (see figure 3.3.14)
Insert the license connection settings as described below (see figure 3.3.15)
Offline licensing Choose Create offline license if the license should be locked for a Offline
License Validity days. Choose Create online server license only, if there is a per-
manent connection to the License Server .
Windows eventually shows an User Access Control dialogue and asks for an Administrator users
credentials in order to save the configuration file into the PowerFactory installation directory (see fig-
ure 4.2.1 on page 75). Select an Administrative Windows user from the list, insert the users password,
and press Yes.
This section describes the steps to take when PowerFactory is upgraded to a new version e.g. from
15.0.3 to 15.2.0.
Run the PowerFactory installer and replace the existing version with the new version.
With the upgraded PowerFactory installation its possible to upgrade the database on the Database
server (see figure 3.3.18).
Run the PowerFactory installer and replace the existing version with the new version.
Start PowerFactory . The local offline database is migrated automatically.
Chapter 4
This chapter addresses typical scenarios where an existing PowerFactory installation is modified.
License Upgrade: an existing license is upgraded (see section 4.1 on page 73)
Apply a PowerFactory service pack e.g. PowerFactory15.1 Service Pack 2 (see section 4.2 on
page 74)
Upgrade to a newer PowerFactory version e.g. from 14.1 to 15.1 (see section 4.3 on page 76).
DIgSILENT s sales team will prepare a new Activation Key for the upgraded license. First youve to
send an Activation Request to DIgSILENT .
Open Windows Start menu and run Start All Progams DIgSILENT Software PowerFactory
(Configuration) (see figure 5.1.1 on page 85).
Press Create Activation Request, which opens a dialog with an Activation Request text.
Send Activation Request text to DIgSILENT s sales team.
When you received an Activation Key text from DIgSILENT Press Enter Activation Key and
insert the key.
DIgSILENT provides for each PowerFactory version e.g. 15.1 a series of Service Packs e.g.
A Service Pack usually contains bug fixes but no new features. A Service Pack is always cumulative
i.e. Service Pack 4 contains all bug fixes Service Pack 3 and earlier Service Packs. Its suggested to
apply the most recent Service Pack.
Start the DIgSILENT Software PreInstaller as described in section 2.1 on page 5. A DIgSILENT Soft-
ware PreInstaller dialogue is shown (see figure below).
Eventually PowerFactorySetup suggests to upgrade the existing PowerFactory installation (see fig-
ure 4.2.2).
At the first start PowerFactory asks to update the database (see figure 4.2.3).
Press Yes.
If youre using a multi-user database you will be asked for the Administrator password. The database
update will take some minutes. Please dont interrupt the update process.
In a multi-user database environment where PowerFactory is installed on several workstations, all ac-
cessing the same multi-user database as shown in figure 3.1.2 on page 36, PowerFactory on all work-
stations has to be upgraded. A not-yet-upgraded PowerFactory can still access the updated multi-user
database but warning message shown (see figure 4.2.4).
This section describes the upgrade of an existing PowerFactory installation to a newer version e.g. 15.0
15.1 or 14.1 15.1. The upgrade process can be quite complex depending on the environment:
1. (PowerFactoryServer only) Upgrade DIgSILENT License Server on the server computer (see
section 4.3.1 on page 77).
2. (PowerFactoryWorkstation only) Unplug all hardlocks.
3. Install the new PowerFactory version into a new installation directory. Follow the instructions in
chapter 2 on page 5.
4. (PowerFactoryWorkstation only) Re-insert hardlock.
5. Configure the new PowerFactory installation: start PowerFactory in Configuration Mode (see
section 5.2 on page 86) and insert the settings from the former installation.
Since version 15.1 the configuration is stored in the PowerFactory.ini file in the installation
directory. Its possible to copy this file into the new installation directory. Youll probably need
Windows Administrator rights for this.
6. Usually you want to continue using your existing PowerFactory database. For database import
and migration see section 4.4 on page 78.
7. (Optional) Uninstall the former PowerFactory installation (see section 2.6 on page 33).
Upgrading an environment with Offline Mode is covered by section 3.3.4 on page 71.
A License Server can not be upgraded directly. Instead the former License Server has to be stopped
and un-installed completely, before the new License Server version can be installed.
Note: If youre using the Floating License module, youll have to do additional actions (see section 4.3.1.1
on page 77).
Now the new License Server can be installed as described in section 2.4.1 on page 18. The final
activation with digactivate.exe is not necessary and can be omitted.
If the License Server hardlock is configured with the Floating License module, the file getlicense.bin
must copied from the former License Server installation directory into the new License Server installa-
tion directory. The floating license parity is synchronized with the file getlicense.bin in the installation
directory. If synchronizing fails the license server stops working properly and must be activated manu-
ally. In this case DIgSILENT must be contacted.
make a backup copy of getlicense.bin before you stop and uninstall the License Server
uninstall former License Server ; install new License Server software dont run it
copy getlicense.bin into the new License Server installation directory
proceed with the normal License Server installation
If the License Server using the Floating License hardlock is expired because of some reasons please
contact DIgSILENT support to provide an activation file. This activation file has to used via the menu
entry Menu Upgrade License.... The License Server has to be restarted afterwards.
Since version PowerFactory 15.1 workspaces (including the local database) can be easily exported
and imported.
Start the former PowerFactory and export the workspace to a *.zip file (section 2.5.1 on page 31)
Start the new PowerFactory and import the *.zip file.
Select a valid 15.0/14.x working directory in the Browse For Folder dialogue e.g. C:\DIgSILENT\pf150
and press OK (see figure 4.4.2).
The 15.0/14.X workspace files are copied into the new workspace and PowerFactory needs a restart
which migrates the database to the new format.
Since version 14.0 PowerFactory can access and use multi-user database from former versions. The
database is migrated automatically when the new PowerFactory version is started. The PowerFactory
Administrator password is required.
Note: A multi-user database is always migrated in-place. After migration the former PowerFactory
version wont be able to use the database anymore. Ensure that the former version is disabled or
completely removed.
Note: The database migration temporarily requires more data space for e.g. intermediate tables or ta-
ble indexes which are dropped at the end of the migration. On Oracle ensure that the temporary
tablespace TEMP can grow up to at least 10 percent of the size of the OBJECT table.
System
Library
Before you migrate, please make sure that these folders dont contain any data you need afterwards.
The new PowerFactory installation must be configured to use the same database connection
parameters.
Start the new PowerFactory version. A warning dialogue is shown (see figure 4.4.3).
Before the migration is started youre asked for the PowerFactory Administrator password.
The existing database is now migrated to the new PowerFactory database structure. Depending on
the size of the database this may take several minutes up to several hours. Please dont interrupt the
migration process. When the migration is completed a success dialogue will appear (see figure 4.4.4).
Each PowerFactory version uses its own database format. Therefore the same database cant be
shared between different PowerFactory builds. If you want to use a new PowerFactory build you have
to migrate the database.
The same applies if you want change the database server (e.g. you move the Oracle server from a
Windows server to a HP-UX workstation) or the whole database system (e.g. Oracle is replaced by
SQL Server).
Migration consists of two steps: First the former database must be exported to DZ files using the former
PowerFactory version. Then these files can be imported with the new PowerFactory version into the
new database.
Before you can import the files you have to create a new database on the database server. The
database system-specific sections describe how to do this.
This will create the database of the new version from scratch.
Then the DZ files exported should be imported. These files can be imported in any sequence.
Earlier PowerFactory versions always migrated the database completely. A complete migration
especially on a multi-user environmentcould run for several days depending on the database size
(i.e. the number of users, the number of projects, and the project sizes) and the available hardware
resources. PowerFactory users could not use the application during that period.
Since PowerFactory version 15.2 its possible to run a Minimal Migration, that reduces the downtime
period for big database essentially. It only alters the database structure, but doesnt migrate the users
projects.
Before the actual migration is started a dialogue allows to choose between Complete and Minimal
migration (see figure 4.4.5).
Complete (recommended): alters database structure and migrates all projects right now. This
may take very long depending on the number of projects and their sizes.
Minimal: alters only the database structure. Projects will be migrated later on first activation.
After a Minimal Migration the Data Manager displays not-migrated projects in a grey-coloured font with-
out any content (see figure 4.4.6). Not-migrated can be renamed, moved, and deleted like normal
projects. Theyre automatically migrated on activation.
Some projects might not be used any more, and stay un-migrated forever. However, in some cases it
might be desirable to enforce the migration of the projects. On account of this PowerFactory can be
started in Migration Mode with the /migration command line argument:
It migrates not-migrated projects sequentially and stops either after a given time period has passed, or
there arent any more projects to migrate.
PowerFactory.exe /migration:8
runs for up to 8 hours. An optional parameter allows to set a sleep time between migrating two projects
in order to reduce the load on the database server. The command below runs the migration for up to 8
hours, pausing for 60 seconds after each project.
PowerFactory.exe /migration:8:60
The migration order of the projects can be influenced by the PowerFactory users. A relative migration
priority can be set in the project dialogue (see figure 4.4.7). First all projects with a High priority are
migrated, then all projects with Medium priority, and finally projects with Low priority. Projects with the
most recent activation date are favoured. Base projects are automatically migrated before their derived
projects.
1. Minimal Migration: during that time the system can not be used by any PowerFactory user.
2. A Windows task is created and scheduled to start PowerFactory in Migration Mode to run for
some hours during each night. During that time users might change the migration priority to High
of projects they think they need in the next days. After all projects have been migrated, the job
can be removed.
3. Immediately after the Minimal Migration PowerFactory users can use the system, and migrate the
projects that theyre actually working on.
Chapter 5
Reference
Some functions (e.g. user management or changing the configuration in the PowerFactory database)
require to start PowerFactory as Administrator user (Administrator Mode).
Open Windows Start menu and run Start All Programs DIgSILENT Software PowerFactory
(Administrator) (see figure 5.1.1).
Alternatively its possible re-start PowerFactory and log as Administrator via the menu Tools Switch
User... (see figure 5.1.2).
Usually the PowerFactory Administrator user has a password. Therefore youre asked to insert a pass-
word (see figure 5.1.3).
Press OK.
Open Windows Start menu and run Start All Programs DIgSILENT Software PowerFactory
(Configuration) (see figure 5.2.1).
Alternatively you can review and change the configuration from within a running PowerFactory via the
menu Tools Configure PowerFactory... (see figure 5.2.2).
The Configuration dialogue contains several pages which are explained in the next sub sections.
Windows eventually shows an User Access Control dialogue and asks for an Administrator users
credentials in order to save the configuration file into the PowerFactory installation directory (see fig-
ure 4.2.1 on page 75). Select an Administrative Windows user from the list, insert the users password,
and press Yes.
5.2.2.2 Oracle
The Database page allows to set the Oracle connection settings (see figure 5.2.5).
//host[:port][/servicename]
With the values used above (host=oracleserver, port=1521 (default port), and SID=PFSERVER)
the connection name is
//oracleserver/PFSERVER
//oracleserver:8888/PFSERVER
If youve installed a (normal) Oracle Client and made an entry (e.g. PFS) in the TNSNAMES.ORA
configuration file, you can use the TNS name instead. Then the Database service is just
PFS
Username and Password During the Oracle server setup an Oracle schema PF with the password
aPasswordForPf has been created. Enter these values in the Username and Password fields.
Vault Directory (Optional) Vault directory as described in section 3.1.4 on page 47.
Note: Usually the Oracle Client installation directory path must be configured on Advanced page.
Otherwise PowerFactory cant find the required Oracle Client Runtime files.
The Database page allows to set the SQL Server connection settings (see figure 5.2.6).
host\instancename
e.g.
MYSERVER\SQLEXPRESS
Note that the 2005 Edition uses something called default instance, which must be accessed by
omitting the instance name in the Database service: MYSERVER.
Username and Password The SQL Server name and password.
PowerFactory s Offline Mode (section 3.3 on page 58) requires to configure a server.
Database service Specify server host name and port, separated by a colon e.g.
OFFLINEPROXYSERVER:9401
Theres nothing to specify for this license option (see figure 5.2.8).
The button Create Activation Request creates an Activation Request text required for activate
the Demo version. The Activation Key text can be imported with Enter Activation Key (see sec-
tion 2.2.2 on page 9).
5.2.3.2 Workstation
Theres nothing to specify for this license option (see figure 5.2.9).
5.2.3.3 Server
The Advanced page allows to set advanced settings (see figure 5.2.11) which must match the License
Server configuration (see section 5.4.1 on page 96).
In Offline Mode there are additional parameters for Offline Licenses (see section 5.2.12).
Offline licensing Choose Create offline license if the license should be locked for some days.
Choose Create online server license only, if there is a permanent connection to the Li-
cense Server .
Offline License Validity Period Only if Create offline license is selected. Number of days the
license should locked on the License Server .
The Workspace page allows to change the Workspace directories (see 5.2.13).
Use Default Workspace Directory Uncheck this option to specify a own Workspace directory.
Workspace Directory Path of the current Workspace directory.
Open Workspace Directory Opens Windows Explorer showing the Workspace directory.
Use Default Backup Directory Uncheck this option to specify a own Workspace Backup directory.
This directory is used when workspaces are exported (section 2.5.1 on page 31).
Backup Directory Path of the current Workspace Backup directory.
Open Backup Directory Opens Windows Explorer showing the Workspace Backup directory.
Note: Be careful when changing the Workspace Directory. The new workspace directory is not
initialized with the current workspace directory. First export the workspace to a *.zip file and
re-import it afterwards as described in section 2.5.1 on page 31.
Additional directories in PATH A set of directories (each directory on a separate line) where Power-
Factory should look for *.dll files e.g. the Oracle Client Runtime.
Startup Commands List of commands that are executed when PowerFactory is started.
The Advanced sub page allows to specify some really advanced settings (see figure 5.2.15).
Master in Distributed Simulation If checked: this PowerFactory instance acts as Master, otherwise
as slave.
Runtime Engine Mode If checked: PowerFactory runs in non-interactive mode i.e. there no dialogues
are shown which wait for user input.
Enable Multi-Threading Allows to run a simulation calculation with multiple threads (experimental)
/housekeeping Execute a database Housekeeping in the database (section 3.1.6.2 on page 53).
/username:<USERNAME> /password:<PASSWORD> Specifies PowerFactory user and password
to use. Example: Start as Administrator user with default password
/migration migrate all not-migrated projects after a Minimal Database Migration (see section 4.4.3 on
page 81 for details)
The License Server has several options, which can be modified by editing the file diglise.ini in the
installation directory:
Protocol based communication: PowerFactory and the License Server communicate via RPC
protocol. The following lines show the standard settings for the communication parameters:
RPC-Protocol=ncacn_ip_tcp
RPC-Endpoint=4000
If you change these values, you will also have to adapt the License of the PowerFactory configu-
ration accordingly (see figure 5.4.1).
Working directory (default: subdirectory Run) request files are read from, and user license files
are written to this directory.
The configuration changes take effect when the License Server service is restarted.
5.4.2 Functionality
This section describes in short the interaction between PowerFactory and License Server .
DIgSILENT PowerFactory communicates with DIgSILENT License Server via RPC protocol by using
binary files written to the license server working directory (Run). For each PowerFactory client a *.req
request file will be created in the Run sub directory in the License Server installation directory.The
License Server responds by creating a user license file *.use in the Run sub directory, then the request
file is deleted.
The client gets the license information via RPC protocol. The corresponding *.use license file exists
in the Run directory as long as the license is valid. If the number of users is UNLIMITED, the user
license files *.use will be deleted immediately after the client has read the file. If the number of users is
LIMITED, PowerFactory will periodically check the existence of the *.use file, and will modify the file to
reflect the time and date of its check. When the user terminates PowerFactory the *.use file is deleted
by the client.
If, for some reason, the connection between PowerFactory and License Server is broken, or if Pow-
erFactory terminates abnormally, the *.use file is not deleted but remains in the Run directory of the
License Server . It is automatically deleted periodically and/or during the next software startup.
The number of *.use files that may be generated in response to client requests corresponds to the
number of user licenses the license key will allow (dependent on how many user licenses have been
purchased) compared to how many other users are currently working with PowerFactory (as shown in
the License Server About Box).
If the number of license files is greater or equal to the maximum permitted number of users, the license
server will not respond.
When the license server program is terminated it will delete all license files i.e. all occupied licenses are
freed.
Note: A PowerFactory session will be closed if the corresponding license file has been deleted, or if
the connection to the License Server is lost during the periodical checks. PowerFactory shows
an appropriate message when the connection to the License Server is lost.
Since Version 15.0 the License Server allows to restrict license requests to a list of named PowerFac-
tory users. For example there are PowerFactory users as shown in figure 5.4.2:
There are eight users (besides the Administrator user) in total, but e.g. only the three users User 03
(user id 15), User 04 (user id 16), and User 05 (user id 5) should be able to request licenses from this
License Server . Then the users have to be specified in a text file AuthenticatedUsers.txt in the
Run sub-directory, each user in a separate line in the format
User_03;15;0
User_04;16;0
User_05;5;1
A DIgSILENT License Server grants licenses to several PowerFactory processes running in a com-
puter network. It is crucial that the License Server is always available. Otherwise its not possible use
PowerFactory . Its availability can be increased by running a second License Server process (a so
called Hot Standby License Server ) on second machine (see figure 5.4.3). Both servers require a
hardlock.
PowerFactory first contacts the Main server. If the Main server is not responding, the Hot Standby
server will be contacted. If the Hot Standby server is not responding, PowerFactory will be closed with
an appropriate error message.
PowerFactory has to be configured accordingly: insert the IP addresses of both Main server (e.g.
192.168.10.1) and Hot Standby server (e.g. 192.168.10.100) on the License page of the configu-
ration dialogue, separated by a comma (see figure 5.4.4). Heres an example:
192.168.10.1,192.168.10.100
The Hot Standby server will only respond if the Main server IP address is correctly configured in Pow-
erFactory . Besides, the configuration file diglise.ini of the Hot Standby server has to include the
IP address of the Main server:
[Options]
...
Main-IP-Address=192.168.10.1
...