You are on page 1of 47

AVEVA™ Enterprise SCADA RealTime

Installer Guide
Release 2021
MONTH 2020

aveva.com
© 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
The Schneider Electric industrial software business and AVEVA have merged to trade as AVEVA Group plc, a UK
listed company. The Schneider Electric and Life is On trademarks are owned by Schneider Electric and are being
licensed to AVEVA by Schneider Electric.
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 furni shed under
a license agreement. This software may be used or copied only in accordance with the terms of such license
agreement.
ArchestrA, Aquis, Avantis, Citect, DYNSIM, eDNA, EYESIM, InBatch, InduSoft, InStep, IntelaTrac, InTouch, OASyS,
PIPEPHASE, PRiSM, PRO/II, PROVISION, ROMeo, SIM4ME, SimCentral, SimSci, Skelta, SmartGlance, Spiral
Software, Termis, WindowMaker, WindowViewer, 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: Monday, July 20, 2020
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 0HB. UK
https://sw.aveva.com/
For information on how to contact sales and customer training, see https://sw.aveva.com/contact.
For information on how to contact technical support, see https://sw.aveva.com/support.
Contents
Chapter 1 RealTime Introduction................................................................................................. 5

Understanding RealTime Installation and Configuration.................................................................. 5


Locating the RealTime Installation and Configuration Files ............................................................. 5

Chapter 2 RealTime Pre-Installation Configuration....................................................................... 7

Pre-Installation Configuration Checklist .......................................................................................... 7

Prepare Your Environment ............................................................................................................. 7


Before You Begin Preparing Your Environment.............................................................................. 8
Preparing to Install Windows Operating System (OS) ..................................................................... 8
Changing the Time Zone .............................................................................................................. 8
Configuring the System Localization Settings................................................................................. 9
Configuring TCP/IP for a Static IP Address ................................................................................... 10
Changing the Computer Name ................................................................................................... 11
Changing the Default Name of a Network ................................................................................... 11
Joining a Computer to the Domain ............................................................................................. 12
Disabling the Built-in Administrator Account............................................................................... 12

Install AVEVA Enterprise SCADA ................................................................................................... 13


Before You Begin....................................................................................................................... 13
Setup.ps1 Parameters ............................................................................................................ 13
Features to Install for Each of the AVEVA Enterprise SCADA Products ....................................... 15
Installing AVEVA Enterprise SCADA on the First System in the Domain ......................................... 17
Installing AVEVA Enterprise SCADA on Additional Systems in the Domain ..................................... 21

Configure AVEVA Enterprise SCADA Post-Installation.................................................................... 25


Moving Computers into the Appropriate Organizational Unit (OU) on the Domain ........................ 25
Configuring the Product Silos ..................................................................................................... 25
Setting Service Principle Names (SPNs) for the Active Directory Application Mode (ADAM) Service 26

Generate and Install AVEVA Enterprise SCADA Certificates ........................................................... 27


Certificate Generation and Installation Prerequisites................................................................... 27
Generating and Installing Certificates for the First Enterprise or Single Development System Machine 27
Generating and Installing Certificates on All Other AVEVA Enterprise SCADA Servers .................... 28
Generating and Installing LDAP Server Certificates on the Development Server ............................ 28
Installing Certificates on the RabbitMQ/Skelta Server.................................................................. 29

Request and Install an AVEVA Enterprise SCADA License ............................................................... 31


Running the Licensing Assistant.................................................................................................. 31

Release 2021 Page 3

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
Chapter 3 RealTime Arbitration Configuration ........................................................................... 35

Arbitration Configuration Checklist............................................................................................... 35

Configure the Arbitration Network Driver Interface Specification (NDIS) Protocol Driver ............... 35
Adding the ArbAdapterName Registry Setting ............................................................................. 35
Installing the Arbitration Network Driver Interface Specification (NDIS) Protocol Driver ................ 36

Disable Dynamic Domain Name System (DDNS) on Arbitrated Servers .......................................... 37


Disabling Dynamic Domain Name System (DDNS) on Arbitrated Servers....................................... 37
Understanding Dynamic Domain Name System (DDNS) on Arbitrated Servers .............................. 37
Disabling Dynamic Domain Name System (DDNS) Network Card Updates ..................................... 38
Ensuring Previous Dynamic Domain Name System (DDNS) Entries are Not Deleted ....................... 38

Chapter 4 RealTime Installation and Configuration..................................................................... 41

RealTime Installation Checklist ..................................................................................................... 41

Configure the RealTime Computers .............................................................................................. 42


Move Computers into the Final Organizational Unit .................................................................... 42
Updating Computers with the New Organizational Unit (OU) on the Domain ............................ 42
Change the Settings for the Open Platform Communication (OPC) Data Access (DA) Server........... 42
Changing the Settings for the Open Platform Communication (OPC) Data Access (DA) Server..... 42
Configure AVEVA Enterprise SCADA Open Platform Communication (OPC) Data Access (DA) Server DCOM
................................................................................................................................................ 43
Configuring AVEVA Enterprise SCADA Open Platform Communication (OPC) Data Access (DA) Server DCOM
............................................................................................................................................ 43
Load Message Sets for Projects with No Custom Message Sets................................................. 45
Manually Configure Selective Startup for RealTime Services ........................................................ 45
Disabling RealTime Services .................................................................................................... 45
Enabling RealTime Services..................................................................................................... 46

Appendix A: RealTime Troubleshooting ........................................................................................ 46


Unmonitored Processes ............................................................................................................. 47

Page 4 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
CHAPTER 1
RealTime Introduction
Understanding RealTime Installation and Configuration
Before installing and configuring RealTime, there is some important information we want you to know.

Locating the RealTime Installation and Configuration Files


The RealTime silo is the repository of the following features:
 RealTime
 Open Platform Communications (OPC) Browse Processor
 OPC Data Acquisition (DA) Server
 Management of Change plugins
 Liquid Management System (LMS)
 PI
Installation-related files for RealTime are located under %DNAInstallRoot%\RealTime (for example, C:\Program
Files\AVEVA\DNA\RealTime). Data-related files containing the project configuration and extensions,
meanwhile, exist under %DNADataRoot%\RealTime (for example, C:\AVEVA\DNA\RealTime).

Release 2021 Page 5

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
CHAPTER 2
RealTime Pre-Installation Configuration
Pre-Installation Configuration Checklist
Before installing and configuring the product, complete the pre-installation configuration procedures below.

Order Step Description

1 Prepare Your The procedures outlined in this section must be performed once
Environment on page 7 per computer prior to the installation of any service on that
computer. The procedures can be skipped if you are installing a
service on an existing AVEVA Enterprise SCADA computer.
2 Install AVEVA Install the desired products using the AVEVA Enterprise SCADA
Enterprise SCADA on installer located on the media.
page 13
3 Configure AVEVA Important: Before performing post-installation configuration
Enterprise SCADA steps on any machine, you must ensure that the valid
Post-Installation on configuration is present in Active Directory Application Mode
page 25 (ADAM).
Use the AVEVA Enterprise SCADA Network Management Console
(NMC) to add related computers and all installed services to the
corresponding AVEVA Enterprise SCADA system.
After installing AVEVA Enterprise SCADA, move computers to the
appropriate Organizational Unit (OU) on the domain, configure
the product silo, and set the Service Principle Names (SPNs) for
the Active Directory Application Mode (ADAM) service.
4 Generate and Install To enable encrypted communications and mutual authentication
AVEVA Enterprise between AVEVA Enterprise SCADA software products, you must
SCADA Certificates on first generate and install the appropriate certificates.
page 27
5 Request and Install an Use the Licensing Assistant to request and install an AVEVA
AVEVA Enterprise Enterprise SCADA license.
SCADA License on page
31

Prepare Your Environment


The procedures outlined in this section must be performed once per computer prior to the installation of any
service on that computer. The procedures can be skipped if you are installing a service on an existing AVEVA
Enterprise SCADA computer.

Release 2021 Page 7

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

Before You Begin Preparing Your Environment


Note: You must install and configure AVEVA Enterprise SCADA with each computer in the "New Computers"
organization unit (OU). The only exception to this rule is when you configure a Remote Desktop Server, which
must be moved to that OU prior to installing.

Preparing to Install Windows Operating System (OS)


Before you install Microsoft Windows Server 2019, review the following installation requirements:
 You must install Windows Server 2019 on the Domain Controller (DC), Engineering Station (ES)/Decision
Support System (DSS), Main1/Main2, and Backup.

Note: The Engineering Station is also commonly known as the Development Station.

 The ezXOS system typically has Windows 10 installed.


 After installing Windows 10, AVEVA recommends preventing the hard disk from going to sleep:
a. Click Start > Windows System > Control Panel > Hardware and Sound > Power Options.
The Power Options window opens.
b. Under Preferred plans, select High Performance.
c. Click Change plan settings.
The Edit Plan Settings window opens.
d. Click Change advanced power settings.
The Power Options dialog box opens.
e. Expand the Hard Disk node.
f. In the Setting (Minutes) field under Turn off hard disk after, type 0.
This setting prevents your hard disk from entering Sleep mode.
g. Click Apply.
h. Click OK.
i. Restart the machine.
 If you are installing the operating system for a Historical computer (a computer running the historical
service), you MUST remove any existing connections to Redundant Arrays of Independent Disks (RAID)
controllers prior to proceeding, including Small Computer System Interface (SCSI) connections and serial -line
monitoring connections.
Important: If you do not disconnect, the RAID array's information could be compromised during this
procedure. The operating system install may construe a serial-line RAID monitoring connection as a serial
mouse that could cause problems upon subsequent reboots.

Changing the Time Zone


After you have installed Microsoft Windows, adjust the time, date, and time zone to match your location. Failure
to do so may impact your AVEVA Enterprise SCADA environment.

Page 8 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

To change the time zone


1. Start an elevated PowerShell session.
2. Type the following to display the current time zone:
tzutil /g
3. Type the following to display all available time zones:
tzutil /l.

4. Using the information from step 3, type the following to change the time zone:
tzutil /s <time zone name>
5. Type the following to turn off automatic time update:
reg add HKLM\SYSTEM\CurrentControlSet\Services\W32Time\Parameters /t REG_SZ /v Type /d
NoSync /f

Note: The above commands should be entered all on one line.


6. If necessary, type the following to correct the time:
time <current time>
For example: time 05:30:21 PM.

Configuring the System Localization Settings


You can configure the system localization settings for your Microsoft Windows servers.
To configure the system localization settings
1. Log on as a member of domain admins (for example, dnaInstaller).
2. Ensure all AVEVA Enterprise SCADA services are shut down.
3. Start an elevated PowerShell session.
4. Execute the following command:
sconfig
The Server Configuration tool opens.
5. Select option 9 to open the Date and Time dialog box.
6. Click Change Time Zone to change to the desired time zone.
7. Click Change date and time to open the Date and Time Settings dialog box.
8. On the Date and Time Settings dialog box, click Change calendar settings to open the Region dialog box.
9. Change the currently configured date format to the appropriate formatting standard.
10. On the Region dialog box, click Time & Language > Region & language.
The Region Settings tab appears.
11. Click Additional date, time, & regional settings.
The Clock, Language, and Region settings tab appears.
12. Click Region.
The Region dialog box appears.

Release 2021 Page 9

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

13. Click the Administrative tab.


14. Click Copy settings.
The Welcome screen and new user accounts settings dialog box appears.
15. Select Welcome screen and system accounts and New user accounts.
16. Click OK to return to the Administrative tab of the Region dialog box.
The Administrative tab appears.
17. Click Change system locale.
The Region Settings dialog box appears.
18. Change Current system locale to the appropriate locale.
19. Click OK to return to the Administrative tab of the Region dialog box.
20. Click OK to close the Region dialog box.
21. Exit all settings dialog boxes.
22. Reboot the machine.

Configuring TCP/IP for a Static IP Address


You need to configure a static address for the AVEVA Enterprise SCADA Enterprise Domain Controller (DC)
computer and any computer with Arbitration installed, such as Engineering Station (ES)/Decision Support
System (DSS), Main1/Main2, and Backup.
To configure Control Protocol (TCP)/Internet Protocol (IP) for a static IP address
1. Start an elevated PowerShell session.
2. Type the following to display a list of all existing ethernet adapters on the computer:
Get-NetAdapter
3. Type the following to rename the adapter to be used for the SCADA network (for example, SCADA_LAN):
Get-NetAdapter -Name <currentNameOfAdapter> | Rename-NetAdapter -NewName “SCADA_LAN”
4. If File and Printer Sharing for Microsoft Networks is not set to True, type the following:
Enable-NetAdapterBinding -Name <Name of ethernet adapter (e.g. SCADA)> -componentid
ms_server'.

Important: Each network card must have File and Printer Sharing for Microsoft Networks set to True.
AVEVA Enterprise SCADA servers and clients use file sharing for administrative purposes. If the value is not
set to True on Domain Controllers, they will fail to replicate and group policy will not be enforced.
5. Type the following:
Get-NetAdapterBinding –InterfaceAlias "SCADA_LAN" –ComponentID ms_tcpip6
6. If ComponentID ms_tcpip6 is set to True, type the following:
Disable-NetAdapterBinding –InterfaceAlias "SCADA_LAN" –ComponentID ms_tcpip6
7. Type the following:
Get-NetAdapterBinding –InterfaceAlias "SCADA_LAN” –ComponentID ms_pacer
8. If QoS Packet Scheduler is set to True, type the following:

Page 10 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

Disable-NetAdapterBinding –InterfaceAlias "SCADA_LAN” –ComponentID ms_pacer


9. Type the following to configure IP-Address, Subnet-Mask, Default-Gateway, and the preferred DNS server
(please work with a system administrator to determine the correct configuration):
netsh interface ipv4 set address “SCADA_LAN” static <IP -Address> <Subnet-Mask>
<Default-Gateway>
netsh interface ipv4 add dns “SCADA_LAN” <IP-AddressOfFirstDC>

Note: Ignore the following warning if it appears: The configured DNS server is incorrect or does not
exist.

(Optional) netsh interface ipv4 add dns “SCADA_LAN” <IP -AddressOfSecondDC>


10. Type the following:
Set-NetAdapterChecksumOffload -name "SCADA_LAN"
Get-NetAdapterChecksumOffload
11. Type the following to add the TCP/IP domain suffix:
Set-DnsClientGlobalSetting -SuffixSearchList @("<1stDomainName>",
"<OptionalSecondDomainName>")
Example:
Set-DnsClientGlobalSetting -SuffixSearchList @("lsscadaprod.local", "lsscadadss.local")
12. On all computers except the Domain Controller (DC), remove Network Information Center (NIC) Domain
Name System (DNS):
Get-NetAdapter “SCADA_LAN” | Set-DNSClient -RegisterThisConnectionsAddress $False
13. Type the following to confirm that the static IP was applied properly:
ipconfig /all
14. Type the following: Get-NetAdapterBinding.

Changing the Computer Name


After Microsoft Windows has been installed, a generic name is assigned to the computer. This section explains
how to assign the computer a meaningful name.

Important: AVEVA does not recommend assigning a computer the same name as the system.
To change the computer name
1. Start an elevated PowerShell session.
2. Execute the following commands:
rename-computer -newname <newcomputername>
restart-computer -force

Changing the Default Name of a Network


To change the default name of a network
1. Start an elevated PowerShell session.
2. Execute the following command:
Get-NetAdapter
Release 2021 Page 11

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

3. Execute the following command to rename the adapter to be used for the private network (for example,
Private_Cluster_Network):
Get-NetAdapter -Name <currentNameOfAdapter> | Rename-NetAdapter -NewName <New Adapter Name>

Joining a Computer to the Domain


To join a computer to the domain
1. Log on to one of the computers you are configuring.
2. Start an elevated PowerShell session.
3. Execute the following command:
add-computer -domainname <domain name> -computername <hostname>
4. You will be asked to fill in your credentials. Fill out your Administrator credentials.
5. Execute the following commands:
gpupdate /force
restart-computer
6. Repeat steps 1 to 5 for the other computers.

Disabling the Built-in Administrator Account


The built-in local Administrator account is present by default on all Windows servers and workstations. You can
disable it via the Local Security Setting tab of the Administrator account status Properties dialog box (accessible
via the Local Security Policy window). However, the system will not actually disable the account if the built-in
Administrators group has no other members.
In such a situation, you cannot simply create another customer-specific local account and to add it to the
Administrators group. The Restricted Groups policy applied to the built-in Administrator account will result in
the system removing the new account from the Administrators group, and keeping the built-in Administrator
account enabled.
Follow the procedure below to completely disable the built-in Administrator account.
To create an alternate Local Administrator account
1. On the Domain Controller (DC), start an elevated PowerShell session.
2. Execute the following command:
gpupdate /force
3. On each machine in the domain, with the exception of DCs, do the following:
a. Create a local user.
b. Add that user to the local Administrators group.
4. On the member machine, start an elevated PowerShell session.
5. Execute the following command:
gpupdate /force
6. Confirm that the built-in local Administrator account is now disabled:
a. Right-click on the Start menu and select Run.
The Run dialog box opens.
Page 12 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

b. Type the following:


compmgmt.msc
c. Press Enter.
The Computer Management window opens.
d. Navigate to Computer Management (Local) > System Tools > Local Users and Groups > Users.
e. The built-in local Administrator account should appear renamed as Disabled_Local_Admin.

Note: Since the Restricted Groups policy change replaces the default set of members (Domain Admins,
<DomainName>\DNA Developers, and <DomainName>\DNA Installers), if a new version of the Required
OASyS DNA Computer Security Policy includes a different set of members, you will need to modify the
customer GPO.

Important: As with any non-baseline policy settings, policy overrides should be defined in additional GPOs
that override and/or augment the baseline settings. Do not modify the baseline GPOs.

Install AVEVA Enterprise SCADA


Install the desired products using the AVEVA Enterprise SCADA installer located on the media.

Before You Begin


Important: Both .NET Framework 4.8 and SQL Server 2019 must be installed first before installing AVEVA
Enterprise SCADA.
 Review the available installer parameters (Setup.ps1 Parameters on page 13). Some parameters, such as
DNADataRoot and DNAInstallRoot, for example, can only be executed the first time you run the Setup.ps1
script.
 Refer to Features to Install for Each of the AVEVA Enterprise SCADA Products on page 15 to identify the
Windows Installers (MSIs) required for the product you're installing.

Setup.ps1 Parameters
DNADataRoot
The location of the DNADataRoot directory. The default is %SystemDrive%\AVEVA\DNA.

Important: The only time you can change the location of the DNADataRoot directory is when you first run the
Setup.ps1 script.
DNAInstallRoot
The location of the DNAInstallRoot directory. The default is %ProgramFiles%\AVEVA\DNA.

Important: The only time you can change the location of the DNAInstallRoot directory is when you first run the
Setup.ps1 script.
Uninstall
Execute an uninstall of features in a feature list. The parameter only runs in NonInteractive mode.

Release 2021 Page 13

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

FeatureList
A parenthesized, comma-separated list of features for installation. This is useful when you have a specific list of
features you want to install on a server or servers.
SelectDowngrades
Automatically select for installation those products on the media whose version numbers are lower than the
version numbers of the corresponding products installed on the system.
SelectUpgrades
Automatically select for installation those products on the media whose version numbers are higher than the
version numbers of the corresponding products installed on the system.
NonInteractive
Use this parameter for the non-interactive execution of the install script.
ConfigurationFile
This parameter allows you to perform installation and configuration simultaneously. Specify the location of the
OASySInfo.ini file, and the system will automatically run ConfigTool to pull the required values from the file.
ConfigureRemote
This parameter is used for Remote Client Services (RCS). When invoked, the system runs ConfigTool, but does
not attempt to locate the OASySInfo.ini file.
ShowInstalled
The system detects and display all features installed in the DNAInstallRoot directory.
Examples
Setup.ps1
Interactive install session.

Setup.ps1 -FeatureList "AVEVA OASyS SCADA HMI Client","AVEVA OASyS SCADA HMI Elements","AVEVA
OASyS SCADA HMI Utilities"
Interactive installation of the specified feature(s).

Setup.ps1 -FeatureList "AVEVA OASyS SCADA Infrastructure Shared" -ConfigurationFile


"C:\TelventInstall\MyOASyS\OASySInfo.ini" -NonInteractive
Non-Interactive installation of the specified feature(s), along with the execution of ConfigTool after installation
of control room configuration.

Setup.ps1 -FeatureList "AVEVA OASyS SCADA Infrastructure Shared" -ConfigureRemote:$true


-NonInteractive
Non-Interactive installation of the specified feature(s), along with the execution of ConfigTool after installation
of remote configuration.

Setup.ps1 -Uninstall -FeatureList "AVEVA OASyS SCADA HMI Client","AVEVA OASyS SCADA HMI
Elements","AVEVA OASyS SCADA HMI Utilities"

Page 14 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

Non-Interactive uninstallation of the features supplied in the features list.

Setup.ps1 -ShowInstalled
Detect and display all Windows Installers (MSIs) installed at %DNAInstallRoot%.

Setup.ps1 -SelectUpgrades
Detect and upgrade all available features.

Features to Install for Each of the AVEVA Enterprise SCADA Products


Note: Only the highest-level features are listed below. As mentioned in Installing AVEVA Enterprise SCADA on
the First System in the Domain on page 17, the Installer will automatically select for installation any features
dependent on the highest-level feature.
Advanced Database Editor (ADE)
 One of the following:
o AVEVA Pipeline Operations for Liquids ADE
o AVEVA Enterprise SCADA RealTime ADE
 If required:
o AVEVA Enterprise SCADA OPC Browser
easy eXtended Operator Station (ezXOS)
 All of the following
o AVEVA Enterprise SCADA Historical Displays
o AVEVA Enterprise SCADA RealTime Displays
o AVEVA Pipeline Operations for Liquids Displays
Historical
 One of the following:
o AVEVA Pipeline Operations for Liquids Historical
o AVEVA Enterprise SCADA Historical Service
 For Datapump, one of the following:
o AVEVA Pipeline Operations for Liquids Datapump
o AVEVA Enterprise SCADA Historical Datapump
Archive
 One of the following:
o AVEVA Pipeline Operations for Liquids Archive
o AVEVA Enterprise SCADA Historical Archive
Inter-System Publish/Subscribe (ISPS)
AVEVA Enterprise SCADA Services ISPS
Release 2021 Page 15

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

Management of Change (MoC)


 Either all of the following:
o AVEVA Pipeline Operations for Liquids RealTime
o AVEVA Enterprise SCADA Management of Change RealTime
Or:
o AVEVA Enterprise SCADA RealTime Service
 And:
o AVEVA Enterprise SCADA OPC DA Server
o AVEVA Enterprise SCADA OPC Client
Remote Client Service (RCS)
AVEVA Enterprise SCADA Services RCS
RealTime
 Either all of the following:
o AVEVA Pipeline Operations for Liquids RealTime
o AVEVA Enterprise SCADA Management of Change RealTime
Or:
o AVEVA Enterprise SCADA RealTime Service
 And:
o AVEVA Enterprise SCADA OPC DA Server
o AVEVA Enterprise SCADA OPC Client
AVEVA Pipeline Operations for Liquids
 All of the following:
o AVEVA Pipeline Operations for Liquids ADE
o AVEVA Enterprise SCADA Historical Displays
o AVEVA Enterprise SCADA RealTime Displays
o AVEVA Enterprise SCADA Displays
o AVEVA Pipeline Operations for Liquids Historical
o AVEVA Pipeline Operations for Liquids Datapump
o AVEVA Pipeline Operations for Liquids RealTime
o AVEVA Enterprise SCADA Management of Change RealTime
o AVEVA Enterprise SCADA OPC DA Server
o AVEVA Enterprise SCADA OPC Client
AVEVA Measurement Advisor
 All of the following:
o AVEVA Enterprise SCADA Measurement Advisor Server
Page 16 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

o AVEVA Enterprise SCADA Measurement Advisor Utilities


 If required:
o AVEVA Enterprise SCADA Measurement Advisor Client
AVEVA Gas Day Advisor
 All of the following:
o AVEVA Enterprise SCADA Gas Day Advisor Server
o AVEVA Enterprise SCADA Gas Day Advisor Utilities
 If required:
o AVEVA Enterprise SCADA Gas Day Advisor Client
Tools
One or more of the following:
 AVEVA Enterprise SCADA Infrastructure Administration Tools
 AVEVA Enterprise SCADA Infrastructure Common Tools
 AVEVA Enterprise SCADA Infrastructure Configuration Tools
 AVEVA Enterprise SCADA Infrastructure Debugging Tools
 AVEVA Enterprise SCADA Infrastructure Development Tools
 AVEVA Enterprise SCADA Infrastructure Operational Tools
 AVEVA Enterprise SCADA Virtual RTU Composer
 AVEVA Enterprise SCADA Virtual RTU Player
 AVEVA Enterprise SCADA OPC Client

Installing AVEVA Enterprise SCADA on the First System in the Domain


To install AVEVA Enterprise SCADA on the first system in the domain
1. Log on as a member of the DNA Installers group.
2. Download and extract the media.
The media package consists of the following items:
o Product folder: This folder contains a) the MSIs for the AVEVA Enterprise SCADA products and b) the
_Versions.txt file listing the product version numbers.
o ThirdParty folder: This folder contains all third-party components.
o Setup.ps1: The script used to install AVEVA Enterprise SCADA products on your system. For information
on the various parameters, refer to Setup.ps1 Parameters on page 13.
3. Start an elevated PowerShell session.
4. Execute the following command:
Set-Location -Path <LocationOfMedia>
For example:
Set-Location -Path C:\Media\

Release 2021 Page 17

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

5. Execute one of the following commands:


o .\Setup.ps1 -<Parameter1> -<Parameter2> -<Parameter...>
Where: <Parameter1>, etc. = One or more of the optional installer parameters (refer to Setup.ps1
Parameters on page 13)
The above is the default, interactive setup mode (as detailed in the current procedure).
o .\Setup.ps1 -NonInteractive -<Parameter1> -<Parameter2> -<Parameter...>
Where: <Parameter1>, etc. = One or more of the optional installer parameters (refer to Setup.ps1
Parameters on page 13)
The above is the non-interactive setup mode for command line installations. Non-interactive mode
omits the various system prompts/questions.
Results:
Executing the .\Setup.ps1 command has the following four results:
a. The installer detects which features are currently installed, as per the following system output::
Reading installed product information from registry
b. The installer reads and lists all MSIs contained on the Media. For example:
Reading MSI information
ACE.Client
ACE.Server
ADE.Client
c. Below the list of included MSIs, there follows a table-like structure with the following four columns:
– Action: The action to be performed. If a feature is already installed, one of two words appears here:
Upgrade or Downgrade. For example, if the CurrentVersion of the an installed product is 9.0.1.224,
and the NewVersion is 9.0.1.225, the word Upgrade appears in the appropriate row under Action.
– DisplayName: The name of the feature (as it appears, or will appear, in the Microsoft Add or
Remove Programs list).
– CurrentVersion: The version number of the installed product.
– NewVersion: The version number of the product on the media.

d. Finally, the following prompt appears:


Enter Select or Deselect followed by a Feature name, Enter to continue, Ctrl+C to exit:
6. Do one of the following:
o To select products to install on the system, proceed to step 7.
o To select all products for installation, proceed to step 8.
7. To select a product to install on the system:
Page 18 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

a. At the prompt, type the name of a product to install on your system as follows:
Select <NameOfProduct>
Where <NameOfProduct> = The exact spelling of the product as it appears under DisplayName.
For example:
Select AVEVA Enterprise SCADA RealTime Service

Important: Always select the highest-level feature. The Installer will automatically select for installation
any features dependent on the highest-level feature.
b. Press Enter.
The installer refreshes the list of features. Under the Action column, the word Install appears next to
the selected feature and any dependencies.
For example:

c. Select any additional features to install, as per the above steps.


d. Proceed to step 9.
8. To select all products for installation on the system:
o At the prompt, execute the following command:
Select all
The installer refreshes the list of features. Under the Action column, the word Install appears next to
all of the features.
9. Optional: Do one of the following:
o To remove any features from the list of those selected for installation, proceed to step 10.
o To deselect all features for installation, proceed to step 11.
10. To remove any features from the list of those selected for installation:
a. At the prompt, type the name of the product as follows:
Deselect <NameOfProduct>
Where <NameOfProduct> = The exact spelling of the product as it appears under DisplayName.
For example:
Deselect AVEVA Enterprise SCADA RealTime Service

Important: The Installer will not automatically remove any dependent features from the list of those
selected for installation.
b. Press Enter.
The installer refreshes the list of features. Under the Action column, the word Install no longer
appears next to the feature or any of its dependencies.

Release 2021 Page 19

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

c. Manually remove any remaining dependent features using the Deselect command.
d. Proceed to step 12.
11. To deselect all features for installation:
o At the prompt, execute the following command:
Deselect all
The installer refreshes the list of features. Under the Action column, the word Install no longer
appears next to any of the features.
12. When ready to install selected features, press Enter.
The installer lists all third-party products it will need to install. For example:

13. Press Enter to begin the installation of all third-party products.


The installer begins installing all third-party products. When complete, it displays the following message:
Installed Third Party Products successfully
After a few seconds, the installer displays information on the products selected for installation, as well as
the location of the data and install roots. For example:

14. Press Enter to install the selected products.


The installer begins installing the selected products. When complete, it displays the following message:
Selected features have been installed successfully
15. (Optional) To visually confirm that the selected products were installed, execute the following command:
.\Setup.ps1

Page 20 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

The CurrentVersion column should display the correct version number of the installed product. For
example:

Installing AVEVA Enterprise SCADA on Additional Systems in the Domain


Before You Begin
Complete all procedures in all sections under the "Configuring Additional Systems, Computers, and Services"
section in the Initial Setup Guide.
To install AVEVA Enterprise SCADA on additional systems in the domain
1. Log on as a member of the DNA Installers group.
2. Download and extract the media.
The media package consists of the following items:
o Product folder: This folder contains a) the MSIs for the AVEVA Enterprise SCADA products and b) the
_Versions.txt file listing the product version numbers.
o ThirdParty folder: This folder contains all third-party components.
o Setup.ps1: The script used to install AVEVA Enterprise SCADA products on your system. For information
on the various parameters, refer to Setup.ps1 Parameters on page 13.
3. Start an elevated PowerShell session.
4. Execute the following command:
Set-Location -Path <LocationOfMedia>
For example:
Set-Location -Path C:\Media\
5. Execute one of the following commands:
o .\Setup.ps1 -<Parameter1> -<Parameter2> -<Parameter...>
Where: <Parameter1>, etc. = One or more of the optional installer parameters (refer to Setup.ps1
Parameters on page 13)
The above is the default, interactive setup mode (as detailed in the current procedure).
o .\Setup.ps1 -NonInteractive -<Parameter1> -<Parameter2> -<Parameter...>
Where: <Parameter1>, etc. = One or more of the optional installer parameters (refer to Setup.ps1
Parameters on page 13)
The above is the non-interactive setup mode for command line installations. Non-interactive mode
omits the various system prompts/questions.
Results:
Executing the .\Setup.ps1 command has the following four results:

Release 2021 Page 21

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

a. The installer detects which features are currently installed, as per the following system output::
Reading installed product information from registry
b. The installer reads and lists all MSIs contained on the Media. For example:
Reading MSI information
ACE.Client
ACE.Server
ADE.Client
c. Below the list of included MSIs, there follows a table-like structure with the following four columns:
– Action: The action to be performed. If a feature is already installed, one of two words appears here:
Upgrade or Downgrade. For example, if the CurrentVersion of the an installed product is 9.0.1.224,
and the NewVersion is 9.0.1.225, the word Upgrade appears in the appropriate row under Action.
– DisplayName: The name of the feature (as it appears, or will appear, in the Microsoft Add or
Remove Programs list).
– CurrentVersion: The version number of the installed product.
– NewVersion: The version number of the product on the media.

d. Finally, the following prompt appears:


Enter Select or Deselect followed by a Feature name, Enter to continue, Ctrl+C to exit:
6. Do one of the following:
o To select products to install on the system, proceed to step 7.
o To select all products for installation, proceed to step 8.
7. To select a product to install on the system:
a. At the prompt, type the name of a product to install on your system as follows:
Select <NameOfProduct>
Where <NameOfProduct> = The exact spelling of the product as it appears under DisplayName.
For example:
Select AVEVA Enterprise SCADA RealTime Service

Important: Always select the highest-level feature. The Installer will automatically select for installation
any features dependent on the highest-level feature.
b. Press Enter.
The installer refreshes the list of features. Under the Action column, the word Install appears next to
the selected feature and any dependencies.

Page 22 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

For example:

c. Select any additional features to install, as per the above steps.


d. Proceed to step 9.
8. To select all products for installation on the system:
o At the prompt, execute the following command:
Select all
The installer refreshes the list of features. Under the Action column, the word Install appears next to
all of the features.
9. Optional: Do one of the following:
o To remove any features from the list of those selected for installation, proceed to step 10.
o To deselect all features for installation, proceed to step 11.
10. To remove any features from the list of those selected for installation:
a. At the prompt, type the name of the product as follows:
Deselect <NameOfProduct>
Where <NameOfProduct> = The exact spelling of the product as it appears under DisplayName.
For example:
Deselect AVEVA Enterprise SCADA RealTime Service

Important: The Installer will not automatically remove any dependent features from the list of those
selected for installation.
b. Press Enter.
The installer refreshes the list of features. Under the Action column, the word Install no longer
appears next to the feature or any of its dependencies.
c. Manually remove any remaining dependent features using the Deselect command.
d. Proceed to step 12.
11. To deselect all features for installation:
o At the prompt, execute the following command:
Deselect all
The installer refreshes the list of features. Under the Action column, the word Install no longer
appears next to any of the features.
12. When ready to install selected features, press Enter.

Release 2021 Page 23

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

The installer lists all third-party products it will need to install. For example:

13. Press Enter to begin the installation of all third-party products.


The installer begins installing all third-party products. When complete, it displays the following message:
Installed Third Party Products successfully
After a few seconds, the installer displays information on the products selected for installation, as well as
the location of the data and install roots. For example:

14. Press Enter to install the selected products.


The installer begins installing the selected products. When complete, it displays the following message:
Selected features have been installed successfully
15. (Optional) To visually confirm that the selected products were installed, execute the following command:
.\Setup.ps1
The CurrentVersion column should display the correct version number of the installed product. For
example:

Page 24 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

Configure AVEVA Enterprise SCADA Post-Installation


Important: Before performing post-installation configuration steps on any machine, you must ensure that the
valid configuration is present in Active Directory Application Mode (ADAM).
Use the AVEVA Enterprise SCADA Network Management Console (NMC) to add related computers and all
installed services to the corresponding AVEVA Enterprise SCADA system.
After installing AVEVA Enterprise SCADA, move computers to the appropriate Organizational Unit (OU) on the
domain, configure the product silo, and set the Service Principle Names (SPNs) for the Active Directory
Application Mode (ADAM) service.

Moving Computers into the Appropriate Organizational Unit (OU) on the Domain
To move your system
1. Click Start > Active Directory Users and Computers.
2. Navigate down to the Active Directory Users and Computers\<domain>\OASyS DNA\New OASyS DNA
Computers (move to appropriate OU) folder.
3. Drag the appropriate system into the Active Directory Users and Computers\<domain>\OASyS DNA\OASyS
DNA Servers\Windows Server 2019 Servers folder.
4. When prompted about the move, click Yes.
5. On the desktop, double-click the Windows PowerShell for DNA shortcut.
Windows PowerShell opens.
6. Execute the following command:
gpupdate /force
7. Execute the following command to re-start the Domain Controller (DC):
shutdown /r /t 0

Configuring the Product Silos


Before You Begin
You must add the computer to the "DNA App Enabled Computers" computer group. For further information,
refer to the AVEVA Enterprise SCADA System Setup and Configuration Guide.
To configure the product silos
1. Log on as a member of the DNA Installers group.
2. Start an elevated PowerShell session.
3. Change the directory to the following:
$env:DNAInstallRoot\Shared\scripts

4. Execute the following command:


.\Write-SilentConfigurationToolScriptTemplate.ps1 '-Path <location>'

Release 2021 Page 25

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

Where:
'-Path <location>' = An optional parameter used to customize the output location file name and
directory.

Note: The script will create or replace "$env:DNADataRoot\Shared\scripts\Invoke-ConfigTool.ps1"


by default.

5. Optional: Modify the generated PowerShell script from the previous step to remove any silos or features
that should not be configured.
6. Execute the following command to run the modified PowerShell script created with
.\Write-SilentConfigurationToolScriptTemplate.ps1 :
Control Room:
. "$env:DNADataRoot\Shared\scripts\Invoke-ConfigTool.ps1" `
-ControlRoom
-ConfigurationFile $env:SystemDrive\TelventInstall\...\OASySInfo.ini `
Remote:
. "$env:DNADataRoot\Shared\scripts\Invoke-ConfigTool.ps1" `
-Remote

Note: The path . "$env:DNADataRoot\Shared\scripts\Invoke-ConfigTool.ps1" ` assumes that the


default was used for the '-Path <location>' parameter.

Setting Service Principle Names (SPNs) for the Active Directory Application Mode
(ADAM) Service
Important: This procedure is required for all computers running the OASySDNACore service.
To set the Service Principle Names (SPNs) for the Active Directory Application Mode (ADAM) service
1. Log on to the server that was previously configured using the Config Tool as a domain administrator.
2. On the desktop, double-click the Windows PowerShell for DNA shortcut.
Windows PowerShell opens.
3. Execute the following command to navigate to the ADAM install directory:
cd “<SystemDrive>:\Program Files\Microsoft ADAM\OASySDNACore\data”
4. Run the following batch file twice:
<FullyQualifiedDomainName>.bat
For Example: ProdDomain.local.bat.

Note: You must run this command twice, as the autogenerated script sometimes doesn’t remove the SPNs
from the computer account before adding them to the dnaApp account
5. Execute the following command to verify that the SPNs were added:
Page 26 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

Setspn -L dnaApp_<SystemId>
Where <SystemId> = The AVEVA Enterprise SCADA system ID of the system to which this computer belongs.
For example, the output should be similar to the following:

Note: If the SPNs do not exist, you can rerun the script or try restarting the server. The domain can take a
few minutes to replicate this information.

Generate and Install AVEVA Enterprise SCADA Certificates


To enable encrypted communications and mutual authentication between AVEVA Enterprise SCADA software
products, you must first generate and install the appropriate certificates.

Certificate Generation and Installation Prerequisites


To generate and install certificates, the following is required:
 You must have OpenSSL installed on each computer that is generating certificates.
Note: The examples in the certificate generation and installation instructions require OpenSSL to be install ed
in C:\Program Files\OpenSSL-Win64\bin\. OpenSSL can be downloaded from
https://slproweb.com/download/Win64OpenSSL-1_1_1g.exe.

 You must ensure the destination folder for the certificates exists on each machine prior to running any
commands. Typically, this is C:\TelventInstall\certificates. The examples for the certificate installation
instructions use this folder.

Generating and Installing Certificates for the First Enterprise or Single Development
System Machine
To generate and install certificates for the first Enterprise or single Development system machine
1. Log on to the machine as a member of domain administrator, and double-click the Windows PowerShell for
DNA shortcut.
Windows PowerShell opens.
2. Execute the following command:
set-silo common
3. Generate the OASyS_DNA_Root certificate using the following command:
RootCertGenerator.exe -sslexe "C:\Program Files\OpenSSL-Win64\bin\openssl.exe" -f
C:\TelventInstall\certificates -v 60000 -a SHA256
4. Generate the OASyS_DNA_Member, OASyS_DNA_SystemLink, OASyS_DNA_DNAApps_<computername>,
and OASyS_DNA_RMQClient remaining certificates using the following command:
EncryptionCertGenerator.exe -e "C:\Program Files\OpenSSL-Win64\bin\openssl.exe" -f
C:\TelventInstall\certificates -m -s -d -q

Release 2021 Page 27

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

5. Install the OASyS_DNA_Root, OASyS_DNA_Member, OASyS_DNA_SystemLink,


OASyS_DNA_DNAApps_<computername>, and OASyS_DNA_RMQClient certificates using the following
command:
EncryptionCertInstaller.exe -f C:\TelventInstall\certificates -r -m -s -d -q
6. Generate the OASyS_DNA_DNAApps_<RabbitMQcomputername> certificate for the RabbitMQ/Skelta
server using the following command:
EncryptionCertGenerator.exe -e "C:\Program Files\OpenSSL-Win64\bin\openssl.exe" -f
C:\TelventInstall\certificates -d -n <RabbitMQcomputername>

Generating and Installing Certificates on All Other AVEVA Enterprise SCADA Servers
To generate and install certificates on all other AVEVA Enterprise SCADA servers
1. Log on to the machine as a member of domain administrator.
2. Open the command console.
3. Type powershell.
The PowerShell console opens.
4. Execute the following command:
set-silo common
5. Copy the .crt, .key, and .p12 files of the generated and installed OASyS_DNA_Root,
OASyS_DNA_SystemLink, OASyS_DNA_Member, and OASyS_DNA_RMQClient certificates from the first
Enterprise system machine to the C:\TelventInstall\certificates folder on all additional AVEVA Enterprise
SCADA server systems.
6. Optional: If required, generate the OASyS_DNA_DNAApps_<computername> certificate (typically only
required on computers running the MoCAgent or RealTime services) using the following command:
EncryptionCertGenerator.exe -e "C:\Program Files\OpenSSL-Win64\bin\openssl.exe" -f
C:\TelventInstall\certificates -d
7. If the OASyS_DNA_DNAApps_<computername> certificate is required, install the certificates using -d in the
following command (otherwise it can be omitted):
EncryptionCertInstaller.exe -f C:\TelventInstall\certificates -r -m -s -d -q

Generating and Installing LDAP Server Certificates on the Development Server


To generate and install Lightweight Directory Access Protocol (LDAP) server certificates on the development
server in the Management of Change (MoC) Development zone
1. Log on to the machine as a member of domain administrator.
2. Ensure you have followed the procedure for Generating and Installing Certificates on All Other AVEVA
Enterprise SCADA Servers on page 28 to install the OASyS_DNA_Root certificate.
3. Generate the OASyS_DNA_LDAPS certificate using the following command:
EncryptionCertGenerator.exe -e "C:\Program Files\OpenSSL-Win64\bin\openssl.exe" -f
C:\TelventInstall\certificates -L
4. Install the OASyS_DNA_LDAPS certificate using the following command:
EncryptionCertInstaller.exe -f C:\TelventInstall\certificates -L

Page 28 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

Installing Certificates on the RabbitMQ/Skelta Server


To install certificates on the RabbitMQ/Skelta server
1. Log on to the machine as a member of domain administrator.
2. Copy the .crt, .key, and .p12 files of the generated and installed OASyS_DNA_Root,
OASyS_DNA_DNAApps_<RabbitMQcomputername>, and OASyS_DNA_RMQClient certificates from the
first Enterprise system machine to the C:\TelventInstall\certificates folder on the RabbitMQ/Skelta system.
3. Manually install the OASyS_DNA_Root.crt, OASyS_DNA_DNAApps_<RabbitMQcomputername>, and
OASyS_DNA_RMQClient certificates.

Note: For the RabbitMQ/Skelta server, you must install the


OASyS_DNA_DNAApps_<RabbitMQcomputername> and OASyS_DNA_RMQClient certificates using the
.p12 files. If you try to install the .crt files for these certificates, you will not be able to adjust the user
permissions on the private key in the next step. The OASyS_DNA_Root certificate can be installed using the
.crt file as you do not have to install the private key.
4. Open the Start menu, type Manage computer certificates, and select the program.
The certlm dialog box appears.

5. Navigate to Personal > Certificates for both the OASyS_DNA_DNAApps_<RabbitMQcomputername> and


OASyS_DNA_RMQClient certificates.
6. Right-click the certificate, and select All Tasks > Manage Private Keys....

Release 2021 Page 29

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

The Permissions dialog box for the certificate appears.

7. Click Add.
The Select Users or Groups dialog box appears.

8. Type Network Service in the Enter the object names to select field, and click OK.

Page 30 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

NETWORK SERVICE appears in the list of Group or user names for Permissions for Client_cert private keys.

9. Click OK.

Request and Install an AVEVA Enterprise SCADA License


Use the Licensing Assistant to request and install an AVEVA Enterprise SCADA license.

Running the Licensing Assistant


To run the Licensing Assistant
1. On the first system (first computer on the domain / Decision Support System [DSS]), ensure that you have:
o Properly installed AVEVA Enterprise SCADA.
o Configured the system for the AVEVA Enterprise SCADA system and computers you want to license.
2. Start an elevated PowerShell session.
3. Execute the following command:
LicenseAssistant /request /systems:<SystemName(s)>
Where:
<SystemName(s)> = The name(s) of your AVEVA Enterprise SCADA system(s). To request licenses for
multiple systems, type a comma-separated string of system names with no spaces. For example:

Release 2021 Page 31

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

LicenseAssistant /request /systems:ls1pdc,ls1sdc

Note: If you do not list any system or systems in the command, the Licensing Assistant assumes that you're
requesting licenses for all systems.
4. Note the output path for the new license file. In the above example, the full path is as follows:
C:\Users\dnainstaller\Documents\OASyS DNA License Requests\requests_2019-12-04_10-28-07.zip
5. Go to http://oasyslicense.com http://oasyslicense.com. Type your email address and select the zipped
license request file generated in the previous step.
6. Click Sign License File.
7. After your license request has been approved, AVEVA Enterprise SCADA Customer Support will email you a
zipped license file for the computers configured in the selected system(s).
8. Extract the contents of the licenses_<date>_<time>.zip file to a convenient location.

Page 32 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 2 – RealTime Pre-Installation Configuration

If you requested licenses for multiple systems, there will be more than one folder.

9. Copy the license file within the folder to the %DNADataRoot%\<silo>\config directory in all silos for that
particular machine.
On the ls1pdcrt1 machine, for example, you would copy the license.xml file to all the silos indicated below.

Release 2021 Page 33

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
CHAPTER 3
RealTime Arbitration Configuration
Arbitration Configuration Checklist
Before installing and configuring the product, complete the arbitration configuration procedures below.

Order Step Description

1 Configure the Install the Arbitration Network Driver Interface Specification


Arbitration Network (NDIS) Protocol Driver on each computer running the Arbitration
Driver Interface service.
Specification (NDIS)
Protocol Driver on page
35
2 Disable Dynamic Any computer with Arbitration software must be configured to
Domain Name System disable Dynamic Domain Name System (DDNS) updates. This is
(DDNS) on Arbitrated very important since DDNS on computers with Arbitration can
Servers on page 37 cause issues with replication and prevent the client from
connecting to the correct Hot server.

Configure the Arbitration Network Driver Interface Specification


(NDIS) Protocol Driver
Install the Arbitration Network Driver Interface Specification (NDIS) Protocol Driver on each computer running
the Arbitration service.

Adding the ArbAdapterName Registry Setting


Before installing the Arbitration Network Driver Interface Specification (NDIS) Protocol Driver, you must add the
ArbAdapterName registry setting to the CoreSDK_custom.xml registry file.

To add ArbAdapterName to the CoreSDK_custom.xml registry file


1. Log on to the computer as either a local administrator or a domain administrator.
2. On the desktop, double-click the Windows PowerShell for DNA shortcut.
Windows PowerShell opens.
3. Execute the following commands:
PowerShell

Release 2021 Page 35

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 3 – RealTime Arbitration Configuration

get-netadapter

4. Take note of the interface description.


5. Log on to the computer as a member of the DNA System Admins group.
6. Open Windows Explorer, and navigate to %DNADataRoot%\Common\config\Settings.
7. If a CoreSDK_custom.json file exists in the directory, open it for editing.
Otherwise, create a new CoreSDK_custom.json file.
8. Add the following text to the CoreSDK_custom.json file, substituting <InterfaceDescription> for the
interface description noted in step 4:
{
"CoreSDK": {
"ArbAdapterName": <InterfaceDescription>
}
}
9. Save your changes, and close the file.

Installing the Arbitration Network Driver Interface Specification (NDIS) Protocol Driver
Once the CoreSDK_custom.json registry file has been updated to include ArbAdapterName, the Arbitration
Network Driver Interface Specification (NDIS) Protocol Driver can be installed.

Note: During installation, the computer may need an internet connection to ensure the driver is recognized as
signed. If you see a message during installation that says the driver is unsigned, please connect the computer to
the internet and try again.
You must repeat the installation procedure if any of the following are true:
 The network card driver was added or removed.
 The network team driver was added, removed, or updated.
To install the Arbitration NDIS protocol driver
1. Log on to the computer as a local administrator or a domain administrator.
2. On the desktop, double-click the Windows PowerShell for DNA shortcut.
Windows PowerShell opens.
3. Execute the following commands:
Import-Certificate -CertStoreLocation Cert:\LocalMachine\TrustedPublisher\ -FilePath
$env:DNAInstallRoot'\Common\bin\dnaarbndis.cat'
netcfg -l "$env:DNAInstallRoot\Common\bin\dnaArbNdis.inf" -c p -i MS_NDISPROT
4. Restart the computer to ensure the driver starts properly.

Page 36 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 3 – RealTime Arbitration Configuration

5. Monitor the oasErrLog.log file when starting an arbitrated service (for example, RealTime, Inter-System
Publish/Subscribe (ISPS), Remote Client Services (RCS)) for error messages related to issues about finding
the correct network driver.
If necessary, correct the name specified in the registry setting.

Disable Dynamic Domain Name System (DDNS) on Arbitrated


Servers
Any computer with Arbitration software must be configured to disable Dynamic Domain Name System (DDNS)
updates. This is very important since DDNS on computers with Arbitration can cause issues with replication and
prevent the client from connecting to the correct Hot server.

Disabling Dynamic Domain Name System (DDNS) on Arbitrated Servers


To disable Dynamic Domain Name System (DDNS)
1. Turn off DDNS network card updates.
2. Ensure the previous DDNS entries are not deleted.
If you are disabling DDNS on a server computer, you must also:
3. Configure DNS to listen on the static IP.
4. Configure DNS for secure DDNS updates.

Understanding Dynamic Domain Name System (DDNS) on Arbitrated Servers


The AVEVA Enterprise SCADA Arbitration software dynamically adds/removes IP addresses on redundant server
pairs. By default, Microsoft Windows system tells the Domain Name System (DNS) server about any additional IP
addresses that may exist as they are dynamically added. When this happens, the given IP address is associated
with the static hostname of the computer.
Therefore, on a server running with AVEVA Enterprise SCADA Arbitration and floating IP addresses, the DDNS
updates can associate a second entry for the virtual IP address of an AVEVA Enterprise SCADA service with the
static hostname of a specific server.
Example: Issues of DDNS on Arbitrated Servers
You have a RealTime service with two servers with static IP addresses:

Name Static IP Address

RealTimeServer1 128.1.1.1
RealTimeServer2 128.1.1.2
You also have a floating hostname/IP for the RealTime service:
 <systemName>RealTime: 128.1.1.3 .

If RealTimeServer1 becomes Hot, the floating IP (128.1.1.3) will bind to RealTimeServer1. Therefore, if any client
software attempts to connect to the static hostname RealTimeServer1, it may accidentally use the floating IP
address 128.1.1.3. If RealTimeServer2 becomes Hot, and therefore owns IP 128.1.1.3, the client could end up
connecting to RealTimeServer2.

Release 2021 Page 37

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 3 – RealTime Arbitration Configuration

In this example, both servers of a redundant service could become Hot at the same time, and clients would be
unable to connect to the actual Hot server of a given service.
To avoid these risks, disable DDNS.

Disabling Dynamic Domain Name System (DDNS) Network Card Updates


You must stop Dynamic Domain Name System (DDNS) network card updates that can interfere with any
computers with Arbitration.
To disable DDNS network card updates
1. Log on to the Primary server as a Windows Administrator.
2. Start an elevated PowerShell session.
3. Execute the following command:
(Get-WmiObject Win32_NetworkAdapter -Filter
"NetEnabled=True").GetRelated('Win32_NetworkAdapterConfiguration').SetDynamicDNSRegistra
tion($false,$false)
This command will disable all DDNS on all network cards. A return value of 0 means the command was
executed successfully.

4. Repeat steps 1–3 on the Secondary server.

Ensuring Previous Dynamic Domain Name System (DDNS) Entries are Not Deleted
After disabling Dynamic Domain Name System (DDNS), you must update the configuration to your Domain
Name System (DNS) server to ensure that previously generated DDNS entires are not deleted, but rather made
permanent entries.
When DDNS creates a DNS hostname/IP entry, it periodically updates a timestamp within that entry. The DNS
server periodically deletes (scavanges) any old entries generated by DDNS that have not been updated recently.
You must update the DNS server settings to ensure this does not happe n.
To prevent the deletion of existing DDNS entries:
1. On the Domain Controller (DC) running the DNS server, open the Windows Control Panel.
2. Click Administrative Tools > DNS.
The DNS Manager appears.
3. Click View and ensure the Advanced option is selected.
4. In the left panel of the window, expand DNS > <DC server name> > Forward Lookup Zones.
Page 38 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 3 – RealTime Arbitration Configuration

The entry records for the project appear in the right panel of the window.
5. Right-click the host entry for which you turned off DDNS, and click Properties.
6. Clear the Delete this record when it becomes stale check box, and click OK.

Note: The Delete this record when it becomes stale check box can only be selected if you are configuring
test virtual machines (VMs).
The DNS Manager window appears.
7. Expand DNS > <DC server name> > Reverse Lookup Zones, and select the zone for the host entry you just
modified.
8. Right-click the reverse entry for the host for which you disabled DDNS, and click Properties.
9. Ensure the Delete this record when it becomes stale check box is clear, and click OK.

Release 2021 Page 39

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
CHAPTER 4
RealTime Installation and Configuration
RealTime Installation Checklist
All procedures in this section are specific to the RealTime feature. Follow the procedures in the order in which
they appear in the table below.

Order Step Description

1 Configure the RealTime Follow the procedures in this section to configure the
Computers on page 42 RealTime computers on the project domain by moving
the computers in to the final organizational unit,
configuring the first computer on the domain/Decision
Support System (DSS), and completing the Active
Directory (AD) configuration.
a. Move Computers into the The computers on the domain need to be updated with
Final Organizational Unit the new Organization Unit (OU).
on page 42
b. Change the Settings for A client connection to the Open Platform
the Open Platform Communication (OPC) Data Access (DA) Server can result
Communication (OPC) in automatic dependent service startup or shutdown
Data Access (DA) Server unless the default OPC DA Server DCOM settings are
on page 42 modified; for example, since the RealTime service is
listed as a dependency of the OPC DA Server, RealTime
can be restarted automatically by OPC after RealTime
was intentionally shut down.
c. Configure AVEVA A good starting point for activation and launch
Enterprise SCADA Open permissions is to configure the following users:
Platform Communication
 dnaInstaller
(OPC) Data Access (DA)
Server DCOM on page 43  dnaAdmin
 SYSTEM
 INTERACTIVE

d. Load Message Sets for


Projects with No Custom
Message Sets on page 45

Release 2021 Page 41

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 4 – RealTime Installation and Configuration

Order Step Description

e. Manually Configure Enable and disable RealTime services as desired.


Selective Startup for
RealTime Services on
page 45

Configure the RealTime Computers


Follow the procedures in this section to configure the RealTime computers on the project domain by moving the
computers in to the final organizational unit, configuring the first computer on the domain/Decision Support
System (DSS), and completing the Active Directory (AD) configuration.

Move Computers into the Final Organizational Unit


The computers on the domain need to be updated with the new Organization Unit (OU).

Updating Computers with the New Organizational Unit (OU) on the Domain
To update your systems
1. On the desktop, double-click the Windows PowerShell for DNA shortcut.
Windows PowerShell opens.
2. Execute the following command:
gpupdate /force
3. Restart the DC.
4. On the desktop of the first computer on the domain/Decision Support System (DSS), double-click the
Windows PowerShell for DNA shortcut.
Windows PowerShell opens.
5. Execute the following command:
gpupdate /force
6. Restart the first computer on the domain/DSS.

Change the Settings for the Open Platform Communication (OPC) Data Access (DA)
Server
A client connection to the Open Platform Communication (OPC) Data Access (DA) Server can result in automatic
dependent service startup or shutdown unless the default OPC DA Server DCOM settings are modified; for
example, since the RealTime service is listed as a dependency of the OPC DA Server, RealTime can be restarted
automatically by OPC after RealTime was intentionally shut down.

Changing the Settings for the Open Platform Communication (OPC) Data Access (DA) Server
After installation and configuration, but prior to operation, the following steps must be performed.
To change the settings
1. Select Start > Administrative Tools > Component Services.

Page 42 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 4 – RealTime Installation and Configuration

Note: If you are not using Windows, run the following command: dcomcnfg.
2. Navigate to Computers > My Computer > DCOM Config.
The Component Services window appears.
3. Right-click OASyS DNA OPC DA Server and select Properties.
The OASyS DNA OPC DA Server Properties dialog box appears.
4. Click the Security tab.
5. In the Launch and Activation Permission field, select Customize.
6. Click Edit.
The Launch and Activation Permission dialog box appears.
7. In the Groups or user names section, select Administrators.
8. In the Permissions for Administrators section, deselect Local Launch and Remote Launch. Leave Local
Activation and Remote Activation selected.
9. Click OK to close the Launch and Activation Permission dialog box.
10. Click OK to close the OASyS DNA OPC DA Server Properties dialog box.
The settings are now changed, and there is no need to reboot.

Configure AVEVA Enterprise SCADA Open Platform Communication (OPC) Data Access
(DA) Server DCOM
A good starting point for activation and launch permissions is to configure the following users:
 dnaInstaller
 dnaAdmin
 SYSTEM
 INTERACTIVE

Configuring AVEVA Enterprise SCADA Open Platform Communication (OPC) Data Access (DA) Server DCOM
To add or remove permissions
1. On the Windows 2019 Core machine hosting the AVEVA Enterprise SCADA OPC DA Server, navigate to
%DNADataRoot%\Realtime\bin.
From the above directory, you can configure DCOM permissions using DCP.exe.
2. On the desktop, double-click the Windows PowerShell for DNA shortcut.
Windows PowerShell opens.
3. Execute the following command
set-silo RealTime
4. Do the following to verify access permissions:
o Execute the following command:
dcp -aa AppID:{1B1A497F-AE3D-48A1-9BC9-DEBB330B195B} list

Release 2021 Page 43

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 4 – RealTime Installation and Configuration

Where: {1B1A497F-AE3D-48A1-9BC9-DEBB330B195B} = the AppID of the AVEVA Enterprise SCADA OPC


server corresponding to the AVEVA Enterprise SCADA OPCDAServer.1 instance.
Note: AppID is different for other AVEVA Enterprise SCADA OPCDAServer instances.
5. Do the following to add users to access permissions:
o Execute the following command:
dcp -aa AppID:{1B1A497F-AE3D-48A1-9BC9-DEBB330B195B} set LSSCADAPROD\dnaAdmin permit

Note: AppID is different for other AVEVA Enterprise SCADA OPCDAServer instances.
6. Do the following to remove users from access permissions:
o Execute the following command:
dcp -aa AppID:{1B1A497F-AE3D-48A1-9BC9-DEBB330B195B} remove LSSCADAPROD\dnaAdmin

Note: AppID is different for other AVEVA Enterprise SCADA OPCDAServer instances.
7. Do the following to verify launch permissions:
o Execute the following command:
dcp -al AppID:{1B1A497F-AE3D-48A1-9BC9-DEBB330B195B} list

Note: AppID is different for other AVEVA Enterprise SCADA OPCDAServer instances.
8. Do the following to add users to launch permissions:
o Execute the following command:
dcp -al AppID:{1B1A497F-AE3D-48A1-9BC9-DEBB330B195B} set LSSCADAPROD\dnaAdmin permit

Note: AppID is different for other AVEVA Enterprise SCADA OPCDAServer instances.
9. Do the following to remove users from launch permissions:
o Execute the following command:
dcp -al AppID:{1B1A497F-AE3D-48A1-9BC9-DEBB330B195B} remove LSSCADAPROD\dnaAdmin

Page 44 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 4 – RealTime Installation and Configuration

Note: AppID is different for other AVEVA Enterprise SCADA OPCDAServer instances.

Load Message Sets for Projects with No Custom Message Sets


Loading Message Sets for Projects with No Custom Message Sets
To load message sets for projects with no custom message sets
1. Prior to running the loadblankdb command, ensure that:
o Your system's %DNAInstallRoot%\RealTime\database\message.init file matches the file provided by
Project Delivery.
o Your system's virtual memory ( OAS_MAX_VIRTUAL) configuration is adequate (for example, 90,000,000),
as indicated in %DNAInstallRoot%\RealTime\config\Settings\RealTime_VirtualMemory.json.
2. On the desktop, double-click the Windows PowerShell for DNA shortcut.
Windows PowerShell opens.
3. Execute the following commands:
loadblankdb
cd %DNAInstallRoot%\RealTime\database\INTEL_NT
dbll template message message.t
dbll list message.t * message.l
text_load
The above should load the following message.init files:
o almbracket_message.init
o Countdown_message.init
o cpm_message.init > PORTED TO 2021?
o deviceRollup_message.init
o dnlist_message.init
o LMS.message.init
o MEAS_message.init
o Message.init
o rtstring_message.init
o Station_message.init
4. Execute the following command:
savedata

Manually Configure Selective Startup for RealTime Services


Enable and disable RealTime services as desired.

Disabling RealTime Services


You can manually disable RealTime services by editing the RealTime_SelectiveStartup.json file.

Release 2021 Page 45

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 4 – RealTime Installation and Configuration

To disable RealTime services


1. Shut down the RealTime service.
2. Navigate to the %DNAInstallRoot%\RealTime\config\Settings folder.
3. Copy the RealTime_SelectiveStartup.json file to the %DNADataRoot%\RealTime\config\Settings folder.
4. From the %DNADataRoot%\RealTime\config\Settings folder, open the RealTime_SelectiveStartup.json file.
5. Locate the service you want to disable.
6. Change Startup from true to false. For example:
"Alternate Alarm Limit Monitor"
{
"Application": "alarmLimitManager",
"Startup": false
}
7. Restart the RealTime service for the Startup option to take effect.

Enabling RealTime Services


You can manually enable RealTime services by editing the RealTime_SelectiveStartup.json file.
To enable RealTime services
1. Shut down the RealTime service.
2. Navigate to the %DNAInstallRoot%\RealTime\config\Settings folder.
3. Copy the RealTime_SelectiveStartup.json file to the %DNADataRoot%\RealTime\config\Settings folder.
4. From the %DNADataRoot%\RealTime\config\Settings folder, open the RealTime_SelectiveStartup.json file.
5. Locate the service you want to enable.
6. Change Startup from false to true. For example:
"Alternate Alarm Limit Monitor"
{
"Application": "alarmLimitManager",
"Startup": true
}
7. Restart the RealTime service for the Startup option to take effect.

Appendix A: RealTime Troubleshooting


Troubleshooting the RealTime product installation.

Page 46 Release 2021

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.
AVEVA™ Enterprise SCADA RealTime Installer Guide
Chapter 4 – RealTime Installation and Configuration

Unmonitored Processes
For unmonitored processes running on a standalone server, the Restart the Service setting—available in the
Properties dialog box of a service—is a useful option.

Release 2021 Page 47

© Copyright 2020 AVEVA Group plc and its subsidiaries. All rights reserved.

You might also like