ABB

Installation Wizard Operating Instructions

(ECT Installation Wizard)

Document No.: 3BHS268362 E70 Rev. -

Prepared by: Habashi / 01.01.2009
Released by: Eschbach / 01.01.2009

© ABB Switzerland Ltd. All Rights Reserved.

ABB

Table of Contents
Table of Contents................................................................................................................ 2

Glossary ......................................................................................................................... 3

General Information............................................................................................................ 4

Chapter 1 - General Description ....................................................................................... 5

1.1. Introduction .......................................................................................................................5

Chapter 2 - Installation ...................................................................................................... 6

2.1. Installation Wizard Setup ..................................................................................................6
2.2. Screen after Startup ..........................................................................................................7

Chapter 3 - Principle of Operation ................................................................................... 9

3.1. General .............................................................................................................................9
3.2. Configuration File ............................................................................................................10

Chapter 4 - Functional Description ................................................................................ 15

4.1. Start ECT Installation Wizard ..........................................................................................15
4.1.1. Installing a package ........................................................................................................15
4.1.2. Conflict in Installation ......................................................................................................20

Chapter 5 - Error Messages ............................................................................................ 22

Chapter 6 - Configuration XML Syntax .......................................................................... 25

3BHS268362 E70 Rev. - 2

ABB

Glossary

CTMS Control Terminal Management Studio

CT Control Terminal

ECT Excition Control Terminal

LCT LCI Control Terminal

Datapoint A parameter or signal is called a datapoint

OPC OLE for Process Control, a sever which contains ControlIT datapoints and
events.

3BHS268362 E70 Rev. - 3

ABB

General Information
Technical Support Address

ABB Switzerland Ltd

PES Development Department ATPT2
CH-5300 Turgi / Switzerland
Telephone: +41 58 589 38 96
Fax: +41 58 589 25 80
Email:
Internet:

Note: throughout this document the 3 terminologies namely, ECT Installation Wizard, Installation
Wizard or Wizard indicate the same terminology i.e. ECT Installation Wizard Tool.

3BHS268362 E70 Rev. - 4

ABB

Chapter 1 - General Description

1.1. Introduction
The Excitation Control Terminal(ECT) Installation Wizard is a standalone software tool
which provides easy installation of various compenents of the Control Terminal such as
ECT, CTMS or Demo for the UNITROL 60XX systems. The need for such a tool arises
from the fact that the complete installation of ECT is a relatively complex task, because on
one hand, there are 3 types of the UNITROL systems, namely:
• UNITROL 6800
• UNITROL 6080
• UNITROL Demo mode
On the other hand, each of above mentioned systems includes in turn, further types such
as:
• Single Channel
• Double Channel
• Single Channel with Backup
• Double Channel with Backup
Each channel may have various configuration such as Local, Remote1, Remote2,
Remote3 or Remote4.
Furthermore, in order for ECT to properly connect and operate with any of the above
UNITROL system, requires installation of ECT with the right application configuration files,
the installation of the OPC server together with its configuration files located in a certain
location. The installation of the WiBu key driver as well the Firebird database are also
required.
The main features of Installation Wizard include:
• Installation of ECT for a certain and pre-defined configuration of the UNITROL
systems.
• Installation of CTMS
• Installation of LCT
• Installation of Auto Startup

3BHS268362 E70 Rev. - 5

ABB

Chapter 2 - Installation
2.1. Installation Wizard Setup
The Installation Wizard does not have any installation program and it can be directly
started from a CD or a disk drive. However, Installation Wizard requires the Microsoft
.NET framework 3.5. If this framework is not already installed on your PC, by starting the
Installation Wizard, one of the following error messages is output:

Or:

NOTE: by installing .NET framework you will get the following dialog from Microsoft
which runs very slowly and the progress bar indication is somewhat confusing but it
installs correctly!! Please have also some patience since the installation may take up to 10
minutes or longer.

3BHS268362 E70 Rev. - 6

ABB Chapter 2 - Installation

IMPORTANT NOTE: After the installation the PC must be rebooted in order the WiBu
key driver to be effective, otherwise, by starting the Control Terminal, an error message
regarding that the key is missing may be output.

2.2. Screen after Startup

The following dialog will appear after the startup.

3BHS268362 E70 Rev. - 7

Chapter 2 - Installation ABB

At the top statusbar, the version(1.0.0) of the Installation Wizard configuration file is
displayed. There is also a field at the top of the screen marked as “UNITROL >>”. This
field is only informative and shows the selection path. As you will see in the next chapter,
the Installation Wizard is built up in hierarchical form. On the main screen, the various
installations of the Control Terminal are also listed. At the bottom left, under the ABB logo,
the version of the Installation Wizard tool is shown.

8 3BHS268362 E70 Rev. -

ABB Chapter 3 - Principle of Operation

Chapter 3 - Principle of Operation

3.1. General
The ECT Installation Wizard is a configurable tool. The project engineer is responsible for
configuration of this tool which can be performed using the “WizardConfiguration.XML” file
located in the same directory as the Installation Wizard tool. This XML file can be edited
using any text editor or any XML tool such as XMLSpy.
Please refer to Chapter 6 for the syntax description of this configuration XML file.

-- install ECT ver.x.x

ECT -- install CTMS ver.x.x
Configuration
XML file Installation Wizard -- install LCTver.x.x
-- install AutoStart
-- …

When the Installation Wizard is started, it reads through the wizard configuration XML file
and builds up the installation wizard structure. If the configuration file includes any syntax
error, then the wizard will not start and an error message is output. Note, that the
configuration file is read only during the wizard start up. This means if you make any
changes to the configuration file during the wizard operation, this will not have any effect.
In order for your changes to be effective, you have to restart the wizard!

The user selects the version of the control terminal package which he wishes to install.
The wizard lists all the software components(such OPC server, WiBu key, ECT) which are
needed to be installed for the requested installation. If the wizard detects that another
version of the requested installation already exists, it outputs a conflicting sign and lists
the conflicting installations. The user can decide whether to continue with the installation
process by clicking on the “Install” button or manually remove the already existing
installations.
Note that for OPCServer and the WiBu key, it does not output conflicting sign since these
components have only one version. The wizard checks whether these components
already installed on the PC, in this case it will not install them again otherwise, installs
them. This is the reason why the installation process may take different length of time
depending upon which components already exists.

The wizard is normally configured(by the project engineer) in a hierarchical(tree) form.

The project engineer decides on the number of installations to be included in the wizard.

3BHS268362 E70 Rev. - 9

Chapter 3 - Principle of Operation ABB
Each installation may have different version, each version may in turn have further
versions. In this way a tree structure similar shown below may be built. Note that the
depth of the tree is unlimited. However, the more depth in the structure, means the more
complicated the configuration file!

UNITROL
Installation Wizard

CTMS ECT

V1.0.10 V1.0.12 V1.0.13 Demo UN6080 UN6800

V1.3.32 V2.3.32

Single Single
Channel Channel
Local Local

3.2. Configuration File

The configuration file of the ECT installation Wizard is called “WizardConfiguration.XML”
and it resides in the same location as the wizard exe file.
The configuration file is used to specify the structure of the wizard. And in particular, to:
• specify the installation packages(ECT, CTMS) with their different versions(tree)
• specify the documentation to be delivered for each version

10 3BHS268362 E70 Rev. -

ABB Chapter 3 - Principle of Operation

• specify the location of the installers for the specified installation packages
• specify the CT application files
• specify any files to be delivered such as OPC server definition files

The configuration file contains the following XML elements

<Configuration>
<DocFiles> All the documents are listed here.
<FileSets> All files to be delivered(OPC file)
<Installers> All installers are listed here.
<ApplicationConfigurations> All ECT config files are listed here.
<Options> The tree structure of each installation
is defined here.
</Configuration>

In order to create this configuration file, it is important to consider that this file is virtually
divided into 2 parts, namely Global and iterative as shown below:

?Global:

DocFiles
FileSets
Installers
ApplicationConfigurations

?Iterative:

Options

In the global part, all the documents, files, installers and application configuration files are
declared together with their paths where they reside. In the iterative part, the hierarchy of

3BHS268362 E70 Rev. - 11

Chapter 3 - Principle of Operation ABB
the all the installations are defined and the global elements are only referenced. The
advantage of this method is that in a large project such as UNITROL wizard, all the path
of the various files are only declared once, and if for some reasons they may be modified,
they are only modified in one place.
One more important issue in the iterative part, is the inheritance property. This means that
in the hierarchical(tree) structure, there are parent and child elements used to define the
different versions of the installations. In this case, a child element(installation) inherits
installation from the parent element. This in turn, means that those installations which are
common for both parent and child can be declared only once in he parent element.
With the help of the next example, the whole concept can be better illustrated. Note, that
in the example, we try to show only the high level design and the syntax used is not
precise. Please refer to Chapter 6 for the exact syntax of the configuration file.

12 3BHS268362 E70 Rev. -

ABB Chapter 3 - Principle of Operation

Example:
Assume we wish to create an installation wizard for installing 2 packages namely ECT
and CTMS. The ECT package has 2 further versions namely, Ver1.0 and Ver2.0. Each
version has a user manual. ECT has one config file for each version. There is also an
OPC server common for ECT and CTMS. The OPC server definition files must be also
delivered with this wizard.

Here is the high level design of the wizard configuration file. Note: the syntax used in the
following example is not precise(correct)!!!
<Configuration>
<DocFiles>
UserMan_ECT_Ver_1.0 path: Doc\ect user manual v1.0.pdf
UserMan_ECT_Ver_2.0 path: Doc\ ect user manual v2.0.pdf
UserMan_CTMS_Ver_1.0 path: Doc\ctms user manual v1.0.pdf
<SetFiles >
Opc_Files_V1.3.32 path source: OPC File\1.3.32 path target: “OPCServer”
“OPCServer” this path is defined in registry. To find out, start registry by clicking
on Stat/Run then enter RegEdit. Select the following path in the registry structure:
SOFTWARE/ABB/OPCServer/5.0.2/Installation/FilePaths/WorkingFolder
<Installers>
Ect_ver1.0_installer path: CT/ECT/ect installer verion 1.0.msi
Ect_ver2.0_installer path: CT/ECT/ect installer verion 2.0.msi
CTMS_installer path: CT/CTMS/ctms installer verion 1.0.msi
Opc_server_installer path: CT/OPCServer/setup.exe

<ApplicationConfigurations>
ECT_1.0_UN6800_1.2.21_config path: 1.2.21/npf-configuration.xml
ECT_2.0_UN6800_2.2.32_config. path: 2.2.32/npf-configuration.xml
<Options >
Root : UNITROL
<SupportingInstallers>
Opc_server_installer
<ChildOption>
ECT
<ChildOption>
V1.0
<SupportingInstallers>
Ect_ver1.0_installer

3BHS268362 E70 Rev. - 13

Chapter 3 - Principle of Operation ABB
<DocumentationFiles>
UserMan_ECT_Ver_1.0
<ApplicationConfiguratons>
ECT_1.0_UN6800_1.2.21_config
V2.0
<SupportingInstallers>
Ect_ver2.0_installer
<DocumentationFiles>
UserMan_ECT_Ver_2.0
<ApplicationConfiguratons>
ECT_2.0_UN6800_2.2.32_config
CTMS^
<SupportingInstallers>
CTMS_installer
<DocumentationFiles>
UserMan_CTMS_Ver_1.0
</Configuration>

14 3BHS268362 E70 Rev. -

ABB Chapter 4 - Functional Description

Chapter 4 - Functional Description

4.1. Start ECT Installation Wizard
After starting ECT Installation Wizard the following dialog appears and the user can
select one of the listed installation packages such as ABB ECT, ABB CT Mqnqgement
Studio, ABB LCT.
The user can select a package and navigate through to choose the requested version
of the installation package. The navigation path is displayed at the top of the screen in
the field marked as “UNITROL>>”. All the texts which appear in the entire graphical
user interface(GUI) are defined in the wizard configuration XML file.

The software version of the ECT Installation Wizard can be viewed in the main screen
under the ABB logo.

4.1.1. Installing a package

Assuming that we wish to install the ABB CT Management Studio. To install this package,
follow these:

3BHS268362 E70 Rev. - 15

Chapter 4 - Functional Description ABB
• Select this package as shown below and click on the Next button:

You will get the following screen:

16 3BHS268362 E70 Rev. -

ABB Chapter 4 - Functional Description

• Select the required version of this package and click on the Next button:
The following screen will appear:

3BHS268362 E70 Rev. - 17

Chapter 4 - Functional Description ABB

The above screen has 3 tabs, namely, Description, Documentation Files and Installers.
The description tab includes a short text about the installation package. The
Documentation Files tab lists all the available documents for the current installation.
Each document can be opened by clicking on the symbol located on the very right
hand side of the document as illustrated below:

18 3BHS268362 E70 Rev. -

ABB Chapter 4 - Functional Description

The Installers tab lists all the installers required for the current installation package. In
this case, the required installers are CT Management Studio V1.0.13 and the Firebird
Database Driver.

3BHS268362 E70 Rev. - 19

Chapter 4 - Functional Description ABB

The installation process can be completed by clicking on the Install… button.

Upon a successful installation, the following message will appear:

By clicking on the OK button, the main screen of the Installation Wizard appears where
the user can select the next installation package.

4.1.2. Conflict in Installation

During the installation operation, if the wizard detects that one or more version of the
package to be installed already exists, the wizard outputs a conflicting tab marked in red
color. In this tab all the conflicting packages are listed. The user can then decide whether
to continue with the installation or uninstall them. To uninstall a package, it should be
selected first then the Uninstall… button be clicked.

20 3BHS268362 E70 Rev. -

ABB Chapter 4 - Functional Description

3BHS268362 E70 Rev. - 21

ABB
Chapter 5 - Error Messages

Startup error
The ECT Installation Wizard requires .NET framework 3.5 and if this software is not
already installed then the following error message is output:

Or you get the following error message:

Or you get the following error message:

3BHS268362 E70 Rev. - 22

ABB Chapter 5 - Error Messages

The above error message indicates that there is a syntax error in the wizard configuration
XML file. The line number of the error location is also shown.
Exception error
The following error message may be output, if the wizard configuration XML file includes
an invalid path.

Not resolve the application path

The following error message may be output, if the wizard can’t find the CT installation
path in the registry:

After clicking on OK button, the following dialog opens:

3BHS268362 E70 Rev. - 23

Chapter 5 - Error Messages ABB

Please select the installlation path, e.g. C:\Program Files\ABB\CT\CT Panel Edition\CT
Panel Edition for ECT

Click on OK to continue with the installation.

24 3BHS268362 E70 Rev. -

ABB

Chapter 6 - Configuration XML Syntax

<!--
Wizard Configuration XML File Syntax Description:

A wizard configuration does not keep everything that belongs to a given installation together
(e.g. installers, documentation, database files etc.), but declares all files that can be
copied/installed/displayed on the root level. This greatly simplifies keeping the overview
of the individual configurations that follow. Basically, this configuration file consists
of four root sections:

- DocFiles: Declares available documentation files

- FileSets: Declares groups of files that can be copied to the target machine. This is in particular used for declaration of
OPC server file, application configuration files and database files.
- Installers: Declares avilable CT- and 3rd-party installers that can be executed
- ApplicationConfigurations: These are the configuration files that belongs to a certain CT
-->

<Configuration Id="DEFAULT" Name="Wizard Sample Configuration">

<DocFiles>
<!-- Available documentation files are being declared here, paths relative to "Documentation" root folder -->
<DocFile Id="DOC:Manual A" Name="CT User Manual" FilePath="docs/Manual A.pdf" />
<DocFile Id="DOC:Manual B" Name="ABB Control Terminal Introduction" FilePath="docs/Manual B.pdf" />
<DocFile Id="DOC:Manual C" Name="ECT Demo System: Parameters and Groups" FilePath="docs/Manual C.pdf" />
</DocFiles>

<FileSets>
<!--
Sets of arbitrary files to be copied to any location, paths relative to "Files" root folder.
The target location can be an absolute path (e.g. C:\abb-files) or relative to one of these folders:
- Desktop
- Installers (this is where the CT installer is being installed to).
- ApplicationConfigurations (CTs sub folder in the "My Data" special folder)
- OpcServerFiles (the path of the ABB OPC server - needs to be installed of course)
-->
<!-- a file set groups a number of files and copies them to a given location -->
<FileSet Id="FS:Set1" Name="Set1">
<TargetDirectoryRoot>ApplicationFolder</TargetDirectoryRoot>
<DeleteFolderContentsBeforeCopying>false</DeleteFolderContentsBeforeCopying>
<TargetDirectoryPath>SubFolder</TargetDirectoryPath>
<!--
A "FilePath" indicates the source location and can be one of two things:
- a file that is being copied to the target directory
- a folder whose *content* is being copied.
-->
<File FilePath="File0.txt" />
<File FilePath="File1.txt" />
<File FilePath="File2.txt" />
</FileSet>
<FileSet Id="FS:Set2" Name="Set2">
<!-- another file set -->
<File FilePath="File0.txt" />
<File FilePath="File1.txt" />
</FileSet>
</FileSets>

<Installers>
<Installer Id="INST:Installer A" Name="Installer A">
<!-- registry value to be checked in order to determine whether software is already installed -->
<RegistryCheck RegistryPath="HKEY/USERS/" FieldName="Version" FieldValue="1.0.1">
<InstallStrategy>IfUnavailable</InstallStrategy>

3BHS268362 E70 Rev. - 25

Chapter 6 - Configuration XML Syntax ABB
</RegistryCheck>
<!-- path relative to the "Installers" root directory -->
<FilePath>Installer A.msi</FilePath>
</Installer>
<Installer Id="INST:Installer B" Name="Installer B">
<!-- registry value to be checked in order to determine whether software is already installed -->
<RegistryCheck RegistryPath="HKEY/USERS/" FieldName="Version" FieldValue="1.0.1">
<InstallStrategy>Always</InstallStrategy>
</RegistryCheck>
<FilePath>Installer B.msi</FilePath>
</Installer>

<Installer Id="INST:ECT Demo System" Name="ECT Demo System">

<!-- registry value to be checked in order to determine whether software is already installed -->
<RegistryCheck RegistryPath="HKEY/USERS/" FieldName="Version" FieldValue="1.0.1">
<!-- only runs the installer if the registry check does not find any software -->
<InstallStrategy>Always</InstallStrategy>
</RegistryCheck>
<FilePath>ECT Demo System.msi</FilePath>
</Installer>
<Installer Id="INST:ECT for PEC 6080" Name="ECT for PEC 6080">
<RegistryCheck RegistryPath="HKEY/USERS/" FieldName="Version" FieldValue="1.0.1">
<!-- only runs the installer if the registry check does not find any software -->
<InstallStrategy>IfUnavailable</InstallStrategy>
</RegistryCheck>
<FilePath>ECT for PEC 6080.msi</FilePath>
</Installer>
</Installers>
<!-- these are CT configuration files. For every selected installer, a configuration file can
be selected and individually configured before it is being copied to the installation
directory.
-->
<ApplicationConfigurations>
<ApplicationConfiguration Id="CONFIG:application.1" Name="application.1" FilePath="application.1.config" />
<ApplicationConfiguration Id="CONFIG:application.2" Name="application.2" FilePath="application.2.config" />
</ApplicationConfigurations>

<!--
This is the hierarchy of target systems - basically, these are nested "Item"
elements that allow us to follow a hierarchical selection, e.g.
UNITROL 6080 >> UNITROL SW VERSION X >> ECT VERSION Y >> ECT CONFIGURATION Z

While following the hierarchy, all configured data is merged. This means that
a child item automatically derives the configuratino of its parent, e.g. by merging
files to be copied.

Every item, on every level can define the following content:

- An arbitrary number of child items.
- References to 0-n file sets. These files will be copied if the item or one of its children was selected.
- References to 0-n documentation files. These will also be merged.
- References to 0-n 3rd party installers. These will be merged too and executed in declaration order
- References to 1 CT configuration. The file can be declared on every level in the item hiearchy, but when
merging items, the allowed maxiumum of found configuration files is 1.
- A path to a given CT installer. Again, the file can be declared anywhere, but every graph from root to leaf
must not include more than 1 CT installer.
-->

<Option Id="OPT:Root" Name="Root">

<Description>This is the root configuration item. Please select one of the two child options below...</Description>
<!-- The childs of root item - in this case, we display Unitrol software versions -->
<ChildOptions>
<!-- Comment -->
<Option Id="OPT:Child6" Name="ECT Demo System">
<Description>
</Description>

26 3BHS268362 E70 Rev. -

ABB Chapter 6 - Configuration XML Syntax

<ApplicationInstaller>
<!-- The installer(s) are referenced here -->
<ItemReference>INST:ECT Demo System</ItemReference>
</ApplicationInstaller>
<!-- UNINSTALL PATTERN search in registry for uninstall of products in case of conflict detection-->
<SuggestedUninstallPattern>wibu</SuggestedUninstallPattern>
<DocumentationFiles>
<!-- We already include CT manuals on the root level - the user always gets these... -->
<!-- The reference for DOC Files are inserted using "ItemReference"-->
<ItemReference>DOC:Manual C</ItemReference>
</DocumentationFiles>
</Option>
<Option Id="OPT:Child2" Name="Child2">
<Description>
This is the second child of the root item.
This is a longer text, which we need to wrap,
which means, continue on a new line so we can read everything...
</Description>
<!-- ChildOptions are used for building a hirachy / tree structure -->
<!-- NOTE: a child elemnt inherits all features of the parent. This means if you define an installer or DocFiles -->
<!-- by parent, you don't need to define it again by the child element. Only once is enough -->
<ChildOptions>
<Option Id="OPT:Child3" Name="Child3">
<ChildOptions />
<FileSets>
<!-- The reference for FileSets are inserted using "ItemReference"-->
<ItemReference>FS:Set2</ItemReference>
</FileSets>
</Option>
<Option Id="OPT:Child4" Name="Child4" />
<Option Id="OPT:Child5" Name="Child5" />
</ChildOptions>
<FileSets>
<ItemReference>FS:Set1</ItemReference>
</FileSets>
</Option>
</ChildOptions>
<DocumentationFiles>
<ItemReference>DOC:Manual A</ItemReference>
<ItemReference>DOC:Manual B</ItemReference>
</DocumentationFiles>
<SupportingInstallers>
<ItemReference>INST:Installer A</ItemReference>
</SupportingInstallers>
<FileSets>
<ItemReference>FS:Set1</ItemReference>
</FileSets>
</Option>
</Configuration>

3BHS268362 E70 Rev. - 27

ABB
REVISION
Rev. Page (P), Description Date
ind. Chapt. (C) (or number of revision) Dept./Init.
- All initial version 01-01-2009
ATPT / EH

3BHS268362 E70 Rev. - 28