Professional Documents
Culture Documents
Installation Guide
Installation Guide
COPYRIGHT
© July 2021 AVEVA Group Plc. All rights reserved.
The Example Project is provided to you for the purpose of illustrating how the SCADA software 2020 R2 could be used in an oper-
ational environment ("the Purpose"). AVEVA grants you a royalty free, non exclusive, non transferable license to use the example pro-
ject installed with your SCADA software version 2020 R2 (“the Example Project”) for the Purpose only.
The Example Project is provided by AVEVA as part of the SCADA software version 2020 R2 on an "as is" basis and AVEVA does not
guarantee the reliability, serviceability or function of the Example Project.
Should you modify the Example Project, you bear the risk of any use of such modified Example Project.
AVEVA gives no express warranties, guarantees or conditions and to the extent permitted under applicable laws, AVEVA disclaims
all implied warranties, including any implied warranties of merchantability, fitness for a particular purpose or non-infringement of
third parties’ intellectual property rights.
AVEVA 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 Project.
No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted by any means, electronic, mechanical,
photocopying, recording, or otherwise, without the prior written permission of AVEVA. No liability is assumed with respect to the
use of the information contained herein. Although precaution has been taken in the preparation of this documentation, AVEVA
assumes no responsibility for errors or omissions. The information in this documentation is subject to change without notice and does
not represent a commitment on the part of AVEVA. The software described in this documentation is furnished under a license agree-
ment. This software may be used or copied only in accordance with the terms of such license agreement. ArchestrA, Aquis, Avantis,
Citect, Citect HMI, Citect SCADA, DYNSIM, eDNA, EYESIM, InBatch, InduSoft, InStep, IntelaTrac, InTouch, PIPEPHASE, PRiSM,
PRO/II, PROVISION, ROMeo, SIM4ME, SimCentral, SimSci, Skelta, SmartGlance, Spiral Software, Termis, WindowMaker, Win-
dowViewer, and Wonderware are trademarks of AVEVA and/or its subsidiaries. An extensive listing of AVEVA trademarks can be
found at: https://sw.aveva.com/legal. All other brands may be trademarks of their respective owners.
Publication date: July 2021
AVEVA Group plc
High Cross Madingley Road
Cambridge CB3 OHB. UK
https://www.aveva.com/
GENERAL INFORMATION
Some product names used in this manual are used for identification purposes only and may be trademarks of their respective com-
panies.
July 2021 edition for Plant SCADA Version 2020 R2.
Manual Revision Version 2020 R2.
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. © July 2021 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 contractual
warranty clauses.
For information on how to contact sales, customer training, and technical support see https://sw.aveva.com/contact.
Contents
Legal Information 1
Contents 3
Safety Information 7
Chapter 2: Configurator 23
View the Configurator Messages List 25
3
Contents
4
Contents
5
Contents
6
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
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
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 AVEVA for any consequences
arising out of the use of this material.
Do not use Plant 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
damage.
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 Plant SCADA must be individually and thor-
oughly tested for proper operation before being placed into service.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
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,
Installation and Operation of Adjustable-Speed Drive Systems" or their equivalent gov-
erning your particular location.
10
Chapter 1: Install Plant SCADA
The Plant SCADA installer initially requires you to specify the "role" a computer will
play within your control system. You can select from the three following options:
l Development Workstation — the computer will be used to build and test Plant
SCADA projects.
l Server — the computer will be responsible for running a Plant SCADA system. It
will perform tasks such as processing I/O device communications and managing
alarms and trends.
l Runtime-only Client — the computer will be a display client for monitoring and con-
trolling a system.
When you specify a role for a computer, a set of default components are automatically
selected for installation. If required, you can customize the list of default selections. For
example, if you select "Server", you can specify which type of server(s) you want to
install.
If you need help to determine the role for a computer, see What Should I Install?
Note: If you want your system to use secured features such as encryption or deploy-
ment, you should not install Plant SCADA on the computer that acts as the domain
controller within your Windows® domain.
If you are not familiar with Plant SCADA, this introductory chapter also provides
information you will need to know about the installation process and some specific
requirements. It includes:
l Licensing Tools
l Windows® User Groups and Security Roles
l Windows® Firewalls
l Communication Drivers
l OPC Factory Server
l Anti-virus Software Setup
l Maintaining System Currency
l Virtualization Host Support.
When installation is complete, a dialog will appear asking if you would like to launch
Configurator. This is a tool that is used to prepare a computer for its role within a Plant
SCADA system. For example, it can be used to manage the certificates required to
enable encrypted communications, or to map the local Windows® user groups to Plant
SCADA's security roles. For more details, see Configurator.
If you already have Plant SCADA installed, the Upgrading section of this guide
provides information to help you update to the latest version. It describes:
l Instructions for both online and offline upgrade methods
l Supported upgrade paths
l The Plant SCADA Migration Tool.
See Upgrading.
Note: Due to significant component organizational changes in this release, you need
to fully uninstall any existing versions of Plant SCADA and it's associated com-
ponents before you install Plant SCADA 2020 R2. You do not need to uninstall Plat-
form Common Services or ArchestrA Data Store.
Licensing Tools
Plant SCADA supports two different software licensing models:
l Sentinel Licensing
Sentinel Licensing uses physical USB keys that plug in to each computer in your
Plant SCADA system.
To use Sentinel Licensing, you need to install the Sentinel Driver (available via
the Core Components page of the installer).
l FLEXERA Softkey Licensing
The FLEXERA softkey solution stores license information on a FlexNet Enterprise
License Server. The Plant SCADA client process will retrieve licenses from this
server as required by the Plant SCADA system.
To activate and administer licenses, you need to install the Floating License Man-
ager (available via the Core Components page of the installer).
In both cases, Plant SCADA uses a Dynamic Point Count to determine if your system is
operating within the limitations of your license agreement. This process tallies the num-
ber of I/O device addresses being used by the runtime system.
Note: You can run Plant SCADA without a key in demonstration (demo) mode.
Demo mode lets you use every feature normally, but with runtime and I/O restric-
tions (15 minutes with a maximum of 50,000 real I/O, or 10 hours with a maximum
of one dynamic real I/O).
For more information, see the topic Licensing in the Plant SCADA documentation when
installation is complete.
Plant SCADA creates a set of security roles and local Windows user groups on a com-
puter during installation. By default the local Windows user groups are associated with
these security roles as members. Each role provides a different level of access to fea-
tures, applications and project resources. See Security Roles.
If you are installing Plant SCADA 2020 on a clean computer (one that has not hosted an
earlier version), the new security roles and local Windows user groups will be created
and mapped as follows:
Server.
If you are upgrading Plant SCADA from an earlier version, equivalent user groups will
already exist on the computer. If the installer detects these existing groups, they will be
retained. Only security roles will be created and mapped to the existing local Windows
user groups.
Security Role
Clean installation version Upgrade from earlier ver-
2020 sion
Configuration
SCADA.ConfigUsers Citect.Engineers
Users
Deployment Admin-
SCADA.DeploymentAdmins Asb.Deployment.AdminRole
istrators
Deployment
SCADA.DeploymentUploaders Asb.Deployment.UploadRole
Uploaders
If required, you can use Configurator to change the associated members with these
security roles (see Modifying the Members of a Security Role).
Windows Firewalls
Microsoft Windows® 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 Plant SCADA installers
can automatically modify the Windows firewall settings for the current active network
profile during installation. If you later change network settings, you will need to manu-
ally modify the firewall settings within Windows.
Note: Plant SCADA networking and redundancy needs the option "Plant SCADA
Runtime" to communicate through a Windows firewall. You will need to manually
add an application to the Windows firewall exception list for a particular network
profile.
Communication Drivers
Plant SCADA communicates with I/O devices such as PLCs, loop controllers, bar code
readers, scientific analyzers, remote terminal units (RTUs), and distributed control sys-
tems (DCS). This communication takes place with each device through the imple-
mentation of a communications driver.
The installation process allows you to select from a set of individual drivers that are spe-
cific to your system and its I/O devices. There are also certain drivers that are necessary
for Plant SCADA to function correctly. These will be installed automatically.
Note: With the release of Plant SCADA 2020 R2, a classification system for the driver
portfolio was introduced to indicate the level of ongoing maintenance that customers
can reasonably expect for each driver. In line with these classifications, the number
of drivers included by default with the Plant SCADA installation media has been
reduced to a set of ‘core’ drivers that have undergone recent updates. All other
drivers continue to be available for download from the Communication Drivers
page at the AVEVA Knowledge and Support Center located at https://soft-
waresupport.aveva.com/.
Based on the OPC protocol, OPC Factory Server enables Windows-based OPC client
applications to communicate with a range of Schneider Electric's PLCs.
The "on access" scan in anti-virus products can lock files used by Plant SCADA, usually having
the effect of slowing Plant SCADA down whilst it waits for the scan of that file to finish.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
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
relocated or deleted, resulting in data being lost or the system being inoperable.
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.
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.
AVEVA will periodically publish software updates for Plant SCADA and advisories
relating to safety, security and functionality. These are available from the Product Hub
page of the AVEVA Knowledge & Support Center website at https://soft-
waresupport.aveva.com. We especially recommend 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.
Note: If you are building a large system, it is important to carefully consider the
overall topology of the system. For example, a distributed architecture, server
redundancy, load sharing and clustered control scenarios can help to address your
process requirements and benefit the overall performance of a system. See the topic
Typical System Scenarios in the Plant SCADA documentation before you start to build
a complex system.
Clients access AVEVA Industrial Graphics via an Industrial Graphics Server, a ded-
icated computer that authenticates client details and provides access to the graphical
and functional content.
If you want to use Industrial Graphics, you will need to set up an Industrial Graphics
Server. You will also need to configure a Deployment Server in your network to deploy
content to the Industrial Graphics Server.
An AVEVA Enterprise License Server also needs to be part of your network to provide
licenses for client access.
Do you want Plant SCADA to act as a server for OPC UA client applications?
Setting up an OPC UA Server allows Plant SCADA's runtime system to function as a
server to OPC UA client applications. For more information, see Install an OPC UA
Server.
Note: To use encrypted communication, your Plant SCADA servers need to be run-
ning as a service.
If you already have a System Management Server set up, you will need access to the cer-
tificate that will connect your new installation to the System Management Server. This
can be also be configured using Configurator. See Connect a Computer to the System
Management Server.
If you want to use this feature, a Deployment Server is required. This is where you
store versions of a project for distribution. Specific components need to be installed for a
Deployment Server (and any Deployment Clients that connect to it).
Add-on components need to be installed to set up a Plant SCADA Web Server. The
installation process also adds a virtual directory called "AVEVA Plant SCADA" to Win-
dows® IIS (Internet Information Services).
Note: If you want to install a standalone Plant SCADA system for training or eval-
uation purposes, install a Development Workstation (see Install a Development
Workstation).
22
Chapter 2: Configurator
Chapter 2: Configurator
Configurator is a tool you can use to prepare a computer for its role within a Plant
SCADA system.
When a Plant SCADA installation is complete, a dialog will appear asking if you would
like to launch Configurator. In most cases, you will require Configurator to complete the
setup of a computer.
To access Configurator at other times, go to the Windows® Start menu and locate
AVEVA | Configurator.
Configurator presents a set of pages that can be accessed via a directory to the left of the
interface.
For the AVEVA Enterprise Licensing Platform, the following page is included:
l AVEVA Enterprise License Server — used to configure an AVEVA Enterprise
License Server.
See Use Configurator to Set Up an Enterprise License Server.
For AVEVA Common Platform components, the following page is included:
l System Management Server — used to configure a System Management Server.
See Configure a System Management Server.
For an AVEVA Industrial Graphics Server, the following pages are included:
l Client Settings
l Authentication Settings
See Use Configurator to Set Up an Industrial Graphics Server for more inform-
ation.
For Plant SCADA, the following pages are included:
l Computer Setup — used to configure environment settings for a runtime computer,
including a server password and some deployment settings
See Use Configurator Setup a Runtime Server.
l Security Roles — used to map Plant SCADA Roles to Windows® user groups,
Domain Groups and Individual users.
See Security Roles.
l Encryption — used to encrypt communications between Plant SCADA processes,
computers and CTAPI applications.
See Enable Encryption.
l Deployment Server — used to set up a Deployment Server for the distribution of
Plant SCADA project versions.
See Configure a Deployment Server.
l Deployment Client — used to set up a Deployment Client.
See Configure a Deployment Client.
l OPC UA Client Driver — used to manage secure communications with OPC UA
devices connected to Plant SCADA via an external OPC UA server. This relates to an
installed driver, not Plant SCADA's OPC UA Server.
See OPC UA Client Driver.
l OPC UA Server — allows Plant SCADA's runtime system to function as a server to
third-party OPC UA client application.
See Use Configurator to Set Up an OPCUA Server.
The icons next to each page indicate the current status of the associated settings, accord-
ing to the following legend.
Each page includes the Configuration Messages panel to advise you of the outcome of
any adjustments you make. You can also View the Configurator Messages List.
26
Chapter 3: Install a Development Workstation
A development workstation uses configuration tools such as Plant SCADA Studio and
Graphics Builder to create a Plant SCADA project.
A project includes runtime content and configuration information. You need to dis-
tribute a copy of the project to each computer in a Plant SCADA runtime system.
When you chose to install a development workstation, the following components are
selected by default:
l Plant SCADA Studio
l Plant SCADA Runtime
l Plant SCADA Drivers
l Plant SCADA Deployment Server
l Plant SCADA Deployment Client
l Plant SCADA Industrial Graphics Server
l Software Update Tool
l Project DBF Add-In for Excel.
Two licensing options are also selected by default.
l Sentinel Driver
l Floating License Manager.
See Licensing Tools to determine your requirements.
If required, you can use the Customize the components that will be installed page to
modify the list of selected components.
See also
Note: Before you install Plant SCADA, it is recommended that you install the latest
updates from Microsoft® for your operating system and system software.
Hardware Requirements
The hardware requirements for a development workstation are as follows, based on the
size of the system you are configuring.
<1,500 pts <15,000 pts <50,000 pts <500,000 pts >500,000 pts
CPU
2000 2000 4250 4250 8000
PassMark®
Cores 2 2 4 4 4
RAM 8 GB 8 GB 8 GB 8 GB 8 GB
HDD 10 GB 20 GB 50 GB 50 GB 100 GB
128 MB of ded- 128 MB of ded- 128 MB of ded- 128 MB of ded- 128 MB of ded-
icated VRAM. icated VRAM. icated VRAM. icated VRAM. icated VRAM.
Screen
1920 x 1080 1920 x 1080 1920 x 1080 1920 x 1080 1920 x 1080
Resolution
<1,500 pts <15,000 pts <50,000 pts <500,000 pts >500,000 pts
The suggested disk space requirements for the HDD is an estimate only and includes:
l A full Plant SCADA installation including optional components and documentation
l Project assets for the specified system size.
If the deployment feature is being used, the HDD needs to have the required space for
the number of configured project versions + 2. You should remove unused project ver-
sions periodically to reduce HDD usage.
Microsoft .NET Framework 4.8 is required. It will be installed by Plant SCADA if not
detected.
When .NET installation is complete, you may be prompted to restart your computer. If
this occurs, you should initiate a restart before you continue.
Note: The Project DBF Add-In for Excel will only work with a 32-bit version of
Excel. An Office 2016 version of Excel (or later) is required.
Use the Back and Next buttons to navigate through the pages.
By default, the following components are selected when you install a Devel-
opment Workstation.
Note: The Project DBF Add-In for Excel will only work with a 32-bit version of
Excel. See the Operating System Requirements.
If the installer detects that the computer has Windows Firewall enabled, you
will be asked if you would like the installer to modify your settings.
Windows® Firewall
If you select Yes, Plant SCADA Runtime will be added to the list of authorized
programs.
Note: The installation folder and the 'User and Data' folder cannot be the
same, or a sub-directory of one another. You also cannot install in your Win-
dows user folder.
This page identifies the destination folder for any add-ons that you have selec-
Base Folder
ted (such as the Project DBF Add-in for Excel).
You can modify the folder locations by clicking the Change button.
This page lists the components that will be installed based on your selections.
Ready to Install the Program If required, use the Back button to make any modifications.
The following descriptions of the Configurator's pages will help you determine which
settings you need to consider.
Computer Setup
The Computer Setup page allows you to specify three key settings for a Plant SCADA
computer.
l Server Authentication — specifies the password the Plant SCADA server processes
use to communicate with each other. If the computer will run a server process, you
will need to configure the server password.
l Project Run Path — instructs Runtime Manager to run the project currently selected
in Plant SCADA Studio, or a deployed project from the Deployment Server.
l Runtime Manager Configuration — allows you to run Runtime Manager as a ser-
vice, which may be required for a Deployment Client.
Security Roles
To manage the usage of Plant SCADA and restrict access to its sensitive components,
only users with relevant permissions can perform certain security-related operations.
Each security role has specific permissions to access different features, software applic-
ations and project resources. Using the Security Roles page in the Configurator, you can
assign the security roles to a user account or a group account. For more information, see
Security Roles.
Encryption
If your Plant SCADA system uses encrypted communications, you will have to enable
encryption for each new installation of Plant SCADA. This is achieved using Con-
figurator's Encryption page (see Enable Encryption).
If your Plant SCADA system already has a System Management Server, you can use this
page to establish a trusted connection to it (see Connect a Computer to a System Man-
agement Server).
Additional Components
Some pages will appear in the Configurator if you chose to install additional com-
ponents. Use the links below for more information on how to configure these pages.
l Deployment Server — see Configure a Deployment Server.
l Deployment Client — see Configure a Deployment Client.
l OPC UA Server — see Use Configurator to Set Up an OPCUA Server.
l OPC UA Client Driver — see OPC UA Client Driver.
l Industrial Graphics Server — see Use Configurator to Set Up an Industrial Graphics
Server.
A System Management Server ensures Plant SCADA components only work on trusted
computers. It also enables support for end-to-end encryption (which is highly recom-
mended).
Only one of the computers in a Plant SCADA system can be set up as a System Man-
agement Server.
The components required to enable encryption are included with every installation of
Plant SCADA. You need to use Configurator to specify which computer in your system
will act as the System Management Server.
The certificates required to enable trusted communications can then be created on this
computer using Configurator. Alternatively, you can also use your own third party cer-
tificates if required.
All other computers in your system then use this certificate to acquire validation from
the System Management Server.
Only one of the machines in the network can be identified and configured as a System
Management Server.
You use Configurator to establish a trust relationship between one or more computers
running Plant SCADA and its services. This configuration creates a platform that can
support encrypted communication between these computers. It is achieved by con-
figuring a certificate on a common System Management Server that can then be used to
enable encrypted communications.
Note: To connect a computer to the System Management Server, the current user on
the connecting machine needs to be a member of either the “aaAdministrators” or
the “Administrators” group on the computer where the System Management Server
is installed.
3. Select This machine is the System Management Server. Review the notes on the
screen before you start the configuration.
Note: The machine on which you want to install the System Management Server
needs to be configured to have a static IP address.
4. Click Configure.
Note: If you need to change the port used by a System Management Server see
the topic Advanced Configuration for a System Management Server in the Plant
SCADA documentation.
If the configuration is unsuccessful, check the Log Viewer. You can access this by
typing the following in the Windows command prompt:
%PROGRAMFILES(X86)%\common files\archestra\aaLogviewer.exe
Alternatively, view the error messages in the System Management Console.
6. Click Close to exit the Configurator.
Note: If you do not have a System Management Server configured, refer to the sec-
tion Configure a System Management Server for instructions. All AVEVA applications
need to be configured to trust each other to use encrypted communications.
To connect a computer to the System Management Server, you use the System Man-
agement Server page in Configurator. You can launch Configurator at the completion of
the installation procedure, or from the Windows™ Start menu.
To establish a connection, the current user on the remote computer needs to be a mem-
ber of either the “aaAdministrators” or the “Administrators” group on the machine
where the System Management Server is installed. If this is not the case, you will be
prompted to enter the credentials for a member of one of these groups.
Note: The Configurator interface refers to "redundant SSO servers". This feature
is not supported by Plant SCADA, you cannot configure a computer as a redund-
ant SSO server.
4. Click Configure. The root certificate is downloaded, and the following message is dis-
played.
5. Review the message carefully before you click Yes. If you select No, the configuration
process will be canceled.
A dialog box may appear prompting you to log on to the System Management
Server. This will occur if the current user is not a member of either the “aaAd-
ministrators” or the “Administrators” group on the machine where the System
Management Server is installed. If this happens, enter the credentials for a mem-
ber of one of these groups and click OK.
The Configuration Messages area displays the steps in the configuration process
and the progress.
If the configuration is unsuccessful, view details of the error messages in the Sys-
tem Management Console. Alternatively, check the Log Viewer by typing the fol-
lowing in the Windows command prompt:
%PROGRAMFILES(X86)%\common files\archestra\aaLogviewer.exe
6. Click Close to exit the Configurator.
Once you have connected to a System Management Server, you can modify the con-
figuration settings by selecting Advanced. Refer to the topic Advanced Configuration for a
System Management Server for more information.
Note: If you need to connect a client computer that is not on the same domain as the
System Management Server (for example, it is part of a Workgroup), you need to
configure the Primary DNS Suffix on the client to identify the domain on which the
System Management Server resides. Refer to the Windows documentation for
instructions on how to specify a Primary DNS Suffix for a computer.
Enable Encryption
Communications between Plant SCADA processes, computers and CtAPI can be encryp-
ted in Plant SCADA 2020 R2.
To use encrypted communications, you need to have a System Management Server con-
figured. In addition, the Runtime Manager should be running as a service. If these pre-
requisites are not met, warning messages will be displayed.
To enable encryption:
1. Launch the Configurator after the installation, or from the Windows™ Start menu.
2. In the left pane, select Plant SCADA | Encryption.
3. Firstly, check that the Encryption Prerequisites have been met. If a red cross appears
next to an item, you will need to make the required configuration changes before you
can enable encryption.
l To register the computer with the System Management Server, see Connect a
5. If you are performing an online upgrade to version Plant SCADA 2020 R2 or running
an older version of Citect SCADA, select Accept encrypted and non-encrypted con-
nections (mixed mode). Note that you can clear this option and configure your sys-
tem to use encryption after the upgrade process is complete.
The following table indicates the encryption mode that will align successfully
across server and client.
Encryption
Communication Communication Communication
mode on Mixed Mode
OK OK OK
client
Note: If you do not select Enable Encryption before you click Configure, the fol-
lowing message is displayed: "Encryption is currently disabled. It is recommended
that you enable encryption.".
These settings can be adjusted using the Configurator's Computer Setup page under
Plant SCADA. You can launch Configurator at the completion of the installation pro-
cedure, or go to the Windows® Start menu and locate AVEVA | Configurator.
Note: If you are using Deployment to run a project and do not select the Run
Runtime Manager as a Service option, you will need to manually start the Plant
SCADA Runtime Manager before deploying the project.
A Runtime Server is any computer that hosts a server process in support of the runtime
system. For example, a Runtime Server can perform one or more of the following func-
tions:
l Alarms server - evaluates the conditions that define an alarm
l Trends server - manages the accumulation and logging of trend information
l Reports server - generates configured reports
l I/O device server - manages communication with field devices.
The server processes that are hosted by a runtime server are not configured during the
installation process. These are defined in a project using in the Topology activity in
Plant SCADA Studio.
These processes can be installed on a single computer, or separated onto multiple com-
puters across a distributed system. See the topic Typical System Scenarios in the Plant
SCADA documentation for examples of how you can distribute server processes.
See also
Before you install Plant SCADA, it is recommended that you install the latest updates
from Microsoft® for your operating system and system software.
Hardware Requirements
The hardware requirements for a Runtime Server are as follows, based on the size of
your system.
CPU
2000 2000 4250 8000
PassMark®
Cores 2 2 4 8
RAM 8 GB 8 GB 8 GB 16 GB
HDD 10 GB 20 GB 50 GB 100 GB
Screen
1920 x 1080 1920 x 1080 1920 x 1080 1920 x 1080
Resolution
Note: The recommendations above are for a single cluster and server only running
I/O, alarms, trends and reports. System resources for CPU and memory should be
increased when using clustering, or if there is high rate of change of data (I/O or
alarms).
The suggested disk space requirements for the HDD 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.
If the deployment feature is being used, the HDD needs to have the required space for
the number of configured project versions + 2. You should remove unused project ver-
sions periodically to reduce HDD usage.
Microsoft .NET Framework 4.8 is required. It will be installed by Plant SCADA if not
detected.
When .NET installation is complete, you may be prompted to restart your computer. If
this occurs, you should initiate a restart before you continue.
By default, the following components are selected when you install a Runtime
Server.
This page lists the local Windows groups the installer will create to manage
security (see Windows User Groups and Security Roles).
Note: This page will only appear if you are installing Plant SCADA on a
clean computer (one that has not hosted an earlier version). If you are
upgrading from an earlier version, equivalent user groups will already exist
on the computer.
Local Windows™ Groups
If you want your current Windows user account to be included in the groups
that are being created, select Add the current Windows user to these
groups.
A dialog will let you know that the group membership changes will not occur
until after a restart.
If the installer detects that the computer has Windows Firewall enabled, you
will be asked if you would like the installer to modify your settings.
Windows™ Firewall
If you select Yes, Plant SCADA Runtime will be added to the list of authorized
programs.
Note: The installation folder and the 'User and Data' folder cannot be the
same, or a sub-directory of one another. You also cannot install in your Win-
dows user folder.
This page identifies the destination folder for any additional components that
you have selected (such as the Project DBF Add-in for Excel).
Base Folder
You can modify the folder locations by clicking the Change button.
This page lists the components that will be installed based on your selections.
Ready to Install the Program If required, use the Back button to make any modifications.
Server Authentication
A server process requires the configuration of a password. This allows servers to authen-
ticate and create trust with each other. If a computer will run a server process, you will
need to create a new password, or use the password that is already used by other server
computers in your Plant SCADA system.
3. If the computer will be used to host a Plant 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.
Note: If you change the server password while the runtime system is active, it will
not disrupt any established connections as the password is only retrieved when
authentication needs to occur. However, it is recommended that you apply the new
password as soon as possible. To do this, you need to restart the runtime system.
If you are not using deployment, you can use the default setting Run the project selec-
ted in Plant SCADA Studio.
2. Select one of the following options to determine which project will be launched by
Runtime Manager:
l Run the project currently selected in Plant SCADA Studio — This is selected
by default and will run the project from Plant SCADA Studio.
l Run the project deployed from the Deployment Server — Select this option to
set up a computer for deployment. This option allows you to run the deployed
projects from the deployment server.
3. To apply your settings, click the Configure button.
Note: If Plant SCADA Runtime is running as a service and the Project Run Path
option in the Configurator is changed to Run the project deployed from the
Deployment Server, you need to restart the Runtime Manager service for deploy-
ment to function correctly.
You need to select Run Runtime Manager as a service under the following cir-
cumstances:
l When a deployment client is configured on a computer and you want to push project
updates using "Force" mode.
l If you are using encrypted communications, and the current user on a deployment
client may not have required privileges.
These settings can be made using the Configurator's Plant SCADA | Computer Setup
page. You can launch Configurator at the completion of the installation procedure, or go
to the Windows®Start menu and locate AVEVA | Configurator.
Note: If you are using Deployment to run a project and do not select the Run
Runtime Manager as a Service option, you will need to manually start the Plant
SCADA Runtime Manager before deploying the project.
A Deployment Server allows you to distribute projects (and any subsequent updates) to
the computers in your Plant SCADA system. It stores multiple "versions" of a project's
runtime files, allowing you to deploy a specific version to any computer that has been
configured as a deployment client.
When using Industrial Graphics, a Deployment Server is required to deliver project ver-
sions to the Industrial Graphics Server.
See also
Before you install Plant SCADA, it is recommended that you install the latest updates
from Microsoft® for your operating system and system software.
Hardware Requirements
The hardware requirements for a Deployment Server are as follows:
Cores 4
Memory 8 GB
Network 1 GB
Microsoft .NET Framework 4.8 is required. It will be installed by Plant SCADA if not
detected.
When .NET installation is complete, you may be prompted to restart your computer. If
this occurs, you should initiate a restart before you continue.
By default, the following components are selected when you install a Deploy-
ment Server.
Customize the default com-
ponents l Plant SCADA Deployment Server
You can use this page to customize the list of selected components.
This page lists the local Windows groups the installer will create to manage
security (see Windows User Groups and Security Roles).
Note: This page will only appear if you are installing Plant SCADA on a
clean computer (one that has not hosted an earlier version). If you are
upgrading from an earlier version, equivalent user groups will already exist
on the computer.
Local Windows™ Groups
If you want your current Windows user account to be included in the groups
that are being created, select Add the current Windows user to these
groups.
A dialog will let you know that the group membership changes will not occur
until after a restart.
If the installer detects that the computer has Windows Firewall enabled, you
will be asked if you would like the installer to modify your settings.
Windows™ Firewall
If you select Yes, Plant SCADA Runtime will be added to the list of authorized
programs.
Note: The installation folder and the 'User and Data' folder cannot be the
same, or a sub-directory of one another. You also cannot install in your Win-
dows user folder.
This page identifies the destination folder for any additional components that
you have selected (such as the Project DBF Add-in for Excel).
Base Folder
You can modify the folder locations by clicking the Change button.
This page lists the components that will be installed based on your selections.
Ready to Install the Program If required, use the Back button to make any modifications.
To configure a deployment server you also need to have the deployment server com-
ponents installed. This is an option on the Customize the default components page of
the Plant SCADA installer (see Install a Deployment Server).
You can then use Configurator to configure a deployment server and set the deploy-
ment database password. Launch Configurator at the completion of the installation pro-
cedure, or from the Windows™ Start menu (Programs | AVEVA | Configurator).
On the Security Roles page under Plant SCADA, make sure that your user account is
assigned to the Deployment Administrator role, either directly or via an associated
domain group (see Security Roles).
After importing the Configurator file, you can continue using the deployment
database and file repository created previously in the current or earlier versions of
Plant SCADA.
3. Click Next. The SETTINGS page appears.
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.
4. Enter the Password for the database. Confirm the password.
Note: To change an existing database password you need to reconfigure the deploy-
ment server.
5. 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 trans-
fer.
If required, you can use the Previous button to make any changes to your settings
before you complete the configuration process.
7. Click Configure. The Configuration Messages panel will indicate if the deployment
server configuration is successful.
Note: If you change the computer name for the deployment server, it will cause a
loss of communications between the deployment server and all of the deployment
clients.
If there is any issue to perform deployment server activities, check that the NT Ser-
vice\CitectDeploymentServer virtual service account has read and write permissions for
the deployment server folder (%PROGRAMDATA%\AVEVA Plant SCADA 2020
R2\Deployment\Server).
Right click the Server folder, go to Properties | Security, and check that the permissions
are assigned correctly.
To configure a deployment client you use Configurator. This allows you to enter the
login credentials required to register the client.
Note: To configure a deployment client you need to have the deployment client com-
ponents installed. This is an option on the Customize the default components page
of the Plant SCADA installer.
Launch the Configurator at the completion of the installation procedure, or from the
Windows™ Start menu (Programs | AVEVA | Configurator).
On the Security Roles page under Plant SCADA, make sure that your user account is
assigned to the Deployment Administrator role, either directly or via an associated
domain group (see Security Roles).
Note: The current user on a deployment client needs to be assigned to the Runtime
Users role to run a deployment client. If this is not always possible, you can con-
figure Runtime Manager to run as a service (see Configure a Computer for Deploy-
ment).
available if a deployment client has been configured. The Deployment Client con-
figuration needs to be updated whenever there is change in the System Man-
agement Server configuration.
l Import configuration file from previous version of the Deployment Client - If
you have an earlier version of the deployment client configured (from Plant
SCADA 2016 or 2018), you can import the client settings. Browse for the following
Configurator file in the provided field:
"SE.Asb.Deployment.Node.WindowsService.exe.config".
On the SETTINGS page, you can set the Unpack Rate, and specify the location
for the projects to be deployed.
l 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 oper-
ation.
l In the Deployed project location field, specify the folder path where the
deployed projects from the Deployment Server will be stored. The default location
is: %PROGRAMDATA%\AVEVA Plant SCADA 2020 R2\Deploy-
ment\Client\Projects. You can use the browse button to change the folder path.
6. Click Next. The FINISH page appears.
This page informs you that the Configurator is ready to send a request to the
deployment server for registration.
If required, you can use the Previous button to make any changes to your settings
before you initiate the registration process.
7. Click Configure.
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.
If there is any issues with deployment client activities, check that the NT Ser-
vice\CitectDeploymentClient and NT Service\Citect Runtime Manager virtual service
accounts have read and write permissions for the deployment client folder
(%PROGRAMDATA%\AVEVA Plant SCADA 2020 R2\Deployment\Client).
Right click the Client folder, go to Properties | Security, and check that the permissions
are assigned correctly.
These settings can be adjusted using the Configurator's Computer Setup page under
Plant SCADA. You can launch Configurator at the completion of the installation pro-
cedure, or go to the Windows® Start menu and locate AVEVA | Configurator.
Server Authentication
If the computer will be used to host a Plant SCADA server process, you will need to spe-
cify a password for server authentication. Server processes with mismatching server
passwords will not communicate with each other.
Note: If you change the server password while the runtime system is active, it will
not disrupt any established connections as the password is only retrieved when
authentication needs to occur. However, it is recommended that you apply the new
password as soon as possible. To do this, need to restart the runtime system.
2. Select one of the following options to determine which project will be launched by
Runtime Manager:
l Run the project currently selected in Plant SCADA Studio — This is selected
by default and will run the project from Plant SCADA Studio.
l Run the project deployed from the Deployment Server — Select this option to
set up a computer for deployment. This option allows you to run the deployed
projects from the deployment server.
3. To apply your settings, click the Configure button.
Note: If Plant SCADA Runtime is running as a service and the Project Run Path
option in the Configurator is changed to Run the project deployed from the
Deployment Server, you need to restart the Runtime Manager service for deploy-
ment to function correctly.
You need to select Run Runtime Manager as a service under the following cir-
cumstances:
l When a deployment client is configured on a computer and you want to push project
updates using "Force" mode.
l If you are using encrypted communications, and the current user on a deployment
client may not have required privileges.
Note: The current user on a deployment client needs to be a member of the Con-
figuration Users security role to run the deployment client (see Security Roles).
Note: If you are using Deployment to run a project and do not select the Run
Runtime Manager as a Service option, you will need to manually start the Plant
SCADA Runtime Manager before deploying the project.
62
Chapter 7: Install an Industrial Graphics Server
Note: With this release of Plant SCADA, the Industrial Graphics Server has a num-
ber of functionality limitations. For example, an Industrial Graphics Server is read-
only and does not support alarms. For a full list of limitations, see Industrial Graph-
ics Server Functionality Limitations.
When you choose to install an Industrial Graphics Server, the following components are
selected by default:
l Plant SCADA Industrial Graphics Server
l Plant SCADA Deployment Client.
The Deployment Client is required as Plant SCADA's Deployment functionality is used
to deliver projects to the Industrial Graphics Server.
Note:
• For runtime operation, it is recommended that you install an Industrial Graphics
Server on a dedicated computer especially if it will be required to handle a large
number of client requests.
• If you would like to review an Industrial Graphics application locally during devel-
opment, you also need to have an Industrial Graphics Server installed locally on the
development workstation.
Licensing for AVEVA Industrial Graphics is managed using the AVEVA Enterprise
Licensing system, which means you may also need to install the Enterprise Licensing
Server and/or the Enterprise Licensing Manager. For more information, see AVEVA
Enterprise Licensing.
If required, you can display the Industrial Graphics Web Client locally on the Industrial
Graphics Server using the following address in a browser:
l https://localhost/aig
Be aware, however, that the connected System Management Server may be configured
to use a non-default port (see Advanced Configuration for a System Management
Server). This changes the port the AIG server uses to listen, which means you need to
include the current HTTPS Port setting in the address as follows:
l https://localhost:<HTTPS Port value>/aig
Note: If the Plant SCADA compiler determines that your SCADA system tag names
are not globally unique across all clusters, any tag subscriptions that do not specify a
specific cluster will be rejected by the Industrial Graphics Server. If this occurs, you
can use the parameter [General]EnforceTagGlobalUniqueness to diagnose which
tags are not globally unique.
See also
Note: It is recommended that you review the list of supported graphical elements
and limitations before you start creating an Industrial Graphics application. See the
topic Supported Graphical Elements and Known Limitations in the AVEVA™ Industrial
Graphics section of the Plant SCADA documentation.
Before you install Plant SCADA, it is recommended that you install the latest updates
from Microsoft® for your operating system and system software.
Hardware Requirements
The hardware requirements for an Industrial Graphics Server are as follows:
l CPU PassMark®: > 5200 pts
l RAM: 16 GB
Each client session requires ~200 Mb of memory, depending upon graphics com-
plexity.
Note: The recommended requirements are suitable for a system with ten clients,
browsing pages with approximately 40 dashboard/charting components with ~250
I/O tags on the page. Pages may take a longer time to display on the first visit. The
display time depends on graphics and script complexity.
Microsoft .NET Framework 4.8 is required. It will be installed by Plant SCADA if not
detected.
When .NET installation is complete, you may be prompted to restart your computer. If
this occurs, you should initiate a restart before you continue.
Note: Licensing for AVEVA Industrial Graphics is managed using the AVEVA Enter-
prise Licensing system. If you do not have access to an existing Enterprise License
Server, you will need to include the AVEVA Enterprise License Manager and
AVEVA Enterprise License Server to your Plant SCADA installation. For more
information, see AVEVA Enterprise Licensing.
By default, the following components are selected when you install an Indus-
trial Graphics Server.
Licensing for AVEVA Industrial Graphics is managed using the AVEVA Enter-
Customize the default com-
prise Licensing system. If you do not have access to an existing Enterprise
ponents
License Server, you will need to include the following components in your
installation.
This page lists the local Windows groups the installer will create to manage
security (see Windows User Groups and Security Roles).
Note: This page will only appear if you are installing Plant SCADA on a
clean computer (one that has not hosted an earlier version). If you are
upgrading from an earlier version, equivalent user groups will already exist
on the computer.
Local Windows™ Groups
If you want your current Windows user account to be included in the groups
that are being created, select Add the current Windows user to these
groups.
A dialog will let you know that the group membership changes will not occur
until after a restart.
If the installer detects that the computer has Windows Firewall enabled, you
will be asked if you would like the installer to modify your settings.
Windows™ Firewall
If you select Yes, Plant SCADA Runtime will be added to the list of authorized
programs.
Note: The installation folder and the 'User and Data' folder cannot be the
same, or a sub-directory of one another. You also cannot install in your Win-
dows user folder.
This page identifies the destination folder for any additional components that
you have selected (such as the Project DBF Add-in for Excel).
Base Folder
You can modify the folder locations by clicking the Change button.
This page lists the components that will be installed based on your selections.
Ready to Install the Program If required, use the Back button to make any modifications.
Authentication Settings
System Management Server
You need to connect a computer that hosts an Industrial Graphics Server to a System
Management Server (SMS). This will allow authentication and authorization requests to
be handled by the SMS's Identity Manager.
When connected, the System Management Server field will display the name of the
computer hosting the SMS.
If "not connected" is displayed, you will need to configure the connection to an SMS (see
Connect a Computer to a System Management Server).
Secure Gateway
If required, you can use a secure gateway to avoid directly exposing the Industrial
Graphics Server to client computers that are not a part of your SCADA system network.
To use a secure gateway, enter the Fully Qualified Domain Name for the computer that
hosts the secure gateway server you want to use. The computer you use should be loc-
ated in a DMZ.
For more information, see the topic Securing Industrial Graphics Web Client Access in the
Plant SCADA documentation.
Client Settings
The Client Settings page allows you to specify the following settings for clients that con-
nect to the Industrial Graphics Server.
Allows you to specify (in milliseconds) how regularly graphics are refreshed in a con-
nected Industrial Graphics Client. You can specify a Refresh Rate between 250 and
60000 milliseconds.
This feature is not supported by Industrial Graphics applications in this version of Plant
SCADA.
Set up deployment.
If your Industrial Graphics Server is running on a remote computer, set it up for deploy-
ment.
l Set up a deployment server in your system (see Configure a Deployment Server).
l Configure a deployment client on the Industrial Graphics Server so that it can receive
project versions from the deployment server (see Configure a Deployment Client).
Enable encryption.
An Industrial Graphics Server will only connect to your Plant SCADA servers over an
encrypted connection. You need to confirm the following:
1. Plant SCADA is configured to run with encryption enabled. This is achieved via the
Encryption page in Configurator (see Enable Encryption).
Running in mixed mode is acceptable as long the remaining prerequisites are also
met.
2. Runtime Manager needs to be configured to run as a service.
This is required to enable encryption. The required settings are available on Con-
figurator's Computer Setup page (see Configure a Runtime Computer for Encryp-
tion).
3. In your project settings, confirm the DNS Name field is configured for each entry in
the Computers activity. This is also required to enable encryption.
4. Run the Computer Setup Wizard and confirm on the Network Model page that net-
working is enabled. This is required even if you are running the Industrial Graphics
Server and the Plant SCADA servers on a single computer.
72
Chapter 8: Install an OPC UA Server
Note: In this release of Plant SCADA, the OPC UA Server has the following func-
tionality limitations:
• The server is read-only.
• The server supports DA only.
• Quality tag extensions are represented as a numeric value. Only the OPC quality is
exposed.
• Alarm Properties as Tags are not exposed.
• Extended quality modes "Control Inhibit" and "Tag Override" are not available.
• Redundant OPC UA servers are not supported.
Following installation, you can configure the OPC UA server via Configurator's OPC
UA Server plugin under Plant SCADA. This has four configuration options:
l Port number – the port number the OPC UA server will listen on.
l URL – the URL to use to connect to the OPC UA server (read only).
l Enable Encryption – This option allows encrypted communications between the
server and client.
l Allow Anonymous access – Checking this option allows anonymous users to con-
nect to the OPC UA server.
The OPC UA Server does not support OPC UA’s discovery feature, so to connect manu-
ally enter the URL of the OPC UA server (as shown in Configurator).
If the OPC UA Server is installed on a separate computer, you will need to configure a
deployment server and client to deploy the relevant project information to the OPC UA
server. Once the project files have been deployed, the OPC UA server will start using
the new configuration automatically.
If you update the Equipment Name or Equipment Item for a variable tag and restart the I/O
Server, any OPC UA clients that are subscribed to this tag via its old equipment name may
show outdated values. After restarting the I/O Server, perform the rebrowse operation in the
OPC UA client and resubscribe to those variables tags.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
Note: The OPC UA Server’s browse functionality will always retrieve a tag name
with the cluster prefix. However, if you manually subscribe to a Plant SCADA tag
using its tag name, the OPC UA Server may reject the subscription request if a
cluster is not explicitly defined. This will occur if the compiler determines that your
SCADA system tags are not globally unique across all clusters. If this occurs, you
can use the parameter [General]EnforceTagGlobalUniqueness to diagnose which
tags are not globally unique.
See also
Before you install Plant SCADA, it is recommended that you install the latest updates
from Microsoft® for your operating system and system software.
Hardware Requirements
The hardware requirements for a OPC UA Server are as follows:
l CPU PassMark®: > 4000 pts
l RAM: 16 GB
l Changes per second: < 25,000
l Supported tags: < 100,000
l Maximum OPC UA clients in the system: < 10
Adding each OPC UA client to the connected OPC UA server increases the CPU
and memory usage on both the OPC UA server and the IO Server.
Note:
• Several systems with a large number of tags arranged in a flat architecture, or a
hierarchy with many child nodes, will significantly impact the browse performance
of a connected OPC UA client.
• Plant SCADA now includes a connectivity service that manages tag subscriptions
for the OPC UA Server and Industrial Graphics Server. This places an additional
load on your I/O servers, particularly if a subscribed tag also specifies a property or
extension. If this impacts I/O performance, you should consider distributing your
I/O servers across a number of computers. You can also disable support for prop-
erties and extensions with the parameter [IOServer-
]DisableConnectivityPropertiesAndExtensions.
Microsoft .NET Framework 4.8 is required. It will be installed by Plant SCADA if not
detected.
When .NET installation is complete, you may be prompted to restart your computer. If
this occurs, you should initiate a restart before you continue.
Note: The OPC UA Server does not support browse filtering by OPC UA Clients.
By default, the following components are selected when you install an OPC UA
Server.
Customize the default com-
ponents l Plant SCADA OPC UA Server
l Plant SCADA Deployment Client.
You can use this page to customize the list of selected components.
This page lists the local Windows groups the installer will create to manage
Local Windows™ Groups
security (see Windows User Groups and Security Roles).
Note: This page will only appear if you are installing Plant SCADA on a
clean computer (one that has not hosted an earlier version). If you are
upgrading from an earlier version, equivalent user groups will already exist
on the computer.
If you want your current Windows user account to be included in the groups
that are being created, select Add the current Windows user to these
groups.
A dialog will let you know that the group membership changes will not occur
until after a restart.
If the installer detects that the computer has Windows Firewall enabled, you
will be asked if you would like the installer to modify your settings.
Windows™ Firewall
If you select Yes, Plant SCADA Runtime will be added to the list of authorized
programs.
Note: The installation folder and the 'User and Data' folder cannot be the
same, or a sub-directory of one another. You also cannot install in your Win-
dows user folder.
This page identifies the destination folder for any additional components that
you have selected (such as the Project DBF Add-in for Excel).
Base Folder
You can modify the folder locations by clicking the Change button.
This page lists the components that will be installed based on your selections.
Ready to Install the Program If required, use the Back button to make any modifications.
See also
To set up an OPC UA Server, open Configurator and adjust the following settings on
the OPC UA Sever page under Plant SCADA.
Address Configuration
Enter the Port Number that you want to use for the OPC UA Server. The value you
enter will be reflected in the URL.
The URL field shows the address that is used to connect to the OPC UA Server. You can-
not edit this field.
opc.tcp://<computer name>:48031/plantscada.
Encryption
Select the Enable encrypted communications to set the security policy to
Basic256Sha256 and the security mode to SignAndEncrypt.
Authentication
Select Allow anonymous connections if you want to allow users to connect anonym-
ously to the OPC UA Server.
If this option is not selected, a user will only be able to access the server if they are part
of a Windows group that is associated with one of the Security Roles defined in your
project. Plant SCADA users are not supported.
Note: The information provided in this topic is intended for a scenario where SMS
certificates are used on computers contained within your SCADA system network. If
you want to deliver information across multiple domains or externally via the inter-
net, we recommend you seek professional advice on setting up an external web
server.
To complete this setup, you will need to perform the following steps:
4. Right-click on the certificate and select All Tasks, then Export. This will open the Cer-
tificate Export Wizard.
Depending on the type of certificates that your client application uses, you will
need to export the certificate as a CER file (if the client uses the Windows™ Cer-
tificate Store) or a DER file (if the client uses file-based certificates). These two
formats are the same, only the file extension is different.
5. Use the following settings to export the certificate.
l On the Export Private Key page, select No, do not export the private key.
l On the Export File Format page, select DER encoded binary X 509 (.CER) or
Base-64 encoded X.509 (.CER) (depending on the requirements of your client
application).
l On the File To Export page, enter a path and file name (for example, "c:\tem-
p\<machine name> OPC UA Server.cer").
6. When you reach the Finish page, review the settings and click Finish to export a
copy of the certificate.
Once the certificate has been exported, you may need to rename the file extension on the
certificate from “.cer” to “.der” (if the client uses file-based certificates).
The table below includes the location of the certificate folder for some common OPC UA
clients.
OPC UA
Manufacturer Certificate Folder
Client
Datafeed
OPC UA Cli- Softing C:\ProgramData\Softing\OpcClient\pki\trusted\certs
ent
UA Client C:\Pro-
Unified Auto-
Getting gramData\unifiedautomation\UaSdkNetBundleEval
mation
Started \pkiclient\trusted\certs
C:\User-
Matrikon Matrikon s\Admin\Appdata\Local\Matrikon\OPCUAExplorer
\pki\DefaultApplicationGroup\trusted\certs
C:\ProgramData\Kepware\KEPServerEX\V6\UA\Client
KEPServer Kepware
Driver\cert
For more information, please refer to the documentation provided with your OPC
UA client application.
The easiest way to do this is to attempt to connect an OPC UA client to the server. As
the server will not trust the client certificate yet, the connection is expected to be unsuc-
cessful. However, after this happens, any OPC UA client certificates that are not
installed on the OPC UA Server computer will be put into the “Rejected Certificate”
folder on the OPC UA Server. By default, this is in the following folder:
You will need to confirm that this port is not blocked by any firewall software installed
on your computer.
See Also
Enable Encryption
Set up deployment.
If your OPC UA Server is running on a remote computer, set it up for deployment.
Enable encryption.
An OPC UA Server will only connect to your Plant SCADA servers over an encrypted
connection. You need to confirm the following:
1. Plant SCADA is configured to run with encryption enabled. This is achieved via the
Encryption page in Configurator (see Enable Encryption).
Running in mixed mode is acceptable as long the remaining prerequisites are also
met.
2. Runtime Manager needs to be configured to run as a service.
This is required to enable encryption. The required settings are available on Con-
figurator's Computer Setup page (see Configure a Runtime Computer for Encryp-
tion).
3. In your project settings, confirm the DNS Name field is configured for each entry in
the Computers activity. This is required to enable encryption.
4. Run the Computer Setup Wizard and confirm on the Network Model page that net-
working is enabled. This is required even if you are running the Industrial Graphics
Server and the Plant SCADA servers on a single computer.
The user must also be a member of a Windows group that is mapped to a valid Role
within your Plant SCADA project. See the topic Roles within the Runtime System Security
section of the Plant SCADA documentation.
Note: The Configurator's OPC UA Client Driver page is used to manage secure
device communications via an external OPC UA server. It is not related to the Plant
SCADA OPC UA Server, which delivers runtime data to third-party OPC UA cli-
ents.
Plant SCADA's OPCUA driver supports the use of user credentials when connecting to
a device. It allows you to establish a secure connection between the driver and an
external OPC UA server using X509 client and server certificates. The driver needs
access to the server certificate and the server needs access to the driver's client cer-
tificate.
To support this, the OPC UA Client Driver page under Plant SCADA in Configurator
allows you to:
l Create security settings.
l Select the client certificate from the Windows® certificate store.
l Import the client certificate from a file into the Windows certificate store.
l Issue a Plant SCADA OPC UA client certificate, store it in the Windows certificate
store and export it to a file.
l Import the server certificate from the file into the Windows certificate store.
l Test connection to the OPC UA server.
For further instructions, see the topic Security Configuration in the OPCUA driver doc-
umentation. You can access the driver documentation via the Driver Reference Help
toolbar button in Plant SCADA Studio's Topology|I/O Devices view.
A Plant SCADA Web Server provides the server-side functionality of the system that
supports a Plant SCADA Web Client, a tool that allows you to view a live project within
a Web browser.
The Web server uses Microsoft's IIS to verify requests from client computers. It shares
the content required to view a project on a Web Client, and provides access to the client
to the runtime servers.
See also
Before you install Plant SCADA, it is recommended that you install the latest updates
from Microsoft® for your operating system and system software.
Hardware Requirements
The hardware requirements for a Web Server are as follows:
Cores 2
Memory 8 GB
HDD 20 GB
Network 100 Mb
The suggested disk space requirement for the HDD is only an estimate. It takes into
account the required software and space for storing your project versions. You need to
ensure there is enough space to hold the number of versions of the project being served.
Note: Use an NTFS file system on the target drive for the Web Server software, oth-
erwise you will not have 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 .NET Framework 4.8 is required. It will be installed by Plant SCADA if not
detected.
When .NET installation is complete, you may be prompted to restart your computer. If
this occurs, you should initiate a restart before you continue.
Windows 10 10.0
IIS includes a number of components that you can enable via the Programs page in Win-
dows' Control Panel. The Windows Features dialog box is displayed by selecting Turn
Windows Features on or off.
The following table lists the IIS components that are required for a Plant SCADA Web
Server installation.
ASP
Application Development Features
ISAPI Extensions
Default Document
Directory Browsing
HTTP Errors
Common HTTP Features
HTTP Redirection
Static Content
WebDAV Publishing
Basic Authentication
Security Request Filtering
Windows Authentication
By default, only the following component is selected when you install a Web
Server.
Customize the default com-
l Plant SCADA Web Server for IIS
ponents
You can use this page to customize the list of components selected for install-
ation.
This page lists the local Windows groups the installer will create to manage
security (see Windows User Groups and Security Roles).
Local Windows™ Groups Note: This page will only appear if you are installing Plant SCADA on a
clean computer (one that has not hosted an earlier version). If you are
upgrading from an earlier version, equivalent user groups will already exist
on the computer.
If you want your current Windows user account to be included in the groups
that are being created, select Add the current Windows user to these
groups.
A dialog will let you know that the group membership changes will not occur
until after a restart.
If the installer detects that the computer has Windows Firewall enabled, you
will be asked if you would like the installer to modify your settings.
Windows™ Firewall
If you select Yes, Plant SCADA Runtime will be added to the list of authorized
programs.
Note: The installation folder and the 'User and Data' folder cannot be the
same, or a sub-directory of one another. You also cannot install in your Win-
dows user folder.
This page identifies the destination folder for any additional components that
you have selected (such as the Project DBF Add-in for Excel).
Base Folder
You can modify the folder locations by clicking the Change button.
This page lists the components that will be installed based on your selections.
Ready to Install the Program If required, use the Back button to make any modifications.
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 Microsoft® Windows® operating system,
enable the World Wide Web Services (HTTP) option in the Windows inbound firewall.
Once you have installed Plant SCADA Web Server for IIS, you will find the following
directories under the following folder:
\Inetpub\wwwroot\PlantSCADA
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 web deployment. Any subdirectories include the com-
ponents associated with a particular release (in this case, v2020 R2).
l The deploy folder includes the files associated with any web deployments (Plant
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 Plant SCADA online help.
See Also
You can view evidence of this virtual directory in Windows' Internet Information Ser-
vices (IIS) Manager. The PlantSCADA virtual directory is shown under the list of
default websites.
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 website, 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 set-
tings.
Setting Up Security
If you want to use a Web Server/Client for communications in your Plant 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 Secur-
ity Using IIS.
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 Plant SCADA system security (privilege/area settings) still
manages the control system, maintaining a primary level of security.
Note: To secure your system, the creation of Windows user groups to manage your
Web Server security is mandatory.
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.
PlantSCADA\ deploy \
read read access denied
#displayclient
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.
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 removing indi-
vidual accounts as needed.
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.
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.
l Web Client Administrator - an end user capable of modifying and managing pro-
jects deployed on the Web Server.
Create the client account user groups:
1. From the Computer Management tool, locate Local Users and Groups in the dir-
ectory 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.
Note: The Web Client Administrator group needs to be added to the “Configuration
Users” role in the Configurator. This is necessary so the Web Server can obtain the
project files. See Security Roles.
To test your security settings, add at least one user to each group. See Testing the Web
Server Security Settings.
5. Add the three client account user groups you created in the previous procedure to
the PlantSCADA folder.
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 PlantSCADA 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.
The differences, outlined in the table in Client Type Access Rights, need specific secur-
ity 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.
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 PlantSCADA folder.
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.
However, if security is a concern, deny the user access to the PlantSCADA folder before
you delete the user. This avoids a situation where the operating system doesn't imme-
diately acknowledge that a user account has been deleted, creating a short period where
a deleted user can still log on.
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.
You can use the Plant SCADA installer to set up a runtime-only client. This will create
dedicated runtime display client that does not include the components required to con-
figure a project.
See also
Before you install Plant SCADA, it is recommended that you install the latest updates
from Microsoft® for your operating system and system software.
Hardware Requirements
The hardware requirements for a Runtime Only Client are as follows.
CPU
2000
PassMark®
Cores 2
RAM 4 GB
HDD 10 GB
Screen
1920 x 1080
Resolution
Network 100 Mb
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 recommended to
use a higher performing PC with high clock speed when building complex user inter-
faces.
As a guide, the following will require high clock speed to maintain a client CPU load of
less than 25% on a single core:
l HD user interface with 50 complex Genies
l UHD4K user interface with 100 complex Genies.
If the deployment feature is being used, the HDD needs to have the required space for
the number of configured project versions + 2. You should remove unused project ver-
sions periodically to reduce HDD usage.
The suggested screen resolution supports lower and higher resolutions including 4K
UHD (3840 x 2160). However, 4K UHD will require a high clock speed CPU. A multi-
monitor client may also require a higher clock speed CPU and more memory.
Microsoft .NET Framework 4.8 is required. It will be installed by Plant SCADA if not
detected.
When .NET installation is complete, you may be prompted to restart your computer. If
this occurs, you should initiate a restart before you continue.
By default, only the following component is selected when you install a Web
Server.
This page lists the local Windows groups the installer will create to manage
security (see Windows User Groups and Security Roles).
Note: This page will only appear if you are installing Plant SCADA on a
clean computer (one that has not hosted an earlier version). If you are
upgrading from an earlier version, equivalent user groups will already exist
on the computer.
Local Windows™ Groups
If you want your current Windows user account to be included in the groups
that are being created, select Add the current Windows user to these
groups.
A dialog will let you know that the group membership changes will not occur
until after a restart.
If the installer detects that the computer has Windows Firewall enabled, you
will be asked if you would like the installer to modify your settings.
Windows™ Firewall
If you select Yes, Plant SCADA Runtime will be added to the list of authorized
programs.
Note: The installation folder and the 'User and Data' folder cannot be the
same, or a sub-directory of one another. You also cannot install in your Win-
dows user folder.
This page identifies the destination folder for any additional components that
you have selected (such as the Project DBF Add-in for Excel).
Base Folder
You can modify the folder locations by clicking the Change button.
This page lists the components that will be installed based on your selections.
Ready to Install the Program If required, use the Back button to make any modifications.
2. Select one of the following options to determine which project will be launched by
Runtime Manager:
l Run the project currently selected in Plant SCADA Studio — This is selected
by default and will run the project from Plant SCADA Studio.
l Run the project deployed from the Deployment Server — Select this option to
set up a computer for deployment. This option allows you to run the deployed
projects from the deployment server.
3. To apply your settings, click the Configure button.
Note: If Plant SCADA Runtime is running as a service and the Project Run Path
option in the Configurator is changed to Run the project deployed from the
Deployment Server, you need to restart the Runtime Manager service for deploy-
ment to function correctly.
If you intend to use Plant SCADA's Deployment feature to distribute project versions to
this client, you will need to use Configurator to connect the computer to a Deployment
Server. See Configure a Deployment Client.
You need to select Run Runtime Manager as a service under the following cir-
cumstances:
l When a deployment client is configured on a computer and you want to push project
updates using "Force" mode.
l If you are using encrypted communications, and the current user on a deployment
client may not have required privileges.
Note: If you are using Deployment to run a project and do not select the Run
Runtime Manager as a Service option, you will need to manually start the Plant
SCADA Runtime Manager before deploying the project.
The AVEVA Enterprise Licensing system is a common platform that allows you to man-
age AVEVA Enterprise Software product licenses. This licensing system is composed: of
a browser-based License Manager and a License Server that together allow you to share
and deliver licenses for your installed products.
The system was introduced to allow centralized license management, remove the need
for dongles, and increase license security by use of activated licenses. It supports flexible
topologies for any size system.
For Plant SCADA, the AVEVA Enterprise Licensing system is used to manage licenses
for clients connecting to the AVEVA Industrial Graphics Server.
The following describes the components of the AVEVA Enterprise Licensing system.
License Manager
The License Manager allows you to access and maintain licenses for certain AVEVA
Enterprise Software products in your different environments using its scalable, flexible
design features:
l Browser-based for scalability and ease of use; can be remotely accessed by any of the
supported web browsers.
l Light-weight, standalone software you can install on the same node as the License
Server computer, or on any other node based on your deployment needs.
l Manage one or multiple License Servers to best organize and manage the licenses in
your unique environment.
l Access details about your licenses, such as usage information, from the License Man-
ager interface.
License Server
License Server provides the functionality to acquire, store, maintain, and serve licenses
to your installed AVEVA Enterprise software.
l Licenses are hosted and maintained on the License Server.
l Securely serve any type of software applications being licensed, including Windows
browsers, tablets, and mobile devices.
l Provide current license usage information.
Activation Server
Activation server is a cloud-based Internet-accessible server to which the License Man-
ager connects for license activation. The License Manager connects to the AVEVA Activ-
ation Server in the Cloud only temporarily during the activation process.
Installed Products
Once the AVEVA Enterprise Software product is installed it relies on the licensing sys-
tem to enable its functionality. During product installation you decide from which
License Server you want the product to get its license.
l If a License Server is installed on the same computer as the product, it will use that
one as the default.
l If the product is installed on a different computer than the License Server, you can
point the product to License Server computer.
All the products installed on the same computer would point to the same License
Server.
Licensing Workflow
The following example of the licensing workflow assumes that both License Manager
and License Server are installed on the same computer, and that the computer can con-
nect to the Internet.
1. Purchase one or more AVEVA Enterprise Software products:
Along with your installation media or downloads, you will receive one or more
entitlement files containing license details.
2. Start License Manager:
It opens in a browser window and accesses the installed License Manager com-
ponents.
3. Select the License Server:
Use the License Manager to select an available server to host the licenses you
want to activate. You can also add a new license server.
4. Import the entitlement file:
Once you import the entitlement file, the License Manager displays the available
licenses.
The entitlement file contains information for specific product licenses that are
imported into the License Manager to activate purchased licenses. It is sent to you
in an email upon purchase of your product licenses. It is in a zipped .xml file
format.
5. Activate licenses:
License Manager connects to the AVEVA Enterprise Activation Server over the
Internet to activate the selected licenses on the License Server. The Activation
Server activates licenses on the License Server.
6. Manage your licenses:
Licenses are now available for their respective product to use. You can now:
l activate new licenses
Note: For more detailed information see the Enterprise License Manager User Guide,
available from the AVEVA branch of the Windows Start menu.
See Also
Before you install this component, it is recommended that you install the latest updates
from Microsoft® for your operating system and system software.
Hardware Requirements
The hardware requirements for a Enterprise License Server are as follows:
Cores 4
Memory 4 GB
Microsoft .NET Framework 4.8 is required. It will be installed by Plant SCADA if not
detected.
By default, the following components are selected when you install an Enter-
Customize the default com- prise License Server.
ponents
l AVEVA Enterprise License Manager
l AVEVA Enterprise License Server.
If you are going to connect the computer to a License Server on a remote com-
puter, you only need to install the License Manager.
This page lists the local Windows groups the installer will create to manage
security.
A dialog will let you know that the group membership changes will not occur
until after a restart.
If the installer detects that the computer has Windows Firewall enabled, you
will be asked if you would like the installer to modify your settings.
Windows™ Firewall
If you select Yes, Plant SCADA Runtime will be added to the list of authorized
programs.
Note: The installation folder and the 'User and Data' folder cannot be the
same, or a sub-directory of one another. You also cannot install in your Win-
dows user folder.
This page identifies the destination folder for any additional components that
you have selected (such as the Project DBF Add-in for Excel).
Base Folder
You can modify the folder locations by clicking the Change button.
This page lists the components that will be installed based on your selections.
Ready to Install the Program If required, use the Back button to make any modifications.
To set up an Enterprise License Server, open Configurator and go to the AVEVA Enter-
prise License Server page located under AVEVA Enterprise Licensing Platform.
Note: Before running the Configurator, make sure that ports 55555 and 59200 are
open.
Server Port
The default Server Port is 55555. You can specify a different port, if necessary.
Agent Port
The default Server Port is 59200. You can specify a different port, if necessary.
You can test your connection to the License Server by selecting Test Connection. Press
Configure to save all your changes.
If you chose to install Plant SCADA Drivers, the communication drivers installation will
commence towards the end of the main product installation.
The available drivers will be extracted to a temporary folder, then the Select Drivers dia-
log will be displayed.
The Select Drivers dialog lists the drivers that are available for installation. There are
certain drivers that are necessary for Plant SCADA to function correctly. These are not
displayed in the list and will be installed automatically.
Note: With the release of Plant SCADA 2020 R2, a classification system for the driver
portfolio was introduced to indicate the level of ongoing maintenance that customers
can reasonably expect for each driver. In line with these classifications, the number
of drivers included by default with the Plant SCADA installation media has been
reduced to a set of ‘core’ drivers that have undergone recent updates. All other
drivers continue to be available for download from the Communication Drivers
Select the drivers that you wish to install. Commonly used drivers are selected by
default. You can select every driver by clicking the Select All button. Then click the
Next button to display a confirmation list of the drivers that will be installed.
You will be advised if any drivers that are time limited or not supported by your oper-
ating system. If you see that any of the drivers in the list are subject to limitations, click
the Back button and deselect them from the previous dialog.
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.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
When you are satisfied that the correct drivers will be installed, click the Next button to
install the selected drivers.
If you want to install additional drivers at a later time, you can run the communications
driver installer from the user interface or the command line. For details see Install Addi-
tional Communication Drivers.
Note: If you are using the Microsoft® Windows operating system 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 on the computer.
114
Chapter 13: Install OPC Factory Server
The Plant SCADA installer allows you to install a copy of Schneider Electric's OPC Fact-
ory Server v3.62.
Based on the OPC protocol, OPC Factory Server enables Windows-based OPC client
applications to communicate with the following Schneider Electric PLCs:
l TSX Compact
l Micro
l TSX Momentum
l TSX/PCX Premium
l Quantum
l M340
l TSX Series 7
l TSX S1000.
Note: You must install Plant SCADA before you install the OPC Factory Server to
allow the OFS Server to be licensed using the Plant SCADA license key. This will
allow the correct Part and Serial number combination to be registered during the
OFS Server installation.
To install OPC Factory Server, launch the Plant SCADA installer and select Schneider
Electric OPC Factory Server.
\Extras\OFS vx.xx\Documentation
To restrict access to Plant SCADA's sensitive components, only users with relevant per-
missions can perform certain security-related operations. To help manage these per-
missions, Plant SCADA uses a set of security roles. Each role provides a different level
of access to features, applications and project resources.
The following security roles are used on all Plant SCADA computers.
If you have installed Industrial Graphics Server on a computer, two additional Security
Roles will exist.
During installation, by default the local Windows user groups are associated with these
security roles as members (see Windows User Groups and Security Roles).
You can view the current associated members with the security roles via the Security
Roles page under Plant SCADA in Configurator. When you select a role, the existing
members associated with the role will be listed in the Members of... section.
It is recommend to replace the local Windows groups associated with these security
roles, with your own domain groups. If required, you can also assign additional user
accounts or groups to a role (see Modify the Members of a Security Role).
See Also
Directory Security
By default, the Windows® User Groups created by the Plant SCADA installer are asso-
ciated with these roles (see Windows User Groups and Security Roles). If required, you
can change the members that are associated with each security role. You can also delete
the default groups and replace them with your own.
3. Select a security role displayed in the table. The existing members associated with the
role will be listed in the Members of... section.
4. To add more members to the security role, click Add. The Select Users or Groups
dialog box opens.
5. Under Enter the object names to select type the name of local or domain group, that
you want to assign to the role, and then click OK.
You can use the Check Names button to verify if the entered names are valid.
Note: You can add a maximum of 10 members to a security role. To manage the
memberships through normal Windows group management practices, it is recom-
mended that you add a minimal number of members per security role. It is ideal to
have one domain group per role.
Note: When removing members from the security roles, make sure that each role has
at least one member before you apply the changes.
See Also
Security Roles
Add the Required Users to the Runtime Users Role
If you have configured Plant SCADA to use any of the following features, you will need
to ensure that the relevant user is added to the Runtime Users role so that runtime can
be launched.
l If Runtime Manager is running as a service and you are not using the default user
account “NT SERVICE\Citect Runtime Manager”.
l If you are using a local CTAPI application that is not being run by the currently
logged in user (for example, the CTAPI application is running as a Windows service
under a different user account).
To determine which users you need add into this role, check the following:
l If Runtime Manager is running as a service, check the properties of the "Plant
SCADA Runtime Manager" service. If this is not running under the "NT
SERVICE\Citect Runtime Manager" account, then the user this service is running
under will need to be added to the Runtime Users role.
l If you are running a CTAPI application as a different user to the currently logged in
user, then the user account this applications runs under needs to be added to the
Runtime Users role.
See Also
Directory Security
The Plant SCADA directories under "%PROGRAMDATA%\AVEVA Plant SCADA 2020
R2" are protected by Windows® access control lists (ACLs) to avoid unauthorized
access. During installation, access permissions for these directories will be granted (with
certain operational restrictions) to the members of the following Plant SCADA Security
Roles.
Note: In addition to the above table, the required permissions will be granted to the
service accounts for Plant SCADA services. Full Control permission will also be gran-
ted to the local Administrators group and System account to access these directories.
See Also
Security Roles
Plant SCADA 2020 R2 includes the following new features or changes in functionality.
Once you have installed this version, refer to the documentation for more information
on how to reconfigure your projects to take advantage of the new features and
improved functionality.
The rebranding incorporates several changes, including updates to splash screens and
graphics, icons, installer and installation directories, start menu paths, and more.
To determine the new directory locations, see View a Project's Folders in the Plant
SCADA user documentation.
Industrial Graphics are accessible in Plant SCADA Studio for integrated browsing and
filtering. From here, they can be launched within the new Industrial Graphics Editor for
all editing activities. AVEVA Industrial Graphics are accessed by clients via an Indus-
trial Graphics Server. It authenticates clients details and provides access to the graphical
and functional content.
For more information, see AVEVA Industrial Graphics in the Plant SCADA user doc-
umentation.
IPv6 Support
Plant SCADA 2020 R2 supports Internet Protocol version 6 (IPv6) and will accept 128 bit
IP addresses (including any acceptable abbreviations). For example:
l 2001:0db8:0000:0000:0000:8a2e:0123:1234
or
l 2001:db8::8a2e:123:1234 (abbreviated).
You can now operate a Plant SCADA system on an IPv6 network. IPv6 protocol can be
used for communication between servers and clients, and for any drivers that support
IPv6.
IPv6 support can be enabled via the Network Model page of the Setup Wizard.
Graphics Usage
Supporting both Plant SCADA native graphics and AVEVA Industrial Graphics, the
new Graphics Usage feature allows you to identify the graphical references that exist in
your system. For example, you can confirm where a Genie or symbol is used, or you can
determine if a project contains any unused graphics.
To take advantage of this feature, see the new Used By section of the Libraries view in
the Visualization activity (see Browse Libraries in Plant SCADA Studio and/or Browse
Industrial Graphics Libraries in Plant SCADA Studio).
Driver Classifications
As part of an ongoing effort to set clear expectations and provide better support to our
customers, we have introduced a classification system for our driver portfolio to com-
municate the level of ongoing maintenance and version updates that customers can reas-
onably expect. These classifications and status of each driver can be found online at
https://gcsresource.aveva.com/PlantSCADA/Drivers/.
In line with these classifications, we have limited the number of drivers included by
default on the Plant SCADA installation media to a reduced set of ‘core’ drivers that
have undergone recent updates, however all other drivers continue to be available for
download from the Communication Drivers page at the AVEVA Knowledge and Sup-
port Center located at https://softwaresupport.aveva.com/.
Note:
The following features are no longer supported with this release of Plant SCADA.
• EcoStruxure Web Services (EWS) are no longer supported. You will not be able to
create or use an EWS server or client.
• The Vijeo Web Gate Control has been deprecated and is no longer part of the Plant
SCADA installation. The control will still work with Plant SCADA. However, to con-
tinue to use it you will need to manually reinstall it from another source as it will
have been uninstalled when the previous version of Citect SCADA was uninstalled.
• The Pelco ActiveX Control has been deprecated and is no longer part of the Plant
SCADA installation. If you have upgraded your computer from a previous version
with this control installed, it will continue to function. However, it is recommended
that you communicate with Pelco cameras using a different method.
128
Chapter 16: Upgrading to Plant SCADA 2020 R2
This chapter describes the process required to migrate from and existing installation of
Citect SCADA to Plant SCADA 2020 R2.
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 updates available. The update
may have a fix for the automatic upgrade and may be required to be installed before
restoring the project. Please refer to the Product Hub page of the AVEVA Know-
ledge & Support Center website at https://softwaresupport.aveva.com.
Before you review this information, check that you have the necessary hardware and
software required to run this version. See the requirements specified for the type of
Citect SCADA computer you are upgrading in the relevant section of the Install Guide.
When upgrading to Plant SCADA 2020 R2 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 of Citect SCADA to Plant SCADA 2020 R2.
For upgrading to intermediate versions specified in the upgrade path (for example,
v2015 or v2016), refer to the documentation for those versions.
Upgrade Method
Before you plan to upgrade to Plant SCADA 2020 R2, consider whether your
SCADA system can afford downtime and whether your historical information needs to
be available. The upgrade method you choose will depend upon this.
Upgrade Path
Upgrade path refers to the versions you need to install to get from your current version
of Citect SCADA to Plant SCADA 2020 R2.
Some versions of Citect SCADA included substantial changes to the product, which
require incremental upgrades involving intermediate steps between versions. The num-
ber of necessary steps will depend on whether you do an offline or online upgrade.
l For an offline upgrade to Plant SCADA 2020 R2, you can upgrade a project directly
from any version of Citect SCADA from 5.21 onwards.
l For an online upgrade to version 2020 R2, you can go directly from the following ver-
sions:
l Citect SCADA v2018 Update 29 (March 2021) or later.
Note: Any patches released from July to October 2020 should not be used in an
online upgrade scenario.
Offline Upgrade
Note: This is the basic upgrade process. You will need to perform these steps even if
you choose to use the Online Upgrade method.
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.
• SE.Asb.Deployment.Server.WindowsService.exe.config
Deployment con-
figuration files
• SE.Asb.Deployment.Node.WindowsService.exe.config.
[Data]\<Project
Alarm Database (for
Name>\<ClusterName.AlarmServerName>.
v2015 or later)
For each alarm server you have in your system, a corresponding
Alarm Database will exist. You need to backup all alarm databases.
Trend files: *.HST The path and names of these files are defined on the trend tag itself
File Description
These files contain the code that is executed on your reports. They
Report Files
are located in the [CtEdit]User\<Project Name> folder.
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.
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 as
Additional Files
it could contain runtime files used by custom code in the project.
If you are aware of any driver hotfix in your system, backup this
driver DLL which is located in the Bin directory where Plant SCADA is
installed.
Driver Hotfixes
Note: Before you backup a project from version 2016 (or earlier) for upgrade to ver-
sion 2018 R2 (or later), you should check if the Citect.ini file uses the parameter
[CtEdit]ANSIToOEM. If so, confirm that the parameter is set to the required value.
Then perform an Update Pages with the Fast Update Pages option disabled. This
will back up the correct ANSI character values. Be aware that the Fast Update Pages
option is not available from version 2018. If you are using a later version and have
noticed inconsistencies due to the misconfiguration of [CtEdit]ANSIToOEM prior to
an upgrade, contact technical support.
If your license is out of support, contact your local authorized AVEVA distributor. If
you don't know who your local distributor is, send an email to scada.orders@aveva.com
with your license and site ID details. For more information about licensing in Plant
SCADA 2020 R2, refer to the Licensing section of the Plant SCADA documentation.
Note: Do not uninstall Platform Common Services (PCS) if upgrading from Plant
SCADA 2018 R2.
If this message is not displayed, you can force an update of all projects by setting the
[CtEdit]Upgrade INI parameter to 1. Close and re-open Plant SCADA Studio. Once you
re-open Plant SCADA Studio, you will get a warning message. After clicking Yes all pro-
jects will be upgraded.
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 the
topic Citect.INI Parameters in Version 2020 R2 in the Plant SCADA documentation.
Refer to the Plant SCADA documentation for instructions on compiling your project.
Note: If you are upgrading from version 2018 R2, the compiler warning message
W1041 will be generated if the Address field for your network address is an IP
address. If this occurs and you want to use encryption, you need to set the DNS
Name field in the Topology|Computers view for the matching network address to
the DNS Name of the computer.
Alarms
Convert your alarm database in the Data directory with the following steps:
1. Check that you have placed your backed-up alarm database in the directory defined
by the [CtEdit]Data parameter.
2. Delete any legacy database files.
Prior to version 7.30, Citect SCADA used the following alarm database files:
l <project>_<cluster>_ALMSAVE.DAT
l <project>_<cluster>_ALMINDEXSAVE.DAT
Or:
l ALMSAVE.DAT
l ALMINDEXSAVE.DAT.
If you are upgrading from a version prior to 7.30, these legacy files are converted to a
new alarm database format when the alarm server is launched. Once this occurs, these
files are no longer required.
If you are upgrading from a version later than 7.30 (2015 or later), you should delete
these files prior to starting the alarm server. Confirm that the directory specified by the
[Alarm]SavePrimary parameter does not contain the legacy alarm database files listed
above.
Note: If you do not delete these files, in some circumstances the legacy data from
these files may replace or merge into your current alarm database when you
launch the alarm server.
Trends
Follow these steps to convert the files:
Note: If you are changing the trend tag name, use the trend renaming tool available
on the Product Hub page of the AVEVA Knowledge and Support Center.
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.
Migrate 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. The hardware key is a physical key that plugs into either the parallel port
or USB port of your computer. To upgrade the key, a new authorization code is
required which can be created by using the AuthCode Generator. To prepare the sys-
tem, 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. You can update the hardware/software key in the Licensing activity in Plant
SCADA Studio.
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
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 sys-
tems to individually co-exist on the network for a period of time. When isolated, the sys-
tems 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. If so, it is recommended that you back up
the driver files located in the product ‘bin’ directory. Existing specialty drivers that are
used may be required for the new version. The Connectivity Hub on the AVEVA Know-
ledge & Support Center can be checked for driver availability and compatibility at
https://softwaresupport.aveva.com.
Note: Plant SCADA 2020 R2 introduced a classification system for the driver port-
folio that reduced the number of drivers included by default with the Plant SCADA
installation media. Some drivers may need to be downloaded from the Connectivity
Hub at the AVEVA Knowledge and Support Center.
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
process 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, check the Tech Note "Upgrading with a modified CITECT.FRM file"
(TN3795) on the AVEVA Knowledge & Support Center.
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
project 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.
Online Upgrade
An online upgrade takes advantage of Plant SCADA's native server redundancy to
avoid loss of data and minimize downtime on a production system. There are two ways
to perform an online upgrade:
l Upgrade one by one — firstly primary servers, then clients and then standby servers.
l Upgrade side by side — where a new set of server and clients runs in parallel.
If the primary server has a lower version of AVEVA Plant SCADA than the standby
server, then the server communication will be lost. So, make sure to avoid the following
scenarios during online upgrade:
l Shutting down the upgraded primary server before the standby is upgraded.
l Stopping both the servers when the upgrade is in progress.
l Starting up the non-upgraded standby server, when the upgraded primary server is
running.
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.
allow your upgraded servers to accept connections from the older version.
l [Alarm]EnableStateLogging: Set this parameter to 1 to allow logging the alarm
Note: Before you perform an online upgrade from Citect SCADA version 2018 or
2018 R2, you need to install the latest product update. Updates for Plant SCADA are
available from the Product Hub page of the AVEVA Knowledge & Support Center
website at https://softwaresupport.aveva.com.
Note: For an online upgrade from v2018, encryption needs to be disabled or set
to Accept encrypted and non-encrypted connects (mixed mode). You can then
modify your encryption settings when the upgrade process is complete.
7. Place the backed-up Alarm database in the [CtEdit]Data directory. This will allow a
quicker synchronization of alarm servers.
8. Restart the primary server, which is now upgraded.
9. Plant SCADA v2020 R2 server will synchronize its alarm database with the running
v2018 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. Upgrade your client nodes one by one.
11. Configure your System Management Server and encryption settings based on your
requirements.
12. Check the Server Authentication section of the Computer Setup page in Con-
figurator under Plant SCADA. If you have selected Configure Server Password,
make sure you use the same password as the one defined above in step 5.
13. Shutdown runtime on the standby server.
14. When the newly upgraded version 2020 R2 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.
15. Upgrade Plant SCADA on this server according to the offline upgrade procedure.
16. Set up the Server Password in the Configurator, Plant SCADA, Computer Setup
page.
17. Configure your System Management Server and encryption settings based on your
requirements.
18. Restart the standby server, which is now upgraded.
19. Check functionality of the system as a whole.
20. Test redundancy by switching off the primary server and checking that the standby
takes over and clients switch over.
Note: Do not uninstall Platform Common Services (PCS) if upgrading from Plant
SCADA 2018 R2.
5. Set up the Server Password in Configurator's Computer Setup page. See Use Con-
figurator to Set Up a Runtime Computer.
6. Configure your System Management Server and encryption settings based on your
requirements.
The following table indicates the encryption settings that will align successfully
across version 2020 R2 and 2018 R2.
Encryption
Communication Communication Communication
setting on Mixed Mode
OK OK OK
2018 R2
7. Place the backed-up Alarm database in the [CtEdit]Data directory. This will allow a
quicker synchronization of alarm servers.
8. Restart the primary server, which is now upgraded.
9. Plant SCADA v2020 R2 server will synchronize its alarm database with the running
v2018 R2 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
available from the main kernel window of the Alarm Process as well as the syslog.
10. Upgrade your client nodes one by one.
11. Configure your System Management Server and encryption settings based on your
requirements.
12. Check the Server Authentication section of the Computer Setup page in Con-
figurator, under Plant SCADA. If you have selected Configure Server Password,
make sure you use the same password as the one defined above in step 5.
13. Shutdown runtime on the standby server.
14. When the newly upgraded version 2020 R2 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.
15. Upgrade Plant SCADA on this server according to the offline upgrade procedure.
16. Set up the Server Password in the Configurator, Plant SCADA, Computer Setup
page.
17. Configure your System Management Server and encryption settings based on your
requirements.
18. Restart the standby server, which is now upgraded.
19. Check functionality of the system as a whole.
20. Test redundancy by switching off the primary server and checking that the standby
takes over and clients switch over.
Note: Please review the changes that have been made to the Windows User Groups
that are created for version 2020 R2. See Windows® User Groups and Security Roles.
Note: Version 2020 R2 should not have encryption enabled with Accept encryp-
ted and non-encrypted not selected, otherwise the servers will not be able to
communicate. Mixed Mode should be used, or encryption should be disabled.
My system is performing slowly even though Hardware and software requirements are met
Check your system’s power options: Control Panel, Power Options.
Migration Tool
The automatic update that occurs when you initially launch Plant SCADA 2020 R2 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 2020
R2.
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
project for final migration. This tool will accommodate the changes in project func-
tionality that are incorporated in 7.x and subsequent versions.
Note: Some of the features introduced in 2020 R2 of Plant SCADA require changes
in the project data from version 6.x.
After upgrading, confirm and adjust the configuration of I/O devices in your project.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
Note: Before you use the Migration Tool, is recommended that you familiarize your-
self with the process that it performs, and the preparatory steps that you need to
carry out with your existing projects.
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
successful migration (see Remove Obsolete Memory and Alarm
Devices).
Remove obsolete
Memory and Note: Do not select this check box when you run the tool for the first
Alarm devices time on a project that contains any included projects which are
shared with more than one master project. If you want to delete
obsolete devices under these circumstances, you can run the tool a
second time using this option if the migration is successful after it is
run the first time.
Select this option to convert legacy menu entries to the format neces-
Copy XP_Style
sary for the new menu configuration system. By default, this option is
menu into Tab_
unchecked to avoid potential compile errors that may occur if the leg-
Style menu
acy menu.dbf contains functions which have been removed.
Migrate included Select this option to migrate the included projects associated with the
projects selected project (see Migrate Included Projects).
Select this option if you have an existing database that you want to
migrate into this version. When upgrading from an earlier version, and
the "PARENT" field of the equipment table was used, you should select
this check box. Otherwise existing data from the PARENT field will be
Migrate equip- ignored. If runtime browsing is used, the PARENT field will return the
ment database equipment parent (the substring of the equipment name without the
last '.' and anything after that).
Select this option if you want to migrate devices that currently use the
Migrate ABCLX to
ABCLX driver to the OPCLX driver. Select the Configure button to indic-
OPCLX
ate which I/O devices you would like to migrate.
Option Description
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 samples) for all trends that have no storage method defined. Use
Migrate
this option to stop the compiler error message "The Storage Method is
Trend/SPC stor-
not defined". In previous versions, a blank storage method would
age method
default to scaled. However, this is no longer supported, resulting in the
compile error message.
If you select this option, computers will be created from the servers and
Create com-
network addresses that you have configured for a project and its
puters from Net-
include projects. This option distinguishes whether a computer has mul-
work Addresses
tiple IP addresses.
Note: If 'Copy XP Style menu into Tab_Style Menu' and 'Migrate Included Pro-
jects' are both selected when the migration tool runs, the following message will
be displayed: "Copying menus of included projects may lead to conflicts. Any
conflicts will need to be manually corrected". To avoid this from occurring, it is
recommended 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'.
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.
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.
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 Plant 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
property 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 vari-
able 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.
Alarm Devices
In previous versions of Plant 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. The Alarm Servers will now publish
Alarm Properties.
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.
Local variables have fewer fields than variables; the following table shows the mapping
from variable to local variable when copying their data.
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.
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.
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.
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
projects sequentially. This could cause the deletion of an I/O Device in the first master
project 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.
After upgrading, confirm and adjust the configuration of all I/O devices in your project.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
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.
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.
154
Chapter 17: Uninstall or Change Components
You can uninstall Plant SCADA components using the Programs and Features page in
Windows® Control Panel. For a Plant SCADA installation, the list of programs can
include any of the following components:
l ArchestrA Data Store
l AVEVA Industrial Graphics Server
l AVEVA Plant SCADA 2020 R2
l AVEVA Plant SCADA 2020 R2 Web Server
l AVEVA Plant SCADA Connectivity Server
l AVEVA Plant SCADA Deployment
l AVEVA Plant SCADA Project DBF Addin
l AVEVA Plant SCADA Security Configuration
l Platform Common Services
l Schneider Electric Floating License Manager
l Sentinel System Driver Installer.
Note: If you want to add additional components to your Plant SCADA installation,
you will need to uninstall the existing Plant SCADA components before you can run
a new installation. You do not need to uninstall Platform Common Services, Arches-
trA Data Store, Floating License Manager or the Sentinel System Driver.
If the Change or Repair option is not available for a component, you will have to re-
install it from the Plant SCADA installation media to make any required modifications.
Note: If you are using the Microsoft® Windows operating system 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 on the computer.
Note: Installing the Platform Common Services Service Repository may cause
interoperability issues, if you install other AVEVA products on the same com-
puter.
AVEVA will periodically publish software updates for Plant SCADA. You can down-
load these updates from the Product Hub page of the AVEVA Knowledge & Support
Center website at https://softwaresupport.aveva.com.
To fully uninstall an update, you need to uninstall each component individually. These
components can include the following:
l AVEVA Plant SCADA 2020 R2
l AVEVA Plant SCADA Connectivity Server
l AVEVA Plant SCADA Deployment
l AVEVA Plant SCADA Security Configuration.