Professional Documents
Culture Documents
Webhmi en Um A10
Webhmi en Um A10
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.
There may be websites linked to and from this site that are operated or created by organizations
outside of Schneider Electric. Those organizations are solely responsible for the operation and
information (including the right to display such information) found on their respective websites.
The linking to or from this site does not imply on the part of Schneider Electric any endorsement or
guarantee of any of the organizations or information (including the right to display such
information) found on their respective websites.
Schneider Electric does not assume and is not responsible for any liability whatsoever for the
linking of any of these linked websites, the operation or content (including the right to display such
information) of any of the linked websites, nor for any of the information, interpretation, comments
or opinions expressed in any of the linked websites. Any comments or inquiries regarding the
linked websites are to be directed to the particular organization for whom the particular website is
being operated.
Contact information
Schneider Electric
+33 (0) 1 41 29 70 00
https://www.se.com
Safety Information
Important Information
Read these instructions carefully and look at the software to become familiar with it
before trying to install, operate, service or maintain it. The following special messages
may appear throughout this bulletin or on the equipment to warn of potential hazards or
to call attention to information that clarifies or simplifies a procedure.
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.
Failure to follow these instructions could result in death, serious injury or equipment
damage.
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.
Secure disposal refers to the process and result by which information, including
information held on the equipment, is irreparably destroyed so as to maintain the
security of the equipment and information during the process and up to the point of
irremediable destruction.
Any equipment containing batteries should have them removed before disposal,
taking precautions to avoid short circuits. Particular regulations within the country of
operation, may apply to the disposal of the equipment.
Announcement
EcoStruxure™ Power Automation System (EPAS)
In case of former brand names such as “EcoStruxure Substation Operation”, “ESO” or “PACiS”,
are lingered in this documentation, please consider them as linked to "EcoStruxure™ Power
Automation System".
Communication Gateway
The communication gateway offer has been rebranded to “EcoStruxure™ Power Automation
System Gateway” (EPAS-Gateway). In case any of former brand names are inadvertently
lingered in, please consider them as linked to “EcoStruxure™ Power Automation System” and/or
“EcoStruxure™ Power Automation System Gateway”.
SAFETY & HANDLING (SA)
SAFETY & HANDLING WEBHMI/EN SA
WEBHMI Documentation Page 1/3
Contents
1. Health and Safety .........................................................................................................................2
2. Installing, Commissioning and Servicing ..................................................................................2
3. Decommissioning and Disposal .................................................................................................2
4. Copyrights & Trademarks ...........................................................................................................2
4.1 Copyrights ......................................................................................................................................................................... 2
4.2 Trademarks........................................................................................................................................................................ 2
5. Warnings regarding use of Schneider Electric Products ..........................................................3
SAFETY & HANDLING WEBHMI/EN SA
WEBHMI Documentation Page 2/3
The equipment should be disposed of in a safe manner and with a secure disposal of confidential embedded
information.
Secure disposal refers to the process and result by which information, including information held on the
equipment, is irreparably destroyed so as to maintain the security of the equipment and information during the
process and up to the point of irremediable destruction.
Any equipment containing batteries should have them removed before disposal, taking precautions to avoid
short circuits. Particular regulations within the country of operation, may apply to the disposal of the equipment.
Under the copyright laws, this publication may not be reproduced or transmitted in any form, electronic or mechanical,
including photocopying, recording, storing in an information retrieval system, or translating, in whole or in part, without the
prior written consent of Schneider Electric.
4.2 Trademarks
EcoStruxure Power Automation System (EPAS), HMI-STUDIO, PROFILE-STUDIO and WebHMI are trademarks of
Schneider Electric. Product and company names mentioned herein are trademarks or trade names of their respective
companies.
SAFETY & HANDLING WEBHMI/EN SA
WEBHMI Documentation Page 3/3
In any application, including the above reliability of operation of the software products can be impaired by adverse factors,
including -but not limited- to fluctuations in electrical power supply, computer hardware malfunctions, computer operating
system, software fitness, fitness of compilers and development software used to develop an application, installation errors,
software and hardware compatibility problems, malfunctions or failures of electronic monitoring or control devices, transient
failures of electronic systems (hardware and/or software), unanticipated uses or misuses, or errors from the user or
applications designer (adverse factors such as these are collectively termed "System failures").
Any application where a system failure would create a risk of harm to property or persons (including the risk of bodily
injuries and death) should not be reliant solely upon one form of electronic system due to the risk of system failure to avoid
damage, injury or death, the user or application designer must take reasonable steps to protect against system failure,
including -but not limited- to back-up or shut-down mechanisms, not because end-user system is customized and differs
from Schneider Electric testing platforms but also a user or application designer may use SCHNEIDER ELECTRIC products
in combination with other products.
These actions cannot be evaluated or contemplated by Schneider Electric; Thus, the user or application designer is
ultimately responsible for verifying and validating the suitability of Schneider Electric products whenever they are
incorporated in a system or application, even without limitation of the appropriate design, process and safety levels of such
system or application.
INTRODUCTION (IT)
INTRODUCTION WebHMI / EN IT
WebHMI Documentation Page 1/4
Contents
1. Introduction ................................................................................................................................3
2. WebHMI User Manual ................................................................................................................3
2.1 Chapters description ....................................................................................................................................................... 3
3. WebHMI Help ..............................................................................................................................4
INTRODUCTION WebHMI / EN IT
WebHMI Documentation Page 2/4
> Reach US Team > Reach France Team > Select your country or region
INTRODUCTION WebHMI / EN IT
WebHMI Documentation Page 3/4
1. Introduction
The WebHMI will continue to be improved. The general features of WebHMI will also be enhanced, as we are able to adopt
new technology solutions.
For up-to-date information on WebHMI, visit our website: www.se.com
Note: The User manual focuses only on the Desktop style version for the users and not for the Tablet style version.
INTRODUCTION WebHMI / EN IT
WebHMI Documentation Page 4/4
3. WebHMI Help
Once WebHMI installed, go to C:/MCIS/WebHMI/ressources/documentation to find WebHMI help or from WebHMI interface go
to the menu on the top-right corner and select Help:
TECHNICAL DATA (TD)
TECHNICAL DATA WEBHMI/EN TD
WEBHMI Documentation Page 1/8
Contents
1. Introduction ............................................................................................................................ 2
2. Requirements ......................................................................................................................... 2
2.1 Hardware .................................................................................................................................................................... 2
2.2 Operating systems ...................................................................................................................................................... 2
2.3 EcoSUI version ........................................................................................................................................................... 2
2.4 Minimal Web browser version ..................................................................................................................................... 2
3. Capabilities............................................................................................................................. 3
3.1 General Architecture ................................................................................................................................................... 3
3.2 Cybersecurity .............................................................................................................................................................. 3
3.3 HMI ............................................................................................................................................................................. 4
3.4 Configurations............................................................................................................................................................. 4
3.5 Time synchronization .................................................................................................................................................. 4
3.6 Events ......................................................................................................................................................................... 5
3.7 Disturbances ............................................................................................................................................................... 5
3.8 Trends ........................................................................................................................................................................ 5
3.9 Reports ....................................................................................................................................................................... 6
3.10 Notifications ................................................................................................................................................................ 6
3.11 Dashboards ................................................................................................................................................................ 7
3.12 Embedded modules .................................................................................................................................................... 9
TECHNICAL DATA WEBHMI/EN TD
WEBHMI Documentation Page 2/8
1. Introduction
The present document is a WebHMI chapter of the documentation binders. It describes the Technical Data of WebHMI
application.
2. Requirements
2.1 Hardware
64bits
3. Capabilities
The cardinality limits of the different components of a WEBHMI are described in the chapter Maintenance of this user
manual.
WebHMI server is able to communicate with a peer of redundant Central DB and several SBUS servers. Clustering
architecture is not available for archives. Means users can not declare several redundant CentralDB or single CentralDB.
Limitations
Limitations known are the following:
• No automatic completion from CentralDB
In case of one CentralDB contains one substation and the other CentralDB, another substation, there is no
consolidation. It is impossible to see a complete treeviewer or to request on each CentralDB for specific data.
• Origin of values
Currently, all viewers cannot display origin of their values. Means in case of clustering, user is not able to define which
SBUS or CentralDB return values.
• Real time/archive values not displayable on non-common rings
In case of classic redundancy, FIFO access is working on CentralDB and SBUS servers. However, due to no
CentralDB completion, if one SBUS server/central DB has more than a ring, data comes randomly.
• Alert by SMS/mail
In case of EcoSUI secured with WebHMI, the alert by SMS/mail feature is not accessible.
NOTE: WebHMI server can be installed on a separate computer without any EcoSUI element on it.
3.2 Cybersecurity
WebHMI uses its own RBAC table. It allows users to create new role and users directly throw the interface. All data are
stored encrypted in linked CentralDB in order to inherit redundancy and robustness of CentralDBs. Roles are limited to
following tables:
Privilege Description
PRINT Allow printing
EXPORT Allow xls,csv extraction
CLEAR_ALARM Clear alarm
ACK_ALARM Acknowledge alarm
CMD_SELECT Allow to select device
CMD_EXECUTE Allow to execute command
CMD_CANCEL Allow to cancel command
SBO_SELECT Allow to select device
SBO_EXECUTE Allow to execute command
SBO_CANCEL Allow to cancel command
STOP_BUZZER Stop buzzer
EDIT_MEMO Not implemented yet
CONFIG Not implemented yet
END Not implemented yet
SHOW Allow user to navigate
This role table evolves in accordance with cybersecurity agreements. However, WebHMI does not deliver an installer with
CAE interface.
WebHMI uses computer web browser as human machine. For hardening recommendations, refer to EcoSUI HMI or Hybrid
EcoSUI HMI.
TECHNICAL DATA WEBHMI/EN TD
WEBHMI Documentation Page 4/8
3.3 HMI
As an extension of EcoSUI, WebHMI delivers similar functionalities as EcoSUI HMI. To know: states, alarms, events,
trends, SLD and system viewers. Its specific functions are disturbances viewer, reports servers, notifications and
dashboards, as well as the integration of web pages accessible from the network.
Views are supplied on WebHMI servers and built according to HTML5 and SVG technologies.
This table shows current HMI performance capabilities:
WebHMI HMI
Maximum number of HMI Clients 12
Time to initialize database Up to 1 min (depending on datapoints volume)
Maximum time to display an alarm 2s
Maximum time to display a SLD or System 2 s for normal view
6 s for view with 2000 data points
Maximum time to refresh information Up to 3 s (depends on network bandwidth)
Maximum time to send control Close to 0 s
Maximum time to get control feedback 1s
NOTE: Values are based on architecture including proxy, gateway, and firewall between HMI computer and WebHMI
server.
Limitations
These are limitations to be considered:
• Not editable control and detail views (built in function).
• Memo function not available.
• No svg live editor available.
• VCR mode not available.
• Formula evaluation engine for views not implemented yet.
3.4 Configurations
Configuration of views for SLD and SYSTEM are done by HMI Studio. Integrated to the newest EcoStruxure Substation
Automation Operation solution, configuration requires our newest top-down approach configuration tools: EPAS-E, Profile
Studio and HMI Studio.
Users shall use IEC 61850 scd files to start its own configuration.
Limitations
Datapoints limitation is defined by EcoSUI server limitation:
WebHMI time synchronization can be done by an external clock and depends on EcoSUI environment. For HMI, displayed
time can be set to refer to server time or client time. All request are based on UTC statements to avoid misuse. But
response are corrected with reference time for display.
TECHNICAL DATA WEBHMI/EN TD
WEBHMI Documentation Page 5/8
3.6 Events
Limitation
Events module retrieves a maximum of 5000 EcoSUI events.
3.7 Disturbances
Disturbances viewer monitors EcoSUI perturbances folder and build its own files for web display. It means current windows
users shall have reading rights on perturbances folders and full control on WebHMI perturbances folder.
45
40
35
30
IO / MV
25
20
15
10
5
0
0 5 10 15 20 25
Seconds
Archiving
Data generated by WebHMI Disturbances module is stored in C:\MCIS\WebHMI\notifications\archiving
Limitations
Limitation of viewer is done by DAT file of COMTRADE. If protective device delivers its disturbance file in binary format,
disturbances viewer will not be able to manipulate it.
Delay in disturbances displaying depends on volume of I/O and measures records in perturbance file.
3.8 Trends
Trends viewer has no limitation on volume of signal which can be added on a view. And same for the type of signal (digital
input, output and measures). Display time is based on following rules: 10 000 values shall be displayed in less than 10 s.
Parameters are available to affine packet sizes for trends (by default 88) and limits before draw (by default 10000).
TECHNICAL DATA WEBHMI/EN TD
WEBHMI Documentation Page 6/8
3.9 Reports
Report functionality is able to produce reports in Excel and pdf format. Excel files cannot support graph on opposite of pdf
files. Only archived values are available in reports. Automatic task can be set to generate periodically reports. Periods
available are the followings:
• Every 1, 2, 4, 6, 8, 12 hours.
• Each day, week, month, quarter and year.
Report server has no edition capability to build report template. Templates can be supplied by Schneider Electric on
demand.
Archiving
Data generated by WebHMI Reports module is stored in C:\MCIS\WebHMI\disturbance
3.10 Notifications
WebHMI users can create notifications based on conditions and, enable/disable sending them via SMS and/or e-mail.
Use Notifications module to create triggers, generate notifications and view them. Set conditions for when a notification is
triggered and decide whether to receive e-mail and/or SMS notifications. A History view displays issued notifications with
notification content (.zip file), status, name of the trigger and creation date.
By default, Notifications module is enabled. To enable/disable Notifications module, go to the WebHMI server manager
which is the management tool of WebHMI application. Learn how in Settings chapter of the WebHMI technical guide.
Archiving
Notifications are stored in C:\MCIS\WebHMI\notifications\archiving
Limitations
Notification’s module is not available for EcoSUI Secured.
For notifications by e-mail:
SMTP server is mandatory, the user needs to create an account on the SMTP server.
3.11 Dashboards
Dashboard module is a powerful tool for data visualization and big data analytics.
Dashboard module according to dataflow provides up to 2 or 3 years of historical data and on-demand events records,
mainly for Key Performance Indicators (KPIs).
Dashboard pages layout contains visualizations such as a graph, chart, plot, table, map, or others visual representation of
data. This pages and visualizations are customizable based on customer and project needs.
The information in Dashboard pages is updated each day at midnight in the time zone.
Events can be updated on demand using Refresh Events tool. Refresh Events retrieves events archived from the EcoSUI
databases at the time of the demand which means that It won’t retrieve events in progress at the moment of the demand.
Dashboard module can be enabled or disabled from the WebHMI server manager which is the management tool of
WebHMI application. Learn how in Settings chapter of the WebHMI technical guide.
Archiving
KPI Monitor according to dataflow enables up to 2 or 3 years of historical data.
If main and backup database are configured, archiving cycle try to connect the main first. If the main is not responding, the
backup DB is tried.
In the event that none of the DBs (main and backup) is available during the data collection cycle, the missing data if any, will
be collected on the next cycle when the DBs are available again.
Only the following MySQL tables of EcoSUI DBs are extracted for data treatment:
• Values_x (x=(0 to 99)
• Events
• Object_state
• Object
TECHNICAL DATA WEBHMI/EN TD
WEBHMI Documentation Page 8/8
Find in the table below useful information to know where the information is stored:
Information Location
Archiving cycle generates .qvd raw data files stored in this location.
References C:\MCIS\Qlik\02_ASSET_MONITOR\7_IMPORT\QVD
References files are stored at setup.
TECHNICAL DATA WEBHMI/EN TD
WEBHMI Documentation Page 9/8
WebHMI can interface with HMI applications other than EcoSUI. Use Embedded modules module to include other HMI
applications e.g., Power SCADA Expert (PSE), EcoStruxure Building Operation (EBO):
FUNCTIONAL DESCRIPTION (FT)
FUNCTIONAL DESCRIPTION
WEBHMI Documentation Page 1/5
Contents
1. Scope of the document ......................................................................................................... 2
2. WebHMI architecture ............................................................................................................. 2
2.1 General description..................................................................................................................................................... 2
2.2 Functional specification .............................................................................................................................................. 2
2.3 External interface ........................................................................................................................................................ 3
2.4 Human interface ......................................................................................................................................................... 4
FUNCTIONAL DESCRIPTION
WEBHMI Documentation Page 2/5
2. WebHMI architecture
2.1 General description
WebHMI is an optional module for EcoSUI application. WebHMI adds web supervision and control capability through web
browser:
• WebHMI aims to bring EcoSUI HMI on web environment. To achieve this, WebHMI provides following functionalities:
• Monitor in real time state viewers
• Monitor in real time with graphic representation for single line diagram and system network
• Telecontrol primary devices
• Access and display archive
• Build curves from archived signals
• Display events on live mode
• Display curves on live mode
• Connection with cybersecurity brick for RBAC
• Request users from EcoSUI on former version
• Manage alarms
• Print and extract
• Interpret HMI Studio SVG files
FUNCTIONAL DESCRIPTION
WEBHMI Documentation Page 3/5
WebHMI Users
Role Based Access Control depends on the installed EcoSUI application:
• In case of an EcoSUI Standard, WebHMI requires users records in EcoSUI specific files. Learn more in chapter
Settings of this manual.
• In case of an EcoSUI Secured, WebHMI requires Schneider Electric cybersecurity module which implements
Cybersecurity Admin Expert tool (CAE) to manage users (login/password/roles) and the roles/actions linked to each
user.
Depending on validity of EcoSUI license, WebHMI will allow access or run in shareware mode (5 minutes demo) or deny
authorization to access WebHMI. Both first cases will prompt login popup.
After a successful login, WebHMI will complete its startup. Otherwise, WebHMI will ask again for a valid login/password.
A unique reference determines the coherent set of software/hardware that WebHMI can be use.
WebHMI
EcoSUI
Web services
CentralDB
Node.js
User interface
SBUS server HTTPS Chrome
Security controller
CAE RBAC Profiles SSL/TLS crypt
HMI Single line diagram
SVG
Studio System network
Main software interfaces are canals between WebHMI and EcoSUI. Webserver embedded behind WebHMI maintains
canals which are linked to SBUS server, Central DB and cybersecurity module (profiles). Through these three pipes, there
is different kind of data:
HMI Studio interface provides SLD and system view. As there is no direct connection between HMI Studio and WebHMI, is
through SVG files that both software applications interact.
Last but not least is web browser with WebHMI server. It is under a secured pipe encrypted with technology SSL/TLS for
the user to be to monitor and control substation. Communications are based on json object exchange (REST technology) or
xml object exchange (SOAP technology) depending on needs.
FUNCTIONAL DESCRIPTION
WEBHMI Documentation Page 4/5
To access WebHMI, users shall use laptop, personal computer, tablet or other device with compatible web browser and connected to a network with access to WebHMI server. To
learn more about compatible web browser , refer to the Technical Data chapter of WebHMI guide).
HMI, LOCAL CONTROL,
USER INTERFACE (HI)
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 1/103
Contents
1. Scope of the document .................................................................................................... 3
General overview .................................................................................................................................. 3
Function’s overview .............................................................................................................................. 4
2. Workspace layout ............................................................................................................. 4
Header .................................................................................................................................................. 5
Navigation bar ....................................................................................................................................... 5
Toolbox ................................................................................................................................................. 5
General Functions ................................................................................................................................ 7
3. Access authorization ....................................................................................................... 9
Default Users ........................................................................................................................................ 9
WebHMI Login/Logout ........................................................................................................................ 10
4. Navigation functions ...................................................................................................... 14
Navigation bar functions ..................................................................................................................... 14
5. States .............................................................................................................................. 15
States display...................................................................................................................................... 15
Measurements Value Display “States” module .................................................................................. 16
States tree filter ................................................................................................................................... 19
States keyword filter ........................................................................................................................... 19
States category filter ........................................................................................................................... 20
Signals count ...................................................................................................................................... 21
States print .......................................................................................................................................... 21
States Export ...................................................................................................................................... 22
6. Events ............................................................................................................................. 23
Events archive display ........................................................................................................................ 23
Event log tree display ......................................................................................................................... 24
Event log archive sorting .................................................................................................................... 24
Event log archive manual time window selection ............................................................................... 25
Event log archive preset time window selection ................................................................................. 26
Event log archive printing ................................................................................................................... 26
Event log archive export ..................................................................................................................... 27
Events live display .............................................................................................................................. 27
Events live print................................................................................................................................... 28
Events live export ............................................................................................................................... 28
7. Alarms management ...................................................................................................... 29
Alarm states definition ........................................................................................................................ 29
Parameters associated with an alarm ................................................................................................ 29
Alarm processing ................................................................................................................................ 30
Acknowledgement .............................................................................................................................. 30
Clearing ............................................................................................................................................... 30
Audible alarms .................................................................................................................................... 31
8. Alarms functions ............................................................................................................ 32
Alarms tab ........................................................................................................................................... 32
Alarms tree filter .................................................................................................................................. 32
Alarm User Interface ........................................................................................................................... 33
Alarms Page Print ............................................................................................................................... 35
Alarms Page Export ............................................................................................................................ 35
Stop Speaker function ........................................................................................................................ 35
Toggle mute function .......................................................................................................................... 36
Alarms counts ..................................................................................................................................... 36
9. Trends ............................................................................................................................. 37
Curves library ...................................................................................................................................... 38
Signals list ........................................................................................................................................... 38
Trends toolbox treeviewer .................................................................................................................. 39
Search keywords ................................................................................................................................ 39
Create curve ....................................................................................................................................... 40
Change display period and sample .................................................................................................... 41
Measurements value display “Trends” module ................................................................................... 42
10. System Architecture....................................................................................................... 43
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 2/103
Illustrations and views in this document are given as an example. They can be modified on a per customer basis.
Some functions described below are dependant of the project configuration and their behavior can be modified, or the function
can be unavailable.
General overview
WebHMI allows the operator to supervise, control and maintain the
substations in a very quick and intuitive manner. It can be
implemented in HV and MV substations and for power plants as a
local or remote workstation. It can also be used as a Web HMI for
satellite substations.
• Web Server
o Entry point for web clients
o Gets live values from SBUS server
o Gets archived data from central data
• Central DB:
o Gets the configuration (the configuration is stored locally on each computer. When EcoSUI starts, it first checks
if a new configuration is available and downloads it if necessary)
o Gets the alarm list, events and measurements
No installation is required for WebHMI. Entire html HMI is embedded in web server. Client uses web browser to access
monitoring and control interface.
WebHMI provides the user with an interface for all operational and engineering functions. In case of connection to multiple
servers, information will be displayed as if it is coming from a single server. Connectivity between web Clients and web Servers
is provided via Internet and/or local network.
WebHMI is a HTML5 web application. The WebHMI hardware platform differs from project to project depending on the
environmental operating conditions and customer requirements. The control is done by mouse, trackball or track point
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 4/103
Function’s overview
WebHMI allows supervising and controlling a substation. Here are the main basic functions:
• Control
o Alarms acknowledgement and clearing
o Control of electrical devices (circuit breaker, switch, …)
o Locking of electrical devices
o Control of transformers
o Control of secondary devices
o Control of internal automation
• Supervision
o Access authorization
o Topological view of single line diagram
o Graphic representation of switching devices
o Graphic representation of analog values
o Graphic representation of additional process information
o Display of automations state
o Display and modification of counters
o Display of alarms in list form
o Display of events
o Display of states
o Display of archives
o Viewing of curves for archived or real-time analog and digital data
o Forcing, substitution, suppression of datapoints
o Hypertext online help
o Reports creation
o Hardcopy
o Dashboard with KPIs, data visualization and big data analytics
2. Workspace layout
The graphical area is split into different frames:
Header
Navigation bar
Navigation bar allows the user to move between opened tabs. Workspace has the capability to embed new navigation bar (cf:
drag and drop chapter). Toolbox is available only on main navigation bar.
Toolbox
Toolbox is a hide/unhide window which proposes tools depending on active window. It covers following functions:
Filter By signal X X X
By date X X
By period X X
By tree viewer X X X X
By keyword X X
Search By keyword X
By tree viewer X
Control Mode X X
Live/Archive
Alarms controls X
Counters X X X X
Library Curves X
Figure 7 : Available functions on toolbox for each tabs
Save filters
WebHMI includes a Save filters feature. Selections on Toolbox tree viewer like Signal types, Curves and Period are stored
and reusable by the user or others if the filter is shared with public.
Filters configuration
Select Curves
Select Period
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 7/103
In Toolbox, click the Filters configuration icon to open the Filters collapsible menu. Filters menu tab will now be visible on
Toolbox pane. Click the small arrow to expand the Filters menu:
Delete filter
General Functions
WebHMI icon
The Schneider Electric logo is displayed on the top left hand corner of the screen:
Product name
Generic controls
These icons are active for all potential active tab. Function behind them should adapt their reaction in function of the active
tab.
Customer logo
Customer logo is embedded in Medium. If no customer logo is defined, partnership icon is the default logo:
Information box
It displays current computer IP address, on which webserver Eco SUI is connected and the current date and time (local time,
local time with GMT modifier, GMT time with GMT modifier). Date and time are available in different format. It shall
automatically take current computer format.
Alarm banner
The last alarm window is always present on the WebHMI, whatever the view displayed, or the function called.
User controls
It allows the customer to logout, view the Actions in the Profile, change the language, change the Desktop style to Tablet
style, view the User rights in the Users and Profiles, check the DB status and to select the Help from the menu to view the
User manual.
Username and its profile are displayed in top-right corner. When no user is logged, by default username is: Public with Visitor
profile.
3. Access authorization
The operator logs into the system through an identification popup. The WebHMI behavior will then depend on the operator
rights.
Default Users
For EcoSUI Standard users are managed by WebHMI. Learn how in User management section.
For EcoSUI Secured users are managed by the CAE application (Cybersecurity Admin Expert). Learn how in CAE user
manual.
NOTE: For security reasons, passwords need to be changed after first login.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 10/103
WebHMI Login/Logout
Once WebHMI is started, two behaviors are allowed:
• the login is mandatory: using the Login / Logout button of the tool banner, the operator must enter its username and the
associated password
• pre-defined user as known as “Public”, which has only view rights, could be logged: this allows an operator to view the
current substation state.
The operator needs to log out and then log in with a new username, using the Login / Logout button of the tool banner.
The choice of the login type procedure is defined during the WebHMI installation procedure. When the following login window
is displayed, no other action is allowed:
View X X X
Control on SLD/System X X
Acknowledge X X
When login procedure is successful, loading screen appears again to load project data in web browser. At first time, this action
could be quite longer than usual due to the project size. This long time could reappear if history of your browser is cleaned.
If database changes on EcoSUI, WebHMI executes again the 3 phases as for a first launch.
It is similar if user deletes web browser history.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 11/103
User management
NOTE: User management feature is not available for EcoSUI versions in which users’ access is controlled by Cybersecurity
Admin Expert (CAE).
To use User Management feature, select Users from the menu on the right-top of the title banner.
User panel
NOTE: Only the users with profile with CONFIG right, can create and modify profiles and users.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 12/103
Profiles
2 Select on panel Rights the operation to affect to the profile. To select several operations, press and hold the “Ctrl”
button and select the item with mouse left click.
3 Set the name of the profile on “Profile information” textbox.
4 Click on “Confirm” button to create the new profile.
Users
To add, modify or remove a user account, follow the steps as described in the tables below.
E-mail address and phone number provided are useful information for the user to receive notifications. Learn more in section
Notifications.
4. Navigation functions
Navigation bar allows the access to Add tab menu. Typically, Add tab menu contains:
• States
• Alarms
• Events
• Trends
• Single Line Diagram
• System architecture
• Reports
• Disturbances
• Notifications
• Dashboard
One or more tabs can be opened on the Navigation bar. This is the dynamic for active or inactive tab:
Open tab
This action displays menu with available modules. Select one of them and tab is automatically added to the navigation bar.
On this example, we add the Single Line Diagram tab:
Close tab
5. States
The State viewer presents the data points by name (a data point will appear only once, with its current state and time
stamping).
It has to be used to get a picture of the current situation of the data point. Data point state can be issued either from wired
signals, data from IED as well as system self-monitoring information.
The types of signals that can be displayed are:
States display
Live states are transferred from SBUS Server to Web HMI by Web server. It displays all data points, their origin, their value,
their quality and the date/time of their last update. States tab appears as follows:
• Sync: Quick control if timestamp is not synchronized. “*” means timestamp is not synchronized by GPS clock
• Origin: Access path of the datapoint (NOTE that the default format is Substation Name / Voltage Level / Bay Name. The
datapoint is defined at the bay level)
• Description of the datapoint information
• Value: State message of the datapoint, datapoint can be in measure, control, position and so on.
• Quality of the signal
• Last update: date of the last state change (NOTE that the default date format is yy/mm/dd hh:mm:ss:mmm)
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 16/103
Note: Refer to section 11.1 for the “System” and “Trends” module’s Measurements Value Display. Also refer the section 2.2.2
Expert chapter SETTINGS of the user manual for Measurement module configuration and the parameter settings.
In the Measurements module, with setting the parameter Value Display mode, the measurements value can be displayed
by either:
• “?” as value for bad quality
• Current measure value for the good quality
Figure 24 : Expert Menu Measurements module configuration to set the Value Display mode
Figure 25 : "States" module Value Display Configuration table according to the Qualities
Figure 26 : Image represents the “?” value display of the datapoint according to the quality in the "States" module
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 18/103
Figure 27 : Image represents the “Current measure value” (real value) display of the datapoint according to the quality in the
"States" module
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 19/103
Electric signals
System signals
Measurements
Strings
User controls
All
Signals count
Counter which represent number of displayed signals on states viewer.
States print
Printing the States page is possible by clicking the Print button.
User can print current page or all states.
Print can be done depending on printer installed on current computer.
NOTE: PDF printer shall be installed to create pdf file.
States Export
Exporting States of the current page is possible by clicking Export button.
6. Events
Event log is split into 2 different features:
• Live: Displays the last 100 events. On opposite of archive, there is no toolbox for live events.
• Archive: Displays user request on Central DB.
• Sort by date
• Sort by origin
• Sort by description
• Sort by message
• Sort by command origin
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 25/103
Request and period buttons are triggers for archive extraction. Without action on them, no data will appear.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 26/103
• Last 5 minutes
• Last Hour
• Last Day
• Last Week
• Last Month
• All CSV: to export the filtered events (already loaded in the data grid or not) to a .csv file.
• All XLS: to export the filtered events (already loaded in the data grid or not) to a .xls file.
7. Alarms management
Alarm states definition
An alarm is generated by an event (e.g. a particular datapoint with a state defined during the configuration phase as «to be
alarmed “).
While this event is still present (e.g. the previous particular datapoint is still in the same state) the alarm is « active”.
When this event disappears (e.g. the previous particular datapoint is now in another non-alarmed state) the previous alarm is
« inactive “.
An existing alarm (active or inactive), can be acknowledged by an operator to signify that it has been taken into account. The
acknowledgement is global (written on the Central DB), i.e. once an alarm has been acknowledged, it is seen as
“acknowledge” by any alarm list on any WebHMI connected to the central DB.
An alarm can be associated with each state of each datapoint. A datapoint can have different alarms for different states, for
example, a Circuit Breaker position can generate an alarm level 1 for open status and an alarm level 2 for jammed status.
Only one alarm (the last one) associated with a data change state is displayed. The previous one (concerning the same data)
is replaced by the current one.
• Immediate or Differed: an « immediate “alarm is displayed as soon as it has been detected, a « differed “ alarm is
displayed only after a user-selectable time delay following its detection (the event associated with the alarm must
remain present during the delay; if not, the alarm will not be displayed); this delay ranges from 1 to 120 seconds and
can be set to particular value for each « differed “ alarm.
• Gravity level: this level is defined for each alarm allowing a hierarchical classification to deal with the urgency of the
events; the gravity level value can be: 0, 1, 2, 3, 4 or 5, 5 being the most serious and 0 meaning that there is no gravity
level.
• Audible or not when detected by the system, eventually with a reset after a user-selectable delay (range: 1 to 60
seconds)
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 30/103
Alarm processing
NOTE: « alarmed event disappears (AL-) “means that the associated data is now in another state which is not alarmed.
Acknowledgement
An operator can acknowledge an existing alarm from the WebHMI to signify that it has been taken into account. The
acknowledgement of alarms by an operator is recorded and shown on the alarm viewer, with the user name, date and time.
Only users with ‘alarm acknowledgment’ rights can acknowledge alarms.
Clearing of alarm requires the same operator access right as for acknowledge action. The operator can also acknowledge /
clear a group of alarms
Clearing
Whatever the clearing mode, the clearing of an alarm is immediately taken into account everywhere it is involved: deletion
from the alarm list, deletion from the last alarms window (if previously present), update of the new graphical state in all views
where it is displayed. Only users with ‘alarm acknowledgment’ rights can clear alarms.
Only the users with the acknowledgement of alarms rights can clear the alarms.
NOTE: All the alarms are treated the same way, they are either all configured in “automatic clearing” mode or all
configured in “operator request clearing” mode.
When the alarms are not configured as « to be cleared automatically “, they have to be cleared by an explicit operator action.
This action is only possible when it is in the « inactive acknowledged” state.
Otherwise, it remains present in the alarm list and in the different graphical views where it is displayed.
Clearing of alarm does not require any special operator access right different from « acknowledgement right “.
A global clearing procedure, which allows clearing all “inactive-acknowledged” alarms in a single operation, is accessible
through a dedicated button.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 31/103
Audible alarms
An audible property (PC Speaker) can be associated to the alarmed data appearance and is triggered simultaneously with
the alarm display on Web HMI.
When a new alarm is coming, all Web HMI (and dedicated external Speaker) will buzz. When audible alarm is acknowledged
on one Web HMI, all Web HMI (and dedicated external Speaker) will stop buzzing.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 32/103
8. Alarms functions
Alarms tab
Click on the “Alarms” button in command banner to Switch to Alarm Page.
Alarm selection
Click on an alarm to select it. To select several alarms, user press key <CTRL> + click on each alarm to select.
The selection is available for alarms that are Acknowledgeable/cleanable.
Click on selected alarm to deselect it. If several alarms are selected, user press key <CTRL> + click on the alarm to deselect.
To select a group of continuous alarm on the Alarm tab, user press key <MAJ> + click on the first alarm to select + click on
the last alarm to select.
To deselect one alarm from a group of selected alarms, user press key <CTRL> + click on the alarm to deselect.
To deselect current selection, user press keys <CTRL> + <MAJ> and click on one of selected alarm.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 34/103
The buttons and appear when one or more alarm is selected, instead of “Acknowledge all” and “Clear all”
buttons.
• Export All Alarms to a .CSV file, filtered alarms are exported to csv file
• Export Alarms of this page to a .CSV file, alarms showed on the current page are exported to csv file
• Export All Alarms to a .XLS file, filtered alarms are exported to xls file
• Export Alarms of this page to a .XLS file, alarms showed on the current page are exported to xls file
NOTE: The Stop Speaker function is common to all WebHMI based on the same database configuration. The audible alarm
stops on all WebHMI.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 36/103
NOTE: The Toggle Mute function affect only the Web HMI on which the user operates. It is not linked to a specific user
and is not visible outside the alarm page.
Alarms counts
Alarms counts indicate number of alarms active and number of alarms unacknowledged.
9. Trends
Curves tool allows the user to study trends of any signals supervised by the WebHMI. Curves tool can display up to 8 curves
on a single display. Two options are possible:
• Curves set by configuration, not user customizable. This type of curve appears in detailed views. Navigation buttons
allow direct access to curves
• Curves toolbox, giving the user the ability to create / modify its curves settings
By default, curves are modifiable (signals, period of time…) according to user privileges. The following information concerns
the user configurable curves option.
Curves library
Web HMI embeds several kinds of curve on its library. With drag and drop option, user can create a specific trends view with
one or more signals. By extension, it could gather different curve shapes and/or signal period.
All curves collection is described on WECOSUI_ COLLECTIONS_A0.doc.
Signals list
Signal list gathers all measurements available in database. By drag and drop, measurements shall be attached to a curve. It
displays some features:
• Pen: gives color legend for a signal
• Curve: records curve title where signal is displayed
• Origin, Measurements, Values, Units, Quality and Last update: last values recorded in events for each signals
• Trends: analytic results which provide global evolution of the signal for a selected period
Trends toolbox treeviewer affects directly signals list. It filters available signal in signal list to help user to find easily a specific
signal.
Search keywords
As treeviewer, search keyword improves productivity by given easy access to specific data. It filters signals list by origin and/or
measurements and/or units.
Create curve
Add signals
To add one or more signal, simply click a signal in the Signal List panel at the bottom of the view:
On each curve selected in signal list, pen list display a rectangle. By clicking on it curve property appears.
Figure 61 : Schedule input box (up) & Timeline navigation bar (down)
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 42/103
The first one will ask on a calendar two dates to delimiter period to extract in database. The other is a more genuine feature.
User can change plot positions on timeline navigation bar to redefined period.
In the WEBHMI, according to the quality of the datapoint the user needs to display the value of the measurements, in the
“Trends” module.
Note: Refer to the section 5.1.1 for the “States” and “Trends” module’s Measurements Value Display. Also refer the section
2.2.2 Expert chapter SETTINGS of the user manual for Measurement module configuration and the parameter settings.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 43/103
In the WEBHMI, according to the quality of the datapoint the user needs to display the value of the measurements, in the
“System” module.
Note: Refer to the section 11.1 for “SLD” and “System” module’s Measurements Value Display. Also refer the section 2.2.2
Expert chapter SETTINGS of the user manual for Measurement module configuration and the parameter settings.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 44/103
Objects are defined by their type, their position, and potentially a link to a file, a link to an IEC61850 data or whatever,
depending on the object type.
Datapoints status can be displayed on the WebHMI to represent dynamic objects, such as CB position, Analog values, devices
status, etc…
Mea
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 45/103
Note: Refer to sections 5.1.1 for the “States” and “Trends” module’s Measurements Value Display. Also refer the section
2.2.2 Expert chapter SETTINGS of the user manual for Measurement module configuration and the parameter settings.
Figure 65 : "SLD" module Value Display Configuration table according to the Qualities
Figure 66 : Image represents the “?” value display of the datapoint according to the quality in the "SLD" module
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 46/103
Figure 67 : Image represents the “Current measure value” (real value) display of the datapoint according to the quality in the
"SLD" module
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 47/103
12. Controls
According to the rights associated to the current user, any object (dynamic or static) accepts controls or not.
Generalities
Each object defined in WebHMI has an Action property and ActionProfile Property. ActionProfile lets or prevents some users
to perform actions by comparing user’s profile with ActionProfile.
WebHMI has Actions that let users send controls, delete/substitute datapoints. WebHMI exposes also some Actions that let
users Bypass Interlock/SynchCheck for some commands.
It’s possible to disable buttons with simple equations to prevent sending ‘useless’ controls (ie. Close command on already
closed device, Open command whereas it is forbidden by the interlock…). In these equations, we can use any datapoints like
interlock SPS, order running SPS, open/close device position, etc…
Control Feedback is given through a special dynamicText object. Non exhaustive list of feedbacks:
WebHMI sends the control to the SBUS Server and SBUS Server reports back the feedback status to WebHMI.
They are configured according to the project requirements to give the user the control of the substation. User rights allow the
user to control or not these devices.
Remark: In the equation that permits to enable/disable the button, the configuration engineer may have to put:
Remark: Like for Direct Execute, in the equation that permits to enable/disable the selection buttons, the configuration
engineer may have to put:
An additional signal can be put in the equation of execute and cancel buttons:
• Status of the selection (ie. Device is selected or not) to enable execute and cancel buttons only if the device is selected.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 49/103
SetPoint Action
13. Reports
Reports module is a tool for the generation of reports leveraging both, real-time events directly from EcoSUI SBUS (jsreport)
and historical information (Analytics) stored in QVD format provided by KPI Monitor environment (Qlik) thanks to KPI Monitor
add-on.
jsreport
Use jsreport to work with events archived in the EcoSUI database at the time of the report demand, meaning that events in
progress at the moment of the demand will not be included.
Analytics
Use Analytics to work with up to 2 years of historical data. KPI Monitor add-on updates this information each day at midnight
in the time zone by default.
NOTE: Only users with profile with CONFIG right have access to Reports module (learn more in User management).
WebHMI Reports module is delivered with report templates than can be customized by the user. Learn how to use and
customize report templates in this chapter.
By default, Reports module is enabled. To enable/disable Reports module, go to the WebHMI server manager which is the
management tool of WebHMI application. Learn how in Settings chapter of this WebHMI technical guide.
When enabled, Reports module can be opened from the Add tab option on the Navigation bar. When Reports module is
opened, this is the default desktop screen:
Then, data loaded into WebHMI is available in form of templates in Reports > Report mode Edition > Models Analytics.
These Analytics templates are called Stories in Report App of Qlik.
WebHMI server checks on KPI monitor every 30 seconds to retrieve updates. New stories or any other modification will be
updated in WebHMI Reports module> Report mode Edition > Models Analytics.
Use KPI monitor (Qlik) to create Sheets and Stories based on project needs:
Open Hub
(Qlik)
Templates
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 52/103
Report App is available in KPI monitor environment. The user can create, configure and customize Sheets and Stories
(Analytics templates) based on project needs.
A Sheet is where charts and tables for data visualization are placed. Sheets are the data source of Stories. Report App
can include several sheets.
To create, configure and customize sheets and stories/templates, go to KPI monitor environment (Qlik) by clicking on
Open Hub icon:
Open Hub
(Qlik)
Report App opens and displays the sheets already created. In the below example, report sheet is already created:
Creating a Sheet
To create a sheet
In WebHMI, open Reports module, then select Edition mode.
In Models tab click Open Hub icon to go to KPI monitor environment.
Report Sheets screen is displayed, click on Create new sheet button or window:
Enter a Title for the new sheet and a Description (optional), then click outside the grey area. A new sheet is created:
Now the user can start adding items for visualization and set their properties.
Charts
The user can use the following available charts for
visualization:
Custom objects
Available / The user can use the following available custom objects
Chart
Unavailable for visualization:
Bar chart
Available /
Custom object
Unavailable
Box plot
Extension menu
Combo chart
Qlik Dashboard bundle
Distribution plot
Qlik Visualization bundle
Filter pane
Bar & area chart
Gauge
Bullet chart
Histogram
Funnel chart
KPI
Heatmap chart
Line chart
Multi KPI
Map
Network chart
Pie chart
Radar chart
Pivot table
Sankey chart
Scatter plot
Word cloud chart
Table
Treemap
Waterfall chart
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 55/103
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 56/103
Taking a Snapshot
In the example below, KPI chart has been added in the sheet.
Click Done to leave Edit mode and right-click on the added chart/object.
KPI chart
Now, the user needs to take snapshots of the visualizations added in the sheet to later use them to build a story. These
snapshots are to be saved in the snapshot library.
Modifications made is sheet visualizations (charts, tables, objects, …) will impact related snapshots.
To take a snapshot
Select the sheet to work with, right-click the visualization to take a snapshot of, then select the camera icon to create a
snapshot:
Camera icon
To learn more about snapshots, refer to Qlik help documentation in these links:
https://help.qlik.com/en-us/sense/1.1/pdf/Data%20Storytelling.pdf
https://help.qlik.com/en-US/sense/February2020/Content/Sense_Helpsites/Home.htm
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 57/103
Build a Story
A story is built with the snapshots taken of sheet visualizations. The user can find the available snapshots in the snapshot
library.
To build a Story
Enter a Title for the new story and a Description (optional), then click outside the grey area. A new story is created:
Now the user can start adding snapshots of one or several sheet visualizations.
To start adding snapshots
Select the story to work with, choose snapshots from the snapshot library.
To learn more about building stories, refer to Qlik help documentation in these links:
https://help.qlik.com/en-us/sense/1.1/pdf/Data%20Storytelling.pdf
https://help.qlik.com/en-US/sense/February2020/Content/Sense_Helpsites/Home.htm
To publish a story
Only published stories will be available in WebHMI Reports module.
Select the story to publish, right-click on it and select Publish:
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 58/103
To modify a story
Only the user who created the story can modify it.
Select the story to modify, right-click on it and select Unpublish:
Once unpublished, click on the story to open it. Use the story tools panel to make changes. When finished, go to App
overview > Stories to publish the story:
Story tools panel
For WebHMI templates, only the following story tools are managed:
Snapshot library
Images
Shapes
Effects library
Sheet library
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 59/103
The user can change the sorting order of the data represented in the charts, tables and other kind of data visualization added
in a sheet.
To change the sorting of a visualization
In WebHMI, open Reports module, then select Edition mode.
In Models tab, click Open Hub icon to go to KPI monitor environment.
Report Sheets screen is displayed, click on the Sheet containing the visualization you want to change the sorting. In this
case, we click on report sheet:
In the Analysis view of the sheet, click on Edit and select the visualization (table, chart, object).
In the properties panel, click on Sorting. In this case, the headers of the selected table are displayed in the defined sorting
order. To change the sorting order, select an item from the list and drag up or down to rearrange the sorting order.
To customize the sorting criteria of each item, click on an item from the list and switch to Custom sorting:
To learn more about changing the sorting of a visualization, refer to Qlik help documentation
in this link:
https://help.qlik.com/en-
US/sense/February2020/Subsystems/Hub/Content/Sense_Hub/Visualizations/change-
sorting-of-visualization.htm
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 60/103
To select Reports mode, go to Reports > Reports mode tab, then select Display or Edition (Display mode is selected by
default):
This table shows the available tools in the toolbox according to the selected Reports mode:
Reports mode
Display mode Edition mode
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 61/103
Display mode Toolbox contains the following Task tools which are only active upon selection of report template:
Edit task Click Edit task to modify scheduling parameters only. Settings.json file is updated.
Click Delete task to remove a task. The task will be removed from the toolbox view and
Delete task as well as the associated system file.
Models tools
Models tools are only active upon selection of report template and with items selected in Signal list pane:
Signal types
Use Signal types tools to filter Signal list:
This table describes the Signal types tools of Edition mode toolbox:
Tool Description and features Tool Description and features Tool Description and features
Edition mode
In jsreport, five templates are provided by default by WebHMI. The user can’t modify or delete them. These templates provide
reports containing events archived in the EcoSUI database at the time of the report demand. These are the five templates
delivered by default with WebHMI:
• reportAlarms
• reportPeriodExcel
• reportEvents
• TemplateValuesMinMaxAvarageExcel
• TemplateValuesMinMaxAverage
In Analytics, templates are the Stories created in Report App of KPI monitor (Qlik). Therefore, if no story has been created
in Qlik, there won’t be any template in Analytics view.
To generate a report, in Edition mode, use Site Map and Signal Types to select the signals to be included in the report
template. If needed, use Filters to make easier the selection of signals.
NOTE: Selection of signals is limited to 100 items. Therefore, if more than 100 signals are selected, only the first 100 will be
included in the report.
jsreport Analytics
templates templates Signal list
Now, the user can directly generate and display an on-demand report which can be downloaded as a pdf file or, add a
new task and schedule it:
To generate a report, generate an on-demand report. Click on the Render Report icon and follow the instructions in
next topic Render Report.
To schedule a new task, schedule report generation. Click on the Add Task icon and follow the instructions in next
topic Add Task.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 63/103
In the example below, this is the information selected: Signal Types= All; Site Map= NDERA 110kV; Signal list > Selection=
All (all selected); Models= jsreport > reportAlarms (template):
4. The following window displays. Enter a Title for the report and a Period of time, then click Generate:
5. The report will be generated and displayed, and it can be downloaded in pdf file format.
NOTE: When using Chrome, if the report is not displaying, maybe it is because the web browser is blocking pop-ups. To
unblock pop-ups, follow the instructions here
https://support.google.com/chrome/answer/95472?co=GENIE.Platform%3DDesktop&hl=en
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 64/103
By scheduling a task, the user can archive useful reports containing value information for site monitoring, data collection and
analytics.
Use Add task to create and schedule a new task.
To add a new task
1. In Edition mode, use Site Map and Signal Types to select the signals to be included in the report template. If needed,
use Filters to make easier the selection of signals.
NOTE: Selection of signals is limited to 100 items. Therefore, if more than 100 signals are selected, only the first 100 will
be included in the report.
2. Then, in Models, select a report template from jsreport or Analytics view.
NOTE: Remember that in Analytics view, templates are the Stories created in Report App of KPI monitor (Qlik).
Therefore, if no story has been created for the selected signals, no report will be generated.
4. The following window displays. Enter a Title for the task, choose an interval of time to schedule the task and enable it,
then click OK:
5. The task has been added and is available from Display mode.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 65/103
Display mode
Use Display mode to display added/schedule tasks for jsreport and Analytics report generation.
Display mode lists generated reports for the schedule tasks. The user can:
1. Download and open directly an automatic report to collect data by pressing download button
2. Edit task to modify scheduling parameters only. To edit a task, select the task and click the Edit task icon . The
user can change the Title, the Execution and Enable/Disable the task.
3. Delete a task. To delete a task, select the task and click the Delete task icon , then click OK:
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 66/103
Storing Reports
WebHMI can store both on-demand generated reports and schedule generated reports.
Go to c:/MCIS/WebHmi/qlik/report
On-demand Reports
Schedule Reports
The user can find schedule reports in C:/MCIS/WebHmi/qlik/report/tasks, go to the related template folder, and then to the
corresponding task folder as shown below.
Template Folder
Tasks folder
14. Disturbances
The Disturbances viewer displays all COMTRADE files gathered by WebHMI servers.
In the toolbox, disturbances files are gathered according to the record dates detected in the cfg files.
Opening a disturbance file fills the tab as follows, where the workspace is divided into 4 areas:
• Toolbox
• Curves view
• COMTRADE details
• Noise / Angular / Phasor curves
Toolbox
The Toolbox displays all disturbance files loaded by WebHMI server. Files are split according to their month and year of
appearance. In addition, a filtering textbox allows the user to refine the disturbance file according to user’s criteria.
As an example, entering “P127” in the Filter box will only show disturbance files containing “P127” in the title.
Curves view
Loading a new disturbance files will automatically create a set of curves.
Analog values are gathered by units and a global digital input is created at the bottom part.
As an example, the screenshot below contains disturbances recorded by a MiCOM P127.
Three curves have been generated:
• one for current curves
• one for voltage curves
• and another one with digital inputs.
All curves can be manually resized by selecting the bottom part and using a drag and drop action to fit size.
COMTRADE details
COMTRADE standard proposes an ID card for a recorded disturbance. This area provides data coming from COMTRADE
cfg.
Noise/Radar/Phasor Areas
Clicking a curve activates noise, radar or phasor area.
• Noise curve represents datapoints for a period. This period is calculated form frequency given by COMTRADE cfg.
• On opposite, radar is based on time selection.
• Phasor establishes RMS, instantaneous peak and angle for each channel included in the selected curves.
15. Notifications
NOTE: Notifications feature is not available for EcoSUI Secured.
WebHMI users can create trigger notifications based on conditions and, enable/disable sending them via SMS and/or e-mail.
NOTE: Only users with profile with CONFIG right have access to Configuration menu in Notifications module (learn more
in User management).
Use Notifications module to create triggers, generate notifications and view them. Set conditions for when a notification is
triggered and decide whether to receive e-mail and/or SMS notifications. A History view displays issued notifications with
notification content (.zip file), status, name of the trigger and creation date.
By default, Notifications module is enabled. To enable/disable Notifications module, go to the WebHMI server manager
which is the management tool of WebHMI application. Learn how in Settings chapter of the WebHMI technical guide.
Notifications Toolbox
Notifications Toolbox contains the following tools:
NOTE: Duplicate Trigger and Delete Trigger are not enabled for On Disturbance File Occurrence and On Report File
Occurrence triggers.
Triggers Configuration
Three different types of triggers are available for configuration:
NOTE: Only users with profile with CONFIG right have access to Configuration menu in Notifications module (learn more
in User management).
On Disturbance File Occurrence to define if the occurrence of a system disturbance triggers automatic SMS
and/or e-mail notifications.
On Report File Occurrence to define whether a generated jsreport report triggers automatic SMS and/or e-
mail notifications.
On Analytics File Occurrence to define whether a generated Anaytics report triggers automatic SMS and/or e-
mail notifications.
On Data Change Detection to define which type of datapoints triggers automatic SMS and/or e-mail
notifications.
In Notifications tab, go to Notifications Mode > Configuration > Triggers and select trigger_disturbance.
To configure notifications On disturbance file occurrence, following actions are available:
1. In Status, select Enable or Disable. When Enable, users who provided e-mail and mobile phone number details will
receive a notification whenever a Disturbance file occurs (see Disturbances section).
2. In Communications, check E-mail, SMS or both to choose how to communicate with users who provided e-mail and
mobile phone number details
3. Add a Trigger description if necessary.
4. Click Save Tigger icon to save changes.
2. Communications 1. Status
In Notifications tab, go to Notifications Mode > Configuration > Triggers and select trigger_report.
To configure notifications On report file occurrence, following actions are available:
1. In Status, select Enable or Disable. When Enable, users who provided e-mail and mobile phone number details will
receive a notification whenever a Report file occurs (see Reports section).
2. In Communications, check E-mail, SMS or both to choose how to communicate with users who provided e-mail and
mobile phone number details.
3. Add a Trigger description if necessary.
4. Click Save Tigger icon to save changes.
2. Communications 1. Status
In Notifications tab, go to Notifications Mode > Configuration > Triggers and select trigger_analytic.
To configure notifications On analytics file occurrence, following actions are available:
1. In Status, select Enable or Disable. When Enable, users who provided e-mail and mobile phone number details will
receive a notification whenever a Schedule report is generated (see Reports section).
2. In Communications, check E-mail, SMS or both to choose how to communicate with users who provided e-mail and
mobile phone number details.
3. Add a Trigger description if necessary.
4. Click Save Tigger icon to save changes.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 74/103
8. Parameters with
2. Trigger name
selected datapoints and
4. Communications drop-down list
1. Add trigger 3. Status
History View
History menu displays issued notifications.
• Link. Click the link to download notification message (see example below).
• Status. This shows whether the notification has been successfully sent to the user or not.
• Trigger name. This is the name of the trigger.
• Creation date. This is the date when the notification was issued.
16. Dashboard
Dashboard module is a powerful tool for data visualization and big data analytics.
Use Dashboard module to view up to 2 years of high level historical data and on-demand events records, mainly for Key
Performance Indicators (KPIs).
The information in Dashboard pages is updated each day at midnight in the time zone.
Events can be updated on demand using Refresh Events tool. Refresh Events retrieves events archived in the EcoSUI
database at the time of the demand which means that it won’t retrieve events in progress at the moment of the demand.
Dashboard module can be enabled or disabled from the WebHMI server manager which is the management tool of WebHMI
application. Learn how in Settings chapter of the WebHMI technical guide.
When enabled, Dashboard module can be opened from the Add tab option on the Navigation bar.
Navigate between the different dashboard pages using the drop-down menu in the Dashboards Toolbox tree view:
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 77/103
Dashboards Toolbox
Dashboards Toolbox contains the following tools which are common for all the Dashboard pages:
Click Refresh Events to retrieve archived events from source (EcoSUI SBUS).
Click Delete On Demand Generation to delete generated App. It is only enabled when a
generated App is selected.
Delete ODAG
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 78/103
Additional Tools
This section describes additional tools available from almost every dashboard element or chart:
• View data to see chart source data in table format.
• Export as an image to create a jpeg or png file of a chart.
• Export to PDF to create a PDF of a chart.
• Export data to get an excel file of the chart source data.
• Selection tools in Charts and Filters to get detailed visualization of selected data.
• Search engine to find an item among dashboards.
View data
Select chart, right-click on it, then from menu select View data.
To return to the chart, right-click on the table, then from the menu select View chart.
Chart to
Table
Table to
Chart
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 79/103
Export as an image
Before using this tool, consider that large screens display more information than small screens and this difference impacts
what is exported in the file. This means that what you see on your screen is what you get on the jpeg or png file.
Select chart, right-click on it, then from menu select Export as an image:
In Image settings window use Current or Custom image size, choose Type of file, then click Export.
When the file is available, a link will appear. Click on it to download the file:
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 80/103
Export to PDF
Select chart, right-click on it, then from menu select Export to PDF:
Use PDF settings window to adjust Paper size, Resolution and Orientation. Then, choose Keep current size to get what
you see or Fit to page to get the entire chart in the PDF file, then click Export.
When the file is available, a link will appear. Click on it to download the file:
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 81/103
Export data
Select chart, right-click on it, then from menu select Export data:
Selection Tools
Selection Bar
For better analysis, the user can get a more detailed view by selecting one or several items directly in charts and tables or by
applying filters.
Selection/s and filters set by the user are displayed in the Selection Bar above the dashboard page and apply to all dashboard
pages.
In the following chart, data is visualized by month. A month has been selected directly on the chart (1), then voltage and bay
filters have been applied using available filters on the page (2). Finally, in the selection bar selected/filtered items date, bay
and voltage have been further defined by using selection tools:
Use Selection Bar to go through a selected item and modify the selection to get a more accurate view of the dashboard page
elements: charts, tables, KPIs, etc:
Step back in selection history in same dashboard page (e.g.: after clearing a selection, click step
back to re-set it).
Clear selections.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 84/103
By clicking on a chart, the user can choose one or several items or elements.
Selection options
This table describes the icons available for item selection in charts:
Choose one or several items on the chart, then click Confirm selection icon to validate
selection.
Turn on Lasso selection to select a group of items by surrounding them with the Lasso tool.
By clicking a filter, a list box is displayed. The user can choose either a single item or multiple items.
The following selection options are available in the filter list box:
Selection options
This table describes the icons available for item selection in filters:
Choose one or several items in the list box, then click Confirm selection icon to validate selection.
Selection menu. Every filter provides the following selection states (see table below):
Possible (white) items which can be selected. If one possible item is selected, all other possible items
become alternative.
Excluded (dark gray) Items which are no longer possible to be selected due to other active filters.
Alternative (light gray) Items which are still selectable even when other filters are active
Selection state color is also visible in the small bar at the bottom of the filter name:
To do so, click a selection (date in the below image) in the Selection bar, then click the lock icon. In this case, date selection
is then locked, and no changes can be made on the elements of the page (charts, tables, …) concerning the date.
Search Engine
Search in Filters
Use Search in listbox option to find a specific item when applying filters.
When typing a letter, search engine (which is not case sensitive) will find all the items in the list starting with that letter. When
typing a word, search engine will find all the items in the list containing that word.
Once the item is found, use the icons to validate, cancel or clear the search:
Smart Search
Use Smart Search to search for specific items in all the dashboard pages.
The picture below shows the results of searching for UTILITY TRANSFORMER. Smart Search looks for UTILITY and
TRANSFORMER. To link words into one search term, use quotation marks (e.g. “UTILITY TRANSFORMER”).
WebHMI Dashboard pages can be adapted to end user requirements or system specificities. This section uses Dashboard
pages as examples to learn users how to use Dashboard module features.
NOTE: This section is to be used for general specification purpose. Dashboard pages design will be defined on per customer
project basis.
The illustrations, architecture drawings and views in this section are not contractual and are given as examples. Also, some
functions described depend on final customer project configuration and their behavior can be modified or the functions can
be unavailable.
This is the list of the Dashboard pages available from KPI Dashboards:
• Report Events and Alarms
• Mapping Thresholds
• Trends MV
• Events and Alarms
• Energy
• Main Dashboard
• IEC 61850
• Report MV
• One Bay KPI View
• Heatmap Events
This table gives a short description to help the user identify dashboard features easily:
Report Events and Alarms This page monitors the number of events and alarms over time (year, month)
Mapping Thresholds This page monitors MV thresholds: minimum, maximum and average.
Trends MV This page monitors MV metrics over time (min, max average per hour).
Events and Alarms This page monitors events and alarms for more detailed analytics.
Main Dashboard This page monitors alarms and events overalls; MV metrics per unit (min, max avg); MV
metrics average per bay.
IEC 61850 This page monitors the datapoints per equipment that can generate events.
Report MV This page monitors minimum, maximum and average MV metrics by year and month.
One Bay KPI View This page monitors site energy performance mainly by bay (all information in a glance).
Heatmap Events This page monitors the overall number of events and alarms occurred per bay and per
month.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 90/103
Use Report Events and Alarms page to get the number of events and alarms within the last two years. It contains the
following elements:
1. Login KPI with the overall number of user logins and logouts tracked and counted. By default, user logins/logouts
events are merged with Events KPI. The user needs to click the Login button to visualize only Login KPI information.
2. Events KPI with the overall number of events. Click Events button to visualize KPI information.
3. Alarms KPI with the overall number of alarmed events. Click Alarms button to visualize KPI information.
4. Table chart with user logins/logouts, events and alarms sorted by year and month. Users can select substation,
voltage, bay, device and description item by clicking it on the table or using filters. KPI visualization will update based
on user’s selection.
Mapping Thresholds
Use Mapping Thresholds dashboard mainly to visualize measurement value thresholds: minimum, maximum and averages.
It contains a Table chart displaying measurements retrieved with minimum, maximum and average values which are colored
depending on defined thresholds (learn here how to define thresholds).
Users can select substation, voltage, analogs and bay by clicking on such item directly on the table or using the filters.
Define Thresholds
Thresholds have to be previously defined using the thresholds template (CSV file) located in:
C:\MCIS\Qlik\7_IMPORT\CSV\thresholds.csv
The CSV file content can be built by exporting thresholds already provided in the project configuration data base (SCE,
EcoSUI).
- object_uid32
- object_threshold_min
- object_threshold_max
- object_threshold_avg
1. Headers
To build the CSV thresholds file for Mapping Thresholds dashboard visualization, users can apply the following query in
MySQL query browser:
H=High L=Low
Then, to export the result of the query go to File > Export as resultset > Export as csv file
Trends MV
Use Trends MV to analyze measurement values (analog values) over time. It contains the following elements:
1. KPI with the different types of analog values (description filter in this page) counted up-to-date.
2. Line chart which shows measured analog values (unit filter) trends over time. Users can adjust selections (substation,
voltage, bay, device, description, unit) on this page to get a more detailed view of an analog value with min, max and
average values per hour.
3. Table chart with information organized in tree view. It shows the number of events par MV type in a bay. Users can
adjust selections (substation, voltage, bay, description) to update line chart.
This screenshot shows Trends MV dashboard monitoring MW (megawatts) (2) in bays K01, K02, K03, K04 and K05 (3) for
a range of time from 03/06/2019 to 07/06/2019 (1). The Table chart shows that unit MW (megawatts) have been counted 9
times for ACTIVE POWER and VP ACTIVE POWER (see KPI counter) in bays K01, K02, K03, K04, K05 and the number of
events per MV type (4). The Line chart represents trends for minimum, maximum and average MW per hour over the defined
range of time and bays.
1. Date/Range of time
KPI MW per hour (min, max, avg)
2. Unit
3. Bay
Use Events and Alarms dashboard to have detailed events and alarms analytics. It contains the following elements:
• Line chart is useful to view trends of the number of alarms and events per hour.
• KPI with Alarms and Events counter with up-to-date overall. By default, user logins/logouts events are merged with
Events KPI. The user needs to click the Login button to visualize only Login KPI information.
• Treemap which shows the voltage level where the alarms and events are affected.
• Donut charts. The first one from the left represents the proportional value of each voltage level where the alarms and
events are affected. The second one from the left represents the proportional value of each bay where the alarms and
events are affected. The third one from the left represents the proportional value of each of the different event types
occurred.
• Table chart with information organized in tree view. Data is sorted by substation, voltage, bay and device and the result
of the addition of alarms plus events is shown in subtotals and grand totals.
• Table chart with information organized in rows and columns and sorted by date and time, substation, voltage, bay and
event description and message.
This screenshot shows Events and Alarms dashboard filtered by AVR device selection:
Table chart
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 96/103
Energy
Energy page monitors last 24 hours measurements. It contains the following elements:
Main Dashboard
Main Dashboard monitors events and historical information of the current project:
1. Gauge meters
2. KPI
IEC 61850
Use IEC 61850 dashboard page to know the datapoints that can generate events. It contains the following elements:
• Bar chart is useful to compare the quantity of datapoints per equipment which can generate events. Users can make
selections by clicking the equipment name or on a bar. Table chart and KPI visualization will update based on user’s
selection.
• Table chart with information organized in rows and columns. Users can adjust selections by clicking on the table or
using filters. Bar chart and KPI visualization will update based on user’s selection.
• KPI with datapoints counter.
This screenshot shows IEC 61850 dashboard filtered by Voltage level selection:
Table chart
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 99/103
Report MV
Use Report MV dashboard to get the minimum, maximum and average metrics of MV sorted by year and month.
It contains a Table chart displaying maximum and average metrics per MV. Users can select substation, voltage, year, month,
bay, MV (unit) by clicking on such item directly on the table or using the filters.
This screenshot shows Report MV dashboard filtered by Unit (MW) and by Month (July) selections:
Filters
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 100/103
• KPI with Alarms and Events counter with up-to-date overall. KPI will update based on user’s selection (filters).
• KPI with minimum, maximum and average current. KPI will update based on user’s selection (filters).
• Filters to filter charts and table by voltage and/or bay.
• Box plot visualizes retrieved measurements. It will update based on user’s selection (filters). Select or deselect items
on the box plot to get a more detailed visualization.
• Line chart shows Voltage, Current or Frequency trends over time. Users can adjust selections on this page to get a
more detailed view.
• Bar chart is useful to compare the quantity of events per signal type. Users can make selections by clicking the signal
type name or on a bar. Dashboard page elements visualization will then update based on user’s selection.
• Column chart compares Alarms and Events. Column chart visualization will update based on the user’s selection,
Users can make selections by clicking on chart elements. Dashboard page elements visualization will then update
based on user’s selection.
• Table chart with information organized in rows and columns and sorted by date and time, substation, voltage, bay,
device, description and message. User can make selections by clicking directly on the table item or using filters.
Heatmap Events
Use Heatmap Events page to easily visualize the overall number of events and alarms occurred per bay and per month.
It is a colored-coded chart where events and alarms are replaced by colored tiles. A legend provides a scaled thin gradient
line of color description at the top of the chart which goes from the lightest color for the lowest values to the darkest color for
the highest values.
User can make selections by clicking directly on the chart elements or by using Table chart in tree view on the left side of the
page.
This screenshot shows Heatmap Events dashboard filtered by substation (UTILITIES), bay and Events (to exclude Alarms)
selections:
Selections Legend
Jan
Feb
Mars
Apr
May
Jun
Jul
Aug
Sept
Use On Demand App Generation for data analytics. For example, after locating the date of an anomaly, use ODAG to obtain
a filtered dashboard with an analysis view of that date.
To do so, select an accurate date rage (not too large), filter bay/s or substation/s (a minimum of two filters is required), then
click the Launch On-demand generation icon
Generated Apps
1. Generated Apps
To delete a Generated App, click the Delete On Demand Generation icon . In the pop-up window, users can select the
App to be deleted, then click Delete to proceed:
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 103/103
Requirements
The username and password credentials need to be the same in both applications ECOSUI and WebHMI:
• For EcoSUI Standard, set the same username and password for ECOSUI and WebHMI.
• For EcoSUI Secured, EcoSUI and WebHMI have already the same username and password.
Example
This is an example of an embedded view mimic in EcoSUI:
WebHMI.tpl
[Browser0]
Browser_Active=1
Browser_X=205
Browser_Y=19
Browser_Width=1000
Browser_Height=800
Browser_AutologinURL=http:\\127.0.0.1:92\autologin
Browser_AutologinPage=reports
The user can test the embedded views directly in Chrome. To test embedded views, first login into WebHMI, then use these
url. In the example below WebHMI address is http://127.0.0.1:90):
• http://127.0.0.1:90/sld/embedded
• http://127.0.0.1:90/reports/embedded
• http://127.0.0.1:90/trends/embedded
• http://127.0.0.1:90/events/embedded
• http://127.0.0.1:90 /states/embedded
• http://127.0.0.1:90 /system/embedded
APPLICATION (AP)
APPLICATION WEBHMI / EN AP
WEBHMI Documentation Page 1/7
Contents
1. Introduction ............................................................................................................................ 2
2. Create Single Line Diagram view .......................................................................................... 2
3. Create System Architecture view ......................................................................................... 5
3.1 Prepare Architecture on PolDoc ARC ......................................................................................................................... 5
3.2 Load architecture on HMI Studio ................................................................................................................................ 6
4. Generate WebHMI SLD and System views ........................................................................... 7
APPLICATION WEBHMI / EN AP
WEBHMI Documentation Page 2/7
1. Introduction
The present document is a WebHMI chapter of the documentation binders. It describes how to configure and generate SVG
files for SLD and system architecture views in HMI Studio.
Otherwise, user shall import data from CBS via “import from EPAS-E” function. This function is automatically done when
user has no .xhe file or chooses not to reopen former .xhe file. At the end of import, user can choose its IHMI or general
SLD on synthesis view:
On SLD view, user shall modify attributes to reduce spacing between bays and align primary devices.
PolDoc ARC is required to create system architecture view. User shall draw its architecture in PolDoc Arc by using
predefined shapes in gabarit.
Then, user shall set in each animated equipment its own network name. Select equipment in view and fill “Network Name”
field in custom properties.
At the end, each view required shall be save as svg file in order to allow HMI Studio to import these views. Press Files >
Save as and select “Scalable Vector Graphics (*.svg)” in file type before save.
APPLICATION WEBHMI / EN AP
WEBHMI Documentation Page 6/7
NOTE: HMI Studio uses network name attribute to create relation link with signal list. User can import in HMI Studio PolDoc
Arc svg without Network Name but no element will be animated. It is recommended for specification phasis. Before import
PolDoc Arc, user shall import its Profile Studio xpe.
Note: HMI Studio generate svg files based on xhe names. WebHMI required two specifics files:
• SLD.svg as main single line diagram view
• SYSTEM.svg as main system architecture view
INSTALLATION (IN)
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 1/29
Contents
1. Scope of the document ......................................................................................................... 2
1.1 WebHMI outline .......................................................................................................................................................... 2
1.2 Version & release ....................................................................................................................................................... 2
5. Install WebHMI on a different computer than the EcoSUI Secured computer ................... 8
5.1 Simple Architecture .................................................................................................................................................... 8
5.2 Redundancy Architecture ........................................................................................................................................... 9
5.3 Redundancy Architecture with KPI Monitor .............................................................................................................. 10
7. Uninstall WebHMI................................................................................................................. 14
8. WebHMI SSL/TLS Certificate ............................................................................................... 15
8.1 Self-Signed Certificate.............................................................................................................................................. 15
An outline helps to define the WebHMI context. PC requirement for a correct use is then presented. The installation of
WebHMI is given with the few necessary setting. The end of document gives indication for handling install problem or
uninstall product.
SCHNEIDER ELECTRIC’s years of experience in monitoring and control system has learnt that any system part needs to
be highly configurable to match a specific electric substation case, and its evolution along years. This needed flexibility is
not only into the change of parameters value but also in the structure of data manage along several devices.
As consequence, system devices use downloaded database compare to fixed devices that use setting upon a rigid structure
of data.
Along time, software features have evolution. WebHMI needs to meet new requirements and has also its own evolutions
and corrections referenced by version. The software version is seen all along installation and is expressed for example
following MSBR rule. 4 digits for each letter:
• Major version is changed whenever the software is totally re-built or re-designed in such a way, that it acts significantly
different from the previous version. Major version change also indicates that conceptual changes have been made to
the software, and the new version will most probably not be compatible with the old versions.
• Sub-version (minor version) is changed when new features have been added to the software, or existing bugs/issues
have been fixed. The changes are significant, but not conceptual, and the software stays compatible with the older
versions.
• Build number is a continuous ordinal number of the release. This number tells how many different versions of the
software were released. When major and minor version numbers stay the same and the build number changes, it
usually indicates insignificant minor fixes or minor updates to the software.
• Revision number indicates whether this release is stable or experimental. The revision number of 0 (zero) means that
this is a stable build. Any number greater than 0 is an experimental build.
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 3/29
• 32 bits
- Windows 10 (32 bits)
• 64 bits
- Windows 10 (64bits)
- Windows 2016 Server (64 bits)
Before installing WebHMI application software, please verify that the Windows Operating System installed on the WebHMI
computer is activated:
1. On Windows task bar, in the Type here to search box, type Activation.
2. In the search results, select See if Windows is activated (or the search result called Activation settings.)
3. Under Activation, check for this message: Windows is activated.
4. If Windows is not activated, follow the instructions in Windows support to activate it.
EcoSUI software must be installed on the WebHMI machine or reachable on the network.
EcoSUI version is 2.4.19211 or upper.
• Server main
• Server redundant
Before installing WebHMI application software, please verify that the Computer name of WebHMI machine is already
defined:
1. In Windows, open Settings and go to System > About.
2. In the About menu, under Device specifications, see the name of the computer in Device name.
3. If the computer name needs to be changed, follow the instructions in this link Windows support
Refer to the Maintenance chapter of this manual to learn important rules in order to help avoid the occurrence of identified
issues.
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 4/29
4. Install WebHMI
WebHMI standard installation takes less than 3 minutes. It mainly creates C:\MCIS\WebHMI directory where it
decompresses delivered files.
On the License Agreement window, read the license, then if you agree check I accept the agreement, then Next to
continue:
Installation folder by default is C:\MCIS\WebHMI. Use Browse if you want to select a different one. Then click Next::
• Node.js 10.14.0
In a simple architecture, the EcoSUI Secured is installed on the ECO computer (see below picture) and the WebHMI
application is installed on the HMI computer (see below picture). In this case, the HMI computer uses the EcoSUI Secured
installed on the ECO machine
Remember:
• EcoSUI Secured installed on both the WebHMI computer and the EcoSUI computers.
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 9/29
In the redundancy architecture with four computers represented here under: two machines for the EcoSUI redundancy,
which are ECO Main and ECO Backup, and two machines for the WebHMI redundancy, which are HMI Main and HMI
Backup. WebHMI computers use the EcoSUI redundancy.
Remember:
• EcoSUI Secured installed on both the WebHMI computers and the EcoSUI computers.
For a redundancy architecture with KPI Monitor, you need to install KPI Monitor plug-in on both the HMI Main computer and
the HMI Backup computer and refer to Redundancy Architecture for further requirements:
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 11/29
6. WebHMI Configuration
This is an overview of WebHMI configuration.
Refer to chapter Settings of this manual to learn how to configure WebHMI with WebHMI Server Manager.
6.1 Login
NOTE: For security reasons, passwords need to be changed after first login.
NOTE: Use AdmOdyssey (username) and Odyssey (password) for Administrator profile (with EcoSUI Standard).
6.4 Parameters
6.5 General
By default, it will automatically configure Single local WebServer and Single local EcoSUI Acquisition and Archive.
6.6 Modules
7. Uninstall WebHMI
To uninstall WebHMI, use standard Windows program removal methods as described below:
Learn furthers details in https://support.microsoft.com/en-us/help/4028054/windows-10-repair-or-remove-programs
4. Select Schneider Electric WebHMI x.x.x.x application, and then select Uninstall.
A self-signed certificate is a certificate that’s signed by the person creating it rather than a trusted certificate authority. The
development servers can be enabled with self-signed certificates that’ll help us reduce the certificate cost and also the
management overheads.
The user generates the SSL auto signed certificate which opens a website for the https protocol. All the connections are
secured and encrypted.
First Step
➢ When appears the command line “Enter passphrase for rootCA.key,” Enter a passphrase and store it securely.
Second Step
3. Execute the command line "openssl req -x509 -new -nodes -key rootCA.key -sha256 -days 20000 -out rootCA.pem" and
follow the instructions. Change the validity days as needed (in this example the certificate is valid for 20000 days).
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 16/29
First instruction
➢ When appears the command line “Enter passphrase for rootCA.key,” enter the passphrase used while generating
the root key.
Second instruction
Enter the optional information regarding your certificate provider. Following the example below:
• Organization Name (e.g., company) [Internet Widgits Pty Ltd]: Tech Forum
• Common Name (e.g., server FQDN or YOUR name) []: Local certificate
4. Execute the command line certutil -addstore -f "ROOT" rootCA.pem (which is generated by step 2). Now the root
certificate is added as part of the Trusted Root Certification Authorities.
5. Create a new OpenSSL configuration file server.csr.cnf so the configurations details can be used while generating the
certificate.
[dn]
C=US
ST=MN
L=Eagan
O=Tech Forum
OU=Marketing
emailAddress=admin@techforum.com
CN = localhost
6. Execute the command line "openssl req -new -sha256 -nodes -out server.csr -newkey rsa:2048 -keyout server.key -
config server.csr.cnf”. It will generate server.key
the "alt_name" correspond to "Subject Alternative Name". This field lets you specify additional host names (sites, IP
addresses, common names, etc.) to be protected by a single SSL Certificate, such as a Multi-Domain (SAN) or Extend
Validation Multi-Domain Certificate. In our case we will use our machine name which is ECOSUI.
8. Execute the command line “openssl x509 -req -in server.csr -CA rootCA.pem -CAkey rootCA.key -CAcreateserial -out
server.crt -days 500 -sha256 -extfile v3.ext". The output certificate is stored in a file called server.crt
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 18/29
12. If in the v3.ext file, Enter the Machine name as seen in the below image: (Ecosui is the machine name)
13. Here the certificate is installed on the server machine. If the user tries to connect the WebHMI server, it is necessary to
import the certificate in its machine otherwise the certificate won’t be recognized, and https won’t work.
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 19/29
This chapter is applicable for KPI Monitor plug-in installation and provides instructions for the correct interface with Qlik
Sense application.
Once installed, refer to Settings chapter of WebHMI documentation to learn how to configure KPI Monitor plug-in (Chapter 3
WebHMI KPI MONITOR).
• KPI Monitor setup (KPI_MONITOR_xxxx.exe.) is launched with administration rights in windows 10.
• Once the installation complete, Qlik environment is reachable from http port 333000 or https port 33301.
• A user has been defined/created for KPI Monitor services management. This user needs to be configured with the
following options:
o Administrator group
o Password never expired
NOTE: Refer to the Technical Data chapter of this manual to learn further details.
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 20/29
KPI Monitor installer will automatically perform the following actions during setup:
Automatic Windows Configuration
KPI Monitor setup automatically updates Windows environment as follows:
• Creation of the shared directory c:\qlikshare
NOTE: For security reasons, passwords need to be changed (refer to Windows user administration help).
mysql-connector-odbc-8.0.11-winx64.msi
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 21/29
NOTE: The hostname is used at installation. If the hostname change after installation, then uninstall KPI Monitor and
reinstall it to have the correct hostname configured.
Step Actions
5 Enter Qlik license information and LEF information (see section Qlik License – LEF information request to learn
how to get this information):
6 Click Next once the required information provided. Then, Install to continue with the installation
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 22/29
Step Actions
7 KPI Monitor and Qlik sense installation process starts:
8 Shell script prepares windows environment, once finished shell window automatically closes:
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 23/29
Step Actions
9 The next step launches a script powershell used to check and update the Qlik license previously registered:
If the powershell script detects an invalid license, the license is asked again until a valid license is confirmed.
NOTE: If the Qlik license is missing, the user needs to either stop the setup task and manually uninstall Qlik
sense and KPI monitor application to re-install later or get a valid license.
10 If the Qlik license is valid a second powershell script is launched to install all Qlik sense items (tasks, apps,
data connection, security rules, ….) used by KPI Monitor.
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 24/29
Step Actions
11 Qlik Sense automatic configuration starts:
14 Once installed, refer to Settings chapter of WebHMI documentation to learn how to configure KPI Monitor plug-
in (Chapter 3 WebHMI KPI MONITOR)
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 25/29
Steps
1. In Control Panel, open Programs and Features.
2. In the list of programs, double-click the extension bundle to install or remove.
10. Manually restart the Qlik Sense Repository Service to make the changes effective.
Check the Extensions section in the Qlik Management Console (QMC) to verify that the changes have been correctly
applied.
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 26/29
To uninstall KPI Monitor go to Windows > Settings > Apps & Features:
2. Select Qlik Sense April 2019, then click Uninstall. Qlik Sense Extension Bundles, will be also uninstalled:
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 27/29
9.6 Annex
1. Enter license Key in License Key field, check I’m not 2. Copy the result into license information form:
a robot and click Request LEF:
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 28/29
Enter license information and click Get LEF and preview the license, then click Apply:
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 29/29
Once finished, refer to Settings chapter of WebHMI documentation to learn how to configure KPI Monitor plug-in (Chapter 3
WebHMI KPI MONITOR).
SETTINGS (ST)
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 1/23
Contents
1. Introduction.............................................................................................................................. 2
1.1 WebHMI settings ........................................................................................................................................................ 2
1.1.1 Setup WebHMI server address .................................................................................................................................. 2
1.1.2 Set WebHMI server in debug mode ........................................................................................................................... 2
1.1.3 Modify login/password for MySQL .............................................................................................................................. 2
1.1.4 Add profile tag for RBAC in EcoSUI Standard ............................................................................................................ 2
1.1.5 Standalone configuration............................................................................................................................................ 3
1.1.6 Modify general settings for web server ....................................................................................................................... 3
1.1.7 Gravity color scheme.................................................................................................................................................. 4
1.1.8 Modules management ................................................................................................................................................ 4
1.1.9 Reports server ............................................................................................................................................................ 4
1.1.10 Time zone .................................................................................................................................................................. 5
1.1.11 Notifications ................................................................................................................................................................ 5
1.1.12 Dashboards ................................................................................................................................................................ 5
1. Introduction
The present document is a WebHMI chapter of the documentation binders. It describes the Settings –or –on-line-
parameters, which can be modified in runtime WebHMI or during the installation process.
Config.json
Line 22: hosts:{main:’IP address’, redunded:[‘IP address; IP address’]},
NOTE: Redunded is initially empty; add IP address to register redundant web servers.
Privilege Description
PRINT Allow printing
EXPORT Allow xls,csv extraction
CLEAR_ALARM Clear alarm
ACK_ALARM Acknowledge alarm
CMD_SELECT Allow to select device
CMD_EXECUTE Allow to execute command
CMD_CANCEL Allow to cancel command
SBO_SELECT Allow to select device
SBO_EXECUTE Allow to execute command
SBO_CANCEL Allow to cancel command
STOP_BUZZER Stop buzzer
EDIT_MEMO Not implemented yet
CONFIG Not implemented yet
END Not implemented yet
SHOW Allow user to navigate
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 3/23
To add a profile tag for RBAC, open {MCIS folder}\Mimics\Users\PacisUsers.ini
Add privileges to operator on the Profiles line. Use the semi-colon to separate privileges.
Example:
[SE viewer]
Password=
LastPasswordUpdate=1395417634
PasswordHistory=
NbOfLoginFailure=0
LastLoginFailure=0
Groups=administrators
Profiles=PRINT;EXPORT;
All color can be set with color name (black, white, yellow, etc) or with hex code (#4FA600, #000000, etc).
On this case, this means GMT modifier is the one on webserver and server clock is checked every 30 seconds.
This means if webserver is installed on a computer with its local time set on 25/12/2015 10:00:00 UTC +2, WebHMI client is
25/12/2015 08:00:00 UTC+1. WebHMI client will use 25/12/2015 10:00:00 UTC +2. If useClientTimeZone is set true, then
in our previous example, WebHMI client will use 25/12/2015 08:00:00 UTC+1.
delaySynchro means if for any reason time on server is changing from 25/12/2015 10:00:00 UTC +2 to 25/12/2015
09:58:00 UTC +2 as for a GPS synchronization. WebHMI client will see 30 seconds later this modification.
NOTE: Only date and time are synchronized, GMT modification on local server requires to reboot webserver.
1.1.11 Notifications
Notifications is a WebHMI module to create trigger notifications based on conditions and, enable/disable sending them via
SMS and/or e-mail.
Use Notifications module to create triggers, generate notifications and view them. Set conditions for when a notification is
triggered and decide whether to receive e-mail and/or SMS notifications. A History view displays issued notifications with
notification content (.zip file), status, name of the trigger and creation date.
NOTE: Notifications feature is not available for EcoSUI Secured.
1.1.12 Dashboards
Dashboard is a WebHMI module to view up to 2 years of high level historical data and on-demand events records, mainly
for Key Performance Indicators (KPIs).
Only the following MySQL tables of EcoSUI are extracted for data treatment and analytics:
• Object
• Events
• Values_x (x=(0 to 99)
• Object_state
Dashboard module requires KPI Monitor add-on. See how to configure KPI Monitor add-on Chapter 3 of this document.
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 6/23
To launch the console, click the WebHMI Server Manager icon in the task bar. The icon color reflects WebHMI operating
mode:
Issue occurred on web server (new trace, server running but task locked,
Alert
intrusion,…)
Basic Mode
In basic mode (Expert mode is OFF), the user can only view or edit settings in the General, Alarms and Languages
menus:
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 8/23
Expert Mode
To turn the view into Expert mode, click the Expert mode switch button to ON.
Additional Expert, Modules and other menus appear on screen:
The general settings for WebHMI, EcoSUI, Time Settings, User Settings, Project Settings, Reports and Active
Directory appear on screen. All these settings are read-only.
To turn the view into Edit mode, click the Enable Modification toggle button:
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 9/23
For some sections, you can:
Add a new item by clicking on the + button Delete an entry by clicking on the x button:
WebHMI
These are the settings for WebHMI:
EcoSUI
These are the settings for EcoSUI:
It is possible to configure Archives and Acquisitions on different IP address. It is possible to configure only one main and
one backup for Archives and Acquisitions.
Main server
Backup server
Not used
Time Settings
These are Time Settings:
Parameters Description Values
Use your timezone Use client side clock for display False by default. Usage of server clock
Synchronization delay Refresh frequency 30 seconds by default
Date format Choose the format of the date dd/MM/yyyy by default
User Settings
These are User Settings:
Parameters Description Values
User session timeout After this time (minutes), the user session expires 15 min by default
Show tray after start WebHMI Service Manager tray will show after WebHMI starts Enabled by default
Simultaneous user sessions Defines the number of sessions in use at the same time. Unlimited by default
Project Settings
These are Project Settings:
Parameters Description Values
Project name The project name will be displayed in WebHMI user interface
Logo The logo of the project customer will be displayed in the WebHMI user interface png file
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 10/23
Reports
These are the settings for Reports module. Go to Dashboard settings to see additional parameters:
Parameters Description Values
Js reports Js Report port 30002
Active Directory
These are Active Directory Settings, apply these settings to use users coming from an external active directory:
Parameters Description Values
Server URL The address of the external active directory server
Service Account login The external active directory login username
Service Account password The external active directory password
Base
To save modifications, click savedata. Then, click Apply modifications in the orange banner, at the bottom of the view.
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 11/23
2.2.2 Expert Settings
Click Expert menu.
NOTE: To enable this menu, switch the setting edition to Expert mode in the Parameters view:
The Expert parameters appear on screen:
2.2.2.1 Traces
Parameters Description Values
Path Storage folder for logs ./../Debug/
Environment Activate verbose mode Production by default
Development for Verbose mode
2.2.2.2 Trends
Parameters Description Values
Trend packet size Volume of data allowed in SQL packet size 80 dps by default
Trend data limit Maximum of volume of data allowed in SQL packet size 10000
2.2.2.3 SVG
These are settings SQL and System modules:
Parameters Description Values
SLD File directory Location of Electrical svg folder ./svg/electrical/
SLD File by default Default svg file for sld module Sld.svg
System file directory Location of System svg folder ./svg/system/
System file by default Default svg file for system view System.svg
2.2.2.4 Disturbances
These settings depend on the Disturbances module, which must be enabled:
Parameters Description Values
SBUS file directory Folder of SBUS disturbances None
Webserver file directory Folder for webserver disturbances ./disturbances
2.2.2.5 Alarms
These settings depend on the Alarm module, which must be enabled:
Parameters Description
Mp3 file for alarm sound Sound file for alarm buzzer
Commit Upload new mp3 file
2.2.2.6 Controls
The above image represents in WebHMI the possibility to configure the bypassing of Interlock and SynchroCheck at IED
level, with the IED network name as the equipment and the possibility to define the full path of the datapoint control which is
the primary equipment level for this equipment.
These settings depend on the Control module, which must be enabled as per the following table.
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 13/23
Remove ByPass button Define rule to remove the ByPass Default: false, the button is visible.
button from the control popup Set to true to remove ByPass button.
NOTE: ByPass button is available if dependencies are configured.
Measurements
These settings depend on the Measurements module, which must be enabled:
This parameter concerns 4 modules States, System, SLD, Trends
Parameters Description Values
Host Address: address of the server SMTP Phone number: Phone number of the Twilio account
Port: port of the server SMTP SID Account: SID account (provided with Twilio account)
Sender: Informations which used to send the notification. Token: Token (provided with Twilio account)
Below the images of Notifications module configuration, with the above table reference, the following information to be filled.
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 15/23
Test it to: To test the communication with the server SMTP and an associated mail for which a test mail is sent.
Below image indicates the notification of the Email sent successfully.
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 16/23
2.2.4 Dashboard and Reports Settings
These settings depend on the Dashboard module which must be enabled. KPI Monitor add-on is required (learn more in
chapter 3 of this document):
Scheduled tasks login This is the login of windows user used to create windows task
Reports (to be created with administrator rights)
Scheduled tasks pwd This is the password of windows user used to create windows
task (to be created with administrator rights).
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 17/23
2.2.5 Embedded modules
WebHMI can interface with HMI applications other than EcoSUI. Use Embedded modules module to include other HMI
applications e.g. Power SCADA Expert (PSE), EcoStruxure Building Operation (EBO):
If the alarm gravity is not configured, then the default text color is black, and the default background color is white.
To do so:
• Click the color flag in the desired area,
• The color picker popup appears on screen:
• Click the desired color and then, click Choose to validate your choice.
or
• Enter the #code in the entry field, and then, click Choose to validate your choice.
or
• Enter the RGB code using the format rgb([0-255],[0-255],[0-255]), and then, click Choose to validate your choice.
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 18/23
Set up the alarm text and background color according to your needs.
NOTE: The users are not allowed to delete gravity level from 1 to 3. Additional levels can be removed.
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 19/23
2.2.7 Languages Configuration Files
• A green check confirms that the required language files are installed,
• A black star means that this language is the default language in WebHMI
The user will be able to switch from one language to another directly from the WebHMI menu:
•
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 20/23
Since a global EcoSUI client allows the connection to several additional central databases (e.g., for redundant purposes),
use Additional DataBases module of WebHMI to handle additional databases added in EcoSUI:
NOTE: To learn more about EcoSUI Additional Databases, refer to topic Configure EcoSUI in EcoSUI user manual.
To configure Additional DataBases module, in Parameters, click Additional DataBases and enter following information:
Element Description
Database name Enter the name of the Additional Database (same name as in EcoSUI).
@IP 1 Enter the IP address of the main computer managing the Additional Database (same IP address as in EcoSUI).
@IP 2 Only in case of redundancy, enter the IP address of the backup computer managing the Additional Database
(same IP address as in EcoSUI).
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 22/23
Settings Port
WebHMI port 90
KPI Monitor port 3090, 4000, 4242, 4244, 4248, 4432, 4444, 5355,
(when Dashboard module enabled) 5353, 5555, 5556, 33000, 33301,
2. Check proxy settings since they could be blocking web site access impacting WebHMI too.
3. Verify that communication is working on ports. To do so, use telnet command (e.g. to verify communication with
MySQL on local host use command telnet localhost 3306)
4. Verify that applications are running on ports. To do so, use this command:
netstat -ano | findstr :YOUR_PORT_TO_FIND
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 23/23
Refer on Installation chapter to “WebHMI KPI Monitor plug-in installation (optional)” for more information about Qlik Sense
installation.
NOTE: The start-up order is important. During start-up the QRS must be able to contact the Qlik License Service, which is
managed by the QSD. The other services are dependent on the QRS. The QSD must therefore be running when the QRS
is started.
COMMISSIONING RECORD
SHEET (RS)
COMMISSIONING RECORD SHEET WEBHMI/EN RS
WEBHMI Documentation Page 1/2
Contents
1. Scope of the document ...............................................................................................................2
2. Installation ....................................................................................................................................2
2.1 Software delivery ............................................................................................................................................................... 2
2.2 WEBHMI Installation .......................................................................................................................................................... 2
2.3 Installation checking .......................................................................................................................................................... 2
COMMISSIONING RECORD SHEET WEBHMI/EN RS
WEBHMI Documentation Page 2/2
2. Installation
2.1 Software delivery
Contents
1. Introduction ............................................................................................................................ 2
2. WebHMI checks ..................................................................................................................... 2
3. WebHMI logs .......................................................................................................................... 3
4. WebHMI background tasks ................................................................................................... 4
4.1 WebHMI Modules background tasks .......................................................................................................................... 4
4.2 WebHMI Server background tasks ............................................................................................................................. 4
5. Quickly check status ............................................................................................................. 5
MAINTENANCE, FAULT FINDING, REPAIRS WebHMI/EN MF
WebHMI Documentation Page 2/5
1. Introduction
The present document is a WebHMI chapter of the documentation binders. It describes the Maintenance and Fault Finding
procedures of the product.
2. WebHMI checks
Respect these rules to avoid following identified issues:
• At least one EcoSUI must be installed on the local machine. Otherwise modify the C:/MCIS/WebHMI/config/config.json
to set an IP address which corresponds to that of your EcoSUI:
"CAEDatabases": {"IP0": { "DBHost": "127.0.0.1" ...} and "SBUSServers": { "Server0": "127.0.0.1 ...
• Do not launch WebHMI.exe with Run as administrator right-click option or check Run this program as an
administrator checkbox in Properties > Compatibility > Settings, otherwise WebHMI will not start at next start of
Windows.
• When launching WebHMI application one or several Command Prompt windows will open. Please do not close these
windows, otherwise WebHMI application will not start.
• EcoSUI with a redundant architecture must have the same password for main EcoSUI and backup EcoSUI.
• EcoSUI must run automatically at startup in Windows. Otherwise, refer to EcoSUI user manual to clear the issue.
• Ports must be available and not used already by another application (in the Settings chapter of this manual, read
section How to connect with WebHMI from another computer to learn about ports). In any case at WebHMI start,
WebHMI tries to kill the applications which use the WebHMI port (configurable).
• MySQL services (EcoSUI database) must be running otherwise connection to WebHMI will be impossible.
• Do not use the WebHMI server machine to access WebHMI web interface since Chrome browser uses much memory.
• WebHMI with a redundant architecture must have the same enabled modules for main and backup. In additions, since
configuration files are not synchronized automatically, modifications done in configuration file (config.json) of main
WebHMI must be done in configuration file (config.json) of the backup WebHMI.
• Do not store files or folders in C:/MCIS/WebHMI since this is the installation folder of WebHMI. Please, choose other
folders for storing matters.
MAINTENANCE, FAULT FINDING, REPAIRS WebHMI/EN MF
WebHMI Documentation Page 3/5
3. WebHMI logs
These are the log files generated in C:\MCIS\Debug folder:
• ECOSUIWEB-errors_ contains all errors retrieved by WebHMI (it is very rare that WebHMI crashes if the error has
been retrieved).
• ECOSUIWEB-activities_ contains all activities of WebHMI. (you will see the validity of license in this file).
• ECOSUIWEB-exceptions_ contains all errors not handled by WebHMI. If this file exists then WebHMI could crash.
• ECOSUIWEB-CyberSecurityDLL.log (new from 3.5.3.1) for cybersecurity issues, please analyze this file.
• ECOSUIWEB-debug_ contains many traces (signals register/unregister, data/messages received from the SBUS).
(Only available in pre-production mode).
These are the log files generated in C:\MCIS\WebHMI\logs folder for report and disturbances:
• reporter.log
• error.log (for disturbance)
To get additional logs generated by WebHMI in lower versions than 3.5.1.1, configure the
C:\MCIS\WEBHMI\ecosystem.json file as follows:
NOTE: Please make sure you backup/save C:\MCIS\WEBHMI\ecosystem.json file before modification to restore it later
after bug detected.
{
"apps":[
{
"name":"webhmiPM2",
"script":"server.js",
"watch":false,
"node_args":[
"--harmony",
"--max_old_space_size=4096"
],
"error_file":"errors_pm2_webhmi.log",
"out_file":"activities_pm2_webhmi.log"
},
{
"name":"traywebhmiPM2",
"script":"./Tray/webhmi-tray/startServer.js",
"error_file":"/dev/null",
"out_file":"/dev/null"
}
]
}
This table contains the background tasks related to the WebHMI server:
Use the information in this table to quickly check the status of other additional services:
Contents
1. Introduction ............................................................................................................................ 1
2. Initial problem identification ................................................................................................. 1
3. Act after problem ................................................................................................................... 2
3.1 Analyze issue.............................................................................................................................................................. 2
3.2 Check web server address ......................................................................................................................................... 2
3.3 Check file encoding .................................................................................................................................................... 2
3.4 First line in text files .................................................................................................................................................... 2
3.5 Check MySQL parameters ......................................................................................................................................... 3
3.6 Missing user rights ...................................................................................................................................................... 3
3.7 ecoSUISecurityServer Service.................................................................................................................................... 3
3.8 Check Node.js version ................................................................................................................................................ 3
3.9 How to analyze performance problem ........................................................................................................................ 4
4. Support team.......................................................................................................................... 5
PROBLEM ANALYSIS WEBHMI/EN PR
WEBHMI Documentation Page 1/6
1. Introduction
The present document is a WebHMI chapter of the documentation binders. It describes the Problem Analysis of the product.
WebHMI log files find information are provided in chapter Maintenance of this manual.
Issue Solution
For all issues Go to Analyze issue
Performance problem Go to How to analyze performance problem
WebHMI server does not start Go to Check web server address
Go to Check file encoding
Impossible to login Go to First line in text files
Cybersecurity module activate
Alarm banner is empty Go to Check MySQL parameters
WebHMI is on demo mode Activate license for EcoSUI
Control EcoSUI server status
Missing user rights Control RBAC. Go to Missing user rights
Advanced issue Go to Schneider Electric WebHMI expert
WebHMI.exe impossible installation Check antivirus since it can be blocking the executable files (e.g.: Cylance is
well-known for blocking executables).
WebHMI does not start Go to ecoSUISecurityServer Service
WebHMI does not start Go to Check Node.js version
WebHMI does not start If WebHMI does not start after a manual modification of config.json, delete
config.json file and restart WebHMI
Dashboard module does not work Uninstall KPI Monitor plug-in and install it again. Refer to the Installation
chapter of this manual and follow the instructions.
PROBLEM ANALYSIS WEBHMI/EN PR
WEBHMI Documentation Page 2/6
To define issue origin, it is highly recommended stopping WebHMI service and launching WebHMI application.
On Windows 10 and further version, WebHMI is able to log server issue on windows events tracker. It is accessible via:
1. Go on control panel > administrative tools
2. Launch events viewer
WebHMI is able to read text file. However, it is limited to third encoding method: ANSI, UTF-8 and UTF-16LE.
Following table shows the files read by WebHMI depending on installation type Standard or Secured:
With third-part software (Notepad++, SublimeText, …), convert encoding to be in phases with requirements below.
Current versions are not able to read first line in text files. On files referred on previous chapter, user shall add a blank line
at line 1.
PROBLEM ANALYSIS WEBHMI/EN PR
WEBHMI Documentation Page 3/6
If user encounters issue to get archived values, MySQL parameters shall be checked.
On WebHMI\config\config.json check following parameters:
DBHost:'localhost',
DBPort:3306,
DBName:'pacis',
DBLogin:'pacis',
DBPassword:'pacis',
DBDebug:false,
DBSSL:false,
WebHMI Standard shall add some attributes to define role based access control (RBAC). Refer to chapter Settings of this
manual to learn more about declaration of roles to users.
WebHMI Secured is connected to cybersecurity module. RBAC is managed by Cybersecurity Admin Expert tool, CAE.
Please refer to CAE user manual to learn more.
For performance problems, enable Log for MySQL data base to check for SQL slow queries.
To analyze SQL queries:
• Enter the following information in C:\Program Files\MySQL\MySQL Server 5.5\my.ini:
slow_query_log=1
slow_query_log_file=C:\\MCIS\\Debug\\[MySQL]Slowqueries.log
long_query_time=1
log-error=C:\MCIS\Debug/[MySQL]Errors.log
• SQL queries taking longer than one second will be archived in C:\\MCIS\\Debug\\[MySQL]Slowqueries.log
• The configuration will work after a restart of MySQL or a restart of the machine.
To monitor network traffic with Wireshark network analyzer https://www.wireshark.org/:
• Mainly, search for http requests which are too long.
• or specific http requests executed too many times.
Also, it is possible to monitor the network activity with Windows Task Manager:
• In Windows, go to Task Manager and click More details.
• In Performance tab, click on Ethernet or Wi-Fi.
• Click on Open Resource Monitor, in Network tab see all the network activity of the computer:
PROBLEM ANALYSIS WEBHMI/EN PR
WEBHMI Documentation Page 5/6
4. Support team
For better support, please provide the following files and directories:
• C:\MCIS\WebHMI\config\config.json
• C:\MCIS\WebHMI\reports\datas\schedules
• C:\MCIS\WebHMI\reports\datas\scripts
• C:\MCIS\WebHMI\logs
• C:\MCIS\WebHMI\svg
• C:\MCIS\Debug
• C:\MCIS\Rings
• C:\MCIS\Formulas
• Export your project from EPAS-E (EPAS-Engineering) if it exists
• Export your project from SCE if it exists
Contents
1. Scope of the document ......................................................................................................... 2
2. WebHMI Lexical ..................................................................................................................... 2
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 2/12
2. WebHMI Lexical
Term Description
AC Alternating Current
AccI Accumulator Input
ACSI Abstract Communication Service Interface
Mapping from the standard IEC 61850 abstract specification of communication service to a
concrete communication infrastructure based on CORBA.
A/D Analog/Digital
ADC Analog to Digital Converter
AE qualifier Application Entity qualifier
Used internally by IEC 61850 to identify a server application
AI Analog Input (Measurement Value including state attribute)
Commonly Voltage or current DC signals delivered by transducers and representing an
external value (refer to CT/VT for AC).
AIS Air Insulated Substation
AIU Analog Input Unit (MiCOM C264 Bay Computer board name for DC Analog Input)
Alarm An alarm is any event tagged as an alarm during the configuration phase
AO Analog Output
Value corresponding to a desired output current applied to a DAC.
AOU Analog Output Unit (MiCOM C264 Bay Computer board name for Analog Output)
API Application Programming Interfaces
AR Auto-Reclose
ARS Auto-Recloser
ASCII American Standard Code for Information Interchange
ASDU Application Specific Data Unit
Name given in the OSI protocol for applicable data (T103, T101..)
ASE Applied System Engineering
ATCC Automatic Tap Change Control
Automation in charge of secondary voltage regulation, more specific than AVR
AVR Automatic Voltage Regulator
Automatic system used to regulate the secondary voltage by automatic tap changer control
(see ATCC). Set of features can be added, see chapter MiCOM C264 FT.
Bay Set of LV, MV or HV equipment (switchgears and transformers) and devices (Protective,
Measurement…) usually encompassing a Circuit Breaker and ancillary devices, and
controlled by a bay computer.
BCD Binary Coded Decimal
One MiCOM C264 supported coding on a set of Digital Inputs, that determine a Digital
Measurement, then a Measurement value (with specific invalid code when coding is not
valid). Each decimal digit is coded by 4 binary digits.
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 3/12
Term Description
BCP Bay Control Point
Name given to the device or part used to control a bay. It can be Mosaic Panel, MiCOM
C264 LCD, usually associated with Remote/Local control.
BCU Bay Control Unit
Name given to the MiCOM C264 controlling a bay. Usually in contrast to Standalone.
BI Binary Input (or Information)
Designation of already filtered data entered into the MiCOM C264 Bay Computer before they
become SPS, DPS with time tag and quality attributes
BIU Basic Interface Unit
MiCOM C264 board for auxiliary power supply, watchdog relay, redundancy I/O
BNC A connector for coaxial cable.
B-Watch Monitoring and control device for GIS substation.
CAD Computer Aided Design
Computer application dedicated to the design of wiring, for example.
CAE Cybersecurity Admin Expert tool
CAS CASe
MiCOM C264 Bay Computer rack
CAT Computer Administration Tool
CB Circuit Breaker
Specific dipole switch with the capability to make line current and break fault current. Some
have isolation capability, i.e. nominal grounding (earthing) at each side.
CBC Compact Bay Controller
Small capacity Bay Computer for Medium Voltage applications, typically MiCOM C264C
CC Complemented Contact
CCU Circuit breaker Control Unit
MiCOM C264 Bay Computer board dedicated to switch control with 8DI, 4 DO
CDM Conceptual Data Modeling
This is the modeling of system/devices data using a hierarchy of structured data (called
object or class) with their attributes, methods or properties and the relations between each
other. It maps common data to devices or components of devices, with guarantee of
interoperability.
Class Defined in IEC 61850 as: description of a set of objects that share the same attributes,
services, relationships, and semantics
Client Defined in IEC 61850 as: entity that requests a service from a server and that receives
unsolicited messages from a server
CM Commissioning
CMT Computer Maintenance Tool
CO Command, logic information Output (Functional Component) / Contact Open
COMTRADE Common Format for Transient Data Exchange (international standard IEC 60255-24
1997/1999/2001)
CPU Central Processing Unit
MiCOM C264 Bay Computer main board based on a Power PC
CRC Cyclic Redundancy Check
Coding result sent with packet of transmitted data to guarantee their integrity. Usually result
of a division of transmitted data by polynomial.
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 4/12
Term Description
CSV Character Separate Values
ASCII values separated by a predefined character or string as in Excel or ASCII Comtrade.
CT Current Transformer
Basically the electric device connected to process and extract a current measurement. By
extension, part of a device (MiCOM C264) that receives an AC value and converts it into a
numerical measurement value.
CT/VT Current and Voltage transformers
(Conventional) By extension, the MiCOM C264 TMU board.
CT/VT Current and Voltage transformers
(Non- New generation of transducer based for example on light diffraction under an electric field.
Conventional or Without transformer, gives a direct numerical measurement of voltage and current as a
intelligent) communicating IED.
CSV Character Separated Values
ASCII values separated by predefined character or string as in Excel or ASCII Comtrade.
DAC Data Acquisition component of the GPT
DAC Digital to Analog Converter
Used to generate an analog signal (usually DC) from a digital value.
DB DataBase
Tool or set of data that defines the entire configuration of a system or specific device such as
a computer. In contrast to a setting or parameter, the DB has a structure that cannot be
modified on-line. DBs are always versioned.
DB-9 A 9-pin family of plugs and sockets widely used in communications and computer devices.
DBI Don’t Believe It
Term used for an undefined state of a double point when inputs are not complementary.
DBI00 signifies dynamic state or jammed. DBI11 signifies undefined.
DBID Databases Identity Brick
DC Direct Current
DC, DPC Double (Point) Control
Two digits and/or relay outputs used for device control with complementary meaning (OPEN,
CLOSE).
DCF77 External master clock and protocol transmission
LF transmitter located at Mainflingen, Germany, about 25 km south-east of Frankfurt/Main,
broadcasting legal time on a 77.5 kHz standard frequency.
DCO Double Control Output
DCP Device Control Point
Located at device level (electric device or IED). It should have its own Remote/Local switch.
DCS Digital Control System
Generic name of system based on numeric communication and devices, to be opposed to
traditional electrically wired control.
DCT Double Counter
Counter based on 2 DI with complementary states (counting switching operations, for
example)
DE Direct Execute
DELTA Phase-to-phase delta values
Device Term used for one of the following units:
Protective relays, metering units, IED, switchgear), disturbance or quality recorders.
Switchgear: switching device such as a CB, disconnector or grounding (earthing) switch
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 5/12
Term Description
DHMI MiCOM C264 Display HMI
DI Digital Input
Binary information related to the presence or to the absence of an external signal, delivered
by a voltage source.
DIN Deutsche Institut für Normung
The German standardization body.
DIU DC Input Unit
MiCOM C264 Bay Computer board name for Digital Input
DLL Dynamic Link Library. Available on Windows XP.
A feature that allows executable code modules to be loaded on demand and linked at run
time. This enables the library-code fields to be updated automatically, transparent to
applications, and then unloaded when they are no longer needed.
DM Digital Measurement
A measurement value with acquisition by DI and a specific coding BCD, Gray, 1-out-of-n, and
so on.
DNP3.0 Distributed Network Protocol
DNP3 is a set of communication protocols used between components in process automation
systems.
DO Digital Output
Used to apply a voltage to an external device via a relay, in order to execute single or dual,
transient or permanent, commands.
DOF Degree Of Freedom
Used for a template attribute that can be modified or not when used. An attribute has a
degree of freedom if a user can modify its values on its instances
DOU Digital Output Unit
MiCOM C264 Bay Computer board name for Digital Output
DP Double Point
Information/control derived from 2 digital inputs/output; usually employed for position
indication of switching devices (OPEN, CLOSE).
DPC Double Point Control
DPS Double Point Status
Position indication of switching devices (OPEN, CLOSE).
ECDD Coherent Extract of Distributed Data
EcoSUI IEC 61850 based Human Machine Interface for Substation Automation System
ECU Extended Communication Unit.
External module connected to the CPU board. This module converts non-insulated RS-232
into optical signal or insulated RS-485/RS-422.
EH90 Transmission protocol dedicated to time synchronization and standardized by EDF.
Specification document: D.652/90-26c, March 1991.
EMC Electro-Magnetic Compatibility
EPAS EcoStruxure Power Automation (former PACiS)
EPAS-E EcoStruxure Power Automation - Engineering (former GEA and SET)
EPATR Ensemble de Protection Ampèremétrique de Terre Résistante (French legacy: very resistive
earth current module)
Event An event is a time-tagged change of state/value, acquired or transmitted by a digital control
system.
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 6/12
Term Description
EWS Engineering Workstation
FAT Factory Acceptance Test
Validation procedures execution with the customer at factory.(i.e. SAT)
FBD Functional Block Diagram
One of the IEC 61131-3 programming languages (language used to define configurable
automation).
FIFO First In First Out
FO Fiber-Optic
FP Front Panel
FTP Foil Twisted Pair
FLS Fast Load Shedding
FSS Force Suppress Substitute
GAT Gateway Administration Tool
Gateway Level 6 session of OSI, the gateway is any device transferring data between different
networks and/or protocols. The RTU function of the MiCOM C264 gives a gateway behavior
to SCADA or RCP level. Gateway (GTW) is separate PC base device dedicated to this
function.
GHU Graphic Human interface Unit
MiCOM C264 Bay Computer Front Panel digital part (LCD, buttons, Front RS)
GIS Gas Insulated Substation
GLOBE GLOBE Brick
GMT Greenwich Mean Time
Absolute time reference
GPS Global Positioning System
Based on triangulation from satellite signals.
Also transmits absolute GMT time used to synchronize a master clock
GOOSE Generic Object Oriented Substation Event
GPT Generic Protocol Translator software, supplied by ASE
Group Logical combination of BI (i.e. SP, DP, SI or other groups).
GSSE Generic Substation Status Event
Hand Dressing Facility for an operator to set the position of a device manually (position acquired by other
means) from the HMI at SCP level; e.g. from OPEN to CLOSE (without any impact on the
“physical” position of the electrical switching device).
HELPS Hostable Emulator for Load and Protocol Simulation. HELPS simulates an Intelligent
Electronic Device (IED)
HMGA Horizontal Measurement Graphical Area
HMI Human Machine Interface
Can be EcoSUI OI (Operator Interface) or MiCOM C264 LCD (Local Control Display) or set
of LEDs, mosaic...
HSR High Speed Auto-Recloser, first cycles of AR
HTML Hyper Text Mark-up Language
Used as standard format for web display
HV High Voltage (for example 30kV to 150kV)
I/O Input/Output
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 7/12
Term Description
ICD IED Capability Description
IEC International Electro-technical Commission
IED Intelligent Electronic Device
General expression for a whole range of microprocessor based products for data collection
and information processing
IP Internet Protocol
IRIG-B Inter-Range Instrumentation Group standard format B. This is an international standard for
time synchronization based on an analog signal.
JAMMED Invalid state of a Double Point:
Occurs when two associated digital inputs are still in state 0 after a user- selected delay, i.e.
when the transient state “ motion ” is considered as ended
Kbus Term used for the Courier protocol on a K-Bus network (RS-422 type).
(Kbus Courier)
LAN Local Area Network
L-BUS Legacy Bus
Generic name of Legacy or field networks and protocols that are used to communicate
between MiCOM C264 (Legacy Gateway function) and IED on field bus. Networks are based
on RS-232, RS-422, RS-485. Protocols are IEC 60850-5-103 (T103 or VDEW), Modbus
Schneider Electric or MODICON
LCD Liquid Crystal Display or Local Control Display (on MiCOM C264)
LD Ladder Diagram, one of the IEC 61131-3 programming languages (language used to define
configurable automation).
LED Light Emitting Diode
LF Low Frequency
LOC Local Operator Console
Dedicated to maintenance operation
L/R Local / Remote
Local / Remote When set to local for a given control point, it means that the commands can be issued from
Control Mode this point, or in remote control from higher-level devices.
LSB Least Significant Bit
LSP Load Shedding Pre-Selection
LV Low Voltage
MAFS Marketing And Functional Specification
MC Modular Computer
MCB Mini Circuit Breaker. Position associated to the tap changer.
MDIO Management Data Input/Output
A standard driven, dedicated-bus approach that is specified in IEEE 802.3
Measurements Values issued from digital inputs or analog inputs (with value, state, time tag)
Metering Values computed depending on the values of digital or analog inputs during variable periods
(non-tariff) of time (time integration).
Metering Values computed depending on the values of digital or analog inputs during variable periods
(tariff) and dedicated to the energy tariff. These values are provided by dedicated “tariff computers”
external to the MiCOM Systems.
MIDOS Schneider Electric Connector: Used for CT/VT acquisition
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 8/12
Term Description
MMC Medium Modular Computer
MMS Manufacturing Message Specification (ISO 9506)
Modbus Communication protocol used on secondary networks with IED or with SCADA RCP. 2
versions. Standard MODICON or Schneider Electric.
Module Word reserved in EPAS SCE for all electric HV devices. It groups all switch-gear devices,
transformers, motors, generators, capacitors, …
MOTION Transient state of a Double Point
Occurs when the two associated digital inputs are momentarily in state 0 (e.g. position
indication when an electrical device is switching). The concept of “momentarily” depends on
a user-selectable delay.
MPC Protection Module for Computer
MV Medium Voltage
MVAR Mega Volt Ampere Reactive
NBB Numerical Busbar Protection
NC Normally Closed (for a relay)
NO Normally Open (for a relay)
OBS One-Box Solution
Computer that provides protection and control functions with local HMI. The prime application
of this device is intended for use in substations up to distribution voltage levels, although it
may also be used as backup protection in transmission substations. Likewise, the OBS may
be applied to the MV part of a HV substation that is being controlled by the same substation
control system.
OI Operator Interface
OLE Object Linking and Embedding
OLE is a Microsoft specification and defines standards for interfacing objects.
OLTC On Line Tap Changing
OMM Operating Mode Management
OPC OLE for process control
OPC is a registered trademark of Microsoft, and is designed to be a method to allow
business management access to plant floor data in a consistent manner.
Operation Sum of time periods during which, a primary device is running in the energized state. For
hours example, a circuit breaker is in Closed state and the current is not equal to 0 A.
OSI Open System Interconnection
Split and define communication in 7 layers : physical, link, network, transport, session,
presentation, application
OWS Operator WorkStation (EcoSUI)
PACiS Protection, Automation and Control Integrated Solutions
PLC Programmable Logic Control /Chart. Includes PSL and ISaGRAF.
The configurable control sequences or automations taken into account by the MiCOM
Systems are defined within the PLC program.
POW Point On Wave
Point on wave switching is the control process of the three poles of an HV-circuit breaker in a
manner that to minimizes the effects of switching.
PSL Programmable Scheme Logic
PSTN Public Switched Telephone Network
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 9/12
Term Description
RCC Remote Control Centre
Computer or system that is not part of a MiCOM system. RCC communicates with and
supervises a MiCOM system using a protocol.
RCP Remote Control Point
Name given to the device or part used to control remotely several bays or sub-stations.
Usually associated with Remote/Local sub-station control. It is a SCADA interface managed
by the MiCOM system through the Telecontrol BUS. Several RCPs can be managed with
different protocols.
Remote Control When set for a control point, it means that the commands are issued from an upper level and
Mode are not allowed from this point.
Remote HMI Remote HMI is a client of the substation HMI server. The client may provide all or part of
functions handled by the substation HMI.
RI Read Inhibit
This output indicates the availability of an analog output (e.g. during DAC converting time)
RJ-45 Registered Jack-45
A 8-pin female connector for 10/100 Base-T Ethernet network
RMS Root Mean Square
RRC Rapid ReClosure
RSE Régime Spécial d’Exploitation
French grid function when work is being done on an HV feeder
RSVC Re-locatable Static VAR Compensator
RS-232 Recommended Standard 232
A standard for serial transmission between computers and peripheral devices.
RS-422 A standard for serial interfaces that extends distances and speeds beyond RS-232. Is
intended for use in multipoint lines.
RS-485 A standard for serial multipoint communication lines.
RS-485 allows more nodes per line than RS-422.
RSVC Re-Locatable Static Var Compensator
RTC Real Time Clock
RTU Remote Terminal Unit
Stand-alone computer that acquires data and transmits them to RCP or SCADA. Typically, it
is the C264. RTU link is the TBUS.
SAT Site Acceptance Test
Validation procedures executed with the customer on the site.
SBMC Site Based Maintenance Control mode
A bay in SBMC mode does not take into account the commands issued from RCP. Moreover,
some of its digital points & measurements (defined during the configuration phase) are not
sent to the RCP anymore (they are “automatically” suppressed).
SBO Select Before Operate
A control made in two steps, selection and execution. The selection phase gives a feedback.
It can be used to prepare, reserve during time, configure a circuit before execution. Controls
are done into a protocol, or physically (select with DI Select then DO execute).
S-BUS Station Bus, network between EPAS devices.
SCADA Supervisory Control And Data Acquisition
Equivalent to RCC
SCD Description file extension
SCE System Configuration Editor
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 10/12
Term Description
SCL Substation automation system Configuration Language ( IEC 61850-6)
SCP Substation Control Point
Name given to the device or part used to control several bays or substation locally. Usually
associated with Remote/Local substation control. It is commonly the EPAS Operator
Interface.
SCS Substation Control System
SCSM Specific Communication Service Mapping
SCT Single Counter
SER Sequence of Event Recorder
Combines SOE with accurate Time synchronization and Maintenance facilities over Ethernet
communication
Server Defined in IEC 61850 as: entity that provides services to clients or issues unsolicited
messages
Setpoints Analog setpoints are analog outputs delivered as current loops. Analog setpoints are used to
(analog) send instruction values to the process or auxiliary device
Setpoints Digital values sent on multiple parallel wired outputs. Each wired output represents a bit of
(digital) the value. Digital setpoints are used to send instruction values to the electrical process or to
auxiliary devices.
SFC Sequential Function Chart
One of the IEC 61131-3 programming languages (language used to define configurable
automation).
SI System Indication
Binary information that does not come from an external interface. It is related to an internal
state of the computer (time status, hardware faults, and so on). It is the result of all inner
functions (AR, …), PSL, or ISaGRAF automation.
SICU 4 Switchgear Intelligent Control Unit
Control unit of an intelligent circuit breaker (fourth generation)
SIG Status Input Group
SINAD Signal-plus-Noise-plus-Distortion to Noise-plus-Distortion ratio, in dB
SIT Status Input Double Bit
SMT System Management Tool
SNTP Simple Network Time Protocol
SOE Sequence Of Events
Other term for the event list.
SP Single Point
SPS Single Point Status
SPC Single Point Control
ST Structured Text
An IEC 61131-3 programming languages to define configurable automation
STP Shielded Twisted Pair
Substation Bay computer used at substation level
computer
Suppression A binary information belonging to a bay in SBMC mode will be automatically suppressed for
(Automatic) the remote control. However changes of state will be signaled locally, at SCP
Suppression A binary information can be suppressed by an order issued from an operator. No subsequent
(Manual) change of state on “suppressed information ” can trigger any action such as display, alarm
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 11/12
Term Description
and transmission
SWR Switch Redundant
MiCOM C264 Bay Computer board Ethernet switch with redundant Ethernet
SWU Switch Unit (MiCOM C264 Bay Computer board Ethernet switch)
T101 Term used for IEC 60870-5-101 protocol
T103 Term used for IEC 60870-5-103 protocol
T104 Term used for IEC 60870-5-104 protocol
TBC / TBD To Be Completed / Defined
T-BUS Telecontrol Bus, generic name of networks and protocols used to communicate between
Gateway (GTW) or MiCOM C264 Telecontrol Interface function and the RCP. Networks are
based on RS-232, RS-485 or Ethernet (T104). Protocols are IEC 60870-5-101 (T101),
Modbus MODICON
TC True Contact
TCIP Tap Change in Progress
TCU Transformer Current Unit
MiCOM C264 Bay Computer CT/VT board : Current acquisition
TDD Total Demand Distortion, similar to the THD but applied to currents and with a rated current
(In) as reference
TG Telecontrol Gateway
THD Total Harmonic Distortion, sum of all voltage harmonics
TI Tele Interface
TM Analog Measurement
TMU Transducer-Less Measurement Unit
Topological Interlocking algorithm, based on evaluation of topological information of the switchgear
interlocking arrangement in the HV network, the switchgear type and position, and defined rules for
controlling this kind of switch (e.g. continuity of power supply)
TPI Tap Position Indication (for transformers).
Frequently acquired via a Digital Measurement
TS Logic position
Term Description
VT Voltage Transformer
Electric device connected to process and extract a voltage measurement. By extension, part
of a device (MiCOM C264) that receives this AC value and converts it to a numerical
measurement value. VTs are wired in parallel.
WTS Windows Terminal Server, Microsoft remote desktop connection
WYE Three phases + neutral AI values
xPC Single Point Control, Double Point Control
Schneider Electric
35 rue Joseph Monier
92500 Rueil Malmaison
France
+33 (0) 1 41 29 70 00
https://www.se.com
WebHMI/EN UM/A9_RC1