Geo SCADA Expert Design Guidelines
Geo SCADA Expert Design Guidelines
(previously ClearSCADA)
Software for Telemetry and Remote SCADA Solutions
Design Guidelines
November 2019
.................................................................................................. 5
Contents .................................................................................... 2
Introduction ............................................................................... 4
Example Projects ........................................................................................ 4
Further Information .................................................................................... 4
Scope......................................................................................... 5
Server Operation ........................................................................................ 6
Server Hardware Requirements ................................................................. 7
System Design ............................................................................................ 8
System Architecture ........................................................................................................................ 8
Database Structure.......................................................................................................................... 8
Archiving............................................................................................................................................. 9
Alarm Banner Display ................................................................................................................... 11
Reuse of Common Configuration............................................................................................... 11
Time Synchronization .................................................................................................................... 11
Metadata ........................................................................................................................................... 12
System Monitoring.......................................................................................................................... 12
Mimic Design ............................................................................................ 14
Efficient Mimic Design................................................................................................................... 14
Embedded Mimics ......................................................................................................................... 15
Server Performance ................................................................................. 17
Logic Programs .............................................................................................................................. 17
Historical Storage of History and Events................................................................................. 17
Server Logging ............................................................................................................................... 18
Client Performance ................................................................................... 20
Embedded Mimic Cache .............................................................................................................. 20
Mimic Disk Cache........................................................................................................................... 20
Mimic Scripts ................................................................................................................................... 21
More Information ...................................................................................... 22
This document provides some guidelines for the successful and efficient design of
EcoStruxureTM Geo SCADA Expert software deployments. To provide some context to the
guidelines within this document, some background information on the operation of
EcoStruxure Geo SCADA Expert (subsequently referred to as ‘Geo SCADA Expert’) software
is first provided as a foundation upon which to build.
Checklists are provided at the end of this document to rate your system against these
guidelines.
Example Projects
An application example is included within the Example Projects to provide a foundation for
development of a real-world Wastewater Lift Station. This example leverages the close
integration of the SCADAPackTM E Smart RTU objects and includes sample IEC 6-1131 logic
for the SCADAPack 334E Smart RTU. This project will be used as the basis for examples of
topics discussed within this document.
This icon is used to provide a demonstration of the current topic within the
Geo SCADA sample database.
Further Information
Further information is available with the Geo SCADA Expert software Resource Center:
https://tprojects.schneider-electric.com/telemetry/display/CS/Home
This icon is used to link directly to a relevant article within the Geo SCADA
Resource Center.
In addition to the Geo SCADA Expert software background information, the guidelines within
this document will focus on the following areas:
• System Design
• Mimic Design
• Server Performance
o Historic Storage
o Use of Logic
• Client Performance
o Use of Mimic Cache
o Mimic Scripting
Server Operation
The Geo SCADA Expert software server’s operation can be broken up into two main parts:
the core database process and the individual driver modules, as follows:
These separate drivers can be monitored within the WindowsTM Task Manager’s Process tab,
as each driver will be listed when it is operational.
The Geo SCADA Expert software Online Help contains information on recommended
computer specifications for both servers and clients. Browse the contents for Getting Started
Installation Geo SCADA Expert Geo SCADA Expert Server Requirements, or search
for "Geo SCADA Expert Server Requirements".
System Design
System Architecture
The Geo SCADA Expert software architecture chosen will be greatly dependent upon the
requirements of the system, although the following attributes should be included in large
systems:
Database Structure
While not directly impacting system performance, the database structure and design has a
large impact on overall operability and user experience. The following database design
guidelines are considered good-practice:
https://tprojects.schneider-electric.com/telemetry/x/ZIA3
The Example Projects section is broken up by Industry (Electricity, Oil & Gas,
Water/Wastewater), and then further by individual areas and/or sites.
Archiving
Archiving is a feature of Geo SCADA Expert software allowing users to create an external
backup of historical data providing long-term offline storage. In summary, historic data and
event messages are kept in the database only for a specified number of weeks after which
time they are deleted. The total amount of time for which historic data and event messages
are stored is referred to as the Keep Online time. To avoid losing data, you must ensure that
archiving takes place before the end of the Keep Online time, configured within Server
Configuration as shown below.
You may decide not to use Archiving features, and keep historic data online for a long period,
thus relying on Geo SCADA Expert software to keep all the data you will need and relying on
redundancy and backup facilities if recovery is needed. This could be on a Standby-Only
server, with a shorter period for the Main/Standby servers. Geo SCADA Expert software
servers keep an index for all historic files in RAM which is loaded when a server is started.
This is acceptable providing you calculate the memory usage associated with each historic
file (event, data, alarm summary etc), and ensure that the total multiplied by 100 bytes
(approx.) does not exceed total RAM less that used for other purposes. You can lessen the
memory used for historic data by setting the ‘Index after’ setting in the Server Configuration
tool’s Historic Data section. Please consult the documentation for further information.
The archive is a process that can be configured on a schedule to suit your needs, however
the archiving process should be performed frequently (e.g. every other week) to ensure that
the amount of data archived each time is kept manageable. It is recommended that each
periodic archive is stored in a new location (identified by the archive date, for example) to allow
for selective restoration of specific periods of historic data.
https://tprojects.schneider-electric.com/telemetry/x/LwMm
It is useful to create and reference color objects within the database instead of explicitly
configuring a specific color within the mimic design, as this provides the ability to quickly and
easily adjust the database color scheme by reconfiguring a few color objects. Without the use
of color objects, potentially each individual mimic would have to be re-configured to achieve
the same result.
Time Synchronization
To ensure each Geo SCADA Expert software server has an accurate representation of time,
synchronization should be implemented with an external source. This can be handled
automatically by the Domain Controller within an Active Directory environment, although for
remote or distributed architectures this is not always possible.
An alternative is to utilize Network Time Protocol (NTP) to manage the time synchronization,
whereby the WindowsTM Operating System is configured to synchronize with a networked NTP
server. In this scenario Geo SCADA Expert software’s NTP Monitor driver can be configured
to monitor the accuracy of the time synchronization and generate an alarm if the local server
time deviates too far from the NTP source.
Consider the scenario whereby a future version of Geo SCADA Expert software is expanded
or a new driver installed which includes a database field that conflicts with one of your existing
metadata fields but is used for a different purpose. Potential mass reconfiguration would be
required within your database to rename and re-align all your references accordingly.
To avoid this consider prepending a project/customer acronym to the beginning of the field
name, for example:
Adding metadata fields does cause additional memory and CPU load to your system, so take
care that you have configured only what is required, and those fields are constrained to the
object types required. For example, add metadata to CDBPoint objects only, if they are not
needed on all objects (CDBObject).
System Monitoring
Geo SCADA Expert software includes a variety of measures to monitor the operation and
performance of the Geo SCADA Expert software system and its hardware which should be
implemented to ensure correct operation and better diagnose potential causes of
underperformance.
• Performance Monitor
The Performance Monitor driver (sometimes referred to as NTMon) is used to monitor various
aspects of server performance on a Geo SCADA Expert software system. This is best
implemented to monitor Operating System metrics including:
• CPU Usage
o Overall (DBServer.exe) and process specific (e.g. DriverDNP3.exe) monitoring
available.
o It may be pertinent to monitor the DBServer application and the most commonly
utilized communications driver.
• HDD Free Space
• RAM Usage (Available Virtual Memory / DBServer memory usage)
• Page File Usage
• Network Usage
• System Uptime
Operation of the Geo SCADA Expert software server can be monitored via OPC points within
Geo SCADA Expert software. Monitoring can be performed of any network-connected Geo
SCADA Expert software server, and therefore can include all partnered servers in a redundant
architecture. Monitoring of Geo SCADA Expert software server operation should include:
• Server Name
• Server State (Main / Standby)
• Server State Change Time
• Server Type (Lone Server, Dual/Triple Standby, Permanent Standby etc.)
• Standby Server Synchronization Status (of Configuration, Data, History, etc.)
The Diagnostics page of the Geo SCADA Product Life Cycle presentation
monitors the status of the local server via OPC, although since this is only
monitoring of the local server the information is available directly from the
OPC database explorer and no database points are required. Currently
monitored are server name, server state, server type, and time when the
server came online.
• SNMP
The Simple Network Management Protocol (SNMP) is a simple protocol for managing devices
on an IP network, and should be used to monitor the status of important networking devices
including routers, switches, printers, UPS’ (uninterruptable power supplies), as well as internal
server components including HDD’s and RAID adapters.
• ICMP
SNMP polls should be implemented to capable devices in lieu of ICMP if this is not permitted
within the SCADA network.
The Geo SCADA Expert database contains a database table with performance counters. You
can query this table for second-on-second counts and accumulated counts. For example, use:
Mimic Design
In summary; as the overall complexity of the mimic increases, so will the load time, therefore
the aim of the designer should be to balance mimic functionality with complexity.
The Wastewater Application uses simple, non-gradient fill colors to match the
relevant process color – in this case wastewater.
The embedded mimics are limited to one ‘level’ where possible, and only two
levels elsewhere to simplify the implementation (the well, for example).
The Schneider Electric logo and other illustrations are all created as
vectorised graphics, instead of embedded images, as these are stored and
accessed much more efficiently.
Trends are not directly embedded onto the main overview mimic. Instead
links are used to provide quick access from the Mimic Header and within
each Faceplate. In this way, the trend is only displayed when requested and
doesn’t impact mimic load time.
The trend buttons provide a dynamic list of trends, so that as new trends are
added to the database they will automatically appear in the list the next time
it is accessed.
Embedded Mimics
The use of embedded mimics is recommended wherever multiple copies of the same symbol
are required, rather than separately managing multiple copies independently. There are two
main implementation strategies for embedded mimics:
The first method is simpler to maintain, as parameters are not individually set each time an
embedded mimic is used.
The Mimic Header is embedded from a common symbol whereas the Site
Menu section (buttons Alarms, Events, Notes, Trends, Reports) is separately
embedded from a template instance. This is because it needs to be located
within the site hierarchy for the links to work properly.
The Pumps and Transmitter symbols are embedded directly from common
symbols to reduce mimic disk cache use.They have “Shared with Other
Embedded Mimics” unchecked as they include hover actions which would
otherwise not animate properly (and hence are separately loaded into the
embedded mimic cache).
Logic Programs
Logic is run as a single-threaded core process and requires the database to be static during
each the read and write steps of execution. For this reason, temporary locks are applied on
the database in conjunction with the execution of logic applications. This is usually seamless
and goes unnoticed by the user if the logic application executes quickly, however complex
logic programs (those containing loops, SQL queries, nested execution etc.) can cause
noticeable periods of server ‘pauses’. To avoid unnecessary repeated executions, logic
programs should, where possible, only be executed “On Input Processed” rather than
executed periodically on a short specific interval such as 1 second. The default period is 1
second for most new Logic programs.
Ensure that any actions performed within “On Input Processed” logic programs do not write to
any of the associated input variables of that program; else an infinite logic execution loop will
be created. This includes “Refresh” actions which update variables.
When implementing logic programs within templates try to use 'On Input Processed', but
where 'On Interval' is required, separate the executions of Logic in each instance by
configuring a different offset time. It is possible to use a Template Expression to do this if part
of the template full name is numeric.
https://tprojects.schneider-electric.com/telemetry/x/twJG
Within the Wastewater Application the TrioTM Data Radio VSWR (Voltage
Standing Wave Ratio) calculation is performed using logic. This logic is
configured to run “On Input Processed” i.e. only when one of the inputs has
changed.
It is strongly recommended that each database point is limited to a maximum sustained rate
of 4 historic records per minute.
The length of time which history and event data can be kept online can vary between different
Geo SCADA Expert software servers, allowing for Permanent Standby / Performance servers
Systems with storage of important historical information should utilize the Archive feature,
configurable within the Server Configuration application. The “Archive after” setting is disabled
by default. It allows historic data to be considered read-only after the configured time and
synchronized more efficiently to Standby servers.
https://tprojects.schneider-electric.com/telemetry/x/YIA3
Server Logging
The Geo SCADA Expert software server includes built-in logging of all server actions to ensure
complete traceability in the event of any server problems. There are multiple logging streams
within Geo SCADA Expert; one for the main server process, and one additional stream for
each separate driver module. These logs are enabled by default, although are usually
insufficient for production installations. The logs for each stream are generated in a FIFO-type
arrangement where the oldest log file is removed and replaced with the new one when the
maximum number of log files is reached.
It is recommended that the number and/or size of log files for each stream is increased (as
required for your system) to be capable of spanning at least 2-3 days to ensure that events
occurring over the weekend, for example, remain within the active logs for review if required.
Consideration needs to be given to the capacity of the logging location used for large
production environments as the server log files can be generated quickly which could
potentially require hundreds of MBs of storage.
The following image shows the Server Configuration options, highlighting those that we
recommend should be increased as required for your system.
https://tprojects.schneider-electric.com/telemetry/x/O4Lo
Embedded mimics that do not have the “Shared with other embedded mimics” option checked
will not be stored within the common cache, but instead each embedded mimic object will
occupy a separate area of memory. The memory for each of these ‘non-shared’ embedded
mimics must be separately loaded and unloaded each time the main mimic is displayed. The
embedded mimic cache size can be managed via the Tools Options dialog box within
ViewX.
To help minimize potential loss of performance, Geo SCADA Expert software will attempt to
remove unused embedded mimics from the cache if the amount of memory being used
reaches the defined cache limit. When the limit is reached, Geo SCADA Expert software will
remove the embedded mimic files for any embedded Mimics that are not currently on display,
starting with the oldest files first. However, Geo SCADA Expert software can only remove the
files for embedded mimics that are not currently being displayed on mimics.
When making changes to the size of the embedded mimic cache, you can examine the effects
by using the View feature for the embedded mimic (available on the Options window). This
allows you to see whether embedded mimic files are being loaded in and out of the cache.
We recommend that you only change the embedded cache size if specifically advised to do
so by a Schneider Electric Geo SCADA Expert software Support Engineer.
The following occurs each time a ViewX client requests a mimic from the server (including all
embedded mimics):
Mimic Scripts
The Geo SCADA Expert software client-side Visual Basic (VB) scripting interface allows users
to create scripts that provide useful functionality specifically tailored to their requirements, for
example; implement navigation features, display dialog boxes, create user interface forms etc.
While Geo SCADA Expert software gives users the flexibility of placing script behind each
mimic, or even within the configuration of a mimic button itself, this can often result in
duplication of code which quickly becomes difficult to maintain. It is recommended that script
libraries are implemented where possible to allow re-use of common code within the entire
Geo SCADA Expert software database, ensuring that any required maintenance or upgrades
are as simple and cost-effective as possible.
It should be noted that mimic scripts access the Geo SCADA Expert software server via the
Geo SCADA Expert software web services port (default port 80 or 443 if secure connections
are used), not the standard ViewX port. If you are experiencing issues with client-side
scripting, check that the web services port is not in use by another application and available
for use by Geo SCADA Expert software, visible with the Server Status application. Also check
that your clients are not waiting for CRL (Certificate Revocation) when using the HTTPS
connection. The following image shows an invalid configuration where Geo SCADA Expert
software is unable to use the http web port, therefore scripts will fail to execute.
https://tprojects.schneider-electric.com/telemetry/x/fQJG
More Information
The Geo SCADA Expert software Online Help is a great first resource and contains information
on resolving common system problems. Browse the contents for System Administration
Server Status Tool Common System Problems, or search for "Common System Problems".
Further information is also available with the Geo SCADA Expert software Resource Center:
https://tprojects.schneider-electric.com/telemetry/display/CS/Home
System Design
Guideline Adherence to
Guideline
Number guideline
SD6 Avoid selecting a point name that describes the state of the point.
SP1 Limit the use of FOR or WHILE loops within logic programs.
Limit the use of “Shared with other embedded mimics” when using
CP2 embedded mimics, where possible.
Contact Information
Email:
[email protected]
Phone (Direct
Worldwide):
URL: + 1 (613) 591-1943
Geo SCADA Expert – Official
Website