Schneider Electric EcoStruxure™ Hybrid DCS - Diagnostics Supervision Services User Guide

EcoStruxure™ Hybrid DCS
EIO0000001528 10/2018
EcoStruxure™ Hybrid DCS
Diagnostic Supervision Services User
Guide
EIO0000001528.14
08/2019
www.schneider-electric.com
The information provided in this documentation contains general descriptions and/or technical
characteristics of the performance of the products contained herein. This documentation is not
intended as a substitute for and is not to be used for determining suitability or reliability of these
products for specific user applications. It is the duty of any such user or integrator to perform the
appropriate and complete risk analysis, evaluation and testing of the products with respect to the
relevant specific application or use thereof. Neither Schneider Electric nor any of its affiliates or
subsidiaries shall be responsible or liable for misuse of the information contained herein. If you
have any suggestions for improvements or amendments or have found errors in this publication,
please notify us.
You agree not to reproduce, other than for your own personal, noncommercial use, all or part of
this document on any medium whatsoever without permission of Schneider Electric, given in
writing. You also agree not to establish any hypertext links to this document or its content.
Schneider Electric does not grant any right or license for the personal and noncommercial use of
the document or its content, except for a non-exclusive license to consult it on an "as is" basis, at
your own risk. All other rights are reserved.
All pertinent state, regional, and local safety regulations must be observed when installing and
using this product. For reasons of safety and to help ensure compliance with documented system
data, only the manufacturer should perform repairs to components.
When devices are used for applications with technical safety requirements, the relevant
instructions must be followed.
Failure to use Schneider Electric software or approved software with our hardware products may
result in injury, harm, or improper operating results.
Failure to observe this information can result in injury or equipment damage.
© 2019 Schneider Electric. All rights reserved.
2
EIO0000001528 08/2019
Table of Contents
Safety Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
About the Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Part I Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1 Supervision Services . . . . . . . . . . . . . . . . . . . . . . . . . . .
Delivering Supervision Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
List of Supervision Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 2 Genies and Faceplates. . . . . . . . . . . . . . . . . . . . . . . . . .
Using Genies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Information Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Part II Control System Diagnosis . . . . . . . . . . . . . . . . . . . .
Chapter 3 Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Description of the Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 4 Control and Supervision Services Relationship . . . . . . .
Control/Supervision Relationship . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 5 CPU Diagnostic Management . . . . . . . . . . . . . . . . . . . .
Supervision Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Genies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Part III Supervision System Diagnosis . . . . . . . . . . . . . . . . .
Chapter 6 Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 7 Configuring Microsoft® Windows® TCPIP Parameters .
Configuring Microsoft® Windows® TCPIP Parameters. . . . . . . . . . . .
Chapter 8 Initializing Components. . . . . . . . . . . . . . . . . . . . . . . . . .
Initializing Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 9 Server Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Server Component Genies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 10 Client Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Client Component Genies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EIO0000001528 08/2019
5
7
9
11
12
13
15
16
17
19
21
21
23
23
25
26
27
30
32
39
41
41
43
43
45
45
49
50
52
55
56
58
3
Chapter 11 I/O Device Component . . . . . . . . . . . . . . . . . . . . . . . . . . .
I/O Component Genies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Faceplates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4
61
62
66
67
EIO0000001528 08/2019
Safety Information
Important Information
NOTICE
Read these instructions carefully, and look at the equipment to become familiar with the device
before trying to install, operate, service, or maintain it. The following special messages may appear
throughout this documentation or on the equipment to warn of potential hazards or to call attention
to information that clarifies or simplifies a procedure.
EIO0000001528 08/2019
5
PLEASE NOTE
Electrical equipment should be installed, operated, serviced, and maintained only by qualified
personnel. No responsibility is assumed by Schneider Electric for any consequences arising out of
the use of this material.
A qualified person is one who has skills and knowledge related to the construction and operation
of electrical equipment and its installation, and has received safety training to recognize and avoid
the hazards involved.
6
EIO0000001528 08/2019
About the Book
At a Glance
Document Scope
This document describes the genies, faceplates, and other Supervision components that provide
the Supervision services for diagnostic functions.
This document only covers the functional aspects of Supervision services when engineering a
system, using EcoStruxure Hybrid DCS, and describes the dynamic objects visible from the
runtime. It does not cover any operational aspects, nor does it provide information on how to use
Supervision services to monitor and operate control systems.
Users of Supervision services need to have a very good working knowledge of EcoStruxure
Hybrid DCS, and of the Supervision and Control Participants.
Validity Note
This document is valid for the EcoStruxure Hybrid DCS - General Purpose Library 2019 Classic. It
supersedes any previous version.
Related Documents
Title of Documentation
Reference Number
EcoStruxure Hybrid DCS User Guide
EIO0000001114
EcoStruxure Hybrid DCS Diagnostic Templates User Guide
EIO0000001526
EcoStruxure Hybrid DCS Diagnostic Control Services User Guide
EIO0000001527
You can download these technical publications and other technical information from our website
at https://www.schneider-electric.com/en/download
Technical Support
Visit https://app.schneider-electric.com/ecostruxure-hybrid-dcs for support information and
services.
Registration required.
EIO0000001528 08/2019
7
Product Related Information
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.
Examples described in this manual are provided for information only.
WARNING
UNINTENDED EQUIPMENT OPERATION
Adapt examples that are given in this manual to the specific functions and requirements of your
industrial application before you implement them.
Failure to follow these instructions can result in death, serious injury, or equipment damage.
8
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Overview
EIO0000001528 10/2018
Part I
Overview
Overview
What Is in This Part?
This part contains the following chapters:
Chapter
Chapter Name
Page
1
Supervision Services
11
2
Genies and Faceplates
15
EIO0000001528 08/2019
9
Overview
10
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Supervision Services
EIO0000001528 10/2018
Chapter 1
Supervision Services
Supervision Services
What Is in This Chapter?
This chapter contains the following topics:
Topic
Page
Delivering Supervision Services
12
List of Supervision Functions
13
EIO0000001528 08/2019
11
Supervision Services
Delivering Supervision Services
Introduction
Inside diagnostic control module templates, the resources providing Supervision services to
diagnose controllers are organized in composite and facet templates. They are called references.
Interfaces link these references within the control module and allow making links to instances of
other templates.
You can also use Supervision components (genies and faceplates) independently of diagnostic
control module templates. For example, you have the possibility to use a given genie of the
SGC_Include2 project and its associated faceplate with your own control resources, which are
controlling compatible devices.
Supervision services are optional.
Supervision Facet References
A facet reference is the smallest component of a process template.
It encapsulates the constituents of the Supervision Participant, which are the tags or genies
described in this document.
During generation (see EcoStruxure™ Hybrid DCS, User Guide), these constituents become part
of the Supervision (see EcoStruxure™ Hybrid DCS, User Guide) Participant project that you have
created in EcoStruxure Hybrid DCS.
Supervision Composite References
A Supervision composite reference is a container for Supervision facet references and/or other
composite references.
They help organizing Supervision services inside the control module template.
Configuring Supervision Services
Supervision resources that correspond to the selected Control services for the diagnosis of
controllers are activated by default.
To customize the services provided by an instance that uses the control module template, the
Properties window of the instance allows you to:
 Deactivate Supervision resources.
 Configure the parameters of selected Supervision resources.
In addition, you can modify the Supervision Participant project and its pages during refinement.
12
EIO0000001528 08/2019
Supervision Services
List of Supervision Functions
Supervision Functions for Controller Diagnosis
The table lists the Supervision functions for controller and Supervision system diagnostic
management:
Function
CPU diagnostic management (see page 25)
Supervision system diagnostic management (see page 39)
EIO0000001528 08/2019
13
Supervision Services
14
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Genies and Faceplates
EIO0000001528 10/2018
Chapter 2
Genies and Faceplates
Genies and Faceplates
What Is in This Chapter?
This chapter contains the following topics:
Topic
Page
Using Genies
16
Information Tab
17
EIO0000001528 08/2019
15
Genies and Faceplates
Using Genies
Genie Availability
The SGC_Include2 resource contains a number of genies grouped in libraries that correspond to
Supervision functions. For example, the sgc_devctl_motors library contains six genies for
on/off motor management.
These genies allow monitoring and interacting with control modules during operation.
Genies become visible in runtime once you assign them to a Supervision page.
Assigning Genies
You can assign the genies that are referenced a template to a Supervision page by editing the
page, using the Edit command.
Genie Properties
Once you have assigned a genie to a page, double-click it to display its properties.
Genies of the SGC_Include2 project have the Control Module and Area properties but may also
feature additional properties.
The following figure shows an example of the properties dialog box of the SPBool_Checkbox_10
genie, featuring the additional Legend property:
Genie Control Module Name
The name that appears in the Control Module field of the genie properties window is used to
generate expressions referencing tags.
For example, a genie of the sgc_devctl_motors library (on/off motor management) with
Conveyor1 as a Control Module (CM) name generates connections with the following tags:
Conveyor1_DEVCTL_STW and Conveyor1_DEVCTL_CFGW.
16
EIO0000001528 08/2019
Genies and Faceplates
Information Tab
Representation
The following figure shows an example of the information tab that is available for each faceplate:
1
2
3
4
5
Default identifier of the instance using the faceplate
Name of the include project that contains the faceplate
Name of the faceplate file
Version of the include project that contains the faceplate
Description of the object
EIO0000001528 08/2019
17
Genies and Faceplates
18
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Control System Diagnosis
EIO0000001528 10/2018
Part II
Control System Diagnosis
Control System Diagnosis
Overview
This chapter describes the resources that allow you to diagnose the control system implemented
with EcoStruxure Hybrid DCS.
These function blocks do not reflect any specific installation.
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.
What Is in This Part?
This part contains the following chapters:
Chapter
Chapter Name
Page
3
Libraries
21
4
Control and Supervision Services Relationship
23
5
CPU Diagnostic Management
25
EIO0000001528 08/2019
19
Control System Diagnosis
20
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Libraries
EIO0000001528 10/2018
Chapter 3
Libraries
Libraries
Description of the Libraries
Description
The resources for the diagnosis of the Control system are included in libraries of the SGC_Include2
project. The xy suffixes in the resource names indicate their version (x) and revision (y)
respectively.
Symbol libraries:
sgc_icons: Basic icons used by multiple objects.
 sgc_citect: Various icons for system diagnosis.

Dynamic object libraries (genies):
sgc_citect: Includes the following genies for control system diagnosis:
 sgc_cpudiag_m340_xy: Diagnosis of M340 platform CPUs.
 sgc_cpudiag_quantum_xy: Diagnosis of Quantum platform CPUs.
 sgc_cpudiag_m580_xy: Diagnosis of M580 platform CPUs.


sgc_items: Basic genies used by other genies.
Faceplates:
!sgc_CPUDIAG_M340: Diagnosis for M340 platform CPUs.
 !sgc_CPUDIAG_QP: Diagnosis for Quantum platform CPU.
 !sgc_CPUDIAG_M580: Diagnosis for M580 platform CPU.

Cicode archives (Auxiliary code for managing animations):
sgc_cpudiag: Functions for opening the faceplate associated to the genies.
 sgc_general: Common primitives used by multiple animation objects.

EIO0000001528 08/2019
21
Libraries
22
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Control and Supervision Services Relationship
EIO0000001528 10/2018
Chapter 4
Control and Supervision Services Relationship
Control and Supervision Services Relationship
Control/Supervision Relationship
Overview
The table describes, which Control resources provide data to the Supervision components of the
sgc_citect library when implemented through the corresponding diagnosis control module
template:
AUX1INFO
AUX2INFO
AUX3INFO
BATT
COMM
FASTINFO
GENSTS
LASTSTOP
MASTINFO
OSINFO
RTC
Supervision resources
AUX0INFO
Supervision service (component)
M340 controller diagnosis
(sgc_cpudiag_m340_xy)
–
–
–
–
–
O
O
X
O
O
O
O
Quantum controller diagnosis(1)
(sgc_cpudiag_quantum_xy)
O
O
O
O
O
O
O
X
O
O
O
O
M580 controller diagnosis(1)
(sgc_cpudiag_m580_xy)
O
O
–
–
–
O
O
X
O
O
O
O
X mandatory resource
O optional resource
(1) AUX tasks are only available in dual core CPUs.
EIO0000001528 08/2019
23
Control and Supervision Services Relationship
24
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
CPU Diagnostic Management
EIO0000001528 10/2018
Chapter 5
CPU Diagnostic Management
CPU Diagnostic Management
Overview
This chapter describes the Supervision resources and runtime services for the diagnosis of
controllers of the platforms (M340, M580, and Quantum).
What Is in This Chapter?
This chapter contains the following topics:
Topic
Page
Supervision Functions
26
Tags
27
Genies
30
Faceplates
32
EIO0000001528 08/2019
25
CPU Diagnostic Management
Supervision Functions
Description
The diagnostic Supervision services are available for CPUs of the platforms (M340, M580, and
Quantum).
26
EIO0000001528 08/2019
CPU Diagnostic Management
Tags
Tag Syntax
Refer to Genie Control Module Name (see page 16).
Common Variable Tags
The table describes the common variable tags that are managed by Supervision components for
all platforms:
Tag
Description
CM name_GENSTS_SYSBITW
Device status information
CM name_GENSTS_GENSTS_COUNTER
Activity counter
CM name_GENSTS_COMM_CURREQ
Current requests
CM name_GENSTS_COMM_MAXREG
Maximum requests
CM name_GENSTS_COMM_USEDCOMM
Used communication
CM name_GENSTS_OSINFO_CPUFIRM
CPU firmware
CM name_GENSTS_OSINFO_CPUPATCH
CPU patch
CM name_GENSTS_OSINFO_CPUVER
CPU version
CM name_GENSTS_RTC_ACTDAYOFWEEK
Current day of week
CM name_GENSTS_RTC_ACTHOURMIN
Current hours and minutes
CM name_GENSTS_RTC_ACTMONTHDAY
Current month and day
CM name_GENSTS_RTC_ACTSEC
Current seconds
CM name_GENSTS_RTC_ACTYEAR
Current year
CM name_GENSTS_RTC_NEWDATE
Date setup
CM name_GENSTS_RTC_NEWHOUR
Hour setup
CM name_GENSTS_RTC_NEWMINUTE
Minute setup
CM name_GENSTS_RTC_NEWMONTH
Month setup
CM name_GENSTS_RTC_NEWSEC
Second setup
CM name_GENSTS_RTC_NEWYEAR
Year setup
CM name_GENSTS_RTC_RTCWRITEW
Command
CM name_GENSTS_MASTINFO_CURRTIME
Current time
CM name_GENSTS_MASTINFO_MINTIME
Minimum time
CM name_GENSTS_MASTINFO_MAXTIME
Maximum time
CM name_GENSTS_MASTINFO_WDGVALUE
Watchdog
CM name_GENSTS_LASTSTOP_STOPDAY
Day
CM name_GENSTS_LASTSTOP_STOPMD
Month and day
EIO0000001528 08/2019
27
CPU Diagnostic Management
Tag
Description
CM name_GENSTS_LASTSTOP_STOPHM
Hours and minutes
CM name_GENSTS_LASTSTOP_STOPSEC
Seconds
CM name_GENSTS_LASTSTOP_STOPYEAR
Year
CM name_GENSTS_FASTINFO_CURRTIME
Current time
CM name_GENSTS_FASTINFO_MINTIME
Minimum time
CM name_GENSTS_FASTINFO_MAXTIME
Maximum time
CM name_GENSTS_FASTINFO_WDGVALUE
Watchdog
M580 Variable Tags
The table describes the variable tags apart from the common variable tags that are managed by
Supervision components for M580 platform:
Tag
Description
CM name_GENSTS_AUXnINFO_CURRTIME
Current time
CM name_GENSTS_AUXnINFO_MINTIME
Minimum time
CM name_GENSTS_AUXnINFO_MAXTIME
Maximum time
CM name_GENSTS_AUXnINFO_WDGVALUE
Watchdog
n = 0 and 1.
Quantum Variable Tags
The table describes the variable tags apart from the common variable tags that are managed by
Supervision components for Quantum platform:
Tag
Description
CM name_GENSTS_BATT_BATTW
Status word
CM name_GENSTS_AUXnINFO_CURRTIME
Current time
CM name_GENSTS_AUXnINFO_MINTIME
Minimum time
CM name_GENSTS_AUXnINFO_MAXTIME
Maximum time
CM name_GENSTS_AUXnINFO_WDGVALUE
Watchdog
n = 0, 1, 2 and 3.
28
EIO0000001528 08/2019
CPU Diagnostic Management
Advanced Alarm Tags
The table describes the advanced alarm tags that are managed by Supervision components and
the expression that is configured in the Supervision component to read or write the corresponding
bit of the status or configuration word:
Name
Description
Expression
Process
event
CM name_GENSTS_GENSTS_IOE
Detected error in I/O
CM name_GENSTS_SYSBITW
BitAND 0x0004
No
CM name_GENSTS_GENSTS_WDO
Watchdog
CM name_GENSTS_SYSBITW
BitAND 0x0008
Trend Tags
No trend tags are managed by Supervision components for diagnosis of controllers of the M340,
M580, and Quantum platforms.
EIO0000001528 08/2019
29
CPU Diagnostic Management
Genies
Genie Properties
Refer to Using Genies (see page 16)
Representation
The table shows the genie of the sgc_citect library:
Graphic symbol
30
Platform
Genie name
Faceplate template
identifier
M340
sgc_cpudiag_ $M340Diag_CG
m340_10
M580
sgc_cpudiag_ $M580Diag_CG
M580_10
Quantum
sgc_cpudiag_ $QuantumDiag_CG
quantum_10
Description
Genie to supervise a
CPU of the platforms.
The label indicates the
name of the entity that is
being supervised.
EIO0000001528 08/2019
CPU Diagnostic Management
Description
The table describes the icons that appear on the genie during operation:
Icon
Platform
Description
M340
M580
Quantum
The arrows are animated when the controller
is online and running.
M340
M580
Quantum
Indicates a non-operational I/O. The icon
corresponds to the I/O LED that is located on
the CPU itself.
M340
Indicates a non-operational I/O.
Quantum
M580
EIO0000001528 08/2019
Indicates overflow of watchdog timer.
31
CPU Diagnostic Management
Faceplates
Overview
During operation, click the genie to display a faceplate with various tabs that provide diagnostic
information on the controller being supervised.
Communication Tab
The following figure displays the Communication tab faceplate for M340 and M580 platforms:
32
EIO0000001528 08/2019
CPU Diagnostic Management
The following figure displays the Communication tab faceplate for Quantum platform:
EIO0000001528 08/2019
33
CPU Diagnostic Management
RTC Tab
The following figure displays the RTC tab faceplate for M340 and Quantum platforms:
34
EIO0000001528 08/2019
CPU Diagnostic Management
The following figure displays the RTC tab faceplate for M580.
EIO0000001528 08/2019
35
CPU Diagnostic Management
Status Tab
The following figure displays the Status tab faceplate for M340, M580, and Quantum platforms:
36
EIO0000001528 08/2019
CPU Diagnostic Management
Auxiliary Tab
The following figure displays the Auxiliary tab faceplate for Quantum platform:
EIO0000001528 08/2019
37
CPU Diagnostic Management
The following figure displays the Auxiliary tab faceplate for M580 platform:
38
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Supervision System Diagnosis
EIO0000001528 10/2018
Part III
Supervision System Diagnosis
Supervision System Diagnosis
Overview
This part describes the resources that allow you to diagnose the Supervision system implemented
with EcoStruxure Hybrid DCS, using graphic elements that represent the architecture of the
system.
NOTE: Components for the diagnosis of the Supervision system are not encapsulated in templates
but are contained in the SGC_Include2 project. Use these components through refinement of the
Supervision project.
What Is in This Part?
This part contains the following chapters:
Chapter
Chapter Name
Page
6
Libraries
41
7
Configuring Microsoft® Windows® TCPIP Parameters
43
8
Initializing Components
45
9
Server Component
49
10
Client Component
55
11
I/O Device Component
61
EIO0000001528 08/2019
39
Supervision System Diagnosis
40
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Libraries
EIO0000001528 10/2018
Chapter 6
Libraries
Libraries
Libraries
Working Principle
The working principle of these resources is based on the Supervision node checking the status of
the entities represented in the architecture and creating local data tables in the node itself. These
local data tables are based on the information that you provide when you create the diagnosis
screen of the system.
The genies used for system diagnosis access this data through primitives, which are included in
the SGC_Include2 project. The information that is displayed represents a snapshot of the current
status of the devices and nodes that are comprised in the architecture of the system.
The different types of nodes are:
Server Node: Represented by a server component.
 Client Node: Represented by a client component.
 Controller: Represented by an I/O device component.

You can combine genies to monitor the various functions that each node of the system carries out
based on its configuration.
NOTE: To obtain information on client nodes or I/O devices, the server nodes of the system have
to be inserted in the diagnostic screen.
For example, if your system consists of 4 servers (one each for the alarm, trend, report, and
communication services), you need to assign 4 server genies in the screen, each genie
representing 1 server. This way, the genies that represent client nodes or I/O devices are able to
show their information correctly.
Using Diagnostic Supervision Functions
To use the diagnostic functionalities of Supervision nodes, start a session with a user account that
exists in the nodes that you want to diagnose.
Required Software Components
Genies and faceplates implemented for the Supervision diagnosis use Microsoft® Forms 2.0
ActiveX® controls and/or the corresponding resources.
Verify that the corresponding Microsoft® ActiveX® control resources are installed on PCs on which
you want to use the library components during operation.
EIO0000001528 08/2019
41
Libraries
Contents
The resources for the diagnosis of Supervision nodes and processes are included in libraries of
the SGC_Include2 project. The xy suffixes in the resource names indicate their version (x) and
revision (y) respectively.
Symbol libraries
sgc_icons: Basic icons used from multiple objects.
 sgc_citect: Various icons for system diagnosis.

Dynamic object libraries (genies):
sgc_citect: Includes the following genies for monitoring subsystem diagnoses:
 sgc_client_xy: Monitors the status of the Supervision client. It displays information on the
server about the services and functions to perform a restart of the node or the monitoring
Supervision software used by the client.
 sgc_iodev_xy: Summarizes the status of the I/O devices that work together to provide
communication with one single device (those I/O devices that have the same device number
are associated to them in the system configuration to provide communication redundancy).
 sgc_m340_iodev: Combines the diagnosis of a controller of the M340 platform and the
associated I/O device.
 sgc_m580_iodev: Combines the diagnosis of a controller of the M580 platform and the
associated I/O device.
 sgc_quantum_iodev: Combines the diagnosis of a controller of the Quantum platform and
the associated I/O device.
 sgc_refresh_xy: Button that includes the calls to code that is necessary to refresh the
diagnostic information on screen. (To refresh the information when you open the screen
requires a specific configuration (see page 47)).
 sgc_server_xy: Monitors the services (alarms, trend logs, and/or reports) and
communications services (I/O server) provided by the server of the system.


sgc_items: Basic genies used by other genies.
Faceplates:
 !sgc_client_xy: Diagnosis of a Supervision client process.
 !sgc_IODevice_xy: Diagnosis of a Supervision I/O device.
 !sgc_server_xy: Diagnosis of the Supervision server processes.
Cicode archives (auxiliary code to manage animations):
 sgc_citect: Functions that allow you to determine the status of the Citect SCADA processes.
 sgc_cpudiag: Functions for opening the faceplates (pages) associated to the dynamic objects
(genies).
 sgc_general: Common primitives used from multiple animation objects.
42
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Configuring TCPIP Parameters
EIO0000001528 10/2018
Chapter 7
Configuring Microsoft® Windows® TCPIP Parameters
Configuring Microsoft® Windows® TCPIP Parameters
Configuring Microsoft® Windows® TCPIP Parameters
Overview
The Microsoft® Windows® operating system has certain configuration parameters by default that
affect TCPIP communication. They are not entirely suited to the accurate execution of functions
related to the diagnosis of communications.
You need to change some Microsoft® Windows® registry keys so that the Supervision software
kernel can provide accurate data about the status of its TCPIP communication.
If the default parameters are kept and, for example, a cable breaks, Microsoft® Windows® does
not consider that the connection is interrupted unless the source of data is the node itself. This may
result in a server genie continuing to show on screen that it has n connected clients because the
connection is still established in the Microsoft® Windows® TCP stack although communication
with 1 or more of them is actually interrupted.
New TCPIP Parameters
These are the new parameters to be configured and the corresponding keys:
KeepAliveTime = 1000 ms
 TcpMaxDataRetransmissions = 3
 TcpTimeWaitDelay = 30

The keys are located at the following path:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters.
Benefits of the New Parameters
With these parameters in effect, the operating system checks the status of the connection with a
device every 1,000 ms and makes 3 additional attempts. After that, once a 4-second delay has
elapsed without a connection being established, the operating system considers that the
connection is interrupted.
EIO0000001528 08/2019
43
Configuring TCPIP Parameters
44
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Initializing Components
EIO0000001528 10/2018
Chapter 8
Initializing Components
Initializing Components
Initializing Components
Description
Diagnostic components have to be initialized and their initial refresh process forced so that the
status of the entities that make up the system (servers, clients, and/or controllers) is displayed
when the diagnosis page opens.
EIO0000001528 08/2019
45
Initializing Components
To initialize diagnostic components and force their initial refresh, the configuration described in this
procedure needs to be applied to the properties of the page that is used as the diagnostics screen:
46
Step
Action
1
Select On page entry in the Events tab and enter the commands in the On
page entry command field as shown in the figure.
2
Select On page shown in the Events tab and enter the commands in the
On page shown command field as shown in the figure.
EIO0000001528 08/2019
Initializing Components
Displaying and Hiding Component Names
You can define a key stroke sequence that allows you to control the display of the name of each
component in real time:
Step
Action
1
In this example, the component names are shown when you press the
PAGE DOWN key.
NOTE: You can enter the code shown in the figure for any other event.
EIO0000001528 08/2019
47
Initializing Components
48
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Server Component
EIO0000001528 10/2018
Chapter 9
Server Component
Server Component
Overview
This chapter describes the server component.
What Is in This Chapter?
This chapter contains the following topics:
Topic
Page
Server Component Genies
50
Faceplates
52
EIO0000001528 08/2019
49
Server Component
Server Component Genies
Server Component Description
This genie represents a node that has been configured as an alarm, trend, report, or I/O server,
either as an all-in-one station or as a server, which provides these services to other client nodes.
Based on the name of the node, the genie determines which services it provides, to whom it
provides them, and how many clients for each service are being served.
Assigning Genies
In the Paste Genie dialog box of the Supervision Participant, select the sgc_citect library, then
the genie (see page 42), and click OK.
Genie Properties
Double-click a genie that you have assigned to a page to access its properties window:
You need to provide data for the following properties:
Server Node: Name of the node, which runs the Supervision services. The name of the node is the
one that corresponds to the citect.ini [LAN]Node parameter.
NOTE: For single node systems, leave the field blank.
Description: Free text field to describe the node. The text is displayed in the title bar of the faceplate
associated to the genie.
Area: Access control area to which the component is associated. Not used in the current
component version. Included for compatibility with other components.
50
EIO0000001528 08/2019
Server Component
Representation in Engineering Time
The figure shows the genie in engineering time:
Representation During Operation
The figure shows the genie during operation:
1
2
3
4
Number of clients connected to the alarm service
Number of clients connected to the trend log service
Number of clients connected to the report service
Services are shown with a green rectangle when the service is active and with a red rectangle when it is
inactive. The rectangle is gray when the server does not provide the corresponding service.
EIO0000001528 08/2019
51
Server Component
Faceplates
Overview
During operation, click the genie to display a faceplate with various tabs that provide diagnostic
information on the server component.
Communications Service Tab
1
52
List of clients (and user) connected to the service
EIO0000001528 08/2019
Server Component
Alarm Service Tab
1
2
Number of clients connected to the service
List of clients (and user) connected to the service
Trend Service Tab
EIO0000001528 08/2019
53
Server Component
Report Service Tab
Client Nodes Tab
54
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Client Component
EIO0000001528 10/2018
Chapter 10
Client Component
Client Component
Overview
This chapter describes the client component.
What Is in This Chapter?
This chapter contains the following topics:
Topic
Page
Client Component Genies
56
Faceplates
58
EIO0000001528 08/2019
55
Client Component
Client Component Genies
Client Component Description
This genie represents a client node of the system architecture and is used to determine, which
server nodes provide the different services such as alarms, trends, reports, and communication.
Genie Properties
Double-click a genie that you have assigned to a Supervision page to access its properties window:
You need to provide data for the following properties:
Client Node: Name of the client node. The name of the node is the one that corresponds to the
citect.ini [LAN]Node parameter.
NOTE: For single node systems, leave the field blank.
Description: Free text field to describe the node. The text is displayed in the title bar of the faceplate
associated to the genie.
Area: Access control area to which the component is associated to control the functions that you
can carry out (restart of the node or of the Supervision software).
56
EIO0000001528 08/2019
Client Component
Representation In Engineering Time
The figure shows the genie in engineering time:
Representation During Operation
The figure displays the services of the client node during operation:
1
2
3
4
5
6
Shown only on the node from which the diagnosis screen is being accessed.
Name of the server providing the alarm service.
Name of the server providing the trend log service.
Name of the server providing the report service.
User on the node.
List of I/O servers that the node accesses.
EIO0000001528 08/2019
57
Client Component
Faceplates
Overview
During operation, click the genie to display a faceplate featuring the Restart tab that allows you to
restart the node that this genie represents or the Supervision application running on this node.
NOTE: The operator needs to have a privilege level greater than 2 to use the buttons.
Restart Tab
1
Shows the status of the restart process.
Restarting Nodes
The Citect SCADA services are not available when Shutdown and Restart Citect SCADA and
Shutdown Citect SCADA and Restart Node buttons are clicked and as a result data acquisition
from field does not happen.
NOTE: There is no double confirmation when Shutdown and Restart Citect SCADA and Shutdown
Citect SCADA and Restart Node buttons on the faceplate are clicked.
Shutdown and Restart Citect SCADA
You can use this command to shut down the Citect SCADA services of the node represented in
the client genie and restart that node on the network remotely by configuring the following
parameter in its Citect.ini configuration file in the path (<installed directory>\Citect SCADA
2016\User\<Project Name>):
Parameter
Description
[ShutDown]NetworkStart
1 = The node can send restart commands to other nodes on the
network. Default value is set to 0.
NOTE: Nodes to be restarted remotely need to be configured to accept shutdown calls through the
network.
58
EIO0000001528 08/2019
Client Component
Shutdown Citect SCADA and Restart Node
You can use the Shutdown Citect SCADA and Restart Node button on the faceplate to quit the
Supervision application that is running on the client node configured in the genie and restart the
PC by configuring the [ShutDown]NetworkIgnore parameter.
Parameter
Description
[ShutDown]NetworkIgnore
0 = The node can be restarted by another node through the network.
Default value is set to 1.
NOTE: Configure the parameter in the Citect.ini configuration file in the path (<installed
directory>\Citect SCADA 2016\User\<Project Name>) of the node to be restarted.
EIO0000001528 08/2019
59
Client Component
60
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
I/O Device Component
EIO0000001528 10/2018
Chapter 11
I/O Device Component
I/O Device Component
Overview
This chapter describes the I/O device component.
What Is in This Chapter?
This chapter contains the following topics:
Topic
Page
I/O Component Genies
62
Faceplates
66
EIO0000001528 08/2019
61
I/O Device Component
I/O Component Genies
I/O Device Component Description
Genie that is used to monitor the I/O device.
In addition to the main genie, two additional genies exist that consist of the combination of a control
system diagnosis genie (see page 21) and the I/O device genie.
Assigning Genies
In the Paste Genie dialog box of the Supervision Participant, select the sgc_citect library, then
the genie (see page 42), and click OK.
62
EIO0000001528 08/2019
I/O Device Component
Genie Properties
Double-click a genie that you have assigned to a Supervision page to access its properties window:
You need to provide data for the following parameters:
I/O Device Number: Number associated to the I/O device for device configuration, as shown in the
next figure.
Area: Access control area to which the component is associated. Not used in the current
component version. Included for compatibility with other components.
EIO0000001528 08/2019
63
I/O Device Component
In the Comment field of the I/O device window, you can enter a description that is displayed in the
title bar of the faceplate of the I/O server, as shown in the following figure:
Representation in Engineering Time
1
The bell icon is displayed only during operation if there is a detected problem regarding communication
with this device. It appears in yellow when a related I/O device is disabled or in standby write status, and
in red when a related I/O device is in an offline, starting and offline, or undefined status mode. The icon
also appears in red if communication cannot be established with an I/O server or if there is no I/O device
in a running status.
Representation During Operation
1
64
List of related I/O servers and current status of the I/O device being monitored
EIO0000001528 08/2019
I/O Device Component
Genies Combining Controller and I/O Device
To facilitate diagnostics of a controller and the associated I/O device, the following 2 preconfigured
genies exist:
Graphic symbol
Description
Genie combining an I/O device genie with a
Quantum controller diagnostic genie
(see page 30).
Genie combining an I/O device genie with an
M340 controller diagnostic genie (see page 30).
Genie combining an I/O device genie with an
M580 controller diagnostic genie (see page 30).
NOTE: The controller diagnostic faceplate is displayed when you click the controller icon (M340
(see page 32), Quantum (see page 32) or M580 (see page 32)).
EIO0000001528 08/2019
65
I/O Device Component
Faceplates
Overview
During operation, click the I/O device icon of the I/O device genie (located on top of the white
rectangle) to display a faceplate with various tabs providing diagnostic information on the I/O
device component.
I/O Device Tab
The I/O device tab shows the I/O devices that are active:
66
EIO0000001528 08/2019
EcoStruxure™ Hybrid DCS
Index
EIO0000001528 10/2018
Index
C
client component
supervision system diagnosis, 55
component names
displaying and hiding, 47
CPU
diagnostic supervision functions, 25
D
diagnostic monitoring
control and supervision services relationship, 23
libraries, 21
diagnostic supervision services
supervision functions, 13
diagnostic supervision templates
description, 12
F
faceplate tabs
information tab, 17
L
libraries
monitoring subsystem diagnosis, 41
N
names
displaying and hiding diagnostic component names, 47
S
server component
monitoring subsystem diagnosis, 49
supervision diagnosis components
configuring TCPIP parameters, 43
T
TCPIP parameters
configuring for supervision diagnosis, 43
G
genies
control module name, 16
properties, 16
using genies, 16
I
I/O device component
monitoring subsystem diagnosis, 61
information tab
faceplate tabs, 17
initializing components
monitoring subsystem diagnosis, 45
EIO0000001528 08/2019
67
Index
68
EIO0000001528 08/2019

* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project