Process Expert

EIO0000001114 05/2017

Process Expert
User Guide
06/2017
EIO0000001114.09

[Link]
 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.
© 2017 Schneider Electric. All Rights Reserved.

2 EIO0000001309 06/2017
 Table of Contents

Safety Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Part I Understanding Process Expert . . . . . . . . . . . . . . . . . 19
Chapter 1 General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Latest Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Terminology Used in This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Chapter 2 Presentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
2.1 PlantStruxure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Introducing PlantStruxure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
2.2 Process Expert System (PES). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Introducing PES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
2.3 Process Expert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Introducing Process Expert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Collaborative Software Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
2.4 Process Expert Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Process Expert Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Chapter 3 General Concepts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
3.1 Object Model Concept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Object Based Engineering. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Object Template Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Application Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Topological Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Interface Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Instances of Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
3.2 System Engineering Life Cycle Concept . . . . . . . . . . . . . . . . . . . . . . . 51
The System Engineering Life Cycle . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Platform Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Global Templates Definition Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Instantiation Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Project Definition Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Assignment Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Generation Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Refinement Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Configuration Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

EIO0000001309 06/2017 3
 Mapping Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Build Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Deployment Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Execution Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Part II Working With Process Expert . . . . . . . . . . . . . . . . . 79
Chapter 4 Starting and Quitting Process Expert . . . . . . . . . . . . . . . . 81
Logging In and Out of Clients. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Starting the System Server Again . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Client/Server Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Quitting Process Expert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Chapter 5 Multiuser Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Multiuser Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Chapter 6 Action Traceability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Notification Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Activity Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Chapter 7 Capabilities of Process Expert . . . . . . . . . . . . . . . . . . . . . 99
Hardware and Software Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Supported Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Naming Rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Chapter 8 Using the Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Software Participant Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Using Help for Different Versions of Schneider Electric Templates . . . 113
Help on User-Created Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Chapter 9 User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Engineering Client User Interface Description . . . . . . . . . . . . . . . . . . . 122
Engineering Client Workspace Description . . . . . . . . . . . . . . . . . . . . . 129
Working with Panes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Using Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Software Participant Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Filtering and Sorting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Chapter 10 Folders and Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Folder Representation and Structure . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Common Folder Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Changing the Folder Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Assigning Icons to Application Folders . . . . . . . . . . . . . . . . . . . . . . . . 156

4 EIO0000001309 06/2017
 Part III Implementing a System with Process Expert . . . . . . 159
Chapter 11 Quick Reference Guides. . . . . . . . . . . . . . . . . . . . . . . . . 161
System Creation Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Task Quick Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Chapter 12 Managing Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Organizing Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Creating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Creating System Backups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Restoring Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Chapter 13 Instantiation Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
13.1 Instantiating Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Organizing the System Application . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Application Explorer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Browsing Application Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Using the Application Browser Pane . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Creating Application Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Creating Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Counting Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Accessing Instance Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Configuring Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Linking Instances. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
13.2 Managing Application Folders and Instances . . . . . . . . . . . . . . . . . . . 232
Inspect Instance Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Changing the Application Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Copying and Pasting Application Folders and Instances . . . . . . . . . . 236
Moving Application Folders and Instances . . . . . . . . . . . . . . . . . . . . . 238
Exporting Folders and Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Modifying the Export File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Importing Folders and Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Updating and Replacing Templates of Instances . . . . . . . . . . . . . . . . 258
Chapter 14 Project Definition Stage . . . . . . . . . . . . . . . . . . . . . . . . . 269
14.1 Control Project Definition Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Creating a Control Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Creating Control Project Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

EIO0000001309 06/2017 5
 14.2 Managing Control Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Control Project Section Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Exporting a Control Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Importing a Control Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Importing a Unity Pro Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Managing Data Backup Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
14.3 Supervision Project Definition Stage . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Internal Supervision Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Creating a Supervision Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
14.4 Creating Supervision Project Components . . . . . . . . . . . . . . . . . . . . . 316
Creating Supervision Tag Containers . . . . . . . . . . . . . . . . . . . . . . . . . 317
Creating Supervision Pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Creating Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Creating Supervision Servers and Clients . . . . . . . . . . . . . . . . . . . . . . 327
Creating I/O Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Creating Communication Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Implementing Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
14.5 Managing Supervision Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Exporting a Supervision Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Importing a Supervision Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Chapter 15 Assignment Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
15.1 Assigning Facets of Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Assignment Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Assigning Control Facets of Instances. . . . . . . . . . . . . . . . . . . . . . . . . 365
Assigning Supervision Facets of Instances . . . . . . . . . . . . . . . . . . . . . 367
Assigned Facet Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Automatic Facet Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Viewing the Application Structure in Control Projects . . . . . . . . . . . . . 376
15.2 Managing Assigned Facets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Facet Actions After Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Viewing Facet Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Navigating to the Assignment Editor . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Navigating to Project Containers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
Order of Control Facets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Navigating from Facets to the Instance . . . . . . . . . . . . . . . . . . . . . . . . 396

6 EIO0000001309 06/2017
 Chapter 16 Generation Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
16.1 General Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
Generation Process Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Control Project Specifics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Selecting Versions of Types in Control Facets During Generation . . . 413
Statuses of Facets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
16.2 Generating a Project for the First Time . . . . . . . . . . . . . . . . . . . . . . . . 441
Generating Entire Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442
Generating Sections and Containers. . . . . . . . . . . . . . . . . . . . . . . . . . 443
16.3 Generating Projects After Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . 445
Generating Control or Supervision Projects After Changes . . . . . . . . 446
Regenerating a Control Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
16.4 Generating the Equipment Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . 455
Generating the Equipment Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . 455
16.5 Generation Diagnostic Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Generation Diagnostic Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
16.6 Managing Generated Facets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Managing Generated Facets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Chapter 17 Refinement Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
17.1 Control Project Refinement Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Refining the Logical Control Project . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Managing Consistency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
About Variables for Peer to Peer Communication . . . . . . . . . . . . . . . . 476
Managing Network Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
17.2 Supervision Project Refinement Stage . . . . . . . . . . . . . . . . . . . . . . . . 492
Refining the Supervision Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
Chapter 18 Configuration Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
18.1 Creating the Topology of the System . . . . . . . . . . . . . . . . . . . . . . . . . 498
Organizing the System Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
Selecting Topological Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
Configuring a Controller. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Configuring a Station Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
Configuring an STB Island. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
Configuring a PROFIBUS Remote Master and Decentralized
Peripherals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527

EIO0000001309 06/2017 7
 Configuring Modbus TCP and Ethernet IP Devices . . . . . . . . . . . . . . . 532
Configuring HART Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
Configuring an Ethernet Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Connecting to an Ethernet Network . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
18.2 Managing the Topology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
Moving Topological Folders and Entities . . . . . . . . . . . . . . . . . . . . . . . 554
Updating Templates of Topological Entities. . . . . . . . . . . . . . . . . . . . . 555
Exporting Topological Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
Importing Topological Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Chapter 19 Mapping Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
19.1 Control Project Mapping Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Creating Control Project Executables . . . . . . . . . . . . . . . . . . . . . . . . . 573
Mapping Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Mapping Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
Mapping Network Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Mapping Hardware. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
19.2 Supervision Project Mapping Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Creating Supervision Project Executables . . . . . . . . . . . . . . . . . . . . . . 612
Mapping Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Mapping Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
Chapter 20 Build Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
20.1 Control Project Build Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Building the Logical Control Participant Project . . . . . . . . . . . . . . . . . . 623
Changing the Built Control Participant Project . . . . . . . . . . . . . . . . . . . 630
Managing Hardware Abstraction Layer (HAL) Variables and DFBs . . 633
20.2 Supervision Participant Project Build Stage. . . . . . . . . . . . . . . . . . . . . 637
Building the Supervision Participant Project . . . . . . . . . . . . . . . . . . . . 638
Changing the Built Supervision Participant Project . . . . . . . . . . . . . . . 642
Chapter 21 Deployment Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
21.1 Control Project Deployment Stage. . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
Control Participant Project Deployment Process . . . . . . . . . . . . . . . . . 645
Deploying to an Emulated Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . 649
Communication Between the Computer and Engines . . . . . . . . . . . . . 653
Managing Passwords of Control Participant Projects . . . . . . . . . . . . . 655
Deploying to Redundant Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Deploying the Control Participant Project . . . . . . . . . . . . . . . . . . . . . . 665

8 EIO0000001309 06/2017
 Re-Deploying the Control Participant Project . . . . . . . . . . . . . . . . . . . 672
Deploying Data to Controllers and Station Nodes . . . . . . . . . . . . . . . . 679
Deploying Control Project Changes . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Changes Requiring to Stop the Controller . . . . . . . . . . . . . . . . . . . . . . 697
21.2 Supervision Project Deployment Stage . . . . . . . . . . . . . . . . . . . . . . . . 699
Preparing for Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 700
Deploying the Built Supervision Participant Project from the Executable 701
Deploying the Built Supervision Participant Project from the Station
Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
Chapter 22 Execution Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 711
22.1 Control Project Execution Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
Control Participant Project Execution Process . . . . . . . . . . . . . . . . . . 713
Execution With Redundant Controllers . . . . . . . . . . . . . . . . . . . . . . . . 717
Starting and Stopping Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
Synchronizing Redundant Controllers . . . . . . . . . . . . . . . . . . . . . . . . . 729
About Changes Made Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 734
Making Changes Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 741
Backing Up Controller Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748
Importing Sections from the Logical Control Participant Project . . . . . 754
Main Redundant Controller Scenarios. . . . . . . . . . . . . . . . . . . . . . . . . 758
Redundant Controller Reservation and Connection Scenarios . . . . . . 761
Updating the Logical Control Participant Project . . . . . . . . . . . . . . . . . 766
22.2 Supervision Project Execution Stage . . . . . . . . . . . . . . . . . . . . . . . . . 778
Executing the Deployed Supervision Participant Project. . . . . . . . . . . 778
Chapter 23 Managing Communication . . . . . . . . . . . . . . . . . . . . . . . 779
23.1 Communication Through Modbus TCP Ethernet Implicit Messaging
(I/O Scanning) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 781
Communicating with Devices Through Modbus TCP Implicit
Messaging (I/O Scanning) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
Communicating with STB Islands Through Modbus TCP Implicit
Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
Communicating with PROFIBUS Remote Masters Through Modbus
TCP Implicit Messaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
Peer to Peer Communication Through Modbus TCP Ethernet Implicit
Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
23.2 Communication by Using Modbus TCP Ethernet Explicit Messaging . 791
Communication with Devices by Using Modbus TCP Ethernet Explicit
Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791
23.3 Communication by Using Ethernet IP Explicit Messaging . . . . . . . . . . 797
Communication with Devices by Using Ethernet IP Explicit Messaging 797

EIO0000001309 06/2017 9
 23.4 Communication Through Modbus Explicit Messaging . . . . . . . . . . . . . 801
Communication with Devices Through Modbus Explicit Messaging . . 802
Example Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 809
Example A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 815
Example B . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
Example C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
Example D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
23.5 Monitoring Modbus Device Data Directly from Supervision . . . . . . . . . 845
Monitoring Modbus Device Data Directly from Supervision . . . . . . . . . 845
Part IV Global Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . 851
Chapter 24 Global Templates Library . . . . . . . . . . . . . . . . . . . . . . . . . 853
Global Templates Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
Global Templates Explorer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 858
Global Templates Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
Global Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
Chapter 25 Global Templates Editors . . . . . . . . . . . . . . . . . . . . . . . . . 867
25.1 Accessing Global Templates Editors . . . . . . . . . . . . . . . . . . . . . . . . . . 868
Opening Global Templates Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . 868
25.2 Interface Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 870
Interface Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 870
25.3 Facet and Composite Template Editors. . . . . . . . . . . . . . . . . . . . . . . . 878
Facet Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
Composite Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
25.4 Common Template Editor Components. . . . . . . . . . . . . . . . . . . . . . . . 887
Common Template Editor Toolbars and Menus . . . . . . . . . . . . . . . . . 888
Common Template Editor Panes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
Chapter 26 Managing Global Templates . . . . . . . . . . . . . . . . . . . . . . 897
26.1 Managing Global Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
Saving Changes In Global Templates . . . . . . . . . . . . . . . . . . . . . . . . . 899
Copying and Pasting Global Templates and Folders. . . . . . . . . . . . . . 903
Exporting Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
Importing Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908
Purging the Global Templates Library . . . . . . . . . . . . . . . . . . . . . . . . . 916
26.2 Updating and Replacing Global Templates . . . . . . . . . . . . . . . . . . . . . 919
Template Update Strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
Updating Global Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
Replacing the Template of an Element of a Global Template . . . . . . . 929

10 EIO0000001309 06/2017
 Part V Process Expert Services. . . . . . . . . . . . . . . . . . . . . . 939
Chapter 27 Process Expert Content Repository . . . . . . . . . . . . . . . . 941
Content Repository Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
Temporary Contents Repository Files . . . . . . . . . . . . . . . . . . . . . . . . . 946
Chapter 28 Language Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
Default Keyboard Layout of the Virtual Machine . . . . . . . . . . . . . . . . . 948
Virtual Machine System Locale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
Glossary ......................................... 955
Index ......................................... 967

EIO0000001309 06/2017 11
12 EIO0000001309 06/2017
 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.

EIO0000001309 06/2017 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 EIO0000001309 06/2017
 About the Book

At a Glance

Document Scope
This manual contains general information about Process Expert and guides you through the
stages to implement a system.
This manual is organized in five main parts:
 Understanding 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 Process Expert:
Describes the graphical user interface and how to use the different tools that are at your
disposal.
 Implementing a system with Process Expert:
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 it contains, and the editors that allow you
to manage them.
 Process Expert services:
Provides information on the contents 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 Process Expert 4.3 or later. It supersedes any previous version.

Related Documents

Title of documentation Reference number

Process Expert - Process Templates User Guide EIO0000000987 (eng)
Process Expert - Device Templates User Guide EIO0000001308 (eng)
Process Expert - Communication Templates User Guide EIO0000001311 (eng)
Process Expert - Diagnostic Templates User Guide EIO0000001526 (eng)
Process Expert - Foundation Application Templates User Guide EIO0000002403 (eng)
Process Expert - Control Participant Services User Guide EIO0000001524 (eng)

EIO0000001309 06/2017 15
 Title of documentation Reference number
Process Expert - Supervision Participant Services User Guide EIO0000001525 (eng)
Process Expert - Runtime Navigation Services User Guide EIO0000001574 (eng)
Process Expert - Global Templates Reference Manual EIO0000001986 (eng)
Process Expert - Installation and Configuration Guide EIO0000001255 (eng)
Process Expert - Licensing Guide EIO0000001261 (eng)

You can download these technical publications at [Link], PES

Document Downloads section.
Registration required.

PES Support Portal

Visit [Link] for support, software updates, and latest information on
Process Expert.
Registration required.

Trademarks
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.

Product Related Information

Process Expert clients authenticate users against Microsoft® Windows® Active Directory®
domain services or the Windows® user database of the local computer. The system server does
not manage user rights.

WARNING
UNINTENDED EQUIPMENT OPERATION
 Allow only authorized personnel with expertise in the design and operation of control systems
to program, install, alter, and apply this product.
 Follow local and national safety codes and standards.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

The examples in this manual are given for information only.

16 EIO0000001309 06/2017
 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.

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.

EIO0000001309 06/2017 17
18 EIO0000001309 06/2017
 Process Expert
Understanding Process Expert
EIO0000001114 05/2017

Part I
Understanding Process Expert

Understanding Process Expert

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

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
1 General Information 21
2 Presentation 25
3 General Concepts 35

EIO0000001309 06/2017 19
Understanding Process Expert

20 EIO0000001309 06/2017
 Process Expert
General Information
EIO0000001114 05/2017

Chapter 1
General Information

General Information

Overview
This chapter provides general information on Process Expert.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Latest Information 22
Terminology Used in This Manual 23

EIO0000001309 06/2017 21
General Information

Latest Information

Release Notes
For latest information on Process Expert, refer to the release notes of the platform.
The file is located at the path:
 for 32 bit operating systems: C:\Program Files
\Schneider Electric\StruxureWare\Process Expert
 for 64 bit operating systems:
C:\Program Files (x86)\Schneider Electric\StruxureWare\Process Expert

22 EIO0000001309 06/2017
 General Information

Terminology Used in This Manual

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

User Interface Items

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

EIO0000001309 06/2017 23
General Information

24 EIO0000001309 06/2017
 Process Expert
Presentation
EIO0000001114 05/2017

Chapter 2
Presentation

Presentation

Overview
This chapter presents the PlantStruxureTM system and the position that Process Expert holds
within this offer. It also describes the features and architecture of the software.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
2.1 PlantStruxure 26
2.2 Process Expert System (PES) 28
2.3 Process Expert 29
2.4 Process Expert Architecture 33

EIO0000001309 06/2017 25
Presentation

Section 2.1
PlantStruxure

PlantStruxure

Introducing PlantStruxure

Overview
As the Schneider Electric automation system offer for industrial and infrastructure customers,
PlantStruxure integrates a wide range of hardware, software, and services to provide maximum
flexibility and openness.
Faced with the constraints of today’s challenging global economical environment, companies are
in constant need of more and more efficient means of production.
PlantStruxure helps you optimize the productivity of your plant by:
 Reducing engineering, operation, and maintenance costs.
 Enabling intelligent energy management.
 Improving plant and production efficiency.
 Maintaining the expected quality of the production.
 Increasing the return on investment.

With PlantStruxure as a collaborative system, Schneider Electric provides solutions ranging from
field devices at the plant floor level up to systems at the enterprise level:

ERP Enterprise Resource Planning

MES Manufacturing Execution System

26 EIO0000001309 06/2017
 Presentation

PlantStruxure Architectures
With PlantStruxure, various combinations of architectures can be created. From simple ones, such
as SCADA supervising a set of controllers, to more complex ones consisting of several areas
linked together on a single or on multiple networks.
The following figure shows an example of architectures where the different areas are outlined:

EIO0000001309 06/2017 27
Presentation

Section 2.2
Process Expert System (PES)

Process Expert System (PES)

Introducing PES

Overview
As part of PlantStruxure, the innovative Process Expert System (PES) offers:
 Integrated software environment for the engineering, operation, and maintenance of automation
systems.
 Preferred integrated architectures, tested, validated, and documented.
 Extensive generic and application-specific libraries.
 Advanced life cycle functions.
 Intelligent energy management.

28 EIO0000001309 06/2017
 Presentation

Section 2.3
Process Expert

Process Expert

Overview
This section introduces the Process Expert software platform and describes its main distinctive
features.

What Is in This Section?

This section contains the following topics:
Topic Page
Introducing Process Expert 30
Collaborative Software Platform 32

EIO0000001309 06/2017 29
Presentation

Introducing Process Expert

Overview
As part of PES, Process Expert is a collaborative software, which is used for the configuration,
control, operation, commissioning, and maintenance of systems.
In the context of Process Expert, a system represents an actual automation system.
It is a single environment, which simplifies design, management, and maintenance of automation
systems by:
 Accelerating the automation system configuration.
 Reducing the engineering effort and time.
 Improving project consistency.

It helps you achieve these objectives by delivering the following features:

 A collaborative system engineering software platform.
 A library of Schneider Electric templates.
 Management of communication among controllers, and between controllers and devices
connected to field buses.
 Engineering data exchange.
 Emulation of control and supervision.
 Automation system operation and maintenance.
 Easy navigation inside an automation system for fast diagnosis through identification of
detected errors or access to documentation.
Process Expert clients authenticate users against Microsoft® Windows® Active Directory®
domain services or the Windows user database of the local PC. The Process Expert system server
does not require a login.

WARNING
UNINTENDED EQUIPMENT OPERATION
 Allow only authorized personnel with expertise in the design and operation of control systems
to program, install, alter, and apply this product.
 Follow local and national safety codes and standards.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

30 EIO0000001309 06/2017
 Presentation

WARNING
UNINTENDED EQUIPMENT OPERATION
When engineering automation systems using 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.

Use Process Expert to complete the stages of the system engineering workflow to implement the
entire system.

EIO0000001309 06/2017 31
Presentation

Collaborative Software Platform

Participants In Process Expert

To manage the entire engineering workflow for implementing systems, the Process Expert
platform integrates software tools, which are called Participants (see page 111):
 A Control Participant: A set of editors and services that allow you to configure controllers, and
refine and troubleshoot Control projects of systems.
 A Supervision Participant: A supervisory control and data acquisition (SCADA) solution that
allows you to manage and monitor processes. It comprises editors to refine and configure
Supervision projects as well as a graphics builder to design the operation environment and to
provide operators with interfaces to interact with the process.
The following figure illustrates the collaborative architecture of the Process Expert software
platform:

1 Ready for other Schneider Electric Participants such as Historian, for example
2 Future developments may include the integration of third-party software tools

Template Libraries
Process Expert software also uses libraries of templates, which allow you to model the automation
system:
 A generic library: An integrated library (see page 854) that includes a wide range of templates
allowing to model standard process equipment as well as a selection of Schneider Electric
hardware platforms, and devices to implement most process control applications.
 Application-specific libraries: Optional libraries that include templates allowing to model
equipment of specific applications (for example, mining, water treatment...) to implement the
corresponding control applications.

32 EIO0000001309 06/2017
 Presentation

Section 2.4
Process Expert Architecture

Process Expert Architecture

Process Expert Architecture

Description
Process Expert uses a client/server architecture.
For detailed information, refer to Process Expert Infrastructure (see Process Expert, Installation
and Configuration Guide).

EIO0000001309 06/2017 33
Presentation

34 EIO0000001309 06/2017
 Process Expert
General Concepts
EIO0000001114 05/2017

Chapter 3
General Concepts

General Concepts

Overview
This chapter describes the object model concept and how it is applied within Process Expert. 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 36
3.2 System Engineering Life Cycle Concept 51

EIO0000001309 06/2017 35
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 with Process Expert.

What Is in This Section?

This section contains the following topics:
Topic Page
Object Based Engineering 37
Object Template Description 39
Application Templates 43
Topological Templates 47
Interface Models 48
Instances of Templates 49

36 EIO0000001309 06/2017
 General Concepts

Object Based Engineering

Description of the System

In Process Expert a system is the representation of a physical automation system and is defined
through 3 independent parts:
 the application: Defines the functions of the system and the corresponding process hierarchy
 Projects: Define the Participant projects that implement the functions of the system:
 Control Projects
 Supervision Projects

 the topology: Defines the hardware and software infrastructure of the system
 controllers
 Devices connected to field buses
 networks
 station nodes (their hardware and software components)

Concept of Object Model

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 a pipe and
tank network.
 Device objects representing, for example, the functions to control a process object such as a
motor through a drive.
 Communication objects representing, for example, the functions to manage communication with
device objects through the port of a Quantum controller through 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 a Quantum 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.

EIO0000001309 06/2017 37
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 to model conveyors and similar items (such as a
mixer) in different systems:

38 EIO0000001309 06/2017
 General Concepts

Object Template Description

Introduction
Object templates created from object models are called Global Templates and are stored in the
Global Templates library. They are visible and can be used in any system created with
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 Process Expert
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 function of the real world. Therefore, the distinction is made between 3 types of
templates:
 Facet templates: They are the smallest templates available. They encapsulate a constituent,
which is provided by a specific Participant and provide the respective service. As such there are:
 Control facet templates providing Control services. For example, the service provided by the
$DEVCTL_UL facet template is the motor management functions implemented through the
DEVCTL function block, which is encapsulated inside the template.
 Supervision facet templates, providing Supervision services. For example, the service
provided by the $HLMOTOR_CG genie facet template is the graphical representation of a
motor and its faceplate on the operator user interface, which are encapsulated inside the
template.
 Composite templates: They consist of 1 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 Control 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.

EIO0000001309 06/2017 39
General Concepts

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 2 facet templates:

- - - Represents interface links

Template Terminology
The following figure is the graphical representation of a generic composite template:

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

40 EIO0000001309 06/2017
 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 Process Expert 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 composite 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 Tag and Genie
respectively.

EIO0000001309 06/2017 41
General Concepts

Types of Object Templates

Like object models represent the application and the topology of the system, so do templates.
Thus, there are the following types of templates:
 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.

42 EIO0000001309 06/2017
 General Concepts

Application Templates

Introduction
Control and Supervision facet templates encapsulate the respective Participant capabilities:
 For Control:
 Logic facet templates: implement a specific function, for example, motor on/off.

 For Supervision:
 Data facet templates: Allow to define tags and user interface messages that re required for
acquiring runtime data.
 Genie facet templates: Represent runtime data through an animated icon.

Based on a combination of these, application control module templates have been created
allowing you to model the application of a system in terms of Control and Supervision services.
They are located in the General Purpose library and grouped by category.
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 (user interface and mode of operation).
Enabling/disabling a Control facet enables/disables the corresponding Supervision facet.

Categories of Application Templates

The table indicates the categories of application control module templates that are available in
Process Expert and the documentation that describes them:

Title Scope
Process Expert Process Process templates, which allow you to instantiate common control modules for
Templates (see Process Expert , process automation, such as motors, valves...including signals from the field and
Process Templates User Guide) variables.
Process Expert Device Device templates, which provide you with functions to manage Schneider Electric
Templates (see Process Expert, devices connected to field buses, such as speed drives, motor starters,
Device Templates User Guide) instrumentation...
Process Expert Communication Communication templates, which provide you with functions to manage
Templates (see Process Expert,
communication with Schneider Electric or third party devices, and client/scanners
Communication Templates User through supported networks and communication buses.
Guide)
NOTE: Communication templates do not provide Supervision services.
Process Expert Diagnostic Diagnostic templates, which provide you with functions to view the status of the
Templates (see Process Expert, main functions of controllers of the system.
Diagnostics Templates User
Guide)

EIO0000001309 06/2017 43
General Concepts

Application Template Example

This following figure is a graphical representation of the actual composition of the control module
template $Motor, which contains the resources that are required for the complete management
of a motor:

NOTE: You can view the composition of the control module $Motor by right-clicking it from the
tree view of the Global Templates Explorer and selecting View only.
In the Global Templates Explorer (see page 858), follow the path: Global Templates\General
Purpose Library\Process\Control Modules\ON/OFF Device Control.

Item Description
1 The composite template $Motor is a control module template, which provides the
typical services for motor management.
It contains 2 elements:
 composite reference Control (2)
 composite reference Supervision (8)

44 EIO0000001309 06/2017
 General Concepts

Item Description
2 Control is a Control composite reference.
The composite provides the typical Control services of which some are core and
some are optional.
It contains 9 elements:
 5 composite references.
 4 facet elements (7).

3 Motor is a Control composite reference, which provides a core Control service.

It contains 1 element, which is a facet Logic (4).
4 Logic is a Control facet element, which provides a core Control service.
5 LocalPanel is a Control composite template, which provides optional Control
services.
It contains 7 elements:
 Facet element Logic, which provides a core Control service.
 6 facet elements, which provide optional Control services.

The names of the Control facets indicate the nature of service that they provide
in the context of the template in which they are referenced.
6 OFFDISignal is a Control facet element, which provides an optional Control
service.
7 Running, Fail, ExternalControl, and OPDOSignal are Control facet elements.
Each of them provides an optional Control service.
8 Supervision is a Supervision composite reference.
The composite provides the typical Supervision services. Such services are
optional.
It contains 2 elements:
 Supervision data facet element Tags (9).
 Supervision genie facet element Genies (10).

9 Tags is a Supervision data facet reference.

It contains 5 elements, which are Supervision data facet references.
10 Genies is a Supervision genie facet reference.
It contains 6 elements, which are Supervision genie facet templates.
11 OnOffDeviceTags is an Supervision data facet reference providing a core
Supervision service, which corresponds to the core Control facet references
Logic (4).
12 LocalPanelTags is a Supervision data facet reference, which provides an optional
Supervision service.
13 HorizontalLeftPumpGenie is a Supervision genie facet reference.

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

EIO0000001309 06/2017 45
General Concepts

The table explains the color and line style coding that is used in the graphical representation of the
$Motor control module template:

Core Services
Typically, Control services that are required to manage the core functions that are provided
by the template. They are selected by default and cannot be deselected.
They are provided by:
Composite references, which can contain the following elements:
 facets, and/or
 other composite references

Control facets.

Supervision facets, which can be:

 Tags: Data facets, which generate the Supervision tags. The services
corresponding to the selected Control services are automatically selected.
 Genies: Genie facets. They are selected by default.

Optional Services
Additional Control or Supervision services, which are available to implement additional
functions that are provided by the template (for example, interlocks, maintenance...).
These services, depending on their nature, are either selected or deselected by default and
cover common use cases to reduce the engineering effort.
You can choose to select optional services when you use the $Motor control module for
modeling the application of the automation system.
They are provided by:
Composite references, which can contain the following elements:
 facets, and/or
 other composite references

Supervision facets, which can be data facets that generate Supervision tags or
genie facets that generate genies in Supervision pages.
A service is automatically activated when you select the corresponding Control
service.
Control facets.

46 EIO0000001309 06/2017
 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.

EIO0000001309 06/2017 47
General Concepts

Interface Models

Introduction
Interface models allow you to define:
 data exchange between 2 object instances or 2 object references.
 dependencies between 2 object instances or 2 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).

48 EIO0000001309 06/2017
 General Concepts

Instances of Templates

From Templates to Instances

Process Expert allows you to create application and topological instances from the corresponding
templates.
Because control module templates integrate a range of Control and Supervision services, provide
editable parameters and 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. Some services are mandatory (for
example, Control logic) and some are optional.
 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 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.
Likewise, when you unselect a service, the software deletes the corresponding facet.

EIO0000001309 06/2017 49
General Concepts

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

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

50 EIO0000001309 06/2017
 General Concepts

Section 3.2
System Engineering Life Cycle Concept

System Engineering Life Cycle Concept

Overview
The concept of breaking down into stages the engineering workflow for implementing 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 52
Platform Components 54
Global Templates Definition Stage 55
Instantiation Stage 56
Project Definition Stage 62
Assignment Stage 65
Generation Stage 67
Refinement Stage 68
Configuration Stage 70
Mapping Stage 72
Build Stage 74
Deployment Stage 76
Execution Stage 78

EIO0000001309 06/2017 51
General Concepts

The System Engineering Life Cycle

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

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 implement a system by
using Process Expert.
The following figure shows the system engineering life cycle.

The stages are grouped into 4 main parts of which the topology, the projects, and the application
represent a system. The library represents the Global Templates. To each part corresponds an
explorer, which provides the services 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 areas of the system
engineering life cycle.
You can find a list of the stages and the main tasks that you can complete in each stage in a Quick
Reference Guide (see page 167).

52 EIO0000001309 06/2017
 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.

EIO0000001309 06/2017 53
General Concepts

Platform Components

Overview
With Process Expert, you manage each part of a system (application, projects, and topology)
distinctively using specific tools, which provide the necessary functions.
You can manage several systems simultaneously.

Platform Managers
The managers provide access to the following software tools of the Process Expert user interface:

Tool Description
Global Displays the Global Templates that are stored in the Global Templates
Templates library as a tree and organized in a folder structure making the templates
Explorer easily accessible.
It provides you with the necessary functions to create, modify, and manage
Global Templates.
Application Displays the application of a system as a tree and allows you to organize
Explorer it in a folder structure in order to define the complete functionality of the
application.
It provides you with the necessary functions to create, configure, and
manage the instances that model the application of a system.
Project Explorer Displays, at the platform level, projects of a system that are managed by
the software participants, in the form of a folder structure:
 Control projects
 Supervision projects

It provides you with the necessary functions to manage the Control logic,
Supervision data, and create the executables for each project.
Topology Displays the topology of a system in the form of a folder structure.
Explorer It provides you with the necessary functions to create and manage the
different entities that model the hardware infrastructure. It allows you to
interact with the controllers, devices, station nodes, and networks of a
system.

54 EIO0000001309 06/2017
 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 with
Process Expert allow you to implement systems but you have the possibility to modify or create
templates.
The Global Templates Definition is the process to create and/or modify templates by:
 Using existing templates from the Global Template library and modifying them to meet your
particular requirements.
 Creating new templates using generic base components with the help of template editors. This
process is not described in this manual.

EIO0000001309 06/2017 55
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 using a folder structure.
 Functional components using instances (see page 49) 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 173), 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.

56 EIO0000001309 06/2017
 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 185).

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 53):

Water tank: Water tank system root folder

Level: Level management folder, which will contain the instances related to the water level sensor
management
Pumping: Pump management folder
Pmp1: Folder containing the instances related to the Pmp1 motor management
Pmp2: Folder containing the instances related to the Pmp 2 motor management

Selecting Templates to Model the Application

The table details, which templates were selected to model the water tank application:

Template Application
$Motor Motors of Pmp1 and Pmp2
$ATS48MB ATS 48 soft staters for Pmp1 and Pmp2
$DigitalInput Digital switches (Lsh1, Lsl1, Lsll1)

NOTE: The Process Expert naming convention defines the use of the $ sign as the first character
of a Schneider Electric template identifier.

EIO0000001309 06/2017 57
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:
 Pmp1 and level switch objects
 instances inside folders Pmp1 and Level
 facets of the Motor_Pmp1 instance

58 EIO0000001309 06/2017
 General Concepts

The table describes the details of the instances that are created during instantiation of the
templates and give an example of the configuration possibilities:

Selected Instances Instance Description Facet Templates Configuration Example(3)

Template Created from Contained in the
Template(1) Template of the
Instance(2)
$Motor Motor_Pmp1 Model the electrical Control facets: The on/off logic facet is selected
motors for Pmp1 and  $DEVCTL_UL: by default and cannot be
Pmp2. On/off logic data deselected. The corresponding
facet service is provided for the
instance.
(You can configure up to
4 parameters for this Control
service.)
 $CONDSUM1_UL: The optional interlock condition
Optional interlock summary facet is selected. The
condition summary facet will be created and the
facet service will be available for the
instance.
(You cannot configure
parameters for this Control
service.)
Motor_Pmp2 Supervision facets: The optional Supervision facet
 $DEVCTL_CD: is selected, will be created, and
Optional on/off data the corresponding service will
facet be available for the instance.
(You can configure up to
30 parameters for this
Supervision service.)
 $CONDSUM1_CD: The optional Supervision facet
Optional interlock is selected, will be created, and
data facet the corresponding service will
be available for the instance
(you can define messages that
will be displayed in the interlock
tab of the motor faceplate.)
$ATS48MB Motor1_ATS Model the management Not detailed for the example.
Motor2_ATS of Motor1 and Motor2
each by an ATS 48 soft
starter device.

EIO0000001309 06/2017 59
General Concepts

Selected Instances Instance Description Facet Templates Configuration Example(3)

Template Created from Contained in the
Template(1) Template of the
Instance(2)
$DigitalInput Lsh1 Model 3 digital inputs for: Control facets: The logic facet is selected by
 Lsh1 high-level  $DINPUT_UL: Logic default and cannot be
detection switch data facet deselected. The corresponding
 Lsl1 low-level service is provided for the
detection switch instance.
 Lsll1 low low-level (You can configure up to
detection switch 4 parameters for this Control
service.)
 $DISignal_UL: The optional digital signal facet
Optional digital input is unselected. The facet will not
signal be created and the service will
not be available.
Supervision facet: The optional Supervision facet
 $DINPUT_CD: is selected, will be created, and
Optional data facet the corresponding service will
be available for the instance.
(You can configure up to
30 parameters for this
Supervision service.)
Lsl1 Control facets. The logic facet is selected by
(Same as for Lsh1) default and cannot be
deselected. The corresponding
service is provided for the
instance.
(You can configure up to
4 parameters for this Control
service.)
The optional digital signal facet
is selected. The facet will be
created and the service will be
available.
Supervision facet. The optional Supervision facet
(Same as for Lsh1) is selected, will be created, and
the corresponding service will
be available for the instance.
(You can configure up to
30 parameters for this
Supervision service.)
Lsll1 Same as for Lsh1 Not detailed for the example.

60 EIO0000001309 06/2017
 General Concepts

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

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

EIO0000001309 06/2017 61
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 1 project with
different hardware infrastructures.
Ultimately, towards the end of the system engineering life cycle, to each project will be associated
1 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, Quantum 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.

62 EIO0000001309 06/2017
 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 folders representing:
 The program structure: A Tasks folder containing FBD and non-FBD program sections, which
are referred to generically as containers.
 The binary program: An Executables folder providing access to program files and related
services.
A Supervision project consists mainly of folders representing:
 Data: A tags folder containing tag containers.
 Graphic elements: A Pages folder that contains the user interface visible to the operator.
 Components: A Services folder for managing servers and communication for data acquisition
and representation.
 The program: An Executables folder 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.
Process Expert manages 3 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 67) 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 74) 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 76).

EIO0000001309 06/2017 63
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 269).

Example
The following projects are defined for the water tank system (see page 53):
 A Control project to manage the logic (for example, variables and DFBs,) of the instances of the
application. It contains 3 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:
 1 tag container for the Supervision data facets of the instances of the application.
 1 page for the Supervision genie facets of the instances of the application.
 Components: 1 of each I/O, alarm, and trend server, and I/O device with its communication
port.

64 EIO0000001309 06/2017
 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 Control or Supervision constituents that are encapsulated inside the facets will be
integrated into the Participant project during subsequent stages of the system engineering life
cycle.
You assign the 2 types of facets to a specific type of container:
 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 1 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 357).

EIO0000001309 06/2017 65
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 53) that you can perform:

Instance Facets Assigned To

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

66 EIO0000001309 06/2017
 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, which integrates
the constituents of the assigned facets, associated to the structure of the project. 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 399).

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

EIO0000001309 06/2017 67
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.

You can refine a Supervision project, for example, to:

 Assign genie facets to a Supervision page.
 Configure user privileges.

Process Expert will open the respective Participant allowing you to use the interface and some
functions of the embedded software.
For more information on completing the refinement stage, refer to the chapter describing its
implementation (see page 465).

68 EIO0000001309 06/2017
 General Concepts

Example
During the refinement of the Control project of the water tank system (see page 53), 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 constituent of the Lsh1 high-level switch sensor
Control facet during which a new variable is added:

EIO0000001309 06/2017 69
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 involves defining the topology of the system, which models the hardware
and software infrastructure.
You can define the topology, using either of 2 methods depending on the entity that you are
defining:
 Through the Process Expert user interface by using specific editors in which you may select
templates for instantiation. This method is called the top-down approach.
 Through the Participant user interface, using the configuration functions of the embedded
software: Once completed, the software creates the corresponding folders and devices in the
Process Expert user interface by using appropriate templates of the Foundation library.
For more information on completing the configuration stage, refer to the chapter describing its
implementation (see page 497).

70 EIO0000001309 06/2017
 General Concepts

Example
For the water tank system (see page 53), 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 the topological instances of the water tank system that you can create
during the configuration stage:

Controller: Local rack with an Ethernet based architecture

Advantys Island: On which 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: LAN connecting the controller, the Advantys Island, the gateway, and the supervision station
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 communicating with devices through Modbus TCP explicit or implicit messaging,
topological instances of devices are created also in the topology to manage TCP/IP addressing.

EIO0000001309 06/2017 71
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 3 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 through I/O
scanning).

72 EIO0000001309 06/2017
 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 571).

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

Mapping Description
Control project
Service Project is mapped to the controller for execution
Hardware If for instance Motor_Pmp1, you select the optional Running Control service, the software
creates the corresponding facet by using the facet template $DISignal_UL. It corresponds
to the boolean variable that indicates the state of the motor switch.
You can map this variable of the application to an input module of the STB island.
Communication I/O scanner channels between the controller and the STB island are defined.
Supervision project
Service The I/O, alarm, and trend server that are defined in the Supervision project are mapped
to the operator station that hosts them.
Communication The I/O device is mapped to the controller and communicates through the selected
communication module of this controller.

EIO0000001309 06/2017 73
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 project in the Control Participant.
For more information on completing the build stage, refer to the chapter describing its implemen-
tation (see page 621).

74 EIO0000001309 06/2017
 General Concepts

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

Participant Generated Files

Control The project file, which is the binary to be deployed to the controller (.stu).
Supervision The master project file to be deployed to the operation server and operator
stations (.ctz).
The include project files to be deployed to the operation server and operator
stations (.ctz).
The OPC Factory Server configuration files (.xml).

EIO0000001309 06/2017 75
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 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 643).

76 EIO0000001309 06/2017
 General Concepts

Example
The following figure illustrates the engines to which you can deploy the built Control and
Supervision Participant projects of the water tank system (see page 53):

EIO0000001309 06/2017 77
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 711).
Additional runtime services are described in the Process Expert Navigation Services User Guide
(see Process Expert, Runtime Navigation Services, User Guide).

78 EIO0000001309 06/2017
 Process Expert
Working With Process Expert
EIO0000001114 05/2017

Part II
Working With Process Expert

Working With Process Expert

Overview
This part explains how to access and use the Process Expert 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 Process Expert 81
5 Multiuser Functionality 91
6 Action Traceability 93
7 Capabilities of Process Expert 99
8 Using the Online Help 111
9 User Interface 121
10 Folders and Instances 149

EIO0000001309 06/2017 79
Working With Process Expert

80 EIO0000001309 06/2017
 Process Expert
Starting and Quitting Process Expert
EIO0000001114 05/2017

Chapter 4
Starting and Quitting Process Expert

Starting and Quitting Process Expert

Overview
This chapter describes how to start and quit Process Expert 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 Clients 82
Starting the System Server Again 85
Client/Server Connection 86
Quitting Process Expert 89

EIO0000001309 06/2017 81
Starting and Quitting Process Expert

Logging In and Out of Clients

Overview
When you start a Process Expert engineering or operation client, you need to log in to be able to
use it.
Process Expert uses Microsoft® Windows® credentials.
Process Expert clients authenticate users against:
 The Active Directory® (AD) domain services controller if the PC is connected to a Windows®
domain.
 The local Windows® user accounts if the PC is not connected to a Windows® domain.

By default, when you start a client, the user name that was used to log on to the current Windows®
session is displayed in the User Name field of the Log In dialog box.
NOTE: For information on starting clients, refer to the topic describing how to start Process Expert
(see Process Expert, Installation and Configuration Guide).

Selecting the Authentication Domain

Process Expert clients authenticate user credentials depending on the user name format that you
use to log in.

User name format Authentication method

<DomainName\UserName> AD domain services controller.
Example: EUR\Operator
<PCName\UserName> Local PC Microsoft® Windows® user accounts.
Example: OPServer\Operator
NOTE: Local Windows® user accounts need to have a password to be
<localhost\UserName> used to log in.
Example: localhost\Operator
<.\UserName>
Example: .\Operator
UserName>  AD domain services controller if the PC is connected to a Windows®
Example: Operator domain.
 Local PC Windows® user accounts if the PC is not connected to a
Windows® domain.

NOTE: If the PC that runs the Process Expert client is connected to a Windows® domain and the
connection to the domain network is interrupted, users can also log in by using their local
Windows® user account if such an account exists.

82 EIO0000001309 06/2017
 Starting and Quitting Process Expert

Logging In
To log in to a Process Expert client, proceed as follows.

Step Action
1 Enter your user name.
2 Enter the corresponding password.
3 Click OK.
Result: When logging in for the first time after starting the client, the default window of the client is
displayed if you entered valid credentials (for example, the Systems Explorer for an engineering
client); otherwise a notification is displayed, and you need to reenter your login information.
The user information that is associated to the account and the user name (in brackets) are
displayed to the outer right of the menu bar.
NOTE: To close the client without logging in, close the Log In dialog box.

NOTE: Logging in to a Process Expert client is subjet to the same log-on policies as those that are
defined locally for the PC or for the domain.

Locking Clients
You can lock a client to which you are logged in by clicking the lock button in the engineering client
toolbar (see page 123).
When a client is locked, the Log In dialog box is displayed and you need to log in again to resume
using it.
If several engineering client windows are open, locking one window also locks the others.
NOTE: When you lock a client, you remain logged in. The user name that was used to log in is
displayed in the Log In dialog box.

Logging Out
To log out of a Process Expert client:
 Close the client.
 Lock the client and log in by entering a different user name and the corresponding password.

NOTE: When you log out by locking the client and logging in with different credentials, you resume
the session in the same state as it was before locking it.

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.
This includes clients that are running but with no user being logged in. For these, the prefix
System: appears in front of the user name.
For a description of the dialog box, refer to the topic describing the About StruxureWare
Process Expert dialog box (see page 127).

EIO0000001309 06/2017 83
Starting and Quitting Process Expert

Tracing Login Attempts and Log Outs

The following actions are recorded in the system server log files, and displayed in the notification
panel and in the system server console:
 Attempt to log in to a client even if they are unsuccessful. The user name that is entered is
recorded.
 Log in of a user to a client that was locked.
 Closing a client, which logs out the user.

For details, refer to the topic describing the traceability of actions (see page 93).

84 EIO0000001309 06/2017
 Starting and Quitting Process Expert

Starting the System Server Again

Temporary Contents Repository Files

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

Starting the System Server

To start the system server after you stopped it (see page 89), 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 From the Windows taskbar icon, click All Programs → Schneider Electric →
Process Expert → System Server.
Result: The system server console opens.
3 From the system server console menu, click Action → Start.
Result: The system server starts.
4 Wait until the system server console displays the following message at the
bottom of the window to start engineering and operation clients
(see Process Expert, Installation and Configuration Guide):
Server is ready
5 Click the minimize button of the system server console.
Result: The system server window is minimized to an icon in the task bar.

NOTE: You can also start the system server by double-clicking the PES icon on the desktop if it
has been created during software installation.

EIO0000001309 06/2017 85
Starting and Quitting Process Expert

Client/Server Connection

Overview
Process Expert 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.

You cannot use Process Expert clients while the connection to the system server is interrupted or
while the system server is not running.

Client/Server Communication Interruption

Clients that cannot connect to the system server anymore display:
 No notification if no action is in progress.
 A notification to inform you that they are unable to connect to the system server if you launch a
task while the connection to the server is interrupted. In such case, launch the task again when
the communication is re-established.

86 EIO0000001309 06/2017
 Starting and Quitting Process Expert

 A notification to inform you of an unexpected communication interruption if an action is in

progress. If the system server is still running, the action completes server side and the
notification of clients is updated when the connection is re-established.

 A message in the notification panel (see page 94) to inform you that the server is shutting down
if the server was stopped by user intervention. From this point on, you cannot perform any action
on the client.
NOTE: Refer also to the topic providing information to help troubleshoot client/server
communication (see Process Expert, Installation and Configuration Guide).

Re-establishing the Connection to the Server

Process Expert 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 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 97).

EIO0000001309 06/2017 87
Starting and Quitting Process Expert

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 PC 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.

88 EIO0000001309 06/2017
 Starting and Quitting Process Expert

Quitting Process Expert

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

When you stop the system server, tasks in progress are completed before the server is stopped.
Then, the system console closes. If any client is still connected to the system server, a notification
is displayed, which indicates the user name of the person who is still logged in.
NOTE: To restart the system server, quit Process Expert in the same order and the then start the
system server (see page 85).

Quitting Process Expert Clients

To quit a Process Expert 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 user is logged out and the client window closes, disconnecting it
from the system server.

Stopping the System Server

You cannot use a Process Expert 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.

EIO0000001309 06/2017 89
Starting and Quitting Process Expert

To stop the Process Expert system server, proceed as follows:

Step Action
1 From the menu bar of the system server console, click Actions → Stop.
Result: Process Expert displays a dialog box asking you to confirm the system
server stop.
NOTE: If a client is still running, the name and user name of the person who is
still logged in is displayed in the dialog box.
If a client is running but with no user being logged in, the user name is displayed
as System:<user name>
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 89) and stop the system server again by starting this
procedure over.
4 When no more client is connected, click Yes.
Result: The system server completes tasks in progress then stops, and closes
the system server console.
NOTE: Click No to close the dialog box without stopping the system server.

90 EIO0000001309 06/2017
 Process Expert
Multiuser Functionality
EIO0000001114 05/2017

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, Process Expert manages system-wide concurrent user access to editors and other
tools to preserve the integrity of data of the system.
Process Expert 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

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.

Virtual Machine Usage Considerations

While the type and number of activated PES 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 Process Expert,
Installation and Configuration Guide).

EIO0000001309 06/2017 91
Multiuser Functionality

Examples
By using examples, the table illustrates some of the locking mechanisms that Process Expert
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 Project Cannot refine the same Participant project or any
Explorer. section of 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).

92 EIO0000001309 06/2017
 Process Expert
Action Traceability
EIO0000001114 05/2017

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 94
Activity Log Files 97

EIO0000001309 06/2017 93
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.
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.
The information remains available as long as 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 123).

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 236) 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.

94 EIO0000001309 06/2017
 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 User name of the user who is logged in to the client from which the task was
executed.
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 96).

EIO0000001309 06/2017 95
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 143) 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.

96 EIO0000001309 06/2017
 Action Traceability

Activity Log Files

Overview
Process Expert 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 94).

Log File Location

Log files are located at the following path:
C:\Users\<Username>\AppData\Roaming\Schneider Electric\Process Expert x.y\Logs where x.y
represents the version of Process Expert that is installed.
<Username> corresponds to the user name that was entered to log on to the current session of
Microsoft® Windows®, independently of the user name that was entered to log in to the
Process Expert client.

Log File Name Syntax

The names of log files have the following syntax: [Link] [Link]
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:
 [Link] is the current log file in which the software is recording server activity.
 [Link] is the log file in which the software recorded past engineering client activity.
The file content is not updated anymore because [Link] is currently recording activity.
[Link] was created when [Link] reached its size limit for the second time (the
first time, [Link] was created).

EIO0000001309 06/2017 97
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

Process Expert 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.

98 EIO0000001309 06/2017
 Process Expert
Capabilities of Process Expert
EIO0000001114 05/2017

Chapter 7
Capabilities of Process Expert

Capabilities of Process Expert

Overview
This chapter describes the capabilities of Process Expert.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Hardware and Software Capabilities 100
Supported Data Types 104
Naming Rules 107

EIO0000001309 06/2017 99
Capabilities of Process Expert

Hardware and Software Capabilities

Overview
The following describes the main hardware and software capabilities of 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 online help of the respective Participants (see page 112).
Some capabilities and/or features may not be supported by Process Expert.

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

Programming Languages
Process Expert generates the program for controllers, using the Function Block Diagram (FBD)
programming language.
The Control Participant supports additional programming languages (see page 101) for creating
the user program, which can be used together in Control projects managed by 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 Process Expert. For more information, refer to the Supervision Participant help
(see page 112).

Template Libraries
Process Expert uses object-oriented modeling for the design of applications. For this purpose, an
extensive selection of Schneider Electric templates are included in the Global Templates library of
Process Expert. The library encompasses simple 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.
For a better overview, the different templates are arranged in libraries, which are then broken down
into families.
The templates are used in explorers and editors specific to Process Expert and the encapsulated
constituents are used in the corresponding software Participants.
For information on architectures, for which templates are available, refer to Supported Hardware
Architectures (see Process Expert, Control Participant Services, User Guide).
For information on applications, for which templates are available, refer to Reference Documents
for Application Templates (see page 856).

100 EIO0000001309 06/2017

 Capabilities of Process Expert

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 Process Expert.

Controller Program
In Process Expert, 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
 1 to 4 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 Process Expert. However, not all of them can be viewed in Process Expert
outside of the Control Participant (for example, non-FBD sections).

Performance Scope
The table shows the main characteristics of Process Expert.

Process Expert Control Supervision

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 – – +

EIO0000001309 06/2017 101

Capabilities of Process Expert

Process Expert Control Supervision

Participant Participant
Schneider Electric Global Templates Libraries
Foundation library + – –
General Purpose library + – –
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 + – –
Managing user rights – + +
Simulator + + –
Documentation as context help and + + +
PDF
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 + – +

102 EIO0000001309 06/2017

 Capabilities of Process Expert

Process Expert Control Supervision

Participant Participant
Server and client events – – +
I/O devices + – +
I/O, alarm, trend, and report servers + – +
Redundancy + – +
Load balancing (operation servers) + – +

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

EIO0000001309 06/2017 103

Capabilities of Process Expert

Supported Data Types

Data Type Conversion

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

Standard Data Types

Process Expert uses the following data types.

Data Type Description Lower Limit Upper Limit Size

DateTime A specific instance 19-01-01 00:00:00.000 2100-12-31 23:59:59.999 8 bytes
in time(1).
Date A Gregorian 1900-01-01 2100-12-31 8 bytes
calendar date(1).
Time An instant of time 00:00:00.000 23:59:59.999 8 bytes
that recurs every
day(1).
hh:mm:[Link]
Duration A duration of time 0 9,223,372,036,854,775,807 8 bytes
as specified by in ticks
Gregorian day,
NOTE: 1 tick = 100 ns
hour, minute,
second, and
millisecond
components(1).
[Link]:mm:[Link]
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 1 character of the standard n characters of the standard 1 character =
unicode ASCII table. ASCII table. 1 byte
characters.
(1) Microsoft® Windows® Regional Options may apply to the format of the type.

104 EIO0000001309 06/2017

 Capabilities of Process Expert

Data Type Description Lower Limit Upper Limit Size

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

EIO0000001309 06/2017 105

Capabilities of Process Expert

User-Defined Data Types

Data Type Description Lower Limit Upper Limit Size

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

106 EIO0000001309 06/2017

 Capabilities of Process Expert

Naming Rules

Overview
When you change default parameters such as identifiers or Supervision element properties,
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 Process Expert does not validate
them. For more information, refer to the respective Participant help (see page 112).

Folder Identifiers
Folder identifiers:
 Can start only with a letter, a digit, 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

Instance Identifiers
Instance identifiers can contain only letters, digits, and underscores.
The maximum character length is set through the Validation property of the $InstanceID parameter
of the template that the instance uses.

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.

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.

EIO0000001309 06/2017 107

Capabilities of Process Expert

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 (see Unity Pro, Program Languages and Structure, Reference Manual
) in the IEC 61131-3 standard (Appendices of the Languages Reference manual).
 Permitted characters: Refer to naming conventions in the glossary of the Control Participant
online help, Operating Modes (see Unity Pro, Operating Modes).
Refer to the topic describing data validation before generating (see page 403).

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.

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

108 EIO0000001309 06/2017

 Capabilities of Process Expert

Rule Field Value

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

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

EIO0000001309 06/2017 109

Capabilities of Process Expert

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

Supervision Fields Special Characters

The table describes the rules that Process Expert validates regarding 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
 \
 _

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 [Link] file is set
to 1 (the default value is 0).

110 EIO0000001309 06/2017

 Process Expert
Using the Online Help
EIO0000001114 05/2017

Chapter 8
Using the Online Help

Using the Online Help

What Is in This Chapter?

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

EIO0000001309 06/2017 111

Using the Online Help

Software Participant Help

Overview
You can access the online help of a Participant by selecting Help from the menu of the Participant
window when displayed (for example, after you click Configure in the context menu of a topological
entity).
You can access the same online help also directly from the Help StruxureWare Process Expert
dialog box without having to open the Participant.
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.

Accessing a Participant Help

To open the online help of a Participant, proceed as follows.

Step Action
1 In the toolbar (see page 123) of the Process Expert user interface, click the help button (?).
Result: The software opens the Help StruxureWare Process Expert dialog box.
2 In the section Software Participant Online Help, double-click a Participant name.
Result: The online help of the Participant opens in a separate window.

112 EIO0000001309 06/2017

 Using the Online Help

Using Help for Different Versions of Schneider Electric Templates

Overview
Each version of Process Expert comes with one version of each template (the latest) and installs
the online help only for this version of the template. This overwrites the help of the previous version
if you are upgrading from an earlier version.
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 Process Expert 4.3, you have the possibility to retain the help of any version of
Process Expert to continue using it after you upgrade Process Expert 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 online help and describes
how to proceed.
NOTE: For more information on how to obtain help on templates, refer to the Opening Context-
Sensitive Help topic located at the top of the Process Expert online help table of contents.

Considerations When Using the Online Help of Several Versions of Process Expert
The online help of a version of Process Expert 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 Process Expert. 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.

EIO0000001309 06/2017 113

Using the Online Help

Location of the Online Help Files

On the computer running the engineering client, the online help files are located in the User Guides
folder at the path C:\Program Files\Schneider Electric\StruxureWare\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 Online Help Files Before Upgrading Process Expert
So that the online help of the current version remains accessible when you uninstall the current
version of Process Expert and 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: %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.y folder (where x.y represents the
version) may already exist under 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 V4.3>.
Mentioning the version helps you identify for which version of Process Expert 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 114) to the subfolder that you
have created in step 2.

Opening the Help for Templates of an Earlier Version

To open the online 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 123) 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 Process Expert.
 The help of the earlier version of Process Expert in which the template was provided (given
you have copied the necessary help files to the required location (see page 114)).
Only one help window opens at a time.

114 EIO0000001309 06/2017

 Using the Online Help

NOTE:
 If the version of the template was provided with a version of Process Expert 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
Process Expert, the Contextual Help Conflict dialog box opens, which lets you select which
version of the help you want to open.

EIO0000001309 06/2017 115

Using the Online Help

Help on User-Created Templates

Overview
You can configure Process Expert to open the online help in CHM format of a user-created
template.
You can also manage the online help files of several versions of the same template so that clicking
a given version of the template opens the corresponding online 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 online help files in CHM format.
NOTE: By using this feature, you can also associate your own online help to a Schneider Electric
global template in addition to the existing help. You can then select which one you want to open.

Prerequisites
The following are the prerequisites to be able to open help for user-created templates:
 You need to have online 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 117) 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.

Creating a Repository for Help Files of User-Created Templates

So that the online help of user-created templates can be opened and also remains on the computer
when you uninstall the current version of Process Expert and upgrade to a later version, you need
to copy your complete set of help files and the [Link] 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.

116 EIO0000001309 06/2017

 Using the Online Help

Step Action
2 In the User Guides folder, create a copy of the folder named Sample-To be copied in the same
location and rename it by using a meaningful name describing its contents and the version of
Process Expert that was used to create the template. For example, <MyReactor Template Help
Files for V4.3>.
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 online help files to the subfolder that you have created in step 2.

NOTE: Uninstalling Process Expert removes the folder named Sample-To be copied but not the
copies of it.

Identifying the ID of a Topic Inside a CHM Online Help File

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

Step Action
1 Open the user-created online 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\[Link]::/[Link], the topic ID is
[Link].

EIO0000001309 06/2017 117

Using the Online Help

Editing the XML File

To edit the [Link] file, proceed as follows.

Step Action
1 In the folder (see page 116) to which you have copied your online help files, open the
[Link] 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-
[Link]" 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 117) 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 114). 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 online help to open.
To manage the online help for different versions of the same template, refer to the next topic
(see page 119).
NOTE: The </ContextualHelp> element must be the last entry in the file.
4 Save your changes.

118 EIO0000001309 06/2017

 Using the Online Help

Updating the Online 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 online 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 Action Comment

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

EIO0000001309 06/2017 119

Using the Online Help

Opening the Online Help for User-Created Templates

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

Step Action
1 Click the context-sensitive help button in the toolbar (see page 123) 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 118).

NOTE:
 If the value of any parameter in the [Link] file is incorrect (except for
description), if the [Link] 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 [Link] 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 Online Help Files to Schneider Electric Global Templates

By using an example, this topic describes how to associate your own online help file in CHM format
to a control module template of the General Purpose library for which the online help of
Process Expert is already available.
The data used for the example is the following:
 Control module template of the General Purpose library: $Motor version 1.0.0.
 Name of you online help file: [Link]
 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 online help (see page 116) and copy the [Link] file to
this folder.
2 Edit the [Link] file (see page 118) 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 123) 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 Process Expert help and your help.
4 Select the help file that you want to view and click OK.

120 EIO0000001309 06/2017

 Process Expert
User Interface
EIO0000001114 05/2017

Chapter 9
User Interface

User Interface

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

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Engineering Client User Interface Description 122
Engineering Client Workspace Description 129
Working with Panes 134
Using Menus 138
Software Participant Windows 139
Filtering and Sorting Data 143
Keyboard Shortcuts 147

EIO0000001309 06/2017 121

User Interface

Engineering Client User Interface Description

Introduction
The Process Expert engineering client user interface is composed of five main areas:
 Toolbar
 Tabs bar
 Workspace toolbar
 Workspace
 Notification panel

The engineering client opens the Systems Explorer after starting.

User Interface Description

The following figure shows the engineering client user interface.

1 Toolbar
2 Tabs bar
3 Workspace Toolbar
4 Workspace
5 Notification panel

122 EIO0000001309 06/2017

 User Interface

Toolbar Description
The following figure describes the toolbar of the engineering client.

Item Description
1 Opens the Systems Explorer window (see page 174), which lets you create, organize, and
navigate through systems.
From the Systems Explorer you can access 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 Links 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 942), which contains files related to Global
Templates and the systems that you are implementing.
4 Opens the Global Templates Explorer (see page 858), which you can use to browse and
interact with templates of the Global Templates library.
5 Opens the notification panel (see page 94).
6 Locks the engineering client (see page 83).
7 Opens the About StruxureWare Process Expert dialog box (see page 127).

EIO0000001309 06/2017 123

User Interface

Item Description
8 Opens a dialog box, which lets you access:
 The global Process Expert online help. It describes how to install, license, and use the
software as well as the Global Templates of the General Purpose and Foundation libraries.
 The global online help of each software Participant (see page 112).
 The online help of OPC Factory Server.

Double-click an entry to open the corresponding help.

9 Opens the online 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.
10 Opens context-sensitive online help.
Clicking the button enables context-sensitive online help and a question mark appears next to
the cursor.
Selecting an item opens the online 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, see Opening Context-
Sensitive Help at the top of the online help (Contents tab).
11 Minimize Window button
Minimizes the engineering client window to the task bar.
12 Maximize/Restore down button
Maximizes the engineering client window.
13 Close Window button
Closes the engineering client window and quits the client.
14 Login information (see page 82).
15 Search field, which lets you search for:
 In the Application Explorer: Instances and folders.
 In the Global Templates Explorer: Templates and folders.

16 Explorer layout settings button, which opens the Settings tab, allowing you to:
 Change the folder structure layout (see page 154).
 Assign icons to application folders.

The button is available only in the Application Explorer.

17 Name of the explorer or editor that is shown.
18 Name of the system or element that is shown in the explorer or editor.

124 EIO0000001309 06/2017

 User Interface

Tabs Bar Description

For each window that you open in a workspace, a tab is displayed in the tabs bar with:
 An icon representing the type of explorer or editor (for example, Application Explorer,
Assignment Editor.
 The identifier of the system that is displayed in the corresponding explorer (except for the
Contents Repository, Global Templates, and Systems Explorer). For editors, the identifier of the
system is indicated in a tooltip.
 A color coding:
 White: Active window
 Green: Inactive window

 A Close button to close the window

The tabs bar lets you open items in new windows (see page 132).
Tabs of windows that open are displayed in the following order:
 A new tab for a system for which no other tab is open: At the end of open tabs.
 A new tab for a system for which other tabs are already open: Grouped with the other tabs of
that system. For each system, tabs are arranged in the same order, by explorer and editor.
The following is the default order in which tabs of windows are arranged for each system:
1. Topology Explorer
2. Application Explorer
3. Links Editor
4. Project Explorer
5. Assignment Editor
6. Hardware Mapping Editor
7. Communication Mapping Editor
8. Variable Mapping Editor
Tabs of other windows (for example, the Global Templates Explorer) open at the end.
You can rearrange the order of tabs on the tabs bar by dragging them to a new position.
NOTE:
 You cannot close the last tab that remains in the tabs bar.
 To close all windows except one, right-click the tab of the window that you want to leave open
and select Close Other Tabs.

EIO0000001309 06/2017 125

User Interface

The following figure describes the tabs bar of the engineering client.

Item Description
1 Display all Tabs button.
Displays a menu showing the open tabs in the form of a list.
2 Inactive tabs.
3 Maximize/Reduce Workspace button.
The button is available when you have created more than one workspace. It maximizes
the workspace in the window or reverts the display to a multiple workspace view.
4 Close Workspace button.
The button is available when you have created more than one workspace. It allows you
to close the workspace.
5 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.
6 Active tab.
7 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.

Workspace Toolbar Description

Each workspace toolbar features the panning and selection buttons.
In addition, other buttons may be available depending on the explorer or editor tab that is active.

Workspaces
The workspace is the area of the client user interface where Process Expert displays information
on the system by using explorers, editors, and other dialog boxes.
For a detailed description of the workspace functions, refer to Workspace Description
(see page 129).

126 EIO0000001309 06/2017

 User Interface

About Process Expert

The dialog box, which you can open from the engineering client displays information related to:
 Process Expert and third-party software.
 Application size license information.
 The folder containing the Schneider Electric End User License Agreement (EULA) and the
release notes.
 Instance count by system (see page 209) (System Details tab).
 Logged in clients.
 Applied hotfixes (if applicable).

The following figure shows the General tab of the dialog box.

EIO0000001309 06/2017 127

User Interface

The following figure shows the Client Details tab of the dialog box.

128 EIO0000001309 06/2017

 User Interface

Engineering Client Workspace Description

Overview
The workspace is the display area that is below the toolbar and where the software displays
information on the system, for example:
 Tree views of folder structures of Explorers such as the Application Explorer.
 Windows of editors, such as the Assignment Editor window.
 Various panes.

The following figure shows an example of an engineering client workspace when the Application
Explorer is open.

1 Templates Browser and Application Browser panes displayed inside the workspace
2 Pin button, which allows you to minimize panes to the edge of the screen as a tab
3 Tree view of a system application displayed inside the workspace
4 Toolbar

EIO0000001309 06/2017 129

User Interface

Moving the Workspace (Panning)

In editors (for example, the Links Editor or template editors), 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 area.
In explorers (for example, the Application Explorer or Projects Explorer), use the following methods
to move the workspace.

Mouse wheel up Moves the workspace down.

Mouse wheel down Moves the workspace up.
Shift + Mouse wheel up Moves the workspace to the left.
Shift + Mouse wheel down Moves the workspace to the right.

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.
 In some workspaces, starting out from the default zoom level, you can only zoom in.

Selecting Multiple Items

The method to select multiple items varies depending on the editor or explorer you are working in:
 In editors (for example, the Links Editor or 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, you can select multiple items in the workspace by selecting an item with the
pointer, pressing and holding Ctrl, and selecting other items.
 In the Application Explorer, you can select multiple items in the workspace also by clicking the
workspace and holding 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.

130 EIO0000001309 06/2017

 User Interface

 In the Application Browser pane, you can select multiple instances and/or folders 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.

Organizing Your Workspace

Process Expert lets you customize the client workspace.
To work more effectively, you can:
 Open items in new, maximized windows.
 Divide the workspace into several smaller workspaces, horizontally, vertically or a combination
of both.
Each workspace has its own tabs bar and toolbar.
The following figure shows an example of an engineering client user interface that is divided into
three workspaces.

EIO0000001309 06/2017 131

User Interface

Opening Items in New Windows Inside the Workspace

In the Application Explorer and the Global Templates Explorer, you can open folders in a new
window inside the workspace. The name of the folder appears in the tab of the window.
To open a folder in a new window inside the workspace, proceed as follows.

Step Action
1 Drag the folder onto the tabs bar.
Result: The folder opens in a new window as a parent folder.

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 tabs are displayed in the tabs bar.
2 Right-click the tab of a window in the tabs bar, and select Open in new Window.
Result: The software opens the tab in a second, separate window, which has a title, a tabs, and
a menu bar.
3 Drag any of the two client windows to the other monitor.

NOTE:
 You can repeat the procedure to create a new, separate window from any tab of either window.
 You cannot view the same tab in two different windows.
 The title bar of the separate windows may differ from the title bar of the main user interface.
 Notifications on actions that you perform in the separate windows appear in the notification pane
of the main user interface.
 For a description of the commands that are available in the separate windows, refer to User
Interface Description (see page 122).

Dividing the Workspace

You can open an item in a new workspace using the docking menus. The new workspace opens
on the left, on the right or at the bottom of the original workspace depending on which docking
menu you use to open it.
Items that you can open in a new workspace are, for example:
 Templates and instances
 Certain open windows
 Folders
 Certain dialog boxes
 Explorers and editors

Once you have created several workspaces, you can drag tabs from one workspace to the other.
Refer to Tabs Bar Description (see page 125) for information on how to manage workspaces.

132 EIO0000001309 06/2017

 User Interface

The following figure illustrates the use of docking menus to create a new workspace.

Step Action
1 Select an item from the workspace by its tab or title bar.
2 Drag the item towards the side where you want to create the new workspace.
Result: The item follows the pointer and the docking menus appear.
3 Drag the pointer over the docking menu where you want the new workspace to open and release
the mouse button.
Result: The software opens a new workspace in the selected location and displays the item in a
window.
NOTE: To cancel the operation, drag the pointer back to the original location of the item and
release the mouse button.

NOTE: When the workspace contains more than one pane and you move one of them, a large
square docking menu appears in the center of the other pane. It lets you position panes in a relative
position to each other.
The position of the pane depends on the area of the docking menu that is selected when you
release the mouse button:
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 dark 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.

EIO0000001309 06/2017 133

User Interface

Working with Panes

Overview
The software displays panes in the 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 as an example the Application Explorer where the Application Browser
pane is pinned and the Templates Browser pane minimized to a tab.

134 EIO0000001309 06/2017

 User Interface

Minimizing, Showing, and Restoring Panes

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

Step Action
1 Click the pin button (see page 129) 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.

Moving Panes
You can move panes to turn them into floating panes or dock them to another area of the screen.
To move a pane, proceed as follows.

Step Action
1 Drag the title bar of the pane away from its current position.
Result: The panes turns into a floating pane and the docking menus appear (see page 132).
2  To keep a floating pane, release the mouse button.
 To dock the pane, move it to the corresponding docking menu.

Result: The pane is repositioned.

NOTE:
 Some panes cannot be moved such as the Templates Browser pane of the Application
Explorer.
 When a pane is tabbed, to turn it into a floating pane or dock it elsewhere, you may need to drag
it by its tab rather than dragging it by the title bar.

EIO0000001309 06/2017 135

User Interface

The following figure shows an example of a tabbed pane that needs to be dragged by its tab to
move it.

Resizing Panes
Typically, panes do not feature a maximize button. Instead, resize them to occupy the entire
workspace.
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.

136 EIO0000001309 06/2017

 User Interface

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 135) to a tab.

EIO0000001309 06/2017 137

User Interface

Using Menus

Context Menus
For many items of Process Expert (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 147) that is indicated
to the right of the command when the item is selected.
NOTE: To close a context menu, press Esc.

138 EIO0000001309 06/2017

 User Interface

Software Participant Windows

Description
The following figure shows an example of an embedded Control Participant window, which opens
by selecting, for example, the Configure, Refine, or Edit command.

1 Restore embedded Participant window

2 Maximize embedded Participant window
3 Close embedded Participant window
4 Extract and maximize Participant window
5 Copy to local Clipboard
6 Paste from local Clipboard
7 Save Participant changes

EIO0000001309 06/2017 139

User Interface

NOTE:
 The other buttons of the Participant window toolbar are task-specific and are described in the
topic documenting the task.
 The features described in this topic are not available in Participant windows that you open from
facet template editors.

Floating Software Participant Windows

When an embedded Participant window is open, you can extract it to a full-screen, floating window
by clicking a button.
You can resize this window, move it around, and display it on another monitor.
You can open several floating windows simultaneously.
The following figure shows an example of a floating Control Participant window (restored down).

1 Open Process Expert context-sensitive help for the UI item that you select outside of the Control Participant
window.
2 Embed floating Participant window
3 Copy to local Clipboard
4 Paste from local Clipboard
5 Save Participant
6 Minimize floating window

140 EIO0000001309 06/2017

 User Interface

7 Maximize floating window (the restore down floating window button is displayed when the floating
Participant window is maximized)

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 Process Expert user interface when the floating
Participant window is maximized.
 You can use the Microsoft® Windows® snap feature:
 When the floating Participant window is displayed full screen, click the title bar and drag it
down to reduce its size. You can also double-click the title bar.
 To maximize it, drag the title bar of the window to the top of the screen and release it. You
can also double-click the title bar.
NOTE: The other buttons of the Participant window toolbar are task-specific and are described in
the topic documenting the task.

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 PC 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 139) 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 PC.
 Paste from local Clipboard button: Pastes strings or graphic elements that you have copied on
the local PC 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.
To copy a data element on the local PC and paste it to the software Participant, proceed as follows.

Step Action
1 On the local PC, 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.

EIO0000001309 06/2017 141

User Interface

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

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

142 EIO0000001309 06/2017

 User Interface

Filtering and Sorting Data

Introduction
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.
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.

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.

EIO0000001309 06/2017 143

User Interface

Item Description
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.
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.

144 EIO0000001309 06/2017

 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.

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.

EIO0000001309 06/2017 145

User Interface

Step Action
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.

146 EIO0000001309 06/2017

 User Interface

Keyboard Shortcuts

Available Keyboard Shortcuts

In Process Expert, 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 123).
Opens or shows the Application Explorer for the system.
Alt+P Navigation button (see page 123).
Opens or shows the Project Explorer for the system.
Alt+T Navigation button (see page 123).
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+V Paste
Del Delete
F2 Rename
F4 Settings (Global Templates)
F12 Read-only (Global Templates)
Shift+F12 Edit (Global Templates)

NOTE: You can abort certain commands (see page 94). Refer to the topic describing the
command for details.

EIO0000001309 06/2017 147

User Interface

148 EIO0000001309 06/2017

 Process Expert
Folders and Instances
EIO0000001114 05/2017

Chapter 10
Folders and Instances

Folders and Instances

Overview
This chapter provides information on the general representation of folders, folder structures and
how you can act on these.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Folder Representation and Structure 150
Common Folder Commands 153
Changing the Folder Structure 154
Assigning Icons to Application Folders 156

EIO0000001309 06/2017 149

Folders and Instances

Folder Representation and Structure

Introduction
The following provides information on the folder representation and structure as you can see it in
the various Process Expert explorers (see page 54).

Folder Representation
The following figure shows the general representation of a closed application, topological, or
Global Templates folder, which contains at least 1 instance, entity, or template respectively.

The following figure shows the general representation of a closed project folder.

The following figure shows the general representation of a closed topological entity folder.

The following figure shows the general representation of an open application, project, or
topological folder containing items.

Callout Description
1 Expand/collapse button.
The buttons appear only for nodes that contain subnodes.
Outlined triangle: The structure is collapsed. Click the button to expand it.
Solid triangle: The structure is already expanded. Click the button to collapse it.
2 Identifier of the folder.
3 Icon indicating the type of folder.
For application folders, you can use the icon to indicate the equipment hierarchy (see page 156).

150 EIO0000001309 06/2017

 Folders and Instances

Callout Description
4 Show/hide instances or devices button.
The button is only available for folders with content, which are parent folders.
NOTE: The button does not appear on Global Templates folders.
5 Collapse folder structure button.
Click the button to collapse the folder structure up to the folder.
6 Restore size button.
Restores the size of the folder.
7 Size to fit button.
Displays only the folder and its subfolders in the tree view.
8 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.
9 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 766) 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.
10 Build diagnostic indicator.
Indicates that the Control Participant performed an analysis (see page 406) of the Participant
project or sections of it and detected that you may not be able to build the project executable
successfully.
Hover with the pointer over the indicator to display a tooltip.

EIO0000001309 06/2017 151

Folders and Instances

Displaying the Folder Structure

Double-click a parent folder to expand the first level of subfolders. If you had expanded the folder
structure previously, the software will restore the structure view to its last expanded state.
Alternatively, right-click the folder and select the Expand command (see page 153).
If the structure is already expanded, double-click a parent folder to collapse the entire structure up
to the folder or right-click the parent folder and select Collapse.
Alternatively, you can click the expand/collapse button (1).
Other methods to navigate through the folder structure may be available and are described in the
topic documenting the corresponding explorer or pane.
NOTE: You can drag a folder that has both parent and subfolders onto the tabs bar. The software
will open a new window in the workspace and display the selected folder as the parent folder, only
showing its subfolders.

Displaying the Folder Content

Double-click the last folder in a structure to open it and display its content. Alternatively, right-click
the folder and select the Expand or Open command (see page 153).
Click the Close button to close the folder or right-click the folder and select Collapse.
NOTE: Except for some Control and Supervision project folders, you cannot open an empty folder.

152 EIO0000001309 06/2017

 Folders and Instances

Common Folder Commands

Overview
When a domain explorer lets you create and/or manipulate folders, the basic contextual menu
commands for folders are identical.
A domain can be, for example, the application or the topology.
Refer to the topic describing the domain explorer for more explorer-specific commands.
NOTE: Commands for folders shown in panes of explorers (for example, in the Application
Browser pane of the Application Explorer) may vary.

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

When you Process Expert...

select...
Expand the first time you click Expand, expands the next level in the folder structure.
The next time you click Expand, displays the folder structure or contents in its last expanded
state.
If the folder has no child level, the command is not available.
Expand All expands each child level in the folder structure.
Collapse collapses the folder structure up to the folder.
The command is available only if the folder is already expanded.
Collapse collapses each child level in the folder structure up to the folder so that when you use the Expand
All command, it expands only the next level in the folder structure.
The command is available only if the folder is already expanded.
Open opens the closed folder.
The command is available only if a folder contains items.
Close closes the current folder.

EIO0000001309 06/2017 153

Folders and Instances

Changing the Folder Structure

Overview
The following describes how to modify the folder representation and structure without changing the
hierarchy of the application.
You can perform these actions by using the Settings pane and by moving folders directly in the
workspace.
NOTE: Refer also to the topic describing how to assign icons to application folders (see page 156).

Changing the Folder Structure Layout

In the Application Explorer, select the number of folders that the software displays horizontally per
hierarchical level (row) in the workspace.
The default value is 2.
The setting applies to the system for which you configure it, to any user who opens the system in
an engineering client, and persists even if you restart the system server.
To change the parameter, proceed as follows.

Step Action
1 In the toolbar of Application Explorer, click the Explorer Layout Settings button (see page 123).
Result: The software opens the Settings pane.
2 Enter a number in the Folders per row field.
Result: When you create folders of the same hierarchical level, the software displays them in the
same row until the number that you have entered is reached and then starts a new row.
NOTE: Changing the setting does not modify the way existing folders are laid out.

Moving Folders Without Changing the Hierarchy

In the workspace of the Application Explorer, to rearrange the way in which folders are displayed,
you can move folders of a same hierarchical level while maintaining the hierarchy:
 From rows to columns.
 From columns to rows.

When used, this operation overrides the Folders per row parameter of the settings pane
(see page 154).
In the Application Browser pane, you can change the order in which folders are displayed when no
sorting is applied.

154 EIO0000001309 06/2017

 Folders and Instances

To move a folder, proceed as follows.

Step Action
1 In the Application Browser pane or the workspace of the Application Explorer, start dragging a
folder along the folder structure until one of the following messages appears as a tooltip:
 Create new row with the item (appears only when moving a folder in the workspace).
 Move before X or Move after X where X is the identifier of the target folder.

2 Release the mouse button.

Result: The software moves the folder depending on the tooltip that was displayed:
 For Create new row with the item: Displays the folder below or above other folders of the
same hierarchy by creating a new row.
 For Move before... or Move after...:
 In the workspace: Displays the folder in the same row, before or after X.
 In the Application Browser pane: Displays the folder before or after X.

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 238).

EIO0000001309 06/2017 155

Folders and Instances

Assigning Icons to Application Folders

Overview
Process Expert lets you assign icons to each application folder level. The icons appear in the tree
view of the Application Browser and the workspace of the Application Explorer.
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 assign an icon to a folder level, proceed as follows.

Step Action
1 Click the Explorer Layout Settings button (see page 123).
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, hover with the pointer over the available icons.
Result: A tooltip describing the icon is displayed.

156 EIO0000001309 06/2017

 Folders and Instances

Step Action
4 Click the icon that you want to use.
Result: The software:
 Assigns the selected icon to each existing folder of the selected level.
 Assigns the selected icon to each new folder that you create in the selected level.

5 Repeat the procedure from step 2 for other levels.

NOTE: To revert to the default folder icon, select a level and select the default folder icon in the
Style menu.

EIO0000001309 06/2017 157

Folders and Instances

158 EIO0000001309 06/2017

 Process Expert
Implementing a System
EIO0000001114 05/2017

Part III
Implementing a System with Process Expert

Implementing a System with Process Expert

Overview
This part describes how to complete the different stages of the system engineering lifecyle to
implement a system, using Process Expert.
The following figure shows the system engineering lifecycle stages:

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
11 Quick Reference Guides 161
12 Managing Systems 173
13 Instantiation Stage 185
14 Project Definition Stage 269
15 Assignment Stage 357
16 Generation Stage 399
17 Refinement Stage 465

EIO0000001309 06/2017 159

Implementing a System

Chapter Chapter Name Page

18 Configuration Stage 497
19 Mapping Stage 571
20 Build Stage 621
21 Deployment Stage 643
22 Execution Stage 711
23 Managing Communication 779

160 EIO0000001309 06/2017

 Process Expert
Quick Reference Guides
EIO0000001114 05/2017

Chapter 11
Quick Reference Guides

Quick Reference Guides

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
System Creation Workflow 162
Task Quick Reference 167

EIO0000001309 06/2017 161

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: 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 779).

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.

162 EIO0000001309 06/2017

 Quick Reference Guides

Systems Explorer

Create system
↓

Application Explorer

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

Topology Explorer

↓
Create topology folder structure (optional)
↓
Create a controller entity
↓
Configure the controller (Participant)
↓
Configure controller properties
↓
Configure station node entities
.
↓

EIO0000001309 06/2017 163

Quick Reference Guides

For Control (simulation) For Supervision

Configure NIC properties I Configure NIC properties
↓ I ↓
Create Unity Pro service I Create VJC and/or OFS service
.
↓
Create device entities
.
↓
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
.
↓
Create an Ethernet network
↓
Create physical connections
↓

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)
↓ ↓

164 EIO0000001309 06/2017

 Quick Reference Guides

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)
↓

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
↓ Vijeo Citect at the station node)
Update Control project ↓
↓ ↓
Start over the life cycle from any point

EIO0000001309 06/2017 165

Quick Reference Guides

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

166 EIO0000001309 06/2017

 Quick Reference Guides

Task Quick Reference

Overview
The tables in this topic provide an overview of the main tasks that you can perform with
Process Expert at each stage of the system engineering life cycle (see page 52) 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 173)
Creating system backups (see page 178)
Restoring systems (see page 180)

Application Explorer Task Quick Reference

System Engineering Life Control Projects Supervision Projects

Cycle Stage
Instantiation stage Browsing templates (see page 191)
(see page 185) Creating instances (see page 204)
Browsing instances and folders (see page 194)
Counting instances (see page 209)
Configuring instances (see page 219)
Linking instances (see page 224)
Managing instances (see page 232) (copy/paste, move, export/import, update/replace
templates)

EIO0000001309 06/2017 167

Quick Reference Guides

Project Explorer Task Quick Reference

System Engineering Life Control Projects Supervision Projects

Cycle Stage
Project Definition stage Creating projects (see page 271) (project Creating projects (see page 312) (project
(see page 269) actions) contents, project actions)
Managing projects and project sections Creating project components
(see page 282) (see page 316)
(order, export, import, manage data backup Managing Projects (see page 339)
files)
(export, import)
Assignment stage Assigning facets (see page 365) Assigning facets (see page 367)
(see page 357) Viewing the application structure in projects
(see page 376)
Managing assigned facets (see page 385) (view assignments, unassign, move,
change order)
Generation stage Generating for the 1st time (see page 406)
(see page 399) Generating equipment hierarchy –
(see page 455)
Generating after changes (see page 445) (auto-assign and generate, regenerate)
Managing generated facets (see page 460) (unassign, reassign, unlink, move)
Managing versions of types –
(see page 413)
Refinement stage Refining projects (see page 467) (viewing Refining projects (see page 492)
(see page 465) the application structure, creating LL984
segments)
Checking consistency (see page 472) Editing pages (see page 493)
Creating network variables (see page 476) Editing advanced project settings, adding
include projects, attaching user files
(see page 494)
Mapping stage Creating Control executables Creating executables (see page 612)
(see page 571) (see page 573)
Mapping services (see page 577) Mapping services (see page 615)
Mapping communication (see page 579) Mapping communication (see page 616)
Mapping network variables (see page 594) (and connecting Modbus devices to
Supervision)
Mapping hardware (see page 605)

168 EIO0000001309 06/2017

 Quick Reference Guides

System Engineering Life Control Projects Supervision Projects

Cycle Stage
Build stage (see page 621) Building projects (see page 623) (also, Building projects (see page 638) (also,
generate and build) generate and build)
Viewing the built Participant project Downloading project files (see page 641)
(see page 629)
Deployment stage Refer to the Topology Explorer task quick Deploying built projects (see page 700)
(see page 643) reference. (to all the station nodes that are service
mapped to the project executable)

EIO0000001309 06/2017 169

Quick Reference Guides

Topology Explorer Task Quick Reference

System Engineering Life Control Projects Supervision Projects

Cycle Stage
Configuration stage Configuring controllers (see page 504)
(see page 497) Configuring station nodes (see page 514) (for Supervision/simulation)
Configuring Modbus TCP and Ethernet IP devices (see page 532)
Configuring PROFIBUS PRM Masters and Decentralized Peripherals (see page 527)
Configuring STB Islands (see page 521)
Configuring Ethernet networks (see page 541)
Connecting to Ethernet networks (see page 543)
Managing the Topology (see page 553) (export, import, update templates)
Managing communication (see page 779) (Modbus TCP Ethernet implicit (I/O
scanning, peer to peer communication)/explicit, Ethernet IP explicit, Modbus serial)
Deployment stage Using the emulated simulator Deploying built projects (see page 700)
(see page 643) (see page 649) (to specific station nodes)
Managing passwords for deployment and
execution operations (see page 655)
Deploying built projects (see page 644)
Re-deploying projects (see page 672)
Deploying project changes (see page 686)
(and undoing online changes)
Deploying controller data (see page 679)
Execution stage Starting/stopping controllers Refer to Executing the Deployed
(see page 711) (see page 720) Supervision Project (see Process Expert,
Synchronizing redundant controllers
Supervision Participant Services, User
(see page 729) Guide)

Refining online (see page 741) (and

importing generated changes, viewing the
application structure)
Updating Control projects (see page 766)
Backing up controller data (see page 748)

170 EIO0000001309 06/2017

 Quick Reference Guides

Global Templates Explorer Task Quick Reference

System Engineering Life Control Projects Supervision Projects

Cycle Stage
Global Templates Managing Global Templates (see page 898) (save, copy, export/import, purge)
Updating and replacing Global Templates (see page 919)

EIO0000001309 06/2017 171

Quick Reference Guides

172 EIO0000001309 06/2017

 Process Expert
Managing Systems
EIO0000001114 05/2017

Chapter 12
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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Organizing Systems 174
Creating Systems 176
Creating System Backups 178
Restoring Systems 180

EIO0000001309 06/2017 173

Managing Systems

Organizing Systems

Overview
Systems that you create are stored in the database of the Process Expert system infrastructure.
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 123).

Systems Explorer Window

The following figure shows the Systems Explorer window.

1 Systems Explorer root folder

2 System folder
3 Systems

174 EIO0000001309 06/2017

 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 Process Expert...

select...
Create creates a system folder or subfolder.
Folder
Create creates a system.
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 180) in the database.

NOTE: Refer also to the topic describing common folder actions (see page 153).

EIO0000001309 06/2017 175

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.

When you select... Process Expert...

Open Application (1) opens the Application Explorer, which allows you to start the Instantiation stage
(see page 185) or access the application of an existing system.
Open Topology(1) opens the Topological Explorer, which allows you to start the Configuration stage
(see page 497) or access the topology of an existing system.
Open Projects(1) opens the Projects Explorer, which allows you to start the Project Definition stage
(see page 269) 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 (see page 178) window, which allows you to create a backup file of the
system.
Properties opens the Properties (see page 177) window of the system.
(1) You can also use the navigation buttons (see page 123) located in the toolbar of the engineering client.

176 EIO0000001309 06/2017

 Managing Systems

System Properties
To access the Properties window of the system, right-click the system and select Properties.
You can 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 507) and station nodes acting as simulator (see page 517) 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.

EIO0000001309 06/2017 177

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 of the Process Expert system infrastructure (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 Process Expert.
When you back up a system, the version of Process Expert is automatically recorded and is
displayed when you restore the system.
NOTE: Backup files are forward compatible between service packs of a same version of
Process Expert. For example, you can restore a backup file created with V4.2 SP1 in V4.2 SP2.

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.
 Supervision include files added by users.
 User files added to Supervision projects.
 OPC Factory Server configuration files.
 Password protection properties (see page 507) for topological entities and their value.

It does not contain:

 The templates that are used by the instances of the application.
 The default Supervision include project.
 Password information (see page 655).

178 EIO0000001309 06/2017

 Managing Systems

NOTE: To be able to restore a backup file (see page 180), these items must be present in the
database of the system infrastructure where you want to restore it. In particular, templates that you
have modified or created are not present in the database of a newly installed or different
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 94). 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.

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 242) from the root folder of the Global Templates explorer because
they are not included in the system backup file but required to restore it.

EIO0000001309 06/2017 179

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 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
Process Expert infrastructure.

Version Compatibility
Backup files are version dependent. You cannot restore system back up files created with another
version of Process Expert. 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 between service packs of a same version of
Process Expert. For example, you can restore a backup file created with V4.2 SP1 in V4.2 SP2. In
such case, a dialog box informs you of the version shift and the software makes the restored
systems compatible with the current service pack 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 178), 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 507) 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 655).

180 EIO0000001309 06/2017

 Managing Systems

Aborting System Restoration

After clicking Restore in the Restore window, the abort icon is displayed in the notification panel
(see page 94). 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 Process Expert 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 Process Expert database (see page 182).
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.

EIO0000001309 06/2017 181

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
Process Expert 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 some
Process Expert 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 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 Process Expert
database changes after restoring it.
The figure shows two systems that exist in the Systems Explorer and their respective name in the
Process Expert database folder.

NOTE: The path to the database folder is

C:\ProgramData\Schneider Electric\Process Expert 4.2\Db.

182 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 183

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 Process Expert database:
 Was System_2 before restoration.
 Is System_3 after restoration.

184 EIO0000001309 06/2017

 Process Expert
Instantiation Stage
EIO0000001114 05/2017

Chapter 13
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 56) for a description of the purpose of this stage.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
13.1 Instantiating Templates 186
13.2 Managing Application Folders and Instances 232

EIO0000001309 06/2017 185

Instantiation Stage

Section 13.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.
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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Organizing the System Application 187
Application Explorer 188
Browsing Application Templates 191
Using the Application Browser Pane 194
Creating Application Folders 198
Creating Instances 204
Counting Instances 209
Accessing Instance Properties 212
Configuring Instances 219
Linking Instances 224

186 EIO0000001309 06/2017

 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 from the Process Expert Global Templates library
to create instances that model the following typical components and functions of a system
application:
 Process objects: Represent the functions of process hardware, for example, motors and valves.
This includes signals from the field and/or variables.
For example, using the $Motor template to 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, using the $TesysTEM template to 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, using the $EMPortQ template to model the management of communication
through the port of a Quantum controller through Modbus TCP explicit messaging.
Refer to Browsing Application Templates (see page 191) 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.

This structure is used in the Supervision project (see page 455) to create a hierarchy of alarms,
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 235) of the application are reflected on the facets
(see page 369) of the impacted instances once these facets are assigned to a Supervision project.

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 277) 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 469) and make
changes online (see page 742).

EIO0000001309 06/2017 187

Instantiation Stage

Application Explorer

Overview
The Application Explorer is composed of:
 The main workspace in which you can view the structure of the application and properties of
folders and instances. This is also the area where you can perform various tasks on folders and
instances.
 The Templates Browser pane, which lets you find the application templates that you need to
create the instances in 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.

Accessing the Application Explorer

To access the Application Explorer, double-click the system in the Systems Explorer.
NOTE:
You can also access the Application Explorer in the following ways:
 Drag the system from the Systems Explorer tree view to the tabs bar or to a docking menu.
 Right-click the system in the Systems Explorer and select Open Application.

Application Explorer Window

The following figure provides a typical view of the Application Explorer window.

188 EIO0000001309 06/2017

 Instantiation Stage

1 Templates Browser pane (see page 191)

2 Application Browser pane (see page 194)
3 System root folder
4 Workspace of the Application Explorer
5 Closed application subfolder with contents
6 Closed, empty application folder
7 Open application parent folder containing instances
8 Search field (see page 189) for folders and instances
9 Button to open the folder Settings pane (see page 154)

Searching Instances and Folders by Using the Application Explorer Search Field
The search field of the Application Explorer lets you find instances 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 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.
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 205) and remains open until
you close it by clicking the close icon. 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.

EIO0000001309 06/2017 189

Instantiation Stage

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

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

Items are shown in both the workspace of the Application Explorer and the Application
Browser pane.
You can also double-click the item.
NOTE: If the instance is hidden because a filter is applied, the instance is not shown
but the border of the folder containing the instance flashes briefly (in the workspace
only).
Edit  For an instance: Opens the Instance Editor window, which lets you edit parameters
of the instance.
 For folder: Opens the Properties window, which lets you edit parameters of the
folder.

You can sort and filter (see page 143) 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.

190 EIO0000001309 06/2017

 Instantiation Stage

Browsing Application Templates

Introduction
The Templates Browser pane of the Application Explorer lets you find the Schneider Electric
Process, Device, Communication, Diagnostic, and Foundation application templates that are
contained in the General Purpose and Foundation libraries of the system server and that you can
use to model the application of the system.
The Templates Browser pane also displays other templates that are contained in the Global
Templates library of the system server.
To be displayed, a template needs to meet the following criteria:
 Template type: Application
 Usability State of either:
 Approved
 Deprecated

Such templates can be the templates that you have created or those of Process Expert segment
libraries, which you can install separately.
By default, filters are applied to display only templates that are:
 Composite templates (see page 43).
 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 filters.

NOTE:
 For a list of available Schneider Electric application templates of the Foundation and General
Purpose libraries and their description, refer to the reference documents (see page 856).
 For information on the naming conventions followed by Schneider Electric templates, refer to
the topic describing the Global Templates library (see page 856).

EIO0000001309 06/2017 191

Instantiation Stage

Templates Browser Pane

1 Filters (the check mark indicates that the filter is applied).

2 Search result. 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. 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.

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 icon or
deleting your entry.
For example, val returns templates that contain val in their identifier, such as $HandValve_UC,
$MValve, and $ControlValve.

192 EIO0000001309 06/2017

 Instantiation Stage

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 Filters

The table describes the filters that are available in the template Browser pane below the search
field 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 state. Yes
Used Displays only the templates that are already used by instances of the No
application.
Using this filter disables the other filters.

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.

Additional Filters and Sorting

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

EIO0000001309 06/2017 193

Instantiation Stage

Using the Application Browser Pane

Overview
The Application Browser pane lets you view, search, sort, and filter folders and instances of your
application.
The pane lets you:
 Create, delete, move, and rename folders and instances.
 Select any combination of folders and instances.
 Paste instances and folders to and from the workspace.
 Toggle between tree and grid view mode, the latter showing only instances.
 Customize the display and the order of columns.

NOTE: In tree view mode, the pane duplicates the folder structure that is shown in the workspace
of the Application Explorer.

Application Browser Pane

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

1 Search field (see page 197) for folders and instances.

2 Button to toggle between tree and grid view mode.

194 EIO0000001309 06/2017

 Instantiation Stage

3 Default columns that are shown in tree view mode and that you can customize (see page 196).
4 System root folder.
5 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 196). Lets you hide the pane and restore it when it is docked.

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 Application Browser Pane

The table describes the various methods that you can use to navigate inside the Application
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.
NOTE: Refer also to the topic describing common folder commands (see page 153).

EIO0000001309 06/2017 195

Instantiation Stage

Moving the Application Browser Pane

By using the pin button, you can choose how to display the Application Browser pane.
You can also move (see page 134) the pane to turn it into a floating window or dock it
(see page 132) to one of the edges of the engineering client window.

Customizing Column Display and Order

By default, the following columns are shown in the Application Browser pane:
 Identifier
 Template

You can show additional optional columns by right-clicking a column header and selecting
Customize.
The following figure shows an example of the Customize dialog box with the optional Version and
Data columns selected.

 The check boxes of columns that are always visible are read-only.
 The Path column is available only in grid view.
 Select/clear a check box to show/hide the corresponding optional column.
When the Customize dialog box is closed, you can change the order of columns by dragging a
column to its new position.
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 205).
NOTE: The order of columns is reset each time you open the Customize dialog box and click Apply.
You cannot move the Identifier column.

196 EIO0000001309 06/2017

 Instantiation Stage

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 icon 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.
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 143) 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.

Sorting and Filtering Folders and Instances

When sorting (see page 146) is applied, it also applied to instances and folders that are created or
modified. The same is applicable for filters.

EIO0000001309 06/2017 197

Instantiation Stage

Creating Application Folders

Overview
You can create application folders to structure your application.
Process Expert lets you structure the application according to the ISA-S88.01-1995 standard for
batch control. You can create and name the application folders according to the physical assets
that you want to represent, and assign icons to the folders (see page 156) 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 250).
 Change the default folder structure (see page 154).

NOTE: Unless mentioned otherwise, you can perform the actions described in this topic from both
the workspace of the Application Explorer and the Application Browser pane (tree view mode).

Creating Application Folders

To create an application folder, proceed as follows.

Step Action
1 Right-click the root folder in the Application Explorer and select Create Folder.
Result: Creates an application folder at the end of existing folders of the same level. The
identifier is in edit mode.
NOTE: To create a subfolder, repeat step 1 at the application folder level.
2 To change the identifier, type it; otherwise, press Enter to accept the default name.

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 select... Process Expert...

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 274), 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 (see page 271), which allows you to start the project definition
stage or access the Control and Supervision projects of the system.
The command is available from the root folder only.

198 EIO0000001309 06/2017

 Instantiation Stage

When you select... Process Expert...

Update Template opens the Update Instance Template window. It lets you update the template that is used by
instances inside the folder and any subfolder 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 select another template to be used
by instances contained in the folder and any subfolders. The template needs to be available
in the Global Templates library on the system server.
At the folder level, the command is available only in the Application Browser pane
(see page 194).
Copy (see page 237) copies folders, their subfolders, and the instances they contain.
The command is not available from the root folder.
Paste (see page 237) pastes the copied items to the selected locations in the system or in another system of the
server.
The command is available if the copied content is valid for the selected target locations.
Export opens a Save As dialog box, which allows you to save the parameters and configuration data
(see page 242) of the folder, its subfolders, and the instances they contain to a file in .xml format.
Import (see page 250) opens an Open dialog box, which allows you to select an export file in .xml format, 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 94). 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 affects the equipment hierarchy (see page 187).
 The command is not available from the root folder and when more than one folder is
selected.
 For folders displayed in the workspace, the command is available only when the folder is
closed.
 In the Application Browser, if the folder has an alias, it is not shown while the identifier is
in edit mode.
Properties opens the Properties (see page 200) window, 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.

NOTE: Refer also to the topic describing common folder commands (see page 153).

EIO0000001309 06/2017 199

Instantiation Stage

Application Folder Properties

To access the Properties window of the application folder, right-click the folder and select
Properties. The window opens inside the folder in the workspace.
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 107).
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
affects the hierarchy of equipment (see page 187).
Alias Optional.
You can assign an abbreviated name to the folder. The alias
can be the same as the folder identifier.
The software uses the alias for the hierarchical naming
function (see page 221).
Default value: Blank
NOTE: In the Application Browser, the alias is shown in
brackets next to the folder identifier.
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 an access control number to the folder.
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.
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 492) 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).

200 EIO0000001309 06/2017

 Instantiation Stage

Tab Item Description

Parameters Parameter_1 Identifier You can use as many folder parameter sets as you require.
... Description Default value: No parameter
Parameter_n
Value
NOTE: Click Add Parameter to add a parameter. Right-click a parameter and select Delete to
delete it.

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 window 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 done in steps
in the same folder structure.

EIO0000001309 06/2017 201

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.

202 EIO0000001309 06/2017

 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).

EIO0000001309 06/2017 203

Instantiation Stage

Creating Instances

Overview
Instances that you create in the folder structure (see page 198) 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, you can perform various actions by using the pointer,
accessing the context menu of the instance, or using keyboard shortcuts.
NOTE: Unless mentioned otherwise, you can perform the actions described in this topic from both
the workspace and the Application Browser pane of the Application Explorer.

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 365).

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 workspace or
in the Application Browser pane of the Application Explorer.
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 232) for information on
productivity tools that are available when working with many application folders and instances.

204 EIO0000001309 06/2017

 Instantiation Stage

Instance Description
Data of instances is displayed:
 In the workspace: In application folders when the folder is open.
 In the Application Browser pane: When the corresponding column is shown (see page 196).

NOTE: For folders, data is displayed only in the Application Browser pane in tree view mode.
The following information is displayed.

Header Description
Icon Displays the icon corresponding to the type of template that the instance uses.
In the Application Browser, a folder icon identifies folders. You can customize the icon
(see page 156).
Identifier For instances, displays the instance identifier, which must be unique for each instance of the
same template. The software calculates the identifier, 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 window or by
using the Rename command (F2).
NOTE:
 You can edit the $Name parameter of an instance in the Instance Editor (see page 212)
or by using the Rename command (F2). 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 221) 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 field is not used for folders.
NOTE:
You can obtain information about the invalid status (see page 217) of an instance in the
Validity Diagnosis window:
 By clicking Invalid.
 When viewing its properties (see page 212).

EIO0000001309 06/2017 205

Instantiation Stage

Header Description
Link Indicates the status of the application interface link of the instance. Possible values:
Valid
Invalid
The field is not used for folders.
NOTE:
You can obtain information about the invalid status (see page 227) of an instance in the
Validity Diagnosis window:
 By clicking Invalid.
 In the Links Editor (see page 224).

Assigned Indicates the assignment status (see page 369) 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 window or the Instance Editor (see page 212) respectively.
Area Displays the value of the $Area parameter for the folder or the instance. You can edit the field
in the Properties window or the Instance Editor (see page 212) respectively.
NOTE: If the value was assigned automatically 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 the Application Browser in grid view mode.

206 EIO0000001309 06/2017

 Instantiation Stage

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

When you select... Process Expert...

Edit Links (1) opens the Links Editor (see page 225), which allows you to link the instance to other
compatible instances of the application through their compatible interfaces.
View Assignments opens the View Assignments window, which lets you verify if the facets that are
(see page 389)(1) referenced by the instance are assigned to a Control or Supervision project:
 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 folder in either case.
NOTE: The command is not available if the Data or Link status of the instance is
Invalid.
Update Template(2) opens the Update Instance Template window. It lets you update the template that
is 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(2)(3) opens the Replace Instance Template window. It lets you replace the template that
the instance is using by another template, which is available in the Global
Templates library on the system server.
Inspect Instance(1) opens the Inspect Instance window, which provides information on the entire
(see page 233) instance configuration, including interface links.

Copy(3) copies the selected instances for pasting within the application of the system or any
(see page 236) other system on the server.

Export(3) opens a Save As dialog box, which allows you to save the instance data to a file in
(see page 242) .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 221) for the instance is enabled.

The concatenated, non-editable aliases are shown on the left of the instance
identifier.
(1) The command is not available when multiple instances are selected.
(2) The command is not available from the workspace of the Application Explorer when multiple instances
are selected inside the same or across folders.
(3) The command is not available from the workspace of the Application Explorer when multiple instances
are selected across folders.

EIO0000001309 06/2017 207

Instantiation Stage

When you select... Process Expert...

Delete (3) 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 369) of these facets changes to Deleted.
NOTE: After confirming the command, the abort icon is displayed in the notification
panel (see page 94). 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 212), 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.
(2) The command is not available from the workspace of the Application Explorer when multiple instances
are selected inside the same or across folders.
(3) The command is not available from the workspace of the Application Explorer when multiple instances
are selected across folders.

208 EIO0000001309 06/2017

 Instantiation Stage

Counting Instances

Overview
Process Expert 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 the activated application size
license allows.
The software does not allow the execution of actions that cause the maximum number of instances
of the application size license to be exceeded.

Viewing Instance Count Information

Instance count and software license information is displayed in the About StruxureWare Process
Expert dialog box (see page 122).
The following figure shows the General tab of the dialog box.

EIO0000001309 06/2017 209

Instantiation Stage

The table describes the information that is displayed in the License Details section.

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.

Click the Systems Details tab to view the current number of instances that exist for each system.

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:
 Instantiation
 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

210 EIO0000001309 06/2017

 Instantiation Stage

Exceeding the Allowed Number of Instances

If one of your actions causes the maximum allowed number of instances that corresponds to the
activated application size 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 242) before deleting them to reuse
them later.)
 Delete systems (you can back up the system (see page 178) before deleting it to reuse it later.)
 Upgrade the application size license (see Process Expert, Licensing Guide).

EIO0000001309 06/2017 211

Instantiation Stage

Accessing Instance Properties

Overview
The Instance Editor opens in the workspace of the Application Explorer and provides access to:
 Control and Supervision services (see page 43), which are provided by the template that the
instance is using.
 Parameter values of the elements (see page 40) of the instance.
 The number of parameters that have been modified.
 The status of the instance.

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 the Application Browser pane of the same client
or by another client connected to the same system server.
 The instance is displayed in the workspace of the Links Editor, either as active or inactive.
(see page 224)
The read-only mode allows you to view instance parameters but not to modify them.

Accessing the Instance Editor

To access the Instance Editor, double-click the instance that you want to configure in the
Application Explorer.
NOTE: You can also access the Instance Editor by right-clicking the instance and selecting
Properties.

212 EIO0000001309 06/2017

 Instantiation Stage

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

1 Instance validity status indicator. An information button is displayed if the Status is Invalid
(see page 217)
2 Save button. Click to save parameter values and propagate changes (see page 369).]
3 Instance pane, which allows you to view Control and Supervision services that the instance
provides and to select optional Control services. By default, nodes are shown expanded.
4 Element displayed in bold indicating that the element contains editable parameters
5 Check box for element selection
6 Counter indicating the number of modified parameters for a node out of the total number of
parameters that exist for that node
7 Counter indicating the number of modified parameters for an element

EIO0000001309 06/2017 213

Instantiation Stage

8 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.
9 Parameters pane, which allows you to configure the parameters of the elements of the instance
that you have selected
10 Optional Hierarchical naming function (see page 221) selection box. The function is enabled by
default.
11 Parameter Filters section (see page 216)
12 Grouped by sorting function for parameters
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 detailed information on the services that are provided by each application
template, refer to the reference documents (see page 856).
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 opposite way, 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.

214 EIO0000001309 06/2017

 Instantiation Stage

Header Description
(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.
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 Control or Supervision 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 Path to the element, which provides the parameters, as shown in the instance pane.
Not available for instances based on a facet template.
Category Category of the parameter.

EIO0000001309 06/2017 215

Instantiation Stage

Header Description
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.
Resolved Value Displays the value after formatting according to the data type.
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 233) 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.

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.

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.

216 EIO0000001309 06/2017

 Instantiation Stage

Filter Description
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.

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 107) 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 107).
 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.

EIO0000001309 06/2017 217

Instantiation Stage

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 227).
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.

218 EIO0000001309 06/2017

 Instantiation Stage

Configuring Instances

Overview
The Instance Editor lets you:
 Select or deselect optional Control and Supervision services, which are provided by the
template that the instance uses.
 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 respective user guides (see page 856).
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 91).

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 439).
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, Process Expert can assign
candidate facets automatically to the same container.
For more information, refer to the topic describing automatic facet assignment (see page 372).

EIO0000001309 06/2017 219

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 104), 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 104) 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 PC 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, the Instance Editor applies the following rules when you edit String data types.

Rule Example
"" returns an empty "Description" returns Description.
string. "Description or Description" is not allowed.
To return " use ^. ^"Description^" returns "Description".
^Description or Description^is not allowed.
To return ^ use ^. ^^Description^^ returns ^Description^.

Naming Rules for Instance Parameters

When you change instance parameter values, verify that they satisfy the Participant specific
naming rules (see page 107) so that the subsequent generation process can complete
successfully.
Further, entering incorrect values may change the Data status (see page 217) of the instance to
Invalid. In such case, saving the instance configuration changes the status of the instance in the
Data column of the folder containing the instance to Invalid.
NOTE: Naming rules may also apply when you use the hierarchical naming function.

220 EIO0000001309 06/2017

 Instantiation Stage

Hierarchical Naming Function

You can use the hierarchical naming function to let the software manage the identifier
(see page 205) 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 in the path of the instance, starting from the system root
folder.
 The $Name (see page 222) 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 107);
otherwise the software displays the status of the instance as Invalid (see page 217).
 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: Process Expert opens the Instance Editor.
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 software opens the Properties window of the folder.
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 or import instances
(see page 232) in the Application Explorer.

EIO0000001309 06/2017 221

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.
Click the field to enter a new name.
Within the application of one system, the resulting instance
identifier 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 107) changes
the instance Status to Invalid (see page 217).
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 $CONDSUM_UL facet). In such case, clicking outside of the field
reverts the name to its previous value.
NOTE: The software changes the $Name parameter of the
instance if the value is not unique anymore within the application
following a paste or import operation (see page 232).
$Description String Click the field to enter a description of the instance.
Default value: Blank.
Instance $Area Integer Click the field to assign an area value.
Range: 1...255
Default value: Blank.
NOTE: If you have assigned an area value to the folder 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 492)
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).

222 EIO0000001309 06/2017

 Instantiation Stage

Selection in the Parameter Data type Description

instance pane
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 detailed information on the parameters of application
templates, refer to the reference documents (see page 856).
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 detailed information on the parameters of application
templates, refer to the reference documents (see page 856).

EIO0000001309 06/2017 223

Instantiation Stage

Linking Instances

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 205) of the device instance remains Invalid.
Link any instance with an Invalid Link (see page 205) status with the Links Editor to change the
status to Valid since it is prerequisite to proceed further in the system engineering life cycle.
For more details, refer to Interface Element Rules Table.
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:
 The instance is being edited.
 The instance is being used in the Links Editor.

In read-only mode (see page 91), you can view existing links of the instance but you cannot create
or modify links.

Naming Rules for Variable Names

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

Instance Appearance
In the Links Editor window, instances appear as follows:
 With a green outline: Applies to the instance that you have selected to open the Links Editor,
which is referred to as active. Only one instance can be active in the same Links Editor window.
 With a gray outline: Applies to instances that you want to link, which are referred to as inactive.

224 EIO0000001309 06/2017

 Instantiation Stage

Accessing the Links Editor

To access the Links Editor, proceed as follows.

Step Action
1 In an application folder, right-click the instance that you want to link to one or more other
instances, and select Edit Links.
Result: The Links Editor window opens and displays the selected instance in the center of the
workspace. The instance is shown as active with a green outline.
NOTE: If you have already linked the selected instance to other instances, the software displays
the already linked instances with a gray outline.

Links Editor Window

The following figure shows an example of the Links Editor window.

EIO0000001309 06/2017 225

Instantiation Stage

1 Instance Browser pane. Displays the instances of the application that you may link to the active
instance. When the application contains many instances, use the search field and/or filters. You
can display instances either in grid view or in tree view mode. By default, the first mode lists
instances in a flat list sorted in ascending alphanumerical order. The second mode reproduces
the folder structure of the application where folders are shown first in the way you arranged them
followed by instances in ascending alphanumerical order. When you select the Edit Links
command from an instance, the folder that contains this instance is opened in the Links Editor
browser so that you can easily locate and use other instances inside the same folder.
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 instance from which you have opened the Links Editor.
4 Inactive instance, which had an existing link with the active instance or which you have made a
link with.
5 Application interface link.
6 Inactive instance, which you have dragged from the Browser pane to the workspace, and which
you can link with the active instance.
7 Application folder that contains the active instance and that opens automatically to let you select
easily another instance to create a link with.
8 Graphic tools (see page 889).
NOTE: You can also move the workspace background (see page 130).

Propagation of Modifications to Instances

Changes that you make to instances through the Instance Editor (for example, identifier or
template) are reflected right away in the Browser pane of the Links Editor.
Certain changes (for example, changing an element selection, which affects interfaces) become
visible once you drag instances to the workspace.
However, instances from which you have opened the Links Editor or that you have dragged to the
workspace for linking are locked for editing.

Viewing Interfaces and Interface Description

Not all interfaces of instances that are displayed in the workspace of the Links Editor are visible by
default. You may need to expand nodes of the interface to show available (green) or unavailable
(gray) interface connectors.
To make an unavailable interface connector 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.

226 EIO0000001309 06/2017

 Instantiation Stage

Viewing Linked Instances

Right-click a link between two instances and select Go to. A submenu displays:
 The identifier of both instances that are linked.
 The element of the instance that exposes the interface and its path.

This feature is helpful when several linked instances are displayed on top of each other in the
workspace of the Links Editor so that you need to scroll to view them. By using this command, you
can instantly view a selected instance without scrolling.

Instance Link Status

The Links Editor displays the Link status of an instance as one of the following:
 Valid: The interface rules and interface element rules that are defined at the template level are
satisfied.
 Invalid: At least 1 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 display the
Validity Diagnosis window, which provides you with information about the cause of the invalid
status.

EIO0000001309 06/2017 227

Instantiation Stage

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

228 EIO0000001309 06/2017

 Instantiation Stage

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.

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 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 212).
5 Shows for each element, the rules that are defined and their status.
6 Filter (see page 143).
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.

EIO0000001309 06/2017 229

Instantiation Stage

Item Description
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.

Linking Instances
To create an interface link to an instance, proceed as follows.

Step Action
1 From the Browser pane of the Links Editor, drag the instance that you want to link next to the active
instance, which is displayed with a green outline in the center of the window.
Result: the software:
 Removes the selected instance from the Browser pane.
 Displays the instance next to the active instance as inactive with a gray outline.

NOTE: If you drag another instance from the Browser pane next to the active instance, this instance
replaces the inactive instance that you had selected previously. The software displays the previously
selected instance in the Browser pane again.
2 From the active or inactive instance, select an interface anchor (green) and when the pointer turns into
a hand, move the pointer away from it while holding down the right mouse button.
Result: An orange line appears and follows the hand-shaped pointer. You can release the mouse button.
NOTE: Press ESC to return to the normal pointer function.
3 Move the hand-shaped pointer over the other instance.
Result: Process Expert automatically highlights compatible interfaces of the instance and snaps the
orange line to the nearest matching anchor.
4 Click to confirm the connection or move the hand-shaped pointer away from the instance to connect the
orange line to another highlighted interface anchor.
Result: When you click, the software
 Links the interfaces of both instances and displays the link as an orange line.
 Rearranges the position of the instances in the window.
 Changes the status of the active instance to Valid if the interface rules are satisfied.

NOTE: To delete the link, right-click the orange line and select Delete. The display then reverts to the
previous state.
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 or with an instance that is displayed in the Browser, refer to Linking Inactive
Instances (see page 231).
6 Repeat steps 1...5 until you have made the required links.
7 Close the Links Editor window.

230 EIO0000001309 06/2017

 Instantiation Stage

Linking Inactive Instances

In order to link an inactive instance, which is displayed with a gray outline in the Links Editor
window to an instance other than the active one, right-click the header of the inactive instance and
select Edit Links.
This turns the inactive instance to active and you can proceed with the linking.

Removing Instances from the Links Editor

You can remove inactive instances from the Links Editor window whether they are linked or not.
To remove an inactive instance, proceed as follows.

Step Action
1 In the Links Editor window, right-click the header of the inactive instance that you want to remove
and select Remove Instance.
Result:
 If the instance is not linked, Process Expert removes the instance and displays it in again the
Browser of the Links Editor.
 If the instance is linked to the active instance, Process Expert displays a dialog box to let you
know that this also removes the interface links associated with the instance that you are
removing.
 Click Yes to proceed. Once removed, the software displays the instance again in the
Browser.
 Click No to cancel the action.

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 window.

EIO0000001309 06/2017 231

Instantiation Stage

Section 13.2
Managing Application Folders and Instances

Managing Application Folders and Instances

Overview
This section describes the Instance Inspector, and the functions that are available in
Process Expert 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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Inspect Instance Window 233
Changing the Application Structure 235
Copying and Pasting Application Folders and Instances 236
Moving Application Folders and Instances 238
Exporting Folders and Instances 242
Modifying the Export File 245
Importing Folders and Instances 250
Updating and Replacing Templates of Instances 258

232 EIO0000001309 06/2017

 Instantiation Stage

Inspect Instance Window

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

Accessing the Inspect Instance Window

In the Application Explorer, 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, which uses the $Motor template.

EIO0000001309 06/2017 233

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 Control and Supervision categories
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 that are used by the parent element.
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 213).

234 EIO0000001309 06/2017

 Instantiation Stage

Changing the Application Structure

Changes Affecting Assigned Supervision Facets

When you change the structure of the application, facets of instances that are assigned to a
Supervision project are affected. The table details these changes and their impact.

Change Impact
Moving an application folder The assignment status of any facets of any instances
that the folder and its subfolders contain is set to Out Of
Modifying the identifier of an application folder
Date.
Moving an instance 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 446).

EIO0000001309 06/2017 235

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 209).
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:
 In the Application Browser, 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 221) 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, 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.

236 EIO0000001309 06/2017

 Instantiation Stage

Aborting Paste Tasks

After selecting the Paste command, the abort icon is displayed in the notification panel
(see page 94). 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 In the workspace or the Application Browser of the Application Explorer, open the folder that
contains the instances that you want to copy.
2 Select the instances.
You can make multiple selections within one application 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 application folder in the Application Explorer 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 In the workspace or the Application Browser of the Application Explorer, right-click the folder that
you want to copy and select Copy.
You can make multiple selections within the application by holding the Ctrl key.
NOTE: In the workspace, If the folder is open, you can right-click the title bar of the folder to
copy the folder and its contents.
2 Right-click the destination application folder in the Application Explorer and select Paste.
You can select multiple folders as targets.
NOTE: If the target is not valid for pasting, the command is not available. For example, if the
target is a subfolder of the copied folder or the copied folder itself. Also, you cannot paste in the
Application Browser in grid view mode.

EIO0000001309 06/2017 237

Instantiation Stage

Moving Application Folders and Instances

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

Both actions change the structure of the application (see page 187). 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 Process Expert had to make changes to folder and/or
instance identifiers to satisfy naming rules, the software displays the Move Summary window
(see page 241) to inform you of the changes that it has made.
NOTE:
You cannot move:
 Instances within a folder.
 A folder to one of its subfolders.

Moving Folders and Instances In the Application Browser

By using the Application Browser, 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.

238 EIO0000001309 06/2017

 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 221) 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, 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.

Moving Instances
To move instances, proceed as follows.

Step Action
1 In the workspace or the Application Browserof the Application Explorer, expand/open the folder
that contains the instances that you want to move.
2 Select the instances that you want to move.
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 129); 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.

EIO0000001309 06/2017 239

Instantiation Stage

Step Action
4 Release the mouse button.
Result: Process Expert:
 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 129); 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: Process Expert:
 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.

NOTE: You can also move folders to change only the layout (see page 154) of the application
folder structure or the display order of folders without changing the folder hierarchy.

240 EIO0000001309 06/2017

 Instantiation Stage

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.

EIO0000001309 06/2017 241

Instantiation Stage

Exporting Folders and Instances

Overview
You can export application folders and/or instances contained therein by using the Export
command of the Application Explorer.
Application folders, instances, interface links, and their respective configuration parameters are
saved to an export file (.xml), allowing you to:
 Move or copy folders and instances to another system.
 Perform bulk processes on instances to create and/or modify (see page 245) them.

For example, you can use the export file to import (see page 250) 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.
Process Expert uses the invariant culture (see page 245) to format parameter values
independently of the language setting that is used on the PC on which you create the export file.
NOTE: You will also need to export templates (see page 904) 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 Process Expert system at the time of import. Instances for which the template is not
present cannot be imported.

Software Version Compatibility

The version of Process Expert that you use to import the information contained in the export file
must be the same as the version used to create the export file; otherwise import may not complete
successfully.

Item Selection
You can select either of the following items 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.
 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.

NOTE:
 From the workspace of the Application Explorer, you can only export instances that are located
in the same folder. To export several instances across folders, select them in the Application
Browser pane.
 In the Application Browser, when you select the Export 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 export only the selected items.

242 EIO0000001309 06/2017

 Instantiation Stage

Export Settings
The table shows the items and their respective parameters that are exported and saved to the file
in .xml format.

Item Parameters
Application folder The folder and any subfolders
Type
Identifier
Action
Alias
Description
Area
NOTE: If the area parameter value is inherited from a parent folder,
the value is not exported and is blank in the export file.
Location
GraphicalLocation
Parameter
ApplicationInstances
ApplicationFolders
Instance The instances of the folder and its subfolders
Type
Identifier
TemplateIdentifier
Version
IsValid
Action
IsHierarchical
Comment
Location
Instance parameters that are configured
ElementSelections
Elements (only those whose check box is selected)
Interfaces

EIO0000001309 06/2017 243

Instantiation Stage

Item Parameters
Interface links The interface links between exported instances
SourcePath
DestinationPath
SourceInterface
DestinationInterface
SourceParent folder
DestinationParent folder
Source instance
Destination instance

NOTE: By default, in the export file (.xml), parameter Action is set to Create (see page 247).

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 94). 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 items, the task may complete before you are able to click
the icon.

Creating the Export File

To export instances and/or folders and create the export file, proceed as follows.

Step Action
1 In the workspace or the Application Browser of the Application Explorer, right-click an item and
select Export
Result: Process Expert opens a Save As dialog box.
2 Select the location and file name for the export file (.xml).
3 Click Save.
Result: Process Expert exports the selected items and creates an export file in the location that
you have selected.

NOTE: If any item 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 window is open, you
cannot create the export file.

244 EIO0000001309 06/2017

 Instantiation Stage

Modifying the Export File

Overview
You can modify the export file (.xml), which you have created during export (see page 242) using
any XML editing software to perform the following actions on application folders and/or instances:
 Create: Creates an item with the parameter values of the export file.
 Update: Locates an item, which has the same identifier as in the export file and applies the
parameter values of the export file.
 Delete: Locates the item, which has the same identifier as in the export file and deletes it.

You can also perform actions on interface links:

 Create or update: A link is created if both the source and the target of the link are created or
updated.
 Delete: A link is deleted as soon as either the source or the target of the link is deleted.

Process Expert applies the changes when you import the modified export file (.xml) into the
application of the system.
For a description of the import function, refer to the topic Importing an External File (see page 250).
NOTE:
 You cannot update the identifier of a folder of the application through import.
 You can combine several actions in the same export file.

Using the Invariant Culture

Use the invariant culture to modify or add parameter values in the export file.
If required, during import Process Expert converts the format according to the language setting that
is used on the target PC.
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 [Link]:mm:[Link] 10.12:30:10.15 translating into
10 days 12 hours 30 min 10 sec
15 msec

EIO0000001309 06/2017 245

Instantiation Stage

Export File Contents

The following figure shows a partial view of the export file that was created by exporting from the
Application Explorer instance Motor_2 from Folder_4.

1 Parameter $Name of the exported instance. The value corresponds to the instance name
2 Instance identifier of the exported instance, which is generated by Process Expert. This is the ID that the
software uses to identify the instance for delete and update actions
3 Folder Action parameter
4 Instance Action parameter
5 Folder identifier
6 Alias, Description, and Area folder properties
7 Description and Area instance properties
8 Follows the element selection of the instance as it is configured in the Instance Editor of the instance with
the parameters for each selection

Instructions When Modifying an Export File

To maintain the consistency of the folder structure and instances contained in the export file:
 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 single instance or single folder, do not modify the
<Location> parameter.
 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.
 Modify only the parameters described in the procedures that appear in this topic.

246 EIO0000001309 06/2017

 Instantiation Stage

The following figure shows an extract of an export file of instance Motor_3, which is located in
Folder_1, a subfolder of Folder_5. The Location parameter of the folders is highlighted.

To Create an Instance
To modify the export file to create a new instance in an existing folder, proceed as follows.

Step Action
1 Open the export file with an XML editing software and change the value of the
parameter $Name (see page 222) to the name of the new instance that you want
to create.
NOTE:
 You must not change the Instance Identifier value as it is generated by the
software.
 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 the parameter $Name to the new name of each
instance.
2 Verify that the parameter Action is set to Create; otherwise replace the value
of the parameter by Create.
3 Save your changes.

EIO0000001309 06/2017 247

Instantiation Stage

To Update an Instance
To modify the export file format to update an existing instance, proceed as follows.

Step Action
1 Open the export file with an XML editing software.
2 For the instance that you want to update, change the value of parameter
Action from Create to Update.
3 Change the value of the parameters (see page 243) that you want to update.
NOTE: You must not change the Instance Identifier value as it is generated by
the software.
4 Save your changes.

NOTE:
If the export file contains information of instances that are linked and you change their $Name
and/or IsHierarchical parameters through update action, you need to change also the
corresponding parameters of the interface link to maintain it:
 SourceInstanceName
 DestinationInstanceName
 SourceInstanceHierarchical
 DestinationInstanceHierarchical

To Delete an Instance And/Or a Folder

To modify the 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 4.

2 Open the export file with an XML editing software.

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

248 EIO0000001309 06/2017

 Instantiation Stage

To Create Folders
To modify the export file to create one or more folders or a folder hierarchy, proceed as follows.

Step Action
1 Open the export file with an XML editing software and verify that the parameter
Action is set to Create for the folders that you want to import; otherwise
replace the value of the parameter by Create.
2 Save your changes.

To Update a Folder
To modify the export file format to update an existing folder, proceed as follows:

Step Action
1 Open the export file with an XML editing software.
2 For the folder that you want to update, change the value of parameter Action
from Create to Update.
3 Change the value of any of the following folder parameters that you want to
update:
 Alias
 Description
 Area
 GraphicalLocation
 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.
4 Save your changes.

EIO0000001309 06/2017 249

Instantiation Stage

Importing Folders and Instances

Overview
You can import into the system application compatible items that are contained in an export file
(.xml) (see page 242) in order to:
 Move instances from one system to another.
 Create new instances and/or folders.
 Update existing instances.
 Update properties of existing folders.
 Delete existing instances and/or folders.

For information on modifying the export file to execute these actions, refer to the topic describing
how to modify the export file (see page 245).
During import, the software first imports items that satisfy applicable rules (for example,
uniqueness of instance identifiers). Once the import of these items is completed, for items for which
the software has detected conflicts, it displays the Import Conflicts dialog box. This dialog box
allows you to modify import settings or cancel the import of conflicting items.
Creating and deleting instances through import affects the instance count (see page 209).
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 topic Browsing Object Templates (see page 191).
 Exporting/importing templates (see page 898).

Software Version Compatibility

The version of Process Expert that you use to import the information contained in the export file
must be the same as the version used to create the export file; otherwise import may not complete
successfully.

Instance Import Behavior

The table describes the import behavior when you configure the export file to create instances.

If Then
Action parameter configuration is incorrect. The instance is not created.
Instance parameters and/or element selection is The values are not imported and the template default
invalid. values are used instead.
The corresponding element selection is set to false.

250 EIO0000001309 06/2017

 Instantiation Stage

The table describes the import behavior when you configure the export file to update instances.

If Then
Action parameter configuration is incorrect. The instance is not updated.
The instance does not exist in the target application. The instance is not updated.
Instance parameters and/or element selection is The instance is not updated.
invalid.
The update action creates a link with another The link is created only if the other instance is
instance. imported as well in the target application.
The instance to be updated is already assigned to a After the update completes successfully, the
project. assignment status of the instance may change.

The table describes the import behavior when you configure the export file to delete instances.

If Then
Action parameter configuration is incorrect. The instance is not deleted.
The instance does not exist in the target application. The instance is not deleted.

Folder Import Behavior

The table describes the import behavior when you configure the export file to create folders.

If Then
Action parameter configuration is incorrect. The folder is not created.
The parameter Action for all the folders in the export Only its subfolders are created if these do not exist
file is set to Create and the parent folder already yet.
exists in the target application. If a subfolder already exists, it is not created but any
lower-level folder in the hierarchy is created if it does
not exist yet. And so on.
The folder hierarchy contained in the export file You have the option not to import the instances but
contains instances. only the folder hierarchy.

The table describes the import behavior when you configure the export file to update folders.

If Then
Action parameter configuration is incorrect. The folder is not updated.
The folder does not exist in the target application. The folder is not updated.
The $Area parameter is updated for a folder. After the import completes successfully, the new
area value of the updated folder is propagated to its
subfolders, unless you had assigned them a different
area value manually.

EIO0000001309 06/2017 251

Instantiation Stage

If Then
The $Alias parameter is updated for a folder. The new alias value of the updated folder is used for
the hierarchical naming function by instances that are
configured accordingly.
The alias value is not updated if it causes any
instance identifier in the folder hierarchy to be non-
unique.

NOTE:
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.

The table describes the import behavior when you configure the export file to delete folders.

If Then
Action parameter configuration is incorrect. The folder is not deleted.
The folder does not exist in the target application. The folder is not deleted.
The folder that you want to delete contains subfolders. The software deletes the subfolders and instances
they contain.

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 94). 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 Explorer at the moment you abort the
task are retained. This corresponds to folders and instances that 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.

252 EIO0000001309 06/2017

 Instantiation Stage

If you click the abort icon after clicking OK in the Import 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 items, 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).

When you import the two tree structures into a system, folders are imported in sequence, tree
structure after tree 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 items 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.

EIO0000001309 06/2017 253

Instantiation Stage

Accessing the Application Import Window

To access the application Import window, proceed as follows.

Step Action
1 In the workspace or the Application Browser of the Application Explorer, right-click the folder in
which you want to import instances or that is to become the parent folder, and select Import.
Result: Process Expert opens a Windows Open file window.
2 Select the export file (.xml) and click Open.
Result: Process Expert opens the application Import window and displays the contents of the
file.
NOTE: If the export file is invalid, the Import window is not opened.

Import Window Description

The following figure provides a typical view of the application Import window.

Header Description
Name Identifier of the folders and name ($Name) of the instances contained in the import file.
The check box allows you to select the instances that you want to import.
By default, instances are selected.
Template type Identifier of the template that instance is using.
Version Version of the template that the instance is using.

254 EIO0000001309 06/2017

 Instantiation Stage

Header Description
Action Indicates the action that the software performs on the selected item according to the
value of the Action parameter in the export file (see page 246):
 Create
 Update
 Delete

Description Contents of the $Description parameter of the item.

Import Settings
In the Import window, you can select the following settings to import instances.

Setting Description
Absolute During import, Process Expert maintains the hierarchy, which existed at the time of export.
path Selected by default.
NOTE: Process Expert creates folders as needed to recreate the original hierarchy.
Relative During import, the folder from which the import function was called becomes the parent folder of
path the imported folder structure. The hierarchy inside the imported folder structure remains
unchanged.

Resolving Conflicts During Import

You can resolve the conflicts that Process Expert detects during import, for example, if the
software detects that you are importing into the application an instance with the same name or
identifier (see page 222) as an already existing instance.
The software displays detected conflicts in the Import Conflicts dialog box. The following figure
shows an example of it.

EIO0000001309 06/2017 255

Instantiation Stage

Item Description
1 Parameter $Name of the instance at the time of export.
2 Identifier of the instance at the time of export.
3 Identifier of the template that the instance uses.
4 Parameter $Name of the instance as it appears in the file that you are importing, and that the software has
modified to satisfy applicable naming rules.
5 Identifier of the instance after import considering the new instance name and the location where you are
importing the instance.
6 Buttons that let you select an action for individual instances:
 Skip: The instance is not imported.
 Update: Default action. Updates the existing instance of the application with the applicable parameter
configuration of the import file. The name and identifier of the instance are not modified.
 Create: Creates a new instance with the applicable parameter configuration of the import file by using the
new instance name and new instance identifier.
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 Instances
To import the content of an export file (.xml) into the system application, proceed as follows.

Step Action
1 In the application Import window, select:
 The instances that you want to import.
 The import settings that you want to apply.

2 Click OK.
Result: If you select to import with relative path, the software displays a confirmation dialog box.
NOTE: Click Cancel to close the Import window without importing any item.
3 Click OK.
Result: If the software does not detect conflicting items, it:
 Imports the contents of the file and applies the import settings that you have selected.
 Displays the imported instances and folders in the tree view of the Application Explorer.
 Displays the result of the import process in the Notification Panel.

If it detects conflicts, it:

 Imports the instances that satisfy import rules and applies the import settings that you have
selected.
 For conflicting instances, displays the Import Conflicts dialog box; proceed to step 4.

256 EIO0000001309 06/2017

 Instantiation Stage

Step Action
4 In the Import Conflicts dialog box, select the actions that you want Process Expert to perform for
conflicting instances.
NOTE: Click Cancel to close the Import 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: Process Expert:
 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 tree view of the Application
Explorer.
 Displays the result of the entire import process in the Notification Panel.

EIO0000001309 06/2017 257

Instantiation Stage

Updating and Replacing Templates of Instances

Overview
In the Application Explorer, you can perform the following actions on the template that is used by
an instance. 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: Both commands are also available in the Topological Explorer for certain topological
entities (see page 555).

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.

258 EIO0000001309 06/2017

 Instantiation Stage

Accessing the Commands

Update Template Right-click one instance, a selection of several instances in the same folder, 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.
The command is not available at the folder level in the workspace of the Application Explorer.
NOTE: To use the commands on multiple instances selected across multiple folders, work in the
Application Browser pane.

Description of the Functionality

Process Expert 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 a usability state of Approved.

NOTE: Refer to Importing Templates (see page 908).

EIO0000001309 06/2017 259

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.

260 EIO0000001309 06/2017

 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 389).

EIO0000001309 06/2017 261

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.

262 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 263

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. You can use the functionality to assign candidate facets
automatically (see page 372).

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 through interface links (Links Editor), update the templates of these
instances at once (see page 266) to maintain the links.

264 EIO0000001309 06/2017

 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 413).
NOTE: To determine the version of a type that is used by a facet, open the facet encapsulating the
type from the Global Templates explorer. The element representing the type contains the version
in its header (for example, DEVCTL (1.20).

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, the software
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.

EIO0000001309 06/2017 265

Instantiation Stage

Item Selection In the Application Browser

In the Application Browser, when you select the Update Template or Replace Template command
for a folder, 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.

Updating the Template of One Instance

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

Step Action
1 In the workspace or the Application Browser of the Application Explorer, 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 of the application folder.
 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 In the workspace or the Application Browser of the Application Explorer, 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.

266 EIO0000001309 06/2017

 Instantiation Stage

Step Action
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 of the application folder.
 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.

Replacing Templates of Instances

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

Step Action
1 In the workspace or the Application Browser of the Application Explorer, select one or more
instances and/or one or more folders.
Result: Process Expert 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 menu.
Result: The software displays the list of templates that are available for the replace operation.
4 Find the template that you want to use by scrolling or entering a keyword in the field of the menu.
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 of the application folder.
 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.

EIO0000001309 06/2017 267

Instantiation Stage

268 EIO0000001309 06/2017

 Process Expert
Project Definition Stage
EIO0000001114 05/2017

Chapter 14
Project Definition Stage

Project Definition Stage

Overview
This chapter provides 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 62) 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 Control Project Definition Stage 270
14.2 Managing Control Projects 282
14.3 Supervision Project Definition Stage 310
14.4 Creating Supervision Project Components 316
14.5 Managing Supervision Projects 339

EIO0000001309 06/2017 269

Project Definition Stage

Section 14.1
Control Project Definition Stage

Control Project Definition Stage

Overview
This section describes how to use the Project Explorer to create the Control project 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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Creating a Control Project 271
Creating Control Project Sections 276

270 EIO0000001309 06/2017

 Project Definition Stage

Creating a Control Project

Before Creating a Control Project

At this stage of the system engineering life cycle, you need to know:
 Which family of controllers (see page 504) you will be using to run the Control project.
 How you will organize the function block diagram (FBD) sections of the project.

Accessing the Project Explorer

In the tree view of the Systems Explorer, right-click the system in which you want to define a
Control project and select Open Projects.
Process Expert opens the Project Explorer window.

Project Explorer Window

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

1 System root folder

2 Control project (expanded view to show contents)
3 MAST task folder containing program sections. You can view facets that are assigned to a section.
4 Control executables folder containing several executables, which can be deployed to topological entities.

EIO0000001309 06/2017 271

Project Definition Stage

Project Explorer Root Folder Actions

Right-click the system root folder of the Project Explorer to display a task menu with the following
commands.

When you select... Process Expert...

Create Control creates a new Control project that is associated to one of the supported controller
Project families, and displays it in the tree view of the Project Explorer.
Import Control opens an Open dialog box, which allows you to create a Control project by importing
Project data of a project that was created with Unity Pro software. The project data needs to be
(see page 306) contained in an export file in .stu or .xef format.
Create Supervision creates a new Supervision project, and displays it in the tree view of the Project
Project Explorer.
(see page 312)
Open Application opens the Application Explorer, which allows you to start the instantiation stage or
access the application of the system.
Open Topology opens the Topological Explorer (see page 274), 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
(see page 284) information of the Control and Supervision projects that exist in the system.
Import opens an Import dialog box, which allows you to display the compatible contents of an
(see page 288) export file (.sbk) in the Import window. You can import entire Control and/or Supervision
projects, or parts of them into the system.

NOTE: Refer also to the topic describing common folder actions (see page 153).

Creating the Control Project

To create the Control project, proceed as follows.

Step Action
1 In the Project Explorer, right-click the system root folder, select Create Control Project, and the
platform of the controller that is associated to the project.
Result: The software creates a new Control project associated to the family of controller that you
have selected, and displays it in the tree view.
NOTE: Refer to Control Project Properties (see page 274) for information on the association of
a Control project with a controller family.

NOTE: In each system, you can create as many Control projects as needed. For example, you can
create a project, which is designed for a Quantum controller in the plant and a project, which is
designed for an M340 controller for test purposes in the laboratory.

272 EIO0000001309 06/2017

 Project Definition Stage

Control Project Contents

By default, a Control project contains the following folders.

Folder name Description

Tasks Contains the MAST and FAST task folders, in which you can create FBD sections
(see page 276) to assign Control facets of the instances of the application.
FBD and non-FBD sections that are created during refinement or by import are also
displayed. Non-FBD sections are sections in any of the following languages: IL, LD, LL984,
SFC, and ST.
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 467) at the project level and save it:
 The Control project is contained in a database of an earlier version of Process Expert
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 178) of Process Expert.
Services Contains the ControlExecutive subfolder.
Executables Contains the ControlExecutable_n executables that you create (see page 573) for the
Control project, and which are required for the mapping, build and deployment stages.
The folder is empty when you create the project.

Control Project Actions

Right-click the Control project to display the project task menu with the following commands.

When you select... Process Expert... Applies to

Assign Facets opens the Assignment Editor (see page 274), which allows you to Assignment stage
assign instances to the FBD sections of the MAST and FAST task (see page 358)
folders.
Generate starts a process to create or update the logic of the entire Control Generation stage
(see page 441) Participant project.
Refine opens the Control Participant, which allows you to make changes to Refinement stage
the logic of the project. (see page 466)
Manage Network Opens the Manage Network Variables dialog box, which allows
Variables creating, modifying, and deleting network variables. These are
(see page 487) variables that are used to share data by using peer to peer
communication.
Manage Data Backup opens the Manage Data Backup FIles dialog box, which lets you view Project Definition
Files (see page 308) and delete data backup files that exist for Control Participant project. stage
The command is available only if, at least, one data backup file exists.
ReGenerate starts a process to recreate the logic of the entire Control Participant Generation stage
(see page 446) project from the beginning.
NOTE: Certain changes that you have made during refinement may
be discarded.

EIO0000001309 06/2017 273

Project Definition Stage

When you select... Process Expert... Applies to

Export (see page 284) opens a Save As dialog box, which allows you to create an export file Project Definition
containing the Control project information. stage
Delete (see page 275) deletes the Control project including any: –
 Subfolders
 Assignments
 Executables (see page 574)

Rename allows you to enter a new identifier for the project, which needs to be –
unique within the system.
Properties opens the Properties window, which allows you to edit the properties –
of the Control project.

NOTE: Refer also to the topic describing common folder actions (see page 153).

Control Project Properties

To access the Properties window of the Control project, 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.
Click the field to edit it and press Enter to validate the entry.
Default value: ControlProject_n where n is an incremental number starting at
1.
Description Optional.
You can enter a description of the project with free text.
Controller Value Indicates the hardware family that you have associated to the project at
family creation time.
The value can be one of the following:
 Quantum
 M340
 M580

You cannot edit this item.

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 defined.

274 EIO0000001309 06/2017

 Project Definition Stage

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 folders of the project and their contents, including any assignments, and mappings.
 Deletes any associated project files (for example, data backup files).

NOTE: You cannot delete a Control project if any executable of the project is deployed
(see page 643).
To delete a Control project, proceed as follows.

Step Action
1 In the Projects Explorer, right-click the Control project and select Delete.
Result: The software deletes the entire project and removes it from the tree view.

EIO0000001309 06/2017 275

Project Definition Stage

Creating Control Project Sections

Overview
In the Project Explorer, you can create only FBD sections in a Control Participant project.
You can create non-FBD sections by:
 Refining (see page 467) the Control Participant project and creating the sections.
 Refining the Control Participant project online (see page 741), creating the sections, and
updating (see page 766) the Control project.
 Importing (see page 288) the sections.

Creating FBD Sections

To create an FBD section in the MAST or FAST task folder, proceed as follows.

Step Action
1 In the Project Explorer, right-click the MAST or FAST folder and select Create FBD Section.
Result: The software creates a new FBD section in last position and with the default identifier in
edit mode.
NOTE: When the MAST or FAST folders are open, you can also create an FBD section by right-
clicking the folder title bar and selecting Create FBD Section.
2 To create another FBD section in any position, right-click the section where you want to insert
the new one and select Insert FBD Section.
Result: The newly created section is inserted and has the order of the section that you had right-
clicked. The order of the section that you right-clicked and those below is incremented by 1.

NOTE: Process Expert automatically creates FBD sections in the MAST task folder during the
assignment stage if you have not created them already. For more information, refer to the Control
project Assignment stage (see page 365).

276 EIO0000001309 06/2017

 Project Definition Stage

Section Description
Open the MAST or FAST task folders to view existing FBD and non-FBD sections.
The figure shows an example of the Containers pane containing three FBD sections and four non-
FBD sections in grid view mode.

item Description
1 Unique identifier of the section.
Refer to Section Properties (see page 281) for a description of the field.
2 Indicates the order in which the software generates the sections of the Control project.
You can change the order of sections (see page 283).
For more detailed information on how the software manages the section order, refer to the
generation function description (see page 447).
NOTE: The order is not shown in tree view mode.

EIO0000001309 06/2017 277

Project Definition Stage

item Description
3 Icon indicating the language of the section.
4 Filter button (see page 143).
5 Button to toggle between grid view (default) and tree view mode (see page 376).
The tree view mode allows you to view sections to which facets are assigned in relation to the
folder structure of the application.

The figure shows the same 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.
Select any node and press the plus (+) or minus (-) key to expand or collapse the node and its
subfolders.
NOTE: Predefined folder icons (see page 156) that you may have assigned in the application
to various folder levels are not represented.
2 Section identifier.
3 Special root folders (see page 376).

278 EIO0000001309 06/2017

 Project Definition Stage

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 217)
 Deleted: The section is generated (see page 399) 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 Assignment viewer.
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 395) inside a section.
The software applies the order only during:
 A first generation (see page 406)
 A regeneration (see page 452)

For more detailed information on how the software manages the facet order,
refer to the generation function description (see page 409).
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 439) for a

description of the assignment status.

EIO0000001309 06/2017 279

Project Definition 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 438) for a description of the
generation status.

NOTE: The information in the Assignments pane is available only for FBD sections.

Section Actions
Right-click a section to open the section task menu with the following commands.

When you Process Expert...

select...
Insert FBD creates a new FBD section (see page 276) in the position of this section.
Section
Generate Refer to Generation Stage (see page 399).
The command is only available for FBD sections.
Refine Refer to Refinement Stage (see page 466).
The command is not available for LL984 sections.
ReGenerate Refer to Generation Stage (see page 452).
The command is only available for FBD sections.
Delete deletes the section.
If you have assigned (see page 358) facets to the section, the software:
 Unassigns (see page 387) any facets contained in the FBD section that you are deleting.
 Change the System status (see page 439) of the facets to Not assigned.

The command is not available when the Properties window of the section is open.
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 452) 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.

280 EIO0000001309 06/2017

 Project Definition Stage

When you Process Expert...

select...
Rename lets you edit the identifier of the section.
Press Enter to validate your entry.
Properties opens the Properties window of the section inside the task folder.

Section Properties
To access 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.
Click the field to edit it and press Enter to validate the entry.
The identifier must be unique within the Control project.
The software allows only the use of identifiers that satisfy the naming rules
(see page 108).
Description Optional.
You can enter a description of the section with free form text.
Generated On Date and time of the last successful generation or regeneration of the
section.
The property is read-only and contains information only for FBD sections.

EIO0000001309 06/2017 281

Project Definition Stage

Section 14.2
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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Control Project Section Order 283
Exporting a Control Project 284
Importing a Control Project 288
Importing a Unity Pro Project 306
Managing Data Backup Files 308

282 EIO0000001309 06/2017

 Project Definition Stage

Control Project Section Order

Overview
Process Expert assigns an order to sections, starting at 0, and displays it in the Containers pane.
The values appear in the Order column.
The order corresponds to 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 446) the entire project or a section of the project.
 Regenerate (see page 452) 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 467) the Control
Participant project or by refining the deployed Control project online (see page 741) and updating
the Control Participant project.

Moving Sections
In the Projects Explorer, you can move sections only within the Containers pane of a 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 in a Control project of the Project Explorer, proceed as follows.

Step Action
1 In the Containers pane of the MAST or FAST task folder, clear filters (see page 146).
Result: The software displays the existing sections in increasing order from top to bottom
(depending on sorting that is applied).
2 Drag one section up or down to a new position.
Result: The software displays a tooltip, which indicates the position that the section will occupy.
3 Release the mouse button.
Result: The software inserts the section at the selected position and modifies the values of the
Order column.
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 395).

EIO0000001309 06/2017 283

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 288) 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 579) and/or peer to peer
communication data (see page 594) 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 the Project Explorer, 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 339).

Software Version Compatibility

The version of Process Expert that you use to import the information contained in the export file
must be the same as the version used to create the export file; 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 290).
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.

284 EIO0000001309 06/2017

 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.

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.

EIO0000001309 06/2017 285

Project Definition Stage

Export Settings
The table describes which Control project information you can export.

Item Selected for Description

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.
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 287).
Built Participant Unselected Represents the built Control Participant file (.stu).
Project by default
Backups By default You can select data backup files individually.
The time stamp and description of each backup file
(see page 748) are shown. The format of the time stamp is
YYYYMMDDHHMMSS.

286 EIO0000001309 06/2017

 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 dialog box, the abort icon is displayed in
the notification panel (see page 94). 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 and create an export file, proceed as follows.

Step Action
1 In the Project Explorer, right-click the Control project that you want to export and select Export.
Result: The software opens the Export window 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 software closes the Export window and opens an Export dialog box.
NOTE: If you click Cancel, the software closes 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 containing the selected Control project information.
NOTE: If you click Cancel, the software closes the Export dialog box without creating the export
file and discards the selection you made in the Export window.

EIO0000001309 06/2017 287

Project Definition Stage

Importing a Control Project

Overview
The import functionality lets you import data of a Control project from an export file (.sbk), which
was created by using the export (see page 284) functionality of the Project Explorer of
Process Expert.
You can import this data into an existing system by using the Import command 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 579). You need to import either the complete communication channel and/or peer to
peer communication data (see page 594) 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 345) as well.

Software Version Compatibility

The version of Process Expert that you use to import the information contained in the export file
must be the same as the version used to create the export file; 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 108) 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 472).

288 EIO0000001309 06/2017

 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 300).
Constituent File (FBD By default The Constituent File is selected if the imported FBD section
sections only) identifier does not exist in the target project.
You cannot unselect the item.
NOTE: The Constituent File is cleared by default if the
imported section identifier already exists in the target
project. Selecting it impacts the import behavior
(see page 292).
Services By default Includes the ControlExecutive.
You cannot unselect the item.
Executables By default You cannot unselect the item.
(1) The information needs to be contained in the export file to be selected.

EIO0000001309 06/2017 289

Project Definition Stage

Item Selected for Description

import(1)
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 Unselected Represents the Control Participant file (.stu).
by default
Backups By default You can select data backup files individually
The time stamp and description of the backup file
(see page 748) 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 308) and
Deploy Data dialog box (see page 679).
(1) The information needs to be contained in the export file to be selected.

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.

290 EIO0000001309 06/2017

 Project Definition Stage

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 300), even empty. (see page 232) of the
A dialog box opens (see page 303) 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 298) 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 212).
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 557) 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.

EIO0000001309 06/2017 291

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.

292 EIO0000001309 06/2017

 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 212) 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 [Link] 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

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.
– The item does not exist

EIO0000001309 06/2017 293

Project Definition Stage

Contents of export file Item in Control project Result in Control project of target system after import
selected for import of target system
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 287) of both
the consumer and the owner projects and the corresponding elements are selected for import.
 The I/O scanner functionality 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 580).
 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 298).
If the software is not able to import communication mappings, a dialog box opens (see page 304)
indicating the reason.
The software updates the Build State (see page 630) of a built executable after import depending
on each 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 the service,
hardware, and communication mappings. These rules are described in the following tables of this
topic.

294 EIO0000001309 06/2017

 Project Definition Stage

The table describes the import rules that apply to Built executables based on different scenarios
when a Control project with the same identifier already exists in the target system.

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 when a
Control project with the same identifier already exists in the target system.

Contents of Item in Control Result in Control project of target system after import
export file project of target
selected for system
import
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 Exists Hardware mapping of the target project is updated with the
mapping 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.

EIO0000001309 06/2017 295

Project Definition Stage

Contents of Item in Control Result in Control project of target system after import
export file project of target
selected for system
import
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 287) 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 580).
 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 298).

296 EIO0000001309 06/2017

 Project Definition Stage

Contents of Item in Control Result in Control project of target system after import
export file project of target
selected for system
import
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 287) of both the consumer and the
owner projects and the corresponding elements are selected for
import.
 The I/O scanner functionality 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 580).
 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 298).

EIO0000001309 06/2017 297

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 292) 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.

298 EIO0000001309 06/2017

 Project Definition Stage

The following figure illustrates the import example by showing the Control projects that exist in the
target system and the contents of the export file that is selected.

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

EIO0000001309 06/2017 299

Project Definition Stage

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 748) 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.

Accessing the Project Import Window

To access the Import window, proceed as follows.

Step Action
1 From the Systems Explorer, right-click the system into which you want to import the Control
project and select Open Projects.
Result: The software opens the Project Explorer.
2 Right-click the system root folder and select Import.
Result: The software opens the Import dialog box.
3 Browse to the export file (.sbk) that contains the Control project information 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 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 305).

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.

300 EIO0000001309 06/2017

 Project Definition Stage

The following figure shows an example of the Import window displaying the contents of a Control
project export file.

EIO0000001309 06/2017 301

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 Indicates either of the following:
 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 290).
 At the executable level: A project-related topological object (see page 290) 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 Indicates that 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.

302 EIO0000001309 06/2017

 Project Definition Stage

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.
Containers are grouped by Participant if you are importing also Supervision projects, then by
project.

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.
Copy Copies the contents of the Details section to the Clipboard.

EIO0000001309 06/2017 303

Project Definition Stage

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.
Copy Copies the contents of the Details section to the Clipboard.

304 EIO0000001309 06/2017

 Project Definition Stage

Aborting Import Tasks

The abort icon is displayed in the notification panel (see page 94) at two different stages of
theimport process:
 After clicking Open when you select the export file (see page 300). 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, 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
NOTE: Click Cancel to close the
selection.
Import window without importing
 Proceeds with the import.
Control project data.
 Replaces existing communication mapping if you had
selected to import them.
 Displays an import summary dialog box.

3 In the Project Explorer, right-click the The software opens the Control Participant window.
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 475). displays a notification to report findings once the check is
completed.
5 Take the necessary corrective actions -
(see page 475).

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.

EIO0000001309 06/2017 305

Project Definition Stage

Importing a Unity Pro Project

Overview
The import function allows you to create a Control project in the Project Explorer by importing data
of a project that was created using Unity Pro software, and which is contained in an external file
(.stu or .xef).
After import, you will have access to the same functions from the project folder as if you had
created the project in the Project Explorer.

Project Compatibility
To be able to import a project created with Unity Pro, the following requirements need to be met:
 The version of Unity Pro 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 Unity Pro PlantStruxure DTM Library that is installed in Unity Pro 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.

Import Settings

Project data contained in the file Contained in the Visible in the Project Explorer after import
(stu or .xef) Control Participant
project after import
FBD sections Yes Yes
Sections appear in their respective MAST and
Sections in the following Yes
FAST task folders.
programming languages:
 Ladder Diagram (LD)
 Instruction List (IL)
 Structured Text (ST)
 Sequential Function Chart
(SFC)
 Ladder Logic 984 (LL984)

Constituents of any section Yes No

Refine the imported project to view the
Configuration No
information.
Other global project information Yes
(for example, variables, types, NOTE: Only data related to the program
project 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.

306 EIO0000001309 06/2017

 Project Definition Stage

Project data contained in the file Contained in the Visible in the Project Explorer after import
(stu or .xef) Control Participant
project after import
Project platform Yes Yes
Family attribute (see page 274).

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 Unity Pro Control Project

To import a Unity Pro Control project into an existing system, proceed as follows.

Step Action
1 From the Systems Explorer, right-click the system into which you want to import the Unity Pro
Control project and select Open Projects.
Result: The software opens the Project Explorer.
2 Right-click the system root folder and select Import Control Project.
Result: The software opens an Open dialog box.
3 Select the file format that you want to import.
4 Browse to the location of the Unity Pro project file that you want to import and click Open.
Result: The software creates a Control project and displays it in the tree view of the Project
Explorer.

EIO0000001309 06/2017 307

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 748) 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 143) the information that is displayed.

Accessing 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 Explorer 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 exist for the executables of ControlProject_1.

Column Description
header
Time Stamp Date and time of the backup file creation.
Description Description that was entered when the backup file was created.

308 EIO0000001309 06/2017

 Project Definition Stage

Column Description
header
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

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.

EIO0000001309 06/2017 309

Project Definition Stage

Section 14.3
Supervision Project Definition Stage

Supervision Project Definition Stage

Overview
This section describes how to use the Project Explorer to create the Supervision project of the
system and its components.
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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Internal Supervision Architecture 311
Creating a Supervision Project 312

310 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 311

Project Definition Stage

Creating a Supervision Project

Accessing the Projects Explorer

In the tree view of the Systems Explorer, right-click the system in which you want to define a
Supervision project and select Open Projects.
Process Expert opens the Project Explorer window.

Project Explorer Window

The following figure provides a typical view of the Project Explorer window, displaying a
Supervision project.

1 System root folder

2 Supervision project (expanded view to show contents)
3 Pages folder (collapsed view) to which you assign Genie facets
4 Project cluster (expanded view) containing the Tags, Services, ClientEvents, and ServerEvents folders
5 Project Tags folder (collapsed view) to which you assign Supervision data facets

312 EIO0000001309 06/2017

 Project Definition Stage

6 Project Services folder (expanded view) which represents the I/O, alarm, trend, and report servers as well
as clients that are mapped to station nodes. The I/O server contains the I/O devices, and the
communication components
7 Project Executables folder (expanded view), which contains the executables of the Supervision project that
you deploy to station nodes

Project Explorer Root Folder Actions

Right-click the root folder of the Project Explorer and display a task menu with commands
(see page 272).
NOTE: Refer also to the topic describing common folder actions (see page 153).

Creating the Supervision Project

To create the Supervision project, proceed as follows.

Step Action
1 In the Project Explorer, right-click the system root folder and select Create
Supervision Project.
Result: The software creates a new Supervision project with the default
identifier in edit mode, and displays it 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 Contents

By default, a Supervision project contains the following folders.

Folder Description
Pages Contains the pages that you create for the Supervision project and that are:
 The containers to which you assign Supervision Genie facets when you
edit the page (see page 493) in the Refinement stage.
 The graphical interface of the Supervision software, which allows you to
view and control the system, and access navigation services.
The folder is empty by default.

EIO0000001309 06/2017 313

Project Definition Stage

Folder Description
Cluster_1 A cluster is an organizational mechanism in a Supervision project
representing logical groups of servers that run across several physical
machines.
By default, each cluster folder contains the following empty subfolders:
 Tags, which displays the tag containers of the project and the
Supervision data facets of the instances of the application that you have
assigned to them.
 Services, which contains the I/O, alarm, trend, and report servers as well
as the Supervision clients of the project.
 ClientEvents. Container to assign to the Supervision project client event
facets, which are executed by the report server during runtime.
 ServerEvents. Container to assign to the Supervision project server
event facets, which are executed by the report server during runtime.
Executables Contains the executables that you create for the Supervision project and
that are required for the Mapping stage (see page 612) and the Deployment
stage (see page 699).
The folder is empty by default.

Supervision Project Actions

Right-click the Supervision project to display the project task menu with the following commands.

When you select... Process Expert... Applies to

Create Cluster creates a new cluster with its default contents and Project Definition
(see page 326) displays it in the tree view. stage
Assign Facets opens the Assignment Editor, which allows you to Assignment stage
assign Supervision data facets of instances to (see page 385)
containers of the project.
Generate starts a process that manages: Generation stage
 Tags from Supervision data facets. (see page 460)
 Report events from Supervision server event
facets.
 Events from Supervision client event facets.

The software merges the data to create the logical

Supervision Participant project.
Refine opens the Supervision Participant, which allows you to Refinement stage
modify the project. (see page 492)

314 EIO0000001309 06/2017

 Project Definition Stage

When you select... Process Expert... Applies to

Advanced Settings opens the Supervision Participant, which allows you to Refinement stage
(see page 494) change advanced project settings that will be activated
in the station nodes where you deploy the Supervision
project.
Include Projects opens a dialog box, which allows you to:
(see page 494)  Add external Include projects to be deployed to the
Supervision nodes.
 To remove Include projects that are attached to the
Supervision and stored in the contents repository.
NOTE: You cannot add an include project if the
software has already added to the Participant project
an include project with the same name.
Attach User Files opens a dialog box, which allows you to:
(see page 495)  Attach external files to be deployed to the
Supervision nodes.
 To remove files that are attached to the Supervision
project and stored in the contents repository.
Export (see page 340) opens a Save As dialog box, which allows you to create Project Definition
an export file containing the Supervision project stage
information.
Delete deletes the Supervision project including subfolders –
and assignments.
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.

NOTE: Refer also to the topic describing common folder actions (see page 153).

Supervision Project Properties

To access the Properties window of a Supervision project, right-click the Supervision project folder
and select Properties.
You can edit the following items.

Item Description
General Identifier The identifier must be unique within the system.
Click the field to edit it and press Enter to validate the entry.
Default value: Supervision_n where n is an incremental
number starting at 1.
Description Optional.
You can enter a description of the project with free text.

EIO0000001309 06/2017 315

Project Definition Stage

Section 14.4
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 configuration files (.xml) are automatically
generated (see page 638) based on the configuration of properties of the Supervision project
components.
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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Creating Supervision Tag Containers 317
Creating Supervision Pages 323
Creating Clusters 326
Creating Supervision Servers and Clients 327
Creating I/O Devices 331
Creating Communication Ports 333
Implementing Redundancy 336

316 EIO0000001309 06/2017

 Project Definition Stage

Creating Supervision Tag Containers

Overview
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 845) 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. VJC Data facets representing device-specific data
are assigned to each container.
NOTE: Process Expert automatically creates one tag container during the assignment process
(see page 364) if you have not created it yet.

Creating Supervision Tag Containers

To create a tag container, proceed as follows.

Step Action
1 Right-click the Tags folder and select Create Tag Container.
Result: The software creates a new tag container with the default identifier in edit mode.
NOTE: When the Tags folder is open, you can also create a tag container by right-clicking the
folder title bar and selecting Create Tag Container.

Tag Container Description

Open the Tags folders to view the tag containers that exist.
The following information is displayed in the Containers pane.

Column Description
header
Identifier The identifier must be unique within a Supervision project of the system.
Refer to Tag Container Properties (see page 320) for a description of the parameter.
Order Not applicable to Supervision projects.

EIO0000001309 06/2017 317

Project Definition Stage

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 217)
 Deleted: The section is generated (see page 399) 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 Assignment viewer.
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 395) inside a section.
The software applies the order only during:
 A first generation (see page 406)
 A regeneration (see page 452)

For more detailed information on how the software manages the facet order,
refer to the generation function description (see page 409).
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 439) for a

description of the assignment status.

318 EIO0000001309 06/2017

 Project Definition 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 438) for a description of the
generation status.

Tag Container Actions

Right-click the tag container to open the container task menu with the following commands.

When you select... Process Expert...

Generate starts the generation process to populate new tags, update out-of-date tags, and/or
(see page 441) remove deleted tags in the Supervision Participant project.
To generate the containers of the Tags folder, right-click the folder, and select
Generate.
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.

The command is not available when the Properties window of the tag container is open.
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 generated
constituents in the logical Participant project when you generate the project.
Rename allows you to enter a new identifier for the tag container.
Properties displays the Properties window, which allows you to edit the properties of the tag
container.

EIO0000001309 06/2017 319

Project Definition Stage

Tag Container Properties

To access 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.
Click the field to edit it. Press Enter to validate the entry.
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).
Attributes ScanTime The acquisition time for the tags that are assigned to the container.
msec
Default value: 0
Protocol The protocol to communicate with the I/O device and that is to be used
to configure the I/O device.
Default value: OFSOPC
NOTE: The protocol needs to be supported by the Supervision
Participant. However, when you use control module templates of the
Global Templates library and assign their Supervision facets to the
Supervision project, only OFSOPC is supported.
(1) The parameter becomes read-only when Protocol is different than OFSOPC. In such case, the value
that was selected last for the parameter is used.

320 EIO0000001309 06/2017

 Project Definition Stage

Item Description
Attributes Direct TCP IP Sets the addressing mode for the TCP IP driver in the OPC Factory
Addressing Server (OFS) configuration file. Select the mode depending on the
Mode(1) Modbus TCP topological entity (see page 616) that is mapped to the
associated I/O device in the Communication Mapping tab.
Possible values:
 Unallocated/Allocated Data, PAC Modicon (/U) (default):
Corresponds to selecting UNITY in the PLCs section of the Device
address wizard in the OFS 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.
NOTE: The value shown in brackets corresponds to the suffix that is
appended to the device address in the OFS configuration file. For more
information, refer to Editing the Device Network Address in the help of
OPC Factory Server (see page 123).
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.

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. In such case, the value
that was selected last for the parameter is used.

EIO0000001309 06/2017 321

Project Definition 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 367). If you create the I/O device
manually (see page 331), 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. In such case, the value
that was selected last for the parameter is used.

322 EIO0000001309 06/2017

 Project Definition Stage

Creating Supervision Pages

Prerequisites
Generate the Supervision project before creating pages.

Creating Supervision Pages

To create a page, proceed as follows.

Step Action
1 Right-click the Pages folder and select Create Page.
Result: The software creates a new page with the default identifier in edit mode.
NOTE: When the Pages folder is open, you can also create a page by right-clicking the folder
title bar and selecting Create Page.

Page Description
Open the Pages folder to view the pages that exist.
The following information is displayed in the Containers pane.

Column Description
header
Identifier The page identifier must be unique within a Supervision project of the system.
Refer to Supervision Page Properties (see page 325) for a description of the parameter.
Order Not applicable to Supervision projects.

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 217)
 Deleted: The section is generated (see page 399) 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.

EIO0000001309 06/2017 323

Project Definition Stage

Column Description
header
Facet Identifier of the template that the facet is using.
Template
Path Path to the facet in the Assignment viewer.
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 395) inside a section.
The software applies the order only during:
 A first generation (see page 406)
 A regeneration (see page 452)

For more detailed information on how the software manages the facet order,
refer to the generation function description (see page 409).
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 439) for a

description of the assignment status.
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 438) for a description of the
generation status.

324 EIO0000001309 06/2017

 Project Definition Stage

Supervision Page Actions

Right-click a Supervision page to open the page task menu with the following commands.

When you select... Process Expert...

Generate starts the generation process to update out-of-date genies, and/or remove deleted
(see page 441) genies in the Supervision Participant project.
To generate the pages of the Pages folder, right-click the folder, and select Generate.
Edit (see page 493) opens the Supervision Participant, which allows you to assign to the page animated
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.
Delete deletes the page including assignments of animated graphics.
The command is not available when the Properties window of the page is open.
Rename allows you to 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.
Default value: Page_n where n is an incremental number starting at 1.
Click the field to edit it. Press Enter to validate the entry.
The software allows only the use of identifiers that satisfy the naming
rules (see page 108).
Description Optional.
You can enter a description of the page with free text.
Generated On Date and time of the last successful generation of the page (read-only).

EIO0000001309 06/2017 325

Project Definition Stage

Creating Clusters

Creating a Cluster
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 folder and displays it in the tree
view of the project.

Cluster Actions
Right-click the cluster folder to display the cluster task menu with the following commands.

When you Process Expert...

select...
Generate starts the generation process to populate the tag database of the Supervision
Participant project.
Delete deletes the cluster including its contents and unassigns the assigned
Supervision data facets.
The command is not available when the Properties window of the page is
open.
Rename allows you to enter a new identifier for the cluster.
Properties opens the Properties window, which allows you to edit the properties of the
cluster.

NOTE: Refer also to the topic describing common folder actions (see page 153).

Cluster Properties
To access 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.
Default value: Cluster_n where n is an incremental number
starting at 1.
Click the field to edit it. Press Enter to validate the entry.
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 text.

326 EIO0000001309 06/2017

 Project Definition Stage

Creating Supervision Servers and Clients

Overview
In Process Expert, you can create Supervision servers in the Services folder of the cluster of the
project.
The I/O server instance represents a server that is set up on an operation server
(see Process Expert, Installation and Configuration Guide), on which Supervision and OPC
Factory Server software are installed. The operation server is represented in the topology of the
system by a station node (see page 514), 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.

Creating Supervision Servers

To create I/O, alarm, trend, and report servers for the Supervision project, proceed as follows.

Step Action
1 Right-click the Services folder and select Create IO Server.
Result: The software creates a new I/O server with the default name in edit mode, and displays
it in the tree view.
2 Right-click the Services folder and select Create Alarm Server.
Result: The software creates a new alarm server with the default name in edit mode, and
displays it the Services tab.
3 Right-click the Services folder and select Create Trend Server.
Result: The software creates a new trend server with the default name in edit mode, and
displays it the Services tab.
4 Right-click the Services folder and select Create Report Server.
Result: The software creates a new report server with the default name in edit mode, and
displays it the Services tab.

NOTE: Process Expert 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 367).

EIO0000001309 06/2017 327

Project Definition Stage

Supervision I/O Server Properties

To access the Properties window of an I/O server, right-click the server folder and select
Properties.
You can edit the following items.

Item Description
General Identifier The identifier must be unique within the Supervision project.
Default value: IOServer_n where n is an incremental number starting at 1.
Click the field to edit it. Press Enter to validate the entry.
Description Optional.
You can enter a description of the server with free text.
Attributes Port Communication port the server listens on.
Default value: 2082.
Click the field to edit it. Press Enter to validate the entry.
Legacy Port Communication port that is used for legacy connections to the server.
Default value: 2078.
Click the field to edit it. Press Enter to validate the entry.

Supervision Servers Common Properties

To access the Properties window of a server, open the Services folder, right-click the server, and
select Properties.
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.
Click the field to edit it. Press Enter to validate the entry.
Description Optional.
You can enter a description of the server with free text.

328 EIO0000001309 06/2017

 Project Definition Stage

Item Description
Attributes Port Communication port the server listens on.
Default value:
 Alarm server: 2080
 Report server: 2084
 Trend server: 2085

Click the field to edit it. Press Enter to validate the entry.
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

Click the field to edit it. Press Enter to validate the entry.
Database Port Property of alarm servers only.
Communication port the server database listens on.
Default value: 5482
Click the field to edit it. Press Enter to validate the entry.
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.

Creating Supervision Clients

In Process Expert, you can create Supervision Clients in the Services folder of the cluster of the
project.
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 folder and select Create Client.
Result: The software creates a new client and displays it in the Services folder.

EIO0000001309 06/2017 329

Project Definition Stage

Supervision Client Properties

To access the Properties window of a client, right-click the client, and select Properties.
You can edit the following items.

Item Description
General Identifier The identifier must be unique within the Supervision project.
Default value: Client_n where n is an incremental number starting at 1.
Click the field to edit it. Press Enter to validate the entry.
Description Optional.
You can enter a description of the client with free text.

330 EIO0000001309 06/2017

 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 317) for data of the second controller and associate this tag container to the second I/O
device.
NOTE: Monitoring data of a device (see page 845) 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.

Creating I/O Devices

To create an I/O device, proceed as follows.

Step Action
1 Expand the Services and the IOServer folders, and right-click the IODevices. Select Create IO
Device.
Result: The software creates a new I/O device with the default name in edit mode.
NOTE: You need to create an I/O server first.

NOTE: Process Expert 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 367).

I/O Device Properties

To access the Properties window of the I/O device, right-click the I/O device, and select Properties.
You can edit the following items.

Item Description
General Identifier The identifier must be unique within the Supervision project.
Default value: IODevice_n where n is an incremental number starting at 1.
Click the field to edit it. Press Enter to validate the entry.
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 text.

EIO0000001309 06/2017 331

Project Definition Stage

Item Description
Attributes Address Alias name in the OPC Factory Server software to communicate with the
controller.
The field is used when you select OFSOPC as the communication protocol
between the controller and the I/O device.
User defined.
Default value: Alias_IODevice_n where n corresponds to the
incremental number used for the I/O device identifier.
Click the field to edit it. Press Enter to validate the entry.
StartupMode Select the role of the I/O device in terms of communication with the
controller:
 Primary (default value)
 Standby
 None

You can only associate one primary I/O device with each tag container.
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

Memory Select 1 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.
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 367)
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 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 367)
during the assignment of Supervision data facets or with the one that you
have created manually.

332 EIO0000001309 06/2017

 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 can access these components from the Communications folder (see page 312) of the
Supervision Participant project.

Creating a Communication Board

To create a communication board, proceed as follows:

Step Action
1 Expand the Services and IOServer folders, right-click the Communications
subfolder, and select Create Board.
Result: The software creates board with the default identifier in edit mode.
NOTE: You need to create an I/O server first.

NOTE:
 Process Expert 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 367).
 Deleting a communication board deletes the associated communication ports.

Communication Board Properties

To access the Properties window of the communication board, right-click the communication board
folder, and select Properties.
You can edit the following items.

Item Description
General Identifier The identifier must be unique within the Supervision project.
Default value: Board_n where n is an incremental number
starting at 1.
Click the field to edit it. Press Enter to validate the entry.
Description Optional.
You can enter a description of the board with free form text.

EIO0000001309 06/2017 333

Project Definition Stage

Item Description
Attributes Type Indicates the protocol for communicating with the I/O device
and that is to be used for configuring the I/O device.
Default value: OFSOPC when the board is created by the
software.
To edit the field, click it and enter the new name. Press Enter
to validate the entry.
Address Default value: 0 when the board is created by the software.
To edit the field, click it and enter the new name. Press Enter
to validate the entry.

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 Process Expert, Supervision Participant Services, User Guide).

Creating Additional 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 folder, right-click the Board_n folder, and select Create
Port.
Result: The software creates a communication port with the default identifier in
edit mode.
NOTE: You need to create a communication board first (see page 333).

NOTE: You can delete communication ports by right-clicking the port, and selecting Delete.

Communication Port Properties

To access the Properties window of the communication port, open the Board_n folder, right-click
the communication port, and select Properties.
You can edit the following items.

Item Description
General Identifier The identifier must be unique within the Supervision
project.
Default value: Port_n where n is an incremental number
starting at 1.
Click the field to edit it. Press Enter to validate the entry.
Description Optional.
You can enter a description of the port with free text.

334 EIO0000001309 06/2017

 Project Definition Stage

Item Description
Relationships IoDevice Select the I/O device that is associated with the
communication port from the menu.
The I/O device (see page 331) 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 367) during the assignment of Supervision
data facets. If you have created the I/O device manually,
associate it with the port.

EIO0000001309 06/2017 335

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, starting from a typical Supervision project composed 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 112), which
describes how to build redundancy into a system.

I/O Server Redundancy

To implement I/O server redundancy, proceed as follows.

Step Action Refer To

1 From the Services folder of the Supervision project, create a second I/O server. Project definition
2 From the Services folder, create a client for this second I/O server. stage

3 From the Communications folder of the second I/O server, create a

communication board.
4 From this Board folder, create a communication port.
5 From the IODevices folder of the second I/O server, create an I/O device.
6 In the Properties window of the second I/O device, associate the I/O device with
the tag container of the Supervision project, which is already associated with 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 Properties window, configure the CommunicationPort property as
Port_2, which is the port of the communication board that you have created in
step 4.
8 In the Properties window of the communication port of the second I/O server,
verify that the port is associated to the standby I/O device under IODevice.

336 EIO0000001309 06/2017

 Project Definition Stage

Step Action Refer To

9 From the system root folder, create a station node entity representing the second Configuration
I/O server. stage
10 In the Properties window of the NIC of this station node, configure the IP address
of the NIC.
11 On this station node, create one VJC and one OFS instances.
12 Connect this station node to the Ethernet network.
13 Once you have generated the complete Supervision project, from the project Mapping stage
executable, map the second I/O server to the station node that you have created
in step 9 (service mapping).
14 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).
15 Configure the physical PCs according to the topology of the system, build, and Build and
deploy the Supervision project. Deployment
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 folder 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 in the Properties window.

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 VJC 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 PCs according to the topology of the system, build, and Build and
deploy the Supervision project. Deployment
stage

EIO0000001309 06/2017 337

Project Definition Stage

Network Redundancy
To implement network redundancy, proceed as follows.

Step Action Refer to

1 From the station node entity representing the I/O server, create a second NIC. Configuration
stage
2 In the Properties window of the second NIC, configure its IP address.
3 Connect the second NIC of the station node to the Ethernet network.
4 Configure the physical PCs according to the topology of the system, build, and Build and
deploy the Supervision project. Deployment
stage

NOTE: No specific action is required in the Supervision project.

338 EIO0000001309 06/2017

 Project Definition Stage

Section 14.5
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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Exporting a Supervision Project 340
Importing a Supervision Project 345

EIO0000001309 06/2017 339

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 288) function 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 the Project Explorer, 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 282).

Software Version Compatibility

The version of Process Expert that you use to import the information contained in the export file
must be the same as the version used to create the export file; 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 348). Use the export-import functionality (see page 557) 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.

340 EIO0000001309 06/2017

 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.

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 sections that contain facets with such states 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.

EIO0000001309 06/2017 341

Project Definition Stage

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 187) is exported.
Logical Participant Project By default Participant project settings including the project properties.
Unselecting the item also deselects any page and tag
container of the project.
Pages folder 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 folder 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.

342 EIO0000001309 06/2017

 Project Definition Stage

Item Selected for Description

export
Services folder 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.
folder You cannot unselect the item.
IODevices folder 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 Unselected Represents the Supervision Participant file (.ctz) (includes the
Project by default OPC Factory Server configuration files (.xml)).

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 94). 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.

EIO0000001309 06/2017 343

Project Definition Stage

Exporting a Supervision Project

To export a Supervision project and create an export file, proceed as follows.

Step Action
1 In the Project Explorer, right-click the Supervision project that you want to export and select
Export.
Result: The software opens the Export window and displays the Supervision project that you
have selected.
2 Select the project components that you want to export.
3 Click OK.
Result: The software closes the Export window and opens an Export dialog box.
NOTE: If you click Cancel, the software closes 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 containing the selected Supervision project
information.
NOTE: If you click Cancel, the software closes the Export dialog box without creating the export
file and discards the selection you made in the Export window.

344 EIO0000001309 06/2017

 Project Definition Stage

Importing a Supervision Project

Overview
The import function allows you to import data of a Supervision project from an export file (.sbk),
which was created by using the export (see page 284) function of the Project Explorer of
Process Expert.
You can import selected data into an existing system using the Import window.
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 288) as well.

Software Version Compatibility

The version of Process Expert that you use to import the information contained in the export file
must be the same as the version used to create the export file; 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.
Logical Participant Project By default Participant project settings including the project properties.
Unselecting the item also deselects any page and tag container
of the project.
Pages folder 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.
Cluster_n By default At least one cluster must be selected.
You cannot unselect a cluster when the export file contains only
one cluster.
(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.

EIO0000001309 06/2017 345

Project Definition Stage

Item Selected for Description

import(1)
Tags folder 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 Constituent By default The Constituent File is selected if the imported tag container
File identifier does not exist in the target project.
You cannot unselect the item.
Unselected The Constituent File is unselected for import by default if the
by default imported tag container identifier already exists in the target
project.
Services folder 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.
folder You cannot unselect the item.
IODevices folder 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
(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.

346 EIO0000001309 06/2017

 Project Definition Stage

Item Selected for Description

import(1)
Executable_n By default or If the target system already contains an executable with the
not same identifier, you cannot select the executable for import.
selectable Else, you can select each executable and its contents
individually.
Selecting an executable automatically selects any associated
mapping.
Service Mappings By default or If a service mapping already exists in the target system, you
not cannot select the service mapping for import.
selectable Constains 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,
Mappings not you cannot select the communication mapping for import.
selectable Contains data related to the communication mapping.
Built Participant Unselected Represents the built Supervision Participant file (.ctz) (includes
Project by default the OPC Factory Server configuration file (.xml).
(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 Include Projects

At the time of import, Process Expert checks whether the content repository of the target system
contains an Include 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 Include project with the same identifier.

EIO0000001309 06/2017 347

Project Definition Stage

Header Description
Identifier The identifier of the Include 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 Include project that is in the content repository.
Version in contents By selecting this check box, you use the version of the Include 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 Include project that is contained
file in the export file (see page 356) and overwrite the version that is in the repository.

Include projects contain data related to Supervision constituents (for example, genies, tags, and
so on), which can be shared by several templates.
Replacing the existing Include project has an impact on:
 The templates that use the contents of the Include project.
 The Supervision Participant projects to which the Include project is associated.

NOTICE
LOSS OF DATA
Resolve an Include project conflict that arises during the import of a Supervision Participant
project by selecting the correct version of the Include project to be imported.
Failure to follow these instructions can result in unusable Supervision projects.

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.

348 EIO0000001309 06/2017

 Project Definition Stage

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 the Supervision project that you are and page containers to which such facets to 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
Valid). that can be imported (see page 353), (see page 232) of the
even empty. Application Explorer to
A dialog box opens (see page 355) asking import missing instances.
you to confirm the partial import.  Create instances. This may
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
selected. The notification panel provides select the corresponding
information about the facet that is not element.
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 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 212).
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 of functionality (see page 557) of
(service and/or communication) that you 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).

EIO0000001309 06/2017 349

Project Definition Stage

Import Rules for the Equipment Hierarchy

In order to generate the equipment hierarchy (see page 187), when you select a project in an
export file, and a project with the same identifier exists in the target system, following the import
process, the software sets the Assignment state of any facet to Out Of Date, if any of the following
conditions are met:
 The facet does not exist in the target project and the Constituent File (see page 350) of the tag
container is selected.
 A facet with the same identifier exists in the target project but the location of the facet in the
hierarchy of the application in the export file is different than the location of the facet in the
hierarchy of the application in the target project.
NOTE: The software applies the truncation rules (see page 350) during import.

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.

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 212) 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.

350 EIO0000001309 06/2017

 Project Definition Stage

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 Facet1 Tag – Facet1 from export file with status from export file.
container1 container1
Tag Facet1 Tag Facet1 Facet1 from export file with status from export file.
container1 container1
Tag Facet1 Tag Facet2 Facet1 from export file with status from export file.
container1 container1 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 Facet3 – – Tag container2 with Facet3 from export file with status
container2 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
Section identifier is identical
Tag Facet1 Tag – Facet1 from export file with status non-generated.
container1 container1
Tag Facet1 Tag Facet1 Facet1 from target system with same status.
container1 container1
Tag Facet1 Tag Facet2 Facet1 from target system with status non-generated.
container1 container1 Facet2 from target system with same status.
– The item does not exist

EIO0000001309 06/2017 351

Project Definition Stage

Import Rules for Executables and Mappings

The software updates the Build State (see page 628) of a Built executable after import depending
on the scenario.
The software applies import rules to executables and mappings (service and communication) if the
system into which you are importing a Supervision project already contains a Supervision project
and an executable with the same identifier.
The table illustrates the import rules that apply to 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 project of Result in Supervision project of target system
selected for import target system after 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 Exists Communication mapping from target system is
mapping not changed.
Communication Does not exist Communication mapping is created with the
mapping mapping information from the export file.

Accessing the Project Import Window

To access the Import window, proceed as follows.

Step Action
1 From the Systems Explorer, right-click the system into which you want to import the Supervision
project and select Open Projects.
Result: The software opens the Project Explorer.
2 Right-click the system root folder and select Import.
Result: The software opens an Import dialog box.
3 Browse to the export file (.sbk) that contains the project information 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.

352 EIO0000001309 06/2017

 Project Definition Stage

Project Import Window

The Import window allows you to 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.

EIO0000001309 06/2017 353

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 Indicates the following:
 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 348).
 At the executable level:
 An executable with the same identifier already exists in the target project.
 A project-related topological object (see page 348) 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 Indicates that the item contains at least one subitem that is tagged with a red dot.
The item can be imported partially only.

354 EIO0000001309 06/2017

 Project Definition Stage

Confirmation Dialog Box for Sections 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. Containers are grouped by Participant if you are also importing Control projects, 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.
Copy Copies the contents of the Details section to the Clipboard.

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 94). 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.

EIO0000001309 06/2017 355

Project Definition Stage

Importing a Supervision Project

Include projects contain data related to Supervision constituents (for example, genies, tags, and
so on), which can be shared by several templates.
Replacing the existing Include project has an impact on:
 The templates that use the contents of the Include project.
 The Supervision Participant projects to which the Include project is associated.

NOTICE
LOSS OF DATA
Resolve an Include project conflict that arises during the import of a Supervision Participant
project by selecting the correct version of the Include 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, 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
Include project names it displays the Resolve Content Conflict dialog box (see page 347).
 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 Include project with the one contained
in the export file that you are importing.
 Select Version in contents repository to keep the existing Include 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.

356 EIO0000001309 06/2017

 Process Expert
Assignment Stage
EIO0000001114 05/2017

Chapter 15
Assignment Stage

Assignment Stage

Overview
This chapter provides information to help you assign facets of instances of the application to the
Control and Supervision projects that you have defined 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 65) 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 Assigning Facets of Instances 358
15.2 Managing Assigned Facets 385

EIO0000001309 06/2017 357

Assignment Stage

Section 15.1
Assigning Facets of Instances

Assigning Facets of Instances

Overview
This section describes how to use the Project Explorer to assign Control and Supervision facets of
instances to the projects of the system. 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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Assignment Editor 359
Assigning Control Facets of Instances 365
Assigning Supervision Facets of Instances 367
Assigned Facet Description 369
Automatic Facet Assignment 372
Viewing the Application Structure in Control Projects 376

358 EIO0000001309 06/2017

 Assignment Stage

Assignment Editor

Accessing the Assignment Editor

In the tree view of the Project Explorer, right-click the Control or Supervision project to which you
want to assign facets and select Assign Facets.
Process Expert opens the respective Assignment Editor window.
NOTE: You can also access the Assignment Editor through the Assignment Viewer
(see page 389).

Assignment Editor Window

The window of 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 provides a typical view of the Assignment Editor window for Control projects.

EIO0000001309 06/2017 359

Assignment Stage

The following figure provides a typical view of the Assignment Editor window for Supervision
projects.

1 Instances pane. Shows the compatible instances of the application

2 Facets pane. Shows Participant-specific facets referenced by the items that are selected in the Instances
pane
3 Containers pane. Shows Participant-specific sections or containers of projects to which you can assign
facets
4 Assignments pane. Shows facets that are assigned to the container that is selected in the Containers pane
5 Button to show/hide the Candidate column
6 Button to toggle between the grid and the tree view in the Instances pane
7 Button to show or hide facets in the Facets pane
8 Check box to enable automatic assignment of candidate facets

360 EIO0000001309 06/2017

 Assignment Stage

The table describes the information that the Assignment Editor displays in the 4 panes.

Column Description
header
1 Instances pane
Displays the instances of the application that have a valid Data and Link
status.
Toggle between the following display modes by clicking the button (6):
 Tree view (default): Displays the instances in a folder structure with the
same hierarchy as defined in the Application Explorer.
 Grid view: Displays the instances in the form of a list without hierarchical
structure.
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
State to a project of 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 Explorer.
The column appears only if you have selected the grid view display mode.
Candidate The column only appears if you click the Show candidate column button (5):
 Done: Facets of the instance are already assigned to this Control or
Supervision project.
 Candidate: The instance contains at least one facet that you can assign to
this Control or Supervision project.
Description Contents of the $Description parameter of the instance.
2 Facets pane
By default, the pane is empty.
Click the button (5) to show or hide facets to display:
 In grid view mode: The facets of the instance that is selected in the
Instances pane.
 In tree view mode: The facets of the instances that are contained in the
hierarchy of the item that is selected in the Instances pane.
To view the facets of any instances that are displayed in the Instances
pane, select the system root folder.
NOTE: Supervision genie facets are not displayed.
Instance Identifier of the instance that references the facet.
Instance Identifier of the template that the instance that references the facet is using.
Template
Icon Indicates the type of the facet:
 Blue: Control facet
 Orange: Supervision data facet

EIO0000001309 06/2017 361

Assignment Stage

Column Description
header
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 389).
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.

3 Containers pane
For a Control project, the pane displays:
 The identifier of the project to which you are assigning facets.
 The function block diagram (FBD) sections that the MAST and FAST task
folders of the project contain.
For a Supervision project, the pane displays:
 The identifier of the project to which you are assigning facets.
 The tag containers that the Tags folder of the project contains.
 The ClientEvents and ServerEvents folders that the cluster of the project
contains.
 The pages that the Pages folder of the project contains.

Path Path to the container in the tree view of the Project Explorer.
Container Identifier of the project and of sections or containers.
4 Assignments pane
Displays the Control or Supervision facets that you have assigned to the containers or the
project that is selected in the Containers pane.
For a description of the information that is displayed, refer to the topic Assigned Facet
Description (see page 369).

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.

362 EIO0000001309 06/2017

 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:
 To view only the instances with status Candidate, use the filter on the Candidate column.
 To narrow the display to part of the application, switch to tree view mode and expand an
application folder.

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.

Assignment Methods
You can assign facets in two ways, by dragging an instance or folder from the Instances pane to
either:
 The Assignments pane: The software assigns facets to the section or container that is selected
in the Containers pane.
 A section or container of the Containers pane: The software assigns facets to this section or
container.

EIO0000001309 06/2017 363

Assignment Stage

You can also assign:

 Any candidate facet of the entire project by selecting the system root folder and dragging it to
the Assignments pane or the Containers pane.
 Individual facets by selecting one or more facets in the Facets pane and dragging them either
to the Assignments pane or the Containers pane as described earlier.
 Facets automatically (see page 372): Applies to remaining candidate facets of instances, which
already have at least 1 facet assigned to a Participant project.
NOTE: The first method (assignment to the Assignments pane) is described in the next pages of
this section.

Automatic Container Creation

If no FBD section or tag container exists for a project, or if no existing container is selected in the
Containers pane and you assign facets of an instance, Process Expert creates the following
containers and assigns the candidate facets to them:
 One FBD section for each instance in the MAST task folder for Control projects.
 One tag container for the first cluster of Supervision projects.

The name of the container is:

 For FBD sections: The concatenation of
instance identifier_instance template identifier.
NOTE: For Schneider Electric templates, the $ prefix is omitted.
 For tag containers: TagContainer_n, where n is an incremental number starting at 1.
NOTE: Process Expert cannot create FBD sections if their identifier does not satisfy the applicable
naming rules (see page 108).
NOTE: The software also creates a container if you assign a facet from the Facets pane.

364 EIO0000001309 06/2017

 Assignment Stage

Assigning Control Facets of Instances

Before Starting
To assign Control facets of instances, you must have completed:
 The Instantiation stage (see page 185)
 The Control Project Definition stage (see page 270)

You can only assign facets of instances that have a valid Data and Link status (see page 205).
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 395).

EIO0000001309 06/2017 365

Assignment Stage

Assigning Facets
To assign facets of instances to FBD sections of the Control project, proceed as follows.

Step Action Result

1 Verify that the instances are displayed in The Assignment Editor displays the valid (see page 205)
tree view mode in the Instances pane, instances of the application in tree view mode.
else click the toggle button (6)
(see page 359).
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 (6).
2 In the Containers pane, select the FBD  The name of the selected FBD section appears in the
section to which you want to assign title bar of the Assignments pane.
facets by clicking it.  The contents of the FBD section is displayed (empty by
default).
3 From the Instances pane, drag to the title  The message Drag items here to assign facets of
bar of the Assignments pane either: instances to <section identifier> appears in the title bar
 One or more folders of the Assignments pane while you are dragging.
 One or more instances  The Control facets that have a status of Candidate are
 A combination of both assigned to the FBD section and displayed in the
Assignments pane.
(To select multiple items: Press and hold
 The software assigns an order (see page 369) to each
Ctrl and select items using the pointer.)
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.
4 Repeat steps 2 and 3 until you have
assigned all the facets that are required
for the Control project.

NOTE:
 To assign selected candidate Control facets of an instance, select them in the Facets pane and
drag them instead of dragging the instance.
 To assign instances to a FAST task, create the necessary FBD sections in the FAST folder first.

366 EIO0000001309 06/2017

 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 185)
 The Supervision Project Definition stage (see page 310)

You can only assign facets of instances that have a valid Data and Link status.
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: You assign Supervision genies facets to a page (see page 313) during the refinement
stage.

Automatic Supervision Project Component Creation

During the assignment, depending on the facets that you assign to the tag container,
Process Expert may automatically create and configure the following components in the Services
folder 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).
For an illustration of the components, refer to the topic describing the Project Explorer window
(see page 312).
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.

EIO0000001309 06/2017 367

Assignment Stage

Assigning Facets
To assign data facets of instances to an existing Supervision tag container, proceed as follows.

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 205) instances of the application in tree view
else click the toggle button (6) mode.
(see page 359).
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 (6).
2 In the Containers pane, select the tag  The name of the selected tag container appears in
container to which you want to assign the title bar of the Assignments pane.
facets by clicking it.  The contents of the tag container is displayed
(empty by default).
3 From the Instances pane, drag to the title  The message Drag items here to assign facets of
bar of the Assignments pane either: instances to <container identifier> appears in the
 One or more folders, or title bar of the Assignments pane while you are
 One or more instances, or dragging.
 A combination of both  Supervision data facets that have a status of
Candidate are assigned to the tag container and
(To select multiple items: Press and hold
displayed in the Assignments pane.
Ctrl and select items using the pointer.)
 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.
4 Repeat steps 2 and 3 until you have
assigned all the facets that are required
for the Supervision project.

NOTE:
 To assign selected candidate Supervision data facets of an instance, select them in the Facets
pane and drag them instead of dragging the instance.
 If an instance contains a facet of type ClientEvent or ServerEvent, the software assigns
the facet automatically to the ClientEvents and ServerEvents container respectively when you
proceed with the assignment of the instance from the Instances pane.

368 EIO0000001309 06/2017

 Assignment Stage

Assigned Facet Description

Facet Description
In the Assignments pane, the Assignment Editor window (see page 359) 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 the Control or Supervision 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 217)
 Deleted: The section is generated (see page 399) 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 Assignment viewer.
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 395) inside a section.
The software applies the order only during:
 A first generation (see page 406)
 A regeneration (see page 452)

For more detailed information on how the software manages the facet order,
refer to the generation function description (see page 409).

EIO0000001309 06/2017 369

Assignment Stage

Column Description
header
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 439) for a

description of the assignment status.
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 438) for a description of the
generation status.

NOTE:
You can see the facet description also in the tree view of the Project Explorer:
 For Control facets: In the Containers window of the MAST or FAST task folder.
 For Supervision data facets: In the Containers window of the Tags folder of the cluster.
 For Supervision genie facets that you have assigned to a page during refinement
(see page 493): In the Containers window of the Pages folder of the project.

370 EIO0000001309 06/2017

 Assignment Stage

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
element of an instance and you can display them in the Facets pane of the
instance Assignment Editor. Proceed with the assignment as described in the
assignment procedure.
Deselect an The corresponding facets are removed from the list of facets in the
element of an Facets pane of the 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 439).

EIO0000001309 06/2017 371

Assignment Stage

Automatic Facet Assignment

Overview
The Assignment Editor features a function, which 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 Process Expert when you select
either generation command (see page 403). The container to which these facets are assigned
depends on where the other facets of the instance are already assigned to.
There can be candidate facets remaining because:
 You have not assigned all the facets to a Participant project yet.
 You have changed the element selection of the instance (see page 219) after assignment,
which has created new facets.
Information on facets that the software has assigned automatically is displayed in the notification
panel.
The software unassigns facets that is had assigned automatically if generation does not complete
successfully.
Generation takes a little longer to complete when the functionality is enabled.
NOTE: Automatic assignment does not apply to Supervision genie facets.

Function Selection and Scope

By default, the function is disabled.
If you enable the function by selecting the check box in the Assignment Editor (see page 359) and
confirming your selection, it remains enabled until you disable it.
The function applies only to containers of the Participant project that is indicated in the title bar of
the Assignment Editor. Assignment is triggered when you select any generation command at the
project or project container level.
NOTE: You can still assign facets manually while the function is selected.

372 EIO0000001309 06/2017

 Assignment Stage

Automatic Assignment Criteria

The table describes how Process Expert assigns remaining candidate facets of an instance,
depending on where other facets of the instance are already assigned.

Candidate facet type Facets of same instance Facets of same instance are already assigned to
already assigned to 1 container several containers
Control facet Candidate facets are assigned Candidate facets are assigned to the FBD
to the same FBD section. section to which other facets of the instance are
already assigned and that has the lowest Order
number.
Supervision facet Candidate facets are assigned  Supervision project with one cluster:
to the same tag container. Candidate facets 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 assignment viewer
(see page 389).

EIO0000001309 06/2017 373

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. By selecting the automatic assignment
function, Process Expert assigns Motor_1_DEVMNT automatically to section FBDSection_1
when you generate the project. (information has been highlighted in yellow for the purpose of this
example.)

374 EIO0000001309 06/2017

 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. By selecting the automatic assignment function, Process Expert 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 the purpose of this example.)

EIO0000001309 06/2017 375

Assignment Stage

Viewing the Application Structure in Control Projects

Overview
Switching to tree view mode in the Containers pane (see page 277) 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 469) and making changes online (see page 742).

Root Folder Description

In tree view mode, the Containers pane can feature up to three root folders.
The <system identifier> (for example, System_1) root folder is the parent 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

There are are two additional root folders in the Containers pane with the following purpose:
 EmptyContainers: Parent folder for sections to which no facet is assigned because of one or
more of the following reasons:
 You have created the section manually.
 You have unassigned all non-generated facets from the section. If the facets were already
generated, you have unassigned all facets and generated the section.
 You have 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.
 You have 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.

376 EIO0000001309 06/2017

 Assignment Stage

 You have 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.

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, which were created automatically during
assignment. Folder_2 is empty.

EIO0000001309 06/2017 377

Assignment Stage

The figure shows the corresponding FBD sections in the Containers pane of the Control project in
grid view mode.

378 EIO0000001309 06/2017

 Assignment Stage

The figure shows how the FBD sections are displayed in relation to the folder structure of the
application in tree view mode.

EIO0000001309 06/2017 379

Assignment Stage

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.

380 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 381

Assignment Stage

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.

382 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 383

Assignment Stage

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.

384 EIO0000001309 06/2017

 Assignment Stage

Section 15.2
Managing Assigned Facets

Managing Assigned Facets

Overview
This section describes the tasks that you can perform on assigned facets, 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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Facet Actions After Assignment 386
Viewing Facet Assignments 389
Navigating to the Assignment Editor 392
Navigating to Project Containers 394
Order of Control Facets 395
Navigating from Facets to the Instance 396

EIO0000001309 06/2017 385

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 460).

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 Assignment Editor,
the MAST/FAST task folders, the Tags, or Pages folder.

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 387).
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 462).
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 396).
Move Changes the assignment of a facet to another FBD section or tag container.
Does not apply to genie facets. Refer to Editing Supervision Pages
(see page 493).
Refer to Moving Facets (see page 387).

NOTE: The Reassign (see page 462) and Unlink (see page 462) commands that you can access
from the facet task menu by right-clicking a facet becomes available only once you have completed
the generation stage.

386 EIO0000001309 06/2017

 Assignment Stage

Unassigning Facets
To unassign a non-generated facet from a section or container, proceed as follows.

Step Action Result

1 In the Containers pane, select The software displays the contents of the
the FBD section/tag container section or container.
containing the facet that you
want to unassign.
2 In the Assignments pane, The software removes the facet from the
right-click the facet and select Assignments pane.
Unassign. In the Assignment Editor(1):
NOTE: You can select  The status of the unassigned facet
multiple facets to unassign displayed in the System column in the
them at once (press and hold Facets pane changes from Assigned to Not
Ctrl and select facets by using assigned if the facet is not assigned to any
the pointer). other project of the system.
 The status of the Project column changes
from Done to Candidate.

(1) Does not apply to genie facets. For information on unassigning genie facets, refer to Editing
Supervision Pages (see page 493).

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 Containers pane, select  The name of the selected FBD section/tag
the FBD section/tag container container appears in the title bar of the
containing the facet that you Assignments pane
want to move.  The software displays the contents of the
FBD section/tag container.
2 In the Assignments pane, -
right-click any one of the
column headers and select
the appropriate command to
clear filters and sorting
(see page 143).

EIO0000001309 06/2017 387

Assignment Stage

Step Action Result

3 In the Assignments pane,  The software removes the facet from the
drag the facet to another FBD original FBD section/tag container and
section/tag container in the assigns it to the target FBD section/tag
Containers pane. container.
 The Assigned status of the facet is
NOTE: You can select
multiple facets to move them unchanged.
at once (press and hold Ctrl
and select facets by using the
pointer).

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 359). 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.

388 EIO0000001309 06/2017

 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 or
not.
For each facet, you can:
 If the facet is not yet assigned: Open the corresponding Assignment Editor (see page 392) 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 (see page 394) to which it is assigned and
locate the facet.
NOTE:
You cannot access the View Assignments window if both conditions are true for the instance:
 Assigned status is Unassigned.
 Data or Link status is Invalid.

Accessing the View Assignments Window

In the tree view of the Application Explorer, right-click an instance and select View Assignments.
Process Expert opens the View Assignments window.

View Assignments Window

The following figure shows an example of the View Assignments window for instance
HandValve_1, whose Control facets are assigned but not its Supervision facets.

EIO0000001309 06/2017 389

Assignment Stage

Header Description
Name Displays the elements of the selected instance (for example, Logic or InterlockTags)
grouped by Participant. In this case, Control and Supervision.
For each Participant, elements are grouped by one or more levels of categories. For
example, category Control and subcategory Interlocks contain element Logic.
Type Indicates the subtype of the facet.
Facet Identifier of the facet that corresponds to the element.
FacetTemplate Identifier of the template that the facet is using.
Assigned 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.

Assignment For Control facets, the following information is displayed:

Details  For unassigned facets: A list of existing Control projects in the system to which you
can assign the facet.
Projects are listed in ascending alphabetical order of identifier.
Click a project in the list to open its Assignment Editor.
 For assigned facets: The list of sections to which the facet is assigned.
Sections are listed in ascending alphabetical order with the format:
[Link].
Click a section to show or open the corresponding Control project. The section and
facet are highlighted.
NOTE: For unassigned facets, if no Control project exists in the system, the column is
empty.
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.
Projects are listed in ascending alphabetical order of identifier.
Click a project in the list to open its Assignment Editor.
 For assigned facets: The list of containers to which the facet is assigned.
Containers are listed in ascending alphabetical order with the format:
 For data facets:
[Link].
 For genie facets: [Link].

Click a container to show or open the corresponding Supervision project. The

container and facet are highlighted.
NOTE: For unassigned facets, if no Supervision project exists in the system, the
column is empty.

NOTE: The View Assignments window is closed automatically when you navigate to a container
or to the Assignment Editor. To close it without navigating, click OK.

390 EIO0000001309 06/2017

 Assignment Stage

Multi-Assignment of Facets
If you have already assigned a facet to a project, you cannot open the Assignment Editor by using
the assignment viewer to assign this facet to another project.
To do so, locate the other project, right-click it, and select Assign Facets (see page 359).

EIO0000001309 06/2017 391

Assignment Stage

Navigating to the Assignment Editor

Overview
From an unassigned Control facet or Supervision data facet displayed in the View Assignments
window (see page 389), you can select an existing project of the system, and open the Assignment
Editor to assign this facet to it.
From an unassigned Supervision genie facet, you can select an existing Supervision project, and
open the Pages folder to assign this facet to a page.
Process Expert also opens the Project Explorer window (see page 271) if it is not open yet.
NOTE: A compatible project must exist in the system for the navigation feature to be available.

Navigating to the Assignment Editor

To navigate from an unassigned facet to the Assignment Editor of an existing project, proceed as
follows.

Step Action
1 In the View Assignments window, for a logic or data facet, select a project from
the list.
Result: the software:
 Closes the View Assignments window.
 Opens/shows a Project Explorer window according to the display rules.
 Opens/displays the Assignment Editor window.

NOTE: For a Supervision genie facet, Process Expert opens the Pages folder
of the selected Supervision project in a Project Explorer window.
2 In the Instances pane of the Assignment Editor (see page 359), locate the
instance to proceed with the assignment.

Project Explorer Display Rules

The table describes the way Process Expert opens the Project Explorer, depending on the use
case.

If... Then Process Expert...

no Project Explorer is open. opens the Project Explorer in the client window that is active.
a Project Explorer is already open (no
Participant being displayed in a
maximized window):
In the main client window. makes the already open Project Explorer active.
In another client window.
In any client window but is hidden shows the already open Project Explorer window.
due to many tabs being open.

392 EIO0000001309 06/2017

 Assignment Stage

If... Then Process Expert...

a Project Explorer is already open in a
client window and:
Any container is displayed in a shows the already open Project Explorer window.
reduced Participant window.

NOTE: For the Assignment Editor, the general display rule is that if it is already open for the
selected project, Process Expert displays it or makes it visible. If not, Process Expert opens it in
the active client window.

EIO0000001309 06/2017 393

Assignment Stage

Navigating to Project Containers

Overview
From an assigned Control facet or Supervision data facet displayed in the View Assignments
window (see page 389), you can select a project to which the facet is assigned, and open its
container by using the Project Explorer.

Navigating to a Project Container

To navigate from an assigned facet to its container in the Participant project, proceed as follows.

Step Action
1 In the View Assignments window, for a logic, data, or genie facet, select a
project from the list.
Result: the software:
 Closes the View Assignments window.
 Opens/shows a Project Explorer window according to the display rules.
 Opens the project folder that contains the container to which the facet is
assigned.
 Selects the container.

Project Explorer Display Rules

The table describes the way Process Expert opens the Project Explorer, depending on the use
case.

If... Then Process Expert...

no Project Explorer is open. opens the Project Explorer in the client window that is active.
a Project Explorer is already open (no
Participant being displayed in a
maximized window):
In the main client window. makes the already open Project Explorer active.
In another client window.
In any client window but is hidden shows the already open Project Explorer window.
due to many tabs being open.
a Project Explorer is already open in a
client window and:
Any container is displayed in a shows the already open Project Explorer window.
reduced Participant window.

394 EIO0000001309 06/2017

 Assignment Stage

Order of Control Facets

Overview
Process Expert assigns an order (see page 365) 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 409) 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 452) 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 of the MAST or FAST window, select the FBD section
that contains the facets that you want to rank.
Result: The software displays the facets that are assigned to the selected FBD
section in the Assignments pane.
2 In the Assignments pane, right-click any one of the column headers and select
the appropriate command to clear filters and sorting (see page 143).
Result: The software displays the facets 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 software displays the facet in the selected position and modifies
the values of the Order column.

NOTE: To change the execution order of the FBD sections, refer to Changing the FBD Section
Execution Order (see page 283).

EIO0000001309 06/2017 395

Assignment Stage

Navigating from Facets to the Instance

Overview
From a facet assigned to a project container, 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.

The navigation feature is available from the Assignments pane of:

 MAST and FAST task folders.
 The Pages folder.
 The Tags folder.
 The Assignment Editor.

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
Explorer because a filter (see page 143) is informs you that the instance is not visible.
applied in the workspace and the After clicking OK, the border of the folder containing the
Templates Browser. instance flashes briefly.
The Application Browser pane is minimized The instance is only shown in the workspace of the Application
or in the background (if tabbed). Explorer if it is visible.
If the instance is not visible, for example, because a filter is
applied, the border of the folder containing the instance flashes
briefly.
The Application Browser pane remains minimized or in the
background.

396 EIO0000001309 06/2017

 Assignment Stage

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: Process Expert:
 Opens the Application Explorer window if it is not yet open in any workspace. If it is, the
window is shown.
 Expands the application folder structure and opens the folder containing the instance.
 Selects the instance that references the facet.

EIO0000001309 06/2017 397

Assignment Stage

398 EIO0000001309 06/2017

 Process Expert
Generation Stage
EIO0000001114 05/2017

Chapter 16
Generation Stage

Generation Stage

Overview
This chapter provides information to help you 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 67) 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 General Description 401
16.2 Generating a Project for the First Time 441
16.3 Generating Projects After Changes 445
16.4 Generating the Equipment Hierarchy 455

EIO0000001309 06/2017 399

Generation Stage

Section Topic Page

16.5 Generation Diagnostic Messages 458
16.6 Managing Generated Facets 460

400 EIO0000001309 06/2017

 Generation Stage

Section 16.1
General Description

General Description

Overview
This section gives a general description of the generation process of Control or 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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Generation Process Description 402
Control Project Specifics 406
Selecting Versions of Types in Control Facets During Generation 413
Statuses of Facets 438

EIO0000001309 06/2017 401

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 441).
 A generation after changes (see page 445).
 A Control Participant project regeneration (see page 452).

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 212).
 Creates links between function blocks generated from different facets, which are assigned to
the same FBD section (see page 407). 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 hierarchy (see page 455).

For both projects, you can generate:

 The entire project.
 Individual FBD sections for Control projects.
 Individual tag, ClientEvents, ServerEvents containers, pages, or clusters for Supervision
projects.
NOTE: You can abort the generation of projects (see page 442) and containers (see page 443),
and the regeneration (see page 453) of Control projects and sections after initiating the task.

402 EIO0000001309 06/2017

 Generation Stage

Data Validation Before Generating

When you select the Generate or ReGenerate command for a project or a container,
Process Expert first verifies if the constituents of the assigned facets satisfy the applicable naming
rules (see page 107).
Process Expert 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 407).
 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

If you have enabled the functionality to assign candidate facets automatically in the Assignment
Editor of a Participant project, Process Expert may assign candidate facets automatically 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 displays a dialog box to remind you that the
functionality is enabled before executing the command. This dialog box gives you the possibility to
cancel generation and the automatic assignment of these facets (see page 372).
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.
For more information on this assignment process, refer to the topic describing automatic facet
assignment (see page 372).
NOTE: Generation takes a little longer to complete when the functionality is enabled.

EIO0000001309 06/2017 403

Generation Stage

Generating During Build Stage

To save time or if you have made minor changes to a logical Control Participant project, instead of
using the Generate command, you can use the Generate and Build command from the Control
executable (see page 574) or Supervision executable (see page 613) context menu, which
performs a generation followed by a build. You need to have completed the system engineering
life cycle up to be build stage.
If you generate a complete Participant project and generation of any section (see page 407) 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 452).
 Can be used together with the automatic facet assignment function (see page 372).

NOTE: After selecting the command, the abort icon is displayed in the notification panel
(see page 94). 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 369) 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 of the $EMPortM and $TesysTEM
templates, assign their facets to a Control Participant project, and then delete the link. The facet of
the $TesysTEM template instance becomes invalid when it is not linked anymore.
Generating the section to which the invalid facet is assigned removes it from the section.

404 EIO0000001309 06/2017

 Generation Stage

Skipping Facets During Generation

If a facet is locked, the constituents 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.

EIO0000001309 06/2017 405

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.

Validating the Capability to Build

When you execute any generation command on a logical Control Participant project or any of its
containers (including the Generate and Build command), Process Expert analyzes the project.
If the result of the analysis indicates that the build process may not complete successfully, the
software displays a build diagnostic icon (see page 150) in the project folder in the Project
Explorer.
In such case, refine (see page 467) 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 the $EMPortQ
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 build diagnostic 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 or Device DDT
variables (see page 738), which exist only in the configuration project until you perform the build
(for example, when the configuration contains HART modules (see page 538)).
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.

406 EIO0000001309 06/2017

 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, detected errors stop the generation process at the section containing the affected code.
Generation is considered as not complete as a whole. The impact on the generation process
depends on the detected error or the user action that is performed.

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 107) The section which contains the detected error and any
subsequent sections are not generated.
Section overcrowded(1) A summary dialog box indicates the identifier of the section
Clicking Cancel in the Type Version Conflict where generation stopped as well as the reason.
dialog box (see page 413).
Operation in the Control Participant did not The generation process stops and the entire process is
succeed (for example, injecting data in a rolled back.
section through import)
.NET exception occurred (for example,
Object reference not set diagnostic
message)
(1) Refer to the topic describing diagnostic messages (see page 458).

EIO0000001309 06/2017 407

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. 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.

408 EIO0000001309 06/2017

 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 411).
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.

Process Expert 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 458).
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, Process Expert processes the facets that
you have assigned to the project and that have an Assignment status of Assigned. It takes into
consideration the order of sections (see page 277) at the project level and the order of facets
(see page 369) at the section level.
Refer also to the topic giving an example of section layout management (see 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 277) 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 369) of the first
facet of each instance that is assigned to the section.

EIO0000001309 06/2017 409

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 858) 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, Process Expert 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 460) encapsulating them, delete (see page 439) the
facets by deleting the instance, or delete the section (see page 280) to which these facets were
assigned.
To remove these types, you can either:
 Regenerate (see page 452) 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.

410 EIO0000001309 06/2017

 Generation Stage

Configurable Generation Settings

By editing the [Link] file, you can customize the behavior of the generation
process of Control Participant projects.
The file is located on the PC on which the system server is installed at the path
C:\Program Files\Schneider Electric\StruxureWare\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 89).
You can configure the following parameters.

Parameter name Default value Description

ReGenerateNonFbdSec- True True = The behavior during a regeneration is the following:
tions  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.
UnityProIgnoreFbd- True True = Comments of FBD sections are not generated.
Comments
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.
UnityProUseEffec- False True = The minimum space around function blocks is decreased
tiveSize to help utilize the space of the section more effectively.
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 450).

EIO0000001309 06/2017 411

Generation Stage

Parameter name Default value Description

CheckConsistency True This is not a user-configurable parameter.
Changing the value affects the behavior of Process Expert.
SaveAfterNumberSec- 30 Number of FBD sections that need to generate successfully to
tionGenerated 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 407).
NumberOfUnitySec- 36(1) Number of rows/columns that the section contains when it is
tionRows created by generating the Control Participant project or section for
the first time or regenerating it.
NumberOfUnitySec- 24(1)
tionColumns 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 409) 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.

412 EIO0000001309 06/2017

 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, the
following cases 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 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, Process Expert detects the presence of several versions for a same type.
As a result, the software opens the Type Version Conflict 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 Type Version Conflict
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 Type Version Conflict dialog box also opens if the software detects the same version
of a type but with a different signature (see page 418).

EIO0000001309 06/2017 413

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 Participant
the application project
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 Participant project 1 Control Participant 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.

414 EIO0000001309 06/2017

 Generation Stage

Type Version Conflict Dialog Box

The following figure shows an example of the Type Version Conflict dialog box. Types DEVCTL
and CONDSUM create a version conflict in FBDSection_1. For each type, seven instances
reference a facet that is assigned to the section and encapsulating the type. No action is allowed
on type DEVCTL_ST_DDT because it is linked to type DEVCTL. The action that you select for
DEVCTL is applied to it.

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.

EIO0000001309 06/2017 415

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 Type Version Conflict 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 447) 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 Type Version Conflict 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.

416 EIO0000001309 06/2017

 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 Assignment: Out Of Date Because the version has already been
detected during this generation detected, the Type Version Conflict
cycle but is different from the one dialog box does not open; therefore, no
currently used in the Control action is required.
project. Refer to example 3 (see page 426).
The version has not yet been Assignment: Out Of Date You are selecting Skip for the proposed
detected during this generation version change after having already
cycle. selected Update for the same type in
another section during the same
generation cycle.
Refer to example_7 (see page 433).

NOTE: If the status of the facet is Non Generated, it does not change.

EIO0000001309 06/2017 417

Generation Stage

Detecting Types of Same Version But With Different Signature

The Type Version Conflict 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 417).
Independently of the action that you select, the Type Version Conflict 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 407).

418 EIO0000001309 06/2017

 Generation Stage

Performing a Consistency Check After Version Conflict Detection

It is recommended to perform a consistency check (see page 472) 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 assignment/ Facet status after Comment

type generation status generating and
version before generating performing a 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 Type
Version Conflict dialog box opens.
If you regenerate a section of a Control Participant project, the software maintains existing types
(see page 452) 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.

If they are different, it opens the Type Version Conflict dialog box.

EIO0000001309 06/2017 419

Generation Stage

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 420),
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 421)
A section contains two facets that are not generated. Example 1b
(see page 422)
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 423)
A generated facet is updated while the same section contains a non- Update and Skip Example 2
generated facet. (see page 425)
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 sections of a Update Example 3
Control project. (see page 426)
Several different versions of the same type in different sections of a Example 4
Control project. (see page 428)
Two different versions of the same type in different sections of a Skip Example 5
Control project. (see page 430)
Several different versions of the same type in different sections of a Example 6
Control project. (see page 431)
Several different versions of the same type in different sections of a Update and Skip Example 7
Control project. (see page 433)
Two different versions of the same type in different sections of a Cancel and Example 8
Control project. Update (see page 436)
The Regenerate
command is also
described.

420 EIO0000001309 06/2017

 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 Facet DFB_A version used

version assignment/generation in Control project
encapsulated status
in facet
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 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/Generated v1.0 The software detects v2.0 while v1.0 is
Facet_1 v2.0 Assigned/Non already generated. Because the conflict
Generated arises in the same section, generation stops
(see page 407) 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 425).
 Unlink Facet_0, generate the section,
select Update when the Type Version
Conflict 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 420).)

EIO0000001309 06/2017 421

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 Facet

version assignment/generation
encapsulated status
in facet
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 407) 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 425).
(1) The order of facets in the section is not relevant.

(Back to example summary table (see page 420).)

422 EIO0000001309 06/2017

 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 Facet DFB_A version used

version assignment/generation in Control project
encapsulated status
in facet
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.

EIO0000001309 06/2017 423

Generation Stage

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 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 407) 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 425).
 Unlink the already assigned and
generated facet (Facet_1), generate the
section, select Update when the Type
Version Conflict 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 420).)

424 EIO0000001309 06/2017

 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 Facet DFB_A version used

version assignment/generation in Control project
encapsulated status
in facet
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 Comment

version assignment/generation version used
encapsulated status after generation in Control
in facet project after
generation
Facet_0 v2.0 Assigned/Generated v2.0 The software detects v2.0 and opens the
Facet_1 v2.0 Assigned/Generated Type Version Conflict 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 420).)

EIO0000001309 06/2017 425

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 Section ID(1) DFB_A

version version used
encapsulated in Control
in facet 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.

426 EIO0000001309 06/2017

 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 Type
Version Conflict 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 420).)

EIO0000001309 06/2017 427

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 Section ID(1) DFB_A

version version used
encapsulated in Control
in facet 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.
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.
(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.

428 EIO0000001309 06/2017

 Generation Stage

Facet ID DFB_A Section ID(1) DFB_A version Comment

version used in Control
encapsulated project after facet
in facet generation
Facet_1 v3.0 Section_1 v3.0 The software detects v3.0 and opens the Type
Version Conflict 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 Type
Version Conflict 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 420).)

EIO0000001309 06/2017 429

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 Section ID(1) DFB_A

version version used
encapsulated in Control
in facet 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 Type
Version Conflict 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.

430 EIO0000001309 06/2017

 Generation Stage

NOTE: The assignment status of Facet_1 and Facet_3 remains Out Of Date.
(Back to example summary table (see page 420).)

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 Section ID(1) DFB_A

version version used
encapsulated in Control
in facet 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.

EIO0000001309 06/2017 431

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 Type
Version Conflict 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 Type
Version Conflict 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 420).)

432 EIO0000001309 06/2017

 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 Section ID(1) DFB_A

version version used
encapsulated in Control
in facet 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.

EIO0000001309 06/2017 433

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 Type
Version Conflict 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 Type
Version Conflict 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.

434 EIO0000001309 06/2017

 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 Type Version Conflict 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 420).)

EIO0000001309 06/2017 435

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 Section ID DFB_A

version version used
encapsulated in Control
in facet 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 Comment

version version used
encapsulated in Control
in facet project after
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
Type Version Conflict 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.

436 EIO0000001309 06/2017

 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
Type Version Conflict 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 420).)

EIO0000001309 06/2017 437

Generation Stage

Statuses of Facets

Overview
After the generation process, the generation and assignment statuses of Control and Supervision
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 446).

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 in:
 The Assignment Editor.
 For Control projects: The MAST or FAST task folders.
 For Supervision projects:
 The subfolders of the cluster for data facets.
 The Pages folder for genie facets.

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 446) 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.
For facets assigned to Control project, it can indicate that generation (see page 410) or
regeneration (see page 454) was unsuccessful and rolled back.
Generated The software has successfully generated the constituents of the facet into the logical
participant project.
NOTE: The software automatically assigns the status Generated to Supervision genie
facets that you assign to a page during page edit.
Moved You have moved (see page 387) 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.

438 EIO0000001309 06/2017

 Generation Stage

Status Description
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 472):
 You have not yet generated the section containing the facet again in order for the software
to resolve the inconsistency (see page 449) 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 460) 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 413).
Unlinked You have unlinked the facet from its already generated constituents in the logical Participant
project:
 By using the Unlink (see page 462) command.
 By unlinking the facet through the Check Consistency dialog box:
 After refining a Control Participant project (see page 467).
 Before updating a Control Participant project (see page 773).

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 in:
 The Assignment Editor.
 For Control projects: The MAST or FAST task folders.
 For Supervision projects:
 The subfolders of the cluster for data facets.
 The Pages folder for genie facets.

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 460) 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.

EIO0000001309 06/2017 439

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 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:
 The identifier of the cluster and/or of the I/O device of the Supervision
project to which the facets are assigned.
 The relationship between tag container and I/O device of the Supervision
project.
 The application structure (see page 235).

Deleted You have unselected the corresponding element in the Instance Editor or
deleted the instance that references the facet.

440 EIO0000001309 06/2017

 Generation Stage

Section 16.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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Generating Entire Projects 442
Generating Sections and Containers 443

EIO0000001309 06/2017 441

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 containers of the Tags, ClientEvents, and ServerEvents folders
of the clusters of the project, including the facets that are assigned to such containers, and any
associated components of the Services folder.
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 94). Click the icon to cancel the task. The Control or Supervision project is not
generated; what the software had already generated at the moment you cancelled 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 Control or Supervision project, proceed as follows.

Step Action
1 In the Project Explorer, 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 438) 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 411).

442 EIO0000001309 06/2017

 Generation Stage

Generating Sections and Containers

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 Tags, ClientEvents, ServerEvents containers, or Pages folder: The facets that are
assigned to the respective containers or pages.
 For a cluster: The containers of the Tags, ClientEvents, and ServerEvents folders of the
cluster including the facets that are assigned to such containers, and any components of the
associated Services folder.
 For the Services folder: The components contained in the folder.

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.
 You can start the generation process also from the Containers pane of the Assignment Editor.

Aborting Generation Tasks for Project Containers

After selecting the Generate command, the abort icon is displayed in the notification panel
(see page 94). Click the icon to cancel the task. The container of the Control or Supervision project
is not generated; what the software had already generated at the moment you cancelled 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 container, the task may complete before you are able to click
the icon.

EIO0000001309 06/2017 443

Generation Stage

Generating an FBD Section, Container, or Folder

To generate part of a project, proceed as follows.

Step Action
1 In the tree view of the Project Explorer, right-click the section, container, or folder that you want
to generate and select Generate.
Result:
 Process Expert 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 438)
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 411).

444 EIO0000001309 06/2017

 Generation Stage

Section 16.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 754) 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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Generating Control or Supervision Projects After Changes 446
Regenerating a Control Project 452

EIO0000001309 06/2017 445

Generation Stage

Generating Control or Supervision Projects After Changes

Overview
You need to generate the logical Control or Supervision 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 452). 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 411).
The software proceeds with the validation of data (see page 403) 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 467) at the project level.

446 EIO0000001309 06/2017

 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 395) to
the logical Control Participant project.

Generating Control Projects After Changing the Order of Sections

When you change the order (see page 283) 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
Process Expert 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.

EIO0000001309 06/2017 447

Generation Stage

Your modification is reverted to the code that Process Expert had previously generated from the
facet.
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. The Motor_1_Motor section 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 the Motor_1_Motor
section does not undo your refinement; the immediate value of the ZSHEN input parameter remains
True.

448 EIO0000001309 06/2017

 Generation Stage

However, if the Motor_1_Motor section 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 313) of the project.

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, Process Expert
retains your refinement if you generate the section. Your refinement is discarded if you
regenerate the section.

EIO0000001309 06/2017 449

Generation Stage

Generating Facets with State Invalid

If the State of a facet (see page 369) 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 of the $EMPortM and $TesysTEM
templates, assign their facets to a Control Participant project, generate the section, and then delete
the link. The facet of the $TesysTEM template instance becomes invalid when it is not linked
anymore.
You need to either regenerate (see page 452) 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, Process Expert 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.
 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.
Process Expert manages the section size (see page 409) as needed.
For more information, refer to Section Layout Management Example (see 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 411) can affect the position of function
blocks.

450 EIO0000001309 06/2017

 Generation Stage

Generating a Project Again

Refer to the generation procedure to generate:
 The entire project (see page 442)
 Part of a project (see page 443)

EIO0000001309 06/2017 451

Generation Stage

Regenerating a Control Project

Control Project Regeneration Function 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 467) 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 411):
 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 454) 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 logical Control project.
 Generate the Control project.

452 EIO0000001309 06/2017

 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 Non Generated Generated Moved Inconsistent Unlinked
status
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

Process Expert manages the section size (see page 409).

Execution Order and Function Block Layout

The process to generate the section order and section layout is the same as for a first-time
generation (see page 409), independently of the facet status.

Aborting Regeneration of Projects And Sections

After confirming the ReGenerate command, the abort icon is displayed in the notification panel
(see page 94). 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 cancelled 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.

EIO0000001309 06/2017 453

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 411) as needed.
2 In the Project Explorer, right-click the Control project that you want to regenerate and select
ReGenerate.
Result:
 Process Expert 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 open MAST or FAST task folder of the project, or in the Containers pane of the
Assignment Editor, right-click the section that you want to regenerate and select ReGenerate.
Result:
 Process Expert 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 or
any facet is not successful.

Regenerated project component Facet status

Entire Control project The generation status of all facets of the project 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.

454 EIO0000001309 06/2017

 Generation Stage

Section 16.4
Generating the Equipment Hierarchy

Generating the Equipment Hierarchy

Generating the Equipment Hierarchy

Overview
Generating Supervision projects populates the equipment database file of the Supervision
Participant based on the structure of the application (see page 187) to create an equipment
hierarchy. This allows you to view alarms during runtime in a structure identical to the hierarchy of
the application.
During this process, 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 235) 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 generated equipment paths, refine the Supervision project and open the
equipment table.

Fields of the Equipment Database

The generation process populates the following fields of the equipment database file of the
Supervision Participant.

Field Description
Name Instance identifier with its complete path satisfying the equipment
database rules for the name field. The folder name 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.
Comment $Description parameter of the instance.
Area $Area parameter of the instance.

NOTE: When an instance is created by instantiating a facet template (as opposed to a composite
template), the instance identifier is not part of the equipment name. The equipment name ends with
the parent folder.
For example, if you instantiate template $DISignal_UL in Folder_2, which is a subfolder of
Folder_1, the equipment name of that instance (DISignal_1) is: Folder_1.Folder_2.

EIO0000001309 06/2017 455

Generation Stage

Truncation Rules
The software may truncate the identifier of folders and instances according to the following rules
to populate the Name field of the equipment database file of the Supervision Participant:

Item Rule Examples

Folder levels 7 folders maximum not including –
the system root folder
Instance path < 128 characters including the –
instance identifier
Folder identifier 12 characters maximum(1) –
length
Instance identifier 18 characters maximum(1) Valid:
length _Equipment2
Identifiers Can only begin with: equipment_2
2_equipment
 Alphanumeric characters
Invalid:
 _ (UNDERSCORE)
Equipment\2 (\ is not an allowed character)
Can only contain: Equipment_Reactor_Motor_2 (identifier length
 Alphanumeric characters exceeded)
 Digits Reactor 2 is modified to Reactor2
 _ (UNDERSCORE)

No spaces.

(1) Optimized name: The software may add an indexer consisting of two digits at the end of names
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 Instance Parameter Validation
(see page 220).
NOTE: If the software truncates the instance identifier or path to satisfy the database rules, it
displays an information message once the generation process is completed.
NOTE: The software does not change the identifier of folders and instances of the application.

Example 1
If in the Application Explorer the application contains the following instance:
 Identifier: Left_Conveyor_Motor_1
 At path (folder identifiers): System_1\PlantNorthFace\F2\F3\F4\F5\F6\F7\F8

The generated equipment name is:

PlantNorthFa.F2.F3.F4.F5.F6.F7.Left_Conveyor_Moto

456 EIO0000001309 06/2017

 Generation Stage

Example 2
If in the Application Explorer the application contains the following two instances in the same folder:
 Identifier: This_is_Instance_number_1
 Identifier: This_is_Instance_number_2
 At path (folder identifiers): System_1\Folder_1

The generated equipment names are:

 System_1.Folder_1.This_is_Instance_n
 System_1.Folder_1.This_is_Instance_n00

EIO0000001309 06/2017 457

Generation Stage

Section 16.5
Generation Diagnostic Messages

Generation Diagnostic Messages

Generation Diagnostic Messages

Overview
The following tables describe 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 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 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 409).  Verify that no message box is interfering with the resizing of
Also, you may have changed the the section (see page 409).
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 411) by
regenerating it.

458 EIO0000001309 06/2017

 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 212) 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 452) 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 265). Generate the project again.
For details, refer to the topic describing the management of
type versions in Control facets during generation
(see page 413).
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 108), and generate the project again.

For Supervision Projects

Detected error Cause Corrective action

Unique The number of non-unique Change the folder structure of the application or instance
equipment truncated folder and instance identifiers to reduce the number of non-unique identifiers that
name cannot identifiers during generation the software creates through truncation (see page 456).
be generated. exceeds 99.
Indexer used
for uniqueness
has reached 99
(maximum
limit).

EIO0000001309 06/2017 459

Generation Stage

Section 16.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
or the project 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 91). In such case, check the
Notification Panel (see page 94) 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 458).
The status UnAssigned is described in Assignment Status of Generated Facets
(see page 439).
Refer to Unassigning Generated Facets (see page 462).
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 387)
are different.
Unlink Refer to Unlinking Generated Facets (see page 462).
NOTE: The status Unlinked is described in Generation Status of Facets
(see page 438).

460 EIO0000001309 06/2017

 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 472) 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 462).
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 function 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 463).
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 396).
Move Refer to Moving Generated Facets (see page 463).
NOTE: The status Moved is described in Generation Status of Facets
(see page 438).

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 445).

EIO0000001309 06/2017 461

Generation Stage

Unassigning Generated Facets

To unassign a generated facet from the container to which it is assigned, proceed as follows.

Step Action Result

1 In the Containers pane, select the  The name of the selected container appears in the title
container from which you want to bar of the Assignments pane.
unassign a facet.  The software displays the contents of the container.

2 In the Assignments pane, right-click  The software unassigns the facet from the selected
the facet and select Unassign. container.
 Its already generated constituents (for example,
NOTE: You can select several facets
in the same container. variables and FB instances for Control facets and
database entries for Supervision facets) are removed
from the logical Participant project (but not derived types
(see page 452) for Control facets).
 The status of the facet displayed in the Assignment
column changes to UnAssigned.

Unlinking Generated Facets

To unlink a facet, proceed as follows.

Step Action Result

1 In the Containers pane, select the  The name of the selected container appears in the title
container from which you want to bar of the Assignments pane
unlink a facet.  The software displays the contents of the container.

2 In the Assignments pane, right-click  The software unlinks the facet from its already
the facet and select Unlink. generated constituents.
 The status of the facet displayed in the Generation
NOTE: You can select several facets
in the same container. column changes to Unlinked.

Reassigning Facets
To reassign a facet, proceed as follows.

Step Action Result

1 In the Containers pane, select the  The name of the selected container appears in the title
container containing the facet that bar of the Assignments pane
you want to reassign.  The software displays the contents of the container.

2 In the Assignments pane, right-click  The software reassigns the facet to the same container
the facet and select Reassign. and performs a consistency check.
 The status of the facet displayed in the Assignment
NOTE: You can select several facets
in the same container. 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 438).

462 EIO0000001309 06/2017

 Generation Stage

Relinking Facets
To relink a facet, proceed as follows.

Step Action Result

1 In the Containers pane, select the  The name of the selected container appears in the title
container containing the facet that bar of the Assignments pane
you want to relink.  The software displays the contents of the container.

2 In the Assignments pane, right-click  The software links the facet again to its generated
the facet and select Relink. constituents in the logical Participant project.
 The status of the facet displayed in the Generation
NOTE: You can select several facets
in the same container. column changes to Generated or Inconsistent
(see page 438).

Moving Generated Facets

To move a facet from one container to another, proceed as follows.

Step Action Result

1 In the Containers pane, select the  The name of the selected container appears in the title
container containing the facet that bar of the Assignments pane
you want to move.  The software displays the contents of the container.

2 In the Assignments pane, right-click -

any one of the column headers and
select the appropriate command to
clear filters and sorting
(see page 143).
3 In the Assignments pane, drag the  The software removes the facet from its original location
facet to another container in the and assigns it to the target container.
Containers pane.  The status of the facet displayed in the Generation

NOTE: You can select several facets column changes to Moved.

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 359). 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 446) the target container again to update the associated logical Participant project.

EIO0000001309 06/2017 463

Generation Stage

464 EIO0000001309 06/2017

 Process Expert
Refinement Stage
EIO0000001114 05/2017

Chapter 17
Refinement Stage

Refinement Stage

Overview
This chapter provides information to help you modify the logical Control and Supervision
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 68) 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 Control Project Refinement Stage 466
17.2 Supervision Project Refinement Stage 492

EIO0000001309 06/2017 465

Refinement Stage

Section 17.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 467
Managing Consistency 472
About Variables for Peer to Peer Communication 476
Managing Network Variables 487

466 EIO0000001309 06/2017

 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
inside the MAST or FAST task folder (except for LL984 sections). The section does not need to be
generated to be refined.
FBD and non-FBD sections that you add during refinement are displayed in the Control project
(Project Explorer) in the order they appear in the Control Participant. The contents of these
sections is not displayed there.
Once refinement is complete, you can request the software to perform a consistency check
(see page 472).
At the refinement stage, you can also create and manage network variables (see page 476), 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 91). In such case, check the
Notification Panel (see page 94) for details.

EIO0000001309 06/2017 467

Refinement Stage

Refinement Window
The figure shows the Refine 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 Check consistency button
4 Save button

NOTE: When you select the Refine command at the section level, the Unity Pro window shows the
contents of the section but the Project Browser and the information window are not displayed. The
Application Tree View pane is also not available.

468 EIO0000001309 06/2017

 Refinement Stage

Viewing the Application Structure When Refining Control Participant Projects

While you refine a Control Participant project, the Application Tree View 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 376).
For information on how to use the pane, refer to the topic describing the refinement of Control
Participant projects (see 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.

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.

Build Diagnostic Indicator

When you save the logical Control Participant project during refinement, the project is analyzed
(see page 406) and the status of the project is indicated by the build diagnostic indicator
(see page 150).
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 Participant project is not open in the Control Participant and the build
diagnostic icon is displayed in the Control Participant project folder, you need to refine the Control
Participant project and analyze it. This allows you to identify the cause of the negative build
diagnostic. The Control Participant features tools that help you identify the issue, which results in
an unsuccessful build (see page 625).
For information on troubleshooting Control Participant projects and/or analyzing them, refer to the
help of the Control Participant.
NOTE: This verification is performed also when you use a command to generate a logical Control
Participant project (see page 406).

EIO0000001309 06/2017 469

Refinement Stage

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 406), DFBs that you have added are not moved, and DFBs coming from assigned facets
are laid out around them.

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: Process Expert opens the Control Participant in a reduced window.
2 Maximize the Control Participant window.
3 Proceed with the refinement.
For more information on the refinement process, refer to Refining the Logical Control Participant
Project (see Process Expert, Control Participant Services, User Guide).
4 Click the save button in the toolbar of the Participant window to save the changes in the logical
Control Participant project.

5 Perform a consistency check (see page 475) if required.

6 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 To save changes in the logical Control Participant project and close the Participant window.
No To discard changes and close the Participant window.
Cancel Does not save changes and leaves the Participant window open.

NOTE: While you refine the logical Control Participant project, commands such as Refine,
Generate, Regenerate, or Delete are not available at the project and section levels.

470 EIO0000001309 06/2017

 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 Project Explorer, open the MAST or FAST task folder, which contains the section you
want to refine.
2 In the Containers pane, right-click the section you want to refine and select Refine.
Result: Process Expert opens the Control Participant window in a new tab inside the MAST or
FAST task folder, displaying the contents of the selected section only.
3 Maximize the Control Participant window.
4 Proceed with the refinement of the section.
For more information on the refinement process, refer to Refining the Logical Control Participant
Project (see Process Expert, Control Participant Services, User Guide).
5 Click the save button in the toolbar of the Participant window to save the changes in the logical

Control Participant project.

6 Perform a consistency check (see page 475) if required.
7 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 tab of the Participant window, the
software displays the Save Refinement dialog box where you have the following choices:
Yes To save changes in the logical Control Participant project and close the Participant window.
No To discard changes and close the Participant window.
Cancel Does not save changes and leaves the Participant window open.

NOTE: While you refine a section of the logical Control Participant project, commands such as
Generate, Regenerate, Delete, or Rename are not available for this section.

EIO0000001309 06/2017 471

Refinement Stage

Managing Consistency

Overview
Consistency management consists in:
 Requesting the software to start the consistency check of a logical Control Participant project or
FBD section of such project.
 Detecting if the constituents of facets that the software has generated in such project or FBD
section are consistent with the related facets that are assigned to the Control project or section:
 If yes, displaying a message to inform you that the software did not detect any inconsistency.
 If not, displaying a message to inform you of the detected inconsistencies and changing the
Generation status of the related facets to Inconsistent.
 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 447).
 Reassign (see page 460) a facet with the status UnAssigned: Automatically (if available).
 Relink (see page 460) a facet with the status Unlinked: Automatically (if available).
 Update the logical Control Participant project (see page 766): On request.

NOTE: The software does not perform consistency checks on facets that have the Unlinked status
(see page 438).

472 EIO0000001309 06/2017

 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 (1)
Any change resulting in a new version of the type . Changes to Inconsistent.
(DDT) and
Change causing no version change but resulting in a new
function block
(DFB) types 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 blocks No change.
(EFs, EFBs, or DFBs).
Changing links. Includes changing immediate values and Changes to Inconsistent.
links between variables.
(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.

EIO0000001309 06/2017 473

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.

474 EIO0000001309 06/2017

 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: Process Expert opens the Control Participant in a reduced window.
2
In the toolbar of the window, click the check consistency button .
Result: Process Expert:
 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 452).
For information on managing inconsistencies without affecting changes made through refinement,
refer to Generating Inconsistent Facets (see page 449).

EIO0000001309 06/2017 475

Refinement Stage

About Variables for Peer to Peer Communication

Overview
Process Expert 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 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 487).
You can create network variables before proceeding with the service mapping and the creation of
communication channels (see page 579).
Variables used for peer to peer communication are allocated during build (see page 626) based on
the network variable mapping (see page 594).
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 779).

Owner/Consumer Project Principle

To help you understand the way peer to peer communication is implemented in Process Expert,
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.

476 EIO0000001309 06/2017

 Refinement Stage

The figure illustrates the owner/consumer principle in a system where the DISignal_UL_1V and
Valve_1_VALVE_OPV variables 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 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.

EIO0000001309 06/2017 477

Refinement Stage

Ways to Create Network Variables to Share Scattered Data One-to-One

The following figure illustrates two common ways to create a network variable to share scattered
data between an owner and a consumer project:
 Top: 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.
 Middle: 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.
NOTE: In both 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 487). To
create the network variable automatically, you need to use two peer to peer communication
templates (Data Out and Data In). This is illustrated with the third scenario (bottom).
Other ways to create network variables exist (see page 485).

478 EIO0000001309 06/2017

 Refinement Stage

The following figure illustrates the first scenario (top) by using instances and linking them in the
Links Editor. Facets of each instance are then assigned to the owner and consumer projects.

The following figure illustrates the second scenario (middle) by using instances and linking them in
the Links Editor. Facets of each instance are then assigned to the owner and consumer projects.

EIO0000001309 06/2017 479

Refinement Stage

The following figure illustrates the third scenario (bottom) 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.

480 EIO0000001309 06/2017

 Refinement Stage

This figure illustrates the scenario by using 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 figure has been modified for better visualization. You cannot view the connections in
the Links Editor as shown above because you are limited to viewing three instances connected in
series at a time.

EIO0000001309 06/2017 481

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 Process Expert , Foundation Application Templates, User Guide).

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 476).
 The platform or the communication module that is used by the topological entity acting as client.

482 EIO0000001309 06/2017

 Refinement Stage

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 Variable Network variable
data from in the context of
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 487).
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 Network variable Variable
to the server in the context of
Process Expert
Name Any valid name Same name
Type Any, including the Reference Same type
data type (REF_TO).
Some restrictions apply
(see page 487).
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

EIO0000001309 06/2017 483

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 Designation of the variable Variable Network variable
data from in the context of
the server 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 True (selected) False (cleared)
Variable
Writing data Designation of the variable Network variable Variable
to the server in the context of
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 True (selected) True (selected)
Variable

NOTE: For more information on the REF_TO data type, refer to the topic describing the refinement
of Control projects (see Process Expert, Control Participant Services, User Guide).

484 EIO0000001309 06/2017

 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 Manage
template Network Variables dialog box detects the variable
corresponding to the as a network variable candidate in the consumer
data type to be shared project, with the name of the Data Out template
(for example, instance.
$DOUTBool_UL to Create the network variable (see page 487).
share a boolean Instantiate a Data In template The generation process creates a network variable
variable of the REF_ corresponding to the data type of the in the consumer project with the name of the
TO ANY_BOOL data Data Out template (for example, Data Out template instance.
type). $DINBool_UL).
NOTE: The Manage Network Variables dialog
box shows the variable in the Existing Network
Variables pane.
Instantiate a peer to Instantiate a peer to peer consumer The generation process creates a network variable
peer owner template template matching the peer to peer in the consumer project with the name of the owner
corresponding to the owner template (for example, template instance.
data type to be shared $Bool16INC to receive up to
NOTE: The Manage Network Variables dialog
(for example, 16 boolean input signals). box shows the variable in the Existing Network
$Bool16INO to share
Variables pane.
up to 16 boolean input
signals of the REF_TO
data type).
Instantiate a template, Reference a variable of the same name The Manage Network Variables dialog box detects
which creates a and data type as the one created by the the variable as a network variable candidate in the
variable during the instance in the owner project without consumer project.
generation process (for declaring it by using the Refine Create the network variable (see page 487).
example, command.
$DISignal_UL, which
Instantiate a template that receives the
creates a variable of variable exposed by the instance in the
type REF_TO owner project by creating a link
ANY_BOOL with between both templates in the Links
default name Editor.
DISignal_UL_nV)(1).
Create a variable of the same name and The Manage Network Variables dialog box shows
data type as the one created by the the variable in the Existing Network Variables
instance in the owner project, and enter pane.
P2P as Custom attribute by using the
Refine command.

EIO0000001309 06/2017 485

Refinement Stage

Action in owner project Action in consumer project Status of variable

(1)
Create a variable to Reference a variable of the same name The Manage Network Variables dialog box detects
be shared by using the and data type without declaring it, using the variable as a network variable candidate in the
Refine command. the Refine command. consumer project.
Create the network variable (see page 487).
Create a variable of the same name and The Manage Network Variables dialog box shows
data type, and enter P2P as Custom the variable in the Existing Network Variables
attribute by using the Refine command. 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 482).
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 789).
 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 487).

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 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 193), 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 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.

486 EIO0000001309 06/2017

 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 478).

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 482).

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 Process Expert, Control Participant Services, User
Guide) in the variable properties window of the Control Participant.

EIO0000001309 06/2017 487

Refinement Stage

Accessing the Manage Network Variables Dialog Box

You can access the Manage Network Variables dialog box either way:
 From the context menu of the Control Participant project by selecting Manage Network
Variables.

 From within the Control Participant by clicking the button (see 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

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.

488 EIO0000001309 06/2017

 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 579).
Name Identifier of the variable.
The field is editable (see page 491).
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 task menu of the Control
Participant 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.

EIO0000001309 06/2017 489

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 task
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: Process Expert opens the Manage Network Variables dialog box. 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 software displays the network variables in the New Network Variables section.
NOTE: Right-click a network variable to open a contextual menu, which allows you to make
changes (see page 491).
3 Save your changes (see page 489).
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.

490 EIO0000001309 06/2017

 Refinement Stage

Modifying Network Variables

Depending from where you have opened the Manage Network Variables dialog box, there are
different ways to save your changes (see page 489).
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.
Press Enter to confirm your entry.
Changing the name of Double-click the Name of the variable and enter a new name with free form text.
the variable Press Enter to confirm your entry.
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 604).
You can also select a variable and press Del.

EIO0000001309 06/2017 491

Refinement Stage

Section 17.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 Process Expert.
 Assign animated graphics to pages of the project, using the Edit command.
 Edit Participant project settings by using the Advanced Settings command.
 Add include projects and user files.

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 91). In such case, check the
Notification Panel (see page 94) for details.

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: Process Expert opens the Supervision Participant in a reduced window.
2 Maximize the Supervision Participant window.
3 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 Process Expert, Supervision
Participant Services, User Guide).

492 EIO0000001309 06/2017

 Refinement Stage

Step Action
4 Click the save button in the toolbar of the Participant window to save the changes in the logical

Supervision Participant project.

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 To save changes in the logical Supervision Participant project and close the Participant
window.
No To discard changes and close the Participant window.
Cancel Does not save changes and leaves the Participant window open.

Editing Supervision Project Pages

To edit a Supervision Page, proceed as follows.

Step Action
1 In the Project Explorer, open the Pages folder.
Result: Process Expert opens the Pages folder and displays the pages it contains.
2 In the Containers pane, right-click the page you want to edit and select Edit.
Result: The software opens the Supervision Participant window in a new tab and displays the
Browser pane next to it.
3 Maximize the Supervision Participant window.
4 Edit the page as required.
For more information on assigning genie facets, refer to Editing Supervision Pages
(see Process Expert, Supervision Participant Services, User Guide).
5
Click the save button in the toolbar of the Participant window to save the changes.
Result: The software displays the facets that encapsulate the genies that you have assigned in
the Assignments pane of the Pages folder. The Assignment and Generation statuses of these
facets are Assigned and Generated respectively.
If you have deleted an already assigned genie, the corresponding facet is removed from the
Assignments pane.
6 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 To save changes you made to the page and close the Participant window.
No To discard changes and close the Participant window.
Cancel Does not save changes and leaves the Participant window open.

EIO0000001309 06/2017 493

Refinement Stage

NOTE: The software adds include projects to the Supervision Participant project when you assign
the first genie to a page. You can download include projects (see page 641) as soon as the
software has added them.

Editing Advanced Supervision Project Settings

To edit advanced project settings, proceed as follows.

Step Action
1 Right-click the Supervision project and select Advanced Settings.
Result: Process Expert opens the Supervision Participant in a reduced window.
2 Maximize the Supervision Participant window.
3 Proceed with changes to the advanced project settings.
For more information, refer to Editing Advanced Project Settings (see Process Expert,
Supervision Participant Services, User Guide).
4
Click the save button in the toolbar of the Participant window to save the changes.
5 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 To save changes you made to the advanced settings and close the Participant window.
No To discard changes and close the Participant window.
Cancel Does not save changes and leaves the Participant window open.

NOTE: You need to deploy (see page 701) the Supervision project to apply changes to advanced
project settings.

Adding Include Projects

You cannot add an include project if the software has already added to the Participant project an
include project with the same name.
To add external include projects to a Supervision Participant project, proceed as follows.

Step Action
1 Right-click the Supervision project to which you want to add an include project and select Include
Projects.
Result: Process Expert opens the Include Projects tab in the Supervision project folder.
2 Click Add.
Result: The software opens a dialog box.

494 EIO0000001309 06/2017

 Refinement Stage

Step Action
3 Browse to the location where the include project file (.ctz) is stored, select it, and click Open.
Result:
 If an include project with the same name already exists in the Participant project, the software
displays a notification:
 Click OK to acknowledge.
 Close the Include Projects tab.

 If an include 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 include project that exists in the contents repository.
 Click No to cancel the process without adding the include project.

 If no include project with the same name already exists, the software:
 Stores the selected file in the contents repository.
 Displays the selected file in the dialog box.

NOTE: The software deploys any include project that you add.
4 Close the Include Projects tab.

NOTE: To remove an include project, which appears in the dialog box, from the Supervision
project, select the file and click Remove. After you acknowledge the command, the software
removes the file from the dialog box and deletes the file from the contents repository.

Attaching External Files

To add external files to a Supervision project, proceed as follows.

Step Action
1 Right-click the Supervision project to which you want to add files and select Attach User Files.
Result: Process Expert opens the Attach User Files tab in the Supervision project folder.
2 Click Add.
Result: The software opens a dialog box.
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 dialog box.

NOTE: The software includes files that you attach into the Supervision project, which it deploys
during deployment.
4 Close the Attach User Files tab.

NOTE: To remove a file that appears in the dialog box from the Supervision project, select the file
and click Remove. The software removes the file name from the dialog box, and deletes the file in
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 703).

EIO0000001309 06/2017 495

Refinement Stage

496 EIO0000001309 06/2017

 Process Expert
Configuration Stage
EIO0000001114 05/2017

Chapter 18
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 70) 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 Creating the Topology of the System 498
18.2 Managing the Topology 553

EIO0000001309 06/2017 497

Configuration Stage

Section 18.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.
Process Expert 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 architectures supported by Process Expert, refer to the topic describing
integrated architectures (see 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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Organizing the System Topology 499
Selecting Topological Templates 503
Configuring a Controller 504
Configuring a Station Node 514
Configuring an STB Island 521
Configuring a PROFIBUS Remote Master and Decentralized Peripherals 527
Configuring Modbus TCP and Ethernet IP Devices 532
Configuring HART Modules 538
Configuring an Ethernet Network 541
Connecting to an Ethernet Network 543

498 EIO0000001309 06/2017

 Configuration Stage

Organizing the System Topology

Before Starting
The topology of the system is defined through topological entities (see page 47), 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.

Accessing the Topology Explorer

To access the Topology Explorer, right-click the system from the Systems Explorer tree view and
select Open Topology.
You can also access it from the context menu of the system root folder of the application or the
project explorers.

Topology Explorer Window

The following figure provides a typical view 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 network device
5 Controller folder (collapsed view)

EIO0000001309 06/2017 499

Configuration Stage

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: Process Expert creates a topology folder and displays it in the tree view.
NOTE: To create a subfolder, repeat step 1 at the topology folder level.

Topology Folder Actions

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

When You select... Process Expert...

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 Application opens the Application Explorer, which allows you to start the instantiation stage or access
the application of the system.
The command is available from the root folder only.
Open Project opens the Projects Explorer (see page 271), which allows you to start the project definition
stage or access the Control and Supervision projects of the 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 541)
Create Station Node creates a station node entity and displays it in the tree view. For example, a station node can
(see page 514) represent a Supervision I/O server or a PC emulating simulator software.
Create Controller displays a submenu, which allows you to create a controller entity of the supported platforms
(see page 504) (see Process Expert, Control Participant Services, User Guide).
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 Island creates an STB island entity and displays it in the tree view.
(see page 521) The topological entity represents the segments, communicator, STB island modules, and
devices connected through the CANopen bus of the island once you have configured them.

500 EIO0000001309 06/2017

 Configuration Stage

When You select... Process Expert...

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 to
(see page 527) the PRM by using device type managers (DTMs) and generic station description (GSD) files.
Create Device IO Opens a submenu containing the following commands:
(see page 532)  Modbus TCP
 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 779) between such device and the controller by
using Modbus TCP (I/O scanning and explicit) or Ethernet IP (explicit) messaging.
Update Template updates the template that is used by entities inside the folder and any subfolder with the
(see page 555) latest version of that template, which is available in the Global Templates library on the
system server.
Export (see page 557) opens the Export window, which allows you to select the topological entities that you want
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 (see page 560) opens the Import window, which allows you to select an export file (.sbk). In a second step,
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.

NOTE: Refer also to the topic describing common folder actions (see page 153).

EIO0000001309 06/2017 501

Configuration Stage

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 107).
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

502 EIO0000001309 06/2017

 Configuration Stage

Selecting Topological Templates

Overview
When you create a topological entity, Process Expert 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 555) 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 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 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.

EIO0000001309 06/2017 503

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 Process Expert 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 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.

IP Address Validation by Subnet Mask

The CPU module of an M580 platform controller and the NOC communication module validate IP
addresses based on the subnet mask. To implement communication through I/O scanning with
such modules, client/server IP addresses need to belong to the same subnet (for example, IP
addresses of the client-side NOC communication module and of the Modbus TCP device entity).

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.

504 EIO0000001309 06/2017

 Configuration Stage

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: Process Expert creates a controller entity and displays it in the tree view.
2 For controllers of the M580 platform, set the CpuVersion property in the Properties window
(see page 507).

Controller Actions
Right-click the controller entity to open a context menu with the following commands.

When You Select... Process Expert...

Configure opens the Control Participant, which allows you to configure the controller hardware,
(see page 509) in-rack modules, drops, and communication services.
Physical opens the Physical Connections window, which allows you to connect or disconnect
Connections communication modules of the controller that support Ethernet to existing Ethernet
(see page 546) networks to represent physical connections to such networks.
Update Template opens the Update Template dialog box, which allows you to update the templates that
(see page 555) 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 644) Participant project and deploy it entirely to the controller.
Deploy Changes / deploys to the controller the differences between the deployed Control Participant
Undo Online project and the corresponding built Control Participant project.
Changes
(see page 644)
Re-Deploy Last lets you deploy once again the entire built Control Participant project that you had
Project deployed to the controller last.
(see page 644) 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 file
(see page 679) 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 712) starts the execution of the participant project by the controller.
Stop (see page 712) stops the execution of the participant project by the controller.
Refine Online lets you modify the deployed Control Participant project online.
(see page 712)

EIO0000001309 06/2017 505

Configuration Stage

When You Select... Process Expert...

Sync (Primary→ lets you synchronize the standby controller with the primary one.
Standby) The command is available only for redundant controllers.
(see page 729)
Update Control updates 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 712) 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 748) 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 658) 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.
Clear Password Opens the Clear Password dialog box, which lets you remove (see page 661) 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 661).
Delete deletes the controller entity including controller devices and related configurations.
(see page 513)
Rename lets you change the identifier of the controller entity.
Export opens the Export window, which allows you to export the entity and its folder hierarchy
(see page 557) in the form of a topology export file (.sbk).
Properties displays the Properties window in which you can view and edit properties of the
controller entity.

NOTE: Refer also to the topic describing common folder actions (see page 153).

506 EIO0000001309 06/2017

 Configuration Stage

Controller Properties
Right-click the controller entity and select Properties to display the Properties window in which you
can view and edit the properties of the controller entity.
You can view and/or edit the following items.

Item Description
General Identifier The identifier must be unique within the system and satisfy
naming rules (see page 107).
Default value: Controller_n where n is an incremental number
starting at 1.
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 624).
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
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 643).
Controller Value Indicates the hardware platform that the controller belongs to.
Family You cannot edit this item.
CpuVersion CpuVersion Indicates the firmware version of the CPU module that is
configured.
The property is displayed only after you save the controller
configuration.

EIO0000001309 06/2017 507

Configuration Stage

Item Description
$Name ServerMemoryStart Holding register address (%MW) for peer to peer data.
(see page 511) (Integer)
of Default value: Blank
communication You can only enter an odd address (see page 626) for this
parameter (for example, 1. 5, 11).
module(2)
For more information, refer to Configuring the Controller I/O
Scanner Parameters (see page 510).
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 626) 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 510).
$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 510).
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 510).
Password Security Password Lets you manage password protection (see page 655) 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 177),
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.

508 EIO0000001309 06/2017

 Configuration Stage

(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 511).

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: Process Expert displays the Control Participant in a reduced window.
2 Maximize the Control Participant.
3 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 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 503) 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.

EIO0000001309 06/2017 509

Configuration Stage

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 579) and hardware mapping (see page 605) of this executable.
In such case, the software displays a notification asking you to confirm the change. Click:
 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 Process Expert, Control Participant
Services, User Guide).

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 Process Expert 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 579).
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
online help.
NOTE: If you reduce the value of the size (see page 584) 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.

510 EIO0000001309 06/2017

 Configuration Stage

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 692) 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 507) 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 Process Expert, Control Participant
Services, User Guide) by using the Control Participant.

Controller Representation
The Topology Explorer allows you to view the topological devices representing the following
hardware components of the controller entity that you have configured:
 Racks
 Buses
 Power supplies
 CPUs
 Communication modules
 I/O modules

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

2 Controller local bus folder
3 Controller local rack folder
4 Controller local rack module folder

EIO0000001309 06/2017 511

Configuration Stage

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.

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.

512 EIO0000001309 06/2017

 Configuration Stage

Right-click a device and select Properties to open the corresponding Properties window to view its
parameters, for example:
 Its reference
 Its position on the rack
 Its address on the network
 Physical interface links with Ethernet networks
 Implicit connections within the entity

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 543) 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.

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 591)
 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: Process Expert displays a notification dialog box.
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.

EIO0000001309 06/2017 513

Configuration Stage

Configuring a Station Node

Overview
The station node is a topological entity, which represents the hardware and software that is
installed on a PC workstation that is connected to the Ethernet network, and that is relevant for the
system.
Station nodes can act as engines for executing:
 OPC Factory Server software
 Supervision runtime
 Control projects by emulating a simulator (see page 649)

For example, station nodes represent operation clients, or Supervision servers, which are
connected to the Ethernet network.
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: Process Expert creates a station node entity and displays it in the tree view.
NOTE: By default, Process Expert 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 503) dialog box.

Station Node Actions

Right-click the station node folder to open a context menu with the following commands.

When You Select... Process Expert...

Create NIC creates an NIC device and displays it in the station node folder.
(see page 517) The NIC provides connectivity to the Ethernet network through the Physical
Connections (see page 543) dialog box.
Create OFS creates an OPC Factory Server service and displays it in the station node folder
(OFS_1).
Create the OPC Factory Server service to communicate between Process Expert and
the I/O server and to be able to map the I/O server component of the Supervision
project to the station node in the Mapping stage (see page 615).
You can create one OPC Factory Server service per station node.
Right-click the service and select Properties to access its parameters (see page 519).

514 EIO0000001309 06/2017

 Configuration Stage

When You Select... Process Expert...

Create UnityPro creates a Unity Pro service and displays it in the station node folder (UnityPro_1).
Create the service to:
 Deploy (see page 644) a built Unity Pro Participant project to software emulating a
simulator that is running on the PC.
 Map the station node to the I/O device of a Supervision project for simulating
Supervision runtime services.
You can create one Unity Pro service per station node.
Right-click the service and select Properties to access its parameters (see page 519).
Create VJC creates a Supervision service and displays it in the station node folder (VJCitect_1).
Create the Supervision service to be able to map the I/O(1), Alarm, Trend, and Report
server and the client components of the Supervision project to the station node in the
Mapping stage (see page 615).
You can create one Vijeo Citect service per station node.
Right-click the service and select Properties to access its parameters (see page 519).
(1) Requires also an OFS service.
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 548) connections to such networks.
Update Template opens the Update Template dialog box, which allows you to update the templates that
(see page 555) 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.
Supervision opens a submenu that contains the Deploy Built Project command.
It lets you select a built Supervision participant project and deploy it to the station node
(see page 704).
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.
Delete deletes the station node entity including services and related configurations.
Rename allows you to 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 557) 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.

NOTE: Refer also to the topic describing common folder actions (see page 153).

EIO0000001309 06/2017 515

Configuration Stage

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.

When You Select... Process Expert...

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 644).
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 644)
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 644) 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 679) 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 712) starts the execution of the deployed Unity Pro Participant project in the simulator.
Stop (see page 712) stops the execution of the deployed Unity Pro Participant project in the simulator.
Refine Online lets you change the deployed Control Participant project online.
(see page 712)
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 712) 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 748) 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 658) 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 661) the
application password of the deployed Control Participant project.
The command is available only if you have set a password.

516 EIO0000001309 06/2017

 Configuration Stage

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.
You can edit the following items.

Parameter Description
General Identifier The identifier must be unique within the system and satisfy naming
rules (see page 107).
Default value: StationNode_n where n is an incremental number
starting at 1.
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
Unity Pro Password Security Lets you manage password protection (see page 655) for
Protection Password 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 177), which is set at
the system level.
Default value: Enabled once you create the Unity Pro service in the
station node.
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.

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: Process Expert opens the station node folder and displays the NIC device.
NOTE: The software may display the Select Template (see page 503) dialog box.

EIO0000001309 06/2017 517

Configuration Stage

NIC Actions
Right-click the NIC device to open a context menu with the following commands.

When You Select... Process Expert...

Update Template Opens the Update Template dialog box, which allows you to update the template that
(see page 555) 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.

NIC Properties
Right-click the NIC device and select Properties to open the Properties window in which you can
view and edit parameters of the NIC device.
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 107).
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 that is assigned to the NIC on the network.
Default address for the NIC that is created when you create
the station node: [Link], corresponding to the
localhost. 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 651)
that is displayed by the simulator software running on the
station node.
SubNet Mask Subnet mask of the NIC on the network.
Default value: Blank

518 EIO0000001309 06/2017

 Configuration Stage

Parameter Description
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 548) 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.

OFS, Unity Pro, and VJC Instance Actions

Right-click an OFS, Unity Pro, or VJC instance to open a context menu with the following
commands.

When You Select... Process Expert...

Update Template Opens the Update Template dialog box, which allows you to update the template that
(see page 555) 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.

OFS, Unity Pro, and VJC Instance Properties

Right-click an OFS, Unity Pro, or VJC instance and select Properties to open the Properties
window in which you can view and edit parameters of the service instance.

EIO0000001309 06/2017 519

Configuration Stage

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 107).
Default value: Service_n where:
 Service corresponds to the name of the service you
have selected (for example, UnityPro.
 n is an incremental number starting at 1.

$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

520 EIO0000001309 06/2017

 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 Process Expert 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 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: Process Expert creates an STB island entity and displays it in the tree view.

STB Island Actions

Right-click the STB island entity to open a context menu with the following commands

When You Select... Process Expert...

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 550) networks.

EIO0000001309 06/2017 521

Configuration Stage

When You Select... Process Expert...

Update Template opens the Update Template dialog box, which allows you to update the templates that
(see page 555) 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 557) in the form of a topology export file (.sbk).
Delete deletes the STB island entity including its devices and related configurations.
(see page 525)
Rename allows you to change the identifier of the STB island entity.
Properties displays the Properties window in which you can view and edit properties of the STB
island.

NOTE: Refer also to the topic describing common folder actions (see page 153).

STB Island Properties

Right-click the STB island entity and select Properties to display the Properties window in which
you can view and edit the properties of the STB island.
You can view and/or edit the following items.

Item Description
General Identifier The identifier must be unique within the system and satisfy naming
rules (see page 107).
Default value: Advantys_n where n is an incremental number starting
at 1.
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 624).
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

522 EIO0000001309 06/2017

 Configuration Stage

Item Description
Advantys IPAddress IP address of the NIM of the STB island on the Ethernet network.
NIM Default value: Blank
Identifier(1) Subnet Mask Subnet mask of the NIM of the STB island on the Ethernet network.
Default value: Blank
NOTE: Verify that the IP address is within the valid range for the
subnet mask (see page 504) that you configure.

(1) The section is displayed once the software has completed the process to transfer the
configuration of the STB island to the Topology Explorer.
NOTE: To view the parameters of the devices representing the hardware modules of the STB
island, refer to STB Island Representation (see page 524).

Changing STB Island Properties

Modifying the IP address or subnet mask (see page 504) of an STB island, may delete the
communication mapping (see page 579) that exists with this STB island.
In such case, the software displays a notification asking you to confirm the change. Click:
 Yes: To save the change to the properties of the STB island and delete the associated
communication mapping.
 No: To discard your changes.

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: Process Expert displays the Control Participant in a reduced window.
2 Maximize the Control Participant.
3 For more information about configuring the STB island and working inside the Control
Participant, refer to the Control Participant Services User Guide (see Process Expert, Control
Participant Services, User Guide).

EIO0000001309 06/2017 523

Configuration Stage

Step Action
4 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 503) 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
5 Right-click the STB island entity and select Properties.
6 Enter the IP address and the subnet mask of the STB island.
7 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 785) for details about
implementing communication by using the I/O scanner of the controller.

STB Island Representation

The Topology Explorer displays the devices representing the following hardware components of
the STB island entity that you have configured:
 Segments
 Bus
 Power supply
 CPU
 NIM
 I/O modules
 Devices connected through the CANopen fieldbus

Right-click a device and select Properties to open the corresponding Properties window to view the
parameters of the hardware module, for example:
 Its reference
 Its position
 Its address

524 EIO0000001309 06/2017

 Configuration Stage

 Physical interface links with Ethernet networks

 Implicit connections within the entity
You can view and edit parameters of devices by right-clicking a folder and selecting Properties.
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)

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.

EIO0000001309 06/2017 525

Configuration Stage

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: Process Expert displays a notification dialog box.
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.

526 EIO0000001309 06/2017

 Configuration Stage

Configuring a PROFIBUS Remote Master and Decentralized Peripherals

Overview
Process Expert 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 Process Expert 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 605).
NOTE: You can install additional DTMs and GSD files in the virtual machine (see Process Expert,
Installation and Configuration Guide).

Virtual Machine Usage

The configuration of one PRM entity uses up one session of the Control Participant of the virtual
machine (see 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: Process Expert creates a PRM entity and displays it in the tree view.
2 Right-click the PRM entity and select Properties.
Result: Process Expert opens the Properties window of the PRM entity.
3 Select the controller platform that the PRM is communicating with in the menu of the
ControllerFamily property (see page 529).
Result: When you configure the PRM entity (see page 530), the software loads the
corresponding base configuration.

EIO0000001309 06/2017 527

Configuration Stage

PRM Actions
Right-click the PRM entity to open a context menu with the following commands.

When you select... Process Expert...

Configure opens the Control Participant, which allows you to configure the PRM and DPs by
(see page 530) 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 546) networks.
Update Template opens the Update Template dialog box, which allows you to update the templates that
(see page 555) 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 557) in the form of a topology export file (.sbk).
Delete deletes the PRM entity including DPs and related configurations.
(see page 531)
Rename allows you to change the identifier of the PRM entity.
Properties displays the Properties window in which you can view and edit properties of the PRM
entity.

NOTE: Refer also to the topic describing common folder actions (see page 153).

528 EIO0000001309 06/2017

 Configuration Stage

PRM Properties
Right-click the PRM entity and select Properties to display the Properties window in which you can
view and edit the properties of the PRM entity.
You can view and/or edit the following items.

Item Description
General Identifier The identifier must be unique within the system and satisfy
naming rules (see page 107).
Default value: Controller_n where n is an incremental number
starting at 1.
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 624).
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 577) 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 530).

EIO0000001309 06/2017 529

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: Process Expert displays the Control Participant in a reduced window.
2 Maximize the Control Participant.
3 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.
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 503) 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 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 579) of the PRM.
In such case, the software displays a notification asking you to confirm the change. Click:
 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 530).

PRM and DP Representation

The Topology Explorer allows you to view the topological devices representing the following
components of the PRM entity that you have configured:
 PROFIBUS fieldbus
 PRM master
 PROFIBUS DPs

530 EIO0000001309 06/2017

 Configuration Stage

Right-click a device and select Properties to open the corresponding Properties window to view the
parameters of the hardware module, for example:
 Its reference
 Its communication properties, such as the address on the network.
 Physical interface links with Ethernet networks.
 Implicit connections within the entity.

You can view and/or edit parameters of devices by right-clicking a device and selecting Properties.
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: Process Expert displays a notification dialog box.
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.

EIO0000001309 06/2017 531

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 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 845).

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: Approved or Deprecated

532 EIO0000001309 06/2017

 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 192) to search for topological Modbus TCP device templates.
2 Filters (see page 193). The check mark indicates that the filter is applied.
3 Button to toggle between grid view and tree view mode.

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 of the template.
Description Description of the template.

EIO0000001309 06/2017 533

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.

When You Select... Process Expert...

Physical opens the Physical Connections window, which allows you to connect or disconnect
Connections the device to existing Ethernet networks to represent physical connections to such
(see page 549) networks.
Update Template opens the Update Template dialog box, which allows you to update the template that
(see page 555) is 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
template that is used by the device with another template that meets the criteria
(see page 532) 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 525)
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 557) in the form of a topology export file (.sbk).
Properties displays the Properties window in which you can view and edit properties of the device
entity.

534 EIO0000001309 06/2017

 Configuration Stage

I/O Device Properties

Right-click the device entity and select Properties to open the Properties 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 107).
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 624).
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 that is assigned to the device.
Default value: Blank
Subnet Mask Subnet mask of the device.
Default value: Blank
NOTE: Verify that the IP address is within the valid range for
the subnet mask (see page 504) that you configure.
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 617) of Supervision
executables.

EIO0000001309 06/2017 535

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).
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.
 : 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 605).
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.
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.

536 EIO0000001309 06/2017

 Configuration Stage

(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.
(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 549) 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 (see page 504) of an I/O device entity, may delete the
communication mapping (see page 579) that exists with this device.
In such case, the software displays a notification asking you to confirm the change.
Click:
 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 779).

EIO0000001309 06/2017 537

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 521).

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 Process Expert system level.
NOTE: You need to use an Asset Management System and perform some additional steps
manually to take advantage of the advanced functionality provided by HART analog I/O modules.

HART Module Device DDT

When you add a HART analog I/O module to a configuration, the Participant creates a read-only
variable associated with a device DDT (DDDT).
When you add the corresponding device type manager (DTM) that is preinstalled in the virtual
machine, it creates a second read-only variable associated with another DDDT.
Both variable names 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 623).

538 EIO0000001309 06/2017

 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: Process Expert 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 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 503) 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.

HART Module Representation

The Topology Explorer allows you to view the topological devices representing HART analog
I/O modules.
Right-click a device and select Properties to open the corresponding Properties window to view the
parameters of the hardware module, for example:
 Its reference
 Its position on the rack.
 the DDDT name.

EIO0000001309 06/2017 539

Configuration Stage

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.

540 EIO0000001309 06/2017

 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: Process Expert creates an Ethernet network entity and displays it inside the folder.
NOTE: The software may display the Select Template (see page 503) dialog box.

Ethernet Network Actions

Right-click the Ethernet network entity to open a context menu with the following commands:

When You Select... Process Expert...

Update Template opens the Update Template dialog box, which allows you to update the template that
(see page 555) 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 557) 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 Properties window in which you can view and edit properties of the device.

EIO0000001309 06/2017 541

Configuration Stage

Ethernet Network Properties

Right-click the Ethernet network entity and select Properties to open the Properties 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 107).
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 511).
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 543) 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.

542 EIO0000001309 06/2017

 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 proceed with the
communication mapping (see page 571) on 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 511).
To make a physical connection, create an Ethernet network first (see page 541).
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 511) 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 544).

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 542).
 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.

EIO0000001309 06/2017 543

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, Process Expert displays a dialog box 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 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 510).

544 EIO0000001309 06/2017

 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 to
connection of module module in the standby the Ethernet network
in standalone controller after changing to
configuration 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.

EIO0000001309 06/2017 545

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: Process Expert 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.

546 EIO0000001309 06/2017

 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: Process Expert 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 544), 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 510) 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.

EIO0000001309 06/2017 547

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: Process Expert 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: Process Expert 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 579) 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.

548 EIO0000001309 06/2017

 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: Process Expert 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: Process Expert 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.

EIO0000001309 06/2017 549

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 605) and communication mapping
(see page 579) 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: Process Expert 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.

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: Process Expert 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.

550 EIO0000001309 06/2017

 Configuration Stage

Step Action
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 605) and communication mapping
(see page 579) 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: Process Expert 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 530) 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.
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.

EIO0000001309 06/2017 551

Configuration Stage

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: Process Expert 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 605) and communication mapping
(see page 579) 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.

552 EIO0000001309 06/2017

 Configuration Stage

Section 18.2
Managing the Topology

Managing the Topology

Overview
This section describes how to use Process Expert 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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Moving Topological Folders and Entities 554
Updating Templates of Topological Entities 555
Exporting Topological Entities 557
Importing Topological Entities 560

EIO0000001309 06/2017 553

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.

Moving Topological Entities

You can move any topological entity to another folder, including the system root folder by dragging
it.

554 EIO0000001309 06/2017

 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.

Accessing the Command

Right-click a folder or an entity, and select Update Template.

Description of the Update Functionality

Process Expert 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.
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 543) template links that are not part of the new template or that do not satisfy
applicable rules are removed.

EIO0000001309 06/2017 555

Configuration Stage

Item Identifier in New Template Action

Mappings – The software maintains existing service, communication, and
(see page 572) 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: Process Expert:
 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.

556 EIO0000001309 06/2017

 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 560) functionality of the Topology Explorer to:
 Transfer project information to a different system or Process Expert platform.
 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 Process Expert that you use to import the information contained in the export file
must be the same as the version used to create the export file; 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 563).
NOTE: Passwords (see page 655) are not exported. Yet, the password protection properties
(see page 507) and their value are exported.

EIO0000001309 06/2017 557

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 Process Expert platform, the Global Templates library of
the target Process Expert platform 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 898).

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

558 EIO0000001309 06/2017

 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 94). 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.

EIO0000001309 06/2017 559

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 284) functionality of
the Topology Explorer of Process Expert.
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 568).
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 Process Expert that you use to import the information contained in the export file
must be the same as the version used to create the export file; 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 Process Expert platform and the necessary templates for
an entity are not present, then the entity is skipped during import.
Information on the necessary 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 898).

560 EIO0000001309 06/2017

 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 564) 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 562).
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 543).
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 563).
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.

EIO0000001309 06/2017 561

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 identifier.  Properties of the entity and its station node may affect
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 identifier. devices are updated. removing a module of a
 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 507). 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 with a new identifier. devices are updated. such as:
 Position of modules are updated.  IP address.
DP
 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 identifier.  Entity is moved if path in export file affect existing hardware and/or
device differs. communication mappings of
the related executables.
Ethernet network Creates the entity  Properties are updated. Existing physical connections
with a new identifier.  New physical connections are in the target system are not
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 563).

562 EIO0000001309 06/2017

 Configuration Stage

Import Rules for Physical Connections

When you import an entity for which a physical connection (see page 543) to an Ethernet network
existed at the time of export and the target system contains no Ethernet network with the same
identifier, Process Expert 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 561)
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 544).

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 507) 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 655).
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.

EIO0000001309 06/2017 563

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 561).
The following figure shows an example of the Import window displaying the contents of the
selected topological export file.

564 EIO0000001309 06/2017

 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 561).
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 566),
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 function was called becomes
the parent folder of the imported folder structure. The hierarchy inside the imported folder
structure remains unchanged.
 Absolute Path: When selected, Process Expert maintains the hierarchy, which 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.

EIO0000001309 06/2017 565

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 561).
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.

566 EIO0000001309 06/2017

 Configuration Stage

Item Description
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 562) 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.
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 94). 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 564), 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 564).
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.

EIO0000001309 06/2017 567

Configuration Stage

Step Action
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.

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 NIC_1 NIC_1 NIC_1
Unity_Pro OFS OFS
VJC VJC
Properties Description: Simulator Description: Supervision server Description: Supervision
server
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

568 EIO0000001309 06/2017

 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 target What is Imported Result

system
Update action is selected
Entity identifier Entity_1 Entity_1 Entity_1
IP address IP 1 IP address already IP address of export file
used on network_1 of
target system
Physical connection to Connected Connected at time of Not connected
network_1 export
Create action is selected
Entity identifier Entity_1 Entity_1 Entity_1 Entity_1_1

EIO0000001309 06/2017 569

Configuration Stage

Element What is in the target What is Imported Result

system
IP address IP 1 IP 1 IP 1 IP 1
Physical connection to Connected Connected at time of Connected Not connected
network_1 export

570 EIO0000001309 06/2017

 Process Expert
Mapping Stage
EIO0000001114 05/2017

Chapter 19
Mapping Stage

Mapping Stage

Overview
This chapter provides information to help you 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 72) 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 Mapping Stage 572
19.2 Supervision Project Mapping Stage 611

EIO0000001309 06/2017 571

Mapping Stage

Section 19.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 399) and the Configuration stage
(see page 497) 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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Creating Control Project Executables 573
Mapping Services 577
Mapping Communication 579
Mapping Network Variables 594
Mapping Hardware 605

572 EIO0000001309 06/2017

 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 498) 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 a Control Executable

To create the Control executable, proceed as follows.

Step Action
1 In the Project Explorer, right-click the Executables folder of the Control project that you want to
map and select Create Executable.
Result: Process Expert creates an executable and displays it in the Executables tab inside the
Executables folder.

Control Executable Description

The following fields are displayed in the Executables tab.

Header Description
Identifier Unique identifier of the executable.
Refer to Control Executable Properties (see page 575) for a description of the field.
Build State Indicates the status (see page 628) of the executable.
Default value: Not Built
Built On Date and time when you last built the executable successfully by using a build command.
Execution Indicates the execution domain (see page 575) to which the executable is assigned.
Domain
Description Description of the executable.
Refer to Control Executable Properties (see page 575) for a description of the field.

EIO0000001309 06/2017 573

Mapping Stage

Control Executable Actions

Right-click the executable to display a context menu with the following commands.

When you select... Process Expert...

Map Service opens the Service Mapping tab inside the Executables folder, which allows you to
(see page 577) associate the logical Control Participant project to an engine of the system.
Map Communication opens the Communication Mapping Editor window, which allows you to define the
(see page 579) communication channels that the software creates for communication through Modbus
TCP Ethernet (I/O scanning) between a controller and:
 Modbus TCP I/O devices
 STB islands
 PRMs
 Other controllers for peer to peer communication

It also allows you to adjust communication channel properties and map network
variables, which you have created to exchange data between Control projects.
The command is available once you have done the service mapping.
NOTE: The command appears only when the executable is mapped to a topological
entity, which supports communication mapping, such as a controller.
Map Hardware opens the Hardware Mapping Editor window, which allows you to map the interfaces
(see page 605) of the instances of the application to hardware channels of the controller. It also allows
you to map interfaces to entities communicating with the controller by using Modbus
TCP (I/O scanning and explicit) or Ethernet IP messaging).
The command is available once you have done the service mapping.
NOTE: The command appears only when the executable is mapped to a topological
entity, which supports hardware mapping, such as a controller.
Build starts an automated process to integrate certain changes in the built Control
(see page 622) Participant project by performing an incremental build.
The command becomes available once you have done the service mapping.
Build All starts an automated process to create (see page 623) the built Control Participant
project the first time or to recreate it to integrate certain changes (see page 630) that
you have made to the Control Participant project or the system topology.
The command becomes 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 404) 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 94). 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 629) program and configuration.
The command becomes available once you have built the Control Participant project.

574 EIO0000001309 06/2017

 Mapping Stage

When you select... Process Expert...

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 308).
Rename allows you to enter a new identifier for the executable.
Properties opens the Properties tab inside the Executables folder, which allows you to view and
edit properties of the executable.

Control Executable Properties

To access the Properties tab, right-click the executable and select Properties.
You can view and edit the following properties.

Property Description
Identifier The identifier must be unique within a Control Participant project.
Click the field to edit it and press Enter to validate the entry.
Default value: Executable_n where n is an incremental number starting at 1.
Description Optional.
You can enter a description for the executable with free form text.
Execution Optional.
Domain String.
Default value: Blank.
You can exchange data between projects through peer to peer communication or use
runtime navigation services (see Process Expert, Runtime Navigation Services, User Guide)
only if the associated executables have the same execution domain value.
These are:
 For peer to peer communication: The executable of the owner project and the executable
of the consumer project.
 For runtime navigation services: The executable of the Control Participant project and the
executable of the Supervision Participant project.
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 blank is considered as a value.

EIO0000001309 06/2017 575

Mapping Stage

Assigning an Execution Domain

To assign an execution domain to a Control executable, proceed as follows.

Step Action
1 In the Project Explorer, open the Executables folder of the Control project.
2 Double-click the executable to which you want to assign an execution domain.
Result: The software opens the Properties tab of the executable.
3 Select a value from the menu or enter a new value.
4 Press Enter to confirm your selection or entry.

NOTE: To remove or change the associated execution domain, select the empty row at the top of
the menu and press Enter to confirm the selection.

576 EIO0000001309 06/2017

 Mapping Stage

Mapping Services

Introduction
The Service Mapping window allows you to associate the logical Control Participant project to
entities acting as engines (see page 498) through its Control executables (see page 573).
These engines are controllers and station nodes of the topology of the system.
NOTE: If the Controller Family is not the same for the entity and the Control project (see page 272)
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 window. 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 529).

Mapping to a Redundant Controller

The software displays the identifier of the controller entity in the Service Mapping window 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 window only if you have created a UnityPro
service (see page 514) 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.

Mapping Services
To map the Control executable to an engine, proceed as follows.

Step Action
1 in the Project Explorer, right-click the executable of the Control project that you want to map and
select Map Service.
Result: Process Expert opens the Service Mapping window inside the Executables folder.
2 Click the field in the Engine column.
Result: The menu displays the identifiers of compatible entities of the topology of the system.

EIO0000001309 06/2017 577

Mapping Stage

Step Action
3 Select an entity.
Result: The software maps the Control executable to the selected entity.
4 Click the close button of the Service Mapping window.

NOTE: To remove a mapping, in the Service Mapping window, right-click an entity and select
Unmap.

578 EIO0000001309 06/2017

 Mapping Stage

Mapping Communication

Overview
The Communication Mapping Editor, allows you to define the communication channels that are
used to communicate between the controller that you have configured as client and mapped to the
Control executable in the service mapping (see page 577) 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 function 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 584).
For peer to peer communication, the Communication Mapping Editor also allows you to map
network variables (see page 594) 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 623).
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 781).
 Peer to peer communication (see page 789).

Accessing the Communication Mapping Editor

In the Project Explorer, right-click the Control executable of the logical Control project and select
Map Communication.
Process Expert opens the Communication Mapping Editor.
NOTE: For peer to peer communication, proceed with the communication mapping from the
executable of the consumer project (see page 476).

EIO0000001309 06/2017 579

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.

580 EIO0000001309 06/2017

 Mapping Stage

The figure shows 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 587).

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 [Link]
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: [Link]
Where project is the identifier of the Control Participant project (owner
(see page 476)) that exposes the variables and executable the identifier of the
executable of this project.

EIO0000001309 06/2017 581

Mapping Stage

Column header Description

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.

Description Displays the value of the parameters Read description and Write description that you
can view in the Channel Properties dialog box (see page 584).
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 507) 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 623).
Free Displays the remaining free memory in words for each existing 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 594) 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 584).
Scan Displays the value of the parameter Scan rate that you can adjust through the Channel
Properties dialog box (see page 584).
Timeout Displays the value of the parameter Timeout that you can adjust through the Channel
Properties dialog box (see page 584).

582 EIO0000001309 06/2017

 Mapping Stage

The table describes the fields of the Server Communication Counterparts - Device IO pane.

Field Description
Service element [Link] 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 [Link]
Where project is the identifier of the Control Participant project (owner
(see page 476)) 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.

Communication Channel Actions

Right-click a communication channel in the Communication Channels pane to display a context
menu with the following commands.

When you Process Expert...

select...
Map Opens the Variable Mapping Editor (see page 594), 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 591).
Properties Opens the Device IO: Properties or Peer to Peer: Properties dialog box, which allows you to
view and/or adjust parameter values of the selected communication channel.

EIO0000001309 06/2017 583

Mapping Stage

Communication Channel Properties

When you create a communication channel (see page 589), Process Expert 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.

584 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 585

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 594) 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 594) 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 of the General Purpose library, refer
to the manual documenting Control resources of device templates (see Process Expert, Device
Control Services User Guide).

586 EIO0000001309 06/2017

 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 online 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 online 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 the Variable Mapping Editor from the owner project
by right-clicking it and selecting Map Communication.
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 692) command, which requires stopping the
controller.

EIO0000001309 06/2017 587

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 [Link]
Where project is the identifier of the Control Participant project (consumer
(see page 476)) 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 592).
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.

588 EIO0000001309 06/2017

 Mapping Stage

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.

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 692) 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 right-clicking the executable of the counterpart owner project, and selecting Map
Communication.
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 software opens the corresponding communication channel Properties dialog box.
2 Adjust the values of the communication channel properties as required.

EIO0000001309 06/2017 589

Mapping Stage

Step Action
3 Click OK.
Result: Process Expert:
 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 623).

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 692) 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.

590 EIO0000001309 06/2017

 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 594) of this communication channel is open.
2 Adjust the values of the communication channel properties as required.
3 Click OK.
Result: Process Expert:
 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 623).

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 594) to the deleted channel are unmapped from
the client and server communication channels.
 The build status (see page 630) 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 692) command, which requires stopping the controller.
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.

EIO0000001309 06/2017 591

Mapping Stage

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: Process Expert:
 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 692) command, which requires stopping the controller.
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.

592 EIO0000001309 06/2017

 Mapping Stage

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 Right-click the executable of the owner (see page 476) project and select Map Communication.
Result: The software opens the Communication Mapping Editor.
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, Process Expert:
 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.

EIO0000001309 06/2017 593

Mapping Stage

Mapping Network Variables

Overview
The Variable Mapping Editor 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 476): 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.

Prerequisites
To proceed with the variable mapping, first create a peer to peer communication channel
(see page 579).

Variable Mapping Editor Window

Right-click a peer to peer communication channel in the Communication Mapping pane to open
the Variable Mapping Editor, which allows you to map the network variables to the selected
communication channel.
The syntax of the Variable Mapping Editor window title is <Control Participant project
identifier>.<executable identifier>.<read channel description>_<write channel description>.
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.

594 EIO0000001309 06/2017

 Mapping Stage

The following figure shows an example of the Variable Mapping Editor window.
o

(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 598).
(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
window from the owner project and using its counterpart variable to write to the server
(see page 476). 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.

EIO0000001309 06/2017 595

Mapping Stage

(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 476).
The table describes the fields of the Network Variables and Variables panes.

Column header Description

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 482).
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
Description the Read description or Write description field of this channel; otherwise the field is empty.

596 EIO0000001309 06/2017

 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 626) 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.

EIO0000001309 06/2017 597

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 626) depending on the controller platform.

598 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 599

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.

600 EIO0000001309 06/2017

 Mapping Stage

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.

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 software opens the Variable
the communication channel to which you want to Mapping Editor.
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 598).
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 598) 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.

EIO0000001309 06/2017 601

Mapping Stage

Step Action Result

5 Click OK. Result: The software:
 Maps the variables (see page 598) to the
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.

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.

602 EIO0000001309 06/2017

 Mapping Stage

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 from Server or Result: The software:
Write to Server pane and drag them to the new  Unmaps the variables from their current
compatible empty position. positions, which become available for
mapping.
 Maps the variables (see page 598) 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
compatible empty position. box.
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 598) 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.

EIO0000001309 06/2017 603

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.

604 EIO0000001309 06/2017

 Mapping Stage

Mapping Hardware

Introduction
The Hardware Mapping Editor 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 mapped to the Control executable of the project (service mapping (see page 577)).
The mapping interfaces of application objects appear in the Hardware Mapping Editor as soon as
you assign their facets to the Control Participant project; even without generating them. Application
objects that expose mapping interfaces are instances of HAL templates (for example,
$DISignal_UL), communication port templates (for example, $EMPortM), and hardware
application templates (for example, $TesysTE) or $TSignCptBmx).
You can map interfaces to modules that are connected:
 Physically (for example, in-rack I/O modules)
 Logically (for example, Modbus TCP Device I/Os, PRMs, or STB islands). Connect
(see page 543) the device to the same Ethernet network as the controller first.
If you have created several (see page 573) executables, proceed with the hardware mapping for
each one of them.
NOTE: Process Expert marks variables and DFB instances (see page 633) 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 579).

NOTE: You need to instantiate the necessary application templates first. For details, refer to the
topic describing how to implement communication (see page 779).

Mapping Hardware with a Simulator

The hardware mapping function 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 608) before proceeding with
the mapping.

EIO0000001309 06/2017 605

Mapping Stage

Accessing the Hardware Mapping Editor

In the tree view of the Project Explorer, right-click the executable of the Control project that you
want to map and select Map Hardware.
Process Expert opens the Hardware Mapping Editor.

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 that meet the selected filter criteria in both panes. The
function helps locate compatible interfaces when you have many different interfaces in either pane. The
function is enabled by default.

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.

606 EIO0000001309 06/2017

 Mapping Stage

Editor section Column header Description

Topological Instance 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 a topological entities (see page 511).
Template Identifier of the template that is used by the topological device.
HW Mapping IF Identifier of the hardware mapping interface that is exposed by the
topological device.
HW Mapping Type Indicates the type of the mapping interface and the role of the device.
Instance These columns are blank before you start the mapping process.
The software moves the information contained in the corresponding
Project Facet
columns of project facet pane to these columns when you map the
Facet Type project facet.
HW Interface
HW Mapping Type
Project facet Instance Identifier of the instance that references the facet.
pane Project Facet Identifier of the project facet that can be mapped.
Facet Type Identifier of the template used by the facet.
HW Interface Identifier of the hardware mapping interface that is exposed by the
facet.
HW Mapping Type Indicates the type of the mapping interface and the role of the facet.
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

EIO0000001309 06/2017 607

Mapping Stage

Displaying Compatible Interfaces

To map facets of the Control project to topological devices of an entity, proceed as follows:

Step Action
1 Verify that the Display only compatible interfaces on filtering is selected.
2 In either pane, click the filter icon of the column that you want to use for filtering interfaces.
Result: The software displays the filter menu (see page 143).
3 Enter criteria for filtering and click Filter.
Result: The software displays:
 In the pane in which you have used the filter: Interfaces that meet the filter criteria.
 In the other pane: Interfaces that are compatible with the interfaces that are the result of the
filtering.

NOTE: When you clear the check box, any filter that is applied is cleared and the display refreshed.
NOTE: Applying a filter on an already filtered list clears the filter that is applied on the other pane
and applies the new filter.

Mapping Hardware
To map facets of the Control project to topological devices of an entity, proceed as follows:

Step Action
1 In the right-hand project facet pane, locate and select the facet of the Control project that you want
to map. Use the scroll bar or filters if necessary.
Result: The software highlights the selected facet.
2 In the left hand, topological device pane, locate, and select the topological device interface to which
you want to map the facet that you have selected in step 1. Use the scroll bar or the filter if necessary.
Result: The software highlights the selected instance.
NOTE: The type of the interface that is displayed in the HW Mapping Type column needs to be
identical for both rows, and the interface roles need to be compatible.
3 From the project facet pane, drag the selected project facet on top of the topological device interface.
Result: Process Expert maps the selected facet to the topological device and shifts the information
of the project facet to the respective columns of the topological device pane.
NOTE: Process Expert displays a tooltip if the interfaces do not match and does not proceed with
the mapping.

NOTE:
 To map an already mapped project facet to a different topological device with matching
interface, drag the mapped project facet onto another compatible topological device interface.
 To undo the mapping of an already mapped project facet, drag the project facet from the
topological device pane back to the project facet pane. You can also:
 Select the mapping and press Del.
 Right-click the mapping and select Unmap.

608 EIO0000001309 06/2017

 Mapping Stage

Mapping Several Project Facets Simultaneously

You can drag more than one project facet onto the topological device pane at once by using
multiple selection. Process Expert maps the project facets to contiguous topological device
interfaces in the order they are displayed in the right-hand project facet pane.
The interfaces of each project facet/topological device pair needs to match to complete the
mapping process.
If there is an incompatible topological device interface in between:
1. The balance of the project facets is mapped to the next available topological device interfaces.
2. If some project facets cannot be mapped, the software displays them in a dialog box.
3. When you acknowledge the dialog box, the software:
a. Maps the project facets to compatible topological device interfaces.
b. Displays the facets that could not be mapped in the right-hand project facet pane again.
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 387) the facet and generating the project or section.
 Deleting the instance referencing the facet.
 Unselecting the element (see page 213) 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.

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 686), 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.
EIO0000001309 06/2017 609
Mapping Stage

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 representing the signal quality
of an AnalogInput instance to the facet representing the analog input module 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.

610 EIO0000001309 06/2017

 Mapping Stage

Section 19.2
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 399) and the Configuration (see page 497)
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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Creating Supervision Project Executables 612
Mapping Services 615
Mapping Communication 616

EIO0000001309 06/2017 611

Mapping Stage

Creating Supervision Project Executables

Overview
The Executables folder gives you access to the service and communication mapping functions 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 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 an Executable
To create the executable, proceed as follows.

Step Action
1 In the Project Explorer, right-click the Executables folder of the Supervision project you want to
map and select Create Executable.
Result: Process Expert creates an executable and displays it in the Executables tab inside the
Executables folder.

Executable Description
The following fields are displayed in the Executables tab.

Header Description
Identifier Unique identifier of the executable.
Refer to Executable Properties (see page 614) for a description of the field.
Build State Indicates the status (see page 640) of the executable.
Default value: Not Built
Built On Date and time when you last built the executable successfully by using the Build command.
Execution Indicates the execution domain (see page 614) to which the executable is assigned
Domain
Description Description of the executable.
Refer to Executable Properties (see page 614) for a description of the field.

612 EIO0000001309 06/2017

 Mapping Stage

Executable Actions
Right-click the executable to display a context menu with the following commands.

When you select... Process Expert...

Map Service opens the Service Mapping tab inside the Executables folder, which allows you to map
(see page 615) the Supervision servers and clients to one or more station nodes of the system
topology.
Map Communication opens the Communication Mapping tab inside the Executables folder, which allows
(see page 616) you to map 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 638) 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 638) the built Supervision Participant
project the first time or to recreate it to integrate certain changes (see page 642) 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 404) 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 94). Click the icon to cancel the task.
Deploy Built Project allows you to deploy the Supervision project to station nodes of the system that can
(see page 699) act as engines for Supervision projects.
Download Projects opens the Download Projects tab, which allows you to select Supervision project files
(see page 641) individually to save them on the PC, such as:
 The master project (.ctz) with the name
ProjectIdentifier_ExecutableIdentifier, which was created by the last
successful build process.
 The default include project SGC_Include2 and other include projects (.ctz) that you
have added.
 The OPC Factory Server configuration files (.xml).

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.

EIO0000001309 06/2017 613

Mapping Stage

When you select... Process Expert...

Rename allows you to enter a new identifier for the executable.
Properties displays the Properties tab in which you can view and edit properties of the executable.

Executable Properties
To access the Properties tab, right-click the executable and select Properties.
You can view and/or edit the following items.

Property Description
Identifier The identifier must be unique within a Supervision project.
Click the field to edit it and press Enter to confirm.
Default value: Executable_n where n is an incremental number starting at 1.
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 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.

Assigning an Execution Domain

To assign an execution domain to an executable, proceed as follows.

Step Action
1 In the Project Explorer, open the Executables folder of the Supervision project.
2 Double-click the executable to which you want to assign an execution domain.
Result: The software opens the Properties tab of the executable.
3 Select a value from the menu or enter a new value.
4 Press Enter to confirm your selection or entry.

NOTE: To remove or change the associated execution domain, select the empty row at the top of
the menu and press Enter to confirm the selection.

614 EIO0000001309 06/2017

 Mapping Stage

Mapping Services

Overview
The Service Mapping tab allows you to map the servers and/or runtime clients that are defined in
the Supervision Participant project to one or more station nodes of the topology of the system.
The station nodes represent the operation server and operator station PCs to which you deploy the
Supervision project.
Before mapping services, create the necessary station node entities and:
 A VJC service (see page 514) in the station nodes that you want to map to I/O alarm, trend, and
report server, and client components.
 An OFS service (see page 514) in the station node that you want to map to the I/O server
component.
NOTE: If you do not map all the services of the Supervision Participant project to station nodes,
you cannot complete the build stage (see page 638).

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 705) 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 VJCitect service. It is
unmapped if you delete its OFS service (see page 514) and the station node was mapped to the
I/O server component of the Supervision project.

Mapping Services
To map a Supervision server or client to a station node, proceed as follows.

Step Action
1 Right-click the Executable in the Project Explorer and select Map Service.
Result: Process Expert opens the Service Mapping tab.
2 Click the field in the Engine column next to the server or client (Service) that you want to map.
Result: The menu displays the identifiers of compatible station nodes (see page 615).
3 Select a station node.
Result: The software maps the service to the selected station node.
4 Click the close button of the Service Mapping tab.

NOTE: To remove a mapping, in the Service Mapping tab, right-click a service and select Unmap.

EIO0000001309 06/2017 615

Mapping Stage

Mapping Communication

Overview
The Communication Mapping tab allows you to map the I/O devices of the Supervision project to:
 A controller of the system and its communication module.
 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.

This defines from which topological entity I/O devices acquire data during runtime by using the
OFSOPC driver (see page 331).
The following need to be connected to the same Ethernet network (see page 543):
 The communication module of the controller entity.
 The Modbus TCP device (if present).
 The station node, which is mapped to the I/O server in the service mapping.

For each I/O server that you map, the software creates one OPC Factory Server (OFS)
configuration file (see page 638), which contains as many device aliases as there are I/O devices.
This file is attached to the communication mapping information of the associated executable of the
Supervision project and the station node.

Mapping to a Modbus Device

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 845).

616 EIO0000001309 06/2017

 Mapping Stage

Communication Mapping Tab

The figure shows an example of the Communication Mapping tab in which one controller, two
Modbus TCP devices (ETesysTHW_1 and STBIsland_1), and two Modbus serial devices
(represented by the gateway entity EGenericDeviceHW_1) are mapped to their respective I/O
device.

Header Description
IO Device I/O devices that you have created in the cluster and which is associated to a tag
container.
Topological Entity Topological entities that have at least one communication module (data server)
connected to 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.
Data Server 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.
For Modbus I/O device entities, it is the Modbus TCP server service of the
topological entity.

EIO0000001309 06/2017 617

Mapping Stage

Header Description
Modbus Unit ID  For Modbus TCP devices, it is the ID parameter of the topological entity. The
value 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.

Mapping to a Station Node

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 tab only if it is connected
to an Ethernet network and if you have created a UnityPro service (see page 514) in the station
node.
NOTE: Map (see page 618) the Control executable of the corresponding Unity Pro Participant
project to the same station node.

Mapping Communication
To map the I/O device to the controller and its communication module, proceed as follows:

Step Action
1 Right-click the executable in the Project Explorer and select Map
Communication.
Result: Process Expert opens the Communication Mapping tab.
2 Click the field in the Controller column next to the I/O device you want to map.
Result: The menu displays the identifiers of the compatible controllers of the
system.
3 Select a controller.
4 Click the field in the Communication Module column next to the I/O device you
want to map.
Result: The menu displays the identifiers of the available communication
modules of the selected controller.

618 EIO0000001309 06/2017

 Mapping Stage

Step Action
5 Select a communication module.
Result: The software maps the I/O device to the selected communication
module of the controller.
6 Click the close button of the Communication Mapping tab.

NOTE: To undo a mapping, in the Communication Mapping tab, right-click a service and select
Remove mapping.

EIO0000001309 06/2017 619

Mapping Stage

620 EIO0000001309 06/2017

 Process Expert
Build Stage
EIO0000001114 05/2017

Chapter 20
Build Stage

Build Stage

Overview
This chapter provides information to help you 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 74) 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 Build Stage 622
20.2 Supervision Participant Project Build Stage 637

EIO0000001309 06/2017 621

Build Stage

Section 20.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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Building the Logical Control Participant Project 623
Changing the Built Control Participant Project 630
Managing Hardware Abstraction Layer (HAL) Variables and DFBs 633

622 EIO0000001309 06/2017

 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 943).
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 510).
 Defines the value of REF_TO data types (see 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 Process Expert,
Installation and Configuration Guide) templates, 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 630).
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.

EIO0000001309 06/2017 623

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 532) 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 498). The identifier is
truncated to not exceed 10 characters.
 <Counter> is an incremental 1 or 2-digit number generated by Process Expert 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 a corresponding DDDT variable of the same name as the DTM.

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 507) of the topological entity acting as server
(see page 580). The identifier is truncated to not exceed 10 characters.
 <Counter> is an incremental 1 or 2-digit number generated by Process Expert so that truncated
server entity names are unique.

624 EIO0000001309 06/2017

 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 a corresponding DDDT variable of the same name as the DTM.

Proactive Build Diagnostic

If the build diagnostic icon (see page 150) is displayed in the Control Participant project folder of
the Project Explorer, you may not be able to build the project successfully. Some exceptions apply
(see page 406).
In such case, Refine the Control Participant project (see page 467) to fix the issue, which results
in a negative build [Link] Control Participant features tools that help you identify such
issues.
When you save the Control Participant project during refinement, the project is analyzed and the
status of the Control project is indicated by the build diagnostic 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 402).

Control Participant Project Settings

When you build a logical Control Participant project by using the Build All command,
Process Expert may override some project settings (see 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 629).
NOTE: This applies also when you are using the Generate and Build command to build a
Participant project executable for the first time.

EIO0000001309 06/2017 625

Build Stage

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 Process Expert, Control Participant Services, User Guide).

Allocation of Peer to Peer Communication Variables

The build process allocates addresses or values to the network variables that you have mapped
(see page 594) 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.

626 EIO0000001309 06/2017

 Build Stage

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 window to remove (see page 604) 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 476)
(client based on the M580 platform) for the Value attribute of two 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 peer to peer communication
variables.

Aborting Build Tasks

After selecting a build command or confirming it, the abort icon is displayed in the notification panel
(see page 94). 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.

EIO0000001309 06/2017 627

Build Stage

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 In the Project Explorer, expand the logical The software displays the Control executables of
Control Participant project that you want to the logical Participant project (see page 573).
build and open the Executables folder.
2 Right-click the executable and select Build, If no build diagnostic icon (see page 625) is
Build All, or Generate and Build depending on displayed in the project folder, the software
the situation (see page 631). executes the following actions; otherwise it
displays a confirmation dialog box. In such case,
proceed to step 3.
 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.
3 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.
4 Refine the Control Participant project -
(see page 469) to fix the issue, which results in
a negative build diagnostic.
5 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.

Build Status
The table describes the build states of an executable.

Build state Description

Not Built No built Participant project exists.
Default state 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 631).

628 EIO0000001309 06/2017

 Build Stage

NOTE: You may need to build the Control Participant project again if you have made certain
changes (see page 630) 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 467) 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 software opens the Control Participant in a reduced window.
2 Maximize the Control Participant window.
For more information, refer to Viewing the Built Control Participant project (see Process Expert,
Control Participant Services, User Guide).
3 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 944).

EIO0000001309 06/2017 629

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 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 594)(1).

630 EIO0000001309 06/2017

 Build Stage

Change Resulting
build state
Removing the service mapping. Not Built
Deleting a controller or station node that is selected in the service mapping, or deleting the
UnityPro service of such a station node.

(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 631).

Using the Right 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)
 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).
Changes that set the build status to Not Built (see page 630). Build or Build Either command performs
All a complete build.

(1) To integrate changes to attributes of variables used in hardware mapping (see page 633), use
the Build All command.
(2) Such change disables the Build command.

EIO0000001309 06/2017 631

Build Stage

(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 404).
NOTE: When you modify an existing peer to peer communication channel, rebuild the owner and
the consumer (see page 476) 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.

632 EIO0000001309 06/2017

 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, the $DigitalInput process template).
 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 more information on the composition of these templates, refer to the respective Templates
User Guides (see page 856).

Marking HAL Variables and DFBs

When you build the logical Control Participant project, Process Expert 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 Process Expert, Control Participant Services, User Guide).
 Update the logical Control Participant project (see page 766) 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.

EIO0000001309 06/2017 633

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 Process Expert has
marked the DigitalInput_1_DINPUT_DISV variable that is used in the hardware mapping.

634 EIO0000001309 06/2017

 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 Process Expert 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 Process Expert has
created the corresponding IODDT TSignCptBmx_1_CHANNEL and marked it.

EIO0000001309 06/2017 635

Build Stage

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.

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 Process Expert 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
Process Expert marks as HAL, using the Refine command, refer to Using the Right Command to
Integrate Changes (see page 631).

636 EIO0000001309 06/2017

 Build Stage

Section 20.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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Building the Supervision Participant Project 638
Changing the Built Supervision Participant Project 642

EIO0000001309 06/2017 637

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 942).
This is the file that you can deploy or download to the PC.

OPC Factory Server Configuration Files

During the build process, the software generates the necessary OPC Factory Server configuration
files and stores them in the contents repository because, by default, the communication board
(see page 333) driver is set to OFSOPC.
One OPC Factory Server configuration file is created for each station node that is mapped to an
I/O server component of the Supervision project.
The name of each configuration file is <Topological entity ID>_DeviceConfig.xml
where <Topological entity ID> is the identifier of the station node to which the I/O server is
mapped in the service mapping (see page 615).
If several I/O devices exist for an I/O server, the configuration file contains a device alias for each
one.
NOTE: If you rename the station node, the name of the OPC Factory Server configuration file is
updated without the need to build the Supervision Participant project.

Network Addresses of Supervision Project Components

When you build a Supervision Participant project, and you have not done the service mapping
(see page 615) 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.

638 EIO0000001309 06/2017

 Build Stage

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 402).

Aborting Build Tasks

After selecting a build command, the abort icon is displayed in the notification panel (see page 94).
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.

Using the Build Commands

To create the Supervision Participant project, modify it, or to create it again, proceed as follows.

Step Action Result

1 In the Project Explorer, expand the logical The software displays the executables of the
Supervision Participant project that you want to logical Participant project (see page 612).
build and open the Executables folder.
2 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 642). 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.

EIO0000001309 06/2017 639

Build Stage

Build Status
The table describes the build states of an executable.

Build state Description

Not Built No built Participant project exists.
Default state 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 640) to the system even though the software displays the Build State as up to
date.

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 the Supervision project. Out Of Date
Generating the project again after 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 that is selected in
the service or communication mapping.
 Deleting the UnityPro, OFS, or NIC instance of a station node that is
selected in the communication mapping.
 Deleting the VJC instance of a station node that is selected in the service
mapping.
 Deleting a controller that is selected in the communication mapping.

Removing all service mappings of the Supervision executable. Not Built

Deleting a station node that is selected in the service mapping.

640 EIO0000001309 06/2017

 Build Stage

Downloading Supervision Project Files

After the build process completes successfully, the following files are available for download in the
Download Projects tab:
 The master project (.ctz) with the name ProjectIdentifier_ExecutableIdentifier
(for example, Supervision_1_Executable_1).
The project also contains any user files (see page 492) that are attached to the Supervision
Participant project.
 The default include project SGC_Include2 that is added when you assign the first genie to a
page (see page 492).
 Any other include project (see page 492) (.ctz) hat is attached to the Supervision Participant
project.
 The OPC Factory Server configuration files (.xml) if you have configured the communication
board (see page 333) driver as OFSOPC.
NOTE: You can download include 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 software opens the Download Projects tab that displays the project files associated
to the built Supervision Participant project.
2 Select one file and click Download.
Result: The software opens a Save As dialog box.
3 Browse to the location where you want to save the file and click Save.
Result: The software:
 Saves the file in the selected location.
 Closes the Save As dialog box.

EIO0000001309 06/2017 641

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.

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

Editing a Supervision page (Edit command). Build (1) Performs an
incremental
compilation.
Modifying a parameter of the Message category (see page 213) 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 in the $Motor template).
Other changes to, for example: Build All(2) Performs a
 A tag container. complete
 The trend, alarm, and/or report server. compilation.
 Service and communication mappings.
 Advanced project settings.
 Generating or refining the Supervision Participant project.

(1) You can also use the Generate and Build command (see page 404).
(2) When you make this type of change, the Build command is not available.

642 EIO0000001309 06/2017

 Process Expert
Deployment Stage
EIO0000001114 05/2017

Chapter 21
Deployment Stage

Deployment Stage

Overview
This chapter provides information to help you 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 76) 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 Deployment Stage 644
21.2 Supervision Project Deployment Stage 699

EIO0000001309 06/2017 643

Deployment Stage

Section 21.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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Control Participant Project Deployment Process 645
Deploying to an Emulated Simulator 649
Communication Between the Computer and Engines 653
Managing Passwords of Control Participant Projects 655
Deploying to Redundant Controllers 662
Deploying the Control Participant Project 665
Re-Deploying the Control Participant Project 672
Deploying Data to Controllers and Station Nodes 679
Deploying Control Project Changes 686
Changes Requiring to Stop the Controller 697

644 EIO0000001309 06/2017

 Deployment Stage

Control Participant Project Deployment Process

Overview
Process Expert allows you to deploy a built Control Participant project (see page 623) to engines
by using the following commands:
 Deploy Built Project
 Re-Deploy Last Project
 Deploy Changes / Undo Online Changes

NOTE: Deployment of data to the controller is not supported by Process Expert, only deployment
of the binary executable.

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:

EIO0000001309 06/2017 645

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 692)
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

Process Expert 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 PC running software that emulates a simulator (see page 514) (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.

Identifying Engines
Process Expert 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.

646 EIO0000001309 06/2017

 Deployment Stage

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 PC to the Ethernet network to which this communication module is
connected and through which you want to deploy or execute.
3 On the PC, execute the [Link] program.
Result: Windows displays a command prompt.
4 Type arp -a and press Enter.
Result: Windows displays the local ARP cache table.
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.

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 86).

EIO0000001309 06/2017 647

Deployment Stage

Start/Stop Commands
Process Expert 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.

648 EIO0000001309 06/2017

 Deployment Stage

Deploying to an Emulated Simulator

Overview
You can deploy built Control Participant projects to computers for simulation purposes. In the
topology of Process Expert, this computer (engine) is represented by a station node
(see page 514) on which a Unity Pro service is installed.
By default, the simulator is configured to start with a password-protected Control project
(see Process Expert, Installation and Configuration Guide) provided with Process Expert. You can
start the simulator with a different password-protected project file or change the password
(see page 658) of the project that is loaded by default.
NOTE: If your Windows® session is not the one that was used to install Process Expert, you need
to configure the simulator manually (see page 651) 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 Process Expert component is Start the simulator.
installed.
(Recommended method)
Other computer on which no Process Expert component 1. Install the simulator.
is installed. 2. Start the simulator.
Refer to the topic describing how to install the
Controller Simulator. (see Process Expert,
Installation and Configuration Guide)

Starting the Emulated Simulator Software

To start the simulator provided with Process Expert, proceed as follows.

Step Action
1 Browse to the [Link] file located in the PLC_Simulator folder.
When you install Process Expert, the folder is copied to the path C:\Program Files
(x86)\Schneider Electric on the local computer.
2 Double-click [Link].
Result: The emulated simulator software starts minimized as an icon in the notification area. By
default the password-protected Control project (see Process Expert, Installation and
Configuration Guide) is loaded.

EIO0000001309 06/2017 649

Deployment Stage

NOTE: For information on using the simulator, refer to the simulator help, which is located in the
PLC_Simulator folder. You can access the help of the simulator also directly from the simulator
panel after starting it.

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 656).
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 Unity Pro Control project file (.sta).
5 Click OK.
Result: The simulator stops.
6 Start the simulator.
Result: The simulator starts by loading the selected Unity Pro 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).

650 EIO0000001309 06/2017

 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 656).
To start the simulator by loading the default Control project provided with Process Expert or
another one when you are logged on to a Windows® that is different from the one used to install
Process Expert, 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:
 [Link] that is provided with Process Expert and that you have copied to the
computer. The file is located in the AFS folder in the root of the installation package of
Process Expert.
 Your own Unity Pro 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 [Link] as IP address for the NIC of the station (see page 518) 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 Process Expert.
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.

EIO0000001309 06/2017 651

Deployment Stage

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 644).

652 EIO0000001309 06/2017

 Deployment Stage

Communication Between the Computer and Engines

Controllers
To deploy a built Control Participant project, verify 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 Process Expert components (see Process Expert,
Installation and Configuration Guide), the PC 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 online help (see page 112).

Station Nodes
To deploy a built Control Participant project, verify that the computer that is running the
Process Expert 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.

EIO0000001309 06/2017 653

Deployment Stage

The following figure shows an example of deployment confirmation dialog box featuring the
reconnect button.

1 Reconnect button

654 EIO0000001309 06/2017

 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 a Process Expert 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 Process Expert.
 Clearing a password.
 Resetting the password if you forgot it.

Setting a password is mandatory if you have enabled password protection (see page 177) 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 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 (Protection tab of the properties
of the project).
NOTE: Other passwords that are managed by the Control Participant are not supported.
Also, you cannot set passwords directly in the Control Participant (for example, by configuring the
controller or refining the Control Participant project offline or online and opening the project
properties).
The table describes which Control projects managed by Process Expert benefit of the password
protection.

Control Participant project Password protection applies

Logical Control project No
Built Control project No
Deployed Control project Yes

EIO0000001309 06/2017 655

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 (.sta)
node/simulator that is loaded when the simulator starts.
only By default, this is the Control project file that is provided
with Process Expert. For details, click here
(see Process Expert, Installation and Configuration
Guide).
NOTE: The simulator may have been configured
(see page 650) to load another Control project file when
starting or the password may have been changed
(see page 658).
First deployment You need to set a password first.
Subsequent deployment and No password required as long as you keep the engineering
execution operations 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 Process Expert), 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 The current password.
execution operation after
setting or changing the
password
Subsequent deployment and No password required as long as you keep the engineering
execution operations 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 The current password.
using Runtime Navigation If you close the operation client or lock it and another user
Services (operation client) logs in, the current password is required again.
Resetting the password if you The temporary password provided by Schneider Electric
have forgotten it. support.

656 EIO0000001309 06/2017

 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 Back Up Data The password that is currently set.
command for the first time
after deploying a Control
project.
Any deployment and The password that is currently set.
execution operations after If no password is set yet, you need to set one (or, for a
importing the controller or station node, provide the password that is used in the
station node Control project file (.sta) that is loaded when the simulator
starts).
Any deployment and
execution 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
Setting the Security The password that is currently set.
Password property to
NOTE: Changing the Security Password property to
Disabled when a Control
Disabled opens the Disable Password Protection dialog
Participant project was
box. This also clears the password.
deployed while the setting
was Enabled.

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.

EIO0000001309 06/2017 657

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 662) 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 Unity Pro service.

 The Enable Password Protection property of the topological entity is set to true.
 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 apply the password that you set also to the Control project that is loaded when you
start the simulator whether it loads the default project or your own.

658 EIO0000001309 06/2017

 Deployment Stage

The following figure shows the Manage Password dialog box for the simulator running on a station
node, which features the check box that lets you also change the password in the Control project
that is loaded when you start the simulator.

1 To be able to change the password of the Control project file:

 The folder containing the file must not be write-protected.
 The simulator must be running on either the system server computer or the engineering client
computer on which you are executing the Manage Password command.
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 656).
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.

EIO0000001309 06/2017 659

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.
NOTE: This functionality lets you also change the password of the Control project that is loaded
when the simulator starts.
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. 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.

660 EIO0000001309 06/2017

 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 16) 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 660) and enter the temporary
password in the Current Password text box.

EIO0000001309 06/2017 661

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 758).

ControllerExist Property
Verify that the value of the ControllerExist property (see page 507) that is selected in the properties
of the redundant controller entity matches the physical configuration of the equipment.
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 712).

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, Process Expert displays 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.

662 EIO0000001309 06/2017

 Deployment Stage

General Deployment Behavior for Redundant Controllers

When you deploy to a redundant controller:
 Process Expert 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 758)) 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 688).

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

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 686):
 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 761) 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.

EIO0000001309 06/2017 663

Deployment Stage

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 720) the primary engine
synchronizes the standby engine.

664 EIO0000001309 06/2017

 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 577).
 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 941).
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, Process Expert 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 State

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 630), 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 628) 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 272) 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 573) that is mapped to the
engine (see page 577).
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 662).

EIO0000001309 06/2017 665

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.

666 EIO0000001309 06/2017

 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.
(1) Displayed only when you deploy a built Participant project to a redundant controller.

EIO0000001309 06/2017 667

Deployment Stage

Label Description
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 688).
(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 653).
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 deployed
belong to. 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 deployed
project to be 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.
(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.

668 EIO0000001309 06/2017

 Deployment Stage

Name column Selected Project column Last Deployed Project column(2)

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 standby controller with the primary one by using
On(1) the Synchronize (Primary→Standby) command.
Start engine Select the option if you want to start the controller or emulated simulator when deployment is
after complete; otherwise the engine remains in stop state.
deployment
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.

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 646).

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.

EIO0000001309 06/2017 669

Deployment Stage

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 deploying to a redundant controller, deployment to the standby controller (see page 761)
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 712).
To deploy the Control Participant project, proceed as follows.

Step Action
1 Verify that the engine can communicate with the PC (see page 653) and that it is in Stopped
state.
When deploying to a station node, verify that the software emulating the simulator is running
(see page 649).
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.

670 EIO0000001309 06/2017

 Deployment Stage

Step Action
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.
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.

EIO0000001309 06/2017 671

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 672) with the exception that you cannot select a Control project and an associated
Control executable for deployment. Process Expert 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, Process Expert 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 662).

672 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 673

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.
(1) Displayed only when you redeploy a built Participant project to a redundant controller.

674 EIO0000001309 06/2017

 Deployment Stage

Label Description
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 redeploy to the CPU module or a NOC
communication module by using IP address A.
You can only select main IP address (see page 688).
(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 653).
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.
(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.

EIO0000001309 06/2017 675

Deployment Stage

Name column Selected Project column Last Deployed Project column(2)

Last Sync. Date and time when you last synchronized the standby controller with the primary one by using the
Performed Synchronize (Primary→Standby) command.
On(3)
Start engine Select the option if you want to start the engine when deployment is complete; otherwise the engine
after remains in stop state.
deployment
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.

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 646).

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.

676 EIO0000001309 06/2017

 Deployment Stage

When redeploying to a redundant controller, re-deployment to the standby controller

(see page 761) 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 712).
To redeploy the last deployed reference, proceed as follows.

Step Action
1 Verify that the engine can communicate with the PC (see page 653) and that it is in Stopped
state.
When redeploying to a station node, verify that the software emulating the simulator is running
(see page 649).
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.

EIO0000001309 06/2017 677

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.

678 EIO0000001309 06/2017

 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 748) 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 112).

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 507) 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 143) the information that is displayed.

EIO0000001309 06/2017 679

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.

680 EIO0000001309 06/2017

 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 688).
(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 653).
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.

EIO0000001309 06/2017 681

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:
 True
Unlocated FBs
 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 645), which is the Control
Participant project residing in Process Expert.
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 16).

682 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 683

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.
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 653).
When deploying to a station node, verify that the software emulating the simulator is running
(see page 649).
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.

684 EIO0000001309 06/2017

 Deployment Stage

Step Action
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 683), 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.

EIO0000001309 06/2017 685

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 692).
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 697). 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 630) 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 645), which is the Control
Participant project residing in Process Expert.
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 Process Expert support.

686 EIO0000001309 06/2017

 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.
Process Expert 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 662).

EIO0000001309 06/2017 687

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.

688 EIO0000001309 06/2017

 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.
(1) Displayed only when you select the command for a redundant controller.

EIO0000001309 06/2017 689

Deployment Stage

Label Description
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 changes to the CPU module or a NOC
communication module by using IP address A.
You can only select main IP address (see page 688).
(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 653).
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 deployed
belong to. 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 have Identifier of the Control executable that contains
selected and that contains the built Participant the built Participant project that you have deployed
project to be 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.
(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.

690 EIO0000001309 06/2017

 Deployment Stage

Name column Selected Project column Last Deployed Project column2

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 Synchronize (Primary→Standby) command.
On(1)
(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.

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
project contains, including modified and/or new ones. Animation tables and/or operator screens
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 796)
 Signals (see page 609)

EIO0000001309 06/2017 691

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 692).

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 (see Unity Pro, Operating Modes) Refine Online (see page 741) or Deploy
Built Project (see page 665)
SR sections
Properties of MAST and FAST tasks
Timer and I/O event tasks
Device DDT and IODDT variables Refine Online (see page 741)
Changes to the topology (see page 498), which you make in the Deploy Built Project (see page 665)
Topology Explorer.
Changes to the communication mapping (see page 579).

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 766) later on.

692 EIO0000001309 06/2017

 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.

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 697).
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.

EIO0000001309 06/2017 693

Deployment Stage

Header Description
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.

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 646).

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.

694 EIO0000001309 06/2017

 Deployment Stage

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 761) 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 663).
NOTE: For information on the Sync (Primary→Standby) command, refer to the Execution stage
(see page 712).
To deploy changes, proceed as follows.

Step Action Result

1 Verify that the engine can communicate with –
the PC (see page 653).
To deploy changes to a station node, verify
that the simulator emulation software is
running (see page 649).
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. –

EIO0000001309 06/2017 695

Deployment Stage

Step Action Result

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. –
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.

696 EIO0000001309 06/2017

 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 741) 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 Unity Pro project settings. N/A Refer to Project Settings (see Unity Pro,
Operating Modes) for a list of settings that
you can change and to Synthesis of
Authorized and Unauthorized
Modifications (see Unity Pro, Operating
Modes) in the Control Participant online
help.
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 (see Unity
action). Pro, Operating Modes) in the Control
Participant online help.
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 (see Unity
Modifying the structure of a used DDT. Yes
Pro, Operating Modes) in the Control
Participant online help.

EIO0000001309 06/2017 697

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 (see Unity
used DFB. Pro, Operating Modes) in the Control
Participant online help.
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.

698 EIO0000001309 06/2017

 Deployment Stage

Section 21.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.
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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Preparing for Deployment 700
Deploying the Built Supervision Participant Project from the Executable 701
Deploying the Built Supervision Participant Project from the Station Node 704

EIO0000001309 06/2017 699

Deployment Stage

Preparing for Deployment

Overview
Process Expert allows you to deploy a built Supervision Participant project to the station nodes
(see page 514) that you have defined in the topology of the system and mapped (see page 615)
to the executable that is associated to the Supervision project.
You can deploy from:
 The executable of the Supervision project (Project Explorer): Deploys the complete set of files
to the stations nodes that are mapped to the executable in the service mapping.
 A station node that is mapped to the executable in the service mapping (Topology Explorer):
 First deployment of the executable: Deploys the complete set of files to this station node.
 Subsequent deployments: You can select the files to deploy to this station node.

The software detects roles of station nodes depending on the services that are configured in the
Topology Explorer and considers a station node to be:
 An I/O server when configured with Vijeo Citect and OPC Factory Server services.
 An alarm, trend, or report server, or a Supervision client when configured with the Vijeo Citect
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 Process Expert, Installation and Configuration Guide).

Target PC Setup
You need to 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 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.

700 EIO0000001309 06/2017

 Deployment Stage

Deploying the Built Supervision Participant Project from the Executable

Overview
By using the Deploy Built Project command, you can transfer the required 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, which represent these
computers.
If the station node is configured with several NICs, deployment is performed by using the first one
that is reachable from the system server.
After a first deployment, you need to restore the deployed Supervision Participant project on each
target computer.
The procedure for subsequent deployments from the same executable is described in the topic
describing how to redeploy the built Supervision Participant project (see page 703).
NOTE: Verify that the setup of the target computers matches the setup of the station nodes
(see page 499) in the topology of the system (for example, verify that the computer that has the
same IP address as the station node containing the OFS service runs the I/O server).

Deployed Files
The following files are deployed:
 The Supervision master project (.ctz file, for example, Supervision_1_Executable_1.ctz), which
includes the Supervision computer setup ([Link] file).
 Attached user files (see page 495). These are located inside the master project (.ctz) on the
target computer.
 OPC Factory Server (OFS) configuration files (.xml) (see page 638): Deployed only to station
nodes mapped to the I/O server component of the Supervision project. If there are several
configuration files, each file is deployed to its respective station node only.
 The SGC_Include2 include project and the ones that you may have added to the Supervision
project (see page 494).
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.

Built Participant Project Build State

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 640)
is up to date and that it contains the latest changes you have made (see page 640) to the system.

EIO0000001309 06/2017 701

Deployment Stage

Aborting Deployment Tasks

After confirming the command by clicking OK in the Deploy Built Project dialog box, the abort icon
is displayed in the notification panel (see page 94). 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 the 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 700).
2 In the Project Explorer, expand the Supervision project that you want to deploy from and open
the Executables folder.
Result: The software displays the executables that are associated to the Supervision project.
3 Right-click the executable that you want to deploy from and select Deploy Built Project.
Result: The Deploy Built Project dialog box opens prompting you to confirm the deployment of
the include files associated to this Supervision project.
4 Click:
 Yes to deploy the complete set of files pertaining to the Supervision project.
 No to deploy only the master Supervision project file (.ctz), the OFS configuration file (if
required) but no include projects.
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.

Restoring the Supervision Project

After a first deployment, you need to restore the deployed Supervision Participant project on each
target computer.
For information on restoring the deployed Supervision project, refer to topic describing how to
restore Supervision projects (see Process Expert, Supervision Participant Services, User Guide).

702 EIO0000001309 06/2017

 Deployment Stage

Redeploying the Built Supervision Participant Project

To perform a subsequent deployment of a Supervision project from the same executable after you
have changed and built it, follow the procedure to deploy the project files (see page 702).
The software replaces the existing files in the SoCoDeploy and SoCoOfsDeploy shared folders
(see 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. Refer to the topic describing how to
execute the deployed Supervision project (see Process Expert, Supervision Participant Services,
User Guide).
NOTE: If you had already deployed attached user files (see page 495) and you redeploy the same
Supervision project after removing one or more of user files, these files remain in the SoCoDeploy
shared folders where they had been deployed initially. You need to remove them manually from
the shared folders.

EIO0000001309 06/2017 703

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 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 615)) to the
executable of the Supervision project that you are deploying.
A first deployment of an executable deploys the complete set of files. During subsequent
deployments of this executable, you can select the files to deploy.
If the station node is configured with several NICs, you can select the one to use for deployment
among those that are reachable from the system server.
After a first deployment, you need to restore the deployed Supervision Participant project on the
target computer.
The procedure for subsequent deployments of the same Supervision project is described in the
topic describing how to redeploy the built Supervision Participant project (see page 703).
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.

Deployed Files
During the first deployment of an executable, the following files are deployed:
 The Supervision master project (.ctz file, for example, Supervision_1_Executable_1.ctz), which
includes the Supervision computer setup ([Link] file).
 Attached user files (see page 495). These are located inside the master project (.ctz) on the
target computer.
 The OPC Factory Server (OFS) configuration files (.xml) (see page 638) that is related to the
station node: Deployed only to station nodes mapped to the I/O server component of the
Supervision project.
 The SGC_Include2 include project and the ones that you may have added to the Supervision
project (see page 494).
During subsequent deployments of the executable, by default, only the master Supervision project
file is deployed to the station node. During the deployment process, you can select additional files
to be deployed by using the Deployment File Selection dialog box (see page 708).
NOTE: Having deployed the executable from the Supervision project (see page 701) is taken into
account when determining whether the executable is deployed for the first time.

704 EIO0000001309 06/2017

 Deployment Stage

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 615)
 Executable: For each project, any built or out of date Supervision executable that is mapped to
the station node (service mapping).

Built Participant Project Build State

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 640)
is up to date and/or that it contains the latest changes that you have made (see page 640) 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 deployed last to the engine.

EIO0000001309 06/2017 705

Deployment Stage

The following figure shows an example of the Confirm Deploy Built Project dialog box.

The table describes the information that is displayed in the Engine Information section of the
Confirm Deploy Built Project dialog box.

Label Description
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.
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.

NOTE: If the status of the station node changes while the Confirm Deploy Built Project dialog box
is displayed, the status information is not updated. It is updated when you close the dialog box and
select the deploy command again.

706 EIO0000001309 06/2017

 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

Executable Identifier of the Supervision executable that you Identifier of the Supervision executable that
have selected and that contains the built contains the built Participant project that you have
Participant project to be deployed. 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 node Identifier of the system that both the engine and
and the Supervision project, which you have the Supervision project, from which you 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 deployed. Supervision Participant project that you have
deployed last.
Last Deployed Not applicable Date and time when you last deployed the
On Participant project from the station node or from
the executable associated to the Supervision
project.
Select Includes Check box.
and OFS Opens the Deployment File Selection dialog box, which allows you to select the OPC Factory Server
Configuration configuration file and include projects to be deployed in addition to the Supervision master project file
Files (.ctz).
The check box is only shown if you have already deployed the executable to the station node. It
appears:
 Cleared by default and if no files have been selected for deployment.
 Selected if all files have been selected for deployment.
 Filled with a black square if files have been partially selected for deployment.

NOTE: When you deploy for the first time to a station node, the fields of the Last Deployed Project
section are empty.

EIO0000001309 06/2017 707

Deployment Stage

Selecting Files to Deploy

The following figure shows an example of the Deployment File Selection dialog box, which opens
when you select the check box 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 OPC Factory Server configuration file that is related to the station node.
3 Include projects that are associated to the master project.

NOTE: To open the dialog box again after closing it, click the check box.

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 94). 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.

708 EIO0000001309 06/2017

 Deployment Stage

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 700).
3 Right-click the station node and click Deploy Build Project → Supervision.
Result: The software opens the Deploy Built Project dialog box.
4 Click the menu next to Project and select the Supervision project.
5 Click the menu next to Executable and select the executable associated to the built Supervision
project that you want to deploy.
6 Click OK.
Result: The software opens the Confirm Deploy Built Project dialog box.
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 If you want to select other files to deploy in addition to the master Supervision project, select the
Select Includes and Device Configuration Files check box (when available); otherwise, proceed
to step12.
Result: The software opens the Deployment File Selection dialog box.
11 Select the files you want to deploy to the station node and click OK.
Result: The software closes the Deployment File Selection dialog box.
NOTE: Click Cancel to close the dialog box without selecting additional files to be deployed.
12 Click OK in the Confirm Deploy Built Project dialog box.
Result: The software opens the Reconfirm Deploy Built Project dialog box.
NOTE: Click Cancel to close the Confirm Deploy Built Project dialog box without deploying.
13 Click OK.
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 close the Reconfirm Deploy Built Project dialog box without deploying.
This reverts to the Confirm Deploy Built Project dialog box.

EIO0000001309 06/2017 709

Deployment Stage

Restoring the Supervision Project

After a first deployment, you need to restore the deployed Supervision Participant project on the
target computer.
For information on restoring the deployed Supervision project, refer to topic describing how to
restore Supervision projects (see Process Expert, Supervision Participant Services, User Guide).

Redeploying the Built Supervision Participant Project

To perform a subsequent deployment of the same Supervision project after you have changed and
built it, follow the procedure to deploy the project files (see page 700).
The software replaces the existing files in the SoCoDeploy and SoCoOfsDeploy shared folders
(see 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. Refer to the topic describing how to execute
the deployed Supervision project (see Process Expert, Supervision Participant Services, User
Guide).
NOTE: If you had already deployed attached user files (see page 495) 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.

710 EIO0000001309 06/2017

 Process Expert
Execution Stage
EIO0000001114 05/2017

Chapter 22
Execution Stage

Execution Stage

Overview
This chapter provides information to help you 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 78) for a description of the purpose of this stage.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
22.1 Control Project Execution Stage 712
22.2 Supervision Project Execution Stage 778

EIO0000001309 06/2017 711

Execution Stage

Section 22.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 Process Expert.
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 91). In such case, check the
Notification Panel (see page 94) for details.

What Is in This Section?

This section contains the following topics:
Topic Page
Control Participant Project Execution Process 713
Execution With Redundant Controllers 717
Starting and Stopping Controllers 720
Synchronizing Redundant Controllers 729
About Changes Made Online 734
Making Changes Online 741
Backing Up Controller Data 748
Importing Sections from the Logical Control Participant Project 754
Main Redundant Controller Scenarios 758
Redundant Controller Reservation and Connection Scenarios 761
Updating the Logical Control Participant Project 766

712 EIO0000001309 06/2017

 Execution Stage

Control Participant Project Execution Process

Overview
Process Expert 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.

EIO0000001309 06/2017 713

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 645).

1 Includes the section import functionality.
2 The functionality is a sub-command of the Refine Online command within the Control
Participant.

714 EIO0000001309 06/2017

 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
Standby) following use cases 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 692)
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 714), which is the Control Participant project residing in
Process Expert.
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 Process Expert support.

EIO0000001309 06/2017 715

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 86).

Start/Stop Commands
Process Expert 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.

716 EIO0000001309 06/2017

 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 758).
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 688).

ControllerExist Property
Verify that the ControllerExist parameter is set correctly (see page 662).

Engine Status for Redundant Controllers

Refer to the information that is provided in the topic describing deployment to redundant controllers
(see page 662).

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 761), 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

EIO0000001309 06/2017 717

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 761) 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 720) the primary engine
synchronizes the standby engine.

718 EIO0000001309 06/2017

 Execution Stage

Redundant Controller Synchronization Timeout

After you select the Build and Deploy command (see 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 714).
It avoids project mismatch (see page 715) and allows you to synchronize the standby controller,
using the Sync (Primary→Standby) command in case the synchronization timeout is elapsed
(see page 729).

EIO0000001309 06/2017 719

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.

720 EIO0000001309 06/2017

 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 controller that is running.

EIO0000001309 06/2017 721

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.

722 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 723

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 688).
(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 653).
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.

724 EIO0000001309 06/2017

 Execution Stage

Name column Last Deployed Project column(2)

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 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 646).
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 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.

EIO0000001309 06/2017 725

Execution Stage

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 729).
To start the engine, proceed as follows.

Step Action Result

1 Verify that the engine is connected to the PC –
(see page 653).
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.

726 EIO0000001309 06/2017

 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 646).
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.

To stop the engine, proceed as follows.

Step Action Result

1 Verify that the engine is connected to the PC –
(see page 653).
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.

EIO0000001309 06/2017 727

Execution Stage

Step Action Result

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.

728 EIO0000001309 06/2017

 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 715).
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 761).

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, Process Expert 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.

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.

EIO0000001309 06/2017 729

Execution Stage

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 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 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 688).

NOTE: To refresh the engine status and attempt to connect to it, click the reconnect button
(see page 653).

730 EIO0000001309 06/2017

 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.

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 646).
Unintended situations can occur if the operations that are in progress are not known when acting
on a controller.

EIO0000001309 06/2017 731

Execution Stage

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 761) 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.

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 653) 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 .

732 EIO0000001309 06/2017

 Execution Stage

Step Action
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.

EIO0000001309 06/2017 733

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 741),
deploy changes (see page 686), and update the logical Control project (see page 766), refer to the
corresponding topics in the deployment and execution sections.

734 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 735

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.

736 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 737

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 406) 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 504).
 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 737), which you can unselect during
deployment of changes.

738 EIO0000001309 06/2017

 Execution Stage

 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.
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.

EIO0000001309 06/2017 739

Execution Stage

The figure shows how online refinements that reference DDDT variables coming from the topology
affect the deployment and execution workflow.

740 EIO0000001309 06/2017

 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 754) 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 Process Expert, Control Participant
Services, User Guide).
When you close the Control Participant after deploying changes online, Process Expert lets you
update the associated logical Control Participant project right away with the changes you have
made online. Until you do so, an icon (see page 741) 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 697).

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 645) 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.

Updating the Control Project with Changes Made Online

Once you have successfully deployed changes made online and close the Control Participant,
Process Expert 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 766). From here
on, you follow the same process as when you select the Update Control Project command. The
same restrictions apply.

EIO0000001309 06/2017 741

Execution Stage

If you do not accept, the online refinement icon is displayed in the topological entity folder
(see page 150). 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 766).
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 687) after building the logical Control Participant project.

Viewing the Application Structure When Making Changes Online

When you modify a Control Participant project online, the Application Tree View 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 376).
For information on how to use the pane, refer to the topic describing the refinement of Control
Participant projects online (see 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.

742 EIO0000001309 06/2017

 Execution Stage

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.

The figure shows an example of the Confirm Refine Online dialog box for a redundant controller.

EIO0000001309 06/2017 743

Execution Stage

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 688).
(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 653).
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.
(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.

744 EIO0000001309 06/2017

 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 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 646).
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.

EIO0000001309 06/2017 745

Execution 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 761) 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 766) 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.

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 653) 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.

746 EIO0000001309 06/2017

 Execution Stage

Step Action Result

5 Click OK. The software opens the Control Participant
in a reduced window.
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 Maximize the Control Participant window. –
7 Proceed with changes or import of sections in the –
deployed Control project inside the Control Participant
UI (see Process Expert, Control Participant Services,
User Guide).
8 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.
9 Click Yes. The software opens the Update Control
Project dialog box, which allows you to
NOTE: Click No to close the Refine Online dialog box
view and select changes made online that
without updating the logical Control Participant project
you can transfer to the associated logical
and to display an icon (see page 741) in the associated
Control Participant project.
topological entity folder.
10 Follow the procedure to update logical Control –
Participant projects (see page 766).

NOTE: If you close the Unity Pro 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.

EIO0000001309 06/2017 747

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 679) and manage backup files (see page 308).
 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 282) 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 112).

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 507) 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.

748 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 749

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) Vou 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.

750 EIO0000001309 06/2017

 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 688).
(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 653).
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.

EIO0000001309 06/2017 751

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 645), which is the Control
Participant project residing in Process Expert.
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 16).

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.

752 EIO0000001309 06/2017

 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 653).
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.

EIO0000001309 06/2017 753

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 445) to be imported.
The time stamp of the last generation of a section (see page 281) 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 purpose 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.

754 EIO0000001309 06/2017

 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. Selected by default.
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 756) by the section import functionality. Sections are
listed in ascending Order (Containers pane of the Control Participant project).
4 Value of the Generated On property of the section.
5 Filter 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,
$AISignal_UL) 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 indicator 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.

EIO0000001309 06/2017 755

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 Comment

importing 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 were Yes –
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
identifier of the instance referencing the facet that creates as a new variable. The variable
the variable). The variable and section already exist in the with the original name that existed
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 block). contains the change you had
Then, making a change in the section that can be made through refinement.
imported (for example, assigning a facet).
Making a change in a section that can be imported (for Yes The section in the deployed
example, assigning a facet) while a section with the same Control project is replaced by the
name already exists in the deployed Control project. imported section.
Changing the order of facets inside the section. No –
Deleting a section to which facets are assigned and that No You cannot remove a section
is generated. from the deployed Control project
by using the section import
functionality.
Making a change in the section that can be imported (for No –
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).

756 EIO0000001309 06/2017

 Execution Stage

Change description Allows Comment

importing the
section
Making changes in a section that can be imported and No The changes are already applied
deploying these changes by using the Deploy Changes / to the deployed Control
Undo Online Changes command. Participant 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 section that you want to import
that can be imported (for example, assigning after generating this section.
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 Process Expert,
Control Participant Services, User Guide).

EIO0000001309 06/2017 757

Execution Stage

Main Redundant Controller Scenarios

Overview
This topic outlines the sequence of actions performed by Process Expert 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 761).

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.

758 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 759

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.

760 EIO0000001309 06/2017

 Execution Stage

Redundant Controller Reservation and Connection Scenarios

Overview
This topic describes the actions that Process Expert 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 Process Expert 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 Comment

Externally Connected IP + 1 Process Expert on Engine
Reserved (Controller Connected
State) (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

EIO0000001309 06/2017 761

Execution Stage

For the Deploy Changes/Undo Online Changes Command

The table describes the actions that Process Expert performs on the primary and standby engines
when you select the Deploy Changes/Undo Online Changes command.

Engine Controller IP Controller Action Executed by Comment

Externally Connected IP + 1 Process Expert 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 Process Expert performs on the primary and standby engines
when you select the Start command.

Engine Controller IP Controller Action Executed by Comment

Externally Connected IP + 1 Process Expert on Engine
Reserved (Controller Connected
State) (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 763) for additional scenarios.

762 EIO0000001309 06/2017

 Execution Stage

For the Stop Command Only

The table describes the actions that Process Expert performs on the primary and standby engines
when you select the Stop command.

Engine Controller IP Controller Action Executed by Comment

Externally Connected IP + 1 Process Expert 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 763) for additional scenarios.

For the Start and Stop Commands

The table describes the actions that Process Expert performs on the primary and standby engines
when you select the Start or Stop command.

Engine Controller IP Controller Action Executed by Comment

Externally Connected IP + 1 Process Expert 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.

EIO0000001309 06/2017 763

Execution Stage

For the Refine Online Command

The table describes the actions that Process Expert performs on the primary and standby engines
when you select the Refine Online command.

Engine Externally Controller IP Controller Action Executed by Comment

Reserved Connected IP + 1 Process Expert on Engine
(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 714)
subcommand.

764 EIO0000001309 06/2017

 Execution Stage

For the Sync (Primary→Standby) Command

The table describes the actions that Process Expert performs on the primary and standby engines
when you select the Sync (Primary→Standby) command.

Engine Controller IP Controller Action Executed by Comment

Externally Connected IP + 1 Process Expert 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

EIO0000001309 06/2017 765

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 734) to the corresponding deployed Participant
project. You must have made the changes by using the Refine Online (see page 741) command.
An indication that online changes need to be applied to the logical Control Participant project is
given by an icon (see page 150) 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 Process Expert 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 622) to which you have applied changes using the
Update Control Project command to be able to deploy these changes.

766 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 767

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 653).

768 EIO0000001309 06/2017

 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 741).

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 build diagnostic indicator (see page 406) will appear
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 Process Expert, Control
Participant Services, User Guide) that is mapped to the executable of this Control project.

EIO0000001309 06/2017 769

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 Process Expert 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 633) or No changes to their attributes are updated in the logical Control
P2P (see page 482) as Custom Participant project.
attribute.
Variables without HAL (see page 633) 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 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 734)
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.

770 EIO0000001309 06/2017

 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 633).

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 (see Unity Pro, 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 774) on sections that you have created after deployment.
NOTE: Restrictions may apply when updating variables (see page 770).

EIO0000001309 06/2017 771

Execution Stage

The following figure shows an example of the Update Control Project dialog box that the software
displays.

1 Check box to request that Process Expert performs a consistency check (see page 773) on the
selected items before proceeding with the update of the logical Control Participant project. By
default, the option is not selected.

772 EIO0000001309 06/2017

 Execution Stage

Header Description
Check boxes By default, changes detected by Process Expert 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 633).
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.

Checking Consistency
Select the corresponding check box in the Update Control Project dialog box for the software to
perform a consistency check (see page 472) 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 438) it.

EIO0000001309 06/2017 773

Execution Stage

If the check box of a facet is cleared, the generation status of the facet remains Inconsistent
(see page 438).
During a subsequent generation (see page 447) 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.

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).

774 EIO0000001309 06/2017

 Execution Stage

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

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.
(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 Project Explorer and select Delete.

EIO0000001309 06/2017 775

Execution Stage

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 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 Project Explorer 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.

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 94). 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.

776 EIO0000001309 06/2017

 Execution Stage

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 653).
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 Process Expert to perform a consistency
check; otherwise proceed to step 8.
6 Click OK.
Result: Process Expert 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.
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 indicator (see page 150) 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

EIO0000001309 06/2017 777

Execution Stage

Section 22.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 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 Process Expert, Supervision Participant
Services, User Guide).

778 EIO0000001309 06/2017

 Process Expert
Managing Communication
EIO0000001114 05/2017

Chapter 23
Managing Communication

Managing Communication

Overview
This chapter provides information to manage communication between devices and controllers
depending on the communication protocol that you want to use.

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: Process Expert does not verify the status of the communication between controllers and
I/O devices.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
23.1 Communication Through Modbus TCP Ethernet Implicit Messaging (I/O 781
Scanning)
23.2 Communication by Using Modbus TCP Ethernet Explicit Messaging 791

EIO0000001309 06/2017 779

Managing Communication

Section Topic Page

23.3 Communication by Using Ethernet IP Explicit Messaging 797
23.4 Communication Through Modbus Explicit Messaging 801
23.5 Monitoring Modbus Device Data Directly from Supervision 845

780 EIO0000001309 06/2017

 Managing Communication

Section 23.1
Communication Through Modbus TCP Ethernet Implicit Messaging (I/O Scanning)

Communication Through Modbus TCP Ethernet Implicit

Messaging (I/O Scanning)

Overview
This section provides 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).
NOTE: For the engineering of a system with Process Expert, 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 Process Expert. 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 Process Expert, 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) 782
Communicating with STB Islands Through Modbus TCP Implicit Messaging 785
Communicating with PROFIBUS Remote Masters Through Modbus TCP Implicit Messaging 786
Peer to Peer Communication Through Modbus TCP Ethernet Implicit Messaging 789

EIO0000001309 06/2017 781

Managing Communication

Communicating with Devices Through Modbus TCP Implicit Messaging (I/O Scanning)

Overview
Process Expert 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 579).
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 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 532) and its application counterpart (for example,
$EGenericDeviceHW and $GenericDevice).
The $GenericDevice application template allows you to create an input and an output variable
of required length and data type.
NOTE: You cannot use the $GenericDevice template when the device communicates with the
CPU module of an M580 controller or with a NOC communication module. In such case, you first
need to create a generic template, which is customized for the data length to read/written, based
on the generic application templates ($GenNOCDevice and $GenericNOC_UL) of the General
Purpose library, Devices category. These templates let you create the appropriate input, output,
and I/O scanner status variables of the Reference data type (REF_TO).

782 EIO0000001309 06/2017

 Managing Communication

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 504) with the I/O scanner enabled Configuration
and its communication module. Configure the client memory start and length
parameters (see page 510) of the communication module.
4 Create and configure (see page 532) the topological device entity (configure IP
address and other applicable properties).
NOTE: If the device communicates with the CPU module of an M580 controller
or a NOC communication module, verify that the IP addresses of the device and
the module belong to the same subnet.
5 Create an Ethernet network (see page 541).
6 Connect the communication module of the controller (see page 543) to the
Ethernet network.
7 Connect the I/O device (see page 549) 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 577).
10 Define the communication channel (see page 579) 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 Process Expert,
Device Control Services User Guide) for configuration and setup details.

EIO0000001309 06/2017 783

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 504) with the I/O scanner enabled Configuration
and its communication module. Configure the client memory start and length
parameters (see page 510) of the communication module.
4 Create and configure the generic topological device entity (see page 532),
assign an IP address to it, and enter values for the read/write parameters
(see page 535).
NOTE: If the device communicates with the CPU module of an M580 controller
or a NOC communication module, verify that the IP addresses of the device and
the module belong to the same subnet.
5 Create an Ethernet network (see page 541).
6 Connect the communication module of the controller (see page 543) to the
Ethernet network.
7 Connect the I/O device (see page 549) to the same Ethernet network.
8 If the device communicates with the CPU module of an M580 controller or a Instantiation
NOC communication module, create a customized generic device application
template and instantiate it; otherwise, instantiate the $GenericDevice
template and configure its properties.
9 Map the Control executable of the project to the controller entity Mapping (service)
(see page 577).
10 Define the communication channel (see page 579) 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.

784 EIO0000001309 06/2017

 Managing Communication

Communicating with STB Islands Through Modbus TCP Implicit Messaging

Overview
Process Expert 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 579).
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 504) with the I/O scanner enabled Configuration
and its communication module. Configure the client memory start and length
parameters (see page 510) of the communication module.
4 Create and configure an STB island (see page 521) entity and assign an IP
address to its NIM.
NOTE: If the NIM needs to communicate with a CPU module of the M580
platform or a NOC communication module, verify that the IP addresses of the
NIM and the module belong to the same subnet.
5 Create an Ethernet network (see page 541).
6 Connect the communication module of the controller (see page 546) to the
Ethernet network.
7 Connect the communication module of the STB island (see page 550) to the
same Ethernet network.
8 Map the Control executable of the project to the controller entity (see page 577). Mapping
(service)
9 Define the communication channel (see page 579) 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.

EIO0000001309 06/2017 785

Managing Communication

Communicating with PROFIBUS Remote Masters Through Modbus TCP Implicit

Messaging

Overview
Process Expert 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 579).
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 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

786 EIO0000001309 06/2017

 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 504) with the I/O scanner enabled Configuration
and its communication module. Configure the client memory start and length
parameters (see page 510) of the communication module.
2 Create and configure (see page 527) the PRM entity and its DPs (configure IP
address and other applicable properties).
NOTE: If the PRM needs to communicate with a CPU module of the M580
platform or a NOC communication module, verify that the IP addresses of the
PRM and the module belong to the same subnet.
3 Create an Ethernet network (see page 541).
4 Connect the communication module of the controller (see page 543) to the
Ethernet network.
5 Connect the PRM entity (see page 551) to the same Ethernet network.

EIO0000001309 06/2017 787

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 786) 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 577).
13 Define the communication channel (see page 579) 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 implement 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.

788 EIO0000001309 06/2017

 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 579).
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 476).

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 476) between the Refinement
projects.
4 Create and configure two controllers (see page 504) 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 510) of the communication module.
6 In the controller acting as server, configure the server memory start and length
parameters (see page 510) of the communication module.
NOTE: If the server communicates with a CPU module of the M580 platform or
a NOC communication module client-side, verify that the IP addresses of the
client/server modules belong to the same subnet.
7 Create an Ethernet network (see page 541).
8 Connect the communication module (see page 546) of each controller to this
Ethernet network.

EIO0000001309 06/2017 789

Managing Communication

Step Description Stage

9 Map the Control executable of the owner project to the controller (see page 577) Mapping
acting as server. (service)
10 Map the Control executable of the consumer project to the controller
(see page 577) acting as client.
11 Define the peer to peer communication channels (see page 579) between the Mapping
controllers. (communication)
12 Map the network variables (see page 594) 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.

790 EIO0000001309 06/2017

 Managing Communication

Section 23.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

Supported Architectures
Process Expert 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 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 532) 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

EIO0000001309 06/2017 791

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.

792 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 793

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 791).
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.

794 EIO0000001309 06/2017

 Managing Communication

Step Description Stage

7 Configure a controller and its communication module. Configuration
8 Create (see page 532) 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 395) 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 577). (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 implement 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 Process Expert, Device Control Services User Guide)
 Ports (see Process Expert, Communication Control Services User Guide)

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

EIO0000001309 06/2017 795

Managing Communication

Example 1
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.

796 EIO0000001309 06/2017

 Managing Communication

Section 23.3
Communication by Using Ethernet IP Explicit Messaging

Communication by Using Ethernet IP Explicit Messaging

Communication with Devices by Using Ethernet IP Explicit Messaging

Supported Architectures
Process Expert 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 Device/Communication Matrix
(see 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 532) 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

EIO0000001309 06/2017 797

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.

798 EIO0000001309 06/2017

 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 797).
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 532) 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 577). (service)

EIO0000001309 06/2017 799

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 implement 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 Process Expert, Device Control Services User Guide)
 Ports (see Process Expert, Communication Control Services User Guide)

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.

800 EIO0000001309 06/2017

 Managing Communication

Section 23.4
Communication Through Modbus Explicit Messaging

Communication Through Modbus Explicit Messaging

Overview
This section provides a procedure aimed at managing 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.
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 802
Example Overview 809
Example A 815
Example B 821
Example C 828
Example D 838

EIO0000001309 06/2017 801

Managing Communication

Communication with Devices Through Modbus Explicit Messaging

About Communication Port Templates for Modbus Explicit Messaging

Process Expert 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 Device/Communication Matrix
(see Process Expert, Communication Control Services User Guide).
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.

802 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 803

Managing Communication

One communication port instance per physical NOM port. In this case, the two NOM ports are
located in the same drop.

804 EIO0000001309 06/2017

 Managing Communication

One communication port instance per physical NOM port. In this case, the two NOM ports are
located in separate drops.

EIO0000001309 06/2017 805

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 802).
4 If you are using one topological communication port with several
communication port instances, instantiate the corresponding intermediate
template (see page 802).
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 395) 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.

To complete the other steps to implement the system, follow the system engineering life cycle
described in this manual.

806 EIO0000001309 06/2017

 Managing Communication

NOTE: Refer also to the topic describing Modbus technology (see Process Expert,
Communication Control Services User Guide).

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 395) 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).
10 Generate the project. Generation

EIO0000001309 06/2017 807

Managing Communication

Step Description Stage

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: Refer also to the topic describing the configuration and setup details of gateways
(see Process Expert, Communication Control Services User Guide).

808 EIO0000001309 06/2017

 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 802) 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 802).

EIO0000001309 06/2017 809

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

810 EIO0000001309 06/2017

 Managing Communication

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 module. 2 devices communicating through A (see page 815)
1 communication port.

EIO0000001309 06/2017 811

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 module. 2 devices, each communicating through 1 B (see page 821)
communication port (2 ports total).

812 EIO0000001309 06/2017

 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 modules For each NOM, 2 devices communicating C
through 1 communication port. (see page 828)

EIO0000001309 06/2017 813

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 communication For each drop, 1 device communicating D (see page 838)
module in each. through 1 communication port.

814 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 815

Managing Communication

Configuration Stage
The following figure shows the controller configuration with the drop and the communication
module.

816 EIO0000001309 06/2017

 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.

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.

EIO0000001309 06/2017 817

Managing Communication

These steps result in the following links (the figure is edited and cannot be viewed in the Links
Editor).

818 EIO0000001309 06/2017

 Managing Communication

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

EIO0000001309 06/2017 819

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.

820 EIO0000001309 06/2017

 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).

EIO0000001309 06/2017 821

Managing Communication

Configuration Stage
The following figure shows the controller configuration with the drop and the communication
module.

822 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 823

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.

824 EIO0000001309 06/2017

 Managing Communication

Similarly, the following links are created in the Links Editor for the Altivar device.

EIO0000001309 06/2017 825

Managing Communication

The following figure show the existing links from the perspective of the intermediate template.

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.

826 EIO0000001309 06/2017

 Managing Communication

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.

EIO0000001309 06/2017 827

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.

828 EIO0000001309 06/2017

 Managing Communication

Configuration Stage
The following figure shows the controller configuration with the drop and the communication
module.

EIO0000001309 06/2017 829

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

830 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 831

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.

832 EIO0000001309 06/2017

 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).

EIO0000001309 06/2017 833

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.

834 EIO0000001309 06/2017

 Managing Communication

The figure shows the existing links from the perspective of the intermediate template.

EIO0000001309 06/2017 835

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).

836 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 837

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.

838 EIO0000001309 06/2017

 Managing Communication

Configuration Stage
The following figure shows the controller configuration with the drop and the communication
module.

EIO0000001309 06/2017 839

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.

840 EIO0000001309 06/2017

 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.

EIO0000001309 06/2017 841

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.

842 EIO0000001309 06/2017

 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

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.

EIO0000001309 06/2017 843

Managing Communication

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.

844 EIO0000001309 06/2017

 Managing Communication

Section 23.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.
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 cyle but requires creating your own application objects by using VJC Data facet
templates.
Process Expert generates:
 An OPC Factory Server (OFS) configuration file that contains as many pre-configured device
aliases as there are Modbus devices.
 Supervision tags for variables to be monitored based on the application objects you have
created.

EIO0000001309 06/2017 845

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 779) are already completed.

Step Description Stage

1 Instantiate a Supervision tag facet template for each variable of a Modbus TCP Instantiation
device that needs to be monitored from Supervision. You can use:
 $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 For instances of $VariableTag_CD, configure:
 The address (Addr parameter) by entering only the topological address in
the format %MW<i>.
For example, if the variable tag address is
ATV61IOD_IODEVICE_1!%MW3233, enter only %MW3233.
 The type of the tag (Type parameter) that corresponds to the data instance
whose address you have entered.
For example, UINT for %MW3233.
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.
4 Create additional tag containers (see page 317); one for each Modbus TCP Project Definition
device that you want to monitor from Supervision. (Supervision)
5 Create an I/O device (see page 331) for each tag container and configure the
following parameters:
 TagContainers: Associate each I/O device to a separate tag container.
 Ports

6 Set the following parameters for each tag container:

 Direct TCP IP Addressing Mode: For example, Allocated Data,
Offset 0 with minimum communication (/NT)
 Supports Optimized Modbus Frames: For example, Off

7 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
(VariableTag_ATV71 and VariableTag_TesysT), then you need to
assign:
 VariableTag_ATV71 to TagContainer_x
 VariableTag_TesysT to TagContainer_y

846 EIO0000001309 06/2017

 Managing Communication

Step Description Stage

8 Generate the project. Generation
9 In the Communication Mapping tab (see page 616), perform the following Mapping
additional mappings for each I/O device that you have created for a (communication
Modbus TCP device: mapping for
 Select the corresponding topological entity (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).

To complete the other steps to implement the system, follow the system engineering life cycle
described in this manual.

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. 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 801) are already completed.

Step Description Stage

1 Create a Modbus TCP device entity by using the $EGenericDeviceHW Configuration
template (see page 532). 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 also connected.

EIO0000001309 06/2017 847

Managing Communication

Step Description Stage

4 Instantiate a Supervision tag facet template for each variable of a Modbus Instantiation
serial device that needs to be monitored from Supervision. You can use:
 $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 For instances of $VariableTag_CD, configure:
 The address (Addr parameter) by entering only the topological address in
the format %MW<i>.
For example, if the variable tag address is
ATV61IOD_IODEVICE_1!%MW3233, enter only %MW3233.
 The type of the tag (Type parameter) that corresponds to the data instance
whose address you have entered.
For example, UINT for %MW3233.
6 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.
7 Create additional tag containers (see page 317); one for each Modbus serial Project Definition
device that you want to monitor from Supervision. (Supervision)
8 Create an I/O device (see page 331) for each tag container and configure the
following parameters:
 TagContainers: Associate each I/O device to a separate tag container.
 Ports

9 Configure the following parameters for each tag container:

 Direct TCP IP Addressing Mode
 Supports Optimized Modbus Frames

10 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 (VariableTag_ATV71MB
and VariableTag_TesysTMB), then you need to assign:
 VariableTag_ATV71MB to TagContainer_x
 VariableTag_TesysT to TagContainer_y

11 Generate the project. Generation

848 EIO0000001309 06/2017

 Managing Communication

Step Description Stage

12 In the Communication Mapping tab (see page 616), 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.
13 Repeat step 12 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.

EIO0000001309 06/2017 849

Managing Communication

850 EIO0000001309 06/2017

 Process Expert
Global Templates
EIO0000001114 05/2017

Part IV
Global Templates

Global Templates

Overview
This part describes the Global Templates library, the templates that it contains, and the different
tools that allow you to manage them.

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
24 Global Templates Library 853
25 Global Templates Editors 867
26 Managing Global Templates 897

EIO0000001309 06/2017 851

Global Templates

852 EIO0000001309 06/2017

 Process Expert
Global Templates Library
EIO0000001114 05/2017

Chapter 24
Global Templates Library

Global Templates Library

Overview
This chapter describes the Global Templates library, the tools that are available to manage it, and
outlines the actions you can perform on Process Expert Global Templates.

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Global Templates Library 854
Global Templates Explorer 858
Global Templates Folders 863
Global Templates 864

EIO0000001309 06/2017 853

Global Templates Library

Global Templates Library

Introduction
The Schneider Electric Global Templates library provides the resources to model systems by using
Global Templates.
Schneider Electric templates, as well as templates that you create are stored in the Global
Templates library. You can access them by using the Global Templates Explorer (see page 858),
which allows organizing and viewing templates inside a folder structure.
Global Templates can be of the following types:
 Interface models
 Facet templates
 Composite templates

854 EIO0000001309 06/2017

 Global Templates Library

Library Structure
The following libraries are available for Process Expert.

 Foundation library: Provides the low-level resources required to define the topology of the
system and enable the other application libraries (Schneider Electric and your own libraries).
 General Purpose library: Provides the following resources in the form of application templates:
 Process templates
 Device templates
 Communication templates
 Diagnostic templates

EIO0000001309 06/2017 855

Global Templates Library

Library Naming Convention

The Schneider Electric Global Templates that are available in Process Expert follow a naming
convention:
$NAME_XX
Where
 $ indicates that the template is a Schneider Electric General Purpose.
 NAME is the name of the template
 _XX indicates the type of the template.

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.

Reference Documents for Application Templates

Refer to the Process Expert templates user guides for:
 A list of process, device, communication, and diagnostic templates that are available in the
Global Templates library.
 A list of foundation application templates that are available in the Foundation library.
 Information on the Control and/or Supervision services that are provided for each category and
their configuration parameters.
This information helps you select templates and configure instances thereof to meet the
requirements of your system.

856 EIO0000001309 06/2017

 Global Templates Library

The table indicates the scope of each of the available templates user guides.

Title Scope
Process Expert Process Describes process templates, which allow you to instantiate common control
Templates User Guide modules for process automation, such as motors, valves...Including signals
from the field and variables.
Two separate user guides provide information on the Control and Supervision
services that are provided for process management.
Process Expert Device Describes device templates, which provide you with functions to manage
Templates User Guide Schneider Electric devices connected to field buses, such as speed drives,
motor starters, instrumentation...
Two separate user guides provide information on the Control and Supervision
services that are provided for device management.
Process Expert Describes communication templates, which provide you with functions to
Communication Templates manage communication with Schneider Electric or third party devices, and
User Guide client/scanners through supported networks and communication buses.
A separate user guide provides information on the Control services that are
provided for communication management.
Process Expert Diagnostic Describes diagnostic templates, which provide you with functions to view the
Templates User Guide status of the main functions of controllers of the system.
Two separate user guides provide information on the Control and Supervision
services that are provided for diagnostic management.
Process Expert Foundation Describes foundation application templates, which provide standardized
Application Templates User elementary resources that are used in control module templates of the
Guide General Purpose library. These templates also provide additional services
that are required to manage data transmission within a system.
A separate user guides contains information on the Control services that are
provided by these templates.

EIO0000001309 06/2017 857

Global Templates Library

Global Templates Explorer

Introduction
The Global Templates Explorer allows you to perform the following tasks on Global Templates:
 Browse the Global Templates.
 Export and import Global Templates (see page 898).
 Access template editors (see page 867).
 Create your own folders (see page 863) and templates.

Global Templates are represented in the tree view of the Global Templates Explorer in the form of
a folder structure starting from the Global Templates root folder, which is automatically created by
the software.

Accessing the Global Templates Explorer

Access the Global Templates Explorer by clicking the Global Templates button in the menu bar.

Global Templates Explorer Window

The following figure shows an example of the Global Templates Explorer window.

1 Toolbox pane. 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 root folder.
3 Tree view of the General Purpose library.
4 Search field.

858 EIO0000001309 06/2017

 Global Templates Library

Searching the Global Templates Library

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 icon. A tooltip provides additional information.
The following figure shows an example of the search results 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.

EIO0000001309 06/2017 859

Global Templates Library

Command Description
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 864).
Edit

You can sort and filter (see page 143) 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.

Global Templates Toolbox

The Toolbox contains the following base Global Templates, which you can use to create new
templates or modify (see page 867) 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.
 Unity: Facet templates that encapsulate constituents of the Control Participant. You can
reference them inside composite templates.
 VJC: 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.

860 EIO0000001309 06/2017

 Global Templates Library

Item Description
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
 Advantys CANopen (CANopen extension of the STB islands)

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)
 Vijeo Citect software
 OPC Factory Server software
 Unity Pro software
 Platform and platform backup servers

The table describes the templates that are in the Unity (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 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.

EIO0000001309 06/2017 861

Global Templates Library

The table describes the templates that are in the Vijeo Citect 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 a genie, which
is contained in a Vijeo Citect Include project 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.

Recovery Folder
When you start the Process Expert system server, if the software detects missing references in
templates, it creates the Recovery folder in the Global Templates library. You can see the folder
when you start an engineering client and open the Global Templates explorer.
This folder contains the templates that are missing.
This can be the case, for example, after migrating a Process Expert 3.1 SP1 database. 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 of the Global
Templates library by right-clicking them and selecting an action (see page 864).

862 EIO0000001309 06/2017

 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: Process Expert 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.

When You Process Expert...

Select...
Create Folder creates a new folder and displays it in the tree view.
Default name: Folder_n , where n is an incremental number starting at 1.
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 copies the folder, any subfolders and their contents.
(see page 903)
Paste pastes the items that you have copied last to a new location.
(see page 903)
Export opens the Export dialog box, which allows you to select which templates contained in the
(see page 904) folder, including any subfolders you want to export to a file in .sbk format.
Import opens the Import dialog box, which allows you to select an export file in .sbk format and
(see page 908) displays the compatible contents that you can select for import.
Purge opens the Purge dialog box, which allows you to select templates to purge in the folder and
(see page 916) any subfolder.
Delete deletes the folder and its contents from the Global Templates library.
The command is not available if the folder or any subfolder contains a template.
Rename allows you to enter a new name for the folder.
The command is not available if the folder or any subfolder contains a template.

EIO0000001309 06/2017 863

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
Icon Displays the icon corresponding to the type of template.
Identifier The fields come from the header of the composite/facet template or of
the interface.
Version
Refer to the following topics for a description of the fields for:
Type  composite templates
Subtype  facet templates
 interface models
Valid
State
Description

Global Templates Actions

Right-click a template in a Global Templates folder to open a context menu with the following
commands:

When you Process Expert...

select...
Read-only 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 868) 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 of the template to either
Obsolete or Deprecated.
The command is available only if a higher version of the template exists and if 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 893) 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.

864 EIO0000001309 06/2017

 Global Templates Library

When you Process Expert...

select...
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 903)
Export opens the Export dialog box, which allows you to save the template data to an export
(see page 904) file in .sbk format.
Remove removes the copy of the template.
The command is available as long as copies of the template exist.
When only one instance of the template remains, the command is replaced by Delete.
Delete deletes the template from the Global Templates library.
The command is not available if a template:
 is being used by another template of the Global Templates library, which is not being
deleted, or
 is being used by a facet of any system

Update allows you to create a new version of the template using the latest version of any
(see page 923) referenced ones that exist in the Global Templates library.

EIO0000001309 06/2017 865

Global Templates Library

866 EIO0000001309 06/2017

 Process Expert
Global Templates Editors
EIO0000001114 05/2017

Chapter 25
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
25.1 Accessing Global Templates Editors 868
25.2 Interface Editor 870
25.3 Facet and Composite Template Editors 878
25.4 Common Template Editor Components 887

EIO0000001309 06/2017 867

Global Templates Editors

Section 25.1
Accessing Global Templates Editors

Accessing Global Templates Editors

Opening Global Templates Editors

Overview
To access 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.

Accessing Global Templates Editors

Modifying or updating Schneider Electric Global Templates or templates created by users may
affect the function of these templates and must be performed by qualified personnel.

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.
1
 Apply local accident prevention and safety regulations and guidelines .
 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.

868 EIO0000001309 06/2017

 Global Templates Editors

To open a template in the corresponding editor in either read-only or editing mode, proceed as
follows.

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 [Link] 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 [Link] 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 858). 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, Process Expert creates a temporary
working copy of the template with the same identifier and a specific version. It removes this working
copy when you close the template editor.

EIO0000001309 06/2017 869

Global Templates Editors

Section 25.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.

870 EIO0000001309 06/2017

 Global Templates Editors

Interface Editor Window

The following figure shows an example of the Interface Editor window 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

EIO0000001309 06/2017 871

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 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 872) or
which other templates reference it.
Locations(1) Allows you to view the path to the interface and its copies (see page 903).
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.

872 EIO0000001309 06/2017

 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 and header common definition (shared among interface models, facet, and
composite templates).
 Elements definition.
 Rules definition editors.
 Interface toolbox.

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 899).
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 899).
4 Opens the editor menu that contains editor-specific commands.

EIO0000001309 06/2017 873

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.
View Used By The commands allow you to bring the corresponding pane to the
front.
Locations
If the pane is closed, the command opens it.
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 899).
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 899).
Export Standard Backup Opens the Export window, which allows you to export the interface
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 904).
Various image file Each command opens a Save dialog box, which allows you to
formats create an 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 877).
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 899).

874 EIO0000001309 06/2017

 Global Templates Editors

Workspace Actions
Right-click an empty area of the workspace to open a context menu with the following commands.

When You Process Expert...

select...
Inspect opens a submenu with the Used By (see page 872) and Dependencies Tree
(see page 872) commands.
Show changes opens the Changes log pane. (see page 877)
log

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 Process Expert...

select...
Rename allows you to modify the identifier of the role.
For more information, refer to the topic describing interface roles.

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 Process Expert...

select...
Switch to sets the rule for the element, which is the producer to optional. In such case, the element
Optional 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 sets the rule for the element, which is the producer to required (default value). In such
Required case, the element is required to provide data for the interface link to be valid.
Use as switches the direction from producer to consumer.
Consumer
NOTE: Using this command resets the element rule to required if it was set to
optional.
Use as switches the direction from consumer to producer.
Producer

EIO0000001309 06/2017 875

Global Templates Editors

When You Process Expert...

select...
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 Process Expert...

select...
Switch to sets the rule for the element to optional. In such case, the element is not required to
Optional 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 sets the rule for the element, which is the producer to required (default value). In such
Required case, the element is required to provide data for the interface link to be valid.
Add to Rules adds the element that has the Ref role to the Rules table so that you can define a rule for
table 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 872) commands.

876 EIO0000001309 06/2017

 Global Templates Editors

When You Process Expert...

select...
Read-only opens the nested interface in another Interface Editor in read-only mode.
Edit opens the nested interface in another Interface Editor in editing mode.
Update Not used in this version.
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 899).

EIO0000001309 06/2017 877

Global Templates Editors

Section 25.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 879
Composite Editor 883

878 EIO0000001309 06/2017

 Global Templates Editors

Facet Editor

Overview
The graphical Facet Editor allows you to manage the entire definition of facet templates.
For a description of panes, toolbars, and menus, refer to the topic describing common template
editor components (see page 887).
NOTE: This topic provides information on the Facet Editor user interface; it does not provide
information on the definition of facet templates (see Process Expert, Global Templates, Reference
Manual).

Facet Editor Window

The following figure provides a typical view of the Facet Editor window.

1 Document Outline, Toolbox, and Browser panes

2 Properties and Interface Rules panes
3 Workspace area displaying a graphical representation of the elements of the template that you are editing
4 Editor toolbar containing commands that apply to the template being viewed or edited
5 Templatizer button
6 Workspace toolbar

EIO0000001309 06/2017 879

Global Templates Editors

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 892).

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.

When You Process Expert...

select...
Optimize reroutes bindings of the element correctly.
Bindings
Show/Hide displays or hides only the selected parameters.
Unchecked
Show/Hide displays or hides only parameters for which a binding exists.
Unbound
Go to opens a submenu that contains the name and path of other elements and their parameters
that are linked to the element through bindings. It allows you to locate them easily. When
you select an entry, it is highlighted in the workspace.
Copy copies the element for pasting in this template or another template.
Exclude removes the element from the workspace and makes it available again in the Elements
section of the Document Outline pane.
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 Facet Editor to open a context
menu with the following commands.

When You Process Expert...

select...
Create allows you to create a parameter that you can configure.
Parameter
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.
For interface parameters only.
Go to opens a submenu that contains the name and path of other elements and their parameters
that are linked to the element through bindings. It allows you to locate them easily. When
you select an entry, it is highlighted in the workspace.

880 EIO0000001309 06/2017

 Global Templates Editors

When You Process Expert...

select...
Binding to here allows creating a binding with the output pin of the parameter of another element in the
from... workspace of the editor. It adds the identifier of the parameter to the context menu of the
parameter that is the source for the binding.
After selecting this command, right-click the parameter or property of an element in the
workspace (which represents the from...) and select Bind to x where x is the identifier
of the element to which you are creating the binding.
The software creates a binding between both parameters.
To remove the binding, delete it. To create a binding with another parameter, right-click the
other parameter and repeat.
NOTE: The command remains unavailable as long as the identifier of the parameter is
added to the context menu of other elements.
Binding from allows creating a binding with the input pin of the parameter of another element in the
here to... workspace of the editor. It adds the identifier of the parameter to the context menu of the
parameter that is the destination of the binding.
after selecting this command, right-click the parameter of an element in the workspace
(which represents the to...) and select Bind from x where x is the identifier of the element
from which you are creating the binding.
The software creates a binding between both parameters.
To remove the binding, delete it. To create a binding with another parameter, right-click the
other parameter and repeat.
NOTE: The command remains unavailable as long as the identifier of the parameter is
added to the context menu of other elements.
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 display a
context menu with the following commands.

When You Process Expert...

select...
Switch to Optional: makes the element optional in the context of the template.
Optional/ The element is represented with a dotted outline.
Required Required: makes the element mandatory in the context of the template.
The element is represented with a solid outline.
Optimize reroutes bindings of the element correctly.
Bindings
Show/Hide displays or hides only the selected parameters.
Unchecked
Show/Hide displays or hides only parameters for which a binding exists.
Unbound

EIO0000001309 06/2017 881

Global Templates Editors

When You Process Expert...

select...
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 elements and their parameters
that are linked to the element through bindings. It allows you to locate them easily. When
you select an entry, it is highlighted in the workspace.
Copy Copies the element for pasting in this template or another template.
Update allows you to create a new version of the template using the latest version of any
(see page 923) referenced ones that exist 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 (header) and properties common definition (shared among interface models, facet,
and composite templates).
 Facet Elements
 Interfaces Rules (see Process Expert, Global Templates, Reference Manual)
 Toolbox: binding functions and/or Supervision Participant elements (see page 893).
 Parameter pane

Viewing Changes to Templates

Refer to the topic describing the Changes log pane (see page 893).

Saving Changes
Refer to Saving Changes in Global Templates (see page 899).

882 EIO0000001309 06/2017

 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 887).
NOTE: This topic provides information on the Composite Editor user interface; it does not provide
information on the definition of composite templates (see Process Expert, Global Templates,
Reference Manual).

Composite Editor Window

The following figure provides a typical view of the Composite Editor window.

1 Document Outline, Toolbox, and Browser panes

2 Properties, Interface Rules, and Element Rules panes
3 Parameters pane
4 Workspace area displaying a graphical representation of the elements of the template that you are editing
5 Editor toolbar containing commands that apply to the template being viewed or edited
6 Workspace toolbar

EIO0000001309 06/2017 883

Global Templates Editors

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 892).

Element Actions
Right-click the header of an element in the workspace of the Composite Editor to display a context
menu with the following commands.

When You Process Expert...

select...
Switch to Optional: makes the element optional in the context of the template.
Optional/ The element is represented with a dotted outline.
Required 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 reroutes bindings of the element correctly.
Bindings
Show/Hide displays or hides only the selected parameters.
Unchecked
Show/Hide displays or hides only parameters for which a binding exists.
Unbound
Inspect allows you top open the Used By, Dependencies Tree, or External References panes
(see page 893) 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.
Go to opens a submenu that contains the name and path of other elements and their parameters
that are linked to the element through bindings. It allows you to locate them easily. When
you select an entry, it is highlighted in the workspace.
Copy Copies the element for pasting in this template or another template.
Update allows you to create a new version of the template using the latest version of any
(see page 923) referenced ones that exist in the Global Templates library.
Delete removes the element from the template.

884 EIO0000001309 06/2017

 Global Templates Editors

When You Process Expert...

select...
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.

When You Process Expert...

select...
Create Deferred defers the parameter to make it available in the top-level template referencing the
composite that you are editing.
See also the commands of the context menu for parameters of elements of facet templates (see page 880).

Right-click the interface of an element in the workspace of the Composite Editor to open a context
menu with the following commands.

When You Process Expert...

select...
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.

Edit opens the interface in the corresponding editor in edit mode.
Properties displays the properties of the interface in the Properties pane.

EIO0000001309 06/2017 885

Global Templates Editors

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 Process Expert, Global Templates, Reference Manual) and properties
common definition (shared among interface models, facet, and composite templates).
 Composite Elements (see Process Expert, Global Templates, Reference Manual)
 Interfaces Rules (see Process Expert, Global Templates, Reference Manual)
 Toolbox: binding functions
 Parameter pane

Viewing Changes to Templates

Refer to the topic describing the Changes log pane (see page 893).

Saving Changes
Refer to Saving Changes in Global Templates (see page 899).

886 EIO0000001309 06/2017

 Global Templates Editors

Section 25.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 888
Common Template Editor Panes 893

EIO0000001309 06/2017 887

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 899).
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 899).
4 Displays the Parameters pane.
5 Displays the Dependencies Tree pane.
6 Displays the Used By pane.
7 Displays the External References pane.

888 EIO0000001309 06/2017

 Global Templates Editors

Item Description
8 opens the Select Variables window, which allows you to encapsulate constituents in Control
and Supervision facet templates. It also allows you to modify encapsulated elements with the
help of the corresponding Participant. If the facet contains no constituents, the button opens the
Content Not Found dialog box, which allows you to start the encapsulation process.
For more information, refer to the topic describing the configuration of facet templates.
NOTE: The command is available only in the Facet Editor.
9 Opens the editor menu (see page 890) 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 893).

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 the display to the default size (100%).
6 Adjusts the size of the display to fit the elements of the template inside the workspace.
7 Zooms out.
8 Zooms in.
9 Current display ratio.
Use a different predefined ratio by clicking the arrow and selecting a value from the menu.
You can use a custom ratio by double-clicking the digits and entering a value.

EIO0000001309 06/2017 889

Global Templates Editors

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 130).

Editor Menu

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.
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.

(1) The command appears only in the menu of the Composite Editor

890 EIO0000001309 06/2017

 Global Templates Editors

Command Description
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
External References template 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 899).
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 899).
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 904).
Various image file Each command opens a Save dialog box, which allows you to
formats create an 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.
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 899).
(1) The command appears only in the menu of the Composite Editor

EIO0000001309 06/2017 891

Global Templates Editors

Workspace Context Menu

Right-click an empty area of the workspace to open a context menu with the following commands.

When You Process Expert...

select...
Inspect opens a submenu with the Used By (see page 872) and Dependencies Tree
(see page 872) commands.
Align left edges Refer to the description of the corresponding commands in the workspace toolbar
Align top edges
(see page 889).
The commands are available only if two or more elements are selected in the workspace.
Align right
edges
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 opens the Changes log pane. (see page 877)
log
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.

892 EIO0000001309 06/2017

 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.
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 referenced by the
template.
Element Rules(1) Allows you to view and define the rules for the elements 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.

EIO0000001309 06/2017 893

Global Templates Editors

Pane Description
Toolbox Allows you to browse and select binding functions to be used in the template.
For facet templates of the Vijeo Citect category, the Toolbox pane also contains the
following elements:
 For facet templates of the Data subtype:
 Advanced Alarm
 Digital Alarm
 Local Variable Tag
 Message
 Time Stamped Digital Alarm
 Trend Tag
 Variable Tag

 For facet templates of the Genie subtype: None.

 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 (see page 854) to
be referenced by the template.
In the Composite Editor, allows you to browse and select facet and composite
templates, and interfaces (see page 854) 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.
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 233).
Parameters The Parameters pane allows you to:
(see Process Expert,  View and manage parameter data that is used during instantiation to customize
Global Templates, elements of an instance.
Reference Manual)  Customize the layout of the parameters that are visible when you edit an
instance by using the Instance Editor:
 Change the position of parameters within their category.
 Change the position of categories.
 Assign parameters to another category.

(1) The pane appears only in the Composite Editor.

894 EIO0000001309 06/2017

 Global Templates Editors

Pane Description
Locations Allows you to view the path to the template and its copies (see page 903).
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.

EIO0000001309 06/2017 895

Global Templates Editors

896 EIO0000001309 06/2017

 Process Expert
Managing Global Templates
EIO0000001114 05/2017

Chapter 26
Managing Global Templates

Managing Global Templates

Overview
This chapter describes how to create new base templates and manage existing Global Templates.

What Is in This Chapter?

This chapter contains the following sections:
Section Topic Page
26.1 Managing Global Templates 898
26.2 Updating and Replacing Global Templates 919

EIO0000001309 06/2017 897

Managing Global Templates

Section 26.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 899
Copying and Pasting Global Templates and Folders 903
Exporting Templates 904
Importing Templates 908
Purging the Global Templates Library 916

898 EIO0000001309 06/2017

 Managing Global Templates

Saving Changes In Global Templates

Overview
When Global Templates are open in their respective editor (see page 868), you can save changes
by using the following commands:
Save Allows you to save changes in Global Templates by using various saving 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 create a new template or a new version of Global Templates.
When you select the Save as command, you can select a location where to save the template.

Tracking Saved Changes

When you save a template, Process Expert 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 893).

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.
By default, New Build is selected when you open the Save As dialog box.
New Minor
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 3 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: If you select a different versioning scheme after editing parameters in the
dialog box, the software could undo your changes.
Version For a description of the version format, refer to Version.
Identifier Within the Global Templates library, the combination of Identifier and Version must be
unique for each template.
NOTE: The use of the $ prefix is reserved for templates created by
Schneider Electric. Do not use it for templates that you create or modify to help avoid
version conflicts with future releases of the Global Templates library.

EIO0000001309 06/2017 899

Managing Global Templates

Item Description
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 903)
exist, their location is indicated also.
Click the browse button to open the Select Template Location dialog box, which lets
you change locations.
Usability State(1) For information on the parameter, refer to Usability State.
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.
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.
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.

900 EIO0000001309 06/2017

 Managing Global Templates

Saving Changes In Global Templates

Updating or 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.

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.
1
 Apply local accident prevention and safety regulations and guidelines .
 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.
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.

EIO0000001309 06/2017 901

Managing Global Templates

Step Action
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.

902 EIO0000001309 06/2017

 Managing Global Templates

Copying and Pasting Global Templates and Folders

Creating Linked Copies of Templates

You can place a template in several folders of the Global Templates library by using the copy and
paste commands. The pasted template is linked to the source template. Any change that you make
to the source template is also made to each copy that you have created by using the paste
command.
NOTE: To create an independent copy of a template, use the Save as command from the
corresponding template editor.

Locating Copies
To locate the linked copies of a template, use the Locations command (see page 864).

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 pasted in the same way.

EIO0000001309 06/2017 903

Managing Global Templates

Exporting Templates

Overview
You can export templates that are contained in the General Purpose library and in library folders
that you have created by using the Export command of the Global Templates Explorer.
The process creates an export file in .sbk format that contains:
 The selected templates.
 Referenced composite and facet templates, and interfaces.
 Local constituents.
 Content.

It 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 94). 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.

904 EIO0000001309 06/2017

 Managing Global Templates

Template Export Window

The following figure shows an example of the template Export window, which opens when you
export the folder containing control module templates of the Process category.

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 903) are
not counted even if they are selected.

EIO0000001309 06/2017 905

Managing Global Templates

NOTE: To expand/collapse a node in the Export window, select the node and press Enter.
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 36).
Version Indicates the version of the template.
State Usability state 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.

906 EIO0000001309 06/2017

 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: Process Expert opens the Export window.
2 Select the templates that you want to export.
3 Click OK.
Result: Process Expert opens a Save dialog box.
4 Enter a name for the export file and select a location, and click Save.
Result: Process Expert 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 the entire General Purpose library, create separate export files
by selecting subfolders (Communications, Devices, and so on) in the Export window. This creates
smaller export files that are easier to import.

EIO0000001309 06/2017 907

Managing Global Templates

Importing Templates

Overview
The import function 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
makes them available in the Process Expert database that is mounted.
When you select an export file (.sbk) containing templates, Process Expert compares the
information in the export file with the templates contained in the Global Templates library and
applies rules to avoid template duplication.
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 genies
used by Supervision runtime.
NOTE: Importing several 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 Process Expert 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
Process Expert displays a
message about the
detected conflict.
The version is unique. The signature is unique. The template is imported.

908 EIO0000001309 06/2017

 Managing Global Templates

Accessing the Template Import Window

To access the Import window, proceed as follows.

Step Action
1 From the Process Expert toolbar, click the Global Templates explorer icon.
Result: Process Expert opens the Global Templates Explorer window.
2 Right-click the Global Templates root folder and select Import.
Result: The software opens the Import dialog box.
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.

EIO0000001309 06/2017 909

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 The message appears when the export file was created with a version of Process Expert that is
different from the one you are using. The version of the export file is indicated in brackets.
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.

910 EIO0000001309 06/2017

 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 903) is created if imported.
Red Red dot: The template cannot be selected for import because of a detected signature
conflict (see page 908).

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 36).
Version Indicates the version of templates in the export file.
State Usability state of the template (for example, Approved or Deprecated).
Description Description of templates in the export file.

EIO0000001309 06/2017 911

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

912 EIO0000001309 06/2017

 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.

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 Genies that are included in the current content located in the content
repository.
New genies Genies that are included in the content in the export file.
Conflicts Genies that represent a conflict if you import the new content.

EIO0000001309 06/2017 913

Managing Global Templates

In the Resolve Contents Conflict dialog box, verify the following before proceeding with the import:
 Refer to the library release notes if you are importing templates provided with the
Process Expert installation files. The document contains information about changes that were
made to templates of the Global Templates library.
 Considerations when importing content:
Selecting new content New and updated templates that you are importing and that require the
new content will work correctly; however, the current content used by existing templates of
the Global Templates library may be overwritten.
Selecting current content The content that is used by existing templates of the Global
Templates library is not affected; however, new and updated 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 94). 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.

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 910) 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.

914 EIO0000001309 06/2017

 Managing Global Templates

Step Action
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:
 Process Expert imports the selected templates.
 Applies the import settings you have selected.
 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 PC, requiring you to restart the PC.

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:

Step Action
1 Quit Process Expert clients (see page 81).
2 Stop the system server.
3 Restart the PC.

EIO0000001309 06/2017 915

Managing Global Templates

Purging the Global Templates Library

Overview
By using the Purge command from a folder in the Global Templates library, you can 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 944).
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
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 439).
To delete such template, first generate the project or the container to which the facet is assigned.

916 EIO0000001309 06/2017

 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 94). 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 Process Expert database (see Process Expert, Installation and Configuration Guide).

EIO0000001309 06/2017 917

Managing Global Templates

Purging Global Templates

NOTICE
LOSS OF DATA
Back up the Process Expert 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 software opens the Purge window. 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.

918 EIO0000001309 06/2017

 Managing Global Templates

Section 26.2
Updating and Replacing Global Templates

Updating and Replacing Global Templates

Overview
This chapter explains the aspect of updating templates with later versions of their references.
It also describes how to replace templates used by elements of Global Templates.

What Is in This Section?

This section contains the following topics:
Topic Page
Template Update Strategy 920
Updating Global Templates 923
Replacing the Template of an Element of a Global Template 929

EIO0000001309 06/2017 919

Managing Global Templates

Template Update Strategy

Overview
The following applies if you have created a new version of one of your interface models, composite,
or facet templates (keeping the same identifier), which is referenced by at least one of your facet
or composite templates.
You need to update any template that references the new version that you have created in order
to apply the changes. You can choose to update only some of the templates.
Updating a template creates a new version of it in the same location.
Follow either update strategy that is described in this topic to manage change effectively.
Once you have created a new version of a template by using the update function, you can update
instances of the application, which use the previous version of that template.
NOTE: If you have created a new template with a different identifier, you cannot use the automatic
update function. You need to update templates manually by including the update in place of the
original template.

Approach to Updating Templates

 If you know which highest level templates reference templates for which a later version is
available, proceed with the update in a methodical way, template by template. Typically,
consider as highest level template the control module template.
 If you do not know which highest level templates are affected, use the Used by command on
the version from which the update was created. This allows you to determine which are the
highest level templates that reference the updated template. Refer to the example
(see page 921).

Update Strategy by Control Module Template

Step Action
1 In the Global Templates Explorer, right-click the control module template that references the
template of which you have created a new version and select Update.
For example, if control module template MyMotor [1.0.0] references element MyLogic
[1.0.0] and you have created MyLogic [1.0.1], you need to right-click MyMotor [1.0.0].
Result: Process Expert opens the Update dialog box.
2 Continue by following the procedure described in Updating Global Templates. (see page 927)
3 Repeat the procedure for each control module referencing the template of which you have created
a new version.

NOTE: If you have created a new version of more than one template and these are referenced by
the same control module template, using the Update command allows you to update the control
module template with them at once.

920 EIO0000001309 06/2017

 Managing Global Templates

Update Strategy Template by Template

The table describes the process to update the various levels of a control module template starting
from the lowest level of the composition where a new version of a referenced template exists.

Step Action
1 In the Global Templates Explorer, locate the interface, composite, or facet template from which you
have created an updated version.
2 Right-click it and select Inspect → Used by.
Result: Process Expert opens the Used by pane on the left-hand side of the workspace.
3 Take note of the identifier and version of the highest level templates that reference it.
4 Locate each of these highest level templates and follow the procedure described in Updating
Global Templates. (see page 927).

Example
This example illustrates the update strategy template by template when you do not know which
control module templates reference the template of which you have created a new version.
The objective is to replace Facet_A [1.0.0] with Facet_A [2.0.0], which is an updated
version.
Consider the following templates.

 Compo_A [1.0.0] references template Facet_A [1.0.0]

 Compo_B [1.0.0] references templates Facet_A [1.0.0] and Facet_B [1.0.0]
The Used by command for Facet_A [1.0.0] allows you to determine which templates
reference the new version of it:
 Compo_A [1.0.0]
 Compo_B [1.0.0]

EIO0000001309 06/2017 921

Managing Global Templates

When you use the Update command on Compo_A [1.0.0] and Compo_B [1.0.0], the
software creates a new version of each composite template. Each one contains
Facet_A [2.0.0]. (The version has been highlighted in yellow for the purpose of this example.)

NOTE: The version number that the software creates depends on the version strategy that you
select in the Update dialog box (see page 925).

922 EIO0000001309 06/2017

 Managing Global Templates

Updating Global Templates

Overview
In the Global Templates Explorer, you can create a new version of your template by using the
latest, approved version of any of the elements referenced by this template.
You can update the following templates as part of:
 Composite templates:
 Interfaces: Interface models
 Elements: Composite and facet references

 Facet templates:
 Interfaces: Interface models

 Interfaces:
 Nested interfaces

This process allows you to integrate in the composition of your template later versions of composite
and facet templates, and interface models that it references.

Function Description
Process Expert proceeds with the update in the following order after you select the Update
command for your template:
 The software searches its tree of dependencies for any element with the same identifier and for
which a later version exists in the Global Templates library.
 A dialog box displays the templates that the software has found in the dependencies, and allows
you to select:
 The usability state for the current version of templates after the software creates a new
version.
 The versioning scheme and usability state for the new version of templates that the software
creates.
 Interface links are processed.
NOTE:
 For the template update process to be executed, the newer version of the referenced template:
 Needs to be available in the Global Templates library.
 Needs to have the Usability State Approved.

 Refer to Importing Global Templates (see page 908).

EIO0000001309 06/2017 923

Managing Global Templates

The table describes the effects on the different template components when you update a template.

Current In new template Effect

template
component
Bindings to the Element selection of composite The software maintains the bindings.
element references is the same as in
selection of current template.
composite Element selection of composite The software removes the bindings to the element selection of
references
references is not the same as in the composites that are not part of the new template.
current template.
Bindings and Bindings and attributes of the The software maintains the bindings and attributes.
attributes of the element parameters are the same
element as in current template.
parameters Bindings and attributes of the The software removes the bindings and attributes of the
element parameters are not the element parameters that are not part of the new template.
same as in current template.
Bindings to Bindings to element interfaces are The software maintains the bindings.
element the same as in current template.
interfaces
Bindings to element interfaces are The software removes the bindings to the element interfaces
not the same as in current that are not part of the new template.
template.

924 EIO0000001309 06/2017

 Managing Global Templates

Update Dialog Box

The following figure shows an example of the Update dialog box for the MyMotor (1.0.0)
control module template, which references MyMotor_UC (1.0.0). This UC composite template
references MyDEVCTL_UC (1.0.0), which references the MyDEVCTL_UL (1.0.0) facet
template. MyDEVCTL_UL version (1.0.1) and (1.0.2) exist in the Global Templates library.

Header Description
Update Plan section
Identifier At the top level, identifier of the template from which you have selected the
Update command. It is followed by identifiers of any referenced templates
that the software updates.
Type Type of the template.
State 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.
Version Current version of the template from which you have selected the Update
command and current version of its elements.

EIO0000001309 06/2017 925

Managing Global Templates

Header Description
New Version Version of the template that will reference the updated templates.
For templates that you have updated, latest version 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 manually for each template
version that the software creates during the update. Modifying the version
number manually sets the Version strategy parameter to Custom.
Current Template section
State strategy Allows you to select the usability state of the current version (Version
column) of the templates after the software has created the new version of
them.
Default value: Custom
New Template section
Usability state 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.
Version strategy Allows you to select the versioning scheme 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.

926 EIO0000001309 06/2017

 Managing Global Templates

Updating Global Templates

Updating Schneider Electric Global Templates or templates created by users may affect the
function of these templates and must be performed by qualified personnel.

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.
1
 Apply local accident prevention and safety regulations and guidelines .
 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.
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: Process Expert displays the Update dialog box.
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.

EIO0000001309 06/2017 927

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: Process Expert:
 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.

928 EIO0000001309 06/2017

 Managing Global Templates

Replacing the Template of an Element of a Global Template

Overview
The Global Templates Explorer allows you to replace the template that is used by an element of a
Global Template with another template of the Global Templates library.
You can replace the template of the following types of elements:
 Composite templates
 Facet templates

Replacing the template of an interface is not supported.

The replacement of the template of an element impacts templates referencing the element and
requires updating (see page 920) all or some of the higher-level templates.
NOTE: To replace the template of an element by another version of the same template, use the
Update command (see page 923) instead.

EIO0000001309 06/2017 929

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, 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.

930 EIO0000001309 06/2017

 Managing Global Templates

After dragging $AINPUT1_UC onto $AINPUT_UC, you need to confirm the template replacement.

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.

EIO0000001309 06/2017 931

Managing Global Templates

The figure shows the AnalogInput element after template replacement is complete.

1 Template 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 was saved with the same identifier but under a new version with Usability state
approved so that templates referencing the original version (1.4.9) can be updated easily.

932 EIO0000001309 06/2017

 Managing Global Templates

Once template replacement is complete, you need to update templates that reference
$AnalogInput_UC (1.4.9) so that they use (1.5.0). 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.

EIO0000001309 06/2017 933

Managing Global Templates

Navigate to $AnalogInput [2.3.1] and use the Update command. In this example, updating
$AnalogInput [2.3.1] creates version [2.3.2], which references $AnalogInput_UC (1.5.0).

NOTE: You may need to update application instances that currently use
$AnalogInput [2.3.1] and/or $AnalogInput_UC (1.5.0) to use the latest version.

Function Description
Process Expert proceeds with the replacement of the template as follows:
 Recreates bindings that can be recreated based on applicable rules.
 Discards any other bindings. You can view the bindings that will be discarded before
proceeding.
 Interface links are processed.

934 EIO0000001309 06/2017

 Managing Global Templates

The table describes the effects on the different template components when you replace the
template of an element.

Current In the new template Effect

template
component
Bindings to the Element selection of composite The software maintains the bindings.
element references is the same as in
selection of current template.
composite
Element selection of composite The software removes the bindings to the element selection of
references references is not the same as in the composites that are not part of the new template.
current template.
Bindings and Bindings and attributes of the The software maintains the bindings and attributes.
attributes of the element parameters are the same
element as in current template.
parameters
Bindings and attributes of the The software removes the bindings and attributes of the
element parameters are not the element parameters that are not part of the new template.
same as in current template.
Bindings to Bindings to element interfaces are The software maintains the bindings.
element the same as in current template.
interfaces
Bindings to element interfaces are The software removes the bindings to the element interfaces
not the same as in current that are not part of the new template.
template.

EIO0000001309 06/2017 935

Managing Global Templates

Replacing The Template Used by an Element of a Global Template

Modifying Schneider Electric Global Templates or templates created by users may affect the
function of these templates and must be performed by qualified personnel.

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.
1
 Apply local accident prevention and safety regulations and guidelines .
 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.
To replace the template that is used by an element of a Global Template, proceed as follows.

Step Action
1 In the tree view of the Global Templates Explorer, right-click the template that references the
element whose template you want to replace and select Edit.
For example, if you want to replace the template that is used by element $AINPUT_UC, which is
referenced by $AnalogInput_UC, right-click $AnalogInput_UC.
Result: Process Expert opens the template in the corresponding editor and displays the element.
NOTE: To determine which template references the element whose template you want to
replace, right-click the element and select the Inspect → Used by command (see page 864).
2 Click the Browser pane. In the search field, enter the name of the template that you want the
element to use instead.

936 EIO0000001309 06/2017

 Managing Global Templates

Step Action
3 Drag the template from the Browser pane 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).
Result: Process Expert opens the Replace dialog box.
4 Verify the information that is displayed and click Yes.
Result: If any binding cannot be recreated, Process Expert opens the Replace Conflicts dialog
box.
NOTE: Click No to close the dialog box without replacing the template used by the element.
5 Verify and write down the information that is displayed in the Replace Conflicts dialog box.
NOTE: Click No to close the dialog box without replacing the template used by the element.
6 Click Yes.
Result: Process Expert replaces the template that is used by the element, discards the
previously listed bindings, and recreates the other bindings.
NOTE: Click No to close the dialog box without replacing the template used by the element.
7 Recreate bindings as needed.
8 Save changes (see page 899).
9 Update templates referencing the modified elements as needed.

NOTE: Undoing the template replacement by replacing it again with the original template does not
restore bindings that the software was not able to recreate in the first place.

EIO0000001309 06/2017 937

Managing Global Templates

938 EIO0000001309 06/2017

 Process Expert
Process Expert Services
EIO0000001114 05/2017

Part V
Process Expert Services

Process Expert Services

Overview
This part describes the services that are provided by Process Expert to support the engineering of
systems.

What Is in This Part?

This part contains the following chapters:
Chapter Chapter Name Page
27 Process Expert Content Repository 941
28 Language Settings 947

EIO0000001309 06/2017 939

Process Expert Services

940 EIO0000001309 06/2017

 Process Expert
Process Expert Content Repository
EIO0000001114 05/2017

Chapter 27
Process Expert Content Repository

Process Expert Content Repository

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Content Repository Explorer 942
Temporary Contents Repository Files 946

EIO0000001309 06/2017 941

Process Expert Content Repository

Content Repository Explorer

Overview
The content repository is the place where Process Expert stores:
 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.
 User files that are related to the systems that the software manages (for example, logical
Participant projects or user files attached to a Supervision project). These files are created
during the different stages of the system engineering life cycle.
You cannot add or remove files directly from the content repository. User files that the software
creates, such as Participant project files, are removed from the content repository by the software
when they are not required anymore (for example, when you delete a Participant project).
Each Process Expert server possesses one content repository in which the generic and system-
related files are stored.
The Content Repository explorer is the tool, which allows you to view contents in the form of a
folder structure and to work with the files that are stored in the content repository.

Accessing the Content Repository Explorer

To access the Content Repository explorer click the Content Repository icon in the toolbar
(see page 123).

942 EIO0000001309 06/2017

 Process Expert Content Repository

Content Repository Explorer Window

The following figure shows a view of the Content Repository explorer window.

EIO0000001309 06/2017 943

Process Expert Content Repository

Content Description
The following data is stored in the content repository under two parent folders:
 Global Root\Global Templates: Contains the contents that is shared by several libraries or
systems:
 Global Constituents: Global Control and Supervision Participant constituents (variables,
DFBs, include projects, and so on)
 User files shared by several systems
 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

 Systems: Contains data of the systems that you have created and for each system, the
complete set of files defining the various existing project components and 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, the built Participant projects under the folder with the name of
the executable.
 Topology: The entities modeling the topology (configurations and profiles). For entities that
you configure by using the Control Participant, the corresponding project files.
 Upro: For each entity, the deployed Participant project. If you do online refinement, the file is
updated, reflecting the changes you have made.
 User Contents

Content Repository File Actions

Starting out from one of the previously mentioned parent folders:
1. Drill down to the lowest level of a node until you reach the Contents List tab.
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.

When You Process Expert...

Select...
View opens the file by using the program that is associated to it if the program is installed on the
PC.
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 allows you to save a copy of the file by selecting a location and
a file name.

944 EIO0000001309 06/2017

 Process Expert Content Repository

NOTE: To be able to open a Unity Pro Participant project file (.stu) in a standalone installation of
Unity Pro, the version of the Unity Pro PlantStruxure DTM Library that is installed in Unity Pro
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.

EIO0000001309 06/2017 945

Process Expert 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 Process Expert creates the temporary storage folders
when you start the system server.

Temporary File Folder Location

The folder is named Process Expert x.y (where x.y represents the version that is installed). It is
located on the PC 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.y folder
when Process Expert is not running.

946 EIO0000001309 06/2017

 Process Expert
Language Settings
EIO0000001114 05/2017

Chapter 28
Language Settings

Language Settings

What Is in This Chapter?

This chapter contains the following topics:
Topic Page
Default Keyboard Layout of the Virtual Machine 948
Virtual Machine System Locale 951

EIO0000001309 06/2017 947

Language Settings

Default Keyboard Layout of the Virtual Machine

Overview
Process Expert is designed in such way that software Participants capture the keyboard layout of
the PC on which the engineering client is running.
For this mechanism to work, the keyboard layout used by the PC 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 PC 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
Process Expert 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 Process Expert,
Installation and Configuration Guide).

Switching Keyboard Layouts on the Fly

When you change the keyboard layout of your PC while working, you can also apply the change
to Participants. Refer to the section providing general information in the corresponding Participant
Services User Guide.

Preloaded Keyboard Layouts

You can view the list of keyboard layouts that are preloaded in the operating system of the VM by
opening the [Link] file located at the following path:
For the system server
c:\Program Files\Schneider Electric\StruxureWare\Process Expert\System Server\Configuratio
n.
For a 64-bit operating system, the path is:
c:\Program Files (x86)\Schneider Electric\StruxureWare\Process Expert\System Server\Confi
guration.
For the engineering client
c:\Program Files\Schneider Electric\StruxureWare\Process Expert\Engineering Client.
For a 64-bit operating system, the path is:
c:\Program Files (x86)\Schneider Electric\StruxureWare\Process Expert\Engineering Client.

948 EIO0000001309 06/2017

 Language Settings

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.

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 Process Expert component, which hosts the VM that the
engineering client is using. Refer to the topic describing the configuration of the virtual machine
(see 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 Process Expert 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 PC running the engineering client, given that this layout is
already loaded in the operating system of the VM (see page 948).

EIO0000001309 06/2017 949

Language Settings

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 Using a text editing software, open the [Link] file (see page 948) of the appropriate
Process Expert component.
2 Add, at least, the parameters defining the keyboard layout (see page 948).
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 Process Expert component.

950 EIO0000001309 06/2017

 Language Settings

Virtual Machine System Locale

Overview
Process Expert 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
Process Expert 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 Process Expert,
Installation and Configuration Guide).
For information on the system locale setting of the Microsoft® Windows® operating system, refer
to Language for non-Unicode programs by clicking, starting from the Windows start button:
Control Panel → Region and Language → 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 [Link] file located at the following path:
For the system server
c:\Program Files\Schneider Electric\StruxureWare\Process Expert\System Server\Configuratio
n.
For a 64-bit operating system, the path is:
c:\Program Files (x86)\Schneider Electric\StruxureWare\Process Expert\System Server\Confi
guration.
For the engineering client
c:\Program Files\Schneider Electric\StruxureWare\Process Expert\Engineering Client.
For a 64-bit operating system, the path is:
c:\Program Files (x86)\Schneider Electric\StruxureWare\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.

EIO0000001309 06/2017 951

Language Settings

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).

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 Process Expert component, which hosts the VM that the
engineering client is using. Refer to the topic describing the configuration of the virtual machine
(see 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 Process Expert component, whose configuration wizard you have updated.
Result: The change is applied.

Adding a System Locale

After you add a system locale to the operating system of the VM, you can select it in the VM
Configurator dialog box 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.

952 EIO0000001309 06/2017

 Language Settings

To add a system locale to the operating system of the VM, proceed as follows:

Step Action
1 Using a text editing software, open the [Link] file (see page 948) of the appropriate
Process Expert component.
2 Add, at least, the parameters defining the system locale (see page 951).
3 Save the changes.
4 Restart the Process Expert component.

EIO0000001309 06/2017 953

Language Settings

954 EIO0000001309 06/2017

 Process Expert
Glossary
EIO0000001114 05/2017

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 to share 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 using application
interfaces. The Links Editor allows you to create and edit such links.
application template
Global Template contained in the General Purpose library that models process, device,
communication, or diagnostic objects and their associated functions. The template encapsulates
the necessary Participant capabilities. You can customize the services provided by the template
depending on your requirements.
Application templates are instantiated 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 template definition:
 parameters
 interfaces
 elements

EIO0000001309 06/2017 955

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.
collaborative engineering system
The collaborative engineering system is the environment that allows you to manage the topology,
the projects, and the application describing the system that you are implementing.
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 link
Links describing logical connections between topological instances that are made 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.
communications interface
Mechanism that allows to share data and manage dependencies between 2 instances/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).
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 959) or local
(see page 961).

956 EIO0000001309 06/2017

 Glossary

constituent encapsulation
Process carried out 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.
control system
A control system is a computerized system designed for automation purposes.
controller
A controller is used to control industrial processes and automation 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
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.

EIO0000001309 06/2017 957

Glossary

engine
An engine is the projection of the hardware and software defined in the topology that is able to
execute the deployed Participant project.
engineering client
Process Expert client connecting to the system server that you use to create and maintain
systems. The client runs on the system server and/or engineering station.
engineering station
The engineering station is a computer running a 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 Control or Supervision 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.

958 EIO0000001309 06/2017

 Glossary

G
gateway
A gateway is a network device that transfers communication data from one type of network to
another, or to a fieldbus.
For example, a gateway allows communication between a Modbus serial device and a controller
through its Ethernet port.
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.
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 1 or more functions that can be customized and reused in any
system created with Process Expert. They are stored in the Global Templates library.
Global Templates library
The Global Templates library is the repository for Global Templates such as:
 interface models
 facet templates
 composite templates

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.

EIO0000001309 06/2017 959

Glossary

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.
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 using
expressions.
interface link
Links describing logical connections between instances that are made using interfaces.
The following types of links exist:
 physical links
 communication links
 application links

Each type of link is made 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 define.

960 EIO0000001309 06/2017

 Glossary

L
library
The library is an organizational structure of the platform to store, distribute, organize, and transport
templates.
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.

M
mapping interface
Mechanism that allows to share 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.

EIO0000001309 06/2017 961

Glossary

operation client
A 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
parameters
Parameters describe data that is provided by the templates and that you enter to customize:
 entities
 instances
 instance elements
 folders
 project components such as executables or Supervision servers
Participant online help
The online help that is supplied with a software Participant.
Participant services
Participant services are the functions provided by a software Participant when interacting with
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.
physical (interface) link
Links describing logical connections between topological instances that are made 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 Process Expert
outside the software Participants.
privilege
Defines groups of functions that are provided by an application, and granted to users through
access control.

962 EIO0000001309 06/2017

 Glossary

Process Expert
Name used in the technical documentation to refer to the StruxureWare PE software platform.
Process Expert online help
Online help dedicated to Process Expert, its software Participants, and the Global Templates
library.
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.
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 services
Runtime services describe the complete set of functions that are provided by Process Expert and
Supervision software during operation, such as process monitoring, navigation, diagnostics.

EIO0000001309 06/2017 963

Glossary

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 Process Expert and the embedded Participants.
software Participant
An external tool executed within the operating system of the virtual machine that collaborates with
the platform. For example, the Control Participant.
station node
A station node represents a PC that can act as an engine to execute a Control project, using
software emulating a simulator, or a Supervision project, using Supervision software.
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 is defined through its:
 topology
 application
 projects

system engineering life cycle

The system engineering life cycle represents the stages to design and implement a system in
Process Expert.

964 EIO0000001309 06/2017

 Glossary

system server
Process Expert system server that hosts:
 the virtual machine and the operating system running the software Participants
 the database
 libraries

The system server manages requests from the Process Expert clients.

T
template
Abbreviation for object template.
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 Process Expert system server hosts a virtual
machine (VM) that uses the Windows 7 operating system to run the software Participants.

EIO0000001309 06/2017 965

Glossary

966 EIO0000001309 06/2017

 Process Expert
Index
EIO0000001114 05/2017

Index

Symbols ers, 443

Generate command for projects, 442
$EGenericDeviceHW template
import command, 252
generic device mapping interfaces, 605
import command (control), 305
$GenericDevice
import command (supervision), 355
implementing communication, 782
import command (topology), 567
$GenericNOC_UL
instance delete command, 207
implementing communication, 782
paste command, 237
$GenericPBSlave template
Purge command, 917
generic device mapping interfaces, 605
ReGenerate command for projects, 453
$GenNOCDevice
restore command, 181
implementing communication, 782
template export command, 904
$PRMMgt templates
template import command, 914
managing Modbus TCP communication
Update Control Project command, 776
(I/O scanning), 786
About Process Expert
$System
viewing information on the software, 123
$System parameters of instances, 222
actions
on assigned facets, 386
on generated facets, 460
A activity
aborting log files, 97
abort task icon, 94 notification panel, 94
back up command, 179 addresses
build command (control), 627 generating network addresses for super-
build command (supervision), 639 vision components, 638
Deploy Built Project command (supervi- identifying engines, 646
sion station node), 708 Advantys
Deploy Built Project command (supervi- selecting templates, 503
sion), 702 alarm server redundancy
export command, 244 implementing, 337
export command (control), 287 analyze issues
export command (supervision), 343 build diagnostic icon, 625
export command (topology), 559 troubleshooting control Participant proj-
folder delete command, 198 ects, 469
Generate and Build command for proj- analyzing
ects, 404 control projects during generation, 406
Generate command for project contain- application
import rules for control project-related ob-
jects, 290
import rules for supervision project-relat-

EIO0000001309 06/2017 967

Index

ed objects, 348 assigning

modeling the application of systems, 185 facets, 358
Application Browser pane facets (control), 365
presentation, 194 facets (supervision), 367
using and customizing, 194 Assignment Editor
Application Explorer navigating from instance, 392
accessing, 188 presentation, 359
presentation, 188 assignment stage
application folders concept, 65
actions, 198 implementing, 357
changing folder structure, 238 Assignment Viewer
changing the application structure, 235 View Assignments window, 389
copying and pasting, 236 assignments
creating, 198 automatic facet assignment, 372
managing, 232 navigating from instance to Assignment
moving, 238 Editor, 392
properties, 200 navigating from instance to containers,
application hierarchy 394
viewing in control projects, 277 viewing by instance, 389
application passwords authentication
changing the application password of of Process Expert clients, 82
control projects, 660 automatic
clearing the application password of con- automatic facet assignment, 372
trol projects, 661 automation system
managing passwords of control projects, description, 37, 52
655
resetting a forgotten password, 661
setting the application password of control B
projects, 658 back up command
application structure aborting, 179
tree view description in Containers pane, backing up
376 backing up systems, 178
tree view when refining Control projects, backing up data
469 backing up controller data, 748
tree view when refining Control projects backup
online, 742 password information and settings in sys-
application templates tem backups, 178
categories of, 43 backup files
description, 43 managing data backup files (control), 308
assigned facets batch
generating automatically assigned facets, modeling the equipment hierarchy, 187
403 browsers
managing assigned facets, 385 Templates Browser presentation, 192
unassigning generated facets, 462 build capability
analyzing control projects during genera-

968 EIO0000001309 06/2017

 Index

tion, 406 capabilities

build command capabilities of Process Expert, 99
aborting (control), 627 hardware, 100
aborting (supervision), 639 programming, 100
build diagnostic icon changes
description, 625 actions changing the build status (con-
refining control Participant projects, 469 trol), 630
build stage deploying changes in hardware map-
concept, 74 pings, 691
control projects, 622 deploying changes to engines (control),
implementing, 621 686
supervision project, 637 managing hardware mappings after de-
build states ploying, 609
building the logical supervision project, saving changes in Manage Network Vari-
640 ables dialog box, 489
changes affecting the build status (con- changes log
trol), 628 accessing, 893
verifying before deploying (control), 665 composite templates, 886
when deploying (supervision), 701 facet templates, 882
when deploying from station node (super- interfaces, 877
vision), 705 saving changes in Global Templates, 899
build status circular links
actions changing the build status (con- generating, 407
trol), 630 [Link] files
building deploying, 699
creating the built Control Participant proj- deploying to engines from executable,
ect, 623 701
network addresses of supervision compo- deploying to engines from station node,
nents, 638 704
building control projects clients
Generate and Build command, 625 connection to the server, 86
project settings, 625 creating (supervision), 329
building supervision projects engineering client UI description, 122
Generate and Build command, 639 locking engineering clients, 83
built Participant projects logging in and out, 82
changing (control), 630 notification panel, 94
changing (supervision), 642 quitting, 89
restarting after closing unexpectedly, 88
supervision client properties, 330
C working with several clients, 91
cancelling clusters
cancelling generation for version conflict actions, 326
(control), 407 creating, 326
properties, 326

EIO0000001309 06/2017 969

Index

collapsing communication channels

nodes in the Application Browser pane, actions, 583
195 adjusting properties, 590
nodes in the instance pane, 216 creating, 589
commands moving, 592
common folder commands, 153 properties, 584
communicating properties server side, 587
with devices through Ethernet explicit unmapping, 591
messaging, 791 communication mapping
with devices through Ethernet IP explicit Communication Mapping Editor , 580
messaging, 797 prerequisites (control), 579
with devices through Modbus explicit with Modbus serial devices, 616
messaging, 802 with Modbus TCP devices, 616
communication communication module
changing Ethernet IP device properties, removing from the configuration, 510
537 communication networks
changing Modbus TCP device properties, connecting a station node to the Ethernet,
537 548
changing STB islands properties, 523 connecting an STB island to the Ethernet,
communicating with the computer for de- 550
ployment (control), 653 creating, 541
Ethernet IP explicit messaging, 797 disconnecting a station node from the
implementing I/O scanning, 781 Ethernet, 548
implementing I/O scanning with devices, disconnecting an STB island from the
782 Ethernet, 550
implementing I/O scanning with PRMs, communication ports
786 creating (supervision), 333
implementing I/O scanning with STB is- creating additional ports (supervision),
lands, 785 334
implementing peer to peer communica- properties (supervision), 334
tion, 789 communication templates
managing, 779 reference documents, 856
mapping (control), 579 components
Modbus explicit messaging, 801 creating supervision project components,
Modbus TCP explicit messaging, 791 316
task workflow, 162 Composite Editor
Variable Mapping Editor window, 594 changes log, 893
communication boards menus and toolbars, 888
creating (supervision), 333 panes, 893
OFSOPC driver configuration, 333 parameter pane, 893
properties (supervision), 333 presentation, 883
composite templates
changes log, 886, 893
description, 39
update strategy, 920

970 EIO0000001309 06/2017

 Index

configuration content repository

changing Ethernet IP device properties, actions, 944
537 content description, 944
changing Modbus TCP device properties, deleting temporary files, 946
537 displaying, 123
changing STB islands properties, 523 explorer, 942
changing the controller configuration, 510 Content Repository Explorer
changing the PRM configuration, 530 accessing, 942
IP address validation by subnet mask, control modules
504 description, 39
configuration file template update strategy, 920
OFS configuration file description, 638 control project sections
configuration stage actions, 280, 280
concept, 70 control projects
implementing, 497 actions, 273
configuring build stage, 622
configuring HART modules, 538 changing built Participant projects, 630
instance parameters, 219 communication mapping import rules ,
connection 294
client-server connection, 86 consistency management, 472
redundant configuration connection sce- contents, 273
narios, 761 creating, 271
connections creating sections, 276
physical connection import rules, 563 creating the built Participant project, 623
consistency checks data backup file import rules , 300
after import, 288 deleting, 275
before updating control projects, 773 deploying, 644
fixing inconsistencies, 475 deploying changes to engines, 686
performing (control), 475 description of tree view mode, 376
rules, 473 executable import rules , 294
consistency management executing, 712
generating inconsistent facets, 449 export settings, 286
refining control projects, 472 exporting, 284
consumer facet import rules , 292
about network variables, 476 generating after changes, 446
managing network variables, 487 generation specifics, 406
owner and consumer projects, 476, 487 hardware mapping import rules , 294
consumer project import settings, 289
description, 476 importing, 288
content importing a Unity Pro project, 306
resolving contents conflicts on import, 913 managing, 282
managing passwords of control projects,
655
mapping stage, 572
peer to peer communication export set-

EIO0000001309 06/2017 971

Index

tings, 287 trol projects, 661

peer to peer communication variable im- communicating with the computer, 653
port rules , 298 configuring, 509
pre-requisites, 271 configuring the I/O scanner, 510
project definition, 270 connecting to Ethernet networks, 546
project import window, 300 creating, 504
properties, 274 creating the system topology, 498
refining, 466 deleting, 513
regenerating, 452 deploying built projects, 665
related project data import rules , 290 deploying changes (control), 686
root folder actions, 272 deploying data, 679
section import rules , 292 deploying to redundant controllers, 662
selecting type version changes, 413 disabling the I/O scanner, 510
service mapping import rules , 294 disconnecting from Ethernet networks,
starting the simulator with your control 547
project, 650 execution with redundant controllers, 717
starting the simulator without password exporting, 557
protection, 650 import rules, 562
task quick reference, 167 importing, 560
task workflow, 162 managing data backup files, 308
tree view mode when refining, 469 managing network variables, 487
tree view mode when refining online, 742 mapping (control), 577
updating projects after deploying changes memory size configuration, 507
online, 741 properties, 507
ControlExecutables redeploying built control projects, 672
actions, 574 representation, 511
assigning execution domains, 576 selecting templates, 503
creating, 573 setting the application password of control
description, 573 projects, 658
properties, 575 starting and stopping, 720
controller stop supported platforms, 100
when deploying changes, 697 copying
controllers copy-paste application folders, 237
about network variables, 476 copy-paste instances, 237
actions, 505 data elements from software Participants,
assigning IP addresses, 509 141
backing up controller data, 748 Global Templates and folders, 903
changing the application password of counting
control projects, 660 counting instances, 209
changing the configuration, 509 CRA modules
clearing the application password of con- connection with device I/Os, 781
creating
folders at import, 249
Global Template editors, 868
instances at import, 247

972 EIO0000001309 06/2017

 Index

ctz files deleting

changing (supervision), 642 control projects, 275
creating (supervision), 637 controllers, 513
deploying, 699 deleting FBD sections during update Con-
deploying to engines from executable, trol project, 774
701 instances or folders at import, 248
deploying to engines from station node, PRMs, 531
704 sections, 280
redeploying to engines from executable, STB islands, 525
703 Deploy Built Project command
redeploying to engines from station node, aborting (supervision station node), 708
710 aborting (supervision), 702
deployed control projects
editing online, 741
D deploying
data controller data to engines, 679
backing up controller data, 748 deploying changes to engines (control),
deploying controller data to engines, 679 686
instance validity status, 217 main redundant configuration scenarios,
managing data backup files (control), 308 758
using filters, 143 preparing for deployment, 700
data backup to engines (control), 665
with redundant controllers, 748 to engines from executable (supervision),
data backup files 701
import rules for data backup files (control), to engines from station node (supervi-
300 sion), 704
managing data backup files (control), 308 to redundant controllers, 662, 665
data deployment deploying changes
to redundant controllers, 679 changes requiring to stop the controller,
data types 697
conversion to Participant types, 104 hardware mappings, 691
Process Expert data types, 104 main redundant configuration scenarios,
validating instance parameters, 220 758
DDDT selecting IP addresses, 687
creating during build, 624 to redundant controllers, 687
for peer to peer communication, 624 to redundant controllers (control), 663
naming convention, 624 deploying control projects
naming convention for P2P communica- supported engines, 646
tion, 624 deployment
DDTs communicating with the computer (con-
device DDTs in the configuration, 504 trol), 653
delete command process flowchart, 645
aborting folder delete, 198
aborting instance delete, 207

EIO0000001309 06/2017 973

Index

deployment stage diagnostic messages

concept, 76 during generation, 458
control projects, 644 DIO scanner
implementing, 643 implementing communication by I/O
supervision project, 699 scanning, 781
device DDT docking menus
creating during build, 624 dividing the workspace, 132
for peer to peer communication, 624 downloading
naming convention, 624 controller data to engines, 679
naming convention for P2P communica- deploying changes to engines (control),
tion, 624 686
device templates deploying to engines (control), 665
reference documents, 856 main redundant configuration scenarios,
[Link] file 758
creating, 637 redeploying to engines (control), 672
deploying, 699 to redundant controllers, 662
downloading, 641 dragging
saving, 613 moving the workspace around, 130
devices DTM
actions for Ethernet IP devices, 534 naming convention, 624
actions for Modbus TCP devices, 534 naming convention for P2P communica-
assigning IP addresses to topological I/O tion, 624
device entities, 535, 535
changing IP addresses in explicit mes-
saging, 796, 800 E
communicating through Ethernet explicit editing
messaging, 791 deployed control projects online, 741
communicating through Ethernet IP ex- editing composite templates
plicit messaging, 797 changes log, 886
communication through Modbus explicit editing facet templates
messaging, 802 changes log, 882
connecting to Ethernet networks, 549 editing instances
connectivity with supervision, 845 changing element selection after assign-
creating Ethernet IP devices, 532 ment, 371
creating Modbus TCP devices, 532 editing interfaces
disconnecting from Ethernet networks, changes log, 877
549 editing online (control)
managing Modbus TCP communication changes requiring to stop the controller,
(I/O scanning), 782 697
mapping I/Os (control), 605 overview, 734
properties of Ethernet IP device entities,
535
properties of Modbus TCP device entities,
535
selecting topological templates, 503

974 EIO0000001309 06/2017

 Index

editors Ethernet
Assignment Editor, 359 conflicting Ethernet connections, 544
Composite Editor, 883 connecting controllers to Ethernet net-
Facet Editor, 879 works, 546
Interface Editor, 870 connecting entities to an Ethernet net-
Links Editor, 224 work, 543
opening Global Template editors, 868 disconnecting controllers from Ethernet
elements networks, 547
definition, 39 managing Ethernet IP explicit messaging,
replacing templates of elements, 929 797
End User License Agreement managing Modbus TCP explicit messag-
viewing the End User License Agreement, ing, 791
127 viewing Ethernet connections, 543
engineering clients Ethernet IP devices
engineering client UI description, 122 changing properties, 537
engines creating and configuring devices, 532
backing up controller data, 748 Ethernet IP explicit messaging
deploying built control projects, 665 communicating with devices, 797
deploying data (control), 679 managing communication, 797
deploying to redundant controllers, 662 Ethernet IP I/O devices
execution with redundant controllers, 717 import rules, 562
managing data backup files (control), 308 Ethernet networks
mapping (control), 577 actions, 541
redeploying built control projects, 672 connecting devices, 549
refreshing engine status and connecting, connecting PRMs, 551
653 connecting station nodes, 548
supported engines for deployment (con- connecting STB islands, 550
trol), 646 creating, 541
entities disconnecting devices, 549
creating and configuring topological enti- disconnecting PRMs, 552
ties, 497 disconnecting station nodes, 548
moving topological entities, 554 disconnecting STB islands, 550
entity identifiers exporting, 557
naming rules, 107 importing, 560
equipment properties, 542
equipment hierarchy, 187 selecting templates, 503
equipment generation Ethernet RIO drops
troubleshooting, 458 connecting to Ethernet networks, 546
equipment hierarchy disconnecting from Ethernet networks,
generating (supervision), 455 547
import rules for equipment hierarchy (su- EULA
pervision), 350 viewing the End User License Agreement,
errors 127
detected errors during generation, 407, examples
407 using the Variable Mapping Editor, 599

EIO0000001309 06/2017 975

Index

executable files execution domains

changing (control), 630 assigning to executables (control), 576
creating (control), 623 assigning to executables (supervision),
creating (supervision), 637 614
deploying (supervision), 699 execution order
modifying (supervision), 642 after first generation, 409
executables when regenerating, 453
actions (control), 574 execution stage
actions (supervision), 613 concept, 78
assigning execution domains (control), control projects, 712
576 implementing, 711
assigning execution domains (supervi- supervision projects, 778
sion), 614 expanding
backing up controller data, 748 nodes in the Application Browser pane,
creating (control), 573 195
creating (supervision), 612 nodes in the instance pane, 216
deploying changes to engines (control), explorers
686 Application Explorer, 188
deploying controller data to engines (con- Content Repository explorer, 942
trol), 679 Global Templates Explorer, 858
deploying to engines (control), 665 Project Explorer, 271
deploying to engines (supervision), 701 Project Explorer (supervision), 312
deploying to engines from station node Systems Explorer, 174
(supervision), 704 task workflow, 162
deploying to redundant controllers, 662 Topology Explorer, 499
description (control), 573 export command
description (supervision), 612 aborting, 244
executable import rules (control), 294 aborting (control), 287
executable import rules (supervision), 352 aborting (supervision), 343
executing with redundant controllers, 717 aborting (topology), 559
managing data backup files (control), 308 aborting template export, 904
properties (control), 575 export file
properties (supervision), 614 contents for instance, 246
redeploying to engines (control), 672 creating, 242
redeploying to engines (supervision), 703, modifying, 245
710 using the invariant culture, 245
executing export settings
deployed participant projects (control), control projects, 286
720 peer to peer communication export set-
to redundant controllers, 717 tings, 287
execution supervision projects, 342
facet execution order, 395 exporting
FBD section execution order, 283 exporting control projects, 284
process flowchart, 714 instances, 242
synchronizing redundant controllers, 729 password related information for topologi-

976 EIO0000001309 06/2017

 Index

cal entities, 557 403

peer to peer communication data, 284 import rules for control project facets, 292
supervision projects, 340 managing assigned facets, 385
templates, 904 moving, 387
topological entities, 557 moving generated facets, 463
exporting control projects navigating to Assignment Editor, 392
software version compatibility, 284 navigating to project containers, 394
exporting supervision projects navigating to the instance, 396
software version compatibility, 340 reassigning, 462
relinking, 463
unassign, 387
F unassigning generated facets, 462
Facet Editor unlinking generated facets, 462
changes log, 893 viewing assignments per instance, 389
menus and toolbars, 888 FAST
panes, 893 control project task folder, 273
parameter pane, 893 FBD
presentation, 879 using FBD language with Process Expert,
facet templates 100
changes log, 882, 893 FBD sections
description, 39 actions, 280
update strategy, 920 changing execution order, 283
facets creating during generation, 409
actions after assigning, 386 deleting, 280
actions after generation, 460 import rules for FBD sections, 292
assigned facet description, 369 properties, 281
assigning, 358 when regenerating, 453
assigning (control), 365 files
assigning (supervision), 367 adding external files to supervision proj-
automatic facet assignment, 372 ects, 495
changing order inside section, 395 filters
element selection changes of assigned filtering data, 143
facets, 371 Templates Browser, 191
generating automatically assigned facets, to display instance parameters, 216
floating windows
floating Participant windows, 140
folder structure
changing the layout, 154
moving folders and maintain hierarchy,
154
folders
changing the application structure, 235
changing the structure, 154
common commands, 153
copying and pasting application folders,

EIO0000001309 06/2017 977

Index

236 generating
copying and pasting library folders, 903 analyzing control projects, 406
creating Global Template folders, 863 automatically assigned facets, 403
moving application folders, 238 configuring settings (control), 411
moving topological folders, 554 control project specifics, 406
naming rules, 107 detecting errors during generation, 407
representation, 150 diagnostic messages, 458
resolving import conflicts, 255 entire projects, 442
S88 representation, 156 equipment hierarchy (supervision), 455
searching application instances and fold- facet order, 395
ers, 189 FBD section size, 409
structure description, 150 first-time generation, 441
function blocks function block layout during first genera-
layout after first generation, 409 tion, 409
layout when generating after changes, function description, 447
450 general description, 401
layout when regenerating, 453 Generate and Build command, 404
functional view generating invalid facets again, 450
viewing the application hiearchy in control invalid facets, 404
projects, 277 part of a project, 443
projects after changes, 445
rules for generating graphical links, 407
G satisfying naming rules, 403
gateways section order, 283
using for Modbus explicit messaging, 802 statuses of facets, 438
Generate and Build generating:
Generate and Build command, 404 importing sections after generation, 445
Generate and Build command generation
aborting, 404 cancelling generation for version conflict
Building control projects the first time, 625 (control), 407
Building supervision projects the first changing type versions during generation
time, 639 (control), 413
Generate command function block layout after changes, 450
aborting generation of project containers, managing generated facets, 460
443 skipping facets during generation, 405
aborting generation of projects, 442 generation name issues
generated facets troubleshooting, 458
unlinking, 462 generation stage
implementing, 399
concept, 67
generating inconsistent facets, 449
GenerationSettings
configuring generation XML file (control),
411

978 EIO0000001309 06/2017

 Index

generic devices Go To Instance command

communicating through Ethernet explicit navigating to the instance, 396
messaging, 791 graphical links
communicating through Ethernet IP ex- generation rule, 407
plicit messaging, 797
communication through Modbus explicit
messaging, 802 H
creating Ethernet IP devices, 532 HAL DFBs
creating Modbus TCP devices, 532 managing, 633
managing Modbus TCP communication HAL variables
(I/O scanning), 782 managing, 633
mapping interfaces, 605 HAL variables and DFBs
generic I/O devices properties, 634
connectivity with supervision, 845 viewing, 636
genies hardware
editing supervision pages, 493 configuration stage, 497
Global Template editors creating the system topology, 498
opening, 868 mapping, 605
Global Templates supported components, 498
actions, 864 hardware abstraction layer variables
classification, 39 managing, 633
copying and pasting, 903 hardware mapping
description, 39, 864 managing changes after deploying, 609
Global Templates Explorer, 858 managing HAL variables, 633
managing, 898 Hardware Mapping Editor
purging the Global Templates library, 916 presentation, 606
renaming, 899 HART
replacing templates of elements, 929 HART communication, 538
saving changes, 899 HART module
updating, 923 representation, 539
global templates definition HART modules
concept, 55 configuring HART modules, 538
Global Templates definition help
Global Templates library, 854 help button, 123
Global Templates Explorer of the software Participants, 112
accessing, 858 online help for user-created templates,
displaying, 123 116
folder actions, 863 using the online help for several versions
presentation, 858 of templates, 113
Toolbox, 860 hierarchical naming, 221
Global Templates library home button
naming convention, 856 description, 126
reference documents, 856 hot standby
structure, 855 managing data backup files, 308

EIO0000001309 06/2017 979

Index

hot standby controllers 782

backing up controller data, 748 managing communication with PRMs,
connecting to Ethernet networks, 544 786
deploying built control projects, 665 managing communication with STB is-
deploying changes to redundant control- lands, 785
lers, 687 managing peer to peer communication,
deploying controller data, 679 789
deploying to redundant controllers, 662, I/O server redundancy
665 implementing, 336
disconnecting from Ethernet networks, icons
547 assigning icons to folders, 156
execution, 717 identifiers
identifying, 504 changing the identifier of Global Tem-
main deployment and execution scenari- plates, 899
os, 758 naming rules, 107
physical connection import rules, 563 identifying engines
redeploying to redundant controllers, 672 using physical addresses, 646
reservation and connection scenarios, IL
761 using IL language with Process Expert,
100
import
I accessing the import window, 564
I/O devices import command
communication mapping import rules , aborting, 252
294 aborting (control), 305
creating I/O devices, 331 aborting (supervision), 355
properties (supervision), 331 aborting (topology), 567
I/O scanner aborting template import, 914
configuring for controllers, 510 import rules
disabling, 510 executable import rules (control), 294
I/O scanner lines executable import rules (supervision), 352
memory allocation, 626 for control project facets, 292
I/O scanning for control project-related objects, 290
connecting devices to Ethernet networks, for data backup files (control), 300
549 for equipment hierarchy (supervision),
connecting PRMs to Ethernet networks, 350
551 for Include projects, 347
creating and configuring Modbus TCP de- for mapped peer to peer communication
vice, 532 variables, 298
disconnecting devices from Ethernet net- for pages of supervision projects, 350
works, 549 for program sections (control), 292
disconnecting PRMs from Ethernet net- for supervision project facets, 350
works, 552 for supervision project-related objects,
implementing communication, 781
managing communication with devices,

980 EIO0000001309 06/2017

 Index

348 Instance Editor

for topological entities, 562 accessing, 212
for topological folders, 562 presentation, 213
mapping import rules (control), 294 instance export file
mapping import rules (supervision), 352 contents, 246
physical connection import rules, 563 instance properties
import settings naming rules, 107
control projects, 289 instances
supervision projects, 345 accessing the Instance Editor, 212
Unity Pro projects, 306 actions, 207
importing application import window, 250
application import settings, 255 changing the application structure, 235
checking consistency after importing con- configuration parameters, 222
trol projects, 288 configuring parameters, 219
control projects, 288 copying and pasting, 236
external file, 250 counting for licensing, 209
instances, 250 creating, 204
password related information for topologi- creating, updating, deleting at import, 245
cal entities, 563 data status, 217
resolving contents conflicts for templates, element selection changes of assigned
913 facets, 371
sections during online refinement, 754 exceeding count of a license, 211
supervision projects, 345 exporting, 242
templates, 908 hierarchical naming, 221
topological entities, 560 import rules for control project-related ob-
Unity Pro projects, 306 jects, 290
importing control projects import rules for supervision project-relat-
software version compatibility, 288 ed objects, 348
importing instances importing, 250
resolving conflicts, 255 Inspect Instance window, 233
importing supervision projects linking, 230
software version compatibility, 345 Links Editor, 224
Include projects managing, 232
adding to a supervision project, 494 moving, 238
downloading, 641 navigating from facets to the instance,
importing, 347 396
modifying (supervision), 642 of templates, 49
saving (supervision), 613 order when creating, 204
inconsistent facets resolving import conflicts, 255
generating, 449 searching application instances and fold-
layout of blocks after generation, 450 ers, 189
infrastructure validating parameters, 220
creating the system topology, 498 viewing facet assignments, 389
supported components, 498 instantiating
templates, 186

EIO0000001309 06/2017 981

Index

instantiation lers, 743

order when creating instances, 204 physical connections to Ethernet net-
structure of the application, 187 works, 543
instantiation stage refreshing engine status and connecting,
concept, 56 653
implementing, 185 IP address validation
Interface Editor validation by subnet mask, 504
pane description, 872
presentation, 870
interface models K
types, 48 keyboard
interfaces selecting VM default layout, 948
changes log, 877 keyboard shortcuts
generic device mapping interfaces, 605 using, 147
mapping hardware interfaces, 605
update strategy, 920
invalid L
instance data validity status, 217 languages
link validity status, 227 VM default keyboard layout, 948
invalid facets VM system locale, 951
generating, 404 layout of function blocks
generating invalid facets again, 450 after first generation, 409
invariant culture when generating after changes, 450
modifying the application export file, 245 when regenerating, 453
IO servers LD
communication ports, 328 using LD language with Process Expert,
properties, 328 100
IP address licensing
assigning to controllers, 509 counting instances, 209
assigning to Ethernet IP devices, 535 exceeding license instance count, 211
assigning to Modbus TCP devices, 535 linking
assigning to PRMs, 530 instances, 224
assigning to station nodes, 518 links
assigning to STB islands, 522 rules for generating graphical links, 407
changing Ethernet IP device properties, status, 227
537 Links Editor
changing for explicit messaging with de- presentation, 225
vices, 796, 800 LL984
changing Modbus TCP device properties, updating logical control projects, 769
537 using LL984 language with Process Ex-
changing STB islands properties, 523 pert, 100
deploying changes to redundant control- local PCs
lers, 687 pasting data to Participants, 141
online changes with redundant control- locked facets
skipping facets during generation, 405

982 EIO0000001309 06/2017

 Index

locking ical templates, 555

engineering clients, 83 hardware, 605
locking button, 123 I/O devices (supervision), 616
locking mechanisms mapping import rules (control), 294
multiuser functionalities, 91 mapping import rules (supervision), 352
log files network variable mapping rules, 600
activity log files, 97 network variables, 594
logging in selecting variable mapping positions, 598
to Process Expert clients, 82 servers (supervision), 615
logging out services (control), 577
of Process Expert clients, 82 services (supervision), 615
logical control projects to engines (control), 577
updating with online changes, 766 Variable Mapping Editor window (control),
loops 594
generating circular links, 407 mapping stage
concept, 72
control projects, 572
M implementing, 571
M340 supervision projects, 611
creating a control project, 272 MAST
creating controllers, 504 control project task folder, 273
creating PRM Profibus DPs, 527 memory allocation
Manage Network Variables when creating I/O scanner lines, 626
saving changes in Manage Network Vari- menus
ables dialog box, 489 common template editor menus, 888
managers using menus, 138
platform tools, 54 Modbus serial devices
managing communication mapping, 616
control projects, 282 Modbus explicit messaging
supervision projects, 339 communicating with devices, 802
mapping managing communication, 801
changing service mappings (control), 577 Modbus serial
clients (supervision), 615 managing communication, 801
communication (control), 579 Modbus serial devices
communication (supervision), 616 connectivity with supervision, 845
deleting mapping when updating topolog- Modbus TCP devices
changing properties, 537
communication mapping, 616
connectivity with supervision, 845
creating and configuring devices, 532
Modbus TCP explicit messaging
communicating with devices, 791
managing communication, 791

EIO0000001309 06/2017 983

Index

Modbus TCP I/O devices naming rules

exporting, 557 for identifiers and variable names, 107
import rules, 562 for Supervision data, 107
importing, 560 navigating
Modbus TCP implicit messaging inside the Application Browser pane, 195
implementing communication, 781 inside the instance pane, 216
implementing communication with devic- navigating from facets to the instance,
es, 782 396
implementing communication with PRMs, navigation services
786 using after restoring systems, 182
implementing communication with STB is- network addresses
lands, 785 generating network addresses for super-
implementing peer to peer communica- vision components, 638
tion, 789 network interface cards
modifying actions, 518
export file, 245 creating, 517
monitoring properties, 518
Modbus device data from supervision, network redundancy
845 implementing, 338
monitors network variables
floating Participant windows, 140 address allocation during build, 626
using dual monitors, 132 creating, 490
moving description, 476
application folders, 238 management function rules, 487
facets, 387 managing network variables, 487
generated facets, 463 mapping, 594
instances, 238 mapping rules, 600
moving folders and maintain hierarchy, modifying, 491
154 properties, 487
moving sections (control), 283 selecting variable mapping positions, 598
topological entities, 554 Variable Mapping Editor window, 594
topological folders, 554 networks
multiple selection conflicting Ethernet connections, 544
selecting multiple items, 130 connecting a station node to the Ethernet,
multiuser 548
working with several clients, 91 connecting an STB island to the Ethernet,
550
connecting controllers to Ethernet net-
N works, 546
naming convention connecting devices to Ethernet networks,
Global Templates library, 856 549
naming instances connecting entities to an Ethernet net-
hierarchical naming, 221 work, 543
connecting PRMs to Ethernet networks,

984 EIO0000001309 06/2017

 Index

551 OFS
creating an Ethernet network, 541 actions for station nodes, 519
disconnecting a station node from the configuration file description, 638
Ethernet, 548 creating in station node, 514
disconnecting an STB island from the creating the configuration file, 616
Ethernet, 550 properties for station nodes, 519
disconnecting controllers from Ethernet OFS configuration file
networks, 547 creating, 637
disconnecting devices from Ethernet net- deploying, 699
works, 549 saving, 613
disconnecting PRMs from Ethernet net- OFS configuration files
works, 552 downloading, 641
import rules, 562 OFSOPC
physical connection import rules, 563 tag container properties, 320
viewing Ethernet connections, 543 OFSOPC driver configuration
NIC communication board properties, 333
actions, 518 online changes
assigning IP addresses, 518 changing the deployed control project,
creating, 517 741
properties, 518 main redundant configuration scenarios,
NOC 758
configuring HART modules, 538 overview, 734
configuring memory for I/O scanning, 510 selecting IP addresses, 743
Not Built updating control projects after deploying
actions changing the build status (con- changes online, 741
trol), 630 updating logical control projects, 766
notification panel online help
abort task icon, 94 online help for user-created templates,
description, 94 116
displaying, 123 using the help for several versions of tem-
performance considerations, 96 plates, 113
online refinement
importing sections, 754
O OPC Factory Server
object models OFS configuration file description, 638
application templates, 43 operation clients
interface models, 48 using navigations services after restoring
topological templates, 47 systems, 182
object templates order
classification, 39 changing facet order inside section, 395
description, 39 changing FBD section order, 283
elements, 39 Out Of Date
references, 39 actions changing the build status (con-
types, 42 trol), 630

EIO0000001309 06/2017 985

Index

Out Of Date facets (supervision), 704

layout of blocks after generation, 450 deploying to redundant controllers, 662
owner executing with redundant controllers, 717
about network variables, 476 managing data backup files (control), 308
managing network variables, 487 redeploying to engines (control), 672
owner and consumer projects, 476, 487 redeploying to engines from executable
owner project (supervision), 703, 710
description, 476 Participants
accessing the online help, 112
floating Participant windows, 140
P Participant window description, 139
P&ID pasting data to the local PC, 141
instantiation stage, 185 system locale, 951
pages VM default keyboard layout, 948
actions, 325 password protection
assigning genie facets, 493 controller properties, 507
creating supervision pages, 323 station node properties, 517
description, 323 system properties, 177
editing, 493 passwords
properties, 325 actions that require providing the pass-
supervision page import rules, 350 word, 656
panes changing the application password of
common template editor panes, 893 control projects, 660
working with panes, 134 clearing the application password of con-
panning trol projects, 661
moving the workspace around, 130 exporting password related information
parameter pane for topological entities, 557
in template editors, 893 importing password related information
parameters for topological entities, 563
accessing instance properties, 212 managing passwords of control projects,
configuring instance parameters, 219 655
instance configuration, 222 password information and settings in sys-
instance parameter filters, 216 tem backups, 178
naming rules, 107 password information and settings when
regional options for instance parameter, restoring systems, 180
220 resetting a forgotten password, 661
validating instance parameters, 220 setting the application password of control
Participant projects projects, 658
creating, 399 verifying password to perform operations,
deploying controller data to engines (con- 660
trol), 679 paste command
deploying to engines (control), 665 aborting, 237
deploying to engines from executable (su- pasting
pervision), 701 data elements to software Participants,
deploying to engines from station node

986 EIO0000001309 06/2017

 Index

141 PlantStruxure
Global Templates and folders, 903 overview, 26
peer to peer platform components
communication mapping import rules , platform tools, 54
294 platforms
mapping network variables, 594 supported hardware platforms, 100
peer to peer communication export set- ports
tings, 287 creating additional communication ports
peer to peer communication variable im- (supervision), 334
port rules , 298 IO server communication ports, 328
peer to peer channels supervision server communication ports,
moving, 592 328
peer to peer communication positions
about network variables, 476 selecting variable mapping positions, 598
address allocation during build, 626 PRM
client communication channel properties, actions, 528
584 assigning IP addresses, 530
communication mapping (control), 579 changing the configuration, 530
configuring the I/O scanner of controllers, changing the PRM configuration, 530
510 configuring, 530
controller memory size configuration, 507 creating PRM Profibus DPs, 527
creating network variables, 490 creating PRM Profibus Masters, 527
exporting control projects, 284 deleting, 531
implementing, 789 properties, 529
managing network variables, 487 representation, 530
modifying network variables, 491 PRMs
network variable properties, 487 connecting to Ethernet networks, 551
owner and consumer projects, 476 disconnecting from Ethernet networks,
server communication channel proper- 552
ties, 587 import rules, 562
templates, 476, 487 managing Modbus TCP communication
variable properties, 482 (I/O scanning), 786
peer to peer communication channels Process Expert
actions, 583 about Process Expert dialog box, 123
adjusting properties, 590 capabilities, 99
creating, 589 latest information, 22
performance libraries, 32
notification panel, 96 manual terminology, 23
OFSOPC driver configuration, 333 object model overview, 37
PES overview, 30
what is PES, 28 participants, 32
physical connections quitting, 89
physical connection import rules, 563 Process Expert System
pin button what is PES, 28
working with panes, 134

EIO0000001309 06/2017 987

Index

process templates 537

reference documents, 856 changing STB islands properties, 523
PROFIBUS configuring instance parameters, 219
connecting to Ethernet networks, 551 I/O devices (supervision), 331
creating PRM Profibus DPs, 527 IO server properties, 328
creating PRM Profibus Masters, 527 properties of sections, 281
disconnecting from Ethernet networks, supervision client properties, 330
552 supervision server properties, 328
managing Modbus TCP communication systems, 177
(I/O scanning), 786 protocol
PROFIBUS remote master and DPs OFSOPC tag container attribute, 320
exporting, 557 Purge command
importing, 560 aborting template purge, 917
programming languages purging
supported languages, 100 Global Templates library, 916
project definition stage
concept, 62
control projects, 270 Q
implementing, 269 Quantum
supervision projects, 310 creating a control project, 272
Project Explorer creating controllers, 504
presentation, 271 creating PRM Profibus DPs, 527
presentation (supervision), 312 quick reference
project files system engineering life cycle task work-
downloading (supervision), 641 flow, 162
project settings system engineering life cycle tasks, 167
defining (supervision), 494 quitting
setting during build (control), 625 clients, 89
projects Process Expert, 89
generating, 442
generating after changes, 445
types of Participant projects, 63 R
properties R/W Rights of Referenced Variable
accessing instance properties, 212 network variables, 487
adjusting peer to peer communication reassigning
channel properties, 590 facets, 462
application folders, 200 reconnect button
changing Ethernet IP device properties, connecting to engines, 653
537 refreshing engine status, 653
changing Modbus TCP device properties, Recovery
Recovery folder description, 862
redeploying
main redundant configuration scenarios,

988 EIO0000001309 06/2017

 Index

758 regenerating
to engines (control), 672 configurable settings (control), 411
to engines from executable (supervision), control project sections, 454
703, 710 control projects, 452
to redundant controllers, 672 entire control projects, 454
redundancy function block layout after changes, 453
implementing (supervision), 336 function description, 452
redundant controllers removing types, 452
backing up controller data, 748 regenerating:
connecting to Ethernet networks, 544 importing sections after regeneration, 445
deploying changes to (control), 663 regeneration
deploying controller data, 679 FBD section size, 453
identifying, 504 regional options
physical connection import rules, 563 instance parameters, 220
synchronizing, 729 release notes
references locations, 22
definition, 39 viewing platform and library release
missing references in Recovery folder, notes, 127
862 relinking
refine online facets, 463
main redundant configuration scenarios, removing
758 removing generated types, 410
overview, 734 removing types when regenerating, 452
refinement renaming
consistency management (control), 472 Global Templates, 899
refinement stage Replace Template
implementing, 465 command description, 258
concept, 68 replacing
control projects, 466 replacing templates of elements, 929
supervision project, 492 template of instances, 258
refining templates with new type version, 265
advanced supervision project settings, replacing templates
494 validating instance identifier uniqueness,
build diagnostic icon, 469 265
control projects, 467 report server redundancy
editing supervision pages, 493 implementing, 337
supervision projects, 492 reservation
refining online redundant configuration reservation sce-
with redundant controllers, 717 narios, 761
ReGenerate command restarting
aborting regeneration of projects and sec- restarting clients that closed unexpected-
tions, 453 ly, 88
restore
impact on system names in database,

EIO0000001309 06/2017 989

Index

182 sections
password information and settings when actions, 280, 280
restoring systems, 180 changing execution order, 283
restore command creating control project sections, 276
aborting, 181 creating FBD sections, 276
restoring deleting FBD sections during update Con-
deployed Participant project from execut- trol project, 774
able (supervision), 702 displaying non-FBD sections, 273
deployed Participant project from station import rules for program sections, 292
node (supervision), 710 importing during online refinement, 754
restoring systems, 180 moving sections (control), 283
rollback properties, 281
rolling back generation, 407 section description, 277
rules tree view description in Containers pane,
truncation rules for equipment hierarchy, 376
455 tree view when refining Control projects,
run 469
starting controllers and simulators (con- tree view when refining Control projects
trol), 720 online, 742
runtime navigation services security services
using after restoring systems, 182 system properties, 177
selecting
selecting multiple items, 130
S server
S88 connection to clients, 86
assigning icons to folders, 156 starting again, 85
modeling the equipment hierarchy, 187 stopping, 89
saving servers
backing up controller data, 748 creating servers (supervision), 327
changes in Manage Network Variables di- IO server properties, 328
alog box, 489 supervision server communication ports,
Global Templates, 899 328
saving templates supervision server properties, 328
tracking changes in the changes log, 899 service mapping
sbk file changing (control), 577
exporting templates, 904 services
searching generating network addresses, 638
application instances and folders, 189 session overcrowded
template search, 191 troubleshooting, 458
section layout sessions
configurable settings (control), 411 restarting clients that closed unexpected-
section size ly, 88
configurable settings (control), 411 settings
configuring generation settings (control),
411

990 EIO0000001309 06/2017

 Index

settings pane ST
changing application folder icons, 156 using ST language with Process Expert,
Settings pane 100
changing the folder layout, 154 STA
Settings pane button, 126 changing the default project loaded at
SFC startup, 650
using SFC language with Process Expert, starting the simulator without password
100 protection, 650
shortcuts stages
keyboard shortcuts, 147 assignment stage concept, 65
signature mismatch assignment stage implementing, 357
actions that require providing the pass- build stage concept, 74
word, 656 build stage implementing, 621
controller data backup, 752 concept, 51
controller data deployment, 682 configuration stage concept, 70
deployment stage, 686 configuration stage implementing, 497
execution stage, 715 deployment stage concept, 76
simulator deployment stage implementing, 643
backing up controller data, 748 execution stage concept, 78
changing the default project loaded at execution stage implementing, 711
startup, 650 generation stage concept, 67
deploying built control projects, 665 generation stage implementing, 399
deploying changes (control), 686 global templates definition stage concept,
deploying controller data (control), 679 55
managing data backup files (control), 308 instantiation stage concept, 56
mapping hardware, 605 instantiation stage implementing, 185
obtaining the IP address, 651 mapping stage concept, 72
redeploying built control projects, 672 mapping stage implementing, 571
starting, 649 project definition stage concept, 62
starting without loading a password-pro- project definition stage implementing, 269
tected project, 650 refinement stage concept, 68
simulator software refinement stage implementing, 465
deploying to, 649 task quick reference, 167
installing, 649 starting
starting and stopping, 720 controllers and simulators (control), 720
skipping emulated simulator, 649
skipping facets during generation, 405 simulator, 649
software system server, 85
overview, 30 station nodes
software Participants actions, 514
floating Participant windows, 140 backing up controller data, 748
pasting data to the local PC, 141 connecting to Ethernet networks, 548
window description, 139 creating, 514
sorting disconnecting from Ethernet networks,
sorting data, 143

EIO0000001309 06/2017 991

Index

548 subnet mask

exporting, 557 IP address validation, 504
import rules, 562 supervision
importing, 560 connectivity with Modbus devices, 845
mapping to emulated simulators (control), supervision architecture
577 description of tasks, 311
properties, 517 supervision clients
selecting templates, 503 properties, 330
status supervision data
instance data validity status, 217 naming rules, 107
link validity, 227 supervision pages
refreshing engine status, 653 actions, 325
STB island properties, 325
actions, 521 supervision proje cts
assigning IP addresses, 522 equipment hierarchy import rules , 350
properties, 522 supervision project
STB islands building, 637
changing properties, 523 deploying, 699
changing the configuration, 523 refining, 492
configuring, 523 restoring after deploying from executable,
connecting to Ethernet networks, 550 702
creating, 521 restoring after deploying from station
deleting, 525 node, 710
disconnecting from Ethernet networks, supervision projects
550 actions, 314
exporting, 557 changing built Participant projects, 642
importing, 560 communication mapping import rules ,
managing Modbus TCP communication 352
(I/O scanning), 785 contents, 313
mapping (control), 577 creating, 312
mapping hardware, 605, 605 creating client, 329
representation, 524 creating clusters, 326
stop creating components, 316
changes requiring to stop the controller, creating I/O devices, 331
697 creating pages, 323
stopping creating servers, 327
controllers and simulators (control), 720 creating tag containers, 317
system server, 89 executable import rules , 352
structure of the application executing, 778
instantiation stage, 187 export settings, 342
stu files exporting, 340
changing (control), 630 facet import rules , 350
STU files generating after changes, 446
creating (control), 623 hardware mapping import rules , 352
implementing alarm server redundancy,

992 EIO0000001309 06/2017

 Index

337 system names

implementing I/O server redundancy, 336 impact of system restoration, 182
implementing network redundancy, 338 system restore
implementing redundancy, 336 password information and settings, 180
implementing report server redundancy, systems
337 actions, 176
implementing trend server redundancy, backing up, 178
337 creating, 176
import settings, 345 implementing, 159
importing, 345 organizing, 174
managing, 339 properties, 177
mapping stage, 611 restoring, 180
page import rules , 350 Systems Explorer
project definition, 310 displaying, 123
project import window, 352 presentation, 174
properties, 315
related project data import rules , 348
root folder actions, 313 T
service mapping import rules , 352 tabs bar
task quick reference, 167 description, 125
task workflow, 162 tag containers
supervision servers actions, 319
properties, 328 creating, 317
synchronization description, 317
timeout when refining online, 719 properties, 320
synchronizing templates
description, 717 $Motor example, 44
redundant controllers, 729 copying and pasting Global Templates,
timeout, 729 903
when deploying changes (control), 663 creating Global Template folders, 863
system description, 39
description, 37, 52 exporting, 904
system backup Global Template editors, 868
password information and settings, 178 Global Templates actions, 864
system engineering life cycle Global Templates description, 864
concept, 51 Global Templates Explorer, 858
graphical representation, 52 import rules for control project-related ob-
platform components, 54 jects, 290
task quick reference, 167 import rules for supervision project-relat-
task workflow, 162
system folders
actions, 175
creating, 175
system locale
selecting, 951

EIO0000001309 06/2017 993

Index

ed objects, 348 topological entities

importing, 908 import rules, 562
instances of templates, 49 physical connection import rules, 563
instantiating, 186 topological entity identifiers
managing, 898 naming rules, 107
naming convention, 856 topological folders
online help for user-created templates, import rules, 562
116 topological templates
purging the Global Templates library, 916 introduction, 47
reference documents, 856 subtypes, 47
renaming Global Templates, 899 topology
replacing templates of elements, 929 configuration stage, 497
saving changes in Global Templates, 899 creating, 498
selecting, 191 exporting, 557
selecting topological templates, 503 import rules for control project-related ob-
templates Import Editor, 908 jects, 290
terminology, 40 import rules for supervision project-relat-
update strategy, 920 ed objects, 348
updating Global Templates, 923 importing, 560
using the online help for several versions managing, 553
of templates, 113 selecting topological templates, 503
Templates Browser supported components, 498
browsing templates, 191 updating templates, 555
templates of instances Topology Explorer
replacing, 258 presentation, 499
updating, 258 topology folders
templates of the topology actions, 500
updating, 555 creating, 500
temporary files properties, 502
content repository, 946 tracking changes
terminology template changes log, 899
for template components, 40 transferring
used in this manual, 23 deploying to engines from executable (su-
timeout pervision), 701
synchronizing standby controllers, 729 deploying to engines from station node
when synchronizing online changes, 719 (supervision), 704
toolbars redeploying to engines from executable
common template editor toolbars, 888 (supervision), 703, 710
components, 126 synchronizing redundant controllers, 729
description, 123 tree view
engineering client UI description, 122 viewing the application hierarchy in con-
Toolbox trol projects, 277
Global Templates Explorer, 860

994 EIO0000001309 06/2017

 Index

tree view in control projects updating

description, 376 control projects after deploying changes
when refining, 469 online, 741
when refining online, 742 folders at import, 249
trend server redundancy Global Templates, 923
implementing, 337 instances at import, 248
troubleshooting linked application templates, 264
generation diagnostic messages, 458 logical control projects, 766
truncation template of instances, 258
rules for equipment hierarchy, 455 template update strategy, 920
type versions templates with new type version, 265
changing type versions during generation topological templates, 555
(control), 413 updating control projects
replacing templates with new type ver- checking consistency, 773
sion, 265 updating Control projects
updating templates with new type version, deleting FBD sections during update Con-
265 trol project, 774
types updating control projects
removing generated types, 410 with redundant controllers, 717
removing when regenerating, 452 user files
redeploying from executable after remov-
ing user files (supervision), 703, 710
U user interface
unassigned facets engineering client, 121
reassigning, 462 engineering client UI description, 122
unassigning engineering client workspaces, 129
facets, 387 user-created templates
generated facets, 462 online help for user-created templates,
Unity Pro 116
actions for station nodes, 519 users
creating in station node, 514 activity log files, 97
properties for station nodes, 519 logging in and out, 82
Unity Pro projects working with several clients, 91
import settings, 306
importing a Unity Pro project, 306
unlinked facets V
relinking, 463 Variable Mapping Editor
unlinking description, 594
facets, 462 usage example, 599
unmapping variable mappings
unmapping communication channels, 591 peer to peer communication variable im-
Update Control Project command port rules , 298
aborting, 776 variable name conflict
Update Template troubleshooting, 458
command description, 258

EIO0000001309 06/2017 995

Index

variables X
about network variables, 476
xml file
address allocation during build, 626
exporting instances, 242
managing network variables, 487
importing, 250
naming rules, 107
instance export file contents, 246
properties, 482
modifying, 245
when updating Control projects, 770
version conflict
cancelling generation for version conflict
(control), 407
Z
troubleshooting, 458 zooming
versions magnifying and reducing the workspace
changing type versions during generation view, 130
(control), 413
virtual machine
system locale, 951
VM default keyboard layout, 948
VJC
actions for station nodes, 519
creating in station node, 514
properties for station nodes, 519

W
windows
floating Participant windows, 140
Participant window description, 139
pasting data to Participants, 141
viewing on separate monitors, 132
workflow
task workflow to implement communica-
tion, 162
workspaces
changing the zoom level, 130
dividing, 132
moving the workspace around, 130
organizing, 131
selecting items, 130
working with panes, 134
zooming in and out, 130

996 EIO0000001309 06/2017