Modicon Libraries - General Purpose for

AVEVA™ System Platform (OMI)

Supervision Services
User Guide

EIO0000004360.04

04/2022

www.se.com
Legal Information
The Schneider Electric brand and any trademarks of Schneider Electric SE and its
subsidiaries referred to in this guide are the property of Schneider Electric SE or its
subsidiaries. All other brands may be trademarks of their respective owners.
This guide and its content are protected under applicable copyright laws and
furnished for informational use only. No part of this guide may be reproduced or
transmitted in any form or by any means (electronic, mechanical, photocopying,
recording, or otherwise), for any purpose, without the prior written permission of
Schneider Electric.
Schneider Electric does not grant any right or license for commercial use of the guide
or its content, except for a non-exclusive and personal license to consult it on an "as
is" basis. Schneider Electric products and equipment should be installed, operated,
serviced, and maintained only by qualified personnel.
As standards, specifications, and designs change from time to time, information
contained in this guide may be subject to change without notice.
To the extent permitted by applicable law, no responsibility or liability is assumed by
Schneider Electric and its subsidiaries for any errors or omissions in the informational
content of this material or consequences arising out of or resulting from the use of the
information contained herein.
 Supervision Services

Table of Contents
Safety Information ....................................................................................15
Before You Begin ................................................................................15
Start-up and Test ................................................................................16
Operation and Adjustments .................................................................17
About the Book.........................................................................................18
Getting Started ..........................................................................................21
Environment Preparation...........................................................................22
Library Installation...............................................................................22
Content of the Modicon Libraries - General Purpose for AVEVA System
Platform ..................................................................................................25
Modicon Libraries General Purpose Library for ASP Overview ...............25
List of Master Templates......................................................................27
Acronym ............................................................................................29
Example to Create Control Block Instance and Generate the
Corresponding ASP Instance ....................................................................31
Overview............................................................................................31
Supervision Features ...............................................................................35
Access Control .........................................................................................36
Access Control ...................................................................................36
Alarm Functions .......................................................................................38
Alarm Priority......................................................................................38
SA Alarm Severity...............................................................................38
Alarm Shelving ...................................................................................39
Namur NE-107 Status Management .....................................................40
Multilanguage Support ..............................................................................43
Multilanguage Support ........................................................................43
Representation of Supervision Data ...........................................................46
Situational Awareness (SA) .................................................................46
Element Styles ...................................................................................47
Icons..................................................................................................48
Faceplate Tab Icons ............................................................................51
Optional Label Text .............................................................................52
Screen Profile and Layout .........................................................................54
Screen Profile and Layout....................................................................54
Faceplate as a Popup ...............................................................................58
Faceplate as a Popup .........................................................................58
Multi Monitor ............................................................................................60
Multi Monitor.......................................................................................60
Faceplates .................................................................................................63
Optional Faceplate Tabs for Process Objects..............................................64
Local Panel Section ............................................................................64
Interlocks Tab .....................................................................................65
Failures Tab........................................................................................68
Maintenance Tab ................................................................................70
Optional Faceplate Tabs for Smart Device Objects ......................................72
Analog Data Tab .................................................................................72
Discrete Data Tab ...............................................................................73
Common Faceplate Tabs ..........................................................................75

EIO0000004360.04 3
Supervision Services

Alarms Tab .........................................................................................75

Faceplate Customization ..........................................................................77
Implementing the Library .........................................................................82
Implementing the Library...........................................................................83
Implementation Overview ....................................................................83
Creating the Model View......................................................................83
aOPCClientGP Configuration...............................................................84
Template or Instance Configuration (Object Editor) ................................85
Graphic Symbol Integration .................................................................85
Object Configuration Pages (Object Editor)..........................................87
Optional Process Object Configuration Pages.............................................88
Interlocks Page Default Configuration...................................................88
Failures Page Default Configuration .....................................................89
Maintenance Page Default Configuration ..............................................92
Local Panel Page Default Configuration................................................93
Alarms Page Default Configuration.......................................................93
Optional Device Object Configuration Pages ..............................................95
Main Page Default Configuration..........................................................95
Discrete Page Default Configuration.....................................................96
Analog Page Default Configuration.......................................................98
Common Configuration Pages................................................................. 100
Attributes Page ................................................................................. 100
Scripts Page..................................................................................... 101
Object Information Page .................................................................... 101
System and Device Integration Objects .............................................. 102
$aAppEngineGP: Application Engine ....................................................... 103
Supervision Functions ....................................................................... 103
Parameters ...................................................................................... 103
Default State Alarms ......................................................................... 103
Graphic Representation .................................................................... 104
$aAreaGP and $aAreaRootGP: Areas ..................................................... 105
Supervision Functions ....................................................................... 105
Parameters ...................................................................................... 105
Default State Alarms ......................................................................... 106
Graphic Representation .................................................................... 106
$aOPCClientGP: OPC Client................................................................... 107
Supervision Functions ....................................................................... 107
Parameters ...................................................................................... 107
Default State Alarms and Additional Alarm Conditions ......................... 107
Graphic Representation .................................................................... 108
$aRedundantDIObjectGP: Redundant Communication Object
Diagnosis............................................................................................... 109
Supervision Functions ....................................................................... 109
Parameters ...................................................................................... 109
Default State Alarms and Additional Alarm Conditions ......................... 109
Graphic Representation .................................................................... 110
Signal Processing ................................................................................... 111
$AnalogInputCE: Analog Inputs with Configurable Range.......................... 112
Supervision Functions ....................................................................... 112
Control/Supervision Relationship ....................................................... 112

4 EIO0000004360.04
 Supervision Services

Parameters ...................................................................................... 113

Default State Alarms ......................................................................... 113
Graphic Representation .................................................................... 114
Faceplates ....................................................................................... 115
$AnalogOutputCE: Analog Outputs.......................................................... 118
Supervision Functions ....................................................................... 118
Control/Supervision Relationship ....................................................... 118
Parameters ...................................................................................... 119
Default State Alarms ......................................................................... 119
Graphic Representation .................................................................... 119
Faceplates ....................................................................................... 122
$DigitalInputCE: Digital Inputs ................................................................. 124
Supervision Functions ....................................................................... 124
Control/Supervision Relationship ....................................................... 124
Parameters ...................................................................................... 125
Default State Alarms ......................................................................... 125
Graphic Representation .................................................................... 126
Faceplates ....................................................................................... 127
$DigitalOutputCE: Digital Outputs ............................................................ 129
Supervision Functions ....................................................................... 129
Control/Supervision Relationship ....................................................... 129
Parameters ...................................................................................... 130
Default State Alarms ......................................................................... 130
Graphic Representation .................................................................... 130
Faceplates ....................................................................................... 131
$AnalogInMultiCE: Multiple Analog Inputs ................................................ 133
Supervision Functions ....................................................................... 133
Control/Supervision Relationship ....................................................... 133
Parameters ...................................................................................... 134
Default State Alarms ......................................................................... 134
Graphic Representation .................................................................... 135
Faceplates ....................................................................................... 136
$TotalCE: Totalizing Function .................................................................. 138
Supervision Functions ....................................................................... 138
Control/Supervision Relationship ....................................................... 138
Parameters ...................................................................................... 139
Default State Alarms ......................................................................... 140
Graphic Representation .................................................................... 141
Faceplates ....................................................................................... 142
$LoadCellENOD4TCE - Scaime Weighing Module ................................... 144
Supervision Function......................................................................... 144
Control/Supervision Relationship ....................................................... 144
Default State Alarms ......................................................................... 144
Graphic Representation .................................................................... 145
Faceplate ......................................................................................... 145
$LoadCellPMESWTCE - Scaime weighing module ................................... 152
Supervision Function......................................................................... 152
Control/Supervision Relationship ....................................................... 152
Default State Alarms ......................................................................... 152
Graphic Representation .................................................................... 153
Faceplate ......................................................................................... 153

EIO0000004360.04 5
Supervision Services

On/Off Device Control ............................................................................ 159

$HandValveCE: Hand Valves .................................................................. 160
Supervision Functions ....................................................................... 160
Control/Supervision Relationship ....................................................... 160
Parameters ...................................................................................... 160
Default State Alarms ......................................................................... 161
Graphic Representation .................................................................... 161
Faceplates ....................................................................................... 162
$MotorCE: On/Off Motor ......................................................................... 164
Supervision Functions ....................................................................... 164
Control/Supervision Relationship ....................................................... 164
Parameters ...................................................................................... 165
Default State Alarms ......................................................................... 166
Graphic Representation .................................................................... 166
Faceplates ....................................................................................... 168
$Motor2DirCE: 2-Speed/2-Rotation-Direction Motors ................................ 171
Supervision Functions ....................................................................... 171
Control/Supervision Relationship ....................................................... 171
Parameters ...................................................................................... 172
Default State Alarms ......................................................................... 173
Graphic Representation .................................................................... 173
Faceplates ....................................................................................... 174
$MValveCE: Discrete Motorized Valves.................................................... 177
Supervision Functions ....................................................................... 177
Control/Supervision Relationship ....................................................... 177
Parameters ...................................................................................... 178
Default State Alarms ......................................................................... 179
Graphic Representation .................................................................... 179
Faceplates ....................................................................................... 181
$DualOPValveCE: Dual Output Valves ..................................................... 183
Supervision Functions ....................................................................... 183
Control/Supervision Relationship ....................................................... 183
Parameters ...................................................................................... 184
Default State Alarms ......................................................................... 185
Graphic Representation .................................................................... 185
Faceplates ....................................................................................... 187
$ValveCE: On/Off Valves ........................................................................ 190
Supervision Functions ....................................................................... 190
Control/Supervision Relationship ....................................................... 190
Parameters ...................................................................................... 191
Default State Alarms ......................................................................... 191
Graphic Representation .................................................................... 191
Faceplates ....................................................................................... 193
Analog Device Control ........................................................................... 196
$ControlValveCE: Control Valves............................................................. 197
Supervision Functions ....................................................................... 197
Control/Supervision Relationship ....................................................... 197
Parameters ...................................................................................... 198
Default State Alarms ......................................................................... 198
Graphic Representation .................................................................... 199
Faceplates ....................................................................................... 201

6 EIO0000004360.04
 Supervision Services

$MValvewithPosCE: Motorized Valve With Feedback................................ 204

Supervision Functions ....................................................................... 204
Control/Supervision Relationship ....................................................... 204
Parameters ...................................................................................... 205
Default State Alarms ......................................................................... 206
Graphic Representation .................................................................... 206
Faceplates ....................................................................................... 207
$MotorVSCE: Devices with Variable Speed Drive...................................... 210
Supervision Functions ....................................................................... 210
Control/Supervision Relationship ....................................................... 210
Parameters ...................................................................................... 211
Default State Alarms ......................................................................... 212
Graphic Representation .................................................................... 212
Faceplates ....................................................................................... 215
Process Control ....................................................................................... 218
$IMCTLCE: Internal Model Controllers ..................................................... 219
Supervision Functions ....................................................................... 219
Control/Supervision Relationship ....................................................... 219
Parameters ...................................................................................... 220
Default State Alarms ......................................................................... 221
Graphic Representation .................................................................... 221
Faceplates ....................................................................................... 223
$LeadLagCE: Lead Lag Controllers ......................................................... 226
Supervision Functions ....................................................................... 226
Control/Supervision Relationship ....................................................... 226
Parameters ...................................................................................... 227
Default State Alarms ......................................................................... 228
Graphic Representation .................................................................... 228
Faceplates ....................................................................................... 228
$PIDCE: PID Controllers ......................................................................... 231
Supervision Functions ....................................................................... 231
Control/Supervision Relationship ....................................................... 231
Parameters ...................................................................................... 232
Default State Alarms ......................................................................... 233
Graphic Representation .................................................................... 233
Faceplates ....................................................................................... 233
$PWMCtlCE: Pulse-Width Modulation Controllers..................................... 235
Supervision Functions ....................................................................... 235
Control/Supervision Relationship ....................................................... 235
Parameters ...................................................................................... 236
Default State Alarms ......................................................................... 236
Graphic Representation .................................................................... 236
Faceplates ....................................................................................... 237
$RampCE: Ramps.................................................................................. 239
Supervision Functions ....................................................................... 239
Control/Supervision Relationship ....................................................... 239
Parameters ...................................................................................... 239
Default State Alarms ......................................................................... 240
Graphic Representation .................................................................... 240
Faceplates ....................................................................................... 241
$RatioCtrlCE: Ratio Controllers ............................................................... 243

EIO0000004360.04 7
Supervision Services

Supervision Functions ....................................................................... 243

Control/Supervision Relationship ....................................................... 243
Parameters ...................................................................................... 244
Default State Alarms ......................................................................... 244
Graphic Representation .................................................................... 244
Faceplates ....................................................................................... 246
$SplitRangeCE: Split Range Controllers................................................... 248
Supervision Functions ....................................................................... 248
Control/Supervision Relationship ....................................................... 248
Parameters ...................................................................................... 249
Default State Alarms ......................................................................... 250
Graphic Representation .................................................................... 250
Faceplates ....................................................................................... 250
$Step3CtlCE: Three-Step Controllers/Positioners ..................................... 252
Supervision Functions ....................................................................... 252
Control/Supervision Relationship ....................................................... 252
Parameters ...................................................................................... 253
Default State Alarms ......................................................................... 254
Graphic Representation .................................................................... 254
Faceplates ....................................................................................... 255
Sequential Control .................................................................................. 258
$SequenceCE: Sequential Control Functions ........................................... 259
Description ....................................................................................... 259
Control/Supervision Relationship ....................................................... 260
Parameters ...................................................................................... 261
Default State Alarms ......................................................................... 262
Graphic Representation .................................................................... 262
Faceplates ....................................................................................... 263
Sequential Control Object Configuration Pages......................................... 270
Main Page Default Configuration........................................................ 270
Initial Conditions Page Default Configuration....................................... 271
Failure Conditions Page Default Configuration .................................... 272
Parameters Page Default Configuration.............................................. 273
Input Parameters Page Default Configuration ..................................... 274
Output Parameters Page Default Configuration ................................... 275
Batch Phase Manager............................................................................ 277
$PhaseCE: Batch Phase Functions ......................................................... 278
Description ....................................................................................... 278
Control/Supervision Relationship ....................................................... 279
Parameters ...................................................................................... 280
Default State Alarms ......................................................................... 281
Graphic Representation .................................................................... 281
Faceplates ...................................................................................... 282
Batch Phase Object Configuration Pages ................................................. 288
Main Page Default Configuration........................................................ 288
Initial Conditions Page Default Configuration....................................... 289
Failure Conditions Page Default Configuration .................................... 290
Parameters Page Default Configuration.............................................. 291
Input Parameters Page Default Configuration ..................................... 292
Output Parameters Page Default Configuration ................................... 293
Communication Configuration in InBatch Tool ........................................... 295
8 EIO0000004360.04
 Supervision Services

Description ...................................................................................... 295

Equipment Module .................................................................................. 303
$EMPatternCE: Equipment Module Functions .......................................... 304
Description ....................................................................................... 304
Control/Supervision Relationship ....................................................... 305
Parameters ...................................................................................... 306
Default State Alarms ......................................................................... 308
Graphic Representation .................................................................... 308
Faceplates ....................................................................................... 309
Equipment Module Object Configuration Pages ........................................ 316
Main Page Default Configuration........................................................ 316
Initial Conditions Page Default Configuration....................................... 318
Failure Conditions Page Default Configuration .................................... 319
Input Parameters Page Default Configuration ..................................... 320
Output Parameters Page Default Configuration ................................... 321
Input/Output Parameter Configuration for Equipment module ............... 322
Pump Set.................................................................................................. 324
$PumpSetCtrlCE: Pump Set Pattern Functions......................................... 325
Description ....................................................................................... 325
Control/Supervision Relationship ....................................................... 326
Parameters ...................................................................................... 326
Default State Alarms ......................................................................... 327
Graphic Representation .................................................................... 328
Faceplates ....................................................................................... 328
Pump Set Pattern Object Configuration pages .......................................... 329
Default Configuration Pages .............................................................. 329
Flow Control ............................................................................................. 330
$PumpFlowCtrlCE: Flow Control Pattern Functions................................... 331
Description ....................................................................................... 331
Control/Supervision Relationship ....................................................... 332
Parameters ...................................................................................... 332
Default State Alarms ......................................................................... 333
Graphic Representation .................................................................... 334
Faceplates ....................................................................................... 334
Flow Control Pattern Object Configuration pages ...................................... 335
Default Configuration Pages .............................................................. 335
Auxiliary Functions.................................................................................. 336
$AlarmSummaryCE: Alarm Summary ...................................................... 337
Supervision Functions ....................................................................... 337
Control/Supervision Relationship ....................................................... 337
Parameters ...................................................................................... 338
Default State Alarms ......................................................................... 338
Graphic Representation .................................................................... 338
Faceplates ....................................................................................... 339
$IlckCE/$ICCE: Extended Interlocks/Initial Conditions............................... 341
Supervision Functions ....................................................................... 341
Control/Supervision Relationship ....................................................... 341
Parameters ...................................................................................... 341
Default State Alarms ......................................................................... 342
Graphic Representation .................................................................... 342

EIO0000004360.04 9
Supervision Services

Faceplates ....................................................................................... 342

$AnalogSelectCE: Analog Signal Selection .............................................. 344
Supervision Functions ....................................................................... 344
Control/Supervision Relationship ....................................................... 344
Parameters ...................................................................................... 345
Default State Alarms ......................................................................... 345
Graphic Representation .................................................................... 345
Faceplates ....................................................................................... 346
$MessageBoxCE: Operator Messages..................................................... 348
Supervision Functions ....................................................................... 348
Control/Supervision Relationship ....................................................... 348
Parameters ...................................................................................... 349
Default State Alarms ......................................................................... 349
Graphic Representation .................................................................... 349
Faceplates ....................................................................................... 350
$SPBoolCE: Discrete Setpoints ............................................................... 352
Supervision Functions ....................................................................... 352
Parameters ...................................................................................... 352
Default State Alarms ......................................................................... 353
Graphic Representation .................................................................... 353
$SPRealCE: Real Setpoints .................................................................... 354
Supervision Functions ....................................................................... 354
Parameters ...................................................................................... 354
Default State Alarms ......................................................................... 355
Graphic Representation .................................................................... 355
$SPIntCE: Integer Setpoints.................................................................... 356
Supervision Functions ....................................................................... 356
Parameters ...................................................................................... 356
Default State Alarms ......................................................................... 357
Graphic Representation .................................................................... 357
$SPDurationCE: Duration Setpoints......................................................... 358
Supervision Functions ....................................................................... 358
Parameters ...................................................................................... 359
Default State Alarms ......................................................................... 359
Graphic Representation .................................................................... 359
$SchedulerCE: Scheduler function........................................................... 361
Supervision Functions ....................................................................... 361
Control/Supervision Relationship ....................................................... 361
Parameters ...................................................................................... 362
Default State Alarms ......................................................................... 362
Graphic Representation .................................................................... 362
Faceplates ....................................................................................... 363
Smart Device Control ............................................................................. 365
Default State Alarms for Devices ............................................................. 366
Default State Alarms for Devices........................................................ 366
Circuit Breakers...................................................................................... 367
$CompactNSXMBUCE: Compact NSX Circuit Breakers ...................... 367
Supervision Functions ................................................................. 367
Control/Supervision Relationship.................................................. 367
Parameters................................................................................. 368
Default State Alarms and Additional Alarm Conditions.................... 369

10 EIO0000004360.04
 Supervision Services

Graphic Representation............................................................... 370

Faceplates.................................................................................. 370
$MasterpactMTZCMBUCE: Masterpact MTZ Circuit Breakers with
Chassis............................................................................................ 371
Supervision Functions ................................................................. 372
Control/Supervision Relationship.................................................. 372
Parameters................................................................................. 372
Default State Alarms and Additional Alarm Conditions.................... 373
Graphic Representation............................................................... 374
Faceplates.................................................................................. 375
$MasterpactMTZMBUCE: Masterpact MTZ Circuit Breaker without
Chassis............................................................................................ 376
Supervision Functions ................................................................. 376
Control/Supervision Relationship.................................................. 376
Parameters................................................................................. 377
Default State Alarms and Additional Alarm Conditions.................... 377
Graphic Representation............................................................... 378
Faceplates.................................................................................. 379
$MasterpactNxMBUCE: Masterpact Nx Circuit Breaker without
Chassis (x= T/W) .............................................................................. 380
Supervision Functions ................................................................. 380
Control/Supervision Relationship.................................................. 380
Parameters................................................................................. 381
Default State Alarms and Additional Alarm Conditions.................... 381
Graphic Representation............................................................... 382
Faceplates.................................................................................. 383
$MasterpactNxCMBUCE: Masterpact Nx Circuit Breakers with
Chassis (x= T/W) .............................................................................. 383
Supervision Functions ................................................................. 383
Control/Supervision Relationship.................................................. 384
Parameters................................................................................. 384
Default State Alarms and Additional Alarm Conditions.................... 385
Graphic Representation............................................................... 386
Faceplates.................................................................................. 387
$MasterpactHWCE: Hardwired Circuit Breaker ................................... 387
Supervision Functions ................................................................. 387
Control/Supervision Relationship.................................................. 388
Parameters................................................................................. 388
Default State Alarms and Additional Alarm Conditions.................... 389
Graphic Representation............................................................... 389
Faceplates.................................................................................. 390
$CompactHWCE: Hardwired Compact Circuit Breaker ........................ 390
Supervision Functions ................................................................. 391
Control/Supervision Relationship.................................................. 391
Parameters................................................................................. 391
Default State Alarms and Additional Alarm Conditions.................... 392
Graphic Representation............................................................... 393
Faceplates.................................................................................. 393
Digital Protection Relays ......................................................................... 395
$Sepam80ECE and $Sepam80MBCE: Sepam80 Digital Protection
Relays ............................................................................................. 395

EIO0000004360.04 11
Supervision Services

Supervision Functions ................................................................. 395

Control/Supervision Relationship.................................................. 395
Parameters................................................................................. 396
Default State Alarms and Additional Alarm Conditions.................... 397
Graphic Representation............................................................... 397
Faceplates.................................................................................. 398
$EasergyP3EMCE: Digital Protection Relays ...................................... 399
Supervision Functions ................................................................. 399
Control/Supervision Relationship.................................................. 399
Parameters................................................................................. 400
Default State Alarms and Additional Alarm Conditions.................... 401
Graphic Representation............................................................... 401
Faceplates.................................................................................. 402
$EasergyP5EMCE: Digital Protection Relays ...................................... 403
Supervision Functions ................................................................. 403
Control/Supervision Relationship.................................................. 403
Parameters................................................................................. 404
Default State Alarms and Additional Alarm Conditions.................... 405
Graphic Representation............................................................... 405
Faceplates.................................................................................. 406
Motor Controllers and Starters ................................................................. 408
$TesysT: TeSys T Motor Controllers and Starters ................................ 408
Supervision Functions ................................................................. 408
Control/Supervision Relationship.................................................. 409
Parameters................................................................................. 409
Default State Alarms and Additional Alarm Conditions.................... 410
Graphic Representation............................................................... 411
Faceplates.................................................................................. 411
$TesysU: TeSys U Motor Controllers and Starters ............................... 413
Supervision Functions ................................................................. 413
Control/Supervision Relationship.................................................. 413
Parameters................................................................................. 414
Default State Alarms and Additional Alarm Conditions.................... 415
Graphic Representation............................................................... 416
Faceplates.................................................................................. 416
Power Measurement............................................................................... 418
$PM5350MBCE and $PM53xxEMCE : PM5350 and PM53xx Power
Meters ............................................................................................. 418
Supervision Functions ................................................................. 418
Control/Supervision Relationship.................................................. 418
Parameters................................................................................. 419
Default State Alarms and Additional Alarm Conditions.................... 419
Graphic Representation............................................................... 420
Faceplates.................................................................................. 421
$PM82xxEMCE: PM82xx Power Meter............................................... 422
Supervision Functions ................................................................. 422
Control/Supervision Relationship.................................................. 423
Parameters................................................................................. 423
Default State Alarms and Additional Alarm Conditions.................... 424
Graphic Representation............................................................... 424
Faceplates.................................................................................. 425

12 EIO0000004360.04
 Supervision Services

Soft Starters ........................................................................................... 426

$ATS22MBCE: Altistart 22 Soft Starters ............................................. 426
Supervision Functions ................................................................. 426
Control/Supervision Relationship.................................................. 426
Parameters................................................................................. 427
Default State Alarms and Additional Alarm Conditions.................... 428
Graphic Representation............................................................... 428
Faceplates.................................................................................. 429
$ATS48MBCE: Altistart 48 Soft Starters ............................................. 430
Supervision Functions ................................................................. 431
Control/Supervision Relationship.................................................. 431
Parameters................................................................................. 431
Default State Alarms and Additional Alarm Conditions.................... 432
Graphic Representation............................................................... 433
Faceplates.................................................................................. 433
MBTCPATS480 - ATS480 (Modbus TCP/IP) and EIPATS480 -
ATS480 (Ethernet IP): Progressive Starters ........................................ 435
Supervision Functions ................................................................. 435
Control/Supervision Relationship.................................................. 435
Parameters................................................................................. 436
Default State Alarms and Additional Alarm Conditions.................... 437
Graphic Representation............................................................... 437
Faceplates.................................................................................. 438
Speed Drives ......................................................................................... 440
$ATV6xxECE: Altivar 6xx Series Variable Speed Drives....................... 440
Supervision Functions ................................................................. 440
Control/Supervision Relationship.................................................. 440
Parameters................................................................................. 441
Default State Alarms and Additional Alarm Conditions.................... 442
Graphic Representation............................................................... 442
Faceplates.................................................................................. 443
$ATV9xxECE: Altivar 9xx Series Variable Speed Drives....................... 445
Supervision Functions ................................................................. 445
Control/Supervision Relationship.................................................. 445
Parameters................................................................................. 446
Default State Alarms and Additional Alarm Conditions.................... 446
Graphic Representation............................................................... 447
Faceplates.................................................................................. 448
$ATV6xxxECE: Altivar 6xxx Series Variable Speed Drives ................... 449
Supervision Functions ................................................................. 449
Control/Supervision Relationship.................................................. 450
Parameters................................................................................. 450
Default State Alarms and Additional Alarm Conditions.................... 451
Graphic Representation............................................................... 451
Faceplates.................................................................................. 452
$ATV320EMCE: Altivar 320 Series Variable Speed Drives ................... 453
Supervision Functions ................................................................. 454
Control/Supervision Relationship.................................................. 454
Parameters................................................................................. 454
Default State Alarms and Additional Alarm Conditions.................... 455
Graphic Representation............................................................... 456

EIO0000004360.04 13
Supervision Services

Faceplates.................................................................................. 457
$ATV340CE: Altivar 340 Series Variable Speed Drives ........................ 458
Supervision Functions ................................................................. 458
Control/Supervision Relationship.................................................. 459
Parameters................................................................................. 459
Default State Alarms and Additional Alarm Conditions.................... 460
Graphic Representation............................................................... 460
Faceplates.................................................................................. 461
Diagnosis ................................................................................................. 463
Controller Diagnosis ............................................................................... 464
$M340DiagCE and $M580DiagCE: Modicon Controller
Diagnosis ......................................................................................... 464
Supervision Functions ................................................................. 464
Control/Supervision Relationship.................................................. 465
Parameters................................................................................. 466
Default State Alarms and Additional Alarm Conditions.................... 466
Graphic Representation............................................................... 467
Faceplates.................................................................................. 467
Index ......................................................................................................... 471

14 EIO0000004360.04
Safety Information Supervision Services

Safety Information
Important Information
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.

The addition of this symbol to a “Danger” or “Warning” safety label indicates that an
electrical hazard exists which will result in personal injury if the instructions are not
followed.

This is the safety alert symbol. It is used to alert you to potential personal injury
hazards. Obey all safety messages that follow this symbol to avoid possible injury or
death.

! DANGER
DANGER indicates a hazardous situation which, if not avoided, will result in death or serious
injury.

! WARNING
WARNING indicates a hazardous situation which, if not avoided, could result in death or
serious injury.

! CAUTION
CAUTION indicates a hazardous situation which, if not avoided, could result in minor or
moderate injury.

NOTICE
NOTICE is used to address practices not related to physical injury.

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.

Before You Begin

Do not use this product on machinery lacking effective point-of-operation
guarding. Lack of effective point-of-operation guarding on a machine can result in
serious injury to the operator of that machine.

EIO0000004360.04 15
Supervision Services Safety Information

WARNING
UNGUARDED EQUIPMENT
• Do not use this software and related automation equipment on equipment
which does not have point-of-operation protection.
• Do not reach into machinery during operation.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.

This automation equipment and related software is used to control a variety of

industrial processes. The type or model of automation equipment suitable for each
application will vary depending on factors such as the control function required,
degree of protection required, production methods, unusual conditions,
government regulations, etc. In some applications, more than one processor may
be required, as when backup redundancy is needed.
Only you, the user, machine builder or system integrator can be aware of all the
conditions and factors present during setup, operation, and maintenance of the
machine and, therefore, can determine the automation equipment and the related
safeties and interlocks which can be properly used. When selecting automation
and control equipment and related software for a particular application, you should
refer to the applicable local and national standards and regulations. The National
Safety Council's Accident Prevention Manual (nationally recognized in the United
States of America) also provides much useful information.
In some applications, such as packaging machinery, additional operator protection
such as point-of-operation guarding must be provided. This is necessary if the
operator's hands and other parts of the body are free to enter the pinch points or
other hazardous areas and serious injury can occur. Software products alone
cannot protect an operator from injury. For this reason the software cannot be
substituted for or take the place of point-of-operation protection.
Ensure that appropriate safeties and mechanical/electrical interlocks related to
point-of-operation protection have been installed and are operational before
placing the equipment into service. All interlocks and safeties related to point-of-
operation protection must be coordinated with the related automation equipment
and software programming.
NOTE: Coordination of safeties and mechanical/electrical interlocks for point-
of-operation protection is outside the scope of the Function Block Library,
System User Guide, or other implementation referenced in this
documentation.

Start-up and Test

Before using electrical control and automation equipment for regular operation
after installation, the system should be given a start-up test by qualified personnel
to verify correct operation of the equipment. It is important that arrangements for
such a check are made and that enough time is allowed to perform complete and
satisfactory testing.

WARNING
EQUIPMENT OPERATION HAZARD
• Verify that all installation and set up procedures have been completed.
• Before operational tests are performed, remove all blocks or other temporary
holding means used for shipment from all component devices.
• Remove tools, meters, and debris from equipment.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.

16 EIO0000004360.04
Safety Information Supervision Services

Follow all start-up tests recommended in the equipment documentation. Store all
equipment documentation for future references.
Software testing must be done in both simulated and real environments.
Verify that the completed system is free from all short circuits and temporary
grounds that are not installed according to local regulations (according to the
National Electrical Code in the U.S.A, for instance). If high-potential voltage
testing is necessary, follow recommendations in equipment documentation to
prevent accidental equipment damage.
Before energizing equipment:
• Remove tools, meters, and debris from equipment.
• Close the equipment enclosure door.
• Remove all temporary grounds from incoming power lines.
• Perform all start-up tests recommended by the manufacturer.

Operation and Adjustments

The following precautions are from the NEMA Standards Publication ICS 7.1-1995
(English version prevails):
• Regardless of the care exercised in the design and manufacture of equipment
or in the selection and ratings of components, there are hazards that can be
encountered if such equipment is improperly operated.
• It is sometimes possible to misadjust the equipment and thus produce
unsatisfactory or unsafe operation. Always use the manufacturer’s
instructions as a guide for functional adjustments. Personnel who have
access to these adjustments should be familiar with the equipment
manufacturer’s instructions and the machinery used with the electrical
equipment.
• Only those operational adjustments actually required by the operator should
be accessible to the operator. Access to other controls should be restricted to
prevent unauthorized changes in operating characteristics.

EIO0000004360.04 17
Supervision Services About the Book

About the Book

Document Scope
This document describes the master templates of the Modicon Libraries - General
Purpose for AVEVA™ System Platform.
It describes their default configuration, the dynamic objects that are included in
these master templates, and other functional aspects managed from ArchestrA
IDE. This document does not cover any operational aspects, nor does it provide
information on how to use supervision services to monitor and operate control
systems.
This document is written for users with experience in the engineering of control
systems and with a working knowledge of ASP and Control Expert.
NOTE: The terms circuit breaker and motor starter that are used in this
manual refer to specific Schneider Electric devices for which templates are
provided in this library. Refer to the product documentation of these devices
for information on the applicable standards, which define these terms.
NOTE: ASP is abbreviation for AVEVA™ System Platform.

Validity Note
This document is valid for Aveva System Platform 2020 or later.

Related Documents
Title of documentation Reference number
Modicon Libraries General Purpose Process Components User Guide EIO0000002093 (eng)

Modicon Libraries General Purpose Devices Components User Guide EIO0000002092 (eng)

Modicon Libraries General Purpose Diagnostics Components User EIO0000002090 (eng)

Guide
Modicon Libraries General Purpose for Wonderware System Platform EIO0000003013 (eng)
Equipment Module Components User Guide

Product Related Information

The application of this library, which is referred to as the product, requires
expertise in the design and operation of control systems.

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.

Examples described in this manual and the demonstration project are provided for
information only.

18 EIO0000004360.04
About the Book Supervision Services

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.

EIO0000004360.04 19
 Supervision Services

Getting Started
What’s in This Part
Environment Preparation ................................................................................22
Content of the Modicon Libraries - General Purpose for AVEVA System
Platform ........................................................................................................25
Example to Create Control Block Instance and Generate the Corresponding
ASP Instance .................................................................................................31

EIO0000004360.04 21
Supervision Services Environment Preparation

Environment Preparation
What’s in This Chapter
Library Installation .........................................................................................22

Library Installation
Software Compatibility
The Modicon Libraries - General Purpose for AVEVA System Platform has been
tested and validated with Aveva System Platform 2020
The control resources that are mentioned in this manual are from the Modicon
Libraries - General Purpose for AVEVA System Platform.
Use OPC Factory Server 3.40.2808.0, 3.50.2908.0 (SP3), or later, page 25.

Installation Methods
You can install the Modicon Libraries - General Purpose for AVEVA System
Platform in ArchestrA IDE in two different ways:
• Recommended way to use the library with existing Galaxies: By importing the
library installation files, which consist of:
◦ The Galaxy package file.
◦ Script function libraries.
◦ The Galaxy style library.
◦ A text (.txt) file with spanish translation of alarm messages.
• Recommended way to use the library with a new Galaxy: By creating a new
Galaxy from the GPLBlank yymmdd.cab Galaxy backup provided. The
backup contains the necessary resources, page 26, including alarm
messages in English and Spanish.
NOTE: Use this method to install the demonstration project.

Installing the Library by Using Installation Files

The installation files are composed of:
• Three script function libraries:
◦ PSxLocalize.aaSLIB
◦ ww.nasc.btl.modeling.aaSLIB
◦ PSxMessaging.aaSLIB (for attributes used by Control Expert runtime
navigation services)
◦ System.Windows.Forms.aaSLIB
• A Galaxy style library:
◦ GalaxyStyles-yyyymmdd.xml
• Two packages containing the objects:
◦ GPLMasterTemplates.aaPKG
◦ GPLApplicationTemplates.aaPKG (also contains master templates), page
26

22 EIO0000004360.04
Environment Preparation Supervision Services

• A file with spanish translation of alarm messages used in master templates:

◦ Galaxy_GPLDemoProcess yyyymmdd_3082_Alarm_Comments.txt
NOTE: This file is for user reference for spanish translation.
• SQL database related files to manage parameter sets:
◦ ParameterSets.bak, which is a backup file of the blank ParameterSets
database. It contains the tables that are required to manage parameter
sets by using the parameter set management template.
NOTE: To use the backup file, Microsoft SQL Server, page 22 needs
to be installed on the PC. Open Microsoft SQL Server Management
Studio and select Restore Database from the context menu of the
Databases folder. Select Device in the Source section of the Restore
Database dialog box and browse to the backup file.
◦ GPL for WSP PS schema yymmdd.sql, which is an SQL query file that
creates a blank ParameterSets database without needing to restore the
backup file provided in the setup.
◦ PS Schema Migration yyyymmdd.sql, which is an SQL query file for
existing users to migrate their ParameterSets database.
NOTE: To use the SQL query file, Microsoft SQL Server, page 22
needs to be installed on the PC. Open Microsoft SQL Server
Management Studio, select File → Open → File, browse to the
required query and open it, then select Query → Execute.
Proceed as follows to install the library by using the installation files.

Step Action

1 Open ArchestrA IDE.

2 Click Galaxy > Import > Galaxy Style Library.

3 Select the GalaxyStyles-yyyymmdd.xml file from the Installation Files > Galaxy
Styles folder and then click Open.

4 Click Galaxy > Import > Script Function Library.

5 Select the PSxLocalize.aaSLIB file from the Installation Files > Script Function
Libraries folder and then click Open.

6 Click Galaxy > Import > Script Function Library.

7 Select the PSxMessaging.aaSLIB file from the Installation Files > Script Function
Libraries folder and then click Open.

8 Click Galaxy > Import > Script Function Library.

9 Select the ww.nasc.btl.modeling.aaSLIB file from the Installation Files > Script
Function Libraries folder and then click Open.

10 Click Galaxy > Import > Script Function Library.

11 Select the System.Windows.Forms.aaSLIB file from the Installation Files > Script
Function Libraries folder and then click Open.

12 Click Galaxy > Import > Object(s).

13 Select the PSxTab.aaPKG file from the Installation Files > Graphic Objects folder and
then click Open.

14 Click Galaxy > Import > Object(s).

15 Select the LayoutGP.aaPKG file from the Installation Files > Graphic Objects folder
and then click Open.

16 Click Galaxy > Import > Object(s).

17 Select the $ViewAppGP.aaPKG file from the Installation Files > Graphic Objects
folder and then click Open.

18 Click Galaxy > Import > Object(s).

19 Select the GPLMasterTemplates.aaPKG file from the Installation Files > Master
Templates folder and then click Open.

20 Click Galaxy > Import > Object(s).

EIO0000004360.04 23
Supervision Services Environment Preparation

Step Action

21 Select the GPLApplicationTemplates.aaPKG file from the Installation Files >

Application Templates folder and then click Open.

22 Select your import preferences according to your needs and click OK.
NOTE:

To update library objects that already exist in your Galaxy, select the following import
preferences.

Result: The import of the library objects begins.

23 Wait until the import ends.

24 Verify the import log in the Import Automation Object(s) window.

Installing the Library by Using the Galaxy Backup

Proceed as follows to install the library by using the Galaxy backup of the Modicon
Libraries - General Purpose for AVEVA System Platform.

Step Action

1 Copy the Galaxy backup file (.cab) to the BackupGalaxies folder at the path C:\Program
Files(x86)\ArchestrA\Framework\Bin\BackupGalaxies.

2 Open ArchestrA IDE.

3 Click New Galaxy.

4 Select the Galaxy backup file from the Galaxy type list.

5 Enter your Galaxy name in the Galaxy name field.

6 Click Create.

Result: Your Galaxy is created from the Galaxy backup of the Modicon Libraries -
General Purpose for AVEVA System Platform.

24 EIO0000004360.04
Content of the Modicon Libraries - General Purpose for AVEVA
System Platform Supervision Services

Content of the Modicon Libraries - General Purpose

for AVEVA System Platform
What’s in This Chapter
Modicon Libraries General Purpose Library for ASP Overview ..........................25
List of Master Templates ................................................................................27
Acronym .......................................................................................................29

Overview
This chapter describes the contents and features of the Modicon Libraries -
General Purpose for AVEVA System Platform.

Modicon Libraries General Purpose Library for ASP

Overview
Library Scope
The Modicon Libraries - General Purpose for AVEVA System Platform provides a
supervision function for each control function of the Modicon Libraries - General
Purpose for Control Expert.
Modularity is provided by the object-oriented design with ready-to-use templates,
which reduces engineering time.
The Modicon Libraries - General Purpose for AVEVA System Platform includes
templates for the following categories of control modules:
• Process
• Devices
• Diagnosis
• Parameter Set
The library is engineered with ArchestrA IDE, page 22.

Key Features
The Modicon Libraries - General Purpose for AVEVA System Platform delivers the
following features:
• Situational Awareness (SA): The library look and feel has been designed
according to SA principles. You can quickly identify abnormal situations,
which are deviations compared to what is expected and to what is considered
to be the normal operating mode. (For example, level bars and trends allow
you to compare current process values to the configured thresholds, or if the
configuration of a function considers the normal operating mode to be
program, setting it to operator is indicated as an abnormal situation.).
• AVEVA Situational Awareness Library (SAL) look and feel.
• Device diagnosis and status reporting according to Namur NE-107
recommendation.
• Communication between the control and supervision layers by using OPC
Factory Server (OPC UA and OPC DA).
• Auto references to controller variables.
• Various process, device, and diagnostic master templates.

EIO0000004360.04 25
 Content of the Modicon Libraries - General Purpose for
Supervision Services AVEVA System Platform

• Consistent look and feel.

• Static text of symbols and faceplates, as well as alarm descriptions available
in English (default) and Spanish.
• Library style management, which allows you to change the appearance of the
library components by modifying the global configuration.

Architecture
The figure illustrates a typical system architecture.

Resource Description
The Modicon Libraries - General Purpose for AVEVA System Platform contains
the following templates and resources:

Templates: A template is an entity that represents a common functional requirement

of a device, family of devices, or function. It only exists in the development
environment. There are four types of templates:
• Base templates. These are core objects used to create master
templates. (For example, $SPBoolCE.)
• Master templates. Their name starts with the sufixCE. (For example,
$MotorCE). These control module templates are derived from base
templates or other parent templates of the Services category. You
can copy these templates if you want to modify the default
configuration at the template level and then create instances.
NOTE: Some attributes of these master templates may be
locked at the template level and/or parent level.
• Application templates. Each one is directly derived from a master
template for your convenience. Their name starts with the prefix $a
and sufixCE. (For example, $AnalogInputCE). You can modify these
templates and/or create instances from them.

ArchestrA Symbols: ArchestrA symbols are included with master and application templates.
They contain graphic objects and faceplates used to visualize data in
runtime. A graphic object includes multiple configurations in a single
symbol wizard (for example, motor or pump symbols).

26 EIO0000004360.04
Content of the Modicon Libraries - General Purpose for AVEVA
System Platform Supervision Services

List of Master Templates

Overview
The master templates described in this document are grouped by category and
family.
When the library is installed, templates are located at the following path in the
Template Toolbox:
• Master templates: EcoStruxure Plant\Master Templates.
• Application templates: EcoStruxure Plant\Application Templates.
For example, the $MotorCE master template is located at the path EcoStruxure
Plant\Master Templates\GPL\Process\Control Modules\On/Off Device
Control.
For other master templates and base templates, their location in the Template
Toolbox is indicated in the table listing them.
NOTE: For each category, the families are the same as those used to group
the control resources that are referenced in this manual.
NOTE: Templates located in the Services folders in each category are
intermediate derived templates, which are common to several master
templates of a category. You can derive from these templates but Schneider
Electric recommends using only master templates located under the Control
Modules folders in the Template Toolbox.

Process Category
The table lists the master templates which belong to the Process category.

Family Template name Purpose

Signal processing $AnalogInputCE Analog inputs with configurable range, page 112

$AnalogOutputCE Analog outputs, page 118

$DigitalInputCE Digital inputs, page 124

$DigitalOutputCE Digital outputs, page 129

$AnalogInMultiCE Multiple analog inputs with configurable range, page 133

$TotalCE Totalizing function, page 138

On/Off device control $HandValveCE Hand valves, page 160

$MotorCE On/off motors, page 164

$Motor2DirCE 2-speed/2-rotation-direction motors, page 171

$MValveCE Discrete motorized valves, page 177

$DualOPValveCE Dual Output Valve, page 183

$ValveCE On/off valves, page 190

Analog device control $ControlValveCE Control valves, page 197

$MValvewithPosCE Motorized valves with position feedback, page 204

$MotorVSCE Motors with variable speed drive, page 210

Process control $IMCTLCE Internal model controllers, page 219

$LeadLagCE Lead-Lag controllers, page 226

$PIDCE PID controllers, page 231

$PWMCtlCE Pulse-width modulation controllers, page 235

$RampCE Ramps, page 239

EIO0000004360.04 27
 Content of the Modicon Libraries - General Purpose for
Supervision Services AVEVA System Platform

Family Template name Purpose

$RatioCtrlCE Ratio controllers, page 243

$SplitRangeCE Split-range controllers, page 248

$Step3CtlCE Three-step controllers, page 252

Sequential control $SequenceCE Sequential control, page 259

Batch Phase Manager $PhaseCE Batch phase functions, page 278

Equipment module $EMPatternCE Equipment module functions, page 304

Pump Set $PumpSetCtrlCE Pump Set functions, page 324

Flow Control $PumpFlowCtrlCE Flow Control functions, page 330

Auxiliary functions $AlarmSummaryCE Alarm summary, page 337

$AnalogSelectCE Analog signal selection, page 344

$SPBoolCE Discrete setpoints, page 352

$SPRealCE Real setpoints, page 354

$SPIntCE Integer setpoints, page 356

$SPDurationCE Duration setpoints, page 358

$MessageBoxCE Messages to the operator, page 348

$SchedulerCE Scheduler function, page 361

Devices Category
The table lists the master templates which belong to the Devices category.

Family Template name Purpose

Circuit breakers $CompactNSXMBUCE Compact NSX circuit breakers, page 367

$MasterpactMTZCMBUCE Masterpact MTZ Circuit Breakers with Drawout/Chasis, page 371

$MasterpactMTZMBUCE Masterpact MTZ Circuit Breakers without Drawout/Chasis, page 376

$MasterpactNxMBUCE Masterpact Nx Circuit Breakers without Drawout/Chasis, page 380

$MasterpactNxCMBUCE Masterpact Nx Circuit Breakers with Drawout/Chasis, page 383

$MasterpactHWCE Hardwired Circuit Breaker, page 387

$CompactHWCE Hardwired Compact Circuit Breaker, page 390

Digital protection relays $Sepam80ECE Sepam 80 protection relays, page 395

$Sepam80MBCE

$EasergyP3EMCE $EasergyP3EMCE, page 399

$EasergyP3EMCE $EasergyP3EMCE, page 403

Motor controllers and $TesysTAllDataCE TeSys T, page 408 communicating by using either:
starters
• Ethernet Modbus TCP implicit messaging (normal I/O scanning)
• Ethernet Modbus TCP explicit messaging
• Modbus serial

$TesysTEFastCE TeSys T, page 408 communicating by using either:

• Ethernet Modbus TCP implicit messaging (fast I/O scanning)
• CANopen (device connected to an STB island)

$TesysTPBCE TeSys T, page 408 communicating by using Profibus.

$TesysUIOCE TeSys U, page 413 communicating by using either of:

• Modbus serial.
• CANopen.

28 EIO0000004360.04
Content of the Modicon Libraries - General Purpose for AVEVA
System Platform Supervision Services

Family Template name Purpose

$TesysUMainDataCE TeSys U, page 413 communicating by using either of:

• Modbus serial.
• CANopen.

$TesysUMECCE TeSys U, page 413 communicating by using Modbus serial.

Power meters $PM5350MBCE PM5350 power meters, page 418

$PM53xxEMCE PM53xx power meters, page 418

$PM82xxEMCE PM82xx power meters, page 422

Soft starters $ATS22MBCE Altistart 22 soft starters, page 426

$ATS48MBCE Altistart 48 soft starters, page 430

$ATS480MBTCPCE Altistart488 soft starters, page 435

$ATS480EIPCE

Speed drives $ATV6xxECE Altivar 6xx series variable speed drives, page 440

$ATV9xxECE Altivar 9xx series variable speed drives, page 445

$ATV6xxxECE Altivar, page 449 6xxx series variable speed drives

$ATV320EMCE Altivar, page 453 320 series variable speed drives

$ATV340CE Altivar, page 458 340 series variable speed drives

Diagnosis Category
The table lists the master templates which belong to the Diagnosis category.

Template name Purpose

$M340DiagCE Modicon M340 diagnosis, page 464

$M580DiagCE Modicon M580 diagnosis, page 464

Acronym
Acronyms and Definitions
The following table lists the acronyms used in this manual:

Acronym Definition

ASP AVEVA system platform

WSP Wonderware system platform

IDE –

OPC –

OPS –

SQL –

IDE –

PID –

SA Situational Awareness
OP Output command

LOP Local output command

PV Present value

EIO0000004360.04 29
 Content of the Modicon Libraries - General Purpose for
Supervision Services AVEVA System Platform

Acronym Definition

SP Setpoint

LSP Local setpoint

RSP Remote setpoint

NAN –

DIO –

ZSH –

ZSL –

PIDFF –

PWM –

30 EIO0000004360.04
Example to Create Control Block Instance and Generate the
Corresponding ASP Instance Supervision Services

Example to Create Control Block Instance and

Generate the Corresponding ASP Instance
What’s in This Chapter
Overview ......................................................................................................31

Overview
This section describes the steps to create control block instance
and generate the corresponding ASP instance
Note: This library has to be used with the AssetLink tool.

Step Action

1 Example to create a Control Expert DFB instances for MOTORVSGP along with its auxiliary blocks:
• Instantiate the MOTORVSGP DFB with the name having suffix "_MotorVSGP" (example: <InstanceName>_MotorVSGP).
• Create the variables for MotorVSGP_CFG and MotorVSGP_ST inout pins with the names having suffix "_MotorVSGP_CFG"
and "_MotorVSGP_ST" respectively (example: <InstanceName>_MotorVSGP_CFG, <InstanceName>_MotorVSGP_ST).
• Instantiate the auxiliary block CONDSUMGP with the name having suffix "_Condsum" (example: <InstanceName>_Condsum)
and connect Result to Fail of MotorVSGP.
• Create the variable for CondSumGP_ST inout pin with the name having suffix "_Condsum_ST" (example: <InstanceName>_
Condsum_ST).
• Instantiate the auxiliary block ILOCKONGP with the name having suffix "_FWDILCKGP" (example: <InstanceName>_
FWDILCKGP) and connect ILCK to FWDILCK of MotorVSGP.
• Create the variable for ILCKOnGP_ST inout pins with the name having suffix "_FWDILCKGP_ST" (example:
<InstanceName>_FWDILCKGP_ST).
• Instantiate the auxiliary block ILOCKONGP with the name having suffix "_REVILCKGP" (example: <InstanceName>_
REVILCKGP) and connect ILCK to REVILCK of MotorVSGP.
• Create the variable for ILCKOnGP_ST inout pins with the name having suffix "_REVILCKGP_ST" (example:
<InstanceName>_REVILCKGP_ST).
• Instantiate the auxiliary block DEVMNTGP with the name having suffix "_MotMNTGP" (example: <InstanceName>_
MotMNTGP) and connect Position to LForward of MotorVSGP.
• Create the variable for DevMNTGP_ST inout pins with the name having suffix "_MotMNTGP_ST" (example:
<InstanceName>_ MotMNTGP_ST).
• Once the project is build successfully, export the control project .xsy file for instance generation in ASP using the AssetLink
tool.
NOTE:
• Suffix details is provided in the Control/Supervision relationship section of respective template chapters.
• Enter the respective conditions descriptions for Cond01 ... Cond15/Cond01 ... Cond07 in the comment field of the
DFB respective pins. These conditions descriptions will be configured in the ASP instance by the AssetLink.

EIO0000004360.04 31
 Example to Create Control Block Instance and Generate the
Supervision Services Corresponding ASP Instance

Step Action

2 Creating the instance for MotorVS in the AVEVA System Platform:

a Open the AssetLink and go to configuration tab (example: Settings for MCS (Modicon Communication Server) connection or
can also be used for OPC UA/OPC DA).

(For configuration details of AssetLink tool, refer to the user guide (see EcoStruxure™ Control Expert AssetLink, User
Guide)).

In the Galaxy Settings:

• Select Source: Control Expert/UnityPro
• Select Protocol: <OPC UA>
• Select Device Name: <DevExample_1> (refer the below figure of SMC)

• DIO Name: <OFS Client name>

• Scan Group: <Group name in OFS Client>
• OI Address Reference: <MCS_Connection.DeviceGroup./DA/0> (refer the below figure of SMC showing the path of
OI Address Reference)

In the Patterns Settings:

• Patters Path: <Browse for the patterns folder>

... In the Control Project Settings:

• Control Project: <Browse for the Control project .xsy file, exported from the control expert>
The following illustration is an example of Configuration tab:

... b In the Patterns tab, check for the availability of applicable patterns as shown below (here, $MotorVSCE.xml is available):

32 EIO0000004360.04
Example to Create Control Block Instance and Generate the
Corresponding ASP Instance Supervision Services

Step Action

c In the Generation tab:

• Click Browse Control Project
• Check for the instances are populated. Check for the action as Create (refer the below figure).

• Click Generate Objects button at the bottom right of AssetLink tool.

... d New instance is generated and is found in the Unassigned Host. Assign it to the required area.

EIO0000004360.04 33
 Example to Create Control Block Instance and Generate the
Supervision Services Corresponding ASP Instance

Step Action

e Add the L3 symbol of MotorVS on to the graphic page as shown below:

f Deploy the Control Expert and the ASP project. Check for the communication and control.

34 EIO0000004360.04
 Supervision Services

Supervision Features
What’s in This Part
Access Control...............................................................................................36
Alarm Functions .............................................................................................38
Multilanguage Support....................................................................................43
Representation of Supervision Data.................................................................46
Screen Profile and Layout ...............................................................................54
Faceplate as a Popup.....................................................................................58
Multi Monitor ..................................................................................................60

Overview
This part describes the supervision features that apply to the Modicon Libraries -
General Purpose for AVEVA System Platform.

EIO0000004360.04 35
Supervision Services Access Control

Access Control
What’s in This Chapter
Access Control..............................................................................................36

Access Control
Overview
Attributes of master templates of the Modicon Libraries - General Purpose for
AVEVA System Platform use the object security classification of ArchestrA IDE for
access control.
The settings are identical in the corresponding application templates, page 26 and
are propagated to derived templates and instances.
You can modify the configuration of the security classification of attributes in
application templates.
For information on the object security classification, refer to the ArchestrA IDE
help.

Default Object Security Classification of Attributes

This table describes the object security classification that is defined by default for
attributes of master templates

Classification Description

Operate This level is used for regular operation activities (for example, setting of
setpoints, operating modes, alarm setpoints) Manual reset of a specific
abnormal condition is also available for users with operate rights

Secured write This level is used for manual resetting of interlock conditions and global reset of
the control module (for example, motor reset).

Verified write This level is used for bypassing interlock conditions, global bypass of interlocks
and bypass of an abnormal condition

Tune This level is used for engineering parameters (for example, alarm priorities, PID
sensitivity, ramp adjustments).

Configure This level is used for UDAs configuration (for example, range, engineering
units, format, normal operating modes).
NOTE: This level is only used for attribute modification during engineering
time.

36 EIO0000004360.04
Access Control Supervision Services

Configuration of Object Security Classification

To configure the security classification of an attribute of an application template,
click the shield icon next to the attribute in the configuration page and select a
level.

NOTE: If the icon is shown in gray, the access control modification is locked in
its parent object. For more information about attribute locking and unlocking,
refer to the ArchestrA IDE help.

Security Group Configuration

When you create derived templates or instances, they are added to the Default
security group.
For information on assigning them to a different security group, refer to the
ArchestrA IDE help.

EIO0000004360.04 37
Supervision Services Alarm Functions

Alarm Functions
What’s in This Chapter
Alarm Priority ................................................................................................38
SA Alarm Severity .........................................................................................38
Alarm Shelving..............................................................................................39
Namur NE-107 Status Management ...............................................................40

Overview
This chapter describes alarm functions of master templates of the Modicon
Libraries - General Purpose for AVEVA System Platform.

Alarm Priority
Overview
Default alarm priorities are configured in master templates for attributes to which
an alarm is associated. The priorities are identical in the corresponding application
templates, page 26. They are propagated to derived templates and instances that
you create.
The security classification of alarm priorities for state alarms is Tune.
The priority value range is 0...999.
You can modify the configuration in the application templates.
NOTE: The alarm priority value associates an alarm severity, page 38 to the
alarm.

Alarm Priority Configuration

Proceed as follows to configure or modify an alarm priority.

Step Action

1 Double-click the object (application template, derived template, or instance).

2 Select the Attributes page.

3 Click the filter icon and select State alarm from the list of filters.
4 From the results, select an attribute (for example DevCtl.St.Faild).

5 The alarm configuration appears in the State alarm section of the features area.

6 Set the Priority value, page 38.

NOTE: You can also modify the Alarm message and the alarm Category.

7 Check in the object.

SA Alarm Severity
Overview
Four Situational Awareness (SA) alarm severities are configured in the global
configuration of the Galaxy.

38 EIO0000004360.04
Alarm Functions Supervision Services

Each alarm signal is assigned an alarm severity, which is related to its alarm
priority. For example, if an alarm has an alarm priority of 200, it is assigned an
alarm severity of 1 by default.
You can change the priority range that is associated to each alarm severity to
adapt the behavior to the specific requirements of your project.
To access the alarm configuration screen, click Galaxy > Configure > Alarms
and Events Configuration.

Default Alarm Severity Configuration

The table describes the alarm severities and their default properties.

Alarm Alarm Priority range Representation

severity historization

1 Yes 1...250

2 Yes 251...500

3 Yes 501...750

4 Yes 751...999

Alarm Shelving
Alarm Shelving Configuration
When you install the Modicon Libraries - General Purpose for AVEVA System
Platform by using the supplied Galaxy backup, alarm shelving is enabled for
alarms of severity 3 and 4 by default.
You can modify the configuration in the alarm configuration screen if your role has
the required permission.

Shelving Alarms
During operation, shelving or unshelving an alarm by using the Shelve check box
in the alarms tab, page 75 of the faceplate of the instance sets the corresponding
<reference>.AlarmShelve* attributes.
An alarm does not need to be active to be shelved. The shelving period starts
when you shelve the alarm.

EIO0000004360.04 39
Supervision Services Alarm Functions

To shelve an alarm during runtime, your role needs to have the required
operational permission.
For more information, refer to the topic describing how to shelve alarms in the
ArchestrA IDE help.
NOTE: Shelving an alarm is considered as an abnormal situation, page 46.

Representation of Shelved Alarms During Operation

At the faceplate level, the alarms tab allows you to view the shelved status of
alarms by displaying a timer icon, page 48. If the alarm is disabled or silenced
while shelved, the timer icon is hidden but the shelving period count-down
continues.
At the symbol level, the timer icon is displayed to indicate that an alarm is shelved.
However, if for an instance, an alarm is shelved and, at the same time, another
alarm is active, the timer icon is not displayed. This is because active alarms are
displayed over shelved alarms independently of their respective severity and
priority.

Namur NE-107 Status Management

Overview
The Namur NE-107 recommendation defines that detailed device diagnostic
information be summarized as four simple status signals. This allows the operator
to view device statuses in a simple and uniform way regardless of the source
device.
Device master templates of the Modicon Libraries - General Purpose for AVEVA
System Platform are preconfigured to manage Namur statuses.
Namur statuses are mapped to the device diagnostic bits of the Control resource,
page 96 that is monitored by the template. These bits are associated to state
alarms by using scripts so that the detection of a Namur status raises an alarm.
This illustration shows a device with two Namur icons displayed to the right.

Description
The table describes the Namur statuses as defined in the Namur NE-107
recommendation and their default configuration

40 EIO0000004360.04
Alarm Functions Supervision Services

Namur status Description Alarm Associ- Icon

priority ated
alarm
severity

Failure Output signal invalid due to error 500 2

detected in the field device or its
peripherals.

Function check Output signal temporarily invalid (for 750 3

example, frozen) due to ongoing work
on the device.

Out of specification The device is operating outside its 999 4

specified range (for example,
measuring or temperature range).

Internal diagnosis indicates deviations

from measured or set values due to
errors detected in the device or process
characteristics.
Maintenance Although the output signal is valid, the 999 4
required wear reserve is nearly exhausted or a
function will soon be restricted due to
operational conditions (for example,
aging of a pH-electrode).

Namur Status Mapping

The mapping of Namur statuses is accessible in the Discrete 1 to Discrete n tabs of the device object. In this
example, Namur statuses are mapped to bits 3, 7, and 10 of the ATV_CFG.DataStatus word, which is monitored
by the template.

NOTE: Bit descriptions and Namur statuses are locked attributes.

EIO0000004360.04 41
Supervision Services Alarm Functions

Namur Alarm Priority Configuration

You can modify the alarm priority of the associated state alarm in the application
template or its instance by configuring the corresponding attribute (for example,
AO.Namur.OutOfSpecs).
For information on modifying state alarm priorities, refer to the topic describing
alarm priority configuration, page 38.

42 EIO0000004360.04
Multilanguage Support Supervision Services

Multilanguage Support
What’s in This Chapter
Multilanguage Support...................................................................................43

Multilanguage Support
Overview
The engineering environment is in English.
The operation environment supports the following languages:
• English
• Spanish
The default and native language is English.
You have the possibility to add other languages to your application.
Click Galaxy > Configure > Languages to access to the Configure Languages
window:

You can add or remove language or change the default language.

For information on how to use other languages, refer to the ArchestrA IDE online
help.

Alarm Description Localization

The alarm description can be localized with the export/import function of alarm
messages.
Proceed as follows to localize alarm messages:

Step Action

1 Click Galaxy > Export > Localization > All Alarm Messages.
Result: The Export Alarm Messages window opens.

2 Select the language to export and click Export.

Result: A text file is generated with all alarm messages.

3 Insert the translation of the alarm messages in this text file. (A file with spanish
translation of alarm messages used in master templates are available in the installation
files, page 22).

4 Click Galaxy > Import > Localization > Alarm Message(s).

EIO0000004360.04 43
Supervision Services Multilanguage Support

Step Action

Result: The Import Alarm Messages window opens.

5 Select the language and the text file to import and click Import.

Result: The localizations of alarm messages are imported in the galaxy.

6 The text file has to be imported in the InTouch window maker also. Click Special >
Language > Import Alarm Fields.

Result: The localizations of alarm messages are imported in the InTouch window maker.

UDA Values Localization

The UDA values (for example interlock and detected failure condition descriptions)
can be entered with a multilingual format.
This illustration presents an example of multilingual format:

Use the following syntax to enter the value:

<text in default language>;[Language ID]<localized text>;[Language ID]<localized
text>...
This table presents the language ID:

Language Language ID

English 1033

Spanish 3082

French 1036
German 1031
Chinese 2052

In this example the interlock description is localized in Spanish and French:

Valve HV1102 Closed;[3082]Válvula HV1102 Cerrada;[1036]Vanne HV1102
fermée
NOTE: If you operate with a non-listed language, the text in default language
is used.

ArchestrA Symbol Localization

The static text of the library symbols can be localized with the export/import
function of symbol localizations.
Proceed as follows to localize the static text of the library symbols:

Step Action

1 Select the graphic toolset to export in the Graphic Toolbox.

2 Click Galaxy > Export > Localization > Selected Symbol(s).

Result: The Export Locale Data window opens.

3 Select the language to export and click Export.

Result: An XML file is generated with all symbol texts of the toolset.

44 EIO0000004360.04
Multilanguage Support Supervision Services

Step Action

4 Edit the XML file and insert the text translation between the tags <Translation> and
</Translation> .

5 Click Galaxy > Import > Localization > Symbol(s).

Result: The Import Locale Data window opens.

6 Select the language and the XML file to import and click Import.

Result: The Import Locale Preferences window opens.

7 Select the import preferences and click Import.

Result: The text localizations of the symbols are imported.

EIO0000004360.04 45
Supervision Services Representation of Supervision Data

Representation of Supervision Data

What’s in This Chapter
Situational Awareness (SA)............................................................................46
Element Styles ..............................................................................................47
Icons ............................................................................................................48
Faceplate Tab Icons ......................................................................................51
Optional Label Text........................................................................................52

Overview
Graphic symbols and faceplates use icons, animations, and other graphic
elements to convey information related to control modules, such as values,
setpoints, statuses, or conditions. In particular, styles are used to distinguish
between types of information or to highlight changes or situations that require
action.
This chapter describes the icons used in supervision components and the styles
that are used to represent supervision data. You can modify the definitions of the
listed styles as needed, without having to redesign the ArchestrA symbols.

Situational Awareness (SA)

Overview
The Modicon Libraries - General Purpose for AVEVA System Platform uses SA
principles. These help you identify states that are different from the expected state
and from the normal operating mode that is configured for an object. Such states
are considered abnormal states.
Bars and trends allow you to compare current process values with expected
thresholds.

Symbol Animation
An abnormal state is represented by an exclamation mark on orange background,
which is displayed next to the symbol.

Icon Description

The control module is in an abnormal configuration or operating mode, for

example:
• Simulation mode.
Static
• The current owner mode is different from the normal mode (as configured by
default in the corresponding attribute) or the initial value is different from the
possible values normally used for the attribute. In such case, the current
owner mode is indicated on the symbol (for example, O for operator).
• Bypassed interlocks or abnormal conditions.
• Disabled, silenced, inhibited, or shelved alarm.

The control module is waiting for an operator action (for example, a motor needs to
be reset manually to start again).
NOTE: If at the same time an operator action is requested and an abnormal
Flashing configuration is detected, which are represented by a flashing and a static
icon respectively, the flashing icon prevails.

46 EIO0000004360.04
Representation of Supervision Data Supervision Services

NOTE: The symbol uses the User_Defined_01 element style, page 47.

Faceplate Animation
An abnormal configuration is represented by an exclamation mark on orange
background, which is displayed next to the icon of the faceplate tab.

NOTE: If the tab icon is flashing, an action is required from this tab.
In addition, the item that is in an abnormal configuration or that requires an
operator action is displayed with an orange background. In this example, the
simulation mode is enabled whereas the normal operating mode has simulation
disabled.

Element Styles
Introduction
The Element Styles of the library are configured in the Galaxy Style Library
(click Galaxy > Configure > Galaxy Style Library). You can change the look and
feel of the entire library by modifying the global configuration for the Galaxy.
You can modify for each element style:
• Color and text font.
• Fill color override.
• Line style.
• Outline style.

Description
This table describes the default element styles that are used to represent
supervision data.

Element State Galaxy style Representation

Static legend - Label

Animated legend Normal state Label

Abnormal User_Defined_01
state

EIO0000004360.04 47
Supervision Services Representation of Supervision Data

Element State Galaxy style Representation

Configurable legend - User_Defined_17

Present value - Actual_Value

Setpoint value - Setpoint

Output value - User_Defined_13

Other non-editable value - User_Defined_04

Editable value - User_Defined_05

Button and drop-down list - User_Defined_08

Animated text in tables Value OFF User_Defined_07

Value ON User_Defined_06

Value ON User_Defined_02

Non-animated text in - User_Defined_03

tables
Dynamic value Value OFF Passive

Value ON Active

Transitioning Transitioning

Stopped state Not_Running

Line separator in - User_Defined_11

faceplates

Faceplate and selected tab - User_Defined_09

background

Unselected tab - User_Defined_10

background

Over range (for example, - Over-range

open and closed at same
time or in case of
motorised valve, if valve
positioner feedback
crosses the threshold limit
and is not matching with its
limit switch indication.)

Outputs in trends - Control_line

Bars representing signals - Active_NotAvailable

not confirmed from field

Icons
Description
The table describes the icons that may be displayed during operation.

48 EIO0000004360.04
Representation of Supervision Data Supervision Services

Function Icon Meaning Examples of use Comment

Displaying O Operator Valve in operator The icon is displayed

owner mode (the operator only if it is not the
selection sets the setpoint). normal mode.

P Program Valve in program

mode (the program
sets the setpoint).

C Cascade Closed-loop PID

controller with an
externally set
setpoint

Displaying A Auto Closed-loop PID The icon is displayed

operating controller. only if it is not the
mode M Manual normal mode.
Interlocking Active A motor is –
interlocked because
of an interlock
condition.
Displaying Out of service A motor is declared –
service out of service in its
information faceplate.

Transitioning Transitioning – –
state

Informing of The control The control module Represented on the

abnormal module is in is in simulation. element that is in
configuration abnormal abnormal
configuration. Global bypass is configuration, page 46.
activated.

Partial bypass.

Requesting The control A motor needs a –

operator module is reset to start again.
action waiting for an
Flashing operator action.

Resetting Awaiting a Motor waiting to be Displayed if mandatory

required reset reset after thermal manual resetting is
trip. enabled in the
resource controlling
the device.
Displaying Out of Speed setpoint is Namur NE-107
Namur specification outside the limit. Management, page 40
statuses
Maintenance Replace the pH
required electrode.

Failure Inoperable device.

detected

Check function Substitute value

entered.

Displaying Information A message is shown See $MessageBoxCE

operator to the operator.
messages

Question A value or
confirmation is
requested from the
operator.

Exclamation The operator is

informed of an
abnormal condition.

Stop An abnormal
condition that is
equivalent to the
Namur Failure status

EIO0000004360.04 49
Supervision Services Representation of Supervision Data

Function Icon Meaning Examples of use Comment

is shown to the
operator.

Displaying Alarm of Very high Defined by the style

alarms severity 1 temperature alarm. AlarmBorder_Critical_
UNACK

Alarm of – Defined by the style

severity 1 AlarmBorder_Critical_
returns to RTN
normal

Alarm of High temperature Defined by the style

severity 2 alarm. AlarmBorder_High_
UNACK

Alarm of – Defined by the style

severity 2 AlarmBorder_High_
returns to RTN
normal

Alarm of Function check Defined by the style

severity 3 (Namur status). AlarmBorder_Medium_
UNACK

Alarm of – Defined by the style

severity 3 AlarmBorder_Medium_
returns to RTN
normal

Alarm of – Defined by the style

severity 4 AlarmBorder_Low_
UNACK

Alarm of – Defined by the style

severity 4 AlarmBorder_Low_
returns to RTN
normal

Displaying Alarm silenced – –

alarms

Alarm disabled – –
or inhibited

The alarm is – –
shelved, page
39.

Indicating Very high Very high –

alarm level temperature.
setpoints
High High temperature. –

Setpoint Temperature outside –

of setpoint.

Deviation Temperature outside –

of deviation.

Low Low temperature. –

Very low Very low –

temperature.

50 EIO0000004360.04
Representation of Supervision Data Supervision Services

Function Icon Meaning Examples of use Comment

Indicating Setpoint Position setpoint of a –

Setpoints control valve.
(bars)

Displaying Present value – –

trend pens

Output value – –

Very high limit – –

High limit – –

Setpoint – –

Deviation – –

Low limit – –

Very low limit – –

Opening the Click the icon to – –

trend open the trend
faceplate faceplate.

Displaying Label of – Only if labels are made

labels symbols visible.

Extended Click to open - Displayed if the

interlock/ extended interlocks/initial
Initial interlock conditions are
condition faceplate, page extended using
342. $IlckCE template.

NOTE: User has to use PSxLabels symbol to enable label on the graphic
(click Graphic Toolbox → PSx Symbol Library → Support → PSxLabels).

Faceplate Tab Icons

Overview
You can access a faceplate, page 63 by clicking a symbol during operation.
Faceplates consist of tabs which group by category, the representation of
functionalities that are provided by the associated control resource during
operation.
Each category is represented by a tab icon.
Click a tab to access its functionalities.
To access the trend faceplate, click the wave icon that is displayed next to a
symbol.
NOTE: Some tabs are optional or object-specific and are displayed only if the
control module features the corresponding service and the service is enabled
for the instance.
NOTE: If the tab icon is flashing, an action is required from this tab.

EIO0000004360.04 51
Supervision Services Representation of Supervision Data

Description
The table describes the tabs and the functionalities they feature.

Tab/category Icon Functionalities Examples of use

Operation • Current status (present value, • Operator/ program

setpoint, output value) • Manual/automatic
• Owner change • PID controller setpoint (SP) change in auto mode
• Operating mode change and output change in manual mode
• Setpoint (SP) change
• Resetting
• Configuration of alarms at control
level
• Local panel monitoring

Interlocks / initial • Interlock condition statuses Interlocks associated with an on-off valve
conditions • Bypassing and/or manual resetting
of interlock conditions
Failures • Status of detected failure conditions Thermal overload of a motor
• Bypassing of detected failure
conditions
• Manual resetting condition

Maintenance • Access to accumulated data • Hours of operation

regarding the control module
• Number of operations
operation
• Counter resetting

Engineering Changing settings or parameters • Adjustment of PID control parameters

• Activating the simulation mode

Warning Status of detected warning conditions To monitor the extended warning conditions from
ATV6xx/ATV9xx device

Alarms • Acknowledgment of alarms • Disable alarm

• Configuration of alarms at • Mute alarm
supervision level

Analog data • Analog data of a device Motor speed

• Input and output parameters of a
sequence

Discrete data Discrete data of a device Information ready to switch on of an ATV61

Optional Label Text

Description
Label of graphical symbols is optional for user to use as it can be show/hide in the
runtime page.
The below table explains the steps to disable the label:

Step Action

1 Open the Application Template derived from the $MotorCE master template, from which
the application instances are created.

2 Add the new local graphic symbol (for example, MyBlower_Left).

3 Open the Blower_Left symbol and also open the MyBlower_Left symbol.

4 Open Blower_Left symbol, copy the entire content of this symbol and paste into
MyBlower_Left symbol that is newly created.

52 EIO0000004360.04
Representation of Supervision Data Supervision Services

Step Action

5 Select the MyBlower_Left symbol and change the LabelVisibility custom property value
to False.
6 Save and Close MyBlower_Left symbol.

7 Instantiate MyBlower_Left symbol on process page and check the runtime.

LabelVisibility custom property of MyBlower_Left symbol on process page can

be disabled (double click on the MyBlower_Left symbol then edit symbol
properties will appear, change LabelVisibility default value to false). The label
custom property will appear in runtime window as per the modification.
Optional label text is available in graphical symbol of below templates:

SI. No. Template Name

1 $DigitalInputCE

2 $AnalogInputCE

3 $AnalogInMultiCE

4 $DigitalOutputCE

5 $AnalogOutputCE

6 $TotalCE

7 $MotorCE

8 $Motor2DirCE

9 $ValveCE

10 $HandValveCE

11 $MValveCE

12 $ControlValveCE

13 $MValvewithPosCE

14 $MotorVSCE

15 $IMCTLCE

16 $LeadLagCE

17 $PIDCE

19 $PWMCtlCE

20 $RampCE

21 $RatioCtrlCE

22 $SplitRangeCE

23 $Step3CtlCE

EIO0000004360.04 53
Supervision Services Screen Profile and Layout

Screen Profile and Layout

What’s in This Chapter
Screen Profile and Layout ..............................................................................54

Screen Profile and Layout

Screen Profile
A Screen Profile defines the display assigned to a client. Screen Profile definitions
include all the aspects defined for a Screen (size, orientation, resolution, density,
touch), but adds the ability to define how many screens are used for the display
and how they fit together. For example, the Screen Profile for a control room might
include the definitions for three screens, two in landscape orientation and one in
portrait orientation, each with a different size and resolution. This library offers one
sample screen ($ScreenProfileGP) profile for a single monitor with HD
resolution.

Layout
A Layout consists of one more rectangular areas of content (panes) for a screen
and is used to define how run-time information is displayed. The Layout
determines the type of content to be displayed in each pane, and how the panes
are positioned on the screen. A pane can encompass the entire screen, or only a
portion of it. This library provides a layout sample ($LayoutGP) for the user, the
details of which are explained below.

54 EIO0000004360.04
Screen Profile and Layout Supervision Services

1. LayoutGP

Item Description

1 This slide-in pane is configured with the Navigationtreecontrol app

provided by AVEVA system platform.

2 This slide-in pane is configured with the Historicaltrendcontrol app

provided by AVEVA system platform.

3 This pane is configured with the Titlebarcontrol app provided by

AVEVA system platform.

4 This pane is configured with the Navigationbreadcrumbcontrol app

provided by AVEVA system platform.

5 This pane is configured to show level 3 symbols. The graphic must

be configured with content type as L3, so that it appears in this pane.

6 This pane is configured to hold the label enable button for the L3
symbols.

7 This area in the layout is reserved to host the faceplate when

faceplate is configured as fixed style.

8 This pane is configured with the Alarmcontrol app provided by

AVEVA system platform. This app helps to manage the alarms.

EIO0000004360.04 55
Supervision Services Screen Profile and Layout

2. GPLLayout_Content:

Item Description

1 This pane will host the operator tab/ information of the faceplate.

2 This pane will display the tab icons of the services that are configured.

3 This pane will host all the tab contents of the services that are
configured.

4 This pane is configured with the Asset Specific Alarmcontrol app

provided by AVEVA system platform. This app helps to manage the
asset specific alarms.

56 EIO0000004360.04
Screen Profile and Layout Supervision Services

3. GPLLayout_Popup:

Item Description

1 This pane will host the Name and Description of the instance.

2 This pane will display the tab icons of operator tab and the services that
are configured.

3 This pane will host all the tab contents of the tabs selected.

NOTE: The element style User_Defined_04 is used for the Popup

TabBars.
Please refer to AVEVA help for more details on the apps which are used in the
layout.
This Library also delivers a viewapp ($viewappGP), which uses the screenprofile
and layout samples delivered in the library.

EIO0000004360.04 57
Supervision Services Faceplate as a Popup

Faceplate as a Popup
What’s in This Chapter
Faceplate as a Popup ....................................................................................58

Faceplate as a Popup
Overview
The faceplates of this Library can be opened in fixed style (default style) or as a
popup.
You can select the type of faceplate from the Graphic Toolbox > OMI >
PSxSymbol Library > GPL_Faceplate > Popupstyle.
The below figure shows the location of GPL_Faceplate Namespace:

Faceplate will open in fixed style if the Initial Value of PopupStyle is set to
false as shown in the below image:

Faceplate will open in fixed style if the Initial Value of PopupStyle is set to true
as shown in the below image:

Additional Tabs
You can add two additional tabs if required when using faceplate as a popup.
Perform the following steps to enable the two tabs in the faceplate:

58 EIO0000004360.04
Faceplate as a Popup Supervision Services

Step Action

1 Set the Initial value of the Attributes Param.ExtendedTab1Popup.Enable and or

Param.ExtendedTab2Popup.Enable to true as required.

2 Enter the name of the tab to be opened in the attributes Param.TabExtendedTabFP.

ExtendedTab1 and or Param.TabExtendedTabFP.ExtendedTab2.

The typical example is shown below when the additional tabs are used:

NOTE: The extended tabs would be available only when the faceplate is
configured as popup. To add extra tabs in fixed style, refer to the topic
Faceplate Customization, page 77.
The Abnormal and Action Required can be configured in the extended tabs by
using the custom properties ExtendedTab1.Abnormal, ExtendedTab1.
ActionR, ExtendedTab2.Abnormal, ExtendedTab2.ActionRin the TabBar
of the master templates.

EIO0000004360.04 59
Supervision Services Multi Monitor

Multi Monitor
What’s in This Chapter
Multi Monitor .................................................................................................60

Multi Monitor
If Faceplate is configured as Fixed Style
The navigation in multi monitor will be based on the asset and all screens will
show the same page.
If Faceplate is configured as Popup Style
You can modify the LayoutGP delivered as a part of GPL Templates to modify the
navigation to support independent navigation in multi monitor.
It is recommended that you duplicate the LayoutGP.

Create a custom navigation symbol in the Graphic tool as per the requirement as
shown in the below example:

60 EIO0000004360.04
Multi Monitor Supervision Services

In the Action Script for each navigation symbol write the code as shown below:
dim contentinfo as aaContent.ContentInfo;
contentinfo.Name = "<Name of the duplicated layout>";
contentinfo.PaneName = "Mimics";
contentinfo.Content = "<Name of the symbol to be opened>";
ShowContent(contentinfo);
Place the symbol in the duplicated LayoutGP as per requirement.
For example, the built-in navigation is removed from the slide in pane in the
duplicated LayoutGP and custom navigation is added.

Replace the layout in the ViewAPP.

EIO0000004360.04 61
Supervision Services Multi Monitor

62 EIO0000004360.04
 Supervision Services

Faceplates
What’s in This Part
Optional Faceplate Tabs for Process Objects ...................................................64
Optional Faceplate Tabs for Smart Device Objects............................................72
Common Faceplate Tabs ................................................................................75
Faceplate Customization ................................................................................77

Overview
This part describes the faceplates and faceplate tabs, page 51 that are common to
various object categories of the Modicon Libraries - General Purpose for AVEVA
System Platform.

EIO0000004360.04 63
Supervision Services Optional Faceplate Tabs for Process Objects

Optional Faceplate Tabs for Process Objects

What’s in This Chapter
Local Panel Section.......................................................................................64
Interlocks Tab................................................................................................65
Failures Tab ..................................................................................................68
Maintenance Tab...........................................................................................70

Overview
This chapter describes the various optional faceplate tabs, page 51 that are
common to objects of the process category.
Their use and functionalities are configured from the corresponding optional
pages, page 88 of the master template.
NOTE: Template-specific faceplate tabs are described in the chapters
documenting the master template.

Local Panel Section

Overview
The operation tab may feature the optional local panel section.
The local panel is enabled from the Local Panel page of the process master
template.

Local Panel Representation

The figure shows the local panel section only when ModeSignalsEN input signal is
high.

The figure shows the local panel section only when VirtualLPEN input signal is
high.

64 EIO0000004360.04
Optional Faceplate Tabs for Process Objects Supervision Services

Function Description
The local panel section features a Local Panel mode indication, Local Panel mode
selection from the Faceplate and status lights.
For a detailed description of the local panel function, refer to the corresponding
control resource (see Modicon Libraries General Purpose, Process Components
User Guide).
This table describes the different operating modes of the local panel when
enabled:

Item State Description

Local Control System User have the choice to control the device through the
Panel PROGRAM or the OPERATOR (OWNER section of the operation
(Modes) tab).

Zero User cannot operate the device neither from the faceplate
controls nor from the field (Local Panel).

Local Panel User can operate the control module from the field (Local Panel)
only.

The Local Panel provides status information of the device on the

faceplate (status lights) that is operated from the field (Local
Panel).

Status Passive style, The status that is indicated by the label is not activated.
lights page 47

Active style, The status that is indicated by the label is activated.

page 47

Local Local Panel mode operation can be enabled from the drop-down list on the faceplate.
Panel
NOTE:
• When VirtualLPEN input pin signal is high in DFB, Local Panel mode drop-
down list appears on the faceplate for operation.
• In runtime, when the user is not logged-in or if the Owner is in program
mode, then the Local Panel mode drop-down list is disabled for operation.

Enable LPMode operation is enabled in DFB, so the user can operate

devices from the field (Local Panel).

Disable LPMode is disabled in DFB. Hence, user cannot operate the

devices from the field (Local Panel).

Interlocks Tab
Overview
The optional interlocks tab is available on certain faceplates, allowing you to view
and interact with conditions that are configured to interlock a control module.
Depending on the configuration of the corresponding control resource and the
process object, the tab allows bypassing each condition. You can also make
manual resetting of each input of the corresponding control resource mandatory
after the interlock condition is cleared.
When configured, a dialog box is displayed when you click a reset button, which is
used to confirm the reset.
The interlocks tab is enabled from the Interlocks page of the process master
template.
NOTE: This tab is also used to display initial conditions for sequential control,
page 271 and equipment module, page 318.

EIO0000004360.04 65
Supervision Services Optional Faceplate Tabs for Process Objects

Interlocks Tab Representation

The figure shows an example of the interlocks tab.

NOTE: When no interlock conditions are present or when all present interlock
conditions are bypassed, the message Not Interlocked is displayed at the
bottom of the tab; otherwise, the message is Interlocked.

WARNING
LOSS OF CONTROL AND UNINTENDED EQUIPMENT OPERATION
• 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.
• Do not manually bypass or reset an interlock condition without confirming the
impact on subsequent process events.
• Provide separate or redundant control paths wherever required.
• 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.

1For 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.

66 EIO0000004360.04
Optional Faceplate Tabs for Process Objects Supervision Services

Interlock Condition Descriptions

The tab displays the interlock conditions configured in the Interlocks page, page
89 of the process object.
When a configured condition arises, its description is displayed in the tab.

Bypassing an Interlock Condition

After you have selected one or more interlock conditions in the tab, bypassing the
selected conditions underlies a security classification, page 89 when you click
Apply. The default configuration is verified write.
Bypassing an interlock condition is configured by default as an abnormal state and
is indicated by an orange rectangle, page 46.
NOTE: For interlock conditions starting by an asterisk (*), the Bypass check
box is not displayed because they are associated to control data that cannot
be written to.

Manual Resetting of an Interlock Condition

When the reset is effective, the command that is shown in the SetPoint menu in
the operation tab of the faceplate is initiated.
The reset button is available only if the interlock condition has disappeared and
depending on the configuration made in the controller.
Resetting an interlock conditions underlies a security classification, page 89. The
default configuration is secured write.
NOTE: When the tab is used as part of the $SequenceCE master template,
after performing a reset, you need to restart the process sequence from the
operation tab of the faceplate.

Reset Confirmation
For the following master templates of the process category, the Param.
InterlockRearmConfirmation parameter allows you to display a dialog box that
requires a confirmation for the reset of an interlock to take effect. The dialog box
appears when you click Apply:
• $MotorCE
• $MValvewithPosCE
• $MValveCE
• $MotorVSCE
• $Motor2DirCE
• $ValveCE
Refer to Parameters in the chapter documenting each master template for a
description of the Param.InterlockRearmConfirmation parameter.

EIO0000004360.04 67
Supervision Services Optional Faceplate Tabs for Process Objects

The figure shows the confirmation dialog box which is model in nature.

Resetting an interlock condition by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
NOTE: When the reset confirmation is enabled, the security classification that
normally applies when you click a reset button is not effective.

Failures Tab
Overview
The optional failures tab is available on certain faceplates, allowing you to view
and interact with abnormal conditions at the control module level.
Depending on the configuration of the monitored control logic and the process
object, the tab allows bypassing each condition. You can also make manual
resetting of each input of the corresponding control resource mandatory after the
abnormal condition is cleared.
The tab is enabled from the Failures page, page 89 of the process master
template.
NOTE: This tab is also used to display:
• Alarm conditions for alarm summary management, page 337.
• Detected failure conditions for sequential control, page 272 and
equipment module, page 319.

68 EIO0000004360.04
Optional Faceplate Tabs for Process Objects Supervision Services

Failures Tab Representation

The figure shows an example of the Failures tab.

NOTE: When no abnormal conditions are present or when all present

abnormal conditions are bypassed, the message Not Failed is displayed at
the bottom of the tab; otherwise, the message is Failed.

WARNING
LOSS OF CONTROL AND UNINTENDED EQUIPMENT OPERATION
• 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.
• Do not manually bypass or reset a failure condition without confirming the
impact on subsequent process events.
• Provide separate or redundant control paths wherever required.
• 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.

1For 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.

EIO0000004360.04 69
Supervision Services Optional Faceplate Tabs for Process Objects

Abnormal Condition Descriptions

The tab displays the abnormal conditions configured in the Failures and/or
Failures2 pages, page 89 of the process object.
When a configured condition arises, its description is displayed in the tab.

Bypassing an Abnormal Condition

After you have selected one or more abnormal conditions in the tab, bypassing the
selected interlock conditions underlies a security classification, page 91 when you
click Apply. The default configuration is verified write.
Bypassing an abnormal condition is configured by default as an abnormal state
and is indicated by an orange rectangle, page 46.
NOTE: When the tab is used as part of the $SequenceCE master template,
resetting a detected failure condition requires a secured write.
NOTE: For abnormal conditions starting by an asterisk (*), the Bypass check
box is not displayed because they are associated to control data that cannot
be written to.

Manual Resetting of Abnormal Conditions

The reset button is available only if the abnormal condition has disappeared and
depending on the configuration made in the controller.
By default, resetting an abnormal condition underlies a secured write security
classification, page 91.
Depending on the configuration of the monitored control logic, to reset the control
module, you may need to click the Reset button on the operation faceplate. Refer
to the description of the operation faceplate in the chapter describing the
corresponding master template.
NOTE: When the tab is used as part of the $AlarmSummaryCE master
template, to reset an abnormal condition, your role needs to have permission
to modify attributes with operate security classification.
NOTE: When the tab is used as part of the $SequenceCE master template,
after performing a reset, you need to restart the process sequence from the
operation tab of the faceplate.

Maintenance Tab
Overview
The maintenance tab is an optional tab that:
• Displays accumulated data related to the operation of the control module.
• Allows resetting the corresponding counters.
The tab is enabled and configured from the Maintenance page of the process
master template.

70 EIO0000004360.04
Optional Faceplate Tabs for Process Objects Supervision Services

Maintenance Tab Representation

The figure shows an example of the maintenance tab.

Resetting of Counters
Resetting a counter underlies a security classification, page 92.

EIO0000004360.04 71
Supervision Services Optional Faceplate Tabs for Smart Device Objects

Optional Faceplate Tabs for Smart Device Objects

What’s in This Chapter
Analog Data Tab............................................................................................72
Discrete Data Tab..........................................................................................73

Overview
This chapter describes the various optional faceplate tabs, page 51 that are
common to templates of the device category.
Their use and functionalities are configured from the corresponding optional
pages, page 95 of the master template.
NOTE: Template-specific faceplate tabs are described in the chapters
documenting the master template.

Analog Data Tab

Overview
The analog data tab contains up to six subtabs displaying the analog data of the
device. A subtab is displayed once the corresponding analog group is enabled
from the Main page of the master template.
The analog data is configured in the Analog 1...Analog 6 pages, page 98 of the
device object .

72 EIO0000004360.04
Optional Faceplate Tabs for Smart Device Objects Supervision Services

Analog Data Tab Representation

The figure shows an example of the analog data tab.

NOTE:
• Analog Data tab - if the value from the Unity is NAN then the data
displayed on the faceplate will be as per the OS language set on the local
System.
• Analog Data tab > Diagnostic codes tab displays the information of
diagnostic code of the device. The value displayed is in decimal, user has
to manually convert this decimal value to hexadecimal value and refer
(see Modicon Libraries General Purpose, Devices Components User
Guide) for Diagnostic codes/ Failcode description.

Discrete Data Tab

Overview
The discrete data tab contains up to four subtabs displaying the discrete data of
the device. A subtab is displayed once the corresponding word is enabled from
the Main page of the master template.
The discrete data is configured in the Discrete 1...Discrete 4 pages, page 96 of
the device object.

EIO0000004360.04 73
Supervision Services Optional Faceplate Tabs for Smart Device Objects

Discrete Data Tab Representation

The figure shows an example of the discrete data tab.

NOTE: Namur icons are displayed in the tab to the right of the description
when configured, page 41.

74 EIO0000004360.04
Common Faceplate Tabs Supervision Services

Common Faceplate Tabs

What’s in This Chapter
Alarms Tab ...................................................................................................75

Overview
This chapter describes the various tabs that are common to the faceplates of
master templates of the library.

Alarms Tab
Overview
The alarms tab is available in each faceplate. It allows you to acknowledge alarm
notifications that are associated to the control module and to manage the way
these notifications are reported at the supervision level.
You can acknowledge and configure alarm notifications either:
• Globally for the alarms that are associated to the control module.
• Individually for each alarm.
NOTE: The evaluation of the corresponding signals at the control level is not
impacted by the configuration of alarm notifications in this tab.

Alarms Tab Representation

The figure shows an example of the alarms tab.

EIO0000004360.04 75
Supervision Services Common Faceplate Tabs

Header Description

Alarm Displays the string that is configured in the Alarm message of the alarm
feature of the attribute.

The row (All) applies the configuration globally to alarms of the control
module.
NOTE: The state alarms that are configured by default are described in
the chapter documenting each master template.

Mode Available alarm modes:

• Enable
• Disable
• Silence
Inhibit When selected, the alarm is inhibited.
NOTE: It also inhibits any alarm in contained instances of the object.

Shelve When selected, the alarm is shelved, page 39.

NOTE: It does not shelve alarms in contained instances of the object.

Status Shows:
• The status of the alarm by using the corresponding icon, page 48.
• The Namur icon (when applicable).
• The alarm severity, page 38.
NOTE: The tab allows you to see the alarms that are active, whereas
the symbol displays only the alarm with the highest priority out of the
active alarms.

NOTE: Your role needs to have the required operational permission to modify
alarm modes.

76 EIO0000004360.04
Faceplate Customization Supervision Services

Faceplate Customization
With the Ecostruxure Process Expert – General Purpose for Aveva System
Platform R2 release you will be able to change the standard library pages and use
custom pages instead of standard tabs. Also you will be able to extend the
faceplate by adding new tabs.
Follow the below mentioned steps to add new tabs.

EIO0000004360.04 77
Supervision Services Faceplate Customization

1. Creation of new tabs in L4 (Faceplates).

There are two methods which can be followed to create new tabs for the
existing templates.
• Duplicate the existing faceplate and add the required objects.
• Create new content and set the following properties.
◦ Create a frame of width: 348 and height: 524

◦ Set the symbol (TabxxxxFP) ContentType : User_Defined_1

◦ Add the required Objects / Scripts / Custom Properties are to the

frame to complete the L4 symbol (Faceplate).
◦ Then an attribute (parameter) is created in the Master template to
store the name of the content that represents the new tab (Faceplate).
Ex: Attribute name: Param.TabOperatorFP.
Operator Attribute Initial Value of: Me.TabOperatorFP

78 EIO0000004360.04
Faceplate Customization Supervision Services

2. Creation of Tab Icon.

• You can either use the existing the Standard Tab Icons available in path
shown below

or can design/create new icon with abnormal if required in same location

depending on the requirements.
• Create new content in Master Template with the below mentioned syntax:
“TabIconxx_yyyy”
where “xx” is a numeric value defining the order where tab appears in
runtime and “yyyy” is any suffix.
Example: TabIcon10_LocalPanel where“10” in the name describes the
order of the tab from left to right in the ascending order.

• Instantiate the Tab Symbol in the new content which is created.

Example: In TabIcon10_LocalPanel, Tabsymbol “Localpanel” is
instantiated

• Write the Abnormal animation conditions in the script (if any of them are
applicable).
The image below illustrates an example for Alarms Tab abnormal
symbol.

EIO0000004360.04 79
Supervision Services Faceplate Customization

• Set the Content Type of Tab symbol to “User_Defined_3” as illustrated

below.

• A custom property TabName is created to read the name of the faceplate

through the attribute (parameter).

80 EIO0000004360.04
Faceplate Customization Supervision Services

• This custom property TabName will be referred in the action script shown
below. This action script will set focus to the faceplate.

NOTE: The recommended number of tabs are 8, however you can add more
tabs. Once the tab count exceeds 8, scroll bar will appear to navigate beyond
8 tabs.

EIO0000004360.04 81
Supervision Services

Implementing the Library

What’s in This Part
Implementing the Library ................................................................................83

Overview
This part describes how to implement the Modicon Libraries - General Purpose for
Wonderware System Platform to create an application.
It does not describe how to deploy objects nor the Galaxy. Refer to the ArchestrA
IDE help.

82 EIO0000004360.04
Implementing the Library Supervision Services

Implementing the Library

What’s in This Chapter
Implementation Overview...............................................................................83
Creating the Model View ................................................................................83
aOPCClientGP Configuration .........................................................................84
Template or Instance Configuration (Object Editor) ..........................................85
Graphic Symbol Integration............................................................................85

Overview
This chapter describes how to implement the Modicon Libraries - General
Purpose for AVEVA System Platform to create an application.
It does not describe how to deploy objects nor the Galaxy. Refer to the ArchestrA
IDE help.

Implementation Overview
Quick Reference
The table indicates the steps to follow and the topic describing each step.

Step Action Refer to

1 Import library objects in your Galaxy. Library Installation, page 22.

2 Create the Model view hierarchy. Creating the Model View.

3 Create application object instances. Instance Creation.

4 Configure application object instances. Template or Instance Configuration, page

85.
5 Deploy the Galaxy. ArchestrA IDE help.

6 Create your supervision application in Graphic Symbol Integration, page 85.

ArchestrA Graphic Editor.

Creating the Model View

Introduction
The Model view shows objects in terms of their physical or containment
relationships and allows you to create your system architecture.
An area represents a physical section of a plant or automation process or a logical
part of an automation application.
The area instances are created from the $aAreaRootGP and $aAreaGP
application templates.
The $aAreaRootGP template is used to create the top-level areas of the Model
view.

EIO0000004360.04 83
Supervision Services Implementing the Library

Model View Creation

This procedure describes the creation of a typical model view by using instances
of application templates.

Step Action

1 Select Model view.

2 Create instances of the $aAreaRootGP application template.

3 Create instances of the $aAreaGP application template.

4 Drag each area instance from the UnassignedArea folder to the required area instances to create your Model view hierarchy
(up to 10 levels).
NOTE: The $aAreaGP instances must not be placed at the top of the model view hierarchy. They need to have
$aAreaRootGP instances as parent.

5 Configure each $aAreaRootGP and $aAreaGP instances.

6 Create system object instances by using the $aWinplatformGP, $aAppEngineGP, and $aViewEngineGP application
templates.

7 Configure the system objects.

8 Create instances of the $aOPCClientGP application template.

9 Drag the $aOPCClientGP instance from the UnassignedArea folder to the $aAreaRootGP instance.

10 Configure the aOPCClientGP instance (refer to aOPCClient Configuration, page 84).

11 Create your application object instances by using the appropriate application templates.

12 Drag the application object instances from the UnassignedArea folder to the areas corresponding to your system
architecture.

aOPCClientGP Configuration
Overview
OPC client instances are created from the $aOPCClientGP template.
They are used to communicate with Modicon controllers through OPC Factory
Server (OFS).

Configuring aOPCClientGP
Proceed as follows to configure an OPC DA and OPC UA client instance.

Step Action

1 Create an instance of the $aOPCClientGP template.

2 Double-click the instance to open it in the object editor

3 In the General page, configure the Server node with the name or IP address of the PC that hosts the OFS server.

4 To set the Server name, you can use the OFS server program ID (Schneider-Aut.OFS) or select the instance of the OFS
server from the menu.
NOTE: For OPC UA Configuration OFS Program ID is OI.GATEWAY.3.

5 In the Scan Group page, you need to configure at least one scan group. A scan group is a collection of OPC items with a
common update interval.
NOTE: By default, Scan Mode is set to ActiveOnDemand. In this mode, the items that are not actively being referenced
by any client or object are not scanned. For more information about Scan Mode, refer to the ArchestrA IDE help.

6 Check in the object.

84 EIO0000004360.04
Implementing the Library Supervision Services

Template or Instance Configuration (Object Editor)

Overview
The object editor features native configuration pages but also pages that are
specific to the objects of Modicon Libraries - General Purpose for AVEVA System
Platform, page 87. Typically, the library-specific pages are used to configure
optional supervision functions provided by templates.
Use the Attributes page to:
• List the attributes associated with the template or instance.
• Add attributes to a template or instance.
• Configure parameters of core supervision functions (attributes with the
Param. prefix)
• Configure state alarms.
• Configure the aliases if needed (attributes with the .Alias suffix).

Diagnostic Messages When Saving Changes to Unassigned

Instances
If you edit an instance that is not assigned to an area or host yet and save your
changes, ArchestrA IDE may display a message about unresolved references in
attributes.
Indeed, most templates of the Modicon Libraries - General Purpose for AVEVA
System Platform have attributes with references, which require that their instances
be assigned to an area or host so that the reference can be resolved.
This is the case, for example, for instances that have attributes with references to
MyEngine. The reference can be resolved only once the instance is assigned to a
host, which is an instance of any template derived from the $aAppEngineGP
template, page 103.
Similarly, instances of templates derived from $aAreaGP trigger a message about
unresolved references to MyArea. These references are resolved when the
instances are assigned to another area. This other area is an instance of any
template derived from the $aAreaGP or $aAreaRootGP templates, page 105.
Edit instances after you have assigned them to the appropriate area or host to
avoid these references from being reported as unresolved.
NOTE: This type of message can also be triggered if ArchestrA IDE cannot
resolve a reference as a result of an incorrect modification in a derived
template or its instances. Verify that your configuration allows references in
attributes to be resolved.

Graphic Symbol Integration

Introduction
The graphic symbols are associated with the automation objects (object
instances).
The ArchestrA Graphic Editor allows you to embed graphic symbols into another
symbol.
You can create part of your supervision application in a symbol and integrate this
symbol in an InTouch window and use it at runtime.

EIO0000004360.04 85
Supervision Services Implementing the Library

Integrating Graphic Symbols

Proceed as follows to insert a graphic symbol into another symbol.

Step Action

1 In the Graphic Toolbox view, double-click the symbol in which you want to insert a symbol.

Result: The ArchestrA Graphic Editor opens.

2
Click Edit > Embed Graphic or click the following icon in the toolbar.

Result: The Galaxy Browser opens.

3
Display the instances by clicking the following icon in the toolbar

4 Select an instance from the list.

5 Select one of the graphic symbols associated with this instance.
NOTE: Faceplate symbols also appear in the list but they do not open dynamically when you click them at runtime. You
do not need to embed them. Faceplates open when you click a symbol at runtime.

6 Click Ok.
7 Click the area where you want to position the symbol.

Result: The symbol is added.

86 EIO0000004360.04
 Supervision Services

Object Configuration Pages (Object Editor)

What’s in This Part
Optional Process Object Configuration Pages ..................................................88
Optional Device Object Configuration Pages ....................................................95
Common Configuration Pages....................................................................... 100

Overview
This part describes the configuration pages that are common to various object
categories of the Modicon Libraries - General Purpose for AVEVA System
Platform.

EIO0000004360.04 87
Supervision Services Optional Process Object Configuration Pages

Optional Process Object Configuration Pages

What’s in This Chapter
Interlocks Page Default Configuration .............................................................88
Failures Page Default Configuration ...............................................................89
Maintenance Page Default Configuration ........................................................92
Local Panel Page Default Configuration ..........................................................93
Alarms Page Default Configuration .................................................................93

Overview
This chapter describes the configuration pages that are common to master
templates of the process category and specific to the Modicon Libraries - General
Purpose for AVEVA System Platform.
They allow you to configure optional supervision functions of process application
templates and their instances.
Data that you configure from these pages affects the corresponding optional tabs,
page 64 and common tabs, page 75 of process object faceplates. If a page
contains no data, the corresponding faceplate tab is not displayed.
The default security classification to modify references is Configure.
NOTE: Depending on the master template, some of these pages may not be
available and/or not configured.

Interlocks Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the
Interlocks page is used to:
• Enable or disable monitoring of interlocks and define the interlock condition
descriptions. When enabled, it allows you to:
◦ Enable or disable the bypass of interlocks.
◦ Enable or disable the manual resetting of interlocks.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of interlocks
management, refer to the chapter documenting each master template of the
process category.

88 EIO0000004360.04
Optional Process Object Configuration Pages Supervision Services

Interlocks Page Description

Element Description

Enable Interlocks Select this check box to enable monitoring of interlock conditions.

The default security classification is Configure.

Enable Bypass of Select this check box to enable bypassing of interlock conditions.
Interlocks
The default security classification is Configure to enable the bypassing
function and Verified Write to bypass interlocks during operation.

Enable Manual Reset Select this check box to enable manual resetting of interlocks.
of Interlocks
The default security classification is Configure to enable the reset
function and Secured Write to reset interlocks during operation.

Interlock Descriptions Enter the interlock condition descriptions (up to 7).

Interlock descriptions starting with an asterisk (*) are associated to

control data that cannot be written to; they cannot be bypassed. For
these, the Bypass check box is therefore not displayed in the faceplate
tab.

The default security classification is Configure.

NOTE: The descriptions can be entered in multiple languages,
page 43.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

Failures Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the
Failures page is used to:

EIO0000004360.04 89
Supervision Services Optional Process Object Configuration Pages

• Enable or disable monitoring of abnormal conditions and define the

descriptions. When enabled, it allows you to:
◦ Enable or disable the bypass of abnormal conditions.
◦ Enable or disable the manual resetting of abnormal conditions.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of abnormal
condition management, refer to the chapter documenting each master template of
the process category.
NOTE: Two identical pages are available to configure abnormal condition
management, Failures and Failures2. Only the suffixes that are configured
by default vary.

Management of Abnormal Conditions for Direction and Speed

Two identical pages are available to configure abnormal condition management,
Failures and Failures2. Only the suffixes that are configured by default vary:
• The Failures page references the CONDSUM_ST datatype.
• The Failures2 page references the RC_CONDSUM_ST datatype.
The table describes the possible scenarios to manage abnormal conditions for
control resources with two motor directions and two speeds that feature these
functions by using either or both pages.

Monitoring of abnormal conditions for Use Failures page Use Failures2 page

None No No
Forward direction/speed 1 and reverse Yes No
direction/speed 2

Forward direction/speed 1 and reverse Yes Yes

direction/speed 2
Forward direction/speed 1 Reverse direction/speed 2

90 EIO0000004360.04
Optional Process Object Configuration Pages Supervision Services

Failures and Failures2 Page Description

Element Description

Enable Failures Select this check box to enable monitoring of abnormal conditions.

The default security classification is Configure.

Enable Bypass of Select this check box to enable bypassing of abnormal conditions.
Failures
The default security classification is Configure to enable the bypassing
function and Verified Write to bypass abnormal conditions during
operation.

Enable Manual Reset Select this check box to enable manual resetting of abnormal conditions.
of Failures
The default security classification is Configure to enable the reset
function and Secured Write to reset abnormal conditions during
operation.

Failure Descriptions Enter the description of the detected failure conditions (up to 15).

Descriptions starting with an asterisk (*) are associated to control data

that cannot be written to; they cannot be bypassed. For these, the
Bypass check box is therefore not displayed in the faceplate tab.

The default security classification is Configure.

NOTE: The descriptions can be entered in multiple languages,
page 43.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

EIO0000004360.04 91
Supervision Services Optional Process Object Configuration Pages

Maintenance Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the
Maintenance page is used to enable monitoring of maintenance data. When
enabled, it allows you to count and reset:
• Operation hours.
• Number of switches.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of maintenance
data management, refer to the chapter documenting each master template of the
process category.

Maintenance Page Description

Element Description

Enable Maintenance Select this check box to enable supervision for maintenance data.

The default security classification is Configure.

Status Word Status word

Configuration Word Configuration word

The default security classification is Verified Write to reset counters

during operation.

Running Hours Counter of operation hours

The default security classification is Configure.

Number of Operations Counter of number of operations; by default the variable reference with
suffix for auto-referencing is <Instance name>_DEVMNT_ST.MCNT.

The default security classification is Configure.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

92 EIO0000004360.04
Optional Process Object Configuration Pages Supervision Services

Local Panel Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Local
Panel page is used to enable the local panel.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of the local panel
function, refer to the chapter documenting each master template of the process
category.

Local Panel Page Description

Element Description

Enable Local Panel Select this check box to enable the local panel function at the
supervision level.

The default security classification is Configure.

Status Word Status word; the variable reference is specific to the type of control
module associated with the local panel. For example, for $Motor2DirCE
master template, the default variable reference is _Motor2LP_ST.STW.

The default security classification is Configure.

Configuration Word Configuration Word; the variable reference is specific to the type of
control module associated with the local panel. For example, for
$Motor2DirCE master template, the default variable reference is
_Motor2LP_ST.CFGW.

The default security classification is Configure.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

NOTE: User has to match Suffix for Auto References with the DDT structure
of the control resource (DFB) of the instance.

Alarms Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Alarms
page is used to enable level alarm functions for analog signals. When enabled, it
allows you to manage individually the following alarm level signals:
• Very high level
• High level
• Deviation
• Low level

EIO0000004360.04 93
Supervision Services Optional Process Object Configuration Pages

• Very low level

The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of the level alarm
function, refer to the chapter documenting each master template of the process
category.

Alarms Page Description

Element Description

Enable Alarms Select this check box to enable supervision for analog alarms.

The default security classification is Configure to enable the alarm

function and Tune to during operation.

Enable High High Select this check box to enable supervision for very high-level alarms.
Setpoint

Enable High Setpoint Select this check box to enable supervision for high-level alarms.

Enable Deviation Select this check box to enable supervision for deviation alarms.
Setpoint

Enable Low Setpoint Select this check box to enable supervision for low-level alarms.

Enable Low Low Select this check box to enable supervision for very low-level alarms.
Setpoint

Customized References Specify a variable reference if the automatic referencing mechanism is

not used.

NOTE: For setpoints, the default security classification is Configure to enable

setpoint supervision and Tune to modify it during operation.

94 EIO0000004360.04
Optional Device Object Configuration Pages Supervision Services

Optional Device Object Configuration Pages

What’s in This Chapter
Main Page Default Configuration ....................................................................95
Discrete Page Default Configuration ...............................................................96
Analog Page Default Configuration .................................................................98

Overview
This chapter describes the configuration pages that are common to master
templates of the device category and specific to the Modicon Libraries - General
Purpose for AVEVA System Platform.
They are used to configure optional supervision functions of device application
templates and their instances.
Data that you configure from these pages affects the corresponding optional tabs
and subtabs, page 72 and common tabs, page 75 of device object faceplates. If a
page contains no data, the corresponding faceplate tab is not displayed.
The default security classification to modify references is Configure.
NOTE: Depending on the master template, some of these pages may not be
available and/or not configured.

Main Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Main
page is used to:
• Enable or disable discrete words related to the device (displayed in the
discrete data tab of the device faceplate).
• Enable or disable analog groups related to the device (displayed in the analog
data tab of the device faceplate).
When enabled, it allows you to configure the corresponding discrete and analog
configuration pages.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of device data
management, refer to the chapter documenting each master template of the
process category.

EIO0000004360.04 95
Supervision Services Optional Device Object Configuration Pages

Main Page Description

Element Description

Status Word Reference variable of the status word of the device.

Configuration Word Reference variable of the configuration word of the device.

The default security classification is Operate.

Enable Discrete Select the check box to enable monitoring of the corresponding discrete
Words word.

Enabling Word 1 to Word 4 enables Discrete 1 to Discrete 4 pages,

page 96 respectively.

The text that you enter in the Purpose field is displayed in the tooltip of
the corresponding subtabs (1 to 4) of the discrete data tab of faceplates,
page 73.

The default security classification is Configure.

NOTE: Text can be entered in multiple languages, page 43.

Enable Discrete Group Select the check box to enable monitoring of the analog group.

Enabling Group 1 to Group 6 enables Analog 1 to Analog 6 pages,

page 98 respectively.

The text that you enter in the Purpose field is displayed in the tooltip of
the corresponding subtabs (1 to 6) of the analog data tab of faceplates,
page 72.
NOTE: Text can be entered in multiple languages, page 43.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

Discrete Page Default Configuration

Overview
The Discrete 1 to Discrete 4 pages are used to:
• Define the bit descriptions of the discrete words.
• Define the Namur status associated with each bit.

96 EIO0000004360.04
Optional Device Object Configuration Pages Supervision Services

• Define the variable references associated with each discrete word.

The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of device data
management, refer to the chapter documenting each master template of the
process category.
NOTE: First, you need to enable the corresponding discrete word in the Main
page, page 95.

Discrete 1 to Discrete 4 Page Description

Element Description

Bit Descriptions Description of the bits. The text is displayed in the subtabs (1 to 4) of the
corresponding discrete data tab of device faceplates, page 73.
NOTE: Descriptions can be entered in multiple languages, page 43.

Namur Icon Select a Namur, page 40 status from the menu:

• None
• Failure
• Function check
• Out of specs
• Maintenance required

Suffix for Auto Variable reference of the configuration word of the control resource
References controlling the device.

By default, the variable reference is <Instance name>_<device-

specifc DFB_DDT>.<Configuration word>.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

EIO0000004360.04 97
Supervision Services Optional Device Object Configuration Pages

Analog Page Default Configuration

Overview
The Analog 1 to Analog 6 pages are used to:
• Define descriptions of data of the analog groups.
• Define the numerical format, engineering unit, and style, page 47 of the
analog values that are displayed in the faceplate of devices.
• Define the variable references associated with each analog data.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of device data
management, refer to the chapter documenting each master template of the
process category.
NOTE: First, you need to enable the corresponding analog group in the Main
page, page 95.

Analog 1 to Analog 6 Page Description

Element Description

Descriptions Description of the analog data. The text is displayed in the subtabs (1 to
6) of the corresponding analog data tab of device faceplates, page 72.
NOTE: The descriptions can be entered in multiple languages,
page 43.

Format Specify the number format of analog data to be displayed in faceplate

tabs.
NOTE: For configuration purposes, the decimal separator must be
Dot (.) and not any other type of separator, for example, Comma
(,). The run-time will use the configured language settings of the
local system.

EU Specify the engineering unit of analog data to be displayed in faceplate

tabs.
Format Select the style from the menu:

98 EIO0000004360.04
Optional Device Object Configuration Pages Supervision Services

Element Description

• PV: Present value style

• SP: Setpoint style
• OP: Output style
• Alarm Code: Alarm style
• No Data: The analog data is not displayed in the faceplate

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.
Suffix for Auto Variable reference of the control resource for each analog data.
References

EIO0000004360.04 99
Supervision Services Common Configuration Pages

Common Configuration Pages

What’s in This Chapter
Attributes Page ........................................................................................... 100
Scripts Page ............................................................................................... 101
Object Information Page .............................................................................. 101

Overview
This chapter provides an overview of the standard ArchestrA IDE configuration
pages that are common to master templates of the library.

Attributes Page
Overview
Use the Attributes page to:
• List the attributes associated with a template or instance.
• Add attributes to a template or instance.
• Configure the parameters of core functions of the object (attributes with the
Param. prefix). The object-specific parameters are described in the chapter
documenting each master template.
• Configure the aliases, if needed (attributes with the .Alias suffix). The
control/supervision relationship that is configured by default in master
templates is described in the chapter documenting each master template.
• Configure extendable attributes.
• Configure features such as state alarms.
NOTE:
◦ The necessary I/O features are already preconfigured in the master
templates.
◦ By default, non of the attributes are historized in the trend.
For more information about attribute configuration, refer to the ArchestrA IDE help.

Me Suffix of Attributes
The Me suffix in an attribute means that the attribute is owned by the object. That
is, the attribute does not come from the field.
Such attributes may point to another attribute of the same object; otherwise, they
are calculated based on various information coming from the field, operators, and
so on.

AO Attributes
The AO element in the syntax of an attribute means that the attribute is calculated.
Such attributes may be calculated by using scripts or by pointing to another
attribute of the same object for clarity and flexibility.

100 EIO0000004360.04
Common Configuration Pages Supervision Services

Scripts Page
Description
The Scripts page contains scripts associated with the object, for example:
• Script to summarize statuses.
• Script to calculate attributes.
• Script to evaluate abnormal conditions.
• Script to calculate references.
For more information about scripts, refer to the ArchestrA IDE help.
NOTE: This page does not require further configuration but you can add your
own scripts.

Object Information Page

Overview
The Object Information page provides general information about an object, its
configuration, and dependencies.

Object Description
The description that you enter in the Description field is displayed on the
faceplate of the object.
NOTE: You can enter descriptions in multiple languages, page 43.

EIO0000004360.04 101
Supervision Services

System and Device Integration Objects

What’s in This Part
$aAppEngineGP: Application Engine ............................................................. 103
$aAreaGP and $aAreaRootGP: Areas ........................................................... 105
$aOPCClientGP: OPC Client ........................................................................ 107
$aRedundantDIObjectGP: Redundant Communication Object
Diagnosis .................................................................................................... 109

Overview
This part describes system and device integration objects, and the diagnostic
functions that they provide.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

102 EIO0000004360.04
$aAppEngineGP: Application Engine Supervision Services

$aAppEngineGP: Application Engine

What’s in This Chapter
Supervision Functions ................................................................................. 103
Parameters................................................................................................. 103
Default State Alarms.................................................................................... 103
Graphic Representation ............................................................................... 104

Supervision Functions
Description
The $aAppEngineGP master template provides the following functions:
• Viewing and setting the scan state of the application engine.
• Viewing the application engine status.
• Viewing redundancy information and status.
• Alarm management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Parameters
Parameter Configuration
The default values of parameters of the $aAppEngineGP master template are the
same as those of the $aAppEngineGP template.
However, the $aAppEngineGP master template contains attributes and scripts,
which are configured to allow monitoring data related to the application engine.
The configurable parameters associated to attributes are described in this topic.

Default State Alarms

State Alarms for Application Engines
The table indicates for which attributes a state alarm is configured in the
$aAppEngineGP master template and provides the default values.

Attribute Alarm message Priority

Redundancy.AO.StandbyUnavailable.Condition Standby Unavailable 250

Redundancy.AO.StandbyNotReady.Condition Standby Not Ready 250

NOTE: You can modify the configuration from the Attributes page.

EIO0000004360.04 103
Supervision Services $aAppEngineGP: Application Engine

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $aAppEngineGP master
template to display data related to the application engine during operation.

Name Graphic symbol Description

Symbol Displays the application engine icon and to the right,

the instance name by using:
• Element style User_Defined_06 if Scan State is
set to On.
• Element style User_Defined_07 if Scan State is
set to Off.

104 EIO0000004360.04
$aAreaGP and $aAreaRootGP: Areas Supervision Services

$aAreaGP and $aAreaRootGP: Areas

What’s in This Chapter
Supervision Functions ................................................................................. 105
Parameters................................................................................................. 105
Default State Alarms.................................................................................... 106
Graphic Representation ............................................................................... 106

Supervision Functions
Description
The $aAreaGP and $aAreaRootGP master templates provide the following
functions:
• Viewing and setting the scan state for instances assigned to the area.
• Viewing the status of alarms for instances assigned to the area.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Parameters
Parameter Configuration
The default values of parameters of the $aAreaGP and $aAreaRootGP master
templates are the same as those of the $aAreaGP template.
However, the$aAreaGP and $aAreaRootGP master templates contain attributes
and scripts, which are configured to allow monitoring data related to the area.
The configurable parameters associated to attributes are described in this topic.
You can modify the parameter values in the derived application template or in its
instances.

Parameter Description
The table describes the parameters that are defined as part of the $aAreaGP and
$aAreaRootGP master template attributes.

Name Data type Initial Description

value
Param.EnablePESLink Boolean False
NOTE: The feature that you can configure by using this
parameter is not supported in this version of the library. This
Control Expert feature is only available when the object is
used.

EIO0000004360.04 105
Supervision Services $aAreaGP and $aAreaRootGP: Areas

Default State Alarms

State Alarms for Areas
No state alarms are configured for attributes of the $aAreaGP and $aAreaRootGP
master templates.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $aAreaGP and
$aAreaRootGP master templates to display data related to areas during
operation.

Name Graphic symbol Description

Symbol Displays the area icon and to the right, the instance
name by using:
• Element style User_Defined_06 if Scan State is
set to On.
• Element style User_Defined_07 if Scan State is
set to Off.

106 EIO0000004360.04
$aOPCClientGP: OPC Client Supervision Services

$aOPCClientGP: OPC Client

What’s in This Chapter
Supervision Functions ................................................................................. 107
Parameters................................................................................................. 107
Default State Alarms and Additional Alarm Conditions.................................... 107
Graphic Representation ............................................................................... 108

Supervision Functions
Description
The $aOPCClientGP master template provides the following functions:
• Viewing and setting the scan state of the OPC client.
• Viewing the connection and related alarm status.
• Viewing scan group information.
• Alarm management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Parameters
Parameter Configuration
The default values of parameters of the $aOPCClientGP master template are the
same as those of the $OPCClientGP template.
However, the $aOPCClientGP master template contains attributes and scripts,
which are configured to allow monitoring data related to the OPC client.
You can modify the configuration in the derived application template or in its
instances.
NOTE: No configurable parameters (attributes with the Param. prefix) are
associated to attributes of the $aOPCClientGP master template.

Default State Alarms and Additional Alarm Conditions

Overview
In the $aOPCClientGP master template, alarms related to core supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain parameters of the General page are associated to alarms.
You can manage the alarms from the alarms tab of the faceplate during operation.

EIO0000004360.04 107
Supervision Services $aOPCClientGP: OPC Client

State Alarms for OPC Clients

The table indicates for which attributes a state alarm is configured in the
$aOPCClientGP master template and provides the default values.

Attribute Alarm message Priority

AO.ScanGroupAlarm Off Scan Alarm 500

NOTE: You can modify the configuration from the Attributes page.

Additional Alarm Conditions for OPC Clients

The table indicates the parameters to which an alarm is associated by default in
the $aOPCClientGP master template.

Parameter Alarm message Priority

Detect connection alarm OPC Server Connection 250

NOTE: You can modify the configuration from the General page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $aOPCClientGP master
template to display data related to OPC clients during operation.

Name Graphic symbol Description

aOPCClientGP Displays the OPC client icon and to the right, the
instance name by using:
• Element style User_Defined_06 if Scan State is
set to On.
• Element style User_Defined_07 if Scan State is
set to Off.

108 EIO0000004360.04
$aRedundantDIObjectGP: Redundant Communication Object
Diagnosis Supervision Services

$aRedundantDIObjectGP: Redundant
Communication Object Diagnosis
What’s in This Chapter
Supervision Functions ................................................................................. 109
Parameters................................................................................................. 109
Default State Alarms and Additional Alarm Conditions.................................... 109
Graphic Representation ............................................................................... 110

Supervision Functions
Description
The $aRedundantDIObjectGP master template provides the following functions:
• Viewing the status of redundant communication objects (sources).
• Switching between primary and backup communication objects.
• Viewing the connection and related alarm status.
• Viewing scan group information.
• Alarm management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Parameters
Parameter Configuration
The default values of parameters of the $aRedundantDIObjectGP master
template are the same as those of the $aRedundantDIObjectGP template.
However, the $aRedundantDIObjectGP master template contains attributes and
scripts, which are configured to allow monitoring data related to redundant
communication objects.
You can modify the configuration in the derived application template or in its
instances.
NOTE: No configurable parameters (attributes with the Param. prefix) are
associated to attributes of the $aRedundantDIObjectGP master template.

Default State Alarms and Additional Alarm Conditions

Overview
In the$aRedundantDIObjectGP master template, alarms related to core
supervision functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain parameters of the General page are associated to alarms.

EIO0000004360.04 109
 $aRedundantDIObjectGP: Redundant Communication Object
Supervision Services Diagnosis

You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Redundant Communication Object Diagnosis

The table indicates for which attributes a state alarm is configured in the
$aRedundantDIObjectGP master template and provides the default values.

Attribute Alarm message Priority

AO.ConnectionAlarm OPC Server Connection 250

AO.ScanGroupAlarm Off Scan Alarm 500

AO.SwitchoverAlarm Switchover Alarm 500

NOTE: You can modify the configuration from the Attributes page.

Additional Alarm Conditions

By default, no additional alarm conditions are configured for the
$aRedundantDIObjectGP master template.
NOTE: You can modify the configuration from the General page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $aRedundantDIObjectGP
master template to display data related to redundant communication objects
during operation.

Name Graphic symbol Description

symbol Displays the redundant communication icon and to

the right, the name of the redundant communication
object being monitored (active source) by using:
• Element style User_Defined_06 if Scan State is
set to On.
• Element style User_Defined_07 if Scan State is
set to Off.

110 EIO0000004360.04
 Supervision Services

Signal Processing
What’s in This Part
$AnalogInputCE: Analog Inputs with Configurable Range ............................... 112
$AnalogOutputCE: Analog Outputs ............................................................... 118
$DigitalInputCE: Digital Inputs ....................................................................... 124
$DigitalOutputCE: Digital Outputs.................................................................. 129
$AnalogInMultiCE: Multiple Analog Inputs ...................................................... 133
$TotalCE: Totalizing Function ........................................................................ 138
$LoadCellENOD4TCE - Scaime Weighing Module ......................................... 144
$LoadCellPMESWTCE - Scaime weighing module ......................................... 152

Overview
This part describes the master templates that provide the supervision functions for
the signal processing family.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

EIO0000004360.04 111
Supervision Services $AnalogInputCE: Analog Inputs with Configurable Range

$AnalogInputCE: Analog Inputs with Configurable

Range
What’s in This Chapter
Supervision Functions ................................................................................. 112
Control/Supervision Relationship.................................................................. 112
Parameters................................................................................................. 113
Default State Alarms.................................................................................... 113
Graphic Representation ............................................................................... 114
Faceplates.................................................................................................. 115

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of analog inputs with configurable range.

Supervision Functions
Description
Core and optional resources provide the following monitoring and operation
functions:
• Main core functions encompass input monitoring, Override, Maintenance
mode, and the configuration of range-related parameters (in engineering
units).
• Optional alarm function allows you to monitor level setpoints (very-high, high,
low, and very-low) in engineering units, a setpoint used as a reference for
deviation alarm evaluation, and a setpoint indicating the maximum deviation
allowed (in engineering units).
You can activate/deactivate the detection of each alarm during operation.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxAnalogInput master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable Used for

name for DDT**
AINPUTGP Analog input with configurable AInputGP_ST_DDT <instance name>_ Core supervision
range logic AInputGP_ST functions.

AInputGP_CFG_DDT <instance name>_

AInputGP_CFG

AALARMGP Analog alarm logic AAlarmGP_CFG_DDT <instance name>_ Optional supervision

AAlarmGP_CFG functions.

AAlarmGP_ST_DDT <instance name>_

AAlarmGP_ST

** Mandatory variables to be defined.

112 EIO0000004360.04
$AnalogInputCE: Analog Inputs with Configurable Range Supervision Services

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$AnalogInputCE master template attributes.

Name Type Initial Description

value
Param. Bool False True = The description of the master template
ContainerDesc that contains a derivation of this template is
used.
NOTE: The parameter is only used when
the template is contained in another
template. For example, the
$MValvewithPosCE master template
contains a derivation of $AnalogInputCE.

Param.EngUnits String % Unit of the output value.

Param.NumFormat String 0.00 Specifies the display format of values.

For example, enter 0.00 to display 2 decimals.

Param. Integer 15 Refer to the description of this parameter that is

TrendPeriodMin documented for $AnalogInputCE.

NOTE: Param.EngUnits and Param.NumFormat will be generated by

Assetlins.

Default State Alarms

State Alarms for Analog Inputs With Configurable Range
The table indicates for which attributes a state alarm is configured in the
$AnalogInputCE master template and provides the default values.

Attribute Alarm message Priority

AInput1.St.AD Deviation 500

AInput1.St.AHH High High 250

AInput1.St.AH High 500

AInput1.St.AL Low 500

AInput1.St.ALL Low Low 250

AInput1.St.BadSt Bad Quality 250

EIO0000004360.04 113
Supervision Services $AnalogInputCE: Analog Inputs with Configurable Range

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $AnalogInputCE master
template to display data of analog inputs with configurable range during operation.

Name Graphic symbol Description

Bar_Horiz_PV Displays the label, a horizontal bar

with engineering units, and
present value (PV).

Bar_Horiz_PV_SP Displays the label, a horizontal bar

with engineering units, present
value (PV), and setpoint (SP).

Bar_Vert_PV Displays the label, a vertical bar

with engineering units, and
present value (PV).

Bar_Vert_PV_SP Displays the label, a vertical bar

with engineering units, present
value (PV), and setpoint (SP).

Bar_Vert_PV_SP_ Displays the label, a vertical bar

Trend with engineering units, present
value (PV), and setpoint (SP).

In addition, the symbol displays

trends and allows you to select the
trend period in minutes. Refer to
the description of the Param.
TrendPeriodMin parameter of the
master template.

114 EIO0000004360.04
$AnalogInputCE: Analog Inputs with Configurable Range Supervision Services

Name Graphic symbol Description

Bar_Vert_PV_Trend Displays the label, a vertical bar

with engineering units, and
present value (PV).

In addition, the symbol displays

trends and allows you to select the
trend period in minutes. Refer to
the description of the Param.
TrendPeriodMin parameter of the
master template.

Indicator_PV Displays the label, engineering

units, and present value (PV).

Indicator_PV_SP Displays the label, engineering

units, present value (PV), and
setpoint (SP).

Label Displays the ObjectTagName,

StaticText and
CustomPropertyLabel.

NOTE: The optional alarm, setpoint, and deviation levels appear in bar graphs
only when enabled in the operation tab of the faceplate. At the same time, the
corresponding trends are also displayed in symbols, which feature a trend
panel.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an analog input symbol opens a faceplate with the
following tabs:
• Operation with optional analog alarm management section.
• Engineering
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

EIO0000004360.04 115
Supervision Services $AnalogInputCE: Analog Inputs with Configurable Range

Operation Tab
The figure shows an example of the Operation tab.

The En check boxes allow you to enable or disable the evaluation of level alarms
at the controller level. Select or unselect the corresponding check box and click
Apply.

Engineering Tab
The figure shows an example of the Engineering tab.

NOTE: This tab features the Simulation menu, which allows setting the
control module to simulation mode.
In addition, the tab may feature another menu or text field, which allows you to
configure the state or value to be simulated.
Enabling the simulation mode underlies a security classification, page 89. The
default configuration is tune. It also triggers the display of an abnormal state,
page 46 on the tab and on the symbol.

116 EIO0000004360.04
$AnalogInputCE: Analog Inputs with Configurable Range Supervision Services

NOTE: Input Value: If external PV is enable from the control, then input value
is equal to external PV. If external PV is disable from the control, then input
value is equal to channel value.

EIO0000004360.04 117
Supervision Services $AnalogOutputCE: Analog Outputs

$AnalogOutputCE: Analog Outputs

What’s in This Chapter
Supervision Functions ................................................................................. 118
Control/Supervision Relationship.................................................................. 118
Parameters................................................................................................. 119
Default State Alarms.................................................................................... 119
Graphic Representation ............................................................................... 119
Faceplates.................................................................................................. 122

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of analog outputs.

Supervision Functions
Description
Core and optional resources provide the following monitoring and operation
functions:
• Main core functions encompass setpoint management, owner selection,
simulation mode, resetting, and global bypassing of interlock conditions.
• Optional functions encompass a local panel and individual interlock condition
management.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxAnalogOutput master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable Used for

name for DDT**
AOUTPUTGP Analog output logic AOutputGP_ST_DDT <instance name>_ Core supervision
AOGP_ST functions.

AOutputGP_CFG_DDT <instance name>_

AOGP_CFG

AOUTPUTLPGP Local panel for analog outputs AOutputLPGP_ST_DDT <instance name>_ Optional supervision
AOLPGP_ST functions.

ILCKONGP Interlock condition summary ILCKGP_ST_DDT <instance

name>ILockOn_ST

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

118 EIO0000004360.04
$AnalogOutputCE: Analog Outputs Supervision Services

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$AnalogOutputCE master template attributes.

Parameter Type Default Description

Param.EngUnits String % Engineering unit of attributes.

Param.HiOP Float 100.0 High limit for the output value.

Param.LoOP Float 0.0 Low limit for the output value.

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.0 Specifies the displaying format of values.

For example, enter 0.00 for 2 decimals.

Param. Integer 0 Refer to the description of this parameter that is

TrendPeriodMin documented for $AnalogOutputCE.

Default State Alarms

State Alarms for Analog Outputs
The table indicates for which attributes a state alarm is configured in the
$AnalogOutputCE master template and provides the default values.

Attribute Alarm message Priority

AOutput.St.BadSt Channel Failure 500

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

EIO0000004360.04 119
Supervision Services $AnalogOutputCE: Analog Outputs

Three-Way Valve Symbol Naming Convention

For analog outputs represented as three-way valve symbols, the naming
convention is as follows:
Valve type_Valve orientation_Inlet position_Port normally open.
For example, V3V_Horiz_Down_Left means:
• Three-way valve.
• Shown horizontally.
• Inlet positioned downwards.
• The left-hand port is normally open.

Three-Way Valve Symbol Graphic Convention

For operator convenience, the graphic convention for analog outputs represented
as three-way valve symbols is as follows:
• The inlet is shown fully filled independently of the position of the valve.
• The area of the outlets that is shown filled gives an indication of the position
of the valve. The filled area shows approximately how much each port is
open.
The example shows a V3V_Horiz_Left_Down symbol representing a three-way
valve 60% open. The normally open Down port is shown 40% filled (40% open)
and the normally closed Right port 60% filled (60% open).

Representation
In addition to icons, the symbols display:
• The label.
• The trend client icon to open the trends faceplate.
• A bar graph showing the setpoint and the present valve position.
• The setpoint value with engineering units.
• States, shown in a square, page 48.
• The owner mode if it is detected as an abnormal situation, page 46.
The table describes the symbols that are included in the $AnalogOutputCE master
template to display data of analog outputs as two-way valves during operation.

120 EIO0000004360.04
$AnalogOutputCE: Analog Outputs Supervision Services

Name Graphic symbol Description

V2V_Horiz Two-way control valve shown

horizontally

V2V_Vert_Left Two-way control valve shown vertically

V2V_Vert_Right Two-way control valve shown vertically

Label Displays the ObjectTagName,

StaticText and
CustomPropertyLabel.

NOTE: For two-way valve symbols, both ports are shown fully filled as soon
as the setpoint > 0.
The table describes the symbols that are included in the $AnalogOutputCE master
template to display data of analog outputs as three-way valves during operation.

Name Graphic symbol

V3V_Horiz_Down_Left

V3V_Horiz_Down_Right

V3V_Horiz_Left_Down

V3V_Horiz_Left_Right

EIO0000004360.04 121
Supervision Services $AnalogOutputCE: Analog Outputs

Name Graphic symbol

V3V_Horiz_Right_Down

V3V_Horiz_Right_Left

V3V_Vert_Down_Right

V3V_Vert_Down_Up

V3V_Vert_Right_Down

V3V_Vert_Right_Up

V3V_Vert_Up_Down

V3V_Vert_Up_Right

Faceplates
Overview
During operation, clicking the graphic symbol allows you to display a faceplate
with the following tabs:
• Standard tabs:
◦ Operation with optional local panel, page 64
◦ Engineering
◦ Alarms, page 75
• Optional tab:
◦ Interlocks, page 65

122 EIO0000004360.04
$AnalogOutputCE: Analog Outputs Supervision Services

NOTE: The master template also features the trends faceplate.

Operation Tab
The figure shows an example of the Operation tab.

Engineering Tab
The figure shows an example of the Engineering tab.

NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.

EIO0000004360.04 123
Supervision Services $DigitalInputCE: Digital Inputs

$DigitalInputCE: Digital Inputs

What’s in This Chapter
Supervision Functions ................................................................................. 124
Control/Supervision Relationship.................................................................. 124
Parameters................................................................................................. 125
Default State Alarms.................................................................................... 125
Graphic Representation ............................................................................... 126
Faceplates.................................................................................................. 127

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of digital inputs.

Supervision Functions
Description
Core and optional resources provide the following monitoring and operation
functions:
• Main core functions encompass setpoint management, alarm configuration,
enabling/disabling of alarm, and simulation mode.
• Optional functions allow you to track operating hours and switching
operations.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxDigitalInput master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable Used for

name for DDT**
DINPUTGP Digital input DInputGP_ST_DDT <instance name>_ Core supervision
DInputGP_ST functions.

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

124 EIO0000004360.04
$DigitalInputCE: Digital Inputs Supervision Services

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the $DigitalInputCE
master template attributes.

Parameter Type Initial Description

value
Param. Bool True If true, the alarm evaluation at the supervision
AlarmEnable level is enabled.

If false, the alarm evaluation at the supervision

level is disabled.
NOTE: The alarm signal is not interpreted as
an alarm at the supervision level but it
continues being evaluated at the controller
level. It is useful for signals to be monitored
but not associated to an alarm.
Param. Bool True If true, the diagnostic status of the channel,
BadStEnable indicated by the Channel Failure alarm, is
enabled.

If false, the diagnostic status of the channel is

disabled.
Param. Bool False True = The description of the master template that
ContainerDesc contains a derivation of this template is used.
NOTE: The parameter is only used when the
template is contained in another template.
For example, the $MValveCE master
template contains a derivation of
$DigitalInputCE.

Default State Alarms

State Alarms for Digital Inputs
The table indicates for which attributes a state alarm is configured in the
$DigitalInputCE master template and provides the default values.

Attribute Alarm message Priority

AO.Alarm Digital Alarm 999

AO.BadSt Channel Failure 500

NOTE: You can modify the configuration from the Attributes page.

EIO0000004360.04 125
Supervision Services $DigitalInputCE: Digital Inputs

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Description
This table describes the symbols available for representing the digital inputs:

Name Graphic symbol Description

AlarmText Alarm text

Arrow_H Arrow with the label

above

Arrow_V Arrow with the label on

the right

Bullet_H Bullet with the label above

Bullet_V Bullet with the label on the

right

EmergencyStop_H Stop button with the label

above

EmergencyStop_V Stop button with the label

on the right

PressureLimit Pressure limit switch

ElectricalSwitch_H_ Electrical switch

Thin represented horizontally

ElectricalSwitch_V_ Electrical switch

Thin represented vertically

126 EIO0000004360.04
$DigitalInputCE: Digital Inputs Supervision Services

Name Graphic symbol Description

TemperatureLimit Temperature limit switch

Label Displays the

ObjectTagName,
StaticText and
CustomPropertyLabel.

Faceplates
Overview
During operation, clicking the graphic symbol allows you to display a faceplate
with the following tabs:
• Standard tabs:
◦ Operation
◦ Engineering
◦ Alarms, page 75
• Optional tab:
◦ Maintenance, page 70

Operation Tab
The figure shows an example of the Operation tab.

The En check box allows you to enable/disabe the evaluation of the alarm at the
controller level.

EIO0000004360.04 127
Supervision Services $DigitalInputCE: Digital Inputs

Engineering Tab
The figure shows an example of the Engineering tab.

NOTE: This tab features the Simulation menu, which allows setting the
control module to simulation mode.
In addition, the tab may feature another menu or text field, which allows you to
configure the state or value to be simulated.
Enabling the simulation mode underlies a security classification, page 89. The
default configuration is tune. It also triggers the display of an abnormal state,
page 46 on the tab and on the symbol.
NOTE: Input Value: Indicates the channel value.

128 EIO0000004360.04
$DigitalOutputCE: Digital Outputs Supervision Services

$DigitalOutputCE: Digital Outputs

What’s in This Chapter
Supervision Functions ................................................................................. 129
Control/Supervision Relationship.................................................................. 129
Parameters................................................................................................. 130
Default State Alarms.................................................................................... 130
Graphic Representation ............................................................................... 130
Faceplates.................................................................................................. 131

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of digital outputs.

Supervision Functions
Description
Core and optional resources provide the following monitoring and operation
functions:
• Main core functions encompass owner selection, setpoint management,
global bypassing of interlock conditions.
• Optional functions encompass individual interlock condition management,
tracking of operating hours and switching operations.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxDigitalOutput master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable Used for

name for DDT**
DOUTPUTGP Digital output DOutputGP_ST_DDT <instance name>_ Core supervision
DOGP_ST functions.

DEVMNTGP Maintenance. DevMNTGP_ST_DDT <instance name>_ Optional supervision

MNTGP_ST functions.

ILCKONGP Interlock condition summary ILCKGP_ST_DDT <instance

name>ILCKGP_ST

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

EIO0000004360.04 129
Supervision Services $DigitalOutputCE: Digital Outputs

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Default Description

Param. String O,P,C Specifies the normal owner modes (separated by a

ModeNormal comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Default State Alarms

State Alarms for Digital Outputs
The table indicates for which attributes a state alarm is configured in the
$DigitalOutputCE master template and provides the default values.

Attribute Alarm message Priority

DOutput.St.BadSt Channel Failure 500

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Description
This table describes the symbols available for representing the digital outputs:

130 EIO0000004360.04
$DigitalOutputCE: Digital Outputs Supervision Services

Name Graphic symbol Description

Electrical_Switch_H_Thin Electrical switch represented

horizontally

Electrical_Switch_V_Thin Electrical switch represented vertically

StatusIndicator_H Status indicator with the label above

StatusIndicator_V Status indicator with the label on the

right

Label Displays the ObjectTagName,

StaticText and
CustomPropertyLabel.

Faceplates
Overview
During operation, clicking the graphic symbol allows you to display a faceplate
with the following tabs:
• Standard tabs:
◦ Operation
◦ Engineering
◦ Alarms, page 75
• Optional tab:
◦ Interlocks, page 65
◦ Maintenance, page 70

EIO0000004360.04 131
Supervision Services $DigitalOutputCE: Digital Outputs

Operation Tab
The figure shows an example of the Operation tab.

Engineering Tab
The figure shows an example of the Engineering tab.

NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.

132 EIO0000004360.04
$AnalogInMultiCE: Multiple Analog Inputs Supervision Services

$AnalogInMultiCE: Multiple Analog Inputs

What’s in This Chapter
Supervision Functions ................................................................................. 133
Control/Supervision Relationship.................................................................. 133
Parameters................................................................................................. 134
Default State Alarms.................................................................................... 134
Graphic Representation ............................................................................... 135
Faceplates.................................................................................................. 136

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of multiple analog inputs (up to 4) with configurable
range.

Supervision Functions
Description
Core resources provide the following monitoring and operation functions:
• Monitoring of up to four analog inputs
• Owner selection
• Simulation mode
• Configuration of parameters: High/Low Range, Bad PV, Cut Off values
• Selection of one input signal based on one of these predefined criteria:
◦ First present value
◦ Direct selection of input signal
◦ Median
◦ Average
◦ Minimum
◦ Maximum
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxMAnalogInput1
master template is configured to exchange data with the following control resource
of the Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable Used for

name for DDT**
MAInputGP Multiple analog inputs MAInputGP_ST <instance name>_ Core supervision
MAInGP_ST functions.

MAInputGP_CFG <instance name>_

MAInGP_CFG

EIO0000004360.04 133
Supervision Services $AnalogInMultiCE: Multiple Analog Inputs

Control resource Description DDT name** Syntax of variable Used for

name for DDT**
AALARMGP Analog alarm AAlarmGP_CFG_DDT <instance name>_ Optional supervision
AAlarmGP_CFG functions.

AAlarmGP_ST_DDT <instance name>_

AAlarmGP_ST

** Mandatory variables to be defined.

For description of the control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$AnalogInMultiCE master template attributes.

Parameter Type Default Description

Param.EngUnits String % Defines the engineering unit of attributes.

Param.ModeNormal String O,P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.00 Specifies the display format of values.

For example, enter 0.00 to display 2 decimals.

Param. Integer 15 Refer to the description of this parameter that is

TrendPeriodMin documented for $AnalogInputCE.

Default State Alarms

State Alarms for Multiple Analog Inputs
The table indicates for which attributes a state alarm is configured in the
$AnalogInMultiCE master template and provides the default values.

Attribute Alarm message Priority

MAInput1.Cfg.PV1Fail PV1 Channel Failure 250

MAInput1.Cfg.PV2Fail PV2 Channel Failure 250

MAInput1.Cfg.PV3Fail PV3 Channel Failure 250

134 EIO0000004360.04
$AnalogInMultiCE: Multiple Analog Inputs Supervision Services

Attribute Alarm message Priority

MAInput1.Cfg.PV4Fail PV4 Channel Failure 250

MAInput1.St.BadSt Selected Channel Failure 250

MAInput1.St.DevAlm Deviation Fail 500

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
The table describes the symbols that are included in the $AnalogInMultiCE master
template to display data of multiple analog inputs during operation.

Name Graphic symbol Description

Bar_Horiz_PV Displays the label, a horizontal bar

with engineering units, and present
value (PV).

Bar_Vert_PV Displays the label, a vertical bar with

engineering units, and present value
(PV).

Bar_Vert_PV_ Displays the label, a vertical bar with

Trend engineering units, and present value
(PV).

In addition, the symbol displays

trends and allows you to select the
trend period in minutes. Refer to the
description of the Param.
TrendPeriodMin parameter of the
master template.

Indicator_PV Displays the label, engineering units,

and present value (PV).

Label Displays the ObjectTagName,

StaticText and
CustomPropertyLabel.

EIO0000004360.04 135
Supervision Services $AnalogInMultiCE: Multiple Analog Inputs

Faceplates
Overview
During operation, clicking the graphic symbol allows you to display a faceplate
with the following tabs:
• Standard tabs:
◦ Operation
◦ Engineering
◦ Alarms, page 75
NOTE: The master template also features the trends faceplate.

Operation Tab

The Selection drop-down list allows you to select the following input signal:
• First present value
• Present value 1
• Present value 2
• Present value 3
• Present value 4
• Median
• Average
• Minimum
• Maximum

136 EIO0000004360.04
$AnalogInMultiCE: Multiple Analog Inputs Supervision Services

Engineering Tab

NOTE: This tab features the Simulation menu, which allows setting the
control module to simulation mode.
In addition, the tab may feature another menu or text field, which allows you to
configure the state or value to be simulated.
Enabling the simulation mode underlies a security classification, page 89. The
default configuration is tune. It also triggers the display of an abnormal state,
page 46 on the tab and on the symbol.

EIO0000004360.04 137
Supervision Services $TotalCE: Totalizing Function

$TotalCE: Totalizing Function

What’s in This Chapter
Supervision Functions ................................................................................. 138
Control/Supervision Relationship.................................................................. 138
Parameters................................................................................................. 139
Default State Alarms.................................................................................... 140
Graphic Representation ............................................................................... 141
Faceplates.................................................................................................. 142

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of totalizing function.

Supervision Functions
Description
The $TotalCE master template provides the following monitoring and operation
functions:
• Core functions:
◦ Command management.
◦ Owner selection.
◦ Totalizing.
◦ Monitoring.
◦ State Management
• Optional functions:
◦ Viewing, bypassing, and resetting of abnormal conditions.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxTotal master template
is configured to exchange data with the following control resources of the Modicon
Libraries - General Purpose for Control Expert.

138 EIO0000004360.04
$TotalCE: Totalizing Function Supervision Services

Control resource Description DDT name** Syntax of variable Used for

name for DDT**
TotalGP Totalizer. TotalGP_ST_DDT <instance name>_ Core supervision
TotalGP_ST functions.

TotalGP_CFG_DDT <instance name>_

TotalGP_CFG

CONDSUMGP Detected failure condition CondsumGP_ST_DDT <instance name>_ Optional supervision

summary. CondsumOnGP_ST functions.

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the $TotalCE
master template attributes.

Name Data Initial Description

type value

Param.EngUnits String EU Defines the engineering unit of attributes.

Param.HiPV Double 999999- Defines the high limit of the present value to
999.0 scale the Y axis for trending.

Param. Bool False If true, the Hold button is not displayed.

HideHoldButton
If false, the Hold button is displayed.

Param. Bool False If true, the Reset button is not displayed.

HideResetButton
If false, the Reset button is displayed.

Param. Bool False If true, the Restart button is not displayed.

HideRestartBut-
ton If false, the Restart button is displayed.

Param. Bool False If true, the Start button is not displayed.

HideStartButton
If false, the Start button is displayed.

Param. Bool False If true, the Stop button is not displayed.

HideStopButton
If false, the Stop button is displayed.

Param.LoPV Double 0 Defines the low limit of the present value to

scale the Y axis for trending.

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated

by a comma):
• O: Operator
• P: Program
• C: Cascade

EIO0000004360.04 139
Supervision Services $TotalCE: Totalizing Function

Name Data Initial Description

type value

For example P,C.

Param. String I,R,H,S Specifies the normal operating states

TotalModeNormal (separated by a comma):
• I: Idle
• R: Running
• H: Held
• S: Stopped
For example I,R,S.

Param.NumFormat String 0.0 Specifies the display format of values.

For example, enter 0.00 to display 2 decimals.

Param. Integer 15 The parameter has two functions:

TrendPeriodMin
• It defines the trend period in minutes that
is used by default.
• When you enter a value that is different
from one of the five predefined values (5,
15, 30, 60, 120, which are displayed below
the trend graph), your value replaces the
120 value.
For example, if you enter 45, the values
that are displayed below symbols featuring
a trend panel, page 114 are (from left to
right) 45, 60, 30, 15, and 5.
Range: 1...10080. (10080 = 1 week)
NOTE: If the initial value is 0, the trend
period that is used becomes 15 minutes
but the predefined values that are
displayed are unchanged.

Param. Boolean False

NOTE: The features that you can configure
EnablePESLink
by using these parameters are not
Param. String Blank supported in this version of the library.
PESExecutionDo- These Control Expert features are only
mainId available when the object is used.

Param. String Blank

PESProjectId

Param. String Blank

PESSystemId

Default State Alarms

State Alarms for TOTAL
The table indicates an attribute for which a state alarm is configured in the
$TotalCE master template and provides the default values.

Attribute Alarm message Priority

Total.St.Alarm Failure detected while totalizing 999

NOTE: You can modify the configuration from the Attributes page.

140 EIO0000004360.04
$TotalCE: Totalizing Function Supervision Services

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $TotalCE master
template to display data of analog inputs during operation.

Name Graphic symbol Description

PanelWithButtons_PV_SP Graphic symbol displays(from

top to bottom):
• The label.
• Engineering units.
• To the right, a horizontal
bar showing the present
value and the setpoint.
• The present value.
• The setpoint value.
• The current state of the
totalizer.
• Control buttons
PanelWithButtons_PV Graphic symbol displays(from
top to bottom):
• The label.
• Engineering units.
• To the right, a horizontal
bar showing the present
value.
• The present value.
• The current state of the
totalizer.
• Control buttons
Numeric_PV_SP Graphic symbol displays(from
top to bottom):
• The label.
• Engineering units.
• The present value.
• The setpoint value.

Numeric_PV Graphic symbol displays(from

top to bottom):
• The label.
• Engineering units.
• The present value.

Bar_Vert_PV_SP Graphic symbol displays(from

top to bottom):
• The label.
• Engineering units.
• A vertical bar showing the
setpoint and the present
value.
• The present value.
• The setpoint value.

EIO0000004360.04 141
Supervision Services $TotalCE: Totalizing Function

Name Graphic symbol Description

Bar_Vert_PV_SP_Trend Displays in addition to data of

Bar_Vert_PV_SP, a trend panel
with configurable trend period in
minutes. Refer to the
description of the Param.
TrendPeriodMin parameter.

Bar_Horz_PV_SP Graphic symbol displays(from

top to bottom):
• The label.
• Engineering units.
• To the right, a horizontal
bar showing the setpoint
and the present value.
• The present value.
• The setpoint value.

Label Displays the ObjectTagName,

StaticText and
CustomPropertyLabel.

NOTE:
• The trends are displayed in the Bar_Vert_PV_SP_Trend symbol which
feature a trend panel.
• When AUTOSTART input pin is high in unity, the start button disappears.This
is applicable for Operator selection in faceplate also.
• When AUTORESET input pin is high in unity, the reset button disappears.This
is applicable for Operator selection in faceplate also.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking the graphic symbol opens a faceplate with the following
tabs:
• Tabs for core functions:
◦ Operation
◦ Alarms, page 75
• Tabs for optional functions, which appear only if configured:
◦ Detected failures, page 68

142 EIO0000004360.04
$TotalCE: Totalizing Function Supervision Services

Operator Tab
The figure shows an example of the Operation tab.

NOTE: The Operator tab features the control module Acknowledge button.
This button is used to acknowledge the rollover indication (Rollover flag) in the
control module.

EIO0000004360.04 143
Supervision Services $LoadCellENOD4TCE - Scaime Weighing Module

$LoadCellENOD4TCE - Scaime Weighing Module

What’s in This Chapter
Supervision Function ................................................................................... 144
Control/Supervision Relationship.................................................................. 144
Default State Alarms.................................................................................... 144
Graphic Representation ............................................................................... 145
Faceplate ................................................................................................... 145

This chapter describes the supervision resources and runtime services that are
available for the management of $LoadCellENOD4TCE - Scaime Weighing
Module.

Supervision Function
Core resources provide monitoring and operation functions. Weighing functions
like Zero, Tare, Preset tare, cancel tare, Device reset, Factory reset, diagnostic
information management, resetting, owner selection.
These functions are implemented in runtime through a symbol and its associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $LoadCellENOD4TCE
master template is configured to exchange data with the following control
resources of the Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable Used for

name for DDT**
ENOD4TEIPGP Scaime Enod4T LoadCell ENOD4TEIPGP_ST_DDT <instance name>_ Core supervision
ENOD4TGP_ST functions.

ENOD4TEIPGP_CFG_ <instance name>_

DDT ENOD4TGP_CFG

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Default State Alarms

The table indicates for which attributes a state alarm is configured in the
$LoadCellENOD4TCE template and provides the default values:

Attribute Alarm message Priority

AO.Namur.CheckFunction Function check 750

AO.Namur.Failure Failure 500
AO.Namur.MaintenanceR Maintenance Required 999

AO.Namur.OutOfSpecs Out Of Specs 999

144 EIO0000004360.04
$LoadCellENOD4TCE - Scaime Weighing Module Supervision Services

Graphic Representation
Graphical Representation
The various types of symbols available in this template are illustrated in the table:

Sr No. Name Graphic Symbol Description

1 Enod4T Device Status:

Namur Alarms

Faceplate
During operation, clicking the graphic symbol allows you to display a faceplate
with the following tabs:
• Operation
• Analog Data
• Discrete Data
• Alarms

Operator Tab
The figure shows the operator tab.

This tab provides information about the operator actions and the device
information:

Item Description

1 This section provides information about the device Communication and

device status.
2 This section provides information about the latest alarms and alerts
generated.

EIO0000004360.04 145
Supervision Services $LoadCellENOD4TCE - Scaime Weighing Module

Item Description

3 This section allows the operator to change the mode from Program
mode to Operator mode or vice versa.

4 This section allows the operator to execute various weighing commands

like Zero, Tare, Device Reset. This section also provides the current
Device status.
NOTE: Command combo becomes active only when it is in
Operator mode.

5 This section displays the major weighing measurements like Gross, Net
and Flow measurements.

NOTE: Command combo becomes active only when it is in Operator mode.

146 EIO0000004360.04
$LoadCellENOD4TCE - Scaime Weighing Module Supervision Services

Analog Tab
This tab provides information about the analog data of the device:
Analog Tab 1: Provides information of Weighing measurements like Gross & Net
measurements.

EIO0000004360.04 147
Supervision Services $LoadCellENOD4TCE - Scaime Weighing Module

Analog Tab 2: Provides information of detected Failure and Alerts codes.

148 EIO0000004360.04
$LoadCellENOD4TCE - Scaime Weighing Module Supervision Services

Discrete Tab
This tab provides information about the digital data of the device:
Digital Tab 1: Provides information about the current device status

EIO0000004360.04 149
Supervision Services $LoadCellENOD4TCE - Scaime Weighing Module

Digital Tab 2: Provide the Input channel status of eNod4T Module

150 EIO0000004360.04
$LoadCellENOD4TCE - Scaime Weighing Module Supervision Services

Digital Tab 3: Provide the Output channel status of eNod4T Module

Alarm Tab
Refer to Alarms Tab, page 75.

EIO0000004360.04 151
Supervision Services $LoadCellPMESWTCE - Scaime weighing module

$LoadCellPMESWTCE - Scaime weighing module

What’s in This Chapter
Supervision Function ................................................................................... 152
Control/Supervision Relationship.................................................................. 152
Default State Alarms.................................................................................... 152
Graphic Representation ............................................................................... 153
Faceplate ................................................................................................... 153

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of $LoadCellPMESWTCE - Scaime Weighing
Module.

Supervision Function
Core resources provide monitoring and operation functions. Weighing functions
like Zero, Tare, Preset tare, cancel tare, Device reset, Factory reset, diagnostic
information management, resetting, owner selection.
These functions are implemented in runtime through a symbol and its associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $LoadCellPMESWTCE
master template is configured to exchange data with the following control
resources of the Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable Used for

name for DDT**
PMESWTGP Scaime PMEWTSWT PMESWTGP_ST_DDT <instance name>_ Core supervision
Weighing Module PMESWTGP_ST functions.

PMESWTGP_CFG_DDT <instance name>_

PMESWTGP_CFG

T_WEIGHING_PMESWT_ <instance name>_

ST ModuleConfig

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Default State Alarms

The table indicates for which attributes a state alarm is configured in the
$LoadCellPMESWTCE template and provides the default values:

152 EIO0000004360.04
$LoadCellPMESWTCE - Scaime weighing module Supervision Services

Attribute Alarm message Priority

AO.Namur.CheckFunction Function check 750

AO.Namur.Failure Failure 500
AO.Namur.MaintenanceR Maintenance Required 999

AO.Namur.OutOfSpecs Out Of Specs 999

Graphic Representation
Graphical Representation
The various types of symbols available in this template are illustrated in the table:

Sr No. Name Graphic Symbol Description

1 Genie Device Status:

Namur Alarms

Faceplate
During operation, clicking the graphic symbol allows you to display a faceplate
with the following tabs:
• Operation
• Analog Data
• Discrete Data
• Alarms

Operator Tab
The figure shows the operator tab.

EIO0000004360.04 153
Supervision Services $LoadCellPMESWTCE - Scaime weighing module

This tab provides information about the operator actions and the device
information:

Item Description

1 This section provides information about the device Communication and

operation status.

2 This section provides information about the latest alarms and alerts
generated.

3 This section allows the operator to change the mode from Program
mode to Operator mode or vice versa.

4 This section allows the operator to execute various weighing commands

like Zero, Tare, Preset Tare and also allows the operator to specify the
Preset tare value in prior to executing Preset Tare command. This
section also provides the current Device status

5 This section displays the major weighing measurements like Gross, Net
and Flow measurements.

154 EIO0000004360.04
$LoadCellPMESWTCE - Scaime weighing module Supervision Services

The figure shows the extended operator tab

Item Description

6 This section allows the user to perform Dosing functions

NOTE: Command combo becomes active only when it is in Operator mode.

Analog Tab
This tab provides information about the analog data of the device:
Analog Tab 1: Provides information about
• Weighing measurements like Gross, Net,Flow
• Set points of Preset Tare Value
• Dosing set points like Coarse feed cut-off point and Fine feed cut-off points
and
• Few Monitoring timers.

EIO0000004360.04 155
Supervision Services $LoadCellPMESWTCE - Scaime weighing module

Analog Tab 2: Provides information of Detected Failure and Alerts codes.

156 EIO0000004360.04
$LoadCellPMESWTCE - Scaime weighing module Supervision Services

Discrete Tab
This tab provides information about the digital data of the device:
Digital Tab 1: Provides information about the current device status

Digital Tab 2: Provide the digital Input channel status of PMESWT0100 Module

EIO0000004360.04 157
Supervision Services $LoadCellPMESWTCE - Scaime weighing module

Digital Tab 3: Provide the digital Output channel status of PMESWT0100 Module

Alarm Tab
Refer to Alarms Tab, page 75.

158 EIO0000004360.04
 Supervision Services

On/Off Device Control

What’s in This Part
$HandValveCE: Hand Valves ........................................................................ 160
$MotorCE: On/Off Motor ............................................................................... 164
$Motor2DirCE: 2-Speed/2-Rotation-Direction Motors ...................................... 171
$MValveCE: Discrete Motorized Valves ......................................................... 177
$DualOPValveCE: Dual Output Valves........................................................... 183
$ValveCE: On/Off Valves .............................................................................. 190

Overview
This part describes the master templates that provide the supervision functions for
the on/off device control family.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

EIO0000004360.04 159
Supervision Services $HandValveCE: Hand Valves

$HandValveCE: Hand Valves

What’s in This Chapter
Supervision Functions ................................................................................. 160
Control/Supervision Relationship.................................................................. 160
Parameters................................................................................................. 160
Default State Alarms.................................................................................... 161
Graphic Representation ............................................................................... 161
Faceplates.................................................................................................. 162

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of hand valves.

Supervision Functions
Description
Core resources provide the following monitoring and operation functions:
Simulation mode and setpoint management.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxHandValve master
template is configured to exchange data with the following control resource of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of Used for

variable name
for DDT**
HVALVEGP Hand valve logic HValveGP_ST_ <instance Core supervision functions.
DDT name>_
HValveGP_ST

** Mandatory variables to be defined.

For description of the control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

Parameters
Parameter Configuration
There are no configurable parameters for hand valves.

160 EIO0000004360.04
$HandValveCE: Hand Valves Supervision Services

Default State Alarms

State Alarms for Hand Valves
The table indicates for which attributes a state alarm is configured in the
$HandValveCE master template and provides the default values.

Attribute Alarm message Priority

HValve.AO.PosFail Unknown Position 750

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available for representing the hand valve:

Name Graphic Description

symbol

V2V_Horiz Horizontal two-way valve

V2V_Vert Vertical two-way valve

V3V_Horiz_Down_ Horizontal three-way valve

Left
(down to left way when closed, down to right way
when open)

V3V_Horiz_Down_ Horizontal three-way valve

Right
(down to right way when closed, down to left way
when open)

V3V_Horiz_Left_ Horizontal three-way valve

Down
(left to down way when closed, left to right way when
open)

V3V_Horiz_Left_ Horizontal three-way valve

Right
(left to right way when closed, left to down way when
open)

V3V_Horiz_Right_ Horizontal three-way valve

Down
(right to down way when closed, right to left way
when open)

V3V_Horiz_Right_ Horizontal three-way valve

Left
(right to left way when closed, right to down way
when open)

EIO0000004360.04 161
Supervision Services $HandValveCE: Hand Valves

Name Graphic Description

symbol

V3V_Vert_Down_ Vertical three-way valve

Right
(down to right way when closed, down to up way
when open)

V3V_Vert_Down_Up Vertical three-way valve

(down to up way when closed, down to right way

when open)

V3V_Vert_Right_ Vertical three-way valve

Down
(right to down way when closed, right to up way
when open)

V3V_Vert_Right_Up Vertical three-way valve

(right to up way when closed, right to down way

when open)

V3V_Vert_Up_Down Vertical three-way valve

(up to down way when closed, up to right way when

open)

V3V_Vert_Up_Right Vertical three-way valve

(up to right way when closed, up to down way when

open)

Label Displays the ObjectTagName, StaticText and

CustomPropertyLabel.

Faceplates
Overview
During operation, clicking the graphic symbol opens a faceplate with the following
tabs:
• Standard tabs:
◦ Operation
◦ Engineering
◦ Alarms, page 75

162 EIO0000004360.04
$HandValveCE: Hand Valves Supervision Services

Operation Tab
The figure shows an example of the Operation tab.

Engineering Tab
The figure shows an example of the Engineering tab.

NOTE: This tab features the Simulation menu, which allows setting the
control module to simulation mode.
In addition, the tab may feature another menu or text field, which allows you to
configure the state or value to be simulated.
Enabling the simulation mode underlies a security classification, page 89. The
default configuration is tune. It also triggers the display of an abnormal state,
page 46 on the tab and on the symbol.

EIO0000004360.04 163
Supervision Services $MotorCE: On/Off Motor

$MotorCE: On/Off Motor

What’s in This Chapter
Supervision Functions ................................................................................. 164
Control/Supervision Relationship.................................................................. 164
Parameters................................................................................................. 165
Default State Alarms.................................................................................... 166
Graphic Representation ............................................................................... 166
Faceplates.................................................................................................. 168

Overview
This chapter describes the $MotorCE master template, which contains
supervision resources to monitor and operate 1-speed/1-rotation-direction on/off
motors.

Supervision Functions
Description
The $MotorCE master template provides the following monitoring and operation
functions:
• Core functions:
◦ Status monitoring.
◦ Owner selection.
◦ Simulation mode.
◦ Resetting.
◦ Global bypassing of interlock conditions.
• Optional functions:
◦ Operation from a local panel.
◦ Viewing, bypassing, and resetting of individual interlock conditions and
abnormal conditions.
◦ Tracking of operating hours and switching operations.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxMotor master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

164 EIO0000004360.04
$MotorCE: On/Off Motor Supervision Services

Control resource Description DDT name** Syntax of variable Used for

name for DDT**
MOTORGP On/off device logic. MotorGP_ST_DDT <instance name>_ Core supervision
MotorGP_ST functions.

DEVMNTGP On/off device maintenance. DevMNTGP_ST_DDT <instance name>_ Optional supervision

MotMNTGP_ST functions.

MOTORLPGP Local panel for on/off MotorLPGP_ST_DDT <instance name>_

devices. MotLPGP_ST

CONDSUMGP Detected failure condition CondsumGP_ST_DDT <instance name>_

summary. CondsumGP_ST

ILCKONGP Interlock condition summary. ILCKGP_ST_DDT <instance name>_

ILockOn1_ST

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $MotorCE
master template attributes.

Name Data Initial Description

type value

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

EIO0000004360.04 165
Supervision Services $MotorCE: On/Off Motor

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.
Param. Boolean False When manual resetting of interlock conditions is
IlckRearmConfir- enabled:
mation
• False = After you click the Reset button on
the faceplate during operation and have
successfully validated the command
according to the configured security
classification, resets the control logic with no
additional confirmation being required.
• True = After you click the Reset button on
the faceplate during operation, displays a
dialog box, which requires that you confirm
the reset command. The control logic is
reset only by clicking OK and validating the
command according to the configured
security classification. By default, the
security classification is secured write.

Default State Alarms

State Alarms for On/Off Motor
The table indicates for which attributes a state alarm is configured in the
$MotorCE master template and provides the default values.

Attribute Alarm message Priority

Devctl.AO.Alarm Confirmation Failure 999

Devctl.AO.PosFail Unknown Position 750
Devctl.St.Faild Device Failure 500

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $MotorCE master
template to display data of 1-speed/1-rotation direction on/off motors during
operation.

166 EIO0000004360.04
$MotorCE: On/Off Motor Supervision Services

Name Graphic symbol Description

Blower_Left Left blower

Blower_Right Right blower

Motor_Down Motor down

Motor_Left Motor left

Motor_Right Motor right

Motor_Up Motor up

Pump_Left Left pump

Pump_Right Right pump

RotaryValve Rotary valve

ScrewPump_Left Screw pump left

ScrewPump_Right Screw pump right

Label Displays the

ObjectTagName, StaticText
and CustomPropertyLabel.

EIO0000004360.04 167
Supervision Services $MotorCE: On/Off Motor

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an on/off motor symbol opens a faceplate with the
following tabs:
• Tabs for core functions:
◦ Operation with optional local panel, page 64
◦ Engineering
◦ Alarms, page 75
• Tabs for optional functions, which appear only if configured:
◦ Interlocks, page 65
◦ Failures, page 68
◦ Maintenance, page 70

Operation Tab
The figure shows an example of the Operation tab.

168 EIO0000004360.04
$MotorCE: On/Off Motor Supervision Services

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

Engineering Tab
The figure shows an example of the Engineering tab.

WARNING
LOSS OF CONTROL AND UNINTENDED EQUIPMENT OPERATION
Before switching the monitored device back into service:
• Verify the current setpoint of the monitored device.
• Confirm the current status of the process.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.

EIO0000004360.04 169
Supervision Services $MotorCE: On/Off Motor

NOTE: This tab features the Simulation menu, which allows setting the
control module to simulation mode.
In addition, the tab may feature another menu or text field, which allows you to
configure the state or value to be simulated.
Enabling the simulation mode underlies a security classification, page 89. The
default configuration is tune. It also triggers the display of an abnormal state,
page 46 on the tab and on the symbol.
NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.
NOTE: This tab features the Service menu, which allows setting the control
module out of service.
When the control menu is set back into service by selecting In Service in the
Service menu, the current setpoint that is shown in the operation tab of the
faceplate is effective.
Setting the control module out of service underlies a security classification,
page 89. The default configuration is tune. It also triggers the display of an
abnormal state, page 46 on the tab and on the symbol.

170 EIO0000004360.04
$Motor2DirCE: 2-Speed/2-Rotation-Direction Motors Supervision Services

$Motor2DirCE: 2-Speed/2-Rotation-Direction Motors

What’s in This Chapter
Supervision Functions ................................................................................. 171
Control/Supervision Relationship.................................................................. 171
Parameters................................................................................................. 172
Default State Alarms.................................................................................... 173
Graphic Representation ............................................................................... 173
Faceplates.................................................................................................. 174

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of 2-speed/2-rotation-direction motors.

Supervision Functions
Description
Core and optional resources provide the following monitoring and operation
functions:
• Main core functions encompass status monitoring, owner selection,
simulation mode, resetting, rotation direction, and global bypassing of
interlock conditions.
• Optional functions encompass a local panel, individual interlock condition and
diagnostic information management, tracking of operating hours and
switching operations.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxMotor2 master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control Description DDT name** Syntax of variable Used for

resource name for DDT**
MOTOR2GP 2 speed/2 rotation direction motor logic Motor2GP_ST_DDT <instance name>_ Core supervision
Motor2GP_ST functions.

DEVMNTGP On/off device maintenance DevMNTGP_ST_DDT <instance name>_ Optional supervision

MotMNTGP_ST functions.

MOTOR2LPGP Local panel for controlling 2-speed/2- Motor2LPGP_ST_ <instance name>_

rotation direction motors DDT MTR2LPGP_ST

CONDSUMGP Detected failure condition summary, CondsumGP_ST_DDT <instance name>_

there are 3 cases: Condsum_ST
• No detected failure condition
summary
• One for both speed and direction
(naming convention <...
>_CONDSUM_<...>)

EIO0000004360.04 171
Supervision Services $Motor2DirCE: 2-Speed/2-Rotation-Direction Motors

Control Description DDT name** Syntax of variable Used for

resource name for DDT**
• One for Speed1/Direct (naming
convention <...>_CONDSUM_
<...>) and one for Speed2/
Reverse (naming convention
<...>_RC_CONDSUM_<...>)

ILCKONGP Forward interlock condition ILCKGP_ST_DDT <instance name>_

FWDILCKGP_ST

Reverse interlock condition <instance name>_

REVILCKGP_ST

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $Motor2DirCE
master template attributes.

Parameter Data Initial Description

type value

Param. Bool False If true, the container description is used.

ContainerDesc
If false, the container description is not used.
NOTE: This parameter is used for object
contained by another object, for example
$MValveCE.M2.
Param.ModeNormal String O,P,C Specifies the normal owner modes (separated
by a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

172 EIO0000004360.04
$Motor2DirCE: 2-Speed/2-Rotation-Direction Motors Supervision Services

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.
Param. Boolean False When manual resetting of interlock conditions is
IlckRearmConfir- enabled:
mation
• False = After you click the Reset button on
the faceplate during operation and have
successfully validated the command
according to the configured security
classification, resets the control logic with no
additional confirmation being required.
• True = After you click the Reset button on
the faceplate during operation, displays a
dialog box, which requires that you confirm
the reset command. The control logic is
reset only by clicking OK and validating the
command according to the configured
security classification. By default, the
security classification is secured write.

Default State Alarms

State Alarms for 2-Speed/2-Rotation-Direction Motors
The table indicates for which attributes a state alarm is configured in the
$Motor2DirCE master template and provides the default values.

Attribute Alarm message Priority

Motor2.St.Alarm1 Confirmation Failure 1 999

Motor2.St.Alarm2 Confirmation Failure 2 999
Motor2.AO.PosFail Unknown Position 750
Motor2.St.Faild1 Device Failure 1 500
Motor2.St.Faild2 Device Failure 2 500

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

EIO0000004360.04 173
Supervision Services $Motor2DirCE: 2-Speed/2-Rotation-Direction Motors

Representation
This table describes the symbols available for representing the 2-speed/2-rotation
direction motors:

Name Graphic symbol Description

Motor_Direction_Down Down vertical motor with 2 rotation

directions

Motor_Direction_Left Left horizontal motor with 2 rotation

directions

Motor_Direction_Right Right horizontal motor with 2 rotation

directions

Motor_Direction_Up Up vertical motor with 2 rotation

directions

Motor_Speed_Down Down vertical motor with 2 speeds

Motor_Speed_Left Left horizontal motor with 2 speeds

Motor_Speed_Right Right horizontal motor with 2 speeds

Motor_Speed_Up Up vertical motor with 2 speeds

Label Displays the ObjectTagName,

StaticText and CustomPropertyLabel.

Faceplates
Overview
During operation, clicking the graphic symbol opens a faceplate with the following
tabs:
• Standard tabs:
◦ Operation with optional local panel, page 64
◦ Engineering
◦ Alarms, page 75
• Optional tabs:
◦ Interlocks, page 65
◦ Failures , page 68
◦ Maintenance, page 70

174 EIO0000004360.04
$Motor2DirCE: 2-Speed/2-Rotation-Direction Motors Supervision Services

Operation Tab
The figure shows an example of the Operation tab.

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

EIO0000004360.04 175
Supervision Services $Motor2DirCE: 2-Speed/2-Rotation-Direction Motors

Engineering Tab
The figure shows an example of the Engineering tab.

WARNING
LOSS OF CONTROL AND UNINTENDED EQUIPMENT OPERATION
Before switching the monitored device back into service:
• Verify the current setpoint of the monitored device.
• Confirm the current status of the process.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.

NOTE: This tab features the Simulation menu, which allows setting the
control module to simulation mode.
In addition, the tab may feature another menu or text field, which allows you to
configure the state or value to be simulated.
Enabling the simulation mode underlies a security classification, page 89. The
default configuration is tune. It also triggers the display of an abnormal state,
page 46 on the tab and on the symbol.
NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.
NOTE: This tab features the Service menu, which allows setting the control
module out of service.
When the control menu is set back into service by selecting In Service in the
Service menu, the current setpoint that is shown in the operation tab of the
faceplate is effective.
Setting the control module out of service underlies a security classification,
page 89. The default configuration is tune. It also triggers the display of an
abnormal state, page 46 on the tab and on the symbol.

176 EIO0000004360.04
$MValveCE: Discrete Motorized Valves Supervision Services

$MValveCE: Discrete Motorized Valves

What’s in This Chapter
Supervision Functions ................................................................................. 177
Control/Supervision Relationship.................................................................. 177
Parameters................................................................................................. 178
Default State Alarms.................................................................................... 179
Graphic Representation ............................................................................... 179
Faceplates.................................................................................................. 181

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of discrete motorized valves.

Supervision Functions
Description
Core and optional resources provide the following monitoring and operation
functions:
• Main core functions encompass status monitoring, owner selection, resetting,
setpoint management, and global bypassing of interlock conditions.
• Optional functions encompass a local panel, and individual interlock condition
and diagnostic information management.
These functions are implemented in runtime through symbols and their associated
faceplate.
NOTE: The discrete motorized valve template includes three contained
objects:
• $MValveCE.M2: motor management (a derived template of
$Motor2DirCE, page 171 with interlock and detected failure conditions
enabled by default, and the parameter Param.ContainerDesc
enabled)
• $MValveCE.ZSH: high limit switch management (a derived template of
$DigitalInputCE, page 124 with the parameter Param.ContainerDesc
enabled)
• $MValveCE.ZSL: low limit switch management (a derived template of
$DigitalInputCE, page 124 with the parameter Param.ContainerDesc
enabled)

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxMotorizedValveD
master template is configured to exchange data with the following control
resources of the Modicon Libraries - General Purpose for Control Expert.

EIO0000004360.04 177
Supervision Services $MValveCE: Discrete Motorized Valves

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
MVALVEDGP Discrete motorized valve MValveDGP_ST_DDT <instance name>_ Core supervision
logic. MVDGP_ST functions.

CONDSUMGP Detected failure condition CondsumGP_ST_DDT <instance name>_ Optional supervision

summary. Condsum_ST functions.

DEVMNTGP On/off device DevMNTGP_ST_DDT <instance name>_

maintenance. VLVMNTGP_ST

MVALVEDLPGP Local panel for controlling MValveDLPGP_ST_DDT <instance name>_

discrete motorized valves. MVDLPGP_ST

ILCKONGP Open interlock condition. ILCKGP_ST_DDT <instance name>_

OPNILCKGP_ST

Close interlock condition ILCKGP_ST_DDT <instance name>_

CLSILCKGP_ST

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $MValveCE
master template attributes.

Parameter Data Initial Description

type value

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

178 EIO0000004360.04
$MValveCE: Discrete Motorized Valves Supervision Services

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.
Param. Boolean False When manual resetting of interlock conditions is
IlckRearmConfir- enabled:
mation
• False = After you click the Reset button on
the faceplate during operation and have
successfully validated the command
according to the configured security
classification, resets the control logic with no
additional confirmation being required.
• True = After you click the Reset button on
the faceplate during operation, displays a
dialog box, which requires that you confirm
the reset command. The control logic is
reset only by clicking OK and validating the
command according to the configured
security classification. By default, the
security classification is secured write.

Default State Alarms

State Alarms for Discrete Motorized Valves
The table indicates for which attributes a state alarm is configured in the
$MValveCE master template and provides the default values.

Attribute Alarm message Priority

MValveD.St.Alarm1 Open Confirmation Fail 999

MValveD.St.Alarm2 Closed Confirmation Fail 999

MValveD.AO.PosFail Unknown Position 750
MValveD.St.Faild Device Failure 500

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

EIO0000004360.04 179
Supervision Services $MValveCE: Discrete Motorized Valves

Representation
This table describes the symbols available for representing the discrete motorized
valves:

Name Graphic symbol Description

V2V_Horiz Horizontal valve

V2V_Vert Vertical valve

PenStockV Penstock valve (Open position)

PenStockV Penstock valve (Intermediate position)

PenStockV Penstock valve (Closed position)

Label Displays the ObjectTagName,

StaticText and CustomPropertyLabel.

NOTE: The discrete motorized valve symbol is composed of four symbols:

• Valve
• Motor
• High limit switch
• Low limit switch
Navigation to display the related faceplate of contained objects motor and limit
switches are provided on main faceplate of discrete motorised valves.

180 EIO0000004360.04
$MValveCE: Discrete Motorized Valves Supervision Services

Faceplates
Overview
During operation, clicking the graphic symbol opens a faceplate with the following
tabs:
• Standard tabs:
◦ Operation with optional local panel, page 64
◦ Engineering
◦ Alarms, page 75
• Optional tabs:
◦ Interlocks, page 65
NOTE: Navigation to display the related faceplate of contained objects motor
and limit switches are provided on main faceplate of discrete motorised
valves.

Operation Tab
The figure shows an example of the Operation tab.

EIO0000004360.04 181
Supervision Services $MValveCE: Discrete Motorized Valves

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

Engineering Tab
The figure shows an example of the Engineering tab.

NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.

182 EIO0000004360.04
$DualOPValveCE: Dual Output Valves Supervision Services

$DualOPValveCE: Dual Output Valves

What’s in This Chapter
Supervision Functions ................................................................................. 183
Control/Supervision Relationship.................................................................. 183
Parameters................................................................................................. 184
Default State Alarms.................................................................................... 185
Graphic Representation ............................................................................... 185
Faceplates.................................................................................................. 187

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of dual output valves.

Supervision Functions
Description
Core and optional resources provide the following monitoring and operation
functions:
• Main core functions encompass status monitoring, owner selection, resetting,
setpoint management, simulation mode, and global bypassing of interlock
conditions.
• Optional functions encompass tracking of operating hours and switching
operations, individual interlock condition and diagnostic information
management.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxDualOutputValve
master template is configured to exchange data with the following control
resources of the Modicon Libraries - General Purpose for Control Expert.

EIO0000004360.04 183
Supervision Services $DualOPValveCE: Dual Output Valves

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
DVALVEGP Dual ouput valve logic. DValveGP_ST_DDT <instance name>_ Core supervision
DValveGP_ST functions.

CONDSUMGP Detected failure condition CondsumGP_ST_DDT <instance name>_ Optional supervision

summary. Condsum_ST functions.

DEVMNTGP On/off device DevMNTGP_ST_DDT <instance name>_

maintenance. VLVMNTGP_ST

DVALVELPGP Local panel for controlling DValveLPGP_ST_DDT <instance name>_

dual output valves. DVLVLPGP_ST

ILCKONGP Open interlock condition. ILCKGP_ST_DDT <instance name>_

OPNILCKGP_ST

Close interlock condition ILCKGP_ST_DDT <instance name>_

CLSILCKGP_ST

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template prefix or in its instances. You can access the parameters from
the Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the
$DualOPValveCE master template attributes.

Parameter Data Initial Description

type value

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

184 EIO0000004360.04
$DualOPValveCE: Dual Output Valves Supervision Services

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.
Param. Boolean False When manual resetting of interlock conditions is
IlckRearmConfir- enabled:
mation
• False = After you click the Reset button on
the faceplate during operation and have
successfully validated the command
according to the configured security
classification, resets the control logic with no
additional confirmation being required.
• True = After you click the Reset button on
the faceplate during operation, displays a
dialog box, which requires that you confirm
the reset command. The control logic is
reset only by clicking OK and validating the
command according to the configured
security classification. By default, the
security classification is secured write.

Default State Alarms

State Alarms for Dual Output Valves
The table indicates for which attributes a state alarm is configured in the
$DualOPValveCE master template and provides the default values.

Attribute Alarm message Priority

DVALVE.ST.AlarmH Open Confirmation Fail 999

DVALVE.ST.AlarmL Close Confirmation Fail 999

DVALVE.ST.FAILD Device failure 500

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available for representing the dual output valves:

EIO0000004360.04 185
Supervision Services $DualOPValveCE: Dual Output Valves

Name Graphic symbol Description

V2V_Horiz Horizontal two-way valve

V2V_Vert Vertical two-way valve

V2V_Butterfly_Vert_ Vertical butterfly with control on the left

Left

V2V_Butterfly_Vert_ Vertical butterfly with control on the right

Right

V3V_Horiz_Down_Left Horizontal three-way valve

(down to left way when closed, down to

right way when open)

V3V_Horiz_Down_Right Horizontal three-way valve

(down to right way when closed, down to

left way when open)

V3V_Horiz_Left_Down Horizontal three-way valve

(left to down way when closed, left to

right way when open)

V3V_Horiz_Left_Right Horizontal three-way valve

(left to right way when closed, left to

down way when open)

V3V_Horiz_Right_Down Horizontal three-way valve

(right to down way when closed, right to

left way when open)

V3V_Horiz_Right_Left Horizontal three-way valve

(right to left way when closed, right to

down way when open)

V3V_Vert_Down_Right Vertical three-way valve

(down to right way when closed, down to

up way when open)

186 EIO0000004360.04
$DualOPValveCE: Dual Output Valves Supervision Services

Name Graphic symbol Description

V3V_Vert_Down_Up Vertical three-way valve

(down to up way when closed, down to

right way when open)

V3V_Vert_Right_Down Vertical three-way valve

(right to down way when closed, right to

up way when open)

V3V_Vert_Right_Up Vertical three-way valve

(right to up way when closed, right to

down way when open)

V3V_Vert_Up_Down Vertical three-way valve

(up to down way when closed, up to right

way when open)

V3V_Vert_Up_Right Vertical three-way valve

(up to right way when closed, up to down

way when open)

Label Displays the ObjectTagName,

StaticText and CustomPropertyLabel.

Faceplates
Overview
During operation, clicking the graphic symbol opens a faceplate with the following
tabs:
• Standard tabs:
◦ Operation
◦ Engineering
◦ Alarms, page 75
• Optional tabs:
◦ Interlocks, page 65
◦ Failures, page 68
◦ Maintenance, page 70

EIO0000004360.04 187
Supervision Services $DualOPValveCE: Dual Output Valves

Operation Tab
The figure shows an example of the Operation tab.

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

188 EIO0000004360.04
$DualOPValveCE: Dual Output Valves Supervision Services

Engineering Tab
The figure shows an example of the Engineering tab.

WARNING
LOSS OF CONTROL AND UNINTENDED EQUIPMENT OPERATION
Before switching the monitored device back into service:
• Verify the current setpoint of the monitored device.
• Confirm the current status of the process.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.

NOTE: This tab features the Simulation menu, which allows setting the
control module to simulation mode.
In addition, the tab may feature another menu or text field, which allows you to
configure the state or value to be simulated.
Enabling the simulation mode underlies a security classification, page 89. The
default configuration is tune. It also triggers the display of an abnormal state,
page 46 on the tab and on the symbol.
NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.
NOTE: This tab features the Service menu, which allows setting the control
module out of service.
When the control menu is set back into service by selecting In Service in the
Service menu, the current setpoint that is shown in the operation tab of the
faceplate is effective.
Setting the control module out of service underlies a security classification,
page 89. The default configuration is tune. It also triggers the display of an
abnormal state, page 46 on the tab and on the symbol.

EIO0000004360.04 189
Supervision Services $ValveCE: On/Off Valves

$ValveCE: On/Off Valves

What’s in This Chapter
Supervision Functions ................................................................................. 190
Control/Supervision Relationship.................................................................. 190
Parameters................................................................................................. 191
Default State Alarms.................................................................................... 191
Graphic Representation ............................................................................... 191
Faceplates.................................................................................................. 193

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of on/off valves.

Supervision Functions
Description
Core and optional resources provide the following monitoring and operation
functions:
• Main core functions encompass status monitoring, owner selection,
simulation mode, resetting, and global bypassing of interlock conditions.
• Optional functions encompass a local panel, individual interlock condition
management, tracking of operating hours and switching operations.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxValve master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable Used for

name for DDT**
VALVEGP On/off device logic ValveGP_ST_DDT <instance name>_ Core supervision functions.
ValveGP_ST

DEVMNT On/off device DevMNTGP_ST_DDT <instance name>_ Optional supervision

maintenance VlvMNTGP_ST functions.

VALVELPGP Local panel for on/off ValveLPGP_ST_DDT <instance name>_

valves VlvLPGP_ST

ILCKONGP Interlock condition ILCKGP_ST_DDT <instance name>_

summary ILockOn_ST

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

190 EIO0000004360.04
$ValveCE: On/Off Valves Supervision Services

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Default Description

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Default State Alarms

State Alarms for On/Off Valves
The attributes for which a state alarm is configured in the $ValveCE master
template are the same as for $MotorCE.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available for representing the on/off valves:

Name Graphic symbol Description

V2V_Butterfly_Vert_ Vertical butterfly with control on the left

Left

V2V_Butterfly_Vert_ Vertical butterfly with control on the right

Right

EIO0000004360.04 191
Supervision Services $ValveCE: On/Off Valves

Name Graphic symbol Description

V2V_Horiz Horizontal two-way valve

V2V_Vert Vertical two-way valve

V3V_Horiz_Down_Left Horizontal three-way valve

(down to left way when closed, down to right

way when open)

V3V_Horiz_Down_Right Horizontal three-way valve

(down to right way when closed, down to left

way when open)

V3V_Horiz_Left_Down Horizontal three-way valve

(left to down way when closed, left to right way

when open)

V3V_Horiz_Left_Right Horizontal three-way valve

(left to right way when closed, left to down way

when open)

V3V_Horiz_Right_Down Horizontal three-way valve

(right to down way when closed, right to left

way when open)

V3V_Horiz_Right_Left Horizontal three-way valve

(right to left way when closed, right to down

way when open)

V3V_Vert_Down_Right Vertical three-way valve

(down to right way when closed, down to up

way when open)

V3V_Vert_Down_Up Vertical three-way valve

(down to up way when closed, down to right

way when open)

V3V_Vert_Right_Down Vertical three-way valve

(right to down way when closed, right to up

way when open)

V3V_Vert_Right_Up Vertical three-way valve

(right to up way when closed, right to down

way when open)

V3V_Vert_Up_Down Vertical three-way valve

(up to down way when closed, up to right way

when open)

192 EIO0000004360.04
$ValveCE: On/Off Valves Supervision Services

Name Graphic symbol Description

V3V_Vert_Up_Right Vertical three-way valve

(up to right way when closed, up to down way

when open)

Label Displays the ObjectTagName, StaticText and

CustomPropertyLabel.

Faceplates
Overview
During operation, clicking the graphic symbol opens a faceplate with the following
tabs:
• Standard tabs:
◦ Operation with optional local panel, page 64
◦ Engineering
◦ Alarms, page 75
• Optional tabs:
◦ Interlocks, page 65
◦ Failures, page 68
◦ Maintenance, page 70
NOTE: The same faceplate is used for on/off motor and on/off valve.

Operation Tab
The figure shows an example of the Operation tab.

EIO0000004360.04 193
Supervision Services $ValveCE: On/Off Valves

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

Engineering Tab
The figure shows an example of the Engineering tab.

WARNING
LOSS OF CONTROL AND UNINTENDED EQUIPMENT OPERATION
Before switching the monitored device back into service:
• Verify the current setpoint of the monitored device.
• Confirm the current status of the process.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.

194 EIO0000004360.04
$ValveCE: On/Off Valves Supervision Services

NOTE: This tab features the Simulation menu, which allows setting the
control module to simulation mode.
In addition, the tab may feature another menu or text field, which allows you to
configure the state or value to be simulated.
Enabling the simulation mode underlies a security classification, page 89. The
default configuration is tune. It also triggers the display of an abnormal state,
page 46 on the tab and on the symbol.
NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.
NOTE: This tab features the Service menu, which allows setting the control
module out of service.
When the control menu is set back into service by selecting In Service in the
Service menu, the current setpoint that is shown in the operation tab of the
faceplate is effective.
Setting the control module out of service underlies a security classification,
page 89. The default configuration is tune. It also triggers the display of an
abnormal state, page 46 on the tab and on the symbol.

EIO0000004360.04 195
Supervision Services

Analog Device Control

What’s in This Part
$ControlValveCE: Control Valves .................................................................. 197
$MValvewithPosCE: Motorized Valve With Feedback...................................... 204
$MotorVSCE: Devices with Variable Speed Drive ........................................... 210

Overview
This part describes the master templates that provide the supervision functions for
the analog device control family.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

196 EIO0000004360.04
$ControlValveCE: Control Valves Supervision Services

$ControlValveCE: Control Valves

What’s in This Chapter
Supervision Functions ................................................................................. 197
Control/Supervision Relationship.................................................................. 197
Parameters................................................................................................. 198
Default State Alarms.................................................................................... 198
Graphic Representation ............................................................................... 199
Faceplates.................................................................................................. 201

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of control valves.

Supervision Functions
Description
Core and optional resources provide the following monitoring and operation
functions:
• Main core functions encompass status monitoring, owner selection,
simulation mode, position indication (current setpoint, position output, current
valve position, in engineering units), and global bypassing of interlock
conditions.
• Optional functions encompass a local panel and individual interlock condition
management.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxControlValve master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
CVALVEGP Control valve CValveGP_ST_DDT <instance name>_ Core supervision
CValveGP_ST functions.

CValveGP_CFG_DDT <instance name>_

CValveGP_CFG

CVALVELPGP Local panel for controlling CValveLPGP_ST_DDT <instance name>_ Optional supervision
control valves CVlvLPGP_ST functions.

ILCKONGP Interlock condition ILCKGP_ST_DDT <instance name>_

summary ILockOn_ST

** Mandatory variables to be defined.

EIO0000004360.04 197
Supervision Services $ControlValveCE: Control Valves

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template prefix or in its instances. You can access the parameters from
the Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Default Description

Param.EngUnits String % Unit of the present value

Param.HiPV Float 100.0 High limit for the present value

Param.LoPV Float 0.0 Low limit for the present value

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated

by a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.0 Specifies the displaying format of setpoint.

For example, enter 0.00 for 2 decimal.

Param. Integer 0 Specifies the default trend period in minutes.

TrendPeriodMin

Default State Alarms

State Alarms for Control Valves
The table indicates for which attributes a state alarm is configured in the
$ControlValveCE master template and provides the default values.

Attribute Alarm message Priority

CValve.St.Alarm Position Failure 500

CValve.St.ChinFailure Input Channel Failure 500

CValve.St.ChoutFailure Output Channel Failure 500

CValve.St.Fail Device Failure 500

NOTE: You can modify the configuration from the Attributes page.

198 EIO0000004360.04
$ControlValveCE: Control Valves Supervision Services

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Three-Way Valve Symbol Naming Convention

For three-way control valve symbols, the naming convention is as follows:
Valve type_Valve orientation_Inlet position_Port normally open.
For example, V3V_Horiz_Left_Down means:
• Three-way valve.
• Shown horizontally.
• Inlet positioned left-hand side.
• The down port is normally open.

Using Limit Switches with Control Valves

You can configure the control valve object to monitor limit switches. By default, bits
11 and 12 of the CVALVE_ST.STW status word are used. These are parameters
ZSLPOS and ZSHPOS respectively.
In such case, the symbol:
• Uses the over-range element style to show both outlet ports fully filled (open)
if both limit switch signals are true.
• Shows either outlet port fully filled (open) when the corresponding limit switch
signal is true, independently of the actual valve position. For example, if
ZSLPOS for a V3V_Horiz_Left_Down symbol is true, the down port (normally
open) is shown fully filled (open) even if PV indicates 25%. In this case, the
down port would normally be shown 75% filled.

Two-Way Valve Symbol Graphic Convention

For operator convenience, the graphic convention for two-way control valve
symbols indicates the limit switch signals.
Both valve ports are filled depending on the signals transmitted by the limit
switches:
• If ZSLPOS is true (closed state), the valve ports are shown not filled (white).
• If ZSHPOS is true (open state), both valve ports are shown fully filled.
• If there is no limit switch signal or if both signals are true, both valve ports are
shown fully filled (open state).
NOTE: The valve position is indicated by the bar graph and the numerical
value.

Three-Way Valve Symbol Graphic Convention

For operator convenience, the graphic convention for three-way control valve
symbols is as follows:
• The inlet is shown fully filled independently of the position of the valve.

EIO0000004360.04 199
Supervision Services $ControlValveCE: Control Valves

• The area of the outlets that is shown filled gives an indication of the position
of the valve. The filled area shows approximately how much each port is
open.
The example shows a V3V_Horiz_Left_Down symbol representing a three-way
valve with a position 60% open. The normally open Down port is shown 40% filled
(40% open) and the normally closed Right port 60% filled (60% open).

Representation
In addition to icons, symbols display:
• The label.
• The trend client icon to open the trends faceplate.
• A bar graph showing the present valve position.
• The value of the present valve position with engineering units.
• States, shown in a square, page 48.
• The owner mode if it is detected as an abnormal situation, page 46.
The table describes the symbols that are included in the $ControlValveCE master
template to display data of two-way control valves during operation.

Name Graphic symbol Description

V2V_Horiz Horizontal two-way valve

V2V_Vert_Left Vertical two-way valve

V2V_Vert_Right Vertical two-way valve

Label Displays the ObjectTagName, StaticText and

CustomPropertyLabel.

NOTE:
The table describes the symbols that are included in the $ControlValveCE master
template to display data of three-way control valves during operation.

Name Graphic symbol

V3V_Horiz_Down_Left

V3V_Horiz_Down_Right

200 EIO0000004360.04
$ControlValveCE: Control Valves Supervision Services

Name Graphic symbol

V3V_Horiz_Left_Down

V3V_Horiz_Left_Right

V3V_Horiz_Right_Down

V3V_Horiz_Right_Left

V3V_Vert_Down_Right

V3V_Vert_Down_Up

V3V_Vert_Right_Down

V3V_Vert_Right_Up

V3V_Vert_Up_Down

V3V_Vert_Up_Right

Faceplates
Overview
During operation, clicking the graphic symbol opens a faceplate with the following
tabs:
• Standard tabs:
◦ Operation with optional local panel, page 64
◦ Engineering
◦ Alarms, page 75

EIO0000004360.04 201
Supervision Services $ControlValveCE: Control Valves

• Optional tabs:
◦ Interlocks, page 65
◦ Failures, page 68
◦ Maintenance, page 70
NOTE: The master template also features the trends faceplate.

Operation Tab
The figure shows an example of the Operation tab.

This table describes the SetPoint button functions in Operator owner mode:

Button Description

Large decrement of the setpoint value (-5)

Small decrement of the setpoint value (-1)

Small increment of the setpoint value (+1)

Large increment of the setpoint value (+5)

202 EIO0000004360.04
$ControlValveCE: Control Valves Supervision Services

Engineering Tab
The figure shows an example of the Engineering tab.

NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.

EIO0000004360.04 203
Supervision Services $MValvewithPosCE: Motorized Valve With Feedback

$MValvewithPosCE: Motorized Valve With Feedback

What’s in This Chapter
Supervision Functions ................................................................................. 204
Control/Supervision Relationship.................................................................. 204
Parameters................................................................................................. 205
Default State Alarms.................................................................................... 206
Graphic Representation ............................................................................... 206
Faceplates.................................................................................................. 207

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of motorized valves with feedback.

Supervision Functions
Description
Core and optional resources provide the following monitoring and operation
functions:
• Main core functions encompass status monitoring, owner selection, three-
step controller functions, resetting, and global bypassing of interlock
conditions.
• Optional functions encompass a local panel, individual interlock condition and
diagnostic information management, tracking of operating hours and
switching operations.
These functions are implemented in runtime through symbols and their associated
faceplate.
NOTE: The motorized valve template includes four contained objects:
• $MValvewithPosCE.AI: analog input management (a derived template of
$AnalogInputCE, page 112 with alarms disabled and the parameter
Param.ContainerDesc enabled)
• $MValveCE.M2: motor management (a derived template of
$Motor2DirCE, page 171 with interlock and detected failure conditions
enabled by default, and the parameter Param.ContainerDesc
enabled)
• $MValveCE.ZSH: high limit switch management (a derived template of
$DigitalInputCE, page 124 with the parameter Param.ContainerDesc
enabled)
• $MValveCE.ZSL: low limit switch management (a derived template of
$DigitalInputCE, page 124 with the parameter Param.ContainerDesc
enabled)

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxMotorizedValve
master template is configured to exchange data with the following control
resources of the Modicon Libraries - General Purpose for Control Expert.

204 EIO0000004360.04
$MValvewithPosCE: Motorized Valve With Feedback Supervision Services

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
MVALVEGP Motorized valve without MValveGP_ST_DDT <instance name>_ Core supervision
feedback logic MValveGP_ST functions.

MValveGP_CFG_DDT <instance name>_

MValveGP_CFG

MVALVELPGP Local panel for controlling MValveLPGP_ST_DDT <instance name>_ Optional supervision
motorized valves MVlvLPGP_ST functions.

DEVMNTGP On/off device DevMNTGP_ST_DDT <instance name>_

maintenance VLVMNTGP_ST

ILCKONGP Interlock condition ILCKGP_ST_DDT <instance name>_

summary ILockOn_ST

CONDSUMGP Detected failure condition CondsumGP_ST_DDT <instance name>_

summary. Condsum_ST

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the
$MValvewithPosCE master template attributes.

Parameter Data Initial Description

type value

Param.EngUnits String % Unit of the present value

Param.HiPV Float 100.0 High limit for the present value.

Param.LoPV Float 0.0 Low limit for the present value.

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.0 Specifies the displaying format of setpoint.

For example, enter 0.00 for 2 decimal.

EIO0000004360.04 205
Supervision Services $MValvewithPosCE: Motorized Valve With Feedback

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.
Param. Boolean False When manual resetting of interlock conditions is
IlckRearmConfir- enabled:
mation
• False = After you click the Reset button on
the faceplate during operation and have
successfully validated the command
according to the configured security
classification, resets the control logic with no
additional confirmation being required.
• True = After you click the Reset button on
the faceplate during operation, displays a
dialog box, which requires that you confirm
the reset command. The control logic is
reset only by clicking OK and validating the
command according to the configured
security classification. By default, the
security classification is secured write.

Default State Alarms

State Alarms for Motorized Valves
The table indicates for which attributes a state alarm is configured in the
$MValvewithPosCE master template and provides the default values.

Attribute Alarm message Priority

MValve.St.Alarm Auxiliary Device Fail 999

MValve.St.PMIS Position Mismatch 999

MValve.AO.PosFail Unknown Position 750
MValve.St.Faild Switching Operation Fault 500

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

206 EIO0000004360.04
$MValvewithPosCE: Motorized Valve With Feedback Supervision Services

Representation
This table describes the symbols available for representing the motorized valves
with feedback

Name Graphic symbol Description

V2V_Horiz Horizontal bar with current value of the valve

position

Horizontal two-way valve

V2V_Vert Vertical bar with current value of the valve

position

Vertical two-way valve

Label Displays the ObjectTagName, StaticText and

CustomPropertyLabel.

NOTE: The motorized valve symbol is composed of five symbols:

• Valve
• Analog input
• Motor
• High limit switch
• Low limit switch
Navigation to display the related faceplate of contained objects analog input,
motor and limit switches are provided on main faceplate of motorised valves
with feedback.

Faceplates
Overview
During operation, clicking the graphic symbol opens a faceplate with the following
tabs:
• Standard tabs:
◦ Operation with optional local panel, page 64
◦ Engineering
◦ Alarms, page 75
• Optional tabs:
◦ Failures, page 68
◦ Maintenance, page 70
NOTE: Navigation to display the related faceplate of contained objects analog
input, motor and limit switches are provided on main faceplate of motorised
valves with feedback.
NOTE: The master template also features the trends faceplate.

EIO0000004360.04 207
Supervision Services $MValvewithPosCE: Motorized Valve With Feedback

Operation Tab
The figure shows an example of the Operation tab.

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.
This table describes the SetPoint button functions in Operator owner mode:

Button Description

Large decrement of the setpoint value (-5)

Small decrement of the setpoint value (-1)

208 EIO0000004360.04
$MValvewithPosCE: Motorized Valve With Feedback Supervision Services

Button Description

Small increment of the setpoint value (+1)

Large increment of the setpoint value (+5)

Engineering Tab
The figure shows an example of the Ongineering tab.

NOTE: This tab features the Simulation menu, which allows setting the
control module to simulation mode.
In addition, the tab may feature another menu or text field, which allows you to
configure the state or value to be simulated.
Enabling the simulation mode underlies a security classification, page 89. The
default configuration is tune. It also triggers the display of an abnormal state,
page 46 on the tab and on the symbol.
NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.
NOTE: This tab features the Service menu, which allows setting the control
module out of service.
When the control menu is set back into service by selecting In Service in the
Service menu, the current setpoint that is shown in the operation tab of the
faceplate is effective.
Setting the control module out of service underlies a security classification,
page 89. The default configuration is tune. It also triggers the display of an
abnormal state, page 46 on the tab and on the symbol.

EIO0000004360.04 209
Supervision Services $MotorVSCE: Devices with Variable Speed Drive

$MotorVSCE: Devices with Variable Speed Drive

What’s in This Chapter
Supervision Functions ................................................................................. 210
Control/Supervision Relationship.................................................................. 210
Parameters................................................................................................. 211
Default State Alarms.................................................................................... 212
Graphic Representation ............................................................................... 212
Faceplates.................................................................................................. 215

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of devices with variable speed drive.

Supervision Functions
Description
Core and optional resources provide the following monitoring and operation
functions:
• Main core functions encompass status monitoring, owner selection,
simulation mode, motor operation indication, multispeed setpoints, resetting,
and global bypassing of interlock conditions.
• Optional functions encompass a local panel, individual interlock condition and
diagnostic information management, tracking of operating hours, and
switching operations.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxMotorVS master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
MOTORVSGP Device with variable MotorVSGP_ST_DDT <instance name>_ Core supervision
speed drive logic MotorVSGP_ST functions.

MotorVSGP_ST_CFG <instance name>_

MotorVSGP_CFG

MOTORVSLPGP Local panel for controlling MotorVSLPGP_ST_DDT <instance name>_ Optional supervision
devices with variable MVSLPGP_ST functions.
speed drive

ILCKONGP Forward interlock ILCKGP_ST_DDT <instance name>_

condition. FWDILCKGP_ST

Reverse interlock <instance name>_

condition. REVILCKGP_ST

DEVMNTGP On/off device DevMNTGP_ST_DDT <instance name>_

maintenance. MotMNTGP_ST

210 EIO0000004360.04
$MotorVSCE: Devices with Variable Speed Drive Supervision Services

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
CONDSUMGP Detected failure condition CondsumGP_ST_DDT <instance name>_
summary. Condsum_ST

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $MotorVSCE
master template attributes.

Parameter Data Initial Description

type value

Param.EngUnits String % Unit of present value (PV) and setpoint (SP)

Param.EngUnitsOP String % Unit of output value (OP)

Param.HiOP Float 100.0 High limit for output value (OP)

Param.HiPV Float 100.0 High limit for present value (PV)

Param.LoOP Float 0.0 Low limit for output value (OP)

Param.LoPV Float 0.0 Low limit for present value (PV)

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.0 Specifies the displaying format of present value

(PV).

For example, enter 0.00 for 2 decimal.

Param. String 0.0 Specifies the displaying format of output value

NumFormatOP (OP).

For example, enter 0.00 for 2 decimal.

EIO0000004360.04 211
Supervision Services $MotorVSCE: Devices with Variable Speed Drive

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.
Param. Boolean False When manual resetting of interlock conditions is
IlckRearmConfir- enabled:
mation
• False = After you click the Reset button on
the faceplate during operation and have
successfully validated the command
according to the configured security
classification, resets the control logic with no
additional confirmation being required.
• True = After you click the Reset button on
the faceplate during operation, displays a
dialog box, which requires that you confirm
the reset command. The control logic is
reset only by clicking OK and validating the
command according to the configured
security classification. By default, the
security classification is secured write.

Default State Alarms

State Alarms for Variable Speed Drives
The table indicates for which attributes a state alarm is configured in the
$MotorVSCE master template and provides the default values.

Attribute Alarm message Priority

SDDevctl.St.Alarm Confirmation Failure 500

SDDevctl.St.Faild Device Failure 500

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available for representing the devices with
variable speed drive:

212 EIO0000004360.04
$MotorVSCE: Devices with Variable Speed Drive Supervision Services

Name Graphic symbol Description

Bar_Horz_OP Horizontal bar with output (OP) of motor with speed

driver

Bar_Hor_PV_SP Horizontal bar with present value (PV) and setpoint

(SP) of motor with speed driver

Bar_Hor_PV_SP_OP Horizontal bar with present value (PV), setpoint (SP),

and output (OP) of motor with speed driver

Bar_Vert_OP Vertical bar with output (OP) of motor with speed driver

Bar_Vert_PV_SP Vertical bar with present value (PV) and setpoint (SP) of
motor with speed driver

Bar_Vert_PV_SP_OP Vertical bar with present value (PV), setpoint (SP), and
output (OP) of motor with speed driver

Bar_Vert_PV_SP_Trend Vertical bar and trend with present value (PV) and
setpoint (SP) of motor with speed driver

EIO0000004360.04 213
Supervision Services $MotorVSCE: Devices with Variable Speed Drive

Name Graphic symbol Description

Bar_Vert_PV_SP_OP_ Vertical bar and trend with present value (PV), setpoint
Trend (SP), and output (OP) of motor with speed driver

Display_PV_SP Display with present value (PV) and setpoint (SP) of

motor with speed driver

Display_PV_SP_OP Display with present value (PV), setpoint (SP), and

output (OP) of motor with speed driver

Motor_Down Down vertical motor and horizontal bar with present

value (PV)

Motor_Left Left horizontal motor and horizontal bar with present

value (PV)

Motor_Right Right horizontal motor and horizontal bar with present

value (PV)

Motor_Up Up vertical motor and horizontal bar with present value

(PV)

Pump_Left Left pump and horizontal bar with present value (PV)

Pump_Right Right pump and horizontal bar with present value (PV)

214 EIO0000004360.04
$MotorVSCE: Devices with Variable Speed Drive Supervision Services

Name Graphic symbol Description

ScrewPump_Left Screw pump left

ScrewPump_Right Screw pump right

Label Displays the ObjectTagName, StaticText and

CustomPropertyLabel.

NOTE: Based on screw pump application, its symbol is available only for
forward direction.

Faceplates
Overview
During operation, clicking the graphic symbol opens a faceplate with the following
tabs:
• Standard tabs:
◦ Operation with optional local panel, page 64
◦ Engineering
◦ Alarms, page 75
• Optional tabs:
◦ Interlocks, page 65
◦ Failures, page 68
◦ Maintenance, page 70
NOTE: The master template also features the trends faceplate.

EIO0000004360.04 215
Supervision Services $MotorVSCE: Devices with Variable Speed Drive

Operation Tab
The figure shows an example of the Operation tab.

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

216 EIO0000004360.04
$MotorVSCE: Devices with Variable Speed Drive Supervision Services

Engineering Tab
The figure shows an example of the Engineering tab.

WARNING
LOSS OF CONTROL AND UNINTENDED EQUIPMENT OPERATION
Before switching the monitored device back into service:
• Verify the current setpoint of the monitored device.
• Confirm the current status of the process.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.

NOTE: This tab features the Simulation menu, which allows setting the
control module to simulation mode.
In addition, the tab may feature another menu or text field, which allows you to
configure the state or value to be simulated.
Enabling the simulation mode underlies a security classification, page 89. The
default configuration is tune. It also triggers the display of an abnormal state,
page 46 on the tab and on the symbol.
NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.
NOTE: This tab features the Service menu, which allows setting the control
module out of service.
When the control menu is set back into service by selecting In Service in the
Service menu, the current setpoint that is shown in the operation tab of the
faceplate is effective.
Setting the control module out of service underlies a security classification,
page 89. The default configuration is tune. It also triggers the display of an
abnormal state, page 46 on the tab and on the symbol.

EIO0000004360.04 217
Supervision Services

Process Control
What’s in This Part
$IMCTLCE: Internal Model Controllers........................................................... 219
$LeadLagCE: Lead Lag Controllers ............................................................... 226
$PIDCE: PID Controllers............................................................................... 231
$PWMCtlCE: Pulse-Width Modulation Controllers .......................................... 235
$RampCE: Ramps ....................................................................................... 239
$RatioCtrlCE: Ratio Controllers ..................................................................... 243
$SplitRangeCE: Split Range Controllers ........................................................ 248
$Step3CtlCE: Three-Step Controllers/Positioners ........................................... 252

Overview
This part describes the master templates that provide the supervision functions for
the process control family.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

218 EIO0000004360.04
$IMCTLCE: Internal Model Controllers Supervision Services

$IMCTLCE: Internal Model Controllers

What’s in This Chapter
Supervision Functions ................................................................................. 219
Control/Supervision Relationship.................................................................. 219
Parameters................................................................................................. 220
Default State Alarms.................................................................................... 221
Graphic Representation ............................................................................... 221
Faceplates.................................................................................................. 223

Overview
This chapter describes the $IMCTLCE master template, which contains
supervision resources to monitor and operate internal model controllers (IMCs).

Supervision Functions
Description
The $IMCTLCE master template provides the following monitoring and operation
functions:
• Core functions:
◦ Status monitoring.
◦ Owner selection.
◦ Setpoint management: IMC tuning and action.
◦ IMC operation indication.
◦ Global bypassing of interlock conditions.
• Optional functions:
◦ Viewing, bypassing, and resetting of individual interlock conditions.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxIMCtl master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

EIO0000004360.04 219
Supervision Services $IMCTLCE: Internal Model Controllers

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
IMCTLGP IMC logic. IMCTLGP_ST <instance name>_ Core supervision
IMCTL_ST functions.

IMCTLGP_CFG <instance name>_

IMCTL_CFG

ILCKONGP Interlock condition ILCKGP_ST_DDT <instance name>_ Optional supervision

summary. ILockOn_ST functions.

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the $IMCTLCE
master template attributes.

Name Data Initial Description

type value

Param.EngUnits String % Defines the unit of inputs and parameters.

Param.EngUnitsOP String % Defines the unit of outputs.

Param.HiOP Float 100.0 Highest value that the controller can output.

Param.HiPV Float 100.0 Highest value that the controller accepts as

setpoint.

Param.LoOP Float 0.0 Lowest value that the controller can output.

Param.LoPV Float 0.0 Lowest value that the controller accepts as

setpoint.

Param. String A,M Specifies the operating mode of the IMC

LoopModeNormal (separated by a comma):
• A: Automatic
• M: Manual
Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by
a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.0 Specifies the display format of values.

For example, enter 0.00 to display 2 decimals.

220 EIO0000004360.04
$IMCTLCE: Internal Model Controllers Supervision Services

Name Data Initial Description

type value

Param. String 0.0 Specifies the display format of the OP variable.

NumFormatOP
For example, enter 0.00 to display 2 decimals.

Param. Integer 0 Refer to the description of this parameter that is

TrendPeriodMin documented for $AnalogInputCE.

Default State Alarms

State Alarms for IMC
No state alarm is configured by default for the $IMCTLCE master template.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
The table describes the symbols that are included in the $IMCTLCE master
template to display data of IMCs during operation.

Name Graphic symbol Description

Bar_Horz_OP In addition to icons,

displays:
• The label.
• Engineering units.
• The output value.
• A horizontal line with
configured high and
low limits showing
the relative position
of the output.

Bar_Hor_PV_SP In addition to icons,

displays (from top to
bottom):
• The label.
• Engineering units.
• The present value.
• The setpoint value.
• States.
• To the right, a
horizontal bar
showing the setpoint
and the present
value.

EIO0000004360.04 221
Supervision Services $IMCTLCE: Internal Model Controllers

Name Graphic symbol Description

Bar_Hor_PV_SP_OP In addition to icons,

displays (from top to
bottom):
• The label.
• Engineering units.
• The present value.
• The setpoint value.
• States.
• To the right, a
horizontal bar
showing the setpoint
and the present
value.
• Below the bar, a
horizontal line with
configured high and
low limits showing
the relative position
of the output.
Engineering units
and value of the
output are displayed
to the left of the line.
Bar_Vert_OP In addition to icons,
displays:
• The label.
• A vertical line with
configured high and
low limits showing
the relative position
of the output.
• Engineering units.
• The ouput value.

Bar_Vert_PV_SP In addition to icons,

displays (from top to
bottom):
• The label.
• A vertical bar
showing the setpoint
and the present
value.
• Engineering units.
• The present value.
• The setpoint value.

Bar_Vert_PV_SP_OP In addition to icons,

displays (from top to
bottom):
• The label.
• A vertical bar
showing the setpoint
and the present
value.
• Engineering units.
• The present value.
• The setpoint value.
• States.
• To the right of the
bar, a vertical line
with configured high
and low limits
showing the relative
position of the
output.
Engineering units
and value of the
output are displayed
below the line.

222 EIO0000004360.04
$IMCTLCE: Internal Model Controllers Supervision Services

Name Graphic symbol Description

Bar_Vert_PV_SP_OP_ Displays in addition to data

Trend of Bar_Vert_PV_SP_OP, a
trend panel with
configurable trend period
in minutes.

Refer to the description of

the Param.
TrendPeriodMin
parameter.

Bar_Vert_PV_SP_Trend Displays in addition to data

of Bar_Vert_PV_SP, a
trend panel with
configurable trend period
in minutes.

Refer to the description of

the Param.
TrendPeriodMin
parameter.

Display_PV_SP In addition to icons,

displays (from top to
bottom):
• The label.
• Engineering units.
• The present value.

Display_PV_SP_OP In addition to icons,

displays (from top to
bottom):
• The label.
• Engineering units.
• The present value.
• The setpoint value.
• States.
• Engineering units
and value of the
output.

Label Displays the

ObjectTagName,
StaticText and
CustomPropertyLabel.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an IMC symbol opens a faceplate with the following
tabs:

EIO0000004360.04 223
Supervision Services $IMCTLCE: Internal Model Controllers

• Tabs for core functions:

◦ Operation
◦ Engineering
◦ Alarms, page 75
• Tabs for optional functions, which appear only if configured:
◦ Interlocks, page 65
NOTE: The master template also features the trends faceplate.

Operation Tab
The figure shows an example of the Operation tab.

Engineering Tab
The figure shows an example of the Engineering tab.

224 EIO0000004360.04
$IMCTLCE: Internal Model Controllers Supervision Services

NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.

EIO0000004360.04 225
Supervision Services $LeadLagCE: Lead Lag Controllers

$LeadLagCE: Lead Lag Controllers

What’s in This Chapter
Supervision Functions ................................................................................. 226
Control/Supervision Relationship.................................................................. 226
Parameters................................................................................................. 227
Default State Alarms.................................................................................... 228
Graphic Representation ............................................................................... 228
Faceplates.................................................................................................. 228

Overview
This chapter describes the $LeadLagCE master template, which contains
supervision resources to monitor and operate lead lag controllers.

Supervision Functions
Description
The $LeadLagCE master template provides the following monitoring and
operation functions:
• Core functions:
◦ Status monitoring.
◦ Owner selection.
◦ Operating mode.
◦ Setpoint management: Lead-lag configuration tuning, lead-lag operation
indication.
◦ Global bypassing of interlock conditions.
• Optional functions:
◦ Viewing, bypassing, and resetting of individual interlock conditions.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxLeadLagCtl master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

226 EIO0000004360.04
$LeadLagCE: Lead Lag Controllers Supervision Services

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
LDLGCTLGP lead lag controller logic. LDLGCTLGP_ST_DDT <instance name>_ Core supervision
LDLGCTLGP_ST functions.

LDLGCTLGP_CFG_DDT <instance name>_

LDLGCTLGP_CFG

ILCKONGP Interlock condition ILCKGP_ST_DDT <instance name>_ Optional supervision

summary. ILockOn_ST functions.

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the $LeadLagCE
master template attributes.

Name Data Initial Description

type value

Param.EngUnits String % Indicates the unit of inputs and parameters.

Param.EngUnitsOP String % Indicates the unit of outputs.

Param.HiOP Float 100.0 Highest value that the controller can output.

Param.HiSP Float 100.0 Highest value that the controller accepts as

setpoint.

Param.LoOP Float 0.0 Lowest value that the controller can output.

Param.LoSP Float 0.0 Lowest value that the controller accepts as

setpoint.

Param. String A,M Specifies the normal loop operating mode of the
LoopModeNormal lead lag controller (separated by a comma):
• A: Automatic
• M: Manual
Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by
a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.0 Specifies the display format of values.

For example, enter 0.00 to display 2 decimals.

EIO0000004360.04 227
Supervision Services $LeadLagCE: Lead Lag Controllers

Name Data Initial Description

type value

Param. String 0.0 Specifies the display format of the OP variable.

NumFormatOP
For example, enter 0.00 to display 2 decimals.

Param. Integer 0 Refer to the description of this parameter that is

TrendPeriodMin documented for $AnalogInputCE.

Default State Alarms

State Alarms for Split Range Controllers
No state alarm is configured by default for the $LeadLagCE master template.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $LeadLagCE master
template to display data of lead lag controllers during operation.

Name Graphic symbol Description

Bar_Hor_SP_OP In addition to icons, displays (from top to

bottom):
• The label.
• A horizontal bar graph showing the
setpoint and the output.
• The output value with engineering
units.
Label Displays the ObjectTagName,
StaticText and CustomPropertyLabel.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a lead lag controller symbol opens a faceplate with the
following tabs:

228 EIO0000004360.04
$LeadLagCE: Lead Lag Controllers Supervision Services

• Tabs for core functions:

◦ Operation
◦ Engineering
◦ Alarms, page 75
• Tabs for optional functions, which appear only if configured:
◦ Interlocks, page 65
NOTE: The master template also features the trends faceplate.

Operation Tab
The figure shows an example of the Operation tab.

Engineering Tab
The figure shows an example of the Engineering tab.

EIO0000004360.04 229
Supervision Services $LeadLagCE: Lead Lag Controllers

NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.

230 EIO0000004360.04
$PIDCE: PID Controllers Supervision Services

$PIDCE: PID Controllers

What’s in This Chapter
Supervision Functions ................................................................................. 231
Control/Supervision Relationship.................................................................. 231
Parameters................................................................................................. 232
Default State Alarms.................................................................................... 233
Graphic Representation ............................................................................... 233
Faceplates.................................................................................................. 233

Overview
This chapter describes the $PIDCE master template, which contains supervision
resources to monitor and operate PIDFF regulators with monitoring interface.

Supervision Functions
Description
The PID controller supervision functions help you to monitor and control a PIDFF-
type controller by providing the operating modes used in the other resources for
process control.
The $PIDCE master template provides the following monitoring and operation
functions:
• Core functions:
◦ Owner selection
◦ PID operation monitoring
◦ PID mode selection
◦ Tuning
◦ Forward/reverse action
◦ Formula management
◦ Global bypassing of interlock conditions
• Optional functions:
◦ Individual interlock condition management
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxPID master template
is configured to exchange data with the following control resources of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
PIDCTLGP PID controller logic PIDCTLGP_ST_DDT <instance name>_ Core supervision
PIDCTLGP_ST functions.

EIO0000004360.04 231
Supervision Services $PIDCE: PID Controllers

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
PIDCTLGP_CFG_DDT <instance name>_
PIDCTLGP_CFG

ILCKONGP Interlock condition ILCKGP_ST_DDT <instance name>_ Optional supervision

summary. ILCKGP_ST functions.

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the $PIDCE master
template attributes.

Parameter Type Initial Description

value
Param.EngUnits String % Unit of present value (PV) and setpoint (SP)

Param.EngUnitsOP String % Unit of output value (OP)

Param.HiOP Float 100.0 High limit for output value (OP)

Param.HiPV Float 100.0 High limit for present value (PV)

Param.LoOP Float 0.0 Low limit for output value (OP)

Param.LoPV Float 0.0 Low limit for present value (PV)

Param. String A,M Specifies the loop normal modes (separated by a

LoopModeNormal comma):
• A: Auto, regardless it is in Override mode
(external output) or not
• M: Manual
Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by
a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.0 Specifies the displaying format of present value

(PV).

For example, enter 0.00 for 2 decimals.

232 EIO0000004360.04
$PIDCE: PID Controllers Supervision Services

Parameter Type Initial Description

value
Param. String 0.0 Specifies the displaying format of output value
NumFormatOP (OP).

For example, enter 0.00 for 2 decimals.

Param. Integer 0 Refer to the description of this parameter that is

TrendPeriodMin documented for $AnalogInputCE.

Default State Alarms

State Alarms for PIDs
No state alarm is configured by default for the $PIDCE master template.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The symbols that are included in the $PIDCE master template to display data of
PIDFF regulators with monitoring interface during operation are the same as those
of the $IMCTLCE master template, page 221.

Faceplates
Overview
During operation, clicking the graphic symbol allows you to display a faceplate
with the following tabs:
• Standard tabs:
◦ Operation
◦ Engineering
◦ Alarms, page 75
• Optional tabs:
◦ Interlocks, page 65
NOTE: The master template also features the trends faceplate.

EIO0000004360.04 233
Supervision Services $PIDCE: PID Controllers

Operation Tab
The figure shows an example of the Operation tab.

Engineering Tab
The figure shows an example of the Engineering tab.

NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.

234 EIO0000004360.04
$PWMCtlCE: Pulse-Width Modulation Controllers Supervision Services

$PWMCtlCE: Pulse-Width Modulation Controllers

What’s in This Chapter
Supervision Functions ................................................................................. 235
Control/Supervision Relationship.................................................................. 235
Parameters................................................................................................. 236
Default State Alarms.................................................................................... 236
Graphic Representation ............................................................................... 236
Faceplates.................................................................................................. 237

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of pulse-width modulation controllers.

Supervision Functions
Description
Core and optional resources provide the following monitoring and operation
functions:
• Main core functions encompass status monitoring, owner selection, PWM
activation, setpoint management (PWM configuration), and global bypassing
of interlock conditions.
• Optional functions encompass individual interlock condition management.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxPWM master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
PWMCTLGP Pulse-width modulation PWMCTLGP_ST_DDT <instance name>_ Core supervision
controller logic PWMCTLGP_ST functions.

PWMCTLGP_CFG_DDT <instance name>_

PWMCTLGP_CFG

ILCKONGP Interlock condition ILCKGP_ST_DDT <instance name>_ Optional supervision

summary. ILockOn_ST functions.

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

EIO0000004360.04 235
Supervision Services $PWMCtlCE: Pulse-Width Modulation Controllers

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Default Description

Param.EngUnits String % Unit of the setpoint value

Param.HiSP Float 100.0 High limit for the setpoint value

Param.LoSP Float 0.0 Low limit for the setpoint value

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.0 Specifies the displaying format of values.

For example, enter 0.00 for 2 decimal.

Default State Alarms

State Alarms for Pulse-Width Modulation Controllers
No state alarm is configured by default for the $PWMCtlCE
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available for representing the pulse-width
modulation controllers:

236 EIO0000004360.04
$PWMCtlCE: Pulse-Width Modulation Controllers Supervision Services

Name Graphic symbol Description

Bar_Horiz_SP Horizontal bar with setpoint value (SP)

Label Displays the ObjectTagName, StaticText

and CustomPropertyLabel.

Faceplates
Overview
During operation, clicking the graphic symbol opens a faceplate with the following
tabs:
• Standard tabs:
◦ Operation
◦ Engineering
◦ Alarms, page 75
• Optional tabs:
◦ Interlocks, page 65
NOTE: The master template also features the trends faceplate.

Operation Tab
The figure shows an example of the Operation tab.

EIO0000004360.04 237
Supervision Services $PWMCtlCE: Pulse-Width Modulation Controllers

Engineering Tab
The figure shows an example of the Engineering tab.

NOTE: This tab features the PWM configuration data:

• Period in seconds.
• Minimum pulse width in seconds.

238 EIO0000004360.04
$RampCE: Ramps Supervision Services

$RampCE: Ramps
What’s in This Chapter
Supervision Functions ................................................................................. 239
Control/Supervision Relationship.................................................................. 239
Parameters................................................................................................. 239
Default State Alarms.................................................................................... 240
Graphic Representation ............................................................................... 240
Faceplates.................................................................................................. 241

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of ramps.

Supervision Functions
Description
Core resources provide the following monitoring and operation functions: Status
monitoring, owner selection, and setpoint management (ramp activation and
configuration).
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxRamp master template is
configured to exchange data with the following control resource of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
ARAMPGP Ramp logic ARampGP_ST_DDT <instance name>_ Core supervision
ARampGP_ST functions.

ARampGP_CFG_DDT <instance name>_

ARampGP_CFG

** Mandatory variables to be defined.

For description of the control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived

EIO0000004360.04 239
Supervision Services $RampCE: Ramps

application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Default Description

Param.EngUnits String % Unit of the setpoint value

Param.HiSP Float 100.0 High limit for the setpoint value

Param.LoSP Float 0.0 Low limit for the setpoint value

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.0 Specifies the displaying format of values.

For example, enter 0.00 for 2 decimal.

Default State Alarms

State Alarms for Ramp Management
No state alarm is configured by default for the $RampCE master template.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available for representing the ramps:

Name Graphic symbol Description

Bar_Horiz_SP_Target Horizontal bar with setpoint (SP)

Label Displays ObjectTagName, StaticText

and CustomPropertyLabel.

240 EIO0000004360.04
$RampCE: Ramps Supervision Services

Faceplates
Overview
During operation, clicking the graphic symbol allows you to display a faceplate
with the following tabs:
• Standard tabs:
◦ Operation
◦ Engineering
◦ Alarms, page 75
NOTE: The master template also features the trends faceplate.

Operation Tab

EIO0000004360.04 241
Supervision Services $RampCE: Ramps

Engineering Tab

242 EIO0000004360.04
$RatioCtrlCE: Ratio Controllers Supervision Services

$RatioCtrlCE: Ratio Controllers

What’s in This Chapter
Supervision Functions ................................................................................. 243
Control/Supervision Relationship.................................................................. 243
Parameters................................................................................................. 244
Default State Alarms.................................................................................... 244
Graphic Representation ............................................................................... 244
Faceplates.................................................................................................. 246

Overview
This chapter describes the $RatioCtrlCE master template, which contains
supervision resources to monitor and operate ratio controllers.

Supervision Functions
Description
The $RatioCtrlCE master template provides the following monitoring and
operation core functions:
• Status monitoring.
• Owner selection.
• Setpoint management: Ratio configuration.
• Ratio operation indication.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxRatioCtl master template is
configured to exchange data with the following control resource of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
RATIOCTLGP Ratio controller logic. RatioCTLGP_ST_DDT <instance name>_ Core supervision
RatioGP_ST functions.

RatioCTLGP_CFG_DDT <instance name>_

RatioGP_CFG

** Mandatory variables to be defined.

For description of the control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

EIO0000004360.04 243
Supervision Services $RatioCtrlCE: Ratio Controllers

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the $RatioCtrlCE
master template attributes.

Name Data Initial Description

type value

Param.EngUnits String % Defines the unit of attributes.

Param.HiPV Float 100.0 Highest value that the controller accepts as

setpoint.

Param.LoPV Float 0.0 Lowest value that the controller accepts as

setpoint.

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.00 Specifies the display format of values.

For example, enter 0.00 to display 2 decimals.

Param. Integer 0 Refer to the description of this parameter that is

TrendPeriodMin documented for $AnalogInputCE.

Default State Alarms

State Alarms for Ratio Controller
No state alarm is configured by default for the $RatioCtrlCE master template.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

244 EIO0000004360.04
$RatioCtrlCE: Ratio Controllers Supervision Services

Present and Output Value Description

Ratio controller symbols display the following values:
• Present value: Current value of the variable that is controlled by the ration
controller.
• Output value: Output OP generated by the controller based on the
measurement and the configured ratio, page 246. OP = (K) * PV_TRACK +
BIAS where (K) is the local ratio.

Symbol Description
The table describes the symbols that are included in the $RatioCtrlCE master
template to display data of ratio controllers during operation.

Name Graphic symbol Description

Bar_Hor_PV_SP In addition to icons, displays (from top to

bottom):
• The label.
• Engineering units.
• The present value.
• The output value.
• The trend client icon.
• States, shown in a square, page 48.
• To the right, a horizontal bar showing
the setpoint and the present value.

Bar_Vert_PV_SP In addition to icons, displays (from top to

bottom):
• The label.
• A vertical bar showing the setpoint
and the present value.
• Engineering units.
• The present value.
• The output value.
• The trend client icon.
• States, shown in a square, page 48.

Bar_Vert_PV_SP_Trend Displays in addition to data of Bar_Vert_

PV_SP, a trend panel with configurable
trend period in minutes.

Refer to the description of the Param.

TrendPeriodMin parameter.

EIO0000004360.04 245
Supervision Services $RatioCtrlCE: Ratio Controllers

Name Graphic symbol Description

Display_PV_SP In addition to icons, displays (from top to

bottom):
• The label.
• Engineering units.
• The present value.
• The output value.
• The trend client icon.
• States, shown in a square, page 48.

Label Displays ObjectTagName, StaticText and

CustomPropertyLabel.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a ratio controller symbol opens a faceplate with the
following tabs:
• Operation
• Engineering
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

Operation Tab
The figure shows an example of the Operation tab.

246 EIO0000004360.04
$RatioCtrlCE: Ratio Controllers Supervision Services

1 Ratio setpoint value: Ratio coefficient for the ration between the generated
output and the measurement that is being applied according to the current
operating mode.

2 Present value ratio: Actual ration coefficient generated by the ratio

controller. Actual ratio KAct = (PV - BIAS)/PV_TRACK.

Engineering Tab
The figure shows an example of the Engineering tab.

EIO0000004360.04 247
Supervision Services $SplitRangeCE: Split Range Controllers

$SplitRangeCE: Split Range Controllers

What’s in This Chapter
Supervision Functions ................................................................................. 248
Control/Supervision Relationship.................................................................. 248
Parameters................................................................................................. 249
Default State Alarms.................................................................................... 250
Graphic Representation ............................................................................... 250
Faceplates.................................................................................................. 250

Overview
This chapter describes the $SplitRangeCE master template, which contains
supervision resources to monitor and operate split range controllers.

Supervision Functions
Description
The $SplitRangeCE master template provides the following monitoring and
operation functions:
• Core functions:
◦ Status monitoring.
◦ Owner selection.
◦ Operating mode.
◦ Setpoint management: Split range configuration.
◦ Global bypassing of interlock conditions.
• Optional functions:
◦ Viewing, bypassing, and resetting of individual interlock conditions.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxSplitRangeCtl master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

248 EIO0000004360.04
$SplitRangeCE: Split Range Controllers Supervision Services

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
SPLRGCTLGP Split range controller SPLRGCTLGP_ST_DDT <instance name>_ Core supervision
logic. SPLRGCTLGP_ST functions.

SPLRGCTLGP_CFG_DDT <instance name>_

SPLRGCTLGP_CFG

ILCKONGP Interlock condition ILCKGP_ST_DDT <instance name>_ Optional supervision

summary. ILockOn_ST functions.

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the $SplitRangeCE
master template attributes.

Name Data Initial Description

type value

Param.EngUnits String % Defines the unit of inputs and parameters.

Param.HiOP Float 100.0 Highest value that the controller can output.

Param.HiSP Float 100.0 Highest value that the controller accepts as

setpoint.

Param.LoOP Float 0.0 Lowest value that the controller can output.

Param.LoSP Float 0.0 Lowest value that the controller accepts as

setpoint.

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.0 Specifies the display format of values.

For example, enter 0.00 to display 2 decimals.

Param. Integer 0 Refer to the description of this parameter that is

TrendPeriodMin documented for $AnalogInputCE.

EIO0000004360.04 249
Supervision Services $SplitRangeCE: Split Range Controllers

Default State Alarms

State Alarms for Split Range Controllers
No state alarm is configured by default for the $SplitRangeCE master template.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $SplitRangeCE master
template to display data of split range controllers during operation.

Name Graphic symbol Description

Numeric_SP_OP1_OP2_ The symbol displays (from top to bottom):

Sates
• The label.
• Engineering units.
• The setpoint.
• Output 1.
• Output 2.
• States.
Label Displays ObjectTagName, StaticText
and CustomPropertyLabel.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a split range controller symbol opens a faceplate with
the following tabs:
• Tabs for core functions:
◦ Operation
◦ Engineering
◦ Alarms, page 75
• Tabs for optional functions, which appear only if configured:
◦ Interlocks, page 65

250 EIO0000004360.04
$SplitRangeCE: Split Range Controllers Supervision Services

NOTE: The master template also features the trends faceplate.

Operation Tab
The figure shows an example of the Operation tab.

Engineering Tab
The figure shows an example of the Engineering tab.

NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.

EIO0000004360.04 251
Supervision Services $Step3CtlCE: Three-Step Controllers/Positioners

$Step3CtlCE: Three-Step Controllers/Positioners

What’s in This Chapter
Supervision Functions ................................................................................. 252
Control/Supervision Relationship.................................................................. 252
Parameters................................................................................................. 253
Default State Alarms.................................................................................... 254
Graphic Representation ............................................................................... 254
Faceplates.................................................................................................. 255

Overview
This chapter describes the $Step3CtlCE master template, which contains
supervision resources to monitor and operate three-step controllers/positioners.

Supervision Functions
Description
The $Step3CtlCE master template provides the following monitoring and
operation functions:
• Core functions:
◦ Status monitoring.
◦ Owner selection.
◦ Setpoint mode selection.
◦ Controller operation indication.
◦ Global bypassing of interlock conditions.
• Optional functions:
◦ Viewing, bypassing, and resetting of individual interlock conditions.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxStep3Ctl master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

252 EIO0000004360.04
$Step3CtlCE: Three-Step Controllers/Positioners Supervision Services

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
STEP3CTLGP Three-step controller/ Step3CTLGP_ST_DDT <instance name>_ Core supervision
positioner logic. Step3CTLGP_ST functions.

Step3CTLGP_CFG_DDT <instance name>_

Step3CTLGP_CFG

ILCKONGP Interlock condition ILCKGP_ST_DDT <instance name>_ Optional supervision

summary. ILockOn_ST functions.

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the $Step3CtlCE
master template attributes.

Name Data Initial Description

type value

Param.EngUnits String % Indicates the unit of attributes

Param.HiPV Float 100.0 Highest value that the controller accepts as

setpoint.

Param.LoPV Float 0.0 Lowest value that the controller accepts as

setpoint.

Param.ModeNormal String O,P,C Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
• C: Cascade
For example P,C.

Param.NumFormat String 0.0 Specifies the display format of values.

For example, enter 0.00 to display 2 decimals.

Param. Integer 0 Refer to the description of this parameter that is

TrendPeriodMin documented for $AnalogInputCE.

EIO0000004360.04 253
Supervision Services $Step3CtlCE: Three-Step Controllers/Positioners

Default State Alarms

State Alarms for Three-Step Controller
No state alarm is configured by default for the $Step3CtlCE master template.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $Step3CtlCE master
template to display data of three-step controllers/positioners during operation.

Name Graphic symbol Description

Bar_Horiz_ In addition to icons, displays

PV_SP_States (from top to bottom):
• The label.
• Engineering units.
• The present value.
• The setpoint value.
• States.
• To the right, a
horizontal bar
showing the setpoint
and the present value.

Bar_Vert_PV_ Displays in addition to data

SP_OP_ of Bar_Vert_PV_SP_
States_Trend States_Trend, a vertical
line showing the output.

254 EIO0000004360.04
$Step3CtlCE: Three-Step Controllers/Positioners Supervision Services

Name Graphic symbol Description

Bar_Vert_PV_ In addition to icons, displays

SP_States (from top to bottom):
• The label.
• A vertical bar showing
the setpoint and the
present value.
• Engineering units.
• The present value.
• The setpoint value.
• States.

Bar_Vert_PV_ Displays in addition to data

SP_States_ of Bar_Vert_PV_SP_
Trend States, a trend panel with
configurable trend period in
minutes.

Refer to the description of

the Param.TrendPeriodMin
parameter.

Numeric_PV_ In addition to icons, displays

SP_States (from top to bottom):
• The label.
• Engineering units.
• The present value.
• The setpoint value.
• States.
Numeric_PV_ In addition to icons, displays
States (from top to bottom):
• The label.
• Engineering units.
• The present value.
• States.
Label Displays ObjectTagName,
StaticText and
CustomPropertyLabel.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

EIO0000004360.04 255
Supervision Services $Step3CtlCE: Three-Step Controllers/Positioners

Available Tabs
During operation, clicking a three-step controller/positioner symbol opens a
faceplate with the following tabs:
• Tabs for core functions:
◦ Operation
◦ Engineering
◦ Alarms, page 75
• Tabs for optional functions, which appear only if configured:
◦ Interlocks, page 65
NOTE: The master template also features the trends faceplate.

Operation Tab
The figure shows an example of the Operation tab.

256 EIO0000004360.04
$Step3CtlCE: Three-Step Controllers/Positioners Supervision Services

Engineering Tab
The figure shows an example of the Engineering tab.

NOTE: This tab features the Interlock Bypass menu, which allows bypassing
interlocks globally.
When the control module is reset, the current setpoint that is shown in the
operation tab of the faceplate is effective.
Bypassing interlocks by selecting Bypass underlies a security classification,
page 89. The default configuration is verified write. It also triggers the display
of an abnormal state, page 46 on the tab and on the symbol.

EIO0000004360.04 257
Supervision Services

Sequential Control
What’s in This Part
$SequenceCE: Sequential Control Functions ................................................. 259
Sequential Control Object Configuration Pages .............................................. 270

Overview
This part describes the master templates that provide the supervision functions for
sequential control. It also describes the template-specific configuration pages of
the ArchestrA IDE object editor.

258 EIO0000004360.04
$SequenceCE: Sequential Control Functions Supervision Services

$SequenceCE: Sequential Control Functions

What’s in This Chapter
Description ................................................................................................. 259
Control/Supervision Relationship.................................................................. 260
Parameters................................................................................................. 261
Default State Alarms.................................................................................... 262
Graphic Representation ............................................................................... 262
Faceplates.................................................................................................. 263

Overview
This chapter describes the master templates that provide the supervision
functions for Sequential Control.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

1For 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.

Description
Introduction
This object is used for monitoring sequences based on the ISA-S88.01-1995
standard for batch control.

EIO0000004360.04 259
Supervision Services $SequenceCE: Sequential Control Functions

Supervision Functions
The table describes the main functions for sequential control management:

Function Description

State management Shows the status of the sequence.

Owner selection Allows you to configure whether the sequence commands come from
the program or the operator.

Operating mode Allows you to operate the sequence in automatic/semi-automatic or

manual mode.
Command management Allows you to send commands (such as Start and Stop) to the
sequence.

Parameter management Allows you to select a strategy, enter input parameter values, and
monitor output values.

Initial condition Optional function that allows you to manage initial conditions that are
management not satisfied and that block the start of the sequence.

Diagnostic information Optional function that allows you to manage abnormal conditions
management detected by the sequence.

These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxSequentialControl
master template is configured to exchange data with the following control
resources of the Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name for Used for
DDT**
SEQCTLGP Sequential control logic SEQCTLGP_ST_DDT <instance name>_ Core supervision
SEQCTLGP_ST functions.

SEQCTLGP_CFG_DDT <instance name>_

SEQCTLGP_CFG

SEQPAR05GP Sequence parameters SEQPAR05GP_ST_DDT <instance name>_ Optional supervision

SEQPAR05GP_ST functions.

SEQPAR10GP SEQPAR010GP_ST_DDT <instance name>_

SEQPAR10GP_ST

SEQPAR16GP SEQPAR016GP_ST_DDT <instance name>_

SEQPAR16GP_ST

CONDSUMGP Detected failure condition CondsumGP_ST_DDT <instance name>_

summary (default variable CONDSUM_ST
naming convention <...
>_FC_CONDSUM_<...>)

Initial conditions (default <instance name>_

variable naming convention INITCOND_ST
<...>_IC_CONDSUM_<...
>)

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

260 EIO0000004360.04
$SequenceCE: Sequential Control Functions Supervision Services

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. User can modify the values in the derived
application template or in its instances. User can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allows user to configure core functions.
NOTE: You can configure optional functions from the template-specific
configuration pages, page 270.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Default Description

Param.Data1.Desc String Data1 description (only displayed in the

PanelAll symbol).

Param.Data1.Format String 0.00 Specifies the displaying format of the

Data1 value.

For example, enter 0.00 for 2 decimal

NOTE: For configuration purposes,
the decimal separator must be Dot (.)
and not any other type of separator,
for example, Comma (,). The run-time
will use the configured language
settings of the local system.

Param.Data1.PV Float 0.0 Data1 value attribute.

NOTE: To display the Data1 variable,
you need to define it in the
Extensions tab as an input extension
of the attribute Param.Data1.PV (for
example Me.SeqPar.OP01.OP.PV
for displaying the output parameter 1).

Param.Data2.Desc String Data2 description (only displayed in the

PanelAll symbol).

Param.Data2.Format String 0.00 Specifies the displaying format of the

Data2 value.

For example, enter 0.00 for 2 decimal

NOTE: For configuration purposes,
the decimal separator must be Dot (.)
and not any other type of separator,
for example, Comma (,). The run-time
will use the configured language
settings of the local system.

Param.Data2.PV Float 0.0 Data2 value attribute.

NOTE: To display the Data2 variable,
you need to define it in the
Extensions tab as an input extension
of the attribute Param.Data2.PV (for
example Me.SeqPar.OP02.OP.PV
for displaying the output parameter 2).

Param.HideAbortButton Bool False If true, the Abort button is not displayed.

If false, the Abort button is displayed.

Param.HideHoldButton Bool False If true, the Hold button is not displayed.

If false, the Hold button is displayed.

Param.HidePauseButton Bool False If true, the Pause button is not displayed.

If false, the Pause button is displayed.

EIO0000004360.04 261
Supervision Services $SequenceCE: Sequential Control Functions

Parameter Type Default Description

Param.HideResetButton Bool False If true, the Reset button is not displayed.

If false, the Reset button is displayed.

Param. Bool False If true, the Restart button is not displayed.

HideRestartButton
If false, the Restart button is displayed.

Param.HideStartButton Bool False If true, the Start button is not displayed.

If false, the Start button is displayed.

Param.HideStopButton Bool False If true, the Stop button is not displayed.

If false, the Stop button is displayed.

Param.ModeNormal String O,P Specifies the normal owner modes

(separated by a comma):
• O: Operator
• P: Program

Default State Alarms

State Alarms for Sequential Control
The table indicates for which attributes a state alarm is configured in the
$SequenceCE master template and provides the default values.

Attribute Alarm message Priority

AO.Failure Failure condition triggered during 999

execution

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available for representing the sequential control:

262 EIO0000004360.04
$SequenceCE: Sequential Control Functions Supervision Services

Name Graphic symbol Description

PanelAll The symbol displays:

• The current state of the sequence.
• The step being executed.
• The strategy that is applied (if configured and
selected).
• The time elapsed for the current step.
• Control buttons.
• Two configurable data (Data1 and Data2).

PanelWithButtons The symbol displays:

• The current state of the sequence.
• The step being executed.
• The strategy that is applied (if configured and
selected).
• The time elapsed for the current step.
• Control buttons
PanelState The symbol displays:
• The current state of the sequence.
• The step being executed.
• The strategy that is applied (if configured and
selected).
• The time elapsed for the current step.

Faceplates
Overview
During operation, clicking a sequential control graphic symbol opens a faceplate
with the following tabs:
• Standard tabs:
◦ Operation
◦ Parameters (input and output parameters)
◦ State machine
◦ Alarms, page 75
• Optional tabs:
◦ Initial Conditions, page 65
◦ Failures, page 68

EIO0000004360.04 263
Supervision Services $SequenceCE: Sequential Control Functions

Operation Tab in Automatic Mode

This figure shows the Operation tab when Operator and the Auto mode are
selected.

The sequence runs in automatic mode after clicking the Start button, and the
bottom section of the faceplate displays:
• The step that is being executed and its number.
• The transition to the next step:
◦ Passive Galaxy style, page 47: The condition is not yet fulfilled.
◦ Active Galaxy style: The condition is true.
• The next step to be executed when the current step is completed and the
transition is true.
This table describes the command that corresponds to each button on the
Operation tab.

Button Command
Start

Hold

Pause

Restart/resume

264 EIO0000004360.04
$SequenceCE: Sequential Control Functions Supervision Services

Button Command

Stop

Abort

Reset

NOTE: Only buttons that correspond to available commands are active (Active
Galaxy style, page 47). Unavailable commands are displayed with the Passive
Galaxy style.
This table describes the mode that corresponds to each button on the Operation
tab.

Button Mode Description

Auto Normal execution

Semi Asks for confirmation before transitioning

Man Allows you to select the step to execute

EIO0000004360.04 265
Supervision Services $SequenceCE: Sequential Control Functions

Operation Tab in Semi-Automatic Mode

This figure shows the Operation tab when Operator and the Semi mode are
selected.

The sequence starts in semi-automatic mode after clicking the Start button, and
the bottom section of the faceplate displays:
• The step that is being executed and its number.
• The transition to the next step:
◦ Passive style: The condition is not yet fulfilled
◦ Active style: The condition is true.
• The next step to be executed.
• A Continue to Next Step button requiring the operator to confirm the
execution of the next step when the transition is true.

266 EIO0000004360.04
$SequenceCE: Sequential Control Functions Supervision Services

Operation Tab in Manual Mode

This figure shows the Operation tab when Operator and the Man mode are
selected.

The sequence starts in manual mode after clicking the Start button. The bottom
section of the faceplate displays:
• The steps of the sequence that are programmed in the Running state.
• A Go To Step button allowing to execute the step selected in the Select the
Step to execute list.
You can scroll up and down (in six-step increments) through the list of steps by
using the two arrow buttons.

EIO0000004360.04 267
Supervision Services $SequenceCE: Sequential Control Functions

Input/Ouput Parameters Tab

This figure shows the Parameters tab when the Input Parameters subtab is
selected

You can select a strategy from the ones that have been defined and enter the
corresponding values for enabled parameters.
Parameters that do not pertain to the selected strategy are disabled.
NOTE: The parameters can be only modified when the sequence is in Idle
state.
This figure shows the Parameters tab when the Output Parameters subtab is
selected.

Displays the values of output parameters, which are calculated while the
sequence is executed.

268 EIO0000004360.04
$SequenceCE: Sequential Control Functions Supervision Services

State Machine Tab

The state diagram allows the operator to execute available commands by using
the buttons.
Names of states appear in Passive style while the current state appears in Active
style.
NOTE: Only buttons that correspond to available commands are active (Active
style). Unavailable commands are displayed with the Passive style.

EIO0000004360.04 269
Supervision Services Sequential Control Object Configuration Pages

Sequential Control Object Configuration Pages

What’s in This Chapter
Main Page Default Configuration .................................................................. 270
Initial Conditions Page Default Configuration ................................................. 271
Failure Conditions Page Default Configuration............................................... 272
Parameters Page Default Configuration ........................................................ 273
Input Parameters Page Default Configuration ................................................ 274
Output Parameters Page Default Configuration ............................................. 275

Overview
This chapter describes the default configuration of pages for sequential control
objects.
They allow you to configure optional supervision functions of process application
templates and their instances.
The default security classification to modify references is Configure.

Main Page Default Configuration

Overview
The Main page is used to modify the variable references used by the sequential
control object.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of sequential
control management, refer to the chapter documenting master template of the
sequential control.

Main Page Description

Element Default variable reference with suffix for auto-referencing

State <Instance name>_SEQCTL1_ST.STATE.

Command <Instance name>_SEQCTL1_ST.COMMAND.

270 EIO0000004360.04
Sequential Control Object Configuration Pages Supervision Services

Element Default variable reference with suffix for auto-referencing

The default security classification is Operate.

Status Word <Instance name>_SEQCTL1_ST.STW.

Configuration Word <Instance name>_SEQCTL1_ST.CFGW.

The default security classification is Operate.

Elapsed Time <Instance name>_SEQCTL1_ST.ETIME.

Current Step <Instance name>_SEQCTL1_ST.CSTEPD;C.

Description

Next Step (Manual) <Instance name>_SEQCTL1_CFG.NSTEP.

The default security classification is Secured Write.

Step Descriptions <Instance name>_SEQCTL1_CFG.STEPD;C.

Transition <Instance name>_SEQCTL1_CFG.TRANSD;C.

Descriptions

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

Initial Conditions Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Initial
Conditions page is used to:
• Enable or disable initial conditions and define the initial condition descriptions.
When enabled, it allows you to:
◦ Enable or disable the bypass of initial conditions.
◦ Enable or disable the manual resetting of initial conditions.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of initial conditions,
refer to the chapter documenting master template of the Sequential control.

Initial Conditions Page Description

EIO0000004360.04 271
Supervision Services Sequential Control Object Configuration Pages

Element Description

Enable Initial Select this check box to enable initial condition management.
Conditions
By default the variable reference with suffix for auto-referencing is
<Instance name>_IC_CONDSUM_ST.CONDW.

The default security classification is Free Access.

Enable Bypass of Select this check box to enable bypass of conditions.

Conditions
By default the variable reference with suffix for auto-referencing is
<Instance name>_IC_CONDSUM_ST.BYPASSW.

The default security classification is Free Access to enable the

bypassing function and Secured Write to bypass conditions during
operation.

Enable Manual Reset Select this check box to enable the manual resetting of conditions.
of Conditions
By default the variable reference with suffix for auto-referencing is
<Instance name>_IC_CONDSUM_ST.REARMREQW.

The default security classification is Free Access to enable the manual

reset function and Secured Write to reset conditions during operation.

Initial Condition Enter the initial condition descriptions (up to 15).

Description
The default security classification is Configure.
NOTE: The descriptions can be entered in multiple languages,
page 43.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

Failure Conditions Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Failure
Conditions page is used to:
• Enable or disable monitoring of detected failure conditions and define the
detected failure condition descriptions. When enabled, it allows you to:
◦ Enable or disable the bypass of detected failure conditions.
◦ Enable or disable the manual resetting of detected failure conditions.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of detected failure
condition management, refer to the chapter documenting master template of the
sequential control.

272 EIO0000004360.04
Sequential Control Object Configuration Pages Supervision Services

Failure Conditions Page Description

Element Description

Enable Failure Select this check box to enable the management of detected failure
Conditions conditions.

By default the variable reference with suffix for auto-referencing is

<Instance name>_FC_CONDSUM_ST.CONDW.

The default security classification is Free Access.

Enable Bypass of Select this check box to enable bypass of detected failure conditions.
Conditions
By default the variable reference with suffix for auto-referencing is
<Instance name>_FC_CONDSUM_ST.BYPASSW.

The default security classification is Free Access to enable the

bypassing function and Secured Write to bypass conditions during
operation.

Enable Manual Reset Select this check box to enable the manual resetting of detected failure
of Conditions conditions.

By default the variable reference with suffix for auto-referencing is

<Instance name>_FC_CONDSUM_ST.REARMREQW.

The default security classification is Free Access to enable the manual

reset function and Secured Write to reset conditions during operation.

Failure Condition Enter the condition descriptions (up to 15).

Descriptions
The default security classification is Free Access.
NOTE: The descriptions can be entered in multiple languages,
page 43.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

Parameters Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the
Parameters page is used to:
• Define the number of input parameters.
• Define the number of output parameters.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.

EIO0000004360.04 273
Supervision Services Sequential Control Object Configuration Pages

For a description of the default template-specific configuration of parameters for

sequential control, refer to the chapter documenting master template of the
sequential control.

Parameters Page Description

Element Description

# Input Parameters Select the number of input parameters from the drop-down list (up to
16).

The default security classification is Free Access.

# Output/Report Select the number of output and report parameters from the drop-down
Parameters list (up to 16).

The default security classification is Free Access.

Status Word Status word; by default the variable reference with suffix for auto-
referencing is <Instance name>_SEQPARxx_ST.STW(1)).

Configuration Word Status word; by default the variable reference with suffix for auto-
referencing is <Instance name>_SEQPARxx_ST.CFGW(1)).

The default security classification is Operate.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

(1) xx = 05, 10, or 16 according to the number of parameters.

By combining the number of input and output parameters (the higher one), the
object automatically selects the control block for the parameters being used at the
control level (no parameters, SEQPAR05, SEQPAR10, or SEQPAR16).

Input Parameters Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Input
Parameters page is used to:
• Define input parameter descriptions.
• Enable or disable strategies for the input parameters.
• Configure the strategies when enabled.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of input parameters
for sequential control, refer to the chapter documenting master template of the
sequential control.

274 EIO0000004360.04
Sequential Control Object Configuration Pages Supervision Services

Input Parameters Page Description

Element Description

Input Parameter Enter the input parameter descriptions. The number of parameters
Descriptions depends of the configuration made in the parameter tab, page 273.

The default variable reference (Alias) is <Instance name>_

SEQPAR16_ST.IP01...<Instance name>_SEQPAR16_ST.IP16.
NOTE: Descriptions can be entered in multiple languages, page 43.

Enable Strategies Select this check box to enable strategy management.

(Parameter 1) NOTE: If the strategies are enabled, the parameter 1 is reserved for
strategy management.

Strategy Descriptions Enter the description of strategies (up to 8).

NOTE: Descriptions can be entered in multiple languages, page 43.

List of applicable Enter the input parameters applicable in each strategy separated by a
Input Parameters comma.

For example, if parameters 02 and 03 are applicable for the strategy,

enter 2,3.

NOTE: The default security classification of attributes of this page is Operate.

Output Parameters Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Output
Parameters page is used to define output and report parameter descriptions.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of parameters for
sequential control, refer to the chapter documenting master template of the
sequential control.

EIO0000004360.04 275
Supervision Services Sequential Control Object Configuration Pages

Output Parameters Page Description

Element Description

Output/Report Enter the output/report parameter descriptions. The number of

Parameter parameters depends of the configuration made in the parameter tab,
Descriptions page 273.
NOTE: Descriptions can be entered in multiple languages, page 43.

Alias Output The default variable reference is <Instance name>_SEQPAR16_ST.

OP01...<Instance name>_SEQPAR16_ST.OP16.

Alias Report The default variable reference is <Instance name>_SEQPAR16_ST.

RPT01...<Instance name>_SEQPAR16_ST.RPT16.

NOTE: The default security classification of attributes of this page is Operate.

276 EIO0000004360.04
 Supervision Services

Batch Phase Manager

What’s in This Part
$PhaseCE: Batch Phase Functions ............................................................... 278
Batch Phase Object Configuration Pages....................................................... 288
Communication Configuration in InBatch Tool................................................. 295

Overview
This part describes the master templates that provide the supervision functions for
Batch phase manager. It also describes the template-specific configuration pages
of the ArchestrA IDE object editor.

EIO0000004360.04 277
Supervision Services $PhaseCE: Batch Phase Functions

$PhaseCE: Batch Phase Functions

What’s in This Chapter
Description ................................................................................................. 278
Control/Supervision Relationship.................................................................. 279
Parameters................................................................................................. 280
Default State Alarms.................................................................................... 281
Graphic Representation ............................................................................... 281
Faceplates ................................................................................................. 282

Overview
This chapter describes the master templates that provide the supervision
functions for Batch phase.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

1For 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.

Description
Introduction
This object is used for monitoring phases based on the ISA-S88.01-1995 standard
for batch control.

278 EIO0000004360.04
$PhaseCE: Batch Phase Functions Supervision Services

Supervision Functions
The table describes the main functions for Batch phase management:

Function Description

State management Shows the status of the phase.

Owner selection Allows user to configure whether the phase commands come from the
program or the operator.

Operating mode Allows user to operate the phase in automatic/semi-automatic or

manual mode.
Command management Allows user to send commands (such as Start and Stop) to the phase.

Parameter management Allows user to select a strategy, enter input parameter values, and
monitor output values.

Initial condition Optional function that allows user to manage initial conditions that are
management not satisfied and that block the start of the phase.

Diagnostic information Optional function that allows user to manage abnormal conditions
management detected by the phase.

These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxInBatchPhase master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name for Used for
DDT**
PHASEGP Batch phase logic PhaseGP_ST_DDT <instance name>_Phase_ Core supervision
ST functions.
PhaseGP_CFG_DDT <instance name>_Phase_
CFG
PHPAR05GP Batch phase parameters PhPar05GP_ST_DDT <instance name>_ Optional supervision
PhPar05_ST functions.

PHPAR10GP PhPar10GP_ST_DDT <instance name>_

PhPar10_ST

PHPAR16GP PhPar16GP_ST_DDT <instance name>_

PhPar16_ST

CONDSUMGP Detected failure condition CondsumGP_ST_DDT <instance name>_FC_

summary (default variable CONDSUM_ST
naming convention <...
>_FC_CONDSUM_<...>)

Initial conditions (default <instance name>_IC_

variable naming convention CONDSUM_ST
<...>_IC_CONDSUM_<...
>)

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

EIO0000004360.04 279
Supervision Services $PhaseCE: Batch Phase Functions

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. User can modify the values in the derived
application template or in its instances. User can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allows user to configure core functions.
NOTE: User can configure optional functions from the template-specific
configuration pages, page 270.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Default Description

Param.Data1.Desc String Data1 description (only displayed in the

PanelAll symbol).

Param.Data1.Format String 0.00 Specifies the displaying format of the

Data1 value.

For example, enter 0.00 for 2 decimal

NOTE: For configuration purposes,
the decimal separator must be Dot (.)
and not any other type of separator,
for example, Comma (,). The run-time
will use the configured language
settings of the local system.

Param.Data1.PV Float 0.0 Data1 value attribute.

NOTE: To display the Data1 variable,
you need to define it in the
Extensions tab as an input extension
of the attribute Param.Data1.PV (for
example Me.IBPar.OP01.OP.PV
for displaying the output parameter 1).

Param.Data2.Desc String Data2 description (only displayed in the

PanelAll symbol).

Param.Data2.Format String 0.00 Specifies the displaying format of the

Data2 value.

For example, enter 0.00 for 2 decimal

NOTE: For configuration purposes,
the decimal separator must be Dot (.)
and not any other type of separator,
for example, Comma (,). The run-time
will use the configured language
settings of the local system.

Param.Data2.PV Float 0.0 Data2 value attribute.

NOTE: To display the Data2 variable,
you need to define it in the
Extensions tab as an input extension
of the attribute Param.Data2.PV (for
example Me.IBPar.OP02.OP.PV
for displaying the output parameter 2).

Param.HideAbortButton Bool False If true, the Abort button is not displayed.

If false, the Abort button is displayed.

Param.HideHoldButton Bool False If true, the Hold button is not displayed.

If false, the Hold button is displayed.

Param.HidePauseButton Bool False If true, the Pause button is not displayed.

If false, the Pause button is displayed.

280 EIO0000004360.04
$PhaseCE: Batch Phase Functions Supervision Services

Parameter Type Default Description

Param.HideResetButton Bool False If true, the Reset button is not displayed.

If false, the Reset button is displayed.

Param. Bool False If true, the Restart button is not displayed.

HideRestartButton
If false, the Restart button is displayed.

Param.HideStartButton Bool False If true, the Start button is not displayed.

If false, the Start button is displayed.

Param.HideStopButton Bool False If true, the Stop button is not displayed.

If false, the Stop button is displayed.

Param.ModeNormal String O,P Specifies the normal owner modes

(separated by a comma):
• O: Operator
• P: Program

Default State Alarms

State Alarms for Batch Phase
The table indicates for which attributes a state alarm is configured in the
$PhaseCE master template and provides the default values.

Attribute Alarm message Priority

AO.Failure Failure condition triggered during 999

execution

NOTE: User can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available for representing the InBatch:

EIO0000004360.04 281
Supervision Services $PhaseCE: Batch Phase Functions

Name Graphic symbol Description

PanelState The symbol displays:

• The current state of the phase.
• The step being executed.
• The strategy that is applied (if configured and
selected).
• The time elapsed for the current step.

PanelWithButtons The symbol displays:

• The current state of the phase.
• The step being executed.
• The strategy that is applied (if configured and
selected).
• The time elapsed for the current step.
• Control buttons
PanelAll The symbol displays:
• The current state of the phase.
• The step being executed.
• The strategy that is applied (if configured and
selected).
• The time elapsed for the current step.
• Control buttons.
• Two configurable data (Data1 and Data2).

ControlButtons User configurable control buttons.

NOTE: Control buttons will be enabled only if the
phase is started in operator owner (during
program owner operation, control buttons are
disabled). Control buttons will be disabled if phase
state is READY or INTERLOCKED.

NOTE:
• The display area for the descriptions of State, Strategy and Step is
limited, however, since they are user configurable, tooltips are available
for these descriptions in the graphical symbols as well as in the Operator
tab of the faceplate.
• Current state will be shown as: State related to InBatch (Intermediate
state of phase). For example, RUN(HOLDING)

Faceplates
Overview
During operation, clicking a Batch phase graphic symbol opens a faceplate with
the following tabs:
• Standard tabs:
◦ Operation
◦ Parameters (input and output parameters)
◦ State machine
◦ Alarms, page 75
• Optional tabs:
◦ Initial Conditions, page 65
◦ Detected Failures, page 68

282 EIO0000004360.04
$PhaseCE: Batch Phase Functions Supervision Services

Operation Tab in Automatic Mode

This figure shows the Operation tab when Operator and the Auto mode are
selected.

NOTE: Control buttons will be enabled only if the phase is started in operator
owner (during program owner operation, control buttons are disabled). Control
buttons will be disabled if phase state is READY or INTERLOCKED.
The phase runs in automatic mode after clicking the Start button, and the bottom
section of the faceplate displays:
• The step that is being executed and its number.
• The transition to the next step:
◦ Passive Galaxy style, page 47: The condition is not yet fulfilled.
◦ Active Galaxy style, page 47: The condition is true.
• The next step to be executed when the current step is completed and the
transition is true.
This table describes the command that corresponds to each button on the
Operation tab.

Button Command
Start

Hold

Pause

Restart/resume

Stop

EIO0000004360.04 283
Supervision Services $PhaseCE: Batch Phase Functions

Button Command
Abort

Reset

NOTE: Only buttons that correspond to available commands are active (Active
Galaxy style, page 47). Unavailable commands are displayed with the Passive
Galaxy style.
This table describes the mode that corresponds to each button on the Operation
tab.

Button Mode Description

Auto Normal execution

Semi Asks for confirmation before transitioning

Man Allows you to select the step to execute

Operation Tab in Semi-Automatic Mode

This figure shows the Operation tab when Operator and the Semi mode are
selected.

The phase starts in semi-automatic mode after clicking the Start button, and the
bottom section of the faceplate displays:
• The step that is being executed and its number.
• The transition to the next step:
◦ Passive style: The condition is not yet fulfilled
◦ Active style: The condition is true.

284 EIO0000004360.04
$PhaseCE: Batch Phase Functions Supervision Services

• The next step to be executed.

• A Continue to Next Step button requiring the operator to confirm the
execution of the next step when the transition is true.

Operation Tab in Manual Mode

This figure shows the Operation tab when Operator and the Man mode are
selected.

The phase starts in manual mode after clicking the Start button. The bottom
section of the faceplate displays:
• The steps of the sequence that are programmed in the Running state.
• A Go To Step button allowing to execute the step selected in the Select the
Step to execute list.
User can scroll up and down (in six-step increments) through the list of steps by
using the two arrow buttons.

EIO0000004360.04 285
Supervision Services $PhaseCE: Batch Phase Functions

Input/Ouput Parameters Tab

This figure shows the Parameters tab when the Input Parameters subtab is
selected

User can select a strategy from the ones that have been defined and enter the
corresponding values for enabled parameters.
Parameters that do not pertain to the selected strategy are disabled.
NOTE: The parameters can be only modified when the sequence is in READY
state.
This figure shows the Parameters tab when the Output Parameters subtab is
selected.

Displays the values of output parameters, which are calculated while the phase is
executed.

286 EIO0000004360.04
$PhaseCE: Batch Phase Functions Supervision Services

State Machine Tab

The state diagram allows the operator to execute available commands by using
the buttons.
Names of states appear in Passive style while the current state appears in Active
style.
NOTE: Only buttons that correspond to available commands are active (Active
style). Unavailable commands are displayed with the Passive style.

EIO0000004360.04 287
Supervision Services Batch Phase Object Configuration Pages

Batch Phase Object Configuration Pages

What’s in This Chapter
Main Page Default Configuration .................................................................. 288
Initial Conditions Page Default Configuration ................................................. 289
Failure Conditions Page Default Configuration............................................... 290
Parameters Page Default Configuration ........................................................ 291
Input Parameters Page Default Configuration ................................................ 292
Output Parameters Page Default Configuration ............................................. 293

Overview
This chapter describes the default configuration of pages for Batch phase objects.
They allow you to configure optional supervision functions of process application
templates and their instances.
The default security classification to modify references is Configure.

Main Page Default Configuration

Overview
The Main page is used to modify the variable references used by the InBatch
object.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of Batch phase
management, refer to the chapter documenting each master template of the Batch
phase.

Main Page Description

288 EIO0000004360.04
Batch Phase Object Configuration Pages Supervision Services

Element Default variable reference with suffix for auto-referencing

InBatch State <Instance name>_IBPHASE_ST.IBSTATE.

InBatch Command <Instance name>_IBPHASE_ST.IBCOMMAND.

Sequence State <Instance name>_IBPHASE_ST.STATE.

Sequence Command <Instance name>_IBPHASE_ST.COMMAND.

The default security classification is Operate.

Status Word <Instance name>_IBPHASE_ST.STW.

Configuration Word <Instance name>_IBPHASE_ST.CFGW.

The default security classification is Operate.

Elapsed Time <Instance name>_IBPHASE_ST.ETIME.

Current Step <Instance name>_IBPHASE_ST.CSTEPD;C.

Description

Next Step (Manual) <Instance name>_IBPHASE_CFG.NSTEP.

The default security classification is Secured Write.

Step Descriptions <Instance name>_IBPHASE_CFG.STEPD;C.

Transition <Instance name>_IBPHASE_CFG.TRANSD;C.

Descriptions

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.
Control Button 1 Label for Control button 1. Control Button will be available only if the
label is defined.
Control Button 2 Label for Control button 2. Control Button will be available only if the
label is defined.

NOTE: For control button commands, access control is provided on Main tab
with labels.

Initial Conditions Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Initial
Conditions page is used to:
• Enable or disable initial conditions and define the initial condition descriptions.
When enabled, it allows you to:
◦ Enable or disable the bypass of initial conditions.
◦ Enable or disable the manual resetting of initial conditions.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of initial conditions,
refer to the chapter documenting each master template of the Batch phase.

EIO0000004360.04 289
Supervision Services Batch Phase Object Configuration Pages

Initial Conditions Page Description

Element Description

Enable Initial Select this check box to enable initial condition management.
Conditions
By default the variable reference with suffix for auto-referencing is
<Instance name>_IC_CONDSUM_ST.CONDW.

The default security classification is Free Access.

Enable Bypass of Select this check box to enable bypass of conditions.

Conditions
By default the variable reference with suffix for auto-referencing is
<Instance name>_IC_CONDSUM_ST.BYPASSW.

The default security classification is Free Access to enable the

bypassing function and Secured Write to bypass conditions during
operation.

Enable Manual Reset Select this check box to enable the manual resetting of conditions.
of Conditions
By default the variable reference with suffix for auto-referencing is
<Instance name>_IC_CONDSUM_ST.REARMREQW.

The default security classification is Free Access to enable the manual

reset function and Secured Write to reset conditions during operation.

Initial Condition Enter the initial condition descriptions (up to 15).

Description
The default security classification is Configure.
NOTE: The descriptions can be entered in multiple languages,
page 43.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

Failure Conditions Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Failure
Conditions page is used to:
• Enable or disable monitoring of detected failure conditions and define the
detected failure condition descriptions. When enabled, it allows you to:
◦ Enable or disable the bypass of detected failure conditions.
◦ Enable or disable the manual resetting of detected failure conditions.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.

290 EIO0000004360.04
Batch Phase Object Configuration Pages Supervision Services

For a description of the default template-specific configuration of detected failure

condition management, refer to the chapter documenting each master template of
the InBatch.

Failure Conditions Page Description

Element Description

Enable Failure Select this check box to enable the management of detected failure
Conditions conditions.

By default the variable reference with suffix for auto-referencing is

<Instance name>_FC_CONDSUM_ST.CONDW.

The default security classification is Free Access.

Enable Bypass of Select this check box to enable bypass of detected failure conditions.
Conditions
By default the variable reference with suffix for auto-referencing is
<Instance name>_FC_CONDSUM_ST.BYPASSW.

The default security classification is Free Access to enable the

bypassing function and Secured Write to bypass conditions during
operation.

Enable Manual Reset Select this check box to enable the manual resetting of detected failure
of Conditions conditions.

By default the variable reference with suffix for auto-referencing is

<Instance name>_FC_CONDSUM_ST.REARMREQW.

The default security classification is Free Access to enable the manual

reset function and Secured Write to reset conditions during operation.

Failure Condition Enter the condition descriptions (up to 15).

Descriptions
The default security classification is Free Access.
NOTE: The descriptions can be entered in multiple languages,
page 43.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

Parameters Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the
Parameters page is used to:
• Define the number of input parameters.

EIO0000004360.04 291
Supervision Services Batch Phase Object Configuration Pages

• Define the number of output parameters.

The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of parameters for
sequential control, refer to the chapter documenting each master template of the
Batch phase.

Parameters Page Description

Element Description

# Input Parameters Select the number of input parameters from the drop-down list (up to
16).

The default security classification is Free Access.

# Output Parameters Select the number of output parameters from the drop-down list (up to
16).

The default security classification is Free Access.

Status Word Status word; by default the variable reference with suffix for auto-
referencing is <Instance name>_IBPARxx_ST.STW(1).

Configuration Word Status word; by default the variable reference with suffix for auto-
referencing is <Instance name>_IBPARxx_ST.CFGW(1).

The default security classification is Operate.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

(1) xx = 05, 10, or 16 according to the number of parameters.

By combining the number of input and output parameters (the higher one), the
object automatically selects the control block for the parameters being used at the
control level (no parameters, IBPAR05, IBPAR10, or IBPAR16).

Input Parameters Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Input
Parameters page is used to:
• Define input parameter descriptions.
• Enable or disable strategies for the input parameters.
• Configure the strategies when enabled.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.

292 EIO0000004360.04
Batch Phase Object Configuration Pages Supervision Services

For a description of the default template-specific configuration of input parameters

for InBatch to the chapter documenting each master template of the Batch phase.

Input Parameters Page Description

Element Description

Input Parameter Enter the input parameter descriptions. The number of parameters
Descriptions depends of the configuration made in the parameter tab, page 273.

The default variable reference (Alias) is <Instance name>_IBPAR16_

ST.IP01...<Instance name>_IBPAR16_ST.IP16.
NOTE: Descriptions can be entered in multiple languages, page 43.

Enable Strategies Select this check box to enable strategy management.

(Parameter 1) NOTE: If the strategies are enabled, the parameter 1 is reserved for
strategy management.

Strategy Descriptions Enter the description of strategies (up to 8).

NOTE: Descriptions can be entered in multiple languages, page 43.

List of applicable Enter the input parameters applicable in each strategy separated by a
Input Parameters comma.

For example, if parameters 02 and 03 are applicable for the strategy,

enter 2,3.

NOTE: The default security classification of attributes of this page is Operate.

Output Parameters Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Output
Parameters page is used to define output parameter descriptions.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of parameters for
InBatch, refer to the chapter documenting each master template of the Batch
phase.

EIO0000004360.04 293
Supervision Services Batch Phase Object Configuration Pages

Output Parameters Page Description

Element Description

Output Parameter Enter the output parameter descriptions. The number of parameters
Descriptions depends of the configuration made in the parameter tab, page 273.
NOTE: Descriptions can be entered in multiple languages, page 43.

Alias Output The default variable reference is <Instance name>_IBPAR16_ST.

OP01...<Instance name>_IBPAR16_ST.OP16.

NOTE: The default security classification of attributes of this page is Operate.

294 EIO0000004360.04
Communication Configuration in InBatch Tool Supervision Services

Communication Configuration in InBatch Tool

What’s in This Chapter
Description ................................................................................................. 295

Overview
This chapter describes the configuration examples that can be implemented to
establish the communication between InBatch tool and Batch Phase Manager.

Description
InBatch tool can be configured to communicate with Batch Phase Manager by two
approaches:
• InBatch tool on top of the OFS layer - InBatch tool will communicate with OFS
directly in parallel with Supervisory layer (ASP) and OFS is communicating
with Batch Phase Manager.
• InBatch tool on top of the Supervisory layer (ASP) - In this approach InBatch
tool will communicate with ASP and ASP is communicating with OFS.

InBatch Tool on Top of the OFS Layer

To configure the InBatch tool to communicate with OFS user has to verify that
IBCli service is added in the runtime services and all the runtime services are
stopped.
The below table shows the steps to configure InBatch tool to communicate with
OFS layer for the AVEVA™ System Platform 2014 R2 SP1.

Step Action

1 Go to the ArchestrA System Management Console.

2 Go to the DAServer Manager in the left side navigation hierarchy.

3 Create and configure the OPC object as shown in the figure (for example, OFS).

4 Add and configure OPC group object as shown in the figure (for example, PLCSim).

EIO0000004360.04 295
Supervision Services Communication Configuration in InBatch Tool

Step Action

5 Go to the InBatch tool, Environment Display.

Open the TagLinker. Create a new access name.

Provide the computer path location where the FSGateway is configured. In this case
FSGateway is on the local host.

Provide the topic name same as Device Group Name mentioned in the FSGateway server.

6 Now Go to View in TagLinker, click on Filter, select the Units and Tag type to create the
link.

In the below figure, Tag Name column shows the tags created by the InBatch and items are
IBCommand and IBState variables from Batch Phase Manager.

User will have to configure every tag with the respective bit in the IBCommand and IBState
as shown in the below figure.

User will have to change the access to the OFS which is created in step 5.

296 EIO0000004360.04
Communication Configuration in InBatch Tool Supervision Services

Step Action

7 After linking all the required tags, update the Environment, Runtime and Configuration in
Environment Display.

8 Now activate the FSGateway server in ArchestrA System Management Console.

9 Start all the services from Runtime in Environment Display. Now the user will be able to
communicate InBatch tool with Batch Phase Manager.

The below table shows the steps to configure InBatch tool to communicate with
OFS layer for the AVEVA™ System Platform 2017 Update 2.

Step Action

1 Go to the ArchestrA System Management Console.

2 Go to the OI.GATEWAY.2 in the left side navigation hierarchy.

3 Create and configure the OPC object as shown in the figure (for example, OFS).

4 Add and configure OFS group object as shown in the figure (for example, G1).

EIO0000004360.04 297
Supervision Services Communication Configuration in InBatch Tool

Step Action

5 Go to the InBatch tool, Environment Display.

Open the TagLinker. Create a new access name.

Provide the computer path location where the OI.GATEWAY.2 is configured. The service
name for the OI.GATEWAY.2 is GATEWAY. In this case Gateway is on the local host.

Provide the topic name same as Device Group Name mentioned in the OI.GATEWAY.2
server.

6 Now Go to View in TagLinker, click on Filter, select the Units and Tag type to create the
link.

In the below figure, Tag Name column shows the tags created by the InBatch and items are
IBCommand and IBState variables from Batch Phase Manager.

User will have to configure every tag with the respective bit in the IBCommand and IBState
as shown in the below figure.

User will have to change the access to the OFS which is created in step 5.

298 EIO0000004360.04
Communication Configuration in InBatch Tool Supervision Services

Step Action

7 After linking all the required tags, update the Environment, Runtime and Configuration in
Environment Display.

8 Now activate the OI.GATEWAY.2 server in ArchestrA System Management Console.

9 Start all the services from Runtime in Environment Display. Now the user will be able to
communicate InBatch tool with Batch Phase Manager.

InBatch tool on Top of the Supervisory Layer (ASP)

To configure the InBatch tool to communicate with the Batch Phase Manager
through the ASP user has to verify that IBMX service is added in the runtime
services and all the runtime services are stopped. The below table shows the
steps to configure InBatch tool to communicate with Batch Phase Manager
through the ASP.

EIO0000004360.04 299
Supervision Services Communication Configuration in InBatch Tool

Step Action

1 Go to the ArchestrA IDE plateform, import the InBatch base templates from the below path
C:\Program Files (x86)\Wonderware\InBatch\AppObjects. Here the drive C is the root drive
for the installables.

Galaxy will have $InBatchPhase and $BatchUnit base templates.

2 Go to the ArchestrA IDE Platform, click InBatch tab →Import InBatch Model.

A dialog box will appear select the Node Name, click on Connect and after successful
connection click on Import.

The import operation will start importing InBatch application phase as an instance in ASP.

3 Now open the InBatch phase instance under $InBatchPhase template. The instance will
have phase commands and phase states from InBatch.

300 EIO0000004360.04
Communication Configuration in InBatch Tool Supervision Services

Step Action

Enable the IO type of the phase commands and phase states. Connect the respective
IBCommand and IBState variable from Batch Phase Manager as shown in figure.

For example, Phase.Start - EPEASP.OPCUA_DeviceGroup.OPCUA.DeviceGroup./

DA/0:PLCSim!PHASE1100_Phase_ST.PhState

4 Go to the InBatch tool, Environment Display.

Open the TagLinker → Access Editor, click Galaxy → enter GR Node Name and then
select the Galaxy Name from the drop-down list and click on Change button.

5 Now Go to View in TagLinker, click on Filter, select the Units and Tag type to create the
link.

Select the tag name, click on Access, select the Galaxy as Access Name and click on
Change button.

A dialog box appears when user clicks the browse button of Item and select the attribute
from corresponding phase instance and click OK as shown in the below figure.

Link all the required attributes of the phase instance.

EIO0000004360.04 301
Supervision Services Communication Configuration in InBatch Tool

Step Action

6 Update the Environment, Runtime and Configuration in Environment Display.

7 Start all the services from Runtime in Environment Display. Now the user will be able to
communicate InBatch tool with Batch Phase Manager through ASP.

302 EIO0000004360.04
 Supervision Services

Equipment Module
What’s in This Part
$EMPatternCE: Equipment Module Functions ................................................ 304
Equipment Module Object Configuration Pages .............................................. 316

Overview
This part describes the master templates that provide the supervision functions for
equipment module. It also describes the template-specific configuration pages of
the ArchestrA IDE object editor.

EIO0000004360.04 303
Supervision Services $EMPatternCE: Equipment Module Functions

$EMPatternCE: Equipment Module Functions

What’s in This Chapter
Description ................................................................................................. 304
Control/Supervision Relationship.................................................................. 305
Parameters................................................................................................. 306
Default State Alarms.................................................................................... 308
Graphic Representation ............................................................................... 308
Faceplates.................................................................................................. 309

Overview
This chapter describes the master templates that provide the supervision
functions for equipment module.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

1For 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.

Description
Introduction
This object is used for monitoring sequences based on the ISA-NS88 standard for
continuous control.

304 EIO0000004360.04
$EMPatternCE: Equipment Module Functions Supervision Services

Supervision Functions
The table describes the main functions for equipment module management:

Function Description

Equipment state Shows the state of the sequence.

management

Owner selection Allows you to configure whether the sequence commands come from
the program or the operator.

Operating mode Allows you to operate the sequence in automatic/semi-automatic or

manual mode.
Command management Allows you to send commands (such as Start and Stop) to the
sequence.

Parameter management Allows you to select a strategy, enter input parameter values, and
monitor output values.

Initial condition Optional function that allows you to manage initial conditions that are
management not satisfied and that block the start of the sequence.

Diagnostic information Optional function that allows you to manage abnormal conditions
management detected by the sequence.

These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxEquipmentModule
master template is configured to exchange data with the following control
resources of the Modicon Libraries - General Purpose for Control Expert.

Control Description DDT name** Syntax of variable name for Used for
resource DDT**
EMCTLGP Equipment module logic EMCTLGP_ST_DDT <instance name>_EMCTL_ Core supervision
ST functions.
EMCTLGP_DDT_DDT <instance name>_EMCTL_
CFG
EMCTLGP_IOPar_DDT <instance name>_IOPar
NOTE: The IOPar pin is
not available in the DFB,
user is expected to create
the variable separately.

CONDSUMGP Detected failure condition CondsumGP_ST_DDT <instance name>_ Optional supervision

summary (default variable CONDSUM_ST functions.
naming convention <...
>_FC_CONDSUM_<...>)

Initial conditions (default <instance name>_

variable naming convention INITCOND_ST
<...>_IC_CONDSUM_<...
>)

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

EIO0000004360.04 305
Supervision Services $EMPatternCE: Equipment Module Functions

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.
NOTE: You can configure optional functions from the template-specific
configuration pages, page 270.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Initial Description

Value
Param.Data1.Desc String Data1 description (only displayed in the
PanelWithButtons_2Data and
PanelWithButtons_4Data symbols).

Param.Data1.Format String 0.00 Specifies the displaying format of the

Data1 value.

The valid format entries are D (Duration), T

(Date Time) and numeric formats (for
example: 0, 0.0, 00000)
NOTE: For configuration purposes,
the decimal separator must be Dot (.)
and not any other type of separator,
for example, Comma (,). The run-time
will use the configured language
settings of the local system.

Param.Data1.PV Double 0.0 Data1 value attribute.

NOTE: To display the Data1 variable,
you need to define it in the
Extensions tab as an input extension
of the attribute Param.Data1.PV (for
example Me.EMPar.OP01.OP.PV
for displaying the output parameter 1).

Param.Data1.EU String Engineering unit for Data1.

Param.Data2.Desc String Data2 description (only displayed in the

PanelWithButtons_2Data and
PanelWithButtons_4Data symbols).

Param.Data2.Format String 0.00 Specifies the displaying format of the

Data2 value.

The valid format entries are D (Duration), T

(Date Time) and numeric formats (for
example: 0, 0.0, 00000)
NOTE: For configuration purposes,
the decimal separator must be Dot (.)
and not any other type of separator,
for example, Comma (,). The run-time
will use the configured language
settings of the local system.

Param.Data2.PV Double 0.0 Data2 value attribute.

NOTE: To display the Data2 variable,
you need to define it in the
Extensions tab as an input extension
of the attribute Param.Data2.PV (for
example Me.EMPar.OP02.OP.PV
for displaying the output parameter 2).

Param.Data2.EU String Engineering unit for Data2.

306 EIO0000004360.04
$EMPatternCE: Equipment Module Functions Supervision Services

Parameter Type Initial Description

Value
Param.HideAbortButton Bool False If true, the Abort button is not displayed.

If false, the Abort button is displayed.

Param.HideHoldButton Bool False If true, the Hold button is not displayed.

If false, the Hold button is displayed.

Param.HidePauseButton Bool False If true, the Pause button is not displayed.

If false, the Pause button is displayed.

Param.HideResetButton Bool False If true, the Reset button is not displayed.

If false, the Reset button is displayed.

Param. Bool False If true, the Restart button is not displayed.

HideRestartButton
If false, the Restart button is displayed.

Param.HideStartButton Bool False If true, the Start button is not displayed.

If false, the Start button is displayed.

Param.HideStopButton Bool False If true, the Stop button is not displayed.

If false, the Stop button is displayed.

Param.ModeNormal String O,P Specifies the normal owner modes

(separated by a comma):
• O: Operator
• P: Program

Param.Data3.Desc String Data3 description (only displayed in the

PanelWithButtons_4Data symbol).

Param.Data3.Format String 0.00 Specifies the displaying format of the

Data3 value.

The valid format entries are D (Duration), T

(Date Time) and numeric formats (for
example: 0, 0.0, 00000)
NOTE: For configuration purposes,
the decimal separator must be Dot (.)
and not any other type of separator,
for example, Comma (,). The run-time
will use the configured language
settings of the local system.

Param.Data3.PV Double 0.0 Data3 value attribute.

NOTE: To display the Data3 variable,
you need to define it in the
Extensions tab as an input extension
of the attribute Param.Data3.PV (for
example Me.EMPar.OP01.OP.PV
for displaying the output parameter 1).

Param.Data3.EU String Engineering unit for Data3.

Param.Data4.Desc String Data4 description (only displayed in the

PanelWithButtons_4Data symbol).

Param.Data4.Format String 0.00 Specifies the displaying format of the

Data4 value.

The valid format entries are D (Duration), T

(Date Time) and numeric formats (for
example: 0, 0.0, 00000)
NOTE: For configuration purposes,
the decimal separator must be Dot (.)
and not any other type of separator,
for example, Comma (,). The run-time
will use the configured language
settings of the local system.

EIO0000004360.04 307
Supervision Services $EMPatternCE: Equipment Module Functions

Parameter Type Initial Description

Value
Param.Data4.PV Double 0.0 Data4 value attribute.
NOTE: To display the Data4 variable,
you need to define it in the
Extensions tab as an input extension
of the attribute Param.Data4.PV (for
example Me.EMPar.OP01.OP.PV
for displaying the output parameter 1).

Param.Data4.EU String Engineering units for Data4.

Default State Alarms

State Alarms for Equipment Module
The table indicates for which attributes a state alarm is configured in the
$EMPatternCE master template and provides the default values.

Attribute Alarm message Priority

AO.Failure Failure condition triggered during 999

execution

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available for representing the equipment
module:

Name Graphic symbol Description

PanelState The symbol displays:

• The current equipment state.
• The current state of the sequence.
• The step being executed.
• The strategy that is applied (if configured and
selected).
• The time elapsed for the current step.

PanelWithButtons The symbol displays:

• The current equipment state.
• The current state of the sequence.
• The step being executed.
• The strategy that is applied (if configured and
selected).
• The time elapsed for the current step.
• Control buttons

308 EIO0000004360.04
$EMPatternCE: Equipment Module Functions Supervision Services

Name Graphic symbol Description

PanelWithButton_ The symbol displays:

2Data
• The current equipment state.
• The current state of the sequence.
• The step being executed.
• The strategy that is applied (if configured and
selected).
• The time elapsed for the current step.
• Control buttons.
• Two configurable data (Data1 and Data2).

PanelWithButton_ The symbol displays:

4Data
• The current equipment state.
• The current state of the sequence.
• The step being executed.
• The strategy that is applied (if configured and
selected).
• The time elapsed for the current step.
• Control buttons.
• Four configurable data (Data1, Data2, Data3 and
Data4).

NOTE: The display area for the descriptions of State, Strategy, Strategy State
and Step is limited, however, since they are user configurable, tooltips are
available for these descriptions in the graphical symbols as well as in the
Operator tab of the faceplate.

Faceplates
Overview
During operation, clicking a equipment module graphic symbol opens a faceplate
with the following tabs:
• Standard tabs:
◦ Operation
◦ Parameters (input and output parameters)
◦ State machine
◦ Alarms, page 75
• Optional tabs:
◦ Initial Conditions, page 65
◦ Failures , page 68

EIO0000004360.04 309
Supervision Services $EMPatternCE: Equipment Module Functions

Operation Tab in Automatic Mode

This figure shows the Operation tab when Operator and the Auto mode are
selected.

The sequence runs in automatic mode. Once user clicks on Start button when
Owner is Operator, it is navigated to Parameter → Input Parameter tab, and from
Input Parameter tab user can select Strategy and start the sequence. After
clicking the Start button, that is placed at the bottom of Input Parameter tab, and
bottom section of the operator tab on faceplate displays:
• The step that is being executed and its number.
• The transition to the next step:
◦ Passive Galaxy style, page 47: The condition is not yet fulfilled.
◦ Active Galaxy style: The condition is true.
• The next step to be executed when the current step is completed and the
transition is true.
This table describes the command that corresponds to each button on the
Operation tab.

Button Command
Start

Hold

Pause

Restart/resume

Stop

310 EIO0000004360.04
$EMPatternCE: Equipment Module Functions Supervision Services

Button Command
Abort

Reset

NOTE: Only buttons that correspond to available commands are active (Active
Galaxy style, page 47). Unavailable commands are displayed with the Passive
Galaxy style.
This table describes the mode that corresponds to each button on the Operation
tab.

Button Mode Description

Auto Normal execution

Semi Asks for confirmation before transitioning

Man Allows you to select the step to execute

Operation Tab in Semi-Automatic Mode

This figure shows the Operation tab when Operator and the Semi mode are
selected.

The sequence starts in semi-automatic mode after clicking the Start button, that is
placed at the bottom of Input Parameter tab, and bottom section of the Operator
tab faceplate displays:
• The step that is being executed and its number.

EIO0000004360.04 311
Supervision Services $EMPatternCE: Equipment Module Functions

• The transition to the next step:

◦ Passive style: The condition is not yet fulfilled
◦ Active style: The condition is true.
• The next step to be executed.
• A Continue to Next Step button requiring the operator to confirm the
execution of the next step when the transition is true.

Operation Tab in Manual Mode

This figure shows the Operation tab when Operator and the Man mode are
selected.

The sequence starts in manual mode after clicking the Start button placed at
bottom of the Input Parameter tab, and the bottom section of the Operator tab
faceplate displays:
• The steps of the sequence that are programmed in the Running state.
• A Go To Step button allowing to execute the step selected in the Select the
Step to execute list.
You can scroll up and down (in six-step increments) through the list of steps by
using the two arrow buttons.

312 EIO0000004360.04
$EMPatternCE: Equipment Module Functions Supervision Services

Input/Ouput Parameters Tab

This figure shows the Parameters tab when the Input Parameters subtab is
selected.

You can select a strategy from the ones that have been defined and enter the
corresponding values for enabled parameters.
• Filter the Strategies shown from the drop-down list based on the currently
disabled strategies as determined from the logics in the controller. The drop-
down list is only editable while the Strategy status is Idle and Owner is in
Operator mode.
The Input Parameter tab consists of three columns:
• Description (read only): Description of input parameter.
• Value (read/write): The value is to be formatted as configured. Only editable
while the Strategy Status is Idle. Formatted as:
◦ Duration: Format of duration is T#DDdHHhMMSSsMSSms
◦ Date/Time: Date/Time as per regional settings.
◦ Numeric: Numeric value formatted as per the configured Format (for
example, 0, 0.0, 00000).
• EU (read only): EU is configured for the following specific data types:
◦ Duration, Date/Time: NA
◦ Numeric: Localized text as per the configured EU.
Sequence Start button is located at the bottom of the Input Parameter tab, that is
to be enabled only in case of the current equipment module Strategy that is in
Idle state and Owner is in Operator mode.
Parameters that do not pertain to the selected strategy are disabled.
NOTE: The parameters can be only modified when the sequence is in Idle
state.

EIO0000004360.04 313
Supervision Services $EMPatternCE: Equipment Module Functions

This figure shows the Parameters tab when the Output Parameters subtab is
selected.

Displays the values of output parameters, which are calculated while the
sequence is executed.
NOTE:
• Display cell area for column Value and EU of Input/Output parameter is
limited. However, if Value or EU is exceeding the optimal space available,
then it can be seen in tool tip.
• In Input/Output parameters, Value column will display NaN in case of
non-numeric variable or if the variable is not available in the controller.

314 EIO0000004360.04
$EMPatternCE: Equipment Module Functions Supervision Services

State Machine Tab

The above faceplate shows a simplified diagram of state machine.

Names of states appear in Passive style while the current state appears in Active
style.
NOTE: All the buttons are displayed with Passive style and cannot be used for
sending commands.

EIO0000004360.04 315
Supervision Services Equipment Module Object Configuration Pages

Equipment Module Object Configuration Pages

What’s in This Chapter
Main Page Default Configuration .................................................................. 316
Initial Conditions Page Default Configuration ................................................. 318
Failure Conditions Page Default Configuration............................................... 319
Input Parameters Page Default Configuration ................................................ 320
Output Parameters Page Default Configuration ............................................. 321
Input/Output Parameter Configuration for Equipment module ......................... 322

Overview
This chapter describes the default configuration of pages for equipment module
objects.
They allow you to configure optional supervision functions of process application
templates and their instances.
The default security classification to modify references is Configure.

Main Page Default Configuration

Overview
The Main page is used to modify the variable references used by the equipment
module object.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of sequential
control management, refer to chapter documenting the master template of the
equipment module.

316 EIO0000004360.04
Equipment Module Object Configuration Pages Supervision Services

Main Page Description

Element Default variable reference with suffix for auto-referencing

Equipment State <Instance name>_EMCTL_ST.EMSTATE

Strategy <Instance name>_EMCTL_ST.STRATEGY

Strategy Execution <Instance name>_EMCTL_ST.STATE

State
Command <Instance name>_EMCTL1_ST.COMMAND.

The default security classification is Operate.

Status Word <Instance name>_EMCTL1_ST.STW.

Configuration Word <Instance name>_EMCTL1_ST.CFGW.

The default security classification is Operate.

Elapsed Time <Instance name>_EMCTL1_ST.ETIME.

Current Step <Instance name>_EMCTL1_ST.CSTEPD;C.

Description

Disable Strategy <Instance name>_ EMCTL _ST.DISSTRATEGY.

Next Step (Manual) <Instance name>_EMCTL1_CFG.NSTEP.

The default security classification is Secured Write.

Step Descriptions <Instance name>_EMCTL1_CFG.STEPD;C.

Transition <Instance name>_EMCTL1_CFG.TRANSD;C.

Descriptions

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

There are sixteen default equipment states (0 to 15) available, and user can add
sixteen more equipment states (17 to 31) as per requirement.

EMSTATE Equipment Module Default State Description

0 Off
1 Stopped

2 Starting

EIO0000004360.04 317
Supervision Services Equipment Module Object Configuration Pages

EMSTATE Equipment Module Default State Description

3 Ready

4 Standby

5 Producing

6 Switching

7 Clearing

8 Holding

9 Held
10 Stopping

11 Aborting

12 Aborted
13 Reserved
14 Reserved
15 Reserved

Initial Conditions Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Initial
Conditions page is used to:
• Enable or disable initial conditions and define the initial condition descriptions.
When enabled, it allows you to:
◦ Enable or disable the bypass of initial conditions.
◦ Enable or disable the manual resetting of initial conditions.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of initial conditions,
refer to chapter documenting the master template of the equipment module.

Initial Conditions Page Description

318 EIO0000004360.04
Equipment Module Object Configuration Pages Supervision Services

Element Description

Enable Initial Select this check box to enable initial condition management.
Conditions
By default the variable reference with suffix for auto-referencing is
<Instance name>_IC_CONDSUM_ST.CONDW.

The default security classification is Free Access.

Enable Bypass of Select this check box to enable bypass of conditions.

Conditions
By default the variable reference with suffix for auto-referencing is
<Instance name>_IC_CONDSUM_ST.BYPASSW.

The default security classification is Free Access to enable the

bypassing function and Secured Write to bypass conditions during
operation.

Enable Manual Reset Select this check box to enable the manual resetting of conditions.
of Conditions
By default the variable reference with suffix for auto-referencing is
<Instance name>_IC_CONDSUM_ST.REARMREQW.

The default security classification is Free Access to enable the manual

reset function and Secured Write to reset conditions during operation.

Initial Condition Enter the initial condition descriptions (up to 15).

Description
The default security classification is Configure.
NOTE: The descriptions can be entered in multiple languages,
page 43.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

Failure Conditions Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Failure
Conditions page is used to:
• Enable or disable monitoring of detected failure conditions and define the
detected failure condition descriptions. When enabled, it allows you to:
◦ Enable or disable the bypass of detected failure conditions.
◦ Enable or disable the manual resetting of detected failure conditions.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of detected failure
condition management, refer to chapter documenting the master template of the
equipment module.

EIO0000004360.04 319
Supervision Services Equipment Module Object Configuration Pages

Failure Conditions Page Description

Element Description

Enable Failure Select this check box to enable the management of detected failure
Conditions conditions.

By default the variable reference with suffix for auto-referencing is

<Instance name>_FC_CONDSUM_ST.CONDW.

The default security classification is Free Access.

Enable Bypass of Select this check box to enable bypass of detected failure conditions.
Conditions
By default the variable reference with suffix for auto-referencing is
<Instance name>_FC_CONDSUM_ST.BYPASSW.

The default security classification is Free Access to enable the

bypassing function and Secured Write to bypass conditions during
operation.

Enable Manual Reset Select this check box to enable the manual resetting of detected failure
of Conditions conditions.

By default the variable reference with suffix for auto-referencing is

<Instance name>_FC_CONDSUM_ST.REARMREQW.

The default security classification is Free Access to enable the manual

reset function and Secured Write to reset conditions during operation.

Failure Condition Enter the condition descriptions (up to 15).

Descriptions
The default security classification is Free Access.
NOTE: The descriptions can be entered in multiple languages,
page 43.

Customized Specify a variable reference if the automatic referencing mechanism is

References not used.

Input Parameters Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Input
Parameters page is used to:
• Define input parameter descriptions.
• Configure the strategies.
The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.

320 EIO0000004360.04
Equipment Module Object Configuration Pages Supervision Services

For a description of the default template-specific configuration of input parameters

for sequential control, refer to chapter documenting the master template of the
equipment module.

Input Parameters Page Description

Element Description

Input Parameter Enter the input parameter descriptions. The number of parameters
Descriptions depends of the configuration made.

Customized (Alias) reference for input parameters.

NOTE: Descriptions can be entered in multiple languages, page 43.

Format The valid format entries are D (Duration), T (Date Time) and numeric
formats (for example: 0, 0.0, 0000).
NOTE: For configuration purposes, the decimal separator must be
Dot (.) and not any other type of separator, for example, Comma
(,). The run-time will use the configured language settings of the
local system.

Engineering Unit EU is configured for the following specific data types:

• Duration, Date/Time: NA
• Numeric: Localized text as per the configured EU.

Customized reference Customized reference for the input parameters.

Alias Alias for the input parameters.

Strategy Descriptions Enter the description of strategies (up to 16).

NOTE: Descriptions can be entered in multiple languages, page 43.

List of applicable Enter the input parameters applicable in each strategy separated by a
Input Parameters comma.

For example, if parameters 02 and 03 are applicable for the strategy,

enter 2,3.

NOTE: The default security classification of attributes of this page is Operate.

Output Parameters Page Default Configuration

Overview
Depending on the configuration of the corresponding control resource, the Output
Parameters page is used to define output parameter descriptions.

EIO0000004360.04 321
Supervision Services Equipment Module Object Configuration Pages

The references to control resources that are described use specific control
resources of the Modicon Libraries - General Purpose for AVEVA System
Platform.
For a description of the default template-specific configuration of parameters for
sequential control, refer to chapter documenting the master template of the
equipment module.

Output Parameters Page Description

Element Description

Output Parameter Enter the output parameter descriptions. The number of parameters
Descriptions depends of the configuration made.
NOTE: Descriptions can be entered in multiple languages, page 43.

Format The valid format entries are D (Duration), T (Date Time) and numeric
formats (for example: 0, 0.0, 0000).
NOTE: For configuration purposes, the decimal separator must be
Dot (.) and not any other type of separator, for example, Comma
(,). The run-time will use the configured language settings of the
local system.

Engineering Unit EU is configured for the following specific data types:

• Duration, Date/Time: NA
• Numeric: Localized text as per the configured EU.

Customized reference Customized reference for the output parameters.

Alias Alias for the output parameters.

NOTE: The default security classification of attributes of this page is Operate.

Input/Output Parameter Configuration for Equipment

module
Description
To configure the Input/Output parameters, you can create the variable tag and use
these variables for configuring the customized data type as per the requirement.
Below table show the various data types supported by the Equipment Module
input and output parameters.

322 EIO0000004360.04
Equipment Module Object Configuration Pages Supervision Services

Data Type (user) Unity Pro Data Type Valid format entries

Boolean BOOL <B>

Duration DINT <D>
Date/ Time DINT <T>
Numeric (Real) Real ASP format (for example, 0.00)

Numeric (Signed integer) INT ASP format (for example, 0)

Numeric (Double signed DINT ASP format (for example, 00000)

integer)

NOTE: By default template EMCTL.xml is configured with six input

parameters and four Output parameters with each data type. You can create
duplicate of EMCTL by deriving it.

EIO0000004360.04 323
Supervision Services

Pump Set
What’s in This Part
$PumpSetCtrlCE: Pump Set Pattern Functions .............................................. 325
Pump Set Pattern Object Configuration pages................................................ 329

324 EIO0000004360.04
$PumpSetCtrlCE: Pump Set Pattern Functions Supervision Services

$PumpSetCtrlCE: Pump Set Pattern Functions

What’s in This Chapter
Description ................................................................................................. 325
Control/Supervision Relationship.................................................................. 326
Parameters................................................................................................. 326
Default State Alarms.................................................................................... 327
Graphic Representation ............................................................................... 328
Faceplates.................................................................................................. 328

Overview
This chapter describes the master templates that provide the supervision
functions for Pump Set.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

1For 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.

Description
Introduction
This object is used for controlling 10 pumping assets. A pump, an inlet valve, an
outlet valve, and a drain valve are collectively referred to as a pumping asset.

EIO0000004360.04 325
Supervision Services $PumpSetCtrlCE: Pump Set Pattern Functions

Supervision Functions
For details about the main functions for Pump Set Equipment module
management,, page 305.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxPumpSet master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name for Used for
DDT**
EMCTLGP Equipment module logic EMCTLGP_ST_DDT <instance name>_EMCTL_ Core supervision
ST functions.
EMCTLGP_DDT_DDT <instance name>_EMCTL_
CFG
PUMPSETPAT- Pump Set Pattern user logic PumpSetGP_IOPar_DDT <instance name>_IOPAR User defined logic
TERNGP DFB for pump sets.

CONDSUMGP Detected failure condition CondsumGP_ST_DDT <instance name>_ Optional supervision

summary (default variable CONDSUM_ST functions.
naming convention <...
>_FC_CONDSUM_<...>)

Initial conditions (default <instance name>_

variable naming convention INITCOND_ST
<...>_IC_CONDSUM_<...
>)

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.
NOTE: You can configure optional functions from the template-specific
configuration pages, page 329.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Initial Value Description

Param.Data1.Desc String Pump Set Diagnosis State Refer to Equipment module,, page 306.

326 EIO0000004360.04
$PumpSetCtrlCE: Pump Set Pattern Functions Supervision Services

Parameter Type Initial Value Description

Param.Data1.Format String E

Param.Data1.PV Double Me.EMPar.OP01.OP.PV

Param.Data1.EU String Normal,0: Warning,1:
Failure,2

Param.Data2.Desc String Requested Pumps

Param.Data2.Format String 0

Param.Data2.PV Double Me.EMPar.OP02.OP.PV

Param.Data2.EU String

Param.Data3.Desc String Active Pumps

Param.Data3.Format String 0

Param.Data3.PV Double Me.EMPar.OP03.OP.PV

Param.Data3.EU String

Param.Data4.Desc String Pump 01 Operation Time

Param.Data4.Format String D

Param.Data4.PV Double Me.EMPar.OP04.OP.PV

Param.Data4.EU String

Param.HideAbortButton Bool False Refer to Equipment module,, page 306.

Param.HideHoldButton Bool False
Param.HidePauseButton Bool False
Param.HideResetButton Bool False
Param.HideRestartButton Bool False
Param.HideStartButton Bool False
Param.HideStopButton Bool False

Param.ModeNormal String O,P

Param.NumInputParam 0 Number of input parameters.

Param.NumOutputParam 0 Number of output parameters.

Param.DisplaySelection Integer 0 0: Pump Operation time, 1: Pump Operation Count,

2: Pump Idle time, 3: Pump Run Time

Param.NumberofAssets Integer 2 Number of assets connected.

Default State Alarms

State Alarms for Pump Set Module
The table indicates for which attributes a state alarm is configured in the
$PumpSetCtrlCE master template and provides the default values.

Attribute Alarm message Priority

AO.Failure Failure condition triggered during execution 999

AO.Diagnosis.PumpSet.Alarm 1 At least one Pumping Asset is in failure 999

AO.Diagnosis.PumpSet.Fail 1 Unable to run requested pumps 500

AO.Diagnosis.PumpingAsset{x}.Alarm1 Asset {y} alarm description 999

AO.Diagnosis.PumpingAsset{x}.Fail1 Asset {y} failure description 500

EIO0000004360.04 327
Supervision Services $PumpSetCtrlCE: Pump Set Pattern Functions

Attribute Alarm message Priority

1 indicates that the User should acknowledge these alarms from the alarm banner.

NOTE: {x} represents from 01 to 10 and {y} represents from 1 to 10.

NOTE: You can modify the configuration from the Attributes page.
For details about the default Strategy and its applicable input parameters,
EMState configured for $PumpSetCtrlCE template refer to, (see Modicon
Libraries General Purpose, Equipment Module Components User Guide) .
For details about the default configuration for DATA1 to DATA4,, page 326.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
The symbols available for representing the Pump Set equipment module, refer,
page 308.

Faceplates
Overview
During operation, clicking a equipment module graphic symbol opens a faceplate
with the following tabs:
• Standard tabs:
◦ Operation, page 310
◦ Parameters (input and output parameters), page 313
◦ State machine, page 315
◦ Alarms, page 75
• Optional tabs:
◦ Initial Conditions, page 65
◦ Failures , page 68

328 EIO0000004360.04
Pump Set Pattern Object Configuration pages Supervision Services

Pump Set Pattern Object Configuration pages

What’s in This Chapter
Default Configuration Pages......................................................................... 329

Default Configuration Pages

The Object configuration pages for pump set pattern are as follows:
• Main Page Default Configuration, page 316
• Initial Conditions Page Default Configuration, page 318
• Failure Conditions Page Default Configuration, page 319
• Input Parameters Page Default Configuration, page 320
• Output Parameters Page Default Configuration, page 321

EIO0000004360.04 329
Supervision Services

Flow Control
What’s in This Part
$PumpFlowCtrlCE: Flow Control Pattern Functions ........................................ 331
Flow Control Pattern Object Configuration pages............................................ 335

330 EIO0000004360.04
$PumpFlowCtrlCE: Flow Control Pattern Functions Supervision Services

$PumpFlowCtrlCE: Flow Control Pattern Functions

What’s in This Chapter
Description ................................................................................................. 331
Control/Supervision Relationship.................................................................. 332
Parameters................................................................................................. 332
Default State Alarms.................................................................................... 333
Graphic Representation ............................................................................... 334
Faceplates.................................................................................................. 334

Overview
This chapter describes the master templates that provide the supervision
functions for Flow Control.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

1For 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.

Description
Introduction
This object is used for controlling 10 pumping assets. A variable speed pump, an
inlet valve, an outlet valve, and a drain valve are collectively referred to as a
pumping asset.

EIO0000004360.04 331
Supervision Services $PumpFlowCtrlCE: Flow Control Pattern Functions

Supervision Functions
For details about the Supervision functions for Flow Control Equipment Module,
page 305.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxFlowCtl master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name for Used for
DDT**
EMCTLGP Equipment module logic EMCTLGP_ST_DDT <instance name>_EMCTL_ Core supervision
ST functions.
EMCTLGP_DDT_DDT <instance name>_EMCTL_
CFG
FLOWCTLPAT- Flow Control Pattern user FlowCTLGP_IOPar_DDT <instance name>_IOPAR User defined logic
TERNGP logic DFB for flow control.

CONDSUMGP Detected failure condition CondsumGP_ST_DDT <instance name>_ Optional supervision

summary (default variable CONDSUM_ST functions.
naming convention <...
>_FC_CONDSUM_<...>)

Initial conditions (default <instance name>_

variable naming convention INITCOND_ST
<...>_IC_CONDSUM_<...
>)

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.
NOTE: You can configure optional functions from the template-specific
configuration pages, page 329.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Initial Value Description

Param.Data1.Desc String Equipment module diagnosis Refer to Equipment module,, page 306.
state

332 EIO0000004360.04
$PumpFlowCtrlCE: Flow Control Pattern Functions Supervision Services

Parameter Type Initial Value Description

Param.Data1.Format String E

Param.Data1.PV Double Me.EMPar.OP01.OP.PV

Param.Data1.EU String Normal,0: Warning,1:
Failure,2

Param.Data2.Desc String Current Flow SP

Param.Data2.Format REAL 0.0

Param.Data2.PV Double Me.EMPar.OP02.OP.PV
Param.Data2.EU String -

Param.Data3.Desc String Flow PV

Param.Data3.Format REAL 0.0

Param.Data3.PV Double Me.EMPar.OP03.OP.PV
Param.Data3.EU String -

Param.Data4.Desc String Pumps required to achieve

Flow SP
Param.Data4.Format String 0

Param.Data4.PV Double Me.EMPar.OP04.OP.PV

Param.Data4.EU String -

Param.HideAbortButton Bool False Refer to Equipment module,, page 306.

Param.HideHoldButton Bool False
Param.HidePauseButton Bool False
Param.HideResetButton Bool False
Param.HideRestartButton Bool False
Param.HideStartButton Bool False
Param.HideStopButton Bool False

Param.ModeNormal String O,P

Param.NumInputParam 0 Number of input parameters.

Param.NumOutputParam 0 Number of output parameters.

Param.DisplaySelection Integer 0 0: Pump Operation time, 1: Pump Operation Count,

2: Pump Idle time, 3: Pump Run Time

Param.NumberofAssets Integer 2 Number of assets connected.

Default State Alarms

State Alarms for Flow Control Equipment Module
The table indicates for which attributes a state alarm is configured in the
$PumpFlowCtrlCE master template and provides the default values.

Attribute Alarm message Priority

AO.Failure Failure condition triggered during execution 999

AO.Diagnosis.FlowCtl.Alarm 1 At least one Pumping Asset is in failure 999

AO.Diagnosis.FlowCtl.Fail 1 Unable to run requested pumps 500

AO.Diagnosis.PumpingAsset{x}.Alarm1 Asset {y} alarm description 999

AO.Diagnosis.PumpingAsset{x}.Fail1 Asset {y} failure description 500

EIO0000004360.04 333
Supervision Services $PumpFlowCtrlCE: Flow Control Pattern Functions

Attribute Alarm message Priority

1 indicates that the User should acknowledge these alarms from the alarm banner.

NOTE: {x} represents from 01 to 15 and {y} represents from 1 to 15

NOTE: You can modify the configuration from the Attributes page.
For details about the applicable input parameters, EMState configured for
$PumpFlowCtrlCE template refer to, (see Modicon Libraries General Purpose,
Equipment Module Components User Guide).
For details about the default configuration for DATA1 to DATA4,, page 326.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
The symbols available for representing the Flow Control Equipment Module, refer,
page 308.

Faceplates
Overview
During operation, clicking a equipment module graphic symbol opens a faceplate
with the following tabs:
• Standard tabs:
◦ Operation, page 310
◦ Parameters (input and output parameters), page 313
◦ State machine, page 315
◦ Alarms, page 75
• Optional tabs:
◦ Initial Conditions, page 65
◦ Failures , page 68

334 EIO0000004360.04
Flow Control Pattern Object Configuration pages Supervision Services

Flow Control Pattern Object Configuration pages

What’s in This Chapter
Default Configuration Pages......................................................................... 335

Default Configuration Pages

The Object configuration pages for Flow Control Equipment Module pattern are as
follows:
• Main Page Default Configuration, page 316
• Initial Conditions Page Default Configuration, page 318
• Failure Conditions Page Default Configuration, page 319
• Input Parameters Page Default Configuration, page 320
• Output Parameters Page Default Configuration, page 321

EIO0000004360.04 335
Supervision Services

Auxiliary Functions
What’s in This Part
$AlarmSummaryCE: Alarm Summary ............................................................ 337
$IlckCE/$ICCE: Extended Interlocks/Initial Conditions..................................... 341
$AnalogSelectCE: Analog Signal Selection .................................................... 344
$MessageBoxCE: Operator Messages .......................................................... 348
$SPBoolCE: Discrete Setpoints..................................................................... 352
$SPRealCE: Real Setpoints.......................................................................... 354
$SPIntCE: Integer Setpoints ......................................................................... 356
$SPDurationCE: Duration Setpoints .............................................................. 358
$SchedulerCE: Scheduler function ................................................................ 361

Overview
This part describes the master templates that provide the supervision functions for
the auxiliary function family.
You can use these templates with those of other families to provide additional
services, data, symbols, and/or faceplates.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

336 EIO0000004360.04
$AlarmSummaryCE: Alarm Summary Supervision Services

$AlarmSummaryCE: Alarm Summary

What’s in This Chapter
Supervision Functions ................................................................................. 337
Control/Supervision Relationship.................................................................. 337
Parameters................................................................................................. 338
Default State Alarms.................................................................................... 338
Graphic Representation ............................................................................... 338
Faceplates.................................................................................................. 339

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of alarms based on up to 15 conditions.

Supervision Functions
Description
Core resources provide the following monitoring and operation functions: Alarm
configuration, enabling/disabling of alarms, simulation mode, management of
individual alarm conditions.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxAlarmSummary master template
is configured to exchange data with the following control resources of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
DINPUTGP Logic DInputGP_ST_DDT <instance name>_ Core supervision
DIGP_ST functions.

CONDSUMGP Summary of conditions. CondsumGP_S_DDTT <instance name>_ Optional supervision

Condsum_ST functions.

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

EIO0000004360.04 337
Supervision Services $AlarmSummaryCE: Alarm Summary

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Default Description

Param. Bool True If true, the alarm evaluation at the supervision

AlarmEnable level is enabled.

If false, the alarm evaluation at the supervision

level is disabled.
NOTE: The alarm signal is not interpreted as
an alarm at the supervision level but it
continues being evaluated at the controller
level. It is useful for signals to be monitored
but not associated to an alarm.

Default State Alarms

State Alarms for Alarm Summary
The table indicates for which attributes a state alarm is configured in the
$AlarmSummaryCE master template and provides the default values.

Attribute Alarm message Priority

AO.Alarm Digital Alarm 500

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available for representing the alarm summary:

338 EIO0000004360.04
$AlarmSummaryCE: Alarm Summary Supervision Services

Name Graphic symbol Description

AlarmText Alarm text

StatusIndicator_H Bullet with the

label above

StatusIndicator_V Bullet with the

label on the right

Faceplates
Overview
During operation, clicking the graphic symbol opens a faceplate with the following
tabs:
• Standard tabs:
◦ Operation
◦ Engineering
◦ Alarms, page 75
• Optional tabs:
◦ Failures, page 68

Operation Tab
The figure shows an example of the Operation tab.

EIO0000004360.04 339
Supervision Services $AlarmSummaryCE: Alarm Summary

Engineering Tab
The figure shows an example of the Engineering tab.

NOTE: This tab features the Simulation menu, which allows setting the
control module to simulation mode.
In addition, the tab may feature another menu or text field, which allows you to
configure the state or value to be simulated.
Enabling the simulation mode underlies a security classification, page 89. The
default configuration is tune. It also triggers the display of an abnormal state,
page 46 on the tab and on the symbol.

340 EIO0000004360.04
$IlckCE/$ICCE: Extended Interlocks/Initial Conditions Supervision Services

$IlckCE/$ICCE: Extended Interlocks/Initial

Conditions
What’s in This Chapter
Supervision Functions ................................................................................. 341
Control/Supervision Relationship.................................................................. 341
Parameters................................................................................................. 341
Default State Alarms.................................................................................... 342
Graphic Representation ............................................................................... 342
Faceplates.................................................................................................. 342

Overview
This chapter describes the supervision resources and runtime services that are
available for extended interlocks/initial conditions functionality.

Supervision Functions
Description
The $IlckCE allows the extension of interlocks and $ICCE allows the extension of
initial conditions. Each interlock/initial condition of a process function object can
be extended to fifteen sub conditions.
NOTE: For configuration of the $IlckCE/$ICCE template refer.

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxIlck/$PSxIC master
template is configured to exchange data with the following control resource of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
CONDSUMGP Summary of conditions. CondsumGP_S_DDTT <instance name>_ Optional supervision
Condsum_ST functions.

** Mandatory variables to be defined.

For description of the control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

Parameters
There are no parameters to be configured.

EIO0000004360.04 341
Supervision Services $IlckCE/$ICCE: Extended Interlocks/Initial Conditions

Default State Alarms

State Alarms for Extended Interlocks
No state alarm is configured by default for the $IlckCE/$ICCE master template.
NOTE: You can modify the configuration from the attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
There is no representation available.

Faceplates
Overview
During operation, clicking the extended interlock/initial condition symbol opens a
faceplate with the extended interlock/initial condition tab:

For standard features of the faceplate refer, page 65.

342 EIO0000004360.04
$IlckCE/$ICCE: Extended Interlocks/Initial Conditions Supervision Services

NOTE: The functionality and configuration of $IlckCE and $ICCE are exactly
same, except for the security configuration of the bypass function. The
security configured for the bypass is VerifiedWrite in $IlckCE and
SecuredWrite in $ICCE.

EIO0000004360.04 343
Supervision Services $AnalogSelectCE: Analog Signal Selection

$AnalogSelectCE: Analog Signal Selection

What’s in This Chapter
Supervision Functions ................................................................................. 344
Control/Supervision Relationship.................................................................. 344
Parameters................................................................................................. 345
Default State Alarms.................................................................................... 345
Graphic Representation ............................................................................... 345
Faceplates.................................................................................................. 346

Overview
This chapter describes the $AnalogSelectCE master template, which contains
supervision resources to monitor and select analog signals.

Supervision Functions
Description
The $AnalogSelectCE master template provides the following core monitoring and
operation functions:
• Monitoring of values of up to four analog signals.
• Selecting one signal out of the monitored signals, either directly or by
selecting the one with the highest or lowest value.
• Owner selection.
• Alarm management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxASelect1 master template is
configured to exchange data with the following control resource of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
ASELECTGP Analog selector logic. ASelectGP_ST_DDT <instance name>_ Core supervision
ASelectGP_ST functions.

ASelectGP_CFG_DDT <instance name>_

ASelectGP_CFG

** Mandatory variables to be defined.

For description of this control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

344 EIO0000004360.04
$AnalogSelectCE: Analog Signal Selection Supervision Services

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$AnalogSelectCE master template attributes.

Name Data type Initial value Description

Param.EngUnits String % Indicates the unit of attributes.

Param.HiSP Integer 100 High limit for the setpoint.

Param.LoSP Integer 0 Low limit for the setpoint.

Param.ModeNormal String O,P Specifies the normal owner modes (separated by a comma):
• O: Operator
• P: Program
For example, O,P.

Param.NumFormat String 0.0 Specifies the display format of values.

For example, enter 0.00 to display 2 decimals.

Param.ShortDescSP1... String SetPoint x where x 4 parameters, each one describing an analog signal, which is
Param.ShortDescSP4 corresponds to the monitored.
number of the NOTE: The initial value is also available in Spanish.
parameter.

Default State Alarms

State Alarms for Analog Signal Selection
The table indicates for which attributes a state alarm is configured in the
$AnalogSelectCE master template and provides the default values.

Attribute Description Priority

ASelect11.St.Error Signal Error 500

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

EIO0000004360.04 345
Supervision Services $AnalogSelectCE: Analog Signal Selection

Symbol Description
The table describes the symbols that are included in the $AnalogSelectCE master
template to display data for monitoring and selecting analog signals during
operation.

Name Graphic symbol Description

Desc_SP In addition to icons, the symbol displays

(from top to bottom):
• The label.
• The short description of the
selected signal.

Indicator_SP In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• The value of the selected signal.
• The short description of the
selected signal.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an analog signal selection symbol opens a faceplate
with the following tabs:
• Operation
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

346 EIO0000004360.04
$AnalogSelectCE: Analog Signal Selection Supervision Services

Operation Tab
The figure shows an example of the operation tab. The description and value of
the selected signal is shown at the top of the tab. The 2 available signals and their
value are shown below.

EIO0000004360.04 347
Supervision Services $MessageBoxCE: Operator Messages

$MessageBoxCE: Operator Messages

What’s in This Chapter
Supervision Functions ................................................................................. 348
Control/Supervision Relationship.................................................................. 348
Parameters................................................................................................. 349
Default State Alarms.................................................................................... 349
Graphic Representation ............................................................................... 349
Faceplates.................................................................................................. 350

Overview
This chapter describes the $MessageBoxCE master template, which contains
supervision resources to manage messages to operators.

Supervision Functions
Description
The $MessageBoxCE master template provides the following core functions:
• Display of 1 message in the symbol and, in addition, in the faceplate:
◦ Display and capture of up to 2 data items, which are associated with the
message.
◦ For each data item, display of up to 1 additional message.
• Configuration of the message mode with 4 different icons, which are
displayed next to the symbol.
• Message treatment.
• Alarm management associated to the icons, which are displayed.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxMessageBox master template is
configured to exchange data with the following control resource of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
MSGBOXGP Logic for messages to MSGBoxGP_ST_DDT <instance name>_ Core supervision
operators. MSGBoxGP_ST functions.

MSGBoxGP_CFG_DDT <instance name>_

MSGBoxGP_CFG

** Mandatory variables to be defined.

For description of the control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

348 EIO0000004360.04
$MessageBoxCE: Operator Messages Supervision Services

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$MessageBoxCE master template attributes.

Name Data Initial Description

type value

Param.NumFormat String 0.0 Specifies the display format of values.

For example, enter 0.00 to display 2 decimals.

Default State Alarms

State Alarms for Operator Messages
The table indicates for which attributes a state alarm is configured in the
$MessageBoxCE master template and provides the default values.

Attribute Description Priority

MsgBox.AO.Stop MsgBox Error 999

MsgBox.AO.Exclamation MsgBox Warning 750

NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $MessageBoxCE master
template to display messages to the operator during operation.

EIO0000004360.04 349
Supervision Services $MessageBoxCE: Operator Messages

Name Graphic symbol Description

MsgBoxTypeNormal- Displays the message by using element style

WithIcon User_Defined_06.

It also displays the following icons, page 48 on the

left-hand side of the message box:
• Stop
• Exclamation mark
• Question mark
• Information
The icons blink when the OK or OK and Cancel
buttons are enabled.
MsgBoxTypeNormal- Displays the message by using element style
WithoutIcon User_Defined_07, no icons.

MsgBoxTypelargeWi- Displays icons in the same position and with the

thIcon same behavior as symbol
MsgBoxTypeNormalWithIcon but uses element
style User_Defined_02, which has large-size text
to display the message.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an operator message box symbol opens a faceplate
with the following tabs:
• Operation
• Alarms

Operation Tab
The items that are displayed depend on the configuration of the sc public variable
(MSGBOX_SC_DDT) of the associated control resource:
• Icon and message.
• Up to 2 additional messages.
• A data item associated to each message. Entering data underlies the Operate
security classification, page 36.
• OK or OK and Cancel buttons. Using these buttons underlies the Operate
security classification, page 36

350 EIO0000004360.04
$MessageBoxCE: Operator Messages Supervision Services

The figure shows an example of the operation tab featuring the icon, the message, as well as 2 additional
messages with their associated data item. It also shows a button.

Alarms Tab
The $MessageBoxCE master template allows managing two alarms, page 38,
which are associated to message modes that display the following icons:
• Exclamation mark icon: Alarm severity 3 (attribute MsgBox.AO.Exclamation).
• Stop icon: Alarm severity 4 (attribute MsgBox.AO.Stop).
For a description of the tab, refer to the topic documenting the alarms tab, page
75.

EIO0000004360.04 351
Supervision Services $SPBoolCE: Discrete Setpoints

$SPBoolCE: Discrete Setpoints

What’s in This Chapter
Supervision Functions ................................................................................. 352
Parameters................................................................................................. 352
Default State Alarms.................................................................................... 353
Graphic Representation ............................................................................... 353

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of setpoints of discrete data type.

Supervision Functions
Description
The $SPBoolCE template is used to enter a boolean setpoint/value from the
supervision runtime. The value can be set by using various types of symbols that
are referenced by the template.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Default Description

Param.HideLegend Bool False If true, the legend (object description) is not

displayed.

If false, the legend is displayed.

Param. Elapsed 00:00:0- Period during which the output remains true when
PulseDuration Time 5.0000- the button is clicked. Only applicable if the symbol
000 is pushbutton, page 353 style.

352 EIO0000004360.04
$SPBoolCE: Discrete Setpoints Supervision Services

Default State Alarms

State Alarms for Discrete Setpoints
No state alarm is configured by default for the $SPBoolCE master template.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available to represent discrete setpoints:

Name Graphic symbol Description

LatchButton The output is set (1) when the symbol is

latched and remains 1, until unlatched.

CheckBox The output is set (1) when the check box

is selected and remains 1, until
unselected.

PulseButton When clicked, the output is set (1) for a

period that you can configure.

Refer to Parameters, page 352

Faceplate
No faceplate is available.

EIO0000004360.04 353
Supervision Services $SPRealCE: Real Setpoints

$SPRealCE: Real Setpoints

What’s in This Chapter
Supervision Functions ................................................................................. 354
Parameters................................................................................................. 354
Default State Alarms.................................................................................... 355
Graphic Representation ............................................................................... 355

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of setpoints of REAL data type.

Supervision Functions
Description
The $SPRealCE template is used to enter a real setpoint/value from the
supervision runtime.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Default Description

Param.EngUnits String - Unit of the setpoint (SP)

Param.HideLegend Bool False If true, the legend (object description) is not

displayed.

If false, the legend is displayed.

Param.HiPV Float 100.0 High limit for the setpoint value

Param.LoPV Float 0.0 Low limit for the setpoint value

Param.NumFormat String 0.0 Specifies the displaying format of the setpoint.

For example, enter 0.00 for 2 decimal.

354 EIO0000004360.04
$SPRealCE: Real Setpoints Supervision Services

Default State Alarms

State Alarms for Setpoints of Real Data Type
No state alarm is configured by default for the $SPRealCE master template.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available to represent REAL setpoints:

Name Graphic symbol Description

RealSetPoint Setpoint value

Faceplate
No faceplate is available.

EIO0000004360.04 355
Supervision Services $SPIntCE: Integer Setpoints

$SPIntCE: Integer Setpoints

What’s in This Chapter
Supervision Functions ................................................................................. 356
Parameters................................................................................................. 356
Default State Alarms.................................................................................... 357
Graphic Representation ............................................................................... 357

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of setpoints of INT data type.

Supervision Functions
Description
The $SPIntCE template is used to enter an integer setpoint/value from the
supervision runtime.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Default Description

Param.EngUnits String % Unit of the setpoint

Param.HideLegend Bool False If true, the legend (object description) is not

displayed.

If false, the legend is displayed.

Param.HiPV Integer 100 High limit for the setpoint (SP)

Param.LoPV Integer 0 Low limit for the setpoint

Param.NumFormat String 0.0 Specifies the displaying format of setpoint.

For example, enter 0.00 for 2 decimal.

356 EIO0000004360.04
$SPIntCE: Integer Setpoints Supervision Services

Default State Alarms

State Alarms for Setpoints of Integer Data Type
No state alarm is configured by default for the $SPIntCE master template.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available to represent integer setpoints:

Name Graphic symbol Description

IntegerSetPoint Setpoint value

Faceplates
No faceplate is available.

EIO0000004360.04 357
Supervision Services $SPDurationCE: Duration Setpoints

$SPDurationCE: Duration Setpoints

What’s in This Chapter
Supervision Functions ................................................................................. 358
Parameters................................................................................................. 359
Default State Alarms.................................................................................... 359
Graphic Representation ............................................................................... 359

Overview
This chapter describes the supervision resources and runtime services that are
available for the management of setpoints of Duration data type.

Supervision Functions
Description
The SPDurationCE template allows you to set a Control Expert variable of type
TIME representing a time duration in milliseconds.
During operation, the symbol allows you to enter a duration in various ways,
based on the format T#DDdHHhMMmSSsMSSms.
The duration is displayed by using 5 time components:

Time component Description Maximum value(1)

DD Days component 24

HH Hours component 99(2)

MM Minutes component 59

SS Seconds component 59

MSS Milliseconds component 999

(1) You need to configure the high end of the setpoint range accordingly.

(2) Values equal to or higher than 24 are converted to days and hours.

Rules Applicable to Durations

The table describes the rules that apply when you enter durations in the symbol
during operation:

Object of the rule Description Example

Conversion of entries The symbol converts hour values that you enter Entering T#50h20m10s displays� displays
and that are equal to or higher than 24 to days T#2d2h20m10s
and hours.
Durations starting with To enter a duration in minutes and seconds or Entering T#20m10s displays T#20m10s
minutes components milliseconds, enter the value in the format
T#DDdHHhMMmSSsMSSms..

358 EIO0000004360.04
$SPDurationCE: Duration Setpoints Supervision Services

Object of the rule Description Example

Durations expressed in The symbol accepts the entry of durations Entering T#119s displays T#1m59s
seconds expressed in seconds in the format T#SSs and
converts the value to the Entering T#3s displays T#3s
T#DDdHHhMMmSSsMSSms format.
Durations expressed in The symbol accepts the entry of durations Entering T#2ms displays T#2ms
milliseconds expressed in milliseconds in the format
T#MSSms.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
This table describes the parameters of the automation object:

Parameter Type Default Description

Param.HideLegend Bool False If true, the legend (object description) is not

displayed.

If false, the legend is displayed.

Default State Alarms

State Alarms for Setpoints of Duration Data Type
No state alarm is configured by default for the $SPDurationCE master template.
NOTE: You can modify the configuration from the Attributes page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
This table describes the symbols available to represent duration setpoints:

EIO0000004360.04 359
Supervision Services $SPDurationCE: Duration Setpoints

Name Graphic symbol Description

DurationSetPoint Shows the time value and legend.

Default display:
T#12d22h59m59s999ms

Display Format
The table describes the rules that apply to display the duration values that you
enter:

Description Data entry example Display

The symbol displays only the time T#320ms T#320ms

components that you enter (or that is the
result of the conversion), if different from 0, in T#3s5ms T#3s5ms
the format T#DDdHHhMMmSSsMSSms..
T#2h10m5s T#2h10m5s000ms
NOTE:
T#50d20h10m T#2d2h20m10s000ms
• The leading 0 of the highest time
component is not displayed.
• The millisecond component is
displayed with 3 digits.
• The day component is displayed
only if you enter a value for this
component.

Faceplates
No faceplate is available.

360 EIO0000004360.04
$SchedulerCE: Scheduler function Supervision Services

$SchedulerCE: Scheduler function

What’s in This Chapter
Supervision Functions ................................................................................. 361
Control/Supervision Relationship.................................................................. 361
Parameters................................................................................................. 362
Default State Alarms.................................................................................... 362
Graphic Representation ............................................................................... 362
Faceplates.................................................................................................. 363

Overview
This chapter describes the $SchedulerCE master template, which contains
supervision resources to schedules based on events or time driven schedules.

Supervision Functions
General Description
The $SchedulerCE template is used to schedules based on events or time
driven schedules. The template allows user to select up to 10 different schedules
which can be configured either event or time schedule

Functional Description
The main functions of motor template are described in the following table:

Function Description

Time scheduling The template compares the current PLC time with configured event times in
the Schedule data. After comparison, the function block releases the outputs.

Event scheduling The template compares the status of the event as per the event configured in
template and if the event is active, then function block releases the outputs.

Scheduler status Active or Inactive

The scheduler module is in operation when scheduler status is set to active

on faceplate.

Mode selection The object can be switched to different modes of operation like On, Off, and
Pulse.
Pulse timing If user selects the mode as Pulse, then user can select the Pulse On time and
Off time either in seconds, minutes, or hours based on the selection in Pulse
Time In on the faceplate.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxScheduler master template is
configured to exchange data with the following control resource of the Modicon
Libraries - General Purpose for Control Expert.

EIO0000004360.04 361
Supervision Services $SchedulerCE: Scheduler function

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
SchedulerGP Scheduler logic SchedulerGP_ST_DDT <instance name>_ Core supervision
SCHDLRGP_ST functions.

SchedulerGP_ST_DDT <instance name>_ Optional - based on

SCHDL0{x}GP_ST number of schedule
NOTE: {x} selection.
represents from 1 to
10.

NOTE: ** Mandatory variables to be defined.

For description of this control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the $SchedulerCE
master template attributes.

Name Data type Initial value Description

Param.NumFormat String 0.0 Specifies the display format of values.

For example, enter 0.00 to display 2 decimals.

Default State Alarms

State Alarms for Scheduler function
No state alarms are configured for attributes of the $SchedulerCE master
templates.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

362 EIO0000004360.04
$SchedulerCE: Scheduler function Supervision Services

Symbol Description
The table describes the symbols that are included in the $SchedulerCE master
template to display data for monitoring and selecting analog signals during
operation.

Name Graphic symbol Description

Scheduler Active scheduler with input value

Scheduler_SV Inactive scheduler with input value

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an analog signal selection symbol opens a faceplate
with the following tabs:
• Operation

EIO0000004360.04 363
Supervision Services $SchedulerCE: Scheduler function

Operation Tab

364 EIO0000004360.04
 Supervision Services

Smart Device Control

What’s in This Part
Default State Alarms for Devices ................................................................... 366
Circuit Breakers ........................................................................................... 367
Digital Protection Relays ............................................................................... 395
Motor Controllers and Starters....................................................................... 408
Power Measurement .................................................................................... 418
Soft Starters................................................................................................. 426
Speed Drives ............................................................................................... 440

Overview
This part describes the master templates that provide the supervision functions for
families of the device category.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

EIO0000004360.04 365
Supervision Services Default State Alarms for Devices

Default State Alarms for Devices

What’s in This Chapter
Default State Alarms for Devices .................................................................. 366

Default State Alarms for Devices

Description
The table indicates for which attributes a state alarm is configured in master
templates of the device category, page 27 and provides the default values.

Attribute Alarm message Priority

AO.Namur.OutOfSpecs Out of Specs 999

AO.Namur.MaintenanceR Maintenance Required 999

AO.Namur.CheckFunction Check Function 750

AO.Namur.Failure Failure 500

NOTE: You can modify the configuration from the Attributes page.

366 EIO0000004360.04
Circuit Breakers Supervision Services

Circuit Breakers
What’s in This Chapter
$CompactNSXMBUCE: Compact NSX Circuit Breakers................................. 367
$MasterpactMTZCMBUCE: Masterpact MTZ Circuit Breakers with
Chassis ...................................................................................................... 371
$MasterpactMTZMBUCE: Masterpact MTZ Circuit Breaker without
Chassis ...................................................................................................... 376
$MasterpactNxMBUCE: Masterpact Nx Circuit Breaker without Chassis (x=
T/W)........................................................................................................... 380
$MasterpactNxCMBUCE: Masterpact Nx Circuit Breakers with Chassis (x=
T/W)........................................................................................................... 383
$MasterpactHWCE: Hardwired Circuit Breaker.............................................. 387
$CompactHWCE: Hardwired Compact Circuit Breaker................................... 390

Overview
This chapter describes the master templates that provide the supervision
functions for the circuit breaker family.

$CompactNSXMBUCE: Compact NSX Circuit Breakers

Overview
This section describes the $CompactNSXMBUCE master template, which
contains supervision resources to monitor and operate Compact NSX circuit
breakers.

Supervision Functions
Description
The $CompactNSXMBUCE master template provides the following monitoring
and operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxCompact master template is
configured to exchange data with the following control resources of the Modicon
Libraries - General Purpose for Control Expert.

EIO0000004360.04 367
Supervision Services Circuit Breakers

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
MBUCOMPACTNSX Logic for Compact NSX COMPACT_ST_DDT <instance name>_ Core supervision
circuit breaker Compact_ST functions.
management Modbus
over ULP. COMPACT_CFG_DDT <instance name>_
Compact_CFG

COMPACT_MEA_DDT <instance name>_

Compact_Mea

COMPACT_MEAExt_DDT <instance name>_

Compact_MeEx

COMPACT_MEAExt1_DDT <instance name>_

Compact_MeEx1

NOTE:
• ** Mandatory variables to be defined.
• The syntax of the Instance name must be same as the Variable name excluding the variable specific suffixes like _ST, _CFG etc.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the
$CompactNSXMBUCE master template attributes.

Name Data Initial Description

type value

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

368 EIO0000004360.04
Circuit Breakers Supervision Services

Default State Alarms and Additional Alarm Conditions

Overview
In the $CompactNSXMBUCE master template, alarms related to core supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Compact NSX Circuit Breakers

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Compact NSX Circuit Breakers

The table indicates for which bits an alarm is configured in the
$CompactNSXMBUCE master template and provides the associated Namur
status.

Word structure Bit Description Namur status

COMPACT_CFG.DataStatus 2 SD electrical trip Failure

3 SDE electrical trip Failure

4 Status Not available Failure

COMPACT_CFG.WarningCode 0 User defined flag 201 Failure

1 User defined flag 202 Failure

2 User defined flag 203 Failure

3 User defined flag 204 Failure

4 User defined flag 205 Failure

5 User defined flag 206 Failure

6 User defined flag 207 Failure

7 User defined flag 208 Failure

8 User defined flag 209 Failure

9 User defined flag 210 Failure

10 Long time protection Failure

11 Earth leakage Failure

12 Ground fault Failure

13 Long time pickup Failure

COMPACT_CFG.WarningOrderCode 1 Wrong password Check Function

2 Modbus pad locked Check Function

3 Detected internal alarm Failure

4 Out of order Check Function
5 Need reset Check Function

10 Not present Failure

EIO0000004360.04 369
Supervision Services Circuit Breakers

NOTE: You can modify the configuration from the Discrete 1, Discrete 2, and
Discrete 3 pages.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $CompactNSXMBUCE
master template to display data of Compact NSX circuit breakers during
operation.

Name Graphic symbol Description

CompactNSX Compact NSX circuit breaker symbol and icons.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a Compact NSX circuit breaker symbol opens a
faceplate with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75

370 EIO0000004360.04
Circuit Breakers Supervision Services

Operation Tab
The figure shows an example of the operation tab.

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

$MasterpactMTZCMBUCE: Masterpact MTZ Circuit

Breakers with Chassis
Overview
This section describes the $MasterpactMTZCMBUCE master template, which
contains supervision resources to monitor and operate Masterpact MTZ circuit
breakers.

EIO0000004360.04 371
Supervision Services Circuit Breakers

Supervision Functions
Description
The $MasterpactMTZCMBUCE master template provides the following monitoring
and operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxMasterpactMTZC master template
is configured to exchange data with the following control resources of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
MBUMASTERPACTMTZC Logic for Masterpact MTZ MASTERPACT_ST_DDT <instance name>_ Core supervision
circuit breakers with MPact_ST functions.
chassis.
MASTERPACT_CFG_DDT <instance name>_
MPact_CFG

MASTERPACT_MEA_DDT <instance name>_

MPact_Mea

MASTERPACT_MEAExt_ <instance name>_

DDT MPact_MeEx

MASTERPACT_MEAExt1_ <instance name>_

DDT MPact_MeEx1

NOTE:
• ** Mandatory variables to be defined.
• The syntax of the Instance name must be same as the Variable name excluding the variable specific suffixes like _ST, _CFG etc.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

372 EIO0000004360.04
Circuit Breakers Supervision Services

Parameter Description
The table describes the parameters that are defined as part of the
$MasterpactMTZCMBUCE master template attributes.

Name Data Initial Description

type value

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $MasterpactMTZCMBUCE master template, alarms related to supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Masterpact Circuit Breakers

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Masterpact Circuit Breakers

The table indicates for which bits an alarm is configured in the
$MasterpactMTZCMBUCE master template and provides the associated Namur
status.

Word structure Bit Description Namur status

Masterpact_CFG.DataStatus 2 SD Electrical trip Failure

3 SDE Electrical trip Failure

4 Discharged Check function

EIO0000004360.04 373
Supervision Services Circuit Breakers

Word structure Bit Description Namur status

6 Not ready to close Check function

10 Chassis disconnected Check function

position

11 Chassis test position Check function

Masterpact_CFG.WarningCodeExt 0 Ground fault Failure

1 Earth leakage Failure

2 Chassis status Check function

discordance
3 Unknown IO Check function
configuration

Masterpact_CFG.WarningOrderCode 1 Wrong password Check function

2 IFE locking pad/EIFE Check function

intrusive command is
locked
3 IFM locking pad locked Check function

4 Resource/Module does Check function

not exist
5 Timeout during Failure
command
6 Circuit breaker tripped, Failure
reset before commands
7 Circuit breaker already Check function
closed
8 Circuit breaker already Check function
open

9 Circuit breaker already Check function

reset
10 Actuator in manual Check function
mode
11 Actuator not present Check function

12 Inhibit mode on Check function

NOTE: You can modify the configuration from the Discrete 1, Discrete 3 and
Discrete 4 application template tabs.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the
$MasterpactMTZCMBUCE master template to display data of Masterpact circuit
breakers during operation.

374 EIO0000004360.04
Circuit Breakers Supervision Services

Name Graphic symbol Description

MasterpactMTZC Symbol and icons for Masterpact MTZ circuit breakers

with chassis.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a Masterpact circuit breaker symbol opens a faceplate
with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75

Operation Tab
The figure shows an example of the operation tab.

NOTE: This tab features the control module Reset button. By default, when
you click Reset, a dialog box opens, which requires that you confirm the
command for the reset of the control module to take effect. Refer to
Parameters, page 372 in this chapter for description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the
reset confirmation. For Reset Confirmation refer, page 67.

EIO0000004360.04 375
Supervision Services Circuit Breakers

$MasterpactMTZMBUCE: Masterpact MTZ Circuit Breaker

without Chassis
Overview
This section describes the $MasterpactMTZMBUCE master template, which
contains supervision resources to monitor and operate Masterpact MTZ circuit
breakers.

Supervision Functions
Description
The $MasterpactMTZMBUCE master template provides the following monitoring
and operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxMasterpactMTZwoC master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
MBUMASTERPACTMTZ Logic for Masterpact MTZ MASTERPACT_ST_DDT <instance name>_ Core supervision
circuit breakers without MPact_ST functions.
chassis.
MASTERPACT_CFG_DDT <instance name>_
MPact_CFG

MASTERPACT_MEA_DDT <instance name>_

MPact_Me

MASTERPACT_MEAExt_ <instance name>_

DDT MPact_MeEx

MASTERPACT_MEAExt1_ <instance name>_

DDT MPact_MeEx1

NOTE:
• ** Mandatory variables to be defined.
• The syntax of the Instance name must be same as the Variable name excluding the variable specific suffixes like _ST, _CFG etc.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

376 EIO0000004360.04
Circuit Breakers Supervision Services

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$MasterpactMTZMBUCE master template attributes.

Name Data Initial Description

type value

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $MasterpactMTZMBUCE master template, alarms related to supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Masterpact Circuit Breakers

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

EIO0000004360.04 377
Supervision Services Circuit Breakers

Additional Namur Alarm Conditions for Masterpact Circuit Breakers

The table indicates for which bits an alarm is configured in the
$MasterpactMTZMBUCE master template and provides the associated Namur
status.

Word structure Bit Description Namur status

Masterpact_CFG.DataStatus 2 SD Electrical trip Failure

3 SDE Electrical trip Failure

4 Discharged Check function

6 Not ready to close Check function

Masterpact_CFG.WarningCodeExt 0 Ground fault Failure

1 Earth leakage Failure

Masterpact_CFG.WarningOrderCode 1 Wrong password Check function

2 IFE locking pad/EIFE Check function

intrusive command is
locked
3 IFM locking pad locked Check function

4 Resource/Module does Check function

not exist
5 Timeout during Failure
command
6 Circuit breaker tripped, Failure
reset before commands
7 Circuit breaker already Check function
closed
8 Circuit breaker already Check function
open

9 Circuit breaker already Check function

reset
10 Actuator in manual Check function
mode
11 Actuator not present Check function

12 Inhibit mode on Check function

NOTE: You can modify the configuration from the Discrete 1, Discrete 3 and
Discrete 4 application template tabs.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $MasterpactMTZMBUCE
master template to display data of Masterpact circuit breakers during operation.

378 EIO0000004360.04
Circuit Breakers Supervision Services

Name Graphic symbol Description

MasterpactMTZwoC Symbol and icons for Masterpact MTZ circuit breakers

without chassis.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a Masterpact circuit breaker symbol opens a faceplate
with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75

Operation Tab

NOTE: This tab features the control module Reset button. By default, when
you click Reset, a dialog box opens, which requires that you confirm the
command for the reset of the control module to take effect. Refer to
Parameters, page 372 in this chapter for description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the
reset confirmation. For Reset Confirmation refer, page 67.

EIO0000004360.04 379
Supervision Services Circuit Breakers

$MasterpactNxMBUCE: Masterpact Nx Circuit Breaker

without Chassis (x= T/W)
Overview
This section describes the $MasterpactNxMBUCE master template, which
contains supervision resources to monitor and operate Nx circuit breakers.

Supervision Functions
Description
The $MasterpactNxMBUCE master template provides the following monitoring
and operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxMasterpactNx master template is
configured to exchange data with the following control resources of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
MBUMASTERPACTNx Logic for Masterpact Nx MASTERPACT_ST_DDT <instance name>_ Core supervision
circuit breakers without MPact_ST functions.
chassis.
MASTERPACT_CFG_DDT <instance name>_
MPact_CFG

MASTERPACT_MEA_DDT <instance name>_

MPact_Me

MASTERPACT_MEAExt_ <instance name>_

DDT MPact_MeEx

MASTERPACT_MEAExt1_ <instance name>_

DDT MPact_MeEx1

NOTE:
• ** Mandatory variables to be defined.
• The syntax of the Instance name must be same as the Variable name excluding the variable specific suffixes like _ST, _CFG etc.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

380 EIO0000004360.04
Circuit Breakers Supervision Services

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$MasterpactNxMBUCE master template attributes.

Name Data Initial Description

type value

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $MasterpactNxMBUCE master template, alarms related to supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Masterpact Circuit Breakers

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

EIO0000004360.04 381
Supervision Services Circuit Breakers

Additional Namur Alarm Conditions for Masterpact Circuit Breakers

The table indicates for which bits an alarm is configured in the
$MasterpactNxMBUCE master template and provides the associated Namur
status.

Word structure Bit Description Namur status

Masterpact_CFG.DataStatus 2 SD Electrical trip Failure

3 SDE Electrical trip Failure

4 Discharged Check function

6 Not ready to close Check function

Masterpact_CFG.WarningCodeExt 0 Ground fault Failure

1 Differential detected Failure
alarm (Vigi)

Masterpact_CFG.WarningOrderCode 1 Wrong password Check function

2 IFE locking pad/EIFE Check function

intrusive command is
locked
3 IFM locking pad locked Check function

4 Resource/Module does Check function

not exist
5 Timeout during Failure
command
6 Circuit breaker tripped, Failure
reset before commands
7 Circuit breaker already Check function
closed
8 Circuit breaker already Check function
open

9 Circuit breaker already Check function

reset
10 Actuator in manual Check function
mode
11 Actuator not present Check function

12 Inhibit mode on Check function

NOTE: You can modify the configuration from the Discrete 1, Discrete 3 and
Discrete 4 application template tabs.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $MasterpactNxMBUCE
master template to display data of Masterpact circuit breakers during operation.

382 EIO0000004360.04
Circuit Breakers Supervision Services

Name Graphic symbol Description

MasterpactNxwoC Symbol and icons for Masterpact Nx circuit breakers

without chassis.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a Masterpact circuit breaker symbol opens a faceplate
with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75
NOTE: This tab features the control module Reset button. By default, when
you click Reset, a dialog box opens, which requires that you confirm the
command for the reset of the control module to take effect. Refer to
Parameters, page 372 in this chapter for description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the
reset confirmation. For Reset Confirmation refer, page 67.

$MasterpactNxCMBUCE: Masterpact Nx Circuit Breakers

with Chassis (x= T/W)
Overview
This section describes the $MasterpactNxCMBUCE master template, which
contains supervision resources to monitor and operate Masterpact Nx circuit
breakers.

Supervision Functions
Description
The $MasterpactNxCMBUCE master template provides the following monitoring
and operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.

EIO0000004360.04 383
Supervision Services Circuit Breakers

• Alarm management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxMasterpactNxC master template
is configured to exchange data with the following control resources of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
MBUMASTERPACTNxC Logic for Masterpact Nx MASTERPACT_ST_DDT <instance name>_ Core supervision
circuit breakers with MPact_ST functions.
chassis.
MASTERPACT_CFG_DDT <instance name>_
MPact_CFG

MASTERPACT_MEA_DDT <instance name>_

MPact_Me

MASTERPACT_MEAExt_ <instance name>_

DDT MPact_MeEx

MASTERPACT_MEAExt1_ <instance name>_

DDT MPact_MeEx1

NOTE:
• ** Mandatory variables to be defined.
• The syntax of the Instance name must be same as the Variable name excluding the variable specific suffixes like _ST, _CFG etc.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$MasterpactNxCMBUCE master template attributes.

384 EIO0000004360.04
Circuit Breakers Supervision Services

Name Data Initial Description

type value

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $MasterpactNxCMBUCE master template, alarms related to supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Masterpact Circuit Breakers

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Masterpact Circuit Breakers

The table indicates for which bits an alarm is configured in the
$MasterpactNxCMBUCE master template and provides the associated Namur
status.

Word structure Bit Description Namur status

Masterpact_CFG.DataStatus 2 SD Electrical trip Failure

3 SDE Electrical trip Failure

4 Discharged Check function

6 Not ready to close Check function

10 Chassis disconnected Check function

position

11 Chassis test position Check function

EIO0000004360.04 385
Supervision Services Circuit Breakers

Word structure Bit Description Namur status

Masterpact_CFG.WarningCodeExt 0 Ground fault Failure

1 Earth leakage Failure

2 Chassis status Check Function

discordance
3 Unknown IO Check Function
configuration

Masterpact_CFG.WarningOrderCode 1 Wrong password Check Function

2 IFE locking pad Check Function

3 IFM locking pad Check Function

locked
4 Resource/Module Check Function
does not exist
5 Timeout during Failure
command
6 Circuit breaker Failure
tripped, reset
before commands
7 Circuit breaker Check Function
already closed

8 Circuit breaker Check Function

already open

9 Circuit breaker Check Function

already reset

10 Actuator in manual Check Function

mode
11 Actuator not Check Function
present

12 Inhibit mode on Check Function

NOTE: You can modify the configuration from the Discrete 1, Discrete 3 and
Discrete 4 application template tabs.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $MasterpactNxCMBUCE
master template to display data of Masterpact circuit breakers during operation.

Name Graphic symbol Description

MasterpactNxC Symbol and icons for Masterpact Nx circuit breakers

with chassis.

386 EIO0000004360.04
Circuit Breakers Supervision Services

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a Masterpact circuit breaker symbol opens a faceplate
with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75
NOTE: This tab features the control module Reset button. By default, when
you click Reset, a dialog box opens, which requires that you confirm the
command for the reset of the control module to take effect. Refer to
Parameters, page 372 in this chapter for description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the
reset confirmation. For Reset Confirmation refer, page 67.

$MasterpactHWCE: Hardwired Circuit Breaker

Overview
This section describes the $MasterpactHWCE master template, which contains
supervision resources to monitor and operate Hardwired circuit breaker.

Supervision Functions
Description
The $MasterpactHWCE master template provides the following monitoring and
operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

EIO0000004360.04 387
Supervision Services Circuit Breakers

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxHWCircuitBreaker master
template is configured to exchange data with the following control resources of the
Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
HWCIRCUITBREAKER Logic for Hardwired circuit HWCB_ST_DDT <instance name>_ Core supervision
breaker. MPact_HWCB_ST functions.

HWCB_CFG_DDT <instance name>_

MPact_HWCB_CFG

** Mandatory variables to be defined.

For description of the above control resource, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$MasterpactHWCE master template attributes.

Name Data Initial Description

type value

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

388 EIO0000004360.04
Circuit Breakers Supervision Services

Default State Alarms and Additional Alarm Conditions

Overview
In the $MasterpactHWCE master template, alarms related to supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Masterpact Circuit Breakers

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Masterpact Circuit Breakers

The table indicates for which bits an alarm is configured in the $MasterpactHWCE
master template and provides the associated Namur status.

Word structure Bit Description Namur status

HWCB_CFG.DataStatus 2 SD Electrical trip Failure

3 SDE Electrical trip Failure

7 Chassis disconnected Check function

position

8 Chassis test position Check function

NOTE: You can modify the configuration from the Discrete 1 application
template tab.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $MasterpactHWCE
master template to display data of Hardwired circuit breakers during operation.

Name Graphic symbol Description

Circuitbreaker Symbol and icons for Hardwired circuit breaker.

EIO0000004360.04 389
Supervision Services Circuit Breakers

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a Masterpact circuit breaker symbol opens a faceplate
with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75

Operation Tab

NOTE: This tab features the control module Reset button. By default, when
you click Reset, a dialog box opens, which requires that you confirm the
command for the reset of the control module to take effect. Refer to
Parameters, page 388 in this chapter for description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the
reset confirmation. For Reset Confirmation refer, page 67.

$CompactHWCE: Hardwired Compact Circuit Breaker

Overview
This section describes the $CompactHWCE master template, which contains
supervision resources to monitor and operate Hardwired Compact Circuit Breaker.

390 EIO0000004360.04
Circuit Breakers Supervision Services

Supervision Functions
Description
The $CompactHWCE master template provides the following monitoring and
operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxHWCompact master template is
configured to exchange data with the following control resources of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
HWCIRCUITBREAKER Logic for Hardwired HWCB_ST_DDT <instance name>_ Core supervision
Circuit Breaker. CPact_HWCB_ST functions.

HWCB_CFG_DDT <instance name>_

CPact_HWCB_CFG

** Mandatory variables to be defined.

For description of the above control resource, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$CompactHWCE master template attributes.

EIO0000004360.04 391
Supervision Services Circuit Breakers

Name Data Initial Description

type value

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $CompactHWCE master template, alarms related to supervision functions
are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Compact Circuit Breakers

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Compact Circuit Breakers

The table indicates for which bits an alarm is configured in the $CompactHWCE
master template and provides the associated Namur status.

Word structure Bit Description Namur status

HWCB_CFG.DataStatus 2 SD Electrical trip Failure

3 SDE Electrical trip Failure

NOTE: You can modify the configuration from the Discrete 1 application
template tab.

392 EIO0000004360.04
Circuit Breakers Supervision Services

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $CompactHWCE master
template to display data of Hardwired circuit breakers during operation.

Name Graphic symbol Description

hwcompact Symbol and icons for Hardwired Compact Circuit

Breaker.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a Compact circuit breaker symbol opens a faceplate
with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75

EIO0000004360.04 393
Supervision Services Circuit Breakers

Operation Tab

NOTE: This tab features the control module Reset button. By default, when
you click Reset, a dialog box opens, which requires that you confirm the
command for the reset of the control module to take effect. Refer to
Parameters, page 388 in this chapter for description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the
reset confirmation. For Reset Confirmation refer, page 67.

394 EIO0000004360.04
Digital Protection Relays Supervision Services

Digital Protection Relays

What’s in This Chapter
$Sepam80ECE and $Sepam80MBCE: Sepam80 Digital Protection
Relays ........................................................................................................ 395
$EasergyP3EMCE: Digital Protection Relays ................................................ 399
$EasergyP5EMCE: Digital Protection Relays ................................................ 403

Overview
This chapter describes the master templates that provide the supervision
functions for the digital protection relay family.

$Sepam80ECE and $Sepam80MBCE: Sepam80 Digital

Protection Relays
Overview
This section describes the supervision resources and runtime services that are
available for the management of the $Sepam80ECE and $Sepam80MBCE
protection relay.

Supervision Functions
Description
The supervision resources provide device status monitoring, communication
status, owner selection, resetting, current commands, and device data.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxSepam80C master template is
configured to exchange data with the following control resources of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
ESEPAM80C Sepam 80C on Ethernet SEPAM_ST_DDT <instance name>_ Core supervision
(Modbus TCP I/O Sepam80_ST functions.
scanning)
SEPAM_CFG_DDT <instance name>_
Sepam80_CFG

SEPAM_IO80_DDT <instance name>_

Sepam80_IO80

SEPAM_MEA_DDT <instance name>_

Sepam80_MEA

MBSEPAM80C Sepam 80C on Modbus SEPAM_ST_DDT <instance name>_ Core supervision

SL Sepam80_ST functions.

EIO0000004360.04 395
Supervision Services Digital Protection Relays

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
SEPAM_CFG_DDT <instance name>_
Sepam80_CFG

SEPAM_IO80_DDT <instance name>_

Sepam80_IO80

SEPAM_MEA_DDT <instance name>_

Sepam80_MEA

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the $Sepam80ECE
master template attributes.

Parameter Data Initial Description

type value

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

396 EIO0000004360.04
Digital Protection Relays Supervision Services

Default State Alarms and Additional Alarm Conditions

Overview
In the $Sepam80ECE master template, alarms related to core supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Sepam 80

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Sepam 80

The table indicates for which bits an alarm is configured in the $Sepam80ECE
master template and provides the associated Namur status.

Word structure Bit Description Namur status

SEPAM_CFG.DataStatus 0 Detected fault Failure

3 Trip Failure

9 Loss of synchronization Failure

10 Loss of event 1 data Failure

12 Detected partial fault Failure

13 Detected major fault Failure

14 Loss of event 2 data Failure

NOTE: You can modify the configuration from the Discrete 1 page.

Graphic Representation
Representation
The table describes the symbols that are included in the $Sepam80ECE master
template to display data of Sepam 80 digital protection relays during operation

Name Graphic symbol Description

Sepam80C Sepam 80C symbol

EIO0000004360.04 397
Supervision Services Digital Protection Relays

Faceplates
Overview
During operation, clicking a Sepam 80 graphic symbol opens a faceplate with the
following tabs:
• Operation
• Analog Data, page 72
• Discrete Data, page 73
• Alarms, page 75

Operation Tab
The figure shows an example of the operation tab.

398 EIO0000004360.04
Digital Protection Relays Supervision Services

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

$EasergyP3EMCE: Digital Protection Relays

Overview
This section describes the Supervision resources and runtime services that are
available for the management of $EasergyP3EMCE

Supervision Functions
Description
The supervision resources provide device status monitoring, communication
status, owner selection, resetting, current commands, and device data.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $EasergyP3 master template is
configured to exchange data with the following control resources of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
EMEasergyP3 Easergy P3 on Ethernet EasergyP3_ST_DDT <instance name>_ Core supervision
EP3_ST functions.

EIO0000004360.04 399
Supervision Services Digital Protection Relays

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
EasergyP3_Inputs_ <instance name>_
DDT EP3_IPMap

EasergyP3_Outputs_ <instance name>_

DDT EP3_OPMap

EasergyP3_ARC_DDT <instance name>_

EP3_Arc

EasergyP3_MEA_DDT <instance name>_

EP3_MEA

EasergyP3_Demand_ <instance name>_

DDT EP3_Dem

EasergyP3_ <instance name>_

DeviceStatus_DDT EP3_Status

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$EasergyP3EMCE master template attributes.

Parameter Data Initial Description

type value

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

400 EIO0000004360.04
Digital Protection Relays Supervision Services

Default State Alarms and Additional Alarm Conditions

Overview
In the $EasergyP3MCE master template, alarms related to core supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses. When the bit is set, an alarm with the default
priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for EasergyP3

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices.

Additional Namur Alarm Conditions for EasergyP3

The table indicates for which bits an alarm is configured in the $EasergyP3MCE
master template and provides the associated Namur status.

Word structure Bit Description Namur status

EasergyP3_CFG.DataStatus 0 Detected fault Failure

3 Trip Failure

9 Loss of synchronization Failure

10 Loss of event 1 data Failure

12 Detected partial fault Failure

13 Detected major fault Failure

14 Loss of event 2 data Failure

NOTE: You can modify the configuration from the Discrete 1 page.

Graphic Representation
Representation
The table describes the symbols that are included in the $EasergyP3MCE master
template to display data of EasergyP3 digital protection relays during operation

Name Graphic symbol Description

EasergyP3EMCE EasergyP3 symbol.

EIO0000004360.04 401
Supervision Services Digital Protection Relays

Faceplates
Overview
During operation, clicking a EasergyP3 graphic symbol opens a faceplate with the
following tabs:
• Operation
• Analog Data
• Discrete Data
• Alarms

Operation Tab
The figure shows an example of the operation tab.

Extended Operator Tab

The figure shows an example of the extended operator tab.

402 EIO0000004360.04
Digital Protection Relays Supervision Services

$EasergyP5EMCE: Digital Protection Relays

Overview
This section describes the Supervision resources and runtime services that are
available for the management of $EasergyP5EMCE

Supervision Functions
Description
The supervision resources provide device status monitoring, communication
status, owner selection, resetting, current commands, and device data.
These functions are implemented in runtime through symbols and their associated
faceplate.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $EasergyP5 master template is
configured to exchange data with the following control resources of the Modicon
Libraries - General Purpose for Control Expert.

Control Resource Description DDT name** Syntax of variable Used for

name for DDT**
EMEasergyP5 Easergy P5 on Ethernet EasergyP5_ST_DDT <instance name>_ Core supervision
EP5_ST functions.

EasergyP5_Inputs_ <instance name>_

DDT EP5_IPMap

EIO0000004360.04 403
Supervision Services Digital Protection Relays

Control Resource Description DDT name** Syntax of variable Used for

name for DDT**
EasergyP5_Outputs_ <instance name>_
DDT EP5_OPMap

EasergyP5_ARC_DDT <instance name>_

EP5_Arc

EasergyP5_MEA_DDT <instance name>_

EP5_MEA

EasergyP5_Demand_ <instance name>_

DDT EP5_Dem

EasergyP5_ <instance name>_

DeviceStatus_DDT EP5_Status

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$EasergyP5EMCE master template attributes.

Parameter Data Initial Description

type value

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

404 EIO0000004360.04
Digital Protection Relays Supervision Services

Default State Alarms and Additional Alarm Conditions

Overview
In the $EasergyP5EMCE master template, alarms related to core supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses. When the bit is set, an alarm with the default
priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for EasergyP5

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices.

Additional Namur Alarm Conditions for EasergyP5

The table indicates for which bits an alarm is configured in the $EasergyP5EMCE
master template and provides the associated Namur status.

Word structure Bit Description Namur status

EasergyP5_CFG.DataStatus 0 Detected fault Failure

3 Trip Failure

9 Loss of synchronization Failure

10 Loss of event 1 data Failure

12 Detected partial fault Failure

13 Detected major fault Failure

14 Loss of event 2 data Failure

NOTE: You can modify the configuration from the Discrete 1 page.

Graphic Representation
Representation
The table describes the symbols that are included in the $EasergyP5EMCE
master template to display data of EasergyP5 digital protection relays during
operation

Name Graphic symbol Description

EasergyP5 EasergyP5 symbol.

EIO0000004360.04 405
Supervision Services Digital Protection Relays

Faceplates
Overview
During operation, clicking a EasergyP5 graphic symbol opens a faceplate with the
following tabs:
• Operation
• Analog Data
• Discrete Data
• Alarms

Operation Tab
The figure shows an example of the operation tab.

Extended Operator Tab

The figure shows an example of the extended operator tab.

406 EIO0000004360.04
Digital Protection Relays Supervision Services

EIO0000004360.04 407
Supervision Services Motor Controllers and Starters

Motor Controllers and Starters

What’s in This Chapter
$TesysT: TeSys T Motor Controllers and Starters........................................... 408
$TesysU: TeSys U Motor Controllers and Starters .......................................... 413

Overview
This chapter describes the master templates that provide the supervision
functions for the motor controller and starter family.

$TesysT: TeSys T Motor Controllers and Starters

Overview
This section describes the master templates that contain supervision resources to
monitor and operate TeSys T motor controllers and starters.
The table indicates the relationship between master templates and TeSys T
devices.

Master template TeSys T device

$TesysTAllDataCE Communicating by using either:

• Ethernet Modbus TCP implicit messaging
(normal I/O scanning)
• Ethernet Modbus TCP explicit messaging
• Modbus serial

$TesysTEFastCE Communicating by using either:

• Ethernet Modbus TCP implicit messaging
(fast I/O scanning)
• CANopen (device connected to an STB
island)

$TesysTPBCE Communicating by using Profibus network.

Supervision Functions
Description
The $TesysTAllDataCE, $TesysTEFastCE and $TesysTPBCE master templates
provide the following monitoring and operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

408 EIO0000004360.04
Motor Controllers and Starters Supervision Services

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the master templates are configured to
exchange data with the following control resources of the Modicon Libraries -
General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
MBTESYST Logic for TeSys T motor TESYST_ST_DDT <instance name>_ Core supervision
management system on TesysT_ST functions.
Modbus serial.
TESYST_CFG_DDT <instance name>_
TesysT_CFG

TESYST_MEA_DDT <instance name>_

TesysT_MEA

TESYST_MEAEV40_DDT <instance name>_

TesysT_MEA40

TESYST_MEAEXT_DDT <instance name>_

TesysT_MEAEXT

EIOSTESYST Logic for TeSys T motor TESYST_ST_DDT <instance name>_ Core supervision
management system on TesysT_ST functions.
Ethernet Modbus TCP
implicit messaging TESYST_CFG_DDT <instance name>_
(normal I/O scanning). TesysT_CFG

TESYST_MEA_DDT <instance name>_

TesysT_MEA

TESYST_MEAEV40_DDT <instance name>_

TesysT_MEA40

TESYST_MEAEXT_DDT <instance name>_

TesysT_MEAEXT

ETESYST Logic for TeSys T motor TESYST_ST_DDT <instance name>_ Core supervision
management system on TesysT_ST functions.
Ethernet Modbus TCP
implicit messaging (fast I/ TESYST_CFG_DDT <instance name>_
O scanning) TesysT_CFG

PBTESYST Logic for TeSys T motor TESYST_ST_DDT <instance name>_ Core supervision
management system on TesysT_ST functions.
Profibus network.
TESYST_CFG_DDT <instance name>_
TesysT_CFG

NOTE:
• ** Mandatory variables to be defined.
• The syntax of the Instance name must be same as the Variable name excluding the variable specific suffixes like _ST, _CFG etc.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

EIO0000004360.04 409
Supervision Services Motor Controllers and Starters

Parameter Description
The tables describe the parameters that are defined as part of the
$TesysTAllDataCE, $TesysTEFastCE and $TesysTPBCE master template
attributes.

Parameter Data Initial Description

type value

Param. Float 100.0 Defines the high limit of the present value to scale
HiAvgCurrent the Y axis for trending.

Param. Float 0.0 Defines the low limit of the present value to scale
LoAvgCurrent the Y axis for trending.

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

AO. BOOL False Visible reset fault authentication on

ResetFaultVisi- $TesysTPBCE.
bility
True Visible reset fault authentication on
$TesysTAllDataCE and $TesysTEFastCE.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $TesysTAllDataCE, $TesysTEFastCE and $TesysTPBCE master templates,
alarms related to core supervision functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for TeSys T Motor Controllers and Starters

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

410 EIO0000004360.04
Motor Controllers and Starters Supervision Services

Additional Namur Alarm Conditions for TeSys T Motor Controllers and

Starters
The table indicates for which bits an alarm is configured in the $TesysTAllDataCE,
$TesysTEFastCE and $TesysTPBCE master templates and provides the
associated Namur status.

Word structure Bit Description Namur status

TESYST_CFG.DataStatus 2 Device fault state Failure

3 Detected alarm Failure
4 Trip Failure

11 Detected fault Function Check

14 HMI communication lost Failure

NOTE: You can modify the configuration from the Discrete 1 page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
The table describes the symbols that are included in the $TesysTAllDataCE,
$TesysTEFastCE and $TesysTPBCE master templates to display data of TeSys T
motor controllers and starters during operation.

Name Graphic symbol Description

TesysT TeSys T device symbol and icons.

TesysT_Amp In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• The average current value in
engineering units.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a TeSys T motor controller and starter symbol opens a
faceplate with the following tabs:

EIO0000004360.04 411
Supervision Services Motor Controllers and Starters

• Operation
• Analog Data, page 72
• Discrete Data, page 73
• Alarms, page 75

Operation Tab
The figure shows an example of the operation tab.

NOTE: FaultResetAuth is not available for $TesysTPBCE.

NOTE: This tab features the control module Reset button.
When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

412 EIO0000004360.04
Motor Controllers and Starters Supervision Services

$TesysU: TeSys U Motor Controllers and Starters

Overview
This section describes the following master templates that contain supervision
resources to monitor and operate TeSys U motor controllers and starters, which
use various protocols for communication..

Template Communication protocol used by the device

$TesysUIOCE Either of:

• Modbus serial.
• CANopen.

$TesysUMainDataCE Either of:

• Modbus serial.
• CANopen.

$TesysUMECCE Modbus serial.

Supervision Functions
Description
The $TesysUIOCE, $TesysUMainDataCE, and $TesysUMECCE master
templates provide the following monitoring and operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions such as communication interruption.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the master templates are configured to
exchange data with the following control resources of the Modicon Libraries -
General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
TESYSUCTL Logic for TeSys U starter TESYSU_ST_DDT <instance name>_ Core supervision
with advanced control unit TesysU_ST functions.
and Advantys STB
communication module. TESYSU_CFG_DDT <instance name>_
TesysU_CFG

TESYSUC Logic for TeSys U TESYSU_ST_DDT <instance name>_ Core supervision

controller with advanced TesysU_ST functions.
or multifunction control
unit and Advantys STB TESYSU_CFG_DDT <instance name>_
communication module. TesysU_CFG

EIO0000004360.04 413
Supervision Services Motor Controllers and Starters

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
TESYSU_IO_DDT <instance name>_
TesysU_IO

MBTESYSUC Logic for TeSys U TESYSU_ST_DDT <instance name>_ Core supervision

controller with advanced TesysU_ST functions.
or multifunction control
unit and Modbus TESYSU_CFG_DDT <instance name>_
communication module. TesysU_CFG

TESYSU_IO_DDT <instance name>_

TesysU_IO

TESYSUSC Logic for TeSys U starter TESYSU_ST_DDT <instance name>_ Core supervision
with multifunction control TesysU_ST functions.
unit and Advantys STB
communication module. TESYSU_CFG_DDT <instance name>_
TesysU_CFG

TESYSU_MEC_DDT <instance name>_

TesysU_MEC

MBTESYSUSC Logic for TeSys U starter TESYSU_ST_DDT <instance name>_ Core supervision
with advanced or TesysU_ST functions.
multifunction control unit
and Modbus TESYSU_CFG_DDT <instance name>_
communication module. TesysU_CFG

TESYSU_MEC_DDT <instance name>_

TesysU_MEC

TESYSUSCST Logic for TeSys U starter TESYSU_ST_DDT <instance name>_ Core supervision
with standard control unit TesysU_ST functions.
and Advantys STB
communication module. TESYSU_CFG_DDT <instance name>_
TesysU_CFG

MBTESYSUSCST Logic for TeSys U starter TESYSU_ST_DDT <instance name>_ Core supervision
with standard control unit TesysU_ST functions.
and Modbus
communication module. TESYSU_CFG_DDT <instance name>_
TesysU_CFG

NOTE:
• ** Mandatory variables to be defined.
• The syntax of the Instance name must be same as the Variable name excluding the variable specific suffixes like _ST, _CFG etc.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $TesysUIOCE,
$TesysUMainDataCE, and $TesysUMECCE master template attributes.

414 EIO0000004360.04
Motor Controllers and Starters Supervision Services

Parameter Data Initial Description

type value

Param. Float 100.0 Defines the high limit of the present value to scale
HiAvgCurrent the Y axis for trending.

Param. Float 0.0 Defines the low limit of the present value to scale
LoAvgCurrent the Y axis for trending.

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $TesysUIOCE, $TesysUMainDataCE, and $TesysUMECCE master
templates, alarms related to core supervision functions are managed in the
following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for TeSys U Motor Controllers and Starters

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for TeSys U Motor Controllers and

Starters
The table indicates for which bits an alarm is configured in the $TesysUIOCE,
$TesysUMainDataCE, and $TesysUMECCE master templates and provides the
associated Namur status.

Word structure Bit Description Namur status

TESYSU_CFG.DataStatus 2 Device in fault state Failure

3 Detected alarm Failure

EIO0000004360.04 415
Supervision Services Motor Controllers and Starters

Word structure Bit Description Namur status

4 Trip Failure

NOTE: You can modify the configuration from the Discrete 1 page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Representation
The table describes the symbols that are included in the $TesysUIOCE,
$TesysUMainDataCE, and $TesysUMECCE master templates to display data of
TeSys U motor controllers and starters during operation.

Name Graphic symbol Description

TesysU TeSys U device symbol and icons.

TesysU_Amp In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• The average current value in
engineering units.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a TeSys U motor controller and starter symbol opens a
faceplate with the following tabs:
• Operation
• Analog Data, page 72
• Discrete Data, page 73
• Alarms, page 75

416 EIO0000004360.04
Motor Controllers and Starters Supervision Services

Operation Tab
The figure shows an example of the operation tab.

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

EIO0000004360.04 417
Supervision Services Power Measurement

Power Measurement
What’s in This Chapter
$PM5350MBCE and $PM53xxEMCE : PM5350 and PM53xx Power
Meters ........................................................................................................ 418
$PM82xxEMCE: PM82xx Power Meter ......................................................... 422

Overview
This chapter describes the master templates that provide the supervision
functions for the power meter family.

$PM5350MBCE and $PM53xxEMCE : PM5350 and PM53xx

Power Meters
Overview
This section describes the $PM5350MBCE and $PM53xxEMCE master
templates, which contains supervision resources to monitor and operate PM5350
power meter by using Modbus serial communication and PM53xx power meter by
using Ethernet explicit communication.

Supervision Functions
Description
The $PM5350MBCE and $PM53xxEMCE master templates provide the following
monitoring and operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions such as communication interruption.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxPM5350 and $PSxPM53xx master
templates are configured to exchange data with the following control resources of
the Modicon Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
EMPM53xx PM53xx power meter PM_ST_DDT <instance name>_PM_ Core supervision
logic for Ethernet explicit ST functions.
communication.

418 EIO0000004360.04
Power Measurement Supervision Services

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
PM_CFG_DDT <instance name>_PM_
CFG
PM53xx_MEA_DDT <instance name>_PM_
MEA
MBPM5350 PM5350 power meter PM_ST_DDT <instance name>_PM_ Core supervision
logic for Modbus serial ST functions.
communication.
PM_CFG_DDT <instance name>_PM_
CFG
PM_MEA_DDT <instance name>_PM_
MEA
** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the
$PM5350MBCE and $PM53xxEMCE master templates attributes.

Name Data Initial value Description

type

Param.HiEnergy Float 10000000.0 Defines the high limit of the present value to
scale the Y axis for trending.

Param.LoEnergy Float 0.0 Defines the low limit of the present value to
scale the Y axis for trending.

Param.HiPower Float 100.0 Defines the high limit of the present value to
scale the Y axis for trending.

Param.LoPower Float 0.0 Defines the low limit of the present value to
scale the Y axis for trending.

Param.ModeNormal String P Specifies the normal owner modes

(separated by a comma):
• O: Operator
• P: Program
For example P,O.

Default State Alarms and Additional Alarm Conditions

Overview
In the $PM5350MBCE and $PM53xxEMCE master templates, alarms related to
core supervision functions are managed through attributes, which have

EIO0000004360.04 419
Supervision Services Power Measurement

associated state alarms. When the condition that is defined in the script, page 101
is satisfied, the alarm becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for PM5350 and PM53xx Power Meters

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for PM5350 and PM53xx Power Meters
In the $PM5350MBCE and $PM53xxEMCE master templates, there are no bits for
which additional alarm conditions are configured.
NOTE: You can modify the configuration from the Main page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $PM5350MBCE master
template to display data of PM5350 power meters during operation.

Name Graphic symbol Description

PM5350 PM5350 power meter symbol and icons.

PM5350_Power In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Apparent energy consumption with
engineering units.
• Total apparent power with
engineering units.
• Total power factor.

The table describes the symbols that are included in the $PM53xxEMCE master
template to display data of PM53xx power meters during operation.

420 EIO0000004360.04
Power Measurement Supervision Services

Name Graphic symbol Description

PM53xx PM53xx power meter symbol and icons.

PM53xx_Power In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Apparent energy consumption with
engineering units.
• Total apparent power with
engineering units.
• Total power factor.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a PM5350/PM53xx power meter symbol opens a
faceplate with the following tabs:
• Operation
• Analog data, page 72
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

Operation Tab
The figure shows the operation tab of MBPM5350.

EIO0000004360.04 421
Supervision Services Power Measurement

The figure shows the operation tab of EMPM53xx.

NOTE: This tab features the control module Reset button.

$PM82xxEMCE: PM82xx Power Meter

Overview
This section describes the $PM82xxEMCE master template, which contains
supervision resources to monitor and operate PM82xx power meter by using
Ethernet explicit communication.

Supervision Functions
Description
The $PM82xxEMCE master template provide the following monitoring and
operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions such as communication interruption.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

422 EIO0000004360.04
Power Measurement Supervision Services

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxPM82xx master template are
configured to exchange data with the following control resources of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
EMPM82xx PM82xx power meter PM_ST_DDT <instance name>_PM_ Core supervision
logic for Ethernet explicit ST functions.
communication.
PM82xx_CFG_DDT <instance name>_PM_
CFG
PM82xx_MEA_DDT <instance name>_PM_
MEA
** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The table describes the parameters that are defined as part of the $PM82xxEMCE
master templates attributes.

Name Data Initial value Description

type

Param.HiEnergy Float 10000000.0 Defines the high limit of the present value to
scale the Y axis for trending.

Param.LoEnergy Float 0.0 Defines the low limit of the present value to
scale the Y axis for trending.

Param.HiPower Float 100.0 Defines the high limit of the present value to
scale the Y axis for trending.

Param.LoPower Float 0.0 Defines the low limit of the present value to
scale the Y axis for trending.

Param.ModeNormal String P Specifies the normal owner modes

(separated by a comma):
• O: Operator
• P: Program
For example P,O.

EIO0000004360.04 423
Supervision Services Power Measurement

Default State Alarms and Additional Alarm Conditions

Overview
In the $PM82xxEMCE master template, alarms related to core supervision
functions are managed through attributes, which have associated state alarms.
When the condition that is defined in the script, page 101 is satisfied, the alarm
becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for PM82xx Power Meters

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for PM82xx Power Meters

In the $PM82xxEMCE master template, there are no bits for which additional
alarm conditions are configured.
NOTE: You can modify the configuration from the Main page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $PM82xxEMCE master
template to display data of PM82xx power meters during operation.

Name Graphic symbol Description

PM82xx PM82xx power meter symbol and icons.

PM82xx_Power In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Apparent energy consumption with
engineering units.
• Total apparent power with
engineering units.
• Total power factor.

424 EIO0000004360.04
Power Measurement Supervision Services

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a PM82xx power meter symbol opens a faceplate with
the following tabs:
• Operation
• Analog data, page 72
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

Operation Tab
The figure shows the operation tab of EMPM82xx.

NOTE: This tab features the control module Reset button.

EIO0000004360.04 425
Supervision Services Soft Starters

Soft Starters
What’s in This Chapter
$ATS22MBCE: Altistart 22 Soft Starters ........................................................ 426
$ATS48MBCE: Altistart 48 Soft Starters ........................................................ 430
MBTCPATS480 - ATS480 (Modbus TCP/IP) and EIPATS480 - ATS480
(Ethernet IP): Progressive Starters ............................................................... 435

Overview
This chapter describes the master templates that provide the supervision
functions for the soft starter family.

$ATS22MBCE: Altistart 22 Soft Starters

Overview
This section describes the $ATS22MBCE master template, which contains
supervision resources to monitor and operate Altistart 22 soft starters.

Supervision Functions
Description
The $ATS22MBCE master template provides the following monitoring and
operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxATS22 master template is
configured to exchange data with the following control resource of the Modicon
Libraries - General Purpose for Control Expert.

426 EIO0000004360.04
Soft Starters Supervision Services

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
MBATS22 Altistart 22 soft starter ATS22_ST_DDT <instance name>_ Core supervision
logic. ATS_ST functions.

ATS22_CFG_DDT <instance name>_

ATS_CFG

** Mandatory variables to be defined.

For description of the control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $ATS22MBCE
master template attributes.

Name Data Initial Description

type value

Param.HiCurrent Float 100.0 Defines the high limit of the present value to scale
the Y axis for trending.

Param.LoCurrent Float 0.0 Defines the low limit of the present value to scale
the Y axis for trending.

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

EIO0000004360.04 427
Supervision Services Soft Starters

Default State Alarms and Additional Alarm Conditions

Overview
In the $ATS22MBCE master template, alarms related to core supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Altistart 22

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Altistart 22

The table indicates for which bits an alarm is configured in the $ATS22MBCE
master template and provides the associated Namur status.

Word structure Bit Description Namur status

ATS22_CFG.DataStatus 2 Trip Failure

3 Detected alarm Failure

NOTE: You can modify the configuration from the Discrete 1 page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $ATS22MBCE master
template to display data of Altistart 22 soft starters during operation.

428 EIO0000004360.04
Soft Starters Supervision Services

Name Graphic symbol Description

ATS22 Altistart 22 symbol and icons.

ATS22_Amp In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• Current on starter line 1 in
Amperes.
• Current on starter line 2 in
Amperes.
• Current on starter line 3 in
Amperes.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an Altistart 22 soft starter symbol opens a faceplate with
the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

EIO0000004360.04 429
Supervision Services Soft Starters

Operation Tab
The figure shows an example of the operation tab.

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

$ATS48MBCE: Altistart 48 Soft Starters

Overview
This section describes the $ATS48MBCE master template, which contains
supervision resources to monitor and operate Altistart 48 soft starters.

430 EIO0000004360.04
Soft Starters Supervision Services

Supervision Functions
Description
The $ATS48MBCE master template provides the following monitoring and
operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxATS48 master template is
configured to exchange data with the following control resource of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
MBATS48 Altistart 48 soft starter ATS_ST_DDT <instance name>_ Core supervision
logic. ATS_ST functions.

ATS_CFG_DDT <instance name>_

ATS_CFG

** Mandatory variables to be defined.

For description of the control resources, refer to the topics describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $ATS48MBCE
master template attributes.

EIO0000004360.04 431
Supervision Services Soft Starters

Name Data Initial Description

type value

Param.HiCurrent Float 100.0 Defines the high limit of the present value to scale
the Y axis for trending.

Param.LoCurrent Float 0.0 Defines the low limit of the present value to scale
the Y axis for trending.

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $ATS48MBCE master template, alarms related to core supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Altistart 48

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Altistart 48

The table indicates for which bits an alarm is configured in the $ATS48MBCE
master template and provides the associated Namur status.

Word structure Bit Description Namur status

ATS_CFG.DataStatus 3 Malfunction Failure

7 Detected alarm Failure

NOTE: You can modify the configuration from the Discrete 1 page.

432 EIO0000004360.04
Soft Starters Supervision Services

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $ATS48MBCE master
template to display data of Altistart 48 soft starters during operation.

Name Graphic symbol Description

ATS48 Altistart 48 symbol and icons.

ATS48_Amp In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• Current on starter line in Amperes.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an Altistart 48 soft starter symbol opens a faceplate with
the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

EIO0000004360.04 433
Supervision Services Soft Starters

Operation Tab
The figure shows an example of the operation tab.

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

434 EIO0000004360.04
Soft Starters Supervision Services

MBTCPATS480 - ATS480 (Modbus TCP/IP) and EIPATS480

- ATS480 (Ethernet IP): Progressive Starters
Overview
This section describes the $ATS480MBTCPCE and $ATS480EIPCE master
template, which contains supervision resources to monitor and operate Altistart
480 soft starters.

Supervision Functions
Description
The $ATS480MBTCPCE and $ATS480EIPCE master template provides the
following monitoring and operation functions:
• Device status and data monitoring.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $ATS480MBTCPCE and
$ATS480EIPCE master templates are configured to exchange data with the
following control resource of the Modicon Libraries - General Purpose for Control
Expert.
Refer to the table below for the control/supervision relationship of
$ATS480MBTCPCE template.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
EIOSATS480 Altistart 480 soft starter ATS480_ST_DDT <instance name>_ Core supervision
logic. ATS_ST functions.

ATS480_CFG_DDT <instance name>_

ATS_CFG

ATS480_IO_DDT <instance name>_

ATS_IO

ATS480_IOEXT_DDT <instance name>_

ATS_IOEXT

EMESATS480DATA Altistart 480 soft starter EMESATS480DATA_ST_ <instance name>_

auxiliary data logic. DDT ATSE_ST

** Mandatory variables to be defined.

Refer to the table below for the control/supervision relationship of

$ATS480EIPCEtemplate.

EIO0000004360.04 435
Supervision Services Soft Starters

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
EIOSATS480 Altistart 480 soft starter ATS480_ST_DDT <instance name>_ Core supervision
logic. ATS_ST functions.

ATS480_CFG_DDT <instance name>_

ATS_CFG

ATS480_IO_DDT <instance name>_

ATS_IO

ATS480_IOEXT_DDT <instance name>_

ATS_IOEXT

EIPATS480DATA Altistart 480 soft starter EIPATS480DATA_ST_ <instance name>_

auxiliary data logic. DDT ATSE_ST

** Mandatory variables to be defined.

For description of the control resources, refer to the topics describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the
$ATS480MBTCPCE and $ATS480EIPCE master template attributes.

Name Data Initial Description

type value

Param.HiCurrent Float 1000.0 Defines the high limit of the present value to scale
the Y axis for trending.

Param.LoCurrent Float 0.0 Defines the low limit of the present value to scale
the Y axis for trending.

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example P,O.

436 EIO0000004360.04
Soft Starters Supervision Services

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $ATS480MBTCPCE and $ATS480EIPCE master template, alarms related
to core supervision functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Altistart 480

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Altistart 480

The table indicates for which bits an alarm is configured in the
$ATS480MBTCPCE and $ATS480EIPCE master template and provides the
associated Namur status.

Word structure Bit Description Namur status

ATS_CFG.DataStatus 3 Malfunction Failure

7 Detected alarm Failure

NOTE: You can modify the configuration from the Discrete 1 page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

EIO0000004360.04 437
Supervision Services Soft Starters

Symbol Description
The table describes the symbols that are included in the $ATS480MBTCPCE and
$ATS480EIPCE master template to display data of Altistart 480 soft starters
during operation.

Name Graphic symbol Description

ATS480 Altistart 480 symbol and icons.

ATS48_Amp In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• Current on starter line in Amperes.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an Altistart 480 soft starter symbol opens a faceplate
with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

438 EIO0000004360.04
Soft Starters Supervision Services

Operation Tab
The figure shows an example of the operation tab.

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification.

The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

EIO0000004360.04 439
Supervision Services Speed Drives

Speed Drives
What’s in This Chapter
$ATV6xxECE: Altivar 6xx Series Variable Speed Drives ................................. 440
$ATV9xxECE: Altivar 9xx Series Variable Speed Drives ................................. 445
$ATV6xxxECE: Altivar 6xxx Series Variable Speed Drives.............................. 449
$ATV320EMCE: Altivar 320 Series Variable Speed Drives ............................. 453
$ATV340CE: Altivar 340 Series Variable Speed Drives .................................. 458

Overview
This chapter describes the master templates that provide the supervision
functions for the speed drive family.

$ATV6xxECE: Altivar 6xx Series Variable Speed Drives

Overview
This section describes the $ATV6xxECE master template, which contains
supervision resources to monitor and operate Altivar 6xx series variable speed
drives (6xx represents the device model number).

Supervision Functions
Description
The $ATV6xxECE master template provides the following monitoring and
operation functions:
• Device status and data monitoring.
• Setting of speed setpoint and direction of rotation.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxATV6xxAllData master template is
configured to exchange data with the following control resource of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
ATV6xx Altivar 6xx series variable ATV6xx_ST_DDT <instance name>_ Core supervision
speed drive logic. ATV_ST functions.

440 EIO0000004360.04
Speed Drives Supervision Services

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
ATV6xx_CFG_DDT <instance name>_
ATV_CFG

ATV6xx_IO_DDT <instance name>ATV_

IO
ATV6xx_IOEXT_DDT <instance name>ATV_
IOEXT
** Mandatory variables to be defined.

For a description of the control resource, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $ATV6xxECE
master template attributes.

Name Data Initial Description

type value

Param.HiPV Float 100.0 Defines the high limit of the present value to scale
the Y axis for trending.

Param.LoPV Float 0.0 Defines the low limit of the present value to scale
the Y axis for trending.

Param.ModeNormal String P Defines the normal owner modes (separated by a

comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

EIO0000004360.04 441
Supervision Services Speed Drives

Default State Alarms and Additional Alarm Conditions

Overview
In the $ATV6xxECE master template, alarms related to core supervision functions
are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Altivar 6xx Series Speed Drives

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Altivar 6xx Series Speed Drives
The table indicates for which bits an alarm is configured in the $ATV6xxECE
master template and provides the associated Namur status.

Word structure Bit Description Namur status

ATV_CFG.DataStatus 3 Malfunction Failure

7 Detected alarm Failure
10 Speed setpoint outside Out Of Specs
of limit

NOTE: You can modify the configuration from the Discrete 1 page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $ATV6xxECE master
template to display data of Altivar 6xx series variable speed drives during
operation.

442 EIO0000004360.04
Speed Drives Supervision Services

Name Graphic symbol Description

ATV6xx Altivar 600 symbol and icons.

ATV6xx_PV In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• Direction of rotation.
• Present motor speed.

ATV6xx_PVSP In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• Direction of rotation.
• Present motor speed.
• Direction of rotation setpoint.
• Motor speed setpoint.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an Altivar 6xx series variable speed drive symbol opens
a faceplate with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

EIO0000004360.04 443
Supervision Services Speed Drives

Operation Tab
The figure shows an example of the operation tab.

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

444 EIO0000004360.04
Speed Drives Supervision Services

$ATV9xxECE: Altivar 9xx Series Variable Speed Drives

Overview
This section describes the $ATV9xxECE master template, which contains
supervision resources to monitor and operate Altivar 9xx series variable speed
drives (9xx represents the device model number).

Supervision Functions
Description
The $ATV9xxECE master template provides the following monitoring and
operation functions:
• Device status and data monitoring.
• Setting of speed setpoint and direction of rotation.
• Setting of torque setpoint.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxATV9xxAllData master template is
configured to exchange data with the following control resource of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
ATV9xx Altivar 9xx series variable ATV9xx_ST_DDT <instance name>_ Core supervision
speed drive logic. ATV_ST functions.

ATV9xx_CFG_DDT <instance name>_

ATV_CFG

ATV9xx_IO_DDT <instance name>ATV_

IO
ATV9xx_IOEXT_DDT <instance name>ATV_
IOEXT
** Mandatory variables to be defined.

For description of the control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

EIO0000004360.04 445
Supervision Services Speed Drives

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $ATV9xxECE
master template attributes.

Name Data Initial Description

type value

Param.HiPV Float 100.0 Defines the high limit of the speed present value to
scale the Y axis for trending.

Param.LoPV Float 0.0 Defines the low limit of the speed present value to
scale the Y axis for trending.

Param.TorqueHiPV Float 100.0 Defines the high limit of the torque present value
to scale the Y axis for trending.

Param.TorqueLoPV Float 0.0 Defines the low limit of the torque present value to
scale the Y axis for trending.

Param.ModeNormal String P Defines the normal owner modes (separated by a

comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $ATV9xxECE master template, alarms related to core supervision functions
are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.

446 EIO0000004360.04
Speed Drives Supervision Services

You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Altivar 9xx Series Speed Drives

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Altivar 9xx Series Speed Drives
The table indicates for which bits an alarm is configured in the $ATV9xxECE
master template and provides the associated Namur status.

Word structure Bit Description Namur status

ATV_CFG.DataStatus 3 Malfunction Failure

7 Detected alarm Failure
10 Speed setpoint outside Out Of Specs
of limit

NOTE: You can modify the configuration from the Discrete 1 page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $ATV9xxECE master
template to display data of Altivar 9xx series variable speed drives during
operation.

Name Graphic symbol Description

ATV9xx Altivar 900 symbol and icons.

ATV9xx_PV In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• Direction of rotation.
• Present motor speed.

ATV9xx_PVSP In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• Direction of rotation.
• Present motor speed.
• Direction of rotation setpoint.
• Motor speed setpoint.

EIO0000004360.04 447
Supervision Services Speed Drives

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an Altivar 9xx series variable speed drive symbol opens
a faceplate with the following tabs:
• Operation, page 448
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

Operation Tab
The figure shows an example of the operation tab.

448 EIO0000004360.04
Speed Drives Supervision Services

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

$ATV6xxxECE: Altivar 6xxx Series Variable Speed Drives

Overview
This section describes the $ATV6xxxECE master template, which contains
supervision resources to monitor and operate Altivar 9xxx series variable speed
drives (9xxx represents the device model number).

Supervision Functions
Description
The $ATV6xxxECE master template provides the following monitoring and
operation functions:
• Device status and data monitoring.
• Setting of speed setpoint and direction of rotation.
• Setting of torque setpoint.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

EIO0000004360.04 449
Supervision Services Speed Drives

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxATV6xxxAllData master template
is configured to exchange data with the following control resource of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
ATV6xxx Altivar 6xxx series ATV6xxx_ST_DDT <instance name>_ Core supervision
variable speed drive logic. ATV_ST functions.

ATV6xxx_CFG_DDT <instance name>_

ATV_CFG

ATV6xxx_IO_DDT <instance name>ATV_

IO
ATV6xxx_IOEXT_DDT <instance name>ATV_
IOEXT
** Mandatory variables to be defined.

For description of the control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $ATV6xxxECE
master template attributes.

Name Data Initial Description

type value

Param.HiPV Float 100.0 Defines the high limit of the speed present value to
scale the Y axis for trending.

Param.LoPV Float 0.0 Defines the low limit of the speed present value to
scale the Y axis for trending.

Param.TorqueHiPV Float 100.0 Defines the high limit of the torque present value
to scale the Y axis for trending.

Param.TorqueLoPV Float 0.0 Defines the low limit of the torque present value to
scale the Y axis for trending.

Param.ModeNormal String P Defines the normal owner modes (separated by a

comma):
• O: Operator
• P: Program
For example, P,O.

450 EIO0000004360.04
Speed Drives Supervision Services

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $ATV6xxxECE master template, alarms related to core supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Altivar 6xxx Series Speed Drives

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Altivar 6xxx Series Speed Drives
The table indicates for which bits an alarm is configured in the $ATV6xxxECE
master template and provides the associated Namur status.

Word structure Bit Description Namur status

ATV_CFG.DataStatus 3 Malfunction Failure

7 Detected alarm Failure
10 Speed setpoint outside Out Of Specs
of limit

NOTE: You can modify the configuration from the Discrete 1 page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

EIO0000004360.04 451
Supervision Services Speed Drives

Symbol Description
The table describes the symbols that are included in the $ATV6xxxECE master
template to display data of Altivar 6xxx series variable speed drives during
operation.

Name Graphic symbol Description

ATV6xxx Altivar 900 symbol and icons.

ATV6xxx_PV In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• Direction of rotation.
• Present motor speed.

ATV6xxx_PVSP In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• Direction of rotation.
• Present motor speed.
• Direction of rotation setpoint.
• Motor speed setpoint.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an Altivar 6xxx series variable speed drive symbol
opens a faceplate with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

452 EIO0000004360.04
Speed Drives Supervision Services

Operation Tab
The figure shows an example of the operation tab.

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

$ATV320EMCE: Altivar 320 Series Variable Speed Drives

Overview
This section describes the $ATV320EMCE master template, which contains
supervision resources to monitor and operate Altivar 320 series variable speed
drives (320 represents the device model number).

EIO0000004360.04 453
Supervision Services Speed Drives

Supervision Functions
Description
The $ATV320EMCE master template provides the following monitoring and
operation functions:
• Device status and data monitoring.
• Setting of speed setpoint and direction of rotation.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxATV320AllData master template is
configured to exchange data with the following control resource of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
ATV320 Altivar 320 series variable ATV320_ST_DDT <instance name>_ Core supervision
speed drive logic. ATV_ST functions.

ATV320_CFG_DDT <instance name>_

ATV_CFG

ATVParamDDT <instance name>_

ATV_ParamRead

** Mandatory variables to be defined.

For description of the control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $ATV320EMCE
master template attributes.

454 EIO0000004360.04
Speed Drives Supervision Services

Name Data Initial Description

type value

Param.HiPV Float 100.0 Defines the high limit of the speed present value to
scale the Y axis for trending.

Param.LoPV Float 0.0 Defines the low limit of the speed present value to
scale the Y axis for trending.

Param.TorqueHiPV Float 100.0 Defines the high limit of the torque present value
to scale the Y axis for trending.

Param.TorqueLoPV Float 0.0 Defines the low limit of the torque present value to
scale the Y axis for trending.

Param.ModeNormal String P Defines the normal owner modes (separated by a

comma):
• O: Operator
• P: Program
For example, P,O.

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $ATV320EMCE master template, alarms related to core supervision
functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Altivar 320 Series Speed Drives

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Altivar 320 Series Speed Drives
The table indicates for which bits an alarm is configured in the $ATV320EMCE
master template and provides the associated Namur status.

Word structure Bit Description Namur status

ATV_CFG.DataStatus 3 Malfunction Failure

EIO0000004360.04 455
Supervision Services Speed Drives

Word structure Bit Description Namur status

7 Detected alarm Failure

10 Speed setpoint outside Out Of Specs
of limit

NOTE: You can modify the configuration from the Discrete 1 page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the $ATV320EMCE master
template to display data of Altivar 320 series variable speed drives during
operation.

Name Graphic symbol Description

ATV320 Altivar 320 symbol and icons.

ATV320_PV In addition to icons, the symbol displays

(from top to bottom):
• The label
• Engineering units.
• Direction of rotation.
• Present motor speed.

ATV320_PVSP In addition to icons, the symbol displays

(from top to bottom):
• The label
• Engineering units.
• Direction of rotation.
• Present motor speed.
• Direction of rotation setpoint.
• Motor speed setpoint.

ATV320_Item_PV In addition to icons, the symbol displays

(from top to bottom):
• The label
• Engineering units of the item
selected.
• Direction of rotation.
• Value of the item selected.

456 EIO0000004360.04
Speed Drives Supervision Services

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an Altivar 320 series variable speed drive symbol opens
a faceplate with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

Operation Tab
The figure shows an example of the operation tab.

EIO0000004360.04 457
Supervision Services Speed Drives

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

$ATV340CE: Altivar 340 Series Variable Speed Drives

Overview
This section describes the $ATV340CE master template, which contains
supervision resources to monitor and operate Altivar 340 series variable speed
drives (340 represents the device model number).

Supervision Functions
Description
The $ATV340CE master template provides the following monitoring and operation
functions:
• Device status and data monitoring.
• Setting of speed setpoint and direction of rotation.
• Setting of torque setpoint.
• Monitoring of abnormal conditions.
• Device logic resetting.
• Owner selection.
• Alarm signal management.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages, page 87.

458 EIO0000004360.04
Speed Drives Supervision Services

Control/Supervision Relationship
Control Resources
To provide core supervision functions, the $PSxATV340AllData master template is
configured to exchange data with the following control resource of the Modicon
Libraries - General Purpose for Control Expert.

Control resource Description DDT name** Syntax of variable name Used for
for DDT**
ATV340 Altivar 340 series variable ATV340_ST_DDT <instance name>_ Core supervision
speed drive logic. ATV_ST functions.

EMESATV340_CFG_DDT, <instance name>_

EIOSATV340_CFG_DDT ATV_CFG

** Mandatory variables to be defined.

For description of the control resource, refer to the topic describing the respective
control resource in the manual documenting the control services of the library.

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $ATV340CE
master template attributes.

Name Data Initial Description

type value

Param.HiPV Float 100.0 Defines the high limit of the speed present value to
scale the Y axis for trending.

Param.LoPV Float 0.0 Defines the low limit of the speed present value to
scale the Y axis for trending.

Param.TorqueHiPV Float 100.0 Defines the high limit of the torque present value
to scale the Y axis for trending.

Param.TorqueLoPV Float 0.0 Defines the low limit of the torque present value to
scale the Y axis for trending.

Param.ModeNormal String P Defines the normal owner modes (separated by a

comma):
• O: Operator
• P: Program
For example, P,O.

EIO0000004360.04 459
Supervision Services Speed Drives

Name Data Initial Description

type value

Param. Boolean True False = After you click the Reset button on the
FailureRearmCon- faceplate during operation and have successfully
firmation validated the command according to the
configured security classification, resets the
control logic with no additional confirmation being
required.

True = After you click the Reset button on the

faceplate during operation, displays a dialog box,
which requires that you confirm the reset
command. The control logic is reset only by
clicking OK and validating the command
according to the configured security classification.
By default, the security classification is secured
write.

Default State Alarms and Additional Alarm Conditions

Overview
In the $ATV340CE master template, alarms related to core supervision functions
are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Altivar 340 Series Speed Drives

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Altivar 340 Series Speed Drives
The table indicates for which bits an alarm is configured in the $ATV340CE master
template and provides the associated Namur status.

Word structure Bit Description Namur status

ATV_CFG.DataStatus 3 Malfunction Failure

7 Detected alarm Failure
10 Speed setpoint outside Out Of Specs
of limit

NOTE: You can modify the configuration from the Discrete 1 page.

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

460 EIO0000004360.04
Speed Drives Supervision Services

Symbol Description
The table describes the symbols that are included in the $ATV340CE master
template to display data of Altivar 340 series variable speed drives during
operation.

Name Graphic symbol Description

ATV340 Altivar 900 symbol and icons.

ATV340_PV In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• Direction of rotation.
• Present motor speed.

ATV340_PVSP In addition to icons, the symbol displays

(from top to bottom):
• The label.
• Engineering units.
• Direction of rotation.
• Present motor speed.
• Direction of rotation setpoint.
• Motor speed setpoint.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking an Altivar 340 series variable speed drive symbol opens
a faceplate with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75
NOTE: The master template also features the trends faceplate.

EIO0000004360.04 461
Supervision Services Speed Drives

Operation Tab
The figure shows an example of the operation tab.

NOTE: This tab features the control module Reset button.

When the control module is reset, the current setpoint that is shown in this tab
is effective.
By default, when you click Reset, a dialog box opens, which requires that you
confirm the command for the reset of the control module to take effect.
Refer to Parameters in this chapter for a description of the Param.
FailureRearmConfirmation parameter, which allows you to configure the reset
confirmation.
The figure shows the confirmation dialog box which is model in nature.

Resetting the control module by clicking OK underlies a security classification,

page 89. The default configuration is secured write.
When the reset confirmation dialog box is enabled, the security classification
that normally applies when you click Reset is not effective.

462 EIO0000004360.04
 Supervision Services

Diagnosis
What’s in This Part
Controller Diagnosis ..................................................................................... 464

Overview
This section describes the master templates that provide the supervision functions
for the diagnosis category.
Schneider Electric provides the templates described in this document. These
templates can be used in various applications to minimize engineering efforts but
the use, integration, configuration, and validation of the system is the sole
responsibility of the user. Said user must ensure the safety of the system as a
whole by performing a safety analysis, including the resources provided by
Schneider Electric through procedures that the user deems appropriate.

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.

EIO0000004360.04 463
Supervision Services Controller Diagnosis

Controller Diagnosis
What’s in This Chapter
$M340DiagCE and $M580DiagCE: Modicon Controller Diagnosis .................. 464

Overview
This section describes the master templates that provides the supervision
functions for the controller diagnosis.

$M340DiagCE and $M580DiagCE: Modicon Controller

Diagnosis
Overview
This section describes the $M340DiagCE and $M580DiagCE master templates,
which contain supervision resources to monitor and update real time clock in the
controller.

Supervision Functions
Description
Use the master templates for the following controllers:
• $M340DiagCE for Modicon M340.
• $M580DiagCE for Modicon M580.
These master templates provide the following monitoring and operation functions:
• Viewing CPU-related information.
• Viewing controller status.
• Viewing communication status information.
• Monitoring of abnormal conditions.
• Updating the real-time clock (RTC).
• Alarm signal management.
NOTE:
• AUX task information is not available for CPUs of the M340 platforms.
• Battery status information is not available for CPUs of the M340 and
M580 platforms.
During operation, these functions are implemented by instances through symbols
and their associated faceplate.
NOTE: You can modify the default configuration in the corresponding
configuration pages as applicable, page 87.

464 EIO0000004360.04
Controller Diagnosis Supervision Services

Control/Supervision Relationship
Control Resources
To provide core and optional supervision functions, the $PSxPACM340 and
$PSxPACM580 master templates are configured to exchange data with the
following control resources of the Modicon Libraries - General Purpose for Control
Expert.

Master template Control resource DDT name** Syntax of variable name Used for
for DDT**
$PSxPACM340 GENSTS GENSTS_ST_DDT <instance name>_ Core supervision
M340_GENSTS_ST functions.

COMM COMM_ST_DDT <instance name>_ Optional supervision

M340_COMM_ST functions.

OSINFO OSINFO_ST_DDT <instance name>_

M340_OSINFO_ST

RTC RTC_ST_DDT <instance name>_

M340_RTC_ST

RTC_CFG_DDT <instance name>_

M340_RTC_CFG

MASTINFO MASTINFO_ST_DDT <instance name>_

M340_MASTINFO_ST

LASTSTOP LASTSTOP_ST_DDT <instance name>_

M340_LASTSTOP_ST

FASTINFO FASTINFO_ST_DDT <instance name>_

M340_FASTINFO_ST

$PSxPACM580 GENSTS GENSTS_ST_DDT <instance name>_ Core supervision

M580_GENSTS_ST functions.

COMM COMM_ST_DDT <instance name>_ Optional supervision

M580_COMM_ST functions.

OSINFO OSINFO_ST_DDT <instance name>_

M580_OSINFO_ST

RTC RTC_ST_DDT <instance name>_

M580_RTC_ST

RTC_CFG_DDT <instance name>_

M580_RTC_CFG

MASTINFO MASTINFO_ST_DDT <instance name>_

M580_MASTINFO_ST

LASTSTOP LASTSTOP_ST_DDT <instance name>_

M580_LASTSTOP_ST

FASTINFO FASTINFO_ST_DDT <instance name>_

M580_FASTINFO_ST

AUX1INFO AUX1INFO_ST_DDT <instance name>_

M580_AUX1INFO_ST

AUX0INFO AUX0INFO_ST_DDT <instance name>_

M580_AUX0INFO_ST

** Mandatory variables to be defined.

For description of these control resources, refer to the topic describing the
respective control resource in the manual documenting the control services of the
library.

EIO0000004360.04 465
Supervision Services Controller Diagnosis

Parameters
Parameter Configuration
The initial value of the parameters described in this topic corresponds to what is
considered the normal operating mode. You can modify the values in the derived
application template or in its instances. You can access the parameters from the
Attributes page of the object editor, page 100.
These parameters allow you to configure core functions.

Parameter Description
The tables describe the parameters that are defined as part of the $M340DiagCE
and $M580DiagCE master template attributes.

Name Data Initial Description

type value

Param.ModeNormal String P Specifies the normal owner modes (separated by

a comma):
• O: Operator
• P: Program
For example P,O.

Default State Alarms and Additional Alarm Conditions

Overview
In the $M340DiagCE and $M580DiagCE master templates, alarms related to core
supervision functions are managed in the following ways:
• Certain attributes have associated state alarms. When the condition that is
defined in the script, page 101 is satisfied, the alarm becomes active.
• Certain bits of the word structure that the master template manages have
associated Namur statuses, page 40. When the bit is set, an alarm with the
default priority that is associated to the status becomes active.
You can manage the alarms from the alarms tab of the faceplate during operation.

State Alarms for Modicon Controller Diagnostic

For a description of the attributes for which a state alarm is configured by default,
refer to the topic describing default state alarms for devices, page 366.

Additional Namur Alarm Conditions for Modicon Controller Diagnostic

The table indicates for which bits an alarm is configured in the $M340DiagCE and
$M580DiagCE master templates and provides the associated Namur status.

Customized reference Bit Description Namur status

Me.Diagnostic.AO.DataStatus 0 Controller Stopped Function Check

3 Detected Error in I/O Failure

4 Watchdog Overflow Failure

NOTE: You can modify the configuration from the Discrete 1 and/or Discrete
2 pages of the parent template $PSxPACModicon.

466 EIO0000004360.04
Controller Diagnosis Supervision Services

Graphic Representation
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in symbols.

Symbol Description
The table describes the symbols that are included in the master templates to
display data of Modicon controllers during operation.

Master template Symbol name Graphic symbol Description

$M340DiagCE PACM340 M340 controller symbol and icons.

$M580DiagCE PACM580 M580 controller symbol and icons.

Faceplates
Representation of Supervision Data
At the beginning of this document, you can find a general description, page 46 of
the graphic elements and element styles that are used in faceplates.

Available Tabs
During operation, clicking a Modicon controller diagnostic symbol opens a
faceplate with the following tabs:
• Operation
• Analog data, page 72
• Discrete data, page 73
• Alarms, page 75
NOTE: Analog Data tab > Operating System and Comm Information tab
displays the information of processor patch version and firmware version. The
value displayed is in decimal, user has to manually convert this decimal value
to hexadecimal value to get the correct processor patch version and firmware
version of the controller.

EIO0000004360.04 467
Supervision Services Controller Diagnosis

Operation Tab
The figure shows an example of the operation tab for a M340 controller, which
opens when you click a PACM340 symbol.

NOTE: The tab for M340 and M580 controllers is identical except for the
controller graphic, which shows a controller-specific rack.
NOTE: In faceplate, Analog tab shows controller OS, patch and firmware
information. The value displayed on the faceplate will be in decimal value
when communicated with PLC simulator.

NOTICE
ERRONEOUS DATA LOGGING
Confirm the input date and time before setting the date and time in the
controller.
Failure to follow these instructions can result in data loss.

The table indicates which attribute corresponds to the field or menu that appears
on the tab.

Item Attribute
Controller status Statuses are indicated by using the following attributes:
• Controller status:
◦ Me.Diagnostic.AO.STW.10. When true, Booting is displayed.
◦ Me.Diagnostic.AO.STW.11. When true, Running is displayed;
when false, Stopped.
• Abnormal conditions:
◦ Me.Diagnostic.AO.STW.03. When true, Failure is displayed and
next to it the description from Me.AO.Lastfailure
NOTE: These fields use the active and passive element styles, page
47.
Current Date/Time Me.Diagnostic.AO.ActualClock

RTC data.

468 EIO0000004360.04
Controller Diagnosis Supervision Services

Item Attribute

Format: dd/mm/yyyy, hh:mm:ss

Last Controller Me.Diagnostic.AO.ActualClock and Me.Diagnostic.AO.CausePLCStop

Stop
RTC data and reason of last controller stop.

RTC data format: dd/mm/yyyy, hh:mm:ss

Update Real-Time Allows user to update Real-Time Clock on Update RTC button action from
Clock (RTC) the faceplate, Current system date and time are passed to the following
attributes individually:
• Me.Diagnostic.AO.RTC.Cfg.NEWDAY
• Me.Diagnostic.AO.RTC.Cfg.NEWMONTH
• Me.Diagnostic.AO.RTC.Cfg.NEWYEAR
• Me.Diagnostic.AO.RTC.Cfg.NEWHOUR
• Me.Diagnostic.AO.RTC.Cfg.NEWMIN
• Me.Diagnostic.AO.RTC.Cfg.NEWSEC
The display format is: dd/mm/yyyy hh:mm:ss
NOTE: For the M580 controller current UTC date and time are passed
to the above mentioned attributes, however for M340 controllers
current system date and time are passed.

EIO0000004360.04 469
 Supervision Services

Index $RatioCtrlCE default configuration .................... 244

$SchedulerCE default configuration .................. 362
$SequenceCE default configuration .................. 262
$AnalogInputCE $SPBoolCE default configuration ...................... 353
analog inputs with range management............... 112 $SPDurationCE default configuration ................ 359
$DualOPValveCE $SPIntCE default configuration ......................... 357
dual output valves ............................................ 183 $SplitRangeCE default configuration ................. 250
$IlckCE/$ICCE $SPRealCE default configuration ...................... 355
alarm summary ................................................ 341 $Step3CtlCE default configuration..................... 254
$LeadLagCE $TotalCE default configuration .......................... 140
lead lag controllers ........................................... 226 $ValveCE default configuration ......................... 191
$MValveCE alarm priorities ...................................................38
discrete motorized valves ................................. 177 default alarm conditions for $aOPCClientGP ...... 107
$PumpFlowCtrlCE default alarm conditions for
Flow Control management................................ 331 $aRedundantDIObjectGP ............................... 109
$PumpSetCtrlCE default configuration for devices ........................ 366
Pump Set management .................................... 325 description of alarm functions..............................38
2-speed motors shelving ............................................................39
$Motor2DirCE 2-speed/2-rotation-direction Alarms page
motors ........................................................... 171 configuration......................................................93
alarms tab
faceplate tabs ....................................................75
A AlarmSummaryCE
alarm summary ................................................ 337
aAppEngineGP analog data tab
description....................................................... 103 faceplate tabs ....................................................72
aAreaGP analog inputs
description....................................................... 105 $AnalogInputCE description ............................. 112
aAreaRootGP analog outputs
description....................................................... 105 $AnalogOutputCE ............................................ 118
abnormal situation management Analog page
SA management ................................................46 configuration......................................................98
access control analog signal selection
description of access control features ..................36 $AnalogSelectCE............................................. 344
object security classification................................36 AnalogInMultiCE
alarm severities multiple analog inputs....................................... 133
SA alarms .........................................................38 AnalogOutputCE
alarm summary analog outputs ................................................. 118
$AlarmSummaryCE ......................................... 337 AnalogSelectCE
$IlckCE/$ICCE ................................................ 341 analog signal selection ..................................... 344
alarms AO elements
$aAppEngineGP default configuration ............... 103 attribute elements ............................................ 100
$aAreaGP default configuration ........................ 106 aOPCClientGP
$aAreaRootGP default configuration ................. 106 configuring OPC clients ......................................84
$AlarmSummaryCE default configuration .......... 338 description....................................................... 107
$AnalogInMultiCE default configuration ............. 134 AppEngines
$AnalogInputCE default configuration................ 113 $aAppEngineGP .............................................. 103
$AnalogOutputCE default configuration ............. 119 application engines
$AnalogSelectCE default configuration.............. 345 $aAppEngineGP .............................................. 103
$ControlValveCE default configuration............... 198 areas
$DigitalInputCE default configuration................. 125 $aAreaGP ....................................................... 105
$DigitalOutputCE default configuration .............. 130 $aAreaRootGP ................................................ 105
$DualOPValveCE default configuration.............. 185 aRedundantDIObjectGP
$EMPatternCE default configuration.................. 308 description....................................................... 109
$HandValveCE default configuration ................. 161 ASM
$IMCTLCE default configuration ....................... 221 SA management ................................................46
$LeadLagCtlCE default configuration ................ 228 attributes
$MessageBoxCE default configuration .............. 349 AO attribute description .................................... 100
$Motor2DirCE default configuration ................... 173 Me suffix description......................................... 100
$MotorCE default configuration ......................... 166 attributes page
$MotorVSCE default configuration .................... 212 overview.......................................................... 100
$MValveCE default configuration....................... 179
$MValvewithPosCE default configuration ........... 206
$PhaseCE default configuration ........................ 281 B
$PIDCE default configuration ............................ 233
$PumpFlowCtrlCE default configuration............. 333 base templates
$PumpSetCtrlCE default configuration............... 327 list of master templates.......................................27
$PWMCtlCE default configuration ..................... 236
$RampCE default configuration......................... 240

EIO0000004360.04 471
Supervision Services

C digital inputs
$DigitalInputCE................................................ 124
categories digital outputs
master templates by category .............................27 $DigitalOutputCE ............................................. 129
Circuit Breaker digital protection relays
$CompactHWCE ............................................. 390 $Sepam80ECE................................................ 395
$MasterpactHWCE .......................................... 387 DigitalInputCE
circuit breakers digital inputs .................................................... 124
$CompactNSXMBUCE..................................... 367 DigitalOutputCE
compatibility digital outputs .................................................. 129
software compatibility .........................................22 DIO
configuration $aOPCClientGP OPC client.............................. 107
Alarms tab .........................................................93 discrete data tab
Analog page ......................................................98 faceplate tabs ....................................................73
attributes page................................................. 100 discrete motorized valves
Discrete pages...................................................96 $MValveCE ..................................................... 177
Failure Conditions page..................... 272, 290, 319 Discrete pages
Failures page.....................................................89 configuration......................................................96
Initial Conditions page ....................... 271, 289, 318 dual output valves
Input Parameters page ...................... 274, 292, 320 $DualOPValveCE ............................................ 183
Interlocks page ..................................................88 dynamic variable statuses
Local Panel tab ..................................................93 element styles ...................................................47
Main page .................... 95, 270, 288, 316, 329, 335
Maintenance page .............................................92
object information page .................................... 101
Output Parameters page ................... 275, 293, 321
E
Parameters page ......................................273, 291 EasergyP3
scripts page..................................................... 101 supervision services......................................... 399
configuration pages EasergyP5
Batch phase objects ......................................... 288 supervision services......................................... 403
equipment module objects ................................ 316 editing
for device objects ...............................................95 configuring templates or instances ......................85
for process objects .............................................88 element styles
sequential control objects ................................. 270 dynamic variable statuses...................................47
configuring EMPatternCE
configuring templates or instances ......................85 equipment module management ....................... 304
OPC clients .......................................................84 equipment module
control valves $EMPatternCE ................................................ 304
$ControlValveCE ............................................. 197
ControlValveCE
control valves .................................................. 197 F
creation
model view ........................................................83 faceplate as a popup
faceplate as a popup ..........................................58
faceplate tabs
D alarms tab .........................................................75
analog data tab ..................................................72
data management templates discrete data tab ................................................73
list of master templates.......................................27 Failures tab .......................................................68
database backup interlocks tab .....................................................65
restoring the database........................................22 local panel section .............................................64
device integration master templates maintenance tab ................................................70
$aOPCClientGP .............................................. 107 faceplates
$aRedundantDIObjectGP ................................. 109 common tabs.....................................................75
device integration templates representation of supervision data.......................46
list of master templates.......................................27 tab icons ...........................................................51
device objects tabs common to devices .....................................72
configuration pages............................................95 tabs common to process objects .........................64
device templates Failure Conditions page
list of master templates.......................................27 configuration..................................... 272, 290, 319
devices Failures page
faceplate tabs common to devices.......................72 configuration......................................................89
devices with variable speed drive Failures tab
$MotorVSCE ................................................... 210 faceplate tabs ....................................................68
diagnosis families
$aRedundantDIObjectGP ................................. 109 master templates by family .................................27
$M340DiagCE description ................................ 464 Flow Control
$M580DiagCE description ................................ 464 $PumpFlowCtrlCE ........................................... 331
diagnostic templates
list of master templates.......................................27

472 EIO0000004360.04
 Supervision Services

G $MasterpactNxCMBUCE .................................. 383

$MasterpactNxMBUCE .................................... 380
graphic symbols Me suffix
integrating .........................................................85 attributes ......................................................... 100
graphics MessageBoxCE
representation of supervision data.......................46 operator messages .......................................... 348
messages
$MessageBoxCE operator messages................ 348
H model view
hand valves creation .............................................................83
$HandValveCE ................................................ 160 Motor2DirCE
HandValveCE 2-speed/2-rotation direction management .......... 171
hand valves ..................................................... 160 MotorCE
on/off motor ..................................................... 164
motorized valves
I $MValveCE ..................................................... 177
motorized valves with feedback
icons $MValvewithPosCE.......................................... 204
description.........................................................48 motors
faceplate tab icons .............................................51 $Motor2DirCE 2-speed/2-rotation-direction
SA management ................................................46 motors ........................................................... 171
IMC controllers $MotorCE description....................................... 164
$IMCTLCE ...................................................... 219 MotorVSCE
IMCTLCE devices with variable speed drive ...................... 210
internal model controllers.................................. 219 multi monitor
InBatch multi monitor......................................................60
$PhaseCE....................................................... 278 Multi Monitor......................................................60
Initial Conditions page multilanguage support
configuration..................................... 271, 289, 318 overview............................................................43
Input Parameters page multiple analog inputs
configuration..................................... 274, 292, 320 $AnalogInMultiCE ............................................ 133
installation MValvewithPosCE
library installation ...............................................22 motorized valves with feedback......................... 204
instances
configuring ........................................................85
Interlocks page N
configuration......................................................88
interlocks tab Namur NE-107
faceplate tabs ....................................................65 Namur status management.................................40

L O
languages object information page
multilanguage support ........................................43 configuration.................................................... 101
lead lag controllers objects
$LeadLagCE ................................................... 226 configuration pages........................... 270, 288, 316
library on/off motors
library installation ...............................................22 $MotorCE description....................................... 164
local panel section on/off valves
faceplate tabs ....................................................64 $ValveCE ........................................................ 190
Local Panel tab OPC client
configuration......................................................93 $aOPCClientGP .............................................. 107
localization configuring ........................................................84
multilanguage support ........................................43 OPC client diagnosis
$aRedundantDIObjectGP ................................. 109
operator messages
M $MessageBoxCE description ............................ 348
Output Parameters page
Main page configuration..................................... 275, 293, 321
configuration................. 95, 270, 288, 316, 329, 335
Maintenance page
configuration......................................................92 P
maintenance tab
faceplate tabs ....................................................70 pages
master templates Batch phase objects ......................................... 288
list of master templates.......................................27 device object configuration pages........................95
Masterpact equipment module objects ................................ 316
$MasterpactMTZCMBUCE ............................... 371 process object configuration pages .....................88
$MasterpactMTZMBUCE ................................. 376 sequential control objects ................................. 270
parameter set templates
EIO0000004360.04 473
Supervision Services

list of master templates.......................................27 Sequential Control management ....................... 259

parameters Sequential Control
attributes page................................................. 100 $SequenceCE ................................................. 259
Parameters page Services folders
configuration.............................................273, 291 recommendations ..............................................27
ParameterSets database setpoint management
restoring the database........................................22 $SPBoolCE boolean setpoints .......................... 352
PhaseCE $SPDurationCE Duration setpoints.................... 358
Batch phase management ................................ 278 $SPIntCE INT setpoints.................................... 356
PIDCE $SPRealCE real setpoints ................................ 354
PID controllers ................................................. 231 severities
PIDs SA alarm configuration .......................................38
$PIDCE........................................................... 231 shelving
power meter alarm shelving ...................................................39
$PM82xxEMCE ............................................... 422 smart device objects
power meters configuration pages............................................95
$PM5350MBCE and $PM53xxEMCE ................ 418 smart device templates
priority list of master templates.......................................27
alarm priorities ...................................................38 soft starters
process $ATS22MBCE ................................................. 426
faceplate tabs common to process objects ...........64 $ATS48MBCE ................................................. 430
process objects MBTCPATS480 ............................................... 435
configuration pages............................................88 software
process templates software compatibility .........................................22
list of master templates.......................................27 SPBoolCE
pulse-width modulation controllers boolean setpoint management .......................... 352
$PWMCtlCE .................................................... 235 SPDurationCE
Pump Set Duration setpoints ............................................ 358
$PumpSetCtrlCE ............................................. 325 SPIntCE
PWM controllers INT setpoint management................................. 356
$PWMCtlCE .................................................... 235 split range controllers
PWMCtlCE $SplitRangeCE ................................................ 248
pulse-width modulation controllers .................... 235 SplitRangeCE
split range controllers ....................................... 248
SPRealCE
R real setpoints ................................................... 354
state alarms
RampCE $aAppEngineGP default configuration ............... 103
ramps ............................................................. 239 $aAreaGP default configuration ........................ 106
ramps $aAreaRootGP default configuration ................. 106
$RampCE ....................................................... 239 $AlarmSummaryCE default configuration .......... 338
ratio controllers $AnalogInMultiCE default configuration ............. 134
$RatioCtrlCE ................................................... 243 $AnalogInputCE default configuration................ 113
RatioCtrlCE $AnalogOutputCE default configuration ............. 119
ratio controllers ................................................ 243 $AnalogSelectCE default configuration.............. 345
redundancy $ControlValveCE default configuration............... 198
$aRedundantDIObjectGP ................................. 109 $DigitalInputCE default configuration................. 125
references $DigitalOutputCE default configuration .............. 130
unresolved references of unassigned instances ...85 $DualOPValveCE default configuration.............. 185
representation $EMPatternCE default configuration.................. 308
representation of supervision data.......................46 $HandValveCE default configuration ................. 161
restoring $IMCTLCE default configuration ....................... 221
restoring the ParameterSets database.................22 $LeadLagCtlCE default configuration ................ 228
root areas $MessageBoxCE default configuration .............. 349
$aAreaRootGP ................................................ 105 $Motor2DirCE default configuration................... 173
$MotorCE default configuration ......................... 166
$MotorVSCE default configuration .................... 212
S $MValveCE default configuration....................... 179
Scheduler function $MValvewithPosCE default configuration ........... 206
$SchedulerCE ................................................. 361 $PhaseCE default configuration ........................ 281
SchedulerCE $PIDCE default configuration ............................ 233
Scheduler function ........................................... 361 $PumpFlowCtrlCE default configuration............. 333
scripts page $PumpSetCtrlCE default configuration............... 327
configuration.................................................... 101 $PWMCtlCE default configuration ..................... 236
security classification $RampCE default configuration......................... 240
library default settings ........................................36 $RatioCtrlCE default configuration .................... 244
security groups $SchedulerCE default configuration .................. 362
library default settings ........................................36 $SequenceCE default configuration .................. 262
SequenceCE $SPBoolCE default configuration ...................... 353

474 EIO0000004360.04
 Supervision Services

$SPDurationCE default configuration ................ 359 tabs common to devices .....................................72

$SPIntCE default configuration ......................... 357 tabs common to process objects .........................64
$SplitRangeCE default configuration ................. 250 Template Toolbox
$SPRealCE default configuration ...................... 355 Services folders .................................................27
$Step3CtlCE default configuration..................... 254 templates
$TotalCE default configuration .......................... 140 configuring ........................................................85
$ValveCE default configuration ......................... 191 list of master templates.......................................27
default alarm conditions for $aOPCClientGP ...... 107 TeSys T
default alarm conditions for $TesysTAllDataCE ........................................... 408
$aRedundantDIObjectGP ............................... 109 $TesysTEFastCE ............................................. 408
default alarm conditions for $ATS22MBCE......... 428 $TesysTPBCE ................................................. 408
default alarm conditions for $ATS480MBTCPCE and TeSys U
$ATS480EIPCE ............................................. 437 $TesysUIOCE.................................................. 413
default alarm conditions for $ATS48MBCE......... 432 $TesysUMainDataCE ....................................... 413
default alarm conditions for $ATV320EMCE ....... 455 $TesysUMECCE .............................................. 413
default alarm conditions for $ATV340CE ............ 460 three-step controllers/positioners
default alarm conditions for $ATV6xxECE .......... 442 $Step3CtlCE ................................................... 252
default alarm conditions for $ATV6xxxECE ........ 451 TotalCE
default alarm conditions for $ATV9xxECE .......... 446 Totalizing Function ........................................... 138
default alarm conditions for $CompactHWCE..... 392 totalizing function
default alarm conditions for $TotalCE ......................................................... 138
$CompactNSXMBUCE ................................... 369
default alarm conditions for $EasergyP3MCE..... 401
default alarm conditions for $EasergyP5EMCE .. 405 U
default alarm conditions for $M340DiagCE ........ 466
default alarm conditions for $M580DiagCE ........ 466 unresolved references
default alarm conditions for editing unassigned instances ..............................85
$MasterpactHWCE......................................... 389
default alarm conditions for
$MasterpactMTZCMBUCE ............................. 373 V
default alarm conditions for ValveCE
$MasterpactMTZMBUCE................................ 377 on/off valves .................................................... 190
default alarm conditions for valves
$MasterpactNxCMBUCE ................................ 385 $ValveCE ........................................................ 190
default alarm conditions for variable speed drives
$MasterpactNxMBUCE................................... 381 $ATV320EMCE ............................................... 453
default alarm conditions for $PM5350MBCE ...... 419 $ATV340CE .................................................... 458
default alarm conditions for $PM82xxEMCE....... 424 $ATV6xxECE................................................... 440
default alarm conditions for $Sepam80ECE ....... 397 $ATV6xxxECE ................................................. 449
default alarm conditions for $TesysTAllDataCE... 410 $ATV9xxECE................................................... 445
default alarm conditions for $TesysTEFastCE .... 410 $MotorVSCE devices with variable speed
default alarm conditions for $TesysTPBCE......... 410 drive.............................................................. 210
default alarm conditions for $TesysUIOCE ......... 415 versions
default alarm conditions for software compatibility .........................................22
$TesysUMainDataCE ..................................... 415
default alarm conditions for $TesysUMECCE ..... 415
default configuration for devices ........................ 366
Step3CtlCE
three-step controller/positioner.......................... 252
supervision data
representation ...................................................46
supervision services
EasergyP3 management .................................. 399
EasergyP5 management .................................. 403
symbols
icons used in symbols ........................................48
integrating .........................................................85
system master templates
$aAppEngineGP .............................................. 103
$aAreaGP ....................................................... 105
$aAreaRootGP ................................................ 105
system templates
list of master templates.......................................27

T
tabs
alarms tab .........................................................75
common faceplate tabs ......................................75

EIO0000004360.04 475
Schneider Electric
35 rue Joseph Monier
92500 Rueil Malmaison
France
+ 33 (0) 1 41 29 70 00
www.se.com

As standards, specifications, and design change from time to time,

please ask for confirmation of the information given in this publication.

© 2022 Schneider Electric. All rights reserved.

EIO0000004360.04