EcoStruxure™ Process Expert

EIO0000001114 06/2020

EcoStruxure™
Process Expert
User Guide
06/2020
EIO0000001114.14

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.
© 2020 Schneider Electric. All rights reserved.

2 EIO0000001114 06/2020
 Table of Contents

Safety Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Part I Understanding EcoStruxure Process Expert . . . . . . 19
Chapter 1 General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Terminology Used in This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Chapter 2 Introducing EcoStruxure Process Expert . . . . . . . . . . . . 23
EcoStruxure Process Expert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
EcoStruxure Process Expert Architecture . . . . . . . . . . . . . . . . . . . . . . 26
Chapter 3 General Concepts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.1 Object Model Concept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Object Based Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Object Template Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Application Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Topological Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Interface Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Instances of Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
3.2 System Engineering Life Cycle Concept . . . . . . . . . . . . . . . . . . . . . . . 40
The System Engineering Life Cycle . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Platform Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Global Templates Definition Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Instantiation Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Project Definition Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Assignment Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Generation Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Refinement Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Configuration Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Mapping Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Build Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Deployment Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Execution Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

EIO0000001114 06/2020 3
 Part II Working with the Software . . . . . . . . . . . . . . . . . . . . 67
Chapter 4 Starting and Quitting System Server and Clients . . . . . . . 69
Logging In and Out of System Server and Clients . . . . . . . . . . . . . . . . 70
Locking and Unlocking the Software . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Starting the System Server Again . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Client/Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Quitting the Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Chapter 5 Multiuser Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Multiuser Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Chapter 6 Action Traceability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Notification Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Activity Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Chapter 7 Software Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Hardware and Software Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Supported Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Naming Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Chapter 8 Using the Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Software Participant Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Using Help for Different Versions of Schneider Electric Templates . . . 105
Help on User-Created Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Chapter 9 User Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Engineering Client User Interface Description . . . . . . . . . . . . . . . . . . . 114
About Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Engineering Client and Explorer Work Areas. . . . . . . . . . . . . . . . . . . . 118
Organizing Work Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Working with Panes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Using Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Software Participant Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Filtering and Sorting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Part III Engineering a System . . . . . . . . . . . . . . . . . . . . . . . 143
Chapter 10 Quick Reference Guides . . . . . . . . . . . . . . . . . . . . . . . . . 145
System Creation Workflow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Task Quick Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

4 EIO0000001114 06/2020
 Chapter 11 Managing Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Organizing Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Creating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Creating System Backups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Restoring Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Chapter 12 Instantiation Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
12.1 Instantiating Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Organizing the System Application . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Application Explorer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Browsing Application Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Using the Application Browser Pane . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Creating Application Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Assigning Icons to Application Folders . . . . . . . . . . . . . . . . . . . . . . . . 193
Creating Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Counting Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Accessing Instance Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Configuring Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
12.2 Instance Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Instance Progress Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Instance Validity Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Instance Write-Lock Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
12.3 Linking Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Links Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Using the Simplified View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Instance Link Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Linking Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Using the RTNS Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Changing the Destination of a Link . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
12.4 Managing Application Folders and Instances . . . . . . . . . . . . . . . . . . . 235
Viewing Instance Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Changing the Application Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Copying and Pasting Application Folders and Instances . . . . . . . . . . 239
Moving Application Folders and Instances . . . . . . . . . . . . . . . . . . . . . 241
Updating and Replacing Templates of Instances . . . . . . . . . . . . . . . . 245
12.5 Exporting and Importing Application Objects to CSV and XML Formats 255
Exporting Folders and Instances to CSV and XML Formats . . . . . . . . 256
CSV Application Export File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Editing the CSV Application Export File . . . . . . . . . . . . . . . . . . . . . . . 263

EIO0000001114 06/2020 5
 XML Application Export File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Editing the XML Application Export File to Manage Folders and
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Editing the XML File to Manage Interface Links. . . . . . . . . . . . . . . . . . 283
Importing a CSV or XML File Into the Application . . . . . . . . . . . . . . . . 287
Chapter 13 Project Definition Stage . . . . . . . . . . . . . . . . . . . . . . . . . . 297
13.1 Project Explorer and Project Browser . . . . . . . . . . . . . . . . . . . . . . . . . 299
Project Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Project Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
13.2 Control Project Definition Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Creating Control Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Creating Control Project Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
13.3 Managing Control Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Control Project Section Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Exporting a Control Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Importing a Control Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Importing a Control Expert Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Managing Data Backup Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
13.4 Supervision Project Definition Stage . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Internal Supervision Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Creating Supervision Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
13.5 Creating Supervision Project Components . . . . . . . . . . . . . . . . . . . . . 343
Creating Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Creating Supervision Servers and Clients . . . . . . . . . . . . . . . . . . . . . . 345
Creating I/O Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Creating Communication Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
Implementing Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
13.6 Managing Supervision Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Exporting a Supervision Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Importing a Supervision Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
13.7 Participant Project Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Participant Project Progress Indicators . . . . . . . . . . . . . . . . . . . . . . . . 376
Participant Project Validity Indicators. . . . . . . . . . . . . . . . . . . . . . . . . . 378
Participant Project Write-Lock Indicator . . . . . . . . . . . . . . . . . . . . . . . . 380
Viewing the Last Action Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381

6 EIO0000001114 06/2020
 Chapter 14 Assignment Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
14.1 Creating and Managing Sections and Containers . . . . . . . . . . . . . . . . 384
Assignment Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Creating Control Project Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Creating Supervision Tag Containers . . . . . . . . . . . . . . . . . . . . . . . . . 394
Creating Supervision Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
14.2 Assigning Facets of Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Defining the Control Facet Assignment Mechanism . . . . . . . . . . . . . . 402
Previewing Facets Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
Assigning Control Facets of Instances . . . . . . . . . . . . . . . . . . . . . . . . 419
Assigning Supervision Facets of Instances . . . . . . . . . . . . . . . . . . . . . 421
Assigned Facet Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Automatic Facet Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Viewing the Application Structure in Control Projects . . . . . . . . . . . . 429
14.3 Managing Assigned Facets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
Facet Actions After Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
Viewing Facet Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Order of Control Facets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
Navigating from Facets to the Instance . . . . . . . . . . . . . . . . . . . . . . . . 441
Chapter 15 Generation Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
15.1 General Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Generation Process Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
Control Project Specifics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
Selecting Versions of Types in Control Facets During Generation . . . 456
Statuses of Facets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
15.2 Generating a Project for the First Time . . . . . . . . . . . . . . . . . . . . . . . . 483
Generating Entire Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
Generating Sections, Containers, and Nodes . . . . . . . . . . . . . . . . . . . 485
15.3 Generating Projects After Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
Generating Participant Projects After Changes . . . . . . . . . . . . . . . . . . 488
Regenerating a Control Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
15.4 Generating Equipment in Supervision Projects . . . . . . . . . . . . . . . . . . 496
Generating Equipment Based on the Application . . . . . . . . . . . . . . . . 496
15.5 Generation Diagnostic Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
Generation Diagnostic Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
15.6 Managing Generated Facets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Managing Generated Facets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501

EIO0000001114 06/2020 7
 Chapter 16 Refinement Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
16.1 Control Project Refinement Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
Refining the Logical Control Project. . . . . . . . . . . . . . . . . . . . . . . . . . . 507
Identifying Code Generated by the Software . . . . . . . . . . . . . . . . . . . . 514
Creating and Updating Device DDT Variables in Logical Control
Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517
Managing Consistency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
About Variables for Peer to Peer Communication . . . . . . . . . . . . . . . . 527
Managing Network Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
16.2 Supervision Project Refinement Stage . . . . . . . . . . . . . . . . . . . . . . . . 543
Refining the Supervision Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
Chapter 17 Configuration Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
17.1 Creating the Topology of the System. . . . . . . . . . . . . . . . . . . . . . . . . . 550
Organizing the System Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
Selecting Topological Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
Configuring a Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
Configuring a Station Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
Configuring an STB Island . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Configuring a PROFIBUS Remote Master and Decentralized
Peripherals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
Configuring Modbus TCP and EtherNet/IP Devices . . . . . . . . . . . . . . 584
Configuring HART Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
Configuring an Ethernet Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Connecting to an Ethernet Network . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
17.2 Managing the Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Moving Topological Folders and Entities . . . . . . . . . . . . . . . . . . . . . . . 607
Updating Templates of Topological Entities. . . . . . . . . . . . . . . . . . . . . 608
Exporting Topological Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Importing Topological Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Chapter 18 Mapping Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
18.1 Control Project Mapping Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Creating Control Project Executables . . . . . . . . . . . . . . . . . . . . . . . . . 625
Mapping Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Mapping Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
Mapping Network Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Mapping Hardware. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655

8 EIO0000001114 06/2020
 18.2 Exporting and Importing Hardware Mappings . . . . . . . . . . . . . . . . . . . 664
Exporting Hardware Mapping Data . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Editing the Hardware Mapping Export File . . . . . . . . . . . . . . . . . . . . . 668
Importing Hardware Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
18.3 Supervision Project Mapping Stage . . . . . . . . . . . . . . . . . . . . . . . . . . 676
Creating Supervision Project Executables . . . . . . . . . . . . . . . . . . . . . 677
Mapping Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
Mapping Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 682
Chapter 19 Build Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
19.1 Control Project Build Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Building the Logical Control Participant Project. . . . . . . . . . . . . . . . . . 689
Changing the Built Control Participant Project . . . . . . . . . . . . . . . . . . 696
Managing Hardware Abstraction Layer (HAL) Variables and DFBs . . 699
19.2 Supervision Participant Project Build Stage . . . . . . . . . . . . . . . . . . . . 703
Building the Supervision Participant Project . . . . . . . . . . . . . . . . . . . . 704
Changing the Built Supervision Participant Project . . . . . . . . . . . . . . . 710
Chapter 20 Deployment Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 713
20.1 Control Project Deployment Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
Control Participant Project Deployment Process. . . . . . . . . . . . . . . . . 715
Deploying to an Emulated Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . 720
Communication Between the Computer and Engines . . . . . . . . . . . . . 723
Managing Passwords of Control Participant Projects . . . . . . . . . . . . . 725
Deploying to Redundant Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . 733
Deploying the Control Participant Project . . . . . . . . . . . . . . . . . . . . . . 736
Re-Deploying the Control Participant Project . . . . . . . . . . . . . . . . . . . 743
Deploying Data to Controllers and Station Nodes . . . . . . . . . . . . . . . . 750
Deploying Control Project Changes . . . . . . . . . . . . . . . . . . . . . . . . . . 757
Changes Requiring to Stop the Controller . . . . . . . . . . . . . . . . . . . . . . 771
20.2 Supervision Project Deployment Stage . . . . . . . . . . . . . . . . . . . . . . . . 773
Preparing for Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
Deploying the Built Supervision Participant Project from the Executable 775
Deploying the Built Supervision Participant Project from the Station
Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
Deploying Supervision Participant Project Changes . . . . . . . . . . . . . . 784

EIO0000001114 06/2020 9
 Chapter 21 Execution Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787
21.1 Control Project Execution Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
Control Participant Project Execution Process. . . . . . . . . . . . . . . . . . . 789
Execution With Redundant Controllers . . . . . . . . . . . . . . . . . . . . . . . . 793
Starting and Stopping Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796
Synchronizing Redundant Controllers . . . . . . . . . . . . . . . . . . . . . . . . . 804
About Changes Made Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Making Changes Online. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 816
Backing Up Controller Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
Importing Sections from the Logical Control Participant Project . . . . . 829
Main Redundant Controller Scenarios . . . . . . . . . . . . . . . . . . . . . . . . . 833
Redundant Controller Reservation and Connection Scenarios . . . . . . 836
Updating the Logical Control Participant Project . . . . . . . . . . . . . . . . . 841
21.2 Supervision Project Execution Stage . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Executing the Deployed Supervision Participant Project . . . . . . . . . . . 854
Chapter 22 Managing Communication . . . . . . . . . . . . . . . . . . . . . . . . 855
22.1 Communication Through Modbus TCP Ethernet Implicit Messaging
(I/O Scanning) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 857
Communicating with Devices Through Modbus TCP Implicit
Messaging (I/O Scanning) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Communicating with STB Islands Through Modbus TCP Implicit
Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
Communicating with PROFIBUS Remote Masters Through Modbus
TCP Implicit Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
Peer to Peer Communication Through Modbus TCP Ethernet Implicit
Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865
22.2 Communication by Using Modbus TCP Ethernet Explicit Messaging . 867
Communication with Devices by Using Modbus TCP Ethernet Explicit
Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 867
22.3 Communication by Using Ethernet IP Explicit Messaging . . . . . . . . . . 873
Communication with Devices by Using Ethernet IP Explicit Messaging 873
22.4 Communication Through Modbus Explicit Messaging . . . . . . . . . . . . . 877
Communication with Devices Through Modbus Explicit Messaging . . 878
Example Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
Example A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
Example B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
Example C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
Example D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 913
22.5 Monitoring Modbus Device Data Directly from Supervision . . . . . . . . . 920
Monitoring Modbus Device Data Directly from Supervision . . . . . . . . . 920

10 EIO0000001114 06/2020
 22.6 Communication with Devices by Using a PROFIBUS Master Module 925
Communication with Devices by Using a PROFIBUS Master Module 925
Part IV Managing, Modifying, and Creating Templates . . . . 929
Chapter 23 Global Templates Library . . . . . . . . . . . . . . . . . . . . . . . . 931
Global Templates Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 932
Global Templates Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
Global Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 940
Chapter 24 Global Templates Editors . . . . . . . . . . . . . . . . . . . . . . . . 943
24.1 Opening Global Templates Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
Opening Global Templates Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
24.2 Interface Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
Interface Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 945
24.3 Facet and Composite Template Editors . . . . . . . . . . . . . . . . . . . . . . . 953
Facet Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 954
Composite Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
24.4 Common Template Editor Components . . . . . . . . . . . . . . . . . . . . . . . 962
Common Template Editor Toolbars and Menus . . . . . . . . . . . . . . . . . 963
Common Template Editor Panes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 969
Using the Radar View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
Using the Simplified View in Template Editors . . . . . . . . . . . . . . . . . . 973
Chapter 25 Managing Global Templates. . . . . . . . . . . . . . . . . . . . . . 977
25.1 Managing Global Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
Saving Changes In Global Templates . . . . . . . . . . . . . . . . . . . . . . . . . 979
Copying and Pasting Global Templates and Folders . . . . . . . . . . . . . 982
Exporting Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 983
Importing Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
Purging the Global Templates Library . . . . . . . . . . . . . . . . . . . . . . . . . 995
25.2 Updating, Replacing, and Duplicating Global Templates . . . . . . . . . . 998
Template Modification Strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 999
Updating Global Templates and Templates of Elements . . . . . . . . . . 1001
Replacing the Template of an Element of a Global Template . . . . . . . 1006
Duplicating Global Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
Replace Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1017
Part V Software Services. . . . . . . . . . . . . . . . . . . . . . . . . . . 1019
Chapter 26 Content Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
Content Repository Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1022
Temporary Contents Repository Files . . . . . . . . . . . . . . . . . . . . . . . . . 1026

EIO0000001114 06/2020 11
 Chapter 27 Language Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
Default Keyboard Layout of the Virtual Machine . . . . . . . . . . . . . . . . . 1028
Virtual Machine System Locale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031
Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1045

12 EIO0000001114 06/2020
 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.

EIO0000001114 06/2020 13
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.

14 EIO0000001114 06/2020
 About the Book

At a Glance

Document Scope
This manual contains general information about EcoStruxure Process Expert and guides you
through the stages to engineer a system.
This manual is organized in five main parts:
 Understanding EcoStruxure Process Expert:
Provides information on the object model and the system engineering life cycle concepts that
the implementation of automation systems is based on.
 Working with the software:
Describes the graphical user interface and how to use the different tools that are at your
disposal.
 Engineering a system:
Provides step by step instructions to help you implement a system by following the system
engineering life cycle.
 Global Templates library and editors:
Describes the Global Templates library, the templates that it can contain, and the editors that
allow you to manage them.
 Software services:
Provides information on the content repository and on language settings for software
Participants.
It is written for users who are familiar with the engineering of Control and Supervision systems.
For further information, refer to the related documents that are mentioned in this manual.

Validity Note
This document is valid for EcoStruxure Process Expert 2020 or later. It supersedes any previous
version.

EIO0000001114 06/2020 15
Related Documents

Title of documentation Reference number

EcoStruxure™ Process Expert - Security Deployment Guide EIO0000004234 (eng)
EcoStruxure™ Process Expert - General Purpose Library User Guide EIO0000004045 (eng)
EcoStruxure™ Process Expert - General Purpose Library Process Templates EIO0000004043 (eng)
Reference Manual
EcoStruxure™ Process Expert - General Purpose Library Device Templates EIO0000004044 (eng)
Reference Manual
EcoStruxure™ Process Expert - Process Templates User Guide EIO0000000987 (eng)
EcoStruxure™ Process Expert - Device Templates User Guide EIO0000001308 (eng)
EcoStruxure™ Process Expert - Communication Templates User Guide EIO0000001311 (eng)
EcoStruxure™ Process Expert - Diagnostic Templates User Guide EIO0000001526 (eng)
EcoStruxure™ Process Expert - Foundation Application Templates User Guide EIO0000002403 (eng)
EcoStruxure™ Process Expert - Control Participant Services User Guide EIO0000001524 (eng)
EcoStruxure™ Process Expert - Supervision Participant Services User Guide EIO0000001525 (eng)
EcoStruxure™ Process Expert - Runtime Navigation Services User Guide EIO0000001574 (eng)
EcoStruxure™ Process Expert - Global Templates Reference Manual EIO0000001986 (eng)
EcoStruxure™ Process Expert - Installation and Configuration Guide EIO0000001255 (eng)
EcoStruxure™ Process Expert - Licensing Guide EIO0000001261 (eng)

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

dcs, Document Downloads section.
Registration required.

EcoStruxure Process Expert Support Portal

Visit app.schneider-electric.com/ecostruxure-hybrid-dcs for support, software updates, and latest
information on EcoStruxure Process Expert.
Registration required.

Trademarks
Schneider Electric, EcoStruxure, Process Expert, 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 and Windows are either registered trademarks or trademarks of Microsoft Corporation in
the United States and/or other countries.
Caché and InterSystems are trademarks of InterSystems Corporation.
Other names are registered trademarks or trademarks of their respective owners.

16 EIO0000001114 06/2020
Product Related Information
The examples in this manual are given for information only.

WARNING
UNINTENDED EQUIPMENT OPERATION
Adapt examples that are given in this manual to the specific functions and requirements of your
industrial application before you implement them.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: Templates shown in examples throughout this manual may differ from the actual templates
contained in the supplied Schneider Electric libraries.

WARNING
LOSS OF CONTROL
 Perform a Failure Mode and Effects Analysis (FMEA) of your application, and apply preventive
and detective controls before implementation.
 Provide a fallback state for undesired control events or sequences.
 Provide separate or redundant control paths wherever required.
 Supply appropriate parameters, particularly for limits.
 Review the implications of transmission delays and take actions to mitigate.
 Review the implications of communication link interruptions and take actions to mitigate.
 Provide independent paths for control functions (for example, emergency stop, over-limit
conditions, and fault conditions) according to the safety analysis and applicable codes, and
regulations.
 Apply local accident prevention and safety regulations and guidelines. 1
 Test each implementation of a system for proper operation before placing it into service.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

1
For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.

EIO0000001114 06/2020 17
18 EIO0000001114 06/2020
 EcoStruxure™ Process Expert
Understanding EcoStruxure Process Expert
EIO0000001114 06/2020

Part I
Understanding EcoStruxure Process Expert

Understanding EcoStruxure Process Expert

Overview
This part introduces EcoStruxure Process Expert and describes the concepts and underlying
mechanisms that are applied to engineer an automation system.
In this manual, software is used to refer to EcoStruxure Process Expert.

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
1 General Information 21
2 Introducing EcoStruxure Process Expert 23
3 General Concepts 27

EIO0000001114 06/2020 19
Understanding EcoStruxure Process Expert

20 EIO0000001114 06/2020
 EcoStruxure™ Process Expert
General Information
EIO0000001114 06/2020

Chapter 1
General Information

General Information

Terminology Used in This Manual

EcoStruxure Process Expert

To make reading easier, the software is sometimes used in place of EcoStruxure Process Expert
throughout this manual.

Item Names
Because you can customize the names of most items that are displayed in the user interface, this
manual uses predominantly the default names created by the software to describe items such as:
 Systems
 Topological entities
 Folders
 Projects and their components
 Instances

EIO0000001114 06/2020 21
General Information

22 EIO0000001114 06/2020
 EcoStruxure™ Process Expert
Introducing EcoStruxure Process Expert
EIO0000001114 06/2020

Chapter 2
Introducing EcoStruxure Process Expert

Introducing EcoStruxure Process Expert

Overview
This topic introduces EcoStruxure Process Expert and describes its main distinctive features.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
EcoStruxure Process Expert 24
EcoStruxure Process Expert Architecture 26

EIO0000001114 06/2020 23
Introducing EcoStruxure Process Expert

EcoStruxure Process Expert

Features
EcoStruxure Process Expert is the next generation process automation system to engineer,
operate, and maintain your entire plant.
It is a single environment, which interconnects and manages all the components of the automation
architecture:
 Standard field buses.
 Instrumentation.
 Intelligent, connected devices.
 Ethernet-based control networks.
 Controllers.
 Engineering and operator stations.
 Alarm management.

The software delivers everything you need to run a sustainable, productive, and market-agile plant:
 Scalable and powerful automation platform.
 Full process traceability.
 Embedded energy management.
 Fast and efficient engineering and deployment of configurations.
 Powerful native diagnostic features.
 Fast access to process data by using Runtime Navigation Services.
 Integrated and specialized, validated object libraries.

24 EIO0000001114 06/2020
 Introducing EcoStruxure Process Expert

Benefits
Using EcoStruxure Process Expert provides the following benefits, which help you:
 Reuse automation objects with proven, standard designs.
 Reduce commissioning time and cost.
 Reduce engineering and integration risks.
 Put in place appropriate preventive, predictive, and prescriptive maintenance so that unplanned
downtime approaches zero.
 Improve quality of production-related decisions and maximize operational profitability.
 Optimize the management of flows and resources to maximize output and profitability.
 Manage regulatory requirements.

WARNING
UNINTENDED EQUIPMENT OPERATION
When engineering automation systems by using EcoStruxure Process Expert:
 Identify and understand all implications and consequences of any changes on the automation
system.
 Evaluate and simulate any actions that have an influence on the automation system.
 Implement elementary protective measures in the process of engineering automation
systems.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000001114 06/2020 25
Introducing EcoStruxure Process Expert

EcoStruxure Process Expert Architecture

Integration with the Plant

EcoStruxure Process Expert offers a scalable architecture, future-ready network with high
availability for continuous operation of your plant.

26 EIO0000001114 06/2020
 EcoStruxure™ Process Expert
General Concepts
EIO0000001114 06/2020

Chapter 3
General Concepts

General Concepts

Overview
This chapter describes the object model concept and how it is applied within the software. It also
describes the concept of engineering an automation system in stages.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
3.1 Object Model Concept 28
3.2 System Engineering Life Cycle Concept 40

EIO0000001114 06/2020 27
General Concepts

Section 3.1
Object Model Concept

Object Model Concept

Overview
This section describes the concept of object model and the resulting templates that are used to
engineer automation systems by using the software.

What Is in This Section?

This section contains the following topics:
Topic Page
Object Based Engineering 29
Object Template Description 31
Application Templates 35
Topological Templates 36
Interface Models 37
Instances of Templates 38

28 EIO0000001114 06/2020
 General Concepts

Object Based Engineering

Description of the System

In EcoStruxure Process Expert a system is the representation of a physical automation system and
is defined by three independent parts:
 The application: Defines the functions of the system and the corresponding process hierarchy.
 Projects: Define the Participant projects that implement the logic and function of the system:
 Control Projects
 Supervision Projects

 The topology: Defines the hardware and software infrastructure of the system. It consists of:
 Controllers
 Devices connected to field buses
 Networks
 Station nodes (their hardware and software components)

Object Model Concept

Object models represent the application and topology of a system.
There are different types of object models representing the application of the system based on their
purpose:
 Process objects representing, for example, the I/Os of pumps, valves, and sensors in several
tanks.
 Device objects representing, for example, the functions to control a process object such as a
motor by using a drive.
 Communication objects representing, for example, the functions to manage communication with
device objects through the port of an M580 controller with Modbus TCP explicit messaging.
Likewise, object models representing the topology of the system are called topological objects.
They can represent, for example, the CPU module of an M580 controller.
The approach of representing any entity or function that exists in the real world with the use of
object models is referred to as object-oriented modeling and is based on the abstraction principle:
Abstraction Process of reducing the information to retain only what is relevant for a particular
component or function independently of the context.

EIO0000001114 06/2020 29
General Concepts

The following figure illustrates the application object-oriented modeling of a conveyor.

From Object Model to Object Template

The next step consists in creating, based on the object model, a component that models an item
or a function of the real world. This component needs to be generic enough to be reused in different
systems.
The following principle is used to achieve this objective:
Standardization Process of finding the common characteristics of different items or functions.
The resulting component is called an object template.
The following figure illustrates the process of standardizing an object model representing a
conveyor to create a template, which allows modelling conveyors and similar items (such as a
mixer) in different systems.

30 EIO0000001114 06/2020
 General Concepts

Object Template Description

Overview
Schneider Electric object templates created from object models are called Global Templates and
are grouped in libraries. When a library is installed, its templates appear in the Global Templates
Explorer (see page 932). These templates can be used in any system that is created by using
EcoStruxure Process Expert.
To make reading easier, the word templates is used to refer to Global Templates.
Templates provide collaboration and data sharing between Participants and the software platform.
By doing so, templates reduce the engineering effort and provide consistency.

Object Template Classification

Templates can be placed one inside the other, linked, and can include several capabilities to model
an item or a functionality of the real world. Therefore, the distinction is made between three types
of templates:
 Facet templates: They are the smallest templates available. They encapsulate a constituent,
which is provided by a specific Participant to deliver the respective service. As such there are:
 Control facet templates providing Control services. For example, in the General Purpose
Library, the service that is provided by the $MOTORGP_UL facet template is the on/off motor
management functionality. The functionality is implemented by using the MOTORGP
function block, which is encapsulated inside the template.
 Supervision facet templates providing Supervision services. For example, in the General
Purpose Library, the service that is provided by the $BlowerLeftGP_m_CG genie facet
template is the animated graphical representation of a motorized blower, which can be
displayed on an operator station. The animated graphic is encapsulated inside the template.
 Composite templates: They consist of one or more facet templates and/or other composite
templates. Composite templates that are included inside another composite template are called
composite references.
Depending on their composition, composite templates can be:
 Control composite templates: Contain only Control references.
 Supervision composite templates: Contain only Control references.
 Control module templates: Highest level of composite template, which contains both Control
and Supervision references.
NOTE: Facet templates that are included inside a composite template are called facet
references.
 Interface models: They are considered as a template because they are generic and can be
reused but they are actually a mechanism that allows linking to each other:
 Any combination of facet and composite templates.
 Instances of templates.

There are different types of interface models depending on the objects that they link. You can
configure interface models.

EIO0000001114 06/2020 31
General Concepts

For details, refer to the help of the Schneider Electric libraries for EcoStruxure Process Expert.
The following figure illustrates a single facet template.

The arrows represent the inputs and outputs of the facet which propagate the data.
The following figure illustrates a composite template including another composite template
(composite reference) and two facet templates.

- - - Represents interface links

Template Terminology
The following example shows the graphical representation of a sample composite template. The
names of elements may vary.

NOTE: Interfaces are not represented since they are mechanisms for managing data exchange
between references.

32 EIO0000001114 06/2020
 General Concepts

The table explains the color coding that is used in the generic composite template Template.

Color Description
Control facet template, which encapsulates a functionality that is provided by the Control
Participant.

Supervision facet template, which encapsulates a functionality that is provided by the Supervision
Participant.

Composite template, which can contain:

 Control and/or Supervision facet templates
 Other composite templates

NOTE: This color coding is used in the user interface to differentiate the different types of templates
and related services.
The table describes the items that compose the generic composite template Template and the
terminology that is used to designate these items depending on the context.

Item Description
1 Template is the highest level composite template and is called a control module because it
provides both the Control and Supervision functionalities that are required to manage the object
that is modeled by the template.
2 Control is a Control composite template because it contains Control facet templates. It is also
called a composite reference as it is referenced inside the composite template Template.
In the context of Template, Control is an element of Template
3 Service1 is a composite reference.
In the context of composite reference Control, Service1 is an element of Control.
The same applies to composite reference Service2.
Both Service1 and Service2 are Control composite templates since they contain only Control
facets.
4 Logic and Signal1 are Control facet references.
In the context of the composite reference Service1, they are elements of Service1.
5 Signal3 is a Control facet reference.
In the context of the control module Template, Signal3 is an element of Template.
6 Supervision is a Supervision composite reference because it is contained in composite template
Template. It contains Supervision elements (composite references Tag and Genie).
In the context of the control module Template, Supervision is an element of Template.
7 Tag is a Supervision composite reference because it is contained in composite Supervision and
contains only a Supervision element (OnOff).
Likewise Genie is a Supervision composite reference.
8, 9 OnOff and Pump are Supervision facet references and elements of templates SuperTagvision and
Genie respectively.

EIO0000001114 06/2020 33
General Concepts

Types of Object Templates

Like object models represent the application and the topology of the system, so do templates.
As a result, the following types of templates exist:
 Application templates: Facet and composite templates, which define the functional components
in the application of the system.
 Topological templates: Facet and composite templates, which define hardware and software
components of the topology of the system.

34 EIO0000001114 06/2020
 General Concepts

Application Templates

Overview
Control and Supervision facet templates encapsulate the respective Participant capabilities:
 For Control:
 Logic facet templates: Implement a specific functionality, for example, discrete motor
management.
 For Supervision:
 Data facet templates: Allow defining tags and user interface messages that are required for
acquiring runtime data.
 Genie facet templates: Represent runtime data by using an animated graphic.

Facet templates encapsulate the respective Participant capabilities. For Control, these are Logic
facet templates, which implement a specific functionality, for example, discrete motor
management.
Based on a combination of these, application control module templates have been created, which
allow you to model the application of a system in terms of Control and Supervision services.
The templates are available in the form of libraries and after installation, appear in the Global
Templates Explorer (see page 932) where they are grouped by category.
For details, refer to the help of the Schneider Electric libraries for EcoStruxure Process Expert.
NOTE: There is a relation between Control and Supervision facet templates because for a given
Control service, which is provided by a Control facet, the Supervision facet represents the part of
the service that is visible to the user (for example supervisory user interface and mode of
operation).

EIO0000001114 06/2020 35
General Concepts

Topological Templates

Introduction
Topological templates allow you to model the hardware and software infrastructure of the topology
of a system by creating topological entities.
They are located in the Foundation library and grouped by category.

Sub-Types of Topological Templates

The following subtypes of topological templates are available:
 Network: Models control and field bus networks.
For example: Ethernet LAN, Modbus, CANopen, Profibus DP, RIO S908, RIO Ethernet, local
bus for controllers and Advantys islands).
 Network devices: Models the field bus devices.
For example: Gateways.
 Station node: This template models the components of the different types of stations that are
connected to the Ethernet network.
For example: network interface cards (NICs), Supervision software, OPC Factory Server (OFS)
software, and Control software.
 Controller: Models the controller hardware that is managed by the Control Participant.
For example: Hardware of the Quantum platform.
 Device I/O: Models devices and remote I/Os including third party devices that can be connected
as nodes to Ethernet networks.
For example: Advantys Island I/Os, energy devices, motor starters, and instrumentation
devices.

36 EIO0000001114 06/2020
 General Concepts

Interface Models

Introduction
Interface models allow you to define:
 data exchange between two object instances or two object references.
 dependencies between two object instances or two object references such as compatibility or
requirement rules.

Types of Interface Models

The following types of interface models are predefined:
 Physical: Allow data exchange at the physical level (modules) between:
 Topological instances

 Topological references
 Communication: Allow data exchange at the logical level (I/O scanner, OPC Factory Server
software, Supervision I/O devices) between:
 Topological instances

 Topological references
 Application: Allow data exchange between:
 Application instances/references
 Topological instances/references

 Mapping: Allow data exchange during the mapping stage between application objects
(representing the logical projection of the hardware) and topological objects (representing the
actual hardware defined in the topology).

EIO0000001114 06/2020 37
General Concepts

Instances of Templates

From Templates to Instances

The software lets you create application and topological instances from the corresponding
templates.
Because control module templates integrate a range of Control and Supervision services, editable
parameters, and expose a set of interfaces, you can customize each instance to fulfill specific
requirements.
The process of creating instances from templates and configuring them is called instantiation.
To access and configure their parameters, instances produce facets, which are based on the facet
templates that each control module template contains.
During the instantiation, you can:
 Select services among those that the template provides. For Schneider Electric templates,
some services are mandatory (for example, Logic) and some are optional (for example,
Supervision).
 Edit the values of parameters (for example, provide a high limit value for an analog level sensor).
 Link instances to each other (for example, link a motor instance to the instance representing the
functions of the variable speed drive that controls the motor).
When you enable (select) a service, the software creates a facet, which is an instance of the facet
template that provides the service. This facet is associated to the instance of the template that
references the service.
The other way around, when you disable (unselect) a service, the software deletes the
corresponding facet.

38 EIO0000001114 06/2020
 General Concepts

The following figure shows an example of several instances with different configurations that you
can create from one template.

Only some facets of instances Conv_1, Pump_1, and Pump_2 are shown for illustration
purposes.

EIO0000001114 06/2020 39
General Concepts

Section 3.2
System Engineering Life Cycle Concept

System Engineering Life Cycle Concept

Overview
The concept of breaking down into stages the workflow to engineer an automation system is
referred to as the system engineering life cycle in this manual.
This section provides a general description of each stage using:
 A stage map showing the position of the stage within the system engineering life cycle.
 A definition to explain the purpose of the stage.
 An example to facilitate the understanding.

What Is in This Section?

This section contains the following topics:
Topic Page
The System Engineering Life Cycle 41
Platform Components 43
Global Templates Definition Stage 44
Instantiation Stage 45
Project Definition Stage 50
Assignment Stage 53
Generation Stage 55
Refinement Stage 56
Configuration Stage 58
Mapping Stage 60
Build Stage 62
Deployment Stage 64
Execution Stage 65

40 EIO0000001114 06/2020
 General Concepts

The System Engineering Life Cycle

Overview
For a description of the representation of a system in EcoStruxure Process Expert, refer to Object
Based Engineering (see page 29).

Graphical Representation
The system engineering life cycle is the representation of the stages of the engineering workflow
(from design to operation and maintenance) that you need to complete to engineer a system
(see page 146) by using the software.
The following figure shows the system engineering life cycle.

The stages are grouped into 4 main parts where Topology, Projects, and Application represent the
components of a system. Library represents the Global Templates, which are used in the other
three parts. To each part corresponds an explorer, which provides the functionality to complete
each of the stages.
The arrows represent the order in which you need to complete the stages. The horizontal double
bars represent the stage gates where the previous stages have to be completed before you can
proceed further in the life cycle.
The Assignment and Mapping stages make the link between the different components of the
system.
You can find a list of the stages and the main tasks that you can complete in each stage in quick
reference Guides (see page 145).

EIO0000001114 06/2020 41
General Concepts

Illustrating the Concept

When necessary, to illustrate the concept of a stage, a concrete example is used.
The example is a water tank system that collects rain water. The installation consists of the
following equipment:
 2 electrical pumps, which transfer the water from the tank into a separate reservoir.
 3 digital switches, which indicate the rain water level in the tank.

The following figure illustrates the water tank system:

1 Pump: Pmp1
2 Pump: Pmp2
3 High-level switch: Lsh1
4 Low-level switch: Lsl1
5 Very low-level switch: Lsll1
6 Rain water tank
7 Reservoir

Pump Management Operating Mode

In the example, 1 of the 2 pumps transfers the rain water into the reservoir. The other pump serves
as a back-up pump in case the transfer pump requires maintenance or is out of order. Both pumps
exchange their roles periodically and are equipped with a soft starter.

Level Management Operating Mode

In the example, the 3 digital level switches act on the pumps at 3 different water levels: very low,
low, and high level. The Lsh1 high level and Lsl1 low-level switches provide information on the level
of the water in the tank. The Lsll1 very low-level switch is directly wired to the power supply of both
pumps so that they do not run dry.

42 EIO0000001114 06/2020
 General Concepts

Platform Components

Overview
The software lets you engineer each part of a system (application, projects, and topology)
independently by using specific tools, which provide the necessary functionality.
You can engineer several systems simultaneously.

Platform Managers
The following explorers are available as part of the software platform.

Explorer Description
Global Displays the Global Templates of the installed libraries and those that you have created
Templates and/or imported.
Explorer They are organized in a folder structure, which makes the templates easily accessible.
The explorer lets you search, create, modify (see EcoStruxure™ Process Expert, Global
Templates, Reference Manual), and manage Global Templates.
Systems Displays the systems that exist in the database of the system server.
Explorer The explorer is the entry point to start engineering systems.
Application Displays the application of a system in a tree view, which lets you create a hierarchy.
Explorer The explorer lets you search, create, configure, and manage the instances that model the
application of a system.
Project Explorer Displays, at the platform level, the projects of a system that are managed by the software
Participants:
 Control projects
 Supervision projects

The explorer lets you create and manage the Control logic, Supervision data, and the
executables of each project.
Topology Displays the topology of a system in the form of a folder structure.
Explorer The explorer lets you create and manage the different topological entities that model the
hardware infrastructure. Also, it allows you to interact with the controllers, devices, station
nodes, and networks of a system.

EIO0000001114 06/2020 43
General Concepts

Global Templates Definition Stage

Stage Map
The following figure shows the position of the Global Templates Definition stage within the system
engineering life cycle:

Definition
The Schneider Electric application and topological templates that are provided in various libraries
allow you to engineer systems. Yet, you have the possibility to modify or create templates.
The Global Templates Definition is the process of creating and/or modifying templates by:
 Using existing templates from the Global Template library and modifying them to meet your
particular requirements.
 Creating new templates by using generic base elements with the help of template editors.
This process is described in a separate manual (see EcoStruxure™ Process Expert, Global
Templates, Reference Manual).

44 EIO0000001114 06/2020
 General Concepts

Instantiation Stage

Stage Map
The following figure shows the position of the Instantiation stage within the system engineering life
cycle.

Definition
The instantiation stage involves modeling:
 The process hierarchy by using a folder structure.
 Functional components by using instances (see page 38) of templates.

The resulting folder and instance organization represents the application of the system and is
unique.
Once you have created a system (see page 157), you can create instances from templates that
you select among a choice of templates that are available in the Global Templates library.
Depending on the composition of the template, during the instantiation, the template creates a set
of Control and/or Supervision facets, which are associated to the instance and provide specific
services.

EIO0000001114 06/2020 45
General Concepts

To fulfill the specific requirements of the application, the instantiation process includes the step of
configuring the application folders and the instances that they contain by:
 Selecting/deselecting optional Control and Supervision facets among those that are built into
the instance template to enable/disable the corresponding services.
 Editing folder and instance properties and/or parameters.
 Creating links between instances.

For more information on completing the instantiation stage, refer to the chapter describing its
implementation (see page 171).

Example of the Process Hierarchy of the Water Tank System

The following figure shows an example of how you can organize the application of the water tank
automation system (see page 42).

Water tank: Water tank system root folder.

Level: Level management folder, which will contain the instances modeling the water level sensor functionality.
Pumping: Pump management folder.
Pmp1: Folder containing the instances modeling the functionality of the motor of Pump 1.
Pmp2: Folder containing the instances modeling the functionality of the motor of Pump 2.

Selecting Templates to Model the Application

The table shows examples of templates of the General Purpose Library that can be used to model
the water tank application.

Template Application
$MotorGP Motors of Pump 1 and Pump 2
$ATS48MBGP Altistart 48 progressive starters for Pump 1 and Pump 2
$DigitalInputGP Digital switches (Lsh1, Lsl1, Lsll1)

46 EIO0000001114 06/2020
 General Concepts

Example of the Instances Modeling the Water Tank Application

The following figure illustrates the concept of instantiation for the water tank application.

NOTE:
For simplicity, only the following items are represented:
 Pump 1 and level switch objects.
 Instances inside folders Pmp1 and Level.
 Facets of the Motor_Pmp1 instance.

EIO0000001114 06/2020 47
General Concepts

The table describes the instances that are created during instantiation of the templates and gives
an example of the configuration possibilities.

Selected template Instances Instance description Purpose of the facet Configuration example(3)
created from contained in the
template(1) template(2)
$MotorGP Motor_Pmp1 Model the electrical Control facet for The on/off logic facet is
motors of Pump 1 and on/off logic. selected by default and
Pump 2. cannot be deselected. The
corresponding service is
provided for the instance.
You can configure various
parameters for this Control
service.
Control facet to The optional interlock
manage interlock condition summary facet is
conditions. selected, created, and the
service is be available for the
instance.
Motor_Pmp2 Supervision facet to The optional Supervision
manage runtime facets are selected, created,
motor on/off data. and the corresponding
services are available for the
Supervision facet to
manage interlock instance.
You can configure several
data.
parameters for these
Supervision services.
$ATS48MBGP Motor1_ATS Model the management Not detailed for the example.
Motor2_ATS of motors for Pump 1
and Pump 2, each by an
ATS 48 soft starter
device.

48 EIO0000001114 06/2020
 General Concepts

Selected template Instances Instance description Purpose of the facet Configuration example(3)
created from contained in the
template(1) template(2)
$DigitalInputGP Lsh1 Models a digital input for Control facet to The logic facet is selected by
the Lsh1 high-level manage the logic. default and cannot be
detection switch. deselected. The
corresponding service is
provided for the instance.
You can configure several
parameters for this Control
service.
Supervision facet for The optional Supervision
signal data. facet is selected, created, and
the corresponding service are
available for the instance.
You can configure several
parameters for this
Supervision service.
Lsl1 Models a digital input for Control facet. The logic facet is selected by
the Lsl1 low-level (Same as for Lsh1) default and cannot be
detection switch. deselected. The
corresponding service is
provided for the instance.
You can configure several
parameters for this Control
service.
Supervision facet. The optional Supervision
(Same as for Lsh1) facet is selected, created, and
the corresponding service is
available for the instance.
You can configure several
parameters for this
Supervision service.
Lsll1 Models a digital input for Same as for Lsh1 Not detailed for the example.
the Lsll1 low-low-level
detection switch.

(1) The name of the instance is user-defined.

(2) The actual templates contain more facet templates than shown in the table.
(3) The facets are created for each instance. The example shows only the configuration for
instances Motor_Pmp1 and Lsh1. In fact, each instance of a template can be configured
individually.

EIO0000001114 06/2020 49
General Concepts

Project Definition Stage

Stage Map
The following figure shows the position of the project definition stage within the system engineering
life cycle.

Definition
The project definition is the process to define the organizational structure of projects that will be
integrated into the system through the Participants. You define projects independently from
specific hardware components, which gives you flexibility and allows you to use one project with
different hardware infrastructures.
Ultimately, towards the end of the system engineering life cycle, to each project will be associated
one or more executable files that you can deploy to the topology of the system.
For each system, you can define as many projects as required.
Each project is associated to a Participant and is therefore referred to as a Participant project.
A system is composed of the following Participant projects:
Control This type of project is specific to a hardware platform (for example, Modicon M580
platform) and manages the controller program.
Supervision This type of project allows you to manage data from the application, represent it
graphically, and provide the operator with a user interface to interact with the controller.
NOTE: Supervision projects are optional and you create them depending on the requirements of
the system.

50 EIO0000001114 06/2020
 General Concepts

Project Structure
The organizational structure of a project is specific to the Participant that it is related to because it
reflects the components that the Participant manages.
A Control project consists mainly of nodes representing:
 The program structure: A Containers node containing FBD and non-FBD program sections,
which are referred to generically as containers.
 The binary program: An Executables node providing access to program files and related
services.
A Supervision project consists mainly of nodes representing:
 Data: A Containers node containing tag containers for each cluster.
 Graphic elements: A Pages node that contains the user interface visible to the operator.
 Components: A Cluster node for managing servers and communication for data acquisition and
representation by cluster.
 The program: An Executables node providing access to services related to the program files.

Types of Projects
As you progress through the system engineering life cycle, a Participant project evolves. To
distinguish between the stages that projects go through, specific terminology is used to describe
them.
The software manages three types of Participant projects throughout the system engineering life
cycle:
Logical Participant projects Contain the information of the application and the organizational
structure of the project with no relation to the hardware infrastructure of the system. The
software creates these projects during the generation (see page 55) stage.
Built Participant projects Contain the information of the logical Participant project and associate it
to the hardware infrastructure of the system. The software creates these projects during the
build (see page 62) stage.
Deployed Participant projects Are the built Participant projects that you have deployed to engines
of the system (for example, controllers or station nodes). You deploy projects during the
deployment stage (see page 64).

EIO0000001114 06/2020 51
General Concepts

The following figure illustrates at which stages of the system engineering life cycle, the different
types of projects are managed.

For more information on completing the project definition stage, refer to the chapter describing its
implementation (see page 297).

Example
The following projects are defined for the water tank system (see page 42):
 A Control project to manage the logic (for example, variables and DFBs,) of the instances of the
application. It contains three containers in the MAST task folder corresponding to the folder
structure of the application:
 Level
 Pmp1
 Pmp2

 A Supervision project to manage the Supervision services (tags, alarms, supervision pages) of
the instances of the application. It contains the following components:
 One tag container for the Supervision data facets of the instances of the application.
 One page for the Supervision genie facets of the instances of the application.
 Components: One of each I/O, alarm, and trend server, and I/O device with its
communication port.

52 EIO0000001114 06/2020
 General Concepts

Assignment Stage

Stage Map
The following figure shows the position of the assignment stage within the system engineering life
cycle.

Definition
The assignment is the process of associating Control and Supervision facets of instances of the
application to a container of the corresponding project of the system.
The purpose is to define where the constituents that are encapsulated inside the facets will be
generated in the Participant project during subsequent stages of the system engineering life cycle.
You need to assign the two types of facets to the corresponding containers:
 Control facets: To containers of Control projects, which are FBD sections.
 Supervision data facets: To containers of Supervision projects, which are tag containers.

You can assign a facet only to one container per project but you can assign a facet to several
projects.
NOTE: Supervision genie facets are assigned to a page of a Supervision project during the
refinement stage.
For more information on completing the assignment stage, refer to the chapter describing its
implementation (see page 383).

EIO0000001114 06/2020 53
General Concepts

Example
The table shows an example of assignment of the facets of the instances Motor_Pmp1 and Lsh1
of the water tank system (see page 42) that you can perform.

Instance Facets Assigned To

Motor_Pmp1 Control facets: FBD section Pmp1 of the Control project.
 $MOTORGP_UL: On/off logic data facet
 $INTERLOCKONGP_UL: Optional interlock
condition summary facet
Supervision facet: Tag container of the Supervision project.
 $MOTORGP_CD: Optional on/off data facet
Lsh1 Control facets: FBD section Level of the Control project.
 $MOTORGP_UL: Logic data facet
 $DISignal_UL: Optional digital input signal

Supervision facet: Tag container of the Supervision project.

 $DINPUTGP_CD: Optional data facet

54 EIO0000001114 06/2020
 General Concepts

Generation Stage

Stage Map
The following figure shows the position of the generation stage within the system engineering life
cycle.

Definition
The generation is an automatic process that creates a logical Participant project by using the
constituents of the assigned facets and taking into account the structure of the project. At this point,
the logical Participant project has no relation with the topology of the system.
For more information on completing the generation stage, refer to the chapter describing its
implementation (see page 443).

Example
During the generation process of the facets of the water tank system (see page 42) that are
assigned to projects, the software creates:
 For Control: The program of the Participant.
 For Supervision: populates the different database files that are used by the Participant.

EIO0000001114 06/2020 55
General Concepts

Refinement Stage

Stage Map
The following figure shows the position of the refinement stage within the system engineering life
cycle.

Definition
Refinement is an optional process during which you can modify and/or add information to a logical
Participant project that the software has created during the generation stage.
For example, you can refine a Control project to:
 Add logic between control facets of instances.
 Create new relationships with other constituents such as interlocks or control sequences.
 Add sections in languages supported by the Participant other than FBD.

To facilitate the refinement of Control projects, the software locks and identifies visually code that
it has generated.
You can refine a Supervision project, for example, to:
 Assign genie facets to a Supervision page.
 Configure user privileges.

The software opens the respective Participant allowing you to use the interface and some function-
alities of the embedded software.
For more information on completing the refinement stage, refer to the chapter describing its
implementation (see page 505).

56 EIO0000001114 06/2020
 General Concepts

Example
During the refinement of the Control project of the water tank system (see page 42), you can
access and modify the control logic using the embedded editors to create or modify constituents.
The following figure illustrates the refinement of the constituents generated by the Control logic
facet of the Lsh1 high-level switch sensor instance. During this refinement, a new variable is
added.

EIO0000001114 06/2020 57
General Concepts

Configuration Stage

Stage Map
The following figure shows the position of the configuration stage within the system engineering
life cycle.

Definition
The configuration stage consists in defining the topology of the system, which models the hardware
and software infrastructure.
You can create topological entities by using either of two methods depending on the entity that you
are defining:
 In the engineering client user interface by selecting manually the templates to be used to create
entities.
 In the Control Participant by using the functionality of the embedded software. Saving the
configuration in the Participant creates the corresponding folders and devices in the Topology
Explorer by selecting automatically the appropriate templates of the Foundation library.
For more information on completing the configuration stage, refer to the chapter describing its
implementation (see page 549).

58 EIO0000001114 06/2020
 General Concepts

Example
For the water tank system (see page 42), during the configuration stage, you can define the
hardware that will run the program, the Ethernet control network, and the operator station from
which the operator will operate the pump, monitor the pumping process, and the water level.
The following figure shows examples of topological entities of the water tank system that you can
create during the configuration stage.

Controller Local rack with an Ethernet based architecture.

STB Island Distributed I/Os to which level switches Lsh1, Lsl1, and Lsll1 are connected,
communicating with the controller through I/O scanning.
Operator station Supervision station to control and monitor the system, configured with its network
interface card and the supervision software.
Ethernet network Networks connecting the controller, the STB Island, the gateway, and the station
node.
Gateway The gateway communication instance is created in the application of the system
modeling the communication functions. The device itself is not represented in the topology.
ATS 48 The soft starter instances are created in the application of the system modeling the motor
management functions. The device itself is not represented in the topology.
NOTE: When communication with devices is performed by using Modbus TCP explicit or implicit
messaging, topological instances of devices are created also in the topology to manage TCP/IP
addressing.

EIO0000001114 06/2020 59
General Concepts

Mapping Stage

Stage Map
The following figure shows the position of the mapping stage within the system engineering life
cycle.

Definition
The mapping stage consists in associating facets of a project to resources of the topology of the
system.
You can perform three types of mappings independently for each project:
 Service mapping: Defines which engine executes the project (for example, which controller runs
the program or, which station node hosts the I/O server).
 Hardware mapping: For Control projects only. Links the logical projection of the hardware
defined in the application (for example, a variable representing an I/O signal of a motor) to the
hardware defined in the topology (for example, an I/O channel in an I/O module of the
controller).
 Communication mapping: Defines runtime communication (for example, which controller will
communicate with the I/O device and through which communication module), communication
between controllers (peer to peer communication), and between controllers and devices (for
example, communication with STB islands or Modbus TCP Ethernet devices by using I/O
scanning).

60 EIO0000001114 06/2020
 General Concepts

NOTE:
You can map a project to several different engines, for example:
 To a controller in the laboratory for test purposes.
 To a controller in the production plant.

For more information on completing the mapping stage, refer to the chapter describing its
implementation (see page 623).

Example
The table gives examples of the mappings that you can perform for the water tank system
(see page 42).

Mapping Description
Control project
Service Defines to controller the program is associated for deployment and execution.
Hardware If for instance Motor_Pmp1, you select the optional Running Control service, the software
creates the corresponding facet. It creates, for example, a boolean variable that indicates
the state of the motor switch.
You can map this variable of the application to the channel of an input module of the STB
island.
Communication Defines the I/O scanner channels that are created for communication between the
controller and the STB island.
Supervision project
Service Defines the I/O, alarm, and trend servers that are used for the Supervision project and on
which operation stations of the topology they are installed.
Communication Defines from which controller I/O data is acquired and which communication module of
this controller is used.

EIO0000001114 06/2020 61
General Concepts

Build Stage

Stage Map
The following figure shows the position of the build stage within the system engineering life cycle.

Definition
The build stage consists in starting an automated process during which a Participant merges the
following information in order to create the built Participant project:
 The logical Participant project
 Mappings
 The topology

The built Participant project is the executable that you can deploy to engines of the system
The software stores the executable files resulting of this process in the contents repository.
At this point, you can view the complete Control and Supervision projects in the corresponding
Participant.
Once built, a project is referred to as the built Participant project, which is the project associated to
an engine for execution.
For more information on completing the build stage, refer to the chapter describing its implemen-
tation (see page 687).

62 EIO0000001114 06/2020
 General Concepts

Example
During the build process of the water tank system (see page 42), Participants create the following
files.

Participant Generated Files

Control The executable file, which is the binary to be deployed to the controller.
Supervision The master project file (.ctz) to be deployed to the operation server and operator stations.
Files of the included projects (.ctz) to be deployed to the operation server and operator
stations.
The OFSOPC/OPC UA configuration files (.xml) to be deployed to the operation server.

EIO0000001114 06/2020 63
General Concepts

Deployment Stage

Stage Map
The following figure shows the position of the deployment stage within the system engineering life
cycle.

Definition
During the deployment stage, you transfer a built Participant project to the corresponding engine
that is defined in the topology of the system.
Depending on the project, an engine can be:
 For Control:
 a controller
 a station node for emulating a simulator

 For Supervision: A station node acting as operation server or operator station.

Once deployed, a project is referred to as the deployed Participant project, which is the project that
is loaded into the engine for execution.
The stage also includes the steps of redeploying an already deployed Participant project and to
update a deployed Participant project with changes that you have made to the corresponding
logical Participant project.
For more information on completing the deployment stage, refer to the chapter describing its
implementation (see page 713).

64 EIO0000001114 06/2020
 General Concepts

Execution Stage

Stage Map
The following figure shows the position of the execution stage within the system engineering life
cycle.

Definition
The execution stage includes the steps to:
 Start and stop the execution of a deployed Participant project.
 Make online changes to a deployed Participant project.
 Update the corresponding logical Participant project with the changes that you have made
online.
The execution stage takes into consideration actions that you can perform with and without
stopping the controller to keep you informed of the impact of your changes.
For more information on completing the execution stage, refer to the chapter describing its
implementation (see page 787).
Additional runtime services are described in the Navigation Services User Guide
(see EcoStruxure™ Process Expert, Runtime Navigation Services , User Guide ).

EIO0000001114 06/2020 65
General Concepts

66 EIO0000001114 06/2020
 EcoStruxure™ Process Expert
Working with the Software
EIO0000001114 06/2020

Part II
Working with the Software

Working with the Software

Overview
This part explains how to access and use the client user interface (UI). It describes the various
functionalities of the software and provides general information to help you use them effectively.

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
4 Starting and Quitting System Server and Clients 69
5 Multiuser Functionality 83
6 Action Traceability 85
7 Software Capabilities 91
8 Using the Help 103
9 User Interface 113

EIO0000001114 06/2020 67
Working with the Software

68 EIO0000001114 06/2020
 EcoStruxure™ Process Expert
Starting and Quitting System Server and Clients
EIO0000001114 06/2020

Chapter 4
Starting and Quitting System Server and Clients

Starting and Quitting System Server and Clients

Overview
This chapter describes how to start and quit the system server and clients after a first start, and
describes the client/server connection.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Logging In and Out of System Server and Clients 70
Locking and Unlocking the Software 73
Starting the System Server Again 74
Client/Server Connection 75
Quitting the Software 80

EIO0000001114 06/2020 69
Starting and Quitting System Server and Clients

Logging In and Out of System Server and Clients

Overview
Any user who is a member of at least one EcoStruxure Process Expert group can log in to the
system server or a client.
These groups are created automatically or must be created manually by the system/network
administrator depending on the authentication type that was selected during installation. The
administrator must also add users to one or more groups depending on the role of each user.
To be able to use the functionality of a given component, you must be a member of the appropriate
group (for example, to use the engineering client, you must be a member of the ESX HDCS
Engineer group).
NOTE: For information on how to get started with the software, refer to the topic describing the first
steps to perform (see EcoStruxure™ Process Expert, Installation and Configuration Guide).

Authentication Domain Selection

When you log in, enter your username without domain name or any prefix.
The system server uses the authentication type setting (see EcoStruxure™ Process Expert,
Installation and Configuration Guide) to validate your credentials either locally or with the Active
Directory® domain service.
NOTE: If Domain is the configured authentication type, the domain controller must be reachable
from the computer running the system server.
NOTE: If the computer that runs the client is connected to a Windows® domain and the connection
to the domain network is interrupted, users can log in locally by changing the authentication type
setting to local.
For more information, refer to the topic describing role based access control (see EcoStruxure™
Process Expert, Installation and Configuration Guide).

Single Login and Logout

The software implements a single-login mechanism. You need to log in when you open the first
software component (for example, a client). Thereafter, you are logged in automatically when you
open other components on the same computer.
If several components are open on the same computer, you are logged in to all of them at once.
You need to log in again only after you log out of a component on the computer.
The software also implements a single-logout mechanism. Logging out of a software component
also logs you out of the other software components to which you are logged in on the same
computer.

70 EIO0000001114 06/2020
 Starting and Quitting System Server and Clients

Logging In
To log in to a software component, enter your username (without domain) and password in the log-
in window. The log-in process may take a moment to complete.
The window appears when you start the first component on a computer, open a second component
while no user is logged in to the first component, or by clicking Log In from the user menu
(see page 115).
If you close the log-in window without logging in, the component remains open.
NOTE: Logging in to a client is subject to the same log-on policies as those that are defined locally
for the computer or for the domain.

Logging Out
To log out of a software component, select the Log Out command from the user menu
(see page 115).
To be able to log out, all operations that are in progress for components running on the computer
must have completed.
Logging out of a software component:
 Does not quit the component.
 The system server is not stopped if it is running. Further, you cannot stop the system server
when no user is logged in.
 For clients, if you had opened additional windows by using the Open in New Window
command (see page 123), these windows are closed. Tabs are closed.
 Logs you also out of the other software components to which you are logged in on the same
computer.
NOTE: You are logged out of the software on a computer when you quit the last component to
which you were logged in on this computer.

Viewing Connected Clients

From any client that is connected to a system server, you can view information about the clients
that are connected to this server in the Client Details tab of the about dialog box.
For a description of the dialog box, refer to the topic describing the About EcoStruxure Process
Expert dialog box (see page 117).

EIO0000001114 06/2020 71
Starting and Quitting System Server and Clients

Tracing Login Attempts and Log Outs

The following actions are recorded:
 Attempts to log in to a component even if they are unsuccessful. The username that is entered
is recorded.
 Locking and unlocking (see page 73) a component.
 Logging out of a component.

Actions performed in the system server console appear as notifications in the console and are
recorded in the system server log files. Actions performed in a client appear in the notification panel
(they also appear in the system server console when client and server are running on the same
computer).
For details, refer to the topic describing the traceability of actions (see page 85).

72 EIO0000001114 06/2020
 Starting and Quitting System Server and Clients

Locking and Unlocking the Software

Locking Software Components

To lock a software component, select the Lock command from the user menu (see page 115).
Locking the server still allows clients running on other computers to connect to it or remain
connected.
When components are locked, the log-in window opens on top of the main window. The username
of the logged-in user shown is in the User Name field in read-only mode. Only the user who has
locked the software can unlock it.

Impacts of Locking Software Components

Locking a software component has the following impacts:
 Locking any software component also locks all the other components that are open on the
computer and to which you are logged in.
 Dialog boxes and notifications in the notification panel are queued and suppressed. These
messages are shown once the component is unlocked.
 You cannot quit a component that is locked.
 You cannot open other EcoStruxure Process Expert components on the computer.

Unlocking Software Components

To unlock a component, enter the password in the login dialog box.
Unlocking any software component also unlocks all the other components that were locked on the
computer.
To unlock the software when the domain authentication type is selected requires that the domain
controller be reachable from the computer running the system server.

EIO0000001114 06/2020 73
Starting and Quitting System Server and Clients

Starting the System Server Again

Temporary Contents Repository Files

When you start the system server, it creates folders to store temporary files (see page 1026) from
the contents repository to speed up access to these files.

Insufficient Disk Space Notification

When you start the system server, the server console may display a notification about insufficient
free disk space (see EcoStruxure™ Process Expert, Installation and Configuration Guide).
If this notification appears, try to free some disk space.

Starting the System Server

To start the system server after you stopped it (see page 81), proceed as follows.

Step Action
1 Verify that Caché is running by checking the presence and the color of the Caché icon in the
notification area. When Caché is running, its icon is blue.
2 If the system server console is not open, from the Windows® Start menu, click EcoStruxure
Process Expert → System Server.
Result: The log-in window opens.
3 Enter your username without domain or prefix, your password, and click Log In.
Result: The system server console opens.
4 Click Action → Start.
Result: The system server starts.
5 Wait until the system server console displays the following message at the bottom of the window
to start engineering and operation clients (see EcoStruxure™ Process Expert, Installation and
Configuration Guide):
Server is ready.

74 EIO0000001114 06/2020
 Starting and Quitting System Server and Clients

Client/Server Connection

Overview
Clients connect with the system server through an Ethernet cable connection, for example to:
 Access the database.
 Access software Participants.
 Launch tasks that are performed by the system server.
 Receive notifications from the system server.
 Verify digital certificates and license rights.

You cannot use clients while the connection to the system server is interrupted or while the system
server is not running.
You can test the client/server connection (see EcoStruxure™ Process Expert, Installation and
Configuration Guide).

Notifications About Client/Server Connection Interruption

The table describes the various notifications that appear client-side for different scenarios where a
client cannot connect to the system server or the virtual machine anymore.

Scenario Operation in progress at Client notification Corrective action

the time of the interruption
1 No No None
2 You launch a task while Notification that the client is Launch the task again when the connection is re-
the connection to the unable to connect to the established.
system server is system server.
interrupted.
3 Yes Notification about an If the system server is still running, the action
unexpected communication completes server side and the notification of
interruption. clients is updated when the connection is re-
established.
If the system server has stopped, an action is
required (see page 78).

EIO0000001114 06/2020 75
Starting and Quitting System Server and Clients

Scenario Operation in progress at Client notification Corrective action

the time of the interruption
4 Yes. An action is If the connection to the system server is still
Notification that the action in
performed in an open the Participant cannot be functional, save changes, close the Participant
software Participant performed and indication of window, and start over once the problem is fixed.
window. the possible causes. If the connection to the system server is
interrupted, refer to scenario 3.
NOTE: If you are refining a
If the reason for the connection interruption
Control project online
cannot be determined, you need to contact
(see EcoStruxure™
Schneider Electric support (see page 117).
Process Expert, Control
Participant Services, User
Guide) and have clicked the
button to build and deploy
changes after the
connection was interrupted,
the changes are not
deployed nor saved.
5 The system server is Notification in the From this point on, you cannot perform any
stopped by user notification panel action on the client.
intervention. (see page 86) to inform that Restart the system server.
the server is shutting down.
6 Yes. An action is None. Contact Schneider Electric support
performed in an open A message appears in the (see page 117).
software Participant system server console.
window.

NOTE: Refer also to the topic providing information to help troubleshoot client/server
communication (see EcoStruxure™ Process Expert, Installation and Configuration Guide).
The following figure shows an example of the notification that appears for scenario 2. The name or
IP address and the port of the system server computer are indicated.

76 EIO0000001114 06/2020
 Starting and Quitting System Server and Clients

The following figure shows an example of the notification that appears for scenario 3.

The following figure shows an example of the notification that appears for scenario 4.

EIO0000001114 06/2020 77
Starting and Quitting System Server and Clients

The following figure shows an example of the notification that appears for scenario 4 in case you
are refining a Control project online.

After Re-establishing the Connection to the System Server

Clients automatically reconnect to the system server when the connection is re-established or
when the system server is running again. After reconnecting, clients display a notification to inform
you of the communication interruption. Unsaved changes are discarded and open windows are
reloaded or closed automatically.

If the system server has stopped, the notification panel is empty when the system server restarts.
To view the history of activity up to the interruption of the communication, open the log files
(see page 89).

78 EIO0000001114 06/2020
 Starting and Quitting System Server and Clients

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
LOSS OF COMMUNICATION
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.
Failure to follow these instructions can result in unresponsive clients.

You are able to resume using the software when the connection to the system server is re-
established or when it is running again.

Restarting Clients After Closing Unexpectedly

If an engineering client closes unexpectedly (for example, because the computer on which it is
running stopped working), you do not need to restart the system server. You can restart the client
after 60 seconds. This is the time that is required by the system server to terminate a client session,
which ended abnormally.
Restarting a client earlier may trigger messages about missing engineering client license, for
example.

EIO0000001114 06/2020 79
Starting and Quitting System Server and Clients

Quitting the Software

Overview
To quit the software, quit in the following order:
 Any clients that are connected the system server that you are stopping.
 The system server

To restart the system server, quit the software in the same order and the then start the system
server (see page 74).
You cannot quit a component if it is locked (see page 73).
NOTE: You are logged out of the software on a computer when you quit the last component to
which you were logged in on this computer.

Quitting Clients
When you quit a client, it does not close if any task is still in progress.
To quit a client, proceed as follows.

Step Action
1 Verify that any processes are finished executing by checking the information in the notification
panel.
2 Click the close button of the client window.
Result: The client window closes, disconnecting it from the system server.

80 EIO0000001114 06/2020
 Starting and Quitting System Server and Clients

Stopping the System Server

When you stop the system server, tasks in progress are completed before the server is stopped.
If any client is still connected to the system server, a notification is displayed, which indicates the
identity of the logged-in user by using the format full name (computer name).
You cannot use a client when the communication between the system server and the client is
interrupted, for example, when the system server is restarted or not running.

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 the system server, proceed as follows.:

Step Action
1 From the menu bar of the system server console, click Actions → Stop.
Result: A dialog box asking you to confirm the system server stop opens.
NOTE: If a client is still running, the full name of the user who is still logged in is displayed in
the dialog box.
2 If a client is still connected, click No; otherwise proceed to step 4.
Result: The dialog box closes without stopping the system server.
3 Quit the client (see page 80) and stop the system server again by starting over this procedure.
4 When no more client is connected, click Yes.
Result: The system server completes tasks in progress and then stops.
NOTE: Click No to close the dialog box without stopping the system server.

EIO0000001114 06/2020 81
Starting and Quitting System Server and Clients

82 EIO0000001114 06/2020
 EcoStruxure™ Process Expert
Multiuser Functionality
EIO0000001114 06/2020

Chapter 5
Multiuser Functionality

Multiuser Functionality

Multiuser Functionality

Overview
Several clients can connect to a system server simultaneously, allowing several users to work on
the same component or different components of a system at the same time.
For example, User A and User B can work on the application of the system, or User A can work on
the application and User B on the projects of the system. These operations could also be
performed by a single user.
In both cases, the software manages system-wide concurrent user access to editors and other
tools to preserve the integrity of data of the system.
It may allow you to view data by granting access to certain editors in read-only mode.
When a user is finished working on a system component (for example, an instance) by closing the
corresponding tool (for example, the Instance Editor), the software allows other users to access
components that manage or use data of that component.
As such, users do not need to check out or lock the component that they are working on.

Managing User Activity

At the following stages of the system engineering life cycle, the software indicates the status of
objects by using icons:
 Instantiation (see page 216)
 Project Definition (see page 380)

At any stage, when the command that you have selected cannot be completed, you can obtain
information about the reason through:
 Dialog boxes that clients display when you try to access system data that is being used or edited
by another user.
 Information in the notification panel on the activity of any user that is logged in to a client of the
same system server.

EIO0000001114 06/2020 83
Multiuser Functionality

Virtual Machine Usage Considerations

While the type and number of activated EcoStruxure Process Expert licenses dictate how many
clients can connect simultaneously to a system server, users may be restricted in the use of certain
commands that require services of a virtual machine (for example, the Refine command of the
Project Explorer). Each virtual machine provides access to a limited number of instances, and each
instance to a limited number of software Participant sessions.
For more information, refer to the topic describing virtual machine usage (see EcoStruxure™
Process Expert, Installation and Configuration Guide).

Examples
By using examples, the table illustrates some of the locking mechanisms that the software
implements when two users work on the same system.

Action executed by User A Examples of restrictions for User B

Editing properties of Instance A. Cannot edit Instance A but can open the Instance Editor
in read-only mode.
Can generate the section to which facets of Instance A are
assigned but the facets of Instance A are not generated. If
the section contains other facets, they are generated.
Information is displayed in the notification panel.
Refining the Control Participant project in the Cannot refine the same Participant project or any section of
Project Explorer. it. Information is displayed in a dialog box.
Cannot generate the same Participant project.
Cannot build the same Participant project.
Configuring a controller entity in the Topology Cannot configure the same controller entity.
Explorer.
Cannot do mapping (hardware and communication) of the
Control executable to which the engine is mapped.
Cannot build the Control Participant project executable to
which the engine is mapped.

NOTE: The locking mechanisms apply also when a single user is performing these operations (if
applicable).

84 EIO0000001114 06/2020
 EcoStruxure™ Process Expert
Action Traceability
EIO0000001114 06/2020

Chapter 6
Action Traceability

Action Traceability

Overview
This chapter describes how to obtain information related to the activity of the system server and
clients.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Notification Panel 86
Activity Log Files 89

EIO0000001114 06/2020 85
Action Traceability

Notification Panel

Overview
The notification panel allows you to view and trace engineering activity. The panel is displayed
automatically when you start an engineering client. You can modify its height and show column
headers.
The information that is displayed is the same for each engineering client that connects to the same
system server. When you open a second engineering client, you can see in its notification panel
the history of actions starting from the moment the first engineering client was opened.
Certain system server and virtual machine tasks are displayed also.
An entry is logged when you launch a task and it is updated as the execution of the task
progresses. When the task is complete, the status of the task and the actions that the software has
executed are indicated.
For each task, a color icon allows you to see the status at a glance.
At any time, the notification The information remains available while the system server to which the
client is connected is running. Closing the client or the notification panel does not delete the entries.
You can show/hide the notification panel from the engineering client toolbar (see page 115).

Information Availability
At any time, the notification panel can display a maximum of 2000 entries. When this limit is
reached, the most recent entries replace the earliest ones on a first-in first-out basis.
The information remains displayed while the system server to which the client is connected is
running. Closing the client or the notification panel does not delete the entries.

Aborting Tasks

When you select or confirm certain commands, the icon appears in the Action column of the
notification panel. You can click it to cancel the task. Once the task is near completion and cannot

be canceled anymore, the icon appears disabled . Only the user who has initiated the
command is allowed to abort it.
The possibility to abort and the behavior when you click the icon is described in the topics
documenting the commands for which the abort functionality is available. For example, the Paste
command (see page 239) of the Application Explorer.
Aborted tasks are identified in the notification panel in the Message column with (Aborted).
When you export data of the notification panel, it is the most recent subtask of the process that is
identified with Aborted in the Action column, not the task itself.

86 EIO0000001114 06/2020
 Action Traceability

Data Description
The table describes the data that is displayed in the notification panel.

Column header(1) Description

– Icons indicate the status of the task:

 Task in progress (spinning).

 Task completed successfully (green). Success(2)

 Task did not complete (red). Not successful(2)

 Task completed with notifications (yellow). Warning(2)

 Information (blue). Informational(2)

Start Time Date and time when the task was initiated.
Elapsed Time The time it took to complete the task independently of its final status.
Message Short description of the task that was executed. The status of the task is indicated
in brackets.
A task can have messages for subactions.
Expand the row by clicking the expand icon on the outer left of the row.
Action Keyword describing the action that was executed. Typically, this corresponds to the
command you selected.
User Name Name of the user who is logged in to the client from which the task was executed.
Format: Full name (Username)
Station Node Name of the PC on which the client from which the task was executed is installed.
System Identifier of the system in which the task was executed.
When the task is not related to a system, the entry is Global.
Domain Identification of the domain or project component on which the task was executed.
When the task is not related to a system component (for example, when a user logs
in), the entry is Global.
Entity Path Path the entity on which the task was executed.
Entity Type Type of the entity on which the task was executed.
Attribute Identifier of the modified attribute (if applicable).
Old Value Value of the attribute before the modification was performed (if applicable).
New Value Value of the attribute after performing and/or saving the modification (if applicable).

(1) To show column headers, right-click any row inside the notification panel and click Show Table
Headers. Headers are hidden by default.
(2) Corresponding keyword in the export file (see page 88).

EIO0000001114 06/2020 87
Action Traceability

Using the Notification Panel

For each task that you launch, it is good practice to verify in the notification panel if the task is
completed and its final status.
Select a task that has subentries and press Enter (or double-click it) to expand/collapse it.
Subentries provide more detailed information about the task.
NOTE: When performing activities on a large number of entities, expanding entries in the
notification panel may increase the response time of the engineering client temporarily. Such
activities can be, for example, importing or generating 500 or more objects at once.

Filtering and Sorting Activity Data

Use the filter function (see page 138) on columns to view, for example, only activity of one user by
filtering on the User Name column.
By default, the most recent activity is displayed at the top of the list.

Exporting Activity Data

To save the history of actions, export activity data on a regular basis and before stopping the
system server.
To export to file (.csv) activity data that is displayed in the notification panel covering a selected
period, proceed as follows.

Step Action
1 Right-click any row inside the notification panel and click Export.
Result: The Export dialog box opens.
2 In the Destination field, enter a file name and location, or use the default file name and location.
3 In the Period field, select a start date and time, and an end date and time to define the time span
of activity data to export.
NOTE: Only activity data that appears in the notification panel can be exported.
4 Click OK.
Result: The software creates the export file and opens the folder that contains it.
NOTE: Click Cancel to close the Export dialog box without exporting data.
NOTE: Click Reset to reset the values of the Destination and Period fields to their default values.

NOTE: If a file with the same name exists at the specified location, the software displays a dialog
box asking you for confirmation before overwriting the file.

88 EIO0000001114 06/2020
 Action Traceability

Activity Log Files

Overview
The software records the activity of each component (system server, engineering client, and
operation client) by using log files.
In addition, the software maintains a log file that records information related to activated licenses
for troubleshooting purposes.
The file size and number of files that the software maintains for each component is limited. This is
done to make the log files more user-friendly to view and to save space.
NOTE: For clients, the data that is logged is different from the activity data that is displayed in the
notification panel (see page 86).

Log File Location

Log files are located at the path
C:\Users\Username\AppData\Roaming\Schneider Electric\Process Expert x\Logs, where x
correponds to the major version of the software that is installed (the R• version suffix does not
appear).
Username corresponds to the username that was entered to log on to the current session of
Windows®, independently of the username that was entered to log in to the client (see page 70).

Log File Name Syntax

The names of log files have the following syntax: ComponentName.File number.log
Component names are:
 Server for the system server.
 Client for engineering clients.
 OperationClient for operation clients.
 License is used for license-related information.

File numbers:
 The most recent log file has no file number.
 The second latest log file has number 0.
 The log files thereafter have incremental numbers from 1 to 9 where 9 represents the earliest
log file containing the oldest information.
For example:
 Server.log is the current log file in which the software is recording server activity.
 Client.1.log is the log file in which the software recorded past engineering client activity.
The file content is not updated anymore because Client.log is currently recording activity.
Client.1.log was created when Client.log reached its size limit for the second time (the
first time, Client.0.log was created).

EIO0000001114 06/2020 89
Action Traceability

Log File Size

The size of any log file cannot exceed 4 Mb. When the size of a log file has reached this limit, the
software creates a new file. Existing log file numbers are incremented.

Number of Log Files

The software keeps up to 10 log files per component. When the software needs to create a new
log file because the current one has reached the size limit, and the number of files for a component
is reached, the software deletes the earliest file for that component before creating the new one.

90 EIO0000001114 06/2020
 EcoStruxure™ Process Expert
Software Capabilities
EIO0000001114 06/2020

Chapter 7
Software Capabilities

Software Capabilities

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Hardware and Software Capabilities 92
Supported Data Types 96
Naming Rules 98

EIO0000001114 06/2020 91
Software Capabilities

Hardware and Software Capabilities

Overview
The following describes the main hardware and software capabilities of EcoStruxure
Process Expert and additional capabilities of the embedded Control and Supervision software
Participants.
For more information on the specific capabilities of the Control Participant and Supervision
Participant, refer to the help of the respective Participants (see page 104).
Some capabilities and/or features may not be supported by the software.

Hardware Platforms
For information on the integrated and not supported hardware architectures, refer to Configuration
Stage (see EcoStruxure™ Process Expert, Control Participant Services, User Guide).
NOTE: You can include other hardware platforms in systems engineered by using the software,
however, the software will not provide any services for these platforms.

Programming Languages
The software generates the program for controllers by using the Function Block Diagram (FBD)
programming language.
The Control Participant supports additional programming languages (see page 94) for creating the
user program, which can be used together in Control projects managed by EcoStruxure
Process Expert.
The Supervision Participant supports a structured, proprietary programming language for
monitoring and controlling plant equipment, which can be used together in Supervision projects
managed by EcoStruxure Process Expert. For more information, refer to the Supervision
Participant help (see page 104).

Template Libraries
The software uses object-oriented modeling for the engineering of applications. For this purpose,
an extensive selection of Schneider Electric templates are provided in various libraries such as
templates modeling signals, hardware templates modeling the system infrastructure, up to
complex control module templates modeling the entire Control and Supervision functionalities of
process objects.
When a library is installed, the templates are available in the Global Templates Explorer and can
be used in explorers and editors specific to the software. The encapsulated Control and
Supervision constituents can be viewed in the corresponding software Participants.
For information on architectures, for which templates are available, refer to Supported Hardware
Architectures (see EcoStruxure™ Process Expert, Control Participant Services, User Guide).

92 EIO0000001114 06/2020
 Software Capabilities

Function and Function Block Libraries

The Control Participant includes an extensive library, which extends from blocks for simple boolean
operations, through blocks for strings and array operations to blocks for controlling complex control
loops.
For a better overview, the different blocks are arranged in libraries, which are then broken down
into families.
The blocks can be used in the Control Participant in the programming languages FBD, LD, IL, and
ST and be added to Control projects managed by EcoStruxure Process Expert.

Controller Program
In the software, the controller program is organized in:
 A Master task (MAST)
 A FAST task
 FBD sections, which are assigned to one of the defined tasks

By using the Control Participant, you can add to the controller program:
 Sections, which are assigned to one of the defined tasks
 AUX tasks (depending on the platform)
 Sections, which are assigned to AUX tasks
 Sections for processing time controlled events (Timerx)
 Sections for processing hardware controlled events (EVTx)
 Subroutine sections (SR)

The program components that are supported by the Control Participant, can be added to Control
projects managed by the software. However, not all of them can be viewed in the software outside
of the Control Participant (for example, non-FBD sections).

EIO0000001114 06/2020 93
Software Capabilities

Performance Scope
The table shows the main characteristics of the software and its Participants.

EcoStruxure Control Supervision

Process Expert Participant Participant
Programming languages
Function Block Diagram (FBD) + + –
Ladder Diagram (LD) – + –
Instruction List (IL) – + –
Structured Text (ST) – + –
Sequential Function Chart (SFC) – + –
Ladder Logic 984 (LL984) – + –
Cicode – – +
Schneider Electric Global Templates libraries
Foundation library + – –
General Purpose and segment libraries + – –
Function block libraries(1)
Standard library – + –
Control library – + –
Communication library – + –
Diagnostics library – + –
I/O Management library – + –
System library – + –
Obsolete library – + –
Memory card file management library – + –
General information
Project browser/explorer + + +
Template explorer + – –
Instance editor + – –
Create and modify object templates + – –
Access control + + +
Simulator - + –
Context-sensitive and PDF help + + +

94 EIO0000001114 06/2020
 Software Capabilities

EcoStruxure Control Supervision

Process Expert Participant Participant
Control
Encapsulate DFB constituents in templates + – –
Create and use data structures (DDTs) + + +
Create and use derived function blocks (DFBs) – + –
HMI operator screens – + –
Supervision
Encapsulate tags and genies in templates + – –
Design pages, genies, face plates – – +
Use tags and alarms + – +
Clusters + – +
Server and client events – – +
I/O devices + – +
I/O, alarm, trend, and report servers + – +
Redundancy + – +
Load balancing (operation servers) + – +

+ Available
(1) Availability of the function blocks depends on the hardware platform.
– Not available

EIO0000001114 06/2020 95
Software Capabilities

Supported Data Types

Data Type Conversion

The software may use data types that are different from the types used by the Control Participant
(see EcoStruxure™ Process Expert, Control Participant Services, User Guide).
The conversion to Participant-supported types is done automatically.

Standard Data Types

The software uses the following data types.

Data Type Description Lower Limit Upper Limit Size

DateTime A specific instance in 19-01-01 00:00:00.000 2100-12-31 23:59:59.999 8 bytes
time(1).
Date A Gregorian calendar 1900-01-01 2100-12-31 8 bytes
date(1).
Time An instant of time that 00:00:00.000 23:59:59.999 8 bytes
recurs every day(1).
hh:mm:ss.ms
Duration A duration of time as 0 9,223,372,036,854,775,807 8 bytes
specified by Gregorian in ticks
day, hour, minute, second,
NOTE: 1 tick = 100 ns
and millisecond
components(1).
D.hh:mm:ss.ms
Example: 1.05:10:30.245
If the value contains no
day or ms component, they
are not shown as 0 values.
For example: 11:20:30 is
displayed to represent
0 days, 11 hours, 20 min.,
30 sec., and 0 ms.
String A sequence of unicode 1 character of the standard n characters of the standard 1 character =
characters. ASCII table. ASCII table. 1 byte
Boolean A binary logic value. False True 1 byte
Float Represented by using the From approximately From approximately 4 bytes
32-bit single-precision -3.4 x 1038 to -1.5 x 10-45 1.5 x 10-45 to 3.4 x 1038
IEEE 754 format(1).
7-digit precision.
(1) Microsoft® Windows® Regional Options may apply to the format of the type.

96 EIO0000001114 06/2020
 Software Capabilities

Data Type Description Lower Limit Upper Limit Size

Double Represented by using the From approximately From approximately 8 bytes
64-bit double-precision -1.7 x 10308 to -5.0 x 10-324 5.0 x 10-324 to 1.7 x 10308
IEEE 754 format(1).
15 to 16-digit precision.
Decimal A fixed-point decimal value 0.0001 922337203685477.5807 12 bytes
with arbitrary precision(1).
A maximum of 4 digits are
allowed after the decimal
separator.
Byte 8-bit signed integer. -128 127 1 byte
Short 16-bit signed integer. -32768 32767 2 bytes
Integer 32-bit signed integer. -2,147,483,648 2,147,483,647 4 bytes
Long 64-bit signed integer. -9223372036854770000 9,223,372,036,854,774,807 8 bytes
UnsignedByte 8-bit unsigned integer. 0 255 1 byte
UnsignedShort 16-bit unsigned integer. 0 65,535 2 bytes
UnsignedInt 32-bit unsigned integer. 0 4,294,967,295 4 bytes
UnsignedLong 32-bit unsigned integer. 0 18446744073709551615 4 bytes
(1) Microsoft® Windows® Regional Options may apply to the format of the type.

User-Defined Data Types

Data Type Description Lower Limit Upper Limit Size

Enum An enumeration value – – –
is stored as String.
Variant Any data type. – – –

EIO0000001114 06/2020 97
Software Capabilities

Naming Rules

Overview
When you change default parameters such as identifiers or Supervision element properties,
EcoStruxure Process Expert validates at different stages of the system engineering life cycle if they
satisfy the naming rules that are described in this topic.
These rules can apply at the platform level and/or can be Participant-specific.
NOTE: Other Participant specific rules may apply; however the software does not validate them.
For more information, refer to the respective Participant help (see page 104).

Folder Identifiers
Folder identifiers:
 Can start only with a letter or the $ character.
 Can contain only letters, digits, underscores, the $ character, and spaces(1).
These rules apply to the following types of folders:
 System folders
 Application folders
 Global Templates folders
 Content containers of the content repository.

Instance Identifiers
Instance identifiers can contain only letters, digits, and underscores.
The maximum character length is set through the Validation property (see EcoStruxure™
Process Expert, Global Templates, Reference Manual) of the $InstanceID parameter of the
template that the instance uses.
NOTE: Participants do not accept the use of certain reserved words for object names (for example,
DO for the Supervision Participant). While the software allows using these reserved words as
identifiers of instances in the application, doing so may prevent the corresponding Participant
project from generating successfully when the reserved word is used as name of Participant project
items (for example, equipment (see page 496)).

Topological Entity, Device and Folder Identifiers

Topological entity, device, and folder identifiers:
 Can start only with a letter.
 Can contain spaces(1).
 Cannot contain any special character other than underscore (_).
 Cannot exceed 32 characters in length.

98 EIO0000001114 06/2020
 Software Capabilities

Control and Supervision Participant Project Identifiers

Identifiers of Control and Supervision Participant Projects, and of their components:
 Can start only with a letter.
 Can contain spaces(1).
 Cannot contain any special character other than underscore (_).
 Cannot exceed 32 characters in length.

Variable Names and Section Identifiers

Names of variables and identifiers of sections that are managed by the Control Participant, must
satisfy the following rules:
 Maximum length: Refer to the maximum length of identifiers as specified under Implementation-
Dependent Parameters in the IEC 61131-3 standard (Appendices of the Languages Reference
manual in the Control Participant help).
 Permitted characters: Refer to naming conventions in the glossary of the Control Participant
help, Operating Modes.
Refer to the topic describing data validation before generating (see page 446).

Supervision Cluster Identifiers

Identifiers of Supervision clusters cannot exceed 16 characters in length.

Supervision Page Identifiers

Identifiers of pages must satisfy the following rules:
 Maximum length: 64 characters
 Can contain spaces(1).
 Cannot contain these characters: \ / : * ? " < > |
(1) The software automatically removes leading and trailing spaces.

EIO0000001114 06/2020 99
Software Capabilities

Supervision Field Lengths

For variable tags:

Rule Field Value

Maximum field length Item Name 79
Address 254
Raw Zero Scale 11
Raw Full Scale
Eng Zero Scale
Eng Full Scale
Eng Units 8
Format 11
Comment 254
Deadband 11
DataType 16

For trend tags:

Rule Field Value

Maximum field length Item Name 79
Expression 254
Trigger 11
Format 11
File Name 253
No. Files 4
Comment 254
Period 32
Storage Method 64
Type 32
Eng Units 8

For advanced alarm tags:

Rule Field Value

Maximum field length Custom1... to Custom8... 64
Paging Group 80

100 EIO0000001114 06/2020

 Software Capabilities

For digital alarm tags:

Rule Field Value

Maximum field length Comment 254
Custom1... to Custom8... 64
Paging Group 80

For reports (and facets assigned to ServerEvents containers):

Rule Field Value

Maximum field length Report Name 79
Output Device 16
Report Format File 253
Comment 48
Area 16
Action 16
Trigger 254
Time 32
Period 32

For events (and facets assigned to ClientEvents containers):

Rule Field Value

Maximum field length Name 16
Trigger 254
Event (Action) 64
Comment 48
Time 32
Period 32

EIO0000001114 06/2020 101

Software Capabilities

Supervision Fields Special Characters

The table describes the rules that the software validates during generation with regard to the
contents of the following field.

Field Rule
Name Tag names need to have the following syntax:
[<alpha> | '_'] *[<alpha> | <digit> | '\' | '_']
 Tag names need to begin with either an alpha character (A-Z or a-z) or the underscore.
 Any following characters need to be either of:
 alpha characters (A-Z or a-z)
 digits
 \
 _ (underscore)
 | (vertical bar)

If you use any other character, the compile process cannot complete successfully.
NOTE: Tag names can only begin with a digit only if the [General]TagStartDigit
parameter of the citect.ini file is set to 1 (the default value is 0).

102 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Using the Help
EIO0000001114 06/2020

Chapter 8
Using the Help

Using the Help

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Software Participant Help 104
Using Help for Different Versions of Schneider Electric Templates 105
Help on User-Created Templates 108

EIO0000001114 06/2020 103

Using the Help

Software Participant Help

Overview
You can open the HTML help of a Participant by clicking Help or the ? button in the menu of the
Participant when the Participant window is open (for example, after you click Configure in the
context menu of a topological entity).
You can open the same help also from the Help EcoStruxure Process Expert dialog box without
having to open the Participant. To access the dialog box, click the ? button in the toolbar of a client.
Help is available for these Participants:
 The Control Participant
 The Advantys Configuration Software (ACS)
 The Supervision Participant

NOTE: ACS is used to configure STB islands during the configuration stage. For simplicity, in this
manual ACS is assimilated to the Control Participant.
NOTE:
The dialog box lets you also open:
 The help describing how to use the Modicon IEC 61850 Configuration Tool.
 The help of OPC Factory Server.
 The help of OPC UA Server Expert.

Opening the Help of a Participant

To open the help of a Participant from a client window, proceed as follows.

Step Action
1 In the toolbar (see page 115) of the client window, click the help button (?).
Result: The Help EcoStruxure Process Expert dialog box opens.
2 In the Software Participant Help section, double-click a Participant name.
Result: The HTML help of the Participant opens in a separate window.

104 EIO0000001114 06/2020

 Using the Help

Using Help for Different Versions of Schneider Electric Templates

Overview
For the templates that are included with the software, each software version contains only one
version of each template (the latest) and installs the help only for this version. This overwrites the
help of an existing previous version if you are upgrading the software. The help is provided in
compiled HTML (CHM) format.
However, your application can contain several versions of a same template, for example, if you
have migrated your database and have imported a later version of the template afterwards.
Starting from V4.3 of the software (Process Expert), you have the possibility to retain the help that
is included with any version of the software to continue using it after you upgrade to a later version.
By verifying the version of a template when you use the context-sensitive help button, the software
opens the help for this version if available.
This topic provides recommendation when using several versions of the help and describes how
to proceed.
NOTE: For more information on how to obtain help on templates, refer to the topic describing how
to open context-sensitive help.

Considerations When Using Several Versions of the Help

The help of a given version of the software documents the templates and functionalities provided
by this version only.
If you open the help for a given template and then, within the same help window, you look up
another template or a platform functionality, it may be that the version of the template or the
functionality that is documented differs from the version/functionality that you are using.
This can be the case, for example, if:
 You have migrated your database and have not updated the template used by instances of the
Application. In this case, the help that is provided may document a later version of templates.
 You are opening the help of an earlier version of the software. In this case, the templates that
are available in the library and the functionalities provided by the platform may be of a later
version than those documented.
Schneider Electric recommends the following:
 Open the help for a template only by using the context-sensitive help button, which takes into
consideration the version of the template that you are selecting.
 Do not view the help for another template or platform functionality within the help window that
you had opened for a template.
 Verify the version of the help you are viewing and which is indicated in the title of the help
window.

EIO0000001114 06/2020 105

Using the Help

Location of the HTML Help Files

On the computer running the engineering client, the help files are located in the User Guides folder
at the path C:\Program Files\Schneider Electric\EcoStruxure\Process Expert.
The User Guides folder also contains ContextualHelpRepository.* files, which are required for the
context-sensitive help on templates to work.

Preserving the Current Help Files Before Upgrading the Software

So that the help of the installed version of the software remains available after you upgrade to a
later version, before proceeding with the upgrade, you need to copy the complete set of help files
and their auxiliary files to a specific location on the computer running the engineering client.
Proceed as follows.

Step Action
1 Create the following folder structure if it does not exist yet: %localappdata%\Schneider
Electric\Process Expert\User Guides.
NOTE: By default, the value of the %localappdata% environment variable is
C:\Users\username\AppData\Local.
A Process Expert x folder, where x corresponds to the installed major version (the R• version
suffix does not appear), may already exist in the Schneider Electric folder but do not use it.
2 In the User Guides folder, create a subfolder with a name containing the number of the current
version. For example, Template Help Files Vx.
Mentioning the version helps you identify for which version of the software you are opening the
help in case the same template version is provided and documented in different versions of the
software.
3 Copy all the files contained in the User Guides folder (see page 106) to the subfolder that you
have created in step 2.

106 EIO0000001114 06/2020

 Using the Help

Opening the Help for Templates of an Earlier Version

To open the help of a template for which several versions exist, proceed as follows.

Step Action
1 Click the context-sensitive help button in the toolbar (see page 115) of the engineering client and
select a template, an instance of a template, or a facet of an instance of a template.
Result: The software verifies the version of the template and opens:
 The help of the current version from the default location if the template is provided in the
current version of the software.
 The help of the earlier version of the software in which the template was provided (given you
have copied the necessary help files to the required location (see page 106)).
Only one help window opens at a time.

NOTE:
 If the version of the template was provided with a version of the software for which the help is
not present on the computer, not at the required location, or incomplete, no help is shown.
 If the version of the template was provided in both the current and the earlier version of the
software, the Contextual Help Conflict dialog box opens, which lets you select which version of
the help you want to open.

EIO0000001114 06/2020 107

Using the Help

Help on User-Created Templates

Overview
You can configure the software to open the help in CHM format of a user-created template.
You can also manage the HTML help files of several versions of the same template so that clicking
a given version of the template opens the corresponding help.
Only one help window opens at a time.
This topic describes the prerequisites and the steps you need to perform. It does not describe how
to create HTML help files in CHM format.
NOTE: By using this feature, you can also associate your own HTML help to a Schneider Electric
global template in addition to the existing help. You can then select which one you want to open.
NOTE: You can also associate help files to templates and their instances that operators can open
from the operation client when using runtime navigation services (see EcoStruxure™
Process Expert, Runtime Navigation Services , User Guide ).

Prerequisites
The following are the prerequisites to be able to open help for user-created templates:
 You need to have help files documenting user-created templates in the Microsoft® compiled
HTML format (.chm).
For more information on creating a help project, refer to the Windows® online help.
 You need to know the topic ID (see page 109) of the topic documenting the template, which you
want to open when you use the context-sensitive help button of the engineering client. If the help
file (.chm) documents several templates, you need to have the topic ID that corresponds to each
template.
For more information on topics, refer to the Windows® online help.

108 EIO0000001114 06/2020

 Using the Help

Creating a Repository for Help Files of User-Created Templates

So that the help of user-created templates remains on the computer and can be opened after you
upgrade the software to a later version, you need to copy your complete set of help files and the
ContextualHelpRepository.xml file to a specific location on the computer running the engineering
client.
Proceed as follows.

Step Action
1 Browse to %localappdata%\Schneider Electric\Process Expert\User Guides.
NOTE: By default, the value of the %localappdata% environment variable is
C:\Users\{username}\AppData\Local.
2 In the User Guides folder, create a copy of the folder named Sample-Tobecopied in the same
location and rename it by using a meaningful name describing its contents and the version of
the software that was used to create the template. For example, <MyReactor Template Help
Files for V2020>.
NOTE: You can create as many copies of this folder as needed in case you want to keep the
help files of different templates in distinct folders.
3 Copy all your help files to the subfolder that you have created in step 2.

NOTE: Uninstalling the software removes the folder named Sample-Tobecopied but not the
copies of it.

Identifying the ID of a Topic Inside a CHM Help File

The procedure describes how to identify the ID of a topic inside a CHM help file.

Step Action
1 Open the user-created HTML help,
2 Select the topic (page) that you want to open when using the context-sensitive help button on
the template and right-click somewhere on the page.
Result: The context menu of the page opens.
3 Select Properties.
Result: The Properties dialog box opens.
4 Copy the topic ID.
The topic ID of the page is the part of the string that starts after ::/ in the Address (URL)
attribute.
For example, if the Address (URL) attribute is
mk:@MSITStore:C:\PROGRA~2\XMLNOT~1\Help.chm::/Overview.htm, the topic ID is
Overview.htm.

EIO0000001114 06/2020 109

Using the Help

Editing the XML File

To edit the ContextualHelpRepository.xml file, proceed as follows.

Step Action
1 In the folder (see page 109) to which you have copied your help files, open the
ContextualHelpRepository.xml file by using Notepad or an XML editor software.
Result: The file that opens contains the following entry, which serves as an example only.
<ContextualHelp Version="1.0">
<Item HelpKey="MyMotor3" FileName="PELbPrTp" MappingId="PELbPrTp_D-SE-
0014236.htm" FileType="CHM" Description="" Version="2.7.2"/>
</ContextualHelp>
2 Edit the following parameters of the entry:
 HelpKey: Is the identifier of the user-created template.
 FileName: Is the name of the CHM file without file extension.
 MappingId: Is the ID (see page 109) of the topic in the CHM file that documents the user-
created template. Include the .htm file extension.
 FileType: Do not edit this parameter. Default value: CHM.
 Description: Optional. You can enter a short description by using free form text. It is used
to describe the entry in the XML file and can appear in the Contextual Help Conflict dialog
box (see page 107). To use no description, leave it as "".
 Version: Is the version of the user-created template as it appears in the Global Templates
Explorer or in the Templates Browser pane of the Application Explorer.
3 Add a new entry for each user-created template for which you want help to open.
To manage the help for different versions of the same template, refer to the next topic
(see page 111).
NOTE: The </ContextualHelp> element must be the last entry in the file.
4 Save your changes.

110 EIO0000001114 06/2020

 Using the Help

Updating the Help for a New Version of a User-Created Template

The table describes the actions that you need to perform when you create a new version of a
template and want help to open for the various versions that exist. Two versions of a template are
used as an example. MyReactor 1.0.0 is considered the previous version and
MyReactor 1.0.1 the new version.

An updated help Action Comment

file is available to
document the
new version
No 1. In the folder (see page 109) to which you have copied your The same help file opens when
help files, edit the ContextualHelpRepository.xml file. you use the context-sensitive help
2. Add a new entry that corresponds to the new version of the button on MyReactor 1.0.0 or
template by using the same parameter values as for the MyReactor 1.0.1.
previous version; except for Version, which needs to If you remove the entry for
correspond to the version of the new template. template version 1.0.0, help
cannot open when you select it.
Yes 1. Browse to the User Guides folder (see page 109) located Clicking either template version
at the path %localappdata%\... when context-sensitive help is
2. Create a copy of the folder in which the help files of enabled opens the help file that is
MyReactor 1.0.0 and the located in the folder, which also
ContextualHelpRepository.xml file are located. contains the XML file with an entry
3. Rename the copy of the folder by using a name that allows of the same template identifier and
you to distinguish the previous and the new version. version.
For example, <MyReactor 1.0.1 Template Help Files for NOTE: It is assumed that the help
V2018>. file name and the topic ID are
4. In this folder, edit the entry in the identical for both template
ContextualHelpRepository.xml by modifying the value of versions.
Version to be equal to the new version (for example,
Version="1.0.1".

EIO0000001114 06/2020 111

Using the Help

Opening the Help for User-Created Templates

To open the help of a user-created template, proceed as follows.

Step Action
1 Click the context-sensitive help button in the toolbar (see page 115) of the engineering client and
select the user-created template.
Result: The software verifies the version of the template and opens the corresponding help file
according to your configuration (see page 110).

NOTE:
 If the value of any parameter in the ContextualHelpRepository.xml file is incorrect (except for
description), if the ContextualHelpRepository.xml file is missing or its location incorrect, or if the
location of the folder containing the help files and the XML file is incorrect, no help is shown.
 If the template identifier and version appear in more than one ContextualHelpRepository.xml file
contained in different subfolders of the User Guides folder, the Contextual Help Conflict dialog
box opens, which lets you select from which location you want to open the help.

Associating Other HTML Help Files to Schneider Electric Global Templates

By using an example, this topic describes how to associate your own help file in CHM format to a
sample control module template of a Global Templates library for which the EcoStruxure
Process Expert help is already available.
The data used for the example is the following:
 Control module template: $Motor version 1.0.0.
 Name of your help file: MyMotorHelp.chm
 ID of the topic that you want to open: mymotor_description.htm

The table describes the steps that you need to perform to implement the help and select, which file
to open.

Step Action
1 Create a repository for your help (see page 109) and copy the MyMotorHelp.chm file to this
folder.
2 Edit the ContextualHelpRepository.xml file (see page 110) located in this folder and add the
following entry before the </ContextualHelp> element.
<Item HelpKey="$Motor" FileName="MyMotorHelp" MappingId="mymotor_description.htm"
FileType="CHM" Description="" Version="1.0.0"/>
3 Click the context-sensitive help button in the toolbar (see page 115) of the engineering client
and select the $Motor template version 1.0.0, and instance, or facet of it.
Result: The Contextual Help Conflict dialog box opens and shows the two help files that are
associated to the template: The EcoStruxure Process Expert help and your help.
4 Select the help file that you want to view and click OK.

112 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
User Interface
EIO0000001114 06/2020

Chapter 9
User Interface

User Interface

Overview
This chapter describes the engineering client user interface, its main components, and the
common tools that allow you to engineer and navigate a system.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Engineering Client User Interface Description 114
About Dialog Box 117
Engineering Client and Explorer Work Areas 118
Organizing Work Areas 122
Working with Panes 127
Using Menus 133
Software Participant Windows 134
Filtering and Sorting Data 138
Keyboard Shortcuts 142

EIO0000001114 06/2020 113

User Interface

Engineering Client User Interface Description

Overview
When you start the engineering client, it opens one main work area in which the various explorers
and editors are displayed.
The engineering client user interface is composed of five main elements:
 The client toolbar
 The tabs bar of the main work area
 Explorer windows
 The Notification Panel

You can divide the main work area (see page 123) of the engineering client.
The explorer that opens when a client is started depends on the group (see EcoStruxure™
Process Expert, Installation and Configuration Guide) that the logged-in user is a member of.

User Interface Description

The following figure shows an example of the engineering client user interface.

114 EIO0000001114 06/2020

 User Interface

1 Engineering client toolbar

2 Tabs bar showing the tabs of the explorers and editors that are open
3 Systems Explorer window
4 Workspace of the Systems Explorer
5 Notification Panel

Engineering Client Toolbar Description

The following figure describes the toolbar of the engineering client.

Item Description
1 Opens the Systems Explorer window (see page 158), which lets you create, organize, and navigate
systems.
From the Systems Explorer you can open the explorers that are needed to create and manage system
components:
 Application Explorer
 Project Explorer
 Topology Explorer

2 Explorer navigation buttons to open or show the explorer of a system.

From left to right:
 Topology Explorer
 Application Explorer
 Project Explorer

Clicking a button opens the corresponding explorer for either:

 The system that is selected in the Systems Explorer when this explorer is active.
 The system for which an explorer or editor is active. For example, if the Assignment Editor for
System_1 is active, clicking the first button opens/shows the Topology Explorer for System_1.
If the explorer is already open, it is shown.
NOTE: Navigation does not work from the Global Templates Explorer nor the Contents Repository
by using these buttons.
3 Opens the Content Repository explorer (see page 1022), which contains files related to Global
Templates and the systems that you are engineering.
4 Opens the Global Templates Explorer (see page 932), which you can use to browse and manage
templates of the Global Templates library.
NOTE: In this example, the button is shown unavailable because the role of the logged-in user
(see page 70) does not have the permission to use this explorer.

EIO0000001114 06/2020 115

User Interface

Item Description
5 Opens the Notification Panel (see page 86).
6 Opens the About EcoStruxure Process Expert dialog box (see page 117).
7 Opens a dialog box, which lets you access:
 The global software HTML help. It describes how to install, license, and use the software as well
as the Global Templates that are included with it.
 The global help of each software Participant (see page 104).
 Other help files.

Double-click an entry to open the corresponding help.

8 Opens the HTML help at the topic describing the system engineering life cycle and the system creation
workflow.
It gives you an overview of the various stages of the life cycle and helps you identify what is the next
step that you need to complete.
9 Opens context-sensitive HTML help.
Clicking the button enables context-sensitive help and a question mark appears next to the cursor.
Selecting an item opens the help when available. If no help is available for the selected item, the
functionality is disabled.
To disable the functionality while the question mark is shown next to the cursor, press Esc.
For an overview of UI items for which context-sensitive help is available, refer to the topic describing
how to open context-sensitive help.
10 Full name of the logged-in user and name of the computer running the system server to which the
client is connected. If the full name is not defined, the username appears instead.
11 Opens the User menu, which contains the following commands.
Lock Locks (see page 73) the components to which you are logged in on the local
computer.
User Opens the User Information dialog box (see EcoStruxure™ Process Expert,
Information Installation and Configuration Guide).
Log In/Log Out Lets you log in or out (see page 70) of the software.

116 EIO0000001114 06/2020

 User Interface

About Dialog Box

Opening the About Dialog Box

To open the dialog box, click:

 The icon in the toolbar of the engineering or operation client (see page 115).
 Help → About in the menu bar of the system server.

General Tab
The General tab displays information related to:
 Installed EcoStruxure Process Expert and third-party software versions.
 The activated application size license and the total instance count for your database.
 The installation and expiration dates of entity certificates (see EcoStruxure™ Process Expert,
Installation and Configuration Guide) installed on the local computer and of the corresponding
root CA.
If no entity certificate is installed, no information is shown.

System Details Tab

The System Details tab displays the instance count by system (see page 198) for the mounted
database.

Client Details Tab

The Client Details tab displays information about the clients that are currently connected to the
system server with a user being logged in. It shows the computer name, user name, and the type
of client.

Support Tab
Contains the contact information of the Schneider Electric support.
The Logs Folder link lets you access the activity log files (see page 89).

Hotfix Details Tab

The Hotfix Details tab displays information about installed hotfixes.
If no hotfix is installed, the tab is hidden.

EIO0000001114 06/2020 117

User Interface

Engineering Client and Explorer Work Areas

Overview
By default, in an engineering client only one work area is visible at a time.
The work area is the display area that is below the tabs bar (see page 114) where explorers and
certain editors open, such as the Systems Explorer and Composite Editor.
Certain explorers (for example, the Application Explorer or Project Explorer) also feature a work
area in which various windows and editors open, such as Properties windows or the Instance
Editor.
You can create additional work areas (see page 123) and organize them.
NOTE: When no window opens in the work area, it is called a workspace. This applies to editors
and certain explorers (for example, the Global Templates Explorer).
The following figure shows an example of the work area of the Application Explorer.

1 Tab of the Application Explorer.

2 Toolbar of the explorer.
3 Panes of the explorer, which are open in the work area.
4 Remaining work area of the explorer in which a window and an editor are open. You can select
them by using their tab.
5 Workspace of the editor.

118 EIO0000001114 06/2020

 User Interface

Tabs Bar Description

For each window, explorer, or editor that you open in a work area, a tab is displayed in the tabs
bar, which features:
 An icon representing the type of window, explorer, or editor (for example, Properties window,
Application Explorer, or Links Editor).
 The identifier of the system that is displayed in the corresponding window (except for the
Contents Repository, Global Templates, and Systems Explorer).
 A button to close it.

You can rearrange the order of tabs on the tabs bar by dragging them to a new position.
NOTE:
 Closing the last tab in a tabs bar closes the work area (except if the work area is the last one to
be open).
 You cannot close the last tab of the last work area that is open.
 To close all windows except one, right-click the tab of the window that you want to leave open
and select Close Other Tabs.
The following example describes the tabs bars of the engineering client in which two work areas
are open.

Item Description
1 Main work area.
2 Additional work area.
3 Display all Tabs button.
Displays a list of the tabs that are open in this work area.
4 Inactive tab.

EIO0000001114 06/2020 119

User Interface

Item Description
5 Maximize/Restore Down button.
The button is available when more than one work area (see page 122) is open. It maximizes the
work area in the window or reverts the display to a multiple work area view.
NOTE: When you maximize a work area, the other open work areas are hidden. Use the
Restore Down button to show them again.
6 Button to close the work area.
The button is available when more than one work area (see page 122) is open. It allows you to
close the other work areas.
You cannot close the main work area.
NOTE: Closing the last tab in a work area closes it.
7 Scroll left button.
Click the button to view hidden tabs that are to the left of the first tab. The scroll increment is one
tab.
8 Active tab.
9 Scroll right button.
Click the button to view hidden tabs that are to the right of the last tab. The scroll increment is
one tab.

Moving the Workspace (Panning)

In editors (for example, the Links Editor), click an empty area of the workspace and hold down the
left mouse button. The pointer turns into a hand icon. You can now drag the workspace in any
direction by moving the pointer. This is useful to view items that are outside the visible workspace.
In certain explorers (for example, the Global Templates Explorer), you can use the following
methods to move the workspace.

Action Direction in which the workspace is moved

Mouse wheel up Down
Mouse wheel down Up
Shift + Mouse wheel down Left
Shift + Mouse wheel up Right

120 EIO0000001114 06/2020

 User Interface

Magnifying and Reducing the Workspace View

To magnify or reduce the workspace view gradually, use the following method.

Ctrl + Mouse wheel up Zoom in.

The position of the pointer becomes the center of the magnification.
Ctrl + Mouse wheel down Zoom out.
The position of the pointer becomes the center of the reduction.

NOTE:
 A zoom selection menu may be available at the bottom of some workspaces. You may also be
able to use the radar view.
 In some workspaces, starting out from the default zoom level, you can only zoom in.
 Zooming out beyond a certain level may switch the display to simplified view (see page 973).

Selecting Multiple Items

The method to select multiple items varies depending on the editor or explorer you are working in:
 In editors (for example, template editors), you can select multiple items in the workspace by
using either or a combination of the following methods:
 Select an item with the pointer, press and hold Ctrl, and select other items.
 Press and hold Ctrl, click the workspace, and hold down the mouse button. Then, drag the
pointer to draw a rectangle. Items that overlap with the rectangle are selected when you
release the mouse button. Last, release Ctrl.
 In explorers, browsers, and various containers, you can select multiple items by selecting an
item with the pointer, pressing and holding Ctrl, and selecting other items. To select contiguous
items, select the first one, press and hold Shift and select the last item. Release Shift.
To unselect an item, press Ctrl and click the item.
NOTE: While you are still holding Ctrl, click a selected item again to unselect it.

EIO0000001114 06/2020 121

User Interface

Organizing Work Areas

Overview
To work more effectively, you can customize the client UI by creating additional work areas
(see page 123) left, right, or below the main one. Inside each work area you can open various
explorers and editors.
Each work area has its own tabs bar (see page 119) and toolbar (if available).
NOTE: You can also divide the work area of explorers (see page 125).
The following figure shows an example of an engineering client UI that is divided into three work
areas.

122 EIO0000001114 06/2020

 User Interface

Viewing Client Windows on Separate Monitors

To open a new window for the same client, so that you can view it on a separate monitor, proceed
as follows.

Step Action
1 Verify that, at least, two windows are open in the same or separate work areas.
For example, the Systems Explorer and the Project Explorer windows.
2 Right-click the tab of a window in the tabs bar and select Open in new Window.
Result: The tab opens in a second, separate client window.
3 Drag any of the two client windows to the other monitor.

NOTE:
 You can repeat the procedure from any tab of either client window given that two tabs are open
in the work area. (The functionality is not available for tabs that are open inside the Application
Explorer or Project Explorer.)
 Notifications about actions that you perform in the additional client windows appear in the
Notification Panel of the main client window.

Creating Additional Work Areas

You can create a new work area with an already open explorer by using the docking tabs. The new
work area opens on the left, right, or at the bottom of the existing one depending on which docking
tab you use.
Once you have created several work areas, you can:
 Drag tabs from one work area to the other.
 Reposition work areas by using the docking tabs.

Refer to the topic describing the tabs bar (see page 119) for information on how to manage
windows inside a work area.

EIO0000001114 06/2020 123

User Interface

The following figure illustrates the use of the external docking tabs to create a new work area.

Example of result when you use the bottom docking menu.

124 EIO0000001114 06/2020

 User Interface

To open a new work area, proceed as follows.

Step Action
1 Verify that at least two explorers are open in the work area.
2 Drag a tab from the tabs bar towards the side of the work area where you want to create the new one.
Result: The explorer follows the pointer and the external docking tabs appear.
3 Keep dragging the pointer over the docking tab where you want the new work area to open and
release the mouse button.
Result: A new work area, which contains the explorer opens at the selected location.
NOTE: To cancel the operation, drag the pointer away from the docking tab and release the mouse
button.

Creating Additional Work Areas in Explorers

When several windows are open in the work area of the Application Explorer or Project Explorer,
you can create additional work areas by dragging either of the windows to a docking tab.
Refer to the topic describing the tabs bar (see page 119) for information on how to manage
windows inside work areas.
NOTE: You cannot create a new work area with the pane of an explorer. Refer to the topic
describing how to work with panes (see page 127).
The following figure illustrates the use of the external docking tabs to create a new work area inside
the Application Explorer.

EIO0000001114 06/2020 125

User Interface

The following figure shows an example of the Application Explorer with two work areas that are
open.

To open a new work area, proceed as follows.

Step Action
1 Verify that at least two windows or editors are open in the work area of the explorer.
2 Drag a tab towards the side of the work area where you want to create the new one.
Result: The item follows the pointer and the external docking tabs appear.
3 Keep dragging the pointer over the docking tab where you want the work area to open and
release the mouse button.
Result: A new work area, which contains the window opens at the selected location.
NOTE: To cancel the operation, drag the pointer away from the docking tab and release the
mouse button.

126 EIO0000001114 06/2020

 User Interface

Working with Panes

Overview
The software displays panes in various explorers and editors.
You can minimize them automatically when you do not need to see them, resize, and move them
as required.

Pane Description
The following figure shows a partial view of two panes in the Application Explorer.

EIO0000001114 06/2020 127

User Interface

The following figure shows a floating pane. The pin button is not available.

1 Pane that is pinned and always visible.

2 Pane that is minimized to a tab.
3 Extract/retract button. Turns it into a floating pane that you can dock or returns a pane to its
previous position (docked or tabbed).
4 Pin button. Lets you show and hide the pane.

Minimizing, Showing, and Restoring Panes

To minimize, show, and restore a docked or tabbed pane, proceed as follows.

Step Action
1 Click the pin button in the title bar of the pane.
Result: The pin button is displayed in a horizontal position and the pane will be minimized to the
edge of the screen as a tab.
2 Move the pointer over the tab.
Result: The pane is shown entirely while the pointer is inside the pane.
NOTE: Click inside the pane so that it remains visible even you move the pointer away from it.
Click outside the pane to minimize it again as a tab.
3 Click the pin button again.
Result: The pin button is displayed in a vertical position and the pane is restored. If there are
several overlapping panes, it may be shown only partially.

128 EIO0000001114 06/2020

 User Interface

Extracting Panes
To make a pane floating, click the extract button or drag it by the title bar.
When panes are docked on top of each other so that their tabs appear at the bottom, dragging
either pane by its title bar extracts the complete group. To extract only one pane, drag it by its tab
or use its extract button.

Docking Panes
You can move docked panes to another area of the workspace or dock floating panes by using the
external docking tabs (see page 123).
When the workspace contains more than one pane and you drag one pane on top of the other, a
docking menu appears in the center of the other pane. It lets you position panes in a relative
position to each other.
The following figure shows the docking menu.

1 The up, right, down, and left arrows let you position the pane on top, to the right, below, or to
the left of the other one respectively.
2 The center pad positions the pane on top of the other one as a tabbed pane. The center pad
appears when you move the pointer over the square docking menu but outside one of the
arrows.

EIO0000001114 06/2020 129

User Interface

The following figure illustrates the use of the docking menu or external docking tabs to reposition
a pane (docked) inside the work area of an explorer.

To dock a pane, proceed as follows.

Step Action
1 Drag the pane by its title bar.
If the pane is already docked, extract it (see page 129) first.
Result: The docking menu and/or the external docking tabs (see page 123) appear.
2 Keep dragging the pointer over the docking menu or tab where you want the pane to be
positioned and release the mouse button.
Result: The pane is docked.

130 EIO0000001114 06/2020

 User Interface

The following figure shows an example of panes that have been tabbed by using the center pad of
the docking menu.

The following figure shows an example of a pane that has been docked below another one by using
the down arrow of the center pad of the docking menu.

EIO0000001114 06/2020 131

User Interface

The following figure shows an example of a pane that has been docked to the bottom edge of the
engineering client window by using the bottom external docking tab.

Resizing Panes
Typically, panes do not feature a maximize button. Instead, resize them to occupy the entire work
area.
To resize a pane, proceed as follows.

Step Action
1 Move the pointer over an edge of the pane.
Result: The pointer turns into a double-ended arrow.
2 Drag the pointer away from the edge.
Result: The pane is resized.

Closing Panes
To close a pane, click the close button in the title bar of the pane (when available). To open it again,
select the corresponding command from the menu of the explorer or editor.
If no close button is available or if it does not allow closing the pane, minimize the pane
(see page 128) to a tab.

132 EIO0000001114 06/2020

 User Interface

Using Menus

Context Menus
For many items of the UI (for example, folders, instances, elements of projects), right-clicking the
item opens a context menu containing several commands.
The commands are described in the topic documenting the item.
The figure shows an example of the context menu that opens when you right-click a system in the
Systems Explorer, which lets you perform actions on the system.

1 You can execute commands that appear in bold also by pressing Enter when the item is
selected or double-clicking the item itself (in this example, the item is System_1).
2 For certain commands, you can also use the keyboard shortcut (see page 142) that is indicated
to the right of the command when the item is selected.
NOTE: To close a context menu, press Esc.

EIO0000001114 06/2020 133

User Interface

Software Participant Windows

Floating Software Participant Windows

When you open a Participant window, it opens as a floating window and maximized.
You can resize this window, display it on another monitor, or embed it in the client window.
You can open several floating windows simultaneously.
The following figure shows an example of a floating Control Participant window. The window is
shown restored down.

1 Open the HTML help of EcoStruxure Process Expert

2 Embed the floating Participant window in the client
3 Copy to the local Clipboard (see page 136)
4 Paste from the local Clipboard
5 Save changes that were made in the Participant
6 Minimize the floating window
7 Maximize the floating window (or restore down the floating window when it is maximized)
8 Close the floating Participant window

NOTE: The other buttons of the Participant window toolbar are task-specific and are described in
the topic documenting the task.

134 EIO0000001114 06/2020

 User Interface

While the floating Participant window is open:

 The embedded Participant window is not refreshed and displays the view that was shown when
you extracted the floating Participant window.
 You cannot work in the embedded Participant window nor close it.
 Use the icon in the taskbar to display the client user interface when the floating Participant
window is maximized.
 The Windows® snap feature is enabled.

Embedded Software Participant Windows

The following figure shows an example of a Control Participant window, which is embedded in the
engineering client by using the restore button.

1 Close the Participant window

2 Extract and maximize the Participant window
3 Save changes that were made in the Participant

EIO0000001114 06/2020 135

User Interface

Showing Software Participant Windows on Separate Monitors

To show a software Participant window on another monitor, extract it (see page 135) and drag it to
the other monitor.
If you experience issues viewing the extracted Participant window on an extended monitor (for
example, if the window turns black), try disabling hardware acceleration for Windows®
Presentation Foundation (WPF). The required setting may already be present in the registry and
you can modify it; otherwise, you need to add it.
To disable hardware acceleration for WPF, proceed as follows. Follow this procedure only if you
are experiencing issues viewing an extracted Participant window on an extended monitor.

Step Action
1 By using the Windows® Registry Editor of the computer on which the client is installed, go to
HKEY_CURRENT_USER → SOFTWARE → Microsoft → Avalon.Graphics
2 Add a new registry key by right-clicking the Name column and selecting New → DWORD (32-bit)
Value.
NOTE: If the DisableHWAcceleration registry key is already present, proceed to step 4 if necessary.
3 Enter DisableHWAcceleration as name.
4 Right-click DisableHWAcceleration, select Modify, and enter 1 as data value.
5 Restart the computer.

Copy-Paste Functionality
You may not be able to copy-paste data elements (for example, strings or graphic elements in a
Supervision page) between the local computer and a software Participant by using the Ctrl+C and
Ctrl+V keyboard shortcuts or the Copy and Paste commands of contextual menus.
To do so, use the two buttons (see page 134) that are located in the toolbar of the software
Participant window, which allow you to perform the following actions:
 Copy to local Clipboard button: Copies strings or graphic elements that are selected in the
software Participant to the Clipboard of the local computer.
 Paste from local Clipboard button: Pastes strings or graphic elements that you have copied on
the local computer to the software Participant.
NOTE: To copy and paste strings or graphic elements between two instances of the same software
Participant (for example, two Refine windows of the Control Participant) or between two different
software Participants (for example, the Control and the Supervision Participant), you can use the
Ctrl+C and Ctrl+V keyboard shortcuts.

136 EIO0000001114 06/2020

 User Interface

To copy a data element on the local computer and paste it to the software Participant, proceed as
follows.

Step Action
1 On the local computer, select the data element and copy it to the Clipboard (Ctrl+C or Copy).
2 In the software Participant, position the cursor or pointer at the desired location and click the
paste button.

To copy a data element in the software Participant and paste it to the local computer, proceed as
follows.

Step Action
1 In the software Participant, select the data element and click the copy button.
2 On the local computer, position the cursor or pointer at the desired location and paste the data
element (Ctrl+V or Paste).

EIO0000001114 06/2020 137

User Interface

Filtering and Sorting Data

Overview
For most columns inside folders and panes, you can open a filter menu that lets you refine data
that is displayed according to criteria and/or conditions that you define.
In addition, you can sort data in ascending or descending alphanumerical order.
Filters and sorting are reset when you close the pane, window, or editor in which they appear.
NOTE: When a filter is active, commands that you execute at a parent node level may also execute
on data that is not displayed. This can be the case, for example, when you execute a command at
the folder level in the Application Explorer while a filter is applied on the Identifier column of the
folder and, as a result, not all the instances contained in the folder are displayed.

Filter Menu Description

The following figure shows an example of the filter menu.

138 EIO0000001114 06/2020

 User Interface

Item Description
1 Column filter icon.
Click the icon to open the filter menu.
The icon turns dark to indicate that you have applied a filter on the column.
2 Data field.
The field displays in a flat list one of each of all the entries that the column contains. That is, if an
entry appears more than once in the column, it is displayed only once in the data field. If the column
contains only partial data because, for example, a keyword search has been performed, the data field
displays also only the partial data.
Select one or more entries. Only entries that you select will be displayed when you apply the filter.
NOTE:
If the column contains a tree view (for example, the Templates Browser pane of the Application
Explorer), the content of the data field depends on the type of lowest-level child elements shown in
the column:
 A single type of child elements (for example, only templates): The data field displays only child
elements that are not part of the tree structure (for example, only templates but no folders).
 Several types of child elements (for example, the Name column of the Import window in the
Projects Explorer for a Control project, which contains services and sections as lowest-level child
elements): The data field displays only the parent nodes (for example, the system root folder).
3 Expression builder.
Lets you build custom filter expressions by selecting one or two conditions and an operator from a list.
The conditions apply to any data contained in the column even if it is not shown in the data field. The
list of available conditions varies and is adapted to the data type of the column.
NOTE: If you build an expression and select an entry in the data field, your selection is used as an
additional condition in the expression with the AND operator. If you select several entries in the data
field, each one is treated as OR condition before the result is used as an additional condition.
4 Match case button.
Click the button to enable case-sensitive filtering as an additional condition.
The button appears only for columns showing data of String type.
5 Click the button to apply the filter to the column.
NOTE: When the filtered data is modified (for example, new objects have been created or imported,
objects have been renamed), the filters do not apply to the modified data. To apply them, open the
filter menu again and click Filter.
6 Click the button to clear the filter for the column.
NOTE: To clear filters for all columns, right-click any column header and select Clear Filters.

EIO0000001114 06/2020 139

User Interface

Example
The following figure shows a filter example consisting of two items selected in the data field and
one expression. It is used to filter the contents of the Identifier column.

The resulting filter expression is:

(Motor_1 OR Motor_2) AND Identifier contains 2.
The following figure shows the search result once the filter is applied; instances for which the
expression is true.

140 EIO0000001114 06/2020

 User Interface

Using Filters
To use filters, proceed as follows.

Step Action
1 Click the filter icon of the row that contains the data that you want to filter.
Result: The filter menu opens.
2 Select entries in the data field or create a filter using the expression builder.
3 Click Filter.
Result: The column displays data that matches the criteria and the filter icon turns dark.
NOTE: When columns contain tree views, the parent structure of filtered items is shown.
4 Close the filter menu.

NOTE: You can use filters for several columns simultaneously. Repeat the above procedure on
each column.

Sorting Data
The sorting feature is represented by a green triangle inside the column header.
Click a column header to enable sorting of the data that the column contains.
Clicking the column header repeatedly toggles between the following states:
 Arrow up: Sorts in ascending alphanumerical order.
 Arrow down: Sorts in descending alphanumerical order.
 No arrow: No sorting. Data is displayed by using the default display order defined for the column.

NOTE:
 Hold Shift to enable sorting of multiple columns.
 To clear sorting on all columns, right-click any column header and select Clear Sorting.
 If a rule has been defined to display contents of a column, enabling the sorting feature does not
override this rule. For example, in the Application Browser of the Application Explorer folders
are shown first, followed by instances. Applying sorting sorts only items within their respective
category. It does not change the display order of categories.

Clearing All Filters and Sorting

To clear filters and sorting for all columns, right-click any column header and select Clear All.

EIO0000001114 06/2020 141

User Interface

Keyboard Shortcuts

Available Keyboard Shortcuts

You can use the following keyboard shortcuts in place of the command in the context menu or the
button.

Keyboard shortcut Corresponding command or button

Alt+A Navigation button (see page 115).
Opens or shows the Application Explorer for the system.
Alt+P Navigation button (see page 115).
Opens or shows the Project Explorer for the system.
Alt+T Navigation button (see page 115).
Opens or shows the Topology Explorer for the system.
Ctrl+A No corresponding command.
Use this keyboard shortcut to select the entire contents of a folder or container,
such as instances or facets.
Ctrl+C Copy
Ctrl+F Find (Global Templates)
Places the cursor in the search field of the Global Templates Explorer.
Ctrl+L Edit Links.
Opens the Links Editor of the Application Explorer.
Ctrl+V Paste
Del Delete
F2 Rename
F4 Settings (Global Templates)
F12 Read-only (Global Templates)
Shift+F12 Edit (Global Templates)

142 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Engineering a System
EIO0000001114 06/2020

Part III
Engineering a System

Engineering a System

Overview
This part describes how to complete the different stages of the system engineering life cycle to
engineer a system.
The following figure shows the stages of the system engineering life cycle.

EIO0000001114 06/2020 143

Engineering a System

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
10 Quick Reference Guides 145
11 Managing Systems 157
12 Instantiation Stage 171
13 Project Definition Stage 297
14 Assignment Stage 383
15 Generation Stage 443
16 Refinement Stage 505
17 Configuration Stage 549
18 Mapping Stage 623
19 Build Stage 687
20 Deployment Stage 713
21 Execution Stage 787
22 Managing Communication 855

144 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Quick Reference Guides
EIO0000001114 06/2020

Chapter 10
Quick Reference Guides

Quick Reference Guides

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
System Creation Workflow 146
Task Quick Reference 151

EIO0000001114 06/2020 145

Quick Reference Guides

System Creation Workflow

Navigation
This page shows the various stages of the system engineering life cycle and which Explorer is used
to complete them.
 Click an Explorer to view the main tasks of the workflow.
 Click a stage for detailed information on how to complete it.

NOTE: In the HTML help, use the Back button in the toolbar of the help window to revert to this
page.

System Engineering Life Cycle

Application Explorer Project Explorer Topology Explorer

Instantiation Project Definition Configuration

↓ ↓ ↓
======================================
↓ ↓
Assignment
↓ ↓
Generation
↓ ↓
Refinement
↓ ↓
======================================
↓
Mapping
↓
Build → Deployment
↓
Execution

NOTE: Specific transversal workflows are also provided describing how to implement
communication (see page 855).

146 EIO0000001114 06/2020

 Quick Reference Guides

System Creation Workflow

The following workflow shows the main tasks that you need to perform to complete the system
engineering life cycle. Click a task to navigate to the topic describing how to complete it.

Systems Explorer

Create system
↓

Application Explorer

↓
Create application folder structure
↓
Configure folder properties
↓
Browse templates
↓
Create instances
(process/device/communication)
↓
Configure instances
↓
Link instances
↓

EIO0000001114 06/2020 147

Quick Reference Guides

Topology Explorer

↓
Create topology folder structure (optional)
↓
Create a controller entity
↓
Configure the controller (Participant)
↓
Configure controller properties
↓
Configure station node entities
I
↓
For Control (simulation) For Supervision
Configure NIC properties I Configure NIC properties
↓ I ↓
Create ControlExpert service I Create Supervision and/or OFS service
I
↓
Create device entities
I
↓
MODBUS TCP/Ethernet I PROFIBUS remote I Distributed I/O entity
IP device entity master (PRM) entity Create STB island entity
Select template Create PRM entity
↓ I ↓ I ↓
Configure device I Configure PRM I Configure the STB island
properties properties (Participant)
↓ I ↓ I ↓
↓ I Configure the PRM I Configure STB island
(Participant) properties
I
↓
Create an Ethernet network
↓
Create physical connections
↓

148 EIO0000001114 06/2020

 Quick Reference Guides

Project Explorer

↓
Control Supervision
Create project Create project
↓ ↓
Create sections in task folders Assign facets to project container
↓ ↓
Assign facets to sections Create Supervision pages
↓ ↓
Generate project or sections Edit pages / assign genies (Participant)
↓ ↓
Refine project or sections (Participant) Generate project
↓ ↓
Create executable Refine the project (Participant)
↓ ↓
Perform service mapping Create executable
↓ ↓
Perform communication mapping Perform service mapping
↓ ↓
Perform hardware mapping Perform communication mapping
↓ ↓
Build project Build project
↓ ↓
View the built project Deploy the project
(from the executable)
↓

EIO0000001114 06/2020 149

Quick Reference Guides

Topology Explorer

↓
Control Supervision
(deployment and execution) (deployment from the station node)

Start the simulator (if applicable) ↓

↓ ↓
Select the project and executable Select the project and executable
↓ ↓
Select the IP address Select the IP address
↓ ↓
Deploy the built project Deploy the built project
(deploy changes after first iteration)
↓ ↓
Refine online (Execution is performed by using
↓ Supervision software running on the station node)
Update Control project ↓
↓ ↓
Start over the life cycle from any point

NOTE: Specific transversal workflows are also provided describing how to implement
communication (see page 855).

150 EIO0000001114 06/2020

 Quick Reference Guides

Task Quick Reference

Overview
The tables in this topic provide an overview of the main tasks that you can perform by using the
software at each stage of the system engineering life cycle (see page 41) and where to find
information explaining how to complete the task.
Stages are grouped by explorer.

Systems Explorer Task Quick Reference

Task
Creating systems (see page 157) (and configuring runtime navigation service (RTNS) parameters)
Creating system backups (see page 163)
Restoring systems (see page 166)

Application Explorer Task Quick Reference

System Engineering Life Task

Cycle Stage
Instantiation stage Browsing templates (see page 177)
(see page 171) Creating instances (see page 194)
Browsing instances and folders (see page 181)
Counting instances (see page 198)
Configuring instances (see page 206) (and associating documents and URLs to
instances for use with RTNS)
Linking instances (see page 217)
Viewing facet assignment (see page 438)
Managing instances (see page 235) (copy/paste, move, update/replace
templates)
Exporting and importing application objects (see page 255)

EIO0000001114 06/2020 151

Quick Reference Guides

Project Explorer Task Quick Reference

System Engineering Control Projects Supervision Projects

Life Cycle Stage
Project Definition Creating projects (see page 305) Creating projects (see page 339)
stage (see page 297)
Managing projects and project sections Creating project components (see page 343)
(see page 310) Managing Projects (see page 357)
(order, export, import, manage data backup
(export, import)
files)
Assignment stage Creating sections (see page 392) (automatic Creating containers (automatic and manual)
(see page 383) and manual)
Assigning facets (see page 419) Assigning facets (see page 421)
Viewing the application structure in projects
(see page 429)
Managing assigned facets (see page 435) (view assignments, unassign, move, change order)
Generation stage Generating for the first time (see page 449)
(see page 443) – Generating equipment names
(see page 496)
Generating after changes (see page 487) (auto-assign and generate, regenerate)
Managing generated facets (see page 501) (unassign, reassign, unlink, move)
Managing versions of types (see page 456) –
Refinement stage Refining projects (see page 507) (viewing the Refining projects (see page 544)
(see page 505) application structure, viewing code generated
by facets, managing device DDTs, creating
LL984 segments)
Checking consistency (see page 523) Editing Supervision pages (see page 544)
Creating network variables (see page 527) Editing advanced project settings, adding
included projects, attaching user files
(see page 545)
Mapping stage Creating Control executables (see page 625) Creating executables (see page 677)
(see page 623) Mapping services (see page 628) Mapping services (see page 680)
Mapping communication (see page 630) Mapping communication (see page 682)
(and connecting Modbus devices to
Mapping network variables (see page 645)
Supervision)
Mapping hardware (see page 655)
Exporting/Importing hardware mappings
(see page 664)

152 EIO0000001114 06/2020

 Quick Reference Guides

System Engineering Control Projects Supervision Projects

Life Cycle Stage
Build stage Building projects (see page 689) (also, Building projects (see page 704) (also,
(see page 687) generate and build) generate and build)
Viewing the built Participant project Downloading project files (see page 709)
(see page 695)
Deployment stage Refer to the Topology Explorer task quick Deploying built projects (see page 774) and
(see page 713) reference. deploying changes (see page 784) (to all the
station nodes that are service mapped to the
project executable)

EIO0000001114 06/2020 153

Quick Reference Guides

Topology Explorer Task Quick Reference

System Engineering Control Projects Supervision Projects

Life Cycle Stage
Configuration stage Configuring controllers (see page 556)
(see page 549) Configuring station nodes (see page 566) (for Supervision/simulation)
Configuring Modbus TCP and Ethernet IP devices (see page 584)
Configuring PROFIBUS PRM Masters and Decentralized Peripherals (see page 579)
Configuring STB Islands (see page 573)
Configuring Ethernet networks (see page 594)
Connecting to Ethernet networks (see page 596)
Managing the Topology (see page 606) (export, import, update templates)
Managing communication (see page 855) (Modbus TCP Ethernet implicit (I/O scanning, peer
to peer communication)/explicit, Ethernet IP explicit, Modbus serial)
Deployment stage Using the emulated simulator (see page 720) Deploying built projects (see page 774) and
(see page 713) Managing passwords for deployment and
deploying changes (see page 784) (to
specific station nodes)
execution operations (see page 725)
Deploying built projects (see page 714)
Re-deploying projects (see page 743)
Deploying project changes (see page 757)
(and undoing online changes)
Deploying controller data (see page 750)
Execution stage Starting/stopping controllers (see page 796) Refer to Executing the Deployed Supervision
(see page 787) Synchronizing redundant controllers
Project (see EcoStruxure™ Process Expert,
(see page 804) Supervision Participant Services, User
Guide)
Refining online (see page 816) (and importing
generated changes, viewing the application
structure)
Updating Control projects (see page 841)
Backing up controller data (see page 823)

154 EIO0000001114 06/2020

 Quick Reference Guides

Global Templates Explorer Task Quick Reference

System Engineering Life Tasks

Cycle Stage
Global Templates Managing Global Templates (see page 978) (save, copy, export/import, purge)
(see page 929) Updating, duplicating, and replacing Global Templates (see page 998)

Content Repository Task Quick Reference

Tasks
Creating content containers (see EcoStruxure™ Process Expert, Runtime Navigation Services , User
Guide ) (and editing, copying, moving, exporting and importing them to set up runtime navigation services
(RTNS))

Virtual Machine and Participant Task Quick Reference

Tasks
Configuring virtual machines (see EcoStruxure™ Process Expert, Installation and Configuration Guide)
(sharing a folder of the local computer, keyboards, disabling the use of the virtual machine on the local
computer)
Installing extensions in Participants (see EcoStruxure™ Process Expert, Installation and Configuration
Guide) (DTMs, GSD and EDS files, hotfixes)
Opening the help of a Participant (see page 104), OPC Factory Server, and OPC UA Server Expert

EIO0000001114 06/2020 155

Quick Reference Guides

156 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Managing Systems
EIO0000001114 06/2020

Chapter 11
Managing Systems

Managing Systems

Overview
This chapter describes how to manage systems by using the Systems Explorer. Creating a system
is prerequisite to starting the system engineering life cycle.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Organizing Systems 158
Creating Systems 160
Creating System Backups 163
Restoring Systems 166

EIO0000001114 06/2020 157

Managing Systems

Organizing Systems

Overview
Systems that you create are stored in the database of the system server.
You can access a system from any client that is connected to the server of this infrastructure.

Accessing the Systems Explorer

To access the Systems Explorer, click the Systems icon in the toolbar (see page 115).

Systems Explorer Window

The following figure shows the Systems Explorer window.

1 Systems Explorer root folder

2 System folder
3 Systems

158 EIO0000001114 06/2020

 Managing Systems

Creating System Folders

To organize systems, you can create system folders, which can contain one or more systems.
To create a system folder, proceed as follows.

Step Action
1 Right-click the Systems Explorer root folder and select Create Folder.
Result: The software creates a system folder with the default name in edit mode, and displays it in
the tree view.
NOTE: To create a subfolder, repeat step 1 at the system folder level.
2 To change the name, type it; otherwise click outside the folder to accept the default name.

System Folder Actions

Right-click the root folder or any system folder to open a context menu with the following
commands.

When you select... The software...

Create Folder creates a system folder or subfolder.
Create System creates a system.
Delete deletes the folder.
The command is not available from the root folder.
NOTE: The command is not available if the folder is not empty.
Rename allows you to enter a new folder name.
The command is not available from the root folder.
NOTE: You can also click the folder twice to edit its name.
Restore opens the Restore window, which allows you to select a system backup file (.sbf) to
restore a system (see page 166) in the database.

EIO0000001114 06/2020 159

Managing Systems

Creating Systems

Creating a System
To create a system, proceed as follows.

Step Action
1 Right-click the Systems Explorer root folder or a system folder and select Create System.
Result: The software creates a new system with the default identifier in edit mode, and displays
in the tree view.
2 To change the identifier, type the new one; otherwise click outside the system to accept the
default name.

System Actions
Right-click a system to open a context menu with the following commands.

Command Description
Open Opens the Application Explorer, which allows you to start the Instantiation stage
Application(1) (see page 171) or access the application of an existing system.
Open Opens the Topological Explorer, which allows you to start the Configuration stage
Topology(1) (see page 549) or access the topology of an existing system.
Open Opens the Projects Explorer, which allows you to start the Project Definition stage
Projects(1) (see page 297) or access the Control and Supervision projects of an existing system.
Delete Deletes the system including all of its contents.
The command is inactive if either an application, topology, or project window of the system
is still open.
Rename Allows you to enter a new system identifier.
NOTE: You can also click the system slowly twice to edit its identifier
Back Up Opens the Back Up window (see page 163), which allows you to create a backup file of the
system.
Settings Opens the Settings window (see page 162), which lets you view and configure various
system-related settings.
Properties Opens the Properties (see page 161) window of the system.
(1) You can also use the navigation buttons (see page 115) located in the toolbar of the engineering client.

160 EIO0000001114 06/2020

 Managing Systems

System Properties
To open the Properties window of the system, right-click the system and select Properties.
You can view and/or edit the following items.

Item Description
Identifier The identifier must be unique on the system server.
Default value: System_n where n is an incremental number starting at 1.
Description Optional.
You can enter a description of the system with free form text. The description you enter
appears in a tooltip when you move the pointer over the system.
Default value: Blank
Market Optional.
You can enter a description of the market that the system pertains to with free form text.
Default value: Blank
Customer Optional.
You can enter a description of the customer that the system pertains to with free form text.
Default value: Blank
Site Optional.
You can enter a description of the site that the system pertains to with free form text.
Default value: Blank
Created By Logged-in user who has created the system.
Creation Date Date and time of the system creation.
Time
Modified By Logged-in user who has modified the system properties.
Modification Date and time of the last modification to the system properties.
Date Time
Change Optional.
Description You can enter a description of the changes to the system with free form text.
Default value: Blank
Optional Security The setting has an impact on the default value of the Security Password property of
Services By controllers (see page 558) and station nodes acting as simulator (see page 569) that you
Default create in the system:
 Enabled: Sets their property to Enabled by default.
 Disabled: Sets their property to Disabled by default.

Default value: Enabled

NOTE: Modifying the setting does not change the value of the Security Password
property of existing station nodes and controllers of the system.

EIO0000001114 06/2020 161

Managing Systems

System Settings Window

The Settings window opens when you select the Settings command in the context menu of a
system.

Section Description
Document Lets you enter the command line that the software executes for a given document type.
Viewers The command is executed when you open, in the operation client, the document that is
associated to an instance by using the HyperLink service (see page 209).

162 EIO0000001114 06/2020

 Managing Systems

Creating System Backups

Overview
You can create a backup file (.sbf) of any system that exists in the Systems Explorer. This allows
you to:
 Save your engineering work on demand so that your data is preserved, for example, in case of
a disk problem on the PC on which the system server is installed (refer to the topic describing
the contents of a system backup for details).
 Restore your work to an earlier point in time.
 Deliver a system to a site.

You cannot create a backup of a system if a component of the system is open in an engineering
or operation client (for example, if the Application Explorer is open or if data of the system is
accessed by using runtime navigation services). Also, while you back up a system, no user can
access it from an engineering or operation client.
You can start a new backup while another system is being backed up. You can do this from the
same or separate engineering clients.

Version Compatibility
Backup files are version dependent. You cannot use them to restore systems in a different version
of the software.
When you back up a system, the version of the software is automatically recorded and is displayed
when you restore the system.
NOTE: Backup files are forward compatible with subsequent releases within the same year (R•
versions) and service packs of a same version of the software. For example, you can restore a
backup file created with version 2018 in version 2018 R2.

EIO0000001114 06/2020 163

Managing Systems

System Backup File Contents

A system backup file contains:
 The definition of all topological and application instances used in a system.
 Participant project and executable files with the related mapping information.
 Controller data backup files (see page 335).
 Supervision included projects (see page 709) added by users.
 User files (see page 547) added to Supervision projects.
 OPC Factory Server and OPC UA Server Expert configuration files (see page 709).
 Password protection properties (see page 558) for topological entities and their value.
 Content containers (see page 1024) that you have created in the User Contents folder structure
of the system.
It does not contain:
 The templates that are used by the instances of the application.
 The default Supervision included project.
 Password information (see page 725).

NOTE: To be able to restore a backup file (see page 166), the items listed above must be present
in the database of the system infrastructure where you want to restore it. For example, typically,
templates that you have modified or created are not present in the database of a newly installed or
different EcoStruxure Process Expert infrastructure.

System Backup File Name

A system backup consists of a file with the default name <system identifier> <(time stamp)>.sbf
where time stamp is the date and time when the backup file was created, displayed by using the
format YYYYMMDDHHMMSS. Time is indicated by using the 24-hour format.
For example, System_1 (20160625144852).
You can edit the file name when creating the backup.

Aborting System Back Up Tasks

After clicking Save in the Back Up window, the abort icon is displayed in the notification panel
(see page 86). Click the icon to cancel the task. The backup file is not created.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are backing up a small system, the task may complete before you are able to click
the icon.

164 EIO0000001114 06/2020

 Managing Systems

Creating a System Backup File

To create a system backup, proceed as follows.

Step Action
1 Right-click the a system in the Systems Explorer and select Back Up.
Result: The Back up window opens.
2 If you want to create the back up in a different location and/or with a different file name, click the
browser button; otherwise, proceed to step 6.
Result: A Save As dialog box opens.
3 Select a location where to create the back up file and edit the file name if needed.
4 Enter a description (optional).
NOTE: The description appears when you restore the system by using the back up file.
5 Click Save.
Result: The Save As dialog box closes and the full path to the file is displayed in the Back up window.
6 Click Save.
Result: The software creates a backup file of the system and displays information in the notification
panel.
NOTE: To cancel the backup task, click the abort icon in the notification panel.
7 Export templates (see page 256) from the root folder of the Global Templates explorer because they
are not included in the system backup file but required to restore it.

EIO0000001114 06/2020 165

Managing Systems

Restoring Systems

Overview
You can restore a system from a system backup file that you had created by using the Back Up
command. This requires that templates that are used by the instances of the application are
present in the database of the EcoStruxure Process Expert infrastructure.
You cannot overwrite an existing system that has the same identifier or merge system data. If a
system with the same identifier already exists, the system is restored with a new identifier.
You cannot start a restore task while another system is being restored within the same
infrastructure.

Version Compatibility
Backup files are version dependent. You cannot restore system back up files created with another
version of the software. The version that was used to create the backup file is displayed when you
try to restore a system.
NOTE: Backup files are forward compatible with subsequent releases within the same year (R•
versions) and service packs of a same version of the software. For example, you can restore a
backup file created with version 2018 in version 2018 R2. In such case, a dialog box informs you
of the version shift and the software makes the restored systems compatible with the installed
version.

Detection of Missing Data Before System Restoration

When you restore a system, if the software detects that an item (for example, a template) is missing
in the database (see page 164), it opens the Restore dialog box. Missing items are reported in the
Status column of this dialog box.
To be able to restore the system, first, you need to add the missing item to the database where you
want to restore it.

Password Management After Restoring a System

After you restore a system that contains a controller and/or a station node acting as simulator for
which password protection (see page 558) has been enabled, you need to do the following to be
able to deploy a Control Participant project:
 If no password was set before creating the backup file, you need to set one.
 If a password had been set before creating the backup file, you need to enter this password
when prompted.
For more information, refer to the topic describing how to manage passwords for Control
Participant projects (see page 725).

166 EIO0000001114 06/2020

 Managing Systems

Aborting System Restoration

After clicking Restore in the Restore window, the abort icon is displayed in the notification panel
(see page 86). Click the icon to cancel the task. The system is not restored.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are restoring a small system, the task may complete before you are able to click the
icon.

Restoring a System
When you restore a system, its name in the database may be different from the name it had when
you created the backup. If this occurs and you had already deployed Supervision projects
contained in this system when you created the backup file, the system name that was used as
reference by runtime navigation services now refers to a different system. As a result, runtime
navigation services may not work or display data of another system.

NOTICE
NAVIGATION TO WRONG SYSTEM
Redeploy Supervision Participant projects after restoring a system.
Failure to follow these instructions can display information of an unexpected system.

NOTE: For details on the possible name change, refer to the topic describing the impact of
restoration on system names in the database (see page 168).
To restore a system from a backup file, proceed as follows.

Step Action
1 Right-click the system root folder or any system folder in the Systems Explorer and select Restore.
Result: The Restore window opens.
2 Browse to the system backup file (.sbf) and click Open.
Result: A confirmation dialog box opens.
3 Review the information that is displayed and click Restore.
Result: The system is restored. If a system with the same identifier already exists, a dialog box
opens, which indicates the new identifier that will be used to restore the system.
NOTE: Click Cancel to close the confirmation dialog box without restoring the system.
4 Click OK.
Result: The system is restored.
NOTE: To cancel the restore operation, click the abort icon in the notification panel.
5 If the system that you have restored contains Supervision Participant projects that you had deployed
before creating the backup, redeploy each one of them.

EIO0000001114 06/2020 167

Managing Systems

Impact of Restoration on System Names in the Database

Each system that you create has an identifier in the Systems Explorer and also a name in the
database, which may be different from the system identifier. Names of systems in the database are
assigned by the software incrementally and used in the background by software services for
system identification purposes, for example, by runtime navigation services provided by the
operation client. The name in the database does not change when you rename a system in the
Systems Explorer.
When you restore a system in the same or another EcoStruxure Process Expert infrastructure, if
the name that was originally assigned to it is already used, the system is restored with same
identifier in the Systems Explorer but with the next available name in the database.
The following example illustrates the scenario where the name of a system in the database
changes after restoring it.
The figure shows two systems that exist in the Systems Explorer and their respective name in the
database folder.

NOTE: The path to the database folder is C:\ProgramData\Schneider Electric\Process

Expert x\Db, where x corresponds to the installled major version (the R• version suffix does not
appear).

168 EIO0000001114 06/2020

 Managing Systems

MySystem is backed up and deleted from the Systems Explorer. Its name in the database is also
removed and becomes available for assignment to a new system.

Then, a new system (System_2) is created. The software assigns it the next available name in the
database. In this case, it corresponds to the name that was originally assigned to MySystem.

EIO0000001114 06/2020 169

Managing Systems

Later, MySystem is restored. The software assigns it the next available name in the database
(System_3), which is different from the name it originally had.

As a result, in this example, the name of MySystem in the database:

 Was System_2 before restoration.
 Is System_3 after restoration.

170 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Instantiation Stage
EIO0000001114 06/2020

Chapter 12
Instantiation Stage

Instantiation Stage

Overview
This chapter provides information to help you model the entire application of the system according
to the process and instrumentation diagram (PID).
The following figure shows the position of the instantiation stage within the system engineering life
cycle.

Refer to the Instantiation stage (see page 45) for a description of the purpose of this stage.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
12.1 Instantiating Templates 172
12.2 Instance Indicators 212
12.3 Linking Instances 217
12.4 Managing Application Folders and Instances 235
12.5 Exporting and Importing Application Objects to CSV and XML Formats 255

EIO0000001114 06/2020 171

Instantiation Stage

Section 12.1
Instantiating Templates

Instantiating Templates

Overview
This section describes how to use the Application Explorer to:
 Create a folder structure representing the process hierarchy of the application.
 Create and configure instances by instantiating application templates to model the functional
components of the application.
 Link instances to each other to propagate data.

NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Organizing the System Application 173
Application Explorer 174
Browsing Application Templates 177
Using the Application Browser Pane 181
Creating Application Folders 186
Assigning Icons to Application Folders 193
Creating Instances 194
Counting Instances 198
Accessing Instance Properties 200
Configuring Instances 206

172 EIO0000001114 06/2020

 Instantiation Stage

Organizing the System Application

Before Starting
Before creating the folder structure for your system application, define the appropriate
segmentation, hierarchy, and naming convention for your process.
The Application Explorer lets you use templates of the Global Templates library to create instances
that model typical components and functions of the application of a system. For example:
 Process objects: Represent the functions of process hardware, for example, motors and valves.
This includes signals from the field and/or variables.
For example, the $Motor template can model the functions of the electrical motor of a pump.
 Device objects: Provide functions required to communicate with, control, and/or diagnose a
range of electrical devices and instrumentation that are connected to field buses.
For example, the $TesysTEM template can model the functions of a TeSys T variable speed
drive communicating through Modbus TCP explicit messaging.
 Communication objects: Provide functions to manage communication with device objects
connected to field buses.
For example, the $EMPortQ template can model the management of communication through
the port of a Quantum controller through Modbus TCP explicit messaging.
Refer to Browsing Application Templates (see page 177) for additional information on templates
that you can instantiate.

Creating an Equipment Hierarchy

When you create instances and folders in the Application Explorer, you create a structure, which
is defined by:
 The identifier and location of the application folders.
 The identifier and location of the instances.

By default, this structure is used in the Supervision project to create an equipment hierarchy
(see page 496), which allows you to view alarms in the Supervision page in a structure identical to
the folder structure of the application.
Therefore, changes to the structure (see page 238) of the application are reflected on the facets
(see page 423) of the impacted instances once these facets are assigned to a Supervision project
and generated.

Viewing the Application Structure in Control Projects

You can view the folder structure of the application also in relation to Control Participant project
sections (see page 386) once you have instantiated templates and assigned facets to the Control
project.
The functionality is available also when you refine a Control project (see page 510) and make
changes online (see page 818).

EIO0000001114 06/2020 173

Instantiation Stage

Application Explorer

Overview
The work area (see page 118) of the Application Explorer features:
 The Templates Browser pane, which lets you search installed libraries and find the application
templates that you need to create the instances of your application.
 The Application Browser pane, which lets you view, search, sort, and filter folders and instances
of your application. You can also perform other tasks on folders and instances by using this
pane.
 In the form of tabs:
 The properties of folders.
 The Instance Editor, which lets you view and edit properties of instances.
 The Links Editor, which lets you view and create links between instances.

Opening the Application Explorer

To open the Application Explorer, double-click the system in the Systems Explorer.
NOTE:
You can also open the Application Explorer in the following ways:
 Drag the system from the Systems Explorer tree view to the tabs bar (see page 114) or to a
docking tab (see page 123).
 Right-click the system in the Systems Explorer and select Open Application.
 Select the system and click the Open Application Explorer button in the toolbar (see page 115).

174 EIO0000001114 06/2020

 Instantiation Stage

Application Explorer Window

The following figure shows an example of the Application Explorer window.

1 Templates Browser pane (see page 177)

2 Application Browser pane (see page 181)
3 System root folder
4 Work area (see page 118) of the Application Explorer. It is empty by default.
5 Properties of a folder
6 Instance Editor tab
7 Links Editor tab
8 Search field (see page 175) for folders and instances
9 Button to open the folder Settings pane (see page 193)

Searching Instances and Folders by Using the Application Explorer Search Field
The search field of the Application Explorer lets you find instances and folders in the Application
Browser by typing the entire or part of their identifier. You do not need to use wildcards. The search
is not case-sensitive. Results are displayed as you type in a pane with columns. Your last three
matching search keywords are stored and appear in a keyword menu. The stored keyword entries
are system-independent and persist even after the system server is restarted.
For example, to returns instances and folders that contain to in their identifier, such as instance
Motor_1, and folder Reactor.

EIO0000001114 06/2020 175

Instantiation Stage

By default, results are displayed in ascending alphabetical order with folders shown first, instances
next.
The results pane provides basic information on instances (see page 195) and remains open until
you close it by clicking the close button. A tooltip provides additional information.
The following figure shows an example of the search results that are displayed when you enter mo
in the search field.

Right-click a search result in the results pane to open a context menu with the following commands.

Command Description
Navigate  For an instance: Expands the containing folder and highlights the instance.
 For a folder: Expands the folder structure and selects the folder.

You can also double-click the item.

If the item is open in a window in a work area, the corresponding tab is also selected.
NOTE: If the instance is hidden because a filter is applied in the Application Browser,
the instance is not shown and a dialog box opens to inform you.
Edit  For an instance: Opens the Instance Editor tab, which lets you view and edit
parameters of the instance (see page 200).
 For folder: Opens the Properties tab, which lets you view, edit, and create
parameters of the folder (see page 188).

You can sort and filter (see page 138) search results.
NOTE: Search results are not updated automatically if instances or folders were created, modified,
or deleted in the meantime. You need to start over the search by clicking the search field and
pressing Enter.

176 EIO0000001114 06/2020

 Instantiation Stage

Browsing Application Templates

Overview
The Templates Browser pane of the Application Explorer lets you find the application templates of
the Foundation library and other libraries that are installed in the database of the system server.
These templates let you model the application of the system.
The Templates Browser pane also displays templates that you have created and/or imported.
To be displayed, a template needs to meet the following criteria:
 Template type: Application
 Usability State (see EcoStruxure™ Process Expert, Global Templates, Reference Manual) of
either:
 Approved
 Deprecated

By default, quick filters are applied to display only templates that are:
 Composite templates (see page 35).
 The latest version of the template.
 In the approved state.

You can display additional templates or refine your search by:

 Using the search field.
 Modifying quick filters.
 Using column filters.

NOTE:
 For details on available Schneider Electric application templates, refer to the help
(see page 115) of the Schneider Electric libraries for EcoStruxure Process Expert.
 For information on the naming conventions followed by Schneider Electric templates, refer to
the topic describing Global Templates libraries (see page 934).

EIO0000001114 06/2020 177

Instantiation Stage

Templates Browser Pane

1 Quick filters (see page 179) (the check mark indicates that the filter is applied).
2 Search results. By default, in tree view, folders are shown first followed by instances. In grid view, instances
are shown in a flat list. In both view modes, items are listed in ascending alphanumerical order.
3 Search field.
4 Button to toggle between grid and tree view for the display of search results.
5 Pin button (see page 127). Lets you minimize the Templates Browser pane to the left edge of the screen.
Move the pointer over the Templates Browser tab to display the pane. Click the pin button again to restore
the pane.
6 Filters and sorting (see page 138).

178 EIO0000001114 06/2020

 Instantiation Stage

Searching Templates by Using the Search Field

The search field of the Templates Browser pane lets you search templates by typing the entire or
part of the template identifier. You do not need to use wildcards or type the $ prefix. The search is
not case-sensitive. Your last three matching search keywords are stored and appear in a keyword
menu. The stored keyword entries are system-independent and persist even after the system
server is restarted.
The search field acts like a filter for the active view mode as soon as you enter a string. Results
are displayed as you type. To show the entire content, clear the field by clicking the close button
or deleting your entry.
For example, val returns templates that contain val in their identifier, such as $HandValve_UC,
$MValve, and $ControlValve.
The table describes the scope of the search and how results are displayed depending on the view
mode that is selected.

View mode What you can find What is displayed

Tree view  Templates Templates and folders matching the search criteria
 Folders with their entire parent folder structure.
Grid view Templates Templates matching the search criteria in a flat list.

NOTE: Click the toggle button to switch between display modes. Search keywords and search
results are retained.

Searching Templates by Using Quick Filters

The table describes the filters that are available in the Templates Browser pane to refine the
template search.

Filter Description Selected by

default
Composites Displays only templates that are composites, which also include Yes
control module templates.
Facets Displays only templates that are facets. No
Last Version Displays only the latest version of templates. Yes
Only
Approved Only Displays only templates that have the approved (see EcoStruxure™ Yes
Process Expert, Global Templates, Reference Manual) state.
Used Displays only the templates that are already used by instances of the No
application.
Using this filter disables the other filters.

EIO0000001114 06/2020 179

Instantiation Stage

NOTE:
 When you select multiple filters, only templates that match the selected filters are displayed.
 When you select a filter, the software automatically refreshes the result. The other way around,
when the filtered data is modified, the filters are not applied to the modifications.
 Filters are reset when you close the Application Explorer.

Additional Filters and Sorting

You can apply additional filters and sort the results (see page 138) to refine your search.

180 EIO0000001114 06/2020

 Instantiation Stage

Using the Application Browser Pane

Overview
The Application Browser pane lets you:
 Create, delete, move, copy-paste, and rename folders and instances.
 Search, sort, and filter folders and instances
 Toggle between tree and grid view mode, the latter showing only instances.
 Customize the display and the order of columns.
 View and edit the properties of folders and instances.
 Open the Links Editor.
 View assignments.
 Export and import application objects.

Application Browser Pane

The following figure shows an example of the Application Browser pane.

EIO0000001114 06/2020 181

Instantiation Stage

1 Status filters (see page 182) (a check mark indicates that the filter is applied).
2 Button to toggle between tree and grid view mode.
3 You can customize (see page 184) which columns appear and in which position.
4 Filters and sorting (see page 138).
5 System root folder. By default, the system root folder is expanded to display its immediate
children. Folders are shown first in the order you have arranged them, followed by instances in
ascending alphanumerical order.
6 Pin button (see page 127). Lets you hide the pane and restore it when it is docked.
7 If the folder has an alias (see page 188), it is shown in brackets after the folder identifier.
8 For instances for which the hierarchical naming function is enabled, the alias is shown in front
of the instance name (see page 195) (if applicable).
9 When you edit the identifier of an instance for which the hierarchical naming function
(see page 208) is enabled, the alias appears to the left of the identifier in read-only mode (if
applicable).
10 Indicator icons (see page 212).
11 Search field (see page 184).

Using Instance Status Filters

The table describes the impact on the search result when you select instance status filters in the
Application Browser pane.

Filter Description
Needs Attention Shows only instances that satisfy the three subfilter criteria.
Link Invalid Shows only instances whose Link status (see page 224) is invalid.
Data Invalid Shows only instances whose Data status (see page 195) is invalid.
Progress Shows only instance for which a progress icon (see page 213) appears.

NOTE:
 When you select multiple filters, only templates that match the selected filters are displayed.
You can combine column filters (see page 138) and use the search field to refine your search
further.
 When you select a filter, the software automatically refreshes the result. The other way around,
when the filtered data is modified, the filters are not applied to the modifications.
 Filters are reset when you close the Application Explorer.

182 EIO0000001114 06/2020

 Instantiation Stage

Toggling Between Tree and Grid View

Tree view is the default view mode. You can switch to grid view any time by clicking the toggle
button. The item selection in either view mode is retained when you switch and revert to this mode.
In grid view, when no sorting and filter is applied, all the instances of the application are shown in
a flat list sorted in ascending alphanumerical order.
The table describes the impact on various features when switching from one view mode to the
other.

Feature that is used Impact when switching between view modes

Search The search criteria is carried over.
Filtering Is not applied to the other view.
Sorting

NOTE:
In grid view mode:
 Commands of context menus related to folders are not available.
 You cannot create instances by dragging a template to the Application Browser pane.

Navigating Inside the Browser Pane

The table describes the various methods that you can use to navigate inside the browser pane.

Key or action Result

Up/down arrow key Moves the selection to the previous/next item.
Left/right arrow key (1) Expands/collapses the next level of the selected node.

Enter(1)
Double-click(1) On a node, expands/collapses the next level of the node.
Plus (+)/minus (-) key Expands/collapses the entire hierarchy from/up to the node.

(1) The next time you expand the node by using one of these methods, the display reverts to the
last expanded view.

EIO0000001114 06/2020 183

Instantiation Stage

Customizing Column Display and Order

You can choose which columns you want to see by right-clicking a column header and selecting
Customize. The Identifier and Template columns are always shown.
The Path column is available only in grid view.
When you hide a column for which a filter is applied, the filter is cleared.
When the Customize dialog box is closed, you can change the order of columns by dragging a
column to its new position (except for Identifier).
You can configure the column display and order independently in tree and grid view.
For a description of each column, refer to the topic describing the creation of instances
(see page 195).
NOTE: The order of columns is reset each time you open the Customize dialog box and click Apply.

Searching Instances and Folders

The search field of the Application Browser pane lets you search folders and instances by typing
the entire or part of their identifier. You do not need to use wildcards. The search is not case-
sensitive. Your last three matching search keywords are stored and appear in a keyword menu.
The stored keyword entries are system-independent and persist even after the system server is
restarted.
For example, entering to returns instances that contain to in their identifier, such as folder
Torrefier and instance Motor_1.
The search field acts like a filter for the active view mode as soon as you enter a string. Results
are displayed as you type. To show the entire content, clear the field by clicking the close button
or deleting your entry.
The table describes the scope of the search and how results are displayed depending on the view
mode that is selected.

View mode What you can find What is displayed

Tree view  Instances Instances and folders matching the search criteria with their
 Folders entire parent folder structure.
NOTE: When searching for folders, if several folders within the
same hierarchical structure match the search criteria, only the
highest level parent folder is shown in a collapsed state. You can
see whether any child folders match the search criteria by
entering the search criteria in the search field of the Application
Explorer. A tooltip indicates the path to folders in the search
results.
Grid view Instances Templates matching the search criteria in a flat list

Search keywords and search results are retained when you switch between view modes.

184 EIO0000001114 06/2020

 Instantiation Stage

By default, results are displayed with folders shown in the order you have arranged them followed
by instances in ascending alphanumerical order.
If sorting and/or filters (see page 138) are applied, they are also applied to the search results.
NOTE: Search results are not updated automatically if instances or folders are created, modified,
or deleted. For example, if you have entered va in the search field and create a folder, which has
Folder_n as default identifier, it will be shown.

EIO0000001114 06/2020 185

Instantiation Stage

Creating Application Folders

Overview
You can create application folders to structure your application by using the Application Browser.
The software lets you structure the application according to the ISA-S88.01-1995 standard for
batch control. You can create and rename the application folders according to the physical assets
that you want to represent and assign icons to the folders (see page 193) to define a hierarchy of
equipment.
Folders that you create may inherit properties of their parent folder, such as the Area.
You can also:
 Create folders also by copying and pasting or import (see page 255).
 Move folders (see page 188) with or without changing the folder hierarchy.
 Assign icons to application folders (see page 193).

Creating Application Folders

To create an application folder, proceed as follows.

Step Action
1 Right-click the system root folder and select Create Folder.
Result: An application folder is created at the end of existing folders of the same level. The
identifier is in edit mode.

Application Folder Actions

Right-click the root folder, any application folder, or multiple folders to open a context menu with
the following commands.

When you The software...

select...
Create Folder creates an application folder or subfolder.
The command is not available when more than one folder is selected.
Open Topology opens the Topological Explorer (see page 307), which allows you to start the configuration
stage or access the topology of the system.
The command is available from the root folder only.
Open Project Opens the Projects Explorer, which allows you to start the Project Definition stage
(see page 297) or access the Control and Supervision projects of an existing system.
The command is available from the root folder only.
Update opens the Update Instance Template window. It lets you update the template that is used
Template by instances inside the folder and any subfolder with the latest version of that template,
(see page 245) which is available in the Global Templates library on the system server.

186 EIO0000001114 06/2020

 Instantiation Stage

When you The software...

select...
Replace opens the Replace Instance Template window. It lets you select another template to be
Template used by instances contained in the folder and any subfolders. The template needs to be
(see page 245) available in the Global Templates library on the system server.
Copy copies folders, their subfolders, and the instances they contain.
(see page 240) The command is not available from the root folder.
Paste pastes the copied items to the selected locations in the system or in another system of the
(see page 240) server.
The command is available if the copied content is valid for the selected target locations.
Export opens an Export dialog box, which allows you to save the parameters and configuration
(see page 255) data of application objects to a file in CSV or XML format.
Import opens an Open dialog box, which allows you to select an export file in CSV or XML format,
(see page 287) display its compatible contents, and select instances to be imported into the application.
The command is not available when more than one folder is selected.
Delete deletes any selected folders and their contents including any subfolders and instances.
The command is not available from the root folder.
NOTE: After confirming the command, the abort icon is displayed in the notification panel
(see page 86). Click the icon to cancel the task. Already deleted instances and/or folders
are restored.
Only the user who has selected the command is allowed to abort it.
If you are deleting only a few items, the task may complete before you are able to click the
icon.
Rename lets you enter a new folder identifier.
NOTE:
 Renaming a folder may affect the equipment hierarchy (see page 173).
 The command is not available from the root folder and when more than one folder is
selected.
 If the folder has an alias, it is not shown while the identifier is in edit mode.

Properties opens the Properties (see page 188) tab, which allows you to edit the properties of the
application folder.
The command is not available from the root folder and when more than one folder is
selected.

EIO0000001114 06/2020 187

Instantiation Stage

Moving Folders
You can move one or more folders by dragging them to a new position. A tooltip indicates the result
of the action, which can have an impact on instances if the folder hierarchy is changed.
The table describes the tooltips that can appear and the corresponding result.

Tooltip Result
Move X before Y The folder and its content is repositioned before or after the other folder.
Move X before Y The folder hierarchy is not changed.
X The folder that you are moving and its content becomes a child of the other folder.
The equipment hierarchy (see page 496) may be impacted.
The instance identifier (see page 208) and assignment status (see page 481) of
generated facets may be impacted.
Where:
X Is the identifier of the folder that you are moving.
Y Is the identifier of another folder of the application.

NOTE: When you move several folders, you cannot reposition them and maintain the same
hierarchy.

Application Folder Properties

To open the properties of the application folder, right-click the folder and select Properties. A tab
opens inside the work area (see page 118) of the Application Explorer.
You can also open the properties by dragging the folder to the work area, the tabs bar of a work
area, or to a docking tab (see page 125) within the Application Explorer.

188 EIO0000001114 06/2020

 Instantiation Stage

You can edit the following items.

Tab Item Description

General Identifier Designation of the folder.
The identifier must be unique for each subfolder of the same parent
folder and satisfy naming rules (see page 98).
Default value: Folder_n where n is an incremental number starting at 1
for each folder level.
NOTE: Changing the identifier of an application folder may affect the
equipment hierarchy (see page 173).
Alias Optional.
You can assign an abbreviated name to the folder.
The alias is shown in brackets next to the folder identifier.
The software uses the alias for the hierarchical naming function
(see page 208).
You cannot create or modify the alias value if it causes any instance
identifier to be non-unique.
Default value: Blank
Description Optional.
You can enter a description of the folder with free form text. The
description you enter appears in a tooltip when you move the cursor
over the folder.
Default value: Blank
Area Optional.
You can assign a folder to an area.
Range: 1...255 (integer)
Default value: Blank
The software attempts to propagate the area value to subfolders and
any instances contained in the hierarchy to which no area value has
been assigned manually.
For details, refer to the topic describing area value propagation
(see page 190).
NOTE: You can also enter a string instead of an integer value. In such
case, you must refine the Supervision project after generating it and
use the same string as label to name the area; otherwise, the
Supervision project does not build successfully. Refer to the help of the
Supervision Participant for details.
NOTE: The area value is also propagated to Supervision elements of
instances such as genies.
Manage Parameter_1 Identifier You can use as many folder parameter sets as you require.
Parameters ... Default value: No parameter
Description
Parameter_n
Value
NOTE: Click Add Parameter to add a parameter.

EIO0000001114 06/2020 189

Instantiation Stage

Area Parameter Value Propagation

The software automatically propagates the value (including blank (NULL value)) of the Area
parameter of a folder to:
 Existing subfolders and instances that the folder and its subfolders contain unless you have
assigned an area value to them manually.
 Subfolders and instances that you create afterwards.
 Subfolders and instances that you add afterwards either by copying or moving them unless an
area value had been assigned to them either automatically or manually.
If you change an existing area value of a folder, only the area value that was propagated
automatically to the next level of subfolders and their instances is updated. The change is
propagated down the folder structure, level after level, until a manual folder area entry is detected.
If the software is not able to propagate the value of the Area parameter to any item because the
item is locked, it:
 Displays a notification to inform you which item is locked.
 Rolls back any propagated area value.
 Reverts the Area parameter value that you have entered in the folder properties to its previous
value.

NOTICE
NO CHANGE PROPAGATION
When the Area parameter value of a folder is not propagated:
 Reenter the Area parameter value in the properties of the folder.
 Verify in the Notification Panel that parameter value propagation completed successfully.

Failure to follow these instructions can result in alarms being signaled in the wrong area during
operation.

Examples
The following three examples illustrate the area value propagation to existing subfolders and
instances in the Application Explorer. The changes described in these examples are performeds
in steps inside the same folder structure.

190 EIO0000001114 06/2020

 Instantiation Stage

In a first step, starting from a folder structure and instances without area value, if you change Area
of Folder_1 to 1, the value is propagated to Instance_1, subfolders, and their instances.

In a second step, if you change Area of Instance_2 to 2 and then Area of Folder_1 to 3,
value 3 is propagated to Instance_1, subfolders, and their instances except for Instance_2
because the area was entered manually.

EIO0000001114 06/2020 191

Instantiation Stage

In a third step, if you change Area of Folder_2 to 4, value 4 is propagated to Instance_21, the
Folder_4 subfolder and its instance. Instance_2 remains unchanged because the area was
entered manually. If you then change Area of Folder_1 to 5, value 5 is propagated only to
Instance_1, subfolder Folder_3, and its instance because the area of other subfolders and
instances have either been entered manually (for example, Folder_2) or are manual entries that
have been propagated (for example, Folder_4).

192 EIO0000001114 06/2020

 Instantiation Stage

Assigning Icons to Application Folders

Overview
By using the Settings pane, you can assign icons to each level of application folders. The icons
appear in the tree view of the Application Browser pane (see page 175).
You can use this feature, for example, to represent graphically the physical hierarchy of equipment
used in a batch process according to the ISA-S88.01-1995 standard.
The settings apply to the system for which you configure them, to any user who opens the system
in an engineering client, and persist even if you restart the system server.
NOTE: You cannot assign an icon to the system root folder.

Available Icons
You can choose from the following selection of icons.

Icon Description
Default folder icon

Site

Area

Process cell

Unit

Equipment module

NOTE: Control modules are represented by the instances of the application.

Assigning Icons to Folder Levels

To assign an icon to a folder level, proceed as follows.

Step Action
1 Click the Explorer Layout Settings button (see page 115).
Result: The Settings pane opens.
2 In the Appearance section, select the folder level to which you want to assign an icon.
3 In the Style menu, click the icon that you want to use.
Result: The icon is assigned to each existing folder of the selected level and to each new folder
that you create in the selected level.
4 Repeat the procedure for other folder levels.

EIO0000001114 06/2020 193

Instantiation Stage

Creating Instances

Overview
Instances that you create in the folder structure (see page 186) of the application are created with
the default configuration of their template. Basic information on each instance is available at the
folder level.
Once you have created an instance by using the Application Browser, you can perform various
actions by using the pointer, accessing the context menu of the instance, or using keyboard
shortcuts.

Order of Instantiation
The order in which you create instances inside an application folder may affect the order of the
referenced Control facets in a section during assignment (see page 419).

Instantiating Application Templates

To instantiate a template in the root folder or in any application folder, proceed as follows.

Step Action
1 Verify that the folder in which you want to create the instance is displayed in the Application
Browser.
2 In the Templates Browser, select a template.
3 Drag the template to the folder.
Result: The folder opens or expands and an instance of the template is created in last position
with the default identifier in edit mode.
NOTE: If the folder has an alias, it is shown in a separate cell on the left of the identifier.
4 To change the identifier, type it; otherwise, press Enter to accept the default name.
NOTE: To keep the default name and create a new instance, you do not need to press Enter;
you can drag another template while the identifier of the instance is still in edit mode.

NOTE: Refer to Managing Application Folders and Instances (see page 235) for information on
features that are available when working with many application folders and instances.

194 EIO0000001114 06/2020

 Instantiation Stage

Instance Description
The following information of an instance is displayed in the Application Browser when the
corresponding column is shown (see page 184).

Header Description
Icon Displays the icon corresponding to the type of template that the instance uses.
Identifier For instances, displays the instance identifier (see EcoStruxure™ Process Expert, Global
Templates, Reference Manual), which must be unique for each instance of the same
template. The software calculates the identifier by using the parameter $Name of the instance
and the applicable naming conventions.
For folders, displays the folder identifier, which you can edit in the Properties tab or by using
the Rename command.
NOTE:
 You can edit the $Name parameter of an instance in the Instance Editor (see page 200)
or by using the Rename command. If the resulting identifier is not unique, the $Name field
is outlined in red. In such case, clicking outside of the field reverts the name to its previous
value.
 The hierarchical naming function (see page 208) can modify the identifier of an instance.
 Two instances using two different templates cannot have the same identifier if both
instances have an element in their composition in common (for example, the Logic
element, which is created by the $DEVCTL_UL facet). In such case, the identifier of the
element that both instances have in common would be the same; this is not allowed.
Template Indicates the identifier of the template that the instance uses.
The field is not used for folders.
Version Indicates the version of the template that the instance uses.
The field is not used for folders.
Data Indicates the status of the instance. Possible values:
 Valid
 Invalid

The value is updated when you save changes in the Instance Editor.
The field is not used for folders.
NOTE:
You can obtain information about the invalid status (see page 205) of an instance in the
Validity Diagnosis window:
 By clicking Invalid.
 When viewing its properties (see page 200).

EIO0000001114 06/2020 195

Instantiation Stage

Header Description
Link Indicates the status of the application interface link of the instance. Possible values:
 Valid
 Invalid

The value is updated when you make a link by using the Links Editor (see page 217) or save
changes in the Instance Editor that impact the link requirements of the instance.
The field is not used for folders.
NOTE:
You can obtain information about the invalid status (see page 224) of an instance in the
Validity Diagnosis window:
 By clicking Invalid.
 In the Links Editor.

Assigned Indicates the assignment status (see page 423) of the facets of the instance. Values:
State Assigned: At least 1 facet of the instance is assigned to any project of the system.
Unassigned: No facet of the instance is assigned to any project of the system.
The field is not used for folders.
Description Displays the content of the $Description parameter the folder or the instance. You can edit
the field in the Properties or the Instance Editor (see page 200) tab respectively.
Area Displays the value of the $Area parameter for the folder or the instance. You can edit the field
in the Properties tab or the Instance Editor (see page 200) tab respectively.
NOTE: If the value was assigned automatically (see page 190) by the software, it appears
between angle brackets. For example, <5>.
Path Indicates the path to the instance in the application starting from the system root folder.
NOTE: The column is shown only in grid view mode.

Instance Actions
Right-click an instance to open the instance context menu with the following commands.

Command Description
Edit Links(1) Opens the Links Editor (see page 217), which allows you to link the instance to other
compatible instances of the application through their compatible interfaces.
View Opens the View Assignments window, which lets you verify if the facets that are
Assignments referenced by the instance are assigned to Participant projects:
(see page 438)(1)  If a facet is not assigned, you can select an existing project and open the Assignment
Editor to assign it.
 If a facet is assigned, you can access the container to which the facet is assigned.

For Supervision genie facets, you access the Pages node in either case.
NOTE: The command is not available if the Data or Link status of the instance is Invalid.
(1) The command is not available when multiple instances are selected.

196 EIO0000001114 06/2020

 Instantiation Stage

Command Description
Update Template Opens the Update Instance Template window. It lets you update the template that is
(see page 245) used by the instance with the latest version of that template, which is available in the
Global Templates library on the system server.
Replace Template Opens the Replace Instance Template window. It lets you replace the template that the
(see page 245) instance is using by another template, which is available in the Global Templates library
on the system server.
Inspect Opens the Inspect Instance window, which provides information on the entire instance
Instance(1) configuration, including interface links.
(see page 236)
Copy Copies the selected instances for pasting within the application of the system or any
(see page 239) other system on the server.
Export Opens an Export dialog box, which allows you to save the instance data to a file in CSV
(see page 256) or XML format.
Rename(1) Sets the identifier of a single instance to edit mode. Type the new identifier and press
Enter.
NOTE:
The instance identifier is split in two and only the instance name ($Name) part is editable
if the following conditions are satisfied:
 You have defined an alias for the folder containing the instance or any of its parent
folders.
 The hierarchical naming function (see page 208) for the instance is enabled.

The concatenated, non-editable aliases are shown on the left of the instance identifier.
Delete Deletes the instance from the application.
You can select multiple instances within the same folder.
Not available while you edit the instance.
If you have assigned facets of the instance to projects, the assignment state
(see page 423) of these facets changes to Deleted.
NOTE: After confirming the command, the abort icon is displayed in the notification
panel (see page 86). Click the icon to cancel the task. Already deleted instances are
restored.
Only the user who has selected the command is allowed to abort it.
If you are deleting only a few instances, the task may complete before you are able to
click the icon.
Properties(1) Opens the Instance Editor (see page 200) in the work area, which allows you to view and
configure parameters, and select services of the instance.
(1) The command is not available when multiple instances are selected.

EIO0000001114 06/2020 197

Instantiation Stage

Counting Instances

Overview
The software includes a mechanism, which counts the instances that exist in the application of any
system on the system server and compares their number to the maximum number of instances that
the application size license that is activated allows.
At any time during the system engineering life cycle, you can view the instance count for each
system, the total count, and the maximum number of instances that is allowed.
The software does not allow actions that cause the maximum number of instances of the
application to be exceeded.

Viewing Instance Count Information

Instance count and software license information is displayed in the About EcoStruxure
Process Expert dialog box (see page 117).
The table describes the information that is displayed in the License Details section of the General
tab.

Label Description
Maximum Instances Allowed Total number of instances that you can create with the current license.
Current Instance Count Total number of instances in the systems that exist on the system server.

The table describes the information that is displayed in the Systems Details tab.

Header Description
System Name Identifiers of the systems that exist on the system server.
Instance Count Total number of instances of the system.

Actions Affecting Instance Count

The following actions that you can perform in the Application Explorer increase and/or reduce the
instance count in the application:
 Instantiate
 Paste
 Import
 Delete

The following actions that you can perform in the Systems Explorer increase and/or reduce the
instance count in the application:
 Restore
 Delete

198 EIO0000001114 06/2020

 Instantiation Stage

Exceeding the Allowed Number of Instances

If one of your actions causes the maximum number of instances that is allowed by the activated
license to be exceeded, the software cancels the entire action. It also displays a message to advise
you that you have reached the limit of instances allowed by the license.
In such case you have the choice to:
 Delete instances (you can export the instances (see page 256) before deleting them to reuse
them later.)
 Delete systems (you can back up the system (see page 163) before deleting it to reuse it later.)
 Upgrade the application size license (see EcoStruxure™ Process Expert, Licensing Guide).

EIO0000001114 06/2020 199

Instantiation Stage

Accessing Instance Properties

Overview
The Instance Editor tab opens in the inside the work area (see page 118) of the Application
Explorer and provides access to:
 Control, Supervision, and documentation services (see page 35), which are provided by the
template that the instance is using.
 Parameter values of the elements (see page 32) of the instance.
 The number of parameters that have been modified.
 The status of the instance.

NOTE: More information on the instance configuration is available in the Inspect Instance window
(see page 236) in read-only mode.

Read-Only Mode
You can open the Instance Editor for an instance in read-only mode if either of the following is true:
 The instance is being edited, for example, from another client connected to the same system
server.
 The instance is displayed in the Links Editor, either as active or inactive. (see page 218)

The read-only mode allows you to view instance parameters but not to modify them.

Opening the Instance Editor

To open the Instance Editor, double-click the instance that you want to configure in the Application
Explorer.
You can also open the Instance Editor in the following ways:
 Right-click the instance and select Properties.
 Drag the instance to either area within the Application Explorer:
 The work area (see page 118).
 The tabs bar of a work area.
 A docking tab (see page 125).

200 EIO0000001114 06/2020

 Instantiation Stage

Instance Editor
The following figure shows an example of instance Motor_1, which uses template $Motor open
in the Instance Editor.

1 Instance identifier. It is prefixed with * if you have made a change and not saved it.
2 Instance validity status indicator. The status is set to Invalid and details are available by clicking
the information button if either the Data or Link status (see page 195) is invalid.
3 Save button. Click to save parameter values and propagate changes (see page 423).]
4 Instance pane, which allows you to view the services that the instance provides and to
enable/disable optional ones. By default, nodes are shown expanded.
5 Element displayed in bold indicating that the element contains editable parameters.
6 Check box for element selection.
7 Counter indicating the number of modified parameters for a node out of the total number of
parameters that exist for that node.
8 Counter indicating the number of modified parameters for an element.
9 Elements of optional nodes of the instance that are not selected and that have configurable
parameters are displayed on a light gray background. This allows identifying easily which are
the optional services of the instance that provide additional customization capabilities. Selecting
the node removes the gray background.
10 Parameters pane, which allows you to configure the parameters of the elements of the instance
that you have selected.
11 Optional Hierarchical naming function (see page 208) selection box. The function is enabled by
default.
12 Parameter Filters section (see page 204).
13 Grouped by sorting function for parameters.

EIO0000001114 06/2020 201

Instantiation Stage

The table describes the fields of the instance pane.

Header Description
Name Shows the composition of the instance by displaying the identifier of the instance and:
 Its core and optional composite elements (nodes)
 Core and optional elements thereof (facets)

Elements (facets) provide the services of the application template, which depend on the
template that the instance uses.
For details on the services that are provided by Schneider Electric application templates,
refer to the help (see page 115) of the Schneider Electric libraries for EcoStruxure
Process Expert.
An item in bold indicates that you can configure parameters of the element.
Move with pointer over an element to see a description of the element in a tooltip.
Icon Indicates the type of template that is used by the instance and its elements.
Check box Indicates that the element is optional and not mandatory for the control module to function.
Typically, optional elements correspond to additional functionalities that are built into the
template and that you can select to customize the instance according to your needs.
An optional element may contain optional subelements, which you can select individually.
Selecting an element enables it and creates the corresponding facets. If applicable, it
allows you to configure parameters of the service that the element provides.
Selecting an optional Control element automatically selects the corresponding Supervision
element if it is available. For example, when you select the Interlocks element of the
$Motor template, the InterlockTags Supervision element is selected.
The other way around, clearing a selected Control element automatically clears the
corresponding Supervision element.
The following Supervision elements are selected by default:
 Elements corresponding to core Control elements, which are not optional.
 Elements corresponding to optional Control elements, which are selected by default.

(x / y) Node counter (7). For the instance and for its composite elements, the first number
indicates the number of parameters that you have changed in the node (x) compared to
the default value and the second, the total number of parameters (y) that you can change
for this node.
Changes to the Instance Name are not counted.
Counters are updated as soon as you confirm your entry by pressing Enter. For boolean
types, when you select or clear them.
NOTE: The counter turns bold to indicate that you have changed a parameter of the
element itself. When you change a parameter of any of its child elements, the counter font
style remains regular.
(z) Element counter (8). For child elements, indicates the number of parameters that you have
changed compared to the default values.
The counter appears even if the element has no editable parameters.
Counters are updated as soon as you confirm your entry by pressing Enter.
Description Description of the instance or element displayed in the Name column.

202 EIO0000001114 06/2020

 Instantiation Stage

Header Description
Template For instances and composite elements, indicates the identifier of the template that the
instance or composite element is using.
For facet elements, indicates the identifier of the facet template that encapsulates the
constituent provided by the Participant to implement the service.
Version Version of the template that the instance or element uses.

The table describes the fields of the parameters pane.

Header Description
Group By Allows you to sort parameters that are displayed in the parameters pane by the following
criteria:
 Element Path
 Category
 Type

By default, parameters are grouped as follows:

 For instances based on a composite template: By Element Path, then Category.
 For instances based on a facet template: By Category.

Click the close button of a criteria to remove if from the grouping. The corresponding column
is displayed.
Drag a column header to the green bar to group parameters by the corresponding criteria. You
can group by multiple criteria simultaneously.
When multiple criteria are selected, swap their order by dragging a criteria left or right.
When you have selected to group by a criteria, the corresponding column is not displayed
anymore.
Element Path to the element, which provides the parameters, as shown in the instance pane.
Path Not available for instances based on a facet template.
Category Category of the parameter.
Name Identifier of the parameter.
The column is hidden by default.
Right-click any column header and select Show Name to display the column. Right-click any
column header and select Hide Name to hide the column.
Description Description of the parameter.
Type Indicates the data type of the parameter.
Value Default value of the parameter or the value that you have entered.
NOTE: For parameters of the enumerated data type, for each enumerator, both the name and
the associated integer are shown (for example, Operator (2))

EIO0000001114 06/2020 203

Instantiation Stage

Header Description
Resolved Displays the value after formatting according to the data type.
Value For example, when the check box of a boolean parameter is selected, the value that is
displayed is True.
The column is hidden by default.
Right-click any column header and select Show Resolved Value to display the column. Right-
click any column header and select Hide Resolved Value to hide the column.
NOTE: Open the Inspect Instance window (see page 236) to view the resolved value of
additional template parameters, which has been calculated by using the value property and
any applicable logic defined in the template definition.

Navigating Inside the Instance Pane

The table describes the various methods that you can use to navigate inside the instance pane.

Key or action Result

Up/down arrow key Moves the selection to the previous/next item.
Left/right arrow key(1) Expands/collapses the next level of the selected node.
(1)
Enter
Double-click(1) On a node, expands/collapses the next level of the node.
Plus (+)/minus (-) key Expands/collapses the entire hierarchy from/up to the node.

(1) The next time you expand the node by using one of these methods, the display reverts to the
last expanded view.

Displaying Instance Parameters Using Filters

The table describes the filters that are available in the Parameter Filters section to customize the
display of parameters of the selected instance or element.

Filter Description
Editable Displays only parameters of the selected instance or element that you can edit.
A parameter may not be editable because it is optional and you have not selected it.
The filter is applied by default.
Modified Displays only parameters of the selected instance or element whose value you have
modified compared to their default value.
Show Child Displays parameters of the selected instance or element including those of child
Parameters elements.
None selected No filter is applied. Displays the parameters of the selected instance or element.

204 EIO0000001114 06/2020

 Instantiation Stage

NOTE:
 When you select multiple filters, the software displays only parameters that match the selected
filters.
 When you select or clear a filter, the software automatically refreshes the result.

To apply default filters, click the filter icon, then click Default.
To clear any filters, click the filter icon, then click Clear Filter.

Instance Data Status

When any of the following conditions apply, the Data status of the instance in the Instance Editor
changes to Invalid:
 Entering a character that is not allowed (see page 98) in the $Name field.
 Entering a number of characters in the $Name field causing the instance identifier to exceed the
length limit that may be defined (see page 98).
 Selecting an invalid combination of optional elements in the instance pane of the Instance
Editor.
 Creating an instance that references an element that has the same identifier as an existing
element in the application. For example, if you create two instances with the same identifier from
two different templates, which have an element in common, such as Interlocks, which uses the
$CONDSUM1_UC facet template.
You cannot assign to projects instances that have a Data status that is Invalid.
Furthermore, when facets of an instance are assigned to a Participant project, and later either
status of the instance changes to Invalid, the software propagates the invalid status to facets of
Participant projects.

While the Data status is displayed as Invalid, click the validity status information button to
display the Validity Diagnosis window, which provides information about the cause of the status.
The following figure shows an example of the Parameter tab of the Validity Diagnosis window that
the software displays when it detects an invalid identifier.

NOTE: For information on the other tabs that are related to the Link status of the instance, refer to
the topic describing instance links (see page 224).
NOTE: If the status of an instance is Invalid because of a duplicate element identifier, deleting or
modifying the other instance that contains the same element does not change the status back to
Valid. After you have solved the conflict, edit the invalid instance and save any change (for
example, a modification of the description) to set its status to Valid.

EIO0000001114 06/2020 205

Instantiation Stage

Configuring Instances

Overview
The Instance Editor lets you:
 Enable or disable optional Control, Supervision, and documentation services, which are
provided by the template that the instance is using.
 View and configure parameters of the instance.

For more information to help you select and configure instances to meet the requirements of your
application, refer to the help (see page 115) of the Schneider Electric libraries for EcoStruxure
Process Expert.
For information on how to link documents, files, and associate web links to instances for use with
runtime navigation services, refer to the topic describing how to add user contents
(see EcoStruxure™ Process Expert, Runtime Navigation Services , User Guide ).
NOTE: When an instance is being edited by using another client of the same system server, this
instance can only be opened with the Instance Editor in read-only mode to preserve data integrity
(see page 83).

Modifying Instance Parameters After Assignment

When you modify and save properties of an instance whose facets are already assigned to a
Participant project, the software may display a message to inform you that your modifications affect
the assignment status of these facets.
This is a generic message that does not take into consideration whether the assigned facets are
generated or not.
In fact, only the assignment status of generated facets can be changed to Out Of Date or Deleted
(see page 481).
If facets are only assigned, upon saving your changes:
 Modifications are propagated without affecting the assignment status. (For example, if you
change the instance name, the identifier of assigned facets is updated in the Participant project.)
 Entire facets are removed from the container to which they are assigned. (For example, if you
clear an element of an instance, the corresponding facet that was assigned is deleted.)

Changing the Element Selection of Instances with Assigned Facets

When you change the element selection of an instance, which has at least one facet that is already
assigned and this change results in the creation of new facets, the software can assign candidate
facets automatically to the same container.
For more information, refer to the topic describing automatic facet assignment (see page 425).

206 EIO0000001114 06/2020

 Instantiation Stage

Validating Parameter Values

When you edit parameters of the instance, the Instance Editor displays and validates values
according to the supported data types (see page 96), helping you configure the values in
accordance with the data type format.
You cannot save the instance properties if the software has detected that a parameter value is not
valid.
Certain supported data types (see page 96) use language-specific formatting according to the
Regional Options that are set for the operating system of the PC. For example, if your regional
settings define . (dot) as decimal delimiter and you enter a decimal value in the format 100,5 by
using comma instead of the dot, the software processes this value as 1005.0.
NOTE:
Except for changes to the $Name parameter:
 Changes appear in italics until you save them.
 Values that you enter and that are different from the default value are shown in bold at any time.

WARNING
UNINTENDED EQUIPMENT OPERATION
Verify which Regional Options are configured in the operating system of your computer and
follow the applicable formatting rules to enter data in the Instance Editor.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

In addition, in the Instance Editor the following rules apply when you edit the $Description
parameter and other element parameters of type String of an instance.

Rule Example or comment

"" returns an empty string. "example or example" is not allowed.
Conversion of " into ^". The software converts "example" into ^"example^" to return "example".
^example or example^ is not allowed.
To return ^ use ^. ^^example^^ returns ^example^.

Naming Rules for Instance Parameters

When you change instance parameter values, verify that they satisfy the Participant specific
naming rules (see page 98) so that the subsequent generation process can complete successfully.
Further, entering incorrect values may change the Data status (see page 205) of the instance to
Invalid when you save the instance configuration.
NOTE: Naming rules may also apply when you use the hierarchical naming function.

EIO0000001114 06/2020 207

Instantiation Stage

Hierarchical Naming Function

You can use the hierarchical naming function to let the software manage the identifier
(see page 195) of an instance. The function is enabled by default.
When you select the hierarchical naming function, the software creates the identifier of an instance
automatically through the concatenation of:
 The alias of each application folder (see page 188) in the path of the instance, starting from the
system root folder.
 The $Name (see page 209) parameter of the instance.

For example, if the $Name of an instance is Motor_1 and the path to its location is: System Root
Folder\Folder_1\Folder_2.
Plus, you have assigned the aliases F1 and F2 respectively to each folder.
Then, the identifier of the instance becomes F1F2Motor_1.
NOTE:
 The length of the instance identifier cannot exceed the maximum length (see page 98);
otherwise the software displays the status of the instance as Invalid (see page 205).
 The software excludes folders without alias from the hierarchical naming (for example, if you
assign no alias to Folder_1, the identifier of the instance becomes F2Motor_1).
 You cannot assign an alias to the system root folder.

To use the hierarchical naming function, proceed as follows.

Step Action
1 Right-click the instance and select Properties.
Result: The Instance Editor opens.
2 Verify that Hierarchical Name is selected, enabling the hierarchical naming function; otherwise
select it.
3 Close the Instance Editor.
4 Right-click the application folder that is to be considered for the hierarchical naming and select
Properties.
Result: The Properties tab of the folder opens.
5 Assign an alias to the folder in the Alias field.
NOTE: Keep the alias as short as possible to avoid reaching the instance identifier character
limit.
6 Repeat steps 4 and 5 for the other folders that you want to include in the hierarchical naming.
7 If required, modify the $Name of the instance in the Instance Editor to avoid reaching the instance
identifier character limit.

NOTE: The software applies the hierarchical naming when you move, copy (see page 235), or
import (see page 287) instances in the Application Explorer.

208 EIO0000001114 06/2020

 Instantiation Stage

Instance Parameters
You can configure the following instance parameters in the parameter pane of the Instance Editor.

Selection in the Parameter Data type Description

instance pane
Instance $Name String Default value: Template identifier _n where n is an incremental
number starting at 1. For Schneider Electric templates, the $ suffix
and the _xy prefix are omitted.
Within the application of one system, the resulting instance
identifier (see page 195) must be unique for each instance using
the same template; otherwise, the $Name field is outlined in red.
Clicking outside of the field reverts the name to its previous value.
Entering a character that is not allowed (see page 98) changes the
instance Status to Invalid (see page 195).
NOTE: If you enter the same value for two instances that use a
different template and the resulting instance identifiers are identical,
the $Name field is outlined in red if the identifiers of Control facets
of the two instances are not unique anymore (for example, when
both instances contain the Interlocks element, which is created by
the same facet).
NOTE: The software changes the $Name parameter of the
instance if the value is not unique anymore within the application
following a paste (see page 239) or import (see page 287)
operation.
$Description String Description of the instance.
Default value: Blank.
(1) You can also enter a string instead of an integer value. In such case, you must refine the Supervision project after
generating it and use the same string as label to name the area; otherwise, the Supervision project does not build
successfully. Refer to the help of the Supervision Participant for details.

EIO0000001114 06/2020 209

Instantiation Stage

Selection in the Parameter Data type Description

instance pane
Instance $Area Integer(1) Area that the instance is assigned to.
Range: 1...255
Default value: Blank.
NOTE: If you have assigned an area value to the folder
(see page 190) containing the instance, the software automatically
assigns the same value to the instance unless you assign a value
manually.
If the software is not able to propagate the value of the Area
parameter to any item because the item is locked, it:
 Displays a notification to inform you which item is locked.
 Rolls back any propagated area value.
 Reverts the Area parameter value that you have entered in the
folder properties to its previous value.
NOTE: The area value is also propagated to Supervision elements
of instances such as genies. However, the change to blank (NULL)
from a non-blank value is not propagated to genies (see page 543)
that are already assigned to a Supervision page (for example,
changing the area value from 3 to 4 is propagated but not changing
it from 3 to blank).
Control node – – You can configure the values of the parameters of the core and
optional Control services that the instance provides through the
selected elements.
The default values are defined in the respective elements of the
template that the instance uses.
For details on parameters of Schneider Electric application
templates, refer to the help (see page 115) of the
Schneider Electric libraries for EcoStruxure Process Expert.
Supervision – – You can configure the values of the parameters of the optional
node Supervision services that the instance provides through the
selected elements.
The default values are defined in the respective elements of the
template that the instance uses.
For details on parameters of Schneider Electric application
templates, refer to the help (see page 115) of the
Schneider Electric libraries for EcoStruxure Process Expert.
(1) You can also enter a string instead of an integer value. In such case, you must refine the Supervision project after
generating it and use the same string as label to name the area; otherwise, the Supervision project does not build
successfully. Refer to the help of the Supervision Participant for details.

210 EIO0000001114 06/2020

 Instantiation Stage

Selection in the Parameter Data type Description

instance pane
HyperLink node – – You can configure the parameters of the optional Documents
service that let you link documents to the instance. You can open
NOTE:
these documents on computers running the operation client when
Requires using
using runtime navigation services (see EcoStruxure™
templates of a
Process Expert, Runtime Navigation Services , User Guide ).
library that
You can link up to five documents.
supports this
You must add documents that you want to link to the content
functionality.
repository first.
For details, refer to the topic describing how to link documents to
instances (see EcoStruxure™ Process Expert, Runtime Navigation
Services , User Guide ).
You can configure the parameters of the optional URL service that
let you associate web links and files to the instance. You can open
these links on computers running the operation client when using
runtime navigation services (see EcoStruxure™ Process Expert,
Runtime Navigation Services , User Guide ).
You can link up to five files or URLs.
For details, refer to the topic describing how to associate web links
and files to instances (see EcoStruxure™ Process Expert, Runtime
Navigation Services , User Guide ).
(1) You can also enter a string instead of an integer value. In such case, you must refine the Supervision project after
generating it and use the same string as label to name the area; otherwise, the Supervision project does not build
successfully. Refer to the help of the Supervision Participant for details.

EIO0000001114 06/2020 211

Instantiation Stage

Section 12.2
Instance Indicators

Instance Indicators

Overview
This topic describes the various indicators that appear on folders and instances of the application.

What Is in This Section?

This section contains the following topics:
Topic Page
Instance Progress Indicators 213
Instance Validity Indicator 215
Instance Write-Lock Indicator 216

212 EIO0000001114 06/2020

 Instantiation Stage

Instance Progress Indicators

Overview
Various icons give an indication of the steps that remain before the instantiation and assignment
(see page 383) stages for each instance are completed.
The color of progress icons is used to indicate instance validity (see page 215).
A progress icon is not visible while the checked-out icon (see page 380) is shown.
NOTE: The icons are visible to any user who opens the application.

Meaning of Icons
The following progress information is valid only for instances whose facets are not yet generated.

Icon Condition description

The instance is created or has been pasted without further action.

(0%
progress)
Either one applies:
 The instance properties (see page 206) have been modified at least once but no
assignments have been performed.
 The instance progress is 50% or 75% and existing assignments (see page 383) have been
removed.
 The instance has been imported without impact on Participant projects.

Either one applies:

 Facets of the instance have been assigned but there is still one type of Participant project to
which no facet has been assigned (for example, to a Supervision project).
 At least one facet that is assigned has a status (see page 423) other than Assigned.
 The instance has been imported and has changed the assignment status of at least one
facet to Out Of Date or Deleted.
At least one facet of the instance has been assigned to a Control and Supervision Participant
project respectively and each one has the Assigned status.
No icon All the facets of the instance have the Assigned status.
(100%
progress)

EIO0000001114 06/2020 213

Instantiation Stage

How Icons Appear

The following figure shows an example of the Application Browser displaying several instances
with various completion states, which are indicated by progress icons.

214 EIO0000001114 06/2020

 Instantiation Stage

Instance Validity Indicator

Overview
A dot or progress icon (see page 213) that appears in red color indicates that the configuration of
an instance is invalid.
When the icon appears on at least one instance, it appears automatically on folders in the hierarchy
of the instance.
NOTE: The indicator icon is visible to any user who opens the application.

Meaning of the Icon

Level Icon color Condition description

Instance Red The instance Data status (see page 195) and/or Link
(progress icon or dot for objects status (see page 224) is invalid.
with 100% progress)
Folder Red The icon appears on at least one instance in the child
(dot) structure.

EIO0000001114 06/2020 215

Instantiation Stage

Instance Write-Lock Indicator

Overview
A lock icon lets you see that an instance or folder is being used or modified by another process or
user and that you cannot work on it.

Certain objects that are locked can be opened in read-only mode.

NOTE: The indicator icon is visible to any user who opens the application.

Meaning of the Icon

The lock icon is shown, for example, when either operation is performed on an instance or folder:
 Properties are open (instances only)
 Paste
 Rename
 Links Editor is open
 Export/import
 Update/replace template

216 EIO0000001114 06/2020

 Instantiation Stage

Section 12.3
Linking Instances

Linking Instances

Overview
This topic describes how to link instances of the application to propagate data and how to manage
interface links.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Links Editor 218
Using the Simplified View 221
Instance Link Status 224
Linking Instances 227
Using the RTNS Interface 230
Changing the Destination of a Link 234

EIO0000001114 06/2020 217

Instantiation Stage

Links Editor

Overview
The Links Editor lets you link the exposed application interfaces of an instance to the interfaces of
other instances that are compatible and respect the cardinality of the roles (for example, 1 to 1, or
1 to n). The editor also allows you to change or delete existing application links between instances.
You can use the Links Editor, for example, to map a signal to an application object such as a limit
switch signal to the corresponding input of a valve motor.
Some instances require that you link them to other instances depending on the interface rules of
their templates (for example, you need to link the instance of a motor starter template $TesysTMB
to a communication instance such as a port $MBPortQ); otherwise the status of the Link
(see page 195) of the device instance remains Invalid.
Link any instance with an Invalid Link (see page 224) status with the Links Editor to change the
status to Valid since it is prerequisite to proceed further in the system engineering life cycle.
NOTE:
 Linking instances by using the Links Editor helps avoid having to create such links later by
refining the Control Participant project and provides a level of consistency in terms of Control
resource names.
 Linking an instance to itself is not allowed. If this is required, edit the template used by the
instance or refine the Control project to which facets of the instance are assigned.

Read-Only Mode
You can open the Links Editor for an instance in read-only mode if either condition is true:
 Properties of the instance are being edited.
 The instance is being used in the Links Editor.

In read-only mode (see page 83), you can view existing links of the instance but you cannot create
or modify links.
NOTE: The other way around, when an instance appears in the Links Editor, you can only open it
with the Instance Editor in read-only mode.

Naming Rules for Variable Names

The name of the variable that is created by linking two instances needs to satisfy the naming rules
(see page 99) for the subsequent generation process to complete successfully.

Instance and Links Appearance

In the Links Editor, instances appear as follows:
 With a green outline: Applies to the instance for which you have selected the Edit Links
command and, which is referred to as active. Only one instance can be active in the same Links
Editor tab.
 With a gray outline: Applies to instances that you can link, which are referred to as inactive.

218 EIO0000001114 06/2020

 Instantiation Stage

NOTE: Active and inactive instances can be selected in which case a green border appears around
them.
The following colors are used for application interface links:
 Orange: Default color.
 Blue: When an instance is selected to highlight links that are connected it.

Opening the Links Editor

To open the Links Editor, proceed as follows.

Step Action
1 Right-click the instance that you want to link to one or more other instances, and select Edit
Links.
Result: The Links Editor tab opens inside the work area (see page 118) of the Application
Explorer and displays the selected instance in the center of the editor. The instance appears as
active (see page 218).
NOTE: If the active instance is already linked to other instances, these are shown and appear
as inactive.

Links Editor
The following figure shows an example of the Links Editor, which is open in the work area of the
Application Explorer.

EIO0000001114 06/2020 219

Instantiation Stage

1 Application Browser pane of the Application Explorer from which you can drag instances that
you want to link.
2 Indication of the Link status of the active instance and button to display the Validity Diagnosis
window if the status is Invalid.
3 Active (see page 218) instance from which you have selected the Edit Links command.
4 Inactive instance, which was already linked with the active instance or which you have linked.
5 Application interface link.
6 Inactive instances, which you have dragged from the Application Browser pane to the editor and
which you can link with the active instance.
7 RTNS interfaces (see page 234) (runtime navigation services). Appear in blue and are located
in the header section of the instance.
8 Zoom tools (see page 964).
9 Radar View (see page 972)
NOTE: You can also move the editor background (see page 120).

Impact of Modification of Instance Properties

When you edit an instance by using the Instance Editor and saving the change disables an
interface that was linked, the link is automatically removed.
This may set the Link status (see page 224) of either linked instances to Invalid.

Viewing Interfaces and Interface Description

Not all interfaces of instances that are displayed in the Links Editor are visible by default. You may
need to expand nodes of the interface to show available (green) or unavailable (gray) interfaces.
To make an unavailable interface available, edit the instance and select the element that contains
the interface, and/or configure the element parameter that enables it.
Move the pointer over any interface of an active or inactive instance in the Links Editor to display
a description of the interface in a tooltip.
NOTE: An interface may be compatible, appear as available, and without a link but cannot be
connected (see page 228).

Viewing Linked Instances

Right-click a link between two instances and select Go to. A submenu opens and displays:
 The identifiers of the two instances that are linked.
 For each instance, the name of the element that exposes the interface and its path.

Click an entry to view the instance and highlight the element in the editor.

220 EIO0000001114 06/2020

 Instantiation Stage

Using the Simplified View

Overview
Zooming out to the lowest level in the Links Editor switches the display to the simplified view.
This view mode lets you see at a glance the instances and the relation between them without
showing the details of links, interfaces, and elements of instances.
Some engineering functionalities are not available.
To exit the simplified view, zoom in.

Restrictions of the Simplified View

The table describes the restrictions in the Links Editor while the simplified view is active.

Actions or object Restrictions

Actions related to links such as creating and moving Actions are not allowed
Elements and interfaces Are not shown
Multiple links to and from an instance Are shown as a single line

EIO0000001114 06/2020 221

Instantiation Stage

Description
The following figure shows an example of instances as they normally appear in the Links Editor.

222 EIO0000001114 06/2020

 Instantiation Stage

The following figure shows the same view when simplified view is active (the view is enlarged for
better visibility).

1 Instances maintain their relative size and position to preserve the aspect of the layout.
2 Links between instances are grouped into a single line.

EIO0000001114 06/2020 223

Instantiation Stage

Instance Link Status

Overview
The Link status of an instance can be one of the following:
 Valid: The interface rules and interface element rules that are defined at the template level are
satisfied.
 Invalid: At least one of the defined interface rules or interface element rules are not satisfied.

You cannot assign to projects instances that have a Link status that is Invalid.

When the status is displayed as Invalid, click the validity status information button to open the
Validity Diagnosis window, which contains information about the cause of the invalid status.
NOTE: In the Links Editor, the validity status applies to the active instance (see page 218).

224 EIO0000001114 06/2020

 Instantiation Stage

Validity Diagnosis Dialog Box - Interface Rules

The following figure shows an example of the Interface Rules tab of the Validity Diagnosis dialog
box.

Item Description
1 Tab displaying information on interface rules of the instance with invalid Link status.
2 Tab displaying information on rules of interface elements (see page 226) of the instance with
invalid Link status.
3 By default, this section displays only the elements of the instance for which at least one
interface rule is not satisfied.
4 Path to the element whose interface rules are shown. You can view the element by editing
the instance (see page 200).

EIO0000001114 06/2020 225

Instantiation Stage

Item Description
5 Shows for each element, the rules that are defined and their status.
6 Filter (see page 138).
7 Select the check box to view elements of the instance for which an interface rule is defined
independently if the rule is satisfied or not.
8 Hover with the pointer over Legend to view an explanation of the statuses displayed in the
rule columns.

The table describes the Legend of the Validity Diagnosis window.

Item Description
9 The link is required to satisfy the rule.
10 Remove the link; otherwise the Status remains Invalid.
11 The link is made, which satisfies the rule.
12 No link is made in accordance with the rule.
13 The link is optional and a link is made.
14 The link is optional and no link is made.

Validity Diagnosis Dialog Box - Interface Element Rules

The figure shows the Interface Element Rules tab, which is available if rules exist for elements of
an interface. In this example, interface PVRange, which is one of the interfaces shown in the
Interface Rules tab has three elements for which a rule is defined but not satisfied.

226 EIO0000001114 06/2020

 Instantiation Stage

Linking Instances

Creating Interface Links

To create an interface link between two instances, proceed as follows.

Step Action
1 From the Application Browser pane, drag the instance that you want to link next to the active
instance (see page 218), which is displayed in the Links Editor.
Result: The instance is shown next to the active instance as inactive.
NOTE: You can drag additional instances to the editor.
2 From the active or inactive instance, position the pointer over an interface and when the pointer
turns into a hand, click and move the pointer away from it while holding down the left mouse
button.
Result: A green line appears and follows the pointer. You can release the mouse button.
NOTE: Press ESC to return to the normal pointer function.
3 Move the pointer over the other instance.
Result: The software automatically highlights compatible and available (see page 228)
interfaces of the instance and snaps the green line to the nearest matching connector.
4 Click to confirm the connection or move the pointer to another highlighted interface until the line
snaps to it.
Result: When you click, the software:
 Links the interfaces of both instances with a line.
 Changes the status of the active instance to Valid if the interface rules are satisfied (if
applicable).
NOTE: To delete the link, right-click the line and select Delete.
5 Verify that the status of the active instance is Valid; otherwise click the validity status information

button to display the Validity Diagnosis window and make the required links until the
instance status becomes Valid.
NOTE: You can only make links between an active and an inactive instance. To link the inactive
instance with another inactive instance, right-click the header of the inactive instance and select
Edit Links. The inactive instance becomes active.
6 Repeat steps 1...5 until you have made the required links.
7 Close the Links Editor tab.

EIO0000001114 06/2020 227

Instantiation Stage

Removing Instances from the Links Editor

You can remove inactive instances from the Links Editor.
To do so, right-click the header of the inactive instance that you want to remove and select Remove
Instance. This also removes links that may exist with the active instance after you confirm the
command.
NOTE: The software does not remove interface links that the instance that you are removing may
have with other instances, and which are not displayed in the current Links Editor tab.

Available Interfaces That Cannot Be Connected

The interface of an inactive (see page 218) instance may appear as available and be compatible
but the link does not snap to it. This can be the case if a link with the interface exists but is not
visible and the interface accepts only one connection at a time.
To view the links of an instance, open it in the Links Editor so that it is the active instance or open
the Inspect Instance window (see page 236).
In the following example, interface ILCK of Motor_1 is connected to DISignal_UL_1 and the
Links Editor is closed.

228 EIO0000001114 06/2020

 Instantiation Stage

When you open the Links Editor for DISignal_UL_2 and drag Motor_1 to the editor, its ILCK
interface appears available. Yet, the link being created from DISignal_UL_2 does not snap to
ILCK. This is because Motor_1 is an inactive instance and its links to other instances
(DISignal_UL_1) are not shown in this view.

EIO0000001114 06/2020 229

Instantiation Stage

Using the RTNS Interface

Purpose of the RTNS Interface

When no application link is required between instances, you can use the RTNS interface to link
them so that they appear in the Linked Production Assets section of the operation client
(see EcoStruxure™ Process Expert, Runtime Navigation Services , User Guide ).
The cardinality of the interface is n to n and it can be connected only to another RTNS interface.

Using the RTNS Interface

You can create a link between any instances that exist in the application by using this interface.
The procedure to create an RTNS link is the same as the one to create a regular interface link
(see page 227).
NOTE:
 Creating an RTNS link between two instances that are already linked by an application link has
no effect.
 Adding or removing an RTNS link between two instances does not change the assignment
status (see page 481) of facets of these instances.

RTNS Interface Identifiers and Roles

Representation Identifier Role

NullInterfaceRoleA A

NullInterfaceRoleB B

230 EIO0000001114 06/2020

 Instantiation Stage

Examples
In the following example, three instances are linked but no link exists between R1_EMPortM_1 and
R1_Motor_1. To be able to view also information of R1_EMPortM_1 in the operation client when
accessing runtime navigation services from Motor_1, you can create an RTNS link with
R1_EMPortM_1 (shown here as a dotted line for illustration purposes).

EIO0000001114 06/2020 231

Instantiation Stage

In the following figure, the RTNS link was created by selecting the Edit Links command from
R1_Motor_1 (from the previous example) and connecting its RTNS interface with the one of
R1_EMPortM_1.

1 Existing interface link

2 RTNS link. The link is only visible when either of the linked instances is active (see page 218).

232 EIO0000001114 06/2020

 Instantiation Stage

The following example shows the result in the operation client window when you access runtime
navigation services from R1_Motor_1. Instance R1_EMPortM_1 also appears in the Linked
Production Assets section because of its RTNS link with R1_Motor_1.

EIO0000001114 06/2020 233

Instantiation Stage

Changing the Destination of a Link

Overview
By using the Links Editor, you can change the destination of an existing link by dragging it to
another interface.
The new destination interface can belong to the same or a different instance.

Destination Interfaces

The destination interface features a male connector .

It is typically the interface with the REF role.

Changing a Link Destination

To change the destination of an interface link, select the link and drag the black dot that appears
on the destination connector to another compatible and available interface.

234 EIO0000001114 06/2020

 Instantiation Stage

Section 12.4
Managing Application Folders and Instances

Managing Application Folders and Instances

Overview
This section describes the Instance Inspector and the functionalities that are available in the
software to manage many application folders and instances.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Viewing Instance Configuration 236
Changing the Application Hierarchy 238
Copying and Pasting Application Folders and Instances 239
Moving Application Folders and Instances 241
Updating and Replacing Templates of Instances 245

EIO0000001114 06/2020 235

Instantiation Stage

Viewing Instance Configuration

Overview
The Inspect Instance command lets you view the entire composition of any instance of the
application along with current values of its parameters, elements, functions, and interfaces.
The functionality does not allow you to change values.

Opening the Inspect Instance Window

In the Application Browser, right-click an instance and select Inspect Instance.

Inspect Instance Window

The following figure shows an example of the Inspect Instance window for an instance of the
application.

236 EIO0000001114 06/2020

 Instantiation Stage

The table describes the various components of an instance that you can view in the left-hand pane
of the Inspect Instance window.

Component Description
Instance identifier Identifier of the instance from which you have opened the Inspect Instance window.
Elements Elements of the instance grouped by Participant (for example, Control)
Inside each category, you can view the hierarchy of elements as they are visible in the
Instance Editor down to the constituent level.
Functions Binding functions (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual) that are used by the parent element.
For example, it lets you view information related to the location of an instance in the
application, which can be provided by the LocationGet function.
Interfaces Interfaces that are referenced by the parent element.
For each interface, you can view its identifier, role used by the element, its template
identifier, parameters, and their current value.

The table describes the parameter information that you can view in the right-hand pane of the
Inspect Instance window. The data pertains to the component that is selected in the left-hand pane
of the window.

Header Description
Name Name of the parameters of the element grouped by category.
Description Description of the parameter.
Type Data type of the parameter.
Value Current resolved value of the parameter (see page 201) or property.

EIO0000001114 06/2020 237

Instantiation Stage

Changing the Application Hierarchy

Changes Impacting Assigned and Generated Supervision Facets

When you change the hierarchy of the application, facets of instances that are assigned to a
Supervision project and generated are affected when they generate equipment based on this
hierarchy (see page 496). The table details these changes and their impact.

Change Impact
Moving an application folder to a different The assignment status of any facets of any instances that
parent folder. the folder and its subfolders contain is set to Out Of Date.
Modifying the identifier of a folder.
Moving an instance to a different folder. The assignment status of any facets of the instance is set
to Out Of Date.

For information on steps that you need to take to integrate the changes into the system, refer to
Generating Control or Supervision Projects After Changes (see page 488).

238 EIO0000001114 06/2020

 Instantiation Stage

Copying and Pasting Application Folders and Instances

Description of the Functionality

You can copy and paste instances and application folders:
 Within the application of a system.
 Between applications of different systems.

The Notification Panel provides detailed information about the result of the paste process.
NOTE: Pasting instances affects the instance count (see page 198).
The table describes the effects of the copy and paste functionality when applied to application
folders and instances.

Item Effect
Folders and instances The copied folder and any instances that it contains, including any subfolders and
their contents are pasted.
NOTE:
 When you select the Copy command for a folder, this folder, any subfolders,
and any instances they contain are copied. This is the case even if you initially
selected, in addition to the folder, only one of the instances or subfolders it
contains with the intention to copy only the selected items.
 If you delete an instance or a folder after copying it, you cannot paste it. Also, if
you copy a folder containing several instances and you delete an instance in
this folder, when you paste the folder, the instance that you deleted is not
pasted.
Folder identifier and If the folder identifier already exists at the same hierarchical level, or the instance
instance name identifier already exists in the target location, the software changes the folder
identifier or the instance name by adding an incremental numerical value as suffix;
otherwise the identifier or instance name is not changed.
For example, Motor_1 becomes Motor_1_1, and Folder_1 becomes
Folder_1_1).
NOTE: If the hierarchical naming function (see page 208) is activated for an
instance, the software changes the instance identifier according to the new location
of the instance and the alias of the folders in its path.
Interface links Interface links are maintained between pasted instances like they were defined
between the original instances if you copy and paste the instances that are linked
at the same time.
Interface links can be copied across systems under the same conditions.
Other user-defined The software does not modify the data during the paste process. Therefore,
configuration data relative expressions that the software has created at the instantiation stage could
produce different results when applied to the new location.
Also, when you paste a folder and/or instance in a folder to which you have
assigned an area value (see page 188), this value is propagated to the pasted
items if they do not have an area value yet and if they are not locked. For details
refer to the topic describing the propagation of the area parameter value
(see page 190).

EIO0000001114 06/2020 239

Instantiation Stage

Aborting Paste Tasks

After selecting the Paste command, the abort icon is displayed in the notification panel
(see page 86). Click the icon to cancel the task. No instances and folders are pasted.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are pasting only a few items, the task may complete before you are able to click the
icon.

Copying and Pasting Instances

To copy and paste instances, proceed as follows.

Step Action
1 Expand the folder that contains the instances that you want to copy.
2 Select the instances.
You can make multiple selections within one folder by holding:
 The Shift key for contiguous instances.
 The Ctrl key if instances are non-contiguous.

3 Right-click a selected instance and select Copy.

4 Right-click the destination folder and select Paste.
You can select multiple folders as targets.
NOTE: If the target is not valid for pasting, the command is not available. Also, you cannot
paste in the Application Browser in grid view mode.

Copying and Pasting Application Folders

To copy and paste application folders, proceed as follows.

Step Action
1 Right-click the folder that you want to copy and select Copy.
You can make multiple selections within the Application Browser by holding the Ctrl key.
2 Right-click the destination folder and select Paste.
You can select multiple folders as targets.
NOTE: If the target is not valid for pasting, the command is not available. Also, you cannot
paste in the Application Browser in grid view mode.

240 EIO0000001114 06/2020

 Instantiation Stage

Moving Application Folders and Instances

Overview
You can move instances and application folders:
 Within the application of a system.
 Between the applications of different systems.

Both actions change the structure of the application (see page 173). The software displays a
notification informing you of the possible impact on the assignment status of already assigned
facets before executing the move operation.
Once the move operation is completed, if the software had to make changes to folder and/or
instance identifiers to satisfy naming rules, it displays the Move Summary window (see page 243)
to inform you of the changes.
NOTE:
 You cannot move instances within a folder.
 You can change the position of folders without modifying the hierarchy of the application
(see page 244).

Moving Folders and Instances

By using the Application Browser pane, you can select a combination of folders and instances to
move them at once. This is possible in tree view mode only.
When you move a folder, this folder, any subfolders, and any instances they contain are moved.
This is the case even if you initially selected, in addition to the folder, only one of the instances or
subfolders it contains with the intention to move only the selected items.
NOTE:
 You can make multiple selections by holding the Shift key for contiguous and the Ctrl key for
non-contiguous items.
 If sorting and/or filters are applied, they are also applied to instances and folders that you have
moved.

EIO0000001114 06/2020 241

Instantiation Stage

Effects of the Move Operation

The table describes the effects of the move operation when applied to application folders and
instances.

Item Effect
Folders and Moves the folder and any instances that it contains, including any subfolders and their
instances contents.
Folder identifier and If the folder identifier already exists at the same hierarchical level, or the instance
instance name identifier already exists in the target application, the software changes the folder
identifier or the instance name by adding an incremental numerical value as suffix;
otherwise the identifier or instance name is not changed.
For example, Motor_1 becomes Motor_1_1, and Folder_1 becomes
Folder_1_1).
NOTE: If the hierarchical naming function (see page 208) is activated for an instance,
the software changes the instance identifier according to the new location of the
instance and the alias of the folders in its path.
Interface links Interface links are maintained between instances if you move the instances that are
linked at the same time.
NOTE: Moving Interface links across systems is supported.
Other user- The software does not modify the data during the move process. Therefore, relative
configured expressions that the software has created at the instantiation stage could produce
properties different results when applied to the new location.
Also, when you move a folder and/or instance to a folder to which you have assigned
an area value (see page 188), this value is propagated to the moved items if they do
not have an area value yet and if they are not locked. For details refer to the topic
describing the propagation of the area parameter value (see page 190).

Moving Instances
To move instances, proceed as follows.

Step Action
1 Expand the folder that contains the instances that you want to move.
2 Select the instances.
You can make multiple selections by holding the Shift key for contiguous and the Ctrl key for
non-contiguous instances.
Result: The selected instances are highlighted.
NOTE: To move instances across systems, use two workspaces (see page 118); one for each
application.
3 Drag one of the highlighted instances to the target application folder.
Result: The identifiers of the instances you are moving appear in a tooltip.

242 EIO0000001114 06/2020

 Instantiation Stage

Step Action
4 Release the mouse button.
Result: The software:
 Moves the selected instances to the new location. When no sorting is applied, instances are
inserted in ascending alphabetical order among existing instances.
 Displays the Move Summary window if the software has performed a change to comply with
applicable naming rules.
5 Close the Move Summary window.

Moving Application Folders

To move application folders, proceed as follows.

Step Action
1 Select the folders that you want to move.
You can make multiple selections by holding the Shift key for contiguous and the Ctrl key for
non-contiguous folders.
Result: The selected folders are highlighted.
NOTE: To move folders across systems, use two workspaces (see page 118); one for each
application.
2 Drag one of the highlighted folders that you want to move to the target.
Result: The identifiers of the folders you are moving appear in a tooltip.
3 Release the mouse button.
Result: The software:
 Moves the folders and their contents to the new location. When no sorting is applied, folders
are added at the end of existing folders.
 Displays the Move Summary window if the software has performed a change to comply with
applicable naming rules.
4 Close the Move Summary window.

Move Summary Window

The following figure shows an example of the Move Summary window.

Path Indicates the path to the folder or instance location after the move.
Description Indicates the name change that the software has performed on the folder and/or instance during
the move.

EIO0000001114 06/2020 243

Instantiation Stage

Changing the Position of Folders Without Changing the Hierarchy

You can change the position of folders inside the structure without modifying the hierarchy of the
application. You can do this one folder at a time.

Step Action
1 Verify that no sorting is applied in the Application Browser pane of the Application Explorer and
that tree view mode is selected.
2 In the Identifier column, start dragging a folder along the folder structure until one of the following
messages appears in a tooltip:
 Move X before Y.
 Move X after Y

Where:
 X is the identifier of the folder that you are moving.
 Y is the identifier of the target folder.

3 Release the mouse button.

Result: The software relocates the folder to the selected position.
NOTE: If you release the mouse button while only the identifier of the folder that you are moving
appears in the tooltip, you are changing the hierarchy of the folder structure (see page 241).

244 EIO0000001114 06/2020

 Instantiation Stage

Updating and Replacing Templates of Instances

Overview
In the Application Browser, you can perform the following actions on the template that is used by
an instance of the application. The working principle of both commands is the same. The difference
resides in the choice of templates provided by each command:
Update Template Lets you update the template that is used by the instance with the latest
available version.
When you select the command from a folder, the command applies to any instance that is
contained in the folder and any subfolders, and for which a template of a newer version is
available.
Replace Template Lets you replace the template that is used by one or more instances with
another version of this template or a different template.
NOTE: The Update Template command is also available in the Topological Explorer for certain
topological entities (see page 608).

Updating Versus Replacing Templates

The following examples are given to illustrate the difference between the two commands.
Update Template command:
 The following templates are available in the Global Templates library: $Motor (2.0.0),
$Motor (2.0.1), and $Motor (2.0.2)
 Instance Motor_1 uses template $Motor (2.0.0)
 The command lets you update the template that is used by Motor_1 with $Motor (2.0.2)
only (latest version).
Replace Template command:
 The following templates are available in the Global Templates library: $Motor (2.0.0),
$Motor (2.0.1), and $Valve (3.0.0)
 Instance Motor_1 uses template $Motor (2.0.1)
 The command lets you replace the template that is used by Motor_1 with either:
 $Motor (2.0.0): Same template, any available version.
 $Valve (3.0.0): Different template.

Using the Commands on a Folder

When you select the Update Template or Replace Template command at the folder level, the
command is performed on this folder, any subfolders, and any instances they contain.
This is the case even if you initially selected, in addition to the folder, only one of the instances or
subfolders it contains with the intention to perform the command only the selected items.

EIO0000001114 06/2020 245

Instantiation Stage

Accessing the Commands

Update Template Right-click one instance, a selection of several instances in the same or in
various folders, the root folder, or any application folder, and select the command.
The command executes only if a newer version of the template that is used by the instance is
available in the Global Templates library.
Replace Template Right-click one instance or a selection of several instances in the same folder,
and select the command.

Description of the Functionality

The software proceeds with the update or replacement of a template in the following order:
 The template that is associated to the instance is updated or replaced.
 Interface links are processed.

The following conditions need to be satisfied:

 The template or template version that you want to use must be available in the Global Templates
library.
 It needs to have the usability state Approved (see EcoStruxure™ Process Expert, Global
Templates, Reference Manual) or Deprecated.
NOTE: Refer to Importing Templates (see page 987).

246 EIO0000001114 06/2020

 Instantiation Stage

The table describes the effects on the various template components when you update or replace
the template that is used by an instance.

Template Identifier in new template(1) Effect

component
Element The identifier of the element and  The element is maintained or updated. If updated, the status of
its path in the composition of the the corresponding facet is set to Out Of Date if the facet was
template is the same as in current generated.
template. Refinements that you have made are preserved if the element
that creates the facet encapsulates the same constituents.
 The element selection that you have made in the current
template is applied to the new template.
For example, in the current and the new template, the Interlocks
element is at the path Control\Interlocks. If it was selected in the
current template, it is selected in the new template.
 If the identifier of the template used by the corresponding facet
(Facet Template column) is different, the status of the facet is
set to Out Of Date if the facet was generated.
NOTE: If you replace a control module template (highest level
template) by one that has a different identifier but an identical
composition, no changes are made to the instance, except for the
template identifier.
The identifier of the element does The element is added and the corresponding facet is created.
not exist in the current template or An optional element that is not part of the current template keeps
the path to the element is different. its default value (selected or cleared).
NOTE: Any element of the current template whose identifier does
not exist in the new template or whose path is different is removed.
Parameter Is same as in current template Explicitly defined parameters of the current template keep their
value respective value in the new template.
Is not in current template New parameters that are not part of the current template keep their
default value.
Interface – The software re-establishes interface links that are valid after the
link template update or replacement in their original configuration.
The software discards interface links that are not valid after the
template update or replacement because, for example:
 The cardinality of the interface role is not respected.
 A linked element does not exist anymore.
 An incompatibility of the type and/or role of the interface.

(1) The term new template refers to either a different version of the same template or a different template

This example illustrates the impact of a template update operation on generated Control facets of
an instance. In this scenario, instance Valve_1 uses template $Valve version 1.3.9. The optional
Maintenance service is selected at the instance level.

EIO0000001114 06/2020 247

Instantiation Stage

The following figure shows the composition of the template as it appears in the Instance Editor.
Elements appear in the Name column and the identifier of the template that is used by the
corresponding facet in the Template column.

The following figure shows the Control facets (Facet column) of instance Valve_1, which are
assigned to a section of a Control project. By relating this information to the one shown in the
Instance Editor, you can see, for example, that element LowLimitSwitch creates facet
Valve_1_ZSL by using template $DISignal_UL. This information is also visible at a glance in the
View Assignments window (see page 438).

248 EIO0000001114 06/2020

 Instantiation Stage

$Valve 1.3.9 is updated to version 1.3.10 by using the Update Template command.
$Valve 1.3.10 has a modified Interlocks service, which is provided by the modified CONDSUM1_UL
template. All other elements are identical.

The result of the template update operation shows that one facet has a modified assignment
status. All facets remain generated.

1 The facet created by the CONDSUM1_UL template (Interlocks service) has a status of Out Of Date because
the already generated constituents (from $Valve 1.3.9) are not consistent with the constituents of the
modified CONDSUM1_UL template anymore. Generating the section injects the constituents coming from
the modified CONDSUM1_UL template into the logical Control Participant project.
2 The optional Maintenance service remains selected after the template update because it is also available
in the latest version of $Valve.

EIO0000001114 06/2020 249

Instantiation Stage

This example illustrates the impact of a template replacement operation on generated Control
facets of an instance. In this scenario, instance Motor_1 uses template $Motor. $Motor has an
Interlocks service provided by the CONDSUM1_UL template. The optional Maintenance service is
selected at the instance level.

$Motor is replaced with $Valve by using the Replace Template command. Compared to
$Motor, $Valve has a modified Interlocks service, which is provided by the modified
CONDSUM1_UL template (located at the same path). The Maintenance service is identical in both
and provided by the same template at the same path. Their other elements are either different (for
example, $CONDSUM_UL) or located at a different path (for example, $DEVCTL_UL) in the
composition of the control module template.

250 EIO0000001114 06/2020

 Instantiation Stage

The result of the template replacement operation shows that several facets have a modified
assignment status.

1 These two facets are deleted because in $Valve, $DEVCTL_UL is at a different path and $CONDSUM_UL
does not exist. Generating the section removes the corresponding constituents from the logical Control
Participant project.
2 The facet providing the Interlocks service is set to Out Of Date because Valve contains this service
(provided also by $CONDSUM1_UL) but a modified version of it. Already generated constituents (from
$Motor) are not consistent with the constituents of the modified CONDSUM1_UL template anymore.
Generating the section injects the constituents coming from the modified CONDSUM1_UL template into the
logical Control Participant project.
3 The optional Maintenance service is not affected because it is identical for both templates. The Instance
Template column indicates that the facet is now created by the Valve template.

In the Assignment Editor, you can see the facets that are specific to Valve and that have been
created for the Motor_1 instance. You need to assign these to the section as needed. These
facets have the Candidate status. By default, the software assigns them automatically
(see page 425).

NOTE: The same that is described in the above examples for Control facets also applies to
Supervision facets of the instance.

Updating or Replacing Templates of Linked Instances

When instances are linked by interface links (Links Editor), update the templates of these instances
at once (see page 253) to maintain the links.

EIO0000001114 06/2020 251

Instantiation Stage

Updating or Replacing Templates Containing a New Version of a Type

When you update or replace the template used by an instance and the Control facets that are
referenced by the instance are already generated, if the new template that you have selected
contains a version of the type that is different from the one that has been generated, the software
requires that you select the version to be used when you generate the Control Participant project.
In certain cases, generation may not be able to complete successfully. For details, refer to the topic
describing the selection of type versions during generation (see page 456).
NOTE: To view the version of a type that is used by a facet, edit the facet encapsulating the type
by using the Global Templates explorer, select the element that represents the type, and click
Templatizer. The version of the type is indicated in the Global Types section of the Select Variables
window (for example, DEVCTL 0.01.

Validating Instance Identifiers

When you perform a template replacement operation, the software verifies if the result of the
operation satisfies the uniqueness requirement for instance identifiers. If it does not, it displays the
Replace Template Summary dialog box, which indicates which instance creates a duplicate
identifier, and cancels the replace operation.
This can be the case if:
1. Two instances use a different template but have the same identifier.
2. You replace one of the two templates with the same template that the other instance uses.
For example:
 The application contains two instances:
 Valve_1, which uses template $HandValve
 Valve_1, which uses template $Valve

 If you replace template $HandValve by template $Valve (any version), the two instances use
the same template and have the same identifier. This is not allowed.
NOTE: When replacing a template creates an element with the same identifier as the element of
an existing instance, you can still proceed with the template replacement but the Data status of the
instance is set to Invalid.
For example:
 The application contains two instances:
 Pump_1, which uses template $Motor
 Pump_1, which uses template $HandValve

 If you replace template $HandValve by template $Valve (any version), although the two
instances do not use the same template, they have the element Logic in common, which has
the same identifier (Pump_1_DEVCTL) in both instances because both instances have the same
identifier. This is not allowed.

252 EIO0000001114 06/2020

 Instantiation Stage

Updating the Template of One Instance

To update the template that is used by one instance, proceed as follows.

Step Action
1 Right-click the instance that you want to update and select Update Template.
Result: The Update Template dialog box opens. It shows the latest version of the template that
is available for the update.
2 Click OK.
Result: The software:
 Updates the template that is used by the selected instance with the latest version of the same
template.
 Displays the version of the template that is used by the instance after the update in the
Version column.
 Displays the result of the update process in the Notification Panel.

NOTE: Click Cancel to close the dialog box without updating the template.

NOTE: To revert to an earlier version of a template, use the Replace Template command.

Updating the Templates of Several Instances

To update the templates of several instances of the application at once, proceed as follows.

Step Action
1 Right-click the root folder of the application and select Update Template.
Result: The Update Template dialog box opens, which:
 Lists the templates, which are used by instances of the application for which a template of a
later version is available. It indicates the current version of the template and the latest version
that is available for the update.
 Indicates, for each template, the instances that are using the template with an indication of
the location of the instances (Path).
2 Select the instances that you want to update:
 Instance by instance.
 By template.
 Through a combination of both.

3 Click OK.
Result: The software:
 Proceeds with the update of the template that is used by the selected instances.
 Displays the version of the template that is used by each instance after the update in the
Version column.
 Displays the result of the update process in the Notification Panel.

NOTE: Click Cancel to close the dialog without updating the templates.

NOTE: If you use a filter in the Name column of the Update Template dialog box and as a result,
not all the instances that you had selected are displayed, the update operation is still performed on
the entire selection of instances.

EIO0000001114 06/2020 253

Instantiation Stage

Replacing Templates of Instances

To replace the template that is used by one or more instances, proceed as follows.

Step Action
1 Select one or more instances and/or one or more folders.
Result: The software highlights the selected items.
2 Right-click a highlighted item and select Replace Template.
Result: The Replace Template dialog box opens.
3 Click the Select Template list.
Result: The software displays the list of templates that are available for the replace operation.
4 Select the template that you want to use by scrolling or entering a keyword in the field of the
menu.
To search by entering the first letter of the template identifier, enter also the $ prefix for
Schneider Electric templates (for example, $m).
5 Click OK.
Result: If the result of the replacement operation does not satisfy the identifier uniqueness
requirement, the software displays the Replace Template Summary dialog box and cancels the
replace operation.
If no conflict is detected, the software:
 Closes the dialog box and replaces the template that is used by the instances with the
template that you have selected.
 Displays the identifier and the version of the template used by the instances respectively in
the Template and Version columns.
 Displays the result of the replace process in the Notification Panel.

NOTE: Click Cancel to close the dialog without replacing the template.

NOTE: If you use a filter in the Instance column of the Replace Template dialog box and as a result,
not all the instances that you had selected are displayed, the replace operation is still performed
on the entire selection of instances.

254 EIO0000001114 06/2020

 Instantiation Stage

Section 12.5
Exporting and Importing Application Objects to CSV and XML Formats

Exporting and Importing Application Objects to CSV and XML

Formats

Overview
The export and import functionality lets you create comma-separated value (CSV) or XML files and
import them into the application of the same or another system.
This allows you to:
 Move or copy the entire application or a selection of folders and instances to another system.
 Perform bulk processes such as creating, modifying and/or deleting instances, folders, and
interface links by editing the exported file.
This topic describes how to export objects, edit the export file to perform the required changes, and
import it.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Exporting Folders and Instances to CSV and XML Formats 256
CSV Application Export File 259
Editing the CSV Application Export File 263
XML Application Export File 275
Editing the XML Application Export File to Manage Folders and Instances 277
Editing the XML File to Manage Interface Links 283
Importing a CSV or XML File Into the Application 287

EIO0000001114 06/2020 255

Instantiation Stage

Exporting Folders and Instances to CSV and XML Formats

Overview
You can export application folders, instances, and interface links by using the Export command of
the Application Explorer.
The application objects and their respective configuration parameters are saved to an export file in
comma-separated (see page 264) value (CSV) or XML format.
For example, you can use the export file to import (see page 287) the application into another
system while modifying some parameters, which helps avoid having to create it from scratch. Also,
you can use it to restore instances after deleting them or to restore them to an earlier state.
NOTE: You also need to export templates (see page 983) that are used by the instances that you
are exporting if the same version of template is not present in the Global Templates library of the
target system at the time of import. Instances whose template is not present cannot be imported.

Good Practices
 If you intend to edit the export file, try to limit your export selection to the objects that you want
to modify or delete, for example, by using filters (see page 138) in the Application Browser. It
reduces the steps to manage unwanted objects during import and speeds up the process.
 If you want to create instances, export, at least, one instance that uses the same template. If
you want to create interface links, export, at least, two instances that are linked. This lets you
use the data as model. For example, you can copy and paste it and modify only necessary
location, element, and/or parameter values.

Export Format Selection

The CSV (see page 259) and XML (see page 275) export files contain similar information and let
you perform the same actions.
Data in CSV format can appear more comprehensible and easier to manage by using a
spreadsheet editor because of its user-friendly, tabular presentation. Also, it facilitates the
integration of existing data, such as an asset list, depending on their format.
Exporting to XML may be preferred by users who are familiar with the use of structured data and
more powerful XML editors.
NOTE: You cannot update existing interface links by using the XML format.

Invariant Culture
The software uses the invariant culture (see page 265) to format parameter values independently
of the language setting that is used on the computer on which you create the export file.
For example, a decimal value that appears as 5,5 (comma separator) in the Instance Editor
because of your regional settings appears as 5.5 (dot separator) in the export file.

256 EIO0000001114 06/2020

 Instantiation Stage

Software Version Compatibility

You can import into a system instances that were exported from an earlier version of the software.
Some restrictions apply (see page 287).

Object Selection
You can select the following objects to export them:
 One or several instances: Exports the data pertaining to the selected instances and their
location in the folder structure of the application. You can select individual instances located in
various folders and export them at once.
 One or several application folders: Exports the data pertaining to the selected folders, the
instances contained in the folders, and in any subfolders.
 The root folder of the application: Exports any application folders and instances of the system.

An interface link is exported only if both linked instances are exported.

NOTE: When you select the Export command for a folder, this folder, any subfolders, and any
instances they contain are exported. This is the case even if you initially selected, in addition to the
folder, only one of the instances or subfolders it contains with the intention to export only the
selected objects.

Aborting Export Tasks

After confirming the export by clicking Save in the Save As dialog box, the abort icon is displayed
in the notification panel (see page 86). Click the icon to cancel the task. The export file is not
created.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are exporting only a few objects, the task may complete before you are able to click
the icon.

EIO0000001114 06/2020 257

Instantiation Stage

Creating the Export File in CSV or XML Format

To export application objects, proceed as follows.

Step Action
1 In the Application Browser, select the objects that you want to export.
Use filters and sorting (see page 138) to facilitate the selection.
2 Right-click your selection and select Export.
Result: The Export dialog box opens.
3 Select the location, file name, and format for the export file.
4 Click Save.
Result:
 The export file containing the selected objects is created.
 A summary of the exported objects is displayed in the notification pane.

NOTE: If any object that you have selected for export is open in the Instance Editor, Links Editor,
accessed for an assignment, update, or replace operation, or if its Properties tab is open, you
cannot create the export file.

258 EIO0000001114 06/2020

 Instantiation Stage

CSV Application Export File

Export File Description

When you export application objects to comma-separated (see page 264) format (CSV), two files
are created.

File Default file name Content and purpose

Application export <System identifier> Data of the folders, instances, and interface
file links that you have exported.
The data is organized in three types of
groups.
You need to edit the content (see page 668)
of this file to create, modify, or delete
application objects.
Application <System identifier>_Pending Data on application interfaces that the
interface data Interfaces where _Pending exported instances expose and that are not
supporting file Interfaces is appended to the file name connected. It includes interfaces that are
once the file is created. disabled.
The data is organized by instance name.
It helps you edit data of the InterfaceLinks
group in the application export file by
providing the necessary data of each
interface that you can connect.

EIO0000001114 06/2020 259

Instantiation Stage

The following table describes the grouping of data in the application export file. Each group has a
group header and a header row, which describes the data of objects.

Group header Description

Folders Groups that contain folder data (see page 265).
More than one group exists when you export folders that have
a different number of parameters as part of the optional folder
properties.
The number of columns depends on the folder configuration. A
column with its header exists for each system parameter and
each configured optional parameter.
NOTE: A group header and its header row appear only if the
export file contains folder data.
TemplateIdentifier=<Template ID> Groups that contain instance data (see page 265).
Version=<Value> where: There are as many groups as templates and versions used by
 <Template ID> is the identifier of the exported instances.
template that is used by the instance. The number of columns depends on the instance
 <Value> is the template version. configuration. A column with its header exists for each element
and parameter of the instance.
Example:
TemplateIdentifier=$Motor NOTE: A group header and its header row appear only if the
Version=3.1.0 export file contains instance data.
InterfaceLinks Group that contains the data of interface links (see page 265),
which link exported instances.
The number of columns and their headers are fixed.
NOTE: The group and its header row appear at the bottom of
the file and are always present.

260 EIO0000001114 06/2020

 Instantiation Stage

Example of CSV Export Files

The following example shows two instances, which have been linked by an interface link.

The following figure shows a partial view of the resulting export file when you export folder Cell
to CSV format.

1 Export file information that is added by the software.

2 Group headers.
3 Header rows.
4 Element of the instance and its selection state.
5 Parameter of the instance and its configured value.
Parameters appear right after their parent element.
6 Parameter of the instance for which no value is configured.
7 Data rows of exported objects (one row per object, such as a folder, an instance, or an interface
link).

EIO0000001114 06/2020 261

Instantiation Stage

The following figure shows a partial view of the supporting file that is created.

262 EIO0000001114 06/2020

 Instantiation Stage

Editing the CSV Application Export File

Overview
By editing the application export file (.csv), you can create, update, and/or delete application
objects.
Various rules and requirements apply when you open and edit CSV export files. They are
described in this topic.
You can use the supporting file (*_PendingInterfaces.csv) to help with the editing of
interface link data.
The software applies the changes when you import the edited CSV file (see page 287) into the
application of the system. At that time, you have the possibility to review and modify the list of
imported objects (except interface links).

Good Practices
 Before editing an application export file, create a copy of it. If needed, it lets you restore the
original application.
 Edit only an up-to-date export file to help avoid data conflicts when importing.
 Carefully remove from the file objects that are not impacted by the import, for example,
instances that you are not updating or deleting.
 When you use data from the supporting file to create or update interface links, cut the data rather
than copying it to help avoid connecting the same interface several times.
The other way around, add to the supporting file data of interfaces that you are disconnecting.

Opening the CSV File by Using a Spreadsheet Editor

When you open a CSV export file by using a spreadsheet editor, some instance parameter values
(for example, durations with millisecond values, certain special characters, or strings starting with -
(hyphen)) may get modified by the editor.
So that these values remain unchanged, you first need to import the data into a blank workbook in
Unicode (UTF-8) format.
Follow this procedure. Microsoft® Excel® is used as an example. Menu items and dialog box
names may vary depending on the version.

Step Action
1 Open a blank workbook.
2 In the Data menu, select to import from text or CSV.
3 In the Import Text File dialog box, select the exported CSV file.
(1) You may need to edit the file during the import process to access the attribute

EIO0000001114 06/2020 263

Instantiation Stage

Step Action
4 Select the following attribute values for the import of data:
 File origin: 65001 : Unicode (UTF-8)
 List separator (delimiter): Comma
 Format for all columns (data type): Text(1)
 Use First Row as Header(1) (depending on version): Open the menu and select this setting even if
it is already selected by default.
5 Load the values to the blank workbook.
NOTE: After loading is completed, the first row of the CSV file must start with ;Export
Version=<Software Version>. You may see additional text in columns E and higher of the first row (for
example, Column1, _1). This text is treated as comment (see page 272) and ignored during import.
The following example shows an extract of a CSV export file after selecting Use First Row as Header
and loading values to the blank workbook.

6 Save the workbook in CSV UTF-8 (comma delimited) format (keep saving in this format when you edit
the file).
(1) You may need to edit the file during the import process to access the attribute

Setting the List Separator Format

CSV export files use the comma as list separator (delimiter) independently of the setting that is in
effect on the computer on which the file is created.
If the format of the list separator on the computer is different from comma, data will not be displayed
correctly when you open the export file by using a spreadsheet editor.
To verify the setting and change it to comma if necessary, open the Windows® Control Panel and
click Clock and Region → Region. In the Formats tab, click Additional settings....
NOTE: For information on how to use commas in values of string data types in the CSV file, refer
to the topic describing editing rules (see page 272).

264 EIO0000001114 06/2020

 Instantiation Stage

Using the Invariant Culture

Use the invariant culture to modify or add parameter values in the application export file.
If required, during import the software converts the format according to the language setting that
is used on the target computer.
The table describes the formats of the invariant culture that are used in the export file.

Type Format Example

Decimal separator x.y 2.5
Time hh:mm:ss 14:30:00
Date mm/dd/yyyy 11/20/2014
Date Time mm/dd/yyyy hh:mm:ss 11/20/2014 14:30:00
Duration DD.hh:mm:ss.ms 10.12:30:10.15 translating into 10 days 12 hours 30 min
10 sec 15 msec

Application Export File Content Requirements

This topic describes the columns that appear in the each type of group and the requirements for
each one. Use this information when you edit existing data, add columns, and/or add entire groups.
For details on the format of the group headers, refer to the topic describing the export file
(see page 259).
Folders group (see page 259). The information applies to each group that appears in the file or
that you add.

Header Description Requirement

$Action Action that is performed on the Possible values (not case-sensitive):
folder during import.  Create (default)
 Update
 Delete
 Blank:
 Creates the folder if it does not
exist yet.
 Updates the folder if it exists.

$Location Path to the folder in the application A column with this header and a valid
starting from the system root value in each row are required.
folder. The path must exist in the application or
Example: be created by the import.
Root\Site\Area\Unit_A For folders whose parent is the system
root folder, enter Root.
NOTE: The name of the system
root folder (see page 175) is
replaced by Root.

EIO0000001114 06/2020 265

Instantiation Stage

Header Description Requirement

$Identifier Folder identifier. A column with this header and a valid
value in each row are required.
NOTE: You cannot update the
identifier of a folder through import.
$Alias Folder alias (see page 188). Column and value are optional.
$Description Folder description. If a row contains data, it must be valid.

$Area Folder area (see page 188).

NOTE: If the value is inherited
from a parent folder
(see page 190), it does not appear
in the export file.
Parameter x.$Identifier Identifier of the folder parameter Column and value are optional.
(see page 188). If a row contains data, it must be valid.
Parameter x.$Description Description of the folder NOTE: The numbering of folder
parameter. parameters (x) corresponds to the order
Parameter x.$Value Value of the folder parameter. (top to bottom) in which parameters
appear in the properties of the folder
when no sorting is applied.

TemplateIdentifier group (see page 259) for instances. The information applies to each
group that appears in the file or that you add.

Header Description Requirement

$Action Action that is performed on the instance Possible values (not case-sensitive):
during import.  Create(1) (default)
 Update
 Delete
 Blank:
 Creates the instance if it does not exist
yet.
 Updates the instance if it exists.

$InstanceName Instance name (see page 209). A column with this header and a valid value in
each row are required.
$Identifier(Non_Editable) Instance identifier (see page 195). A column with this header is required and:
The value is used to identify the  To create an instance, the value can be left
instance or calculated by the software in blank.
case of instance creation.  To update or delete an instance, the value
must be valid.
(1) Instances with action set to create and that you do not want to import can be unselected during import
(see page 292).

266 EIO0000001114 06/2020

 Instantiation Stage

Header Description Requirement

$IsHierarchical Hierarchical naming function Column and value are optional.
(see page 208). Possible values:
 True
 False
 Blank (or not present):
 Equals true for an instance that is created.
 Keeps the configured value for an existing
instance.
$Location Path to the instance in the application. A column with this header and a valid value in
Example: each row are required.
Root\Site\Area\Unit_A The path must exist in the application or be
created by the import.
NOTE: The name of the system root
folder (see page 175) is replaced by
Root.
$Description Instance description. Column and value are optional.
If a row contains data, it must be valid.
$Area Instance area (see page 209).
NOTE: If the value is inherited from a
parent folder (see page 190), it does
not appear in the export file.
<Element path>.Enabled A column exists for each service Column and value are optional.
(element (see page 261)) of the Possible values (not case-sensitive):
instance as they appear in the Instance  True: The service is enabled.
Editor.  False: The service is disabled.
The instance identifier is excluded from  Blank:
the element path.  Equals false for an instance that is
Example: created.
For the Running service that belongs  Keeps the configured value for an existing
to the Control element, the column instance.
header is:
Control. Running.Enabled Mandatory elements (whose check box cannot
be cleared in the Instance Editor) are identified
with (Non_Editable) in the header. If you set
the value to false, it is not considered during
import and the element remains enabled.
(1) Instances with action set to create and that you do not want to import can be unselected during import
(see page 292).

EIO0000001114 06/2020 267

Instantiation Stage

Header Description Requirement

Parameter.<parameter A column exists for each parameter Column and value are optional.
full path> (see page 261) that is featured by the If a row contains data, it must be valid.
instance, including parameters of When you edit a parameter, verify that the
disabled services (elements) element (see page 261) to which it belongs is
(see page 272) and not configured set to true; otherwise, the parameter value is not
parameters. applied during import. This rule does not apply to
Example: parameter values of mandatory elements, which
For the DISignalName parameter of are applied even if the element is set to false in
the Running service, the column the CSV file.
header is: NOTE: To view the hierarchy of elements and
Parameter.Control. parameters of an instance, use the Instance
Running.DISignalName Editor or the View Instance window
(see page 236).
NOTE: For parameters of the enumerated data
type (see page 279), the name is exported as
value. For example, if the parameter value
(see page 201) that is configured in the Instance
Editor is Operator (2), the exported value is
Operator. To edit the value, you can enter
either the name of the enumerator or the
associated integer (for example, 3 for an
enumerator that is Supervisor (3)).
(1) Instances with action set to create and that you do not want to import can be unselected during import
(see page 292).

268 EIO0000001114 06/2020

 Instantiation Stage

InterfaceLinks group (see page 259).

Parameter Description Requirement

$Action Action that is performed on the Possible values (not case-
interface link during import. sensitive):
 Create (default)
 Update(1)
 Delete
 Blank:
 Creates the link if it does
not exist yet.
 Updates(1) the link
destination if the link
exists.
$SourceLocation Path to the instance that is the source A column with this header and a
of the link in the Application Explorer. valid value in each row are
The name of the system root folder required.
(see page 175) is replaced by Root.
Example:
For instance Motor_1 of System_1
that is located in Folder_2, which is
a subfolder of Folder_1, the value
is Root\Folder_1\Folder_2.
$SourceInstanceName Value of the $Name parameter
(see page 209) of the instance that is
the source of the link.
$SourceInstance Identifier of the template that is used
TemplateIdentifier by the instance, which is the source
of the link.
(1) You can only change the destination (see page 274) of an existing link by using the Update command.

EIO0000001114 06/2020 269

Instantiation Stage

Parameter Description Requirement

$SourceInterfacePath Path to the source interface in the A column with this header and a
composition of the instance. valid value in each row are
Example: required.
In the following sample instance, the
NOTE: For RTNS interfaces,
value for interface ZSHPOS is
the column is optional and does
Control\Motor\Logic. not contain values.

$SourceInterfaceIdentifier Identifier of the interface that is the A column with this header and a
source of the link. valid value in each row are
required.
NOTE: Refer to the description
of RTNS interfaces for
information on their specific
identifiers (see page 230).
$DestinationLocation Path to the instance that is the A column with this header and a
destination of the link in the valid value in each row are
Application Explorer. required.
The name of the system root folder
(see page 175) is replaced by Root.
$DestinationInstance Name Value of the $Name parameter
(see page 209) of the instance that is
the destination of the link.
$DestinationInstance Identifier of the template that is used
TemplateIdentifier by the instance, which is the
destination of the link.
(1) You can only change the destination (see page 274) of an existing link by using the Update command.

270 EIO0000001114 06/2020

 Instantiation Stage

Parameter Description Requirement

$DestinationInterface Path Path to the destination interface in A column with this header and a
the composition of the instance. valid value in each row are
Example: required.
In the following sample instance, the
NOTE: For RTNS interfaces,
value for interface BoolVar is empty
the column is optional and does
(blank) because it has no parent not contain values.
element.

$DestinationInterface Identifier of the interface that is the A column with this header and a
Identifier destination of the link. valid value in each row are
required.
NOTE: Refer to the description
of RTNS interfaces for
information on their specific
identifiers (see page 230).
$NewDestinationLocation The description is the same as for the Columns with these headers
$NewDestinationInstance $Destination* parameters but the are required. Rows can be left
Name data applies to the new destination blank.
interface of the same or another The columns must contain a
$NewDestinationInstance valid value only when you
instance.
TemplateIdentifier change the destination
The parameters are empty by
$NewDestinationInterface default. (see page 274) of an existing
Path link.
$NewDestinationInterface
Identifier
(1) You can only change the destination (see page 274) of an existing link by using the Update command.

EIO0000001114 06/2020 271

Instantiation Stage

Editing Rules
The table indicates the rules that apply when you edit a CSV application export file.

Item Rule
Header of a group Must start with a colon.
You can remove a group header and its header row if the group contains no data.
First header of a header
You can change the order of groups.
row
Headers of non-editable Headers of data that does not need to be edited or that is ignored during import
data are identified by the software with the Non_Editable suffix.
Rows of object data Refer to the requirements (see page 265).
You can delete the row of an object if you do not want to import it or modify it
through import.
Empty rows Can be added anywhere.
Comment rows Can be added anywhere and must start with a semi-colon.
Comments are ignored during import.
Order of columns Can be changed within a group given the first header of the row starts with a colon.
Empty columns Can be added after the first column.
Interface links For any actions on links (see page 273), the data of the linked instances must be
included in the application export file even if the instances already exist in the
target application.
List separator Only comma (see page 264) is accepted.
Values Use the invariant culture (see page 265).
To use commas or quotation marks in values of string data types when you edit
the file by using a text editor, for example, Notepad, follow these rules:
Expected value after import Value to be entered
Motor, Pump "Motor, Pump"
Motor"Pump "Motor""Pump"

Creating, Updating, and Deleting Folders

To create an instance in a new folder, you must also enter in the CSV file the necessary data to
create the folder.
Since each row corresponds to only one folder, to create, for example, the structure
Root\Folder_1\Folder_10, you must configure two rows.
NOTE: It is not possible to rename a folder by using the Update action.
Perform the following steps in the Folders groups of the CSV application export file.

Step Action
1 Edit the rows that contain data of folders and/or create rows. Verify that at least the required
columns and data (see page 265) are present.
2 Specify a value for $Action for each row as needed.

272 EIO0000001114 06/2020

 Instantiation Stage

Creating, Updating, and Deleting Instances

Perform the following steps in the TemplateIdentifier groups of the CSV application export file.

Step Action
1 Edit the rows that contain data of instances and/or create new groups and/or rows. Verify that
at least the required columns and data (see page 265) are present.
2 Verify that the data for $Location is consistent with the target application and/or $Location
in the Folders group.
3 Specify a value for $Action for each row as needed.

NOTE: If you update data of instances that are already linked and want the link to be maintained,
it is not required to update the row of the InterfaceLinks group that pertains to the link as long as
the linked interfaces remain enabled. This applies even if you change the value of
$InstanceName or the instance identifier (for example, by configuring an alias for a folder) for
either or both instances.

Creating and Deleting Interface Links

Perform the following steps in the CSV application export file.

Step Action
1 In the InterfaceLinks group, edit the rows that contain data of the links and/or create new rows.
Verify that at least the required columns and data (see page 265) are present.
2 Verify that the data for $SourceLocation and $DestinationLocation is consistent with
the target application and/or $Location in the other groups (if applicable).
3 Specify a value for $Action for each row as needed.
4 In the TemplateIdentifier group, verify that the data of the linked instances is entered.
If the linked instances already exist in the target application with the same configuration and you
do not want to modify them, change the value of $Action to Update or leave it blank for each
instance.
NOTE: If the instances already exist in the target application and you leave the value as
Create, the Resolve Uniqueness Conflicts dialog box (see page 294) opens during import and
you need to select the Update action for the instances there.

EIO0000001114 06/2020 273

Instantiation Stage

Changing the Destination of An Existing Interface Link

To move the destination of an existing link to a different interface, edit the CSV application export
file as follows. The new destination interface must be available for connection during import.

Step Action
1 In the InterfaceLinks group, for the row that contains the data of the existing link, change the
value of $Action to Update or leave it blank.
2 Enter the appropriate data in each of the five columns $NewDestinationLocation to
$NewDestinationInterfaceIdentifier.
NOTE: You do not need to edit the data of the existing interface link. If the interface link does
not exist in the target application, a link from the specified source to the new destination is
created anyway.
3 In the TemplateIdentifier group, verify that the data of the linked instances is included.
If the instances already exist in the target application with the same configuration and you do
not want to modify them, change the value of $Action to Update or leave it blank for each
instance.
NOTE: If the instances already exist in the target application and you leave the value as
Create, the Resolve Uniqueness Conflicts dialog box (see page 294) opens during import and
you need to set the action to Update there.

274 EIO0000001114 06/2020

 Instantiation Stage

XML Application Export File

Export File Description

The following example shows the structure of an XML application export file (partial view) that was
created by exporting Folder_1, which contains instance DISignal_UL_1.

EIO0000001114 06/2020 275

Instantiation Stage

1 Data pertaining to the folder.

2 Data pertaining to the instance.
3 Data of the parameters and elements of the instance.
4 Data of the application interfaces (see page 277) that the instance exposes.
5 Folder identifier.
6 Folder Action parameter
7 $InstanceID parameter of the instance, which is generated by the software. This is the identifier that the
software uses to identify the instance for delete and update actions. Do not edit this parameter.
8 $Name parameter of the instance.
9 Instance Action parameter.

When instances that are linked are exported, the information of the interface links is grouped in the
InterfaceLinks element, which appears at the end of the file. The following example shows an
extract of an export file, which contains two instances linked by two interface links.

1 Action parameter plus source and destination information pertaining to the first interface link.
2 Same information pertaining to the second interface link.

276 EIO0000001114 06/2020

 Instantiation Stage

Editing the XML Application Export File to Manage Folders and Instances

Overview
You can edit the XML export file by using any XML editing software to perform one or more of the
following actions on application folders and/or instances:
 Create an object by using the parameter values of the export file.
 Update an object that has the same identifier by using the parameter values in the export file.
 Delete an object that has the same identifier as in the export file.

You can also create and delete interface links (see page 283).
The software applies the changes when you import the edited XML file (see page 287) into the
application of the system. At that time, you have the possibility to review and modify the list of
imported objects (except interface links).
NOTE: You cannot update the identifier of a folder through import.

Good Practices
 Before editing an application export file, create a copy of it. If needed, it lets you restore the
original application.
 Edit only an up-to-date export file to help avoid data conflicts when importing.

Application Export File Content

The table shows the objects and their respective parameters that are exported to the XML file and
that are configurable.

Object Parameters
Application folder For the folder and any subfolders
Action
Identifier
Alias
Description

Area(1)
Location
Parameters
(1) If the value is inherited from a parent folder (see page 190), it does not appear in the export file

EIO0000001114 06/2020 277

Instantiation Stage

Object Parameters
Instance For the instances in the folder and its subfolders
Action
TemplateIdentifier
Version
IsHierarchical
Location
$Name
$Description

$Area(1)
Elements that are enabled (selected in the Instance Editor)
Parameters of each element
For parameters of the enumerated data type (see page 279), the name is exported
as value. For example, if the parameter value (see page 201) that is configured in
the Instance Editor is Operator (2), the exported value is Operator. To edit the
value, you can enter either the name of the enumerator or the associated integer (for
example, 3 for an enumerator that is Supervisor (3)).
Identifier of exposed interfaces and their path in the composition of the instance.
Includes data of disabled and connected interfaces.
When an alias is configured for an interface, both the alias and the identifier are
indicated. The alias is the name that appears in the Links Editor.
Interface link Parameters of interface links that exist between exported source and destination
instances.
Refer to the topic describing how to edit the XML file to manage interface links
(see page 283).
(1) If the value is inherited from a parent folder (see page 190), it does not appear in the export file

Action Parameter
Configuring the Action parameter is optional.
Possible values (not case-sensitive):
 Create (default)
 Update (except for interface links (see page 284))
 Delete
 Blank:
 Creates the object if it does not exist yet.
 Updates the object if it exists (except interface links).

NOTE: Instances with action set to create and that you do not want to import can be removed from
the list of imported objects during import (see page 292).

278 EIO0000001114 06/2020

 Instantiation Stage

Using the Invariant Culture

Use the invariant culture (see page 265) to modify or add parameter values in the application
export file.

Editing Rules for XML Application Export Files

To maintain the consistency of the folder structure and instances contained in the export file, follow
these rules.

Item Rule
Instance Do not modify Identifier of the instance ($InstanceID parameter) because it is
generated by the software.
Parameters Modify only the parameters described in the procedures that appear in this topic.
Object hierarchy Do not modify the structure of child elements.
For example, a folder must be the parent of an instance and not the opposite.
However, you can modify the order of Elements or Parameters inside an instance
(ApplicationInstance section).
When the export file contains data of a folder structure, do not change the
<Location> parameter of the highest level folder (the folder from which the export
file was created). For subfolders, the hierarchy from the export file prevails.
When the export file contains data of a single instance or single folder, do not modify
the <Location> parameter.

EIO0000001114 06/2020 279

Instantiation Stage

The following figure shows an extract of an export file of instance Motor_3, which was exported
from Folder_5. The instance is located in Folder_1, a subfolder of Folder_5. The Location
parameters of these folders are highlighted.

Creating an Instance
To edit the XML export file to create a new instance in an existing folder, proceed as follows.

Step Action
1 Change the value of the $Name (see page 209) parameter to the name of the new instance that
you want to create.
NOTE:
To create multiple instances during import:
 Copy the entire ApplicationInstance section of the export file that contains the data of
the instance.
 Paste it at the end of the section that you have copied, as many times as you want to create
instances.
 Change the value of $Name to the new name of each instance.

2 Verify that Action is set to Create; otherwise replace the value by Create.
3 Save your changes.

280 EIO0000001114 06/2020

 Instantiation Stage

Updating an Instance
To edit the XML export file format to update an existing instance, proceed as follows.

Step Action
1 For the instance that you want to update, change the value of Action from Create to Update.
2 Change the value of the parameters (see page 277) that you want to update.
3 Save your changes.

NOTE: If you update data of instances that are already linked and want the link to be maintained,
it is not required to update the data of the InterfaceLinks element that pertains to the link as long
as the linked interfaces remain enabled. This applies even if you change the value of $Name or the
instance identifier (for example, by configuring an alias for a folder) for either or both instances.

Deleting an Instance And/Or a Folder

To edit the XML export file to delete an existing instance and/or folder, proceed as follows.

Step Action
1 If you want to delete:
 The instance and the folder containing the instance, verify that the export file also includes
the information pertaining to the folder.
 The instance only, proceed to step 3.

2 For the folder that you want to delete, change the value of Action from Create to Delete.
3 For the instance that you want to delete, change the value of Action from Create to Delete.
4 Save your changes.

Creating Folders
To edit the XML export file to create one or more folders or a folder hierarchy, proceed as follows.

Step Action
1 Verify that Action is set to Create for the folders that you want to import; otherwise replace
the value by Create.
2 Save your changes.

EIO0000001114 06/2020 281

Instantiation Stage

Updating a Folder
To edit the XML export file to update an existing folder, proceed as follows.

Step Action
1 For the folder that you want to update, change the value of Action from Create to Update.
2 Change the value of any of the following folder parameters that you want to update:
 Alias
 Description
 Area
 Parameters

If the value of the parameter that you want to update is blank, enter the new value in the following
format <Parameter>Value</Parameter>, where Parameter represents one of the four
parameters that you can change and Value the new parameter value.
For example, to modify the blank Area parameter of a folder to 100, enter <Area>100</Area>.
NOTE: You must not change the Folder Identifier value.
3 Save your changes.

282 EIO0000001114 06/2020

 Instantiation Stage

Editing the XML File to Manage Interface Links

Overview
You can use any XML editing software to edit the export file. This lets you create and delete
interface links.
The software applies the configuration when you import the edited XML file (see page 287) into the
application of the system.
If you modify the data of a link that is contained in the export file, the existing link is not deleted
after import. The new link is created in addition.

Good Practices
 Before editing an application export file, create a copy of it. If needed, it lets you restore the
original application.
 Edit only an up-to-date export file to help avoid data conflicts when importing.
 Use the data of exposed interfaces (see page 275) to create interface links.

Linked Instances Data

For any actions on links, the data of the linked instances must appear in the application export file
(see page 277) even if the instances already exist in the target application.
If the linked instances already exist in the target application with the same configuration and you
do not want to modify them, change the value of $Action to Update for each instance.
NOTE: If the instances already exist in the target application and you leave the value as Create,
the Resolve Uniqueness Conflicts dialog box (see page 294) opens during import and you need to
select the Update action for the instances there.

EIO0000001114 06/2020 283

Instantiation Stage

Contents of the InterfaceLinks Element

The table describes the parameters of the InterfaceLinks element (see page 275) that
appears at the end of the XML application export file.

Parameter Description
Action Action that the software performs by using the
interface link data. Possible values:
 Create (default): Creates new links in addition to
existing links whose data has been exported.
 Delete: Deletes links whose configuration matches
the data in the imported file.
NOTE: To create a new link in place of an existing
link, you need to explicitly delete the existing link.
NOTE: Entering Update produces the same result as
Create.
DestinationPath Path to the instance that is the destination of the link in
the Application Explorer.
The name of the system root folder (see page 175) is
replaced by Root.
DestinationInstanceName Value of the $Name parameter (see page 209) of the
instance that is the destination of the link.
DestinationInstanceTemplateIdentifier Identifier of the template that is used by the instance,
which is the destination of the link.
DestinationInstanceIdentifier Identifier (see page 195) of the instance that is the
destination of the link.
DestinationInterfacePath Path to the destination interface in the composition of
the instance.
Example:
In the following sample instance, value for interface
BoolVar is "" (blank) because it has no parent
element.

DestinationInterfaceIdentifier Identifier of the interface that is the destination of the

link.

IsDestinationInstanceHierarchical Indicates if the hierarchical naming function

(see page 208) is enabled for the instance.

284 EIO0000001114 06/2020

 Instantiation Stage

Parameter Description
SourcePath Path to the instance that is the source of the link in the
Application Explorer.
The name of the system root folder (see page 175) is
replaced by Root.
Example:
For instance Motor_1 of System_1 that is located in
Folder_2, which is a subfolder of Folder_1, the
value is Root\Folder_1\Folder_2.
SourceInstanceName Value of the $Name parameter (see page 209) of the
instance that is the source of the link.
SourceInstanceTemplateIdentifier Identifier of the template that is used by the instance,
which is the source of the link.
SourceInstanceIdentifier Identifier (see page 195) of the instance that is the
source of the link.
SourceInterfacePath Path to the source interface in the composition of the
instance.
Example:
In the following sample instance, the value for
interface ZSHPOS is Control\Motor\Logic.

SourceInterfaceIdentifier Identifier of the interface that is the source of the link.

IsSourceInstanceHierarchical Indicates if the hierarchical naming function

(see page 208) is enabled for the instance.

EIO0000001114 06/2020 285

Instantiation Stage

Creating a Link
To edit the XML export file to create a link, proceed as follows.

Step Action
1 In the InterfaceLinks element, copy the source and destination data that pertains to an
existing interface link and paste it inside the element.
2 Edit the necessary source and destination data.
3 Verify that the value of Action is Create.
4 Save your changes.

Deleting a Link
To edit the XML export file to delete a link, proceed as follows.

Step Action
1 In the InterfaceLinks element, locate the source and destination data that pertains to the
interface link and change the value of Action to Delete.
2 Save your changes.

286 EIO0000001114 06/2020

 Instantiation Stage

Importing a CSV or XML File Into the Application

Overview
By using the Import command, you can modify the application with the configurations that you have
made in the CSV or XML file.
The import process is performed in steps during which the software:
1. Validates the structure of the CSV or XML file.
2. If valid, displays the folders and instances contained in the imported file along with the action
that you have configured for each one, informs you of detected issues, and lets you select which
objects to import.
3. Imports selected objects that satisfy applicable rules (for example, uniqueness of instance
identifiers and presence of template).
4. For the other objects, informs you of the detected uniqueness conflicts (see page 294) and lets
you resolve them so that you can import these objects.
5. Displays a summary of the import operation, which includes information about incorrect
configurations and objects that were not imported.
Creating and deleting instances through import affects the instance count (see page 198).
NOTE:
Verify that the version of the templates that are used by the instances that you are importing exists
in the Global Templates library before you proceed with the import; otherwise you will not be able
to import these instances. Refer to the topics describing how to:
 Browse application templates (see page 177).
 Export/import templates (see page 978).

Software Version Compatibility

You can import into a system instances that were exported to XML format from Process Expert 4.0
and later.
If the XML export file was created from a version earlier than Process Expert 4.0, you need to
import the file into the version from which it was created, migrate the database in steps to
version 4.0, and export the instances again from this version.

EIO0000001114 06/2020 287

Instantiation Stage

Instance Import Behavior

The table describes the default import behavior when you configure the export file to create
instances in the following scenarios.

Scenario Result
An instance parameter The instance is created and configured with parameters whose value is valid.
value is invalid or no value For the invalid or not configured parameter, the default value of the template is
is configured. used.
An instance element The instance is created and configured with element selections whose value is
selection value is invalid or valid.
no value is configured. For the invalid or not configured element selection, the value is set to false. The
values that are configured for its parameters are not applied.

Folders Instance Result

No Folders group Data is  If the folders exist in the target application: The instance
(see page 259) or no data valid. is created.
(see page 265) in the group.  If at least one folder in the instance path does not exist:
The instance is not created.
Invalid data for at least one folder Data is  If the folders exist in the target application: The instance
in the instance path. valid. is created.
 If the folders do not exist, only those that have valid data
and a parent folder with valid data are created.
The instance is created only if the folder that contains it is
created.

The table describes the import behavior when you configure the export file to update instances in
the following scenarios.

Scenario Result
An instance parameter value is Only parameters whose value is valid are updated.
invalid or no value is configured. For the invalid or not configured parameter, the current value of the
instance is retained.
An instance element selection value Only element selections whose value is valid are updated.
is invalid or no value is configured. For the invalid or not configured element selection, the current value of
the instance is retained.

Folders Instance Result

No Folders group Data is valid. The instance is updated.
(see page 259) or no data NOTE: When you import an XML file, folders
(see page 265) in the group. whose data is invalid or missing are tagged with a
Invalid or missing data for at least Data is valid. red dot in the Import window.
one folder in instance path.

288 EIO0000001114 06/2020

 Instantiation Stage

Folder Import Behavior

The table describes the default import behavior when you configure the export file to create folders
in the following scenarios.

Scenario Result
The parameter Action for all the folders in Only its subfolders are created if these do not exist yet.
the export file is set to Create and the If a subfolder already exists, it is not created but any lower-level
parent folder already exists in the target folder in the hierarchy is created if it does not exist yet. And so on.
application.
The data of at least one folder in the folder Only folders that have valid data and a parent folder with valid
structure is invalid. data are created.

The table describes the import behavior when you configure the export file to update folders in the
following scenario.

Scenario Result
The data of at least one folder in the folder structure is invalid. Only folders that have valid data are updated.

NOTE:
If it is not able to propagate the value of the Area parameter to any object because the object is
locked, the software:
 Displays a notification to inform you which object is locked.
 Rolls back any propagated area value.
 Reverts the Area parameter value that you have entered in the folder properties to its previous
value.

NOTICE
NO CHANGE PROPAGATION
When the Area parameter value of a folder is not propagated:
 Reenter the Area parameter value in the properties of the folder.
 Verify in the Notification Panel that parameter value propagation completed successfully.

Failure to follow these instructions can result in alarms being signaled in the wrong area during
operation.

The table describes the import behavior when you configure the export file to delete folders in the
following scenario.

Scenario Result
The folder that you are deleting contains subfolders The software deletes the subfolders and instances.
and instances.

EIO0000001114 06/2020 289

Instantiation Stage

Interface Link Import Behavior

When you import two instances that are linked and select the Relative Path import setting
(see page 292), which imports the instances to a location that is different from the one that is
specified for the source and destination instance in the interface links data group, the link is
maintained.

Aborting Import Tasks

After confirming the import by clicking OK in the Import window, the abort icon is displayed in the
notification panel (see page 86). Click the icon to cancel the task.
Only the user who has selected the command is allowed to abort it.
Folders and instances that already appear in the Application Browser at the moment you abort the
task are retained given they belong to a tree structure that starts from the system root folder and
that is completely imported at the moment the import task is aborted.
If you click the abort icon after clicking OK in the Resolve Uniqueness Conflicts dialog box,
instances and folders that you had selected to be created and/or updated are not imported. Already
imported objects (non-conflicting ones) are retained.
In any case, links that exist between instances are not recreated when you abort an import task
even if these instances are retained. This is because recreating links is the last step performed
before completing an import task.
NOTE: If you are importing only a few objects, the task may complete before you are able to click
the abort icon.
The following example illustrates two scenarios. Parent folders Folder_1 and Folder_2 are
exported with their respective subfolders from the system root folder (System_1).

290 EIO0000001114 06/2020

 Instantiation Stage

When you import the two structures into a system, folders are imported in sequence, structure after
structure. If the import task is aborted:
 Before Folder_C and its contents is completely imported (displayed), nothing is retained.
 After Folder_C and its contents is completely imported (displayed), only the complete
Folder_1 tree structure and the instances therein are retained.
The following figure shows the objects that are retained when the import task is aborted after
Folder_C and its contents has finished importing.

If a link exists, for example, between an instance in Folder_A and an instance in Folder_C, it is
not recreated.

Opening the Application Import Window

To open the application Import window, proceed as follows.

Step Action
1 Right-click the folder in which you want to import instances or that is to become the parent folder
and select Import.
Result: The Open dialog box opens.
2 Select the application export file and click Open.
Result: The application Import window opens and displays the contents of the file.

EIO0000001114 06/2020 291

Instantiation Stage

Import Window Description

The following figure shows an example of the application Import window. This example illustrates
a scenario where three instances and one folder cannot be imported. Details are provided in the
legend.

292 EIO0000001114 06/2020

 Instantiation Stage

Item Description
1 Full path of the file that you are importing.
2 You can sort and filter (see page 138) data.
3 Identifier of the folders and name ($Name) of the instances contained in the import file.
A selected check box indicates that the instance is imported if possible.
A colored dot next to each folder and instance indicates the import status. Details are shown in a
tooltip.
NOTE:
 Instances whose data is invalid are not shown.
 Instances whose data is valid are shown but may not be created (see page 288).
Refer to the Details section.
Color Colored dot description
Green For instances: The template that is used by the instance (same identifier and version)
is available in the Global Templates library.
For folders: Subfolders and instances inside the folder and its subfolders are marked
with a green dot.
Red For instances: The template that is used by the instance (same identifier and version)
is not available in the Global Templates library. If you proceed, the instance is not
imported.
For folders, may appear in these situations:
 Subfolders and instances inside the folder and its subfolders are marked with a
red dot.
 The folder data in the CSV file is invalid.
 The folder contains an instance whose data is invalid.
If the location of the instance is not specified, the red dot appears on the system
root folder.
Yellow For folders only: The folder or its subfolders contains at least one subfolder or
instance that are marked with a red dot while at least one instance or subfolder is
marked with a green dot.
4 Identifier of the template that instance is using.
5 Version of the template that the instance is using.
6 Indicates the action that the software performs on the selected object according to the value of the
Action parameter in the imported file.
NOTE: When you create an instance, in the import summary that is shown in the notification panel,
the action appears as Create for the instance but as Update for its elements and parameters.
7 Contents of the $Description parameter of the object.

EIO0000001114 06/2020 293

Instantiation Stage

Item Description
8 Import setting. The view is updated to show the impact of your selection.
Absolute During import, the software maintains the folder structure of the imported file
Path independently from where you select the import command given the required folder
data is present in the imported file or the folders exist in the target application.
The system root folder appears as Root.
Relative During import, the folder from which you select the import command becomes the
Path parent folder of the imported folder structure.
However, folders that do not exist in the target application and whose data is missing
in the import file are not imported. This may change the location of instances.
9 Notification area, which contains information about detected issues.
10 The message indicates that the instance cannot be imported because its template is not available
in the Global Templates library. As a result, the instance is tagged with a red dot.
11 The message indicates that the instance that is located in folder Unit_2 cannot be imported. As a
result, the folder is tagged with a red dot and the instance is not shown in the window.
12 Folder Cell_3 cannot be imported because of missing data in the imported file. As a result, the
folder is tagged with a red dot and no action appears for it. Also, instance MyValve_2 will not be
created. It is tagged with a green dot because its template is available in the Global Templates
library.

Resolving Conflicts During Import

You can resolve the object-uniqueness conflicts that the software detects during import, for
example, if you are importing a new instance and an instance with the same name or identifier
(see page 209) already exists in the application.
The Resolve Uniqueness Conflicts dialog box opens once non-conflicting objects have been
imported. The following figure shows an example.

294 EIO0000001114 06/2020

 Instantiation Stage

Item Description
1 $Name parameter of the instance as it appears in the imported file.
2 Identifier of the instance based on the data of the imported file.
3 Identifier of the template that the instance uses.
4 New value for the $Name parameter of the instance that the software will use to satisfy applicable naming
rules if you select to create the instance.
5 Identifier of the instance after import if you select to create it.
6 Buttons that let you select an action for individual instances:
 Skip: The existing instance and its links are not modified.
 Update: Default action. Modifies the existing instance with the imported parameter and link configuration.
The name of the instance is not modified.
 Create: Creates a new instance with New Instance Name and the imported folder, parameter, and link
configuration.
NOTE: Update is disabled if you have selected the Relative Path import setting and, as a result, the instance
is imported in a different folder.
7 Buttons that let you select an action for the conflicting instances as a whole.
The actions are the same as when you select the action for instances individually.
NOTE: Clicking these buttons overrides the selection you have made for individual instances.

Importing Objects into the Application

To import the content of an application export file into the application of a system, proceed as
follows.

Step Action
1 In the application Import window:
 Review information that is shown in the Details pane (if applicable).
 Select the instances that you want to import.
 Select the import settings that you want to apply.

2 Click OK.
Result: If you select to import with relative path, a confirmation dialog box opens.
NOTE: Click Cancel to close the Import window without importing any object.
3 Click OK.
Result: If it does not detect conflicting objects, the software:
 Imports the contents of the file and applies the import settings that you have selected.
 Displays the imported instances and folders in the Application Browser.
 Displays a summary of the import process in the notification pane.

If it detects conflicts, the software:

 Imports the instances that satisfy import rules and applies the import settings that you have
selected.
 For conflicting instances, opens the Resolve Uniqueness Conflicts dialog box; proceed to
step 4.

EIO0000001114 06/2020 295

Instantiation Stage

Step Action
4 In the Resolve Uniqueness Conflicts dialog box, select the actions that you want to perform for
conflicting instances.
NOTE: Click Cancel to close the Resolve Uniqueness Conflicts dialog box without importing
instances for which the software has detected a conflict. Instances that satisfied import rules
remain imported.
5 Click OK.
Result: The software:
 Imports the remainder of the instances with the import settings that you have selected.
 Displays the entirety of the imported instances and folders in the Application Browser.
 Displays a summary of the entire import process in the notification pane.

296 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Project Definition Stage
EIO0000001114 06/2020

Chapter 13
Project Definition Stage

Project Definition Stage

Overview
This chapter contains information to help you define the Control and Supervision projects of the
system.
The following figure shows the position of the Project Definition stage within the system
engineering life cycle.

Refer to the Project Definition stage (see page 50) for a description of the purpose of this stage.

EIO0000001114 06/2020 297

Project Definition Stage

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
13.1 Project Explorer and Project Browser 299
13.2 Control Project Definition Stage 304
13.3 Managing Control Projects 310
13.4 Supervision Project Definition Stage 337
13.5 Creating Supervision Project Components 343
13.6 Managing Supervision Projects 357
13.7 Participant Project Indicators 375

298 EIO0000001114 06/2020

 Project Definition Stage

Section 13.1
Project Explorer and Project Browser

Project Explorer and Project Browser

Overview
This section describes the Project Explorer, which features the various editors that let you manage
Control and Supervision Participant project components. It also describes the Control Project
Browser and Supervision Project Browser, which let you create these projects and open their
respective editors.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Project Explorer 300
Project Browser 302

EIO0000001114 06/2020 299

Project Definition Stage

Project Explorer

Opening the Project Explorer

To open the Project Explorer for a system, verify that the system is selected in the Systems
Explorer or that at least one explorer/editor is already open for this system. Then, click the Open
Project Explorer button in the engineering client toolbar.
Otherwise, right-click the system in the Systems Explorer and select Open Project.

Project Explorer Window

The following figure shows an example of the Project Explorer for a system in which two Participant
projects exist. The Control Project Browser is selected.

300 EIO0000001114 06/2020

 Project Definition Stage

The following figure shows an example of the Project Explorer for a system in which two Participant
projects exist. The Supervision Project Browser is selected.

1 Tabs to show the Control Project Browser or Supervision Project Browser pane (see page 302).
2 System root folder.
3 Remaining work area (see page 118) of the Project Explorer when the project browser pane is
pinned. The data that is shown depends on the project browser tab that is selected. The work
area is empty by default.
4 Assignment Editor tab (see page 384). It shows the containers of the Participant projects and
lets you assign facets to them.
5 Executable management (see page 624) tab, which lets you view and edit executable
properties and perform the various mappings by selecting the corresponding subtabs:
 Service Mapping
 Communication Mapping
 Hardware Mapping (Control only)

6 Properties tab (see page 307) for the Participant projects and their components other than
executables.

EIO0000001114 06/2020 301

Project Definition Stage

Project Browser

Description
The project browsers let you see, create, and interact with the Control and Supervision Participant
projects that exist in a system.
The following figure shows an example of the Control Project Browser in which two projects have
been created.

The following figure shows an example of the Supervision Project Browser in which one project
has been created.

302 EIO0000001114 06/2020

 Project Definition Stage

1 Pin button (see page 127). Lets you hide the pane and restore it when it is docked.
2 You can customize (see page 303) which columns appear.
3 System root folder.
4 Node giving access to project-level context menu commands.
5 Node giving access to container-level context menu commands.
6 Node giving access to cluster-specific context menu commands.
7 User-created executable (see page 624).
8 Indicator icons (see page 375).
9 Project type selection tabs.

Navigating Inside the Project Browser

The keys to navigate are the same as in the Application Browser pane (see page 183).

Customizing Column Display

You can choose which columns you want to see by right-clicking a column header and selecting
Customize. Certain columns are always shown.
For a description of the columns, refer to the topic describing properties of Control executables
(see page 627) and Supervision executables (see page 679).

System Root Folder Actions

Right-click the system root folder to open a context menu with the following commands. The
availability of commands depends on the tab of the Project Browser that is selected.

Command Description
Create Control Project Creates a new Control project that is associated to one of the supported controller
(see page 305) families and displays it in the tree view of the Project Explorer.
Import Control Project Opens an Open dialog box, which allows you to create a Control project by
(see page 333) importing data of a project that was created with Control Expert. Export files in .stu
or .xef format are supported.
Create Supervision Creates a new Supervision project, and displays it in the tree view of the Project
Project (see page 339) Explorer.
Open Application Opens the Application Explorer (see page 174), which allows you to start the
instantiation stage or access the application of the system.
Open Topology Opens the Topological Explorer (see page 307), which allows you to start the
configuration stage or access the topology of the system.
Export Opens a Save As dialog box, which allows you to create an export file containing
the information of the Control projects (see page 312) and Supervision projects
(see page 358) that exist in the system.
Import Opens an Import dialog box, which allows you to display the compatible contents
of an export file (.sbk) in the Import window. You can import entire Control projects
(see page 316) and/or Supervision projects (see page 363), or parts of them into
the system.

EIO0000001114 06/2020 303

Project Definition Stage

Section 13.2
Control Project Definition Stage

Control Project Definition Stage

Overview
This section describes how to create Control projects of a system and their sections.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Creating Control Projects 305
Creating Control Project Sections 309

304 EIO0000001114 06/2020

 Project Definition Stage

Creating Control Projects

Before Creating a Control Project

At this stage of the system engineering life cycle, you need to know:
 Which family of controllers (see page 556) you will be using to run the Control project.
 How you will organize the function block diagram (FBD) sections of the project.

Creating Control Projects

To create a Control project, proceed as follows.

Step Action
1 In the Control Project Browser, right-click the system root folder, select Create Control Project
and the controller platform (see page 307) that is associated to the project.
Result: The Control project is shown in the tree view.

NOTE: In each system, you can create as many Control projects as needed. For example, you can
create a project, which is engineered for a Modicon M580 controller in the plant and a project,
which is engineered for an M340 controller for test purposes in the laboratory.

Control Project Actions

The table describes the Control project context menu commands.

Command Description Applies to

Assign Facets Opens the Assignment Editor, which lets you create and manage Assignment Stage
sections and assign facets to them. (see page 383)
Generate Starts a process to create or update the logic at the project level. Generation stage
(see page 483)
Refine Opens the Control Participant, which allows you to make changes to Refinement stage
the logic of the project. (see page 506)
Manage Opens the Manage Network Variables dialog box, which allows
Network creating, modifying, and deleting network variables. These are
Variables variables that are used to share data by using peer to peer
(see page 538) communication.
Manage Data Opens the Manage Data Backup Files dialog box, which lets you Project Definition
Backup Files view and delete data backup files that exist for Control Participant stage
(see page 335) project.
ReGenerate Starts a process to recreate the logic from the beginning at the Generation stage
(see page 488) project level.
NOTE: Certain changes that you have made during refinement may
be discarded.

EIO0000001114 06/2020 305

Project Definition Stage

Command Description Applies to

Last Action Opens a dialog box that indicates the last action that was performed Project Definition
Summary and a summary of the result. stage
(see page 381)
Export Opens a Save As dialog box, which allows you to create an export
(see page 312) file containing the Control project information.
Settings Opens the Settings window (see page 308), which lets you configure Assignment stage
various project-related settings.
Delete Deletes the Control project including: –
(see page 307)  Sections
 Assignments
 Executables (see page 625)

Rename Allows you to enter a new identifier (see page 307) for the project. –
Properties Opens the Properties window, which allows you to view and/or edit –
the properties of the Control project.

Containers Node Actions

The table describes the Containers node context menu commands.

Command Description Applies to

Assign Facets Opens the Assignment Editor, which lets you create and manage Assignment Stage
sections and assign facets to them. (see page 383)
Create FBD Lets you create an FBD section (see page 392) in the task folder
Section that you select.
The Assignment Editor opens in the background.
Generate Starts a process to create or update the logic at the section level. Generation Stage
ReGenerate Starts a process to recreate the logic from the beginning at the
(see page 443)
section level.
NOTE: Certain changes that you have made during refinement
may be discarded.

Executables Node Actions

The table describes the Executables node context menu commands.

Command Description Applies to

Create Creates one or more Control executables (see page 625), which let Mapping Stage
Executable you associate one or more controllers to the Control project, map (see page 624)
project facets to hardware, and create communication channels by
using the I/O scanner service of the controller.

306 EIO0000001114 06/2020

 Project Definition Stage

Control Project Properties

Right-click the Control project and select Properties.
You can view and/or edit the following items.

Item Description
General Identifier The identifier must be unique within the system.
Description Optional.
You can enter a description of the project with free text.
Controller Value Indicates the controller platform that you have associated to the project at the
Family time of creation.
Possible values:
 Quantum
 M340
 M580

Read-only.
NOTE: When you associate a Control project with a controller family, the
software limits the assignment of facets to the project to those that have the
corresponding attribute (see EcoStruxure™ Process Expert, Global
Templates, Reference Manual) defined.

Deleting a Control Project

When you select the command to delete a Control project, the software displays a confirmation
dialog box. Once you have confirmed the deletion, the software executes the following actions in
relation to the project that you are deleting:
 Deletes any components of the project and their contents, including any assignments and
mappings.
 Deletes any associated files (for example, data backup files and expressions (see page 402) for
container naming rules).
NOTE: You cannot delete a Control project if any executable of the project is deployed
(see page 713).

EIO0000001114 06/2020 307

Project Definition Stage

Project Settings Window

The Settings window opens when you select the Settings command in the context menu of a
Control or Supervision project.

Section Description
Container Naming Lets you configure expressions (see page 402), which define how sections are
Rules created and how Control facets are assigned to the project.
The section appears only for Control projects.
Assignment Lets you set the functionality, which can automatically assign remaining candidate
facets (see page 425) of instances.
Possible values:
 Enabled
 Disabled

Project Analysis Lets you enable or disable the automatic analysis of the Control project, which is
performed when you generate the project/sections or save refinement changes.
When the analysis is disabled:
 The Control project validity indicators (see page 378) are not functional.
 The time required to generate and save refinement changes is reduced.

You can perform an analysis of the Control project manually at any time by refining it
offline and clicking Build → Analyze on the menu bar. After you click the save button,
the project validity indicators indicate the status of the project.
Possible values:
 Enabled
 Disabled: Default value.

The section appears only for Control projects.

NOTE: The OK and Cancel buttons apply to all the sections of the Settings window.

308 EIO0000001114 06/2020

 Project Definition Stage

Creating Control Project Sections

Overview
In the Project Explorer, you can create only FBD sections in a Control Participant project by using
context menu commands.

Creating FBD Sections

To create FBD sections in task folders, open the Assignment Editor by selecting Assign Facets
from the context menu of the Containers node in the Control Project Browser.
For a description of sections and actions that you can perform, refer to the topic describing the
editor (see page 386).
NOTE: You can create FBD sections also by refining the Control Participant project or importing
them.

Creating Non-FBD Sections

You can create non-FBD sections by:
 Refining (see page 507) the Control Participant project and creating the sections.
 Refining the Control Participant project online (see page 816), creating the sections, and
updating (see page 841) the Control project.
 Importing (see page 316) the sections.

Non-FBD sections are sections in any of the following languages: IL, LD, LL984, SFC, and ST.
They appear also in the Containers pane of the Assignment Editor.
NOTE:
In the following cases, existing non-FBD sections may be displayed only after you make a change
by using the Refine command (see page 507) at the project level and save it:
 The Control project is contained in a database of an earlier version of the software that you have
migrated.
 The Control project is contained in a system that you have restored by using a backup file
created with an earlier version (see page 163) of the software.

EIO0000001114 06/2020 309

Project Definition Stage

Section 13.3
Managing Control Projects

Managing Control Projects

Overview
This section describes how to use the Project Explorer to manage entire Control projects or
sections of such projects.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Control Project Section Order 311
Exporting a Control Project 312
Importing a Control Project 316
Importing a Control Expert Project 333
Managing Data Backup Files 335

310 EIO0000001114 06/2020

 Project Definition Stage

Control Project Section Order

Overview
The software assigns an order to sections, starting at 0, and displays it in the Containers pane
(see page 386). The values appear in the Order column.
It indicates the order in which the software generates the sections of the Control project and
thereafter the execution order of the sections by the Control Participant.
You can change the order of sections inside the Containers pane.
The software applies changes to the order of sections in the logical Control Participant project
when you perform either action:
 Select the Refine command at the project level (it is not required to make a change or save).
 Generate (see page 488) the entire project or a section of the project.
 Regenerate (see page 493) the entire project or a section of the project.

You then need to propagate the change downward in the system engineering life cycle.
NOTE: You can also change the order of sections by refining (see page 507) the Control
Participant project or by refining the deployed Control project online (see page 816) and updating
the Control Participant project.

Moving Sections
In the Assignment Editor, you can move sections only within the MAST or FAST task folder.
To move sections from the MAST to the FAST task folder or the other way around, refine the
Control Participant project.

Changing the Order of Sections

To change the order of sections of a Control project, proceed as follows.

Step Action
1 In the Containers pane of the Assignment Editor, clear filters (see page 141).
2 Drag one section up or down to a new position.
Result: A tooltip indicates the position that the section will occupy.
NOTE: In the Assignment Editor, you can select multiple, contiguous or non-contiguous
sections that belong to the same task folder.
3 Release the mouse button.
Result: The section is inserted at the selected position and the values of the Order column are
updated.
4 Apply the new order to the logical Control project by performing the necessary action.

NOTE: To change the order of the facets inside an FBD section, refer to Changing the Facet Order
(see page 440).

EIO0000001114 06/2020 311

Project Definition Stage

Exporting a Control Project

Overview
The export functionality lets you create a non-editable export file (.sbk), which contains selected
Control project information.
You can use this data by using the Control project import (see page 316) functionality to transfer
project information to a different system or to merge information from different Control projects.
However, you cannot merge data related to communication mapping during import. You need to
import either the complete communication channel (see page 630) and/or peer to peer
communication data (see page 645) that is contained in the export file for selected Control projects
or nothing.
NOTE: To export the Control and Supervision projects of a system at once in one export file, right-
click the system root folder in either Project Browser, select Export, and follow the project export
procedure described in this section. Refer also to the topic describing the export and import of
Supervision projects (see page 357).

Software Version Compatibility

The version of EcoStruxure Process Expert that you use to import the information contained in the
export file must be the same as the version that you used to create the export file (a service pack
is considered the same version); otherwise you cannot proceed with the import.

Project Related Data

To be able to use the export file to import a project into a different system, verify that the instances,
their templates, and topological entities related to the project exist in the target system before
importing the project (see page 319).
NOTE: The parameter values of instances that reference the exported facets are not contained in
the export file. However, the export file contains information that allows the software to verify during
import if the configuration of an instance is different from when its facets were exported.

312 EIO0000001114 06/2020

 Project Definition Stage

Project Export Window

The Control window lets you select, which project information the export file will contain.
The following figure shows an example of the Export window where the check box for
FBDSection_2 has been cleared. To indicate that at least one item of the Control project is not
selected, the check box of parent nodes are filled with a square.

The table indicates the meaning of the colored dots that appear in the Export window next to items
of a Control project.

Color code Description

Green You can export the item.
Red You cannot export the item because it contains at least one facet with the following state:
 Deleted
 Unassigned
 Out of Date
 Moved

Generate sections that contain facets with such states in order to export the Control project.
NOTE: You cannot export items that are tagged with a red dot.
Yellow Indicates that the item contains at least one subitem that is tagged with a red dot.
The item can be exported partially only.

NOTE: To expand/collapse a node in the Export window, select the node and press Enter.

EIO0000001114 06/2020 313

Project Definition Stage

Export Settings
The table describes which Control project information you can export.

Item Selected Description

for export
System_n By default Unselecting the item excludes any Control project and disables
the creation of the export file.
ControlProject_n By default Unselect the item to exclude the entire project from the export
file.
Tasks folder By default You cannot unselect the item.
MAST and FAST task By default You cannot unselect the item.
folders
Sections By default You can unselect sections individually.
Selecting an FBD section automatically selects any facets that
are assigned to it.
Services By default You cannot unselect the item.
Container Naming Rules By default Represents the expressions (see page 402) that are
configured.
You cannot unselect expressions.
Executables By default You cannot unselect the item.
ControlExecutable_n By default You can unselect each executable and its contents individually.
Selecting an executable automatically selects any associated
mapping.
Service Mappings By default Selecting the item exports any data related to the service
mapping including any required contents in the contents
repository.
Unselecting the item also unselects both the associated
hardware and communication mapping.
Hardware Mappings By default You cannot select hardware mappings individually.
Selecting the item also selects the associated control
executable and service mapping.
Communication By default You cannot select communication mappings individually.
Mappings Selecting the item also selects the associated executable and
exports the complete communication mapping data.
NOTE: If the project contains peer to peer communication
data, refer to the topic describing peer to peer communication
export settings (see page 315).
Built Participant By default Represents the built Control Participant file (.stu).
Project
Backups By default You can select data backup files individually.
The time stamp and description of each backup file
(see page 823) are shown. The format of the time stamp is
YYYYMMDDHHMMSS.

314 EIO0000001114 06/2020

 Project Definition Stage

Peer to Peer Communication Export Settings

To be able to recreate peer to peer communication channels and existing variable mappings at the
time of import if the necessary conditions are fulfilled, you need to export all of the following:
 The owner project and its Control executable.
 The consumer project and its communication mappings.

NOTE: Including communication mappings in the export file may also include communication
channels other than those for peer to peer communication (for example, communication channels
for I/O devices).

Aborting Export Tasks

After confirming the export by clicking Save in the Export window, the abort icon is displayed in the
notification panel (see page 86). Click the icon to cancel the task. The export file is not created.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are exporting a small project, the task may complete before you are able to click the
icon.

Exporting a Control Project

To export a Control project to file, proceed as follows.

Step Action
1 In the Control Project Browser, right-click the Control project that you want to export and select
Export.
Result: The Export window opens and displays the Control project that you have selected.
NOTE: To be able to export two or more Control projects, for example, to export peer to peer
communication data, right-click the system root folder.
2 Select the project components that you want to export.
NOTE: If you had right-clicked the system root folder, you can select which projects you want
to export.
3 Click OK.
Result: The Export window closes and the Export dialog box opens.
4 Select a location where you want to save the export file, enter a file name, and click Save.
Result: The software creates the export file containing the selected Control project information.
NOTE: If you click Cancel, the Export dialog box closes without creating the export file and the
selection you have made in the Export window is discarded.

EIO0000001114 06/2020 315

Project Definition Stage

Importing a Control Project

Overview
The Import command lets you import data of a Control project from an export file (.sbk), which was
created by using the export (see page 312) functionality of the Project Explorer.
If the system into which you are importing a Control project already contains a Control project with
the same identifier, the software compares the data of both projects. It then proceeds with the
partial import, according to the import settings that you select and the import rules that are
described in this topic.
However, you cannot do a partial import of data related to communication mapping
(see page 630). You need to import either the complete communication channel and/or peer to
peer communication data (see page 645) that is contained in the export file for selected Control
projects or nothing. Importing it overrides any existing communication mapping and variable
mappings. Specific conditions apply and are described in this topic.
If the software detects conflicts related to communication mapping before import, you have the
choice to import the Control without communication mapping or to cancel the operation. If it detects
conflicts during the import process, the entire import operation is canceled and rolled back.
NOTE: If the export file also contains information of a Supervision project, you can see the data
that is related to the Supervision project, and have the choice to import it (see page 363) as well.

Software Version Compatibility

The version of EcoStruxure Process Expert that you use to import the information contained in the
export file must be the same as the version that you used to create the export file (a service pack
is considered the same version); otherwise you cannot proceed with the import.

Naming Rules for Variable Names and Section Identifiers

Names of variables and identifiers of sections that you import into a system need to satisfy the
naming rules (see page 99) for the generation process to complete successfully.

Checking Consistency After Import

After importing a Control project, perform a consistency check. This allows the software to identify
if the constituents of the project into which you have imported are not consistent with the facets that
are assigned to the project.
For more information on the process, refer to the topic Consistency Management (see page 523).

316 EIO0000001114 06/2020

 Project Definition Stage

Import Settings
The table describes which Control project information you can import into a system.

Item Selected for Description

import(1)
System_n By default Unselecting the item excludes any Control project and
disables the import of the export file.
ControlProject_n By default Unselect the item to exclude the entire project from the import
process.
Tasks folder By default You cannot unselect the item.
MAST and FAST task folders By default You cannot unselect the item.
Sections By default You can select sections individually.
Displays the identifier and path of the facets that are assigned
to the section.
A Constituent File is associated to each FBD section.
Selecting an FBD section imports any facets that are assigned
to this section.
NOTE: A section can be selected only if it is tagged with a
green dot (see page 328).
Constituent File (FBD By default If the identifier of the imported FBD section already exists in
sections only) the target project, the selection of the constituent file has an
impact on the import behavior (see page 320).
NOTE: The Constituent File check box is selected and
disabled if the identifier of the imported FBD section does not
exist in the target project.
Services By default Includes the ControlExecutive.
You cannot unselect the item.
Container Naming Rules Project Expressions (see page 402) are imported only if a Control
dependent project with the same identifier does not exist in the target
system.
(1) The information needs to be contained in the export file to be selected.

EIO0000001114 06/2020 317

Project Definition Stage

Item Selected for Description

import(1)
Executables By default You cannot unselect the item.
ControlExecutable_n By default You can select each Control executable and its contents
individually.
Selecting the Control executable automatically selects any
existing mapping.
Service Mappings By default Any data related to the service mapping including any required
contents in the Contents Repository.
Selecting the item automatically selects the associated
executable.
Hardware Mappings By default You cannot select hardware mappings individually.
Selecting the item automatically selects the associated
executable and service mapping.
Communication By default The complete data related to the communication mapping.
Mappings Selecting the item automatically selects the associated
executable and service mapping.
Built Participant Project By default Represents the Control Participant file (.stu).
It appears and is selected only if the built Participant project
was selected at the time of export.
Backups By default You can select data backup files individually
The time stamp and description of the backup file
(see page 823) are shown. The format of the time stamp is
YYYYMMDDHHMMSS.
Importing a data backup file makes it available in the Manage
Data Backup File dialog box (see page 335) and Deploy Data
dialog box (see page 750).
(1) The information needs to be contained in the export file to be selected.

318 EIO0000001114 06/2020

 Project Definition Stage

Import Rules for Project-Related Objects

Facets assigned to Control projects are related to instances of the application and mappings of
project executables are related to entities of the topology. For the Control project import to
complete entirely, these project-related objects need to be present in the system in which you want
to import the project.
The table describes the impact on the import operation when project-related objects are not
present or have a different configuration. It also describes the corrective action.

Project-related object that is not present Impact if not present in the target system Required action
or different
An instance whose facets are assigned You can import the project but not the Do either of the following first
to the Control project that you are sections to which such facets are to create missing instances:
importing (same identifier, template assigned. This requires that the project  Use the export/import
identifier, template version, and status contains at least one section that can be functionality
Valid) is not present. imported (see page 328), even empty. (see page 255) of the
A dialog box opens (see page 330) asking Application Explorer to
you to confirm the partial import. import missing instances.
 Create instances. This may
NOTE: Performing a partial import may
cancel the entire import operation if import require importing templates
rules for peer to peer communication first.
variables (see page 326) are not satisfied. You can obtain information
about the missing instances
and their templates in the
tooltip of the container that is
tagged with a red dot.
An element of the instance creating a The facet that is normally created by this Edit the instance in the
facet that is being imported is not element is not imported. Application Explorer and
selected. The notification panel provides select the corresponding
information about the facet that is not element.
imported.
For example, you import a Control project
to which the facet created by the
Maintenance element of an instance is
assigned but in the application of the
target system, the Maintenance element
of the same instance is not selected.
The properties of an instance are The assignment status of facets that are Generate the project o section
different from the instance configuration imported is set to Out Of Date. to apply the changes.
at the time of export. The difference lies
in the element selection (services) and/or
the parameter values (see page 200).
A topological entity to which you have You can import the project but not the Use the export-import
mapped the executable of the project Control project executable and any of its functionality (see page 610) of
(service and/or communication) that you associated mappings. the Topology Explorer first to
are importing (same identifier, same create the missing topological
devices, and same services). entities.

EIO0000001114 06/2020 319

Project Definition Stage

Import Rules for Sections

The table describes the import rules that apply to FBD and non-FBD sections with respect to the
section order when a Control project with the same identifier already exists in the target system.

Contents of export Section in Control Result in Control project of target system after import
file selected for project of target system
import
Section1, order 0 Section3, order 0 Section3, order 0
Section2, order 1 Section1, order 1 Section1, order 1
Section4, order 2 Section2, order 2
Section4, order 3
The order of existing sections is maintained and imported
sections are added at the end.
NOTE: If a section already exists in the target system, its
order is maintained even if the order of the section in the
export file is different.

The table describes the import rules that apply to non-FBD sections when a Control project with
the same identifier already exists in the target system.

Contents of export Section in Result in Control project of target system after import
file selected for Control project
import of target system
Section1 Section1 Section1 from export file replaces Section1 in the Control project of
target of the target system.
Section1 Section2 Section1 and Section2 exist in the Control project of target of the
target system.

Import Rules for Facets

The software applies import rules to facets if the system into which you are importing a Control
project already contains a Control project with the same identifier.
The following are the general import rules that the software applies if facets with the same identifier
contained in FBD sections with the same identifier exist in both the target project and the export
file that you are importing:
 If you select the constituent file of the section:
 Facets from the export file overwrite facets of the target system and maintain the state they
have in the export file.
 Facets that exist only in the export file are imported into the target system and maintain the
state they have in the export file.
 Facets that exist only in the target system become Assigned and Non Generated. If the
status of the facet is deleted, unassigned, or unlinked, the software removes the facet from
the section after import.

320 EIO0000001114 06/2020

 Project Definition Stage

 If you unselect the constituent file of the section:

 Facets with the same identifier maintain the state they have in the target system.
 Facets that exist only in the export file are imported into the target system and become
Assigned and Non Generated unless the generation status of the facet is Unlinked.
 Facets that exist only in the target system maintain their state.

NOTE: The software changes the assignment status of any facet of an instance to Out Of Date if
a property of an instance (see page 200) is different from what it was at the time of export. The
notification panel provides information about the change of the assignment status after import is
complete.
The following tables illustrate these import rules based on the different use cases.The section and
facet names are examples, and represent sections and facets in the MAST or FAST task folders
of the projects.
If you select the FBD section Constituent File check box.

Contents of export file Item in Control project Result in Control project of target system after import
selected for import of target system
Section identifier is identical
Section1 Facet1 Section1 – Facet1 from export file with status from export file.
Section1 Facet1 Section1 Facet1 Facet1 from export file with status from export file.
Section1 Facet1 Section1 Facet2 Facet1 from export file with status from export file.
Facet2 with status non-generated.
The software adds imported facets at the end of existing
facets in the target section.
If the status of Facet2 is deleted, unassigned or
unlinked, the facet is removed from the section after
import.
Section identifier does not exist in target project
Section2 Facet3 – – Section2 with Facet3 from export file with status of
export file.
The software adds imported sections at the end of
existing sections in the target task folder.
– The item does not exist

EIO0000001114 06/2020 321

Project Definition Stage

If you unselect the FBD section Constituent File check box.

Contents of export file Item in Control project Result in Control project of target system after import
selected for import of target system
Section identifier is identical
Section1 Facet1 Section1 – Facet1 from export file with status non-generated unless
generation status of Facet1 is Unlinked.
Section1 Facet1 Section1 Facet1 Facet1 from target system with same status.
Section1 Facet1 Section1 Facet2 Facet1 from target system with status non-generated.
Facet2 from target system with same status.
The software adds imported facets at the end of existing
facets in the target section.
– The item does not exist

Import Rules for Executables and Mappings

Communication mapping is created with the mapping information from the export file if the
following conditions are fulfilled:
 For peer to peer communication: The export file contains necessary data (see page 315) of both
the consumer and the owner projects and the corresponding elements are selected for import.
 The I/O scanner service of the client controller that is mapped to the imported executable is
enabled.
 Sufficient free memory is available in the client and/or server memory length property of the
controllers to fit the communication channels that exist in the export file.
 The client and server controllers that are mapped to the imported executables are connected to
the same Ethernet network.
 For I/O device communication channels, in addition:
 The I/O scanner service that is imported needs to match with the service of the topological
I/O device entity with which communication is to be implemented. Refer to the description of
the Service column in the Device IO section of the Communication Mapping Editor window
(see page 631).
 The topological I/O device entity with which communication is to be implemented needs to
be connected to the same Ethernet network as the controller.
If the export file contains mapped peer to peer variables, refer to the topic describing import rules
for peer to peer communication variables (see page 326).
If the software is not able to import communication mappings, a dialog box opens (see page 331)
indicating the reason.
The software updates the Build State (see page 696) of a Built executable after import depending
on the scenario.
NOTE: if the system into which you are importing a Control project already contains a Control
project and an executable with the same identifier, the software applies import rules to executables
and service, hardware, and communication mappings. These rules are described in the following
tables.

322 EIO0000001114 06/2020

 Project Definition Stage

The table describes the import rules that apply to Built executables based on different scenarios.

Contents of export file Item in Control project of Resulting built state in Control project of target system
selected for import target system after import
Executable1 Does not exist Out Of Date
Executable1 Executable1 Out Of Date
Executable1 Executable2 Executable1: Out Of Date.
Executable2: Out Of Date.

The table describes the import rules that apply to mappings based on different scenarios.

Contents of export Item in Control Result in Control project of target system after import
file selected for project of target
import system
Service mapping Exists Service mapping of target system is not changed.
Does not exist Service mapping is created with the mapping information from the
export file.
Hardware mapping Exists Hardware mapping of the target project is updated with the
mapping information from the export file in the following way:
 Existing mappings of the target project are overwritten.
 New mappings are created.
 Mappings of the target project that are not affected by the
import process are maintained.
NOTE: Any new mapping for which the required mapping
interface from the topological instance of the target project is not
present is rejected.
Does not exist Hardware mapping is created with the mapping information from
the export file.
NOTE: Any mapping for which the required mapping interface
from the topological instance of the target project is not present is
rejected.

EIO0000001114 06/2020 323

Project Definition Stage

Contents of export Item in Control Result in Control project of target system after import
file selected for project of target
import system
Communication Exists Communication mapping is overwritten as a whole if the following
mapping conditions are fulfilled:
 For peer to peer communication: The export file contains
necessary data (see page 315) of both the consumer and the
owner projects and the corresponding elements are selected
for import.
 Sufficient free memory is available in the client and/or server
memory length property of the controllers to fit the
communication channels that exist in the export file.
 For I/O device communication channels, in addition:
 The I/O scanner service that is imported needs to match
with the service of the topological I/O device entity with
which communication is to be implemented. Refer to the
description of the Service column in the Device IO section
of the Communication Mapping Editor window
(see page 631).
 The topological I/O device entity with which
communication is to be implemented needs to be
connected to the same Ethernet network as the controller.
 If a service mapping exists, it needs to be identical to the
service mapping contained in the export file for the Control
project that you want to import.
NOTE: If the export file contains mapped peer to peer variables,
refer to the topic describing import rules for peer to peer
communication variables (see page 326).

324 EIO0000001114 06/2020

 Project Definition Stage

Contents of export Item in Control Result in Control project of target system after import
file selected for project of target
import system
Communication Does not exist Communication mapping is created with the mapping information
mapping from the export file if the following conditions are fulfilled:
 For peer to peer communication: The export file contains
necessary data (see page 315) of both the consumer and the
owner projects and the corresponding elements are selected
for import.
 The I/O scanner service of the client controller that is mapped
to the imported executable is enabled.
 Sufficient free memory is available in the client and/or server
memory length property of the controllers to fit the
communication channels that exist in the export file.
 The client and server controllers that are mapped to the
imported executables are connected to the same Ethernet
network.
 For I/O device communication channels, in addition:
 The I/O scanner service that is imported needs to match
with the service of the topological I/O device entity with
which communication is to be implemented. Refer to the
description of the Service column in the Device IO section
of the Communication Mapping Editor window
(see page 631).
 The topological I/O device entity with which
communication is to be implemented needs to be
connected to the same Ethernet network as the controller.
 If a service mapping exists, it needs to be identical to the
service mapping contained in the export file for the Control
project that you want to import.
NOTE: If the export file contains mapped peer to peer variables,
refer to the topic describing import rules for peer to peer
communication variables (see page 326).

EIO0000001114 06/2020 325

Project Definition Stage

Import Rules for Peer to Peer Communication Variables

To be able to import communication mappings as a whole, the software also needs to be able to
create variable mappings that exist in the export file.
If none of the imported Control projects exist in the target system, the necessary variables are
created, given that import rules for project-related items are satisfied.
If either Control project that you are importing already exists in the target system but a variable that
is mapped to a peer to peer communication channel present in the export file has been modified
or deleted, two scenarios are possible:
 The variable was created by refining the Control project. In such case, when you import
communication mappings, the software is not able to recreate the variable. Therefore, it cannot
create variables mappings and the entire import process is canceled and rolled back. The
software displays a dialog box to inform you.
You need to recreate the variable manually to be able to import communication mapping.
 The variable was created by a facet assigned to the Control project. In such case, if you select
the constituent file of the section to which the facet is assigned, the import process is able to
recreate the required variable and the import succeeds, given that other necessary conditions
are fulfilled.
The following example illustrates the second scenario: You have created two Control projects,
Owner and Consumer between which a peer to peer communication channel exists. Var_1 is
mapped to this communication channel. The variable exists as network variable in Consumer (with
P2P as custom attribute) and as variable in Owner.
You have exported both projects with their complete contents and have kept on working on both
projects, which altered the communication mapping . After a while, you realize that you are not
satisfied with some changes you made and therefore, you want to recover the original projects and
communication mapping while keeping some of your changes (for example, you want to keep an
FDB section that you have added to Consumer after exporting).
You import the export file in the Projects Explorer where Owner and Consumer Control exist.
However, you have renamed Var_1 in the Owner project.
Because you want to import communication mappings, you have selected both Control projects in
the Import window.
Because Var_1 had been created by a facet that is assigned, for example, to FBDSection_1 in
the Owner Control project, by selecting the constituent file (see page 320) of FBDSection_1 in
the Import window, you are able to recreate the variable and import communication mappings.
NOTE: A network variable can be used only once per project, independently of the number of
Control executables that exist in the project.

326 EIO0000001114 06/2020

 Project Definition Stage

The following figure illustrates the import example by using a target system in which the Owner and
Consumer projects exist and showing the objects that are selected for import.

1 FBDSection_1 of Owner Control project showing the facet that creates Var_1
2 Consumer Control project
3 Communication mappings of Consumer
4 Owner Control project
5 Constituent file of FBDSection_1 to which facet that creates Var_1 is assigned

Import Rules for Data Backup Files

When you import a Control project and a Control project with the same identifier already exists in
the target system, if you have selected to import the data backup file and a file with the following
identical identification information (see page 823) already exists, the file is not imported:
 Time stamp.
 Identifier of the executable.
 Identifier of the controller and role.
 Description.
 Type of data that is backed up.

NOTE: The notification panel displays information about the not imported data backup file.

EIO0000001114 06/2020 327

Project Definition Stage

Opening the Project Import Window

To open the Import window, proceed as follows.

Step Action
1 Right-click the system root folder in a Project Browser of the Project Explorer and select Import.
Result: The Import dialog box opens.
2 Browse to the export file (.sbk) that contains the Control project information that you want to
import and click Open.
Result: The Import window opens and displays the contents of the file that you have selected
once it has read the data contained in the file. This can take time depending on the number and
size of projects contained in the file.
NOTE: You can abort the command (see page 332).

Project Import Window

The Import window lets you select Control project information that is contained in an export file and
that you can import into an existing system. You can select one or more entire Control Participant
project and/or parts of them.

328 EIO0000001114 06/2020

 Project Definition Stage

The following figure shows an example of the Import window displaying the contents of a Control
project export file. In this example, the check box for FBDSection_2 is cleared because the
section cannot be imported. To indicate that at least one item of the Control project is not selected,
the check box of parent nodes are filled with a square.

EIO0000001114 06/2020 329

Project Definition Stage

The table indicates the meaning of the colored dots that appear in the Import window next to items
of a Control project.

Color code Description

Green You can import the item.
Red  At the section level: The section contains at least one facet that is referenced by an instance,
which is not present in the application (see page 319).
 At the executable level: A project-related topological object (see page 319) is not present in
the target system.
A tooltip provides additional information about the issue.
NOTE: You cannot import items that are tagged with a red dot.
Yellow The item contains at least one subitem that is tagged with a red dot.
The item can be imported partially only.

NOTE: To expand/collapse a node in the Import window, select the node and press Enter.

Confirmation Dialog Box For Sections That Cannot Be Imported

The following figure shows an example of the dialog box that opens when a section of a Control
project selected for import is tagged with a red dot and you click OK in the Import window.
If you are importing also Supervision projects, containers are grouped by Participant then by
project.

330 EIO0000001114 06/2020

 Project Definition Stage

Button Description
Yes Closes the dialog box, the Import window, and imports the selected projects without
sections tagged with a red dot.
No Closes the dialog box and reverts to the Import window without importing projects. You
can modify the selection of projects or cancel the import operation.

Confirmation Dialog Box For Communication Mappings That Cannot Be Imported

The following figure shows an example of the dialog box that opens when you click OK in the Import
window and the software detects that communication mappings selected for import cannot be
imported. It indicates the identifier of the project and the corresponding executable, and the reason.
The Import window is closed before the dialog box opens.

Button Description
Yes Closes the dialog box and imports the selected projects without communication mappings.
NOTE: This may result in variable mappings being present in the target system while the
required variables do not exist.
No Closes the dialog box and cancels the import operation.

EIO0000001114 06/2020 331

Project Definition Stage

Aborting Import Tasks

The abort icon is displayed in the notification panel (see page 86) at two different stages of the
import process:
 After clicking Open when you select the export file (see page 328). Clicking the icon cancels the
operation to read the contents of the export file. The Import window does not open.
 After confirming the import by clicking OK in the Import window, the abort icon is displayed.
Clicking the icon cancels the task. The project is not imported.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are importing a small project, each task may complete before you are able to click
the icon.

Importing a Control Project

To import data of a Control project into an existing system, proceed as follows.

Step Action Result

1 In the Import window (see page 328), -
select the items that you want to import.
2 Click OK. If applicable rules are satisfied, the software:
 Applies the import rules based on your import
selection.
 Proceeds with the import.
 Replaces existing communication mapping if you had
selected to import them.
 Displays an import summary dialog box.

3 In the Project Browser, right-click the The Control Participant window opens.
Control project into which you have
made the import and select Refine.
4 Click the consistency check button The software proceeds with a consistency check and
(see page 526). displays a notification to report findings once the check is
completed.
5 Take the necessary corrective actions -
(see page 526).

NOTE: If the software detects incompatibilities during the import process, it cancels and rolls back
the import operation, and displays a dialog box to inform you. In such case, take the necessary
corrective actions and start the import over. For example, if the incompatibility is related to variable
mappings, you can clear the check box next to CommunicationMappings to import Control project
data but no communication mapping.

332 EIO0000001114 06/2020

 Project Definition Stage

Importing a Control Expert Project

Overview
The Import Control Project command allows you to create a Control project in the Project Explorer
by importing data of a project that was created by using Control Expert and which is contained in
a compatible project file (.stu or .xef format).
After import, you will have access to the same commands from the project node as if you had
created the project in the Project Browser.

Project Compatibility
To be able to import a project created with Control Expert, the following requirements need to be
met:
 The version of Control Expert with which the export file was created needs to be identical to the
version of the Control Participant. To determine the version of the Control Participant, open it
(for example, by refining a Control project) and open the About dialog box from the Help menu.
 The version of the EcoStruxure Control Expert DTM Library that is installed in Control Expert
needs to be the same as the one installed in the Control Participant. For information on the
installed version, refer to the platform release notes.

Imported Data

Project data contained in the file (stu Contained in the Visible in the Project Explorer after import
or .xef) Control Participant
project after import
FBD sections Yes Yes
Sections in the following Yes Sections are created in their respective
MAST and FAST task folders in the
programming languages:
 Ladder Diagram (LD)
Assignment Editor.
 Instruction List (IL)
 Structured Text (ST)
 Sequential Function Chart (SFC)
 Ladder Logic 984 (LL984)

Constituents of any section Yes No

Configuration No Refine the imported project to view the
information.
Other global project information (for Yes
example, variables, types, project NOTE: Only data related to the program
settings...) becomes part of the logical Control project.
Other data (for example, data related to the
configuration) is ignored during build
although it is visible when you refine the
logical project.

EIO0000001114 06/2020 333

Project Definition Stage

Project data contained in the file (stu Contained in the Visible in the Project Explorer after import
or .xef) Control Participant
project after import
Project platform Yes Yes
Controller Family attribute (see page 307).

NOTE: The name of the file containing the project data becomes the identifier of the Control project
that the software creates during the import process.

Importing a Control Expert Project

To import a Control Expert project into an existing system, proceed as follows.

Step Action
1 Right-click the system root folder in the Control Project Browser of the Project Explorer and
select Import Control Project.
Result: The Open dialog box opens.
2 Select the file format that you want to import.
3 Browse to the location of the Control Expert project file that you want to import and click Open.
Result: The software creates a Control project and displays it in the Control Project Browser.

334 EIO0000001114 06/2020

 Project Definition Stage

Managing Data Backup Files

Overview
The Manage Data Backup Files dialog box lets you view and delete data backup files
(see page 823) that exist for all the executables of a Control Participant project.
The dialog box shows the information that was associated to each backup file at the time of
creation, including the type of data that was selected.
By default, backup files are listed in descending order of time stamp (most recent one on top). You
can sort and filter (see page 138) the information that is displayed.

Opening the Manage Data Backup Files Dialog Box

To open the Manage Data Backup Files dialog box, right-click a Control Participant project in the
Project Browser and select Manage Data Backup Files.
If no data backup file exists, the command is not available.

Manage Data Backup Files Dialog Box

The following figure shows an example of the Manage Data Backup Files dialog box, which shows
the data backup files that have been created for executables of ControlProject_1.

EIO0000001114 06/2020 335

Project Definition Stage

Column Description
header
Time Stamp Date and time of the backup file creation.
Description Description that was entered when the backup file was created.
User Name of the user who was logged on when the backup file was created.
Executable Identifier of the Control executable whose data is contained in the backup file.
Controller Identifier of the controller that was running the executable whose data was backed up.
For redundant controllers, it also indicates the role of the controller that was selected when
the backup file was created.
%M Indicates the memory range of located variables of boolean data type that are contained in
the backup file.
If no such data was selected during data backup, the value shown is N/A.
%MW Indicates the memory range of located variables of WORD data type that are contained in
the backup file.
If no such data was selected during data backup, the value shown is N/A.
Unlocated True indicates that this type of data was selected during data backup.
Variables Possible values:
 True
Unlocated FBs
 False

Deleting Data Backup Files

To delete a data backup file, select the corresponding row and click Delete. The backup file is
deleted after you confirm the command.
You can select more than one backup file at a time.
NOTE: When you delete a Control Participant project or the controller to which it is deployed, the
corresponding data backup files are deleted as well.

336 EIO0000001114 06/2020

 Project Definition Stage

Section 13.4
Supervision Project Definition Stage

Supervision Project Definition Stage

Overview
This section describes how to create Supervision projects of a system.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Internal Supervision Architecture 338
Creating Supervision Projects 339

EIO0000001114 06/2020 337

Project Definition Stage

Internal Supervision Architecture

Task Description
As a reminder, the following figure describes the internal Supervision architecture for the execution
of tasks:

1 Report scheduling and execution

2 Alarm acquisition and processing
3 Trend acquisition and storage
4 I/O communications
5 Graphical interface, events, local I/O, and client services

NOTE: Report, alarm, and trend servers also act as clients of the I/O server.

338 EIO0000001114 06/2020

 Project Definition Stage

Creating Supervision Projects

Creating Supervision Projects

To create a Supervision project, proceed as follows.

Step Action
1 In the Supervision Project Browser, right-click the system root folder and select Create
Supervision Project.
Result: The Supervision is shown in the tree view.

NOTE: For each system, you can create as many Supervision projects as needed to meet the
requirements of the system.

Supervision Project Actions

The table describes the Supervision project context menu commands.

Command Description Applies to

Create Cluster Creates a new cluster with its default contents and displays it Project Definition stage
(see page 344) in the tree view.
Last Action Opens a dialog box that indicates the last action that was
Summary performed and a summary of the result.
(see page 381)
Assign Facets Opens the Assignment Editor, which lets you create and Assignment Stage
manage tag containers and Supervision pages of the (see page 383)
Supervision project and assign facets to them.
Generate Starts a process that creates and/or updates in the Generation stage
Supervision Participant project the data of the entire (see page 443)
Supervision project.
Refine Opens the Supervision Participant, which allows you to Refinement stage
modify the project. (see page 543)

EIO0000001114 06/2020 339

Project Definition Stage

Command Description Applies to

Advanced Opens the Supervision Participant, which allows you to Refinement stage
Settings change advanced project settings that will be activated in the
(see page 545) station nodes where you deploy the Supervision project.
Include Projects Opens a dialog box, which allows you to:
(see page 546)  Add external included projects to be deployed to the
Supervision nodes.
 To remove included projects that are attached to the
Supervision and stored in the contents repository.
NOTE: You cannot add an included project if the software
has already added to the Participant project an included
project with the same name.
Attach User Opens a dialog box, which allows you to:
Files  Attach external files to be deployed to the Supervision
(see page 547) nodes.
 To remove files that are attached to the Supervision
project and stored in the contents repository.
Export Opens a Save As dialog box, which allows you to create an Project Definition stage
(see page 358) export file containing the Supervision project information.
Settings Opens the Settings window (see page 308), which lets you Assignment stage
configure various project-related settings.
Delete Deletes the Supervision project including components, –
assignments, and mappings.
Rename Allows you to enter a new identifier for the project. –
Properties Opens the Properties window, which allows you to edit the –
properties of the Supervision project.

Containers Node Actions

The table describes the Containers node context menu commands.

Command Description Applies to

Assign Facets Opens the Assignment Editor, which lets you create and manage Assignment Stage
tag containers and Supervision pages of all clusters and assign (see page 383)
facets to them.
Create Tag Lets you create a tag container (see page 394) in an existing
Container cluster.
The Assignment Editor opens in the background.
Create Page Opens the Assignment Editor and creates a Supervision page
(see page 400) in the project.
Generate Starts a process to create and/or update in the Supervision Generation Stage
Participant project the data for the containers of all clusters that (see page 443)
exist in the project.

340 EIO0000001114 06/2020

 Project Definition Stage

Pages Node Actions

The table describes the Pages node context menu commands.

Command Description Applies to

Assign Facets Opens the Assignment Editor, which lets you create and manage Assignment Stage
tag containers and Supervision pages of all clusters and assign (see page 383)
facets to them.
Create Page Opens the Assignment Editor and creates a Supervision page in the Assignment Stage
project. (see page 384)
Generate Starts a process to create and/or update in the Supervision Generation Stage
Participant project the data for the pages that exist in the project. (see page 443)

Cluster Node Actions

For a description of the context menu commands, refer to the topic describing how to create
clusters (see page 344).

Tags Node Actions

The table describes the Tags node context menu commands.

Command Description Applies to

Assign Facets Opens the Assignment Editor, which lets you create and manage Assignment Stage
tag containers and Supervision pages of the parent cluster and (see page 383)
assign facets to them.
Generate Starts the generation process of tag containers and pages that exist Generation Stage
in the parent cluster to populate new tags, update out-of-date tags, (see page 443)
and/or remove deleted tags in the Supervision Participant project.

Services Node Actions

The table describes some of the Services node context menu commands. For a description of the
other commands, refer to the topic describing how to create Supervision servers and clients
(see page 345).

Command Description Applies to

Open Opens the Services window, which lets you view and edit properties Assignment Stage
of the Alarm, report, and trend servers as well as clients that exist (see page 383)
in the parent cluster.
Generate Starts a process to create and/or update in the Supervision Generation Stage
Participant project the data related to services. (see page 443)

EIO0000001114 06/2020 341

Project Definition Stage

ClientEvents and ServerEvents Node Actions

The table describes the ClientEvents and ServerEvents nodes context menu commands.

Command Description Applies to

Open Opens the corresponding window, which lets you view the Assignment Stage
Supervision facets that are assigned to client or server events in the (see page 383)
parent cluster.
Generate Starts a process to create and/or update in the Supervision Generation Stage
Participant project the data related to services in the parent cluster. (see page 443)

Executables Node Actions

The table describes the Executables node context menu commands.

Command Description Applies to

Create Creates one or more Supervision executables (see page 677), Mapping Stage
Executable which let you associate the Supervision project infrastructure to
stations nodes and the I/O devices to controllers.

Supervision Project Properties

Right-click the Supervision project and select Properties.
You can edit the following items.

Item Description
General Identifier The identifier of the Supervision project, which must be unique within the
system.
Description Optional.
You can enter a description of the project with free form text.

342 EIO0000001114 06/2020

 Project Definition Stage

Section 13.5
Creating Supervision Project Components

Creating Supervision Project Components

Overview
This section describes how to use the Project Explorer to create the components of Supervision
projects.
During build, one or more OPC Factory Server and/or OPC UA Server Expert configuration files
(.xml) are automatically generated (see page 705) based on the configuration of properties of the
Supervision project components.
For information on how to create tag containers and Supervision pages, refer to the topic
describing the creation of containers (see page 384) in the Assignment stage.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Creating Clusters 344
Creating Supervision Servers and Clients 345
Creating I/O Devices 348
Creating Communication Ports 351
Implementing Redundancy 354

EIO0000001114 06/2020 343

Project Definition Stage

Creating Clusters

Creating Clusters
To create a cluster, proceed as follows.

Step Action
1 Right-click the Supervision project and select Create Cluster.
Result: The software creates a new cluster node and its child nodes.

Cluster Actions
The table describes the cluster context menu commands.

Command Description
Generate Starts the generation process to populate the database of the Supervision Participant project
for this cluster.
Delete Deletes the cluster including its contents and unassigns the assigned Supervision data facets.
Rename Lets you enter a new identifier for the cluster.
Properties Opens the Properties window, which allows you to edit the properties of the cluster.

Cluster Properties
To open the Properties window of the cluster, right-click the cluster and select Properties.
You can edit the following items,

Item Description
General Identifier The identifier must be unique within the Supervision project and satisfy
applicable naming rules (see page 99).
NOTE: Changing the identifier of the cluster changes the assignment
status of facets that are assigned to a tag container of the cluster to Out Of
Date.
Description Optional.
You can enter a description of the cluster with free form text.

344 EIO0000001114 06/2020

 Project Definition Stage

Creating Supervision Servers and Clients

Overview
You can create Supervision servers in the Services node of a cluster.
The I/O server instance represents a server that is set up on an operation server
(see EcoStruxure™ Process Expert, Installation and Configuration Guide), on which Supervision
and OPC Factory Server or OPC UA Server Expert software is installed. The operation server is
represented in the topology of the system by a station node (see page 566), which acts as an
engine to run the Supervision project.
The alarm, trend, and report server instances represent servers that are set up on a single or
distinct operation servers, on which Supervision software is installed.
You can create up to two alarm, report, and trend servers per cluster.
NOTE: Generate the Supervision project after you make changes related to components described
in this topic.

Creating Supervision Servers

To create I/O, alarm, trend, and report servers in the cluster, proceed as follows.

Step Action
1 Right-click the Services node and select the corresponding command.
Result: The new server is created.
NOTE: Only I/O servers are shown in the project browser. To view other servers, open the
Services node.

NOTE: The software may automatically create servers during the assignment stage if you have not
created them already. For more information, refer to the Supervision project Assignment stage
(see page 421).

Supervision I/O Server Properties

To open the Properties window of an I/O server, right-click the server and select Properties.
You can edit the following items.

Item Description
General Identifier The identifier must be unique within the Supervision project.
Description Optional.
You can enter a description of the server with free form text.
Attributes Port Communication port the server listens on.
Default value: 2082.
Legacy Port Communication port that is used for legacy connections to the server.
Default value: 2078.

EIO0000001114 06/2020 345

Project Definition Stage

Supervision Servers Common Properties

To view the alarm, trend, and report servers that exist in the cluster and their properties, right-click
the Services node and select Open.
You can view and/or edit the following items.

Item Description
General Identifier The identifier must be unique within the Supervision project.
Default value: Server_n_P where:
 Server is the name of the service provided by the server (for example,
Alarm).
 n is an incremental number starting at 1.
 P stands for primary. The suffix of the second server instance that you create
is _S for standby, even if you rename the first instance.
Description Optional.
You can enter a description of the server with free form text.
Attributes Port Communication port the server listens on.
Default value:
 Alarm server: 2080
 Report server: 2084
 Trend server: 2085

Edit the value if you are running more than one server on the station node.
Legacy Port Communication port that is used for legacy connections to the server.
Default value:
 Alarm server: 2076
 Report server: 2075
 Trend server: 2077

Database The attribute is available for alarm servers only.

Port Communication port the server database listens on.
Default value: 5482
Edit the value if you are running more than one alarm server on the station node.
Mode You can select one of the following values from the menu:
 None
 Primary: Defines the server as the primary server. Default value for the server
with _P suffix.
 Standby: Defines the server as the standby server. Default value for the server
with _S suffix.
Extended The attribute is available for alarm servers only.
Memory Possible values:
 False: Default value.
 True: The alarm server operates in 64-bit extended memory mode. This allows
the alarm server process to utilize memory beyond the 4GB limit.
For more information on this mode of operation, refer to Alarm Server
Process in the help of the Supervision Participant.

346 EIO0000001114 06/2020

 Project Definition Stage

Creating Supervision Clients

You can create Supervision Clients in the Services node of a cluster.
The client instance can represent a Supervision client (runtime) that runs:
 On the operation server.
 On an operator station.

To create a client for the Supervision project, proceed as follows.

Step Action
1 Right-click the Services node and select Create Client.
Result: The client is created but not shown in the project browser.

Supervision Client Properties

To view the clients that exist in the cluster and their properties, right-click the Services node and
select Open.
You can edit the following items.

Item Description
General Identifier The identifier must be unique within the Supervision project.
Description Optional.
You can enter a description of the client with free form text.

EIO0000001114 06/2020 347

Project Definition Stage

Creating I/O Devices

Overview
Typically, an I/O device is created for one controller. If the data is present in two controllers, create
an additional I/O device for the second controller manually. Create a second tag container
(see page 394) for data of the second controller and associate this tag container to the second I/O
device.
The software creates additional I/O devices (see page 350) when you create calculated or disk
variable tags.
NOTE: Monitoring data of a device (see page 920) communicating by using the Modbus TCP
protocol (or Modbus through an Ethernet gateway) from the Supervision infrastructure also
requires a dedicated I/O device per Modbus device.

Prerequisites
An I/O server must exist in the cluster.

Creating I/O Devices

To create an I/O device in the cluster, proceed as follows.

Step Action
1 Expand the Services node and the I/O server, right-click the IODevices node, and select Create
IO Device.
Result: The I/O device is created but not shown in the project browser.

NOTE: The software automatically creates the I/O device during the assignment stage if you have
not created it already. For more information, refer to the Supervision project Assignment stage
(see page 421).

348 EIO0000001114 06/2020

 Project Definition Stage

I/O Device Properties

To view the I/O devices that exist in the cluster and their properties, right-click the IODevices node
and select Open.
You can edit the following items.

Item Description
General Identifier The identifier must be unique within the Supervision project.
NOTE: Changing the identifier of the I/O device changes the assignment status of
facets that are assigned to the tag container that is associated with the I/O device to
Out Of Date if they were generated.
Description Optional.
You can enter a description of the I/O device with free form text.
Attributes Address The value needs to be compatible with the protocol that is selected for the associated
tag container.
The default value is the alias name for OPC Factory Server: Alias_<IODevice_n>
where <IODevice_n> corresponds to the value of Identifier.
NOTE: The attribute is disabled and cleared when Protocol of the associated tag
container is set to OPCUA or OPCUA Embedded.
For these two protocols, the following temporary address is created for the I/O device
when you generate the Supervision project or the cluster:
 For OPCUA: opc.tcp://127.0.0.x:49152/OPCUAServerExpert
 For OPCUA Embedded: opc.tcp://127.0.0.x:4840

During build (see page 704), the IP address placeholder (127.0.0.x) and the port value
are updated based on the mapping.
StartupMode Select the role of the I/O device in terms of communication with the controller:
 Primary (default value)
 Standby
 StandbyWrite
 None

Priority You can assign the order in which the I/O device attempts to communicate with the tag
container that it is associated with in case more than one I/O device is associated with
the container.
Set the values as follows depending on the role of the I/O device:
 Primary: 1 or blank (default value)
 Secondary: 2 or higher

NOTE: If you associate two I/O devices configured as primary to one tag container,
verify that Priority is configured with a different value for each.
Memory Select one of the following values depending on how you want the I/O device to
communicate with the controller:
False Default value. The I/O device is online with the controller
True The I/O device is not connected to the controller. Select this setting for testing
purposes, for example.

EIO0000001114 06/2020 349

Project Definition Stage

Item Description
Relationships TagContainer Select the tag container that is associated with the I/O device.
NOTE:
 By default, the software associates the I/O device with the tag container for which
the I/O device has been automatically created (see page 421) during the
assignment of Supervision data facets.
 Changing the relationship of the I/O device to the tag container changes the
assignment status of facets assigned to the tag containers affected by this change
to Out Of Date.
Ports Select the communication port (see page 351) that is associated to the I/O device.
NOTE: By default, the software associates the I/O device with either the
communication port that has been automatically created (see page 421) during the
assignment of Supervision data facets or with the one that you have created manually.

I/O Devices Created for Calculated and Disk Variable Tags

When you generate a Supervision data facet that references a non-disabled Calculated Variable
Tag or Disk Variable Tag element (see EcoStruxure™ Process Expert, Global Templates,
Reference Manual), one specific I/O device is automatically created per I/O server with the same
properties as the default I/O device except for the following. These specific I/O devices are only
visible when you refine the Supervision project.

Property For a calculated variable tag For a disk variable tag

Identifier CicodeIODevice_n where is an Disk_IODeviceID_n where:
integer starting at 1 so that the identifier  IODeviceID is the identifier of the I/O device
remains unique within the I/O sever. that is associated to the tag container to which
the data facet is assigned.
 n is an optional integer starting at 1 that is
added so that the identifier remains unique
within the I/O sever.
Address Blank Blank
Ports Blank Blank
Memory Same value as default I/O device True
Persist True

350 EIO0000001114 06/2020

 Project Definition Stage

Creating Communication Ports

Overview
Before you can create a communication port, you need to create a communication board unless
one already exists.
You need to create a communication board for each communication driver that you are using. For
example, if you are using both OFSOPC and OPCUA, create one board for each and configure
them accordingly.
To view the communication ports that exist, right-click a board and select Open.

Prerequisites
An I/O server must exist in the cluster.

Creating a Communication Board

To create a communication board, proceed as follows:

Step Action
1 Expand the Services node and the I/O server, right-click the Communications node, and select
Create Board.
Result: The board is created.

NOTE:
 The software automatically creates one communication board and port during the assignment
stage if you have not created it already. For more information, refer to the Supervision
Assignment stage (see page 421).
 Deleting a communication board deletes the associated communication ports.

EIO0000001114 06/2020 351

Project Definition Stage

Communication Board Properties

To open the Properties window of the communication board, right-click it, and select Properties.
You can edit the following items. For details, refer to Board Properties in the help of the Supervision
Participant.

Item Description
General Identifier The identifier must be unique within the I/O server.
16 characters maximum.
Description Optional.
You can enter a description of the board with free form text.
Attributes Protocol Indicates the protocol for communicating with the I/O device and that is to
be used for configuring the I/O device.
When the protocol for the tag container is set to OPCUA Embedded, select
OPCUA.
When you configure a user-defined protocol for a tag container
(see page 395), enter a protocol for the board that is compatible and
installed in the Supervision Participant. To verify which ones are installed,
refine the Supervision Participant project and expand an entry in the Board
Type column of Components & Mapping in the Topology activity.
Default value:
 Same as Protocol (that is, OFSOPC or OPCUA) if the value of Protocol for
all the tag containers that are associated to an I/O device whose
communication port is associated to the board is the same; otherwise,
OFSOPC.
 OFSOPC when you create the board manually.

Address Default value: 0 when the board is created by the software.

NOTE: The OFSOPC driver configuration implements an automatic and adaptive strategy, creating
and deleting OPC groups and OPC items dynamically to maximize throughput. For information on
other parameters affecting performance when using this driver configuration, refer to Performance
Considerations (see EcoStruxure™ Process Expert, Supervision Participant Services, User
Guide).
NOTE: For the OPCUA driver, the software adds driver-specific parameters to the citect.ini file
(see EcoStruxure™ Process Expert, Supervision Participant Services, User Guide) (for example,
subscription and connection parameters), which are configured with default values and apply to a
given I/O device. For details, refer to OPCUA Driver in the Driver Reference Help of the
Supervision Participant.

352 EIO0000001114 06/2020

 Project Definition Stage

Creating Communication Ports

For each communication board, you can create several communication ports.
To create a communication port, proceed as follows.

Step Action
1 Expand the Services node, right-click the board, and select Create Port.
Result: The port is created but not shown in the project browser.

Communication Port Properties

To view the ports that exist for a board and their properties, right-click the board and select Open.
You can edit the following items.

Item Description
General Identifier The identifier must be unique within the I/O server.
Description Optional.
You can enter a description of the port with free text.
Attributes Port Number Interrupt number of the port.
Leave it blank if you are using the COM port of the computer.
Special Opt Lets you enter any special options that are supported by the board.
32 characters maximum.
For details, refer to Hardware Arrangements in the help of the
Supervision Participant.
Relationships IoDevice Select the I/O devices that are associated with the communication port
from the menu.
The I/O device (see page 348) must exist in the Supervision project
cluster to be available for selection.
NOTE: By default, the software associates the port with the I/O device
that has been automatically created (see page 421) during the
assignment of Supervision data facets. If you have created the I/O
device manually, associate it with the port.

EIO0000001114 06/2020 353

Project Definition Stage

Implementing Redundancy

Overview
The Supervision Participant allows you to build redundancy into the system at different levels to
help increase the degree of protection and/or reliability. The common ways to implement
redundancy are:
 I/O server redundancy
 Alarm, trend, and report server redundancy
 Network redundancy

The following topics describe the additional steps that you need to complete in order to implement
such redundancy by starting from a typical Supervision project, which consists of one of each:
 Cluster
 Tag container
 I/O server with its client
 I/O device
 Communication board
 Communication port

For more information, refer to the topic of the Supervision Participant help (see page 104), which
describes how to build redundancy into a system.

354 EIO0000001114 06/2020

 Project Definition Stage

I/O Server Redundancy

To implement I/O server redundancy, proceed as follows.

Step Action Refer to

1 From the Services node of the Supervision project, create a second I/O server. Project definition
stage
2 From the Services node, create a client for this second I/O server.
3 From the Communications node of the second I/O server, create a
communication board.
4 From this board, create a communication port.
5 From the IODevices node of the second I/O server, create an I/O device.
6 In the properties of the second I/O device, associate the I/O device with the tag
container of the Supervision project, which is already associated to the first I/O
device.
Result: The software automatically configures the StartupMode of the second I/O
device as Standby with Priority 2.
7 In the same window, configure the Ports property as Port_2, which is the port of
the communication board that you have created in step 4.
8 In the properties of the communication port of the second I/O server, verify that
the port is associated to the standby I/O device under IODevice.
9 In the properties of the communication board of the second I/O server, configure
Protocol with the same values as for the tag container, which is associated to the
first I/O device.
10 From the system root folder, create a station node entity representing the second Configuration
I/O server. stage
11 In the properties of the NIC of this station node, configure the IP address of the
NIC.
12 On this station node, create one Supervision and one OFS service instances.
13 Connect this station node to the Ethernet network.
14 Once you have generated the complete Supervision project, from the project Mapping stage
executable, perform the service mapping of the second I/O server to the station
node that you have created in step 10.
15 From the project executable, map the standby I/O device to the same controller
to which you have mapped the primary I/O device (communication mapping).
16 Configure the physical computers according to the topology of the system, build, Build and
and deploy the Supervision project. Deployment
stage

EIO0000001114 06/2020 355

Project Definition Stage

Alarm, Trend, or Report Server Redundancy

To implement alarm, trend and/or report server redundancy, proceed as follows.

Step Action Refer to

1 From the Services node of the Supervision project, create a second alarm, trend Project definition
and/or report server. stage
Result: The software:
 Creates the server with the _s suffix in its identifier.
 Configures its Mode as Standby.

2 From the system root folder, create a station node entity representing each Configuration
redundant alarm, trend and/or report server. stage
3 In the Properties window of the NIC of each redundant station node, configure
the IP address of each NIC.
4 On each redundant station node, create one Supervision service instance.
5 Connect each redundant station node to the Ethernet network.
6 Once you have generated the complete Supervision project, from the project Mapping stage
executable, map each standby server to the corresponding redundant station
node (service mapping).
7 Configure the physical computers according to the topology of the system, build, Build and
and deploy the Supervision project. Deployment stage

Network Redundancy
Network redundancy can be implemented for any Supervision station.
To implement network redundancy, for example, on the operation server, proceed as follows.

Step Action Refer to

1 In the station node entity representing the operation server (I/O server), create a Configuration
second NIC. stage
2 In the Properties window of the second NIC, configure its IP address.
NOTE: It is not required to connect this NIC to an Ethernet network.
3 Configure the physical computers according to the topology of the system. –
4 Build the Supervision project by using the Build All command. Build and
Mapping stages
NOTE: In the service mapping, no additional mapping is required as the engine
that is mapped to the IOServer service is the station node.
5 Deploy the Supervision project either from the executable or from the station Deployment and
node by selecting either NIC. Execution stages
Result: After restoring the Supervision project on the station node (operation
server), both network addresses are created in the Supervision Participant and
associated to the I/O server.

NOTE: No specific action is required in the Supervision project.

356 EIO0000001114 06/2020

 Project Definition Stage

Section 13.6
Managing Supervision Projects

Managing Supervision Projects

Overview
This section describes how to use the Project Explorer to manage Supervision projects and project
contents.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Exporting a Supervision Project 358
Importing a Supervision Project 363

EIO0000001114 06/2020 357

Project Definition Stage

Exporting a Supervision Project

Overview
The export functionality lets you create a non-editable export file (.sbk), which contains selected
Supervision project information.
You can use this data with the Supervision project import (see page 316) functionality to transfer
Supervision project information to a different system or merge information from different
Supervision projects.
NOTE: To export all the projects (Control and Supervision) of a system at once in one export file,
right-click the root folder in either Project Browser, select Export, and follow the export procedure
described in this section. Refer also to the topic describing the export and import of Control projects
(see page 310).

Software Version Compatibility

The version of EcoStruxure Process Expert that you use to import the information contained in the
export file must be the same as the version that you used to create the export file (a service pack
is considered the same version); otherwise you cannot proceed with the import.

Project Related Data

To be able to use the export file for importing a project into a different system, verify that the
instances, their templates, and topological entities related to the project exist in the target system
before importing the project (see page 367). Use the export-import functionality (see page 610) of
the Topology Explorer first.
NOTE: The parameter values of instances that reference the exported facets are not contained in
the export file. However, the export file contains information that allows the software to verify during
import if the configuration of an instance is different from when its facets were exported.

358 EIO0000001114 06/2020

 Project Definition Stage

Project Export Window

The Supervision project Export window lets you select, which information the export file will
contain.
The following figure shows an example of the Export window where the check box for
TagContainer_2 has been cleared. To indicate that at least one item of the Supervision project
is not selected, the check box of parent nodes are filled with a square.

EIO0000001114 06/2020 359

Project Definition Stage

The table indicates the meaning of the colored dots that appear in the Export window next to items
of a Supervision project.

Color code Description

Green You can export the item.
Red You cannot export the item because it contains at least one facet with the following state:
 Deleted
 Unassigned
 Out of Date
 Moved

Generate containers that contain facets with such states or clear their check box in the Export
window in order to export the Supervision project.
NOTE: You cannot export items that are tagged with a red dot.
Yellow Indicates that the item contains at least one subitem that is tagged with a red dot.
The item can be exported partially only.

NOTE: To expand/collapse a node in the Export window, select the node and press Enter.

Export Settings
The table describes which Supervision project information you can export.

Item Selected for Description

export
SupervisionProject_n By default Unselect the item to exclude the entire project from the export
file.
When you select the project, the associated equipment
hierarchy (see page 173) is exported.
Pages node By default You cannot unselect the item.
Pages By default Selecting a page automatically selects any genie facets that
are assigned to it.
Selecting a page automatically selects the logical Participant
project.
Cluster_n By default You cannot unselect the item.
Tags node By default You cannot unselect the item.
Tag containers By default You can select tag containers individually.
Selecting a tag container automatically selects any facets that
are assigned to it.

360 EIO0000001114 06/2020

 Project Definition Stage

Item Selected for Description

export
Services node By default You cannot unselect the item.
Alarm servers By default
I/O servers By default
Communications By default Any associated boards and ports are selected by default.
node You cannot unselect the item.
IODevices node By default Any associated I/O devices are selected by default.
You cannot unselect the item.
Trend servers By default You cannot unselect the item.
Report servers By default
Clients By default
ServerEvents By default
ClientEvents By default
Executables By default
Executable_n By default You can select each executable and its contents individually.
Selecting an executable automatically selects any associated
mapping.
Service By default Contains data related to the service mapping including any
Mappings required contents in the contents repository.
Communication By default Contains data related to the communication mapping.
Mappings
Built Participant By default Represents the Supervision Participant file (.ctz) (includes the
Project OFS/OPC UA configuration files (.xml)).
It appears and is selected only if its build status is Built or Out
Of Date.

Aborting Export Tasks

After confirming the export by clicking Save in the Export dialog box, the abort icon is displayed in
the notification panel (see page 86). Click the icon to cancel the task. The export file is not created.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are exporting a small project, the task may complete before you are able to click the
icon.

EIO0000001114 06/2020 361

Project Definition Stage

Exporting a Supervision Project

To export a Supervision project to file, proceed as follows.

Step Action
1 In the Supervision Project Browser, right-click the Supervision project that you want to export
and select Export.
Result: The Export window opens and displays the Supervision project that you have selected.
2 Select the project components that you want to export.
3 Click OK.
Result: The Export window clsoes and the Export dialog box opens.
4 Select a location where you want to save the export file, enter a file name, and click Save.
Result: The software creates the export file containing the selected Supervision project
information.
NOTE: If you click Cancel, the the Export dialog box closes without creating the export file and
the selection you have made in the Export window is discarded.

362 EIO0000001114 06/2020

 Project Definition Stage

Importing a Supervision Project

Overview
The Import command lets you import data of a Supervision project from an export file (.sbk), which
was created by using the export (see page 312) functionality of the Project Explorer.
If the system into which you are importing a Supervision project already contains a Supervision
project with the same identifier, the software compares the data of both projects. It then proceeds
with the partial import according to the import settings that you select and the import rules that are
described in this topic.
NOTE: If the export file also contains information of a Control project, you can see the data that is
related to the Control project, and have the choice to import it (see page 316) as well.

Software Version Compatibility

The version of EcoStruxure Process Expert that you use to import the information contained in the
export file must be the same as the version that you used to create the export file (a service pack
is considered the same version); otherwise you cannot proceed with the import.

Import Settings
The table describes which Supervision project information you can import into a system.

Item Selected for Description

import(1)
SupervisionProject_n By default Unselect the item to exclude the entire project from the export file.
Pages node By default You cannot unselect the item.
Pages By default You can select containers (pages) individually(2).
Selecting a page automatically selects any genie facets that are
assigned to it.
Selecting a page automatically selects the logical Participant project.
(1) The information needs to be contained in the export file to be selected
(2) The item is available for selection only if it is tagged with a green dot; otherwise the item cannot be selected.

EIO0000001114 06/2020 363

Project Definition Stage

Item Selected for Description

import(1)
Cluster_n By default At least one cluster must be selected.
You cannot unselect a cluster when the export file contains only one
cluster.
Tags node By default You cannot unselect the item.
Tag containers By default You can select tag containers individually(2).
Selecting a tag container automatically selects any facets that are
assigned to it.
A Constituent File is associated to each tag container.
Tag container By default If the identifier of the imported tag container already exists in the
Constituent File target project, the selection of the constituent file has an impact on
the import behavior (see page 368).
NOTE: The Constituent File check box is selected and disabled if the
identifier of the imported tag container does not exist in the target
project.
Services node By default You cannot unselect the item.
Alarm servers By default
IOServer_n By default
Communications By default Any associated boards and ports are selected by default.
node You cannot unselect the item.
IODevices node By default Any associated I/O devices are selected by default.
You cannot unselect the item.
Trend servers By default You cannot unselect the item.
Report servers By default
Clients By default
ClientEvents By default
ServerEvents By default
Executables By default
(1) The information needs to be contained in the export file to be selected
(2) The item is available for selection only if it is tagged with a green dot; otherwise the item cannot be selected.

364 EIO0000001114 06/2020

 Project Definition Stage

Item Selected for Description

import(1)
Executable_n By default or If the target system already contains an executable with the same
not selectable identifier, you cannot select the executable for import.
Else, you can select each executable and its contents individually.
Selecting an executable automatically selects any associated
mapping.
Service By default or If a service mapping already exists in the target system, you cannot
Mappings not selectable select the service mapping for import.
Contains data related to the service mapping including any required
contents in the content repository.
Communication By default or If a communication mapping already exists in the target system, you
Mappings not selectable cannot select the communication mapping for import.
Contains data related to the communication mapping.
Built Participant By default Represents the built Supervision Participant file (.ctz) (includes the
Project OFS/OPC UA configuration files (.xml)).
It appears and is selected only if the built Participant project was
selected at the time of export.
(1) The information needs to be contained in the export file to be selected
(2) The item is available for selection only if it is tagged with a green dot; otherwise the item cannot be selected.

Import Rules for Included Projects

At the time of import, the software checks whether the content repository of the target system
contains an included project that has the same identifier as the one contained in the export file.
The following figure shows an example of the Resolve Content Conflict dialog box that opens if the
software detects the presence of an included project with the same identifier.

EIO0000001114 06/2020 365

Project Definition Stage

Header Description
Identifier The identifier of the included project for which a conflict exists.
Conflicts The identifier of the Supervision Participant projects that exist in the target system and
use the version of the included project that is in the content repository.
Version in contents By selecting this check box, you use the version of the included project that is in the
repository content repository.
Selected by default.
Version in export By selecting this check box, you use the version of the included project that is contained
file in the export file (see page 374) and overwrite the version that is in the repository.

Included projects contain data related to Supervision constituents (for example, genies, tags, and
so on), which can be shared by several templates.
Replacing the existing included project has an impact on:
 The templates that use the contents of the included project.
 The Supervision Participant projects to which the included project is associated.

NOTICE
LOSS OF DATA
Resolve an included project conflict that arises during the import of a Supervision Participant
project by selecting the correct version of the included project to be imported.
Failure to follow these instructions can result in unusable Supervision projects.

366 EIO0000001114 06/2020

 Project Definition Stage

Import Rules for Project-Related Objects

Facets assigned to Supervision projects are related to instances of the application and mappings
of project executables are related to entities of the topology. For the Supervision project import to
complete entirely, these project-related objects need to be present in the system in which you want
to import the project.
The table describes the impact on the import operation when project-related objects are not
present or have a different configuration. It also describes the corrective action.

Project-related object that is not present Impact if not present in the target system Required action
or different
The instances whose facets are assigned You can import the project but not the tag Do either of the following first to
to the Supervision project that you are and page containers to which such facets create missing instances:
importing (same identifier, template are assigned. This requires that the  Use the export/import
identifier, template version, and status project contains at least one container functionality (see page 255)
Valid). that can be imported (see page 371), of the Application Explorer
even empty. to import missing instances.
A dialog box opens (see page 373)  Create instances. This may
asking you to confirm the partial import. require importing templates
first.
You can obtain information
about the missing instances
and their templates in the tooltip
of the container that is tagged
with a red dot.
An element of the instance creating a The facet that is normally created by this Edit the instance in the
facet that is being imported is not element is not imported. Application Explorer and select
selected. The notification panel provides the corresponding element.
information about the facet that is not
imported.
For example, you import a Supervision
project to which the data facet created by
the Maintenance element of an instance
is assigned but in the application of the
target system, the Maintenance element
of the same instance is not selected.
The properties of an instance are The assignment status of facets that are Generate the project or
different from the instance configuration imported is set to Out Of Date. container to apply the changes.
at the time of export. The difference lies
in the element selection (services) and/or
the parameter values (see page 200).
Topological entities to which you have You can import the project but not the Use the export-import
mapped the executable of the project Supervision project executable and any functionality (see page 610) of
(service and/or communication) that you of its associated mappings. the Topology Explorer first to
are importing (same identifier, same create the missing topological
devices (for example, NIC for a station entities.
node), and services).

EIO0000001114 06/2020 367

Project Definition Stage

Import Rules for Equipment

When you import a Supervision project and a project with the same identifier already exists in the
target system, for an instance that exists in the same cluster in both the imported file and the
Supervision project, the equipment (see page 496) that is already generated in the Supervision
project prevails. This applies independently of the selection of the Constituent File (see page 368)
of the tag container.
Example:

Identifier of instance Equipment name Equipment name generated Equipment in the Participant
present in imported file and generated by the imported by the instance in the project after import
Supervision project instance Supervision project
MyMotor_1(1) Folder_1.MyMotor_1(2) Folder_2.MyMotor_1(2) Folder_2.MyMotor_1

(1) The instance is located in Folder_1.

(2) Facets of the instance are assigned to TagContainer_1 in Cluster_1.

Import Rules for Pages

When you select to import a page that is contained in an export file, and a page with the same
identifier exists in the target system, the contents of the existing page is overwritten with the
content of the page that is in the export file.

Import Rules for Facets

The software applies import rules to facets if the system into which you are importing a Supervision
project already contains a Supervision project with the same identifier.
The following are the general import rules that the software applies if facets with the same identifier
contained in tag containers with the same identifier exist in both the target project and the export
file that you are importing:
 If you select the constituent file of the tag container:
 Facets from the export file overwrite facets of the target system and maintain the state they
have in the export file.
 Facets that exist only in the export file are imported into the target system and maintain the
state they have in the export file.
 Facets that exist only in the target system become Assigned and Non Generated. If the
status of the facet is deleted, unassigned, or unlinked, the software removes the facet from
the tag container after import.
 If you unselect the constituent file of the tag container:
 Facets with the same identifier maintain the state that they have in the target system.
 Facets that exist only in the export file are imported into the target system and become
Assigned and Non Generated.
 Facets that exist only in the target system maintain their state.

368 EIO0000001114 06/2020

 Project Definition Stage

NOTE: The software changes the assignment status of any facet of an instance to Out Of Date if
a property of an instance (see page 200) is different from what it was at the time of export. This
includes the location of the instance in the application. The notification panel provides information
about the change of the assignment status after import is complete.
The following tables illustrate these import rules based on the different use cases. The tag
container and facet names are examples, and represent tag containers and facets in a cluster of
the project.
If you select the tag container Constituent File option.

Contents of export file Item in Supervision Result in Supervision project of target system after
selected for import project of target system import
Tag container identifier is identical
Tag container1 Facet1 Tag container1 – Facet1 from export file with status from export file.
Tag container1 Facet1 Tag container1 Facet1 Facet1 from export file with status from export file.
Tag container1 Facet1 Tag container1 Facet2 Facet1 from export file with status from export file.
Facet2 with status non-generated.
If the status of Facet2 is deleted, unassigned or
unlinked, the facet is removed from the tag container
after import.
Tag container identifier does not exist in target project
Tag container2 Facet3 – – Tag container2 with Facet3 from export file with status
from export file.
– The item does not exist

If you do not select the tag container Constituent File option.

Contents of export file Item in Supervision Result in Supervision project of target system after
selected for import project of target system import
Container identifier is identical
Tag container1 Facet1 Tag container1 – Facet1 from export file with status non-generated.
Tag container1 Facet1 Tag container1 Facet1 Facet1 from target system with same status.
Tag container1 Facet1 Tag container1 Facet2 Facet1 from target system with status non-generated.
Facet2 from target system with same status.
– The item does not exist

EIO0000001114 06/2020 369

Project Definition Stage

Import Rules for Executables and Mappings

The software updates the Build State (see page 695) of a Built executable after import depending
on the scenario.
If the system into which you are importing a Supervision project does not contain a Supervision
project with the same identifier, the state of Built executables that you import changes to Out Of
Date.
If the system into which you are importing a Supervision project already contains a Supervision
project and an executable with the same identifier, the software applies import rules to
executables, service, and communication mappings. These rules are described in the following
tables.
The table illustrates the import rules that apply to a Built executable based on different scenarios.

Contents of export file Item in Supervision project of Resulting built state in Supervision project of
selected for import target system target system after import
Executable1 Does not exist Out Of Date
Executable1 Executable1 Out Of Date
Executable1 Executable2 Executable1: Out Of Date
Executable2: Out Of Date

The table illustrates the import rules that apply to mappings based on different scenarios.

Contents of export file Item in Supervision Result in Supervision project of target system after
selected for import project of target system import
Service mapping Exists Service mapping from target system is not changed.
Does not exist Service mapping is created with the mapping
information from the export file.
Communication mapping Exists Communication mapping from target system is not
changed.
Communication mapping Does not exist Communication mapping is created with the mapping
information from the export file.

Opening the Project Import Window

To open the Import window, proceed as follows.

Step Action
1 Right-click the system root folder in a Project Browser of the Project Explorer and select Import.
Result: The Import dialog box opens.
2 Browse to the export file (.sbk) that contains the project information that you want to import and
click Open.
Result: The Import window opens and displays the contents of the file that you have selected.
NOTE: You can abort the command (see page 373).

370 EIO0000001114 06/2020

 Project Definition Stage

Project Import Window

The Import window lets you select the information of a Supervision project that is contained in an
export file that you want to import into an existing system.
The following figure shows an example of the Import window displaying the contents of a
Supervision project export file. In this example, the check boxes for TagContainer_2 and relate
mappings are cleared because the items cannot be imported. To indicate that at least one item of
the Supervision project is not selected, the check box of parent nodes are filled with a square.

EIO0000001114 06/2020 371

Project Definition Stage

The table indicates the meaning of the colored dots that appear in the Import window next to items
of a Supervision project.

Color code Description

Green You can import the item.
Red  At the container level: The container (for example, the tag container or the page) contains
at least one facet that is referenced by an instance, which is not present in the application
(see page 367).
 At the executable level:
 An executable with the same identifier already exists in the target project.
 A project-related topological object (see page 367) is not present in the target system.
A tooltip provides additional information about the issue.
NOTE: You cannot import items that are tagged with a red dot.
Yellow The item contains at least one subitem that is tagged with a red dot.
The item can be imported partially only.

NOTE: To expand/collapse a node in the Import window, select the node and press Enter.

372 EIO0000001114 06/2020

 Project Definition Stage

Confirmation Dialog Box for Containers That Cannot Be Imported

The following figure shows an example of the dialog box that opens when a container of a
Supervision project selected for import is tagged with a red dot and you click OK in the Import
window. If you are also importing Control projects, containers are grouped by Participant then by
project.

Button Description
Yes Closes the dialog box, the Import window, and imports the selected projects without containers
tagged with a red dot.
No Closes the dialog box and reverts to the Import window without importing projects. You can
modify the selection of projects or cancel the import operation.

Aborting Import Tasks

After confirming the import by clicking OK in the Import window, the abort icon is displayed in the
notification panel (see page 86). Click the icon to cancel the task. The project is not imported.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are importing a small project, the task may complete before you are able to click the
icon.

EIO0000001114 06/2020 373

Project Definition Stage

Importing a Supervision Project

Included projects contain data related to Supervision constituents (for example, genies, tags, and
so on), which can be shared by several templates.
Replacing the existing included project has an impact on:
 The templates that use the contents of the included project.
 The Supervision Participant projects to which the included project is associated.

NOTICE
LOSS OF DATA
Resolve an included project conflict that arises during the import of a Supervision Participant
project by selecting the correct version of the included project to be imported.
Failure to follow these instructions can result in unusable Supervision projects.

To import data of a Supervision project into an existing system, proceed as follows.

Step Action
1 In the Import window (see page 370), select the items that you want to import.
2 Click OK.
Result: The software:
 Applies the import rules based on your import selection.
 If the applicable rules are satisfied, it proceeds with the import; If it detects a conflict with the
name of an included project, it displays the Resolve Content Conflict dialog box
(see page 365).
 Displays a summary of the completed actions and detected incompatibilities in the
Notification Panel.
NOTE: Click Cancel to close the Import window without importing project information.
3 If the software displays the Resolve Content Conflict dialog box, do one of the following:
 Select Version in export file to overwrite the existing included project with the one contained
in the export file that you are importing.
 Select Version in contents repository to keep the existing included project.

Click OK.
Result: The software proceeds according to your selection.
NOTE: Click Cancel to discard your selection in the Resolve Content Conflict dialog box and
revert to the Import window.

374 EIO0000001114 06/2020

 Project Definition Stage

Section 13.7
Participant Project Indicators

Participant Project Indicators

Overview
This topic describes the various indicators that appear on components of Control and Supervision
Participant projects.

What Is in This Section?

This section contains the following topics:
Topic Page
Participant Project Progress Indicators 376
Participant Project Validity Indicators 378
Participant Project Write-Lock Indicator 380
Viewing the Last Action Summary 381

EIO0000001114 06/2020 375

Project Definition Stage

Participant Project Progress Indicators

Overview
Various icons give an indication of the steps that remain before the system engineering life cycle
is completed up to the deployment stage for Control and Supervision projects.
The progress icon is not visible while the checked-out icon (see page 380) is shown.
NOTE: The indicator icons are visible to any user who opens the Participant project.

Meaning of Icons
For Control and Supervision projects.

Icon Condition description

Either one applies:
 0% progress for all project containers.
(0% progress)  At least one facet is candidate (see page 390) for assignment.

The progress of at least one container is not 100%.

Either one applies:

 The progress of all containers is 100% and no executable exists.
 The project progress is 75% and executables are deleted.

The progress of at least one executable is not 100%.

No icon (100% progress) The progress of at least one executable is 100%.

For sections and containers.

Icon Condition description

Either one applies:
 No assignment is done.
(0% progress)  All assignments have been removed.

At least one facet is Non Generated.

At least one facet (see page 480) is Out Of Date, Deleted, UnAssigned, Moved,
Inconsistent, or Invalid and no facet is Non Generated.
All facets are Generated but the analysis detected one or more errors (see page 378).

No icon (100% All facets are Generated or Unlinked without detected errors during analysis.
progress)

376 EIO0000001114 06/2020

 Project Definition Stage

For executables.

Icon Condition description

Either one applies:
 The executable is created.
(0% progress)  Executable progress is 100% and service mapping (see page 623) is removed.

 Control: Service mapping is completed.

 Supervision: Service mapping is done for at least one service.

Or, executable progress is 100% and service mapping is modified.

 Control: At least one communication mapping or hardware mapping is done.
 Supervision: Communication mapping is completed.

And the executable state is Not Built.

The executable state is Out Of Date or Built with alerts (see page 381).

No icon (100% The executable state is Built.

progress)

How Icons Appear

The following figure shows an example of several Control projects and their components that have
various completion states, which are indicated by progress icons.

EIO0000001114 06/2020 377

Project Definition Stage

Participant Project Validity Indicators

Overview
A dot or progress icon (see page 376) that appears in red or yellow color indicates an alert or
detected error (see page 381) during the analysis of components of a Participant project.
When both an alert and the detection of an error occur for the same object, the detected error icon
prevails.
When an icon appears on at least one component of a project (for example, a section, a container,
an executable), it appears automatically at the project level.
The indicator icons are visible to any user who opens the Participant project.
NOTE: The last action summary (see page 381) can help provide information about issues that are
not indicated by validity icons.

Meaning of Icons

Icon color Level Condition description

Yellow Project  Control projects: The analysis (see page 449) of the
(progress icon or dot for project or saving refinement changes (see page 511)
objects with 100% generated an alert indicating that the build operation
progress) may not complete successfully.
Example:  Supervision projects: Saving changes generated an
alert.
 All projects: At least one alert was generated for a
project component.
Section The analysis (see page 449) of the section or saving
refinement changes (see page 511) generated an alert
indicating that the build operation may not complete
successfully.
Tag container or page Generation completed with at least one alert.
Page Saving changes generated at least one alert.
Executable Build completed with at least one alert.

378 EIO0000001114 06/2020

 Project Definition Stage

Icon color Level Condition description

Red Project  Control projects: The analysis (see page 449) of the
(progress icon or dot for project or saving refinement changes (see page 511)
objects with 100% detected an error, which prevents the build operation
progress) from completing successfully.
Example:  Supervision projects: Saving changes detected an
error.
 All projects: There is at least one detected error for a
project component.
Section The analysis (see page 449) of the section or saving
refinement changes (see page 511) detected an error,
which prevents the build operation from completing
successfully.
Tag container or page Generation completed with at least one detected error.
Page Saving changes detected at least one error.
Executable Build did not complete successfully.

How Icons Appear

The following figure shows an example of several Control projects and their components that have
various validity states, which are indicated by the color of the progress icons.

1 Valid project with 50% progress.

2 Project with 25% progress and at least one alert.
3 The detected error at the section level is also shown at the project level.

EIO0000001114 06/2020 379

Project Definition Stage

Participant Project Write-Lock Indicator

Overview
A lock icon lets you see which Participant project components are being used or modified by other
processes or users and that you cannot work on them.

Certain components that are locked can be opened in read-only mode.

NOTE: The indicator icon is visible to any user who opens the Participant project.

Meaning of the Icon

The icon indicates that the project or a component is locked because an operation is in progress,
such as:
(1)
 Assignment
 Generation
 Refinement
 Editing
 Mapping(1)
 Export/import
 Build
(1) The lock icon appears very briefly while an performed is performed.

Where the Icon Appears

The lock icon can appear at the following levels:
 The Participant project
 Sections
 Containers (such as Supervision pages or tag containers)
 Clusters
 Services node and any of its subcomponents (such as servers, I/O devices)
 ClientEvents and ServerEvents nodes
 Executables

380 EIO0000001114 06/2020

 Project Definition Stage

Viewing the Last Action Summary

Overview
The Last Action Summary command lets you view the last action that was performed on a given
Participant project component and a summary of the result. The command is available in the
context menu of projects and their components.
For actions that had not completed successfully or with alerts, and/or detected errors, it shows
again the information that was displayed originally.

Supported Actions
An action summary is available after you perform either action:
 Generation
 Regeneration
 Build

Particular Conditions

Last action performed Result

Not a supported action. The command is unavailable.
A supported action was aborted. An action summary for aborted actions is not available.
The action summary for the previous action remains available (if
applicable).
Import of a Participant project. The command is unavailable.
The action summary that existed at the time of export is cleared.
NOTE: The last action summary of the target project is preserved when
you perform an incremental import. That is, when you import a project into
a system in which a project with the same identifier already exists.

EIO0000001114 06/2020 381

Project Definition Stage

382 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Assignment Stage
EIO0000001114 06/2020

Chapter 14
Assignment Stage

Assignment Stage

Overview
This chapter describes how to create Control and Supervision containers and assign facets of
instances of the application to the corresponding projects that you have created during the Projects
Definition stage.
The following figure shows the position of the Assignment stage within the system engineering life
cycle.

Refer to the Assignment stage (see page 53) for a description of the purpose of this stage.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
14.1 Creating and Managing Sections and Containers 384
14.2 Assigning Facets of Instances 401
14.3 Managing Assigned Facets 435

EIO0000001114 06/2020 383

Assignment Stage

Section 14.1
Creating and Managing Sections and Containers

Creating and Managing Sections and Containers

Overview
This section describes the Assignment Editor and how to use it to create and manage Control
sections and Supervision containers. It also describes section and container context menu
commands and properties.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Assignment Editor 385
Creating Control Project Sections 392
Creating Supervision Tag Containers 394
Creating Supervision Pages 400

384 EIO0000001114 06/2020

 Assignment Stage

Assignment Editor

Overview
The Assignment Editor lets you create and manage Control and Supervision containers and assign
the facets of instances of the application to them.
You can assign by facet, instance, folder, or entire application depending on the extent of the
assignment (see page 391) that you want to perform.
The editor gives you the flexibility to assign manually, automatically, or by combining both
methods.
The following table describes the two methods that you can use to assign facets to Control projects
(see page 419).

Section creation Facet assignment Prerequisite How to use

Automatic, user-defined. Automatic(1), user-defined, Configure assignment Assign objects by dragging
With possibility to: with possibility to preview mechanism them to the project.
 Rename sections assignments (see page 402).
(see page 416) (see page 416).
 Select which sections to
create
Manual Manual Create sections Assign objects by dragging
(see page 392) them to a section.
(1) By default, remaining candidate facets are assigned automatically (see page 425) during generation

The following table describes the two methods that you can use to assign facets to Supervision
projects (see page 421).

Tag container creation Facet assignment Prerequisite How to use

Automatic Automatic with possibility Create additional clusters
(1) Assign objects by dragging
With possibility to: to preview assignments (see page 344) as needed. them to the project.
 Rename tag containers (see page 416).
(see page 416)
 Select the cluster

Manual Manual Create tag containers Assign objects by dragging

(see page 394) in the them to the tag container.
Assignment Editor and
additional clusters
(see page 344) (as needed).
(1) By default, remaining candidate facets are assigned automatically (see page 425) during generation

EIO0000001114 06/2020 385

Assignment Stage

Opening the Assignment Editor

In a Control or Supervision project browser of the Project Explorer, double-click the Containers
node (see page 302) of the project to which you want to assign facets.
NOTE: You can also open the Assignment Editor by using the View Assignments (see page 438)
window.

Assignment Editor
The Assignment Editor for Control and Supervision projects is identical except for the color scheme
of the Containers and Assignments pane:
 Blue: Displays facets, containers, and assignments of Control projects.
 Orange: Displays facets, containers, and assignments of Supervision projects.

The following figure shows an example of the Assignment Editor for Control projects.

The following figure shows an example of the Assignment Editor for Supervision projects. The
Instances and Facets panes are minimized to a tab by unpinning the Instances pane.

386 EIO0000001114 06/2020

 Assignment Stage

1 Instances pane. Shows the compatible instances of the application that have a valid Data and
Link status.
2 Facets pane. Shows Participant-specific facets, which are referenced by the items that are
selected in the Instances pane. The pane is empty by default. Supervision genie facets are not
displayed.
3 Containers pane. Shows the project and its sections or containers. This pane is used to select
the target to which you want to assign facets.
4 Assignments pane. Shows facets that are assigned to the project or container that is selected
in the Containers pane. The title bar of the pane is where you drag objects to assign them.
5 You can select which columns (see page 389) you want to see in each pane.
6 Button to toggle between grid and tree view in the Instances pane.
7 Button to show or hide facets (see page 390) in the Facets pane. The Instances pane must be
pinned.
8 Button to toggle between grid and tree view in the Containers pane (see page 389).
9 Button to show or hide (see page 127) the Instances and Facets panes.
10 Button to extract or retract the Instances pane.
11 Project node, which gives you access to project-level context menu commands.
The following tables describe the information that appears in the panes of the Assignment Editor.
Instances pane.

Column Description
header
Instance Identifier of the instance.
Template Identifier of the template that the instance is using.
Version Version of the template that the instance is using.
Assigned Assigned At least one Control or Supervision facet of the instance is assigned to a project of
State the system.
Unassigned No facet of the instance is assigned to any project of the system.
Path Path to the instance in the tree view of the Application Browser.
The column appears only if you have selected the grid view display mode.
Candidate Provides information about the assignment of facets at the instance level:
 Done: The facets of the instance are already assigned to this project.
 Candidate: The instance contains at least one facet that is not yet assigned to this project.

Description Contents of the $Description parameter of the instance.

EIO0000001114 06/2020 387

Assignment Stage

Facets pane.

Column Description
header
Instance Identifier of the instance that references the facet.
Instance Identifier of the template that the instance that references the facet is using.
Template
Facet Identifier of the facet.
Facet Identifier of the template that the facet is using.
Template
Path Path to the facet as it is shown in the Assignment Viewer (see page 438).
System Indicates the assignment(1) status of the facet at the system level:
 Assigned: The facet is already assigned to a project of the system.
 Not assigned: The facet is not yet assigned to a project of the system.

Project Indicates the assignment status of the facet at the project level:
 Candidate: You have not yet assigned the facet to this project.
 Done: You have already assigned the facet(1).

Type Provides information on the subtype of the facet.

1 Generating the section that contains the facet may change this status depending on the actions that you
have executed on the facet (for example, unassigning it after a first generation). The Assignment column
of the Assignments pane provides you with a more detailed information on the assignment status of the
facet.

Containers pane.

Column Description
header
Path For a Control project, indicates whether the section belongs to the MAST or FAST task folder.
For a Supervision project, indicates to which cluster the container belongs.
Container Shows the identifier of the project and the sections or containers that it contains.
An icon indicates the language of a section or the type of container.
NOTE: Although Supervision pages appear, you cannot assign genie facets (see page 543)
to them by using the Assignment Editor.
Order For Control projects, indicates the order in which the software generates the sections.
You can change the order of sections (see page 311).
For more detailed information on how the software manages the section order, refer to the
generation process description (see page 452).
NOTE: The order is not shown in tree view mode.

For a description of the Assignments pane, refer to the topic Assigned Facet Description
(see page 423).

388 EIO0000001114 06/2020

 Assignment Stage

Customizing Column Display

In the various panes of the editor, you can choose which columns you want to see by right-clicking
a column header and selecting Customize. Certain columns are always shown.
When you hide a column for which a filter is applied, the filter is cleared.
If tree and grid view are available, you may be able to configure the column display independently
in each view.

Displaying Sections in Tree View Mode

The tree view mode allows you to view sections to which facets are assigned in relation to the folder
structure of the application.
For more details, refer to the topic describing the representation of the application structure in
Control projects (see page 429).
The figure shows an example of the Containers pane in tree view mode once facets have been
assigned to some FBD sections.

item Description
1 System root folder and subfolders representing the folder structure of the application.
NOTE: Predefined folder icons (see page 193) that you may have assigned in the application
to various folder levels are not represented.
2 Section identifier.
3 Special root folders.

EIO0000001114 06/2020 389

Assignment Stage

Viewing Instances with Facets That Can Be Assigned

To view the instances of the entire application, which have facets that can be assigned to the
project, proceed as follows.

Step Action
1 Switch to grid view mode by clicking the button in the Instances pane.
2 Click the button to show the candidate column in the Instances pane.
Result: The Instances pane displays the instances of the entire application.
Those that have a status of Candidate in the Candidate column have facets that can be assigned
to this project.

NOTE: Use the instance progress icons (see page 213) to see which instances have facets that
need to be assigned.

Viewing Facets That Can Be Assigned

To view the facets of the entire application that can be assigned to the project, proceed as follows.

Step Action
1 Switch to tree view mode by clicking the button in the Instances pane.
2 In the Instances pane, select the system root folder.
3 Click the button to show facets in the Instances pane.
Result: The Facets pane displays the facets of the entire application.
Those that have a status of Candidate in the Project column can be assigned to this project.

NOTE:
 To view only the facets with status Candidate, use the filter on the Project column.
 To narrow the display to part of the application, select an application folder instead of the system
root folder.

390 EIO0000001114 06/2020

 Assignment Stage

Object Selection
The following table describes the scope of the assignment depending on the objects that you drag
from the Instances or Facets pane of either Assignment Editor. Each editor assigns only
Participant-specific facets.

Object Resulting assignment

One or more facets of the same or These facets only.
several instances. Remaining facets are assigned automatically (see page 425).
One or more instances. The facets of all the selected instances.
One or more folders. The facets of all the instances that are contained in the selected folders.
By dragging the system root folder, you can assign facets of the entire
application at once.

NOTE: If the facet that you are trying to assign is not compatible with the selected container, you
cannot create the assignment and a tooltip indicates it. If you are trying to assign multiple items at
once and some of them are not compatible, the assignment is created for the compatible ones and
information about the other ones is displayed in the notification panel.

EIO0000001114 06/2020 391

Assignment Stage

Creating Control Project Sections

Overview
In the Assignment Editor, you can create only FBD sections in a Control Participant project.
This topic describes how to create sections manually. Sections can also be created automatically
(see page 402).
To create non-FBD sections, refer to the topic describing the Project Explorer.

Creating FBD Sections

To create an FBD section in the Assignment Editor, proceed as follows.

Step Action
1 Right-click the identifier of the Control project in the Containers pane and select Create FBD
Section.
Result: The Create FBD Section dialog box opens.
2 Edit the identifier (see page 393) of the section if required, select the MAST or FAST task folder,
and click OK.
Result: A new FBD section is created with the next available order value (see page 311).

Inserting FBD Sections

To insert an FBD section, proceed as follows.

Step Action
1 In the Containers pane of the Assignment Editor, right-click the section where you want to insert
the new one and select Insert FBD Section.
Result: The Insert FBD Section dialog box opens.
2 Edit the identifier (see page 393) of the section and click OK.
Result: The newly created section is inserted and has the order (see page 311) of the section
that you had right-clicked. The order of the section that you right-clicked and those that follow is
incremented by 1.

Section Actions
The table describes the context menu commands of sections.

Command Description
Insert FBD Creates a new FBD section (see page 392) at the position of this section.
Section
Generate Refer to Generation Stage (see page 443).
The command is only available for FBD sections.
Refine Refer to Refinement Stage (see page 506).
The command is not available for LL984 sections.

392 EIO0000001114 06/2020

 Assignment Stage

Command Description
ReGenerate Refer to Generation Stage (see page 493).
The command is only available for FBD sections.
Delete Deletes the section.
If you have assigned (see page 384) facets to the section, the software:
 Unassigns (see page 436) any facets contained in the FBD section that you are deleting.
 Change the System status (see page 481) of the facets to Not assigned.

NOTE: If the FBD section has been generated, deleting it also removes from the logical
Control Participant project the section and constituents that were generated by the facets
assigned to the section (for example, variables).
However, derived types that were generated by these facets are not removed (for example,
DFBs and DDTs). To remove these, you can either:
 Regenerate (see page 493) the Control project. This discards refinements.
 Purge the types from the Control Participant during refinement. For details, refer to Purge
of Unused Instances in the Control Participant help.
Rename Lets you edit the identifier (see page 393) of the section.
Properties Opens the Properties window of the section.

Section Properties
To open the Properties window of a section, right-click the section and select Properties.
You can edit the following items.

Item Description
General Identifier Depending on how you create the section, the default identifier can be either:
 FBDSection_n if you create the FBD section manually, using the Create FBD
Section command, where n is an incremental number starting at 1.
 The concatenation of instance identifier_instance template identifier if the
software creates the section automatically during assignment.
NOTE: For identifiers of Schneider Electric templates, the $ prefix is omitted.
The identifier must be unique within the Control project.
The software allows only the use of identifiers that satisfy the naming rules
(see page 99).
Description Optional.
You can enter a description of the section with free form text.
Generated Date and time of the last successful generation or regeneration of the section.
On The property is read-only and contains information only for FBD sections.

EIO0000001114 06/2020 393

Assignment Stage

Creating Supervision Tag Containers

Overview
This topic describes how to create tag containers manually by using the Assignment Editor, their
properties, and context menu commands. The software creates tag containers automatically when
you assign facets (see page 385).
You need to create, at least, one tag container per controller to assign Supervision data facets of
instances of the application.
These data facets represent the tags that are managed by Supervision components and assigned
to the I/O device variables to be associated to the Supervision Participant project:
 Variable tags
 Trend tags
 Alarm tags

Monitoring data of a device (see page 920) communicating by using the Modbus TCP protocol (or
Modbus through an Ethernet gateway) from the Supervision infrastructure requires creating, in
addition, one tag container for each device. Supervision Data facets representing device-specific
data are assigned to each container. Also, a specific communication protocol needs to be defined
for these tag containers.

Creating Tag Containers

To create a tag container in the Assignment Editor, proceed as follows.

Step Action
1 Right-click the identifier of the Supervision project in the Containers pane and select Create Tag
Container.
Result: The Create Tag Container dialog box opens.
2 Edit the identifier (see page 396) of the tag container if required, select an existing cluster, and
click OK.
Result: A new tag container is created.

394 EIO0000001114 06/2020

 Assignment Stage

Using a User-Defined Protocol

When you enter a protocol in the Protocol parameter of the tag container (see page 396) instead
of selecting a predefined one, verify the following:
 The protocol is supported by the platform of the controller that is the data source of the variable
tags; otherwise, the variables cannot be read and/or written to by Supervision software.
 It is supported by the Supervision Participant and installed; otherwise, you cannot build the
Supervision executable.
To verify which protocols are installed in the Supervision Participant, refine the Supervision
Participant project and expand an entry in the Protocol column of I/O Devices in the Topology
activity.
If the protocol is not installed, contact EcoStruxure Process Expert support.
When using a user-defined protocol, some data generated at the template level, such as variable
tag addresses may not be in the required protocol-specific format depending on the template
configuration. After generating the Supervision Participant project, refine it and edit the data as
needed. No configuration file (.xml) is generated when you build the Supervision Participant
project.
NOTE: For communication with the I/O server, ensure that the protocol of the communication
board (see page 352) is correctly configured.

Tag Container Actions

The table describes the tag container context menu commands.

Command Description
Create Tag Lets you create a new tag container in an existing cluster.
Container
Generate Starts the generation process to populate new tags, update out-of-date tags, and/or
(see page 483) remove deleted tags in the Supervision Participant project.
Delete Deletes the tag container.
If you have assigned facets to the container, the software:
 Unassigns the facets contained in the container that you are deleting.
 Changes the system status of the facets to Not assigned.

NOTE: The software does not delete the servers that it may have created during the
assignment of Supervision facets.
NOTE: If the container has been generated, deleting it also deletes the data in the logical
Participant project when you generate the project again.
Rename Lets you enter a new identifier for the tag container.
Properties Opens the Properties window, which allows you to edit the properties of the tag container.

EIO0000001114 06/2020 395

Assignment Stage

Tag Container Properties

To open the Properties window of the tag container, right-click the container and select Properties.
You can edit the following items.

Item Description
General Identifier The identifier must be unique within the Supervision project.
Default value: TagContainer_n where n is an incremental number starting
at 1.
NOTE:
When Protocol for the tag container is set to OPCUA, the identifier is used
as follows:
 During generation, it becomes part of the variable tag address in the
Supervision Participant project. The format of the address is
ns=2;s=0:<tag container ID>!<variable name>, where ns
indicates the namespace and 2 corresponds to the OPC UA server as
defined by Schneider Electric.
For example, ns=2;s=0:Controller1!InputVar1
 During build, it becomes the alias for the device in the OFS
configuration file (see page 704).
Therefore, it may be useful to rename the tag container with the identifier
of the controller that is mapped to the associated I/O device
(see page 682).
Description Optional.
You can enter a description of the container with free text.
Generated On Date and time of the last successful generation of the tag container (read-
only).
(1) The parameter becomes read-only when Protocol is different than OFSOPC or OPC UA.

396 EIO0000001114 06/2020

 Assignment Stage

Item Description
Attributes ScanTime The acquisition time for the tags that are assigned to the container.
msec
Default value: 0
Protocol The protocol that is used for communication with the I/O device.
The menu contains the following values:
 OFSOPC (default)
 OPCUA
 OPCUA Embedded: When the OPC UA server is embedded in a
module (see EcoStruxure™ Process Expert, Control Participant
Services, User Guide) of the controller. Sets the protocol of the
associated I/O device to OPCUA in the Supervision Participant project.
 User-defined protocol (see page 395) whose name can be entered by
using free-form text. 16 characters maximum. Values entered are
added to the menu.
When you instantiate Schneider Electric templates and assign their
Supervision facets to the Supervision project, only OFSOPC. OPCUA, and
OPCUA Embedded are supported. This is because, by default, the facets
generate Supervision data (variables and tags) that is specific to these
protocols. To use another protocol, you can add the protocol-specific
Supervision data to the project either by instantiating and configuring the
$VariableTag_CD template or by refining the Supervision project.
NOTE: For each additional tag container that you create to monitor data
of a device directly from the Supervision runtime, change the value to OPC.
For information on the corresponding driver, refer to the driver help. To
locate driver help files, look up Driver Reference Help in the help of the
Supervision Participant (see page 104)
(1) The parameter becomes read-only when Protocol is different than OFSOPC or OPC UA.

EIO0000001114 06/2020 397

Assignment Stage

Item Description
Attributes Direct TCP IP Sets the addressing mode for the TCP IP driver in the OFS/OPC UA
Addressing configuration file. Select the mode depending on the Modbus TCP
Mode(1) topological entity (see page 682) that is mapped to the associated I/O
device in the Communication Mapping tab.
The parameter is disabled when Protocol for the tag container is set to
OPCUA Embedded.
Possible values:
 Unallocated/Allocated Data, PAC Modicon (/U) (default): Corresponds
to selecting UNITY / Control Expert in the PLCs section of the
Device address wizard in the OFS/OPC UA configuration tool. Use this
setting when mapping a controller or station node.
 Allocated Data, Offset 0 (/T): Corresponds to selecting PL7 in the PLCs
section.
 Allocated Data, Offset 0 with minimum communication (/NT):
Corresponds to selecting PL7 in the PLCs section and Minimum
communication profile.
 Allocated Data, Offset 1 (/Q): Corresponds to selecting CONCEPT in the
PLCs section.
 Allocated Data, Offset 1 with 32 bits swapping (/QW): Corresponds to
selecting CONCEPT in the PLCs section and Swap 32-bit Values.
 Allocated Data, Offset 1 (/NQ): Corresponds to selecting MODBUS
Device in the PLCs section.
The value is available only when Protocol is set to OPCUA.
NOTE: The value shown in brackets corresponds to the suffix that is
appended to the device address in the configuration file.
For more information, refer to:
 Editing the Device Network Address in the help of OPC Factory Server
(see page 115).
 Managing Device Aliases in the help of OPC UA Server Expert.

Attributes Supports Corresponds to the Modbus Request Optimization parameter of

Optimized Communication Settings in the OFS configuration tool.
Modbus Possible values:
Frames(1)  Off (default): The check box of the parameter is cleared.
 On: The check box of the parameter is selected.

The parameter is not available for the OPCUA protocol.

NOTE: Because in OFS, this parameter applies to all aliases of the OFS
configuration file, if you configure several tag containers in a Supervision
project and for one of them you select Off, the check box of the parameter
in the OFS configuration file is cleared, overriding the On setting that you
may have configured for any other tag container.
(1) The parameter becomes read-only when Protocol is different than OFSOPC or OPC UA.

398 EIO0000001114 06/2020

 Assignment Stage

Item Description
Relationships IoDevices Select the I/O device that you want to associate with the container.
The I/O device appears in the menu once you have created it or assigned
facets.
Default value: IODevice_1
NOTE:
 By default, the software associates the tag container with the I/O device
that it automatically creates when you assign Supervision facets to the
container (see page 421). If you create the I/O device manually
(see page 348), associate it with the tag container before or after
assigning facets.
 Changing the relationship after assigning facets to the tag container
changes their assignment status to Out Of Date.
(1) The parameter becomes read-only when Protocol is different than OFSOPC or OPC UA.

EIO0000001114 06/2020 399

Assignment Stage

Creating Supervision Pages

Prerequisites
Generate the Supervision project before creating pages.

Creating Supervision Pages

To create a page in the Assignment Editor, proceed as follows.

Step Action
1 Right-click the identifier of the Supervision project in the Containers pane and select Create Page.
Result: A new page is created.

Supervision Page Actions

The table describes the page context menu commands.

Command Description
Create Page Lets you create a new Supervision page.
Edit Opens the Supervision Participant, which allows you to assign to the page animated
(see page 544) graphics that are associated with the instances of the Supervision project. It also allows you
to add graphic elements to the page to represent process hardware.
Generate Starts the generation process to update out-of-date genies, and/or remove deleted genies
(see page 483) in the Supervision Participant project.
Delete Deletes the page including assignments of animated graphics.
Rename Lets you enter a new identifier for the page.
Properties Opens the Properties window, which allows you to edit the properties of the page.

Supervision Page Properties

To access the Properties window of the Supervision page, right-click the page and select
Properties.
You can edit the following items.

Item Description
General Identifier The identifier must be unique within the Supervision project.
The software allows only the use of identifiers that satisfy the naming rules
(see page 99).
Description Optional.
You can enter a description of the page with free form text.
Generated On Date and time of the last successful generation of the page (read-only).

400 EIO0000001114 06/2020

 Assignment Stage

Section 14.2
Assigning Facets of Instances

Assigning Facets of Instances

Overview
This section describes how to use the Assignment Editor to assign facets of instances to their
respective Control and Supervision containers. It also details the information that the software
provides on the resulting assignments.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Defining the Control Facet Assignment Mechanism 402
Previewing Facets Assignments 416
Assigning Control Facets of Instances 419
Assigning Supervision Facets of Instances 421
Assigned Facet Description 423
Automatic Facet Assignment 425
Viewing the Application Structure in Control Projects 429

EIO0000001114 06/2020 401

Assignment Stage

Defining the Control Facet Assignment Mechanism

Overview
The Container Naming Rules window allows up to four expressions and lets you use either one to
define the assignment mechanism of Control facets, which includes:
 The name of sections that are automatically created when you assign facets.
 Which facets are assigned to which section.

Expressions are project-specific.

By default, one preconfigured expression (see page 406) is selected in each project.
The expression is applied when you drag instances or folders containing instances to the Control
project in the Assignment Editor.
If the resulting container identifier does not satisfy applicable naming rules, it is indicated
(see page 418).
NOTE: You can preview and modify (see page 416) the result or override the mechanism by
assigning facets to an existing section.

Opening the Container Naming Rules Window

To open the Container Naming Rules window, select Settings in the context menu (see page 305)
of the Control project.

402 EIO0000001114 06/2020

 Assignment Stage

Container Naming Rules Window Description

The following example shows the Container Naming Rules window for a new Control project with
its two preconfigured expressions of which the first one is selected.

Item Description
1 Preconfigured expression (see page 406) (read-only). Select the expression to use it to create
sections and assign facets.
You can copy expressions (see page 407) and edit the name and description of expressions that you
add.
2 To create the expression, you can configure up to six tokens. To create the section identifiers, the
software concatenates the values that it has calculated for each of the configured tokens.
The tokens that you include in the expression have an impact on the number of sections
(see page 405) that are created.
The available tokens are:
 Alias Hierarchy: Corresponds to the alias of the folder (see page 188).
 Folder Hierarchy: Corresponds to the identifiers of folders that make up the path of the instance.
 Free Text: Free-form text that you can enter. It lets you add a fixed value to all sections that are
created or insert a separator. Underscore is the only special character that is allowed.
 Instance ID: Corresponds to the identifier of the instance (see page 195).
 Template ID: Corresponds to the identifier of the template (see page 195) that is used by the
instance.

EIO0000001114 06/2020 403

Assignment Stage

Item Description
3 For Alias Hierarchy and Folder Hierarchy, you can select which levels in the path of the instance to
consider.
0 corresponds to the folder that contains the instance. 1 corresponds to its parent folder, and so on.
N corresponds to the highest folder in the structure. The system root folder is excluded (except for
instances that have the system root folder as direct parent).
Maximum value: 99
Example:
For an instance located in System_1\Site_1(S1)\Area_1(A1)\Cell_1(C1)\Unit_1(U1)
(where the value in parentheses represents the folder alias):
 0 = Unit_1 (or its alias, U1)
 1 = Cell_1 (or its alias, C1)
 2 = Area_1 (or its alias, A1)
 N = Site_1 (or its alias, S1)

Configuring the value as 1 to 2 for each token generates the following result:
 For Folder Hierarchy: Cell_1Area_1
 For Alias Hierarchy: C1A1

4 Optionally, you can define up to two conditions (see page 407) for each token (except for the first and
last token, which support only one condition each).
The following conditions are available:
 Condition 1:
 Remove if previous token resolved value is empty
 Remove if all previous tokens resolved value is empty
 Remove if previous token resolved value is NOT empty
 Remove if all previous tokens resolved value is NOT empty

 Condition 2:
 Remove if next token resolved value is empty
 Remove if all next tokens resolved value is empty
 Remove if next token resolved value is NOT empty
 Remove if all next tokens resolved value is NOT empty

5 Buttons to add and remove tokens in an expression.

6 Lets you simulate the resulting section identifier by using the expression that is configured based on a
sample folder structure and instance identifier if you were to assign any part of this sample hierarchy
to the Control project in the Assignment Editor.
To refresh the result after modifying the expression, click the button again.
7 Pane showing the sample folder structure and the resulting section identifier.
Values in bracket represent the alias of the folder and the identifier of the template.
8 Lets you add a custom expression.
You can add up to two expressions but only one expression can be selected at a time.
9 You can delete expressions that you have added.

404 EIO0000001114 06/2020

 Assignment Stage

Item Description
10 When selected, opens the Assignment Viewer window (see page 416) only if the assignment creates
at least one new section based on the selected expression.
11 Additional preconfigured expression (see page 406) (read-only).
12 User-created expression that can be configured and selected.

Container Creation Principle

The table describes the number of sections (see page 412) that are created depending on the
token that the expression contains. When several tokens are included, the one with the lowest
granularity determines the number of sections. Tokens are listed in increasing order of granularity.

Token Number of sections created

Instance ID As many sections as there are instances in the object that you are dragging.
Folder Hierarchy (1) As many sections as there are folders containing instances in the object that you are
dragging (when Value = 0 to N).
This token lets you assign facets of instances located in several folders of a same
level (see page 413) to one section.

Alias Hierarchy(1) As many sections as there are folders that have an alias and that contain instances
(instances of subfolders included) in the object that you are dragging.
This token lets you assign facets of instances located in several folders of different
levels (see page 414) to one section.
Template ID As many sections as there are templates used by instances in the object that you
are dragging.
This token lets you assign facets of several instances that use the same template
(see page 410) to one section.
(1) The value that you configure impacts the number of sections that are created and the section identifier

NOTE: The conditions (see page 407) that are configured may impact the results.

EIO0000001114 06/2020 405

Assignment Stage

Preconfigured Expressions
The following preconfigured expressions exist and are read-only. The section identifier that they
create is composed of three parts where each part is the result of a calculated token.
To use a different expression, create one and select it.
For new Control projects:
The expression creates a section for each folder containing instances.
Example:
Alias1Alias2Alias3_Folder3Folder4
The table describes how the tokens of the expression are used to calculate the different parts of
the section identifier.

Token Value Result

Alias Hierarchy From 1 to N Concatenation of the folder aliases from the highest level
folder down to the level-1 folder in the path of the instance.
Free Text _ (underscore) An underscore.
NOTE: The condition removes the underscore if no aliases
have been configured because a section identifier cannot start
with an underscore.
Folder Hierarchy From 0 to 1 Concatenation of the identifiers of the level-1 and level-0
folders in the path of the instance starting with the level-1
folder.

For new and migrated Control projects:

The expression creates a section for each instance. The section identifier is the same as the one
that was automatically created when assigning facets by using earlier versions of the software.
It is selected by default for migrated projects.
Example:
MyMotor_1_Motor
The table describes how the tokens of the expression are used to calculate the different parts of
the section identifier.

Token Value Result

Instance ID n/a The identifier of the instance.
Free Text _ (underscore) An underscore.
Template ID n/a The identifier of the template that is used by the instance (without
$ prefix).

406 EIO0000001114 06/2020

 Assignment Stage

Using Conditions in Expressions

You can use conditions to modify container identifiers. Conditions remove a token from an
expression based on the value of one or all previous tokens and/or the value of one or all following
tokens.
It lets you, for example, show the folder identifier instead of the folder alias in case no alias is
defined.
Example of condition based on previous token:
You have configured an expression as <token1><token2><token3> and an underscore is
defined as free text for token2.
If the value for token1 is blank, the resulting container identifier starts with an underscore. To
avoid that, you can configure the condition Remove if previous token resolved value is empty for
token2. The container identifier is then only token3.
Example of condition based on next token:
You have configured an expression as <token1><token2><token3> and Section_A is
defined as free text for token1. However, you want this text to appear only when token2 and
token3 contain no value.
You can configure the condition Remove if all next tokens resolved value is not empty for token1
to achieve this.

Copying Expressions
You can copy expressions to paste them in the same window or in the window of another project.

Step Action
1 Right-click the header of the expression and select Copy.
2 Right-click the empty space below an expression and select Paste.
Result: The expression is added to the Container Naming Rules window.
NOTE: You can only paste as many expressions as is allowed to remain within the limit of
expressions per project.

EIO0000001114 06/2020 407

Assignment Stage

Sample Application for Examples

The following figure shows the sample application that is used in the following examples. In each
one, Area is dragged to the Control project in the Assignment Editor

Example With Instance ID Token

Only Instance ID is configured as token without conditions.

408 EIO0000001114 06/2020

 Assignment Stage

After dragging Area, one section for each instance is proposed. The section identifier is the
instance identifier.

Example With Folder Hierarchy and instance ID Tokens

Folder Hierarchy is added to Instance ID as tokens with an underscore as separator. No conditions.

EIO0000001114 06/2020 409

Assignment Stage

Compared to the previous example (see page 408), the number of sections remains the same.
Only the identifier of the sections is changed by adding the identifier of the folder containing the
instance (level 0) and its parent (level 1) as prefix.

Example With Template ID Token

Instance Motor_1 that is using template $Motor is added to the application so that two instances
of the same template exist.

410 EIO0000001114 06/2020

 Assignment Stage

Only Template ID is configured as token without conditions.

One section for each template that is used in the application is proposed. The section identifier is
the template identifier (without $ character).

EIO0000001114 06/2020 411

Assignment Stage

Example With Template ID and Alias Hierarchy Tokens

Alias Hierarchy is added to Template ID as tokens with an underscore as separator. No conditions.

Compared to the previous example (see page 410), one section has been added because the two
instances of template $Motor are located in folders that have a different alias. The section
identifier is the template identifier with the aliases of Cell1 and Area added as prefix.

NOTE: The same number of folders would have been created if Folder Hierarchy had been
selected as token instead of Alias Hierarchy.

412 EIO0000001114 06/2020

 Assignment Stage

Example to Group Facets of Instances Located in Several Folders of Same Level

This example illustrates how to use the Folder Hierarchy token to assign to one section the facets
of instances located in folders of a same level in the application (Cell1 and Cell2). The following
figure shows the sample application that is used.

Folder Hierarchy is configured as token with value 1 to 1. Because the value represents the parent
folder, it creates a section for each folder that contains instances by using the identifier of its parent.
When two folders have the same parent, only one section is created. No conditions.

EIO0000001114 06/2020 413

Assignment Stage

After dragging Area to the Control project, two sections are proposed. Section Area contains the
facets of A1HandValve_1 and A1Motor_1 because it is the parent of Cell1 and Cell2.

NOTE: If the section identifier is not satisfactory, you can edit it in-place (see page 418) or add a
Free Text token to the expression.

Example to Group Facets of Instances Located in Several Folders of Different Levels

This example illustrates how to use the Alias Hierarchy token to assign to one section the facets
of instances located in folders of different levels in the application (Area and Cell1). The following
figure shows the sample application that is used.

414 EIO0000001114 06/2020

 Assignment Stage

Alias Hierarchy is configured as token with value 0 to 1. This creates a section for each folder that
has an alias and contains instances. No conditions.

After dragging Area to the Control project, one section is proposed, which contains the facets of
the three instances of the application. Cell1 contains instances but has no alias. Area contains
an instance and has an alias. Thus, its alias is used to create the section identifier to which facets
of A1Valve_1 are assigned. Facets of any instances contained in subfolders (Cell1) are
assigned there as well.

NOTE: If the section identifier is not satisfactory, you can edit it in-place (see page 418) or add a
Free Text token to the expression.

EIO0000001114 06/2020 415

Assignment Stage

Previewing Facets Assignments

Overview
The Assignment Viewer opens when you drag one or more facets to a project in the Assignment
Editor.
It does not open if you drag facets to a container that you have created manually.
The window lets you:
 For Control projects, preview the identifier of newly created sections, which is the result of the
expression that you have selected (see page 402).
 Preview which facets will be assigned to which container.
 Edit the identifier (see page 418) of containers in-place.
 Select in which task folder or cluster to create new containers.
 Select which assignments to perform.

NOTE: For Control projects, you can configure it (see page 403) to open only if the facets that you
are assigning create a new section.

Assignment Viewer Description

The following figure shows an example of the Assignment Viewer when you drag the top level
folder of a folder structure containing two instances(1) to a Control project while the default
expression (see page 406) for a new project is selected.

416 EIO0000001114 06/2020

 Assignment Stage

The following figure shows an example of the Assignment Viewer when you drag the top level
folder of a folder structure containing two instances(1) to a Supervision project.

Item
1 Shows the identifier of the containers to which the facets of the instances that you have dragged will
be assigned. For each container, shows the identifier of the instances whose facets will be
assigned.
By default, the order of containers and instances corresponds to the hierarchy of the application.
For Control projects, the number of sections and their identifier depends on the expression that is
selected (see page 402) and the object that you have dragged (for example, an instance, a folder,
or a folder structure).
For Supervision projects, one tag container is created each time you drag an object to the project
independently of the number of instances inside the object.
You can edit the identifier of new sections.
2 Identifiers of the facets that will be assigned to the container.
3 Indicates whether the container already exists in the project or if it will be created.
4 Indicates or, for new containers, lets you select:
 For Control projects: The task folder of the section.
 For Supervision projects: The cluster of the container.

5 Check box to select all the containers that appear in the window.
6 Select the check box to create the container (if new) and assign the facets.
Containers whose check box is cleared are ignored.
7 For Control projects, indicates the name of the expression (see page 403) that is selected.

EIO0000001114 06/2020 417

Assignment Stage

(1) The following figure shows the application that was used for the two Assignment Viewer
examples.

Editing Container Identifiers

You can edit the identifier of new containers only.
By editing the identifier of a container so that it is the same as an existing container or another
container that is proposed in the Assignment Viewer, you can assign the facets of both to a single
container.

Container Identifier Validation

Either of the following dots can appear on the container icon:
 A red dot to indicate that the container identifier that is the result of the expression is blank.
 A yellow dot to indicate that the container identifier has been modified to satisfy applicable
naming rules (see page 98) (for example, maximum length or allowed characters).

Modifying the Application While the Assignment Viewer is Open

If the application is modified while the Assignment Viewer is open and the changes impact any
result of the expression that is selected, the information in the window is not updated. Also, when
you proceed with the assignments, they are performed based on the information that is displayed
in the window.

418 EIO0000001114 06/2020

 Assignment Stage

Assigning Control Facets of Instances

Before Starting
To assign Control facets of instances, you must have completed:
 The Instantiation stage (see page 171)
 The Control Project Definition stage (see page 304)

You can only assign facets of instances that have a valid Data and Link status (see page 195).
You can assign facets only to FBD sections.
You cannot assign the same facet to more than one FBD section in the same project but you can
assign the same facet to several Control Participant projects of the system.

Facet Assignment Order

Depending on the method that you use to select instances for assignment, the order of the
referenced facets varies. The following applies when you assign all facets to the same FBD
section.

Assignment method Facet order

Instance by instance The order in which you drag instances to assign them defines the order of the
referenced facets. Instances selected first for assignment have facets with the
lowest order.
Multiple instances at once The order in which you select instances defines the order of the referenced
facets. Instances selected first have facets with the lowest order.
By folder The order of instantiation defines the order of the referenced facets. Instances
created first have facets with the lowest order.
Multiple folders at once The order in which you select folders defines the order of the referenced facets.
Folders selected first have facets with the lowest order.
If the folders contain multiple instances, the order in which instances where
created is not relevant anymore.

NOTE: You can change the order of facets (see page 440).

EIO0000001114 06/2020 419

Assignment Stage

Assigning Facets
This procedure describes how to assign facets of instances to sections of the Control project by
using an expression (see page 402).

Step Action Result

1 Verify that the instances are displayed in tree The Assignment Editor displays the valid
view mode in the Instances pane, else click (see page 195) instances of the application in tree
the toggle button (see page 386). view mode.
NOTE: Alternatively, you can assign
instances using the grid view mode. The
assignment principle remains unchanged.
You can switch between views at any time
during assignment by clicking the toggle
button.
2 Configure the expression depending on the –
assignment mechanism that you want to use
and select it.
3 In the Containers pane, select the Control  The name of the project appears in the title bar of
project. the Assignments pane.
 Any existing sections and the facets already
assigned to them are displayed.
4 From the Instances pane, drag one or more The Assignment Viewer window (see page 416)
objects (see page 391) to the title bar of the opens.
Assignments pane.
NOTE: Alternatively, you can drag objects
directly to project in the Containers pane.
5 Review the information that is displayed, edit –
section identifiers as needed, and select the
task folder for each section.
6 Click OK.  Sections that do not exist yet are created after
existing sections.
 The Control facets that have a status of Candidate
are assigned to the respective FBD sections and
displayed in the Assignments pane.
 The software assigns an order (see page 423) to
each assigned facet.
 The status of the assigned facets in the System
column of the Facets pane changes to Assigned if
the status was Not assigned.
 The status in the Project column of the Facets
pane changes from Candidate to Done.

NOTE: By default, remaining facets will be assigned automatically (see page 425) when you
generate the project or a section.

420 EIO0000001114 06/2020

 Assignment Stage

Assigning Supervision Facets of Instances

Before Starting
To assign Supervision data facets of instances, you must have completed:
 The Instantiation stage (see page 171)
 The Supervision Project Definition stage (see page 337)

You can only assign facets of instances that have a valid Data and Link status (see page 195).
You cannot assign the same facet to more than one tag container in the same project but you can
assign the same facet to several Supervision projects of the system.
NOTE: To assign Supervision genies facets to a page (see page 400), refine the Supervision
project.

Automatic Supervision Project Component Creation

Each time you drag an object from the Instances pane to the Supervision project, one tag container
is created (see page 416).
In addition, depending on the facets that you assign to the tag container, the software may
automatically create and configure the following components under the Services node
(see page 341) of the Supervision project cluster:
 One I/O server including:
 One I/O device
 One communication board and its port

 One alarm and/or one trend server (if facets that create alarm and/or trend tags have been
assigned).
NOTE: The I/O server and its components are created only for the first tag container of a cluster
whether you create the tag container manually or if the software creates it automatically during the
assignment. The other servers are created also when you assign corresponding facets to
additional tag containers.

EIO0000001114 06/2020 421

Assignment Stage

Assigning Facets
This procedure describes how to assign data facets of instances to a Supervision project.

Step Action Result

1 Verify that the instances are displayed in The Assignment Editor displays the valid
tree view mode in the Instances pane, (see page 195) instances of the application in tree view
else click the toggle button mode.
(see page 386).
NOTE: Alternatively, you can assign
instances using the grid view mode. The
assignment principle remains
unchanged. You can switch between
views at any time during assignment by
clicking the toggle button.
2 In the Containers pane, select the  The name of the project appears in the title bar of the
Supervision. Assignments pane.
 Any existing containers and the facets already
assigned to them are displayed.
3 From the Instances pane, drag one or The Assignment Viewer window (see page 416) opens.
more objects (see page 391) to the title
bar of the Assignments pane.
NOTE: Alternatively, you can drag
objects directly to the project in the
Containers pane.
4 Review the information that is displayed, –
edit the container identifier as needed,
and select the cluster.
5 Click OK.  Containers that do not exist yet are created.
 Supervision data facets that have a status of
Candidate are assigned to the respective container
and displayed in the Assignments pane.
 The status of the assigned facets in the System
column of the Facets pane changes to Assigned if
the status was Not assigned.
 The status in the Project column of the Facets pane
changes from Candidate to Done.

NOTE: If an instance contains a facet of type ClientEvent or ServerEvent, the software

assigns the facet to the ClientEvents and ServerEvents container (see page 342) respectively.
NOTE: By default, remaining facets will be assigned automatically (see page 425) when you
generate the project or a section.

422 EIO0000001114 06/2020

 Assignment Stage

Assigned Facet Description

Facet Description
The Assignments pane (see page 386) of the Assignment Editor provides information on the facets
that are assigned to an FBD section or tag container.
To see a list of facets that are assigned to a project, select the project in the Containers pane.
The following information is displayed in the Assignments pane.

Column Description
header
Container Identifier of the section/container to which the facet is assigned.
Instance Identifier of the instance that references the facet.
Instance Identifier of the template that the instance is using.
Template
State State of the facet in the context of the instance.
Possible values:
 Valid
 Invalid (see page 205)
 Deleted: The section is generated (see page 443) and you have unselected the
corresponding element of the instance in the Instance Editor or deleted the instance itself.
Facet Unique identifier of the facet.
Facet Identifier of the template that the facet is using.
Template
Path Path to the facet in the composition of the instance (see page 200).
Order This column applies to Control projects only.
Indicates the order in which the software generates constituents of the facets inside the section
and as such, the order in which the Control Participant executes the constituents inside the
section.
You can change the order of facets (see page 440) inside a section.
The software applies the order only during:
 A first generation (see page 449)
 A regeneration (see page 493)

For more detailed information on how the software manages the facet order, refer to the
description of the generation functionality (see page 452).
Assignment Indicates the status of the facet in relation to the instance that references the facet.
Possible values:
 Assigned
 Unassigned
 Out Of Date
 Deleted

Refer to Assignment Status of Generated Facets (see page 481) for a description of the
assignment status.

EIO0000001114 06/2020 423

Assignment Stage

Column Description
header
Generation Indicates the status of the facet in relation to the generation of its constituents in the logical
Participant project.
Possible values:
 Non Generated
 Generated
 Moved
 Inconsistent
 Unlinked

Refer to Generation Status of Facets (see page 480) for a description of the generation status.

Changing the Element Selection of Instances After Assignment

If you change the Control or Supervision element selection of an instance in the Instance Editor
window after assigning facets of the instance (before generating), the changes are reflected in the
respective Assignment Editor.
The table describes how the changes to the element selection of an instance are reflected in the
Assignment Editor.

When you... Then...

Select a new The corresponding facets are added to the existing facets of the instance and you can
element of an display them in the Facets pane of the Assignment Editor. Proceed with the assignment
instance as described in the assignment procedure.
Unselect an The corresponding facets are removed from the list of facets in the Facets pane of the
element of an Assignment Editor.
instance If you had already assigned the facets, then they are also removed from the corresponding
container.

NOTE: Changes impacting the assignment status of facets that you have generated are described
in Assignment Status of Generated Facets (see page 481).

424 EIO0000001114 06/2020

 Assignment Stage

Automatic Facet Assignment

Overview
The Project Explorer features a functionality that allows you to assign remaining Control and
Supervision candidate facets of instances, which have at least one facet that is already assigned
to a Participant project. The assignment is done automatically by the software when you select a
generation command (see page 446). The container to which these facets are assigned depends
on where the other facets of the instance are already assigned.
There can be candidate facets remaining because you have:
 Not assigned all the facets to a Participant project yet.
 Unassigned facets.
 Changed the element selection of the instance (see page 206) after assignment, which has
created new facets.
Information on facets that the software has assigned automatically is displayed in the notification
panel.
NOTE: Automatic assignment does not apply to Supervision genie facets.

Using and Disabling the Functionality

The functionality is enabled by default and remains enabled until you disable it in the settings of a
Control project (see page 308) or Supervision project (see page 339).
Assignment is triggered (see page 446) when you use any generation command at the project or
project container level.
NOTE: You can still assign facets manually while the functionality is enabled.

EIO0000001114 06/2020 425

Assignment Stage

Automatic Assignment Criteria

The table describes how the software assigns remaining candidate facets of an instance,
depending on where other facets of the instance are already assigned.

Candidate Facets of same instance are Facets of same instance are already assigned to several
facet type already assigned to one container containers
Control Candidate facets are assigned to Candidate facets are assigned to the FBD section to
facet the same FBD section. which other facets of the instance are already assigned
and that has the lowest Order number.
Supervision Candidate facets are assigned to  Supervision project with one cluster: Candidate facets
facet the same tag container. are assigned to the tag container that was created first.
 Supervision project with several clusters: Candidate
facets are assigned to each cluster. In each cluster,
candidate facets are assigned to the tag container that
was created first.

NOTE: Only facets that are available are assigned. If a facet is locked, for example, because the
instance referencing it is open in the Instance Editor, it remains unassigned.

Viewing Assignments
To verify to which container facets of an instance are assigned, use the View Assignments
(see page 438) window.

426 EIO0000001114 06/2020

 Assignment Stage

Examples
In this example, three facets of instance Motor_1 are already assigned to section
FBDSection_1. A modification of the element selection of Motor_1 has created facet
Motor_1_DEVMNT, which is candidate to be assigned. The software assigns Motor_1_DEVMNT
automatically to section FBDSection_1 when you generate the project. (Information has been
highlighted in yellow for this example.)

EIO0000001114 06/2020 427

Assignment Stage

In this example, three facets of instance Motor_1 have been assigned to section FBDSection_1.
The section was generated and the three facets unassigned. Thereafter, modification of the
element selection of Motor_1 has created facet Motor_1_DEVMNT, which is candidate to be
assigned. The software assigns Motor_1_DEVMNT automatically to section FBDSection_1 when
you generate the project again while the three unassigned facets are removed from it. (Information
has been highlighted in yellow for this example.)

428 EIO0000001114 06/2020

 Assignment Stage

Viewing the Application Structure in Control Projects

Overview
Switching to tree view mode in the Containers pane (see page 386) of the Assignment Editor
allows you to view FBD sections based on the location of instances whose Control facets are
assigned to these sections.
It shows the relationship between the folder structure of the application and the sections of a
Control Participant project. This is useful, for example, when you want to view the logic related to
a specific area or subdivision of the application or verify that the Control facets of a group of
instances are assigned to the right sections of a project.
Any FBD section to which a Control facet is assigned appears in the tree view. A section can
appear several times depending on the facets it contains.
Independently of where and how many times an FBD section appears, its contents, which is visible
in the Assignments pane, is the same.
Changing the application folder structure, the location of instances, facet assignments, and/or the
status of facets has an impact on the position of sections in the tree view.
Empty FBD sections and non-FBD sections are shown as well.
NOTE: You can view the application structure also when refining Control Participant projects
(see page 510) and making changes online (see page 818).

EIO0000001114 06/2020 429

Assignment Stage

Root Folder Description

In tree view mode, up to three root folders can appear in the Containers pane.

Root folder identifier Description

<system identifier> (for The <system identifier> (for example, System_1) root folder is the parent
example, System_1) folder for the application structure. This structure contains sections to which
facets with the following status are assigned:
 Assigned
 Out Of Date
 UnAssigned
 Non Generated
 Generated
 Moved
 Inconsistent

EmptyContainers Parent folder for sections to which no facet is assigned because you have
performed one or more actions such as:
 Created the section manually.
 Unassigned all non-generated facets from the section. If the facets were
already generated, you have unassigned all facets and generated the
section.
 Disabled a service, which removed the corresponding non-generated
facet. If the facet was already generated, you have disabled the service
and generated the section.
 Deleted any instance referencing a non-generated facet assigned to the
section. If the facets were already generated, you have deleted the
instances and generated the section.
 Moved all facets to another section.
 The section is a non-FBD section.

DeletedFacetContainers Parent folder for sections to which at least one facet is assigned with the
status Deleted.
If the section contains at least one facet with another status, the section also
appears under the <system identifier> root folder.
Once you generate the section and the Deleted facet is removed from the
section, the section appears only under either of the two other root folders
depending on the facets that are assigned to it.
No application folders are shown under this root folder.

NOTE: A root folder appears only if there is a section in its folder structure. For example, if there
is no empty section, the EmptyContainers root folder is not shown.

430 EIO0000001114 06/2020

 Assignment Stage

Relation Between Folder Structure and FBD Sections

A folder structure can contain several sections if facets referenced by instances in that folder
structure are assigned to multiple sections.
A section can be shown multiple times under different folder structures if the facets assigned to this
section are referenced from instances located in various folders.
In this example, the application contains three folders. The Control facets referenced by each
instance are assigned to separate FBD sections. Folder_2 is empty.

The following is an extract of the Assignment Editor, which shows the corresponding FBD sections
in the Containers pane of the Control project in grid view mode. The project node is not shown.

EIO0000001114 06/2020 431

Assignment Stage

The following figures show how the FBD sections are displayed in relation to the folder structure
of the application in the Containers pane in tree view mode.

If during assignment, you had assigned one facet of instance Valve_1 also to section
Motor_20_Motor, this section would appear twice. Under Folder_20 because of facets of
instance Motor_20 and under Folder_1 because of the facet of Valve_1. The following figure
shows this.

432 EIO0000001114 06/2020

 Assignment Stage

Impact of Changes in the Application on the Tree View

In tree view mode, changes to the application are reflected.
Changes that you make to the folder structure of the application are reflected in folder structure
shown in the Containers pane.
Changes that you make to the location of instances whose facets are assigned to sections are
reflected in the position of these sections in the Containers pane.
Based on the application of the previous example, if you create Folder_3 and move instance
AnalogInput_1 to this folder, the tree view is modified as shown in the figure.

If you delete instance AnalogInput_1 and its facets were generated, the status of the facets
changes to deleted. When this happens, section AnalogInput_1_AnalogInput appears under
the DeletedFacetContainers root folder as shown in the figure.

NOTE: Folder_3 is empty and therefore it does not appear in the Containers pane.

EIO0000001114 06/2020 433

Assignment Stage

Impact of Changes to Assignments on the Tree View

Changes that you make to the assignment of facets are reflected in the position of sections in the
Containers pane.
If without changing the application, you move a facet of the Valve_1 instance to the
Motor_20_Motor section, the section appears also under Folder_1 because the instance is
located in Folder_1.

If you had generated section AnalogInput_1_AnalogInput, delete the instance, and generate
the section again, the Deleted facets are removed from the section and the empty section now
appears under the EmptyContainers root folder. The result is shown in the following figure.

434 EIO0000001114 06/2020

 Assignment Stage

Section 14.3
Managing Assigned Facets

Managing Assigned Facets

Overview
This section describes the actions that you can perform on assigned facets by using the Project
Explorer and the Application Explorer.
It also describes how to access containers to which facets are assigned and how to open the
Assignment Editor from facets that you have not yet assigned to a project.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Facet Actions After Assignment 436
Viewing Facet Assignments 438
Order of Control Facets 440
Navigating from Facets to the Instance 441

EIO0000001114 06/2020 435

Assignment Stage

Facet Actions After Assignment

Overview
This topic applies to facets that are assigned but not yet generated.
For information on facets that are generated, refer to the topic describing management of
generated facets (see page 501).

Commands and Actions

Once you have assigned Control or Supervision data facets of instances to the respective project,
you can execute the following commands and actions on these facets from the Assignments pane
of the Assignment Editor.

Command/Action Description
Unassign Removes the facet from the section or container.
You cannot unassign facets that have the Assignment status of deleted.
Refer to Unassigning Facets (see page 436).
NOTE: The actions that the software executes when you select the Unassign
command for a non-generated facet is different than if you execute the command on a
generated facet (see page 503).
Go To Instance Shows the instance that references the facet in the Application Explorer.
The navigation feature is not available if the Assignment status of the facet is deleted.
Refer to the topic describing how to navigate from facets to the instance (see page 441).
Move the facet Changes the assignment of a facet to another FBD section or tag container. Does not
apply to genie facets (see page 544).
Refer to Moving Facets (see page 437).

NOTE: The Reassign (see page 503) and Unlink (see page 503) commands that you can access
from the facet context menu become available only once you have completed the generation
stage.

Unassigning Facets
To unassign a non-generated facet from a section or container, proceed as follows.

Step Action Result

1 In the Assignments pane of The facet is removed from the Assignments pane and:
the Assignment Editor, right-  The status of the unassigned facet displayed in the System
click the facet and select column in the Facets pane changes from Assigned to Not
Unassign. assigned if the facet is not assigned to any other project of the
system.
NOTE: You can select
 The status of the Project column changes from Done to
multiple facets to unassign
them at once. Candidate.

436 EIO0000001114 06/2020

 Assignment Stage

Moving Facets
To move a non-generated facet from one FBD section/tag container to another, proceed as follows.

Step Action Result

1 In the Assignments pane of the -
Assignment Editor, right-click any one
of the column headers to clear filters
and sorting (see page 138).
2 Drag the facet to another FBD section  The facet is removed from its original container and
of the same task folder or tag assigned to the target one.
container that is shown in the  The assignment status of the facet is unchanged.
Containers pane.
NOTE: You can select multiple
facets to move them at once.

NOTE: Control facets that you move are assigned to the new section with the highest order value
in the Order column of the Assignments pane (see page 386). When you move several facets at
once, the facet that you have selected first gets the lowest order out of the ones that are moved.

EIO0000001114 06/2020 437

Assignment Stage

Viewing Facet Assignments

Overview
By opening the View Assignments window for any instance of the application, you can verify if
Control facets and Supervision (data and genie) facets are assigned to a project of the system.
For each facet, you can:
 If the facet is not yet assigned: Open the corresponding Assignment Editor (see page 386) for
existing projects of the system. For genie facets, you can open the Pages container of existing
Supervision projects.
 If the facet is already assigned: Open each container to which it is assigned and locate the facet.

Opening the View Assignments Window

In the Application Browser pane (see page 175), right-click an instance and select View
Assignments.
NOTE:
You cannot open the View Assignments window if both conditions are true for the instance:
 Assigned status is Unassigned.
 Data or Link status is Invalid.

View Assignments Window

The following figure shows an example of the View Assignments window for instance MyMotor_1,
whose Control and Supervision data facets are assigned but not its genie facets.

438 EIO0000001114 06/2020

 Assignment Stage

Item Description
1 Displays the elements of the selected instance grouped by Participant.
For each Participant, elements are grouped by one or more levels of categories. For example,
category Control and subcategory Interlocks contain element Logic.
2 Indicates the subtype of the facet.
3 Identifier of the facet that corresponds to the element.
4 Identifier of the template that the facet is using.
5 Facet assignment status.
Possible values:
 Unassigned: The facet is not yet assigned to any project of the system.
 Assigned: The facet is assigned to, at least, one project of the system.

6 For Control facets, the following information is displayed:

 For unassigned facets: A list of existing Control projects in the system to which you can
assign the facet.
Click a project in the list to open its Assignment Editor.
 For assigned facets: The list of sections to which the facet is assigned.
Section identifiers are shown in the format: ProjectIdentifier.SectionIdentifier.
Click a section to show or open the Assignment Editor. The section and facet are highlighted.
NOTE: For unassigned facets, if no Control project exists in the system, the column is empty.
6 For Supervision data and genie facets, the following information is displayed:
 For unassigned facets: A list of existing Supervision projects in the system to which you can
assign the facet.
Click a project in the list to open its Assignment Editor.
 For assigned facets: The list of containers to which the facet is assigned.
Container identifiers are shown in the following format format:
 For data facets:
ProjectIdentifier.ClusterIdentifier.ContainerIdentifier.
 For genie facets: ProjectIdentifier.PageIdentifier.

Click a container to show or open the Assignment Editor. The container and facet are
highlighted.
NOTE: For unassigned facets, if no Supervision project exists in the system, the column is
empty.
7 Elements of the instance, which generate a facet and that are shown when you open the
Instance Editor.
8 Elements of the instance, which generate a facet and that are shown when you inspect the
instance (see page 236).

NOTE: The View Assignments window is closed automatically when you navigate to the
Assignment Editor.

EIO0000001114 06/2020 439

Assignment Stage

Order of Control Facets

Overview
The software assigns an order (see page 423) to facets that you assign to an FBD section, starting
at 0, and displays it in the Assignments pane. The values appear in the Order column.
The order corresponds to the execution order of the constituents of the facet by the Control
Participant inside the section after you generate the section.
You can change the order of facets inside an FBD section.
The software applies the default order or changes to this order only until the first generation
(see page 452) of the section. After you have generated the section a first time, you can still
change the order of facets inside the section. However, the change has no effect on the order of
already generated facet constituents if you generate the section again. You need to regenerate
(see page 493) the section for the software to apply the new facet order.

Changing the Facet Order

To change the order of Control facets inside an FBD section, proceed as follows.

Step Action
1 In the Containers pane, select the FBD section that contains the facets that you want to rank.
Result: The facets that are assigned to the selected FBD section appear in the Assignments
pane.
2 In the Assignments pane, right-click any one of the column headers and clear filters and sorting
(see page 138).
Result: The facets are displayed in increasing order from top to bottom.
3 Drag a facet up or down to a new position until you see a tooltip, which indicates the position that
the facet will occupy when you release the mouse button.
Result: The facet appears in the selected position with a new order value.

NOTE: To change the execution order of the FBD sections, refer to the topic describing how to
change the order of sections (see page 311).

440 EIO0000001114 06/2020

 Assignment Stage

Navigating from Facets to the Instance

Overview
From a facet that is shown in the Assignments pane of the Assignment Editor, you can open the
Application Explorer to show the instance that references this facet.
The navigation feature is available for:
 Control facets.
 Supervision data and genie facets.

Conditions Impacting Navigation to the Instance

The table describes the scenarios where navigation to the instance is limited or not possible.

Condition Result
The Assignment status of its facet is The Go To Instance command is not available.
Deleted.
The instance is not shown in the Application The Application Explorer opens or is shown but a dialog box
Browser because a filter (see page 138) is informs you that the instance is not visible.
applied.
The Application Browser pane is minimized The Application Browser pane remains minimized or in the
or in the background (if tabbed). background.
If the instance is open in the Instance Editor, the corresponding
tab is shown.

Navigating to the Instance

To navigate from a facet assigned to a project container to the instance that references this facet,
proceed as follows.

Step Action
1 Rick-click the facet and select Go To Instance.
Result: The software:
 Opens the Application Explorer window if it is not yet open. If it is, the window is shown.
 Expands the application folder containing the instance.
 Selects the instance that references the facet.

EIO0000001114 06/2020 441

Assignment Stage

442 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Generation Stage
EIO0000001114 06/2020

Chapter 15
Generation Stage

Generation Stage

Overview
This chapter describes how to create the logical Control and Supervision Participant projects of the
system.
The following figure shows the position of the Generation stage within the system engineering life
cycle.

Refer to the Generation stage (see page 55) for a description of the purpose of this stage.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
15.1 General Description 444
15.2 Generating a Project for the First Time 483
15.3 Generating Projects After Changes 487
15.4 Generating Equipment in Supervision Projects 496
15.5 Generation Diagnostic Messages 499
15.6 Managing Generated Facets 501

EIO0000001114 06/2020 443

Generation Stage

Section 15.1
General Description

General Description

Overview
This section gives a general description of the generation process of Control and Supervision
Participant projects.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Generation Process Description 445
Control Project Specifics 449
Selecting Versions of Types in Control Facets During Generation 456
Statuses of Facets 480

444 EIO0000001114 06/2020

 Generation Stage

Generation Process Description

Overview
Once you have assigned Control and/or Supervision facets to the containers of their respective
projects, you need to generate these projects.
During the system engineering life cycle, the generation process of Participant projects can
encompass up to three steps:
 A first-time generation (see page 483).
 A generation after changes (see page 487).
 A Control Participant project regeneration (see page 493).

You can generate the entire projects or parts of it.

The generation process creates the logical Participant project.
For Control projects the generation process:
 Creates the derived function blocks (DFBs) and variables based on the constituents that are
encapsulated inside the facets according to the assignment of the facets in the structure of the
project and their properties (see page 200).
 Creates links between function blocks generated from different facets, which are assigned to
the same FBD section (see page 450). In addition to links that are defined at the template level,
links created in the Links Editor are processed.
For Supervision projects, the generation process populates the native Supervision Participant
database files for:
 Tags from Supervision data facets.
 Report events from Supervision server event facets.
 Events from Supervision client event facets.
 Supervision project components.
 User interface messages.
 Equipment (see page 496).

NOTE: You can abort the generation of projects (see page 484) and their containers
(see page 485) as well as the regeneration (see page 494).

EIO0000001114 06/2020 445

Generation Stage

Data Validation Before Generating

When you select the Generate or ReGenerate command for a project or a container, the software
first verifies if the constituents of the assigned facets satisfy the applicable naming rules
(see page 98).
The software behaves as follows when it detects that the applicable naming rules are not satisfied:
 For Control facets, it does not generate containers nor constituents in the logical Participant
project even those that satisfy the naming rules.
Refer also to the topic describing the impact of detected errors on generation (see page 450).
 For Supervision facets, it generates only the constituents that satisfy the applicable naming
rules.
 For both facet types, it displays a diagnostic message, which contains the identifiers of the
containers, assigned facets, and their parameter values that do not satisfy a naming rule.

Generating Facets of the Same Instance Assigned to Several Projects

You can generate several projects simultaneously even when facets of the same instance are
assigned to these project.
The projects can be Control and/or Supervision projects.

Generating Automatically Assigned Facets

By default, the software assigns candidate facets automatically (see page 425) when you select
any generation command at the project or project container level.
If among the instances whose facets are already assigned to the Participant project, at least one
facet remains with the status Candidate, the software opens a dialog box to remind you that the
functionality is enabled before executing the command. You have the possibility to cancel
generation and disable the automatic assignment of these facets.
If the software is not able to proceed with the automatic assignment of a facet, generation of
assigned facets completes but the notification panel displays information on the facets that it could
not assign and generate.
If generation does not complete successfully, facets that the software has assigned automatically
are unassigned.
NOTE: Generation takes a little longer to complete when the functionality is enabled.

446 EIO0000001114 06/2020

 Generation Stage

Generating During Build Stage

To save time or if you have made minor changes to a logical Participant project, instead of using
the Generate command, you can use the Generate and Build command from the Control
executable (see page 625) or Supervision executable (see page 678) context menu. This
performs a generation followed by a build. You need to have completed the system engineering
life cycle up to the build stage.
If you generate a complete Participant project and generation of any section (see page 450) or
generation of any container does not complete, build is not started. Information about the
sections/containers that were not generated is displayed in the notification panel.
If build is not started or does not complete successfully, the result of the generation process is the
same as if you had selected the Generate command for the Participant project. This means, for
example, that for a Control Participant project, sections that were successfully generated remain
generated.
The Generate and Build command:
 Cannot be used to perform a regeneration (see page 493).
 Can be used together with the automatic facet assignment functionality (see page 425).
 Automatically performs a Build or Build All command (see page 687) depending on the type of
change that you have made to the Participant project.
NOTE: After selecting the command, the abort icon is displayed in the notification panel
(see page 86). Click the icon to cancel the task. Only the user who has selected the command is
allowed to abort it.
If you cancel the task:
 Before generation completes, the entire generation task is canceled and no sections are
generated. Build does not start.
 After generation completes, only the build task is canceled and the software displays a
notification to inform you.
If you are generating and building a small project, the whole task may complete before you are able
to click the icon.

Generating Facets with State Invalid

If the State of a facet (see page 423) has become Invalid after you have assigned it, generating
the container or Participant project removes the facet from the container.
This can be the case, for example, when you link instances A and B (where instance A needs to
be linked to be valid), assign their facets to a Control project, and then delete the link between the
two instances. The facet of instance A becomes invalid because the instance is not linked
anymore.
Generating the section to which the invalid facet is assigned removes it from the section.

EIO0000001114 06/2020 447

Generation Stage

Skipping Facets During Generation

If a facet is locked, the constituents that it encapsulates cannot be generated. In such case, the
locked facets are skipped but generation of the section or the Participant project completes for the
other facets. This may happen, for example, when an instance is open in the Instance Editor.
The generation status of a facet that is skipped does not change.
The notification panel contains information about locked facets that the software could not
generate.

448 EIO0000001114 06/2020

 Generation Stage

Control Project Specifics

Overview
This topic describes the default behavior when generating Control Participant projects and the
settings that you can configure to customize the generation process.

Identifying Code Generated by Control Facets

Constituents that are generated from facets assigned to Control projects are locked in the Control
Participant project. The locked code is color coded in the DFB editor of the Control Participant
when you refine the project (see page 514).

Validity Indicators
When you execute any generation command on a logical Control Participant project or any of its
containers (including the Generate and Build command) and project analysis is enabled
(see page 308), the software performs an analysis.
If the result of the analysis raises and alert or detects an error, the software displays a validity icon
(see page 378).
In such case, refine (see page 507) the Control Participant project, identify, and fix the issue. When
you save your refinement changes, the software performs a new analysis. The result is shown in
the Analyze Project tab of the Control Participant window.
NOTE: It is possible that the software detects inconsistencies that are linked to the default
configuration in the Control Participant, which is part of every logical Control project but that is not
relevant in the context of the Project Explorer. These detected errors do not affect the capability to
build the project successfully if you configure the topological entities correctly in the Topological
Explorer.
This can be the case, for example, when the application contains an instance of a communication
port template, which requires that you enter a %MW holding register starting address. During
generation, this address is checked against the default address in the CPU of the default
configuration. If both addresses are not consistent, a validity icon is displayed. But when you build
the logical Control Participant project, this address is checked against the address that you
configure in the CPU of the entity in the Topological Explorer, which needs to be consistent.
It can also happen because the logical Control Participant project is missing IODDT variables (for
example, when the configuration contains HART modules (see page 591)) or Device DDT
variables (see page 813), which exist only in the configuration project until you perform the build
or you create them (see page 517).
If fixing the inconsistency requires that you change a value in the CPU of the default configuration,
you still have to verify that the value in the CPU is configured correctly in the Topological Explorer
by using the Configure command for the entity to which the Control Participant project will be
mapped.

EIO0000001114 06/2020 449

Generation Stage

Generating Graphical Links

Inside the same FBD section, the software generates graphical links between function blocks that
use the same variable and that are encapsulated inside different facets only if the following
conditions are satisfied:
 The variable is created by a facet (not created manually by the user).
 The resulting link:
 Links the output pin and input pin of separate function blocks.
 Is not a circular link.

The software breaks any graphical circular link and creates it as variable link.

Impact of Detected Errors or User Action During Generation

When you select the Generate or Generate and Build command for a project containing several
sections and the software detects an error, the impact on the generation process depends on the
detected error or the user action that is performed.
NOTE: The behavior is the same when you regenerate (see page 493) a Control Participant
project.

Detected error or user action Impact on the generation process

Variable name conflict (1) Generation stops. Code of sections that have been
successfully generated remains in the logical Control
Type version conflict(1) Participant project.
Naming rule conflict (see page 98) The section which contains the detected error and any
subsequent sections are not generated.
Clicking Cancel in the Type Version Conflict
A summary dialog box indicates the identifier of the section
dialog box (see page 456).
where generation stopped as well as the reason.
Operation in the Control Participant did not
succeed (for example, injecting data in a
section through import).
.NET exception occurred (for example, an
Object reference not set diagnostic
message is shown).
Section overcrowded(1) Generation completes but any overcrowded section is not
generated.
Details are provided in the summary dialog box.
(1) Refer to the topic describing diagnostic messages (see page 499).

450 EIO0000001114 06/2020

 Generation Stage

In the following example, ControlProject_2, which consists of four sections is being generated
for the first time but the software stops the generation process because of a variable name conflict
in FBDSection_3 (the section name is highlighted for the purpose of the example). As a result,
FBDSection_1 and FBDSection_2 are generated in the logical Control Participant project.
FBDSection_3 is not generated because it contains the conflicting variable and FBDSection_4
is not either because it is generated only once generation of FBDSection_3 completes

NOTE: If you had selected the Generate and Build command, build would not start because at least
one section did not generate.

EIO0000001114 06/2020 451

Generation Stage

Control Project Section Size

During generation, FBD sections are created in the Control Participant project with a maximum
initial size of 360 rows x 240 columns. You can modify this size (see page 454).
If additional space is required to fit the function blocks that are generated from the facets assigned
to a section, the software adapts the section size by:
 Deleting empty columns on the outer right of the section to add rows at the bottom of the section.
 Deleting empty rows at the bottom of the section to add columns on the outer right of the section.

The software displays a message to inform you of the change in section size.
If you want to reserve some space in the section, you can insert a comment box on the right-hand
side of the section and/or at the bottom of the section so that the software does not delete the rows
that are left and/or above the comment box when resizing the section.
When the space requirements of the function blocks exceed the maximum section size, the
software displays a diagnostic message (see page 499).
NOTE: The section resizing process applies to a first generation, subsequent generations, and
regenerations.

Execution Order and Function Block Layout

When you generate a Control project for the first time, the software processes the facets that you
have assigned to the project and that have an Assignment status (see page 423) of Assigned. It
takes into consideration the order of sections (see page 311) at the project level and the order of
facets (see page 423) at the section level.
Refer also to the topic giving an example of section layout management (see EcoStruxure™
Process Expert, Control Participant Services, User Guide).
The table describes the process that the software applies during a first generation to manage the
order of sections and facets, and the position of function blocks inside a section.

Stage Description
1 The software detects the order (see page 386) of the project sections and processes the
sections starting with the one ranked 0; then the section ranked 1; and so on, until it has
processed the sections of the entire project.
2 For each section, the software detects the order (see page 423) of the first facet of each instance
that is assigned to the section.

452 EIO0000001114 06/2020

 Generation Stage

Stage Description
3 The software generates the function blocks encapsulated in the facets according to the order
that it has detected in stage 2, starting with the facet ranked 0. However, the software groups
the function blocks according to the layout (see page 932) of the composite referencing the
facets.
For example, if a section contains two instances, Instance1 and Instance2, referencing three and
one facets respectively, and ordered as follows:
Facet1_Instance1 - Order 0
Facet1_Instance2 - Order 1
Facet2_Instance1 - Order 2
Facet3_Instance1 - Order 3
The software generates Facet1_Instance1 before Facet1_Instance2 but groups function blocks
of facets 1, 2 and 3 of Instance1 at the top of the section to respect the layout of the composite
template used by Instance1.
Therefore, function blocks of Facet1_Instance2 are placed at the end in spite of the order of the
facet, which is 1.
4 If a function block is generated in a position that is already occupied by another function block,
creating an overlap, the function block generated last is moved to the end of the section content.
The block keeps its horizontal position (X axis) as defined by the layout of them template
referencing it.
In such case, the software displays a message advising you about the change in position and a
possible change in the execution order.

Facet Status After Unsuccessful Generation

The table describes the effect on the status of Control facets when the generation of a section or
any facet is not successful.

Generated component Facet status

Entire Control project The generation status of facets assigned to the entire
project reverts to the value it was before generating.
Control project section The generation status of facets assigned to the
section reverts to the value it was before generating.

Removing Types from the Logical Control Participant Project

Types generated from Control facets remain in the logical Control Participant project even when
you unassign generated facets (see page 501) encapsulating them, delete (see page 481) the
facets by deleting the instance, or delete the section (see page 392) to which these facets were
assigned.
To remove these types, you can either:
 Regenerate (see page 493) the Control Participant project. This discards refinements you have
made.
 Purge the types from the Control Participant during refinement. For details, refer to Purge of
Unused Instances in the Control Participant help.

EIO0000001114 06/2020 453

Generation Stage

Configurable Generation Settings

By editing the GenerationSettings.xml file, you can customize the behavior of the generation
process of Control Participant projects.
The file is located on the computer on which the system server is installed at the path
C:\Program Files\Schneider Electric\EcoStruxure\Process Expert\System Server.
You need to have administrator rights to be able to edit this file.
NOTE: Changes to the file are applied only after a system server restart (see page 80).
You can configure the following parameters.

Parameter name Default Description

value
ReGenerateNonFbdSections True True = The behavior during a regeneration is the following:
 Non-FBD sections that were created during refinement and
their contents are retained.
 Refinements that are made in FBD sections to which facets
are assigned are discarded.
 Refinements made in FBD sections that were created in the
Projects Explorer are retained if no facets have been
assigned to these sections.
False = The behavior during a regeneration is the following:
 Non-FBD sections that were created during refinement and
their contents are discarded.
 Refinements that are made in FBD sections are discarded
whether facets have been assigned to them or not.
UnityProIgnoreFbdComments True True = Comments of FBD sections are not generated.
UnityProMinSpaceTop 0 Minimum space that the software leaves above function blocks
that are positioned at the top of the section.
UnityProMinSpaceLeft 10 Minimum space that the software leaves at the left of any
function block that it generates.
UnityProMinDistanceX 5 Minimum space that the software leaves between two
consecutive function blocks along the x axis.
UnityProMinDistanceY 2 Minimum space that the software leaves between two
consecutive function blocks along the y axis.
UnityProUseEffectiveSize False True = The minimum space around function blocks is
decreased to help utilize the space of the section more
effectively.

454 EIO0000001114 06/2020

 Generation Stage

Parameter name Default Description

value
UnityProInsertToEnd True  True = The software puts function blocks that are
generated after a first generation at the end of sections
independently of the position that they would normally
occupy.
 False = The software lays out function blocks according to
the default behavior when generating Control Participant
projects after changes (see page 491).
CheckConsistency True This is not a user-configurable parameter.
Changing the value affects the behavior of the software.
SaveAfterNumberSectionGenerated 30 Number of FBD sections that need to generate successfully to
trigger a save command in the Control Participant.
If you are generating a number of sections lower than the
value, a save command is executed once generation
completed successfully.
NOTE: Reducing this number may increase generation time
because the number of save operations is higher. The setting
does not alter the impact of detected errors during generation
(see page 450).
NumberOfUnitySectionRows 36(1) Number of rows/columns that the section contains when it is
created by generating the Control Participant project or section
NumberOfUnitySectionColumns 24(1) for the first time or regenerating it.
NumberOfUnitySectionRows allowed range: 24 to 144
NumberOfUnitySectionColumns allowed range: 6 to 36
NOTE: If you modify the default section size or if the Control
Participant creates a section that is different from your settings,
generation or regeneration may not complete successfully
because constituents cannot be positioned (see page 452) as
required.

(1) NumberOfUnitySectionRows x NumberOfUnitySectionColumns =< 864. If this value is

exceeded, either 24 or 144 is retained for the number of rows (the value that comes closest to
NumberOfUnitySectionRows) and the number of columns adjusted in consequence,
independently of the setting of NumberOfUnitySectionColumns. For example, if you enter
200 and 7 respectively, a section of size 1440 x 60 is created because 200 exceeds the allowed
number of rows and is closer to 144 than to 24.

EIO0000001114 06/2020 455

Generation Stage

Selecting Versions of Types in Control Facets During Generation

Overview
Because in a logical Control Participant project, only one version of a given type can exist, either
of the following situations require that you select which version is generated:
 You are assigning to a Control Participant project facets that encapsulate the same type but
different versions of it.
 You have updated or replaced the template (see page 245) that is used by an instance whose
facets are already assigned to a Control Participant project and generated. The new template
contains the same type (DFBs and/or DDTs) but of a different version. The assignment status
of one or more of these facets has been set to Out Of Date.
If such a case occurs, when you generate the logical Control Participant project to apply the
changes, the software detects the presence of several versions for a same type.
As a result, the software opens the Global Constituent Type Version Conflicts dialog box in which
you can select either command to select the version that you want to use in the logical Control
Participant project:
 Update
 Skip
 Cancel

The software maintains a list of the various versions of a type that it detects during each generation
cycle and applies your initial selection when it detects a version again. If the software detects a
new version of the same type when it generates the next section, it opens the Global Constituent
Type Version Conflicts dialog box again.
The detection of the version change is performed at the facet level and it is irrelevant to which
instance a facet belongs.
However, if two or more versions of the same type are detected in the same section, generation
stops. In this case, the software informs you about the facets, the type, and the versions that create
the conflict. You need to resolve the version conflict at the instance or facet level manually.
This topic contains several examples illustrating the main scenarios that you may encounter.
NOTE: Although you select the version at the section level, updating the version of a type impacts
all its instances across all sections of the Control Participant project. Also, the last action that you
select for a given type is the one that is applied.
NOTE: The Global Constituent Type Version Conflicts dialog box also opens if the software detects
the same version of a type but with a different signature (see page 461).

456 EIO0000001114 06/2020

 Generation Stage

Relation Between Type Versions in the Application and in Control Projects

The version of the type that you select to use in the logical Control Participant project is not
necessarily the same as the version that is encapsulated in the template used by instances of the
application. Indeed, in the application, instances can use several versions of a same template
encapsulating different versions of a type. The version of the type that is used in the logical Control
Participant project can only be one of these versions.
This example shows the different versions of a template that are used by three instances of the
application. Each template encapsulating a different version of a DFB. It also shows the single type
version that is generated in the Control project.

Template version and encapsulated type version in Type version used in the logical Control project
the application
Template_A [1.0.0], type version 1.2 Type version 1.3
Template_A [1.0.1], type version 1.3
Template_A [1.0.2], type version 2.0

This second example shows that different versions of a type can be used in different Control
projects, each project using only a single version.

Template version and encapsulated type Type version used in logical Type version used in logical
version in the application Control project 1 Control project 2
Template_A [1.0.0], type version 1.2 Type version 1.3 Type version 2.0
Template_A [1.0.1], type version 1.3
Template_A [1.0.2], type version 2.0

Impact of Type Version Selection on Links

Selecting Update or Skip for a facet removes links with any instance of the encapsulated type if a
pin for which a link exists is impacted in either way:
 The pin is removed.
 The pin is renamed.

The software displays a message informing you of the links that have been removed after
generation completes.

EIO0000001114 06/2020 457

Generation Stage

Global Constituent Type Version Conflicts Dialog Box

The following figure shows an example scenario where several DFB and DDT types create a
version conflict in FBDSection_1.

Item Description
1 Identifier of an instance referencing a facet that is assigned to this section and that encapsulates the type. If
other facets encapsulating the type and assigned to the section are referenced by different instances, the
number of instances is indicated.
Expand the row to view a list of these instances with the template identifier and version each one uses. A tooltip
displays the same information when the row is not expanded.
2 Name of the type encapsulated in the facets for which a version conflict is detected.
3 Version of the type that is currently used in the logical Control Participant project.
4 Version of the type that is encapsulated in the facets being generated.
(1) Includes all the types encapsulated in the facet if more than one, for example the DFB and its DDT. You cannot
select to update or skip one and not the other.

458 EIO0000001114 06/2020

 Generation Stage

Item Description
5 Button that lets you select the Skip action for individual types.
Does not update the type(1) that is currently used in the logical Control project (version X) to version Y, which is
the version encapsulated in the facet. Also, it does not generate the facet.
For each generation cycle, the software maintains a list of the various versions of a same type that it has
detected. Based on this list, if other facets encapsulate version X or y of the same type, no dialog box opens
and version X is maintained automatically.
If, in another section, the software detects a facet that encapsulates the same type but of a version that is
different from version X and version Y (for example, version Z), the Global Constituent Type Version Conflicts
dialog box opens again. Version Z is added to the list of versions already detected.
The generation status of facets may be set to inconsistent. In such case, when generation completes, the
software provides a summary with the name of the facets that are affected and the name of the section they are
assigned to.
NOTE: Skip only skips the generation of the facet that encapsulates the type. Other facets belonging to the
same instance are generated if their status (see page 489) requires it (for example, if it is Out Of Date).
6 Button that lets you select the Update action for individual types.
Generates the facet and updates the type(1) currently used in the logical Control project (version X) to the
version that is encapsulated in the facet (version Y). The status of the facet becomes Generated.
For each generation cycle, the software maintains a list of the various versions of a same type that it has
detected. Based on this list, if other facets encapsulate version X or y of the same type, no dialog box opens
and version Y is used automatically.
If, in another section, the software again detects a facet that encapsulates version X of the same type and the
facet is not generated, it remains non-generated.
If, in another section, the software detects a facet that encapsulates the same type but of a version that is
different from version X and version Y (for example, version Z), the Global Constituent Type Version Conflicts
dialog box opens again. This allows you to update the current version of the type (for example, version Y) to
version Z. Version Z is added to the list of versions already detected.
The generation status of facets may be set to inconsistent. In such case, when generation completes, the
software provides a summary with the name of the facets that are affected and the name of the section they are
assigned to.
NOTE: version Y can be a version later or earlier than version X. The same applies to version Z compared to
the other versions.
7 Copies the content of the dialog box to the Clipboard.
8 Buttons that let you select an action for the conflicting type versions as a whole.
The actions are the same as when you select the action for types individually.
NOTE: Clicking these buttons overrides the selection you have made for individual types.
(1) Includes all the types encapsulated in the facet if more than one, for example the DFB and its DDT. You cannot
select to update or skip one and not the other.

EIO0000001114 06/2020 459

Generation Stage

Item Description
9 Generation of the Control Participant project stops. Code of sections that have been generated successfully
remains in the logical Control Participant project. The type(1) version that was used after the generation of the
previous section is maintained.
The section in which the version conflicts have been detected and any subsequent sections are not generated.
10 Generates the section by applying your selection of actions for conflicting types.
(1) Includes all the types encapsulated in the facet if more than one, for example the DFB and its DDT. You cannot
select to update or skip one and not the other.

NOTE: The status of facets is updated only after the entire generation process is completed.

Setting the Status of Facets to Inconsistent

Updating or skipping the version of a type may set the generation status of a facet to Inconsistent.
The assignment status does not change.
The table describes under which conditions the generation status is changed.

Status of the type version Required facet status Required user action
The version has already been detected Assignment: Out Of Because the version has already been
during this generation cycle but is different Date detected, the Global Constituent Type
from the one currently used in the Control Version Conflicts dialog box does not
project. open; therefore, no action is required.
Refer to example 3 (see page 468).
The version has not yet been detected Assignment: Out Of You are selecting Skip for the proposed
during this generation cycle. Date version change after having already
selected Update for the same type in
another section during the same
generation cycle.
Refer to example_7 (see page 475).

NOTE: If the status of the facet is Non Generated, it does not change.

460 EIO0000001114 06/2020

 Generation Stage

Detecting Types of Same Version But With Different Signature

The Global Constituent Type Version Conflicts dialog box also opens if the software detects in a
facet assigned to the Control project and which needs to be generated, the same version of a type
as it is already used in the logical Control project but with a different signature.
The following figure shows an example of detection of a type of the same version but with a
different signature. A tooltip indicates the nature of the conflict when you position the pointer over
the version of the type.

 Update: The type in the logical Control project is updated with the type and signature that is
encapsulated in the facet.
 Skip: The type that is used in the logical Control project continues to be used; no update is
performed. The generation status of facets may be set to inconsistent (see page 460).
Independently of the action that you select, the Global Constituent Type Version Conflicts dialog
box opens again if in another section of the same Control project another facet is detected, which
encapsulates the same version of the same type and with a signature that is the same as in the
previous facet or with yet another signature.
If two or more facets encapsulating the same version of a type but each with a different signature
are detected in the same section, generation stops (see page 450).

EIO0000001114 06/2020 461

Generation Stage

Performing a Consistency Check After Version Conflict Detection

It is recommended to perform a consistency check (see page 523) when the software detects
several versions of the same type or the same version with different signature during generation
of a Control Participant project.
A consistency check detects which generated facets encapsulate a type whose version or
signature is different from the version/signature of the type used in the Control Participant project.
The status of such facets is set to Inconsistent.
The following example illustrates a scenario where a consistency check allows identifying a facet
that contains a version of a type that is different from the version used in the Control project after
the software detected a version conflict. In this example, v1.0 of DFB_A type was generated in the
Control project by Facet_2. A second facet (Facet_1) containing v2.0 of the same type is assigned
to a different section and the project is generated again.

Section Facet DBF_A Facet Facet status after Comment

type assignment/generation generating and
version status before performing a
generating consistency check
Section_1 Facet_1 v2.0 Out Of Assigned/Generated The software detects a
Date/Generated version conflict and you
update the type used in
the Control project to
v2.0 by selecting
Update.
Section_2 Facet_2 v1.0 Assigned/Generated Assigned/Inconsistent Because the facet
encapsulates v1.0 of
the type, the
consistency check has
set the status of the
facet to Inconsistent.

Regenerating a Control Participant Project After Type Version Changes

When you select the Regenerate command after generating a Control Participant project or section
in which version conflicts were detected, the behavior is different depending on what you
regenerate.
If you regenerate the entire Control Participant project, the software removes the types from the
logical Control project and generates the ones that are encapsulated in facets assigned to the
Control Participant project sections. If various versions of a same type are detected again, the
Global Constituent Type Version Conflicts dialog box opens.
If you regenerate a section of a Control Participant project, the software maintains existing types
(see page 493) in the logical Control project and starts over the generation process. During
regeneration, it compares:
 For the first facet of the section that encapsulates a type, the version of the type.
 The version of this type that exists in the logical Control project.

462 EIO0000001114 06/2020

 Generation Stage

If they are different, it opens the Global Constituent Type Version Conflicts dialog box.
If they are identical, it performs the comparison with the second facet of the section encapsulating
a type, and so on.
In case several versions of the same type are detected in the same section (see page 463),
generation stops.

Examples
The following examples illustrate various type version conflict scenarios when facets are assigned
to the same section.

Description Command used Refer to

A facet is assigned to an already generated section. – Example1a
(see page 464)
A section contains two facets that are not generated. Example 1b
(see page 465)
A section contains two facets that are generated and one of them is Example 1c
updated to use a different version of the type. (see page 466)
A generated facet is updated while the same section contains a non- Update and Example 2
generated facet. Skip (see page 467)
This example illustrates a possible solution to examples 1.

The following examples illustrate various type version conflict scenarios when facets are assigned
to different sections.

Description Command used Refer to

Two different versions of the same type in different Update Example 3
sections of a Control project. (see page 468)
Several different versions of the same type in Example 4
different sections of a Control project. (see page 470)
Two different versions of the same type in different Skip Example 5
sections of a Control project. (see page 472)
Several different versions of the same type in Example 6
different sections of a Control project. (see page 473)
Several different versions of the same type in Update and Skip Example 7
different sections of a Control project. (see page 475)
Two different versions of the same type in different Cancel and Update Example 8
sections of a Control project. The Regenerate command is (see page 478)
also described.

EIO0000001114 06/2020 463

Generation Stage

Example 1a: Two Different Versions of the Same Type in the Same Section
A facet is assigned to an already generated section.
The starting point is the following:
 One facet is assigned to Section_1 and generated.
 The facet encapsulates DFB_A.

Facet ID DFB_A version Facet assignment/generation DFB_A version used

encapsulated in facet status in Control project
Facet_0 v1.0 Assigned/Generated v1.0

Then, another facet encapsulating DFB_A but of a different version is assigned to the same
section. The section is generated again to apply the changes.
The table explains the behavior during generation of Section_1 and which version of DFB_A is
used in the end.

Facet ID(1) DFB_A version Facet DFB_A version Comment

encapsulated in assignment/generation used in Control
facet status after generation project after
generation
Facet_0 v1.0 Assigned/Generated v1.0 The software detects v2.0 while v1.0
Facet_1 v2.0 Assigned/Non is already generated. Because the
Generated conflict arises in the same section,
generation stops (see page 450) and
DFB_A version v1.0 is maintained.
The status of facets is unchanged.
To be able to generate the section, you
can either:
 Unassign one of the facets from the
section.
 Update the template used by one of
the instances so that both facets use
the same version of DFB_A
(see page 467).
 Unlink Facet_0, generate the
section, select Update when the
Global Constituent Type Version
Conflicts dialog box opens, then
relink Facet_0.
(1) The order of facets in the section is not relevant.

(Back to example summary table (see page 463).)

464 EIO0000001114 06/2020

 Generation Stage

Example 1b: Two Different Versions of the Same Type in the Same Section
A section contains two facets that are not generated.
The starting point is the following:
 Two facets of two different instances are assigned to Section_1.
 Both facets encapsulate DFB_A but of a different version.
 DFB_A does not exist in the Control project.

Facet ID(1) DFB_A version encapsulated in facet Facet assignment/generation status

Facet_0 v1.0 Assigned/Non Generated

Facet_1 v2.0
(1) The order of facets in the section is not relevant.

Then, the section is generated.

The table explains the behavior during generation of Section_1 and which version of DFB_A is
used in the end.

Facet ID(1) DFB_A Facet DFB_A Comment

version assignment/generation version used
encapsulated status after generation in Control
in facet project after
generation
Facet_0 v1.0 Assigned/Non None The software detects v1.0 and v2.0 in the
Generated same section. Because of this, generation
Facet_1 v2.0
stops (see page 450) and no version of
DFB_A is generated.
The status of facets is unchanged.
To be able to generate the section, you can
either:
 Unassign one of the facets from the
section.
 Update the template used by one of the
instances so that both facets use the
same version of DFB_A (see page 467).
(1) The order of facets in the section is not relevant.

(Back to example summary table (see page 463).)

EIO0000001114 06/2020 465

Generation Stage

Example 1c: Two Different Versions of the Same Type in the Same Section
A section contains two facets that are generated and one of them is updated to use a different
version of the type.
The starting point is the following:
 Two facets of two different instances are assigned to Section_1.
 Both facets encapsulate the same version of DFB_A.

Facet ID(1) DFB_A version Facet assignment/generation DFB_A version used

encapsulated in facet status in Control project
Facet_0 v1.0 Assigned/Generated v1.0
Facet_1 v1.0
(1) The order of facets in the section is not relevant.

Then, the template used by instance referencing Facet_0 is updated. This results in Facet_0
encapsulating a different version of DFB_A. The section is generated again to apply the change.
The table explains the behavior during generation of Section_1 and which version of DFB_A is
used in the end.

Facet ID(1) DFB_A Facet DFB_A version Comment

version assignment/generation used in Control
encapsulated status after generation project after
in facet generation
Facet_0 v2.0 Out Of Date/Generated v1.0 The software detects v2.0 while v1.0 is
Facet_1 v1.0 Assigned/Generated already generated. Because the conflict
arises in the same section, generation stops
(see page 450) and DFB_A version v1.0 is
maintained.
The status of facets is unchanged.
To be able to generate the section, you can
either:
 Unassign one of the facets from the
section.
 Update the template used by the
instance referencing Facet_1 so that
both facets use the same version of
DFB_A (see page 467).
 Unlink the already assigned and
generated facet (Facet_1), generate the
section, select Update when the Global
Constituent Type Version Conflicts
dialog box opens, then relink Facet_1.
(1) The order of facets in the section is not relevant.

(Back to example summary table (see page 463).)

466 EIO0000001114 06/2020

 Generation Stage

Example 2: Two Different Versions of the Same Type in the Same Section
A generated facet is updated while the same section contains a non-generated facet.
The starting point is the following:
 Two facets are assigned to Section_1.
 One facet is generated, the other not.
 Both facets encapsulate DFB_A but of a different version.

Facet ID(1) DFB_A version Facet assignment/generation DFB_A version used

encapsulated in facet status in Control project
Facet_0 v1.0 Assigned/Generated v1.0
Facet_1 v2.0 Assigned/Non Generated
(1) The order of facets in the section is not relevant.

Then, the template used by instance referencing Facet_0 is updated. This results in Facet_0
encapsulating the same version of DFB_A as Facet_1 (v2.0). The assignment status of Facet_0
is set to Out Of Date. The section is generated again to apply the change.
The table explains the behavior during generation of Section_1 and which version of DFB_A is
used in the end.

Facet ID(1) DFB_A Facet DFB_A version Comment

version assignment/generation used in Control
encapsulated status after generation project after
in facet generation
Facet_0 v2.0 Assigned/Generated v2.0 The software detects v2.0 and opens
Facet_1 v2.0 Assigned/Generated the Global Constituent Type Version
Conflicts dialog box. Update is selected.
The facet is generated and the version of
DFB_A used in the logical Control
project is updated from v1.0 to v2.0.
(1) The order of facets in the section is not relevant.

NOTE: If you select Skip instead, none of the facets in Section_1 are generated and the version of
DFB_A in the logical Control project remains v1.0.
(Back to example summary table (see page 463).)

EIO0000001114 06/2020 467

Generation Stage

Example 3: Two Different Versions of the Same Type in Different Sections of a Control Project
This example illustrates the behavior during generation when facets encapsulating two different
versions of the same type are assigned to various sections.
The starting point is the following:
 Four facets of four different instances are assigned to separate sections.
 Each facet encapsulates DFB_A.
 All sections are part of the same Control project and generated.

Facet ID DFB_A version encapsulated in facet Section ID(1) DFB_A version used in Control project
Facet_0 v1.0 Section_0 v1.0
Facet_1 v1.0 Section_1
Facet_2 v1.0 Section_2
Facet_3 v1.0 Section_3
No facet – Section_4
assigned
(1) The order of the sections corresponds to the section number.

Then, the following changes are performed:

 The template used by one instance is updated. As a result, one facet encapsulates DFB_A of a
different version and its status is set to Out Of Date.
 A new facet, Facet_4, is assigned to Section_4. It encapsulates version v1.0 of DFB_A and its
statuses are Assigned/Non Generated.
The Control project is generated again to apply the changes.

468 EIO0000001114 06/2020

 Generation Stage

The table explains the behavior during generation of the Control project and which version of
DFB_A is used in the end.

Facet ID DFB_A Section ID(1) DFB_A version Comment

version used in Control
encapsulated project after facet
in facet generation
Facet_0 v1.0 Section_0 v1.0 No change to be generated for the facet.
Facet_1 v2.0 Section_1 v2.0 (2) The software detects v2.0 and opens the Global
Constituent Type Version Conflicts dialog box.
Update is selected. The facet is generated and the
version of DFB_A used in the logical Control
project is updated from v1.0 to v2.0.
Facet_2 v1.0 Section_2 Because v1.0 has already been detected, the
Facet_3 v1.0 Section_3 previously selected Update command is applied
automatically and DFB_A version v2.0 is
Facet_4 v1.0 Section_4
maintained.
Facet_4 is not generated; its statuses remain
Assigned/Non Generated.
NOTE: If the assignment status of Facet_2 or
Facet_3 is Out Of Date, its generation status is set
to Inconsistent.
(1) The order of the sections corresponds to the section number.
(2) Version of DFB_A that is used in the end after successful generation of the Control project.

(Back to example summary table (see page 463).)

EIO0000001114 06/2020 469

Generation Stage

Example 4: Several Different Versions of the Same Type in Different Sections of a Control Project
This example illustrates the behavior during generation when facets encapsulating different
versions of the same type are assigned to the various sections.
The starting point is the following:
 Four facets of four different instances are assigned to separate sections.
 Each facet encapsulates DFB_A.
 All sections are part of the same Control project and generated.

Facet ID DFB_A version encapsulated in facet Section ID(1) DFB_A version used in Control project
Facet_0 v1.0 Section_0 v1.0
Facet_1 v1.0 Section_1
Facet_2 v1.0 Section_2
Facet_3 v1.0 Section_3
(1) The order of the sections corresponds to the section number.

Then, the template used by some instances is updated with various versions. As a result, the facets
encapsulate various versions of DFB_A and their status is set to Out Of Date. The Control project
is generated again to apply the changes.

470 EIO0000001114 06/2020

 Generation Stage

The table explains the behavior during generation of the Control project and which version of
DFB_A is used in the end.

Facet ID DFB_A Section ID(1) DFB_A version Comment

version used in Control
encapsulated project after facet
in facet generation
Facet_0 v1.0 Section_0 v1.0 No change to be generated for the facet.
Facet_1 v3.0 Section_1 v3.0 The software detects v3.0 and opens the Global
Constituent Type Version Conflicts dialog box.
Update is selected. The facet is generated and the
version of DFB_A used in the logical Control
project is updated from v1.0 to v3.0.
Facet_2 v1.0 Section_2 Because v1.0 has already been detected, the
previously selected Update command is applied
automatically and DFB_A version v3.0 is
maintained.
NOTE: If the assignment status of the facet is Out
Of Date, its generation status is set to Inconsistent.
Facet_3 v4.0 Section_3 v4.0(2) The software detects v4.0 and opens the Global
Constituent Type Version Conflicts dialog box.
Update is selected. The facet is generated and the
version of DFB_A used in the logical Control
project is updated from v3.0 to v4.0.
(1) The order of the sections corresponds to the section number.
(2) Version of DFB_A that is used in the end after successful generation of the Control project.

NOTE: It is possible to update the version of a type to an earlier one. For example, if Facet_3 would
encapsulate DFB_A of version v2.0, the version used in the end would be v2.0.
(Back to example summary table (see page 463).)

EIO0000001114 06/2020 471

Generation Stage

Example 5: Two Different Versions of the Same Type in Different Sections of a Control Project
This example illustrates the behavior during generation when facets encapsulating two different
versions of the same type are assigned to various sections and the Skip command is used.
The starting point is the following:
 Four facets of four different instances are assigned to separate sections.
 Each facet encapsulates DFB_A.
 All sections are part of the same Control project and generated.

Facet ID DFB_A version encapsulated in facet Section ID(1) DFB_A version used in Control project
Facet_0 v1.0 Section_0 v1.0
Facet_1 v1.0 Section_1
Facet_2 v1.0 Section_2
Facet_3 v1.0 Section_3
(1) The order of the sections corresponds to the section number.

Then, the template used by two instances is updated. As a result, two facets encapsulate DFB_A
of a different version and their status is set to Out Of Date. The Control project is generated again
to apply the changes.
The table explains the behavior during generation of the Control project and which version of
DFB_A is used in the end.

Facet ID DFB_A Section ID(1) DFB_A version Comment

version used in Control
encapsulated project after facet
in facet generation
Facet_0 v1.0 Section_0 v1.0(2) No change to be generated for the facet.
Facet_1 v2.0 Section_1 The software detects v2.0 and opens the Global
Constituent Type Version Conflicts dialog box.
Skip is selected. The facet is not generated and the
version of DFB_A used in the logical Control
project remains v1.0.
Facet_2 v1.0 Section_2 No change to be generated for the facet.
Facet_3 v2.0 Section_3 Because v2.0 has already been detected, the
previously selected Skip command is applied
automatically. The facet is not generated and
DFB_A version v1.0 is maintained.
(1) The order of the sections corresponds to the section number.
(2) Version of DFB_A that is used in the end after successful generation of the Control project.

NOTE: The assignment status of Facet_1 and Facet_3 remains Out Of Date.
(Back to example summary table (see page 463).)

472 EIO0000001114 06/2020

 Generation Stage

Example 6: Several Different Versions of the Same Type in Different Sections of a Control Project
This example illustrates the behavior during generation when facets encapsulating different
versions of the same type are assigned to the various sections and the Skip command is used.
The starting point is the following:
 Four facets of four different instances are assigned to separate sections.
 Each facet encapsulates DFB_A.
 All sections are part of the same Control project and generated.

Facet ID DFB_A version encapsulated in facet Section ID(1) DFB_A version used in Control project
Facet_0 v1.0 Section_0 v1.0
Facet_1 v1.0 Section_1
Facet_2 v1.0 Section_2
Facet_3 v1.0 Section_3
(1) The order of the sections corresponds to the section number.

Then, the template used by some instances is updated with various versions. As a result, the facets
encapsulate various versions of DFB_A and their status is set to Out Of Date. The Control project
is generated again to apply the changes.

EIO0000001114 06/2020 473

Generation Stage

The table explains the behavior during generation of the Control project and which version of
DFB_A is used in the end.

Facet ID DFB_A Section ID(1) DFB_A version Comment

version used in Control
encapsulated project after
in facet facet generation
Facet_0 v1.0 Section_0 v1.0(2) No change to be generated for the facet.
Facet_1 v2.0 Section_1 The software detects v2.0 and opens the Global
Constituent Type Version Conflicts dialog box. Skip
is selected. The facet is not generated and the
version of DFB_A used in the logical Control project
remains v1.0.
Facet_2 v4.0 Section_2 The software detects v4.0 and opens the Global
Constituent Type Version Conflicts dialog box. Skip
is selected. The facet is not generated and the
version of DFB_A used in the logical Control project
remains v1.0.
Facet_3 v2.0 Section_3 Because version v2.0 has already been detected
(for Facet_1), the previously selected Skip
command is applied automatically. The facet is not
generated and the version of DFB_A used in the
logical Control project remains v1.0.
(1) The order of the sections corresponds to the section number.
(2) Version of DFB_A that is used in the end after successful generation of the Control project.

NOTE: The assignment status of Facet_1, Facet_2, and Facet_3 remains Out Of Date.
(Back to example summary table (see page 463).)

474 EIO0000001114 06/2020

 Generation Stage

Example 7: Several Different Versions of the Same Type in Different Sections of a Control Project
This example illustrates the behavior during generation when facets encapsulating different
versions of the same type are assigned to the various sections and the Update and Skip
commands are used.
The starting point is the following:
 Six facets of six different instances are assigned to separate sections.
 Each facet encapsulates DFB_A.
 All sections are part of the same Control project and generated.

Facet ID DFB_A version encapsulated in facet Section ID(1) DFB_A version used in Control project
Facet_0 v1.0 Section_0 v1.0
Facet_1 v1.0 Section_1
Facet_2 v1.0 Section_2
Facet_3 v1.0 Section_3
Facet_4 v1.0 Section_4
Facet_5 v1.0 Section_5
(1) The order of the sections corresponds to the section number.

Then, the template used by the instances is updated with various versions. As a result, the facets
encapsulate various versions of DFB_A and their status is set to Out Of Date. The Control project
is generated again to apply the changes.

EIO0000001114 06/2020 475

Generation Stage

The table explains the behavior during generation of the Control project and which version of
DFB_A is used in the end.

Facet ID DFB_A Section ID(1) DFB_A version Comment

version used in Control
encapsulated project after
in facet facet generation
Facet_0 v4.0 Section_0 v4.0 The software detects v4.0 and opens the Global
Constituent Type Version Conflicts dialog box.
Update is selected. The facet is generated and the
version of DFB_A used in the logical Control project
is updated from v1.0 to v4.0.
Facet_1 v2.0 Section_1 The software detects v2.0 and opens the Global
Constituent Type Version Conflicts dialog box. Skip
is selected. The facet is not generated and
version v4.0 of DFB_A is maintained.
NOTE: The generation status of the facet is set to
Inconsistent because the version of DFB_A has
been previously updated when generating Facet_0.
Facet_2 v1.0 Section_2 Because version v1.0 has already been detected
when generating Facet_0, the previously selected
Update command is applied automatically and
DFB_A version v4.0 is maintained.
NOTE: If the assignment status of the facet is Out
Of Date, its generation status is set to Inconsistent.
Facet_3 v4.0 Section_3 The facet is generated but without the detection of
a version change because the version of DFB_A
used in the Control project is already v4.0 due to
the update when generating Facet_0.
(1) The order of the sections corresponds to the section number.
(2) Version of DFB_A that is used in the end after successful generation of the Control project.

476 EIO0000001114 06/2020

 Generation Stage

Facet ID DFB_A Section ID(1) DFB_A version Comment

version used in Control
encapsulated project after
in facet facet generation
Facet_4 v2.0 Section_4 v4.0(2) The previously selected Skip command (for
Facet_1) is applied automatically. The facet is not
generated and DFB_A version v4.0 is maintained.
NOTE: The generation status of the facet is set to
Inconsistent because the version of DFB_A has
been previously updated when generating Facet_0.
Facet_5 v3.0 Section_5 The software detects v3.0 for the first time and
therefore opens the Global Constituent Type
Version Conflicts dialog box. Skip is selected. The
facet is not generated and the version of DFB_A
used in the logical Control project remains v4.0.
NOTE: The generation status of the facet is set to
Inconsistent because the version of DFB_A has
been previously updated when generating Facet_0.
(1) The order of the sections corresponds to the section number.
(2) Version of DFB_A that is used in the end after successful generation of the Control project.

(Back to example summary table (see page 463).)

EIO0000001114 06/2020 477

Generation Stage

Example 8: Two Different Versions of the Same Type in Different Sections

This example illustrates the behavior during generation when facets encapsulating different
versions of the same type are assigned to the different sections and the Cancel and Update
commands are used.
The starting point is the following:
 Two facets of two different instances are assigned to one section each.
 Each facet encapsulates DFB_A.
 Facets are not yet generated.

Facet ID(1) DFB_A version encapsulated in facet Section ID DFB_A version used in Control project
Facet_0 v1.0 Section_1 None
Facet_1 v2.0 Section_2
(1) The order of the facet in the section corresponds to the facet number.

Then, the Control project is generated.

The table explains the behavior during generation of the Control project and which version of
DFB_A is used in the end.

Facet ID DFB_A Section ID DFB_A version Comment

version used in Control
encapsulated project after
in facet generation
Facet_0 v1.0 Section_1 1.0 Version v1.0 of DFB_A is generated in the
logical Control project.
Facet_1 v2.0 Section_2 1.0(1) The software detects v2.0 and opens the
Global Constituent Type Version Conflicts
dialog box. Cancel is selected. Generation
stops. The facet is not generated and the
version of DFB_A used in the logical Control
project remains v1.0.
(1) Version of DFB_A that is used in the end after successful generation of the section.

478 EIO0000001114 06/2020

 Generation Stage

Then, the Control project is generated a second time.

Facet ID DFB_A Section ID DFB_A Comment

version version used
encapsulated in Control
in facet project after
generation
Facet_0 v1.0 Section_1 1.0 No change to be generated for the facet.
Facet_1 v2.0 Section_2 2.0(1) The software detects v2.0 and opens the
Global Constituent Type Version Conflicts
dialog box. Update is selected. The facet is
generated and the version of DFB_A used in
the logical Control project is updated
from v1.0 to v2.0.
(1) Version of DFB_A that is used in the end after successful generation of the section.

NOTE:
After the second generation, if you regenerate:
 The entire Control project: A version conflict is detected in Section_2 like during a first
generation because type DFB_A is removed from the Control before regenerating.
 Section_1: A version conflict is detected because the version of DFB_A in the Control project
(v2.0) is different from the version encapsulated in Facet_0 (v1.0).
 Section_2: No version conflict is detected.

(Back to example summary table (see page 463).)

EIO0000001114 06/2020 479

Generation Stage

Statuses of Facets

Overview
After the generation process, the generation and assignment statuses of facets provide information
on the facet state.
NOTE: For information on the behavior when generating such facets again, refer to the topic
describing the generation of facets after changes (see page 488).

Generation Status of Facets

The generation status indicates the status of the facet in relation to the generation of its
constituents in the logical Participant project.
You can see the generation status in the Generation column of the Assignments pane
(see page 386) in the Assignment Editor.
The table describes the possible generation statuses of facets following a generation.

Status Description
Non You have assigned the facet to the FBD section or container after generating that
Generated section/container. Generate (see page 488) the section/container again to create the
constituents of the facet in the logical Participant project.
It can also indicate that the generation process of a facet or its container was unsuccessful.
Generated The software has successfully generated the constituents of the facet into the logical
participant project.
NOTE: The software automatically sets the status of Supervision genie facets that you
assign to a page during page edit to Generated.
Moved You have moved (see page 437) the facet to another FBD section of the Control project or
another container of the Supervision.
NOTE:
 If you move the facet back to its original FBD section or container, it keeps the status
Moved.
 The status does not apply to genie facets.

Inconsistent You have refined, updated, or imported the logical Control Participant project, or relinked a
facet, which was unlinked and the software has detected an inconsistency in the facet during
the consistency check (see page 523):
 You have not yet generated the section containing the facet again in order for the software
to resolve the inconsistency (see page 491) and change the status, or
 The software could not solve the inconsistency during a subsequent generation and the
status of the facet remains Inconsistent.
NOTE: By default, the status of Supervision genie and data facets changes to Inconsistent
when you reassign or relink (see page 501) them.
NOTE: This status can also be the result of a type version conflict that the software detected
during generation of Control facets (see page 456).

480 EIO0000001114 06/2020

 Generation Stage

Status Description
Unlinked You have unlinked the facet from its already generated constituents in the logical Participant
project:
 By using the Unlink (see page 503) command.
 By unlinking the facet through the Check Consistency dialog box:
 After refining a Control Participant project (see page 507).
 Before updating a Control Participant project (see page 849).

By unlinking a facet, the software does not change already generated constituents when you
generate it again if the status the facet is such that a generation would change its status (for
example, if the status of the facet is out of date or inconsistent, generating it would change
its status to generated). This allows you to preserve changes that you have made in the
logical Participant project to constituents of the facet through refinement or refinement online.

Assignment Status of Generated Facets

The assignment status indicates the status of the facet in relation to the instance that references
the facet.
The software may update the Assignment status of the facet when you change the properties of
the instance that references the facet.
You can see the assignment status in the Assignment column of the Assignments pane
(see page 386) in the Assignment Editor.
The table describes the possible assignment statuses of a facet following a generation.

Status Description
Assigned The facet is assigned to the container.
Unassigned You have unassigned (see page 501) a generated facet from the container to which you had
assigned it.
NOTE: The facet can still be assigned to other projects of the system.

EIO0000001114 06/2020 481

Generation Stage

Status Description
Out Of Date You have changed at least 1 of the following parameter configurations of the instance that
references the facet:
 $System parameters (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual) that affect the facet.
 Element selections and their parameters.
 Instance identifier (including changes made by the software in relation to the hierarchical
naming function).
 Links.
 Updated or replaced the template that is used by the instance.
 Other changes made within the application to an instance and that affect its facet.

Furthermore, for Supervision data facets only, you have changed any of the following in the
Supervision project:
 The identifier of the cluster or I/O device.
 The identifier of the tag container if Protocol is set to OPCUA.
 The relationship between the tag container and the I/O device.
 The protocol of the tag container.
 The application structure (see page 238) (in the Application Explorer).

Deleted You have unselected the corresponding element in the Instance Editor or deleted the instance
that references the facet.

482 EIO0000001114 06/2020

 Generation Stage

Section 15.2
Generating a Project for the First Time

Generating a Project for the First Time

Overview
This section describes how to use the Project Explorer to create a logical Control or Supervision
Participant project or part of a project for the first time.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Generating Entire Projects 484
Generating Sections, Containers, and Nodes 485

EIO0000001114 06/2020 483

Generation Stage

Generating Entire Projects

Overview
The generation of the entire project for the first time encompasses:
 For a Control project: The FBD sections of the project and the facets that are assigned to these
sections.
 For a Supervision project: The various containers of the clusters of the project to which facets
are assigned and any associated components of the Services node.
The status of facets is updated only after the entire generation process is completed.
NOTE: You can generate a project while the generation of another project is still ongoing.

Aborting Project Generation Tasks

After selecting the Generate command, the abort icon is displayed in the notification panel
(see page 86). Click the icon to cancel the task. The project is not generated; what the software
had already generated at the time you canceled the task is reverted.
Refer to the notification panel for details.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are generating a small project, the task may complete before you are able to click the
icon.

Generating an Entire Project

To generate an entire Participant project, proceed as follows.

Step Action
1 In the project browser or the Containers pane of the Assignment Editor, right-click the project
that you want to generate and select Generate.
Result:
 The software creates the corresponding logical Participant project. Generation is complete
when Completed is displayed for the process in the notification panel.
 The status of the Generation column in the Assignments pane changes to Generated for
facets that are assigned to the project.
NOTE: If you are generating the project again, the generation status (see page 480) of facets
that were Unlinked remains unchanged and those that were Inconsistent may remain
unchanged.

NOTE: For Control projects, you can configure certain generation settings (see page 454).

484 EIO0000001114 06/2020

 Generation Stage

Generating Sections, Containers, and Nodes

Overview
The generation of parts of a project for the first time encompasses:
 For an FBD section of a Control project: The facets that are assigned to the section and the
order of the section.
 For a Supervision project:
 For the Containers node: The containers of all the clusters of the project.
 For tag containers, pages, client and sever event containers: The facets that are assigned to
the respective container.
 For the Tags containers: The facets that are assigned to the containers of the corresponding
cluster.
 For a cluster: The containers of the Tags, ClientEvents, and ServerEvents nodes of the
cluster and any components of the Services node.
 For the Services node: The components of the node.

NOTE: You can generate several sections or containers of the same project at the same time but
the generation process will occur in sequence. If the sections/containers belong to different
projects, they are generated in parallel.

Aborting Generation Tasks

After selecting the Generate command, the abort icon is displayed in the notification panel
(see page 86). Click the icon to cancel the task. The container of the Participant project is not
generated; what the software had already generated at the time you canceled the task is reverted.
Refer to the notification panel for details.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are generating a container to which only few facets are assigned, the task may
complete before you are able to click the icon.

EIO0000001114 06/2020 485

Generation Stage

Generating Part of a Project

To generate part of a project, proceed as follows.

Step Action
1 In the project browser or in the Containers pane of the Assignment Editor, right-click the item
that you want to generate and select Generate.
Result:
 The software generates the contents of the selected item. Generation is complete when
Completed is displayed for the process in the notification panel.
 The status of the Generation column in the Assignments pane changes to Generated for the
facets that are assigned to the selected containers.
NOTE: If you are generating this part of the project again, the generation status (see page 480)
of facets that were Unlinked remains unchanged and those that were Inconsistent may remain
unchanged.

NOTE: For Control projects, you can configure certain generation settings (see page 454).

486 EIO0000001114 06/2020

 Generation Stage

Section 15.3
Generating Projects After Changes

Generating Projects After Changes

Overview
This section describes how to use the Project Explorer to perform a subsequent generation or to
regenerate entire logical Control or Supervision Participant projects, or parts of such projects.
You may be able to import into the deployed Control Participant project (see page 829) sections
that you have generated or regenerated after modifying them.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Generating Participant Projects After Changes 488
Regenerating a Control Project 493

EIO0000001114 06/2020 487

Generation Stage

Generating Participant Projects After Changes

Overview
You need to generate the logical Participant project that you have created with the first-time
generation when you make changes that result in facets having one of the following statuses:
 Assignment status:
 Unassigned
 Out Of Date
 Deleted

 Generation status:
 Non Generated
 Moved
 Inconsistent

You also need to generate it when you perform the following actions on sections of a Control
project in the Project Explorer:
 Rename a section.
 Create an FBD section.
 Change the order of sections.

To update the logical Participant project, use one of the following commands:
Generate Only changes that you made to the application and the project since the last generation
are generated incrementally into the logical Participant project. Already generated data remains
unchanged. However, certain changes that you made during refinement may be discarded.
Regenerate Applies to Control projects only (see page 493). Re-creates the logical Participant
project from the beginning based on the current application and Control project settings. Certain
changes that you made during refinement are discarded. You can configure certain generation
settings (see page 454).
The software proceeds with the validation of data (see page 446) like it does when generating.
NOTE: To apply to the logical Control project changes that you have made to sections, you can
also select the Refine command (see page 507) at the project level.

488 EIO0000001114 06/2020

 Generation Stage

Generation Function Description

The table indicates the actions that the software executes on facets when you perform a
subsequent generation of a project or parts of it, based on the Assignment and Generation status
of the facet.

Facet generation status

Facet assignment status Non Generated Generated Moved Inconsistent Unlinked
Assigned X O (1) X X O
Out Of Date – X X X O
Unassigned – Del – Del –
Deleted – Del – Del –
X Creates the constituent of the facet in the logical Participant project
O No action
Del Removes the facet and its already generated constituents (for example, variables and FB instances) but not
derived types (DFBs and DDTs)
– Combination not applicable
(1) Some exceptions apply. Refer to the topic describing the generation of Control projects after refining

NOTE: When you change the order of a facet inside a section that you had generated a first time
and generate it again, the software does not propagate the new order of facets (see page 440) to
the logical Control Participant project.

Generating Control Projects After Changing the Order of Sections

When you change the order (see page 311) of already generated sections and generate again
either the entire Control project or a section whose order you have changed, the software
propagates the new order to the logical Control Participant project.
NOTE: Generating at the project level may take slightly longer to complete compared to generating
at the section level.

Generating Control Projects After Refining

If during refinement you have modified code in a section that was already generated by the
software from a facet (for example, you have modified the variable or immediate value on a pin of
a DFB), the software reverts your change when you generate the section again if any of the
following conditions is true; otherwise your modification is preserved:
 You assign a facet to this section.
 You unassign a facet in this section.
 You move a facet to or from this section.
 You make a modification, which sets the status of any facet assigned to this section to Out Of
Date.
 You perform a consistency check, which sets the status of any facet assigned to this section to
Inconsistent.
Your modification is reverted to the code that the software had previously generated from the facet.
EIO0000001114 06/2020 489
Generation Stage

If your modification consists in replacing a variable or immediate value on the pin of an FFB by a
graphical link, such modification is not reverted by a subsequent generation. If the change is
detected as an inconsistency, the generation status of the corresponding facet is set to
Inconsistent.
In this example, the immediate value of the ZSHEN input parameter of the DEVCTL DFB is changed
to True during refinement and saved. Section Motor_1_Motor that contains the facet, which
generates the DFB (Motor_1_DEVCTL) contains only facets with the Assigned and Generated
status. No other changes were made in the Control project. Generating section Motor_1_Motor
does not undo your refinement; the immediate value of the ZSHEN input parameter remains True.

However, if section Motor_1_Motor contains, for example, a facet with status Out Of Date,
generating the section undoes the refinement change, setting the ZSHEN input parameter again to
False.

Generating Supervision Projects After Refining

Generating a Supervision project overrides any changes that you have made in refinement to
elements pertaining to the Services (see page 345) of the project.

490 EIO0000001114 06/2020

 Generation Stage

Generating Inconsistent Facets

During generation, the software attempts to restore the generated constituents of facets in the
logical Control Participant project that have the Generation status Inconsistent to be consistent
with the related facets of the Control project.
The resulting Generation status of an inconsistent facet can be:
 Generated: The software completely restored the generated constituents while preserving the
refinement that you have made.
 Inconsistent: The software was not able to restore the generated constituents completely
because it would require altering the refinement that you have made. The software may have
partially restored the constituents and the refinement that you have made was preserved.
This is the case, for example, if during refinement of an FBD section, you replace a variable by
a graphical link and such change is detected as an inconsistency. Indeed, the software retains
your refinement if you generate the section. Your refinement is discarded if you regenerate the
section.

Generating Facets with State Invalid

If the State of a facet (see page 423) has become Invalid after you generated it, generating the
container or Participant project again does not remove the facet from the container.
This can be the case, for example, when you link instances A and B (where instance A needs to
be linked to be valid), assign their facets to a Control project, generate the section, and then delete
the link between the two instances. The facet of instance A becomes invalid because the instance
is not linked anymore.
You need to either regenerate (see page 493) the section to which the invalid facet is assigned or
unassign the facet and generate to remove it from the section.

Function Block Layout

When you generate Control projects or sections again, the software positions function blocks that
are encapsulated in facets depending on their status:
 Facets that you had already generated and that have the following status:
 Out Of Date: Facets creating a new function block after a change in their properties. The
function block is positioned according to the layout defined by the template referencing the
facet.
 Inconsistent: Function blocks encapsulated in the facet are recreated and positioned in their
previously generated position.
For both facets, if the position of the function block is already occupied, the block is moved to
the end of the section content (Y axis), keeping its horizontal position (X axis) as defined by the
layout of the template referencing the facet.

EIO0000001114 06/2020 491

Generation Stage

 Non Generated facets:

 Single facets created through an element selection and that you have assigned to the section
after generating it: Function blocks encapsulated in the facet are positioned at the end of the
section content, on the outer left.
 Facets referenced by an instance of which no facets were previously assigned: Function
blocks encapsulated in the facets are positioned at the end of the section content while
respecting the layout as defined by the template that the instance uses.
This requires that the generation of the corresponding facets completes successfully and that the
resulting facet status is Generated.
The software manages the section size (see page 452) as needed.
For more information, refer to Section Layout Management Example (see EcoStruxure™
Process Expert, Control Participant Services, User Guide).
NOTE: To keep the constituents that are generated for an instance grouped, assign all its facets
at once.
NOTE: Certain configurable generation settings (see page 454) can affect the position of function
blocks.

Generating a Project Again

Refer to the procedure describing how to generate:
 The entire project (see page 484)
 Part of a project (see page 485)

492 EIO0000001114 06/2020

 Generation Stage

Regenerating a Control Project

Control Project Regeneration Description

This process recreates the logical Control Participant project from the beginning based on the
current settings:
 Section execution order.
 Facet execution order inside the section.
 Properties of assigned facets.

The following changes made during refinement (see page 507) are discarded by the regeneration
process:
 Any changes to the contents of sections to which facets are assigned.
 Any contents added to such sections.
 If you set the ReGenerateNonFbdSections parameter to false (see page 454):
 Non-FBD sections that you have added during refinement and their contents.
 Name changes of FBD sections that are created by the generation process.
 FBD sections that you have added during refinement, their contents and any facets that you
have assigned to these sections.
You can regenerate the entire Control project or FBD sections individually.
If the software was not able to regenerate a Control project or FBD sections of it, the status of
facets (see page 495) can vary.

Types Removed When Regenerating

The following derived types (DFBs and DDTs) are removed from the logical Control project when
you regenerate it:
 Types that were generated from facets that you have unassigned from a project section or
whose instance has been deleted.
 Types that remained after deleting the section that contained the facet that generated them.

NOTE:
In both cases, such types are not removed when you:
 Regenerate only a section of a Control project.
 Generate the Control project.

EIO0000001114 06/2020 493

Generation Stage

Actions on Facets
The table indicates the actions that the software performs on facets when you regenerate a Control
project or FBD section, based on the Assignment and Generation status of the facet.

Facet generation status

Facet assignment status Non Generated Generated Moved Inconsistent Unlinked
Assigned X X X X X
Out Of Date – X X X X
Unassigned – Del – Del –
Deleted – Del – Del –
X Creates the constituent of the facet in the Participant project
Del Deletes the facet and its already generated constituents
– Combination not applicable

Control Project Section Size

The software manages the section size (see page 452).

Execution Order and Function Block Layout

The process to regenerate the section order and section layout is the same as for a first-time
generation (see page 452), independently of the facet status.

Regenerating Control Projects Containing Non-FBD Sections

When you regenerate a Control project that contains non-FBD sections, a message appears in the
notification panel for each one of them informing you that the section was generated because of
an order change. This message, which is related to an internal process, appears even if the
position of these sections has not changed.
An exception applies to non-FBD sections that have rank 0 (Order column) when the Regenerate
command is used. For these sections, the message does not appear whether their position has
changed or not.

Aborting Regeneration of Projects And Sections

After confirming the ReGenerate command, the abort icon is displayed in the notification panel
(see page 86). Click the icon to cancel the task. The Control project or section is not regenerated;
what the software had already regenerated at the moment you canceled the task is reverted.
Refer to the notification panel for details.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are regenerating a small project or section, the task may complete before you are
able to click the icon.

494 EIO0000001114 06/2020

 Generation Stage

Regenerating the Entire Control Project

To recreate the entire logical Control Participant project, proceed as follows.

Step Action
1 Configure generation settings (see page 454) as needed.
2 In the project browser or the Containers pane of the Assignment Editor, right-click the Control
project that you want to regenerate and select ReGenerate.
Result:
 The software re-creates the logical Control Participant project. Regeneration is complete
when Completed is displayed for the process in the notification panel.
 The status of the Generation column in the Assignments pane changes to Generated for the
facets that are assigned to the project.

Regenerating an FBD Section Only

The regeneration at the FBD section level allows you to recreate the Control Participant logic for
the facets contained in the selected FBD section only.
To regenerate the logic of an FBD section, proceed as follows.

Step Action
1 In the Containers pane of the Assignment Editor, right-click the section that you want to
regenerate and select ReGenerate.
Result:
 The software re-creates the Control Participant logic of the selected section only.
Regeneration is complete when Completed is displayed for the process in the notification
panel.
 The status of the Generation column in the Assignments pane changes to Generated for the
facets that are assigned to the selected FBD section.

Facet Status After Unsuccessful Regeneration

The table describes the effect on the status of Control facets when the regeneration of a section is
not successful.

Regenerated project component Facet status

Entire Control project The generation status of facets assigned to sections that are not
regenerated (see page 450) reverts to the value it was before
regenerating.
Control project section The generation status of facets assigned to this section reverts to the
value it was before regenerating.

EIO0000001114 06/2020 495

Generation Stage

Section 15.4
Generating Equipment in Supervision Projects

Generating Equipment in Supervision Projects

Generating Equipment Based on the Application

Overview
By default, generating a Supervision project populates the equipment table of the Supervision
project based on the structure of the application (see page 173). Each instance of the application
creates one equipment instance. This allows you to view alarms during runtime in a structure
identical to the hierarchy of the application.
To create equipment names, the software may truncate the identifier of folders and instances to
comply with the format of the name field of the equipment database file.
Changes to the structure (see page 238) of the application are reflected on generated facets of the
project allowing you to update the equipment database file by generating the project again.
NOTE: To view the equipment name that is generated, refine the Supervision project and open the
equipment table.

Properties of the Equipment Table

The generation process populates the following properties of the equipment table of the
Supervision project.

Field Description
Name Instance identifier with its path in the application, satisfying the equipment naming rules for the
name field(1). The folder and instance identifiers are dot-separated.
NOTE: The system root folder identifier is not included in the name.
Cluster Identifier of the cluster of the Supervision project to which facets of the instance are associated.
Comment $Description parameter of the instance.
Area $Area parameter of the instance.
(1) The Supervision Participant does not accept the use of certain reserved words for item names (for
example, DO). While the software allows using these reserved words as identifiers of instances in the
application, doing so prevents the Supervision project from generating successfully because the reserved
word becomes the equipment name when the instance is created in the system root folder. For details on
the reserved words, look up Reserved Words in the help of the Supervision Participant (see page 104).

NOTE: You can use the Equipment element (see EcoStruxure™ Process Expert, Global
Templates, Reference Manual) to populate additional properties of equipment instances without
impacting the way the equipment name is generated.

496 EIO0000001114 06/2020

 Generation Stage

Rules Applying to the Creation of Equipment Names

The software may modify and/or truncate the identifier of folders and instances according to the
following rules to populate the Name property of the equipment table of the Supervision project.

Item Rule Comment

Folder levels 7 folders maximum not including the –
system root folder
Instance path 125 characters maximum including the –
instance identifier and dot separators
Folder identifier 12 characters maximum(1) –
length
Instance identifier 18 characters maximum(1) By default, the identifiers of instances of
length Schneider Electric templates are limited to
18 characters.
Identifiers of Can only begin with a letter. Examples:
folders Can only contain alphanumerical $Folder1 and Folder$1 are modified to
characters and underscores ( _ ). Folder1 (or Folder100 if Folder1
No spaces. already exists)
Folder 2 is modified to Folder2

(1) The software may add an indexer consisting of two digits at the end of identifiers so that the
name of each folder having the same parent folder and the name of each instance inside a folder
remain unique.
For more information on not allowed characters, refer to the topic describing naming rules
(see page 98).
NOTE: If the software truncates the instance identifier or path to satisfy the equipment name
creation rules, it displays a notification once the generation process is completed.
NOTE: The software does not change the identifier of folders and instances in the application.

Example 1 - Folder Identifier Exceeds Length

If in the Application Explorer, the following instance exists:
 Conveyor_Motor_1
 At path (folder identifiers): System_1\PlantNorthFace\Unit 20

The generated equipment name is: PlantNorthFa.Unit20.Conveyor_Motor_1

EIO0000001114 06/2020 497

Generation Stage

Example 2 - Indexing the Truncated Folder Identifier

If in the Application Explorer, the following two instances exist in two distinct folders:
 Instance_1 at the path System_1\Folder_12345_1 (the application folder name has 14
characters)
 Instance_2 at the path System_1\Folder_12345

The generated equipment names are:

 Folder_1234500.Instance_1
 Folder_12345.Instance_2

Example 3 - Number of Folders Exceeds Limit

If in the Application Explorer, the following instance exists:
 Motor_1
 At path (folder identifiers): System_1\F1\F2\F3\F4\F5\F6\F7\F8\F9

The generated equipment name is: F1.F2.F3.F4.F5.F6.F7.Motor_1

498 EIO0000001114 06/2020

 Generation Stage

Section 15.5
Generation Diagnostic Messages

Generation Diagnostic Messages

Generation Diagnostic Messages

Overview
The following tables describe some of the messages that the software displays when applicable
rules are not satisfied during the generation of Control and Supervision projects and propose
corrective actions.
In these messages and others, notifications (see page 381) that are generated by the Control
Participant may be displayed. These notifications provide more detailed information about the
reason for which the generation process did not complete successfully.

For Control Projects

Message Cause Corrective action

details
Section is The section cannot accept as Do the following to free up space:
overcrowded many function blocks as the  Move or unassign facets from the FBD section.
software is trying to generate  Change the layout of the function blocks inside the section.
inside it (see page 452).  Verify whether a comment box is preventing the software
Also, you may have changed the from adapting the size of the section (see page 452).
position of DFBs during refinement
so that the software cannot adapt Then, generate the project/section again
the size of the section to NOTE:
accommodate the function blocks. When you move DFBs inside a section, use either method:
 Position DFBs tightly together to use the full width of the grid
effectively, leaving empty rows at the bottom of the section.
 Position DFBs to use the entire height of the grid, leaving
empty columns on the right side of the section.
 You can change the section size (see page 454) by
regenerating it.

EIO0000001114 06/2020 499

Generation Stage

Message Cause Corrective action

details
Variable name A facet is generating a variable that You can do either of the following:
conflict has the same name as an already  Change the instance $Name parameter (see page 200) so
existing variable in the project. that the facet creates a variable with a different name. Then,
generate the project again.
 If you had already generated the project, refine the project
and rename or remove the existing variable. Then, generate
the project again.
 Regenerate the Control project (see page 493) in order to
remove the existing variable (for example, if you had created
the variable during refinement).
Version conflict The software is trying to generate, You can do either of the following:
in the same within the same section, a version  Update the template used by instances whose facets are
section of a DDT and/or DFB that is assigned to the section so that only one version of the same
different from the version that type is generated.
already exists in the Control  Remove the type from the project if it is not used anymore.
project.  Assign the facet that is generating the new version of the
You may have updated the type to another section.
template used by an instance
(see page 252). Generate the project again.
For details, refer to the topic describing the management of
type versions in Control facets during generation
(see page 456).
Invalid The name of a generated Edit the properties of the instance referencing the facet that is
characters constituent contains a character mentioned in the message details so that resulting variable
that is invalid for use with the names and section identifiers satisfy the naming rules
Control Participant. (see page 99), and generate the project again.

For Supervision Projects

Detected error Cause Corrective action

Unique equipment name cannot be The number of non-unique Change the folder structure of the
generated. Indexer used for uniqueness truncated folder and instance application or instance identifiers to reduce
has reached 99 (maximum limit). identifiers during generation the number of non-unique identifiers that the
exceeds 99. software creates through truncation
(see page 497).

500 EIO0000001114 06/2020

 Generation Stage

Section 15.6
Managing Generated Facets

Managing Generated Facets

Managing Generated Facets

Overview
Following the generation of the Control or Supervision project, or parts of it, you can execute
commands and actions on generated facets from the Assignments pane of the Assignment Editor.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

Generated Facets Actions

The table outlines the commands and actions that you can execute on generated facets.

Command or action Description

Unassign You can unassign facets that have the following Assignment status:
 Assigned
 Out Of Date

If you unassign a Control facet that has the generation status of Unlinked, the facet
is removed from the section but the generated constituents pertaining to the facet are
not deleted from the logical Control Participant project. If you assign this facet again
to the same project, you may receive a notification about a variable name conflict
(see page 499).
The status UnAssigned is described in Assignment Status of Generated Facets
(see page 481).
Refer to Unassigning Generated Facets (see page 503).
NOTE: The actions that the software executes when you select the Unassign
command for a generated facet or a facet that is not yet generated (see page 436)
are different.
Unlink Refer to Unlinking Generated Facets (see page 503).
NOTE: The status Unlinked is described in Generation Status of Facets
(see page 480).

EIO0000001114 06/2020 501

Generation Stage

Command or action Description

Reassign You can reassign generated facets that have the status UnAssigned.
The Reassign command assigns a facet to the container in which it is located,
allowing you to:
 Apply to the facet changes to the instance that references it.
 Generate its constituents into the logical Participant project.

The software performs a consistency check (see page 523) when available.
When the consistency check is not available, the generation status of facets changes
to Inconsistent. This is the case, for example, for Supervision genie and data facets.
Reassigning a facet changes its status to Assigned.
Refer to Reassigning Facets (see page 503).
Relink You can relink generated facets that have the status Unlinked.
The Relink command links a facet again to its already generated constituents,
allowing you to:
 Apply to the logical Participant project changes of the facet using the Generate
command.
 Detect inconsistencies by performing a consistency check.

When you relink a facet, the software performs a consistency check if the functionality
is available for the facet. Depending on the result, it changes the generation status of
the facet to either:
 Generated if it detects no inconsistency.
 Inconsistent if it detects an inconsistency.

When the consistency check is not available, the generation status of facets changes
to Inconsistent. This is the case, for example, for Supervision genie and data facets.
Refer to Relinking Facets (see page 504).
Go To Instance Allows you to go to the instance that references the facet.
The navigation feature is not available if the Assignment status of the facet is Deleted.
Refer to Navigating From Facets to Instance (see page 441).
Move Refer to Moving Generated Facets (see page 504).
NOTE: The status Moved is described in Generation Status of Facets
(see page 480).

NOTE: For a description of the effect of a subsequent generation process on the facets that you
have acted upon, refer to Generating Projects After Changes (see page 487).

502 EIO0000001114 06/2020

 Generation Stage

Unassigning Generated Facets

To unassign a generated facet from the container to which it is assigned, proceed as follows.

Step Action
1 In the Assignments pane, right-click the facet and select Unassign.
Result:
 The software unassigns the facet from the selected container.
 Its already generated constituents (for example, variables and FB instances for Control facets
and database entries for Supervision facets) are removed from the logical Participant project
(except derived data types (see page 493) for Control facets).
 The status of the facet displayed in the Assignment column changes to UnAssigned.

NOTE: You can select several facets in the same container.

Unlinking Generated Facets

To unlink a facet, proceed as follows.

Step Action
1 In the Assignments pane, right-click the facet and select Unlink.
Result:
 The software unlinks the facet from its already generated constituents.
 The status of the facet displayed in the Generation column changes to Unlinked.

NOTE: You can select several facets in the same container.

Reassigning Facets
To reassign a facet, proceed as follows.

Step Action
1 In the Assignments pane, right-click the facet and select Reassign.
Result:
 The software reassigns the facet to the same container and performs a consistency check.
 The status of the facet displayed in the Assignment column changes to Assigned or Out Of
Date.
 The status of the facet displayed in the Generation column changes to Generated or
Inconsistent (see page 480).
NOTE: You can select several facets in the same container.

EIO0000001114 06/2020 503

Generation Stage

Relinking Facets
To relink a facet, proceed as follows.

Step Action
1 In the Assignments pane, right-click the facet and select Relink.
Result:
 The software links the facet again to its generated constituents in the logical Participant project.
 The status of the facet displayed in the Generation column changes to Generated or
Inconsistent (see page 480).
NOTE: You can select several facets in the same container.

Moving Generated Facets

To move a facet from one container to another, proceed as follows.

Step Action
1 In the Assignments pane, right-click any one of the column headers and select the appropriate
command to clear filters and sorting (see page 138).
2 In the Assignments pane, drag the facet to another container in the Containers pane.
Result:
 The software removes the facet from its original location and assigns it to the target container.
 The status of the facet displayed in the Generation column changes to Moved.

NOTE: You can select several facets in the same container.

NOTE: Control facets that you move are assigned to the new section with the highest order value
in the Order column of the Assignments pane (see page 423). If you move several facets at once,
the facet that you have selected first gets the lowest order out of the ones that are moved.
NOTE: After you have moved a generated facet from one container to another, generate
(see page 488) the target container again to update the associated logical Participant project.

504 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Refinement Stage
EIO0000001114 06/2020

Chapter 16
Refinement Stage

Refinement Stage

Overview
This chapter describes how to modify the logical Participant projects that the software has created
during the generation stage to fulfill the requirements of the system.
The refinement stage is not mandatory to be able to proceed to the next stage.
The following figure shows the position of the Refinement stage within the system engineering life
cycle.

Refer to Refinement Stage (see page 56) for a description of the purpose of this stage.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
16.1 Control Project Refinement Stage 506
16.2 Supervision Project Refinement Stage 543

EIO0000001114 06/2020 505

Refinement Stage

Section 16.1
Control Project Refinement Stage

Control Project Refinement Stage

What Is in This Section?

This section contains the following topics:
Topic Page
Refining the Logical Control Project 507
Identifying Code Generated by the Software 514
Creating and Updating Device DDT Variables in Logical Control Projects 517
Managing Consistency 523
About Variables for Peer to Peer Communication 527
Managing Network Variables 538

506 EIO0000001114 06/2020

 Refinement Stage

Refining the Logical Control Project

Overview
You can refine at the project level, which allows you to view and modify the entire logical Control
project with the help of the Control Participant.
You can also refine specific sections only by launching the refinement process from a section
(except for LL984 sections). The section does not need to be generated to be refined.
You can import LL984 sections (see EcoStruxure™ Process Expert, Control Participant Services,
User Guide).
FBD and non-FBD sections that you add during refinement are displayed in the Control project
(Assignment Editor) in the order they appear in the Control Participant. The contents of these
sections is not displayed there however.
Once refinement is complete, you can request the software to perform a consistency check
(see page 523).
At the refinement stage, you can also create and manage network variables (see page 527), which
are used for peer to peer communication.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

EIO0000001114 06/2020 507

Refinement Stage

Project Refinement Window

The figure shows the Refine Offline window embedding the Control Participant, which opens when
you select the Refine command at the Control Participant project level. The window is shown
restored.

1 Tab of the pane in which you can see the project sections in relation to the structure of the
application
2 Manage network variables button
3 Access device DDTs of unmapped hardware button
4 Check consistency button
5 Save button

508 EIO0000001114 06/2020

 Refinement Stage

Section Refinement Window

The figure shows the Refine Offline window embedding the Control Participant, which opens when
you select the Refine command at the section level. The window is shown restored.

1 Tab of the Control Participant window.

2 Tab of the section refinement window.
3 Tab of another refinement window (for example, a DFB refinement window), which you have
opened from the section that is being refined.
4 Tab of another window that is open in the Project Explorer.

EIO0000001114 06/2020 509

Refinement Stage

NOTE:
 To switch between open refinement windows, use the tabs at the bottom of the Participant
window.
 To close a refinement window, right-click its tab and select Close Window.

Viewing the Application Structure When Refining Control Participant Projects

While you refine a Control Participant project, the Application Browser pane displays FBD sections
based on the location of instances whose Control facets are assigned to these sections.
It shows the relationship between the folder structure of the application and the sections of the
Control Participant project. This is useful, for example, when you want to view the logic related to
a specific area or subdivision of the application. You can open sections from the pane.
The pane only shows FBD and non-FBD sections that exist in the logical Control Participant project
at the moment you select the Refine command.
For a general description of the contents of the pane, refer to the topic describing the application
structure view (see page 429).
For information on how to use the pane, refer to the topic describing the refinement of Control
Participant projects (see EcoStruxure™ Process Expert, Control Participant Services, User
Guide).
For general information on how to work with panes, refer to the topic describing the engineering
client workspace (see page 127).

Applying Changes to Generated Control Participant Projects

Selecting the Refine command applies to the logical Control Participant project the following
changes that you have made in the Project Explorer to an already generated Control project:
 Renaming a section.
 Creating an FBD section.
 Changing the order of sections.

If the status of the executable of the Control project is Built, it is set to Out Of Date.
NOTE: You do not need to click the save button in the Control Participant window to apply the
above mentioned changes.

510 EIO0000001114 06/2020

 Refinement Stage

Validity Indicators
When you save the logical Control Participant project during refinement and project analysis is
enabled (see page 308), the project is analyzed (see page 449). The status of the project is
indicated by the validity icons (see page 378).
Details of the analysis are shown in the Analyze Project tab of the Control Participant window while
it is still open.
If the logical Control project is not open in the Participant and the validity icon is displayed, you
need to refine the Control project and analyze it. This allows you to identify the cause of the invalid
status. The Control Participant features tools that help you identify validity issues, which result in
an unsuccessful build (see page 691).
For information on troubleshooting Control projects and/or analyzing them, refer to the help of the
Control Participant.
NOTE: This verification is performed also when you generate a logical Control project
(see page 449).

Deleting Sections During Project Refinement

The table describes the result when you delete sections during refinement and the action that you
need to perform to complete the deletion process depending on the type of section.

Type of section Result after saving changes and closing Required action
the Control Participant window
Non-generated FBD section that was The section still appears in the Right-click the section in
created in the Project Explorer. Containers pane but below other existing the Containers pane and
Non-generated FBD section that was sections (higher order value)(1). select Delete.
created during refinement.
Any non-FBD section.
(1) LL984 segments deleted during refinement appear in last position (highest order value)

Refining Non-Generated Sections

When you refine an FBD section to which facets are assigned but that is not generated yet, you do
not see the constituents of these facets in the Control Participant.
If you add logic to this section during refinement, when you generate the section or project
(see page 449), DFBs that you have added are not moved, and DFBs coming from assigned facets
are laid out around them.

EIO0000001114 06/2020 511

Refinement Stage

Refining at the Control Project Level

To refine the logical Control project, proceed as follows.

Step Action
1 In the Project Explorer, right-click the Control project you want to refine and select Refine.
Result: The Control Participant opens extracted (see page 134) and maximized.
2 Proceed with the refinement.
For more information on the refinement process, refer to Refining the Logical Control Participant
Project (see EcoStruxure™ Process Expert, Control Participant Services, User Guide).
3 Click the save button in the toolbar of the Participant window to save the changes in the logical
Control Participant project.

4 Perform a consistency check (see page 526) if required.

5 Click the close button in the Control Participant window.
NOTE:
If you have unsaved changes and click the close button in the Participant window, the software
displays the Save Refinement dialog box where you have the following choices:
 Yes: Saves changes in the logical Control Participant project and closes the Participant window.
 No: Discards changes and closes the Participant window.
 Cancel: Does not save changes and leaves the Participant window open.

512 EIO0000001114 06/2020

 Refinement Stage

Refining at the Section Level

To refine a section of the Control project (except for LL984 sections), proceed as follows.

Step Action
1 In the Containers pane of the Assignment Editor, right-click the section that you want to refine and
select Refine.
Result: The Control Participant opens extracted (see page 134) and maximized and displays only the
contents of the selected section.
2 Proceed with the refinement of the section.
For more information on the refinement process, refer to Refining the Logical Control Participant
Project (see EcoStruxure™ Process Expert, Control Participant Services, User Guide).
3 Click the save button in the toolbar of the Participant window to save the changes in the logical Control
project.

4 Perform a consistency check (see page 526) if required.

5 Click the close button in the tab of the Control Participant window.
NOTE:
If you have unsaved changes and click the close button in the Participant window, the software
displays the Save Refinement dialog box where you have the following choices:
 Yes: Saves changes in the logical Control Participant project and closes the Participant window.
 No: Discards changes and closes the Participant window.
 Cancel: Does not save changes and leaves the Participant window open.

EIO0000001114 06/2020 513

Refinement Stage

Identifying Code Generated by the Software

Overview
Constituents that are generated from facets assigned to Control projects are locked in the Control
Participant project. The locked code is color coded in the DFB editor of the Control Participant.
This feature helps you:
 Distinguish code generated by the software from code that you modify and/or add during
refinement.
 Avoid modifying code generated by the software inadvertently and maintain consistency. This
is achieved by requiring a confirmation before unlocking code and providing the possibility to
lock code again.
Locking of code is managed by the software throughout the system engineering life cycle.

Viewing Locked Code

The following figure shows an example of a Control Participant refinement window showing an
FBD section, which contains code that was generated by some sample facets assigned to the
section.

1 Code that is generated from the facet is locked and shown in purple.
2 Variable that was added by the user during refinement to code generated by the software. The
code is not locked and shown in black.
3 Literal, previously shown in purple that was unlocked and changed by the user and now shown
in black.
4 Link, previously shown in purple that was unlocked by the user and now shown in black.

514 EIO0000001114 06/2020

 Refinement Stage

Code that Is Locked

The following data is locked when generated from facets assigned to a Control project:
 DFBs and the pins to which an effective parameter is assigned.
 Effective parameters.
 Links (including links created by using the Links Editor).
 EFB and DFB instances.

NOTE: FBD sections that you have generated are also locked but without visual indication.

Code that Is not Locked

The following data is not locked:
 Non-FBD sections.
 Pins of DFBs to which no effective parameter is assigned or that are not connected.
 Formal parameters of DFBs.
 Variables shown in the Data Editor of the Control Participant.
 Any code added by the user during refinement offline and online.
 FBD sections that are generated but to which no facets are assigned.

Modifying Locked Code During Refinement

To modify locked code during refinement offline and online, you need to unlock it first
(see EcoStruxure™ Process Expert, Control Participant Services, User Guide).
For example, changing the parameter that is assigned to the pin of a generated DFB.
However, adding code that does not modify generated code can be done without unlocking. For
example, assigning a parameter to an empty pin of a generated DFB or adding an EFB in a section
containing generated code.
NOTE: You cannot delete FBD sections that are locked.

Management of Locked Code in the System Engineering Life Cycle

The fact that code is locked is part of its attributes and managed by the software during the system
engineering life cycle.
As such, unlocking code is detected as an inconsistency during a consistency check
(see page 523) even if the code itself is unchanged. The status of the facet that generated the code
is set to Inconsistent.
Code that was originally locked and that you have unlocked is:
 Locked again when the facet is generated and either condition applies:
 The status of the facet is Inconsistent.
 No consistency check was performed but the contents of the section was modified
(see page 489).
 Detected when you use the following commands:
 Deploy Changes / Undo Online Changes
 Update Control Project

EIO0000001114 06/2020 515

Refinement Stage

Considerations when Migrating Databases

When you refine a Control project of a database that was migrated from a previous version of the
software, code generated by the software may not be locked.
However, you can enable the code locking feature for such code in a migrated database if you
perform a consistency check and generate the Control project.
Code generated from facets that are assigned to Control projects after the migration is locked.
The table describes the impact on code that is generated by the software and contained in a
migrated database depending on the action that you perform and the status of facets.

Actions performed after Status of facets assigned to Result after generating the Control projects
migration Control projects in the migrated
database
No consistency check Generated or Unlinked. No change.
was performed.
Non Generated, Out Of Date, or The code of facets that were successfully
Inconsistent. generated is locked.
FBD sections containing at least one such
facet are locked.
A consistency check is All facets are set to Inconsistent. The code of facets that were successfully
performed. generated is locked.
FBD sections containing at least one such
facet are locked.

NOTE: If you use the Regenerate command on the Control project after migrating the database,
code that was generated by the software before the migration is locked even if you have not
performed a consistency check.

516 EIO0000001114 06/2020

 Refinement Stage

Creating and Updating Device DDT Variables in Logical Control Projects

Overview
In the system engineering life cycle, the software lets you engineer Control projects independently
of the hardware that exists in the topology up to the build stage. As a result, device DDT variables,
which are associated to hardware modules and managed by the Control Participant are not readily
available when you refine a logical Control project offline.
This functionality lets you create in the logical Control project device DDT variables that are
associated to the hardware present in the topology of the system. This makes it possible to use
device DDT variables in the program during refinement offline, for example, to manage special
modules or access hardware diagnostic data.
Using device DDT variables does not replace hardware mapping. Device DDT variables do not
appear in the Hardware Mapping Editor.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

Device DDT Variables Present in the Control Project by Default

When you create a Control project of the M580 platform in the Project Explorer, it contains a default
configuration with only a controller (although it is not to be used from the Project Explorer at this
stage of the system engineering life cycle). Therefore, by default, the logical Control Participant
project already contains the device DDT variable that is mapped to the M580 CPU module (a lock
icon appears next to the DDDT variable). You can use it by refining the logical Control project.

Prerequisites
The topological entities whose device DDT variables you want to create must exist in the topology
of the system.

Accessing the Device DDT Variable Wizard

To open the wizard, refine the Control project and click the device DDT wizard button
(see page 508).

EIO0000001114 06/2020 517

Refinement Stage

Device DDT Variable Wizard - Controller Selection

Item Description
1 Box to select the controller whose device DDT variables you want to create in the logical Control
project.
2 When the check box is selected, the menu shows only the controllers that are service mapped
to an executable of the Control project. Otherwise, it shows the controllers that exist in the
topology of the system.
3 Proceeds to the next screen and locks the controller in the Topology Explorer so that no other
user can change its configuration or delete it.

518 EIO0000001114 06/2020

 Refinement Stage

Device DDT Variable Wizard - Device DDT Variable Selection

Item Description
1 Candidate pane that shows device DDT variables of the controller that you have selected and
that you can create in the logical Control project. The following can be shown:
 Variables that do not exist in the logical Control project yet.
 Variables and types that already exist but which have been modified in the controller.

NOTE:
The following variables do not appear in the candidate pane:
 Device DDT variables of the M580 CPU (see page 517).
 Device DDT variables that already exist in the logical Control project with the same name but
with a different type. This can be the case, for example, if after having created the device DDT
variable for hardware module 1, you remove this module in the topology, add hardware
module 2, which creates a device DDT variable of a different type, and rename this device
DDT variable to have the same name as the variable that was associated to hardware
module 1.
2 Selected variables panes that shows the device DDT variables that you have selected.

EIO0000001114 06/2020 519

Refinement Stage

Item Description
3 Filter icon (see page 138).
4 Name of the device DDT variable.
5 Data type of the device DDT variable.
6 Either action appears for each device DDT variable:
 Create: Creates (see page 520) the data type and the variable in the logical Control project.
 Update: Updates (see page 520) the data type in the logical Control project.

7 Notification area.
Expand the area to view alerts on device DDT variables of the selected controller.
8 Reverts to the previous screen.
To be able to select device DDT variables from another controller, you need to complete the
process for your current selection first. Any selection that you have not applied is discarded.

Impact of the Create Action on the Logical Control Project

The table describes the impact when you create in the Logical Control Project a device DDT
variable that appears in the candidate pane with the Create action. The impact varies depending
on the scenario.

Scenario Impact of the Create Action

The variable and the type are not yet present in Both are created in the logical Control project.
the logical Control project.
A type of the same name already exists in the The variable is created.
logical Control project but not the variable. If the structure of the type of the selected variable is
different, it overwrites the type that is present in the
Control project. This may impact other existing variables
of that type.

Impact of the Update Action on the Logical Control Project

The table describes the impact when you update in the Logical Control Project a device DDT
variable that appears in the candidate pane with the Update action. The impact varies depending
on the scenario.

Scenario Impact of the Update Action

The variable and the type already exist in the The structure of the type is updated in the logical Control
logical Control project but the structure of the project. This may impact other existing variables of that type.
selected type is different.
The variable and the type already exist in the The version of the type is updated in the logical Control
logical Control project but the version of the project. This may impact other existing variables of that type.
selected type is different.

520 EIO0000001114 06/2020

 Refinement Stage

Creating or Updating Device DDT Variables

To create or update device DDT variables in the logical Control project, proceed as follows.

Step Action
1 In the device DDT variable wizard, select the controller whose device DDT variables you want
to create or update and click Next.
2 Expand the notification area to view alert messages.
3 In the candidate pane, select one or more device DDT variables that you want to create/update
and click OK.
Result: The selected device DDT variables are processed by applying the corresponding action
for each and the wizard is closed.
4 Save changes by clicking the save button (see page 508) in the toolbar of the Control
Participant window frame.

Modifying Device DDT Variables

Device DDT variables that you create in the logical Control project are not locked and you must not
modify their structure or name. If you do, the software cannot treat them anymore as device DDT
variables associated to the device from which they were created originally.

Deleting Device DDT Variables

You cannot remove a device DDT variable and/or its data type from the logical Control project by
using the device DDT variable wizard.
To remove the variable, select it in the Control Participant window while refining the logical Control
project and select Delete. Then, purge the type by using the Types Library manager

Considerations When Removing Modules in the Topology Explorer and Deploying Changes
When the topology of the system contains entities and you had created the corresponding device
DDT variables in the logical Control project, built the project, and deployed it, if you delete the
source of the device DDT variable from the topology (for example, a module or DTM), verify that
the corresponding device DDT variable is removed in the configuration of the Topology Explorer.
If not (for example, when you delete an analog input module), you need to purge the corresponding
device DDT variable.
Otherwise, if you build the logical Control project after removing the source of the device DDT
variable from the topology, it remains in the built Control project as unmapped variable (while it is
present in the deployed Participant project as mapped variable). If you deploy changes, the
software proposes to add the unmapped device DDT variable.

EIO0000001114 06/2020 521

Refinement Stage

Integrating Device DDT Variables in the System Engineering Life Cycle

To use device DDT variables that you have created logical Control project, follow the stages of the
system engineering life cycle described in this manual (build (see page 691), build changes
(see page 697), deployment, deployment of changes (see page 766), refinement online, and so
on).

Using Device DDT Variables in the Supervision Runtime

Device DDT variables do not have the HMI attribute enabled. To use such a variable in
Supervision, you need to connect it to the input pin of a DFB encapsulated in a template that
features Supervision services.

522 EIO0000001114 06/2020

 Refinement Stage

Managing Consistency

Overview
Consistency management is a process that encompasses the following steps:
 Launching the consistency check of a logical Control Participant project or FBD section of such
project.
 Indicating if the constituents of facets that the software has generated in such project or FBD
section are not consistent with the related facets that are assigned to the Control project or
section. In such case, a message informs you of the detected inconsistencies and the
Generation status of the related facets is changed to Inconsistent. Otherwise, the software
informs you that it did not detect an inconsistency.
 Attempting to fix the detected inconsistencies by restoring the constituents inside the logical
Control Participant project or FBD section to a state that is consistent with the related facets of
the Control project or section.
The purpose of consistency management is to provide means for you to know whether changes
that you have made during refinement affect the logical Control Participant project that was created
during generation and, if desired, to fix inconsistencies when it is possible without modifying the
refinements you made.
The software performs a consistency check in the following way when you:
 Generate again an already generated Control project or FBD section: Depending on the
changes you have made (see page 489).
 Reassign (see page 501) a facet with the status UnAssigned: Automatically (if available).
 Relink (see page 501) a facet with the status Unlinked: Automatically (if available).
 Update the logical Control Participant project (see page 841): On request.

NOTE: The software does not perform consistency checks on facets that have the Unlinked status
(see page 480).

EIO0000001114 06/2020 523

Refinement Stage

Rules for Consistency Checks

The table indicates in which cases the software detects and reports an inconsistency when
performing a consistency check on constituents that the software has generated in a logical Control
Participant project. It also indicates the resulting status of the facet encapsulating the constituent.

Type Change made through refinement Generation status of the facet

Derived data (DDT) Any change resulting in a new version of the type(1)
. Changes to Inconsistent.
and function block
Change causing no version change but resulting in a
(DFB) types
new type or code signature(1).
Variables Changing an attribute of a variable.
Removing markers created by the software (for
example P2P).
FBD sections Changing function calls (EFs, EFBs, or DFBs) in an
FBD section.
Changing the relative execution order of function No change.
blocks (EFs, EFBs, or DFBs).
Changing links. Includes changing immediate values Changes to Inconsistent.
and links between variables.
– Unlocking locked data (see page 514). Changes to Inconsistent.
(1) The change may also have been made by encapsulating a modified type in a Control facet and updating
the template with this facet. However, starting with Process Expert 4.2 SP2, the software does not allow
you anymore to save modifications to the type encapsulated in a Control facet if the version of the type
is still the same but its type or code signature different.

524 EIO0000001114 06/2020

 Refinement Stage

Check Consistency Dialog Box

The figure shows an example of the Check Consistency dialog box.

1 Check box to select all FBD sections and facets that appear in the two categories of the dialog
box. By default no section or facet is selected.
2 Category listing FBD sections containing facets for which inconsistencies related to their DDT
and DFB types have been detected. Select the check box to select all sections and facets that
appear in this category.
3 Category listing FBD sections in which inconsistent facets have been detected. Select the check
box to select all sections and facets that appear in this category.
4 Name of a type for which an inconsistency has been detected. Expand the node to view the
facets generating this type and the sections to which these facets are assigned.
5 Identifier of a section to which facets are assigned, which are inconsistent. Expand the node to
view the facets.
6 Description of the detected inconsistency.
7 Unlinks the selected facets so that no consistency check is performed on them.

EIO0000001114 06/2020 525

Refinement Stage

8 Copies the content of the dialog box to the Clipboard in text format. The status of check boxes
is not copied.
9 Cancels your selection and closes the dialog box.
NOTE: When a section or facet appears in both categories, selecting it in one category
automatically selects it in the other, and the other way around, clearing its selection in one category
automatically clears it in the other.

Performing a Consistency Check

To perform a consistency check on generated constituents, proceed as follows.

Step Action
1 In the Project Explorer, right-click the Control project or FBD section that you want to check for
consistency and select refine.
Result: The Control Participant opens in a reduced window.
2
In the toolbar of the window, click the check consistency button .
Result: The software:
 Performs a consistency check.
 Opens the Check Consistency dialog box.
 Changes the Generation status of facets referencing inconsistent constituents to
Inconsistent.
NOTE: The check consistency button is not available when you refine a non-FBD section.
3 In the Check Consistency dialog box, select inconsistent sections and/or facets that you want to
unlink.
4 Click Unlink to unlink the selected facets.
NOTE: Click Cancel to close the Check Consistency dialog box without unlinking facets. The
status of facets that the software has detected as inconsistent remains Inconsistent.

Managing Inconsistencies
Even though a logical Control Participant project contains inconsistent facets, you can proceed
further in the system engineering life cycle.
Regenerate the FBD section or project containing inconsistent facets to revert to a consistent state,
which is indicated by the generation status Generated of the facet but certain changes that you
made through refinement are discarded (see page 493).
For information on managing inconsistencies without affecting changes made through refinement,
refer to Generating Inconsistent Facets (see page 491).

526 EIO0000001114 06/2020

 Refinement Stage

About Variables for Peer to Peer Communication

Overview
The software facilitates the creation of variables to exchange scattered data or sets of data
between two or more Control Participant projects by using peer to peer communication. Such
variables are called network variables.
You can create network variables in the following ways:
 By assigning facets of instances to different projects.
 By refining both logical Control Participant projects. Refer to Refining the Logical Control
Participant project (see EcoStruxure™ Process Expert, Control Participant Services, User
Guide).
 By instantiating peer to peer templates in the application.
 By using a mix of the above.

Depending on the way that you use to create them, network variables have the candidate status
until they are explicitly created for use as network variables by using the Manage Network
Variables dialog box (see page 538).
You can create network variables before proceeding with the service mapping and the creation of
communication channels (see page 630).
Variables used for peer to peer communication are allocated during build (see page 693) based on
the network variable mapping (see page 645).
NOTE: For more information on the steps to implement peer to peer communication by using the
I/O scanner function, refer to the topic describing peer to peer communication by modbus TCP
Ethernet implicit messaging (see page 855).

Owner/Consumer Project Principle

To help you understand the way peer to peer communication is implemented in the software, this
manual uses a particular naming convention to refer to the Control Participant projects that
exchange data.
The logical Control Participant project producing the variables to be shared is the owner project,
and the one receiving the variables is the consumer project.
The controller that is mapped to the owner project acts as the server. The one mapped to the
consumer project acts as the client.
A network variable allows you to read data from the server by mapping it to a communication
channel that exists client-side.
NOTE: You can write data to the server by using a network variable that exists in the owner project
and the corresponding variable of same name and type in the consumer project.

EIO0000001114 06/2020 527

Refinement Stage

The following example illustrates the owner/consumer principle in a system where sample
variables DISignal_UL_1V and Valve_1_VALVE_OPV are used for peer to peer communication
to read from and write to the server respectively. The variables are generated by facets of the
DISignal_UL_1 and Valve_1 sample instances respectively. The specific attributes of the
variables of reference data type are shown. The two instances are linked and their facets are
assigned to the Owner_Project and Consumer_Project Control Participant projects. The
executable of each project is mapped to the corresponding topological entity. The read from server
and write to server actions are performed from the consumer (client) project.

528 EIO0000001114 06/2020

 Refinement Stage

Ways to Create Network Variables to Share Scattered Data One-to-One

The first two scenarios that are shown in the following figure illustrate two common ways to create
a network variable to share scattered data between an owner and a consumer project. Other ways
to create network variables exist (see page 536).

Scenario Description
1 When the instance in the owner project creates a variable (for example, an instance of a
hardware abstraction layer (HAL) template), it can be linked directly to the input pin of a DFB
(created, for example, by an instance of an application template) in the consumer project.
2 When the instance in the owner project does not create a variable (for example, an instance of
an application template), the output pin needs to be linked first to an instance of a peer to peer
communication template (for example, Data Out) in the owner project.
The Data Out instance creates a variable, which can be linked directly to the input pin of a DFB
(created, for example, by an instance of an application template) in the consumer project.
3 In the first two scenarios, only a network variable candidate is created. You need to create the
network variable manually by using the Manage Network Variables command (see page 538).
This third scenario shows how to create the network variable automatically by using two peer
to peer communication templates (Data Out and Data In).

EIO0000001114 06/2020 529

Refinement Stage

The following example shows how to implement the first scenario by using sample instances and
linking them in the Links Editor. Facets of each instance are then assigned to the owner and
consumer projects.

The following example shows how to implement the second scenario by using sample instances
and linking them in the Links Editor. Facets of each instance are then assigned to the owner and
consumer projects.

530 EIO0000001114 06/2020

 Refinement Stage

The following example shows how to implement the third scenario by using two peer to peer
communication templates to create the network variable automatically. Instances are linked in the
Links Editor. The view has been modified to be able to show all four instances at once.

Ways to Create Network Variables to Share Scattered Data One-to-Many

The following figure illustrates the use of Data In and/or Data Out application templates to share
one variable exposed by one owner project with three different consumer projects of the same
system.

EIO0000001114 06/2020 531

Refinement Stage

This example illustrates the scenario by using sample instances and linking them in the Links
Editor. Facets of each instance are then assigned to the owner and the three consumer projects.

NOTE: The view has been modified for better visualization. You cannot see the connections in the
Links Editor as shown above.

532 EIO0000001114 06/2020

 Refinement Stage

Ways to Create Network Variables to Share Sets of Data

The following figure illustrates the use of owner and consumer application templates to share
physical signals:
 Without signal conditioning.
 With signal conditioning by using a HAL template.

NOTE: In both cases, the physical signals are linked to the owner template and the HAL templates
respectively by using mapping interfaces (dotted lines) during the hardware mapping.
For more information on owner/consumer templates and a usage example, refer to the topic
describing these templates (see EcoStruxure™ Process Expert , Foundation Application
Templates, User Guide).

EIO0000001114 06/2020 533

Refinement Stage

Properties of Variables for Peer to Peer Communication

Certain attributes of variables that you create through refinement to be mapped to peer to peer
communication channels require a specific configuration.
The configuration varies depending on:
 Whether the variable is used to read from the server or write to the server (see page 527).
 The platform or the communication module that is used by the topological entity acting as client.

The table describes required variable attribute values in the Control Participant when the
topological entity acting as client communicates by using a Quantum CPU module or an NOE
communication module (with Quantum or M340 platform).

Usage Variable attribute Owner project/Server Consumer project/Client

Reading Designation of the variable in the Variable Network variable
data from context of EcoStruxure
the server Process Expert
Name Any valid name Same name
Type Any, including the Reference Same type
data type (REF_TO).
Some restrictions apply
(see page 538).
Custom Blank P2P

Constant (1) True (selected) True (selected)

R/W Rights of Referenced True (selected) False (cleared)
Variable(1)
Writing data Designation of the variable in the Network variable Variable
to the server context of EcoStruxure
Process Expert
Name Any valid name Same name
Type Any, including the Reference Same type
data type (REF_TO).
Some restrictions apply
(see page 538).
Custom P2P Blank
Constant (1) True (selected) True (selected)
R/W Rights of Referenced True (selected) True (selected)
Variable(1)
(1) For variables of the Reference data type (REF_TO) only

534 EIO0000001114 06/2020

 Refinement Stage

The table describes required variable attribute values in the Control Participant when the
topological entity acting as client communicates by using an M580 CPU module with or without
NOC communication module, or a Quantum controller with NOC communication module.

Usage Variable attribute Owner project/Server Consumer project/Client

Reading data Designation of the variable in the Variable Network variable
from the server context of EcoStruxure Process Expert
Name Any valid name Same name
Type Reference data type Same type
(REF_TO) only
Custom Blank P2P
Constant True (selected) True (selected)
R/W Rights of Referenced Variable True (selected) False (cleared)
Writing data to Designation of the variable in the Network variable Variable
the server context of EcoStruxure Process Expert
Name Any valid name Same name
Type Reference data type Same type
(REF_TO) only
Custom P2P Blank
Constant True (selected) True (selected)
R/W Rights of Referenced Variable True (selected) True (selected)

NOTE: For more information on the REF_TO data type, refer to the topic describing the refinement
of Control projects (see EcoStruxure™ Process Expert, Control Participant Services, User Guide).

EIO0000001114 06/2020 535

Refinement Stage

Overview of Ways to Create Network Variables

The table provides an overview of the different ways to create network variables in the consumer
project to read data from the controller of the owner project, acting as server. It also indicates the
status of the variable for each method.

Action in owner project Action in consumer project Status of variable

Instantiate a Data Out - Once you generate both projects, the
template corresponding to the Manage Network Variables dialog box
data type to be shared (for detects the variable as a network variable
example, $DOUTBool_UL to candidate in the consumer project, with the
share a boolean variable of name of the Data Out template instance.
the REF_TO ANY_BOOL data Create the network variable
type). (see page 538).
Instantiate a Data In template The generation process creates a network
corresponding to the data type of the variable in the consumer project with the
Data Out template (for example, name of the Data Out template instance.
$DINBool_UL).
NOTE: The Manage Network Variables
dialog box shows the variable in the Existing
Network Variables pane.
Instantiate a peer to peer Instantiate a peer to peer consumer The generation process creates a network
owner template template matching the peer to peer variable in the consumer project with the
corresponding to the data owner template (for example, name of the owner template instance.
type to be shared (for $Bool16INC to receive up to
NOTE: The Manage Network Variables
example, $Bool16INO to 16 boolean input signals). dialog box shows the variable in the Existing
share up to 16 boolean input Network Variables pane.
signals of the REF_TO data
type).
Instantiate a template, which Reference a variable of the same name The Manage Network Variables dialog box
creates a variable during the and data type as the one created by the detects the variable as a network variable
generation process (for instance in the owner project without candidate in the consumer project.
example, a variable of type declaring it by using the Refine Create the network variable
REF_TO ANY_BOOL(1)). command. (see page 538).
Instantiate a template that receives the
variable exposed by the instance in the
owner project by creating a link
between both templates in the Links
Editor.
Create a variable of the same name and The Manage Network Variables dialog box
data type as the one created by the shows the variable in the Existing Network
instance in the owner project, and enter Variables pane.
P2P as Custom attribute by using the
Refine command.

536 EIO0000001114 06/2020

 Refinement Stage

Action in owner project Action in consumer project Status of variable

Create a variable(1) to be Reference a variable of the same name The Manage Network Variables dialog box
shared by using the Refine and data type without declaring it, using detects the variable as a network variable
command. the Refine command. candidate in the consumer project.
Create the network variable
(see page 538).
Create a variable of the same name and The Manage Network Variables dialog box
data type, and enter P2P as Custom shows the variable in the Existing Network
attribute by using the Refine command. Variables pane.

(1) Verify that the data type of the variable that is created meets the requirements to be used for
peer to peer communication (see page 534).
NOTE:
 The table does not detail each step required to implement peer to peer communication. For
more information, refer to Peer to Peer Communication Through Modbus TCP Implicit
Messaging (see page 865).
 To be detected and/or created as network variables by the Manage Network Variables dialog
box, variables need to satisfy the network variable management rules (see page 538).

Overview of Peer to Peer Templates

The following templates are available from the Global Templates library to create network
variables:
 Data IN/Data OUT: Application facet templates that create a network variable in the consumer
project. The library contains templates for sharing various variable sizes and data types. Use
these templates to share scattered data.
For a detailed description of the templates and how to use them, refer to Data In/Data Out
Templates (see EcoStruxure™ Process Expert , Foundation Application Templates, User
Guide).
NOTE: To find these templates by using the template browser of the Application Explorer, select
the Facets filter (see page 179), and enter either din or dout in the search field.
 Owner/Consumer: Application composite templates that create a network variable in the
consumer project. The library contains templates for sharing up to 16 digital and 8 analog
inputs/outputs. Use these templates to share sets of data. Typically, such templates allow you
to manage I/O objects exchanged between a Modicon BMX PRA module and a master
controller.
For a detailed description of the templates and how to use them, refer to Owner/Consumer
Templates (see EcoStruxure™ Process Expert , Foundation Application Templates, User
Guide).
NOTE: Network variables created by using peer to peer templates have the Custom attribute set
to P2P by default in the variable properties window of the Control Participant.

EIO0000001114 06/2020 537

Refinement Stage

Managing Network Variables

Overview
This topic describes how to use the Manage Network Variables dialog box to manage network
variables, which exist or have the candidate status.
Network variable management includes the creation, modification, and deletion of network
variables.

General Network Variable Management Rules

The software applies either of the following rules to identify candidate network variables when you
open the Manage Network Variables dialog box:
 The variable needs to be referenced from, at least, 1 FBD section but not be declared.
 The variable is created by using a peer to peer template (see page 529).

In addition, the following are not considered network variable candidates:

 Variables referencing an element of a data structure (for example, DigitalInput_DIN-
PUT_ST.STW where STW is a word of the DINPUT_ST structure).
 Function block instances (for example, DigitalInput_DINPUT.PV where PV is a formal
parameter of the DINPUT DFB).
 Types ANY_X where X represents the type (except for the ANY_BOOL data type).
 Inconsistent types (for example, a.b where a and b are variables and one of them is undefined).
 32-bit data types.

NOTE: In the Manage Network Variables dialog box, it is not taken into account whether the data
type of the variable is compatible with the communication module client-side (see page 534).

Network Variable Properties

Network variables that the software creates by using the Manage Network Variables dialog box
have the following properties:
 They are of the same type as shown in the Type field of the Network Variables Candidates
section.
 They have P2P as Custom attribute in the variable properties window of the Control Participant.

NOTE: The software does not set the R/W Rights of Referenced Variable attribute for REF_TO
type network variables that it creates. If it needs to be enabled, you need to refine the consumer
project and set the attribute manually (see EcoStruxure™ Process Expert, Control Participant
Services, User Guide) in the variable properties window of the Control Participant.

538 EIO0000001114 06/2020

 Refinement Stage

Opening the Manage Network Variables Dialog Box

You can open the Manage Network Variables dialog box either way:
 From the context menu of the Control Participant project in the Project Explorer by selecting
Manage Network Variables.

 From within the Control Participant by clicking the button (see EcoStruxure™
Process Expert, Control Participant Services, User Guide). When you refine at the section level,
the button is available only for FBD sections.
Both commands open the Manage Network Variables dialog box. The difference lies in the way
you save changes.

Manage Network Variables Dialog Box

The following figure shows an example of the Manage Network Variables dialog box in which
several sample variables appear.

1 Network Variables section showing existing network variables.

2 Network Variable Candidates section showing the candidate variables that the software has detected in
the selected project. These variables satisfy the applicable rules and you can them use as network
variables. Certain restrictions apply depending on the communication module used by the topological entity
acting as client.

EIO0000001114 06/2020 539

Refinement Stage

Fields of the Network Variables section.

Header Description
Action  Left/right arrow icon: Existing network variable.
 Minus icon: The variable will be removed from the project.
 Plus icon: The variable will be added to the project.
 Pencil icon: The variable will be modified in the project.
 Lock icon: The variable is already mapped to a peer to peer communication channel in the
communication mapping (see page 630).
Name Identifier of the variable.
The field is editable (see page 542).
Type Data type of the variable
Comment You can enter a comment for the variable using free form text.

Fields of the Network Variable Candidates section.

Header Description
Name Identifier of the variable.
When you use HAL or peer to peer templates, the name of the variable is the identifier of the
template instance.
Type Data type of the variable.

NOTE: You can select multiple variables in either sections by selecting the first variable, pressing
and holding Ctrl, and selecting the other variables by using the pointer.

Saving Changes in the Manage Network Variables Dialog Box

Depending from where you have opened the Manage Network Variables dialog box, the procedure
to apply and save your changes varies.
If you have opened the Manage Network Variables dialog box from the context menu of the Control
project, proceed as follows to apply and save your changes.

Step Action
1 In the Manage Network Variables dialog box, click OK.
Result: A confirmation dialog box opens.
2 Click Yes to save your changes.
NOTE:
 Click No to close the Manage Network Variables dialog box without saving changes.
 Click Cancel to leave the Manage Network Variables dialog box open without saving
changes.

540 EIO0000001114 06/2020

 Refinement Stage

If you have opened the Manage Network Variables dialog box from within the Control Participant
during refinement, proceed as follows to apply and save your changes.

Step Action
1 In the Manage Network Variables dialog box, click OK to apply the changes to the logical
Control project.
Result: The Manage Network Variables dialog box closes.
NOTE: If you open the Manage Network Variables dialog box again before closing the
Control Participant, your changes are preserved but are not saved yet.
2 Click the save button in the toolbar of the Control Participant window to save your changes.
NOTE: Closing the Control Participant without saving does not apply your changes.

Creating Network Variables

To create a network variable by using the Manage Network Variables command from the context
menu of the Control project, proceed as follows.

Step Action
1 In the Projects Explorer, right-click the logical Control project in which you want the software to
identify network variable candidates and select Manage Network Variables.
Result: The Manage Network Variables dialog box opens. If the software did not detect any
candidate or network variables, the corresponding dialog box fields are empty.
2 In the Network Variable Candidates section, select the candidate variables that you want to
create as network variables and drag them to the Network Variables section.
Result: The network variables are shown in the New Network Variables section.
NOTE: Right-click a network variable to open a context menu, which allows you to make
changes (see page 542).
3 Save your changes (see page 540).
Result: The software closes the dialog box, creates the network variables, and displays a
summary of the actions in the notification panel.
NOTE: You can see the variable by refining the Control Participant project and double-clicking
Elementary Variables in the Variables & FB Instances section of the Project Browser.

EIO0000001114 06/2020 541

Refinement Stage

Modifying Network Variables

NOTE: Depending from where you have opened the Manage Network Variables dialog box, there
are different ways to save your changes (see page 540).
You can perform the following modifications on network variables displayed in the Network
Variables section:

Action Description
Adding a comment Double-click the Comment field of the variable and enter a description with free
form text.
Changing the name of Double-click the Name of the variable and enter a new name with free form text.
the variable
NOTE: You can only change the name of existing network variables that are not
yet mapped to a communication channel.
Undoing changes Right-click a variable and select Undo to discard the changes that you have made.
You can also press Ctrl+Z.
NOTE: You cannot undo changes that you have applied by clicking OK if you
have opened the Manage Network Variables dialog box from within the Control
Participant.
Deleting a network Right-click a variable and select Remove to:
variable  Display the variable again in the Network Variable Candidates section if it has
not been created yet.
 Mark the network variable for deletion in the Control Participant project.

If the variable is mapped to a communication channel, the software removes the

mapping (see page 654).
You can also select a variable and press Del.

542 EIO0000001114 06/2020

 Refinement Stage

Section 16.2
Supervision Project Refinement Stage

Supervision Project Refinement Stage

Refining the Supervision Project

Overview
The refinement process of Supervision Participant projects allows you to:
 View and modify Participant project data by using the Refine command. Limitations apply to the
modification of project data that is managed by the software.
 Add animated graphics to pages (see page 400) of the project, using the Edit command.
 Edit Participant project settings by using the Advanced Settings command.
 Add included projects and attach user files.

For each Supervision Participant project, you can use only one of the aforementioned commands
at a time. However, you can edit several Supervision pages at the same time. Each command uses
one instance of the virtual machine (see EcoStruxure™ Process Expert, Installation and
Configuration Guide).
NOTE: While you refine the Supervision Participant project or edit advanced settings, commands
such as Generate or Delete are not available for pages or containers.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

EIO0000001114 06/2020 543

Refinement Stage

Refining the Supervision Project

To refine the Supervision project, proceed as follows.

Step Action
1 In the Project Explorer, right-click the Supervision project you want to refine and select Refine.
Result: The Supervision Participant opens extracted (see page 134) and maximized.
2 Proceed with the refinement.
For more information on the refinement process and restrictions that apply, refer to the topic
describing the refinement of the Supervision project (see EcoStruxure™ Process Expert,
Supervision Participant Services, User Guide).
3 Close the Participant window.
Result: The Save Refinement dialog box opens.
4 Click the appropriate button in the dialog box.
Result:
 Yes: Closes the Supervision Participant window and keeps only changes that you have
saved in the Supervision Participant.
 No: Closes the Supervision Participant window and discards all changes, including those
that you have saved in the Supervision Participant.
 Cancel: Closes the Save Refinement dialog box and keeps the Supervision Participant
window open.

Editing Supervision Project Pages

The number of pages that you can edit at the same time is limited by the number of virtual machine
instances that can run simultaneously (see EcoStruxure™ Process Expert, Installation and
Configuration Guide) for the client and/or system server (for the system server in case the client is
installed on the system server computer).
You can save changes to several Supervision pages at the same time by clicking the save button
on each Supervision Participant window.
When you add an animated graphic to a page, the software adds the required included project to
the Supervision Participant project if it is not yet present. You can download included projects
(see page 709) as soon as the software has added them.
To edit a Supervision page, proceed as follows.

Step Action
1 In the Containers pane of the Assignment Editor, right-click the page (see page 400) that you
want to edit and select Edit.
Result: The Supervision opens extracted (see page 134) and maximized with the Instances
browser pane next to it.
2 Edit the page as required.
For more information on adding animated graphics, refer to Editing Supervision Pages
(see EcoStruxure™ Process Expert, Supervision Participant Services, User Guide).

544 EIO0000001114 06/2020

 Refinement Stage

Step Action
3 Click the save button in the toolbar of the Participant window to save the changes.

Result: The facets that encapsulate the animated graphics that you have added to a page
appear in the Assignments pane when you select the page. The Assignment and Generation
statuses of these facets are Assigned and Generated respectively.
If you have deleted an animated graphic that had already been added to a page, the
corresponding facet is removed from the Assignments pane.
4 Close the Supervision Participant window.
NOTE:
If you have unsaved changes and click the close button on the outer frame of the Participant
window, the software displays the Save Refinement dialog box where you have the following
choices:
 Yes: Saves changes you made to the page and closes the Participant window.
 No: Discards changes and closes the Participant window.
 Cancel: Does not save changes and leaves the Participant window open.

Editing Advanced Supervision Project Settings

To edit advanced project settings, proceed as follows.

Step Action
1 In the Project Explorer, right-click the Supervision project and select Advanced Settings.
Result: The Supervision Participant opens extracted (see page 134) and maximized.
2 Proceed with changes to the advanced project settings.
For more information, refer to Editing Advanced Project Settings (see EcoStruxure™
Process Expert, Supervision Participant Services, User Guide).
3 Click the save button in the toolbar of the Participant window to save the changes.

4 Close the Supervision Participant window.

NOTE:
If you have unsaved changes and you click the close button in the Participant window, the
software displays the Save Advanced Settings dialog box where you have the following choices:
 Yes: Saves changes you made to the advanced settings and closes the Participant window.
 No: Discards changes and closes the Participant window.
 Cancel: Does not save changes and leaves the Participant window open.

NOTE: You need to deploy (see page 775) the Supervision project to apply changes to advanced
project settings.

EIO0000001114 06/2020 545

Refinement Stage

Adding Included Projects

When you add an animated graphic (see page 544) to a Supervision page, the software
automatically adds the required included project to the Supervision Participant project.
You can add additional included projects. However, you cannot add an included project if the
software has already added to the Participant project an included project with the same name.
To add additional included projects to a Supervision Participant project, proceed as follows.

Step Action
1 In the Project Explorer, right-click the Supervision project to which you want to add an included
project and select Include Projects.
Result: The Include Projects window opens.
2 Click Add.
Result: The Open dialog box opens.
3 Browse to the location where the included project file (.ctz) is stored, select it, and click Open.
Result:
 If an included project with the same name already exists in the Participant project, the
software displays a notification:
 Click OK to acknowledge.
 Close the Include Projects window.

 If an included project with the same name already exists in the Global Constituents folder of
the contents repository, the software displays a notification:
 Click Yes to add the included project that exists in the contents repository.
 Click No to cancel the process without adding the included project.

 If no included project with the same name already exists, the software:
 Stores the selected file in the contents repository.
 Displays the selected file in the window.

NOTE: The software lets you deploy (see page 773) included project that you add.
4 Close the Include Projects window.

NOTE: To remove an included project from the Supervision project, select the file in the Include
Projects window and click Remove. After you acknowledge the command, the software removes
the file and deletes it from the contents repository.

546 EIO0000001114 06/2020

 Refinement Stage

Attaching External Files

To add external files to a Supervision project, proceed as follows.

Step Action
1 In the Project Explorer, right-click the Supervision project to which you want to add files and
select Attach User Files.
Result: The Attach User Files window opens.
2 Click Add.
Result: The Open dialog box opens.
3 Browse to the location where the file is stored, select it, and click Open.
Result: The software:
 Stores the selected file in the contents repository.
 Displays the selected file in the window.

NOTE: The software includes files that you attach into the Supervision project, which it deploys
during deployment.
4 Close the Attach User Files window.

NOTE: To remove a file from the Supervision project, select the file and click Remove. The
software removes the file and deletes it from the contents repository. If user files had already been
deployed, they are not removed from the location they were deployed to when you re-deploy the
Supervision project (see page 777).

EIO0000001114 06/2020 547

Refinement Stage

548 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Configuration Stage
EIO0000001114 06/2020

Chapter 17
Configuration Stage

Configuration Stage

Overview
This chapter provides information to help you model the entire topology of the system, which
consists of the hardware and software infrastructure.
The following figure shows the position of the Configuration stage within the system engineering
life cycle.

Refer to the Configuration stage (see page 58) for a description of the purpose of this stage.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
17.1 Creating the Topology of the System 550
17.2 Managing the Topology 606

EIO0000001114 06/2020 549

Configuration Stage

Section 17.1
Creating the Topology of the System

Creating the Topology of the System

Overview
This section describes how to use the Topology Explorer to create and configure topological
entities modeling the topology of the system.
The software includes templates that allow you to model the following infrastructure components:
 Ethernet networks
 Station nodes
 Controllers
 Ethernet STB islands and devices connected through CANopen extension
 Modbus TCP and Ethernet IP I/O devices
 PROFIBUS remote masters (PRMs) and their decentralized peripherals (DPs)

Controllers and station nodes act as engines to which you can deploy Control or Supervision
projects.
For more information on supported architectures, refer to the topic describing integrated
architectures (see EcoStruxure™ Process Expert, Control Participant Services, User Guide).
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Organizing the System Topology 551
Selecting Topological Templates 555
Configuring a Controller 556
Configuring a Station Node 566
Configuring an STB Island 573
Configuring a PROFIBUS Remote Master and Decentralized Peripherals 579
Configuring Modbus TCP and EtherNet/IP Devices 584
Configuring HART Modules 591
Configuring an Ethernet Network 594
Connecting to an Ethernet Network 596

550 EIO0000001114 06/2020

 Configuration Stage

Organizing the System Topology

Before Starting
The topology of the system is defined through topological entities (see page 36), which consist of
folders, and instances of topological templates, called devices. You can organize these entities in
the form of a folder structure, which is displayed in the tree view of the Topology Explorer.
Before creating the folder structure for the topology, define the appropriate segmentation and
naming convention for the hardware infrastructure of the system.
NOTE: Before selecting another command for an entity, wait for the current task to complete.
However, the same command can be executed on distinct entities by one or more clients
simultaneously.

Opening the Topology Explorer

To open the Topology Explorer, right-click the system from the Systems Explorer tree view and
select Open Topology.

Topology Explorer Window

The following figure shows an example of the Topology Explorer window.

1 System root folder

2 Topology folder tree view
3 Station node folder (expanded view to display contents)
4 Ethernet networks
5 Controller folder (collapsed view)

EIO0000001114 06/2020 551

Configuration Stage

Topological Entity Folder Description

The following figure shows a folder representing a topological entity.

Item Description
1 Identifier of the entity.
2 Icon indicating the type of entity.
3 Show/hide devices button.
4 Mapping indicator.
The entity that is represented by the folder is mapped when a check mark is displayed. It is not mapped
when a cross is displayed.
Hover with the pointer over the indicator to display in a tooltip the mapping status.
5 Online refinement indicator.
The icon indicates that you have made changes online to the Control Participant project that is
deployed to the engine of the topological entity. These changes need to be applied to the associated
logical Control Participant project to make it consistent with the one that is deployed to the engine.
The icon is removed once you successfully update the associated logical Control Participant project
(see page 841) with all the changes that the software has detected in the following sections of the
Update Control Project dialog box:
 Derived Data & FB Types
 Variables & FB Instances
 Sections

If you update the project only partially with these three categories, the icon remains visible.
Hover with the pointer over the indicator to display a tooltip.
NOTE: If you have also made changes pertaining to the Animation Tables and/or Operator Screens
category, it is not relevant whether you select or not any of these two categories as long as you select
all the changes in the three aforementioned categories to remove the refinement indicator.
If you have made a change online pertaining only to the Animation Tables and/or Operator Screens
category, you need to select such change to remove the indicator.

Creating Topology Folders

The Topology Explorer allows you to organize the system infrastructure in the form of a folder
structure.
To create a topology folder, proceed as follows.

Step Action
1 Right-click the system root folder in the Topology Explorer and select Create Folder.
Result: A topology folder is created and displayed it in the tree view.
NOTE: To create a subfolder, repeat step 1 at the topology folder level.

552 EIO0000001114 06/2020

 Configuration Stage

Topology Folder Actions

Right-click the system root folder or a topology folder to open a context menu with the following
commands.

Command Description
Expand The first time you click Expand, expands the next level in the folder structure or opens the
folder/window.
The next time you click Expand, displays the folder structure or contents in its last
expanded state.
If the folder is empty, the command has no effect.
Collapse Collapses the folder structure up to the folder or closes the folder/window.
The command is available only if the folder/window is already expanded.
Create Folder Creates a topology folder or subfolder and displays it in the tree view.
Open Opens the Application Explorer (see page 172), which allows you to start the instantiation
Application stage or access the application of the system.
The command is available from the root folder only.
Open Project Opens the Projects Explorer, which allows you to start the Project Definition stage
(see page 297) or access the Control and Supervision projects of an existing system.
The command is available from the root folder only.
Create Ethernet Creates an Ethernet network entity and displays it in the folder. The entity represents an
Network Ethernet based network of the system.
(see page 594)
Create Station Creates a station node entity and displays it in the tree view.
Node For example, a station node can represent a Supervision I/O server or a PC emulating
(see page 566) simulator software.
Create Displays a submenu, which allows you to create a controller entity of the supported
Controller platforms (see EcoStruxure™ Process Expert, Control Participant Services, User Guide).
(see page 556) The topological entity allows you to configure devices, which represent the CPU, power
supply, communication, I/O modules, extended and remote racks, and so on.
Create STB Creates an STB island entity and displays it in the tree view.
Island The topological entity represents the segments, communicator, STB island modules, and
(see page 573) devices connected through the CANopen bus of the island once you have configured
them.
Create PRM Creates a PROFIBUS remote master (PRM) entity and displays it in the tree view.
PROFIBUS DP The topological entity allows you to configure the decentralized devices (DPs) connected
(see page 579) to the PRM by using device type managers (DTMs) and generic station description (GSD)
files.
Create Opens a submenu containing the following commands:
Device IO  Modbus TCP
(see page 584)  Ethernet IP

Selecting either command opens the Select Template dialog box, which lets you select and
instantiate a topological template to create an I/O device entity. The topological entity is
used to manage communication (see page 855) between such device and the controller
by using Modbus TCP (I/O scanning and explicit) or EtherNet/IP (explicit) messaging.

EIO0000001114 06/2020 553

Configuration Stage

Command Description
Update Updates the template that is used by entities inside the folder and any subfolder with the
Template latest version of that template, which is available in the Global Templates library on the
(see page 608) system server.
Export Opens the Export window, which allows you to select the topological entities that you want
(see page 610) to export in the form of a topology export file (.sbk).
You can select entities contained in the folder and any subfolders along with their folder
hierarchy.
The command is not available from empty topological folders.
Import Opens the Import window, which allows you to select an export file (.sbk). In a second step,
(see page 613) you can select which compatible content of the export file you import in the topology.
Delete Deletes the folder and its contents, including subfolders, their contents, and associated
configurations.
The command is not available from the root folder.
Rename Allows you to type a new folder name.
The command is not available from the root folder.
Properties Opens the folder Properties window, which allows you to view and edit information of the
folder.
The command is not available from the root folder.

Topology Folder Properties

To access the Properties window of the topology folder, right-click the folder and select Properties.
You can edit the following items.

Item Description
General Identifier Designation of the folder.
The identifier must be unique for each subfolder of the same parent folder and
satisfy naming rules (see page 98).
Default value: Folder_n where n is an incremental number starting at 1.
Description Optional.
You can enter a description of the folder with free form text. The description you
enter appears in a tooltip when you move the pointer over the folder.
Default value: Blank
Area Optional.
You can assign an access control number to the folder.
Value: 1...255 (integer).
Default value: Blank

554 EIO0000001114 06/2020

 Configuration Stage

Selecting Topological Templates

Overview
When you create a topological entity, the software displays the Select Template dialog box if more
than 1 topological template is available to model a hardware module:
 When you first create the entity: For any module that you add in the Control Participant.
 When you modify the entity: For modules that you have added or moved since you last
configured the entity.
The Select Template dialog box allows you to select the topological template and version that you
want to use among the compatible ones that are available.
NOTE: The Update Templates command (see page 608) is available from the context menu of
entities after you create them.

Default Selection
By default, the software selects the topological template in the Global Templates library that has
the highest version number with the usability state (see EcoStruxure™ Process Expert, Global
Templates, Reference Manual) of Approved or Deprecated among those that have a matching
Hardware Reference as attribute.

Selection for Redundant Controllers

When you select a topological template for a module of the primary controller of a redundant
configuration, the software applies your selection automatically to the counterpart module of the
standby controller.

Select Template Dialog Box

The table describes the fields of the Select Template dialog box and how to select templates.

Column Header Description

Hardware References Module hardware references and network type (see EcoStruxure™
Process Expert, Global Templates, Reference Manual) for which a choice of
topological templates is available.
Templates For each displayed hardware reference, indicates the identifier and version of
the default topological template that the software will use to create the device.
 To select a different template: Click the default template to display the other
available templates, select the template that you want to use, and click OK to
confirm your selection.
 To cancel the configuration process and return to the Control Participant
window, click Cancel.

EIO0000001114 06/2020 555

Configuration Stage

Configuring a Controller

Overview
Controller entities act as engines for executing Control projects that are defined in the Projects
Explorer.
You proceed with the configuration of controller entities from within the Control Participant, which
then transfers the defined configuration to the controller entity of the Topology Explorer by using
the appropriate topological templates.
If the software cannot find the corresponding template for a hardware module, it uses the
$UnknownModule template. Hardware modules that are modeled with this template do not appear
in the Hardware Mapping editor.

Virtual Machine Usage

The configuration of one controller entity uses up one session of the Control Participant of the
virtual machine (see EcoStruxure™ Process Expert, Installation and Configuration Guide).

Device DDTs of Topological Entities

When you add a module to a controller entity, which uses a device type manager (DTM) (for
example, an M580 CPU, a NOC communication module, or a HART analog I/O module), the
software automatically creates the corresponding device DDT. Such variables exist only in the
configuration that you can access from the Topology Explorer and are integrated to the Control
Participant project during build.
However, you can create certain device DDTs (see page 517) in a Control Participant project
during refinement.

Redundant Controllers
Typically, for redundant controllers that are configured in the topology, only the entity identifier or
the identifier of the primary engine is used at the platform level to identify them (for example, in the
Physical Connections dialog box when you connect the controller to an Ethernet network). The
standby engine is implicitly included. If the standby engine needs to be dealt with explicitly (for
example, for deployment tasks), it is identified separately.

Creating a Controller Entity

To create the controller entity, which will contain the controller configuration (devices), proceed as
follows.

Step Action
1 Right-click the system root folder or a topology folder in the Topology Explorer, select Create
Controller, and select a controller platform.
Result: The controller entity (see page 552) is created and displayed in the tree view.

556 EIO0000001114 06/2020

 Configuration Stage

Controller Actions
Right-click the controller entity to open a context menu with the following commands.

Command Description
Configure Opens the Control Participant, which allows you to configure the controller
(see page 561) hardware, in-rack modules, drops, and communication services.
Physical Connections Opens the Physical Connections window, which allows you to connect or disconnect
(see page 599) communication modules of the controller that support Ethernet to existing Ethernet
networks to represent physical connections to such networks.
Update Template Opens the Update Template dialog box, which allows you to update the templates
(see page 608) that are used by controller entities with the highest available version of the Global
Templates library on the system server.
Deploy Built Project Opens the Deploy Built Project dialog box, which lets you select a built Control
(see page 714) Participant project and deploy it entirely to the controller.
Deploy Changes / Deploys to the controller the differences between the deployed Control Participant
Undo Online Changes project and the corresponding built Control Participant project.
(see page 714)
Re-Deploy Last Project Lets you deploy once again the entire built Control Participant project that you had
(see page 714) deployed to the controller last.
The command is available only if you had executed the Deploy Built Project
command previously on the controller.
Deploy Data Opens the Deploy Data dialog box in which you can select a controller data backup
(see page 750) file that has been created by using the Back Up Data command. It lets you deploy
the data contained in the file to the controller.
The command available only if you have deployed a built Control Participant project
to the controller.
Start (see page 788) Starts the execution of the participant project by the controller.
Stop (see page 788) Stops the execution of the participant project by the controller.
Refine Online Lets you modify the deployed Control Participant project online.
(see page 788)
Sync (Primary→ Lets you synchronize the standby controller with the primary one.
Standby) The command is available only for redundant controllers.
(see page 804)
Update Control Project Updates the logical Control Participant project that is associated to the deployed
(see page 788) Control Participant project with the changes that you have made to the deployed
project online, using the Refine Online command.
Back Up Data Opens the Back Up Data dialog box, which lets you configure the data that you want
(see page 823) to back up and create a controller data backup file.
The command available only if you have deployed a built Control Participant project
to the controller.
Manage Password Opens the Manage Password dialog box, which lets you set (see page 728) a
password for deployment and execution operations performed on the controller and
modify it.
The command is available only if the Security Password property is set to Enabled.

EIO0000001114 06/2020 557

Configuration Stage

Command Description
Clear Password Opens the Clear Password dialog box, which lets you remove (see page 731) the
application password of the deployed Control Participant project.
The command is available only if you have set a password.
Forgot Password Opens the Forgot Password dialog box, which contains an authentication code that
you need to reset the forgotten password (see page 731).
Delete (see page 565) Deletes the controller entity including controller devices and related configurations.
Rename Lets you change the identifier of the controller entity.
Export (see page 610) Opens the Export window, which allows you to export the entity and its folder
hierarchy in the form of a topology export file (.sbk).
Properties Opens the Properties window in which you can view and edit properties of the
controller entity.
NOTE: To view properties of the controller devices representing the hardware
modules, refer to Controller Representation (see page 563).

Controller Properties
Right-click the controller entity and select Properties to open the Properties window in which you
can view and edit its properties.

Item Description
General Identifier The identifier must be unique within the system and satisfy
naming rules (see page 98).
The entity identifier becomes part of the name of the devices
that the software creates inside in the entity:
 Folders (identifier field)
 Devices ($Name parameter)

The identifier (or part of it) is also used to create the name of
the DTM if it is added during build when the controller is acting
as server for peer to peer communication (see page 690).
Description Optional.
You can enter a description of the controller with free form
text. The description you enter appears in a tooltip when you
move the cursor over the entity.
Default value: Blank
Area Optional.
You can assign an access control number to the controller
entity.
Range: 1...255 (integer)
Default value: Blank

558 EIO0000001114 06/2020

 Configuration Stage

Item Description
Hot Standby(1) ControllerExist  PrimaryAndStandby: Select this value when both the
primary and the standby controllers are physically present
and connected by a Hot Standby cable link (default value).
 Primary: Select this value when either of the following
applies:
 Only the primary controller is physically present.
 Both the primary and the standby controllers are
physically present but not connected by a Hot Standby
cable link.
The value has an impact on the behavior during deployment
and execution (see page 713).
Controller Family Value Indicates the hardware platform that the controller belongs to.
Read-only.
CpuVersion CpuVersion Indicates the firmware version of the CPU module that is
configured.
The read-only property is displayed only after you save the
controller configuration.
$Name ServerMemoryStart Holding register address (%MW) for peer to peer data.
(see page 563) of (Integer)
communication Default value: Blank
You can only enter an odd address (see page 693) for this
module(2)
parameter (for example, 1, 5, 11).
For more information, refer to Configuring the Controller I/O
Scanner Parameters (see page 562).
ServerMemoryLength Holding register size for peer to peer data.
(Integer)
Default value: Blank.
NOTE: The available memory length is
ServerMemoryLength - 1 because 1 word is reserved to
move the channel address for managing the 32-bit alignment
(see page 693) for peer to peer communication across
Modicon M340, M580, and Quantum platforms.
For more information, refer to Configuring the Controller I/O
Scanner Parameters (see page 562).
$Name of ClientMemoryStart(3) Holding register address (%MW) for I/O scanning.
communication (Integer)
module(2) Default value: Blank.
For more information, refer to Configuring the Controller I/O
Scanner Parameters (see page 562).
ClientMemoryLength(3) Holding register size in words for I/O scanning
(Integer)
Default value: Blank.
For more information, refer to Configuring the Controller I/O
Scanner Parameters (see page 562).

EIO0000001114 06/2020 559

Configuration Stage

Item Description
Password Security Password Lets you manage password protection (see page 725) for
Protection deployment and execution operations performed on the
controller.
 Enabled: Enables password protection.
 Disabled: Disables password protection after you confirm
the selection.
By default, the value is set according to the value of the
Optional Security Services By Default property
(see page 161), which is set at the system level.
Default value: Enabled once you configure the controller.
NOTE: To disable the property once you have deployed a
Control Participant project with the property set to Enabled,
you need to enter the current password, which also clears it.
On the other hand, if you had already deployed a Control
Participant project while the property was set to Disabled, you
can enable it and set a password for the already deployed
Control project.

(1) The section is displayed only for redundant controller configurations.

(2) The section is displayed when the software has completed the configuration process. A section
is displayed for each communication module that you have configured with an IP address in the
Control Participant by using the Configure command.
The server properties are displayed for CPU modules only.
(3) The client properties are displayed for communication modules, including the CPU module
when the I/O scanner service is enabled. They are not displayed for controllers of the
Modicon M580 platform and NOC communication modules.
NOTE: To view properties of the controller devices representing the hardware modules, refer to
Controller Representation (see page 563).

560 EIO0000001114 06/2020

 Configuration Stage

Configuring the Controller

To configure the controller, proceed as follows.

Step Action
1 Right-click the controller entity in the Topology Explorer and select Configure.
Result: The Control Participant opens extracted (see page 134) and maximized.
2 Proceed with the configuration of the controller inside the Control Participant.
For more information about configuring the controller and working inside the Control Participant,
refer to the Control Participant Services User Guide (see EcoStruxure™ Process Expert, Control
Participant Services, User Guide).
3 Click the save button in the toolbar of the Participant window.

Result: The software saves the changes in the configuration file and transfers the configuration
to the Topology Explorer. It may display the Select Template (see page 555) dialog box.
NOTE: If the software detects a configuration issue, it displays a notification, which allows you
to change the configuration until you are able to save it.
4 Close the Control Participant window.
NOTE:
If you change the configuration and you click the close button on the outer frame of the
Participant window without saving your changes first, the software displays the Save
Configuration dialog box where you can click:
Yes to save the changes in the configuration file and close the Participant window.
No to discard your changes and close the Participant window.
Cancel to leave the Participant open without saving your changes.

Changing the Controller Configuration

To change the configuration of a controller, follow the procedure to configure a controller, and
proceed with the changes inside the Control Participant.
If the controller is mapped to at least 1 executable, saving changes to communication functions
that you made from within the Control Participant may delete the existing communication mapping
(see page 630) and hardware mapping (see page 655) of this executable.
In such case, the software displays a notification asking you to confirm the change. Make either
selection:
 OK: To save the change to the configuration file of the controller and delete the associated
communication and hardware mappings.
 Cancel: To keep the Control Participant window open. Unsaved changes are not discarded

For more information, refer to Configuring the Controller (see EcoStruxure™ Process Expert,
Control Participant Services, User Guide).

EIO0000001114 06/2020 561

Configuration Stage

Configuring the Controller I/O Scanner Parameters

To use the I/O scanner of the controller and define communication channels between the CPU
and/or communication modules and devices connected to the same Ethernet network, configure
the read/write zones once the software has completed the configuration process to transfer the
controller configuration to the Topology Explorer.
The software configures the related parameters of the devices representing the
CPU/communication modules and exposes the data in the Communication Mapping Editor window
during the communication mapping (see page 630).
If you configure overlapping client and server memory areas for a controller and map variables to
these overlapping addresses, build does not complete successfully and the software displays a
message to inform you.
These settings are an example of values entered in the Properties window of a controller that result
in overlapping memory areas:
 ServerMemoryStart: 1
 ServerMemoryLength: 100
 ClientMemoryStart: 51
 ClientMemoryLength: 150

For more information on configuring parameters for I/O scanning, refer to the Control Participant
help.
NOTE: If you reduce the value of the size (see page 635) that is reserved in the client and/or server
memory while peer to peer communication channels exist in the controller and you have already
built the associated logical Control Participant project, verify that the new register size meets the
requirements of the project. You cannot build the project if the free memory value becomes
negative.
NOTE: When you modify a parameter of the client and/or server memory reserved for
communication channels and you have already deployed the associated built Control Participant
project, you can only apply the change to the engine by using the Deploy Built Project
(see page 763) command, which requires stopping the controller. You cannot use the Deploy
changes command.
To configure the I/O scanner parameters of the controller, proceed as follows.

Step Action
1 In the Topology Explorer, right-click the controller folder and select Properties.
2 Enter a value in the appropriate fields of the memory section (see page 558) of the CPU and/or
communication module that you want to use for I/O scanning.
3 Click the close button to close the Properties window.

NOTE: For controllers of the Quantum platform configured with a NOC communication module and
acting as client, configure the memory size of the NOC (see EcoStruxure™ Process Expert,
Control Participant Services, User Guide) by using the Control Participant.

562 EIO0000001114 06/2020

 Configuration Stage

Controller Representation
The Topology Explorer allows you to view the topological devices representing the following
hardware components of the controller entity once you have configured it:
 Racks
 Buses
 Power supplies
 CPUs
 Communication modules
 I/O modules

It lets you also view and configure their properties (see page 565).
The following figure shows the representation of a controller entity based on the Modicon M580
platform with a local rack and one Ethernet RIO drop.

1 Controller folder representing the controller entity (see page 552)

2 Controller local bus folder
3 Controller local rack folder
4 Controller local rack module folder
5 Devices modeling the rack, power supply, CPU, communication modules, and I/O modules of the local rack
6 EIO bus folder
7 EthRIO rack folder
8 EthRIO drop folder
9 Devices modeling the rack, CRA module, and I/O modules of the EthRIO drop

Devices are identified by the $Name parameter, which uses the format <Entity identifier> <Bus
number>:<Designation> <Drop number>:D <Rack number>:R <Position on rack>:<Commercial
reference>.
<Designation> is either:
 Local for the local bus of controller platforms that do not support a redundant configuration.
 PriLocal or SecLocal for the local bus of controller platforms that support a redundant
configuration. If a standalone controller is configured, the local bus designation is PriLocal.
 EthRIO for the EIO bus of any controller platform supporting remote drops.

EIO0000001114 06/2020 563

Configuration Stage

In this example, the highlighted row in the following figure represents a BMXDDI1603 digital input
module located in position 3 of the local rack of Controller_1.

In this example, the highlighted row in the following figure represents a BMXAMO0210 analog
output module located in position 2 of the second remote drop of Controller_1.

NOTE:
For CPUs of the Modicon M580 platform that have an embedded RIO scanner service:
 The parent folder with the name <Entity identifier> <Bus number>:EthRIO is created by default.
The folder and the device it contains represent the RIO scanner service. The status of the device
remains invalid until you configure at least one RIO drop.
 The <Entity identifier> <Bus number>:EthRIO device appears in the Physical Connections
dialog box (see page 596) even if you have not yet configured a RIO drop. It is associated to
IP Address A of the CPU module. In case of a redundant controller, it also implicitly represents
the RIO scanner service of the CPU designated as B and is associated to IP Address B.

564 EIO0000001114 06/2020

 Configuration Stage

Properties of Modules
Expand the topological entity folder, right-click a device, and select Properties to open the Device
Editor, which lets you view some of its parameters without the need to open the Control Participant.
For example:
 Its reference
 Its position on the rack
 IP addresses, ports, and other module-specific communication parameters
 Physical interface links with Ethernet networks
 Implicit connections within the entity

Deleting a Controller Entity

When you select the Delete command for a controller entity, the software notifies you if it detects
any of the following:
 Any mappings.
 Any physical interface link with an Ethernet network.

Once you have confirmed the delete command, the software deletes the following components of
the controller entity:
 Physical interface links
 The controller entity, subfolders, and devices contained therein
 The corresponding Control Participant configuration project, including:
 Any mapping information
 Peer to peer communication channels (see page 642)
 Any deployed Control Participant project related to the engine

To delete the controller entity and its contents, proceed as follows.

Step Action
1 Right-click the controller entity in the Topology Explorer and select Delete.
Result: A dialog box opens.
2 Verify the information that is displayed and click OK to proceed.
Result: The software deletes the controller entity and its contents, and displays a confirmation
message in the notification panel.

EIO0000001114 06/2020 565

Configuration Stage

Configuring a Station Node

Overview
The station node is a topological entity, which represents the hardware (for example, network
interface cards (NICs)) and software (for example, Supervision servers and clients, OPC Factory
Server or OPC UA Server Expert) that is installed on a computer workstation, which is connected
to the Ethernet control network.
Station nodes act as engines for executing:
 Deployed Supervision projects.
 Deployed Control projects running in an emulated simulator (see page 720).

For example, station nodes represent operator stations and operation servers.
You create station node entities in the Topology Explorer and define their devices from the station
node folder representing the entity.

Creating a Station Node Entity

To create a station node entity, proceed as follows.

Step Action
1 Right-click the system root folder or the topology folder in the Topology Explorer and select
Create Station Node.
Result: The software creates a station node entity (see page 552) and displays it in the tree
view.
NOTE: By default, the software creates a Network Interface Card (NIC) device when you create
a station node entity. To display the NIC device, open the station node entity folder.

NOTE: The software may display the Select Template (see page 555) dialog box.

566 EIO0000001114 06/2020

 Configuration Stage

Station Node Actions

Right-click the station node folder to open a context menu with the following commands.

Command Description
Create NIC Creates an NIC device and displays it in the station node folder.
(see page 570) The NIC provides connectivity to the Ethernet network through the Physical
Connections (see page 596) dialog box.
Create Supervision Creates a Supervision service instance and displays it in the station node folder.
Service It lets you select the station node in the service mapping (see page 680) so that you
can deploy a Supervision project to it.
Create the service in the stations nodes on which the I/O(1), Alarm, Trend, and Report
servers as well as the Supervision clients are installed.
You can create one Supervision service per station node.
Right-click the service and select Properties to access its parameters (see page 572).
(1) May also require an OFS service.
Create OFS Creates a protocol-independent OFS service instance and displays it in the station
node folder.
Create the service in the station node on which the I/O server and OPC Factory Server
or OPC UA Server Expert are installed. It is required to map the station node to the
IOServer service of the Supervision project in the service mapping (see page 680)
and to deploy the corresponding configuration files (see page 705) to the station node.
You can create one OFS service per station node.
Right-click the service and select Properties to access its parameters (see page 572).
NOTE: Requires also a Supervision service.
NOTE: The OFS service is not required to perform the service mapping with the
IOServer service when the OPCUA Embedded protocol is selected (see page 396)
for all the tag containers associated to the same I/O server.
Create Control Creates a Control Expert service instance and displays it in the station node folder.
Service It allows you to:
 Deploy (see page 714) a built Control Participant project to software emulating a
simulator that is running on the computer.
 Select the station node to which you have deployed a Control project in the
communication mapping (see page 682). It lets you use it as data source (I/O
device) for simulating Supervision runtime services.
You can create one ControlExpert service per station node.
Right-click the service and select Properties to access its parameters (see page 572).
Physical Opens the Physical Connections window, which allows you to connect or disconnect
Connections the station node, through its NIC, to existing Ethernet networks to represent physical
(see page 601) connections to such networks.
Update Template Opens the Update Template dialog box, which allows you to update the templates that
(see page 608) are used by station node entities with the highest available version of the Global
Templates library on the system server.
Control Opens a submenu containing deployment and execution commands.

EIO0000001114 06/2020 567

Configuration Stage

Command Description
Supervision Opens a submenu that contains the following commands:
 Deploy Built Project: Lets you select a built Supervision Participant project and
deploy it to the station node (see page 778).
The command is available only if you have created the necessary service in the
station node, mapped an executable to the station node, and built it.
 Deploy Changes: Lets you deploy a limited number of changes (see page 784) to
the station node.
The command is available only if you have already deployed the built Supervision
Participant project to the station node and if the number and type of changes are
supported.
Delete Deletes the station node entity including services and related configurations.
Rename Lets you change the identifier of the station node entity.
Export Opens the Export window, which allows you to export the entity and its folder hierarchy
(see page 610) in the form of a topology export file (.sbk).
Properties Opens the Properties window in which you can view and edit properties of the station
node entity.

The following table describes the commands of the Control submenu. Commands in this submenu
are available only if you have created the necessary service in the station node, mapped an
executable to the station node, and built it. Additional availability conditions may apply; refer to the
description of each command.

Command Description
Deploy Built Project Opens the Deploy Built Project dialog box, which lets you select a built Control
Participant project and deploy it to the station node (see page 714).
Deploy Changes / lets you deploy to the station node the differences between the deployed Control
Undo Online Participant project and the corresponding built Control Participant project.
Changes
(see page 714)
Re-Deploy Last lets you deploy once again the entire built Control Participant project that you had
Project deployed to the station node last.
(see page 714) The command is available only if you had executed the Deploy Built Project command
previously on the station node.
Deploy Data opens the Deploy Data dialog box in which you can select a controller data backup file
(see page 750) that has been created by using the Back Up Data command. It lets you deploy the data
contained in the file to the simulator running in the station node.
The command available only if you have deployed a built Control Participant project to
the station node.
Start (see page 788) starts the execution of the deployed Control Participant project in the simulator.
Stop (see page 788) stops the execution of the deployed Control Participant project in the simulator.
Refine Online lets you change the deployed Control Participant project online.
(see page 788)

568 EIO0000001114 06/2020

 Configuration Stage

Command Description
Update Control lets you update the logical Control Participant project that is associated to the deployed
Project Control Participant project with the changes that you have made to the deployed
(see page 788) project online, using the Refine Online command.
Back Up Data opens the Back Up Data dialog box, which lets you configure the data that you want to
(see page 823) back up and create a controller data backup file.
The command available only if you have deployed a built Control Participant project to
the station node.
Manage Password Opens the Manage Password dialog box, which lets you set (see page 728) a
password for deployment and execution operations performed on the simulator and
modify it.
The command is available only if the Security Password property is set to Enabled.
Clear Password Opens the Clear Password dialog box, which lets you remove (see page 731) the
application password of the deployed Control Participant project.
The command is available only if you have set a password.

Station Node Properties

Right-click the station node folder and select Properties to open the Properties window in which
you can view and edit the station node properties.

Parameter Description
General Identifier The identifier must be unique within the system and satisfy naming rules
(see page 98).
Description Optional.
You can enter a description of the station node with free form text. The
description you enter appears in a tooltip when you move the cursor over
the entity.
Default value: Blank
Area Optional.
You can assign an access control number to the station node entity.
Range: 1...255 (integer)
Default value: Blank

EIO0000001114 06/2020 569

Configuration Stage

Parameter Description
Control Password Security The property is available only once you create a ControlExpert service
Expert Protection Password (see page 567).
Lets you manage password protection (see page 725) for deployment and
execution operations performed on the simulator.
 Enabled: Enables password protection.
 Disabled: Disables password protection after you confirm the selection.

By default, the value is set according to the value of the Optional Security
Services By Default property (see page 161), which is set at the system
level.
Default value: Enabled.
NOTE: To disable the property once you have deployed a Control
Participant project with the property set to Enabled, you need to enter the
current password, which also clears it.
On the other hand, if you had already deployed a Control Participant
project while the property was set to Disabled, you can enable it and set a
password for the already deployed Control project.
Supervision TCP Port Configure the value to be the same as TCP Listening Port of the OPCUA
server that is installed on the station node.
The value is used in the I/O device address (see page 704) only when
Protocol of the associated tag container is set to OPCUA.
Valid range: 49152 (default) to 65535.
The parameter is available only for station nodes in which an OFS service
has been created.

Creating a Network Interface Card (NIC)

To create an NIC device, proceed as follows.

Step Action
1 Right-click the station node entity in the Topology Explorer and select Create NIC.
Result: The software opens the station node folder and displays the NIC device.
NOTE: The software may display the Select Template (see page 555) dialog box.

NIC Actions
Right-click the NIC device to open a context menu with the following commands.

Command Description
Update Template Opens the Update Template dialog box, which allows you to update the template that
(see page 608) is used by NIC devices with the highest available version of the Global Templates
library on the system server.
Delete deletes the NIC device including related configurations.
Rename allows you to change the identifier of the NIC.
Properties opens the Properties window in which you can view and edit properties of the NIC.

570 EIO0000001114 06/2020

 Configuration Stage

NIC Properties
Right-click the NIC device and select Properties to open the Device Editor, which lets you view and
edit its parameters.

Parameter Description
$System $Name The identifier must be unique within the system and satisfy
naming rules (see page 98).
Default value: NIC_n where n is an incremental number
starting at 1.
$Description Optional.
You can enter a description of the NIC with free form text.
Default value: Blank
$Area Optional.
You can assign an access control number to the NIC.
Range: 1...255 (integer)
Default value: Blank
NIC Parameters IPAddress IP address of the NIC on the Ethernet network.
The default IP address of the NIC that is created when you
create the station node is 127.0.0.1, which corresponds to
the local host. For additional NICs that you create manually,
the default value is blank.
NOTE: For station nodes on which you install software
emulating a simulator, enter the IP address (see page 722)
that is displayed by the simulator software running on the
station node.
Subnet Mask Subnet mask that is used to define IP addresses on the
Ethernet network that the NIC belongs to.
Default value: Blank
PhysicalInterfaceLinkX(1) Destination Indicates to which Ethernet network the NIC is connected.
Instance
Role Indicates the identifier of the role of the interface.
Interface Indicates the identifier of the interface that the NIC device
exposes for connection to the Ethernet network.

(1) The section is displayed if you have connected (see page 601) the station node through its NIC
to an Ethernet network of the system. The parameters are not editable. X represents the number
of the physical interface link, which is an incremental number starting at 1.

EIO0000001114 06/2020 571

Configuration Stage

Station Node Service Actions

Right-click an OFS, ControlExpert, or Supervision service instance to open a context menu with
the following commands.

Command Description
Update Template Opens the Update Template dialog box, which allows you to update the template that
(see page 608) is used by the instance with the highest available version of the Global Templates
library on the system server.
Delete Deletes the instance including related configurations.
Rename Lets you change the identifier of the instance.
Properties Opens the Properties window in which you can view and edit properties of the
instance.

Station Node Service Properties

Right-click an OFS, ControlExpert, or Supervision service instance and select Properties to open
the Device Editor, which lets you view and edit its parameters.

Parameter Description
$System $Name Identifier of the service, which must be unique within the system and satisfy
naming rules (see page 98).
$Description Optional.
You can enter a description of the instance with free form text.
Default value: Blank
$Area Optional.
You can assign an access control number to the instance.
Range: 1...255 (integer)
Default value: Blank

572 EIO0000001114 06/2020

 Configuration Stage

Configuring an STB Island

Overview
The topological entity represents an STB island that communicates with the controller through
I/O scanning. It contains:
 Modules
 CANopen extensions
 HART devices

The STB island acts as a server.

You configure STB island entities from within the Control Participant, which then transfers the
defined configuration to the STB island entity of the Topology Explorer by using the appropriate
topological templates.
If the software cannot find the corresponding template for a hardware module, it uses the
$UnknownModule template. Hardware modules that are modeled with this template do not appear
in the Hardware Mapping editor.

Virtual Machine Usage

The configuration of one STB island entity uses up one session of the Advantys Configuration
Software (ACS) Participant of the virtual machine (see EcoStruxure™ Process Expert, Installation
and Configuration Guide).

Creating an STB Island Entity

To create the STB island entity, which will contain the STB island configuration (devices), proceed
as follows.

Step Action
1 Right-click the system root folder or a topology folder in the Topology Explorer and select Create
STB Island.
Result: The software creates an STB island entity and displays it in the tree view.

EIO0000001114 06/2020 573

Configuration Stage

STB Island Actions

Right-click the STB island entity to open a context menu with the following commands

Command Description
Configure Opens the Control Participant, which allows you to configure hardware, such as
modules of the STB island, devices connected through the CANopen bus, and
communication modules.
Physical Opens the Physical Connections window, which allows you to connect or disconnect
Connections the STB island to existing Ethernet networks to represent physical connections to such
(see page 603) networks.
Update Template Opens the Update Template dialog box, which allows you to update the templates that
(see page 608) are used by STB island entities with the highest available version of the Global
Templates library on the system server.
Export Opens the Export window, which allows you to export the entity and its folder hierarchy
(see page 610) in the form of a topology export file (.sbk).
Delete Deletes the STB island entity including its devices and related configurations.
(see page 578)
Rename Allows you to change the identifier of the STB island entity.
Properties Opens the Properties window in which you can view and edit properties of the STB
island.
NOTE: To view the parameters of the devices representing the hardware modules of
the STB island, refer to STB Island Representation (see page 577).

574 EIO0000001114 06/2020

 Configuration Stage

STB Island Properties

Right-click the STB island entity and select Properties to open the Properties window in which you
can view and edit its properties.

Item Description
General Identifier The identifier must be unique within the system and satisfy naming rules
(see page 98).
The folder identifier becomes part of the name of the items that the
software creates inside in the entity:
 Subfolders (identifier field)
 Devices ($Name parameter)

The identifier (or part of it) is also used to create the name of the DTM if
it is added during build (see page 690).
Description Optional.
You can enter a description of the STB island with free form text. The
description you enter appears in a tooltip when you move the pointer
over the entity.
Default value: Blank
Area Optional.
You can assign an access control number to the STB island entity.
Range: 1...255 (integer)
Default value: Blank
Identifier IPAddress IP address of the communication module of the STB island on the
<communication Ethernet network.
module ID> (1) Default value: Blank
Subnet Mask Subnet mask that is used to define IP addresses on the Ethernet network
that the communication module of the STB island belongs to.
Default value: Blank

(1) The section is displayed once you have closed the Participant window and saved changes.
NOTE: To view the parameters of the devices representing the hardware modules of the STB
island, refer to STB Island Representation (see page 577).

Changing STB Island Properties

Modifying the IP address or subnet mask of an STB island, may delete the communication
mapping (see page 630) that exists with this STB island.
In such case, the software displays a notification asking you to confirm the change. Make either
selection:
 Yes: To save the change to the properties of the STB island and delete the associated
communication mapping.
 No: To discard your changes.

EIO0000001114 06/2020 575

Configuration Stage

Configuring the STB Island

To configure the STB island, proceed as follows.

Step Action
1 Right-click the STB island folder in the Topology Explorer and select Configure.
Result: The Control Participant opens extracted (see page 134) and maximized.
2 Proceed with the configuration of the STB island.
For more information about configuring the STB island and working inside the Control
Participant, refer to the Control Participant Services User Guide (see EcoStruxure™
Process Expert, Control Participant Services, User Guide).
3 Click the close button in the toolbar of the Participant window.

Result: The software saves the changes in the configuration file, closes the Control Participant
window, and transfers the configuration to the Topology Explorer. It may display the Select
Template (see page 555) dialog box.
NOTE: If the software detects a configuration issue, it displays a notification, which allows you
to change the configuration until you are able to save it.
NOTE:
If you click the close button on the outer frame of the Participant window, the software displays
the Configuration dialog box where you can click:
Yes to save the changes in the configuration file and close the Participant
No to discard your changes and close the Participant
Cancel to leave the Participant open without saving your changes
4 Right-click the STB island entity and select Properties.
5 Enter the IP address and the subnet mask of the STB island.
6 Close the Properties window.

NOTE: To change the configuration of an STB island, follow the procedure to configure the STB
island, and make the changes inside the Control Participant.

Configuring Communication Between Controller and STB Island

Refer to Communicating with STB Islands Through Modbus TCP (see page 861) for details about
implementing communication by using the I/O scanner of the controller.

576 EIO0000001114 06/2020

 Configuration Stage

STB Island Representation

The Topology Explorer displays the devices representing the following hardware components of
the STB island entity once you have configured it:
 Segments
 Bus
 Power supply
 CPU
 Communication modules
 I/O modules
 Devices connected through the CANopen fieldbus

It lets you also view and configure their properties (see page 565).
The following figure shows the representation of an STB island entity with a device connected
through the CANopen fieldbus:

1 STB island folder representing the STB island entity

2 STB island bus folder containing the bus device (expanded view)
3 STB island drop folder
4 STB island rack folder containing the devices modeling the STB island modules: Power supply, I/O
modules, NIM, CANopen extension module, termination plate (expanded view)
5 STB island CANopen fieldbus folder containing the CANopen fieldbus device (collapsed view)
6 STB island drop folder containing the devices modeling the devices connected to the CANopen fieldbus of
the Island (collapsed view)

EIO0000001114 06/2020 577

Configuration Stage

Deleting an STB Island Entity

When you select the Delete command for an STB island entity, the software notifies you if it detects
any physical or mapping interface links with any device that is contained in the STB island folder
that you want to delete.
Once you have confirmed the delete command, the software executes the following actions in
relation to the devices that are being deleted:
 Interface links are deleted.
 The STB island folder, subfolders, and device contained therein are deleted
 The associated STB island profile is deleted.

To delete the STB island entity and its contents, proceed as follows.

Step Action
1 Right-click the STB island entity in the Topology Explorer and select Delete.
Result: A notification dialog box opens.
2 Verify the information that is displayed and click OK to proceed.
Result: The software deletes the STB island entity and its contents and displays a confirmation
message in the notification panel.

578 EIO0000001114 06/2020

 Configuration Stage

Configuring a PROFIBUS Remote Master and Decentralized Peripherals

Overview
The software allows you to model PROFIBUS remote masters (PRMs) and their decentralized
peripherals (DPs), which communicate with supported controller platforms through I/O scanning.
You proceed with the configuration of PRM and DPs from within the Control Participant by using
the default device type managers (DTMs) or generic station description (GSD) files that are
installed in the virtual machine. Thereafter, the software transfers the defined configuration to the
entity of the Topology Explorer by using the appropriate topological templates.
If the software cannot find the corresponding topological template for a DP, it uses the
$GenericPBSlave template. DPs that are modeled with this template use a generic mapping
interface that is available in the Hardware Mapping editor (see page 655).
NOTE: You can install additional DTMs and GSD files in the Control Participant by using the
Extensions section (see EcoStruxure™ Process Expert, Installation and Configuration Guide) of
the System Server Configuration Wizard.

Virtual Machine Usage

The configuration of one PRM entity uses up one session of the Control Participant of the virtual
machine (see EcoStruxure™ Process Expert, Installation and Configuration Guide).

Creating a PRM Entity

To create the PRM entity, which will contain the PRM and DP configuration (devices), proceed as
follows.

Step Action
1 Right-click the system root folder or a topology folder in the Topology Explorer, select Create
PRM Profibus DP.
Result: The software creates a PRM entity and displays it in the tree view.
2 Right-click the PRM entity and select Properties.
Result: The Properties window of the PRM entity opens.
3 Select the controller platform that the PRM is communicating with in the menu of the
ControllerFamily property (see page 581).
Result: When you configure the PRM entity (see page 582), the software loads the
corresponding base configuration.

EIO0000001114 06/2020 579

Configuration Stage

PRM Actions
Right-click the PRM entity to open a context menu with the following commands.

Command Description
Configure Opens the Control Participant, which allows you to configure the PRM and DPs by
(see page 582) using DTMs and/or GSD files.
Physical Opens the Physical Connections window, which allows you to connect or disconnect
Connections the PRM to existing Ethernet networks to represent physical connections to such
(see page 599) networks.
Update Template Opens the Update Template dialog box, which allows you to update the templates that
(see page 608) are used by PRM entities with the highest available version of the Global Templates
library on the system server.
Export Opens the Export window, which allows you to export the entity and its folder hierarchy
(see page 610) in the form of a topology export file (.sbk).
Delete Deletes the PRM entity including DPs and related configurations.
(see page 583)
Rename Allows you to change the identifier of the PRM entity.
Properties Opens the Properties window in which you can view and edit properties of the PRM
entity.
NOTE: To view the parameters of the PRM devices representing the hardware
modules, refer to PRM Representation (see page 583).

580 EIO0000001114 06/2020

 Configuration Stage

PRM Properties
Right-click the PRM entity and select Properties to open the Properties window in which you can
view and edit the properties of the PRM entity.

Item Description
General Identifier The identifier must be unique within the system and satisfy naming rules
(see page 98).
The entity identifier becomes part of the name of the devices that the
software creates inside in the entity:
 Folders (identifier field)
 Devices ($Name parameter)

The identifier (or part of it) is also used to create the name of the DTM if it is
added during build (see page 690).
NOTE: The identifier is not propagated to the PRM DTM (Alias name) in the
Control Participant.
Description Optional.
You can enter a description of the PRM with free form text. The description
you enter appears in a tooltip when you move the pointer over the entity.
Default value: Blank
Area Optional.
You can assign an access control number to the PRM entity.
Range: 1...255 (integer)
Default value: Blank
Controller ControllerFamily Indicates the hardware platform of the controller that the PRM
Family communicates with through I/O scanning.
The value needs to correspond to the family of the controller that you select
in the service mapping tab (see page 628) of the executable of the Control
Participant project.
Possible values:
 M340/M580
 Quantum

Default value: Quantum

NOTE: To view the parameters of the PRM devices representing the hardware modules, refer to
PRM Representation (see page 583).

EIO0000001114 06/2020 581

Configuration Stage

Configuring the PRM and its DPs

To configure the PRM and its DPs, proceed as follows.

Step Action
1 Right-click the PRM entity in the Topology Explorer and select Configure.
Result: The Control Participant opens extracted (see page 134) and maximized.
2 Proceed with the configuration of the PRM and its DPs inside the Control Participant.
For more information, refer to the topic describing the configuration of the PRM and DPs
(see EcoStruxure™ Process Expert, Control Participant Services, User Guide).
3 Click the save button in the toolbar of the Participant window.

Result: The software saves the changes in the configuration file and transfers the configuration
to the Topology Explorer. It may display the Select Template (see page 555) dialog box.
NOTE: If the software detects a configuration issue, it displays a notification, which allows you
to change the configuration until you are able to save it.
4 Close the Control Participant window.
NOTE:
If you change the configuration and you click the close button on the outer frame of the
Participant window without saving your changes first, the software displays the Save
Configuration dialog box where you can click:
Yes to save the changes in the configuration file and close the Participant window.
No to discard your changes and close the Participant window.
Cancel to leave the Participant open without saving your changes.

Changing the PRM Configuration

To change the configuration of a PRM, follow the procedure to configure a PRM, and proceed with
the changes within the Control Participant.
Saving changes to communication functions that you made within the Control Participant, may
delete existing communication mappings (see page 630) of the PRM.
In such case, the software displays a notification asking you to confirm the change. Make either
selection:
 OK: To save the change to the configuration file of the PRM and delete the associated
communication mapping.
 Cancel: To keep the Control Participant window open. Unsaved changes are not discarded.

For more information, refer to Configuring the PRM (see page 582).

582 EIO0000001114 06/2020

 Configuration Stage

PRM and DP Representation

The Topology Explorer allows you to view the topological devices representing the following
components of the PRM entity once you have configured it:
 PROFIBUS fieldbus
 PRM master
 PROFIBUS DPs

It lets you also view and configure their properties (see page 565).
The following figure shows the representation of a PRM master configuration with one DP
communicating with a Quantum controller.

1 PRM folder representing the PRM entity

2 PROFIBUS bus device
3 PRM device
4 DP device

Deleting a PRM Entity

Once you confirm the delete command, the software deletes the following components of the PRM
entity:
 Physical interface links
 The PRM entity, subfolders, and devices contained therein
 The corresponding Control Participant configuration project, including:

To delete the PRM entity and its contents, proceed as follows.

Step Action
1 Right-click the PRM entity in the Topology Explorer and select Delete.
Result: A notification dialog box opens.
2 Verify the information that is displayed and click OK to proceed.
Result: The software deletes the PRM entity and its contents, and displays a confirmation
message in the notification panel.

EIO0000001114 06/2020 583

Configuration Stage

Configuring Modbus TCP and EtherNet/IP Devices

Overview
The Topology Explorer lets you select and instantiate the topological template of devices that
communicate with the controller by using either:
 Modbus TCP implicit (I/O scanning) or explicit messaging.
 EtherNet/IP explicit messaging.

Each template creates an I/O device topological entity.

There are two types of I/O device templates:
 Templates that are specific to a Schneider Electric device (see EcoStruxure™ Process Expert,
Device Templates User Guide) (for example, $EATV32HW), which models an Altivar 32 speed
drive).
 Generic templates (for example, $EIPGenericDeviceHW), which let you model devices for
which no specific template is available. For generic Modbus TCP templates, select one that
creates the required number of I/O scanner lines.
Alternatively, instances of the $EGenericDeviceHW template can act as gateways when you
implement monitoring of Modbus serial device data directly from the Supervision infrastructure
(see page 920).

Selecting Topological I/O Device Templates

The Select Template dialog box displays templates of the Global Templates library that meet the
following criteria:
 Type: Topological
 SubType: Device-I/O
 Usability State (see EcoStruxure™ Process Expert, Global Templates, Reference Manual):
Approved or Deprecated

584 EIO0000001114 06/2020

 Configuration Stage

The following figure shows an example of the Select Template dialog box for Modbus TCP I/O
device templates in tree view mode.

1 Search field (see page 179) to search for topological I/O device templates.
2 Filters (see page 179). The check mark indicates that the filter is applied.
3 Button to toggle between grid view and tree view.

Column header Description

Template Identifier of the template.
In tree view mode, the path to the template in the Global Templates library is also
shown.
Version Version of the template.
State Usability state (see EcoStruxure™ Process Expert, Global Templates,
Reference Manual) of the template.
Description Description of the template.

EIO0000001114 06/2020 585

Configuration Stage

Creating an I/O Device Entity

To create an I/O device entity, proceed as follows.

Step Action
1 In the Topology Explorer, right-click the root or a topological folder and select Create Device IO →
Modbus TCP or EtherNet/IP.
Result: The Select Template dialog box opens displaying the corresponding templates.
2 Select a template and click OK.
Result: The software creates an instance of the selected template in the folder, which represents
the I/O device topological entity.
NOTE: Click Cancel to close the Select Template dialog box without creating the I/O device entity.

Modbus TCP and EtherNet/IP Device Actions

Right-click the I/O device entity to open a context menu with the following commands.

Command Description
Physical Opens the Physical Connections window, which allows you to connect or disconnect the
Connections device to existing Ethernet networks to represent physical connections to such
(see page 602) networks.
Update Template Opens the Update Template dialog box, which allows you to update the template that is
(see page 608) used by Modbus TCP device entities with the highest available version of the Global
Templates library on the system server.
Replace Template Opens the Replace Device Template dialog box, which allows you to replaces the
(see page 245) template that is used by the device with another template that meets the criteria
(see page 584) and that is available in the Global Templates library on the system
server.
Delete Deletes the device entity including related configurations and mappings.
(see page 578)
Rename Allows you to change the identifier of the Modbus TCP device entity.
Export Opens the Export window, which allows you to export the entity and its folder hierarchy
(see page 610) in the form of a topology export file (.sbk).
Properties Opens the Device Editor window in which you can view and edit properties of the device
entity.

586 EIO0000001114 06/2020

 Configuration Stage

I/O Device Properties

Right-click the device entity and select Properties to open the Device Editor window in which you
can view and edit its parameters.
You can view and/or edit the following parameters.

Parameter Description
$System $Name The identifier must be unique within the system and
satisfy naming rules (see page 98).
The default value: xHW_n where x is the identifier of the
corresponding application template of the device and n
an incremental number starting at 1.
The identifier (or part of it) is also used to create the name
of the DTM if it is added during build (see page 690).
String.
$Description Optional.
You can enter a description of the device with free form
text (string).
$Area Optional.
You can assign an access control number to the device
entity.
Range: 1...255 (integer)
Communication IPAddress IP address of the device on the Ethernet network.
Default value: Blank
Subnet Mask Subnet mask that is used to define IP addresses on the
Ethernet network that the device belongs to.
Default value: Blank
IOScanningLines(1) You can select the number of I/O scanner lines that are
generated during build.
Possible values: 1 to n, where n, is the maximum number
of lines that a given template can generate.
Default value: Varies by template.
ID(2) Modbus unit ID, unique identifier of the device. The
parameter is provided by the DeviceID element of the
Modbus TCP server interface (MBTCPServiceServer),
which is referenced by all Schneider Electric
Modbus TCP I/O device hardware templates.
Default value: 255
Valid range: 0 to 255
(UnsignedInt).
For example, for Altivar variable speed drives, the
identifier is 255.
NOTE: You can configure the parameter also in the
Communication Mapping tab (see page 683) of
Supervision executables.

EIO0000001114 06/2020 587

Configuration Stage

Parameter Description
Communication ReadLength(2) Number of words to be read (integer).
Enter an appropriate value. The value cannot be null
when you implement communication by using I/O
scanning with the CPU of an M580 controller or a NOC
communication module.
Default value: 0
ReadAddress(2) Remote address (%MW) to be read (integer).
Enter an appropriate value.
Default value: 0
WriteLength(2) Number of words to be written (integer).
Enter an appropriate value. The value cannot be null
when you implement communication by using I/O
scanning with the CPU of an M580 controller or a NOC
communication module.
Default value: 0
WriteAddress(2) Remote address (%MW) to be written (integer).
Enter an appropriate value.
Default value: 0
Description(2) Optional.
Enter a description of the device with free form text
(string).

588 EIO0000001114 06/2020

 Configuration Stage

Parameter Description
Configuration Privilege Parameter for access control purposes.
Default value: Blank
(String).

IOSType(3) Parameter to select the I/O scanning element to be used:

 TesysTE: To read/write the complete data from/to the
device.
 TesysTEFast: To read/write a minimum set of data
from/to the device. Default value.
The selection and the device template that is used in the
application of the system needs to match; otherwise you
cannot proceed with the hardware mapping
(see page 655).
For example, if you select TesysTEFast for this
parameter, instantiate the $TesysTEFast template in
the application.
(Enum).
NOTE: Changing this parameter value when the
hardware mapping is done removes the mapping.
EnableDHCP When true, the device subscribes to a DHCP server
service.
IdentifyByDeviceName When true, the DHCP server identifies the device by
using DTMDeviceName; otherwise, it identifies the
device by using MACAddress.
MACAddress MAC address of the device.
Use a hyphen as separator.
DTMDeviceName Name of the device.
For example, TeSys064.

PhysicalInterfaceLink1(4) Destination Instance Indicates to which Ethernet network the device is

connected.
Role Indicates the identifier of the role of the interface.
Interface Indicates the identifier of the interface that the device
exposes for connection to the Ethernet network.

(1) The parameter is displayed only for entities using a generic topological Modbus TCP device
template, which allows selecting the number of I/O scanner lines that are generated (for
example, $EGenDev4IOSHW).
(2) The parameters are available only for entities using a generic topological Modbus TCP device
template (and also for a few Modbus TCP device-specific templates). For generic templates that
reference several Modbus TCP server interfaces (for example, $EGenDev4IOSHW), the set of
parameters appears as many times as there are server interfaces in the template.

EIO0000001114 06/2020 589

Configuration Stage

(3) The parameter is available only for certain Modbus TCP entities (for example, those using the
$ETesysTHW template).
(4) The section is displayed if you have connected (see page 602) the I/O device entity to an
Ethernet network of the system. The parameters are not editable.

Changing I/O Device Properties

Modifying the IP address or subnet mask of an I/O device entity, may delete the communication
mapping (see page 630) that exists with this device.
In such case, the software displays a notification asking you to confirm the change.
Make either selection:
 Yes: To save the change to the properties of the I/O device and delete the associated
communication mapping.
 No: To discard your changes.

Implementing Communication Between Controllers and I/O Devices

For details about how to implement communication between controllers and I/O devices by using
Modbus TCP or EtherNet/IP, refer to the topic describing how to manage communication
(see page 855).

590 EIO0000001114 06/2020

 Configuration Stage

Configuring HART Modules

Overview
The HART communication protocol can be addressed by using either of these Modicon eX80
modules:
 BMEAHI0812 HART analog input module.
 BMEAHO0412 HART analog output module.

You can add these HART analog I/O modules to local racks and/or remote drops of controllers of
the Quantum and M580 platform. With the Quantum platform, a NOC communication module is
required.
You proceed with the configuration of HART modules from within the Control Participant by using
the Configure command on a controller entity.
Thereafter, the software transfers the defined configuration to the entity of the Topology Explorer
by using the appropriate topological templates.
NOTE: Addressing the HART protocol by using a Modicon STB island is also possible with the
STBAHI8321 HART interface module (see page 573).

Managed Data
The Primary Variable (PV) of HART analog I/O modules is the only variable that is available in the
Hardware Mapping Editor later on. During this stage, you can map facets of analog I/O templates
(for example, $AnalogInput1) instantiated in the application, which represent PV, to the
projection of the I/Os of the HART modules.
The other variables and data of the HART modules that you configure are preserved during build
and can be deployed to a controller but are not usable at the system level.
NOTE: You need to use an Asset Management System and perform some additional steps
(see EcoStruxure™ Process Expert , Foundation Application Templates, User Guide) manually to
take advantage of the advanced functionality provided by HART analog I/O modules.

HART Module Device DDT Variables

When you add a HART analog I/O module to a configuration, the Participant creates a device DDT
(DDDT) variable associated to the I/O the module.
When you add the corresponding HART device type manager (DTM) that is preinstalled, it creates
a second DDDT variable associated to the DTM to manage the extended data.
Both variable are present only in the configuration that you can access from the Topology Explorer
and are integrated to the Control Participant project during build (see page 689). However, if you
want to use the two DDDTs in a Control Participant project during refinement, you can create them
(see page 517).

EIO0000001114 06/2020 591

Configuration Stage

Configuring HART Modules

To configure HART analog I/O modules, proceed as follows.

Step Action
1 Right-click the controller entity in the Topology Explorer and select Configure.
Result: The software displays the Control Participant in a reduced window.
2 Maximize the Control Participant.
3 Proceed with the configuration of the HART module inside the Control Participant.
For more information about configuring HART analog I/O module and working inside the Control
Participant, refer to the topic describing the configuration of the controller (see EcoStruxure™
Process Expert, Control Participant Services, User Guide).
4 Click the save button in the toolbar of the Participant window.

Result: The software saves the changes in the configuration file and transfers the configuration
to the Topology Explorer. It may display the Select Template (see page 555) dialog box.
NOTE: If the software detects a configuration issue, it displays a notification, which allows you
to change the configuration until you are able to save it.
5 Close the Control Participant window.
NOTE:
If you change the configuration and you click the close button on the outer frame of the
Participant window without saving your changes first, the software displays the Save
Configuration dialog box where you can click:
Yes to save the changes in the configuration file and close the Participant window.
No to discard your changes and close the Participant window.
Cancel to leave the Participant open without saving your changes.

Changing the HART Module Configuration

To change the configuration of a HART analog I/O module, follow the procedure to configure a
HART module, and proceed with the changes inside the Control Participant.

592 EIO0000001114 06/2020

 Configuration Stage

HART Module Representation

The Topology Explorer allows you to view the topological devices representing HART analog
I/O modules.
It lets you also view and configure their properties (see page 565).
The following figure shows the representation of a BMEAHI0812 HART analog I/O module located
in the local rack of an M580 controller entity.

1 Device representing the HART module.

NOTE: The HART module is represented similarly in a topological entity based on the Quantum
platform.

EIO0000001114 06/2020 593

Configuration Stage

Configuring an Ethernet Network

Overview
The Ethernet network entity represents a physical or virtual Ethernet local area network (LAN or
VLAN) to which you can physically connect topological entities of the system such as controllers,
Modbus TCP devices, Ethernet IP devices, and station nodes.
You create Ethernet network entities and define their parameters in the Topology Explorer.

Creating an Ethernet Network Entity

To create an Ethernet network entity, proceed as follows.

Step Action
1 Right-click the system root folder or a topological folder in the Topology Explorer and select
Create Ethernet Network.
Result: The software creates an Ethernet network entity and displays it inside the folder.
NOTE: The software may display the Select Template (see page 555) dialog box.

Ethernet Network Actions

Right-click the Ethernet network entity to open a context menu with the following commands.

Command Description
Update Template Opens the Update Template dialog box, which allows you to update the template that
(see page 608) is used by the Ethernet network entity with the highest available version of the Global
Templates library on the system server.
Export Opens the Export window, which allows you to export the entity and its folder hierarchy
(see page 610) in the form of a topology export file (.sbk).
Delete Deletes the entity including related configurations.
Rename Allows you to change the identifier of the Ethernet network entity.
Properties Opens the Device Editor window in which you can view and edit properties of the
Ethernet network.

594 EIO0000001114 06/2020

 Configuration Stage

Ethernet Network Properties

Right-click the Ethernet network entity and select Properties to open the Device Editor window in
which you can view and edit parameters of the Ethernet network.
You can view and/or edit the following parameters.

Parameter Description
$System $Name The identifier must be unique within the system and satisfy
naming rules (see page 98).
Default value: EthernetNetwork_n where n is an incremental
number starting at 1.
$Description Optional.
You can enter a description of the Ethernet network with free
form text.
Default value: Blank
$Area Optional.
You can assign an access control number to the Ethernet
network entity.
Range: 1...255 (integer)
Default value: Blank
PhysicalInterfaceLinkX(1) Indicates which topological entities and/or devices you have connected to the
Ethernet network.
A section containing these parameters is displayed for each of the connected
topological entities and devices, including connections to standby controllers
of redundant configurations.
Destination Indicates the $Name of the connected entity or device
Instance (see page 563).
Role Indicates the identifier of the role of the interface.
Interface Indicates the identifier of the interface that the Ethernet
network entity exposes for connecting with the topological
entity or device.

(1) The section is displayed if you have connected (see page 596) topological entities or devices
to the Ethernet network. The parameters are not editable. X represents the number of the
physical interface link, which is an incremental number starting at 1.

EIO0000001114 06/2020 595

Configuration Stage

Connecting to an Ethernet Network

Overview
The Physical Connections command allows you to connect topological entities that support
Modbus TCP or Ethernet IP connectivity to an Ethernet network entity of the system.
The physical interface link that is created represents the physical connection of communication
modules to a network.
At the platform level, physical connections for entities are required to be able to perform the
communication mapping (see page 623) in Control and Supervision executables. They are not
required to perform service mapping or deployment and execution tasks.
Devices with which you can create a physical connection are identified by using their $Name
parameter (see page 563).
To make a physical connection, create an Ethernet network first (see page 594).
NOTE: The command also allows you to disconnect an entity from an Ethernet network.

IP Address Uniqueness Requirement

The IP address of a topological entity and/or its communication module on the Ethernet network
must be unique to make the physical connection possible. This rule applies to:
 CPU modules (including main IP address and IP address A depending on controller platform)
 Communication modules such as:
 NOE
 NOC (for 140NOC78•00 modules, main IP address only, not IP address A)
 CRA
 NIC of station nodes
 NIM of STB islands
 Embedded RIO scanner services (see page 563) of M580 CPUs

 Modbus TCP and Ethernet IP I/O devices

 PROFIBUS remote masters (PRMs)
NOTE: Refer also to rules for redundant controller entities (see page 597).

Viewing Connections to Ethernet Networks

The PhysicalInterfaceLink parameter allows you to view, which entities are connected to which
Ethernet network. Access the parameter by right-clicking either of the following and selecting
Properties:
 The Ethernet network entity (see page 595).
 The communication module of a topological entity

NOTE: You can also right-click an entity and select Physical Connections to view the Ethernet
network to which the entity if connected to.

596 EIO0000001114 06/2020

 Configuration Stage

Availability of Ethernet Networks

If the communication or hardware mapping editor is open for an entity, then the Ethernet network
to which this entity is connected is not available. Because of this, you cannot use the Physical
Connections command to connect other entities to this Ethernet network or change existing
connections to this network.
Close the communication mapping editor to release the Ethernet network.

Managing Conflicting Connections to Ethernet Networks

If the system contains at least 2 entities, each with a communication module physically connected
to an Ethernet network, and during the configuration of 1 of the entities, you enter a conflicting IP
address for the module, a dialog box opens when you attempt to save the configuration, requiring
confirmation to remove the physical connection of the module.
Click:
OK To remove the physical connection of the module, disconnecting it from the Ethernet network.
Cancel To cancel the save operation and keep the Control Participant open, which allows you to
change the configuration.
For more information, refer to Considerations When Updating an Existing Configuration
(see EcoStruxure™ Process Expert, Control Participant Services, User Guide).
NOTE: Removing the physical connection to an Ethernet network deletes all or part of the existing
communication and hardware mapping of the associated Control Participant project executable.

Connections with Redundant Controllers

For redundant controllers, the rule about uniqueness of the IP address on an Ethernet network to
make the connection possible applies also to:
 For CPU modules:
 (Main) IP address +1 (where IP address is the address of the CPU module of the primary
controller)
 IP address B (M580 platform)

 For BMENOC3•1 communication modules, main IP address +1 only (not IP address B)

 For 140NOC78•00 communication modules, IP address +1 (where IP address is the address of
the NOC module of the primary controller)
 For NOE communication modules, IP address +1 (where IP address is the address of the NOE
module of the primary controller)
Therefore, when a standalone controller is connected to an Ethernet network and you change the
configuration to a redundant one, already connected modules of the controller that has become the
primary controller may be disconnected. This affects existing mappings (see page 561).

EIO0000001114 06/2020 597

Configuration Stage

The table describes the various scenarios when you change the configuration of a standalone
controller to a redundant one depending on the status of the IP address of counterpart modules in
the standby controller. It is assumed that the standalone controller becomes the primary controller
of the redundant configuration.

Status of physical IP address(1) of counterpart Impact on the physical connection of both modules
connection of module in module in the standby to the Ethernet network
standalone configuration controller after changing to
redundant configuration
Connected Unique Both modules are connected.
Connected Already exists Module of the primary controller is disconnected.
Module of the standby controller is not connected.
Not connected irrelevant Both modules are not connected.
(1) If the module has two IP addresses both are considered unless otherwise mentioned.

For example, if the local rack of an M580 standalone controller contains an NOC module, which is
connected to an Ethernet network (main IP address) and the CPU communication module is also
connected (Main IP address and IP address A) if, when you change this configuration to a
redundant one, the IP address of the NOC module of the standby controller (main IP address +1)
is not unique on the same network, then it is not connected to the network and the NOC module of
the primary controller is disconnected from the network. If the IP addresses of the CPU
communication module of the standby controller are unique, both primary and standby CPU
communication modules are connected to the network.
The other way around, when you change the configuration of a redundant controller to a
standalone one, the modules that were connected to the Ethernet network remain connected.

598 EIO0000001114 06/2020

 Configuration Stage

Connecting a Controller to an Ethernet Network

You can connect controller entities that offer physical connectivity to existing Ethernet networks of
the system.
To connect a controller to an Ethernet network, proceed as follows.

Step Action
1 Right-click the controller entity in the Topology Explorer and select Physical Connections.
Result: The software opens the Physical Connections window and displays the identifier of the
communication modules of the controller in the Communication Modules column.
NOTE:
 The identifier only appears if you have assigned an IP address to the communication module
in the configuration.
 When connecting a redundant controller, only communication modules of the primary
controller are displayed in the Physical Connections window.
 When connecting a controller that has a CRP module or an embedded RIO scanner service
(M580 CPUs), the EthRIO bus device that is displayed in the Physical Connections window
represents the physical connection with the remote I/O network. It connects the
corresponding communication modules such as CRP and CRA modules, and the embedded
RIO scanner service.
2 Click the field in the Allowed Network(s) column next to the communication module that you want
to connect to the network.
Result: The Ethernet networks to which a connection is possible are displayed.
3 Select a network.
4 Click OK to save your selection and close the Physical Connections window.
Result: The communication module is connected to the selected Ethernet network.
NOTE:
 For redundant controllers, the software automatically connects the counterpart module of the
standby controller to the same Ethernet network.
 For BMENOC3•1 communication modules, IP addresses A and B are not connected.

EIO0000001114 06/2020 599

Configuration Stage

Disconnecting a Controller from an Ethernet Network

To disconnect a controller from an Ethernet network, proceed as follows.

Step Action
1 Right-click the controller entity in the Topology Explorer and select Physical Connections.
Result: The software opens the Physical Connections window and displays the identifier of:
 The communication modules of the controller in the Communication Modules column
 The Ethernet network to which the controller is connected in the Allowed Network(s) column

NOTE:
 When disconnecting a redundant controller, only the communication modules of the primary
controller are displayed in the Physical Connections window.
 When disconnecting a controller that as CRP module or an embedded RIO scanner service
(M580 CPUs), the EthRIO bus device that is displayed in the Physical Connections window,
represents the physical connection with the remote I/O network. It disconnects the
corresponding communication modules, such as CRP and CRA modules, and the embedded
RIO scanner service.
The other way around, when the software disconnects (see page 597), for example, a CRA
module because of an IP address conflict, it is the EthRIO bus device that is disconnected.
2 Click the field in the Allowed Network(s) column next to the communication module that you want
to disconnect from the network.
Result: The Ethernet networks to which a connection is possible are displayed.
3 Select Not Assigned in the Allowed Network(s) menu.
NOTE: You may also select another Ethernet network from the menu (if available) to create a
connection with it instead.
4 Click OK.
Result: If a communication mapping exists for the executable to which the controller is mapped,
the software displays a notification, asking you to confirm the disconnection.
Otherwise, the software disconnects the communication module from the selected Ethernet
network, and closes the Physical Connections window.
NOTE: For redundant controllers, the software automatically disconnects the counterpart
module of the standby controller from the same Ethernet network.
5 Click Yes to confirm.
Result: The software:
 Disconnects the communication module from the selected Ethernet network.
 Deletes the existing mappings (see page 561) of the executable to which the controller is
mapped.
 Changes the status of the executable to which the controller is mapped to Out Of Date if it is
built.
 Closes the Physical Connections window.

NOTE: Click No to close the Physical Connections window without disconnecting the
communication module from the Ethernet network.
NOTE: For a redundant controller, the software automatically disconnects the counterpart
module of the standby controller from the same Ethernet network.

600 EIO0000001114 06/2020

 Configuration Stage

Connecting a Station Node to an Ethernet Network

You can connect or disconnect station node entities to existing Ethernet networks through their NIC
devices.
To connect a station node to an Ethernet network, proceed as follows.

Step Action
1 Right-click the station node entity in the Topology Explorer and select Physical Connections.
Result: The software opens the Physical Connections window and displays the identifier of the
NIC of the station node in the Communication Modules column.
NOTE: The NIC identifier only appears if you have assigned an IP address to the NIC.
2 Click the field in the Allowed Network(s) column next to the NIC that you want to connect to the
network.
Result: The Ethernet networks to which a connection is possible are displayed.
3 Select a network.
4 Click OK to save your selection and close the Physical Connections window.
Result: The station node is connected to the selected Ethernet network.

Disconnecting a Station Node from an Ethernet Network

To disconnect a station node entity from an Ethernet network, proceed as follows.

Step Action
1 Right-click the station node entity in the Topology Explorer and select Physical Connections.
Result: The software opens the Physical Connections window and displays the identifier of:
 The NIC of the station node in the Communication Modules column
 The Ethernet network to which the NIC is connected in the Allowed Network(s) column

2 Click the field in the Allowed Network(s) column next to the NIC that you want to disconnect from
the network.
Result: The Ethernet networks to which a connection is possible are displayed.
3 Select Not Assigned in the Allowed Network(s) menu.
NOTE: You may also select another Ethernet network from the menu (if available) to create a
connection with it instead.
4 Click OK.
Result: The software:
 Disconnects the station node from the selected Ethernet network.
 Deletes the existing communication mapping (see page 630) of the executable to which the
station node is mapped.
 Changes the status of the executable to which the station node is mapped to Out Of Date if
it is built.
 Closes the Physical Connections window.

EIO0000001114 06/2020 601

Configuration Stage

Connecting a Modbus TCP or Ethernet IP Device to an Ethernet Network

You can connect or disconnect Modbus TCP and Ethernet IP device entities to existing Ethernet
networks.
To connect an I/O device entity to an Ethernet network, proceed as follows.

Step Action
1 Right-click the device entity in the Topology Explorer and select Physical Connections.
Result: The software opens the Physical Connections window and displays the device entity
identifier in the Communication Modules column.
NOTE: The device identifier only appears if you have assigned an IP address to the device.
2 Click the field in the Allowed Network(s) column next to the device that you want to connect to
the network.
Result: The Ethernet networks to which a connection is possible are displayed.
3 Select a network.
4 Click OK to save your selection and close the Physical Connections window.
Result: The device is connected to the selected Ethernet network.

Disconnecting a Modbus TCP or Ethernet IP Device from an Ethernet Network

To disconnect a Modbus TCP or Ethernet IP device entity from an Ethernet network, proceed as
follows.

Step Action
1 Right-click the device entity in the Topology Explorer and select Physical Connections.
Result: The software opens the Physical Connections window and displays the identifier of:
 The I/O device in the Communication Modules column
 The Ethernet network to which the device is connected in the Allowed Network(s) column

2 Click the field in the Allowed Network(s) column next to the device that you want to disconnect from
the network.
Result: The Ethernet networks to which a connection is possible are displayed.
3 Select Not Assigned in the Allowed Network(s) menu.
NOTE: You may also select another Ethernet network from the menu (if available) to create a
connection with it instead.
4 Click OK.
Result: If a hardware or communication mapping exists for the executable of the client controller
communicating with the device, the software displays a notification, asking you to confirm the
disconnection.
Otherwise, the software disconnects the I/O device from the selected Ethernet network, and closes
the Physical Connections window.

602 EIO0000001114 06/2020

 Configuration Stage

Step Action
5 Click Yes to confirm.
Result: The software:
 Disconnects the I/O device from the selected Ethernet network.
 Deletes the existing hardware mapping (see page 655) and communication mapping
(see page 630) of the executable of the client controller communicating with the device.
 Changes the status of the client controller communicating with the device to Out Of Date if it is
built.
 Closes the Physical Connections window.

NOTE: Click No to close the Physical Connections window without disconnecting the I/O device from
the Ethernet network.

Connecting an STB Island to an Ethernet Network

You can connect or disconnect STB islands to existing Ethernet networks through their NIM.
To connect an STB island to an Ethernet network, proceed as follows.

Step Action
1 Right-click the STB island entity in the Topology Explorer and select Physical Connections.
Result: The software opens the Physical Connections window and displays the identifier of the
communication module of the STB island in the Communication Modules column.
NOTE: The module identifier only appears if you have assigned an IP address to the NIM.
2 Click the field in the Allowed Network(s) column next to the communication module that you want to
connect to the network.
Result: The Ethernet networks to which a connection is possible are displayed.
3 Select a network.
4 Click OK to save your selection and close the Physical Connections window.
Result: The STB island entity is connected to the selected Ethernet network.

EIO0000001114 06/2020 603

Configuration Stage

Disconnecting an STB Island from an Ethernet Network

To disconnect an STB island entity from an Ethernet network, proceed as follows.

Step Action
1 Right-click the STB island entity in the Topology Explorer and select Physical Connections.
Result: The software opens the Physical Connections window and displays the identifier of:
 The NIM of the STB island in the Communication Modules column
 The Ethernet network to which the NIM is connected in the Allowed Network(s) column

2 Click the field in the Allowed Network(s) column next to the NIM that you want to disconnect from the
network.
Result: The Ethernet networks to which a connection is possible are displayed.
3 Select Not Assigned in the Allowed Network(s) menu.
NOTE: You may also select another Ethernet network from the menu (if available) to create a
connection with it instead.
4 Click OK.
Result: If a hardware or communication mapping exists for the executable of the client controller
communicating with the STB island, the software displays a notification, asking you to confirm the
disconnection.
Otherwise, the software disconnects the STB island entity from the selected Ethernet network, and
closes the Physical Connections window.
5 Click Yes to confirm.
Result: The software:
 Disconnects the STB island entity from the selected Ethernet network.
 Deletes the existing hardware mapping (see page 655) and communication mapping
(see page 630) of the executable of the client controller communicating with the STB island.
 Changes the status of the client controller communicating with the STB island to Out Of Date if it
is built.
 Closes the Physical Connections window.

NOTE: Click No to close the Physical Connections window without disconnecting the
communication module from the Ethernet network.

Connecting a PRM to an Ethernet Network

You can connect or disconnect PRM entities to existing Ethernet networks.
To connect a PRM entity to an Ethernet network, proceed as follows.

Step Action
1 Right-click the PRM entity in the Topology Explorer and select Physical Connections.
Result: The software opens the Physical Connections window and displays the PRM entity
identifier in the Communication Modules column.
NOTE: The PRM identifier only appears if you have assigned an IP address (see page 582) to
the PRM.
2 Click the field in the Allowed Network(s) column next to the PRM.
Result: The Ethernet networks to which a connection is possible are displayed.

604 EIO0000001114 06/2020

 Configuration Stage

Step Action
3 Select a network.
4 Click OK to save your selection and close the Physical Connections window.
Result: The PRM is connected to the selected Ethernet network.

Disconnecting a PRM from an Ethernet Network

To disconnect a PRM entity from an Ethernet network, proceed as follows.

Step Action
1 Right-click the PRM entity in the Topology Explorer and select Physical Connections.
Result: The software opens the Physical Connections window and displays the identifier of:
 The PRM in the Communication Modules column
 The Ethernet network to which the PRM is connected in the Allowed Network(s) column

2 Click the field in the Allowed Network(s) column next to the PRM.
Result: The Ethernet networks to which a connection is possible are displayed.
3 Select Not Assigned in the Allowed Network(s) menu.
NOTE: You may also select another Ethernet network from the menu (if available) to create a
connection with it instead.
4 Click OK.
Result: If a hardware or communication mapping exists for the executable of the client controller
communicating with the PRM, the software displays a notification, asking you to confirm the
disconnection.
Otherwise, the software disconnects the PRM from the selected Ethernet network, and closes the
Physical Connections window.
5 Click Yes to confirm.
Result: The software:
 Disconnects the PRM entity from the selected Ethernet network.
 Deletes the existing hardware mapping (see page 655) and communication mapping
(see page 630) of the executable of the client controller communicating with the PRM.
 Changes the status of the client controller communicating with the PRM to Out Of Date if it is built.
 Closes the Physical Connections window.

NOTE: Click No to close the Physical Connections window without disconnecting the PRM from the
Ethernet network.

EIO0000001114 06/2020 605

Configuration Stage

Section 17.2
Managing the Topology

Managing the Topology

Overview
This section describes how to use the software to manage the topology of the system.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Moving Topological Folders and Entities 607
Updating Templates of Topological Entities 608
Exporting Topological Entities 610
Importing Topological Entities 613

606 EIO0000001114 06/2020

 Configuration Stage

Moving Topological Folders and Entities

Moving Topological Folders

You can move any topological folder to another folder, including the system root folder, by dragging
it.

EIO0000001114 06/2020 607

Configuration Stage

Updating Templates of Topological Entities

Overview
By using the Update Template command in the Topology Explorer, you can update the templates
that are used by the following topological entities and their devices:
 Controllers
 STB islands
 Station nodes
 Modbus TCP and Ethernet IP devices
 PROFIBUS Remote Masters and DPs
 Ethernet networks

If the update of one template cannot be completed for an entity, the entire update process is rolled
back.
When used at the folder level, the command applies to any entity that is contained in the folder,
and in any of its subfolders.
NOTE:
The update functionality affects:
 Existing service, communication, and hardware mapping interface links.
 Deployment information related to the executable to which the entity is mapped.

NOTE: No command is available to replace a topological template, such as the $UnknownModule

template (see EcoStruxure™ Process Expert, Control Participant Services, User Guide).

Accessing the Command

Right-click a folder or an entity, and select Update Template.

Description of the Update Functionality

The software proceeds with the update of templates in the following order:
 The templates that are associated to the entity are updated.
 Interface links are processed.

The table describes the effects on the different template items when you update the templates that
are used by a topological entity:

Item Identifier in New Template Action

Parameter Is same as in current template Explicitly defined parameters of the current template keep their
values respective value in the new template.
Is not in current template New parameters that are not part of the current template keep
their default values.

608 EIO0000001114 06/2020

 Configuration Stage

Item Identifier in New Template Action

Physical Is same as in current template Physical interface links of the entity are maintained.
interface links Is not the same as in current New physical interface links can be added. Physical interface
(see page 596) template links that are not part of the new template or that do not satisfy
applicable rules are removed.
Mappings – The software maintains existing service, communication, and
(see page 624) hardware mapping interface links of the Control and
Supervision executables to which the entity is mapped if the
corresponding mapping interfaces are available, and satisfy
applicable rules.
Deployment – If you had deployed a Control project to a station node or
information controller entity, the corresponding deployment information is
unchanged.

NOTE: When you update the template of a redundant controller entity, the update takes places for
both the primary and the standby controller entities.

Default Template Selection

By default, the software selects the topological template with the same identifier that has the
highest version number with the Usability State of Approved.

Updating Templates
To update the templates that are used by a topological entity, proceed as follows:

Step Action
1 In the tree view of the Topology Explorer, right-click the entity and select Update Template.
Result: The Update Device Template dialog box opens. It shows for each device template that can
be updated, the new version that will be used.
2 Click OK.
Result: The software:
 Updates the templates that are used by the entity.
 May delete existing mapping information of the corresponding executable of the Control project.

NOTE: Click Cancel to close the Update Device Template dialog box without updating templates.

NOTE: If you use a filter in the Name column of the Update Device Template dialog box and as a
result, only some of the device templates for which a later version exists are displayed, the update
operation is still performed on the entire selection of device templates of the entity for which a later
version exists.

EIO0000001114 06/2020 609

Configuration Stage

Exporting Topological Entities

Overview
The Export command allows you to create a non-editable export file (.sbk), which contains
information of selected topological entities, their folder hierarchy, and dependencies.
You can use this data with the import (see page 613) functionality of the Topology Explorer to:
 Transfer project information to a different system or EcoStruxure Process Expert infrastructure.
 Add and/or modify topological entities.
 Duplicate topological entities.
 Move, remove, replace, and/or add devices of entities.
 Update properties of entities and folders.
 Prepare the topology of a system before importing Control and/or Supervision Participant
projects.

Software Version Compatibility

The version of EcoStruxure Process Expert that you use to import the information contained in the
export file must be the same as the version that you used to create the export file (a service pack
is considered the same version); otherwise you cannot proceed with the import.

Export File Contents

You can select the Export command at different levels to export the following:
 For an entity: Exports the data pertaining to this topological entity and its devices. The parent
folder hierarchy up to the system root folder is also included.
 For a topological folder: Exports the entities contained in the folder and in any subfolders, and
their devices. The parent folder hierarchy up to the system root folder is also included.
 For the system root folder: Exports the entities of the entire system and their devices. The parent
folder hierarchy up to the system root folder for any entity is also included.
By default, in each case, the folder hierarchy of the exported entities is selected for export.
You cannot export empty folders or folders that contain entities that are not selected for export. The
rule does not apply for folders that are part of the parent folder hierarchy of an exported entity or
folder.
NOTE: If physical connections exist for a selected entity at the time of export, these links are
automatically included in the export file. This allows recreating the physical connection at the time
of import if applicable rules are satisfied (see page 616).
NOTE: Passwords (see page 725) are not exported. Yet, the password protection properties
(see page 558) and their value are exported.

610 EIO0000001114 06/2020

 Configuration Stage

Topological Templates
The export file does not contain the topological templates of the entities and devices that you are
exporting. To import entities in a different EcoStruxure Process Expert infrastructure, the Global
Templates library of the target architecture needs to contain the necessary templates with the
same version. Entities for which the template is not present cannot be imported.
For information on how to export templates, refer to the topic that describes managing Global
Templates (see page 978).

Topological Export Window

The topological Export window allows you to select the entities and folders that you export.
The following figure shows an example of the Export window in tree view mode.

1 Button to toggle between the grid view and tree view

EIO0000001114 06/2020 611

Configuration Stage

Header Description
Name Shows the identifier of topological entities that you can export.
By default, entities are selected for export.
NOTE: When check boxes of folders are filled with a black square, at least one entity
or folder in a sublevel is not selected for export.
Type Type of the topological entity (controller, station node, Ethernet network, and so on).
Path Path to the folder or entity.
The column is displayed only in grid view.
Description Contents of the Description property of the entity.

NOTE: To expand/collapse a node in the Export window, select the node and press Enter.

Aborting Export Tasks

After confirming the export by clicking Save in the Save dialog box, the abort icon is displayed in
the notification panel (see page 86). Click the icon to cancel the task. The export file is not created.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are exporting only a few entities, the task may complete before you are able to click
the icon.

Creating the Export File

To create a topology export file, proceed as follows.

Step Action
1 In the Topology Explorer, right-click the folder or entity that you want to export and select Export.
Result: The software opens the Export window and displays the entities that you can export.
2 Select the entities that you want to export.
3 Click OK.
Result: The software opens the Save dialog box.
NOTE: Click Cancel to close the Export window without creating the export file.
4 Select a location where you want to save the export file, enter a file name, and click Save.
Result: The software creates the export file (.sbk), which contains information of the selected
topological entities.
NOTE: Click Cancel to close the Save dialog box and revert to the Export window.

612 EIO0000001114 06/2020

 Configuration Stage

Importing Topological Entities

Overview
The import functionality allows you to import data of topological folders and entities from a
topological export file (.sbk), which was created by using the export (see page 312) functionality of
the Topology Explorer.
You can import this data into an existing system by using the Import command of the Topology
Explorer.
You have the possibility to select which items you want to import out of those contained in the
export file.
Before proceeding with the import, the software verifies if importing the selected instances creates
a duplicate entity identifier or an IP address conflict. If required, the import operation includes a
second step, which allows you to resolve conflicts by selecting an action to perform during import:
 Skip the entity; it is not imported.
 Update the entity of the target system with the configuration of the export file.
 Create the entity with a different, unique identifier.

The notification panel displays information on both the tasks that completed successfully and those
that could not be completed.
Applicable import rules are described in this topic. Examples are given to illustrate various
scenarios (see page 621).
NOTE: You cannot proceed with the import of an entity if in the target system one of its
dependencies is locked by another operation or user. For example, if in the target system the
Hardware Mapping Editor is open, you cannot import into the topology of this system entities that
are linked to the Ethernet network because it is locked by the hardware mapping process.
However, you could import a station node that has no physical connection.

Software Version Compatibility

The version of EcoStruxure Process Expert that you use to import the information contained in the
export file must be the same as the version that you used to create the export file (a service pack
is considered the same version); otherwise you cannot proceed with the import.

Topological Templates
The export file does not contain the topological templates of the exported entities and devices. If
you are importing entities in a different EcoStruxure Process Expert infrastructure and the required
template for an entity is not present, then the entity is skipped during import.
Information on the required templates and template version is indicated in the Import window.
When the import is finished, the notification panel displays information on the entities that were not
imported if applicable.
For information on how to import templates, refer to the topic that describes managing Global
Templates (see page 978).

EIO0000001114 06/2020 613

Configuration Stage

Identification of Conflicts
The table indicates the meaning of the color coding that the software uses to indicate the status of
entities and folders in the Import window (see page 617) in the context of the target system.

Identification Tooltip text Description

method
Tooltip Ok An entity of the same type with the same name does not exist in the topology of the
target system. If you select if for import, the entity is created.
Tooltip Entity already An entity of the same type with the same name, and with an identical configuration
exists already exists in the topology of the target system. If you select if for import, the
entity is created but with a different name to comply with the naming rule of the
topology. This rule specifies that identifiers of entities must be unique within a
system.
Tooltip Conflict to be An entity of the same type with the same name already exists in the topology of the
resolved target system but the software detected a change, which can, for example, be
related to:
 Properties.
 Devices of entities: Properties, position of modules on the rack, configuration,
CPU or module type.
 Services of station nodes.
 Physical connections.

If you want to import the entity anyway, you need to select an action for it.
NOTE: Refer to the topic describing import rules for conflicting entities
(see page 615).
IP with yellow IP conflict At the time of export, the entity that you want to import was connected to an Ethernet
dot network that exists in the target system and its IP address is already used on this
network (see page 596).
In addition, the tooltip text indicates <conflicting IP address in the target system> -
<path to the entity in the target system> - <Ethernet network identifier in the target
system>.
You can still import the entity but physical connections are impacted. For details,
refer to the topic describing import rules for physical connections (see page 616).
NOTE: If the entity that has the same IP address in the target system also has the
same identifier and is of the same type, the software does not indicate an IP address
conflict.

General Import Rule for Non-Conflicting Entities and Folders

Each entity that is contained in the export file and that you have selected for import is created in
the topology of the target system if the software does not detect a conflict.
Depending on the import path setting that you select, the software may create folders as needed
to recreate the original hierarchy.
If a folder with the same identifier already exists in the target system, its properties (for example,
its description or area) are automatically updated with the configuration of the export file.

614 EIO0000001114 06/2020

 Configuration Stage

Import Rules for Conflicting Entities

The table describes the actions that you can perform for various types of entities when the software
detects a conflict, depending if you select Update or Create. To be able to perform the changes
that are indicated in the table, the export file needs to contain an entity that has the same identifier
as an entity of same type in the target system. The imported entity needs to have a configuration
that is different from the target entity. Update actions apply to the entity in the target system.

Entity type Create action Update action Comments

Station node Creates the entity  Services are updated. Removing a service from a
with a new  Properties of the entity and its station node may affect
identifier. services are updated. existing service mappings of
 Entity is moved if path in export file related executables.
differs.
Controller Creates the entity  Properties of the entity and its Moving, adding, replacing, or
with a new devices are updated. removing a module of a
identifier.  Position of modules are updated. controller may affect existing
 Modules are added, replaced, and/or service, hardware, and/or
removed. communication mappings of
 Entity is moved if path in export file the related executables.
differs. This includes:
 Replacing the CPU module
NOTE: Action not allowed if the of a controller.
controller is not of the same hardware  Changing a standalone
platform (see page 558). controller into a redundant
one or the other way
around.
STB island Creates the entity  Properties of the entity and its You can overwrite parameters
PRM PROFIBUS DP with a new devices are updated. such as:
identifier.  Position of modules are updated.  IP address.
 Modules are added and/or removed.  Subnet mask.
 Entity is moved if path in export file  Explicit parameters that are
differs. defined in the
corresponding templates.
Modbus TCP and Creates the entity  Properties are updated. Updating an I/O device may
Ethernet IP I/O with a new  Entity is moved if path in export file affect existing hardware and/or
device identifier. differs. communication mappings of
the related executables.
Ethernet network Creates the entity  Properties are updated. Existing physical connections
with a new  New physical connections are in the target system are not
identifier. recreated if the entity is also imported maintained.
and no IP conflict is detected.
 Entity is moved if path in export file
differs.

NOTE: Refer also to the topic describing import rules for physical connections (see page 616).

EIO0000001114 06/2020 615

Configuration Stage

Import Rules for Physical Connections

When you import an entity for which a physical connection (see page 596) to an Ethernet network
existed at the time of export and the target system contains no Ethernet network with the same
identifier, the software recreates the physical connection in the target system if the following
conditions are true:
 The Ethernet network is included in the export file.
 Both the entity and the Ethernet network are imported successfully with their original identifier
(if an entity is created with a new identifier, the physical connection is not recreated).
On the opposite, if an Ethernet network with the same identifier already exists in the target system,
the Ethernet network does not need to be contained in the export file and you do not need to select
it if it is contained. The physical connection to this Ethernet network is automatically maintained if
the IP address of the imported entity is still available on the Ethernet network of the target system.
NOTE: As a rule, physical connections that exist in the target system prevail.
When you import an entity that is connected to an Ethernet network, if the Ethernet network in the
target system has the same name and the IP address of the entity is already used (see page 614)
on this Ethernet network, after import, the entity is not connected to the Ethernet network anymore.
The disconnection from the Ethernet network happens whether you create an entity or update an
existing one. The IP address of the entity after import is the one contained in the export file.
NOTE: More information on physical connections of redundant controllers is available in the topic
describing connections to Ethernet networks (see page 597).

Password Management After Importing Topological Entities

After you import into a system a controller and/or a station node for which password protection
(see page 558) 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 page 725).
NOTE: The above applies even if you are importing these topological entities into the same system
from which they were exported or if you have not logged out of the engineering client since the
export was performed.

616 EIO0000001114 06/2020

 Configuration Stage

Accessing the Topology Import Window

To access the topology Import window, proceed as follows.

Step Action
1 From the Systems Explorer, right-click the system into which you want to import topological entities
and select Open Topology.
Result: The software opens the Topology Explorer.
2 Right-click the system root folder and select Import.
Result: The software opens the Import dialog box.
3 Browse to the topology export file (.sbk) that contains information on the topological entities that you
want to import and click Open.
Result: The software opens the Import window and displays the contents of the file that you have
selected.

Topology Import Window Description

The topology Import window allows you to select the entities that you want to import in the topology
of a system and to take appropriate actions in case of detected conflicts (see page 614).
The following figure shows an example of the Import window displaying the contents of the
selected topological export file.

EIO0000001114 06/2020 617

Configuration Stage

Item Description
1 The check boxes allow you to select the folders and/or entities that you want to import.
Selecting a folder selects any item it contains and the other way around.
By default, items contained in the export file are selected.
NOTE: A check box filled with a black square indicates that at least one item in a sublevel is not
selected.
2 Identifier of the folders and entities contained in the export file (Name column).
Entities for which the software has detected a conflict are identified (see page 614).
In tree view mode, the column also reflects the hierarchy of the items at the time of export. The
hierarchy may be different depending on the import path setting.
3 Type of the entity.
- Path column. which indicates the path to the folder or entity.
The column is displayed only in grid view. Refer to item (6).
4 Description that comes from the properties of the entity or folder contained in the export file.
5 OK or Resolve button.
Either button is displayed depending on the status of the instances selected for import in the context
of the target system:
 OK: The software did not detect duplicate identifier conflicts and selected instances are created
in the target system upon clicking the button.
 Resolve: The software detected at least one duplicate identifier conflict for an instance selected
for import. Upon clicking the button, a new import window opens (see page 619), which displays
only entities for which a conflict was detected. It allows you to resolve identifier conflicts.
The other entities for which no conflict was detected and that you have selected remain selected
for import.
NOTE: If Resolve is displayed and you clear the check box of instances for which a conflict has been
detected, the button changes to OK, and the other way around.
6 Button to toggle between grid view and tree view.
7 Import path setting check box:
 Relative Path: Default setting. The folder from which the import command was selected becomes
the parent folder of the imported folder structure. The hierarchy of the imported folder structure
remains unchanged.
 Absolute Path: When selected, the software maintains the hierarchy that existed at the time of
export. The software creates folders as needed to recreate the original hierarchy.
NOTE: The check box is not displayed when you select the import command from the system root
folder because in such case, relative and absolute paths are the same.

NOTE: To expand/collapse a node in the Import window, select the node and press Enter.

618 EIO0000001114 06/2020

 Configuration Stage

Resolving Detected Conflicts

The following figure shows an example of the Import window that is displayed when the software
has detected conflicts and you click Resolve in the first import window.

The table describes the second topology Import window, which opens when you click Resolve.

Item Description
1 Identifier of entities that you have selected for import and for which the software has detected an
identifier and/or IP address conflict (Name column).
The type of conflict is identified (see page 614).
NOTE: Only grid view mode is available in this window.
2 New name that will be used to create the entity when you select the Create action for the entity (New
Name column). The software automatically changes the identifier of the entity by adding the _n suffix
where n is an incremental number starting at 1. This is for not having two entities with the same
identifier in the topology after import.
For example, if the original identifier of the instance is Controller_1, the new identifier is
Controller_1_1.
3 Type of the entity.
4 Description that comes from the properties of the entity or folder contained in the export file.
5 Buttons that allow you to select an action for individual instances:
 Skip: The instance is not imported.
 Update: Default action. The instance that has the same identifier in the target system is updated
(see page 615) with the configuration contained in the export file. Depending on the type of entity,
this update can pertain to descriptions, services, IP addresses, I/O modules, and so on.
 Create: The instance is created in the target system with the new identifier indicated in the New
Name column.

EIO0000001114 06/2020 619

Configuration Stage

Item Description
6 Buttons that allow you to select an action for the conflicting instances as a whole.
The actions are the same as when you select the action for instances individually.
NOTE: Clicking on of these buttons overrides the selection you have made for individual instances.
7 Back. Click to revert to the first import window.
NOTE: If you modify the default selection in this window and click Back to revert to the first import
window, when you click Resolve again in the first import window, the changes you had made to the
selection are retained. Instances that you may have unselected in the first import window do not
appear anymore, and the other way around.

Aborting Import Tasks

After confirming the import by clicking OK in the Import dialog box, the abort icon is displayed in
the notification panel (see page 86). Click the icon to cancel the task. No entities are imported.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are importing only a few entities, the task may complete before you are able to click
the icon.

Importing Topological Entities

To import topological entities into an existing system, proceed as follows.

Step Action
1 In the Import window (see page 617), select the entities that you want to import.
2 If you selected the import command from a folder other than the system root folder, select Absolute
Path if needed (see page 617).
3 If the software has detected an identifier conflict, click Resolve, otherwise proceed to step 5.
Result: The software opens a new import window, which displays entities for which the software has
detected a conflict. The other entities for which no conflict was detected and that you have selected
remain selected for import.
NOTE: Click Cancel to close the Import window without importing entities.
4 Select the action that you want to perform for each conflicting entity.
NOTE: Click Back to revert to the first import window. Your selection is retained when you return
to this window by clicking Resolve again.
5 Click OK.
Result: The software:
 Applies the import rules based on your selection and updates the topology of the target system.
 Displays an import summary in the notification panel.

620 EIO0000001114 06/2020

 Configuration Stage

Examples
This topics gives examples of various import scenarios of an entity into a system, which contains
an Ethernet network with the same name as the network in the source system.
The table gives an example of an imported entity that creates an identifier conflict. The Update
action is selected in the second step of the import.

Element What is in the target What is Imported Result

system
Entity identifier StationNode_1 StationNode_1 StationNode_1
Services ControlExpert Supervision Supervision
Properties Description: Station1 Description: Station2 Description: Station2
Folder properties None Description: Control Room Description: Control Room

The table gives two examples of an imported entity that does not create an identifier conflict. In the
second example, the software detects an IP address conflict. In both cases, you can import
Entity_2 in one step.

Element What is in the target What is Imported Result

system
Entity identifier Entity_1 Entity_2 Entity_1 Entity_2
IP address IP_1 IP 1 IP 1 IP 1
Physical connection to Not connected Connected at time of Not connected Connected
network_1 export

Entity identifier Entity_1 Entity_2 Entity_1 Entity_2

IP address IP 1 IP 1 IP 1 IP 1
Physical connection to Connected Connected at time of Connected Not connected
network_1 export

EIO0000001114 06/2020 621

Configuration Stage

The table gives two examples of an imported entity that creates an identifier conflict but without an
IP address conflict. The action that is selected in the second step of the import is indicated.

Element What is in the target What is Imported Result

system
Update action is selected
Entity identifier Entity_1 Entity_1 Entity_1
IP address IP 1 IP 1 or any IP IP address of export file
Physical connection to Connected Not connected at time Not connected
network_1 of export

Entity identifier Entity_1 Entity_1 Entity_1

IP address IP 1 (not used on IP_1 or any IP address IP address of export file
network_1) not used on network_1
of target system
Physical connection to Not connected Connected at time of Connected
network_1 export
Create action is selected
Entity identifier Entity_1 Entity_1 Entity_1 Entity_1_1
IP address IP 1 Any IP address not IP 1 IP address of
used on network_1 of export file
target system
Physical connection to Connected Connected at time of Connected Not connected
network_1 export

The table gives two examples of an imported entity that creates an IP address conflict. In each
example, a different action is selected in the second step of the import.

Element What is in the What is Imported Result

target system
Update action is selected
Entity identifier Entity_1 Entity_1 Entity_1
IP address IP 1 IP address already used on IP address of export file
network_1 of target system
Physical connection to Connected Connected at time of export Not connected
network_1
Create action is selected
Entity identifier Entity_1 Entity_1 Entity_1 Entity_1_1
IP address IP 1 IP 1 IP 1 IP 1
Physical connection to Connected Connected at time of export Connected Not connected
network_1

622 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Mapping Stage
EIO0000001114 06/2020

Chapter 18
Mapping Stage

Mapping Stage

Overview
This chapter describes how to map the Control and Supervision projects to the topological entities
of the system, and to create communication channels, which allow you to use the I/O scanner
function of controllers.
The following figure shows the position of the Mapping stage within the system engineering life
cycle.

Refer to the Mapping stage (see page 60) for a description of the purpose of this stage.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
18.1 Control Project Mapping Stage 624
18.2 Exporting and Importing Hardware Mappings 664
18.3 Supervision Project Mapping Stage 676

EIO0000001114 06/2020 623

Mapping Stage

Section 18.1
Control Project Mapping Stage

Control Project Mapping Stage

Overview
This section describes how to use the Project Explorer to map a logical Control Participant project
to one or more topological entities of the system to map the application to hardware channels. It
also describes how to create and configure communication channels that allow using the controller
I/O scanner function for communication with devices and peer to peer communication.
You must have completed the Generation stage (see page 443) and the Configuration stage
(see page 549) of the Control Participant project to proceed with the mapping stage.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Creating Control Project Executables 625
Mapping Services 628
Mapping Communication 630
Mapping Network Variables 645
Mapping Hardware 655

624 EIO0000001114 06/2020

 Mapping Stage

Creating Control Project Executables

Overview
A Control executable allows you to associate to the logical Control Participant project a topological
entity acting as engine (see page 550) by mapping the Service. Based on that, you can further map
Hardware (I/O and communication modules) and Communication (communication channels for
various communication modules) of this engine.
You can map a logical Control Participant project to several engines of the system. To do so, create
one executable for each engine.
For example, you can map the same logical Control Participant project to both:
 The controller that is in the plant by using executable_A.
 Another controller that is in the laboratory for test purposes by using executable_B.

Executables are associated to an Execution Domain, which serves as a filter for selecting
applicable services, for example, to define the boundaries for peer to peer communication or
runtime navigation services.

Creating Control Executables

To create a Control executable, proceed as follows.

Step Action
1 In the Control Project Browser, right-click the Executables node of the Control project that you
want to map and select Create Executable.
Result: A Control executable is created under the Executables node.

Control Executable Actions

The table describes the executable context menu commands.

Command Description
Manage Opens the Manage window in the work area of the Project Explorer, which lets you
perform the following actions:
 Service mapping (see page 628): Associates the logical Control Participant project
to an engine of the system.
 View and edit the properties (see page 627) of the executable.
 Communication mapping (see page 630): Defines the Modbus TCP Ethernet (I/O
scanning) communication channels between a controller and devices and/or other
controllers for peer to peer communication.
 Hardware mapping (see page 655): Lets you map the interfaces of the instances of
the application that are assigned to the project to hardware channels of the
controller.
Build Starts an automated process to integrate certain changes in the built Control
(see page 688) Participant project by performing an incremental build.
The command is available once you have done the service mapping.

EIO0000001114 06/2020 625

Mapping Stage

Command Description
Build All Starts an automated process to create (see page 689) the built Control Participant
project the first time or to recreate it to integrate certain changes (see page 696) that
you have made to the Control Participant project or the system topology.
The command is available once you have done the service mapping.
Generate and Build Starts a generation of the Control Participant project followed by a build.
(see page 447) If you have not built the logical Control Participant project yet, the build process that is
executed is the same as when you select the Build All command.
If the generation process does not complete successfully, no build is performed and
information is displayed in the notification panel.
NOTE: After selecting the command, the abort icon is displayed in the notification
panel (see page 86). Click the icon to cancel the task.
Open Built Project Opens the built Control project in the Control Participant, which allows you to view the
(see page 695) program and configuration.
The command is available once you have built the Control Participant project.
Delete Deletes the executable including any associated:
 Service and hardware mappings.
 Communication mappings.

NOTE:
 You cannot delete an executable that you have deployed. The software displays a
message to inform you that the command cannot be executed.
 Deleting an executable does not delete data backup files (see page 335).
Rename Lets you enter a new identifier (see page 627) for the executable.

626 EIO0000001114 06/2020

 Mapping Stage

Control Executable Properties

To open the properties of the executable, double-click it.
You can view and edit the following properties.

Property Description
Identifier The identifier must be unique within a Control Participant project.
Description Optional.
You can enter a description for the executable with free form text.
Execution Optional.
Domain String.
Default value: Blank.
For the following types of communication, you can exchange data only if these executables
have the same execution domain:
 For peer to peer communication: The executable of the owner project and the executable
of the consumer project.
 For runtime navigation services (see EcoStruxure™ Process Expert, Runtime Navigation
Services , User Guide ): The executable of the Control Participant project and the
executable of the Supervision Participant project.
Values that you enter remain in the menu and you can select those of executables of other
Control and Supervision Participant projects.
You can assign a logical execution domain to the executable with free form text.
You can modify the Execution Domain value at any time during the engineering life cycle.
NOTE: Leaving Execution Domain blank is considered as a value.
Build State Indicates the status (see page 695) of the executable.
Default value: Not Built
Built On Date and time when you last built the executable successfully by using a build command.

Assigning an Execution Domain

To assign an execution domain to a Control executable, proceed as follows.

Step Action
1 Double-click the executable to open its properties.
2 Select a value from the Execution Domain menu or enter a new value.

NOTE: To remove or change the associated execution domain, select the empty row at the top of
the menu.

EIO0000001114 06/2020 627

Mapping Stage

Mapping Services

Overview
The Service Mapping Editor opens within the Manage window when you double-click the Control
executable (see page 625). It allows you to associate the logical Control Participant project to
entities acting as engines (see page 550) through its Control executable.
These engines are controllers and station nodes that exist in the topology of the system.
NOTE: If the Controller Family is not the same for the entity and the Control project (see page 307)
that you want to map, you may not be able to map certain hardware I/O interfaces.

Mapping to Other Topological Entities

The software does not display STB islands, PROFIBUS Remote Masters (PRMs), Modbus TCP,
nor Ethernet IP I/O devices in the Service Mapping Editor. For these topological entities, you need
to map to the Control executable the controller that communicates with the entity.
NOTE: For PRMs, verify that the family of the controller is the same as the family that is selected
in the properties of the PRM (see page 581).

Mapping to a Redundant Controller

The software displays the identifier of the controller entity in the Service Mapping Editor when you
map the Control executable to a redundant controller. The mapping however, is performed with
both the primary and the secondary controllers.

Mapping to a Station Node

When you map a Control executable to a station node for simulation purposes, the software
displays the station node in the Service Mapping Editor window only if you have created a
ControlExpert service (see page 567) in the station node first.

Changing the Service Mapping of Deployed Executables

If you have already deployed the Control executable to an engine of the system, you cannot
change nor remove the service mapping of this executable. You need to create a new executable.

628 EIO0000001114 06/2020

 Mapping Stage

Mapping Services
To map the Control executable to an engine, proceed as follows.

Step Action
1 Double-click the executable of the Control project that you want to map and select Manage.
Result: The Service Mapping Editor opens.
2 Click the Engine menu.
Result: The menu displays the identifiers of compatible entities of the topology of the system.
3 Select an entity.
Result: The software:
 Maps the Control executable to the selected entity.
 Displays the Hardware Mapping tab at the bottom of the window. If the controller is connected
to an Ethernet network (see page 596), the Communication Mapping tab appears also.

NOTE: To remove a mapping, in the Service Mapping Editor, right-click an entity and select
Unmap.

EIO0000001114 06/2020 629

Mapping Stage

Mapping Communication

Overview
To open the Communication Mapping Editor, click the Communication Mapping tab within the
Manage window (see page 625). The tab appears once you have performed the service mapping
(see page 628) with a controller that is connected to an Ethernet network (see page 596).
It allows you to define the communication channels that are used for communication between the
controller that you have configured as client and service mapped and:
 Modbus TCP devices.
 STB islands.
 PRMs.
 Other controllers that are mapped to other logical Control Participant projects for peer to peer
communication.
This method uses the I/O scanner service of the controller that is configured as client.
A communication channel is the logical representation, at the platform level, of the Control
Participant I/O scanner row.
During the creation of a communication channel, you can configure its properties (see page 635).
For peer to peer communication, the Communication Mapping Editor also allows you to map
network variables (see page 645) to communication channels.
The software creates the I/O scanner lines that correspond to the communication channels in the
controller acting as client during the build process (see page 689).
NOTE: For peer to peer communication, proceed with the communication mapping from the
executable of the consumer project (see page 527).
NOTE: The communication mapping feature is not supported for executables that you have
mapped to a station node that is emulating a simulator.

Prerequisites
For a description of the prerequisites for communication mapping, refer to the topics that describe
the steps to complete:
 Communication with devices (see page 857).
 Peer to peer communication (see page 865).

630 EIO0000001114 06/2020

 Mapping Stage

Communication Mapping Editor

The following figure shows an example of the Communication Mapping Editor window, which
displays two peer to peer communication and one Modbus I/O device communication channels. It
also indicates that free memory remains in the server counterpart to create additional peer to peer
communication channels and/or increase the size of existing channels.

1 Communication Channels pane, which displays the client memory area of the communication module of
the controller that you have mapped to the Control executable. There is one tab for each communication
module (including the CPU communication module) that is configured in the controller and whose I/O
scanning service is enabled. Select a tab to display the communication channels that are configured in the
memory area of the corresponding communication module of the controller acting as client.
2 <controller_identifier>(Server) tab, which displays the communication channels that are configured in the
memory area of the controller when acting as server (if applicable). The information is displayed in the
Server Memory Map pane.
3 Server Communication Counterparts - Device IO pane, which displays, topological entities such as
Modbus TCP devices, PRMs, and STB islands, acting as servers, and with which you can define a
communication channel. Click the arrow in the title bar to expand/collapse the pane
4 Server Communication Counterparts - Peer to Peer pane, which displays other Control projects, their
executable, and the mapped controller entity with which you can define a communication channel. Click
the arrow button in the title bar to expand/collapse the pane.

NOTE: When the executable of the Control project is mapped to a redundant controller, the
Communication Channels pane displays only the client memory area of the communication
module of the primary controller.

EIO0000001114 06/2020 631

Mapping Stage

The figure shows an example of the Server Memory Map pane, which is displayed when you select
the <controller_identifier>(Server) tab. It indicates that one peer to peer communication channel
exists in the memory area of the client controller when acting as server (see page 638).

The table describes the fields of the Communication Channels pane when you select the tab of the
client communication module.

Column header Description

Type System
Indicates in the Size column, the size of memory that is reserved, and in the
Description column, the corresponding usage.
Free
Refer to the description of the Size column.
Device IO
Identifies channels that exist to communicate with Modbus TCP Ethernet devices,
PRMs, and STB islands.
Peer to Peer
Identifies channels that exist to exchange data between Control Participant projects
through the controllers that are mapped to these projects.
Service  For I/O device communication channels: element category.communication
element
Where element category is the category of the I/O scanner element, and
communication element the name of the I/O scanner element for the I/O
device.
 For peer to peer communication: project.executable
Where project is the identifier of the Control Participant project (owner
(see page 527)) that exposes the variables and executable the identifier of the
executable of this project.
Server Identifier of the server counterpart using the communication channel:
 The I/O device identifier for I/O device channels.
 The controller identifier for peer to peer communication channels.

Direction Indicates the direction of the communication as Read, Write, or Both.

632 EIO0000001114 06/2020

 Mapping Stage

Column header Description

Description Displays the value of the parameters Read description and Write description that you
can view in the Channel Properties dialog box (see page 635).
NOTE: For channels of type System indicates the usage of the reserved memory.
Size For each channel, indicates the memory size that is allocated for reading from the
server and writing to the server. It corresponds to the read and/or write size that you
enter when you create a communication channel with a server counter part.
You can create communication channels until there is not enough sufficient memory
left.
NOTE:
 For channel type Free, indicates the remaining free memory size that you can use
to create communication channels. It is calculated based on the memory size that
you have configured in the memory heap of the client by using the
ClientMemoryLength parameter (see page 558) and on the memory allocation of
existing communication channels.
Additional words used by the System (for example, for disabling flags) are also
deducted from the memory size.
 For controllers of the M580 platform and NOC communication modules of any
controller, the size value for channel type Free is not indicated because it is
managed during build only (see page 689).
Free Displays the remaining free memory in words for each existing peer to peer
communication channel. The size is indicated separately for read and write channels
when they exist. It is calculated based on Size and the size of variables that you have
mapped (see page 645) to read and/or write communication channels.
For example, if the read channel size is 100 and you have mapped variables to this
channel, which use up 10 words, the displayed value is 89. If you have mapped
variables that use less than a word (a variable of BOOL data type), the free size can
be indicated in decimals. These correspond to 1/16th of a word. For example, a free
memory size indicated as 8.14 (out of 10) corresponds to 8 words and 14/16th of a
word (2/16th of a word are used by variables of BOOL data type, which use up 1/16th
of a word each).
NOTE: 1 word of each channel is reserved to move the channel address to manage
the 32-bit alignment for peer to peer communication across Modicon Quantum and
M340 platforms. This word is deducted from the remaining free memory size.
Last Displays the value of the parameter Last value that you can select and adjust through
the Channel Properties dialog box (see page 635).
Scan Displays the value of the parameter Scan rate that you can adjust through the Channel
Properties dialog box (see page 635).
Timeout Displays the value of the parameter Timeout that you can adjust through the Channel
Properties dialog box (see page 635).

EIO0000001114 06/2020 633

Mapping Stage

The table describes the fields of the Server Communication Counterparts - Device IO pane.

Field Description
Service element category.communication element, where element category is the
category of the I/O scanner element, and communication element the name of the
I/O scanner element for the I/O device.
Server Identifier of the STB island, PRM, or Modbus TCP device entity, acting as server and
with which you can create a communication channel.
Description Description of the data to be exchanged through the channel.
Read Size Number of words that are read from the server.
Write Size Number of words that are written to the server.

The table describes the fields of the Server Communication Counterparts - Peer to Peer pane.

Field Description
Service project.executable
Where project is the identifier of the Control Participant project (owner
(see page 527)) that exposes the variables and executable the identifier of the
executable of this project.
Server Identifier of the controller mapped to the owner project described in the Service field,
which acts as counterpart, and that is available to create a communication channel.
Free When no communication channel exists, indicates the number of words that you have
configured in the memory heap of the controller acting as server, which is defined in the
Server field.
When you create a communication channel, the read and write sizes that you define in
the Peer to Peer: Properties dialog box are deducted from this value.

Customizing Column Display

In the various panes of the editor, you can choose which columns you want to see by right-clicking
a column header and selecting Customize. Certain columns are always shown.
When you hide a column for which a filter is applied, the filter is cleared.

634 EIO0000001114 06/2020

 Mapping Stage

Communication Channel Actions

Right-click a communication channel in the Communication Channels pane to display a context
menu with the following commands.

Command Description
Map Opens the Variable Mapping Editor (see page 645), which allows you to map network variables
Variables and define the relative position of such variables in the selected communication channel.
The command is available only for peer to peer communication channels.
Unmap Removes the selected communication channel (see page 642).
Properties Opens the Device IO: Properties or Peer to Peer: Properties dialog box (see page 635), which
lets you view and/or adjust parameter values of the selected communication channel.

Communication Channel Properties

When you create a communication channel (see page 640), the software opens the appropriate
dialog box, which allows you to adjust the values of the parameters of the communication channel
in the memory heap of the client.
NOTE: You can view and/or adjust the values of certain parameters of existing communication
channels.
The following figure shows an example of the Device IO: Properties dialog box that the software
opens when you create a channel to communicate with an STB island. The dialog box is also
displayed when you right-click the existing communication channel and select Properties.

EIO0000001114 06/2020 635

Mapping Stage

The following figure shows an example of the Peer to Peer: Properties dialog box that the software
opens when you create a peer to peer communication channel. The dialog box is also displayed
when you right-click the existing communication channel and select Properties.

Parameter Description
Service Refer to the description of the Service column of the Server Communication Counterparts - Device
IO or Server Communication Counterparts - Peer to Peer pane.
Server Refer to the description of the Server column of the Server Communication Counterparts - Device
IO or Server Communication Counterparts - Peer to Peer pane.
Communication The parameter appears only in the Peer to Peer: Properties dialog box.
Service Identifier of the communication module device through which data is exchanged.
You can select from the communication modules that exist in the server controller and which are
connected to the same Ethernet network as the client controller communication module.
Read description Description for the read channel.
NOTE: For peer to peer communication channels, the default value is blank. You must enter a
description.

636 EIO0000001114 06/2020

 Mapping Stage

Parameter Description
Read size Number of words that are allocated to the channel and read from the server counterpart.
The corresponding memory size is reserved in both the client and server memory heap.
NOTE:
For peer to peer communication channels:
 Default value: 0
 Maximum value: 125
 You can adjust the value:
 The total value of columns Read size and Write size cannot exceed the lowest value
indicated in either column Free of the Server Communication Counterparts pane or column
Size (row Free) of the Communication Channels pane.
 You cannot set the size to a value that is lower than the total size of variables that are
mapped (see page 645) to the channel.
 You can increase the size as long as there is no overlapping channel in the server memory
heap within the new size limit.
Write description Description for the write channel.
NOTE: For peer to peer communication channels, the default value is blank. If you enter a value
in the Write size field, you must enter a description.
Write size Number of words that are allocated to the channel and written to the server counterpart.
The corresponding memory size is reserved in both the client and server memory heap.
NOTE:
For peer to peer communication channels:
 Default value: 0
 Maximum value: 100
 You can adjust the value:
 The total value of columns Read size and Write size cannot exceed the lowest value
indicated in either column Free of the Server Communication Counterparts pane or column
Size (row Free) of the Communication Channels pane.
 You cannot set the size to a value that is lower than the total size of variables that are
mapped (see page 645) to the channel.
 You can increase the size as long as there is no overlapping channel in the server memory
heap within the new size limit.
Last value Value that is retained when a communication interruption occurs.
Select between:
 Reset: Set to 0
 Hold: Last value

Default value: Hold

NOTE: This setting applies to the I/O scanner line created in the Control Participant project. When
communicating with an I/O device modeled by a device template, confirm that the DFB contained
in the device template supports the selected setting. If not, the value of variables read from the
device may not be synchronized with the value sent to the Supervision layer by the DFB.
For information on parameters of DFBs of device templates, refer to the help of the corresponding
template library, which documents the Control resources (services).

EIO0000001114 06/2020 637

Mapping Stage

Parameter Description
Scan rate The rate at which data is scanned in the channel.
Range: 0...65535 ms
Default value: 60 ms
If you change the default value, verify that the new value is a multiple of the repetitive rate step.
For more information, refer to the Control Participant help.
Timeout The maximum interval between responses from the entity for the channel. After this time expires,
the communication is considered interrupted, and the last value is retained according to the
configuration of the Last value parameter.
Range: 1...65535 ms
Interval: 1 ms
Default value: 1000 ms
NOTE: Verify that the TimeOut value is greater than the ScanRate value.
For more information, refer to the Control Participant help.

Server-Side Communication Channel Properties

Once you have created a peer to peer communication channel in the memory heap of the client,
you can view properties of the channel server-side by right-clicking the communication channel
and selecting Properties.
To view the communication channel, first open (see page 630) the Communication Mapping Editor
from the owner project.
NOTE: You can open the an identical properties dialog box for the communication channel that
exists in the client controller when acting as server by selecting the <controller_identifier>(Server)
tab from the client-side communication mapping window, right-clicking the communication channel
in the Server Memory Map pane, and selecting Properties.
NOTE: When you modify the properties of a communication channel server-side, and you have
already deployed the associated built Control Participant project, you can only apply the change to
the engine, using the Deploy Built Project (see page 763) command, which requires stopping the
controller.

638 EIO0000001114 06/2020

 Mapping Stage

The following figure shows an example of the Server Peer to Peer Channel: Properties dialog box,
which indicates properties of the peer to peer communication channel server-side.

Parameter Description
Partner project.executable
Where project is the identifier of the Control Participant project (consumer
(see page 527)) that receives the variables and executable the identifier of the
executable of this project.
Client Identifier of the controller entity (server) to which the owner project is mapped.
Description Description for the read or write channel.
Direction Read or Write.
Start position Starting address of the communication channel in the memory heap of the server.
The value is editable, allowing you to move communication channels server-side
(see page 643).
Size Number of words that are allocated to the communication channel server-side.

Communication Channel Position

Communication channels are contiguous in the memory area of the controller acting as client.

Communication Channel Order

Device I/O communication channels appear in the memory area reserved for this type of
communication channel in the order you create them.
When both peer to peer communication channels and device I/O communication channels exist
then device I/O communication channels are positioned after peer to peer communication
channels.

EIO0000001114 06/2020 639

Mapping Stage

Restrictions when Creating Communication Channels

For each communication module of a controller acting as client (a tab of the Communication
Channels pane), you cannot create communication channels with several executables that are
mapped to the same controller.
For example, if the following executables appear in the Service column of the Server
Communication Counterparts - Peer to Peer pane and both are mapped (service mapping) to
controller Controller_1 (Server column):
 Project_1.Executable_1
 Project_2.Executable_2

Then, for a given client controller communication module, you can create a communication channel
only with either one of these executables.

Creating Communication Channels

When you create a communication channel, and you have already deployed the associated built
Control Participant project, you can only apply the change to the engine, using the Deploy Built
Project (see page 763) command, which requires stopping the controller.
NOTE: Following the creation of a peer to peer communication channel, you can view it in the
memory heap of the server, in the Server Memory Map pane (<controller_Identifier>(server) tab),
by opening (see page 630) the Communication Mapping Editor from the counterpart owner project.
Creating a peer to peer communication channel in the executable of the consumer project also
affects the executable of the counterpart owner project. To apply changes, you need to start/stop
the controllers to which these executables are deployed in the right order; otherwise incorrect data
may be read and/or written.

WARNING
LOSS OF CONTROL
 Deploy the executables to the controllers between which the peer to peer communication
channel exists.
 Start/stop controllers in the right order.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

To create a communication channel between the client and the server counterpart, proceed as
follows.

Step Action
1 From one of the Server Communication Counterparts panes, drag the server counterpart with
which you want to create a communication channel to the Communication Channels pane.
Result: The corresponding communication channel Properties dialog box opens.
2 Adjust the values of the communication channel properties as required.

640 EIO0000001114 06/2020

 Mapping Stage

Step Action
3 Click OK.
Result: The software:
 Creates a communication channel between the selected server counterpart and the client
with the parameter values that you have configured in the corresponding Properties dialog
box.
 Shifts the information of the server counterpart to the respective columns in the
Communication Channels pane.
 Updates values of the Size and Free columns.

NOTE: Click Cancel to close the Properties dialog box without creating the communication
channel.

NOTE:
 If there is no sufficient space in the memory of the client or server to accommodate the
communication channel, the software displays a notification and you cannot create the channel.
Adjust the client or server memory properties of the corresponding controller entity and repeat.
 The validation of sufficient space in the memory of the client is not performed for controllers of
the M580 platform and NOC communication modules of any controller because the free
memory size is managed during build only (see page 689).

Modifying Communication Channel Properties

You can view modify the values of certain parameters of existing communication channels in the
Properties dialog box of the channel.
When you modify the properties of a communication channel, and you have already deployed the
associated built Control Participant project, you can only apply the change to the engine, using the
Deploy Built Project (see page 763) command, which requires stopping the controller.
Modifying peer to peer communication channel properties in the executable of the consumer
project also affects the executable of the counterpart owner project. To apply changes, you need
to start/stop the controllers to which these executables are deployed in the right order; otherwise
incorrect data may be read and/or written.

WARNING
LOSS OF CONTROL
 Deploy the executables to the controllers between which the peer to peer communication
channel exists.
 Start/stop controllers in the right order.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000001114 06/2020 641

Mapping Stage

To modify properties of an existing communication channel, proceed as follows.

Step Action
1 In the Communication Channels pane, right-click the communication channel and select
Properties.
Result: The software opens the Properties dialog box.
NOTE: The Properties dialog box does not open if the Variable Mapping Editor window
(see page 645) of this communication channel is open.
2 Adjust the values of the communication channel properties as required.
3 Click OK.
Result: The software:
 Adjusts the communication channel properties.
 Updates the values that are displayed in the Communication Mapping Editor.
 Displays information on the modification in the notification panel.

NOTE: Click Cancel to close the Properties dialog box without creating the communication
channel.

NOTE: If the software is not able to apply your modification, it displays a notification. The validation
of sufficient space in the memory of the client is not performed for controllers of the M580 platform
and NOC communication modules of any controller because the free memory size is managed
during build only (see page 689).

Unmapping Communication Channels

Unmapping a communication channel has the following impacts:
 The memory size allocated to the channel is released in the memory heap of the client and of
the server.
 Other channels that exist in the memory heap of the client are realigned to be contiguous.
 Network variables that are mapped (see page 645) to the deleted channel are unmapped from
the client and server communication channels.
 The build status (see page 696) of the Control executable to which the controller is mapped
changes to out of date if it is built.
 When you unmap a communication channel and you have already deployed the associated built
Control Participant project, you can only apply the change to the engine, using the Deploy Built
Project (see page 763) command, which requires stopping the controller.

642 EIO0000001114 06/2020

 Mapping Stage

The executables of both the consumer and the counterpart owner Control projects are affected. To
apply changes, you need to start/stop the controllers to which these executables are deployed in
the right order; otherwise incorrect data may be read and/or written.

WARNING
LOSS OF CONTROL
 Deploy the executables to the controllers between which the peer to peer communication
channel exists.
 Start/stop controllers in the right order.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

To unmap a communication channel, proceed as follows.

Step Action
1 In the Communication Channels pane, right-click the communication channel and select Unmap.
Result: The software opens the Unmap dialog box.
2 Click OK to confirm.
Result: The software:
 Unmaps the communication channel between the selected server counterpart and the client.
 Displays the server counterpart in the corresponding Server Communication Counterparts
pane.
 Updates values of the Size and Free columns.

NOTE: Click No to close the Unmap dialog box without unmapping the channel.

Moving Communication Channels Server-Side

When you move an existing peer to peer communication channel within the memory heap of the
server counterpart:
 You can only enter an odd starting address.
 The starting address has to leave enough free memory area to fit the size of the communication
channel; otherwise you cannot move the channel.
When you move a communication channel and you have already deployed the associated built
Control Participant project, you can only apply the change to the engine, using the Deploy Built
Project (see page 763) command, which requires stopping the controller.

EIO0000001114 06/2020 643

Mapping Stage

Moving a peer to peer communication channel in the executable of the owner project also affects
the executable of the consumer counterpart project. To apply changes, you need to start/stop the
controllers to which these executables are deployed in the right order; otherwise incorrect data may
be read and/or written.

WARNING
LOSS OF CONTROL
 Deploy the executables to the controllers between which the peer to peer communication
channel exists.
 Start/stop controllers in the right order.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

To move a peer to peer communication channel in the memory heap of the server counterpart,
proceed as follows.

Step Action
1 Open (see page 630) the Communication Mapping Editor from the owner (see page 527)
project.
2 Select the <controller_identifier>(Server) tab to display the memory heap of the server.
Result: The software displays the Server Memory Map pane.
3 Right-click the communication channel that you want to move and select Properties.
Result: The software opens the Server Peer to Peer Channel: Properties dialog box.
4 Enter a new positive, odd integer value in the Start position field.
5 Click OK.
Result: If sufficient free memory is available at the specified position, the software:
 Moves the selected communication channel to the new start position.
 Updates values of the Start Position and Size columns in the Server Memory Map pane of
the Communication Mapping Editor.
If not, the software displays a dialog box informing you that it cannot move the communication
channel.
NOTE: Click Cancel to close the Server Peer to Peer Channel: Properties dialog box without
moving the channel.

644 EIO0000001114 06/2020

 Mapping Stage

Mapping Network Variables

Overview
The Variable Mapping Editor opens when you right-click a peer to peer communication channel in
the Communication Mapping pane (see page 631) and select Map Variables.
It allows you to map variables of the consumer project to peer to peer communication channels that
exist in the memory heap of the client:
 Network variables (see page 527): To read data from the server.
 Variables, which are the counterpart to network variables that exist in the owner project: To write
data to the server.
You can assign a position manually or let the software manage positions.
The software indicates if variables are already mapped to another channel and lets you open the
Variable Mapping Editor of this channel.
NOTE: You can work simultaneously on different communication channels. The variable mappings
that are performed on a channel and that affect other channels are reflected right away on these
channels.
NOTE: The first time you open the Variable Mapping Editor and the first time you open it after
refining the project, it may take time before the window appears.

Prerequisites
To proceed with the variable mapping, first create a peer to peer communication channel
(see page 630).

EIO0000001114 06/2020 645

Mapping Stage

Variable Mapping Editor

The following figure shows an example of the Variable Mapping Editor.

(1) Information bar, which displays scan rate and timeout properties of the selected communication
channel, as well as the check box to position variables automatically (see page 649).
(2) Pane that displays the network variables that the client reads from its server counterpart, and
that are mapped to the selected communication channel. In this example, network variable
Var_3, which is created in the consumer project is mapped to the communication channel that
exists in the client controller.
(3) Pane that displays the network variables that exist in the consumer project and that you can
map to the communication channel that is created in the client controller. In this example,
network variable Var_2 has already been mapped by opening the Variable Mapping Editor from
the owner project and using its counterpart variable to write to the server (see page 527). You
cannot map it again. You can view its mapping information by right-clicking Mapped.
(4) Pane that displays the variables that the client writes to its server counterpart, and that are
mapped to the selected communication channel. In this example, no variables are mapped.
(5) Pane that displays the variables that exist in the consumer project for which a corresponding
network variable exists in the owner project and that you can map to the communication
channel. In this example, Var_1 exists as network variable in the owner project and here you
can map its counterpart variable to the channel that exists in the client controller to write to the
server (see page 527).

646 EIO0000001114 06/2020

 Mapping Stage

The table describes the fields of the Network Variables and Variables panes.

Column Description
header
Identifier Identifier of the variable.
Type Data type of the variable.
If the software detects inconsistencies in the type, the variable is shown in red color and a
tooltip provides additional information.
NOTE: When peer to peer communication with the topological entity acting as client is
implemented by using an M580 CPU or a NOC communication module, only variables of the
reference type (REF_TO) are shown (see page 534).
Size Size of the variable in words.
NOTE: For variables of a size of less than 1 word, the size is displayed in corresponding
fractions of words (for example, for data type BOOL, the size is displayed in 1/16th of words).
Description Displays the contents of the Comment property of the Control Participant of the variable in the
consumer project.
Status Indicates the mapping status of the variable.
Possible values:
 Free: The variable is not yet mapped to a communication channel.
 Mapped: The variable is already mapped to another communication channel of the Control
executable.
Click the filter icon in the column header to select the statuses that you want to see.
NOTE: You can open the Variable Mapping Editor of the communication channel to which a
variable with status Mapped is mapped by right-clicking the variable and selecting Go To
Variable Mapping Editor.
Map For variables that are mapped to another communication channel, displays the content of the
Description Read description or Write description field of this channel; otherwise the field is empty.

EIO0000001114 06/2020 647

Mapping Stage

The table describes the fields of the Read from Server and Write to Server panes.

Column header Description

Pane title bar For the Read from Server pane, displays:
 The contents of the field Read description.
 The read size (in words) of the selected channel in the client memory heap and the
remaining words available to map variables.
For the Write to Server pane, displays:
 The contents of the field Write description.
 The write size (in words) of the selected channel in the client memory heap and the
remaining words available to map variables.
NOTE: One word of each channel is reserved to move the channel address to manage the
32-bit alignment (see page 693) for peer to peer communication across Modicon Quantum,
M580, and M340 platforms.
Position Position of the word to which you have mapped the variable within the memory size that
you have allocated to the channel or the next available empty position within a word or of
the next word.
The position in the communication channel is the same in the client and in the server.
For variables of a size of less than 1 word, positions are displayed using the x.y format
where:
 x represents the word
 y represents the position inside the word

Identifier Identifier of the mapped variable or Empty.

Empty: Appears for the next available position to which you can map variables.
Type Type of the mapped variable, of the remaining space in a word, or Any.
To map variables to the remaining space of a word, the data type of the variables needs to
match.
Any: Appears when Identifier is Empty. You can map a variable of any data type to this
space.
Size Indicates either, the size of the mapped variable in words, the size of the remaining space
inside a word, or the size of the empty space available for mapping.
NOTE: For mapped variables of a size of less than 1 word, the size is displayed in
corresponding fractions of words (for example, for data type BOOL, the size is displayed in
1/16th of words). The empty space of a word is indicated similarly.
Description Displays the contents of the Comment property of the Control Participant of the variable in
the consumer project.

Customizing Column Display

In the various panes of the editor, you can choose which columns you want to see by right-clicking
a column header and selecting Customize. Certain columns are always shown.
When you hide a column for which a filter is applied, the filter is cleared.

648 EIO0000001114 06/2020

 Mapping Stage

Position of Mapped Variables

The Position variables automatically check box lets the software define automatically the position
of the variables that you are mapping or moving:
 Selected (default setting): The software automatically maps or moves the variable to the
compatible empty position that you have selected.
If you have selected several variables:
 If the space in the empty position that you have chosen allows it, variables are mapped or
moved contiguously starting from this position.
 If there is not sufficient contiguous space in the empty position that you have chosen to map
or move all variables but is sufficient for at least one variable, the software opens the
Mapping Confirmation dialog box to inform you. You have the following options:
Yes: Maps or moves the variables for which sufficient space is available at the chosen empty
position and maps or moves the other ones to the next available position.
No: Maps or moves only the variables for which sufficient space is available at the chosen
empty position but does not map or move the other ones. It then opens a dialog box to inform
you of which variables it could not map or move. These variables remain in the Network
Variables or Variables section.
Cancel: Cancels the mapping or move operation.
 Cleared: The software opens the Select Memory Position dialog box, which allows you to select
any available compatible position to map or move the variable within the read or write size that
you have defined for the channel.
If you have selected several variables, the position that you select in the Select Memory Position
dialog box applies to the first variable only. The software then maps or moves the other variables
in the contiguous space that is available right after the position hat you have selected. If not
sufficient contiguous space is available, it informs you of which variables it was not able to map
or move because of insufficient space.
In both cases, the software verifies that the position satisfies the variable mapping rules based on
its size. The Mapping Confirmation dialog box opens only if there is empty space in a channel
before and after an already mapped variable.
NOTE: You can map 32-bit variables (for example, variables of type REAL or DWORD) only to odd
addresses in the Variable Mapping Editor. The variables are aligned correctly during the build
(see page 693) depending on the controller platform.

EIO0000001114 06/2020 649

Mapping Stage

Example of Variable Mapping Editor Usage

In this example, network variable Var_1 is already mapped to a peer to peer communication
channel and there is one word of free space available before (position 1) and five words available
after (position 3). The Position variables automatically check box is selected. Var_2 and Var_3
are selected and dragged to be mapped at position 1. Because there is no sufficient space to map
both variables but only one of them at position 1, the software displays the Mapping Confirmation
dialog box when you release the mouse button.

If you click Yes, the software maps Var_2 at position 1, which you had selected and Var_3 at
position 3, which is the next available space where the variable fits.

650 EIO0000001114 06/2020

 Mapping Stage

If you click No, the software maps only Var_2 at position 1, which is the only variable out of the
two selected ones that fits in this position. It then informs you that Var_3 is not mapped by opening
a dialog box. Var_3 remains in the Network Variables section and is available for mapping.

Variable Mapping Rules

The software applies the following rules when mapping a variable:
 A variable cannot be mapped to a position overlapping with another mapped variable.
 A variable cannot be mapped if:
 It is split up between two or more positions.
 It does not fit entirely inside the communication channel.

Mapping Network Variables

Mapping variables to a peer to peer communication channel affects the executables of both the
consumer and the counterpart owner projects. To apply changes, you need to start/stop the
controllers to which these executables are deployed in the right order; otherwise incorrect data may
be read and/or written.

WARNING
LOSS OF CONTROL
 Deploy the executables to the controllers between which the peer to peer communication
channel exists.
 Start/stop controllers in the right order.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000001114 06/2020 651

Mapping Stage

To map network variables (to read from the server) to a communication channel, proceed as
follows.

Step Action Result

1 In the Communication Mapping Editor, right-click Result: The Variable Mapping Editor opens.
the communication channel to which you want to
map variables and select Map Variables.
2 Clear the Position variables automatically check Refer to Position of Mapped Variables for details
box if you want to select the position to map the (see page 649).
variable yourself.
3 In the Network Variables pane, select the Result: If you have unselected the Map on Top
variables that you want to map and drag them check box, the software opens the Select
onto a compatible empty position in the Read Memory Position dialog box. Proceed to step 4;
from Server pane. otherwise the software:
 Maps the variables (see page 649) to the
available space starting from the position that
you have selected and satisfying the mapping
rules.
 Displays them in the Read from Server pane.
 Removes the variable from the Network
Variables pane.
 Informs you if it was not able to map any
variable.
4 In the Select Memory Position dialog box, click -
the arrow button of the Memory Position field and
select a position to map the variable.
5 Click OK. Result: The software:
(see page 649) to the
 Maps the variables
NOTE: Click Cancel to close the Select a
selected position.
Memory Position dialog box without mapping the
 Displays them in the Read from Server pane.
variable.
 Removes the variable from the Network
Variables pane.
 Informs you if it was not able to map any
variable.

NOTE: Proceed in the same way to map a variable (to write to the server) to the selected
communication channel by using the Variables and Write to Server panes of the Variable Mapping
Editor.

652 EIO0000001114 06/2020

 Mapping Stage

Changing a Variable Mapping Position

To change the mapping position of a variable, drag it to the new position.
You can select several variables to move them at once.
Moving variables mapped to a peer to peer communication channel affects the executables of both
the consumer and the counterpart owner projects. To apply changes, you need to start/stop the
controllers to which these executables are deployed in the right order; otherwise incorrect data may
be read and/or written.

WARNING
LOSS OF CONTROL
 Deploy the executables to the controllers between which the peer to peer communication
channel exists.
 Start/stop controllers in the right order.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

To change the mapping position of network variables or variables with the Select a Memory
Position dialog box selected, proceed as follows.

Step Action Result

1 Select the variables in the Read Result: The software:
from Server or Write to Server  Unmaps the variables from their current positions, which
pane and drag them to the new become available for mapping.
compatible empty position.  Maps the variables (see page 649) to the available space
starting from the new position that you have selected and
satisfying the mapping rules.
 Informs you if it was not able to map any variable.

To change the mapping position of network variables or variables with the Select a Memory
Position dialog box cleared, proceed as follows.

Step Action Result

1 Select the variables in the Read from Server or Result: The software:
Write to Server pane and drag them to the new  Opens the Select Memory Position dialog box.
compatible empty position.
2 In the Select Memory Position dialog box, click -
the arrow button of the Memory Position field
and select a position to map the variable.
3 Click OK. Result: The software:
 Maps the variables (see page 649) to the
NOTE: Click Cancel to close the Select a
selected position.
Memory Position dialog box without mapping
 Informs you if it was not able to map any
the variable.
variable.

EIO0000001114 06/2020 653

Mapping Stage

Removing a Variable from a Communication Channel

To remove a mapped variable from the communication channel, unmap it.
Unmapping variables mapped from a peer to peer communication channel affects the executables
of both the consumer and the counterpart owner projects. To apply changes, you need to start/stop
the controllers to which these executables are deployed in the right order; otherwise incorrect data
may be read and/or written.

WARNING
LOSS OF CONTROL
 Deploy the executables to the controllers between which the peer to peer communication
channel exists.
 Start/stop controllers in the right order.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

To unmap a network variable or variable, proceed as follows.

Step Action
1 right-click the variable in the Read from Server or Write to Server pane and select Unmap.
Result: The software:
 Unmaps the variable from the selected position, which becomes available for mapping.
 Removes the variable from the corresponding Read from Server or Write to Server pane.
 Displays the variable in the corresponding Network Variables or Variables pane.

NOTE: You can also right-click the variable and press Del.

Deleting or Changing Mapped Variables

A network variable or variable is unmapped from the communication channel if you delete either:
 The network variable itself.
 The corresponding variable in the owner project.

It is also unmapped from the communication channel if you change any of the following parameters
of it, in either the owner or the consumer project:
 Name
 Type (ID or version)
 Size

Corresponding information is displayed in the notification panel.

654 EIO0000001114 06/2020

 Mapping Stage

Mapping Hardware

Overview
To open the Hardware Mapping Editor, click the Hardware Mapping tab within the Manage window
(see page 625). The tab appears once you have performed the service mapping (see page 628)
with a controller.
It allows you to map the interfaces of instances of the application to compatible hardware interfaces
representing the I/O and communication modules of the entity that you have service mapped to the
Control executable of the project.
Application objects that expose mapping interfaces are instances of:
 HAL templates (for example, $DISignal_UL).
 Communication port templates (for example, $EMPortM).
 Hardware application templates (for example, $TesysTE or $TSignCptBmx).

The mapping interfaces of application objects appear in the Hardware Mapping Editor once you
assign their facets to the Control project; even without generating them. They are updated in the
mapping editor when you make changes in the application (for example, rename an instance or
disable a service) and/or generate the Control project (for example, after setting a facet to Out Of
Date or Deleted).
You can map interfaces to modules that are connected:
 Physically (for example, in-rack I/O modules).
Their topological mapping interfaces are updated in the mapping editor when you save changes
(see page 561) in the Control Participant Configuration window.
 Logically (for example, Modbus TCP Device I/Os, PRMs, or STB islands).
Their topological mapping interfaces appear in the mapping editor when you connect
(see page 596) the device to the same Ethernet network as the controller.
If you have created several executables, proceed with the hardware mapping for each one of them.
To facilitate the management of many mappings, you can export and import hardware mappings
(see page 664).
NOTE: The software marks variables and DFB instances (see page 699) that are used for the
hardware mapping when you build the logical Control Participant project.

Mapping Modbus TCP Devices, PRMs, and STB Islands

For the following entities communicating with the controller through Modbus TCP implicit
messaging (I/O scanning), and that are connected to the same Ethernet network as the controller,
you can proceed with the hardware mapping:
 Modbus TCP I/O devices: Even without existing communication channels.
 STB islands and PRMs: Only after you create a communication channel (see page 630).

NOTE: You need to instantiate the necessary application templates first. For details, refer to the
topic describing how to implement communication (see page 855).

EIO0000001114 06/2020 655

Mapping Stage

Mapping Hardware with a Simulator

Hardware mapping is not supported, and not required, for executables that you have mapped to a
station node running software emulating a simulator.

Mapping Generic Device Interfaces

When a topological entity uses the $EGenericDeviceHW, $EIPGenericDeviceHW, or
$EGenericPBSlave template to model a device, a generic hardware mapping interface is
available for this device in the Hardware Mapping Editor. You can use it to map the interface of a
project facet to this I/O device. However, because of the generic nature of the interface, the
software does not verify if both interfaces are compatible (see page 661) before proceeding with
the mapping.

Opening the Hardware Mapping Editor in Read-Only Mode

The editor can open in read-only mode, for example, if the executable is locked by another process
such as the configuration of the controller. In this case, hardware mapping creation, modification,
and import are not allowed.

Hardware Mapping Editor

The following figure shows an example of the Hardware Mapping Editor window.

1 Topological devices pane (left, gray title bar), which displays the interfaces of the controller entity that you
have mapped to the executable of the Control project. It also displays interfaces of Modbus TCP/Ethernet
IP device, PRM, and STB island entities that are connected to the same Ethernet network as the controller.
A communication mapping for PRM and STB island entities needs to exist.
2 Project facet pane (right, blue title bar), which displays the mapping interfaces of the facets that you have
assigned to the Control project, including interfaces of facets of Modbus TCP/Ethernet IP explicit
messaging device instances, Modbus serial device instances, and the corresponding communication port
instances.
3 Check box to display only compatible interfaces (see page 658) that meet the selected filter criteria in both
panes. The functionality helps locate compatible interfaces when you have many different ones in either
pane. The functionality is enabled by default.

656 EIO0000001114 06/2020

 Mapping Stage

4 Lets you export (see page 664) to file (.csv) the existing hardware mappings and the interfaces of project
facets that have not been mapped yet.
5 Lets you import (see page 664) valid and compatible hardware mappings that you have created outside
the Hardware Mapping Editor and that are contained in a file (.csv).

NOTE: When the executable of the Control project is mapped to a redundant controller, the
topological devices pane displays only the hardware interfaces of the primary controller.

Editor section Column header Description

Topological HWInstance Identifier of the topological device.
devices pane Displays:
 Controller devices.
 Modbus TCP and Ethernet IP devices that are physically
connected to the same network as the controller.
 PRM entities and STB island devices after you have completed the
communication mapping.
NOTE: The designation of devices is described in the topic showing
the representation of topological entities (see page 563).
HWTemplate Identifier of the template that is used by the topological device.
HWMapping Identifier of the facet that models the hardware channel followed by
Interface the identifier of the facet template.
HWInterfaceType Type of the mapping interface and role.
AppInstance These columns are blank before you start the mapping process.
The software moves the information contained in the corresponding
AppFacet
columns of the project facet pane to these columns when you map the
AppTemplate project facet interface.
AppMapping
Interface
AppInterfaceType
Project facet AppInstance Identifier of the instance that references the facet.
pane
AppFacet Identifier of the facet that is assigned to the Control project.
AppTemplate Identifier of the template that is used by the instance.
AppMapping Identifier of the hardware mapping interface that is exposed by the
Interface facet.
AppInterfaceType Type of the mapping interface and role.
The prefix of the type indicates the type of I/O hardware channel:
 DI: Digital input
 DO: Digital output
 AI: Analog input
 AO: Analog output

EIO0000001114 06/2020 657

Mapping Stage

Customizing Column Display

In the various panes of the editor, you can choose which columns you want to see by right-clicking
a column header and selecting Customize. Certain columns are always shown.
When you hide a column for which a filter is applied, the filter is cleared.

Displaying Compatible Interfaces

To show only interfaces that are compatible in both panes, proceed as follows.

Step Action
1 Verify that the Display only compatible interfaces on filtering check box (see page 656) is
selected.
2 In either pane, click the filter icon of the column that you want to use to filter interfaces.
Result: The filter menu (see page 138) opens.
3 Enter criteria to be used as filter and click Filter.
Result:
 In the pane in which you have applied the filter, only interfaces that meet the filter criteria are
shown.
 In the other pane, a filter is automatically applied to the *InterfaceType column to show only
interfaces that are compatible with those that result of the filter that you have applied.
4 You can apply additional filters in either pane to further refine results.

NOTE:
 When you clear the filter in either pane, a filter is applied to the *InterfaceType column in the
other pane to show only interfaces that are compatible with those displayed in the pane where
you have cleared the filter.
 To clear filters in both panes, clear the Display only compatible interfaces on filtering check box.

658 EIO0000001114 06/2020

 Mapping Stage

The following example illustrates the use of the automatic filter mechanism to display only
compatible interfaces. The figures shows only a partial view of the Hardware Mapping Editor to
simplify the example.

1 A controller is configured with an analog input, an analog output, and a digital input module. The
corresponding interfaces appear in the HWInterfaceType column of the topological devices
pane.
2 Facets of analog input, digital input and digital output templates are assigned to the project and
the template identifiers appear in the AppTemplate column of the project facet pane.
In this step, the objective is to show only topological interfaces that are compatible with digital input
interfaces to perform the hardware mapping between the two.

EIO0000001114 06/2020 659

Mapping Stage

1 Verify that the check box (see page 656) is selected.

2 The AppTemplate column, a filter was applied to show only interfaces of digital input templates.
One interface meets this criteria.
3 In the topological devices pane, the software has automatically applied a filter to the
HWInterfaceType column to show only interfaces of digital input modules. Interfaces of other
modules are not shown anymore. You can map the interface of the project facet to any of these
topological input channels.
In this step, the objective is to show only project facet interfaces that are compatible with the
topological interfaces of the modules present in the controller configuration. This can be helpful to
verify if any hardware-compatible project facet interfaces have not yet been mapped.

1 In the topological devices pane, the filter that the software had automatically applied to the
HWInterfaceType column was cleared by the user. The column now shows all the interfaces of
the various modules of the controller to which you can map project facet interfaces.
2 In the project facet pane, the software has cleared the filter of the AppTemplate column.
Instead, it has applied a filter to the AppInterfaceType column to show only interfaces that are
compatible with the topological interfaces that are exposed by the configuration. As a result, the
interface of the digital output template is not shown anymore because the configuration does
not contain a digital output module.
3 The check box must be selected.

660 EIO0000001114 06/2020

 Mapping Stage

Mapping Hardware
To map facets of the Control project to topological interfaces of an entity, proceed as follows.

Step Action
1 In the right-hand project facet pane, locate and select the facets of the Control project that you want
to map. Use filters if necessary.
Result: The selected facets are highlighted.
2 In the left hand, topological device pane, locate the topological interfaces to which you want to map
the facets that you have selected in step 1. Use filters if necessary.
Result: The selected instance is highlighted.
NOTE: For the mapping to succeed, the type of the interface that is displayed in both
*InterfaceType columns needs to be identical and the interface roles need to be compatible.
For example, interface type $DIChannel with roles HO (Hardware Object) and SO (Signal Object).
3 From the project facet pane, drag the selected project facets onto the topological interfaces.
Result: The software shifts the information of the project facets to the respective columns of the
topological device pane.
NOTE: If the interfaces do not match, a tooltip opens and they are not mapped.

NOTE: To map an already mapped project facet interface to a different topological device with
matching interface, drag the mapped project facet onto another compatible topological device
interface.

Deleting Hardware Mappings

To delete the mapping of one or more already mapped project facet interfaces, proceed as follows.

Step Action
1 In the topological device pane, select the rows that correspond to the mappings.
2 Proceed either way:
 Drag the selection back to the project facet pane.
 Press Del and confirm the command.
 Right-click the selection, click Unmap, and confirm the command.

Result: The selected facet appear again in the project facet pane.
NOTE: To delete all the mappings at once, click inside the topological device pane, press
Ctrl+A, and use Del or Unmap.

EIO0000001114 06/2020 661

Mapping Stage

Mapping Several Project Facet Interfaces Simultaneously

You can drag more than one project facet interface onto the topological device pane at once by
using multiple selection. The software maps the project facet interfaces to contiguous topological
interfaces in the order they are displayed in the tooltip while dragging them.
The interfaces of each project facet/topological device pair need to match to complete the mapping
process.
If there is a missing or incompatible topological interface in between, the first matching interfaces
are mapped but not the remaining ones, which appear again in the right-hand project facet pane.
A message informs you of the project facet interfaces that could not be mapped.
NOTE: Use the filters to display topological devices in the desired sequence.

Changing the Application and Projects After Mapping

If you make any of the following changes to a facet that you have already mapped by using the
Hardware Mapping Editor, the software deletes the mapping and makes the facet available again
for mapping:
 Unassigning (see page 436) the facet and generating the project or section.
 Deleting the instance referencing the facet.
 Unselecting the element (see page 201) that corresponds to the facet.

Changing the Topology After Mapping

If you make any of the following changes to topological devices whose interfaces you have already
mapped by using the Hardware Mapping Editor, the software may delete the mapping. In such
case, it makes the corresponding project facets available again for mapping:
 Deleting the controller entity.
 Changing the CPU module of the controller entity.
 Deleting the I/O device.
 Moving the I/O device.
 Deleting the communication channel with an STB island or a PROFIBUS PRM Master.
 Updating templates of topological entities.

662 EIO0000001114 06/2020

 Mapping Stage

Changing Hardware Mapping After Deploying

Consider a Control project that contains one or more facets representing signals that need to be
mapped to I/O modules.
You build and deploy the Control project but without doing these hardware mappings.
If you then do the hardware mapping, build the Control project, and select the Deploy changes /
Undo Online Changes command to deploy the hardware mapping change (see page 757), the new
initial value of the variables that correspond to the mapped signals are deployed.
However, the current value of these variables remains unchanged in the deployed Control project.
The change becomes effective, either through a cold start of the controller or by replacing the
current value of the variables in the animation table by their new initial value.
For example, you deploy a Control project without mapping the facet interface representing the
signal quality of an AnalogInput instance to the facet interface representing the analog input
module channel of the controller.
If you refine the deployed Control project online, the initial value of the variable assigned to the
ComStatus pin of the corresponding DFB is displayed as False because the hardware mapping
is not done. Its current value is 0.
If you proceed with the hardware mapping, build the Control project, and execute the Deploy
changes / Undo Online Changes command, the initial value of this variable is changed to True.
However, its current value remains 0.
NOTE: The same applies when you change an existing hardware mapping after deploying it and
deploy it, using the Deploy changes / Undo Online Changes command.

EIO0000001114 06/2020 663

Mapping Stage

Section 18.2
Exporting and Importing Hardware Mappings

Exporting and Importing Hardware Mappings

Overview
The functionality lets you manage, in a three-step process, a large number of hardware mappings
(see page 655) by:
 Exporting the data that is shown in the Hardware Mapping Editor to comma-separated data
format (CSV).
 Editing the file so that it contains the hardware mappings that you want to create or modify.
 Importing the file into the Hardware Mapping Editor of the same or a different Control
executable.
Before proceeding with the import, the software validates the data and informs you of invalid
entries, which will not be imported.

What Is in This Section?

This section contains the following topics:
Topic Page
Exporting Hardware Mapping Data 665
Editing the Hardware Mapping Export File 668
Importing Hardware Mappings 674

664 EIO0000001114 06/2020

 Mapping Stage

Exporting Hardware Mapping Data

Overview
In a first step, the export functionality lets you create export files that contain the data of the
Hardware Mapping Editor for a given Control executable.

Good Practices
 Before modifying hardware mappings, back up all the existing hardware mappings by exporting
them. If needed, it lets you restore the original configuration by importing the file.
 Apply a filter before exporting so that the export file contains only the topological interfaces
whose hardware mapping you want to create or modify.

Export File Compatibility

Hardware mapping export files are forward compatible unless mentioned otherwise.

Export File Description

When you export hardware mapping data, two export files are created. Each one contains data in
a comma-separated (see page 264) format (CSV).
By default, export files are saved at the path %ProgramData%\Schneider Electric\Process
Expert x\Db, where x represents the software version. When this location does not exist (for
example, if only clients are installed on the computer), files are saved at either location:
 At the path where you have last exported or imported any file of EcoStruxure Process Expert.
 If the above does not apply or is not reachable, in the Windows® Documents folder.

Default file name Description

<Executable identifier>_HWMapping where The file contains the same data as shown in the topological
_HWMapping is appended to the file name that you devices pane (see page 656) of the Hardware Mapping
enter once the file is created. Editor at the time of export.
It is a snapshot of:
 The mapping interfaces of the topological entity that is
mapped to the Control executable (columns A to D(1)).
 The mapping interfaces of application objects that are
already mapped (columns E to I(1)).
If you have applied a filter (see page 658) before exporting,
only the filtered data is exported.
The first row contains the column headers of the editor.
You need to edit the content (see page 668) of this file to
create, modify, or delete hardware mappings.
(1) When you open the file by using Microsoft® Excel®

EIO0000001114 06/2020 665

Mapping Stage

Default file name Description

<Executable identifier>_Pending where _Pending is This supporting file contains the same data as shown in the
appended to the file name that you enter once the file project facet pane (see page 656) of the Hardware Mapping
is created. Editor at the time of export.
It is a snapshot of the mapping interfaces of application
objects that are available for mapping.
If you have applied a filter (see page 658) before exporting,
only the filtered data is exported.
The first row contains the column headers of the pane in the
editor.
You can use this file to perform cut-and-paste operations to
move to the <Executable identifier>_HWMapping.csv file the
data that corresponds to hardware mappings that you want to
create.
(1) When you open the file by using Microsoft® Excel®

Example of Export Files

The following figure shows an example of the Hardware Mapping Editor where:
 In the topological devices pane, four interfaces of digital input project facets are mapped to the
corresponding hardware channel interfaces.
 In the project facet pane, four interfaces of analog output project facets are shown as available
for hardware mapping.

666 EIO0000001114 06/2020

 Mapping Stage

The following figure shows the content of the exported hardware mapping data file
(*_HWMapping.csv) that corresponds to the previous example.

And the following figure shows the content of the supporting file (*_Pending.csv).

Exporting Hardware Mapping Data

To export the data shown in the Hardware Mapping Editor, proceed as follows.

Step Action
1 In the Hardware Mapping Editor, select the data that you want to export by using the filters
(see page 138).
2 Click the export button (see page 656).
Result: The Save As dialog box opens.
3 Enter a file name, select a location, and click Save.
Result: The two export files are created.
NOTE: The export files do not contain the Control project and the system identifiers. If required,
include this information in the file name.

EIO0000001114 06/2020 667

Mapping Stage

Editing the Hardware Mapping Export File

Overview
In this second step, the objective is to edit the exported hardware mapping data file
(*_HWMapping.csv) so that it contains the hardware mappings that you want to create or modify
for a Control executable.
You can use the supporting file (*_Pending.csv) which contains the project facet interfaces that
are available for mapping.
Schneider Electric recommends using a spreadsheet editor to facilitate the editing of data
contained in the export files.
NOTE: Although you can delete hardware mappings by using the import functionality, you can
delete them directly in the Hardware Mapping Editor by using the Unmap command
(see page 661).

Good Practices
 Before modifying hardware mappings, back up all the existing hardware mappings by exporting
them. If needed, it lets you restore the original configuration by importing the file.
 Edit only an up-to-date export file to avoid data conflicts.
 Verify that the list separator format (see page 264) is set to comma on the computer if you are
using a spreadsheet editor.
 When you use data from the supporting file to create hardware mappings, cut the data rather
than copying it to help avoid mapping the same project facet interface several times.
The other way around, add to the supporting file project facet interfaces that you are unmapping.

Compatibility With Hardware Mapping Files of Earlier Versions

You can use hardware mapping data files (topologyexport.csv and supporting file
projectexport.csv) that have been exported by using the system server console of earlier versions
of the software if you edit the column headers to match the current format.
The table describes which column headers of the topologyexport.csv file need to be updated and
their new value (not case-sensitive).

Column(1) Header Change to

A Instance HWInstance
B Template HWTemplate
C HW Mapping IF HWMappingInterface
D HW Mapping Type HWInterfaceType
E Instance AppInstance
F Project Facet AppFacet
(1) When you open the file by using Microsoft® Excel®

668 EIO0000001114 06/2020

 Mapping Stage

Column(1) Header Change to

G Facet Type AppTemplate
H HW Interface AppMappingInterface
I HW Mapping Type AppInterfaceType
(1) When you open the file by using Microsoft® Excel®

Editing the Hardware Mapping Data File

Edit only rows that correspond to topological interfaces whose hardware mapping you want to
create, modify, or delete. Refer also to the examples (see page 671).
Entries that exist in the Hardware Mapping Editor but not in the hardware mapping data file (for
example, because a filter was applied before exporting or because they have been deleted from
the file) are not modified.
The tables describe the result of various editing actions in the hardware mapping data file
(see page 665) (*_HWMapping.csv) once you import the file.
Editing to create, modify, and delete hardware mappings:

Edited data Action Result after import

Rows of New, compatible(2)project facet interface data is The corresponding hardware mapping is
columns added by cutting and pasting it from the created.
E to I(1) *_Pending.csv file. The hardware mapping is valid if the values
of the two *InterfaceType columns match
(same interface type and compatible roles).
Existing project facet interface data is modified The corresponding hardware mapping is
appropriately. For example: modified.
 By mapping another project facet interface to the
topological interface (the data is cut and pasted
from the *_Pending.csv file).
 By swapping two mapped project facet interfaces.

Existing project facet interface data is deleted. The corresponding hardware mapping is
deleted.
(1) When you open the file by using Microsoft® Excel®

EIO0000001114 06/2020 669

Mapping Stage

Other editing:

Edited data Action Result after import

Rows of Existing topology interface data is deleted. If columns E to I(1) for the same row:
columns  Are empty, no impact.
A to D(1) This lets you remove from the file rows
that you do not need to work with.
 Contain data, an invalid entry is
reported.
The first row The first row is deleted. You cannot import the file.
(1)
A header of columns A to E is deleted or modified.
Other rows A row is not edited. No impact given the same row is still
present in the Hardware Mapping Editor.
An entire row is deleted. No impact.
NOTE: This lets you remove from the file
rows that you do not need to work with.
A row containing a string is added. No impact.
Enter the string in column A(1) and start with a semi- NOTE: This lets you add comments to the
colon (for example, ;My comment). file.
An empty row is added. No impact.
The order of complete rows is changed.
The topology or project facet interface data (or both) of You cannot import the original hardware
a row is duplicated. mapping nor its copy.
Any columns A column is added in first position (A(1)) or between You cannot import the file.
columns A to E(1).
One or more columns are added after the last No impact.
column (E(1)). NOTE: This lets you add comments at the
end of a row.
The order of columns A to E (1)
is modified. No impact.
(1) When you open the file by using Microsoft® Excel®

670 EIO0000001114 06/2020

 Mapping Stage

Example of Editing to Create Hardware Mappings

The following example shows how to create hardware mappings with two channels of an analog
output module by pasting the corresponding project facet interface data of the supporting file
(shown outlined) to the hardware mapping data file.

The following figure shows the result in the topological devices pane of the Hardware Mapping
Editor. Also, the corresponding analog output project facet interfaces have been removed from the
project facet pane of the editor (not shown).

Example of Editing to Delete Hardware Mappings

Continuing with the previous example, the figure shows how to delete hardware mappings with two
channels of a digital input module by deleting the corresponding project facet interface data (shown
outlined) from the hardware mapping data file.

NOTE: It is recommended to cut the project facet interface data and paste it in the supporting file
to keep track of project facet interfaces that are available for mapping.

EIO0000001114 06/2020 671

Mapping Stage

The following figure shows the result in the topological devices pane of the Hardware Mapping
Editor. Also, the corresponding project facet interfaces have been added to the project facet pane
of the editor (not shown).

Example of Editing to Modify Hardware Mappings

Continuing with the previous example, the figure shows how to move an existing hardware
mapping with the channel of an analog output module (Ch_02) to another channel (Ch_01). This
is achieved by moving the corresponding project facet interface data of AnalogOutput_2 to the
other topological interface, thus overwriting the original interface data of AnalogOutput_1.

NOTE: Before overwriting the project facet interface data of AnalogOutput_1, it is recommended
to cut the data and paste it in the supporting file to keep track of project facet interfaces that are
available for mapping.

672 EIO0000001114 06/2020

 Mapping Stage

The following figure shows the result in the topological devices pane of the Hardware Mapping
Editor. The interface of AnalogOutput_2 is now mapped to Ch_01. The project facet interface of
AnalogOutput_1 has been unmapped and added to the project facet pane of the editor (not
shown).

Example of Editing to Add Comments to the Export File

The following figure illustrates the various ways to add comments (shown in bold) to the hardware
mapping data file (*_HWMapping.csv) so that they are not detected as invalid entries. Comments
are not imported.

NOTE: The CSV format does not allow saving special formatting.

EIO0000001114 06/2020 673

Mapping Stage

Importing Hardware Mappings

Overview
In this third step, the data contained in the hardware mapping data file (*_HWMapping.csv) is
imported into the topological devices pane Hardware Mapping Editor that is open for the Control
executable.
Each row in the hardware mapping data file is compared to the same row in the Hardware Mapping
Editor and if different, triggers an action that corresponds to the editing (see page 669) that you
have performed. Rows in the editor that are not present in the hardware mapping data file remain
unchanged.
You can import a file into the same or a different system, Control, or executable as long as the
prerequisites are fulfilled.

Prerequisites
To be able to import hardware mapping data, the following conditions must be fulfilled:
 You must have performed the service mapping (see page 628) for the Control executable.
 Hardware mapping data files that were created by using earlier versions of the software must
be compatible (see page 668).
 Both the mapping interfaces of the topological entity and of the application objects
(see page 665) that are in the hardware mapping data file must exist when you open the
Hardware Mapping Editor for the Control executable. Additional interfaces of both types can
appear in the editor and they have no effect on the import.

Invalid Hardware Mapping Log File

When you attempt to import a hardware mapping data file and the software detects invalid
mappings, it creates a log file with these mappings.
 The file is located in the folder from where you have imported the hardware mapping data file.
 It has the same name as the imported file but with the _log suffix and .txt file extension.

Thereafter, each time you try to import the same hardware mapping data file (same file name),
invalid mappings that the software detects are added to the log file.

674 EIO0000001114 06/2020

 Mapping Stage

Importing Hardware Mapping Data

To import hardware mapping data in the Hardware Mapping Editor, proceed as follows.

Step Action
1 In the Hardware Mapping Editor, click the import button (see page 656).
Result: The Open dialog box opens.
2 Select the file (*_HWMapping.csv) that contains the hardware mapping data and click Open.
Result: The Import Mappings dialog box opens.
3 Click Yes.
Result: If the hardware mapping data is valid, the corresponding hardware mappings are performed
in the Hardware Mapping Editor; otherwise, if the software detects invalid hardware mappings
(see page 669) in the imported file, a dialog box opens, which contains information about the invalid
entries. Proceed to step 4.
NOTE: Once the import operation is completed, you can see a summary in the notification pane.
4 Click:
 Yes to import only the valid data; invalid entries will be skipped.
 No to cancel the entire import operation.

NOTE: If you proceed, you can see a summary in the notification pane once the operation is
completed.
5 If required, correct the invalid entries in the hardware mapping file or make the necessary
adjustments in the Control project and import the file again.

EIO0000001114 06/2020 675

Mapping Stage

Section 18.3
Supervision Project Mapping Stage

Supervision Project Mapping Stage

Overview
This section describes how to use the Project Explorer to map the Supervision project of the
system.
You must have completed Generation (see page 443) and the Configuration (see page 549)
stages of the Supervision project to proceed with the mapping.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Creating Supervision Project Executables 677
Mapping Services 680
Mapping Communication 682

676 EIO0000001114 06/2020

 Mapping Stage

Creating Supervision Project Executables

Overview
The Executables node gives you access to the service and communication mapping functionality
of the Supervision Participant project.
As such, it allows you to associate:
 The Supervision infrastructure (I/O, alarm, trend, and/or report servers, and/or runtime clients)
that is defined in the Supervision Participant project to station nodes of the topology
representing operation servers and operator stations.
 The I/O device to a controller and its communication module and/or to compatible Modbus TCP
devices and their Modbus TCP server service by using the OFSOPC and/or OPCUA
communication protocol.
You can create several executables for a Supervision Participant project, associating the
Supervision infrastructure to various topological entities, and its I/O device to various controllers
and Modbus TCP devices.
An executable is associated to an Execution Domain, which serves as a filter to select applicable
services, for example, to define the boundaries for runtime navigation services.

Creating Executables
To create an executable, proceed as follows.

Step Action
1 In the Supervision Project Browser, right-click the Executables node of the project and select
Create Executable.
Result: A Supervision executable is created under the Executables node.

EIO0000001114 06/2020 677

Mapping Stage

Executable Actions
The table describes the executable context menu commands.

Command Description
Manage Opens the Manage window in the work area of the Project Explorer, which lets you
perform the following actions:
 Service mapping (see page 680): Associates the Supervision servers and clients
to one or more station nodes of the system topology.
 View and edit the properties (see page 679) of the executable.
 Communication mapping (see page 682): Maps the Supervision I/O device to:
 A controller and its communication module.
 Compatible Modbus TCP devices and their Modbus TCP server service.

Build Starts an automated process to integrate changes quickly in the built Supervision
(see page 704) Participant project by performing an incremental build. The command applies only for
changes that you have made while editing Supervision pages (Edit command).
This command becomes available once you have completed the service and
communication mapping.
NOTE: If the Supervision Participant project is not built yet, you can use this
command in place of Build All indifferently.
Build All Starts an automated process to create (see page 704) the built Supervision
Participant project the first time or to recreate it to integrate certain changes
(see page 710) that you have made to the Supervision Participant project.
This command becomes available once you have completed the service and
communication mapping.
Generate and Build Starts a generation of the Supervision Participant project followed by a build of the
(see page 447) project executable.
If you have not built the executable yet, the build process that is executed is the same
as when you select the Build All command.
If the generation process does not complete successfully, no build is performed and
information is displayed in the notification panel.
NOTE: After selecting the command, the abort icon is displayed in the notification
panel (see page 86). Click the icon to cancel the task.
Deploy Built Project Allows you to deploy the built Supervision project to the station nodes that are mapped
(see page 773) to the executable.
Deploy Changes The command is available only if you have already deployed the built Supervision
(see page 784) project to at least one station node that is mapped to the executable and if the number
and type of changes are supported.
Download Projects Opens the Download Projects tab, which allows you to select Supervision project files
(see page 709) individually to save them on the computer, such as:
 The master project (.ctz) with the name
ProjectIdentifier_ExecutableIdentifier, which was created by the last
successful build process.
 Included projects (.ctz) that are related to animated graphics assigned to
Supervision pages and those that you have added manually (see page 546).
 OFS/OPC UA configuration files (.xml).

678 EIO0000001114 06/2020

 Mapping Stage

Command Description
Delete Deletes the executable including the associated configurations.
NOTE: You cannot delete an executable that you have deployed. The software
displays a message to inform you that the command cannot be executed.
Rename Lets you to enter a new identifier for the executable.
Properties Opens the Properties tab in which you can view and edit properties of the executable.

Executable Properties
To open the properties of the executable, double-click it.
You can view and/or edit the following items.

Property Description
Identifier The identifier must be unique within a Supervision project.
Description Optional.
You can enter a description for the Executable with free form text.
Execution Optional.
Domain String.
Default value: Blank.
You can use runtime navigation services (see EcoStruxure™ Process Expert, Runtime
Navigation Services , User Guide ) only if the executable of the Control Participant project
and the executable of the Supervision Participant project have the same execution domain
value.
You can assign a logical execution domain to the executable with free form text.
Values that you enter remain in the menu and you can select them from executables of other
Control and Supervision Participant projects.
You can modify the Execution Domain parameter at any time during the engineering life
cycle.
NOTE: Leaving the Execution Domain parameter empty is considered as a value.
Build State Indicates the status (see page 707) of the executable.
Default value: Not Built
Built On Date and time when you last built the executable successfully by using a build command.

Assigning an Execution Domain

To assign an execution domain to an executable, proceed as follows.

Step Action
1 Double-click the executable to open its properties.
2 Select a value from the Execution Domain menu or enter a new value.

NOTE: To remove or change the associated execution domain, select the empty row at the top of
the menu.

EIO0000001114 06/2020 679

Mapping Stage

Mapping Services

Overview
The Service Mapping Editor opens within the Manage window when you double-click the
Supervision executable (see page 677).
The service mapping defines to which station nodes that represent the operation server and
operator station computers you deploy (see page 773) the Supervision project.
Before you proceed with the service mapping, create the necessary station nodes in the topology
of the system and configure them with the services as needed:
 A Supervision service (see page 567).
 An OFS service (see page 567).

You must map all the services of the Supervision Participant project to station nodes in order to
complete the build stage (see page 704).
NOTE: Install OPC Factory Server or OPC UA Server Expert on the station node that you map to
the IOServer service.

Mapping Station Nodes Configured with Several NICs

The service mapping does not let you select a specific NIC for each station node.
The IP address of each NIC is created as a network address (see page 356) in the Supervision
Participant project and associated to the I/O server.
For details on the behavior when deploying to a station node that is configured with more than one
NIC, refer to the topic describing the target computer setup (see page 774).

Changing the Service Mapping of Deployed Executables

If you have already deployed a Supervision executable to one or more station nodes of the system,
when you change the service mapping of this executable, the software clears the related entry in
the Last Deployed On field (see page 779) of the station nodes that you have unmapped. As a
result, if you recreate this mapping right away and deploy, it is handled like a first deployment.
NOTE: The service mapping of a station node is unmapped if you delete its Supervision service. It
is unmapped if you delete its OFS service (see page 567) and the station node was mapped to the
IOServer service of the Supervision project.

680 EIO0000001114 06/2020

 Mapping Stage

Mapping Services
To map a Supervision server or client to a station node, proceed as follows.

Step Action
1 Double-click the executable of the Supervision project that you want to map and select Manage.
Result: The Service Mapping Editor opens.
2 Click the Engine menu next to the server or client that you want to map.
Result: The menu displays the identifiers of compatible station nodes (see page 680).
3 Select a station node.
Result: The software maps the service to the selected station node.
NOTE: Once you have mapped the I/O server, the Communication Mapping tab is shown at
the bottom of the window.

NOTE: To remove a mapping, in the Service Mapping Editor, right-click a service and select
Unmap.

EIO0000001114 06/2020 681

Mapping Stage

Mapping Communication

Overview
To open the Communication Mapping Editor, click the Communication Mapping tab within the
Manage window (see page 678). The tab appears once you have performed the service mapping
(see page 680) with an I/O server.
The communication mapping defines from which topological entity I/O devices acquire data during
runtime by using the selected driver (see page 352).
The editor lets you map the I/O devices of the Supervision project to:
 A controller of the system and its communication modules. This includes modules that embed
an OPC UA server.
 Modbus TCP devices that feature the Modbus TCP server service (for example, Altivar drives,
power meters, STB islands, or PRMs).
 Modbus serial devices by using a topological Modbus TCP device acting as gateway.
 A station node acting as an emulated simulator and to which a Control Expert project has been
deployed.
For each I/O server that you map, the software creates a protocol-dependent OFS/OPC UA
configuration file (see page 704). Exceptions apply.
NOTE: Changing the protocol of a tag container (see page 396) whose associated I/O device is
already mapped to a topological entity removes the mapping.

Physical Connection Prerequisites

To be able to proceed with the communication mapping, the following need to be connected to the
same Ethernet network (see page 596):
 The NIC of the station node that is mapped to the I/O server in the service mapping
(see page 680).
 The communication modules of the controller entity.
 The Modbus TCP device (if present).

Mapping Modbus Devices

Before you can map a Modbus TCP or Modbus serial device to be able to monitor data directly
from the Supervision infrastructure that is defined in the Supervision project, you need to perform
some additional steps.
For details, refer to the topic describing how to monitor Modbus device data directly from
Supervision (see page 920).

682 EIO0000001114 06/2020

 Mapping Stage

Mapping Modules Embedding an OPC UA Server

When Protocol of the tag container that is associated to the I/O device is set to OPCUA Embedded,
Data Server (Address B) is disabled. You can map only one module per I/O device.
When modules embedding the OPC UA server are mounted in both local racks of a redundant
configuration, either module can be selected under Data Server (Address A).
To map also the module embedding an OPC UA server located in rack B, create a second I/O
device configured as standby (see page 348) and associate it to the same tag container.

Mapping Redundant Communication Ports

For controllers and station nodes, you can map up to two communication ports or NICs to a same
I/O device if the following conditions are satisfied:
 The communication ports/NICs belong to the same topological entity.
 They are connected to the same physical network.
 Direct TCP/IP Addressing Mode of the tag container (see page 396) that is associated to the
I/O device is set to Unallocated/Allocated Data, PAC Modicon (/U).
NOTE: When Protocol of the tag container that is associated to the I/O device is set to OPCUA
Embedded, communication port redundancy for the same I/O device is not possible.

Communication Mapping Tab

The following figure shows an example of the Communication Mapping Editor in which one
controller and two Modbus TCP devices are mapped to I/O devices through their communication
modules.

EIO0000001114 06/2020 683

Mapping Stage

Header Description
IO Device I/O devices that you have created in the cluster and which is associated to a tag container.
Topological Topological entities that have at least one communication module (data server) connected to
Entity the same Ethernet network as the station node to which the I/O server is mapped. These can
be controllers, station nodes, Modbus TCP devices, and generic Modbus TCP device entities
acting as gateways for Modbus serial devices.
The selected entity becomes the data source.
NOTE:
Restrictions apply when the protocol of the tag container that is associated to the I/O device has
the following value:
 OPCUA: Controllers of the Quantum platform are not shown.
 OPCUA Embedded: Only controllers that have a module, which embeds an OPC UA server
and that is connected to the same Ethernet network (see page 682) are shown.
Data Server Communication modules of the selected topological entity that are connected to the same
(Address A) Ethernet network as the station node to which the I/O server is mapped.
For Modbus I/O device entities, it is the Modbus TCP server service of the topological entity.
The IP address of the module is set as the primary address in the OFS/OPC UA configuration
file.
NOTE: When the protocol of the tag container that is associated to the I/O device is set to
OPCUA Embedded, only modules that embed an OPC UA server are shown.
Data Server Optional. The menu is available only if the topological address A has been mapped.
(Address B) Communication modules of the selected topological entity that are connected to the same
Ethernet network as the station node to which the I/O server is mapped excluding the one that
has been mapped to address A.
The IP address of the module is set as the secondary address in the OFS/OPC UA
configuration file.
NOTE:
The menu is disabled in either case:
 The topological entity is a Modbus TCP device.
 Protocol of the tag container that is associated to the I/O device is set to OPCUA Embedded.

Modbus  For Modbus TCP devices, it is the ID parameter of the topological entity. The value
Unit ID corresponds to the default value of the template or to the value that you had configured
(when available) before selecting the device and its data server. You can change the value
for the device. The change is not propagated to the topological entity. Changing the value
in the topological entity is not propagated to devices that are already mapped.
 For Modbus serial devices, if you have already configured an application template of the
device (for example, an instance of $ATV71MB), enter the ModbusAddress parameter value
of the instance. Otherwise, enter the unique serial slave ID of the device.
Valid range: 0 to 255
Refer to the documentation of the device for information on the parameter configuration.
NOTE:
 The software does not verify the uniqueness of entries.
 The parameter is disabled for station nodes and controllers.

684 EIO0000001114 06/2020

 Mapping Stage

Mapping Station Nodes

When you map an I/O device to a station node, you can simulate runtime services.
The software displays the station node in the Communication Mapping Editor only if its NIC is
connected to an Ethernet network and if you have created a Control Expert service (see page 567)
in the station node.
NOTE: Map (see page 685) the Control executable of the corresponding Control Participant
project to the same station node.

Mapping Communication
To map the I/O device to the communication module/card of a topological entity, proceed as
follows.

Step Action
1 Select the Communication Mapping tab within the Manage window.
2 Click the Topological Entity menu next to the I/O device you want to map.
Result: The menu displays the identifiers of the compatible entities of the system.
3 Select an entity.
4 Click the Data Server (Address A) menu.
Result: The menu displays the identifiers of the available communication modules/cards of the
selected entity.
5 Select a communication module/card.
6 If needed, click the Data Server (Address B) menu and select a second communication
module/card of the same entity.

NOTE: To remove the entire communication mapping for an I/O device, right-click a
communication module/card in either Data Server column and select Unmap.
To remove the mapping of one data server only, select Not Assigned from the menu.

EIO0000001114 06/2020 685

Mapping Stage

686 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Build Stage
EIO0000001114 06/2020

Chapter 19
Build Stage

Build Stage

Overview
This chapter describes how to create the built Control and Supervision Participant projects, which
are the executables and project files that you deploy to controllers and/or station nodes of the
system.
The following figure shows the position of the Build stage within the system engineering life cycle.

Refer to the Build stage (see page 62) for a description of the purpose of this stage.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
19.1 Control Project Build Stage 688
19.2 Supervision Participant Project Build Stage 703

EIO0000001114 06/2020 687

Build Stage

Section 19.1
Control Project Build Stage

Control Project Build Stage

Overview
This section describes how to use the Project Explorer to create the built Control Participant project
for the first time and, in a second step, to integrate changes that you have made to the Control
Participant project and to the topology of the system.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Building the Logical Control Participant Project 689
Changing the Built Control Participant Project 696
Managing Hardware Abstraction Layer (HAL) Variables and DFBs 699

688 EIO0000001114 06/2020

 Build Stage

Building the Logical Control Participant Project

Overview
In this automated process, the software creates a unique built Control Participant project, which
merges:
 The logical Control Participant project information, including changes made during refinement.
 The mapping information, which is associated to the Control executable of the logical project:
 Services
 Hardware
 Communication (if applicable)

 The topological information, which is associated to the mapped services

The software stores the resulting program file (.stu) in the content repository (see page 1023).
The build process also:
 Creates the necessary DDDT variables with the number of input and output words that you have
configured to allocate memory.
 Creates the I/O scanner lines for the communication channels that exist in the communication
mapping given that sufficient memory is available (see page 562).
 Defines the value of REF_TO data types (see EcoStruxure™ Process Expert, Control
Participant Services, User Guide):
 As REF(%MWx) or REF(%CH<@mod>.<c>) (IODDT) for direct addressing data instances
(HAL2.0 variables) that are used in hardware mapping.
 As REF(DDDT) for variables that are used in communication mapping.
 As REF(PES_CONST_TRUE) for variables that need to be initialized as TRUE.

 Introduces the REF_TO ANY_BOOL data type because of the legacy feature to convert BOOL
to EBOOL, and the other way around becoming obsolete. If you have updated existing
Schneider Electric HAL templates in systems with HAL2.0 templates (see EcoStruxure™
Process Expert, Control Participant Services, User Guide), both data types are converted to
REF_TO ANY_BOOL.
NOTE: The conversion does not apply to templates created by users except if they reference
Schneider Electric HAL templates (for example, $DISignal_UL).
To perform a subsequent build or if the Build command has become unavailable, refer to the topic
Changing the Built Control Participant project (see page 696).
NOTE: You may need to update the firmware version of topological entities to support the
ANY_BOOL data type during build. For information on compatible firmware versions, refer to the
platform release notes.

EIO0000001114 06/2020 689

Build Stage

Device Type Manager and Device DDT Variables for Modbus TCP Devices
During build, the software adds a generic Modbus Device device type manager (DTM) for each
Schneider Electric Ethernet Modbus TCP device (see page 584) that you have configured in the
topology of the system and which communicates with a controller of the M580 platform or by using
a NOC communication module. You do not need to add it.
Modbus TCP devices can be:
 An STB Island
 A PRM
 A Modbus TCP I/O device

The DTM name is composed of four elements. It has the following syntax.
<I/O device name><Counter>_<Client communication module><Position>
Where:
 <I/O device name> is the identifier of the topological entity (see page 550). The identifier is
truncated not to exceed 10 characters.
 <Counter> is an incremental 1 or 2-digit number generated by the software so that truncated
device names are unique.
 <Client communication module> is the commercial reference of the communication module of
the client controller that is used to communicate with the device. The reference is truncated to
not exceed 12 characters.
 <Position> is the position of the communication module on the rack.

For example, EATV71HW_11_BMENOC030122 (1 in 11th position from the left is the counter and
2 in last position is the position of the module. EATV71HW_1 is the I/O device name.
BMENOC03012 is the commercial reference of the communication module).
The Control Participant creates the corresponding DDDT variable.

Device Type Manager and Device DDT Variables for Peer to Peer Communication
During build, the software adds a generic Modbus Device device type manager (DTM) in the
consumer (client) Control project for each communication module of a server counterpart with
which a peer to peer communication channel exists. The DTM is added if the controller acting as
client is of the M580 platform or if communication client-side is implemented by using a NOC
communication module.
The DTM name is composed of four elements. It has the following syntax.
<Server entity><Counter>_<Server communication module><Position>
Where:
 <Server entity> is the identifier (see page 558) of the topological entity acting as server
(see page 631). The identifier is truncated to not exceed 10 characters.
 <Counter> is an incremental 1 or 2-digit number generated by the software so that truncated
server entity names are unique.

690 EIO0000001114 06/2020

 Build Stage

 <Server communication module> is the commercial reference of the communication module of

the controller acting as server. The reference is truncated to not exceed 12 characters.
 <Position> is the position of the communication module on the rack.
For example, Controller1_140NOE771012 (1 in 11th position from the left is the counter and
2 in last position is the position of the module. Controller_1 is the server entity name, which
has been truncated. 140NOE77101 is the commercial reference of the communication module
server side).
The Control Participant creates the corresponding DDDT variable.

Device DDT Variables Created in the Logical Control Project

If you have created a device DDT variable (see page 517) in the logical Control project and this
variable does not exist in the controller that is mapped to the executable (for example, because
you have removed the module to which it is associated), the resulting built Control project contains
it in unmapped (unlocked) state.
If a device DDT variable with the same name exists in both the logical Control project and the
controller that is mapped to the executable but with a different data type or type version, the
resulting built Control project contains the variable of either type based on the following rule.

DDDT variable in the DDDT variable in the logical Result in the built Control project
controller Control project
Mapped Unmapped Variable of the same type as in the controller
mapped to the executable.
Unmapped Unmapped Variable of the same type as in the logical Control
project.

Validity Indicators
If a validity icon (see page 378) is displayed, you may not be able to build the project successfully.
Some exceptions apply (see page 449).
In such case, Refine the Control Participant project (see page 507) to fix the issue.The Control
Participant features tools that help you identify validity issues.
When you save the Control Participant project after refining (see page 511) it and project analysis
is enabled (see page 308), the project is analyzed. The status of the Control project is indicated by
a validity icon.

Building the Control Project for the First Time

Use the Build or Build All command indifferently to create the built Control Participant project for
the first time.
NOTE: If you have not built the Control Participant project yet, you can also use the Generate and
Build command. For information on the generation process, refer to the topic describing the
generation of Participant projects (see page 445).

EIO0000001114 06/2020 691

Build Stage

Control Participant Project Settings

When you build a logical Control Participant project by using the Build All command, the software
may override some project settings (see EcoStruxure™ Process Expert, Control Participant
Services, User Guide) that you have set during configuration.
To view the Project Settings of the built Control Participant project, use the Open Built Project
command (see page 695).
NOTE: This applies also when you are using the Generate and Build command to build a
Participant project executable for the first time.

Allocation of Memory in I/O Scanner Lines

The build process allocates the memory in the following order: First write, then read.
Read and write addresses are created contiguously for clients of the M580, M340, and Quantum
platforms.
The read/write memory allocation varies depending on the platform.

Platform Memory allocation process

Quantum The write address should be the end of the read address of the previous channel. However, for
example, if 2 channels exist for entity A, and 1 channel exists for entity B, then the memory
allocation is the following:
1 Write memory allocation for any existing channels of entity A.
2 Read memory allocation for any existing channels of entity A.
3 Write memory allocation for the channel of entity B.
4 Read memory allocation for the channel of entity B.
NOTE: The first 8 words are allocated for the device control block.
M340 1 Allocates the memory for writing for any existing channels.
M580 2 Allocates the memory for reading for any existing channels.

NOTE: The software detects an error in the configuration during build if you have not configured
sufficient memory for a client controller based on the Quantum platform with NOC communication
module (see EcoStruxure™ Process Expert, Control Participant Services, User Guide).

692 EIO0000001114 06/2020

 Build Stage

Allocation of Peer to Peer Communication Variables

The build process allocates addresses or values to the network variables that you have mapped
(see page 645) to communication channels.
The start address of a variable in the channel needs to be even and contiguous with the channel.
Therefore, if the start address of the communication channel created in the client is:
 Odd:
 No variable is allocated to the first word of the client communication channel.
 Addressing of variables in this channel starts from the second word.
 The offset of the server read/write memory counterpart is the first word of the server
communication channel.
 Even:
 Addressing of variables in this channel starts from the first word.
 Read and write size of the memory is equal to the value of the ServerMemoryLength
parameter - 1.
 The offset of the server read/write memory counterpart is the second word of the server
communication channel.
NOTE: If by using the Refine command, you delete or change the name, type (ID or version), or
size of any variable or network variable that is mapped to a communication channel, the build
process cannot complete successfully. The software displays diagnostic information in a dialog
box. In such case, open the Variable Mapping Editor to remove (see page 654) the inconsistent
variable or undo the changes to the variable. Start the build process over.
The figure shows examples of entries created during build in the consumer project (see page 527)
(client based on the M580 platform) for the Value attribute of two sample peer to peer
communication variables that are used to read data from the server (DISignal_UL_1V) and write
data to the server (Valve_1_VALVE_OPV).

The figure shows examples of entries created during build in the owner project (server based on
the M580 platform) for the Value attribute of the two counterpart sample peer to peer
communication variables.

EIO0000001114 06/2020 693

Build Stage

Aborting Build Tasks

After selecting a build command or confirming it, the abort icon is displayed in the notification panel
(see page 86). Click the icon to cancel the task. No build is performed.
Only the user who has initiated the command is allowed to abort it.
NOTE: If you are building only a small Control Participant project, the task may complete before
you are able to click the icon.

Using the Build Commands

To build the Control Participant project, modify the built Participant project through an incremental
build, or build it again, proceed as follows.

Step Action Result

1 Right-click the executable and select Build, If no validity icon (see page 691) is displayed, the
Build All, or Generate and Build depending on software executes the following actions; otherwise
the situation (see page 698). it displays a confirmation dialog box. In such case,
proceed to step 2.
 Proceeds with the creation or update of the built
Control Participant project.
 Stores the program file (.stu) in the content
repository.
 Displays information in the notification panel.
 Displays a dialog box containing a summary of
the build process.
2 In the confirmation message, click No. The confirmation dialog box closes without building
the Control Participant project.
NOTE: Click Yes to proceed with the build
anyway; the process may not complete
successfully.
3 Refine the Control Participant project –
(see page 511) to fix the issue.
4 Start the build process over. –

NOTE: If the build process does not complete successfully, the software displays a notification to
inform you and provides indications about the cause. In such case, make the necessary
corrections and build the project again.

694 EIO0000001114 06/2020

 Build Stage

Build Status
The table describes the build status of an executable (see page 627).

Status Description
Not Built No built Participant project exists.
Default status when you create an executable.
Built The built Participant project is up to date.
Out Of Date The built Participant project is out of date and needs to be built again (see page 698).

NOTE: You may need to build the Control Participant project again if you have made certain
changes (see page 696) to the system even though the software displays the Build State as Built.

Viewing the Built Participant Project

Once you have built the Control Participant project, you can open the project in the Control
Participant to view it.
You may also be able to open the built Control Participant project if the software reports detected
errors during the build process to help you with the troubleshooting.
NOTE: Do not make changes to the built Control Participant project from within the Control
Participant as the software discards any changes upon closing the reduced Participant window.
To make changes to the system, you can use the following methods:
 Open the system using the corresponding explorer.
 Refine (see page 507) the logical Control project.

To open the built Control Participant project in the Control Participant, proceed as follows.

Step Action
1 Right-click the Control executable and select Open Built Project.
Result: The Control Participant opens extracted (see page 134) and maximized. You can view
the contents of the built executable.
NOTE: For more information, refer to Viewing the Built Control Participant project
(see EcoStruxure™ Process Expert, Control Participant Services, User Guide).
2 Close the Control Participant window.

NOTE: To save a copy of the built Control Participant project, use the Save as command of the
Content Repository explorer (see page 1025).

EIO0000001114 06/2020 695

Build Stage

Changing the Built Control Participant Project

Overview
This automated process allows you to change the built Control Participant project by integrating
changes that you have made to the Control Participant project, or to the topology of the system.
Depending on the modifications you made, the status of a built Control Participant project changes
and you may need to use a specific command to integrate changes.

Changes Modifying the Build Status

The table describes how changes affect the executable of a Control Participant project whose
status is Built.

Change Resulting
build state
Changes to the topology of the system (for example, properties, controller rack configuration, Out Of Date
IP addresses, physical connections, replacing templates of I/O device entities, deleting STB
island entities, Ethernet networks entities, and so on).
Changing the logical Control Participant project and generating it.
Deleting a section in the Project Explorer.
Selecting the Refine command after adding, renaming, or changing the order of sections in
the Project Explorer.
Refining the Control Participant project.
Selecting Built Participant Project for an executable when importing a Control Participant
project in the Project Explorer.
It applies in the following cases:
 An executable with the same identifier already exists in the target project and its status is
Built.
 You are importing an executable that does not exist yet in the target project and its status
was Built at the time of export.
Updating (see page 841) the logical Control Participant project.
Changing the service, communication, or hardware mapping of the Control executable.
For communication mapping, in case a peer to peer communication channel exists, changes
include creating, modifying, or deleting a variable mapping (see page 645)(1).
Removing the service mapping. Not Built
Deleting a controller or station node that is selected in the service mapping, or deleting the
ControlExpert service (see page 567) of such a station node.

696 EIO0000001114 06/2020

 Build Stage

(1) When a communication channel and variable mappings for peer to peer communication exist
between two built Control project executables, making a change affecting the communication
channel or variable mapping in one executable, which sets its build status to Out Of Date also
changes the build status of the other executable to Out Of Date. Such change can be, for
example, deleting the Control project or its executable, deleting a mapped variable, deleting a
section containing a mapped variable, disconnecting a mapped controller entity, and so on.
NOTE: After making a change, which modifies the build status, build the logical Control Participant
project again using the appropriate command (see page 698).

Building after Creating, Updating, or Deleting Device DDT Variables in the Logical Control Project
If you have created a device DDT variable (see page 517) in the logical Control project and this
variable does not exist in the built Control project, the updated built Control project contains it in
unmapped (unlocked) state.
The following table describes the result when building changes if a device DDT variable with the
same name exists in both the logical and the built Control project but with a different data type or
type version.

DDDT variable in the built DDDT variable in the logical Result in the updated built Control project
Control project Control project
Mapped Unmapped Variable of the same type as it was in the built
Control project.
Unmapped Unmapped Variable of the same type as in the logical Control
project if the type that is updated is not used by a
mapped device DDT variable.

The following table describes the result when building changes if a device DDT variable that exists
in the built Control project has been deleted from the logical Control project.

DDDT variable in the built DDDT variable in the logical Result in the updated built Control project
Control project Control project
Mapped Variable is deleted and  The device DDT variable is not removed.
references to it in code are  Code is updated.
removed.
Unmapped  The device DDT variable is removed.
 Code is updated.

EIO0000001114 06/2020 697

Build Stage

Using the Appropriate Command to Integrate Changes

The table indicates which command to use to update the built Control Participant project depending
on the change that you have made.

Change Command Action

Adding, deleting, or changing: Build (4) Performs an incremental
 Any section (including the order of sections) build.
 Variables(1) (including device DDT variables (see page 517))
 The hardware mapping

Changing the topology of the system(2). Build All Performs a complete

build.
Changing the communication or network variable mapping(2).
After an import into a Control Participant project(2).
After regenerating a Control Participant project(2).
Adding, deleting, or changing:
 Animation tables(3)
 Operator screens(3)
 DDTs or DFBs(3)

Changing the order of FBD or non-FBD sections in the Control

Participant project by using the Refine command(3).
Moving FBD or non-FBD sections from one task folder to the other
(for example, from MAST to FAST) while refining the Control
Participant project (Refine command).
Changes that set the build status to Not Built (see page 696). Build or Either command performs
Build All a complete build.

(1) To integrate changes to attributes of variables used in hardware mapping (see page 699), use
the Build All command.
(2) Such change disables the Build command.
(3) Using the Build command after such change does not update the built Control Participant
project.
(4) You can also use the Generate and Build command (see page 447).
NOTE: When you modify an existing peer to peer communication channel, rebuild the owner and
the consumer (see page 527) Control Participant projects.

Performance Considerations
When you have made changes to a built Control Participant project and the appropriate command
to update it is Build, in certain cases you may be able to reduce the time required to update the
built Participant project by using the Build All command instead.
This can be the case, for example when you make changes to many sections of a built Control
Participant project at once.

698 EIO0000001114 06/2020

 Build Stage

Managing Hardware Abstraction Layer (HAL) Variables and DFBs

Overview
The Global Templates library contains HAL application templates, which generate elementary
variables representing the value and/or quality of hard-wired signals.
HAL is a mechanism that emulates access to hardware resources to maintain an application
device-independent. By using such templates, you can use the elementary variables that they
generate although the hardware channels are not yet part of the logical Control Participant project.
Data related to the topology is associated to the logical Control project during build.
The following types of templates exist:
 HAL templates generating elementary digital or analog Control Participant variables (for
example, signal conditioning templates).
 Special card templates containing DDTs, DFBs, and/or IODDTs, allowing to use the data
exchanged with the special in-rack modules (for example, Modicon M340 high speed counter
module device templates).
Facets referenced by these templates are used during the hardware mapping.
For details on these templates, refer to the help (see page 115) of the Schneider Electric libraries
for EcoStruxure Process Expert.

Marking HAL Variables and DFBs

When you build the logical Control Participant project, the software marks the following code that
is used in the hardware mapping with the Custom attribute HAL:
 Elementary variables coming from mapped facets of hardware abstraction layer templates or
special card templates.
 DFB instances and IODDTs coming from mapped facets of special card templates and that are
added to a section during build.
Limitations can apply when you:
 Refine sections containing marked DFB instances, using the Refine Online command
(see EcoStruxure™ Process Expert, Control Participant Services, User Guide).
 Update the logical Control Participant project (see page 841) with changes made to HAL
variables or sections containing marked DFB instances.
NOTE: DFB instances and IODDTs are marked with the attribute HALFB to distinguish them from
EDTs.

EIO0000001114 06/2020 699

Build Stage

Properties of HAL Variables

In this example, facets of instance DigitalInput_1 have been assigned to an FBD section and
generated. In the hardware mapping, the DigitalInput_1_DINPUT_DIS facet is mapped to a
channel of the digital input module of the controller. The controller entity is based on the M580
CPU. The following figure shows the built Control Participant project where the software has
marked the DigitalInput_1_DINPUT_DISV variable that is used in the hardware mapping.

700 EIO0000001114 06/2020

 Build Stage

Properties of HAL IODDT Variables and DFBs

In this example, the facet of instance TSignCptBmx_1 (modeling a high speed counter module) has
been assigned to an FBD section and generated. In the hardware mapping, the TSignCptBmx_1
facet is mapped to a channel of the high speed counter module of the controller. The following
figure shows the built Control Participant project where the software has added the
TSignCptBmx_1 DFB encapsulated in this facet to the section and marked it.
NOTE: The data type and addressing method for variables shown in this example may vary
depending on the version of the template generating them.

The following figure shows the same built Control Participant project where the software has
created the corresponding IODDT TSignCptBmx_1_CHANNEL and marked it.

NOTE: A TSignCptBmx_2_DATA facet of another high speed counter instance, for the second
channel of the counter module, has been assigned to the FBD section and generated. However,
the hardware mapping for the second channel has not been done, thus the second DFB instance
and the corresponding IODDT have not been added to the section.

EIO0000001114 06/2020 701

Build Stage

Viewing Sections Containing HAL DFBs and Variables

Once you have built the Control Participant project, use the Open Built Project command to view
the HAL attribute, allowing you to identify variables and DFB instances that the software has
marked.
NOTE: After deployment, you can also view this attribute by using the Refine Online command.
NOTE:
This attribute is not visible when you refine the logical Control Participant project by using the
Refine command.

Changing HAL Variables

To integrate into the built Control Participant project changes that you make to variables that the
software marks as HAL, using the Refine command, refer to Using the Right Command to Integrate
Changes (see page 698).

702 EIO0000001114 06/2020

 Build Stage

Section 19.2
Supervision Participant Project Build Stage

Supervision Participant Project Build Stage

Overview
This section describes how to use the Project Explorer to create the built Supervision Participant
project for the first time and, in a second step, to integrate changes that you have made to the
Supervision Participant project.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Building the Supervision Participant Project 704
Changing the Built Supervision Participant Project 710

EIO0000001114 06/2020 703

Build Stage

Building the Supervision Participant Project

Overview
In this automated process, by using the compilation mechanism of the Supervision Participant, the
software creates a unique built Supervision Participant project, which merges:
 The logical Supervision Participant project information.
 The mapping information, which is associated to the executable of the logical Participant
project:
 Services
 Communication

 The topology information, which is associated to the mapped services.

The software stores the resulting Supervision project file (.ctz) in the content repository
(see page 1022).
This is the file that you can deploy to computers running Supervision software.

I/O Device Addresses

When the protocol for a tag container is OPCUA or OPCUA Embedded, the build process replaces
the temporary IP address and port value (see page 349) in the address of the I/O device that is
associated to the container in order to create the actual I/O device address in the Supervision
Participant project.

Protocol for tag I/O device address format

container
OPCUA opc.tcp://<IP address>:<TCP listening port>/OPCUAServerExpert
Where:
 <IP address> is the IP address of the station node (see page 569) that is
mapped (see page 680) to the IOServer service.
 <TCP listening port> is the value that is configured for TCP Port for this station
node.
OPCUA Embedded opc.tcp://<IP address>:<TCP listening port>
Where:
 <IP address> is the IPv4 address (see EcoStruxure™ Process Expert, Control
Participant Services, User Guide) of the communication module embedding the
OPCUA server and that is selected in the communication mapping (see page 682)
for the I/O device associated to the tag container.
 <TCP listening port> is the value that is configured for this module in the Control
Participant.

NOTE: For other protocols, refer to the Address property (see page 348) of the I/O device.

704 EIO0000001114 06/2020

 Build Stage

OFSOPC and OPC UA Configuration Files

During the build process, the software generates the necessary OPC Factory Server and OPC UA
Server Expert configuration files and stores them in the contents repository.
One configuration file is created for each station node that is mapped (see page 680) to an
IOServer service. The name of the configuration file contains a suffix that identifies the protocol
that is used.
In case more than one protocol is used in the Supervision project, at least one configuration file per
protocol is generated.

Protocol used Configuration file name Configuration file aliases

OFSOPC <Topological One device alias exists for each I/O device of
entity>_DeviceConfig_OFSDA.xml the same I/O server.
For example, The alias name is Alias_<I/O device>
OperationServer_DeviceConfig_OFSDA.xml where <I/O device> is the identifier of the
I/O device that is mapped (see page 682) to
the data source.
For example, Alias_IODevice_1.
OPCUA <Topological One device alias exists for each tag container.
entity>_DeviceConfig_OPCUA.xml The alias name is the tag container identifier
For example, (see page 396).
OperationServer_DeviceConfig_OPCUA.xml For example, TagContainer_1.
NOTE: The User authentication and
X509 user token properties are enabled by
default.
For details, refer to User Authentication and
Authorization in the help of OPC UA Server
Expert.
OPCUA with No configuration file is generated. Not required.
OPC UA server The OPC UA server is embedded in a module
embedded in of the controller that is the data source.
module of The variable tag address has the format
controller ns=2;s=0:<variable name> where ns
(see page 396) indicates the namespace and 2 corresponds
to the OPC UA server as defined by
Schneider Electric.
For example, ns=2;s=0:InputVar1
Where <Topological entity> is the identifier of the station node to which the IOServer service is mapped in the
service mapping (see page 680)

If you rename the station node, the name of the configuration file is updated without the need to
build the Supervision Participant project.
NOTE: For information on how to generate symbol table files (.xvm), refer to the topic describing
the Control project deployment process (see page 719).

EIO0000001114 06/2020 705

Build Stage

Network Addresses of Supervision Project Components

When you build a Supervision Participant project, and you have not done the service mapping
(see page 680) of a server and/or client of the project, the software does not generate an IP
address for this component. Because of this, the build process of the Supervision Participant
project cannot complete successfully.
Proceed with the service mapping of any Supervision Participant project component that you have
created before building the project.
For example, if you have not mapped the alarm server of the project, the network address of the
associated topological entity is not generated into the Supervision Participant project.

Building When Instance Identifiers Start with a Digit

When the logical Supervision Participant project that you want to build contains facets referenced
by instances whose identifier starts with a digit, you need to set the tagstartdigit parameter
of the Supervision Participant configuration file (.ini) to 1 for the build process to complete
successfully.

Building the Supervision Project for the First Time

Use the Build or Build All command indifferently to create the built Supervision Participant project
for the first time.
NOTE: If you have not built the Supervision Participant project yet, you can also use the Generate
and Build command. For information on the generation process, refer to the topic describing the
generation of Participant projects (see page 445).

Aborting Build Tasks

After selecting a build command, the abort icon is displayed in the notification panel (see page 86).
Click the icon to cancel the task. No build is performed.
Only the user who has initiated the command is allowed to abort it.
NOTE: If you are building only a small Supervision Participant project, the task may complete
before you are able to click the icon.

706 EIO0000001114 06/2020

 Build Stage

Using the Build Commands

To create the Supervision Participant project, modify it, or to create it again, proceed as follows.

Step Action Result

1 Right-click the executable and select Build, Build The software executes the following actions:
All, or Generate and Build depending on the  Creates the creation or update of the
situation (see page 710). Supervision Participant project.
 Stores the project files in the contents
repository.
 Displays information in the notification panel.
 Displays a dialog box containing a summary
of the build process.
NOTE: Building the Supervision project may
take time.

NOTE: If the build process does not complete successfully, the software displays a notification to
inform you, and provides indications about the cause. In such case, make the necessary
corrections and build the project again.

Build Status
The table describes the build status of an executable (see page 679).

Status Description
Not Built No built Participant project exists.
Default status when you create an Executable.
Built The built Participant project is up to date.
Out Of Date The built Participant project is out of date and needs to be built again.

NOTE: You may need to build the Supervision Participant project again if you have made certain
changes (see page 708) to the system even though the software displays the Build State as up to
date.

EIO0000001114 06/2020 707

Build Stage

Changes Modifying the Build Status

The table describes how changes affect the status of the executable of a Supervision Participant
project that is already built.

Change Resulting build state

Renaming an I/O device or the Supervision project. Out Of Date
Generating the project after making changes.
Creating a page.
Changing the project through refinement.
Any import operation in the Project Explorer.
Changing service or communication mapping of the Supervision executable.
Changes to the topology of the system, for example:
 Changing the IP address of the NIC of a station node or of a module that
is selected in the service or communication mapping.
 Deleting the ControlExpert or OFS service, or the NIC instance of a
station node that is selected in the communication mapping.
 Deleting the Supervision service of a station node that is selected in the
service mapping.
 Deleting a controller that is selected in the communication mapping.
 Changing the TCP Port of a station node that is selected in the service
mapping for the I/O server when the protocol that is used for at least one
tag container is OPCUA.
Removing all service mappings of the Supervision executable. Not Built
Deleting a station node that is selected in the service mapping.

708 EIO0000001114 06/2020

 Build Stage

Downloading Supervision Project Files

After the build process completes successfully, the following files are available for download in the
Download Projects window (see page 678):
 The master project (.ctz) with the name ProjectIdentifier_ExecutableIdentifier
(for example, Supervision_1_Executable_1).
The project also contains any user files (see page 543) that are attached to the Supervision
Participant project.
 The included projects (.ctz) that are related to animated graphics, which have been added to
Supervision pages (see page 543).
 Any other included project that you have added manually (see page 546) to the Supervision
Participant project.
 The OFSOPC/OPC UA configuration files (.xml) if you have configured the communication
board (see page 352) driver as OFSOPC or OPCUA.
NOTE: You can download included projects as soon as the software has added them to the
Supervision Participant project.
To download a project file, proceed as follows.

Step Action
1 Right-click the executable that you have built and select Download Projects.
Result: The Download Projects window opens and shows the project files associated to the built
Supervision Participant project.
2 Select one file and click Download.
Result: The Save As dialog box opens.
3 Browse to the location where you want to save the file and click Save.

EIO0000001114 06/2020 709

Build Stage

Changing the Built Supervision Participant Project

Overview
This automated process allows you to change the built Supervision Participant project by
integrating changes that you have made to the Supervision Participant project.
For performance considerations, when possible, use the Build command. It requires less time to
complete than Build All. However, you can use the Build All command in any case.
NOTE: You can also use the Generate and Build command (see page 447).

Using the Right Command to Integrate Changes

The table indicates which command to use to update the built Supervision Participant project
depending on the type of change that you have made.

Change Command Action

Changes involving Supervision pages: Build (1)(2) Performs an
 Creating or deleting a page. incremental
 Editing a page (Edit command): compilation.
 Adding or deleting one or more genies or graphical elements.
 Editing page properties.

 Generating a page that contains a genie facet with the status Out Of
Date or Deleted.
Changes involving Supervision data facets(2):
 Assigning or unassigning a facet from a tag container.
 Moving an existing facet to another tag container.
 Generating a tag container that contains a facet with the status Out Of
Date or Deleted.
Modifying a parameter of the Message category (see page 201) of a No compilation
Supervision element of an instance and generating the corresponding is performed.
Supervision project (for example, modifying the description of an interlock
condition of the InterlockTags element under the Supervision node of an
instance).
(1) You are limited in the number of changes that you can make per Supervision Participant project to be able
to use the Build command:
 A maximum of 5 changes involving Supervision pages.
 A maximum of 30 changes involving data facets.

When you exceed either limit, you must use the Build All command.
(2) You can also use the Generate and Build command (see page 447).
(3) When you make this type of change, the Build command is not available.

710 EIO0000001114 06/2020

 Build Stage

Change Command Action

Other changes, for example, to: Build All(2)(3) Performs a
 Clusters. complete
 The trend, alarm, report, and/or I/O server. compilation.
 Service and communication mappings.
 Advanced project settings.
 Generating or refining the Supervision Participant project (except when
generating only changes that involve a Supervision data facet as
described in this table).
 Topological entities, for example, changing the TCP Port of the I/O
server station node when the OPCUA protocol is used or changing the
configuration of a module that embeds an OPC UA server.
(1) You are limited in the number of changes that you can make per Supervision Participant project to be able
to use the Build command:
 A maximum of 5 changes involving Supervision pages.
 A maximum of 30 changes involving data facets.

When you exceed either limit, you must use the Build All command.
(2) You can also use the Generate and Build command (see page 447).
(3) When you make this type of change, the Build command is not available.

EIO0000001114 06/2020 711

Build Stage

712 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Deployment Stage
EIO0000001114 06/2020

Chapter 20
Deployment Stage

Deployment Stage

Overview
This chapter describes how to deploy the built Control and Supervision Participant projects to
entities that exist in the topology of the system.
The following figure shows the position of the Deployment stage within the system engineering life
cycle.

Refer to Deployment Stage (see page 64) for a description of the purpose of this stage.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
20.1 Control Project Deployment Stage 714
20.2 Supervision Project Deployment Stage 773

EIO0000001114 06/2020 713

Deployment Stage

Section 20.1
Control Project Deployment Stage

Control Project Deployment Stage

Overview
This section describes how to use the Topology Explorer to deploy entire built Control Participant
projects or parts of them to physical controllers or to PCs emulating simulators, which are modeled
by engines in the topology of the system.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Control Participant Project Deployment Process 715
Deploying to an Emulated Simulator 720
Communication Between the Computer and Engines 723
Managing Passwords of Control Participant Projects 725
Deploying to Redundant Controllers 733
Deploying the Control Participant Project 736
Re-Deploying the Control Participant Project 743
Deploying Data to Controllers and Station Nodes 750
Deploying Control Project Changes 757
Changes Requiring to Stop the Controller 771

714 EIO0000001114 06/2020

 Deployment Stage

Control Participant Project Deployment Process

Overview
The software allows you to deploy a built Control Participant project (see page 689) to engines by
using the following commands:
 Deploy Built Project
 Re-Deploy Last Project
 Deploy Changes / Undo Online Changes

Deployment Flowchart
The following figure illustrates the different steps that are part of the deployment process of the
built Control Participant project and their associated commands.

1 Or emulated simulator (station node).

EIO0000001114 06/2020 715

Deployment Stage

Prerequisites
The following table describes the actions that are prerequisite for using a command.

Command Actions
Deploy Built Project Build the Control Participant project and configure the corresponding topological
entity.
Re-Deploy Last Project Deploy the built Control Participant project.
Deploy Changes / Undo For Deploy Changes:
Online Changes  Deploy the built Control Participant project.
 Change the logical Control Participant project and build it.

For Undo Online Changes:

 Deploy the built Control Participant project.
 Change the deployed Control Participant project, using the Refine Online
command.
NOTE: Certain changes cannot be deployed (see page 763) by using the Deploy
Changes command.

For the other actions that are required, for example, mapping the Control executable to a controller,
refer to the system engineering life cycle.

Supported Engines for Deployment

The software allows you to deploy/re-deploy a built Control Participant project, and deploy changes
to engines representing:
 A controller
 A redundant controller of the M580 or Quantum platform.
 A computer running software that emulates a simulator (see page 566) (modeled by a station
node in the topology of the system).
Engines need to exist in the topology of the system and be mapped to a Control executable of the
project.

716 EIO0000001114 06/2020

 Deployment Stage

Identifying Engines
The software uses the IP address of each engine to identify it on the Ethernet network.

WARNING
UNINTENDED EQUIPMENT OPERATION
Before deploying to a controller, verify that:
 You have assigned a valid IP address to the controller.
 The IP address corresponds to the physical address printed on the hardware.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: To obtain a list of IP addresses of nodes that are connected to the same physical network
and their corresponding physical address (media access control (MAC) address), use the Address
Resolution Protocol (ARP).
The procedure describes how to use the ARP to obtain a list of IP addresses of nodes connected
to the same physical network and their corresponding physical address (MAC address).

Step Action
1 Write down the MAC address that is printed on the communication module through which you want
to deploy or execute.
2 Connect the computer to the Ethernet network to which this communication module is connected
and through which you want to deploy or execute.
3 On the computer, execute the cmd.exe program.
Result: A command prompt opens.
4 Type arp -a and press Enter.
Result: The local ARP cache table opens.
5 In the table, locate the MAC address matching the one printed on the communication module.
6 In the table, verify that for this address, the corresponding IP address matches the IP address that
you have assigned to the engine in the Control Participant; otherwise proceed to step 7.
7 Assign to the communication module the IP address that you have assigned to the corresponding
engine in the Control Participant and repeat the procedure, starting from step 2.

EIO0000001114 06/2020 717

Deployment Stage

Client/Server Connection
In case of an unexpected stop of the system server, the notification panel of engineering clients
that were connected to the system server before the communication interruption may contain
information about operations that did not complete successfully because of this interruption. It may
also indicate corrective actions.
After an interruption of the client/server connection, the states of both the engineering client and
the system server may have become inconsistent if a deployment operation was in progress.

NOTICE
DATA CORRUPTION
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.
Failure to follow these instructions can result in equipment damage.

NOTE: For more information on client and server behavior in case of a communication interruption,
refer to the topic describing client/server connection (see page 75).

Start/Stop Commands
The software can send a start or stop command to the controller or software emulating a simulator.
Unintended situations can occur if the operations that are in progress are not known when acting
on a controller.

WARNING
UNKNOWN OPERATIONAL STATE OF EQUIPMENT
Before starting or stopping a controller, always positively confirm that there is no critical operation
in progress.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

718 EIO0000001114 06/2020

 Deployment Stage

Generating Symbol Table Files

You cannot generate symbol table files (.xvm) by selecting the saveXVM property in the project
settings of the Control Participant. You need to edit a dedicated configuration file instead before
deploying a Control project.
To generate symbol table files (.xvm) of the Control Participant and retrieve them from the content
repository, proceed as follows.

Step Action
1 Open the ControllerSettings.xml file that is located at the path C:\Program Files\Schneider
Electric\EcoStruxure\Process Expert\System Server on the computer on which the system
server is installed.
2 Set the value for the SaveXVM attribute to 1 and save changes.
Result: When you deploy changes (see page 757) to a Control project or refine it online
(see page 816), the symbol table file is added to the content repository.
3 In the content repository, open the XvmHolder folder located under Systems → <System name>
→ Project → Upro.
4 Save the file (see page 1025).

EIO0000001114 06/2020 719

Deployment Stage

Deploying to an Emulated Simulator

Overview
You can deploy built Control Participant projects to computers for simulation purposes. In the
topology of the software, this computer (engine) is represented by a station node (see page 566)
on which a ControlExpert service is installed.
By default, the simulator is configured to start with a password-protected Control project
(see EcoStruxure™ Process Expert, Installation and Configuration Guide) provided with the
software. You can start the simulator with a different password-protected project file or change the
password (see page 728) of the project that is loaded by default.
NOTE: If your Windows® session is not the one that was used to install the software, you need to
configure the simulator manually (see page 722) to load a password-protected Control project at
startup.

Before Deploying to the Simulator

The table describes the actions you need to perform to be able to proceed with the deployment,
depending on the computer on which the emulated simulator is running.

Computer selected for deployment Actions

Computer on which a software Start the simulator.
component is installed.
(Recommended method)
Other computer on which no 1. Install the simulator.
software component is installed. 2. Start the simulator.
Refer to the topic describing how to install the Controller Simulator.
(see EcoStruxure™ Process Expert, Installation and Configuration
Guide)

Starting the Emulated Simulator

To start the simulator provided with the software, proceed as follows.

Step Action
1 Double-click the shortcut of the controller simulator on the desktop.
Result: The emulated simulator starts minimized as an icon in the notification area. By default
the password-protected Control project (see EcoStruxure™ Process Expert, Installation and
Configuration Guide) is loaded.
NOTE: If you had installed the simulator manually, double-click the sim.exe file located in the
PLC_Simulator folder.

NOTE: For information on using the simulator, refer to the simulator help, which is located in the
PLC_Simulator folder. You can open the help of the simulator also directly from the simulator panel
after starting it.

720 EIO0000001114 06/2020

 Deployment Stage

Starting the Simulator With Another Password-Protected Control Project

You can modify the way the simulator starts and have it load your own password-protected Control
project file (.sta).
Once you have configured the simulator to start by loading your own Control project, you will need
to provide the password to use it (see page 726).
To start the simulator by loading a specific password-protected Control project, proceed as follows.

Step Action
1 Start the simulator.
2 Right-click the simulator icon in the Windows® taskbar and select Options....
Result: The Simulator Panel Options dialog box opens.
3 Select the Use default application to start simulator (enforce security) check box.
4 Click the browse button and select your password-protected Control Expert Control project file (.sta).
5 Click OK.
Result: The simulator stops.
6 Start the simulator.
Result: The simulator starts by loading the selected Control Expert Control project file.

Starting the Simulator Without Password-Protected Control Project

You can modify the startup setting and start the simulator without loading a password-protected
Control project file (.sta). However, modifying this setting is not recommended because it leaves
the Ethernet port of the computer, which is used by the simulator vulnerable to cyber attack.
To start the simulator without loading a password-protected Control project, proceed as follows.

Step Action
1 Start the simulator.
2 Right-click the simulator icon in the Windows® taskbar and select Options....
Result: The Simulator Panel Options dialog box opens.
3 Clear the Use default application to start simulator (enforce security) check box.
4 Click OK.
Result: You do not require to enter a password to use the simulator.
NOTE: When you restart the simulator, it starts without loading a Control project (no
configuration).

EIO0000001114 06/2020 721

Deployment Stage

Starting the Simulator Under Another Windows® session

Once you have configured the simulator to start by loading a password-protected Control project,
you will need to provide the password to use it (see page 726).
To start the simulator by loading the default Control project provided with the software or another
one when you are logged on to a Windows® that is different from the one used to install the
software, proceed as follows.

Step Action
1 Start the simulator.
2 Right-click the simulator icon in the Windows® taskbar and select Options....
Result: The Simulator Panel Options dialog box opens.
3 Select the Use default application to start simulator (enforce security) check box.
4 Click the browse button and select the password-protected Control project file (.sta) that you want to
use. This is either of the following files:
 Simulatorprofile.sta that is provided with the software and that you have copied to the computer.
The file is located in the AFS folder in the root of the installation package of the software.
 Your own Control Expert Control project file.

5 Click OK.
Result: The simulator stops.
6 Start the simulator.
Result: The simulator starts by loading the selected Control project file.

Obtaining the IP Address of the Simulator

If you leave 127.0.0.1 as IP address for the NIC of the station (see page 571) on which the
simulator is running, it automatically defaults to the simulator that is installed on the system server.
To use the simulator that is installed on a computer on which no system server is installed (for
example, an engineering station on which only the engineering client is installed), you need to enter
the actual IP address of the local computer on the subnet (host IP address).
To obtain the host IP address used by the emulated simulator software, proceed as follows.

Step Action
1 Start the software emulating a simulator provided by the software.
2 Double-click the simulator icon in the notification area.
Result: The Controller Simulator Panel is displayed.
3 Read the IP address in the Host IP address field.

Using Deployment Commands With the Simulator

The procedure is similar to using deployment commands with a controller. You need to use the
commands that appear in the context menu of the station node that you have mapped to the
executable of the Control Participant project.
Refer to the description of commands that are documented in this section (see page 714).

722 EIO0000001114 06/2020

 Deployment Stage

Communication Between the Computer and Engines

Controllers
To deploy a built Control Participant project, ensure that the computer that is running the virtual
machine (VM) can communicate through the Ethernet network with the controller or its
communication module, which is modeled by the entity that you want to deploy to.
Depending on the configuration of the software components (see EcoStruxure™ Process Expert,
Installation and Configuration Guide), the computer can be the one on which either software is
installed:
 The system server (if the engineering client is using this VM).
 The engineering client (if it is using its local VM).

For more information on connecting controllers to an Ethernet network, refer to the Control
Participant help.

Station Nodes
To deploy a built Control Participant project, ensure that the computer that is running the system
server can communicate through the Ethernet network with the computer, which is modeled by the
station node that you want to deploy to.

Refreshing Engine Status and Reconnecting Engines

When you use the various deployment and execution commands, a confirmation dialog opens in
which you need to select the IP address of the target engine.
The engine needs to be reachable to be able to proceed with the deployment or execution
command. Once you have selected the IP address, the status of the engine is indicated in the
Status field. If the status of the engine changes while the confirmation dialog box is open, its status
is not refreshed.
This can be the case, for example, if the status of the engine is detected as Not Reachable
because a network cable is unplugged. After you reconnect the cable, the status is unchanged.
Click the reconnect button to refresh the status of the engine and attempt to establish the
connection.

EIO0000001114 06/2020 723

Deployment Stage

The following figure shows an example of deployment confirmation dialog box featuring the
reconnect button.

1 Reconnect button

724 EIO0000001114 06/2020

 Deployment Stage

Managing Passwords of Control Participant Projects

Overview
Using password protection restricts deployment and execution operations for Control Participant
projects that you perform by using an engineering client. It also restricts operations performed by
using the operation client.
This topic describes how you can perform the following actions on controllers and the simulator
running on a station node:
 Setting a password for the first time.
 Changing a password. This includes changing a password for a controller for which a password
was already set by using other applications than the software.
 Clearing a password.
 Resetting the password if you forgot it.

Setting a password is mandatory if you have enabled password protection (see page 161) for
topological entities; otherwise, you cannot deploy Control Participant projects.
NOTE: For information on the default password for the simulator (to be entered in the Current
Password text box when you want to set a password), refer to the topic describing how to install
the controller simulator (see EcoStruxure™ Process Expert, Installation and Configuration Guide).
NOTE: Deploying a Control Participant project after setting or changing the password takes slightly
longer than deploying with an existing or without password.

Scope of the Password Protection

The password that you can set by using the commands in the context menu of the topological entity
corresponds to the Application password of the Control Participant. The corresponding settings are
disabled in the Control Participant (Protection tab of the properties of the project).
NOTE: Other passwords that are managed by the Control Participant are not supported.
The table describes which Control projects managed by the software benefit of the password
protection.

Control Participant project Password protection applies

Logical Control project No
Built Control project No
Deployed Control project Yes

EIO0000001114 06/2020 725

Deployment Stage

Actions That Require Providing the Password

The table outlines the various actions for which you need to provide a password if password
protection is enabled for the controller or simulator running on a station node.

Topological Action Password that is required

entity
Station Setting the password. The password that is used in the Control project file
node/simulator (.sta) that is loaded when the simulator starts.
only By default, this is the Control project file that is
provided with the software (see EcoStruxure™
Process Expert, Installation and Configuration
Guide).
NOTE: The simulator may have been configured
(see page 721) to load another Control project file
when starting or the password may have been
changed (see page 728).
First deployment. You need to set a password first.
Subsequent deployment and No password required as long as you keep the
execution operations. engineering client open.
If you close the engineering client or lock it and
another user logs in, the password that you have set
is required.
Controller only Setting the password. No password is required.
If a password is already set for the controller (for
example, by using an application other than the
software), the current password is required to be able
to set a new one.
NOTE: Setting the password when no Control
Participant project is deployed to the controller
requires stopping the controller.
First deployment. You need to set a password first.
Any deployment and execution The current password.
operation after setting or changing
the password.
Subsequent deployment and No password required as long as you keep the
execution operations. engineering client open.
If you close the engineering client or lock it and
another user logs in, the current password is
required.
Navigating to a section by using The current password.
Runtime Navigation Services If you close the operation client or lock it and another
(operation client). user logs in, the current password is required again.
Resetting the password if you have The temporary password provided by
forgotten it. Schneider Electric support.

726 EIO0000001114 06/2020

 Deployment Stage

Topological Action Password that is required

entity
Controller or Changing the password. The password that is currently set.
station
Clearing the password. The password that is currently set.
node/simulator
Using the Re-Deploy last Project The password that is currently set.
command.
NOTE: If before redeploying the initial project
(protected with password A), another project that is
protected with password B and belonging to a
different system has been deployed from a different
client to the same engine, during re-deployment of
the initial project, you need to enter password B. The
deployment operation performed from a different
system and client has changed the password that
had been set during the initial deployment
(password A).
Using the Back Up Data command The password that is currently set.
for the first time after deploying a
Control project.
Any deployment and execution The password that is currently set.
operations after importing the If no password is set yet, you need to set one (or, for
controller or station node. a station node, provide the password that is used in
the Control project file (.sta) that is loaded when the
Any deployment and execution
simulator starts).
operations after restoring a system
containing the controller or station
node.
Any deployment and execution
operations after restoring a
database containing a system with
the controller or station node.
Recovering from a signature The password that is currently set.
mismatch.
Disabling the Security Password The password that is currently set.
property when a Control Participant
NOTE: Disabling the Security Password property
project was deployed while the
opens the Disable Password Protection dialog box.
setting was enabled.
This also clears the password.

Password Requirements
Your password must contain between 8 and 16 alphanumeric characters.
It can contain lower and upper case as well as special characters.
NOTE: Password strength is increased when it contains a mix of upper and lower case,
alphabetical, numerical, and special characters.

EIO0000001114 06/2020 727

Deployment Stage

Managing Application Passwords with Redundant Controllers

The following are the specific password management rules that apply to redundant controllers:
 Both primary and standby engines of the topological entity must be reachable by using the IP
addresses that you have configured and the Hot Standby cable link must be present.
 The same application password is set for the Control project of both engines. Changing or
clearing the password also applies to both engines.
 When the ControllerExist property (see page 733) of a redundant controller is set to Primary,
passwords are managed the same way as for a standalone controller.
The following describes the operating mode for redundant controllers when a password mismatch
occurs:
 If setting, changing, or clearing the password for the Control project of the standby controller did
not succeed, you need to synchronize it by using the Sync (Primary→Standby) command. You
can still proceed with the deployment to the primary controller.
 When you are prompted to provide the password for security purposes, the password is
compared with that of the Control project in both engines. If the password of the project in the
standby engine does not match, you cannot perform the operation on the standby engine.

Setting the Application Password of a Control Project

The following are prerequisites to be able to set the application password for a Control project:
 You have created a topological entity of type controller or station node.
 The topological entity is configured:
 For a controller: You have used the Configure command and saved changes.
 For a station node: You have created the ControlExpert service.

 The Security Password property of the topological entity is enabled.

 The engine of the topological entity must be reachable by using the IP address that you have
configured. In case of the simulator, it must be running.
You can set a password even if you have already deployed a Control project while the password
protection for the topological entity was disabled. The password is set for the already deployed
Control project without stopping the controller.
NOTE: You can use this functionality also to change the password of the Control project that is
loaded when you start the simulator.

728 EIO0000001114 06/2020

 Deployment Stage

The following figure shows the Manage Password dialog box for the simulator running on a station
node.

1 Check box that lets you also change the password (see page 732) of the Control project that is
loaded when you start the simulator.
To set the application password for a Control project, proceed as follows.

Step Action
1 Right-click the topological entity and select:
 For a controller: Manage Password
 For a station node (simulator): Control → Manage Password

Result: The Manage Password dialog box opens.

2 Enter the current password in the Current Password text box if required (see page 726).
3 Enter the new password and confirm the new password in the corresponding text boxes.
4 If you want to use this password also in the Control project that is loaded when the simulator
starts, select the check box. It replaces the password that is currently used in this Control project
file.
5 Click OK.
Result: The password is saved and set as application password.

EIO0000001114 06/2020 729

Deployment Stage

Verifying the Password to Perform Deployment and Execution Tasks

When you select a command and are prompted to enter the password that is set for a controller or
simulator running on a station node, proceed as follows.

Step Action
1 In the Verify Password dialog box, enter the required password.
NOTE: Alternatively, you can select the Use last entered password check box. It fills the text
box with the last password that you have entered in a Verify Password dialog box during the
current engineering client session. The text box becomes read-only.
2 Click OK.
Result: If the password is correct, the command is executed. If not, an information message is
displayed, prompting you to reenter the password. You can enter the password three times
before the command is canceled.
NOTE: Click Cancel to cancel the command you had selected.

Changing the Application Password of a Control Project

To be able to change the password, the engine of the topological entity must be reachable by using
the IP address that you have configured.
To change the application password for a Control project, proceed as follows.

Step Action
1 Right-click the topological entity and select:
 For a controller: Manage Password
 For a station node (simulator): Control → Manage Password

Result: The Manage Password dialog box opens.

2 Enter the current password in the Current Password text box.
3 Enter the new password and confirm the new password in the corresponding text boxes.
4 If you want to use this password also in the Control project that is loaded when the simulator
starts, select the check box (see page 728). It replaces the password that is currently used in
this Control project file.
5 Click OK.
Result: The password is saved and set as application password.

730 EIO0000001114 06/2020

 Deployment Stage

Clearing the Application Password of a Control Project

To be able to clear the application password, the engine of the topological entity must be reachable
by using the IP address that you have configured.
NOTE: Clearing the application password does not clear the password of the Control project that
is loaded when the simulator starts.
To clear the application password for a Control project, proceed as follows.

Step Action
1 Right-click the topological entity and select:
 For a controller: Clear Password
 For a station node (simulator): Control → Clear Password

Result: The Clear Password dialog box opens.

2 Enter the current password in the Current Password text box.
3 Click OK.
Result: The password is cleared.

Resetting a Forgotten Password

To reset the application password of a Control project, proceed as follows.

Step Action
1 Right-click the topological entity and select Forgot Password.
Result: The Forgot Password dialog box opens and a number is displayed in the Authentication
Code field.
NOTE: If you close the Forgot Password dialog box and open it again, the same number is
displayed.
2 Contact Schneider Electric support (see page 117) and provide the number.
Result: You receive a temporary password.
NOTE: You can reuse the temporary password as long as you do not modify the application
that is deployed to the controller.
3 Right-click the topological entity and select Manage Password.
Result: The Manage Password dialog box opens.
4 Follow the procedure to change the password (see page 730) and enter the temporary
password in the Current Password text box.

EIO0000001114 06/2020 731

Deployment Stage

Changing the Password of the Control Project Loaded at Simulator Start-Up

You can change the password of the default Control project file or your own file (see page 721) that
is loaded when the simulator starts if the functionality is enabled.
The folder containing the project file must not be write-protected.
The table indicates from where you can change the password of the Control project file depending
on the location of the controller simulator.

Computer on which the Software component on which you need to perform the password change
controller simulator is running
System server computer. Any engineering client.
The IP address of the NIC of the station node in the Topology Explorer
must correspond to the system server computer.
Engineering client computer. The local engineering client.
Operation client computer. 1. Copy the project file loaded in the controller simulator to the local
Other computer on which the engineering client computer (if the project file loaded in both simulators
is different; otherwise, proceed to step 3).
controller simulator was installed
2. Configure the simulator (see page 721) on the local engineering client
manually.
computer to load this project file at start-up.
3. Change the password of the project file by using the local engineering
client.
4. Replace the project file on the operation client or the other computer.

To change the password of the Control project file that is loaded when the simulator starts, proceed
as follows.

Step Action
1 Start the controller simulator or restart it.
2 Right-click the station node that represents the computer on which the controller simulator is
running and select Control → Manage Password.
Result: The Manage Password dialog box opens.
3 In the Current Password text box, enter the password of the Control project file that is loaded when
the simulator starts.
4 Enter the new password and confirm the new password in the corresponding text boxes.
5 Select the check box (see page 728).
6 Click OK.
Result: The password is changed in Control project file.

732 EIO0000001114 06/2020

 Deployment Stage

Deploying to Redundant Controllers

Overview
This topic describes aspects that are specific to the deployment of Control Participant projects to
redundant controllers, which are modeled in the topology of the system.
The same commands that are used on standalone configurations are also used for redundant
controllers.
Detailed information on the commands that are available as part of the deployment stage are
described later in the chapter.
For a description of the sequence of actions that Control performs on the engines, refer to the topic
describing main redundant controller scenarios (see page 833).

ControllerExist Property
Verify that the value of the ControllerExist property (see page 558) that is selected in the properties
of the redundant controller entity matches the physical configuration of the hardware.
If the software detects a mismatch, you cannot proceed with the deployment.
NOTE: Selecting PrimaryAndStandby for the ControllerExist property requires that both controllers
are reachable and connected by a Hot Standby cable link.
NOTE: The value of the property also affects execution commands (see page 788).

Engine Status for Redundant Controllers

When you select a command for a redundant controller, composed of one primary and one standby
engine to which IP addresses IP and IP + 1 are assigned respectively, before proceeding with
the deployment, the software opens various dialog boxes, depending on the command that you
have selected.
Each of these dialog boxes features the Status field, which informs you of the current state of each
of the engine roles (A and B) that the software has detected.

States for M580 platform controllers States for Quantum platform controllers
Run Primary Run Primary
Run Standby Run Standby
Wait Run Offline
Stop Stop Offline
No conf (non-configured state) No conf (non-configured state)

NOTE: If you have selected Primary for the ControllerExist property of the controller entity, the
status of the standby engine is not available.

EIO0000001114 06/2020 733

Deployment Stage

General Deployment Behavior for Redundant Controllers

When you deploy to a redundant controller:
 The software deploys to both the primary and the standby engines unless you have selected
Primary for the ControllerExist property of the controller entity. You can view and/or select the
IP address for the primary engine (IP) and the software automatically selects IP address
IP + 1 as the standby engine.
 If you select to start the engines after deployment, both engines are started.

If deployment to the first engine (IP or IP + 1, depending on the status of the engine
(see page 833)) does not complete successfully, the entire deployment process is canceled.
If deployment to the second engine (IP or IP + 1, depending on the status of the engine) or if
synchronization does not complete successfully, logic that was deployed successfully to the first
engine is preserved.
NOTE: For controllers of the M580 platform, you cannot perform deployment tasks on the CPU
module or a NOC communication module by using IP address A and IP address B. You can
only select main IP address (see page 759).

Redundant Controller Stop Sequence

When deployment requires to stop the controller and both engines are running, the software stops
in the following order:
 The standby engine
 The primary engine

734 EIO0000001114 06/2020

 Deployment Stage

Deploying Changes to Redundant Controllers

If the primary controller is in Running Primary state, and you deploy changes that do not require
stopping the controller by using the Deploy Changes / Undo Online Changes command
(see page 757):
 The software enables the configuration mismatch feature of the controller so that the standby
controller does not enter the offline operating mode when changes are deployed to the primary
controller.
 The software deploys to the primary controller first, and upon successful completion of the
deployment, automatically synchronizes the standby controller.
 Then, the software disables the configuration mismatch feature.

When you deploy changes to a redundant controller, although deployment to the primary controller
succeeded, it is possible that synchronization of the standby controller (see page 836) does not
complete. If an interruption of the connection to the system server or an unexpected stop of the
system server is the cause, the notification panel also contains additional information about steps
that you must complete when the connection to the system server is re-established. This is the
case, for example, when the software cannot disable the configuration mismatch feature. If this
feature is enabled and a switchover occurs, the standby controller operates with a program that
does not contain the changes that you have deployed to the primary controller.

WARNING
UNINTENDED EQUIPMENT OPERATION
 Verify that deployment to the standby controller completed successfully.
 Do not operate the primary controller if deployment to the standby controller does not complete
successfully.
 Synchronize the standby controller manually, using the Sync (Primary→Standby) command
and verify that the synchronization completed successfully.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: If the primary controller is not in Running Primary state, synchronization of the standby
controller cannot complete successfully. In such case, starting (see page 796) the primary engine
synchronizes the standby engine.

EIO0000001114 06/2020 735

Deployment Stage

Deploying the Control Participant Project

Overview
The Topology Explorer allows you to deploy the complete Control Participant project to a controller
or station node that is modeled by an engine in the topology of the system by using the following
commands:
 Deploy Built Project: Deploys the built Control Participant project to the controller/station node
that is mapped to the corresponding executable (see page 628).
 Re-Deploy Last Project: Deploys the same built Control Participant project that you have
deployed to the controller/station node last. This is done by using a mirror of the deployed
Participant project, called the last deployed reference, which is stored in the contents repository
(see page 1021).
To deploy or redeploy a built Participant project, the controller or the emulated simulator that you
are deploying to must be in Stop state before proceeding. If it is not, the software informs you of it,
and stops the engine when you proceed with the deployment.
Also, the software gives you the option to start the controller following the deployment.

Built Participant Project Build Status

The software lets you deploy a built Control Participant project whose executable is either marked
as being out of date or that you have not built again after making changes to the system
(see page 696), which affect the built Participant project.
The software displays a message in the confirmation dialog boxes of deployment commands if the
Build State (see page 695) of the associated executable is Out Of Date.

Selecting Participant Project and Control Executable

When you select the Deploy Built Project command for an engine, the software displays the Deploy
Built Project dialog box, which allows you to select:
 Project: Any Control project that exists in the system and:
 Whose Controller family (see page 305) property has the same value as the engine.
 Contains a built or out of date executable that is mapped to the engine.

 Executable: For each project, any Control executable (see page 625) that is mapped to the
engine (see page 628).
NOTE: When you select Deploy Built Project from a station node, you can select any Control
project that has a Control executable that is mapped to this station node.

Deploying to a Redundant Controller

For information that applies specifically to the deployment to redundant controllers, refer to the
related topic (see page 733).

736 EIO0000001114 06/2020

 Deployment Stage

Control Participant Project Information

Before proceeding with the deployment or redeployment of a built Participant project, the software
displays information in the Confirm Deploy Built Project dialog box about:
 The engine that you are deploying to.
 The built Participant project to be deployed.
 The Participant project deployed last to the engine.

EIO0000001114 06/2020 737

Deployment Stage

The figure shows an example of the Confirm Deploy Built Project dialog box for a redundant
controller.

The table describes the information that is displayed in the Engine Information section of the
Confirm Deploy Built Project dialog box.

Label Description
Role(1) Role of the engine: A or B.
If the software cannot communicate with the engine, the role is indicated as Not Detected.
Status Status of the engine that is selected for deployment.
If the status is Not Reachable you cannot proceed with the deployment. In such case, verify the
IP address, the connection to the engine, and the status of the engine.
NOTE: If the status is Running, a notification is displayed in the dialog box to inform you that
the engine will be stopped if you proceed with the deployment.
IP Address Identifier of the communication module through which the software will deploy the built
Participant project and its IP address that is configured in the Topology Explorer.
If the topological entity has several communication modules, you can select which one you want
to deploy to.
NOTE: For controllers of the M580 platform, you cannot deploy to the CPU module or a NOC
communication module by using IP address A. You can only select main IP address
(see page 759).
(1) Displayed only when you deploy a built Participant project to a redundant controller.

NOTE: To refresh the engine status and attempt to connect to it, click the reconnect button
(see page 723).

738 EIO0000001114 06/2020

 Deployment Stage

The table describes the information that is displayed in the Project Information section of the
Confirm Deploy Built Project dialog box. It also describes the check box.

Name column Selected Project column Last Deployed Project column(2)

System Identifier of the system that both the engine and Identifier of the system that both the engine and
the Control project, which you have selected the Control project, from which you have
belong to. deployed the Participant project last belong to.
Project Identifier of the Control Participant project that Identifier of the Control Participant project
you have selected. associated to the executable that you have
deployed last.
Executable Identifier of the Control executable that you have Identifier of the Control executable that contains
selected and that contains the built Participant the built Participant project that you have
project to be deployed. deployed last.
Controller Identifier of the topological entity to which you Identifier of the topological entity to which you
are deploying the built Participant project. have deployed the built Participant project last.
Last Built On Date and time when you successfully built the Date and time when you successfully built the
Control Participant project to be deployed. Control Participant project that you have
deployed last.
Last Deployed Not applicable Date and time when you last deployed the
On Participant project to the engine or you last
completed the Deploy Changes / Undo Online
Changes command, independently if there were
changes to be deployed or not.
Last Online Not applicable Date and time when you last changed the
Change deployed Participant project by using the Refine
Performed On Online command; otherwise the field is empty.
Last Sync. Not applicable Date and time when you last synchronized the
Performed On(1) standby controller with the primary one by using
the Synchronize (Primary→Standby)
command.
Start engine after Select the option if you want to start the controller or emulated simulator when deployment is
deployment complete; otherwise the engine remains in stop state.
NOTE: The software stops the engine before proceeding with the deployment if the engine is not
yet in stop state.
(1) Displayed only when you deploy a built Participant project to a redundant controller.
(2) When you deploy to a redundant controller, the dialog box shows separate columns for the primary and the
standby engine.

NOTE: When you deploy for the first time to an engine, the fields of the Last Deployed Project
section are empty.

EIO0000001114 06/2020 739

Deployment Stage

Deploying the Control Participant Project

WARNING
UNINTENDED EQUIPMENT OPERATION
Before deploying to a controller, verify that:
 You have assigned a valid IP address to the controller.
 The IP address corresponds to the physical address printed on the hardware.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For more information, refer to Identifying Engines (see page 717).

WARNING
UNINTENDED EQUIPMENT OPERATION
Before deploying to an engine, verify that you have selected the correct project files.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

Unintended situations can occur if the operations that are in progress are not known when acting
on a controller.

WARNING
UNKNOWN OPERATIONAL STATE OF EQUIPMENT
Before starting or stopping a controller, always positively confirm that there is no critical operation
in progress.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

740 EIO0000001114 06/2020

 Deployment Stage

When deploying to a redundant controller, deployment to the standby controller (see page 836)
may not complete successfully. In such case, the software displays a message in the notification
panel to inform you.

WARNING
UNINTENDED EQUIPMENT OPERATION
 Verify that deployment to the standby controller completed successfully.
 Do not operate the primary controller if deployment to the standby controller does not complete
successfully.
 Synchronize the standby controller manually, using the Sync (Primary→Standby) command
and verify that the synchronization completed successfully.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For information on the Sync (Primary→Standby) command, refer to the Execution stage
(see page 788).
To deploy the Control Participant project, proceed as follows.

Step Action
1 Verify that the engine can communicate with the PC (see page 723) and that it is in Stopped
state.
When deploying to a station node, verify that the software emulating the simulator is running
(see page 720).
2 In the Topology Explorer, right-click the entity to which you want to deploy the built Participant
project and select Deploy Built Project.
Result: The software displays the Deploy Built Project dialog box.
3 Click the menu next to Project and select the Control project.
4 Click the menu next to Executable and select the executable associated to the built Control
project that you want to deploy.
5 Click OK.
Result: The software displays the Confirm Deploy Built Project dialog box.
NOTE: Click Cancel to close the dialog box without deploying.
6 Verify the information that is displayed.
7 Verify the status of the engine in the Status field.
8 Verify the communication module identification or select one in the IP Address field.
9 Select Start engine after deployment if you want the software to start the engine after the
deployment is complete.
10 Click OK.
Result: The software displays the Reconfirm Deploy Built Project dialog box.
NOTE: Click Cancel to close the Confirm Deploy Built Project dialog box without deploying.

EIO0000001114 06/2020 741

Deployment Stage

Step Action
11 Click OK.
Result: The software:
 Stops the engine if it is running.
 Deploys the Control Participant project.
 Displays Completed in the notification panel once it has successfully completed the
deployment process to the engine, which is identified by its IP address.
 For a redundant controller, the notification panel displays separate messages for the
primary and the standby engines by using their respective IP address to identify them. If
deployment to either engine does not complete successfully, the software displays a
corresponding message in the notification panel.
 Updates the related date/time field.
 Starts the controller (cold start) or software emulating a simulator if you selected the option.

NOTE: Click Cancel to close the Reconfirm Deploy Built Project dialog box without deploying.
This reverts to the Confirm Deploy Built Project dialog box.

NOTE: If the deployment process does not complete successfully and the software has stopped
the engine before deploying the Participant project, the engine remains in Stopped state.

742 EIO0000001114 06/2020

 Deployment Stage

Re-Deploying the Control Participant Project

Overview
The Re-Deploy Last Project command for an engine becomes available once you have deployed
a project to this engine.
The process of redeploying the Control Participant project is identical to the deployment process
(see page 743) with the exception that you cannot select a Control project and an associated
Control executable for deployment. The software deploys to the controller or station node
emulating a simulator a mirror image of the last deployed Participant project, which is the last
deployed reference.
To redeploy a built Participant project, the engine that you are deploying to, must be in Stopped
state before proceeding. If it is not, the software informs you of it, and stops the engine when you
proceed with the deployment.
NOTE: If you made changes to the deployed Participant project using the Refine Online and/or if
you have deployed changes using the Deploy Changes commands, then the Participant project
that the software redeploys to the controller contains these changes.

Redeploying to a Redundant Controller

For information that applies specifically to the redeployment to redundant controllers, refer to the
topic describing deployment to redundant controllers (see page 733).

EIO0000001114 06/2020 743

Deployment Stage

Control Participant Project Information

Before proceeding with the re-deployment of the last deployed reference, the software displays
information in the Confirm Re-Deploy Last Project dialog box about:
 The engine that you are re-deploying to.
 The project to be re-deployed.
 The Participant project deployed last to the engine.

744 EIO0000001114 06/2020

 Deployment Stage

The figure shows an example of the Confirm Re-Deploy Last Project dialog box for a redundant
controller.

The table describes the information that is displayed in the Engine Information section of the
Confirm Re-Deploy Last Project dialog box.

Label Description
Role (1) Role of the engine: A or B.
If the software cannot communicate with the engine, the role is indicated as Not Detected.
Status Status of the engine that is selected for deployment.
If the status is Not Reachable you cannot proceed with the deployment. In such case, verify the IP
address, the connection to the engine, and the status of the engine.
NOTE: If the status is Running, a notification is displayed in the dialog box to inform you that the
engine will be stopped if you proceed with the deployment.
IP Identifier of the communication module through which the software will deploy the built Participant
Address project and its IP address that is configured in the Topology Explorer.
If the topological entity has several communication modules, you can select which one you want to
deploy to.
NOTE: For controllers of the M580 platform, you cannot redeploy to the CPU module or a NOC
communication module by using IP address A. You can only select main IP address
(see page 759).
(1) Displayed only when you redeploy a built Participant project to a redundant controller.

NOTE: To refresh the engine status and attempt to connect to it, click the reconnect button
(see page 723).

EIO0000001114 06/2020 745

Deployment Stage

The table describes the information that is displayed in the Project Information section of the
Confirm Re-Deploy Built Project dialog box. It also describes the check box.

Name column Selected Project column Last Deployed Project column(2)

System(1) Identifier of the system that both the engine and the Control project, which you have selected
belong to.

Project(1) Identifier of the Control Project that you have selected.

Executable(1) Identifier of the Control executable that you have selected and that contains the built Participant
project to be deployed.

Controller(1) Identifier of the controller/station node to which you are deploying the built Participant project.
Last Built On Date and time when you successfully built the Date and time when you successfully built the
Control Participant project to be deployed. Control Participant project that you have
deployed last.
Last Deployed Not applicable Date and time when you last deployed the
On Participant project to the engine or you last
completed the Deploy Changes / Undo Online
Changes command, independently if there were
changes to be deployed or not.
Last Online Not applicable Date and time when you last changed the
Change deployed Participant project by using the Refine
Performed On Online command; otherwise the field is empty.
Last Sync. Date and time when you last synchronized the standby controller with the primary one by using the
Performed On(3) Synchronize (Primary→Standby) command.
Start engine Select the option if you want to start the engine when deployment is complete; otherwise the engine
after deployment remains in stop state.
NOTE: The software stops the engine before proceeding with the deployment if the engine is not
yet in stop state.
(1) The values of the Selected Project and Last Deployed Project fields are identical.
(2) When you redeploy to a redundant controller, the dialog box shows separate columns for the primary and the
standby engines.
(3) Displayed only when you redeploy to a redundant controller.

746 EIO0000001114 06/2020

 Deployment Stage

Re-Deploying the Last Deployed Reference

WARNING
UNINTENDED EQUIPMENT OPERATION
Before deploying to a controller, verify that:
 You have assigned a valid IP address to the controller.
 The IP address corresponds to the physical address printed on the hardware.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For more information, refer to Identifying Engines (see page 717).

WARNING
UNINTENDED EQUIPMENT OPERATION
Before deploying to an engine, verify that you have selected the correct project files.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

Unintended situations can occur if the operations that are in progress are not known when acting
on a controller.

WARNING
UNKNOWN OPERATIONAL STATE OF EQUIPMENT
Before starting or stopping a controller, always positively confirm that there is no critical operation
in progress.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000001114 06/2020 747

Deployment Stage

When redeploying to a redundant controller, re-deployment to the standby controller

(see page 836) may not complete successfully. In such case, the software displays a message in
the notification panel to inform you.

WARNING
UNINTENDED EQUIPMENT OPERATION
 Verify that deployment to the standby controller completed successfully.
 Do not operate the primary controller if deployment to the standby controller does not complete
successfully.
 Synchronize the standby controller manually, using the Sync (Primary→Standby) command
and verify that the synchronization completed successfully.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For information on the Sync (Primary→Standby) command, refer to the Execution stage
(see page 788).
To redeploy the last deployed reference, proceed as follows.

Step Action
1 Verify that the engine can communicate with the PC (see page 723) and that it is in Stopped
state.
When redeploying to a station node, verify that the software emulating the simulator is running
(see page 720).
2 In the Topology Explorer, right-click the entity to which you want to deploy the built Participant
project and select Re-Deploy Last Project.
Result: The software displays the Confirm Re-Deploy Last Project dialog box.
3 Verify the information that is displayed.
4 Verify the status of the engine in the Status field.
5 Select Start engine after deployment if you want the software to start the engine after the
redeployment is complete.
6 Click OK.
The software displays the Reconfirm Re-Deploy Last Project dialog box.
NOTE: Click Cancel to close the Confirm Re-Deploy Last Project dialog box without
redeploying.

748 EIO0000001114 06/2020

 Deployment Stage

Step Action
7 Click OK.
Result: The software:
 Redeploys the last deployed reference to the engine.
 Displays Complete in the notification panel once it has successfully completed the re-
deployment process to the engine, which is identified by its IP address.
 For a redundant controller, the notification panel displays separate messages for the
primary and the standby engines by using their respective IP address to identify them. If
redeployment to either engine does not complete successfully, the software displays a
corresponding message in the notification panel.
 Updates the related date/time field.
 Starts the controller (cold start) or software emulating a simulator if you selected the option.

NOTE: Click Cancel to close the Reconfirm Re-Deploy Last Project dialog box without re-
deploying. This reverts to the Confirm Re-Deploy Last Project dialog box.

NOTE: If the redeployment process does not complete successfully and the software has stopped
the engine before redeploying the Participant project, the engine remains in Stopped state.

EIO0000001114 06/2020 749

Deployment Stage

Deploying Data to Controllers and Station Nodes

Overview
The Deploy Data command lets you deploy data contained in a backup file (see page 823) that has
been created by using the Back Up Data command.
You can select one file from a list of backup files that have been created for all executables of the
same Control Participant project. The selection dialog shows the information that was associated
to each backup file at the time of creation, including the type of data that was selected.
By default, backup files are listed in descending order of time stamp (most recent one on top).
NOTE: For more information, refer to Save/Restore Data Between a File and the PLC in the help
of the Control Participant (see page 104).

Deploying Data to Redundant Controllers

For redundant controllers, deployment of data is possible only to the primary controller.
To be able to deploy data to the primary controller, the standby controller must be reachable at the
IP address that is configured. It may not be reachable, for example, because it is switched off or
the Hot Standby cable is removed.
Only if the ControllerExist property (see page 558) is set to Primary you can deploy data to the
primary controller while the standby controller is not reachable.
NOTE: The status of the standby controller is not shown in the Confirm Deploy Data dialog box.

Data Backup File Information

Before proceeding with the deployment of controller data, the software displays information in the
Confirm Deploy Data dialog box about:
 The deployed Control Participant project.
 The executable that is deployed.
 Executables of this Control project for which a backup file exists.
 The type of data contained in each backup file.
 The backup file identification.

NOTE: If you change the identifier of a controller or executable, or the role of a controller, the
identification information of the corresponding backup file is not modified.
You can sort and filter (see page 138) the information that is displayed.

750 EIO0000001114 06/2020

 Deployment Stage

The following figure shows an example of the Confirm Deploy Data dialog box for a standalone
controller.

The following figure shows an example of the Confirm Deploy Data dialog box for a redundant
controller.

EIO0000001114 06/2020 751

Deployment Stage

The table describes the information that is displayed in the Engine Information section of the
Deploy Data dialog box.

Label Description

Controller(1) You can deploy controller data only to the primary controller.
Default value: Primary

Role(1) Role of the engine: A or B.

If the software cannot communicate with the engine, the role is indicated as Not Detected.
Status Status of the engine that is selected for deployment of data.
If the status is Not Reachable, you cannot proceed with the deployment. In such case, verify
the IP address, the connection to the engine, and the status of the engine.
IP Address Identifier of the communication module through which the software will deploy data and its IP
address that is configured in the Topology Explorer.
If the topological entity has several communication modules, you can select which one you
want to use.
Default value: IP address that was selected for the last deployment operation to this engine.
NOTE: For controllers of the M580 platform, you cannot deploy data to the CPU module or
through a NOC communication module by using IP address A. You can only select
main IP address (see page 759).
(1) Displayed only when you deploy data to a redundant controller.

NOTE: To refresh the engine status and attempt to connect to it, click the reconnect button
(see page 723).
The table describes the information that is displayed in the Project Information section of the
Deploy Data dialog box.

Label Description
Control Project Identifier of the Control Participant project associated to the executable that you have
deployed last.
Executable Identifier of the Control executable to which you are deploying data.
Last Deployed Date and time when you last deployed the Participant project to the engine or you last
On completed the Deploy Changes / Undo Online Changes command, independently if there
were changes to be deployed or not.

752 EIO0000001114 06/2020

 Deployment Stage

The table describes the information that is displayed in the Select Backup Data section of the
Confirm Deploy Data dialog box.

Column Description
header
Time Stamp Date and time of the backup file creation.
Description Description that was entered when the backup file was created.
User Name of the user who was logged on when the backup file was created.
Executable Identifier of the Control executable whose data is contained in the backup file.
Controller Identifier of the controller that was running the executable whose data was backed up.
For redundant controllers, it also indicates the role of the controller that was selected when
the backup file was created.
%M Indicates the memory range of located variables of boolean data type that are contained in
the backup file.
If no such data was selected during data backup, the value shown is N/A.
%MW Indicates the memory range of located variables of WORD data type that are contained in
the backup file.
If no such data was selected during data backup, the value shown is N/A.
Unlocated True indicates that this type of data was selected during data backup.
Variables Possible values:
Unlocated FBs  True
 False

Control Project Signature Verification

Before executing the command, the software compares the Control Participant project that is
deployed in the engine with the last deployed reference (see page 715), which is the Control
Participant project residing in the software.
If they are identical, the command is executed. If they differ, the software starts a recovery process
first. This process may take several minutes to complete.
In case the software displays a notification about a signature mismatch, the command cannot be
executed. Contact Schneider Electric support (see page 117).

EIO0000001114 06/2020 753

Deployment Stage

Deployed Data Conflicts

Before proceeding with the deployment of data contained in the selected backup file, the software
opens a dialog box in case it detects any conflicts in the data to be deployed. It displays the data
instances that cannot be deployed.
You have the choice to proceed with the deployment but without the conflicting data instances or
to cancel the deployment operation entirely.
The following figure shows an example of the Deploy Data Conflicts dialog box.

754 EIO0000001114 06/2020

 Deployment Stage

Deploying Data Contained in a Backup File

Unintended situations can occur if the operations that are in progress are not known when acting
on a controller.
Deploying data when the controller is in RUN state may take several scan cycles and corrupt the
program data. This adversely affects the execution of the program.
Further, deploying data to the controller may change program data. This affects the execution of
the program when the controller is in STOP state and then switched to RUN state after the
deployment.

WARNING
UNINTENDED EQUIPMENT OPERATION
Before deploying data to the controller:
 Verify that the controller state does not jeopardize data integrity when the data is deployed.
 Verify the impact of the deployment on the execution of the program.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: Schneider Electric recommends deploying data while the controller is in STOP state.

EIO0000001114 06/2020 755

Deployment Stage

To deploy data contained in a backup file to a controller or station node, proceed as follows.

Step Action
1 Verify that the engine can communicate with the PC (see page 723).
When deploying to a station node, verify that the software emulating the simulator is running
(see page 720).
2 In the Topology Explorer, right-click the entity to which you want to deploy data and select Deploy
Data.
Result: The software opens the Confirm Deploy Data dialog box.
3 In the IP Address field, verify that the communication module identification is correct.
4 Verify the status of the engine in the Status field.
NOTE: Deployment is possible only if the state of the engine is indicated as either RUN, STOP
(recommended), or WAIT (OFFLINE for Hot Standby controllers of the Quantum platform).
5 Verify the information that is displayed in the Project Information section.
6 Select a backup file.
7 Click OK.
Result: The Reconfirm Deploy Data dialog box opens.
NOTE: Click Cancel to close the Confirm Deploy Data dialog box without deploying data.
8 Click OK.
Result:
 If the software detects conflicts in the data to be deployed, it opens the Deploy Data Conflicts
dialog box (see page 754), which lets you proceed with the deployment (Yes) or cancel it (No).
 If you select to proceed, the software deploys the data and provides information about the
deployment operation in the notification panel (or in a dialog box in case deployment did not
succeed).
NOTE: Click Cancel to close the Reconfirm Deploy Data dialog box without deploying data.

756 EIO0000001114 06/2020

 Deployment Stage

Deploying Control Project Changes

Overview
Following a deployment, the Deploy Changes / Undo Online Changes command allows you to
deploy to an engine changes that you have made to the logical Control Participant project that
corresponds to the built Participant project that you had deployed to the same engine last.
You can deploy changes pertaining to the following categories:
 Animation tables
 Operator screens
 Sections
 Types
 Variables

To deploy other changes, refer to Changes that Cannot be Deployed (see page 763).
When you select the Deploy changes / Undo Online Changes command, the software compares
the deployed Participant project that is currently loaded in the engine with the corresponding built
Participant project and identifies:
 Changes that you can deploy without stopping the engine.
 Changes that require stopping the engine (see page 771). The software displays a dialog box
informing you that an engine stop is required in order to deploy such changes.
You can select, which of the identified changes you want to deploy.
The software gives you the option to proceed with a cold start of the engine following the
deployment of changes that require stopping the engine.
NOTE:
 You can use the Deploy changes / Undo Online Changes command to discard changes that you
made to the deployed Participant project.
 Build the Participant project to which you have made changes (see page 696) in order to deploy
these changes using the Deploy changes / Undo Online Changes command.
 You cannot view the result of the deployment of changes before the deployment is actually
completed.

Control Project Signature Verification

Before executing the command, the software compares the Control Participant project that is
deployed in the engine with the last deployed reference (see page 715), which is the Control
Participant project residing in the software.
If they are identical, the command is executed. If they differ, the software starts a recovery process
first. This process may take several minutes to complete.
In case the software displays a notification about a signature mismatch, the command cannot be
executed. Contact EcoStruxure Process Expert support (see page 117).

EIO0000001114 06/2020 757

Deployment Stage

Undoing Online Changes

If you changed the deployed Participant project using the Refine Online command, select Deploy
changes / Undo Online Changes to undo these changes.
The software identifies the changes you made and displays them in the Deploy Changes / Undo
Online Changes dialog box. After executing the command the deployed Control Participant project
will be identical to the built Participant project again.
Before using the Deploy changes / Undo Online Changes command to undo online changes, verify
that you have not changed and built the logical Control Participant project since the deployment.
NOTE: Changes that you have made online and that you have transferred to the logical Control
Participant project are not undone when you deploy changes after building the logical Control
project. It requires that you have not refined the Control project and made changes that would undo
your online changes.

Deploying Changes to a Redundant Controller

For information that applies specifically to the deployment of changes to redundant controllers,
refer to the topic describing deployment to redundant controllers (see page 733).

758 EIO0000001114 06/2020

 Deployment Stage

Deployed Project Information

When you select the Deploy Changes / Undo Online Changes command, before you can select
the changes that you want to deploy, the software displays the Confirm Deploy Changes / ... dialog
box, which contains information about:
 The engine that you are deploying changes to.
 The Control Participant project that is deployed to the engine.

EIO0000001114 06/2020 759

Deployment Stage

The figure shows an example of the Confirm deploy changes / Undo Online Changes dialog box
for a redundant controller.

The table describes the information that is displayed in the Engine Information section of the
Confirm deploy changes / Undo Online Changes dialog box.

Label Description
Role (1) Role of the engine: A or B.
If the software cannot communicate with the engine, the role is indicated as Not Detected.
Status Status of the engine that is selected for deployment.
If the status is Not Reachable you cannot proceed with the deployment. In such case, verify the
IP address, the connection to the engine, and the status of the engine.
NOTE: If the status is Running, a notification is displayed in the dialog box to inform you that the
engine will be stopped if you proceed with the deployment.
IP Identifier of the communication module through which the software will deploy the built
Address Participant project and its IP address that is configured in the Topology Explorer.
If the topological entity has several communication modules, you can select which one you want
to deploy to.
NOTE: For controllers of the M580 platform, you cannot deploy changes to the CPU module or
a NOC communication module by using IP address A. You can only select main IP address
(see page 759).
(1) Displayed only when you select the command for a redundant controller.

NOTE: To refresh the engine status and attempt to connect to it, click the reconnect button
(see page 723).

760 EIO0000001114 06/2020

 Deployment Stage

The table describes the information that is displayed in the Project Information section of the
Confirm Deploy Changes / Undo Online Changes dialog box. It also describes the check box.

Name column Selected Project column Last Deployed Project column2

System Identifier of the system that both the engine and Identifier of the system that both the engine and
the Control project, which you have selected the Control project, from which you have
belong to. deployed the Participant project last belong to.
Project Identifier of the Control Project that you have Identifier of the Control Project associated to the
selected. deployed Participant project that you have
deployed last.
Executable Identifier of the Control executable that you Identifier of the Control executable that contains
have selected and that contains the built the built Participant project that you have
Participant project to be deployed. deployed last.
Controller Identifier of the controller/station node to which Identifier of the controller/station node to which
you are deploying the built Participant project. you have deployed the built Participant project
last.
Last Built On Date and time when you successfully built the Date and time when you successfully built the
Control Participant project to be deployed. Control Participant project that you have
deployed last.
Last Deployed Not applicable Date and time when you last deployed the
On Participant project to the engine or you last
completed the Deploy Changes / Undo Online
Changes command, independently if there were
changes to be deployed or not.
Last Online Not applicable Date and time when you last changed the
Change deployed Participant project by using the Refine
Performed On Online command; otherwise the field is empty.
Last Sync. Date and time when you last synchronized the standby controller with the primary one, using the
Performed On(1) Synchronize (Primary→Standby) command.
(1) Displayed only when you select the command for a redundant controller.
(2) When you deploy changes to a redundant controller, the dialog box shows separate columns for the primary and
the standby engine.

EIO0000001114 06/2020 761

Deployment Stage

Deploying Changes Other Than FBD Language

The table describes the effect of the Deploy changes / Undo Online Changes command on items
other than FBD language.

Item Effect
Non-FBD Details of changes inside non-FBD sections that the software has identified are not shown. Only
sections the name of sections that have been added, removed, or inside which the software has identified
changes is displayed. Nevertheless, the changes are applied in the logical Control Participant
project.
Animation Details of changes to such items that the software has identified are not shown. Only the name
tables of the animation table and/or operator screen is displayed.
The software displays any animation tables and/or operator screens that the built Participant
Operator
screens project contains, including modified and/or new ones. Animation tables and/or operator screens
that you have deleted from the Participant project are not shown.
You cannot select individual items but only the category for deployment.
When selected, animation tables and operator screens of the deployed Participant project are
overwritten with the ones contained in the built Participant Project.
By default, both categories are not selected.
NOTE:
 Overwriting of an existing operator screen creates a copy of the screen in the deployed
Participant project. Following deployment, use the Refine Online command to edit the
categories and make their contents consistent with the logical Control Participant project.
 Animation tables and/or operator screens that you have removed from the logical Participant
project are not removed from the deployed Participant project by using the command. Use
the Refine Online command to delete them.

Considerations When Deploying Hardware Mapping Changes

Consider the information that is provided on the following pages when using the Deploy changes
/ Undo Online Changes to deploy changes in the hardware mapping affecting:
 IP addresses (see page 872)
 Signals (see page 663)

762 EIO0000001114 06/2020

 Deployment Stage

Changes That Cannot Be Deployed

The software only identifies changes that pertain to a category displayed in the Name column of
the Deploy Changes / Undo Online Changes dialog box. Changes that are not identified are not
deployed. For more information, refer to Changes that Cannot be Deployed (see page 763).

WARNING
UNINTENDED EQUIPMENT OPERATION
Perform Deploy Built Project operation to apply changes that are not identified in the Deploy
Changes / Undo Online Changes dialog box.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

The table indicates the types of changes that are not identified by the software and the command
that you need to use to apply them to the deployed Control Participant project directly.

Type of change Command to use

Control project settings (refer to the Control Participant help, Refine Online (see page 816) or Deploy
Operating Modes) Built Project (see page 736)
SR sections
Properties of MAST and FAST tasks
Timer and I/O event tasks
IODDT variables Refine Online (see page 816)
Device DDT variables Refer to the topic describing the
deployment of changes related to device
DDT variables (see page 766)
Changes to the topology (see page 550), which you make in the Deploy Built Project (see page 736)
Topology Explorer.
Changes to the communication mapping (see page 630).

NOTE: Only changes that you deploy using the Deploy changes / Undo Online Changes command
can be applied to the logical Control Participant project (see page 841) later on.

EIO0000001114 06/2020 763

Deployment Stage

Identifying Project Changes

Before proceeding with the deployment, the software displays the Deploy Changes / Undo Online
Changes dialog box, which provides information about the differences that it has identified
between the built Participant project and the deployed Participant project. It also allows you to
select, which changes you want to deploy.
NOTE: When you select a section in order to deploy changes to this section in the deployed Control
Participant project, the software overrides the online changes that you have made in this section
after the deployment.
The following figure shows an example of the Deploy Changes / Undo Online Changes dialog box
that the software displays.

764 EIO0000001114 06/2020

 Deployment Stage

Header Description
Name Indicates the category and identifier of the items that are changed.
Items of the following categories are identified and displayed:
 Animation Table
 Operator Screens
 Sections (FBD and non-FBD)
 Types
 Variables

Selected items are the ones that the software has identified as changed and that it will
deploy.
NOTE: A black square in a selection box indicates that at least 1 subitem is unselected.
Impact on Indicates if the deployment of the item requires stopping the engine (see page 771).
Engine  Green dot with an arrow: You can deploy the item online.
 Red dot with a square: The software needs to stop the engine to deploy the item.

Action  Minus icon: The item will be removed from the deployed Participant project.
 Plus icon: The item will be added to the deployed Participant project.
 Pencil icon: The item will be modified in the deployed Participant project.

NOTE: When you select a section, the software deploys any changes that it has identified
for this section. You cannot select/unselect changes individually inside a section.
Type Indicates the type of the item identified as a change.
DataType Indicates the data type that is affected by the change, if applicable.
Description of For FBD sections, variables and types, indicates whether the change that the software has
Change identified is an addition, a modification, or a deletion compared to the deployed Participant
project.

NOTE: If the software does not detect any change, it displays a notification to inform you that there
are no changes to deploy.

EIO0000001114 06/2020 765

Deployment Stage

Deploying Changes Related to Device DDT Variable Creation, Update, or Deletion

The following table describes which information the software displays if a device DDT variable
(see page 517) is present only in either the built or the deployed Control project.

DDDT variable in the DDDT variable in the built Information shown in the Deploy Changes / Undo
deployed Control project Control project Online Changes dialog box
Mapped or unmapped Not present No information.
Use the Refine Online (see page 816) or Deploy
Built Project (see page 736) command to remove
the variable in the deployed Control project
Not present Mapped or unmapped The software detects the following as candidate for
deployment:
 The device DDT variable
 Logic related to the variable
 Sections containing the logic

NOTE: The variable is unmapped in the deployed

Control project.

The following table describes which information the software displays in a situation where:
 A device DDT variable with the same name exists in both the built and the deployed Control
project but with a different data type or type version.
 The built Control project contains updated code using the device DDT variable.

DDDT variable in the DDDT variable in the built Information shown in the Deploy Changes / Undo
deployed Control project Control project Online Changes dialog box
Mapped Mapped/unmapped The device DDT variable is not shown as
candidate for deployment. Modifications to the
DDT variable type are not deployed.
Only the changes in code are shown as
candidate for deployment.
NOTE:
 A notification is displayed in the Details
section of the dialog box.
 Deployment of changes may not succeed
because not all changes are deployed.
Unmapped Unmapped The software detects the following as candidate
for deployment:
 The device DDT variable
 Logic related to the variable
 Sections containing the logic

766 EIO0000001114 06/2020

 Deployment Stage

The following table describes which information the software displays in a situation where:
 A device DDT variable with the same name exists in both the built and the deployed Control
project but with a different data type or type version.
 The device DDT variable is not used in the code of either Control project.

DDDT variable in the DDDT variable in the built Information shown in the Deploy Changes / Undo
deployed Control project Control project Online Changes dialog box
Mapped Mapped/unmapped The device DDT variable is not shown as
candidate for deployment. modifications to the
DDT variable type are not deployed.
NOTE: A notification is displayed in the Details
section of the dialog box.
Unmapped Unmapped The software detects the device DDT variable as
candidate for deployment.

The following table describes which information the software displays in a situation where:
 A device DDT variable that exists in the deployed Control project has been deleted from the built
Control project.
 The device DDT variable is either:
 Used in the code.
 Not used in the code.

DDDT variable in the DDDT variable in the built Information shown in the Deploy Changes / Undo
deployed Control project Control project Online Changes dialog box
Mapped Variable is deleted and The device DDT variable is not shown as
references to it in code are candidate for deployment (removal).
removed. Only the changes in code are shown as
candidate for deployment.
Variable is deleted. It is not no information
used in code.
Unmapped Variable is deleted and The software detects the following as candidate
references to it in code are for deployment:
removed.  The device DDT variable (removal)
 Logic related to the variable
 Sections containing the logic

Variable is deleted. It is not The software detects the device DDT variable as
used in code. candidate for deployment (removal).

EIO0000001114 06/2020 767

Deployment Stage

Deploying Changes

WARNING
UNINTENDED EQUIPMENT OPERATION
Before deploying to a controller, verify that:
 You have assigned a valid IP address to the controller.
 The IP address corresponds to the physical address printed on the hardware.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For more information, refer to Identifying Engines (see page 717).

WARNING
UNINTENDED EQUIPMENT OPERATION
Before deploying to an engine, verify that you have selected the correct project files.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

Unintended situations can occur if the operations that are in progress are not known when acting
on a controller.

WARNING
UNKNOWN OPERATIONAL STATE OF EQUIPMENT
Before starting or stopping a controller, always positively confirm that there is no critical operation
in progress.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

768 EIO0000001114 06/2020

 Deployment Stage

When you deploy changes to a redundant controller, although deployment to the primary controller
succeeded, it is possible that synchronization of the standby controller (see page 836) does not
complete. In such case, the software displays a message in the notification panel to inform you. If
an interruption of the connection to the system server or an unexpected stop of the system server
is the cause, the notification panel also contains additional information about steps that you must
complete when the connection to the system server is re-established.

WARNING
UNINTENDED EQUIPMENT OPERATION
 Verify that deployment to the standby controller completed successfully.
 Do not operate the primary controller if deployment to the standby controller does not complete
successfully.
 Synchronize the standby controller manually, using the Sync (Primary→Standby) command
and verify that the synchronization completed successfully.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For information on the deployment of changes to redundant controllers, refer to the topic
describing deployment to redundant controllers (see page 735).
NOTE: For information on the Sync (Primary→Standby) command, refer to the Execution stage
(see page 788).
To deploy changes, proceed as follows.

Step Action Result

1 Verify that the engine can communicate with –
the PC (see page 723).
To deploy changes to a station node, verify
that the simulator emulation software is
running (see page 720).
2 In the Topology Explorer, right-click the The software displays the Confirm Deploy
engine to which you want to deploy changes Changes / Undo Online Changes dialog box.
and select Deploy Changes / Undo Online
Changes.
3 Verify the information that is displayed. –
4 Click OK. The software displays the Deploy Changes /
Undo Online Changes dialog box.
NOTE: Click Cancel to close the Confirm
Deploy Changes / Undo Online Changes
dialog box without deploying.
5 Select the changes that you want to deploy. –

EIO0000001114 06/2020 769

Deployment Stage

Step Action Result

6 Click OK. The software displays the Deploy Changes /
Undo Online Changes confirmation dialog box.
NOTE: Click Cancel to close the Deploy
Changes / Undo Online Changes dialog box
without deploying changes. This reverts to
the previous Deploy Changes / Undo Online
Changes dialog box.
7 If the deployment requires stopping the –
engine, in the Deploy Changes / Undo Online
Changes confirmation dialog box, select
Start engine after deploying built project if
you want the software to start the engine after
the deployment of changes is complete.
8 Click OK or Deploy depending on the use The software:
case. (Only either button is displayed  Stops the engine (if applicable).
depending on the deployment use case,  Deploys the changes that you have selected
without or with engine stop.) to the deployed Control Participant project.
NOTE: Click Cancel to close the Deploy  Displays Completed in the notification panel
Changes / Undo Online Changes dialog box once it has successfully completed the
without deploying changes and revert to the deployment of changes to the engine, which
selection of changes to deploy. is identified by its IP address.
 For a redundant controller, the notification
panel displays separate messages for the
primary and the standby engines by using
their respective IP address to identify
them. If deployment to either engine does
not complete successfully, the software
displays a corresponding message in the
notification panel.
 Updates the related date/time field.
 Starts the controller (cold start) or software
emulating a simulator if you selected the
option (if applicable).

NOTE: In case the deployment of changes does not complete successfully, the software displays
a notification to inform you. If the software stopped the engine before deploying Participant project
changes, the engine remains in Stopped state.

770 EIO0000001114 06/2020

 Deployment Stage

Changes Requiring to Stop the Controller

Summary of Changes
The table indicates if changes that you deploy by using the Deploy Changes / Undo Online
Changes command, or apply by using the Refine Online (see page 816) command require
stopping the controller.

Type of change Requires stopping the controller

When deploying, When applying, using the Refine Online
using Deploy command
Changes command
General
Modifying Control Expert project settings. N/A Refer to Project Settings for a list of
settings that you can change and to
Synthesis of Authorized and
Unauthorized Modifications in the help of
the Control Participant.
Program: Task Sections, SR, SFC Action & Transition
Modifying/replacing partially the code of Yes Refer to Synthesis of Authorized and
an SFC section (SFC chart, transition, Unauthorized Modifications in the help of
action). the Control Participant.
Deleting SFC chart, transition, action. Yes
Adding an SFC section. No
Modifying or deleting an LL984 section. Yes
Adding an LL984 section. No
Modifying, deleting, or adding a section in No
either of the following languages:
 IL
 LD
 ST

Used Variables (used even in Animation Tables or Operator Screens)

Modifying the Retain or Exchange On Yes Yes
STBY attribute of a used variable.
Modifying the time stamp attribute of any Yes Refer also to Synthesis of Authorized and
used variable. Unauthorized Modifications in the help of
the Control Participant.
Modifying the structure of a used DDT. Yes

EIO0000001114 06/2020 771

Deployment Stage

Type of change Requires stopping the controller

Used DFBs
Modifying the name of an input, output, or Yes Refer also to Synthesis of Authorized and
input/output pin (formal parameter) of a Unauthorized Modifications in the help of
used DFB. the Control Participant.
Adding an input, output, or input/output pin Yes
(formal parameter) to a used DFB.
Deleting an input, output, or input/output Yes
pin (formal parameter) from a used DFB.

772 EIO0000001114 06/2020

 Deployment Stage

Section 20.2
Supervision Project Deployment Stage

Supervision Project Deployment Stage

Overview
This section describes the methods that you can use to deploy built Supervision Participant
projects to computers (for example, operation servers, operator stations), which are connected to
the Ethernet network. These computers are modeled by the corresponding station nodes in the
topology of the system.
It also describes how to deploy only the changes that you have made following a first deployment.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Preparing for Deployment 774
Deploying the Built Supervision Participant Project from the Executable 775
Deploying the Built Supervision Participant Project from the Station Node 778
Deploying Supervision Participant Project Changes 784

EIO0000001114 06/2020 773

Deployment Stage

Preparing for Deployment

Overview
The software lets you deploy a built Supervision Participant project and related files to the station
nodes (see page 566) that you have defined in the topology of the system and mapped
(see page 680) to the executable that is associated to the Supervision project.
You can deploy either way:
 In the Project Explorer: From the executable of the Supervision project. This deploys a selection
of files to the station nodes that are mapped to the executable in the service mapping.
 In the Topology Explorer: From a station node that is mapped to the executable in the service
mapping. This deploys a selection of files to this station node only.
The software detects roles of station nodes depending on the services (see page 569) that are
configured in the Topology Explorer and considers a station node to be:
 An I/O server when configured with Supervision and OFS services.
 An alarm, trend, or report server, or a Supervision client when configured with the Supervision
service only.
The software deploys to the computer that has an IP address matching the IP address of the
station node configured in the Topology Explorer.
For information on the required Supervision software, refer to the topic describing software
requirements (see EcoStruxure™ Process Expert, Installation and Configuration Guide).

Target Computer Setup

To prepare for the deployment, you need to:
 Verify that the configuration of the station nodes (see page 551) in the topology of the system
matches the configuration of the target computers (for example, verify that the station node
containing the OFS service has the same IP address as the computer that runs the OPC Factory
Server or OPC UA Server Expert).
If a station node is configured with several NICs, each having an IP address:
 When deploying from the executable, the first IP address that is reachable from the system
server computer is used.
 When deploying from the station node, you can select which IP address to use among those
that are reachable from the system server computer.
 Create shared folders on each computer to which you deploy the Supervision project.
 Verify that the system server can access these shared folders; otherwise, the deployment
cannot complete successfully.
For information on how to set up target computers, refer to the topic describing how to prepare for
deployment (see EcoStruxure™ Process Expert, Supervision Participant Services, User Guide).
NOTE: When sharing a folder, restrict access by giving permissions only to the user who needs to
access the folder. In this case, the user who is logged on to the system server computer.

774 EIO0000001114 06/2020

 Deployment Stage

Deploying the Built Supervision Participant Project from the Executable

Overview
By using the Deploy Built Project command, you can transfer selected files of the built Supervision
Participant project to the operation server, and/or operator stations that are connected to the
Ethernet network. The deployment is performed to the station nodes that you have mapped to the
executable of the Supervision project in the service mapping and which represent these
computers.
After a first deployment, you need to restore the deployed Supervision Participant project on each
target computer.
Information related to subsequent deployments from the same executable is provided in the topic
describing how to deploy the built Supervision Participant project again (see page 777).

Deployed Files
You can deploy the following files:
 The Supervision master project file (.ctz), for example, Supervision_1_Executable_1.ctz), which
includes the Supervision computer setup file (citect.ini) (see EcoStruxure™ Process Expert,
Supervision Participant Services, User Guide).
 Attached user files (see page 547). These are located inside the master project (.ctz) on the
target computer.
 OFSOPC/OPC UA configuration files (.xml) (see page 705): Deployed only to station nodes
mapped to the IOServer service of the Supervision project. If there are several configuration
files, each file is deployed to its respective station node only.
 The included projects (see page 546).

You can select not to deploy the configuration file and/or the included project in the Deployment
File Selection dialog box (see page 781), which is accessible during the deployment process.
NOTE: Supervision project files that are deployed are already compiled by using the version of the
Supervision Participant that is running inside the virtual machine. To verify the version, open a
Supervision Participant (for example, by refining a Supervision Participant project), and open the
About dialog box.

Deploying Out Of Date Participant Projects

You can deploy a Supervision Participant project whose status is Out Of Date.
Before deploying a built Supervision Participant project, verify its Build State (see page 707). Only
Supervision Participant projects whose status is Built contain the latest changes that you have
made (see page 708) to the system.

EIO0000001114 06/2020 775

Deployment Stage

Aborting Deployment Tasks

After confirming the command by clicking OK in the Deploy Built Project or Deployment File
Selection dialog box, the abort icon is displayed in the notification panel (see page 86). Click the
icon to cancel the task.
Files that have already been transferred to station nodes at the moment you abort the task are not
removed from the target locations. Open the shared folders on each station node to confirm which
files have been transferred.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are deploying only a small project, the task may complete before you are able to click
the icon.

Deploying the Supervision Files

To deploy selected files pertaining to the built Supervision Participant project to the target
computers from the executable, proceed as follows.

Step Action
1 Verify that the target computers are prepared (see page 774).
2 Right-click the executable that you want to deploy and select Deploy Built Project.
Result: The Deploy Built Project dialog box opens, which gives you the possibility to modify the
selection of deployed files.
3 Click:
 Yes to open the Deployment File Selection dialog box (see page 781); proceed to step 4.
 No to deploy only the master Supervision project file (.ctz) but no OFSOPC/OPC UA
configuration file and no included projects.
 Cancel to cancel the deployment.

Result: If you clicked No, the software:

 Deploys the files to the appropriate folders on each target computer.
 Displays deployment information in the notification panel for each target computer, including
the IP addresses that were used.
 Opens the Deploy Built Project dialog box, which contains a summary of the deployment
process per target computer.
4 In the Deployment File Selection dialog box, select the files that you want to deploy and click OK.
Result: The software:
 Deploys the files to the appropriate folders on each target computer.
 Displays deployment information in the notification panel for each target computer, including
the IP addresses that were used.
 Opens the Deploy Built Project dialog box, which contains a summary of the deployment
process per target computer.
NOTE: Click Cancel to cancel the deployment.

776 EIO0000001114 06/2020

 Deployment Stage

Restoring the Supervision Project

After a first deployment, you need to restore the deployed Supervision Participant project on each
target computer.
Restoring the project creates a Supervision project folder on the target computer that has the same
name as the deployed Supervision master project file (.ctz).
For information on restoring the deployed Supervision project, refer to topic describing how to
restore Supervision projects (see EcoStruxure™ Process Expert, Supervision Participant
Services, User Guide).

Deploying the Built Supervision Participant Project Again

To perform a subsequent deployment of the complete Supervision project from the same
executable after you have modified and built it, follow the procedure describing how to deploy the
project files (see page 776).
The software replaces the existing files in the SoCoDeploy, SoCoOfsDeploy, and/or
SoCoOpcUaDeploy shared folders (see EcoStruxure™ Process Expert, Supervision Participant
Services, User Guide) on the target computers with the version that is contained in the Supervision
project that you are deploying again.
Then, to apply the changes, the steps that you need to complete on each of the target computer
vary, depending on the changes that you have deployed (for example, updating the
OFSOPC/OPC UA configuration data manually). Refer to the topic describing how to execute the
deployed Supervision project (see EcoStruxure™ Process Expert, Supervision Participant
Services, User Guide).
NOTE: If you had already deployed attached user files (see page 547) and you redeploy the same
Supervision project after removing one or more of user files, these files remain in the SoCoDeploy
shared folder where they had been deployed initially. You need to remove them manually from the
shared folder.

EIO0000001114 06/2020 777

Deployment Stage

Deploying the Built Supervision Participant Project from the Station Node

Overview
The Deploy Built Project command that is available from the station node provides an alternative
deployment method. By selecting it, you can transfer selected files of the built Supervision
Participant project to a specific computer connected to the Ethernet network (for example, the
operation server or an operator station). The deployment is performed from the station node that
represents this computer. The station node needs to be mapped (service mapping (see page 680))
to the executable of the Supervision project that you are deploying.
After a first deployment, you need to restore the deployed Supervision Participant project on the
target computer.
Information related to subsequent deployments of the same Supervision project is provided in the
topic describing how to deploy the built Supervision Participant project again (see page 777).

Deployed Files
You can deploy the following files:
 The Supervision master project (.ctz file, for example, Supervision_1_Executable_1.ctz), which
includes the Supervision cocomputer setup file (citect.ini) (see EcoStruxure™ Process Expert,
Supervision Participant Services, User Guide).
 Attached user files (see page 547). These are located inside the master project (.ctz) on the
target computer.
 The OFSOPC/OPC UA configuration files (.xml) (see page 705) that are related to the station
node: Deployed only to station nodes mapped to the IOServer service of the Supervision
project.
 The included projects (see page 546).

You can select not to deploy the configuration files and/or the included project in the Deployment
File Selection dialog box (see page 781), which is accessible during the deployment process.
NOTE: Supervision project files that are deployed are already compiled by using the version of the
Supervision Participant that is running inside the virtual machine. To verify the version, open a
Supervision Participant (for example, by refining a Supervision Participant project), and open the
About dialog box.

Selecting Participant Project and Control Executable

When you select the Deploy Built Project command for a station node, the software displays the
Deploy Built Project dialog box, which allows you to select:
 Project: Any Supervision project that exists in the system whose executable is mapped to at
least one service (see page 680)
 Executable: For each project, any built or out of date Supervision executable that is mapped to
the station node (service mapping).

778 EIO0000001114 06/2020

 Deployment Stage

Built Participant Project Build Status

The software informs you when the built Supervision Participant project that you want to deploy is
marked as being out of date. Nevertheless, you can proceed with the deployment.
Before deploying a built Supervision Participant project, verify that its Build State (see page 707)
is up to date and/or that it contains the latest changes that you have made (see page 708) to the
system.

Supervision Participant Project Information

Before proceeding with the deployment of a built Participant project, the software displays
information in the Confirm Deploy Built Project dialog box about:
 The station node that you are deploying to.
 The built Participant project to be deployed.
 The Participant project that was deployed last to the engine.

The following figure shows an example of the Confirm Deploy Built Project dialog box.

EIO0000001114 06/2020 779

Deployment Stage

The tables describe the information that is displayed in the Confirm Deploy Built Project dialog box.

Engine Information Description

section
Status Status of the station node that is selected for deployment.
If the status is Not Reachable, you cannot proceed with the deployment. In such case,
verify the IP address and the connection to the station node.
NOTE: To refresh the engine status and attempt to connect to it, click the reconnect
button (see page 723).
IP Address Identifier of the NIC through which the software will deploy the built Participant project
and its IP address that is configured in the Topology Explorer.
If the station node has several NICs, you can select which one you want to use for
deployment.

Project Information Selected Project column Last Deployed Project column

section
Executable Identifier of the Supervision executable that Identifier of the Supervision executable that
you have selected and that contains the built contains the built Participant project that you
Participant project to be deployed. have deployed last.
Station Node Identifier of the topological entity to which you Identifier of the topological entity to which you
are deploying the built Participant project. have deployed the built Participant project last.
System Identifier of the system that both the station Identifier of the system that both the engine and
node and the Supervision project, which you the Supervision project, from which you have
have selected belong to. deployed the Participant project last belong to.
Project Identifier of the Supervision Participant project Identifier of the Supervision Participant project
that you have selected. associated to the executable that you have
deployed last.
Last Built On Date and time when you successfully built the Date and time when you successfully built the
Supervision Participant project to be Supervision Participant project that you have
deployed. deployed last.
Last Deployed On Not applicable Date and time when you last deployed the
Participant project from the station node or
from the executable associated to the
Supervision project.
Select Check box.
OFSOPC/OPC UA When selected, opens the Deployment File Selection dialog box, where you can select the
configuration files OFSOPC/OPC UA configuration files and included projects to be deployed in addition to the
and/or included Supervision master project file (.ctz).
projects When cleared, the dialog box does not open and only the Supervision master project file (.ctz)
is deployed.

780 EIO0000001114 06/2020

 Deployment Stage

Check box Description

Select When selected, opens the Deployment File Selection dialog box, where you can select the
OFSOPC/OPC UA OFSOPC/OPC UA configuration files and included projects to be deployed in addition to the
configuration files Supervision master project file (.ctz).
and/or included projects When cleared, the dialog box does not open and only the Supervision master project file
(.ctz) is deployed.

NOTE: When you deploy for the first time to a station node, the fields of the Last Deployed Project
section are empty.

Selecting the Files to Deploy

The following figure shows an example of the Deployment File Selection dialog box, which opens
when you select the Select OFSOPC/OPC UA configuration files and/or included projects check
box and click OK in the Confirm Deploy Built Project dialog box.

1 Supervision master project file (.ctz), which is selected by default. You cannot clear the check box.
2 OFSOPC or OPC UA configuration files (see page 705) that are related to the station node and generated
depending on the selected protocol for the tag container. Configuration files can be selected only for station
nodes that are mapped to an I/O server.
3 Included projects (see page 546) that are associated to the master project.

EIO0000001114 06/2020 781

Deployment Stage

Aborting Deployment Tasks

After confirming the command by clicking OK in the Reconfirm Deploy Built Project dialog box, the
abort icon is displayed in the notification panel (see page 86). Click the icon to cancel the task.
Files that have already been transferred to the station node at the moment you abort the task are
not removed from the target locations. Open the shared folders on the station node to confirm
which files have been transferred.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are deploying only a small project, the task may complete before you are able to click
the icon.

Deploying the Supervision Files

To deploy selected files pertaining to the built Supervision Participant project from a station node,
proceed as follows.

Step Action
1 In the Topology Explorer, identify the station node that represents the computer you want to
deploy to.
2 Verify that the target computer is prepared (see page 774).
3 Right-click the station node and click Supervision → Deploy Build Project.
Result: The Deploy Built Project dialog box opens.
4 Click the Project list and select the Supervision project.
5 Click the Executable list and select the executable associated to the built Supervision project
that you want to deploy.
6 Click OK.
Result: The Confirm Deploy Built Project dialog box opens.
NOTE: Click Cancel to close the dialog box without deploying.
7 Verify the status of the engine in the Status field.
8 Verify the NIC identification and IP address or select one in the IP Address field.
9 Verify the information that is displayed in the Project Information section of the Confirm Deploy
Built Project dialog box.
10 To modify the selection of files to deploy, select the Select OFS configuration files and/or
included projects check box (see page 779) and click OK; otherwise, to exclude configuration
files and included projects from the deployed files, clear the check box, click OK, and proceed
to step 12.
Result: The Deployment File Selection dialog box opens.
11 In the Deployment File Selection dialog box, select the files you want to deploy to the station
node and click OK.
Result: The Reconfirm Deploy Built Project dialog box opens.
NOTE: Click Cancel to cancel your file selection and revert to the Confirm Deploy Built Project
dialog box.

782 EIO0000001114 06/2020

 Deployment Stage

Step Action
12 Click OK in the Reconfirm Deploy Built Project dialog box.
Result: The software:
 Deploys the selected files to the appropriate folders on the target computer.
 Displays Completed in the notification panel and provides deployment information.
 Updates the related date/time field.

NOTE: Click Cancel to revert to the Confirm Deploy Built Project dialog box.

Restoring the Supervision Project

After a first deployment, you need to restore the deployed Supervision Participant project on the
target computer.
Restoring the project creates a Supervision project folder on the target computer that has the same
name as the deployed Supervision master project file (.ctz).
For information on restoring the deployed Supervision project, refer to topic describing how to
restore Supervision projects (see EcoStruxure™ Process Expert, Supervision Participant
Services, User Guide).

Deploying the Built Supervision Participant Project Again

To perform a subsequent deployment of the complete Supervision project after you have modified
and built it, follow the procedure describing how to deploy the project files (see page 782).
The software replaces the existing files in the SoCoDeploy and SoCoOfsDeploy shared folders
(see EcoStruxure™ Process Expert, Supervision Participant Services, User Guide) on the target
computer with the version that is contained in the Supervision project that you are deploying again.
Then, to apply the changes, the steps that you need to complete on the target computer vary,
depending on the changes that you have deployed (for example, updating the OFSOPC/OPC UA
configuration data manually). Refer to the topic describing how to execute the deployed
Supervision project (see EcoStruxure™ Process Expert, Supervision Participant Services, User
Guide).
NOTE: If you had already deployed attached user files (see page 547) and you redeploy the same
Supervision project after removing one or more of user files, these files remain in the SoCoDeploy
shared folder where they had been deployed initially. You need to remove them manually from the
shared folder.

EIO0000001114 06/2020 783

Deployment Stage

Deploying Supervision Participant Project Changes

Overview
By using the Deploy Changes command, you can deploy the changes that you have made to an
already deployed Supervision Participant project given these changes are supported by the
command.
You can deploy changes either from the executable or the station node independently from the
method that you have used to perform the previous deployment.
You can select to deploy only the Supervision master project file (.ctz) or also additional files.

Prerequisites
The following conditions must be satisfied to be able to deploy changes by using the Deploy
Changes command.
 You must have deployed the complete Supervision Participant project to the station node and
restored it by using the Supervision software.
 The Supervision project folder (see EcoStruxure™ Process Expert, Supervision Participant
Services, User Guide) that was created by restoring the deployed Supervision Participant
project must be present on the target computer.
 The changes that can be deployed incrementally are only those that can be applied by using
the Build command:
 A maximum of 5 changes involving Supervision pages.
 A maximum of 30 changes involving data facets.
 Modifications of parameters of the Message category of Supervision elements

Refer to the topic describing the build stage for details (see page 710).
NOTE: Using the Build All command disables the Deploy Changes command.

Deployed Files
The files that you can deploy are the same as for the deployment of the complete Supervision
Participant project (see page 778).
You can change the selection during the deployment process in the Deployment File Selection
dialog box (see page 781).

784 EIO0000001114 06/2020

 Deployment Stage

Aborting Deployment Tasks

After confirming the command by clicking OK in the Reconfirm Deploy Changes dialog box, the
abort icon is displayed in the notification panel (see page 86). Click the icon to cancel the task.
Files that have already been transferred to station nodes at the moment you abort the task are not
removed from the target locations. Open the shared folders on each station node to confirm which
files have been transferred.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are deploying only few changes, the task may complete before you are able to click
the icon.

Deploying Changes from the Executable

To deploy changes to the Supervision Participant project to the target computers from the
executable, proceed as follows.

Step Action
1 Verify that the target computers are prepared (see page 774).
2 In the Project Explorer, expand the Supervision project that you want to deploy from and open
the Executables folder to show existing executables.
3 Right-click the executable that you want to deploy and select Deploy Changes.
Result: The Deploy Changes dialog box opens, which gives you the possibility to modify the
selection of files.
4 Click:
 Yes to open the Deployment File Selection dialog box (see page 781); proceed to step 5.
 No to deploy only the master Supervision project file (.ctz) but no OFSOPC/OPC UA
configuration file and no included project.
 Cancel to cancel the deployment.

Result: If you clicked No, the software:

 Deploys the master Supervision project file to the appropriate folders on each target
computer.
 Displays deployment information in the notification panel for each target computer, including
the IP addresses that were used.
 Opens the Deploy Changes dialog box, which contains a summary of the deployment
process per target computer.
5 In the Deployment File Selection dialog box, select the files that you want to deploy and click OK.
Result: The software:
 Deploys the files to the appropriate folders on each target computer.
 Displays deployment information in the notification panel for each target computer, including
the IP addresses that were used.
 Opens the Deploy Changes dialog box, which contains a summary of the deployment
process per target computer.
NOTE: Click Cancel to the deployment.

EIO0000001114 06/2020 785

Deployment Stage

Deploying Changes from the Station Node

To deploy changes to the Supervision Participant project from a station node, proceed as follows.

Step Action
1 In the Topology Explorer, identify the station node that represents the computer you want to
deploy to.
2 Verify that the target computer is prepared (see page 774).
3 Right-click the station node and click Supervision → Deploy Changes.
Result: The Confirm Deploy Changes dialog box opens. The information of the last deployed
executable and project is indicated in the Executable and Project fields of the Project Information
section.
4 Verify the status of the engine in the Status field.
5 Verify the NIC identification and IP address or select one in the IP Address field.
6 If you want to deploy other files in addition to the master Supervision project, select the Select
OFSOPC/OPC UA configuration files and/or included projects check box (see page 779) and
click OK; otherwise, to exclude configuration files and included projects from the deployed files,
clear the check box, click OK, and proceed to step 8
Result: The Deployment File Selection dialog box opens.
NOTE: Click Cancel to close the dialog box without deploying.
7 In the Deployment File Selection dialog box, select the files you want to deploy to the station
node and click OK.
Result: The Reconfirm Deploy Changes dialog box opens.
NOTE: Click Cancel to cancel your file selection and revert to the Confirm Deploy Changes
dialog box.
8 Click OK in the Reconfirm Deploy Changes dialog box.
Result: The software:
 Deploys the selected files to the appropriate folders on the target computer.
 Displays Completed in the notification panel and provides deployment information.
 Updates the related date/time field.

NOTE: Click Cancel to revert to the Confirm Deploy Changes dialog box.

786 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Execution Stage
EIO0000001114 06/2020

Chapter 21
Execution Stage

Execution Stage

Overview
This chapter describes how to execute and/or modify the Control and Supervision projects that you
have deployed to engines of the system.
The following figure shows the position of the Execution stage within the system engineering life
cycle.

Refer to the Execution stage (see page 65) for a description of the purpose of this stage.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
21.1 Control Project Execution Stage 788
21.2 Supervision Project Execution Stage 854

EIO0000001114 06/2020 787

Execution Stage

Section 21.1
Control Project Execution Stage

Control Project Execution Stage

Overview
This section describes how to use the Topology Explorer to change the state of controllers, modify
deployed Control Participant projects, and how to transfer changes to the associated logical
Participant project in the software.
NOTE: When one or more users work on components of the same system simultaneously (for
example, Participant projects, the application, project containers, topological entities), locking
mechanisms may restrict certain concurrent actions (see page 83). In such case, check the
Notification Panel (see page 86) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Control Participant Project Execution Process 789
Execution With Redundant Controllers 793
Starting and Stopping Controllers 796
Synchronizing Redundant Controllers 804
About Changes Made Online 809
Making Changes Online 816
Backing Up Controller Data 823
Importing Sections from the Logical Control Participant Project 829
Main Redundant Controller Scenarios 833
Redundant Controller Reservation and Connection Scenarios 836
Updating the Logical Control Participant Project 841

788 EIO0000001114 06/2020

 Execution Stage

Control Participant Project Execution Process

Overview
The software allows you to execute a deployed Control Participant project, make changes to the
deployed Participant project online, and update the logical Control Participant source project with
these changes.
For this purpose, following the deployment of a built Control Participant project, the following
commands become available:
 Start
 Stop
 Refine Online
 Sync (Primary→Standby)
 Update Control Project

The commands are available for the following engines to which you have deployed a Control
Participant project:
 Controllers.
 Station nodes running software emulating a simulator.

EIO0000001114 06/2020 789

Execution Stage

Execution Flowchart
The following figure illustrates the different steps that are part of the execution of the deployed
Control Participant project and their associated commands.

- - - Represents commands pertaining to the deployment stage (see page 715).

1 Includes the section import functionality (see page 829).
2 The functionality is a sub-command of the Refine Online command within the Control
Participant.
3 Or emulated simulator (station node).

790 EIO0000001114 06/2020

 Execution Stage

Prerequisites
The table describes the actions that are prerequisite for using a command.

Command Actions
Start / Stop Deploy the built Control Participant project.
Refine Online Deploy the built Control Participant project.
Sync (Primary→  Deploy the built Control Participant project. Either of the following use cases
Standby) may apply:
 Deployment to, or synchronization of the standby engine did not complete
successfully following execution of the Deploy, Re-Deploy, Deploy
Changes, or Refine Online command.
 Deployment was done to the primary engine only because the
ControllerExist parameter is set to Primary. You need to set the
parameter to PrimaryAndStandby, verify that the standby engine is
reachable, and that both engines are connected by a Hot Standby cable
link.
 Verify that the status of the primary engine is Running Primary.

Update Control Project  Deploy the built Control Participant project.

 Change the deployed Control Participant project by using the Refine Online
command.
NOTE: Certain changes cannot be transferred (see page 763) to the logical
Control Participant project by using the command.

For the other actions that are required, for example, mapping of the Control executable to an
engine, refer to the system engineering life cycle that is described in this manual.

Control Project Mismatch Verification

Before executing the Start/Stop, Sync (Primary→Standby), or Refine Online command, the
software compares the Control Participant project that is deployed in the engine with the last
deployed reference (see page 790), which is the Control Participant project residing in the
software.
If they are identical, the command is executed. If they differ, the software starts a recovery process
first. This process may take several minutes to complete.
In case the software displays a notification about a signature mismatch, the command cannot be
executed. Contact EcoStruxure Process Expert support.

EIO0000001114 06/2020 791

Execution Stage

Client/Server Connection
In case of an unexpected stop of the system server, the notification panel of engineering clients
that were connected to the system server before the communication interruption may contain
information about operations that did not complete successfully because of this interruption. It may
also indicate corrective actions.
After an interruption of the client/server connection, the states of both the engineering client and
the system server may have become inconsistent if an execution operation was in progress.

NOTICE
DATA CORRUPTION
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.
Failure to follow these instructions can result in equipment damage.

NOTE: For more information on client and server behavior in case of a communication interruption,
refer to the topic describing client/server connection (see page 75).

Start/Stop Commands
The software can send a start or stop command to the controller or software emulating a simulator.
Unintended situations can occur if the operations that are in progress are not known when acting
on a controller.

WARNING
UNKNOWN OPERATIONAL STATE OF EQUIPMENT
Before starting or stopping a controller, always positively confirm that there is no critical operation
in progress.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

792 EIO0000001114 06/2020

 Execution Stage

Execution With Redundant Controllers

Overview
This topic describes aspects that are specific to the execution of Control Participant projects with
redundant controllers, which are modeled in the topology of the system.
The same commands that are used on standalone configurations are also used for redundant
controllers.
Detailed information on the commands that are available as part of the execution stage are
described later in this chapter.
For a description of the sequence of actions that Control performs on the engines, refer to the topic
describing main redundant controller scenarios (see page 833).
NOTE: For controllers of the M580 platform, you cannot perform execution tasks on the CPU
module or a NOC communication module by using IP address A and IP address B. You can
only select main IP address (see page 759).

ControllerExist Property
Verify that the ControllerExist parameter is set correctly (see page 733).

Engine Status for Redundant Controllers

Refer to the information that is provided in the topic describing deployment to redundant controllers
(see page 733).

Starting/Stopping a Redundant Controller

For redundant controllers, the Start/Stop commands act on the primary and the standby engines,
provided that both are reachable.
When you select the Start or Stop command for a redundant controller (see page 836), composed
of one primary and one standby engine to which IP addresses IP, and IP + 1 are assigned
respectively, the software displays the Confirm <Command> dialog box (where <Command>
represents either Start or Stop), which provides information on both engines.
NOTE: When you select the Start command and the status of the standby engine is Stop Offline
(or Stop for controllers of the M580 platform), the primary engine starts and synchronizes the
standby engine so that both engines start.

Redundant Controller Stop Sequence

When you stop the redundant controller and both engines are running, the software stops in the
following order:
 The standby engine
 The primary engine

EIO0000001114 06/2020 793

Execution Stage

Refining Online with a Redundant Controller

To proceed with the deployment, the primary engine must be in either Running Primary or Stop
Offline (or Stop for controllers of the M580 platform) state.
The software executes the command on the project that is deployed on the primary engine.
When you deploy online changes that do not require stopping the engine, and the primary engine
is in Running Primary state:
 The software enables the configuration mismatch feature of the controller so that the standby
engine does not enter the offline operating mode when changes are deployed to the primary
engine.
 The software deploys to the primary engine first, and upon successful completion of the
deployment, automatically synchronizes the standby engine.
 Then, the software disables the configuration mismatch feature.

When you deploy changes to a redundant controller, although deployment to the primary controller
succeeded, it is possible that synchronization of the standby controller (see page 836) does not
complete. In such case, the software displays a message in the notification panel to inform you. If
an interruption of the connection to the system server or an unexpected stop of the system server
is the cause, the notification panel also contains additional information about steps that you must
complete when the connection to the system server is re-established. This is the case, for example,
when the software cannot disable the configuration mismatch feature. If this feature is enabled and
a switchover occurs, the standby controller operates with a program that does not contain the
changes that you have deployed to the primary controller.

WARNING
UNINTENDED EQUIPMENT OPERATION
 Verify that deployment to the standby controller completed successfully.
 Do not operate the primary controller if deployment to the standby controller does not complete
successfully.
 Synchronize the standby controller manually, using the Sync (Primary→Standby) command
and verify that the synchronization completed successfully.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: If the primary engine is not in Running Primary state, synchronization of the standby engine
cannot complete successfully. In such case, starting (see page 796) the primary engine
synchronizes the standby engine.

794 EIO0000001114 06/2020

 Execution Stage

Redundant Controller Synchronization Timeout

After you select the Build and Deploy command (see EcoStruxure™ Process Expert, Control
Participant Services, User Guide), upon successful deployment to the primary engine, the
deployed Control Participant project is stored in the contents repository as the last deployed
reference (see page 790).
It avoids project mismatch (see page 791) and allows you to synchronize the standby controller,
using the Sync (Primary→Standby) command in case the synchronization timeout is elapsed
(see page 804).

EIO0000001114 06/2020 795

Execution Stage

Starting and Stopping Controllers

Overview
Following the deployment of a built Control Participant project to an engine, you can change the
state of the engine by using the following commands:
 Start
 Stop

The commands act on the physical controller or on the software emulating a simulator that is
installed on the PC represented by the engine in the topology of the system. The IP address of the
controller or of the PC on the Ethernet network needs to match with the address that is assigned
to the corresponding engine.

Confirming Execution
When you select the Start or Stop command for a controller or station node, before proceeding with
the execution of the command, the software displays the Confirm <Command> dialog box (where
<Command> represents either Start or Stop), which contains information about:
 The engine that you want to start or stop.
 The Control Participant project that is deployed to the engine.

The following figure shows an example of the Confirm Stop dialog box that the software displays
when you select the Stop command for a controller that is running.

796 EIO0000001114 06/2020

 Execution Stage

The following figure shows an example of the Confirm Stop dialog box that the software displays
when you select the Stop command for a redundant controller that is running.

EIO0000001114 06/2020 797

Execution Stage

The following figure shows an example of the Confirm Start dialog box that the software displays
when you select the start command for a controller that is stopped.

The following figure shows an example of the Confirm Start dialog box that the software displays
when you select the start command for a redundant controller that is running. The command
cannot be executed because the engine is already running.

798 EIO0000001114 06/2020

 Execution Stage

The table describes the information that is displayed in the Engine Information section of the
Confirm Start and Confirm Stop dialog boxes.

Label Description

Role(1) Role of the engine: A or B.

If the software cannot communicate with the engine, the role is indicated as Not Detected.
Status Status of the engine that is selected for execution.
If the status is Not Reachable you cannot proceed with the command. In such case, verify the
IP address, the connection to the engine, and the status of the engine.
IP Address Identifier of the communication module through which the software sends the command and
its IP address that is configured in the Topology Explorer.
If the topological entity has several communication modules, you can select through which one
you want to start or stop.
NOTE: For controllers of the M580 platform, you cannot start or stop an engine by using IP
address A of the CPU module or a NOC communication module. You can only select
main IP address (see page 759).
(1) Displayed only when you select the command for a redundant controller.

NOTE: To refresh the engine status and attempt to connect to it, click the reconnect button
(see page 723).
The table describes the information that is displayed in the Project Information section of the
Confirm Start and Confirm Stop dialog boxes.

Name column Last Deployed Project column(2)

System Identifier of the system that both the engine and the Control project, from which you
have deployed the Participant project last belong to.
Project Identifier of the Control Participant project associated to the deployed Participant
project that you have deployed last.
Executable Identifier of the Control executable that contains the built Participant project that you
have deployed last.
Controller Identifier of the topological entity to which you have deployed the built Participant
project last.
Last Deployed On Date and time when you last deployed the Participant project to the engine or you last
completed the Deploy Changes / Undo Online Changes command, independently if
there were changes to be deployed or not.
Last Start/Stop Date and time when you last started or stopped the engine.
Performed On
(1) Displayed only when you select the command for a redundant controller.
(2) When you start or stop a redundant controller, the dialog box shows separate columns for the primary
and the standby engine.

EIO0000001114 06/2020 799

Execution Stage

Name column Last Deployed Project column(2)

Last Online Date and time when you last changed the deployed Participant project by using the
Change Performed Refine Online command; otherwise the field is empty.
On
Last Sync. Date and time when you last synchronized the standby engine with the primary engine
Performed On(1) by using the Synchronize (Primary→Standby) command; otherwise the field is empty.

(1) Displayed only when you select the command for a redundant controller.
(2) When you start or stop a redundant controller, the dialog box shows separate columns for the primary
and the standby engine.

NOTE: If the software detects that the engine is already running or stopped, it displays information
in the dialog box and you cannot execute the command.

Starting an Engine

WARNING
UNINTENDED EQUIPMENT OPERATION
Before starting or stopping a controller, verify that:
 You have assigned a valid IP address to the controller.
 The IP address corresponds to the physical address printed on the hardware.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For more information, refer to Identifying Engines (see page 717).
Unintended situations can occur if the operations that are in progress are not known when acting
on a controller.

WARNING
UNKNOWN OPERATIONAL STATE OF EQUIPMENT
Before starting or stopping a controller, always positively confirm that there is no critical operation
in progress.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

800 EIO0000001114 06/2020

 Execution Stage

When starting a redundant controller, synchronization of the standby controller may not complete
successfully. In such case, the software displays a message in the notification panel to inform you.

WARNING
UNINTENDED EQUIPMENT OPERATION
 Verify that deployment to the standby controller completed successfully.
 Do not operate the primary controller if deployment to the standby controller does not complete
successfully.
 Synchronize the standby controller manually, using the Sync (Primary→Standby) command
and verify that the synchronization completed successfully.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For information on the Sync (Primary→Standby) command, refer to the topic describing
synchronization of redundant controllers (see page 804).
To start the engine, proceed as follows.

Step Action Result

1 Verify that the engine is connected to the PC –
(see page 723).
2 In the Topology Explorer, right-click the engine The software displays the Confirm Start dialog
and select Start. box.
3 Verify the information that is displayed. –
4 Click OK. The software displays the Reconfirm Start dialog
box.
NOTE: Click Cancel to close the Confirm Start
dialog box without starting the engine.
5 Click OK. The software:
 Starts the engine.
NOTE: Click Cancel to close the Reconfirm
 Displays Completed in the notification panel
Start dialog box without starting the engine.
This reverts to the Confirm Start dialog box. once it has successfully completed the
command for the engine, which is identified by
its IP address.
 For a redundant controller, the information
pane displays separate messages for the
primary and the standby engines by using
their respective IP address to identify them.
 Updates the Last Start/Stop Performed On
field.

EIO0000001114 06/2020 801

Execution Stage

Stopping an Engine

WARNING
UNINTENDED EQUIPMENT OPERATION
Before starting or stopping a controller, verify that:
 You have assigned a valid IP address to the controller.
 The IP address corresponds to the physical address printed on the hardware.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For more information, refer to Identifying Engines (see page 717).
Unintended situations can occur if the operations that are in progress are not known when acting
on a controller.

WARNING
UNKNOWN OPERATIONAL STATE OF EQUIPMENT
Before starting or stopping a controller, always positively confirm that there is no critical operation
in progress.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

802 EIO0000001114 06/2020

 Execution Stage

To stop the engine, proceed as follows.

Step Action Result

1 Verify that the engine is connected to the PC –
(see page 723).
2 In the Topology Explorer, right-click the engine The software displays the Confirm Stop dialog box.
that you want to stop and select Stop.
3 Verify the information that is displayed. –
4 Click OK. The software displays the Reconfirm Stop dialog
box.
NOTE: Click Cancel to close the Confirm
Stop dialog box without stopping the engine.
5 Click OK. The software:
 Stops the engine to stop the execution of the
NOTE: Click Cancel to close the Reconfirm
deployed Control participant project.
Stop dialog box without stopping the engine.
 Displays Completed in the notification panel
This reverts to the Confirm Stop dialog box.
once it has successfully completed the
command for the engine, which is identified by
its IP address.
 For a redundant controller, the information
pane displays separate messages for the
primary and the standby engines by using
their respective IP address to identify them.
 Updates the Last Start/Stop Performed On field.

EIO0000001114 06/2020 803

Execution Stage

Synchronizing Redundant Controllers

Overview
The Sync (Primary→Standby) command allows you to manually transfer the deployed Control
Participant project from the primary engine to the secondary redundant engine in case of an
application program, configuration, or data mismatch.
Manual synchronization is only possible when the primary engine is running. The state of the
standby engine does not matter.
The software verifies if the application program or configuration of the primary and the secondary
redundant engines are identical and proceeds with the transfer only if it detects a difference.
It also verifies that there is no project mismatch (see page 791).
The command is available only for entities of the topology that are configured as redundant
controllers.
Refer also to Redundant Controller Deployment and Execution Scenarios (see page 836).

Hot Standby Cable Link

If the Hot Standby cable link between the controllers is broken, synchronization does not complete
successfully, and the software displays a message to inform you of the detected error.

Synchronization Timeout
During synchronization of the standby engine, the software compares the signatures of both the
primary and the standby engines. When they are identical, it considers that the synchronization
completed successfully.
After 3 min, if the comparison does not detect identical signatures, the software displays a dialog
box to inform you that synchronization did not complete successfully and cancels the comparison
process. However, the synchronization itself is not canceled and may still complete after the
timeout.
You can retry synchronizing by using the Sync (Primary→Standby) command.

804 EIO0000001114 06/2020

 Execution Stage

Confirming the Synchronization

Before proceeding with the execution of the command, the software displays the Confirm Sync
(Primary→Standby) dialog box, which contains information about:
 The current state of the primary and standby engines.
 The deployed Control Participant project to transfer to the standby controller.

The following figure shows an example of the Confirm Sync (Primary→Standby) dialog box that
the software displays when you select the Sync (Primary→Standby) command with the primary
controller in Running Primary state.

The table describes the information that is displayed in the Engine Information section of the
Confirm Sync (Primary→Standby) dialog box.

Label Description
Role Role of the engine: A or B.
If the software cannot communicate with the engine, the role is indicated as Not Detected.
Status Status of the engine that is selected for synchronization.
If the status is Not Reachable you cannot proceed with the command. In such case, verify the IP
address, the connection to the engine, and the status of the engine.
IP Identifier of the communication module through which the software sends the command and its IP
Address address that is configured in the Topology Explorer.
If the topological entity has several communication modules, you can select through which one you
want to synchronize.
NOTE: For controllers of the M580 platform, you cannot synchronize an engine by using IP
address A of the CPU module or a NOC communication module. You can only select
main IP address (see page 759).

NOTE: To refresh the engine status and attempt to connect to it, click the reconnect button
(see page 723).

EIO0000001114 06/2020 805

Execution Stage

The table describes the information that is displayed in the Project Information section of the
Confirm Sync (Primary→Standby) dialog box.

Name column Last Deployed Project To Primary Engine / Standby Engines columns
System Identifier of the system that both the engine and the Control project, from which you
have deployed the Participant project last belong to.
Project Identifier of the Control Participant project associated to the deployed Participant project
that you have deployed last.
Executable Identifier of the Control executable that contains the built Participant project that you
have deployed last.
Controller Identifier of the topological entity to which you have deployed the built Participant
project last.
Last Deployed On Date and time when you last deployed the Participant project to the engine or you last
completed the Deploy Changes / Undo Online Changes command, independently if
there were changes to be deployed or not.
Last Start/Stop Date and time when you last started or stopped the engine.
Performed On
Last Online Date and time when you last changed the deployed Participant project by using the
Change Performed Refine Online command; otherwise the field is empty.
On
Last Sync. Date and time when you last synchronized the standby engine with the primary engine
Performed On by using the Synchronize (Primary→Standby) command; otherwise the field is empty.

NOTE: If the software detects that the engine is stopped, it displays the Confirm Sync (Primary→
Standby) dialog box to inform you that the synchronization cannot be completed.

806 EIO0000001114 06/2020

 Execution Stage

Synchronizing the Standby Controller

WARNING
UNINTENDED EQUIPMENT OPERATION
Before starting or stopping a controller, verify that:
 You have assigned a valid IP address to the controller.
 The IP address corresponds to the physical address printed on the hardware.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For more information, refer to Identifying Engines (see page 717).
Unintended situations can occur if the operations that are in progress are not known when acting
on a controller.

WARNING
UNKNOWN OPERATIONAL STATE OF EQUIPMENT
Before starting or stopping a controller, always positively confirm that there is no critical operation
in progress.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

Synchronization of the standby controller (see page 836) may not complete, for example, if the
primary or the standby engine is reserved. In such case, the software displays a message in the
notification panel to inform you.

WARNING
UNINTENDED EQUIPMENT OPERATION
 Verify that deployment to the standby controller completed successfully.
 Do not operate the primary controller if deployment to the standby controller does not complete
successfully.
 Synchronize the standby controller manually, using the Sync (Primary→Standby) command
and verify that the synchronization completed successfully.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000001114 06/2020 807

Execution Stage

To synchronize the standby engine with the primary engine, proceed as follows.

Step Action
1 Verify that the primary engine is connected to the PC (see page 723) and its status is Running
Primary.
2 In the Topology Explorer, right-click the redundant controller that you want to synchronize and
select Sync (Primary→Standby).
Result: The software displays the Confirm Sync (Primary→Standby) dialog box.
3 Verify the information that is displayed.
4 Click OK.
NOTE: Click Cancel to close the Confirm Sync (Primary→Standby) dialog box without
synchronizing.
5 The software displays the Reconfirm Sync (Primary→Standby) dialog box.
6 Click OK.
NOTE: Click Cancel to close the Reconfirm Sync (Primary→Standby) dialog box without
synchronizing. This reverts to the Confirm Sync (Primary→Standby) dialog box .
7 Result: If the software detects no difference in the application program or configuration between
the primary and the standby engines, it does not proceed with the transfer, and displays the
Sync Operation Result dialog box to inform you of the result.
Otherwise, the software:
 Transfers the deployed Control Participant project from the primary engine to the standby
engine.
 Displays Completed in the notification panel once it has successfully completed the
command for the engines, which are identified by their respective IP address.
 Updates the related date/time field.

808 EIO0000001114 06/2020

 Execution Stage

About Changes Made Online

Overview
This topic provides an overview of the workflow of the system engineering life cycle with a focus
on changes that you make during refinement online.
After refining the deployed project online, the logical and the deployed Control Participant projects
are different.
If you refine (offline) the logical Control Participant project later on and deploy these changes, the
operation may undo your online refinements. You have the possibility to preserve online
refinements by transferring them to the logical Control Participant project. However, some online
refinements cannot be transferred or can be transferred only partially.
The table indicates which workflow chart provides the information depending on your objective.

Objective Refer to
Making online refinements persistent in the logical Control Participant project by updating Workflow 1
the project.
Preserving online refinements that cannot be transferred to the logical Control Participant Workflow 2
project
Updating the logical Control Participant project with references to DDDT variables coming Workflow 3
from the topology.

NOTE: For details on using the various commands that allow you to refine online (see page 816),
deploy changes (see page 757), and update the logical Control project (see page 841), refer to the
corresponding topics in the deployment and execution sections.

EIO0000001114 06/2020 809

Execution Stage

Workflow 1
The figure illustrates the typical workflow to make online refinements persistent by transferring
them to the logical Control Participant project.

NOTE: Not updating the logical Control Participant project allows you to undo online refinements
by deploying changes. The software detects the online refinements as change compared to the
logical Control project.

810 EIO0000001114 06/2020

 Execution Stage

This allows you later on to deploy additional changes to the sections that you had modified during
refinement online while preserving online refinements. These changes can come from the
topology, and/or the application, and/or from refinements of the logical Control Participant project.

EIO0000001114 06/2020 811

Execution Stage

Workflow 2
When you make refinements online that you cannot or do not want to transfer to the Control
Participant project, you can make these refinements in a new, separate section (section_2 in this
example). You can unselect this section when deploying changes later on.

812 EIO0000001114 06/2020

 Execution Stage

Making refinements online in a separate section (section_2 in this example) allows you to preserve
them when you deploy changes (to topology, application, or in refinement (offline)) by unselecting
the section that contains the online refinements (section_2).

Workflow 3
After you update the logical Control project with the following online refinements, the Control
Participant reports a detected error during project analysis (see page 449) because the DDDT
variable does not exist in the logical Control project:
 You add a variable that references a DDDT variable, which exists only in the topology
(see page 556).
 You add an instance of an existing DFB type, which references a DDDT variable, which exists
only in the topology.
The solution is:
 When you add a variable that references a DDDT variable:
 Do not use the variable in code that is generated by assigned facets or modified during
refinement (offline) so that a subsequent deployment of changes does not undo online
refinement.
 Use the variable in a separate section (see page 812), which you can unselect during
deployment of changes.
 When you add an instance of an existing DFB type, which references a DDDT variable, build
the Control project. This integrates variables coming from the topology into the built Control
Participant project.

EIO0000001114 06/2020 813

Execution Stage

In this example, variable MyVar1 is created during refinement online. It references the
MOD_ANA_8_1 DDDT variable of a HART analog input module, which comes from the topology.
You cannot transfer MyVar1 nor the MOD_ANA_8_1 DDDT variable to the logical Control project.

In this example, the My_DINPUT DFB instance is created during refinement online from the
DINPUT DFB type, which exists in the logical Control project. My_DINPUT references the
MOD_ANA_8_1 DDDT variable of a HART analog input module, which comes from the topology.
You can transfer the My_DINPUT DFB instance to the logical Control project but the reference to
the DDDT variable is broken.

814 EIO0000001114 06/2020

 Execution Stage

The figure shows how online refinements that reference DDDT variables coming from the topology
affect the deployment and execution workflow.

EIO0000001114 06/2020 815

Execution Stage

Making Changes Online

Overview
The Refine Online command opens the deployed Control Participant project in the Control
Participant, allowing you to change the project when the engine is running or stopped.
You may be able to import sections (see page 829) of the logical Control Participant project that
have been modified and generated since their last deployment.
Online refinement requires using the Build and Deploy subcommand, which is described in
Refining the Deployed Control Participant Project Online (see EcoStruxure™ Process Expert,
Control Participant Services, User Guide).
When you close the Control Participant after deploying changes online, the software lets you
update the associated logical Control Participant project right away with the changes you have
made online. Until you do so, a validity icon (see page 378) is displayed in the corresponding
topological entity folder. It indicates that the logical and the deployed Control Participant projects
are different.
NOTE: To be applied, certain changes that you make online require stopping the controller
(see page 771).

Refining Online with a Station Node

When you select the Refine Online command for a station node, the software may display a
notification asking you to deploy (see page 715) the built Control Participant project to the station
node if the previously deployed project is not loaded anymore into the simulation software that is
installed on this station node.

Preserving Changes Made Online

After selecting the Refine Online command, if deployment of the following online changes does not
complete successfully, then these changes are not discarded:
 Deployment of changes that do not require stopping the engine.
 Deployment of changes that require stopping the engine.

In such case, select the Refine Online command again and continue your work.
NOTE: If the deployment of online changes requires disconnecting the engine, the changes are
discarded.

816 EIO0000001114 06/2020

 Execution Stage

Updating the Control Project with Changes Made Online

Once you have successfully deployed changes made online and close the Control Participant, the
software prompts you to update the associated logical Control Participant project with these
changes. You are not prompted in case you have made changes that require stopping the
controller.
If you accept, the software opens the Update Control Project dialog box (see page 841). From here
on, you follow the same process as when you select the Update Control Project command. The
same restrictions apply.

If you do not accept, the online refinement icon (see page 552) is displayed in the topological
entity folder. It indicates that changes made online need to be applied to the associated logical
Control Participant project to make it consistent with the one that is deployed to the engine. The
icon is displayed independently of the type of change that you make.
The icon is displayed and the software prompts you to update the associated Control Participant
project until you complete the update process.
Refer to the topic describing how to update logical Control Participant projects (see page 841).
NOTE: The icon is also displayed if you accept to update the logical Control Participant project but
cancel the operation, if you update the project only partially, or if the update does not complete
successfully.

Making Changes Online in Separate FBD Sections

When possible, it is good practice to make changes online in separate FBD sections that you
create during online refinement. This is because you cannot transfer to the logical Control
Participant project certain changes. It also applies when you do not update the logical Control
Participant project after making changes online.
It helps you preserve changes that you have made online when you deploy changes
(see page 758) after building the logical Control Participant project.

EIO0000001114 06/2020 817

Execution Stage

Viewing the Application Structure When Making Changes Online

When you modify a Control Participant project online, the Application Browser displays FBD
sections based on the location of instances whose Control facets are assigned to these sections.
It shows the relationship between the folder structure of the application and the sections of the
Control Participant project. This is useful, for example, when you want to modify the logic related
to a specific area or subdivision of the application. You can open sections from the pane.
The pane only shows FBD and non-FBD sections of the Control Participant project that are
deployed at the moment you select the Refine Online command.
For a general description of the contents of the pane, refer to the topic describing the application
structure view (see page 429).
For information on how to use the pane, refer to the topic describing the refinement of Control
Participant projects online (see EcoStruxure™ Process Expert, Control Participant Services, User
Guide).
For general information on how to work with panes, refer to the topic describing the engineering
client workspace (see page 127).

Confirming the Command

When you select the Refine Online command, before you can proceed with the online editing, the
software displays the Confirm Refine Online dialog box, which contains information about:
 The engine whose program you want to refine online.
 The Control Participant project that is deployed to the engine.

818 EIO0000001114 06/2020

 Execution Stage

The figure shows an example of the Confirm Refine Online dialog box for a redundant controller.

The table describes the information that is displayed in the Engine Information section of the
Confirm Refine Online dialog box.

Label Description
Role(1) Role of the engine: A or B.
If the software cannot communicate with the engine, the role is indicated as Not Detected.
Status Status of the engine that is selected for online refinement.
If the status is Not Reachable or Stop Offline(2) you cannot proceed with the command. In such
case, verify the IP address, the connection to the engine, or the status of the engine.
IP Address Identifier of the communication module through which the software sends the command and its
IP address that is configured in the Topology Explorer.
If the engine has several communication modules, you can select one.
NOTE: For controllers of the M580 platform, you cannot connect to an engine by using IP
address A of the CPU module or a NOC communication module. You can only select
main IP address (see page 759).
(1) Displayed only when you select the command for a redundant controller.
(2) Stop for controllers of the M580 platform.

NOTE: To refresh the engine status and attempt to connect to it, click the reconnect button
(see page 723).

EIO0000001114 06/2020 819

Execution Stage

The table describes the information that is displayed in the Project Information section of the
Confirm Refine Online dialog box.

Name column Last Deployed Project column(2)

System Identifier of the system that both the engine and the Control project, from which you
have deployed the Participant project last belong to.
Project Identifier of the Control Participant project associated to the deployed Participant
project that you have deployed last.
Executable Identifier of the Control executable that contains the built Participant project that you
have deployed last.
Controller Identifier of the topological entity to which you have deployed the built Participant
project last.
Last Deployed On Date and time when you last deployed the Participant project to the engine or you last
completed the Deploy Changes / Undo Online Changes command, independently if
there were changes to be deployed or not.
Last Online Change Date and time when you last changed the deployed Participant project by using the
Performed On Refine Online command; otherwise the field is empty.
Last Sync. Date and time when you last synchronized the standby engine with the primary engine
Performed On(1) by using the Synchronize (Primary→Standby) command; otherwise the field is empty.
(1) Displayed only when you select the command for a redundant controller.
(2) When you select the command for a redundant controller, the dialog box shows separate columns for the
primary and the standby engines.

Making Changes Online

WARNING
UNINTENDED EQUIPMENT OPERATION
Before deploying to an engine, verify that you have selected the correct project files.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

WARNING
UNINTENDED EQUIPMENT OPERATION
Before starting or stopping a controller, verify that:
 You have assigned a valid IP address to the controller.
 The IP address corresponds to the physical address printed on the hardware.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: For more information, refer to Identifying Engines (see page 717).

820 EIO0000001114 06/2020

 Execution Stage

Unintended situations can occur if the operations that are in progress are not known when acting
on a controller.

WARNING
UNKNOWN OPERATIONAL STATE OF EQUIPMENT
Before starting or stopping a controller, always positively confirm that there is no critical operation
in progress.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

When you deploy changes to a redundant controller, although deployment to the primary controller
succeeded, it is possible that synchronization of the standby controller (see page 836) does not
complete. In such case, the software displays a message in the notification panel to inform you.

WARNING
UNINTENDED EQUIPMENT OPERATION
 Verify that deployment to the standby controller completed successfully.
 Do not operate the primary controller if deployment to the standby controller does not complete
successfully.
 Synchronize the standby controller manually, using the Sync (Primary→Standby) command
and verify that the synchronization completed successfully.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

When you make changes by online refinement, the associated logical and built Control Participant
projects do not contain these changes. To preserve these changes during a next deployment, you
need to integrate them into the built Control Participant project first by updating the logical Control
Participant project (see page 841) and building it; otherwise, the changes are discarded.

WARNING
LOSS OF DATA
After building and deploying changes made during online refinement, update the associated
logical Control Participant project.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

EIO0000001114 06/2020 821

Execution Stage

To edit the deployed Control Participant project online, proceed as follows.

Step Action Result

1 Verify that the engine is connected to the PC –
(see page 723) and that it is running or stopped.
2 In the Topology Explorer, right-click the engine and The software displays the Confirm Refine
select Refine Online. Online dialog box.
3 Verify the information that is displayed. –
4 Click OK. The software displays the Reconfirm Refine
Online dialog box.
NOTE: Click Cancel to close the Confirm Refine
Online dialog box without editing the Participant
project.
5 Click OK. The Control Participant opens extracted
(see page 134) and maximized.
NOTE: Click Cancel to close the Reconfirm Refine
Online dialog box without editing the Participant
project. This reverts to the Confirm Refine Online
dialog box.
6 Proceed with changes or import of sections in the –
deployed Control project inside the Control
Participant UI (see EcoStruxure™ Process Expert,
Control Participant Services, User Guide).
7 Close the Control Participant window. The software displays the Refine Online dialog
box prompting you to update the associated
logical Control Participant project with the
changes you have made online if applying these
changes did not require stopping the controller.
NOTE: Not updating the associated logical
Control Participant project may result in losing
online refinement changes during next
deployments.
8 Click Yes. The software opens the Update Control Project
dialog box, which allows you to view and select
NOTE: Click No to close the Refine Online dialog
changes made online that you can transfer to
box without updating the logical Control Participant
the associated logical Control Participant
project and to display a validity icon (see page 378)
project.
in the associated topological entity folder.
9 Follow the procedure to update logical Control –
Participant projects (see page 841).

NOTE: If you close the Control Participant window without making changes online, the software
may still display the Refine Online online dialog box, which prompts you to update the associated
Control project. This is the case if you had made changes online previously, which you have not
yet applied to the associated logical Control Participant project. The online refinement icon is also
displayed in the associated topological entity folder to indicates this.

822 EIO0000001114 06/2020

 Execution Stage

Backing Up Controller Data

Overview
The Back Up Data command lets you back up and save to file (.DTX) the following controller data:
 Located data of boolean type (%M).
 Located data of WORD type (%MW).
 Unlocated variables.
 Unlocated function block instances (DFB and EFB).

The functionality is available once you have deployed a built Control Participant project to a
controller or station node of the system.
Data backup files:
 Are associated to information such as a time stamp, which lets you select the correct file to
deploy data again (see page 750) and manage backup files (see page 335).
 Retain your backup settings making it easy to reuse the same settings for subsequent backup
operations on the same deployed executable.
 Can be exported and imported (see page 310) with the Control Participant project.

NOTE: For more information, refer to Save/Restore Data Between a File and the PLC in the help
of the Control Participant (see page 104).

Backing Up Data with Redundant Controllers

For redundant controllers, back up of data is possible only from the primary controller.
To be able to back up data from the primary controller, the standby controller must be reachable
at the IP address that is configured. It may not be reachable, for example, because it is switched
off or the Hot Standby cable is removed.
Only if the ControllerExist property (see page 558) is set to Primary you can back up data from the
primary controller while the standby controller is not reachable.
NOTE: The status of the standby controller is not shown in the Confirm Back Up Data dialog box.

Backup File Identification

When the software creates a backup file, it associates the following information to the file:
 A date/time stamp.
 A description entered by the user.
 The name of the user who is logged on to the client.
 Identifiers of the controller, the Control Participant project, and the executable.
 The type of data that is backed up.

This information is shown for existing backup files when you select the Deploy Data command.

EIO0000001114 06/2020 823

Execution Stage

NOTE:
 When you delete a Control Participant project or a controller, its data backup files are deleted
as well.
 If you change the identifier of a controller or executable, or the role of a controller, the identifi-
cation information of the corresponding backup file is not modified.

Controller and Controller Data Information

Before proceeding with the backup of controller data, the software displays information in the
Confirm Back Up Data dialog box about:
 The executable whose data you want to back up.
 The associated Control Participant project.
 The engine to which the executable is deployed.

This dialog box lets you also select the data that you want to back up.
The following figure shows an example of the Confirm Back Up Data dialog box for a standalone
controller.

824 EIO0000001114 06/2020

 Execution Stage

The following figure shows an example of the Confirm Back Up Data dialog box for a redundant
controller.

The table describes the information that is displayed in the Engine Information section of the
Confirm Back Up Data dialog box.

Label Description
Controller (1) You can perform the backup only from the primary controller.
Default value: Primary
Role(1) Role of the selected controller: A or B.
If the software cannot communicate with the engine, the role is indicated as Not Detected.
Status Status of the engine that is selected for backup.
If the status is Not Reachable, you cannot proceed with the deployment. In such case, verify
the IP address, the connection to the engine, and the status of the engine.
NOTE: If the status is Running, a notification is displayed in the dialog box to inform you
about a possible desynchronization of the backed up data.
(1) Displayed only when you back up data from a redundant controller.

EIO0000001114 06/2020 825

Execution Stage

Label Description
IP Address Identifier of the communication module through which the software will back up data and its
IP address that is configured in the Topology Explorer.
If the topological entity has several communication modules, you can select which one you
want to use.
Default value: IP address that was selected for the last deployment operation to this engine.
NOTE: For controllers of the M580 platform, you cannot back up data from the CPU module
or through a NOC communication module by using IP address A. You can only select
main IP address (see page 759).
(1) Displayed only when you back up data from a redundant controller.

NOTE: To refresh the engine status and attempt to connect to it, click the reconnect button
(see page 723).
The table describes the information that is displayed in the Project Information section of the
Confirm Back Up Data dialog box.

Label Description
Control Project Identifier of the Control Participant project associated to the executable that you have
deployed last.
Executable Identifier of the Control executable that contains the built Participant project that you have
deployed last.
Description You need to enter a description for the backup file by using free form text to be able to
proceed with the backup.

The table describes the information that is displayed in the Controller Data section of the Confirm
Back Up Data dialog box.

Section Description
Located Data Select the check boxes depending on the type of located variables that you want to back up
to file:
 %M: When selected, backs up located boolean variables. You need to provide the
memory range to be backed up.
Default range: 0 to maximum configured memory size -1.
 %MW: When selected, backs up located variables of WORD data type. You need to
provide the memory range to be backed up.
Default range: 0 to maximum configured memory size -1.
NOTE: The maximum configured memory size depends on the memory configuration of
located data of the CPU module of the controller to which the Control project is deployed.
Selecting/clearing the Located Data check box also selects/clears the other check boxes in
this section.
Default value for first data backup for an executable: True (selected). If you have already
performed a data backup operation for the same executable, your last settings are retained.
The settings are reset when you restore a system or import the topology.

826 EIO0000001114 06/2020

 Execution Stage

Section Description
Unlocated Select the check boxes depending on the type of located variables that you want to back up
Data to file:
 Variable instances: When selected, backs up unlocated variable instances.
 Function block instances (DFB and EFB): When selected, backs up unlocated function
block instances.
Selecting/clearing the Unlocated Data check box also selects/clears the other check boxes
in this section.
Default value for first data backup for an executable: True (selected). If you have already
performed a data backup operation for the same executable, your last settings are retained.
The settings are reset when you restore a system or import the topology.

Control Project Signature Verification

Before executing the command, the software compares the Control Participant project that is
deployed in the engine with the last deployed reference (see page 715), which is the Control
Participant project residing in the software.
If they are identical, the command is executed. If they differ, the software starts a recovery process
first. This process may take several minutes to complete.
In case the software displays a notification about a signature mismatch, the command cannot be
executed. Contact Schneider Electric support (see page 117).

Backing Up Controller Data

Unintended situations can occur if the operations that are in progress are not known when acting
on a controller.
Backing up data when the controller is in RUN state may take several scan cycles and the backed
up data may be desynchronized. This adversely affects program execution when the backed up
data is deployed to the controller.

WARNING
UNINTENDED EQUIPMENT OPERATION
Before backing up data from the controller, verify that the controller state does not jeopardize data
integrity when the data is backed up.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

NOTE: Schneider Electric recommends backing up data while the controller is in STOP state.

EIO0000001114 06/2020 827

Execution Stage

To back up the controller data, proceed as follows.

Step Action
1 Verify that the engine can communicate with the PC (see page 723).
2 In the Topology Explorer, right-click the entity whose data you want to back up and select the
Back Up Data command.
Result: The software opens the Confirm Back Up Data dialog box.
3 In the IP Address field, verify that the communication module identification is correct.
4 Verify the status of the engine in the Status field.
NOTE: Backup is possible only if the status of the engine is indicated as either RUN, STOP
(recommended), or WAIT (OFFLINE for Hot Standby controllers of the Quantum platform).
5 Verify the information that is displayed in the Project Information section.
6 Enter a description for the backup file.
7 Configure the data that you want to back up in the Controller Data section.
8 Click OK.
Result: The Reconfirm Back Up Data dialog box opens.
NOTE: Click Cancel to close the Confirm Back Up Data dialog box without backing up data.
9 Click OK.
Result:
 The software backs up the selected controller data and creates the corresponding backup
file.
 It provides information about the backup operation in the notification panel (or in a dialog box
in case the operation did not succeed).
NOTE: Click Cancel to close the Reconfirm Back Up Data dialog box without backing up data.

828 EIO0000001114 06/2020

 Execution Stage

Importing Sections from the Logical Control Participant Project

Overview
It is possible to import FBD sections directly from the logical Control Participant project to help
speed up the implementation of changes during commissioning. This is achieved by skipping the
build and deployment stages of the system engineering life cycle.
The import functionality allows you to import into the deployed Control project, FBD sections of the
corresponding logical Control Participant project, which you have modified since they were
deployed last. The modifications need to be generated (see page 487) to be imported.
The time stamp of the last generation of a section (see page 393) is used as reference.
Changes made to a section by using the Refine command can be imported only if you have
generated the section afterwards.
Refining a section by using the Refine command after generating it disables the possibility to import
it.
Variables and types that are not used anymore after an import are not removed.
NOTE: If the section that you import has the same name as a section in the deployed Control
project, it replaces the existing section. As a result, changes you had made in the section are
overwritten.

Section Import Functionality in the System Engineering Life Cycle

In the following figure, the dotted line shows the scope of the section import functionality in the
context of the system engineering life cycle. Modifications that you make after generating a section
and that pertain to the refinement, mapping, and build stages cannot be imported.

EIO0000001114 06/2020 829

Execution Stage

Section Import Window

The figure shows an example of the section import window, which opens when you click the section
import button in the toolbar of the Control Participant window during online refinement.

1 Check box to select or clear all the sections displayed in the import window. A black square
inside the check box indicates that at least one section is not selected.
2 Check box to select or clear sections individually.
3 Identifier of sections of the corresponding logical Control project, which have been modified and
generated since the build Control project was last deployed to the engine. A section appears
only if the change is supported (see page 831) by the section import functionality. Sections are
listed in ascending Order (Containers pane of the Assignment Editor).
4 Value of the Generated On property of the section.
5 Filter (see page 138) for the Section column.

Attributes Related to HAL and Network Variables

When you import a section that contains a variable generated by a HAL template (for example, a
signal conditioning template) or peer to peer communication templates (for example,
$DOUTBool_UL and $DINBool_UL, which generate a variable with P2P as custom attribute), and
the section and variable already exist in the deployed Control project, the Address and Value
attributes of the variable are not modified by the import operation.

Online Refinement Indicator

When you import a section, build, and deploy the change, the online refinement icon

(see page 552) is displayed and you are prompted to update the associated logical Control
project. However, if you have not made any other change apart from importing the section, the
logical Control project is already up-to-date. Accepting to update the logical Control project
displays a message informing you that no changes are detected.

830 EIO0000001114 06/2020

 Execution Stage

Changes to Sections That Can Be Imported During Online Refinement

The table indicates whether a section can be imported during online refinement depending on the
change that you have made. It is assumed that the section is generated after making the change
(if required to apply the change).

Change description Allows importing Comment

the section
Assigning a facet to the section. Yes –
Unassigning a facet from the section. Yes –
Actions resulting in a change of the status of a facet. Yes Except unlinking and relinking a
facet.
Regenerating the section (independently if changes Yes –
were made in the section before regenerating).
Renaming the section. Yes The renamed section is imported
as a new section. The section with
the original name that existed
remains.
Changing the order of sections. Yes –
Creating a new section without assigning facets. Yes –
Renaming a variable (for example, by changing the Yes The renamed variable is created as
identifier of the instance referencing the facet that a new variable. The variable with
creates the variable). The variable and section the original name that existed
already exist in the deployed Control project. remains.
Creating a section and making a change by using the Yes The section is imported and also
Refine command (for example, adding a function contains the change you had made
block). Then, making a change in the section that can through refinement.
be imported (for example, assigning a facet).
Making a change in a section that can be imported Yes The section in the deployed
(for example, assigning a facet) while a section with Control project is replaced by the
the same name already exists in the deployed imported section.
Control project.
Changing the order of facets inside the section. No –
Deleting a section to which facets are assigned and No You cannot remove a section from
that is generated. the deployed Control project by
using the section import
functionality.
Making a change in the section that can be imported No –
(for example, assigning a facet), then making a
change in the section by using the Refine command
(for example, adding a function block or modifying a
variable used in this section).

EIO0000001114 06/2020 831

Execution Stage

Change description Allows importing Comment

the section
Making changes in a section that can be imported No The changes are already applied to
and deploying these changes by using the Deploy the deployed Control Participant
Changes / Undo Online Changes command. project.
If you have made changes that can
be imported in more than one
section but have not selected all
these sections during deployment
of changes, the sections that you
have not selected appear as
candidates for import.
1. Deploying a section. No You have deployed a change to a
2. In the Project Explorer making a change in the section that you want to import
section that can be imported (for example, after generating this section.
assigning additional facets).
3. Making a change in this section in the deployed
Control project by using the Refine Online
command and applying it by clicking the button to
build and deploy (for example, removing a DFB).

Importing Sections from the Logical Control Participant Project

Refer to the topic describing how to refine the deployed Control project online (see EcoStruxure™
Process Expert, Control Participant Services, User Guide).

832 EIO0000001114 06/2020

 Execution Stage

Main Redundant Controller Scenarios

Overview
This topic outlines the sequence of actions performed by the software when executing commands
of the context menu of a redundant controller entity, which is composed of one primary and one
standby engine. IP addresses IP and IP + 1 are assigned respectively to each engine.
Other scenarios are described in the topic documenting redundant Controller reservation and
connection scenarios (see page 836).

Deployment and Re-Deployment Sequence of Actions

Various deployment and re-deployment scenarios are considered depending on the status of the
engines of the redundant controller before and after successful deployment.
Deployment is considered to require stopping engines.
Scenario 1: Both engines are stopped. No start after deployment.

Actions
1 Deployment to IP + 1.
2 Deployment to IP.

Scenario 2: Both engines are stopped. Engines are started after deployment.

Actions
1 Deployment to IP.
2 Start of IP.
3 Synchronization of IP + 1.
4 A successful synchronization starts IP + 1.

Scenario 3: Both engines are running. No start after deployment.

Actions
1 Stop of IP + 1.
2 Deployment to IP + 1.
3 Stop of IP.
4 Deployment to IP.

EIO0000001114 06/2020 833

Execution Stage

Scenario 4: Both engines are running. Engines are started after deployment.

Actions
1 Stop of IP + 1.
2 Stop of IP.
3 Deployment to IP.
4 Start of IP.
5 Synchronization of IP + 1.
6 A successful synchronization starts IP + 1.

Deployment of Changes and Online Refinement Sequence of Actions

Various scenarios for deploy changes and refine online are considered depending on:
 The status of the redundant controller before and after successful deployment.
 The need to stop the controller.
 The need to disconnect the engine.
 The status of the redundant controller after successful deployment.

Scenario 5: IP is stopped. Disconnection required. No start after deployment.

Actions
1 Disconnection of IP.
2 Project is rebuilt.
3 Deployment as per deployment scenarios 1 or 2.

Scenario 6: IP is stopped. Disconnection not required. Engines started after deployment.

Actions
1 Deployment as per deployment scenario 2.

Scenario 7: IP is stopped. Disconnection not required. No start after deployment.

Actions
1 Changes are built in IP.

Scenario 8: IP is stopped. Disconnection not required. No start after deployment.

Actions
1 Changes are built in IP.
2 Deployment to IP + 1.

834 EIO0000001114 06/2020

 Execution Stage

Scenario 9: IP is running. Engine stop not required. Disconnection not required.

Actions
1 Changes are built in IP.
2 Synchronization of IP + 1.

Scenario 10: IP is running. Engine stop required. Disconnection not required. Engines started after
deployment

Actions
1 Deployment as per deployment scenario 4.

Scenario 11: IP is running. Disconnection not required. Engine stop required. No start after
deployment

Actions
1 Stop of IP + 1.
2 Stop of IP.
3 Changes are built in IP.

Scenario 12: IP is running. Disconnection required. Engine stop not required. No start after
deployment.

Actions
1 Disconnection of IP.
2 Project is rebuilt.
3 Deployment as per deployment scenarios 3 or 4.

EIO0000001114 06/2020 835

Execution Stage

Redundant Controller Reservation and Connection Scenarios

Overview
This topic describes the actions that the software performs on the primary and standby engines for
each deployment and execution command, depending on:
 The reservation state of the engine.
 The status of the connection to the engine.
 The status of the engine.

It is considered that the redundant controller is composed of a primary and a standby engine to
which IP addresses IP and IP + 1 are assigned respectively.

For the Deploy Built Project and Re-Deploy Last Project Commands
The table describes the actions that the software performs on the primary and standby engines
when you select the Deploy Built Project and Re-Deploy Last Project commands.

Engine Controller IP Controller Action Executed by the Comment

Externally Connected IP + 1 software on Engine
Reserved (Controller State) Connected
(Controller State)
Primary Standby
primary true indifferent no action Primary engine is reserved.
standby true (stopped) true deployment no action Standby engine is reserved.
standby true (running) true no action Standby engine is reserved
and cannot be stopped.
none false indifferent no action Unable to connect to
controller IP.
none true (running) false no action Unable to connect to
controller IP + 1.
none true (stopped) false deployment no action Unable to connect to
controller IP + 1.
none true true deployment to both If the engines need to be
stopped for the deployment,
the software stops the
primary engine even if the
standby engine is already
stopped, given that:
 none of the engines is
reserved
 the connection status for
both engines is true

836 EIO0000001114 06/2020

 Execution Stage

For the Deploy Changes/Undo Online Changes Command

The table describes the actions that the software performs on the primary and standby engines
when you select the Deploy Changes/Undo Online Changes command.

Engine Controller IP Controller Action Executed by the Comment

Externally Connected IP + 1 software on Engine
Reserved (Controller Connected
State) (Controller
State)
Primary Standby
primary true indifferent no action Primary engine is reserved.
none false indifferent no action Unable to connect to
controller IP.
standby true indifferent no action Standby engine is reserved.
none true (stopped) indifferent deployment of no action No synchronization of
changes standby controller because
primary controller is stopped.
none true (running) true deployment of changes If the engines need to be
stopped for the deployment of
changes, the software stops
the primary engine even if the
standby engine is already
stopped, given that:
 none of the engines is
reserved
 the connection status for
both engines is true

For the Start Command Only

The table describes the actions that the software performs on the primary and standby engines
when you select the Start command.

Engine Controller IP Controller Action Executed by the Comment

Externally Connected IP + 1 software on Engine
Reserved (Controller State) Connected
(Controller State)
Primary Standby
primary true (running) indifferent no action Primary engine is already
running.
primary true (stopped) indifferent no action Primary engine is reserved.

Refer to For the Start and Stop Command (see page 838) for additional scenarios.

EIO0000001114 06/2020 837

Execution Stage

For the Stop Command Only

The table describes the actions that the software performs on the primary and standby engines
when you select the Stop command.

Engine Controller IP Controller Action Executed by the Comment

Externally Connected IP + 1 software on Engine
Reserved (Controller Connected
State) (Controller
State)
Primary Standby
primary true (stopped) indifferent no action Primary engine is already
stopped.
primary true (running) indifferent no action Primary engine is reserved.
none true (running) true (stopped) Stop no action
standby true (running) true (running) no action Standby engine is reserved
and cannot be stopped.
Stopping primary engine
causes switchover.
none true (running) false no action Unable to connect to
controller IP + 1.
none true (running) true (running) stop The software stops in the
following order:
 the standby engine
 the primary engine

Refer to For the Start and Stop Command (see page 838) for additional scenarios.

For the Start and Stop Commands

The table describes the actions that the software performs on the primary and standby engines
when you select the Start or Stop command.

Engine Controller IP Controller Action Executed by the Comment

Externally Connected IP + 1 software on Engine
Reserved (Controller Connected
State) (Controller
State)
Primary Standby
standby true true no action Standby engine is reserved.
none false indifferent no action Unable to connect to
controller IP.
none true false no action Unable to connect to
controller IP + 1.

838 EIO0000001114 06/2020

 Execution Stage

For the Refine Online Command

The table describes the actions that the software performs on the primary and standby engines
when you select the Refine Online command.

Engine Controller IP Controller Action Executed by the Comment

Externally Connected IP + 1 software on Engine
Reserved (Controller Connected
State) (Controller
State)
Primary Standby
primary true indifferent no action primary engine is reserved.
standby not required true no action standby engine is reserved.
StandbyLater (1) true indifferent no action standby engine is reserved.

StandbyLater(2) true indifferent no action or no action No synchronization of

deployment standby because reserved.
Changes may have been
deployed to primary engine.
none false indifferent no action Unable to connect to
controller IP.
none true true deployment of project If the engines need to be
changes stopped for the deployment of
online changes, the software
stops the primary engine
even if the standby engine is
already stopped, given that:
 none of the engines is
reserved
 the connection status for
both engines is true

(1) The engine is reserved after the software opens the Control Participant window in the Topology
Explorer.
(2) The engine is reserved after the software executes the Build & Deploy (see page 790)
subcommand.

EIO0000001114 06/2020 839

Execution Stage

For the Sync (Primary→Standby) Command

The table describes the actions that the software performs on the primary and standby engines
when you select the Sync (Primary→Standby) command.

Engine Controller IP Controller Action Executed by the Comment

Externally Connected IP + 1 software on Engine
Reserved (Controller Connected
State) (Controller
State)
Primary Standby
primary true indifferent no action primary engine is
reserved.
standby true true no action standby engine is
reserved.
none false indifferent no action Unable to connect to
controller IP.
none true false no action synchronize –
standby

840 EIO0000001114 06/2020

 Execution Stage

Updating the Logical Control Participant Project

Overview
The Update Control Project command allows you to apply to the logical Control Participant project
changes that you have made online (see page 809) to the corresponding deployed Participant
project. You must have made the changes by using the Refine Online (see page 816) command.
An indication that online changes need to be applied to the logical Control Participant project is
given by a validity icon (see page 378) that is displayed in the associated topological entity folder.
You can apply changes pertaining to the following categories:
 Animation tables
 Operator screens
 Sections
 Types
 Variables

Applicable restrictions are described in this topic.

When you select the Update Control Project command, the software compares the deployed
Participant project that is currently loaded in the engine with the corresponding logical Participant
project and identifies differences.
The software allows you to select, which of the identified changes you want to apply.
You can request the software to perform a consistency check before updating the logical
Participant project.
If you changed the logical Participant project since the deployment, executing the Update Control
Project command may override some of these changes.
NOTE: Build the Participant project (see page 688) to which you have applied changes using the
Update Control Project command to be able to deploy these changes.

EIO0000001114 06/2020 841

Execution Stage

Confirming the Command

When you select the Update Control Project command, before you can proceed with the selection
of changes, the software displays the Confirm Update Control Project dialog box, which contains
information about:
 The engine from which you are updating the Control Participant project.
 The Control Participant project that is deployed to the engine.

842 EIO0000001114 06/2020

 Execution Stage

The following figure shows an example of the Confirm Update Control Project dialog box for a
redundant controller.

The table describes the information that is displayed in the Engine Information section of the
Confirm Update Control Project dialog box.

Label Description
Role (1) Role of the engine: A or B.
If the software cannot communicate with the engine, the role is indicated as Not
Detected.
Status Status of the engine that is selected to update the Control Participant project from.
If the status is Not Reachable you cannot proceed with the command. In such case,
verify the IP address, the connection to the engine, and the status of the engine.
IP Address Identifier of the communication module through which the software sends the
command and its IP address that is configured in the Topology Explorer.
If the engine has several communication modules, you can select one.
(1) Displayed only when you select the command for a redundant controller.

NOTE: To refresh the engine status and attempt to connect to it, click the reconnect button
(see page 723).

EIO0000001114 06/2020 843

Execution Stage

The table describes the information that is displayed in the Project Information section of the
Confirm Update Control Project dialog box.

Name column Selected Project column

System Identifier of the system that both the engine and the Control project belong to.
Project Identifier of the Control Participant project associated to the deployed Participant
project.
Executable Identifier of the Control executable that contains the built Participant project.
Controller Identifier of the topological entity from which you are updating the logical Control
Participant project.
Last Deployed On Date and time when you last deployed the Participant project to the engine or you
last completed the Deploy Changes / Undo Online Changes command,
independently if there were changes to be deployed or not.
Last Online Change Date and time when you last changed the deployed Participant project by using the
Performed On Refine Online command; otherwise the field is empty.
Last Control Project Date and time when you last modified the logical Control Participant project by using
Modified On the Generate or Refine command.
Last Sync. Performed Date and time when you last synchronized the standby engine with the primary
On(1) engine by using the Synchronize (Primary→Standby) command; otherwise the field
is empty.
(1) Displayed only when you select the command for a redundant controller.

NOTE: The Confirm Update Control Project dialog box is not displayed if you choose to update the
logical Control Participant project when prompted after completing a refine online operation
(see page 817).

Updating with Changes Other Than FBD Language

The table describes the effect of the Update Control Project command on items other than FBD
language.

Item Effect
Non-FBD Details of changes inside non-FBD sections that the software has detected are not shown. Only
sections the name of the section is displayed.
When selected, such sections are either updated, added, or removed from the logical Control
Participant project.
NOTE: If you update the logical Control Participant project with code in LL984 language added
during online refinement and you had not selected the Ladder Logic 984 (LL984) setting in the
Control Participant before deploying, the validity icon (see page 378) is displayed after the
update.
To be able to build the logical Control Participant project select the Ladder Logic 984 (LL984)
setting in project containing the configuration of the controller (see EcoStruxure™
Process Expert, Control Participant Services, User Guide) that is mapped to the executable of
this Control project.

844 EIO0000001114 06/2020

 Execution Stage

Item Effect
Animation The software does not detect changes to such items.
tables The software displays any animation tables and/or operator screens that the deployed
Participant project contains, including modified and/or new ones. Animation tables and/or
Operator
operator screens that you have deleted from the deployed Participant project are not shown.
screens
You cannot select individual items but only the category for transfer to the logical Participant
project.
When you select a category, any animation tables or operator screens of the logical Control
Participant project are overwritten with the ones contained in the deployed Participant Project.
By default, both categories are not selected.
NOTE:
 Overwriting of an existing operator screen creates a copy of the screen in the logical
Participant project. Following the update, use the Refine command to edit the categories and
make their contents consistent with the deployed Control Participant project.
 Animation tables and/or operator screens that you have removed from the deployed
Participant project are not removed from the logical Participant project by using the
command. Use the Refine command to delete them.

Updating with Changes to Variables

The table describes the behavior of the software when you update a logical Control Participant
project, depending on the changes that you have made to variables contained in the deployed
Control Participant project.

Variables in the Deployed Control Behavior

Project
Variables with HAL (see page 699) or No changes to their attributes are updated in the logical Control
P2P (see page 534) as Custom Participant project.
attribute.
Variables without HAL (see page 699) Any attributes of such variables that you add or modify during
as Custom attribute. refinement online are updated in the logical Control Participant
project, except for the Address or Value attributes if it corresponds
to or references a topological address.
NOTE: For more information on variables using the Value attribute
for topological addressing, refer to the topic describing REF_TO type
variables (see EcoStruxure™ Process Expert, Control Participant
Services, User Guide).
Device DDT variables These variables (and any of their attributes) coming from the
configuration are not transported to the logical Control Participant
project.
Therefore, if you add code during refinement online (see page 809)
that uses this type of variable, you can update the logical Control
Participant project with that code but not with the variable itself. This
causes the code to become invalid.

EIO0000001114 06/2020 845

Execution Stage

Updating with Changes to Sections Containing HAL DFBs

You cannot transfer to the logical Control Participant project any changes that you have made or
code that you have added to sections containing HAL DFB instances (see page 699).

Changes That Cannot Be Transferred to Control Projects

You cannot transfer to the logical Control Participant project changes pertaining to any of the
following categories:
 Control project settings (refer to the Control Participant help, Operating Modes).
 SR sections.
 Properties of MAST and FAST tasks.
 Properties of MAST and FAST sections(1).
 Timer and I/O event tasks.
 Alias of attribute of variables for Modicon X80 I/O modules (reference to the Device DDT
variable).
(1) Except for changes in the Comment tab.

Identifying Project Changes

Before proceeding with the update, the software displays the Update Control Project dialog box,
which provides information about the differences that it has detected between the deployed
Participant project and the logical Participant project. It also allows you to select, which changes
you want to apply to the logical Control Participant project.
The software can only update the logical Participant project with changes that pertain to a category
displayed in the Name column of the Update Control Project dialog box. Changes that are not
detected or that are detected but that cannot be selected are not transferred.
When the software detects no changes, it does not display the Update Control Project dialog box
but instead, shows a message to inform you that it has found no changes. This is the case if, for
example, only a timer event was added during online refinement.
NOTE: When you select a section in order to apply changes to this section in the logical Control
Participant project, the software overrides the refinements that you made in this section after the
deployment. See also the topic that describes the impact of a Control project update
(see page 850) on sections that you have created after deployment.
NOTE: Restrictions may apply when updating variables (see page 845).

846 EIO0000001114 06/2020

 Execution Stage

The following figure shows an example of the Update Control Project dialog box that the software
displays.

EIO0000001114 06/2020 847

Execution Stage

1 Check box to request that the software performs a consistency check (see page 849) on the
selected items before proceeding with the update of the logical Control Participant project. By
default, the option is not selected.

Header Description
Check boxes By default, changes detected by the software are unselected.
Select items that you want to update in the logical Control Participant project.
A green square inside the check box in the column header indicates that, at least, 1 item
that the software has detected as a difference is still unselected.
NOTE: You cannot select sections that contain HAL DFB instances (see page 699).
Name Identifier of the item that the software has detected as a difference.
Items are displayed in 1 of the following categories:
 Animation Table
 Operator Screens
 Sections
 Types
 Variables

Action Indicates the action that the software will carry out for the item:
 Plus icon: The item is added to the logical Participant project.
 Minus icon: The item is removed from the logical Participant project.
 Pencil icon: The item is modified compared to the logical Participant project.

NOTE: When you select a section, the software applies any changes that it has identified
for this section. You cannot select/unselect changes individually inside a section.
Type Type of the item.
DataType Data type of the item, if applicable.
Change For FBD sections, variables and types, indicates whether the change that the software has
Description identified is an addition, a modification, or a deletion compared to the logical Participant
project.

NOTE: If the software does not detect a difference between the deployed Participant project and
the corresponding logical Participant project in a category of the Update Control Project dialog box,
no entry appears under that category.

848 EIO0000001114 06/2020

 Execution Stage

Checking Consistency
Select the corresponding check box in the Update Control Project dialog box for the software to
perform a consistency check (see page 523) before proceeding with the update of the logical
Participant project.
In such case, the software displays the Check Consistency dialog box to show, for the changes
that you have selected in the Update Control Project dialog box:
 The sections that contain constituents that are inconsistent.
 For each section, the facets that are assigned to the section and generate the corresponding
constituents.
 For each facet, a description of the inconsistency.

Select the check box next to a facet to unlink (see page 480) it.
If the check box of a facet is cleared, the generation status of the facet remains Inconsistent
(see page 480).
During a subsequent generation (see page 489) of the updated logical Participant project, the
software:
 Does not modify constituents of facets that are unlinked.
 Attempts to restore constituents of facets that are inconsistent.

By default, no items are selected.

NOTE: If the software does not detect inconsistencies, it does not display the Check Consistency
dialog box.

EIO0000001114 06/2020 849

Execution Stage

Updating After Creating Sections in the Logical Control Project Without Deploying Them
After updating the logical Control project, a section is moved to the end of sections in this project
(highest order value) if the following conditions are fulfilled:
 The logical Control project is deployed.
 You create a section either in the Project Explorer or during refinement (offline) post
deployment.
 You do not deploy this section.
 The section that you have created occupies the same position as a section in the deployed
Control project or you select the section in the Update Control Project dialog box (delete).
It can also have an impact on facets that are assigned to this section.
The following example shows how a section created in the logical Control project after deployment
can have the same position as a section in the deployed Control project.
Example: The logical Control project contains two sections. It is deployed.

Logical Control project (offline) Deployed Control project (online)

Section_1 / order 0 Section_1
Section_2 / order 1 Section_2

Then, section_3 is created in between Section_1 and Section_2. It now has the same position as
Section_2 in the deployed Control project.

Logical Control project (offline) Deployed Control project (online)

Section_1 / order 0 Section_1
Section_3 / order 1 Section_2
Section_2 / order 2

850 EIO0000001114 06/2020

 Execution Stage

The table describes the possible scenarios where updating the logical Control project has an
impact on the position of a section that you have created in it post deployment and/or on the status
of the facets assigned to this section.

Assignment and The position of Proposed action User selection Result in logical Control project after
generation status the section during Control the update
conflicts with the project update
position of a
section in the
deployed project
Facets are Yes None. Not applicable. The section that was created in the
assigned to the The section logical project is moved to the end of
section but none created in the sections (highest order value)(1)(2).
are generated. logical project is
not detected as a
difference because
it is not generated.
Facets are No Delete. The section is  The section created in the logical
assigned to the selected for project is moved to the end of
section and deletion. sections (highest order value)(2).
generated.  The generation status of facets is
changed to Non Generated.
Yes Delete. The section is  The section created in the logical
selected for project is moved to the end of
deletion. sections (highest order value)(2).
 The generation status of facets is
changed to Non Generated.
Delete. The section is  The section created in the logical
not selected project is moved to the end of
(default). sections (highest order value)(1).
 The generation status of facets is
unchanged.
(1) After the update is complete, you may be able to preserve the change that you have made in the logical Control
project by moving the section back to its original position and propagating the change in the system engineering
life cycle.
(2) After the update is complete, to remove the section from the logical Control project, right-click it in the Containers
pane of the Assignment Editor and select Delete.

NOTE: In the above scenarios, it is implied that other changes that you may have made during
refinement online are applied to the logical Control project (for example, adding code to a section
or changing the order of sections).
NOTE: The behavior is the same when you update the logical Control project if you create a section
in the Project Explorer, generate, and deploy it and then delete it during refinement online (given
the section is not locked (see page 514)).

EIO0000001114 06/2020 851

Execution Stage

Aborting Control Project Update Tasks

After confirming the update by clicking OK in the Update Control Project dialog box, the abort icon
is displayed in the notification panel (see page 86). Click the icon to cancel the task. The project is
not updated.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are updating the Control Participant project with only a few changes, the task may
complete before you are able to click the icon.

Updating the Logical Control Participant Project

To update the logical Control Participant project, proceed as follows.

Step Action
1 Verify that the engine is connected to the PC (see page 723).
2 In the Topology Explorer, right-click the controller or station node that contains the deployed
Participant project and select Update Control Project.
Result: The software displays the Confirm Update Control Project dialog box.
3 Verify the information that is displayed and click OK.
Result: The software displays the Update Control Project dialog box.
NOTE: Click Cancel to close the Confirm Update Control Project dialog box without applying the
changes.
4 Select the changes that you want to update the logical Control Participant project with.
NOTE: Click Cancel to close the Update Control Project dialog box without updating the Control
Participant project.
5 Select the Check Consistency check box if you want the software to perform a consistency check;
otherwise proceed to step 8.
6 Click OK.
Result: The software displays the Check Consistency dialog box if you selected the option and if it
detects inconsistencies.
7 In the Check Consistency dialog box, select facets that you want to unlink.
NOTE: Click Cancel to close the Check Consistency dialog box without unlinking facets and revert
to the Update Control Project dialog box.

852 EIO0000001114 06/2020

 Execution Stage

Step Action
8 Click Unlink or OK.
Result: The software:
 Applies the changes that you have selected.
 Changes the status of the associated executable to Out Of Date.
 Displays Completed in the information pane once it has successfully completed the update
process.
 Updates the related date/time field.

 Removes the online refinement icon (see page 552) from the associated topological entity
only if you had selected to update the Control Participant project with all the detected changes of
the following categories; otherwise the indicator remains.
 Derived Data & FB Types
 Variables & FB Instances
 Sections

EIO0000001114 06/2020 853

Execution Stage

Section 21.2
Supervision Project Execution Stage

Supervision Project Execution Stage

Executing the Deployed Supervision Participant Project

Overview
You need to execute the deployed Supervision Participant project locally, on each PC to which you
have deployed the Supervision project by using the appropriate Supervision runtime.
For information on the required software, refer to the topic describing software requirements
(see EcoStruxure™ Process Expert, Installation and Configuration Guide).

Executing a Deployed Supervision Project

For information on executing the deployed Supervision Participant project on a PC, refer to
Executing the Deployed Supervision Project (see EcoStruxure™ Process Expert, Supervision
Participant Services, User Guide).

854 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Managing Communication
EIO0000001114 06/2020

Chapter 22
Managing Communication

Managing Communication

Overview
This chapter contains information describing how to manage communication between devices and
controllers depending on the communication protocol that you want to use. It contains examples
that use templates of the General Purpose library Classic.

WARNING
LOSS OF CONTROL
 Perform a Failure Mode and Effects Analysis (FMEA) of your application, and apply preventive
and detective controls before implementation.
 Provide a fallback state for undesired control events or sequences.
 Provide separate or redundant control paths wherever required.
 Supply appropriate parameters, particularly for limits.
 Review the implications of transmission delays and take actions to mitigate.
 Review the implications of communication link interruptions and take actions to mitigate.
 Provide independent paths for control functions (for example, emergency stop, over-limit
conditions, and fault conditions) according to the safety analysis and applicable codes, and
regulations.
 Apply local accident prevention and safety regulations and guidelines. 1
 Test each implementation of this library for proper operation before placing it into service.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

1 For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the

Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.
NOTE: The software does not verify the status of the communication between controllers and I/O
devices.

EIO0000001114 06/2020 855

Managing Communication

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
22.1 Communication Through Modbus TCP Ethernet Implicit Messaging (I/O 857
Scanning)
22.2 Communication by Using Modbus TCP Ethernet Explicit Messaging 867
22.3 Communication by Using Ethernet IP Explicit Messaging 873
22.4 Communication Through Modbus Explicit Messaging 877
22.5 Monitoring Modbus Device Data Directly from Supervision 920
22.6 Communication with Devices by Using a PROFIBUS Master Module 925

856 EIO0000001114 06/2020

 Managing Communication

Section 22.1
Communication Through Modbus TCP Ethernet Implicit Messaging (I/O Scanning)

Communication Through Modbus TCP Ethernet Implicit

Messaging (I/O Scanning)

Overview
This section contains specific procedures to help you configure communication through Modbus
TCP Ethernet implicit messaging by using the I/O scanner function. It covers communication
between a controller and entities that are configured in the topology of the system, and between
several controllers (peer to peer communication). It contains examples that use templates of the
General Purpose library Classic.
NOTE: For the engineering of a system with the software, it is not relevant how Modbus TCP
devices are physically connected to the real Ethernet network. As long as they are connected to
the same logical Ethernet network with a valid IP address, you can proceed with the implemen-
tation of communication in the software. However, in your physical architecture, you need to
confirm that connections are done properly so that devices are indeed reachable.
For example, in an M580 architecture, whether an STB island is connected directly to the service
port of the CPU module, to the port of a BMENOC0301.2 module, or to the service port of a
BMXCRA31210 module does not matter. In the software, you configure only the DIO scanner
service of the CPU or NOC module to exchange data with the STB island on the same Ethernet
network.

What Is in This Section?

This section contains the following topics:
Topic Page
Communicating with Devices Through Modbus TCP Implicit Messaging (I/O Scanning) 858
Communicating with STB Islands Through Modbus TCP Implicit Messaging 861
Communicating with PROFIBUS Remote Masters Through Modbus TCP Implicit Messaging 862
Peer to Peer Communication Through Modbus TCP Ethernet Implicit Messaging 865

EIO0000001114 06/2020 857

Managing Communication

Communicating with Devices Through Modbus TCP Implicit Messaging (I/O Scanning)

Overview
The software supports communication through Modbus TCP Ethernet implicit messaging between
common devices and supported controller platforms by using the I/O scanner function.
In addition to configuring the controller as a client and enabling its I/O scanner, you need to
instantiate the topological template of the Modbus TCP device.
The topological device instance allows you to assign an IP address to the device and connect it to
the Ethernet network to which the controller is connected.
The communication channel between the controller and the device is managed through the
communication mapping (see page 630).
The build process creates the communication channel in the built Control Participant project.
For a list of available device templates, refer to the Device/Communication Matrix
(see EcoStruxure™ Process Expert, Communication Control Services User Guide).
NOTE: Refer to the TVDA document Hot Standby Quantum_EIO for recommendations when using
a NOC communication module to implement communication between Modbus TCP devices and
Hot Standby controllers of the Quantum platform.

Using Device Application Templates

The device-specific application template of a Modbus TCP device (for example, $TesysTE) allows
you to edit the Control and Supervision parameters of the device and proceed with the hardware
mapping to the controller I/O modules.
It is not required for managing communication with the device using I/O scanning.

Generic Device Templates

If no specific topological template is available for the device that you are using, use one of the
generic topological device templates (see page 584) and its application counterpart.
The generic application template lets you create an input and an output variable of required length
and data type.
The table indicates which device template to use depending on the module that is used to
communication with the device.

Module used to communicate with Topological device template to use Corresponding application device
device template to use
CPU module of an M580 controller $EGenericDeviceHW $GenNOCDevice
BMENOC•••• communication Some manual configuration is
required (see EcoStruxure™
module
Process Expert, Device Templates
User Guide).

858 EIO0000001114 06/2020

 Managing Communication

Module used to communicate with Topological device template to use Corresponding application device
device template to use
CPU module of a Quantum $EGenericDeviceHW $GenericDevice
controller
140NOE••••• communication
module

Implementing Communication
To implement communication between a controller and a device through Modbus TCP by using I/O
scanning, complete these steps.

Step Description Stage

1 Create a Control project in the system. Project Definition
2 Create a Control executable in the project.
3 Create and configure a controller (see page 556) with the I/O scanner enabled Configuration
and its communication module. Configure the client memory start and length
parameters (see page 562) of the communication module.
4 Create and configure (see page 584) the topological device entity (configure IP
address and other applicable properties).
NOTE: If the device communicates with a communication module that
validates IP addresses based on the subnet mask, verify that the IP addresses
of the device and the module belong to the same subnet.
5 Create an Ethernet network (see page 594).
6 Connect the communication module of the controller (see page 596) to the
Ethernet network.
7 Connect the I/O device (see page 602) to the same Ethernet network.
8 Instantiate the application template that corresponds to the topological device Instantiation
entity and configure its properties.
9 Map the Control executable of the project to the controller entity Mapping (service)
(see page 628).
10 Define the communication channel (see page 630) between the controller and Mapping
the device. (communication)

To complete the other steps to implement the system that contains the controller and the device,
follow the system engineering life cycle described in this manual.
NOTE: Refer to the topic describing device communication technologies (see EcoStruxure™
Process Expert, Device Control Services User Guide) for configuration and setup details.

EIO0000001114 06/2020 859

Managing Communication

Implementing Communication by Using Generic Device Templates

To implement communication through Modbus TCP by using I/O scanning, between a controller
and a device for which no specific topological template exists, complete these steps.

Step Description Stage

1 Create a Control project in the system. Project Definition
2 Create a Control executable in the project.
3 Create and configure a controller (see page 556) with the I/O scanner enabled Configuration
and its communication module. Configure the client memory start and length
parameters (see page 562) of the communication module.
4 Create and configure the generic topological device entity (see page 584),
assign an IP address to it, and enter values for the read/write parameters
(see page 587).
NOTE: If the device communicates with a communication module that
validates IP addresses based on the subnet mask, verify that the IP addresses
of the device and the module belong to the same subnet.
5 Create an Ethernet network (see page 594).
6 Connect the communication module of the controller (see page 596) to the
Ethernet network.
7 Connect the I/O device (see page 602) to the same Ethernet network.
8 Instantiate the generic application device (see page 858) template and Instantiation
configure its properties.
9 Map the Control executable of the project to the controller entity Mapping (service)
(see page 628).
10 Define the communication channel (see page 630) between the controller and Mapping
the device. (communication)

To complete the other steps to implement the system that contains the controller and the device,
follow the system engineering life cycle described in this manual.

860 EIO0000001114 06/2020

 Managing Communication

Communicating with STB Islands Through Modbus TCP Implicit Messaging

Overview
The software supports communication through Modbus TCP Ethernet implicit messaging between
STB islands and supported controller platforms by using the I/O scanner function.
The controller acts as client, and its I/O scanner is enabled.
The STB island acts as server, and both are connected to the same Ethernet network, on which
they are identified with their respective IP address.
The communication channel between the controller and the STB island is defined through the
communication mapping (see page 630).
The build process creates the communication channel in the built Control Participant project.

Implementing Communication
To implement communication between a controller and an STB island through Modbus TCP (I/O
scanning), complete these steps.

Step Description Stage

1 Create a Control project in the system. Project
Definition
2 Create a Control executable in the project.
3 Create and configure a controller (see page 556) with the I/O scanner enabled Configuration
and its communication module. Configure the client memory start and length
parameters (see page 562) of the communication module.
4 Create and configure an STB island (see page 573) entity and assign an IP
address to its NIM.
NOTE: If the NIM communicates with a communication module that validates
IP addresses based on the subnet mask, verify that the IP addresses of the NIM
and the module belong to the same subnet.
5 Create an Ethernet network (see page 594).
6 Connect the communication module of the controller (see page 599) to the
Ethernet network.
7 Connect the communication module of the STB island (see page 603) to the
same Ethernet network.
8 Map the Control executable of the project to the controller entity (see page 628). Mapping
(service)
9 Define the communication channel (see page 630) between the controller and Mapping
the STB island. (communication)

To complete the other steps to implement the system that contains the controller and the STB
island, follow the system engineering life cycle described in this manual.

EIO0000001114 06/2020 861

Managing Communication

Communicating with PROFIBUS Remote Masters Through Modbus TCP Implicit

Messaging

Overview
The software supports communication through Modbus TCP implicit messaging between
PROFIBUS remote masters (PRMs) and supported controller platforms by using the I/O scanner
function.
The topological PRM entity allows you to configure decentralizes devices (DPs) and assign an IP
address to the PRM to connect it to the Ethernet network to which the controller is connected.
In addition to configuring the controller as a client with the I/O scanner enabled, you need to
instantiate:
 A PRM management application template.
 A device application template that corresponds to the DP that is configured in the PRM entity.

The communication channel between the controller and the PRM is managed through the
communication mapping (see page 630).
The build process creates the communication channel in the built Control Participant project.
NOTE: The device application templates of the configured DPs allow you to edit the Control and
Supervision parameters of the devices and proceed with the hardware mapping to the controller
I/O modules. They are not required to manage communication with the DPs by using I/O scanning.

Using several Communication Port Instances

To use one topological communication port with several PRM management instances
(application), you need to instantiate the following intermediate templates (fan-out type application
templates). Each instance of such template accepts links to n PRM management instances.

PRM management template Intermediate template

$PRMMgtM $EthAddM
$PRMMgtQ $EthAddQ

862 EIO0000001114 06/2020

 Managing Communication

The following figure shows an example of how to link two instances of the PRM management
template to the instance of an intermediate template. During hardware mapping, the interface of
the intermediate template instance is mapped to the interface of the Ethernet port of an M340 or
M580 controller.

Implementing Communication
To implement communication between a controller, a PRM and its DP through Modbus TCP by
using I/O scanning, complete these steps.

Step Description Stage

1 Create and configure a controller (see page 556) with the I/O scanner enabled Configuration
and its communication module. Configure the client memory start and length
parameters (see page 562) of the communication module.
2 Create and configure (see page 579) the PRM entity and its DPs (configure IP
address and other applicable properties).
NOTE: If the PRM communicates with a communication module that validates
IP addresses based on the subnet mask, verify that the IP addresses of the
PRM and the module belong to the same subnet.
3 Create an Ethernet network (see page 594).
4 Connect the communication module of the controller (see page 596) to the
Ethernet network.
5 Connect the PRM entity (see page 604) to the same Ethernet network.

EIO0000001114 06/2020 863

Managing Communication

Step Description Stage

6 In the Application Explorer, instantiate the following templates: Instantiation
 The PRM management template. One for each PRM entity that is
configured:
 $PRMMgtQ for a controller of the Quantum platform.
 $PRMMgtM for a controller of the M340 or M580 platform.

 One application template for each DP that you have configured (for
example, $ATV71PB for an Altivar 71 DP.
NOTE: If no specific template is available for a given DP, you can instantiate
the generic application template $GenericDevice.
7 If you are using the $PRMMgtQ PRM management template, in the Instance
Editor, configure the StartMemoryHeap parameter.
Refer to the help of the template for details.
8 If you are using several PRM management instances, instantiate the
corresponding intermediate template (see page 862) and link its instance to
each PRM management instance by using the Links Editor.
NOTE: A link between the DP instance and the PRM management instance is
not required.
9 Create a Control Participant project in the system. Project Definition
10 Assign the necessary facets to the Control Participant project.
11 Create a Control executable in the project.
12 Map the Control executable of the project to the controller entity Mapping (service)
(see page 628).
13 Define the communication channel (see page 630) between the controller and Mapping
the device. (communication)
14 Map to their respective topological counterpart (HO) by dragging from right to Mapping
left: (hardware)
 The EMPortChM or EMPortChQ interface.
 The PRMCTRLData interface.
 The PRMEthernetAddress interface.
 The interface of the device application facet to the interface of the
topological DP device.

To complete the other steps to engineer the system that contains the controller and the device,
follow the system engineering life cycle described in this manual.
NOTE: Refer to the help of the various templates for configuration and setup details.

864 EIO0000001114 06/2020

 Managing Communication

Peer to Peer Communication Through Modbus TCP Ethernet Implicit Messaging

Overview
Peer to peer communication allows you to share data between two or more Control Participant
projects by using the I/O scanner function for any pair of controllers that are configured in the
topology of the system.
Network variables are used to exchange data between the Participant projects to which the
controllers are mapped.
Client/server communication channels and network variable mappings are managed through
communication mapping (see page 630).
The build process creates the communication channels and allocates the mapped variables in the
respective built Control Participant projects.
For more information about ways to create variables to share data, refer to the topic documenting
the creation of network variables (see page 527).

Implementing Peer to Peer Communication

To implement peer to peer communication through Modbus TCP implicit messaging by using I/O
scanning, follow these steps.

Step Description Stage

1 Create two Control projects in the same system. Project definition
2 Create a Control executable in each project.
3 Create the network variables that will be exchanged (see page 527) between the Refinement
projects.
4 Create and configure two controllers (see page 556) with the necessary Configuration
communication and I/O modules.
In the controller acting as client, enable the I/O scanner function.
5 In the controller acting as client, configure the client memory start and length
parameters (see page 562) of the communication module.
6 In the controller acting as server, configure the server memory start and length
parameters (see page 562) of the communication module.
NOTE: If the server communicates with a communication module that validates
IP addresses based on the subnet mask client-side, verify that the IP addresses
of the client/server modules belong to the same subnet.
7 Create an Ethernet network (see page 594).
8 Connect the communication module (see page 599) of each controller to this
Ethernet network.

EIO0000001114 06/2020 865

Managing Communication

Step Description Stage

9 Map the Control executable of the owner project to the controller (see page 628) Mapping
acting as server. (service)
10 Map the Control executable of the consumer project to the controller
(see page 628) acting as client.
11 Define the peer to peer communication channels (see page 630) between the Mapping
controllers. (communication)
12 Map the network variables (see page 645) to the peer to peer communication
channels.

To complete the other steps to implement the system, follow the system engineering life cycle
described in this manual.

866 EIO0000001114 06/2020

 Managing Communication

Section 22.2
Communication by Using Modbus TCP Ethernet Explicit Messaging

Communication by Using Modbus TCP Ethernet Explicit

Messaging

Communication with Devices by Using Modbus TCP Ethernet Explicit Messaging

Overview
This topic contains examples that use templates of the General Purpose library Classic.

Supported Architectures
The software supports communication by using Modbus TCP Ethernet explicit messaging between
common devices and supported controller platforms.
The process requires to instantiate the topological template of the Modbus TCP device, its
application counterpart, and the appropriate application template of the communication port.
The communication port instance lets you configure the number of simultaneous requests that are
sent per cycle. The configuration depends on the capacity of the communication module. For
example, the various M580 CPU modules can send from 16 to 80 requests as client.
The topological device instance lets you assign an IP address to the device and connect it to the
Ethernet network to which the controller is connected.
The IP address is exchanged with the application template of the device through the hardware
mapping.
For a list of supported communication architectures, refer to the Device/Communication Matrix
(see EcoStruxure™ Process Expert, Communication Control Services User Guide).
NOTE: If no device-specific topological template is available for the device that you are using, use
a generic topological device template (see page 584) and its application counterpart $EMClient.

Using several Communication Port Instances

To use one topological communication port with several communication port instances
(application), you need to instantiate the following intermediate templates (fan-out type application
templates). Each instance of such template accepts links to n communication port instances.

Communication port Intermediate template

template
$EMPortM $EthAddM
$EMPortQ $EthAddQ

EIO0000001114 06/2020 867

Managing Communication

The following figure shows an example of how to link two instances of the communication port
template to the instance of an intermediate template. In the hardware mapping, the interface of the
intermediate template instance is mapped to the interface of the Ethernet port of an M340 or M580
controller.

NOTE: The EthIPAddOut interface is not used for Modbus TCP explicit messaging.

868 EIO0000001114 06/2020

 Managing Communication

The following figure shows an example of how to link two instances of the communication port
template to the instance of an intermediate template. In the hardware mapping, the interface of the
intermediate template instance is mapped to the interface of the Ethernet port of a Quantum
controller.

NOTE: The EthChAddOut and EthIPAddOut interfaces are not used for Modbus TCP explicit
messaging.

EIO0000001114 06/2020 869

Managing Communication

Implementing Communication
To implement communication between a controller and a device by using Modbus TCP Ethernet
explicit messaging, follow these steps.

Step Description Stage

1 Instantiate the process template that corresponds to the piece of equipment that Instantiation
you want the device to communicate with (for example, $Motor).
2 Instantiate the Modbus TCP explicit messaging (EM) application template that
corresponds to device that you want to use (for example, $TesysTEM).
NOTE: If no device-specific application template exists, use the $EMClient
template. Create as many instances of it as you have requests. For example, for
one read and one write request you need two instances.
3 Instantiate the following communication port template:
 $EMPortQ for a controller of the Quantum platform.
 $EMPortM for a controller of the M340 or M580 platform.

4 Configure the communication port instance:

 The Control element lets you select a profile, which corresponds to the
maximum number of simultaneous requests that the communication module
supports.
 The corresponding LogicX service lets you optimize communication by
reducing the number of simultaneous requests that are sent depending on your
needs. X corresponds to the last two digits of the profile you select under
Control. For example, to EMPortM16 corresponds Loigc16.
NOTE: If you select a profile that exceeds the capacity of the communication
module, you cannot assign the communication port instance to the Control
Participant project. Even if you reduce the number of requests under LogicX. For
example, if you select EMPortM32 for a NOC communication module, which can
send a maximum of 16 requests simultaneously.
5 If you are using one topological communication port with several communication
port instances, instantiate the corresponding intermediate template
(see page 867).
6 Open the Links Editor from the device instance and link to it:
 The port instance
 The process instance

NOTE: In case of a generic device, the device instance is the $EMClient

template instance.
NOTE: If you use an intermediate template instance, link it to the port instance.

870 EIO0000001114 06/2020

 Managing Communication

Step Description Stage

7 Configure a controller and its communication module. Configuration
8 Create (see page 584) the corresponding topological device entity and configure
its IP address and other applicable properties (for example, $ETesysTHW).
NOTE: If no device-specific topological template exists, use a generic device
template.
9 Create an Ethernet network.
10 Connect the communication module of the controller and the topological device
entity to the same Ethernet network.
11 Assign the Control facets of the process, device, and communication port Assignment
instances to the Control Participant project so that the execution order
(see page 440) is as follows:
1. The facet of the Modbus TCP explicit messaging device instance (for example,
TesysTEM_1).
2. The facet of the communication port instance (for example, EMPortQ_1).
12 Generate the project. Generation
13 Map the executable of the Control Participant project to the engine of the controller Mapping
(see page 628). (service)
14 Map the EMPortChM or EMPortChQ interface of the communication port instance Mapping
(or of the intermediate template instance) to its topological counterpart. (hardware)
15 Map the interface of the application instance of the device to the interface of the
topological device instance.

To complete the other steps to engineer the system that contains the controller and the device,
follow the system engineering life cycle described in this manual.
NOTE:
Refer to the following topics for configuration and setup details of:
 Devices (see EcoStruxure™ Process Expert, Device Control Services User Guide)
 Ports (see EcoStruxure™ Process Expert, Communication Control Services User Guide)

EIO0000001114 06/2020 871

Managing Communication

Examples
The following examples illustrate the configuration of Modbus TCP explicit messaging to connect
to 20 devices from clients of two different platforms with different communication capacities.

Example 1
Number of devices 20
Controller platform Modicon Quantum
Communication module 140NOC77101
Communication port template $EMPortQ
Communication port instance configuration (PortSelection) EMPortQ16

Requests sent simultaneously (SimultaneousSends) 10 in Logic16

Cycles to connect once to the number of devices 2 (2 x 10)

Example 2
Number of devices 20
Controller platform Modicon M580
Communication module BMEP582020
Communication port template $EMPortM
Communication port instance configuration (PortSelection) EMPortM32

Requests sent simultaneously (SimultaneousSends) 20 in Logic32

Cycles to connect once to the number of devices 1

Managing IP Address Changes

The topological templates of devices communicating by using Modbus TCP Ethernet explicit
messaging use a variable to define the IP address of the device.
During deployment, the templates set up the initial value of this variable, which is connected to the
pin of the DFB implementing the device.
When you change the IP address of a device by changing the hardware mapping of the facet
modeling the device and deploy the change by using the Deploy Changes command, only the initial
value, in this case the IP address, is changed online. The current value remains the same.
The IP address change becomes effective, either through a cold start of the controller or by
replacing the current value of the variable in the animation table by the new initial value.

872 EIO0000001114 06/2020

 Managing Communication

Section 22.3
Communication by Using Ethernet IP Explicit Messaging

Communication by Using Ethernet IP Explicit Messaging

Communication with Devices by Using Ethernet IP Explicit Messaging

Overview
This section contains a procedure specifically aimed at managing communication between devices
and M580 controllers by using Ethernet IP explicit messaging. It contains examples that use
templates of the General Purpose library Classic.

Supported Architectures
The software supports communication by using Ethernet IP explicit messaging between common
devices and CPU modules of M580 controllers or NOC communication modules.
The process requires to instantiate the topological template of the Ethernet IP device, its
application counterpart, and the appropriate application template of the communication port.
The communication port instance lets you configure the number of simultaneous requests that are
sent per cycle. The configuration depends on the capacity of the communication module. For
example, the various M580 CPU modules can send from 16 to 80 requests as client.
The topological device instance lets you assign an IP address to the device and connect it to the
Ethernet network to which the controller is connected.
The IP address is exchanged with the application template of the device through the hardware
mapping.
For a list of supported communication architectures, refer to the help of the Schneider Electric
libraries for EcoStruxure Process Expert.
NOTE: If no device-specific topological template is available for the device that you are using, use
a generic topological device template (see page 584) and its application counterpart
$EIPMClient.

Using several Communication Port Instances

To use one topological communication port with several communication port instances
(application), you need to instantiate the following intermediate templates (fan-out type application
templates). Each instance of such template accepts links to n communication port instances.

Communication port Intermediate template

template
$EIPMPortM $EthAddM

EIO0000001114 06/2020 873

Managing Communication

The following figure shows an example of how to link two instances of the communication port
template to the instance of an intermediate template. In the hardware mapping, the interface of the
intermediate template instance is mapped to the interface of the Ethernet port of an M580
controller.

NOTE: The EthIPAddOut interface is not used.

874 EIO0000001114 06/2020

 Managing Communication

Implementing Communication
To implement communication between a controller and a device by using Ethernet IP explicit
messaging, follow these steps.

Step Description Stage

1 Instantiate the Ethernet IP messaging (EIPM) application template that Instantiation
corresponds to device that you want to use.
NOTE: If no device-specific application template exists, use the $EIPMClient
template. Create as many instances of it as you have requests. For example, for
one read and one write request you need two instances.
2 Instantiate the $EIPMPortM Ethernet IP communication port template and
configure its parameters, such as:
 Port Selection of the Control element: Enables the corresponding LogicX
service where X represents the numeric part of the selected port function. It
needs to correspond to the maximum number of simultaneous requests that
the communication module supports.
For example, to EIPMPortM16 corresponds Loigc16.
 Simultaneous Sends of the LogicX service to optimize communication by
reducing the number of simultaneous requests that are sent.
3 If you are using one topological communication port with several communication
port instances, instantiate the corresponding intermediate template
(see page 873).
4 Open the Links Editor from the communication port instance and link to it:
 The device instance.
 The intermediate template instance (if used).

NOTE: In case of a generic device, the device instance is the $EIPMClient

template instance.
5 Configure an M580 controller and its communication module. Configuration
6 Create (see page 584) the corresponding topological device entity and configure
its IP address and other applicable properties (for example, $EIPMPMESWTHW).
NOTE: If no device-specific topological template exists, use the
$EIPGenericDeviceHW) generic device template.
7 Create an Ethernet network.
8 Connect the communication module of the controller and the topological device
entity to the same Ethernet network.
9 Assign the Control facets of the device, the communication port instances, and the Assignment
intermediate template instance to the Control Participant project.
10 Generate the project. Generation
11 Map the executable of the Control Participant project to the engine of the controller Mapping
(see page 628). (service)

EIO0000001114 06/2020 875

Managing Communication

Step Description Stage

12 Map the EMPortChM interface of the communication port instance (or of the Mapping
intermediate template instance) to its topological counterpart. (hardware)
13 Map the interface of the application instance of the device to the interface of the
topological device instance.

To complete the other steps to engineer the system that contains the controller and the device,
follow the system engineering life cycle described in this manual.
NOTE: For configuration and setup details of devices and communication ports, refer to the help
of the Schneider Electric libraries for EcoStruxure Process Expert.

Managing IP Address Changes

The topological templates of devices communicating by using Modbus TCP Ethernet and Ethernet
IP explicit messaging use a variable to define the IP address of the device.
During deployment, the templates set up the initial value of this variable, which is connected to the
pin of the DFB implementing the device.
When you change the IP address of a device by changing the hardware mapping of the facet
modeling the device and deploy the change by using the Deploy Changes command, only the initial
value, in this case the IP address, is changed online. The current value remains the same.
The IP address change becomes effective, either through a cold start of the controller or by
replacing the current value of the variable in the animation table by the new initial value.

876 EIO0000001114 06/2020

 Managing Communication

Section 22.4
Communication Through Modbus Explicit Messaging

Communication Through Modbus Explicit Messaging

Overview
This section contains a procedure describing how to manage communication between devices and
M340 or Quantum controllers through Modbus explicit messaging.
It also contains a set of four examples illustrating how to use Modbus serial communication
templates and do the required hardware mapping. Each example uses a different architecture
based on the M580 platform. The examples use templates of the General Purpose library Classic.
Refer to the example overview and select the one that applies to your situation. From there, a link
allows you to jump directly to the topic describing it.

What Is in This Section?

This section contains the following topics:
Topic Page
Communication with Devices Through Modbus Explicit Messaging 878
Example Overview 885
Example A 890
Example B 896
Example C 903
Example D 913

EIO0000001114 06/2020 877

Managing Communication

Communication with Devices Through Modbus Explicit Messaging

About Communication Port Templates for Modbus Explicit Messaging

The software supports communication through Modbus explicit messaging between common
devices and various controller platforms by using specific communication templates.

Controller platform Communication module Communication port

template
Modicon M580 NOM(1) communication module in the local rack. $MBPortM

NOM(1) communication module in a drop. $MBPortM58X80

Modicon M340 NOM communication module in the local rack. $MBPortM

Modicon Quantum NOM communication module in an X80 drop. $MBPortQX80
(1) For example, BMXNOM0200.2 communication module

Communication through an Ethernet port of the controller is also supported.

For a list of supported communication architectures, refer to the help of the Schneider Electric
libraries for EcoStruxure Process Expert.
NOTE: If no device-specific application template is available for the device that you are using, use
the $MBClient template.

About Intermediate Templates

Intermediate templates are used when more than one communication port instance is used
according to the following rules:
 $MBAddM: When a physical communication module (NOC, NOE, or NOM) needs to pass its port
address to more than one communication port instance. Use one template per physical
communication port.
This can be case when you are linking more devices to a communication port instance than this
instance can handle requests per cycle. For example, The DFB of the $MBPortM58X80
communication port template can send a maximum of 4 simultaneous requests per cycle. If you
want to send 10 requests per cycle, you need to use 3 instances of the $MBPortM58X80
template. These 3 instances are linked to an instance of the $MBAddM template.
 $EthAddM: When either of these conditions is fulfilled:
 A communication module (CPU, NOC, or NOE) needs to pass its Ethernet port address to
more than one communication port instance.
 A CRA module needs to pass its IP address to more than one communication port instance.

The intermediate templates allow grouping the interfaces coming from several communication port
instances to connect them to the corresponding interfaces of the topology. This is because a 1 to
N mapping is not possible for topological mapping interfaces.
Together, the $MBAddM and $EthAddM templates expose the same interfaces as one
$MBPortM58X80 template.

878 EIO0000001114 06/2020

 Managing Communication

The table indicates which intermediate templates to instantiate depending on the communication
port template that is used and also indicates the data that is transferred to the communication port
instance.

Communication port Intermediate template Transferred address

template
$MBPortM $MBAddM Port address of NOM communication module.
$MBPortM58X80 $MBAddM Port address of NOM communication module.
$EthAddM Port address of M580 CPU or NOC
communication module.
IP address of the CRA module.
$MBPortQX80 $MBAddM Port address of NOM communication module.
$EthAddQ Port address of Quantum CPU or NOC
communication module.
IP address of the CRA module.

NOTE: When two intermediate templates are required, create the links with the communication
port instances by opening the Links Editor from the first intermediate template and then from the
second one.
The following figures illustrate the transfer of data between the topology and the application in
various scenarios.
Multiple communication port instances per physical NOM port. In this case, only one NOM port is
used and located in a drop.

EIO0000001114 06/2020 879

Managing Communication

One communication port instance per physical NOM port. In this case, the two NOM ports are
located in the same drop.

880 EIO0000001114 06/2020

 Managing Communication

One communication port instance per physical NOM port. In this case, the two NOM ports are
located in separate drops.

EIO0000001114 06/2020 881

Managing Communication

Implementing Communication with Controllers Through Modbus Port

To implement communication between an M580, M340, or Quantum controller with Modbus port
and devices through Modbus explicit messaging, follow these steps.

Step Description Stage

1 Instantiate the process template that corresponds to the piece of equipment Instantiation
that you want the device to communicate with (for example, $Motor).
2 Instantiate a Modbus explicit messaging application template that corresponds
to the device that you want to use (for example, $TesysTMB), and configure its
Modbus address.
NOTE: If no device-specific application template exists, use the $MBClient
template. Create as many instances of it as you have requests. For example,
for one read and one write request you need two instances.
3 Instantiate the corresponding communication port template (see page 878).
4 If you are using one topological communication port with several
communication port instances, instantiate the corresponding intermediate
template (see page 878).
5 Open the Links Editor from the device instance and link the communication port
and the process instance to it.
NOTE: In case of a generic device, the device instance is the $MBClient
template instance.
6 Configure the controller with a Modbus port as master. Configuration
7 Assign the Control facets of the process, device, and communication port Assignment
instances to the Control Participant project so that the execution order
(see page 440) is as follows:
1. The facet of the Modbus explicit messaging device instance (for example,
TesysTMB_1).
2. The facet of the communication port instance (for example,
MBPort58X80_1).
8 Generate the project. Generation
9 Map the executable of the Control Participant project to the engine of the Mapping (service)
controller.
10 If the communication module is in the local rack, map by dragging from right to Mapping
left: (hardware)
 The EMPortChM or EMPortChQ interface to its topological counterpart.
 The MBPortChM or MBPortChQ interface to the interface of the NOM
module of the drop.
If the communication module is in a drop, in addition, map by dragging from
right to left:
 The CRAIPAddress interface to its topological counterpart.

882 EIO0000001114 06/2020

 Managing Communication

To complete the other steps to engineer the system, follow the system engineering life cycle
described in this manual.
NOTE: For details on Modbus technology, refer to the help of the Schneider Electric libraries for
EcoStruxure Process Expert.

Implementing Communication with Controllers Through Ethernet Port

To implement communication between an M340, M580, or Quantum controller with Ethernet port
and devices through Modbus explicit messaging, follow these steps.

Step Description Stage

1 Instantiate the process template that corresponds to the piece of equipment Instantiation
that you want the device to communicate with (for example, $Motor).
2 Instantiate a Modbus explicit messaging application template that corresponds
to the device that you want to use (for example, $TesysTMB), and configure the
Modbus address.
NOTE: If no device-specific application template exists, use the $MBClient
template. Create as many instances of it as you have requests. For example,
for one read and one write request you need two instances.
3 Instantiate the following communication port templates:
 Gateway template $EGtwMB.
 $EMPortM for a controller of the M340 or M580 platform.
 $EMPortQ for a controller of the Quantum platform.

4 Open the Links Editor from the device instance and link to it:
 the gateway instance
 the process instance

NOTE: In case of a generic device, the device instance is the $MBClient

template instance.
5 Open the Links Editor from the gateway instance and link the port instance to it.
6 Create an Ethernet network. Configuration
7 Configure Ethernet communication of the controller.
8 Connect the communication module of the controller to the Ethernet network.
9 Assign the Control facets of the process, device, and communication port Assignment
instances to the Control Participant project so that the execution order
(see page 440) is as follows:
1. The facet of the Modbus explicit messaging device instance (for example,
TesysTMB_1).
2. The facet of the gateway instance (for example, EGtwMB_1).
3. The facet of the communication port instance (for example, EMPortM_1).

EIO0000001114 06/2020 883

Managing Communication

Step Description Stage

10 Generate the project. Generation
11 Map the executable of the Control Participant project to the engine of the Mapping (service)
controller.
12 Map the EMPortChM or EMPortChQ interface of the communication port Mapping
instance (CO) to its topological counterpart (HO). (hardware)

To complete the other steps to implement the system that contains the controller and devices,
follow the system engineering life cycle described in this manual.
NOTE: For configuration and setup details of gateways, refer to the help of the Schneider Electric
libraries for EcoStruxure Process Expert.

884 EIO0000001114 06/2020

 Managing Communication

Example Overview

Supported Architectures
These examples are based on a controller of the M580 platform configured with one
BMENOC0301.2 communication module.
They can be used also for controllers of the Quantum platform by using the corresponding
templates with the Q variant (for example, $EthAddQ or $MBPortQX80).
NOTE: The examples are not meant to represent a functional system. Only the elements that are
relevant for the examples are configured and illustrated. Default identifiers have been edited to be
more comprehensible.

About Communication Port Templates for Modbus Explicit Messaging

Various Modbus serial communication port templates (see page 878) exist depending on the
architecture, which contains the BMXNOM0200 communication module and its location.
When the communication module is located in a drop, the $MBPortM58X80 template is used. Its
instance exposes three mapping interfaces (HW Interface column) to transfer the required data to
the process objects:
 MBPortChM: The port address of the NOM communication module.
 EMPortChM: The port address of the CPU or NOC communication module.
 CRAIPAddress: The IP address of the CRA module.

Instantiate one $MBPortM58X80 template for each physical communication port used. When you
need several communication port templates, use also intermediate templates (see page 878).

EIO0000001114 06/2020 885

Managing Communication

The $MBPortM58X80 template allows mapping with the topology, which exposes the following
interfaces in the Hardware Mapping Editor when the NOM communication module is located in a
drop.

1 Port address of the NOC communication module in the local rack

2 IP address of the CRA module
3 Port address of the NOM communication module when the NOM port is configured for Modbus link

Example A
The table indicates the specifics of this example in terms of remote drop configuration and
application objects used.

M580 remote drop configuration Application objects Example description

1 BMXNOM0200 communication 2 devices communicating through 1 A (see page 890)
module. communication port.

886 EIO0000001114 06/2020

 Managing Communication

Example B
The table indicates the specifics of this example in terms of drop configuration and application
objects used.

M580 remote drop configuration Application objects Example description

1 BMXNOM0200 communication 2 devices, each communicating through 1 B (see page 896)
module. communication port (2 ports total).

EIO0000001114 06/2020 887

Managing Communication

Example C
The table indicates the specifics of this example in terms of drop configuration and application
objects used.

M580 remote drop configuration Application objects Example description

2 BMXNOM0200 communication For each NOM, 2 devices communicating C (see page 903)
modules through 1 communication port.

888 EIO0000001114 06/2020

 Managing Communication

Example D
The table indicates the specifics of this example in terms of drop configuration and application
objects used.

M580 remote drop configuration Application objects Example description

2 drops with 1 BMXNOM0200 For each drop, 1 device communicating D (see page 913)
communication module in each. through 1 communication port.

EIO0000001114 06/2020 889

Managing Communication

Example A

Example Description
The table indicates the specifics of this example in terms of remote drop configuration and
application objects used.

M580 remote drop configuration Application objects

1 BMXNOM0200 communication module. 2 devices communicating through 1 communication port.

890 EIO0000001114 06/2020

 Managing Communication

Configuration Stage
The following figure shows the controller configuration with the drop and the communication
module.

EIO0000001114 06/2020 891

Managing Communication

Instantiation Stage
The following Instances are required to implement communication at the application level with two
devices (TeSys T motor controllers) by using Modbus serial.
The MBPortM58X80_NOM1 Modbus serial communication port instance is to be used when the
NOM communication module is located in the remote drop of an M580 controller. In this example,
one instance is created because one physical communication port is used.

892 EIO0000001114 06/2020

 Managing Communication

Application Interface Links

The following links are created in the Links Editor for the TeSys T devices.
The process instance (Motor_n), the device instance (TesysTMB_n), and the communication port
instance (MBPortM58X80_NOM1) are linked.

EIO0000001114 06/2020 893

Managing Communication

These steps result in the following links (the figure is edited and cannot be viewed in the Links
Editor).

The communication port instance (MBPortM58X80_NOM1) passes the following data to the
process instances:
 Port address of the NOC communication module
 IP address of the CRA module of the drop
 Port address of the NOM communication module

894 EIO0000001114 06/2020

 Managing Communication

Control Facet Assignment

Facets of the instances are assigned to a Control Participant project in an FBD section.

Generation and Service Mapping

The Control Participant project is generated.
An executable is created in the Control Participant and mapped to the M580 controller.

Hardware Mapping
The Hardware Mapping Editor shows the following interfaces.
(Lines have been drawn to show the mappings that you need to do.)

NOTE: You do not need to map MBAdress interfaces (for example, of facet
TesysTMB_1_TesysT).

Completing the System Engineering Life Cycle

Complete the creation of the system by performing the other steps of the system engineering life
cycle.

EIO0000001114 06/2020 895

Managing Communication

Example B

Example Description
The table indicates the specifics of this example in terms of drop configuration and application
objects used.

M580 remote drop configuration Application objects

1 BMXNOM0200 communication module. 2 devices, each communicating through 1
communication port (2 ports total).

896 EIO0000001114 06/2020

 Managing Communication

Configuration Stage
The following figure shows the controller configuration with the drop and the communication
module.

EIO0000001114 06/2020 897

Managing Communication

Instantiation Stage
The following Instances are required to implement communication at the application level with two
devices (a TeSys T motor controller and an Altivar variable speed drive) by using Modbus serial.
The MBPortM58X80_x Modbus serial communication port instances are to be used when the
NOM communication module is located in the drop of an M580 controller. In this example, two
instances are created, one for each physical communication port used.
Instances are grouped in two folders for clarity, one for each communication port instance.

These steps result in the following links (the figure is edited and cannot be viewed in the Links
Editor).
The communication port instance (MBPortM58X80_NOM1) passes the following data to the
process instances:
 Port address of the NOC communication module
 IP address of the CRA module of the drop
 Port address of the NOM communication module

Intermediate Template Instances

Only intermediate template $EthAddM_NOC_CRA is used because more than one communication
port instance is used. It is common to both communication port instances. Intermediate template
$MBAddM is not used because on each NOM port, only one communication port instance is used.

898 EIO0000001114 06/2020

 Managing Communication

Creating Links
The following links are created in the Links Editor for the TeSys T device.
The process instance (Motor_1), the device instance (TesysTMB_1), and the communication port
instance (MBPortM58X80_Port1) are linked.

By right-clicking the MBPortM58X80_Port1 instance, you can link both interfaces of the
EthAddM_NOC_CRA Ethernet intermediate template instance to it.

The EthAddM_NOC_CRA instance passes the NOC port address as well as the IP address of the
BMECRA312 module to the communication port instance.

EIO0000001114 06/2020 899

Managing Communication

Similarly, the following links are created in the Links Editor for the Altivar device.

900 EIO0000001114 06/2020

 Managing Communication

The following figure show the existing links from the perspective of the intermediate template.

EIO0000001114 06/2020 901

Managing Communication

Control Facet Assignment

Facets of the instances are assigned to a Control Participant project in two separate FBD sections.
Folder B is assigned to FBDSection_1.

Folder B_2 is assigned to FBDSection_2.

Generation and Service Mapping

The Control Participant project is generated.
An executable is created in the Control Participant and mapped to the M580 controller.

Hardware Mapping
The Hardware Mapping Editor shows the following interfaces.
(Lines have been drawn to show the mappings that you need to do.)

NOTE: You do not need to map MBAdress interfaces (for example, of facet
TesysTMB_1_TesysT).

Completing the System Engineering Life Cycle

Complete the creation of the system by performing the other steps of the system engineering life
cycle.

902 EIO0000001114 06/2020

 Managing Communication

Example C

Example Description
The table indicates the specifics of this example in terms of drop configuration and application
objects used.

M580 remote drop configuration Application objects

2 BMXNOM0200 communication modules For each NOM, 2 devices communicating through 1
communication port.

EIO0000001114 06/2020 903

Managing Communication

Configuration Stage
The following figure shows the controller configuration with the drop and the communication
module.

904 EIO0000001114 06/2020

 Managing Communication

Instantiation Stage
The following Instances are required to implement communication at the application level with four
devices (two TeSys T motor controllers and two Altivar variable speed drives) by using Modbus
serial.
The MBPortM58X80_x Modbus serial communication port instances are to be used when the
NOM communication module is located in the drop of an M580 controller. In this example, two
instances are created, one for each physical communication port used.
Instances are grouped in two folders for clarity, one for each communication port instance.

These steps result in the following links (the figure is edited and cannot be viewed in the Links
Editor).
The communication port instance (MBPortM58X80_NOM1) passes the following data to the
process instances:
 Port address of the NOC communication module
 IP address of the CRA module of the drop
 Port address of the NOM communication module

EIO0000001114 06/2020 905

Managing Communication

Intermediate Template Instances

Only intermediate template $EthAddM_NOC_CRA is used because more than one communication
port instance is used. It is common to both communication port instances. Intermediate template
$MBAddM is not used because on each NOM port, only one communication port instance is used.

Application Interface Links

The following links are created in the Links Editor for both TeSys T devices.

906 EIO0000001114 06/2020

 Managing Communication

By right-clicking the communication port instance MBPortM58X80_NOM1 that communicates with

the NOM communication module located in drop 1, you can drag the intermediate template
instance EthAddM_NOC_CRA to the workspace and link both its interfaces to it.

The EthAddM_NOC_CRA instance passes the physical NOC port address as well as the IP address
of the BMECRA312 module to the first communication port instance.

EIO0000001114 06/2020 907

Managing Communication

Similarly, the following links are created in the Links Editor for both Altivar devices (The figure is
edited and cannot be viewed in the Links Editor).

908 EIO0000001114 06/2020

 Managing Communication

Proceed similarly with the communication port instance MBPortM58X80_NOM2 that communicates
with the NOM communication module located in drop 2 to link to it both interfaces of the
intermediate template instance EthAddM_NOC_CRA.

The EthAddM_NOC_CRA instance passes the physical NOC port address as well as the IP address
of the BMECRA312 module to the second communication port instance.

EIO0000001114 06/2020 909

Managing Communication

The figure shows the existing links from the perspective of the intermediate template.

910 EIO0000001114 06/2020

 Managing Communication

Control Facet Assignment

Facets of the instances are assigned to a Control Participant project in two separate FBD sections.
Folder C is assigned to FBDSection_1.

Folder C_2 is assigned to FBDSection_2.

Generation and Service Mapping

The Control Participant project is generated.
An executable is created in the Control Participant and mapped to the M580 controller.

Hardware Mapping
The Hardware Mapping Editor shows the following interfaces.
(Lines have been drawn to show the mappings that you need to do.)

NOTE: You do not need to map MBAdress interfaces (for example, of facet
TesysTMB_10_TesysT).

EIO0000001114 06/2020 911

Managing Communication

Completing the System Engineering Life Cycle

Complete the creation of the system by performing the other steps of the system engineering life
cycle.

912 EIO0000001114 06/2020

 Managing Communication

Example D

Example Description
The table indicates the specifics of this example in terms of drop configuration and application
objects used.

M580 remote drop configuration Application objects

2 drops with 1 BMXNOM0200 communication For each drop, 1 device communicating through 1
module in each. communication port.

EIO0000001114 06/2020 913

Managing Communication

Configuration Stage
The following figure shows the controller configuration with the drop and the communication
module.

914 EIO0000001114 06/2020

 Managing Communication

Instantiation Stage
The following Instances are required to implement communication at the application level with two
devices (a TeSys T motor controller and an Altivar variable speed drive) by using Modbus serial.
The MBPortM58X80_x Modbus serial communication port instance are to be used when the NOM
communication module is located in the drop of an M580 controller. In this example, two instances
are created, one for each physical communication port used.
Instances are grouped in two folders for clarity, one for each communication port instance.

These steps result in the following links (the figure is edited and cannot be viewed in the Links
Editor).
The communication port instance (MBPortM58X80_NOM1) passes the following data to the
process instances:
 Port address of the NOC communication module
 IP address of the CRA module of the drop
 Port address of the NOM communication module

Intermediate Template Instances

Only intermediate template $EthAddM_NOC_CRA is used because more than one communication
port instance is used. It is common to both communication port instances. Intermediate template
$MBAddM is not used because on each NOM port, only one communication port instance is used.

EIO0000001114 06/2020 915

Managing Communication

Application Interface Links

The following links are created in the Links Editor for the TeSys T devices.
The process instance (Motor_1), the device instance (TesysTMB_1), and the communication port
instance (MBPortM58X80_NOM1) are linked.

By right-clicking the MBPortM58X80_NOM1 instance, you can link the EthPortAddOut interface of
the EthAddM_NOC intermediate template instance to it.

916 EIO0000001114 06/2020

 Managing Communication

Similarly, the process instance (Motor_2), the device instance (ATV61MB_2), and the
communication port instance (MBPortM58X80_NOM2) are linked.

By right-clicking the MBPortM58X80_NOM2 instance, you can link the EthPortAddOut interface of
the EthAddM_NOC intermediate template instance to it.

EIO0000001114 06/2020 917

Managing Communication

These steps result in the following links (the figure is edited and cannot be viewed in the Links
Editor).

The communication port instances (MBPortM58X80_x) pass the following data to the process
instances:
 IP address of the CRA module of each drop
 Port address of the NOM communication module of each drop

The intermediate template instance (EthAddM_NOC) passes the following data to the process
instances:
 Port address of the NOC communication module in the local rack

918 EIO0000001114 06/2020

 Managing Communication

Control Facet Assignment

Facets of the instances are assigned to a Control Participant project in two separate FBD sections.
Folder D is assigned to FBDSection_1.

Folder D_2 is assigned to FBDSection_2.

Generation and Service Mapping

The Control Participant project is generated.
An executable is created in the Control Participant and mapped to the M580 controller.

Hardware Mapping
The Hardware Mapping Editor shows the following interfaces.
(Lines have been drawn to show the mappings that you need to do.)

NOTE: You do not need to map MBAdress interfaces (for example, of facet
TesysTMB_1_TesysT).

Completing the System Engineering Life Cycle

Complete the creation of the system by performing the other steps of the system engineering life
cycle.

EIO0000001114 06/2020 919

Managing Communication

Section 22.5
Monitoring Modbus Device Data Directly from Supervision

Monitoring Modbus Device Data Directly from Supervision

Monitoring Modbus Device Data Directly from Supervision

Overview
This topic provides specific procedures to help you implement connectivity between Modbus TCP
and Modbus serial devices and the Supervision infrastructure that is defined in the system.
For Modbus TCP devices, you can use the OPC or OPC UA driver.
This allows, for example, monitoring additional Modbus device variables without adding load to the
controller.
The implementation is possible for the following topological entities:
 Modbus TCP I/O devices.
 STB islands.
 PROFIBUS remote masters (PRMs).
 Third-party I/O devices modeled by using the generic topological device template.

It also allows connecting Modbus serial devices by using the generic Modbus TCP I/O device
acting as gateway.
The implementation supplements the engineering effort to set up communication between the
controller and Modbus devices and to operate these devices from the runtime. However, it does
not use the application control module templates that come into play in the usual system
engineering life cycle but requires creating your own application objects by using Supervision data
facet templates (see page 936).
By following the steps described in this topic, the software generates Supervision tags for variables
to be monitored based on the application objects that you have created.

920 EIO0000001114 06/2020

 Managing Communication

Implementing Monitoring of Modbus TCP Device Data

The table describes the specific steps that you need to perform to be able to monitor data of
Modbus TCP devices directly from the Supervision infrastructure. It is assumed that the required
topological entities, Control and Supervision Participant projects, the application instances,
assignments, and mappings to implement communication with Modbus TCP devices
(see page 855) already exist.

Step Description Stage

1 Instantiate a Supervision data facet template for each variable of a Modbus TCP Instantiation
device that you want to monitor from Supervision. You can use the following
templates:
 $VariableTag_CD
 $AdvancedAlarm_CD
 $TrendTag_CD

Configure the identifiers of each instance so that the relationship with the
corresponding Modbus TCP device can be easily seen.
NOTE: Select Facets as filter in the Browser pane.
2 Configure instances of $VariableTag_CD as follows:
 Addr parameter (Configuration category):
 For the OPC driver: Address of the variable by using the format
Alias!%MW<i>.
For example, ATV61IOD_IODEVICE_1!%MW3233.
 For the OPC UA driver: Name of the variable in the symbol table.

 Type parameter (Configuration category): Data type of the variable.

For example, UINT.
NOTE: Alternatively, for OPC, you can specify the address for the device by
adding an appropriate entry in the citect.ini file. For details, refer to OPC Access
Path Parameters in the OPC Driver topic of the Driver Reference Help, which you
can open from the Windows® Start menu or from within the Supervision
Participant (Topology\I/O Devices).
3 If you are using trend tags, open the Links Editor from the trend tag instance and
link it to the variable tag instance so that the instance status becomes valid.

EIO0000001114 06/2020 921

Managing Communication

Step Description Stage

4 Create additional tag containers (see page 394); one for each Modbus TCP Project Definition
device that you want to monitor from Supervision and configure Protocol as either (Supervision)
OPC or OPC UA.
5 Create a dedicated communication board (see page 351) and configure Type as
either OPC or OPC UA.
6 Create a communication port for each Modbus TCP device.
7 Create an I/O device (see page 348) for each tag container and configure the
following parameters:
 Address:
 For the OPC driver: Enter Schneider-Aut.OFS, which corresponds to
the Prog ID of the OFS server.
 For the OPC UA driver: The address parameter is not used.

 TagContainers: Associate each I/O device to a separate tag container.

 Ports

8 Assign the Supervision facets related to each device to the corresponding tag Assignment
container.
For example, if you have created two Modbus TCP devices (EATV71HW_1 and
ETesystHW_1) and for each device, you have create one variable tag instance
(ATV71_Var1 and TesysT_Var1), then you need to assign:
 ATV71_Var1 to TagContainer_ATV71
 TesysT_Var1 to TagContainer_TesysT

9 Generate the project. Generation

10 In the Communication Mapping tab (see page 682), perform the following Mapping
additional mappings for each I/O device that you have created for a Modbus TCP (communication
device: mapping for
 Select the corresponding topological entity (the Modbus TCP device). Supervision
 Select its communication service (MBTCPServiceServer or device-specific executables)
service).
 Verify the Modbus Unit ID value for the device and modify it as needed (refer
to the user manual of the device).
11 When using the OPC UA driver, you must create a symbol table (.csv) where the EcoStruxure
variable name and data type correspond to the values that you have entered for OPC UA Server
the Addr and Type parameters (see step 2). Expert
For details, refer to Modbus Device Address Space in the help of EcoStruxure Configuration
OPC UA Server Expert. Tool
12 Associate the symbol table file to the device alias by using the Symbol table file
browse button.
Verify that Symbol table is selected under Preload settings.

To complete the other steps to engineer the system, follow the system engineering life cycle
described in this manual.

922 EIO0000001114 06/2020

 Managing Communication

Implementing Monitoring of Modbus Serial Device Data

The table describes the specific steps that you need to perform to be able to monitor data of
Modbus serial devices directly from the Supervision infrastructure by using the OPC driver. It is
assumed that the required topological entities, Control and Supervision Participant projects, the
application instances, assignments, and mappings to implement communication with devices by
using Modbus explicit messaging (see page 877) already exist.

Step Description Stage

1 Create a Modbus TCP device entity by using the $EGenericDeviceHW Configuration
template (see page 584). The entity acts as a gateway.
2 Configure the IPAddress and SubnetMask parameters of the gateway entity.
If you are already using an application template of the Modbus serial device (for
example, an instance of $ATV71MB) and have linked it to an instance of the
$EGtwMB gateway application template, enter the GatewayAdd parameter
value of the gateway instance. Otherwise, enter the IP address of the gateway.
NOTE: Enter values for the read/write length and address parameters only if
you are going to implement I/O scanning with the gateway entity.
3 Connect the gateway entity to the same Ethernet network to which the station
node that is mapped to the I/O server is connected.
4 Instantiate a Supervision data facet template for each variable of a Modbus Instantiation
serial device that you want to monitor from Supervision. You can use the
following templates:
 $VariableTag_CD
 $AdvancedAlarm_CD
 $TrendTag_CD

Configure the identifiers of each instance so that the relationship with the
corresponding Modbus serial device can be easily seen.
NOTE: Select Facets as filter in the Browser pane.
5 If you are using trend tags, open the Links Editor from the trend tag instance
and link it to the variable tag instance so that the instance status becomes valid.
6 Configure instances of $VariableTag_CD as follows:
 Addr parameter (Configuration category): Address of the variable by
using the format Alias!%MW<i>.
For example, ATV61IOD_IODEVICE_1!%MW3233.
 Type parameter (Configuration category): Data type of the variable.
For example, UINT for ATV61IOD_IODEVICE_1%MW3233.
NOTE: Alternatively, you can specify the address for the device by adding an
appropriate entry in the citect.ini file. For details, refer to OPC Access Path
Parameters in the OPC Driver topic of the Driver Reference Help, which you
can open from the Windows® Start menu or from within the Supervision
Participant (Topology\I/O Devices).

EIO0000001114 06/2020 923

Managing Communication

Step Description Stage

7 Create additional tag containers (see page 394); one for each Modbus serial Project Definition
device that you want to monitor from Supervision. (Supervision)
Configure Protocol as OPC.
8 Create a dedicated communication board (see page 351) and configure Type
as OPC.
9 Create a communication port for each Modbus TCP device.
10 Create an I/O device (see page 348) for each tag container and configure the
following parameters:
 Address: Enter Schneider-Aut.OFS, which corresponds to the Prog ID
of the OFS server.
 TagContainers: Associate each I/O device to a separate tag container.
 Ports

11 Assign the Supervision facets related to each device to the corresponding tag Assignment
container.
For example, if you want to monitor two Modbus serial devices and for each
device, you have create one variable tag instance (ATV71MB_Var1 and
TesysTMB_Var1), then you need to assign:
 ATV71MB_Var1 to TagContainer_ATV71MB
 TesysT_Var1 to TagContainer_TesysT

12 Generate the project. Generation

13 In the Communication Mapping tab (see page 682), perform the following Mapping
additional mappings for the first I/O device that you have created for a Modbus (communication
serial device: mapping for
 Select the gateway as topological entity (instance of Supervision
$EGenericDeviceHW). executables)
 Select its communication service (MBTCPServiceServer).
 Enter the Modbus Unit ID value for the device. If you have already
configured an application template of the device (for example, an instance
of $ATV71MB), enter the ModbusAddress parameter value of the instance.
Otherwise, enter a unique serial slave ID for the device.
14 Repeat step 13 for each additional Modbus serial device by selecting the same
gateway entity but entering a new Modbus Unit ID value.

To complete the other steps to implement the system, follow the system engineering life cycle
described in this manual.

924 EIO0000001114 06/2020

 Managing Communication

Section 22.6
Communication with Devices by Using a PROFIBUS Master Module

Communication with Devices by Using a PROFIBUS Master

Module

Communication with Devices by Using a PROFIBUS Master Module

Overview
The topology supports the PMEPXM0100 PROFIBUS master module. The configuration of the
module is performed partially in the Topology Explorer and completed by using the external
ProSoft Configurator for Modicon. Additional steps need to be performed in various stages of the
system engineering life cycle.

Prerequisites
 Read and understand the PMEPXM0100 ProSoft User Manual, which is located in the Prosoft
Installer folder in the root of the EcoStruxure Process Expert installation package.
 Install ProSoft Configurator for Modicon on a computer.
The installation files are in the Prosoft Installer folder.
 Share a folder with the virtual machine (see EcoStruxure™ Process Expert, Installation and
Configuration Guide) to be able to import files into the Control Participant project.
NOTE: For the latest version of the tool and the manual, visit https://www.schneider-
electric.com/en/download.

EIO0000001114 06/2020 925

Managing Communication

Workflow
The table describes the workflow to integrate a PMEPXM0100 PROFIBUS master module and
slave devices into a system by using a standalone or redundant M580 controller.

Step Description Stage

1 Add a PMEPXM0100 PROFIBUS master module to an M580 standalone or Configuration
redundant controller.
NOTE: For details, including steps that you need to perform when using a
redundant controller, refer to the topic describing the configuration of the
PMEPXM0100 PROFIBUS master module. (see EcoStruxure™ Process Expert,
Control Participant Services, User Guide)
2 If you have templates of PROFIBUS slave devices, create instances thereof and Instantiation
configure them as needed.
NOTE: If you want to use device templates of a Schneider Electric library (for
example, $ATV71PB or $TeSysTPB), refer to the specific procedure describing
how to use them.
3 Assign the facets of application objects to the Control project and generate the Assignment and
project. Generation
4 With the help of the ProSoft Configurator for Modicon, configure the External
PMEPXM0100 master and slave devices by following the steps described in the
PMEPXM0100 ProSoft User Manual.
NOTE: In the Export EcoStruxure Control Expert Export Options dialog box
select Enhanced for I/O Scan Mode and select the folder that is shared with the
virtual machine as target location.
5 Refine the Control project and create the device DDT variable (see page 517) of Refinement
the PMEPXM0100 module.
NOTE: If you are using a redundant controller, create both device DDT variables.
6 Copy the exported project file to the folder that is shared with the VM –
(see EcoStruxure™ Process Expert, Installation and Configuration Guide).
7 Import the exported project file by following the steps described in the Refinement
PMEPXM0100 ProSoft User Manual.
NOTE: To access the file in the Control Participant, browse to the folder shared
with the VM by using the Network node and select the exported project file.
8 Analyze the Control project.
9 Build and deploy the Control project to the controller. Build and
Deployment

926 EIO0000001114 06/2020

 Managing Communication

Step Description Stage

10 With the help of the ProSoft Configurator for Modicon, download the master and External
slave device configuration to the module by following the steps described in the
PMEPXM0100 ProSoft User Manual.
11 Refine the deployed Control project online and follow the steps described in the Execution
PMEPXM0100 ProSoft User Manual to set the operating mode of the
PMEPXM0100 module.

To complete the other steps to engineer the system, follow the system engineering life cycle
described in this manual.

EIO0000001114 06/2020 927

Managing Communication

928 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Managing, Modifying, and Creating Templates
EIO0000001114 06/2020

Part IV
Managing, Modifying, and Creating Templates

Managing, Modifying, and Creating Templates

Overview
Creating, modifying, updating, replacing, or duplicating templates may affect the function of these
templates and/or systems, and must be performed by qualified personnel.
Refer also to the topic containing information about template design good practices and key
aspects (see EcoStruxure™ Process Expert, Global Templates, Reference Manual).

WARNING
LOSS OF CONTROL
After creating, updating, or modifying templates:
 Verify that templates generate correct addresses when their mapping interfaces are mapped
by using the Hardware Mapping Editor.
 Perform a Failure Mode and Effects Analysis (FMEA) of the system that contains new,
updated, or modified templates and apply preventive, detective controls before
implementation.
 Provide a fallback state for undesired control events or sequences.
 Provide separate or redundant control paths wherever required.
 Supply appropriate parameters, particularly for limits.
 Review the implications of transmission delays and take actions to mitigate.
 Review the implications of communication link interruptions and take actions to mitigate.
 Provide independent paths for control functions (for example, emergency stop, over-limit
conditions, and fault conditions) according to the safety analysis and applicable codes, and
regulations.
 Apply local accident prevention and safety regulations and guidelines .
1

 Test each implementation of a template for proper operation before placing it into service.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

1
For additional information, refer to NEMA ICS 1.1 (latest edition), Safety Guidelines for the
Application, Installation, and Maintenance of Solid State Control and to NEMA ICS 7.1 (latest
edition), Safety Standards for Construction and Guide for Selection, Installation and Operation of
Adjustable-Speed Drive Systems or their equivalent governing your particular location.

EIO0000001114 06/2020 929

Managing, Modifying, and Creating Templates

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
23 Global Templates Library 931
24 Global Templates Editors 943
25 Managing Global Templates 977

930 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Global Templates Library
EIO0000001114 06/2020

Chapter 23
Global Templates Library

Global Templates Library

Overview
This chapter describes the Global Templates library, the tools that are available to manage it, and
context menu commands.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Global Templates Explorer 932
Global Templates Folders 939
Global Templates 940

EIO0000001114 06/2020 931

Global Templates Library

Global Templates Explorer

Overview
The Global Templates Explorer shows the templates of the Global Templates library, which
regroups the Schneider Electric libraries for EcoStruxure Process Expert that are installed (for
example, the Foundation Library, the General Purpose Library) as well as templates that you
create and/or import.
These templates are displayed the in the form of a folder structure and can be of the following
types:
 Interface models
 Facet templates
 Composite templates

The Global Templates Explorer allows you to perform the following actions on Global Templates:
 Browse Global Templates.
 Export and import templates (see page 978).
 Open template editors (see page 943).
 Create copies of templates (see page 982).
 Create (see EcoStruxure™ Process Expert, Global Templates, Reference Manual) your own
folders (see page 939) and templates.
 Update and replace templates (see page 998).

Opening the Global Templates Explorer

Open the Global Templates Explorer by clicking the Global Templates button in the toolbar
(see page 115).

932 EIO0000001114 06/2020

 Global Templates Library

Global Templates Explorer

The following figure shows an example of the Global Templates Explorer window. The content of
the folder structure may vary depending on the libraries that are installed.

1 Toolbox pane (see page 936). The pin button allows you to minimize the Toolbox pane to the
left edge of the screen. Move the pointer above the Toolbox tab to display the pane. Click the
pin button again to restore the pane.
2 Global Templates library root folder.
3 Tree view of the installed libraries. You can open parts of the tree view in new windows.
4 Search field (see page 934).

EIO0000001114 06/2020 933

Global Templates Library

Global Templates Naming Convention

The Schneider Electric Global Templates follow a naming convention:
$NAME_XX
Where
 $ indicates that the template is provided by Schneider Electric.
 NAME is the name of the template
 _XX indicates the type of the template. Control module templates have no suffix.

NOTE: Some templates provided by Schneider Electric may not have the $ prefix to indicate that
you can modify them to meet your specific requirements.
The table describes the suffixes that are used to identify types of Global Templates.

Suffix Description
_UL Control logic facet template.
_UH Control HMI facet template.
_UC Control logic and HMI composite template.
_CD Supervision data composite and facet templates.
_CG Supervision genie composite and facet templates.
_CS Supervision composite template.
_CR Supervision server composite template.
_CC Supervision client composite template.

Searching Global Templates

The search field of the Global Templates Explorer lets you find templates and folders by typing the
entire or part of their identifier. You do not need to use wildcards. The search is not case-sensitive.
Results are displayed as you type in a pane with columns. Your last three matching search
keywords are stored and appear in a keyword menu. The stored keyword entries persist even after
the system server is restarted.
For example, va returns templates and folders that contain va in their identifier, such as templates
$Valve, $HValve_CD, and folder Advantys.
By default, results are displayed in ascending alphabetical order with folders shown first, templates
next.
The results pane provides basic information on templates and remains open until you close it by
clicking the close button. A tooltip provides additional information.

934 EIO0000001114 06/2020

 Global Templates Library

The following figure shows an example of the search results that can be shown when you enter
sign in the search field.

Right-click a search result in the results pane to open a context menu with the following commands.

Command Description
Navigate  For a template: Opens/expands the containing folder and highlights the instance.
 For a folder: Expands the folder structure and selects the folder.

You can also double-click the item.

NOTE: If the template is hidden because a filter is applied, the template is not shown
but the border of the folder containing the instance flashes briefly.
Open The command is available for folders only.
Opens a new Global Templates Explorer workspace and displays only the folder.
NOTE: Searches that you perform by using the search field of this workspace are
limited to the contents of the folder.
Inspect These commands are available for templates only.
For a description of these commands, refer to the topic describing Global Templates
Read-Only
actions (see page 940).
Edit

You can sort and filter (see page 138) search results.
NOTE: Search results are not updated automatically if templates or folders were created, modified,
or deleted in the meantime. You need to start over the search by clicking the search field and
pressing Enter.

EIO0000001114 06/2020 935

Global Templates Library

Global Templates Toolbox

The Toolbox contains the following base Global Templates, which you can use to create new
templates or modify (see page 943) existing ones:
 Interface models
 Facet templates
 Composite templates

Templates are grouped in the following categories:

 Platform: Templates and interface models that are used at the platform level. These templates
can reference components of this category and/or of the other two categories.
 Control: Facet templates that encapsulate constituents of the Control Participant. You can
reference them inside composite templates.
 Supervision: Facet templates that encapsulate constituents of the Supervision Participant. You
can reference them inside composite templates.
The table describes the items that are in the Platform category.

Item Description
Composite Template Generic template that you can use to:
 Reference facet templates and other composite templates.
 Build control module templates.

Composite Device IO and Topological templates that you can use to model devices and their decentralized
Device IO (facet I/O modules in the topology of the system:
templates)  Devices (energy and motor devices, instrumentation...)
 STB island I/O modules

NOTE: You can use this type of template to model third-party devices in the
topology of a system if they will be connected to the network of such a system as
nodes.
Composite Generic and Topological templates that you can use to model unknown devices in a generic
Generic (facet templates) manner.
Interface Model Object that you can define to create interfaces, which you can use to:
 Link to each other facet and/or composite templates referenced by a control
module template during template creation.
 Expose connectors that allow linking instances to each other during
instantiation.
Network Topological template that you can use to model the following types of networks
that are used in the topology of a system:
 Ethernet
 Modbus
 CANopen
 PROFIBUS DP
 RIO S908
 RIO Ethernet
 Local bus of topological entities

936 EIO0000001114 06/2020

 Global Templates Library

Item Description
Composite Network Topological templates that you can use to model network devices that are used
Device and Network in the topology of a system (for example, switches, routers, gateways...).
Device (facet templates)
Composite Station Node Topological templates that you can use to model the hardware and software
and Station Node (facet components of a workstation in the topology of a system:
templates)  Network interface card (NIC)
 Citect SCADA software
 OPC Factory Server and OPC UA Server Expert software
 Control Expert software
 Platform and platform backup servers

The table describes the templates that are in the Control category.

Item Description
Composite Topological templates that you can use to model controller hardware modules (CPUs,
Controller and power supplies, network cards, I/O modules, and so on) of supported platforms
Controller (facet (see EcoStruxure™ Process Expert, Control Participant Services, User Guide).
templates)
NOTE: Do not use this type of template to model distributed I/O modules such as
STB island I/O modules, for example in the topology of a system. Use a Platform
DeviceIO template instead.
HMI Application Control facet template that you can use to model one operator screen.
Logic Application Control facet template that you can use to encapsulate Control constituents
to implement a specific function.
For example, you can encapsulate a DFB and one or more variables to manage on/off
motor functions.

The table describes the templates that are in the Supervision category:

Item Description
Client Event Application client script facet template that you can use to create an event to be
executed during runtime in the context of the Supervision client.
Data Application Supervision facet template that you can use to model tags and user
interface messages required for runtime data acquisition.
Genie Application Supervision facet template that you can use to encapsulate an animated
graphic (genie), which is contained in a Citect SCADA included project (see page 546)
and which displays data of the associated control module during runtime.
Server Event Application server script facet template that you can use to create an event to be
executed during runtime in the Supervision server.

EIO0000001114 06/2020 937

Global Templates Library

Opening Items in a New Window

You can open part of a folder structure that appears in the Global Templates Explorer in a new
explorer window.
To open a folder structure in a new window, proceed as follows.

Step Action
1 Drag the folder onto the tabs bar of the work area.
Result: The folder opens in a new window as a parent folder.
NOTE: If several work areas are open, you can drag the folder to the tabs bar of another work area.

The following figure shows an example where by expanding the sample General Purpose Library
folder and dragging the Process folder to the tabs bar, a new explorer window opens in which the
Process folder is the parent folder of the structure.

Recovery Folder
When you start the system server, if the software detects missing references in templates, it
creates the Recovery folder. You can see the folder in the Global Templates Explorer.
This folder contains the templates that are missing.
This can be the case, for example, after migrating the database of an earlier version. If the
database contains a template that is used by another template (determined by using the Used By
command) but you cannot locate this parent template by searching for it, most likely you can find
it in the Recovery folder.
You can work with templates inside the Recovery folder like with any other templates by right-
clicking them and selecting an action (see page 940).

938 EIO0000001114 06/2020

 Global Templates Library

Global Templates Folders

Creating Global Templates Folders

To create a Global Templates folder, proceed as follows.

Step Action
1 Right-click the Global Templates root folder or an existing folder in the Global Templates
Explorer and select Create Folder.
Result: It creates a folder with the identifier in edit mode and displays it in the tree view.
2 To change the identifier, type it; otherwise, press Enter to accept the default name.

Global Templates Folder Actions

Right-click a Global Templates folder to open a context menu with the following commands.

Command Description
Create Folder Creates a new folder and displays it in the tree view.
Create Opens a submenu that allows you to create in the folder any base composite and
facet template, which is available in the Toolbox.
Copy (see page 982) Copies the folder, any subfolders and their contents.
Paste (see page 982) Pastes the items that you have copied last to a new location.
Export (see page 983) Opens the Export dialog box, which allows you to select which templates
contained in the folder, including any subfolders you want to export to a file in .sbk
format.
Import (see page 987) Opens the Import dialog box, which allows you to select an export file in .sbk
format and displays the compatible contents that you can select for import.
Purge (see page 995) Opens the Purge dialog box, which allows you to select templates to purge in the
folder and any subfolder.
Delete Deletes the folder and its contents from the database after you confirm the
command.
The command is not available if the folder or any subfolder contains a template.
Rename Lets you enter a new name for the folder.
The command is not available if the folder or any subfolder contains a template.

EIO0000001114 06/2020 939

Global Templates Library

Global Templates

Global Templates Description

The following fields are displayed in a Global Templates folder in the tree view of the Global
Templates Explorer.

Field Description
Identifier The fields come from the header of the composite/facet template or interface.
Refer to the following topics for a description of the fields for:
Version
 Composite templates (see EcoStruxure™ Process Expert, Global Templates,
Type Reference Manual)
Subtype  Facet templates (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual)
Valid
 Interface models (see EcoStruxure™ Process Expert, Global Templates, Reference
State Manual)
Description

Global Templates Actions

Right-click a template in the Global Templates Explorer to open a context menu with the following
commands.

Command Description
View Opens the template in the corresponding editor in view-only mode.
The editor allows you to view the composition of the template or interface.
NOTE: A password may be required to view a template.
Edit Opens the template in the corresponding editor in edit mode.
(see page 944) The editor allows you to view and modify the definition and composition of the template or
interface.
NOTE: A password may be required to edit a template.
State Opens a submenu that allows you to set the usability state (see EcoStruxure™
Process Expert, Global Templates, Reference Manual) of the template to either Obsolete
or Deprecated.
The command is available only if:
 The template is used by an instance or referenced by another template.
 A higher version of the template exists.
 The usability state of the next highest version of the template is Approved.

Inspect Allows you top open the Used By, Dependencies Tree, or External References panes
(see page 969) in which you can view respectively:
 The templates that reference it.
 Templates that it references. For each reference you can view its interfaces.
 Systems in which an instance of the template exists.

940 EIO0000001114 06/2020

 Global Templates Library

Command Description
Locations Opens a submenu that allows you view where the template is located. If the template is
present at more than one location:
 The current location is grayed out.
 You can click the other locations to open the folder and highlight the template.

Copy Copies the template for pasting.

(see page 982)
Export Opens the Export dialog box, which allows you to save the template data to an export file
(see page 983) in .sbk format.
Remove Removes the copy of the template.
The command is available only if copies (see page 982) of the template exist.
When only one instance of the template remains, the command is replaced by Delete.
Delete Deletes the template from the database after you confirm the command.
The command is not available if either condition is satisfied:
 The template is referenced by another template, which is not being deleted.
 The template is used by a facet of in a system.

Update Opens the Update dialog box, which allows you to create a new version of the template by
(see page 1001) using the latest version of any referenced child templates that exist in the Global
Templates library.
Duplicate Opens the Duplicate window, which allows you to create, in a single step, a copy or new
(see page 1013) version of the template with the possibility to keep, duplicate, or replace any child template
that is references.

EIO0000001114 06/2020 941

Global Templates Library

942 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Global Templates Editors
EIO0000001114 06/2020

Chapter 24
Global Templates Editors

Global Templates Editors

Overview
This chapter describes the Global Templates editors, which allow you to view and edit the entire
definition of Global Templates. They also allow you to create new templates based on existing
ones or by starting from empty base templates.
You can view and edit:
 Composite templates by using the Composite Editor.
 Facet templates by using the Facet Editor.
 Interface models and interfaces by using the Interface Editor.

Starting from the control module template level, you can drill down through the entire composition
of the template. At each level, you can view dependencies and which templates reference the one
you are viewing or editing.
NOTE: Some of the commands that are described in this chapter may not be available when you
open a template editor in read-only mode.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
24.1 Opening Global Templates Editors 944
24.2 Interface Editor 945
24.3 Facet and Composite Template Editors 953
24.4 Common Template Editor Components 962

EIO0000001114 06/2020 943

Global Templates Editors

Section 24.1
Opening Global Templates Editors

Opening Global Templates Editors

Opening Global Templates Editors

Overview
Modifying Schneider Electric Global Templates or templates created by users may affect the
function of these templates and must be performed by qualified personnel. Before proceeding,
refer to the Overview of this part (see page 929).

Opening Global Templates Editors

To open a Global Templates editor, you need to open a template. You cannot open a Global
Templates editor without opening a template either in read-only or editing mode.

Step Action
1 In the tree view of the Global Templates Explorer, open the folder that contains the template that
you want to view or edit.
2 Right-click the template and select:
 Read-only to open the template in the corresponding editor in read-only mode.This mode
does not allow you to change the definition of the template.
The background of the workspace has a light shade of gray to distinguish it from the editing
mode.
 Edit to open the template in the corresponding editor in editing mode.This mode allows you
to modify the entire definition of the template.
NOTE: Double-clicking the template opens the corresponding editor in read-only mode by
default.

NOTE: From the Global Templates explorer, you can also look up templates by entering a key word
in the search field (see page 933). In the list of results, right-click the template and select Read-
only or Edit. The software opens the selected template in the corresponding editor in either mode.

Working Copy of Templates

When you open a template in read-only or editing mode, the software creates a temporary working
copy of the template with the same identifier and a specific version (see EcoStruxure™
Process Expert, Global Templates, Reference Manual). It removes this working copy when you
close the template editor.

944 EIO0000001114 06/2020

 Global Templates Editors

Section 24.2
Interface Editor

Interface Editor

Interface Editor

Introduction
The graphical Interface Editor allows you to manage the entire definition of interface models and
interfaces.
This topic describes the panes, toolbars, and menus of the Interface Editor.
Certain menus and commands may be available only in editing mode.
NOTE: This topic provides information on the Interface Editor user interface; it does not provide
information on the definition of interface models or interfaces (see EcoStruxure™ Process Expert,
Global Templates, Reference Manual).

EIO0000001114 06/2020 945

Global Templates Editors

Interface Editor
The following figure shows an example of the Interface Editor in edit mode.

1 Graphical representation of role A of the interface

2 Graphical representation of role B of the interface
3 Interface Header pane
4 Toolbox pane
5 Elements and Rules panes for role A of the interface
6 Elements and Rules panes for role B of the interface
7 Button to show the interface Browser pane
8 Editor toolbar containing commands that apply to the interface being viewed or edited
9 Workspace. You can use the mouse to move the view (see page 120).

946 EIO0000001114 06/2020

 Global Templates Editors

Editor Panes
The Interface Editor uses various panes to group properties and data that are related. The table
describes the purpose of the panes.

Pane Description
Header Allows you to view and/or edit general properties of the interface.
Toolbox Allows you to browse and select transformation functions (see EcoStruxure™
Process Expert, Global Templates, Reference Manual) to be used in the template.
Elements Allows you to view, create, and modify elements of a role of the interface.
Rules Allows you to view, create, and modify rules for the elements of a role of the
interface.
Browser Allows you to search interface models and interfaces that are available in the
Global Templates library.
Move the pointer over the Browser tab to display the pane. Click the pin button to
toggle between minimized and visible pane view.
NOTE: The pane is available only in editing mode.
Used By(1) Allows you to view the templates and interfaces that reference the interface, which
is open in the editor. You can right-click a template or interface in the Used By pane
to open it in a new editor. You can also view its dependencies (see page 947) or
which other templates reference it.
Locations(1) Allows you to view the path to the interface and its copies (see page 982).
Right-click an entry and select Open Reference Container to open the
corresponding folder in the Global Templates explorer.
Changes Log(1) Keeps track of changes that are made to the interface and saved. The pane
indicates:
 The action that was performed.
 The state of the interface after the change.
 The mandatory description of changes that is entered when the interface is
saved.
 The version of the interface after the change.
 The user name of the user logged in to the engineering client.

(1) Use the corresponding command in the editor menu to open the pane.

NOTE: For information on working with panes, refer to the topic describing the engineering client
workspace (see page 127).

EIO0000001114 06/2020 947

Global Templates Editors

Additional Information
The list indicates where you can find a detailed description of the contents of the Interface Editor
panes:
 Header definition (see EcoStruxure™ Process Expert, Global Templates, Reference Manual)
and header common definition (see EcoStruxure™ Process Expert, Global Templates,
Reference Manual) (shared among interface models, facet, and composite templates).
 Elements definition (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual).
 Rules definition editors (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual).
 Interface toolbox (see EcoStruxure™ Process Expert, Global Templates, Reference Manual).

Editor Toolbar
The figure shows the toolbar that is located in the top right-hand corner of the Interface Editor.

Item Description
1 Edit button.
Switches the editor from read-only to editing mode.
2 Save button.
Opens the Save dialog box.
For more information, refer to the topic describing how to save changes in templates (see page 979).
3 Save as button.
Opens the Save as dialog box.
For more information, refer to the topic describing how to save changes in templates (see page 979).
4 Undo and redo buttons.
Lets you undo and redo most actions.
5 Opens the editor menu that contains editor-specific commands.

948 EIO0000001114 06/2020

 Global Templates Editors

Editor Menu
The table describes the commands that are available in the editor menu of the Interface Editor.

Command Description
New... Opens the Global Templates dialog box, which contains the same base
templates as the Toolbox of the Global Templates explorer. It allows you to
create a new template in one or more existing folders of the Global
Templates library and open it in edit mode in the corresponding editor.
For more information, refer to the topic describing how to create templates
(see EcoStruxure™ Process Expert, Global Templates, Reference
Manual).
View Used By The commands allow you to bring the corresponding pane to the front.
If the pane is closed, the command opens it.
Locations
For a description of the panes, refer to the topic describing template editor
panes.
Save Save button.
Opens the Save dialog box.
For more information, refer to the topic describing how to save changes in
templates (see page 979).
Save As Save as button.
Opens the Save As dialog box.
For more information, refer to the topic describing how to save changes in
templates (see page 979).
Export Standard Opens the Export window, which allows you to export the interface
Backup definition to file (.sbk).
You can only export an interface if you have saved changes.
For more information on export feature, refer to the topic describing
template export (see page 983).
Various image Each command opens a Save dialog box, which allows you to create an
file formats image file with the corresponding file extension. The image captures the
contents of the workspace as if it were shown with the Fit to content display
ratio.
Panes and toolbars are not captured.
Show Changes Log Opens the Changes Log pane (see page 952).
Close Closes the template editor.
If you have made changes, opens the Save dialog box.
For more information, refer to the topic describing how to save changes in
templates (see page 979).

EIO0000001114 06/2020 949

Global Templates Editors

Workspace Actions
Right-click an empty area of the workspace to open a context menu with the following commands.

When you select... The software...

Inspect opens a submenu with the Used By (see page 947) and Dependencies Tree
(see page 947) commands.
Show changes log opens the Changes log pane. (see page 952)

Interface and Interface Element Actions

Right-click the header of an interface role in the workspace to open a context menu with the
following command.

When you select... The software...

Rename allows you to modify the identifier of the role.
For more information, refer to the topic describing interface roles (see EcoStruxure™
Process Expert, Global Templates, Reference Manual).

Right-click an element of an interface role to open a context menu with the following commands.
Commands may vary depending on the role of the element.

When you select... The software...

Switch to Optional sets the rule for the element, which is the producer to optional. In such case, the
element is not required to provide data for the interface link to be valid.
The default value is required.
NOTE: If you set a role to optional and later you change the role to consumer, the role
is reset to required.
Switch to Required sets the rule for the element, which is the producer to required (default value). In such
case, the element is required to provide data for the interface link to be valid.
Use as Consumer switches the direction from producer to consumer.
NOTE: Using this command resets the element rule to required if it was set to
optional.
Use as Producer switches the direction from consumer to producer.

950 EIO0000001114 06/2020

 Global Templates Editors

When you select... The software...

Switch Mode switches the mode of the link between role A and role B of an element from Direct to
Transform and the other way around.
Right-clicking an element and switching the mode to:
 Transform
 Removes the direct link between role A and role B of the element.
 Removes the element from the other role.
 Requires that you create a new element in the other role with mode Transform
and with the opposite direction.
 Direct
 Removes the link between the element and the transformation function.
 Creates the element in the other role of the interface.
 Creates a direct link between both roles of the element.
 Requires that you reconfigure the transformation function, and possibly the
elements that are still linked to it.
NOTE: When you switch the mode to Transform, verify that the cardinality that is
defined in the Header pane for either role A or role B makes it possible to use
transformation functions.
NOTE: The command is not available for nested interfaces.
Delete deletes the element from both roles of the interface.

Right-click a nested interface of an interface role to open a context menu with the following
commands. Commands may vary depending on the role of the element.

When you select... The software...

Switch to Optional sets the rule for the element to optional. In such case, the element is not required to
provide data for the interface link to be valid.
The default value is required.
NOTE: The command is available by default for the Def role of the nested interface. To
make the command available for the Ref role, add the element to the Rules table first
by using the Add to Rules table command first.
Switch to Required sets the rule for the element, which is the producer to required (default value). In such
case, the element is required to provide data for the interface link to be valid.
Add to Rules table adds the element that has the Ref role to the Rules table so that you can define a rule
for it (optional or required).
Remove from removes the element that has the Ref role from the Rules table.
Rules table
NOTE: Removing the element from the Rules table makes the Switch to Optional and
Switch to Required commands unavailable.
Inspect opens a submenu with the Used By and Dependencies Tree (see page 947)
commands.
Read-only opens the nested interface in another Interface Editor in read-only mode.

EIO0000001114 06/2020 951

Global Templates Editors

When you select... The software...

Edit opens the nested interface in another Interface Editor in editing mode.
Update Allows you to update the version of the nested interface to the latest one, which exists
in the Global Templates library.
Replace Opens the Replace dialog box. It allows you to replace the nested interface by a different
one, which exists in the Global Templates library.
Delete deletes the nested interface from both roles of the interface.

Viewing Changes to Interfaces

The submenu of the editor menu contains the Show changes log command, which opens the
Changes log pane. This pane keeps track of the changes that are made to the template and saved.
It indicates:
 The action that was performed.
 The state of the template after the change.
 The mandatory description of changes that is entered when the template is saved.
 The version of the template after the change.
 The user name of the user logged in to the engineering client.

Saving Changes
Refer to Saving Changes in Global Templates (see page 979).

952 EIO0000001114 06/2020

 Global Templates Editors

Section 24.3
Facet and Composite Template Editors

Facet and Composite Template Editors

Overview
This topic describes the user interface of the Facet Editor and Composite Editor.

What Is in This Section?

This section contains the following topics:
Topic Page
Facet Editor 954
Composite Editor 958

EIO0000001114 06/2020 953

Global Templates Editors

Facet Editor

Overview
The graphical Facet Editor allows you to manage the entire definition of Control and Supervision
facet templates.
For a description of panes, toolbars, and menus, refer to the topic describing common template
editor components (see page 962).
NOTE: This topic provides information on the Facet Editor user interface; it does not provide
information on the definition of facet templates (see EcoStruxure™ Process Expert, Global
Templates, Reference Manual).

Facet Editor
The following figure shows an example of the Facet Editor.

1 Document Outline, Toolbox, and Browser panes.

2 Properties and Interface Rules panes.
3 Parameters pane.
4 Workspace area displaying a graphical representation of the elements of the template that you are editing.

954 EIO0000001114 06/2020

 Global Templates Editors

5 Editor toolbar (see page 963) containing commands that apply to the template being viewed or edited.
6 Workspace toolbar (see page 964).
7 Radar view (see page 972).

Workspace Actions
For a description of the context menu that opens when you right-click an empty area of the
workspace, refer to the description of the workspace context menu (see page 968).

Element Actions
Right-click the header of an element in the workspace of the Facet Editor to open a context menu
with the following commands.

Command Description
Optimize Reroutes bindings of the element correctly.
Bindings
Show/Hide Shows or hides properties whose eye icon that is located on the right-hand side is not
Unchecked visible (unchecked).
To uncheck a property, click its icon. The icon disappears.
NOTE: A property that has a binding connected to it cannot be hidden.
Show/Hide Shows or hides properties that have no binding connected.
Unbound
Go To Opens a submenu that contains the name and path of other objects and/or their properties
that are linked to the element through bindings. It lets you locate them (see EcoStruxure™
Process Expert, Global Templates, Reference Manual) easily. When you select an entry,
the object and the binding are highlighted in the workspace.
Copy Copies the element for pasting in this template or another template.
Exclude After you confirm the command, removes the element from the workspace and makes it
available again in the Elements section of the Document Outline pane.
Any existing bindings with the element are discarded.
NOTE: The command is available only for Control elements.
Delete After you confirm the command, removes the element from the facet template.
Any existing bindings with the element are discarded.
NOTE: The command is available only for certain types of elements.
Rename Allows you to modify the identifier of the element.
Properties Displays the properties of the element in the Properties pane.

EIO0000001114 06/2020 955

Global Templates Editors

Right-click the property of an element in the workspace of the Facet Editor to open a context menu
with the following commands.

Command Description
Create Allows you to create a parameter that you can customize (see EcoStruxure™
Parameter Process Expert, Global Templates, Reference Manual).
Create Input Allows you to enter an absolute value.
Value
Show/Hide Displays or hides the $IsConnected property, which outputs the boolean value TRUE
$IsConnected when the interface link is successfully established. This implies that applicable interface
and interface element rules are satisfied; otherwise the value is FALSE.
The command is available for interfaces only.
Go To Opens a submenu that contains the name and path of other objects and/or their properties
that are linked to this property through bindings. It lets you locate them (see EcoStruxure™
Process Expert, Global Templates, Reference Manual) easily. When you select an entry,
the object and the binding are highlighted in the workspace.
Binding To Here Use this command (see EcoStruxure™ Process Expert, Global Templates, Reference
From... Manual) on the property that is the destination of the binding to be created.
It enables the Bind to command.
Binding From Use this command (see EcoStruxure™ Process Expert, Global Templates, Reference
Here To... Manual) on the object that is the source of the binding to be created.
It enables the Bind from command.
Properties Displays the properties of the element in the Properties pane.

Right-click the header of an interface element in the workspace of the Facet Editor to open a
context menu with the following commands.

Command Description
Switch to Optional: Makes the element optional in the context of the template.
Optional/Required The element is represented with a dotted outline.
Required: Makes the element mandatory in the context of the template.
The element is represented with a solid outline.
Optimize Bindings Reroutes bindings of the element correctly.
Show/Hide Shows or hides properties whose eye icon that is located on the right-hand side is not
Unchecked visible (unchecked).
By default, each property is checked; the icon is visible.
To uncheck a property, click its icon. The icon disappears.
NOTE: A property that has a binding connected to it cannot be hidden even if it is
unchecked.
Show/Hide Shows or hides properties that have no binding connected.
Unbound

956 EIO0000001114 06/2020

 Global Templates Editors

Command Description
Inspect allows you top open the Used By or Dependencies Tree panes in which you can view
respectively:
 The templates that reference it.
 Elements that it references (not applicable for interfaces).

Read-Only Opens the element in the corresponding editor in read-only mode.

Edit Opens the element in the corresponding editor in edit mode.
Go To Opens a submenu that contains the name and path of other objects and/or their
properties that are linked to the element through bindings. It lets you locate them
(see EcoStruxure™ Process Expert, Global Templates, Reference Manual) easily.
When you select an entry, the object and the binding are highlighted in the workspace.
Copy Copies the element for pasting in this template or another template.
Update Allows you to update the version of the interface model that is used by the interface to
(see page 1001) the latest one, which exists in the Global Templates library.
Replace Opens the Replace dialog box. It allows you to replace the interface model that is used
(see page 1006) by the interface by a different one, which exists in the Global Templates library.
Delete Removes the element from the template.
Rename Allows you to modify the identifier of the element.
Properties Displays the properties of the element in the Properties pane.

Additional Information
The list indicates where you can find a detailed description of the contents of the various panes of
the Facet Editor:
 Properties (see EcoStruxure™ Process Expert, Global Templates, Reference Manual) and
properties common definition (see EcoStruxure™ Process Expert, Global Templates,
Reference Manual) (shared among interface models, facet, and composite templates).
 Facet Elements (see EcoStruxure™ Process Expert, Global Templates, Reference Manual)
 Interfaces Rules (see EcoStruxure™ Process Expert, Global Templates, Reference Manual)
 Toolbox: binding functions (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual) and/or Supervision Participant elements (see page 969).
 Parameter pane (see EcoStruxure™ Process Expert, Global Templates, Reference Manual)

Viewing Changes to Templates

Refer to the topic describing the Changes log pane (see page 969).

Saving Changes
Refer to Saving Changes in Global Templates (see page 979).

EIO0000001114 06/2020 957

Global Templates Editors

Composite Editor

Overview
The graphical Composite Editor allows you to manage the entire composition and definition of
composite templates.
For a description of panes, toolbars, and menus, refer to the topic describing common template
editor components (see page 962).
NOTE: This topic provides information on the Composite Editor user interface; it does not provide
information on the definition of composite templates (see EcoStruxure™ Process Expert, Global
Templates, Reference Manual).

Composite Editor
The following figure shows an example of the Composite Editor.

1 Document Outline, Toolbox, and Browser panes.

2 Properties, Interface Rules, and Element Rules panes.
3 Parameters pane.

958 EIO0000001114 06/2020

 Global Templates Editors

4 Workspace area displaying a graphical representation of the elements of the template that you
are editing.
5 Editor toolbar (see page 963) containing commands that apply to the template being viewed or
edited.
6 Workspace toolbar (see page 964).
7 Radar view (see page 972).

Workspace Actions
For a description of the context menu that opens when you right-click an empty area of the
workspace, refer to the description of the workspace context menu (see page 968).

Element Actions
Right-click the header of an element in the workspace of the Composite Editor to open a context
menu with the following commands.

Command Description
Switch to Optional: makes the element optional in the context of the template.
Optional/Required The element is represented with a dotted outline.
Required: makes the element mandatory in the context of the template.
The element is represented with a solid outline.
Defer Defers items to make them available in the top-level template referencing the composite
that you are editing (for example, in the control module).
Selecting the command displays a submenu with the following commands:
 Unbound selection/parameters: Makes available any element selection (only optional
elements) and parameters for which no binding exists.
 Unbound interfaces: Makes available any interfaces for which no binding exists.
 All unbound: Makes available any element selection (only optional elements),
parameters, and interfaces for which no binding exists.
Optimize Bindings Reroutes bindings of the element correctly.
Show/Hide Shows or hides properties whose eye icon that is located on the right-hand side is not
Unchecked visible (unchecked).
To uncheck a property, click its icon. The icon disappears.
NOTE: A property that has a binding connected to it cannot be hidden.
Show/Hide Shows or hides properties that have no binding connected.
Unbound
Inspect Allows you top open the Used By, Dependencies Tree, or External References panes
(see page 969) in which you can view respectively:
 The templates that reference it.
 Elements that it references. For each reference, you can view its interfaces.
 Systems in which an instance of the template exists.

Read-Only Opens the element in the corresponding editor in read-only mode.

Edit Opens the element in the corresponding editor in edit mode.

EIO0000001114 06/2020 959

Global Templates Editors

Command Description
Go To Opens a submenu that contains the name and path of other objects and/or their
properties that are linked to the element through bindings. It lets you locate them
(see EcoStruxure™ Process Expert, Global Templates, Reference Manual) easily.
When you select an entry, the object and the binding are highlighted in the workspace.
Copy Copies the element for pasting in this template or another template.
Update Allows you to update the version of the template that is used by the element to the latest
(see page 1001) one, which exists in the Global Templates library.
In case of an interface element, lets you replace the interface model.
Replace Opens the Replace dialog box. It allows you to replace the template that is used by the
(see page 1006) element by a different one, which exists in the Global Templates library.
In case of an interface element, lets you replace the interface model.
Delete Removes the element from the template.
Rename Allows you to modify the identifier of the element.
Properties Displays the properties of the element in the Properties pane.

Right-click the parameter of an element in the workspace of the Composite Editor to open a context
menu with the following commands.

Command Description
Create Deferred Defers the parameter to make it available in the top-level template referencing the
composite that you are editing.
The other commands are described in the table describing the context menu commands of properties of
elements of facet templates (see page 955).

Right-click the interface of an element in the workspace of the Composite Editor to open a context
menu with the following commands.

Command Description
Create Deferred Defers the interface to make it available in the top-level template referencing the composite
that you are editing.
Create Shows the interface as an element of the template.
Extended
Explode  Collapsed state: Makes a connector available that represents the complete interface.
Implode The connection is made by using an interface link (shown in orange).
 Expanded state: Makes each element of a multi-element interface available individually
for connection to other elements by using bindings (shown in gray).
Inspect Allows you top open the Used By or Dependencies Tree panes in which you can view
respectively:
 The templates that reference it.
 Nested interfaces that it references.

Read-Only Opens the interface in the corresponding editor in read-only mode.

960 EIO0000001114 06/2020

 Global Templates Editors

Command Description
Edit Opens the interface in the corresponding editor in edit mode.
Go To Opens a submenu that contains the name and path of other objects and/or their properties
that are linked to the interface through bindings. It lets you locate them (see EcoStruxure™
Process Expert, Global Templates, Reference Manual) easily. When you select an entry,
the object and the binding are highlighted in the workspace.
Properties Displays the properties of the interface in the Properties pane.

NOTE: Additional commands are described in the topic describing actions for properties of
elements (see page 955) in the Facet Editor.

Additional Information
The list indicates where you can find a detailed description of the contents of the various panes of
the Composite Editor:
 Properties (Header) (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual) and properties common definition (see EcoStruxure™ Process Expert, Global
Templates, Reference Manual) (shared among interface models, facet, and composite
templates).
 Composite Elements (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual)
 Interfaces Rules (see EcoStruxure™ Process Expert, Global Templates, Reference Manual)
 Toolbox: binding functions (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual)
 Parameter pane (see EcoStruxure™ Process Expert, Global Templates, Reference Manual)

Viewing Changes to Templates

Refer to the topic describing the Changes log pane (see page 969).

Saving Changes
Refer to Saving Changes in Global Templates (see page 979).

EIO0000001114 06/2020 961

Global Templates Editors

Section 24.4
Common Template Editor Components

Common Template Editor Components

Overview
The Facet Editor and Composite Editor have several components in common, which are described
in this topic. Items that are specific to either editor are pointed out.

What Is in This Section?

This section contains the following topics:
Topic Page
Common Template Editor Toolbars and Menus 963
Common Template Editor Panes 969
Using the Radar View 972
Using the Simplified View in Template Editors 973

962 EIO0000001114 06/2020

 Global Templates Editors

Common Template Editor Toolbars and Menus

Overview
The Facet Editor and Composite Editor feature toolbars and menus, which allow you to access the
various tools and functions that you require to create and edit Global Templates.
This topic describes toolbars and menus that the Facet Editor and Composite Editor have in
common. Those that are specific to either editor are pointed out.
Certain menus and commands may be available only in editing mode.
NOTE: Toolbars contain commands that apply to the template that is being viewed or edited. To
interact with an element of a template, open the context menu of the element by right-clicking it.

Editor Toolbar
The figure shows the editor toolbar that is located in the top right-hand corner of the Facet Editor
and Composite Editor.

Item Description
1 Edit button.
Switches the editor from read-only to editing mode.
2 Save button.
Opens the Save dialog box.
For more information, refer to the topic describing how to save changes in templates (see page 979).
3 Save as button.
Opens the Save As dialog box.
For more information, refer to the topic describing how to save changes in templates (see page 979).
4 Undo and redo buttons.
Lets you undo and redo most actions.
5 Displays the Parameters pane.
6 Displays the Dependencies Tree pane.
7 Displays the Used By pane.
8 Displays the External References pane.

EIO0000001114 06/2020 963

Global Templates Editors

Item Description
9 Opens the Select Variables or Select Genie window, which allows you to encapsulate constituents in
Control and compatible Supervision facet templates respectively. It also allows you to modify
encapsulated elements with the help of the corresponding Participant.
If a Control facet contains no constituents, the Content Not Found dialog box opens, which allows you
to start the encapsulation process.
For more information, refer to the topic describing the configuration of facet templates
(see EcoStruxure™ Process Expert, Global Templates, Reference Manual).
NOTE: The command is available only in the Facet Editor.
10 Opens the editor menu (see page 965) that contains editor-specific commands.

NOTE: For a description of the panes mentioned in the table, refer to the topic describing common
template editor panes (see page 969).

Workspace Toolbar
The figure shows the workspace toolbar that is located in the bottom right-hand corner of the Facet
Editor and Composite Editor.

Item Description
1 Aligns the left edge of any selected item in the workspace with the left edge of the item that you have
selected first.
NOTE: The graphical alignment rules do not apply to parameters and input values, except for the
three $System parameters $InstanceID, $Description, and $Area.
2 Aligns the top edge of any selected item in the workspace with the top edge of the item that you have
selected first.
3 Aligns the right edge of any selected item in the workspace with the right edge of the item that you
have selected first.
4 Aligns the bottom edge of any selected item in the workspace with the bottom edge of the item that
you have selected first.
5 Reverts to the default zoom level (100%).
6 Adjusts the zoom level to fit the elements of the template inside the visible workspace.
If the layout of the template is very large, some objects may not fit inside the visible workspace. You
can use the radar view (see page 972) to locate these objects.
7 Zooms out (see page 121).
Alternatively, use the minus (-) keyboard key.
When you zoom out to 50%, the display switches to the simplified view (see page 973). To return to
the normal view, zoom in.

964 EIO0000001114 06/2020

 Global Templates Editors

Item Description
8 Zooms in.
Alternatively, use the plus (+) keyboard key.
9 Current zoom level.
Use a predefined level by clicking the arrow and selecting a value from the list.
You can set a custom level by double-clicking the value, entering a new one, and pressing Enter.
Range: 50 to 200.

NOTE: For information on commands that allow you to select multiple items in the workspace and
move the workspace around, refer to the topic describing the engineering client workspace
(see page 120).

Editor Menu
The table describes the submenus and commands of the menu located in the toolbar of template
editors.

Command Description
New... Opens the Global Templates dialog box, which contains the same
base templates as the Toolbox of the Global Templates explorer. It
allows you to create a new template in one or more existing folders
of the Global Templates library and open it in editing mode in the
corresponding editor.
For more information, refer to the topic describing how to create
templates (see EcoStruxure™ Process Expert, Global Templates,
Reference Manual).
(1) The command appears only in the menu of the Composite Editor
(2) You cannot print a simplified view (see page 973) of the layout.

EIO0000001114 06/2020 965

Global Templates Editors

Command Description
Edit Copy Copies the selected element for pasting in this template or another
template.
You can copy multiple elements by selecting them first.
Paste Pastes copied elements.
When a naming rule applies to elements, the software uses the _n
suffix (where n is an incremental number starting at 1) to create
unique names.
Select All Selects any element in the workspace.
Select None Clears any selected element in the workspace.
Invert Selection Selects elements that are not selected and clears any selected
element in the workspace.
Find Displays a search field, which allows you to find strings in any
element of the workspace by entering entire or partial key words.
Strings that contain the word you entered appear in a list with an
indication of their path.
Right-click a result and select Navigate to highlight it in the
workspace.
For example, entering in returns various results, such as:
 The $InstanceID system parameter.
 The $InstanceID parameter of an element.
 The In input of a binding function.
 Interfaces to indicate that an element references interfaces.

View Document Outline The commands allow you to bring the corresponding pane to the
Dependencies Tree front.
If the pane is closed, the command opens it.
Used By For a description of the panes, refer to the topic describing template
External References editor panes.

Locations
Parameters
Interface Rules
Element Rules(1)
Toolbox
Browser
Properties
Save Save button.
Opens the Save dialog box.
For more information, refer to the topic describing how to save
changes in templates (see page 979).
(1) The command appears only in the menu of the Composite Editor
(2) You cannot print a simplified view (see page 973) of the layout.

966 EIO0000001114 06/2020

 Global Templates Editors

Command Description
Save As Save as button.
Opens the Save As dialog box.
For more information, refer to the topic describing how to save
changes in templates (see page 979).
Export Standard Backup Opens the Export window, which allows you to export the template
definition to file (.sbk).
You can only export a template if you have saved changes.
For more information on export feature, refer to the topic describing
template export (see page 983).
Various image file Each command opens a Save dialog box, which allows you to create
formats an image file with the corresponding file extension. The image
captures the entire layout of the template independently of the zoom
level.
Panes and toolbars are not captured.
Print Only Visible Content Opens the Print dialog box, which lets you print on one page, the
portion of the template layout that is visible(2) in the current view.
Editor Content On Single Opens the Print dialog box, which lets you print the entire layout of
Page the template(2) on one page.
Show Changes Log Opens the Changes Log pane.
Close Closes the template editor.
If you have made changes, opens the Save dialog box.
For more information, refer to the topic describing how to save
changes in templates (see page 979).
(1) The command appears only in the menu of the Composite Editor
(2) You cannot print a simplified view (see page 973) of the layout.

EIO0000001114 06/2020 967

Global Templates Editors

Workspace Context Menu

Right-click an empty area of the workspace of a template editor to open a context menu with the
following commands.

When you select... The software...

Inspect opens a submenu with the Used By (see page 947) and Dependencies Tree
(see page 947) commands.
Align Left Edges Refer to the description of the corresponding commands in the workspace toolbar
Align Top Edges
(see page 964).
The commands are available only if two or more elements are selected in the
Align Right Edges workspace.
Align Bottom Edges
Copy copies the selected element for pasting in this template or another template.
You can copy multiple elements by selecting them first.
Paste pastes copied elements.
When a naming rule applies to elements, the software uses the _n suffix (where n is
an incremental number starting at 1) to create unique names.
Show Changes Log opens the Changes log pane. (see page 952)
Properties brings the Properties pane to the front to display properties of the template that is open
in the editor. If the pane is closed, the command opens it.

Binding Context Menu

Right-click a binding or its connector (see EcoStruxure™ Process Expert, Global Templates,
Reference Manual) in the workspace of a template editor to open a context menu with the following
commands.

Command Description
Convert To Line Lets you toggle between binding styles (see EcoStruxure™ Process Expert, Global
Convert to
Templates, Reference Manual).
Connector
Go To For bindings in line style, opens a submenu that contains the name and path of objects
and/or their properties that are linked to this object through bindings. It lets you locate them
(see EcoStruxure™ Process Expert, Global Templates, Reference Manual) easily. When
you select an entry, the object and the binding are highlighted in the workspace.
For bindings in connector style, highlights the object that is connected to the other end of
the binding.
Update Binding Opens the Update Binding dialog box, which lets you move the destination
(see EcoStruxure™ Process Expert, Global Templates, Reference Manual) of the binding
to another property or element.
The command is not available for source connectors of bindings.
Delete Deletes the binding after you confirm the command.

968 EIO0000001114 06/2020

 Global Templates Editors

Common Template Editor Panes

Introduction
The Facet Editor and Composite Editor use various panes to group properties and data that are
related.
This topic describes panes that are common to both. Panes that are specific to either editor are
pointed out.
Certain panes may be available only in editing mode.
For information on working with panes, refer to the topic describing the engineering client
workspace (see page 127).
NOTE: This topic provides information on the user interface of the panes only. It does not provide
information on how to define or modify their contents.

Editor Panes
The table describes the purpose of the panes that you can access in the Facet Editor and
Composite Editor.

Pane Description
Document Outline Allows you to view and/or edit:
 Parameters
 Elements
 Interfaces

Click a parameter, element, or interface to display its properties in the Properties

pane. The corresponding item is selected in the workspace.
NOTE: To view and/or edit the properties of the template, click Parameters.
Interface Rules Allows you to view and define the rules for the interfaces (see EcoStruxure™
Process Expert, Global Templates, Reference Manual) referenced by the template.
Element Rules(1) Allows you to view and define the rules for the elements (see EcoStruxure™
Process Expert, Global Templates, Reference Manual) referenced by the template.
Properties Allows you to view and/or edit the properties of the selected element of the template.
(1) The pane appears only in the Composite Editor.

EIO0000001114 06/2020 969

Global Templates Editors

Pane Description
Toolbox Allows you to browse and select binding functions (see EcoStruxure™
Process Expert, Global Templates, Reference Manual) to be used in the template.
For facet templates of the Supervision category, the Toolbox pane also contains the
following elements (see EcoStruxure™ Process Expert, Global Templates,
Reference Manual):
 For facet templates of the Data subtype:
 Advanced Alarm
 Calculated Variable Tag
 Disk Variable Tag
 Digital Alarm
 Equipment
 Equipment Parameter
 Equipment Group of Messages
 Local Variable Tag
 Message
 Time Stamped Digital Alarm
 Trend Tag
 Variable Tag

 For facet templates of the Genie subtype:

 Equipment
 Equipment Parameter
 Equipment Group of Messages

 For facet templates of the Client Event subtype: Event.

 For facet templates of the Server Event subtype: Report.

These elements contain the same properties as the corresponding elements of the
Supervision Participant and allow populating the respective databases.
Browser In the Facet Editor, allows you to browse and select interfaces to be referenced by the
template.
In the Composite Editor, allows you to browse and select facet and composite
templates, and interfaces to be referenced in the template.
Dependencies Tree In the Facet Editor, allows you to view the interfaces that the template references.
In the Composite Editor, allows you to view the interfaces, facet and composite
templates that the template references.
You can right-click an item to view and/or edit it in a new editor. You can also view the
dependencies of the item or which other templates reference it.
Used By Allows you to view the templates that reference the template, which is open in the
editor. You can right-click a template in the Used By pane to open it in a new editor.
You can also view its dependencies or which other templates reference it.
(1) The pane appears only in the Composite Editor.

970 EIO0000001114 06/2020

 Global Templates Editors

Pane Description
External References Allows you to view:
 In which systems an instance of the template exists.
 For each system, the identifier of the instances using the template.

You can right-click an application instance to:

 Open the folder containing the instance in the Application Explorer.
 Open the Inspect Instance window (see page 236).

Parameters The Parameters pane allows you to:

(see EcoStruxure™  View and manage parameter data that is used during instantiation to customize
Process Expert, elements of an instance.
Global Templates,  Customize the layout of the parameters that are visible when you edit an instance
Reference Manual) by using the Instance Editor:
 Change the position of parameters within their category.
 Change the position of categories.
 Assign parameters to another category.

Locations Allows you to view the path to the template and its copies (see page 982).
Right-click an entry and select Open reference container to open the corresponding
folder in the Global Templates explorer.
Changes log Keeps track of changes that are made to the template and saved. The pane indicates:
 The action that was performed.
 The state of the template after the change.
 The mandatory description of changes that is entered when the template is saved.
 The version of the template after the change.
 The user name of the user logged in to the engineering client.

(1) The pane appears only in the Composite Editor.

EIO0000001114 06/2020 971

Global Templates Editors

Using the Radar View

Overview
The radar view appears in the bottom right corner of certain graphical editors. It shows you which
area of the layout of a template or workspace you are seeing in the editor.
You can also use it to navigate the inside the workspace and adjust the zoom level.

Description
The following figure shows an example of the Radar View in a template editor.

Item Description
1 Shows all the objects that appear in the editor.
The view is refreshed when you modify the layout of objects.
2 Area that is currently visible in the editor.
You can move the translucent rectangle by dragging it with the pointer. The view inside the editor
moves accordingly. Alternatively, click anywhere inside the Radar View to move the center of the
translucent rectangle to where you have clicked.
When you change the zoom level, the size of the translucent rectangle adjusts accordingly.
3 Zoom level adjustment.
Dragging the corner inward or outward lets you zoom in or out respectively.
NOTE: While the pointer is over the Radar View, you can also use the mouse wheel to zoom.

When the Radar View is collapsed, it appears as a button

972 EIO0000001114 06/2020

 Global Templates Editors

Using the Simplified View in Template Editors

Overview
Zooming out to the lowest level in the Composite Editor or Facet Editor switches the display to the
simplified view.
This view mode lets you see, at a glance, the elements of a template and the relation between them
without showing the details of bindings and element properties.
Some template engineering functionalities are not available.
To exit the simplified view, zoom in.

Restrictions of the Simplified View

The table describes the restrictions in the template editor while the simplified view is active.

Action or object Restrictions

Actions related to bindings (such as creating, moving, deleting, Actions are not allowed
switching styles).
Creating parameters or platform inputs.
Element properties and deferred inputs and outputs. Are not shown.
Multiple bindings to and from an element. Are shown as a single line.
Binding connectors. Are not shown. Bindings are shown in
line style instead.

EIO0000001114 06/2020 973

Global Templates Editors

Description
The following figure shows an example of template as it normally appears in the Facet Editor.

974 EIO0000001114 06/2020

 Global Templates Editors

The following figure shows the same template when simplified view is active (the view is enlarged
for better visibility).

1 Elements keep their relative size and position to preserve the aspect of the layout.
2 Parameters and platform inputs are shown in their actual position.
3 Bindings to and from each element are grouped into a single line.

EIO0000001114 06/2020 975

Global Templates Editors

976 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Managing Global Templates
EIO0000001114 06/2020

Chapter 25
Managing Global Templates

Managing Global Templates

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
25.1 Managing Global Templates 978
25.2 Updating, Replacing, and Duplicating Global Templates 998

EIO0000001114 06/2020 977

Managing Global Templates

Section 25.1
Managing Global Templates

Managing Global Templates

What Is in This Section?

This section contains the following topics:
Topic Page
Saving Changes In Global Templates 979
Copying and Pasting Global Templates and Folders 982
Exporting Templates 983
Importing Templates 987
Purging the Global Templates Library 995

978 EIO0000001114 06/2020

 Managing Global Templates

Saving Changes In Global Templates

Overview
When Global Templates are open in their respective editor (see page 944), you can save changes
by using the following commands:
Save Allows you to save changes to templates that you have created by using various save
options. Use the command to rename a template or change its usability state.
The command is available only if the template is not referenced by another template and not
used by an instance of the application; otherwise the software opens the Save as dialog box.
Save as Allows you to save changes to Schneider Electric Global Templates, create a new
template, or a new version of a template.
When you select the Save as command, you can select one or more locations where to store the
template.
NOTE: To save a template with a different identifier and/or version without editing it, use the
Duplicate command (see page 1013).

Restrictions When Saving Schneider Electric Templates

Restrictions (see EcoStruxure™ Process Expert, Global Templates, Reference Manual) related to
the template identifier apply when you save a Schneider Electric template.

Tracking Saved Changes

When you save a template, the software keeps a record of the save operation. You can view details
in the Changes log pane, which is available in each template editor (see page 969).

EIO0000001114 06/2020 979

Managing Global Templates

Save Options
The table describes the items of the Save and Save as dialog boxes that the software displays
when you select the respective command.

Item Description
Keep Version (1) Select this versioning scheme to save changes in a template without changing its
version number.
Selected by default.
New Build For information on the usage of the different version components, refer to Version
New Minor
(see EcoStruxure™ Process Expert, Global Templates, Reference Manual).
By default, New Build is selected when you open the Save As dialog box.
New Major
Other Selecting this versioning scheme allows you to edit the following parameters in the
dialog box before saving the template:
 The identifier.
 The three version components (major, minor, build number).

Select it to rename the template or create a new template based on the one you are
editing.
NOTE: By default, the version that is selected is the same as for New Build.
Version For a description of the version format, refer to Version (see EcoStruxure™
Process Expert, Global Templates, Reference Manual).
Identifier Within the Global Templates library, the software requires that the combination of
identifier (see EcoStruxure™ Process Expert, Global Templates, Reference Manual)
and version be unique for each template.
Locations(3) Allows you to select one or more existing folders of the Global Templates library to
store the template.
Default value: The current location of the template. If linked copies (see page 982)
exist, their location is indicated also.
Click the browse button to open the Select Template Location dialog box, which lets
you change locations and create linked copies by selecting additional locations.
Usability State(1) For information on the parameter, refer to Usability State (see EcoStruxure™
Process Expert, Global Templates, Reference Manual).
Default value: Current state of the template.
New Version Allows you to define the usability state of the new template that you are creating.
Usability State(2) Default value: Not Approved
For information on the parameter, refer to Usability State (see EcoStruxure™
Process Expert, Global Templates, Reference Manual).
(1) The item is displayed only in the Save dialog box.
(2) The item is displayed only in the Save As dialog box for templates that are already referenced or
instantiated.
(3) The item is displayed only in the Save As dialog box.

980 EIO0000001114 06/2020

 Managing Global Templates

Item Description
Old Version Usability Allows you to define what will be the usability state of the template that you are
State(2) currently editing after you create the new template.
Default value: Approved
For information on the parameter, refer to Usability State (see EcoStruxure™
Process Expert, Global Templates, Reference Manual).
Changes Description You must enter a description by using free form text to be able to save changes.
The description that you enter is visible in the Changes log of the template editor.
Entering a detailed description of changes allows you to keep track of the version
history of the template.
(1) The item is displayed only in the Save dialog box.
(2) The item is displayed only in the Save As dialog box for templates that are already referenced or
instantiated.
(3) The item is displayed only in the Save As dialog box.

Saving Changes In Global Templates

Modifying Schneider Electric Global Templates or creating templates may affect the function of
these templates and/or systems, and must be performed by qualified personnel. Before
proceeding, refer to the Overview of this part (see page 929).
To save changes in Global Templates, proceed as follows.

Step Action
1 In the template editor, click the Save or Save As button.
Result: The software opens the appropriate dialog box.
2 Select the versioning scheme that you want to use.
3 Edit the Identifier, Change Description, and/or Usability State as needed.
4 Click the Save button.
Result: The software:
 For the Save dialog box:
 Closes the dialog box.
 Saves the changes in the template.
 Keeps the template open inside the editor.

 For the Save as dialog box:

 Creates a new template, which includes your changes and displays it in the editor.
 Closes the source template without saving.

NOTE: Click the Cancel button to close the Save or Save as dialog box without saving changes.

EIO0000001114 06/2020 981

Managing Global Templates

Copying and Pasting Global Templates and Folders

Creating Linked Copies of Templates

Certain commands (for example, copy and paste) let you place copies of a template in several
folders of the Global Templates library. The copies are linked to the source template. Any change
that you make to the source template is also made to each copy that you have created.
NOTE: To create an independent copy of a template, use the Save as or Duplicate command from
the corresponding template editor or Global Templates Explorer.

Locating Copies
To locate the linked copies of a template, use the Locations command (see page 940).

Copying Folders
You cannot paste an empty library folder.
When you copy a folder containing templates and you paste it on another folder, the software
creates a subfolder with the same identifier, which contains a linked copy of each template of the
source folders. Subfolders and their contents are created in the same way.

982 EIO0000001114 06/2020

 Managing Global Templates

Exporting Templates

Overview
The Export command of the Global Templates Explorer lets you export templates of the Global
Templates library.
The process creates an export file in .sbk format that contains:
 The selected templates.
 Referenced composite and facet templates, interfaces, and their parameter configuration.
 Local constituents.
 Supervision content.

User contents such as content containers (see page 1024) containing documents and URLs that
are linked to a template are not exported.
The export functionality allows you to copy these templates to another system or platform, or to
create a backup.

Aborting Export Tasks

After confirming the export by clicking Save in the Save window, the abort icon is displayed in the
notification panel (see page 86). Click the icon to cancel the task. The export file is not created.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are exporting only a few templates, the task may complete before you are able to
click the icon.

EIO0000001114 06/2020 983

Managing Global Templates

Template Export Window

The following figure shows an example of the template window that opens after selecting the
Export command from the ON_OFF Devices Control sample folder.

1 Button to show or hide the details pane (shown on the right-hand side of the window). Select a
template by clicking its row in the tree or grid view to view details.
2 Button to toggle between grid view and tree view. Tree view is the default view (shown here).
3 Indicates the number of selected templates and the total number of templates contained in the
location from which you have selected the Export command. Linked copies (see page 982) are
not counted even if they are selected.
NOTE: To expand/collapse a node in the Export window, select the node and press Enter.

984 EIO0000001114 06/2020

 Managing Global Templates

The table describes the information that appears in the columns of the Export window.

Column Header Description

Identifier Displays:
 The folder hierarchy in the Global Templates library (tree view mode only).
 The identifier of templates contained in the location from which you have selected
the Export command.
 Check boxes that let you select the templates you want to export.

In grid view mode, only templates are shown, not linked copies.
NOTE: By default, all templates are selected.
Type Indicates the category of the template.
Refer to the definition header of each template category for a description of the type
(see page 28).
Version Indicates the version of the template.
State Usability state (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual) of the template (for example, Approved or Deprecated).
Description Description of the template.

The table describes the details pane of the Export window.

Section Header Description

– Identifier of the selected template.
NOTE: You can view details even if the check box next to the template
identifier is not selected.
Required Dependencies Identifier of templates that are required to export the selected template.
The check box of required dependencies is selected and disabled. To
enable it, you need to clear the check box of the selected template.
Selected Dependencies Identifier of templates that reference the selected template.
When you clear the check box of a selected dependency, the template is
removed from this section. Once you have cleared the check boxes of all
the listed templates of this section, the check box of the selected template
is enabled and you can clear it to exclude it from the export file.
As long as selected dependencies are listed, the check box of the selected
template remains disabled.
Locations Path of the selected template and any of its linked copies in the Global
Templates library.
For each template and linked copy, the status of the check box in the
Identifier column is duplicated.

EIO0000001114 06/2020 985

Managing Global Templates

Creating the Export File

To export templates and create the export file, proceed as follows.

Step Action
1 From the tree view of the Global Templates Explorer, right-click and select Export on:
 A template if you want to export the template only
 A template folder if you want to export any templates of the folder, subfolders, and any
templates contained in these subfolders
Result: The Export window opens.
2 Select the templates that you want to export.
3 Click OK.
Result: The Save dialog box opens.
4 Enter a name for the export file and select a location, and click Save.
Result: The software exports the selected items and creates an export file in .sbk format in the
location that you have selected.

NOTE: To export the templates of an entire library, create separate export files by selecting various
subfolders in the Export window. This creates smaller export files that take less time to import.

986 EIO0000001114 06/2020

 Managing Global Templates

Importing Templates

Overview
The Import command of the Global Templates Explorer allows you to import new templates, new
versions of existing templates, and to modify or update templates or parts of these in the Global
Templates library. Importing templates adds them to the database that is mounted.
When you select an export file (.sbk) containing templates, the software compares the information
in the export file with the templates contained in the Global Templates library and applies rules to
keep templates unique.
The Import window allows you to select which valid templates of the export file you import. It also
allows you to import new and/or updated content that is required by the templates you are
importing. Content are project files containing, for example, Supervision resources such as
animated graphics (genies) used by Supervision runtime.
NOTE: Importing many templates may take time.

Export File Location

The export file containing the template information needs to be located in a folder that you can write
to.

Import Rules
The table describes the rules that the software applies while comparing templates contained in the
export file with those in the Global Templates library before importing templates.

Template identifier Template version Template signature Action

Does not exist in the Global Indifferent Indifferent The template is imported.
Templates library.
Already exists in the Global Already exists in the Already exists in the The template is not
Templates library. Global Templates Global Templates library. imported.
library.
The signature is The template is not
different. imported and it displays a
message about the
detected conflict.
The version is unique. The signature is unique. The template is imported.

EIO0000001114 06/2020 987

Managing Global Templates

Importing Supervision Included Projects

An included project (.ctz) that is used by a template is only imported if the template itself is
imported.
For example, if you have modified the included project that is used by the MyMotor template v1.0.0
but without making any change to the template itself, you cannot add the modified included project
to the content repository (see page 1022) by importing the template if MyMotor v1.0.0 already
exists in the Global Templates library. Since the template already exists, it is not imported.
The table describes the methods that you can use to add a new included project to the content
repository.

Method Description
Modify the template that Modify at least one Supervision genie facet template (_CG) of the template.
references the new For example, you can create a new version (see page 979) of the genie facet
included project so that it template without changing its content by using the Save As command.
can be imported. Importing the template allows you to import the new included project and add it to
the content repository.
Add the new included Refer to the procedure that describes how to add project files to the content
project directly to the repository (see EcoStruxure™ Process Expert, Global Templates, Reference
content repository. Manual).
To follow the procedure, edit either facet template:
 A new Supervision genie facet template that you create by using the Genie
template from the Toolbox of the Global Templates Explorer.
 Any existing Supervision genie facet template (_CG) of the Global Templates
library.
In both cases, you do not need to save the template to be able to add the included
project to the content repository.

Accessing the Template Import Window

To access the Import window, proceed as follows.

Step Action
1 From the client toolbar, click the Global Templates explorer icon.
Result: The Global Templates Explorer window opens.
2 Right-click the Global Templates root folder and select Import.
Result: The Import dialog box opens.
NOTE: If you know the exact location where you want to import the templates, you can right-
click the corresponding folder in the tree view of the Global Templates Explorer and select
Import.
3 Select the export file (.sbk) containing the templates that you want to import and click Open.
Result: The software opens the Import window and displays the contents of the export file.

988 EIO0000001114 06/2020

 Managing Global Templates

Template Import Window

The following figure shows an example of the Import window.

1 Button to show or hide the details pane (shown on the right-hand side of the window). Select a
template by clicking its row in the tree or grid view to view details.
2 Button to toggle between grid view and tree view, which is shown here. (default view).
3 Imports templates with the hierarchy of folders that existed at the time of export. Clear the check
box to import templates in the same folder without hierarchy. The check box is selected by
default. While in grid view, selecting or clearing the check box switches to tree view.
4 A message appears when the templates were exported from a version of the software that is
different from the version you are using.
5 Indicates the number of selected templates and the total number of templates contained in the
export file. Linked copies (templates marked with a blue dot) are not counted even if they are
selected.
NOTE: To expand/collapse a node in the Import window, select the node and press Enter.

EIO0000001114 06/2020 989

Managing Global Templates

The table indicates the meaning of the colored dots that appear in the Import window next to
template identifiers.

Color code Description

Green The template does not exist in the Global Templates library and can be imported.
For a node, indicates that the elements of the node can be imported.
Gray The template already exists in the Global Templates library and cannot be imported.
For a node, indicates that at least one element of the node already exists and is identified by
a gray dot.
Blue The template already exists in the Global Templates library but a linked copy (see page 982)
is created if imported.
Red Red dot: The template cannot be selected for import because of a detected signature conflict
(see page 987).

The table describes the information that appears in the columns of the Import window.

Column Header Description

Identifier Displays:
 The folder hierarchy at the time of export (when Import hierarchy is selected).
 The identifier of templates contained in the export file.
 A colored dot.
 Check boxes allowing you to select the templates that you want to import.

Selecting a template automatically selects any referenced templates that can be imported.
It also selects linked copies of referenced templates if the referenced template does not
exist in the Global Templates library yet.
In tree view, when Import hierarchy is not selected, the software can only import one of
each template and/or one linked copy of each existing template because any template or
linked copy is imported to the same folder.
In grid view, only templates are shown, not linked copies. If a template already exists, its
check box is cleared and disabled. Templates that do not exist have their check box
selected by default and enabled (you can clear it).
NOTE: By default, new templates and new template versions are selected.
Type Indicates the category of templates in the export file.
Refer to the definition header of each template category for a description of the type
(see page 28).
Version Indicates the version of templates in the export file.
State Usability state (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual) of the template (for example, Approved or Deprecated).
Description Description of templates in the export file.

990 EIO0000001114 06/2020

 Managing Global Templates

The table describes the details pane of the Import window.

Section Header Description

– Identifier of the selected template.
NOTE: You can view details even if the check box next to the template identifier
is not selected.
Required Dependencies Identifier of templates that are referenced by the selected template.
Selected Dependencies Identifier of templates that reference the selected template (only if the selected
template can be imported).
When you clear the check box of a selected dependency, it clears the check box
of any template and linked copies referencing the selected template. This allows
you to clear the check box of the selected template, which would be disabled
otherwise.
Locations Path at the time of export of the selected template and any of its linked copies
contained in the export file.
For each template and linked copy, the status of the check box in the Identifier
column is duplicated.
NOTE:
If you clear Import hierarchy:
 Linked copies are not shown anymore.
 The path does not reflect the hierarchy at the time of export anymore

EIO0000001114 06/2020 991

Managing Global Templates

Resolving Contents Conflicts

When the software detects contents with the same name but a different version in the export file
compared to the content that exists in the content repository, it displays the Resolve Contents
Conflict dialog box. The following figure shows an example of the dialog box.

Header Description
Identifier Name of the content that conflicts with the current content located in the content
repository.
Current Version of the current content located in the content repository.
New Version of the content in the export file.
Current genies Animated graphics (genies) that are included in the current content located in the
content repository.
New genies Animated graphics that are included in the content in the export file.
Conflicts Animated graphics that create a conflict if you import the new content.

992 EIO0000001114 06/2020

 Managing Global Templates

In the Resolve Contents Conflict dialog box, verify the following before proceeding with the import:
 Refer to the library release notes. The documents contain information about changes that were
made to templates of the corresponding library.
 Considerations when importing content:
Selecting new content Templates that you are importing and that require the new content will
work correctly; however, the current content that is used by existing templates of the Global
Templates library and instances thereof may be overwritten.
Also, the status of executables of Supervision projects that use contents of which you are
importing a new version may be set to Out Of Date if it is currently Built. In such case, you
need to build these executables to integrate changes of the content in the corresponding
Supervision projects.
Selecting current content The content that is used by existing templates of the Global
Templates library and instances thereof is not affected; however, templates that you are
importing will be missing the new content that they require to work properly.
NOTE: Refer to the Conflicts section of the Resolve Contents Conflict dialog box.

Aborting Import Tasks

After confirming the import by clicking OK in the Import window or in the Resolve Contents Conflict
dialog box, the abort icon is displayed in the notification panel (see page 86). Click the icon to
cancel the task. No templates and no content are imported.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are importing only a few templates, the task may complete before you are able to
click the icon.

Importing Templates

NOTICE
LOSS OF DATA
Resolve a content conflict that arises during the import of templates by selecting the correct
version of the content to be imported.
Failure to follow these instructions can result in unusable Supervision projects.

EIO0000001114 06/2020 993

Managing Global Templates

To import templates from an export file (.sbk) into the Global Templates library, proceed as follows.

Step Action
1 In the Import window, select the templates (see page 989) that you want to import.
2 Click OK.
Result: If software detects content with the same name but of a different version, it displays the
Resolve Contents Conflict dialog box; otherwise the software proceeds with the import of
selected templates from the export file.
NOTE: Click Cancel to close the Import window without importing templates.
3 If the software displays the Resolve Contents Conflict dialog box, select the version of the
content that you want to use, and click OK.
Result:
 The selected templates are imported.
 The import settings that you have selected are applied.
 It displays Completed in the notification panel when the import is complete.

NOTE: Click Cancel to close the Resolve Contents Conflict dialog box without importing the
template. This reverts to the Import window.

After Importing Templates

Depending on the number of templates that you are importing and your hardware configuration,
the import process may affect the performance of your computer, requiring you to restart the
computer.

NOTICE
LOSS OF COMMUNICATION
Stop the system server only when no client is running.
Failure to follow these instructions can result in unresponsive clients.

After importing templates, proceed as follows.

Step Action
1 Quit clients (see page 69).
2 Stop the system server.
3 Restart the computer.

994 EIO0000001114 06/2020

 Managing Global Templates

Purging the Global Templates Library

Overview
The Purge context menu command of folders of the Global Templates Explorer allows you to
remove unused, earlier versions of templates and interface models from the Global Templates
library. The process also removes local constituents of deleted templates and unused global
constituents (see page 1024).
You can select the templates to remove.
At the end of the purge process, the notification panel provides a summary with information on
purged templates.
If the process ends abnormally (for example, by terminating the process), the tool rolls back the
process.

Purge Rules
The tool deletes, using an iterative process, any facet, and composite templates, as well as
interface models that satisfy the following rules:
 A template with a higher version number, having the same identifier and the Usability State
(see EcoStruxure™ Process Expert, Global Templates, Reference Manual) Approved exists in
the Global Templates library.
 The template or the interface model is not referenced (used) by any other template of the Global
Templates library.
 The template is not used by any instance of the application.

NOTE: The tool does not delete a template if the template is used by a facet that is assigned to a
project and the Assignment status of the facet is Deleted (see page 481).
To delete such template, first generate the project or the container to which the facet is assigned.

EIO0000001114 06/2020 995

Managing Global Templates

Purge Window
The following figure shows an example of the Purge window when the Purge command is selected
from the General Purpose Library folder.

Aborting Purge Tasks

After confirming the Purge command by clicking OK in the Purge window, the abort icon is
displayed in the notification panel (see page 86). Click the icon to cancel the task. No templates
are purged.
Only the user who has selected the command is allowed to abort it.
NOTE: If you are purging only a few templates, the task may complete before you are able to click
the icon.

Backing Up the Database

You cannot restore Global Templates that you delete from the Global Templates library by using
the Purge command.
Before using the command, back up the database. Refer to the topic describing how to back up
the database (see EcoStruxure™ Process Expert, Installation and Configuration Guide).

996 EIO0000001114 06/2020

 Managing Global Templates

Purging Global Templates

NOTICE
LOSS OF DATA
Back up the database before using the Purge command.
Failure to follow these instructions can result in unusable systems or database.

To delete Global Templates that satisfy the purge rules, proceed as follows.

Step Action
1 Back up the database.
2 Right-click the parent folder starting from which you want to proceed with the removal and select
Purge.
Result: The Purge window opens. After a few moments, it displays the templates that satisfy the
purge rules in the selected location.
3 Select the templates that you want to delete and click OK.
Result: The software:
 Deletes applicable templates and interface models.
 Displays information in the notification panel when the purge is complete.

NOTE: Click Cancel to close the Purge window without purging Global Templates.

EIO0000001114 06/2020 997

Managing Global Templates

Section 25.2
Updating, Replacing, and Duplicating Global Templates

Updating, Replacing, and Duplicating Global Templates

Overview
This chapter describes the various commands that are available to modify Global Templates with
or without editing them.

What Is in This Section?

This section contains the following topics:
Topic Page
Template Modification Strategy 999
Updating Global Templates and Templates of Elements 1001
Replacing the Template of an Element of a Global Template 1006
Duplicating Global Templates 1013
Replace Dialog Box 1017

998 EIO0000001114 06/2020

 Managing Global Templates

Template Modification Strategy

Overview
Various commands are available that allow you to modify Schneider Electric and/or user-created
templates. Select the appropriate command depending on:
 Whether you want to edit a template or not.
 Whether the identifier of the template or one of its child templates contains the $ prefix
(see EcoStruxure™ Process Expert, Global Templates, Reference Manual).
 The scope of changes to be performed.

The table shows the commands that are available to modify Global Templates and their specifics.

Command Use in Use with Purpose Comment

Update Global Templates Templates To update a template with the  Cannot be used with
Explorer latest version of any child templates whose identifier
templates that exist in the Global contains the $ prefix.
Templates library.  The software finds the latest
versions of templates with
the same identifier
automatically.
Template editors Elements To update the template that is  Lets you updated the
used by a specific element with template that is used by a
the latest version that exists in specific element (instance).
the Global Templates library.  The software finds the latest
version automatically.
Replace Template editors Elements To update the template that is  Lets you replace the
used by a specific element with a template that is used by a
different version or a different specific element (instance).
template that exists in the Global  Can be used to undo a
Templates library. template update.
Duplicate Global Templates Templates To create a new template from  The replace action impacts
Explorer an existing one with the all elements (instances) of a
possibility to keep, duplicate, or given template.
replace each child template that  Can be used in place of the
is referenced. Update command with
templates whose identifier
contains the $ prefix.

EIO0000001114 06/2020 999

Managing Global Templates

Impact of Template Update or Replacement

The table describes the impact on the various template components when you update or replace
a template.

Current template In new template Impact

component
Bindings to the Are the same as in current The software maintains the bindings.
element selection template.
of composite
Are not the same as in current The software removes the bindings to the element selection of
references
template. the composites that are not part of the new template.
Bindings and Are the same as in current The software maintains the bindings and attributes.
attributes of the template.
element
Are not the same as in current The software removes the bindings and attributes of the
parameters template. element parameters that are not part of the new template.
Bindings to element Are the same as in current The software maintains the bindings.
interfaces template.
Are not the same as in current The software removes the bindings to the element interfaces
template. that are not part of the new template.

Applying Template Modifications to Existing Instances

Modifications to templates need to be propagated to instances of the application to take effect. The
method to apply modifications to existing instances depends on the template identifier.

Result of template modification Method to apply

A new version of the template (same identifier) Update the template used by instances (see page 245)
A template with a new identifier Replace the template used by instances (see page 245)

1000 EIO0000001114 06/2020

 Managing Global Templates

Updating Global Templates and Templates of Elements

Overview
The Update command lets you perform different actions depending on where you use it.
In the Global Templates Explorer, it lets you create a new version of your template, in the same
location, by using the latest approved version of any of the child templates that are referenced by
this template.
In the Facet Editor and the Composite Editor, it lets you update the template or interface model
that is used by a specific element by the latest available version.
In both cases, the update process allows you to integrate in the composition of your template the
latest versions of composite and facet templates, and interface models.
NOTE: The update of the template of an element impacts templates that reference this element
and requires updating (see page 999) all the higher-level templates.

Restrictions When Updating Schneider Electric Templates

Restrictions (see EcoStruxure™ Process Expert, Global Templates, Reference Manual) related to
the identifier of the parent template apply when you update a Schneider Electric template.
You cannot use the Update command in the Global Templates Explorer on a template whose
identifier contains the $ prefix. You need to use the Duplicate command (see page 1013) instead.

Good Practices
 If you know which highest level templates reference templates of which a later version is
available, proceed with the update from these highest level templates. Typically, the highest
level template is the control module template.
 If you do not know which highest level templates need to be updated, use the Inspect → Used
By context-menu command on the template of which you have created a new version. This
allows you to determine which are the highest level templates that you need to update with the
new version child template.

EIO0000001114 06/2020 1001

Managing Global Templates

Working Principle of the Update Functionality

When the Update command is used on a template in the Global Templates Explorer, the software
proceeds as follows:
 Searches the tree of dependencies of the template for any element with the same identifier and
for which a later version exists in the Global Templates library.
 Displays in a dialog box the latest version of templates that it has found in the dependencies
and lets you select:
 The usability state for the current version of templates after the new versions are created.
 The versioning scheme (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual) and usability state for the new version of templates that are created.
 Once you proceed, creates the new templates, proceeds with the update, and processes
bindings (see EcoStruxure™ Process Expert, Global Templates, Reference Manual).
When the Update command is used in a template editor, the software proceeds as follows:
 Verifies if a template with a later version exists in the Global Templates library.
 If so, processes bindings and:
 If any binding cannot be recreated, informs you and gives you the choice to proceed or cancel
the update.
 If bindings can be recreated, proceeds with the update of the template.

NOTE: For the template update process to complete, the latest version of the template or interface
model must have the Usability State Approved or Deprecated.

1002 EIO0000001114 06/2020

 Managing Global Templates

Update Dialog Box

The following figure shows an example of the Update dialog box in a scenario where the Update
command was used on the MyMotor (1.0.0) control module template in the Global Templates
Explorer. The template references MyMotor_UC (1.0.0). This UC composite template
references MyDEVCTL_UC (1.0.0), which in turn references the MyDEVCTL_UL (1.0.0) facet
template. MyDEVCTL_UL versions 1.0.1 and 1.0.2 exist in the Global Templates library.

Item Description
1 Template of which the software has found a later version in the Global Templates library compared
to the version that is currently used.
2 Templates of which the software will automatically create a later version because the version of their
child template is being incremented.
3 Shows the hierarchy of the templates that will be updated and the templates of which a later version
exists in the Global Templates library. Other child templates whose version is unchanged are not
shown.
At the top level, identifier of the template from which you have selected the Update command.
4 Type of the template.
5 Usability state of the current version of the template after the software has created the new version
based on the value of the State strategy parameter.
You can select it individually for templates of which the software creates a new version.

EIO0000001114 06/2020 1003

Managing Global Templates

Item Description
6 Current version of the template from which you have selected the Update command and current
version of its child templates.
7 Version of the template after the update and latest version of child templates with the usability state
Approved that the software has found in the Global Templates library.
For parent templates, the version is created by the software during the update based on the value of
the Version strategy parameter.
NOTE: You can modify the version number (see EcoStruxure™ Process Expert, Global Templates,
Reference Manual) manually for each template version that the software creates during the update.
Modifying the version number manually sets the Version strategy parameter to Custom. You cannot
enter the same value as in Version.
NOTE: If Version for a template that the software will update is already 99.99.9999, New Version
is blank and you need to enter a value manually.
8 Allows you to select the usability state of the current version (Version column) of the templates after
the software has created a new version of them.
Default value: Custom
9 Allows you to select the usability state of the new version of the templates after the update.
Default value: Approved
NOTE: The usability state applies only to new template versions that the software creates.
10 Allows you to select the versioning scheme (see EcoStruxure™ Process Expert, Global Templates,
Reference Manual) for new template versions that the software creates.
Default value: New Build
NOTE: The version strategy applies only to new template versions that the software creates.

Updating Global Templates in the Global Templates Explorer

Updating Schneider Electric or user-created templates may affect the function of these templates
and must be performed by qualified personnel. Before proceeding, refer to the Overview
(see page 929).
To update Global Templates, proceed as follows.

Step Action
1 In the tree view of the Global Templates Explorer, right-click the template that you want to update
and select Update.
Result: The Update dialog box opens.
2 For the current template version and its elements, select the usability state strategy that you want
the software to apply from the menu of the State strategy parameter.
NOTE: If you select Custom, select the usability state for each template in the State column.
3 For the new template version and its elements, select the usability state strategy that you want the
software to apply from the menu of the Usability State parameter.

1004 EIO0000001114 06/2020

 Managing Global Templates

Step Action
4 For the new template version and its elements, select the version strategy that you want the software
to apply from the menu of the Version strategy parameter.
NOTE:
You can modify the version number manually for each template that the software will create by
double-clicking the New Version field:
 If the version number that you have entered is invalid, the software applies the default versioning
scheme for new templates.
 To undo your version change, select New Build as the version strategy. This changes the version
of new templates to the default value.
5 Click OK.
Result: The software:
 Proceeds with the update.
 Displays the new templates that it has created in their respective folders within the Global
Templates library.
 Displays Completed in the notification panel when the update process is completed.

NOTE: Click Cancel to close the dialog box without proceeding with the update.

Updating Global Templates in Template Editors

Updating Schneider Electric Global Templates or user-created templates may affect the function
of these templates and must be performed by qualified personnel. Before proceeding, refer to the
Overview (see page 929).
To update the template or interface model that is used by an element of a facet or composite
template, proceed as follows.

Step Action
1 In the template editor, right-click the element whose template or interface model you want to
update and select Update.
Result: If a later version of the same template or interface model with the required usability state
exists in the Global Templates library, the software processes binding information; otherwise,
the software indicates that the template is already up-to-date.
2 Result: If any binding cannot be recreated, the Replace Conflicts dialog box opens; otherwise,
the update of the template completes and bindings are recreated.
3 Verify the information that is displayed in the Replace Conflicts dialog box and click:
 Yes: Proceeds with the update of the template, discards conflicting bindings, and recreates
the other bindings.
 No: Closes the Replace Conflicts dialog box without updating the template.

4 Recreate bindings as needed.

5 Save the change (see page 979).

NOTE: To undo a template update that you have performed in a template editor, you can use the
Replace command (see page 1006).

EIO0000001114 06/2020 1005

Managing Global Templates

Replacing the Template of an Element of a Global Template

Overview
In the Facet Editor and Composite Editor, the Replace context-menu command allows you to
replace the template that is used by an element with another template of the Global Templates
library.
You can replace the template of the following types of elements:
 Composite templates
 Facet templates
 Interfaces

The software informs you if it detects binding-related conflicts before proceeding with the
replacement of the template.
The replacement of the template of an element impacts templates that reference this element and
requires updating (see page 999) all the higher-level templates.

Restrictions When Replacing Schneider Electric Templates

Restrictions (see EcoStruxure™ Process Expert, Global Templates, Reference Manual) related to
the identifier of parent templates apply when you replace a template.

Before Starting
Depending on the situation, consider the following before starting:
 To replace the template of an element by the latest version of the same template, use the
Update command (see page 1001) instead.
 You can use the Replace command to undo the update of the template of an element
(see page 1001). Undoing a template update does not restore bindings that the software was
not able to recreate.

Replace Dialog Box

For a description of the template browser that opens, refer to the topic describing the Replace
dialog box (see page 1017).

1006 EIO0000001114 06/2020

 Managing Global Templates

Replacing The Template That Is Used by an Element

Modifying Schneider Electric Global Templates or user-created templates may affect the function
of these templates and must be performed by qualified personnel. Before proceeding, refer to the
Overview (see page 929).
To replace the template that is used by an element of a Global Template, proceed as follows.

Step Action
1 In a template editor, right-click the element whose template you want to replace and select
Replace.
Result: The Replace dialog box opens.
NOTE: Alternatively, you can select the template in the Browser pane and drag it onto the
header of the element until Drop to update the reference with x is displayed in a tooltip (where x
represents the name and version of the template that you want the element to use).
2 Select the template that you want the element to use instead and click OK.
Result: The Replace confirmation dialog box opens.
3 Verify the information that is displayed and click Yes.
Result: If any binding cannot be recreated, the Replace Conflicts dialog box opens; otherwise,
the replacement of the template completes and bindings are recreated.
4 Verify the information that is displayed in the Replace Conflicts dialog box and click:
 Yes: Proceeds with the replacement of the template, discards conflicting bindings, and
recreates the other bindings.
 No: Closes the Replace Conflicts dialog box without replacing the template.

5 Recreate bindings as needed.

6 Save changes (see page 979).

EIO0000001114 06/2020 1007

Managing Global Templates

Example
The following example illustrates the replacement of the template of a composite element, which
is referenced by a parent composite reference. The highest level composite template being
$AnalogInput (control module).

1 $AnalogInput_UC [1.4.9], which references element AnalogInput is opened in edit mode in the
Composite Editor.
2 Element AnalogInput uses template $AINPUT_UC, which is going to be replaced.
3 Browser pane that allowed locating template $AINPUT1_UC, which is going to replace $AINPUT_UC.

1008 EIO0000001114 06/2020

 Managing Global Templates

The software displays the list of bindings that cannot be recreated after the template replacement.
Write down these bindings so that you can recreate them later on if required.

EIO0000001114 06/2020 1009

Managing Global Templates

The figure shows the AnalogInput element after template replacement is complete and the
template referencing it has been saved.

1 Element AnalogInput now uses template $AINPUT1_UC. Its identifier is unchanged as shown in the
element header and the Properties pane.
2 The bindings that were listed in the Replace Conflicts dialog box have not been recreated.
3 $AnalogInput_UC [1.4.9] has to be saved with a different identifier (see EcoStruxure™ Process Expert,
Global Templates, Reference Manual) (for example, MyAnalogInput_UC [1.2.0]) with Usability state
approved.

1010 EIO0000001114 06/2020

 Managing Global Templates

Once template replacement is complete, you need to update templates that reference
$AnalogInput_UC [1.4.9] so that they use MyAnalogInput_UC [1.2.0] instead. To identify
these templates, use the Used by command on $AnalogInput_UC [1.4.9]. In this example, the
command returns $AnalogInput [2.3.1], which uses $AnalogInput_UC [1.4.9] for element
Control.

The following figure shows in a partial view, element Control referenced by

$AnalogInput [2.3.1].

EIO0000001114 06/2020 1011

Managing Global Templates

To update $AnalogInput [2.3.1] with MyAnalogInput_UC [1.2.0], navigate to

$AnalogInput [2.3.1] and use the Duplicate command (see page 1013). This process creates a
copy with a different identifier, which includes MyAnalogInput_UC [1.2.0]. In this example,
duplicating $AnalogInput [2.3.1] creates MyAnalogInput [1.0.0]. (The template that is
replaced is highlighted for the example.)

NOTE: You may need to update application instances that currently use $AnalogInput [2.3.1]
and/or $AnalogInput_UC [1.4.9] to use the new templates MyAnalogInput [1.0.0] and/or
MyAnalogInput_UC [1.2.0] respectively. Use the Replace command (see page 245) to perform
the update.

1012 EIO0000001114 06/2020

 Managing Global Templates

Duplicating Global Templates

Overview
The Duplicate command that is available in the context-menu of templates in the Global Templates
Explorer, lets you create a copy or a new version of any template with the original and/or modified
child templates.
For each child template, you can select to keep the original, duplicate (rename or change the
version), or replace it by another existing template.
The software informs you if it detects binding-related conflicts because of a template replacement
before proceeding with the duplication of the template.
NOTE: This command can be used instead of the Update command for templates whose identifier
contains the $ prefix. However, you need to know for which child templates a new version already
exists and select it manually.

Restrictions When Duplicating Schneider Electric Templates

Restrictions (see EcoStruxure™ Process Expert, Global Templates, Reference Manual) related to
the template identifiers apply when you duplicate a Schneider Electric template .

Good Practices
 Use the Duplicate command as a one-step solution to create a copy of a Schneider Electric
template whose child templates you can edit and save without using the $ prefix
(see EcoStruxure™ Process Expert, Global Templates, Reference Manual).
 Avoid duplicating templates of the Foundation library and interface models because these are
low-level resources that are common to all Schneider Electric templates to make them widely
compatible. You can identify foundation templates by their location.

EIO0000001114 06/2020 1013

Managing Global Templates

Duplicate Window
The following figure shows an example of the Duplicate window for a $HandValve sample
template in which duplication and replacement actions for child templates have been selected.

Item Description
1 You can sort and filter (see page 138) data.
2 Identifier and version of the template from which you have selected the Duplicate command.
3 Identifier and version of child templates that the template references.
At each level of the template composition, each template is shown only once even if several instances
of it exist.
By default, interface models are not shown.
4 When you replace a template, the child templates of the replacement are shown under the template
to be replaced in read-only mode.
5 Type (see page 31) of the template.

1014 EIO0000001114 06/2020

 Managing Global Templates

Item Description
6 Action to be performed for each referenced child template. Each type of action is identified by a colored
dot:
 Duplicate (green): Creates a new template. If the template references child templates, they are
reused without change unless you duplicate all or some of them as well.
 None (gray): No action is performed. The template is reused in the duplicated parent template.
For replacement templates and their children, it is the only setting that is allowed.
 Replace (blue): Opens the Replace dialog box (see page 1017), which lets you select an existing
template in the Global Templates library to be used in place of the current template and its child
templates. The replacement template is used for all instances of the current template.
The template must have the usability state (see EcoStruxure™ Process Expert, Global Templates,
Reference Manual) Approved.
7 Duplicating or replacing a template automatically sets the action of all parent templates to Duplicate.
Entries in italic indicate a change that is the result of an action that you have selected.
8 Free form text fields to enter either a prefix or suffix that is added to the identifier of each duplicated
template.
9 Identifier of the template that is proposed by the software for duplicated templates (editable) or
identifier of the replacement template that you have selected.
10 Version that is proposed by the software for duplicated templates (editable) or version of the
replacement template.
11 Location in the Global Templates library of:
 An original template (None action). The location is read-only.
 The duplicated template. You can select a different location and/or add additional ones.
The location that you select must exist. When you select more than one location, the software
creates linked copies (see page 982) of the template.
In the location selection dialog box, a check box lets you set the same location for all duplicated
templates.
 The replacement template. The location is read-only.
 Child templates of a replacement template (None action). The location is read-only

12 Button to modify the location of duplicated templates within the Global Templates library.
13 Button to open the Replace dialog box (see page 1017) to select a different template.
14 Sets the action of all child templates to Duplicate. Applies to interfaces only if they are shown.
This action overrides changes that you have made for child templates for which you have selected the
Replace action.
NOTE: You cannot revert this action for all templates at once.
15 When selected, shows the interface models that are referenced by child templates. You can select an
action for each interface model. Toggling the view does not impact changes that you have made.
16 Lets you select the usability state (see EcoStruxure™ Process Expert, Global Templates, Reference
Manual) that is set for all duplicated templates.
17 Free form text field to enter a description of the changes.

EIO0000001114 06/2020 1015

Managing Global Templates

Duplicating Global Templates

Duplicating Schneider Electric Global Templates or user-created templates may affect the function
of these templates and must be performed by qualified personnel. Before proceeding, refer to the
Overview (see page 929).
To duplicate a global template, proceed as follows.

Step Action
1 In the tree view of the Global Templates Explorer, right-click the template that you want to duplicate
and select Duplicate.
Result: The Duplicate window opens.
2 Select an action for referenced child templates as needed.
3 Configure the parameters for duplicated templates as needed.
4 Select a usability state for duplicated templates.
5 Click OK.
Result: If the software detects no binding-related conflicts, it duplicates the template based on your
selections; otherwise, the Replace Conflicts dialog box opens.
6 Verify the information that is displayed in the Replace Conflicts dialog box and click:
 Yes: Proceeds with the duplication of the template and discards conflicting bindings.
 No: Closes the Replace Conflicts dialog box and reverts to the Duplicate window.

7 Recreate bindings as needed.

1016 EIO0000001114 06/2020

 Managing Global Templates

Replace Dialog Box

Overview
The Replace dialog box opens when you select the corresponding command in the Duplicate
window (see page 1013) or in the context menu of an element in a template editor
(see page 1006).
It lets you browse the Global Templates library to select a replacement template.

Description
The browser of the Replace dialog box behaves like the templates browser (see page 934) of the
Global Templates Explorer with the following exceptions:
 The scope of the search is context-sensitive.
 Facet templates are shown by default.
 Only templates with the usability state Approved are shown.

EIO0000001114 06/2020 1017

Managing Global Templates

1018 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Software Services
EIO0000001114 06/2020

Part V
Software Services

Software Services

Overview
This part describes the services that are provided by the software to facilitate the engineering of
systems.

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
26 Content Repository 1021
27 Language Settings 1027

EIO0000001114 06/2020 1019

Software Services

1020 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Content Repository
EIO0000001114 06/2020

Chapter 26
Content Repository

Content Repository

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Content Repository Explorer 1022
Temporary Contents Repository Files 1026

EIO0000001114 06/2020 1021

Content Repository

Content Repository Explorer

Overview
The content repository is the place where the software stores:
 Global files used by Global Templates and that are required by the software platform to provide
various services (for example, global constituents referenced by templates). These files are
associated to the library that is installed during the installation of the software and to optional
application libraries.
 System-related files (for example, logical Participant projects or user files attached to a
Supervision project or to instances). These files are created during the different stages of the
system engineering life cycle.
You cannot add to or remove files directly from the content repository. The software removes from
the content repository system-related files such as Participant project files when they are not
required anymore (for example, when you delete a Participant project). An exception exists for
documents that you can manage yourself (see EcoStruxure™ Process Expert, Runtime
Navigation Services , User Guide ).
Each system server possesses one content repository in which the global and system-related files
are stored.
The Content Repository explorer is the tool, which lets you view contents in the form of a folder
structure and work with the files that are stored in the content repository.

Opening the Content Repository Explorer

To open the Content Repository explorer click the Content Repository icon in the toolbar
(see page 115).

1022 EIO0000001114 06/2020

 Content Repository

Content Repository Explorer Window

The following figure shows an example of the Content Repository explorer window.

1 Content repository root folder.

2 Root folder for global content repository items that are available at the platform level (system
independent).
3 User Contents folders that are the parent folder of the folder structure and content containers
that you can add depending on your role.

EIO0000001114 06/2020 1023

Content Repository

4 User-created content container.

5 Root folder for content repository items that are available to systems.
6 Root folders for content repository items that are available only to one given system.
7 User-created content container open in the content editor.

Description of the Contents of the Repository

The following data is stored in the content repository under the Global Root\Global Templates
parent folder.

Node Contains
Global Constituents Global Control and Supervision Participant constituents (such as variables, DFBs,
included projects).
Local Constituents Control facet templates of the Global Templates library and for each facet, the
referenced local constituent sources and the referenced global constituents
User Contents Documents (files) that can be managed by users having the appropriate role
(see EcoStruxure™ Process Expert, Installation and Configuration Guide). They
are delivered with the software and organized in a predefined folder structure and
content containers (see EcoStruxure™ Process Expert, Runtime Navigation
Services , User Guide ).
These documents can be opened when viewing instance information by using
runtime navigation services.
They can be associated either to templates or instances.

The following data is stored in the content repository under the Systems parent folder.

Node Contains
<system identifier> For each system that exists in the database of the system server, the complete set
of files defining the various existing Participant projects, their components, and
topological entities.
Data is grouped by Participant.
Project The logical Participant projects under the folder with the name of the project. If you
update the logical Participant project by using the Update Control Project
command, the project file is updated, reflecting the changes.
For each Participant project, data of the various components of the logical
Participant project such as:
 Section export files under the folder with the name of the section.
 The built Participant projects under the folder with the name of the executable.

Topology Configuration files and profiles of the entities that exist in the topology of the system
(under the folder with the name of the entity).
For entities that you configure by using the Control Participant, the corresponding
project files.
Upro For each entity of the system, the deployed Participant project. If you do online
refinement, the file is updated, reflecting the changes.

1024 EIO0000001114 06/2020

 Content Repository

Node Contains
VJC For each Supervision Participant project of the system, the various project files such
as database and configuration files.
User Contents User documents (files) that can be added and managed by users having the
appropriate role (see EcoStruxure™ Process Expert, Installation and Configuration
Guide). They are organized in a user-created folder structure and content
containers (see EcoStruxure™ Process Expert, Runtime Navigation Services ,
User Guide ) at the system level.
These documents can be opened when viewing instance information by using
runtime navigation services.
They can be associated either to templates or instances.

Content Repository Root Folder Actions

Right-click the Content Repository root folder to open a context menu with the following
commands.

Command Description
Export User Opens the Export User Contents window, which lets you export content containers
Contents (see EcoStruxure™ Process Expert, Runtime Navigation Services , User Guide ) with the
documents they contain as a single file (.cbk).
Import User Opens the import window, which lets you select an export file (.cbk) to import
Contents (see EcoStruxure™ Process Expert, Runtime Navigation Services , User Guide ) the folders
and content containers it contains.

Content Repository File Actions

Starting out from one of the previously mentioned parent folders:
1. Drill down to the lowest level folder of a node until you reach the Contents List tab (this requires
opening the folder).
2. Right-click a content and select View Content Detail.
In the Detail tab, right-click a file to open a context menu with the following commands.

Command Description
View Opens the file by using the program that is associated to it. The program must be installed on
the computer.
NOTE: You cannot save changes in the content repository when you open a file by using this
command.
Save As Opens a dialog box, which lets you save a copy of the file by selecting a location and a file name.

NOTE: To be able to open a Control Participant project file (.stu) in a standalone installation of
Control Expert, the version of Control Expert and of the installed EcoStruxure Control Expert DTM
Library need to be the same as the Control Participant. For information on the installed version,
refer to the platform release notes.

EIO0000001114 06/2020 1025

Content Repository

Temporary Contents Repository Files

Overview
The system server stores temporary files from the content repository inside a folder structure to
access the files it needs faster. If needed the software creates the temporary storage folders when
you start the system server.

Temporary File Folder Location

The folder is named Process Expert x, where x corresponds to the major version of the software
that is installed (the R• version suffix does not appear). It is located on the computer on which the
system server is installed, at the path
C:\Users\<UserName>\AppData\Local\Temp\Schneider Electric.

Reclaiming Disk Space

With time, the size of this temporary file folder increases.
You can reclaim disk space by deleting the subfolders and files inside the Process Expert x folder
when the software is not running.

1026 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Language Settings
EIO0000001114 06/2020

Chapter 27
Language Settings

Language Settings

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Default Keyboard Layout of the Virtual Machine 1028
Virtual Machine System Locale 1031

EIO0000001114 06/2020 1027

Language Settings

Default Keyboard Layout of the Virtual Machine

Overview
The software is designed in such way that software Participants capture the keyboard layout of the
computer on which the engineering client is running.
For this mechanism to work, the keyboard layout used by the computer needs to be available in
the operating system of the virtual machine (VM).
Therefore, many keyboard layouts are preloaded in the operating system of the VM.
It can happen that the computer on which the engineering client is running is configured with a
keyboard layout that is not available in the operating system of the VM. In such case, Participants
use the default keyboard layout.
If the default keyboard layout (US) is not suitable, you have the following choices:
 Select a different default keyboard layout from the list of available layouts that is better suited
than the US layout.
 Add a keyboard layout to the ones preloaded in the operating system of the VM and make it the
default one.
You can change the default keyboard layout by using the configuration wizard of the software
component, which hosts the VM that the engineering client is using. For example, if the engineering
client uses the VM of the system server, change the keyboard layout by using the configuration
wizard of the system server.
Refer to the topic describing the configuration of the virtual machine (see EcoStruxure™
Process Expert, Installation and Configuration Guide).

Switching Keyboard Layouts on the Fly

When you change the keyboard layout of your computer while working, you can also apply the
change to Participants. Refer to the section providing general information in the corresponding
Participant Services User Guide.

1028 EIO0000001114 06/2020

 Language Settings

Preloaded Keyboard Layouts

You can view the list of keyboard layouts that are preloaded in the operating system of the VM by
opening the locales.def file located at the following path:
For the system server C:\Program Files\Schneider Electric\EcoStruxure\Process
Expert\System Server\Configuration.
For the engineering client C:\Program Files\Schneider Electric\EcoStruxure\Process
Expert\Engineering Client.
For each language, the information is structured as follows:
parameter1;parameter2;parameter3;parameter4, where:
 parameter1 represents the Default keyboard layout and the System Locale parameters
 parameter2 represents the second System Locale parameter (for example (en-US))
 parameter3 represents the system locale code
 parameter4 represents the keyboard layout code

The parameters defining the keyboard layout are parameter1 and parameter4.

Determining the Current Keyboard Layout

The current keyboard layout is indicated by the Default keyboard layout parameter in the
configuration wizard.
NOTE: The default configuration is US.

Changing the Default Keyboard Layout

Changing the default keyboard layout requires that you stop the system server if the engineering
client uses the VM of the system server.

NOTICE
LOSS OF COMMUNICATION
Stop the system server only when no client is running.
Failure to follow these instructions can result in unresponsive clients.

EIO0000001114 06/2020 1029

Language Settings

To change the default keyboard layout of the operating system of the VM, proceed as follows.

Step Action
1 Open the configuration wizard of the software component, which hosts the VM that the
engineering client is using. Refer to the topic describing the configuration of the virtual machine
(see EcoStruxure™ Process Expert, Installation and Configuration Guide).
2 In the Virtual Machine section, select a language for the Default keyboard layout parameter.
3 Click Finish.
4 Restart the software component, whose configuration wizard you have updated.
Result: The change is applied.

NOTE: Even if you change the default keyboard layout parameter, Participants continue using the
same keyboard layout as the one of the computer running the engineering client, given that this
layout is already loaded in the operating system of the VM (see page 1029).

Adding Keyboard Layouts

After you add a keyboard layout to the operating system of the VM, you can select it in the
configuration wizard under Default keyboard layout.
Adding a keyboard layout requires that you stop the system server if the engineering client uses
the VM of the system server.

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 add a keyboard layout to the operating system of the VM, proceed as follows.

Step Action
1 By using a text editing software, open the locales.def file (see page 1029) of the appropriate
software component.
2 Add, at least, the parameters defining the keyboard layout (see page 1029).
NOTE: Even if you enter only 2 parameters, enter the 3 semi-colons (for example:
French;;;0000040c represents only the French keyboard layout).
3 Save the changes.
4 Restart the software component.

1030 EIO0000001114 06/2020

 Language Settings

Virtual Machine System Locale

Overview
The software allows you to set the system locale setting of the operating system of the VM, which
controls the language used to display text in non-Unicode programs, such as the Supervision
Participant.
The default system locale is (US (en-US)), which allows to display English and some other
western languages using characters contained in the Windows-1252 code page layout.
You can change the default keyboard layout by using the configuration wizard of the software
component, which hosts the VM that the engineering client is using. For example, if the engineering
client uses the VM of the system server, change the keyboard layout by using the configuration
wizard of the system server.
Refer to the topic describing the configuration of the virtual machine (see EcoStruxure™
Process Expert, Installation and Configuration Guide).
For information on the system locale setting of the Windows® operating system, refer to Language
for non-Unicode programs by clicking, starting from the Windows® Control Panel, Clock,
Language, and Region → Region → Administrative.

Available System Locale

You can view the list of system locale that are preloaded in the operating system of the VM by
opening the locales.def file located at the following path:
For the system server C:\Program Files\Schneider Electric\EcoStruxure\Process
Expert\System Server\Configuration.
For the engineering client C:\Program Files\Schneider Electric\EcoStruxure\Process
Expert\Engineering Client.
For each language, the information is structured as follows:
parameter1;parameter2;parameter3;parameter4, where:
 parameter1 represents the Default keyboard layout and the System Locale parameters
 parameter2 represents the second System Locale parameter (for example (en-US))
 parameter3 represents the system locale code
 parameter4 represents the keyboard layout code

The parameters defining the system locale are parameter1 and parameter3.

Determining the Current System Locale

The current system locale is indicated by the System Locale parameter in the configuration wizard.
NOTE: The default configuration is US (en-US).

EIO0000001114 06/2020 1031

Language Settings

Changing the System Locale

Changing the system locale requires that you stop the system server if the engineering client uses
the VM of the system server.

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 change the system locale of the operating system of the VM, proceed as follows.

Step Action
1 Open the configuration wizard of the software component, which hosts the VM that the
engineering client is using. Refer to the topic describing the configuration of the virtual machine
(see EcoStruxure™ Process Expert, Installation and Configuration Guide).
2 In the Virtual Machine section, select a language for the System Locale parameter.
3 Click Finish.
4 Restart the software component, whose configuration wizard you have updated.
Result: The change is applied.

1032 EIO0000001114 06/2020

 Language Settings

Adding a System Locale

After you add a system locale to the operating system of the VM, you can select it in the
corresponding configuration wizard under System Locale.
Adding a system locale requires that you stop the system server if the engineering client uses the
VM of the system server.

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 add a system locale to the operating system of the VM, proceed as follows:

Step Action
1 By using a text editing software, open the locales.def file (see page 1029) of the appropriate
software component.
2 Add, at least, the parameters defining the system locale (see page 1031).
3 Save the changes.
4 Restart the software component.

EIO0000001114 06/2020 1033

Language Settings

1034 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Glossary
EIO0000001114 06/2020

Glossary

A
application
The application models the complete functionality provided by the system through an application
folder structure and instances of application templates.
application interface
Mechanism that allows sharing data and manage dependencies between 2 instances/references.
The application interface allows you to link:
 applications instances/references to each other
 topological instances/references to each other

application link
Links describing connections between instances of the application that are made by using
application interfaces. The Links Editor allows you to create and edit such links.
application template
Global Template contained in the Global Templates library that models an object of the application
of a system and its associated functions. The template encapsulates the necessary Participant
capabilities.
Application templates are instantiated and can be configured to create the application of a system.
area
The area, when referring to access control, defines a topological, functional, or another user-based
rule to restrict access in the scope of an automation system.
audit trail
The audit trail records the following information for a given period:
 Who accesses a computer system.
 Which operations are performed.

B
binding
The binding is the key mechanism that establishes relations between the following items of the
facet and composite templates:
 Parameters
 Interfaces
 Elements

EIO0000001114 06/2020 1035

Glossary

built Participant project

The built Participant project is a generated, optionally refined, and built project, which is created by
the corresponding Participant and that exists at the platform level in the form of an executable.
For example, files with .stu and .ctz extensions that are represented by Control and Supervision
executables respectively are built Participant projects.

C
cardinality
The cardinality, in the context of the interface model, is the number of connections that are
supported by the objects playing the other role of the interface model.
communication channel
A communication channel is the logical representation, at the platform level, of communication
between controllers or between a controller and devices.
For example, a controller I/O scanner row is modeled by a communication channel for
Modbus TCP communication in the executable of the Control project.
communication interface
Mechanism that allows sharing data and manage dependencies between 2 instances or
references.
Communication interfaces allow the platform to link topological instances/references at the logical
level (for example, I/O scanner, OPC Factory Server, Supervision I/O devices).
communication link
Links describing logical connections between topological instances that are made by using
communication interfaces.
For example, the communication link between 2 controllers exchanging data.
communication mapping
The communication mapping process defines the communication aspects of a logical Participant
project after being mapped to the topology.
composite
The composite is an instance of a composite template.
composite template
The composite template combines the capabilities of 1 or more facet templates, each
encapsulating functionalities provided by one software Participant, and/or of other composite
templates.
constituent
Set of data provided by a software Participant, which can be global (see page 1039) or local
(see page 1040).

1036 EIO0000001114 06/2020

 Glossary

constituent encapsulation
Process that is performed by using the Facet Editor and that allows you to:
 Select constituents that are created with a software Participant.
 Optionally, modify constituents inside the corresponding Participant.
 Include the selected constituents inside a facet template.

contents repository
The contents repository is a global storage provided by the platform to manage global constituents
and other files, such as Participant projects, used by the libraries and the systems.

D
deferring mechanism
Mechanism that allows you to make available in the composite template that is at the highest level
optional element selections, parameters, and/or interfaces of its references.
deployed Participant project
A deployed Participant project is a built project that has been transferred to a controller or other
entity of the topology acting as an engine, and that you can execute.
DFB type
The derived function block type is a programming language element that consists of:
 A data structure definition partitioned into input, output, public, and internal variables.
 A set of operations written in IEC 61131 programming languages to be performed upon the
elements of the data structure when an instance of the function block type is started.

E
EcoStruxure Process Expert
Third generation name of the software platform. Formerly, StruxureWare Process Expert then,
EcoStruxure Hybrid DCS.
element
Element is the term that is used to describe the contents of templates at the next lowest level as
well as the contents of interface models:
 For facet templates, elements are the constituents that the facet encapsulates.
 For composite templates, elements are:
 Facet references
 Composite references

 For interface models, elements are the data that is shared. See interface elements.
You can define properties and rules for elements during the Global Templates definition stage.
engine
An engine is the projection of the hardware and software defined in the topology that is able to
execute the deployed Participant project.

EIO0000001114 06/2020 1037

Glossary

engineering client
EcoStruxure Process Expert client connecting to the system server that you use to engineer and
maintain systems. It can run on the system server and/or an engineering station.
Each client hosts a virtual machine in which the software Participants are running.
engineering station
The engineering station is a computer running an EcoStruxure Process Expert engineering client
to design, and maintain systems that exist on the server to which the engineering client connects.
executable
The executable is a project component that represents the built Participant project. It contains the
mapping information.
execution domain
Property of the executable of a Participant project, which serves as a filter for selecting the scope
of applicable services.
For example, it is used to define the boundaries for runtime navigation services or to restrict the
exchange of data through peer to peer communication between projects that have executables
with the same execution domain.

F
faceplate
The faceplate is a component of a Supervision genie that provides a user interface to interact with
the object that it represents.
facet
The facet is an instance of a facet template.
facet element
The facet element is the contents that can be accessed at the system level. Depending on the type
of facet template, such elements can be either:
 The visible part of the constituents stored in the facet templates.
 A set of data defined by the facet template.

facet template
The facet template is the smallest available template that encapsulates a specific capability
provided by 1 software Participant only.

G
genie
Animated graphic that is assigned to Supervision pages and that represents functionalities of
instances of the application during operation.
Genies are encapsulated in Supervision facets.

1038 EIO0000001114 06/2020

 Glossary

global constituent
Set of data provided by a software Participant that is a common resource referenced by several
Global Templates. Global constituents are stored in the contents repository.
Global Templates
Global Templates encapsulate one or more functions that can be customized and reused in any
system created with EcoStruxure Process Expert. They are stored in the Global Templates library.

H
hardware mapping
The hardware mapping process links the logical projection of the hardware that is defined in the
application and assigned to projects to the hardware defined in the topology of the system.
For example, linking Control variables representing I/O signals to I/O channels of an I/O module.
HMI
Abbreviation for human machine interface. It is a graphical operator interface for industrial
equipment.

I
I/O
Abbreviation for Inputs/Outputs.
IEC
The International Electrotechnical Commission is a non-profit and non-governmental international
standard organization that prepares and publishes international standards for electrical, electronic,
and related technologies.
instance
Abbreviation for object instance. It is the result of the instantiation of a template.
instance element selection
The instance element selection is a mechanism of the instantiation stage that allows you to
customize an instance by selecting services that are provided by the template that the instance
uses.
instance parameter
Instance parameters are properties of the elements of an instance that you may be able to
customize.
instantiation naming convention
The instantiation naming convention defines the naming strategy that the platform applies when
you create instances.

EIO0000001114 06/2020 1039

Glossary

interface
The interface is a reference, inside a composite or facet template, of an interface model. Interfaces
are exposed by the facets of an instance, allowing you to make different types of links with other
instances to share data.
In the context of the template definition, interfaces are a mechanism to define the links between
references by declaring compatibility and/or requirement rules.
interface element
Represents the data that will be shared through an interface. Interface elements are defined during
in the interface definition. Interface elements can be transformed by the interface by using
expressions.
interface link
Links describing logical connections between instances that are made by using interfaces.
The following types of links exist:
 Physical links
 Communication links
 Application links

Each type of link is made by using the corresponding interface (physical, communication, or
application interface).
interface model
The interface Model is a type of template that is available in the Global Templates library and that
you can configure.

L
local constituent
Set of data that is provided by a software Participant, encapsulated inside a facet template but not
used at the system level. The local constituent is used to generate the contents of the logical
Participant project. An example is Control Participant code that is encapsulated in a Control facet
template.
logical Participant project
The logical Participant project is a generated and refined project, which is created by the
Participant but, which is not associated to the topology.
NOTE: The refinement of the project is optional.

1040 EIO0000001114 06/2020

 Glossary

M
mapping interface
Mechanism that allows sharing data between two facets.
Mapping interfaces allow you to perform the hardware mapping. It is the process whereby you link
facets assigned to projects to facets representing the hardware defined in the topology through
matching mapping interfaces that these facets expose.
MES
The Manufacturing Execution Systems is a control system for managing and monitoring work-in-
process in a factory plant.

N
network variable
The network variable is a peer to peer communication mechanism allowing you to share data
between 2 or more Control projects.

O
object template
An object template is a generic term that covers several reusable templates such as facet or
composite templates.
OFS
Abbreviation for OPC Factory Server.
operation client
An EcoStruxure Process Expert client connecting to the system server that you can use during
runtime to monitor and troubleshoot a system.
operator station
The operator station is a computer running a Supervision client software.

P
Participant services
Participant services are the functions provided by a software Participant when interacting with
EcoStruxure Process Expert.
peer to peer communication
Peer to peer communication is a data exchange mechanism between 2 or more Control projects,
which uses the I/O scanner function of the controller acting as client.

EIO0000001114 06/2020 1041

Glossary

physical (interface) link

Links describing logical connections between topological instances that are made by using
physical interfaces.
For example, the connection of a controller to an Ethernet network.
physical connection
Link between topological entities representing the physical connections between controllers,
station nodes, devices, and communication networks.
physical interface
Physical interfaces allow the platform to link, at a physical level, topological instances to model the
topology of the system.
platform
Abbreviation for system platform. Represents the services that are provided by EcoStruxure
Process Expert apart from the software Participants.
privilege
Defines groups of functions that are provided by an application and granted to users through
access control.
project
Component of a system associated to a software Participant. Its structure contains elements that
are managed by the software participant.
project container
The project container is an organizational structure of a project to organize the facets that are
assigned to it. Such a structure models the ones managed by the corresponding software
Participant, and that are visible at the system level.
project facet
Facet that is assigned to a project.

R
redundant controller
Generic term that is used to refer a Quantum Hot Standby controller and/or an M580 redundant
controller.
reference
Defines facet and composite templates, which are contained inside other facet or composite
templates in order to distinguish templates, which are used in the composition of other templates
from the highest level templates, such as control modules.

1042 EIO0000001114 06/2020

 Glossary

role
The role can have 2 different meanings,
 For access control:
The role groups functionalities to grant different levels of user rights, which combine areas and
privileges to fulfill a set of services.
 For interface models:
The role defines the 2 sides of an interface, role A and role B.
runtime navigation services
Describes the complete set of functionalities that are provided by EcoStruxure Process Expert
operation client in runtime, such as process monitoring, viewing of instance information,
diagnostics.

S
service
In the context of projects, the project service is an organizational structure of a project to organize
the execution capabilities. It models the structures that are managed by the corresponding
software Participant, and that are visible and configured at the system level.
In the context of templates, a service represents a functionality provided by a Participant under the
form of a facet referenced by the template.
service mapping
The service mapping links the execution capabilities of a project represented by the executable to
an engine of the topology.
For example, it can link:
 The I/O server of a Supervision project to a station node representing the operation server.
 The executable of a Control project to a controller.

software
Refers to EcoStruxure Process Expert.
software Participant
An external tool that is running in the virtual machine and which collaborates with the platform. For
example, the Control Participant.
station node
A station node represents a computer that can act as an engine to execute a Control project by
using software emulating a simulator, or a Supervision project by using Supervision software.
subnet mask
A 32-bit value that indicates the number of available host addresses on a subnet, which uses
TCP/IP knowing that the first and last addresses are reserved (for example, subnet mask
255.255.192.0 allows 317 addresses for classless devices). It also indicates whether addressing
is classful or classless. For classful addressing, it indicates the class of the network (for example,
255.255.255.0 is the subnet mask for class C networks).

EIO0000001114 06/2020 1043

Glossary

Supervision client
Client connecting to the Supervision server that provides runtime services to operate and monitor
automation systems. The client runs on an operator station and/or operation server.
Supervision server
Server running on the operation server or on the system server, and that provides runtime data to
Supervision clients.
system
Models a physical automation system.
The system consists of the following components:
 Topology
 Application
 Participant projects

system engineering life cycle

The system engineering life cycle represents the stages to engineer a system in EcoStruxure
Process Expert.
system server
EcoStruxure Process Expert server that hosts:
 A virtual machine running the software Participants
 The database containing template libraries and system data

The system server manages requests from the EcoStruxure Process Expert clients.

T
topological entity
A topological entity is the representation of piece of hardware infrastructure.
For example, a controller.
topology
Models the hardware and software infrastructure of a system through topological folders and
entities.

V
virtual machine
A software implementation emulating the architecture and functions of an actual computer, which
supports the execution of an operating system. The EcoStruxure Process Expert system server
hosts a virtual machine (VM) that uses a Microsoft® Windows® operating system to run the
software Participants.

1044 EIO0000001114 06/2020

 EcoStruxure™ Process Expert
Index
EIO0000001114 06/2020

Index

Symbols ers, 485

Generate command for projects, 484
$EGenericDeviceHW template
import command (control), 332
generic device mapping interfaces, 656
import command (supervision), 373
$GenericDevice
import command (topology), 620
implementing communication, 858
instance delete command, 196
$GenericNOC_UL
paste command, 240
implementing communication, 858
Purge command, 996
$GenericPBSlave template
ReGenerate command for projects, 494
generic device mapping interfaces, 656
restore command, 167
$GenNOCDevice
template export command, 983
implementing communication, 858
template import command, 993
$PRMMgt templates
Update Control Project command, 852
managing Modbus TCP communication
About Process Expert
(I/O scanning), 862
About dialog box, 117
$System
opening the about dialog box, 115
$System parameters of instances, 209
actions
on assigned facets, 436
on generated facets, 501
A activity
aborting log files, 89
abort task icon, 86 notification panel, 86
application import command, 290 addresses
back up command, 164 generating network addresses for super-
build command (control), 694 vision components, 706
build command (supervision), 706 identifying engines, 717
Deploy Built Project command (supervi- Advantys
sion station node), 782 selecting templates, 555
Deploy Built Project command (supervi- alarm server redundancy
sion), 776 implementing, 356
Deploy Changes command (supervision), analyze issues
785 troubleshooting control Participant proj-
export command, 257 ects, 511
export command (control), 315 validity indicators, 691
export command (supervision), 361 Analyze Project
export command (topology), 612 control project settings, 308
folder delete command, 186 analyzing
Generate and Build command for proj- control projects during generation, 449
ects, 447 application
Generate command for project contain- import rules for control project-related ob-

EIO0000001114 06/2020 1045

Index

jects, 319 assigned facets

import rules for supervision project-relat- generating automatically assigned facets,
ed objects, 367 446
modeling the application of systems, 171 managing assigned facets, 435
Application Browser pane unassigning generated facets, 503
presentation, 181 assigning
using and customizing, 181 Assignment Viewer description, 416
Application Explorer defining container names, 402
accessing, 174 facets, 401
opening, 115 facets (control), 419
presentation, 175 facets (supervision), 421
application export files Assignment Editor
using the invariant culture, 265 presentation, 386
application folders assignment stage
actions, 186 completing, 383
changing folder structure, 241 concept, 53
changing the application hierarchy, 238 Assignment Viewer
copying and pasting, 239 description, 416
creating, 186 View Assignments window, 438
managing, 235 assignments
moving, 241 automatic facet assignment, 425
properties, 188 viewing by instance, 438
application objects authentication
exporting and importing to XML or CSV, logging in to server and clients, 70
255 automatic
application passwords automatic facet assignment, 425
changing the application password of automation system
control projects, 730 description, 41
clearing the application password of con- automation systems
trol projects, 731 description, 29
managing passwords of control projects,
725
resetting a forgotten password, 731 B
setting the application password of control back up command
projects, 728 aborting, 164
application structure backing up
tree view description in Containers pane, backing up systems, 163
429 backing up data
tree view when refining Control projects, backing up controller data, 823
510 backup
tree view when refining Control projects password information and settings in sys-
online, 818 tem backups, 164
application templates backup files
description, 35 managing data backup files (control), 335

1046 EIO0000001114 06/2020

 Index

batch built Participant projects

modeling the equipment hierarchy, 173 changing (control), 696
BMENUA0100 changing (supervision), 710
variable tag addresses, 705
boards
creating communication boards (supervi- C
sion), 351 calculated variable tags
bold formatting I/O device properties, 350
editing instance properties, 207 canceling
browsers canceling generation for version conflict
Templates Browser presentation, 178 (control), 450
build command capabilities
aborting (control), 694 hardware, 92
aborting (supervision), 706 programming, 92
build stage certificate validity
completing, 687 About dialog box, 117
concept, 62 changes
control projects, 688 actions changing the build status (con-
supervision project, 703 trol), 696
build states deploying changes in hardware map-
when deploying (supervision), 775 pings, 762
build status deploying changes to engines (control),
actions changing the build status (con- 757
trol), 696 managing hardware mappings after de-
building the logical supervision project, ploying, 663
707 saving changes in Manage Network Vari-
changes affecting the build status (con- ables dialog box, 540
trol), 695 changes log
verifying before deploying (control), 736 accessing, 969
when deploying from station node (super- composite templates, 961
vision), 779 facet templates, 957
building interfaces, 952
creating the built Control Participant proj- saving changes in Global Templates, 979
ect, 689 CHM help
network addresses of supervision compo- HTML help for user-created templates,
nents, 706 108
building changes (control) using the HTML help for several versions
building with device DDT variables, 697 of templates, 105
building control projects circular links
building with device DDT variables, 691 generating, 450
Generate and Build command, 691 citect.ini files
project settings, 692 deploying, 773
building supervision projects deploying from station node, 778
Generate and Build command, 706 deploying to station nodes from execut-
able, 775

EIO0000001114 06/2020 1047

Index

clients 862
connection to the server, 75 implementing I/O scanning with STB is-
creating (supervision), 347 lands, 861
engineering client UI description, 114 implementing peer to peer communica-
logging in and out, 70 tion, 865
notification panel, 86 managing, 855
quitting, 80 mapping (control), 630
restarting after closing unexpectedly, 79 Modbus explicit messaging, 877
supervision client properties, 347 Modbus TCP explicit messaging, 867
working with several clients, 83 task workflow, 146
closing Variable Mapping Editor window, 646
closing the software, 80 communication boards
clusters creating (supervision), 351
actions, 344 driver selection, 352
creating, 344 properties (supervision), 352
properties, 344 communication channels
collapsing actions, 635
nodes in the Application Browser pane, adjusting properties, 641
183 creating, 640
nodes in the instance pane, 204 moving, 643
color coding properties, 635
importing application objects, 292 properties server side, 638
color indicators unmapping, 642
instance color icons, 212 communication mapping
project color icons, 375 Communication Mapping Editor , 631
communicating prerequisites (control), 630
with devices through Ethernet explicit with Modbus serial devices, 682
messaging, 867 with Modbus TCP devices, 682
with devices through Ethernet IP explicit communication module
messaging, 873 removing from the configuration, 561
with devices through Modbus explicit communication networks
messaging, 878 connecting a station node to the Ethernet,
communication 601
changing EtherNet/IP device properties, connecting an STB island to the Ethernet,
590 603
changing Modbus TCP device properties, creating, 594
590 disconnecting a station node from the
changing STB islands properties, 575 Ethernet, 601
communicating with the computer for de- disconnecting an STB island from the
ployment (control), 723 Ethernet, 604
Ethernet IP explicit messaging, 873 communication ports
implementing I/O scanning, 857 creating (supervision), 351
implementing I/O scanning with devices, creating additional ports (supervision),
858 353
implementing I/O scanning with PRMs, properties (supervision), 353

1048 EIO0000001114 06/2020

 Index

components consistency management

creating supervision project components, generating inconsistent facets, 491
343 refining control projects, 523
Composite Editor consumer
changes log, 969 about network variables, 527
menus and toolbars, 963 managing network variables, 538
panes, 969 owner and consumer projects, 527, 538
parameter pane, 969 consumer project
presentation, 958 description, 527
using the radar view, 972 Container Naming Rules
using the simplified view, 973 window description, 402
composite templates containers
changes log, 961, 969 creating and managing, 384
description, 31 Containers pane
modification strategy, 999 displaying sections in tree view, 389
configuration content
changing EtherNet/IP device properties, resolving contents conflicts on import, 992
590 content repository
changing Modbus TCP device properties, actions, 1025
590 content description, 1024
changing STB islands properties, 575 deleting temporary files, 1026
changing the controller configuration, 561 explorer, 1022
changing the PRM configuration, 582 opening, 115
viewing instance configuration, 236 root folder actions, 1025
configuration file User Contents folder, 1022
OFS/OPCUA configuration file descrip- Content Repository explorer
tion, 705 opening, 1022
configuration stage Control Expert projects
completing, 549 importing a Control Expert project, 333
concept, 58 control modules
configuring description, 31
configuring HART modules, 591 template modification strategy, 999
instance parameters, 206 Control Project Browser
connection description, 302
client-server connection, 75 control project sections
physical connection import rules, 616 actions, 392, 392
redundant configuration connection sce- control projects
narios, 836 actions, 305
consistency checks build stage, 688
after import, 316 changing built Participant projects, 696
before updating control projects, 849 communication mapping import rules ,
code lock feature, 514
fixing inconsistencies, 526
performing (control), 526
rules, 524

EIO0000001114 06/2020 1049

Index

322 protection, 721

consistency management, 523 task quick reference, 151
creating, 305 task workflow, 146
creating FBD and non-FBD sections, 309 tree view mode when refining, 510
creating FBD sections, 392 tree view mode when refining online, 818
creating the built Participant project, 689 updating projects after deploying changes
data backup file import rules , 327 online, 817
deleting, 307 Control service
deploying, 714 creating in station node, 567
deploying changes to engines, 757 ControlExecutables
description of tree view mode, 429 actions, 625
executable import rules , 322 assigning execution domains, 627
executing, 788 creating, 625
export settings, 314 properties, 627
exporting, 312 ControlExpert services
facet import rules , 320 actions for station nodes, 572
generating after changes, 488 properties for station nodes, 572
generation specifics, 449 controller stop
hardware mapping import rules , 322 when deploying changes, 771
import settings, 317 controllers
importing, 316 about network variables, 527
importing a Control Expert project, 333 actions, 557
managing, 310 assigning IP addresses, 561
managing passwords of control projects, backing up controller data, 823
725 changing the application password of
mapping stage, 624 control projects, 730
peer to peer communication export set- changing the configuration, 561
tings, 315 clearing the application password of con-
peer to peer communication variable im- trol projects, 731
port rules , 326 communicating with the computer, 723
prerequisites, 305 configuring, 561
Project Explorer, 304 configuring the I/O scanner, 562
Project Explorer and Browser, 299 connecting to Ethernet networks, 599
project import window, 328 creating, 556
properties, 307 creating the system topology, 550
refining, 506 deleting, 565
refining locked code, 514 deploying built projects, 736
regenerating, 493 deploying changes (control), 757
related project data import rules , 319 deploying data, 750
section import rules , 320 deploying to redundant controllers, 733
selecting type version changes, 456 disabling the I/O scanner, 561
service mapping import rules , 322 disconnecting from Ethernet networks,
starting the simulator with your control
project, 721
starting the simulator without password

1050 EIO0000001114 06/2020

 Index

600 able, 775

execution with redundant controllers, 793 redeploying to engines from executable,
exporting, 610 777
import rules, 615 redeploying to engines from station node,
importing, 613 783
managing data backup files, 335
managing network variables, 538
mapping (control), 628 D
memory size configuration, 558 data
properties, 558 backing up controller data, 823
redeploying built control projects, 743 deploying controller data to engines, 750
representation, 563 instance validity status, 205
selecting templates, 555 managing data backup files (control), 335
setting the application password of control sorting data, 138
projects, 728 using filters, 138
starting and stopping, 796 data backup
supported platforms, 92 with redundant controllers, 823
copying data backup files
copy-paste application folders, 240 import rules for data backup files (control),
copy-paste instances, 240 327
data elements from software Participants, managing data backup files (control), 335
136 data deployment
Global Templates and folders, 982 to redundant controllers, 750
counting data types
counting instances, 198 conversion to Participant types, 96
CRA modules data types used by the software, 96
connection with device I/Os, 857 validating instance parameters, 207
creating DDDT
Global Template editors, 944 building changes in control projects, 697
CSV building control projects, 691
application export file description, 259 creating during build, 690
editing the application export file, 263 deploying changes to control projects,
exporting and importing application ob- 766
jects to XML or CSV, 255 for peer to peer communication, 690
importing CSV files into the application, managing device DDT variables, 517
287 naming convention, 690
csv export files naming convention for P2P communica-
using the invariant culture, 265 tion, 690
ctz files DDT
changing (supervision), 710 device DDTs in the configuration, 556
creating (supervision), 703 delete command
deploying, 773 aborting folder delete, 186
deploying changes to station nodes, 784 aborting instance delete, 196
deploying from station node, 778
deploying to station nodes from execut-

EIO0000001114 06/2020 1051

Index

deleting trol), 723

control projects, 307 process flowchart, 715
controllers, 565 deployment stage
deleting FBD sections during update Con- completing, 713
trol project, 850 concept, 64
PRMs, 583 control projects, 714
sections, 392 supervision project, 773
STB islands, 578 device DDT
unmapping hardware mappings, 661 building changes in control projects, 697
Deploy Built Project command building control projects, 691
aborting (supervision station node), 782 creating during build, 690
aborting (supervision), 776 deploying changes to control projects,
Deploy Changes command 766
aborting (supervision), 785 device DDTs in the configuration, 556
deployed control projects for peer to peer communication, 690
editing online, 816 naming convention, 690
deploying naming convention for P2P communica-
controller data to engines, 750 tion, 690
deploying changes to engines (control), device DDT variables
757 managing device DDT variables, 517
from station node (supervision), 778 Device Editor
main redundant configuration scenarios, hardware module properties, 565
833 DeviceConfig.xml file
preparing for deployment, 774 creating, 703
to engines (control), 736 deploying, 773
to redundant controllers, 733, 736 saving, 678
to station nodes from executable (supervi- devices
sion), 775 actions for EtherNet/IP devices, 586
deploying changes actions for Modbus TCP devices, 586
changes requiring to stop the controller, assigning IP addresses to topological I/O
771 device entities, 587, 587
deploying device DDT variable changes, changing IP addresses in explicit mes-
766 saging, 872, 876
hardware mappings, 762 communicating through Ethernet explicit
main redundant configuration scenarios, messaging, 867
833 communicating through Ethernet IP ex-
selecting IP addresses, 758 plicit messaging, 873
to redundant controllers, 758 communication through Modbus explicit
to redundant controllers (control), 735 messaging, 878
to station nodes (supervision), 784 connecting to Ethernet networks, 602
deploying control projects connectivity with supervision, 920
supported engines, 716 creating EtherNet/IP devices, 584
deployment creating Modbus TCP devices, 584
communicating with the computer (con- disconnecting from Ethernet networks,

1052 EIO0000001114 06/2020

 Index

602 editing composite templates

integrating PROFIBUS devices, 925 changes log, 961
managing Modbus TCP communication editing facet templates
(I/O scanning), 858 changes log, 957
mapping I/Os (control), 655 editing instance properties
properties of EtherNet/IP device entities, bold formatting, 207
587 italic formatting, 207
properties of Modbus TCP device entities, validity status, 207
587 editing instances
selecting topological templates, 555 changing element selection after assign-
diagnostic messages ment, 424
during generation, 499 editing interfaces
DIO scanner changes log, 952
implementing communication by I/O editing online (control)
scanning, 857 changes requiring to stop the controller,
disk variable tags 771
I/O device properties, 350 overview, 809
docking menus editors
creating additional work areas, 123 Assignment Editor, 386
downloading Composite Editor, 958
controller data to engines, 750 Facet Editor, 954
deploying changes to engines (control), Interface Editor, 945
757 Links Editor, 218
deploying to engines (control), 736 opening Global Template editors, 944
main redundant configuration scenarios, elements
833 definition, 31
redeploying to engines (control), 743 replacing templates of elements, 1006
to redundant controllers, 733 updating templates of elements, 1001
dragging End User License Agreement
moving the workspace around, 120 viewing the End User License Agreement,
drivers 117
creating communication boards and engineering client
ports, 351 engineering client work areas, 118
DTM engineering clients
naming convention, 690 engineering client UI description, 114
naming convention for P2P communica- engines
tion, 690 backing up controller data, 823
duplicating deploying built control projects, 736
Global Templates, 1013 deploying data (control), 750
deploying to redundant controllers, 733
execution with redundant controllers, 793
E managing data backup files (control), 335
editing mapping (control), 628
deployed control projects online, 816 redeploying built control projects, 743
refreshing engine status and connecting,

EIO0000001114 06/2020 1053

Index

723 Ethernet networks

supported engines for deployment (con- actions, 594
trol), 716 connecting devices, 602
entities connecting PRMs, 604
creating and configuring topological enti- connecting station nodes, 601
ties, 549 connecting STB islands, 603
entity folders creating, 594
description, 552 disconnecting devices, 602
entity identifiers disconnecting PRMs, 605
naming rules, 98 disconnecting station nodes, 601
enumerations disconnecting STB islands, 604
exporting parameter values to CSV, 265 exporting, 610
exporting parameter values to XML, 277 importing, 613
viewing values in the Instance Editor, 201 properties, 595
equipment selecting templates, 555
equipment hierarchy, 173 Ethernet RIO drops
generating equipment (supervision), 496 connecting to Ethernet networks, 599
equipment generation disconnecting from Ethernet networks,
troubleshooting, 499 600
equipment hierarchy EtherNet/IP devices
import rules for equipment (supervision), changing properties, 590
368 creating and configuring devices, 584
errors EULA
detected errors during generation, 450, viewing the End User License Agreement,
450 117
Ethernet Exclude command
conflicting Ethernet connections, 597 description, 955
connecting controllers to Ethernet net- executable files
works, 599 changing (control), 696
connecting entities to an Ethernet net- creating (control), 689
work, 596 creating (supervision), 703
disconnecting controllers from Ethernet deploying (supervision), 773
networks, 600 modifying (supervision), 710
managing Ethernet IP explicit messaging, executables
873 actions (control), 625
managing Modbus TCP explicit messag- actions (supervision), 678
ing, 867 assigning execution domains (control),
viewing Ethernet connections, 596 627
Ethernet IP devices assigning execution domains (supervi-
import rules, 615 sion), 679
Ethernet IP explicit messaging backing up controller data, 823
communicating with devices, 873 creating (control), 625
managing communication, 873 creating (supervision), 677
deploying changes to engines (control),

1054 EIO0000001114 06/2020

 Index

757 expanding
deploying changes to station nodes (su- nodes in the Application Browser pane,
pervision), 784 183
deploying controller data to engines (con- nodes in the instance pane, 204
trol), 750 explorers
deploying from station node (supervision), Application Explorer, 174
778 Content Repository explorer, 1022
deploying to engines (control), 736 creating work areas in explorers, 125
deploying to redundant controllers, 733 Global Templates Explorer, 932
deploying to station nodes (supervision), opening, 115
775 opening the Project Explorer, 300
executable import rules (control), 322 overview, 43
executable import rules (supervision), 370 Systems Explorer, 158
executing with redundant controllers, 793 task workflow, 146
managing data backup files (control), 335 Topology Explorer, 551
properties (control), 627 export command
properties (supervision), 679 aborting, 257
redeploying to engines (control), 743 aborting (control), 315
redeploying to engines (supervision), 777, aborting (supervision), 361
783 aborting (topology), 612
executables (supervision) aborting template export, 983
status change when importing new con- export files
tent version, 992 editing the CSV application export file,
executing 263
deployed participant projects (control), editing the XML application export file,
796 277
to redundant controllers, 793 editing XML to manage application links,
execution 283
facet execution order, 440 using the invariant culture, 265
FBD section execution order, 311 export settings
process flowchart, 790 control projects, 314
synchronizing redundant controllers, 804 peer to peer communication export set-
execution domains tings, 315
assigning to executables (control), 627 supervision projects, 360
assigning to executables (supervision), exporting
679 CSV application export file description,
execution order 259
after first generation, 452 editing exported hardware mappings, 669
when regenerating, 494 exporting application objects to XML or
execution stage CSV, 255
completing, 787 exporting control projects, 312
concept, 65 exporting hardware mappings, 665
control projects, 788 password related information for topologi-
supervision projects, 854

EIO0000001114 06/2020 1055

Index

cal entities, 610 facets, 424

peer to peer communication data, 312 generating automatically assigned facets,
supervision projects, 358 446
templates, 983 import rules for control project facets, 320
topological entities, 610 managing assigned facets, 435
XML application export file description, moving, 437
275 moving generated facets, 504
exporting control projects navigating to the instance, 441
software version compatibility, 312 reassigning, 503
exporting supervision projects relinking, 504
software version compatibility, 358 unassign, 436
expressions unassigning generated facets, 503
Container Naming Rules window, 402 unlinking generated facets, 503
importing expressions for control sec- viewing assignments per instance, 438
tions, 317 FBD
extracted Participant windows using FBD language with Process Expert,
troubleshooting, 136 92
extracting FBD sections
software Participant windows, 134 actions, 392
changing execution order, 311
creating during generation, 452
F creating FBD sections, 392
Facet Editor deleting, 392
changes log, 969 import rules for FBD sections, 320
description, 954 inserting FBD sections, 392
menus and toolbars, 963 properties, 393
panes, 969 when regenerating, 494
parameter pane, 969 files
using the radar view, 972 adding external files to supervision proj-
using the simplified view, 973 ects, 547
facet templates filters
changes log, 957, 969 filtering data, 138
description, 31 Templates Browser, 177
modification strategy, 999 to display instance parameters, 204
facets floating Participant windows
actions after assigning, 436 troubleshooting, 136
actions after generation, 501 folder structure
assigned facet description, 423 changing application folder hierarchy, 188
assigning, 401 changing the position of folders, 244
assigning (control), 419 folders
assigning (supervision), 421 changing the application hierarchy, 238
automatic facet assignment, 425 copying and pasting application folders,
changing order inside section, 440
element selection changes of assigned

1056 EIO0000001114 06/2020

 Index

239 generating
copying and pasting library folders, 982 analyzing control projects, 449
creating Global Template folders, 939 automatically assigned facets, 446
exporting and importing to XML or CSV, configuring settings (control), 454
255 control project specifics, 449
moving application folders, 241 detecting errors during generation, 450
moving folders, 188 diagnostic messages, 499
moving topological folders, 607 entire projects, 484
naming rules, 98 equipment (supervision), 496
resolving application import conflicts, 294 facet order, 440
S88 representation, 193 FBD section size, 452
searching application instances and fold- first-time generation, 483
ers, 175 function block layout during first genera-
function blocks tion, 452
layout after first generation, 452 function description, 489
layout when generating after changes, general description, 444
491 Generate and Build command, 447
layout when regenerating, 494 generating invalid facets again, 491
importing sections after generation, 487
invalid facets, 447
G part of a project, 485
gateways projects after changes, 487
using for Modbus explicit messaging, 878 rules for generating graphical links, 450
Generate and Build command satisfying naming rules, 446
aborting, 447 section order, 311
Building control projects the first time, 691 statuses of facets, 480
Building supervision projects the first generation
time, 706 canceling generation for version conflict
description, 447 (control), 450
Generate command changing type versions during generation
aborting generation of project containers, (control), 456
485 function block layout after changes, 491
aborting generation of projects, 484 managing generated facets, 501
generated code skipping facets during generation, 448
identifying software-generated code, 514 generation name issues
generated facets troubleshooting, 499
unlinking, 503 generation stage
completing, 443
concept, 55
generating inconsistent facets, 491
GenerationSettings
configuring generation XML file (control),
454
generic devices
communicating through Ethernet explicit

EIO0000001114 06/2020 1057

Index

messaging, 867 H
communicating through Ethernet IP ex-
HAL DFBs
plicit messaging, 873
managing, 699
communication through Modbus explicit
HAL variables
messaging, 878
managing, 699
connectivity with supervision, 920
HAL variables and DFBs
creating EtherNet/IP devices, 584
properties, 700
creating Modbus TCP devices, 584
viewing, 702
managing Modbus TCP communication
hardware
(I/O scanning), 858
configuration stage, 549
mapping interfaces, 656
creating the system topology, 550
genies
mapping, 655
editing supervision pages, 544
supported components, 550
Global Template editors
hardware abstraction layer variables
opening, 944
managing, 699
Global Templates
hardware mapping
actions, 940
managing HAL variables, 699
classification, 31
Hardware Mapping Editor
copying and pasting, 982
presentation, 656
description, 31, 940
hardware mappings
duplicating, 1013
editing exported hardware mappings, 669
Global Templates Explorer, 932
exporting hardware mappings, 665
managing, 978
importing hardware mappings, 674
naming convention, 934
managing changes after deploying, 663
purging the Global Templates library, 995
unmapping hardware mappings, 661
renaming, 979
HART
replacing templates of elements, 1006
HART communication, 591
saving changes, 979
HART modules
updating, 1001
configuring HART modules, 591
Global Templates definition
representation, 593
concept, 44
help
Global Templates Explorer
help button, 115
folder actions, 939
HTML help for user-created templates,
opening, 115, 932
108
presentation, 933
opening the help of software Participants,
Toolbox, 936
104
Global Templates library
using the HTML help for several versions
viewing in the Global Templates Explorer,
of templates, 105
932
hierarchical naming, 208
Go To Instance command
hot standby
navigating to the instance, 441
managing data backup files, 335
graphical links
generation rule, 450

1058 EIO0000001114 06/2020

 Index

hot standby controllers 602

backing up controller data, 823 connecting PRMs to Ethernet networks,
connecting to Ethernet networks, 597 604
deploying built control projects, 736 creating and configuring Modbus TCP de-
deploying changes to redundant control- vice, 584
lers, 758 disconnecting devices from Ethernet net-
deploying controller data, 750 works, 602
deploying to redundant controllers, 733, disconnecting PRMs from Ethernet net-
736 works, 605
disconnecting from Ethernet networks, implementing communication, 857
600 managing communication with devices,
execution, 793 858
identifying, 556 managing communication with PRMs,
main deployment and execution scenari- 862
os, 833 managing communication with STB is-
physical connection import rules, 616 lands, 861
redeploying to redundant controllers, 743 managing peer to peer communication,
reservation and connection scenarios, 865
836 I/O server redundancy
HTML help implementing, 355
HTML help for user-created templates, icons
108 assigning icons to folders, 193
using the HTML help for several versions identifiers
of templates, 105 changing the identifier of Global Tem-
plates, 979
naming rules, 98
I identifying engines
I/O device addresses using physical addresses, 717
Build stage, 704 IL
I/O devices using IL language, 92
communication mapping import rules , import
322 accessing the import window, 617
creating I/O devices, 348 import command
I/O devices for calculated variable tags, aborting (control), 332
350 aborting (supervision), 373
I/O devices for disk variable tags, 350 aborting (topology), 620
properties (supervision), 349 aborting application import command,
I/O scanner 290
configuring for controllers, 562 aborting template import, 993
disabling, 561
I/O scanner lines
memory allocation, 692
I/O scanning
connecting devices to Ethernet networks,

EIO0000001114 06/2020 1059

Index

import rules 992

executable import rules (control), 322 sections during online refinement, 829
executable import rules (supervision), 370 supervision projects, 363
for control project facets, 320 templates, 987
for control project-related objects, 319 topological entities, 613
for data backup files (control), 327 importing control projects
for equipment (supervision), 368 software version compatibility, 316
for included projects, 365 importing instances
for mapped peer to peer communication resolving conflicts, 294
variables, 326 importing supervision projects
for pages of supervision projects, 368 software version compatibility, 363
for program sections (control), 320 included projects
for supervision project facets, 368 adding or removing, 546
for supervision project-related objects, downloading, 709
367 importing, 365
for topological entities, 615 importing with templates, 988
for topological folders, 615 saving (supervision), 678
mapping import rules (control), 322 inconsistent facets
mapping import rules (supervision), 370 generating, 491
physical connection import rules, 616 layout of blocks after generation, 491
import settings infrastructure
control projects, 317 creating the system topology, 550
supervision projects, 363 supported components, 550
importing instance count
application import settings, 292 About dialog box, 117
checking consistency after importing con- Instance Editor
trol projects, 316 accessing, 200
color coding when importing application presentation, 201
objects, 292 instance path
Control Expert projects, 333 viewing instance location information, 236
control projects, 316 instance properties
expressions for control project sections, naming rules, 98
317 instances
importing application objects to XML or accessing the Instance Editor, 200
CSV, 255 actions, 196
importing hardware mappings, 674 changing the application hierarchy, 238
importing XML or CSV files into the appli- color indicators, 212
cation, 287 configuration parameters, 209
password related information for topologi- configuring parameters, 206
cal entities, 616 copying and pasting, 239
resolving contents conflicts for templates, counting for licensing, 198
creating, 194
data status, 205
element selection changes of assigned

1060 EIO0000001114 06/2020

 Index

facets, 424 interfaces

exceeding count of a license, 199 changes log, 952
exporting and importing to XML or CSV, generic device mapping interfaces, 656
255 mapping hardware interfaces, 655
hierarchical naming, 208 modification strategy, 999
import rules for control project-related ob- invalid
jects, 319 instance data validity status, 205
import rules for supervision project-relat- link validity status, 224
ed objects, 367 invalid facets
Inspect Instance window, 236 generating, 447
Linking instances, 217 generating invalid facets again, 491
Links Editor, 218 invariant culture
managing, 235 editing the application export file, 265
moving, 241 editing the XML application export file,
navigating from facets to the instance, 279
441 IO servers
of templates, 38 communication ports, 345
order when creating, 194 properties, 345
resolving import conflicts, 294 IP address
searching, 181 assigning to controllers, 561
searching application instances and fold- assigning to EtherNet/IP devices, 587
ers, 175 assigning to Modbus TCP devices, 587
validating parameters, 207 assigning to PRMs, 582
viewing facet assignments, 438 assigning to station nodes, 571
instantiating assigning to STB islands, 575
templates, 172 changing EtherNet/IP device properties,
instantiation 590
order when creating instances, 194 changing for explicit messaging with de-
structure of the application, 173 vices, 872, 876
instantiation stage changing Modbus TCP device properties,
completing, 171 590
concept, 45 changing STB islands properties, 575
Interface Editor deploying changes to redundant control-
pane description, 947 lers, 758
presentation, 945 online changes with redundant control-
interface links lers, 818
editing the XML export file, 283 physical connections to Ethernet net-
exporting and importing to XML or CSV, works, 596
255 refreshing engine status and connecting,
interface models 723
types, 37 italic formatting
editing instance properties, 207

EIO0000001114 06/2020 1061

Index

K Links Editor
changing link destinations, 234
keyboard
link validity status, 224
selecting VM default layout, 1028
Links Editor, 218
keyboard shortcuts
presentation, 219
using, 142
using the radar view, 972
using the simplified view, 221
L LL984
updating logical control projects, 844
languages using LL984 language, 92
VM default keyboard layout, 1028 local computers
VM system locale, 1031 pasting data to Participants, 136
layout of function blocks location
after first generation, 452 viewing instance location information, 236
when generating after changes, 491 locked code
when regenerating, 494 code lock feature, 514
LD locked facets
using LD language, 92 skipping facets during generation, 448
libraries locking
viewing in the Global Templates Explorer, Lock command (engineering client), 115
932 locking mechanisms
licensing multiuser functionalities, 83
counting instances, 198 log files
exceeding license instance count, 199 activity log files, 89
Linked Production Assets section logging in
creating links to view instances, 230 to server and clients, 70
linking logging out
changing link destinations, 234 of server and clients, 70
linking instances, 217 logical control projects
Links Editor, 218 updating with online changes, 841
links loops
creating interface links between instanc- generating circular links, 450
es, 227
creating links to view instance information
in RTNS, 230 M
editing the XML export file, 283
M340
exporting and importing to XML or CSV,
creating a control project, 305
255
creating controllers, 556
rules for generating graphical links, 450
creating PRM Profibus DPs, 579
status, 224
M580
creating a control project, 305
Manage Network Variables
saving changes in Manage Network Vari-
ables dialog box, 540

1062 EIO0000001114 06/2020

 Index

managers Modbus serial

platform tools, 43 managing communication, 877
managing Modbus serial devices
control projects, 310 communication mapping, 682
supervision projects, 357 connectivity with supervision, 920
mapping Modbus TCP devices
changing service mappings (control), 628 changing properties, 590
clients (supervision), 680 communication mapping, 682
communication (control), 630 connectivity with supervision, 920
communication (supervision), 682 creating and configuring devices, 584
deleting mapping when updating topolog- exporting, 610
ical templates, 608 import rules, 615
editing exported hardware mappings, 669 importing, 613
exporting hardware mappings, 665 Modbus TCP explicit messaging
hardware, 655 communicating with devices, 867
I/O devices (supervision), 682 managing communication, 867
importing hardware mappings, 674 Modbus TCP implicit messaging
mapping import rules (control), 322 implementing communication, 857
mapping import rules (supervision), 370 implementing communication with devic-
network variable mapping rules, 651 es, 858
network variables, 645, 668 implementing communication with PRMs,
selecting variable mapping positions, 649 862
servers (supervision), 680 implementing communication with STB is-
services (control), 628 lands, 861
services (supervision), 680 implementing peer to peer communica-
to engines (control), 628 tion, 865
Variable Mapping Editor window (control), modules
646 hardware module properties, 565
mapping stage monitoring
completing, 623 Modbus device data from supervision,
concept, 60 920
control projects, 624 monitors
exporting and importing hardware map- floating Participant windows, 134
pings, 664 using dual monitors, 123
supervision projects, 676 moving
memory allocation application folders, 241
when creating I/O scanner lines, 692 changing the position of folders and main-
menus tain hierarchy, 244
common template editor menus, 963 facets, 437
using menus, 133 generated facets, 504
migrating databases instances, 241
code lock feature, 514 moving folders, 188
Modbus explicit messaging moving sections (control), 311
communicating with devices, 878 topological folders, 607
managing communication, 877

EIO0000001114 06/2020 1063

Index

multiple selection networks

selecting multiple items, 121 conflicting Ethernet connections, 597
multiuser connecting a station node to the Ethernet,
working with several clients, 83 601
connecting an STB island to the Ethernet,
603
N connecting controllers to Ethernet net-
naming convention works, 599
Global Templates naming convention, connecting devices to Ethernet networks,
934 602
naming instances connecting entities to an Ethernet net-
hierarchical naming, 208 work, 596
naming rules connecting PRMs to Ethernet networks,
rules for identifiers and variable names, 604
98 creating an Ethernet network, 594
rules for Supervision data, 98 disconnecting a station node from the
navigating Ethernet, 601
inside the Application Browser pane, 183 disconnecting an STB island from the
inside the instance pane, 204 Ethernet, 604
navigating from facets to the instance, disconnecting controllers from Ethernet
441 networks, 600
navigation services disconnecting devices from Ethernet net-
using after restoring systems, 168 works, 602
network addresses disconnecting PRMs from Ethernet net-
generating network addresses for super- works, 605
vision components, 706 import rules, 615
network interface cards physical connection import rules, 616
actions, 570 viewing Ethernet connections, 596
creating, 570 NIC
properties, 571 actions, 570
network redundancy assigning IP addresses, 571
implementing (supervision), 356 creating, 570
network variables properties, 571
address allocation during build, 693 NOC
creating, 541 configuring memory for I/O scanning, 562
description, 527 NOC communication modules
management function rules, 538 configuring HART modules, 591
managing network variables, 538 non-FBD sections
mapping, 645, 668 notification when regenerating, 494
mapping rules, 651 Not Built
modifying, 542 actions changing the build status (con-
properties, 538 trol), 696
selecting variable mapping positions, 649
Variable Mapping Editor window, 646

1064 EIO0000001114 06/2020

 Index

notification panel changes online, 817

abort task icon, 86 updating logical control projects, 841
description, 86 online help
displaying, 115 HTML help for user-created templates,
performance considerations, 88 108
using the help for several versions of tem-
plates, 105
O online refinement
object models importing sections, 829
application templates, 35 online refinement indicator, 552
interface models, 37 OPC Factory Server
topological templates, 36 OFS configuration file description, 705
object templates OPC UA Server Expert
classification, 31 configuration file description, 705
description, 31 OPCUA
elements, 31 configuration file description, 705
references, 31 tag container properties, 396
types, 34 variable tag addresses, 396
objects OPCUA driver
object model overview, 29 citect.ini parameters, 352
OFS communication board properties, 352
configuration file description, 705 OPCUA embedded
OFS configuration file mapping communication, 683
creating, 703 operation clients
deploying, 773 using navigations services after restoring
saving, 678 systems, 168
OFS services operation servers
actions for station nodes, 572 creating in the topology, 566
creating in station node, 567 operator stations
properties for station nodes, 572 creating in the topology, 566
OFSOPC order
tag container properties, 396 changing facet order inside section, 440
OFSOPC driver changing FBD section order, 311
communication board properties, 352 order of sections
OFSOPC/OPCUA configuration files notification when regenerating non-FBD
downloading, 709 sections, 494
online changes Out Of Date
changing the deployed control project, actions changing the build status (con-
816 trol), 696
main redundant configuration scenarios, Out Of Date facets
833 layout of blocks after generation, 491
overview, 809 owner
selecting IP addresses, 818 about network variables, 527
updating control projects after deploying managing network variables, 538
owner and consumer projects, 527, 538

EIO0000001114 06/2020 1065

Index

owner project able (supervision), 775

description, 527 executing with redundant controllers, 793
managing data backup files (control), 335
redeploying to engines (control), 743
P redeploying to engines from executable
P&ID (supervision), 777, 783
instantiation stage, 171 system root folder actions, 303
pages Participant windows
actions, 400 troubleshooting floating window appear-
assigning genie facets, 544 ance, 136
creating supervision pages, 400 Participants
editing, 544 floating Participant windows, 134
properties, 400 opening the Participant help, 104
supervision page import rules, 368 Participant window description, 134
panes pasting data to the local computer, 136
common template editor panes, 969 system locale, 1031
working with panes, 127 VM default keyboard layout, 1028
panning password protection
moving the workspace around, 120 controller properties, 558
parameter pane station node properties, 569
in template editors, 969 system properties, 161
parameters passwords
accessing instance properties, 200 actions that require providing the pass-
conditional font formats, 207 word, 726
configuring instance parameters, 206 changing passwords of project loaded at
hardware module properties, 565 simulator startup, 732
instance configuration, 209 changing the application password of
instance parameter filters, 204 control projects, 730
naming rules, 98 clearing the application password of con-
regional options for instance parameter, trol projects, 731
207 exporting password related information
validating instance parameters, 207 for topological entities, 610
Participant projects importing password related information
creating, 443 for topological entities, 616
deploying changes to station nodes (su- managing passwords of control projects,
pervision), 784 725
deploying controller data to engines (con- password information and settings in sys-
trol), 750 tem backups, 164
deploying from station node (supervision), password information and settings when
778 restoring systems, 166
deploying to engines (control), 736 project loaded at simulator startup, 728
deploying to redundant controllers, 733 resetting a forgotten password, 731
deploying to station nodes from execut- setting the application password of control
projects, 728
verifying password to perform operations,

1066 EIO0000001114 06/2020

 Index

730 pin button

paste command working with panes, 127
aborting, 240 platform components
pasting platform tools, 43
data elements to software Participants, platforms
136 supported hardware platforms, 92
Global Templates and folders, 982 PMEPXM0100 modules
peer to peer integration workflow, 925
communication mapping import rules , ports
322 creating additional communication ports
mapping network variables, 645, 668 (supervision), 353
peer to peer communication export set- creating communication ports (supervi-
tings, 315 sion), 351
peer to peer communication variable im- IO server communication ports, 345
port rules , 326 supervision server communication ports,
peer to peer communication 346
about network variables, 527 positions
address allocation during build, 693 selecting variable mapping positions, 649
client communication channel properties, printing
635 template layouts, 965
communication mapping (control), 630 PRM
configuring the I/O scanner of controllers, actions, 580
562 assigning IP addresses, 582
controller memory size configuration, 558 changing the configuration, 582
creating network variables, 541 changing the PRM configuration, 582
exporting control projects, 312 configuring, 582
implementing, 865 connecting to Ethernet networks, 604
managing network variables, 538 creating PRM Profibus DPs, 579
modifying network variables, 542 creating PRM Profibus Masters, 579
network variable properties, 538 deleting, 583
owner and consumer projects, 527 disconnecting from Ethernet networks,
server communication channel proper- 605
ties, 638 import rules, 615
templates, 527, 538 managing Modbus TCP communication
variable properties, 534 (I/O scanning), 862
peer to peer communication channels properties, 581
actions, 635 representation, 583
adjusting properties, 641 PROFIBUS
creating, 640 connecting to Ethernet networks, 604
moving, 643 creating PRM Profibus DPs, 579
performance creating PRM Profibus Masters, 579
notification panel, 88 disconnecting from Ethernet networks,
OFSOPC driver configuration, 352 605
physical connections managing Modbus TCP communication
physical connection import rules, 616 (I/O scanning), 862

EIO0000001114 06/2020 1067

Index

PROFIBUS remote master and DPs 590

exporting, 610 changing STB islands properties, 575
importing, 613 configuring instance parameters, 206
PROFIBUS slave devices hardware module properties, 565
integrating in systems, 925 I/O devices (supervision), 349
programming languages IO server properties, 345
supported languages, 92 properties of sections, 393
progress indicators supervision client properties, 347
instance color icons, 212 supervision server properties, 346
project color icons, 375 systems, 161
Project Browser Protocol
system root folder actions, 303 tag container attributes, 396
project definition stage Purge command
completing, 297 aborting template purge, 996
concept, 50 purging
control projects, 304 Global Templates library, 995
Project Browser, 299
Project Explorer, 299
supervision projects, 337 Q
Project Explorer Quantum
description, 300 creating a control project, 305
opening, 115 creating controllers, 556
project files creating PRM Profibus DPs, 579
downloading (supervision), 709 quick reference
project settings system engineering life cycle task work-
defining (supervision), 545 flow, 146
setting during build (control), 692 system engineering life cycle tasks, 151
projects quitting
color indicators, 375 clients, 80
generating, 484 quitting the software, 80
generating after changes, 487
types of Participant projects, 51
properties R
accessing instance properties, 200 R/W Rights of Referenced Variable
adjusting peer to peer communication network variables, 538
channel properties, 641 radar view
application folders, 188 description, 972
changing EtherNet/IP device properties, reassigning
590 facets, 503
changing Modbus TCP device properties, reconnect button
connecting to engines, 723
refreshing engine status, 723
Recovery
Recovery folder description, 938

1068 EIO0000001114 06/2020

 Index

redeploying refinement stage

main redundant configuration scenarios, completing, 505
833 concept, 56
to engines (control), 743 control projects, 506
to engines from executable (supervision), supervision project, 543
777, 783 refining
to redundant controllers, 743 advanced supervision project settings,
redundancy 545
implementing (supervision), 354 control projects, 507
redundant alarm servers editing supervision pages, 544
implementing alarm server redundancy, managing device DDT variables, 517
356 supervision projects, 543
redundant controllers validity indicators, 511
backing up controller data, 823 ReGenerate command
connecting to Ethernet networks, 597 aborting regeneration of projects and sec-
deploying changes to (control), 735 tions, 494
deploying controller data, 750 regenerating
identifying, 556 configurable settings (control), 454
physical connection import rules, 616 control project sections, 495
synchronizing, 804 control projects, 493
redundant I/O servers entire control projects, 495
implementing I/O server redundancy, 355 FBD section size, 494
redundant networks function block layout after changes, 494
implementing network redundancy (su- functionality description, 493
pervision), 356 importing sections after regeneration, 487
redundant report servers removing types, 493
implementing report server redundancy, regenerating non-FBD sections
356 notification when regenerating, 494
redundant trend servers regional options
implementing trend server redundancy, instance parameters, 207
356 release notes
references viewing platform and library release
definition, 31 notes, 117
missing references in Recovery folder, relinking
938 facets, 504
refine online removing
main redundant configuration scenarios, removing generated types, 453
833 removing types when regenerating, 493
overview, 809 renaming
with redundant controllers, 793 Global Templates, 979
refinement Replace dialog box
consistency management (control), 523 description, 1017
refining locked code, 514 Replace Template
command description, 245

EIO0000001114 06/2020 1069

Index

replacing S
replacing templates of elements, 1006
S88
template of instances, 245
assigning icons to folders, 193
templates with new type version, 252
modeling the equipment hierarchy, 173
replacing templates
saving
validating instance identifier uniqueness,
backing up controller data, 823
252
changes in Manage Network Variables di-
report server redundancy
alog box, 540
implementing, 356
Global Templates, 979
reservation
saving templates
redundant configuration reservation sce-
tracking changes in the changes log, 979
narios, 836
sbk file
Resolve Uniqueness Conflicts
exporting templates, 983
dialog box description, 294
searching
restarting
application instances and folders, 175
restarting clients that closed unexpected-
instances, 181
ly, 79
template search, 177
restore
section layout
impact on system names in database,
configurable settings (control), 454
168
section size
password information and settings when
configurable settings (control), 454
restoring systems, 166
sections
restore command
actions, 392, 392
aborting, 167
changing execution order, 311
restoring
creating and managing, 384
deployed Participant project from execut-
creating FBD and non-FBD sections, 309
able (supervision), 777
creating FBD sections, 392
deployed Participant project from station
deleting FBD sections during update Con-
node (supervision), 783
trol project, 850
restoring systems, 166
import rules for program sections, 320
rollback
importing during online refinement, 829
rolling back generation, 450
inserting FBD sections, 392
RTNS
moving sections (control), 311
creating links to view instance informa-
properties, 393
tion, 230
tree view description in Containers pane,
rules
429
truncation rules for equipment (supervi-
tree view when refining Control projects,
sion), 496
510
run
tree view when refining Control projects
starting controllers and simulators (con-
online, 818
trol), 796
security services
runtime navigation services
system properties, 161
creating links to view instance informa-
selecting
tion, 230
selecting multiple items, 121
using after restoring systems, 168

1070 EIO0000001114 06/2020

 Index

server simulator
connection to clients, 75 backing up controller data, 823
starting again, 74 changing passwords of projects loaded at
stopping, 81 startup, 732
servers changing the default project loaded at
creating servers (supervision), 345 startup, 721
IO server properties, 345 deploying built control projects, 736
supervision server communication ports, deploying changes (control), 757
346 deploying controller data (control), 750
supervision server properties, 346 managing data backup files (control), 335
service mapping mapping hardware, 656
changing (control), 628 obtaining the IP address, 722
services redeploying built control projects, 743
generating network addresses, 706 setting passwords of project loaded at
session overcrowded simulator startup, 728
troubleshooting, 499 starting, 720
sessions starting without loading a password-pro-
restarting clients that closed unexpected- tected project, 721
ly, 79 simulator software
settings deploying to, 720
configuring generation settings (control), installing, 720
454 starting and stopping, 796
Settings skipping
control project settings, 308 skipping facets during generation, 448
supervision project settings, 308 software Participants
Settings pane floating Participant windows, 134
changing application folder icons, 193 pasting data to the local computer, 136
Settings window window description, 134
Systems Explorer, 162 sorting
SFC sorting data, 138
using SFC language, 92 ST
shortcuts using ST language, 92
keyboard shortcuts, 142 STA
signature mismatch changing the default project loaded at
actions that require providing the pass- startup, 721
word, 726 starting the simulator without password
controller data backup, 827 protection, 721
controller data deployment, 753
deployment stage, 757
execution stage, 791
simplified view
Links Editors, 221
template editors, 973

EIO0000001114 06/2020 1071

Index

stages status
assignment stage concept, 53 editing instance properties, 207
assignment stage implementation, 383 instance data validity status, 205
build stage concept, 62 link validity, 224
build stage implementation, 687 refreshing engine status, 723
concept, 40 status of supervision executables
configuration stage concept, 58 status change when importing new con-
configuration stage implementation, 549 tent version, 992
deployment stage concept, 64 STB islands
deployment stage implementation, 713 actions, 574
execution stage concept, 65 assigning IP addresses, 575
execution stage implementation, 787 changing properties, 575
generation stage concept, 55 changing the configuration, 576
generation stage implementation, 443 configuring, 576
Global Templates definition stage con- connecting to Ethernet networks, 603
cept, 44 creating, 573
instantiation stage concept, 45 deleting, 578
instantiation stage implementation, 171 disconnecting from Ethernet networks,
mapping stage concept, 60 604
mapping stage implementation, 623 exporting, 610
project definition stage concept, 50 importing, 613
project definition stage implementation, managing Modbus TCP communication
297 (I/O scanning), 861
refinement stage concept, 56 mapping (control), 628
refinement stage implementation, 505 mapping hardware, 655, 655
task quick reference, 151 properties, 575
starting representation, 577
controllers and simulators (control), 796 stop
emulated simulator, 720 changes requiring to stop the controller,
simulator, 720 771
system server, 74 stopping
station nodes controllers and simulators (control), 796
actions, 567 system server, 81
backing up controller data, 823 structure of the application
connecting to Ethernet networks, 601 instantiation stage, 173
creating, 566 STU files
disconnecting from Ethernet networks, changing (control), 696
601 creating (control), 689
exporting, 610 supervision
import rules, 615 connectivity with Modbus devices, 920
importing, 613 supervision architecture
mapping to emulated simulators (control), description of tasks, 338
628 supervision clients
properties, 569 properties, 347
selecting templates, 555

1072 EIO0000001114 06/2020

 Index

supervision data node, 783

naming rules, 98 service mapping import rules , 370
supervision pages task quick reference, 151
actions, 400 task workflow, 146
creating pages, 400 supervision servers
properties, 400 properties, 346
Supervision Project Browser Supervision service
description, 302 creating in station node, 567
supervision projects supervision services
actions, 339 actions for station nodes, 572
building, 703 properties for station nodes, 572
changing built Participant projects, 710 support
communication mapping import rules , support contact details, 117
370 symbol table files
creating, 339 generating symbol table files, 719
creating client, 347 synchronization
creating components, 343 timeout when refining online, 795
creating I/O devices, 348 synchronizing
creating servers, 345 description, 793
deploying, 773 redundant controllers, 804
equipment import rules , 368 timeout, 804
executable import rules , 370 when deploying changes (control), 735
executing, 854 system
export settings, 360 description, 41
exporting, 358 system backup
facet import rules , 368 password information and settings, 164
generating after changes, 488 system engineering life cycle
hardware mapping import rules , 370 concept, 40
implementing redundancy, 354 graphical representation, 41
import settings, 363 platform components, 43
importing, 363 task quick reference, 151
managing, 357 task workflow, 146
mapping stage, 676 system folders
page import rules , 368 actions, 159
project definition, 337 creating, 159
Project Explorer and Browser, 299 system locale
project import window, 370 selecting, 1031
properties, 342 system names
refining, 543 impact of system restoration, 168
related project data import rules , 367 system restore
restoring after deploying from executable, password information and settings, 166
777 system server
restoring after deploying from station logging in and out, 70

EIO0000001114 06/2020 1073

Index

systems ed objects, 367

actions, 160 importing, 987
backing up, 163 instances of templates, 38
creating, 160 instantiating, 172
description, 29 managing, 978
engineering, 143 modification strategy, 999
organizing, 158 naming convention, 934
properties, 161 purging the Global Templates library, 995
restoring, 166 renaming Global Templates, 979
Systems Explorer replacing templates of elements, 1006
opening, 115 saving changes in Global Templates, 979
presentation, 158 selecting, 177
selecting topological templates, 555
templates Import Editor, 987
T terminology, 32
tabs bar updating Global Templates, 1001
description, 119 using the HTML help for several versions
tag containers of templates, 105
actions, 395 Templates Browser
creating tag containers, 394 browsing templates, 177
properties, 396 templates of instances
templates replacing, 245
copying and pasting Global Templates, updating, 245
982 templates of the topology
creating Global Template folders, 939 updating, 608
description, 31 temporary files
duplicating Global Templates, 1013 content repository, 1026
exporting, 983 terminology
Global Template editors, 944 for template components, 32
Global Templates actions, 940 terminology used in this manual, 21
Global Templates description, 940 timeout
Global Templates Explorer, 932 synchronizing standby controllers, 804
HTML help for user-created templates, when synchronizing online changes, 795
108 toolbars
import rules for control project-related ob- common template editor toolbars, 963
jects, 319 description, 115
import rules for supervision project-relat- engineering client UI description, 114
Toolbox
Global Templates Explorer, 936
topological entities
import rules, 615
physical connection import rules, 616
topological entity folders
description, 552

1074 EIO0000001114 06/2020

 Index

topological entity identifiers tree view in control projects

naming rules, 98 description, 429
topological folders when refining, 510
import rules, 615 when refining online, 818
topological templates trend server redundancy
introduction, 36 implementing, 356
subtypes, 36 troubleshooting
topology floating Participant window appearance,
configuration stage, 549 136
creating, 550 generation diagnostic messages, 499
exporting, 610 truncation
import rules for control project-related ob- rules for equipment (supervision), 496
jects, 319 type versions
import rules for supervision project-relat- changing type versions during generation
ed objects, 367 (control), 456
importing, 613 replacing templates with new type ver-
managing, 606 sion, 252
selecting topological templates, 555 updating templates with new type version,
supported components, 550 252
updating templates, 608 types
Topology Explorer removing generated types, 453
opening, 115 removing when regenerating, 493
presentation, 551
topology folders
actions, 553 U
creating, 552 unassigned facets
properties, 554 reassigning, 503
tracking changes unassigning
template changes log, 979 facets, 436
transferring generated facets, 503
deploying changes to station nodes (su- unlinked facets
pervision), 784 relinking, 504
deploying from station node (supervision), unlinking
778 facets, 503
deploying to station nodes from execut- unmap
able (supervision), 775 unmapping hardware mappings, 661
redeploying to engines from executable unmapping
(supervision), 777, 783 unmapping communication channels, 642
synchronizing redundant controllers, 804 Update Control Project command
tree view aborting, 852
viewing the application structure in control Update Template
projects, 389 command description, 245
updating
control projects after deploying changes

EIO0000001114 06/2020 1075

Index

online, 817 variable mappings

Global Templates, 1001 peer to peer communication variable im-
linked application templates, 251 port rules , 326
logical control projects, 841 variable name conflict
template modification strategy, 999 troubleshooting, 499
template of instances, 245 variable tag addresses
templates of elements, 1001 OPCUA embedded protocol, 705
templates with new type version, 252 variables
topological templates, 608 about network variables, 527
updating control projects address allocation during build, 693
checking consistency, 849 managing network variables, 538
deleting FBD sections during update Con- naming rules, 98
trol project, 850 properties, 534
with redundant controllers, 793 when updating Control projects, 845
user authentication version conflict
OPC UA configuration files, 705 canceling generation for version conflict
User Contents folder (control), 450
location in the content repository, 1022 troubleshooting, 499
user files versions
redeploying from executable after remov- changing type versions during generation
ing user files (supervision), 777, 783 (control), 456
user interface virtual machine
engineering client, 113 system locale, 1031
engineering client UI description, 114 VM default keyboard layout, 1028
engineering client work areas, 118
user-created templates
HTML help for user-created templates, W
108 windows
users floating Participant windows, 134
activity log files, 89 Participant window description, 134
logging in to server and clients, 70 pasting data to Participants, 136
working with several clients, 83 viewing on separate monitors, 123
work areas
creating additional work areas, 123
V creating work areas in explorers, 125
validity indicators description, 118
analyzing control projects during genera- organizing, 122
tion, 449 workflow
description, 691 task workflow to implement communica-
instance color icons, 212 tion, 146
project color icons, 375 workspace
refining control Participant projects, 511 changing the zoom level, 121
Variable Mapping Editor zooming in and out, 121
description, 646
usage example, 650

1076 EIO0000001114 06/2020

 Index

workspaces
moving the workspace around, 120
selecting items, 121
working with panes, 127

X
X509 user token
OPC UA configuration files, 705
XML
application export file description, 275
editing the application export file, 277
editing to manage application links, 283
exporting and importing application ob-
jects to XML or CSV, 255
importing XML files into the application,
287
XVM files
generating symbol table files, 719

Z
zooming
magnifying and reducing the workspace
view, 121
using the radar view, 972
zooming out
simplified view in template editors, 973
simplified view in the Links Editor, 221

EIO0000001114 06/2020 1077

Index

1078 EIO0000001114 06/2020