EcoStruxure Hybrid DCS Installation and Configuration Guide - Eng - EIO0000001255.12

EcoStruxure™ Hybrid DCS
EIO0000001255 09/2019

Installation and Configuration Guide
09/2019
EIO0000001255.12
www.schneider-electric.com
The information provided in this documentation contains general descriptions and/or technical
characteristics of the performance of the products contained herein. This documentation is not
intended as a substitute for and is not to be used for determining suitability or reliability of these
products for specific user applications. It is the duty of any such user or integrator to perform the
appropriate and complete risk analysis, evaluation and testing of the products with respect to the
relevant specific application or use thereof. Neither Schneider Electric nor any of its affiliates or
subsidiaries shall be responsible or liable for misuse of the information contained herein. If you
have any suggestions for improvements or amendments or have found errors in this publication,
please notify us.
You agree not to reproduce, other than for your own personal, noncommercial use, all or part of
this document on any medium whatsoever without permission of Schneider Electric, given in
writing. You also agree not to establish any hypertext links to this document or its content.
Schneider Electric does not grant any right or license for the personal and noncommercial use of
the document or its content, except for a non-exclusive license to consult it on an "as is" basis, at
your own risk. All other rights are reserved.
All pertinent state, regional, and local safety regulations must be observed when installing and
using this product. For reasons of safety and to help ensure compliance with documented system
data, only the manufacturer should perform repairs to components.
When devices are used for applications with technical safety requirements, the relevant
instructions must be followed.
Failure to use Schneider Electric software or approved software with our hardware products may
result in injury, harm, or improper operating results.
Failure to observe this information can result in injury or equipment damage.
© 2019 Schneider Electric. All rights reserved.
2 EIO0000001255 09/2019
Table of Contents
Safety Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Chapter 1 First Steps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
First Installation or Upgrade of Process Expert 4.3/SP1 . . . . . . . . . . . 10
Upgrading EcoStruxure Hybrid DCS 2018 or 2018 R2 . . . . . . . . . . . . 13
Chapter 2 EcoStruxure Hybrid DCS System Infrastructure. . . . . . . 15
Software Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Virtual Machine Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Virtual Machine Licensing Considerations. . . . . . . . . . . . . . . . . . . . . . 27
Physical Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Physical Architecture Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Chapter 3 System and Installation Requirements . . . . . . . . . . . . . . 37
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
General Installation Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Installing the Controller Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Chapter 4 Installing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Installing the Software for the First Time . . . . . . . . . . . . . . . . . . . . . . . 54
Installing Supervision Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Chapter 5 Upgrading the Software . . . . . . . . . . . . . . . . . . . . . . . . . 57
5.1 About Upgrading the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Using Templates Supplied with the Software Upgrade . . . . . . . . . . . . 64
Stopping and Starting Caché. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
5.2 Migrating Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Preparing Databases for Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Re-Installing Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Migrating Databases to the Current Version . . . . . . . . . . . . . . . . . . . . 77
Impact of Migration On System Data. . . . . . . . . . . . . . . . . . . . . . . . . . 79
5.3 Installing the Software Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Installing the Software Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Chapter 6 Role-Based Access Control . . . . . . . . . . . . . . . . . . . . . . 85
About Role Based Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Setting Up Role Based Access Control . . . . . . . . . . . . . . . . . . . . . . . . 91
EIO0000001255 09/2019 3
Chapter 7 Securing Client/Server Communication . . . . . . . . . . . . . . 93
About Using Digital Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Generating and Installing Root CA Certificates . . . . . . . . . . . . . . . . . . 98
Installing Entity Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Uninstalling Certificates from the Computer. . . . . . . . . . . . . . . . . . . . . 107
Chapter 8 Configuring the Software . . . . . . . . . . . . . . . . . . . . . . . . . 111
Using Configuration Wizards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Configuring the System Server and Clients . . . . . . . . . . . . . . . . . . . . . 117
Configuring the Virtual Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Managing Participant Extensions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Activating the Virtual Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Configuring the Content of Blank Databases . . . . . . . . . . . . . . . . . . . . 144
Chapter 9 Starting the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
System Server Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Backing Up and Restoring Databases . . . . . . . . . . . . . . . . . . . . . . . . . 152
Starting With a Blank Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Starting the System Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Starting the Engineering Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Chapter 10 Modifying, Repairing, and Removing the Software . . . . . 163
Modifying the Software Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Repairing the Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Removing the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Chapter 11 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Troubleshooting Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Troubleshooting the System Server. . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Troubleshooting the Virtual Machine . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Troubleshooting Client/Server Communication . . . . . . . . . . . . . . . . . . 178
Troubleshooting USB Port Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Troubleshooting the Caché Database . . . . . . . . . . . . . . . . . . . . . . . . . 182
Appendices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Appendix A Installing the Floating License Manager . . . . . . . . . . . . . . 185
Installing the Floating License Manager. . . . . . . . . . . . . . . . . . . . . . . . 185
Appendix B Installation of DTMs by Using a Response File . . . . . . . . 187
Installing DTMs by Using a Response File . . . . . . . . . . . . . . . . . . . . . 187
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
4 EIO0000001255 09/2019
Safety Information
Important Information
NOTICE
Read these instructions carefully, and look at the equipment to become familiar with the device
before trying to install, operate, service, or maintain it. The following special messages may appear
throughout this documentation or on the equipment to warn of potential hazards or to call attention
to information that clarifies or simplifies a procedure.
EIO0000001255 09/2019 5
PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by qualified
personnel. No responsibility is assumed by Schneider Electric for any consequences arising out of
the use of this material.
A qualified person is one who has skills and knowledge related to the construction and operation
of electrical equipment and its installation, and has received safety training to recognize and avoid
the hazards involved.
6 EIO0000001255 09/2019
About the Book
At a Glance
Document Scope
This document explains how to install or upgrade EcoStruxure Hybrid DCS.
It also describes how to:
 Configure the software.
 Start the system server and engineering clients.
 Migrate databases of supported earlier versions to make them compatible with the current
version.
 Repair, modify, and uninstall the software.
It is written for users who have a working knowledge in the design of control systems, including
supervision functions.
NOTE: Read and understand this manual and the EcoStruxure™ Hybrid DCS Licensing Guide
before installing and using this software.
The licensing Guide is in the ReleaseNotesAndUGs folder of the software installation package.
Validity Note
This document is valid for EcoStruxure Hybrid DCS 2019 or later. It supersedes any previous
version.
Related Documents
Title of documentation Reference number

EcoStruxure™ Hybrid DCS Licensing Guide EIO0000001261 (eng)
EcoStruxure™ Hybrid DCS User Guide EIO0000001114 (eng)
Schneider Electric Floating License Manager User Manual EIO0000001078 (eng)
EcoStruxure™ Hybrid DCS Infrastructure Virtualization - Application Note EIO0000003796 (eng)
You can download these technical publications at app.schneider-electric.com/ecostruxure-hybrid-

dcs, Document Downloads section.
Registration required.
EIO0000001255 09/2019 7
EcoStruxure Hybrid DCS Support Portal
Visit app.schneider-electric.com/ecostruxure-hybrid-dcs for support, software updates, and latest
information on EcoStruxure Hybrid DCS.
Registration required.
Trademarks
Schneider Electric, EcoStruxure Hybrid DCS, and Control Expert are trademarks of
Schneider Electric SE, its subsidiaries, and affiliates.
Citect is a registered trademark of AVEVA Group plc in the United States and/or other countries.
Microsoft, Windows, and Internet Explorer are either registered trademarks or trademarks of
Microsoft Corporation in the United States and/or other countries.
Adobe and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated
in the United States and/or other countries.
Oracle and Java are registered trademarks of Oracle and/or its affiliates.
Caché and InterSystems are trademarks of InterSystems Corporation.
InstallShield is a registered trademark of Flexera Software in the United States and other countries.
PassMark is a registered trademark of Passmark Software Pty Ltd in Australia and other countries.
Other names are registered trademarks or trademarks of their respective owners.
8 EIO0000001255 09/2019
First Steps
EIO0000001255 09/2019
Chapter 1
First Steps
First Steps
What Is in This Chapter?

This chapter contains the following topics:
Topic Page
First Installation or Upgrade of Process Expert 4.3/SP1 10
Upgrading EcoStruxure Hybrid DCS 2018 or 2018 R2 13
EIO0000001255 09/2019 9
First Steps
First Installation or Upgrade of Process Expert 4.3/SP1
Overview
This topic outlines the steps that you need to complete to get started with EcoStruxure Hybrid DCS
in the following cases:
 You are installing the software for the first time.
 You are upgrading Process Expert 4.3 or V4.3 SP1 with or without reusing a database.
If you want to reuse one or more of your databases with the new version of the software, refer to
the prerequisites (see page 10) before proceeding with the upgrade. Upgrading the software
without migrating a database creates a new blank one (see page 44).
If you are upgrading EcoStruxure Hybrid DCS 2018, refer to the corresponding procedure
(see page 13).
In case you experience difficulties, refer to the troubleshooting topic (see page 171) or contact
EcoStruxure Hybrid DCS support by visiting app.schneider-electric.com/ecostruxure-hybrid-dcs.
Prerequisites to Migrate a Database

Before installing the software upgrade, you need to prepare the database (see page 70) of
Process Expert for migration.
This step requires using the system server of your current version.
Perform this step for each database that you want to reuse.
Getting Started
The table outlines the steps to follow if you are installing the software for the first time or upgrading
Process Expert 4.3 or its service pack. Each step contains a reference to the topic describing the
step more in detail.
Step Action
1 Verify that the computers of the Process Expert system infrastructure still fulfill the system
requirements (see page 37).
2 If you are upgrading and had customized any setting in one of the configuration wizards
(see page 111), write down the modifications because you need to make them again after the
installation of the upgrade is completed (for example, the system server IP address, the folder
shared with the virtual machine).
NOTE: The software automatically backs up the extensions (see page 75) that are installed in
the virtual machines.
3 If you are upgrading, in specific cases, you need to delete a folder (see page 60) before
proceeding with the installation of the upgrade.
4 Extract the files of the installation package (see page 41) to disk or mount the image (.iso).
10 EIO0000001255 09/2019
First Steps
Step Action
5 Install the software (see page 54) by launching the installer.
 For a first-time installation, install at least the system server.
 If you are upgrading, perform this step on the computer on which the Process Expert system
server is installed. You can add and/or remove clients.
Select the authentication type (see page 91) during installation.
NOTE: The steps to follow when you install clients are described at the end of this table.
6 Purchase or update licenses and activate them by using the Floating License Manager
(see EcoStruxure™ Hybrid DCS, Licensing Guide).
7 If you selected the domain authentication, the system/network administrator must create a
group (see page 92) for each EcoStruxure Hybrid DCS role.
(If you selected local authentication, the groups have been created automatically on the
computer on which the system server has been installed.)
8 The system/network administrator must add users (see page 85) who need to use the software
to one or more groups either:
 On the system server computer for a local authentication type. Use the Windows® Computer
Management or lusrmgr (.msc) UI.
 On the domain controller for a domain authentication type. Use the Windows® Active
Directory Administrative Center.
9 Open the system server console and log in (see EcoStruxure™ Hybrid DCS, User Guide) by
entering your username without domain or prefix and your password.
(From the Windows® Start menu, click EcoStruxure Hybrid DCS → System Server.)
10 Create and/or install certificates (see page 93) by using the Security section of the System
Server Configuration Wizard (Settings menu of the system server console).
You can let the software create a root CA certificate or you may be able to use your own.
11 In the Virtual Machine section of the System Server Configuration Wizard, activate
(see page 63) the virtual machine by entering an appropriate Windows® product key
(see page 27).
12 Enter the IP address (see page 121) of the computer on which the Floating License Manager is
installed (if it is not installed on the local computer) by using the Port@Address of Floating
License Manager parameter.
13 Share a folder (see page 120) with the virtual machine.
The shared folder is required when you want to manage files within the virtual machine or
exchange them between the virtual machine and the local computer.
14 For a new installation or if you are not migrating a database, you can select which templates are
added to the database (see page 144) that is created when you start the system server.
15 If you are upgrading and had customized any setting by using the System Server Configuration
Wizard, re-configure the system server with these modifications.
16 If you are upgrading and want to migrate (see page 61) a Process Expert 4.3/SP1 database
1. Re-install extensions (see page 75) in the virtual machine of the system server.
2. Restore the database backup file (.mdbk) (see page 77).
EIO0000001255 09/2019 11
First Steps
Step Action
17 Start the system server (see page 147) by clicking Action → Start in the menu bar of the server
console.
If you are migrating a database, the EcoStruxure Hybrid DCS 2019 Migration window opens and
may require user-interaction (see page 77) to complete the migration of Supervision data.
Wait until Server is ready appears in the console. This may take a moment the first time.
18 Install clients by launching the installer on other computers that you want to be part of the
EcoStruxure Hybrid DCS infrastructure:
 For engineering clients, repeat steps 1, 4, 10, 11, and 13 of this procedure. Use the
Engineering Client Configuration Wizard (from the EcoStruxure Hybrid DCS folder of the
Windows® Start menu).
 For operation clients, repeat steps 1, 4 and 10 of this procedure. Use the Operation Client
Configuration Wizard (from the EcoStruxure Hybrid DCS folder of the Windows® Start
menu).
Install certificates only once per computer even if you are installing both types of clients.
NOTE: If you are upgrading, perform this step on each computer on which a Process Expert
client is installed.
19 if you are upgrading and had customized any setting by using a client configuration wizard,
re-configure clients with these modifications before starting them.
20 if you have migrated a database and want to modify existing systems or create new ones to take
advantage of the new functionalities of the upgrade, you need to import and use the templates
that are supplied with the upgrade (see page 64).
12 EIO0000001255 09/2019
First Steps
Upgrading EcoStruxure Hybrid DCS 2018 or 2018 R2
Overview
This topic outlines the steps that you need to complete to get started if you are upgrading
EcoStruxure Hybrid DCS 2018 or 2018 R2 with or without reusing a database.
If you want to reuse one or more of your databases with the new version of the software, refer to
the prerequisites (see page 13) before proceeding with the upgrade. Upgrading the software
without migrating a database creates a new blank one (see page 44).
In case you experience difficulties, refer to the troubleshooting topic (see page 171) or contact
EcoStruxure Hybrid DCS support by visiting app.schneider-electric.com/ecostruxure-hybrid-dcs.
Prerequisites to Migrate a Database

Before installing the software upgrade, you need to prepare the database (see page 70) of version
2018 or 2018 R2 for migration.
This step requires using the system server of your current version.
Perform this step for each database that you want to reuse.
Getting Started
Each step contains a link to the topic describing the step more in detail.
Step Action
1 If you had customized any setting in one of the configuration wizards (see page 111), write
down the modifications because you need to make them again after the installation of the
upgrade is completed (for example, the system server IP address or the folder shared with the
virtual machine).
2 If you want to retain the HTML help of templates that you have used with version 2018 or
2018 R2, you need to copy the corresponding help files before proceeding with the upgrade.
Without this step, the help of version 2018/R2 is replaced by the help of version 2019.
For details, refer to Using Help for Different Versions of Schneider Electric Templates in the
User Guide of version 2018 or 2018 R2.
3 In specific cases, you need to delete a folder (see page 60) before proceeding with the
installation of the upgrade.
4 Update your licenses and activate them by using the Floating License Manager
5 Extract the files of the installation package (see page 41) to disk or mount the image (.iso).
EIO0000001255 09/2019 13
First Steps
Step Action
6 Install the software (see page 82) by launching the installer.
Perform this step on each computer on which version 2018 or 2018 R2 is installed. You can
remove and/or add software components on each computer during installation.
NOTE:
The following items of version 2018 or 2018 R2 are still valid given that they are not expired (if
applicable):
 The authentication type (see page 91) that you had selected is retained (for system server
computer). However, you can change it.
 User groups and user memberships for RBAC.
 Certificates (see page 93). Except for the root certificate file (.pfx), which is deleted during
the upgrade if you had created it at the default path. In such case, retrieve the file first.
7 In the Virtual Machine section of the System Server Configuration Wizard, activate the virtual
machine by entering your Windows® product key (see page 27). You can reuse the one that
you had used for version 2018 or 2018 R2.
8 Enter the IP address (see page 121) of the computer on which the Floating License Manager is
installed (if it is not installed on the local computer) by using the Port@Address of Floating
License Manager parameter.
9 Re-configure the software components by using the appropriate configuration wizards
(see page 112).
10 If you are not migrating a database, you can select which templates are added to the database
(see page 144) that is created when you start the system server.
11 If you want to migrate (see page 61) a version 2018 or 2018 R2 database:
1. Re-install extensions (see page 75) in the virtual machine of the system server.
2. Restore the database backup file (.mdbk) (see page 77).
12 Start the system server (see page 147) by clicking Action → Start in the menu bar of the server
console.
If you are migrating a database, the EcoStruxure Hybrid DCS 2019 Migration window opens and
may require user-interaction (see page 77) to complete the migration of Supervision data.
Wait until Server is ready appears in the console. This may take a moment the first time.
NOTE: If no database backup file has been restored, a blank version 2019 database is created
(see page 155).
13 if you have migrated a database and want to modify existing systems or create new ones to take
advantage of the new functionalities of the upgrade, you need to import and use the templates
that are supplied with the upgrade (see page 64).
14 EIO0000001255 09/2019
EcoStruxure Hybrid DCS System Infrastructure
EIO0000001255 09/2019
Chapter 2
Overview
This chapter provides a high-level understanding of the main software components that form the
EcoStruxure Hybrid DCS system infrastructure. It also describes how these components can be
installed on various computers depending on the tasks you want to accomplish. For example,
engineering only or runtime-related tasks.

Topic Page
Software Architecture 16
Virtual Machine Usage 20
Virtual Machine Licensing Considerations 27
Physical Architecture 29
Physical Architecture Examples 32
EIO0000001255 09/2019 15
Software Architecture
Overview
The EcoStruxure Hybrid DCS system infrastructure is based on a client/server architecture with
integrated as well as third-party software components. It allows you to run multiple clients with one
server to access the tools that are required in engineering time and during operation.
By using multiple clients, several users can work simultaneously on the same system or perform
similar tasks on various systems.
To use the various software components described in this topic, you need to:
 Purchase and activate the necessary licenses (see EcoStruxure™ Hybrid DCS, Licensing
Guide).
 Generate and install digital certificates (see page 93).
 Create groups and/or add users to groups (see page 85).
NOTE: EcoStruxure Hybrid DCS and Supervision software components are available in separate
installation packages (see page 42).
16 EIO0000001255 09/2019
Software Components
The EcoStruxure Hybrid DCS installation package contains the following software components,
which form the system infrastructure:
 A system server: Manages system data, software Participant activity, and requests from clients.
The user interface consists of a console that allows you to monitor server activity.
 Engineering clients: Provide a user interface that gives access to software platform resources,
such as explorers and editors. In addition, engineering clients display software Participants with
which you can perform in-depth configurations. Together, these resources and tools allow you
to design and maintain systems. You can use several clients at the same time.
 Operation clients: Provide a user interface that allows you to view system components during
runtime (for example, controllers, process objects, process data, and so on) for monitoring and
troubleshooting purposes. These clients display software Participants too. They require a
Supervision client to run in parallel, which is the entry point to runtime navigation services
(RTNS) (see EcoStruxure™ Hybrid DCS, Runtime Navigation Services , User Guide). You can
use several clients at the same time.
 Virtual machines: Provide the services of software Participants (for example Control and
Supervision Participants), which are required in engineering time and during operation. They
are run by third-party software and use the Microsoft® Windows® operating system. Virtual
machines can be accessed by the system server and clients. They can be used in various
configurations depending on the performance of the computers they are installed on and the
number of concurrent users.
For details, refer to the topic describing virtual machine usage (see page 20).
 A database: Consists of several physical databases, which contain template libraries and user
data related to the systems that you create by using the software. Each system has its own
database. The database resides on the computer running the system server and is created
during the first system server start. It is managed by third-party software (see page 43), which
is included.
NOTE: To manage usage rights and application size, the software also utilizes Schneider Electric
license management software (see page 45).
EIO0000001255 09/2019 17
The following figure shows a simplified model of the software architecture of EcoStruxure
Hybrid DCS.
Supervision Software Components

EcoStruxure Hybrid DCS also uses the following software components during runtime:
 Operation server: I/O, alarm, trend, and report servers can be installed on one or distributed
over several computers. One computer requires the configuration tools to be installed. These
consist of various editors, which allow you to complete the deployment of Supervision projects
on the network.
 Supervision clients: Provide a user interface that allows you to monitor and/or control the
process during operation. A Supervision system can be made of several clients, which can be
used simultaneously.
Supervision clients can be either:
 Control clients, which allow you to control the process during operation.
 View-only clients, which allow you to monitor the process. They cannot interact with the
process during operation.
Each operation server also acts as a control client across the Supervision system architecture.
 OPC Factory Server: Acts as an interface between the program and the I/O server and
manages OPC items because OFSOPC is the default communication protocol of systems that
you create by using the software.
18 EIO0000001255 09/2019
The following figure shows the Supervision client/server part of an EcoStruxure Hybrid DCS
architecture.
EIO0000001255 09/2019 19
Virtual Machine Usage
Overview
A virtual machine (VM) provides Software Participant services, which are required to complete the
system engineering life cycle. These services are also required if you want to use the runtime
navigation services.
Each VM that you install, gives you access to a limited number of VM instances (see page 27).
Each VM instance can provide a limited number of Participant sessions of each Participant.
NOTE: You must activate the Microsoft® Windows® operating system of each VM with a suitable
product key (see page 27). You need to purchase product keys separately.
Virtual Machine Network Connection

The virtual machine (VM) has no network connection; do not share the Internet connection of the
host computer with the VM. Sharing the Internet connection may lead to cyber security
vulnerabilities.
Virtual Machine Performance

VMs are demanding in terms of hardware resources and their usage may be limited by the
performance of your computer (see page 38). Especially, sufficient RAM needs to be installed so
that the amount of memory allocated to the VM when it is started is available on the host computer
as free memory.
The amount of physical memory that is allocated to the VM (see page 121) can be configured. This
amount is not available to the host computer anymore while the VM is running. The VM starts as
soon as you start a component that uses it, this is the system server and/or the engineering client.
For good VM performance:
 Avoid running simultaneously with the software:
 Microsoft® Hyper-VTM: If it is installed and enabled, the VM cannot use it.
 Other virtualization software and/or hypervisors.
 If you need to run the software inside a virtual machine, refer to the Application Note Running
EcoStruxure Hybrid DCS System Infrastructure Virtualized, which is available on the Support
Portal. It describes the hardware requirements that are specific to this application.
20 EIO0000001255 09/2019
Software Participant Sessions

Each instance of a VM provides the following Participant sessions, also called slots.
Software Participant Number of slots per VM instance

Control Participant 2
Advantys Configuration Software (ACS) 1
Supervision Participant 1
When no more Participant sessions are available because the corresponding slots are used up,
the software informs you that it cannot provide the Participant services.
For more information on using Participants, refer to:
 The Participant Services User Guides.
 The help of software Participants (see EcoStruxure™ Hybrid DCS, User Guide).
Virtual Machine Instances and Sessions

When configured, each installation of a VM makes it possible to use more than one instance of that
VM. Each instance giving you access to an additional set of Participant sessions.
For example, if you allow the execution of 2 instances of a VM that is installed with the engineering
client, a user can use up to 4 Control Participant slots simultaneously. Each VM instance providing
2 of these slots. The user can, for example, refine 2 Control projects and configure 2 controllers at
the same time.
In addition, various instances of a VM can be accessed by different client computers. Each
instance of the VM being accessible only to one client computer at a time. This means that the slots
of one instance of a VM cannot be shared by several client computers. On each computer an
engineering and/or operation client can be installed. It is irrelevant whether the same user is logged
on to more than one client computer. This rule applies when the VM instance is accessed through
a Participant window (for example, when you use the Configure or Refine command).
EIO0000001255 09/2019 21
In this example, 2 instances are allowed for the VM installed on the system server computer. When
client PC A accesses an instance of this VM through the Participant window and uses only one
slot, client PC B cannot access the remaining slots of this VM. They are reserved for client PC A.
Client PC B will use the second instance of the VM. If a third client computer tries to access the
system server VM through a Participant window, no Participant services can be provided because
this would require a third VM instance.
22 EIO0000001255 09/2019
Sharing the slots of a VM instance is only possible when:

 The VM instance is accessed simultaneously by several client computers but only one of them
is accessing it through a Participant window. The other client computers need to access it
without using the Participant window (for example, by using the Generate or Build command).
In this case, slots of the VM instance are assigned to client computers on a first come, first
served basis.
 The VM instance is accessed from the same client computer, for example when the engineering
and operation clients are used simultaneously. It does not matter if the VM instance is accessed
through a Participant window.
NOTE: The use of instances of a VM by more than one user needs to satisfy the VM licensing terms
(see page 27).
EIO0000001255 09/2019 23
Virtual Machine Usage by Software Component

The following figure shows the most common VM usage scenarios in an EcoStruxure Hybrid DCS
infrastructure consisting of a system server with three client computers connecting to it. On each
computer an engineering and/or operation client is installed. Dotted double-ended arrows
represent the connection between the system server and a client. Solid double-ended arrows show
which VM the component is configured to use.
24 EIO0000001255 09/2019
The table describes the various possibilities of VM usage that you can configure for each
component and their limitations.
Software component
VM that the component can use
requiring VM services
System server VM Engineering client VM (installed on
engineering station)
System server Yes Yes
Engineering client Yes (2) (3)
Yes(3)
By default, the engineering client uses
the local VM to help improve
performance but, if allowed
(see page 121), uses the system server
VM when needed.
Operation client Yes(1) (2) (3) Yes(1) (3)
NOTE: An operation client When the operation and engineering
installation does not include clients are installed on the same
a VM. computer, the operation client can use
the VM of the engineering client.
(1) Each operation client uses 1 Control Participant slot of a VM. The other slots remain available
to the engineering client installed on the same computer.
(2) The system server VM must be configured to allow clients to use it.
(3) When several clients access the same VM, they use instances of that VM on a first come, first
served basis. In the case where more than 1 instance of a VM is allowed, once no more slots
are available to a client, another instance of the VM is started as long as the number of instances
is within the limit.
If clients are configured to use the local VM and can also use the VM of the system server, the
local VM is used first. Once the maximum number of allowed local VM instances is reached, the
VM of the system server is used.
Virtual Machine Usage Recommendations

To help improve performance, it is recommended to allow the usage of VMs on the following
computers:
 For use by engineering clients: On the local computer (engineering station).
 For use by operation clients: On the system server computer.
The obligation for clients to use their local VM or the right to use the system server VM are
configurable after you install a component by using its Configuration wizard (see page 120).
In addition, the configuration wizards (see page 120) allow you to configure the maximum number
of VM instances that can run in the system server and engineering clients.
NOTE: By default, when you install the software, VMs are installed and configured (see page 120)
as per these recommendations.
EIO0000001255 09/2019 25
Insufficient Free Disk Space Notification

At least 25 GB of free space needs to be available when an instance of the VM starts. The free
space is required on the drive containing the Windows® operating system (typically C:\) of the
computer on which the VM is running.
A VM starts in the following situations:
 You start the system server (starts the local VM).
 You start the first instance of an engineering client that connects to a remote system server and
that is configured to use a local VM (starts the local VM).
 Your action starts a second instance of the VM (starts a VM on the system server computer).
This can happen, for example, if you refine a Control project, which requires a slot of the VM but
all the slots of the first VM instance are already used.
The free space is required so that VM-related processes can execute correctly. The amount of
space that is required depends on the size of the projects that you are working with and on how
many slots (see page 21) you are using at once.
If the software detects that less than 25 GB of free space is available when a VM starts, it displays
a notification in the system server console and the notification panel of connected clients. In such
case, try to free some disk space.
Also, Schneider Electric recommends checking regularly the amount of free space that remains on
the above mentioned drive.
Virtual Machine Time Zone

By default, the time zone of the operating system of the VM is set to (UTC +05:30).
If needed, you can synchronize the time zone of the VM with the one of the host computer or set
another time zone (see page 141).
26 EIO0000001255 09/2019
Virtual Machine Licensing Considerations
Overview
You must purchase licensing rights to use VMs that you install for various software components.
VMs use the Microsoft® Windows® 10 Professional operating system.
This objective of this topic is to help you understand VM licensing concepts and determine the
number of VM licenses you need to purchase. It also outlines various license types that Microsoft®
offers.
NOTE: The information in this topic is provided for guidance only. It does not constitute legal advice
or interpretation. You must ensure that you comply with Microsoft® Software License Terms in any
case. For more information, contact your local software distributor or visit
www.microsoft.com/licensing.
Virtual Machine Licensing Principles

The VM licensing terms of Microsoft® limit the number of instances of an activated VM that 1 user
can use simultaneously at 4.
2 users cannot use the instances of a VM simultaneously with only 1 license.
If, for example, 2 users are using 2 instances of the same VM each, then 2 licenses are required.
If they do not work simultaneously, only 1 license is required.
Determining License Needs

You need to determine how many licenses you need to purchase, depending on the concurrent
usage of software components that use VMs.
For volume licenses, based on the Microsoft® VM licensing principles, the rule is: Number of
licenses = number of users using a VM simultaneously.
For example, consider the following system infrastructure:
 PC_1: System server with VM
 PC_2: 1 engineering client with VM
 PC_3: 1 engineering client with VM and 1 operation client
The operation client is configured to use the VM of the system server.

The total number of VMs installed is 3: 1 for the system server and 1 for each engineering client.
At any time, 2 users (User_A and User_B) work simultaneously in the following way:
 No one works on PC_1.
 User_A working on PC_2 uses the VM on PC_2.
 User_B working on PC_3 uses:
 The VM on PC_3 when working with the engineering client.
 The VM on PC_1 when working with the operation client.
The number of licenses that is required is 2 even if sometimes User_B uses both engineering and
operation clients simultaneously on PC_3.
EIO0000001255 09/2019 27
License Types
The table outlines the various Microsoft® license types that are available to activate VMs.
License type Description Operating system of the Activation method

computer
Individual Usage rights for 4 instance of Microsoft® Windows® 7 By using either a:
Microsoft® Windows® 10 a VM. or 10 Professional  Digital license (obtained
Professional license One-time purchase. from the Microsoft®
Store).
 Product key (obtained
from an authorized
retailer).
Software Assurance (SA) Contract with Microsoft®, 2 possibilities:
which details the software type  Through multiple
and quantity that you want to activation key (MAK)
run.  Through Key
Monthly fee. Management Service
Virtual Desktop Access Contract with Microsoft®, (KMS) server
Client Access Licenses which details the software type Provided through the
(VDA CAL) and quantity that you want to Microsoft® Volume
run. Licensing Customers
Monthly fee. portal.
VDA CAL is included with the
SA.
Windows Server The license includes rights to Microsoft® To run the VM, you need to
Standard license run 2 VMs; however you Windows Server® 2012 R2 purchase either:
cannot use these rights for the  SA
EcoStruxure Hybrid DCS VM.  VDA CAL
The license includes rights to Windows Server Data  Product keys
run an unlimited number of Center
VMs; however you cannot use
these rights for the
EcoStruxure Hybrid DCS VM.
NOTE: For details, contact your local software distributor or visit www.microsoft.com/licensing.
Activating Licenses for VMs

Configuration wizards allow you to activate licenses for VMs by using a product key or through
KMS server.
For more information, refer to the topic describing VM activation (see page 143).
28 EIO0000001255 09/2019
Physical Architecture
Overview
The software provides the flexibility to install software components on various physical
architectures depending on the performance of the computers, the number of concurrent users,
and your work method. Client stations and servers need to be connected to each other on an
Ethernet network by a cable connection. A cable connection to the control network is also
necessary.
Physical Architecture Description

Typically, the physical architecture on which an EcoStruxure Hybrid DCS infrastructure is running
consists of computers that have the following roles and connections.
Role of the computer Number of Description computer connected to

computers
Servers
System server 1 Runs the System Server. Ethernet station/server
network.
Ethernet control network (if
the virtual machine of the
system server is used).
Operation server 1 or more Runs Supervision server software to Ethernet station/server
collect real-time data from devices network.
and treat it according to its nature (for Ethernet control network.
example, alarms or trends).
Each operation server also acts as a
control client.
Clients
Engineering station 1 to n Runs an Engineering Client to Ethernet station/server
engineer and maintain systems. network.
Requires the services of a virtual Ethernet control network (if
machine, either locally or on the the local virtual machine is
system server. used).
Operator station 1 to n Runs Supervision control or view-only Ethernet station/server
client software to monitor and control network.
the automation system. Ethernet control network
Requires an Operation Client to do (required to use the
online diagnosis by using runtime Operation Client).
navigation services
(see EcoStruxure™ Hybrid DCS,
Runtime Navigation Services , User
Guide). Operation clients require the
services of a virtual machine.
EIO0000001255 09/2019 29
NOTE: computers can cumulate several roles in which case you need to install the software that
is required for each role. Verify that each computer meets the requirements (see page 41) of each
role.
NOTE:
For more information, refer to the topics describing:
 Example architectures. (see page 32)
 The installation of Supervision software (see page 55).
 Virtual machine usage (see page 20).
The following figure shows an example of a physical architecture running EcoStruxure

Hybrid DCS.
NOTE:
The following can exist but are not represented:
 Multiple engineering and operator stations.
 Redundant and/or multiple operation servers.
30 EIO0000001255 09/2019
Performance Considerations
If you are using a client that is installed on the system server computer and perform CPU-intensive
operations (for example, importing many instances), actions that you execute immediately after
may trigger notifications about client/server communication interruptions.
For more information, refer to the troubleshooting topic (see page 178).
Network Connections
If you experience difficulties with client/server communication, refer to the topic providing
troubleshooting information (see page 178).
EIO0000001255 09/2019 31
Physical Architecture Examples
Overview
With the use of examples, this topic describes some common architectures and outlines the VM
license requirements depending on the number of users working simultaneously.
It also shows the connections to the control network that are required.
Use these examples as a guideline to determine the architecture that is adapted to your needs and
the resulting license requirements.
NOTE: This topic does not describe EcoStruxure Hybrid DCS and application size license
requirements (see EcoStruxure™ Hybrid DCS, Licensing Guide).
All-In-One Architecture
The all-in-one architecture is a common small engineering configuration with:
 A single user.
 One VM requiring one license.
The following figure shows an architecture where all software components are installed on one
computer.
(1) computer with the system server, a VM, one engineering, and one operation client. Up to four
instances of the VM are available to the user.
(2) Controllers.
(3) Ethernet control network.
32 EIO0000001255 09/2019
NOTE: Optionally, Supervision software (one operation server and its Supervision control client)
can also be installed on the computer for testing purposes. This does not affect the VM license
requirements.
Engineering Architecture
This architecture is a common medium-size configuration that is used by system integrators with:
 Up to three users working simultaneously.
 Three VMs requiring three licenses:
 Two VMs on engineering stations.
 One VM on the system server.
(1) System server combined with operation server: Computer with the system server, a VM, one
engineering client, one operation client, and Supervision software (one operation server and its
Supervision control client).
(2) Engineering station: Computer with one engineering client and a VM.
(4) Controllers.
EIO0000001255 09/2019 33
NOTE: Up to four instances of the VM are available to each user.

NOTE: In the case where no engineering client is installed on the system server, no separate
license is required for the VM of the system server. Up to two users can work simultaneously on
the engineering stations, which requires two VM licenses. The VM license that is used for one of
the engineering stations can be used for the system server also.
On-Site Architecture
This architecture models small to medium-size configurations, which are deployed on site with:
 One engineering user and up to four operators working simultaneously.
 Three VMs requiring five licenses:
 The VM of the engineering client on the engineering station (2) requires one license.
 The VM of the engineering client on the operator station (3) requires one license.
 The three operation clients on the three other operator stations (4) use the VM on the system
server, which requires three licenses.
34 EIO0000001255 09/2019
(1) System server: Computer with the system server and a VM, which is used by operator stations
(4).
(3) Operator station combined with engineering station: Computer with one Supervision control
and/or view-only client, one operation client, one engineering client, and a VM.
(4) Operator stations: Three computers with a Supervision control and/or view-only client, and an
operation client.
(5) Operation servers (redundant or specific): Computers with Supervision servers.
(6) Controllers.
NOTE:
 Each user of an engineering station ((2) and (3)) can use up to four instances (see page 20) of
the local VM.
 Each user of an operator station ((3) and (4)) can share the instances of the VM (see page 21)
of the system server.
EIO0000001255 09/2019 35
36 EIO0000001255 09/2019
System and Installation Requirements
EIO0000001255 09/2019
Chapter 3
Overview
This chapter describes the requirements to install the software on your computer. It also provides
general information, which applies whether you install the software for the first time or upgrade an
earlier version.

Topic Page
System Requirements 38
Software Requirements 41
General Installation Information 44
Installation Requirements 50
Installing the Controller Simulator 51
EIO0000001255 09/2019 37
System Requirements
Overview
This topic describes the hardware and operating system requirements.
The hardware requirements depend on the role of the computer (see page 29) in the EcoStruxure
Hybrid DCS system infrastructure.
CPU Performance
Because of the various criteria that impact CPU performance, the required processor performance
level is defined by using the PassMark® CPU mark. To find a CPU that meets the indicated
performance requirement, look up the CPU benchmarks available at passmark.com.
NOTE: Restrictions on the number of supported CPU cores (see page 38) apply.
CPU Virtualization Settings

Using a CPU that supports hardware virtualization capabilities (HVC) and enabling VT-x or AMD-
V in the BIOS is mandatory to be able to use a VM (see page 24) and start the system server.
System Server Hardware Requirements
Component Requirements
CPU CPU mark according to application size:
 Small (<1,250 objects): 5,000 (minimum)
 Medium (<3,000 objects): 8,000
 Large/extra large (>3,000 objects): 10,000
A maximum of 16 processor cores due to restrictions from the license of the database,
which can prevent the system server from starting (see page 174).
RAM Recommended: 24 GB
Minimum: 16 GB
Hard drive 250 GB, 7,200 RPM minimum. SSD recommended. NTFS file system.
40 GB of free space to install and run the software.
Display 1920 x 1080 or higher
Ports Ethernet port
Input devices Mouse or compatible device
Keyboard
38 EIO0000001255 09/2019
Operation Server Hardware Requirements
CPU Varies according to application size.
Display 1920 x 1080
Ports Ethernet port
Keyboard
NOTE: For detailed information, refer to the chapter describing installation requirements in the
Citect SCADA Installation and Configuration Guide.
Engineering Client Hardware Requirements
CPU CPU mark according to application size:
 Small (<1,250 objects): 5,000 (minimum)
 Medium (<3,000 objects): 8,000
 Large/extra large (>3,000 objects): 10,000
Minimum: 16 GB
40 GB of free space to install and run the software.
Ports Ethernet port
Keyboard
NOTE: The same requirements apply if, in addition, you install an operation client on the computer.
EIO0000001255 09/2019 39
Operation Client Hardware Requirements
CPU CPU mark: 2,000 minimum
RAM Minimum: 4 GB
Ports Ethernet port
Keyboard
Operating System Requirements
Supported operating systems Recommended for (station role)

Microsoft® Windows Server® 2016 Standard (versions 14393 System server
and earlier)
Microsoft® Windows Server® 2012 R2
Microsoft® Windows® 10 Professional 64-bit (versions 1803 and –
earlier)
Microsoft® Windows® 7 Professional 64-bit
NOTE: The software has been tested with operating systems configured in the following
languages: English, French, Chinese, German, and Spanish.
40 EIO0000001255 09/2019
Software Requirements
Overview
You can install EcoStruxure Hybrid DCS 2019 on a computer in either of the following cases:
 No EcoStruxure Hybrid DCS software is installed.
 One of these supported earlier versions of the software is installed:
 EcoStruxure Hybrid DCS 2018 or 2018 R2.
 Process Expert 4.3 or V4.3 SP1.
You must have administrator rights to install the software.

Installing the software automatically removes the earlier version of the software if installed.
Each case is described more in detail in dedicated chapters.
Only a 64-bit installation package is provided.
NOTE: If you are upgrading a supported earlier version, you can migrate and reuse your database
(see page 44) with version 2019. In such case, you need to perform certain steps before installing
the software upgrade.
Upgrading the software without migrating a database creates a new blank one (see page 155).
Digital Certificates
The software implements a public key infrastructure (PKI) based on the X.509 standard. It allows
using a self-signed root certification authority (CA) and entity certificates to secure client/server
communication in the EcoStruxure Hybrid DCS system infrastructure.
You must generate and install certificates (see page 94) before you can use the system server and
clients.
Role Based Access Control

The software implements role based account control (see page 86) to administer the tasks that
authorized users can perform by assigning them predefined roles. Roles are associated to groups.
A person with administrator rights for the computer needs to create groups and/or add users to one
or more of these groups so that they can log in to software components.
Opening the Installation Package

The installation package is supplied in the form of an ISO file. Use either method to open it:
 An ISO file management tool.
With Windows® 10, you can use the Windows® Explorer. Right-click the file and select Open
with.
 An archive management tool. 7-Zip is the recommended tool. It is a freeware. You can
download it at www.7-zip.com.
EIO0000001255 09/2019 41
Supervision Software Requirements

To complete the deployment of Supervision projects and use Supervision runtime, you need to
install the following software, which is available in separate installation packages:
 Citect SCADA 2018 update 11.
 OPC Factory Server 3.62 SP1 (version 3303, LARGE (L) configuration).
For more information on the installation of Citect SCADA and OPC Factory Server, refer to
Installing Supervision Software (see page 55).
NOTE: You can download the software from the EcoStruxure Hybrid DCS Support Portal,
Software Downloads section. Registration required.
Control Expert Installation Requirements

If you want to create Control Expert projects and import them into the software or open Control
project files coming from EcoStruxure Hybrid DCS with Control Expert, you need to use the same
version of Control Expert as installed in the virtual machine and the appropriate Control Expert
DTM library version. Refer to the platform release notes for version details.
If the appropriate Control Expert version is already installed, install the appropriate DTM library.
If you experience difficulties with the exchange of Control project files between the software and
Control Expert, contact EcoStruxure Hybrid DCS support.
NOTE:
For versions of Control Expert that are earlier than the one installed in the virtual machine:
 Having Control Expert installed on the same computer does not interfere with EcoStruxure
Hybrid DCS as long as you install EcoStruxure Hybrid DCS after Control Expert; however, you
will not be able to exchange Control project data.
 If EcoStruxure Hybrid DCS is already installed and you do not want to uninstall it, you need to
install Control Expert on another computer.
Other Software Requirements

The following software should be installed on your computer before installing EcoStruxure
Hybrid DCS:
 Internet Explorer® browser for computers on which the operation client is installed. Minimum:
version 7 or higher. Recommended: Installing the latest version. Configure the browser to be
the default browser.
 Adobe® Reader® software.
42 EIO0000001255 09/2019
Third-Party Components Installed By the Software

The software installs third-party components that it requires to function properly, such as Oracle®
VM Virtualbox software, which handles the virtual machine and InterSystems Caché software,
which manages the database.
Only the version that is provided in the installation package is tested and validated. Updating these
third-party components independently of the EcoStruxure Hybrid DCS installation leads to
incompatibilities.
NOTICE
UNEXPECTED SOFTWARE BEHAVIOR
Use only the version of third-party software that is installed by the EcoStruxure Hybrid DCS
installer.
Failure to follow these instructions can result in unusable systems or database.
NOTE: Refer to the topic providing general installation information for details about the version of
third-party software that is installed (see page 45).
License Requirements
The table outlines the license-related actions that are required to use the software.
License type Software version that is upgraded Required action

EcoStruxure None (first installation) Purchase your software licenses and activate
Hybrid DCS licenses them by using the Schneider Electric Floating
License Manager.
Process ExpertV4.3 or its service Update your current licenses and activate them.
pack
EcoStruxure Hybrid DCS 2018 or
2018 R2
Virtual machine None (first installation) Purchase a digital license or product key
operating system Process ExpertV4.3 or its service (see page 28) and activate the operating system
license (see page 27) (see page 143) of the virtual machine.
pack
EcoStruxure Hybrid DCS 2018 or Activate the operating system of the virtual
2018 R2 machine by reusing your product key
(see page 143).
EIO0000001255 09/2019 43
General Installation Information
Overview of Installation Scenarios

The table outlines various software installation and database migration scenarios and describes
the result in terms of available systems and templates.
Software installation Database migration Result

scenarios
Version 2019 is installed None Creates a database containing templates
without an earlier version of (see page 64) delivered with version 2019(2).
the software installed on the
The version 2019 system The migrated database replaces(1) the version
computer.
server is started without 2019 database, which was created during the
database migration. Later first server start. Only systems and templates
only, the user restores and contained in the migrated database are
migrates a database backup available.
of Process Expert 4.3/SP1 or Systems created and templates delivered with
version 2018/R2 (it can version 2019 are not available anymore.
come, for example, from However, you can import templates
another system (see page 64) delivered with version 2019.
infrastructure).
Version 2019 is installed to None Creates a new database containing templates
upgrade (see page 64) delivered with version 2019(2).
Process Expert 4.3/SP1 or A database backup of the earlier version can
version 2018/R2 installed on be migrated at a later time to be reused.
the computer.
The user restores a database A version 2019 database is not created. Only
backup of systems and templates contained in the
Process Expert 4.3/SP1 or migrated database are available.
version 2018/R2, which is Templates (see page 64) delivered with
migrated during the first start version 2019 are not available. However, you
of the version 2019 system can import them.
server.
The version 2019 system The migrated database replaces(1) the version
server is started without 2019 database, which was created during the
database migration. Later first server start. Only systems and templates
only, the user restores a contained in the migrated database are
database backup of available.
Process Expert 4.3/SP1 or Systems created and templates delivered with
version 2018/R2, which is version 2019 are not available anymore.
migrated by restarting the However, you can import templates
system server. (see page 64) delivered with version 2019.
(1) When you restore a database, it replaces the mounted database, which remains on the computer
(see page 153).
(2) By default, the database may not contain all the templates that are available. You can change the setting
(see page 144).
44 EIO0000001255 09/2019
NOTE: Typically, a software upgrade comes with one or more libraries, which contain only the
latest version of each template. Without these latest templates, new functionalities are not
available (for example, support of new controller platforms or new communication modules). For
more information on the latest version of templates, refer to the Library Release Notes.
If you intend to migrate the database of an earlier version, refer to the topic describing how to use
templates supplied with the software upgrade (see page 64).
User Interface Language

The user interface of Hybrid DCS and the help are available only in English.
User Rights
EcoStruxure Hybrid DCS and Schneider Electric licensing software (see page 45) are installed so
that they are available to all the users of the computer.
However, only authorized users can log in (see page 86) and use the system server and/or clients.
Installed Software Components

During installation of the software, you have the choice to install any combination of the following
system infrastructure components on the computer.
EIO0000001255 09/2019 45
When you install a given software component, the following additional software components are
installed. The table also indicates the installed version.
EcoStruxure Virtual machine Database Schneider Elect Schneider Electric Floating Schneider
Hybrid DCS (see page 20) (Caché version ric License License Manager version Electric
system (Oracle® 2017.1.3.317.0) Manager 2.4.0.0 Software
infrastructure VM Virtualbox version 2.4.0.0 Update
component version 5.1.30 and
HybridDCS.Vm.X.
Win10.64.Y.vdi(1)
virtual machine
file)
System Yes Yes Yes(2) Optional(2). An EcoStruxure Yes
server If an earlier Hybrid DCS system This
version is infrastructure requires at least application
installed on the one Floating License informs you
computer, you Manager. of available
need to allow It corresponds to the License updates for
the installer to Server check box during installed
upgrade it installation. Schneider
during If you select it (default) and an Electric
installation; earlier version is already software
otherwise setup installed on the computer, you and lets you
cannot need to allow the installer to install them.
complete. upgrade it during installation; An Internet
otherwise setup cannot connection
Engineering Yes No No
complete. is required.
client
If you want to use the Floating
Operation No No No License Manager on another
client computer on which no
component is installed, verify
that it is of the same version
as the License Manager
installed by the software.
For more information, refer to
the topic describing licensing
mechanisms
(see EcoStruxure™
Hybrid DCS, Licensing
Guide).
(1) Where X is the software version and Y an alphanumerical revision index.

(2) Upgrading the License Manager or Floating License Manager may change the license server
port value (see page 47).
NOTE: If you install the system server and an engineering client on the same computer, it installs
only one virtual machine.
46 EIO0000001255 09/2019
NOTE: You can also install the Floating License Manager separately by running the EcoStruxure
Hybrid DCS installer and selecting only the License Server check box in the Station Role dialog
box.
License Server Port Settings

The installation of EcoStruxure Hybrid DCS 2019 may modify the default settings of
Schneider Electric licensing software (see page 45) that is installed on the computer.
The table indicates which parameters are modified and the new value after the installation.
Software component Parameter Parameter value Comment

after installing
Hybrid DCS
Floating License Manager License Server Port 27011 If you had modified the default
license server port value (27010),
no change is made.
License Manager Vendor Daemon / Server 27011 The server port value is changed
Port(1) only for Host Name / IP Address
equal to 127.0.0.1 (default value).
(1) This parameter can specify either the vendor daemon port or the license server port of the Floating License
Manager.
The modification is done when the installer updates the earlier version of the Floating License
Manager that is installed on the computer.
After installation, verify that the server port setting is the same in the Floating License Manager and
License Manager of the EcoStruxure Hybrid DCS 2019 system infrastructure. In particular if the
two are not installed on the same computer.
For information on how to verify and/or modify the server port setting, refer to the topic describing
how to configure an Enterprise License Server (see EcoStruxure™ Hybrid DCS, Licensing Guide).
NOTE: If other software acquires license rights from a Floating License Manager whose license
server port was changed, verify that these license rights remain available to the software.
EIO0000001255 09/2019 47
Installation Log Files

The installer logs the activities performed during software installation in two log files.
File name Path Content

EcoStruxure Hybrid DCS C:\ProgramData\Schneider Electric\Hybrid DCS x(1).  Installed, modified,
Installation.log repaired, and
uninstalled software
components.
 Component version.
 Applied hotfixes.
 Status of the action.
Hybrid DCS x_reg.log(1) Folder designated by the Microsoft® Windows® Microsoft® installer (MSI)
%TEMP% environment variable. verbose logging
information.
(1) Where x corresponds to the version of the software that you have installed
Databases
When you install the software and start the system server, a new database is created.
If you are upgrading a supported earlier version and have created a backup for migration of the
database before installing the upgrade, you have the possibility to reuse the database of the earlier
version after migrating it (see page 70).
Virtual Machine
If you are installing a component that uses a virtual machine, the installer may give you the option
to keep the existing virtual machine file or replace it.
During installation, the software verifies if a virtual machine file (.vdi) is present at the location
specified in the Destination Folder dialog box.
If no corresponding virtual machine is present at this location (for example, because the virtual
machine of an earlier version is in a different location), the software automatically installs the virtual
machine included in the installation package.
If a corresponding virtual machine is already present at this location, the software gives you the
choice to continue using the existing virtual machine or to replace it with the one included in the
installation package.
If the installer is not able to extract the virtual machine file from the installation package, it displays
a notification during installation. Refer to the troubleshooting section (see page 172) for details.
NOTE: If you replace the virtual machine, you will lose any changes that you have made to it (for
example, updates of the Libset of the Control Participant) and you will need to activate it.
48 EIO0000001255 09/2019
Default Destination Folders

The default installation paths are:
 For EcoStruxure Hybrid DCS: C:\Program Files\Schneider Electric\EcoStruxure\Hybrid DCS
 For the Db (database, for system server only) and VM (virtual machine, for system server and
engineering clients) folders: C:\ProgramData\Schneider Electric\Hybrid DCS x (where x
corresponds to the version of the software that you are installing, for example, 2019).
NOTE: You can change both paths during installation and the path to the VM folder (see page 121)
also after installation.
EIO0000001255 09/2019 49
Installation Requirements
Firewall Exceptions
The installation process modifies the Windows® firewall settings of the computer to allow
communication with applications that it installs.
If you are using a firewall other than the Windows® one, modify the settings of the firewall to allow
incoming connections with these applications.
The following paths correspond to a default installation of the system server with its virtual
machine:
 VBoxHeadless: C:\Program Files\Oracle\VirtualBox\VBoxHeadless.exe
 VBoxWrap: C:\Program Files\Oracle\VirtualBox\VBoxWrap2.exe
 HostAgent: C:\Program Files\Schneider Electric\EcoStruxure\Hybrid DCS\System
Server\HostAgent.exe
 SystemServer: C:\Program Files\Schneider Electric\EcoStruxure\Hybrid DCS\System
Server\SystemServer.exe
When you install only an engineering client on the computer, only settings for the VBoxHeadless
and VBoxWrap applications are required in the firewall. No settings are required when you install
only an operation client.
NOTE: The entries created by the installer of an earlier version of the software may remain when
the program is removed.
Enabling .NET Framework 3.5 for Microsoft® Windows Server® 2012 R2

Before installing the software, you need to enable .NET Framework 3.5.
Refer to the activation procedure, which is described at technet.microsoft.com/en-
us/library/dn482066.aspx to enable .NET Framework 3.5.
NOTE: Windows® needs to download the .NET Framework 3.5 package from the Internet. If you
do not have an Internet connection, refer to the offline activation procedure, which is described at
support.microsoft.com. The procedure requires the operating system installation media.
Installing .NET Framework 4.6.1 for Microsoft® Windows Server® 2012 R2, and Windows® 10
Before you can install the software on a computer, .NET Framework 4.6.1 needs to be installed:
 For Windows® 7 and Windows® 10 (version earlier than 1511): The installer installs it
automatically after you confirm the operation.
 For Microsoft® Windows Server® 2012 R2: The installer installs it automatically only if the
required Windows® updates are installed on the computer. If not, the installation of the software
is canceled and you need to install these updates manually first.
For information on the required updates and how to install them, refer to the FAQ section of the
EcoStruxure Hybrid DCS support portal.
NOTE: .NET Framework 4.6.1 is already installed on Windows® 10 versions later than 1511.
50 EIO0000001255 09/2019
Installing the Controller Simulator
Overview
The installation package includes the PLC_Simulator folder, which contains the files required to run
an emulated simulator software. You can use it to perform deployment and execution tasks for
Control Participant projects.
When you install any component on a computer, the Controller Simulator application is installed.
By default, the simulator is installed with a setting that secures the Ethernet port of the computer,
which it uses. This setting applies only to the Windows® session of the user who is logged on
during installation.
Modifying this setting during the installation or installing the simulator on another computer makes
the computer vulnerable to cyber attack.
Securing the Ethernet Port of the Controller Simulator

During installation, in the Controller Simulator Ethernet Port Vulnerability dialog box a check box
is shown, which impacts the way the simulator is started.
Check box Result

Selected (default and The simulator is started with a password-protected Control project being loaded by
recommended default. This secures the Ethernet port of the computer (port 502 by default) that is
setting) used by the simulator and helps reduce vulnerability to cyber attack.
NOTE: If you are upgrading the software and the Ethernet port of the computer is
already secured, the check box is unavailable.
Cleared The simulator is started without a Control project being loaded. This leaves the
Ethernet port of the computer (port 502 by default) unsecured and may allow a cyber
attacker to gain access to the computer to execute, for example, malicious code.
NOTE: Securing the Ethernet port used by the simulator must be part of a global approach to make
your control environment less vulnerable to cyber attack. A topic dedicated to cybersecurity is
available in the support area of the Schneider Electric website.
Default Control Project Provided

When you install the software, a password-protected Control project file is copied to the computer:
 Full path: %localappdata%\Schneider Electric\Hybrid DCS\simulatorprofile.sta (by default, the
value of the %localappdata% environment variable is C:\Users\ <username>\AppData\Local)
 Password: 31081986@v!sh
This is the file that is loaded into the simulator when you select the check box in the Controller
Simulator Ethernet Port Vulnerability dialog box.
NOTE: For information on how to change the password, refer to the topic describing password
management.
EIO0000001255 09/2019 51
Default Simulator Installation Path

When you install the system server, the PLC_Simulator folder is copied to the computer at the path
C:\Program Files (x86)\Schneider Electric.
Installing the Simulator on a Computer Without Installing the Software

Schneider Electric recommends to install and use the simulator on a computer on which
EcoStruxure Hybrid DCS is installed so that the Ethernet port of the computer that is used by the
simulator is secured by using default installation settings.
To install the simulator separately on a computer on which the software is not installed, proceed
as follows.
Step Action
1 Copy the PLC_Simulator folder to the computer.
The folder is located in the installation package at the path Program Files\Schneider Electric.
2 Copy the simulatorprofile.sta file to the computer.
The file is located in the AFS folder in the root of the installation package.
NOTE: If you had installed the simulator that was provided with an earlier version of the software
on another computer, you must replace it with the simulator provided with this version of
EcoStruxure Hybrid DCS.
Securing the Ethernet Port for Other Windows® Sessions

The setting to secure the Ethernet port of the computer applies only to the Windows® session of
the user who is logged on during installation.
When another user logs on to the computer and starts the simulator, no password-protected
Control project is loaded. The simulator needs to be configured manually (see EcoStruxure™
Hybrid DCS, User Guide) to load the default Control project provided with EcoStruxure
Hybrid DCS or another one.
Using the Simulator

For information on how to use the simulator, load another password-protected Control project, refer
to the topic describing the deployment to an emulated simulator (see EcoStruxure™ Hybrid DCS,
User Guide).
52 EIO0000001255 09/2019
Installing the Software
EIO0000001255 09/2019
Chapter 4
Overview
This chapter describes how to install the various components of EcoStruxure Hybrid DCS and
highlights specific points of the installation of Supervision software, which is required during
runtime.

Topic Page
Installing the Software for the First Time 54
Installing Supervision Software 55
EIO0000001255 09/2019 53
Installing the Software for the First Time
Overview
The installer installs necessary software depending on the components that you select during
installation.
The computer may restart automatically during the installation process and requires a restart to
complete it.
NOTE: If you are upgrading a supported earlier version, refer to the topic describing how to
upgrade the software (see page 57).

The table describes the procedure to install the software on the computer.
Step Action
1 Verify that the hardware and software requirements (see page 41) are fulfilled.
2 Quit Schneider Electric applications that are running.
3 Verify that .NET Framework is enabled (see page 50) (for Windows® 10 and Microsoft®
Windows Server® 2012 R2 operating systems).
4 Temporarily disable antivirus services (such as real time, scripting) running on the computer.
5 Double-click the setup.exe file located in the root of the installation package.
Result: The installation procedure starts.
6 Follow the instructions on screen.
7 Accept the End User License Agreement (EULA).
8 In the Station Role dialog box, select the components (see page 45) that you want to install on
the computer depending on the machine role (see page 29).
9 If you selected to install the system server component, in the Authentication Settings dialog box,
configure the settings for role based access control (see page 85).
10 Click Finish to exit the installer.
11 Restart the computer when prompted to complete the installation process.
NOTE: To disable the USB port monitoring service of Oracle® VM Virtualbox software after
installation, use the registry entries file provided (see page 179).
54 EIO0000001255 09/2019
Installing Supervision Software
Installation Requirements
To complete the system engineering life cycle and use Supervision services during operation, you
need to install Supervision software (see page 42) on machines that serve as:
 Operation server: Install operation server software (configuration tools are required on at least
one operation server).
 Operator station: Install a Supervision control and/or view only client.
For more information, refer to the Citect SCADA 2018 Installation and Configuration Guide, which
is available in the software installation package and shown during installation.
NOTE: To use runtime navigation services, you need to install on the same computer, an
EcoStruxure Hybrid DCS operation client (see page 29) in addition to the Supervision client.
An operation client requires the services of a virtual machine (see page 24). By default, it is
configured to use the virtual machine of the system server.
Installing Schneider Electric Licensing Software with Citect SCADA

The version of the licensing software that is installed by Citect SCADA 2018 is earlier than the
version required for (see page 45) and installed by EcoStruxure Hybrid DCS 2019. Therefore:
 Install Citect SCADA 2018 first and clear the Schneider Electric Floating License Manager
check box when prompted to select the components to install (selected by default).
 Then, installing an EcoStruxure Hybrid DCS 2019 component on this computer afterwards
lets you install the required Schneider Electric License Manager and/or Floating License
Manager.
 If you do not need to install a software component on this computer but need the Floating
License Manager, you can install it by using the EcoStruxure Hybrid DCS installer. In the
Station Role dialog box, clear all but the License Server check box. This installs only the
Floating License Manager.
 If EcoStruxure Hybrid DCS 2019 is already installed, when you install Citect SCADA 2018,
clear the Schneider Electric Floating License Manager check box when prompted to select the
components to install (selected by default).
For configuration information, refer to Configuring an Enterprise License Server for Supervision
Software (see EcoStruxure™ Hybrid DCS, Licensing Guide).
NOTE: The License Manager is not required by Citect SCADA.
Installing Drivers
When you install the operation server, in the Select Drivers screen, select the OFSOPC RELEASE
Driver option so that the software can communicate with the OPC Factory Server.
For more information, refer to the topic documenting the Protocol parameter in tag container
properties (see EcoStruxure™ Hybrid DCS, User Guide).
EIO0000001255 09/2019 55
Installing OPC Factory Server

OPC Factory Server v3.61 (LARGE configuration) is included in the Citect SCADA installation
package (see page 42).
Install Citect SCADA before installing OPC Factory Server. If the latter is already installed, uninstall
it before installing Citect SCADA. This way, the correct part number and serial number are entered
automatically during installation of OPC Factory Server.
To install OPC Factory Server, double-click Launch.exe in the Citect SCADA installation package
and the select OPC Factory Server vX.Y (where X.Y corresponds to the included version) in the
CitectSCADA Setup dialog box.
Then, use the OPC Factory Server installation package of the required version (see page 42) to
update it.
For more information on how to install OPC Factory Server, refer to the OPC Factory Server help,
which is located in the Help folder inside the OPC Factory Server installation package.
56 EIO0000001255 09/2019
Upgrading the Software
EIO0000001255 09/2019
Chapter 5
Overview
This chapter contains information on the upgrade process and describes how to upgrade a
supported earlier version.

This chapter contains the following sections:
Section Topic Page
5.1 About Upgrading the Software 58
5.2 Migrating Databases 70
5.3 Installing the Software Upgrade 82
EIO0000001255 09/2019 57
Section 5.1
About Upgrading the Software
About Upgrading the Software
Overview
This section contains information about the various aspects related to upgrading a supported
earlier version (see page 41).
NOTE: Refer also to the topic containing general installation information (see page 44).
What Is in This Section?

This section contains the following topics:
Topic Page
Overview 59
Using Templates Supplied with the Software Upgrade 64
Stopping and Starting Caché 68
58 EIO0000001255 09/2019
Overview
Upgrade Process Description

An upgrade consists in installing on top of an existing installation a new major version, for example,
EcoStruxure Hybrid DCS 2019 (or 2019 R2 for a second release in the same year) on top of
version 2018.
When you upgrade the software, you need to install the upgrade on all computers on which the
system server and any clients connecting to it are installed because you cannot mix versions within
the same system infrastructure (see page 17).
The installer:
 Searches for already installed components on the computer.
 Backs up the extensions (see page 75) that were installed in the virtual machines.
 Uninstalls the version that is already installed. The database that contains data of the systems
that you have created is not removed.
 Installs an upgraded version of the software components that were installed on the computer.
 Gives you the option to add and/or remove machine roles (see page 29).
 May install a new virtual machine or may give you the choice to keep the existing one.
 Upgrades the following if the version that is installed is earlier than the one included in the
software upgrade:
 Schneider Electric licensing software.
 Third-party software components (see page 43).
You have the possibility to reuse databases of supported earlier version (see page 70) of the
software or start fresh with a blank database (see page 155).
NOTE: If upgrading your version of Process Expert is not supported, either uninstall it, or if you
want to reuse your database, migrate it to the next version as you need to migrate databases by
following the sequence of versions. For example, if Process Expert 4.2 is installed, migrate the
database to Process Expert 4.3 first. Then, you can migrate it directly to EcoStruxure
Hybrid DCS 2019.
EIO0000001255 09/2019 59
Before Upgrading Process Expert or EcoStruxure Hybrid DCS

Before preparing a database for migration (see page 71) or upgrading the system server or an
engineering client to EcoStruxure Hybrid DCS 2019, you need to manually delete the Vm folder on
this computer if either of the following cases applies:
 The Windows® user account that is used to upgrade the software and start the system server
or engineering client is not the same as the one that was used to start either component of the
currently installed version on this computer.
 The user account that is used to upgrade the software and start the system server or
engineering client is the same as the one that was used to start either component of the
currently installed version on this computer but another user had also logged on and started
either component of the currently installed version on this computer.
The Vm folder is located at C:\Users\<username>\AppData\Local\Schneider Electric\<currently
installed version>\Vm where <username> corresponds to the other user who had started either
component of the currently installed version and <currently installed version> is, for example,
Hybrid DCS 2018.
If you do not delete the folder, the VM of EcoStruxure Hybrid DCS 2019 may not start.
The table illustrates two scenarios in which it is required to delete the Vm folder when these actions
are performed on the same computer.
User account that was used User account that was used User account that is used to User account that is used to
to install the currently to start the install the upgrade start the upgraded
installed version server/engineering client of server/engineering client
the currently installed
version
User A User B(1) User A User A
User A User A(1) and User B User B User B
(1) Delete the folder for this user (corresponds to <username> in the folder path)
Upgrading a 32-Bit System Infrastructure

Starting with EcoStruxure Hybrid DCS 2018, operation clients can only be installed on 64-bit
operating systems.
Upgrading Supervision Software

Supervision software requirements (see page 42) may have changed and as a result, you may
need to upgrade installed Supervision components (see page 55) that are used in conjunction with
the EcoStruxure Hybrid DCS system infrastructure.
60 EIO0000001255 09/2019
Reusing Databases of a Supported Earlier Version

The following figure illustrates the workflow to migrate a Process Expert V4.3/SP1 or EcoStruxure
Hybrid DCS 2018 or 2018 R2 database to version 2019.
Migrating databases of supported earlier versions so that you can reuse them with the current
version of the software is a two-step process:
 In a first step, you need to install a premigration patch and create a backup of each database
that you want to reuse by using the system server of your existing software installation.
NOTE: The installation of the premigration patch is optional for Process Expert 4.3/SP1.
 In a second step, you need to install EcoStruxure Hybrid DCS 2019, re-install the extensions
(see page 75) that the software has backed up, and restore the database backup. The migration
is performed automatically when you start the system server.
If you do not want to reuse your current databases (this includes systems, segment libraries, and
any template you may have created), install the software upgrade and start the system server. In
this case, to save disk space, you can remove the Db database folder (see page 49) of the earlier
version.
NOTE: It is possible to re-use the database of 32-bit Process Expert 4.1 or earlier but you need to
migrate it to V4.2 first, then to V4.3. Refer to the V4.2 Installation Guide, Upgrading the Software.
EIO0000001255 09/2019 61
Extensions Installed in the Virtual Machine

If you had made changes to the software Participants of your supported earlier version of the
software by installing extensions or adding files manually to the Extensions folder, you need to re-
install them manually in case the upgrade process has installed a new virtual machine
(see page 45).
These changes can be, for example, the installation of device type managers (DTMs) or an
upgrade of the set of libraries (Libset) of the Control Participant.
To facilitate the re-installation of these extensions (see page 75), the software automatically backs
up the installed extensions when you upgrade the system server.
New Name of Control Participant Installed in Virtual Machine

The name of the Control Participant that is installed in the virtual machine of EcoStruxure
Hybrid DCS 2019 is renamed Control Expert. Due to this name change, the installation path of the
Participant is changed to C:\Program Files (x86)\Schneider Electric\Control Expert.
If you were using any user-created patches with the earlier version of the software in which a file
referred to the former Participant installation path (for example, if the execute.bat file contains the
path C:\Program Files (x86)\Schneider Electric\Unity Pro), you need to update them with the new
path before installing them.
Reusing Templates
If you want to resuse templates that you had created in Process Expert 4.3/SP1 or
version 2018/2018 R2 and that are not part of the Global Templates library anymore (because you
have, for example, exported and then deleted them), you need to Import (see EcoStruxure™
Hybrid DCS, User Guide) the corresponding export files (.sbk) in the library of the respective
version before installing the software upgrade. During migration of the database, the templates are
made compatible with the upgrade.
NOTE: When you import templates that were exported from a different version of the software, they
may not be usable in the entire system engineering life cycle.
Reusing Application Export Files

If you want to reuse instances that you have exported from Process Expert 4.0 and later, you can
import the corresponding application export files (.xml) in the Application Explorer after installing
the upgrade. This requires that the templates that are used by these instances are available in the
Global Templates library at the time of import (same template version).
For more information on the export and import of the application, refer to the topic describing how
to manage application folders and instances (see EcoStruxure™ Hybrid DCS, User Guide).
NOTE: For application export files created with Process Expert earlier than version 4.0, you need
to import these into the version in which they have been created (for example, Process Expert 3.1)
and migrate the database to version 4.0. From then on, you can export the application and import
the file into later versions.
62 EIO0000001255 09/2019
Reusing Project or Topology Export Files

If you want to reuse Control or Supervision Participant projects, or topological entities that you have
exported from Process Expert 4.3/SP1 or version 2018/2018 R2, you need to import the
corresponding export files (.sbk) into a system of the respective version before installing the
software upgrade.
This is because you cannot import project or topology export files into a version of the software that
is different from the one with which they were created. This restriction applies also to R• versions
of a major release.
License Requirements
When you install a new version of the software, you may need to update your licenses
For more information, refer to the Schneider Electric Floating License Manager user manual.
Before installing the software upgrade, check the instance count of existing systems to verify that
your application size license is still of the appropriate size.
For more information, refer to Counting Instances (see EcoStruxure™ Hybrid DCS, User Guide).
NOTE: Unless mentioned otherwise, licenses that you have activated for a major version (for
example, EcoStruxure Hybrid DCS 2019) are valid also for subsequent releases within the same
year (versions with R• suffix, for example EcoStruxure Hybrid DCS 2019 R2).
Transferring License Rights to the Virtual Machine

Upgrading Process Expert V4.3/SP1 requires installing a new virtual machine (VM) with a different
operating system (see page 27). Therefore, you cannot reuse the Microsoft® Windows® product
key that you were using with the VM of this version to activate (see page 143) the operating system
of the VM of the software upgrade. You need to purchase a new product key (see page 28).
If you are upgrading EcoStruxure Hybrid DCS 2018 or 2018 R2, you can reuse the product key to
activate the operating system of the VM of version 2019.
If you had used a digital license, you need to retrieve the corresponding product key.
NOTE: You must comply with the Microsoft® Software License Terms for the operating system of
the VM, which were provided when you purchased the digital license or product key.
EIO0000001255 09/2019 63
Using Templates Supplied with the Software Upgrade
Overview
Typically, a software upgrade comes with one or more libraries, which contain new and/or updated
templates.
To take advantage of the new functionalities provided by these templates, you need to import
(see EcoStruxure™ Hybrid DCS, User Guide) them if you have migrated a database of a
supported earlier version. This is because the templates that are supplied with the software
upgrade do not appear in the Global Templates library (see page 44) after a migration.
Then, to be able to use the latest version of templates you need to update the templates that are
used by the instances of your systems.
As a general rule, update a template only if it is required. That is, if the new version of the template
provides a new functionality that you need or fixes an issue that you may experience. This applies
in particular to systems that are already deployed.
For more information on the templates that are provided, refer to the help of the Schneider Electric
libraries.
For information on the severity of the impact when updating a template and on the compatibility of
templates belonging to different libraries, refer to the Library Release Notes.
Templates Supplied with the Software Upgrade

The new and/or updated Schneider Electric topological and application templates are provided in
the form of export files (.sbk).
There is one export file (.sbk) per template category.
The table indicates which libraries are included with the upgrade and the path of the folder on the
computer on which the system server is installed (where x is the software version).
EcoStruxure Folder containing SBK files Description

Hybrid DCS library
General Purpose C:\ProgramData\Schneider Electric\ New GPL that supports Situational Awareness
Library 2019 Hybrid DCS x\Templates functionalities of the Supervision Participant.
Template export file names have the SA suffix.
General Purpose C:\ProgramData\Schneider Electric\ Standard GPL that was delivered with
Library Classic 2019 Hybrid DCS x\Templates Classic EcoStruxure Hybrid DCS 2018 R2 with some
enhancements.
Foundation The Foundation.sbk file is included in Contains elementary application templates that
Library 2019 each folder containing SBK files of a are referenced by templates of other libraries.
GPL. It also contains topological templates that are
required to take advantage of new
functionalities of the new version of the Control
Participant.
64 EIO0000001255 09/2019
Updated Types Supplied With the Software

The FL and GPL Templates folder may contain updated versions of derived function block (DFB)
types and/or derived data types (DDTs) that are used in Global Templates supplied with the
software upgrade.
The folder is located in the root of the software upgrade installation package.
The types are supplied in .XDB format in a compressed archive file.
When to Import and Update Templates

The table describes several scenarios, which are possible after you migrate a database and
indicates in which case you need to use templates that are provided with the software upgrade.
Scenario Example Required and possible actions after

migrating the database
Migrated systems are not modified User whose existing systems are Importing templates supplied with the
or only by using templates and deployed and working fine. No upgrade is not required.
functionalities of the earlier version changes are planned in the
NOTE: The templates of the earlier version
of the software. application or topology in the short
of the software are readily available in the
Typically, the software is upgraded term, which would use new
Global Templates library.
to benefit of performance and/or UI functionalities (for example, adding
improvements. newly supported hardware
modules).
Migrated systems are going to be User who wants to:
updated to take advantage of the Add to the topology a newly Import templates of the Foundation library
new features of the upgrade.
supported hardware module. that is supplied with the upgrade.
Update the module of an existing Import templates of the Foundation library
controller to the latest version. that is supplied with the upgrade then,
update the template that is used by the
module.
Thereafter, you can configure the controller
in the Topology Explorer and change the
version of the module.
Use the new functionality provided Import templates of the GPL Classic that is
by the latest version of an supplied with the upgrade to create new
application template of the GPL instances.
Classic. Optionally, update templates of existing
instances of the application.
EIO0000001255 09/2019 65
Scenario Example Required and possible actions after

migrating the database
Application instances and System integrator who keeps  To create new topological entities:
topological entities of migrated supporting the installed base while Import templates of the Foundation
systems remain unchanged. creating new systems within the library that is supplied with the upgrade.
However, new systems will be same database by using the  To create new application instances:
created, which contain application upgrade. Import templates of a GPL that is
instances and topological entities supplied with the upgrade.
that use new functionalities of the  Updating templates of existing instances
upgrade. of the application and entities of the
As a result, systems of both the topology is not required.
earlier version and the current
software version will co-exist. NOTE:
Because earlier and new versions of
templates co-exist in the Global Templates
library, verify that you are using:
 The earlier version when modifying
migrated systems.
 The new version when creating and
modifying new systems.
Updating Systems with the Latest Templates

After you import new templates into the Global Templates library, you can update instances of
systems with these new templates.
Migrated Control Participant projects may not function properly after a migration.
WARNING
UNINTENDED EQUIPMENT OPERATION
Verify that any built Control Participant projects that are contained in a migrated database
function properly before deploying them to controllers.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
66 EIO0000001255 09/2019
The table describes the work flow to update templates that are used by application instances and
topological entities with templates supplied with the software upgrade.
Step Description
1 Verify that the application size license that is activated for the software is of the appropriate size.
If the software displays a notification about the license size, refer to Licensing Conflicts
For information on the size of systems, refer to Instance Count (see EcoStruxure™ Hybrid DCS,
User Guide).
2 Verify that you have imported Global Templates supplied with the software upgrade
(see page 64).
3 If you had created your own templates, update these templates with any updated reference that
may be available with the software upgrade.
Refer to Updating Global Templates (see EcoStruxure™ Hybrid DCS, User Guide).
4 Update the templates that are used by instances of the application.
Refer to Updating and Replacing Templates of Instances.
NOTE: To maintain existing links, update instances that are linked at once.
5 Generate the Control and Supervision projects.
NOTE: If the software detects DFB version conflicts, it opens a dialog box, which allows you to
select the version you want to use. Select the version encapsulated in the new version of the
template. For details, refer to the topic describing the management of versions of types in
Control facets during generation (see EcoStruxure™ Hybrid DCS, User Guide).
NOTE: If generation detects that the controller does not support a new functionality or data type,
you need to upgrade the firmware version of the CPU of the default configuration used by the
Control Participant project.
6 Update the templates that are used by the topological entities of each system by using the
Update Templates command.
Refer to Updating Templates of Topological Entities (see EcoStruxure™ Hybrid DCS, User
Guide).
NOTE: You may need to upgrade the firmware of topological entities to a version that supports
new modules or data types.
7 Build the Participant projects and verify that they function properly.
8 Deploy the built Participant projects to their respective engines.
EIO0000001255 09/2019 67
Stopping and Starting Caché
Stopping Caché
To stop Caché, you need to stop the system server first.
NOTICE
LOSS OF COMMUNICATION
Stop the system server only when no client is running.
Failure to follow these instructions can result in unresponsive clients.
To stop Caché, proceed as follows.
Step Action
1 Quit any clients that are connected to the system server that is running on the computer on which
Caché is installed (see EcoStruxure™ Hybrid DCS, User Guide).
2 Stop the system server (see EcoStruxure™ Hybrid DCS, User Guide).
3 Right-click the icon in the Microsoft® Windows® notification area representing the Caché
database.
Result: The Caché context menu opens.
4 Select Stop Caché.
Result: Caché opens the Caché Shutdown dialog box.
5 Select Shut down and click OK.
Result: Caché displays a splash screen while shutting down the database.
6 Wait until the Caché database icon turns gray, indicating that the database is shut down.
NOTE: Do not start the system server when Caché is stopped because the database needs to be
running for the system server to function properly.
NOTE: By default, Caché starts when you restart the computer.
68 EIO0000001255 09/2019
Starting Caché
To start Caché, proceed as follows.
Step Action
1 Right-click the icon in the Microsoft® Windows® notification area representing the Caché
database.
Result: The Caché context menu opens.
2 Select Start Caché.
Result: Caché displays a splash screen while the database starts.
3 Wait until the Caché database icon turns blue, indicating that the database is running.
NOTE: By default, Caché is configured to start when you start Microsoft® Windows®.
EIO0000001255 09/2019 69
Section 5.2
Migrating Databases
Migrating Databases
Overview
Only the migration of databases of Process Expert 4.3 or V4.3 SP1 and EcoStruxure
Hybrid DCS 2018 or 2018 R2 is supported.
Migrating a database is a two-step process (see page 61), which can take up to several hours
depending on the size of the database. This section describes the prerequisites and how to
complete the process.
NOTE: The information in this section applies only if you are upgrading and want to reuse your
existing database with EcoStruxure Hybrid DCS 2019.
What Is in This Section?

This section contains the following topics:
Topic Page
Preparing Databases for Migration 71
Re-Installing Extensions 75
Migrating Databases to the Current Version 77
Impact of Migration On System Data 79
70 EIO0000001255 09/2019
Preparing Databases for Migration
Overview
Migrating a database of Process Expert V4.3/V4.3 SP1 or version 2018/2018 R2 is a two-step
process (see page 61).
In the first step, you need to prepare databases for migration before installing the software
upgrade. This premigration is an automated process and is performed by using the Migrate
Database command of the system server of the currently installed version.
 For version 2018/2018 R2 databases, the command becomes available once you install the
premigration patch.
 For V4.3/V4.3 SP1 databases, the command is already available in the system sever console.
You need to install a premigration patch only in case of forgotten passwords (see page 71).
The purpose of premigration is to create a backup file of each database that you want to use with
the new version of the software. Once the new version is installed, these backup files can be
migrated to create a compatible database.
You cannot use clients during this step.
NOTE: If you modify, add, or delete a system or make a change to the Global Templates library or
content repository after you have created the database backup file, you must create a new one in
order to migrate the changes.
Activity Logs
The software creates log entries when you prepare a database for migration.
The information is added to the system server log file (see EcoStruxure™ Hybrid DCS, User
Guide).
Password Authentication
If the database contains systems with topological entities for which password protection
(see EcoStruxure™ Hybrid DCS, User Guide) is enabled and an application password has been
set, the Password Authentication dialog box opens. You must provide the password for each
controller to be able to proceed with the premigration.
The dialog box provides an option to manage forgotten passwords:
 For controllers, it lets you obtain a temporary password that you can enter directly in the
Password Authentication dialog box.
 For station nodes, it lets you proceed with the premigration without providing the password.
NOTE: In Process Expert 4.3/SP1, the option is only available after you install the premigration
patch.
Without installing the premigration patch, if you have forgotten the password for a controller or
station node, you can cancel the premigration process, open the Topological Explorer, reset the
password (see EcoStruxure™ Hybrid DCS, User Guide), and then start over.
EIO0000001255 09/2019 71
The following figure shows an example of the Password Authentication dialog box featuring the
option to manage forgotten passwords.
Item Description
1 When selected, shows the station nodes acting as emulated simulator for which password
protection is enabled and a password has been set. Otherwise, these station nodes are not shown
and you cannot enter their password.
NOTE: Entering the password for station nodes is optional. If you do not enter it, you can proceed
with the premigration after you confirm the command. However, you will need to deploy the built
Control Participant project again to the station node in the new version of the software.
Click No in the confirmation dialog box to revert to the Password Authentication dialog box.
2 Identifier of the system containing the topological entity.
3 Identifier of the topological entity in the Topology Explorer.
For station nodes, indicates also the identifier of the Control Expert service.
72 EIO0000001255 09/2019
Item Description
4 The engine type can be either of the following:
 Controller.
 Simulator: A station node in which a Control Expert service has been created.
5 Text box to enter the password.

If you enter an incorrect password for an entity, a red icon is displayed in the corresponding row.
6 Click the link if you have forgotten the password for a controller. It provides a code that you must
submit to Schneider Electric support to obtain a temporary password. You can enter this
temporary password directly in the Password Authentication dialog box and proceed with the
premigration.
Installing the Premigration Patch

Install the patch on the computer on which the system server is installed before starting the
premigration process.
Step Action
1 Verify that the system server and clients are not running.
2 Copy the premigration patch installation file (.exe ) that corresponds to your installed version to
the computer.
The file is located in the MigrationPatches folder, which is in the root of the upgrade installation
package.
3 Double-click the file.
Result: The welcome screen opens.
4 Click Update and follow the instructions on screen.
EIO0000001255 09/2019 73
Creating a Database Backup File for Migration

The premigration of a database may take up to several hours depending on the size of the
database.
To create a backup file of the database that is mounted, proceed as follows.
Step Action
1 Start the system server.
2 Verify that no client is connected to the system server.
3 In the system server console menu bar click Database → Migrate Database.
Result: A Save As dialog box opens.
4 Enter a name and location for the database backup file and click Save.
Result: If the database contains a system with a topological entity for which password protection
is enabled and a password has been set, the Password Authentication dialog box opens;
proceed to step 6. Otherwise, the creation of the database backup file starts.
5 Wait until Done appears in the system server console after the server is stopped and database
operations are completed.
Result: The database backup file is created and premigration is complete.
NOTE: When the creation of the database backup file starts, no activity may be shown in the
system server console.
6 In the Password Authentication dialog box, enter the password for each topological entity or
manage forgotten passwords (see page 71) and click OK.
Result: The creation of the database backup file starts (no activity may be shown in the system
server console).
NOTE: Click Cancel to close the dialog box without migrating a database.
7 Wait until Done appears in the system server console after the server is stopped and database
operations are completed.
Result: The database backup file is created and premigration is complete.
8 To create a backup file of another database, restore it (see page 152) and repeat the procedure.
74 EIO0000001255 09/2019
Re-Installing Extensions
Overview
When you upgrade the software, the software automatically backs up the extensions that were
installed in the virtual machine and creates a log file.
It includes:
 Participant extensions that you have installed by using the Extensions section of the System
Server Configuration Wizard (for example, a DTM).
 Extensions whose files you have added manually or by an installer to the Extensions folder,
which is located on the computer on which the system server is installed, at the path C:\Program
Files\Schneider Electric\EcoStruxure\Hybrid DCS\Vm\Extensions (for example, a segment
library extension that is added when you install such an optional library).
This facilitates the re-installation of these extensions, which are required if you are migrating a
database or reusing it in another EcoStruxure Hybrid DCS infrastructure.
NOTE: A backup of the extensions is also created when you uninstall the system server
(see page 168).
Extension Backup File Name and Location

The various extension files are backed up as one compressed archive file named
Extensions_Version.7z, where:
 Version is the software version that you have upgraded or removed.
 DateTime the date and time when the backup was performed.
After the upgrade or uninstallation is completed, the file is located at the path
C:\Users\Username\AppData\Local\Schneider Electric\Hybrid DCS\ExtensionBackup where
Username corresponds to the user who is currently logged on to the operating system of the
computer.
Extension Backup Log Files

The software creates a log file in the ExtensionBackup folder.
The name of the log file is Log_Version_DateTime.txt where:
 Version is the software version that you have upgraded or removed.
 DateTime the date and time when the log file was created.
The log file contains:

 The names of the extensions that have been backed up. Extensions are grouped by method of
installation (Extensions section of the configuration wizard and manual addition to the
(Vm\)Extensions folder).
 A list of extensions that were installed in the virtual machine but that could not be backed up
because the corresponding files were not present in the source location. This can be the case,
for example, if the extension file has been deleted from the folder from which it was installed
(see page 132).
EIO0000001255 09/2019 75
Re-Installing Extensions
Re-install the extensions before you start the system server of the software upgrade.
Once you have extracted the backup archive file to disk on the computer on which the system
server is installed, you can re-install extensions by using either method:
 Use the Extensions section (see page 130) of the System Server Configuration Wizard.
 Add the files manually to the Extensions (see page 75) folder.
76 EIO0000001255 09/2019
Migrating Databases to the Current Version
Overview
The second step of the migration process can be performed once you have upgraded the system
server.
By restoring a database backup file created during the first step and starting the system server, the
migration process is completed.
Once you have migrated a database, you can complete the migration process of another database
at any time by repeating this step.
NOTE: After upgrading to EcoStruxure Hybrid DCS 2019, if you start the system server without
restoring a database first, a blank database is created (see page 44).
Prerequisites
The following are prerequisites for performing the migration process:
 You have an up-to-date backup file (.mdbk) of each database that you want to migrate, which
was created before installing the upgrade (see page 71).
 You have installed the version 2019 system server.
 You have activated (see page 63) the operating system of the VM of the system server.
 You have re-installed (see page 75) in the VM of the system server all the extensions
(see page 130) that are used in Control Participant projects of systems contained in the
database that you want to migrate.
Migrating Supervision Data

Due to the new version of the Supervision Participant that is running in the virtual machine, a
Supervision Participant window opens when Supervision data (for example included projects or
pages) is migrated to the new version.
The window opens even if systems that you are migrating as part of your database contain no
Supervision project.
Depending on the Supervision data that is migrated, you may be required to interact with some
dialog boxes to complete the migration process.
For details, refer to the platform release notes that are located in the installation package.
Completing the Migration on a Different Computer

If you have installed the system server upgrade on another computer than the one on which you
have created the database backup file, confirm that the system server can access the file over the
network or transfer it manually from the other computer.
NOTE: Confirm that the Read-only attribute of the folder containing the database backup file is
cleared by right-clicking the folder and selecting Properties.
EIO0000001255 09/2019 77
Migrating the Database of the Earlier Version
Step Action
1 Back up the database that is mounted by using the Back Up Database command
(see page 149) in the system server console. A database is mounted (see page 44) if you have
restored one and/or already started the version 2019 system server.
2 Mount the database that you want to migrate by clicking Database → Restore Database in the
system server console.
In the Open dialog box, select the .mdbk extension in the file type menu.
3 Start the system server (see page 156).
Result: The migration of the database is performed. During this process, the EcoStruxure
Hybrid DCS 2019 Supervision Participant window opens and may require user-interaction for
migration to complete successfully.
4 Wait until Server is ready appears in the console.
Result: The server is running and the database has been migrated to the current software
version, which is indicated in brackets.
Migration Log Files

The software creates several log files when you migrate a database, which contain information
about the migrated objects and detected errors.
The name of the log files is migration_YYYY-MM-DD_HH-MM-SS.log where YYYY-MM-
DD_HH-MM-SS represents the date and time when the log file was created.
The software creates log files at the following locations:
 For the database that you have migrated, in the GLOBAL folder located at the path
C:\ProgramData\Schneider Electric\Hybrid DCS x\Db.
 For each system contained in the migrated database, in the System_n folder located at the path
C:\ProgramData\Schneider Electric\Hybrid DCS x\Db.
x corresponds to the major version of the software that you are using (the R• version suffix does
not appear).
NOTE: Systems that appear in the Db database folder keep their default name (System_n) even
if you rename them in the Systems Explorer.
Managing Databases
Database backups that the software creates when you restore databases can use up a lot of disk
space. Manage these folders regularly to recover disk space.
78 EIO0000001255 09/2019
Impact of Migration On System Data
Overview
This topic describes the impact that database migration has on data of systems.
It describes in particular, the changes that result of new Participant features and that are available
in the migrated database. These changes may require user intervention to be fully integrated in
existing systems.
After Migrating Databases

Migrated Control Participant projects may not function properly after a migration.
WARNING
UNINTENDED EQUIPMENT OPERATION
Verify that any built Control Participant projects that are contained in a migrated database
function properly before deploying them to controllers.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
After migration of the database is completed, you need to deploy the executable of a built Control
Participant project to its respective engine again by using the Deploy Built Project command if the
link status that is displayed in the status bar of the Control Participant indicates DIFFERENT.
Deploying executables requires stopping the controller.
To view the link status, use the Refine Online command in the Topology Explorer, which opens the
Control Participant window. The figure shows a partial view of the status bar.
1 Link status
EIO0000001255 09/2019 79
The table describes the various states of Control project executables that can result of a migration
and the actions you can to take in each case.
Executable status Executable status after Next actions

before migration migration
Built Out Of Date If before migration, the built Control project was:
 Deployed: You can use the Build or Build All command and
Out Of Date
deploy changes(1) or deploy it again depending on the
change that you have made.
 Not deployed: You can use the Build or Build All command
depending on the change that you have made and deploy it.
Not Built Not Built Use the Build or Build All command and deploy it.
(1) Online refinement, deployment of changes, and redeploying the last project is not possible if the link status that is
indicated in the status bar of the Control Participant is DIFFERENT.
The table describes the various states of Supervision project executables that can result of a
migration and the actions you need to take in each case.
Executable status Executable status after Next actions

before migration migration
Built Out Of Date If before migration, the built Supervision project was:
 Deployed: Use the Build All command(2). There is no need to
deploy the project again to the same Supervision station
nodes(1).
 Not deployed: Use the Build All command(2) and deploy it.
Out Of Date Out Of Date Independently if the built Supervision project was deployed or
not, use the Build All command(2) and deploy it.
Not Built Not Built Use the Build or Build All command(2) and deploy it.
(1) Supervision software installed on station nodes needs to be upgraded to meet the software requirements.
Deployed Supervision projects need to be compiled locally.
(2) Building a Supervision project will not complete successfully if the identifier of any cluster exceeds 16 characters
in length. If this is the case, rename such clusters and generate any impacted Supervision project before building
it.
Locking Code of Control Projects after Migration

After you have migrated a Process Expert V4.3/SP1 database containing Control projects, it is
recommended to perform a consistency check to enable the code locking feature.
This feature lets you distinguish code that is generated by the software from code that you have
modified or added during refinement.
NOTE: Code may become locked without performing a consistency check depending on the status
of Control facets or if you regenerate a Control project.
80 EIO0000001255 09/2019
First Deployment or Execution Actions With a Migrated Database

The first time you use the Deploy Changes / Undo Online Changes or Refine Online command
after migrating a Process Expert V4.3/SP1 database, the operation may take more time than usual
because of file format conversions taking place in the background. This is part of the migration
process and is indicated in the notification panel.
Availability of New Features in Migrated Databases

The table describes the availability of the main new features of the upgrade when you migrate a
database.
Feature Availability in migrated database

ItemName property in The ItemName property is added to the Supervision Elements (for example,
Supervision elements of variable tags) that are referenced in Supervision data facets of any instance of a
Supervision project system.
facets The property is positioned at the bottom of the element.
You need to configure this property if you want to use the equipment name
(see EcoStruxure™ Hybrid DCS, User Guide) as data reference for animated
graphics as part of a Situational Awareness Supervision project.
For details on the property, refer to Add a Variable Tag (Equipment Properties) in
the help of Citect SCADA 2018.
NOTE: The property may be hidden if a filter is applied (for example, Hide
Unbound).
Last Action Summary The command is available only for supported actions that you perform after
command migration.
(see EcoStruxure™
Hybrid DCS, User Guide)
Participant project validity The indicators are shown only once you perform actions on a migrated project.
indicators
(see EcoStruxure™
Automatic assignment of The state of the functionality (enabled/disabled) in the projects that you are
remaining candidate migrating is not changed by the migration process.
facets
(see EcoStruxure™
Automatic creation of The preconfigured expression (see EcoStruxure™ Hybrid DCS, User Guide) that
FBD sections is selected creates automatically sections that have the same syntax as those that
(see EcoStruxure™ were created by default in the previous version of the software.
during assignment of
Control facets
EIO0000001255 09/2019 81
Section 5.3
Installing the Software Upgrade
Overview
Install the upgrade on computers that have the following roles (see page 29) because all
components of a same system infrastructure need to be of the same version:
 System server.
 Operation server (Supervision): Only if a system server, engineering client, or operation client
is installed.
 Engineering station.
 Operator station (Supervision): Only if an operation and/or engineering client is installed.
You can add and/or remove roles during installation.

A restart of the computer is required to complete the installation process.
Identifying a Software Component Version

The version of an installed component is indicated in the Installed Software section of the General
tab of the About EcoStruxure Hybrid DCS dialog box (see EcoStruxure™ Hybrid DCS, User
Guide).
For information on how to identify the components of earlier software versions, refer to this topic in
their respective installation guides.
82 EIO0000001255 09/2019
Installation Procedure
You can upgrade a supported earlier version only when the system server is not running.
NOTICE
NOTICE
LOSS OF DATA
Back up the database before installing a software upgrade.
Failure to follow these instructions can result in loss of database or unusable systems.
The table describes the procedure to install the software to upgrade a supported earlier version.
Step Action
1 Verify that the system and installation requirements (see page 37) are fulfilled.
2 If you had customized any setting in one of the configuration wizards (see page 111), write down
the modifications because you need to make them again after the installation of the upgrade is
completed (for example, the system server IP address or the folder shared with the virtual
machine).
3 If you want to retain the HTML help of templates that you have used with version 2018 or
2018 R2, you need to copy the corresponding help files before proceeding with the upgrade.
Without this step, the help of version 2018/R2 is replaced by the help of version 2019.
For details, refer to Using Help for Different Versions of Schneider Electric Templates in the User
Guide of version 2018 or 2018 R2.
4 Back up the mounted database (see page 152) and/or prepare for migration the databases
(see page 71) that you want to continue using.
5 Verify that the installed components are not running.
6 Quit other Schneider Electric applications that are running.
7 Temporarily disable antivirus services (real time, scripting, and so on) running on the computer.
8 Double-click the setup.exe file located in the root of the installation package of the upgrade.
Result: The installation procedure starts and looks for installed components to upgrade and/or
remove.
EIO0000001255 09/2019 83
Step Action
10 In the Station Role dialog box, the check boxes of components of the earlier version that are
installed on the computer are selected. These components (see page 45) are upgraded by the
installer.
Modify the component selection as needed:
 Clearing a selected check box uninstalls the component from the computer.
 Selecting a check box that is cleared installs the component on the computer.
NOTE: Clearing the License Server check box does not remove the installed version
(see page 45); it remains on the computer but it is not upgraded. If an earlier version of the
Floating License Manager is installed on the computer, you need to select the check box and
accept to upgrade it so that the installation process can continue.
11 Click Next.
NOTE: If an earlier version of the License Manager is installed on the computer, you need to
accept to upgrade it so that the installation process can continue.
13 if you selected to upgrade the system sever component, in the Authentication Settings dialog
box, you can modify the settings for role based access control (see page 85).
15 Restart the computer when prompted to complete the installation process.
16 Repeat the installation procedure on each computer of the EcoStruxure Hybrid DCS system
infrastructure on which the upgrade is required (see page 82).
NOTE: If messages about detected errors are displayed during the upgrade, refer to the topic
about troubleshooting installation (see page 172).
NOTE: To disable the USB port monitoring service of Oracle® VM Virtualbox after installation, use
the registry entries file provided (see page 179).
84 EIO0000001255 09/2019
Role-Based Access Control
EIO0000001255 09/2019
Chapter 6
Overview
This topic describes role-based access control and how to set it up in the EcoStruxure Hybrid DCS
system infrastructure.

Topic Page
About Role Based Access Control 86
Setting Up Role Based Access Control 91
EIO0000001255 09/2019 85
About Role Based Access Control
Overview
The objective of role-based access control (RBAC) is to administer the tasks that authorized users
can perform by assigning them predefined roles.
Roles are associated to groups, which are created either in the operating system of the system
server computer or in a domain controller. Users need to be added to these groups and must log
in to the various EcoStruxure Hybrid DCS components to be authenticated.
You must have administrator rights on the computer to set up RBAC.
NOTE: If you had set up RBAC for an earlier version of the software, your configuration remains
valid when you upgrade.
Working Principle
The following figure illustrates the implementation of RBAC with local authentication. Each user
has a different role and is a member of the corresponding group. The user accounts and groups
are created on the system server computer.
86 EIO0000001255 09/2019
The following figure illustrates the implementation of RBAC with domain authentication. Each user
has a different role and is a member of the corresponding group. The user accounts and groups
are created on the domain controller.
RBAC Setup Workflow for Local Authentication

The table outlines the steps that you need to complete if you want users to be authenticated locally
on the computer running the system server.
Stage Description
1 During installation or upgrade of the system server, select to authenticate users locally.
The software automatically creates a group for each predefined role in the operating system of
the local computer.
2 Complete the installation of the software.
3 If required, create a user account on the computer running the system server for each user who
is authorized to use a component of the EcoStruxure Hybrid DCS system infrastructure (system
server, engineering client, operation client).
4 Add each authorized user to one or more groups depending on the tasks to be performed.
EIO0000001255 09/2019 87
RBAC Setup Workflow for Domain Authentication

The table outlines the steps that you need to complete if you want users to be authenticated on a
domain to which the computer running the system server is joined.
Stage Description
1 During installation or upgrade of the system server, select to authenticate users on a domain.
2 Complete the installation of the software.
3 On the Active Directory® domain controller:
 Create a group for each predefined role. The creation of the groups can be automated by
running the supplied software tool.
 If required, create a user account for each user who is authorized to use a component of the
EcoStruxure Hybrid DCS system infrastructure (system server, engineering client, operation
client).
 Add each authorized user to one or more groups depending on the tasks to be performed.
Roles
The following roles are defined to cover all the tasks that one can perform with EcoStruxure
Hybrid DCS.
Any logged-in user, independently of their group membership, can access the user, about, and/or
help menus of a component. These menus are also accessible when no user is logged in.
Role name Permissions

ESX HDCS Server Admin Full access to the menu bar of the system server and its
commands.
No access to client functionalities.
ESX HDCS Engineer(1) Perform tasks on the engineering client that are directly related to
systems.
No access to:
 System server
 Operation client
 Global Templates Explorer
 Global Root folder, its subfolders, and the corresponding
context menu commands in the Content Repository explorer
(1) Both roles combined give full access to the functionalities of the engineering client.
88 EIO0000001255 09/2019
Role name Permissions
ESX HDCS Template Designer (1) Perform tasks on the engineering client that are directly related to
Global Templates and not a system.
No access to:
 System server
 Operation client
 Explorers other than Global Templates Explorer and Content
Repository explorer
 Systems folder, its subfolders, and the corresponding context
menu commands in the Content Repository explorer
 Inspect → External References context menu command of a
template in the Global Templates Explorer.
ESX HDCS Operator Full access to the functionalities of the operation client only.
No access to:
 System server
 Engineering client
(1) Both roles combined give full access to the functionalities of the engineering client.
After logging in, you can view which roles are assigned to you in the User Information dialog box
(see page 90) .
Groups
For each predefined role, a corresponding group must exist either locally in the operating system
of the computer running the system server or in the Active Directory® domain controller, depending
on the selected authentication type. Users need to be added to these groups.
You can create the required groups automatically (see page 92) or manually. If you had not
created all the groups manually, you can add the others automatically as well.
If you create the groups manually, their name must be identical to the role name (see page 88) and
respect the case.
Groups can be removed manually only. Uninstalling the software does not remove the groups that
were created automatically.
A user who does not belong to one of the groups cannot log in to the software. A user can belong
to more than one group.
NOTE: If a user is added to a new group or removed from a group while the user is logged in to
the software, the change takes effect only after the user logs off.
EIO0000001255 09/2019 89
Windows® User Accounts

The computer on which users must have a Windows® account to be able to log in to EcoStruxure
Hybrid DCS depends on the authentication type that you select.
Authentication type Computer on which the user account must exist

Domain Domain controller
Local Computer running the system server
Authentication Type
You can select whether the system server validates the credentials of users who log in either
locally on the computer running the system server or on a domain that you specify.
The selection is made initially during the installation of the system server but can be viewed and
modified by either method:
 By using the Repair or Modify functionality (see page 163).
 By using the System Server Configuration Wizard, Authentication section (see page 149).
User Information
The User Information dialog box contains the following information about the user who is logged in:
 Username and full name.
 The name of the computer running the system server of this EcoStruxure Hybrid DCS
infrastructure.
 Roles assigned to the user and their description.
You can open the dialog box from the user menu in the toolbar of each software component.
Logging In and Out and Locking the Software

The use of RBAC requires that users log in to a component before they can use it.
The software implements the single login and logout mechanism when opening several
components on the same computer.
A logged-in user can lock the components that are open on the computer and only the same user
can unlock them.
For details, refer to the topic describing how to log in and out (see EcoStruxure™ Hybrid DCS,
User Guide) and lock (see EcoStruxure™ Hybrid DCS, User Guide) software components.
90 EIO0000001255 09/2019
Setting Up Role Based Access Control
RBAC Authentication Settings

The following figure shows an example of the dialog box that appears when you install the system
server or modify/repair an existing installation of the system server.
Item Description
1 Lets you select where the system server validates the credentials of users who log in:
 Local: On the computer running the system server.
 Domain: On the Active Directory® domain controller.
2 You must enter the name of the domain if you have selected the domain authentication.
3 Click to verify if the domain controller of the selected domain is accessible (optional).
A dialog box informs you of the result.
NOTE: You can view and change the authentication type and domain settings also in the System
Server Configuration Wizard, Authentication section (see page 149).
EIO0000001255 09/2019 91
Creating Groups by Using the Software Tool

Follow this procedure to create groups if you have:
 Selected the Domain authentication type.
 Created only some groups (manually) and want to create the others.
Using the software tool facilitates the creation of groups with the correct name so that they are
valid.
Step Action
1 Copy the Domain folder to the domain controller computer.
The folder is located at the path ProgramFiles64Folder\Utilities\Roles Manager starting from the
root of the installation package (.iso).
2 Double-click Domain.bat.
Result: A group for each role is created on the local computer.
NOTE: Right-click the file and select Run as administrator if the groups were not created the
first time.
92 EIO0000001255 09/2019
Securing Client/Server Communication
EIO0000001255 09/2019
Chapter 7
Overview
This topic describes how to generate and install digital certificates that are required to use

Topic Page
About Using Digital Certificates 94
Generating and Installing Root CA Certificates 98
Installing Entity Certificates 102
Uninstalling Certificates from the Computer 107
EIO0000001255 09/2019 93
About Using Digital Certificates
Overview
The software implements a public key infrastructure (PKI) based on the X.509 standard. It uses a
Schneider Electric self-signed certification authority (CA) to create root and entity certificates to
help secure client/server communication in the EcoStruxure Hybrid DCS system infrastructure
(see page 15).
You may be able to use your own CA and root certificate.
Certificates are verified and must be validated successfully at these times:
 For the system server: During server start.
 For clients: During the attempt to connect to the system server.
In a distributed infrastructure, a client can connect to the system server only if their respective
certificates are issued and signed by the same root CA.
The use of digital certificates is mandatory.
NOTE: If you had generated and/or installed certificates for an earlier version of the software, they
remain valid when you upgrade it given that they are not expired.
If you have modified the role of a station (see page 97) during the upgrade, you may need to install
new certificates.
94 EIO0000001255 09/2019
The following figure illustrates the working principle of the PKI in a distributed system infrastructure.
Certificate Installation Workflow - Distributed System Infrastructure

The table outlines the steps that you need to complete to install certificates in order to use the
software when the various components are installed on different computers.
Stage Description
1 On the system server computer, generation of a password-protected root CA certificate
(see page 98) by a user with administrator rights.
This step is performed by using the System Server Configuration Wizard.
This also installs a set of entity certificates on this computer, which is required for the system
server to run.
NOTE: If you want to use your own root certificate file (.pfx), you need to select to install only
certificates (see page 99) in the System Server Configuration Wizard.
2 On each computer of the EcoStruxure Hybrid DCS system infrastructure, installation of a set of
entity certificates (see page 102) by a user with administrator rights, who knows the root CA
certificate file location and password.
This step is performed by using any client configuration wizard.
This also installs the root CA certificate on each computer.
EIO0000001255 09/2019 95
Certificate Installation Workflow - All in One Architecture

The table outlines the steps that you need to complete to install certificates in order to use the
software when all the components are installed on the same computer.
Stage Description
1 Generation of a password-protected root CA certificate (see page 98) by a user with
administrator rights.
This step is performed by using the System Server Configuration Wizard.
This also installs a set of entity certificates on this computer.
NOTE: If you want to use your own root certificate file (.pfx), you can select to install only
certificates in the System Server Configuration Wizard.
Recommendations
The following are recommendations related to the expiration of certificates.
Certificate Recommendations
Root CA certificate Stop using the software as soon as you receive a notification about the
Entity certificates upcoming expiration of a certificate and install new certificates.
If you keep using the software after certificates have expired, software
Participant services (for example, refinement) or runtime navigation
services may not function properly.
The following are recommendations for sharing the root CA certificate file (.pfx) to make it
accessible to computers of a distributed EcoStruxure Hybrid DCS infrastructure when you install
entity certificates.
Sharing method Recommendations

A shared folder Restrict access permissions so that only the user who needs to install entity
certificates on the computer can access the folder.
Once entity certificates are installed, disable folder sharing.
A removable drive Once entity certificates are installed, remove the drive.
Do not use the drive for another purpose and keep it in a safe place.
The following are recommendations for the validity period of entity certificates.
Hybrid DCS component usage Recommendations

Normal use Use the default validity period or shorter.
Temporary or occasional use Limit the validity to one day.
NOTE: Once you have generated a certificate, you cannot modify its validity period. To change it,
you need to generate a new certificate.
96 EIO0000001255 09/2019
Certificate Properties
Certificates are installed on a machine basis and are valid for all users who can use EcoStruxure
Hybrid DCS.
You can check whether root CA and entity certificates are installed on the local computer and view
information about these certificates in the Microsoft® Management Console (in a Windows® 10
operating system, use the certlm.msc service of the local computer).
The following set of entity certificates is generated on each machine and can be found under
Personal\Certificates:
 System server: EcoStruxure Hybrid DCS Server
 Engineering client: EcoStruxure Hybrid DCS Engineering Client
 Operation client: EcoStruxure Hybrid DCS Operation Client
 Virtual machine: EcoStruxure Hybrid DCS VM
They are issued by EcoStruxure Hybrid DCS Root, which is the root CA certificate generated
by EcoStruxure Hybrid DCS and located in Trusted Root Certification Authorities\Certificates.
Modifying the Software Installation

After you have installed entity certificates on a computer, if you install a new client on this computer,
you do not need to install an additional entity certificate.
However, if only clients are installed and you add the system server, you need to install new
certificates by using the System Server Configuration Wizard. You can reuse the same root CA
(.pfx) that you had used to install entity certificates for the clients.
EIO0000001255 09/2019 97
Generating and Installing Root CA Certificates
Overview
The Security section of the System Server Configuration Wizard lets you generate a root certificate
and private key on the computer on which the system server is installed. Both are stored in a single
file (.pfx) that is created in a location that you select.
The default name of the root CA is EcoStruxure Hybrid DCS Root.
This operation also generates a set of entity certificates and installs the root CA certificate along
with the set of entity certificates on the computer so that you can start the system server.
NOTE: Only root certificate files with the .pfx extension are supported,
Prerequisites
 You must have installed the system server.
 Any EcoStruxure Hybrid DCS component installed on the computer must not be running.
Accessing the System Server Configuration Wizard

To open the System Server Configuration Wizard, in the system server console menu bar, click
Settings → Basic.
98 EIO0000001255 09/2019
Security Section Description

The following figure shows the Security section of the System Server Configuration Wizard when
you select to generate and install the root CA and entity certificates.
Item Description
1  Generate and Install Certificates generates and installs both the root CA and a set of entity
certificates on the computer.
 Install Certificates installs only a set of entity certificates on the computer by using an existing
root CA certificate, which must be accessible from the computer (see page 96).
The fields that are displayed depend on the selection.
EIO0000001255 09/2019 99
Item Description
2  When you select Generate and Install Certificates for the first time or after uninstalling
certificates, contains the full path to the default root CA certificate file that you are creating. The
path is C:\Users\<username>\AppData\Local\Schneider Electric\Hybrid DCS\Certificates. You
can edit the full path but the path must exist and you must use the .pfx extension for the file
name.
You can create the file at a different location on the local computer, a network location shared
(see page 96) with all computers running Hybrid DCS components (for example, the system
server, the engineering client), or on a removable drive (for example, a USB drive).
 When you select Install Certificates, the field is empty. You must enter the full path or browse
to an existing root CA certificate file (.pfx).
3  When you select Generate and Install Certificates, you must create and confirm a password.
Hovering with the pointer over the text field shows a tooltip containing the applicable password
rules.
It is possible to generate different root certificate files by using the same password.
NOTE: You will need this password to generate entity certificates on other computers of a
distributed EcoStruxure Hybrid DCS system infrastructure.
 When you select Install Certificates, you must enter the password that was used to generate
the root CA certificate.
If you have forgotten the password, you need to generate a new root CA certificate.
4  When you select Generate and Install Certificates, expiration date of the root CA and entity
certificates. You can edit the field.
 When you select Install Certificates, enter the expiration date of the entity certificates.
15 days before the expiration date (see EcoStruxure™ Hybrid DCS, User Guide) and at 24-hour
intervals thereafter, a notification about the upcoming certificate expiration is shown:
 For the system server certificate: In the server console (only when the server is starting) and in
clients that are connected to the server.
 For client certificates: In the client when it is starting or running.
After this date, a new root CA certificate and/or new entity certificates need to be installed.
5 Depending on your selection, button to proceed with:
 The generation and installation of the CA root and the set of entity certificates on the computer.
 The installation of the CA root and the set of entity certificates on the computer.
6 Button to uninstall root and entity certificates (see page 107) from the computer.
7 Once you have successfully installed certificates on the computer, the fields display the
corresponding information. If no certificates are installed on the computer or if the operation did
not succeed, the fields are empty.
100 EIO0000001255 09/2019

Generating and Installing Root CA and Entity Certificates on the System Server Computer
To install only entity certificates on the computer, refer to the corresponding procedure
(see page 102).
Step Action
1 Open the System Server Configuration Wizard.
Result: The Security section is displayed.
2 Select Generate and Install Certificates.
3 Modify the path and/or file name if required. You can create only files with the .pfx extension.
NOTE: You need to have read/write permissions for the folder containing the certificate file.
4 Enter and confirm a password.
5 Modify the expiration date (see page 96) if needed.
NOTE: Schneider Electric recommends that you do not extend the validity period.
6 Click Generate and Install.
Result:
 The root CA certificate file is created at the selected location.
 A set of entity certificates is installed on the computer. If you are using an all-in-one
architecture, the certificate installation process is complete.
 The fields of the Last Installed Certificates Details section are populated.
NOTE: If the Certificate Import Wizard dialog box opens, you can click No to preserve your
current Certificate Revocation List (CRL). Clicking either button has no impact on the PKI
functionality for EcoStruxure Hybrid DCS. Certificate revocation is currently not supported.
7 If you are using the System Server Configuration Wizard only to generate and/or install
certificates, you can close the window by clicking the close button or Cancel.
EIO0000001255 09/2019 101

Installing Entity Certificates
Overview
You must install a set of entity certificates (see page 97) on each computer of a distributed
EcoStruxure Hybrid DCS system infrastructure so that clients can connect to the system server.
This applies also when using the all-in-one architecture (see page 32).
All entity certificates of a same system infrastructure must be issued and signed by the same root
CA.
You can test the client/server connection to verify certificate validity.
Prerequisites
 You must have installed the system server and clients. The component on which you want to
install entity certificates must not be running.
 You must have generated a root CA certificate (see page 98) by using the System Server
Configuration Wizard or posses your own root certificate file with .pfx extension.
 The folder containing the root certificate file must be accessible from the computer on which the
component is installed.
102 EIO0000001255 09/2019

Connecting Clients to Several System Servers Having Different Certificates Installed

If you need to connect a client to several system servers each possessing entity certificates issued
by a different root CA, you need to install in the client as many sets of entity certificates as there
are system servers. Each set of client entity certificate is generated by using the same root CA as
the one used to generate the entity certificates on the system server computer.
Accessing Client Configuration Wizards
Step Action
1 Verify that clients are closed.
2 In the Windows® Start menu, click EcoStruxure Hybrid DCS.
3 Click the Configuration Wizard entry of any component.
4 Go to the Security section.
EIO0000001255 09/2019 103

Security Section Description

The following figure shows the Security section of the Engineering Client Configuration Wizard.
The section is available also in the configuration wizards of the operation client and system server
(see page 99).
Item Description
1 Full path of the root CA certificate file.
Once you have successfully generated entity certificates, the last full path that you have entered
is retained when you open the same configuration wizard again.
2 Enter the password that was used to generate the root CA certificate.
NOTE: If you have forgotten the password, you need to generate a new root CA certificate.
104 EIO0000001255 09/2019

Item Description
3 Expiration date of the set of entity certificates that are installed on the computer.
15 days before the expiration date (see EcoStruxure™ Hybrid DCS, User Guide), a notification
about the upcoming certificate expiration is shown. From then on, you are notified at 24-hour
intervals.
The expiration notification is displayed in clients that are starting or running. In a distributed
EcoStruxure Hybrid DCS system infrastructure, the upcoming expiration of the system server
certificate is shown in clients that are connected to this server.
After this date, the next time a client attempts to connect to the system server, the entity certificates
are considered invalid. A new set of certificates needs to be installed.
NOTE: The expiration date cannot exceed the expiration date of the root certificate.
4 Button to proceed with the installation of the root CA and the set of entity certificates on the
computer.
5 Button to uninstall root and entity certificates (see page 107) from the local computer.
6 Once you have successfully installed certificates on the computer, the fields display the
corresponding information. If no certificates are installed on the computer or if the operation did
not succeed, the fields are empty.
Installing Entity Certificates
Step Action
1 Verify that the EcoStruxure Hybrid DCS components installed on the computer are not running.
If you are installing entity certificates for a system server, verify that clients that connect to it are
not running.
2 Open the Security section of the configuration wizard of the component installed on the
computer.
NOTE: If you have installed several components (for example, an engineering client and an
operation client) on the same computer, you need to install certificates once by using the
configuration wizard of either of the installed components.
If one of the installed components is the system server, you must use the System Server
Configuration Wizard. It installs certificates for the clients as well.
3 Enter the full path of the root CA certificate file (see page 99) with the .pfx extension.
4 Enter the password for the root CA certificate.
5 Modify the expiration date (see page 96) if needed.
NOTE: Schneider Electric recommends that you do not extend the validity period.
6 Click Install.
Result: The set of entity certificates and the root CA certificates are installed in the local
certificate store.
NOTE: If the Certificate Import Wizard dialog box opens, you can click No to preserve your
current Certificate Revocation List (CRL). Clicking either button has no impact on the PKI
functionality for EcoStruxure Hybrid DCS. Certificate revocation is currently not supported.
EIO0000001255 09/2019 105

Step Action
7 For clients that need to connect also to another system server (see page 103), repeat the
procedure and enter the full path and the password that corresponds to the root CA certificate
used on the other system server computer.
8 If you are using the configuration wizard only to install certificates, you can close the window by
clicking the close button or Cancel.
Verifying Certificate Validity

The Test Certificates button lets you verify if the certificate that is installed on the computer is valid
for the system server to which the client is configured to connect (see page 119). To perform the
test, the computer running the system server must be reachable and the server running. If a
connection can be established, the certificate is valid.
The button is located in the System Server section of the configuration wizard of the engineering
and operation clients.
A notification informs you of the outcome of the test.
106 EIO0000001255 09/2019

Uninstalling Certificates from the Computer
Overview
Uninstalling certificates deletes the EcoStruxure Hybrid DCS root CA and entity certificates from
the certificate store of the computer.
The root CA certificate file (.pfx) remains on the computer and can be reused to install new entity
certificates.
Prerequisites
You can uninstall certificates from a computer only when the components installed on this
computer are not running.
EIO0000001255 09/2019 107

Uninstalling Certificates When Removing the Software

By default, when you remove (see page 163) the software from the computer by using the installer
or the Change command of the Windows® Control Panel, EcoStruxure Hybrid DCS certificates
remain in the certificate store of the computer.
If you reinstall the software or install a later version, these certificates are reused as long as they
are still valid. You do not need to install new certificates.
Clear the Preserve Certificates check box to delete EcoStruxure Hybrid DCS root CA and entity
certificates from the certificate store.
NOTE: When the root CA certificate file (.pfx) is no longer present, you can reinstall or modify the
software on the same computers but you cannot renew entity certificates or install the software on
different computers by using this root CA certificate.
108 EIO0000001255 09/2019

Uninstalling Certificates from the Computer
Step Action
1 Verify that the EcoStruxure Hybrid DCS components installed on the computer are not running.
2 Open the configuration wizard of a component that is installed on the computer.
3 In the Security section (see page 104), click Uninstall.
Result: The EcoStruxure Hybrid DCS certificates that were installed on the computer are
deleted from the local certificate store.
EIO0000001255 09/2019 109

110 EIO0000001255 09/2019

Configuring the Software
EIO0000001255 09/2019
Chapter 8
Overview
This chapter describes how to configure the system server, clients, as well as virtual machines
before starting the software for the first time and thereafter when changes are required.
The purpose is to:
 Verify and/or configure parameters of:
 The system server and clients.
 The virtual machine (VM) that is installed with the system server and/or engineering clients.
 Participants running inside the VM.
 Install in and/or remove from Participants running inside the VM extensions, such as:
 Device type managers (DTMs).
 Generic station description (GSD) files.
 Hotfixes or patches.
The configuration is performed by using the various sections of the configuration wizards.

Topic Page
Using Configuration Wizards 112
Configuring the System Server and Clients 117
Configuring the Virtual Machine 120
Managing Participant Extensions 130
Activating the Virtual Machine 143
Configuring the Content of Blank Databases 144
EIO0000001255 09/2019 111

Using Configuration Wizards
Overview
The following configuration wizards are available to facilitate the configuration of software
components:
 System Server Configuration Wizard
 Engineering Client Configuration Wizard
 Operation Client Configuration Wizard
Each configuration wizard consists of several sections.

Configuration wizards are used for the initial configuration of the client/server architecture and later
to adjust your settings if required. Starting a component without using its configuration wizard
applies the default settings that are described in this chapter.
You can access the client configuration wizards through the start menu of Microsoft® Windows®.
The system server configuration wizard is accessible only from the server console (see page 148).
You must have the necessary permissions.
NOTE: Configure the system server first because the software provides means to take over server
settings when configuring clients to speed up the configuration process.
Client/Server Configuration and User Accounts

The configuration of the system server and clients that is performed by using the corresponding
configuration wizard is tied to the user account that is used to log on to the operating system of the
computer. Configuration settings are stored in the local user folder.
When another user logs on to the computer for the first time, the person has to perform the
necessary configuration, including the activation of the VM.
If the configuration of the system server changes (for example, because another user has logged
on to the computer running the system server, which has loaded the account-specific system
server configuration), then the configuration of clients connecting to the server may change as well.
112 EIO0000001255 09/2019

Configuration Wizard Sections

The System Server Configuration Wizard features the following sections.
Section Description
Security Used to generate the root CA certificate, install entity certificates, and uninstall
certificates (see page 93).
Authentication Used to set up the authentication type (see page 91) for role based access control
(RBAC) for the EcoStruxure Hybrid DCS system infrastructure.
Hosting Used to view and configure communication port settings for connections with
clients.
Virtual Machine Used to configure settings to activate and configure the system server VM (saved
states).
Extensions Used to customize software participants installed in the VM.
The Engineering Client Configuration Wizard and Operation Client Configuration Wizard feature
the following sections.
Section Description
System Server Used to view and configure communication settings for the connection with the
system server.
Security Used to install entity certificates and uninstall certificates (see page 93).
Virtual Machine Used to activate and configure the local VM (saved states).
Synchronization of Participants of System Server and Client VMs

The system server and client VMs can be configured differently. However, for client/server
communication to function properly, the software Participants hosted by the respective VMs need
to be synchronized.
For example, additional device type managers (DTMs) that you install in the Control Participant of
the system server VM also need to be installed in the Control Participant of any client VM.
The software uses automated mechanisms that facilitate the configuration of VMs and the
synchronization of the software Participants.
NOTE: How to easily configure client VMs to be identical to the system server VM is described in
the topic documenting VM configuration (see page 120).
EIO0000001255 09/2019 113

The following figure illustrates the scenario where the VM configuration and the extensions of both
the system server and the client VM are identical. Starting the system server configures the VM
and generates the saved states. When a client that uses a VM connects to the system server, the
saved states of the system server VM are automatically transferred to the client computer. As a
result, patches and/or extensions (for example, DTMs (see page 130)) that were installed on the
VM server-side are readily available client-side because they are part of the saved states of the
VM. You can disable automatic transfer of saved states (see page 121).
NOTE: If the VM was not able to start server-side, saved states cannot be transferred to clients
and VM services are not available client-side. Take the necessary corrective actions server-side
and start the system server again.
114 EIO0000001255 09/2019

The following figure illustrates another scenario where the VM configuration and/or the extensions
of both the system server and the client VM are different. When a client that uses a VM connects
to the system server, the software detects the difference, copies the server-side extensions to the
client computer, and generates the saved states locally to take into account the specific
configuration of the client VM. As a result, installation of patches and/or extensions (for example,
DTMs (see page 130)) that were performed on the VM server-side are repeated on the VM client-
side.
Differences that the software detects between the system server and clients are, for example:
 A client VM configuration parameter (for example, a different timeout or language setting).
 A new DTM that is installed on the system server.
 A different VM activation key that is used for the client VM.
 VT-X/AM-V settings of Oracle® VM Virtualbox software.
EIO0000001255 09/2019 115

The following client configuration wizard parameters are not considered to check whether the
server and client VM configuration is identical:
 Folder shared with virtual machine
 Force saved states generation
NOTE: If an engineering client attempts to connect to the system server while the latter is still
starting, server-side extension files are copied to the client even if their VM configuration and
extension files are identical. This results in saved states being generated locally client-side.
Using Configuration Wizards

When the software is running and you make changes by using a configuration wizard, the changes
are applied only when you restart it.
NOTICE
NOTE: Quit a software component before making changes by using its configuration wizard.
To use a configuration wizard, proceed as follows. You must have the necessary permissions.
Step Action
1 From the Microsoft® Windows® Start menu, click EcoStruxure Hybrid DCS and one of the
configuration wizards:
 Engineering Client Configuration Wizard
 Operation Client Configuration Wizard
For the System Server Configuration Wizard, in the menu bar of system server console, click
Settings → Basic. The system server needs to be stopped.
Result: The selected configuration wizard opens.
2 Verify the settings and/or make necessary changes in the various sections (see page 113) of the
configuration wizard as described further in this chapter.
Clicking Back does not discard your changes.
3 Click Save & Close.
NOTE: Click Cancel to discard changes and close the configuration wizard. You cannot cancel
the creation of certificates (see page 93).
116 EIO0000001255 09/2019

Configuring the System Server and Clients
Overview
This topic describes the parameters that you can configure by using:
 The Hosting section for the system server:
 The client/server communication port.
 The file transfer port.
 The System Server section for clients:

 The client/server communication port.
 The IP address of the system server.
This topic also describes the communication ports that are used by the VM and third-party software
installed along with EcoStruxure Hybrid DCS.
Communication Port Availability

Before using the system server and its clients, you need to verify that the ports configured by
default are not already used on the computer on which the system server is installed.
In case one of these ports is used, you need to configure another port that is available.
To verify port usage on the computer, execute netstat -a -b at a command prompt. The
command returns a list of ports that are being used and the corresponding application.
EIO0000001255 09/2019 117

System Server Communication Port Description

The table describes the parameters that you can configure in the Hosting section of the System
Server Configuration Wizard window.
Parameter Description Default value

Port Main TCP port that is used by engineering and 9950
operation clients to communicate with the system
NOTE: The same value is
server to load data and execute user commands.
configured by default for
NOTE: If you modify this value, you need to modify it engineering and operation
also for each engineering and operation client that clients.
connects to the server.
File transfer port TCP port that is used to transfer files between clients, 9951
the system server, and software Participants of VMs.
The port is automatically transferred to VMs and clients.
CriticalMessaging port Port that is used to maintain a continuous 9949
communication link between the system server, clients,
NOTE: The same value is
and virtual machines. The port is used by the
configured by default for
SystemServer.exe and HostAgent.exe processes.
engineering and operation
NOTE: If you modify this value, you need to modify it clients in the Virtual Machine
also for engineering and operation clients that connect section of the corresponding
to the server. configuration wizard.
Caché installation path Installation path of the third-party software that C:\Program Files\InterSystems\
manages the EcoStruxure Hybrid DCS database. STRUXUREWAREPEv44
NOTE: Both ports accept connections from any IP address.

The table describes additional ports used by the system server.
Protocol Port Description

UDP 18080 Logging/display
UDP 18081 Logging
118 EIO0000001255 09/2019

Server Parameters for Clients

The table describes the parameters that you can configure in the System Server section of the
Engineering Client Configuration Wizard and Operation Client Configuration Wizard windows.
Parameter Description Default value

Host Name / IP Name or IP address of the computer on which the system Localhost
Address server is installed.
For example, Server_1 or 168.190.0.100.
Port TCP port that is used for the client/server connection. 9950
NOTE: If you modify this value, you need to modify it also NOTE: The same value is
for the system server and any other engineering and configured by default for the
operation client that connects to the same server. system server.
NOTE: You can test the client/server connection by using the Test Certificates button. The system
server must be running. A dialog box informs you of the outcome of the test. If you experience
difficulties, refer to the troubleshooting topic (see page 178).
Virtual Machine Communication Ports

Software components bind VM services to the following ports.
Protocol Port Description

TCP 39081 One port by VM instance. For example, if two instances of the VM are
TCP 39181 used, ports 39081 and 39082 are used.
If you experience difficulties, verify if another program is using any of these ports or if the firewall
is blocking them.
NOTE: For engineering clients, ports used by the local VM are bound to IP address 127.0.0.1
(localhost) to accept only local connections.
EIO0000001255 09/2019 119

Configuring the Virtual Machine
Overview
Before using the system server or clients for the first time, you need to verify and/or configure
certain parameters of the VM by using the corresponding configuration wizard (see page 112);
otherwise the default settings that are described in this topic are applied.
VM to be configured Configuration wizard to be used Comment

System server VM System Server Configuration -
Wizard
Engineering client VM (local Engineering Client You can take over the system server VM
VM. Includes VM used by Configuration Wizard settings or customize the local VM.
operation client installed on the In addition, you need to use the
same computer) Operation Client Configuration Wizard to
allow the use of the local VM.
System server VM (used by System Server Configuration In addition, you need to use the
engineering clients and/or Wizard Engineering Client Configuration Wizard
operation clients) of each engineering client to configure it
so that it does not use its local VM.
Thereafter, use the wizards to adjust parameters of the VM if necessary.

NOTE: During the initial configuration you need to activate the VM (see page 143).
Configuration Priority
When the system server with a VM and an engineering client are installed on the same computer,
and you configure the VM by using the configuration wizard of both the system server and the
engineering client, the parameters that are applied to the VM are the ones you configure in the
system server configuration wizard.
When an engineering and an operation client are installed on the same computer, changes that
you save in the Virtual Machine section of one configuration wizard appear also in the configuration
wizard of the other client when you open it. Changes to either configuration wizard that you save
last are retained.
120 EIO0000001255 09/2019

Configurable Virtual Machine Parameters

The following figure shows the Virtual Machine section of the system server configuration wizard,
which allows you to configure parameters of the VM of the system server.
EIO0000001255 09/2019 121

The following figure shows the Virtual Machine section of the engineering client configuration
wizard, which allows you to configure parameters of the VM that is used by the engineering client.
122 EIO0000001255 09/2019

The following figure shows the Virtual Machine section of the operation client configuration wizard,
which allows you to configure parameters of the VM that is used by the operation client.
1 Set of parameters that are specific to the client and that you can configure if the client uses the
local VM; even if you select to use system server settings to configure the VM.
2 Click the button to view settings of the VM of the system server, which are configured in the
Virtual Machine section of the System Server Configuration Wizard. The execution of the local
VM needs to be allowed and the system server needs to be running.
3 Select either option to configure the VM of clients:
 Use server configuration: Default setting. Selecting this option configures the VM of the client
by using the same settings as those of the VM of the system server. The fields of the
configurable parameters are not visible.
Saved states of the client VM are transferred from the system server to the client
(see page 113).
 Use custom configuration: Selecting this option allows you to configure each parameter of
the VM of clients independently. Fields that you leave blank use the setting of the VM of the
system server.
Saved states of the client VM are generated locally (see page 113) if you customize a
parameter.
NOTE: You cannot customize the Folder for user extensions parameter.
NOTE: The functionality is enabled only if you have allowed the execution of the local virtual
machine.
EIO0000001255 09/2019 123

The table describes the parameters of the Virtual Machine section of the configuration wizard that
are related to the activation of the VM.
Parameter Description
Windows product The Windows® product key (see page 28) to activate the operating system of the VM
key with Microsoft®.
Default value: Blank
NOTE:
If you enter a wrong product key, the operating system is not activated and the software
displays a message in:
 The console for the system server.
 The notification panel for an engineering client.
Open the corresponding configuration wizard (see page 121), enter the correct product
key. The new value takes effect at the next restart of the component.
Key Management Name and/or port for the Key Management Server (KMS) that the host computer uses
Server (KMS) when you activate the operating system of the VM by using a Windows® product key
under a volume license agreement (see page 28).
The format is hostname:port.
NOTE: Enter an IPv6 address in the format [hostname]:port.
are related to the licensing of the VM.
Port@Address of Floating License server port of the Floating License Manager where the system server
License Manager license is activated and IP address of the computer on which this FLM is
installed.
This information is required by certain software Participants that are running
inside the VM for licensing purposes.
Default value: 27011@127.0.0.1 (corresponds to localhost).
If the FLM is installed on a different computer, enter the appropriate
information. Use the format port@IP address (IPv4).
NOTE:
 This parameter is not a substitute for the License Manager.
 If you experience difficulties with Participant services, verify which license
server port is used by the FLM (see EcoStruxure™ Hybrid DCS, Licensing
Guide).
124 EIO0000001255 09/2019

are related to the usage of the VM (see page 20).
Allow execution of local Client parameter only.
virtual machine When the check box is:
 Selected (true): The client can use the local VM, which is the VM that is
running on the computer. The settings of the configuration wizard apply to the
local VM. The client can still use the VM of the system server (see page 24) if
the system server configuration allows it.
 Cleared (false): The client uses the VM that is installed on the system server
computer, whose name or IP address is configured in the Server section of
this wizard. Verify that the system server VM is configured to allow clients to
use it.
You cannot change local VM settings by using the configuration wizard. To
change settings of the VM of the system server, use the System Server
Configuration Wizard.
If a client cannot access a VM, you cannot complete the system engineering life
cycle and/or use runtime navigation services.
Default values:
 Engineering client: Selected (true)
 Operation client: Cleared (false)
NOTE:
For the operation client, verify that:
 The system server VM is configured to allow clients to use it.
 If you set the parameter to true, an engineering client needs to be installed on
the same computer unless the operation client is installed on the system
server computer.
Maximum number of The maximum number of VM instances that users are allowed to use. The
virtual machine instances instances can be on the system server, on clients, or on both depending on the
running simultaneously parameter settings for VM usage.
If you change the setting, confirm that this number does not exceed the limit that
is defined by your Microsoft® VM licensing terms (see page 27) and the
performance of your computer is adequate (see page 20).
Default value:
 For the system server: 2
 For clients: 1
The software starts a new instance automatically when the slots of the current VM
are already used and it receives the request for a new slot (see page 21).
EIO0000001255 09/2019 125

Folder containing virtual Enter the path to the VM folder containing the virtual image file (.vdi) if you need
machine files (.vdi) to move the folder after installing the software.
This could be necessary, for example, if the disk that contains the VM folder is
running out of space because the virtual machine file is a large file.
Value: Path selected during the installation (see page 49) of the software. By
default, C:\ProgramData\Schneider Electric\Hybrid DCS x\VM, where x
corresponds to the installed major version (the R• version suffix does not
appear).
CriticalMessaging Port Refer to the description of the parameter in the topic documenting the
configuration of server and clients (see page 118).
Allow clients to use virtual System server parameter only.
machine of system server When the check box is selected (true), allows engineering and operation clients
to use the VM (see page 20) that is installed on the computer on which the
system server is installed.
In this case, ports used by the VM (see page 119) are bound to IP address
0.0.0.0 to accept connections from remote computers; otherwise ports are bound
to IP address 127.0.0.1 (localhost).
Default value: Selected (true)
126 EIO0000001255 09/2019

Folder shared with virtual Path to an existing folder on the local computer or network that becomes
machine accessible from the software Participants installed in the VM.
To access the folder select the Network node in dialog boxes of software
Participants and drill down. The folder that is shared with the VM does not
appear; only its files and subfolders are shown. For example, if you share the
local folder C:\VM_Files, which contains subfolder Control, when you access the
shared folder from a software Participant, you see only Control.
Configuring this parameter is required to manage software Participant files (for
example, to export/import files in the Control Participant) and to exchange files
between the VM and the host computer.
NOTE: You cannot share the system root folder (for example, C:\).
NOTE: The folder that you specify needs to exist on the computer that hosts the
VM or on a network that this computer can access. If you enable sharing for this
folder, restrict access by giving permissions only to users who must access this
folder.
For example, if an engineering client installed on PC_1 is configured to use the
VM of the system server, which is installed on PC_2, entering C:\Temp in the
system server configuration wizard allows the VM that is displayed in the
engineering client to access this folder on PC_2. Also, any other engineering
client that is configured to use the VM of the system server can access this folder
as well.
On the opposite, if you are using two engineering clients that are configured to
use their local VM:
 To use the C:\Temp folder on the system server, enter the network path to the
folder in each engineering client configuration wizard and share the folder so
that the two engineering client computers can access it (when sharing, give
permissions only to the user of each of the two engineering clients). Similarly,
you can configure any folder on the network to be shared with the VM of each
engineering client. The use of a shared folder on the network is recommended
to share a single folder with several VMs. When sharing, give permissions
only to specific users who need to access the folder.
 To use a local folder on each engineering client computer, enter its path in the
engineering client configuration wizard.
Memory allocated to Size of the paging file of the VM in MB.
virtual machine in MB Typically, do not allocate more than half of the memory available on the host
computer.
Default value: 4096
NOTE: Modifying this parameter may cause the software to function incorrectly.
EIO0000001255 09/2019 127

Processor Count Number of virtual CPU cores that are allocated to the VM.
Allocating more virtual CPU cores can help improve Control-Participant-related
operations.
Typically, do not allocate more than 25% of the physical CPU cores of the host
computer. For example, not more than 4 cores for a 16-core CPU.
Default value: 2
NOTE: Decreasing the default value may reduce the performance.
Ratio to apply to timeouts Allows modifying the default timeouts that apply to the start of the VM (for
example, timeout applicable to the generation of saved states of the VM during
system server startup).
Enter values:
 From 1 to 14 to reduce timeouts.
 From 16 to 100 to increase timeouts.
Increasing the ratio may help when you experience difficulties during the start of
the VM because of low computer performance.
Range: From 1 to 100
Default value: 15
NOTE: Reducing timeouts excessively or entering a value that is outside of the
range may cause the software to function incorrectly.
Default keyboard layout Allows you to select the default keyboard layout to be used when you work inside
software Participants.
Default keyboard layout setting: US
For more information, refer to Language Settings (see EcoStruxure™
Hybrid DCS, User Guide).
System locale Allows you to set the system locale setting of the operating system of the VM,
which controls the language used to display text in programs that do not support
Unicode. Applies to non-Unicode software Participants.
Change the setting if the language used by non-Unicode Participants to display
text contains characters that are not part of the Windows-1252 code page layout,
which corresponds to English and some Western languages.
Default value: US (en-US)
For more information, refer to Language Settings (see EcoStruxure™
NOTE: The setting does not affect time, date, and currency formats.
Update virtual machine When the check box is selected (true), generates the saved states of the VM
with latest extensions again.This reinstalls any extensions that are listed in the Extensions section of
the configuration wizard.
The setting is helpful, for example, when a Participant has stopped working.
Restarting the system server and selecting this parameter restarts the
Participant.
Default value: Cleared (false)
128 EIO0000001255 09/2019

Force re-activation of When the check box is selected (true), the software verifies if the operating
Windows system of the VM is activated with Microsoft®. If it is not, it starts the activation
procedure like for a first system server start. If the operating system is already
activated, it starts the system server normally.
Select the check box, for example, if move the VM file (.vdi) to a different
computer. In such case, Windows® detects the hardware change and requires
reactivation.
Default value: Cleared (false)
EIO0000001255 09/2019 129

Managing Participant Extensions
Overview
This topic describes how to use the Extensions section of the System Server Configuration Wizard
to install and remove the following types of extensions in the Control Participant:
 Device type managers (DTMs)
 Generic station description (GSD) files
 Electronic data sheet (EDS) files of devices communicating by using EtherNet/IP
Once installed, you can use these extensions to configure topological entities in the Topology
Explorer.
It also describes how to install other extensions (see page 140) such as libraries containing Control
resources that you need to refine Control Participant projects.
The software provides silent and manual installation modes. For the installation of GSD and EDS
files (manual mode only), installation files are provided to facilitate the installation.
You can install extensions only in the VM of the system server. Each time you make a change in
the Virtual Machine or Extensions sections of the system server configuration wizard and you start
the system server, the extensions that appear in the Extensions section are reinstalled.
The software transfers or installs automatically to clients that use a VM the extensions that are
installed in the VM of the system server.
If the installation of an extension does not complete successfully or if you cancel it, the VM does
not start.
NOTE: Use the Extensions section also to install hotfixes in software Participants (see page 141).
NOTE: The commands of the Control Participant that allow you to add and remove EDS files are
available but the corresponding wizards do not open when the commands are executed. Follow
the procedures described in this topic instead.
Transferring Extensions to Clients

When an engineering client connects to the system server once it is started, the software transfers
or installs automatically to the VM client-side (see page 113) the extensions that are installed in
the system server VM.
If the generation of the saved states of the client VM is done locally, the silent and manual
installations are repeated client-side exactly like they were executed server-side. Installations in
manual mode require the same user intervention.
NOTE: If you have installed or removed an extension while an engineering client was still open,
the next time the engineering client queries a Participant, the software detects the difference and
restarts the VM of the engineering client to synchronize it with the system server VM.
130 EIO0000001255 09/2019

Supported Installation File Types and Installation Methods
File type Installation mode Comment

.exe and .msi Silent or manual To install DTMs by using an InstallShield response file (setup.iss),
Default mode: refer to the appendices (see page 187).
Manual.
.gsd The installation requires using the InstallGsd folder, which is a
subfolder of the VM Extensions folder located in the root of the
software installation package (.iso).
NOTE: Manual mode is the recommended installation method for
this file type.
.bat You can create your own batch file and have it executed.
.eds Manual Adding this file type requires using the EDS_Addition.bat file that
is located at the path VM Extensions\InstallEDS starting from the
root of the software installation package (.iso).
NOTE: To remove EDS files that are part of the device library
(see page 139) of the Control Participant, use the
EDS_Deletion.bat, which is located in the same folder. The .bat file
is not required to remove EDS files that you have added.
The software installs extensions one after the other in the order that is assigned to them
(see page 132).
The timeout for a silent installation is 10 min. If the installation is not completed within this period,
it is considered not successful.
If the installation in silent mode does not complete successfully, after the timeout is elapsed,
installation starts over in manual mode automatically. This can be the case, for example, if during
a silent installation user interaction is required for the installation to continue or complete.
The following restrictions apply:
 You can only install DTMs that create a setup.log file once installation is completed. Refer to the
alternate procedure (see page 187).
 You cannot use silent installation for nested installers.
 You cannot install an extension that requires a restart of the VM after installation.
NOTE: When you install DTMs, the DTM update dialog box of the Control Participant is displayed
even if the DTM is installed in silent mode.
EIO0000001255 09/2019 131

Recommendations
To reduce the possibility of unsuccessful installation:
 Do not place installation files in the root directory of a drive or on the desktop of the computer
before selecting them for installation. Instead, place installation files of each extension in a
separate folder because the software copies the entire folder containing the setup file
(see page 131) (for example, ExtensionSetup.exe) to another location to proceed with the
installation.
 When possible, use the .msi file for the installation rather than the .exe file.
 Extract compressed installation files (.exe or .msi) and place them in a folder, which does not
contain the compressed archive.
 Close all clients before installing or removing extensions.
Extensions Section
The following figure shows an example of the Extensions section of the system server
configuration wizard, which lets you install and remove DTMs, GSD files, and other types of
extensions in the VM of the system server.
132 EIO0000001255 09/2019

Item Description
1 Opens the Browse Extension dialog box, which lets you browse and select the .exe, .msi., or .bat
file of extensions that you want to install.
2 Once you have selected an extension, its path appears under Extension Name.
Extensions that are already installed or that you had added but that did not install successfully
remain in the list of extensions with the order they were assigned when you last saved the
configuration wizard settings.
When you click Save & Close, the folder containing a newly selected extension file (.exe, .msi, or
.bat) is copied to the path C:\Users\Username\AppData\Local\Schneider
Electric\Hybrid DCS X\Vm\HybridDCS.Vm.X.UserExtensions, where X corresponds to the major
version of the software (the R• version suffix does not appear) and x.y is a version index. This is
the location from where the extension is installed.
You cannot install extensions by copying installation files to this folder manually.
Clicking Cancel in the System Server Configuration Wizard section removes from the list of
extensions any extensions, which have not yet been copied to the
HybridDCS.Vm.X.UserExtensions folder.
NOTE:
Once the folder containing the extension file has been copied to the
HybridDCS.Vm.X.UserExtensions folder:
 The path that appears under Extension Name is updated when you reopen the System Server
Configuration Wizard. It shows the name of the extension installation file and its parent folder.
The full path appears in a tooltip.
 If you need to modify any file in the folder, you must remove the extension from the list first,
proceed with the modification, then add the extension again. If the extension has not yet been
installed in the VM, you do not need to start the server after removing the extension.
3 Indicates the order in which extensions are installed.
You can change the order of installation by dragging an extension up or down to another row.
4 Lets you select the installation mode of the extension (see page 131).
NOTE: Selecting silent mode may not install the extension successfully if the extension does not
support silent mode because, for example, the user is required to provide information during
installation.
EIO0000001255 09/2019 133

Item Description
5 Lets you remove extensions from the list of extensions:
 Not yet installed extensions are not installed.
 Already installed extensions are uninstalled from the VM.
You need to confirm the command.

Starting the system server uninstalls from the VM the extensions that you have removed.
To remove an EDS file from the device library of the Control Participant, the procedure depends on
the EDS file:
 For EDS files that you have added by using the Extensions section of the System Server
Configuration Wizard, remove the EDS_Addition.bat file from the section by clicking the remove
button. This removes the device from the device library and deletes the .eds files.
 For EDS files that are part of the device library of the Control Participant, follow the procedure
describing how to remove EDS files (see page 139).
NOTE: The folder containing the extension file is deleted from the
HybridDCS.Vm.X.UserExtensions folder after you click Save & Close. Until you do so, clicking
Cancel in the System Server Configuration Wizard does not delete the folder and restores the
extension to the list of extensions.
6 Lets you replace an extension by another one without changing the order. The installation mode is
reset.
7 Resets the installation mode of all the extensions that appear in the list of extensions to Manual.
134 EIO0000001255 09/2019

Installation of Extensions Window

Installations for which you select manual mode or that switch to this mode open the Installation of
Extensions window.
It displays dialog boxes pertaining to the verbose installation mode of extensions. You need to
interact with these dialog boxes to complete the installation of the extension.
The window closes automatically when installation is complete.
NOTE: Do not interact with elements of the Installation of Extensions window other than the dialog
boxes of the installer. Closing the window cancels the installation of the extension.
The following figure shows an example of the window. The content that is displayed inside may
vary depending on the type of extension that you are installing.
EIO0000001255 09/2019 135

Installing Extensions in Manual Mode

To install an extension by using the manual installation mode, proceed as follows. For EDS files,
refer to the specific procedure describing how to add them (see page 138).
Step Action
1 Go to the Extensions section of the System Server Configuration Wizard.
2 Open the Browse Extension dialog box and select the installation file (.msi, .exe or, or .bat) of
the extension that you want to install.
NOTE:
If you want to install extensions by using .gsd files, first perform the following steps:
1. Copy the InstallGsd folder (see page 131) to disk. You can change the name of the folder.
2. Copy the extension files (.gsd) to the InstallGsd folder. You can create subfolders.
3. In the Browse Extension dialog box, browse to the InstallGsd folder and select the
Execute.bat file.
3 Modify the order if required.
4 Navigate to the last section of the configuration wizard and click Save & Close.
Result: Folders containing newly selected extension files are copied to the
HybridDCS.Vm.X.UserExtensions folder. Once files and folders are copied, the System Server
Configuration Wizard window closes.
5 Starting the system server starts the VM and initiates the installation of the extensions that
appear in the list of extensions.
Result: The Installation of Extensions window opens.
6 Follow the instructions in the dialog boxes that appear in the Installation of Extensions window.
Result: Once you complete the installation of the extension, the Installation of Extensions
window closes.
NOTE: When you install extensions by using .gsd files, a command prompt window also opens
in the Installation of Extensions window. You need to close the command prompt window after
you have interacted with the installer dialog boxes for the Installation of Extensions window to
close.
NOTE: If you close the Installation of Extensions window manually or cancel the installation of
an extension, the system server starts but without starting the VM.
7 When the installation of DTMs is completed, the Installation of Extensions window opens again
and displays the FDT/DTM Catalog dialog box of the Control Participant.
If the FDT/DTM Catalog dialog box requires any interaction, follow the instructions on screen;
otherwise the dialog box and the Installation of Extensions window close automatically after the
DTM catalog has been updated with the newly installed DTMs.
NOTE: If you do not interact with the FDT/DTM Catalog dialog box when it is required before
the timeout elapses, the Installation of Extensions window closes and installation of the DTM is
considered not successful.
8 When the installation of extensions is completed, the result of the installation (see page 142) is
indicated in the system server console under Result of application of user extensions. Review
the entries.
Startup of the system server continues.
136 EIO0000001255 09/2019

Installing Extensions in Silent Mode

To install an extension by using the silent installation mode, proceed as follows.
Step Action
2 Open the Browse Extension dialog box and select the installation file (.msi, .exe or, or .bat) of
the extension that you want to install.
3 Modify the order if required.
4 Select Silent as installation mode.
Result: Folders containing newly selected extension files are copied the
Result: When the installation of DTMs is completed, the Installation of Extensions window
opens and displays the FDT/DTM Catalog dialog box of the Control Participant.
NOTE: The installation of an extension may restart in manual mode.
7 If the FDT/DTM Catalog dialog box requires any interaction, follow the instructions on screen;
otherwise the dialog box and the Installation of Extensions window close automatically after the
DTM catalog has been updated with the newly installed DTMs.
NOTE: If you do not interact with the FDT/DTM Catalog dialog box when it is required before
the timeout elapses, the Installation of Extensions window closes and installation of the DTM is
considered not successful.
8 When the installation of extensions is completed, the result of the installation (see page 142) is
indicated in the system server console under Result of application of user extensions. Review
the entries.
Startup of the system server continues.
9 Once the system server is started and you have started an engineering client, if an extension
that you have added was installed in silent mode, confirm that it is installed correctly.
If not, open the System Server Configuration Wizard, change the installation mode to Manual,
and start the system server again.
EIO0000001255 09/2019 137

Adding EDS Files in Manual Mode

To add one or more EDS files, proceed as follows. For more information, refer to Adding an EDS
File in the Hardware Catalog in the Control Participant help.
Step Action
1 Create a folder on the computer on which the system server is installed and copy to it:
 The EDS_Addition.bat file
 EDS installation files
You can create subfolders .

3 Open the Browse Extension dialog box and select the EDS_Addition.bat file.
NOTE: Verify that the installation mode is set to Manual.
Result: The folder containing the .bat file and the EDS installation files is copied to the
Result: The Installation of Extensions window opens and displays the start screen of the EDS
Addition wizard.
6 In the EDS Addition wizard, click Next to go to the next screen.
7 Select the appropriate settings and the location of the EDS files by clicking Browse.
Result: The Open dialog box opens.
8 Click Network → VBOXSVR → \\VBOXSVR\UserHostVm and either an EDS file or the folder
containing them depending on the settings that you have selected in step 7.
Result: The EDS files appear in a grid in the EDS Addition wizard.
NOTE: Each EDS file needs to be tagged with a green check mark; Otherwise, verify that you
are using EDS files of devices communicating by EtherNet/IP. If no EDS file appears, click Back
and modify the settings in step 7 (you may need to select Look in Subfolders).
9 Click Next to go to the next screen, then Finish.
Result: The EDS Addition wizard closes and startup of the system server resumes after a few
moments.
NOTE: You can cancel the EDS Addition wizard at any time. The startup of the system server
resumes without installing the EDS files.
138 EIO0000001255 09/2019

Removing EDS Files from the Control Participant Device Library

Removing an EDS file by using this procedure only removes the corresponding device or module
from the device library. It does not delete the file itself.
To remove one or more EDS files that are part of the device library of the Control Participant,
proceed as follows. For more information, refer to Removing an EDS File from the Hardware
Catalog in the Control Participant help.
Step Action
1 Create a folder on the computer on which the system server is installed and copy to it the
EDS_Deletion.bat file (see page 131).
3 Open the Browse Extension dialog box and select the EDS_Deletion.bat file.
NOTE: Verify that the installation mode is set to Manual.
Result: The folder containing the .bat file is copied to the HybridDCS.Vm.X.UserExtensions
folder. Once files and folder are copied, the System Server Configuration Wizard window
closes.
Result: The Installation of Extensions window opens and displays the start screen of the EDS
Deletion from Device Library wizard.
6 In the EDS Deletion from Device Library wizard, expand a node, select one EDS file, and click
Delete Selected File(s).
Result: The Delete EDS dialog box opens.
7 Click Yes to confirm the deletion.
Result: The selected file is removed from the list.
NOTE: Click No to close the Delete EDS dialog box without deleting the file from the list.
8 Repeat steps 6 and 7 for each EDS file that you want to remove.
9 Once you have selected all the files that you want to remove, click Close.
Result: The EDS Deletion from Device Library wizard closes and startup of the system server
resumes after a few moments.
NOTE: To get the EDS Deletion from Device Library wizard to open again (for example, if you want
to remove additional EDS files after having completed the procedure a first time), select the Update
virtual machine with latest extensions check box (see page 121) in the System Server
Configuration Wizard.
EIO0000001255 09/2019 139

Installing Control Resources in the Control Participant

The table describes the steps that you need to perform to install a Control resource in the Control
Participant by using the Extensions section of the system server configuration wizard. The
following procedure uses a type library as example.
Step Action
1 Create a folder on the computer on which the system server is installed and name it, for
example, MyLibrary.
2 In this folder, create a new text file and name it Execute.bat.
NOTE: If the library installation package already contains such a file, you can edit this one
instead.
3 Edit the file so that it contains only the following line.
"c:\Program Files (x86)\Schneider Electric\Control
Expert 14.0\setupEF.exe" "%~dp0family.dsc" -i -h
Where family.dsc is a file that is included in the library installation package. The name and
file extension may vary
NOTE: setupEF.exe is an existing file in the VM.
4 Save the Execute.bat file.
5 Copy all the library installation files to the same folder.
6 Select the Execute.bat file from the Extensions section of the system server configuration
wizard and follow the procedure describing how to install extensions in manual mode
(see page 130).
140 EIO0000001255 09/2019

Installing Hotfixes in the Control Participant

The table describes the steps that you need to perform to install a hotfix in the Control Participant
by using the Extensions section of the system server configuration wizard.
Step Action
example, MyHotFix.
3 Edit the file and enter the following two lines.
reg ADD "HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Schneider
Electric\Control Expert\V14.0" /v SilentMode /t REG_SZ /d ON /f
abc.exe /auto (where abc is the name of the hotfix executable file (for example,
ControlExpert_V14_HF123))
5 Copy the hotfix executable file (.exe) to the same folder.
wizard and follow the procedure describing how to install extensions in manual mode
(see page 130).
NOTE: If you are installing several hotfixes, you can add an entry for each (second line) in the
Execute.bat file and place all the hotfix executable files (.exe) in the same folder.
Changing the Time Zone of the VM Operating System

The table describes the steps that you need to perform to change the time zone of the operating
system of the VM.
Step Action
example, MyTimeZone.
3 Edit the file and enter the following line.
Tzutil.exe /s "<time zone>"
Where <time zone> is the time zone that you want to use.
For example, Tzutil.exe /s "Pacific Standard time"
NOTE: You can obtain your current time zone by typing Tzutil.exe /g in a command
prompt. To obtain a list of valid time zones and their display name, use the /l option.
wizard and follow the procedure described in this topic.
EIO0000001255 09/2019 141

Confirming Extension Installation

You can verify which extensions are installed and the status of an installation:
 In the system server log (see EcoStruxure™ Hybrid DCS, User Guide).
 In the system server console under Results of application of user extensions. This section also
lists system extensions that the software installs in addition to those that you add in the
Extensions section. However, it does not list extensions that you have installed by using .gsd
files.
 By refining any Control Participant project and confirm the presence of the extensions in the
Participant (for example, by opening the DTM Browser).
Impact on Extensions when Connecting a Client to Different System Servers

When a client is connected to a remote system server on which extensions are installed, these
extensions are also installed in the VM of the engineering client (local computer).
If you connect this client to a local system server on which no extensions are installed, the
previously installed extensions remain in the VM, which is now shared by the engineering client
and the system server on the local computer.
These extensions may appear in the Extensions section of the local system server. In such case,
you can remove them from the local system server if they are not required. This does not remove
them from the remote system server.
142 EIO0000001255 09/2019

Activating the Virtual Machine
Overview
You need to activate the Windows® operating system of the virtual machine (VM) by using the
appropriate configuration wizard (see page 120) and entering a suitable product key
(see page 27).
Schneider Electric recommends that you proceed with the activation the first time you start a
software component that uses a VM. This is because the VM is regenerated when you activate it
and requires, for example, reinstalling any extensions that you had already installed.
You must purchase digital licenses/product keys separately. In case you have purchased a digital
license from the Microsoft® Store, you can retrieve the corresponding product key by looking up
your purchase history and selecting Product key/Install. For more information, search Find your
downloads and product keys on the Microsoft® web site.
Activating the Virtual Machine Manually

If an attempt to activate the operating system of the VM over the Internet does not complete
successfully, the manual activation procedure is started automatically, which allows you to activate
the operating system over the phone.
EIO0000001255 09/2019 143

Configuring the Content of Blank Databases
Overview
The Data Folders section lets you configure which templates and content containers a blank
database contains.
You need to configure the parameters before starting the system server (see page 155) or using
the Create Blank Database command (see page 148).
NOTE: After the blank database has been created, you can import additional templates
(see EcoStruxure™ Hybrid DCS, User Guide) and content containers (see EcoStruxure™
Hybrid DCS, Runtime Navigation Services , User Guide).
Customizing Templates and Content Containers of Blank Databases

The folder whose path is configured by using the configurable database parameters must be
reachable from the system server computer. The folder can contain one or more archive files,
which can be located in subfolders.
To create a database that contains no templates and/or content containers, edit the path to point
to an empty folder.
To add other templates and/or content containers in addition to those that are located at the default
path, copy the corresponding archive files to this folder.
144 EIO0000001255 09/2019

Configurable Database Parameters

The following figure shows the Data Folders section of the system server configuration wizard.
Item Description
1 By default, path to the folder containing the template archive files (see page 64) (.sbk) of a
Schneider Electric library.
Verify that the templates (.sbk) that you are adding are compatible (see page 62) with this version
of the software; otherwise, the system server may not start.
2 By default, path to the folder containing the content container archive files (.cbk)
(see EcoStruxure™ Hybrid DCS, Runtime Navigation Services , User Guide) that are extracted to
disk during installation of the software.
NOTE: Verify that the selected content containers match the templates that are installed in the
database.
EIO0000001255 09/2019 145

146 EIO0000001255 09/2019

Starting the Software
EIO0000001255 09/2019
Chapter 9
Overview
This section describes the system server console and the various actions that you can perform by
using its commands. It also describes how to start the system server and engineering clients for
the first time.
For information on how to start the operation client, refer to the topic describing how to set up
runtime navigation services (see EcoStruxure™ Hybrid DCS, Runtime Navigation Services , User
Guide).
For additional information on how to start and quit the software, including logging in to clients and
client/server connection, refer to the topic that describes starting and quitting the software
(see EcoStruxure™ Hybrid DCS, User Guide).

Topic Page
System Server Console 148
Backing Up and Restoring Databases 152
Starting With a Blank Database 155
Starting the System Server 156
Starting the Engineering Client 159
EIO0000001255 09/2019 147

System Server Console
Overview
When you double-click the system server icon, the system server console opens after you are
logged-in.
The console lets you:
 Start, stop, and configure the system server.
 Back up, restore, and delete databases of the current version of the software.
 Restore databases of a supported earlier version (see page 41).
 Back up databases of the current version to migrate them to a later version.
 Create an empty database.
To use the system server console you must be a member of a group that is created for an
EcoStruxure Hybrid DCS role (see page 88) with the necessary permission.
NOTE: To back up individual systems, use the corresponding command from the system context
menu in the Systems Explorer of the engineering client (see EcoStruxure™ Hybrid DCS, User
Guide).
System Server Console Description
1 Activity and notification area of the console.

2 Full name of the logged-in user and name of computer. If the full name is not defined, the
username appears instead.
3 Access to the user menu.
148 EIO0000001255 09/2019

System Server Console Menu Bar Commands

The table describes the commands of the Action menu.
Command Description
Start Starts the system server.
NOTE: If you had restored a database of a supported earlier version, it migrates
the database (see page 77).
Stop Stops the system server after you confirm the command (see EcoStruxure™
The table describes the commands of the Database menu. The commands are unavailable(1)
when the system server is running.
Command Description
Back Up Database Opens a Save as dialog box, which lets you save (see page 152) the mounted
database to disk as one file (.dbk).
Restore Database Opens an Open dialog box, which lets you mount a database by using a backup file
of either format:
 .dbk: Backup files created by using the Back Up Database command of the
current version of the software.
 .mdbk: Backup files created by using the Migrate Database command of a
supported earlier version of the software. This mounts the database so that it is
migrated (see page 77) when you start the system server.
NOTE: The software creates a copy of the database folder (see page 152) before
restoring the one that you have selected.
Delete Database Allows you to remove the Caché database entries pertaining to the installed
EcoStruxure Hybrid DCS databases.
The command is available only in either of the following cases:
 The Db folder on the computer on which the system server is installed is either
empty or missing.
 The CACHE.DAT file is missing in the GLOBAL and SCHEMA subfolders and no
System_n system exists in the Db folder.
For more information, refer to the troubleshooting section (see page 175).
Create Blank Lets you back up the mounted database to a location that you select and starts the
Database system server with a blank database (see page 155) after you confirm the command.
You can configure (see page 144) which templates and content are added to the
blank database.
(1) The Migrate Database command is available only when the system server is running.
EIO0000001255 09/2019 149

Command Description
Migrate Database Opens a Save as dialog box, which lets you save the mounted database to disk as
one file (.mdbk).
It lets you create a backup file (see page 71) of a database that you can migrate to
make it compatible with a later version of the software once you have installed it.
The command is visible only once you install a migration patch, which is available
when the later version of the software is released. Refer to the Installation and
Configuration Guide of the later version to determine if you need to use this
command.
NOTE: You cannot restore this backup file (.mdbk) in the same version of the
software. To do so, create a backup file by using the Back Up Database command.
(1) The Migrate Database command is available only when the system server is running.
The table describes the commands of the Settings menu.
Command Description
Basic Opens the Server Configuration Wizard window (see page 113), which lets you
configure settings of the system server and its virtual machine.
Advanced Gives access to advanced parameters of the system server, virtual machine,
client/server communication, and database that can be adjusted if you experience
difficulties running the software.
The command is available only after you enable the console command prompt
(see page 151).
NOTE: Modifying default settings may have a negative impact on software
functionality. Contact EcoStruxure Hybrid DCS support before modifying settings.
The table describes the commands of the Help menu.
Command Description
View Help Opens the global HTML software help.
About Opens the About EcoStruxure Hybrid DCS dialog box (see EcoStruxure™
The table describes the commands of the User menu.
Command Description
Lock Locks (see EcoStruxure™ Hybrid DCS, User Guide) the components where you
logged in on the local computer.
User Information Opens the User Information dialog box (see page 90).
Log In/Log Out Lets you log in or out (see EcoStruxure™ Hybrid DCS, User Guide) of the software.
150 EIO0000001255 09/2019

Enabling the Console Command Prompt

Enabling the console command prompt gives you access to advanced functionalities and settings.
NOTE: Modifying advanced settings may have a negative impact on software functionality. Contact
EcoStruxure Hybrid DCS support before modifying settings.
To enable the console command prompt, proceed as follows.
Step Action
1 Open the system server console.
2 Press Ctrl+M and enter support@Pes2016 (case sensitive).
3 Press Enter.
Result: Entering maintenance mode is displayed in the console and the command prompt is
enabled.
NOTE:
 If you enter a wrong password, repeat step 2.
 To disable the command prompt, press Ctrl+M again.
EIO0000001255 09/2019 151

Backing Up and Restoring Databases
Overview
Data of systems that you create is stored in the database. It also contains the templates of the
Global Templates library.
You can back up a database as a file (.dbk) and restore a database from such a backup file by
using the corresponding commands in the system server console menu bar (see page 148).
Database backup files can only be used with the version of the software that was used to create
them.
Exceptions apply for certain supported versions of databases that you can restore to migrate them
to the current version. This may be the case, for example, for additional releases within the same
year (versions with R• suffix) or when Participants are compatible from one version to the other.
NOTE: You can also back up and restore individual systems by using the corresponding
commands from the context menu in the Systems Explorer of the engineering client
(see EcoStruxure™ Hybrid DCS, User Guide). A system backup contains less data than a
database backup (for example, it does not contain templates) and is version dependent.
Backing Up and Restoring Databases for Migration

To create a database backup file of the current version of the software in order to migrate and reuse
it in a later version, you may need to use the Migrate Database command (see page 149).
Control Project Password Management After Restoring a Database

After you restore a database that contains a controller and/or a station node for which password
protection (see EcoStruxure™ Hybrid DCS, User Guide) has been enabled, you need to do the
following to be able to deploy a Control Participant project:
 If no password was set, you need to set one.
 If a password was set, you need to enter the password when prompted.
For more information, refer to the topic describing how to manage passwords for Control
Participant projects (see EcoStruxure™ Hybrid DCS, User Guide).
Managing Database Backup Files

Database backup files that the software creates when you restore databases can use up a lot of
disk space. Manage these folders regularly to recover disk space.
152 EIO0000001255 09/2019

Backing Up a Database
You can back up databases only when the system server is stopped.
NOTICE
To back up the EcoStruxure Hybrid DCS database, proceed as follows.
Step Action
1 Quit any clients that connect to the system server whose database you want to back up
3 Close and reopen the system server console if required.
4 From the system server console menu bar, click Database → Back Up Database.
Result: A Save as dialog box opens.
5 Select a file name and location for the database backup and click Save.
Result: The software starts the back-up process and displays Done in the system server console
when the operation is completed.
Restoring a Database
When you restore a database, the software creates a copy of the existing database folder before
mounting the new database.
The name of the database folder copy is created by adding the suffix _YYYYMMDDHHMMSS to the
name of the database folder, where YYYYMMDD represents the date and HHMMSS the time when the
copy was created.
The copy of the database folder is stored at the path:
C:\ProgramData\Schneider Electric\Hybrid DCS x, where x corresponds to the major version that
you are using (the R• version suffix does not appear).
You can restore databases only when the system server is stopped.
NOTICE
EIO0000001255 09/2019 153

To restore a EcoStruxure Hybrid DCS database, proceed as follows.
Step Action
1 Quit any clients that connect to the system server (see EcoStruxure™ Hybrid DCS, User Guide).
3 Close and reopen the system server console if required.
4 From the system server console menu bar, click Database → Restore Database.
Result: An Open dialog box opens.
5 Select a database backup file (.dbk) and click Open.
Result: The software:
 Creates a copy the existing database.
 Starts the restore process of the selected file.
 Displays Done in the system server console when the database is mounted.
NOTE: If the restore operation does not complete successfully, the software restores the
previously mounted database.
154 EIO0000001255 09/2019

Starting With a Blank Database
Starting With a Blank Database

At any point in time, you can start fresh with a blank database, which can contain the latest
templates provided with the software version, and/or your templates, or no templates at all.
Configuring the Content of the Database

When you start the system server and a blank database is created, the templates and content
containers that are specified in the Data Folders section (see page 144) of the system server
configuration wizard are added to this database.
Methods to Create a Blank Database

The table describes the method that you need to use to create a blank database for various
scenarios.
Scenario Method
Software is installed for the first time and system server has not yet Starting the system server creates a
been started. blank database (see page 44).
Software has been upgraded to a next major version and no
database has been restored.
Software has been upgraded to an intermediate version (Rx) and Use the Create Blank Database
system server has not yet been started. command (see page 149) and start
Any scenario where a database is already mounted. The database the system server.
may have been migrated and/or contains systems that you have
created.
EIO0000001255 09/2019 155

Starting the System Server
Overview
From the System Server console (see page 148), before starting the system server for the first
time, you need to configure (see page 82) server settings and the virtual machine (VM) if you have
installed it.
Start the system server before starting clients.
A first system server start may take several minutes because it:
 Installs extensions that you have added to the Extensions section of the configuration wizard.
 Starts one instance of the VM.
 Generates the saved states of the VM.
 Imports templates into the Global Templates library and creates the database (this step is not
performed if you are migrating a database).
If starting the system server migrates a database (see page 77), the start-up time is significantly
longer because of the additional steps that the software carries out to migrate it. Depending on the
size of the database, the process may take hours.
Once you start the system server, you cannot stop it until startup is completed.
Refer to Starting and Quitting the Software (see EcoStruxure™ Hybrid DCS, User Guide) for more
information on working with the system server and clients.
NOTE:
Before you can start the system server, you must:
 Activate your EcoStruxure Hybrid DCS licenses on the Floating License Manager.
 Add users to groups (see page 86).
 Generate and install digital certificates (see page 93).
Starting with Default Settings

If you start the system server without using its configuration wizard, default settings are applied to
the VM and server settings.
For information on default settings, refer to the topic describing the configuration of the software
(see page 111).
Server Activity Log

The System Server console lets you monitor and keep track of the server activity until you stop it.
The history of activity data is logged in a log file (see EcoStruxure™ Hybrid DCS, User Guide).
Insufficient Disk Space Notification

When you start the system server, the server console may display a notification about insufficient
free disk space (see page 26).
If this notification appears, try to free some disk space.
156 EIO0000001255 09/2019

Considerations When Using Several System Servers

If a system server and a client are installed on the same computer, the system server cannot start
if the client is already running and connected to different system server. In such case, a message
appears in the server console.
Starting the System Server for the First Time

To start the system server for the first time, proceed as follows.
Step Action
1 Configure (see page 111) the system server and its VM settings as needed.
2 Verify that Caché (see page 68) is running by checking the presence and the color of the Caché
notification area icon. When Caché is running, its notification area icon is blue.
3 From the Windows® start menu, click EcoStruxure Hybrid DCS → System Server.
Result: The log-in window opens.
4 Enter your username without domain or prefix, your password, and click Log In.
Result: The system server console opens.
5 If you want to migrate a database, refer to the topic describing database migration
(see page 77).
Otherwise, proceed to step 6.
6 Click Action → Start.
Result: The system server starts up and creates a new, blank database (see page 144). If you
are upgrading an earlier version and/or have restored a database backup file in the previous
step, the system server migrates this database instead.
NOTE: If you have not activated the software license by using the Floating License Manager,
the system server displays a notification and stops.
7 If before starting the system server, you had entered a Microsoft® Windows® product key in the
configuration wizard to activate the VM, the software attempts to activate it over the Internet or
by using the KMS server. If it is unable to do so, the Microsoft® Select your country or region
dialog box opens. Otherwise, the system server activates the VM in the background and
resumes its startup; proceed to step 10.
NOTE: If you entered a wrong Microsoft® Windows® product key, the VM activation procedure
is not initiated, the system server starts but the VM does not. In such case, open the Server
Configuration Wizard (see page 121), enter the correct product key, and restart the system
server.
8 Select your country or region and click Next.
Result: The Call and provide your installation ID dialog box opens.
NOTE: If you cancel the manual activation process, the VM is not activated. You need to restart
the system server once the initial startup has completed to reinitiate the VM activation procedure.
9 Follow the instructions on screen to complete the manual activation of the VM.
10 Wait until the system server console displays the following message at the bottom of the window
to start the engineering client (see page 159): Server is ready.
EIO0000001255 09/2019 157

Troubleshooting System Server Startup

If you experience difficulties during system server startup, refer to the troubleshooting topic
(see page 171).
158 EIO0000001255 09/2019

Starting the Engineering Client
Overview
Start the system server (see page 156) before starting any client.
Before you start the engineering client for the first time, you need to configure (see page 82) the
server settings and the virtual machine (VM) that the engineering client is using.
The complete start-up of an engineering client may take several minutes if the client uses its own
VM and generates the saved states of the virtual machine (see page 113) and/or installs
extensions (see page 130) locally.
Refer to Starting and Quitting the Software (see EcoStruxure™ Hybrid DCS, User Guide) for more
information on working with the system server and clients.
NOTE: Before you can start the engineering client, you must generate and install digital certificates
(see page 93).
Starting with Default Settings

If you start the engineering client without using its configuration wizard, default parameters are
applied to the System Server and Virtual Machine settings of the VM.
For information on default settings of the VM, refer to the topic describing the configuration of the
software (see page 111).
Client Activity Log

The notification panel lets you monitor and keep track of the engineering client activity until you
stop the system server. To keep the history of data that is displayed in the notification panel, you
need to export the data (see EcoStruxure™ Hybrid DCS, User Guide).
Other client activity is logged in log files (see EcoStruxure™ Hybrid DCS, User Guide).
Insufficient Disk Space Notification

When you start an engineering client and this action starts a VM, the notification panel may display
a notification about insufficient free disk space (see page 26).
If this notification appears, try to free some disk space.
A VM starts when you open the first instance of an engineering client if the client connects to a
remote system server and it is configured to use the local VM.
EIO0000001255 09/2019 159

Starting the Engineering Client

After an unexpected interruption of the client/server connection, the states of both the engineering
client and the system server may have become inconsistent. This can be the case, for example, if
at the time of the interruption an operation was in progress such as an import of several Participant
projects or pasting of many instances.
NOTICE
After an interruption of the client/server connection, verify that the last operation executed by the
software was completed successfully, and if necessary, repeat the last operation.
NOTE: It is recommended to use the notification panel of the engineering client to verify the status
of each task executed through a task menu command. The history of other client-related activity
data is logged in log files (see EcoStruxure™ Hybrid DCS, User Guide).
To start the engineering client for the first time, proceed as follows.
Step Action
1 Configure the server and VM settings as needed by using the configuration wizard.
2 With the system server running, from the Windows® start menu, click EcoStruxure Hybrid DCS →
Engineering Client.
Result: A splash screen appears to indicate that the engineering client is starting. After a few
moments, the log-in window opens.
NOTE: If you are already logged in (see EcoStruxure™ Hybrid DCS, User Guide) to another
EcoStruxure Hybrid DCS on this computer (for example, the system server) the engineering client
window opens without displaying the log-in window.
3 Log in by entering your username without domain or prefix and your password.
NOTE: Close the log-in window to quit the engineering client.
4 Click Log In.
Result: The engineering client window opens and VM-related start-up tasks continue executing.
Information about these tasks is available in the notification panel. You can use the engineering
client in the meantime but Participant services are not available until the VM is fully started.
5 If you have configured the engineering client to use the local VM, selected to use a custom
configuration, and before starting the engineering client, you had entered a Microsoft® Windows®
product key, the software attempts to activate it over the Internet or by using the KMS server. If it is
unable to do so, the Microsoft® Select your country or region dialog box opens. Otherwise, the VM
is activated in the background.
NOTE: If you entered a wrong Microsoft® Windows® product key, the VM activation procedure is
not initiated, the client starts but the VM does not. In such case, open the Engineering Client
Configuration Wizard (see page 121), enter the correct product key, and restart the client.
160 EIO0000001255 09/2019

Step Action
6 Select your country or region and click Next.
Result: The Call and provide your installation ID dialog box opens.
NOTE: If you cancel the manual activation process, the VM is not activated. You need to restart
the client to reinitiate the VM activation procedure.
7 Follow the instructions on screen to complete the manual activation of the VM.
The client starts independently of the VM.
NOTE:
If you start the engineering client:
 Before the system server, the client displays a notification that it cannot locate the server.
 While the system server is still starting up, the splash screen of the client is displayed until the
server is up and running.
EIO0000001255 09/2019 161

162 EIO0000001255 09/2019

Modifying, Repairing, and Removing the Software
EIO0000001255 09/2019
Chapter 10
Overview
This chapter describes how to modify, repair, and remove EcoStruxure Hybrid DCS.

Topic Page
Modifying the Software Installation 164
Repairing the Software 166
Removing the Software 168
EIO0000001255 09/2019 163

Overview
By using the Modify functionality of the installer, you can perform the following actions after you
have installed at least one EcoStruxure Hybrid DCS component on the computer:
 Install one or more additional components (for example, an engineering client).
 Uninstall one or more installed components.
 Change the authentication type and create role groups (see page 86) (only if the system server
is installed or if you select to install it)
You can access the functionality from either:
 The installation package.
 The Uninstall or change a program window of the Microsoft® Windows® Control Panel. Select
the Change command for EcoStruxure Hybrid DCS.
When you remove an installed component, the installer checks the integrity of the files of remaining
components.
NOTE: To remove the software from the computer use the remove functionality (see page 168).
Third-Party Software Components

When you select to install a new software component on the computer, required third-party
components are installed as well. However, when you uninstall a software component, associated
third-party components (see page 45) are not uninstalled.
Software Licenses
When you add and/or remove software components from the computer, verify that you:
 Return licenses that have become unnecessary through the Floating License Manager.
 Activate licenses for newly installed components as needed.
For information on the return process, refer to the Schneider Electric Floating License Manager
user manual.
164 EIO0000001255 09/2019


You can modify the software installation only when the system server is stopped.
NOTICE
NOTICE
LOSS OF DATA
Back up the database before modifying the installation.
NOTE: For more information, refer to the topic describing how to back up the database
(see page 152).
To modify the software installation of a computer by using the installation package, proceed as
follows.
Step Action
1 Quit any clients connected to the system server (see EcoStruxure™ Hybrid DCS, User Guide).
3 Back up the database (see page 152) of the software system infrastructure.
4 On the computer whose installation you want to modify, double-click the setup.exe file that is
located in the root of the installation package.
Result: The installer dialog box opens.
5 Select Modify and click Next.
6 The dialog box shows the different software components that you can install. Those that are
already installed are selected:
 Select the check box of other components that you want to install.
 Clear the check box of installed components that you want to uninstall.
 Do not modify the check box of installed components that you want to keep.
7 Click Next.
Result: The software proceeds with the removal and/or installation of components according to
your selection.
9 Restart the computer when prompted to do so to complete the installation process.
EIO0000001255 09/2019 165

Repairing the Software
Overview
If a software component is not working properly, you may be able to repair it by using the Repair
functionality of the installer.
The installer attempts to fix missing or corrupt files, shortcuts, and registry entries.
On a computer on which the system server is installed, you can also change the authentication
type and create role groups (see page 86).
the Change command for EcoStruxure Hybrid DCS.
NOTE: Third-party components are not repaired. If a third-party component that is required is not
installed (for example, because it has been uninstalled), the installer installs it.
Impact of Repair on the Virtual Machine

When you repair the software, the virtual machine file (.vdi) is replaced if it is present on the
computer. The installed extensions and the virtual machine activation are not impacted. No action
is required.
Repairing the Installation

You can repair an installation only when the system server is stopped.
NOTICE
NOTICE
LOSS OF DATA
Back up the database before repairing the installation.
(see page 152).
166 EIO0000001255 09/2019

To repair the software on a computer by using the installation package, proceed as follows.
Step Action
1 Quit any clients connected to the system server (see EcoStruxure™ Hybrid DCS, User Guide).
3 Back up the database (see page 152) of the software system infrastructure.
4 On the computer on which the component that you want to repair is installed, double-click the
setup.exe file that is located in the root of the installation package.
5 Select Repair and click Next.
Result: The software attempts to repair the installed software components.
7 Restart the computer when prompted to do so to complete the repair process.
EIO0000001255 09/2019 167

Removing the Software
Overview
This operation removes the software from the computer. The database that contains the data of
existing systems is not removed.
Nevertheless, consider backing up existing databases (see page 152).
To remove software components individually, use the modify functionality (see page 164).
A restart is required to complete the process of uninstalling the software from the computer.
NOTE: The process does not remove the Schneider Electric License Manager and Floating
License Manager.
Removing Digital Certificates

Removing the software may delete digital certificates (see page 108).
Removing Third-Party Components

By default, when you remove the software by using the installer or the Change command of the
Microsoft® Windows® Control Panel, the process also removes the following third-party
components if they are installed:
 Oracle® VM Virtualbox, the application managing the virtual machine.
 The virtual machine image file (.vdi).
 Caché, the application managing the database. However, the InterSystems folder is not
removed. You need to remove it manually. The folder is located at the path: C:\Program Files.
Clear the check box to keep these components on the computer.
When you remove the software by using the Uninstall command from the Microsoft® Windows®
Control Panel, these third-party components are not removed.
When you remove the virtual machine, you lose any changes that you have made to it (for example,
updates of the Libset of the Control Participant or installed device type managers (DTMs)).
NOTE: When removing Oracle® VM Virtualbox software, you need to restart the computer;
otherwise, if you reinstall the software without restarting the computer, it does not install properly.
Removing Hotfixes
You can remove hotfixes that have been applied to the software by using the Uninstall command
from the Microsoft® Windows® Control Panel. Navigate to the View installed updates window
under Programs and Features.
Applied hotfixes are listed in the EcoStruxure Hybrid DCS section.
168 EIO0000001255 09/2019

Backing Up Extensions of the Virtual Machines

When you remove the software from a computer and this operation uninstalls the system server,
extensions that were installed in the virtual machine are automatically backed up (see page 75)
and a log file is created.
These extensions are required if you want to reuse the database in another EcoStruxure
Hybrid DCS infrastructure.
NOTE: Extensions are not backed up if you remove only the system server by modifying the
software installation (see page 164) on a computer.
Removing to Install an Earlier Version of the Software

If you are removing the software to install an earlier version, you need to also remove these third-
party components (see page 168):
 Remove the InterSystems Caché and Oracle® VM Virtualbox applications.
 Delete the InterSystems folder, which is located at the path: C:\Program Files.
Returning Licenses
When you remove the software from the computer, consider returning your licenses through the
Floating License Manager so that you may activate them again on a different computer.
For information on the return process, refer to the Schneider Electric Floating License Manager
user manual.
Removing EcoStruxure Hybrid DCS

You can remove the software only when the system server is stopped.
NOTICE
NOTICE
LOSS OF DATA
Back up the database before removing the software.
(see page 152).
EIO0000001255 09/2019 169

The table describes the procedure to remove the software from the computer by using the
installation package.
Step Action
1 Quit Schneider Electric applications that are running, clients, and stop the system server
2 Back up the database (see page 152).
3 On the computer on which the component that you want to remove is installed, double-click the
Setup.exe file located in the root of the installation package.
4 Click Next.
5 Select Remove.
8 Restart the computer when prompted to do so to complete the removal process.
NOTE: You can click No to restart the computer yourself later. However, a restart of the
computer is required before you start a new installation of EcoStruxure Hybrid DCS.
170 EIO0000001255 09/2019

Troubleshooting
EIO0000001255 09/2019
Chapter 11
Troubleshooting
Troubleshooting
Overview
This chapter contains various troubleshooting information.

Topic Page
Troubleshooting Installation 172
Troubleshooting the System Server 174
Troubleshooting the Virtual Machine 175
Troubleshooting Client/Server Communication 178
Troubleshooting USB Port Issues 179
Troubleshooting the Caché Database 182
EIO0000001255 09/2019 171

Troubleshooting
Troubleshooting Installation
Invalid Drive Notification During Installation

When you copy the installation package (ISO file) from the external hard drive to the computer and
start the installation from the computer when the copy is complete, you may receive a notification
about an invalid drive (1327) if you disconnect the external hard drive before the installation is
finished.
Restart the installation and leave the external hard drive connected to the computer until the
installation of the software is finished.
Notification During Installation of the Virtual Machine

The virtual machine file (.vdi) is included in the installation package as an archive file (.7z).
If the virtual machine file cannot be extracted during installation, the software displays a message
and cancels the installation. This may happen, for example, if the installation package got
corrupted during download.
In such case, you can verify the integrity of the installation package by using an MD5 checksum.
Follow the procedure that is available at www.pes.schneider-electric.com, Product Downloads
section.
Installation Does Not Complete

Verify that the path to any file of the installation package does not exceed 260 characters, whether
you are accessing it on the local computer or from a network location.
Unable to Uninstall the Software by Using the Control Panel

If you are trying to remove the software by using the Uninstall command in the
Microsoft® Windows® Control Panel and you receive a notification that the software cannot be
uninstalled because the installation log file cannot be opened, proceed as follows.
Step Action
1 Open Task Manager.
2 Stop the explorer.exe process.
3 Restart the explorer.exe process by clicking from the menu of the Task Manager, File → New
Task (Run...).
4 Enter explorer.exe and click OK.
5 Uninstall the software again by using the Uninstall command.
172 EIO0000001255 09/2019

Troubleshooting
Notification During Reinstallation Of the Software

During the reinstallation of the software, a dialog box about InterSystems Caché opens containing
the message Error. CctrlInstallStartCP(STRUXUREWAREPE)failed. Return
value: 1.
Reason: The temporary files in the %TEMP% folder of the computer exceed the limit of 65,535
files. When the installation tries to create new temporary files, it cannot do so because the system
limit of 65,535 files has been reached. Therefore, the installation does not complete successfully
and an unrelated message is reported.
Solution: Delete no longer required files in the %TEMP% folder of the computer before installing
the software.
EIO0000001255 09/2019 173

Troubleshooting
Troubleshooting the System Server
Delay Starting the System Server

If you experience delays of several minutes when starting the system server and you have
configured several Enterprise license servers in the LM, confirm that each IP address can be
reached from the computer on which the system server is installed.
For more information, refer to the topic describing the configuration of Enterprise license servers
System Server Not Starting

The following describes various issues that can prevent the system server from starting.
Cannot load Counter Name data because an invalid index “ ” was read from the registry: If the
system server console displays this message shortly after starting the server, proceed as follows.
Step Action
1 Open a command prompt as administrator.
2 Change to C:\Windows\SysWOW64
3 Execute lodctr /r
4 Press Enter.
NOTE: You may see a message about a detected error: Unable to rebuild performance counter
setting from system backup restore, error code is 2
5 Restart the system server.
Callin.CallinException: Failure: If the system server console displays this message shortly after
starting the server, you may be running the system server on a computer whose CPU has more
than 16 cores. This hardware configuration conflicts with the license of the Caché database, which
is included with EcoStruxure Hybrid DCS and supports only 16 CPU cores or less.
In such case, to be able to start the system server, you have the following options:
 Restrict the number of processors (cores) that the operating system can use in the Boot tab of
the Windows® System Configuration.
 Contact Schneider Electric technical support (see page 8) to obtain a license for the database,
which supports more than 16 cores. Conditions apply.
174 EIO0000001255 09/2019

Troubleshooting
Troubleshooting the Virtual Machine
Virtual Machine Password Protection

During startup of the system server, a message appears in the server console with orange text
informing you of a VM password mismatch.
The VM will restart automatically, up to three times, which resolves the password mismatch.
The password mismatch happens in the following situation:
1. A system server and an engineering client are installed on computer A.
2. A system server is installed on computer B.
3. The engineering client of computer A is connected to the remote system server on computer B.
4. On computer A, you close the engineering client and start the local system server.
However, if the message still appears after three restarts or, if in any other situation, the virtual
machine of the system server or a client is not starting and the server console or the client
notification panel displays either of the following messages, contact EcoStruxure Hybrid DCS
support for assistance:
 Password not matching
 Invalid length for a base-64 char array or string
 Bad credentials
Troubleshooting Virtual Machine Startup Difficulties Related to Database

If the software displays notifications about the virtual machine not starting, you may have deleted
the Db folder or all or part of its contents on the computer on which the system server is installed.
Notifications appear in:
 The system server console with text in red.
 The notification panel.
The Db folder contains the files of databases where the software stores data of the Global
Templates library and of existing systems. The default path to the Db folder is
C:\ProgramData\Schneider Electric\Hybrid DCS x, where x corresponds to the major version that
you are using (the R• version suffix does not appear).
EIO0000001255 09/2019 175

Troubleshooting
The figure shows an example of the contents of the Db folder for a healthy database with two
systems created. The right-hand section of the window shows the CACHE.DAT file that exists in
the GLOBAL and SCHEMA subfolders.
NOTE: Systems that appear in the Db folder keep their default name (System_n) even if you
rename them in the Systems Explorer.
Deleting the Db folder or some of its contents creates an inconsistency with the database entries
that exist in the Caché database.
In such case, you need to remove the Caché database entries pertaining to the installed databases
to make them consistent with the file structure on the computer.
To remove Caché database entries, proceed as follows.
Step Action
1 In the system server console menu bar (see page 149), click Database → Delete database.
Result: The Delete Database dialog box opens.
2 Click Yes.
Result: The software removes Caché database entries.
NOTE: Click No to close the Delete Database dialog box without removing Caché database
entries.
3 Wait until the console displays Done to start the system server.
176 EIO0000001255 09/2019

Troubleshooting
Virtual Machine Startup Difficulties Related to Missing Directory

The system server displays a notification about a missing directory during startup if the following
conditions apply:
 You are using an operating system configured in a language other than English.
 The username of the logged-in user contains characters that are not part of the US-ASCII
character table.
Use only a username that contains characters of the US-ASCII character table to log in to the
operating system of computers on which the system server and engineering clients are installed.
Virtual Machine Startup Difficulties After Upgrading the Software

The VM of the system server and/or engineering client may not start if you had not deleted a file
used by the VM of the earlier version before upgrading it.
Deleting the folder containing the file (see page 60) allows the VM to start when you restart the
system server.
EIO0000001255 09/2019 177

Troubleshooting
Troubleshooting Client/Server Communication
CPU-Intensive Operations
Performing CPU-intensive operations (for example, importing many instances or mapping many
interfaces) by using a client on a computer on which the system server is installed may lead to CPU
starvation.
As a result, actions that you execute immediately after such CPU-intensive tasks may trigger
notifications about client/server communication interruptions.
Increase the priority of the EngineeringClient.exe or OperationClient.exe process to Above
Normal by using the Details tab of the Windows® Task Manager.
Network Connections
The system server and its engineering stations need to be connected to the same Ethernet network
by a cable connection so that the system server, engineering, and operation clients are able to
communicate. This can be a network that is dedicated to client/server communication.
In case the computer on which the system server is installed is connected also to another network
(for example, an enterprise network providing access to the Internet), verify that an interruption of
this network connection does not block communication on the client/server network. This may
happen, for example, if a domain firewall is configured to disable all communication ports of the
computer in case the connection to the enterprise network is interrupted.
Negative Connection Test Result

A button to test the client/server connection is located in the System Server section of the client
configuration wizards (see page 112).
If the result of the connection test is negative, verify the following:
 The validity of the digital certificates (see page 93).
 The port configuration (see page 117).
Communication Port Usage

The software uses communication ports for client/server communication. If you experience
communication difficulties, verify if any of them are already used.
Refer to the topic describing how to configure the system server and clients (see page 117).
178 EIO0000001255 09/2019

Troubleshooting
Troubleshooting USB Port Issues
Problem Description
When you connect a USB drive to a computer on which the system server and/or engineering client
is running, you may experience one or more of the following issues:
 You cannot eject the USB drive.
 The USB port stops responding.
 The computer does not hibernate anymore.
 The computer does not shut down anymore.
 The Microsoft® Windows® blue screen.
This is because the USB port monitoring service of the Oracle® VM Virtualbox application, the
third-party software managing the virtual machine (VM) of the software, does not release the USB
port of the computer.
Recommendation
To transfer files between the host computer and the VM of the system server and/or the
engineering client, use the user-configurable folder that is shared with the VM (see page 120)
rather than USB drives.
Using USB Drives on Computers of the EcoStruxure Hybrid DCS Infrastructure

If you still need to use USB drives on the computer on which the system server and/or engineering
client is installed, two files are provided:
 VBoxUSBMonitorDisable.reg: The file modifies registry settings to disable the USB port
monitoring service of the Oracle® VM Virtualbox application. This allows you to use USB drives
on the computer while the system server and/or engineering client is running. However, USB
drives are not recognized anymore by VMs run by the Oracle® VM Virtualbox application.
 VBoxUSBMonitorEnable.reg: The file reverts registry settings to their original values to enable
the USB port monitoring service of the Oracle® VM Virtualbox application if you had disabled it.
This allows VMs run by the Oracle® VM Virtualbox application to recognize USB drives. Enable
the USB port monitoring service and use USB drives only when the system server and/or
engineering client is not running.
NOTE: Disable or enable USB port monitoring before connecting a USB drive to the computer.
Location of the Registry Entries Files

The registry entries (.reg) files are located in the VboxUSBMonitor folder, which is in the root of the
software installation package.
EIO0000001255 09/2019 179

Troubleshooting
Disabling USB Port Monitoring

To disable the USB port monitoring service of the Oracle® VM Virtualbox application, you need to
stop the system server.
NOTICE
To disable the USB port monitoring service of the Oracle® VM Virtualbox application, proceed as
follows.
Step Action
1 Close engineering clients and the system server they connect to.
2 Restart the computer.
3 Copy the VBoxUSBMonitorDisable.reg file to the computer on which you want to use USB
drives.
4 Double-click the VBoxUSBMonitorDisable.reg file.
Result: The Registry Editor dialog box opens.
5 Click Yes.
Result: The USB port monitoring service of the Oracle® VM Virtualbox application is disabled.
180 EIO0000001255 09/2019

Troubleshooting
Enabling USB Port Monitoring

To enable the USB port monitoring service of the Oracle® VM Virtualbox application, you need to
stop the system server.
NOTICE
To enable the USB port monitoring service of Oracle® VM Virtualbox, proceed as follows.
Step Action
1 Close engineering clients and the system server they connect to.
2 Restart the computer.
3 Copy the VBoxUSBMonitorEnable.reg file to the computer on which you want to use USB
drives.
4 Double-click the VBoxUSBMonitorEnable.reg file.
Result: The Registry Editor dialog box opens.
5 Click Yes.
Result: The USB port monitoring service of the Oracle® VM Virtualbox application is enabled.
EIO0000001255 09/2019 181

Troubleshooting
Troubleshooting the Caché Database
Problem Description
The Caché database does not start if you have changed the name of the computer while Caché
was running and have restarted the computer. The Caché icon in the notification area of
Microsoft® Windows® remains gray.
Attempting to start the Caché database manually opens a dialog box Cache Terminal could not
start (112).
Caché software stores the name of the computer in temporary files. When it starts, it compares the
name of the computer with the name stored in the files. If they do not match, the Caché database
does not start.
Recommendation
To change the name of the computer on which the Caché application is installed, first stop the
Caché application (see page 68).
Starting Caché
To get the Caché database to start again, proceed as follows.
Step Action
1 Browse to C:\Program Files\InterSystems\STRUXUREWAREPEv44\mgr.
2 Delete the following files:
 cache.ids
 cache.lck
3 Start the Caché (see page 69) database.
182 EIO0000001255 09/2019

EIO0000001255 09/2019
Appendices
What Is in This Appendix?

The appendix contains the following chapters:
Chapter Chapter Name Page
A Installing the Floating License Manager 185
B Installation of DTMs by Using a Response File 187
EIO0000001255 09/2019 183

184 EIO0000001255 09/2019
Installing the Floating License Manager
EIO0000001255 09/2019
Appendix A
Overview
This topic describes how to install the Floating License Manager (FLM) on a computer that is to
become an enterprise license server and on which no EcoStruxure Hybrid DCS nor Supervision
components are going to be installed.
For more information on how to use the FLM, refer to the topic describing licensing mechanisms
Installation Procedure
Step Action
1 Double-click the FloatingLicenseManagerSetup_PE.exe file to extract the installation files.
The file is located inside the LicenseManagers folder of the EcoStruxure Hybrid DCS installation
package.
2 Select a destination folder on the computer on which you want to install the FLM.
3 In this destination folder, double-click the setup.exe file to start the installation.
NOTE:
Use the following values to configure parameters of the FLM (see EcoStruxure™ Hybrid DCS,
Licensing Guide):
 Web Port: 8090
 License Server Port: 27011
 Vendor Daemon Port: 27010
NOTE: To obtain the server port value that is used by an FLM after installation, refer to the topic
describing how to verify the license server, vendor daemon, and Web port settings of the FLM
EIO0000001255 09/2019 185

186 EIO0000001255 09/2019

Installation of DTMs by Using a Response File
EIO0000001255 09/2019
Appendix B
Installing DTMs by Using a Response File
Overview
Use this procedure when the installation of a DTM in the Control Participant of the VM did not
succeed because the installation process does not generate the necessary log file (see page 131)
(silent and manual installation modes).
In this case, the use of a response file (setup.iss) allows completing the installation. The response
file records user entries and installation settings that are made during a temporary manual
installation from within the VM.
The response file is generated by installing the DTM on any computer running a Windows®
operating system. This is the only purpose of this installation, which can be removed once the
response file has been retrieved.
The file is then copied from where it was generated and added to the installation package of the
DTM to be used during a silent installation with the help of a batch file (.bat).
Copying the DTM Installation Files to a Folder
Step Action
1 On the computer on which the system server is installed, create a folder that you will be
accessing from the VM.
2 Copy the DTM installation files (.exe and any other required files) to this folder so that the
installation can be started from within the VM.
EIO0000001255 09/2019 187

Generating the Setup.iss Response File

To generate the response file that you are going to include later on in the batch file, proceed as
follows.
Step Action
1 Copy the DTM installation file to the C: drive of the computer on which you can perform the
installation (for example, the computer running the system server).
2 Open a command prompt.
3 In the command prompt, type cd.. and press Enter until you are the C:\> prompt.
188 EIO0000001255 09/2019

Step Action
4 Execute the DTM installation file with the /r option in order to generate the InstallShield response
file.
Result: The DTM installation starts.
The following example shows the SMARTSENS_PH_DTM_V1-1-3_Setup.exe DTM installation file,
which is executed from the command prompt with the /r option.
Your entries and settings are recorded in the response file.
5 Follow the steps on screen until the installation of the DTM is complete.
Result: The setup.iss response file is generated at the path C:\Windows.
EIO0000001255 09/2019 189

Installing the DTM

To install the DTM by using the response file, proceed as follows.
Step Action
1 Confirm that the system server is closed.
2 Locate the VM Extensions folder in the EcoStruxure Hybrid DCS installation package (.iso) and
copy the InstallGsd subfolder to the computer on which the system server is installed.
3 Open the InstallGsd folder and delete the UpdateDtm.exe, which is not required.
4 Copy the uncompressed DTM installation file (.exe) and the response file (setup.iss) to the
InstallGsd folder.
5 Edit the Execute.bat file inside the InstallGsd folder as follows.
@Echo off
echo installing DTM...
setup.exe /s
echo Done
Where setup.exe is the name of the DTM installation file.
(Remove the UpdateDtm.exe command.)
NOTE: The /s option installs the DTM in silent mode by using the data and installation settings
contained in the response file.
6 Save the changes to the Execute.bat file.
NOTE: If you want to install several DTMs, create the other entries (setup.exe /s) in the
Execute.bat file and copy all the installation files and response files to the InstallGsd folder. You
can create subfolders inside the InstallGsd folder.
7 Open the Extensions section of the System Server Configuration Wizard.
8 Open the Browse for extension dialog box, browse to the InstallGsd folder, and select the
Execute.bat file.
9 Refer to the topic describing the installation of extensions in manual mode (see page 136) to
complete the procedure.
190 EIO0000001255 09/2019

Index
EIO0000001255 09/2019
Index
Symbols issues, 175

BIOS
.NET Framework requirements
settings for virtual machines, 38
Windows 10, 50
blank databases
Windows Server 2012, 50
starting with a blank database, 155
0-9 C
32-bit databases
Cache
reusing, 61
installed software components, 45
32-bit Process Expert
starting and stopping, 68
upgrading a 32-bit system infrastructure,
third-party software components, 43
60
troubleshooting Cache not starting, 182
7-zip
certificate generator
unzipping the installation package, 41
generating and installing digital certifi-
cates, 93
A certificates
expiration notification for entity certifi-
access control cates, 104
setting up RBAC, 85 generating and installing digital certifi-
activating cates, 93
virtual machine, 143 uninstalling digital certificates, 93
activation Citect SCADA
using configuration wizards, 112 installation requirements, 42
adding installing supervision software, 55
adding a software component, 164 upgrading supervision software, 60
architectures client configuration wizards
client/server communication interrup- activating virtual machines, 143
tions, 31 configuring virtual machines, 120
physical architectures, 29 clients
physical VM architecture examples, 32 configuring clients, 117
software architecture, 16 configuring server settings, 119
authentication connecting a client to different system
role-based access control, 85 servers, 142
engineering client activity logs, 159
starting engineering clients, 159
B communication interruptions
backing up client/server communication interrup-
databases, 152 tions, 31
bad credentials performance considerations, 31
troubleshooting virtual machine password troubleshooting, 178
EIO0000001255 09/2019 191

Index
communication ports database restoration

settings and configuration, 117 password information and settings, 152
troubleshooting, 178 databases
computers backing up, 152
hardware requirements, 38 contents of blank databases, 144
configuration wizards migrating the database, 70
activating virtual machines, 143 migrating to the current version, 77
parameters, 121 overview of installation scenarios, 44
user accounts, 112 preparing databases for migration, 71
using configuration wizards, 112 removing database of an earlier version,
configuring 61
clients, 117 restoring, 152
system servers, 117 restoring a new database, 152
using configuration wizards, 112 reusing, 61
connections reusing 32-bit databases, 61
network connections of servers and sta- starting and stopping Cache, 68
tions, 29 starting with a blank database, 155
troubleshooting client-server connec- troubleshooting Cache not starting, 182
tions, 178 troubleshooting database inconsisten-
console cies, 175
system server console, 148 Delete Database
constraints system server console commands, 148
firewall exceptions, 50 troubleshooting database inconsisten-
content cies, 175
selecting content of blank databases, 144 DFBs and DDTs
Control Expert updated types supplied in the release, 65
control Participant rebranding, 62 digital licenses
installation path in the VM, 62 activating virtual machines, 143
installation requirements, 42 disk space
installing control Participant hotfixes, 141 free space requirement for virtual ma-
installing control resources, 140 chines, 26
Control Panel domain
troubleshooting when uninstalling, 172 authentication in RBAC, 85
control Participant DTMs
impact of rebranding on patches, 62 installing and removing, 130
Controller Simulator installing DTMs with a response file, 187
installing, 51
E
D EDS files
Data Folders section installing and removing, 130
System Server Configuration Wizard, 144 engineering clients
Database menu engineering client activity logs, 159
system server console menu bar, 148 starting, 159
192 EIO0000001255 09/2019

Index
expiration notification Hybrid DCS

expiration notification for entity certifi- generating and installing digital certifi-
cates, 104 cates, 93
extensions physical architecture examples, 32
connecting a client to different system physical architectures, 29
servers, 142 software architecture, 16
installing DTMs with a response file, 187 hypervisors
re-installing extensions before migration, compatibility with virtual machines, 20
75
Extensions section
installing and removing extensions in the I
VM, 130 installation
installing control resources, 140 general installation information, 44
installation log files, 48
F modifying the installation, 164
files overview of installation scenarios, 44
sharing with the VM, 121 troubleshooting, 172
firewall unable to extract the VM file, 172
firewall exceptions for Hybrid DCS, 50 upgrade installation procedure, 82
Floating License Manager installation files
installed software components, 45 opening, 41
installing, 185 installation requirements
license server port setting, 47 hardware, 38
installing Control Expert, 42
operating systems, 40
G other software requirements, 42
Global Templates supervision software requirements, 42
supplied with Hybrid DCS upgrades, 64 installing
groups first-time installation, 54
setting up role-based access control, 85 Floating License Manager, 185
GSD files installing an earlier software version, 169
installing and removing, 130 removing applied hotfixes, 168
supervision software, 55
virtual machines, 20
H Internet connection
hardware virtual machine internet connection, 20
hardware requirements, 38 invalid drive
host computer troubleshooting installation, 172
sharing files with the VM, 121 invalid length message
hosting troubleshooting virtual machine password
system server configuration wizard, 118 issues, 175
hotfixes ISO installation package
installing control Participant hotfixes, 141 opening, 41
removing applied hotfixes, 168 verifying integrity of ISO file, 172
EIO0000001255 09/2019 193

Index
ItemName property login

availability after database migration, 81 role-based access control, 85
K M
keyboard layouts memory
configuration wizard for virtual machines, memory allocated to the VM, 20
121 Migrate Database
system server console commands, 148
migrating
L databases, 70
languages migrating databases
default keyboard layout of virtual ma- 32-bit migration process overview, 61
chines, 121 database migration log files, 78
user interface language, 45 database premigration log files, 71
Last Action Summary impact on system data, 79
availability after database migration, 81 migrating databases to the current ver-
libraries sion, 77
installing in the control Participant, 140 migration process overview, 61
libraries supplied with Hybrid DCS up- new feature availability after migrating, 79
grades, 64 preparing databases for migration, 71
License Manager re-installing extensions, 75
installed software components, 45 missing directory
license server port setting, 47 troubleshooting virtual machine startup,
license server port 177
licensing software installation, 47 modifying the installation
licensing licensing considerations, 164
considerations for virtual machines, 27 mounting databases
installing the Floating License Manager, restoring, 152
185
requirements when upgrading, 63
using configuration wizards, 112 N
VM licensing examples, 32 network connections
licensing software virtual machine network connections, 20
license server port setting, 47 networks
locking network connection examples, 32
Lock command (system server), 148 network connections of servers and sta-
log files tions, 29
database migration log files, 78 troubleshooting client-server connec-
database premigration log files, 71 tions, 178
engineering client activity log files, 159 new features
extension backup log files, 75 availability in migrated databases, 79
installation log files, 48
system server activity log files, 156
194 EIO0000001255 09/2019

Index
O R
operating systems RBAC
operating system requirements, 40 setting up role based access control, 85
Oracle VM VirtualBox removing
third-party software components, 43 before installing an earlier software ver-
sion, 169
Hybrid DCS, 168
P removing a software component, 164
passwords removing applied hotfixes, 168
default simulator password, 51 repairing
password information and settings when Hybrid DCS, 166
restoring databases, 152 requirements
troubleshooting virtual machine password installing Control Expert, 42
issues, 175 response files
patches installing DTMs with a response file, 187
impact of Control Participant rebranding, Restore Database
62 system server console commands, 148,
performance 148
virtual machine installation recommenda- restoring
tions, 20 databases, 152
performance considerations password information and settings when
client/server communication interrup- restoring databases, 152
tions, 31 restoring a new database, 152
permissions role-based access control
setting up role-based access control, 85 setting up RBAC, 85
physical architectures roles
description, 29 role-based access control, 85
PKI root certificates
generating and installing digital certifi- generating and installing digital certifi-
cates, 93 cates, 93
PLC Simulator
installing, 51
ports S
client configuration wizard, 119 saving files
client VM communication ports, 119 sharing files with the VM, 121
server VM communication ports, 119 security
settings and configuration of communica- setting up role-based access control, 85
tion ports, 117 Security section
system server port configuration, 118 generating and installing digital certifi-
troubleshooting communication ports, cates, 93
178
premigration
preparing databases for migration, 71
project indicators
availability after database migration, 81
EIO0000001255 09/2019 195

Index
server supervision software

configuring the system server, 117 installing, 55
server address for clients, 119 upgrading supervision software, 60
starting the system server, 156 system locale
system server activity logs, 156 configuration wizard for virtual machines,
troubleshooting system server not start- 121
ing, 174 system server
troubleshooting system server startup de- configuring the system server, 117
lay, 174 console, 148
server configuration wizard console menu, 148
installing DTMs with a response file, 187 starting the system server, 156
server extensions system server activity logs, 156
connecting a client to different system troubleshooting server not starting, 174
servers, 142 troubleshooting system server startup de-
server port lay, 174
licensing software installation, 47 system server configuration wizard
Settings menu activating virtual machines, 143
system server console menu bar, 148 configuring virtual machines, 120
setup.iss contents of blank databases, 144
installing DTMs with a response file, 187 hosting, 118
shared folders installing and removing extensions in the
configuring the VM shared folder, 121 VM, 130
sharing files
sharing with the VM, 121
simulator T
default simulator password, 51 templates
default STA file for simulator, 51 overview of installation scenarios, 44
installing the PLC Simulator, 51 selecting templates of blank databases,
slots 144
for Participant services, 20 templates supplied as export files, 64
software time zones
installed software components, 45 changing the time zone of the virtual ma-
licensing software installation, 47 chine, 141
software requirements, 41 virtual machine time zone, 26
software architectures troubleshooting
description, 16 client/server communication interrup-
STA file
default STA file for simulator, 51
starting
engineering clients, 159
system server, 156
troubleshooting system server, 174
starting fresh
restoring a new database, 152
196 EIO0000001255 09/2019

Index
tions, 178 USB

communication ports, 178 troubleshooting USB port issues, 179
database inconsistencies, 175 user accounts
installation does not complete, 172 using configuration wizards, 112
installation issues, 172 user interface
system server not starting, 174 user interface language, 45
system server startup delay, 174 users
troubleshooting Cache not starting, 182 role-based access control, 85
troubleshooting USB port issues, 179
unable to extract the VM file, 172
virtual machine password issues, 175 V
virtual machine startup, 175, 177 vdi file
types verifying integrity with checksum, 172
updated DFBs and DDTs supplied in the version
release, 65 client/server compatibility, 82
Hybrid DCS component version, 82
installing an earlier software version, 169
U updating third-party software compo-
uninstalling nents, 43
Hybrid DCS, 168 virtual machine
modifying the installation, 164 activating, 121, 143
troubleshooting, 172 changing the time zone of the virtual ma-
uninstalling digital certificates, 93 chine, 141
unzipping client communication ports, 119
unzipping the installation package, 41 configuring the VM shared folder, 121
updating default time zone, 26
DFBs supplied as XDB files, 64 free disk space requirements, 26
Global Templates supplied as export files, installation recommendations, 20
64 licensing considerations, 27
third-party software components, 43 network connections, 20
upgrading performance considerations, 20
licensing requirements, 63 re-installing extensions before migration,
upgrading a 32-bit system infrastructure, 75
60 replacing during installation, 48
upgrading supervision software, 60 server communication ports, 119
user accounts when upgrading EcoStrux- sharing files with the VM, 121
ure Hybrid DCS, 60 troubleshooting virtual machine password
upgrading Process Expert issues, 175
general information, 58 troubleshooting virtual machine startup,
migrating the database, 70 175, 177
user accounts when upgrading Process unable to extract the VM file, 172
Expert, 60 user accounts when upgrading EcoStrux-
upgrading the software ure Hybrid DCS, 60
installation procedure, 82 user accounts when upgrading Process
EIO0000001255 09/2019 197

Index
Expert, 60
using configuration wizards, 112
VirtualBox
third-party software components, 43
VM
changing the time zone of the virtual ma-
chine, 141
default time zone, 26
memory allocated to the VM, 20
unable to extract the VM file, 172
W
Windows 10
.NET Framework requirements, 50
Windows Server 2012
.NET Framework requirements, 50
wizards
using configuration wizards, 112
X
XDB files
updated types supplied in the release, 65
Z
zip utility
unzipping the installation package, 41
198 EIO0000001255 09/2019

EcoStruxure Hybrid DCS Installation and Configuration Guide - Eng - EIO0000001255.12

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

EcoStruxure Hybrid DCS Installation and Configuration Guide - Eng - EIO0000001255.12

Uploaded by

Copyright:

Available Formats

EcoStruxure™ Hybrid DCS

EcoStruxure™ Hybrid DCS

Title of documentation Reference number

You can download these technical publications at app.schneider-electric.com/ecostruxure-hybrid-

What Is in This Chapter?

First Installation or Upgrade of Process Expert 4.3/SP1

Prerequisites to Migrate a Database

Upgrading EcoStruxure Hybrid DCS 2018 or 2018 R2

Prerequisites to Migrate a Database

EcoStruxure Hybrid DCS System Infrastructure

What Is in This Chapter?

Supervision Software Components

Virtual Machine Usage

Virtual Machine Network Connection

Virtual Machine Performance

Software Participant Sessions

Software Participant Number of slots per VM instance

Virtual Machine Instances and Sessions

Sharing the slots of a VM instance is only possible when:

Virtual Machine Usage by Software Component

Virtual Machine Usage Recommendations

Insufficient Free Disk Space Notification

Virtual Machine Time Zone

Virtual Machine Licensing Considerations

Virtual Machine Licensing Principles

Determining License Needs

The operation client is configured to use the VM of the system server.

License type Description Operating system of the Activation method

Activating Licenses for VMs

Physical Architecture Description

Role of the computer Number of Description computer connected to

The following figure shows an example of a physical architecture running EcoStruxure

Physical Architecture Examples

NOTE: Up to four instances of the VM are available to each user.

System and Installation Requirements

What Is in This Chapter?

CPU Virtualization Settings

System Server Hardware Requirements

Operation Server Hardware Requirements

Engineering Client Hardware Requirements

Operation Client Hardware Requirements

Operating System Requirements

Supported operating systems Recommended for (station role)

You must have administrator rights to install the software.

Role Based Access Control

Opening the Installation Package

Supervision Software Requirements

Control Expert Installation Requirements

Other Software Requirements

Third-Party Components Installed By the Software

License type Software version that is upgraded Required action

General Installation Information

Overview of Installation Scenarios

Software installation Database migration Result

User Interface Language

Installed Software Components

(1) Where X is the software version and Y an alphanumerical revision index.

License Server Port Settings

Software component Parameter Parameter value Comment

Installation Log Files

File name Path Content

Default Destination Folders

Enabling .NET Framework 3.5 for Microsoft® Windows Server® 2012 R2