Installation Guide PDF

Citect SCADA 2018
Installation and Configuration Guide

May 2018
Legal Information
DISCLAIMER
Aveva Group Plc makes no representations or warranties with respect to this manual and, to the maximum extent permitted by law,
expressly limits its liability for breach of any warranty that may be implied to the replacement of this manual with another. Further,
Aveva Group Plc reserves the right to revise this publication at any time without incurring an obligation to notify any person of the revi-
sion.
The Example Projects are provided to you for the purpose of illustrating how the SCADA software 2018 could be used in an oper-
ational environment ("the Purpose"). Schneider Electric grants you a royalty free, non exclusive, non transferable license to use the
example projects installed with your SCADA software version 2018 (“the Example Projects”) for the Purpose only.
The Example Projects are provided by Schneider Electric as part of the SCADA software version 2018 on an "as is" basis and Schneider
Electric does not guarantee the reliability, serviceability or function of the Example Projects.
Should you modify the Example Projects, you bear the risk of any use of such modified Example Projects.
Schneider Electric gives no express warranties, guarantees or conditions and to the extent permitted under applicable laws, Schneider
Electric disclaims all implied warranties, including any implied warranties of merchantability, fitness for a particular purpose or non-
infringement of third parties’ intellectual property rights.
Schneider Electric shall not be liable for any direct, indirect or consequential damages or costs of any type arising out of any action
taken by you or others related to the Example Projects.
The Schneider Electric industrial software business and AVEVA have merged to trade as AVEVA Group plc, a UK listed company. The
Schneider Electric and Life is On trademarks are owned by Schneider Electric and are being licensed to AVEVA by Schneider Electric.
COPYRIGHT
© 2018 Aveva Group Plc. All rights reserved.
TRADEMARKS
Aveva Group Plc has made every effort to supply trademark information about company names, products and services mentioned in
this manual.
Citect, CitectHMI, Vijeo Citect, Vijeo Citect Lite and CitectSCADA are either registered trademarks or trademarks of Aveva Group Plc.
Pelco, Spectra, Sarix, Endura, are registered trademarks of Pelco, Inc.
IBM, IBM PC and IBM PC AT are registered trademarks of International Business Machines Corporation.
MS-DOS, Windows, Windows NT, Microsoft, and Excel are either registered trademarks or trademarks of Microsoft Corporation in the
United States and/or other countries.
DigiBoard, PC/Xi and Com/Xi are trademarks of Digi International Inc.
Novell, Netware and Netware Lite are either registered trademarks or trademarks of Novell, Inc. in the United States and other
countries.
dBASE is a trademark of dataBased Intelligence, Inc.
All other brands and products referenced in this document are acknowledged to be the trademarks or registered trademarks of their
respective holders.
GENERAL INFORMATION
Some product names used in this manual are used for identification purposes only and may be trademarks of their respective com-
panies.
May 2018 edition for Citect SCADA Version 2018.
Manual Revision Version 2018.
PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by qualified personnel. No responsibility is assumed
by Aveva Group Plc for any consequences arising out of the use of this material. © 2018 Aveva Group Plc. All Rights Reserved.
Validity Note
The present documentation is intended for qualified technical personnel responsible for the implementation, operation and main-
tenance of the products described. It contains information necessary for the proper use of the products. However, those who wish to
make a more "advanced" use of our products may find it necessary to consult our nearest distributor in order to obtain additional
information.
The contents of this documentation are not contractual and in no way constitute an extension to, or restriction of, the con-
tractual warranty clauses.
Contact Schneider Electric today at www.schneider-electric.com
Contents
Legal Information 1
Contents 3
Safety Information 5
Chapter 1: Introduction 9
About This Guide 9
Purpose 9
Maintaining System Currency 9
Chapter 2: Upgrading to Citect SCADA 2018 11

New Features 12
Introduced in 2018 12
Upgrade Method 15
Upgrade Path 16
Offline Upgrade 16
Migrating to Production 21
Troubleshooting Offline Upgrade 23
Online Upgrade 23
Pre-requisites for Online Upgrade 24
Upgrading from v7.20 25
Special Considerations 26
Upgrading from v7.40 27
Upgrading from v2015 28
Upgrading from v2016 29
Troubleshooting Online Upgrade 29
Migration Tool 31
Using the Migration Tool 31
3
Contents
Remove Obsolete Memory and Alarm Devices 34

Creation of Roles for Existing Users 36
Migrate Included Projects 37
Default Scale 37
Chapter 3: Installation Description 39

Task Selection Dialogs 39
Installation Profiles 39
Documentation Installation 40
Add-ons Installation 41
Communication Drivers 41
Chapter 4: Installation Requirements 43

Hardware Requirements 43
System Software 47
Runtime Only Server or Client System Software 49
Virtualization Host Support 50
Anti-virus Software Setup 50
Software Protection 51
Updating Your Hardware Key 52
Floating Point License Manager 53
Dynamic Point Count Licensing 54
Demo Mode 55
Chapter 5: Installation 57
The Installation Process 57
Preliminary Installation 57
Installation Profiles 60
Completing the Installation 65
Communication Drivers 68
Installing Additional Communication Drivers 71
Modify, Repair, or Remove Components 72
Chapter 6: Configuration 75
Local Area Network Configuration 75
Network Communications Overview 76
Configuring Communications Over a WAN 77
Web Server Configuration 77
The IIS Virtual Directory 78
Setting Up Security 79
Web Client user account types 79
Configuring Security Using IIS 79
Testing the Web Server Security Settings 83
Logging on to the Web Server 84
Deployment Server Configuration 84
4
Safety Information
Hazard categories and special symbols
The following symbols and special messages may appear in this manual or on the
product to warn of potential hazards or to call attention to information that clarifies or
simplifies a procedure.
Symbol Description
The addition of either symbol to a “Danger” or “Warning”

safety label indicates that an electrical hazard exists
or which will result in personal injury if the instructions are
not followed.
This is the safety alert symbol. It is used to alert you to

personal injury hazards. Obey all safety messages that
follow this symbol to avoid possible injury or death.
DANGER indicates an imminently hazardous situation, which, if not avoided, will result in death or
serious injury.
WARNING indicates a potentially hazardous situation, which, if not avoided, can result in death or
serious injury.
CAUTION indicates a potentially hazardous situation which, if not avoided, can result in minor or
moderate injury.
NOTICE
NOTICE used without a safety alert symbol, indicates a potentially hazardous situation which, if
5
Safety Information
not avoided, can result in property or equipment damage.
Please Note
Electrical equipment should be installed, operated, serviced, and maintained only by

qualified personnel. No responsibility is assumed by Schneider Electric for any con-
sequences arising out of the use of this material.
Before You Begin
Citect SCADA is a Supervisory Control and Data Acquisition (SCADA) solution. It facil-
itates the creation of software to manage and monitor industrial systems and processes.
Due to Citect SCADA's central role in controlling systems and processes, you must appro-
priately design, commission, and test your Citect SCADA project before implementing it
in an operational setting. Observe the following:
UNINTENDED EQUIPMENT OPERATION
Do not use Citect SCADA or other SCADA software as a replacement for PLC-based control pro-
grams. SCADA software is not designed for direct, high-speed system control.
Failure to follow these instructions can result in death, serious injury, or equipment dam-
age.
LOSS OF CONTROL
l The designer of any control scheme must consider the potential failure modes of control paths and,
for certain critical control functions, provide a means to achieve a safe state during and after a path
failure. Examples of critical control functions are emergency stop and overtravel stop, power out-
age and restart.
l Separate or redundant control paths must be provided for critical control functions.
l System control paths may include communication links. Consideration must be given to the implic-
ations of unanticipated transmission delays or failures of the link.
l Observe all accident prevention regulations and local safety guidelines. 1
l Each implementation of a control system created using Citect SCADA must be individually and thor-
oughly tested for proper operation before being placed into service.
age.
6
Safety Information
1. For additional information, refer to NEMA ICS 1.1 (latest edition) "Safety Guidelines
for the Application, Installation, and Maintenance of Solid State Control", and to NEMA
ICS 7.1 (latest edition) "Safety Standards for Construction and Guide for Selection, Install-
ation and Operation of Adjustable-Speed Drive Systems" or their equivalent governing
your particular location.
7
Safety Information
8
Chapter 1: Introduction
About This Guide
Purpose
This document provides instructions for installing Citect SCADA. It describes the install-
ation process and optional components which can be installed in each environment,
either on a single workstation or on a network (online upgrade).
The configuration section provides an overview of using Citect SCADA in a Local Area
Network (LAN), a Wide Area Network (WAN), and as a Web Server.
It includes information on the following aspects of installing Citect SCADA:
l Upgrading
l Installation Description
l Installation Requirements
l Installation
l Configuration
Maintaining System Currency

After you have completed the installation and configuration of Citect SCADA and
deployed it as your production system, it is recommended that you keep your software
up to date. Schneider Electric will periodically publish updates in the form of Service
Packs, Hot Fixes or Advisories relating to safety, security and functionality of Citect
SCADA. These updates are available from the Knowledge Base page of the “MyCitect”
web site or http://www.citect.schneider-electric.com/servicepacks. We especially recom-
mend that you nominate a person in your organization to refer, and subscribe, to the RSS
feeds for Safety and Security, as well as the latest articles on the web site.
9
Chapter 1: Introduction
10
Chapter 2: Upgrading to Citect SCADA 2018
This chapter describes upgrading the product, and new features introduced in Citect
SCADA 2018.
Note: Cross version compatibility is not available for alarms version v7.20 onwards.
When updating the computer with a new product version, backup the existing projects
and uninstall the existing installation. Install the new version and restore projects into
the new version.
Note: The new version you are installing may have a service pack released. The ser-
vice pack may have a fix for the automatic upgrade and may be required to be
installed before restoring the project. Please refer to the service pack documentation.
Before you review this information, check that you have the necessary hardware and soft-
ware required to run this version.
When upgrading to Citect SCADA 2018 you need to consider the following:
l Upgrade Method: Depending on whether your system can afford downtime and loss
of data, choose an upgrade method: Offline or Online.
l Upgrade Path: Upgrade path refers to the number of versions to which you need to
upgrade to get from your current version to Citect SCADA 2018. For upgrading to
intermediate versions specified in the upgrade path (for example, v7.20 or v2016),
refer to the documentation for those versions.
Note: After upgrading to Citect SCADA 2018, you can make use of its Situational
Awareness features. For more information, see Situational Awareness Projects in the
Citect SCADA help.
Note: For instructions related to previous versions of Citect SCADA, such as backing

up a or restoring a project, consult the documentation for that version.
11
New Features
Citect SCADA 2018 includes the following new features or changes in functionality. In
many cases these new features will not impact the installation or initial configuration.
However, some of them may impact your project configuration and functionality. Once
you have installed this version, refer to the online help for information on how to recon-
figure your projects to take advantage of the new features and improved functionality.
Introduced in 2018
The following list of new features introduced in this release is only a brief description.
For more details, and links to using the features in your projects, refer to the "What's
New in Citect SCADA 2018" page in the main Citect SCADA help.
Situational Awareness Starter Project
The Situational Awareness Starter Project can be used to create a Citect SCADA project
that is designed to support abnormal situation management for operators. It provides
accurate information to an operator in a way that can be perceived and acted upon
quickly, without overwhelming their cognitive abilities.
This objective is achieved through:
l A consistent look and feel for graphical content.
l The use of standardized color settings, optimized for perceiving process data and
alarms.
l The inclusion of operational focused library objects.
l Support for runtime updates based on navigational or contextual changes.
l The inclusion of navigation aids and an operator dashboard.
A Situational Awareness project differs from other Citect SCADA template projects as it
uses a "workspace" for each client screen that is comprised of a set of "panes". Each pane
displays a page that can be updated independently at runtime based on navigational or
contextual changes. Contextual updates are managed via a project's equipment hier-
archy, which creates an association between the location of a detected change, and the
type of content each pane is configured to display.
Alarm Management
Citect SCADA 2018 includes the following enhancements to the way operators can man-
age alarms at runtime.
Alarm Cause and Response
12
You can associate cause and response information with an alarm tag. This means you
can describe the circumstances that are likely to cause the alarm, and the appropriate
course of action required to address the alarm. This information can then be presented to
an operator at runtime. To specify cause and response information for an alarm tag, you
need to use the new Alarming > Cause and Response view in the Setup activity.
Alarm Shelving
When you shelve an alarm, it is disabled for a specified period of time, or until a spe-
cified time is reached. This allows an operator to temporarily disable alarms that are
causing an unnecessary distraction. Shelving is available via the Workspace’s Alarm
Tab in the Information Zone.
If your project uses the StruxureWare or Tab Style templates (accessible via a starter pro-
ject), you can shelve alarms during runtime from the Active Alarms and Alarm Sum-
mary page. You can also shelve alarms by setting the EndTime argument for some
Cicode functions:
Alarm Indicators
Citect SCADA 2018 allows you to use alarm indicators. Consisting of an alarm border
and flag that appear around the extent of an object group or Genie, an alarm indicator
provides a prominent visual indication of alarm occurrences at runtime.
Alarm Priority Display Properties
You can configure optional display properties for an alarm priority that allow you to:
l Specify a name for a priority value to provide a meaningful representation of its pur-
pose.
l Define background and foreground colors that support a visual representation of pri-
ority on a graphics page.
l Define a Large and Small genie to visually represent the priority on the Alarm Indic-
ator and Alarm Lists.
These additional properties are configured in the Setup activity.
Graphics Enhancements
Citect SCADA 2018 includes the following enhancements to Graphics and the Graphics
Builder.
Name a Graphic Object
You can now name graphics objects (for example, a Polyline, Rectangle, Text and Genie).
Use this name to reference a graphics object via expressions and Cicode at runtime. Con-
figure the animation name when defining the general access properties of a graphics
object.
Animated Polygon Vertices
13
You can now associate a tag or Cicode expression with the vertices in a polygon. This
means the shape of a polygon can be manipulated at runtime in response to values gen-
erated by a production system.
This is achieved by applying offset values to each vertex that define a path along which
the vertex can move. As the return value for an expression changes, a vertex will move
along the path defined for it, altering the shape of the polygon.
Pinned Windows
Windows can now be "pinned" at specified locations within a main window or within
other pinned windows. A new Cicode function WinNewPinAt() has been added that
when configured opens a new display window at a specified location, relative to the cur-
rent active window, with a selected page displayed. The window can later be removed
with the WinFree() function.
Activate/Deactivate Events
You can now configure events to run when a window is activated or deactivated. This is
useful when using pinned windows on a page. For example, the activate event can be
used to run an event if the user clicks on the pinned window.
Dynamically Display Symbols
You can use the DspSym Cicode function with a Genie to dynamically display content
that is only generated at runtime.
Screen Profiles
Screen profiles specify the physical characteristics of one or more workstation screens
and how these screens are arranged with respect to each other. Screen profiles allow you
to set up multiple displays. If you are running a Situational Awareness project, you can
set up screen profiles for independent or linked contexts. You can create, manage and
configure screen profiles with the Screen Profile Editor, which is displayed below the
Screen Profile table in the Setup.
Equipment References
Citect SCADA 2018 allows you to link a piece of equipment to items or tags belonging to
another piece of equipment in your project. This means you can establish a relationship
with equipment or equipment.items outside the equipment hierarchy. With equipment
reference browse functions, you can then track, group and display information for the
equipment and referenced equipment in one interface at runtime.
Equipment references enable you to configure interlocks that link two pieces of equip-
ment so when a condition or other event occurs in one, it will trigger an action in the
other. For example, if a pump is pumping water through a valve and the valve is closed,
the pump should be turned off in order to prevent equipment damage.
14
Composite Genies
Citect SCADA 2018 provides several Composite Genies for use on graphics pages. A
Composite Genie is a collection of individual Genies assembled to form a single object
based on parameters/options chosen by the engineer. The individual objects and their
parameters/options are defined in an XML template file along with layouts for the col-
lection, that is, the Composite Genie.
You can insert multiple instances of the composite object on to a graphics page, and spe-
cify different parameter settings including values, alignment and display options for
each instance to tailor the Composite Genie to suit your requirements.
Display Name for Equipment
Equipment definitions now support a Display Name property. This allows you to specify
a meaningful name that can identify a piece of equipment at runtime. The Display Name
can also be used to reference equipment in a Genie.
Arrays Functions
Citect SCADA 2018 now includes a set of functions that allow you to create arrays that
use up to three dimensions (x,y,z). This can offer performance benefits when handling
large amounts of data, for example, when generating an alarms list.
Upgrade Method
Before you plan to upgrade to Citect SCADA 2018, consider whether your
SCADA system can afford downtime and whether all of your historical information
needs to be available at all times. The upgrade method you choose will depend upon
this.
Upgrade methods are of the following types:
l Offline: This method requires your system to be shut down for the duration of the
upgrade. If your system can afford downtime and depending on whether all of your
historical information needs to be available at all times, this method is suitable for
you. This is the basic upgrade process that will be required even if you use the online
upgrade method.
l Online: If you need your system to be available at all times, this method is suitable
for you. To be able to conduct an online upgrade, you need to have at least one pair
of redundant servers (for details and other pre-requisites, see Pre-requisites for an
Online Upgrade.)
15
Upgrade Path
Upgrade path refers to the number of versions to which you need to upgrade to get from
your current version to Citect SCADA 2018. Historically, some versions of Citect SCADA
have included substantial changes to the product, which required incremental upgrades
involving several intermediate steps between very distant versions (for example, 5.21 to
7.20). We have improved the upgrade code so that fewer steps are necessary to go from
5.21 to Citect SCADA 2018, and the number of necessary steps will depend on whether
you do an offline or online upgrade.
If you plan to perform an offline upgrade, you can upgrade your project from as early a
version as 5.21, directly into Citect SCADA 2018.
If you plan to perform an online upgrade, you need to follow an upgrade path that will
depend on your starting version:
l Prior to v7.20 - If your starting version is prior to v7.20, upgrade to v7.20
SP5A. Compile and run your project in order to restore and convert your historic
alarm data.
l v7.20 - If this is your starting version, you need to restore your project to SP5A. Com-
pile and run your project in order to restore and convert your historic alarm data.
l v7.40 - If this is your starting version, you need to restore your project to SP2. Com-
pile and run the project in order to restore your data.
l v2015 - If this is your starting version, you need to restore your project to SP1 Patch 6.
Compile and run the project in order to restore your data.
l v2016 - If this is your starting version, you need to restore your project to RTM
version. Compile and run the project in order to restore your data.
Offline Upgrade
Note: This is the basic upgrade process and you will need to perform these steps
even if choose to use the Online Upgrade method.
Offline Upgrade to Citect SCADA 2018 comprises the following steps:
1. Backup your current project and relevant files.

Perform a backup of your project and other relevant files. For the upgrade to complete
smoothly without errors, you need to back up a number of files/folders from your system
other than your project files. The number of files you need to back up depends on your
system configuration. For more information about performing a backup, refer to the Back-
ing Up a Project section in the online help of your current version.
16
The following files need to be backed up:
File Description
This is the main file to back up. For information about backing up a
Project backup (.ctz project, refer to your current version's online help. You need to have
file) the Save sub-directories and Save configuration files options
selected in the Backup dialog.
Citect.ini This file is located in the config folder.
Data directory This file is found on the path [CtEdit]Data
These files contain alarm configuration data as well as runtime data.

ALMSAV.DAT and Their path is defined in the Citect.INI file. The default path is same
ALMINDEXSAVE.DA- as the data directory path.
T (For v7.20)
OR
The Alarm Database is located in the Data directory: [Data]\<Pro-
Alarm Database (for ject Name>\<ClusterName.AlarmServerName>. For each
v7.40 and v2015) alarm server you have in your system, a corresponding Alarm Data-
base will exist. You need to backup all alarm databases.
The path and names of these files are defined on the trend tag itself,
and created in the Data directory defined in [CtEdit]Data. The files
Trend files: *.HST
will be named after the trend name and number of files. For
and *.00X
example, if the trend name is CPU, file names will be CPU.HST,
CPU.001, CPU.002 and so on.
These files contain the code that is executed on your reports, and
Report Files
are located in the [CtEdit]User\<Project Name> folder.
Citect SCADA includes a number of ActiveX controls, which will be avail-

able with the 2018 installation, but need to take a back up of your cus-
tom ActiveX controls.
Check your ActiveX.dbf file in the [CtEdit]User\<Project Name>
Custom ActiveX Con- folder. This file contains a list of the ActiveX controls in your project
trols (.OCX) and their GUID. Using the GUID, find the path of an ActiveX control
using the Windows Registry key KEY_LOCAL_
MACHINE\SOFTWARE\Classes\CLSID\"GUID"\InProcServer32\. The
default value for this key is a path to the .DLL or .OCX file you need to
back up.
Backup the main <Project Folder>\Analyst Views and <Project Folder-
Process Analyst files
>\Dictionary folders.
These files contain any logging (alarm logs, report logs) you have
Device logs configured in your project. You will find their location in the Devices
dialog. Refer to your online help for more information.
Check your Citect.ini file or use the Setup Editor | Paths section
Additional Files
as it could contain runtime files used by custom code in the project.
Driver Hotfixes If you are aware of any driver hotfix in your system, backup this
17
File Description
driver DLL which is located in the Bin directory where Citect SCADA

is installed.
Note: The fixes contained in this hotfix may have been included in

the drivers which ship with Citect SCADA 2018.
2. Upgrade your licenses

In order to do this, you will either need to have a valid support agreement or you will
need to purchase a license upgrade. Upgrade your key or soft license using our online
license generator. You can also check the support status at the same URL.
If your license is out of support, contact your Schneider Electric account manager. If you
are not sure who your account manager is, send an email to scada.orders@schneider-elec-
tric.com with your license and site ID details. For more information about licensing in
Citect SCADA 2018, refer to Licensing.
3. Uninstall your current SCADA version and install the next version defined on your
upgrade path
If you need new hardware or need to upgrade to a new operating system to run Citect
SCADA, this step is not required. Otherwise, uninstall the current version of Citect
SCADA completely and install the next version specified in your upgrade path.
If your current version is v7.20 or higher, proceed to step 13.
4. Restore your project

Restore your project.
5. Upgrade your project

As a default, when you restore your project from a previous version, Citect SCADA will
force an update, and you will get a warning message. Click Yes to proceed with project
upgrade.
If this message is not displayed, you can force an update of all projects by setting the
[CtEdit]Upgrade INI parameter to 1 and restarting Citect SCADA. Once you restart, you
will get a warning message. After clicking Yes all projects will be upgraded.
6. Migrate your project

The automatic project upgrade does not fully upgrade your projects, and needs to be fol-
lowed by the Migration tool. The Migration tool is a separate application that run auto-
matically after the project upgrade has been executed, and adds computers from the
existing topology. You may need to run the Migration tool separately for other com-
ponents. Refer to the online help for more information about running the Migration tool.
18
7. Merge your .INI file

If you have defined the following parameters in your Citect.INI file, merge them into the
new version's INI file.
Parameter Description
Without this parameter, you will

[General] encounter the 'Tag not defined' compiler
error. Setting this to 1 allows you to
TagStartDigit=1 define tag names that begin with a num-
ber or a symbol.
Without this parameter, you could

encounter the 'Bad Raw Data' or other tag
address related errors. Setting this to 0
[General]
allows defining variable tags of the same
data type in odd or even addresses. When
CheckAddressBoundary=0
this parameter is set to 1 all variable tags
from the same data type need to be defined
on odd OR even addresses.
Without this parameter, compile will fail in a
[General]
multi-cluster system. Setting this para-
meter to 1 will enable tag/tag reference rep-
ClusterReplication=1
lication in a multi-cluster system.
[CtDraw.RSC] This allows you to open popup pages

ListSystemPage=1 from Graphics Builder.
[CtDraw.RSC]
This allows you to edit super genie pages
from Graphics Builder.
AllowEditSuperGeniePage=1
This allows you to set the maximum number

of .DBF files that can be open sim-
[CtEdit] ultaneously. Allowable values are between
DbFiles=100 50 to 32767 with the default set to 100.
Increase the value of this parameter for lar-
ger projects.
Merge any driver parameters from you old .INI file as they will most likely be necessary
to interface with your I/O network. For a list of changes to .INI parameters, refer to
Citect.INI Parameters in Version 2018.
8. Compile your project

After upgrading your project and running the Migration tool, compile your project to
ascertain that runtime functionality works as expected. It is very likely that you may
encounter errors when you compile your project. One of the most common sources of
errors when upgrading is Cicode functions. This is because functions may have
changed, deprecated or simply because the compiler code has been updated to prevent
runtime errors. You can find a list of updates to Cicode functions here.
19
Refer to your online help for instructions on compiling your project.
9. Run the Setup Wizard

Before running your project, run the Setup Wizard (known as Computer Setup Wizard in
previous versions) to configure the Runtime Manager and other settings that are relevant
to the runtime process. The Setup Wizard will automatically determine the role of your
computer based on the network addresses defined in your project. After finishing the
Setup Wizard, restore your historic data and other files, and run your project.
10. Restore runtime files

After compiling your project, place the files necessary for runtime in the correct dir-
ectories. Refer to point 1 in this topic for the list of files you need to place in the cor-
responding directories as defined in your Citect.INI file and project configuration.
11. Restore historical data files

Restore the historical data files before running your upgraded projects.
Alarms (v7.20 and earlier)
Before you can upgrade to Citect SCADA2018, perform the following steps to convert
your <Project Name>_<Cluster Name>_ALMSAV.DAT and <Project Name>_<Cluster
Name>_ALMINDEXSAVE.DAT files to a format that can be ready by the new alarm
server architecture introduced in v7.30:
1. Make sure that the [Alarm]SavePrimary parameter points to the directory in which
you have placed your backed-up ALMSAV.DAT and ALMINDEXSAVE.DAT.
Alarms (v7.40 and v2015)
Convert your Alarm Database in the Data directory with the following steps:
1. Make sure to place your backed-up Alarm Database in the directory defined by the
[CtEdit]Data parameter.
2. Before starting runtime, confirm that the directory [Alarm]SavePrimary does NOT con-
tain ANY ALMSAV.DAT nor ALMINDEXSAVE.DAT files.
Trends
Follow these steps to convert the files:

1. Create the same file hierarchy on the new system.
2. Place the files in the same folders.
3. If you want to change the folder location or you cannot replicate the same file hier-
archy, edit the trend tag definitions to match the new file paths.
Note: If you are changing the trend tag name, use the trend renaming tool available at the Support Site.
20
12. Run your project

Run your project to check that the functionality works as intended:
l Check any Cicode that you needed to modify in order to compile your project.
l Test communications to your I/O devices, alarm triggering and trend capture.
13. Install Citect SCADA2018

After you have completed all the steps in your upgrade path, install Citect SCADA 2018.
Refer to the Citect SCADA 2018 Installation Guide for more information.
Migrating to Production
Review the following information to complete your Offline Upgrade process, and apply
the changes to your production system.
Testing Considerations
After the upgrade and configuration changes to the project are complete, it is recom-
mended to perform system testing of the new project version. This is to check that func-
tionally and operation behaves as expected before applying the new project to the
production environment.
Licensing
When changing to use a newer product version, the hardware/software key may need to
be updated. To prepare the system, it is recommended to update the production machine
keys before the project is updated on the production machines as the updated key will
still license the previous version.
Prepare Configuration [INI] Files
Before beginning any changes to the production computers, it is recommended that you
backup the configuration [INI] files for each machine as they may be required for ref-
erence.
The current configuration file can be used with the new product version after the path
parameters have been updated to the new version file locations. Refer to the setup of the
development environment section of the specific version for further parameter inform-
ation.
The Setup Editor and Setup Wizard can be used to finalize the configuration of the com-
puter setup.
Server Addresses
21
During a migration with an existing system, it may be useful to use a new set of IP
addresses and computer names for the new version. This is typically done when there is
a need to provide isolation between the system project versions to allow the two systems
to individually co-exist on the network for a period of time.When isolated, the systems
will be independent and not cross communicate or synchronize between the existing and
new versions. This type of upgrade would have the new version start with a snapshot of
the historical data from the previous system and then run in parallel.
Communication Drivers
The project may be using specialty drivers and if so, it is recommended to backup the
driver files located in the product ‘bin’ directory. Existing specialty drivers that are used
may be required to be installed for the new version. The driver web can be checked for
availability and compatibility with the new version at the DriverWeb.
Specialty Software
The project may be using specialty software to provide certain system functionality.
These applications may be required to be updated or re-installed during the upgrade pro-
cess and considered in the context of the upgrade.
Format File
The project may be using custom configuration forms in the product. This configuration
is located in the FRM file which may be required in the new installation. For further
information please see KB1579.
Trend and Alarm Data
A project upgrade may also require the trend and alarm data to be updated based on the
new product features. It is recommended to keep a backup of the existing production
trend data files and the alarm save data file from the original
Once the data files have been upgraded, the updated data files may not be compatible
with the previous version.
It is not recommended to change the directory path of the trend data files during the pro-
ject upgrade as this may affect the trend operation. The default data directory may be
changed between product versions and may need to be considered in the context of the
install and upgrade with regards to the trend file location.
Licensing
When changing to use a newer product version, the hardware/software key may need to
be updated. The hardware key is a physical key that plugs into either the parallel port or
USB port of your computer. The key update utility can be run from the Help menu of the
product Explorer application. To upgrade the key a new authorization code is required
which can be created by using the AuthCode Generator.
22
Troubleshooting Offline Upgrade

This section lists common issues you might encounter during your Offline Upgrade,
which may be compiling errors or any other pre-runtime issues.
Not able to upgrade license key
1. Make sure you have correctly installed the latest versions of CiUSafe and Sentinel
Driver.
2. Make sure the Authorization code matches the Key you are trying to upgrade. If you
still cannot upgrade your license, please check KB article Q3672 for more information
on the error codes.
Compiler errors and warnings not related to deprecated functions
As Citect SCADA evolves, the compiler feature becomes stricter in order to ensure project
quality and runtime success. The fact that you are getting compiling errors that were not
appearing before is because of stricter compilation, which will result in more predictable
and stable runtime. Refer to the error code in the error message to resolve any errors and
warnings. You can search the online help using the error code for more information
about a specific error code.
Online Upgrade
An online upgrade takes advantage of Citect SCADA's native server redundancy to min-
imize or avoid loss of data or downtime on your production system, allowing for one
server to take ownership while the other is being upgraded. An online upgrade is the
only way to avoid loss of data where you perform an upgrade in parallel. This is the pro-
cess in which the two SCADA systems (the old version and the newer one) are running
side-by-side. The old version is decommissioned after the new version has been fully
tested and validated.
Similar to the offline upgrade, you will need to follow the upgrade path, and repeat the
process as many times as the number of steps in your upgrade path.
Refer to the relevant section depending upon your current version of Citect SCADA.
l Upgrading from v7.20
l Upgrading from v7.40
l Upgrading from v2015
23
Pre-requisites for Online Upgrade

As mentioned earlier, an online upgrade will allow you to avoid downtime and loss of
data. It is important that you take into consideration the complexity and size of your pro-
ject when planning for this upgrade. It is recommended that you review the following
pre-requisites before you start an online upgrade:
1. At least one pair of redundant servers: This is to upgrade one server at the time
while the redundant server assumes primary operation, avoiding downtime and loss
of data.
2. Upgraded project: Check that your project runs and works properly on Citect SCADA
2018 before migrating to production and starting the online upgrade. If your project is
complex or if you are upgrading from a version earlier than v7.20 SP5A, it is recom-
mended that you have a test environment as the offline upgrade could be complex
and could involve a long server downtime if done on your production system.
3. Restore runtime files: Check that you have restored the necessary files for runtime
onto the appropriate directories to avoid any disturbances on the upgraded live sys-
tem.
4. Capture data files: To allow historic data to be restored into the new version, you
need to assess and move data files to the required location during the upgrade pro-
cess. This is described in detail in the online upgrade steps in the relevant sections.
5. Configure your running system for Online upgrade: To allow this process to be as
smooth as possible, we recommend leveraging of your current redundant system and
adding the following Citect.INI parameters before the online upgrade:
l [LAN] EarliestLegacyVersion: Use 7200 for upgrade from v7.20, 7400 for upgrade
from v7.40 and 7500 for upgrade from v2015. This will allow your upgraded serv-
ers to accept connections from the older version
l [Alarm]EnableStateLogging: Set this parameter to 1 to allow logging the alarm
synchronization messages into the syslog.
l [Alarm.<ClusterName>.<AlarmServerName>]ArchiveAfter: This parameter is spe-
cific for an upgrade to v2015. If this parameter is not set to Citect 2015, the alarm
server will not start up. This is configured for each Alarm Server instance. When
configuring this parameter you need to decide what time period of data you wish
to maintain during upgrade. For example, if you set this parameter to 1 week, it
means that during the upgrade process you will lose any summary data that is
older than 1 week. If you don’t want to lose any data, you need to set this para-
meter to the earliest data in your summary (v7.20) or SOE (v7.30 and v7.40)
l [Debug] Kernel = 1 (optional): Enable this to allow for monitoring the kernel dur-
ing the upgrade.
24
Upgrading from v7.20

When upgrading from v7.20, you will NOT need to restore the alarm data files
(ALARMSAV.DAT and ALRMSAVEINDEX.DAT) under most circumstances. Citect
SCADA 2018 is equipped to read this information from the redundant v7.20 (SP5A or
greater) server that is still not upgraded.
To upgrade from v7:20:
1. Add the following parameter on the .INI file to all your server nodes before you start
the online upgrade.
[LAN]EarliestLegacyVersion = 7200.
Restart the servers after adding the parameter for the changes to take effect.
2. Shutdown SCADA runtime on the primary server.
3. Upgrade Citect on this server according to the offline upgrade procedure.
4. Restart the primary server. It is now upgraded.
5. Now, the Citect SCADA 2018 server will build the new alarm database, and will
import the historic data from the Standby v7.20 server.
6. Check the status of the alarm server synchronization using the Alarm Server Kernel,
on the Main Window:
l W hen the Alarm Servers synchronization starts you should see the following mes-
sage:
Alarm: Peer update request sent.
l Then you should see a number of messages with Update packets (number is depend-
ent on your Alarm historic events and configuration).
Alarm: Update packet XXXX received.
l Finally, the following messages will indicate that the synchronization has been final-
ized successfully:
Alarm: Database objects state synchronization completed.
Alarm: Database is initialized, preparing to Start the Alarm Engine.
Alarm: Starting Alarm Engine
Alarm: Server startup complete.
7. If you find that your Alarm Server synchronization is not completing successfully,
place the ALARMSAV.DAT and ALRMSAVEINDEX.DAT on the
[Alarm]SavePrimary directory.
8. Upgrade your client nodes one by one.
9. Once you are confident that synchronization of alarms, trends etc., is complete, and
that your v2018 clients are working correctly, shutdown runtime on the Standby
server.
10. Upgrade Citect SCADA on this server according to the offline upgrade procedure.
11. Restart the standby server. It is now upgraded.
25
12. Once the standby server is running fine, check for hardware alarms when it is con-
nected to the primary server.
13. Check functionality of the system as a whole.
14. Finally, test redundancy by switching off the primary server and checking that the
standby server takes over and clients switch over.
Special Considerations
Custom Alarm Filtering
The AlarmSetQuery Cicode function was deprecated in v7.30. This means that if you are
using custom alarm filtering code, you will most likely need to convert it. Click here for
more information about this process.
Historical Alarm Events
Set the [Alarm.<Cluster Name>.<Server Name>]ArchiveAfter .INI parameter to a date

prior to the earliest historical event date from which you want to migrate.
Alarm server synchronization during online upgrade
In the event that there is a disconnection or timeout during synchronization between the
v2018 and v7.20 alarm servers, follow these steps:
1. Shutdown your 2018 server.
2. Delete the alarm database and re-start it.
3. Wait for the synchronization between servers to finish.
Also, you can increase the timeout using the [Alarm]StartTimeout .INI parameter. This
will allow the v2018 server to wait for connection from the v7.20 server.
If you find that the synchronization between the two servers is experiencing inter-
ruptions, delete the alarm database, and place your ALARMSAV.DAT and
ALARMSAVINDEX.DAT in the [Alarm]SavePrimary directory and the v2018 server will
convert the data. However, we recommend always trying the peer synchronization first.
Changes during the upgrade process
Because of the differences between Citect SCADA2018 and v7.20, any actions that hap-
pen during the online upgrade process are subject to incompatibilities that are not recon-
cilable between versions. However, the scenarios are quite particular and should not
have a great impact if any, on your SCADA system. Here is a list of such scenarios:
l UserLocation field: In Citect SCADA2018, a record of the UserLocation, that is the
IP address, for alarm operations such as acknowledge is available. If an acknowledge
occurs on the v7.20 server during the upgrade, the v2018 server will be unable to
record the UserLocation, which will be displayed as "0.0.0.0".
26
l Summary Comments during the upgrade: Comments that you add to an alarm sum-
mary record on the v7.20 server during the online upgrade will not be available in
the upgraded version.
Upgrading from v7.40

To upgrade from v7:40:
1. Check that you have added the following parameters on the .INI file to all your server
nodes before you start the online upgrade.
2. Shutdown SCADA runtime on the primary server
4. Place the backed-up Alarm database in the [CtEdit]Data directory. This will allow a
quicker synchronization of alarm servers.
5. Restart the primary server, which is now upgraded.
6. Citect SCADA2018 server will synchronize its alarm database with the running v7.40
server.
Wait for the synchronization process to finish; this will depend upon the size of
your alarm database. The synchronization information is available from the main
kernel window of the Alarm Process as well as the syslog.
7. Upgrade your client nodes one by one. When the newly upgraded v2018 server
assumes the primary server role it will migrate the entire alarm database to the new
format, and you should now be able to see Alarm Summary data on all migrated Cli-
ents.
8. Shutdown runtime on the standby server.
9. Upgrade Citect SCADA on the standby server according to the offline upgrade pro-
cedure.
10. Restart the standby server, which is now upgraded.
12. Test redundancy by switching off the primary server and assuring standby takes over
and Clients switch over.
Alarm Summary
The v2018 Summary feature will be disabled when connecting to a v7.40 server. You
may still see summary records for active alarms.
Alarm Save Files
27
When doing an online upgrade from v7.40 to v2018 check that any pre-7.20 Alarm Save
files are removed from the v2018 project folders (e.g. <project_cluster>_ALMSAVE.DAT
and <project_cluster>_ALMINDEXSAVE.DAT).
Historical Alarm Events
Set the [Alarm.<Cluster Name>.<Server Name>]ArchiveAfter .INI parameter to a date

prior to the earliest historical event date from which you want to migrate.
Upgrading from v2015

To upgrade from v2015:
1. Check that you have SP1, Patch 6 or later installed. For instructions on upgrading to
this version, refer to the v2015 documentation.
7. Citect SCADA 2018 server will synchronize its alarm database with the running
v2015 server. You need to wait for the synchronization process to finish, and this will
depend on the size of your alarm database. The synchronization information is avail-
able from the main kernel window of the Alarm Process as well as the syslog.
10. When the newly upgraded v2018 server assumes the primary server role it will
migrate the entire alarm database to the new format, and you should now be able to
see Alarm Summary data on all migrated Clients.
28
Alarm Save Files
When doing an online upgrade from v7.50 to v2018 check that any pre-7.20 Alarm Save
files are removed from the v2018 project folders (e.g. <project_cluster>_ALMSAVE.DAT
and <project_cluster>_ALMINDEXSAVE.DAT).
Upgrading from v2016

To upgrade from v2016:
1. Check that you have the RTM version installed. For instructions on upgrading to this
version, refer to the v2016 documentation.
7. Citect SCADA v2018 server will synchronize its alarm database with the running
v2016 server. You need to wait for the synchronization process to finish, and this will
depend on the size of your alarm database. The synchronization information is avail-
able from the main kernel window of the Alarm Process as well as the syslog.
10. When the newly upgraded v2018 server assumes the primary server role it will
migrate the entire alarm database to the new format, and you should now be able to
see Alarm Summary data on all migrated Clients.
Troubleshooting Online Upgrade

This section lists common issues you might encounter during your Online Upgrade,
which may be related to runtime issues and redundancy connectivity.
29
Redundant servers do not communicate
I cannot make my redundant servers communicate and I keep getting the hardware
alarm “Redundant Server not found”.
1. Check that you have set your [LAN]EarliestLegacyVersion parameter correctly.
l If upgrading from v7.20 use [LAN]EarliestLegacyVersion=7200.
l If upgrading v2015 use [LAN]EarliestLegacyVersion=7500.
l Check that you have run the Setup Wizard and set both servers to Networked mode.
2. Set the same server password on both servers in the Setup Wizard.
My system is performing slowly even though Hardware and software requirements are met
Check your system’s power options: Control Panel | All Control Panel Items | Power
Options.
Remove Upgrade related parameters
After finalizing the upgrade process and confirming that runtime is fully functional, we
recommend removing or updating the following .INI parameters. You will need to restart
the servers after changing the parameters for the changes to take effect.
30
l [Alarm]SavePrimary: remove this parameter.

l [Alarm]SaveStandby: remove this parameter.
l [Debug]Kernel = 0: this is to enhance security and keep operators out of the kernel.
l [LAN]EarliestLegacyVersion: remove this parameter.
It is important to note that after removing the EarliestLegacyVersion parameter, the next
time you change your user’s passwords, you should change all the passwords on one
server, and then roll out the updated project in the same order in which you conducted
the online upgrade (primary server, clients and then standby server). Refer to KB article
Q7865 for more information.
Migration Tool
The automatic update that occurs when you initially launch Citect SCADA 2018 does
not fully upgrade your projects, and needs to be followed by the use of the Migration
Tool (if migrating from v7.x this is particularly noteworthy). The automatic update is a
passive action which updates the database field definition for any database that has
been changed between the two versions and copies new files that are necessary in 2018.
The Migration Tool is a separate application which has to be run manually after the
automatic upgrade has been executed. It can be initiated after you have prepared the pro-
ject for final migration. This tool will accommodate the changes in project functionality
that are incorporated in 7.0 and 2018.
Note: Some of the features introduced in 2018 of Citect SCADA require changes in
the project data from version 6.x
UPGRADE ALTERS COMMUNICATIONS CONFIGURATIONS
After upgrading, confirm and adjust the configuration of I/O devices in your project.
age.
Using the Migration Tool
Note: Before you use the Migration Tool, is recommended that you familiarize
31
yourself with the process that it performs, and the preparatory steps that you need to
carry out with your existing projects.
To run the Migration Tool:

1. Backup the projects that you need to migrate.
2. Navigate to the Project activity in Citect Studio, select Home | Migration Tool to dis-
play the Migration Tool dialog.
3. Either accept the project displayed in the edit box, or browse for the project that you
wish to upgrade.
4. Specify the changes you would like to implement during the migration process by
selecting from the options described in the following table.
Option Description
Select this check box if you wish to delete these types of devices after suc-
cessful migration (see Remove Obsolete Memory and Alarm Devices).
Remove
obsolete
Note: Do not select this check box when you run the tool for the first time on a
Memory
project that contains any included projects which are shared with more than
and Alarm
one master project. If you want to delete obsolete devices under these cir-
devices
cumstances, you can run the tool a second time using this option if the migra-
tion is successful after it is run the first time.
Use this option to append information about the migration process to the exist-
Append to
ing Migration Tool log file (located in Citect SCADA's User directory). If this
existing
option is not selected, a new log file will be created when migration is com-
log file
plete.
Create
roles from
User Select this option if you wish to migrate the users database from an existing
security project (see Creation of Roles).
inform-
ation
Copy XP_
Select this option to convert legacy menu entries to the format necessary for
Style
the new menu configuration system. By default, this option is unchecked to
menu into
avoid potential compile errors that may occur if the legacy menu.dbf contains
Tab_Style
functions which have been removed.
menu
Migrate
Select this option to migrate the included projects associated with the selected
included
project (see Migrate Included Projects).
projects
Migrate Select this option if you have an existing database that you want to migrate
equip- into this version. When upgrading from an earlier version, and the "PARENT"
ment data- field of the equipment table was used, you should select this check box. Other-
base wise existing data from the PARENT field will be ignored. If runtime browsing
is used, the PARENT field will return the equipment parent (the substring of
32
Option Description
the equipment name without the last '.' and anything after that).
To retrieve information that was stored in the previous "PARENT" field the
"COMPOSITE" field should be used.
Select this option if you want to migrate devices that currently use the ABCLX
driver to the OPCLX driver. Select the Configure button to indicate which I/O
Migrate
devices you would like to migrate.
ABCLX to
OPCLX
Note: You should confirm that the OPCLX driver is installed before you use
this option.
If you select this option, the storage method will be set to scaled (2-byte
Migrate
samples) for all trends that have no storage method defined. Use this option to
Trend/SP-
stop the compiler error message "The Storage Method is not defined". In pre-
C storage
vious versions, a blank storage method would default to scaled. However, this
method
is no longer supported, resulting in the compile error message.
Create
com-
If you select this option, computers will be created from the servers and net-
puters
work addresses that you have configured for a project and its include pro-
from Net-
jects. This option distinguishes whether a computer has multiple IP
work
addresses.
Addresse-
s
Note: If 'Copy XP Syle menu into Tab_Style Menu' and 'Migrate Included Projects'
are both selected when the migration tool runs, the following message will be dis-
played: "Copying menus of included projects may lead to conflicts. Any conflicts
will need to be manually corrected". To avoid this from occurring, it is recom-
mended you run the migration tool twice. In the first instance just select the
option 'Copy XP_Style menu into Tab_Style Menu', and in the second instance
just select the option 'Migrate Included Projects'.
5. Click Migrate to begin the migration process.

A progress dialog will display indicating the stage of the conversion and the name
of the project being migrated. If you wish to cancel the migration at this point click
the Abort button.
Note: Aborting a migration will stop the migration process, and any changes
already completed will not be rolled back. You will have to restore your project
from the backup created in the first step.
33
When the migration process is concluded, a confirmation dialog box will display
indicating the number of variables converted and the number of I/O devices
deleted (if device deletion was selected at the start of migration).
6. Click the Close button to close the dialog.
Remove Obsolete Memory and Alarm Devices

When you use Citect SCADA's Migration Tool, the Remove obsolete Memory and
Alarm devices option adjusts the following:
Memory tags to local variables: tags that are on an I/O device that are configured to use
a 'memory' port.
Note: If there are real I/O devices in your project that have been set to use a 'memory'
port during testing, these can be changed before running the migration tool to avoid
those tags getting adjusted.
Alarm devices: can remove I/O devices that have a protocol set to 'Alarm', which was
needed in earlier versions to enable alarm properties as tags. In version 7.x, the alarm
properties are enabled via a setting on the alarm server configuration form.
Memory Devices
In previous versions of Citect SCADA an I/O Device could be defined as a memory
device by setting the port value to "Memory". This was generally done for one of the fol-
lowing purposes:
l To provide for future devices that were not currently connected to the system, but
their points needed to be configured at this stage of project.
l For virtual devices where there was no corresponding physical I/O Device and you
needed data storage with the entire functionality normally associated with I/O vari-
ables such as alarms.
l To act as a variable which was local to the process being used in place of Cicode
global variables.
You can still use I/O Devices for future or virtual devices in version 7.0, but manually
set the Port parameter to an unused value other than Memory, and set the Memory prop-
erty of the device to True to indicate that it is an offline in-memory device before running
the Migration Tool.
You need to review your project to identify which memory I/O Devices are local variable
holders and which ones need to be changed to non-memory so that the Migration tool
does not convert their variables.
The Migration Tool will set any I/O Device's port which is identified as a Memory
device to the new Local Variable, and the original device record will be deleted.
34
Alarm Devices
In previous versions of Citect SCADA Alarm devices were defined as devices with their
Protocol property set to "Alarm". In version 7.0 the function of configuring such a device
is now replaced by setting the Publish Alarm Properties property to True on the Alarm
Server.
Alarm devices with their Protocol property set to "Alarm" will be deleted from I/O
Devices table by the Migration Tool.
The Migration tool can delete memory and alarm device records. If you want to delete
the devices at a later time, deselect the "Remove obsolete Memory and Alarm Devices"
option.
Note: Alarm devices with their Protocol property set to "Alarm" are no longer used
and will be removed by the Migration Tool. All Alarm Servers will now publish
Alarm Properties.
Converting Memory Variables

A memory variable is a variable with its I/O Device Port property set to either "Memory"
or "MEM_PLC".
If there are multiple I/O Devices with the same name, possibly on different I/O Servers,
the device would not be considered as a memory device regardless of its port value. In
other words the Migration tool will not process the variables for memory devices with
duplicate names.
Inserting New Local Variables

When the Migration Tool runs, a local variable record will be inserted for each identified
memory variable, and the variable data will be copied into the new local variable.
Local variables have fewer fields than variables; the following table shows the mapping
from variable to local variable when copying their data.
Variable Tag Parameter or Constant Value Local Variable Parameter
Variable Tag name Name
Data Type Date Type
(Empty) Array Size
Eng. Zero Scale Zero Scale
35
Variable Tag Parameter or Constant Value Local Variable Parameter
Eng. Full Scale Full Scale
Comment Comment
With the exception of the Array Size, which has been introduced in version 7.0 exclus-
ively for local variables, every field receives its value from the same or similar field.
Deleting Variable Tags

Once the Migration Tool has created the local variable records it will insert those vari-
able tag records that have been converted in the previous step, and delete the original
variable tag.
If an error is detected during the insertion of the local variables, the deletion of the vari-
able tags will not be performed. If this occurs it is possible to have two records with
same name and data, one in the local variable (the newly inserted record) and one in the
variable tags (the original record that has not been deleted). You need to delete either of
the variables manually, or restore the backed up project after removing the cause of the
error then run the Migration Tool again.
Deleting Obsolete I/O Devices

Deleting obsolete I/O Devices is an optional step in the Migration Tool and will be per-
formed after the memory variables are converted. If the delete option is chosen, obsolete
Memory devices and Alarm devices will be deleted as the final step of the Migration
Tool operation.
Creation of Roles for Existing Users

When upgrading an existing project using the migration tool, a new role will be created
(if needed) for every existing user. The new role will have the same security settings that
were defined for that user and be given a generic name such as Role_1, Role_2 etc. Dur-
ing the upgrade process, if a role exists with the same security settings as the user, then
the existing role will be assigned to the user being upgraded. For example; If Role_1
exists and matches the security settings of the upgraded user then that user will be
assigned Role_1 also.
If you do not want to migrate users from an existing project clear the option Create
Roles from User security information from the migration tool dialog before running it.
36
Migrate Included Projects

Each project may contain multiple included projects. Additionally any included project
may contain its own included project so creating a cascading project.
The Migration Tool needs to process the original project and included projects in a single
step. The reason for this is that variables can be defined in one project that refer to I/O
Devices defined in another included project.
The Migration Tool performs this procedure sequentially on the "master" project then
each included project.
In the case where two master projects share the same project as an included project, you
should not select the "Remove obsolete Memory and Alarm devices" check box when
you process a project that contains shared included projects. This is because the removal
is performed at the conclusion of the migration process on each master and included pro-
jects sequentially. This could cause the deletion of an I/O Device in the first master pro-
ject which is referenced by a tag in a shared included project which is processed in a
later step.
If two separate "master" projects contain the same included project, run the Migration
Tool on each "master" project without selecting to delete obsolete devices.
UPGRADE ALTERS COMMUNICATIONS CONFIGURATIONS
After upgrading, confirm and adjust the configuration of all I/O devices in your project.
age.
To remove obsolete devices it is recommended that once the Migration Tool has com-
pleted successfully (without the check box being selected), run it a second time with the
check box selected. This will remove the devices since every tag conversion were com-
pleted in the first pass of the Migration Tool.
Default Scale
The Scale properties in both variable tags and local variables are optional. If a Scale
value is not specified the default value is indicated by a parameter in the Citect.ini file.
The parameter name is "DefaultSliderScale" under the [General] section in the Citect.ini
file. The default values for Scale is 0-32000, unless the default slider scale is true in
which case the default value depends on the type, for example, Integer, String, or so on.
37
The Migration Tool will read this parameter and if it is not set, or set to false, then it will
explicitly set any empty Scale property to a value in to the range of 0 to 32000. This will
be done even if either of the Zero Scale or Full Scale parameters has a value, in which
case the empty Scale parameter will receive the default value.
If the DefaultSliderScale in the Citect.ini file set to True, the Scale parameters will not be
populated with a default value if they are empty, rather they will be interpreted at
runtime.
38
Chapter 3: Installation Description
Before you begin the installation of Citect SCADA, you need to first decide which com-
ponents you want to install. This is determined by the functionality you want the install-
ation to support.
After you have decided on the Citect SCADA environment, and any additional stand
alone components that you want to install, refer to Chapter 4 Installation Requirements
so that your hardware and system software meet the requirements for your selected
installation.
Once you have progressed through the preliminary dialogs of the installation interface,
you will be requested to begin selecting the components that you want to install. The
options that the installation interface will present to you are described below.
Task Selection Dialogs
Installation Profiles
The installer provides a set of profiles to help you select the appropriate components for
installation. Depending on the profile that you choose, the next dialog will have default
selections recommended for installation. You may accept the default components, or
select the ones of your choice on the components selection screen which is displayed
after you click Next on the Installation Profiles dialog.
The options are as follows:
Option Description
This option will select the Runtime, Configuration and Development Environment, Drivers and
Sentinel Driver components for installation. It is a "complete" installation which will install a fully
functional Citect SCADA development and server/client system. Such an installation will include the
Citect SCADA development environment, runtime infrastructure files, client, I/O Server, Alarm
Server, Trend Server and Reports Server.
All Core
Com-
This option also allows you to select the Deployment Server and Deployment Client components for
ponents
installation. You can use a deployment server to distribute a project's runtime files to the com-
puters within a Citect SCADA system that have been configured as a deployment client.
Select this option if this is an initial installation of Citect SCADA which will run as a single system,
or act as a server to service a number of client installations.
39
Option Description
If the .NET Framework 4.6.1 installation does not complete, you can install it manually from the
installation file in the Extras folder of the Citect SCADA installation disk, then install Citect SCADA.
Be aware that .NET Framework 4.5.1 requires Windows Imaging Component (available on the Win-
dows Download Center web site) to be installed first.
This option will select Runtime, Sentinel Driver and Communications Drivers for installation. It is an
installation which will install the runtime components for both a Server and Client. Such an install-
Runtime ation will include runtime infrastructure files, Client and I/O Server, Alarm Server, Trend Server
Only Ser- and Reports Server.
ver
Select this option if this is an installation of Citect SCADA which will act as a server to service a num-
ber of client installations.
This option will only select the Runtime system for installation. It is an installation which will install
the runtime components and a Client. Such an installation will include runtime infrastructure files,
but will exclude drivers. Select this option if this is an installation of Citect SCADA which will be
used as a client.
If you wish to upgrade either of the Runtime installations to a full installation, including the Devel-
opment and Configuration environment, insert the original installation media and select "All Core
Components" or "Custom" from the Installation Profiles dialog.
Runtime Note: You can also install the Citect SCADA Runtime Only Client from a single installation file. This
Only Cli- file is named Citect SCADA 7.50.exe and located in the <discmedia>\Citect SCADA 7.50\Ex-
ent tras\Runtime Installer folder of the installation DVD. This allows installation of the software to com-
puters which only require the runtime. The file can be copied to a network location for remote
installation
The single-file installation does not include Communication Drivers, the Sentinel Driver, or the
Microsoft® .NET Framework which is a prerequisite of the runtime. If the .NET Framework is not
already installed on the target computer, you cannot use the single-file installation. In this case,
you may use the full package installer to automatically install the .NET Framework during the install-
ation of Citect SCADA. Alternatively you can install .NET Framework from another source, then
carry out the single file runtime installation.
This option will not select any components for installation; it will allow you to select the core com-
Custom
ponents that you specifically need, or allow you to install add-ons or documentation only.
Documentation Installation
The Product Documentation option will install a comprehensive library of user guides
and references in Adobe Portable Document Format (PDF). These can be accessed from a
master contents HTML page.
It is highly recommended that you install the product documentation for future reference.
40
Add-ons Installation
Once you have selected the components that you want to install, the next dialog allows
you to select any Add-ons that you wish to use in your installed system.
The options are:
l Project DBF Add-in for Excel™
l Web Server for IIS
The Project DBF Add-in for Excel option will install an Add-In for Microsoft™ Excel.
When this Add-In is loaded into Excel, it allows you to browse, open, edit and save
Citect SCADA .dbf files in the correct format. This is only available for selection if
Microsoft Excel 2007 or above is installed on the computer. Otherwise, it is visible but is
deselected and disabled.
The Web Server option will install a Web Server running on Microsoft Internet Inform-
ation Service (IIS). The Web Server performs the server-side functionality of a Web Ser-
vice to the Web Client. As well as facilitating communication, it directs a client to the
graphical and functional content of a Citect SCADA project and the location of the
runtime servers. This information is stored on the Web Server when a Citect SCADA pro-
ject is deployed. A Web Server can contain multiple deployments.
Note: If the Web Server and Citect SCADA runtime server are set up on different
machines, and it is not possible to establish a trust relationship between them, the
two machines need to be on the same domain so that the Web server can access the
directory on the Citect SCADA server that's hosting the web deployment files. If, con-
versely, a trust relationship can be established between the Web Server and the Citect
SCADA server, they can be on different domains as long as the Web server has read
access to the project folder on the Citect SCADA server.
Citect SCADA communicates with control or monitoring I/O Devices that have a com-
munication port or data highway - including PLCs (Programmable Logic Controllers),
loop controllers, bar code readers, scientific analyzers, remote terminal units (RTUs), and
distributed control systems (DCS). This communication takes place with each device
through the implementation of a communications driver. It is recommended that these
drivers are the latest version.
41
The installation process allows you to select individual drivers that you want to install,
specific to your system and its I/O devices. There are certain drivers that the product
installation will install that are necessary for Citect SCADA to function correctly. These
will be installed automatically.
Only install drivers which are identified as being compatible with the computers oper-
ating system. If you select any driver that is not yet identified as being compatible, or is
specifically identified as not compatible, the installation process will provide an alert to
that effect, and will allow you to deselect the driver prior to continuing with the install-
ation.
INCOMPATIBLE DRIVERS
Do not ignore alerts during driver installation. If you choose to ignore such alerts, the driver will be
installed but may operate incorrectly.
age.
The communication driver installation can also be invoked individually at any time
after the product installation to install additional drivers.
42
Chapter 4: Installation Requirements
This chapter describes the requirements for hardware, operating system software and sys-
tem configuration prior to installing Citect SCADA and any of its components.
These requirements will vary subject to the components of Citect SCADA that you
attempt to install on any computer. Refer to chapter 3 Installation Description to determ-
ine the components that you want to install. This chapter identifies the basic hardware
and system software requirements, as well as requirements specific to each particular
component.
Before you begin to install Citect SCADA, it is recommended that you install the latest
updates from Microsoft® for your operating system and system software.
Hardware Requirements
Selecting hardware is dependent upon a number of factors such as:
l The role of the hardware in your SCADA system
l The amount of I/O, alarms, trends and the frequency of change
l Number of clients (for servers)
l Server clustering
l Complexity of the user interface
l Degree of customization
The requirements below have been tested using a simulated SCADA system with 10 cli-
ents connected maintaining a server CPU load of less than 25% and should be used as a
guideline only due to the impact of the factors listed above.
The SCADA system may require more or less powerful hardware.
Hard Disk Drive (HDD) indicates an estimate of the required amount of space to install
the software, store projects and runtime data.
Computer Performance
General PC performance will be affected by the major elements of CPU, RAM, Bus and
HDD speed.
43
It is recommended to look for two things when selecting client and server hardware –
PassMark score and CPU Clock Speed. The required processor is defined according to an
average CPU mark given by PassMark® Software. To check CPU performance, for
example a Core i3 CPU, type "PassMark Core i3" in the search engine of an internet
browser. This will return the CPU's calculated performance as compared to other similar
well-known processors.
In general, the more intense an application, the higher the clock speed to be selected.
This is especially true for clients operating graphically intense or heavily scripted applic-
ations.
In general, it is recommended that computers in the SCADA network should target
between ~25%-%50 CPU in normal state. This allows the system to be responsive, and
handle abnormal situations better.
Client Recommendation
Screen
CPU Cores HDD
RAM Graphics Resolution Network
PassMark® *1 *2
*3
DirectX 9 or later
with WDDM 1.0
2000 2 4 GB 10 GB Driver, 1920 x 1080 100 Mb
128 MB of dedicated
VRAM
1. The complexity of your pages such as the number of graphical animations and
Cicode running in the background will impact your client CPU choice. It is recom-
mended to use a higher performing PC with high clock speed when building complex
user interfaces. As a guidance, the following will require high clock speed to maintain
a Client CPU load of less than 25% on a single core:
a. HD user interface with 50 complex genies
b. UHD4K user interface with 100 complex genies
2. If the Deployment feature is being used, the HDD needs to have the required space for
the number of configured version+2 of the project.
3. Citect SCADA supports lower and higher resolutions including 4K UHD Resolution
(3840 x 2160). A 4K UHD will require a high clock speed CPU.
4. A multi-monitor client will typically require a higher clock speed CPU and more
memory.
Server Recommendation
44
I/O per CPU

HDD Screen
Server PassMark- Cores RAM Graphics Network
*2 *3 Resolution
*1 ®
DirectX 9 or
later with
Compact
WDDM 1.0 1920 x
(<1,500 1800 1 4 GB 10 GB 100 Mb
Driver, 1080
pts)
64 MB of ded-
icated VRAM
DirectX 9 or
later with
Small
WDDM 1.0 1920 x
(<15,000 4500 4 8 GB 20 GB 100 Mb
Driver, 1080
pts)
128 MB of ded-
icated VRAM
DirectX 9 or
later with
Medium
100 WDDM 1.0 1920 x
(<50,000 8000 4 8 GB 100 Mb
GB Driver, 1080
pts)
128 MB of ded-
icated VRAM
DirectX 9 or
later with
Large
500 WDDM 1.0 1920 x
(<200,00- 10000 8 16 GB 1 Gb
GB Driver, 1080
0 pts)
128 MB of ded-
icated VRAM
1. This is a recommendation for a single server only running I/O, alarms, trends and
reports. For larger systems, services can be distributed to their own PC and/or clus-
tering can be used to add additional servers. System resources of CPU and Memory
should be increased when:
l Using clustering
l There is high rate of change of data (I/O or Alarms)
2. If the Deployment feature is being used, the HDD needs to have the required space for
the number of configured versions+ 2 of your project.
3. Disk space is an estimate only and includes:
l Runtime components
l Compiled project
l 20% of the I/O trending with a change on average every 10 seconds, 24 x 7 for 3
months.
l Alarm changes equal to the number of I/O changing per day
Engineering Workstation Recommendation
45
Total CPU HDD Screen

System PassMark- Cores RAM *1 Graphics Resolution Network
Size ® *2 *3 *4
DirectX 9 or
later with
Compact
WDDM 1.0 1920 x
(<1,500 2000 2 8 GB 10 GB 100 Mb
Driver, 128 1080
pts)
MB of ded-
icated VRAM
DirectX 9 or
later with
Small
WDDM 1.0 1920 x
(<15,000 2000 2 8 GB 20 GB 100 Mb
Driver, 128 1080
pts)
MB of ded-
icated VRAM.
DirectX 9 or
later with
Medium
WDDM 1.0 1920 x
(<50,000 4250 4 8 GB 50 GB 100 Mb
Driver, 128 1080
pts)
MB of ded-
icated VRAM.
DirectX 9 or
later with
Large
WDDM 1.0 1920 x
(<500,00- 4250 4 8 GB 50 GB 100 Mb
Driver, 128 1080
0 pts)
MB of ded-
icated VRAM.
DirectX 9 or
later with
Huge
100 WDDM 1.0 1920 x 100 Mb
(>500,00- 8000 4 8 GB
GB Driver, 128 1080 *5
0 pts)
MB of ded-
icated VRAM.
1. SSD is recommended for Engineering machines for a smoother and faster experience.
If a non-SSD is used, select a minimum RPM of 7200.
2. If the Engineering machine is being used as a Deployment Server, the size of the
HDD will determine how many versions of the system you can retain.
3. Disk space is an estimate only and includes:
l Full Citect SCADA installation including optional components and documentation
l Project Assets for the specified system size
4. Citect Studio is designed for a minimum desktop resolution of 1920 x 1080.
5. If the Engineering machine is being used as a Deployment Server, a 1Gb network con-
nection is recommended.
HMI Recommendation
46
Sys-
CPU
tem Screen Net-
PassMark- Cores RAM HDD Graphics
Resolution work
®
Size* 1
Com- DirectX 9 or later

pact 10 with WDDM 1.0 1920 x
1400 1 8 GB n/a
(<1,20- GB Driver, 64 MB of 1080
0 pts) dedicated VRAM
1. HMI Client/Server combination.
System Software
The following table indicates the system software that is needed on any computer onto
which you want to install the Citect SCADA All Core Components installation and all
optional components.
Citect SCADA
Minimum System Software
Component
Operating Systems:
Windows® 7 SP1 (64 bit only)
Windows® 8.1 (64 bit only)
Windows® 10 version 1607 and later (64 bit only)
Windows® Server 2008 R2 SP1
Windows® Server 2012
Windows® Server 2012 R2
All Core Components Windows® Server 2016
Microsoft .NET Framework 4.0, 4.5.1, 4.6.1 and 4.7 (installed

with Citect SCADA if not already installed).
Microsoft .NET Framework 2.0 (x64) is required by "Schneider

Electric License Manager" and "Schneider Electric Software
Update" if using Windows Server 2012.
Internet Explorer Version 9.0 or greater.
ArchestrA Data Store 3.0
Note: If installation is unsuccessful check if an earlier version of

ArchestrA Data Store is installed on your machine. If an earlier ver-
sion is installed, uninstall it. Restart your machine before installing
47
Citect SCADA
Minimum System Software
Component
Citect SCADA.
A Local Area Network (LAN) if you want to have multiple clients

access a remote server.
If running under virtualization with VMWare, the minimum sys-

tem requirement is VMWorkstation 6.03 and later.
The following virtualization environments are supported:
l Microsoft Hyper-V: based on the version of Windows

l VMware 5.0: basic virtualization without High Availability
and Disaster Recovery
l VMware Workstation
Virtualization Host Sup-
For further information on virtualization, please refer to the
port
online Knowledge Base (http://www.citect.schneider-elec-
tric.com/scada/vijeo-citect/find-answers/knowledge-base).
For further information on virtualization, please refer to the

online Knowledge Base (http://www.citect.schneider-elec-
tric.com/scada/citectscada/find-answers/knowledge-base).
As for Citect SCADA all Core Components with the addition of:
A LAN running TCP/IP

Citect SCADA WebServer
and
Microsoft Internet Information Services (IIS) See Microsoft IIS

Compatibility for information.
Product Documentation As for All Core Components.
Project DBF Add-in for As for All Core Components, and Microsoft Excel 2007 or later.
Excel Microsoft Excel 2013 (32 bit only)
Note: Use an NTFS file system on the target drive for the Web Server software, oth-
erwise you won't have effective access to the necessary Windows security settings
(that is, the Folder Properties dialog will not have a Security tab). If you are currently
using a FAT/FAT32 system, convert the drive to NTFS before installing the Web
Server software.
Microsoft IIS Compatibility

For correct operation of the WebServer, install the appropriate Microsoft Internet Inform-
ation Services (IIS) feature for your operating system:
48
Operating System IIS version
Windows 10 10.0
Windows 8.1 8.5
Windows Server 2012 R2 8.5
Windows 8 8.0
Windows Server 2012 8.0
Windows 7 7.5
Windows Server 2008 R2 7.5
Windows Server 2008 7.0
Components recommended for Web Server Installation
IIS6 Management Compatibility

IIS6 Metabase and IIS6 Configuration compatibility
Web Management Tools
IIS Management Console
IIS Management Services
ASP
Application Development Features
ISAPI Extensions
Default Document
Directory Browsing
HTTP Errors
Common HTTP Features
HTTP Redirection
Static Content
WebDAV Publishing
Health and Diagnostics HTTP Logging
Performance Features Static Content Compression
Basic Authentication
Security Request Filtering
Windows Authentication
Runtime Only Server or Client System Software

An installation of a Citect SCADA Runtime Only Server or Client has the same hardware
and system software requirements as the Core.
49
Virtualization Host Support

You can run components of your Citect SCADA system in a virtual environment.
The following virtualization environments are supported:
l Microsoft Hyper-V: based on the version of Windows
l VMware Workstation: basic virtualization without High Availability and Disaster
Recovery
l VMware vSphere
For further information on virtualization, please refer to the online Knowledge Base
(http://www.citect.schneider-electric.com/scada/citectscada/find-answers/knowledge-
base).
Anti-virus Software Setup
SYSTEM PERFORMANCE DEGREDATION
The "on access" scan in anti-virus products can lock files used by Citect SCADA, usually having
the effect of slowing Citect SCADA down whilst it waits for the scan of that file to finish.
age.
INOPERABLE SYSTEM OR LOSS OF DATA
In some extreme cases, anti-virus software may (incorrectly) detect certain patterns within data
files as being viruses. Depending on the anti-virus configuration, this may result in files being relo-
cated or deleted, resulting in data being lost or the system being inoperable.
Failure to follow these instructions can result in injury or equipment damage.
It is recommended that the following directories are excluded from scanning by any anti-
virus products:
l Program Files installation directory (including files and sub directories)
l Data and Logs directories
l Any alarm server archive paths
50
The above exclusions are recommended for "on access" or "real time" scans that run con-
tinuously and scan each file that is read from or written to.
Software Protection
Citect SCADA supports two different software licensing models:
l Sentinel Licensing (using USB keys)
Sentinel Licensing is a legacy licensing solution for Citect SCADA. It uses physical
USB keys that plug in to each computer in your Citect SCADA system. The USB
key contains details of your user license, such as its type and I/O point count.
When you upgrade to a new version of Citect SCADA, you are required to update
your Sentinel keys. To do this, you need to retrieve an authorization code from Sch-
neider Electric's online License Generator (see Updating Your Hardware Key).
l FLEXERA Softkey Licensing
The FLEXERA softkey solution stores license information on a FlexNet Enterprise
License Server. The Citect SCADA client process will retrieve licenses from this
server as required by the Citect SCADA system. To activate and administer
licenses, you use the Floating License Manager (see Floating Point License Man-
ager).
In both cases, Citect SCADA uses a Dynamic Point Count Licensing to determine if your
system is operating within the limitations of your license agreement. This process tallies
the number of I/O device addresses being used by the runtime system.
A point limit is allocated to each type of license included in your license agreement.
These license types include:
l Full Server Licenses
l Control Client Licenses
l View-only Licenses.
A special OPC Server License is also available if you want to run a computer as a ded-
icated OPC server. For more information, contact Technical Support.
Note:
• There is no distinction between a Control Client and an Internet Control Client.
• There is no distinction between a View-Only Client and an Internet View-Only Cli-
ent.
See Also
Demo Mode
51
Updating Your Hardware Key

When you upgrade to a new version of Citect SCADA, you need to update any existing
Sentinel USB hardware keys to enable the system to run.
To update a Sentinel USB key with CiUSAFE:
1. Plug the key you would like to update in a local USB port.
2. Open Citect Studio.
3. On the Activity Bar, select Licensing from the menu.
OR
Click the Licensing icon.
4. On the Sentinel Key Update panel, click Launch.

The CiUSAFE dialog box will appear.
5. Retrieve the Serial Number for the key from CiUSAFE.
6. Visit www.citect.schneider-electric.com/license-generator, and enter the serial number
in the USB Key Serial Number field.
7. Click Submit.
If the key is validated, an authorization code will be generated.
8. In CiUSAFE, enter the generated code in the Authorization Code field.
9. Click Update.
CiUSAFE will display a Return Code to confirm if the update was successful. See
the table below for an explanation of the return code values.
0 The key was updated successfully.
1,3 Either the KeyID or the Authorization code you entered is invalid.
2 Either the KeyID or the Authorization code you entered has been corrupted.
4,16 Either the KeyID or the Authorization code you entered is invalid.
9 No hardware key could be found.
52
Note: Each time you run the Sentinel Key Update, a different Key ID is generated
which is normal. However, if you obtain an authorization code but do not imme-
diately update the hardware key, you can enter the same authorization code the next
time you run the update.
Floating Point License Manager

If your Citect SCADA system uses FLEXERA Softkey Licensing, you need to activate your
licenses to allocate the computers in your system. To do this, you use the Schneider Elec-
tric Floating License Manager.
Note: If you have purchased softkey licenses for your Citect SCADA system, the
required activation codes will be emailed to your from scada.orders@schneider-elec-
tric.com.
To activate a license using Floating License Manager:

1. Obtain the required license activation code from the purchase confirmation email.
2. Open Citect Studio.
3. On the Activity Bar, select Licensing from the menu.
OR
Click the Licensing icon.
4. On the License Manager panel, click Launch.

The Schneider Electric Floating License Manger will appear. It will include a list of
the floating licenses that are already available on the FlexNet Enterprise License
Server.
5. Click Activate.
6. On the dialog that appears, select an Activation Method, then click Next.
7. Enter the Activation ID that was emailed to you, then click Next.
The following steps will be determined by activation method you selected. If you
require assistance, click the Help button for instructions.
8. To finalize the activation process, you will be prompted to restart the FlexNet License
Administrator. Click Yes.
The license you have activated will now appear in the list displayed in the Float-
ing License Manager.
53
There are several other tasks you can perform with Floating License Manager. For more
information on its supported functionality, see the documentation that is available from
the Help menu.
See Also
Dynamic Point Count Licensing
Dynamic Point Count Licensing

Citect SCADA counts I/O device addresses dynamically at runtime.
The client process keeps track of the dynamic point count. This includes variable tags
used by the following:
l Alarms
l Trends
l Reports
l Events
l OPC DA Server
l EWS Server
l Pages and Super Genies
l Cicode functions (TagRead, TagWrite, TagSubscribe, TagGetProperty and TagResolve)
l Any tag referenced by Cicode
l Reads or writes using DDE, ODBC, CTAPI or external OPC DA clients.
A particular variable tag is only counted towards your point count the first time it is
requested. Even if you have configured a certain tag on a particular page in your project,
the variable tag will not be counted towards your point count unless you navigate to
that page and request the data.
You should also be aware of the following:
l A dynamic point count is tag based, not address based. For example, two tags that
use the same PLC address will be counted twice.
l For the multi-process mode, each server component will accumulate its own point
count which will add to the total of the client dynamic point count.
If two trend tags use the same variable tag, it will be counted once. If two server
components use the same tag(s) (say alarm and trend), the tags will not be coun-
ted twice when the point count gets totaled in the client process.
l For the multi-process mode, the client component will also accumulate its own point
count, which will include all the variable tags that are used by the process.
54
l For the multi-process mode, the machine point count will be the point count of the cli-
ent component, or the point count added up from each server component, depending
on whichever is bigger. If the server point count is greater than 500, the client com-
ponent point count is disregarded.
l Reading properties of a tag with TagGetProperty() or TagSubscribe() will cause that
tag to be included in the point count, even if the value is not read.
l Persisted I/O (memory devices), local variables and disk I/O variable tags will not
count towards the dynamic point count, unless they are written to by an external
source (via OPC, DDE, ODBC, or CTAPI). For example, if you use an OPC client to
write to a local variable, each local variable will be counted once the first time it is
used.
Note: You can use the CitectInfo() Cicode function or the General page in the Citect
SCADA Kernel to determine the point count status of a client process. See the Licens-
ing Statistics for the Page General Kernel command.
Demo Mode
You can run Citect SCADA without the hardware key in demonstration (demo) mode.
Demo mode lets you use every Citect SCADA feature normally, but with runtime and I/O
restrictions.
In demo mode, you can run multiple processes (with the networking model selected as
"stand alone"), or in single process mode.
The following demonstration modes are available:
l 15 minutes with a maximum of 50,000 real I/O.
l 10 hours with a maximum of one dynamic real I/O. This is useful for demonstrations
using memory and disk I/Os. Citect SCADA starts in this mode if no hardware key is
available. If the system detects that you are using more than one real I/O point at
runtime, then it will swap to the 15 minutes demo mode.
Note: Writing to any tag through DDE, CTAPI, or ODBC will cause that tag to con-
tribute to the dynamic point count even if it is a memory or disk I/O point. So if you
write to more than one point through these interfaces, it will swap to the 15 minute
demo mode.
55
56
Chapter 5: Installation
The Installation Process
Note: Backup your existing projects then uninstall prior versions before installing
2018, as Citect SCADA does not support different versions running side-by-side.
Note: If you have an existing installation of OFS (OPC Factory Server), you will need
to uninstall it before proceeding with the installation of Citect SCADA. To uninstall
OFS select OPC Factory Server from the list displayed in the Windows Add or
Remove Programs dialog, then follow the on screen instructions.
Note: Remove existing Floating License Managers installations before installing the
new version.
Preliminary Installation
Make sure Windows Update is not running when you attempt to install Citect SCADA.
When you begin the installation any additional system software that is necessary will be
installed prior to the initial Citect SCADA Setup dialog being displayed..
1. To begin the installation, place the Citect SCADA DVD in the DVD drive of your com-
puter. If you have autorun enabled the initial Citect SCADA Setup dialog will dis-
play. If this does not occur, use Windows Explorer to navigate to the root directory of
the DVD and click Launch.exe to display the initial Citect SCADA Setup dialog.
57
When the Citect SCADA Setup dialog is displayed choose which application you
wish to install.
NOTICE
You must install Citect SCADA before you install the OPC Factory Server to have the OFS Server
licensed using the Citect SCADA license key. This will allow the correct Part and Serial number
combination to be registered during the OFS Server installation.
The OPC Factory Server, based on the OPC protocol, software enables Windows
client applications to communicate with PLCs of the TSX Compact, micro, TSX
Momentum, TSX/PCX Premium, Quantum, M340, TSX Series 7 and TSX S1000
families in order to supply the OPC clients with data.
If you choose the OPC Factory Server follow the on screen instruction. Complete
details on the installation options for OPC Factory Server can be found in the OPC
Factory Server User Manual located in OFS v3.60\Documentation on the install-
ation DVD.
If you choose the Citect SCADA installation, click Next to display the Welcome to
Citect SCADA dialog.
2. When this dialog is displayed, click Next to begin the installation process and dis-
play the Welcome to Citect SCADA dialog.
58
3. Click Next to display the Installation Documentation dialog. This allows you to read
the Installation Guide (this document), the readme file and Release Notes prior to con-
tinuing the installation. It is recommended that you read them.
59
4. Click Next to display the License Agreement dialog. Read the license agreement, and
if you accept the terms of the agreement, select the appropriate radio button, then
click Next to display the Installation Profiles dialog.
Installation Profiles
1. In the Installation Profiles dialog select the profile that represents the type of install-
ation that you require. For information on the profiles and their application com-
ponents refer to Chapter 3, "Installation Description".
60
2. Click Next to display the subsequent dialog in the installation sequence. The optional
components selected by default in the subsequent dialog will vary subject to the
option that you select in this Installation Profiles dialog.
As an example, if you selected the All Core Components option in the previous
step, when you click Next the Core Components dialog will be displayed and will
have all the components selected by default. If you had selected another profile in
the previous step, only some of the components will be selected.
61
This dialog allows you to change the selected components if you wish to have a
different installation configuration from the default provided by the profile which
you chose in the previous step.
Note:For the Deployment Client to be installed, the Citect SCADA2018 Runtime

option needs to be selected .
Note: The Sentinel Driver is not necessary on a client that gets a floating license from
a server. However if you upgrade from a Runtime installation to a full Configuration
and Development Environment, you will need to select the Sentinel Driver option so
that the hardware protection key will be recognized.
Note: Remove existing Floating License Manager installations before installing the
new version.
3. Click Next to display the Deployment Components dialog
62
By default the Deployment Server option is not selected. If you plan to use the
computer as a deployment server, select this option. You will be able to launch the
deployment server configuration tool when installation is complete.
The Deployment Client option is selected by default, and allows new project ver-
sions to be deployed to the current computer from a deployment server.
4. When you have made your selection, click Next to display the Add-on selection dia-
log.
63
The Add-on dialog allows you to select specific additional components for your
installation.
The options are:
l Project DBF Add-in for Excel™ (Only selectable if Microsoft Excel 2007 or later is
installed on the computer.)
l Web Server for IIS
Refer to Chapter 3, "Installation Description", for a description of these optional
Add-on components.
The Web Server on IIS (Internet Information Services) option will use IIS as a
platform for your server.
If you proceed with the Web Server for IIS installation, the installer automatically
determines if IIS is installed. An error message is displayed if IIS is not installed.
Install IIS before you continue with the Web Server for IIS installation.
5. Click Next. If the installer detects that the computer has Windows™ Firewall enabled,
you will be asked if you would like the installer to modify your Windows Firewall set-
tings.
64
If you select Yes, this will add Citect SCADA Runtime to the list of authorized pro-
grams.
When you have made your selection, click Next.
6. Proceed to Completing the Installation.
Completing the Installation

1. The Destination Folder dialog identifies the folders into which the Citect SCADA pro-
gram files you have selected will be installed.
65
You may change the folder locations by clicking the Change buttons and selecting
alternative locations.
2. When you are satisfied with the folder selections, click Next to display the Base
folder dialog.
The Base Folder dialog identifies the base folder into which the additional or optional
components of Citect SCADA that you have selected will be installed. You may change
the folder location by clicking the Change buttons and selecting an alternative location.
66
If you are satisfied with the folder selection, click Next to display the Ready to Install
the Program dialog.
The Ready to Install the Program dialog lists the Citect SCADA programs that will be
installed.
67
3. Review the list and if you wish to change the selections click the Back button through
the previous dialog until you reach the selection that you want to change. Click
Install to install the programs in the list and display the Installing Citect SCADA dia-
log.
4. The Installing Citect SCADA dialog displays a progress bar and identifies the status
of the installation. You can click Cancel if you want to terminate the installation.
During the course of the final installation you may be asked to confirm certain actions,
depending on the additional components that you have selected to install. In such cases
follow the prompts on the dialogs.
If Citect SCADA Drivers was selected, the communication driver installation will com-
mence towards the end of the main product installation.
You can also run the communications driver separately at a later time from the user
interface or the command line if you want to install additional drivers. For details see
Installing Additional Communication Drivers.
Installation of the drivers commences with the drivers being extracted to a temporary
folder. The Driver Selection dialog will then be displayed.
68
The Driver Selection dialog lists the drivers that are available for installation. There are
certain drivers that the product installation will install that are necessary for Citect
SCADA to function correctly. These are not displayed in the list and will be installed
automatically as in previous releases. For convenience, commonly used drivers are selec-
ted by default. In addition it will advise you of any drivers that are time limited or not
supported by your operating system. If you see that any of the drivers in the list are sub-
ject to limitations, click the Back button and deselect them from the previous dialog.
Select the drivers that you wish to install. You can select every driver by clicking the
Select All button. Then click the Next button to display the Driver Information dialog.
69
The Driver Information dialog displays a confirmation list of the drivers that will be
installed.
In addition it will advise you of any drivers that are time limited or not supported by
your operating system. In particular, some drivers may have not yet been confirmed to
operate correctly, or have been confirmed specifically to not operate correctly with
Microsoft® Windows 7. If you see that any of the drivers in the list are subject to lim-
itations, click the Back button and deselect them from the previous dialog, then click
Next to return to the Driver Information dialog. When you are satisfied that the correct
drivers will be installed click the Next button to install the selected drivers.
When the driver installation is finished, any Add Ons that you selected to install earlier
will be installed, followed by the main product installation Setup Completed dialog.
This lists a summary of the programs that have been installed.
70
If you wish to configure your deployment server now, select Launch Citect Configurator.
Clear the selection and click Finish to close the installation dialog. You can configure
your Deployment Server at a later stage by launching the Citect Configurator from Start
Programs | Schneider Electric | Common | Configurator.
Installing Additional Communication Drivers

You can install additional communications drivers at any time after you have installed
the main Citect SCADA product.
To install additional drivers:
1. From the Installation DVD locate the CitectDriverInstaller.exe file located in the root
directory.
Note: If you are using the Microsoft® Windows Vista™ or Windows 7 operating sys-
tem and have User Account Control (UAC) switched on the UAC dialog will display
when you open the file. You will be required to supply administrator credentials if
you are not an administrator of the computer.
2. Open the file to display the Welcome dialog and follow the steps above in Com-
munication Drivers noting the following additional step.
71
3. After you have accepted the license agreement an additional Choose Destination dia-
log will display. This will identify the default folder in which to install the drivers.
You can accept the default location or change to another folder using the Browse but-
ton. The installation folder has to contain the citect32.exe file otherwise an alert mes-
sage will be generated. In other words the location needs to have an existing Citect
SCADA product installed in that location.
4. Click the Next button to display the Driver Selection dialog and continue with the
installation as described in Communication Drivers.
Modify, Repair, or Remove Components

You can modify, repair or remove installed Citect SCADA components by using the Win-
dows Add/Remove Programs (or "Programs and Features" icon in Microsoft Vista).
Note: The Citect SCADA 2018 installation can only be removed using this operation.
You cannot Modify or Repair this installation. In order to Modify or Repair this
installation you need to re-install it from the main Citect SCADA installation inter-
face.
To perform a Modify, Repair, or Remove follow these steps.

1. From the Start menu select Settings, Control Panel to display the Control Panel win-
dow.
2. Select Add or Remove Programs to display the Add or Remove Programs dialog box.
3. Locate the Citect SCADA program on which you want to carry out the operation from
the list.
The available maintenance operations are shown below.
l Modify allows you to add Citect SCADA components that were not installed during
the original installation, or remove selected components via the Custom Setup dialog.
If you select the Modify operation, when you click the Next button the Custom Setup
dialog will be displayed.
l Repair the existing Citect SCADA component installation by reinstalling all non-cus-
tomizable files in the same location as the previous installation. If any of the files
were accidentally deleted or modified, then this option will restore the software back
to its original state.
l Remove Citect SCADA component files and remove all the registry entries. This will
restore the computer to the state prior to installation of the Citect SCADA component.
If you select the Remove operation, when you click the Next button a message box
will display requesting that you confirm or cancel the operation. If you confirm the
operation, the Citect SCADA component will be uninstalled.
72
Note: The uninstallation of Citect SCADA does not uninstall the Sentinel Protection
Software (used by the hardware protection key), Schneider Electric Licensing soft-
ware, Web Server, or the Project DB Add-in. To uninstall these applications use the
same procedure as for uninstalling Citect SCADA, but select the appropriate installer
from the list displayed in the Add or Remove Programs dialog, then follow the on
screen instructions.
In addition, you will need to separately uninstall OFS (OPC Factory Server) and the OFS
Configuration Tool. To uninstall these applications use the same procedure as for unin-
stalling Citect SCADA, but select OPC Factory Server from the list displayed in the Add
or Remove Programs dialog, then follow the on screen instructions. After OPC Factory
Server has been uninstalled, select OFS Configuration Tool from the list displayed in the
Add or Remove Programs dialog, then follow the on screen instructions.
73
74
Chapter 6: Configuration
In all but the smallest system, Citect SCADA will need to operate over a Local Area Net-
work (LAN) or a Wide Area Network (WAN).
You can use TCP/IP with Citect SCADA. Citect SCADA supports scalable architecture,
which lets you initially implement Citect SCADA on a single computer, or over a small
network, and then expand the system later without changing your existing hardware,
software, or system configuration.
Using Citect SCADA on a LAN adds more flexibility to the system, and coordination
within large plants can be more easily achieved. You can control and monitor autonom-
ous areas within the plant separately, and interrogate the whole plant using any Citect
SCADA computer on the network if you want.
In any of these scenarios there are basic configurations that you have to make for the suc-
cessful operation of your Citect SCADA system. The configuration steps are described in
this chapter.
Local Area Network Configuration

To set up a local area network (LAN) for Citect SCADA, you need to have successfully
installed network hardware and software in strict accordance with the instructions
provided by the manufacturer, and also be familiar with the basic operation of the net-
work.
Install the Citect SCADA software on every PC you want to use as a Citect SCADA
design-time development machine, Citect SCADA Runtime Only Client, Citect SCADA
I/O server, Citect SCADA Alarm, Report, or Trend server.
Also, set up Citect SCADA for your network, using the Setup Wizard on every one of the
machines. To access the Setup Wizard, start Citect Studio and navigate to the Project
activity. Click Setup Wizardon the Command Bar.
Note: You need a compiled project to select in order to run the Setup Wizard.
For a detailed explanation on the Setup Wizard, and its options refer to Running the
Setup Wizard in the online help.
75
Network Communications Overview
Networking and Microsoft Windows 7
Microsoft Windows 7 distinguishes between Public, Home and Work networks. Each net-
work has its own firewall profile, which allows you to configure different firewall rules
depending on the security requirements of your location. The Citect SCADA installers
automatically modify the windows firewall settings for the current active network profile
during installation. If you later change network settings, you will need to manually
modify the firewall settings within Windows.
Note:Citect SCADA networking and redundancy needs the options "Citect SCADA
FTP server" and "Citect SCADA Runtime" to communicate through a Windows fire-
wall. You will need to manually add an application to the Windows 7 firewall excep-
tion list for a particular network profile.
Using TCP/IP for Network Communications
Citect SCADA uses TCP/IP to facilitate communications across a network.

To set your system to TCP/IP-based communications, a number of parameters need to be
set in the citect.ini file. These parameters will be set automatically when you run the
Setup Wizard and select TCP/IP, after you have completed the installation of Citect
SCADA. For details of these parameters, and others, refer to “Citect.ini File Parameters”
in the online help.
The Setup Wizard will recognize the computer's IP address and match it to the IP
address configured in the project for the various servers in the Networking Addresses
list in the Topology activity | Edit view.
For example, if you had the following servers in your system:
Citect_IO_1
Citect_IO_2
Citect.PrimaryAlarm
Citect.StandbyAlarm
Citect.PrimaryTrend
Citect.StandbyTrend
Citect.PrimaryReport
Citect.StandbyReport
76
If the role you need for your PC is not available, you will also have to determine the IP
address and update the project accordingly. You can use the DOS command “ipconfig”
to obtain this information. Alternatively, you can change the PCs IP address to match
that defined in the project.
Configuring Communications Over a WAN

You can configure your system for use with wide area networks (WANs).
Using a Wide Area Network (WAN) is configured in much the same way as using a
LAN, with several additional considerations:
1. That the PCs on the WAN can see each other.
2. That appropriate security precautions (eg: VPN) are used when connecting networks
over a potentially public link (eg: the Internet).
3. Performance of the connections is appropriate to the data being transferred.
4. Reliability of the connection is appropriate to the requirement for access.
Web Server Configuration

To display a live Citect SCADA project in an Internet browser, you need to publish the
content of the project pages and the current data these pages present using standard,
Web-based communication protocols.
For the web server to function you need to create an exception in the Windows firewall
or any other third party firewall to allow TCP traffic to flow on port 80. Specifically, if the
machine hosting the web server is running the Windows Vista or Windows 7 operating
system, enable the World Wide Web Services (HTTP) option in the Windows Vista
inbound firewall.
To understand the communication architecture for the Citect SCADA Web Client, it's easi-
est to consider the role each of the following components play in achieving this outcome:
l Citect SCADA Web Server - Performs the server-side functionality of the system. As
well as providing communication, it directs a client to the graphical and functional
content of a Citect SCADA project and the location of the runtime servers. This inform-
ation is stored on the Web Server when a Citect SCADA project is configured as a
“deployment”. A Citect SCADA Web Server can contain multiple deployments.
l Citect SCADA Runtime Servers (including the I/O Server, Alarms Server, Trends
Server and Report Server) - Monitor the physical production facility and contain the
live variable tag data, alarms and trends that the Web Client will display.
l Web Client - provides the platform to merge a deployed project's pages and content
with the raw data drawn from the runtime servers. Again, standard Web technologies
are needed, so the client uses Microsoft Internet Explorer.
77
Once you've installed Citect SCADA Web Server for IIS, you will find the following dir-
ectories under the \Inetpub\wwwroot\Citect folder.
l The base directory primarily hosts the administrative pages that are displayed by a
Web Server.
l The cgi-bin and images directories contain the content necessary to display these
pages.
l The client folder contains the client components (.cab files) that are delivered to a
remote computer to run a deployment. Any subdirectories includes the components
associated with a particular release (in this case, v2018).
l The deploy folder includes the files associated with any deployments (Citect SCADA
projects) configured on the Web Server.
l The #displayclientfolder (located in the Deploy folder) plays a key role in the Web
Server security, as the permissions defined for this folder determine the access rights
for each user.
l The locales folder contains the files necessary to support different languages for the
client interface. See “Implementing Multiple Language Support” in the Web Client
topic of the Citect SCADA online help.
The IIS Virtual Directory

The installation process also adds a virtual directory called Citect to Windows IIS (Inter-
net Information Services). This virtual directory establishes the Web Server as a valid des-
tination for client applications. However, it also plays a key role in managing which
users have access to the site.
You can view evidence of this virtual directory in Windows' Internet Information Ser-
vices (IIS) Manager. The Citect SCADA virtual directory is shown under the list of
default web sites.
You can view the properties for the directory by selecting Properties from the right-click
menu.
The Virtual Directory inherits settings from the computer's default web site, with the fol-
lowing exceptions:
l Directory Browsing is enabled
l Script Source Access is disabled
l The default document is set to default.htm only
l Anonymous access is disabled
l Integrated Authentication is disabled
l Basic Authentication is enabled.
These settings, including integrated authentication, anonymous access and SSL Encryp-
tion, can be customized by the local administrator. However, proper configuration needs
experience with IIS and an understanding of the implications of adjusting its settings.
78
Setting Up Security
If you want to use a Web Server/Client for communications in your Citect SCADA sys-
tem there are configuration requirements for both the server and the client. The major
configuration needed is that of security on the server.
Security on the Web Server is based on the implementation of user accounts. In the case
of an IIS-based Web server, security is tightly integrated with Windows user authen-
tication. For information on setting security on each of these, refer to Configuring Security
Using IIS.
Web Client user account types

Both systems support the same three user account types on a Web Client.
Client type Description
User is permitted to remotely view, add, update and delete

Administrator
deployments.
User can view project pages and make adjustments to writable

Control Client
values.
View-only Client User can only view the project pages.
The Web Server tests the access rights for each user when they log in and then displays
or hides the appropriate buttons on the home page accordingly.
Note: Although the Web Client security architecture controls access to your projects
on the Web Server, the Citect SCADA system security (privilege/area settings) still
manages the control system, maintaining a primary level of security.
Configuring Security Using IIS

Setting up security on an IIS-based Web Server primarily involves creating three Win-
dows user groups, each representing one of the Web Client user account types. Indi-
vidual users can then be assigned to the relevant user group, and automatically inherit
appropriate access rights based on the Windows security settings defined for the group.
Note: To avoid security access issues for operating systems Windows Vista® and
above, creation of these Windows user groups is mandatory.
79
Client Type Access Rights
The following table defines the access rights that each type of user has to the Web
Server's installed directories, as defined by the properties for each.
In the table, read means Read & Execute, List Folder Contents and Read user per-
missions are allowed; read and write means Full Control is allowed, and access denied
means Full Control is denied.
VIEW-
Installed directory ADMINISTRATOR CONTROL
ONLY
Citect read read read
Citect \ cgi-bin read read read
Citect \ client read read read
Citect \ deploy read and write read read
access
Citect \ deploy \ #displayclient read read
denied
Citect \ images read read read
For example, an administrator client needs to be able to read all the installed folders to
fully access the components of the home page. Additionally, they need write access to
the Deploy subdirectory to create new deployments.
By comparison, a View-only Client needs to be denied access to the #displayclient folder
to deny the ability to write back to a Citect SCADA project.
Therefore, when setting up security on the Web Server, your user accounts need to align
appropriately with the permissions outlined in the table above.
To implement the Web Server’s security strategy successfully, follow the procedure below
to configure your system, and simplify managing client accounts.
The ongoing management of your Web Server security then involves adding and remov-
ing individual accounts as needed.
Note:
l The installation and initial configuration of the Web Server needs to be performed by
a Windows user with local administrator permissions; that is, they need to be able to
add and edit Windows User accounts, and modify files and folders. This capability is
needed to set up Web Client user accounts and manage security settings.
l It is important to understand the distinction between the role of the Windows Local
Administrator, and the Web Client’s Administrator users:
l Windows Administrator - configures security on the Web Server and sets up client
accounts.
80
l Web Client Administrator - an end user capable of modifying and managing pro-
jects deployed on the Web Server.
The two roles parallel a Citect SCADA configuration engineer and a runtime operator
To create the client account user groups:
1. From the Computer Management tool, locate Local Users and Groups in the directory
tree. This is where the users and groups for the local machine are configured and
managed.
2. Right-click the Groups folder and select New Group. This displays the New Group
dialog.
3. In the Group Name, type Web Client Administrator (or something appropriate), and
describe the group's purpose.
4. Click Create.
The group you have just created will appear in the list of groups presented in the Com-
puter Management console.
Repeat the steps above to create Control Client and View-only Client user groups.
To test your security settings, add at least one user to each group.
Preparing the Citect folder
You need to set the security settings for the Citect folder and its sub-directories, as this
will determine the access granted to each type of client account.
To prepare the Citect folder:
1. Log on to the Web Server computer as a Windows Administrator.
2. Launch Windows Explorer and browse to the Citect folder. The Citect folder is located
in the installation directory. By default, this is Inetpub\wwwroot\Citect on the web
server computer.
3. Right-click the Citect folder and select Properties.
4. From the Properties dialog, select the Security tab to display the users currently con-
figured for the folder.
There will probably be several groups already defined in this folder. The two you need to
pay attention to are the Administrators group and the Everyone group.
l The Administrators group represents all the Windows users recognized by the
Web Server computer with Local Administrator rights. This group has Full Con-
trol permissions on the folder, facilitating the ability to adjust the Web Server secur-
ity settings. If this is the case, there should be no reason to modify this group.
l The Everyone group represents all other users recognized by the local machine.
Give this group the following access to the Citect folder; allow Read & Execute,
List Folders Contents, and Read permissions. This provides local users on the
Web Server machine with the equivalent of Control Client permissions.
5. Add the three groups that you created in Configuring Client Account User Groups to
the Citect folder.
81
6. Confirm the security settings for the three newly created groups. Each has to have the
same access as the Everyone group: Read & Execute, List Folders Contents, and
Read permissions
7. All the subdirectories have to inherit the permissions set for the Citect folder. To do
this click the Advanced button on the Security tab of the properties dialog, and select
Replace permission entries on all child objects, then click OK.
This provides consistent security settings across all the installed directories. A Security
dialog might appear to alert you that this will “remove or reset explicitly defined per-
missions on child objects”. Click Yes to continue.
Setting Access Rights for Client Accounts
The three client account types supported by the Web Client are defined by the security set-
tings for each within the installed directories on the Web Server machine.
The differences, outlined in the table in Client Type Access Rights, need specific security
settings for the Administrator Client and View-only Client types. An Administrator
needs write access to the Deploy subdirectory, and the View-only Client needs to be
denied access to the #displayclient subdirectory.
To configure security setting for the Administrator Client group:
The Administrator Client needs full access to the Deploy subdirectory to enable the cre-
ation and modification of deployments.
1. Locate the Deploy subdirectory in the Citect folder. By default, this is InetPub\www-
root\Citect\Deploy.
2. Right-click the folder and select Properties to display the Deploy folder properties.
3. Click the Security tab and locate the Web Client Administrator group you created in
the list of users and groups.
4. Edit the permissions set for the group to Allow Full Control.
To configure the security settings for the View-only Client group:
The View-only Client needs to be denied access to the #displayclient subdirectory to deny
write changes being made to a deployed Citect SCADA project.
1. Locate the #displayclient subdirectory in the Citect folder. By default, this is Inet-
pub\wwwroot\Citect\Deploy\#displayclient.
2. Right-click the folder and select Properties to display the folder properties.
3. Click the Security tab and locate the View-only Client group you created in the list of
users and groups.
4. Edit the permissions set for the group, and change to Deny Full Control
5. A Security dialog appears “Deny entries take priority over all Allow entries”. Click
Yes to continue.
Note: The Control Client group needs no additional configuration, as it uses the set-
tings outlined in Preparing the Citect folder.
82
Set security permissions accurately in order for the web server to operate correctly. If you
experience any problem with communicating from the web client check that the security
settings are correct for your installation.
Deleting a User Account
You can deny a user access to the Web Server by removing them from the groups that
have permissions set for the Citect folder.
However, if security is a concern, deny the user access to the Citect folder before you
delete the user. This avoids a situation where the operating system doesn't immediately
acknowledge that a user account has been deleted, creating a short period where a
deleted user can still log on.
To absolutely delete a user account:
1. Add the user as an individual to the Citect folder.
2. Set their access rights to Deny Full Control.
3. Remove the user from the groups that have permissions set for the Citect folder.
With all access denied, they cannot do anything even if they gain access.
Testing the Web Server Security Settings

To test the security settings for your Web Server client groups:
1. Launch Internet Explorer on the Web Server machine.
2. Call up the Web Client home page by typing in the following address:
http://localhost/Citect
3. Log in to the home page using a user name and password that's been added to the
Administrator Client group.
If successful, the System Messages dialog will read “LOGINADMIN Admin (User-
Name) logged in”.
If the message starts with LOGINDC (for Control Client) or LOGINMC (for View-
only Client), there is a problem with your configuration. Confirm that you are
using the correct user name for the group you are testing. If the problem still
occurs, revisit the process in Setting up security using IIS to check that an error
hasn't been made.
4. Repeat this process with a Control Client and View-only Client user.
Once you have confirmed that security is correctly set up on the Web Server, you can
now prepare your Citect SCADA project for deployment. For more information see Con-
figuring a deployment in the online help.
83
Logging on to the Web Server

After setting up your client accounts, you need to provide the following details to each
end user so they can log on to the Web Server:
l Address of the Web Server
This is the address users have to type into their Web browser to gain access to the
Citect SCADA Web Server. If they are doing this remotely, the address is:
http://<machine name>/Citect
or
http://<machine IP address>/Citect
If they are logging on to the Web Server computer, the address is:
http://localhost/Citect
l User name and password
Once the browser has arrived at the Web Server, the end user is asked to provide a
user name and password. Typically, you just need to tell them that their Windows
user name and password will provide appropriate access. If you had to create a
new user profile for someone, provide them with the details.
Note: In some operating systems users may be logged in automatically. To modify

this behavior so the user is prompted to login, go to User Authentication in Internet
Explorer|Tools|Internet Options|Security Settings.
Once you have finalized the security setup on the Web Server, you are ready to prepare
your Citect SCADA projects for deployment.
Deployment Server Configuration

A deployment server allows you to send runtime files to specific computers in a Citect
SCADA system. This simplifies the process of distributing project changes across mul-
tiple computers.
A project's runtime files can be stored on the deployment server as a "version". From
here, they can be distributed across an encrypted connection to those computers that
have been set up as a deployment client. Any computer in a Citect SCADA system can
be a deployment client, including system servers and/or display clients.
84
To set up a deployment server for your system, you initially need to install the deploy-
ment server components on the host computer. This option is available on the Deploy-
ment Components installation profile.
When installation is complete, you will be able to run the Configurator, a tool that mod-
ifies the server's settings and generates the authentication file required to connect to the
deployment clients.
When the authentication certificate has been created, you need to run the Configurator on
each deployment client so you can locate the authentication file and request access to the
deployment server. You will also need to install theCitect SCADA runtime components
on each deployment client.
You can also use the Configurator to adjust some runtime environment settings for a
deployment client. These settings include:
l Server Authentication — specifies the password the computer will use to com-
municate with other Citect SCADA server processes.
l Project Run Path — .instructs Runtime Manager to run the deployed project, or the
project currently selected in Citect Studio.
For more information, see:
l Configure settings for a local deployment server
l Configure settings for a local deployment client
l Set up a deployment computer.
To configure the deployment server (on a local computer):

1. In the panel on the left side of the Configurator, select Deployment Server. The
[START] page will display.
2. You can choose one of the following options:
l Configure the Deployment Server
This option is available when no deployment server has been configured.
l Update the configuration of the current Deployment Server
This option is available once a deployment server has been configured. If selected
you can update the database password and transfer speed for a deployment
server; however you are unable to update the port number.
l Import configuration file from previous version of the Deployment Server
If you have a deployment server configured for Citect SCADA 2016, you can
import the settings. In the field provided browse for the following Configurator file:
"SE.Asb.Deployment.Server.WindowsService.exe.config".
Note: The default location is : “C:\ProgramData\Schneider Electric\Citect SCADA 2016\Config”
Once imported you will be able to continue using the deployment database and
file repository created in v2016 in Citect SCADA 2018 .
85
3. Click the [Next] button. The PORT page will display.

4. Enter a Port Number to specify which port the deployment server will use for https
communication with the deployment clients. By default, 443 is entered.
If the Port Number is not in your Windows firewall exception list, you need to
select Add the port to the Windows firewall exception list. If this option is not
selected, you may not be able to register deployment clients. (This option also
needs to be selected when configuring the deployment clients.)
5. Click the Next button. The TRUST page will display.
This page determines how the certificates required to verify communications will
be managed.
l Create unique security certificates for me — the deployment server will be con-
figured using locally created certificates. The Configurator will generate the
required authentication file for you.
l I have my own installed certificates — the Binding and Signing certificate fields
will be displayed. From the drop down menu, select the appropriate certificates.
(System generated certificates are not available from these menus.)
Note: If you select Create unique security certificates for me, you will only be able to
use the generated authentication file to verify the connection to each deployment cli-
ent.
7. Click the Next button. The ROLES page will display.

This page lists the Windows user groups the deployment server creates to control
access to some of its functionality. These groups include:
l [local]\Asb.Deployment.AdminRole - users can add and remove computers and
groups
l [local]\Asb.Deployment.UploadRole - users can add and remove project versions
l [local]\Asb.Deployment.DeployRole - users can deploy projects to runtime com-
puters
l [local]\Asb.Deployment.ReadRole - users can browse project versions and com-
puters.
When the configuration process is complete, the current user account will be
added to these groups. If required, you can manually add additional users to these
groups in the Windows configuration environment.
8. Click the Next button. The SETTINGS page will display.
This page allows you to set the password used by the deployment database. It also
allows you to set the transfer rate to limit the network bandwidth used when
deploying a project.
9. Enter the Password for the database. Confirm the password.
86
Note: To change an existing database password you need to reconfigure the deploy-
ment server.
10. In the Transfer Speed (KB/s) field, enter a value between 0 and 2147483647 (0 being
unrestricted). The default is 10000 (KB/s). By limiting the transfer speed, you allow
other processes to use the remaining network bandwidth. This value may affect the
overall duration of a deployment operation. For example, if your project is 20MB with
a limit set to 1000 KB/s, the project will take approximately 20 seconds to transfer.
Note: Settings may vary according to your network infrastructure.
11. Click the Next button. The FINISH page will display.
This page informs you that the Configurator is ready to apply the settings to the
server and generate an authentication certificate. Specify a location for the authen-
tication file in the File Path field.
If required, you can use the Previous button to make any changes to your settings
before you complete the configuration process.
12. Click the Configure button. The Configuration Messages panel will indicate if the
deployment server configuration was successful.
Note: If you need to regenerate the authentication file, you can open the Configurator
on the deployment server and click the Configure button. When you run the Con-
figurator again, you can only change the Password and Transfer Speed fields on the
Settings page.
To configure a deployment client (on a local computer):

1. In the panel on the left side of the Configurator, select Deployment Client.The
[START] page will display.
l Configure the Deployment Client
This option is available when no deployment client has been configured.
l Update the configuration of the current Deployment Client
This option is available once a deployment client has been configured.
l Import configuration file from previous version of the Deployment Server
If you have a deployment client configured for Citect SCADA 2016, you can import
the client settings. In the field provided browse for the following Configurator file:
"SE.Asb.Deployment.Node.WindowsService.exe.config".
Note: The default location is : “C:\ProgramData\Schneider Electric\Citect SCADA 2016\Config”
87
Click the [Next] button. The CONNECT page will display.

3. In the File Path field, enter the location of the authentication file generated by the
deployment server to which you would like to connect.
To change the deployment server to which a deployment client is connected,
repeat the steps needed to configure a deployment client.
If the deployment client is also configured as a deployment server, the deployment
client should only connect to the local deployment server.
4. Click the Next button. The TRUST page will display.
5. The options available will vary according to whether the system is using system gen-
erated certificates or locally installed certificates.
Select Use system generated certificates to use the authentication certificate gen-
erated by the Configurator during configuration of the deployment server. This
option is only available if you selected "Create unique security certificates for me"
when configuring the deployment server.
Select Use my own installed certificate to use the locally installed certificates. This
option is only available if you selected "I have my own installed certificates" when
configuring the deployment server.
Note: If using your own locally installed security certificates, you need to confirm
that the certificates used on both the deployment server and deployment client will
trust the certificates selected by each other.
6. Click the Next button. The AUTHORIZE page will display.

Enter the User Name and Password for the Windows user account that will be
used to register the client computer with the deployment server. The user account
you enter needs to be part of the "Deployment Admin Role" Windows user group
that is configured locally on the deployment server.
7. Click the Next button. The SETTINGS page will display.
On the SETTINGS page you can set the Unpack Rate, and add the Port number to
the firewall exception list.
8. In the Unpack rate (KB/s) field, enter a value between 0 and 2147483647 (0 being
unrestricted). If you limit the unpack rate, your system will still be able to run other
processes. This value may affect the overall duration of a deployment operation.
9. If the Port Number specified on the deployment server is not in your Windows fire-
wall exception list, you may need to select the option Add Port to the Windows fire-
wall exception list. If this option is not selected, you may not be able to start the
deployment client service.
10. Click the Next button. The FINISH page will display.
This page informs you that the Configurator is ready to send a request to the
deployment server for registration.
88
If required, you can use the Previous button to make any changes to your settings
before you initiate the registration process.
11. Click the Configure button.
If registration is successful, the configured client information will be stored on the
computer and a connection will be established. If registration is not successful, you
will be notified via the Configuration Messages panel.
Note: If you run the Configurator a second time on a deployment client, you can use
the File Path setting on the CONNECT page to do one of the following:
1) Select a different authentication file, which will connect the client to the deploy-
ment server associated with the file you select. If you choose this option, the existing
configuration settings for the deployment client will be overwritten.
2) Leave the file path blank. This will allow you to reconfigure the existing con-
nection to the deployment server. If you choose this option, you will only be able to
change the SETTINGS page. Use the Next button to go to the SETTINGS page.
To set up a runtime computer to operate as a deployment client:

1. In the panel on the left side of the Configurator, select Computer Setup.
2. If the computer will be used to host a Citect SCADA server process, you will need to
specify a password for server authentication. To do this, go to the Server Authentic-
ation section of the dialog.
3. Select the Configure Server Password check box.
4. Enter the required password and confirm it in the fields provided.
The password you enter needs to match the password configured for the other
server processes included in your Citect SCADA system. This password can be set
on each computer using Configurator or the Setup Wizard.
Note: If the Password and Confirm Password fields already contain an entry, it
means a server password has already been configured on the local computer. If
required, you can enter a new password.
5. In the Project Run Path section of the dialog, select one of the following options to
determine which project will be launched by Runtime Manager:
l Run the project currently selected in Citect Studio.
l Run the project deployed from the Deployment Server.
This option allows you to specify the directory location from which the deployed
project will run. If the specified folder does not exist, it will be created during the
deployment process. The default location is:
C:\ProgramData\Schneider Electric\Citect SCADA 2018\Deploy-
ment\Client\Project
89
6. Go to the Runtime Manager Configuration section of the dialog.

7. Select Run Runtime Manager as a Service to allow projects to be deployed to the
deployment client without having to manually start Runtime Manager.
Note: This option should only be used on unattended server computers.
If this option is not selected, you will need to manually start the Citect Runtime
Service before deploying a project.
8. To apply your settings, click the Configure button.
90

Installation Guide PDF

Uploaded by

Copyright:

Available Formats

Installation Guide PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Installation Guide PDF

Uploaded by

Copyright:

Available Formats

Citect SCADA 2018

Installation and Configuration Guide

Chapter 2: Upgrading to Citect SCADA 2018 11

Remove Obsolete Memory and Alarm Devices 34

Chapter 3: Installation Description 39

Chapter 4: Installation Requirements 43

The addition of either symbol to a “Danger” or “Warning”

This is the safety alert symbol. It is used to alert you to

not avoided, can result in property or equipment damage.

Electrical equipment should be installed, operated, serviced, and maintained only by

Before You Begin

UNINTENDED EQUIPMENT OPERATION

About This Guide

Maintaining System Currency

Note: For instructions related to previous versions of Citect SCADA, such as backing

Situational Awareness Starter Project

Display Name for Equipment

Offline Upgrade to Citect SCADA 2018 comprises the following steps:

1. Backup your current project and relevant files.

The following files need to be backed up:

Citect.ini This file is located in the config folder.

Data directory This file is found on the path [CtEdit]Data

These files contain alarm configuration data as well as runtime data.

Citect SCADA includes a number of ActiveX controls, which will be avail-

driver DLL which is located in the Bin directory where Citect SCADA

Note: The fixes contained in this hotfix may have been included in

2. Upgrade your licenses

4. Restore your project

5. Upgrade your project

6. Migrate your project

7. Merge your .INI file

Without this parameter, you will

Without this parameter, you could

[CtDraw.RSC] This allows you to open popup pages

This allows you to set the maximum number

8. Compile your project

Refer to your online help for instructions on compiling your project.

9. Run the Setup Wizard

10. Restore runtime files

11. Restore historical data files

Follow these steps to convert the files:

12. Run your project

13. Install Citect SCADA2018

Prepare Configuration [INI] Files

Trend and Alarm Data

Troubleshooting Offline Upgrade

Not able to upgrade license key

Compiler errors and warnings not related to deprecated functions

Pre-requisites for Online Upgrade

Upgrading from v7.20

Custom Alarm Filtering

Historical Alarm Events

Set the [Alarm.<Cluster Name>.<Server Name>]ArchiveAfter .INI parameter to a date

Alarm server synchronization during online upgrade

Changes during the upgrade process

Upgrading from v7.40

Alarm Save Files

Historical Alarm Events

Set the [Alarm.<Cluster Name>.<Server Name>]ArchiveAfter .INI parameter to a date