Download as pdf or txt
Download as pdf or txt
You are on page 1of 227

WebHMI

Human Machine Interface


User Manual

Version: WebHMI/EN UM/A10


08/2022
Legal Information
The Schneider Electric brand and any trademarks of Schneider Electric SE and its subsidiaries
referred to in this guide are the property of Schneider Electric SE or its subsidiaries. All other
brands may be trademarks of their respective owners.

This guide and its content are protected under applicable copyright laws and furnished for
informational use only. No part of this guide may be reproduced or transmitted in any form or by
any means (electronic, mechanical, photocopying, recording, or otherwise), for any purpose,
without the prior written permission of Schneider Electric.

Schneider Electric does not grant any right or license for commercial use of the guide or its
content, except for a non-exclusive and personal license to consult it on an "as is" basis.
Schneider Electric products and equipment should be installed, operated, serviced, and
maintained only by qualified personnel.

As standards, specifications, and designs change from time to time, information contained in this
guide may be subject to change without notice.

To the extent permitted by applicable law, no responsibility or liability is assumed by Schneider


Electric and its subsidiaries for any errors or omissions in the informational content of this material
or consequences arising out of or resulting from the use of the information contained herein.
Disclaimer
No responsibility is assumed by Schneider Electric for any consequences arising out of the use of
this guide. This guide is not intended as an instruction manual for untrained persons. The guide
cannot cover all conceivable circumstances or include detailed information on all topics. In the
event of questions or specific issues, do not take any action without proper authorisation. Contact
Schneider Electric and request the necessary information.

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

35 rue Joseph Monier


92500 Rueil Malmaison
France

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

The addition of either symbol to a "Danger" or "Warning" safety label


indicates that an electrical hazard exists which will result in personal
injury if the instructions are not followed.
This is the safety alert symbol. It is used to alert you to potential personal
injury hazards. Obey all safety messages that follow this symbol to avoid
possible injury or death.

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

Failure to follow these instructions 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.

Failure to follow these instructions could result in injury or equipment damage.

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

Failure to follow these instructions could result in equipment damage.


Please Note
Software should be installed, operated, serviced and maintained only by qualified personnel. No
responsibility is assumed by Schneider Electric for any consequences arising out of the use of this
manual.

Secure Disposal of the equipment embedding the software

It is recommended that incineration and disposal to water courses is avoided. 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.
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

1. Health and Safety


The data in the Safety Section of the product documentation helps to ensure that products are properly installed and safely
operated to maintain them in a serviceable condition. Everyone who operates the equipment must be familiar with the
contents of the Safety Section and all Safety documents related to the PC and Communication networks.

2. Installing, Commissioning and Servicing


Operate the equipment (PC supporting WebHMI) within in the specified electrical and environmental limits.

3. Decommissioning and Disposal


It is recommended that incineration and disposal to water courses is avoided.

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.

4. Copyrights & Trademarks


4.1 Copyrights

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

5. Warnings regarding use of Schneider Electric Products


Schneider Electric products are not designed with components and testing for a level of reliability suitable for use in or in
connection with surgical implants or as critical components in any life support systems whose failure to perform can
reasonably be expected to cause significant injuries to a human.

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

Upcoming Document Versions


New items or updates would be considered in upcoming versions of this manual.
Readers finding obsolete or incorrect information, please contact us in order to amend in upcoming manual versions.

> 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

2. WebHMI User Manual


The WebHMI user manual provides a functional and technical description of WebHMI, and a comprehensive set of
instructions for WebHMI use and application.

2.1 Chapter’s description


WebHMI user manual contains chapters below:
Chapter Safety (SA)
This chapter contains the safety instructions, handling and reception of electronic equipment, packing and unpacking parts,
Copyrights and Trademarks.
Chapter Introduction (IT)
This chapter contains the description of each chapter of the WebHMI guide. It is a brief introduction to WebHMI capabilities.
Chapter Functional Description (FT)
This chapter contains description of the product. It describes the functions included in WebHMI.
Chapter Technical Data (TD)
This chapter contains the technical data including, accuracy limits, recommended operating conditions, ratings and
performance data.
Chapter HMI, Local control, and user interface (HI)
This chapter contains the operator interface description, Menu tree organization and navigation, Setting/configuration
software.
Chapter Application (AP)
This chapter contains a brief introduction to WebHMI capabilities.
Chapter Installation (IN)
This chapter contains the installation procedures.
Chapter Commissioning record sheet (RS)
This chapter provides detailed record sheets to commission WebHMI.
Chapter Settings (ST)
This chapter contains the list of the setting with defaults value and range of the WebHMI.
Chapter Maintenance, Fault finding, Repairs (MF)
This chapter provides advice on how to identify failure modes, fault codes and describes the recommended repair actions.
Chapter Problem analysis (PR)
This chapter provides practical examples of problem solving and company contact information. It includes all information on
the self-checking features and diagnostics of WebHMI.
Chapter Lexical (LX)
This chapter contains lexical description of acronyms and definitions of WebHMI.

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

Recommended configuration for WebHMI


Processor Core i7
Hard Disk At least 80Gb hard disk
Memory 8Gb RAM
Graphics card Chipset frequency: 1266 MHz / Video memory Video memory: 2 Go RAM
Resolution 1920 x 1080 pixels

Recommended configuration for WebHMI and KPI monitor


Processor Core i7
Hard Disk At least 80Gb hard disk
Memory 16Gb RAM
Graphics card Chipset frequency: 1266 MHz / Video memory Video memory: 2 Go RAM
Resolution 1920 x 1080 pixels

Recommended configuration for WebHMI and KPI monitor and EcoSUI


Processor Core i7
Hard Disk At least 80Gb hard disk
Memory 32Gb RAM
Graphics card Chipset frequency: 1266 MHz / Video memory Video memory: 2 Go RAM
Resolution 1920 x 1080 pixels

2.2 Operating systems

Operating systems supported are:

64bits

Windows® Server 2019 (64bits)


Windows® Server 2016 (64bits)
Windows® 10 (64bits)

2.3 EcoSUI version

EcoSUI version 2.4.19211 or upper

2.4 Minimal Web browser version

Chrome© version 78.0.3904.108 or upper.


Chrome© is a registered trademark of Google™.
Chrome© is available here.
TECHNICAL DATA WEBHMI/EN TD
WEBHMI Documentation Page 3/8

3. Capabilities
The cardinality limits of the different components of a WEBHMI are described in the chapter Maintenance of this user
manual.

3.1 General Architecture

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.

SBUS servers shall be declared according to their peer of CentralDBs.

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:

Per SBUS Server Limits


Maximum quantity of Datapoints 120 000
Maximum quantity IEC 61850 Servers 500
Maximum incoming continuous dataflow per second 400 Measures + 100 Digital inputs
Maximum quantity of acquisition instances 12

3.5 Time synchronization

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

Events module displays EcoSUI event logs. Information displayed is:

• Sync status of archive entry


• Date of the event
• Origin of the event
• Description of the type of information
• Message associated to the event
• Origin of the command

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.

The following chart represents evolution of display delay.

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.

For SMS notifications, two options are possible:


1. GSM module. Limitations depends on GSM provider.
2. TWILIO. In https://www.twilio.com, create an account with a phone number which corresponds to your country.
Limitations then, depends on your country since TWILIO does not provide the same service everywhere.
TECHNICAL DATA WEBHMI/EN TD
WEBHMI Documentation Page 7/8

3.11 Dashboards

For Token/License, refer to § 16 Dashboard of chapter HI.

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.

Architecture with KPI Monitor plugin for Analytics (option)


KPI Monitor is the analytics plugin for WebHMI required to implement Dashboard module in WebHMI application.
KPI Monitor can manage data from up to 25 EcoSUI DBs (25 main + 25 backup) for Dashboard module reports and
visualizations. Once the data has been collected, it is stored locally (in a compressed format) within the PC running
WebHMI with the KPI monitor plug-in. Therefore, this data is available for Dashboards even if the communication with the
source DBs is lost.
KPI Monitor handles redundancy retrieving archived data from WebHMI Server Main or Backup.

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

Data (ROOT PATH) C:\MCIS\Qlik\02_ASSET_MONITOR\3_QVD\00_RAW\DATAS

Archiving cycle generates .qvd raw data files stored in this location.

Values <ROOT PATH>\<DB_NUMBER>\values_xx.qvd (xx = 0 to 99)


<DB_NUMBER> = 0 for the central DB
<DB_NUMBER> = 1 to 25 for each additional database configured.

Events <ROOT PATH>\events.qvd


events.qvd is the concatenation of events tables of each EcoSUI DB configured:

Objects <ROOT PATH>\objects.qvd

Objects states <ROOT PATH>\object_states.qvd

object.qvd is the concatenation of object tables of each EcoSUI DB database configured


object_states.qvd is the concatenation of object_state tables of each EcoSUI DB database
configured

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

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

1. Scope of the document


This document is a chapter of WebHMI documentation binders. It is the functional description WebHMI.

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:

Figure 1: General architecture

WebHMI is based on a Node.js web server which interacts with:


• SBUS server to obtain real-time values
• Licensing module of EcoSUI.
• CentralDB (Central Data Base) to get access to archived data.
• Web browser to display user interface.
• SLD and system SVG files from HMI Studio.

2.2 Functional specification

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

How to Use WebHMI


User shall open certified web browser (see chapter TD Technical data). In the address bar, type https://[Web server
address].

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.

Version & release


Schneider Electric solution and/or system’s device features evolves. Therefore, WebHMI will experience evolutions and
corrections referenced by version.

A unique reference determines the coherent set of software/hardware that WebHMI can be use.

2.3 External interface

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

Figure 2: External interface

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:

• Real-time values in SBUS server.


• Archived values in CentralDB.
• User login username/password with cybersecurity module.

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

2.4 Human interface

At initial start-up, WebHMI displays user login splash screen :

Figure 3: Login screen

After a successful login, first page displayed is home page:

Figure 4: Home page


FUNCTIONAL DESCRIPTION WEBHMI/EN FT
WEBHMI Documentation Page 5/5

Navigation between tabs is done according to following site map:

Figure 5: Site map

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

Measurements value display “System” module .................................................................................. 43


11. Single Line Diagram ....................................................................................................... 44
Measurements value display “SLD” module ....................................................................................... 45
12. Controls .......................................................................................................................... 47
Generalities ......................................................................................................................................... 47
Pop-up control windows ...................................................................................................................... 47
13. Reports............................................................................................................................ 50
Report App in KPI Monitor .................................................................................................................. 51
Reports Toolbox in WebHMI ............................................................................................................... 60
Edition mode ....................................................................................................................................... 62
Display mode ...................................................................................................................................... 65
Storing Reports ................................................................................................................................... 66
14. Disturbances................................................................................................................... 67
Toolbox ............................................................................................................................................... 67
Curves view ........................................................................................................................................ 68
COMTRADE details ............................................................................................................................ 69
Noise/Radar/Phasor Areas ................................................................................................................. 69
Trends viewer addition ........................................................................................................................ 70
15. Notifications.................................................................................................................... 71
Notifications Toolbox .......................................................................................................................... 71
Triggers Configuration ........................................................................................................................ 72
History View ........................................................................................................................................ 75
16. Dashboard....................................................................................................................... 76
Maximum token license Qlik© ............................................................................................................ 77
Dashboards Toolbox ........................................................................................................................... 77
Additional Tools .................................................................................................................................. 78
17. Dashboards pages ......................................................................................................... 89
Report Events and Alarms .................................................................................................................. 90
Mapping Thresholds ........................................................................................................................... 91
Trends MV .......................................................................................................................................... 94
Events and Alarms .............................................................................................................................. 95
Energy ................................................................................................................................................. 96
Main Dashboard.................................................................................................................................. 97
IEC 61850 ........................................................................................................................................... 98
Report MV ........................................................................................................................................... 99
One Bay KPI View ............................................................................................................................ 100
Heatmap Events ............................................................................................................................... 101
18. On Demand App Generation (ODAG) .......................................................................... 102
19. Embedded Views .......................................................................................................... 103
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 3/103

1. Scope of the document


This document is addressed to WebHMI users, the web graphical user interface of EcoSUI. This guide focuses on the User
Interface or Human Machine Interface and functionalities of the WebHMI engineering tool.

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.

This document is valid for version upper than WebHMI 1.2.1

Dashboard module is available from version 3.5.1.0

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.

WebHMI is one of the HMI solutions covered by the EcoSUI suite. It


extends hardware device capability of EcoSUI solution by adding
HTML5 compatible devices.

WebHMI communicates with other EcoSUI modules:

• Web Server
o Entry point for web clients
o Gets live values from SBUS server
o Gets archived data from central data

• SBUS Servers (Acquisition Module)


o Gets Live values from SBUS equipment Figure 1 : EcoSUI solution architecture
o Sends commands

• 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:

Figure 2 : Workspace layout


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 5/103

Header

The header banner shows:

• WebHMI graphic logo


• WebHMI product name
• Generic buttons (Home | import | export | print)
• Customer logo
• Computer name, connected Webserver, date and time
• Alarm banner with Speaker control
• User controls (login/logout | language | help)
• Username
• User profile

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.

Figure 3 : Navigation bar at WebHMI opening

Figure 4 : Navigation bar at WebHMI opening with Toolbox open

Figure 5 : Selected tab

Toolbox

Figure 6 : Adaptative toolbox


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 6/103

Toolbox is a hide/unhide window which proposes tools depending on active window. It covers following functions:

Functions Alarms States Live Archived Trends Reports


Events Events

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

NOTE: There is no toolbox for Home page.

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.

To create a new filter


In Toolbox pane, make needed selections. Workspace will display data according to selections:

Filters configuration

Select Signal types

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:

Click the Save Filter icon to save filters.


A popup appears, enter a name for the new filter. To share Filters, click Public, otherwise Filters remain private.
Filters can be shared/unshared at anytime, and the name can be modified. To do so, select a filter and click the pen icon to
edit the filter configuration.
Use cross icon to delete a filter.

Delete filter

Enter filter name


Click to share

General Functions

WebHMI icon

The Schneider Electric logo is displayed on the top left hand corner of the screen:

Figure 8 : Eco SUI icon position on header

Product name

WebHMI product name is displayed near product logo:

Figure 9 : Eco SUI product name on header

Generic controls

These icons are active for all potential active tab. Function behind them should adapt their reaction in function of the active
tab.

Figure 10 : Generic controls on header

Home. Return to the Home page open on full size workspace


Export: Export data from current tab in Microsoft Excel format .xls or Coma Separated Value .csv
Import: Import data from Microsoft Excel format .xls or Coma Separated Value .csv files in current tab
Print: Print current tab or global view

Icon dynamic is: Normal Over Selected


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 8/103

Customer logo

Customer logo is embedded in Medium. If no customer logo is defined, partnership icon is the default logo:

Figure 11 : Customer logo on header

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.

Figure 12 : Information box on header

Alarm banner

The last alarm window is always present on the WebHMI, whatever the view displayed, or the function called.

Figure 13 : Alarm banner in header


Its behavior is the same as the Alarms tab with adaptative column in function of screen size. Customer with acknowledge
and/or clear right can acknowledge and/or clear directly alarm from this panel.
On right there is a mute Speaker control. Customer can mute computer from this button. Button is also an indicator of alarm
activity. Mute control goes from green background for no issue to red for any active alarm.

Active alarm is present


No alarm detected

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.

Figure 14 : Users controls on header

User name and profile

Username and its profile are displayed in top-right corner. When no user is logged, by default username is: Public with Visitor
profile.

Figure 15 : Username and profile on header


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 9/103

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.

Default users in EcoSUI Standard are the following:

User Password Profile

AdmOdyssey Odyssey Administrator

admin schneider Administrator

public schneider Operator


NOTE: For security reasons, passwords need to be changed after first login.

For EcoSUI Secured users are managed by the CAE application (Cybersecurity Admin Expert). Learn how in CAE user
manual.

Default users in EcoSUI Secured are the following:

User Password Profile

SecurityAdmin AAAAAAAA Security Administrator

DefaultEngineer AAAAAAAA Engineer

DefaultOperator AAAAAAAA Operator

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:

Figure 16 : Login screen


The user has to enter username, then password, select whether to record credentials and ENTER or click OK.
After a login, the username and its profile are displayed in the title banner.

Profiles Viewer Operator Engineer

View X X X

Control on SLD/System X X

Control on States viewer 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.

At first start of WebHMI, pop up indicates 3 phases:


• Populate => WebHMI loads database on web browser
• Checking => WebHMI tests database coherency
• Done

In next restarts of WebHMI only two steps will be processed:


• Checking data => WebHMI tests database coherency
• Done

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.

Figure 17 : open user management "Add tab"

User panel

Figure 18 : “Users” main panel

The following dialog box opens with the following panes:


• Rights pane. This is the list of possible actions to be assigned to a profile.
• Users pane. This is the list of available users in the EcoSUI server.
• Profiles pane. This is the list of available profiles in the EcoSUI server.

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

Four profiles exist by default:


• Administrator
• Engineer
• Operator
• PME
Administrator profile has full rights. Administrator profile is neither modifiable nor removable. The other profiles are modifiable
and removable.

Figure 19 : “Users” profile panel

To add a profile, do the following:


Step Action
1 Click on “Add a profile” to open Profile popup.

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.

To modify a profile, do the following:


Step Action
1 Select the profile to modify on Profile panel.

2 Click on “Modify selection” to open Profile popup.


3 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.
4 Set the name of the profile on “Profile information” textbox.
5 Click on “Confirm” button to set the new parameters.

To remove a profile, do the following:


Step Action
1 Select the profile to remove on Profile panel.

2 Click on “Delete selection.


3 A confirmation popup appears, click “OK” to validate the delete.

NOTE: The profile Administrator is not removable.


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 13/103

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.

Figure 20 : “Users” users panel

To add a user, do the following:


Step Action
1 Click on “Add a user” to open User popup.

2 Select on panel Profiles the profile to affect to the user.


3 Set the information:
- Username: max 255 characters
- Password: max 255 characters
- Mail address: valid email address
- Phone number: valid phone number
4 Click on “Confirm” button to create the new user.

To modify a user, do the following:


Step Action
1 Select the user to modify on User panel.

2 Click on “Modify selection” to open User popup.


3 Select on panel Profiles the profile to affect to the user.
4 Set the information.
5 Click on “Confirm” button to set the new parameters.

To remove a user, do the following:


Step Action
1 Select the user to remove on User panel.

2 Click on “Delete selection”.


3 A confirmation popup appears, click on “OK” to validate the delete.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 14/103

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:

Inactive tab Active tab

Navigation bar functions

Open tab

In order to open a tab, use Add tab on main navigation bar:

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

Click the cross icon in the tab to close it:

Figure 21 : Delete "system" tab


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 15/103

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:

• SPS (single point),


• DPS (double point),
• MPS (multiple point),
• State and value of Measurements
• State and value of Control values
• Users activities

Information displayed in the state viewer are all real-time.

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:

Figure 22 : State viewer shows live values

Information displayed on the Live Status display is:

• 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

Measurements Value Display “States” module


In the WEBHMI, according to the quality of the datapoint the user needs to display the value of the measurements, in the
“SLD”, “System”, “States” and “Trends” modules.

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.

Click the Expert menu in the Parameters view.


NOTE: To enable this menu, switch the setting edition to Expert mode in the Parameters view.

Figure 23 : Parameters view Expert menu in WEBHMI

The Expert parameters appears on the screen.

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

Parameter configured in the “States” module is shown in the below table


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 17/103

Figure 25 : "States" module Value Display Configuration table according to the Qualities

Measurements value display examples for the “States” module

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

States tree filter


Toolbox displays a tree view of the database, which is used as a filter.

Figure 28 : States toolbox tree viewer


Filter the information to display by checking/unchecking boxes in the navigation tree. Only information from checked boxes
will be displayed.

States keyword filter


The keyword filter in toolbox allows users to find signals search engine. Keywords look for origin, description or origin to find
one or more words.

Figure 29 : States toolbox keyword filter


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 20/103

States category filter


The Category filter is a complementary filter useful to find signals per category:

Electric signals

System signals

Measurements

Strings

User controls

All

Figure 30 : States toolbox signal filter


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 21/103

Signals count
Counter which represent number of displayed signals on states viewer.

Figure 31 : Signals count on states viewer toolbox

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.

Figure 32 : Print states


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 22/103

States Export
Exporting States of the current page is possible by clicking Export button.

Two export options are proposed:

• Export States as a Comma Separated Value text file (CSV)


• Export States as a Microsoft Excel Workbook (XLS)

Files are automatically downloaded in default download folder of user computer.

Figure 33 : Extract states


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 23/103

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.

Use the switch selector button to select Live or Archive mode.

Figure 34 : Live/Archive switch button in live position on Events toolbox

Events archive display


The Archive display shows datapoints origin, description, message and date / time:

Figure 35 : Events archive display

Information displayed on the Archive display is:

• Sync status of archive entry


• Date of the event (NOTE that the default date format is yyyy/mm/dd hh:mm:ss.mmm)
• Origin of the event
• Description of the type of information
• Message associated to the event
• Origin of the command
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 24/103

Event log tree display


The left part of the window displays a tree view of the database, which is used as a filter. Only events with checked boxes
display on the Event Log Archive Display.

Figure 36 : Events archive treeviewer on toolbox

Event log archive sorting


Sorting options can be applied by clicking the column title:

• 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

Event log archive manual time window selection


Sorting options can be applied by clicking the column title. The calendar window opens allowing the user to sort information
on a period of time:

Figure 37 : Date filter on events archive toolbox

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

Event log archive preset time window selection


Events can be extracted from archive central DB by selecting a default period. Period button is on Date filter module in events
archive toolbox.

Different preselected period options are available:

• Last 5 minutes
• Last Hour
• Last Day
• Last Week
• Last Month

Figure 38 : Extraction by period on events archive toolbox

Event log archive printing


Two options are available:

• Print all Events (print all filtered events)


• Print Events of this page (to print event of this screen)

Figure 39 : Print function on events archive


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 27/103

Event log archive export


Export of the Event Log Archive is possible by clicking the Export button.

Three options are available:

• Export all events (filtered events)


• Export events of this page as CSV file (events shown on the screen)
• Export events of this page as a XLS file (events shown on the screen)

Figure 40 : Extract function on events archive

Files are automatically downloaded in default download folder of user computer.

Events live display


The Event Live displays the last 100 events with their datapoint origin, description, message and date / time that happen in
real time.
Click on the “Live” button in toolbox to display this information.

Figure 41 : Live mode for events


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 28/103

Events live print


The Event Log Live Print function is active only when the acquisition is paused. The available options are:

• Print all Events (filtered events)


• Print Events of this page (events of this screen)

Figure 42 : Print events live

Events live export


Export of the Event Log Live is possible by clicking the Export button.

Two options are available:

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

Figure 43 : Extract events live

Files are automatically downloaded in default download folder of user computer.


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 29/103

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 have the following states:

• Inactive: no transition, no event


• Active-acknowledged: the cause is still present, but the active state has been taken into account by the operator
• Active-unacknowledged: the cause is still present, and the active state has not been taken into account by the operator
• Inactive-unacknowledged: the cause has disappeared, but the inactive state has not been taken into account by the
operator (only available for events alarmed on appearance and disappearance)
• Inactive-acknowledged: the cause has disappeared, and the inactive state has been taken into account by the operator
• Inactive-active-unacknowledged: the cause has disappeared but the active state (previous state) has not been taken
into account by the operator

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.

Parameters associated with an alarm


The following user-selectable parameters can be associated with each alarm definition. The values are set during the
configuration phase and can be specific to each defined alarm:

• 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

Figure 44 : Acknowledgement matrix


Transition events:

• AL+ alarmed event appearance


• AL- alarmed event disappearance
• ACK operator acknowledgement of the alarm
• CLEAR operator clearing of the alarm

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.

The audible alarm is activated anytime a new alarm is coming.


Audible alarms can be stopped at Web HMI level by acknowledging the audible alarms the stop klaxon button in the command
banner. This “audible acknowledgement” can be done from any Web HMI.
It is global (i.e. it applies to all the audible alarms present in the substation); it concerns only the audible aspect of the alarm
(i.e. the alarm state remains the same in the alarm list: « unacknowledged “).

The audible alarm can be performed by PC Speaker.

An operator can stop the klaxon by a dedicated icon displayed on 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.

Figure 45 : Alarms tab

Alarms tree filter


The left part of the window displays a Tree, corresponding to the database, and used as a filter. Only alarms of a checked
node on tree are displayed on alarms tab. Treeviewer of alarm tab is colorized to retrieve easily path with active alarm.

Figure 46 : Alarm treeviewer


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 33/103

Alarm User Interface

Alarm acknowledgment is available for user with alarm acknowledgment right.


Alarm clearing is available for user with alarm clearing right.
Rights are configurable on user’s profile.

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.

Click on “Click to acknowledge” to acknowledge an alarm selected or not.


Click on “Clear” to clear an alarm selected or not.

Multiple alarm selection

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

Acknowledgment and clear action

”Acknowledge all” button allow user to acknowledge all acknowledgeable alarm.


“Clear all” button allow user to clear all clearable alarms.

The buttons and appear when one or more alarm is selected, instead of “Acknowledge all” and “Clear all”
buttons.

Click on button to acknowledge all acknowledgeable and selected alarms.

Click on button to clear all clearable and selected alarms.


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 35/103

Alarms Page Print


Click on Printer button to print alarms. The two options are:

• Print all Alarms, filtered alarms are printed


• Print Current page, alarms showed on the current page are printed

Figure 47 : Print alarms

Alarms Page Export


Click on Export button to use export functions. The options are:

• 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

Figure 48 : Export alarms

Stop Speaker function


Click on “Stop Speaker” button to stop the Audible alarm (Speaker), available for user with rights. It is disabled for operator
without sufficient rights. The Audible alarm is still active and ready to react to a new alarm.

Figure 49 : Stop all Speakers

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

Toggle mute function


Click on “Toggle Mute” button deactivate the Audible alarm, available for user with rights. This option is useful in case of
maintenance operations.

Figure 50 : Stop computer Speaker

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.

Figure 51 : Alarms counts


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 37/103

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.

Figure 52 : Trends tab


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 38/103

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.

Figure 53 : Curves library on trends toolbox

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

Figure 54 : Signals list on trends tab


Signals list could be hidden/unhidden or extended to give more visibility to signals list or trends.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 39/103

Trends toolbox treeviewer

Trends toolbox treeviewer affects directly signals list. It filters available signal in signal list to help user to find easily a specific
signal.

Figure 55 : Treeviewer on trends toolbox

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.

Figure 56 : Search keywords on trends toolbox


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 40/103

Create curve

Select a Curve from the library

Figure 57 : Add a curve on trends tab

Add signals

To add one or more signal, simply click a signal in the Signal List panel at the bottom of the view:

Figure 58 : Add signal on curve


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 41/103

Change curve properties

On each curve selected in signal list, pen list display a rectangle. By clicking on it curve property appears.

Figure 59 : Curve properties view

On this window, user can modify:


• Curve title
• Change curve shape
• Change pen colors

Change display period and sample


User can modify sample size with sample buttons.

Figure 60 : Sampling bar


Period to observe can be set by two ways. On one hand, the schedule input box and on the other hand timeline navigation (if
it is activated on curve properties).

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.

Figure 62 : Time modifiers on trends tab

Measurements value display “Trends” module

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

10. System Architecture


System represents real-time status of network architecture. This architecture is scalable vector graphic which allow
zoom/unzoom and cluttering functions.

Figure 63: System architecture

Measurements value display “System” module

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

11. Single Line Diagram


According to the rights associated to the user, any object (dynamic or static) can be displayed or not.

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.

WebHMI can display numerous types of data, such as:

• Single Point Status (SPS)


• Double Point Status (DPS)
• Multiple Point Status (MPS)
• Measurement Values (MV)

Datapoints status can be displayed on the WebHMI to represent dynamic objects, such as CB position, Analog values, devices
status, etc…

The datapoint actual value is read directly on the SBUS Server.

Figure 64: Single line diagram

Mea
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 45/103

Measurements value display “SLD” module


In the WEBHMI, according to the quality of the datapoint the user needs to display the value of the measurements, in the
“SLD”, “System”, “States” and “Trends” modules.

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.

Parameter configured in the “SLD” module is shown in the below table

Figure 65 : "SLD" module Value Display Configuration table according to the Qualities

Measurement value display examples for the “SLD” module

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:

• Success ! Order executed


• Order In Progress
• Failed ! Device is Disconnected
• Failed ! Device Failed to Operate
• Failed ! Position Reached
• Failed ! Command Already In Execution
• Failed ! Object not selected
• Failed ! Invalid Position
• Failed ! Blocked by Interlockings
• Failed ! Blocked by SynchroCheck
• Failed ! Blocked by Switching Hierarchy
• Failed ! Step Limit
• Failed ! The Limit is Over
• Failed ! Computer not Ready
• Failed ! Automation Running
• …

WebHMI sends the control to the SBUS Server and SBUS Server reports back the feedback status to WebHMI.

Pop-up control windows


Command buttons (Local/Remote control for instance) or sensible area around a controllable device (circuit breakers,
disconnectors for instance) are available on Views Display area every time they are needed.

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.

Figure 68: Direct execute control popup


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 48/103

Direct Execute Action

We have one Action.

DatapointName;0 or 1 -> Send 0 (OFF or RESET) or 1 (ON or SET) to the xPC

Remark: In the equation that permits to enable/disable the button, the configuration engineer may have to put:

• interlock xPS, to prevent sending the control if it is forbidden


• order running xPS, to prevent sending the control if the control has already been done
• device position xPS, to prevent sending a close command on a closed device or open command on a open device

Select Before Operate Actions

There are 3 different Actions.

SBO_SELECT DatapointName;0 or 1 -> Select xPC


SBO_EXECUTE -> Execute xPC
SBO_CANCEL -> Cancel xPS Selection

Figure 69: SBO with ByPass: dependencies configured

Figure 70: SBO without ByPass: no dependency configured

Remark: Like for Direct Execute, in the equation that permits to enable/disable the selection buttons, the configuration
engineer may have to put:

• interlock xPS, to prevent sending the control if it is forbidden


• order running xPS, to prevent sending the control if the control has already been done
• ice position xPS, to prevent sending a close command on a closed device or open command on an open device

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

The Setpoint control popup is used to set analogue value.

Figure 71: SetPoint popup


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 50/103

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.

Use Reports module for:


• Getting reports in Display and Edition mode.
• Report templates design via KPI Monitor add-on.
• On-demand report generation from templates according to filtered data.
• Schedule report task from template according to filtered data.

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:

Toolbox Add tab Reports module Navigation bar

Analytics jsreport Data is displayed here


(historical) (real time)
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 51/103

Report App in KPI Monitor


WebHMI is delivered with Report Application (App) built in KPI monitor environment powered by Qlik Sense® solution. Report
App is a collection of reusable data items (measures, dimensions, and visualizations), sheets and stories. Report App uses
automated ETL (Extract, Transform and Load) process with scripts to load EcoSUI data into WebHMI every day.

EXTRACT TRANSFORM LOAD and GENERATE

EcoSUI KPI WebHMI


MONITOR

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:

ANALYTICS TEMPLATES STORIES


Reports module in WebHMI Report App in KPI monitor environment (Qlik)

Open Hub
(Qlik)

Templates
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 52/103

How to create and configure sheets and stories in Report app

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:

Click to open Sheet

This is a Sheet of Report app:

Charts/Custom Objects library Data Visualization Sheet properties


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 53/103

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:

Create new sheet

Create new 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.

To start adding items


Click on a created sheet, then click Edit to add Charts and Custom objects. When finished click Done to apply changes.
For WebHMI, learn in below Chart and Custom objects sections which are the available elements for visualization.
To learn more, refer to Qlik help documentation in these links:
https://help.qlik.com/en-US/sense/November2019/pdf/Create%20apps%20and%20visualizations.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 54/103

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

Text & image

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

Enter a Snapshot annotation to identify the snapshot, then click Save:

Now the snapshot is ready to be used when building a story.

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

In WebHMI, open Reports module, then select Edition mode.


In Models tab, click Open Hub icon to go to KPI monitor environment.
Go to Stories, click on Create new story button or window::

Create new story

Create new 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:

Tool Available / Unavailable

Snapshot library

Title and text

Images

Shapes

Effects library

Sheet library
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 59/103

How to change the sorting of a visualization

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:

The sorting is either ascending or descending. The sorting options are:


• Sort by expression (Enter an expression to sort by. Only available for dimensions.)
• Sort numerically
• Sort alphabetically

When finished click Done to apply changes.

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

Reports Toolbox in WebHMI


In WebHMI, Reports Toolbox tools vary according to selected Reports mode.

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

Toolbox in Display mode

Display mode Toolbox contains the following Task tools which are only active upon selection of report template:

This table describes the Task tools in Display mode toolbox:

Tool Description and features

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.

Toolbox in Edition mode

Edition mode Toolbox contains the following tools.

Models tools
Models tools are only active upon selection of report template and with items selected in Signal list pane:

This table describes the Models tools of Edition mode toolbox:

Tool Description and features


Click Open Hub to enter KPI monitor environment (Qlik) to update, delete, create or
publish/unpublish templates/stories.
Open Hub Hub is only accessible to users with CONFIG role assigned.

Click Render report to download report file.


Render report Only pdf format is available.
Click Add task to create and schedule a new task.
Go to Display mode to see added tasks in Analytics. Select related template to
Add task see/expand the added/s task/s.

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

Electric signals Measurements Controls

System signals Strings All signal types


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 62/103

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.

Then, in Models, select a report template from jsreport or Analytics view:

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

Render Report (On-demand Report)

To render a report (on-demand report)


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.

3. To generate the report, click on the Render Report icon

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

Add Task (Schedule Report)

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.

3. To Add a task, click on the Add Task icon


In the example below, this is the information selected: Signal Types= All; Site Map= NDERA 15kV; Signal list > Selection=
All (all selected); Models= Analytics > SIMPLE TABLE (template):

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

The user can find on-demand reports in C:/MCIS/WebHmi/qlik/report/OnDemand as shown below:

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

The tasks folder contains:


• pdf files: The list of reports generated by Add task function.
• settings.json: Task settings.
• history.json: Reports Generation history.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 67/103

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

Figure 72: Disturbance viewer

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.

Figure 73: Filter textbox

NOTE: Filter box is case sensitive.


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 68/103

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.

Figure 74: Curves view in disturbance

All curves can be manually resized by selecting the bottom part and using a drag and drop action to fit size.

On curves following actions are available:


• Resize
• Zoom in
• Click to refresh noise/angular view
• Tooltip on mouse over for more detail
• Hide or unhide signals with legends

Curves can independently be modified using the following tools:


Add curves Clear zoom Configure charts (signals) Delete

NOTE: Zoom in and out apply to all curves at one shot.


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 69/103

COMTRADE details
COMTRADE standard proposes an ID card for a recorded disturbance. This area provides data coming from COMTRADE
cfg.

Figure 75: COMTRADE ID card

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.

Figure 76: Phasors Figure 77: Radar

Figure 78: Noise


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 70/103

Trends viewer addition


On trends viewer, if it exists a disturbance file within the extracted period, a flag displays on curves and on timeline.
Click on it to open the disturbance viewer on the selected disturbance file.

Figure 79: Trend viewer


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 71/103

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:

This table describes the icons in the Notifications Toolbox:

NOTE: Duplicate Trigger and Delete Trigger are not enabled for On Disturbance File Occurrence and On Report File
Occurrence triggers.

Tool Icon Description and features

Click Add Trigger to create a new On data change detection trigger

Click Save Trigger to save changes.

Click Duplicate Trigger to make a copy of selected trigger.

Click Delete Trigger to delete selected trigger


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 72/103

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

Trigger Type Description

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.

On Disturbance File Occurrence

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

3. Add trigger description


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 73/103

On Report File Occurrence

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

3. Add trigger description

On Analytics File Occurrence

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

On Data Change Detection

User can create up to 10 On data change detection triggers.


In Notifications tab, go to Notifications Mode > Configuration > Triggers
To create notifications On data change detection triggers, following actions are available:
1. In Notification Toolbox click Add trigger icon .
2. In Trigger name, enter a name for the new trigger.
3. In Status, select Enable or Disable for the users who provided e-mail and mobile phone number details to receive a
notification whenever a change occurs on selected datapoints.
4. In Communications, check E-mail, SMS or both to choose how to communicate with users who provided e-mail and
mobile phone number details
5. Add a Trigger description if necessary.
6. In Site map, choose an item in order to display in the Signal list pane the datapoints contained.
7. In Signal list pane, select one or several datapoints for the user to receive a notification whenever a status change
occurs on any of them.
8. In Parameters pane, previous selected datapoints are displayed. Go to the drop-down list of the datapoint and select
the value which will trigger notification. Check Apply to similar signals to enter the same value in datapoints with the
same profile.
9. Click Save Tigger icon to save changes.

8. Parameters with
2. Trigger name
selected datapoints and
4. Communications drop-down list
1. Add trigger 3. Status

5. Add trigger description

6. Site map 7. Signal list


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 75/103

History View
History menu displays issued notifications.

In Notifications tab, go to Notifications Mode > History

History view contains following information:

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

This is an example of a notification message content:


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 76/103

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.

Only the following MySQL tables of EcoSUI are extracted:


• Object
• Events
• Values_x (x=(0 to 99))
• Object_state

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

Maximum token license Qlik©

Qlik© license determine the number of session available.


If the maximum number of users is reached, then the following popup message appears.

When a user connects to Dashboard, it uses one token.


The token is dedicated to this user for 7 days.
It is not possible for another user to use this token during these days.
It is not possible for the user to cancel his token, even by disconnection or logout.
When user is connected to server, the token is active.
When user is disconnected from server, the token remains in quarantined time during 7 days from latest connection of user.
Token allow 5 simultaneous sessions per user.

Dashboards Toolbox

Dashboards Toolbox contains the following tools which are common for all the Dashboard pages:

This table describes the icons in the Dashboards Toolbox:

Tool Description and features

Click Refresh Events to retrieve archived events from source (EcoSUI SBUS).

Events in currently dashboard page will update automatically.


Refresh Events
Analog values are retrieved once a day at midnight.
Minimum, maximum and average values are calculated on one-hour time range.

Click Open Hub to enter KPI Monitor environment.


Hub is only accessible to users with CONFIG role assigned.
Open Hub

Click Launch On Demand App Generation to generate a detailed Dashboard or App.


ODAG is only available for Energy, Trends MV and One Bay KPI View Dashboard pages.
Launch ODAG

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

Use this tool to display chart source data in table format.

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

Use this tool to export chart as an image to a jpeg or png file.

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

Use this tool to export chart to a PDF file.

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

Use this tool to export chart source data to an Excel file.

Select chart, right-click on it, then from menu select Export data:

Excel file is generated automatically. Click the link to download file:

The excel file will contain all chart source data:


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 82/103

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:

Selection Bar 2. Filters 1. Click on chart for date selection


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 83/103

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:

This table describes the icons in the Selection Bar:

Icon Icon Label and Action Description

Step back in selection history in same dashboard page (e.g.: after clearing a selection, click step
back to re-set it).

Step forward in selection history in same dashboard page.

Smart search (learn here how to use it).

Clear selections.
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 84/103

Selection Tools in Charts

By clicking on a chart, the user can choose one or several items or elements.

In this chart several dates have been selected (in green):

Confirm selection to get an accurate chart view with selected dates:


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 85/103

The following selection options are available:

Selection options

This table describes the icons available for item selection in charts:

Icon Icon Label and Action Description

Confirm selection to validate selection.

Choose one or several items on the chart, then click Confirm selection icon to validate
selection.

Cancel selection to stop and close selection tool.

Turn on Lasso selection to select a group of items by surrounding them with the Lasso tool.

Clear selection to cancel selection and start a new selection.


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 86/103

Selection Tools in Filters

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:

Icon Icon label and action description

Confirm selection to validate selection.

Choose one or several items in the list box, then click Confirm selection icon to validate selection.

Cancel selection to stop and close selection tool.

Clear selection to cancel selection and start a new selection.

Selection menu. Every filter provides the following selection states (see table below):

Close selection menu


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 87/103

This table describes the different selection states:

Selection state and color Description

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

Selected (green) Selected item

Selection state color is also visible in the small bar at the bottom of the filter name:

Selection state color Selection state color

Possible (white) Selected item (green)

Alternative (light gray)


Excluded (dark gray)

Lock and Unlock Selections

A selection can be locked/unlocked only from the Selection bar.

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.

To unlock the selection, click the lock icon again.


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 88/103

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.

Smart Search is available on the Selection Bar by clicking .

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

Once a result is selected, selection will be displayed in the Selection Bar:


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 89/103

17. Dashboards pages

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:

MV= Measurement Value

Dashboard page name Description

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.

Energy This page monitors last 24 hours MV metrics.

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

Report Events and Alarms

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.

NOTE: Use Refresh Events tool to update events on Dashboard page.

1. Login KPI 2. Events KPI 3. Alarms KPI

Filters 4. Table chart


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 91/103

Mapping Thresholds
Use Mapping Thresholds dashboard mainly to visualize measurement value thresholds: minimum, maximum and averages.

NOTE: Remember analog values are refreshed every day at midnight.

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.

A date or a range of dates can be still selected from a different page.

Filters Measurement values Thresholds


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 92/103

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

CSV file format is as follows:


1. Header titles in the following order, separated by semicolons and always in the first line:

- object_uid32
- object_threshold_min
- object_threshold_max
- object_threshold_avg

2. Datapoint ID (object_uid32). It is the unique number which identifies a datapoint.


3. Minimum threshold value (object_threshold_min) below which Min value retrieved will be visualized in red in the
chart.
4. Maximum threshold value (object_threshold_max) beyond which Max value retrieved will be visualized in red in the
chart.
5. Average threshold value (object_threshold_avg) below which Average value retrieved will be visualized in red in the
chart.

1. Headers

3. Minimum threshold value


2. Datapoint ID

4. Maximum threshold value

5. Average threshold value


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 93/103

Export CSV thresholds file from MySQL

To build the CSV thresholds file for Mapping Thresholds dashboard visualization, users can apply the following query in
MySQL query browser:

SELECT object_uid32 , object_thresholdLLL as object_threshold_min, object_thresholdHHH as object_threshold_max


, object_thresholdH as object_threshold_avg FROM objects;

H=High L=Low

Then, to export the result of the query go to File > Export as resultset > Export as csv file

Finally, save the exported file in C:\MCIS\Qlik\7_IMPORT\CSV\thresholds.csv

This picture shows the MySQL query to be executed:


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 94/103

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.

NOTE: Remember analog values are refreshed every day at midnight.

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

4. Metrics overall per MV


type
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 95/103

Events and Alarms

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.

NOTE: Use Refresh Events tool to update events on Dashboard page.

This screenshot shows Events and Alarms dashboard filtered by AVR device selection:

Table chart in tree view Treemap Line chart KPI

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:

1. Unit table to select or deselect a measurement.


2. Filters to filter selected measurement by substation, voltage, bay, device or description.
3. Column chart represents the average per hour of the selected measurement. This chart displays by default 24 hours,
but the user can select one or several hours by clicking on the corresponding column/s. Column chart visualization will
update based on the user’s selection (unit, filters, hour/s).
4. Gauge meters show the minimum, maximum and the average of selected measurement (analog values).Gauge
meters visualization will update based on user’s selection (unit, filters, hour/s).

NOTE: Remember analog values are refreshed every day at midnight.

2. Filters 1. Select measurement unit

3. Column chart 4. Gauge meters


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 97/103

Main Dashboard
Main Dashboard monitors events and historical information of the current project:

Main Dashboard page contains the following elements:


1. Gauge meters show the minimum, maximum and the average of a measurement (analog value) retrieved. Gauge
meters visualization will update based on user’s selection of unit (e.i.: Hz, KW, MVA, Mvar, …).
2. KPI with Alarms and Events counter with up-to-date overall. KPI will update based on user’s selection (filters).
3. Table chart shows retrieved measurements (analog values) sorted by substation, bay, voltage and/or other predefined
data. This data feeds Gauge meters (1), KPI (2) and Box plot (4) elements. Use filters on the top of the table to filter
data by substation, voltage, analog value and/or bay.
4. Box plot visualizes retrieved measurements per bay. Select or deselect items on the box plot to get a more detailed
visualization. Gauge meters (1), KPI (2) and Table chart (3) visualization will update based on selection.

NOTE: Remember analog values are refreshed every day at midnight.


NOTE: Use Refresh Events tool to update events on Dashboard page.

1. Gauge meters
2. KPI

3. Table chart 4. Box plot


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 98/103

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:

Bar chart KPI

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:

NOTE: Remember analog values are refreshed every day at midnight.

Filters
HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 100/103

One Bay KPI View


Use One Bay KPI View dashboard to easily visualize in a glance site energy performance mainly by bay. It contains the
following elements:

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

NOTE: Remember analog values are refreshed every day at midnight.


NOTE: Use Refresh Events tool to update events on Dashboard page.

KPI Box plot KPI Filters Line chart

Bar chart Table chart Column chart


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 101/103

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.

NOTE: Use Refresh Events tool to update events on Dashboard 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

Table chart Color-coded tiles


HMI, LOCAL CONTROL, USER INTERFACE WEBHMI / EN HI
WEBHMI Documentation Page 102/103

18. On Demand App Generation (ODAG)


In very large data volume environments, On Demand App Generation can load filtered data to have a more detailed
dashboard views.

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

Launch On-demand generation

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

19. Embedded Views


The user can display WebHMI views from EcoSUI. These views are called Embedded Views. To enable Embedded Views,
some actions need to be done in EcoSUI application.

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

To create embedded view mimic in EcoSUI


First, use SHIFT + CTRL + ALT + F12 shortcut to unlock EcoSUI mimic.
Add a Web browser object in the HMI of ECOSUI and fill in Browser_AutologinURL and Browser_AutologinPage
parameters as follows:
• Browser_AutologinURL to be equal to http or https]:\\your_address_of_webhmi:port\autologin
• Browser_AutologinPage can be equal to one of the following items:
- Disturbances
- Notifications
- Alarms
- Dashboard
- Events
- Reports
- SLD
- states
- system
- trends

In case embedded views are not correctly displaying


Open C:\MCIS\GENERAL.INI file and add the --show-console argument to [Browser] or [Chromium] parameter. This will
enable the browser console to display a message to help analyze the source of the displaying problem.

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.

2. Create Single Line Diagram view


User shall select a project on HMI Studio:

Figure 1: Select project on TPM

Existing projects can be reloaded by selecting the right .xhe file.

Figure 2: Select previous configuration


APPLICATION WEBHMI / EN AP
WEBHMI Documentation Page 3/7

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:

Figure 3: Select IHMI or General SLD


APPLICATION WEBHMI / EN AP
WEBHMI Documentation Page 4/7

On Configuration view, user shall modify:

• Clutters : Select/deselect data to be displayed and its zoom level.


• Description and panel: modify EPA-E value or add one.
• Bay edit: able to relocate data on template views.

Figure 4: Configuration view

On SLD view, user shall modify attributes to reduce spacing between bays and align primary devices.

Figure 5: SLD view


APPLICATION WEBHMI / EN AP
WEBHMI Documentation Page 5/7

3. Create System Architecture view


3.1 Prepare Architecture on PolDoc ARC

PolDoc ARC is required to create system architecture view. User shall draw its architecture in PolDoc Arc by using
predefined shapes in gabarit.

Figure 6: Drag and drop shapes in PolDoc ARC

Then, user shall set in each animated equipment its own network name. Select equipment in view and fill “Network Name”
field in custom properties.

Figure 7: Link equipment with its network name

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

3.2 Load architecture on HMI Studio

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.

On HMI Studio, import PolDoc Arc with its specific button.

Figure 8: Import ARC in HMI Studio


APPLICATION WEBHMI / EN AP
WEBHMI Documentation Page 7/7

4. Generate WebHMI SLD and System views


On HMI Studio, user shall use export function name “Export WebHMI”. Then copy paste on svg folder in WebHMI.

Figure 9: Export WebHMI on HMI Studio

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

2. Requirements before the installation of WebHMI software ................................................ 3


2.1 Operating system ....................................................................................................................................................... 3
2.2 EcoSUI version........................................................................................................................................................... 3
2.3 Windows 10 User Account (UAC) rules...................................................................................................................... 3
2.4 Computer name.......................................................................................................................................................... 3
2.5 WebHMI checks ......................................................................................................................................................... 3

3. WebHMI delivery package ..................................................................................................... 4


4. Install WebHMI ....................................................................................................................... 5
4.1 WebHMI detailed installation description .................................................................................................................... 5

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

6. WebHMI Configuration ........................................................................................................ 11


6.1 Login ........................................................................................................................................................................ 11
6.2 Information (viewer access) ..................................................................................................................................... 11
6.3 Information (Administrator access) ........................................................................................................................... 12
6.4 Parameters ............................................................................................................................................................... 12
6.5 General .................................................................................................................................................................... 13
6.6 Modules.................................................................................................................................................................... 13

7. Uninstall WebHMI................................................................................................................. 14
8. WebHMI SSL/TLS Certificate ............................................................................................... 15
8.1 Self-Signed Certificate.............................................................................................................................................. 15

9. WebHMI KPI Monitor plug-in installation (optional) .......................................................... 19


9.1 KPI Monitor Delivery Package .................................................................................................................................. 19
9.2 Before installing KPI Monitor verify that: ................................................................................................................... 19
9.3 Automatic Configuration ........................................................................................................................................... 20
9.4 Installation steps....................................................................................................................................................... 21
9.5 KPI Monitor uninstall ................................................................................................................................................ 26
9.6 Annex ....................................................................................................................................................................... 27
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 2/29

1. Scope of the document


The present document is a WebHMI chapter of the documentation binders. It describes the installation of this Web Human
Machine Interface plugins for EcoSUI.

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.

1.1 WebHMI outline

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.

1.2 Version & release

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

2. Requirements before the installation of WebHMI software


2.1 Operating system

WebHMI runs on Windows Operating System:

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

2.2 EcoSUI version

EcoSUI software must be installed on the WebHMI machine or reachable on the network.
EcoSUI version is 2.4.19211 or upper.

2.3 Windows 10 User Account (UAC) rules

• Install WebHMI software by an Administrator.

• Possibility to launch WebHMI software application without administrator rights.


WebHMI can be installed on a desktop or a laptop computer depending of the use of it:

• Server main

• Server redundant

• Support for commissioning

2.4 Computer name

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

2.5 WebHMI checks

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

3. WebHMI delivery package


The WebHMI delivery package can be provided by file or CD-DOM. It contains:

• A release note WebHMI_x.y_realease note.doc

• An installer program WebHMI_x.x.x.x.exe according to the following computer requirements:


o Installer for EcoSUI Secured
o Installer for EcoSUI Standard
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 5/29

4. Install WebHMI
WebHMI standard installation takes less than 3 minutes. It mainly creates C:\MCIS\WebHMI directory where it
decompresses delivered files.

4.1 WebHMI detailed installation description

Initial step is to launch WebHMI installer with double click on WebHMI_x.x.x.x.exe.


WebHMI is automatically configured depending on EcoSUI version (Secured or Standard).
NOTE: Cybersecurity tag is for EcoSUI only. WebHMI uses TLS/SSL technology with EAS 256 bits encryption for data
transfer.
First popup is for installer language selection. Note that this is not WebHMI interface language.

Figure 1: Select language

In the Welcome window, click Next to continue:

Figure 2: Welcome form

On the License Agreement window, read the license, then if you agree check I accept the agreement, then Next to
continue:

Figure 3: License agreement form


INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 6/29

Installation folder by default is C:\MCIS\WebHMI. Use Browse if you want to select a different one. Then click Next::

Figure 4: Install folder selection

Select Create a desktop icon and click Next:

Figure 5: Start install form

Click Install to continue or Back to review selections:

Figure 6: Start install form


INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 7/29

WebHMI setup starts installation.


WebHMI setup will install automatically and silently the following components if they are not already present on current
computer:

• Node.js 10.14.0

• Microsoft.Net Framework 4.8

Figure 7: Progress bar

When finished, click Finish to close the installer:


A WebHMI shortcut icon is created on desktop.

Figure 8: Launch WebHMI


INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 8/29

5. Install WebHMI on a different computer than the EcoSUI


Secured computer
For the WebHMI to communicate with an EcoSUI Secured which is installed on a different computer, you also need to
install the EcoSUI Secured on the WebHMI computer. Use the same password for both EcoSUI Secured installations.
EcoSUI Secured includes ecoSUISecurityServer service which allows the communication with another EcoSUI Secured
on the network. That is why we need to install an EcoSUI Secured.
To install WebHMI on another computer different than the EcoSUI Secured server, consider the following architectures:

5.1 Simple Architecture

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:

• Same password on all the EcoSUI Secured installations.

• EcoSUI Secured installed on both the WebHMI computer and the EcoSUI computers.
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 9/29

5.2 Redundancy Architecture

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:

• Same password on all the EcoSUI Secured installations.

• EcoSUI Secured installed on both the WebHMI computers and the EcoSUI computers.

• Same WebHMI version installed on HMI Main and HMI Backup..


INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 10/29

5.3 Redundancy Architecture with KPI Monitor

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

Only available with EcoSUI Standard

Login Password Profile

public Schneider Operator

Admin Schneider Administrator

AdmOdyssey Odyssey Administrator

Figure 9: WebHMI Server manager – 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.2 Information (viewer access)

Figure 10: WebHMI Server manager – Information


INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 12/29

6.3 Information (Administrator access)

Figure 11: WebHMI Server manager – Information

6.4 Parameters

This is Parameters pane:

Figure 12: WebHMI Server manager - Parameters


INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 13/29

6.5 General

By default, it will automatically configure Single local WebServer and Single local EcoSUI Acquisition and Archive.

Figure 13: WebHMI Server manager - General

6.6 Modules

Parameter Modules is available only for AdmOdyssey user.


NOTE: This module is not available with EcoSUI Secured.
If you want to change Modules availability, go to C:\MCIS\WebHMI\config\config.json and manually change it as shown
in the example below:
Change "System","enabled":false to "System","enabled":true
By default, it will automatically install options as shown below:

Figure 14: WebHMI Server manager - Modules


INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 14/29

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

• Uninstall from the Start menu


1. Select the Start button and look for Schneider Electric WebHMI x.x.x.x application.
2. Press and hold (or right-click) on the application, then select Uninstall.

• Uninstall from the Settings page


3. Select the Start button, then select Settings > Apps > Apps & features.

4. Select Schneider Electric WebHMI x.x.x.x application, and then select Uninstall.

• Uninstall from the Control Panel (for programs)


5. In the search box on the taskbar, type Control Panel and select it from the results.
6. Select Programs > Programs and Features.
7. Press and hold (or right-click) on Schneider Electric WebHMI x.x.x.x application and
select Uninstall or Uninstall/Change. Then follow the steps on the screen.

Figure 15: Software manager


INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 15/29

8. WebHMI SSL/TLS Certificate


8.1 Self-Signed Certificate

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.

• How to generate SSL certificate


1. Run as administrator a command line window
2. Execute the command line “openssl genrsa -des3 -out rootCA.key 2048” and follow the instructions.

First Step

➢ When appears the command line “Enter passphrase for rootCA.key,” Enter a passphrase and store it securely.
Second Step

It generates a rootCA.key file

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:

• Country Name (2 letter code) [AU]: US

• State or Province Name (full name) [Some-State]: MN

• Locality Name (e.g., city) []: Eagan

• Organization Name (e.g., company) [Internet Widgits Pty Ltd]: Tech Forum

• Organizational Unit Name (e.g., section) []: Marketing

• Common Name (e.g., server FQDN or YOUR name) []: Local certificate

• Email Address []: admin@techforum.com


INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 17/29

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.

The content of server.csr.cnf


[req]
default_bits = 2048
prompt = no
default_md = sha256
distinguished_name = dn

[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

7. Create a v3.ext file with a list of local SAN domains:


authorityKeyIdentifier=keyid, issuer
basicConstraints=CA: FALSE
keyUsage = digitalSignature, nonRepudiation, keyEncipherment, dataEncipherment
subjectAltName = @alt_names
[alt_names]
DNS.1 =ecosui
DNS.2=localhost
IP.1=127.0.0.1
IP.2=172.31.184.5

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

9. Cut the files (refer the image below)

10. Paste the files (refer the image below)

11. Connect to https://localhost (refer the image below):

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

9. WebHMI KPI Monitor plug-in installation (optional)


KPI Monitor is the analytics plug-in that enables WebHMI Dashboard module. It is powered by Qlik Sense® solution.

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

9.1 KPI Monitor Delivery Package

Package is composed of two items:

• A release note: KPI_MINITOR Vx.x.x.x-realeaseNOTEs.doc

• An installer program according to computer requirements: KPI_MONITOR_xxxx.exe.

9.2 Before installing KPI Monitor verify that:

• Operating system is Window© 10 64 bits.

• Windows time zone is properly configured.

• WebHMI application software is already installed.

• WebHMI application software is not running.

• Https port 443 is available during installation.

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

• Qlik license is prepared.

• 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

o No password change required at the first connection.

NOTE: Refer to the Technical Data chapter of this manual to learn further details.
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 20/29

9.3 Automatic Configuration

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

• Creation of Windows administration user accounts:

User Account Details

Default password: qlik


Qlik Qlik role: RootAdmin
Windows account: administrator

NOTE: For security reasons, passwords need to be changed (refer to Windows user administration help).

Automatic Qlik Installation


KPI Monitor setup launches automatically Qlik Sense setup in silent mode. When KPI Monitor installation is completed, Qlik
folder is created in C:\MCIS

Automatic ODBC (Open DataBase Connectivity) Installation


KPI Monitor setup installs automatically the following ODBC drivers:

mysql-connector-odbc-8.0.11-winx64.msi
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 21/29

9.4 Installation steps

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.

This table describes KPI Monitor plug-in installation steps:

Step Actions

1 Double click KPI_MONITOR_x.x.x.x.exe


2 Select Language
3 Click Next to accept the License Agreement to continue with the installation
4 Enter the login and password of the user dedicated for starting KPI Monitor services. Click Validate
Credentials to activate Next button:

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:

Starting script …in progress

…in progress …end of execution

12 The script displays the result of installation of each step..


Once finished, press a key to exit the script and continue the installation.
13 WebHMI window will appear.
Click Finish to exit Setup

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

Installation of Qlik Sense Extension bundles from a Qlik Sense installation


In Qlik Sense November 2018 it is not possible to install Qlik Sense Extension bundles through a silent installation. Qlik
Sense Extension bundles can only be installed via the regular install procedure, or separately, once Qlik Sense November
2018 is installed. It is possible to install or remove Qlik Sense Extension bundles from Qlik Sense deployment at any
moment. If it is a multi-node installation, Qlik Sense Extension bundles are installed on the central node.

Steps
1. In Control Panel, open Programs and Features.
2. In the list of programs, double-click the extension bundle to install or remove.

3. The Extension Bundle Setup Wizard opens. Click Next.


4. Select Change.
5. Accept the End-user License Agreement and click Next.
6. On the Custom Setup screen, click on the bundle icon to select how to modify the bundle installation:
- If the bundle is installed, select Entire feature will be unavailable to uninstall it.
- If the bundle is not installed, select Entire feature will be installed on local hard drive to install it.

Then, click Next.


7. Click Change.
8. When the setup modification is complete, a message invites to manually restart the Qlik Sense Repository
Service.
9. Click Finish to close the Extension Bundle Setup Wizard.

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

9.5 KPI Monitor uninstall

To uninstall KPI Monitor go to Windows > Settings > Apps & Features:

1. Select Schneider Electric KPI_MONITOR xxxx, then click Uninstall:

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

Qlik License – LEF information request


• Input license
The following information is required to request LEF information:

• Request LEF information


Open URL http://lef1.qliktech.com/manuallef/default.aspx

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

Preparation of Qlik Sense environment for KPI_Monitor


• License installation
Open Qlik Sense Management website in http://localhost:443/qmc
Click License Management:

Click Site License:

Enter license information and click Get LEF and preview the license, then click Apply:
INSTALLATION WebHMI/EN IN
WebHMI Documentation Page 29/29

Launch Qlik Sense preparation script for KPI Monitor


Start command prompt window with administrator rights:

Move PowerShell to C:\MCIS\QLIK\02_ASSET_MONITOR\12_ADMINISTRATION\InstallQS:

To start PowerShell interpreter type Powershell.exe -executionPolicy unrestricted Windows PowerShell

To execute the preparation script type .\se-install\se-installer.ps1

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

2. WebHMI Server Manager ......................................................................................................... 6


2.1 Start WebHMI Server Manager .................................................................................................................................. 6
2.1.1 WebHMI Dashboard ................................................................................................................................................... 6
2.1.2 Log into the Console .................................................................................................................................................. 7
2.2 Edit WebHMI Parameters ........................................................................................................................................... 7
2.2.1 General Settings......................................................................................................................................................... 8
2.2.2 Expert Settings ......................................................................................................................................................... 11
2.2.3 Notifications Settings ................................................................................................................................................ 14
2.2.4 Dashboard and Reports Settings ............................................................................................................................. 16
2.2.5 Embedded modules ................................................................................................................................................. 17
2.2.6 Alarm Settings .......................................................................................................................................................... 17
2.2.7 Languages Configuration Files ................................................................................................................................. 19
2.2.8 Additional DataBases ............................................................................................................................................... 21
2.3 How to connect with WebHMI from another computer ............................................................................................. 22

3. WebHMI KPI MONITOR .......................................................................................................... 23


3.1 Qlik Sense Services ................................................................................................................................................. 23
3.1.1 How to Stop and Start Qlik Services manually ......................................................................................................... 23
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 2/23

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.

1.1 WebHMI settings

1.1.1 Setup WebHMI server address


Server address is the IP address or DNS address used by an internet browser to call WebHMI.
To set server address, use file:
• {WebHMI folder}\config\config.json

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.

1.1.2 Set WebHMI server in debug mode


To check WebHMI server state, modify {WebHMI folder}\config\config.json to activate debug mode.
• In line 29, replace ‘production’ with ‘development’
• Then, stop WebHMI services and start WebHMI in console mode using {WebHMI folder}\WebHMI.exe.

1.1.3 Modify login/password for MySQL


If necessary, change MySQL database configuration in {WebHMI folder}\config\config.json.
• Line 33: DBHost:'localhost', IP address of MySQL
• Line 34: DBPort:3306, IP port of MySQL
• Line 35: DBName:'pacis', Database name in MySQL
• Line 36: DBLogin:'root’, Login in MySQL
• Line 37: DBPassword:'', Password in MySQL
Previous configuration is the default one for EcoSUI Standard.

1.1.4 Add profile tag for RBAC in EcoSUI Standard


WebHMI uses same logic in both EcoSUI Standard and Secured versions. It checks role action attribute for each user.
Privileges in EcoSUI Secured are managed with CAE application (Cybersecurity Admin Expert). Please refer to CAE user
manual to learn how.
This table contains the privileges that can be added to a profile:

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;

1.1.5 Standalone configuration


For WebHMI installation, SbusServers, CentralDBs and default language settings are stored in the following file:
{WebHMI folder}\ressources\config.ini.

1.1.6 Modify general settings for web server


Any web server can be reconfigured without reinstallation.
First part of config.json contains general settings for webserver:
• https: true or false | Activate SSL certification or not.
• hosts:{main:’[IP ADDRESS MANDATORY]’, redunded [’[IP ADDRESS OPTIONNAL]’, ’[IP ADDRESS OPTIONNAL]’]}.
Defines IP ADDRESS for webserver. The main one is the current computer and shall use an Ip address defined on one
of active network card (could be copper as wireless card). Note: it is highly recommended to use a static Ip address
and not a DHCP one. Due to the fact, in case of DHCP, network card will change dynamically IP, but web server is not
able it to cope with this dynamic modification.
• SBUSServerConfigurationFile:’[.INI file]’. INI files which contains SBUS and CentralDB IP address. This shall be
declared as on MCIS\SERVERS.INI file
• GeneralConfigurationFile : ’[.INI file]’. INI files which contains Default language and DateTime format. This shall be
declared as on MCIS\GENERAL.INI file
• LanguagesDirectory:’[.LNG file]’. By default, WebHMI brings its own language files. New language can be added on
this folder. Remind, name of .lng file will define what is displayed on WebHMI language selection.
• SbusPerturbanceFilesFolders:[‘[MCIS perturbance folder]’] shall be similar to what is defined in perturbances.ini files
contains in each MCIS ring.
• WebServerPerturbanceFilesFolders:‘[custom folder]’. This folder will store converted COMTRADE files to manipulate
in WebHMI
• sldSvgFilesDirectory: ‘[default folder]’. Location where are stored svg files from HMI Studio for SLD tabs in WebHMI
• systemSvgFilesDirectory: ‘[default folder]’. Location where are stored svg files from HMI Studio for architectures tabs
in WebHMI
• CheckPerturbanceFilesTimePeriod: integer. This attribute sets period in ms for frequency to check in
SbusPerturbanceFilesFolders if it exists a new disturbance COMTRADE.
• LogsDirectory: ‘[default folder]’. Location where WebHMI stored its activities, errors and exceptions. Filenames start
with following word: ‘ECOSUIWEB’.
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 4/23
1.1.7 Gravity color scheme
Attributes contain definition for each alarm gravity level. Following example is the default table:
Gravity level 1:
Alarm active not acknowledge back color is red with words in white
Alarm inactive not acknowledge back color is white with words in red
Alarm inactive not acknowledge back color is green with words in black
Alarm active acknowledge back color is black with words in white
Gravity level 2:
Alarm active not acknowledge back color is orange with words in white
Alarm inactive not acknowledge back color is white with words in orange
Alarm inactive not acknowledge back color is green with words in black
Alarm active acknowledge back color is black with words in white
Gravity level 3:
Alarm active not acknowledge back color is yellow with words in white
Alarm inactive not acknowledge back color is white with words in yellow
Alarm inactive not acknowledge back color is green with words in black
Alarm active acknowledge back color is black with words in white

All color can be set with color name (black, white, yellow, etc) or with hex code (#4FA600, #000000, etc).

1.1.8 Modules management


Modules can be activated or deactivated after installation. Behind change modules access, there is two attributes:
• “enabled”: Activate/Deactivate engine on web server
• “UIModule”: Display specific tabs on Web client. Note that for busBarColoring module, UIModule value must be false.

1.1.9 Reports server


If Reports module is enabled, jsReports server shall be set. “Host” attribute is the same IP address than webserver main IP
address and “port” is “81” if “https” is “false”, or “442” if “https” is “true”.
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 5/23
1.1.10 Time zone
The timeSettings variable defines two factors : display WebHMI client date and time. If not, refresh period in seconds to
check if server time is changed.
By default, webserver is defined as in following example

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

2. WebHMI Server Manager


WebHMI Server Manager is the Admin Console of WebHMI. It allows you to view and manage all of the information and
tools that affect your WebHMI application and productivity.
From one single interface, WebHMI Server Manager allows administrators to do the following:
• View the status of WebHMI and the state of related applications (SBUS server, central DB…),
• Perform Expert management tasks associated with the operational mode of WebHMI,
• View and edit setting parameters...
Special Consideration
Before using WebHMI Server Manager, it is recommended that users familiarize themselves with the functions, terminology,
requirements.

2.1 Start WebHMI Server Manager

To launch the console, click the WebHMI Server Manager icon in the task bar. The icon color reflects WebHMI operating
mode:

Tray Icon Server Operating Mode Comments

Running WebHMI is running and fully accessible by WebHMI client

Not active WebHMI service is running but server is not active

Issue occurred on web server (new trace, server running but task locked,
Alert
intrusion,…)

The WebHMI console appears on screen.

2.1.1 WebHMI Dashboard

Without connecting to the console, you


can view the general information about
WebHMi and status of related
applications by clicking on Information:

Click the > icon to view the detailed


settings of an application: (information
is read-only):

To go back to the previous screen, click


the Return link
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 7/23
2.1.2 Log into the Console
To view and/or edit WebHMI settings, you must log to the console as an expert user with administration rights.
Once logged with administration rights, the dashboard shows additional icons at the bottom of the console:

To edit WebHMI settings, click the parameter icon.


The Parameters view appears on screen.

To log out the application, click the logout icon.

To restart the webhmi, click the restart icon.

To stop the Webhmi, click the stop icon.

2.2 Edit WebHMI Parameters

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:

2.2.1 General Settings

Click General menu.

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:

Parameters Description Values


URL Address to be entered in web browser Default value : 127.0.0.1
Port Number of the port to be used Default : 443
HTTPS Activate or not SSL certification Default: 443 with SSL (recommended) or 80 without SSL

EcoSUI
These are the settings for EcoSUI:

Parameters Description Values


IP Address Location of EcoSUI equipments Default 127.0.0.1
Archives Defines Central DB Enabled by default (Redundancy: Use M for Main / B for Backup)
Acquisition Defines SBUS Server Enabled by default (Redundancy: Use M for Main / B for Backup)

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:

Edit the desired values according to your needs:


SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 12/23

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

Parameters Description Values


ByPass Interlock 1. Define rules for ByPass Default: “empty”
“value” Interlocking Enter
2. Configure force bypass of 1. IED Name
Interlock at IED level
2. Full path of the control datapoint
For example:
➢ Activate ByPass Interlock for the equipments with IED
network name, Enter “ied”: “K01_P139”.
➢ The path of the primary equipment for this equipment, Enter
“ctrlFullPath”: “UTILITIES / 15kV / K01 / Q0 / Q0 CONTROL”
➢ Please refer the image above, for the reference of this
example cited for Enter values.

ByPass SynchroCheck 1. Define rules for ByPass Default: “empty”


“value” SynchroCheck Enter
2. Configure force bypass of 3. IED Name
synchrocheck at IED level
4. Full path of the control datapoint
For example:
➢ Activate ByPass Interlock for the equipments with IED
network name, Enter “ied”: “K01_P139”.
➢ The path of the primary equipment for this equipment, Enter
“ctrlFullPath”: “UTILITIES / 15kV / K01 / Q0 / Q0 CONTROL”
➢ Please refer the image above, for the reference of this
example cited for Enter values.

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

1. “?” for bad quality


It allows the configuration of
Value Display mode 2. Current measure value for good quality
display of measured values.
NOTE: refer to the section 5.1.1 for the definition of “bad qualities”
for “States” and “Trends” module, and to section 11.1 for the
definition of “bad qualities” for “SLD” and “System” module.
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 14/23
2.2.3 Notifications Settings
NOTE: Notifications feature is not available for EcoSUI Secured.
Notifications module is enabled by default, but the configuration of the server account is still required.
To disable Notifications module, in Modules, deselect Notifications, then click Apply modifications:

Module activation Module access for configuration

To send e-mail and/or SMS, Notifications module requires to be configured.


To configure Notifications module, in Parameters, click Notifications and enter following information:

E-mail Daemon SMS/MMS Daemon

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)

Name: Name of the sender

Email: Address email of the sender

Proxy: proxy of the user’s network

Credentials user: User’s login of the e-mail account

Credentials password: User’s password of the e-mail 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):

Module activation Module access for configuration

In the configuration panel (below image), enter the following parameters:

Parameters Description Values

Qlik Sense Network Configuration

Hostname Machine name

Communication Http port 33300

Https port 33301

Proxy name jwt


Authentication
UserDirectory WEBHMI_REP_USER

Qlik Sense Application Configuration

Reload task – task name Task_ASSET_MONITOR-00


Events
Reload task – task tag LOAD_EVENT_CHAIN

On-demand Public stream Everyone


applications Template suffix _ODAGTemplate

Reports stream report

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

2.2.6 Alarm Settings


Click the Alarm menu.
Alarms settings appear on screen. By default, three gravity levels are available and can be customized.

2.2.6.1 Change the Alarm Text and Background color


For Active and Inactive Alarms, you can set up the background color and text color for “Not Acknowledged” and
“Acknowledged” alarm statuses.

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

2.2.6.2 Add an Alarm Level


You can add a new alarm gravity level by clicking the + button:

A new line appears on screen.

Set up the alarm text and background color according to your needs.

2.2.6.3 Delete an Alarm Level


You can delete an alarm level by clicking the x button:

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

Click the Languages menu.


The tabs, on the left, show the languages available in WebHMI.

• 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

2.2.7.1 Add a new application language


You can add a new appllication language to webhmi.
To do so:
• Click New language
• Enter the language name in the Language Name entry field,
• Click Default to set this language as the default one when using WebHMI
• Then, drag and drop lng files to the File(s) area.
• Once dropped, click Commit.

2.2.7.2 Edit Language Configuration Files


You can edit a language file to change translation text or add new entries.
To do so:
• Click the desired language.
• Click Export and select the destination folder to store the associated language file (lng)
A <language>. zip file is then generated. It contains two files. One containing the webhmi language text and another one
containing the signal list text.
Edit the lng files with Notepad for instance, and make the relavant changes.
Once the files are ready to be imported, click Import to update the libraries of webhmi server manager.
SETTINGS WEBHMI/EN ST
WEBHMI Documentation Page 21/23
2.2.8 Additional DataBases

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

+ Click plus icon to add an Additional Database (already added in EcoSUI).

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

2.3 How to connect with WebHMI from another computer

To enable communication between server machine and client machine:


1. Configure the firewall settings to enable communication between server and client:
This table contains the ports to be configured on the server machine:

Settings Port

WebHMI port 90

Reports port (when Reports module enabled) 81, 5000, 30002

KPI Monitor port 3090, 4000, 4242, 4244, 4248, 4432, 4444, 5355,
(when Dashboard module enabled) 5353, 5555, 5556, 33000, 33301,

EcoSUI port (for EcoSUI Standard) 44444

EcoSUI port (for EcoSUI Secured) 40000

MySQL port 3306

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

3. WebHMI KPI MONITOR


KPI Monitor is the analytics add-on-in that enables WebHMI Dashboard module. It is powered by Qlik Sense® solution.
This chapter is applicable after KPI Monitor add-on-in installation and provides settings to be applied by the user for the
correct interface with Qlik Sense application.

Refer on Installation chapter to “WebHMI KPI Monitor plug-in installation (optional)” for more information about Qlik Sense
installation.

This section provides actions to be performed before applying settings.


WebHMI needs to be installed and run on the same machine as KPI Monitor application and configured in order to provide
the IP address of all EcoSUI databases to take in account.

3.1 Qlik Sense Services

Check Qlik sense services are running:

3.1.1 How to Stop and Start Qlik Services manually

The user may need to stop or start Qlik Services manually.

To Stop Qlik Services manually, stop them in the following order:


1. Qlik Sense Repository Database (QRD). This will first terminate all services with a dependency to the QRD (see
Service dependencies on the Qlik Sense Online Help).
2. Qlik Sense Logging Service (If feature was enabled during installation).
3. Qlik Sense Service Dispatcher (QSD).

To Start Qlik Services manually, start them in the following order:


1. Qlik Sense Repository Database (QRD).
2. Qlik Sense Logging Service (if installed).
3. Qlik Sense Service Dispatcher (QSD).
4. Qlik Sense Repository Service (QRS).
5. Qlik Sense Proxy Service (QPS), Qlik Sense Engine Service (QES), Qlik Sense Scheduler Service (QSS), Qlik Sense
Printing Service (QPR) in no specific order.

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

1. Scope of the document


The present document is a WEBHMI chapter of the documentation binders. It describes the Commissioning record
sheet and the Setting Record (RS) of WEBHMI application.

2. Installation
2.1 Software delivery

EPAS system version


EcoSUI version
WebHMI version

EPAS SYSTEM Release note Checked


О Yes О No

EcoSUI Release note Checked


О Yes О No

WebHMI Release note Checked


О Yes О No

2.2 WEBHMI Installation

WEBHMI installed using WEBHMI installation guide (IN)


О Yes О No

WEBHMI Installation directory


О Standard (C:\MCIS\WebHMI)
О Other (precise: ___________________________ )

WEBHMI Internet address


https:// ___________________________________________

WEBHMI Installation problem


О Yes О No

2.3 Installation checking

WEBHMI as service started launched


О Yes О No

WEBHMI is accessible with web browser


О Yes О No

Check on WebHMI about page is coherent with installer version


О Yes О No
MAINTENANCE, FAULT FINDING,
REPAIRS (MF)
MAINTENANCE, FAULT FINDING, REPAIRS WebHMI/EN MF
WebHMI Documentation Page 1/5

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)

Also, from 3.5.3.3 version:


• ECOSUIWEB-activities_pm2_webhmi-0.log (equal to activities_pm2_webhmi-0.log )
• ECOSUIWEB-errors_pm2_webhmi-0-0.log (equal to errors_pm2_webhmi-0-0.log )
• ECOSUIWEB-qlikreports.log contains all logs about reports generated with qlik (available from 3.5.3.4 version)

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"
}
]
}

Save the file and Restart the computer.


MAINTENANCE, FAULT FINDING, REPAIRS WebHMI/EN MF
WebHMI Documentation Page 4/5

4. WebHMI background tasks


4.1 WebHMI Modules background tasks

This table contains the background tasks related to WebHMI modules:

Background task by WebHMI module Interval


Notifications
Delete older than 10 days notification archive Every 24 hours
Send disturbance file notification Every 5 minutes
Send event notification Every 5 minutes
Send report notification Every 5 minutes
Disturbances
Search for and retrieve new disturbance files Once per day
Dashboards
Repair task chain Every 8 hours
Release unused open sessions Every minute
Reports
Discovery of Analytic Report Available in upcoming version of WebHMI

4.2 WebHMI Server background tasks

This table contains the background tasks related to the WebHMI server:

Background task Interval


Clean logs Every 12 hours
Delete no longer used sessions Every 5 minutes
Check data base availability Every 2000 ms
Try reconnection to EcoSUI SBUS when communication is lost Every 10000 ms
MAINTENANCE, FAULT FINDING, REPAIRS WebHMI/EN MF
WebHMI Documentation Page 5/5

5. Quickly check status


Use the services in this table to quickly check the status of the following items:

Item to check Service


EcoSUI SBUS server http://127.0.0.1:90/api/health/getAllStatusSbus
EcoSUI Databases http://127.0.0.1:90/api/health/centralDBs
http://127.0.0.1:90/api/health/additionnalCentralDBs
WebHMI server http://127.0.0.1:90/api/health/webServer

Use the information in this table to quickly check the status of other additional services:

Item to check Service


WebHMI configuration file (.json format) http://127.0.0.1:90/api/health/currentConfig
WebHMI restart (if service answers YES, WebHMI http://127.0.0.1:90/api/health/rebootNeeded
application needs to be restarted)
WebHMI connected sessions http://127.0.0.1:90/api/health/webServerUserSession
PROBLEM ANALYSYS (PR)
PROBLEM ANALYSIS WEBHMI/EN PR
WEBHMI Documentation Page 1/6

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.

2. Initial problem identification


Consult the table below to find the description that best matches the problem experienced, then consult the section
referenced to perform a more detailed analysis of the problem.

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

3. Act after problem


3.1 Analyze issue

To define issue origin, it is highly recommended stopping WebHMI service and launching WebHMI application.

To find the bug rapidly:


• Analyze C:\MCIS\Debug\ECOSUIWEB-errors_pm2_webhmi.log file and try to find all occurrences of Configuration
Save.
• Once you find occurrences, see the last action before them and detect the wrong action which is repeated before
Configuration Save.

To activate debug mode, follow this procedure:


1. Open task manager and select service tabs
2. Right-click on WebHMI EcoSUI and stop service
3. On WebHMI\config folder, open config.json
4. Find Environment:’production’ line and replace production with development
5. Click on WebHMI icon in WebHMI directory to start server in console mode

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

3.2 Check web server address

Web server address is set on file config.json.


On config.json, find the line hosts:{main:'127.0.0.1', redunded:[]} and check if main address is the address of main web
server. Redunded parameter can record several emergency web servers. IP addresses shall be separated with “,”
separator. E.g.:

hosts:{main:'127.0.0.1', redunded:[ 'ecosui.schneider-electric.com','10.234.37.114']}

3.3 Check file encoding

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:

Files WebHMI Secured WebHMI


MCIS\GENERAL.INI X X
MCIS\SERVERS.INI X X
MCIS\Rings\[projects]\RING.INI X X
WebHMI\ressources\languages\*.lng (default)
or X X
MCIS\Mimics\languages\*.lng
MCIS\Mimics\Users\PacisUsers.ini X

With third-part software (Notepad++, SublimeText, …), convert encoding to be in phases with requirements below.

3.4 First line in text files

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

3.5 Check MySQL parameters

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,

• DBHost: Ip address of default CentralDB


• DBPort: default port for MySQL database
• DBName: Database name
• DBLogin: Database login
• DBPassword: Database password
• DBDebug: activate MySQL debug mode
• DBSSL: activate cybersecurity for MySQL

3.6 Missing user rights

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.

3.7 ecoSUISecurityServer Service

ecoSUISecurityServer is installed by EcoSUI Secured installation.

For EcoSUI Secured


• To start WebHMI, ecoSUISecurityServer service must be running.
• To check connection with the cybersecurity module, use telnet command telnet localhost 40000
If connection is ok, then communication between ECOSUI and WebHMI should work. If not, there is a compatibility
problem.

For EcoSUI Standard


ecoSUISecurityServer service must not be running, otherwise the WebHMI doesn’t start.

3.8 Check Node.js version

WebHMI will not start if Node.js version is other than 6.13.1


If WebHMI does not start, install it again by running the WebHMI setup as Administrator.
Verify if Node.js 6.13.1 is installed (maybe a different Node.js version is already installed).
PROBLEM ANALYSIS WEBHMI/EN PR
WEBHMI Documentation Page 4/6

3.9 How to analyze performance problem

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

For support request, please use DevTrack tool:


http://iww.ia-devtrack.schneider-electric.com/scripts/texcel/devtrack/devtrack.dll?Login
In the menu, select HotLine, then Hotline ticket and create related ticket.
LEXICON (LX)
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 1/12

Contents
1. Scope of the document ......................................................................................................... 2
2. WebHMI Lexical ..................................................................................................................... 2
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 2/12

1. Scope of the document


The present document is a WebHMI chapter of the documentation binders. It is the lexical of WebHMI.

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

TVU Transformer Voltage Unit


MiCOM C264 Bay Computer CT/VT board : Voltage acquisition
UCA Utility Communications Architecture
Communication standard (mainly US) used for EPAS SBUS communication
UPI Unit Per Impulse
Parameter of counter to convert number of pulses to Measurement value. Both data (integer
and scaled floating) are in a common class UCA2 Accumulator.
UTC Universal Time Co-ordinates (or Universal Time Code)
This designation replaces GMT (but it is practically the same for our purposes).
VdBS Versioned data Base System, databag generated by SCE & ready to download
VDEW Term used for IEC 60870-5-103 protocol
VDU Visual Display Unit
VMGA Vertical Measurement Graphical Area
Voltage level Set of bays, whose plants & devices deal with the same voltage (for example, 275 kV)
LEXICAL WEBHMI/EN LX
WEBHMI Documentation Page 12/12

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

As standards, specifications, and designs change from time to time,


please ask for confirmation of the information given in this publication.

© 2010 - 2022 Schneider Electric. All Rights Reserved..

WebHMI/EN UM/A9_RC1

You might also like