ASID11000159 - HMI 500 - User Manual - Configuration and Use of The Client Component (1 5 0)

User Manual
Configuration and Use of the Client

Component
HMI 500 – User Manual
Configuration and Use of the Client Component
Revisions
Version Date Comments Product Author

Version
1.0 2007-08-17 Document release. 0.8 Helder Magalhães;

Aníbal Pinto
1.1.0 2009-01-23 Archive addition and other minor 0.9 Maria Eulália Pinto
features; Helder Magalhães
Important improvements on the
text;
Minor corrections.
1.2.0 2011-04-26 New features: 1.5 Bruno Ferreira;

– Value imposition; Nelson Costa;
– Control inhibitions; André Santos;
– Alarm inhibition; Helder Magalhães
– Tag support in synoptics;
– Tag viewer;
– Enable/ disable printers;
– Exporting in CSV format;
– Printing wizard with
description;
Distinction between Type and
Description of the Alarm;
Added some columns in the
entities list;
Improvements were made in
mimics navigation;
Figures update;
Minor corrections.
1.3 2011-06-03 Configuration to work around IE8 1.6 Helder Magalhães
issue.
1.4 2012-01-06 New features: 1.8 André Santos

- Reports
1.5 2012-10-23 New features: André Santos

- View in synoptic; Helder Magalhães
- Virtual keyboard
Figures update (reports);
Supported operating systems
and browsers lists update.
Revisions ii
Document
Name HMI 500 – User Manual – Configuration and Use of the Client
Component
Document Number ASID11000159
Template Modelo para fascículo de Manual
Template Version 1.4
Translated by Maria Eulália Pinto
Reviewed by Helder Magalhães
Approved by Paulo Rodrigues
Total Pages 49
Document iii
Table of Contents
1. INTRODUCTION .............................................................................................................. 1
1.1 REQUIREMENTS ............................................................................................................. 1
1.2 SCOPE .......................................................................................................................... 1
1.3 OBJECTIVES .................................................................................................................. 1
2. SUPPORTED PLATFORMS ............................................................................................ 2
3. INSTALLATION AND CONFIGURATION ....................................................................... 3
3.1 INSTALLATION OF THE REQUIRED SOFTWARE TO ACCESS THE SYSTEM ............................ 3
3.1.1 Based on Internet Explorer ................................................................................... 3
3.1.1.1. Installation of the Required Plug-in for Graphics View .............................................. 3
3.1.2 Based on Mozilla Firefox ....................................................................................... 4
3.1.3 Based on Opera .................................................................................................... 4
3.1.4 Based on Safari ..................................................................................................... 4
3.2 CONFIGURATION ............................................................................................................ 5
3.2.1 Based on Internet Explorer ................................................................................... 5
3.2.1.1. Enhanced access to Data Server .............................................................................. 5
3.2.1.2. Printing ...................................................................................................................... 6
3.2.2 Based on Mozilla Firefox ....................................................................................... 7
3.2.2.1. Printing ...................................................................................................................... 7
3.2.3 Based on Opera .................................................................................................... 7
3.2.3.1. User Interface ............................................................................................................ 7
3.2.3.2. Printing ...................................................................................................................... 8
3.2.4 Microsoft Pocket Internet Explorer ........................................................................ 8
4. COMPONENT GENERAL USE ..................................................................................... 10
4.1 SYSTEM LOGIN ............................................................................................................ 10
4.2 SYSTEM AUTHENTICATION ............................................................................................ 10
4.3 APPLICATION GENERAL VIEW ....................................................................................... 11
4.3.1 Main Menu .......................................................................................................... 11
4.3.2 System Summary ................................................................................................ 12
4.4 INFORMATION AND GENERIC ACTIONS ........................................................................... 12
4.4.1 Toolbar ................................................................................................................ 12
4.4.2 Printing ................................................................................................................ 13
4.4.3 Lists Handling ...................................................................................................... 14
4.4.4 Filters................................................................................................................... 15
4.4.5 Visualization of Entities Attributes ....................................................................... 15
4.4.5.1. Value Imposition ...................................................................................................... 16
4.4.6 Sending Controls ................................................................................................. 16
4.4.6.1. Control Inhibition ..................................................................................................... 17
4.4.7 Virtual keyboard .................................................................................................. 17
5. AVAILABLE MODULES ................................................................................................ 19
5.1 ALARM VIEWER............................................................................................................ 19
5.1.1 Accepting Alarms ................................................................................................ 20
5.2 ALARM INHIBITIONS ...................................................................................................... 20
5.2.1 Alarm Inhibition ................................................................................................... 21
5.2.2 Alarm Activation .................................................................................................. 22
Table of Contents iv
5.3 EVENTS LIST ............................................................................................................... 23

5.3.1 Printer Activation/ Inhibition ................................................................................ 23
5.4 SYSTEM EVENTS LIST .................................................................................................. 24
5.5 ENTITIES LIST .............................................................................................................. 25
5.6 ARCHIVES VIEWER ....................................................................................................... 26
5.7 USERS ........................................................................................................................ 27
5.8 NOTES ........................................................................................................................ 28
5.8.1 Adding a Note ..................................................................................................... 29
5.9 TAGS LIST ................................................................................................................... 29
5.9.1 Tags Removal ..................................................................................................... 30
5.10 SYNOPTIC VIEWER ..................................................................................................... 30
5.10.1 Entity Attributes Visualization ............................................................................ 30
5.10.2 Sending controls ............................................................................................... 31
5.10.3 Tags .................................................................................................................. 31
5.10.3.1. Symbology............................................................................................................. 31
5.10.3.2. Adding Tags .......................................................................................................... 31
5.10.3.3. Changing a Tag ..................................................................................................... 32
5.10.3.4. Removing a Tag .................................................................................................... 32
5.10.4 Navigation ......................................................................................................... 33
5.10.4.1. Intra-synoptic ......................................................................................................... 33
5.10.4.2. Inter-synoptic ......................................................................................................... 34
5.11 TREND CHARTS ......................................................................................................... 35
5.11.1 Configuration ..................................................................................................... 35
5.11.1.1. Line Configuration ................................................................................................. 35
5.11.1.2. Save and Load Configurations .............................................................................. 36
5.11.2 Navigation ......................................................................................................... 37
5.11.2.1. Trend Graphic Mode ............................................................................................. 37
5.11.2.2. System Surveillance Mode .................................................................................... 37
5.12 REPORTS .................................................................................................................. 37
6. TROUBLESHOOTING ................................................................................................... 39
6.1 LOG OFF ERROR .......................................................................................................... 39
6.2 PROBLEM WHEN VISUALIZING SYNOPTIC DURING THE NAVIGATION................................. 40
6.3 MEMORY LEAK IN IE8 IN W INDOWS XP ......................................................................... 40
7. KNOWN LIMITATIONS .................................................................................................. 41
7.1 INTERNET EXPLORER BROWSER ................................................................................... 41
7.1.1 Version 6.x .......................................................................................................... 41
7.1.2 Version 7.0 and Above ........................................................................................ 41
7.2 MOZILLA FIREFOX BROWSER ........................................................................................ 41
7.2.1 Version 1.5 .......................................................................................................... 41
7.2.2 Version 4.0 and Above ........................................................................................ 41
7.3 OPERA BROWSER ........................................................................................................ 41
7.4 SAFARI BROWSER........................................................................................................ 41
REFERENCES ...................................................................................................................... I
GLOSSARY .......................................................................................................................... II
Table of Contents v
1. Introduction
1.1 Requirements
It is assumed that the reader of this document has experience in automation systems
usage (for example, the CLP 500 platform).
1.2 Scope
Remote Units.
1.3 Objectives
Support the user when configuring and using the client component, as well as to aid on
the resolution of common problems.
Introduction 1 of 42
2. Supported Platforms
The system was tested on the following Web browsers. The ones that are officially
supported are:
1. Microsoft Internet Explorer 9;
2. Microsoft Internet Explorer 8; added by the plug-in for Adobe SVG Viewer 3.03
trends;
3. Mozilla Firefox 3.6
There are other Web browsers, not often tested, for which support is not official and/ or it
is considered experimental:
1. Opera 10;
2. Safari 5;
3. Google Chrome 4 (the restrictions are the same as Safari’s).
The official supported operating system is Microsoft Windows XP, although the Microsoft
Windows 7 and Linux systems are also very often tested.
The PDA version was tested in the following browsers:
1. Android 4 (stock browser);
2. Opera Mobile 9.6;
3. Microsoft Pocket Internet Explorer.
See point 7 to know each Web browser limitations.
Supported Platforms 2 of 42
3. Installation and Configuration
3.1 Installation of the Required Software to Access the System

3.1.1 Based on Internet Explorer
You can see the browser version from the “Help” menu, “About Internet Explorer” option.
The installed version should be 6.0 or higher.
Figure 1. Panel “About…” of Internet Explorer
3.1.1.1. Installation of the Required Plug-in for Graphics View

As Internet Explorer doesn’t natively support the required technology to operate the
graphic components of the client component, it is necessary to previously install a plug-in.
The procedure should start automatically or after a message is shown demanding the
installation. A panel, similar to the one on Figure 2, appears with important instructions
that should be read and accepted.
Figure 2. Required plug-in installation for graphics view on Internet Explorer
Installation and Configuration 3 of 42

3.1.2 Based on Mozilla Firefox

The Mozilla Firefox client natively support the SVG technology, so, additional software is
not required. The installed version should be 2.0 or higher.
Figure 3. “About...” panel of Mozilla Firefox
3.1.3 Based on Opera

The Opera client natively support the SVG technology, so, additional software is not
required. The installed version should be 9.26 or higher.
Figure 4. “About...” panel of Opera
3.1.4 Based on Safari

The Safari client natively supports the SVG technology, so, additional software is not
required. The installed version should be the 3.0 or higher.

Figure 5. “About…” panel of the Safari Web browser
3.2 Configuration
The Web browser in use requires some specific configurations to access the server, so
some features work as expected. Not confirming the configurations can lead to negative
and/ or unexpected effects on the client functioning.
It is important to notice that the configurations described on these sections may not have
the desired effect for several reasons:
4. The user may not have permissions to change configurations on the machine
where he’s working;
5. The network environment may not allow the communication on the suggested
configurations;
6. There may be systems in the network path that change data. This is an extremely
rare situation, but, isolated cases may happen.
3.2.1 Based on Internet Explorer

3.2.1.1. Enhanced access to Data Server
It is necessary to change the default configurations so that Internet Explorer Web browser
accesses the data server in an optimized way
One can access the configurations from the “Control Panel”, “Internet Options” and
“Advanced” separator. The two checking boxes concerning the “HTTP 1.1” definitions
must be ticked (“Use HTTP 1.1” and “Use HTTP 1.1” through a proxy connection”), as
shown on Figure 6. The “Use HTTP 1.1 through proxy connections” option can require the
confirmation by the network administrator.

Figure 6. Configurations for data server access in Internet Explorer
3.2.1.2. Printing
To print on the several components, it is necessary to check the configuration described
on Figure 7. The configuration is in the same separator of the previous setting (3.2.1.1).
Figure 7. Printing configuration on Internet Explorer

3.2.2 Based on Mozilla Firefox

3.2.2.1. Printing
Follow the configuration described on Figure 8 in order to print on the several
components. Access the configuration in “File” menu, “Page setup…” option.
Figure 8. Printing configuration on the Mozilla Firefox
3.2.3 Based on Opera

3.2.3.1. User Interface
Entity attributes view is possible after enabling the capture of right button mouse button.
Access this configuration from “Tools” menu, “Preferences”. In “Advanced” separator,
press the “JavaScript options” button and select “Allow script to receive right clicks” as
shown by Figure 9. Notice that it is necessary to perform this configuration for each server
– “Tools”, “Quick preferences”, “Edit site preferences”, and “Scripting” separator.

Figure 9. Right mouse button configuration
3.2.3.2. Printing
Follow the configuration described on Figure 10 in order to print on the several
components. The configuration is accessed in “File” menu, “Page configuration…” option.
Figure 10. Printing configuration on Opera
3.2.4 Microsoft Pocket Internet Explorer

The PDA version requires a configuration in order to enable the system normal access.
The option is selected from the “Menu”, “Options”, “Fit to screen” (Figure 11).

Figure 11. Configuration on the Pocket Internet Explorer

4. Component General Use
4.1 System Login

The system login should display an introductory screen, similar to the one presented on
Figure 12.
Figure 12. Welcome screen
4.2 System Authentication

This feature is supported using HTTP authentication. The authentication is made through
an authentication panel (similar to Figure 13).
Figure 13. Authentication panel of the system
Component General Use 10 of 42

4.3 Application General View

The application initial view (Figure 14) presents the main menu (Figure 15), the area for
the available modules (5) and, depending on the configuration, the system summary
(Figure 18). The specific components of the general view are briefly described next.
Figure 14. Application general view
4.3.1 Main Menu

The main menu (Figure 15) gives access to several available modules presenting the
information and general actions about the system.
The menu’s left side presents a set of buttons from which the modules can be started
through a click in the associated button. The user can open a module in a new window by
pressing simultaneously the Ctrl key and clicking the left mouse button.
The menu’s right side presents some information about the installation: its identification,
system date and communication status indicator. Some generic actions are also possible,
as access button to options window, the “Help” button connecting to User Manual, the
access button to “About” window and “Log-off”. Logotypes of client company and Efacec
are also represented, and there’s the possibility to link them to their websites.
Figure 15. Main menu
The options window (Figure 16) allows defining the position of the system summary, as
well as choosing between two different themes that slightly change the application general
look. It also enables to activate the virtual keyboard feature () for all the text and
numbering components.

Figure 16. Options Window
The “About” window (Figure 17) displays some information about the version of the
several components involved as well as configuration databases.
Figure 17. “About” window
4.3.2 System Summary

The system summary (Figure 18) presents the more important alarms, the active users,
notes list, as well as the graphic indicating the system status.
About the alarms presented in the system summary, it is not possible to filter them or even
reorganize the list, once its visualisation objective is to warn the user of the displayed
alarms.
Figure 18. System summary
4.4 Information and Generic Actions

There are some interaction paradigms and generic actions shared by all the modules
explained next.
4.4.1 Toolbar
All the modules share a toolbar (Figure 19) which displays the specific options for each

one of the modules. Some of the buttons are common to all modules (for instance, Print,
Options and Help). These perform generic actions and configurations. The Save button is
common only to modules with data lists, enabling to save/ export data in CSV format.
Figure 19. Toolbar
The printing action, when properly configured (3.2.1.2) should print lists, trend graphics
and mimics. The “Options” button must open a configuration window. The “Help” button
opens the respective section from the user manual.
4.4.2 Printing
Besides containing essential information about each module (data of lists, trend graphics
or mimics), the printing option also has a header with important information about the
printing action as represented by Figure 21. The header has some fields, one of them is
the user description optionally filled when starting the printing from the window of Figure
20.
Figure 20. Description support in the printing

Figure 21. Printing the Alarm list
4.4.3 Lists Handling

The list-based views have a common interface regarding column arrangement, options
and filters.
The list usual features are the column and line arrangement, as adding or removing them.
The user may do this using the button on the upper right of the list, and select the columns
that are about to be added or removed.
It’s enough to drag he column header in order to change its position. The lines order is
changed by clicking the column that will be sorted by ascending or descending order
(indication given by the arrow displayed on the top of the column).
The options panel (accessible through the toolbar) of the list-based modules allows
defining the update interval and the limit of lines to be shown. There’s also an option
disabling or enabling the user warning that the limit was exceeded.
Figure 22. Example of list options window

4.4.4 Filters
Filters are used to restrict all data in the lists, so the result would be a subset of available
information. Usually entities and time restrictions are available, but other restrictions might
be applied depending on the context.
Figure 23. Example of a Filter window
The user can select one of several types of entities in the sub-filter and restrict it to
specific hierarchy levels or identifier pattern.
The sub-filter of specific entities (Figure 24) selected using “Choose…” button selects a
limited set of entities. If intended, the separator regarding the required entities type
(discreet, continuous and commands) must be selected, using restrictions of hierarchy
levels and/ or identifier pattern in order to reduce the amount of information.
Figure 24. Example of a sub-filters window
The time restriction sub-filter reduces the information to a random period, of absolute or
relative reference. The button to select dates opens a useful calendar when inserting
dates.
4.4.5 Visualization of Entities Attributes

The visualization of entities attributes can be made in the entities and mimics module,
from the window shown in Figure 25.

Figure 25. Attributes window
The actions about the “Tags” option are explained in detail in section 5.10.3.
4.4.5.1. Value Imposition
Through the value imposition the user can “freeze” status refreshing of an entity with a
defined value and besides that, one can turn it invalid. The imposition is done from the
window of Figure 26, opened after window of Figure 25.
Figure 26. Value imposition window.
4.4.6 Sending Controls

The sending of controls can be made in entity and mimic modules through the window of
Figure 27.

Figure 27. Control window
4.4.6.1. Control Inhibition

Inhibiting the controls allow the user to view a set of conditions that restrict the execution
of specific controls. These conditions are displayed in a tabular view, where the active
conditions are indicated that may inhibit the control execution. In case of Figure 28 it is
possible to see that one of the conditions is active and the control is inhibited.
Figure 28. Control inhibition window
4.4.7 Virtual keyboard

The Virtual Keyboard option is only visible when enabled by the user (Figure 16). This is a
continuing configuration by session and user in the machine.
The keyboard will be displayed to the user whenever there is an interaction with a text or
numbering input. The layout and format of the keyboard will be according to the selected
component as figure below indicates.

Figure 29. International and numeric keyboard
The user will have access to different options in the international keyboard with the
selection of Shift and/ or AltGr keys as in the common keyboard.
Accepting the value inserted in the virtual keyboard can be made when selecting the
Accept button or simply pressing any mouse button outside the keyboard area. The cancel
button must be pressed to cancel the option.

5. Available Modules
5.1 Alarm Viewer

The Alarm viewer is a list that allows the user to have access to the current list of the
system alarms. The columns containing the information about the alarms are presented in
Table 1.
The alarms list is always sorted by descending order of local time, thus, columns can’t be
reorganized. The list is real time refreshed every time a system alarm changes.
Figure 30. Alarms List
The “Filter” button allows reducing data that will be presented, as usually the view
applications means the handling of considerable data quantities (see 4.4.4).
Available Modules 19 of 42
Table 1. Alarm list columns
Column Description
Local Time Date and local time of the event that gave origin to the alarm is logged
in the system.
Source Time Moment where the event that gave origin to the alarm is logged at
acquisition level, when available.
Identifier The entity responsible by the alarm is identified.
Hierarchy Level 1-4 Entity description in the system tree.
Alarm Type Description Text description of the type of the alarm.
Alarm Description Text description of the alarm.
Priority The priority level of the alarm.
Alarm Active Indication that the condition that created the alarm is still active.
Alarm Accepted Indication of alarm acceptance.
5.1.1 Accepting Alarms

The user should first activate the “Alarms Acceptance Mode” button (from the toolbar) in
order to accept alarms, so that he can afterwards select the desired line(s) and use the
“Accept Selection” button. The “Accept Page” button purpose is to allow the acceptance of
the alarms shown on that moment.
5.2 Alarm Inhibitions

The Alarm Inhibition module allows the configuration and visualization of alarm inhibitions.
Figure 31. List of alarm inhibitions
The user can inhibit the alarms in the configuration options (prevent the alarm generation)
by entity or hierarchical level, and besides this, he can disable all the inhibitions (activate
alarm generation).
Table 2. Columns in the Alarm inhibition list
Column Description
Local Time Date and local time of the inhibition configuration.

Identifier Identifies the entity or hierarchical level whose alarm is inhibited.
Description Description of the entity or hierarchical level.
Hierarchy Level 1-4 Entity description in the system tree.
Comment User optional comment.
Expire Date Inhibition expiry date.
5.2.1 Alarm Inhibition

The user must press the “Add alarm inhibition” in order to inhibit alarms (from the Toolbar).
It’s then possible to select a set of entities and/ or hierarchy levels (see Figure 32).
Figure 32. Window for adding alarm inhibitions
After having selected the entities and/ or hierarchy levels which alarm one intends to
inhibit (see Figure 32), the “OK” or “Apply” buttons should be pressed, so the window of
Figure 33 is shown from where inhibitions are configured.
Figure 33. Window for alarm inhibition configuration.
When configuring the inhibitions the user can associated an expiry date, where the
inhibition is automatically disabled. In case it isn’t defined, the inhibition will remain active
until the user manual intervention.
Then one can see how the user may disable the existing inhibitions.
5.2.2 Alarm Activation

So the alarm generation of existing inhibitions are enabled the user must first activate the
“Alarm activation mode” button (from the Toolbar), so then he can select the intended
line (s) and use the “Activate selection”.
5.3 Events List

This list indicates past events, as data changes and alarms acceptance, for example.
Figure 34. Events List
Table 3. Available Columns on the Events List.
Column Description
Local Time Date and local hour the event is logged on the system.
Source Time Moment in which the event is logged on the acquisition level, when
available.
Identifier Identifies the entity responsible for the event.
Hierarchy Level 1-4 Entity characterization on the system tree.
Event Type Event type occurred on the system.
Event Description The textual description of the event.
Value The entity value in the moment of the event occurrence, together with
engineering units, if appropriate.
Alarm If the entity is on alarm state.
Historic The alarm occurred in the past.
5.3.1 Printer Activation/ Inhibition

The system may have one or more daily record printers that are printing the events as
they are being generated. It is possible to enable or disable a specific printer from the
respective button from the toolbar.
Figure 35. Printer configuration
As exemplified in Figure 35, the window allows monitoring the current status of printers
attached to the system, as well as toggling their state.
5.4 System Events List

The System Events List presents the events that occurred on the system, as the starting-
up of the process or the logging of software anomalies.
Figure 36. System Events List
Table 4. Available columns on the System Events List.
Column Description
Type Indicates the event type and/or its cause.

Level Indicates how serious the event was (information or error, for example).
Local Time Local timestamp.
Process Identifier of the process that has originated the event.
Event Description Textual description of the event.
5.5 Entities List

The Entities List presents the current state of entities and it allows executing actions
depending on the context.
Figure 37. Entities List
When double-clicking over a line, in case an entity appears from the attribute visualization
window (4.4.5); in case a command is handled, a control execution window appears
(4.4.6).
Table 5. Available columns of the Entities List.
Column Description
Identifier The single identifier of the associated entity.

Value The entity value, with engineering units (if applicable).
State Description The entity value, with engineering units (if applicable).
Invalid Indicates if the entity value is incoherent.
Manual Offscan Indicates if the entity acquisition was intentionally interrupted.
Automatic Offscan Indicates if the entity acquisition as automatically interrupted.
Alarm Indicate that the value corresponds to an alarm state.
Alarm Unaccepted Indicates that there is a pending alarm over the entity.
Overflow Indicates that the entity value was overflowed.
Imposed Value Indicates that the entity is frozen, so updates don’t occur.
Alarm Inhibited Indicates that there the alarm associated with the entity is inhibited.
Last Update Moment in which the last entity change occurred.
5.6 Archives Viewer

The Archives Viewer allows consulting historical values of entities that were configured to
be part of the log. The log is often made periodically or by event (entity state change or
variation higher than a configured interval).
Figure 38. Archives Viewer
Table 6. Available columns on the Archives Viewer.
Column Description
Source Time Moment in which the event is logged on the acquisition level, when
available.
Type Entity type.
Description Entity description.
Value Entity value on the moment of the log.
Archive Type Archive type: periodic or by event.
5.7 Users
This module shows the application users list, specifying the access level of each one.
Figure 39. Users List
Table 7. Available columns on the Users List.
Columns Description
Access Level Defines the user access level (user or administrator).

User User identifier.
Self Indicates if the user is the one who is logged.
Local Indicates the user which is in session in CLP 500.
5.8 Notes
The Notes module creates messages in the system. They are used for several purposes:
communication between users or report of anomalous persistent situations.
Figure 40. Notes List
Table 8. Available columns on the Notes List.
Column Description
Hierarchy Level 1-4 Classification of the entity on the system tree.
Priority Message level of priority (very high or normal, for instance).
User Identification of the user who wrote the note.
Message Message text.
5.8.1 Adding a Note

To add a note the user should use the associated button from the toolbar, appearing a
window as shown on Figure 41. The text field should be filled and, if considered
necessary, the priority level changed: this will assign the note more or less importance.
Figure 41. Window to Add a Note
Only local system administrators can remove or edit notes, although it might be possible in
the future for the user to remotely edit and/or delete his notes.
5.9 Tags List

Tags module enables to see all tags, created from mimics (see section 5.10.3). Tags can
be used for several purposes: inhibit controls associated to the device where the tag was
created for instance, or just logging and sharing some important information about the
device.
Figure 42. Tags list
Table 9. Available columns on the Tags List.
Column Description
Local Time Date and local time the event was logged in the system.
Identifier The single identifier of the associated entity
Description Entity description.
User Identification of the user who inserted the tag.
Message Message text.
Inhibition Indicates if the tag is inhibiting the associated controls.
5.9.1 Tags Removal

In order to remove a tag, the user must first activate the “Tags Delete Mode” button (from
the Toolbar), so then he selects the line (s) and uses the “Remove Selection” button.
Besides the possibility of removing them, the user can also change them by double-
clicking over the tag. A window very similar to the one of section 5.10.3 is displayed.
5.10 Synoptic Viewer

The Synoptic Viewer allows accessing and interacting with graphic diagrams representing
the system state. An example can be found in Figure 43.
Figure 43. Overview of the Synoptic Viewer
It is not possible to access the options window from the Synoptic Viewer if the time-slot
configuration between data updating is reserved to the system administrator.
5.10.1 Entity Attributes Visualization

It is possible to visualize the attributes by selecting a device with right mouse button. If the
affected area has more than one configured control, a menu should be displayed where
one can select the entity. The result should be similar to window of Figure 25.
5.10.2 Sending controls

The controls are sent after selecting the device with left mouse button. In case the
affected area has more than one configured control, a menu should appear where the
intended control is selected. A window for confirming or cancelling is shown and for Set
Point controls, a field for value input. The result must be similar to Figure 27 (for Digital
controls).
5.10.3 Tags
Tags are associated to animated areas and they represent a way for the user to create
messages about the synoptic. These can be used for several purposes: communication
between users, report anomalous persistent situations or inhibition the control sending.
5.10.3.1. Symbology
The graphical representation of a tag in a synoptic is:
Figure 44. Graphical representation of a tag
The tag presents a different color depending on its type: if inhibits a control it will be red,
otherwise yellow will be the predominant color.
5.10.3.2. Adding Tags
The user must first select a device with right mouse button and choose the Tags option
from the window (Attributes window). The result must be similar to the window below.
Figure 45. Basic mode of tag window.
In order to continue inserting a tag it is necessary to select the Insert option. It will open a
form in the same window (Details section) with all the fields required to create a tag. The
text field must be filled and, if intended, active control inhibition. The insertion will be
complete when the user confirms it by pressing the Confirm button. The complete window
is presented below.
Figure 46. Tags window in insertion mode
In sensitive areas with several entities it will be possible to add Tags to entities that don’t
have any configured yet. If all entities have tags, the inserting option will be inactive.
5.10.3.3. Changing a Tag
The user must first select the tag symbol in the synoptic with left mouse button. The
window must be equal to Tags window in basic mode.
In that window, a list of active tags associated to entities of sensitive area will be
displayed. After selecting the intended tag, its data will be displayed in “Details” section
which might be changed then. The changing action will be complete after the “Change”
button is pressed. The window will have the same presentation as this one below:
Figure 47. Tags window in updating/ removing mode.
Data will only be effectively changed if the user has permissions to do it.
5.10.3.4. Removing a Tag
The user must select the tag symbol with left mouse button. Select the tag that is about to
be removed and, in Details section, press the Remove option. The window in that moment
will have the same presentation as Figure 46.
It’s important to say that removing a tag does not mean that its graphical representation is
deleted, once there may be other tags associated to entities belonging to sensitive area.
Thus, the graphical representation will be only deleted from the synoptic when all device
entities don’t have associated tags.
As when changing a tag, also its removal is made by users with the right permissions to
do it.
5.10.4 Navigation
5.10.4.1. Intra-synoptic
The navigation inside the same synoptic is achieved by using the options of the Toolbar.
5.10.4.1.1. Zoom
This feature has two buttons. The “Zoom in” button enlarges the synoptic, while the “Zoom
out” button reduces it.
5.10.4.1.2. Pan
This feature has four buttons. Each one of them enables to move the synoptic (left, right,
up and down).
5.10.4.1.3. Free navigation (zoom and pan)
This option includes the features previously described, zoom and pan. After selected, this
feature will remain active until it’s no longer selected from the toolbar, or the “Zooming
through the window” option is activated.
The synoptic can be moved into another position by keeping pressed the left mouse
button and simultaneously moving it.
By keeping pressed the right mouse button and moving it up and down, the synoptic will
progressively grow larger or smaller.
In case the mouse has a third button with a wheel, it is also used to zoom in or out the
synoptic depending on its direction.
5.10.4.1.4. Zoom window
This option enables to enlarge an area previously selected from the synoptic. Once
selected, this feature will remain active until a zoom in window is created, being
deselected from the toolbar or the “Free navigation” option is activated.
5.10.4.1.5. Reset view
This option resets for initial values all the actions explained before.
5.10.4.1.6. Refresh
This option reloads the current synoptic, that is, it forces data restoration (besides view
restoring).
5.10.4.1.7. Views
This option enables to define, save and apply views in synoptic. A view is a synoptic
visualization area with a set of operations as zoom in/ zoom out and/ or move. In the view
window will be displayed all the views defined by the user, whether existing (embedded) in
the viewed synoptic. The window will be displayed as:
Figure 48. Views window
Save views
Place the synoptic in the required area and select the option Capture. The synoptic area
displayed in the screen will be the defined view. After the capture process, the user must
fill the fields Name and Description and press the Save button.
Delete views
In order to delete a view it’s necessary to select the required view and press the Delete
button.
It’s important to refer that only the views defined by the user (saved from the view window)
may be deleted.
Apply views
Select a displayed list view and press the Go to button.
5.10.4.2. Inter-synoptic
Navigation between synoptic depends on how it was designed. Navigation buttons are
easily distinguished from others once navigation is one of their possible actions. In Figure
43 example, grey buttons lead to other synoptic displays (apart from “SE CARRASCAL”
and “AUTOMATISMOS” buttons).
5.11 Trend Charts
Figure 49. Overview of trend charts module
5.11.1 Configuration
Configure first the entities about to be visualized and their graphic look in order to start a
Trend chart.
5.11.1.1. Line Configuration
Lines are configured from the options window of Figure 50.
Figure 50. Chart configuration window
The system enables to use historical data in the chart representation. It is assumed that
the entities about to be visualized are configured to be archived by the system
administrator. So, in order to change to historic mode, select the “Reference Type”
verification mark from the “Historic” group (Figure 50) and configure the desired time-slot.
The Insert option opens a configuration window with the line properties. All the information
for the line configuration is specified from the menu of Figure 51.
Figure 51. Configuration of a chart line
The line configuration elements are:

7. Identifier: line description;
8. Expression: entity or set of entities that will be represented in the line. In case it’s
more than one, the value will be obtained after a mathematical expression;
9. Minimum and Maximum: defines the scale limits of the Y axis;
10. Color: color on which the line will be represented;
11. Width : line width;
12. Type: line graphical representation;
 Line: the read points are joint by line segments;
 Square Line: the values are placed by levels (ideal for the representation
of discreet values);
 Only Points: the points are shown through symbols without any visual
connection between them;
13. Symbol: visual sign to use when representing the values;
14. Sampling: time between requests to the server.
5.11.1.2. Save and Load Configurations
It is possible to save chart configurations for future visualization. The name inserted when
saving the chart will identify it when loading.
Figure 52. Configuration loading window
The storage, load and removal of configurations are handled with dialogues similar to
Figure 52. It is possible to create configurations only by the user, like global configurations
accessible by all the system users.
5.11.2 Navigation
The Trend Chart has two distinct modes: as a graphic representation of the entities found
on the server and as surveillance service of the system properties with entities defined in
the database.
With these two modes, there are some complementing tools enabling a better interaction
with the chart.
5.11.2.1. Trend Graphic Mode
Using this mode requires the entity configuration. It can be obtained from an already
saved configuration from the database or from a new one using configuration windows.
So the read values are easier to identify, there’s a tooltip with the exact read value and the
line description. It is displayed when the mouse pointer is over a symbol that identifies the
read value.
The same paradigms of intra synoptic navigation are used (5.10.4.1) allowing a more
detailed view of graphic areas and/or the values driving out to better identify the line
behavior throughout the time.
5.11.2.2. System Surveillance Mode
There is no interactivity in this mode. A pre-defined configuration is represented with
properties that are usually associated with the system (processor consumption or disk
space, for instance). The goal is to aid the system maintenance and/ or diagnosis.
5.12 Reports
The Reports module enables the reports configuration and generation from data in the
system. An example is displayed below.
1 2
a
Figure 53. Report generation window
The window has two areas:

1. Report configuration
This area is divided in three sections:
a. Report selection
Report list available at the moment and a brief description of the report
selected now (if the report definition).
The refresh button enables to update the report list now available.
b. Filters
Presents all the filtering criteria according to the selected report all the filtering
criteria and a brief description about each one use.
c. Generation
It allows the selection of format types for the report to be generated, the
request generation cancelling still active and the impression of the last
generated report.
In the printing process, if several formats are selected for the report in the
generation, it will be displayed to the user a window to choose the required
format.
2. Preview the generated report
Displaying the report in HTML format.
The user must select one of the available reports, configuring (if applicable) the filtering
criteria and press the “Generate Report” button.
6. Troubleshooting
6.1 Log off Error

In some cases the authentication may not be correctly closed, requiring user intervention.
The simplest way to solve the problem is to close all Web browser windows. Checking its
resolution means to access again the product protected section and confirm that an
authentication dialogue is shown (4.2).
There is an equivalent option for Mozilla Firefox browser, accessible from the “Tools”
menu, “Clear Private Data…” option, where a configuration similar to Figure 54 is made.
Figure 54. Cleaning the authenticated sessions from the Mozilla Firefox
There is an equivalent option for Opera web browser, accessible from the “Tools” menu,
“Delete Private Data” option, where a configuration similar to Figure 55 is made.
Figure 55. Cleaning the authenticated sessions on the Opera Web browser
Troubleshooting 39 of 42
On the Safari Web browser, the option is available on the “Edit” menu, “Reset Safari…”
option, where a configuration similar to Figure 56 is made.
Figure 56. Cleaning authenticated sessions on the Safari Web browser
6.2 Problem when Visualizing Synoptic During the Navigation

Situations may occur where, instead of appearing a synoptic, a text is displayed in its
place. The exception is when the Web browser doesn’t have the required installed
software (3.1), thus this is a system configuration problem. In this case, the HMI 500
administrator should be noticed of the problem, once there isn’t a way to avoid the
problem.
6.3 Memory Leak in IE8 in Windows XP

It was verified that Internet Explorer 8, when running over Windows XP, suffers from a
memory leak, noticeable in long sessions. The symptoms are a diminished HMI 500
performance, as time goes by, and/or a complete freeze in synoptic entities refresh.
To work around the issue, go to Control Panel, Internet Options, Security separator, select
Local intranet, press the Sites button and configure as following:
Figure 57. IE8 memory leak workaround configuration
Troubleshooting 40 of 42
7. Known Limitations
This section includes the known system limitations, working as an extra to the
Troubleshooting (6). Solutions are being developed to avoid the limitations here identified,
what gives them a non-definitive nature, although it’s important to refer that most of them
are due to specific technological limitations of the Web browsers.
7.1 Internet Explorer Browser

7.1.1 Version 6.x
Problems were detected when navigating between synoptics, using version
“6.0.2800.1106”. Please check that your browser is updated – “6.0.2900.2180” version, at
least.
Some problems concerning the rounding of the scale of axe X were observed in trend
charts. The problem doesn’t happen on latter browser versions.
7.1.2 Version 7.0 and Above

It is not possible to open a synoptic in a new window in “7.0.5730.11” version (right click in
“Open in New Window” option). The problem can be avoided by creating a new synoptic
window.
It was observed that the panning (Alt key) in synoptic and/ or trend charts for
“7.0.5730.11” version messes the interaction. The default configuration does not have a
system menu and the Alt key is also used to open system menus, changing the size of the
window and generating small stops. Use the navigation of the toolbar in order to avoid this
behavior. As an alternative, use the right mouse button from the navigation bar and assure
that the “Menu Bar” option is selected.
In version 8.0, running over Windows XP, a memory leak was detected. A work around is
possible by changing configuration (6.3).
7.2 Mozilla Firefox Browser

7.2.1 Version 1.5
Memory losses were observed, clearly manifested in long periods of time while there is
synoptic activity.
7.2.2 Version 4.0 and Above

There are problems with end of session using this version. It is advised to use the
alternate procedure (6.1) whenever needed (Version 3.6 is well supported).
7.3 Opera Browser

The end of session fails due to a browser limitation.
Viewing attributes in a synoptic display is not easy because the context menu (of the
browser) is placed over the entity selection menu.
7.4 Safari Browser

The end of session fails due to a browser limitation.
Known Limitations 41 of 42
Known Limitations 42 of 42
References
[1] HMI 500 – Manual do Integrador de Sistemas – Configuração dos Componentes Cliente e
Servidor
EFACEC Engenharia S. A., Maia, 2009.
[2] CLP 500 – Manual do Utilizador – Unidade Central
EFACEC Sistemas de Electrónica S. A., Maia, 2007.
References I
Glossary
ASV Adobe SVG Viewer – SVG viewer from Adobe Systems Incorporated.
Primary Button Left mouse button.
Secondary Button Right mouse button.
CSV Comma-separated values – values separated by comma. Text format for
tabulated data storage.
Firefox Web browser of the Mozilla foundation.
IIS Internet Information Services – Web Server of Microsoft Corporation.
Internet Explorer Web browser from Microsoft Corporation.
Opera Web browser from Opera Software ASA.
RTU Remote Terminal Unit.
SCADA Supervisory Control And Data Acquisition.
SVG Scalable Vector Graphics, Open standard format for 2D graphics.
Tooltip Box appearing over an active area and which typically contains
information associated to that area.
TPU Terminal Protection Unit.
Glossary II

ASID11000159 - HMI 500 - User Manual - Configuration and Use of The Client Component (1 5 0)

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ASID11000159 - HMI 500 - User Manual - Configuration and Use of The Client Component (1 5 0)

Uploaded by

Copyright:

Available Formats

User Manual

Configuration and Use of the Client

Version Date Comments Product Author

1.0 2007-08-17 Document release. 0.8 Helder Magalhães;

1.2.0 2011-04-26 New features: 1.5 Bruno Ferreira;

1.4 2012-01-06 New features: 1.8 André Santos

1.5 2012-10-23 New features: André Santos

5.3 EVENTS LIST ............................................................................................................... 23

3. Installation and Configuration

3.1 Installation of the Required Software to Access the System

Figure 1. Panel “About…” of Internet Explorer

3.1.1.1. Installation of the Required Plug-in for Graphics View

Figure 2. Required plug-in installation for graphics view on Internet Explorer

Installation and Configuration 3 of 42

3.1.2 Based on Mozilla Firefox

Figure 3. “About...” panel of Mozilla Firefox

3.1.3 Based on Opera

Figure 4. “About...” panel of Opera

3.1.4 Based on Safari

Installation and Configuration 4 of 42

Figure 5. “About…” panel of the Safari Web browser

3.2.1 Based on Internet Explorer

Installation and Configuration 5 of 42

Figure 6. Configurations for data server access in Internet Explorer

Figure 7. Printing configuration on Internet Explorer

Installation and Configuration 6 of 42

3.2.2 Based on Mozilla Firefox

Figure 8. Printing configuration on the Mozilla Firefox

3.2.3 Based on Opera

Installation and Configuration 7 of 42

Figure 9. Right mouse button configuration

Figure 10. Printing configuration on Opera

3.2.4 Microsoft Pocket Internet Explorer

Installation and Configuration 8 of 42

Figure 11. Configuration on the Pocket Internet Explorer

Installation and Configuration 9 of 42

4. Component General Use

4.1 System Login

Figure 12. Welcome screen

4.2 System Authentication

Figure 13. Authentication panel of the system

Component General Use 10 of 42

4.3 Application General View

Figure 14. Application general view

4.3.1 Main Menu

Figure 15. Main menu

Component General Use 11 of 42

Figure 16. Options Window

Figure 17. “About” window

4.3.2 System Summary

Figure 18. System summary

4.4 Information and Generic Actions

Component General Use 12 of 42

Figure 19. Toolbar

Figure 20. Description support in the printing

Component General Use 13 of 42

Figure 21. Printing the Alarm list

4.4.3 Lists Handling

Figure 22. Example of list options window

Component General Use 14 of 42

Figure 23. Example of a Filter window

Figure 24. Example of a sub-filters window

4.4.5 Visualization of Entities Attributes